domma-cms 0.89.1 → 0.90.1

package/plugins/seo/admin/lib/redirects.js

@@ -1,163 +0,0 @@
-/**
- * SEO - redirects, pure. Used by the server (matching every request) and the
- * admin screen (checking a rule before it is sent).
- *
- * A rule: {id, from, to, code: 301|302|307|308|410, hits, lastHit, note, auto, at}
- *   - `from` is a path: "/old-page", or a prefix ending in "/*": "/news/*".
- *   - `to` is a path or a full http(s) URL; a "*" in it takes what the prefix
- *     matched. 410 ("gone") has no `to`.
- * Paths compare without a trailing slash and without case, and the query string
- * travels with the visitor unless `to` has one of its own.
- *
- * @module seo/admin/lib/redirects
- */
-
-export const CODES = [301, 302, 307, 308, 410];
-export const MAX_RULES = 5000;
-
-/** "/About/" -> "/about"; "" -> ""; keeps "/" as "/". */
-export function normalisePath(p) {
-    let s = String(p ?? '').trim();
-    if (!s) return '';
-    try { s = decodeURI(s); } catch { /* keep as typed */ }
-    s = s.split('#')[0].split('?')[0];
-    if (!s.startsWith('/')) s = `/${s}`;
-    s = s.replace(/\/{2,}/g, '/');
-    if (s.length > 1) s = s.replace(/\/+$/, '');
-    return s.toLowerCase();
-}
-
-const isWildcard = (from) => String(from).endsWith('/*');
-const isAbsolute = (to) => /^https?:\/\//i.test(String(to));
-
-/**
- * Check one rule. `others` are the rules already there (minus this one, when
- * editing), for duplicates and loops.
- *
- * @returns {{errors: Record<string, string>, rule: object}}
- */
-export function checkRule(input = {}, others = []) {
-    const errors = {};
-    const code = Number(input.code ?? 301);
-    const fromRaw = String(input.from ?? '').trim();
-    const wildcard = isWildcard(fromRaw);
-    const from = wildcard ? `${normalisePath(fromRaw.slice(0, -2)) === '/' ? '' : normalisePath(fromRaw.slice(0, -2))}/*` : normalisePath(fromRaw);
-    let to = String(input.to ?? '').trim();
-
-    if (!CODES.includes(code)) errors.code = 'Choose 301, 302, 307, 308 or 410.';
-    if (!fromRaw) errors.from = 'Say which address to redirect.';
-    else if (/^https?:\/\//i.test(fromRaw)) errors.from = 'The address to redirect is a path on this site, like /old-page.';
-    else if (/^\/(admin|api)(\/|$)/.test(from)) errors.from = 'The admin and the API cannot be redirected.';
-    else if (from === '/*') errors.from = 'That would redirect the whole site.';
-
-    if (code === 410) {
-        to = '';
-    } else if (!to) {
-        errors.to = 'Say where it goes.';
-    } else if (isAbsolute(to)) {
-        try { new URL(to.replace('*', 'x')); } catch { errors.to = 'Not a web address.'; }
-    } else if (/^[a-z][a-z0-9+.-]*:/i.test(to) || to.startsWith('//')) {
-        errors.to = 'A path on this site (/new-page) or an http(s) address.';
-    } else {
-        const [p, q] = to.split('?');
-        to = normalisePath(p) + (q ? `?${q}` : '');
-        if (to.includes('*') && !wildcard) errors.to = 'A "*" in the target needs a "/*" rule to fill it.';
-    }
-
-    if (!errors.from && !errors.to && code !== 410 && !isAbsolute(to)) {
-        const target = normalisePath(to.split('?')[0]);
-        if (!wildcard && target === from) errors.to = 'It would redirect to itself.';
-        else if (!wildcard && loopsBack(from, target, others)) errors.to = 'That makes a loop with another redirect.';
-    }
-    if (!errors.from && others.some(r => r.from === from)) errors.from = `There is already a redirect from ${from}.`;
-
-    return {
-        errors,
-        rule: {
-            from,
-            to,
-            code,
-            note: String(input.note ?? '').trim().slice(0, 200),
-            ...(input.auto === true && {auto: true})
-        }
-    };
-}
-
-/** Would following `target` through `rules` come back to `from`? */
-function loopsBack(from, target, rules) {
-    const seen = new Set([from]);
-    let at = target;
-    for (let i = 0; i < 20; i++) {
-        if (seen.has(at)) return true;
-        seen.add(at);
-        const next = matchRedirect(rules, at);
-        if (!next || !next.location || isAbsolute(next.location)) return false;
-        at = normalisePath(next.location.split('?')[0]);
-    }
-    return true;
-}
-
-/**
- * The rule for a request path, exact rules before prefixes (the longest
- * prefix wins). Returns null when none applies.
- *
- * @param {object[]} rules
- * @param {string} rawPath - the request path, query included or not
- * @returns {{rule: object, location: string, code: number}|null}
- */
-export function matchRedirect(rules, rawPath) {
-    const [pathPart, query] = String(rawPath ?? '').split('?');
-    const p = normalisePath(pathPart);
-    if (!p) return null;
-    let hit = null;
-    let rest = '';
-    for (const r of rules) {
-        if (r.from === p) { hit = r; rest = ''; break; }
-    }
-    if (!hit) {
-        let best = -1;
-        for (const r of rules) {
-            if (!isWildcard(r.from)) continue;
-            const prefix = r.from.slice(0, -2);
-            if ((p === prefix || p.startsWith(`${prefix}/`)) && prefix.length > best) {
-                best = prefix.length;
-                hit = r;
-                rest = p.slice(prefix.length + 1);
-            }
-        }
-    }
-    if (!hit) return null;
-    if (hit.code === 410) return {rule: hit, location: '', code: 410};
-    let location = hit.to.includes('*') ? hit.to.replace('*', rest) : hit.to;
-    if (!isAbsolute(location)) location = location.replace(/\/{2,}/g, '/').replace(/(.)\/$/, '$1');
-    if (query && !location.includes('?')) location += `?${query}`;
-    return {rule: hit, location, code: hit.code};
-}
-
-/**
- * A page moved from `from` to `to`: the redirect to add, and every existing
- * rule that pointed at `from` re-aimed at `to` (no chains). A rule FROM the
- * new address is removed - the page lives there now. Pure: returns a new list.
- */
-export function onMoved(rules, from, to, {now = new Date().toISOString(), id} = {}) {
-    const f = normalisePath(from);
-    const t = normalisePath(to);
-    if (!f || !t || f === t) return rules;
-    const out = rules
-        .filter(r => r.from !== t)
-        .map(r => (normalisePath(String(r.to).split('?')[0]) === f && !isAbsolute(r.to) ? {...r, to: t} : r));
-    const existing = out.find(r => r.from === f);
-    if (existing) return out.map(r => (r === existing ? {...r, to: t, code: 301} : r));
-    return [...out, {id: id || `r${Date.now().toString(36)}`, from: f, to: t, code: 301, note: 'The page moved', auto: true, hits: 0, lastHit: null, at: now}];
-}
-
-/** Redirects that lead to another redirect (A -> B -> C): [{rule, via}]. */
-export function chains(rules) {
-    const out = [];
-    for (const r of rules) {
-        if (r.code === 410 || isAbsolute(r.to) || isWildcard(r.from)) continue;
-        const next = matchRedirect(rules, r.to);
-        if (next && next.rule !== r) out.push({rule: r, via: next.rule});
-    }
-    return out;
-}

package/plugins/seo/admin/lib/schema.js

@@ -1,113 +0,0 @@
-/**
- * SEO - structured data (JSON-LD) and the 'seo:meta' changes this plugin
- * makes, pure: the server's transform calls applySeo() on every render.
- *
- * @module seo/admin/lib/schema
- */
-
-const abs = (u, origin) => {
-    const s = String(u || '').trim();
-    if (!s || /^https?:\/\//i.test(s) || !origin) return s;
-    return `${origin}${s.startsWith('/') ? '' : '/'}${s}`;
-};
-
-/** Organization / LocalBusiness / Person for the home page, or null when off or unnamed. */
-export function organisationLd(org, {origin = '', siteTitle = ''} = {}) {
-    if (!org?.enabled) return null;
-    const name = org.name || siteTitle;
-    if (!name) return null;
-    const ld = {'@context': 'https://schema.org', '@type': org.type || 'Organization', name};
-    const url = org.url || origin;
-    if (url) ld.url = abs(url, origin);
-    if (org.logo) ld[org.type === 'Person' ? 'image' : 'logo'] = abs(org.logo, origin);
-    if (org.email) ld.email = org.email;
-    if (org.phone) ld.telephone = org.phone;
-    if (org.sameAs?.length) ld.sameAs = org.sameAs;
-    const a = org.address || {};
-    if (org.type !== 'Person' && (a.street || a.locality || a.postcode)) {
-        ld.address = {'@type': 'PostalAddress',
-            ...(a.street && {streetAddress: a.street}), ...(a.locality && {addressLocality: a.locality}),
-            ...(a.region && {addressRegion: a.region}), ...(a.postcode && {postalCode: a.postcode}),
-            ...(a.country && {addressCountry: a.country})};
-    }
-    return ld;
-}
-
-/** BlogPosting for a blog post (the render says `item.type === 'blog:post'`). */
-export function articleLd(meta, {origin = '', publisher = ''} = {}) {
-    const ld = {'@context': 'https://schema.org', '@type': 'BlogPosting', headline: String(meta.title || '').slice(0, 110)};
-    if (meta.description) ld.description = meta.description;
-    if (meta.image) ld.image = abs(meta.image, origin);
-    if (meta.canonical) {
-        ld.url = meta.canonical;
-        ld.mainEntityOfPage = meta.canonical;
-    }
-    if (publisher) ld.publisher = {'@type': 'Organization', name: publisher};
-    return ld;
-}
-
-/**
- * The 'seo:meta' transform's work, on a copy of core's model.
- *
- * @param {object} meta - core's model (renderer.js buildSeoMeta)
- * @param {object} ctx
- * @param {object} ctx.page - {urlPath, item?}
- * @param {'page'|'plugin'} ctx.kind
- * @param {string} ctx.origin - the request's origin, no trailing slash
- * @param {string} ctx.siteTitle
- * @param {object} ctx.settings - SEO settings (mergeDefaults)
- * @param {object|null} ctx.override - this URL's overrides {title, description, image, noindex}
- * @returns {object}
- */
-export function applySeo(meta, {page, kind, origin = '', siteTitle = '', settings, override = null}) {
-    const out = {...meta, jsonLd: [...(meta.jsonLd || [])], extra: [...(meta.extra || [])]};
-
-    // A URL's own overrides - for plugin pages (a blog post, a listing) whose
-    // fields this plugin cannot edit in place. Core pages are edited in place.
-    if (override) {
-        if (override.title) out.title = override.title;
-        if (override.description) out.description = override.description;
-        if (override.image) out.image = abs(override.image, origin);
-        if (override.noindex === true) out.noindex = true;
-        const webPage = out.jsonLd.find(x => x?.['@type'] === 'WebPage');
-        if (webPage) {
-            const i = out.jsonLd.indexOf(webPage);
-            out.jsonLd[i] = {...webPage, ...(override.description && {description: override.description}), ...(out.image && {image: out.image})};
-        }
-    }
-
-    const urlPath = page?.urlPath || '/';
-    if (urlPath === '/') {
-        const org = organisationLd(settings?.organisation, {origin, siteTitle});
-        if (org) out.jsonLd.push(org);
-    }
-    if (settings?.articles !== false && kind === 'plugin' && page?.item?.type === 'blog:post') {
-        out.ogType = 'article';
-        out.jsonLd.push(articleLd(out, {origin, publisher: settings?.organisation?.enabled ? settings.organisation.name : siteTitle}));
-    }
-    return out;
-}
-
-/**
- * robots.txt lines, the settings applied: everything blocked (a site not yet
- * live), or extra lines added before the Sitemap line.
- */
-export function robotsLines(lines, {blockAll = false, extra = ''} = {}, sitemapUrl = '/sitemap.xml') {
-    if (blockAll) return ['# This site asks search engines to stay away (SEO settings).', 'User-agent: *', 'Disallow: /'];
-    const add = String(extra || '').split('\n').map(l => l.trimEnd()).filter((l, i, a) => l || (i > 0 && a[i - 1]));
-    if (!add.length) return lines;
-    let out;
-    if (add.some(l => /^user-agent\s*:/i.test(l))) {
-        // Groups of their own: after core's group, before the Sitemap line.
-        const at = lines.findIndex(l => /^sitemap:/i.test(l));
-        out = at >= 0 ? [...lines.slice(0, at), ...add, '', ...lines.slice(at)] : [...lines, '', ...add];
-    } else {
-        // Plain rules belong to the "User-agent: *" group: in it, before the blank line that ends it.
-        const ua = lines.findIndex(l => /^user-agent\s*:\s*\*/i.test(l));
-        const end = ua >= 0 ? lines.findIndex((l, i) => i > ua && !l.trim()) : -1;
-        const at = end >= 0 ? end : (ua >= 0 ? lines.length : -1);
-        out = at >= 0 ? [...lines.slice(0, at), ...add.filter(Boolean), ...lines.slice(at)] : ['User-agent: *', ...add.filter(Boolean), '', ...lines];
-    }
-    if (!out.some(l => /^sitemap:/i.test(l))) out.push('', `Sitemap: ${sitemapUrl}`);
-    return out;
-}

package/plugins/seo/admin/lib/settings.js

@@ -1,141 +0,0 @@
-/**
- * SEO - settings (config/plugins.json `seo.settings`), checked the same way by
- * the server and the settings slideover. Pure.
- *
- * The site-wide defaults (title separator, default description and image, the
- * X handle) stay where core keeps them - Settings › SEO in site.json - so a
- * site without this plugin still has them.
- */
-import {LIMITS} from './analyse.js';
-
-export const ORG_TYPES = ['Organization', 'LocalBusiness', 'Person'];
-
-export const DEFAULT_SETTINGS = {
-    organisation: {
-        enabled: false, type: 'Organization', name: '', logo: '', url: '', email: '', phone: '', sameAs: [],
-        address: {street: '', locality: '', region: '', postcode: '', country: ''}
-    },
-    articles: true,
-    sitemap: {exclude: [], sources: {}},
-    robots: {blockAll: false, extra: ''},
-    redirects: {onRename: true},
-    audit: {everyHours: 24, ...LIMITS}
-};
-
-const str = (v, max = 300) => String(v ?? '').trim().slice(0, max);
-const bool = (v, d) => (v === undefined ? d : v === true || v === 'true');
-const lines = (v) => (Array.isArray(v) ? v : String(v ?? '').split(/[\n,]+/)).map(s => String(s).trim()).filter(Boolean);
-const int = (v, min, max) => {
-    const n = Number(v);
-    return Number.isInteger(n) && n >= min && n <= max ? n : null;
-};
-const httpUrl = (s) => { try { return ['http:', 'https:'].includes(new URL(s).protocol); } catch { return false; } };
-
-/**
- * The stored settings merged over the defaults, every value checked.
- *
- * @param {object} input - a full or partial settings object
- * @param {object} [base] - what is stored now
- * @returns {{errors: Record<string, string>, settings: object}}
- */
-export function checkSettings(input = {}, base = DEFAULT_SETTINGS) {
-    const errors = {};
-    const out = JSON.parse(JSON.stringify(mergeDefaults(base)));
-
-    const o = input.organisation;
-    if (o && typeof o === 'object') {
-        const org = out.organisation;
-        if (o.enabled !== undefined) org.enabled = bool(o.enabled, false);
-        if (o.type !== undefined) {
-            if (ORG_TYPES.includes(o.type)) org.type = o.type;
-            else errors['organisation.type'] = 'Organisation, local business or person.';
-        }
-        for (const k of ['name', 'email', 'phone']) if (o[k] !== undefined) org[k] = str(o[k], 200);
-        for (const k of ['logo', 'url']) {
-            if (o[k] === undefined) continue;
-            const v = str(o[k], 500);
-            if (v && !httpUrl(v) && !v.startsWith('/')) errors[`organisation.${k}`] = `${k === 'logo' ? 'The logo' : 'The address'}: a full web address, or a path like /media/logo.png.`;
-            else org[k] = v;
-        }
-        if (o.sameAs !== undefined) {
-            const list = lines(o.sameAs);
-            const bad = list.filter(u => !httpUrl(u));
-            if (bad.length) errors['organisation.sameAs'] = `Not web addresses: ${bad.slice(0, 2).join(', ')}`;
-            else org.sameAs = [...new Set(list)].slice(0, 20);
-        }
-        if (o.address && typeof o.address === 'object') {
-            for (const k of Object.keys(DEFAULT_SETTINGS.organisation.address)) if (o.address[k] !== undefined) org.address[k] = str(o.address[k], 200);
-        }
-        if (org.enabled && !org.name) errors['organisation.name'] = 'Give the name search engines should show.';
-    }
-
-    if (input.articles !== undefined) out.articles = bool(input.articles, true);
-
-    if (input.sitemap && typeof input.sitemap === 'object') {
-        if (input.sitemap.exclude !== undefined) {
-            const list = lines(input.sitemap.exclude);
-            const bad = list.filter(p => !p.startsWith('/'));
-            if (bad.length) errors['sitemap.exclude'] = `Each starts with "/": ${bad.slice(0, 3).join(', ')}`;
-            else out.sitemap.exclude = [...new Set(list)].slice(0, 200);
-        }
-        if (input.sitemap.sources && typeof input.sitemap.sources === 'object') {
-            for (const [id, on] of Object.entries(input.sitemap.sources)) {
-                if (/^[a-z0-9][a-z0-9:-]*$/.test(id)) out.sitemap.sources[id] = bool(on, true);
-            }
-        }
-    }
-
-    if (input.robots && typeof input.robots === 'object') {
-        if (input.robots.blockAll !== undefined) out.robots.blockAll = bool(input.robots.blockAll, false);
-        if (input.robots.extra !== undefined) {
-            const text = String(input.robots.extra ?? '').replace(/\r/g, '').slice(0, 5000);
-            const bad = text.split('\n').map(l => l.trim()).filter(l => l && !l.startsWith('#') && !/^[A-Za-z-]+\s*:/.test(l));
-            if (bad.length) errors['robots.extra'] = `Each line is "Field: value" (or a # comment): ${bad[0].slice(0, 40)}`;
-            else out.robots.extra = text.trim();
-        }
-    }
-
-    if (input.redirects && input.redirects.onRename !== undefined) out.redirects.onRename = bool(input.redirects.onRename, true);
-
-    const a = input.audit;
-    if (a && typeof a === 'object') {
-        const num = (key, min, max, label) => {
-            if (a[key] === undefined) return;
-            const n = int(a[key], min, max);
-            if (n === null) errors[`audit.${key}`] = `${label}: a whole number, ${min} to ${max}.`;
-            else out.audit[key] = n;
-        };
-        num('everyHours', 0, 168, 'Check every (hours)');
-        num('titleMin', 10, 70, 'Shortest title');
-        num('titleMax', 30, 100, 'Longest title');
-        num('descMin', 30, 160, 'Shortest description');
-        num('descMax', 80, 320, 'Longest description');
-        num('minWords', 0, 5000, 'Words a page should have');
-        if (out.audit.titleMax < out.audit.titleMin) errors['audit.titleMax'] = 'The longest title cannot be shorter than the shortest.';
-        if (out.audit.descMax < out.audit.descMin) errors['audit.descMax'] = 'The longest description cannot be shorter than the shortest.';
-    }
-    return {errors, settings: out};
-}
-
-/** Stored settings (possibly old or partial) with every default filled in. */
-export function mergeDefaults(s = {}) {
-    const d = DEFAULT_SETTINGS;
-    return {
-        organisation: {...d.organisation, ...(s.organisation || {}), address: {...d.organisation.address, ...(s.organisation?.address || {})},
-            sameAs: Array.isArray(s.organisation?.sameAs) ? s.organisation.sameAs : []},
-        articles: s.articles ?? d.articles,
-        sitemap: {exclude: Array.isArray(s.sitemap?.exclude) ? s.sitemap.exclude : [], sources: {...(s.sitemap?.sources || {})}},
-        robots: {...d.robots, ...(s.robots || {})},
-        redirects: {...d.redirects, ...(s.redirects || {})},
-        audit: {...d.audit, ...(s.audit || {})}
-    };
-}
-
-/** Is a path excluded from the sitemap by the settings? A trailing / or /* covers everything under it. */
-export function excluded(urlPath, exclude = []) {
-    const p = String(urlPath || '').toLowerCase();
-    return exclude.some((raw) => {
-        const e = String(raw).toLowerCase().replace(/\*$/, '');
-        return e.endsWith('/') ? p === e.slice(0, -1) || p.startsWith(e) : p === e;
-    });
-}