node-ovh-objectstorage
Version:
Simple library to use OVH Public Cloud Object Storage.
1,011 lines (867 loc) • 38.6 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Objects.js - Documentation
</title>
<link href="https://www.braintreepayments.com/images/favicon-ccda0b14.png" rel="icon" type="image/png">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<link type="text/css" rel="stylesheet" href="styles/collapse.css">
<!-- start Mixpanel -->
<script type="text/javascript">(function(e,a){if(!a.__SV){var b=window;try{var c,l,i,j=b.location,g=j.hash;c=function(a,b){return(l=a.match(RegExp(b+"=([^&]*)")))?l[1]:null};g&&c(g,"state")&&(i=JSON.parse(decodeURIComponent(c(g,"state"))),"mpeditor"===i.action&&(b.sessionStorage.setItem("_mpcehash",g),history.replaceState(i.desiredHash||"",e.title,j.pathname+j.search)))}catch(m){}var k,h;window.mixpanel=a;a._i=[];a.init=function(b,c,f){function e(b,a){var c=a.split(".");2==c.length&&(b=b[c[0]],a=c[1]);b[a]=function(){b.push([a].concat(Array.prototype.slice.call(arguments,
0)))}}var d=a;"undefined"!==typeof f?d=a[f]=[]:f="mixpanel";d.people=d.people||[];d.toString=function(b){var a="mixpanel";"mixpanel"!==f&&(a+="."+f);b||(a+=" (stub)");return a};d.people.toString=function(){return d.toString(1)+".people (stub)"};k="disable time_event track track_pageview track_links track_forms register register_once alias unregister identify name_tag set_config reset people.set people.set_once people.increment people.append people.union people.track_charge people.clear_charges people.delete_user".split(" ");
for(h=0;h<k.length;h++)e(d,k[h]);a._i.push([b,c,f])};a.__SV=1.2;b=e.createElement("script");b.type="text/javascript";b.async=!0;b.src="undefined"!==typeof MIXPANEL_CUSTOM_LIB_URL?MIXPANEL_CUSTOM_LIB_URL:"file:"===e.location.protocol&&"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js".match(/^\/\//)?"https://cdn.mxpnl.com/libs/mixpanel-2-latest.min.js":"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js";c=e.getElementsByTagName("script")[0];c.parentNode.insertBefore(b,c)}})(document,window.mixpanel||[]);
mixpanel.init("1919205b2da72e4da3b9b6639b444d59");</script>
<!-- end Mixpanel -->
</head>
<body>
<svg style="display: none;">
<defs>
<symbol id="linkIcon" fill="#706d77" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M0 0h24v24H0z" fill="none"/>
<path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"/>
</symbol>
</defs>
</svg>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<div class="top-nav-wrapper">
<ul>
<li >
<a href="index.html">
<svg fill="#6D6D6D" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z"/>
<path d="M0 0h24v24H0z" fill="none"/>
</svg>
</a>
</li>
</ul>
</div>
<nav>
<h3 class="reference-title">
OVH Object Storage
</h3>
<h3>Classes</h3><ul><li id="Account-nav"><a href="Account.html">Account</a><ul class='methods'><li data-type="method" id="Account-all-nav"><a href="Account.html#all">all</a></li><li data-type="method" id="Account-containers-nav"><a href="Account.html#containers">containers</a></li><li data-type="method" id="Account-details-nav"><a href="Account.html#details">details</a></li><li data-type="method" id="Account-generateKey-nav"><a href="Account.html#generateKey">generateKey</a></li><li data-type="method" id="Account-metas-nav"><a href="Account.html#metas">metas</a></li></ul></li><li id="AccountMeta-nav"><a href="AccountMeta.html">AccountMeta</a><ul class='methods'><li data-type="method" id="AccountMeta-all-nav"><a href="AccountMeta.html#all">all</a></li><li data-type="method" id="AccountMeta-create-nav"><a href="AccountMeta.html#create">create</a></li><li data-type="method" id="AccountMeta-create_with_result-nav"><a href="AccountMeta.html#create_with_result">create_with_result</a></li><li data-type="method" id="AccountMeta-delete-nav"><a href="AccountMeta.html#delete">delete</a></li><li data-type="method" id="AccountMeta-delete_with_result-nav"><a href="AccountMeta.html#delete_with_result">delete_with_result</a></li><li data-type="method" id="AccountMeta-get-nav"><a href="AccountMeta.html#get">get</a></li><li data-type="method" id="AccountMeta-has-nav"><a href="AccountMeta.html#has">has</a></li><li data-type="method" id="AccountMeta-update-nav"><a href="AccountMeta.html#update">update</a></li><li data-type="method" id="AccountMeta-update_with_result-nav"><a href="AccountMeta.html#update_with_result">update_with_result</a></li></ul></li><li id="Containers-nav"><a href="Containers.html">Containers</a><ul class='methods'><li data-type="method" id="Containers-create-nav"><a href="Containers.html#create">create</a></li><li data-type="method" id="Containers-create_with_result-nav"><a href="Containers.html#create_with_result">create_with_result</a></li><li data-type="method" id="Containers-delete-nav"><a href="Containers.html#delete">delete</a></li><li data-type="method" id="Containers-delete_objects-nav"><a href="Containers.html#delete_objects">delete_objects</a></li><li data-type="method" id="Containers-delete_objects_with_result-nav"><a href="Containers.html#delete_objects_with_result">delete_objects_with_result</a></li><li data-type="method" id="Containers-delete_with_result-nav"><a href="Containers.html#delete_with_result">delete_with_result</a></li><li data-type="method" id="Containers-exist-nav"><a href="Containers.html#exist">exist</a></li><li data-type="method" id="Containers-info-nav"><a href="Containers.html#info">info</a></li><li data-type="method" id="Containers-list-nav"><a href="Containers.html#list">list</a></li><li data-type="method" id="Containers-metas-nav"><a href="Containers.html#metas">metas</a></li></ul></li><li id="ContainersMeta-nav"><a href="ContainersMeta.html">ContainersMeta</a><ul class='methods'><li data-type="method" id="ContainersMeta-all-nav"><a href="ContainersMeta.html#all">all</a></li><li data-type="method" id="ContainersMeta-create-nav"><a href="ContainersMeta.html#create">create</a></li><li data-type="method" id="ContainersMeta-create_with_result-nav"><a href="ContainersMeta.html#create_with_result">create_with_result</a></li><li data-type="method" id="ContainersMeta-delete-nav"><a href="ContainersMeta.html#delete">delete</a></li><li data-type="method" id="ContainersMeta-delete_with_result-nav"><a href="ContainersMeta.html#delete_with_result">delete_with_result</a></li><li data-type="method" id="ContainersMeta-get-nav"><a href="ContainersMeta.html#get">get</a></li><li data-type="method" id="ContainersMeta-has-nav"><a href="ContainersMeta.html#has">has</a></li><li data-type="method" id="ContainersMeta-update-nav"><a href="ContainersMeta.html#update">update</a></li><li data-type="method" id="ContainersMeta-update_with_result-nav"><a href="ContainersMeta.html#update_with_result">update_with_result</a></li></ul></li><li id="Objects-nav"><a href="Objects.html">Objects</a><ul class='methods'><li data-type="method" id="Objects-copy-nav"><a href="Objects.html#copy">copy</a></li><li data-type="method" id="Objects-copy_with_result-nav"><a href="Objects.html#copy_with_result">copy_with_result</a></li><li data-type="method" id="Objects-delete-nav"><a href="Objects.html#delete">delete</a></li><li data-type="method" id="Objects-delete_with_result-nav"><a href="Objects.html#delete_with_result">delete_with_result</a></li><li data-type="method" id="Objects-deletes-nav"><a href="Objects.html#deletes">deletes</a></li><li data-type="method" id="Objects-deletes_with_result-nav"><a href="Objects.html#deletes_with_result">deletes_with_result</a></li><li data-type="method" id="Objects-download-nav"><a href="Objects.html#download">download</a></li><li data-type="method" id="Objects-exist-nav"><a href="Objects.html#exist">exist</a></li><li data-type="method" id="Objects-expire_after-nav"><a href="Objects.html#expire_after">expire_after</a></li><li data-type="method" id="Objects-expire_after_with_result-nav"><a href="Objects.html#expire_after_with_result">expire_after_with_result</a></li><li data-type="method" id="Objects-expire_at-nav"><a href="Objects.html#expire_at">expire_at</a></li><li data-type="method" id="Objects-expire_at_with_result-nav"><a href="Objects.html#expire_at_with_result">expire_at_with_result</a></li><li data-type="method" id="Objects-get-nav"><a href="Objects.html#get">get</a></li><li data-type="method" id="Objects-getTempLink-nav"><a href="Objects.html#getTempLink">getTempLink</a></li><li data-type="method" id="Objects-info-nav"><a href="Objects.html#info">info</a></li><li data-type="method" id="Objects-metas-nav"><a href="Objects.html#metas">metas</a></li><li data-type="method" id="Objects-save-nav"><a href="Objects.html#save">save</a></li><li data-type="method" id="Objects-save_with_result-nav"><a href="Objects.html#save_with_result">save_with_result</a></li><li data-type="method" id="Objects-saveData-nav"><a href="Objects.html#saveData">saveData</a></li><li data-type="method" id="Objects-saveFile-nav"><a href="Objects.html#saveFile">saveFile</a></li><li data-type="method" id="Objects-set-nav"><a href="Objects.html#set">set</a></li><li data-type="method" id="Objects-set_with_result-nav"><a href="Objects.html#set_with_result">set_with_result</a></li></ul></li><li id="ObjectsMeta-nav"><a href="ObjectsMeta.html">ObjectsMeta</a><ul class='methods'><li data-type="method" id="ObjectsMeta-all-nav"><a href="ObjectsMeta.html#all">all</a></li><li data-type="method" id="ObjectsMeta-create-nav"><a href="ObjectsMeta.html#create">create</a></li><li data-type="method" id="ObjectsMeta-create_with_result-nav"><a href="ObjectsMeta.html#create_with_result">create_with_result</a></li><li data-type="method" id="ObjectsMeta-delete-nav"><a href="ObjectsMeta.html#delete">delete</a></li><li data-type="method" id="ObjectsMeta-delete_with_result-nav"><a href="ObjectsMeta.html#delete_with_result">delete_with_result</a></li><li data-type="method" id="ObjectsMeta-get-nav"><a href="ObjectsMeta.html#get">get</a></li><li data-type="method" id="ObjectsMeta-has-nav"><a href="ObjectsMeta.html#has">has</a></li><li data-type="method" id="ObjectsMeta-update-nav"><a href="ObjectsMeta.html#update">update</a></li><li data-type="method" id="ObjectsMeta-update_with_result-nav"><a href="ObjectsMeta.html#update_with_result">update_with_result</a></li></ul></li><li id="OVHStorage-nav"><a href="OVHStorage.html">OVHStorage</a><ul class='methods'><li data-type="method" id="OVHStorage-account-nav"><a href="OVHStorage.html#account">account</a></li><li data-type="method" id="OVHStorage-connection-nav"><a href="OVHStorage.html#connection">connection</a></li><li data-type="method" id="OVHStorage-containers-nav"><a href="OVHStorage.html#containers">containers</a></li><li data-type="method" id="OVHStorage-getConnectionDetails-nav"><a href="OVHStorage.html#getConnectionDetails">getConnectionDetails</a></li><li data-type="method" id="OVHStorage-objects-nav"><a href="OVHStorage.html#objects">objects</a></li></ul></li></ul><h3 id="global-nav"><a href="global.html">Global</a></h3>
</nav>
<div id="main">
<h1 class="page-title">
Objects.js
</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>const fs = require('fs');
const _ = require("../tools/lodash");
const request = require('../tools/request');
const moment = require('moment');
const CryptoJS = require('crypto-js');
const ObjectsMeta = require('./ObjectsMeta');
/**
* Put, edit, remove, downloads objects files
*
* __Available methods :__ *download(), *get(), *save(), *save_with_result(), *set()*, *set_with_result()*, *copy()*, *copy_with_result()*, *delete()*, *delete_with_result()*, *deletes()*, *deletes_with_result()*, *exist()*, *info()*, *expire_at()*, *expire_at_with_result()*, *expire_after()*, *expire_after_with_result()*, *metas()*
*/
class Objects {
/**
* Object constructor
*
* @param {OVHStorage} context OVHObjectStorage context
*/
constructor(context) {
this.context = context;
}
/**
* Download file
*
* @param {String} path Online path of file with container
* @param {String} pathLocal Local path to download file
*
* @async
* @return {Promise<Boolean|Error>}
*/
download(path, pathLocal) {
return new Promise(async (resolve, reject) => {
try {
// check
if (_.isUndefined(path)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Path parameter is expected.");
if (!_.isString(path)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Path parameter is not a string.");
if (!_.includes(path, '/')) // noinspection ExceptionCaughtLocallyJS
throw new Error("Path parameter isn't valid : container/filename.ext.");
if (_.isUndefined(pathLocal)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Local path parameter is expected.");
if (!_.isString(pathLocal)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Local path parameter is not a string.");
// check if file exist
if (!(await this.context.objects().exist(path))) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path does not seem to exist.");
let writeStream = fs.createWriteStream(pathLocal);
let file = (() => {
let p = path.split('/');
if (p[0] === "")
delete p[0];
p = _.filter(p, (r) => {
return !_.isUndefined(r);
});
return p.join("/");
})();
request({
method: 'GET',
uri: encodeURI(this.context.endpoint.url + "/" + file),
headers: {
"X-Auth-Token": this.context.token,
"Accept": "application/json"
}
}, (err, res) => {
err = err || request.checkIfResponseIsError(res);
if (err) // noinspection ExceptionCaughtLocallyJS
throw new Error(err);
}).pipe(writeStream);
writeStream.on('error', (e) => {
throw e;
});
writeStream.on('finish', () => {
return resolve(true);
});
} catch (e) {
if (fs.existsSync(pathLocal))
fs.unlink(pathLocal);
return reject(e);
}
});
}
/**
* Get file
*
* @param {String} path Path of file with container
* @param {String|null|undefined} encoding If null, the body is returned as a Buffer by default it is utf8.
*
* @async
* @return {Promise<{content: *, headers: Objects}>}
*/
get(path, encoding = undefined) {
return new Promise(async (resolve, reject) => {
try {
// check
if (_.isUndefined(path)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Path parameter is expected.");
if (!_.isString(path)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Path parameter is not a string.");
if (!_.includes(path, '/')) // noinspection ExceptionCaughtLocallyJS
throw new Error("Path parameter isn't valid : container/filename.ext.");
// check if file exist
if (!(await this.context.objects().exist(path))) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path does not seem to exist.");
let file = (() => {
let p = path.split('/');
if (p[0] === "")
delete p[0];
p = _.filter(p, (r) => {
return !_.isUndefined(r);
});
return p.join("/");
})();
request({
method: 'GET',
uri: encodeURI(this.context.endpoint.url + "/" + file),
headers: {
"X-Auth-Token": this.context.token,
"Accept": "application/json"
},
encoding: encoding
}, (err, res, body) => {
err = err || request.checkIfResponseIsError(res);
if (err) // noinspection ExceptionCaughtLocallyJS
throw new Error(err);
return resolve({
'content': body,
'headers': res.headers
});
})
} catch (e) {
return reject(e);
}
});
}
/**
* @deprecated Use saveFile(file, path)
* Save file
*
* @param {String} file Local file path to save
* @param {String} path Path where to store the file
*
* @async
* @return {Promise<Object>}
*/
save(file, path) {
return this.saveFile(file, path);
}
/**
* Save file data
*
* @param {Buffer|Uint8Array|Blob|string|Readable} data data to save
* @param {String} path Path where to store the file
*
* @async
* @return {Promise<Object>}
*/
saveData(data, path) {
return new Promise(async (resolve, reject) => {
try {
// check
if (_.isUndefined(data)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Local file data parameter is expected.");
if (_.isUndefined(path)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Path parameter is expected.");
if (!_.isString(path)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Path parameter is not a string.");
if (!_.includes(path, '/')) // noinspection ExceptionCaughtLocallyJS
throw new Error("Path parameter isn't valid : container/filename.ext.");
// check if container exist
if (!(await this.context.containers().exist((() => {
let p = path.split('/');
if (p[0] === "")
delete p[0];
p = _.filter(p, (r) => {
return !_.isUndefined(r);
});
if (_.count(p) <= 0)
return "";
return p[0];
})()))) // noinspection ExceptionCaughtLocallyJS
throw new Error("Container does not seem to exist.");
request({
method: 'PUT',
uri: encodeURI(this.context.endpoint.url + path),
headers: {
"X-Auth-Token": this.context.token,
"Accept": "application/json"
},
body: data
}, (err, res) => {
err = err || request.checkIfResponseIsError(res);
if (err) // noinspection ExceptionCaughtLocallyJS
throw new Error(err);
return resolve(res.headers);
});
} catch (e) {
return reject(e);
}
});
}
/**
* Save file
*
* @param {String} file Local file path to save
* @param {String} path Path where to store the file
*
* @async
* @return {Promise<Object>}
*/
saveFile(file, path) {
return new Promise(async (resolve, reject) => {
try {
// check
if (_.isUndefined(file)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Local file path parameter is expected.");
if (!_.isString(file)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Local file path parameter is not a string.");
if (!fs.existsSync(file)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Local file does not seem to exist.");
if (_.isUndefined(path)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Path parameter is expected.");
if (!_.isString(path)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Path parameter is not a string.");
if (!_.includes(path, '/')) // noinspection ExceptionCaughtLocallyJS
throw new Error("Path parameter isn't valid : container/filename.ext.");
// check if container exist
if (!(await this.context.containers().exist((() => {
let p = path.split('/');
if (p[0] === "")
delete p[0];
p = _.filter(p, (r) => {
return !_.isUndefined(r);
});
if (_.count(p) <= 0)
return "";
return p[0];
})()))) // noinspection ExceptionCaughtLocallyJS
throw new Error("Container does not seem to exist.");
let stream = fs.createReadStream(file);
stream.pipe(request({
method: 'PUT',
uri: encodeURI(this.context.endpoint.url + path),
headers: {
"X-Auth-Token": this.context.token,
"Accept": "application/json"
}
}, (err, res) => {
err = err || request.checkIfResponseIsError(res);
if (err) // noinspection ExceptionCaughtLocallyJS
throw new Error(err);
stream.close();
return resolve(res.headers);
}));
} catch (e) {
return reject(e);
}
});
}
/**
* Save file and return boolean as result
*
* @param {String} file Local file path to save
* @param {String} path Path where to store the file
*
* @async
* @return {Promise<Object>}
*/
async save_with_result(file, path) {
try {
await this.context.objects().set(file, path);
return true;
} catch (e) {
return false;
}
}
/**
* Set file
* Method deprecated prefer save() method
* @deprecated
*
* @param {String} file Local file path to save
* @param {String} path Path where to store the file
*
* @async
* @return {Promise<Object>}
*/
async set(file, path) {
await this.context.objects().save(file, path);
}
/**
* Set file and return boolean as result
* Method deprecated prefer save_with_result() method
* @deprecated
*
* @param {String} file Local file path to save
* @param {String} path Path where to store the file
*
* @async
* @return {Promise<Object>}
*/
async set_with_result(file, path) {
try {
await this.context.objects().set(file, path);
return true;
} catch (e) {
return false;
}
}
/**
* Copy online file from another destination on account
*
* @param {String} pathOrigin Source file path to copy
* @param {String} pathToPaste Destination file path to paste
*
* @async
* @return {Promise<Object>}
*/
copy(pathOrigin, pathToPaste) {
return new Promise(async (resolve, reject) => {
try {
if (_.isUndefined(pathOrigin)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Original file path parameter is expected.");
if (!_.isString(pathOrigin)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Original file path parameter is not a string.");
if (!_.includes(pathOrigin, '/')) // noinspection ExceptionCaughtLocallyJS
throw new Error("Original file path parameter isn't valid : container/filename.ext.");
if (_.isUndefined(pathToPaste)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Copy file path parameter is expected.");
if (!_.isString(pathToPaste)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Copy file path parameter is not a string.");
if (!_.includes(pathToPaste, '/')) // noinspection ExceptionCaughtLocallyJS
throw new Error("Copy file path parameter isn't valid : container/filename.ext.");
// check if file exist
if (!(await this.context.objects().exist(pathOrigin))) // noinspection ExceptionCaughtLocallyJS
throw new Error("Original file path path does not seem to exist.");
if (await this.context.objects().exist(pathToPaste)) // noinspection ExceptionCaughtLocallyJS
throw new Error("A file with destination path already exist.");
let pathOriginFile = (() => {
let p = pathOrigin.split('/');
if (p[0] === "")
delete p[0];
p = _.filter(p, (r) => {
return !_.isUndefined(r);
});
return p.join("/");
})();
let pathToPasteFile = (() => {
let p = pathToPaste.split('/');
if (p[0] === "")
delete p[0];
p = _.filter(p, (r) => {
return !_.isUndefined(r);
});
return p.join("/");
})();
request({
method: 'COPY',
uri: encodeURI(this.context.endpoint.url + '/' + pathOriginFile),
headers: {
"X-Auth-Token": this.context.token,
"Accept": "application/json",
"Destination": '/' + pathToPasteFile
}
}, (err, res) => {
err = err || request.checkIfResponseIsError(res);
if (err) // noinspection ExceptionCaughtLocallyJS
throw new Error(err);
return resolve(res.headers);
});
} catch (e) {
return reject(e);
}
});
}
/**
* Copy online file from another destination on account and return boolean as result
*
* @param {String} pathOrigin Source file path to copy
* @param {String} pathToPaste Destination file path to paste
*
* @async
* @return {Promise<Boolean>}
*/
async copy_with_result(pathOrigin, pathToPaste) {
try {
await this.context.objects().copy(pathOrigin, pathToPaste);
return true;
} catch (e) {
return false;
}
}
/**
* Generate temporary link to download files in private containers
*
* @param {String} path
* @param {Number} validityDurationInSeconds
* @param {Boolean} checkContainer
* @returns {Promise<String>}
*/
getTempLink(path, validityDurationInSeconds, checkContainer = true) {
return new Promise(async (resolve, reject) => {
try {
// check args
if (_.isUndefined(path)) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path parameter is expected.");
if (!_.isString(path)) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path parameter is not a string.");
if (!_.includes(path, '/')) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path parameter isn't valid : container/filename.ext.");
// remove first path separator if is send with parameter
path = (() => {
let p = path.split('/');
if (p[0] === '')
delete p[0];
return _.filter(p, (e) => {
return (!_.isUndefined(e))
}).join('/');
})()
// check if file exist
if (!(await this.context.objects().exist(path))) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path does not seem to exist.");
let baseUrl = this.context.endpoint.url.split('/v1')[0];
let pathUrl = '/v1'+this.context.endpoint.url.split('/v1')[1];
let seconds = Math.floor(((validityDurationInSeconds * 1000) || 36e5) / 1000);
let method = 'GET';
let objectPath = pathUrl + '/' + path;
let expires = Math.floor(Date.now()/1000) + seconds;
let hmacBody = method + '\n' + expires + '\n' + objectPath;
let sig = CryptoJS.algo.HMAC.create(CryptoJS.algo.SHA1, this.context.key).update(hmacBody).finalize().toString(CryptoJS.enc.Hex);
resolve(baseUrl + objectPath + '?temp_url_sig=' + sig + '&temp_url_expires=' + expires);
} catch (e) {
return reject(e);
}
});
}
/**
* Delete file object
*
* @param {String} path Path of file with container
* @param {Boolean=} [checkContainer=true] Boolean to disable check existence of container
*
* @async
* @return {Promise<Object>}
*/
delete(path, checkContainer = true) {
return new Promise(async (resolve, reject) => {
try {
// check args
if (_.isUndefined(path)) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path parameter is expected.");
if (!_.isString(path)) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path parameter is not a string.");
if (!_.includes(path, '/')) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path parameter isn't valid : container/filename.ext.");
// remove first path separator if is send with parameter
path = (() => {
let p = path.split('/');
if (p[0] === '')
delete p[0];
return _.filter(p, (e) => {
return (!_.isUndefined(e))
}).join('/');
})()
// check if file exist
if (!(await this.context.objects().exist(path))) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path does not seem to exist.");
// delete file
request({
method: 'DELETE',
uri: encodeURI(this.context.endpoint.url + '/' + path),
headers: {
"X-Auth-Token": this.context.token,
"Accept": "application/json"
}
}, (err, res) => {
err = err || request.checkIfResponseIsError(res);
if (err) // noinspection ExceptionCaughtLocallyJS
throw new Error(err);
return resolve(res.headers);
});
} catch (e) {
return reject(e);
}
});
}
/**
* Delete file object and return boolean as result
*
* @param {String} path Path of file with container
* @param {Boolean=} [checkContainer=true] Boolean to disable check existence of container
*
* @async
* @return {Promise<Boolean>}
*/
async delete_with_result(path, checkContainer = true) {
try {
await this.context.objects().delete(path, checkContainer = true);
return true;
} catch (e) {
return false;
}
}
/**
* Delete multiple files object
*
* @param {Array<string>} paths Array of path file
* @param {Boolean=} [checkContainer=true] Boolean to disable check existence of container
*
* @async
* @return {Promise<Array<Objects>>}
*/
deletes(paths, checkContainer = true) {
return new Promise(async (resolve, reject) => {
try {
if (_.isUndefined(paths)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Files paths parameter is expected.");
if (!_.isArray(paths) && _.count(_.filter(paths, (path) => {
return (_.isString(path))
})) !== _.count(paths)) // noinspection ExceptionCaughtLocallyJS
throw new Error("One or more file path are incorrect, paths type must be an array of string values.");
if (_.count(_.filter(paths, (path) => {
return (_.includes(path, '/'))
})) !== _.count(paths)) // noinspection ExceptionCaughtLocallyJS
throw new Error("One or more file path parameter isn't valid : container/filename.ext.");
let deletes = await Promise.all(_.map(paths, (path) => {
return this.context.objects().delete(path, checkContainer);
}));
return resolve(deletes);
} catch (e) {
return reject(e);
}
});
}
/**
* Delete multiple files object and return boolean as result
*
* @param {Array<string>} paths Array of path file
* @param {Boolean=} [checkContainer=true] Boolean to disable check existence of container
*
* @async
* @return {Promise<Boolean>}
*/
async deletes_with_result(paths, checkContainer = true) {
try {
await this.context.objects().deletes(paths, checkContainer);
return true;
} catch (e) {
return false;
}
}
/**
* Check if file object exist
*
* @param {String} path Path of file with container
*
* @async
* @return {Promise<Boolean>}
*/
exist(path) {
return new Promise(async (resolve, reject) => {
try {
if (_.isUndefined(path)) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path parameter is expected.");
if (!_.isString(path)) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path parameter is not a string.");
if (!_.includes(path, '/')) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path parameter isn't valid : container/filename.ext.");
// check if container exist
if (!(await this.context.containers().exist((() => {
let p = path.split('/');
if (p[0] === "")
delete p[0];
p = _.filter(p, (r) => {
return !_.isUndefined(r);
});
if (_.count(p) <= 0)
return "";
return p[0];
})()))) // noinspection ExceptionCaughtLocallyJS
throw new Error("Container does not seem to exist.");
let file = (() => {
let p = path.split('/');
if (p[0] === "")
delete p[0];
p = _.filter(p, (r) => {
return !_.isUndefined(r);
});
return p.join("/");
})();
request({
method: 'GET',
uri: encodeURI(this.context.endpoint.url + '/' + file),
headers: {
"X-Auth-Token": this.context.token,
"Accept": "application/json"
}
}, (err, res) => {
if (parseInt(res.statusCode) === 404) {
return resolve(false);
}
err = err || request.checkIfResponseIsError(res);
if (err) // noinspection ExceptionCaughtLocallyJS
throw new Error(err);
return resolve(true);
});
} catch (e) {
return reject(e);
}
});
}
/**
* Get information details of file object
*
* @param {String} path Path of file with container
*
* @async
* @return {Promise<Object>}
*/
info(path) {
return new Promise(async (resolve, reject) => {
try {
if (_.isUndefined(path)) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path parameter is expected.");
if (!_.isString(path)) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path parameter is not a string.");
if (!_.includes(path, '/')) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path parameter isn't valid : container/filename.ext.");
// check if file exist
if (!(await this.context.objects().exist(path))) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path does not seem to exist.");
let file = (() => {
let p = path.split('/');
if (p[0] === "")
delete p[0];
p = _.filter(p, (r) => {
return !_.isUndefined(r);
});
return p.join("/");
})();
// call
request({
method: 'HEAD',
uri: encodeURI(this.context.endpoint.url + '/' + file),
headers: {
"X-Auth-Token": this.context.token,
"Accept": "application/json"
}
}, (err, res) => {
err = err || request.checkIfResponseIsError(res);
if (err) // noinspection ExceptionCaughtLocallyJS
throw new Error(err);
return resolve(res.headers);
});
} catch (e) {
return reject(e);
}
});
}
/**
* Expire file at datetime
*
* @param {String} path Path of file with container
* @param {Moment} expire_date
*
* @async
* @return {Promise<Object>}
*/
expire_at(path, expire_date) {
return new Promise(async (resolve, reject) => {
try {
// check
if (_.isUndefined(path)) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path parameter is expected.");
if (!_.isString(path)) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path parameter is not a string.");
if (!_.includes(path, '/')) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path parameter isn't valid : container/filename.ext.");
if (_.isUndefined(expire_date)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Datetime expiration is expected.");
if (!_.isDate(expire_date) && !moment(expire_date).isValid()) // noinspection ExceptionCaughtLocallyJS
throw new Error("Datetime expiration must be a valid datetime.");
// check if file exist
if (!(await this.context.objects().exist(path))) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path does not seem to exist.");
/** @type {Moment} **/
expire_date = (!moment.isMoment(expire_date) ? moment(expire_date) : expire_date);
request({
method: 'POST',
uri: encodeURI(this.context.endpoint.url + '/' + path),
headers: {
"X-Auth-Token": this.context.token,
"X-Delete-At": Math.round(expire_date.toDate().getTime() / 1000),
"Accept": "application/json"
}
}, (err, res) => {
err = err || request.checkIfResponseIsError(res);
if (err) // noinspection ExceptionCaughtLocallyJS
throw new Error(err);
return resolve(res.headers);
});
} catch (e) {
return reject(e);
}
});
}
/**
* Expire file at datetime and return boolean as result
*
* @param {String} path Path of file with container
* @param {Moment} expire_date
*
* @async
* @return {Promise<Boolean>}
*/
async expire_at_with_result(path, expire_date) {
try {
await this.context.objects().expire_at(path, expire_date);
return true;
} catch (e) {
return false;
}
}
/**
* Expire file after X seconds
*
* @param {String} path Path of file with container
* @param {number} delete_seconds
*
* @async
* @return {Promise<Object>}
*/
expire_after(path, delete_seconds) {
return new Promise(async (resolve, reject) => {
try {
// check
if (_.isUndefined(path)) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path parameter is expected.");
if (!_.isString(path)) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path parameter is not a string.");
if (!_.includes(path, '/')) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path parameter isn't valid : container/filename.ext.");
if (_.isUndefined(delete_seconds)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Delete seconds isn't defined.");
if (!_.isNumber(delete_seconds)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Delete seconds isn't an integer.");
// check if file exist
if (!(await this.context.objects().exist(path))) // noinspection ExceptionCaughtLocallyJS
throw new Error("File path does not seem to exist.");
request({
method: 'POST',
uri: encodeURI(this.context.endpoint.url + '/' + path),
headers: {
"X-Auth-Token": this.context.token,
"X-Delete-After": parseInt(delete_seconds),
"Accept": "application/json"
}
}, (err, res) => {
err = err || request.checkIfResponseIsError(res);
if (err) // noinspection ExceptionCaughtLocallyJS
throw new Error(err);
return resolve(res.headers);
});
} catch (e) {
return reject(e);
}
});
}
/**
* Expire file after X seconds and return boolean as result
*
* @param {String} path Path of file with container
* @param {number} delete_seconds
*
* @async
* @return {Promise<Boolean>}
*/
async expire_after_with_result(path, delete_seconds) {
try {
await this.context.objects().expire_after(path, delete_seconds);
return true;
} catch (e) {
return false;
}
}
/**
* Manage meta data of object
* Available methods : create(), update(), delete(), all(), has(), get()
*
* @return {AccountMeta}
*/
metas() {
return new ObjectsMeta(this.context);
}
}
module.exports = Objects;
</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a>
</footer>
<script src="scripts/linenumber.js"></script>
<script src="scripts/pagelocation.js"></script>
</body>
</html>