domma-cms 0.66.0 → 0.69.3

package/server/services/plugins.js

@@ -24,12 +24,47 @@ import {
     registerTransform
 } from './hooks.js';
 import {registerPluginResource, unregisterPluginResourcesByPlugin} from './permissionRegistry.js';
+import {classifyEntitlement, mayLoad} from './pluginEntitlement.js';
 import {createCollection, getCollection} from './collections.js';
 
 const PLUGINS_DIR = path.resolve('plugins');
 
 const REQUIRED_MANIFEST_FIELDS = ['name', 'displayName', 'version', 'description', 'author', 'date', 'icon'];
 
+/**
+ * Validate a candidate plugin directory the way discoverPlugins() would.
+ *
+ * Exported so an UPGRADE can check what it extracted before swapping it over a
+ * working installation. Validating after the swap would mean discovering the
+ * new version is broken with the old one already gone.
+ *
+ * @param   {string} dir  - absolute directory
+ * @param   {string} slug
+ * @returns {Promise<{ok: boolean, reason?: string, manifest?: object}>}
+ */
+export async function validatePluginDir(dir, slug) {
+    let manifest;
+    try {
+        manifest = JSON.parse(await fs.readFile(path.join(dir, 'plugin.json'), 'utf8'));
+    } catch {
+        return {ok: false, reason: 'no readable plugin.json'};
+    }
+    for (const field of REQUIRED_MANIFEST_FIELDS) {
+        if (!manifest[field]) return {ok: false, reason: `missing required field "${field}"`};
+    }
+    if (manifest.name !== slug) {
+        return {ok: false, reason: `manifest name is "${manifest.name}", not "${slug}"`};
+    }
+    for (const file of ['plugin.js', 'config.js']) {
+        try {
+            await fs.access(path.join(dir, file));
+        } catch {
+            return {ok: false, reason: `missing required file ${file}`};
+        }
+    }
+    return {ok: true, manifest};
+}
+
 const failedLoads = [];
 
 /**
@@ -60,6 +95,23 @@ export function getPluginLoadFailures() {
  */
 const _loadedPlugins = {};
 
+/**
+ * Entitlement state per licensed plugin, as of the last registerPlugins().
+ * Reported by GET /api/plugins so the screen can explain an absence rather than
+ * simply not showing a plugin the operator knows they installed.
+ *
+ * @type {Object.<string, string>}
+ */
+const _entitlementStates = {};
+
+/** Entitlement states that still let a plugin load. Mirrors pluginEntitlement. */
+const ENTITLEMENT_LOADABLE = new Set(['valid', 'grace', 'support-ended', 'not-required']);
+
+/** @returns {Object.<string, string>} */
+export function getEntitlementStates() {
+    return {..._entitlementStates};
+}
+
 /**
  * Core plugins - always loaded regardless of plugins.json enabled state.
  * These are considered first-class CMS features, not optional add-ons: they
@@ -70,12 +122,15 @@ const _loadedPlugins = {};
  * for these, so a site that had one switched off still gets it on the next
  * start - which is the point of promoting one.
  *
- * It is also a waiting room rather than a destination: site-search sat here
- * until search was moved into the CMS proper (server/services/search.js), and
- * a feature nobody may switch off has no business being discovered, listed and
- * toggled as though it were an add-on.
+ * It is also a waiting room rather than a destination, and as of 0.67.0 it is
+ * EMPTY. site-search sat here until search moved into the CMS proper, and
+ * analytics until it did the same - a feature nobody may switch off has no
+ * business being discovered, listed and toggled as though it were an add-on.
+ *
+ * Kept rather than deleted because the mechanism is the right one for the next
+ * promotion: a plugin lands here while its replacement is built, then leaves.
  */
-const CORE_PLUGINS = new Set(['analytics']);
+const CORE_PLUGINS = new Set([]);
 
 /** Is this plugin a built-in feature rather than an optional add-on? */
 export function isCorePlugin(name) { return CORE_PLUGINS.has(name); }
