@reldens/cms 0.52.0 → 0.53.0

package/bin/reldens-cms-generate-entities.js

@@ -9,7 +9,6 @@
 const { Manager } = require('../index');
 const { PrismaClientLoader } = require('@reldens/storage');
 const { Logger, sc } = require('@reldens/utils');
-const { FileHandler } = require('@reldens/server-utils');
 const readline = require('readline');
 
 class CmsEntitiesGenerator

package/install/index.html

@@ -109,6 +109,10 @@
                         <input type="checkbox" name="install-dynamic-forms" id="install-dynamic-forms" checked/>
                         <label for="install-dynamic-forms">Install dynamic forms system</label>
                     </div>
+                    <div class="input-box input-checkbox install-seo-files">
+                        <input type="checkbox" name="install-seo-files" id="install-seo-files" checked/>
+                        <label for="install-seo-files">Install default robots.txt and sitemap.xml</label>
+                    </div>
                     <div class="input-box submit-container">
                         <input id="install-submit-button" type="submit" value="Install"/>
                         <img class="install-loading hidden" src="/install-assets/img/loading.gif"/>

package/lib/admin-manager/router-contents.js

@@ -248,6 +248,7 @@ class RouterContents
             let loadedEntities = await entityRepository.load(idsFilter);
             await this.deleteEntitiesRelatedFiles(driverResource, loadedEntities);
             let deleteResult = await entityRepository.delete(idsFilter);
+            await this.emitEvent('reldens.adminAfterEntityDelete', {driverResource, idProperty, ids});
             return redirectPath + (deleteResult ? 'success' : 'errorStorageFailure');
         } catch (error) {
             return redirectPath + 'errorDeleteFailure';

package/lib/frontend/content-renderer.js

@@ -119,6 +119,7 @@ class ContentRenderer
         );
         let templatePath = this.templateResolver.findTemplatePath(templateName, domain);
         if(!templatePath){
+            Logger.warning('Template not found: "'+templateName+'" for domain: "'+domain+'"');
             return layoutContent;
         }
         let routerKey = route?.router;

package/lib/frontend/template-cache.js

@@ -13,7 +13,7 @@ class TemplateCache
     constructor(props)
     {
         this.templatesPath = sc.get(props, 'templatesPath', '');
-        this.templateExtensions = sc.get(props, 'templateExtensions', ['.html', '.mustache', '.template']);
+        this.templateExtensions = sc.get(props, 'templateExtensions', ['.html', '.mustache', '.template', '.txt', '.xml', '.json']);
         this.defaultDomain = sc.get(props, 'defaultDomain', 'default');
         this.partialsCache = {};
         this.domainPartialsCache = new Map();

package/lib/frontend/template-resolver.js

@@ -5,7 +5,7 @@
  */
 
 const { FileHandler } = require('@reldens/server-utils');
-const { sc } = require('@reldens/utils');
+const { Logger, sc } = require('@reldens/utils');
 
 class TemplateResolver
 {
@@ -13,7 +13,11 @@ class TemplateResolver
     constructor(props)
     {
         this.templatesPath = sc.get(props, 'templatesPath', '');
-        this.templateExtensions = sc.get(props, 'templateExtensions', ['.html', '.mustache', '.template']);
+        this.templateExtensions = sc.get(
+            props,
+            'templateExtensions',
+            ['.html', '.mustache', '.template', '.txt', '.xml', '.json']
+        );
         this.defaultDomain = sc.get(props, 'defaultDomain', 'default');
         this.domainMapping = sc.get(props, 'domainMapping', {});
         this.siteKeyMapping = sc.get(props, 'siteKeyMapping', {});
@@ -75,6 +79,7 @@ class TemplateResolver
                 return templatePath;
             }
         }
+        Logger.debug('Template file not found: "'+templateName+'" in path: "'+basePath+'"');
         return false;
     }
 

package/lib/frontend.js

@@ -33,7 +33,11 @@ class Frontend
         this.projectRoot = sc.get(props, 'projectRoot', './');
         this.templatesPath = FileHandler.joinPaths(this.projectRoot, 'templates');
         this.publicPath = FileHandler.joinPaths(this.projectRoot, 'public');
-        this.templateExtensions = sc.get(props, 'templateExtensions', ['.html', '.mustache', '.template']);
+        this.templateExtensions = sc.get(
+            props,
+            'templateExtensions',
+            ['.html', '.mustache', '.template', '.txt', '.xml', '.json']
+        );
         this.defaultDomain = sc.get(props, 'defaultDomain', 'default');
         this.domainMapping = sc.get(props, 'domainMapping', {});
         this.siteKeyMapping = sc.get(props, 'siteKeyMapping', {});
