// # Ghost Module // Defines core methods required to build the frontend // ## Setup Prerequisites var config = require('./../config'), when = require('when'), express = require('express'), errors = require('./server/errorHandling'), fs = require('fs'), path = require('path'), hbs = require('express-hbs'), nodefn = require('when/node/function'), _ = require('underscore'), Polyglot = require('node-polyglot'), models = require('./server/models'), requireTree = require('./server/require-tree'), themePath = path.resolve(__dirname + '../../content/themes'), pluginPath = path.resolve(__dirname + '../../content/plugins'), themeDirectories = requireTree(themePath), pluginDirectories = requireTree(pluginPath), Ghost, instance, defaults, statuses; // ## Default values /** * A hash of default values to use instead of 'magic' numbers/strings. * @type {Object} */ defaults = { filterPriority: 5, maxPriority: 9 }; // ## Article Statuses /** * A list of atricle status types * @type {Object} */ statuses = { 'draft': 'draft', 'complete': 'complete', 'approved': 'approved', 'scheduled': 'scheduled', 'published': 'published' }; // ## Module Methods /** * @method Ghost * @returns {*} * @constructor */ Ghost = function () { var app, polyglot; if (!instance) { instance = this; // Holds the filters instance.filterCallbacks = []; // Holds the filter hooks (that are built in to Ghost Core) instance.filters = []; // Holds the theme directories temporarily instance.themeDirectories = {}; // Holds the plugin directories temporarily instance.pluginDirectories = {}; app = express(); polyglot = new Polyglot(); // functionality // load Plugins... // var f = new FancyFirstChar(ghost).init(); _.extend(instance, { app: function () { return app; }, config: function () { return config; }, // there's no management here to be sure this has loaded settings: function () { return instance.settingsCache; }, dataProvider: models, statuses: function () { return statuses; }, polyglot: function () { return polyglot; }, getPaths: function () { return when.all([themeDirectories, pluginDirectories]).then(function (paths) { instance.themeDirectories = paths[0]; instance.pluginDirectories = paths[1]; return; }); }, paths: function () { return { 'activeTheme': __dirname + '/../content/' + config.themeDir + '/' + config.activeTheme + '/', 'adminViews': __dirname + '/server/views/', 'helperTemplates': __dirname + '/server/helpers/tpl/', 'lang': __dirname + '/shared/lang/', 'availableThemes': instance.themeDirectories, 'availablePlugins': instance.pluginDirectories }; } }); } return instance; }; Ghost.prototype.init = function () { var self = this; return when.join(instance.dataProvider.init(), instance.getPaths()).then(function () { return self.loadPlugins(); }, errors.logAndThrowError).then(function () { return self.updateSettingsCache(); }, errors.logAndThrowError); }; Ghost.prototype.loadPlugins = function () { var self = this, pluginPaths = _.values(self.paths().availablePlugins), pluginPromises = []; _.each(self.config().activePlugins, function (plugin) { var match = _.find(pluginPaths, function (path) { return new RegExp(plugin + '$').test(path); }); if (match) { pluginPromises.push(require(path.join(pluginPath, plugin))); } }); return when.all(pluginPromises).then(function (plugins) { _.each(plugins, function (plugin) { if (_.isFunction(plugin.init)) { plugin.init(self); } }); }, errors.logAndThrowError); }; Ghost.prototype.updateSettingsCache = function (settings) { var self = this; settings = settings || {}; if (!_.isEmpty(settings)) { self.settingsCache = settings; } else { // TODO: this should use api.browse return models.Settings.findAll().then(function (result) { var settings = {}; _.map(result.models, function (member) { if (!settings.hasOwnProperty(member.attributes.key)) { settings[member.attributes.key] = member.attributes.value; } }); self.settingsCache = settings; }, errors.logAndThrowError); } }; // ## Template utils Ghost.prototype.compileTemplate = function (templatePath) { return nodefn.call(fs.readFile, templatePath).then(function (templateContents) { return hbs.handlebars.compile(templateContents.toString()); }, errors.logAndThrowError); }; Ghost.prototype.loadTemplate = function (name) { // TODO: allow themes to override these templates var templatePath = path.join(this.paths().helperTemplates, name + '.hbs'); return this.compileTemplate(templatePath); }; /** * @param {string} name * @param {Function} fn * @return {method} hbs.registerHelper */ Ghost.prototype.registerThemeHelper = function (name, fn) { hbs.registerHelper(name, fn); }; /** * @param {string} name * @param {Function} fn * @return {*} */ Ghost.prototype.registerTheme = function (name, fn) { return this; }; /** * @param {string} name * @param {Function} fn * @return {*} */ Ghost.prototype.registerPlugin = function (name, fn) { return this; }; /** * @param {string} name * @param {integer} priority * @param {Function} fn */ Ghost.prototype.registerFilter = function (name, priority, fn) { // Curry the priority optional parameter to a default of 5 if (_.isFunction(priority)) { fn = priority; priority = defaults.filterPriority; } this.filterCallbacks[name] = this.filterCallbacks[name] || {}; this.filterCallbacks[name][priority] = this.filterCallbacks[name][priority] || []; this.filterCallbacks[name][priority].push(fn); }; /** * @param {string} name [description] * @param {*} args * @param {Function} callback * @return {method} callback */ Ghost.prototype.doFilter = function (name, args, callback) { var callbacks = this.filterCallbacks[name]; // Bug out early if no callbacks by that name if (!callbacks) { return callback(args); } _.times(defaults.maxPriority + 1, function (priority) { // Bug out if no handlers on this priority if (!_.isArray(callbacks[priority])) { return; } // Call each handler for this priority level _.each(callbacks[priority], function (filterHandler) { try { args = filterHandler(args); } catch (e) { // If a filter causes an error, we log it so that it can be debugged, but do not throw the error errors.logError(e); } }); }); callback(args); }; /** * Initialise Theme * * @todo Tod (?) Old comment * @param {Object} app */ Ghost.prototype.initTheme = function (app) { var self = this; return function initTheme(req, res, next) { app.set('view engine', 'hbs'); // return the correct mime type for woff files express['static'].mime.define({'application/font-woff': ['woff']}); if (!res.isAdmin) { app.engine('hbs', hbs.express3( {partialsDir: self.paths().activeTheme + 'partials'} )); app.set('views', self.paths().activeTheme); } else { app.engine('hbs', hbs.express3({partialsDir: self.paths().adminViews + 'partials'})); app.set('views', self.paths().adminViews); app.use('/public', express['static'](path.join(__dirname, '/client/assets'))); app.use('/public', express['static'](path.join(__dirname, '/client'))); app.use('/shared', express['static'](path.join(__dirname, '/shared/'))); } app.use(express['static'](self.paths().activeTheme)); app.use('/content/images', express['static'](path.join(__dirname, '/../content/images'))); next(); }; }; // TODO: Expose the defaults for other people to see/manipulate as a static value? // Ghost.defaults = defaults; module.exports = Ghost;