client.go 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071
  1. // Package oss implements functions for access oss service.
  2. // It has two main struct Client and Bucket.
  3. package oss
  4. import (
  5. "bytes"
  6. "encoding/xml"
  7. "fmt"
  8. "io"
  9. "log"
  10. "net/http"
  11. "strings"
  12. "time"
  13. )
  14. // Client SDK's entry point. It's for bucket related options such as create/delete/set bucket (such as set/get ACL/lifecycle/referer/logging/website).
  15. // Object related operations are done by Bucket class.
  16. // Users use oss.New to create Client instance.
  17. //
  18. type (
  19. // Client OSS client
  20. Client struct {
  21. Config *Config // OSS client configuration
  22. Conn *Conn // Send HTTP request
  23. HTTPClient *http.Client //http.Client to use - if nil will make its own
  24. }
  25. // ClientOption client option such as UseCname, Timeout, SecurityToken.
  26. ClientOption func(*Client)
  27. )
  28. // New creates a new client.
  29. //
  30. // endpoint the OSS datacenter endpoint such as http://oss-cn-hangzhou.aliyuncs.com .
  31. // accessKeyId access key Id.
  32. // accessKeySecret access key secret.
  33. //
  34. // Client creates the new client instance, the returned value is valid when error is nil.
  35. // error it's nil if no error, otherwise it's an error object.
  36. //
  37. func New(endpoint, accessKeyID, accessKeySecret string, options ...ClientOption) (*Client, error) {
  38. // Configuration
  39. config := getDefaultOssConfig()
  40. config.Endpoint = endpoint
  41. config.AccessKeyID = accessKeyID
  42. config.AccessKeySecret = accessKeySecret
  43. // URL parse
  44. url := &urlMaker{}
  45. url.Init(config.Endpoint, config.IsCname, config.IsUseProxy)
  46. // HTTP connect
  47. conn := &Conn{config: config, url: url}
  48. // OSS client
  49. client := &Client{
  50. Config: config,
  51. Conn: conn,
  52. }
  53. // Client options parse
  54. for _, option := range options {
  55. option(client)
  56. }
  57. // Create HTTP connection
  58. err := conn.init(config, url, client.HTTPClient)
  59. return client, err
  60. }
  61. // Bucket gets the bucket instance.
  62. //
  63. // bucketName the bucket name.
  64. // Bucket the bucket object, when error is nil.
  65. //
  66. // error it's nil if no error, otherwise it's an error object.
  67. //
  68. func (client Client) Bucket(bucketName string) (*Bucket, error) {
  69. return &Bucket{
  70. client,
  71. bucketName,
  72. }, nil
  73. }
  74. // CreateBucket creates a bucket.
  75. //
  76. // bucketName the bucket name, it's globably unique and immutable. The bucket name can only consist of lowercase letters, numbers and dash ('-').
  77. // It must start with lowercase letter or number and the length can only be between 3 and 255.
  78. // options options for creating the bucket, with optional ACL. The ACL could be ACLPrivate, ACLPublicRead, and ACLPublicReadWrite. By default it's ACLPrivate.
  79. // It could also be specified with StorageClass option, which supports StorageStandard, StorageIA(infrequent access), StorageArchive.
  80. //
  81. // error it's nil if no error, otherwise it's an error object.
  82. //
  83. func (client Client) CreateBucket(bucketName string, options ...Option) error {
  84. headers := make(map[string]string)
  85. handleOptions(headers, options)
  86. buffer := new(bytes.Buffer)
  87. isOptSet, val, _ := isOptionSet(options, storageClass)
  88. if isOptSet {
  89. cbConfig := createBucketConfiguration{StorageClass: val.(StorageClassType)}
  90. bs, err := xml.Marshal(cbConfig)
  91. if err != nil {
  92. return err
  93. }
  94. buffer.Write(bs)
  95. contentType := http.DetectContentType(buffer.Bytes())
  96. headers[HTTPHeaderContentType] = contentType
  97. }
  98. params := map[string]interface{}{}
  99. resp, err := client.do("PUT", bucketName, params, headers, buffer)
  100. // get response header
  101. respHeader, _ := findOption(options, responseHeader, nil)
  102. if respHeader != nil {
  103. pRespHeader := respHeader.(*http.Header)
  104. *pRespHeader = resp.Headers
  105. }
  106. if err != nil {
  107. return err
  108. }
  109. defer resp.Body.Close()
  110. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  111. }
  112. // ListBuckets lists buckets of the current account under the given endpoint, with optional filters.
  113. //
  114. // options specifies the filters such as Prefix, Marker and MaxKeys. Prefix is the bucket name's prefix filter.
  115. // And marker makes sure the returned buckets' name are greater than it in lexicographic order.
  116. // Maxkeys limits the max keys to return, and by default it's 100 and up to 1000.
  117. // For the common usage scenario, please check out list_bucket.go in the sample.
  118. // ListBucketsResponse the response object if error is nil.
  119. //
  120. // error it's nil if no error, otherwise it's an error object.
  121. //
  122. func (client Client) ListBuckets(options ...Option) (ListBucketsResult, error) {
  123. var out ListBucketsResult
  124. params, err := getRawParams(options)
  125. if err != nil {
  126. return out, err
  127. }
  128. resp, err := client.do("GET", "", params, nil, nil)
  129. // get response header
  130. respHeader, _ := findOption(options, responseHeader, nil)
  131. if respHeader != nil {
  132. pRespHeader := respHeader.(*http.Header)
  133. *pRespHeader = resp.Headers
  134. }
  135. if err != nil {
  136. return out, err
  137. }
  138. defer resp.Body.Close()
  139. err = xmlUnmarshal(resp.Body, &out)
  140. return out, err
  141. }
  142. // IsBucketExist checks if the bucket exists
  143. //
  144. // bucketName the bucket name.
  145. //
  146. // bool true if it exists, and it's only valid when error is nil.
  147. // error it's nil if no error, otherwise it's an error object.
  148. //
  149. func (client Client) IsBucketExist(bucketName string) (bool, error) {
  150. listRes, err := client.ListBuckets(Prefix(bucketName), MaxKeys(1))
  151. if err != nil {
  152. return false, err
  153. }
  154. if len(listRes.Buckets) == 1 && listRes.Buckets[0].Name == bucketName {
  155. return true, nil
  156. }
  157. return false, nil
  158. }
  159. // DeleteBucket deletes the bucket. Only empty bucket can be deleted (no object and parts).
  160. //
  161. // bucketName the bucket name.
  162. //
  163. // error it's nil if no error, otherwise it's an error object.
  164. //
  165. func (client Client) DeleteBucket(bucketName string) error {
  166. params := map[string]interface{}{}
  167. resp, err := client.do("DELETE", bucketName, params, nil, nil)
  168. if err != nil {
  169. return err
  170. }
  171. defer resp.Body.Close()
  172. return checkRespCode(resp.StatusCode, []int{http.StatusNoContent})
  173. }
  174. // GetBucketLocation gets the bucket location.
  175. //
  176. // Checks out the following link for more information :
  177. // https://help.aliyun.com/document_detail/oss/user_guide/oss_concept/endpoint.html
  178. //
  179. // bucketName the bucket name
  180. //
  181. // string bucket's datacenter location
  182. // error it's nil if no error, otherwise it's an error object.
  183. //
  184. func (client Client) GetBucketLocation(bucketName string) (string, error) {
  185. params := map[string]interface{}{}
  186. params["location"] = nil
  187. resp, err := client.do("GET", bucketName, params, nil, nil)
  188. if err != nil {
  189. return "", err
  190. }
  191. defer resp.Body.Close()
  192. var LocationConstraint string
  193. err = xmlUnmarshal(resp.Body, &LocationConstraint)
  194. return LocationConstraint, err
  195. }
  196. // SetBucketACL sets bucket's ACL.
  197. //
  198. // bucketName the bucket name
  199. // bucketAcl the bucket ACL: ACLPrivate, ACLPublicRead and ACLPublicReadWrite.
  200. //
  201. // error it's nil if no error, otherwise it's an error object.
  202. //
  203. func (client Client) SetBucketACL(bucketName string, bucketACL ACLType) error {
  204. headers := map[string]string{HTTPHeaderOssACL: string(bucketACL)}
  205. params := map[string]interface{}{}
  206. params["acl"] = nil
  207. resp, err := client.do("PUT", bucketName, params, headers, nil)
  208. if err != nil {
  209. return err
  210. }
  211. defer resp.Body.Close()
  212. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  213. }
  214. // GetBucketACL gets the bucket ACL.
  215. //
  216. // bucketName the bucket name.
  217. //
  218. // GetBucketAclResponse the result object, and it's only valid when error is nil.
  219. // error it's nil if no error, otherwise it's an error object.
  220. //
  221. func (client Client) GetBucketACL(bucketName string) (GetBucketACLResult, error) {
  222. var out GetBucketACLResult
  223. params := map[string]interface{}{}
  224. params["acl"] = nil
  225. resp, err := client.do("GET", bucketName, params, nil, nil)
  226. if err != nil {
  227. return out, err
  228. }
  229. defer resp.Body.Close()
  230. err = xmlUnmarshal(resp.Body, &out)
  231. return out, err
  232. }
  233. // SetBucketLifecycle sets the bucket's lifecycle.
  234. //
  235. // For more information, checks out following link:
  236. // https://help.aliyun.com/document_detail/oss/user_guide/manage_object/object_lifecycle.html
  237. //
  238. // bucketName the bucket name.
  239. // rules the lifecycle rules. There're two kind of rules: absolute time expiration and relative time expiration in days and day/month/year respectively.
  240. // Check out sample/bucket_lifecycle.go for more details.
  241. //
  242. // error it's nil if no error, otherwise it's an error object.
  243. //
  244. func (client Client) SetBucketLifecycle(bucketName string, rules []LifecycleRule) error {
  245. err := verifyLifecycleRules(rules)
  246. if err != nil {
  247. return err
  248. }
  249. lifecycleCfg := LifecycleConfiguration{Rules: rules}
  250. bs, err := xml.Marshal(lifecycleCfg)
  251. if err != nil {
  252. return err
  253. }
  254. buffer := new(bytes.Buffer)
  255. buffer.Write(bs)
  256. contentType := http.DetectContentType(buffer.Bytes())
  257. headers := map[string]string{}
  258. headers[HTTPHeaderContentType] = contentType
  259. params := map[string]interface{}{}
  260. params["lifecycle"] = nil
  261. resp, err := client.do("PUT", bucketName, params, headers, buffer)
  262. if err != nil {
  263. return err
  264. }
  265. defer resp.Body.Close()
  266. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  267. }
  268. // DeleteBucketLifecycle deletes the bucket's lifecycle.
  269. //
  270. //
  271. // bucketName the bucket name.
  272. //
  273. // error it's nil if no error, otherwise it's an error object.
  274. //
  275. func (client Client) DeleteBucketLifecycle(bucketName string) error {
  276. params := map[string]interface{}{}
  277. params["lifecycle"] = nil
  278. resp, err := client.do("DELETE", bucketName, params, nil, nil)
  279. if err != nil {
  280. return err
  281. }
  282. defer resp.Body.Close()
  283. return checkRespCode(resp.StatusCode, []int{http.StatusNoContent})
  284. }
  285. // GetBucketLifecycle gets the bucket's lifecycle settings.
  286. //
  287. // bucketName the bucket name.
  288. //
  289. // GetBucketLifecycleResponse the result object upon successful request. It's only valid when error is nil.
  290. // error it's nil if no error, otherwise it's an error object.
  291. //
  292. func (client Client) GetBucketLifecycle(bucketName string) (GetBucketLifecycleResult, error) {
  293. var out GetBucketLifecycleResult
  294. params := map[string]interface{}{}
  295. params["lifecycle"] = nil
  296. resp, err := client.do("GET", bucketName, params, nil, nil)
  297. if err != nil {
  298. return out, err
  299. }
  300. defer resp.Body.Close()
  301. err = xmlUnmarshal(resp.Body, &out)
  302. return out, err
  303. }
  304. // SetBucketReferer sets the bucket's referer whitelist and the flag if allowing empty referrer.
  305. //
  306. // To avoid stealing link on OSS data, OSS supports the HTTP referrer header. A whitelist referrer could be set either by API or web console, as well as
  307. // the allowing empty referrer flag. Note that this applies to requests from webbrowser only.
  308. // For example, for a bucket os-example and its referrer http://www.aliyun.com, all requests from this URL could access the bucket.
  309. // For more information, please check out this link :
  310. // https://help.aliyun.com/document_detail/oss/user_guide/security_management/referer.html
  311. //
  312. // bucketName the bucket name.
  313. // referers the referrer white list. A bucket could have a referrer list and each referrer supports one '*' and multiple '?' as wildcards.
  314. // The sample could be found in sample/bucket_referer.go
  315. // allowEmptyReferer the flag of allowing empty referrer. By default it's true.
  316. //
  317. // error it's nil if no error, otherwise it's an error object.
  318. //
  319. func (client Client) SetBucketReferer(bucketName string, referers []string, allowEmptyReferer bool) error {
  320. rxml := RefererXML{}
  321. rxml.AllowEmptyReferer = allowEmptyReferer
  322. if referers == nil {
  323. rxml.RefererList = append(rxml.RefererList, "")
  324. } else {
  325. for _, referer := range referers {
  326. rxml.RefererList = append(rxml.RefererList, referer)
  327. }
  328. }
  329. bs, err := xml.Marshal(rxml)
  330. if err != nil {
  331. return err
  332. }
  333. buffer := new(bytes.Buffer)
  334. buffer.Write(bs)
  335. contentType := http.DetectContentType(buffer.Bytes())
  336. headers := map[string]string{}
  337. headers[HTTPHeaderContentType] = contentType
  338. params := map[string]interface{}{}
  339. params["referer"] = nil
  340. resp, err := client.do("PUT", bucketName, params, headers, buffer)
  341. if err != nil {
  342. return err
  343. }
  344. defer resp.Body.Close()
  345. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  346. }
  347. // GetBucketReferer gets the bucket's referrer white list.
  348. //
  349. // bucketName the bucket name.
  350. //
  351. // GetBucketRefererResponse the result object upon successful request. It's only valid when error is nil.
  352. // error it's nil if no error, otherwise it's an error object.
  353. //
  354. func (client Client) GetBucketReferer(bucketName string) (GetBucketRefererResult, error) {
  355. var out GetBucketRefererResult
  356. params := map[string]interface{}{}
  357. params["referer"] = nil
  358. resp, err := client.do("GET", bucketName, params, nil, nil)
  359. if err != nil {
  360. return out, err
  361. }
  362. defer resp.Body.Close()
  363. err = xmlUnmarshal(resp.Body, &out)
  364. return out, err
  365. }
  366. // SetBucketLogging sets the bucket logging settings.
  367. //
  368. // OSS could automatically store the access log. Only the bucket owner could enable the logging.
  369. // Once enabled, OSS would save all the access log into hourly log files in a specified bucket.
  370. // For more information, please check out https://help.aliyun.com/document_detail/oss/user_guide/security_management/logging.html
  371. //
  372. // bucketName bucket name to enable the log.
  373. // targetBucket the target bucket name to store the log files.
  374. // targetPrefix the log files' prefix.
  375. //
  376. // error it's nil if no error, otherwise it's an error object.
  377. //
  378. func (client Client) SetBucketLogging(bucketName, targetBucket, targetPrefix string,
  379. isEnable bool) error {
  380. var err error
  381. var bs []byte
  382. if isEnable {
  383. lxml := LoggingXML{}
  384. lxml.LoggingEnabled.TargetBucket = targetBucket
  385. lxml.LoggingEnabled.TargetPrefix = targetPrefix
  386. bs, err = xml.Marshal(lxml)
  387. } else {
  388. lxml := loggingXMLEmpty{}
  389. bs, err = xml.Marshal(lxml)
  390. }
  391. if err != nil {
  392. return err
  393. }
  394. buffer := new(bytes.Buffer)
  395. buffer.Write(bs)
  396. contentType := http.DetectContentType(buffer.Bytes())
  397. headers := map[string]string{}
  398. headers[HTTPHeaderContentType] = contentType
  399. params := map[string]interface{}{}
  400. params["logging"] = nil
  401. resp, err := client.do("PUT", bucketName, params, headers, buffer)
  402. if err != nil {
  403. return err
  404. }
  405. defer resp.Body.Close()
  406. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  407. }
  408. // DeleteBucketLogging deletes the logging configuration to disable the logging on the bucket.
  409. //
  410. // bucketName the bucket name to disable the logging.
  411. //
  412. // error it's nil if no error, otherwise it's an error object.
  413. //
  414. func (client Client) DeleteBucketLogging(bucketName string) error {
  415. params := map[string]interface{}{}
  416. params["logging"] = nil
  417. resp, err := client.do("DELETE", bucketName, params, nil, nil)
  418. if err != nil {
  419. return err
  420. }
  421. defer resp.Body.Close()
  422. return checkRespCode(resp.StatusCode, []int{http.StatusNoContent})
  423. }
  424. // GetBucketLogging gets the bucket's logging settings
  425. //
  426. // bucketName the bucket name
  427. // GetBucketLoggingResponse the result object upon successful request. It's only valid when error is nil.
  428. //
  429. // error it's nil if no error, otherwise it's an error object.
  430. //
  431. func (client Client) GetBucketLogging(bucketName string) (GetBucketLoggingResult, error) {
  432. var out GetBucketLoggingResult
  433. params := map[string]interface{}{}
  434. params["logging"] = nil
  435. resp, err := client.do("GET", bucketName, params, nil, nil)
  436. if err != nil {
  437. return out, err
  438. }
  439. defer resp.Body.Close()
  440. err = xmlUnmarshal(resp.Body, &out)
  441. return out, err
  442. }
  443. // SetBucketWebsite sets the bucket's static website's index and error page.
  444. //
  445. // OSS supports static web site hosting for the bucket data. When the bucket is enabled with that, you can access the file in the bucket like the way to access a static website.
  446. // For more information, please check out: https://help.aliyun.com/document_detail/oss/user_guide/static_host_website.html
  447. //
  448. // bucketName the bucket name to enable static web site.
  449. // indexDocument index page.
  450. // errorDocument error page.
  451. //
  452. // error it's nil if no error, otherwise it's an error object.
  453. //
  454. func (client Client) SetBucketWebsite(bucketName, indexDocument, errorDocument string) error {
  455. wxml := WebsiteXML{}
  456. wxml.IndexDocument.Suffix = indexDocument
  457. wxml.ErrorDocument.Key = errorDocument
  458. bs, err := xml.Marshal(wxml)
  459. if err != nil {
  460. return err
  461. }
  462. buffer := new(bytes.Buffer)
  463. buffer.Write(bs)
  464. contentType := http.DetectContentType(buffer.Bytes())
  465. headers := make(map[string]string)
  466. headers[HTTPHeaderContentType] = contentType
  467. params := map[string]interface{}{}
  468. params["website"] = nil
  469. resp, err := client.do("PUT", bucketName, params, headers, buffer)
  470. if err != nil {
  471. return err
  472. }
  473. defer resp.Body.Close()
  474. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  475. }
  476. // DeleteBucketWebsite deletes the bucket's static web site settings.
  477. //
  478. // bucketName the bucket name.
  479. //
  480. // error it's nil if no error, otherwise it's an error object.
  481. //
  482. func (client Client) DeleteBucketWebsite(bucketName string) error {
  483. params := map[string]interface{}{}
  484. params["website"] = nil
  485. resp, err := client.do("DELETE", bucketName, params, nil, nil)
  486. if err != nil {
  487. return err
  488. }
  489. defer resp.Body.Close()
  490. return checkRespCode(resp.StatusCode, []int{http.StatusNoContent})
  491. }
  492. // GetBucketWebsite gets the bucket's default page (index page) and the error page.
  493. //
  494. // bucketName the bucket name
  495. //
  496. // GetBucketWebsiteResponse the result object upon successful request. It's only valid when error is nil.
  497. // error it's nil if no error, otherwise it's an error object.
  498. //
  499. func (client Client) GetBucketWebsite(bucketName string) (GetBucketWebsiteResult, error) {
  500. var out GetBucketWebsiteResult
  501. params := map[string]interface{}{}
  502. params["website"] = nil
  503. resp, err := client.do("GET", bucketName, params, nil, nil)
  504. if err != nil {
  505. return out, err
  506. }
  507. defer resp.Body.Close()
  508. err = xmlUnmarshal(resp.Body, &out)
  509. return out, err
  510. }
  511. // SetBucketCORS sets the bucket's CORS rules
  512. //
  513. // For more information, please check out https://help.aliyun.com/document_detail/oss/user_guide/security_management/cors.html
  514. //
  515. // bucketName the bucket name
  516. // corsRules the CORS rules to set. The related sample code is in sample/bucket_cors.go.
  517. //
  518. // error it's nil if no error, otherwise it's an error object.
  519. //
  520. func (client Client) SetBucketCORS(bucketName string, corsRules []CORSRule) error {
  521. corsxml := CORSXML{}
  522. for _, v := range corsRules {
  523. cr := CORSRule{}
  524. cr.AllowedMethod = v.AllowedMethod
  525. cr.AllowedOrigin = v.AllowedOrigin
  526. cr.AllowedHeader = v.AllowedHeader
  527. cr.ExposeHeader = v.ExposeHeader
  528. cr.MaxAgeSeconds = v.MaxAgeSeconds
  529. corsxml.CORSRules = append(corsxml.CORSRules, cr)
  530. }
  531. bs, err := xml.Marshal(corsxml)
  532. if err != nil {
  533. return err
  534. }
  535. buffer := new(bytes.Buffer)
  536. buffer.Write(bs)
  537. contentType := http.DetectContentType(buffer.Bytes())
  538. headers := map[string]string{}
  539. headers[HTTPHeaderContentType] = contentType
  540. params := map[string]interface{}{}
  541. params["cors"] = nil
  542. resp, err := client.do("PUT", bucketName, params, headers, buffer)
  543. if err != nil {
  544. return err
  545. }
  546. defer resp.Body.Close()
  547. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  548. }
  549. // DeleteBucketCORS deletes the bucket's static website settings.
  550. //
  551. // bucketName the bucket name.
  552. //
  553. // error it's nil if no error, otherwise it's an error object.
  554. //
  555. func (client Client) DeleteBucketCORS(bucketName string) error {
  556. params := map[string]interface{}{}
  557. params["cors"] = nil
  558. resp, err := client.do("DELETE", bucketName, params, nil, nil)
  559. if err != nil {
  560. return err
  561. }
  562. defer resp.Body.Close()
  563. return checkRespCode(resp.StatusCode, []int{http.StatusNoContent})
  564. }
  565. // GetBucketCORS gets the bucket's CORS settings.
  566. //
  567. // bucketName the bucket name.
  568. // GetBucketCORSResult the result object upon successful request. It's only valid when error is nil.
  569. //
  570. // error it's nil if no error, otherwise it's an error object.
  571. //
  572. func (client Client) GetBucketCORS(bucketName string) (GetBucketCORSResult, error) {
  573. var out GetBucketCORSResult
  574. params := map[string]interface{}{}
  575. params["cors"] = nil
  576. resp, err := client.do("GET", bucketName, params, nil, nil)
  577. if err != nil {
  578. return out, err
  579. }
  580. defer resp.Body.Close()
  581. err = xmlUnmarshal(resp.Body, &out)
  582. return out, err
  583. }
  584. // GetBucketInfo gets the bucket information.
  585. //
  586. // bucketName the bucket name.
  587. // GetBucketInfoResult the result object upon successful request. It's only valid when error is nil.
  588. //
  589. // error it's nil if no error, otherwise it's an error object.
  590. //
  591. func (client Client) GetBucketInfo(bucketName string) (GetBucketInfoResult, error) {
  592. var out GetBucketInfoResult
  593. params := map[string]interface{}{}
  594. params["bucketInfo"] = nil
  595. resp, err := client.do("GET", bucketName, params, nil, nil)
  596. if err != nil {
  597. return out, err
  598. }
  599. defer resp.Body.Close()
  600. err = xmlUnmarshal(resp.Body, &out)
  601. // convert None to ""
  602. if err == nil {
  603. if out.BucketInfo.SseRule.KMSMasterKeyID == "None" {
  604. out.BucketInfo.SseRule.KMSMasterKeyID = ""
  605. }
  606. if out.BucketInfo.SseRule.SSEAlgorithm == "None" {
  607. out.BucketInfo.SseRule.SSEAlgorithm = ""
  608. }
  609. }
  610. return out, err
  611. }
  612. // SetBucketVersioning set bucket versioning:Enabled、Suspended
  613. // bucketName the bucket name.
  614. // error it's nil if no error, otherwise it's an error object.
  615. func (client Client) SetBucketVersioning(bucketName string, versioningConfig VersioningConfig, options ...Option) error {
  616. var err error
  617. var bs []byte
  618. bs, err = xml.Marshal(versioningConfig)
  619. if err != nil {
  620. return err
  621. }
  622. buffer := new(bytes.Buffer)
  623. buffer.Write(bs)
  624. contentType := http.DetectContentType(buffer.Bytes())
  625. headers := map[string]string{}
  626. headers[HTTPHeaderContentType] = contentType
  627. params := map[string]interface{}{}
  628. params["versioning"] = nil
  629. resp, err := client.do("PUT", bucketName, params, headers, buffer)
  630. // get response header
  631. respHeader, _ := findOption(options, responseHeader, nil)
  632. if respHeader != nil {
  633. pRespHeader := respHeader.(*http.Header)
  634. *pRespHeader = resp.Headers
  635. }
  636. if err != nil {
  637. return err
  638. }
  639. defer resp.Body.Close()
  640. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  641. }
  642. // GetBucketVersioning get bucket versioning status:Enabled、Suspended
  643. // bucketName the bucket name.
  644. // error it's nil if no error, otherwise it's an error object.
  645. func (client Client) GetBucketVersioning(bucketName string, options ...Option) (GetBucketVersioningResult, error) {
  646. var out GetBucketVersioningResult
  647. params := map[string]interface{}{}
  648. params["versioning"] = nil
  649. resp, err := client.do("GET", bucketName, params, nil, nil)
  650. // get response header
  651. respHeader, _ := findOption(options, responseHeader, nil)
  652. if respHeader != nil {
  653. pRespHeader := respHeader.(*http.Header)
  654. *pRespHeader = resp.Headers
  655. }
  656. if err != nil {
  657. return out, err
  658. }
  659. defer resp.Body.Close()
  660. err = xmlUnmarshal(resp.Body, &out)
  661. return out, err
  662. }
  663. // SetBucketEncryption set bucket encryption config
  664. // bucketName the bucket name.
  665. // error it's nil if no error, otherwise it's an error object.
  666. func (client Client) SetBucketEncryption(bucketName string, encryptionRule ServerEncryptionRule, options ...Option) error {
  667. var err error
  668. var bs []byte
  669. bs, err = xml.Marshal(encryptionRule)
  670. if err != nil {
  671. return err
  672. }
  673. buffer := new(bytes.Buffer)
  674. buffer.Write(bs)
  675. contentType := http.DetectContentType(buffer.Bytes())
  676. headers := map[string]string{}
  677. headers[HTTPHeaderContentType] = contentType
  678. params := map[string]interface{}{}
  679. params["encryption"] = nil
  680. resp, err := client.do("PUT", bucketName, params, headers, buffer)
  681. // get response header
  682. respHeader, _ := findOption(options, responseHeader, nil)
  683. if respHeader != nil {
  684. pRespHeader := respHeader.(*http.Header)
  685. *pRespHeader = resp.Headers
  686. }
  687. if err != nil {
  688. return err
  689. }
  690. defer resp.Body.Close()
  691. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  692. }
  693. // GetBucketEncryption get bucket encryption
  694. // bucketName the bucket name.
  695. // error it's nil if no error, otherwise it's an error object.
  696. func (client Client) GetBucketEncryption(bucketName string, options ...Option) (GetBucketEncryptionResult, error) {
  697. var out GetBucketEncryptionResult
  698. params := map[string]interface{}{}
  699. params["encryption"] = nil
  700. resp, err := client.do("GET", bucketName, params, nil, nil)
  701. // get response header
  702. respHeader, _ := findOption(options, responseHeader, nil)
  703. if respHeader != nil {
  704. pRespHeader := respHeader.(*http.Header)
  705. *pRespHeader = resp.Headers
  706. }
  707. if err != nil {
  708. return out, err
  709. }
  710. defer resp.Body.Close()
  711. err = xmlUnmarshal(resp.Body, &out)
  712. return out, err
  713. }
  714. // DeleteBucketEncryption delete bucket encryption config
  715. // bucketName the bucket name.
  716. // error it's nil if no error, otherwise it's an error bucket
  717. func (client Client) DeleteBucketEncryption(bucketName string, options ...Option) error {
  718. params := map[string]interface{}{}
  719. params["encryption"] = nil
  720. resp, err := client.do("DELETE", bucketName, params, nil, nil)
  721. // get response header
  722. respHeader, _ := findOption(options, responseHeader, nil)
  723. if respHeader != nil {
  724. pRespHeader := respHeader.(*http.Header)
  725. *pRespHeader = resp.Headers
  726. }
  727. if err != nil {
  728. return err
  729. }
  730. defer resp.Body.Close()
  731. return checkRespCode(resp.StatusCode, []int{http.StatusNoContent})
  732. }
  733. //
  734. // SetBucketTagging add tagging to bucket
  735. // bucketName name of bucket
  736. // tagging tagging to be added
  737. // error nil if success, otherwise error
  738. func (client Client) SetBucketTagging(bucketName string, tagging Tagging, options ...Option) error {
  739. var err error
  740. var bs []byte
  741. bs, err = xml.Marshal(tagging)
  742. if err != nil {
  743. return err
  744. }
  745. buffer := new(bytes.Buffer)
  746. buffer.Write(bs)
  747. contentType := http.DetectContentType(buffer.Bytes())
  748. headers := map[string]string{}
  749. headers[HTTPHeaderContentType] = contentType
  750. params := map[string]interface{}{}
  751. params["tagging"] = nil
  752. resp, err := client.do("PUT", bucketName, params, headers, buffer)
  753. // get response header
  754. respHeader, _ := findOption(options, responseHeader, nil)
  755. if respHeader != nil {
  756. pRespHeader := respHeader.(*http.Header)
  757. *pRespHeader = resp.Headers
  758. }
  759. if err != nil {
  760. return err
  761. }
  762. defer resp.Body.Close()
  763. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  764. }
  765. // GetBucketTagging get tagging of the bucket
  766. // bucketName name of bucket
  767. // error nil if success, otherwise error
  768. func (client Client) GetBucketTagging(bucketName string, options ...Option) (GetBucketTaggingResult, error) {
  769. var out GetBucketTaggingResult
  770. params := map[string]interface{}{}
  771. params["tagging"] = nil
  772. resp, err := client.do("GET", bucketName, params, nil, nil)
  773. // get response header
  774. respHeader, _ := findOption(options, responseHeader, nil)
  775. if respHeader != nil {
  776. pRespHeader := respHeader.(*http.Header)
  777. *pRespHeader = resp.Headers
  778. }
  779. if err != nil {
  780. return out, err
  781. }
  782. defer resp.Body.Close()
  783. err = xmlUnmarshal(resp.Body, &out)
  784. return out, err
  785. }
  786. //
  787. // DeleteBucketTagging delete bucket tagging
  788. // bucketName name of bucket
  789. // error nil if success, otherwise error
  790. //
  791. func (client Client) DeleteBucketTagging(bucketName string, options ...Option) error {
  792. params := map[string]interface{}{}
  793. params["tagging"] = nil
  794. resp, err := client.do("DELETE", bucketName, params, nil, nil)
  795. // get response header
  796. respHeader, _ := findOption(options, responseHeader, nil)
  797. if respHeader != nil {
  798. pRespHeader := respHeader.(*http.Header)
  799. *pRespHeader = resp.Headers
  800. }
  801. if err != nil {
  802. return err
  803. }
  804. defer resp.Body.Close()
  805. return checkRespCode(resp.StatusCode, []int{http.StatusNoContent})
  806. }
  807. // LimitUploadSpeed set upload bandwidth limit speed,default is 0,unlimited
  808. // upSpeed KB/s, 0 is unlimited,default is 0
  809. // error it's nil if success, otherwise failure
  810. func (client Client) LimitUploadSpeed(upSpeed int) error {
  811. if client.Config == nil {
  812. return fmt.Errorf("client config is nil")
  813. }
  814. return client.Config.LimitUploadSpeed(upSpeed)
  815. }
  816. // UseCname sets the flag of using CName. By default it's false.
  817. //
  818. // isUseCname true: the endpoint has the CName, false: the endpoint does not have cname. Default is false.
  819. //
  820. func UseCname(isUseCname bool) ClientOption {
  821. return func(client *Client) {
  822. client.Config.IsCname = isUseCname
  823. client.Conn.url.Init(client.Config.Endpoint, client.Config.IsCname, client.Config.IsUseProxy)
  824. }
  825. }
  826. // Timeout sets the HTTP timeout in seconds.
  827. //
  828. // connectTimeoutSec HTTP timeout in seconds. Default is 10 seconds. 0 means infinite (not recommended)
  829. // readWriteTimeout HTTP read or write's timeout in seconds. Default is 20 seconds. 0 means infinite.
  830. //
  831. func Timeout(connectTimeoutSec, readWriteTimeout int64) ClientOption {
  832. return func(client *Client) {
  833. client.Config.HTTPTimeout.ConnectTimeout =
  834. time.Second * time.Duration(connectTimeoutSec)
  835. client.Config.HTTPTimeout.ReadWriteTimeout =
  836. time.Second * time.Duration(readWriteTimeout)
  837. client.Config.HTTPTimeout.HeaderTimeout =
  838. time.Second * time.Duration(readWriteTimeout)
  839. client.Config.HTTPTimeout.IdleConnTimeout =
  840. time.Second * time.Duration(readWriteTimeout)
  841. client.Config.HTTPTimeout.LongTimeout =
  842. time.Second * time.Duration(readWriteTimeout*10)
  843. }
  844. }
  845. // SecurityToken sets the temporary user's SecurityToken.
  846. //
  847. // token STS token
  848. //
  849. func SecurityToken(token string) ClientOption {
  850. return func(client *Client) {
  851. client.Config.SecurityToken = strings.TrimSpace(token)
  852. }
  853. }
  854. // EnableMD5 enables MD5 validation.
  855. //
  856. // isEnableMD5 true: enable MD5 validation; false: disable MD5 validation.
  857. //
  858. func EnableMD5(isEnableMD5 bool) ClientOption {
  859. return func(client *Client) {
  860. client.Config.IsEnableMD5 = isEnableMD5
  861. }
  862. }
  863. // MD5ThresholdCalcInMemory sets the memory usage threshold for computing the MD5, default is 16MB.
  864. //
  865. // threshold the memory threshold in bytes. When the uploaded content is more than 16MB, the temp file is used for computing the MD5.
  866. //
  867. func MD5ThresholdCalcInMemory(threshold int64) ClientOption {
  868. return func(client *Client) {
  869. client.Config.MD5Threshold = threshold
  870. }
  871. }
  872. // EnableCRC enables the CRC checksum. Default is true.
  873. //
  874. // isEnableCRC true: enable CRC checksum; false: disable the CRC checksum.
  875. //
  876. func EnableCRC(isEnableCRC bool) ClientOption {
  877. return func(client *Client) {
  878. client.Config.IsEnableCRC = isEnableCRC
  879. }
  880. }
  881. // UserAgent specifies UserAgent. The default is aliyun-sdk-go/1.2.0 (windows/-/amd64;go1.5.2).
  882. //
  883. // userAgent the user agent string.
  884. //
  885. func UserAgent(userAgent string) ClientOption {
  886. return func(client *Client) {
  887. client.Config.UserAgent = userAgent
  888. }
  889. }
  890. // Proxy sets the proxy (optional). The default is not using proxy.
  891. //
  892. // proxyHost the proxy host in the format "host:port". For example, proxy.com:80 .
  893. //
  894. func Proxy(proxyHost string) ClientOption {
  895. return func(client *Client) {
  896. client.Config.IsUseProxy = true
  897. client.Config.ProxyHost = proxyHost
  898. client.Conn.url.Init(client.Config.Endpoint, client.Config.IsCname, client.Config.IsUseProxy)
  899. }
  900. }
  901. // AuthProxy sets the proxy information with user name and password.
  902. //
  903. // proxyHost the proxy host in the format "host:port". For example, proxy.com:80 .
  904. // proxyUser the proxy user name.
  905. // proxyPassword the proxy password.
  906. //
  907. func AuthProxy(proxyHost, proxyUser, proxyPassword string) ClientOption {
  908. return func(client *Client) {
  909. client.Config.IsUseProxy = true
  910. client.Config.ProxyHost = proxyHost
  911. client.Config.IsAuthProxy = true
  912. client.Config.ProxyUser = proxyUser
  913. client.Config.ProxyPassword = proxyPassword
  914. client.Conn.url.Init(client.Config.Endpoint, client.Config.IsCname, client.Config.IsUseProxy)
  915. }
  916. }
  917. //
  918. // HTTPClient sets the http.Client in use to the one passed in
  919. //
  920. func HTTPClient(HTTPClient *http.Client) ClientOption {
  921. return func(client *Client) {
  922. client.HTTPClient = HTTPClient
  923. }
  924. }
  925. //
  926. // SetLogLevel sets the oss sdk log level
  927. //
  928. func SetLogLevel(LogLevel int) ClientOption {
  929. return func(client *Client) {
  930. client.Config.LogLevel = LogLevel
  931. }
  932. }
  933. //
  934. // SetLogger sets the oss sdk logger
  935. //
  936. func SetLogger(Logger *log.Logger) ClientOption {
  937. return func(client *Client) {
  938. client.Config.Logger = Logger
  939. }
  940. }
  941. // Private
  942. func (client Client) do(method, bucketName string, params map[string]interface{},
  943. headers map[string]string, data io.Reader) (*Response, error) {
  944. return client.Conn.Do(method, bucketName, "", params,
  945. headers, data, 0, nil)
  946. }