base.js 149 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686
  1. 'use strict';
  2. var REQUEST = require('../lib/request');
  3. var base64 = require('../lib/base64');
  4. var util = require('./util');
  5. var mime = require('mime');
  6. // Bucket 相关
  7. /**
  8. * 获取用户的 bucket 列表
  9. * @param {Object} params 回调函数,必须,下面为参数列表
  10. * 无特殊参数
  11. * @param {Function} callback 回调函数,必须
  12. */
  13. function getService(params, callback) {
  14. if (typeof params === 'function') {
  15. callback = params;
  16. params = {};
  17. }
  18. var protocol = 'https:';
  19. var domain = this.options.ServiceDomain;
  20. var region = params.Region;
  21. if (domain) {
  22. domain = domain.replace(/\{\{Region\}\}/ig, region || '').replace(/\{\{.*?\}\}/ig, '');
  23. if (!/^[a-zA-Z]+:\/\//.test(domain)) {
  24. domain = protocol + '//' + domain;
  25. }
  26. if (domain.slice(-1) === '/') {
  27. domain = domain.slice(0, -1);
  28. }
  29. } else if (region) {
  30. domain = protocol + '//cos.' + region + '.myqcloud.com';
  31. } else {
  32. domain = protocol + '//service.cos.myqcloud.com';
  33. }
  34. var SignHost = '';
  35. var standardHost = region ? 'cos.' + region + '.myqcloud.com' : 'service.cos.myqcloud.com';
  36. var urlHost = domain.replace(/^https?:\/\/([^/]+)(\/.*)?$/, '$1');
  37. if (standardHost === urlHost) SignHost = standardHost;
  38. submitRequest.call(this, {
  39. Action: 'name/cos:GetService',
  40. url: domain,
  41. method: 'GET',
  42. headers: params.Headers,
  43. }, function (err, data) {
  44. if (err) return callback(err);
  45. var buckets = (data && data.ListAllMyBucketsResult && data.ListAllMyBucketsResult.Buckets
  46. && data.ListAllMyBucketsResult.Buckets.Bucket) || [];
  47. buckets = util.isArray(buckets) ? buckets : [buckets];
  48. var owner = (data && data.ListAllMyBucketsResult && data.ListAllMyBucketsResult.Owner) || {};
  49. callback(null, {
  50. Buckets: buckets,
  51. Owner: owner,
  52. statusCode: data.statusCode,
  53. headers: data.headers,
  54. });
  55. });
  56. }
  57. /**
  58. * 创建 Bucket,并初始化访问权限
  59. * @param {Object} params 参数对象,必须
  60. * @param {String} params.Bucket Bucket名称,必须
  61. * @param {String} params.Region 地域名称,必须
  62. * @param {String} params.ACL 用户自定义文件权限,可以设置:private,public-read;默认值:private,非必须
  63. * @param {String} params.GrantRead 赋予被授权者读的权限,格式x-cos-grant-read: uin=" ",uin=" ",非必须
  64. * @param {String} params.GrantWrite 赋予被授权者写的权限,格式x-cos-grant-write: uin=" ",uin=" ",非必须
  65. * @param {String} params.GrantFullControl 赋予被授权者读写权限,格式x-cos-grant-full-control: uin=" ",uin=" ",非必须
  66. * @param {Function} callback 回调函数,必须
  67. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  68. * @return {Object} data 返回的数据
  69. * @return {String} data.Location 操作地址
  70. */
  71. function putBucket(params, callback) {
  72. var self = this;
  73. var xml = '';
  74. if(params['BucketAZConfig']){
  75. var CreateBucketConfiguration = {
  76. BucketAZConfig: params.BucketAZConfig
  77. };
  78. xml = util.json2xml({CreateBucketConfiguration: CreateBucketConfiguration});
  79. }
  80. submitRequest.call(this, {
  81. Action: 'name/cos:PutBucket',
  82. method: 'PUT',
  83. Bucket: params.Bucket,
  84. Region: params.Region,
  85. headers: params.Headers,
  86. body: xml,
  87. }, function (err, data) {
  88. if (err) return callback(err);
  89. var url = getUrl({
  90. protocol: self.options.Protocol,
  91. domain: self.options.Domain,
  92. bucket: params.Bucket,
  93. region: params.Region,
  94. isLocation: true,
  95. });
  96. callback(null, {
  97. Location: url,
  98. statusCode: data.statusCode,
  99. headers: data.headers,
  100. });
  101. });
  102. }
  103. /**
  104. * 查看是否存在该Bucket,是否有权限访问
  105. * @param {Object} params 参数对象,必须
  106. * @param {String} params.Bucket Bucket名称,必须
  107. * @param {String} params.Region 地域名称,必须
  108. * @param {Function} callback 回调函数,必须
  109. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  110. * @return {Object} data 返回的数据
  111. * @return {Boolean} data.BucketExist Bucket是否存在
  112. * @return {Boolean} data.BucketAuth 是否有 Bucket 的访问权限
  113. */
  114. function headBucket(params, callback) {
  115. submitRequest.call(this, {
  116. Action: 'name/cos:HeadBucket',
  117. Bucket: params.Bucket,
  118. Region: params.Region,
  119. headers: params.Headers,
  120. method: 'HEAD',
  121. }, function (err, data) {
  122. callback(err, data);
  123. });
  124. }
  125. /**
  126. * 获取 Bucket 下的 object 列表
  127. * @param {Object} params 参数对象,必须
  128. * @param {String} params.Bucket Bucket名称,必须
  129. * @param {String} params.Region 地域名称,必须
  130. * @param {String} params.Prefix 前缀匹配,用来规定返回的文件前缀地址,非必须
  131. * @param {String} params.Delimiter 定界符为一个符号,如果有Prefix,则将Prefix到delimiter之间的相同路径归为一类,非必须
  132. * @param {String} params.Marker 默认以UTF-8二进制顺序列出条目,所有列出条目从marker开始,非必须
  133. * @param {String} params.MaxKeys 单次返回最大的条目数量,默认1000,非必须
  134. * @param {String} params.EncodingType 规定返回值的编码方式,非必须
  135. * @param {Function} callback 回调函数,必须
  136. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  137. * @return {Object} data 返回的数据
  138. * @return {Object} data.ListBucketResult 返回的 object 列表信息
  139. */
  140. function getBucket(params, callback) {
  141. var reqParams = {};
  142. reqParams['prefix'] = params['Prefix'] || '';
  143. reqParams['delimiter'] = params['Delimiter'];
  144. reqParams['marker'] = params['Marker'];
  145. reqParams['max-keys'] = params['MaxKeys'];
  146. reqParams['encoding-type'] = params['EncodingType'];
  147. submitRequest.call(this, {
  148. Action: 'name/cos:GetBucket',
  149. ResourceKey: reqParams['prefix'],
  150. method: 'GET',
  151. Bucket: params.Bucket,
  152. Region: params.Region,
  153. headers: params.Headers,
  154. qs: reqParams,
  155. }, function (err, data) {
  156. if (err) return callback(err);
  157. var ListBucketResult = data.ListBucketResult || {};
  158. var Contents = ListBucketResult.Contents || [];
  159. var CommonPrefixes = ListBucketResult.CommonPrefixes || [];
  160. Contents = util.isArray(Contents) ? Contents : [Contents];
  161. CommonPrefixes = util.isArray(CommonPrefixes) ? CommonPrefixes : [CommonPrefixes];
  162. var result = util.clone(ListBucketResult);
  163. util.extend(result, {
  164. Contents: Contents,
  165. CommonPrefixes: CommonPrefixes,
  166. statusCode: data.statusCode,
  167. headers: data.headers,
  168. });
  169. callback(null, result);
  170. });
  171. }
  172. /**
  173. * 删除 Bucket
  174. * @param {Object} params 参数对象,必须
  175. * @param {String} params.Bucket Bucket名称,必须
  176. * @param {String} params.Region 地域名称,必须
  177. * @param {Function} callback 回调函数,必须
  178. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  179. * @return {Object} data 返回的数据
  180. * @return {String} data.Location 操作地址
  181. */
  182. function deleteBucket(params, callback) {
  183. submitRequest.call(this, {
  184. Action: 'name/cos:DeleteBucket',
  185. Bucket: params.Bucket,
  186. Region: params.Region,
  187. headers: params.Headers,
  188. method: 'DELETE',
  189. }, function (err, data) {
  190. if (err && err.statusCode === 204) {
  191. return callback(null, {statusCode: err.statusCode});
  192. } else if (err) {
  193. return callback(err);
  194. }
  195. callback(null, {
  196. statusCode: data.statusCode,
  197. headers: data.headers,
  198. });
  199. });
  200. }
  201. /**
  202. * 设置 Bucket 的 权限列表
  203. * @param {Object} params 参数对象,必须
  204. * @param {String} params.Bucket Bucket名称,必须
  205. * @param {String} params.Region 地域名称,必须
  206. * @param {String} params.ACL 用户自定义文件权限,可以设置:private,public-read;默认值:private,非必须
  207. * @param {String} params.GrantRead 赋予被授权者读的权限,格式x-cos-grant-read: uin=" ",uin=" ",非必须
  208. * @param {String} params.GrantWrite 赋予被授权者写的权限,格式x-cos-grant-write: uin=" ",uin=" ",非必须
  209. * @param {String} params.GrantFullControl 赋予被授权者读写权限,格式x-cos-grant-full-control: uin=" ",uin=" ",非必须
  210. * @param {Function} callback 回调函数,必须
  211. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  212. * @return {Object} data 返回的数据
  213. */
  214. function putBucketAcl(params, callback) {
  215. var headers = params.Headers;
  216. var xml = '';
  217. if (params['AccessControlPolicy']) {
  218. var AccessControlPolicy = util.clone(params['AccessControlPolicy'] || {});
  219. var Grants = AccessControlPolicy.Grants || AccessControlPolicy.Grant;
  220. Grants = util.isArray(Grants) ? Grants : [Grants];
  221. delete AccessControlPolicy.Grant;
  222. delete AccessControlPolicy.Grants;
  223. AccessControlPolicy.AccessControlList = {Grant: Grants};
  224. xml = util.json2xml({AccessControlPolicy: AccessControlPolicy});
  225. headers['Content-Type'] = 'application/xml';
  226. headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
  227. }
  228. // Grant Header 去重
  229. util.each(headers, function (val, key) {
  230. if (key.indexOf('x-cos-grant-') === 0) {
  231. headers[key] = uniqGrant(headers[key]);
  232. }
  233. });
  234. submitRequest.call(this, {
  235. Action: 'name/cos:PutBucketACL',
  236. method: 'PUT',
  237. Bucket: params.Bucket,
  238. Region: params.Region,
  239. headers: headers,
  240. action: 'acl',
  241. body: xml,
  242. }, function (err, data) {
  243. if (err) return callback(err);
  244. callback(null, {
  245. statusCode: data.statusCode,
  246. headers: data.headers,
  247. });
  248. });
  249. }
  250. /**
  251. * 获取 Bucket 的 权限列表
  252. * @param {Object} params 参数对象,必须
  253. * @param {String} params.Bucket Bucket名称,必须
  254. * @param {String} params.Region 地域名称,必须
  255. * @param {Function} callback 回调函数,必须
  256. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  257. * @return {Object} data 返回的数据
  258. * @return {Object} data.AccessControlPolicy 访问权限信息
  259. */
  260. function getBucketAcl(params, callback) {
  261. submitRequest.call(this, {
  262. Action: 'name/cos:GetBucketACL',
  263. method: 'GET',
  264. Bucket: params.Bucket,
  265. Region: params.Region,
  266. headers: params.Headers,
  267. action: 'acl',
  268. }, function (err, data) {
  269. if (err) return callback(err);
  270. var AccessControlPolicy = data.AccessControlPolicy || {};
  271. var Owner = AccessControlPolicy.Owner || {};
  272. var Grant = AccessControlPolicy.AccessControlList.Grant || [];
  273. Grant = util.isArray(Grant) ? Grant : [Grant];
  274. var result = decodeAcl(AccessControlPolicy);
  275. if (data.headers && data.headers['x-cos-acl']) {
  276. result.ACL = data.headers['x-cos-acl'];
  277. }
  278. result = util.extend(result, {
  279. Owner: Owner,
  280. Grants: Grant,
  281. statusCode: data.statusCode,
  282. headers: data.headers,
  283. });
  284. callback(null, result);
  285. });
  286. }
  287. /**
  288. * 设置 Bucket 的 跨域设置
  289. * @param {Object} params 参数对象,必须
  290. * @param {String} params.Bucket Bucket名称,必须
  291. * @param {String} params.Region 地域名称,必须
  292. * @param {Object} params.CORSConfiguration 相关的跨域设置,必须
  293. * @param {Array} params.CORSConfiguration.CORSRules 对应的跨域规则
  294. * @param {Function} callback 回调函数,必须
  295. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  296. * @return {Object} data 返回的数据
  297. */
  298. function putBucketCors(params, callback) {
  299. var CORSConfiguration = params['CORSConfiguration'] || {};
  300. var CORSRules = CORSConfiguration['CORSRules'] || params['CORSRules'] || [];
  301. CORSRules = util.clone(util.isArray(CORSRules) ? CORSRules : [CORSRules]);
  302. util.each(CORSRules, function (rule) {
  303. util.each(['AllowedOrigin', 'AllowedHeader', 'AllowedMethod', 'ExposeHeader'], function (key) {
  304. var sKey = key + 's';
  305. var val = rule[sKey] || rule[key] || [];
  306. delete rule[sKey];
  307. rule[key] = util.isArray(val) ? val : [val];
  308. });
  309. });
  310. var Conf = {CORSRule: CORSRules};
  311. if (params.ResponseVary) Conf.ResponseVary = params.ResponseVary;
  312. var xml = util.json2xml({CORSConfiguration: Conf});
  313. var headers = params.Headers;
  314. headers['Content-Type'] = 'application/xml';
  315. headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
  316. submitRequest.call(this, {
  317. Action: 'name/cos:PutBucketCORS',
  318. method: 'PUT',
  319. Bucket: params.Bucket,
  320. Region: params.Region,
  321. body: xml,
  322. action: 'cors',
  323. headers: headers,
  324. }, function (err, data) {
  325. if (err) return callback(err);
  326. callback(null, {
  327. statusCode: data.statusCode,
  328. headers: data.headers,
  329. });
  330. });
  331. }
  332. /**
  333. * 获取 Bucket 的 跨域设置
  334. * @param {Object} params 参数对象,必须
  335. * @param {String} params.Bucket Bucket名称,必须
  336. * @param {String} params.Region 地域名称,必须
  337. * @param {Function} callback 回调函数,必须
  338. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  339. * @return {Object} data 返回的数据
  340. * @return {Object} data.CORSRules Bucket的跨域设置
  341. */
  342. function getBucketCors(params, callback) {
  343. submitRequest.call(this, {
  344. Action: 'name/cos:GetBucketCORS',
  345. method: 'GET',
  346. Bucket: params.Bucket,
  347. Region: params.Region,
  348. headers: params.Headers,
  349. action: 'cors',
  350. }, function (err, data) {
  351. if (err) {
  352. if (err.statusCode === 404 && err.error && err.error.Code === 'NoSuchCORSConfiguration') {
  353. var result = {
  354. CORSRules: [],
  355. statusCode: err.statusCode,
  356. };
  357. err.headers && (result.headers = err.headers);
  358. callback(null, result);
  359. } else {
  360. callback(err);
  361. }
  362. return;
  363. }
  364. var CORSConfiguration = data.CORSConfiguration || {};
  365. var CORSRules = CORSConfiguration.CORSRules || CORSConfiguration.CORSRule || [];
  366. CORSRules = util.clone(util.isArray(CORSRules) ? CORSRules : [CORSRules]);
  367. var ResponseVary = CORSConfiguration.ResponseVary;
  368. util.each(CORSRules, function (rule) {
  369. util.each(['AllowedOrigin', 'AllowedHeader', 'AllowedMethod', 'ExposeHeader'], function (key) {
  370. var sKey = key + 's';
  371. var val = rule[sKey] || rule[key] || [];
  372. delete rule[key];
  373. rule[sKey] = util.isArray(val) ? val : [val];
  374. });
  375. });
  376. callback(null, {
  377. CORSRules: CORSRules,
  378. ResponseVary: ResponseVary,
  379. statusCode: data.statusCode,
  380. headers: data.headers,
  381. });
  382. });
  383. }
  384. /**
  385. * 删除 Bucket 的 跨域设置
  386. * @param {Object} params 参数对象,必须
  387. * @param {String} params.Bucket Bucket名称,必须
  388. * @param {String} params.Region 地域名称,必须
  389. * @param {Function} callback 回调函数,必须
  390. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  391. * @return {Object} data 返回的数据
  392. */
  393. function deleteBucketCors(params, callback) {
  394. submitRequest.call(this, {
  395. Action: 'name/cos:DeleteBucketCORS',
  396. method: 'DELETE',
  397. Bucket: params.Bucket,
  398. Region: params.Region,
  399. headers: params.Headers,
  400. action: 'cors',
  401. }, function (err, data) {
  402. if (err && err.statusCode === 204) {
  403. return callback(null, {statusCode: err.statusCode});
  404. } else if (err) {
  405. return callback(err);
  406. }
  407. callback(null, {
  408. statusCode: data.statusCode || err.statusCode,
  409. headers: data.headers,
  410. });
  411. });
  412. }
  413. /**
  414. * 获取 Bucket 的 地域信息
  415. * @param {Object} params 参数对象,必须
  416. * @param {String} params.Bucket Bucket名称,必须
  417. * @param {String} params.Region 地域名称,必须
  418. * @param {Function} callback 回调函数,必须
  419. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  420. * @return {Object} data 返回数据,包含地域信息 LocationConstraint
  421. */
  422. function getBucketLocation(params, callback) {
  423. submitRequest.call(this, {
  424. Action: 'name/cos:GetBucketLocation',
  425. method: 'GET',
  426. Bucket: params.Bucket,
  427. Region: params.Region,
  428. headers: params.Headers,
  429. action: 'location',
  430. }, function (err, data) {
  431. if (err) return callback(err);
  432. callback(null, data);
  433. });
  434. }
  435. function putBucketPolicy(params, callback) {
  436. var Policy = params['Policy'];
  437. var PolicyStr = Policy;
  438. try {
  439. if (typeof Policy === 'string') {
  440. Policy = JSON.parse(PolicyStr);
  441. } else {
  442. PolicyStr = JSON.stringify(Policy);
  443. }
  444. } catch (e) {
  445. callback({error: 'Policy format error'});
  446. }
  447. var headers = params.Headers;
  448. headers['Content-Type'] = 'application/json';
  449. headers['Content-MD5'] = util.binaryBase64(util.md5(PolicyStr));
  450. submitRequest.call(this, {
  451. Action: 'name/cos:PutBucketPolicy',
  452. method: 'PUT',
  453. Bucket: params.Bucket,
  454. Region: params.Region,
  455. action: 'policy',
  456. body: PolicyStr,
  457. headers: headers,
  458. json: true,
  459. }, function (err, data) {
  460. if (err && err.statusCode === 204) {
  461. return callback(null, {statusCode: err.statusCode});
  462. } else if (err) {
  463. return callback(err);
  464. }
  465. callback(null, {
  466. statusCode: data.statusCode,
  467. headers: data.headers,
  468. });
  469. });
  470. }
  471. /**
  472. * 获取 Bucket 的读取权限策略
  473. * @param {Object} params 参数对象,必须
  474. * @param {String} params.Bucket Bucket名称,必须
  475. * @param {String} params.Region 地域名称,必须
  476. * @param {Function} callback 回调函数,必须
  477. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  478. * @return {Object} data 返回数据
  479. */
  480. function getBucketPolicy(params, callback) {
  481. submitRequest.call(this, {
  482. Action: 'name/cos:GetBucketPolicy',
  483. method: 'GET',
  484. Bucket: params.Bucket,
  485. Region: params.Region,
  486. headers: params.Headers,
  487. action: 'policy',
  488. rawBody: true,
  489. }, function (err, data) {
  490. if (err) {
  491. if (err.statusCode && err.statusCode === 403) {
  492. return callback({ErrorStatus: 'Access Denied'});
  493. }
  494. if (err.statusCode && err.statusCode === 405) {
  495. return callback({ErrorStatus: 'Method Not Allowed'});
  496. }
  497. if (err.statusCode && err.statusCode === 404) {
  498. return callback({ErrorStatus: 'Policy Not Found'});
  499. }
  500. return callback(err);
  501. }
  502. var Policy = {};
  503. try {
  504. Policy = JSON.parse(data.body);
  505. } catch (e) {
  506. }
  507. callback(null, {
  508. Policy: Policy,
  509. statusCode: data.statusCode,
  510. headers: data.headers,
  511. });
  512. });
  513. }
  514. /**
  515. * 删除 Bucket 的 跨域设置
  516. * @param {Object} params 参数对象,必须
  517. * @param {String} params.Bucket Bucket名称,必须
  518. * @param {String} params.Region 地域名称,必须
  519. * @param {Function} callback 回调函数,必须
  520. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  521. * @return {Object} data 返回的数据
  522. */
  523. function deleteBucketPolicy(params, callback) {
  524. submitRequest.call(this, {
  525. Action: 'name/cos:DeleteBucketPolicy',
  526. method: 'DELETE',
  527. Bucket: params.Bucket,
  528. Region: params.Region,
  529. headers: params.Headers,
  530. action: 'policy',
  531. }, function (err, data) {
  532. if (err && err.statusCode === 204) {
  533. return callback(null, {statusCode: err.statusCode});
  534. } else if (err) {
  535. return callback(err);
  536. }
  537. callback(null, {
  538. statusCode: data.statusCode || err.statusCode,
  539. headers: data.headers,
  540. });
  541. });
  542. }
  543. /**
  544. * 设置 Bucket 的标签
  545. * @param {Object} params 参数对象,必须
  546. * @param {String} params.Bucket Bucket名称,必须
  547. * @param {String} params.Region 地域名称,必须
  548. * @param {Array} params.TagSet 标签设置,必须
  549. * @param {Function} callback 回调函数,必须
  550. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  551. * @return {Object} data 返回数据
  552. */
  553. function putBucketTagging(params, callback) {
  554. var Tagging = params['Tagging'] || {};
  555. var Tags = Tagging.TagSet || Tagging.Tags || params['Tags'] || [];
  556. Tags = util.clone(util.isArray(Tags) ? Tags : [Tags]);
  557. var xml = util.json2xml({Tagging: {TagSet: {Tag: Tags}}});
  558. var headers = params.Headers;
  559. headers['Content-Type'] = 'application/xml';
  560. headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
  561. submitRequest.call(this, {
  562. Action: 'name/cos:PutBucketTagging',
  563. method: 'PUT',
  564. Bucket: params.Bucket,
  565. Region: params.Region,
  566. body: xml,
  567. action: 'tagging',
  568. headers: headers,
  569. }, function (err, data) {
  570. if (err && err.statusCode === 204) {
  571. return callback(null, {statusCode: err.statusCode});
  572. } else if (err) {
  573. return callback(err);
  574. }
  575. callback(null, {
  576. statusCode: data.statusCode,
  577. headers: data.headers,
  578. });
  579. });
  580. }
  581. /**
  582. * 获取 Bucket 的标签设置
  583. * @param {Object} params 参数对象,必须
  584. * @param {String} params.Bucket Bucket名称,必须
  585. * @param {String} params.Region 地域名称,必须
  586. * @param {Function} callback 回调函数,必须
  587. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  588. * @return {Object} data 返回数据
  589. */
  590. function getBucketTagging(params, callback) {
  591. submitRequest.call(this, {
  592. Action: 'name/cos:GetBucketTagging',
  593. method: 'GET',
  594. Bucket: params.Bucket,
  595. Region: params.Region,
  596. headers: params.Headers,
  597. action: 'tagging',
  598. }, function (err, data) {
  599. if (err) {
  600. if (err.statusCode === 404 && err.error && (err.error === "Not Found" || err.error.Code === 'NoSuchTagSet')) {
  601. var result = {
  602. Tags: [],
  603. statusCode: err.statusCode,
  604. };
  605. err.headers && (result.headers = err.headers);
  606. callback(null, result);
  607. } else {
  608. callback(err);
  609. }
  610. return;
  611. }
  612. var Tags = [];
  613. try {
  614. Tags = data.Tagging.TagSet.Tag || [];
  615. } catch (e) {
  616. }
  617. Tags = util.clone(util.isArray(Tags) ? Tags : [Tags]);
  618. callback(null, {
  619. Tags: Tags,
  620. statusCode: data.statusCode,
  621. headers: data.headers,
  622. });
  623. });
  624. }
  625. /**
  626. * 删除 Bucket 的 标签设置
  627. * @param {Object} params 参数对象,必须
  628. * @param {String} params.Bucket Bucket名称,必须
  629. * @param {String} params.Region 地域名称,必须
  630. * @param {Function} callback 回调函数,必须
  631. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  632. * @return {Object} data 返回的数据
  633. */
  634. function deleteBucketTagging(params, callback) {
  635. submitRequest.call(this, {
  636. Action: 'name/cos:DeleteBucketTagging',
  637. method: 'DELETE',
  638. Bucket: params.Bucket,
  639. Region: params.Region,
  640. headers: params.Headers,
  641. action: 'tagging',
  642. }, function (err, data) {
  643. if (err && err.statusCode === 204) {
  644. return callback(null, {statusCode: err.statusCode});
  645. } else if (err) {
  646. return callback(err);
  647. }
  648. callback(null, {
  649. statusCode: data.statusCode,
  650. headers: data.headers,
  651. });
  652. });
  653. }
  654. function putBucketLifecycle(params, callback) {
  655. var LifecycleConfiguration = params['LifecycleConfiguration'] || {};
  656. var Rules = LifecycleConfiguration.Rules || params.Rules || [];
  657. Rules = util.clone(Rules);
  658. var xml = util.json2xml({LifecycleConfiguration: {Rule: Rules}});
  659. var headers = params.Headers;
  660. headers['Content-Type'] = 'application/xml';
  661. headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
  662. submitRequest.call(this, {
  663. Action: 'name/cos:PutBucketLifecycle',
  664. method: 'PUT',
  665. Bucket: params.Bucket,
  666. Region: params.Region,
  667. body: xml,
  668. action: 'lifecycle',
  669. headers: headers,
  670. }, function (err, data) {
  671. if (err && err.statusCode === 204) {
  672. return callback(null, {statusCode: err.statusCode});
  673. } else if (err) {
  674. return callback(err);
  675. }
  676. callback(null, {
  677. statusCode: data.statusCode,
  678. headers: data.headers,
  679. });
  680. });
  681. }
  682. function getBucketLifecycle(params, callback) {
  683. submitRequest.call(this, {
  684. Action: 'name/cos:GetBucketLifecycle',
  685. method: 'GET',
  686. Bucket: params.Bucket,
  687. Region: params.Region,
  688. headers: params.Headers,
  689. action: 'lifecycle',
  690. }, function (err, data) {
  691. if (err) {
  692. if (err.statusCode === 404 && err.error && err.error.Code === 'NoSuchLifecycleConfiguration') {
  693. var result = {
  694. Rules: [],
  695. statusCode: err.statusCode,
  696. };
  697. err.headers && (result.headers = err.headers);
  698. callback(null, result);
  699. } else {
  700. callback(err);
  701. }
  702. return;
  703. }
  704. var Rules = [];
  705. try {
  706. Rules = data.LifecycleConfiguration.Rule || [];
  707. } catch (e) {
  708. }
  709. Rules = util.clone(util.isArray(Rules) ? Rules : [Rules]);
  710. callback(null, {
  711. Rules: Rules,
  712. statusCode: data.statusCode,
  713. headers: data.headers,
  714. });
  715. });
  716. }
  717. function deleteBucketLifecycle(params, callback) {
  718. submitRequest.call(this, {
  719. Action: 'name/cos:DeleteBucketLifecycle',
  720. method: 'DELETE',
  721. Bucket: params.Bucket,
  722. Region: params.Region,
  723. headers: params.Headers,
  724. action: 'lifecycle',
  725. }, function (err, data) {
  726. if (err && err.statusCode === 204) {
  727. return callback(null, {statusCode: err.statusCode});
  728. } else if (err) {
  729. return callback(err);
  730. }
  731. callback(null, {
  732. statusCode: data.statusCode,
  733. headers: data.headers,
  734. });
  735. });
  736. }
  737. function putBucketVersioning(params, callback) {
  738. if (!params['VersioningConfiguration']) {
  739. callback({error: 'missing param VersioningConfiguration'});
  740. return;
  741. }
  742. var VersioningConfiguration = params['VersioningConfiguration'] || {};
  743. var xml = util.json2xml({VersioningConfiguration: VersioningConfiguration});
  744. var headers = params.Headers;
  745. headers['Content-Type'] = 'application/xml';
  746. headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
  747. submitRequest.call(this, {
  748. Action: 'name/cos:PutBucketVersioning',
  749. method: 'PUT',
  750. Bucket: params.Bucket,
  751. Region: params.Region,
  752. body: xml,
  753. action: 'versioning',
  754. headers: headers,
  755. }, function (err, data) {
  756. if (err && err.statusCode === 204) {
  757. return callback(null, {statusCode: err.statusCode});
  758. } else if (err) {
  759. return callback(err);
  760. }
  761. callback(null, {
  762. statusCode: data.statusCode,
  763. headers: data.headers,
  764. });
  765. });
  766. }
  767. function getBucketVersioning(params, callback) {
  768. submitRequest.call(this, {
  769. Action: 'name/cos:GetBucketVersioning',
  770. method: 'GET',
  771. Bucket: params.Bucket,
  772. Region: params.Region,
  773. headers: params.Headers,
  774. action: 'versioning',
  775. }, function (err, data) {
  776. if (!err) {
  777. !data.VersioningConfiguration && (data.VersioningConfiguration = {});
  778. }
  779. callback(err, data);
  780. });
  781. }
  782. function putBucketReplication(params, callback) {
  783. var ReplicationConfiguration = util.clone(params.ReplicationConfiguration);
  784. var xml = util.json2xml({ReplicationConfiguration: ReplicationConfiguration});
  785. xml = xml.replace(/<(\/?)Rules>/ig, '<$1Rule>');
  786. xml = xml.replace(/<(\/?)Tags>/ig, '<$1Tag>');
  787. var headers = params.Headers;
  788. headers['Content-Type'] = 'application/xml';
  789. headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
  790. submitRequest.call(this, {
  791. Action: 'name/cos:PutBucketReplication',
  792. method: 'PUT',
  793. Bucket: params.Bucket,
  794. Region: params.Region,
  795. body: xml,
  796. action: 'replication',
  797. headers: headers,
  798. }, function (err, data) {
  799. if (err && err.statusCode === 204) {
  800. return callback(null, {statusCode: err.statusCode});
  801. } else if (err) {
  802. return callback(err);
  803. }
  804. callback(null, {
  805. statusCode: data.statusCode,
  806. headers: data.headers,
  807. });
  808. });
  809. }
  810. function getBucketReplication(params, callback) {
  811. submitRequest.call(this, {
  812. Action: 'name/cos:GetBucketReplication',
  813. method: 'GET',
  814. Bucket: params.Bucket,
  815. Region: params.Region,
  816. headers: params.Headers,
  817. action: 'replication',
  818. }, function (err, data) {
  819. if (err) {
  820. if (err.statusCode === 404 && err.error && (err.error === 'Not Found' || err.error.Code === 'ReplicationConfigurationnotFoundError')) {
  821. var result = {
  822. ReplicationConfiguration: {Rules: []},
  823. statusCode: err.statusCode,
  824. };
  825. err.headers && (result.headers = err.headers);
  826. callback(null, result);
  827. } else {
  828. callback(err);
  829. }
  830. return;
  831. }
  832. if (!err) {
  833. !data.ReplicationConfiguration && (data.ReplicationConfiguration = {});
  834. }
  835. if (data.ReplicationConfiguration.Rule) {
  836. data.ReplicationConfiguration.Rules = data.ReplicationConfiguration.Rule;
  837. delete data.ReplicationConfiguration.Rule;
  838. }
  839. callback(err, data);
  840. });
  841. }
  842. function deleteBucketReplication(params, callback) {
  843. submitRequest.call(this, {
  844. Action: 'name/cos:DeleteBucketReplication',
  845. method: 'DELETE',
  846. Bucket: params.Bucket,
  847. Region: params.Region,
  848. headers: params.Headers,
  849. action: 'replication',
  850. }, function (err, data) {
  851. if (err && err.statusCode === 204) {
  852. return callback(null, {statusCode: err.statusCode});
  853. } else if (err) {
  854. return callback(err);
  855. }
  856. callback(null, {
  857. statusCode: data.statusCode,
  858. headers: data.headers,
  859. });
  860. });
  861. }
  862. /**
  863. * 设置 Bucket 静态网站配置信息
  864. * @param {Object} params 参数对象,必须
  865. * @param {String} params.Bucket Bucket名称,必须
  866. * @param {String} params.Region 地域名称,必须
  867. * @param {Object} params.WebsiteConfiguration 地域名称,必须
  868. * @param {Object} WebsiteConfiguration.IndexDocument 索引文档,必须
  869. * @param {Object} WebsiteConfiguration.ErrorDocument 错误文档,非必须
  870. * @param {Object} WebsiteConfiguration.RedirectAllRequestsTo 重定向所有请求,非必须
  871. * @param {Array} params.RoutingRules 重定向规则,非必须
  872. * @param {Function} callback 回调函数,必须
  873. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  874. * @return {Object} data 返回数据
  875. */
  876. function putBucketWebsite(params, callback) {
  877. if (!params['WebsiteConfiguration']) {
  878. callback({ error: 'missing param WebsiteConfiguration' });
  879. return;
  880. }
  881. var WebsiteConfiguration = util.clone(params['WebsiteConfiguration'] || {});
  882. var RoutingRules = WebsiteConfiguration['RoutingRules'] || WebsiteConfiguration['RoutingRule'] || [];
  883. RoutingRules = util.isArray(RoutingRules) ? RoutingRules : [RoutingRules];
  884. delete WebsiteConfiguration.RoutingRule;
  885. delete WebsiteConfiguration.RoutingRules;
  886. if (RoutingRules.length) WebsiteConfiguration.RoutingRules = { RoutingRule: RoutingRules };
  887. var xml = util.json2xml({ WebsiteConfiguration: WebsiteConfiguration });
  888. var headers = params.Headers;
  889. headers['Content-Type'] = 'application/xml';
  890. headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
  891. submitRequest.call(this, {
  892. Action: 'name/cos:PutBucketWebsite',
  893. method: 'PUT',
  894. Bucket: params.Bucket,
  895. Region: params.Region,
  896. body: xml,
  897. action: 'website',
  898. headers: headers,
  899. }, function (err, data) {
  900. if (err && err.statusCode === 204) {
  901. return callback(null, {statusCode: err.statusCode});
  902. } else if (err) {
  903. return callback(err);
  904. }
  905. callback(null, {
  906. statusCode: data.statusCode,
  907. headers: data.headers,
  908. });
  909. });
  910. }
  911. /**
  912. * 获取 Bucket 的静态网站配置信息
  913. * @param {Object} params 参数对象,必须
  914. * @param {String} params.Bucket Bucket名称,必须
  915. * @param {String} params.Region 地域名称,必须
  916. * @param {Function} callback 回调函数,必须
  917. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  918. * @return {Object} data 返回数据
  919. */
  920. function getBucketWebsite(params, callback) {
  921. submitRequest.call(this, {
  922. Action: 'name/cos:GetBucketWebsite',
  923. method: 'GET',
  924. Bucket: params.Bucket,
  925. Region: params.Region,
  926. Key: params.Key,
  927. headers: params.Headers,
  928. action: 'website',
  929. }, function (err, data) {
  930. if (err) {
  931. if(err.statusCode === 404 && err.error.Code === 'NoSuchWebsiteConfiguration'){
  932. var result = {
  933. WebsiteConfiguration: {},
  934. statusCode: err.statusCode,
  935. };
  936. err.headers && (result.headers = err.headers);
  937. callback(null, result);
  938. } else {
  939. callback(err);
  940. }
  941. return;
  942. }
  943. var WebsiteConfiguration = data.WebsiteConfiguration || {};
  944. if (WebsiteConfiguration['RoutingRules']) {
  945. var RoutingRules = util.clone(WebsiteConfiguration['RoutingRules'].RoutingRule || []);
  946. RoutingRules = util.makeArray(RoutingRules);
  947. WebsiteConfiguration.RoutingRules = RoutingRules;
  948. }
  949. callback(null, {
  950. WebsiteConfiguration: WebsiteConfiguration,
  951. statusCode: data.statusCode,
  952. headers: data.headers,
  953. });
  954. });
  955. }
  956. /**
  957. * 删除 Bucket 的静态网站配置
  958. * @param {Object} params 参数对象,必须
  959. * @param {String} params.Bucket Bucket名称,必须
  960. * @param {String} params.Region 地域名称,必须
  961. * @param {Function} callback 回调函数,必须
  962. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  963. * @return {Object} data 返回数据
  964. */
  965. function deleteBucketWebsite(params, callback) {
  966. submitRequest.call(this, {
  967. Action: 'name/cos:DeleteBucketWebsite',
  968. method: 'DELETE',
  969. Bucket: params.Bucket,
  970. Region: params.Region,
  971. headers: params.Headers,
  972. action: 'website',
  973. }, function (err, data) {
  974. if (err && err.statusCode === 204) {
  975. return callback(null, {statusCode: err.statusCode});
  976. } else if (err) {
  977. return callback(err);
  978. }
  979. callback(null, {
  980. statusCode: data.statusCode,
  981. headers: data.headers,
  982. });
  983. });
  984. }
  985. /**
  986. * 设置 Bucket 的防盗链白名单或者黑名单
  987. * @param {Object} params 参数对象,必须
  988. * @param {String} params.Bucket Bucket名称,必须
  989. * @param {String} params.Region 地域名称,必须
  990. * @param {Object} params.RefererConfiguration 地域名称,必须
  991. * @param {String} RefererConfiguration.Status 是否开启防盗链,枚举值:Enabled、Disabled
  992. * @param {String} RefererConfiguration.RefererType 防盗链类型,枚举值:Black-List、White-List,必须
  993. * @param {Array} RefererConfiguration.DomianList.Domain 生效域名,必须
  994. * @param {String} RefererConfiguration.EmptyReferConfiguration ,非必须
  995. * @param {Function} callback 回调函数,必须
  996. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  997. * @return {Object} data 返回数据
  998. */
  999. function putBucketReferer(params, callback) {
  1000. if (!params['RefererConfiguration']) {
  1001. callback({ error: 'missing param RefererConfiguration' });
  1002. return;
  1003. }
  1004. var RefererConfiguration = util.clone(params['RefererConfiguration'] || {});
  1005. var DomainList = RefererConfiguration['DomainList'] || {};
  1006. var Domains = DomainList['Domains'] || DomainList['Domain'] || [];
  1007. Domains = util.isArray(Domains) ? Domains : [Domains];
  1008. if (Domains.length) RefererConfiguration.DomainList = {Domain: Domains};
  1009. var xml = util.json2xml({ RefererConfiguration: RefererConfiguration });
  1010. var headers = params.Headers;
  1011. headers['Content-Type'] = 'application/xml';
  1012. headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
  1013. submitRequest.call(this, {
  1014. Action: 'name/cos:PutBucketReferer',
  1015. method: 'PUT',
  1016. Bucket: params.Bucket,
  1017. Region: params.Region,
  1018. body: xml,
  1019. action: 'referer',
  1020. headers: headers,
  1021. }, function (err, data) {
  1022. if (err && err.statusCode === 204) {
  1023. return callback(null, {statusCode: err.statusCode});
  1024. } else if (err) {
  1025. return callback(err);
  1026. }
  1027. callback(null, {
  1028. statusCode: data.statusCode,
  1029. headers: data.headers,
  1030. });
  1031. });
  1032. }
  1033. /**
  1034. * 获取 Bucket 的防盗链白名单或者黑名单
  1035. * @param {Object} params 参数对象,必须
  1036. * @param {String} params.Bucket Bucket名称,必须
  1037. * @param {String} params.Region 地域名称,必须
  1038. * @param {Function} callback 回调函数,必须
  1039. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  1040. * @return {Object} data 返回数据
  1041. */
  1042. function getBucketReferer(params, callback) {
  1043. submitRequest.call(this, {
  1044. Action: 'name/cos:GetBucketReferer',
  1045. method: 'GET',
  1046. Bucket: params.Bucket,
  1047. Region: params.Region,
  1048. Key: params.Key,
  1049. headers: params.Headers,
  1050. action: 'referer',
  1051. }, function (err, data) {
  1052. if (err) {
  1053. if(err.statusCode === 404 && err.error.Code === 'NoSuchRefererConfiguration'){
  1054. var result = {
  1055. WebsiteConfiguration: {},
  1056. statusCode: err.statusCode,
  1057. };
  1058. err.headers && (result.headers = err.headers);
  1059. callback(null, result);
  1060. } else {
  1061. callback(err);
  1062. }
  1063. return;
  1064. }
  1065. var RefererConfiguration = data.RefererConfiguration || {};
  1066. if (RefererConfiguration['DomainList']) {
  1067. var Domains = util.makeArray(RefererConfiguration['DomainList'].Domain || []);
  1068. RefererConfiguration.DomainList = {Domains: Domains};
  1069. }
  1070. callback(null, {
  1071. RefererConfiguration: RefererConfiguration,
  1072. statusCode: data.statusCode,
  1073. headers: data.headers,
  1074. });
  1075. });
  1076. }
  1077. /**
  1078. * 设置 Bucket 自定义域名
  1079. * @param {Object} params 参数对象,必须
  1080. * @param {String} params.Bucket Bucket名称,必须
  1081. * @param {String} params.Region 地域名称,必须
  1082. * @param {Function} callback 回调函数,必须
  1083. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  1084. * @return {Object} data 返回数据
  1085. */
  1086. function putBucketDomain(params, callback) {
  1087. var DomainConfiguration = params['DomainConfiguration'] || {};
  1088. var DomainRule = DomainConfiguration.DomainRule || params.DomainRule || [];
  1089. DomainRule = util.clone(DomainRule);
  1090. var xml = util.json2xml({DomainConfiguration: {DomainRule: DomainRule}});
  1091. var headers = params.Headers;
  1092. headers['Content-Type'] = 'application/xml';
  1093. headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
  1094. submitRequest.call(this, {
  1095. Action: 'name/cos:PutBucketDomain',
  1096. method: 'PUT',
  1097. Bucket: params.Bucket,
  1098. Region: params.Region,
  1099. body: xml,
  1100. action: 'domain',
  1101. headers: headers,
  1102. }, function (err, data) {
  1103. if (err && err.statusCode === 204) {
  1104. return callback(null, {statusCode: err.statusCode});
  1105. } else if (err) {
  1106. return callback(err);
  1107. }
  1108. callback(null, {
  1109. statusCode: data.statusCode,
  1110. headers: data.headers,
  1111. });
  1112. });
  1113. }
  1114. /**
  1115. * 获取 Bucket 的自定义域名
  1116. * @param {Object} params 参数对象,必须
  1117. * @param {String} params.Bucket Bucket名称,必须
  1118. * @param {String} params.Region 地域名称,必须
  1119. * @param {Function} callback 回调函数,必须
  1120. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  1121. * @return {Object} data 返回数据
  1122. */
  1123. function getBucketDomain(params, callback) {
  1124. submitRequest.call(this, {
  1125. Action: 'name/cos:GetBucketDomain',
  1126. method: 'GET',
  1127. Bucket: params.Bucket,
  1128. Region: params.Region,
  1129. headers: params.Headers,
  1130. action: 'domain',
  1131. }, function (err, data) {
  1132. if (err) return callback(err);
  1133. var DomainRule = [];
  1134. try {
  1135. DomainRule = data.DomainConfiguration.DomainRule || [];
  1136. } catch (e) {
  1137. }
  1138. DomainRule = util.clone(util.isArray(DomainRule) ? DomainRule : [DomainRule]);
  1139. callback(null, {
  1140. DomainRule: DomainRule,
  1141. statusCode: data.statusCode,
  1142. headers: data.headers,
  1143. });
  1144. });
  1145. }
  1146. /**
  1147. * 删除 Bucket 自定义域名
  1148. * @param {Object} params 参数对象,必须
  1149. * @param {String} params.Bucket Bucket名称,必须
  1150. * @param {String} params.Region 地域名称,必须
  1151. * @param {Function} callback 回调函数,必须
  1152. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  1153. * @return {Object} data 返回数据
  1154. */
  1155. function deleteBucketDomain(params, callback) {
  1156. submitRequest.call(this, {
  1157. Action: 'name/cos:DeleteBucketDomain',
  1158. method: 'DELETE',
  1159. Bucket: params.Bucket,
  1160. Region: params.Region,
  1161. headers: params.Headers,
  1162. action: 'domain',
  1163. }, function (err, data) {
  1164. if (err && err.statusCode === 204) {
  1165. return callback(null, {statusCode: err.statusCode});
  1166. } else if (err) {
  1167. return callback(err);
  1168. }
  1169. callback(null, {
  1170. statusCode: data.statusCode,
  1171. headers: data.headers,
  1172. });
  1173. });
  1174. }
  1175. /**
  1176. * 设置 Bucket 的回源
  1177. * @param {Object} params 参数对象,必须
  1178. * @param {String} params.Bucket Bucket名称,必须
  1179. * @param {String} params.Region 地域名称,必须
  1180. * @param {Function} callback 回调函数,必须
  1181. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  1182. * @return {Object} data 返回数据
  1183. */
  1184. function putBucketOrigin(params, callback){
  1185. var OriginConfiguration = params['OriginConfiguration'] || {};
  1186. var OriginRule = OriginConfiguration.OriginRule || params.OriginRule || [];
  1187. OriginRule = util.clone(OriginRule);
  1188. var xml = util.json2xml({OriginConfiguration: {OriginRule: OriginRule}});
  1189. var headers = params.Headers;
  1190. headers['Content-Type'] = 'application/xml';
  1191. headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
  1192. submitRequest.call(this, {
  1193. Action: 'name/cos:PutBucketOrigin',
  1194. method: 'PUT',
  1195. Bucket: params.Bucket,
  1196. Region: params.Region,
  1197. body: xml,
  1198. action: 'origin',
  1199. headers: headers,
  1200. }, function (err, data) {
  1201. if (err && err.statusCode === 204) {
  1202. return callback(null, {statusCode: err.statusCode});
  1203. } else if (err) {
  1204. return callback(err);
  1205. }
  1206. callback(null, {
  1207. statusCode: data.statusCode,
  1208. headers: data.headers,
  1209. });
  1210. });
  1211. }
  1212. /**
  1213. * 获取 Bucket 的回源
  1214. * @param {Object} params 参数对象,必须
  1215. * @param {String} params.Bucket Bucket名称,必须
  1216. * @param {String} params.Region 地域名称,必须
  1217. * @param {Function} callback 回调函数,必须
  1218. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  1219. * @return {Object} data 返回数据
  1220. */
  1221. function getBucketOrigin(params, callback) {
  1222. submitRequest.call(this, {
  1223. Action: 'name/cos:GetBucketOrigin',
  1224. method: 'GET',
  1225. Bucket: params.Bucket,
  1226. Region: params.Region,
  1227. headers: params.Headers,
  1228. action: 'origin',
  1229. }, function (err, data) {
  1230. if (err) return callback(err);
  1231. var OriginRule = [];
  1232. try {
  1233. OriginRule = data.OriginConfiguration.OriginRule || [];
  1234. } catch (e) {
  1235. }
  1236. OriginRule = util.clone(util.isArray(OriginRule) ? OriginRule : [OriginRule]);
  1237. callback(null, {
  1238. OriginRule: OriginRule,
  1239. statusCode: data.statusCode,
  1240. headers: data.headers,
  1241. });
  1242. });
  1243. }
  1244. /**
  1245. * 删除 Bucket 的回源
  1246. * @param {Object} params 参数对象,必须
  1247. * @param {String} params.Bucket Bucket名称,必须
  1248. * @param {String} params.Region 地域名称,必须
  1249. * @param {Function} callback 回调函数,必须
  1250. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  1251. * @return {Object} data 返回数据
  1252. */
  1253. function deleteBucketOrigin(params, callback) {
  1254. submitRequest.call(this, {
  1255. Action: 'name/cos:DeleteBucketOrigin',
  1256. method: 'DELETE',
  1257. Bucket: params.Bucket,
  1258. Region: params.Region,
  1259. headers: params.Headers,
  1260. action: 'origin',
  1261. }, function (err, data) {
  1262. if (err && err.statusCode === 204) {
  1263. return callback(null, {statusCode: err.statusCode});
  1264. } else if (err) {
  1265. return callback(err);
  1266. }
  1267. callback(null, {
  1268. statusCode: data.statusCode,
  1269. headers: data.headers,
  1270. });
  1271. });
  1272. }
  1273. /**
  1274. * 设置 Bucket 的日志记录
  1275. * @param {Object} params 参数对象,必须
  1276. * @param {String} params.Bucket Bucket名称,必须
  1277. * @param {String} params.Region 地域名称,必须
  1278. * @param {(Object|String)} params.BucketLoggingStatus 说明日志记录配置的状态,如果无子节点信息则意为关闭日志记录,必须
  1279. * @param {Function} callback 回调函数,必须
  1280. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  1281. * @return {Object} data 返回数据
  1282. */
  1283. function putBucketLogging(params, callback) {
  1284. var xml = util.json2xml({
  1285. BucketLoggingStatus: params['BucketLoggingStatus'] || ''
  1286. });
  1287. var headers = params.Headers;
  1288. headers['Content-Type'] = 'application/xml';
  1289. headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
  1290. submitRequest.call(this, {
  1291. Action: 'name/cos:PutBucketLogging',
  1292. method: 'PUT',
  1293. Bucket: params.Bucket,
  1294. Region: params.Region,
  1295. body: xml,
  1296. action: 'logging',
  1297. headers: headers,
  1298. }, function (err, data) {
  1299. if (err && err.statusCode === 204) {
  1300. return callback(null, {statusCode: err.statusCode});
  1301. } else if (err) {
  1302. return callback(err);
  1303. }
  1304. callback(null, {
  1305. statusCode: data.statusCode,
  1306. headers: data.headers,
  1307. });
  1308. });
  1309. }
  1310. /**
  1311. * 获取 Bucket 的日志记录
  1312. * @param {Object} params 参数对象,必须
  1313. * @param {String} params.Bucket Bucket名称,必须
  1314. * @param {String} params.Region 地域名称,必须
  1315. * @param {Function} callback 回调函数,必须
  1316. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  1317. * @return {Object} data 返回数据
  1318. */
  1319. function getBucketLogging(params, callback) {
  1320. submitRequest.call(this, {
  1321. Action: 'name/cos:GetBucketLogging',
  1322. method: 'GET',
  1323. Bucket: params.Bucket,
  1324. Region: params.Region,
  1325. headers: params.Headers,
  1326. action: 'logging',
  1327. }, function (err, data) {
  1328. if (err) return callback(err);
  1329. delete data.BucketLoggingStatus._xmlns;
  1330. callback(null, {
  1331. BucketLoggingStatus: data.BucketLoggingStatus,
  1332. statusCode: data.statusCode,
  1333. headers: data.headers,
  1334. });
  1335. });
  1336. }
  1337. /**
  1338. * 创建/编辑 Bucket 的清单任务
  1339. * @param {Object} params 参数对象,必须
  1340. * @param {String} params.Bucket Bucket名称,必须
  1341. * @param {String} params.Region 地域名称,必须
  1342. * @param {String} params.Id 清单任务的名称,必须
  1343. * @param {Object} params.InventoryConfiguration 包含清单的配置参数,必须
  1344. * @param {Function} callback 回调函数,必须
  1345. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  1346. * @return {Object} data 返回数据
  1347. */
  1348. function putBucketInventory(params, callback) {
  1349. var InventoryConfiguration = util.clone(params['InventoryConfiguration']);
  1350. if (InventoryConfiguration.OptionalFields) {
  1351. var Field = InventoryConfiguration.OptionalFields || [];
  1352. InventoryConfiguration.OptionalFields = {
  1353. Field: Field
  1354. };
  1355. }
  1356. if (InventoryConfiguration.Destination
  1357. && InventoryConfiguration.Destination.COSBucketDestination
  1358. && InventoryConfiguration.Destination.COSBucketDestination.Encryption
  1359. ) {
  1360. var Encryption = InventoryConfiguration.Destination.COSBucketDestination.Encryption;
  1361. if (Object.keys(Encryption).indexOf('SSECOS') > -1) {
  1362. Encryption['SSE-COS'] = Encryption['SSECOS'];
  1363. delete Encryption['SSECOS'];
  1364. }
  1365. }
  1366. var xml = util.json2xml({
  1367. InventoryConfiguration: InventoryConfiguration
  1368. });
  1369. var headers = params.Headers;
  1370. headers['Content-Type'] = 'application/xml';
  1371. headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
  1372. submitRequest.call(this, {
  1373. Action: 'name/cos:PutBucketInventory',
  1374. method: 'PUT',
  1375. Bucket: params.Bucket,
  1376. Region: params.Region,
  1377. body: xml,
  1378. action: 'inventory',
  1379. qs: {
  1380. id: params['Id']
  1381. },
  1382. headers: headers,
  1383. }, function (err, data) {
  1384. if (err && err.statusCode === 204) {
  1385. return callback(null, {statusCode: err.statusCode});
  1386. } else if (err) {
  1387. return callback(err);
  1388. }
  1389. callback(null, {
  1390. statusCode: data.statusCode,
  1391. headers: data.headers,
  1392. });
  1393. });
  1394. }
  1395. /**
  1396. * 获取 Bucket 的清单任务信息
  1397. * @param {Object} params 参数对象,必须
  1398. * @param {String} params.Bucket Bucket名称,必须
  1399. * @param {String} params.Region 地域名称,必须
  1400. * @param {String} params.Id 清单任务的名称,必须
  1401. * @param {Function} callback 回调函数,必须
  1402. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  1403. * @return {Object} data 返回数据
  1404. */
  1405. function getBucketInventory(params, callback) {
  1406. submitRequest.call(this, {
  1407. Action: 'name/cos:GetBucketInventory',
  1408. method: 'GET',
  1409. Bucket: params.Bucket,
  1410. Region: params.Region,
  1411. headers: params.Headers,
  1412. action: 'inventory',
  1413. qs: {
  1414. id: params['Id']
  1415. }
  1416. }, function (err, data) {
  1417. if (err) return callback(err);
  1418. var InventoryConfiguration = data['InventoryConfiguration'];
  1419. if (InventoryConfiguration && InventoryConfiguration.OptionalFields && InventoryConfiguration.OptionalFields.Field) {
  1420. var Field = InventoryConfiguration.OptionalFields.Field;
  1421. if (!util.isArray(Field)) {
  1422. Field = [Field];
  1423. }
  1424. InventoryConfiguration.OptionalFields = Field;
  1425. }
  1426. if (InventoryConfiguration.Destination
  1427. && InventoryConfiguration.Destination.COSBucketDestination
  1428. && InventoryConfiguration.Destination.COSBucketDestination.Encryption
  1429. ) {
  1430. var Encryption = InventoryConfiguration.Destination.COSBucketDestination.Encryption;
  1431. if (Object.keys(Encryption).indexOf('SSE-COS') > -1) {
  1432. Encryption['SSECOS'] = Encryption['SSE-COS'];
  1433. delete Encryption['SSE-COS'];
  1434. }
  1435. }
  1436. callback(null, {
  1437. InventoryConfiguration: InventoryConfiguration,
  1438. statusCode: data.statusCode,
  1439. headers: data.headers,
  1440. });
  1441. });
  1442. }
  1443. /**
  1444. * 获取 Bucket 的清单任务信息
  1445. * @param {Object} params 参数对象,必须
  1446. * @param {String} params.Bucket Bucket名称,必须
  1447. * @param {String} params.Region 地域名称,必须
  1448. * @param {String} params.ContinuationToken 当 COS 响应体中 IsTruncated 为 true,且 NextContinuationToken 节点中存在参数值时,您可以将这个参数作为 continuation-token 参数值,以获取下一页的清单任务信息,非必须
  1449. * @param {Function} callback 回调函数,必须
  1450. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  1451. * @return {Object} data 返回数据
  1452. */
  1453. function listBucketInventory(params, callback) {
  1454. submitRequest.call(this, {
  1455. Action: 'name/cos:ListBucketInventory',
  1456. method: 'GET',
  1457. Bucket: params.Bucket,
  1458. Region: params.Region,
  1459. headers: params.Headers,
  1460. action: 'inventory',
  1461. qs: {
  1462. 'continuation-token': params['ContinuationToken']
  1463. }
  1464. }, function (err, data) {
  1465. if (err) return callback(err);
  1466. var ListInventoryConfigurationResult = data['ListInventoryConfigurationResult'];
  1467. var InventoryConfigurations = ListInventoryConfigurationResult.InventoryConfiguration || [];
  1468. InventoryConfigurations = util.isArray(InventoryConfigurations) ? InventoryConfigurations : [InventoryConfigurations];
  1469. delete ListInventoryConfigurationResult['InventoryConfiguration'];
  1470. util.each(InventoryConfigurations, function (InventoryConfiguration) {
  1471. if (InventoryConfiguration && InventoryConfiguration.OptionalFields && InventoryConfiguration.OptionalFields.Field) {
  1472. var Field = InventoryConfiguration.OptionalFields.Field;
  1473. if (!util.isArray(Field)) {
  1474. Field = [Field];
  1475. }
  1476. InventoryConfiguration.OptionalFields = Field;
  1477. }
  1478. if (InventoryConfiguration.Destination
  1479. && InventoryConfiguration.Destination.COSBucketDestination
  1480. && InventoryConfiguration.Destination.COSBucketDestination.Encryption
  1481. ) {
  1482. var Encryption = InventoryConfiguration.Destination.COSBucketDestination.Encryption;
  1483. if (Object.keys(Encryption).indexOf('SSE-COS') > -1) {
  1484. Encryption['SSECOS'] = Encryption['SSE-COS'];
  1485. delete Encryption['SSE-COS'];
  1486. }
  1487. }
  1488. });
  1489. ListInventoryConfigurationResult.InventoryConfigurations = InventoryConfigurations;
  1490. util.extend(ListInventoryConfigurationResult, {
  1491. statusCode: data.statusCode,
  1492. headers: data.headers,
  1493. });
  1494. callback(null, ListInventoryConfigurationResult);
  1495. });
  1496. }
  1497. /**
  1498. * 删除 Bucket 的清单任务
  1499. * @param {Object} params 参数对象,必须
  1500. * @param {String} params.Bucket Bucket名称,必须
  1501. * @param {String} params.Region 地域名称,必须
  1502. * @param {String} params.Id 清单任务的名称,必须
  1503. * @param {Function} callback 回调函数,必须
  1504. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  1505. * @return {Object} data 返回数据
  1506. */
  1507. function deleteBucketInventory(params, callback) {
  1508. submitRequest.call(this, {
  1509. Action: 'name/cos:DeleteBucketInventory',
  1510. method: 'DELETE',
  1511. Bucket: params.Bucket,
  1512. Region: params.Region,
  1513. headers: params.Headers,
  1514. action: 'inventory',
  1515. qs: {
  1516. id: params['Id']
  1517. }
  1518. }, function (err, data) {
  1519. if (err && err.statusCode === 204) {
  1520. return callback(null, {statusCode: err.statusCode});
  1521. } else if (err) {
  1522. return callback(err);
  1523. }
  1524. callback(null, {
  1525. statusCode: data.statusCode,
  1526. headers: data.headers,
  1527. });
  1528. });
  1529. }
  1530. /* 全球加速 */
  1531. function putBucketAccelerate(params, callback) {
  1532. if (!params['AccelerateConfiguration']) {
  1533. callback({error: 'missing param AccelerateConfiguration'});
  1534. return;
  1535. }
  1536. var configuration = { AccelerateConfiguration: params.AccelerateConfiguration || {} };
  1537. var xml = util.json2xml(configuration);
  1538. var headers = {};
  1539. headers['Content-Type'] = 'application/xml';
  1540. headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
  1541. submitRequest.call(this, {
  1542. Interface: 'putBucketAccelerate',
  1543. Action: 'name/cos:PutBucketAccelerate',
  1544. method: 'PUT',
  1545. Bucket: params.Bucket,
  1546. Region: params.Region,
  1547. body: xml,
  1548. action: 'accelerate',
  1549. headers: headers,
  1550. }, function (err, data) {
  1551. if (err) return callback(err);
  1552. callback(null, {
  1553. statusCode: data.statusCode,
  1554. headers: data.headers,
  1555. });
  1556. });
  1557. }
  1558. function getBucketAccelerate(params, callback) {
  1559. submitRequest.call(this, {
  1560. Interface: 'getBucketAccelerate',
  1561. Action: 'name/cos:GetBucketAccelerate',
  1562. method: 'GET',
  1563. Bucket: params.Bucket,
  1564. Region: params.Region,
  1565. action: 'accelerate',
  1566. }, function (err, data) {
  1567. if (!err) {
  1568. !data.AccelerateConfiguration && (data.AccelerateConfiguration = {});
  1569. }
  1570. callback(err, data);
  1571. });
  1572. }
  1573. // Object 相关
  1574. /**
  1575. * 取回对应Object的元数据,Head的权限与Get的权限一致
  1576. * @param {Object} params 参数对象,必须
  1577. * @param {String} params.Bucket Bucket名称,必须
  1578. * @param {String} params.Region 地域名称,必须
  1579. * @param {String} params.Key 文件名称,必须
  1580. * @param {String} params.IfModifiedSince 当Object在指定时间后被修改,则返回对应Object元信息,否则返回304,非必须
  1581. * @param {Function} callback 回调函数,必须
  1582. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  1583. * @return {Object} data 为指定 object 的元数据,如果设置了 IfModifiedSince ,且文件未修改,则返回一个对象,NotModified 属性为 true
  1584. * @return {Boolean} data.NotModified 是否在 IfModifiedSince 时间点之后未修改该 object,则为 true
  1585. */
  1586. function headObject(params, callback) {
  1587. submitRequest.call(this, {
  1588. Action: 'name/cos:HeadObject',
  1589. method: 'HEAD',
  1590. Bucket: params.Bucket,
  1591. Region: params.Region,
  1592. Key: params.Key,
  1593. VersionId: params.VersionId,
  1594. headers: params.Headers,
  1595. }, function (err, data) {
  1596. if (err) {
  1597. var statusCode = err.statusCode;
  1598. if (params.Headers['If-Modified-Since'] && statusCode && statusCode === 304) {
  1599. return callback(null, {
  1600. NotModified: true,
  1601. statusCode: statusCode,
  1602. });
  1603. }
  1604. return callback(err);
  1605. }
  1606. data.ETag = util.attr(data.headers, 'etag', '');
  1607. callback(null, data);
  1608. });
  1609. }
  1610. function listObjectVersions(params, callback) {
  1611. var reqParams = {};
  1612. reqParams['prefix'] = params['Prefix'] || '';
  1613. reqParams['delimiter'] = params['Delimiter'];
  1614. reqParams['key-marker'] = params['KeyMarker'];
  1615. reqParams['version-id-marker'] = params['VersionIdMarker'];
  1616. reqParams['max-keys'] = params['MaxKeys'];
  1617. reqParams['encoding-type'] = params['EncodingType'];
  1618. submitRequest.call(this, {
  1619. Action: 'name/cos:GetBucketObjectVersions',
  1620. ResourceKey: reqParams['prefix'],
  1621. method: 'GET',
  1622. Bucket: params.Bucket,
  1623. Region: params.Region,
  1624. headers: params.Headers,
  1625. qs: reqParams,
  1626. action: 'versions',
  1627. }, function (err, data) {
  1628. if (err) return callback(err);
  1629. var ListVersionsResult = data.ListVersionsResult || {};
  1630. var DeleteMarkers = ListVersionsResult.DeleteMarker || [];
  1631. DeleteMarkers = util.isArray(DeleteMarkers) ? DeleteMarkers : [DeleteMarkers];
  1632. var Versions = ListVersionsResult.Version || [];
  1633. Versions = util.isArray(Versions) ? Versions : [Versions];
  1634. var result = util.clone(ListVersionsResult);
  1635. delete result.DeleteMarker;
  1636. delete result.Version;
  1637. util.extend(result, {
  1638. DeleteMarkers: DeleteMarkers,
  1639. Versions: Versions,
  1640. statusCode: data.statusCode,
  1641. headers: data.headers,
  1642. });
  1643. callback(null, result);
  1644. });
  1645. }
  1646. /**
  1647. * 下载 object
  1648. * @param {Object} params 参数对象,必须
  1649. * @param {String} params.Bucket Bucket名称,必须
  1650. * @param {String} params.Region 地域名称,必须
  1651. * @param {String} params.Key 文件名称,必须
  1652. * @param {WriteStream} params.Output 文件写入流,非必须
  1653. * @param {String} params.IfModifiedSince 当Object在指定时间后被修改,则返回对应Object元信息,否则返回304,非必须
  1654. * @param {String} params.IfUnmodifiedSince 如果文件修改时间早于或等于指定时间,才返回文件内容。否则返回 412 (precondition failed),非必须
  1655. * @param {String} params.IfMatch 当 ETag 与指定的内容一致,才返回文件。否则返回 412 (precondition failed),非必须
  1656. * @param {String} params.IfNoneMatch 当 ETag 与指定的内容不一致,才返回文件。否则返回304 (not modified),非必须
  1657. * @param {String} params.ResponseContentType 设置返回头部中的 Content-Type 参数,非必须
  1658. * @param {String} params.ResponseContentLanguage 设置返回头部中的 Content-Language 参数,非必须
  1659. * @param {String} params.ResponseExpires 设置返回头部中的 Content-Expires 参数,非必须
  1660. * @param {String} params.ResponseCacheControl 设置返回头部中的 Cache-Control 参数,非必须
  1661. * @param {String} params.ResponseContentDisposition 设置返回头部中的 Content-Disposition 参数,非必须
  1662. * @param {String} params.ResponseContentEncoding 设置返回头部中的 Content-Encoding 参数,非必须
  1663. * @param {Function} callback 回调函数,必须
  1664. * @param {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  1665. * @param {Object} data 为对应的 object 数据,包括 body 和 headers
  1666. */
  1667. function getObject(params, callback) {
  1668. var reqParams = params.Query || {};
  1669. var reqParamsStr = params.QueryString || '';
  1670. reqParams['response-content-type'] = params['ResponseContentType'];
  1671. reqParams['response-content-language'] = params['ResponseContentLanguage'];
  1672. reqParams['response-expires'] = params['ResponseExpires'];
  1673. reqParams['response-cache-control'] = params['ResponseCacheControl'];
  1674. reqParams['response-content-disposition'] = params['ResponseContentDisposition'];
  1675. reqParams['response-content-encoding'] = params['ResponseContentEncoding'];
  1676. // 如果用户自己传入了 output
  1677. submitRequest.call(this, {
  1678. Action: 'name/cos:GetObject',
  1679. method: 'GET',
  1680. Bucket: params.Bucket,
  1681. Region: params.Region,
  1682. Key: params.Key,
  1683. VersionId: params.VersionId,
  1684. headers: params.Headers,
  1685. qs: reqParams,
  1686. qsStr: reqParamsStr,
  1687. rawBody: true,
  1688. }, function (err, data) {
  1689. if (err) {
  1690. var statusCode = err.statusCode;
  1691. if (params.Headers['If-Modified-Since'] && statusCode && statusCode === 304) {
  1692. return callback(null, {
  1693. NotModified: true
  1694. });
  1695. }
  1696. return callback(err);
  1697. }
  1698. callback(null, {
  1699. Body: data.body,
  1700. ETag: util.attr(data.headers, 'etag', ''),
  1701. statusCode: data.statusCode,
  1702. headers: data.headers,
  1703. });
  1704. });
  1705. }
  1706. /**
  1707. * 上传 object
  1708. * @param {Object} params 参数对象,必须
  1709. * @param {String} params.Bucket Bucket名称,必须
  1710. * @param {String} params.Region 地域名称,必须
  1711. * @param {String} params.Key 文件名称,必须
  1712. * @param {String} params.Body 上传文件的内容,只支持字符串
  1713. * @param {String} params.CacheControl RFC 2616 中定义的缓存策略,将作为 Object 元数据保存,非必须
  1714. * @param {String} params.ContentDisposition RFC 2616 中定义的文件名称,将作为 Object 元数据保存,非必须
  1715. * @param {String} params.ContentEncoding RFC 2616 中定义的编码格式,将作为 Object 元数据保存,非必须
  1716. * @param {String} params.ContentLength RFC 2616 中定义的 HTTP 请求内容长度(字节),必须
  1717. * @param {String} params.ContentType RFC 2616 中定义的内容类型(MIME),将作为 Object 元数据保存,非必须
  1718. * @param {String} params.Expect 当使用 Expect: 100-continue 时,在收到服务端确认后,才会发送请求内容,非必须
  1719. * @param {String} params.Expires RFC 2616 中定义的过期时间,将作为 Object 元数据保存,非必须
  1720. * @param {String} params.ContentSha1 RFC 3174 中定义的 160-bit 内容 SHA-1 算法校验,非必须
  1721. * @param {String} params.ACL 允许用户自定义文件权限,有效值:private | public-read,非必须
  1722. * @param {String} params.GrantRead 赋予被授权者读的权限,格式 x-cos-grant-read: uin=" ",uin=" ",非必须
  1723. * @param {String} params.GrantWrite 赋予被授权者写的权限,格式 x-cos-grant-write: uin=" ",uin=" ",非必须
  1724. * @param {String} params.GrantFullControl 赋予被授权者读写权限,格式 x-cos-grant-full-control: uin=" ",uin=" ",非必须
  1725. * @param {String} params.ServerSideEncryption 支持按照指定的加密算法进行服务端数据加密,格式 x-cos-server-side-encryption: "AES256",非必须
  1726. * @param {Function} params.onProgress 上传进度回调函数
  1727. * @param {Function} callback 回调函数,必须
  1728. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  1729. * @return {Object} data 为对应的 object 数据
  1730. * @return {String} data.ETag 为对应上传文件的 ETag 值
  1731. */
  1732. function putObject(params, callback) {
  1733. var self = this;
  1734. var FileSize = params.ContentLength;
  1735. var onProgress = util.throttleOnProgress.call(self, FileSize, params.onProgress);
  1736. // 特殊处理 Cache-Control、Content-Type,避免代理更改这两个字段导致写入到 Object 属性里
  1737. var headers = params.Headers;
  1738. if (!headers['Cache-Control'] && !headers['cache-control']) headers['Cache-Control'] = '';
  1739. if (!headers['Content-Type'] && !headers['content-type']) headers['Content-Type'] = mime.getType(params.Key) || 'application/octet-stream';
  1740. util.getBodyMd5(self.options.UploadCheckContentMd5, params.Body, function (md5) {
  1741. if (md5) headers['Content-MD5'] = util.binaryBase64(md5);
  1742. if (params.ContentLength !== undefined) headers['Content-Length'] = params.ContentLength;
  1743. onProgress(null, true); // 任务状态开始 uploading
  1744. submitRequest.call(self, {
  1745. Action: 'name/cos:PutObject',
  1746. TaskId: params.TaskId,
  1747. method: 'PUT',
  1748. Bucket: params.Bucket,
  1749. Region: params.Region,
  1750. Key: params.Key,
  1751. headers: params.Headers,
  1752. qs: params.Query,
  1753. body: params.Body,
  1754. onProgress: onProgress,
  1755. }, function (err, data) {
  1756. if (err) {
  1757. onProgress(null, true);
  1758. return callback(err);
  1759. }
  1760. onProgress({loaded: FileSize, total: FileSize}, true);
  1761. var url = getUrl({
  1762. ForcePathStyle: self.options.ForcePathStyle,
  1763. protocol: self.options.Protocol,
  1764. domain: self.options.Domain,
  1765. bucket: params.Bucket,
  1766. region: !self.options.UseAccelerate ? params.Region : 'accelerate',
  1767. object: params.Key,
  1768. });
  1769. url = url.substr(url.indexOf('://') + 3);
  1770. data.Location = url;
  1771. data.ETag = util.attr(data.headers, 'etag', '');
  1772. callback(null, data);
  1773. });
  1774. });
  1775. }
  1776. /**
  1777. * 上传 object
  1778. * @param {Object} params 参数对象,必须
  1779. * @param {String} params.Bucket Bucket名称,必须
  1780. * @param {String} params.Region 地域名称,必须
  1781. * @param {String} params.Key 文件名称,必须
  1782. * @param {FilePath} params.FilePath 要上传的文件路径
  1783. * @param {Function} params.onProgress 上传进度回调函数
  1784. * @param {Function} callback 回调函数,必须
  1785. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  1786. * @return {Object} data 为对应的 object 数据
  1787. * @return {String} data.ETag 为对应上传文件的 ETag 值
  1788. */
  1789. function postObject(params, callback) {
  1790. var self = this;
  1791. var headers = {};
  1792. var filePath = params.FilePath;
  1793. if (!filePath) {
  1794. callback({error: 'missing param FilePath'});
  1795. return;
  1796. }
  1797. headers['Cache-Control'] = params['CacheControl'];
  1798. headers['Content-Disposition'] = params['ContentDisposition'];
  1799. headers['Content-Encoding'] = params['ContentEncoding'];
  1800. headers['Content-MD5'] = params['ContentMD5'];
  1801. headers['Content-Length'] = params['ContentLength'];
  1802. headers['Content-Type'] = params['ContentType'];
  1803. headers['Expect'] = params['Expect'];
  1804. headers['Expires'] = params['Expires'];
  1805. headers['x-cos-acl'] = params['ACL'];
  1806. headers['x-cos-grant-read'] = params['GrantRead'];
  1807. headers['x-cos-grant-write'] = params['GrantWrite'];
  1808. headers['x-cos-grant-full-control'] = params['GrantFullControl'];
  1809. headers['x-cos-storage-class'] = params['StorageClass'];
  1810. headers['x-cos-mime-limit'] = params['MimeLimit'];
  1811. headers['x-cos-traffic-limit'] = params['TrafficLimit'];
  1812. // SSE-C
  1813. headers['x-cos-server-side-encryption-customer-algorithm'] = params['SSECustomerAlgorithm'];
  1814. headers['x-cos-server-side-encryption-customer-key'] = params['SSECustomerKey'];
  1815. headers['x-cos-server-side-encryption-customer-key-MD5'] = params['SSECustomerKeyMD5'];
  1816. // SSE-COS、SSE-KMS
  1817. headers['x-cos-server-side-encryption'] = params['ServerSideEncryption'];
  1818. headers['x-cos-server-side-encryption-cos-kms-key-id'] = params['SSEKMSKeyId'];
  1819. headers['x-cos-server-side-encryption-context'] = params['SSEContext'];
  1820. // 删除 Content-Length 避免签名错误
  1821. delete headers['Content-Length'];
  1822. delete headers['content-length'];
  1823. for (var key in params) {
  1824. if (key.indexOf('x-cos-meta-') > -1) {
  1825. headers[key] = params[key];
  1826. }
  1827. }
  1828. var onProgress = util.throttleOnProgress.call(self, headers['Content-Length'], params.onProgress);
  1829. submitRequest.call(this, {
  1830. Action: 'name/cos:PostObject',
  1831. method: 'POST',
  1832. Bucket: params.Bucket,
  1833. Region: params.Region,
  1834. Key: params.Key,
  1835. headers: headers,
  1836. qs: params.Query,
  1837. filePath: filePath,
  1838. TaskId: params.TaskId,
  1839. onProgress: onProgress,
  1840. }, function (err, data) {
  1841. onProgress(null, true);
  1842. if (err) return callback(err);
  1843. if (data && data.headers) {
  1844. var headers = data.headers;
  1845. var ETag = headers.etag || headers.Etag || headers.ETag || '';
  1846. var filename = filePath.substr(filePath.lastIndexOf('/') + 1);
  1847. var url = getUrl({
  1848. ForcePathStyle: self.options.ForcePathStyle,
  1849. protocol: self.options.Protocol,
  1850. domain: self.options.Domain,
  1851. bucket: params.Bucket,
  1852. region: params.Region,
  1853. object: params.Key.replace(/\$\{filename\}/g, filename),
  1854. isLocation: true,
  1855. });
  1856. return callback(null, {
  1857. Location: url,
  1858. statusCode: data.statusCode,
  1859. headers: headers,
  1860. ETag: ETag,
  1861. });
  1862. }
  1863. callback(null, data);
  1864. });
  1865. }
  1866. /**
  1867. * 删除 object
  1868. * @param {Object} params 参数对象,必须
  1869. * @param {String} params.Bucket Bucket名称,必须
  1870. * @param {String} params.Region 地域名称,必须
  1871. * @param {String} params.Key object名称,必须
  1872. * @param {Function} callback 回调函数,必须
  1873. * @param {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  1874. * @param {Object} data 删除操作成功之后返回的数据
  1875. */
  1876. function deleteObject(params, callback) {
  1877. submitRequest.call(this, {
  1878. Action: 'name/cos:DeleteObject',
  1879. method: 'DELETE',
  1880. Bucket: params.Bucket,
  1881. Region: params.Region,
  1882. Key: params.Key,
  1883. headers: params.Headers,
  1884. VersionId: params.VersionId,
  1885. }, function (err, data) {
  1886. if (err) {
  1887. var statusCode = err.statusCode;
  1888. if (statusCode && statusCode === 204) {
  1889. return callback(null, {statusCode: statusCode});
  1890. } else if (statusCode && statusCode === 404) {
  1891. return callback(null, {BucketNotFound: true, statusCode: statusCode,});
  1892. } else {
  1893. return callback(err);
  1894. }
  1895. }
  1896. callback(null, {
  1897. statusCode: data.statusCode,
  1898. headers: data.headers,
  1899. });
  1900. });
  1901. }
  1902. /**
  1903. * 获取 object 的 权限列表
  1904. * @param {Object} params 参数对象,必须
  1905. * @param {String} params.Bucket Bucket名称,必须
  1906. * @param {String} params.Region 地域名称,必须
  1907. * @param {String} params.Key object名称,必须
  1908. * @param {Function} callback 回调函数,必须
  1909. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  1910. * @return {Object} data 返回的数据
  1911. * @return {Object} data.AccessControlPolicy 权限列表
  1912. */
  1913. function getObjectAcl(params, callback) {
  1914. submitRequest.call(this, {
  1915. Action: 'name/cos:GetObjectACL',
  1916. method: 'GET',
  1917. Bucket: params.Bucket,
  1918. Region: params.Region,
  1919. Key: params.Key,
  1920. headers: params.Headers,
  1921. action: 'acl',
  1922. }, function (err, data) {
  1923. if (err) return callback(err);
  1924. var AccessControlPolicy = data.AccessControlPolicy || {};
  1925. var Owner = AccessControlPolicy.Owner || {};
  1926. var Grant = AccessControlPolicy.AccessControlList && AccessControlPolicy.AccessControlList.Grant || [];
  1927. Grant = util.isArray(Grant) ? Grant : [Grant];
  1928. var result = decodeAcl(AccessControlPolicy);
  1929. if (data.headers && data.headers['x-cos-acl']) {
  1930. result.ACL = data.headers['x-cos-acl'];
  1931. }
  1932. result = util.extend(result, {
  1933. Owner: Owner,
  1934. Grants: Grant,
  1935. statusCode: data.statusCode,
  1936. headers: data.headers,
  1937. });
  1938. callback(null, result);
  1939. });
  1940. }
  1941. /**
  1942. * 设置 object 的 权限列表
  1943. * @param {Object} params 参数对象,必须
  1944. * @param {String} params.Bucket Bucket名称,必须
  1945. * @param {String} params.Region 地域名称,必须
  1946. * @param {String} params.Key object名称,必须
  1947. * @param {Function} callback 回调函数,必须
  1948. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  1949. * @return {Object} data 返回的数据
  1950. */
  1951. function putObjectAcl(params, callback) {
  1952. var headers = params.Headers;
  1953. var xml = '';
  1954. if (params['AccessControlPolicy']) {
  1955. var AccessControlPolicy = util.clone(params['AccessControlPolicy'] || {});
  1956. var Grants = AccessControlPolicy.Grants || AccessControlPolicy.Grant;
  1957. Grants = util.isArray(Grants) ? Grants : [Grants];
  1958. delete AccessControlPolicy.Grant;
  1959. delete AccessControlPolicy.Grants;
  1960. AccessControlPolicy.AccessControlList = {Grant: Grants};
  1961. xml = util.json2xml({AccessControlPolicy: AccessControlPolicy});
  1962. headers['Content-Type'] = 'application/xml';
  1963. headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
  1964. }
  1965. // Grant Header 去重
  1966. util.each(headers, function (val, key) {
  1967. if (key.indexOf('x-cos-grant-') === 0) {
  1968. headers[key] = uniqGrant(headers[key]);
  1969. }
  1970. });
  1971. submitRequest.call(this, {
  1972. Action: 'name/cos:PutObjectACL',
  1973. method: 'PUT',
  1974. Bucket: params.Bucket,
  1975. Region: params.Region,
  1976. Key: params.Key,
  1977. action: 'acl',
  1978. headers: headers,
  1979. body: xml,
  1980. }, function (err, data) {
  1981. if (err) return callback(err);
  1982. callback(null, {
  1983. statusCode: data.statusCode,
  1984. headers: data.headers,
  1985. });
  1986. });
  1987. }
  1988. /**
  1989. * Options Object请求实现跨域访问的预请求。即发出一个 OPTIONS 请求给服务器以确认是否可以进行跨域操作。
  1990. * @param {Object} params 参数对象,必须
  1991. * @param {String} params.Bucket Bucket名称,必须
  1992. * @param {String} params.Region 地域名称,必须
  1993. * @param {String} params.Key object名称,必须
  1994. * @param {Function} callback 回调函数,必须
  1995. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  1996. * @return {Object} data 返回的数据
  1997. */
  1998. function optionsObject(params, callback) {
  1999. var headers = params.Headers;
  2000. headers['Origin'] = params['Origin'];
  2001. headers['Access-Control-Request-Method'] = params['AccessControlRequestMethod'];
  2002. headers['Access-Control-Request-Headers'] = params['AccessControlRequestHeaders'];
  2003. submitRequest.call(this, {
  2004. Action: 'name/cos:OptionsObject',
  2005. method: 'OPTIONS',
  2006. Bucket: params.Bucket,
  2007. Region: params.Region,
  2008. Key: params.Key,
  2009. headers: headers,
  2010. }, function (err, data) {
  2011. if (err) {
  2012. if (err.statusCode && err.statusCode === 403) {
  2013. return callback(null, {
  2014. OptionsForbidden: true,
  2015. statusCode: err.statusCode
  2016. });
  2017. }
  2018. return callback(err);
  2019. }
  2020. var headers = data.headers || {};
  2021. callback(null, {
  2022. AccessControlAllowOrigin: headers['access-control-allow-origin'],
  2023. AccessControlAllowMethods: headers['access-control-allow-methods'],
  2024. AccessControlAllowHeaders: headers['access-control-allow-headers'],
  2025. AccessControlExposeHeaders: headers['access-control-expose-headers'],
  2026. AccessControlMaxAge: headers['access-control-max-age'],
  2027. statusCode: data.statusCode,
  2028. headers: data.headers,
  2029. });
  2030. });
  2031. }
  2032. /**
  2033. * @param {Object} 参数列表
  2034. * @param {String} Bucket Bucket 名称
  2035. * @param {String} Region 地域名称
  2036. * @param {String} Key 文件名称
  2037. * @param {String} CopySource 源文件URL绝对路径,可以通过versionid子资源指定历史版本
  2038. * @param {String} ACL 允许用户自定义文件权限。有效值:private,public-read默认值:private。
  2039. * @param {String} GrantRead 赋予被授权者读的权限,格式 x-cos-grant-read: uin=" ",uin=" ",当需要给子账户授权时,uin="RootAcountID/SubAccountID",当需要给根账户授权时,uin="RootAcountID"。
  2040. * @param {String} GrantWrite 赋予被授权者写的权限,格式 x-cos-grant-write: uin=" ",uin=" ",当需要给子账户授权时,uin="RootAcountID/SubAccountID",当需要给根账户授权时,uin="RootAcountID"。
  2041. * @param {String} GrantFullControl 赋予被授权者读写权限,格式 x-cos-grant-full-control: uin=" ",uin=" ",当需要给子账户授权时,uin="RootAcountID/SubAccountID",当需要给根账户授权时,uin="RootAcountID"。
  2042. * @param {String} MetadataDirective 是否拷贝元数据,枚举值:Copy, Replaced,默认值Copy。假如标记为Copy,忽略Header中的用户元数据信息直接复制;假如标记为Replaced,按Header信息修改元数据。当目标路径和原路径一致,即用户试图修改元数据时,必须为Replaced
  2043. * @param {String} CopySourceIfModifiedSince 当Object在指定时间后被修改,则执行操作,否则返回412。可与x-cos-copy-source-If-None-Match一起使用,与其他条件联合使用返回冲突。
  2044. * @param {String} CopySourceIfUnmodifiedSince 当Object在指定时间后未被修改,则执行操作,否则返回412。可与x-cos-copy-source-If-Match一起使用,与其他条件联合使用返回冲突。
  2045. * @param {String} CopySourceIfMatch 当Object的ETag和给定一致时,则执行操作,否则返回412。可与x-cos-copy-source-If-Unmodified-Since一起使用,与其他条件联合使用返回冲突。
  2046. * @param {String} CopySourceIfNoneMatch 当Object的ETag和给定不一致时,则执行操作,否则返回412。可与x-cos-copy-source-If-Modified-Since一起使用,与其他条件联合使用返回冲突。
  2047. * @param {String} StorageClass 存储级别,枚举值:存储级别,枚举值:Standard, Standard_IA,Archive;默认值:Standard
  2048. * @param {String} CacheControl 指定所有缓存机制在整个请求/响应链中必须服从的指令。
  2049. * @param {String} ContentDisposition MIME 协议的扩展,MIME 协议指示 MIME 用户代理如何显示附加的文件
  2050. * @param {String} ContentEncoding HTTP 中用来对「采用何种编码格式传输正文」进行协定的一对头部字段
  2051. * @param {String} ContentLength 设置响应消息的实体内容的大小,单位为字节
  2052. * @param {String} ContentType RFC 2616 中定义的 HTTP 请求内容类型(MIME),例如text/plain
  2053. * @param {String} Expect 请求的特定的服务器行为
  2054. * @param {String} Expires 响应过期的日期和时间
  2055. * @param {String} params.ServerSideEncryption 支持按照指定的加密算法进行服务端数据加密,格式 x-cos-server-side-encryption: "AES256",非必须
  2056. * @param {String} ContentLanguage 指定内容语言
  2057. * @param {String} x-cos-meta-* 允许用户自定义的头部信息,将作为 Object 元数据返回。大小限制2K。
  2058. */
  2059. function putObjectCopy(params, callback) {
  2060. // 特殊处理 Cache-Control
  2061. var headers = params.Headers;
  2062. if (!headers['Cache-Control'] && !!headers['cache-control']) headers['Cache-Control'] = '';
  2063. var CopySource = params.CopySource || '';
  2064. var m = CopySource.match(/^([^.]+-\d+)\.cos(v6)?\.([^.]+)\.[^/]+\/(.+)$/);
  2065. if (!m) {
  2066. callback({error: 'CopySource format error'});
  2067. return;
  2068. }
  2069. var SourceBucket = m[1];
  2070. var SourceRegion = m[3];
  2071. var SourceKey = decodeURIComponent(m[4]);
  2072. submitRequest.call(this, {
  2073. Scope: [{
  2074. action: 'name/cos:GetObject',
  2075. bucket: SourceBucket,
  2076. region: SourceRegion,
  2077. prefix: SourceKey,
  2078. }, {
  2079. action: 'name/cos:PutObject',
  2080. bucket: params.Bucket,
  2081. region: params.Region,
  2082. prefix: params.Key,
  2083. }],
  2084. method: 'PUT',
  2085. Bucket: params.Bucket,
  2086. Region: params.Region,
  2087. Key: params.Key,
  2088. VersionId: params.VersionId,
  2089. headers: params.Headers,
  2090. }, function (err, data) {
  2091. if (err) return callback(err);
  2092. var result = util.clone(data.CopyObjectResult || {});
  2093. util.extend(result, {
  2094. statusCode: data.statusCode,
  2095. headers: data.headers,
  2096. });
  2097. callback(null, result);
  2098. });
  2099. }
  2100. function uploadPartCopy(params, callback) {
  2101. var CopySource = params.CopySource || '';
  2102. var m = CopySource.match(/^([^.]+-\d+)\.cos(v6)?\.([^.]+)\.[^/]+\/(.+)$/);
  2103. if (!m) {
  2104. callback({error: 'CopySource format error'});
  2105. return;
  2106. }
  2107. var SourceBucket = m[1];
  2108. var SourceRegion = m[3];
  2109. var SourceKey = decodeURIComponent(m[4]);
  2110. submitRequest.call(this, {
  2111. Scope: [{
  2112. action: 'name/cos:GetObject',
  2113. bucket: SourceBucket,
  2114. region: SourceRegion,
  2115. prefix: SourceKey,
  2116. }, {
  2117. action: 'name/cos:PutObject',
  2118. bucket: params.Bucket,
  2119. region: params.Region,
  2120. prefix: params.Key,
  2121. }],
  2122. method: 'PUT',
  2123. Bucket: params.Bucket,
  2124. Region: params.Region,
  2125. Key: params.Key,
  2126. VersionId: params.VersionId,
  2127. qs: {
  2128. partNumber: params['PartNumber'],
  2129. uploadId: params['UploadId'],
  2130. },
  2131. headers: params.Headers,
  2132. }, function (err, data) {
  2133. if (err) return callback(err);
  2134. var result = util.clone(data.CopyPartResult || {});
  2135. util.extend(result, {
  2136. statusCode: data.statusCode,
  2137. headers: data.headers,
  2138. });
  2139. callback(null, result);
  2140. });
  2141. }
  2142. function deleteMultipleObject(params, callback) {
  2143. var Objects = params.Objects || [];
  2144. var Quiet = params.Quiet;
  2145. Objects = util.isArray(Objects) ? Objects : [Objects];
  2146. var xml = util.json2xml({Delete: {Object: Objects, Quiet: Quiet || false}});
  2147. var headers = params.Headers;
  2148. headers['Content-Type'] = 'application/xml';
  2149. headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
  2150. var Scope = util.map(Objects, function (v) {
  2151. return {
  2152. action: 'name/cos:DeleteObject',
  2153. bucket: params.Bucket,
  2154. region: params.Region,
  2155. prefix: v.Key,
  2156. };
  2157. });
  2158. submitRequest.call(this, {
  2159. Scope: Scope,
  2160. method: 'POST',
  2161. Bucket: params.Bucket,
  2162. Region: params.Region,
  2163. body: xml,
  2164. action: 'delete',
  2165. headers: headers,
  2166. }, function (err, data) {
  2167. if (err) return callback(err);
  2168. var DeleteResult = data.DeleteResult || {};
  2169. var Deleted = DeleteResult.Deleted || [];
  2170. var Errors = DeleteResult.Error || [];
  2171. Deleted = util.isArray(Deleted) ? Deleted : [Deleted];
  2172. Errors = util.isArray(Errors) ? Errors : [Errors];
  2173. var result = util.clone(DeleteResult);
  2174. util.extend(result, {
  2175. Error: Errors,
  2176. Deleted: Deleted,
  2177. statusCode: data.statusCode,
  2178. headers: data.headers,
  2179. });
  2180. callback(null, result);
  2181. });
  2182. }
  2183. function restoreObject(params, callback) {
  2184. var headers = params.Headers;
  2185. if (!params['RestoreRequest']) {
  2186. callback({error: 'missing param RestoreRequest'});
  2187. return;
  2188. }
  2189. var RestoreRequest = params.RestoreRequest || {};
  2190. var xml = util.json2xml({RestoreRequest: RestoreRequest});
  2191. headers['Content-Type'] = 'application/xml';
  2192. headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
  2193. submitRequest.call(this, {
  2194. Action: 'name/cos:RestoreObject',
  2195. method: 'POST',
  2196. Bucket: params.Bucket,
  2197. Region: params.Region,
  2198. Key: params.Key,
  2199. VersionId: params.VersionId,
  2200. body: xml,
  2201. action: 'restore',
  2202. headers: headers,
  2203. }, function (err, data) {
  2204. callback(err, data);
  2205. });
  2206. }
  2207. /**
  2208. * 设置 Object 的标签
  2209. * @param {Object} params 参数对象,必须
  2210. * @param {String} params.Bucket Object名称,必须
  2211. * @param {String} params.Region 地域名称,必须
  2212. * @param {Array} params.TagSet 标签设置,必须
  2213. * @param {Function} callback 回调函数,必须
  2214. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/42998
  2215. * @return {Object} data 返回数据
  2216. */
  2217. function putObjectTagging(params, callback) {
  2218. var Tagging = params['Tagging'] || {};
  2219. var Tags = Tagging.TagSet || Tagging.Tags || params['Tags'] || [];
  2220. Tags = util.clone(util.isArray(Tags) ? Tags : [Tags]);
  2221. var xml = util.json2xml({Tagging: {TagSet: {Tag: Tags}}});
  2222. var headers = params.Headers;
  2223. headers['Content-Type'] = 'application/xml';
  2224. headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
  2225. submitRequest.call(this, {
  2226. Interface: 'putObjectTagging',
  2227. Action: 'name/cos:PutObjectTagging',
  2228. method: 'PUT',
  2229. Bucket: params.Bucket,
  2230. Key: params.Key,
  2231. Region: params.Region,
  2232. body: xml,
  2233. action: 'tagging',
  2234. headers: headers,
  2235. VersionId: params.VersionId,
  2236. }, function (err, data) {
  2237. if (err && err.statusCode === 204) {
  2238. return callback(null, {statusCode: err.statusCode});
  2239. } else if (err) {
  2240. return callback(err);
  2241. }
  2242. callback(null, {
  2243. statusCode: data.statusCode,
  2244. headers: data.headers,
  2245. });
  2246. });
  2247. }
  2248. /**
  2249. * 获取 Object 的标签设置
  2250. * @param {Object} params 参数对象,必须
  2251. * @param {String} params.Bucket Bucket名称,必须
  2252. * @param {String} params.Region 地域名称,必须
  2253. * @param {Function} callback 回调函数,必须
  2254. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/42998
  2255. * @return {Object} data 返回数据
  2256. */
  2257. function getObjectTagging(params, callback) {
  2258. submitRequest.call(this, {
  2259. Interface: 'getObjectTagging',
  2260. Action: 'name/cos:GetObjectTagging',
  2261. method: 'GET',
  2262. Key: params.Key,
  2263. Bucket: params.Bucket,
  2264. Region: params.Region,
  2265. headers: params.Headers,
  2266. action: 'tagging',
  2267. VersionId: params.VersionId,
  2268. }, function (err, data) {
  2269. if (err) {
  2270. if (err.statusCode === 404 && err.error && (err.error === "Not Found" || err.error.Code === 'NoSuchTagSet')) {
  2271. var result = {
  2272. Tags: [],
  2273. statusCode: err.statusCode,
  2274. };
  2275. err.headers && (result.headers = err.headers);
  2276. callback(null, result);
  2277. } else {
  2278. callback(err);
  2279. }
  2280. return;
  2281. }
  2282. var Tags = [];
  2283. try {
  2284. Tags = data.Tagging.TagSet.Tag || [];
  2285. } catch (e) {
  2286. }
  2287. Tags = util.clone(util.isArray(Tags) ? Tags : [Tags]);
  2288. callback(null, {
  2289. Tags: Tags,
  2290. statusCode: data.statusCode,
  2291. headers: data.headers,
  2292. });
  2293. });
  2294. }
  2295. /**
  2296. * 删除 Object 的 标签设置
  2297. * @param {Object} params 参数对象,必须
  2298. * @param {String} params.Bucket Object名称,必须
  2299. * @param {String} params.Region 地域名称,必须
  2300. * @param {Function} callback 回调函数,必须
  2301. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/42998
  2302. * @return {Object} data 返回的数据
  2303. */
  2304. function deleteObjectTagging(params, callback) {
  2305. submitRequest.call(this, {
  2306. Interface: 'deleteObjectTagging',
  2307. Action: 'name/cos:DeleteObjectTagging',
  2308. method: 'DELETE',
  2309. Bucket: params.Bucket,
  2310. Region: params.Region,
  2311. Key: params.Key,
  2312. headers: params.Headers,
  2313. action: 'tagging',
  2314. VersionId: params.VersionId,
  2315. }, function (err, data) {
  2316. if (err && err.statusCode === 204) {
  2317. return callback(null, {statusCode: err.statusCode});
  2318. } else if (err) {
  2319. return callback(err);
  2320. }
  2321. callback(null, {
  2322. statusCode: data.statusCode,
  2323. headers: data.headers,
  2324. });
  2325. });
  2326. }
  2327. // 分块上传
  2328. /**
  2329. * 初始化分块上传
  2330. * @param {Object} params 参数对象,必须
  2331. * @param {String} params.Bucket Bucket名称,必须
  2332. * @param {String} params.Region 地域名称,必须
  2333. * @param {String} params.Key object名称,必须
  2334. * @param {String} params.UploadId object名称,必须
  2335. * @param {String} params.CacheControl RFC 2616 中定义的缓存策略,将作为 Object 元数据保存,非必须
  2336. * @param {String} params.ContentDisposition RFC 2616 中定义的文件名称,将作为 Object 元数据保存 ,非必须
  2337. * @param {String} params.ContentEncoding RFC 2616 中定义的编码格式,将作为 Object 元数据保存,非必须
  2338. * @param {String} params.ContentType RFC 2616 中定义的内容类型(MIME),将作为 Object 元数据保存,非必须
  2339. * @param {String} params.Expires RFC 2616 中定义的过期时间,将作为 Object 元数据保存,非必须
  2340. * @param {String} params.ACL 允许用户自定义文件权限,非必须
  2341. * @param {String} params.GrantRead 赋予被授权者读的权限 ,非必须
  2342. * @param {String} params.GrantWrite 赋予被授权者写的权限 ,非必须
  2343. * @param {String} params.GrantFullControl 赋予被授权者读写权限 ,非必须
  2344. * @param {String} params.StorageClass 设置Object的存储级别,枚举值:Standard,Standard_IA,Archive,非必须
  2345. * @param {String} params.ServerSideEncryption 支持按照指定的加密算法进行服务端数据加密,格式 x-cos-server-side-encryption: "AES256",非必须
  2346. * @param {Function} callback 回调函数,必须
  2347. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  2348. * @return {Object} data 返回的数据
  2349. */
  2350. function multipartInit(params, callback) {
  2351. var self = this;
  2352. var headers = params.Headers;
  2353. // 特殊处理 Cache-Control、Content-Type
  2354. if (!headers['Cache-Control'] && !headers['cache-control']) headers['Cache-Control'] = '';
  2355. if (!headers['Content-Type'] && !headers['content-type']) headers['Content-Type'] = mime.getType(params.Key) || 'application/octet-stream';
  2356. submitRequest.call(self, {
  2357. Action: 'name/cos:InitiateMultipartUpload',
  2358. method: 'POST',
  2359. Bucket: params.Bucket,
  2360. Region: params.Region,
  2361. Key: params.Key,
  2362. action: 'uploads',
  2363. headers: params.Headers,
  2364. qs: params.Query,
  2365. }, function (err, data) {
  2366. if (err) return callback(err);
  2367. data = util.clone(data || {});
  2368. if (data && data.InitiateMultipartUploadResult) {
  2369. return callback(null, util.extend(data.InitiateMultipartUploadResult, {
  2370. statusCode: data.statusCode,
  2371. headers: data.headers,
  2372. }));
  2373. }
  2374. callback(null, data);
  2375. });
  2376. }
  2377. /**
  2378. * 分块上传
  2379. * @param {Object} params 参数对象,必须
  2380. * @param {String} params.Bucket Bucket名称,必须
  2381. * @param {String} params.Region 地域名称,必须
  2382. * @param {String} params.Key object名称,必须
  2383. * @param {String} params.Body 上传文件对象或字符串
  2384. * @param {String} params.ContentLength RFC 2616 中定义的 HTTP 请求内容长度(字节),非必须
  2385. * @param {String} params.Expect 当使用 Expect: 100-continue 时,在收到服务端确认后,才会发送请求内容,非必须
  2386. * @param {String} params.ServerSideEncryption 支持按照指定的加密算法进行服务端数据加密,格式 x-cos-server-side-encryption: "AES256",非必须
  2387. * @param {String} params.ContentSha1 RFC 3174 中定义的 160-bit 内容 SHA-1 算法校验值,非必须
  2388. * @param {Function} callback 回调函数,必须
  2389. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  2390. * @return {Object} data 返回的数据
  2391. * @return {Object} data.ETag 返回的文件分块 sha1 值
  2392. */
  2393. function multipartUpload(params, callback) {
  2394. var self = this;
  2395. util.getFileSize('multipartUpload', params, function () {
  2396. util.getBodyMd5(self.options.UploadCheckContentMd5, params.Body, function (md5) {
  2397. if (md5) params.Headers['Content-MD5'] = util.binaryBase64(md5);
  2398. submitRequest.call(self, {
  2399. Action: 'name/cos:UploadPart',
  2400. TaskId: params.TaskId,
  2401. method: 'PUT',
  2402. Bucket: params.Bucket,
  2403. Region: params.Region,
  2404. Key: params.Key,
  2405. qs: {
  2406. partNumber: params['PartNumber'],
  2407. uploadId: params['UploadId'],
  2408. },
  2409. headers: params.Headers,
  2410. onProgress: params.onProgress,
  2411. body: params.Body || null
  2412. }, function (err, data) {
  2413. if (err) return callback(err);
  2414. callback(null, {
  2415. ETag: util.attr(data.headers, 'etag', {}),
  2416. statusCode: data.statusCode,
  2417. headers: data.headers,
  2418. });
  2419. });
  2420. });
  2421. });
  2422. }
  2423. /**
  2424. * 完成分块上传
  2425. * @param {Object} params 参数对象,必须
  2426. * @param {String} params.Bucket Bucket名称,必须
  2427. * @param {String} params.Region 地域名称,必须
  2428. * @param {String} params.Key object名称,必须
  2429. * @param {Array} params.Parts 分块信息列表,必须
  2430. * @param {String} params.Parts[i].PartNumber 块编号,必须
  2431. * @param {String} params.Parts[i].ETag 分块的 sha1 校验值
  2432. * @param {Function} callback 回调函数,必须
  2433. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  2434. * @return {Object} data 返回的数据
  2435. * @return {Object} data.CompleteMultipartUpload 完成分块上传后的文件信息,包括Location, Bucket, Key 和 ETag
  2436. */
  2437. function multipartComplete(params, callback) {
  2438. var self = this;
  2439. var UploadId = params.UploadId;
  2440. var Parts = params['Parts'];
  2441. for (var i = 0, len = Parts.length; i < len; i++) {
  2442. if (Parts[i]['ETag'].indexOf('"') === 0) {
  2443. continue;
  2444. }
  2445. Parts[i]['ETag'] = '"' + Parts[i]['ETag'] + '"';
  2446. }
  2447. var xml = util.json2xml({CompleteMultipartUpload: {Part: Parts}});
  2448. var headers = params.Headers;
  2449. headers['Content-Type'] = 'application/xml';
  2450. headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
  2451. submitRequest.call(this, {
  2452. Action: 'name/cos:CompleteMultipartUpload',
  2453. method: 'POST',
  2454. Bucket: params.Bucket,
  2455. Region: params.Region,
  2456. Key: params.Key,
  2457. qs: {
  2458. uploadId: UploadId
  2459. },
  2460. body: xml,
  2461. headers: headers,
  2462. }, function (err, data) {
  2463. if (err) return callback(err);
  2464. var url = getUrl({
  2465. ForcePathStyle: self.options.ForcePathStyle,
  2466. protocol: self.options.Protocol,
  2467. domain: self.options.Domain,
  2468. bucket: params.Bucket,
  2469. region: params.Region,
  2470. object: params.Key,
  2471. isLocation: true,
  2472. });
  2473. var CompleteMultipartUploadResult = data.CompleteMultipartUploadResult || {};
  2474. var result = util.extend(CompleteMultipartUploadResult, {
  2475. Location: url,
  2476. statusCode: data.statusCode,
  2477. headers: data.headers,
  2478. });
  2479. callback(null, result);
  2480. });
  2481. }
  2482. /**
  2483. * 分块上传任务列表查询
  2484. * @param {Object} params 参数对象,必须
  2485. * @param {String} params.Bucket Bucket名称,必须
  2486. * @param {String} params.Region 地域名称,必须
  2487. * @param {String} params.Delimiter 定界符为一个符号,如果有Prefix,则将Prefix到delimiter之间的相同路径归为一类,定义为Common Prefix,然后列出所有Common Prefix。如果没有Prefix,则从路径起点开始,非必须
  2488. * @param {String} params.EncodingType 规定返回值的编码方式,非必须
  2489. * @param {String} params.Prefix 前缀匹配,用来规定返回的文件前缀地址,非必须
  2490. * @param {String} params.MaxUploads 单次返回最大的条目数量,默认1000,非必须
  2491. * @param {String} params.KeyMarker 与upload-id-marker一起使用 </Br>当upload-id-marker未被指定时,ObjectName字母顺序大于key-marker的条目将被列出 </Br>当upload-id-marker被指定时,ObjectName字母顺序大于key-marker的条目被列出,ObjectName字母顺序等于key-marker同时UploadId大于upload-id-marker的条目将被列出,非必须
  2492. * @param {String} params.UploadIdMarker 与key-marker一起使用 </Br>当key-marker未被指定时,upload-id-marker将被忽略 </Br>当key-marker被指定时,ObjectName字母顺序大于key-marker的条目被列出,ObjectName字母顺序等于key-marker同时UploadId大于upload-id-marker的条目将被列出,非必须
  2493. * @param {Function} callback 回调函数,必须
  2494. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  2495. * @return {Object} data 返回的数据
  2496. * @return {Object} data.ListMultipartUploadsResult 分块上传任务信息
  2497. */
  2498. function multipartList(params, callback) {
  2499. var reqParams = {};
  2500. reqParams['delimiter'] = params['Delimiter'];
  2501. reqParams['encoding-type'] = params['EncodingType'];
  2502. reqParams['prefix'] = params['Prefix'] || '';
  2503. reqParams['max-uploads'] = params['MaxUploads'];
  2504. reqParams['key-marker'] = params['KeyMarker'];
  2505. reqParams['upload-id-marker'] = params['UploadIdMarker'];
  2506. reqParams = util.clearKey(reqParams);
  2507. submitRequest.call(this, {
  2508. Action: 'name/cos:ListMultipartUploads',
  2509. ResourceKey: reqParams['prefix'],
  2510. method: 'GET',
  2511. Bucket: params.Bucket,
  2512. Region: params.Region,
  2513. headers: params.Headers,
  2514. qs: reqParams,
  2515. action: 'uploads',
  2516. }, function (err, data) {
  2517. if (err) return callback(err);
  2518. if (data && data.ListMultipartUploadsResult) {
  2519. var Upload = data.ListMultipartUploadsResult.Upload || [];
  2520. var CommonPrefixes = data.ListMultipartUploadsResult.CommonPrefixes || [];
  2521. CommonPrefixes = util.isArray(CommonPrefixes) ? CommonPrefixes : [CommonPrefixes];
  2522. Upload = util.isArray(Upload) ? Upload : [Upload];
  2523. data.ListMultipartUploadsResult.Upload = Upload;
  2524. data.ListMultipartUploadsResult.CommonPrefixes = CommonPrefixes;
  2525. }
  2526. var result = util.clone(data.ListMultipartUploadsResult || {});
  2527. util.extend(result, {
  2528. statusCode: data.statusCode,
  2529. headers: data.headers,
  2530. });
  2531. callback(null, result);
  2532. });
  2533. }
  2534. /**
  2535. * 上传的分块列表查询
  2536. * @param {Object} params 参数对象,必须
  2537. * @param {String} params.Bucket Bucket名称,必须
  2538. * @param {String} params.Region 地域名称,必须
  2539. * @param {String} params.Key object名称,必须
  2540. * @param {String} params.UploadId 标示本次分块上传的ID,必须
  2541. * @param {String} params.EncodingType 规定返回值的编码方式,非必须
  2542. * @param {String} params.MaxParts 单次返回最大的条目数量,默认1000,非必须
  2543. * @param {String} params.PartNumberMarker 默认以UTF-8二进制顺序列出条目,所有列出条目从marker开始,非必须
  2544. * @param {Function} callback 回调函数,必须
  2545. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  2546. * @return {Object} data 返回的数据
  2547. * @return {Object} data.ListMultipartUploadsResult 分块信息
  2548. */
  2549. function multipartListPart(params, callback) {
  2550. var reqParams = {};
  2551. reqParams['uploadId'] = params['UploadId'];
  2552. reqParams['encoding-type'] = params['EncodingType'];
  2553. reqParams['max-parts'] = params['MaxParts'];
  2554. reqParams['part-number-marker'] = params['PartNumberMarker'];
  2555. submitRequest.call(this, {
  2556. Action: 'name/cos:ListParts',
  2557. method: 'GET',
  2558. Bucket: params.Bucket,
  2559. Region: params.Region,
  2560. Key: params.Key,
  2561. headers: params.Headers,
  2562. qs: reqParams,
  2563. }, function (err, data) {
  2564. if (err) return callback(err);
  2565. var ListPartsResult = data.ListPartsResult || {};
  2566. var Part = ListPartsResult.Part || [];
  2567. Part = util.isArray(Part) ? Part : [Part];
  2568. ListPartsResult.Part = Part;
  2569. var result = util.clone(ListPartsResult);
  2570. util.extend(result, {
  2571. statusCode: data.statusCode,
  2572. headers: data.headers,
  2573. });
  2574. callback(null, result);
  2575. });
  2576. }
  2577. /**
  2578. * 抛弃分块上传
  2579. * @param {Object} params 参数对象,必须
  2580. * @param {String} params.Bucket Bucket名称,必须
  2581. * @param {String} params.Region 地域名称,必须
  2582. * @param {String} params.Key object名称,必须
  2583. * @param {String} params.UploadId 标示本次分块上传的ID,必须
  2584. * @param {Function} callback 回调函数,必须
  2585. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  2586. * @return {Object} data 返回的数据
  2587. */
  2588. function multipartAbort(params, callback) {
  2589. var reqParams = {};
  2590. reqParams['uploadId'] = params['UploadId'];
  2591. submitRequest.call(this, {
  2592. Action: 'name/cos:AbortMultipartUpload',
  2593. method: 'DELETE',
  2594. Bucket: params.Bucket,
  2595. Region: params.Region,
  2596. Key: params.Key,
  2597. headers: params.Headers,
  2598. qs: reqParams,
  2599. }, function (err, data) {
  2600. if (err) return callback(err);
  2601. callback(null, {
  2602. statusCode: data.statusCode,
  2603. headers: data.headers,
  2604. });
  2605. });
  2606. }
  2607. /**
  2608. * 追加上传
  2609. * @param {Object} params 参数对象,必须
  2610. * @param {String} params.Bucket Bucket名称,必须
  2611. * @param {String} params.Region 地域名称,必须
  2612. * @param {String} params.Key object名称,必须
  2613. * @param {String} params.Body 上传文件的内容,只支持字符串
  2614. * @param {Number} params.Position 追加操作的起始点,单位为字节,必须
  2615. * @param {String} params.CacheControl RFC 2616 中定义的缓存策略,将作为 Object 元数据保存,非必须
  2616. * @param {String} params.ContentDisposition RFC 2616 中定义的文件名称,将作为 Object 元数据保存,非必须
  2617. * @param {String} params.ContentEncoding RFC 2616 中定义的编码格式,将作为 Object 元数据保存,非必须
  2618. * @param {String} params.ContentLength RFC 2616 中定义的 HTTP 请求内容长度(字节),必须
  2619. * @param {String} params.ContentType RFC 2616 中定义的内容类型(MIME),将作为 Object 元数据保存,非必须
  2620. * @param {String} params.Expect 当使用 Expect: 100-continue 时,在收到服务端确认后,才会发送请求内容,非必须
  2621. * @param {String} params.Expires RFC 2616 中定义的过期时间,将作为 Object 元数据保存,非必须
  2622. * @param {String} params.ACL 允许用户自定义文件权限,有效值:private | public-read,非必须
  2623. * @param {String} params.GrantRead 赋予被授权者读取对象的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,非必须
  2624. * @param {String} params.GrantReadAcp 赋予被授权者读取对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,非必须
  2625. * @param {String} params.GrantWriteAcp 赋予被授权者写入对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,非必须
  2626. * @param {String} params.GrantFullControl 赋予被授权者操作对象的所有权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,非必须
  2627. * @param {String} params.StorageClass 设置对象的存储级别,枚举值:STANDARD、STANDARD_IA、ARCHIVE,默认值:STANDARD,非必须
  2628. * @param {String} params.x-cos-meta-* 允许用户自定义的头部信息,将作为对象的元数据保存。大小限制2KB,非必须
  2629. * @param {String} params.ContentSha1 RFC 3174 中定义的 160-bit 内容 SHA-1 算法校验,非必须
  2630. * @param {String} params.ServerSideEncryption 支持按照指定的加密算法进行服务端数据加密,格式 x-cos-server-side-encryption: "AES256",非必须
  2631. * @param {Function} callback 回调函数,必须
  2632. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  2633. * @return {Object} data 返回的数据
  2634. */
  2635. function appendObject(params, callback) {
  2636. submitRequest.call(this, {
  2637. Action: 'name/cos:AppendObject',
  2638. method: 'POST',
  2639. Bucket: params.Bucket,
  2640. Region: params.Region,
  2641. action: 'append',
  2642. Key: params.Key,
  2643. body: params.Body,
  2644. qs: {
  2645. position: params.Position
  2646. },
  2647. headers: params.Headers,
  2648. }, function (err, data) {
  2649. if (err) return callback(err);
  2650. callback(null, data);
  2651. });
  2652. }
  2653. /**
  2654. * cos 内置请求
  2655. * @param {Object} params 参数对象,必须
  2656. * @param {String} params.Bucket Bucket名称,必须
  2657. * @param {String} params.Region 地域名称,必须
  2658. * @param {String} params.Key object名称,必须
  2659. * @param {Function} callback 回调函数,必须
  2660. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  2661. * @return {Object} data 返回的数据
  2662. */
  2663. function request(params, callback) {
  2664. submitRequest.call(this, {
  2665. method: params.Method,
  2666. Bucket: params.Bucket,
  2667. Region: params.Region,
  2668. Key: params.Key,
  2669. action: params.Action,
  2670. headers: params.Headers,
  2671. qs: params.Query,
  2672. body: params.Body,
  2673. Url: params.Url,
  2674. rawBody: params.RawBody,
  2675. }, function (err, data) {
  2676. if (err) return callback(err);
  2677. if (data && data.body) {
  2678. data.Body = data.body;
  2679. delete data.body;
  2680. }
  2681. callback(err, data);
  2682. });
  2683. }
  2684. /**
  2685. * 获取签名
  2686. * @param {Object} params 参数对象,必须
  2687. * @param {String} params.Method 请求方法,必须
  2688. * @param {String} params.Key object名称,必须
  2689. * @param {String} params.Expires 名超时时间,单位秒,可选
  2690. * @return {String} data 返回签名字符串
  2691. */
  2692. function getAuth(params) {
  2693. var self = this;
  2694. return util.getAuth({
  2695. SecretId: params.SecretId || this.options.SecretId || '',
  2696. SecretKey: params.SecretKey || this.options.SecretKey || '',
  2697. Bucket: params.Bucket,
  2698. Region: params.Region,
  2699. Method: params.Method,
  2700. Key: params.Key,
  2701. Query: params.Query,
  2702. Headers: params.Headers,
  2703. Expires: params.Expires,
  2704. SystemClockOffset: self.options.SystemClockOffset,
  2705. });
  2706. }
  2707. /**
  2708. * 获取文件下载链接
  2709. * @param {Object} params 参数对象,必须
  2710. * @param {String} params.Bucket Bucket名称,必须
  2711. * @param {String} params.Region 地域名称,必须
  2712. * @param {String} params.Key object名称,必须
  2713. * @param {String} params.Method 请求的方法,可选
  2714. * @param {String} params.Expires 签名超时时间,单位秒,可选
  2715. * @param {Function} callback 回调函数,必须
  2716. * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
  2717. * @return {Object} data 返回的数据
  2718. */
  2719. function getObjectUrl(params, callback) {
  2720. var self = this;
  2721. var useAccelerate = params.UseAccelerate === undefined ? self.options.UseAccelerate : params.UseAccelerate;
  2722. var url = getUrl({
  2723. ForcePathStyle: self.options.ForcePathStyle,
  2724. protocol: params.Protocol || self.options.Protocol,
  2725. domain: params.Domain || self.options.Domain,
  2726. bucket: params.Bucket,
  2727. region: useAccelerate ? 'accelerate' : params.Region,
  2728. object: params.Key,
  2729. });
  2730. var queryParamsStr = '';
  2731. if(params.Query){
  2732. queryParamsStr += util.obj2str(params.Query);
  2733. }
  2734. if(params.QueryString){
  2735. queryParamsStr += (queryParamsStr ? '&' : '') + params.QueryString;
  2736. }
  2737. var syncUrl = url;
  2738. if (params.Sign !== undefined && !params.Sign) {
  2739. queryParamsStr && (syncUrl += '?' + queryParamsStr);
  2740. callback(null, {Url: syncUrl});
  2741. return syncUrl;
  2742. }
  2743. // 签名加上 Host,避免跨桶访问
  2744. var SignHost = getSignHost.call(this, {Bucket: params.Bucket, Region: params.Region, UseAccelerate: params.UseAccelerate, Url: url});
  2745. var AuthData = getAuthorizationAsync.call(this, {
  2746. Action: ((params.Method || '').toUpperCase() === 'PUT' ? 'name/cos:PutObject' : 'name/cos:GetObject'),
  2747. Bucket: params.Bucket || '',
  2748. Region: params.Region || '',
  2749. Method: params.Method || 'get',
  2750. Key: params.Key,
  2751. Expires: params.Expires,
  2752. Headers: params.Headers,
  2753. Query: params.Query,
  2754. SignHost: SignHost,
  2755. ForceSignHost: params.ForceSignHost === false ? false : self.options.ForceSignHost, // getObjectUrl支持传参ForceSignHost
  2756. }, function (err, AuthData) {
  2757. if (!callback) return;
  2758. if (err) {
  2759. callback(err);
  2760. return;
  2761. }
  2762. // 兼容万象url qUrlParamList需要再encode一次
  2763. var replaceUrlParamList = function(url) {
  2764. var urlParams = url.match(/q-url-param-list.*?(?=&)/g)[0];
  2765. var encodedParams = 'q-url-param-list=' + encodeURIComponent(urlParams.replace(/q-url-param-list=/, '')).toLowerCase();
  2766. var reg = new RegExp(urlParams, 'g');
  2767. var replacedUrl = url.replace(reg, encodedParams);
  2768. return replacedUrl;
  2769. }
  2770. var signUrl = url;
  2771. signUrl += '?' + (AuthData.Authorization.indexOf('q-signature') > -1 ?
  2772. replaceUrlParamList(AuthData.Authorization) : 'sign=' + encodeURIComponent(AuthData.Authorization));
  2773. AuthData.SecurityToken && (signUrl += '&x-cos-security-token=' + AuthData.SecurityToken);
  2774. AuthData.ClientIP && (signUrl += '&clientIP=' + AuthData.ClientIP);
  2775. AuthData.ClientUA && (signUrl += '&clientUA=' + AuthData.ClientUA);
  2776. AuthData.Token && (signUrl += '&token=' + AuthData.Token);
  2777. queryParamsStr && (signUrl += '&' + queryParamsStr);
  2778. setTimeout(function () {
  2779. callback(null, {Url: signUrl});
  2780. });
  2781. });
  2782. if (AuthData) {
  2783. syncUrl += '?' + AuthData.Authorization +
  2784. (AuthData.SecurityToken ? '&x-cos-security-token=' + AuthData.SecurityToken : '');
  2785. queryParamsStr && (syncUrl += '&' + queryParamsStr);
  2786. } else {
  2787. queryParamsStr && (syncUrl += '?' + queryParamsStr);
  2788. }
  2789. return syncUrl;
  2790. }
  2791. /**
  2792. * 私有方法
  2793. */
  2794. function decodeAcl(AccessControlPolicy) {
  2795. var result = {
  2796. GrantFullControl: [],
  2797. GrantWrite: [],
  2798. GrantRead: [],
  2799. GrantReadAcp: [],
  2800. GrantWriteAcp: [],
  2801. ACL: '',
  2802. };
  2803. var GrantMap = {
  2804. 'FULL_CONTROL': 'GrantFullControl',
  2805. 'WRITE': 'GrantWrite',
  2806. 'READ': 'GrantRead',
  2807. 'READ_ACP': 'GrantReadAcp',
  2808. 'WRITE_ACP': 'GrantWriteAcp',
  2809. };
  2810. var AccessControlList = AccessControlPolicy && AccessControlPolicy.AccessControlList || {};
  2811. var Grant = AccessControlList.Grant;
  2812. if (Grant) {
  2813. Grant = util.isArray(Grant) ? Grant : [Grant];
  2814. }
  2815. var PublicAcl = {READ: 0, WRITE: 0, FULL_CONTROL: 0};
  2816. Grant && Grant.length && util.each(Grant, function (item) {
  2817. if (item.Grantee.ID === 'qcs::cam::anyone:anyone' || item.Grantee.URI === 'http://cam.qcloud.com/groups/global/AllUsers') {
  2818. PublicAcl[item.Permission] = 1;
  2819. } else if (item.Grantee.ID !== AccessControlPolicy.Owner.ID) {
  2820. result[GrantMap[item.Permission]].push('id="' + item.Grantee.ID + '"');
  2821. }
  2822. });
  2823. if (PublicAcl.FULL_CONTROL || (PublicAcl.WRITE && PublicAcl.READ)) {
  2824. result.ACL = 'public-read-write';
  2825. } else if (PublicAcl.READ) {
  2826. result.ACL = 'public-read';
  2827. } else {
  2828. result.ACL = 'private';
  2829. }
  2830. util.each(GrantMap, function (item) {
  2831. result[item] = uniqGrant(result[item].join(','));
  2832. });
  2833. return result;
  2834. }
  2835. // Grant 去重
  2836. function uniqGrant(str) {
  2837. var arr = str.split(',');
  2838. var exist = {};
  2839. var i, item;
  2840. for (i = 0; i < arr.length; ) {
  2841. item = arr[i].trim();
  2842. if (exist[item]) {
  2843. arr.splice(i, 1);
  2844. } else {
  2845. exist[item] = true;
  2846. arr[i] = item;
  2847. i++;
  2848. }
  2849. }
  2850. return arr.join(',');
  2851. }
  2852. // 生成操作 url
  2853. function getUrl(params) {
  2854. var longBucket = params.bucket;
  2855. var shortBucket = longBucket.substr(0, longBucket.lastIndexOf('-'));
  2856. var appId = longBucket.substr(longBucket.lastIndexOf('-') + 1);
  2857. var domain = params.domain;
  2858. var region = params.region;
  2859. var object = params.object;
  2860. var protocol = 'https:';
  2861. if (!domain) {
  2862. if (['cn-south', 'cn-south-2', 'cn-north', 'cn-east', 'cn-southwest', 'sg'].indexOf(region) > -1) {
  2863. domain = '{Region}.myqcloud.com';
  2864. } else {
  2865. domain = 'cos.{Region}.myqcloud.com';
  2866. }
  2867. if (!params.ForcePathStyle) {
  2868. domain = '{Bucket}.' + domain;
  2869. }
  2870. }
  2871. domain = domain.replace(/\{\{AppId\}\}/ig, appId)
  2872. .replace(/\{\{Bucket\}\}/ig, shortBucket)
  2873. .replace(/\{\{Region\}\}/ig, region)
  2874. .replace(/\{\{.*?\}\}/ig, '');
  2875. domain = domain.replace(/\{AppId\}/ig, appId)
  2876. .replace(/\{BucketName\}/ig, shortBucket)
  2877. .replace(/\{Bucket\}/ig, longBucket)
  2878. .replace(/\{Region\}/ig, region)
  2879. .replace(/\{.*?\}/ig, '');
  2880. if (!/^[a-zA-Z]+:\/\//.test(domain)) {
  2881. domain = protocol + '//' + domain;
  2882. }
  2883. // 去掉域名最后的斜杆
  2884. if (domain.slice(-1) === '/') {
  2885. domain = domain.slice(0, -1);
  2886. }
  2887. var url = domain;
  2888. if (params.ForcePathStyle) {
  2889. url += '/' + longBucket;
  2890. }
  2891. url += '/';
  2892. if (object) {
  2893. url += util.camSafeUrlEncode(object).replace(/%2F/g, '/');
  2894. }
  2895. if (params.isLocation) {
  2896. url = url.replace(/^https?:\/\//, '');
  2897. }
  2898. return url;
  2899. }
  2900. var getSignHost = function (opt) {
  2901. if (!opt.Bucket || !opt.Region) return '';
  2902. var useAccelerate = opt.UseAccelerate === undefined ? this.options.UseAccelerate : opt.UseAccelerate;
  2903. var url = opt.Url || getUrl({
  2904. ForcePathStyle: this.options.ForcePathStyle,
  2905. protocol: this.options.Protocol,
  2906. domain: this.options.Domain,
  2907. bucket: opt.Bucket,
  2908. region: useAccelerate ? 'accelerate' : opt.Region,
  2909. });
  2910. var urlHost = url.replace(/^https?:\/\/([^/]+)(\/.*)?$/, '$1');
  2911. var standardHostReg = new RegExp('^([a-z\\d-]+-\\d+\\.)?(cos|cosv6|ci|pic)\\.([a-z\\d-]+)\\.myqcloud\\.com$');
  2912. if (standardHostReg.test(urlHost)) return urlHost;
  2913. return '';
  2914. }
  2915. // 异步获取签名
  2916. function getAuthorizationAsync(params, callback) {
  2917. var headers = util.clone(params.Headers);
  2918. var headerHost = '';
  2919. util.each(headers, function (v, k) {
  2920. (v === '' || ['content-type', 'cache-control'].indexOf(k.toLowerCase()) > -1) && delete headers[k];
  2921. if (k.toLowerCase() === 'host') headerHost = v;
  2922. });
  2923. // ForceSignHost明确传入false才不加入host签名
  2924. var forceSignHost = params.ForceSignHost === false ? false : true;
  2925. // Host 加入签名计算
  2926. if (!headerHost && params.SignHost && forceSignHost) headers.Host = params.SignHost;
  2927. // 获取凭证的回调,避免用户 callback 多次
  2928. var cbDone = false;
  2929. var cb = function (err, AuthData) {
  2930. if (cbDone) return;
  2931. cbDone = true;
  2932. if (AuthData && AuthData.XCosSecurityToken && !AuthData.SecurityToken) {
  2933. AuthData = util.clone(AuthData);
  2934. AuthData.SecurityToken = AuthData.XCosSecurityToken;
  2935. delete AuthData.XCosSecurityToken;
  2936. }
  2937. callback && callback(err, AuthData);
  2938. };
  2939. var self = this;
  2940. var Bucket = params.Bucket || '';
  2941. var Region = params.Region || '';
  2942. // PathName
  2943. var KeyName = params.Action === 'name/cos:PostObject' || !params.Key ? '' : params.Key;
  2944. if (self.options.ForcePathStyle && Bucket) {
  2945. KeyName = Bucket + '/' + KeyName;
  2946. }
  2947. var Pathname = '/' + KeyName;
  2948. // Action、ResourceKey
  2949. var StsData = {};
  2950. var Scope = params.Scope;
  2951. if (!Scope) {
  2952. var Action = params.Action || '';
  2953. var ResourceKey = params.ResourceKey || params.Key || '';
  2954. Scope = params.Scope || [{
  2955. action: Action,
  2956. bucket: Bucket,
  2957. region: Region,
  2958. prefix: ResourceKey,
  2959. }];
  2960. }
  2961. var ScopeKey = util.md5(JSON.stringify(Scope));
  2962. // STS
  2963. self._StsCache = self._StsCache ||[];
  2964. (function () {
  2965. var i, AuthData;
  2966. for (i = self._StsCache.length - 1; i >= 0; i--) {
  2967. AuthData = self._StsCache[i];
  2968. var compareTime = Math.round(util.getSkewTime(self.options.SystemClockOffset) / 1000) + 30;
  2969. if (AuthData.StartTime && compareTime < AuthData.StartTime || compareTime >= AuthData.ExpiredTime) {
  2970. self._StsCache.splice(i, 1);
  2971. continue;
  2972. }
  2973. if (!AuthData.ScopeLimit || AuthData.ScopeLimit && AuthData.ScopeKey === ScopeKey) {
  2974. StsData = AuthData;
  2975. break;
  2976. }
  2977. }
  2978. })();
  2979. var calcAuthByTmpKey = function () {
  2980. var KeyTime = '';
  2981. if (StsData.StartTime && params.Expires) {
  2982. KeyTime = StsData.StartTime + ';' + (StsData.StartTime + params.Expires * 1);
  2983. } else if (StsData.StartTime && StsData.ExpiredTime) {
  2984. KeyTime = StsData.StartTime + ';' + StsData.ExpiredTime;
  2985. }
  2986. var Authorization = util.getAuth({
  2987. SecretId: StsData.TmpSecretId,
  2988. SecretKey: StsData.TmpSecretKey,
  2989. Method: params.Method,
  2990. Pathname: Pathname,
  2991. Query: params.Query,
  2992. Headers: headers,
  2993. Expires: params.Expires,
  2994. SystemClockOffset: self.options.SystemClockOffset,
  2995. KeyTime: KeyTime,
  2996. ForceSignHost: forceSignHost,
  2997. });
  2998. var AuthData = {
  2999. Authorization: Authorization,
  3000. SecurityToken: StsData.SecurityToken || StsData.XCosSecurityToken || '',
  3001. Token: StsData.Token || '',
  3002. ClientIP: StsData.ClientIP || '',
  3003. ClientUA: StsData.ClientUA || '',
  3004. };
  3005. cb(null, AuthData);
  3006. };
  3007. var checkAuthError = function (AuthData) {
  3008. if (AuthData.Authorization) {
  3009. // 检查签名格式
  3010. var formatAllow = false;
  3011. var auth = AuthData.Authorization;
  3012. if (auth) {
  3013. if (auth.indexOf(' ') > -1) {
  3014. formatAllow = false;
  3015. } else if (auth.indexOf('q-sign-algorithm=') > -1 &&
  3016. auth.indexOf('q-ak=') > -1 &&
  3017. auth.indexOf('q-sign-time=') > -1 &&
  3018. auth.indexOf('q-key-time=') > -1 &&
  3019. auth.indexOf('q-url-param-list=') > -1) {
  3020. formatAllow = true;
  3021. } else {
  3022. try {
  3023. auth = atob(auth);
  3024. if (auth.indexOf('a=') > -1 &&
  3025. auth.indexOf('k=') > -1 &&
  3026. auth.indexOf('t=') > -1 &&
  3027. auth.indexOf('r=') > -1 &&
  3028. auth.indexOf('b=') > -1) {
  3029. formatAllow = true;
  3030. }
  3031. } catch (e) {}
  3032. }
  3033. }
  3034. if (!formatAllow) return util.error(new Error('getAuthorization callback params format error'));
  3035. } else {
  3036. if (!AuthData.TmpSecretId) return util.error(new Error('getAuthorization callback params missing "TmpSecretId"'));
  3037. if (!AuthData.TmpSecretKey) return util.error(new Error('getAuthorization callback params missing "TmpSecretKey"'));
  3038. if (!AuthData.SecurityToken && !AuthData.XCosSecurityToken) return util.error(new Error('getAuthorization callback params missing "SecurityToken"'));
  3039. if (!AuthData.ExpiredTime) return util.error(new Error('getAuthorization callback params missing "ExpiredTime"'));
  3040. if (AuthData.ExpiredTime && AuthData.ExpiredTime.toString().length !== 10) return util.error(new Error('getAuthorization callback params "ExpiredTime" should be 10 digits'));
  3041. if (AuthData.StartTime && AuthData.StartTime.toString().length !== 10) return util.error(new Error('getAuthorization callback params "StartTime" should be 10 StartTime'));
  3042. }
  3043. return false;
  3044. };
  3045. // 先判断是否有临时密钥
  3046. if (StsData.ExpiredTime && StsData.ExpiredTime - (util.getSkewTime(self.options.SystemClockOffset) / 1000) > 60) { // 如果缓存的临时密钥有效,并还有超过60秒有效期就直接使用
  3047. calcAuthByTmpKey();
  3048. } else if (self.options.getAuthorization) { // 外部计算签名或获取临时密钥
  3049. self.options.getAuthorization.call(self, {
  3050. Bucket: Bucket,
  3051. Region: Region,
  3052. Method: params.Method,
  3053. Key: KeyName,
  3054. Pathname: Pathname,
  3055. Query: params.Query,
  3056. Headers: headers,
  3057. Scope: Scope,
  3058. SystemClockOffset: self.options.SystemClockOffset,
  3059. ForceSignHost: forceSignHost,
  3060. }, function (AuthData) {
  3061. if (typeof AuthData === 'string') {
  3062. AuthData = {Authorization: AuthData};
  3063. }
  3064. var AuthError = checkAuthError(AuthData);
  3065. if (AuthError) return cb(AuthError);
  3066. if (AuthData.Authorization) {
  3067. cb(null, AuthData);
  3068. } else {
  3069. StsData = AuthData || {};
  3070. StsData.Scope = Scope;
  3071. StsData.ScopeKey = ScopeKey;
  3072. self._StsCache.push(StsData);
  3073. calcAuthByTmpKey();
  3074. }
  3075. });
  3076. } else if (self.options.getSTS) { // 外部获取临时密钥
  3077. self.options.getSTS.call(self, {
  3078. Bucket: Bucket,
  3079. Region: Region,
  3080. }, function (data) {
  3081. StsData = data || {};
  3082. StsData.Scope = Scope;
  3083. StsData.ScopeKey = ScopeKey;
  3084. if (!StsData.TmpSecretId) StsData.TmpSecretId = StsData.SecretId;
  3085. if (!StsData.TmpSecretKey) StsData.TmpSecretKey = StsData.SecretKey;
  3086. var AuthError = checkAuthError(StsData);
  3087. if (AuthError) return cb(AuthError);
  3088. self._StsCache.push(StsData);
  3089. calcAuthByTmpKey();
  3090. });
  3091. } else { // 内部计算获取签名
  3092. return (function () {
  3093. var Authorization = util.getAuth({
  3094. SecretId: params.SecretId || self.options.SecretId,
  3095. SecretKey: params.SecretKey || self.options.SecretKey,
  3096. Method: params.Method,
  3097. Pathname: Pathname,
  3098. Query: params.Query,
  3099. Headers: headers,
  3100. Expires: params.Expires,
  3101. SystemClockOffset: self.options.SystemClockOffset,
  3102. ForceSignHost: forceSignHost,
  3103. });
  3104. var AuthData = {
  3105. Authorization: Authorization,
  3106. SecurityToken: self.options.SecurityToken || self.options.XCosSecurityToken,
  3107. };
  3108. cb(null, AuthData);
  3109. return AuthData;
  3110. })();
  3111. }
  3112. return '';
  3113. }
  3114. // 调整时间偏差
  3115. function allowRetry(err) {
  3116. var allowRetry = false;
  3117. var isTimeError = false;
  3118. var serverDate = (err.headers && (err.headers.date || err.headers.Date)) || (err.error && err.error.ServerTime);
  3119. try {
  3120. var errorCode = err.error.Code;
  3121. var errorMessage = err.error.Message;
  3122. if (errorCode === 'RequestTimeTooSkewed' ||
  3123. (errorCode === 'AccessDenied' && errorMessage === 'Request has expired')) {
  3124. isTimeError = true;
  3125. }
  3126. } catch (e) {
  3127. }
  3128. if (err) {
  3129. if (isTimeError && serverDate) {
  3130. var serverTime = Date.parse(serverDate);
  3131. if (this.options.CorrectClockSkew && Math.abs(util.getSkewTime(this.options.SystemClockOffset) - serverTime) >= 30000) {
  3132. console.error('error: Local time is too skewed.');
  3133. this.options.SystemClockOffset = serverTime - Date.now();
  3134. allowRetry = true;
  3135. }
  3136. } else if (Math.floor(err.statusCode / 100) === 5) {
  3137. allowRetry = true;
  3138. }
  3139. }
  3140. return allowRetry;
  3141. }
  3142. // 获取签名并发起请求
  3143. function submitRequest(params, callback) {
  3144. var self = this;
  3145. // 处理 headers
  3146. !params.headers && (params.headers = {});
  3147. // 处理 query
  3148. !params.qs && (params.qs = {});
  3149. params.VersionId && (params.qs.versionId = params.VersionId);
  3150. params.qs = util.clearKey(params.qs);
  3151. // 清理 undefined 和 null 字段
  3152. params.headers && (params.headers = util.clearKey(params.headers));
  3153. params.qs && (params.qs = util.clearKey(params.qs));
  3154. var Query = util.clone(params.qs);
  3155. params.action && (Query[params.action] = '');
  3156. var paramsUrl = params.url || params.Url;
  3157. var SignHost = params.SignHost || getSignHost.call(this, {Bucket: params.Bucket, Region: params.Region, Url: paramsUrl});
  3158. var next = function (tryTimes) {
  3159. var oldClockOffset = self.options.SystemClockOffset;
  3160. getAuthorizationAsync.call(self, {
  3161. Bucket: params.Bucket || '',
  3162. Region: params.Region || '',
  3163. Method: params.method,
  3164. Key: params.Key,
  3165. Query: Query,
  3166. Headers: params.headers,
  3167. SignHost: SignHost,
  3168. Action: params.Action,
  3169. ResourceKey: params.ResourceKey,
  3170. Scope: params.Scope,
  3171. ForceSignHost: self.options.ForceSignHost,
  3172. }, function (err, AuthData) {
  3173. if (err) {
  3174. callback(err);
  3175. return;
  3176. }
  3177. params.AuthData = AuthData;
  3178. _submitRequest.call(self, params, function (err, data) {
  3179. if (err && tryTimes < 2 && (oldClockOffset !== self.options.SystemClockOffset || allowRetry.call(self, err))) {
  3180. if (params.headers) {
  3181. delete params.headers.Authorization;
  3182. delete params.headers['token'];
  3183. delete params.headers['clientIP'];
  3184. delete params.headers['clientUA'];
  3185. delete params.headers['x-cos-security-token'];
  3186. }
  3187. next(tryTimes + 1);
  3188. } else {
  3189. callback(err, data);
  3190. }
  3191. });
  3192. });
  3193. };
  3194. next(1);
  3195. }
  3196. // 发起请求
  3197. function _submitRequest(params, callback) {
  3198. var self = this;
  3199. var TaskId = params.TaskId;
  3200. if (TaskId && !self._isRunningTask(TaskId)) return;
  3201. var bucket = params.Bucket;
  3202. var region = params.Region;
  3203. var object = params.Key;
  3204. var method = params.method || 'GET';
  3205. var url = params.url || params.Url;
  3206. var body = params.body;
  3207. var json = params.json;
  3208. var rawBody = params.rawBody;
  3209. var httpDNSServiceId = self.options.HttpDNSServiceId;
  3210. // url
  3211. if (self.options.UseAccelerate) {
  3212. region = 'accelerate';
  3213. }
  3214. url = url || getUrl({
  3215. ForcePathStyle: self.options.ForcePathStyle,
  3216. protocol: self.options.Protocol,
  3217. domain: self.options.Domain,
  3218. bucket: bucket,
  3219. region: region,
  3220. object: object,
  3221. });
  3222. if (params.action) {
  3223. url = url + '?' + params.action;
  3224. }
  3225. if (params.qsStr) {
  3226. if(url.indexOf('?') > -1){
  3227. url = url + '&' + params.qsStr;
  3228. }else{
  3229. url = url + '?' + params.qsStr;
  3230. }
  3231. }
  3232. var opt = {
  3233. method: method,
  3234. url: url,
  3235. headers: params.headers,
  3236. qs: params.qs,
  3237. filePath: params.filePath,
  3238. body: body,
  3239. json: json,
  3240. httpDNSServiceId: httpDNSServiceId,
  3241. };
  3242. // 兼容ci接口
  3243. var token = 'x-cos-security-token';
  3244. if (util.isCIHost(url)) {
  3245. token = 'x-ci-security-token';
  3246. }
  3247. // 获取签名
  3248. opt.headers.Authorization = params.AuthData.Authorization;
  3249. params.AuthData.Token && (opt.headers['token'] = params.AuthData.Token);
  3250. params.AuthData.ClientIP && (opt.headers['clientIP'] = params.AuthData.ClientIP);
  3251. params.AuthData.ClientUA && (opt.headers['clientUA'] = params.AuthData.ClientUA);
  3252. params.AuthData.SecurityToken && (opt.headers[token] = params.AuthData.SecurityToken);
  3253. // 清理 undefined 和 null 字段
  3254. opt.headers && (opt.headers = util.clearKey(opt.headers));
  3255. opt = util.clearKey(opt);
  3256. // progress
  3257. if (params.onProgress && typeof params.onProgress === 'function') {
  3258. opt.onProgress = function (e) {
  3259. if (TaskId && !self._isRunningTask(TaskId)) return;
  3260. var loaded = e ? e.loaded : 0;
  3261. params.onProgress({loaded: loaded, total: e.total});
  3262. };
  3263. }
  3264. if (this.options.Timeout) {
  3265. opt.timeout = this.options.Timeout;
  3266. }
  3267. self.options.ForcePathStyle && (opt.pathStyle = self.options.ForcePathStyle);
  3268. self.emit('before-send', opt);
  3269. var sender = REQUEST(opt, function (err, response, body) {
  3270. if (err === 'abort') return;
  3271. // 返回内容添加 状态码 和 headers
  3272. var hasReturned;
  3273. var cb = function (err, data) {
  3274. TaskId && self.off('inner-kill-task', killTask);
  3275. if (hasReturned) return;
  3276. hasReturned = true;
  3277. var attrs = {};
  3278. response && response.statusCode && (attrs.statusCode = response.statusCode);
  3279. response && response.headers && (attrs.headers = response.headers);
  3280. if (err) {
  3281. err = util.extend(err || {}, attrs);
  3282. callback(err, null);
  3283. } else {
  3284. data = util.extend(data || {}, attrs);
  3285. callback(null, data);
  3286. }
  3287. sender = null;
  3288. };
  3289. // 请求错误,发生网络错误
  3290. if (err) {
  3291. cb({error: err});
  3292. return;
  3293. }
  3294. // 不对 body 进行转换,body 直接挂载返回
  3295. var jsonRes;
  3296. if (rawBody) {
  3297. jsonRes = {};
  3298. jsonRes.body = body;
  3299. } else {
  3300. try {
  3301. jsonRes = body && body.indexOf('<') > -1 && body.indexOf('>') > -1 && util.xml2json(body) || {};
  3302. } catch (e) {
  3303. jsonRes = body || {};
  3304. }
  3305. }
  3306. // 请求返回码不为 200
  3307. var statusCode = response.statusCode;
  3308. var statusSuccess = Math.floor(statusCode / 100) === 2; // 200 202 204 206
  3309. if (!statusSuccess) {
  3310. cb({error: jsonRes.Error || jsonRes});
  3311. return;
  3312. }
  3313. if (jsonRes.Error) {
  3314. cb({error: jsonRes.Error});
  3315. return;
  3316. }
  3317. cb(null, jsonRes);
  3318. });
  3319. // kill task
  3320. var killTask = function (data) {
  3321. if (data.TaskId === TaskId) {
  3322. sender && sender.abort && sender.abort();
  3323. self.off('inner-kill-task', killTask);
  3324. }
  3325. };
  3326. TaskId && self.on('inner-kill-task', killTask);
  3327. }
  3328. var API_MAP = {
  3329. // Bucket 相关方法
  3330. getService: getService, // Bucket
  3331. putBucket: putBucket,
  3332. headBucket: headBucket, // Bucket
  3333. getBucket: getBucket,
  3334. deleteBucket: deleteBucket,
  3335. putBucketAcl: putBucketAcl, // BucketACL
  3336. getBucketAcl: getBucketAcl,
  3337. putBucketCors: putBucketCors, // BucketCors
  3338. getBucketCors: getBucketCors,
  3339. deleteBucketCors: deleteBucketCors,
  3340. getBucketLocation: getBucketLocation, // BucketLocation
  3341. getBucketPolicy: getBucketPolicy, // BucketPolicy
  3342. putBucketPolicy: putBucketPolicy,
  3343. deleteBucketPolicy: deleteBucketPolicy,
  3344. putBucketTagging: putBucketTagging, // BucketTagging
  3345. getBucketTagging: getBucketTagging,
  3346. deleteBucketTagging: deleteBucketTagging,
  3347. putBucketLifecycle: putBucketLifecycle, // BucketLifecycle
  3348. getBucketLifecycle: getBucketLifecycle,
  3349. deleteBucketLifecycle: deleteBucketLifecycle,
  3350. putBucketVersioning: putBucketVersioning, // BucketVersioning
  3351. getBucketVersioning: getBucketVersioning,
  3352. putBucketReplication: putBucketReplication, // BucketReplication
  3353. getBucketReplication: getBucketReplication,
  3354. deleteBucketReplication: deleteBucketReplication,
  3355. putBucketWebsite: putBucketWebsite, // BucketWebsite
  3356. getBucketWebsite: getBucketWebsite,
  3357. deleteBucketWebsite: deleteBucketWebsite,
  3358. putBucketReferer: putBucketReferer, // BucketReferer
  3359. getBucketReferer: getBucketReferer,
  3360. putBucketDomain: putBucketDomain, // BucketDomain
  3361. getBucketDomain: getBucketDomain,
  3362. deleteBucketDomain: deleteBucketDomain,
  3363. putBucketOrigin: putBucketOrigin, // BucketOrigin
  3364. getBucketOrigin: getBucketOrigin,
  3365. deleteBucketOrigin: deleteBucketOrigin,
  3366. putBucketLogging: putBucketLogging, // BucketLogging
  3367. getBucketLogging: getBucketLogging,
  3368. putBucketInventory: putBucketInventory, // BucketInventory
  3369. getBucketInventory: getBucketInventory,
  3370. listBucketInventory: listBucketInventory,
  3371. deleteBucketInventory: deleteBucketInventory,
  3372. putBucketAccelerate: putBucketAccelerate,
  3373. getBucketAccelerate: getBucketAccelerate,
  3374. // Object 相关方法
  3375. getObject: getObject,
  3376. headObject: headObject,
  3377. listObjectVersions: listObjectVersions,
  3378. putObject: putObject,
  3379. postObject: postObject,
  3380. deleteObject: deleteObject,
  3381. getObjectAcl: getObjectAcl,
  3382. putObjectAcl: putObjectAcl,
  3383. optionsObject: optionsObject,
  3384. putObjectCopy: putObjectCopy,
  3385. deleteMultipleObject: deleteMultipleObject,
  3386. restoreObject: restoreObject,
  3387. putObjectTagging: putObjectTagging,
  3388. getObjectTagging: getObjectTagging,
  3389. deleteObjectTagging: deleteObjectTagging,
  3390. appendObject: appendObject,
  3391. // 分块上传相关方法
  3392. uploadPartCopy: uploadPartCopy,
  3393. multipartInit: multipartInit,
  3394. multipartUpload: multipartUpload,
  3395. multipartComplete: multipartComplete,
  3396. multipartList: multipartList,
  3397. multipartListPart: multipartListPart,
  3398. multipartAbort: multipartAbort,
  3399. // 工具方法
  3400. request: request,
  3401. getObjectUrl: getObjectUrl,
  3402. getAuth: getAuth,
  3403. };
  3404. module.exports.init = function (COS, task) {
  3405. task.transferToTaskMethod(API_MAP, 'postObject');
  3406. task.transferToTaskMethod(API_MAP, 'putObject');
  3407. util.each(API_MAP, function (fn, apiName) {
  3408. COS.prototype[apiName] = util.apiWrapper(apiName, fn);
  3409. });
  3410. };