@@ -95,6 +99,12 @@ class Frontend
             enableJsonResponse: sc.get(props, 'enableJsonResponse', false),
             events: this.events
         });
+        this.contentTypeMap = sc.get(props, 'contentTypeMap', {
+            '.txt': 'text/plain',
+            '.xml': 'application/xml',
+            '.json': 'application/json',
+            '.html': 'text/html'
+        });
     }
 
     async initialize()
@@ -153,6 +163,16 @@ class Frontend
         return true;
     }
 
+    getContentTypeFromPath(path)
+    {
+        let lastDotIndex = path.lastIndexOf('.');
+        if(-1 === lastDotIndex){
+            return 'text/html';
+        }
+        let extension = path.substring(lastDotIndex);
+        return sc.get(this.contentTypeMap, extension, 'text/html');
+    }
+
     async handleRequest(req, res)
     {
         try {
@@ -178,10 +198,14 @@ class Frontend
                 if(!originalPath.endsWith('/') && routeFoundWithSlash){
                     return res.redirect(301, originalPath + '/');
                 }
+                let contentType = this.getContentTypeFromPath(originalPath);
                 return await this.responseManager.renderWithCacheHandler(
                     async () => await this.contentRenderer.generateRouteContent(route, domain, req),
                     async () => await this.responseManager.renderNotFound(domain, res, req),
-                    async (content) => res.send(content),
+                    async (content) => {
+                        res.setHeader('Content-Type', contentType);
+                        return res.send(content);
+                    },
                     domain,
                     res,
                     originalPath,
@@ -200,6 +224,7 @@ class Frontend
             }
             let entityResult = await this.entityAccessManager.findEntityByPath(originalPath);
             if(entityResult){
+                let contentType = this.getContentTypeFromPath(originalPath);
                 return await this.responseManager.renderWithCacheHandler(
                     async () => await this.contentRenderer.renderWithTemplateContent(
                         entityResult.entity,
@@ -209,7 +234,10 @@ class Frontend
                         null
                     ),
                     async () => await this.responseManager.renderNotFound(domain, res, req),
-                    async (content) => res.send(content),
+                    async (content) => {
+                        res.setHeader('Content-Type', contentType);
+                        return res.send(content);
+                    },
                     domain,
                     res,
                     originalPath,
@@ -218,12 +246,16 @@ class Frontend
             }
             let templatePath = this.templateResolver.findTemplateByPath(originalPath, domain);
             if(templatePath){
+                let contentType = this.getContentTypeFromPath(originalPath);
                 return await this.responseManager.renderWithCacheHandler(
                     async () => await this.contentRenderer.generateTemplateContent(templatePath, domain, req),
                     async () => res.status(500).send('Template error: '+templatePath),
-                    async (content) => res.send(
-                        await this.contentRenderer.renderWithTemplateContent({content}, {}, domain, req, null)
-                    ),
+                    async (content) => {
+                        res.setHeader('Content-Type', contentType);
+                        return res.send(
+                            await this.contentRenderer.renderWithTemplateContent({content}, {}, domain, req, null)
+                        );
+                    },
                     domain,
                     res,
                     originalPath,

package/lib/manager.js

@@ -21,6 +21,7 @@ const { Frontend } = require('./frontend');
 const { CacheManager } = require('./cache/cache-manager');
 const { TemplateReloader } = require('./template-reloader');
 const { PasswordEncryptionHandler } = require('./password-encryption-handler');
+const { SitemapLoader } = require('./sitemap-loader');
 const { EventsManagerSingleton, Logger, sc } = require('@reldens/utils');
 const { DriversMap } = require('@reldens/storage');
 const { AppServerFactory, FileHandler, Encryptor } = require('@reldens/server-utils');
@@ -74,7 +75,11 @@ class Manager
             'domainCdnMapping',
             sc.toJson(process.env.RELDENS_DOMAIN_CDN_MAPPING, {})
         );
-        this.templateExtensions = sc.get(props, 'templateExtensions', ['.html', '.template']);
+        this.templateExtensions = sc.get(
+            props,
+            'templateExtensions',
+            ['.html', '.mustache', '.template', '.txt', '.xml', '.json']
+        );
         this.cache = sc.get(props, 'cache', false);
         this.reloadTime = sc.get(props, 'reloadTime', 0);
         this.app = sc.get(props, 'app', false);
@@ -416,6 +421,11 @@ class Manager
                 return false;
             }
         }
+        this.sitemapLoader = new SitemapLoader({
+            dataServer: this.dataServer,
+            events: this.events,
+            domainMapping: this.domainMapping
+        });
         if(!this.useProvidedServer){
             await this.appServer.listen(this.config.port);
         }

package/lib/mysql-installer.js

@@ -20,7 +20,8 @@ class MySQLInstaller
             'install-default-homepage': 'default-homepage.sql',
             'install-default-blocks': 'default-blocks.sql',
             'install-entity-access': 'default-entity-access.sql',
-            'install-dynamic-forms': 'default-forms.sql'
+            'install-dynamic-forms': 'default-forms.sql',
+            'install-seo-files': 'default-sitemaps-and-robots.sql'
         };
     }
 

