settings.js

Go to the documentation of this file.

/**
 * @file routes/settings.js
 * @module routes/settings
 * @description
 *   Settings management API for global and tenant-specific configuration in the RMM-PSA platform.
 *   Provides endpoints for retrieving and updating global defaults, tenant overrides, and WordPress integration credentials.
 *
 *   - Global settings are stored in the `app_settings` table as a JSONB config object.
 *   - Tenant-specific overrides are stored in the `tenant_settings` table as key-value pairs.
 *   - WordPress credentials are managed as a sub-object in global config (root tenant only).
 *
 *   **Core Features:**
 *   - Retrieve merged global + tenant settings for UI and agent configuration
 *   - Update global defaults (admin/root context) or tenant overrides (tenant context)
 *   - Fine-grained update and retrieval of individual tenant settings
 *   - Secure WordPress credential management (root tenant only)
 *   - Multi-tenant isolation and admin-only update enforcement
 *
 *   **Security:**
 *   - All endpoints require authentication
 *   - Most endpoints require admin privileges for updates
 *   - WordPress credential endpoints restricted to root tenant
 *   - Tenant context enforced for all tenant-specific operations
 *
 *   **Related Models:**
 *   - app_settings (global config)
 *   - tenant_settings (tenant overrides)
 *   - tenants (for company name sync)
 *   @requires express
 *   @requires ../middleware/auth
 *   @requires ../middleware/adminOnly
 *   @requires ../middleware/tenant
 *   @requires ../services/db
 *   @author IBG MSP Development Team
 *   @date 2026-03-12
 *   @since 1.0.0
 */
 
const express = require('express');
const router = express.Router();
const authenticateToken = require('../middleware/auth');
const requireAdmin = require('../middleware/adminOnly');
const { getTenantFilter, setTenantContext } = require('../middleware/tenant');
const pool = require('../services/db');
 
// Apply authentication and tenant context to all routes
router.use(authenticateToken, setTenantContext);
 
// Ensure app_settings table exists (global settings)
/**
 *
 */
async function ensureTable() {
  await pool.query(`
    CREATE TABLE IF NOT EXISTS app_settings (
      id SERIAL PRIMARY KEY,
      config JSONB,
      updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
    )
  `);
}
 
// GET settings (global defaults merged with tenant overrides)
/**
 * @api {get} /settings/ Get merged global + tenant settings
 * @apiName GetSettings
 * @apiGroup Settings
 * @apiDescription
 *   Returns the effective configuration for the current tenant, merging global defaults from `app_settings` with any tenant-specific overrides from `tenant_settings`.
 *   Used for UI configuration, agent policy, and feature toggles.
 *
 *   - If no tenant context, returns global config only.
 *   - If tenant context, merges known overrides (company name, timezone, theme, etc.).
 *   - Default values are provided for missing config fields.
 * @apiHeader {string} Authorization Bearer JWT token.
 * @apiSuccess {object} config Merged configuration object.
 * @apiSuccessExample {json} Success-Response (tenant):
 *   HTTP/1.1 200 OK
 *   {
 *     "general": { "companyName": "Acme MSP", "timezone": "America/New_York", "dateFormat": "YYYY-MM-DD" },
 *     "notifications": { "emailEnabled": true, "slackEnabled": false, "alertThresholds": { "cpu": 90, "memory": 90, "disk": 90 } },
 *     "display": { "itemsPerPage": 25, "theme": "dark" }
 *   }
 * @apiError (500) ServerError Database or merge error.
 * @apiExample {curl} Example usage:
 *   curl -H "Authorization: Bearer <token>" https://api.example.com/settings/
 * @since 1.0.0
 */
