ghost 4.48.0 → 5.0.2

package/core/server/api/v3/utils/serializers/output/utils/mapper.js

@@ -1,197 +0,0 @@
-const _ = require('lodash');
-const utils = require('../../../index');
-const url = require('./url');
-const date = require('./date');
-const gating = require('./post-gating');
-const clean = require('./clean');
-const extraAttrs = require('./extra-attrs');
-const postsMetaSchema = require('../../../../../../data/schema').tables.posts_meta;
-const mega = require('../../../../../../services/mega');
-
-const mapUser = (model, frame) => {
-    const jsonModel = model.toJSON ? model.toJSON(frame.options) : model;
-
-    url.forUser(model.id, jsonModel, frame.options);
-
-    clean.author(jsonModel, frame);
-
-    return jsonModel;
-};
-
-const mapTag = (model, frame) => {
-    const jsonModel = model.toJSON ? model.toJSON(frame.options) : model;
-
-    url.forTag(model.id, jsonModel, frame.options);
-    clean.tag(jsonModel, frame);
-
-    return jsonModel;
-};
-
-const mapPost = (model, frame) => {
-    const extendedOptions = Object.assign(_.cloneDeep(frame.options), {
-        extraProperties: ['canonical_url']
-    });
-
-    const jsonModel = model.toJSON(extendedOptions);
-
-    url.forPost(model.id, jsonModel, frame);
-
-    extraAttrs.forPost(frame, model, jsonModel);
-
-    if (utils.isContentAPI(frame)) {
-        // Content api v2 still expects page prop
-        if (jsonModel.type === 'page') {
-            jsonModel.page = true;
-        }
-        date.forPost(jsonModel);
-        gating.forPost(jsonModel, frame);
-
-        delete jsonModel.newsletter_id;
-    }
-
-    if (typeof jsonModel.email_recipient_filter === 'undefined') {
-        jsonModel.send_email_when_published = null;
-    } else if (jsonModel.email_recipient_filter === 'none') {
-        jsonModel.send_email_when_published = false;
-    } else {
-        jsonModel.send_email_when_published = true;
-    }
-
-    // Transforms post/page metadata to flat structure
-    let metaAttrs = _.keys(_.omit(postsMetaSchema, ['id', 'post_id']));
-    _(metaAttrs).filter((k) => {
-        return (!frame.options.columns || (frame.options.columns && frame.options.columns.includes(k)));
-    }).each((attr) => {
-        if (!(attr === 'email_only')) {
-            jsonModel[attr] = _.get(jsonModel.posts_meta, attr) || null;
-        }
-    });
-    delete jsonModel.posts_meta;
-
-    clean.post(jsonModel, frame);
-
-    if (frame.options && frame.options.withRelated) {
-        frame.options.withRelated.forEach((relation) => {
-            // @NOTE: this block also decorates primary_tag/primary_author objects as they
-            // are being passed by reference in tags/authors. Might be refactored into more explicit call
-            // in the future, but is good enough for current use-case
-            if (relation === 'tags' && jsonModel.tags) {
-                jsonModel.tags = jsonModel.tags.map(tag => mapTag(tag, frame));
-            }
-
-            if (relation === 'authors' && jsonModel.authors) {
-                jsonModel.authors = jsonModel.authors.map(author => mapUser(author, frame));
-            }
-
-            if (relation === 'email' && jsonModel.email) {
-                jsonModel.email = mapEmail(jsonModel.email, frame);
-            }
-
-            if (relation === 'email' && _.isEmpty(jsonModel.email)) {
-                jsonModel.email = null;
-            }
-        });
-    }
-
-    return jsonModel;
-};
-
-const mapPage = (model, frame) => {
-    const jsonModel = mapPost(model, frame);
-
-    delete jsonModel.email_subject;
-    delete jsonModel.send_email_when_published;
-    delete jsonModel.email_recipient_filter;
-    delete jsonModel.newsletter_id;
-
-    return jsonModel;
-};
-
-const mapSettings = (attrs, frame) => {
-    url.forSettings(attrs);
-    extraAttrs.forSettings(attrs, frame);
-
-    // NOTE: The cleanup of deprecated ghost_head/ghost_foot has to happen here
-    //       because codeinjection_head/codeinjection_foot are assigned on a previous
-    //      `forSettings` step. This logic can be rewritten once we get rid of deprecated
-    //      fields completely.
-    if (_.isArray(attrs)) {
-        const keysToFilter = ['ghost_head', 'ghost_foot'];
-
-        // NOTE: to support edits of deprecated 'slack' setting artificial 'slack_url' and 'slack_username'
-        //       were added to the request body in the input serializer. These should not be returned in response
-        //       body unless directly requested
-        if (frame.original.body && frame.original.body.settings) {
-            const requestedEditSlackUrl = frame.original.body.settings.find(s => s.key === 'slack_url');
-            const requestedEditSlackUsername = frame.original.body.settings.find(s => s.key === 'slack_username');
-
-            if (!requestedEditSlackUrl) {
-                keysToFilter.push('slack_url');
-            }
-
-            if (!requestedEditSlackUsername) {
-                keysToFilter.push('slack_username');
-            }
-        }
-
-        attrs = _.filter(attrs, attr => !(keysToFilter.includes(attr.key)));
-    }
-
-    return attrs;
-};
-
-const mapIntegration = (model, frame) => {
-    const jsonModel = model.toJSON ? model.toJSON(frame.options) : model;
-
-    if (jsonModel.api_keys) {
-        jsonModel.api_keys.forEach((key) => {
-            if (key.type === 'admin') {
-                key.secret = `${key.id}:${key.secret}`;
-            }
-        });
-    }
-
-    return jsonModel;
-};
-
-const mapImage = (path) => {
-    return url.forImage(path);
-};
-
-const mapAction = (model, frame) => {
-    const attrs = model.toJSON(frame.options);
-    clean.action(attrs);
-    return attrs;
-};
-
-const mapLabel = (model, frame) => {
-    const jsonModel = model.toJSON ? model.toJSON(frame.options) : model;
-    return jsonModel;
-};
-
-const mapEmail = (model, frame) => {
-    const jsonModel = model.toJSON ? model.toJSON(frame.options) : model;
-
-    // Ensure we're not outputting unwanted replacement strings when viewing email contents
-    // TODO: extract this to a utility, it's duplicated in the email-preview API controller
-    const replacements = mega.postEmailSerializer.parseReplacements(jsonModel);
-    replacements.forEach((replacement) => {
-        jsonModel[replacement.format] = jsonModel[replacement.format].replace(
-            replacement.match,
-            replacement.fallback || ''
-        );
-    });
-
-    return jsonModel;
-};
-
-module.exports.mapPost = mapPost;
-module.exports.mapPage = mapPage;
-module.exports.mapUser = mapUser;
-module.exports.mapTag = mapTag;
-module.exports.mapLabel = mapLabel;
-module.exports.mapIntegration = mapIntegration;
-module.exports.mapSettings = mapSettings;
-module.exports.mapImage = mapImage;
-module.exports.mapAction = mapAction;
-module.exports.mapEmail = mapEmail;

