✨ Custom post templates (#9073)

closes #9060

- Update `gscan` - it now extracts custom templates and exposes them to Ghost
- Add `custom_template` field to post schema w/ 1.13 migration
- Return `templates` array for the active theme in `/themes/` requests
- Users with Author/Editor roles can now request `/themes/`
- Front-end will render `custom_template` for posts if it exists, template priority is now:
  1. `post/page-{{slug}}.hbs`
  2. `{{custom_template}}.hbs`
  3. `post/page.hbs`

core/server/api/themes.js

@@ -20,6 +20,12 @@ var debug = require('ghost-ignition').debug('api:themes'),
  * **See:** [API Methods](index.js.html#api%20methods)
  */
 themes = {
+    /**
+     * Every role can browse all themes. The response contains a list of all available themes in your content folder.
+     * The active theme get's marked as `active:true` and contains an extra object `templates`, which
+     * contains the custom templates of the active theme. These custom templates are used to show a dropdown
+     * in the PSM to be able to choose a custom post template.
+     */
     browse: function browse(options) {
         return apiUtils
             // Permissions

core/server/controllers/frontend/templates.js

@@ -66,22 +66,26 @@ function getChannelTemplateHierarchy(channelOpts) {
  *
  * Fetch the ordered list of templates that can be used to render this request.
  * 'post' is the default / fallback
- * For posts: [post-:slug, post]
- * For pages: [page-:slug, page, post]
+ * For posts: [post-:slug, custom-*, post]
+ * For pages: [page-:slug, custom-*, page, post]
  *
- * @param {Object} single
+ * @param {Object} postObject
  * @returns {String[]}
  */
-function getSingleTemplateHierarchy(single) {
+function getSingleTemplateHierarchy(postObject) {
     var templateList = ['post'],
-        type = 'post';
+        slugTemplate = 'post-' + postObject.slug;
 
-    if (single.page) {
+    if (postObject.page) {
         templateList.unshift('page');
-        type = 'page';
+        slugTemplate = 'page-' + postObject.slug;
     }
 
-    templateList.unshift(type + '-' + single.slug);
+    if (postObject.custom_template) {
+        templateList.unshift(postObject.custom_template);
+    }
+
+    templateList.unshift(slugTemplate);
 
     return templateList;
 }
@@ -117,8 +121,8 @@ function pickTemplate(templateList, fallback) {
     return template;
 }
 
-function getTemplateForSingle(single) {
-    var templateList = getSingleTemplateHierarchy(single),
+function getTemplateForSingle(postObject) {
+    var templateList = getSingleTemplateHierarchy(postObject),
         fallback = templateList[templateList.length - 1];
     return pickTemplate(templateList, fallback);
 }

core/server/data/migrations/versions/1.13/1-custom-template-post.js

@@ -0,0 +1,30 @@
+'use strict';
+
+const Promise = require('bluebird'),
+    logging = require('../../../../logging'),
+    commands = require('../../../schema').commands,
+    table = 'posts',
+    column = 'custom_template',
+    message = 'Adding column: ' + table + '.' + column;
+
+module.exports = function addCustomTemplateField(options) {
+    let transacting = options.transacting;
+
+    return transacting.schema.hasTable(table)
+        .then(function (exists) {
+            if (!exists) {
+                return Promise.reject(new Error('Table does not exist!'));
+            }
+
+            return transacting.schema.hasColumn(table, column);
+        })
+        .then(function (exists) {
+            if (exists) {
+                logging.warn(message);
+                return Promise.resolve();
+            }
+
+            logging.info(message);
+            return commands.addColumn(table, column, transacting);
+        });
+};

core/server/data/migrations/versions/1.13/2-theme-permissions.js

@@ -0,0 +1,39 @@
+var _ = require('lodash'),
+    utils = require('../../../schema/fixtures/utils'),
+    permissions = require('../../../../permissions'),
+    logging = require('../../../../logging'),
+    resource = 'theme',
+    _private = {};
+
+_private.getPermissions = function getPermissions() {
+    return utils.findModelFixtures('Permission', {object_type: resource});
+};
+
+_private.getRelations = function getRelations() {
+    return utils.findPermissionRelationsForObject(resource);
+};
+
+_private.printResult = function printResult(result, message) {
+    if (result.done === result.expected) {
+        logging.info(message);
+    } else {
+        logging.warn('(' + result.done + '/' + result.expected + ') ' + message);
+    }
+};
+
+module.exports = function addRedirectsPermissions(options) {
+    var modelToAdd = _private.getPermissions(),
+        relationToAdd = _private.getRelations(),
+        localOptions = _.merge({
+            context: {internal: true}
+        }, options);
+
+    return utils.addFixturesForModel(modelToAdd, localOptions).then(function (result) {
+        _private.printResult(result, 'Adding permissions fixtures for ' + resource + 's');
+        return utils.addFixturesForRelation(relationToAdd, localOptions);
+    }).then(function (result) {
+        _private.printResult(result, 'Adding permissions_roles fixtures for ' + resource + 's');
+    }).then(function () {
+        return permissions.init(localOptions);
+    });
+};

core/server/data/schema/fixtures/fixtures.json

@@ -482,7 +482,8 @@
                     "role": "all",
                     "client": "all",
                     "subscriber": ["add"],
-                    "invite": "all"
+                    "invite": "all",
+                    "theme": ["browse"]
                 },
                 "Author": {
                     "post": ["browse", "read", "add"],
@@ -492,7 +493,8 @@
                     "user": ["browse", "read"],
                     "role": ["browse"],
                     "client": "all",
-                    "subscriber": ["add"]
+                    "subscriber": ["add"],
+                    "theme": ["browse"]
                 }
             }
         },

core/server/data/schema/schema.js

@@ -31,7 +31,8 @@ module.exports = {
         og_description: {type: 'string', maxlength: 500, nullable: true},
         twitter_image: {type: 'string', maxlength: 2000, nullable: true},
         twitter_title: {type: 'string', maxlength: 300, nullable: true},
-        twitter_description: {type: 'string', maxlength: 500, nullable: true}
+        twitter_description: {type: 'string', maxlength: 500, nullable: true},
+        custom_template: {type: 'string', maxlength: 100, nullable: true}
     },
     users: {
         id: {type: 'string', maxlength: 24, nullable: false, primary: true},

core/server/themes/active.js

@@ -16,8 +16,7 @@
  * No properties marked with an _ should be used directly.
  *
  */
-var _ = require('lodash'),
-    join = require('path').join,
+var join = require('path').join,
     themeConfig = require('./config'),
     config = require('../config'),
     engine = require('./engine'),
@@ -42,14 +41,11 @@ class ActiveTheme {
         this._packageInfo = loadedTheme['package.json'];
         this._partials =  checkedTheme.partials;
 
-        // @TODO: get gscan to return a template collection for us
-        this._templates = _.reduce(checkedTheme.files, function (templates, entry) {
-            var tplMatch = entry.file.match(/(^[^\/]+).hbs$/);
-            if (tplMatch) {
-                templates.push(tplMatch[1]);
-            }
-            return templates;
-        }, []);
+        // all custom .hbs templates (e.g. custom-about)
+        this._customTemplates = checkedTheme.templates.custom;
+
+        // all .hbs templates
+        this._templates = checkedTheme.templates.all;
 
         // Create a theme config object
         this._config = themeConfig.create(this._packageInfo);
@@ -59,6 +55,10 @@ class ActiveTheme {
         return this._name;
     }
 
+    get customTemplates() {
+        return this._customTemplates;
+    }
+
     get path() {
         return this._path;
     }

core/server/themes/to-json.js

@@ -1,10 +1,16 @@
 var _ = require('lodash'),
     themeList = require('./list'),
+    active = require('./active'),
     packages = require('../utils/packages'),
     settingsCache = require('../settings/cache');
 
 /**
- * Provides a JSON object which can be returned via the API
+ *
+ * Provides a JSON object which can be returned via the API.
+ * You can either request all themes or a specific theme if you pass the `name` argument.
+ * Furthermore, you can pass a gscan result to filter warnings/errors.
+ *
+ * @TODO: settingsCache.get('active_theme') vs. active.get().name
  *
  * @param {string} [name] - the theme to output
  * @param {object} [checkedTheme] - a theme result from gscan
@@ -15,10 +21,8 @@ module.exports = function toJSON(name, checkedTheme) {
 
     if (!name) {
         toFilter = themeList.getAll();
-        // Default to returning the full list
         themeResult = packages.filterPackages(toFilter, settingsCache.get('active_theme'));
     } else {
-        // If we pass in a gscan result, convert this instead
         toFilter = {
             [name]: themeList.get(name)
         };
@@ -34,5 +38,10 @@ module.exports = function toJSON(name, checkedTheme) {
         }
     }
 
+    // CASE: if you want a JSON response for a single theme, which is not active.
+    if (_.find(themeResult, {active: true}) && active.get()) {
+        _.find(themeResult, {active: true}).templates = active.get().customTemplates;
+    }
+
     return {themes: themeResult};
 };

core/test/functional/routes/api/posts_spec.js

@@ -766,6 +766,7 @@ describe('Post API', function () {
                         should.exist(jsonResponse.posts[0]);
                         jsonResponse.posts[0].title = changedTitle;
                         jsonResponse.posts[0].author = changedAuthor;
+                        jsonResponse.posts[0].custom_template = 'custom-about';
 
                         request.put(testUtils.API.getApiQuery('posts/' + testUtils.DataGenerator.Content.posts[0].id + '/'))
                             .set('Authorization', 'Bearer ' + ownerAccessToken)
@@ -783,6 +784,8 @@ describe('Post API', function () {
                                 should.exist(putBody);
                                 putBody.posts[0].title.should.eql(changedTitle);
                                 putBody.posts[0].author.should.eql(changedAuthor);
+                                putBody.posts[0].status.should.eql('published');
+                                putBody.posts[0].custom_template.should.eql('custom-about');
 
                                 testUtils.API.checkResponse(putBody.posts[0], 'post');
                                 done();