router.get('/', async (req, res) => {
  try {
    await ensureTable();
    // 1) Load global defaults from app_settings
    const result = await pool.query('SELECT config FROM app_settings ORDER BY id DESC LIMIT 1');
    let baseConfig;
    if (result.rows.length === 0) {
      baseConfig = {
        general: { companyName: 'Demo MSP', timezone: 'UTC', dateFormat: 'YYYY-MM-DD' },
        notifications: { emailEnabled: true, slackEnabled: false, alertThresholds: { cpu: 90, memory: 90, disk: 90 } },
        display: { itemsPerPage: 10, theme: 'light' }
      };
      // insert default
      await pool.query('INSERT INTO app_settings (config) VALUES ($1)', [baseConfig]);
    } else {
      baseConfig = result.rows[0].config || {};
      baseConfig.general = baseConfig.general || { companyName: 'Demo MSP', timezone: 'UTC', dateFormat: 'YYYY-MM-DD' };
      baseConfig.display = baseConfig.display || { itemsPerPage: 10, theme: 'light' };
      baseConfig.notifications = baseConfig.notifications || { emailEnabled: true, slackEnabled: false, alertThresholds: { cpu: 90, memory: 90, disk: 90 } };
    }
 
    // 2) If we have a tenant context, load tenant-specific overrides from tenant_settings
    const tenantId = req.tenant?.id || req.user?.tenantId || null;
    if (!tenantId) {
      // No tenant context -> return global config
      return res.json(baseConfig);
    }
 
    // Ensure tenant_settings table exists
    await pool.query(`
      CREATE TABLE IF NOT EXISTS tenant_settings (
        tenant_id INTEGER NOT NULL,
        setting_key TEXT NOT NULL,
        setting_value TEXT,
        description TEXT,
        updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
        PRIMARY KEY (tenant_id, setting_key)
      )
    `);
 
    const overridesRes = await pool.query(
      'SELECT setting_key, setting_value FROM tenant_settings WHERE tenant_id = $1',
      [tenantId]
    );
 
    const overrides = Object.fromEntries(overridesRes.rows.map(r => [r.setting_key, r.setting_value]));
 
    // 3) Merge known overrides into the base config
    const merged = JSON.parse(JSON.stringify(baseConfig));
    if (overrides.company_name !== undefined) merged.general.companyName = overrides.company_name;
    if (overrides.general_timezone !== undefined) merged.general.timezone = overrides.general_timezone;
    if (overrides.general_date_format !== undefined) merged.general.dateFormat = overrides.general_date_format;
 
    if (overrides.display_theme !== undefined) {
      merged.display.theme = overrides.display_theme;
    }
    if (overrides.display_items_per_page !== undefined) {
      const n = parseInt(overrides.display_items_per_page, 10);
      if (!Number.isNaN(n)) merged.display.itemsPerPage = n;
    }
 
    return res.json(merged);
  } catch (err) {
    console.error('Error fetching settings:', err);
    res.status(500).send('Server error');
  }
});
 
// ========================================
// WordPress Settings Routes (Root Tenant Only)
// MUST be defined BEFORE /:key route to avoid conflict
// ========================================
 
// GET /settings/wordpress - Get WordPress global credentials (Root Tenant Only)
/**
 * @api {get} /settings/wordpress Get WordPress global credentials (root tenant only)
 * @apiName GetWordPressSettings
 * @apiGroup Settings
 * @apiDescription
 *   Returns the global WordPress integration credentials from the global config. Only accessible by the root tenant (platform admin).
 *   Used for automated WordPress provisioning and backup workflows.
 * @apiHeader {string} Authorization Bearer JWT token.
 * @apiSuccess {string} database_password MySQL password.
 * @apiSuccess {string} spaces_access_key DigitalOcean Spaces access key.
 * @apiSuccess {string} spaces_secret_key DigitalOcean Spaces secret key.
 * @apiError (403) Forbidden Only root tenant may access.
 * @apiError (500) ServerError Database or config error.
 * @apiExample {curl} Example usage:
 *   curl -H "Authorization: Bearer <token>" https://api.example.com/settings/wordpress
 * @since 1.0.0
 */