package/core/server/api/v3/utils/serializers/output/utils/post-gating.js

@@ -1,39 +0,0 @@
-const membersService = require('../../../../../../services/members');
-const htmlToPlaintext = require('../../../../../../../shared/html-to-plaintext');
-
-// @TODO: reconsider the location of this - it's part of members and adds a property to the API
-const forPost = (attrs, frame) => {
-    // CASE: Access always defaults to true, unless members is enabled and the member does not have access
-    if (!Object.prototype.hasOwnProperty.call(frame.options, 'columns') || (frame.options.columns.includes('access'))) {
-        attrs.access = true;
-    }
-
-    const memberHasAccess = membersService.contentGating.checkPostAccess(attrs, frame.original.context.member);
-
-    if (!memberHasAccess) {
-        const paywallIndex = (attrs.html || '').indexOf('<!--members-only-->');
-
-        if (paywallIndex !== -1) {
-            attrs.html = attrs.html.slice(0, paywallIndex);
-            attrs.plaintext = htmlToPlaintext(attrs.html);
-
-            if (!attrs.custom_excerpt && attrs.excerpt) {
-                attrs.excerpt = attrs.plaintext.substring(0, 500);
-            }
-        } else {
-            ['plaintext', 'html', 'excerpt'].forEach((field) => {
-                if (attrs[field] !== undefined) {
-                    attrs[field] = '';
-                }
-            });
-        }
-    }
-
-    if (!Object.prototype.hasOwnProperty.call(frame.options, 'columns') || (frame.options.columns.includes('access'))) {
-        attrs.access = memberHasAccess;
-    }
-
-    return attrs;
-};
-
-module.exports.forPost = forPost;

