Ghost/core/server/services/xmlrpc.js
Hannah Wolfe 61e1b19d46
Added comments to all usages of lib/common/events
- This is a precursor to trying to split apart into:
   - model events + webhooks system which makes sense
   - frontend events which should be independent or removed
   - maybe some concept of a settings manager that we can use in various places to bind logic 🤔
   - other usages of events that should be refactored to not use events
2021-07-07 16:02:44 +01:00

133 lines
4.1 KiB
JavaScript

const _ = require('lodash');
const xml = require('xml');
const config = require('../../shared/config');
const urlService = require('../../frontend/services/url');
const errors = require('@tryghost/errors');
const tpl = require('@tryghost/tpl');
const logging = require('@tryghost/logging');
const request = require('@tryghost/request');
const settingsCache = require('../../shared/settings-cache');
const sentry = require('../../shared/sentry');
// Used to receive post.published model event
const events = require('../lib/common/events');
const messages = {
requestFailedError: 'The {service} service was unable to send a ping request, your site will continue to function.',
requestFailedHelp: 'If you get this error repeatedly, please seek help on {url}.'
};
const defaultPostSlugs = [
'welcome',
'the-editor',
'using-tags',
'managing-users',
'private-sites',
'advanced-markdown',
'themes'
];
// ToDo: Make this configurable
const pingList = [
{
url: 'http://rpc.pingomatic.com'
}
];
function ping(post) {
let pingXML;
const title = post.title;
const url = urlService.getUrlByResourceId(post.id, {absolute: true});
if (post.type === 'page' || config.isPrivacyDisabled('useRpcPing') || settingsCache.get('is_private')) {
return;
}
// Don't ping for the default posts.
// This also handles the case where during ghost's first run
// models.init() inserts this post but permissions.init() hasn't
// (can't) run yet.
if (defaultPostSlugs.indexOf(post.slug) > -1) {
return;
}
// Build XML object.
pingXML = xml({
methodCall: [{
methodName: 'weblogUpdates.ping'
}, {
params: [{
param: [{
value: [{
string: title
}]
}]
}, {
param: [{
value: [{
string: url
}]
}]
}]
}]
}, {declaration: true});
// Ping each of the defined services.
_.each(pingList, function (pingHost) {
const options = {
body: pingXML,
timeout: 2 * 1000
};
const goodResponse = /<member>[\s]*<name>flerror<\/name>[\s]*<value>[\s]*<boolean>0<\/boolean><\/value><\/member>/;
const errorMessage = /<name>(?:faultString|message)<\/name>[\s]*<value>[\s]*<string>([^<]+)/;
request(pingHost.url, options)
.then(function (res) {
if (!goodResponse.test(res.body)) {
const matches = res.body.match(errorMessage);
const message = matches ? matches[1] : res.body;
throw new errors.GhostError({message});
}
})
.catch(function (err) {
let error;
if (err.statusCode === 429) {
error = new errors.TooManyRequestsError({
err,
message: err.message,
context: tpl(messages.requestFailedError, {service: 'xmlrpc'}),
help: tpl(messages.requestFailedHelp, {url: 'https://ghost.org/docs/'})
});
} else {
error = new errors.GhostError({
err: err,
message: err.message,
context: tpl(messages.requestFailedError, {service: 'xmlrpc'}),
help: tpl(messages.requestFailedHelp, {url: 'https://ghost.org/docs/'})
});
}
logging.error(error);
sentry.captureException(error);
});
});
}
function listener(model, options) {
// CASE: do not rpc ping if we import a database
// TODO: refactor post.published events to never fire on importing
if (options && options.importing) {
return;
}
ping(model.toJSON());
}
function listen() {
events.on('post.published', listener);
}
module.exports = {
listen: listen
};