@@ -300,11 +355,29 @@ export async function registerPlugins(fastify) {
     const manifests = await discoverPlugins();
     const states = getPluginStates();
 
+    // Entitlement is settled BEFORE supersession, not after, and the ordering is
+    // load-bearing. `email-pro` supersedes `mail-reader`; if an unentitled
+    // email-pro still counted as active it would displace mail-reader and then
+    // fail to load itself, leaving a customer whose licence lapsed with NEITHER -
+    // worse off than someone who never paid at all.
+    for (const manifest of manifests) {
+        if (manifest.closedSource !== true) continue;
+        const verdict = mayLoad(manifest);
+        _entitlementStates[manifest.name] = verdict.state;
+        if (!verdict.allowed) {
+            fastify.log.warn(`[plugins] "${manifest.name}" not loaded: ${verdict.state} (${verdict.reason})`);
+        } else if (verdict.state !== 'valid') {
+            fastify.log.info(`[plugins] "${manifest.name}": ${verdict.state} (${verdict.reason})`);
+        }
+    }
+    const entitled = (name) => _entitlementStates[name] === undefined
+        || ENTITLEMENT_LOADABLE.has(_entitlementStates[name]);
+
     // Which plugins would load on their own account, before anything displaces
     // one another.
     const activeNames = new Set(
         manifests
-            .filter(m => states[m.name]?.enabled || CORE_PLUGINS.has(m.name))
+            .filter(m => (states[m.name]?.enabled || CORE_PLUGINS.has(m.name)) && entitled(m.name))
             .map(m => m.name)
     );
     const superseded = resolveSupersessions(manifests, activeNames, {
@@ -327,6 +400,12 @@ export async function registerPlugins(fastify) {
             continue;
         }
 
+        // Already classified above, before supersession was resolved. A refusal
+        // is NOT written into plugins.json: a lapse recorded as stored state
+        // would mean a renewal could not simply restore it, the same reasoning
+        // resolveSupersessions() uses for a superseded plugin.
+        if (!entitled(manifest.name)) continue;
+
         const entryPath = path.join(PLUGINS_DIR, manifest.name, 'plugin.js');
         try {
             const { default: plugin } = await import(entryPath);
@@ -801,6 +880,34 @@ export function pluginLicence(manifest) {
     return 'Included with Domma CMS';
 }
 
+/**
+ * The expiry shown beside the licence on a plugin's admin banner, or null.
+ *
+ * Only a licensed plugin has one, and what "expires" means depends on how it
+ * was bought (see pluginEntitlement.js): a rental STOPS at its end date, a
+ * perpetual licence never does and only its support lapses. The banner says
+ * which, because "Expires" on something bought outright would frighten a
+ * customer about a thing that is not going to happen.
+ *
+ * An owner wildcard, or a perpetual licence with no support date, has nothing
+ * to show and returns null rather than a chip with no date in it.
+ *
+ * @param   {object} manifest
+ * @param   {object|null} [given] - injectable for testing; read from disk when omitted
+ * @returns {{kind: 'rental'|'support', date: string, state: string}|null}
+ */
+export function pluginExpiry(manifest, given) {
+    if (manifest?.closedSource !== true) return null;
+    const {state, entitlement} = classifyEntitlement(manifest.name, given);
+    if (!entitlement || state === 'unlicensed') return null;
+    if (entitlement.model === 'rental') {
+        return entitlement.expiresAt ? {kind: 'rental', date: entitlement.expiresAt, state} : null;
+    }
+    return entitlement.supportExpiresAt
+        ? {kind: 'support', date: entitlement.supportExpiresAt, state}
+        : null;
+}
+
 export async function getAdminPluginConfig() {
     const manifests = await discoverPlugins();
     const states = getPluginStates();
@@ -830,6 +937,8 @@ export async function getAdminPluginConfig() {
         // browser fetching the same URL and serving the previous build of
         // everything behind it. That presents as a feature that worked
         // yesterday and does not today, on one machine.
+        // Once per plugin, not per view: it verifies a signature.
+        const expiry = pluginExpiry(manifest);
         const sharedStamp = Math.max(
             await newestAdminMtime(path.join(PLUGINS_DIR, '_lib', 'admin')),
             await newestAdminMtime(path.join(PLUGINS_DIR, manifest.name, 'admin'))
@@ -851,7 +960,8 @@ export async function getAdminPluginConfig() {
                 author:      manifest.author || '',
                 icon:        manifest.icon || 'package',
                 core:        CORE_PLUGINS.has(manifest.name),
-                licence:     pluginLicence(manifest)
+                licence:     pluginLicence(manifest),
+                expiry
             };
         }
 

package/server/services/presetCollections.js

@@ -115,6 +115,350 @@ const PRESETS = [
             delete: {enabled: false, access: 'admin'}
         }
     }
+    ,
+    // ---- Tools promoted out of plugins/ (0.67.0) --------------------------
+    // The slugs are what setupPlugin() created from `schema.slug`, NOT the
+    // directories the schemas used to live in (`user-notes`, `todos`). Keeping
+    // them exactly preserves every existing entry; changing one would seed an
+    // empty collection beside a site's real one.
+    //
+    // seedAll() rewrites schema.json on every boot, so `storage` is declared
+    // exactly as the plugins declared it - a site that had these in Mongo must
+    // not silently switch to files and lose sight of its rows. Sites with no
+    // connections.json fall back to the file adapter as they always did.
+    {
+        "slug": "notes-notes",
+        "title": "Notes",
+        "description": "Personal notes, one row per note, scoped to its author.",
+        "preset": true,
+        "fields": [
+            {
+                "name": "title",
+                "label": "Title",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "content",
+                "label": "Content",
+                "type": "textarea",
+                "required": false
+            },
+            {
+                "name": "categories",
+                "label": "Categories",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "userId",
+                "label": "User ID",
+                "type": "text",
+                "required": false
+            }
+        ],
+        "api": {
+            "create": {
+                "enabled": true,
+                "access": "admin"
+            },
+            "read": {
+                "enabled": true,
+                "access": "admin"
+            },
+            "update": {
+                "enabled": false,
+                "access": "admin"
+            },
+            "delete": {
+                "enabled": false,
+                "access": "admin"
+            }
+        },
+        "storage": {
+            "adapter": "mongodb",
+            "connection": "default"
+        }
+    },
+    {
+        "slug": "todo-items",
+        "title": "Todo Items",
+        "description": "Personal tasks, one row per task, scoped to its owner.",
+        "preset": true,
+        "fields": [
+            {
+                "name": "text",
+                "label": "Text",
+                "type": "text",
+                "required": true
+            },
+            {
+                "name": "status",
+                "label": "Status",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "priority",
+                "label": "Priority",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "dueAt",
+                "label": "Due At",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "userId",
+                "label": "User ID",
+                "type": "text",
+                "required": false
+            }
+        ],
+        "api": {
+            "create": {
+                "enabled": true,
+                "access": "admin"
+            },
+            "read": {
+                "enabled": true,
+                "access": "admin"
+            },
+            "update": {
+                "enabled": false,
+                "access": "admin"
+            },
+            "delete": {
+                "enabled": false,
+                "access": "admin"
+            }
+        },
+        "storage": {
+            "adapter": "mongodb",
+            "connection": "default"
+        }
+    },
+    // ---- Contacts, promoted out of plugins/ (0.67.0) ----------------------
+    // Slugs are contacts-contacts and contacts-groups - NOT the directories the
+    // schemas lived in (user-contacts, user-contact-groups). Taken verbatim from
+    // those files so none of the 25 contact fields is lost in transcription, and
+    // `storage` stays `file` exactly as it was.
+    {
+        "slug": "contacts-contacts",
+        "title": "Contacts",
+        "description": "Contacts managed by the Contacts plugin.",
+        "fields": [
+            {
+                "name": "name",
+                "label": "Name",
+                "type": "text",
+                "required": true
+            },
+            {
+                "name": "email",
+                "label": "Email",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "phone",
+                "label": "Phone",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "groups",
+                "label": "Groups",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "notes",
+                "label": "Notes",
+                "type": "textarea",
+                "required": false
+            },
+            {
+                "name": "favourite",
+                "label": "Favourite",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "company",
+                "label": "Company",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "jobTitle",
+                "label": "Job Title",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "website",
+                "label": "Website",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "vatNumber",
+                "label": "VAT Number",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "companyNumber",
+                "label": "Company Number",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "reference",
+                "label": "Their Reference",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "billingEmail",
+                "label": "Billing Email",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "paymentTerms",
+                "label": "Payment Terms (days)",
+                "type": "number",
+                "required": false
+            },
+            {
+                "name": "currency",
+                "label": "Preferred Currency",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "addresses",
+                "label": "Addresses",
+                "type": "json",
+                "required": false
+            },
+            {
+                "name": "emails",
+                "label": "Additional Emails",
+                "type": "json",
+                "required": false
+            },
+            {
+                "name": "phones",
+                "label": "Additional Phones",
+                "type": "json",
+                "required": false
+            },
+            {
+                "name": "accountName",
+                "label": "Account Name",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "bankName",
+                "label": "Bank",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "sortCode",
+                "label": "Sort Code",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "accountNumber",
+                "label": "Account Number",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "iban",
+                "label": "IBAN",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "bic",
+                "label": "BIC / SWIFT",
+                "type": "text",
+                "required": false
+            },
+            {
+                "name": "userId",
+                "label": "User ID",
+                "type": "text",
+                "required": false
+            }
+        ],
+        "api": {
+            "create": {
+                "enabled": true,
+                "access": "admin"
+            },
+            "read": {
+                "enabled": true,
+                "access": "admin"
+            },
+            "update": {
+                "enabled": false,
+                "access": "admin"
+            },
+            "delete": {
+                "enabled": false,
+                "access": "admin"
+            }
+        },
+        "storage": {
+            "adapter": "file"
+        },
+        "preset": true
+    },
+    {
+        "slug": "contacts-groups",
+        "title": "Contact Groups",
+        "description": "Groups for the Contacts plugin.",
+        "fields": [
+            {
+                "name": "name",
+                "label": "Group Name",
+                "type": "text",
+                "required": true
+            }
+        ],
+        "api": {
+            "create": {
+                "enabled": true,
+                "access": "admin"
+            },
+            "read": {
+                "enabled": true,
+                "access": "admin"
+            },
+            "update": {
+                "enabled": false,
+                "access": "admin"
+            },
+            "delete": {
+                "enabled": false,
+                "access": "admin"
+            }
+        },
+        "storage": {
+            "adapter": "file"
+        },
+        "preset": true
+    }
 ];
 
 /** Slugs exported for use in adapterRegistry and the delete guard. */