2014-06-03 08:05:25 -05:00
|
|
|
// # DB API
|
|
|
|
// API for DB operations
|
2013-12-24 19:05:20 -05:00
|
|
|
var dataExport = require('../data/export'),
|
|
|
|
dataImport = require('../data/import'),
|
|
|
|
dataProvider = require('../models'),
|
|
|
|
fs = require('fs-extra'),
|
2014-08-17 01:17:23 -05:00
|
|
|
Promise = require('bluebird'),
|
2014-02-05 03:40:30 -05:00
|
|
|
_ = require('lodash'),
|
2014-07-15 05:40:14 -05:00
|
|
|
path = require('path'),
|
2014-05-09 05:11:29 -05:00
|
|
|
errors = require('../../server/errors'),
|
2014-04-08 08:40:33 -05:00
|
|
|
canThis = require('../permissions').canThis,
|
2013-12-29 18:52:55 -05:00
|
|
|
api = {},
|
2013-10-09 03:52:58 -05:00
|
|
|
db;
|
|
|
|
|
2013-12-29 18:52:55 -05:00
|
|
|
api.settings = require('./settings');
|
|
|
|
|
2014-07-23 09:53:03 -05:00
|
|
|
function isValidFile(ext) {
|
|
|
|
if (ext === '.json') {
|
2014-07-15 05:40:14 -05:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
2014-06-03 08:05:25 -05:00
|
|
|
/**
|
|
|
|
* ## DB API Methods
|
|
|
|
*
|
|
|
|
* **See:** [API Methods](index.js.html#api%20methods)
|
|
|
|
*/
|
2013-10-09 03:52:58 -05:00
|
|
|
db = {
|
2014-06-03 08:05:25 -05:00
|
|
|
/**
|
|
|
|
* ### Export Content
|
|
|
|
* Generate the JSON to export
|
|
|
|
*
|
|
|
|
* @public
|
|
|
|
* @param {{context}} options
|
|
|
|
* @returns {Promise} Ghost Export JSON format
|
|
|
|
*/
|
2014-09-09 23:06:24 -05:00
|
|
|
exportContent: 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 07:41:19 -05:00
|
|
|
options = options || {};
|
2014-04-08 08:40:33 -05:00
|
|
|
|
2014-02-27 10:48:38 -05: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 07:41:19 -05:00
|
|
|
return canThis(options.context).exportContent.db().then(function () {
|
2014-09-09 23:06:24 -05:00
|
|
|
return dataExport().then(function (exportedData) {
|
|
|
|
return {db: [exportedData]};
|
|
|
|
}).catch(function (error) {
|
|
|
|
return Promise.reject(new errors.InternalServerError(error.message || error));
|
2014-04-08 08:40:33 -05:00
|
|
|
});
|
2014-09-09 23:06:24 -05:00
|
|
|
}, function () {
|
2014-09-27 14:05:35 -05:00
|
|
|
return Promise.reject(new errors.NoPermissionError('You do not have permission to export data (no rights).'));
|
2014-09-09 23:06:24 -05:00
|
|
|
});
|
2013-10-09 03:52:58 -05:00
|
|
|
},
|
2014-06-03 08:05:25 -05:00
|
|
|
/**
|
|
|
|
* ### Import Content
|
|
|
|
* Import posts, tags etc from a JSON blob
|
|
|
|
*
|
|
|
|
* @public
|
|
|
|
* @param {{context}} options
|
|
|
|
* @returns {Promise} Success
|
|
|
|
*/
|
2014-09-09 23:06:24 -05: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 07:41:19 -05:00
|
|
|
options = options || {};
|
2014-07-15 05:40:14 -05:00
|
|
|
var databaseVersion,
|
|
|
|
type,
|
|
|
|
ext,
|
|
|
|
filepath;
|
2013-10-09 03:52:58 -05: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 07:41:19 -05:00
|
|
|
return canThis(options.context).importContent.db().then(function () {
|
2014-07-15 05:40:14 -05:00
|
|
|
if (!options.importfile || !options.importfile.type || !options.importfile.path) {
|
2014-08-17 01:17:23 -05:00
|
|
|
return Promise.reject(new errors.NoPermissionError('Please select a file to import.'));
|
2014-04-08 08:40:33 -05:00
|
|
|
}
|
2013-10-09 03:52:58 -05:00
|
|
|
|
2014-07-15 05:40:14 -05:00
|
|
|
type = options.importfile.type;
|
|
|
|
ext = path.extname(options.importfile.name).toLowerCase();
|
|
|
|
filepath = options.importfile.path;
|
2014-05-07 00:28:51 -05:00
|
|
|
|
2014-08-17 01:17:23 -05:00
|
|
|
return Promise.resolve(isValidFile(ext)).then(function (result) {
|
2014-07-15 05:40:14 -05:00
|
|
|
if (!result) {
|
2014-08-17 01:17:23 -05:00
|
|
|
return Promise.reject(new errors.UnsupportedMediaTypeError('Please select a .json file to import.'));
|
2014-07-15 05:40:14 -05:00
|
|
|
}
|
|
|
|
}).then(function () {
|
2014-07-28 16:41:45 -05:00
|
|
|
return api.settings.read(
|
2014-09-09 23:06:24 -05:00
|
|
|
{key: 'databaseVersion', context: {internal: true}}
|
2014-07-28 16:41:45 -05:00
|
|
|
).then(function (response) {
|
2014-07-15 05:40:14 -05:00
|
|
|
var setting = response.settings[0];
|
|
|
|
|
2014-08-17 01:17:23 -05:00
|
|
|
return setting.value;
|
2014-07-15 05:40:14 -05:00
|
|
|
});
|
2014-04-08 08:40:33 -05:00
|
|
|
}).then(function (version) {
|
|
|
|
databaseVersion = version;
|
|
|
|
// Read the file contents
|
2014-08-17 01:17:23 -05:00
|
|
|
return Promise.promisify(fs.readFile)(filepath);
|
2014-04-08 08:40:33 -05:00
|
|
|
}).then(function (fileContents) {
|
2014-07-28 16:41:45 -05:00
|
|
|
var importData;
|
2013-10-09 03:52:58 -05:00
|
|
|
|
2014-04-08 08:40:33 -05:00
|
|
|
// Parse the json data
|
|
|
|
try {
|
|
|
|
importData = JSON.parse(fileContents);
|
2014-05-08 19:03:05 -05: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 08:40:33 -05:00
|
|
|
} catch (e) {
|
2014-07-28 16:41:45 -05:00
|
|
|
errors.logError(e, 'API DB import content', 'check that the import file is valid JSON.');
|
2014-09-27 14:05:35 -05:00
|
|
|
return Promise.reject(new errors.BadRequestError('Failed to parse the import JSON file.'));
|
2014-04-08 08:40:33 -05:00
|
|
|
}
|
2013-10-09 03:52:58 -05:00
|
|
|
|
2014-04-08 08:40:33 -05:00
|
|
|
if (!importData.meta || !importData.meta.version) {
|
2014-08-17 01:17:23 -05:00
|
|
|
return Promise.reject(
|
2014-07-28 16:41:45 -05:00
|
|
|
new errors.ValidationError('Import data does not specify version', 'meta.version')
|
|
|
|
);
|
2014-04-08 08:40:33 -05:00
|
|
|
}
|
2013-10-09 03:52:58 -05:00
|
|
|
|
2014-04-08 08:40:33 -05:00
|
|
|
// Import for the current version
|
|
|
|
return dataImport(databaseVersion, importData);
|
2014-08-17 01:17:23 -05:00
|
|
|
}).then(api.settings.updateSettingsCache)
|
2014-09-09 23:06:24 -05:00
|
|
|
.return({db: []})
|
2014-08-17 01:17:23 -05:00
|
|
|
.finally(function () {
|
2014-04-08 08:40:33 -05:00
|
|
|
// Unlink the file after import
|
2014-08-17 01:17:23 -05:00
|
|
|
return Promise.promisify(fs.unlink)(filepath);
|
2014-04-08 08:40:33 -05:00
|
|
|
});
|
|
|
|
}, function () {
|
2014-09-27 14:05:35 -05:00
|
|
|
return Promise.reject(new errors.NoPermissionError('You do not have permission to import data (no rights).'));
|
2013-12-03 21:47:39 -05:00
|
|
|
});
|
2013-12-24 19:05:20 -05:00
|
|
|
},
|
2014-06-03 08:05:25 -05:00
|
|
|
/**
|
|
|
|
* ### Delete All Content
|
|
|
|
* Remove all posts and tags
|
|
|
|
*
|
|
|
|
* @public
|
|
|
|
* @param {{context}} options
|
|
|
|
* @returns {Promise} Success
|
|
|
|
*/
|
2014-09-09 23:06:24 -05:00
|
|
|
deleteAllContent: 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 07:41:19 -05:00
|
|
|
options = options || {};
|
2014-04-08 08:40:33 -05: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 07:41:19 -05:00
|
|
|
return canThis(options.context).deleteAllContent.db().then(function () {
|
2014-08-17 01:17:23 -05:00
|
|
|
return Promise.resolve(dataProvider.deleteAllContent())
|
2014-09-09 23:06:24 -05:00
|
|
|
.return({db: []})
|
2014-08-17 01:17:23 -05:00
|
|
|
.catch(function (error) {
|
|
|
|
return Promise.reject(new errors.InternalServerError(error.message || error));
|
2014-04-08 08:40:33 -05:00
|
|
|
});
|
|
|
|
}, function () {
|
2014-09-27 14:05:35 -05:00
|
|
|
return Promise.reject(new errors.NoPermissionError('You do not have permission to export data (no rights).'));
|
2014-04-08 08:40:33 -05:00
|
|
|
});
|
2013-11-01 07:12:01 -05:00
|
|
|
}
|
2013-10-09 03:52:58 -05:00
|
|
|
};
|
|
|
|
|
2014-01-28 23:18:00 -05:00
|
|
|
module.exports = db;
|