base.js 161 KB

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