OssClient.php 81 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230
  1. <?php
  2. namespace OSS;
  3. use OSS\Core\MimeTypes;
  4. use OSS\Core\OssException;
  5. use OSS\Http\RequestCore;
  6. use OSS\Http\RequestCore_Exception;
  7. use OSS\Http\ResponseCore;
  8. use OSS\Model\CorsConfig;
  9. use OSS\Model\CnameConfig;
  10. use OSS\Model\LoggingConfig;
  11. use OSS\Result\AclResult;
  12. use OSS\Result\BodyResult;
  13. use OSS\Result\GetCorsResult;
  14. use OSS\Result\GetLifecycleResult;
  15. use OSS\Result\GetLoggingResult;
  16. use OSS\Result\GetRefererResult;
  17. use OSS\Result\GetWebsiteResult;
  18. use OSS\Result\GetCnameResult;
  19. use OSS\Result\HeaderResult;
  20. use OSS\Result\InitiateMultipartUploadResult;
  21. use OSS\Result\ListBucketsResult;
  22. use OSS\Result\ListMultipartUploadResult;
  23. use OSS\Model\ListMultipartUploadInfo;
  24. use OSS\Result\ListObjectsResult;
  25. use OSS\Result\ListPartsResult;
  26. use OSS\Result\PutSetDeleteResult;
  27. use OSS\Result\ExistResult;
  28. use OSS\Result\AppendResult;
  29. use OSS\Model\ObjectListInfo;
  30. use OSS\Result\UploadPartResult;
  31. use OSS\Model\BucketListInfo;
  32. use OSS\Model\LifecycleConfig;
  33. use OSS\Model\RefererConfig;
  34. use OSS\Model\WebsiteConfig;
  35. use OSS\Core\OssUtil;
  36. use OSS\Model\ListPartsInfo;
  37. /**
  38. * Class OssClient
  39. *
  40. * Object Storage Service(OSS) 的客户端类,封装了用户通过OSS API对OSS服务的各种操作,
  41. * 用户通过OssClient实例可以进行Bucket,Object,MultipartUpload, ACL等操作,具体
  42. * 的接口规则可以参考官方OSS API文档
  43. */
  44. class OssClient
  45. {
  46. /**
  47. * 构造函数
  48. *
  49. * 构造函数有几种情况:
  50. * 1. 一般的时候初始化使用 $ossClient = new OssClient($id, $key, $endpoint)
  51. * 2. 如果使用CNAME的,比如使用的是www.testoss.com,在控制台上做了CNAME的绑定,
  52. * 初始化使用 $ossClient = new OssClient($id, $key, $endpoint, true)
  53. * 3. 如果使用了阿里云SecurityTokenService(STS),获得了AccessKeyID, AccessKeySecret, Token
  54. * 初始化使用 $ossClient = new OssClient($id, $key, $endpoint, false, $token)
  55. * 4. 如果用户使用的endpoint是ip
  56. * 初始化使用 $ossClient = new OssClient($id, $key, “1.2.3.4:8900”)
  57. *
  58. * @param string $accessKeyId 从OSS获得的AccessKeyId
  59. * @param string $accessKeySecret 从OSS获得的AccessKeySecret
  60. * @param string $endpoint 您选定的OSS数据中心访问域名,例如oss-cn-hangzhou.aliyuncs.com
  61. * @param boolean $isCName 是否对Bucket做了域名绑定,并且Endpoint参数填写的是自己的域名
  62. * @param string $securityToken
  63. * @throws OssException
  64. */
  65. public function __construct($accessKeyId, $accessKeySecret, $endpoint, $isCName = false, $securityToken = NULL)
  66. {
  67. $accessKeyId = trim($accessKeyId);
  68. $accessKeySecret = trim($accessKeySecret);
  69. $endpoint = trim(trim($endpoint), "/");
  70. if (empty($accessKeyId)) {
  71. throw new OssException("access key id is empty");
  72. }
  73. if (empty($accessKeySecret)) {
  74. throw new OssException("access key secret is empty");
  75. }
  76. if (empty($endpoint)) {
  77. throw new OssException("endpoint is empty");
  78. }
  79. $this->hostname = $this->checkEndpoint($endpoint, $isCName);
  80. $this->accessKeyId = $accessKeyId;
  81. $this->accessKeySecret = $accessKeySecret;
  82. $this->securityToken = $securityToken;
  83. self::checkEnv();
  84. }
  85. /**
  86. * 列举用户所有的Bucket[GetService], Endpoint类型为cname不能进行此操作
  87. *
  88. * @param array $options
  89. * @throws OssException
  90. * @return BucketListInfo
  91. */
  92. public function listBuckets($options = NULL)
  93. {
  94. if ($this->hostType === self::OSS_HOST_TYPE_CNAME) {
  95. throw new OssException("operation is not permitted with CName host");
  96. }
  97. $this->precheckOptions($options);
  98. $options[self::OSS_BUCKET] = '';
  99. $options[self::OSS_METHOD] = self::OSS_HTTP_GET;
  100. $options[self::OSS_OBJECT] = '/';
  101. $response = $this->auth($options);
  102. $result = new ListBucketsResult($response);
  103. return $result->getData();
  104. }
  105. /**
  106. * 创建bucket,默认创建的bucket的ACL是OssClient::OSS_ACL_TYPE_PRIVATE
  107. *
  108. * @param string $bucket
  109. * @param string $acl
  110. * @param array $options
  111. * @return null
  112. */
  113. public function createBucket($bucket, $acl = self::OSS_ACL_TYPE_PRIVATE, $options = NULL)
  114. {
  115. $this->precheckCommon($bucket, NULL, $options, false);
  116. $options[self::OSS_BUCKET] = $bucket;
  117. $options[self::OSS_METHOD] = self::OSS_HTTP_PUT;
  118. $options[self::OSS_OBJECT] = '/';
  119. $options[self::OSS_HEADERS] = array(self::OSS_ACL => $acl);
  120. $response = $this->auth($options);
  121. $result = new PutSetDeleteResult($response);
  122. return $result->getData();
  123. }
  124. /**
  125. * 删除bucket
  126. * 如果Bucket不为空(Bucket中有Object,或者有分块上传的碎片),则Bucket无法删除,
  127. * 必须删除Bucket中的所有Object以及碎片后,Bucket才能成功删除。
  128. *
  129. * @param string $bucket
  130. * @param array $options
  131. * @return null
  132. */
  133. public function deleteBucket($bucket, $options = NULL)
  134. {
  135. $this->precheckCommon($bucket, NULL, $options, false);
  136. $options[self::OSS_BUCKET] = $bucket;
  137. $options[self::OSS_METHOD] = self::OSS_HTTP_DELETE;
  138. $options[self::OSS_OBJECT] = '/';
  139. $response = $this->auth($options);
  140. $result = new PutSetDeleteResult($response);
  141. return $result->getData();
  142. }
  143. /**
  144. * 判断bucket是否存在
  145. *
  146. * @param string $bucket
  147. * @return bool
  148. * @throws OssException
  149. */
  150. public function doesBucketExist($bucket)
  151. {
  152. $this->precheckCommon($bucket, NULL, $options, false);
  153. $options[self::OSS_BUCKET] = $bucket;
  154. $options[self::OSS_METHOD] = self::OSS_HTTP_GET;
  155. $options[self::OSS_OBJECT] = '/';
  156. $options[self::OSS_SUB_RESOURCE] = 'acl';
  157. $response = $this->auth($options);
  158. $result = new ExistResult($response);
  159. return $result->getData();
  160. }
  161. /**
  162. * 获取bucket的ACL配置情况
  163. *
  164. * @param string $bucket
  165. * @param array $options
  166. * @throws OssException
  167. * @return string
  168. */
  169. public function getBucketAcl($bucket, $options = NULL)
  170. {
  171. $this->precheckCommon($bucket, NULL, $options, false);
  172. $options[self::OSS_BUCKET] = $bucket;
  173. $options[self::OSS_METHOD] = self::OSS_HTTP_GET;
  174. $options[self::OSS_OBJECT] = '/';
  175. $options[self::OSS_SUB_RESOURCE] = 'acl';
  176. $response = $this->auth($options);
  177. $result = new AclResult($response);
  178. return $result->getData();
  179. }
  180. /**
  181. * 设置bucket的ACL配置情况
  182. *
  183. * @param string $bucket bucket名称
  184. * @param string $acl 读写权限,可选值 ['private', 'public-read', 'public-read-write']
  185. * @param array $options 可以为空
  186. * @throws OssException
  187. * @return null
  188. */
  189. public function putBucketAcl($bucket, $acl, $options = NULL)
  190. {
  191. $this->precheckCommon($bucket, NULL, $options, false);
  192. $options[self::OSS_BUCKET] = $bucket;
  193. $options[self::OSS_METHOD] = self::OSS_HTTP_PUT;
  194. $options[self::OSS_OBJECT] = '/';
  195. $options[self::OSS_HEADERS] = array(self::OSS_ACL => $acl);
  196. $options[self::OSS_SUB_RESOURCE] = 'acl';
  197. $response = $this->auth($options);
  198. $result = new PutSetDeleteResult($response);
  199. return $result->getData();
  200. }
  201. /**
  202. * 获取object的ACL属性
  203. *
  204. * @param string $bucket
  205. * @param string $object
  206. * @throws OssException
  207. * @return string
  208. */
  209. public function getObjectAcl($bucket, $object)
  210. {
  211. $options = array();
  212. $this->precheckCommon($bucket, $object, $options, true);
  213. $options[self::OSS_METHOD] = self::OSS_HTTP_GET;
  214. $options[self::OSS_BUCKET] = $bucket;
  215. $options[self::OSS_OBJECT] = $object;
  216. $options[self::OSS_SUB_RESOURCE] = 'acl';
  217. $response = $this->auth($options);
  218. $result = new AclResult($response);
  219. return $result->getData();
  220. }
  221. /**
  222. * 设置object的ACL属性
  223. *
  224. * @param string $bucket bucket名称
  225. * @param string $object object名称
  226. * @param string $acl 读写权限,可选值 ['default', 'private', 'public-read', 'public-read-write']
  227. * @throws OssException
  228. * @return null
  229. */
  230. public function putObjectAcl($bucket, $object, $acl)
  231. {
  232. $this->precheckCommon($bucket, $object, $options, true);
  233. $options[self::OSS_BUCKET] = $bucket;
  234. $options[self::OSS_METHOD] = self::OSS_HTTP_PUT;
  235. $options[self::OSS_OBJECT] = $object;
  236. $options[self::OSS_HEADERS] = array(self::OSS_OBJECT_ACL => $acl);
  237. $options[self::OSS_SUB_RESOURCE] = 'acl';
  238. $response = $this->auth($options);
  239. $result = new PutSetDeleteResult($response);
  240. return $result->getData();
  241. }
  242. /**
  243. * 获取Bucket的访问日志配置情况
  244. *
  245. * @param string $bucket bucket名称
  246. * @param array $options 可以为空
  247. * @throws OssException
  248. * @return LoggingConfig
  249. */
  250. public function getBucketLogging($bucket, $options = NULL)
  251. {
  252. $this->precheckCommon($bucket, NULL, $options, false);
  253. $options[self::OSS_BUCKET] = $bucket;
  254. $options[self::OSS_METHOD] = self::OSS_HTTP_GET;
  255. $options[self::OSS_OBJECT] = '/';
  256. $options[self::OSS_SUB_RESOURCE] = 'logging';
  257. $response = $this->auth($options);
  258. $result = new GetLoggingResult($response);
  259. return $result->getData();
  260. }
  261. /**
  262. * 开启Bucket访问日志记录功能,只有Bucket的所有者才能更改
  263. *
  264. * @param string $bucket bucket名称
  265. * @param string $targetBucket 日志文件存放的bucket
  266. * @param string $targetPrefix 日志的文件前缀
  267. * @param array $options 可以为空
  268. * @throws OssException
  269. * @return null
  270. */
  271. public function putBucketLogging($bucket, $targetBucket, $targetPrefix, $options = NULL)
  272. {
  273. $this->precheckCommon($bucket, NULL, $options, false);
  274. $this->precheckBucket($targetBucket, 'targetbucket is not allowed empty');
  275. $options[self::OSS_BUCKET] = $bucket;
  276. $options[self::OSS_METHOD] = self::OSS_HTTP_PUT;
  277. $options[self::OSS_OBJECT] = '/';
  278. $options[self::OSS_SUB_RESOURCE] = 'logging';
  279. $options[self::OSS_CONTENT_TYPE] = 'application/xml';
  280. $loggingConfig = new LoggingConfig($targetBucket, $targetPrefix);
  281. $options[self::OSS_CONTENT] = $loggingConfig->serializeToXml();
  282. $response = $this->auth($options);
  283. $result = new PutSetDeleteResult($response);
  284. return $result->getData();
  285. }
  286. /**
  287. * 关闭bucket访问日志记录功能
  288. *
  289. * @param string $bucket bucket名称
  290. * @param array $options 可以为空
  291. * @throws OssException
  292. * @return null
  293. */
  294. public function deleteBucketLogging($bucket, $options = NULL)
  295. {
  296. $this->precheckCommon($bucket, NULL, $options, false);
  297. $options[self::OSS_BUCKET] = $bucket;
  298. $options[self::OSS_METHOD] = self::OSS_HTTP_DELETE;
  299. $options[self::OSS_OBJECT] = '/';
  300. $options[self::OSS_SUB_RESOURCE] = 'logging';
  301. $response = $this->auth($options);
  302. $result = new PutSetDeleteResult($response);
  303. return $result->getData();
  304. }
  305. /**
  306. * 将bucket设置成静态网站托管模式
  307. *
  308. * @param string $bucket bucket名称
  309. * @param WebsiteConfig $websiteConfig
  310. * @param array $options 可以为空
  311. * @throws OssException
  312. * @return null
  313. */
  314. public function putBucketWebsite($bucket, $websiteConfig, $options = NULL)
  315. {
  316. $this->precheckCommon($bucket, NULL, $options, false);
  317. $options[self::OSS_BUCKET] = $bucket;
  318. $options[self::OSS_METHOD] = self::OSS_HTTP_PUT;
  319. $options[self::OSS_OBJECT] = '/';
  320. $options[self::OSS_SUB_RESOURCE] = 'website';
  321. $options[self::OSS_CONTENT_TYPE] = 'application/xml';
  322. $options[self::OSS_CONTENT] = $websiteConfig->serializeToXml();
  323. $response = $this->auth($options);
  324. $result = new PutSetDeleteResult($response);
  325. return $result->getData();
  326. }
  327. /**
  328. * 获取bucket的静态网站托管状态
  329. *
  330. * @param string $bucket bucket名称
  331. * @param array $options
  332. * @throws OssException
  333. * @return WebsiteConfig
  334. */
  335. public function getBucketWebsite($bucket, $options = NULL)
  336. {
  337. $this->precheckCommon($bucket, NULL, $options, false);
  338. $options[self::OSS_BUCKET] = $bucket;
  339. $options[self::OSS_METHOD] = self::OSS_HTTP_GET;
  340. $options[self::OSS_OBJECT] = '/';
  341. $options[self::OSS_SUB_RESOURCE] = 'website';
  342. $response = $this->auth($options);
  343. $result = new GetWebsiteResult($response);
  344. return $result->getData();
  345. }
  346. /**
  347. * 关闭bucket的静态网站托管模式
  348. *
  349. * @param string $bucket bucket名称
  350. * @param array $options
  351. * @throws OssException
  352. * @return null
  353. */
  354. public function deleteBucketWebsite($bucket, $options = NULL)
  355. {
  356. $this->precheckCommon($bucket, NULL, $options, false);
  357. $options[self::OSS_BUCKET] = $bucket;
  358. $options[self::OSS_METHOD] = self::OSS_HTTP_DELETE;
  359. $options[self::OSS_OBJECT] = '/';
  360. $options[self::OSS_SUB_RESOURCE] = 'website';
  361. $response = $this->auth($options);
  362. $result = new PutSetDeleteResult($response);
  363. return $result->getData();
  364. }
  365. /**
  366. * 在指定的bucket上设定一个跨域资源共享(CORS)的规则,如果原规则存在则覆盖原规则
  367. *
  368. * @param string $bucket bucket名称
  369. * @param CorsConfig $corsConfig 跨域资源共享配置,具体规则参见SDK文档
  370. * @param array $options array
  371. * @throws OssException
  372. * @return null
  373. */
  374. public function putBucketCors($bucket, $corsConfig, $options = NULL)
  375. {
  376. $this->precheckCommon($bucket, NULL, $options, false);
  377. $options[self::OSS_BUCKET] = $bucket;
  378. $options[self::OSS_METHOD] = self::OSS_HTTP_PUT;
  379. $options[self::OSS_OBJECT] = '/';
  380. $options[self::OSS_SUB_RESOURCE] = 'cors';
  381. $options[self::OSS_CONTENT_TYPE] = 'application/xml';
  382. $options[self::OSS_CONTENT] = $corsConfig->serializeToXml();
  383. $response = $this->auth($options);
  384. $result = new PutSetDeleteResult($response);
  385. return $result->getData();
  386. }
  387. /**
  388. * 获取Bucket的CORS配置情况
  389. *
  390. * @param string $bucket bucket名称
  391. * @param array $options 可以为空
  392. * @throws OssException
  393. * @return CorsConfig
  394. */
  395. public function getBucketCors($bucket, $options = NULL)
  396. {
  397. $this->precheckCommon($bucket, NULL, $options, false);
  398. $options[self::OSS_BUCKET] = $bucket;
  399. $options[self::OSS_METHOD] = self::OSS_HTTP_GET;
  400. $options[self::OSS_OBJECT] = '/';
  401. $options[self::OSS_SUB_RESOURCE] = 'cors';
  402. $response = $this->auth($options);
  403. $result = new GetCorsResult($response, __FUNCTION__);
  404. return $result->getData();
  405. }
  406. /**
  407. * 关闭指定Bucket对应的CORS功能并清空所有规则
  408. *
  409. * @param string $bucket bucket名称
  410. * @param array $options
  411. * @throws OssException
  412. * @return null
  413. */
  414. public function deleteBucketCors($bucket, $options = NULL)
  415. {
  416. $this->precheckCommon($bucket, NULL, $options, false);
  417. $options[self::OSS_BUCKET] = $bucket;
  418. $options[self::OSS_METHOD] = self::OSS_HTTP_DELETE;
  419. $options[self::OSS_OBJECT] = '/';
  420. $options[self::OSS_SUB_RESOURCE] = 'cors';
  421. $response = $this->auth($options);
  422. $result = new PutSetDeleteResult($response);
  423. return $result->getData();
  424. }
  425. /**
  426. * 为指定Bucket增加CNAME绑定
  427. *
  428. * @param string $bucket bucket名称
  429. * @param string $cname
  430. * @param array $options
  431. * @throws OssException
  432. * @return null
  433. */
  434. public function addBucketCname($bucket, $cname, $options = NULL)
  435. {
  436. $this->precheckCommon($bucket, NULL, $options, false);
  437. $options[self::OSS_BUCKET] = $bucket;
  438. $options[self::OSS_METHOD] = self::OSS_HTTP_POST;
  439. $options[self::OSS_OBJECT] = '/';
  440. $options[self::OSS_SUB_RESOURCE] = 'cname';
  441. $options[self::OSS_CONTENT_TYPE] = 'application/xml';
  442. $cnameConfig = new CnameConfig();
  443. $cnameConfig->addCname($cname);
  444. $options[self::OSS_CONTENT] = $cnameConfig->serializeToXml();
  445. $options[self::OSS_CNAME_COMP] = 'add';
  446. $response = $this->auth($options);
  447. $result = new PutSetDeleteResult($response);
  448. return $result->getData();
  449. }
  450. /**
  451. * 获取指定Bucket已绑定的CNAME列表
  452. *
  453. * @param string $bucket bucket名称
  454. * @param array $options
  455. * @throws OssException
  456. * @return CnameConfig
  457. */
  458. public function getBucketCname($bucket, $options = NULL)
  459. {
  460. $this->precheckCommon($bucket, NULL, $options, false);
  461. $options[self::OSS_BUCKET] = $bucket;
  462. $options[self::OSS_METHOD] = self::OSS_HTTP_GET;
  463. $options[self::OSS_OBJECT] = '/';
  464. $options[self::OSS_SUB_RESOURCE] = 'cname';
  465. $response = $this->auth($options);
  466. $result = new GetCnameResult($response);
  467. return $result->getData();
  468. }
  469. /**
  470. * 解除指定Bucket的CNAME绑定
  471. *
  472. * @param string $bucket bucket名称
  473. * @param CnameConfig $cnameConfig
  474. * @param array $options
  475. * @throws OssException
  476. * @return null
  477. */
  478. public function deleteBucketCname($bucket, $cname, $options = NULL)
  479. {
  480. $this->precheckCommon($bucket, NULL, $options, false);
  481. $options[self::OSS_BUCKET] = $bucket;
  482. $options[self::OSS_METHOD] = self::OSS_HTTP_POST;
  483. $options[self::OSS_OBJECT] = '/';
  484. $options[self::OSS_SUB_RESOURCE] = 'cname';
  485. $options[self::OSS_CONTENT_TYPE] = 'application/xml';
  486. $cnameConfig = new CnameConfig();
  487. $cnameConfig->addCname($cname);
  488. $options[self::OSS_CONTENT] = $cnameConfig->serializeToXml();
  489. $options[self::OSS_CNAME_COMP] = 'delete';
  490. $response = $this->auth($options);
  491. $result = new PutSetDeleteResult($response);
  492. return $result->getData();
  493. }
  494. /**
  495. * 检验跨域资源请求, 发送跨域请求之前会发送一个preflight请求(OPTIONS)并带上特定的来源域,
  496. * HTTP方法和header信息等给OSS以决定是否发送真正的请求。 OSS可以通过putBucketCors接口
  497. * 来开启Bucket的CORS支持,开启CORS功能之后,OSS在收到浏览器preflight请求时会根据设定的
  498. * 规则评估是否允许本次请求
  499. *
  500. * @param string $bucket bucket名称
  501. * @param string $object object名称
  502. * @param string $origin 请求来源域
  503. * @param string $request_method 表明实际请求中会使用的HTTP方法
  504. * @param string $request_headers 表明实际请求中会使用的除了简单头部之外的headers
  505. * @param array $options
  506. * @return array
  507. * @throws OssException
  508. * @link http://help.aliyun.com/document_detail/oss/api-reference/cors/OptionObject.html
  509. */
  510. public function optionsObject($bucket, $object, $origin, $request_method, $request_headers, $options = NULL)
  511. {
  512. $this->precheckCommon($bucket, NULL, $options, false);
  513. $options[self::OSS_BUCKET] = $bucket;
  514. $options[self::OSS_METHOD] = self::OSS_HTTP_OPTIONS;
  515. $options[self::OSS_OBJECT] = $object;
  516. $options[self::OSS_HEADERS] = array(
  517. self::OSS_OPTIONS_ORIGIN => $origin,
  518. self::OSS_OPTIONS_REQUEST_HEADERS => $request_headers,
  519. self::OSS_OPTIONS_REQUEST_METHOD => $request_method
  520. );
  521. $response = $this->auth($options);
  522. $result = new HeaderResult($response);
  523. return $result->getData();
  524. }
  525. /**
  526. * 设置Bucket的Lifecycle配置
  527. *
  528. * @param string $bucket bucket名称
  529. * @param LifecycleConfig $lifecycleConfig Lifecycle配置类
  530. * @param array $options
  531. * @throws OssException
  532. * @return null
  533. */
  534. public function putBucketLifecycle($bucket, $lifecycleConfig, $options = NULL)
  535. {
  536. $this->precheckCommon($bucket, NULL, $options, false);
  537. $options[self::OSS_BUCKET] = $bucket;
  538. $options[self::OSS_METHOD] = self::OSS_HTTP_PUT;
  539. $options[self::OSS_OBJECT] = '/';
  540. $options[self::OSS_SUB_RESOURCE] = 'lifecycle';
  541. $options[self::OSS_CONTENT_TYPE] = 'application/xml';
  542. $options[self::OSS_CONTENT] = $lifecycleConfig->serializeToXml();
  543. $response = $this->auth($options);
  544. $result = new PutSetDeleteResult($response);
  545. return $result->getData();
  546. }
  547. /**
  548. * 获取Bucket的Lifecycle配置情况
  549. *
  550. * @param string $bucket bucket名称
  551. * @param array $options
  552. * @throws OssException
  553. * @return LifecycleConfig
  554. */
  555. public function getBucketLifecycle($bucket, $options = NULL)
  556. {
  557. $this->precheckCommon($bucket, NULL, $options, false);
  558. $options[self::OSS_BUCKET] = $bucket;
  559. $options[self::OSS_METHOD] = self::OSS_HTTP_GET;
  560. $options[self::OSS_OBJECT] = '/';
  561. $options[self::OSS_SUB_RESOURCE] = 'lifecycle';
  562. $response = $this->auth($options);
  563. $result = new GetLifecycleResult($response);
  564. return $result->getData();
  565. }
  566. /**
  567. * 删除指定Bucket的生命周期配置
  568. *
  569. * @param string $bucket bucket名称
  570. * @param array $options
  571. * @throws OssException
  572. * @return null
  573. */
  574. public function deleteBucketLifecycle($bucket, $options = NULL)
  575. {
  576. $this->precheckCommon($bucket, NULL, $options, false);
  577. $options[self::OSS_BUCKET] = $bucket;
  578. $options[self::OSS_METHOD] = self::OSS_HTTP_DELETE;
  579. $options[self::OSS_OBJECT] = '/';
  580. $options[self::OSS_SUB_RESOURCE] = 'lifecycle';
  581. $response = $this->auth($options);
  582. $result = new PutSetDeleteResult($response);
  583. return $result->getData();
  584. }
  585. /**
  586. * 设置一个bucket的referer访问白名单和是否允许referer字段为空的请求访问
  587. * Bucket Referer防盗链具体见OSS防盗链
  588. *
  589. * @param string $bucket bucket名称
  590. * @param RefererConfig $refererConfig
  591. * @param array $options
  592. * @return ResponseCore
  593. * @throws null
  594. */
  595. public function putBucketReferer($bucket, $refererConfig, $options = NULL)
  596. {
  597. $this->precheckCommon($bucket, NULL, $options, false);
  598. $options[self::OSS_BUCKET] = $bucket;
  599. $options[self::OSS_METHOD] = self::OSS_HTTP_PUT;
  600. $options[self::OSS_OBJECT] = '/';
  601. $options[self::OSS_SUB_RESOURCE] = 'referer';
  602. $options[self::OSS_CONTENT_TYPE] = 'application/xml';
  603. $options[self::OSS_CONTENT] = $refererConfig->serializeToXml();
  604. $response = $this->auth($options);
  605. $result = new PutSetDeleteResult($response);
  606. return $result->getData();
  607. }
  608. /**
  609. * 获取Bucket的Referer配置情况
  610. * Bucket Referer防盗链具体见OSS防盗链
  611. *
  612. * @param string $bucket bucket名称
  613. * @param array $options
  614. * @throws OssException
  615. * @return RefererConfig
  616. */
  617. public function getBucketReferer($bucket, $options = NULL)
  618. {
  619. $this->precheckCommon($bucket, NULL, $options, false);
  620. $options[self::OSS_BUCKET] = $bucket;
  621. $options[self::OSS_METHOD] = self::OSS_HTTP_GET;
  622. $options[self::OSS_OBJECT] = '/';
  623. $options[self::OSS_SUB_RESOURCE] = 'referer';
  624. $response = $this->auth($options);
  625. $result = new GetRefererResult($response);
  626. return $result->getData();
  627. }
  628. /**
  629. * 获取bucket下的object列表
  630. *
  631. * @param string $bucket
  632. * @param array $options
  633. * 其中options中的参数如下
  634. * $options = array(
  635. * 'max-keys' => max-keys用于限定此次返回object的最大数,如果不设定,默认为100,max-keys取值不能大于1000。
  636. * 'prefix' => 限定返回的object key必须以prefix作为前缀。注意使用prefix查询时,返回的key中仍会包含prefix。
  637. * 'delimiter' => 是一个用于对Object名字进行分组的字符。所有名字包含指定的前缀且第一次出现delimiter字符之间的object作为一组元素
  638. * 'marker' => 用户设定结果从marker之后按字母排序的第一个开始返回。
  639. *)
  640. * 其中 prefix,marker用来实现分页显示效果,参数的长度必须小于256字节。
  641. * @throws OssException
  642. * @return ObjectListInfo
  643. */
  644. public function listObjects($bucket, $options = NULL)
  645. {
  646. $this->precheckCommon($bucket, NULL, $options, false);
  647. $options[self::OSS_BUCKET] = $bucket;
  648. $options[self::OSS_METHOD] = self::OSS_HTTP_GET;
  649. $options[self::OSS_OBJECT] = '/';
  650. $options[self::OSS_HEADERS] = array(
  651. self::OSS_DELIMITER => isset($options[self::OSS_DELIMITER]) ? $options[self::OSS_DELIMITER] : '/',
  652. self::OSS_PREFIX => isset($options[self::OSS_PREFIX]) ? $options[self::OSS_PREFIX] : '',
  653. self::OSS_MAX_KEYS => isset($options[self::OSS_MAX_KEYS]) ? $options[self::OSS_MAX_KEYS] : self::OSS_MAX_KEYS_VALUE,
  654. self::OSS_MARKER => isset($options[self::OSS_MARKER]) ? $options[self::OSS_MARKER] : '',
  655. );
  656. $query = isset($options[self::OSS_QUERY_STRING]) ? $options[self::OSS_QUERY_STRING] : array();
  657. $options[self::OSS_QUERY_STRING] = array_merge(
  658. $query,
  659. array(self::OSS_ENCODING_TYPE => self::OSS_ENCODING_TYPE_URL)
  660. );
  661. $response = $this->auth($options);
  662. $result = new ListObjectsResult($response);
  663. return $result->getData();
  664. }
  665. /**
  666. * 创建虚拟目录 (本函数会在object名称后增加'/', 所以创建目录的object名称不需要'/'结尾,否则,目录名称会变成'//')
  667. *
  668. * 暂不开放此接口
  669. *
  670. * @param string $bucket bucket名称
  671. * @param string $object object名称
  672. * @param array $options
  673. * @return null
  674. */
  675. public function createObjectDir($bucket, $object, $options = NULL)
  676. {
  677. $this->precheckCommon($bucket, $object, $options);
  678. $options[self::OSS_BUCKET] = $bucket;
  679. $options[self::OSS_METHOD] = self::OSS_HTTP_PUT;
  680. $options[self::OSS_OBJECT] = $object . '/';
  681. $options[self::OSS_CONTENT_LENGTH] = array(self::OSS_CONTENT_LENGTH => 0);
  682. $response = $this->auth($options);
  683. $result = new PutSetDeleteResult($response);
  684. return $result->getData();
  685. }
  686. /**
  687. * 上传内存中的内容
  688. *
  689. * @param string $bucket bucket名称
  690. * @param string $object objcet名称
  691. * @param string $content 上传的内容
  692. * @param array $options
  693. * @return null
  694. */
  695. public function putObject($bucket, $object, $content, $options = NULL)
  696. {
  697. $this->precheckCommon($bucket, $object, $options);
  698. OssUtil::validateContent($content);
  699. $options[self::OSS_CONTENT] = $content;
  700. $options[self::OSS_BUCKET] = $bucket;
  701. $options[self::OSS_METHOD] = self::OSS_HTTP_PUT;
  702. $options[self::OSS_OBJECT] = $object;
  703. if (!isset($options[self::OSS_LENGTH])) {
  704. $options[self::OSS_CONTENT_LENGTH] = strlen($options[self::OSS_CONTENT]);
  705. } else {
  706. $options[self::OSS_CONTENT_LENGTH] = $options[self::OSS_LENGTH];
  707. }
  708. if (!isset($options[self::OSS_CONTENT_TYPE])) {
  709. $options[self::OSS_CONTENT_TYPE] = $this->getMimeType($object);
  710. }
  711. $response = $this->auth($options);
  712. $result = new PutSetDeleteResult($response);
  713. return $result->getData();
  714. }
  715. /**
  716. * 上传本地文件
  717. *
  718. * @param string $bucket bucket名称
  719. * @param string $object object名称
  720. * @param string $file 本地文件路径
  721. * @param array $options
  722. * @return null
  723. * @throws OssException
  724. */
  725. public function uploadFile($bucket, $object, $file, $options = NULL)
  726. {
  727. $this->precheckCommon($bucket, $object, $options);
  728. OssUtil::throwOssExceptionWithMessageIfEmpty($file, "file path is invalid");
  729. $file = OssUtil::encodePath($file);
  730. if (!file_exists($file)) {
  731. throw new OssException($file . " file does not exist");
  732. }
  733. $options[self::OSS_FILE_UPLOAD] = $file;
  734. $file_size = filesize($options[self::OSS_FILE_UPLOAD]);
  735. $is_check_md5 = $this->isCheckMD5($options);
  736. if ($is_check_md5) {
  737. $content_md5 = base64_encode(md5_file($options[self::OSS_FILE_UPLOAD], true));
  738. $options[self::OSS_CONTENT_MD5] = $content_md5;
  739. }
  740. if (!isset($options[self::OSS_CONTENT_TYPE])) {
  741. $options[self::OSS_CONTENT_TYPE] = $this->getMimeType($object, $file);
  742. }
  743. $options[self::OSS_METHOD] = self::OSS_HTTP_PUT;
  744. $options[self::OSS_BUCKET] = $bucket;
  745. $options[self::OSS_OBJECT] = $object;
  746. $options[self::OSS_CONTENT_LENGTH] = $file_size;
  747. $response = $this->auth($options);
  748. $result = new PutSetDeleteResult($response);
  749. return $result->getData();
  750. }
  751. /**
  752. * 追加上传内存中的内容
  753. *
  754. * @param string $bucket bucket名称
  755. * @param string $object objcet名称
  756. * @param string $content 本次追加上传的内容
  757. * @param array $options
  758. * @return int next append position
  759. * @throws OssException
  760. */
  761. public function appendObject($bucket, $object, $content, $position, $options = NULL)
  762. {
  763. $this->precheckCommon($bucket, $object, $options);
  764. OssUtil::validateContent($content);
  765. $options[self::OSS_CONTENT] = $content;
  766. $options[self::OSS_BUCKET] = $bucket;
  767. $options[self::OSS_METHOD] = self::OSS_HTTP_POST;
  768. $options[self::OSS_OBJECT] = $object;
  769. $options[self::OSS_SUB_RESOURCE] = 'append';
  770. $options[self::OSS_POSITION] = strval($position);
  771. if (!isset($options[self::OSS_LENGTH])) {
  772. $options[self::OSS_CONTENT_LENGTH] = strlen($options[self::OSS_CONTENT]);
  773. } else {
  774. $options[self::OSS_CONTENT_LENGTH] = $options[self::OSS_LENGTH];
  775. }
  776. if (!isset($options[self::OSS_CONTENT_TYPE])) {
  777. $options[self::OSS_CONTENT_TYPE] = $this->getMimeType($object);
  778. }
  779. $response = $this->auth($options);
  780. $result = new AppendResult($response);
  781. return $result->getData();
  782. }
  783. /**
  784. * 追加上传本地文件
  785. *
  786. * @param string $bucket bucket名称
  787. * @param string $object object名称
  788. * @param string $file 追加上传的本地文件路径
  789. * @param array $options
  790. * @return int next append position
  791. * @throws OssException
  792. */
  793. public function appendFile($bucket, $object, $file, $position, $options = NULL)
  794. {
  795. $this->precheckCommon($bucket, $object, $options);
  796. OssUtil::throwOssExceptionWithMessageIfEmpty($file, "file path is invalid");
  797. $file = OssUtil::encodePath($file);
  798. if (!file_exists($file)) {
  799. throw new OssException($file . " file does not exist");
  800. }
  801. $options[self::OSS_FILE_UPLOAD] = $file;
  802. $file_size = filesize($options[self::OSS_FILE_UPLOAD]);
  803. $is_check_md5 = $this->isCheckMD5($options);
  804. if ($is_check_md5) {
  805. $content_md5 = base64_encode(md5_file($options[self::OSS_FILE_UPLOAD], true));
  806. $options[self::OSS_CONTENT_MD5] = $content_md5;
  807. }
  808. if (!isset($options[self::OSS_CONTENT_TYPE])) {
  809. $options[self::OSS_CONTENT_TYPE] = $this->getMimeType($object, $file);
  810. }
  811. $options[self::OSS_METHOD] = self::OSS_HTTP_POST;
  812. $options[self::OSS_BUCKET] = $bucket;
  813. $options[self::OSS_OBJECT] = $object;
  814. $options[self::OSS_CONTENT_LENGTH] = $file_size;
  815. $options[self::OSS_SUB_RESOURCE] = 'append';
  816. $options[self::OSS_POSITION] = strval($position);
  817. $response = $this->auth($options);
  818. $result = new AppendResult($response);
  819. return $result->getData();
  820. }
  821. /**
  822. * 拷贝一个在OSS上已经存在的object成另外一个object
  823. *
  824. * @param string $fromBucket 源bucket名称
  825. * @param string $fromObject 源object名称
  826. * @param string $toBucket 目标bucket名称
  827. * @param string $toObject 目标object名称
  828. * @param array $options
  829. * @return null
  830. * @throws OssException
  831. */
  832. public function copyObject($fromBucket, $fromObject, $toBucket, $toObject, $options = NULL)
  833. {
  834. $this->precheckCommon($fromBucket, $fromObject, $options);
  835. $this->precheckCommon($toBucket, $toObject, $options);
  836. $options[self::OSS_BUCKET] = $toBucket;
  837. $options[self::OSS_METHOD] = self::OSS_HTTP_PUT;
  838. $options[self::OSS_OBJECT] = $toObject;
  839. if (isset($options[self::OSS_HEADERS])) {
  840. $options[self::OSS_HEADERS][self::OSS_OBJECT_COPY_SOURCE] = '/' . $fromBucket . '/' . $fromObject;
  841. } else {
  842. $options[self::OSS_HEADERS] = array(self::OSS_OBJECT_COPY_SOURCE => '/' . $fromBucket . '/' . $fromObject);
  843. }
  844. $response = $this->auth($options);
  845. $result = new PutSetDeleteResult($response);
  846. return $result->getData();
  847. }
  848. /**
  849. * 获取Object的Meta信息
  850. *
  851. * @param string $bucket bucket名称
  852. * @param string $object object名称
  853. * @param string $options 具体参考SDK文档
  854. * @return array
  855. */
  856. public function getObjectMeta($bucket, $object, $options = NULL)
  857. {
  858. $this->precheckCommon($bucket, $object, $options);
  859. $options[self::OSS_BUCKET] = $bucket;
  860. $options[self::OSS_METHOD] = self::OSS_HTTP_HEAD;
  861. $options[self::OSS_OBJECT] = $object;
  862. $response = $this->auth($options);
  863. $result = new HeaderResult($response);
  864. return $result->getData();
  865. }
  866. /**
  867. * 删除某个Object
  868. *
  869. * @param string $bucket bucket名称
  870. * @param string $object object名称
  871. * @param array $options
  872. * @return null
  873. */
  874. public function deleteObject($bucket, $object, $options = NULL)
  875. {
  876. $this->precheckCommon($bucket, $object, $options);
  877. $options[self::OSS_BUCKET] = $bucket;
  878. $options[self::OSS_METHOD] = self::OSS_HTTP_DELETE;
  879. $options[self::OSS_OBJECT] = $object;
  880. $response = $this->auth($options);
  881. $result = new PutSetDeleteResult($response);
  882. return $result->getData();
  883. }
  884. /**
  885. * 删除同一个Bucket中的多个Object
  886. *
  887. * @param string $bucket bucket名称
  888. * @param array $objects object列表
  889. * @param array $options
  890. * @return ResponseCore
  891. * @throws null
  892. */
  893. public function deleteObjects($bucket, $objects, $options = null)
  894. {
  895. $this->precheckCommon($bucket, NULL, $options, false);
  896. if (!is_array($objects) || !$objects) {
  897. throw new OssException('objects must be array');
  898. }
  899. $options[self::OSS_METHOD] = self::OSS_HTTP_POST;
  900. $options[self::OSS_BUCKET] = $bucket;
  901. $options[self::OSS_OBJECT] = '/';
  902. $options[self::OSS_SUB_RESOURCE] = 'delete';
  903. $options[self::OSS_CONTENT_TYPE] = 'application/xml';
  904. $quiet = 'false';
  905. if (isset($options['quiet'])) {
  906. if (is_bool($options['quiet'])) { //Boolean
  907. $quiet = $options['quiet'] ? 'true' : 'false';
  908. } elseif (is_string($options['quiet'])) { // string
  909. $quiet = ($options['quiet'] === 'true') ? 'true' : 'false';
  910. }
  911. }
  912. $xmlBody = OssUtil::createDeleteObjectsXmlBody($objects, $quiet);
  913. $options[self::OSS_CONTENT] = $xmlBody;
  914. $response = $this->auth($options);
  915. $result = new PutSetDeleteResult($response);
  916. return $result->getData();
  917. }
  918. /**
  919. * 获得Object内容
  920. *
  921. * @param string $bucket bucket名称
  922. * @param string $object object名称
  923. * @param array $options 该参数中必须设置ALIOSS::OSS_FILE_DOWNLOAD,ALIOSS::OSS_RANGE可选,可以根据实际情况设置;如果不设置,默认会下载全部内容
  924. * @return string
  925. */
  926. public function getObject($bucket, $object, $options = NULL)
  927. {
  928. $this->precheckCommon($bucket, $object, $options);
  929. $options[self::OSS_BUCKET] = $bucket;
  930. $options[self::OSS_METHOD] = self::OSS_HTTP_GET;
  931. $options[self::OSS_OBJECT] = $object;
  932. if (isset($options[self::OSS_LAST_MODIFIED])) {
  933. $options[self::OSS_HEADERS][self::OSS_IF_MODIFIED_SINCE] = $options[self::OSS_LAST_MODIFIED];
  934. unset($options[self::OSS_LAST_MODIFIED]);
  935. }
  936. if (isset($options[self::OSS_ETAG])) {
  937. $options[self::OSS_HEADERS][self::OSS_IF_NONE_MATCH] = $options[self::OSS_ETAG];
  938. unset($options[self::OSS_ETAG]);
  939. }
  940. if (isset($options[self::OSS_RANGE])) {
  941. $range = $options[self::OSS_RANGE];
  942. $options[self::OSS_HEADERS][self::OSS_RANGE] = "bytes=$range";
  943. unset($options[self::OSS_RANGE]);
  944. }
  945. $response = $this->auth($options);
  946. $result = new BodyResult($response);
  947. return $result->getData();
  948. }
  949. /**
  950. * 检测Object是否存在
  951. * 通过获取Object的Meta信息来判断Object是否存在, 用户需要自行解析ResponseCore判断object是否存在
  952. *
  953. * @param string $bucket bucket名称
  954. * @param string $object object名称
  955. * @param array $options
  956. * @return bool
  957. */
  958. public function doesObjectExist($bucket, $object, $options = NULL)
  959. {
  960. $this->precheckCommon($bucket, $object, $options);
  961. $options[self::OSS_BUCKET] = $bucket;
  962. $options[self::OSS_METHOD] = self::OSS_HTTP_HEAD;
  963. $options[self::OSS_OBJECT] = $object;
  964. $response = $this->auth($options);
  965. $result = new ExistResult($response);
  966. return $result->getData();
  967. }
  968. /**
  969. * 获取分片大小,根据用户提供的part_size,重新计算一个更合理的partsize
  970. *
  971. * @param int $partSize
  972. * @return int
  973. */
  974. private function computePartSize($partSize)
  975. {
  976. $partSize = (integer)$partSize;
  977. if ($partSize <= self::OSS_MIN_PART_SIZE) {
  978. $partSize = self::OSS_MIN_PART_SIZE;
  979. } elseif ($partSize > self::OSS_MAX_PART_SIZE) {
  980. $partSize = self::OSS_MAX_PART_SIZE;
  981. }
  982. return $partSize;
  983. }
  984. /**
  985. * 计算文件可以分成多少个part,以及每个part的长度以及起始位置
  986. * 方法必须在 <upload_part()>中调用
  987. *
  988. * @param integer $file_size 文件大小
  989. * @param integer $partSize part大小,默认5M
  990. * @return array An array 包含 key-value 键值对. Key 为 `seekTo` 和 `length`.
  991. */
  992. public function generateMultiuploadParts($file_size, $partSize = 5242880)
  993. {
  994. $i = 0;
  995. $size_count = $file_size;
  996. $values = array();
  997. $partSize = $this->computePartSize($partSize);
  998. while ($size_count > 0) {
  999. $size_count -= $partSize;
  1000. $values[] = array(
  1001. self::OSS_SEEK_TO => ($partSize * $i),
  1002. self::OSS_LENGTH => (($size_count > 0) ? $partSize : ($size_count + $partSize)),
  1003. );
  1004. $i++;
  1005. }
  1006. return $values;
  1007. }
  1008. /**
  1009. * 初始化multi-part upload
  1010. *
  1011. * @param string $bucket Bucket名称
  1012. * @param string $object Object名称
  1013. * @param array $options Key-Value数组
  1014. * @throws OssException
  1015. * @return string 返回uploadid
  1016. */
  1017. public function initiateMultipartUpload($bucket, $object, $options = NULL)
  1018. {
  1019. $this->precheckCommon($bucket, $object, $options);
  1020. $options[self::OSS_METHOD] = self::OSS_HTTP_POST;
  1021. $options[self::OSS_BUCKET] = $bucket;
  1022. $options[self::OSS_OBJECT] = $object;
  1023. $options[self::OSS_SUB_RESOURCE] = 'uploads';
  1024. $options[self::OSS_CONTENT] = '';
  1025. if (!isset($options[self::OSS_CONTENT_TYPE])) {
  1026. $options[self::OSS_CONTENT_TYPE] = $this->getMimeType($object);
  1027. }
  1028. if (!isset($options[self::OSS_HEADERS])) {
  1029. $options[self::OSS_HEADERS] = array();
  1030. }
  1031. $response = $this->auth($options);
  1032. $result = new InitiateMultipartUploadResult($response);
  1033. return $result->getData();
  1034. }
  1035. /**
  1036. * 分片上传的块上传接口
  1037. *
  1038. * @param string $bucket Bucket名称
  1039. * @param string $object Object名称
  1040. * @param string $uploadId
  1041. * @param array $options Key-Value数组
  1042. * @return string eTag
  1043. * @throws OssException
  1044. */
  1045. public function uploadPart($bucket, $object, $uploadId, $options = null)
  1046. {
  1047. $this->precheckCommon($bucket, $object, $options);
  1048. $this->precheckParam($options, self::OSS_FILE_UPLOAD, __FUNCTION__);
  1049. $this->precheckParam($options, self::OSS_PART_NUM, __FUNCTION__);
  1050. $options[self::OSS_METHOD] = self::OSS_HTTP_PUT;
  1051. $options[self::OSS_BUCKET] = $bucket;
  1052. $options[self::OSS_OBJECT] = $object;
  1053. $options[self::OSS_UPLOAD_ID] = $uploadId;
  1054. if (isset($options[self::OSS_LENGTH])) {
  1055. $options[self::OSS_CONTENT_LENGTH] = $options[self::OSS_LENGTH];
  1056. }
  1057. $response = $this->auth($options);
  1058. $result = new UploadPartResult($response);
  1059. return $result->getData();
  1060. }
  1061. /**
  1062. * 获取已成功上传的part
  1063. *
  1064. * @param string $bucket Bucket名称
  1065. * @param string $object Object名称
  1066. * @param string $uploadId uploadId
  1067. * @param array $options Key-Value数组
  1068. * @return ListPartsInfo
  1069. * @throws OssException
  1070. */
  1071. public function listParts($bucket, $object, $uploadId, $options = null)
  1072. {
  1073. $this->precheckCommon($bucket, $object, $options);
  1074. $options[self::OSS_METHOD] = self::OSS_HTTP_GET;
  1075. $options[self::OSS_BUCKET] = $bucket;
  1076. $options[self::OSS_OBJECT] = $object;
  1077. $options[self::OSS_UPLOAD_ID] = $uploadId;
  1078. $options[self::OSS_QUERY_STRING] = array();
  1079. foreach (array('max-parts', 'part-number-marker') as $param) {
  1080. if (isset($options[$param])) {
  1081. $options[self::OSS_QUERY_STRING][$param] = $options[$param];
  1082. unset($options[$param]);
  1083. }
  1084. }
  1085. $response = $this->auth($options);
  1086. $result = new ListPartsResult($response);
  1087. return $result->getData();
  1088. }
  1089. /**
  1090. * 中止进行一半的分片上传操作
  1091. *
  1092. * @param string $bucket Bucket名称
  1093. * @param string $object Object名称
  1094. * @param string $uploadId uploadId
  1095. * @param array $options Key-Value数组
  1096. * @return null
  1097. * @throws OssException
  1098. */
  1099. public function abortMultipartUpload($bucket, $object, $uploadId, $options = NULL)
  1100. {
  1101. $this->precheckCommon($bucket, $object, $options);
  1102. $options[self::OSS_METHOD] = self::OSS_HTTP_DELETE;
  1103. $options[self::OSS_BUCKET] = $bucket;
  1104. $options[self::OSS_OBJECT] = $object;
  1105. $options[self::OSS_UPLOAD_ID] = $uploadId;
  1106. $response = $this->auth($options);
  1107. $result = new PutSetDeleteResult($response);
  1108. return $result->getData();
  1109. }
  1110. /**
  1111. * 在将所有数据Part都上传完成后,调用此接口完成本次分块上传
  1112. *
  1113. * @param string $bucket Bucket名称
  1114. * @param string $object Object名称
  1115. * @param string $uploadId uploadId
  1116. * @param array $listParts array( array("PartNumber"=> int, "ETag"=>string))
  1117. * @param array $options Key-Value数组
  1118. * @throws OssException
  1119. * @return null
  1120. */
  1121. public function completeMultipartUpload($bucket, $object, $uploadId, $listParts, $options = NULL)
  1122. {
  1123. $this->precheckCommon($bucket, $object, $options);
  1124. $options[self::OSS_METHOD] = self::OSS_HTTP_POST;
  1125. $options[self::OSS_BUCKET] = $bucket;
  1126. $options[self::OSS_OBJECT] = $object;
  1127. $options[self::OSS_UPLOAD_ID] = $uploadId;
  1128. $options[self::OSS_CONTENT_TYPE] = 'application/xml';
  1129. if (!is_array($listParts)) {
  1130. throw new OssException("listParts must be array type");
  1131. }
  1132. $options[self::OSS_CONTENT] = OssUtil::createCompleteMultipartUploadXmlBody($listParts);
  1133. $response = $this->auth($options);
  1134. $result = new PutSetDeleteResult($response);
  1135. return $result->getData();
  1136. }
  1137. /**
  1138. * 罗列出所有执行中的Multipart Upload事件,即已经被初始化的Multipart Upload但是未被
  1139. * Complete或者Abort的Multipart Upload事件
  1140. *
  1141. * @param string $bucket bucket
  1142. * @param array $options 关联数组
  1143. * @throws OssException
  1144. * @return ListMultipartUploadInfo
  1145. */
  1146. public function listMultipartUploads($bucket, $options = null)
  1147. {
  1148. $this->precheckCommon($bucket, NULL, $options, false);
  1149. $options[self::OSS_METHOD] = self::OSS_HTTP_GET;
  1150. $options[self::OSS_BUCKET] = $bucket;
  1151. $options[self::OSS_OBJECT] = '/';
  1152. $options[self::OSS_SUB_RESOURCE] = 'uploads';
  1153. foreach (array('delimiter', 'key-marker', 'max-uploads', 'prefix', 'upload-id-marker') as $param) {
  1154. if (isset($options[$param])) {
  1155. $options[self::OSS_QUERY_STRING][$param] = $options[$param];
  1156. unset($options[$param]);
  1157. }
  1158. }
  1159. $query = isset($options[self::OSS_QUERY_STRING]) ? $options[self::OSS_QUERY_STRING] : array();
  1160. $options[self::OSS_QUERY_STRING] = array_merge(
  1161. $query,
  1162. array(self::OSS_ENCODING_TYPE => self::OSS_ENCODING_TYPE_URL)
  1163. );
  1164. $response = $this->auth($options);
  1165. $result = new ListMultipartUploadResult($response);
  1166. return $result->getData();
  1167. }
  1168. /**
  1169. * 从一个已存在的Object中拷贝数据来上传一个Part
  1170. *
  1171. * @param string $fromBucket 源bucket名称
  1172. * @param string $fromObject 源object名称
  1173. * @param string $toBucket 目标bucket名称
  1174. * @param string $toObject 目标object名称
  1175. * @param int $partNumber 分块上传的块id
  1176. * @param string $uploadId 初始化multipart upload返回的uploadid
  1177. * @param array $options Key-Value数组
  1178. * @return null
  1179. * @throws OssException
  1180. */
  1181. public function uploadPartCopy($fromBucket, $fromObject, $toBucket, $toObject, $partNumber, $uploadId, $options = NULL)
  1182. {
  1183. $this->precheckCommon($fromBucket, $fromObject, $options);
  1184. $this->precheckCommon($toBucket, $toObject, $options);
  1185. //如果没有设置$options['isFullCopy'],则需要强制判断copy的起止位置
  1186. $start_range = "0";
  1187. if (isset($options['start'])) {
  1188. $start_range = $options['start'];
  1189. }
  1190. $end_range = "";
  1191. if (isset($options['end'])) {
  1192. $end_range = $options['end'];
  1193. }
  1194. $options[self::OSS_METHOD] = self::OSS_HTTP_PUT;
  1195. $options[self::OSS_BUCKET] = $toBucket;
  1196. $options[self::OSS_OBJECT] = $toObject;
  1197. $options[self::OSS_PART_NUM] = $partNumber;
  1198. $options[self::OSS_UPLOAD_ID] = $uploadId;
  1199. if (!isset($options[self::OSS_HEADERS])) {
  1200. $options[self::OSS_HEADERS] = array();
  1201. }
  1202. $options[self::OSS_HEADERS][self::OSS_OBJECT_COPY_SOURCE] = '/' . $fromBucket . '/' . $fromObject;
  1203. $options[self::OSS_HEADERS][self::OSS_OBJECT_COPY_SOURCE_RANGE] = "bytes=" . $start_range . "-" . $end_range;
  1204. $response = $this->auth($options);
  1205. $result = new UploadPartResult($response);
  1206. return $result->getData();
  1207. }
  1208. /**
  1209. * multipart上传统一封装,从初始化到完成multipart,以及出错后中止动作
  1210. *
  1211. * @param string $bucket bucket名称
  1212. * @param string $object object名称
  1213. * @param string $file 需要上传的本地文件的路径
  1214. * @param array $options Key-Value数组
  1215. * @return null
  1216. * @throws OssException
  1217. */
  1218. public function multiuploadFile($bucket, $object, $file, $options = null)
  1219. {
  1220. $this->precheckCommon($bucket, $object, $options);
  1221. if (isset($options[self::OSS_LENGTH])) {
  1222. $options[self::OSS_CONTENT_LENGTH] = $options[self::OSS_LENGTH];
  1223. unset($options[self::OSS_LENGTH]);
  1224. }
  1225. if (empty($file)) {
  1226. throw new OssException("parameter invalid, file is empty");
  1227. }
  1228. $uploadFile = OssUtil::encodePath($file);
  1229. if (!isset($options[self::OSS_CONTENT_TYPE])) {
  1230. $options[self::OSS_CONTENT_TYPE] = $this->getMimeType($object, $uploadFile);
  1231. }
  1232. $upload_position = isset($options[self::OSS_SEEK_TO]) ? (integer)$options[self::OSS_SEEK_TO] : 0;
  1233. if (isset($options[self::OSS_CONTENT_LENGTH])) {
  1234. $upload_file_size = (integer)$options[self::OSS_CONTENT_LENGTH];
  1235. } else {
  1236. $upload_file_size = filesize($uploadFile);
  1237. if ($upload_file_size !== false) {
  1238. $upload_file_size -= $upload_position;
  1239. }
  1240. }
  1241. if ($upload_position === false || !isset($upload_file_size) || $upload_file_size === false || $upload_file_size < 0) {
  1242. throw new OssException('The size of `fileUpload` cannot be determined in ' . __FUNCTION__ . '().');
  1243. }
  1244. // 处理partSize
  1245. if (isset($options[self::OSS_PART_SIZE])) {
  1246. $options[self::OSS_PART_SIZE] = $this->computePartSize($options[self::OSS_PART_SIZE]);
  1247. } else {
  1248. $options[self::OSS_PART_SIZE] = self::OSS_MID_PART_SIZE;
  1249. }
  1250. $is_check_md5 = $this->isCheckMD5($options);
  1251. // 如果上传的文件小于partSize,则直接使用普通方式上传
  1252. if ($upload_file_size < $options[self::OSS_PART_SIZE] && !isset($options[self::OSS_UPLOAD_ID])) {
  1253. return $this->uploadFile($bucket, $object, $uploadFile, $options);
  1254. }
  1255. // 初始化multipart
  1256. if (isset($options[self::OSS_UPLOAD_ID])) {
  1257. $uploadId = $options[self::OSS_UPLOAD_ID];
  1258. } else {
  1259. // 初始化
  1260. $uploadId = $this->initiateMultipartUpload($bucket, $object, $options);
  1261. }
  1262. // 获取的分片
  1263. $pieces = $this->generateMultiuploadParts($upload_file_size, (integer)$options[self::OSS_PART_SIZE]);
  1264. $response_upload_part = array();
  1265. foreach ($pieces as $i => $piece) {
  1266. $from_pos = $upload_position + (integer)$piece[self::OSS_SEEK_TO];
  1267. $to_pos = (integer)$piece[self::OSS_LENGTH] + $from_pos - 1;
  1268. $up_options = array(
  1269. self::OSS_FILE_UPLOAD => $uploadFile,
  1270. self::OSS_PART_NUM => ($i + 1),
  1271. self::OSS_SEEK_TO => $from_pos,
  1272. self::OSS_LENGTH => $to_pos - $from_pos + 1,
  1273. self::OSS_CHECK_MD5 => $is_check_md5,
  1274. );
  1275. if ($is_check_md5) {
  1276. $content_md5 = OssUtil::getMd5SumForFile($uploadFile, $from_pos, $to_pos);
  1277. $up_options[self::OSS_CONTENT_MD5] = $content_md5;
  1278. }
  1279. $response_upload_part[] = $this->uploadPart($bucket, $object, $uploadId, $up_options);
  1280. }
  1281. $uploadParts = array();
  1282. foreach ($response_upload_part as $i => $etag) {
  1283. $uploadParts[] = array(
  1284. 'PartNumber' => ($i + 1),
  1285. 'ETag' => $etag,
  1286. );
  1287. }
  1288. return $this->completeMultipartUpload($bucket, $object, $uploadId, $uploadParts);
  1289. }
  1290. /**
  1291. * 上传本地目录内的文件或者目录到指定bucket的指定prefix的object中
  1292. *
  1293. * @param string $bucket bucket名称
  1294. * @param string $prefix 需要上传到的object的key前缀,可以理解成bucket中的子目录,结尾不能是'/',接口中会补充'/'
  1295. * @param string $localDirectory 需要上传的本地目录
  1296. * @param string $exclude 需要排除的目录
  1297. * @param bool $recursive 是否递归的上传localDirectory下的子目录内容
  1298. * @param bool $checkMd5
  1299. * @return array 返回两个列表 array("succeededList" => array("object"), "failedList" => array("object"=>"errorMessage"))
  1300. * @throws OssException
  1301. */
  1302. public function uploadDir($bucket, $prefix, $localDirectory, $exclude = '.|..|.svn|.git', $recursive = false, $checkMd5 = true)
  1303. {
  1304. $retArray = array("succeededList" => array(), "failedList" => array());
  1305. if (empty($bucket)) throw new OssException("parameter error, bucket is empty");
  1306. if (!is_string($prefix)) throw new OssException("parameter error, prefix is not string");
  1307. if (empty($localDirectory)) throw new OssException("parameter error, localDirectory is empty");
  1308. $directory = $localDirectory;
  1309. $directory = OssUtil::encodePath($directory);
  1310. //判断是否目录
  1311. if (!is_dir($directory)) {
  1312. throw new OssException('parameter error: ' . $directory . ' is not a directory, please check it');
  1313. }
  1314. //read directory
  1315. $file_list_array = OssUtil::readDir($directory, $exclude, $recursive);
  1316. if (!$file_list_array) {
  1317. throw new OssException($directory . ' is empty...');
  1318. }
  1319. foreach ($file_list_array as $k => $item) {
  1320. if (is_dir($item['path'])) {
  1321. continue;
  1322. }
  1323. $options = array(
  1324. self::OSS_PART_SIZE => self::OSS_MIN_PART_SIZE,
  1325. self::OSS_CHECK_MD5 => $checkMd5,
  1326. );
  1327. $realObject = (!empty($prefix) ? $prefix . '/' : '') . $item['file'];
  1328. try {
  1329. $this->multiuploadFile($bucket, $realObject, $item['path'], $options);
  1330. $retArray["succeededList"][] = $realObject;
  1331. } catch (OssException $e) {
  1332. $retArray["failedList"][$realObject] = $e->getMessage();
  1333. }
  1334. }
  1335. return $retArray;
  1336. }
  1337. /**
  1338. * 支持生成get和put签名, 用户可以生成一个具有一定有效期的
  1339. * 签名过的url
  1340. *
  1341. * @param string $bucket
  1342. * @param string $object
  1343. * @param int $timeout
  1344. * @param string $method
  1345. * @param array $options Key-Value数组
  1346. * @return string
  1347. * @throws OssException
  1348. */
  1349. public function signUrl($bucket, $object, $timeout = 60, $method = self::OSS_HTTP_GET, $options = NULL)
  1350. {
  1351. $this->precheckCommon($bucket, $object, $options);
  1352. //method
  1353. if (self::OSS_HTTP_GET !== $method && self::OSS_HTTP_PUT !== $method) {
  1354. throw new OssException("method is invalid");
  1355. }
  1356. $options[self::OSS_BUCKET] = $bucket;
  1357. $options[self::OSS_OBJECT] = $object;
  1358. $options[self::OSS_METHOD] = $method;
  1359. if (!isset($options[self::OSS_CONTENT_TYPE])) {
  1360. $options[self::OSS_CONTENT_TYPE] = '';
  1361. }
  1362. $timeout = time() + $timeout;
  1363. $options[self::OSS_PREAUTH] = $timeout;
  1364. $options[self::OSS_DATE] = $timeout;
  1365. $this->setSignStsInUrl(true);
  1366. return $this->auth($options);
  1367. }
  1368. /**
  1369. * 检测options参数
  1370. *
  1371. * @param array $options
  1372. * @throws OssException
  1373. */
  1374. private function precheckOptions(&$options)
  1375. {
  1376. OssUtil::validateOptions($options);
  1377. if (!$options) {
  1378. $options = array();
  1379. }
  1380. }
  1381. /**
  1382. * 校验bucket参数
  1383. *
  1384. * @param string $bucket
  1385. * @param string $errMsg
  1386. * @throws OssException
  1387. */
  1388. private function precheckBucket($bucket, $errMsg = 'bucket is not allowed empty')
  1389. {
  1390. OssUtil::throwOssExceptionWithMessageIfEmpty($bucket, $errMsg);
  1391. }
  1392. /**
  1393. * 校验object参数
  1394. *
  1395. * @param string $object
  1396. * @throws OssException
  1397. */
  1398. private function precheckObject($object)
  1399. {
  1400. OssUtil::throwOssExceptionWithMessageIfEmpty($object, "object name is empty");
  1401. }
  1402. /**
  1403. * 校验bucket,options参数
  1404. *
  1405. * @param string $bucket
  1406. * @param string $object
  1407. * @param array $options
  1408. * @param bool $isCheckObject
  1409. */
  1410. private function precheckCommon($bucket, $object, &$options, $isCheckObject = true)
  1411. {
  1412. if ($isCheckObject) {
  1413. $this->precheckObject($object);
  1414. }
  1415. $this->precheckOptions($options);
  1416. $this->precheckBucket($bucket);
  1417. }
  1418. /**
  1419. * 参数校验
  1420. *
  1421. * @param array $options
  1422. * @param string $param
  1423. * @param string $funcName
  1424. * @throws OssException
  1425. */
  1426. private function precheckParam($options, $param, $funcName)
  1427. {
  1428. if (!isset($options[$param])) {
  1429. throw new OssException('The `' . $param . '` options is required in ' . $funcName . '().');
  1430. }
  1431. }
  1432. /**
  1433. * 检测md5
  1434. *
  1435. * @param array $options
  1436. * @return bool|null
  1437. */
  1438. private function isCheckMD5($options)
  1439. {
  1440. return $this->getValue($options, self::OSS_CHECK_MD5, false, true, true);
  1441. }
  1442. /**
  1443. * 获取value
  1444. *
  1445. * @param array $options
  1446. * @param string $key
  1447. * @param string $default
  1448. * @param bool $isCheckEmpty
  1449. * @param bool $isCheckBool
  1450. * @return bool|null
  1451. */
  1452. private function getValue($options, $key, $default = NULL, $isCheckEmpty = false, $isCheckBool = false)
  1453. {
  1454. $value = $default;
  1455. if (isset($options[$key])) {
  1456. if ($isCheckEmpty) {
  1457. if (!empty($options[$key])) {
  1458. $value = $options[$key];
  1459. }
  1460. } else {
  1461. $value = $options[$key];
  1462. }
  1463. unset($options[$key]);
  1464. }
  1465. if ($isCheckBool) {
  1466. if ($value !== true && $value !== false) {
  1467. $value = false;
  1468. }
  1469. }
  1470. return $value;
  1471. }
  1472. /**
  1473. * 获取mimetype类型
  1474. *
  1475. * @param string $object
  1476. * @return string
  1477. */
  1478. private function getMimeType($object, $file = null)
  1479. {
  1480. if (!is_null($file)) {
  1481. $type = MimeTypes::getMimetype($file);
  1482. if (!is_null($type)) {
  1483. return $type;
  1484. }
  1485. }
  1486. $type = MimeTypes::getMimetype($object);
  1487. if (!is_null($type)) {
  1488. return $type;
  1489. }
  1490. return self::DEFAULT_CONTENT_TYPE;
  1491. }
  1492. /**
  1493. * 验证并且执行请求,按照OSS Api协议,执行操作
  1494. *
  1495. * @param array $options
  1496. * @return ResponseCore
  1497. * @throws OssException
  1498. * @throws RequestCore_Exception
  1499. */
  1500. private function auth($options)
  1501. {
  1502. OssUtil::validateOptions($options);
  1503. //验证bucket,list_bucket时不需要验证
  1504. $this->authPrecheckBucket($options);
  1505. //验证object
  1506. $this->authPrecheckObject($options);
  1507. //Object名称的编码必须是utf8
  1508. $this->authPrecheckObjectEncoding($options);
  1509. //验证ACL
  1510. $this->authPrecheckAcl($options);
  1511. // 获得当次请求使用的协议头,是https还是http
  1512. $scheme = $this->useSSL ? 'https://' : 'http://';
  1513. // 获得当次请求使用的hostname,如果是公共域名或者专有域名,bucket拼在前面构成三级域名
  1514. $hostname = $this->generateHostname($options);
  1515. $string_to_sign = '';
  1516. $headers = $this->generateHeaders($options, $hostname);
  1517. $signable_query_string_params = $this->generateSignableQueryStringParam($options);
  1518. $signable_query_string = OssUtil::toQueryString($signable_query_string_params);
  1519. $resource_uri = $this->generateResourceUri($options);
  1520. //生成请求URL
  1521. $conjunction = '?';
  1522. $non_signable_resource = '';
  1523. if (isset($options[self::OSS_SUB_RESOURCE])) {
  1524. $conjunction = '&';
  1525. }
  1526. if ($signable_query_string !== '') {
  1527. $signable_query_string = $conjunction . $signable_query_string;
  1528. $conjunction = '&';
  1529. }
  1530. $query_string = $this->generateQueryString($options);
  1531. if ($query_string !== '') {
  1532. $non_signable_resource .= $conjunction . $query_string;
  1533. $conjunction = '&';
  1534. }
  1535. $this->requestUrl = $scheme . $hostname . $resource_uri . $signable_query_string . $non_signable_resource;
  1536. //创建请求
  1537. $request = new RequestCore($this->requestUrl);
  1538. $request->set_useragent($this->generateUserAgent());
  1539. // Streaming uploads
  1540. if (isset($options[self::OSS_FILE_UPLOAD])) {
  1541. if (is_resource($options[self::OSS_FILE_UPLOAD])) {
  1542. $length = null;
  1543. if (isset($options[self::OSS_CONTENT_LENGTH])) {
  1544. $length = $options[self::OSS_CONTENT_LENGTH];
  1545. } elseif (isset($options[self::OSS_SEEK_TO])) {
  1546. $stats = fstat($options[self::OSS_FILE_UPLOAD]);
  1547. if ($stats && $stats[self::OSS_SIZE] >= 0) {
  1548. $length = $stats[self::OSS_SIZE] - (integer)$options[self::OSS_SEEK_TO];
  1549. }
  1550. }
  1551. $request->set_read_stream($options[self::OSS_FILE_UPLOAD], $length);
  1552. } else {
  1553. $request->set_read_file($options[self::OSS_FILE_UPLOAD]);
  1554. $length = $request->read_stream_size;
  1555. if (isset($options[self::OSS_CONTENT_LENGTH])) {
  1556. $length = $options[self::OSS_CONTENT_LENGTH];
  1557. } elseif (isset($options[self::OSS_SEEK_TO]) && isset($length)) {
  1558. $length -= (integer)$options[self::OSS_SEEK_TO];
  1559. }
  1560. $request->set_read_stream_size($length);
  1561. }
  1562. }
  1563. if (isset($options[self::OSS_SEEK_TO])) {
  1564. $request->set_seek_position((integer)$options[self::OSS_SEEK_TO]);
  1565. }
  1566. if (isset($options[self::OSS_FILE_DOWNLOAD])) {
  1567. if (is_resource($options[self::OSS_FILE_DOWNLOAD])) {
  1568. $request->set_write_stream($options[self::OSS_FILE_DOWNLOAD]);
  1569. } else {
  1570. $request->set_write_file($options[self::OSS_FILE_DOWNLOAD]);
  1571. }
  1572. }
  1573. if (isset($options[self::OSS_METHOD])) {
  1574. $request->set_method($options[self::OSS_METHOD]);
  1575. $string_to_sign .= $options[self::OSS_METHOD] . "\n";
  1576. }
  1577. if (isset($options[self::OSS_CONTENT])) {
  1578. $request->set_body($options[self::OSS_CONTENT]);
  1579. if ($headers[self::OSS_CONTENT_TYPE] === 'application/x-www-form-urlencoded') {
  1580. $headers[self::OSS_CONTENT_TYPE] = 'application/octet-stream';
  1581. }
  1582. $headers[self::OSS_CONTENT_LENGTH] = strlen($options[self::OSS_CONTENT]);
  1583. $headers[self::OSS_CONTENT_MD5] = base64_encode(md5($options[self::OSS_CONTENT], true));
  1584. }
  1585. uksort($headers, 'strnatcasecmp');
  1586. foreach ($headers as $header_key => $header_value) {
  1587. $header_value = str_replace(array("\r", "\n"), '', $header_value);
  1588. if ($header_value !== '') {
  1589. $request->add_header($header_key, $header_value);
  1590. }
  1591. if (
  1592. strtolower($header_key) === 'content-md5' ||
  1593. strtolower($header_key) === 'content-type' ||
  1594. strtolower($header_key) === 'date' ||
  1595. (isset($options['self::OSS_PREAUTH']) && (integer)$options['self::OSS_PREAUTH'] > 0)
  1596. ) {
  1597. $string_to_sign .= $header_value . "\n";
  1598. } elseif (substr(strtolower($header_key), 0, 6) === self::OSS_DEFAULT_PREFIX) {
  1599. $string_to_sign .= strtolower($header_key) . ':' . $header_value . "\n";
  1600. }
  1601. }
  1602. // 生成 signable_resource
  1603. $signable_resource = $this->generateSignableResource($options);
  1604. $string_to_sign .= rawurldecode($signable_resource) . urldecode($signable_query_string);
  1605. $signature = base64_encode(hash_hmac('sha1', $string_to_sign, $this->accessKeySecret, true));
  1606. $request->add_header('Authorization', 'OSS ' . $this->accessKeyId . ':' . $signature);
  1607. if (isset($options[self::OSS_PREAUTH]) && (integer)$options[self::OSS_PREAUTH] > 0) {
  1608. $signed_url = $this->requestUrl . $conjunction . self::OSS_URL_ACCESS_KEY_ID . '=' . rawurlencode($this->accessKeyId) . '&' . self::OSS_URL_EXPIRES . '=' . $options[self::OSS_PREAUTH] . '&' . self::OSS_URL_SIGNATURE . '=' . rawurlencode($signature);
  1609. return $signed_url;
  1610. } elseif (isset($options[self::OSS_PREAUTH])) {
  1611. return $this->requestUrl;
  1612. }
  1613. if ($this->timeout !== 0) {
  1614. $request->timeout = $this->timeout;
  1615. }
  1616. if ($this->connectTimeout !== 0) {
  1617. $request->connect_timeout = $this->connectTimeout;
  1618. }
  1619. try {
  1620. $request->send_request();
  1621. } catch (RequestCore_Exception $e) {
  1622. throw(new OssException('RequestCoreException: ' . $e->getMessage()));
  1623. }
  1624. $response_header = $request->get_response_header();
  1625. $response_header['oss-request-url'] = $this->requestUrl;
  1626. $response_header['oss-redirects'] = $this->redirects;
  1627. $response_header['oss-stringtosign'] = $string_to_sign;
  1628. $response_header['oss-requestheaders'] = $request->request_headers;
  1629. $data = new ResponseCore($response_header, $request->get_response_body(), $request->get_response_code());
  1630. //retry if OSS Internal Error
  1631. if ((integer)$request->get_response_code() === 500) {
  1632. if ($this->redirects <= $this->maxRetries) {
  1633. //设置休眠
  1634. $delay = (integer)(pow(4, $this->redirects) * 100000);
  1635. usleep($delay);
  1636. $this->redirects++;
  1637. $data = $this->auth($options);
  1638. }
  1639. }
  1640. $this->redirects = 0;
  1641. return $data;
  1642. }
  1643. /**
  1644. * 设置最大尝试次数
  1645. *
  1646. * @param int $maxRetries
  1647. * @return void
  1648. */
  1649. public function setMaxTries($maxRetries = 3)
  1650. {
  1651. $this->maxRetries = $maxRetries;
  1652. }
  1653. /**
  1654. * 获取最大尝试次数
  1655. *
  1656. * @return int
  1657. */
  1658. public function getMaxRetries()
  1659. {
  1660. return $this->maxRetries;
  1661. }
  1662. /**
  1663. * 打开sts enable标志,使用户构造函数中传入的$sts生效
  1664. *
  1665. * @param boolean $enable
  1666. */
  1667. public function setSignStsInUrl($enable)
  1668. {
  1669. $this->enableStsInUrl = $enable;
  1670. }
  1671. /**
  1672. * @return boolean
  1673. */
  1674. public function isUseSSL()
  1675. {
  1676. return $this->useSSL;
  1677. }
  1678. /**
  1679. * @param boolean $useSSL
  1680. */
  1681. public function setUseSSL($useSSL)
  1682. {
  1683. $this->useSSL = $useSSL;
  1684. }
  1685. /**
  1686. * 检查bucket名称格式是否正确,如果非法抛出异常
  1687. *
  1688. * @param $options
  1689. * @throws OssException
  1690. */
  1691. private function authPrecheckBucket($options)
  1692. {
  1693. if (!(('/' == $options[self::OSS_OBJECT]) && ('' == $options[self::OSS_BUCKET]) && ('GET' == $options[self::OSS_METHOD])) && !OssUtil::validateBucket($options[self::OSS_BUCKET])) {
  1694. throw new OssException('"' . $options[self::OSS_BUCKET] . '"' . 'bucket name is invalid');
  1695. }
  1696. }
  1697. /**
  1698. *
  1699. * 检查object名称格式是否正确,如果非法抛出异常
  1700. *
  1701. * @param $options
  1702. * @throws OssException
  1703. */
  1704. private function authPrecheckObject($options)
  1705. {
  1706. if (isset($options[self::OSS_OBJECT]) && $options[self::OSS_OBJECT] === '/') {
  1707. return;
  1708. }
  1709. if (isset($options[self::OSS_OBJECT]) && !OssUtil::validateObject($options[self::OSS_OBJECT])) {
  1710. throw new OssException('"' . $options[self::OSS_OBJECT] . '"' . ' object name is invalid');
  1711. }
  1712. }
  1713. /**
  1714. * 检查object的编码,如果是gbk或者gb2312则尝试将其转化为utf8编码
  1715. *
  1716. * @param mixed $options 参数
  1717. */
  1718. private function authPrecheckObjectEncoding(&$options)
  1719. {
  1720. $tmp_object = $options[self::OSS_OBJECT];
  1721. try {
  1722. if (OssUtil::isGb2312($options[self::OSS_OBJECT])) {
  1723. $options[self::OSS_OBJECT] = iconv('GB2312', "UTF-8//IGNORE", $options[self::OSS_OBJECT]);
  1724. } elseif (OssUtil::checkChar($options[self::OSS_OBJECT], true)) {
  1725. $options[self::OSS_OBJECT] = iconv('GBK', "UTF-8//IGNORE", $options[self::OSS_OBJECT]);
  1726. }
  1727. } catch (\Exception $e) {
  1728. try {
  1729. $tmp_object = iconv(mb_detect_encoding($tmp_object), "UTF-8", $tmp_object);
  1730. } catch (\Exception $e) {
  1731. }
  1732. }
  1733. $options[self::OSS_OBJECT] = $tmp_object;
  1734. }
  1735. /**
  1736. * 检查ACL是否是预定义中三种之一,如果不是抛出异常
  1737. *
  1738. * @param $options
  1739. * @throws OssException
  1740. */
  1741. private function authPrecheckAcl($options)
  1742. {
  1743. if (isset($options[self::OSS_HEADERS][self::OSS_ACL]) && !empty($options[self::OSS_HEADERS][self::OSS_ACL])) {
  1744. if (!in_array(strtolower($options[self::OSS_HEADERS][self::OSS_ACL]), self::$OSS_ACL_TYPES)) {
  1745. throw new OssException($options[self::OSS_HEADERS][self::OSS_ACL] . ':' . 'acl is invalid(private,public-read,public-read-write)');
  1746. }
  1747. }
  1748. }
  1749. /**
  1750. * 获得档次请求使用的域名
  1751. * bucket在前的三级域名,或者二级域名,如果是cname或者ip的话,则是二级域名
  1752. *
  1753. * @param $options
  1754. * @return string 剥掉协议头的域名
  1755. */
  1756. private function generateHostname($options)
  1757. {
  1758. if ($this->hostType === self::OSS_HOST_TYPE_IP) {
  1759. $hostname = $this->hostname;
  1760. } elseif ($this->hostType === self::OSS_HOST_TYPE_CNAME) {
  1761. $hostname = $this->hostname;
  1762. } else {
  1763. // 专有域或者官网endpoint
  1764. $hostname = ($options[self::OSS_BUCKET] == '') ? $this->hostname : ($options[self::OSS_BUCKET] . '.') . $this->hostname;
  1765. }
  1766. return $hostname;
  1767. }
  1768. /**
  1769. * 获得当次请求的资源定位字段
  1770. *
  1771. * @param $options
  1772. * @return string 资源定位字段
  1773. */
  1774. private function generateResourceUri($options)
  1775. {
  1776. $resource_uri = "";
  1777. // resource_uri + bucket
  1778. if (isset($options[self::OSS_BUCKET]) && '' !== $options[self::OSS_BUCKET]) {
  1779. if ($this->hostType === self::OSS_HOST_TYPE_IP) {
  1780. $resource_uri = '/' . $options[self::OSS_BUCKET];
  1781. }
  1782. }
  1783. // resource_uri + object
  1784. if (isset($options[self::OSS_OBJECT]) && '/' !== $options[self::OSS_OBJECT]) {
  1785. $resource_uri .= '/' . str_replace(array('%2F', '%25'), array('/', '%'), rawurlencode($options[self::OSS_OBJECT]));
  1786. }
  1787. // resource_uri + sub_resource
  1788. $conjunction = '?';
  1789. if (isset($options[self::OSS_SUB_RESOURCE])) {
  1790. $resource_uri .= $conjunction . $options[self::OSS_SUB_RESOURCE];
  1791. }
  1792. return $resource_uri;
  1793. }
  1794. /**
  1795. * 生成signalbe_query_string_param, array类型
  1796. *
  1797. * @param array $options
  1798. * @return array
  1799. */
  1800. private function generateSignableQueryStringParam($options)
  1801. {
  1802. $signableQueryStringParams = array();
  1803. $signableList = array(
  1804. self::OSS_PART_NUM,
  1805. 'response-content-type',
  1806. 'response-content-language',
  1807. 'response-cache-control',
  1808. 'response-content-encoding',
  1809. 'response-expires',
  1810. 'response-content-disposition',
  1811. self::OSS_UPLOAD_ID,
  1812. self::OSS_CNAME_COMP,
  1813. self::OSS_POSITION
  1814. );
  1815. foreach ($signableList as $item) {
  1816. if (isset($options[$item])) {
  1817. $signableQueryStringParams[$item] = $options[$item];
  1818. }
  1819. }
  1820. if ($this->enableStsInUrl && (!is_null($this->securityToken))) {
  1821. $signableQueryStringParams["security-token"] = $this->securityToken;
  1822. }
  1823. return $signableQueryStringParams;
  1824. }
  1825. /**
  1826. * 生成用于签名resource段
  1827. *
  1828. * @param mixed $options
  1829. * @return string
  1830. */
  1831. private function generateSignableResource($options)
  1832. {
  1833. $signableResource = "";
  1834. $signableResource .= '/';
  1835. if (isset($options[self::OSS_BUCKET]) && '' !== $options[self::OSS_BUCKET]) {
  1836. $signableResource .= $options[self::OSS_BUCKET];
  1837. // 如果操作没有Object操作的话,这里最后是否有斜线有个trick,ip的域名下,不需要加'/', 否则需要加'/'
  1838. if ($options[self::OSS_OBJECT] == '/') {
  1839. if ($this->hostType !== self::OSS_HOST_TYPE_IP) {
  1840. $signableResource .= "/";
  1841. }
  1842. }
  1843. }
  1844. //signable_resource + object
  1845. if (isset($options[self::OSS_OBJECT]) && '/' !== $options[self::OSS_OBJECT]) {
  1846. $signableResource .= '/' . str_replace(array('%2F', '%25'), array('/', '%'), rawurlencode($options[self::OSS_OBJECT]));
  1847. }
  1848. if (isset($options[self::OSS_SUB_RESOURCE])) {
  1849. $signableResource .= '?' . $options[self::OSS_SUB_RESOURCE];
  1850. }
  1851. return $signableResource;
  1852. }
  1853. /**
  1854. * 生成query_string
  1855. *
  1856. * @param mixed $options
  1857. * @return string
  1858. */
  1859. private function generateQueryString($options)
  1860. {
  1861. //请求参数
  1862. $queryStringParams = array();
  1863. if (isset($options[self::OSS_QUERY_STRING])) {
  1864. $queryStringParams = array_merge($queryStringParams, $options[self::OSS_QUERY_STRING]);
  1865. }
  1866. return OssUtil::toQueryString($queryStringParams);
  1867. }
  1868. /**
  1869. * 初始化headers
  1870. *
  1871. * @param mixed $options
  1872. * @param string $hostname hostname
  1873. * @return array
  1874. */
  1875. private function generateHeaders($options, $hostname)
  1876. {
  1877. $headers = array(
  1878. self::OSS_CONTENT_MD5 => '',
  1879. self::OSS_CONTENT_TYPE => isset($options[self::OSS_CONTENT_TYPE]) ? $options[self::OSS_CONTENT_TYPE] : self::DEFAULT_CONTENT_TYPE,
  1880. self::OSS_DATE => isset($options[self::OSS_DATE]) ? $options[self::OSS_DATE] : gmdate('D, d M Y H:i:s \G\M\T'),
  1881. self::OSS_HOST => $hostname,
  1882. );
  1883. if (isset($options[self::OSS_CONTENT_MD5])) {
  1884. $headers[self::OSS_CONTENT_MD5] = $options[self::OSS_CONTENT_MD5];
  1885. }
  1886. //添加stsSecurityToken
  1887. if ((!is_null($this->securityToken)) && (!$this->enableStsInUrl)) {
  1888. $headers[self::OSS_SECURITY_TOKEN] = $this->securityToken;
  1889. }
  1890. //合并HTTP headers
  1891. if (isset($options[self::OSS_HEADERS])) {
  1892. $headers = array_merge($headers, $options[self::OSS_HEADERS]);
  1893. }
  1894. return $headers;
  1895. }
  1896. /**
  1897. * 生成请求用的UserAgent
  1898. *
  1899. * @return string
  1900. */
  1901. private function generateUserAgent()
  1902. {
  1903. return self::OSS_NAME . "/" . self::OSS_VERSION . " (" . php_uname('s') . "/" . php_uname('r') . "/" . php_uname('m') . ";" . PHP_VERSION . ")";
  1904. }
  1905. /**
  1906. * 检查endpoint的种类
  1907. * 如有有协议头,剥去协议头
  1908. * 并且根据参数 is_cname 和endpoint本身,判定域名类型,是ip,cname,还是专有域或者官网域名
  1909. *
  1910. * @param string $endpoint
  1911. * @param boolean $isCName
  1912. * @return string 剥掉协议头的域名
  1913. */
  1914. private function checkEndpoint($endpoint, $isCName)
  1915. {
  1916. $ret_endpoint = null;
  1917. if (strpos($endpoint, 'http://') === 0) {
  1918. $ret_endpoint = substr($endpoint, strlen('http://'));
  1919. } elseif (strpos($endpoint, 'https://') === 0) {
  1920. $ret_endpoint = substr($endpoint, strlen('https://'));
  1921. $this->useSSL = true;
  1922. } else {
  1923. $ret_endpoint = $endpoint;
  1924. }
  1925. if ($isCName) {
  1926. $this->hostType = self::OSS_HOST_TYPE_CNAME;
  1927. } elseif (OssUtil::isIPFormat($ret_endpoint)) {
  1928. $this->hostType = self::OSS_HOST_TYPE_IP;
  1929. } else {
  1930. $this->hostType = self::OSS_HOST_TYPE_NORMAL;
  1931. }
  1932. return $ret_endpoint;
  1933. }
  1934. /**
  1935. * 用来检查sdk所以来的扩展是否打开
  1936. *
  1937. * @throws OssException
  1938. */
  1939. public static function checkEnv()
  1940. {
  1941. if (function_exists('get_loaded_extensions')) {
  1942. //检测curl扩展
  1943. $enabled_extension = array("curl");
  1944. $extensions = get_loaded_extensions();
  1945. if ($extensions) {
  1946. foreach ($enabled_extension as $item) {
  1947. if (!in_array($item, $extensions)) {
  1948. throw new OssException("Extension {" . $item . "} is not installed or not enabled, please check your php env.");
  1949. }
  1950. }
  1951. } else {
  1952. throw new OssException("function get_loaded_extensions not found.");
  1953. }
  1954. } else {
  1955. throw new OssException('Function get_loaded_extensions has been disabled, please check php config.');
  1956. }
  1957. }
  1958. /**
  1959. * 设置http库的请求超时时间,单位秒
  1960. *
  1961. * @param int $timeout
  1962. */
  1963. public function setTimeout($timeout)
  1964. {
  1965. $this->timeout = $timeout;
  1966. }
  1967. /**
  1968. * 设置http库的连接超时时间,单位秒
  1969. *
  1970. * @param int $connectTimeout
  1971. */
  1972. public function setConnectTimeout($connectTimeout)
  1973. {
  1974. $this->connectTimeout = $connectTimeout;
  1975. }
  1976. // 生命周期相关常量
  1977. const OSS_LIFECYCLE_EXPIRATION = "Expiration";
  1978. const OSS_LIFECYCLE_TIMING_DAYS = "Days";
  1979. const OSS_LIFECYCLE_TIMING_DATE = "Date";
  1980. //OSS 内部常量
  1981. const OSS_BUCKET = 'bucket';
  1982. const OSS_OBJECT = 'object';
  1983. const OSS_HEADERS = OssUtil::OSS_HEADERS;
  1984. const OSS_METHOD = 'method';
  1985. const OSS_QUERY = 'query';
  1986. const OSS_BASENAME = 'basename';
  1987. const OSS_MAX_KEYS = 'max-keys';
  1988. const OSS_UPLOAD_ID = 'uploadId';
  1989. const OSS_PART_NUM = 'partNumber';
  1990. const OSS_CNAME_COMP = 'comp';
  1991. const OSS_POSITION = 'position';
  1992. const OSS_MAX_KEYS_VALUE = 100;
  1993. const OSS_MAX_OBJECT_GROUP_VALUE = OssUtil::OSS_MAX_OBJECT_GROUP_VALUE;
  1994. const OSS_MAX_PART_SIZE = OssUtil::OSS_MAX_PART_SIZE;
  1995. const OSS_MID_PART_SIZE = OssUtil::OSS_MID_PART_SIZE;
  1996. const OSS_MIN_PART_SIZE = OssUtil::OSS_MIN_PART_SIZE;
  1997. const OSS_FILE_SLICE_SIZE = 8192;
  1998. const OSS_PREFIX = 'prefix';
  1999. const OSS_DELIMITER = 'delimiter';
  2000. const OSS_MARKER = 'marker';
  2001. const OSS_CONTENT_MD5 = 'Content-Md5';
  2002. const OSS_SELF_CONTENT_MD5 = 'x-oss-meta-md5';
  2003. const OSS_CONTENT_TYPE = 'Content-Type';
  2004. const OSS_CONTENT_LENGTH = 'Content-Length';
  2005. const OSS_IF_MODIFIED_SINCE = 'If-Modified-Since';
  2006. const OSS_IF_UNMODIFIED_SINCE = 'If-Unmodified-Since';
  2007. const OSS_IF_MATCH = 'If-Match';
  2008. const OSS_IF_NONE_MATCH = 'If-None-Match';
  2009. const OSS_CACHE_CONTROL = 'Cache-Control';
  2010. const OSS_EXPIRES = 'Expires';
  2011. const OSS_PREAUTH = 'preauth';
  2012. const OSS_CONTENT_COING = 'Content-Coding';
  2013. const OSS_CONTENT_DISPOSTION = 'Content-Disposition';
  2014. const OSS_RANGE = 'range';
  2015. const OSS_ETAG = 'etag';
  2016. const OSS_LAST_MODIFIED = 'lastmodified';
  2017. const OS_CONTENT_RANGE = 'Content-Range';
  2018. const OSS_CONTENT = OssUtil::OSS_CONTENT;
  2019. const OSS_BODY = 'body';
  2020. const OSS_LENGTH = OssUtil::OSS_LENGTH;
  2021. const OSS_HOST = 'Host';
  2022. const OSS_DATE = 'Date';
  2023. const OSS_AUTHORIZATION = 'Authorization';
  2024. const OSS_FILE_DOWNLOAD = 'fileDownload';
  2025. const OSS_FILE_UPLOAD = 'fileUpload';
  2026. const OSS_PART_SIZE = 'partSize';
  2027. const OSS_SEEK_TO = 'seekTo';
  2028. const OSS_SIZE = 'size';
  2029. const OSS_QUERY_STRING = 'query_string';
  2030. const OSS_SUB_RESOURCE = 'sub_resource';
  2031. const OSS_DEFAULT_PREFIX = 'x-oss-';
  2032. const OSS_CHECK_MD5 = 'checkmd5';
  2033. const DEFAULT_CONTENT_TYPE = 'application/octet-stream';
  2034. //私有URL变量
  2035. const OSS_URL_ACCESS_KEY_ID = 'OSSAccessKeyId';
  2036. const OSS_URL_EXPIRES = 'Expires';
  2037. const OSS_URL_SIGNATURE = 'Signature';
  2038. //HTTP方法
  2039. const OSS_HTTP_GET = 'GET';
  2040. const OSS_HTTP_PUT = 'PUT';
  2041. const OSS_HTTP_HEAD = 'HEAD';
  2042. const OSS_HTTP_POST = 'POST';
  2043. const OSS_HTTP_DELETE = 'DELETE';
  2044. const OSS_HTTP_OPTIONS = 'OPTIONS';
  2045. //其他常量
  2046. const OSS_ACL = 'x-oss-acl';
  2047. const OSS_OBJECT_ACL = 'x-oss-object-acl';
  2048. const OSS_OBJECT_GROUP = 'x-oss-file-group';
  2049. const OSS_MULTI_PART = 'uploads';
  2050. const OSS_MULTI_DELETE = 'delete';
  2051. const OSS_OBJECT_COPY_SOURCE = 'x-oss-copy-source';
  2052. const OSS_OBJECT_COPY_SOURCE_RANGE = "x-oss-copy-source-range";
  2053. //支持STS SecurityToken
  2054. const OSS_SECURITY_TOKEN = "x-oss-security-token";
  2055. const OSS_ACL_TYPE_PRIVATE = 'private';
  2056. const OSS_ACL_TYPE_PUBLIC_READ = 'public-read';
  2057. const OSS_ACL_TYPE_PUBLIC_READ_WRITE = 'public-read-write';
  2058. const OSS_ENCODING_TYPE = "encoding-type";
  2059. const OSS_ENCODING_TYPE_URL = "url";
  2060. // 域名类型
  2061. const OSS_HOST_TYPE_NORMAL = "normal";//http://bucket.oss-cn-hangzhou.aliyuncs.com/object
  2062. const OSS_HOST_TYPE_IP = "ip"; //http://1.1.1.1/bucket/object
  2063. const OSS_HOST_TYPE_SPECIAL = 'special'; //http://bucket.guizhou.gov/object
  2064. const OSS_HOST_TYPE_CNAME = "cname"; //http://mydomain.com/object
  2065. //OSS ACL数组
  2066. static $OSS_ACL_TYPES = array(
  2067. self::OSS_ACL_TYPE_PRIVATE,
  2068. self::OSS_ACL_TYPE_PUBLIC_READ,
  2069. self::OSS_ACL_TYPE_PUBLIC_READ_WRITE
  2070. );
  2071. // OssClient版本信息
  2072. const OSS_NAME = "aliyun-sdk-php";
  2073. const OSS_VERSION = "2.0.7";
  2074. const OSS_BUILD = "20160617";
  2075. const OSS_AUTHOR = "";
  2076. const OSS_OPTIONS_ORIGIN = 'Origin';
  2077. const OSS_OPTIONS_REQUEST_METHOD = 'Access-Control-Request-Method';
  2078. const OSS_OPTIONS_REQUEST_HEADERS = 'Access-Control-Request-Headers';
  2079. //是否使用ssl
  2080. private $useSSL = false;
  2081. private $maxRetries = 3;
  2082. private $redirects = 0;
  2083. // 用户提供的域名类型,有四种 OSS_HOST_TYPE_NORMAL, OSS_HOST_TYPE_IP, OSS_HOST_TYPE_SPECIAL, OSS_HOST_TYPE_CNAME
  2084. private $hostType = self::OSS_HOST_TYPE_NORMAL;
  2085. private $requestUrl;
  2086. private $accessKeyId;
  2087. private $accessKeySecret;
  2088. private $hostname;
  2089. private $securityToken;
  2090. private $enableStsInUrl = false;
  2091. private $timeout = 0;
  2092. private $connectTimeout = 0;
  2093. }