package/core/server/api/v3/utils/serializers/output/utils/settings-type-group-mapper.js

@@ -1,24 +0,0 @@
-const groupTypeMapping = {
-    core: 'core',
-    amp: 'blog',
-    labs: 'blog',
-    slack: 'blog',
-    site: 'blog',
-    unsplash: 'blog',
-    views: 'blog',
-    theme: 'theme',
-    members: 'members',
-    private: 'private',
-    portal: 'portal',
-    email: 'bulk_email',
-    newsletter: 'newsletter',
-    firstpromoter: 'firstpromoter',
-    oauth: 'oauth',
-    editor: 'editor'
-};
-
-const mapGroupToType = (group) => {
-    return groupTypeMapping[group];
-};
-
-module.exports = mapGroupToType;

package/core/server/api/v3/utils/serializers/output/utils/url.js

@@ -1,67 +0,0 @@
-const urlService = require('../../../../../../services/url');
-const urlUtils = require('../../../../../../../shared/url-utils');
-const localUtils = require('../../../index');
-
-const forPost = (id, attrs, frame) => {
-    attrs.url = urlService.getUrlByResourceId(id, {absolute: true});
-
-    /**
-     * CASE: admin api should serve preview urls
-     *
-     * @NOTE
-     * The url service has no clue of the draft/scheduled concept. It only generates urls for published resources.
-     * Adding a hardcoded fallback into the url service feels wrong IMO.
-     *
-     * 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/v3/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.
-     *
-     * Needs further discussion.
-     */
-    if (!localUtils.isContentAPI(frame)) {
-        if (attrs.status !== 'published' && attrs.url.match(/\/404\//)) {
-            attrs.url = urlUtils.urlFor({
-                relativeUrl: urlUtils.urlJoin('/p', attrs.uuid, '/')
-            }, null, true);
-        }
-    }
-
-    if (frame.options.columns && !frame.options.columns.includes('url')) {
-        delete attrs.url;
-    }
-
-    return attrs;
-};
-
-const forUser = (id, attrs, options) => {
-    if (!options.columns || (options.columns && options.columns.includes('url'))) {
-        attrs.url = urlService.getUrlByResourceId(id, {absolute: true});
-    }
-
-    return attrs;
-};
-
-const forTag = (id, attrs, options) => {
-    if (!options.columns || (options.columns && options.columns.includes('url'))) {
-        attrs.url = urlService.getUrlByResourceId(id, {absolute: true});
-    }
-
-    return attrs;
-};
-
-const forSettings = (attrs) => {
-    return attrs;
-};
-
-const forImage = (path) => {
-    return urlUtils.urlFor('image', {image: path}, true);
-};
-
-module.exports.forPost = forPost;
-module.exports.forUser = forUser;
-module.exports.forTag = forTag;
-module.exports.forSettings = forSettings;
-module.exports.forImage = forImage;

package/core/server/api/v3/utils/serializers/output/webhooks.js

@@ -1,15 +0,0 @@
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:webhooks');
-
-module.exports = {
-    all(models, apiConfig, frame) {
-        debug('all');
-        // CASE: e.g. destroy returns null
-        if (!models) {
-            return;
-        }
-
-        frame.response = {
-            webhooks: [models.toJSON(frame.options)]
-        };
-    }
-};

package/core/server/api/v3/utils/validators/index.js

@@ -1,9 +0,0 @@
-module.exports = {
-    get input() {
-        return require('./input');
-    },
-
-    get output() {
-        return require('./output');
-    }
-};

package/core/server/api/v3/utils/validators/input/images.js

@@ -1,85 +0,0 @@
-const jsonSchema = require('../utils/json-schema');
-const config = require('../../../../../../shared/config');
-const tpl = require('@tryghost/tpl');
-const errors = require('@tryghost/errors');
-const {imageSize, blogIcon} = require('../../../../../lib/image');
-
-const messages = {
-    isNotSquare: 'Please select a valid image file with square dimensions.',
-    invalidFile: 'Icon must be a square .ico or .png file between 60px – 1,000px, under 100kb.'
-};
-
-const profileImage = (frame) => {
-    return imageSize.getImageSizeFromPath(frame.file.path).then((response) => {
-        // save the image dimensions in new property for file
-        frame.file.dimensions = response;
-
-        // CASE: file needs to be a square
-        if (frame.file.dimensions.width !== frame.file.dimensions.height) {
-            return Promise.reject(new errors.ValidationError({
-                message: tpl(messages.isNotSquare)
-            }));
-        }
-    });
-};
-
-const icon = (frame) => {
-    const iconExtensions = (config.get('uploads').icons && config.get('uploads').icons.extensions) || [];
-
-    const validIconFileSize = (size) => {
-        return (size / 1024) <= 100;
-    };
-
-    // CASE: file should not be larger than 100kb
-    if (!validIconFileSize(frame.file.size)) {
-        return Promise.reject(new errors.ValidationError({
-            message: tpl(messages.invalidFile, {extensions: iconExtensions})
-        }));
-    }
-
-    return blogIcon.getIconDimensions(frame.file.path).then((response) => {
-        // save the image dimensions in new property for file
-        frame.file.dimensions = response;
-
-        // CASE: file needs to be a square
-        if (frame.file.dimensions.width !== frame.file.dimensions.height) {
-            return Promise.reject(new errors.ValidationError({
-                message: tpl(messages.invalidFile, {extensions: iconExtensions})
-            }));
-        }
-
-        // CASE: icon needs to be bigger than or equal to 60px
-        // .ico files can contain multiple sizes, we need at least a minimum of 60px (16px is ok, as long as 60px are present as well)
-        if (frame.file.dimensions.width < 60) {
-            return Promise.reject(new errors.ValidationError({
-                message: tpl(messages.invalidFile, {extensions: iconExtensions})
-            }));
-        }
-
-        // CASE: icon needs to be smaller than or equal to 1000px
-        if (frame.file.dimensions.width > 1000) {
-            return Promise.reject(new errors.ValidationError({
-                message: tpl(messages.invalidFile, {extensions: iconExtensions})
-            }));
-        }
-    });
-};
-
-module.exports = {
-    upload(apiConfig, frame) {
-        return Promise.resolve()
-            .then(() => {
-                return jsonSchema.validate(apiConfig, frame);
-            })
-            .then(() => {
-                if (frame.data.purpose === 'profile_image') {
-                    return profileImage(frame);
-                }
-            })
-            .then(() => {
-                if (frame.data.purpose === 'icon') {
-                    return icon(frame);
-                }
-            });
-    }
-};

package/core/server/api/v3/utils/validators/input/index.js

@@ -1,61 +0,0 @@
-module.exports = {
-    get passwordreset() {
-        return require('./passwordreset');
-    },
-
-    get setup() {
-        return require('./setup');
-    },
-
-    get posts() {
-        return require('./posts');
-    },
-
-    get pages() {
-        return require('./pages');
-    },
-
-    get invites() {
-        return require('./invites');
-    },
-
-    get invitations() {
-        return require('./invitations');
-    },
-
-    get members() {
-        return require('./members');
-    },
-
-    get settings() {
-        return require('./settings');
-    },
-
-    get tags() {
-        return require('./tags');
-    },
-
-    get labels() {
-        return require('./labels');
-    },
-
-    get users() {
-        return require('./users');
-    },
-
-    get images() {
-        return require('./images');
-    },
-
-    get oembed() {
-        return require('./oembed');
-    },
-
-    get webhooks() {
-        return require('./webhooks');
-    },
-
-    get snippets() {
-        return require('./snippets');
-    }
-};

package/core/server/api/v3/utils/validators/input/invitations.js

@@ -1,49 +0,0 @@
-const Promise = require('bluebird');
-const validator = require('@tryghost/validator');
-const debug = require('@tryghost/debug')('api:v3:utils:validators:input:invitation');
-const tpl = require('@tryghost/tpl');
-const errors = require('@tryghost/errors');
-
-const messages = {
-    noTokenProvided: 'No token provided.',
-    noEmailProvided: 'No email provided.',
-    noPasswordProvided: 'No password provided.',
-    noNameProvided: 'No name provided.',
-    invalidEmailReceived: 'The server did not receive a valid email'
-};
-
-module.exports = {
-    acceptInvitation(apiConfig, frame) {
-        debug('acceptInvitation');
-
-        const data = frame.data.invitation[0];
-
-        if (!data.token) {
-            return Promise.reject(new errors.ValidationError({message: tpl(messages.noTokenProvided)}));
-        }
-
-        if (!data.email) {
-            return Promise.reject(new errors.ValidationError({message: tpl(messages.noEmailProvided)}));
-        }
-
-        if (!data.password) {
-            return Promise.reject(new errors.ValidationError({message: tpl(messages.noPasswordProvided)}));
-        }
-
-        if (!data.name) {
-            return Promise.reject(new errors.ValidationError({message: tpl(messages.noNameProvided)}));
-        }
-    },
-
-    isInvitation(apiConfig, frame) {
-        debug('isInvitation');
-
-        const email = frame.data.email;
-
-        if (typeof email !== 'string' || !validator.isEmail(email)) {
-            throw new errors.BadRequestError({
-                message: tpl(messages.invalidEmailReceived)
-            });
-        }
-    }
-};

package/core/server/api/v3/utils/validators/input/invites.js

@@ -1,21 +0,0 @@
-const Promise = require('bluebird');
-const tpl = require('@tryghost/tpl');
-const errors = require('@tryghost/errors');
-const models = require('../../../../../models');
-
-const messages = {
-    userAlreadyRegistered: 'User is already registered.'
-};
-
-module.exports = {
-    add(apiConfig, frame) {
-        return models.User.findOne({email: frame.data.invites[0].email}, frame.options)
-            .then((user) => {
-                if (user) {
-                    return Promise.reject(new errors.ValidationError({
-                        message: tpl(messages.userAlreadyRegistered)
-                    }));
-                }
-            });
-    }
-};

package/core/server/api/v3/utils/validators/input/labels.js

@@ -1,6 +0,0 @@
-const jsonSchema = require('../utils/json-schema');
-
-module.exports = {
-    add: jsonSchema.validate,
-    edit: jsonSchema.validate
-};

package/core/server/api/v3/utils/validators/input/members.js

@@ -1,6 +0,0 @@
-const jsonSchema = require('../utils/json-schema');
-
-module.exports = {
-    add: jsonSchema.validate,
-    edit: jsonSchema.validate
-};

package/core/server/api/v3/utils/validators/input/oembed.js

@@ -1,17 +0,0 @@
-const Promise = require('bluebird');
-const tpl = require('@tryghost/tpl');
-const errors = require('@tryghost/errors');
-
-const messages = {
-    noUrlProvided: 'No url provided.'
-};
-
-module.exports = {
-    read(apiConfig, frame) {
-        if (!frame.data.url || !frame.data.url.trim()) {
-            return Promise.reject(new errors.BadRequestError({
-                message: tpl(messages.noUrlProvided)
-            }));
-        }
-    }
-};

package/core/server/api/v3/utils/validators/input/pages.js

@@ -1,46 +0,0 @@
-const jsonSchema = require('../utils/json-schema');
-const models = require('../../../../../models');
-const {ValidationError} = require('@tryghost/errors');
-const tpl = require('@tryghost/tpl');
-
-const messages = {
-    invalidVisibilityFilter: 'Invalid filter in visibility property'
-};
-
-const validateVisibility = async function (frame) {
-    if (!frame.data.pages || !frame.data.pages[0]) {
-        return Promise.resolve();
-    }
-
-    // validate visibility - not done at schema level because this can be an NQL query so needs model access
-    const visibility = frame.data.pages[0].visibility;
-    if (visibility) {
-        if (!['public', 'members', 'paid'].includes(visibility)) {
-            // check filter is valid
-            try {
-                await models.Member.findPage({filter: visibility, limit: 1});
-                return Promise.resolve();
-            } catch (err) {
-                return Promise.reject(new ValidationError({
-                    message: tpl(messages.invalidVisibilityFilter),
-                    property: 'visibility'
-                }));
-            }
-        }
-
-        return Promise.resolve();
-    }
-};
-
-module.exports = {
-    add(apiConfig, frame) {
-        return jsonSchema.validate(...arguments).then(() => {
-            return validateVisibility(frame);
-        });
-    },
-    edit(apiConfig, frame) {
-        return jsonSchema.validate(...arguments).then(() => {
-            return validateVisibility(frame);
-        });
-    }
-};