components/sitemaps/routes.js

import { getAllSitemapsFiltered } from './backend.js';
import { requireHeader } from './../middleware.js';
import { backendInfo } from '../../server.js';
import { sitemapAllowedForClient } from './security.js';
import proxy from 'express-http-proxy';

const sitemapAccess = () => {
  return async function (req, res, next) {
    const org = req.headers['x-openhab-org'] || '';
    const user = req.headers['x-openhab-user'];
    try {
      const allowed = await sitemapAllowedForClient(user, org, req.params.sitemapname);
      if (allowed === true) {
        next();
      } else {
        res.status(403).send();
      }
    } catch {
      res.status(500).send();
    }
  };
};

/**
 * Provides required /sitemaps routes.
 *
 * @memberof routes
 * @param {*} app expressjs app
 */
const sitemaps = (app) => {
  /**
   * @swagger
   * /rest/sitemaps:
   *   get:
   *     summary: Get all available sitemaps.
   *     parameters:
   *       - in: header
   *         name: X-OPENHAB-USER
   *         required: true
   *         description: Name of user
   *         schema:
   *           type: string
   *         style: form
   *       - in: header
   *         name: X-OPENHAB-ORG
   *         required: false
   *         description: Organisations the user is member of
   *         schema:
   *           type: string
   *         style: form
   *     responses:
   *       200:
   *         description: OK
   *         content:
   *           application/json:
   *             schema:
   *               type: array
   *               items:
   *                 type: object
   */
  app.get('/rest/sitemaps', requireHeader('X-OPENHAB-USER'), async (req, res) => {
    const org = req.headers['x-openhab-org'] || '';
    const user = req.headers['x-openhab-user'];

    try {
      const data = await getAllSitemapsFiltered(backendInfo.HOST, req, user, org);
      res.status(200).send(data);
    } catch {
      res.status(500).send();
    }
  });

  /**
   * @swagger
   * /auth/sitemaps:
   *   get:
   *     summary: Authorization endpoint for Sitemap access.
   *     description: Used by nginx auth_request.
   *     parameters:
   *       - in: header
   *         name: X-OPENHAB-USER
   *         required: true
   *         description: Name of user
   *         schema:
   *           type: string
   *         style: form
   *       - in: header
   *         name: X-OPENHAB-ORG
   *         required: false
   *         description: Organisations the user is member of
   *         schema:
   *           type: string
   *         style: form
   *       - in: header
   *         name: X-ORIGINAL-URI
   *         required: true
   *         description: Original request URI
   *         schema:
   *           type: string
   *         style: form
   *     responses:
   *       200:
   *         description: Allowed
   *       403:
   *         description: Forbidden
   */
  app.get('/auth/sitemaps', requireHeader('X-OPENHAB-USER'), requireHeader('X-ORIGINAL-URI'), (req, res, next) => {
    const org = req.headers['x-openhab-org'] || '';
    const user = req.headers['x-openhab-user'];
    const regex = /\/(sitemaps|page)\/([a-zA-Z_0-9]+)/;
    const sitemapname = regex.exec(req.headers['x-original-uri']);
    if (sitemapname == null) return res.status(403).send();
    try {
      const allowed = sitemapAllowedForClient(user, org, sitemapname[2]);
      if (allowed === true) {
        res.status(200).send();
      } else {
        res.status(403).send();
      }
    } catch (err) {
      res.status(500).send();
    }
  });

  /**
   * @swagger
   * /rest/sitemaps/{sitemapname}:
   *   get:
   *     summary: Get sitemap by name.
   *     parameters:
   *       - in: path
   *         name: sitemapname
   *         required: true
   *         description: Sitemap name
   *         schema:
   *           type: string
   *         style: form
   *       - in: header
   *         name: X-OPENHAB-USER
   *         required: true
   *         description: Name of user
   *         schema:
   *           type: string
   *         style: form
   *       - in: header
   *         name: X-OPENHAB-ORG
   *         required: false
   *         description: Organisations the user is member of
   *         schema:
   *           type: string
   *         style: form
   *     responses:
   *       200:
   *         description: OK
   *         content:
   *           application/json:
   *             schema:
   *               type: object
   */
  app.get('/rest/sitemaps/:sitemapname', requireHeader('X-OPENHAB-USER'), sitemapAccess(), proxy(backendInfo.HOST + '/rest/sitemaps'));

  /**
   * @swagger
   * /rest/sitemaps/{sitemapname}/{pageid}:
   *   get:
   *     summary: Get sitemap by name.
   *     parameters:
   *       - in: path
   *         name: sitemapname
   *         required: true
   *         description: Sitemap name
   *         schema:
   *           type: string
   *         style: form
   *       - in: path
   *         name: pageid
   *         required: true
   *         description: page id
   *         schema:
   *           type: string
   *         style: form
   *       - in: header
   *         name: X-OPENHAB-USER
   *         required: true
   *         description: Name of user
   *         schema:
   *           type: string
   *         style: form
   *       - in: header
   *         name: X-OPENHAB-ORG
   *         required: false
   *         description: Organisations the user is member of
   *         schema:
   *           type: string
   *         style: form
   *     responses:
   *       200:
   *         description: OK
   *         content:
   *           application/json:
   *             schema:
   *               type: object
   */
  app.get('/rest/sitemaps/:sitemapname/:pageid', requireHeader('X-OPENHAB-USER'), sitemapAccess(), proxy(backendInfo.HOST + '/rest/sitemaps/'));

  /**
   * @swagger
   * /rest/sitemaps/events/{subscriptionid}:
   *   post:
   *     summary: Get Sitemap events. Requires nginx.
   *     parameters:
   *       - in: path
   *         name: subscriptionid
   *         required: true
   *         description: subscription id
   *         schema:
   *           type: string
   *         style: form
   *       - in: query
   *         name: sitemap
   *         required: false
   *         description: Sitemap name
   *         schema:
   *           type: string
   *         style: form
   *       - in: query
   *         name: pageid
   *         required: false
   *         description: page id
   *         schema:
   *           type: string
   *         style: form
   *     responses:
   *       200:
   *         description: OK
   *       400:
   *         description: Page not linked to the subscription.
   *       404:
   *         description: Subscription not found.
   */

  /**
   * @swagger
   * /rest/sitemaps/events/subscribe:
   *   post:
   *     summary: Creates a Sitemap event subscription. Requires nginx.
   *     responses:
   *       201:
   *         description: Subscription created.
   *       503:
   *         description: Subscriptions limit reached.
   */
};

export default sitemaps;