|
const debug = require('debug')('ali-oss');
|
const sendToWormhole = require('stream-wormhole');
|
const crypto = require('crypto');
|
const path = require('path');
|
const copy = require('copy-to');
|
const mime = require('mime');
|
const xml = require('xml2js');
|
const ms = require('humanize-ms');
|
const AgentKeepalive = require('agentkeepalive');
|
const HttpsAgentKeepalive = require('agentkeepalive').HttpsAgent;
|
const merge = require('merge-descriptors');
|
const urlutil = require('url');
|
const is = require('is-type-of');
|
const platform = require('platform');
|
const utility = require('utility');
|
const urllib = require('urllib');
|
const pkg = require('../package.json');
|
const dateFormat = require('dateformat');
|
const bowser = require('bowser');
|
const signUtils = require('./common/signUtils');
|
const utils = require('./common/utils');
|
|
const globalHttpAgent = new AgentKeepalive();
|
const globalHttpsAgent = new HttpsAgentKeepalive();
|
|
function getHeader(headers, name) {
|
return headers[name] || headers[name.toLowerCase()];
|
}
|
|
function setEndpoint(endpoint) {
|
let url = urlutil.parse(endpoint);
|
|
if (!url.protocol) {
|
url = urlutil.parse(`http://${endpoint}`);
|
}
|
|
if (url.protocol !== 'http:' && url.protocol !== 'https:') {
|
throw new Error('Endpoint protocol must be http or https.');
|
}
|
|
return url;
|
}
|
|
function setRegion(region, internal, secure) {
|
const protocol = secure ? 'https://' : 'http://';
|
let suffix = internal ? '-internal.aliyuncs.com' : '.aliyuncs.com';
|
const prefix = 'vpc100-oss-cn-';
|
// aliyun VPC region: https://help.aliyun.com/knowledge_detail/38740.html
|
if (region.substr(0, prefix.length) === prefix) {
|
suffix = '.aliyuncs.com';
|
}
|
|
return urlutil.parse(protocol + region + suffix);
|
}
|
|
function Client(options, ctx) {
|
if (!(this instanceof Client)) {
|
return new Client(options, ctx);
|
}
|
|
if (options && options.inited) {
|
this.options = options;
|
} else {
|
this.options = Client.initOptions(options);
|
}
|
|
// support custom agent and urllib client
|
if (this.options.urllib) {
|
this.urllib = this.options.urllib;
|
} else {
|
this.urllib = urllib;
|
this.agent = this.options.agent || globalHttpAgent;
|
this.httpsAgent = this.options.httpsAgent || globalHttpsAgent;
|
}
|
this.ctx = ctx;
|
this.userAgent = this._getUserAgent();
|
}
|
|
/**
|
* Expose `Client`
|
*/
|
|
module.exports = Client;
|
|
Client.initOptions = function initOptions(options) {
|
if (!options
|
|| !options.accessKeyId
|
|| !options.accessKeySecret) {
|
throw new Error('require accessKeyId, accessKeySecret');
|
}
|
|
const opts = {
|
region: 'oss-cn-hangzhou',
|
internal: false,
|
secure: false,
|
timeout: 60000, // 60s
|
bucket: null,
|
endpoint: null,
|
cname: false,
|
isRequestPay: false
|
};
|
|
Object.keys(options).forEach((key) => {
|
if (options[key] !== undefined) {
|
opts[key] = options[key];
|
}
|
});
|
opts.accessKeyId = opts.accessKeyId.trim();
|
opts.accessKeySecret = opts.accessKeySecret.trim();
|
|
opts.timeout = ms(opts.timeout);
|
|
if (opts.endpoint) {
|
opts.endpoint = setEndpoint(opts.endpoint);
|
} else if (opts.region) {
|
opts.endpoint = setRegion(opts.region, opts.internal, opts.secure);
|
} else {
|
throw new Error('require options.endpoint or options.region');
|
}
|
|
opts.inited = true;
|
return opts;
|
};
|
|
/**
|
* prototype
|
*/
|
|
const proto = Client.prototype;
|
|
/**
|
* Object operations
|
*/
|
merge(proto, require('./object'));
|
/**
|
* Bucket operations
|
*/
|
merge(proto, require('./bucket'));
|
// multipart upload
|
merge(proto, require('./managed-upload'));
|
/**
|
* RTMP operations
|
*/
|
merge(proto, require('./rtmp'));
|
|
/**
|
* common multipart-copy support node and browser
|
*/
|
merge(proto, require('./common/multipart-copy'));
|
/**
|
* Common module parallel
|
*/
|
merge(proto, require('./common/parallel'));
|
/**
|
* Multipart operations
|
*/
|
merge(proto, require('./common/multipart'));
|
/**
|
* ImageClient class
|
*/
|
Client.ImageClient = require('./image')(Client);
|
/**
|
* Cluster Client class
|
*/
|
Client.ClusterClient = require('./cluster')(Client);
|
|
/**
|
* STS Client class
|
*/
|
Client.STS = require('./sts');
|
|
/**
|
* get OSS signature
|
* @param {String} stringToSign
|
* @return {String} the signature
|
*/
|
proto.signature = function signature(stringToSign) {
|
debug('authorization stringToSign: %s', stringToSign);
|
|
return signUtils.computeSignature(this.options.accessKeySecret, stringToSign);
|
};
|
|
/**
|
* get author header
|
*
|
* "Authorization: OSS " + Access Key Id + ":" + Signature
|
*
|
* Signature = base64(hmac-sha1(Access Key Secret + "\n"
|
* + VERB + "\n"
|
* + CONTENT-MD5 + "\n"
|
* + CONTENT-TYPE + "\n"
|
* + DATE + "\n"
|
* + CanonicalizedOSSHeaders
|
* + CanonicalizedResource))
|
*
|
* @param {String} method
|
* @param {String} resource
|
* @param {Object} header
|
* @return {String}
|
*
|
* @api private
|
*/
|
|
proto.authorization = function authorization(method, resource, subres, headers) {
|
const stringToSign = signUtils.buildCanonicalString(method.toUpperCase(), resource, {
|
headers,
|
parameters: subres
|
});
|
|
return signUtils.authorization(this.options.accessKeyId, this.options.accessKeySecret, stringToSign);
|
};
|
|
/**
|
* create request params
|
* See `request`
|
* @api private
|
*/
|
|
proto.createRequest = function createRequest(params) {
|
const headers = {
|
'x-oss-date': dateFormat(new Date(), 'UTC:ddd, dd mmm yyyy HH:MM:ss \'GMT\''),
|
'x-oss-user-agent': this.userAgent,
|
'User-Agent': this.userAgent
|
};
|
|
if (this.options.isRequestPay) {
|
Object.assign(headers, { 'x-oss-request-payer': 'requester' });
|
}
|
|
if (this.options.stsToken) {
|
headers['x-oss-security-token'] = this.options.stsToken;
|
}
|
|
copy(params.headers).to(headers);
|
|
if (!getHeader(headers, 'Content-Type')) {
|
if (params.mime === mime.default_type) {
|
params.mime = '';
|
}
|
|
if (params.mime && params.mime.indexOf('/') > 0) {
|
headers['Content-Type'] = params.mime;
|
} else {
|
headers['Content-Type'] = mime.lookup(params.mime || path.extname(params.object || ''));
|
}
|
}
|
|
if (params.content) {
|
headers['Content-Md5'] = crypto
|
.createHash('md5')
|
.update(new Buffer(params.content, 'utf8'))
|
.digest('base64');
|
if (!headers['Content-Length']) {
|
headers['Content-Length'] = params.content.length;
|
}
|
}
|
|
const authResource = this._getResource(params);
|
headers.authorization = this.authorization(params.method, authResource, params.subres, headers);
|
|
const url = this._getReqUrl(params);
|
debug('request %s %s, with headers %j, !!stream: %s', params.method, url, headers, !!params.stream);
|
const timeout = params.timeout || this.options.timeout;
|
const reqParams = {
|
method: params.method,
|
content: params.content,
|
stream: params.stream,
|
headers,
|
timeout,
|
writeStream: params.writeStream,
|
customResponse: params.customResponse,
|
ctx: params.ctx || this.ctx
|
};
|
if (this.agent) {
|
reqParams.agent = this.agent;
|
}
|
if (this.httpsAgent) {
|
reqParams.httpsAgent = this.httpsAgent;
|
}
|
|
return {
|
url,
|
params: reqParams
|
};
|
};
|
|
/**
|
* request oss server
|
* @param {Object} params
|
* - {String} object
|
* - {String} bucket
|
* - {Object} [headers]
|
* - {Object} [query]
|
* - {Buffer} [content]
|
* - {Stream} [stream]
|
* - {Stream} [writeStream]
|
* - {String} [mime]
|
* - {Boolean} [xmlResponse]
|
* - {Boolean} [customResponse]
|
* - {Number} [timeout]
|
* - {Object} [ctx] request context, default is `this.ctx`
|
*
|
* @api private
|
*/
|
|
proto.request = async function request(params) {
|
const reqParams = this.createRequest(params);
|
let result;
|
let reqErr;
|
try {
|
result = await this.urllib.request(reqParams.url, reqParams.params);
|
debug('response %s %s, got %s, headers: %j', params.method, reqParams.url, result.status, result.headers);
|
} catch (err) {
|
reqErr = err;
|
}
|
let err;
|
if (result && params.successStatuses && params.successStatuses.indexOf(result.status) === -1) {
|
err = await this.requestError(result);
|
err.params = params;
|
} else if (reqErr) {
|
err = await this.requestError(reqErr);
|
}
|
|
if (err) {
|
if (params.customResponse && result && result.res) {
|
// consume the response stream
|
await sendToWormhole(result.res);
|
}
|
throw err;
|
}
|
|
if (params.xmlResponse) {
|
result.data = await this.parseXML(result.data);
|
}
|
return result;
|
};
|
|
proto._getResource = function _getResource(params) {
|
let resource = '/';
|
if (params.bucket) resource += `${params.bucket}/`;
|
if (params.object) resource += params.object;
|
|
return resource;
|
};
|
|
proto._isIP = function _isIP(host) {
|
return utils._isIP(host);
|
};
|
|
proto._escape = function _escape(name) {
|
return utility.encodeURIComponent(name).replace(/%2F/g, '/');
|
};
|
|
proto._getReqUrl = function _getReqUrl(params) {
|
const ep = {};
|
copy(this.options.endpoint).to(ep);
|
const isIP = this._isIP(ep.hostname);
|
const isCname = this.options.cname;
|
if (params.bucket && !isCname && !isIP) {
|
ep.host = `${params.bucket}.${ep.host}`;
|
}
|
|
let resourcePath = '/';
|
if (params.bucket && isIP) {
|
resourcePath += `${params.bucket}/`;
|
}
|
|
if (params.object) {
|
// Preserve '/' in result url
|
resourcePath += this._escape(params.object).replace(/\+/g, '%2B');
|
}
|
ep.pathname = resourcePath;
|
|
const query = {};
|
if (params.query) {
|
merge(query, params.query);
|
}
|
|
if (params.subres) {
|
let subresAsQuery = {};
|
if (is.string(params.subres)) {
|
subresAsQuery[params.subres] = '';
|
} else if (is.array(params.subres)) {
|
params.subres.forEach((k) => {
|
subresAsQuery[k] = '';
|
});
|
} else {
|
subresAsQuery = params.subres;
|
}
|
merge(query, subresAsQuery);
|
}
|
|
ep.query = query;
|
|
return urlutil.format(ep);
|
};
|
|
/*
|
* Get User-Agent for browser & node.js
|
* @example
|
* aliyun-sdk-nodejs/4.1.2 Node.js 5.3.0 on Darwin 64-bit
|
* aliyun-sdk-js/4.1.2 Safari 9.0 on Apple iPhone(iOS 9.2.1)
|
* aliyun-sdk-js/4.1.2 Chrome 43.0.2357.134 32-bit on Windows Server 2008 R2 / 7 64-bit
|
*/
|
|
proto._getUserAgent = function _getUserAgent() {
|
const agent = (process && process.browser) ? 'js' : 'nodejs';
|
const sdk = `aliyun-sdk-${agent}/${pkg.version}`;
|
let plat = platform.description;
|
if (!plat && process) {
|
plat = `Node.js ${process.version.slice(1)} on ${process.platform} ${process.arch}`;
|
}
|
|
return this._checkUserAgent(`${sdk} ${plat}`);
|
};
|
|
proto._checkUserAgent = function _checkUserAgent(ua) {
|
const userAgent = ua.replace(/\u03b1/, 'alpha').replace(/\u03b2/, 'beta');
|
return userAgent;
|
};
|
|
/*
|
* Check Browser And Version
|
* @param {String} [name] browser name: like IE, Chrome, Firefox
|
* @param {String} [version] browser major version: like 10(IE 10.x), 55(Chrome 55.x), 50(Firefox 50.x)
|
* @return {Bool} true or false
|
* @api private
|
*/
|
|
proto.checkBrowserAndVersion = function checkBrowserAndVersion(name, version) {
|
return ((bowser.name === name) && (bowser.version.split('.')[0] === version));
|
};
|
|
/**
|
* thunkify xml.parseString
|
* @param {String|Buffer} str
|
*
|
* @api private
|
*/
|
|
proto.parseXML = function parseXMLThunk(str) {
|
return new Promise((resolve, reject) => {
|
if (Buffer.isBuffer(str)) {
|
str = str.toString();
|
}
|
xml.parseString(str, {
|
explicitRoot: false,
|
explicitArray: false
|
}, (err, result) => {
|
if (err) {
|
reject(err);
|
} else {
|
resolve(result);
|
}
|
});
|
});
|
};
|
|
/**
|
* generater a request error with request response
|
* @param {Object} result
|
*
|
* @api private
|
*/
|
|
proto.requestError = async function requestError(result) {
|
let err = null;
|
if (!result.data || !result.data.length) {
|
if (result.status === -1 || result.status === -2) { // -1 is net error , -2 is timeout
|
err = new Error(result.message);
|
err.name = result.name;
|
err.status = result.status;
|
err.code = result.name;
|
} else {
|
// HEAD not exists resource
|
if (result.status === 404) {
|
err = new Error('Object not exists');
|
err.name = 'NoSuchKeyError';
|
err.status = 404;
|
err.code = 'NoSuchKey';
|
} else if (result.status === 412) {
|
err = new Error('Pre condition failed');
|
err.name = 'PreconditionFailedError';
|
err.status = 412;
|
err.code = 'PreconditionFailed';
|
} else {
|
err = new Error(`Unknow error, status: ${result.status}`);
|
err.name = 'UnknowError';
|
err.status = result.status;
|
}
|
err.requestId = result.headers['x-oss-request-id'];
|
err.host = '';
|
}
|
} else {
|
const message = String(result.data);
|
debug('request response error data: %s', message);
|
|
let info;
|
try {
|
info = await this.parseXML(message) || {};
|
} catch (error) {
|
debug(message);
|
error.message += `\nraw xml: ${message}`;
|
error.status = result.status;
|
error.requestId = result.headers['x-oss-request-id'];
|
return error;
|
}
|
|
let msg = info.Message || (`unknow request error, status: ${result.status}`);
|
if (info.Condition) {
|
msg += ` (condition: ${info.Condition})`;
|
}
|
err = new Error(msg);
|
err.name = info.Code ? `${info.Code}Error` : 'UnknowError';
|
err.status = result.status;
|
err.code = info.Code;
|
err.requestId = info.RequestId;
|
err.hostId = info.HostId;
|
}
|
|
debug('generate error %j', err);
|
return err;
|
};
|