router.get('/wordpress', async (req, res) => {
  try {
    // Only root tenant (tenant_id = '00000000-0000-0000-0000-000000000001') can access
    const ROOT_TENANT_ID = '00000000-0000-0000-0000-000000000001';
    if (!req.tenant || req.tenant.id !== ROOT_TENANT_ID) {
      return res.status(403).json({ error: 'Access denied. Root tenant only.' });
    }
 
    await ensureTable();
    const result = await pool.query('SELECT config FROM app_settings ORDER BY id DESC LIMIT 1');
    
    if (result.rows.length === 0 || !result.rows[0].config || !result.rows[0].config.wordpress) {
      // Return empty credentials if not set
      return res.json({
        database_password: '',
        spaces_access_key: '',
        spaces_secret_key: ''
      });
    }
 
    const wordpressConfig = result.rows[0].config.wordpress || {};
    return res.json({
      database_password: wordpressConfig.database_password || '',
      spaces_access_key: wordpressConfig.spaces_access_key || '',
      spaces_secret_key: wordpressConfig.spaces_secret_key || ''
    });
  } catch (err) {
    console.error('Error fetching WordPress settings:', err);
    res.status(500).json({ error: 'Server error' });
  }
});
 
// POST /settings/wordpress - Update WordPress global credentials (Root Tenant Only)
/**
 * @api {post} /settings/wordpress Update WordPress global credentials (root tenant only)
 * @apiName UpdateWordPressSettings
 * @apiGroup Settings
 * @apiDescription
 *   Updates the global WordPress integration credentials in the global config. Only accessible by the root tenant (platform admin).
 *   All fields are required. Used for automated WordPress provisioning and backup workflows.
 * @apiHeader {string} Authorization Bearer JWT token.
 * @apiParam {string} database_host MySQL host.
 * @apiParam {string} database_port MySQL port.
 * @apiParam {string} database_user MySQL user.
 * @apiParam {string} database_password MySQL password.
 * @apiParam {string} database_name MySQL database name.
 * @apiParam {string} database_sslmode MySQL SSL mode.
 * @apiParam {string} mysql_cluster_id DigitalOcean MySQL cluster ID.
 * @apiParam {string} spaces_access_key DigitalOcean Spaces access key.
 * @apiParam {string} spaces_secret_key DigitalOcean Spaces secret key.
 * @apiSuccess {boolean} success Always true if update succeeded.
 * @apiSuccess {Object} wordpress Updated WordPress config.
 * @apiError (400) BadRequest Missing required fields.
 * @apiError (403) Forbidden Only root tenant may update.
 * @apiError (500) ServerError Database or config error.
 * @apiExample {curl} Example usage:
 *   curl -X POST -H "Authorization: Bearer <token>" -H "Content-Type: application/json" \
 *     -d '{"database_host":"db.example.com","database_port":"3306","database_user":"admin","database_password":"secret","database_name":"wp_db","database_sslmode":"REQUIRED","mysql_cluster_id":"do-cluster","spaces_access_key":"AKIA...","spaces_secret_key":"..."}' \
 *     https://api.example.com/settings/wordpress
 * @since 1.0.0
 */
