Add site endpoint.

CHANGELOG.md

@@ -23,6 +23,7 @@
 - Add expand catalog option to get content call @robgietema
 - Add content events @robgietema
 - Add profile metadata @robgietema
+- Add @site endpoint @robgietema
 
 ### Bugfix
 

docs/examples/content/get_notfound.res

@@ -2,5 +2,5 @@ HTTP/1.1 404 Not Found
 Content-Type: application/json
 
 {
-  "error": "Not found."
+  "error": "Not found: /random"
 }

docs/examples/controlpanels/list.res

@@ -16,5 +16,10 @@ Content-Type: application/json
     "@id": "http://localhost:8000/@controlpanels/navigation",
     "group": "General",
     "title": "Navigation"
+  },
+  {
+    "@id": "http://localhost:8000/@controlpanels/site",
+    "group": "General",
+    "title": "Site"
   }
 ]

docs/examples/site/get.req

@@ -0,0 +1,2 @@
+GET /@site HTTP/1.1
+Accept: application/json

docs/examples/site/get.res

@@ -0,0 +1,9 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+    "@id": "http://localhost:8000/@site",
+    "robots_txt": "Sitemap: {portal_url}/sitemap.xml.gz\n\n# Define access-restrictions for robots/spiders\n# http://www.robotstxt.org/wc/norobots.html\n\n\n\n# By default we allow robots to access all areas of our site\n# already accessible to anonymous users\n\nUser-agent: *\nDisallow:\n\n\n\n# Add Googlebot-specific syntax extension to exclude forms\n# that are repeated for each piece of content in the site\n# the wildcard is only supported by Googlebot\n# http://www.google.com/support/webmasters/bin/answer.py?answer=40367&ctx=sibling\n\nUser-Agent: Googlebot\nDisallow: /*?\nDisallow: /*atct_album_view$\nDisallow: /*folder_factories$\nDisallow: /*folder_summary_view$\nDisallow: /*login_form$\nDisallow: /*mail_password_form$\nDisallow: /@@search\nDisallow: /*search_rss$\nDisallow: /*sendto_form$\nDisallow: /*summary_view$\nDisallow: /*thumbnail_view$\nDisallow: /*view$\n",
+    "site_logo": null,
+    "site_title": "Nick"
+}

docs/site.md

@@ -0,0 +1,20 @@
+---
+nav_order: 24
+permalink: /site
+---
+
+# Site
+
+The `@site` endpoint provides general site-wide information, such as the site title, logo, and other information. It uses the view permission, which requires appropriate authorization.
+
+Send a `GET` request to the `@site` endpoint:
+
+```
+{% include_relative examples/site/get.req %}
+```
+
+The response will contain the site information:
+
+```
+{% include_relative examples/site/get.res %}
+```

src/profiles/core/controlpanels/site.json

@@ -0,0 +1,40 @@
+{
+  "id": "site",
+  "title:i18n": "Site",
+  "group": "General",
+  "schema": {
+    "fieldsets": [
+      {
+        "fields": ["robots_txt", "site_logo", "site_title"],
+        "id": "general",
+        "title": "General"
+      }
+    ],
+    "properties": {
+      "robots_txt": {
+        "title:i18n": "Robots.txt",
+        "description:i18n": "This is the contents of the robots.txt file.",
+        "type": "string",
+        "widget": "textarea"
+      },
+      "site_logo": {
+        "description:i18n": "This shows a custom logo on your site.",
+        "title:i18n": "Site Logo",
+        "type": "object",
+        "widget": "file",
+        "factory": "Image"
+      },
+      "site_title": {
+        "title:i18n": "Site title",
+        "description:i18n": "This shows up in the title bar of browsers and in syndication feeds.",
+        "type": "string"
+      }
+    },
+    "required": []
+  },
+  "data": {
+    "robots_txt": "Sitemap: {portal_url}/sitemap.xml.gz\n\n# Define access-restrictions for robots/spiders\n# http://www.robotstxt.org/wc/norobots.html\n\n\n\n# By default we allow robots to access all areas of our site\n# already accessible to anonymous users\n\nUser-agent: *\nDisallow:\n\n\n\n# Add Googlebot-specific syntax extension to exclude forms\n# that are repeated for each piece of content in the site\n# the wildcard is only supported by Googlebot\n# http://www.google.com/support/webmasters/bin/answer.py?answer=40367&ctx=sibling\n\nUser-Agent: Googlebot\nDisallow: /*?\nDisallow: /*atct_album_view$\nDisallow: /*folder_factories$\nDisallow: /*folder_summary_view$\nDisallow: /*login_form$\nDisallow: /*mail_password_form$\nDisallow: /@@search\nDisallow: /*search_rss$\nDisallow: /*sendto_form$\nDisallow: /*summary_view$\nDisallow: /*thumbnail_view$\nDisallow: /*view$\n",
+    "site_logo": null,
+    "site_title": "Nick"
+  }
+}

src/routes/index.js

@@ -18,6 +18,7 @@ import querystring from './querystring/querystring';
 import roles from './roles/roles';
 import search from './search/search';
 import sharing from './sharing/sharing';
+import site from './site/site';
 import system from './system/system';
 import types from './types/types';
 import users from './users/users';
@@ -39,6 +40,7 @@ export default [
   ...roles,
   ...search,
   ...sharing,
+  ...site,
   ...system,
   ...types,
   ...users,

src/routes/site/site.js

@@ -0,0 +1,29 @@
+/**
+ * Site route.
+ * @module routes/site/site
+ */
+
+import { Controlpanel } from '../../models';
+import { getRootUrl } from '../../helpers';
+
+export default [
+  {
+    op: 'get',
+    view: '/@site',
+    permission: 'View',
+    handler: async (req, trx) => {
+      const controlpanel = await Controlpanel.fetchById('site');
+      const config = controlpanel.data;
+
+      // Return database information
+      return {
+        json: {
+          '@id': `${getRootUrl(req)}/@site`,
+          robots_txt: config?.robots_txt,
+          site_logo: config?.site_logo,
+          site_title: config?.site_title,
+        },
+      };
+    },
+  },
+];

src/routes/site/site.test.js

@@ -0,0 +1,6 @@
+import app from '../../app';
+import { testRequest } from '../../helpers';
+
+describe('Site', () => {
+  it('should get the site information', () => testRequest(app, 'site/get'));
+});