package/lib/sitemap-loader.js

@@ -0,0 +1,101 @@
+/**
+ *
+ * Reldens - CMS - SitemapLoader
+ *
+ */
+
+const { Logger, sc } = require('@reldens/utils');
+
+class SitemapLoader
+{
+
+    constructor(props)
+    {
+        this.dataServer = sc.get(props, 'dataServer', false);
+        this.routesRepository = this.dataServer?.getEntity('routes');
+        this.events = sc.get(props, 'events', false);
+        this.domainMapping = sc.get(props, 'domainMapping', {});
+        this.listenEvents();
+    }
+
+    listenEvents()
+    {
+        if(!this.events){
+            Logger.error('EventsManager not provided for SitemapLoader.');
+            return;
+        }
+        this.events.on('reldens.afterVariablesCreated', this.loadSitemapData.bind(this));
+    }
+
+    async loadSitemapData(eventData)
+    {
+        if(!this.dataServer){
+            Logger.error('DataServer not provided for SitemapLoader.');
+            return;
+        }
+        if(!this.routesRepository){
+            Logger.error('Routes repository not found for SitemapLoader.');
+            return;
+        }
+        let req = eventData.renderContext.req;
+        if(!req){
+            return;
+        }
+        if(!req.path){
+            return;
+        }
+        if('/sitemap.xml' !== req.path){
+            return;
+        }
+        if(req.sitemapPages){
+            eventData.variables.sitemapPages = req.sitemapPages;
+            return;
+        }
+        let currentDomain = eventData.renderContext.domain;
+        let mappedDomain = this.resolveMappedDomain(currentDomain);
+        let filters = {
+            enabled: 1,
+            redirect_url: null,
+            redirect_type: null,
+            OR: [
+                {domain: null},
+                {domain: mappedDomain}
+            ]
+        };
+        try {
+            let routesWithPages = await this.routesRepository.loadWithRelations(filters, 'cms_pages');
+            let sitemapPages = routesWithPages.filter(route => {
+                if(!route.cms_pages || 0 === route.cms_pages.length){
+                    return false;
+                }
+                let page = route.cms_pages[0];
+                if('noindex,nofollow' === page.meta_robots){
+                    return false;
+                }
+                return true;
+            });
+            req.sitemapPages = sitemapPages;
+            eventData.variables.sitemapPages = sitemapPages;
+        } catch (error) {
+            Logger.error('Error loading sitemap data: '+error.message);
+        }
+    }
+
+    resolveMappedDomain(currentDomain)
+    {
+        if(!this.domainMapping){
+            return currentDomain;
+        }
+        if(!sc.isObject(this.domainMapping)){
+            return currentDomain;
+        }
+        let mappedValue = sc.get(this.domainMapping, currentDomain, false);
+        if(!mappedValue){
+            return currentDomain;
+        }
+        return mappedValue;
+    }
+
+}
+
+module.exports.SitemapLoader = SitemapLoader;

package/lib/template-engine/collections-transformer.js

@@ -234,7 +234,14 @@ class CollectionsTransformer extends CollectionsTransformerBase
                     this.jsonFieldsParser.getJsonFieldsForEntity(tableName)
                 );
             }
-            let collectionContent = await this.renderCollectionLoop(loopContent, collectionData, domain, req, systemVariables, enhancedData);
+            let collectionContent = await this.renderCollectionLoop(
+                loopContent,
+                collectionData,
+                domain,
+                req,
+                systemVariables,
+                enhancedData
+            );
             finalContent = this.renderEngine.render(
                 1 < paginationData.totalPages
                     ? this.loadPaginationTemplate(paginationOptions.containerName, domain)
@@ -259,7 +266,14 @@ class CollectionsTransformer extends CollectionsTransformerBase
                 queryOptionsJson,
                 relationsString
             );