router.post('/wordpress', async (req, res) => {
  try {
    // Only root tenant (tenant_id = '00000000-0000-0000-0000-000000000001') can update
    const ROOT_TENANT_ID = '00000000-0000-0000-0000-000000000001';
    if (!req.tenant || req.tenant.id !== ROOT_TENANT_ID) {
      return res.status(403).json({ error: 'Access denied. Root tenant only.' });
    }
 
    const { 
      database_host, 
      database_port, 
      database_user, 
      database_password, 
      database_name,
      database_sslmode,
      mysql_cluster_id,
      spaces_access_key, 
      spaces_secret_key 
    } = req.body;
 
    // Validate required fields
    if (!database_host || !database_port || !database_user || !database_password || 
        !database_name || !mysql_cluster_id || !spaces_access_key || !spaces_secret_key) {
      return res.status(400).json({ 
        error: 'All fields are required: database_host, database_port, database_user, database_password, database_name, database_sslmode, mysql_cluster_id, spaces_access_key, spaces_secret_key' 
      });
    }
 
    await ensureTable();
    
    // Get current config or create default
    const result = await pool.query('SELECT config FROM app_settings ORDER BY id DESC LIMIT 1');
    let config;
    
    if (result.rows.length === 0) {
      // Create default config with WordPress settings
      config = {
        general: { companyName: 'Demo MSP', timezone: 'UTC', dateFormat: 'YYYY-MM-DD' },
        notifications: { emailEnabled: true, slackEnabled: false, alertThresholds: { cpu: 90, memory: 90, disk: 90 } },
        display: { itemsPerPage: 10, theme: 'light' },
        wordpress: {
          database_host,
          database_port,
          database_user,
          database_password,
          database_name,
          database_sslmode: database_sslmode || 'REQUIRED',
          mysql_cluster_id,
          spaces_access_key,
          spaces_secret_key
        }
      };
      await pool.query('INSERT INTO app_settings (config) VALUES ($1)', [config]);
    } else {
      // Update existing config with WordPress settings
      config = result.rows[0].config || {};
      config.wordpress = {
        database_host,
        database_port,
        database_user,
        database_password,
        database_name,
        database_sslmode: database_sslmode || 'REQUIRED',
        mysql_cluster_id,
        spaces_access_key,
        spaces_secret_key
      };
      await pool.query('UPDATE app_settings SET config = $1, updated_at = CURRENT_TIMESTAMP WHERE id = (SELECT id FROM app_settings ORDER BY id DESC LIMIT 1)', [config]);
    }
 
    res.json({ 
      success: true, 
      message: 'WordPress settings updated successfully',
      wordpress: config.wordpress
    });
  } catch (err) {
    console.error('Error updating WordPress settings:', err);
    res.status(500).json({ error: 'Server error' });
  }
});
 
// GET /settings/:key - for individual tenant settings
/**
 * @api {get} /settings/:key Get individual tenant setting by key
 * @apiName GetTenantSetting
 * @apiGroup Settings
 * @apiDescription
 *   Retrieves a single tenant-specific setting by key. Returns default values for known keys if not set.
 *   Used for fine-grained configuration and UI customization.
 * @apiHeader {string} Authorization Bearer JWT token.
 * @apiParam {string} key Setting key (URL param).
 * @apiSuccess {string} setting_key The key requested.
 * @apiSuccess {string} setting_value The value for this tenant.
 * @apiSuccess {string} tenant_id Tenant ID.
 * @apiError (400) BadRequest Tenant context required.
 * @apiError (404) NotFound Setting not found.
 * @apiError (500) ServerError Database error.
 * @apiExample {curl} Example usage:
 *   curl -H "Authorization: Bearer <token>" https://api.example.com/settings/company_name
 * @since 1.0.0
 */
router.get('/:key', async (req, res) => {
  const { key } = req.params;
  try {
    const tenantId = req.tenant?.id || req.user?.tenantId;
    if (!tenantId) {
      return res.status(400).json({ error: 'Tenant context required' });
    }
 
    const result = await pool.query(
      'SELECT * FROM tenant_settings WHERE tenant_id = $1 AND setting_key = $2',
      [tenantId, key]
    );
    
    if (result.rows.length === 0) {
      // Return defaults for known settings
      const defaults = {
        'default_tax_rate': '10.00',
        'company_name': 'My Company',
        'company_abn': '',
        'company_address': '',
        'company_phone': '',
        'company_email': ''
      };
      
      if (defaults[key] !== undefined) {
        return res.json({ setting_key: key, setting_value: defaults[key], tenant_id: tenantId });
      }
      
      return res.status(404).json({ error: 'Setting not found' });
    }
    
    res.json(result.rows[0]);
  } catch (err) {
    console.error('Error fetching setting:', err);
    res.status(500).send('Server error');
  }
});
 
