2014-06-03 17:05:25 +04:00
|
|
|
// # DB API
|
|
|
|
// API for DB operations
|
2013-12-25 04:05:20 +04:00
|
|
|
var dataExport = require('../data/export'),
|
|
|
|
dataImport = require('../data/import'),
|
|
|
|
dataProvider = require('../models'),
|
|
|
|
fs = require('fs-extra'),
|
2014-08-17 10:17:23 +04:00
|
|
|
Promise = require('bluebird'),
|
2014-02-05 12:40:30 +04:00
|
|
|
_ = require('lodash'),
|
2014-07-15 14:40:14 +04:00
|
|
|
path = require('path'),
|
2014-05-09 14:11:29 +04:00
|
|
|
errors = require('../../server/errors'),
|
2014-04-08 17:40:33 +04:00
|
|
|
canThis = require('../permissions').canThis,
|
2013-12-30 03:52:55 +04:00
|
|
|
api = {},
|
2013-10-09 12:52:58 +04:00
|
|
|
db;
|
|
|
|
|
2013-12-30 03:52:55 +04:00
|
|
|
api.settings = require('./settings');
|
|
|
|
|
2014-07-15 14:40:14 +04:00
|
|
|
|
2014-07-23 18:53:03 +04:00
|
|
|
function isValidFile(ext) {
|
|
|
|
if (ext === '.json') {
|
2014-07-15 14:40:14 +04:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
2014-06-03 17:05:25 +04:00
|
|
|
/**
|
|
|
|
* ## DB API Methods
|
|
|
|
*
|
|
|
|
* **See:** [API Methods](index.js.html#api%20methods)
|
|
|
|
*/
|
2013-10-09 12:52:58 +04:00
|
|
|
db = {
|
2014-06-03 17:05:25 +04:00
|
|
|
/**
|
|
|
|
* ### Export Content
|
|
|
|
* Generate the JSON to export
|
|
|
|
*
|
|
|
|
* @public
|
|
|
|
* @param {{context}} options
|
|
|
|
* @returns {Promise} Ghost Export JSON format
|
|
|
|
*/
|
Refactor API arguments
closes #2610, refs #2697
- cleanup API index.js, and add docs
- all API methods take consistent arguments: object & options
- browse, read, destroy take options, edit and add take object and options
- the context is passed as part of options, meaning no more .call
everywhere
- destroy expects an object, rather than an id all the way down to the model layer
- route params such as :id, :slug, and :key are passed as an option & used
to perform reads, updates and deletes where possible - settings / themes
may need work here still
- HTTP posts api can find a post by slug
- Add API utils for checkData
2014-05-08 16:41:19 +04:00
|
|
|
'exportContent': function (options) {
|
|
|
|
options = options || {};
|
2014-04-08 17:40:33 +04:00
|
|
|
|
2014-02-27 19:48:38 +04:00
|
|
|
// Export data, otherwise send error 500
|
Refactor API arguments
closes #2610, refs #2697
- cleanup API index.js, and add docs
- all API methods take consistent arguments: object & options
- browse, read, destroy take options, edit and add take object and options
- the context is passed as part of options, meaning no more .call
everywhere
- destroy expects an object, rather than an id all the way down to the model layer
- route params such as :id, :slug, and :key are passed as an option & used
to perform reads, updates and deletes where possible - settings / themes
may need work here still
- HTTP posts api can find a post by slug
- Add API utils for checkData
2014-05-08 16:41:19 +04:00
|
|
|
return canThis(options.context).exportContent.db().then(function () {
|
2014-08-17 10:17:23 +04:00
|
|
|
return dataExport().then(function (exportedData) {
|
|
|
|
return { db: [exportedData] };
|
|
|
|
}).catch(function (error) {
|
|
|
|
return Promise.reject(new errors.InternalServerError(error.message || error));
|
|
|
|
});
|
|
|
|
}, function () {
|
|
|
|
return Promise.reject(new errors.NoPermissionError('You do not have permission to export data. (no rights)'));
|
2014-04-08 17:40:33 +04:00
|
|
|
});
|
2013-10-09 12:52:58 +04:00
|
|
|
},
|
2014-06-03 17:05:25 +04:00
|
|
|
/**
|
|
|
|
* ### Import Content
|
|
|
|
* Import posts, tags etc from a JSON blob
|
|
|
|
*
|
|
|
|
* @public
|
|
|
|
* @param {{context}} options
|
|
|
|
* @returns {Promise} Success
|
|
|
|
*/
|
2014-01-06 18:05:31 +04:00
|
|
|
'importContent': function (options) {
|
Refactor API arguments
closes #2610, refs #2697
- cleanup API index.js, and add docs
- all API methods take consistent arguments: object & options
- browse, read, destroy take options, edit and add take object and options
- the context is passed as part of options, meaning no more .call
everywhere
- destroy expects an object, rather than an id all the way down to the model layer
- route params such as :id, :slug, and :key are passed as an option & used
to perform reads, updates and deletes where possible - settings / themes
may need work here still
- HTTP posts api can find a post by slug
- Add API utils for checkData
2014-05-08 16:41:19 +04:00
|
|
|
options = options || {};
|
2014-07-15 14:40:14 +04:00
|
|
|
var databaseVersion,
|
|
|
|
type,
|
|
|
|
ext,
|
|
|
|
filepath;
|
2013-10-09 12:52:58 +04:00
|
|
|
|
Refactor API arguments
closes #2610, refs #2697
- cleanup API index.js, and add docs
- all API methods take consistent arguments: object & options
- browse, read, destroy take options, edit and add take object and options
- the context is passed as part of options, meaning no more .call
everywhere
- destroy expects an object, rather than an id all the way down to the model layer
- route params such as :id, :slug, and :key are passed as an option & used
to perform reads, updates and deletes where possible - settings / themes
may need work here still
- HTTP posts api can find a post by slug
- Add API utils for checkData
2014-05-08 16:41:19 +04:00
|
|
|
return canThis(options.context).importContent.db().then(function () {
|
2014-07-15 14:40:14 +04:00
|
|
|
if (!options.importfile || !options.importfile.type || !options.importfile.path) {
|
2014-08-17 10:17:23 +04:00
|
|
|
return Promise.reject(new errors.NoPermissionError('Please select a file to import.'));
|
2014-04-08 17:40:33 +04:00
|
|
|
}
|
2013-10-09 12:52:58 +04:00
|
|
|
|
2014-07-15 14:40:14 +04:00
|
|
|
type = options.importfile.type;
|
|
|
|
ext = path.extname(options.importfile.name).toLowerCase();
|
|
|
|
filepath = options.importfile.path;
|
2014-05-07 09:28:51 +04:00
|
|
|
|
2014-08-17 10:17:23 +04:00
|
|
|
return Promise.resolve(isValidFile(ext)).then(function (result) {
|
2014-07-15 14:40:14 +04:00
|
|
|
if (!result) {
|
2014-08-17 10:17:23 +04:00
|
|
|
return Promise.reject(new errors.UnsupportedMediaTypeError('Please select a .json file to import.'));
|
2014-07-15 14:40:14 +04:00
|
|
|
}
|
|
|
|
}).then(function () {
|
2014-07-29 01:41:45 +04:00
|
|
|
return api.settings.read(
|
|
|
|
{key: 'databaseVersion', context: { internal: true }}
|
|
|
|
).then(function (response) {
|
2014-07-15 14:40:14 +04:00
|
|
|
var setting = response.settings[0];
|
|
|
|
|
2014-08-17 10:17:23 +04:00
|
|
|
return setting.value;
|
2014-07-15 14:40:14 +04:00
|
|
|
});
|
2014-04-08 17:40:33 +04:00
|
|
|
}).then(function (version) {
|
|
|
|
databaseVersion = version;
|
|
|
|
// Read the file contents
|
2014-08-17 10:17:23 +04:00
|
|
|
return Promise.promisify(fs.readFile)(filepath);
|
2014-04-08 17:40:33 +04:00
|
|
|
}).then(function (fileContents) {
|
2014-07-29 01:41:45 +04:00
|
|
|
var importData;
|
2013-10-09 12:52:58 +04:00
|
|
|
|
2014-04-08 17:40:33 +04:00
|
|
|
// Parse the json data
|
|
|
|
try {
|
|
|
|
importData = JSON.parse(fileContents);
|
2014-05-09 04:03:05 +04:00
|
|
|
|
|
|
|
// if importData follows JSON-API format `{ db: [exportedData] }`
|
|
|
|
if (_.keys(importData).length === 1 && Array.isArray(importData.db)) {
|
|
|
|
importData = importData.db[0];
|
|
|
|
}
|
2014-04-08 17:40:33 +04:00
|
|
|
} catch (e) {
|
2014-07-29 01:41:45 +04:00
|
|
|
errors.logError(e, 'API DB import content', 'check that the import file is valid JSON.');
|
2014-08-17 10:17:23 +04:00
|
|
|
return Promise.reject(new errors.BadRequest('Failed to parse the import JSON file'));
|
2014-04-08 17:40:33 +04:00
|
|
|
}
|
2013-10-09 12:52:58 +04:00
|
|
|
|
2014-04-08 17:40:33 +04:00
|
|
|
if (!importData.meta || !importData.meta.version) {
|
2014-08-17 10:17:23 +04:00
|
|
|
return Promise.reject(
|
2014-07-29 01:41:45 +04:00
|
|
|
new errors.ValidationError('Import data does not specify version', 'meta.version')
|
|
|
|
);
|
2014-04-08 17:40:33 +04:00
|
|
|
}
|
2013-10-09 12:52:58 +04:00
|
|
|
|
2014-04-08 17:40:33 +04:00
|
|
|
// Import for the current version
|
|
|
|
return dataImport(databaseVersion, importData);
|
2013-12-29 00:13:47 +04:00
|
|
|
|
2014-08-17 10:17:23 +04:00
|
|
|
}).then(api.settings.updateSettingsCache)
|
|
|
|
.return({ db: [] })
|
|
|
|
.finally(function () {
|
2014-04-08 17:40:33 +04:00
|
|
|
// Unlink the file after import
|
2014-08-17 10:17:23 +04:00
|
|
|
return Promise.promisify(fs.unlink)(filepath);
|
2014-04-08 17:40:33 +04:00
|
|
|
});
|
|
|
|
}, function () {
|
2014-08-17 10:17:23 +04:00
|
|
|
return Promise.reject(new errors.NoPermissionError('You do not have permission to import data. (no rights)'));
|
2013-12-04 06:47:39 +04:00
|
|
|
});
|
2013-12-25 04:05:20 +04:00
|
|
|
},
|
2014-06-03 17:05:25 +04:00
|
|
|
/**
|
|
|
|
* ### Delete All Content
|
|
|
|
* Remove all posts and tags
|
|
|
|
*
|
|
|
|
* @public
|
|
|
|
* @param {{context}} options
|
|
|
|
* @returns {Promise} Success
|
|
|
|
*/
|
Refactor API arguments
closes #2610, refs #2697
- cleanup API index.js, and add docs
- all API methods take consistent arguments: object & options
- browse, read, destroy take options, edit and add take object and options
- the context is passed as part of options, meaning no more .call
everywhere
- destroy expects an object, rather than an id all the way down to the model layer
- route params such as :id, :slug, and :key are passed as an option & used
to perform reads, updates and deletes where possible - settings / themes
may need work here still
- HTTP posts api can find a post by slug
- Add API utils for checkData
2014-05-08 16:41:19 +04:00
|
|
|
'deleteAllContent': function (options) {
|
|
|
|
options = options || {};
|
2014-04-08 17:40:33 +04:00
|
|
|
|
Refactor API arguments
closes #2610, refs #2697
- cleanup API index.js, and add docs
- all API methods take consistent arguments: object & options
- browse, read, destroy take options, edit and add take object and options
- the context is passed as part of options, meaning no more .call
everywhere
- destroy expects an object, rather than an id all the way down to the model layer
- route params such as :id, :slug, and :key are passed as an option & used
to perform reads, updates and deletes where possible - settings / themes
may need work here still
- HTTP posts api can find a post by slug
- Add API utils for checkData
2014-05-08 16:41:19 +04:00
|
|
|
return canThis(options.context).deleteAllContent.db().then(function () {
|
2014-08-17 10:17:23 +04:00
|
|
|
return Promise.resolve(dataProvider.deleteAllContent())
|
|
|
|
.return({ db: [] })
|
|
|
|
.catch(function (error) {
|
|
|
|
return Promise.reject(new errors.InternalServerError(error.message || error));
|
2014-04-08 17:40:33 +04:00
|
|
|
});
|
|
|
|
}, function () {
|
2014-08-17 10:17:23 +04:00
|
|
|
return Promise.reject(new errors.NoPermissionError('You do not have permission to export data. (no rights)'));
|
2014-04-08 17:40:33 +04:00
|
|
|
});
|
2013-11-01 16:12:01 +04:00
|
|
|
}
|
2013-10-09 12:52:58 +04:00
|
|
|
};
|
|
|
|
|
2014-01-29 08:18:00 +04:00
|
|
|
module.exports = db;
|