client.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423
  1. const debug = require('debug')('ali-oss');
  2. const xml = require('xml2js');
  3. const AgentKeepalive = require('agentkeepalive');
  4. const merge = require('merge-descriptors');
  5. const platform = require('platform');
  6. const utility = require('utility');
  7. const urllib = require('urllib');
  8. const pkg = require('./version');
  9. const bowser = require('bowser');
  10. const signUtils = require('../common/signUtils');
  11. const _initOptions = require('../common/client/initOptions');
  12. const { createRequest } = require('../common/utils/createRequest');
  13. const { encoder } = require('../common/utils/encoder');
  14. const { getReqUrl } = require('../common/client/getReqUrl');
  15. const { setSTSToken } = require('../common/utils/setSTSToken');
  16. const { retry } = require('../common/utils/retry');
  17. const { isFunction } = require('../common/utils/isFunction');
  18. const globalHttpAgent = new AgentKeepalive();
  19. function _unSupportBrowserTip() {
  20. const { name, version } = platform;
  21. if (name && name.toLowerCase && name.toLowerCase() === 'ie' && version.split('.')[0] < 10) {
  22. // eslint-disable-next-line no-console
  23. console.warn('ali-oss does not support the current browser');
  24. }
  25. }
  26. // check local web protocol,if https secure default set true , if http secure default set false
  27. function isHttpsWebProtocol() {
  28. // for web worker not use window.location.
  29. // eslint-disable-next-line no-restricted-globals
  30. return location && location.protocol === 'https:';
  31. }
  32. function Client(options, ctx) {
  33. _unSupportBrowserTip();
  34. if (!(this instanceof Client)) {
  35. return new Client(options, ctx);
  36. }
  37. if (options && options.inited) {
  38. this.options = options;
  39. } else {
  40. this.options = Client.initOptions(options);
  41. }
  42. this.options.cancelFlag = false; // cancel flag: if true need to be cancelled, default false
  43. // support custom agent and urllib client
  44. if (this.options.urllib) {
  45. this.urllib = this.options.urllib;
  46. } else {
  47. this.urllib = urllib;
  48. this.agent = this.options.agent || globalHttpAgent;
  49. }
  50. this.ctx = ctx;
  51. this.userAgent = this._getUserAgent();
  52. this.stsTokenFreshTime = new Date();
  53. // record the time difference between client and server
  54. this.options.amendTimeSkewed = 0;
  55. }
  56. /**
  57. * Expose `Client`
  58. */
  59. module.exports = Client;
  60. Client.initOptions = function initOptions(options) {
  61. if (!options.stsToken) {
  62. console.warn(
  63. 'Please use STS Token for safety, see more details at https://help.aliyun.com/document_detail/32077.html'
  64. );
  65. }
  66. const opts = Object.assign(
  67. {
  68. secure: isHttpsWebProtocol(),
  69. // for browser compatibility disable fetch.
  70. useFetch: false
  71. },
  72. options
  73. );
  74. return _initOptions(opts);
  75. };
  76. /**
  77. * prototype
  78. */
  79. const proto = Client.prototype;
  80. // mount debug on proto
  81. proto.debug = debug;
  82. /**
  83. * Object operations
  84. */
  85. merge(proto, require('./object'));
  86. /**
  87. * Bucket operations
  88. */
  89. merge(proto, require('./bucket'));
  90. merge(proto, require('../common/bucket/getBucketWebsite'));
  91. merge(proto, require('../common/bucket/putBucketWebsite'));
  92. merge(proto, require('../common/bucket/deleteBucketWebsite'));
  93. // lifecycle
  94. merge(proto, require('../common/bucket/getBucketLifecycle'));
  95. merge(proto, require('../common/bucket/putBucketLifecycle'));
  96. merge(proto, require('../common/bucket/deleteBucketLifecycle'));
  97. // multiversion
  98. merge(proto, require('../common/bucket/putBucketVersioning'));
  99. merge(proto, require('../common/bucket/getBucketVersioning'));
  100. // inventory
  101. merge(proto, require('../common/bucket/getBucketInventory'));
  102. merge(proto, require('../common/bucket/deleteBucketInventory'));
  103. merge(proto, require('../common/bucket/listBucketInventory'));
  104. merge(proto, require('../common/bucket/putBucketInventory'));
  105. // worm
  106. merge(proto, require('../common/bucket/abortBucketWorm'));
  107. merge(proto, require('../common/bucket/completeBucketWorm'));
  108. merge(proto, require('../common/bucket/extendBucketWorm'));
  109. merge(proto, require('../common/bucket/getBucketWorm'));
  110. merge(proto, require('../common/bucket/initiateBucketWorm'));
  111. // multipart upload
  112. merge(proto, require('./managed-upload'));
  113. /**
  114. * common multipart-copy support node and browser
  115. */
  116. merge(proto, require('../common/multipart-copy'));
  117. /**
  118. * Multipart operations
  119. */
  120. merge(proto, require('../common/multipart'));
  121. /**
  122. * Common module parallel
  123. */
  124. merge(proto, require('../common/parallel'));
  125. /**
  126. * get OSS signature
  127. * @param {String} stringToSign
  128. * @return {String} the signature
  129. */
  130. proto.signature = function signature(stringToSign) {
  131. this.debug('authorization stringToSign: %s', stringToSign, 'info');
  132. return signUtils.computeSignature(this.options.accessKeySecret, stringToSign, this.options.headerEncoding);
  133. };
  134. proto._getReqUrl = getReqUrl;
  135. /**
  136. * get author header
  137. *
  138. * "Authorization: OSS " + Access Key Id + ":" + Signature
  139. *
  140. * Signature = base64(hmac-sha1(Access Key Secret + "\n"
  141. * + VERB + "\n"
  142. * + CONTENT-MD5 + "\n"
  143. * + CONTENT-TYPE + "\n"
  144. * + DATE + "\n"
  145. * + CanonicalizedOSSHeaders
  146. * + CanonicalizedResource))
  147. *
  148. * @param {String} method
  149. * @param {String} resource
  150. * @param {Object} header
  151. * @return {String}
  152. *
  153. * @api private
  154. */
  155. proto.authorization = function authorization(method, resource, subres, headers) {
  156. const stringToSign = signUtils.buildCanonicalString(method.toUpperCase(), resource, {
  157. headers,
  158. parameters: subres
  159. });
  160. return signUtils.authorization(
  161. this.options.accessKeyId,
  162. this.options.accessKeySecret,
  163. stringToSign,
  164. this.options.headerEncoding
  165. );
  166. };
  167. /**
  168. * request oss server
  169. * @param {Object} params
  170. * - {String} object
  171. * - {String} bucket
  172. * - {Object} [headers]
  173. * - {Object} [query]
  174. * - {Buffer} [content]
  175. * - {Stream} [stream]
  176. * - {Stream} [writeStream]
  177. * - {String} [mime]
  178. * - {Boolean} [xmlResponse]
  179. * - {Boolean} [customResponse]
  180. * - {Number} [timeout]
  181. * - {Object} [ctx] request context, default is `this.ctx`
  182. *
  183. * @api private
  184. */
  185. proto.request = async function (params) {
  186. if (this.options.retryMax) {
  187. return await retry(request.bind(this), this.options.retryMax, {
  188. errorHandler: err => {
  189. const _errHandle = _err => {
  190. if (params.stream) return false;
  191. const statusErr = [-1, -2].includes(_err.status);
  192. const requestErrorRetryHandle = this.options.requestErrorRetryHandle || (() => true);
  193. return statusErr && requestErrorRetryHandle(_err);
  194. };
  195. if (_errHandle(err)) return true;
  196. return false;
  197. }
  198. })(params);
  199. } else {
  200. return request.call(this, params);
  201. }
  202. };
  203. async function request(params) {
  204. if (this.options.stsToken && isFunction(this.options.refreshSTSToken)) {
  205. await setSTSToken.call(this);
  206. }
  207. const reqParams = createRequest.call(this, params);
  208. if (!this.options.useFetch) {
  209. reqParams.params.mode = 'disable-fetch';
  210. }
  211. let result;
  212. let reqErr;
  213. const useStream = !!params.stream;
  214. try {
  215. result = await this.urllib.request(reqParams.url, reqParams.params);
  216. this.debug(
  217. 'response %s %s, got %s, headers: %j',
  218. params.method,
  219. reqParams.url,
  220. result.status,
  221. result.headers,
  222. 'info'
  223. );
  224. } catch (err) {
  225. reqErr = err;
  226. }
  227. let err;
  228. if (result && params.successStatuses && params.successStatuses.indexOf(result.status) === -1) {
  229. err = await this.requestError(result);
  230. // not use stream
  231. if (err.code === 'RequestTimeTooSkewed' && !useStream) {
  232. this.options.amendTimeSkewed = +new Date(err.serverTime) - new Date();
  233. return await this.request(params);
  234. }
  235. err.params = params;
  236. } else if (reqErr) {
  237. err = await this.requestError(reqErr);
  238. }
  239. if (err) {
  240. throw err;
  241. }
  242. if (params.xmlResponse) {
  243. const parseData = await this.parseXML(result.data);
  244. result.data = parseData;
  245. }
  246. return result;
  247. }
  248. proto._getResource = function _getResource(params) {
  249. let resource = '/';
  250. if (params.bucket) resource += `${params.bucket}/`;
  251. if (params.object) resource += encoder(params.object, this.options.headerEncoding);
  252. return resource;
  253. };
  254. proto._escape = function _escape(name) {
  255. return utility.encodeURIComponent(name).replace(/%2F/g, '/');
  256. };
  257. /*
  258. * Get User-Agent for browser & node.js
  259. * @example
  260. * aliyun-sdk-nodejs/4.1.2 Node.js 5.3.0 on Darwin 64-bit
  261. * aliyun-sdk-js/4.1.2 Safari 9.0 on Apple iPhone(iOS 9.2.1)
  262. * aliyun-sdk-js/4.1.2 Chrome 43.0.2357.134 32-bit on Windows Server 2008 R2 / 7 64-bit
  263. */
  264. proto._getUserAgent = function _getUserAgent() {
  265. const agent = process && process.browser ? 'js' : 'nodejs';
  266. const sdk = `aliyun-sdk-${agent}/${pkg.version}`;
  267. let plat = platform.description;
  268. if (!plat && process) {
  269. plat = `Node.js ${process.version.slice(1)} on ${process.platform} ${process.arch}`;
  270. }
  271. return this._checkUserAgent(`${sdk} ${plat}`);
  272. };
  273. proto._checkUserAgent = function _checkUserAgent(ua) {
  274. const userAgent = ua.replace(/\u03b1/, 'alpha').replace(/\u03b2/, 'beta');
  275. return userAgent;
  276. };
  277. /*
  278. * Check Browser And Version
  279. * @param {String} [name] browser name: like IE, Chrome, Firefox
  280. * @param {String} [version] browser major version: like 10(IE 10.x), 55(Chrome 55.x), 50(Firefox 50.x)
  281. * @return {Bool} true or false
  282. * @api private
  283. */
  284. proto.checkBrowserAndVersion = function checkBrowserAndVersion(name, version) {
  285. return bowser.name === name && bowser.version.split('.')[0] === version;
  286. };
  287. /**
  288. * thunkify xml.parseString
  289. * @param {String|Buffer} str
  290. *
  291. * @api private
  292. */
  293. proto.parseXML = function parseXMLThunk(str) {
  294. return new Promise((resolve, reject) => {
  295. if (Buffer.isBuffer(str)) {
  296. str = str.toString();
  297. }
  298. xml.parseString(
  299. str,
  300. {
  301. explicitRoot: false,
  302. explicitArray: false
  303. },
  304. (err, result) => {
  305. if (err) {
  306. reject(err);
  307. } else {
  308. resolve(result);
  309. }
  310. }
  311. );
  312. });
  313. };
  314. /**
  315. * generater a request error with request response
  316. * @param {Object} result
  317. *
  318. * @api private
  319. */
  320. proto.requestError = async function requestError(result) {
  321. let err = null;
  322. if (!result.data || !result.data.length) {
  323. if (result.status === -1 || result.status === -2) {
  324. // -1 is net error , -2 is timeout
  325. err = new Error(result.message);
  326. err.name = result.name;
  327. err.status = result.status;
  328. err.code = result.name;
  329. } else {
  330. // HEAD not exists resource
  331. if (result.status === 404) {
  332. err = new Error('Object not exists');
  333. err.name = 'NoSuchKeyError';
  334. err.status = 404;
  335. err.code = 'NoSuchKey';
  336. } else if (result.status === 412) {
  337. err = new Error('Pre condition failed');
  338. err.name = 'PreconditionFailedError';
  339. err.status = 412;
  340. err.code = 'PreconditionFailed';
  341. } else {
  342. err = new Error(`Unknow error, status: ${result.status}`);
  343. err.name = 'UnknownError';
  344. err.status = result.status;
  345. }
  346. err.requestId = result.headers['x-oss-request-id'];
  347. err.host = '';
  348. }
  349. } else {
  350. const message = String(result.data);
  351. this.debug('request response error data: %s', message, 'error');
  352. let info;
  353. try {
  354. info = (await this.parseXML(message)) || {};
  355. } catch (error) {
  356. this.debug(message, 'error');
  357. error.message += `\nraw xml: ${message}`;
  358. error.status = result.status;
  359. error.requestId = result.headers['x-oss-request-id'];
  360. return error;
  361. }
  362. let msg = info.Message || `unknow request error, status: ${result.status}`;
  363. if (info.Condition) {
  364. msg += ` (condition: ${info.Condition})`;
  365. }
  366. err = new Error(msg);
  367. err.name = info.Code ? `${info.Code}Error` : 'UnknownError';
  368. err.status = result.status;
  369. err.code = info.Code;
  370. err.requestId = info.RequestId;
  371. err.hostId = info.HostId;
  372. err.serverTime = info.ServerTime;
  373. }
  374. this.debug('generate error %j', err, 'error');
  375. return err;
  376. };