// PUT /settings/:key - update individual tenant setting (Admin only)
/**
 * @api {put} /settings/:key Update individual tenant setting (admin only)
 * @apiName UpdateTenantSetting
 * @apiGroup Settings
 * @apiDescription
 *   Updates a single tenant-specific setting by key. Only accessible by tenant admins.
 *   Used for fine-grained configuration and UI customization.
 * @apiHeader {string} Authorization Bearer JWT token.
 * @apiParam {string} key Setting key (URL param).
 * @apiParam {string} setting_value New value for the setting.
 * @apiParam {string} [description] Optional description.
 * @apiSuccess {string} setting_key The key updated.
 * @apiSuccess {string} setting_value The new value.
 * @apiSuccess {string} tenant_id Tenant ID.
 * @apiError (400) BadRequest Tenant context required.
 * @apiError (500) ServerError Database error.
 * @apiExample {curl} Example usage:
 *   curl -X PUT -H "Authorization: Bearer <token>" -H "Content-Type: application/json" \
 *     -d '{"setting_value":"Acme MSP"}' https://api.example.com/settings/company_name
 * @since 1.0.0
 */
router.put('/:key', requireAdmin, async (req, res) => {
  const { key } = req.params;
  const { setting_value, description } = req.body;
  
  try {
    const tenantId = req.tenant?.id || req.user?.tenantId;
    if (!tenantId) {
      return res.status(400).json({ error: 'Tenant context required' });
    }
 
    const result = await pool.query(
      `INSERT INTO tenant_settings (tenant_id, setting_key, setting_value, description, updated_at)
       VALUES ($1, $2, $3, $4, CURRENT_TIMESTAMP)
       ON CONFLICT (tenant_id, setting_key) 
       DO UPDATE SET setting_value = $3, description = $4, updated_at = CURRENT_TIMESTAMP
       RETURNING *`,
      [tenantId, key, setting_value, description]
    );
    res.json(result.rows[0]);
  } catch (err) {
    console.error('Error updating setting:', err);
    res.status(500).send('Failed to update setting');
  }
});
 