-            finalContent = await this.renderCollectionLoop(loopContent, collectionData, domain, req, systemVariables, enhancedData);
+            finalContent = await this.renderCollectionLoop(
+                loopContent,
+                collectionData,
+                domain,
+                req,
+                systemVariables,
+                enhancedData
+            );
         }
         return template.substring(0, startPos) + finalContent + template.substring(endPos + endMatch[0].length);
     }
@@ -312,7 +326,14 @@ class CollectionsTransformer extends CollectionsTransformerBase
         }
         let renderedContent = '';
         for(let row of collectionData){
-            renderedContent += await this.processPartialsInLoop(loopContent, row, domain, req, systemVariables, enhancedData);
+            renderedContent += await this.processPartialsInLoop(
+                loopContent,
+                row,
+                domain,
+                req,
+                systemVariables,
+                enhancedData
+            );
         }
         return renderedContent;
     }
@@ -351,7 +372,13 @@ class CollectionsTransformer extends CollectionsTransformerBase
                 continue;
             }
             if(this.processAllTemplateFunctions){
-                partialContent = await this.processAllTemplateFunctions(partialContent, domain, req, systemVariables, enhancedData);
+                partialContent = await this.processAllTemplateFunctions(
+                    partialContent,
+                    domain,
+                    req,
+                    systemVariables,
+                    enhancedData
+                );
             }
             let renderData = Object.assign({}, enhancedData);
             if(sc.hasOwn(tag.attributes, 'row')){
@@ -367,9 +394,19 @@ class CollectionsTransformer extends CollectionsTransformerBase
                 +processedContent.substring(tag.end);
         }
         if(this.processAllTemplateFunctions){
-            processedContent = await this.processAllTemplateFunctions(processedContent, domain, req, systemVariables, enhancedData);
+            processedContent = await this.processAllTemplateFunctions(
+                processedContent,
+                domain,
+                req,
+                systemVariables,
+                enhancedData
+            );
         }
-        return this.renderEngine.render(processedContent, Object.assign({}, enhancedData, {row: rowData}), this.getPartials(domain));
+        return this.renderEngine.render(
+            processedContent,
+            Object.assign({}, enhancedData, {row: rowData}),
+            this.getPartials(domain)
+        );
     }
 
     getCurrentUrl(req)

package/lib/template-engine.js

