ghost 5.2.2 → 5.3.0

package/core/server/api/{canary → endpoints}/utils/serializers/output/index.js

@@ -13,6 +13,10 @@ module.exports = {
         return require('./default');
     },
 
+    get comments() {
+        return require('./comments');
+    },
+
     get authentication() {
         return require('./authentication');
     },
@@ -21,6 +25,10 @@ module.exports = {
         return require('./db');
     },
 
+    get explore() {
+        return require('./explore');
+    },
+
     get pages() {
         return require('./pages');
     },

package/core/server/api/{canary → endpoints}/utils/serializers/output/mail.js

@@ -1,5 +1,5 @@
 const _ = require('lodash');
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:mail');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:mail');
 
 module.exports = {
     all(response, apiConfig, frame) {

package/core/server/api/endpoints/utils/serializers/output/mappers/comments.js

@@ -0,0 +1,50 @@
+const _ = require('lodash');
+
+const commentFields = [
+    'id',
+    'status',
+    'html',
+    'created_at',
+    'edited_at'
+];
+
+const memberFields = [
+    'id',
+    'uuid',
+    'name',
+    'bio',
+    'avatar_image'
+];
+
+const commentMapper = (model, frame) => {
+    const jsonModel = model.toJSON ? model.toJSON(frame.options) : model;
+
+    const response = _.pick(jsonModel, commentFields);
+
+    if (jsonModel.member) {
+        response.member = _.pick(jsonModel.member, memberFields);
+    } else {
+        response.member = null;
+    }
+
+    if (jsonModel.likes) {
+        response.likes_count = jsonModel.likes.length;
+    } else {
+        response.likes_count = 0;
+    }
+
+    if (jsonModel.replies) {
+        response.replies = jsonModel.replies.map(reply => commentMapper(reply, frame));
+    }
+
+    // todo
+    response.liked = false;
+    if (jsonModel.likes && frame.original.context.member && frame.original.context.member.id) {
+        const id = frame.original.context.member.id;
+        response.liked = !!jsonModel.likes.find(l => l.member_id === id);
+    }
+
+    return response;
+};
+
+module.exports = commentMapper;

package/core/server/api/{canary → endpoints}/utils/serializers/output/mappers/index.js

@@ -1,6 +1,7 @@
 module.exports = {
     actions: require('./actions'),
     authors: require('./authors'),
+    comments: require('./comments'),
     emails: require('./emails'),
     images: require('./images'),
     integrations: require('./integrations'),

package/core/server/api/{canary → endpoints}/utils/serializers/output/members.js

@@ -1,5 +1,5 @@
 //@ts-check
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:members');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:members');
 const {unparse} = require('@tryghost/members-csv');
 
 module.exports = {

package/core/server/api/{canary → endpoints}/utils/serializers/output/notifications.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:notifications');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:notifications');
 
 module.exports = {
     all(response, apiConfig, frame) {

package/core/server/api/{canary → endpoints}/utils/serializers/output/oembed.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:oembed');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:oembed');
 
 module.exports = {
     all(data, apiConfig, frame) {

package/core/server/api/{canary → endpoints}/utils/serializers/output/offers.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:offers');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:offers');
 const utils = require('../../index');
 
 module.exports = {

package/core/server/api/{canary → endpoints}/utils/serializers/output/pages.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:pages');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:pages');
 const mappers = require('./mappers');
 const membersService = require('../../../../../services/members');
 

package/core/server/api/{canary → endpoints}/utils/serializers/output/posts.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:posts');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:posts');
 const mappers = require('./mappers');
 const membersService = require('../../../../../services/members');
 

package/core/server/api/{canary → endpoints}/utils/serializers/output/roles.js

@@ -1,5 +1,5 @@
 const Promise = require('bluebird');
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:roles');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:roles');
 const canThis = require('../../../../../services/permissions').canThis;
 
 module.exports = {

package/core/server/api/{canary → endpoints}/utils/serializers/output/session.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:session');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:session');
 
 module.exports = {
     all(data, apiConfig, frame) {

package/core/server/api/{canary → endpoints}/utils/serializers/output/site.js

@@ -1,5 +1,5 @@
 const _ = require('lodash');
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:site');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:site');
 
 module.exports = {
     read(data, apiConfig, frame) {

package/core/server/api/{canary → endpoints}/utils/serializers/output/slack.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:slack');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:slack');
 
 module.exports = {
     all(data, apiConfig, frame) {

package/core/server/api/{canary → endpoints}/utils/serializers/output/slugs.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:slugs');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:slugs');
 
 module.exports = {
     all(slug, apiConfig, frame) {

package/core/server/api/{canary → endpoints}/utils/serializers/output/themes.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:themes');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:themes');
 
 module.exports = {
     all(data, apiConfig, frame) {

package/core/server/api/{canary → endpoints}/utils/serializers/output/tiers.js

@@ -1,5 +1,5 @@
 //@ts-check
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:tiers');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:tiers');
 
 const allowedIncludes = ['monthly_price', 'yearly_price'];
 const localUtils = require('../../index');

package/core/server/api/{canary → endpoints}/utils/serializers/output/users.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:users');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:users');
 const tpl = require('@tryghost/tpl');
 
 const messages = {

package/core/server/api/{canary → endpoints}/utils/serializers/output/utils/clean.js

@@ -31,11 +31,12 @@ const author = (attrs, frame) => {
         delete attrs.last_seen;
         delete attrs.status;
         delete attrs.email;
+        delete attrs.comment_notifications;
 
         // @NOTE: used for night shift
         delete attrs.accessibility;
 
-        // Extra properties removed from canary
+        // Extra properties removed from current API
         delete attrs.tour;
 
         // We are standardising on returning null from the Content API for any empty values

package/core/server/api/endpoints/utils/serializers/output/utils/extra-attrs.js

@@ -0,0 +1,67 @@
+const readingMinutes = require('@tryghost/helpers').utils.readingMinutes;
+
+module.exports.forPost = (frame, model, attrs) => {
+    const _ = require('lodash');
+    // This function is split up in 3 conditions for 3 different purposes:
+    // 1. Gets excerpt from post's plaintext. If custom_excerpt exists, it overrides the excerpt but the key remains excerpt.
+    if (Object.prototype.hasOwnProperty.call(frame.options, 'columns') || _.includes(frame.options.columns, 'excerpt') || _.includes(frame.options.columns, 'excerpt') && frame.options.formats && frame.options.formats.includes('plaintext')) {
+        if (_.includes(frame.options.columns, 'excerpt')) {
+            if (!attrs.custom_excerpt || attrs.custom_excerpt === null) {
+                let plaintext = model.get('plaintext');
+                if (plaintext) {
+                    attrs.excerpt = plaintext.substring(0, 500);
+                } else {
+                    attrs.excerpt = null;
+                }
+                if (!frame.options.columns.includes('custom_excerpt')) {
+                    delete attrs.custom_excerpt;
+                }
+            } else {
+                attrs.excerpt = attrs.custom_excerpt;
+                if (!_.includes(frame.options.columns, 'custom_excerpt')) {
+                    delete attrs.custom_excerpt;
+                }
+            }
+        }
+    }
+    // 2. Displays plaintext if requested by user as a field. Also works if used as format.
+    if (_.includes(frame.options.columns, 'plaintext') || frame.options.formats && frame.options.formats.includes('plaintext')) {
+        let plaintext = model.get('plaintext');
+        if (plaintext){
+            attrs.plaintext = plaintext;
+        } else {
+            delete attrs.plaintext;
+        }
+    }
+
+    // 3. Displays excerpt if no columns was requested - specifically needed for the Admin Posts API.
+
+    if (!Object.prototype.hasOwnProperty.call(frame.options, 'columns')) {
+        let plaintext = model.get('plaintext');
+        let customExcerpt = model.get('custom_excerpt');
+
+        if (customExcerpt !== null){
+            attrs.excerpt = customExcerpt;
+        } else {
+            if (plaintext) {
+                attrs.excerpt = plaintext.substring(0, 500);
+            } else {
+                attrs.excerpt = null;
+            }
+        }
+    }
+
+    // reading_time still only works when used along with formats=html.
+
+    if (!Object.prototype.hasOwnProperty.call(frame.options, 'columns') ||
+        (frame.options.columns.includes('reading_time'))) {
+        if (attrs.html) {
+            let additionalImages = 0;
+
+            if (attrs.feature_image) {
+                additionalImages += 1;
+            }
+            attrs.reading_time = readingMinutes(attrs.html, additionalImages);
+        }
+    }
+};

package/core/server/api/{canary → endpoints}/utils/serializers/output/utils/url.js

@@ -14,7 +14,7 @@ const forPost = (id, attrs, frame) => {
      *
      * Imagine the site won't be part of core and core does not serve urls anymore.
      * Core needs to offer a preview API, which returns draft posts.
-     * That means the url is no longer /p/:uuid, it's e.g. GET /api/canary/content/preview/:uuid/.
+     * That means the url is no longer /p/:uuid, it's e.g. GET /api/content/preview/:uuid/.
      * /p/ is a concept of the site, not of core.
      *
      * The site is not aware of existing drafts. It won't be able to get the uuid.

package/core/server/api/{canary → endpoints}/utils/validators/input/invitations.js

@@ -1,6 +1,6 @@
 const Promise = require('bluebird');
 const validator = require('@tryghost/validator');
-const debug = require('@tryghost/debug')('api:canary:utils:validators:input:invitation');
+const debug = require('@tryghost/debug')('api:endpoints:utils:validators:input:invitation');
 const tpl = require('@tryghost/tpl');
 const errors = require('@tryghost/errors');
 

package/core/server/api/{canary → endpoints}/utils/validators/input/password_reset.js

@@ -1,6 +1,6 @@
 const Promise = require('bluebird');
 const validator = require('@tryghost/validator');
-const debug = require('@tryghost/debug')('api:canary:utils:validators:input:passwordreset');
+const debug = require('@tryghost/debug')('api:endpoints:utils:validators:input:passwordreset');
 const tpl = require('@tryghost/tpl');
 const errors = require('@tryghost/errors');
 

package/core/server/api/{canary → endpoints}/utils/validators/input/setup.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('api:canary:utils:validators:input:updateSetup');
+const debug = require('@tryghost/debug')('api:endpoints:utils:validators:input:updateSetup');
 const tpl = require('@tryghost/tpl');
 const errors = require('@tryghost/errors');
 

package/core/server/api/{canary → endpoints}/utils/validators/input/users.js

@@ -1,5 +1,5 @@
 const Promise = require('bluebird');
-const debug = require('@tryghost/debug')('api:canary:utils:validators:input:users');
+const debug = require('@tryghost/debug')('api:endpoints:utils:validators:input:users');
 const tpl = require('@tryghost/tpl');
 const errors = require('@tryghost/errors');
 

package/core/server/api/index.js

@@ -1,3 +1,3 @@
-module.exports.endpoints = require('./canary');
+module.exports.endpoints = require('./endpoints');
 
 module.exports.shared = require('./shared');

package/core/server/data/exporter/table-lists.js

@@ -31,8 +31,10 @@ const BACKUP_TABLES = [
     'members_paid_subscription_events',
     'members_subscribe_events',
     'members_product_events',
-    'members_newsletters'
-
+    'members_newsletters',
+    'comments',
+    'comment_likes',
+    'comment_reports'
 ];
 
 // NOTE: exposing only tables which are going to be included in a "default" export file

package/core/server/data/migrations/versions/5.3/2022-07-04-13-49-add-comments-table.js

@@ -0,0 +1,13 @@
+const {addTable} = require('../../utils');
+
+module.exports = addTable('comments', {
+    id: {type: 'string', maxlength: 24, nullable: false, primary: true},
+    post_id: {type: 'string', maxlength: 24, nullable: false, unique: false, references: 'posts.id', cascadeDelete: true},
+    member_id: {type: 'string', maxlength: 24, nullable: true, unique: false, references: 'members.id'},
+    parent_id: {type: 'string', maxlength: 24, nullable: true, unique: false, references: 'comments.id'},
+    status: {type: 'string', maxlength: 50, nullable: false, defaultTo: 'published', validations: {isIn: [['published', 'hidden', 'deleted']]}},
+    html: {type: 'text', maxlength: 1000000000, fieldtype: 'long', nullable: true},
+    edited_at: {type: 'dateTime', nullable: true},
+    created_at: {type: 'dateTime', nullable: false},
+    updated_at: {type: 'dateTime', nullable: false}
+});

package/core/server/data/migrations/versions/5.3/2022-07-05-09-36-add-comments-likes-table.js

@@ -0,0 +1,9 @@
+const {addTable} = require('../../utils');
+
+module.exports = addTable('comment_likes', {
+    id: {type: 'string', maxlength: 24, nullable: false, primary: true},
+    comment_id: {type: 'string', maxlength: 24, nullable: false, unique: false, references: 'comments.id', cascadeDelete: true},
+    member_id: {type: 'string', maxlength: 24, nullable: true, unique: false, references: 'members.id'},
+    created_at: {type: 'dateTime', nullable: false},
+    updated_at: {type: 'dateTime', nullable: false}
+});

package/core/server/data/migrations/versions/5.3/2022-07-05-09-47-add-comments-reports-table.js

@@ -0,0 +1,10 @@
+const {addTable} = require('../../utils');
+
+module.exports = addTable('comment_reports', {
+    id: {type: 'string', maxlength: 24, nullable: false, primary: true},
+    comment_id: {type: 'string', maxlength: 24, nullable: false, unique: false, references: 'comments.id', cascadeDelete: true},
+    member_id: {type: 'string', maxlength: 24, nullable: true, unique: false, references: 'members.id'},
+    reason: {type: 'text', maxlength: 65535, nullable: false},
+    created_at: {type: 'dateTime', nullable: false},
+    updated_at: {type: 'dateTime', nullable: false}
+});

package/core/server/data/migrations/versions/5.3/2022-07-05-10-00-add-comment-related-fields-to-members.js

@@ -0,0 +1,21 @@
+const {createAddColumnMigration, combineNonTransactionalMigrations} = require('../../utils');
+
+module.exports = combineNonTransactionalMigrations(
+    createAddColumnMigration('members', 'last_commented_at', {
+        type: 'dateTime',
+        nullable: true
+    }),
+
+    createAddColumnMigration('members', 'bio', {
+        type: 'string',
+        nullable: true,
+        maxlength: 191,
+        validations: {isLength: {max: 50}}
+    }),
+
+    createAddColumnMigration('members', 'enable_comment_notifications', {
+        type: 'boolean',
+        nullable: false,
+        defaultTo: true
+    })
+);

package/core/server/data/migrations/versions/5.3/2022-07-05-12-55-add-comments-crud-permissions.js

@@ -0,0 +1,68 @@
+const {combineTransactionalMigrations, addPermissionWithRoles} = require('../../utils');
+
+module.exports = combineTransactionalMigrations(
+    addPermissionWithRoles({
+        name: 'Browse comments',
+        action: 'browse',
+        object: 'comment'
+    }, [
+        'Administrator',
+        'Admin Integration'
+    ]),
+    addPermissionWithRoles({
+        name: 'Read comments',
+        action: 'read',
+        object: 'comment'
+    }, [
+        'Administrator',
+        'Admin Integration'
+    ]),
+    addPermissionWithRoles({
+        name: 'Edit comments',
+        action: 'edit',
+        object: 'comment'
+    }, [
+        'Administrator',
+        'Admin Integration'
+    ]),
+    addPermissionWithRoles({
+        name: 'Add comments',
+        action: 'add',
+        object: 'comment'
+    }, [
+        'Administrator',
+        'Admin Integration'
+    ]),
+    addPermissionWithRoles({
+        name: 'Delete comments',
+        action: 'destroy',
+        object: 'comment'
+    }, [
+        'Administrator',
+        'Admin Integration'
+    ]),
+    addPermissionWithRoles({
+        name: 'Moderate comments',
+        action: 'moderate',
+        object: 'comment'
+    }, [
+        'Administrator',
+        'Admin Integration'
+    ]),
+    addPermissionWithRoles({
+        name: 'Like comments',
+        action: 'like',
+        object: 'comment'
+    }, [
+        'Administrator',
+        'Admin Integration'
+    ]),
+    addPermissionWithRoles({
+        name: 'Unlike comments',
+        action: 'unlike',
+        object: 'comment'
+    }, [
+        'Administrator',
+        'Admin Integration'
+    ])
+);

package/core/server/data/migrations/versions/5.3/2022-07-05-15-35-add-comment-notifications-field-to-users-table.js

@@ -0,0 +1,7 @@
+const {createAddColumnMigration} = require('../../utils');
+
+module.exports = createAddColumnMigration('users', 'comment_notifications', {
+    type: 'boolean',
+    nullable: false,
+    defaultTo: true
+});

package/core/server/data/migrations/versions/5.3/2022-07-06-07-26-add-comments-enabled-setting.js

@@ -0,0 +1,8 @@
+const {addSetting} = require('../../utils');
+
+module.exports = addSetting({
+    key: 'comments_enabled',
+    value: 'off',
+    type: 'string',
+    group: 'comments'
+});

package/core/server/data/migrations/versions/5.3/2022-07-06-07-58-add-ghost-explore-integration-role.js

@@ -0,0 +1,31 @@
+const logging = require('@tryghost/logging');
+const {default: ObjectID} = require('bson-objectid');
+const {createTransactionalMigration, meta} = require('../../utils');
+
+module.exports = createTransactionalMigration(
+    async function up(knex) {
+        logging.info('Creating "Ghost Explore Integration" role');
+        const existingRole = await knex('roles').where({
+            name: 'Ghost Explore Integration'
+        }).first();
+
+        if (existingRole) {
+            logging.warn('"Ghost Explore Integration" role already exists, skipping');
+            return;
+        }
+
+        await knex('roles').insert({
+            id: (new ObjectID()).toHexString(),
+            name: 'Ghost Explore Integration',
+            description: 'Internal Integration for the Ghost Explore directory',
+            created_by: meta.MIGRATION_USER,
+            created_at: knex.raw('current_timestamp')
+        });
+    },
+    async function down(knex) {
+        logging.info('Deleting role "Ghost Explore Integration"');
+        await knex('roles').where({
+            name: 'Ghost Explore Integration'
+        }).del();
+    }
+);