aliyun-tablestore-nodejs-sdk
Version:
TableStore SDK for JavaScript
757 lines (659 loc) • 27.8 kB
JavaScript
/*global escape:true */
var TableStore = require('./core');
//var cryptoLib = require('crypto');
var jsSHA = require('../bower_components/jsSHA/src/sha.js');
var SparkMD5 = require('../bower_components/spark-md5/spark-md5.js');
var int64buffer = require("int64-buffer");
/* jshint -W079 */
var Buffer = require('buffer/').Buffer;
/* jshint +W079 */
/**
* A set of utility methods for use with the TableStore SDK.
*
* @!attribute abort
* Return this value from an iterator function {each} or {arrayEach}
* to break out of the iteration.
* @example Breaking out of an iterator function
* TableStore.util.each({a: 1, b: 2, c: 3}, function(key, value) {
* if (key == 'b') return TableStore.util.abort;
* });
* @see each
* @see arrayEach
* @api private
*/
TableStore.util = {
engine: function engine() {
if (TableStore.util.isBrowser() && typeof navigator !== 'undefined') {
return navigator.userAgent;
} else {
return process.platform + '/' + process.version;
}
},
userAgent: function userAgent() {
// 在 浏览器中不能设置 ua
return "";
},
isBrowser: function isBrowser() { return typeof window !== 'undefined'; },
isNode: function isNode() { return !TableStore.util.isBrowser(); },
nodeRequire: function nodeRequire(module) {
if (TableStore.util.isNode()) return require(module);
},
// todo: atob, btoa
hexToBase64: function (str) {
return btoa(String.fromCharCode.apply(null,
str.replace(/\r|\n/g, "").replace(/([\da-fA-F]{2}) ?/g, "0x$1 ").replace(/ +$/, "").split(" "))
);
},
topEscape: function (clearString) {
var output = '';
var x = 0;
clearString = clearString.toString();
var regex = /(^[a-zA-Z0-9-_.~]*)/;
while (x < clearString.length) {
var match = regex.exec(clearString.substr(x));
if (match != null && match.length > 1 && match[1] != '') {
output += match[1];
x += match[1].length;
} else {
if (clearString[x] == ' ')
output += '%20';
else {
var charCode = clearString.charCodeAt(x);
var hexVal = charCode.toString(16);
output += '%' + (hexVal.length < 2 ? '0' : '') + hexVal.toUpperCase();
}
x++;
}
}
return output;
},
popEscape: function (clearString) {
clearString = clearString.toString();
clearString = encodeURIComponent(clearString)
.replace(/\!/gi, '%21')
.replace(/\'/gi, '%27')
.replace(/\(/gi, '%28')
.replace(/\)/gi, '%29')
.replace(/\*/gi, '%2A')
return clearString;
},
opensearchEscape: function (clearString) {
// http://v8.googlecode.com/svn/trunk/src/uri.js
return encodeURIComponent(clearString)
.replace(/\!/gi, '%21')
.replace(/\'/gi, '%27')
.replace(/\(/gi, '%28')
.replace(/\)/gi, '%29')
.replace(/\*/gi, '%2A')
},
uriEscape: function uriEscape(string) {
/*jshint undef:false */
var output = encodeURIComponent(string);
output = output.replace(/[^A-Za-z0-9_.~\-%]+/g, escape);
// percent-encodes some extra non-standard characters in a URI
output = output.replace(/[*]/g, function (ch) {
return '%' + ch.charCodeAt(0).toString(16).toUpperCase();
});
return output;
},
uriEscapePath: function uriEscapePath(string) {
var parts = [];
TableStore.util.arrayEach(string.split('/'), function (part) {
parts.push(TableStore.util.uriEscape(part));
});
return parts.join('/');
},
urlParse: function urlParse(url) {
return require('url').parse(url);
},
urlFormat: function urlFormat(url) {
return require('url').format(url);
},
uuid: function generateUUID() {
var d = new Date().getTime();
if (window.performance && typeof window.performance.now === "function") {
d += performance.now(); //use high-precision timer if available
}
var uuid = 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
var r = (d + Math.random() * 16) % 16 | 0;
d = Math.floor(d / 16);
return (c == 'x' ? r : (r & 0x3 | 0x8)).toString(16);
});
return uuid;
},
queryParamsToString: function queryParamsToString(params) {
var items = [];
var escape = TableStore.util.uriEscape;
var sortedKeys = Object.keys(params).sort();
TableStore.util.arrayEach(sortedKeys, function (name) {
var value = params[name];
var ename = escape(name);
var result = ename;
if (Array.isArray(value)) {
var vals = [];
TableStore.util.arrayEach(value, function (item) { vals.push(escape(item)); });
result = ename + '=' + vals.sort().join('&' + ename + '=');
} else if (value !== undefined && value !== null) {
result = ename + '=' + escape(value);
}
items.push(result);
});
return items.join('&');
},
readFileSync: function readFileSync(path) {
if (typeof window !== 'undefined') return null;
return require('fs').readFileSync(path, 'utf-8');
},
base64: {
encode: function encode64(string) {
if (typeof string === 'number') {
throw util.error(new Error('Cannot base64 encode number ' + string));
}
if (string === null || typeof string === 'undefined') {
return string;
}
var buf = (typeof TableStore.util.Buffer.from === 'function' && TableStore.util.Buffer.from !== Uint8Array.from) ? TableStore.util.Buffer.from(string) : new TableStore.util.Buffer(string);
return buf.toString('base64');
},
decode: function decode64(string) {
if (typeof string === 'number') {
throw util.error(new Error('Cannot base64 decode number ' + string));
}
if (string === null || typeof string === 'undefined') {
return string;
}
return (typeof TableStore.util.Buffer.from === 'function' && TableStore.util.Buffer.from !== Uint8Array.from) ? TableStore.util.Buffer.from(string, 'base64') : new TableStore.util.Buffer(string, 'base64');
}
},
Buffer: Buffer,
buffer: {
/**
* Concatenates a list of Buffer objects.
*/
concat: function (buffers) {
var length = 0,
offset = 0,
buffer = null, i;
for (i = 0; i < buffers.length; i++) {
length += buffers[i].length;
}
buffer = new TableStore.util.Buffer(length);
for (i = 0; i < buffers.length; i++) {
buffers[i].copy(buffer, offset);
offset += buffers[i].length;
}
return buffer;
}
},
Int64: {
doubleToRawLongBits: function (number) {
var buf = new Buffer(8);
buf.fill(0);
buf.writeDoubleLE(number, 0);
var int64 = new int64buffer.Int64LE(buf);
return int64;
}
},
string: {
byteLength: function byteLength(string) {
if (string === null || string === undefined) return 0;
if (typeof string === 'string') string = new Buffer(string);
if (typeof string.byteLength === 'number') {
return string.byteLength;
} else if (typeof string.length === 'number') {
return string.length;
} else if (typeof string.size === 'number') {
return string.size;
} else if (typeof string.path === 'string') {
return require('fs').lstatSync(string.path).size;
} else {
throw TableStore.util.error(new Error('Cannot determine length of ' + string),
{ object: string });
}
},
upperFirst: function upperFirst(string) {
return string[0].toUpperCase() + string.substr(1);
},
lowerFirst: function lowerFirst(string) {
return string[0].toLowerCase() + string.substr(1);
}
},
jamespath: {
query: function query(expression, data) {
if (!data) return [];
var results = [];
var expressions = expression.split(/\s+or\s+/);
TableStore.util.arrayEach.call(this, expressions, function (expr) {
var objects = [data];
var tokens = expr.split('.');
TableStore.util.arrayEach.call(this, tokens, function (token) {
var match = token.match('^(.+?)(?:\\[(-?\\d+|\\*)\\])?$');
var newObjects = [];
TableStore.util.arrayEach.call(this, objects, function (obj) {
if (match[1] === '*') {
TableStore.util.arrayEach.call(this, obj, function (value) {
newObjects.push(value);
});
} else if (obj.hasOwnProperty(match[1])) {
newObjects.push(obj[match[1]]);
}
});
objects = newObjects;
// handle indexing (token[0], token[-1])
if (match[2]) {
newObjects = [];
TableStore.util.arrayEach.call(this, objects, function (obj) {
if (Array.isArray(obj)) {
if (match[2] === '*') {
newObjects = newObjects.concat(obj);
} else {
var idx = parseInt(match[2], 10);
if (idx < 0) idx = obj.length + idx; // negative indexing
newObjects.push(obj[idx]);
}
}
});
objects = newObjects;
}
if (objects.length === 0) return TableStore.util.abort;
});
if (objects.length > 0) {
results = objects;
return TableStore.util.abort;
}
});
return results;
},
find: function find(expression, data) {
return TableStore.util.jamespath.query(expression, data)[0];
}
},
/**
* Date and time utility functions.
*/
date: {
/**
* @return [Date] the current JavaScript date object. Since all
* TableStore services rely on this date object, you can override
* this function to provide a special time value to TableStore service
* requests.
*/
getDate: function getDate() { return new Date(); },
// for taobao open platform
top: function top(date, fmt) {
fmt = fmt || '%Y-%M-%dT%H:%m:%sZ';
function pad(value) {
return (value.toString().length < 2) ? '0' + value : value;
};
return fmt.replace(/%([a-zA-Z])/g, function (_, fmtCode) {
switch (fmtCode) {
case 'Y':
return date.getUTCFullYear();
case 'M':
return pad(date.getUTCMonth() + 1);
case 'd':
return pad(date.getUTCDate());
case 'H':
return pad(date.getUTCHours());
case 'm':
return pad(date.getUTCMinutes());
case 's':
return pad(date.getUTCSeconds());
default:
throw new Error('Unsupported format code: ' + fmtCode);
}
});
},
/**
* @return [String] the date in ISO-8601 format
*/
iso8601: function iso8601(date) {
if (date === undefined) { date = TableStore.util.date.getDate(); }
return date.toISOString();
},
/**
* @return [String] the date in RFC 822 format
*/
rfc822: function rfc822(date) {
if (date === undefined) { date = TableStore.util.date.getDate(); }
return date.toUTCString();
},
unixSeconds: function unixSeconds(date) {
if (date === undefined) { date = TableStore.util.date.getDate(); }
return Math.floor(date.getTime() / 1000);
},
unixMilliseconds: function unixMilliseconds(date) {
if (date === undefined) { date = TableStore.util.date.getDate(); }
return date.getTime();
},
/**
* @param [String,number,Date] date
* @return [Date]
*/
from: function format(date) {
if (typeof date === 'number') {
if (date.toString().length == 10) {
return new Date(date * 1000); // unix timestamp in seconds
}
return new Date(date); // unix timestamp in mill seconds
}
else if (Object.prototype.toString.call(date) === '[object Date]') {
return date;
}
else {
return new Date(date);
}
},
/**
* Given a Date or date-like value, this function formats the
* date into a string of the requested value.
* @param [String,number,Date] date
* @param [String] formatter Valid formats are:
# * 'iso8601'
# * 'rfc822'
# * 'unixSeconds'
# * 'unixMilliseconds'
* @return [String]
*/
format: function format(date, formatter) {
if (!formatter) formatter = 'unixSeconds';
return TableStore.util.date[formatter](TableStore.util.date.from(date));
}
},
crypto: {
crc32Table: [
0x00000000, 0x77073096, 0xEE0E612C, 0x990951BA, 0x076DC419,
0x706AF48F, 0xE963A535, 0x9E6495A3, 0x0EDB8832, 0x79DCB8A4,
0xE0D5E91E, 0x97D2D988, 0x09B64C2B, 0x7EB17CBD, 0xE7B82D07,
0x90BF1D91, 0x1DB71064, 0x6AB020F2, 0xF3B97148, 0x84BE41DE,
0x1ADAD47D, 0x6DDDE4EB, 0xF4D4B551, 0x83D385C7, 0x136C9856,
0x646BA8C0, 0xFD62F97A, 0x8A65C9EC, 0x14015C4F, 0x63066CD9,
0xFA0F3D63, 0x8D080DF5, 0x3B6E20C8, 0x4C69105E, 0xD56041E4,
0xA2677172, 0x3C03E4D1, 0x4B04D447, 0xD20D85FD, 0xA50AB56B,
0x35B5A8FA, 0x42B2986C, 0xDBBBC9D6, 0xACBCF940, 0x32D86CE3,
0x45DF5C75, 0xDCD60DCF, 0xABD13D59, 0x26D930AC, 0x51DE003A,
0xC8D75180, 0xBFD06116, 0x21B4F4B5, 0x56B3C423, 0xCFBA9599,
0xB8BDA50F, 0x2802B89E, 0x5F058808, 0xC60CD9B2, 0xB10BE924,
0x2F6F7C87, 0x58684C11, 0xC1611DAB, 0xB6662D3D, 0x76DC4190,
0x01DB7106, 0x98D220BC, 0xEFD5102A, 0x71B18589, 0x06B6B51F,
0x9FBFE4A5, 0xE8B8D433, 0x7807C9A2, 0x0F00F934, 0x9609A88E,
0xE10E9818, 0x7F6A0DBB, 0x086D3D2D, 0x91646C97, 0xE6635C01,
0x6B6B51F4, 0x1C6C6162, 0x856530D8, 0xF262004E, 0x6C0695ED,
0x1B01A57B, 0x8208F4C1, 0xF50FC457, 0x65B0D9C6, 0x12B7E950,
0x8BBEB8EA, 0xFCB9887C, 0x62DD1DDF, 0x15DA2D49, 0x8CD37CF3,
0xFBD44C65, 0x4DB26158, 0x3AB551CE, 0xA3BC0074, 0xD4BB30E2,
0x4ADFA541, 0x3DD895D7, 0xA4D1C46D, 0xD3D6F4FB, 0x4369E96A,
0x346ED9FC, 0xAD678846, 0xDA60B8D0, 0x44042D73, 0x33031DE5,
0xAA0A4C5F, 0xDD0D7CC9, 0x5005713C, 0x270241AA, 0xBE0B1010,
0xC90C2086, 0x5768B525, 0x206F85B3, 0xB966D409, 0xCE61E49F,
0x5EDEF90E, 0x29D9C998, 0xB0D09822, 0xC7D7A8B4, 0x59B33D17,
0x2EB40D81, 0xB7BD5C3B, 0xC0BA6CAD, 0xEDB88320, 0x9ABFB3B6,
0x03B6E20C, 0x74B1D29A, 0xEAD54739, 0x9DD277AF, 0x04DB2615,
0x73DC1683, 0xE3630B12, 0x94643B84, 0x0D6D6A3E, 0x7A6A5AA8,
0xE40ECF0B, 0x9309FF9D, 0x0A00AE27, 0x7D079EB1, 0xF00F9344,
0x8708A3D2, 0x1E01F268, 0x6906C2FE, 0xF762575D, 0x806567CB,
0x196C3671, 0x6E6B06E7, 0xFED41B76, 0x89D32BE0, 0x10DA7A5A,
0x67DD4ACC, 0xF9B9DF6F, 0x8EBEEFF9, 0x17B7BE43, 0x60B08ED5,
0xD6D6A3E8, 0xA1D1937E, 0x38D8C2C4, 0x4FDFF252, 0xD1BB67F1,
0xA6BC5767, 0x3FB506DD, 0x48B2364B, 0xD80D2BDA, 0xAF0A1B4C,
0x36034AF6, 0x41047A60, 0xDF60EFC3, 0xA867DF55, 0x316E8EEF,
0x4669BE79, 0xCB61B38C, 0xBC66831A, 0x256FD2A0, 0x5268E236,
0xCC0C7795, 0xBB0B4703, 0x220216B9, 0x5505262F, 0xC5BA3BBE,
0xB2BD0B28, 0x2BB45A92, 0x5CB36A04, 0xC2D7FFA7, 0xB5D0CF31,
0x2CD99E8B, 0x5BDEAE1D, 0x9B64C2B0, 0xEC63F226, 0x756AA39C,
0x026D930A, 0x9C0906A9, 0xEB0E363F, 0x72076785, 0x05005713,
0x95BF4A82, 0xE2B87A14, 0x7BB12BAE, 0x0CB61B38, 0x92D28E9B,
0xE5D5BE0D, 0x7CDCEFB7, 0x0BDBDF21, 0x86D3D2D4, 0xF1D4E242,
0x68DDB3F8, 0x1FDA836E, 0x81BE16CD, 0xF6B9265B, 0x6FB077E1,
0x18B74777, 0x88085AE6, 0xFF0F6A70, 0x66063BCA, 0x11010B5C,
0x8F659EFF, 0xF862AE69, 0x616BFFD3, 0x166CCF45, 0xA00AE278,
0xD70DD2EE, 0x4E048354, 0x3903B3C2, 0xA7672661, 0xD06016F7,
0x4969474D, 0x3E6E77DB, 0xAED16A4A, 0xD9D65ADC, 0x40DF0B66,
0x37D83BF0, 0xA9BCAE53, 0xDEBB9EC5, 0x47B2CF7F, 0x30B5FFE9,
0xBDBDF21C, 0xCABAC28A, 0x53B39330, 0x24B4A3A6, 0xBAD03605,
0xCDD70693, 0x54DE5729, 0x23D967BF, 0xB3667A2E, 0xC4614AB8,
0x5D681B02, 0x2A6F2B94, 0xB40BBE37, 0xC30C8EA1, 0x5A05DF1B,
0x2D02EF8D],
crc32: function crc32(data) {
/*jshint bitwise:false*/
var tbl = TableStore.util.crypto.crc32Table;
var crc = 0 ^ -1;
if (typeof data === 'string') {
data = new Buffer(data);
}
for (var i = 0; i < data.length; i++) {
var code = data.readUInt8(i);
crc = (crc >>> 8) ^ tbl[(crc ^ code) & 0xFF];
}
return (crc ^ -1) >>> 0;
},
hmac: function hmac(key, string, digest, fn) {
if (!digest) digest = 'binary';
if (digest === 'buffer') {
digest = undefined;
// todo: 不支持 buffer 类型的 hash
return "";
}
if (!fn) fn = 'sha256';
if (typeof string != 'string') {
//string = new Buffer(string);
// todo: 目前只支持 string
return "";
}
var shaObj;
switch (fn) {
case "md5":
// todo: 不支持 md5
return "";
case "sha1":
shaObj = new jsSHA("SHA-1", "TEXT");
break;
case "sha256":
shaObj = new jsSHA("SHA-256", "TEXT");
break;
case "sha512":
shaObj = new jsSHA("SHA-512", "TEXT");
break;
default:
return "";
}
shaObj.setHMACKey(key, "TEXT");
shaObj.update(string);
switch (digest) {
case "binary":
return shaObj.getHMAC("BYTES");
case "hex":
return shaObj.getHMAC("HEX");
case "base64":
return shaObj.getHMAC("B64");
default:
return "";
}
},
// https://nodejs.org/api/crypto.html#crypto_hash_digest_encoding
md5: function md5(data, digest) {
var hash = "";
if (!digest) { digest = 'binary'; }
if (digest === 'buffer') {
digest = undefined;
// todo: 不支持 buffer 类型的 hash
return "";
}
if (typeof data === 'string') {
switch (digest) {
case "binary":
return SparkMD5.hash(data, true);
case "hex":
return SparkMD5.hash(data);
case "base64":
return TableStore.util.hexToBase64(SparkMD5.hash(data));
default:
return "";
}
}
else { // array buffer
switch (digest) {
case "binary":
return SparkMD5.ArrayBuffer.hash(data, true);
case "hex":
return SparkMD5.ArrayBuffer.hash(data);
case "base64":
return TableStore.util.hexToBase64(SparkMD5.ArrayBuffer.hash(data));
default:
return "";
}
}
},
// 目前不支持 sha256 hash
sha256: function sha256(string, digest) {
//if (!digest) { digest = 'binary'; }
//if (digest === 'buffer') { digest = undefined; }
//if (typeof string === 'string') string = new Buffer(string);
//return TableStore.util.crypto.createHash('sha256').update(string).digest(digest);
return "";
},
toHex: function toHex(data) {
var out = [];
for (var i = 0; i < data.length; i++) {
out.push(('0' + data.charCodeAt(i).toString(16)).substr(-2, 2));
}
return out.join('');
}
},
/** @!ignore */
/* Abort constant */
abort: {},
each: function each(object, iterFunction) {
for (var key in object) {
if (object.hasOwnProperty(key)) {
var ret = iterFunction.call(this, key, object[key]);
if (ret === TableStore.util.abort) break;
}
}
},
arrayEach: function arrayEach(array, iterFunction) {
for (var idx in array) {
if (array.hasOwnProperty(idx)) {
var ret = iterFunction.call(this, array[idx], parseInt(idx, 10));
if (ret === TableStore.util.abort) break;
}
}
},
update: function update(obj1, obj2) {
TableStore.util.each(obj2, function iterator(key, item) {
obj1[key] = item;
});
return obj1;
},
merge: function merge(obj1, obj2) {
return TableStore.util.update(TableStore.util.copy(obj1), obj2);
},
copy: function copy(object) {
if (object === null || object === undefined) return object;
var dupe = {};
/*jshint forin:false */
for (var key in object) {
dupe[key] = object[key];
}
return dupe;
},
isEmpty: function isEmpty(obj) {
for (var prop in obj) {
if (obj.hasOwnProperty(prop)) {
return false;
}
}
return true;
},
isType: function isType(obj, type) {
// handle cross-"frame" objects
if (typeof type === 'function') type = TableStore.util.typeName(type);
return Object.prototype.toString.call(obj) === '[object ' + type + ']';
},
typeName: function typeName(type) {
if (type.hasOwnProperty('name')) return type.name;
var str = type.toString();
var match = str.match(/^\s*function (.+)\(/);
return match ? match[1] : str;
},
error: function error(err, options) {
var originalError = null;
if (typeof err.message === 'string' && err.message !== '') {
if (typeof options === 'string' || (options && options.message)) {
originalError = TableStore.util.copy(err);
originalError.message = err.message;
}
}
err.message = err.message || null;
if (typeof options === 'string') {
err.message = options;
} else {
TableStore.util.update(err, options);
}
if (typeof Object.defineProperty === 'function') {
Object.defineProperty(err, 'name', { writable: true, enumerable: false });
Object.defineProperty(err, 'message', { enumerable: true });
}
err.name = err.name || err.code || 'Error';
err.time = new Date();
if (originalError) err.originalError = originalError;
return err;
},
/**
* @api private
*/
inherit: function inherit(klass, features) {
var newObject = null;
if (features === undefined) {
features = klass;
klass = Object;
newObject = {};
} else {
/*jshint newcap:false */
/*jshint camelcase:false */
var ctor = function __ctor_wrapper__() { };
ctor.prototype = klass.prototype;
newObject = new ctor();
}
// constructor not supplied, create pass-through ctor
if (features.constructor === Object) {
features.constructor = function () {
if (klass !== Object) {
return klass.apply(this, arguments);
}
};
}
features.constructor.prototype = newObject;
TableStore.util.update(features.constructor.prototype, features);
features.constructor.__super__ = klass;
return features.constructor;
},
/**
* @api private
*/
mixin: function mixin() {
var klass = arguments[0];
for (var i = 1; i < arguments.length; i++) {
/*jshint forin:false*/
for (var prop in arguments[i].prototype) {
var fn = arguments[i].prototype[prop];
if (prop != 'constructor') {
klass.prototype[prop] = fn;
}
}
}
return klass;
},
/**
* @api private
*/
hideProperties: function hideProperties(obj, props) {
if (typeof Object.defineProperty !== 'function') return;
TableStore.util.arrayEach(props, function (key) {
Object.defineProperty(obj, key, {
enumerable: false, writable: true, configurable: true
});
});
}
};
module.exports = TableStore.util;