| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494 |
- var pkg = require('../package.json');
- var REQUEST = require('request');
- var mime = require('mime-types');
- var Stream = require('stream');
- var util = require('./util');
- var fs = require('fs');
- // Bucket 相关
- /**
- * 获取用户的 bucket 列表
- * @param {Object} params 回调函数,必须,下面为参数列表
- * 无特殊参数
- * @param {Function} callback 回调函数,必须
- */
- function getService(params, callback) {
- var protocol = this.options.Protocol || (util.isBrowser && location.protocol === 'http:' ? 'http:' : 'https:');
- var domain = this.options.ServiceDomain;
- var appId = params.AppId || this.options.appId;
- var region = params.Region;
- if (domain) {
- domain = domain
- .replace(/\{\{AppId\}\}/gi, appId || '')
- .replace(/\{\{Region\}\}/gi, region || '')
- .replace(/\{\{.*?\}\}/gi, '');
- if (!/^[a-zA-Z]+:\/\//.test(domain)) {
- domain = protocol + '//' + domain;
- }
- if (domain.slice(-1) === '/') {
- domain = domain.slice(0, -1);
- }
- } else if (region) {
- domain = protocol + '//cos.' + region + '.myqcloud.com';
- } else {
- domain = protocol + '//service.cos.myqcloud.com';
- }
- var SignHost = '';
- var standardHost = region ? 'cos.' + region + '.myqcloud.com' : 'service.cos.myqcloud.com';
- var urlHost = domain.replace(/^https?:\/\/([^/]+)(\/.*)?$/, '$1');
- if (standardHost === urlHost) SignHost = standardHost;
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetService',
- url: domain,
- method: 'GET',
- headers: params.Headers,
- SignHost: SignHost,
- qs: {
- tagkey: params.TagKey,
- tagvalue: params.TagValue,
- 'create-time': params.CreateTime,
- range: params.CreateRange,
- marker: params.Marker,
- 'max-keys': params.MaxKeys,
- },
- },
- function (err, data) {
- if (err) return callback(err);
- var buckets =
- (data &&
- data.ListAllMyBucketsResult &&
- data.ListAllMyBucketsResult.Buckets &&
- data.ListAllMyBucketsResult.Buckets.Bucket) ||
- [];
- buckets = util.isArray(buckets) ? buckets : [buckets];
- var owner = (data && data.ListAllMyBucketsResult && data.ListAllMyBucketsResult.Owner) || {};
- callback(null, {
- Buckets: buckets,
- Owner: owner,
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 创建 Bucket,并初始化访问权限
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.ACL 用户自定义文件权限,可以设置:private,public-read;默认值:private,非必须
- * @param {String} params.GrantRead 赋予被授权者读的权限,格式x-cos-grant-read: uin=" ",uin=" ",非必须
- * @param {String} params.GrantWrite 赋予被授权者写的权限,格式x-cos-grant-write: uin=" ",uin=" ",非必须
- * @param {String} params.GrantFullControl 赋予被授权者读写权限,格式x-cos-grant-full-control: uin=" ",uin=" ",非必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- * @return {String} data.Location 操作地址
- */
- function putBucket(params, callback) {
- var self = this;
- var xml = '';
- var conf = {};
- if (params.BucketAZConfig) conf.BucketAZConfig = params.BucketAZConfig;
- if (params.BucketArchConfig) conf.BucketArchConfig = params.BucketArchConfig;
- if (conf.BucketAZConfig || conf.BucketArchConfig) xml = util.json2xml({ CreateBucketConfiguration: conf });
- submitRequest.call(
- this,
- {
- Action: 'name/cos:PutBucket',
- method: 'PUT',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- body: xml,
- },
- function (err, data) {
- if (err) return callback(err);
- var url = getUrl({
- protocol: self.options.Protocol,
- domain: self.options.Domain,
- bucket: params.Bucket,
- region: params.Region,
- isLocation: true,
- });
- callback(null, {
- Location: url,
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 查看是否存在该Bucket,是否有权限访问
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- * @return {Boolean} data.BucketExist Bucket是否存在
- * @return {Boolean} data.BucketAuth 是否有 Bucket 的访问权限
- */
- function headBucket(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:HeadBucket',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- method: 'HEAD',
- },
- callback
- );
- }
- /**
- * 获取 Bucket 下的 object 列表
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.Prefix 前缀匹配,用来规定返回的文件前缀地址,非必须
- * @param {String} params.Delimiter 定界符为一个符号,如果有Prefix,则将Prefix到delimiter之间的相同路径归为一类,非必须
- * @param {String} params.Marker 默认以UTF-8二进制顺序列出条目,所有列出条目从marker开始,非必须
- * @param {String} params.MaxKeys 单次返回最大的条目数量,默认1000,非必须
- * @param {String} params.EncodingType 规定返回值的编码方式,非必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- * @return {Object} data.ListBucketResult 返回的 object 列表信息
- */
- function getBucket(params, callback) {
- var reqParams = {};
- reqParams['prefix'] = params['Prefix'] || '';
- reqParams['delimiter'] = params['Delimiter'];
- reqParams['marker'] = params['Marker'];
- reqParams['max-keys'] = params['MaxKeys'];
- reqParams['encoding-type'] = params['EncodingType'];
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetBucket',
- ResourceKey: reqParams['prefix'],
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- qs: reqParams,
- },
- function (err, data) {
- if (err) return callback(err);
- var ListBucketResult = data.ListBucketResult || {};
- var Contents = ListBucketResult.Contents || [];
- var CommonPrefixes = ListBucketResult.CommonPrefixes || [];
- Contents = util.isArray(Contents) ? Contents : [Contents];
- CommonPrefixes = util.isArray(CommonPrefixes) ? CommonPrefixes : [CommonPrefixes];
- var result = util.clone(ListBucketResult);
- util.extend(result, {
- Contents: Contents,
- CommonPrefixes: CommonPrefixes,
- statusCode: data.statusCode,
- headers: data.headers,
- });
- callback(null, result);
- }
- );
- }
- /**
- * 删除 Bucket
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- * @return {String} data.Location 操作地址
- */
- function deleteBucket(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:DeleteBucket',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- method: 'DELETE',
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 设置 Bucket 的 权限列表
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.ACL 用户自定义文件权限,可以设置:private,public-read;默认值:private,非必须
- * @param {String} params.GrantRead 赋予被授权者读的权限,格式x-cos-grant-read: uin=" ",uin=" ",非必须
- * @param {String} params.GrantWrite 赋予被授权者写的权限,格式x-cos-grant-write: uin=" ",uin=" ",非必须
- * @param {String} params.GrantFullControl 赋予被授权者读写权限,格式x-cos-grant-full-control: uin=" ",uin=" ",非必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- */
- function putBucketAcl(params, callback) {
- var headers = params.Headers;
- var xml = '';
- if (params['AccessControlPolicy']) {
- var AccessControlPolicy = util.clone(params['AccessControlPolicy'] || {});
- var Grants = AccessControlPolicy.Grants || AccessControlPolicy.Grant;
- Grants = util.isArray(Grants) ? Grants : [Grants];
- delete AccessControlPolicy.Grant;
- delete AccessControlPolicy.Grants;
- AccessControlPolicy.AccessControlList = { Grant: Grants };
- xml = util.json2xml({ AccessControlPolicy: AccessControlPolicy });
- headers['Content-Type'] = 'application/xml';
- headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
- }
- // Grant Header 去重
- util.each(headers, function (val, key) {
- if (key.indexOf('x-cos-grant-') === 0) {
- headers[key] = uniqGrant(headers[key]);
- }
- });
- submitRequest.call(
- this,
- {
- Action: 'name/cos:PutBucketACL',
- method: 'PUT',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: headers,
- action: 'acl',
- body: xml,
- },
- function (err, data) {
- if (err) return callback(err);
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 获取 Bucket 的 权限列表
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- * @return {Object} data.AccessControlPolicy 访问权限信息
- */
- function getBucketAcl(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetBucketACL',
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'acl',
- },
- function (err, data) {
- if (err) return callback(err);
- var AccessControlPolicy = data.AccessControlPolicy || {};
- var Owner = AccessControlPolicy.Owner || {};
- var Grant = (AccessControlPolicy.AccessControlList && AccessControlPolicy.AccessControlList.Grant) || [];
- Grant = util.isArray(Grant) ? Grant : [Grant];
- var result = decodeAcl(AccessControlPolicy);
- if (data.headers && data.headers['x-cos-acl']) {
- result.ACL = data.headers['x-cos-acl'];
- }
- result = util.extend(result, {
- Owner: Owner,
- Grants: Grant,
- statusCode: data.statusCode,
- headers: data.headers,
- });
- callback(null, result);
- }
- );
- }
- /**
- * 设置 Bucket 的 跨域设置
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Object} params.CORSConfiguration 相关的跨域设置,必须
- * @param {Array} params.CORSConfiguration.CORSRules 对应的跨域规则
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- */
- function putBucketCors(params, callback) {
- var CORSConfiguration = params['CORSConfiguration'] || {};
- var CORSRules = CORSConfiguration['CORSRules'] || params['CORSRules'] || [];
- CORSRules = util.clone(util.isArray(CORSRules) ? CORSRules : [CORSRules]);
- util.each(CORSRules, function (rule) {
- util.each(['AllowedOrigin', 'AllowedHeader', 'AllowedMethod', 'ExposeHeader'], function (key) {
- var sKey = key + 's';
- var val = rule[sKey] || rule[key] || [];
- delete rule[sKey];
- rule[key] = util.isArray(val) ? val : [val];
- });
- });
- var Conf = { CORSRule: CORSRules };
- if (params.ResponseVary) Conf.ResponseVary = params.ResponseVary;
- var xml = util.json2xml({ CORSConfiguration: Conf });
- var headers = params.Headers;
- headers['Content-Type'] = 'application/xml';
- headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
- submitRequest.call(
- this,
- {
- Action: 'name/cos:PutBucketCORS',
- method: 'PUT',
- Bucket: params.Bucket,
- Region: params.Region,
- body: xml,
- action: 'cors',
- headers: headers,
- },
- function (err, data) {
- if (err) return callback(err);
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 获取 Bucket 的 跨域设置
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- * @return {Object} data.CORSRules Bucket的跨域设置
- */
- function getBucketCors(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetBucketCORS',
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'cors',
- },
- function (err, data) {
- if (err) {
- if (err.statusCode === 404 && err.error && err.error.Code === 'NoSuchCORSConfiguration') {
- var result = {
- CORSRules: [],
- statusCode: err.statusCode,
- };
- err.headers && (result.headers = err.headers);
- callback(null, result);
- } else {
- callback(err);
- }
- return;
- }
- var CORSConfiguration = data.CORSConfiguration || {};
- var CORSRules = CORSConfiguration.CORSRules || CORSConfiguration.CORSRule || [];
- CORSRules = util.clone(util.isArray(CORSRules) ? CORSRules : [CORSRules]);
- var ResponseVary = CORSConfiguration.ResponseVary;
- util.each(CORSRules, function (rule) {
- util.each(['AllowedOrigin', 'AllowedHeader', 'AllowedMethod', 'ExposeHeader'], function (key) {
- var sKey = key + 's';
- var val = rule[sKey] || rule[key] || [];
- delete rule[key];
- rule[sKey] = util.isArray(val) ? val : [val];
- });
- });
- callback(null, {
- CORSRules: CORSRules,
- ResponseVary: ResponseVary,
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 删除 Bucket 的 跨域设置
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- */
- function deleteBucketCors(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:DeleteBucketCORS',
- method: 'DELETE',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'cors',
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode || err.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 获取 Bucket 的 地域信息
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回数据,包含地域信息 LocationConstraint
- */
- function getBucketLocation(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetBucketLocation',
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'location',
- },
- callback
- );
- }
- function putBucketPolicy(params, callback) {
- var Policy = params['Policy'];
- try {
- if (typeof Policy === 'string') Policy = JSON.parse(Policy);
- } catch (e) {}
- if (!Policy || typeof Policy === 'string') return callback(util.error(new Error('Policy format error')));
- var PolicyStr = JSON.stringify(Policy);
- if (!Policy.version) Policy.version = '2.0';
- var headers = params.Headers;
- headers['Content-Type'] = 'application/json';
- headers['Content-MD5'] = util.binaryBase64(util.md5(PolicyStr));
- submitRequest.call(
- this,
- {
- Action: 'name/cos:PutBucketPolicy',
- method: 'PUT',
- Bucket: params.Bucket,
- Region: params.Region,
- action: 'policy',
- body: PolicyStr,
- headers: headers,
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 获取 Bucket 的读取权限策略
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回数据
- */
- function getBucketPolicy(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetBucketPolicy',
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'policy',
- rawBody: true,
- },
- function (err, data) {
- if (err) {
- if (err.statusCode && err.statusCode === 403) {
- return callback(util.error(err, { ErrorStatus: 'Access Denied' }));
- }
- if (err.statusCode && err.statusCode === 405) {
- return callback(util.error(err, { ErrorStatus: 'Method Not Allowed' }));
- }
- if (err.statusCode && err.statusCode === 404) {
- return callback(util.error(err, { ErrorStatus: 'Policy Not Found' }));
- }
- return callback(err);
- }
- var Policy = {};
- try {
- Policy = JSON.parse(data.body);
- } catch (e) {}
- callback(null, {
- Policy: Policy,
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 删除 Bucket 的 跨域设置
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- */
- function deleteBucketPolicy(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:DeleteBucketPolicy',
- method: 'DELETE',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'policy',
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode || err.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 设置 Bucket 的标签
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Array} params.TagSet 标签设置,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回数据
- */
- function putBucketTagging(params, callback) {
- var Tagging = params['Tagging'] || {};
- var Tags = Tagging.TagSet || Tagging.Tags || params['Tags'] || [];
- Tags = util.clone(util.isArray(Tags) ? Tags : [Tags]);
- var xml = util.json2xml({ Tagging: { TagSet: { Tag: Tags } } });
- var headers = params.Headers;
- headers['Content-Type'] = 'application/xml';
- headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
- submitRequest.call(
- this,
- {
- Action: 'name/cos:PutBucketTagging',
- method: 'PUT',
- Bucket: params.Bucket,
- Region: params.Region,
- body: xml,
- action: 'tagging',
- headers: headers,
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 获取 Bucket 的标签设置
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回数据
- */
- function getBucketTagging(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetBucketTagging',
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'tagging',
- },
- function (err, data) {
- if (err) {
- if (err.statusCode === 404 && err.error && (err.error === 'Not Found' || err.error.Code === 'NoSuchTagSet')) {
- var result = {
- Tags: [],
- statusCode: err.statusCode,
- };
- err.headers && (result.headers = err.headers);
- callback(null, result);
- } else {
- callback(err);
- }
- return;
- }
- var Tags = [];
- try {
- Tags = data.Tagging.TagSet.Tag || [];
- } catch (e) {}
- Tags = util.clone(util.isArray(Tags) ? Tags : [Tags]);
- callback(null, {
- Tags: Tags,
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 删除 Bucket 的 标签设置
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- */
- function deleteBucketTagging(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:DeleteBucketTagging',
- method: 'DELETE',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'tagging',
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- function putBucketLifecycle(params, callback) {
- var LifecycleConfiguration = params['LifecycleConfiguration'] || {};
- var Rules = LifecycleConfiguration.Rules || params.Rules || [];
- Rules = util.clone(Rules);
- var xml = util.json2xml({ LifecycleConfiguration: { Rule: Rules } });
- var headers = params.Headers;
- headers['Content-Type'] = 'application/xml';
- headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
- submitRequest.call(
- this,
- {
- Action: 'name/cos:PutBucketLifecycle',
- method: 'PUT',
- Bucket: params.Bucket,
- Region: params.Region,
- body: xml,
- action: 'lifecycle',
- headers: headers,
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- function getBucketLifecycle(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetBucketLifecycle',
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'lifecycle',
- },
- function (err, data) {
- if (err) {
- if (err.statusCode === 404 && err.error && err.error.Code === 'NoSuchLifecycleConfiguration') {
- var result = {
- Rules: [],
- statusCode: err.statusCode,
- };
- err.headers && (result.headers = err.headers);
- callback(null, result);
- } else {
- callback(err);
- }
- return;
- }
- var Rules = [];
- try {
- Rules = data.LifecycleConfiguration.Rule || [];
- } catch (e) {}
- Rules = util.clone(util.isArray(Rules) ? Rules : [Rules]);
- callback(null, {
- Rules: Rules,
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- function deleteBucketLifecycle(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:DeleteBucketLifecycle',
- method: 'DELETE',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'lifecycle',
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- function putBucketVersioning(params, callback) {
- if (!params['VersioningConfiguration']) {
- callback(util.error(new Error('missing param VersioningConfiguration')));
- return;
- }
- var VersioningConfiguration = params['VersioningConfiguration'] || {};
- var xml = util.json2xml({ VersioningConfiguration: VersioningConfiguration });
- var headers = params.Headers;
- headers['Content-Type'] = 'application/xml';
- headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
- submitRequest.call(
- this,
- {
- Action: 'name/cos:PutBucketVersioning',
- method: 'PUT',
- Bucket: params.Bucket,
- Region: params.Region,
- body: xml,
- action: 'versioning',
- headers: headers,
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- function getBucketVersioning(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetBucketVersioning',
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'versioning',
- },
- function (err, data) {
- if (!err) {
- !data.VersioningConfiguration && (data.VersioningConfiguration = {});
- }
- callback(err, data);
- }
- );
- }
- function putBucketReplication(params, callback) {
- var ReplicationConfiguration = util.clone(params.ReplicationConfiguration);
- var xml = util.json2xml({ ReplicationConfiguration: ReplicationConfiguration });
- xml = xml.replace(/<(\/?)Rules>/gi, '<$1Rule>');
- xml = xml.replace(/<(\/?)Tags>/gi, '<$1Tag>');
- var headers = params.Headers;
- headers['Content-Type'] = 'application/xml';
- headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
- submitRequest.call(
- this,
- {
- Action: 'name/cos:PutBucketReplication',
- method: 'PUT',
- Bucket: params.Bucket,
- Region: params.Region,
- body: xml,
- action: 'replication',
- headers: headers,
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- function getBucketReplication(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetBucketReplication',
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'replication',
- },
- function (err, data) {
- if (err) {
- if (
- err.statusCode === 404 &&
- err.error &&
- (err.error === 'Not Found' || err.error.Code === 'ReplicationConfigurationnotFoundError')
- ) {
- var result = {
- ReplicationConfiguration: { Rules: [] },
- statusCode: err.statusCode,
- };
- err.headers && (result.headers = err.headers);
- callback(null, result);
- } else {
- callback(err);
- }
- return;
- }
- if (!err) {
- !data.ReplicationConfiguration && (data.ReplicationConfiguration = {});
- }
- if (data.ReplicationConfiguration.Rule) {
- data.ReplicationConfiguration.Rules = util.makeArray(data.ReplicationConfiguration.Rule);
- delete data.ReplicationConfiguration.Rule;
- }
- callback(err, data);
- }
- );
- }
- function deleteBucketReplication(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:DeleteBucketReplication',
- method: 'DELETE',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'replication',
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 设置 Bucket 静态网站配置信息
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Object} params.WebsiteConfiguration 地域名称,必须
- * @param {Object} WebsiteConfiguration.IndexDocument 索引文档,必须
- * @param {Object} WebsiteConfiguration.ErrorDocument 错误文档,非必须
- * @param {Object} WebsiteConfiguration.RedirectAllRequestsTo 重定向所有请求,非必须
- * @param {Array} params.RoutingRules 重定向规则,非必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回数据
- */
- function putBucketWebsite(params, callback) {
- if (!params['WebsiteConfiguration']) {
- callback(util.error(new Error('missing param WebsiteConfiguration')));
- return;
- }
- var WebsiteConfiguration = util.clone(params['WebsiteConfiguration'] || {});
- var RoutingRules = WebsiteConfiguration['RoutingRules'] || WebsiteConfiguration['RoutingRule'] || [];
- RoutingRules = util.isArray(RoutingRules) ? RoutingRules : [RoutingRules];
- delete WebsiteConfiguration.RoutingRule;
- delete WebsiteConfiguration.RoutingRules;
- if (RoutingRules.length) WebsiteConfiguration.RoutingRules = { RoutingRule: RoutingRules };
- var xml = util.json2xml({ WebsiteConfiguration: WebsiteConfiguration });
- var headers = params.Headers;
- headers['Content-Type'] = 'application/xml';
- headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
- submitRequest.call(
- this,
- {
- Action: 'name/cos:PutBucketWebsite',
- method: 'PUT',
- Bucket: params.Bucket,
- Region: params.Region,
- body: xml,
- action: 'website',
- headers: headers,
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 获取 Bucket 的静态网站配置信息
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回数据
- */
- function getBucketWebsite(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetBucketWebsite',
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- Key: params.Key,
- headers: params.Headers,
- action: 'website',
- },
- function (err, data) {
- if (err) {
- if (err.statusCode === 404 && err.error.Code === 'NoSuchWebsiteConfiguration') {
- var result = {
- WebsiteConfiguration: {},
- statusCode: err.statusCode,
- };
- err.headers && (result.headers = err.headers);
- callback(null, result);
- } else {
- callback(err);
- }
- return;
- }
- var WebsiteConfiguration = data.WebsiteConfiguration || {};
- if (WebsiteConfiguration['RoutingRules']) {
- var RoutingRules = util.clone(WebsiteConfiguration['RoutingRules'].RoutingRule || []);
- RoutingRules = util.makeArray(RoutingRules);
- WebsiteConfiguration.RoutingRules = RoutingRules;
- }
- callback(null, {
- WebsiteConfiguration: WebsiteConfiguration,
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 删除 Bucket 的静态网站配置
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回数据
- */
- function deleteBucketWebsite(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:DeleteBucketWebsite',
- method: 'DELETE',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'website',
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 设置 Bucket 的防盗链白名单或者黑名单
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Object} params.RefererConfiguration 地域名称,必须
- * @param {String} RefererConfiguration.Status 是否开启防盗链,枚举值:Enabled、Disabled
- * @param {String} RefererConfiguration.RefererType 防盗链类型,枚举值:Black-List、White-List,必须
- * @param {Array} RefererConfiguration.DomianList.Domain 生效域名,必须
- * @param {String} RefererConfiguration.EmptyReferConfiguration ,非必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回数据
- */
- function putBucketReferer(params, callback) {
- if (!params['RefererConfiguration']) {
- callback(util.error(new Error('missing param RefererConfiguration')));
- return;
- }
- var RefererConfiguration = util.clone(params['RefererConfiguration'] || {});
- var DomainList = RefererConfiguration['DomainList'] || {};
- var Domains = DomainList['Domains'] || DomainList['Domain'] || [];
- Domains = util.isArray(Domains) ? Domains : [Domains];
- if (Domains.length) RefererConfiguration.DomainList = { Domain: Domains };
- var xml = util.json2xml({ RefererConfiguration: RefererConfiguration });
- var headers = params.Headers;
- headers['Content-Type'] = 'application/xml';
- headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
- submitRequest.call(
- this,
- {
- Action: 'name/cos:PutBucketReferer',
- method: 'PUT',
- Bucket: params.Bucket,
- Region: params.Region,
- body: xml,
- action: 'referer',
- headers: headers,
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 获取 Bucket 的防盗链白名单或者黑名单
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回数据
- */
- function getBucketReferer(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetBucketReferer',
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- Key: params.Key,
- headers: params.Headers,
- action: 'referer',
- },
- function (err, data) {
- if (err) {
- if (err.statusCode === 404 && err.error.Code === 'NoSuchRefererConfiguration') {
- var result = {
- WebsiteConfiguration: {},
- statusCode: err.statusCode,
- };
- err.headers && (result.headers = err.headers);
- callback(null, result);
- } else {
- callback(err);
- }
- return;
- }
- var RefererConfiguration = data.RefererConfiguration || {};
- if (RefererConfiguration['DomainList']) {
- var Domains = util.makeArray(RefererConfiguration['DomainList'].Domain || []);
- RefererConfiguration.DomainList = { Domains: Domains };
- }
- callback(null, {
- RefererConfiguration: RefererConfiguration,
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 设置 Bucket 自定义域名
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回数据
- */
- function putBucketDomain(params, callback) {
- var DomainConfiguration = params['DomainConfiguration'] || {};
- var DomainRule = DomainConfiguration.DomainRule || params.DomainRule || [];
- DomainRule = util.clone(DomainRule);
- var xml = util.json2xml({ DomainConfiguration: { DomainRule: DomainRule } });
- var headers = params.Headers;
- headers['Content-Type'] = 'application/xml';
- headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
- submitRequest.call(
- this,
- {
- Action: 'name/cos:PutBucketDomain',
- method: 'PUT',
- Bucket: params.Bucket,
- Region: params.Region,
- body: xml,
- action: 'domain',
- headers: headers,
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 获取 Bucket 的自定义域名
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回数据
- */
- function getBucketDomain(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetBucketDomain',
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'domain',
- },
- function (err, data) {
- if (err) return callback(err);
- var DomainRule = [];
- try {
- DomainRule = data.DomainConfiguration.DomainRule || [];
- } catch (e) {}
- DomainRule = util.clone(util.isArray(DomainRule) ? DomainRule : [DomainRule]);
- callback(null, {
- DomainRule: DomainRule,
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 删除 Bucket 自定义域名
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回数据
- */
- function deleteBucketDomain(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:DeleteBucketDomain',
- method: 'DELETE',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'domain',
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 设置 Bucket 的回源
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回数据
- */
- function putBucketOrigin(params, callback) {
- var OriginConfiguration = params['OriginConfiguration'] || {};
- var OriginRule = OriginConfiguration.OriginRule || params.OriginRule || [];
- OriginRule = util.clone(OriginRule);
- var xml = util.json2xml({ OriginConfiguration: { OriginRule: OriginRule } });
- var headers = params.Headers;
- headers['Content-Type'] = 'application/xml';
- headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
- submitRequest.call(
- this,
- {
- Action: 'name/cos:PutBucketOrigin',
- method: 'PUT',
- Bucket: params.Bucket,
- Region: params.Region,
- body: xml,
- action: 'origin',
- headers: headers,
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 获取 Bucket 的回源
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回数据
- */
- function getBucketOrigin(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetBucketOrigin',
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'origin',
- },
- function (err, data) {
- if (err) return callback(err);
- var OriginRule = [];
- try {
- OriginRule = data.OriginConfiguration.OriginRule || [];
- } catch (e) {}
- OriginRule = util.clone(util.isArray(OriginRule) ? OriginRule : [OriginRule]);
- callback(null, {
- OriginRule: OriginRule,
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 删除 Bucket 的回源
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回数据
- */
- function deleteBucketOrigin(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:DeleteBucketOrigin',
- method: 'DELETE',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'origin',
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 设置 Bucket 的日志记录
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {(Object|String)} params.BucketLoggingStatus 说明日志记录配置的状态,如果无子节点信息则意为关闭日志记录,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回数据
- */
- function putBucketLogging(params, callback) {
- var xml = util.json2xml({
- BucketLoggingStatus: params['BucketLoggingStatus'] || '',
- });
- var headers = params.Headers;
- headers['Content-Type'] = 'application/xml';
- headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
- submitRequest.call(
- this,
- {
- Action: 'name/cos:PutBucketLogging',
- method: 'PUT',
- Bucket: params.Bucket,
- Region: params.Region,
- body: xml,
- action: 'logging',
- headers: headers,
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 获取 Bucket 的日志记录
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回数据
- */
- function getBucketLogging(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetBucketLogging',
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'logging',
- },
- function (err, data) {
- if (err) return callback(err);
- callback(null, {
- BucketLoggingStatus: data.BucketLoggingStatus,
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 创建/编辑 Bucket 的清单任务
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.Id 清单任务的名称,必须
- * @param {Object} params.InventoryConfiguration 包含清单的配置参数,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回数据
- */
- function putBucketInventory(params, callback) {
- var InventoryConfiguration = util.clone(params['InventoryConfiguration']);
- if (InventoryConfiguration.OptionalFields) {
- var Field = InventoryConfiguration.OptionalFields || [];
- InventoryConfiguration.OptionalFields = {
- Field: Field,
- };
- }
- if (
- InventoryConfiguration.Destination &&
- InventoryConfiguration.Destination.COSBucketDestination &&
- InventoryConfiguration.Destination.COSBucketDestination.Encryption
- ) {
- var Encryption = InventoryConfiguration.Destination.COSBucketDestination.Encryption;
- if (Object.keys(Encryption).indexOf('SSECOS') > -1) {
- Encryption['SSE-COS'] = Encryption['SSECOS'];
- delete Encryption['SSECOS'];
- }
- }
- var xml = util.json2xml({
- InventoryConfiguration: InventoryConfiguration,
- });
- var headers = params.Headers;
- headers['Content-Type'] = 'application/xml';
- headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
- submitRequest.call(
- this,
- {
- Action: 'name/cos:PutBucketInventory',
- method: 'PUT',
- Bucket: params.Bucket,
- Region: params.Region,
- body: xml,
- action: 'inventory',
- qs: {
- id: params['Id'],
- },
- headers: headers,
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 获取 Bucket 的清单任务信息
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.Id 清单任务的名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回数据
- */
- function getBucketInventory(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetBucketInventory',
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'inventory',
- qs: {
- id: params['Id'],
- },
- },
- function (err, data) {
- if (err) return callback(err);
- var InventoryConfiguration = data['InventoryConfiguration'];
- if (
- InventoryConfiguration &&
- InventoryConfiguration.OptionalFields &&
- InventoryConfiguration.OptionalFields.Field
- ) {
- var Field = InventoryConfiguration.OptionalFields.Field;
- if (!util.isArray(Field)) {
- Field = [Field];
- }
- InventoryConfiguration.OptionalFields = Field;
- }
- if (
- InventoryConfiguration.Destination &&
- InventoryConfiguration.Destination.COSBucketDestination &&
- InventoryConfiguration.Destination.COSBucketDestination.Encryption
- ) {
- var Encryption = InventoryConfiguration.Destination.COSBucketDestination.Encryption;
- if (Object.keys(Encryption).indexOf('SSE-COS') > -1) {
- Encryption['SSECOS'] = Encryption['SSE-COS'];
- delete Encryption['SSE-COS'];
- }
- }
- callback(null, {
- InventoryConfiguration: InventoryConfiguration,
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 获取 Bucket 的清单任务信息
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.ContinuationToken 当 COS 响应体中 IsTruncated 为 true,且 NextContinuationToken 节点中存在参数值时,您可以将这个参数作为 continuation-token 参数值,以获取下一页的清单任务信息,非必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回数据
- */
- function listBucketInventory(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:ListBucketInventory',
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'inventory',
- qs: {
- 'continuation-token': params['ContinuationToken'],
- },
- },
- function (err, data) {
- if (err) return callback(err);
- var ListInventoryConfigurationResult = data['ListInventoryConfigurationResult'];
- var InventoryConfigurations = ListInventoryConfigurationResult.InventoryConfiguration || [];
- InventoryConfigurations = util.isArray(InventoryConfigurations)
- ? InventoryConfigurations
- : [InventoryConfigurations];
- delete ListInventoryConfigurationResult['InventoryConfiguration'];
- util.each(InventoryConfigurations, function (InventoryConfiguration) {
- if (
- InventoryConfiguration &&
- InventoryConfiguration.OptionalFields &&
- InventoryConfiguration.OptionalFields.Field
- ) {
- var Field = InventoryConfiguration.OptionalFields.Field;
- if (!util.isArray(Field)) {
- Field = [Field];
- }
- InventoryConfiguration.OptionalFields = Field;
- }
- if (
- InventoryConfiguration.Destination &&
- InventoryConfiguration.Destination.COSBucketDestination &&
- InventoryConfiguration.Destination.COSBucketDestination.Encryption
- ) {
- var Encryption = InventoryConfiguration.Destination.COSBucketDestination.Encryption;
- if (Object.keys(Encryption).indexOf('SSE-COS') > -1) {
- Encryption['SSECOS'] = Encryption['SSE-COS'];
- delete Encryption['SSE-COS'];
- }
- }
- });
- ListInventoryConfigurationResult.InventoryConfigurations = InventoryConfigurations;
- util.extend(ListInventoryConfigurationResult, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- callback(null, ListInventoryConfigurationResult);
- }
- );
- }
- /**
- * 删除 Bucket 的清单任务
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.Id 清单任务的名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回数据
- */
- function deleteBucketInventory(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:DeleteBucketInventory',
- method: 'DELETE',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'inventory',
- qs: {
- id: params['Id'],
- },
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /* 全球加速 */
- function putBucketAccelerate(params, callback) {
- if (!params['AccelerateConfiguration']) {
- callback(util.error(new Error('missing param AccelerateConfiguration')));
- return;
- }
- var configuration = { AccelerateConfiguration: params.AccelerateConfiguration || {} };
- var xml = util.json2xml(configuration);
- var headers = {};
- headers['Content-Type'] = 'application/xml';
- headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
- submitRequest.call(
- this,
- {
- Action: 'name/cos:PutBucketAccelerate',
- method: 'PUT',
- Bucket: params.Bucket,
- Region: params.Region,
- body: xml,
- action: 'accelerate',
- headers: headers,
- },
- function (err, data) {
- if (err) return callback(err);
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- function getBucketAccelerate(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetBucketAccelerate',
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- action: 'accelerate',
- },
- function (err, data) {
- if (!err) {
- !data.AccelerateConfiguration && (data.AccelerateConfiguration = {});
- }
- callback(err, data);
- }
- );
- }
- function putBucketEncryption(params, callback) {
- var conf = params.ServerSideEncryptionConfiguration || {};
- var Rules = conf.Rule || conf.Rules || [];
- var xml = util.json2xml({ ServerSideEncryptionConfiguration: { Rule: Rules } });
- var headers = params.Headers;
- headers['Content-Type'] = 'application/xml';
- headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
- submitRequest.call(
- this,
- {
- Action: 'name/cos:PutBucketEncryption',
- method: 'PUT',
- Bucket: params.Bucket,
- Region: params.Region,
- body: xml,
- action: 'encryption',
- headers: headers,
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- function getBucketEncryption(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetBucketEncryption',
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'encryption',
- },
- function (err, data) {
- if (err) {
- if (err.statusCode === 404 && err.code === 'NoSuchEncryptionConfiguration') {
- var result = {
- EncryptionConfiguration: { Rules: [] },
- statusCode: err.statusCode,
- };
- err.headers && (result.headers = err.headers);
- callback(null, result);
- } else {
- callback(err);
- }
- return;
- }
- var Rules = util.makeArray((data.EncryptionConfiguration && data.EncryptionConfiguration.Rule) || []);
- data.EncryptionConfiguration = { Rules: Rules };
- callback(err, data);
- }
- );
- }
- function deleteBucketEncryption(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:DeleteBucketReplication',
- method: 'DELETE',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'encryption',
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- // Object 相关
- /**
- * 取回对应Object的元数据,Head的权限与Get的权限一致
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.Key 文件名称,必须
- * @param {String} params.IfModifiedSince 当Object在指定时间后被修改,则返回对应Object元信息,否则返回304,非必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 为指定 object 的元数据,如果设置了 IfModifiedSince ,且文件未修改,则返回一个对象,NotModified 属性为 true
- * @return {Boolean} data.NotModified 是否在 IfModifiedSince 时间点之后未修改该 object,则为 true
- */
- function headObject(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:HeadObject',
- method: 'HEAD',
- Bucket: params.Bucket,
- Region: params.Region,
- Key: params.Key,
- VersionId: params.VersionId,
- headers: params.Headers,
- },
- function (err, data) {
- if (err) {
- var statusCode = err.statusCode;
- if (params.Headers['If-Modified-Since'] && statusCode && statusCode === 304) {
- return callback(null, {
- NotModified: true,
- statusCode: statusCode,
- });
- }
- return callback(err);
- }
- data.ETag = util.attr(data.headers, 'etag', '');
- callback(null, data);
- }
- );
- }
- function listObjectVersions(params, callback) {
- var reqParams = {};
- reqParams['prefix'] = params['Prefix'] || '';
- reqParams['delimiter'] = params['Delimiter'];
- reqParams['key-marker'] = params['KeyMarker'];
- reqParams['version-id-marker'] = params['VersionIdMarker'];
- reqParams['max-keys'] = params['MaxKeys'];
- reqParams['encoding-type'] = params['EncodingType'];
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetBucketObjectVersions',
- ResourceKey: reqParams['prefix'],
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- qs: reqParams,
- action: 'versions',
- },
- function (err, data) {
- if (err) return callback(err);
- var ListVersionsResult = data.ListVersionsResult || {};
- var DeleteMarkers = ListVersionsResult.DeleteMarker || [];
- DeleteMarkers = util.isArray(DeleteMarkers) ? DeleteMarkers : [DeleteMarkers];
- var Versions = ListVersionsResult.Version || [];
- Versions = util.isArray(Versions) ? Versions : [Versions];
- var result = util.clone(ListVersionsResult);
- delete result.DeleteMarker;
- delete result.Version;
- util.extend(result, {
- DeleteMarkers: DeleteMarkers,
- Versions: Versions,
- statusCode: data.statusCode,
- headers: data.headers,
- });
- callback(null, result);
- }
- );
- }
- /**
- * 下载 object
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.Key 文件名称,必须
- * @param {WriteStream} params.Output 文件写入流,非必须
- * @param {String} params.IfModifiedSince 当Object在指定时间后被修改,则返回对应Object元信息,否则返回304,非必须
- * @param {String} params.IfUnmodifiedSince 如果文件修改时间早于或等于指定时间,才返回文件内容。否则返回 412 (precondition failed),非必须
- * @param {String} params.IfMatch 当 ETag 与指定的内容一致,才返回文件。否则返回 412 (precondition failed),非必须
- * @param {String} params.IfNoneMatch 当 ETag 与指定的内容不一致,才返回文件。否则返回304 (not modified),非必须
- * @param {String} params.ResponseContentType 设置返回头部中的 Content-Type 参数,非必须
- * @param {String} params.ResponseContentLanguage 设置返回头部中的 Content-Language 参数,非必须
- * @param {String} params.ResponseExpires 设置返回头部中的 Content-Expires 参数,非必须
- * @param {String} params.ResponseCacheControl 设置返回头部中的 Cache-Control 参数,非必须
- * @param {String} params.ResponseContentDisposition 设置返回头部中的 Content-Disposition 参数,非必须
- * @param {String} params.ResponseContentEncoding 设置返回头部中的 Content-Encoding 参数,非必须
- * @param {Function} callback 回调函数,必须
- * @param {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @param {Object} data 为对应的 object 数据,包括 body 和 headers
- */
- function getObject(params, callback) {
- if (this.options.ObjectKeySimplifyCheck) {
- // getObject 的 Key 需要格式化,避免调用成 getBucket
- var formatKey = util.simplifyPath(params.Key);
- if (formatKey === '/') {
- callback(util.error(new Error('The Getobject Key is illegal')));
- return;
- }
- }
- var reqParams = params.Query || {};
- var reqParamsStr = params.QueryString || '';
- reqParams['response-content-type'] = params['ResponseContentType'];
- reqParams['response-content-language'] = params['ResponseContentLanguage'];
- reqParams['response-expires'] = params['ResponseExpires'];
- reqParams['response-cache-control'] = params['ResponseCacheControl'];
- reqParams['response-content-disposition'] = params['ResponseContentDisposition'];
- reqParams['response-content-encoding'] = params['ResponseContentEncoding'];
- var BodyType;
- var self = this;
- var outputStream = params.Output;
- if (params.ReturnStream) {
- outputStream = new Stream.PassThrough();
- BodyType = 'stream';
- } else if (outputStream && typeof outputStream === 'string') {
- outputStream = fs.createWriteStream(outputStream);
- BodyType = 'stream';
- } else if (outputStream && typeof outputStream.pipe === 'function') {
- BodyType = 'stream';
- } else {
- BodyType = 'buffer';
- }
- var onProgress = params.onProgress;
- var onDownloadProgress = (function () {
- var time0 = Date.now();
- var size0 = 0;
- var FinishSize = 0;
- var FileSize = 0;
- var progressTimer;
- var update = function () {
- progressTimer = 0;
- if (onProgress && typeof onProgress === 'function') {
- var time1 = Date.now();
- var speed = parseInt(((FinishSize - size0) / ((time1 - time0) / 1000)) * 100) / 100 || 0;
- var percent = parseInt((FinishSize / FileSize) * 100) / 100 || 0;
- time0 = time1;
- size0 = FinishSize;
- try {
- onProgress({
- loaded: FinishSize,
- total: FileSize,
- speed: speed,
- percent: percent,
- });
- } catch (e) {}
- }
- };
- return function (info, immediately) {
- if (info && info.loaded) {
- FinishSize = info.loaded;
- FileSize = info.total;
- }
- if (immediately) {
- clearTimeout(progressTimer);
- update();
- } else {
- if (progressTimer) return;
- progressTimer = setTimeout(update, self.options.ProgressInterval || 1000);
- }
- };
- })();
- // 如果用户自己传入了 output
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetObject',
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- Key: params.Key,
- VersionId: params.VersionId,
- headers: params.Headers,
- qs: reqParams,
- qsStr: reqParamsStr,
- rawBody: true,
- outputStream: outputStream,
- onDownloadProgress: onDownloadProgress,
- },
- function (err, data) {
- onDownloadProgress(null, true);
- if (err) {
- var statusCode = err.statusCode;
- if (params.Headers['If-Modified-Since'] && statusCode && statusCode === 304) {
- return callback(null, { NotModified: true });
- }
- if (outputStream) outputStream.emit('error', err);
- return callback(err);
- }
- var result = {};
- if (data.body) {
- if (BodyType === 'buffer') {
- result.Body = Buffer.from(data.body);
- } else if (BodyType === 'string') {
- result.Body = data.body;
- }
- }
- util.extend(result, {
- ETag: util.attr(data.headers, 'etag', ''),
- statusCode: data.statusCode,
- headers: data.headers,
- });
- callback(null, result);
- }
- );
- if (params.ReturnStream) return outputStream;
- }
- function getObjectStream(params, callback) {
- params.ReturnStream = true;
- return getObject.call(this, params, callback);
- }
- /**
- * 上传 object
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.Key 文件名称,必须
- * @param {Buffer || ReadStream || String} params.Body 上传文件的内容或流或字符串
- * @param {String} params.CacheControl RFC 2616 中定义的缓存策略,将作为 Object 元数据保存,非必须
- * @param {String} params.ContentDisposition RFC 2616 中定义的文件名称,将作为 Object 元数据保存,非必须
- * @param {String} params.ContentEncoding RFC 2616 中定义的编码格式,将作为 Object 元数据保存,非必须
- * @param {String} params.ContentLength RFC 2616 中定义的 HTTP 请求内容长度(字节),必须
- * @param {String} params.ContentType RFC 2616 中定义的内容类型(MIME),将作为 Object 元数据保存,非必须
- * @param {String} params.Expect 当使用 Expect: 100-continue 时,在收到服务端确认后,才会发送请求内容,非必须
- * @param {String} params.Expires RFC 2616 中定义的过期时间,将作为 Object 元数据保存,非必须
- * @param {String} params.ACL 允许用户自定义文件权限,有效值:private | public-read,非必须
- * @param {String} params.GrantRead 赋予被授权者读取对象的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,非必须
- * @param {String} params.GrantReadAcp 赋予被授权者读取对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,非必须
- * @param {String} params.GrantWriteAcp 赋予被授权者写入对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,非必须
- * @param {String} params.GrantFullControl 赋予被授权者操作对象的所有权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,非必须
- * @param {String} params.StorageClass 设置对象的存储级别,枚举值:STANDARD、STANDARD_IA、ARCHIVE,默认值:STANDARD,非必须
- * @param {String} params.x-cos-meta-* 允许用户自定义的头部信息,将作为对象的元数据保存。大小限制2KB,非必须
- * @param {String} params.ContentSha1 RFC 3174 中定义的 160-bit 内容 SHA-1 算法校验,非必须
- * @param {String} params.ServerSideEncryption 支持按照指定的加密算法进行服务端数据加密,格式 x-cos-server-side-encryption: "AES256",非必须
- * @param {Function} params.onProgress 上传进度回调函数
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 为对应的 object 数据
- * @return {String} data.ETag 为对应上传文件的 ETag 值
- */
- function putObject(params, callback) {
- var self = this;
- var FileSize = params.ContentLength;
- var onProgress = util.throttleOnProgress.call(self, FileSize, params.onProgress);
- // 特殊处理 Cache-Control、Content-Type,避免代理更改这两个字段导致写入到 Object 属性里
- var headers = params.Headers;
- if (!headers['Cache-Control'] && !headers['cache-control']) {
- headers['Cache-Control'] = '';
- }
- util.getBodyMd5(self.options.UploadCheckContentMd5, params.Body, function (md5) {
- if (md5) params.Headers['Content-MD5'] = util.binaryBase64(md5);
- if (params.ContentLength !== undefined) {
- params.Headers['Content-Length'] = params.ContentLength;
- }
- onProgress(null, true); // 任务状态开始 uploading
- submitRequest.call(
- self,
- {
- Action: 'name/cos:PutObject',
- TaskId: params.TaskId,
- method: 'PUT',
- Bucket: params.Bucket,
- Region: params.Region,
- Key: params.Key,
- headers: params.Headers,
- qs: params.Query,
- body: params.Body,
- onProgress: onProgress,
- },
- function (err, data) {
- if (err) {
- onProgress(null, true);
- return callback(err);
- }
- onProgress({ loaded: FileSize, total: FileSize }, true);
- if (data) {
- var url = getUrl({
- ForcePathStyle: self.options.ForcePathStyle,
- protocol: self.options.Protocol,
- domain: self.options.Domain,
- bucket: params.Bucket,
- region: !self.options.UseAccelerate ? params.Region : 'accelerate',
- object: params.Key,
- });
- url = url.substr(url.indexOf('://') + 3);
- data.Location = url;
- if (data.headers && data.headers.etag) data.ETag = data.headers.etag;
- return callback(null, data);
- }
- callback(null, data);
- }
- );
- });
- }
- /**
- * 删除 object
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.Key object名称,必须
- * @param {Function} callback 回调函数,必须
- * @param {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @param {Object} data 删除操作成功之后返回的数据
- */
- function deleteObject(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:DeleteObject',
- method: 'DELETE',
- Bucket: params.Bucket,
- Region: params.Region,
- Key: params.Key,
- headers: params.Headers,
- VersionId: params.VersionId,
- },
- function (err, data) {
- if (err) {
- var statusCode = err.statusCode;
- if (statusCode && statusCode === 404) {
- return callback(null, { BucketNotFound: true, statusCode: statusCode });
- } else {
- return callback(err);
- }
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 获取 object 的 权限列表
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.Key object名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- * @return {Object} data.AccessControlPolicy 权限列表
- */
- function getObjectAcl(params, callback) {
- var reqParams = {};
- if (params.VersionId) {
- reqParams.versionId = params.VersionId;
- }
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetObjectACL',
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- Key: params.Key,
- headers: params.Headers,
- qs: reqParams,
- action: 'acl',
- },
- function (err, data) {
- if (err) return callback(err);
- var AccessControlPolicy = data.AccessControlPolicy || {};
- var Owner = AccessControlPolicy.Owner || {};
- var Grant = (AccessControlPolicy.AccessControlList && AccessControlPolicy.AccessControlList.Grant) || [];
- Grant = util.isArray(Grant) ? Grant : [Grant];
- var result = decodeAcl(AccessControlPolicy);
- delete result.GrantWrite;
- if (data.headers && data.headers['x-cos-acl']) {
- result.ACL = data.headers['x-cos-acl'];
- }
- result = util.extend(result, {
- Owner: Owner,
- Grants: Grant,
- statusCode: data.statusCode,
- headers: data.headers,
- });
- callback(null, result);
- }
- );
- }
- /**
- * 设置 object 的 权限列表
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.Key object名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- */
- function putObjectAcl(params, callback) {
- var headers = params.Headers;
- var xml = '';
- if (params['AccessControlPolicy']) {
- var AccessControlPolicy = util.clone(params['AccessControlPolicy'] || {});
- var Grants = AccessControlPolicy.Grants || AccessControlPolicy.Grant;
- Grants = util.isArray(Grants) ? Grants : [Grants];
- delete AccessControlPolicy.Grant;
- delete AccessControlPolicy.Grants;
- AccessControlPolicy.AccessControlList = { Grant: Grants };
- xml = util.json2xml({ AccessControlPolicy: AccessControlPolicy });
- headers['Content-Type'] = 'application/xml';
- headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
- }
- // Grant Header 去重
- util.each(headers, function (val, key) {
- if (key.indexOf('x-cos-grant-') === 0) {
- headers[key] = uniqGrant(headers[key]);
- }
- });
- submitRequest.call(
- this,
- {
- Action: 'name/cos:PutObjectACL',
- method: 'PUT',
- Bucket: params.Bucket,
- Region: params.Region,
- Key: params.Key,
- action: 'acl',
- headers: headers,
- body: xml,
- },
- function (err, data) {
- if (err) return callback(err);
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * Options Object请求实现跨域访问的预请求。即发出一个 OPTIONS 请求给服务器以确认是否可以进行跨域操作。
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.Key object名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- */
- function optionsObject(params, callback) {
- var headers = params.Headers;
- headers['Origin'] = params['Origin'];
- headers['Access-Control-Request-Method'] = params['AccessControlRequestMethod'];
- headers['Access-Control-Request-Headers'] = params['AccessControlRequestHeaders'];
- submitRequest.call(
- this,
- {
- Action: 'name/cos:OptionsObject',
- method: 'OPTIONS',
- Bucket: params.Bucket,
- Region: params.Region,
- Key: params.Key,
- headers: headers,
- },
- function (err, data) {
- if (err) {
- if (err.statusCode && err.statusCode === 403) {
- return callback(null, {
- OptionsForbidden: true,
- statusCode: err.statusCode,
- });
- }
- return callback(err);
- }
- var headers = data.headers || {};
- callback(null, {
- AccessControlAllowOrigin: headers['access-control-allow-origin'],
- AccessControlAllowMethods: headers['access-control-allow-methods'],
- AccessControlAllowHeaders: headers['access-control-allow-headers'],
- AccessControlExposeHeaders: headers['access-control-expose-headers'],
- AccessControlMaxAge: headers['access-control-max-age'],
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * @param {Object} 参数列表
- * @param {String} Bucket Bucket 名称
- * @param {String} Region 地域名称
- * @param {String} Key 文件名称
- * @param {String} CopySource 源文件URL绝对路径,可以通过versionid子资源指定历史版本
- * @param {String} ACL 允许用户自定义文件权限。有效值:private,public-read默认值:private。
- * @param {String} GrantRead 赋予被授权者读的权限,格式 x-cos-grant-read: uin=" ",uin=" ",当需要给子账户授权时,uin="RootAcountID/SubAccountID",当需要给根账户授权时,uin="RootAcountID"。
- * @param {String} GrantWrite 赋予被授权者写的权限,格式 x-cos-grant-write: uin=" ",uin=" ",当需要给子账户授权时,uin="RootAcountID/SubAccountID",当需要给根账户授权时,uin="RootAcountID"。
- * @param {String} GrantFullControl 赋予被授权者读写权限,格式 x-cos-grant-full-control: uin=" ",uin=" ",当需要给子账户授权时,uin="RootAcountID/SubAccountID",当需要给根账户授权时,uin="RootAcountID"。
- * @param {String} MetadataDirective 是否拷贝元数据,枚举值:Copy, Replaced,默认值Copy。假如标记为Copy,忽略Header中的用户元数据信息直接复制;假如标记为Replaced,按Header信息修改元数据。当目标路径和原路径一致,即用户试图修改元数据时,必须为Replaced
- * @param {String} CopySourceIfModifiedSince 当Object在指定时间后被修改,则执行操作,否则返回412。可与x-cos-copy-source-If-None-Match一起使用,与其他条件联合使用返回冲突。
- * @param {String} CopySourceIfUnmodifiedSince 当Object在指定时间后未被修改,则执行操作,否则返回412。可与x-cos-copy-source-If-Match一起使用,与其他条件联合使用返回冲突。
- * @param {String} CopySourceIfMatch 当Object的ETag和给定一致时,则执行操作,否则返回412。可与x-cos-copy-source-If-Unmodified-Since一起使用,与其他条件联合使用返回冲突。
- * @param {String} CopySourceIfNoneMatch 当Object的ETag和给定不一致时,则执行操作,否则返回412。可与x-cos-copy-source-If-Modified-Since一起使用,与其他条件联合使用返回冲突。
- * @param {String} StorageClass 存储级别,枚举值:存储级别,枚举值:Standard, Standard_IA,Archive;默认值:Standard
- * @param {String} CacheControl 指定所有缓存机制在整个请求/响应链中必须服从的指令。
- * @param {String} ContentDisposition MIME 协议的扩展,MIME 协议指示 MIME 用户代理如何显示附加的文件
- * @param {String} ContentEncoding HTTP 中用来对「采用何种编码格式传输正文」进行协定的一对头部字段
- * @param {String} ContentLength 设置响应消息的实体内容的大小,单位为字节
- * @param {String} ContentType RFC 2616 中定义的 HTTP 请求内容类型(MIME),例如text/plain
- * @param {String} Expect 请求的特定的服务器行为
- * @param {String} Expires 响应过期的日期和时间
- * @param {String} params.ServerSideEncryption 支持按照指定的加密算法进行服务端数据加密,格式 x-cos-server-side-encryption: "AES256",非必须
- * @param {String} ContentLanguage 指定内容语言
- * @param {String} x-cos-meta-* 允许用户自定义的头部信息,将作为 Object 元数据返回。大小限制2K。
- */
- function putObjectCopy(params, callback) {
- // 特殊处理 Cache-Control
- var headers = params.Headers;
- if (!headers['Cache-Control'] && !headers['cache-control']) headers['Cache-Control'] = '';
- var CopySource = params.CopySource || '';
- var m = util.getSourceParams.call(this, CopySource);
- if (!m) {
- callback(util.error(new Error('CopySource format error')));
- return;
- }
- var SourceBucket = m.Bucket;
- var SourceRegion = m.Region;
- var SourceKey = decodeURIComponent(m.Key);
- submitRequest.call(
- this,
- {
- Scope: [
- {
- action: 'name/cos:GetObject',
- bucket: SourceBucket,
- region: SourceRegion,
- prefix: SourceKey,
- },
- {
- action: 'name/cos:PutObject',
- bucket: params.Bucket,
- region: params.Region,
- prefix: params.Key,
- },
- ],
- method: 'PUT',
- Bucket: params.Bucket,
- Region: params.Region,
- Key: params.Key,
- VersionId: params.VersionId,
- headers: params.Headers,
- },
- function (err, data) {
- if (err) return callback(err);
- var result = util.clone(data.CopyObjectResult || {});
- util.extend(result, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- callback(null, result);
- }
- );
- }
- function uploadPartCopy(params, callback) {
- var CopySource = params.CopySource || '';
- var m = util.getSourceParams.call(this, CopySource);
- if (!m) {
- callback(util.error(new Error('CopySource format error')));
- return;
- }
- var SourceBucket = m.Bucket;
- var SourceRegion = m.Region;
- var SourceKey = decodeURIComponent(m.Key);
- submitRequest.call(
- this,
- {
- Scope: [
- {
- action: 'name/cos:GetObject',
- bucket: SourceBucket,
- region: SourceRegion,
- prefix: SourceKey,
- },
- {
- action: 'name/cos:PutObject',
- bucket: params.Bucket,
- region: params.Region,
- prefix: params.Key,
- },
- ],
- method: 'PUT',
- Bucket: params.Bucket,
- Region: params.Region,
- Key: params.Key,
- VersionId: params.VersionId,
- qs: {
- partNumber: params['PartNumber'],
- uploadId: params['UploadId'],
- },
- headers: params.Headers,
- },
- function (err, data) {
- if (err) return callback(err);
- var result = util.clone(data.CopyPartResult || {});
- util.extend(result, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- callback(null, result);
- }
- );
- }
- function deleteMultipleObject(params, callback) {
- var Objects = params.Objects || [];
- var Quiet = params.Quiet;
- Objects = util.isArray(Objects) ? Objects : [Objects];
- var xml = util.json2xml({ Delete: { Object: Objects, Quiet: Quiet || false } });
- var headers = params.Headers;
- headers['Content-Type'] = 'application/xml';
- headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
- var Scope = util.map(Objects, function (v) {
- return {
- action: 'name/cos:DeleteObject',
- bucket: params.Bucket,
- region: params.Region,
- prefix: v.Key,
- };
- });
- submitRequest.call(
- this,
- {
- Scope: Scope,
- method: 'POST',
- Bucket: params.Bucket,
- Region: params.Region,
- body: xml,
- action: 'delete',
- headers: headers,
- },
- function (err, data) {
- if (err) return callback(err);
- var DeleteResult = data.DeleteResult || {};
- var Deleted = DeleteResult.Deleted || [];
- var Errors = DeleteResult.Error || [];
- Deleted = util.isArray(Deleted) ? Deleted : [Deleted];
- Errors = util.isArray(Errors) ? Errors : [Errors];
- var result = util.clone(DeleteResult);
- util.extend(result, {
- Error: Errors,
- Deleted: Deleted,
- statusCode: data.statusCode,
- headers: data.headers,
- });
- callback(null, result);
- }
- );
- }
- function restoreObject(params, callback) {
- var headers = params.Headers;
- if (!params['RestoreRequest']) {
- callback(util.error(new Error('missing param RestoreRequest')));
- return;
- }
- var RestoreRequest = params.RestoreRequest || {};
- var xml = util.json2xml({ RestoreRequest: RestoreRequest });
- headers['Content-Type'] = 'application/xml';
- headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
- submitRequest.call(
- this,
- {
- Action: 'name/cos:RestoreObject',
- method: 'POST',
- Bucket: params.Bucket,
- Region: params.Region,
- Key: params.Key,
- VersionId: params.VersionId,
- body: xml,
- action: 'restore',
- headers: headers,
- },
- callback
- );
- }
- /**
- * 设置 Object 的标签
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Object名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Array} params.TagSet 标签设置,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/42998
- * @return {Object} data 返回数据
- */
- function putObjectTagging(params, callback) {
- var Tagging = params['Tagging'] || {};
- var Tags = Tagging.TagSet || Tagging.Tags || params['Tags'] || [];
- Tags = util.clone(util.isArray(Tags) ? Tags : [Tags]);
- var xml = util.json2xml({ Tagging: { TagSet: { Tag: Tags } } });
- var headers = params.Headers;
- headers['Content-Type'] = 'application/xml';
- headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
- submitRequest.call(
- this,
- {
- Action: 'name/cos:PutObjectTagging',
- method: 'PUT',
- Bucket: params.Bucket,
- Key: params.Key,
- Region: params.Region,
- body: xml,
- action: 'tagging',
- headers: headers,
- VersionId: params.VersionId,
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 获取 Object 的标签设置
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/42998
- * @return {Object} data 返回数据
- */
- function getObjectTagging(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetObjectTagging',
- method: 'GET',
- Key: params.Key,
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- action: 'tagging',
- VersionId: params.VersionId,
- },
- function (err, data) {
- if (err) {
- if (err.statusCode === 404 && err.error && (err.error === 'Not Found' || err.error.Code === 'NoSuchTagSet')) {
- var result = {
- Tags: [],
- statusCode: err.statusCode,
- };
- err.headers && (result.headers = err.headers);
- callback(null, result);
- } else {
- callback(err);
- }
- return;
- }
- var Tags = [];
- try {
- Tags = data.Tagging.TagSet.Tag || [];
- } catch (e) {}
- Tags = util.clone(util.isArray(Tags) ? Tags : [Tags]);
- callback(null, {
- Tags: Tags,
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 删除 Object 的 标签设置
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Object名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/42998
- * @return {Object} data 返回的数据
- */
- function deleteObjectTagging(params, callback) {
- submitRequest.call(
- this,
- {
- Action: 'name/cos:DeleteObjectTagging',
- method: 'DELETE',
- Bucket: params.Bucket,
- Region: params.Region,
- Key: params.Key,
- headers: params.Headers,
- action: 'tagging',
- VersionId: params.VersionId,
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- return callback(err);
- }
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 使用 SQL 语句从指定对象(CSV 格式或者 JSON 格式)中检索内容
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Object名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Object} params.SelectRequest 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/42998
- * @return {Object} data 返回的数据
- */
- function selectObjectContent(params, callback) {
- var SelectType = params['SelectType'];
- if (!SelectType) return callback(util.error(new Error('missing param SelectType')));
- var SelectRequest = params['SelectRequest'] || {};
- var xml = util.json2xml({ SelectRequest: SelectRequest });
- var headers = params.Headers;
- headers['Content-Type'] = 'application/xml';
- headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
- var outputStream;
- var selectResult = {};
- var SelectStream = require('./select-stream');
- if (params.ReturnStream && params.DataType === 'raw') {
- // 流 && raw 直接原样数据吐回
- outputStream = new Stream.PassThrough();
- } else {
- // 包含 params.ReturnStream || !params.ReturnStream
- outputStream = new SelectStream();
- outputStream.on('message:progress', function (progress) {
- if (typeof params.onProgress === 'function') params.onProgress(progress);
- });
- outputStream.on('message:stats', function (stats) {
- selectResult.stats = stats;
- });
- outputStream.on('message:error', function (error) {
- selectResult.error = error;
- });
- }
- submitRequest.call(
- this,
- {
- Action: 'name/cos:GetObject',
- method: 'POST',
- Bucket: params.Bucket,
- Region: params.Region,
- Key: params.Key,
- headers: params.Headers,
- action: 'select',
- qs: {
- 'select-type': params['SelectType'],
- },
- VersionId: params.VersionId,
- body: xml,
- rawBody: true,
- outputStream: outputStream,
- },
- function (err, data) {
- if (err && err.statusCode === 204) {
- return callback(null, { statusCode: err.statusCode });
- } else if (err) {
- if (outputStream) outputStream.emit('error', err);
- return callback(err);
- } else if (selectResult.error) {
- return callback(
- util.extend(selectResult.error, {
- statusCode: data.statusCode,
- headers: data.headers,
- })
- );
- }
- var result = {
- statusCode: data.statusCode,
- headers: data.headers,
- };
- // 只要流里有解析出 stats,就返回 Stats
- if (selectResult.stats) result.Stats = selectResult.stats;
- // 只要有 records,就返回 Payload
- if (selectResult.records) result.Payload = Buffer.concat(selectResult.records);
- callback(null, result);
- }
- );
- if (!params.ReturnStream && params.DataType !== 'raw') {
- selectResult.records = [];
- outputStream.pipe(
- new Stream.Writable({
- write: function (chunk, encoding, callback) {
- selectResult.records.push(chunk);
- callback();
- },
- writev: function (chunks, encoding, callback) {
- chunks.forEach(function (item) {
- selectResult.records.push(chunks);
- });
- callback();
- },
- })
- );
- outputStream.pipe(outputStream);
- }
- if (params.ReturnStream) return outputStream;
- }
- /**
- * 使用 SQL 语句从指定对象(CSV 格式或者 JSON 格式)中检索内容
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Object名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {Object} params.SelectRequest 地域名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/42998
- * @return {Object} data 返回的数据
- * @return {Object} Stream 返回值
- */
- function selectObjectContentStream(params, callback) {
- params.ReturnStream = true;
- return selectObjectContent.call(this, params, callback);
- }
- // 分块上传
- /**
- * 初始化分块上传
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.Key object名称,必须
- * @param {String} params.UploadId object名称,必须
- * @param {String} params.CacheControl RFC 2616 中定义的缓存策略,将作为 Object 元数据保存,非必须
- * @param {String} params.ContentDisposition RFC 2616 中定义的文件名称,将作为 Object 元数据保存 ,非必须
- * @param {String} params.ContentEncoding RFC 2616 中定义的编码格式,将作为 Object 元数据保存,非必须
- * @param {String} params.ContentType RFC 2616 中定义的内容类型(MIME),将作为 Object 元数据保存,非必须
- * @param {String} params.Expires RFC 2616 中定义的过期时间,将作为 Object 元数据保存,非必须
- * @param {String} params.ACL 允许用户自定义文件权限,非必须
- * @param {String} params.GrantRead 赋予被授权者读的权限 ,非必须
- * @param {String} params.GrantWrite 赋予被授权者写的权限 ,非必须
- * @param {String} params.GrantFullControl 赋予被授权者读写权限 ,非必须
- * @param {String} params.StorageClass 设置Object的存储级别,枚举值:Standard,Standard_IA,Archive,非必须
- * @param {String} params.ServerSideEncryption 支持按照指定的加密算法进行服务端数据加密,格式 x-cos-server-side-encryption: "AES256",非必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- */
- function multipartInit(params, callback) {
- // 特殊处理 Cache-Control
- var headers = params.Headers;
- // 特殊处理 Cache-Control、Content-Type
- if (!headers['Cache-Control'] && !headers['cache-control']) {
- headers['Cache-Control'] = '';
- }
- if (!headers['Content-Type'] && !headers['content-type']) {
- headers['Content-Type'] = (params.Body && params.Body.type) || '';
- }
- submitRequest.call(
- this,
- {
- Action: 'name/cos:InitiateMultipartUpload',
- method: 'POST',
- Bucket: params.Bucket,
- Region: params.Region,
- Key: params.Key,
- action: 'uploads',
- headers: params.Headers,
- qs: params.Query,
- },
- function (err, data) {
- if (err) return callback(err);
- data = util.clone(data || {});
- if (data && data.InitiateMultipartUploadResult) {
- return callback(
- null,
- util.extend(data.InitiateMultipartUploadResult, {
- statusCode: data.statusCode,
- headers: data.headers,
- })
- );
- }
- callback(null, data);
- }
- );
- }
- /**
- * 分块上传
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.Key object名称,必须
- * @param {Buffer || Stream || String} params.Body 上传文件对象或字符串
- * @param {String} params.ContentLength RFC 2616 中定义的 HTTP 请求内容长度(字节),非必须
- * @param {String} params.Expect 当使用 Expect: 100-continue 时,在收到服务端确认后,才会发送请求内容,非必须
- * @param {String} params.ServerSideEncryption 支持按照指定的加密算法进行服务端数据加密,格式 x-cos-server-side-encryption: "AES256",非必须
- * @param {String} params.ContentSha1 RFC 3174 中定义的 160-bit 内容 SHA-1 算法校验值,非必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- * @return {Object} data.ETag 返回的文件分块 sha1 值
- */
- function multipartUpload(params, callback) {
- var self = this;
- util.getFileSize('multipartUpload', params, function () {
- util.getBodyMd5(self.options.UploadCheckContentMd5, params.Body, function (md5) {
- if (md5) params.Headers['Content-MD5'] = util.binaryBase64(md5);
- submitRequest.call(
- self,
- {
- Action: 'name/cos:UploadPart',
- TaskId: params.TaskId,
- method: 'PUT',
- Bucket: params.Bucket,
- Region: params.Region,
- Key: params.Key,
- qs: {
- partNumber: params['PartNumber'],
- uploadId: params['UploadId'],
- },
- headers: params.Headers,
- onProgress: params.onProgress,
- body: params.Body || null,
- SwitchHost: params.SwitchHost,
- },
- function (err, data) {
- if (err) return callback(err);
- callback(null, {
- ETag: util.attr(data.headers, 'etag', ''),
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- });
- });
- }
- /**
- * 完成分块上传
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.Key object名称,必须
- * @param {Array} params.Parts 分块信息列表,必须
- * @param {String} params.Parts[i].PartNumber 块编号,必须
- * @param {String} params.Parts[i].ETag 分块的 sha1 校验值
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- * @return {Object} data.CompleteMultipartUpload 完成分块上传后的文件信息,包括Location, Bucket, Key 和 ETag
- */
- function multipartComplete(params, callback) {
- var self = this;
- var UploadId = params.UploadId;
- var Parts = params['Parts'];
- for (var i = 0, len = Parts.length; i < len; i++) {
- if (Parts[i]['ETag'].indexOf('"') === 0) {
- continue;
- }
- Parts[i]['ETag'] = '"' + Parts[i]['ETag'] + '"';
- }
- var xml = util.json2xml({ CompleteMultipartUpload: { Part: Parts } });
- // CSP/ceph CompleteMultipartUpload 接口 body 写死了限制 1MB,这里醉倒 10000 片时,xml 字符串去掉空格853KB
- xml = xml.replace(/\n\s*/g, '');
- var headers = params.Headers;
- headers['Content-Type'] = 'application/xml';
- headers['Content-MD5'] = util.binaryBase64(util.md5(xml));
- submitRequest.call(
- this,
- {
- Action: 'name/cos:CompleteMultipartUpload',
- method: 'POST',
- Bucket: params.Bucket,
- Region: params.Region,
- Key: params.Key,
- qs: {
- uploadId: UploadId,
- },
- body: xml,
- headers: headers,
- },
- function (err, data) {
- if (err) return callback(err);
- var url = getUrl({
- ForcePathStyle: self.options.ForcePathStyle,
- protocol: self.options.Protocol,
- domain: self.options.Domain,
- bucket: params.Bucket,
- region: !self.options.UseAccelerate ? params.Region : 'accelerate',
- object: params.Key,
- isLocation: true,
- });
- var res = data.CompleteMultipartUploadResult || {};
- if (res.ProcessResults) {
- if (res && res.ProcessResults) {
- res.UploadResult = {
- OriginalInfo: {
- Key: res.Key,
- Location: url,
- ETag: res.ETag,
- ImageInfo: res.ImageInfo,
- },
- ProcessResults: res.ProcessResults,
- };
- delete res.ImageInfo;
- delete res.ProcessResults;
- }
- }
- var result = util.extend(res, {
- Location: url,
- statusCode: data.statusCode,
- headers: data.headers,
- });
- callback(null, result);
- }
- );
- }
- /**
- * 分块上传任务列表查询
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.Delimiter 定界符为一个符号,如果有Prefix,则将Prefix到delimiter之间的相同路径归为一类,定义为Common Prefix,然后列出所有Common Prefix。如果没有Prefix,则从路径起点开始,非必须
- * @param {String} params.EncodingType 规定返回值的编码方式,非必须
- * @param {String} params.Prefix 前缀匹配,用来规定返回的文件前缀地址,非必须
- * @param {String} params.MaxUploads 单次返回最大的条目数量,默认1000,非必须
- * @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的条目将被列出,非必须
- * @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的条目将被列出,非必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- * @return {Object} data.ListMultipartUploadsResult 分块上传任务信息
- */
- function multipartList(params, callback) {
- var reqParams = {};
- reqParams['delimiter'] = params['Delimiter'];
- reqParams['encoding-type'] = params['EncodingType'];
- reqParams['prefix'] = params['Prefix'] || '';
- reqParams['max-uploads'] = params['MaxUploads'];
- reqParams['key-marker'] = params['KeyMarker'];
- reqParams['upload-id-marker'] = params['UploadIdMarker'];
- reqParams = util.clearKey(reqParams);
- submitRequest.call(
- this,
- {
- Action: 'name/cos:ListMultipartUploads',
- ResourceKey: reqParams['prefix'],
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- headers: params.Headers,
- qs: reqParams,
- action: 'uploads',
- },
- function (err, data) {
- if (err) return callback(err);
- if (data && data.ListMultipartUploadsResult) {
- var Upload = data.ListMultipartUploadsResult.Upload || [];
- Upload = util.isArray(Upload) ? Upload : [Upload];
- data.ListMultipartUploadsResult.Upload = Upload;
- }
- var result = util.clone(data.ListMultipartUploadsResult || {});
- util.extend(result, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- callback(null, result);
- }
- );
- }
- /**
- * 上传的分块列表查询
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.Key object名称,必须
- * @param {String} params.UploadId 标示本次分块上传的ID,必须
- * @param {String} params.EncodingType 规定返回值的编码方式,非必须
- * @param {String} params.MaxParts 单次返回最大的条目数量,默认1000,非必须
- * @param {String} params.PartNumberMarker 默认以UTF-8二进制顺序列出条目,所有列出条目从marker开始,非必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- * @return {Object} data.ListMultipartUploadsResult 分块信息
- */
- function multipartListPart(params, callback) {
- var reqParams = {};
- reqParams['uploadId'] = params['UploadId'];
- reqParams['encoding-type'] = params['EncodingType'];
- reqParams['max-parts'] = params['MaxParts'];
- reqParams['part-number-marker'] = params['PartNumberMarker'];
- submitRequest.call(
- this,
- {
- Action: 'name/cos:ListParts',
- method: 'GET',
- Bucket: params.Bucket,
- Region: params.Region,
- Key: params.Key,
- headers: params.Headers,
- qs: reqParams,
- },
- function (err, data) {
- if (err) return callback(err);
- var ListPartsResult = data.ListPartsResult || {};
- var Part = ListPartsResult.Part || [];
- Part = util.isArray(Part) ? Part : [Part];
- ListPartsResult.Part = Part;
- var result = util.clone(ListPartsResult);
- util.extend(result, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- callback(null, result);
- }
- );
- }
- /**
- * 抛弃分块上传
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.Key object名称,必须
- * @param {String} params.UploadId 标示本次分块上传的ID,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- */
- function multipartAbort(params, callback) {
- var reqParams = {};
- reqParams['uploadId'] = params['UploadId'];
- submitRequest.call(
- this,
- {
- Action: 'name/cos:AbortMultipartUpload',
- method: 'DELETE',
- Bucket: params.Bucket,
- Region: params.Region,
- Key: params.Key,
- headers: params.Headers,
- qs: reqParams,
- },
- function (err, data) {
- if (err) return callback(err);
- callback(null, {
- statusCode: data.statusCode,
- headers: data.headers,
- });
- }
- );
- }
- /**
- * 追加上传
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.Key object名称,必须
- * @param {{Buffer || ReadStream || String}} params.Body 上传文件对象或字符串
- * @param {Number} params.Position 追加操作的起始点,单位为字节,必须
- * @param {String} params.CacheControl RFC 2616 中定义的缓存策略,将作为 Object 元数据保存,非必须
- * @param {String} params.ContentDisposition RFC 2616 中定义的文件名称,将作为 Object 元数据保存,非必须
- * @param {String} params.ContentEncoding RFC 2616 中定义的编码格式,将作为 Object 元数据保存,非必须
- * @param {String} params.ContentLength RFC 2616 中定义的 HTTP 请求内容长度(字节),必须
- * @param {String} params.ContentType RFC 2616 中定义的内容类型(MIME),将作为 Object 元数据保存,非必须
- * @param {String} params.Expect 当使用 Expect: 100-continue 时,在收到服务端确认后,才会发送请求内容,非必须
- * @param {String} params.Expires RFC 2616 中定义的过期时间,将作为 Object 元数据保存,非必须
- * @param {String} params.ACL 允许用户自定义文件权限,有效值:private | public-read,非必须
- * @param {String} params.GrantRead 赋予被授权者读取对象的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,非必须
- * @param {String} params.GrantReadAcp 赋予被授权者读取对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,非必须
- * @param {String} params.GrantWriteAcp 赋予被授权者写入对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,非必须
- * @param {String} params.GrantFullControl 赋予被授权者操作对象的所有权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,非必须
- * @param {String} params.StorageClass 设置对象的存储级别,枚举值:STANDARD、STANDARD_IA、ARCHIVE,默认值:STANDARD,非必须
- * @param {String} params.x-cos-meta-* 允许用户自定义的头部信息,将作为对象的元数据保存。大小限制2KB,非必须
- * @param {String} params.ContentSha1 RFC 3174 中定义的 160-bit 内容 SHA-1 算法校验,非必须
- * @param {String} params.ServerSideEncryption 支持按照指定的加密算法进行服务端数据加密,格式 x-cos-server-side-encryption: "AES256",非必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- */
- function appendObject(params, callback) {
- // 特殊处理 Cache-Control、Content-Type,避免代理更改这两个字段导致写入到 Object 属性里
- var headers = params.Headers;
- if (!headers['Cache-Control'] && !headers['cache-control']) headers['Cache-Control'] = '';
- submitRequest.call(
- this,
- {
- Action: 'name/cos:AppendObject',
- method: 'POST',
- Bucket: params.Bucket,
- Region: params.Region,
- action: 'append',
- Key: params.Key,
- body: params.Body,
- qs: {
- position: params.Position,
- },
- headers: params.Headers,
- },
- function (err, data) {
- if (err) return callback(err);
- callback(null, data);
- }
- );
- }
- /**
- * cos 内置请求
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.Key object名称,必须
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- */
- function request(params, callback) {
- var Query = params.Query || {};
- // 处理 url
- if (params.Url) {
- var m = params.Url.match(/^https?:\/\/([^/]+)(\/[^?#]*)?(\?[^#]*)?(#.*)?$/);
- var urlPath = (m && m[2]) || '';
- if (urlPath && !params.Key) params.Key = urlPath.substr(1);
- }
- submitRequest.call(
- this,
- {
- method: params.Method,
- Bucket: params.Bucket,
- Region: params.Region,
- Key: params.Key,
- action: params.Action,
- headers: params.Headers,
- qs: Query,
- body: params.Body,
- url: params.Url,
- rawBody: params.RawBody,
- },
- function (err, data) {
- if (err) return callback(err);
- if (data && data.body) {
- data.Body = data.body;
- delete data.body;
- }
- callback(err, data);
- }
- );
- }
- /**
- * 获取签名
- * @param {Object} params 参数对象,必须
- * @param {String} params.Method 请求方法,必须
- * @param {String} params.Key object名称,必须
- * @param {String} params.Expires 名超时时间,单位秒,可选
- * @return {String} data 返回签名字符串
- */
- function getAuth(params) {
- var self = this;
- return util.getAuth({
- SecretId: params.SecretId || this.options.SecretId || '',
- SecretKey: params.SecretKey || this.options.SecretKey || '',
- Bucket: params.Bucket,
- Region: params.Region,
- Method: params.Method,
- Key: params.Key,
- Query: params.Query,
- Headers: params.Headers,
- Expires: params.Expires,
- UseRawKey: self.options.UseRawKey,
- SystemClockOffset: self.options.SystemClockOffset,
- });
- }
- function getV4Auth(params) {
- return util.getV4Auth({
- SecretId: params.SecretId || this.options.SecretId || '',
- SecretKey: params.SecretKey || this.options.SecretKey || '',
- Bucket: params.Bucket,
- Key: params.Key,
- Expires: params.Expires,
- });
- }
- /**
- * 获取文件下载链接
- * @param {Object} params 参数对象,必须
- * @param {String} params.Bucket Bucket名称,必须
- * @param {String} params.Region 地域名称,必须
- * @param {String} params.Key object名称,必须
- * @param {String} params.Method 请求的方法,可选
- * @param {String} params.Expires 签名超时时间,单位秒,可选
- * @param {Function} callback 回调函数,必须
- * @return {Object} err 请求失败的错误,如果请求成功,则为空。https://cloud.tencent.com/document/product/436/7730
- * @return {Object} data 返回的数据
- */
- function getObjectUrl(params, callback) {
- var self = this;
- var useAccelerate = params.UseAccelerate === undefined ? self.options.UseAccelerate : params.UseAccelerate;
- var url = getUrl({
- ForcePathStyle: self.options.ForcePathStyle,
- protocol: params.Protocol || self.options.Protocol,
- domain: params.Domain || self.options.Domain,
- bucket: params.Bucket,
- region: useAccelerate ? 'accelerate' : params.Region,
- object: params.Key,
- });
- var queryParamsStr = '';
- if (params.Query) {
- queryParamsStr += util.obj2str(params.Query);
- }
- if (params.QueryString) {
- queryParamsStr += (queryParamsStr ? '&' : '') + params.QueryString;
- }
- var syncUrl = url;
- if (params.Sign !== undefined && !params.Sign) {
- queryParamsStr && (syncUrl += '?' + queryParamsStr);
- callback(null, { Url: syncUrl });
- return syncUrl;
- }
- // 签名加上 Host,避免跨桶访问
- var SignHost = getSignHost.call(this, {
- Bucket: params.Bucket,
- Region: params.Region,
- UseAccelerate: params.UseAccelerate,
- Url: url,
- });
- var AuthData = getAuthorizationAsync.call(
- this,
- {
- Action: (params.Method || '').toUpperCase() === 'PUT' ? 'name/cos:PutObject' : 'name/cos:GetObject',
- Bucket: params.Bucket || '',
- Region: params.Region || '',
- Method: params.Method || 'get',
- Key: params.Key,
- Expires: params.Expires,
- Headers: params.Headers,
- Query: params.Query,
- SignHost: SignHost,
- ForceSignHost: params.ForceSignHost === false ? false : self.options.ForceSignHost, // getObjectUrl支持传参ForceSignHost
- },
- function (err, AuthData) {
- if (!callback) return;
- if (err) {
- callback(err);
- return;
- }
- // 兼容万象url qUrlParamList需要再encode一次
- var replaceUrlParamList = function (url) {
- var urlParams = url.match(/q-url-param-list.*?(?=&)/g)[0];
- var encodedParams =
- 'q-url-param-list=' + encodeURIComponent(urlParams.replace(/q-url-param-list=/, '')).toLowerCase();
- var reg = new RegExp(urlParams, 'g');
- var replacedUrl = url.replace(reg, encodedParams);
- return replacedUrl;
- };
- var signUrl = url;
- signUrl +=
- '?' +
- (AuthData.Authorization.indexOf('q-signature') > -1
- ? replaceUrlParamList(AuthData.Authorization)
- : 'sign=' + encodeURIComponent(AuthData.Authorization));
- AuthData.SecurityToken && (signUrl += '&x-cos-security-token=' + AuthData.SecurityToken);
- AuthData.ClientIP && (signUrl += '&clientIP=' + AuthData.ClientIP);
- AuthData.ClientUA && (signUrl += '&clientUA=' + AuthData.ClientUA);
- AuthData.Token && (signUrl += '&token=' + AuthData.Token);
- queryParamsStr && (signUrl += '&' + queryParamsStr);
- setTimeout(function () {
- callback(null, { Url: signUrl });
- });
- }
- );
- if (AuthData) {
- syncUrl +=
- '?' + AuthData.Authorization + (AuthData.SecurityToken ? '&x-cos-security-token=' + AuthData.SecurityToken : '');
- queryParamsStr && (syncUrl += '&' + queryParamsStr);
- } else {
- queryParamsStr && (syncUrl += '?' + queryParamsStr);
- }
- return syncUrl;
- }
- /**
- * 私有方法
- */
- function decodeAcl(AccessControlPolicy) {
- var result = {
- GrantFullControl: [],
- GrantWrite: [],
- GrantRead: [],
- GrantReadAcp: [],
- GrantWriteAcp: [],
- ACL: '',
- };
- var GrantMap = {
- FULL_CONTROL: 'GrantFullControl',
- WRITE: 'GrantWrite',
- READ: 'GrantRead',
- READ_ACP: 'GrantReadAcp',
- WRITE_ACP: 'GrantWriteAcp',
- };
- var AccessControlList = (AccessControlPolicy && AccessControlPolicy.AccessControlList) || {};
- var Grant = AccessControlList.Grant;
- if (Grant) {
- Grant = util.isArray(Grant) ? Grant : [Grant];
- }
- var PublicAcl = { READ: 0, WRITE: 0, FULL_CONTROL: 0 };
- Grant &&
- Grant.length &&
- util.each(Grant, function (item) {
- if (
- item.Grantee.ID === 'qcs::cam::anyone:anyone' ||
- item.Grantee.URI === 'http://cam.qcloud.com/groups/global/AllUsers'
- ) {
- PublicAcl[item.Permission] = 1;
- } else if (item.Grantee.ID !== AccessControlPolicy.Owner.ID) {
- result[GrantMap[item.Permission]].push('id="' + item.Grantee.ID + '"');
- }
- });
- if (PublicAcl.FULL_CONTROL || (PublicAcl.WRITE && PublicAcl.READ)) {
- result.ACL = 'public-read-write';
- } else if (PublicAcl.READ) {
- result.ACL = 'public-read';
- } else {
- result.ACL = 'private';
- }
- util.each(GrantMap, function (item) {
- result[item] = uniqGrant(result[item].join(','));
- });
- return result;
- }
- // Grant 去重
- function uniqGrant(str) {
- var arr = str.split(',');
- var exist = {};
- var i, item;
- for (i = 0; i < arr.length; ) {
- item = arr[i].trim();
- if (exist[item]) {
- arr.splice(i, 1);
- } else {
- exist[item] = true;
- arr[i] = item;
- i++;
- }
- }
- return arr.join(',');
- }
- // 生成操作 url
- function getUrl(params) {
- var longBucket = params.bucket;
- var shortBucket = longBucket.substr(0, longBucket.lastIndexOf('-'));
- var appId = longBucket.substr(longBucket.lastIndexOf('-') + 1);
- var domain = params.domain;
- var region = params.region;
- var object = params.object;
- // 兼容不带冒号的http、https
- if (['http', 'https'].includes(params.protocol)) {
- params.protocol = params.protocol + ':';
- }
- var protocol = params.protocol || (util.isBrowser && location.protocol === 'http:' ? 'http:' : 'https:');
- if (!domain) {
- if (['cn-south', 'cn-south-2', 'cn-north', 'cn-east', 'cn-southwest', 'sg'].indexOf(region) > -1) {
- domain = '{Region}.myqcloud.com';
- } else {
- domain = 'cos.{Region}.myqcloud.com';
- }
- if (!params.ForcePathStyle) {
- domain = '{Bucket}.' + domain;
- }
- }
- domain = domain
- .replace(/\{\{AppId\}\}/gi, appId)
- .replace(/\{\{Bucket\}\}/gi, shortBucket)
- .replace(/\{\{Region\}\}/gi, region)
- .replace(/\{\{.*?\}\}/gi, '');
- domain = domain
- .replace(/\{AppId\}/gi, appId)
- .replace(/\{BucketName\}/gi, shortBucket)
- .replace(/\{Bucket\}/gi, longBucket)
- .replace(/\{Region\}/gi, region)
- .replace(/\{.*?\}/gi, '');
- if (!/^[a-zA-Z]+:\/\//.test(domain)) {
- domain = protocol + '//' + domain;
- }
- // 去掉域名最后的斜杆
- if (domain.slice(-1) === '/') {
- domain = domain.slice(0, -1);
- }
- var url = domain;
- if (params.ForcePathStyle) {
- url += '/' + longBucket;
- }
- url += '/';
- if (object) {
- url += util.camSafeUrlEncode(object).replace(/%2F/g, '/');
- }
- if (params.isLocation) {
- url = url.replace(/^https?:\/\//, '');
- }
- return url;
- }
- var getSignHost = function (opt) {
- // Url 或 Bucket+Region 至少传一个
- var paramsCompleted = opt.Url || (opt.Bucket && opt.Region);
- if (!paramsCompleted) return '';
- var useAccelerate = opt.UseAccelerate === undefined ? this.options.UseAccelerate : opt.UseAccelerate;
- var url =
- opt.Url ||
- getUrl({
- ForcePathStyle: this.options.ForcePathStyle,
- protocol: this.options.Protocol,
- domain: this.options.Domain,
- bucket: opt.Bucket,
- region: useAccelerate ? 'accelerate' : opt.Region,
- });
- var urlHost = url.replace(/^https?:\/\/([^/]+)(\/.*)?$/, '$1');
- return urlHost;
- };
- // 异步获取签名
- function getAuthorizationAsync(params, callback) {
- var headers = util.clone(params.Headers);
- var headerHost = '';
- util.each(headers, function (v, k) {
- (v === '' || ['content-type', 'cache-control'].indexOf(k.toLowerCase()) > -1) && delete headers[k];
- if (k.toLowerCase() === 'host') headerHost = v;
- });
- // ForceSignHost明确传入false才不加入host签名
- var forceSignHost = params.ForceSignHost === false ? false : true;
- // Host 加入签名计算
- if (!headerHost && params.SignHost && forceSignHost) headers.Host = params.SignHost;
- // 获取凭证的回调,避免用户 callback 多次
- var cbDone = false;
- var cb = function (err, AuthData) {
- if (cbDone) return;
- cbDone = true;
- if (AuthData && AuthData.XCosSecurityToken && !AuthData.SecurityToken) {
- AuthData = util.clone(AuthData);
- AuthData.SecurityToken = AuthData.XCosSecurityToken;
- delete AuthData.XCosSecurityToken;
- }
- callback && callback(err, AuthData);
- };
- var self = this;
- var Bucket = params.Bucket || '';
- var Region = params.Region || '';
- // PathName
- var KeyName = params.Key || '';
- if (self.options.ForcePathStyle && Bucket) {
- KeyName = Bucket + '/' + KeyName;
- }
- var Pathname = '/' + KeyName;
- // Action、ResourceKey
- var StsData = {};
- var Scope = params.Scope;
- if (!Scope) {
- var Action = params.Action || '';
- var ResourceKey = params.ResourceKey || params.Key || '';
- Scope = params.Scope || [
- {
- action: Action,
- bucket: Bucket,
- region: Region,
- prefix: ResourceKey,
- },
- ];
- }
- var ScopeKey = util.md5(JSON.stringify(Scope));
- // STS
- self._StsCache = self._StsCache || [];
- (function () {
- var i, AuthData;
- for (i = self._StsCache.length - 1; i >= 0; i--) {
- AuthData = self._StsCache[i];
- var compareTime = Math.round(util.getSkewTime(self.options.SystemClockOffset) / 1000) + 30;
- if ((AuthData.StartTime && compareTime < AuthData.StartTime) || compareTime >= AuthData.ExpiredTime) {
- self._StsCache.splice(i, 1);
- continue;
- }
- if (!AuthData.ScopeLimit || (AuthData.ScopeLimit && AuthData.ScopeKey === ScopeKey)) {
- StsData = AuthData;
- break;
- }
- }
- })();
- var calcAuthByTmpKey = function () {
- var KeyTime = '';
- if (StsData.StartTime && params.Expires) {
- KeyTime = StsData.StartTime + ';' + (StsData.StartTime + params.Expires * 1);
- } else if (StsData.StartTime && StsData.ExpiredTime) {
- KeyTime = StsData.StartTime + ';' + StsData.ExpiredTime;
- }
- var Authorization = util.getAuth({
- SecretId: StsData.TmpSecretId,
- SecretKey: StsData.TmpSecretKey,
- Method: params.Method,
- Pathname: Pathname,
- Query: params.Query,
- Headers: headers,
- Expires: params.Expires,
- UseRawKey: self.options.UseRawKey,
- SystemClockOffset: self.options.SystemClockOffset,
- KeyTime: KeyTime,
- ForceSignHost: forceSignHost,
- });
- var AuthData = {
- Authorization: Authorization,
- SecurityToken: StsData.SecurityToken || StsData.XCosSecurityToken || '',
- Token: StsData.Token || '',
- ClientIP: StsData.ClientIP || '',
- ClientUA: StsData.ClientUA || '',
- SignFrom: 'client',
- };
- cb(null, AuthData);
- };
- var checkAuthError = function (AuthData) {
- if (AuthData.Authorization) {
- // 检查签名格式
- var formatAllow = false;
- var auth = AuthData.Authorization;
- if (auth) {
- if (auth.indexOf(' ') > -1) {
- formatAllow = false;
- } else if (
- auth.indexOf('q-sign-algorithm=') > -1 &&
- auth.indexOf('q-ak=') > -1 &&
- auth.indexOf('q-sign-time=') > -1 &&
- auth.indexOf('q-key-time=') > -1 &&
- auth.indexOf('q-url-param-list=') > -1
- ) {
- formatAllow = true;
- } else {
- try {
- auth = Buffer.from(auth, 'base64').toString();
- if (
- auth.indexOf('a=') > -1 &&
- auth.indexOf('k=') > -1 &&
- auth.indexOf('t=') > -1 &&
- auth.indexOf('r=') > -1 &&
- auth.indexOf('b=') > -1
- ) {
- formatAllow = true;
- }
- } catch (e) {}
- }
- }
- if (!formatAllow) return util.error(new Error('getAuthorization callback params format error'));
- } else {
- if (!AuthData.TmpSecretId) return util.error(new Error('getAuthorization callback params missing "TmpSecretId"'));
- if (!AuthData.TmpSecretKey)
- return util.error(new Error('getAuthorization callback params missing "TmpSecretKey"'));
- if (!AuthData.SecurityToken && !AuthData.XCosSecurityToken)
- return util.error(new Error('getAuthorization callback params missing "SecurityToken"'));
- if (!AuthData.ExpiredTime) return util.error(new Error('getAuthorization callback params missing "ExpiredTime"'));
- if (AuthData.ExpiredTime && AuthData.ExpiredTime.toString().length !== 10)
- return util.error(new Error('getAuthorization callback params "ExpiredTime" should be 10 digits'));
- if (AuthData.StartTime && AuthData.StartTime.toString().length !== 10)
- return util.error(new Error('getAuthorization callback params "StartTime" should be 10 StartTime'));
- }
- return false;
- };
- // 先判断是否有临时密钥
- if (StsData.ExpiredTime && StsData.ExpiredTime - util.getSkewTime(self.options.SystemClockOffset) / 1000 > 60) {
- // 如果缓存的临时密钥有效,并还有超过60秒有效期就直接使用
- calcAuthByTmpKey();
- } else if (self.options.getAuthorization) {
- // 外部计算签名或获取临时密钥
- self.options.getAuthorization.call(
- self,
- {
- Bucket: Bucket,
- Region: Region,
- Method: params.Method,
- Key: KeyName,
- Pathname: Pathname,
- Query: params.Query,
- Headers: headers,
- Scope: Scope,
- SystemClockOffset: self.options.SystemClockOffset,
- ForceSignHost: forceSignHost,
- },
- function (AuthData) {
- if (typeof AuthData === 'string') AuthData = { Authorization: AuthData };
- var AuthError = checkAuthError(AuthData);
- if (AuthError) return cb(AuthError);
- if (AuthData.Authorization) {
- cb(null, AuthData);
- } else {
- StsData = AuthData || {};
- StsData.Scope = Scope;
- StsData.ScopeKey = ScopeKey;
- self._StsCache.push(StsData);
- calcAuthByTmpKey();
- }
- }
- );
- } else if (self.options.getSTS) {
- // 外部获取临时密钥
- self.options.getSTS.call(
- self,
- {
- Bucket: Bucket,
- Region: Region,
- },
- function (data) {
- StsData = data || {};
- StsData.Scope = Scope;
- StsData.ScopeKey = ScopeKey;
- if (!StsData.TmpSecretId) StsData.TmpSecretId = StsData.SecretId;
- if (!StsData.TmpSecretKey) StsData.TmpSecretKey = StsData.SecretKey;
- var AuthError = checkAuthError(StsData);
- if (AuthError) return cb(AuthError);
- self._StsCache.push(StsData);
- calcAuthByTmpKey();
- }
- );
- } else {
- // 内部计算获取签名
- return (function () {
- var Authorization = util.getAuth({
- SecretId: params.SecretId || self.options.SecretId,
- SecretKey: params.SecretKey || self.options.SecretKey,
- Method: params.Method,
- Pathname: Pathname,
- Query: params.Query,
- Headers: headers,
- Expires: params.Expires,
- UseRawKey: self.options.UseRawKey,
- SystemClockOffset: self.options.SystemClockOffset,
- ForceSignHost: forceSignHost,
- });
- var AuthData = {
- Authorization: Authorization,
- SecurityToken: self.options.SecurityToken || self.options.XCosSecurityToken,
- SignFrom: 'client',
- };
- cb(null, AuthData);
- return AuthData;
- })();
- }
- return '';
- }
- // 判断当前请求出错时能否重试
- function allowRetry(err) {
- var self = this;
- var canRetry = false;
- var networkError = false;
- var isTimeError = false;
- var serverDate = (err.headers && (err.headers.date || err.headers.Date)) || (err.error && err.error.ServerTime);
- try {
- var errorCode = err.error.Code;
- var errorMessage = err.error.Message;
- if (
- errorCode === 'RequestTimeTooSkewed' ||
- (errorCode === 'AccessDenied' && errorMessage === 'Request has expired')
- ) {
- isTimeError = true;
- }
- } catch (e) {}
- if (err) {
- // 调整时间偏差
- if (isTimeError && serverDate) {
- var serverTime = Date.parse(serverDate);
- if (
- this.options.CorrectClockSkew &&
- Math.abs(util.getSkewTime(this.options.SystemClockOffset) - serverTime) >= 30000
- ) {
- console.error('error: Local time is too skewed.');
- this.options.SystemClockOffset = serverTime - Date.now();
- return { canRetry: true, networkError: false };
- }
- } else if (Math.floor(err.statusCode / 100) === 5) {
- return { canRetry: true, networkError: false };
- } else if (err.code === 'ECONNRESET') {
- return { canRetry: true, networkError: false };
- }
- /**
- * 归为网络错误
- * 1、no statusCode
- * 2、statusCode === 3xx || 4xx || 5xx && no requestId
- */
- if (!err.statusCode) {
- canRetry = true;
- networkError = self.options.AutoSwitchHost;
- } else {
- const statusCode = Math.floor(err.statusCode / 100);
- const requestId = err.headers ? err.headers['x-cos-request-id'] : '';
- if ([3, 4, 5].includes(statusCode) && !requestId) {
- canRetry = self.options.AutoSwitchHost;
- networkError = true;
- }
- }
- }
- return { canRetry, networkError };
- }
- /**
- * requestUrl:请求的url,用于判断是否cos主域名,true才切
- * clientCalcSign:是否客户端计算签名,服务端返回的签名不能切,true才切
- * networkError:是否未知网络错误,true才切
- * */
- function canSwitchHost({ requestUrl, clientCalcSign, networkError }) {
- if (!this.options.AutoSwitchHost) return false;
- if (!requestUrl) return false;
- if (!clientCalcSign) return false;
- if (!networkError) return false;
- const commonReg = /^https?:\/\/[^\/]*\.cos\.[^\/]*\.myqcloud\.com(\/.*)?$/;
- const accelerateReg = /^https?:\/\/[^\/]*\.cos\.accelerate\.myqcloud\.com(\/.*)?$/;
- // 当前域名是cos主域名才切换
- const isCommonCosHost = commonReg.test(requestUrl) && !accelerateReg.test(requestUrl);
- return isCommonCosHost;
- }
- // 获取签名并发起请求
- function submitRequest(params, callback) {
- var self = this;
- // 处理 headers
- !params.headers && (params.headers = {});
- params.headers['User-Agent'] = self.options.UserAgent || 'cos-nodejs-sdk-v5-' + pkg.version;
- // 处理 query
- !params.qs && (params.qs = {});
- params.VersionId && (params.qs.versionId = params.VersionId);
- params.qs = util.clearKey(params.qs);
- // 清理 undefined 和 null 字段
- params.headers && (params.headers = util.clearKey(params.headers));
- params.qs && (params.qs = util.clearKey(params.qs));
- var Query = util.clone(params.qs);
- params.action && (Query[params.action] = '');
- var SignHost =
- params.SignHost || getSignHost.call(this, { Bucket: params.Bucket, Region: params.Region, Url: params.url });
- var next = function (tryTimes) {
- var oldClockOffset = self.options.SystemClockOffset;
- if (params.SwitchHost) {
- // 更换要签的host
- SignHost = SignHost.replace(/myqcloud.com/, 'tencentcos.cn');
- }
- getAuthorizationAsync.call(
- self,
- {
- Bucket: params.Bucket || '',
- Region: params.Region || '',
- Method: params.method,
- Key: params.Key,
- Query: Query,
- Headers: params.headers,
- SignHost: SignHost,
- Action: params.Action,
- ResourceKey: params.ResourceKey,
- Scope: params.Scope,
- ForceSignHost: self.options.ForceSignHost,
- SwitchHost: params.SwitchHost,
- },
- function (err, AuthData) {
- if (err) return callback(err);
- params.AuthData = AuthData;
- _submitRequest.call(self, params, function (err, data) {
- let canRetry = false;
- let networkError = false;
- if (err) {
- const info = allowRetry.call(self, err);
- canRetry = info.canRetry || oldClockOffset !== self.options.SystemClockOffset;
- networkError = info.networkError;
- }
- // 默认重试 3 次
- if (err && !(params.body && params.body.pipe) && !params.outputStream && tryTimes < 4 && canRetry) {
- if (params.headers) {
- delete params.headers.Authorization;
- delete params.headers['token'];
- delete params.headers['clientIP'];
- delete params.headers['clientUA'];
- params.headers['x-cos-security-token'] && delete params.headers['x-cos-security-token'];
- params.headers['x-ci-security-token'] && delete params.headers['x-ci-security-token'];
- }
- // 进入重试逻辑时 需判断是否需要切换cos备用域名
- const switchHost = canSwitchHost.call(self, {
- requestUrl: err.url || '',
- clientCalcSign: AuthData.SignFrom === 'client',
- networkError,
- });
- params.SwitchHost = switchHost;
- // 重试时增加请求头
- params.headers['x-cos-sdk-retry'] = true;
- next(tryTimes + 1);
- } else {
- if (err && params.Action === 'name/cos:UploadPart') {
- const switchHost = canSwitchHost.call(self, {
- requestUrl: err.url || '',
- clientCalcSign: AuthData.SignFrom === 'client',
- networkError,
- });
- err.switchHost = switchHost;
- }
- callback(err, data);
- }
- });
- }
- );
- };
- next(1);
- }
- // 发起请求
- function _submitRequest(params, callback) {
- var self = this;
- var TaskId = params.TaskId;
- if (TaskId && !self._isRunningTask(TaskId)) return;
- var bucket = params.Bucket;
- var region = params.Region;
- var object = params.Key;
- var method = params.method || 'GET';
- var url = params.url || params.Url;
- var body = params.body;
- var rawBody = params.rawBody;
- // 处理 readStream and body
- var readStream;
- if (body && typeof body.pipe === 'function') {
- readStream = body;
- body = null;
- }
- // url
- if (this.options.UseAccelerate) {
- region = 'accelerate';
- }
- url =
- url ||
- getUrl({
- ForcePathStyle: self.options.ForcePathStyle,
- protocol: self.options.Protocol,
- domain: self.options.Domain,
- bucket: bucket,
- region: region,
- object: object,
- });
- if (params.SwitchHost) {
- // 更换请求的url
- url = url.replace(/myqcloud.com/, 'tencentcos.cn');
- }
- if (params.action) {
- url = url + '?' + params.action;
- }
- if (params.qsStr) {
- if (url.indexOf('?') > -1) {
- url = url + '&' + params.qsStr;
- } else {
- url = url + '?' + params.qsStr;
- }
- }
- var opt = {
- method: method,
- url: url,
- headers: params.headers,
- qs: params.qs,
- body: body,
- };
- // 兼容ci接口
- var token = 'x-cos-security-token';
- if (util.isCIHost(url)) {
- token = 'x-ci-security-token';
- }
- // 获取签名
- opt.headers.Authorization = params.AuthData.Authorization;
- params.AuthData.Token && (opt.headers['token'] = params.AuthData.Token);
- params.AuthData.ClientIP && (opt.headers['clientIP'] = params.AuthData.ClientIP);
- params.AuthData.ClientUA && (opt.headers['clientUA'] = params.AuthData.ClientUA);
- params.AuthData.SecurityToken && (opt.headers[token] = params.AuthData.SecurityToken);
- // 清理 undefined 和 null 字段
- opt.headers && (opt.headers = util.clearKey(opt.headers));
- opt = util.clearKey(opt);
- var Ip = this.options.Ip;
- if (Ip) {
- opt.url = opt.url.replace(/^(https?:\/\/)([^\/]+)/, function (str, pre, Host) {
- opt.headers.Host = Host;
- return pre + Ip;
- });
- }
- if (this.options.StrictSsl !== true) {
- opt.strictSSL = this.options.StrictSsl;
- }
- if (this.options.Proxy) {
- opt.proxy = this.options.Proxy;
- }
- if (typeof this.options.Tunnel === 'boolean') {
- opt.tunnel = this.options.Tunnel;
- }
- if (this.options.Timeout) {
- opt.timeout = this.options.Timeout;
- }
- if (this.options.KeepAlive) {
- opt.forever = true;
- }
- if (!this.options.FollowRedirect) {
- opt.followRedirect = false;
- }
- // 修复 Content-Type: false 的 Bug,原因 request 模块会获取 request('mime-types).lookup(readStream.path) 作为 Content-Type
- // 问题代码位置:https://github.com/request/request/blob/v2.88.1/request.js#L500
- if (readStream) {
- var hasContentType = false;
- util.each(opt.headers, function (val, key) {
- if (key.toLowerCase() === 'content-type') hasContentType = true;
- });
- if (
- !hasContentType && // 1. not set Content-Type
- readStream.readable &&
- readStream.path &&
- readStream.mode && // 2. isFileReadStream
- !mime.lookup(readStream.path) // 3. mime return false
- ) {
- opt.headers['Content-Type'] = 'application/octet-stream';
- }
- }
- // 特殊处理内容到写入流的情况,等待流 finish 后才 callback
- if (params.outputStream) callback = util.callbackAfterStreamFinish(params.outputStream, callback);
- self.emit('before-send', opt);
- var sender = REQUEST(opt);
- var retResponse;
- var hasReturned;
- var cb = function (err, data) {
- TaskId && self.off('inner-kill-task', killTask);
- if (hasReturned) return;
- hasReturned = true;
- var attrs = {};
- retResponse && retResponse.statusCode && (attrs.statusCode = retResponse.statusCode);
- retResponse && retResponse.headers && (attrs.headers = retResponse.headers);
- if (err) {
- opt.url && (attrs.url = opt.url);
- opt.method && (attrs.method = opt.method);
- err = util.extend(err || {}, attrs);
- callback(err, null);
- } else {
- data = util.extend(data || {}, attrs);
- callback(null, data);
- }
- if (sender) {
- sender.removeAllListeners && sender.removeAllListeners();
- sender.on('error', function () {});
- sender = null;
- }
- };
- // 在 request 分配的 socket 上挂载 _lastBytesWritten 属性,记录该 socket 已经发送的字节数
- var markLastBytesWritten = function () {
- try {
- Object.defineProperty(sender.req.connection, '_lastBytesWritten', {
- enumerable: true,
- configurable: true,
- writable: true,
- value: sender.req.connection.bytesWritten,
- });
- } catch (e) {}
- };
- sender.on('error', function (err) {
- if (params.outputStream) {
- params.outputStream.close && params.outputStream.close();
- }
- markLastBytesWritten();
- cb(util.error(err));
- });
- sender.on('response', function (response) {
- retResponse = response;
- var responseContentLength = response.headers['content-length'] || 0;
- var chunkList = [];
- var statusCode = response.statusCode;
- var statusSuccess = Math.floor(statusCode / 100) === 2; // 200 202 204 206
- if (statusSuccess && params.outputStream) {
- sender.on('end', function () {
- cb(null, {});
- });
- } else if (responseContentLength >= process.binding('buffer').kMaxLength && opt.method !== 'HEAD') {
- cb(
- util.error(
- new Error(
- 'file size large than ' +
- process.binding('buffer').kMaxLength +
- ', please use "Output" Stream to getObject.'
- )
- )
- );
- } else {
- var dataHandler = function (chunk) {
- chunkList.push(chunk);
- };
- var endHandler = function () {
- try {
- var bodyBuf = Buffer.concat(chunkList);
- } catch (e) {
- cb(util.error(e));
- return;
- }
- var body = bodyBuf.toString();
- // 不对 body 进行转换,body 直接挂载返回
- if (rawBody && statusSuccess) return cb(null, { body: bodyBuf });
- // 解析body,兼容 xml、json,解析失败时完整返回
- var json = util.parseResBody(body);
- // 处理返回值
- var errorBody = json && json.Error;
- if (statusSuccess) {
- // 正确返回,状态码 2xx 时,body 不会有 Error
- cb(null, json);
- } else if (errorBody) {
- // 正常返回了 xml body,且有 Error 节点
- cb(util.error(new Error(errorBody.Message), { code: errorBody.Code, error: errorBody }));
- } else if (statusCode) {
- // 有错误的状态码
- cb(util.error(new Error(response.statusMessage), { code: '' + statusCode }));
- } else {
- // 无状态码,或者获取不到状态码
- cb(util.error(new Error('statusCode error')));
- }
- chunkList = null;
- };
- sender.on('data', dataHandler);
- sender.on('end', endHandler);
- }
- });
- // kill task
- var killTask = function (data) {
- if (data.TaskId === TaskId) {
- readStream && readStream.isSdkCreated && readStream.close && readStream.close(); // 如果是 SDK 里从 FilePath 创建的读流,要主动取消
- sender && sender.abort && sender.abort();
- self.off('inner-kill-task', killTask);
- }
- };
- TaskId && self.on('inner-kill-task', killTask);
- // 请求结束时,在 request 分配的 socket 上挂载 _lastBytesWritten 属性,记录该 socket 已经发送的字节数
- sender.once('end', function () {
- markLastBytesWritten();
- });
- // upload progress
- if (params.onProgress && typeof params.onProgress === 'function') {
- var contentLength = opt.headers['Content-Length'];
- var time0 = Date.now();
- var size0 = 0;
- sender.on('drain', function () {
- var time1 = Date.now();
- var loaded = 0;
- try {
- // 已经上传的字节数 = socket当前累计发送的字节数 - 头部长度 - socket以前发送的字节数
- loaded =
- sender.req.connection.bytesWritten -
- sender.req._header.length -
- (sender.req.connection._lastBytesWritten || 0);
- } catch (e) {}
- var total = contentLength;
- var speed = parseInt(((loaded - size0) / ((time1 - time0) / 1000)) * 100) / 100 || 0;
- var percent = parseInt((loaded / total) * 100) / 100 || 0;
- time0 = time1;
- size0 = loaded;
- params.onProgress({
- loaded: loaded,
- total: total,
- speed: speed,
- percent: percent,
- });
- });
- }
- // download progress
- if (params.onDownloadProgress && typeof params.onDownloadProgress === 'function') {
- var time0 = Date.now();
- var size0 = 0;
- var loaded = 0;
- var total = 0;
- sender.on('response', function (res) {
- total = res.headers['content-length'];
- sender.on('data', function (chunk) {
- loaded += chunk.length;
- var time1 = Date.now();
- var speed = parseInt(((loaded - size0) / ((time1 - time0) / 1000)) * 100) / 100 || 0;
- var percent = parseInt((loaded / total) * 100) / 100 || 0;
- time0 = time1;
- size0 = loaded;
- params.onDownloadProgress({
- loaded: loaded,
- total: total,
- speed: speed,
- percent: percent,
- });
- });
- });
- }
- // pipe 输入
- if (readStream) {
- readStream.on('error', function (err) {
- sender && sender.abort && sender.abort();
- cb(err);
- });
- readStream.pipe(sender);
- }
- // pipe 输出
- if (params.outputStream) {
- params.outputStream.on('error', function (err) {
- sender && sender.abort && sender.abort();
- cb(err);
- });
- sender.pipe(params.outputStream);
- }
- return sender;
- }
- var API_MAP = {
- // Bucket 相关方法
- getService: getService, // Bucket
- putBucket: putBucket,
- headBucket: headBucket, // Bucket
- getBucket: getBucket,
- deleteBucket: deleteBucket,
- putBucketAcl: putBucketAcl, // BucketACL
- getBucketAcl: getBucketAcl,
- putBucketCors: putBucketCors, // BucketCors
- getBucketCors: getBucketCors,
- deleteBucketCors: deleteBucketCors,
- getBucketLocation: getBucketLocation, // BucketLocation
- getBucketPolicy: getBucketPolicy, // BucketPolicy
- putBucketPolicy: putBucketPolicy,
- deleteBucketPolicy: deleteBucketPolicy,
- putBucketTagging: putBucketTagging, // BucketTagging
- getBucketTagging: getBucketTagging,
- deleteBucketTagging: deleteBucketTagging,
- putBucketLifecycle: putBucketLifecycle, // BucketLifecycle
- getBucketLifecycle: getBucketLifecycle,
- deleteBucketLifecycle: deleteBucketLifecycle,
- putBucketVersioning: putBucketVersioning, // BucketVersioning
- getBucketVersioning: getBucketVersioning,
- putBucketReplication: putBucketReplication, // BucketReplication
- getBucketReplication: getBucketReplication,
- deleteBucketReplication: deleteBucketReplication,
- putBucketWebsite: putBucketWebsite, // BucketWebsite
- getBucketWebsite: getBucketWebsite,
- deleteBucketWebsite: deleteBucketWebsite,
- putBucketReferer: putBucketReferer, // BucketReferer
- getBucketReferer: getBucketReferer,
- putBucketDomain: putBucketDomain, // BucketDomain
- getBucketDomain: getBucketDomain,
- deleteBucketDomain: deleteBucketDomain,
- putBucketOrigin: putBucketOrigin, // BucketOrigin
- getBucketOrigin: getBucketOrigin,
- deleteBucketOrigin: deleteBucketOrigin,
- putBucketLogging: putBucketLogging, // BucketLogging
- getBucketLogging: getBucketLogging,
- putBucketInventory: putBucketInventory, // BucketInventory
- getBucketInventory: getBucketInventory,
- listBucketInventory: listBucketInventory,
- deleteBucketInventory: deleteBucketInventory,
- putBucketAccelerate: putBucketAccelerate,
- getBucketAccelerate: getBucketAccelerate,
- putBucketEncryption: putBucketEncryption,
- getBucketEncryption: getBucketEncryption,
- deleteBucketEncryption: deleteBucketEncryption,
- // Object 相关方法
- getObject: getObject,
- getObjectStream: getObjectStream,
- headObject: headObject,
- listObjectVersions: listObjectVersions,
- putObject: putObject,
- deleteObject: deleteObject,
- getObjectAcl: getObjectAcl,
- putObjectAcl: putObjectAcl,
- optionsObject: optionsObject,
- putObjectCopy: putObjectCopy,
- deleteMultipleObject: deleteMultipleObject,
- restoreObject: restoreObject,
- putObjectTagging: putObjectTagging,
- getObjectTagging: getObjectTagging,
- deleteObjectTagging: deleteObjectTagging,
- selectObjectContent: selectObjectContent,
- selectObjectContentStream: selectObjectContentStream,
- appendObject: appendObject,
- // 分块上传相关方法
- uploadPartCopy: uploadPartCopy,
- multipartInit: multipartInit,
- multipartUpload: multipartUpload,
- multipartComplete: multipartComplete,
- multipartList: multipartList,
- multipartListPart: multipartListPart,
- multipartAbort: multipartAbort,
- // 工具方法
- request: request,
- getObjectUrl: getObjectUrl,
- getAuth: getAuth,
- getV4Auth: getV4Auth,
- };
- function warnOldApi(apiName, fn, proto) {
- util.each(['Cors', 'Acl'], function (suffix) {
- if (apiName.slice(-suffix.length) === suffix) {
- var oldName = apiName.slice(0, -suffix.length) + suffix.toUpperCase();
- var apiFn = util.apiWrapper(apiName, fn);
- var warned = false;
- proto[oldName] = function () {
- !warned &&
- console.warn('warning: cos.' + oldName + ' has been deprecated. Please Use cos.' + apiName + ' instead.');
- warned = true;
- apiFn.apply(this, arguments);
- };
- }
- });
- }
- module.exports.init = function (COS, task) {
- task.transferToTaskMethod(API_MAP, 'putObject');
- util.each(API_MAP, function (fn, apiName) {
- COS.prototype[apiName] = util.apiWrapper(apiName, fn);
- warnOldApi(apiName, fn, COS.prototype);
- });
- };
|