// PUT update settings (Admin only)
// If called in a tenant context (non-admin subdomain), persist tenant overrides in tenant_settings.
// If called in the root/admin context, replace global defaults in app_settings.
router.put('/', authenticateToken, requireAdmin, async (req, res) => {
  try {
 
    const tenantId = req.tenant?.id || req.user?.tenantId || null;
    const isAdminSubdomain = req.tenant?.subdomain === 'admin' || req.tenant?.is_msp === true;
    const payload = req.body || {};
 
    // If NOT in a specific tenant context (or in admin/root context), write global defaults
    if (!tenantId || isAdminSubdomain) {
      await ensureTable();
      const result = await pool.query('INSERT INTO app_settings (config) VALUES ($1) RETURNING config', [payload]);
      return res.json(result.rows[0].config);
    }
 
    // Otherwise, we are updating settings for a particular tenant -> map to tenant_settings keys
    await pool.query(`
      CREATE TABLE IF NOT EXISTS tenant_settings (
        tenant_id INTEGER NOT NULL,
        setting_key TEXT NOT NULL,
        setting_value TEXT,
        description TEXT,
        updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
        PRIMARY KEY (tenant_id, setting_key)
      )
    `);
 
    // Build batch of upserts for known fields
    const upserts = [];
    const pushUpsert = (key, val, desc) => {
      if (val === undefined || val === null) return;
      upserts.push(pool.query(
        `INSERT INTO tenant_settings (tenant_id, setting_key, setting_value, description, updated_at)
         VALUES ($1, $2, $3, $4, CURRENT_TIMESTAMP)
         ON CONFLICT (tenant_id, setting_key)
         DO UPDATE SET setting_value = EXCLUDED.setting_value, description = EXCLUDED.description, updated_at = CURRENT_TIMESTAMP`,
        [tenantId, key, String(val), desc || null]
      ));
    };
 
    // General
    if (payload.general) {
      pushUpsert('company_name', payload.general.companyName, 'General: Company name');
      pushUpsert('general_timezone', payload.general.timezone, 'General: Timezone');
      pushUpsert('general_date_format', payload.general.dateFormat, 'General: Date format');
        // Also update the tenant name in tenants table if companyName is present
        if (payload.general.companyName) {
          try {
            await pool.query(
              'UPDATE tenants SET name = $1 WHERE tenant_id = $2',
              [payload.general.companyName, tenantId]
            );
          } catch (err) {
            console.error('Error updating tenant name:', err);
          }
        }
    }
 
    // Display
    if (payload.display) {
      pushUpsert('display_theme', payload.display.theme, 'Display: Theme');
      pushUpsert('display_items_per_page', payload.display.itemsPerPage, 'Display: Items per page');
    }
 
    // Notifications (optional future mapping)
    // if (payload.notifications) { ... }
 
    await Promise.all(upserts);
 
    // Recompute merged config for this tenant (same logic as GET)
    await ensureTable();
    const result = await pool.query('SELECT config FROM app_settings ORDER BY id DESC LIMIT 1');
    let baseConfig = (result.rows[0] && result.rows[0].config) ? result.rows[0].config : {
      general: { companyName: 'Demo MSP', timezone: 'UTC', dateFormat: 'YYYY-MM-DD' },
      notifications: { emailEnabled: true, slackEnabled: false, alertThresholds: { cpu: 90, memory: 90, disk: 90 } },
      display: { itemsPerPage: 10, theme: 'light' }
    };
    baseConfig.general = baseConfig.general || { companyName: 'Demo MSP', timezone: 'UTC', dateFormat: 'YYYY-MM-DD' };
    baseConfig.display = baseConfig.display || { itemsPerPage: 10, theme: 'light' };
    baseConfig.notifications = baseConfig.notifications || { emailEnabled: true, slackEnabled: false, alertThresholds: { cpu: 90, memory: 90, disk: 90 } };
 
    const overridesRes = await pool.query(
      'SELECT setting_key, setting_value FROM tenant_settings WHERE tenant_id = $1',
      [tenantId]
    );
    const overrides = Object.fromEntries(overridesRes.rows.map(r => [r.setting_key, r.setting_value]));
    const merged = JSON.parse(JSON.stringify(baseConfig));
    if (overrides.company_name !== undefined) merged.general.companyName = overrides.company_name;
    if (overrides.general_timezone !== undefined) merged.general.timezone = overrides.general_timezone;
    if (overrides.general_date_format !== undefined) merged.general.dateFormat = overrides.general_date_format;
    if (overrides.display_theme !== undefined) merged.display.theme = overrides.display_theme;
    if (overrides.display_items_per_page !== undefined) {
      const n = parseInt(overrides.display_items_per_page, 10);
      if (!Number.isNaN(n)) merged.display.itemsPerPage = n;
    }
    return res.json(merged);
  } catch (err) {
    console.error('Error updating settings:', err);
    res.status(500).send('Server error');
  }
});
 
/**
 * @api {put} /settings/ Update settings (admin only, global or tenant context)
 * @apiName UpdateSettings
 * @apiGroup Settings
 * @apiDescription
 *   Updates settings for the current context:
 *   - In admin/root context, replaces global defaults in `app_settings`.
 *   - In tenant context, persists tenant overrides in `tenant_settings`.
 *   - Only accessible by admins.
 *   - Also syncs company name to tenants table if present.
 * @apiHeader {string} Authorization Bearer JWT token.
 * @apiParam {object} config New config object (see GET /settings/ for structure).
 * @apiSuccess {object} config Updated merged config for this tenant or global.
 * @apiError (500) ServerError Database or merge error.
 * @apiExample {curl} Example usage (tenant):
 *   curl -X PUT -H "Authorization: Bearer <token>" -H "Content-Type: application/json" \
 *     -d '{"general":{"companyName":"Acme MSP","timezone":"America/New_York"},"display":{"theme":"dark"}}' \
 *     https://api.example.com/settings/
 * @since 1.0.0
 */
module.exports = router;