@@ -195,11 +195,7 @@ class TemplateEngine
 
     buildEnhancedRenderData(originalData, systemVariables, currentEntityData)
     {
-        let enhancedData = Object.assign({}, originalData);
-        enhancedData.currentRequest = systemVariables.currentRequest;
-        enhancedData.currentRoute = systemVariables.currentRoute;
-        enhancedData.currentDomain = systemVariables.currentDomain;
-        enhancedData.systemInfo = systemVariables.systemInfo;
+        let enhancedData = Object.assign({}, originalData, systemVariables);
         if(currentEntityData){
             enhancedData.currentEntity = currentEntityData;
         }

package/migrations/default-blocks.sql

@@ -1,5 +1,5 @@
 
--- Default CMS blocks:
+-- Default CMS blocks
 
 REPLACE INTO `cms_blocks` (`name`, `title`, `content`, `enabled`) VALUES
     ('header-main', 'Main Header', '{{>header}}', 1),

package/migrations/default-entity-access.sql

@@ -1,5 +1,5 @@
 
--- Default entity access rules:
+-- Default entity access rules
 
 REPLACE INTO `entities_access` (`entity_name`, `is_public`, `allowed_operations`) VALUES
     ('cms_pages', TRUE, '["read"]'),

package/migrations/default-forms.sql

@@ -12,7 +12,6 @@ CREATE TABLE `cms_forms` (
     UNIQUE INDEX `form_key` (`form_key`) USING BTREE
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
 
-
 CREATE TABLE `cms_forms_submitted` (
     `id` INT UNSIGNED NOT NULL AUTO_INCREMENT,
     `form_id` INT UNSIGNED NOT NULL,

package/migrations/default-homepage.sql

@@ -1,19 +1,19 @@
--- Default homepage:
 
--- Create a default route first
-REPLACE INTO `routes` (`id`, `path`, `router`, `cache_ttl_seconds`, `enabled`, `created_at`) VALUES (1, '/', 'cmsPages', 3600, 1, NOW());
+-- Default homepage
 
--- Create a default homepage with route_id reference
-REPLACE INTO `cms_pages` (
+INSERT INTO `routes` (`id`, `path`, `router`, `cache_ttl_seconds`, `enabled`, `created_at`) VALUES (NULL, '/', 'cmsPages', 3600, 1, NOW());
+SET @route_id = LAST_INSERT_ID();
+
+INSERT INTO `cms_pages` (
     `id`, `title`, `content`, `template`, `route_id`, `meta_title`, `meta_description`,
     `canonical_url`, `meta_robots`, `meta_og_title`, `meta_og_description`,
     `meta_og_image`, `meta_twitter_card_type`, `status`, `locale`, `publish_date`, `expire_date`, `created_at`
 ) VALUES (
-    1,
+    NULL,
     'Home',
     '<h1>Welcome to Reldens CMS</h1><p>This is your homepage. Edit this content in the admin panel.</p>',
     NULL,
-    1,
+    @route_id,
     'Home - Reldens CMS',
     'Welcome to Reldens CMS',
     NULL,

package/migrations/default-sitemaps-and-robots.sql

@@ -0,0 +1,44 @@
+
+-- Default robots.txt and sitemap.xml
+
+INSERT INTO `routes` (`id`, `path`, `router`, `cache_ttl_seconds`, `enabled`, `created_at`) VALUES
+(NULL, '/robots.txt', 'cmsPages', 3600, 1, NOW());
+SET @route_id_robots = LAST_INSERT_ID();
+
+INSERT INTO `cms_pages` (
+    `id`, `title`, `content`, `template`, `layout`, `route_id`, `meta_robots`,
+    `status`, `locale`, `publish_date`, `created_at`
+) VALUES (
+    NULL,
+    'Robots.txt',
+    NULL,
+    'robots',
+    'raw',
+    @route_id_robots,
+    'noindex,nofollow',
+    NULL,
+    NULL,
+    NOW(),
+    NOW()
+);
+
+INSERT INTO `routes` (`id`, `path`, `router`, `cache_ttl_seconds`, `enabled`, `domain`, `created_at`) VALUES
+(NULL, '/sitemap.xml', 'cmsPages', 3600, 1, NULL, NOW());
+SET @route_id_sitemap = LAST_INSERT_ID();
+
+INSERT INTO `cms_pages` (
+    `id`, `title`, `content`, `template`, `layout`, `route_id`, `meta_robots`,
+    `status`, `locale`, `publish_date`, `created_at`
+) VALUES (
+    NULL,
+    'Sitemap XML',
+    NULL,
+    'sitemap',
+    'raw',
+    @route_id_sitemap,
+    'noindex,nofollow',
+    NULL,
+    NULL,
+    NOW(),
+    NOW()
+);

package/migrations/default-user.sql

@@ -1,5 +1,5 @@
 
--- Default admin user:
+-- Default admin user
 
 REPLACE INTO `users` (`id`, `email`, `username`, `password`, `role_id`, `status`)
 VALUES (

package/migrations/users-authentication.sql

@@ -1,5 +1,5 @@
 
--- Default db-users authentication:
+-- Default db-users authentication
 
 CREATE TABLE IF NOT EXISTS `users` (
     `id` INT UNSIGNED NOT NULL AUTO_INCREMENT,

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@reldens/cms",
     "scope": "@reldens",
-    "version": "0.52.0",
+    "version": "0.53.0",
     "description": "Reldens - CMS",
     "author": "Damian A. Pastorini",
     "license": "MIT",
@@ -13,8 +13,7 @@
     "bin": {
         "reldens-cms": "bin/reldens-cms.js",
         "reldens-cms-generate-entities": "bin/reldens-cms-generate-entities.js",
-        "reldens-cms-update-password": "bin/reldens-cms-update-password.js",
-        "reldens-cms-generate-sitemap": "bin/reldens-cms-generate-sitemap.js"
+        "reldens-cms-update-password": "bin/reldens-cms-update-password.js"
     },
     "repository": {
         "type": "git",
@@ -36,7 +35,7 @@
     },
     "dependencies": {
         "@reldens/server-utils": "^0.44.0",
-        "@reldens/storage": "^0.87.0",
+        "@reldens/storage": "^0.88.0",
         "@reldens/utils": "^0.54.0",
         "dotenv": "17.2.3",
         "mustache": "4.2.0"

package/templates/layouts/raw.html

@@ -0,0 +1 @@
+{{&content}}

package/templates/raw.html

@@ -0,0 +1 @@
+{{&content}}

package/templates/robots.txt

@@ -0,0 +1,3 @@
+User-agent: *
+Allow: /
+Sitemap: {{&currentRequest.publicUrl}}/sitemap.xml

package/templates/sitemap.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+{{#sitemapPages}}
+    <url>
+        <loc>{{&currentRequest.publicUrl}}{{&path}}</loc>
+        <lastmod>{{&updated_at}}</lastmod>
+    </url>
+{{/sitemapPages}}
+</urlset>