@reldens/cms 0.6.0 → 0.7.0

package/lib/manager.js

@@ -4,12 +4,21 @@
  *
  */
 
-const { AppServerFactory, FileHandler, Encryptor } = require('@reldens/server-utils');
-const { DriversMap } = require('@reldens/storage');
+const { TemplatesList } = require('./templates-list');
+const { AdminTranslations } = require('./admin-translations');
+const { AdminTemplatesLoader } = require('./admin-templates-loader');
+const { AdminManagerValidator } = require('./admin-manager-validator');
+const { MimeTypes } = require('./mime-types');
+const { AllowedExtensions } = require('./allowed-extensions');
+const { TemplatesToPathMapper } = require('./templates-to-path-mapper');
+const { AdminEntitiesGenerator } = require('./admin-entities-generator');
+const { LoadedEntitiesProcessor } = require('./loaded-entities-processor');
 const { AdminManager } = require('./admin-manager');
 const { Installer } = require('./installer');
 const { Frontend } = require('./frontend');
 const { EventsManagerSingleton, Logger, sc } = require('@reldens/utils');
+const { DriversMap } = require('@reldens/storage');
+const { AppServerFactory, FileHandler, Encryptor } = require('@reldens/server-utils');
 const dotenv = require('dotenv');
 const mustache = require('mustache');
 
@@ -23,14 +32,27 @@ class Manager
         this.installLockPath = FileHandler.joinPaths(this.projectRoot, 'install.lock');
         dotenv.config({path: this.envFilePath});
         this.config = this.loadConfigFromEnv();
-        this.entities = sc.get(props, 'entities', {});
-        this.rawEntities = sc.get(props, 'rawEntities', {});
-        this.entitiesConfig = sc.get(props, 'entitiesConfig', {});
+        this.adminEntities = sc.get(props, 'adminEntities', {});
+        this.rawRegisteredEntities = sc.get(props, 'rawRegisteredEntities', {});
         this.entitiesTranslations = sc.get(props, 'entitiesTranslations', {});
+        this.entitiesConfig = sc.get(props, 'entitiesConfig', {});
+        this.processedEntities = sc.get(props, 'processedEntities', {});
         this.authenticationMethod = sc.get(props, 'authenticationMethod', 'db-users');
         this.authenticationCallback = sc.get(props, 'authenticationCallback', false);
         this.events = sc.get(props, 'events', EventsManagerSingleton);
+        this.adminTemplatesList = sc.get(props, 'adminTemplatesList', TemplatesList);
+        this.projectAdminPath = FileHandler.joinPaths(this.projectRoot, 'admin');
+        this.projectAdminTemplatesPath = FileHandler.joinPaths(this.projectAdminPath, 'templates');
+        this.mimeTypes = sc.get(props, 'mimeTypes', MimeTypes);
+        this.allowedExtensions = sc.get(props, 'allowedExtensions', AllowedExtensions)
+        this.adminRoleId = sc.get(props, 'adminRoleId', 99);
+        this.stylesFilePath = sc.get(props, 'stylesFilePath', '/css/reldens-admin-client.css');
+        this.scriptsFilePath = sc.get(props, 'scriptsFilePath', '/js/reldens-admin-client.js');
+        this.companyName = sc.get(props, 'companyName', 'Reldens - CMS');
+        this.logo = sc.get(props, 'logo', '/assets/web/reldens-your-logo-mage.png');
+        this.favicon = sc.get(props, 'favicon', '/assets/web/favicon.ico');
         this.appServerFactory = new AppServerFactory();
+        this.adminEntitiesGenerator = new AdminEntitiesGenerator();
         this.installer = new Installer({
             projectRoot: this.projectRoot,
             postInstallCallback: this.initializeCmsAfterInstall.bind(this)
@@ -84,36 +106,24 @@ class Manager
             return true;
         }
         try {
-            await this.initializeDataServer();
-            await this.initializeAdminManager();
-            await this.initializeFrontend();
-            await this.appServer.listen(this.config.port);
+            await this.initializeServices();
             Logger.info('CMS running on '+this.config.host+':'+this.config.port);
             return true;
         } catch (error) {
-            Logger.error('Failed to start CMS: '+error.message);
+            Logger.critical('Failed to start CMS: '+error.message);
             return false;
         }
     }
 
-    async initializeCmsAfterInstall(entitiesData)
+    async initializeCmsAfterInstall(loadEntities)
     {
         try {
-            if(entitiesData){
-                this.entities = sc.get(entitiesData, 'entities', this.entities);
-                this.rawEntities = sc.get(entitiesData, 'rawEntities', this.rawEntities);
-                this.entitiesConfig = sc.get(entitiesData, 'entitiesConfig', this.entitiesConfig);
-                this.entitiesTranslations = sc.get(entitiesData, 'entitiesTranslations', this.entitiesTranslations);
-            }
+            this.rawRegisteredEntities = loadEntities.rawRegisteredEntities;
+            this.entitiesTranslations = loadEntities.entitiesTranslations;
+            this.entitiesConfig = loadEntities.entitiesConfig;
+            this.dataServer.rawEntities = loadEntities.rawRegisteredEntities;
             this.config = this.loadConfigFromEnv();
-            if(this.appServerFactory.error.message){
-                Logger.critical('App server creation failed: '+this.appServerFactory.error.message);
-                return false;
-            }
-            await this.initializeDataServer();
-            await this.initializeAdminManager();
-            await this.initializeFrontend();
-            await this.appServer.listen(this.config.port);
+            await this.initializeServices();
             Logger.info('CMS initialized after installation on '+this.config.host+':'+this.config.port);
             return true;
         } catch (error) {
@@ -122,6 +132,32 @@ class Manager
         }
     }
 
+    async initializeServices()
+    {
+        await this.initializeDataServer();
+        if (0 === Object.keys(this.adminEntities).length){
+            if(0 === Object.keys(this.processedEntities).length){
+                this.processedEntities = LoadedEntitiesProcessor.process(
+                    this.rawRegisteredEntities,
+                    this.entitiesTranslations,
+                    this.entitiesConfig
+                );
+            }
+            if(!this.processedEntities.entities){
+                Logger.critical('Processed entities undefined.');
+                return false;
+            }
+            await this.dataServer.generateEntities();
+            this.adminEntities = this.adminEntitiesGenerator.generate(
+                this.processedEntities.entities,
+                this.dataServer.entityManager.entities
+            );
+        }
+        await this.initializeAdminManager();
+        await this.initializeFrontend();
+        await this.appServer.listen(this.config.port);
+    }
+
     async initializeDataServer()
     {
         let dbConfig = {
@@ -133,7 +169,7 @@ class Manager
                 user: this.config.database.user,
                 password: this.config.database.password
             },
-            rawEntities: this.rawEntities
+            rawEntities: this.rawRegisteredEntities
         };
         let DriverClass = DriversMap[this.config.database.driver];
         if(!DriverClass){
@@ -152,35 +188,58 @@ class Manager
     async initializeAdminManager()
     {
         let authenticationCallback = this.authenticationCallback;
-        if('db-users' === this.authenticationMethod){
+        if('db-users' === this.authenticationMethod && !authenticationCallback){
             authenticationCallback = async (email, password, roleId) => {
+                Logger.debug('Running default "db-users" authentication.');
                 let usersEntity = this.dataServer.getEntity('users');
                 if(!usersEntity){
+                    Logger.critical('No users entity found.');
                     return false;
                 }
                 let user = await usersEntity.loadOneBy('email', email);
                 if(!user){
+                    Logger.debug('User not found by email: '+email+'.', user);
                     return false;
                 }
                 if(Number(user.role_id) !== Number(roleId)){
+                    Logger.debug('Invalid user role ID: '+roleId+' / '+user.role_id+'.');
                     return false;
                 }
-                return Encryptor.validatePassword(password, user.password) ? user : false;
+                let passwordResult = Encryptor.validatePassword(password, user.password) ? user : false;
+                if(!passwordResult){
+                    Logger.debug('Invalid user password for: '+email+'.');
+                }
+                return passwordResult;
             };
         }
         let adminConfig = {
             events: this.events,
-            renderCallback: this.renderCallback.bind(this),
             dataServer: this.dataServer,
             authenticationCallback,
             app: this.app,
             appServerFactory: this.appServerFactory,
+            entities: this.adminEntities,
+            validator: new AdminManagerValidator(),
+            renderCallback: this.renderCallback.bind(this),
             secret: this.config.adminSecret,
             rootPath: this.config.adminPath,
-            adminRoleId: 99,
-            entities: this.entities,
-            entitiesConfig: this.entitiesConfig,
-            translations: this.entitiesTranslations
+            translations: AdminTranslations.appendTranslations(this.entitiesTranslations || {}),
+            adminFilesContents: await AdminTemplatesLoader.fetchAdminFilesContents(
+                TemplatesToPathMapper.map(this.adminTemplatesList, this.projectAdminTemplatesPath)
+            ),
+            mimeTypes: this.mimeTypes,
+            allowedExtensions: this.allowedExtensions,
+            adminRoleId: this.adminRoleId,
+            stylesFilePath: this.stylesFilePath,
+            scriptsFilePath: this.scriptsFilePath,
+            branding: {
+                companyName: this.companyName,
+                logo: this.logo,
+                favicon: this.favicon,
+                copyRight: await FileHandler.fetchFileContents(
+                    FileHandler.joinPaths(this.projectAdminTemplatesPath, this.adminTemplatesList.defaultCopyRight)
+                )
+            }
         };
         this.adminManager = new AdminManager(adminConfig);
         await this.adminManager.setupAdmin();

package/lib/mime-types.js

@@ -0,0 +1,35 @@
+/**
+ *
+ * Reldens - MimeTypes
+ *
+ */
+
+module.exports.MimeTypes = {
+    audio: [
+        'audio/aac',
+        'audio/midi',
+        'audio/x-midi',
+        'audio/mpeg',
+        'audio/ogg',
+        'application/ogg',
+        'audio/opus',
+        'audio/wav',
+        'audio/webm',
+        'audio/3gpp2'
+    ],
+    image: [
+        'image/bmp',
+        'image/gif',
+        'image/jpeg',
+        'image/png',
+        'image/svg+xml',
+        'image/vnd.microsoft.icon',
+        'image/tiff',
+        'image/webp'
+    ],
+    text: [
+        'application/json',
+        'application/ld+json',
+        'text/plain',
+    ]
+};

package/lib/templates-list.js

@@ -8,10 +8,6 @@ module.exports.TemplatesList = {
     login: 'login.html',
     dashboard: 'dashboard.html',
     management: 'management.html',
-    mapsWizard: 'maps-wizard.html',
-    mapsWizardMapsSelection: 'maps-wizard-maps-selection.html',
-    objectsImport: 'objects-import.html',
-    skillsImport: 'skills-import.html',
     list: 'list.html',
     listContent: 'list-content.html',
     view: 'view.html',
@@ -41,10 +37,5 @@ module.exports.TemplatesList = {
             button: 'button.html',
             file: 'file.html'
         }
-    },
-    sections: {
-        view: {
-            rooms: 'rooms.html'
-        }
     }
 };

package/lib/templates-to-path-mapper.js

@@ -0,0 +1,28 @@
+/**
+ *
+ * Reldens - TemplatesToPathMapper
+ *
+ */
+
+const { sc } = require('@reldens/utils');
+const { FileHandler } = require('@reldens/server-utils');
+
+class TemplatesToPathMapper
+{
+
+    map(templateList, path)
+    {
+        let result = {};
+        for(let templateName of Object.keys(templateList)){
+            if(sc.isObject(templateList[templateName])){
+                result[templateName] = this.map(templateList[templateName], FileHandler.joinPaths(path, templateName));
+                continue;
+            }
+            result[templateName] = FileHandler.joinPaths(path, templateList[templateName]);
+        }
+        return result;
+    }
+
+}
+
+module.exports.TemplatesToPathMapper = new TemplatesToPathMapper();

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@reldens/cms",
     "scope": "@reldens",
-    "version": "0.6.0",
+    "version": "0.7.0",
     "description": "Reldens - CMS",
     "author": "Damian A. Pastorini",
     "license": "MIT",
@@ -33,7 +33,7 @@
     },
     "dependencies": {
         "@reldens/server-utils": "^0.16.0",
-        "@reldens/storage": "^0.43.0",
+        "@reldens/storage": "^0.44.0",
         "@reldens/utils": "^0.47.0",
         "dotenv": "^16.5.0",
         "mustache": "^4.2.0"

package/templates/index.js.dist

@@ -13,7 +13,7 @@ let projectRoot = args[0] || process.cwd();
 
 let manager = new Manager({
     projectRoot,
-    entities: rawRegisteredEntities,
+    rawRegisteredEntities,
     entitiesConfig,
     entitiesTranslations
 });
@@ -27,6 +27,6 @@ manager.start().then((result) => {
     Logger.info('Reldens CMS started by command.');
     return true;
 }).catch((error) => {
-    Logger.error('Failed to start CMS: '+error.message);
+    Logger.critical('Failed to start CMS: '+error.message);
     process.exit();
 });

package/admin/templates/maps-wizard-maps-selection.html

@@ -1,85 +0,0 @@
-<h2>Maps Wizard</h2>
-<div class="sub-content maps-wizard">
-    <div class="sub-content-box">
-        <form class="sub-content-form maps-wizard-form confirmation-required"
-            name="maps-wizard-form"
-            id="maps-wizard-form"
-            action="{{&actionPath}}"
-            method="post"
-            enctype="multipart/form-data">
-            <input type="hidden" name="mainAction" id="mainAction" value="import"/>
-            <input type="hidden" name="generatedMapsHandler" id="generatedMapsHandler" value="{{&generatedMapsHandler}}"/>
-            <input type="hidden" name="importAssociationsForChangePoints" id="importAssociationsForChangePoints" value="{{&importAssociationsForChangePoints}}"/>
-            <input type="hidden" name="importAssociationsRecursively" id="importAssociationsRecursively" value="{{&importAssociationsRecursively}}"/>
-            <input type="hidden" name="automaticallyExtrudeMaps" id="automaticallyExtrudeMaps" value="{{&automaticallyExtrudeMaps}}"/>
-            <input type="hidden" name="verifyTilesetImage" id="verifyTilesetImage" value="{{&verifyTilesetImage}}"/>
-            <input type="hidden" name="handlerParams" id="handlerParams" value="{{handlerParams}}"/>
-            <div class="main-action-container maps-selection">
-                <h3>Select the maps to be imported</h3>
-                <p>Notes:<p>
-                <p>
-                    - The Game Server requires a reboot in order to make the maps available on the game.<br/>
-                    - If you refresh the page you will get a new set of random maps generated.<br/>
-                    - Generated sub-maps will be automatically imported, if you don't want to import those you can download all the related maps (the main map and the sub-map) and edit change them to your needs.<br/>
-                </p>
-                <ul class="wizard-options-container">
-                {{#maps}}
-                    <li class="wizard-map-option-container">
-                        <div class="selector-box">
-                            <input class="map-wizard-option" type="checkbox" name="selectedMaps[]" id="maps-wizard-map-option-{{&key}}" value="{{&key}}"/>
-                            <input type="hidden" name="map-title-{{&key}}" id="map-title-{{&key}}" value="{{&key}}"/>
-                            <label class="main-option" for="maps-wizard-map-option-{{&key}}">
-                                {{&key}}
-                            </label>
-                            <p>Downloads:</p>
-                            <p>
-                                - <a href="{{&mapJson}}" target="_blank">{{&mapJson}}</a><br/>
-                                - <a href="{{&mapImage}}" target="_blank">{{&mapImage}}</a>
-                            </p>
-                        </div>
-                        <canvas
-                            class="mapCanvas"
-                            data-toggle="modal"
-                            width="{{&mapWidth}}"
-                            height="{{&mapHeight}}"
-                            data-tile-width="{{&tileWidth}}"
-                            data-tile-height="{{&tileHeight}}"
-                            data-image-key="{{&mapImage}}"
-                            data-map-json="{{&mapJson}}">
-                        </canvas>
-                        {{#hasSubMaps}}
-                            <div class="sub-maps">
-                                <p class="sub-map-option-description clickable" data-expand-collapse=".sub-maps-container-{{&key}}">
-                                    <img class="icon-sm" src="/assets/admin/filters.png" alt="Associated maps"/>
-                                    <span>Associated maps generated</span>
-                                </p>
-                                <div class="sub-maps-container sub-maps-container-{{&key}} hidden">
-                                    {{#subMaps}}
-                                        <p>{{&key}}</p>
-                                        <p>Downloads:</p>
-                                        <p>
-                                            - <a href="{{&mapJson}}" target="_blank">{{&mapJson}}</a><br/>
-                                            - <a href="{{&mapImage}}" target="_blank">{{&mapImage}}</a>
-                                        </p>
-                                        <canvas
-                                            class="mapCanvas"
-                                            data-toggle="modal"
-                                            width="{{&mapWidth}}"
-                                            height="{{&mapHeight}}"
-                                            data-tile-width="{{&tileWidth}}"
-                                            data-tile-height="{{&tileHeight}}"
-                                            data-image-key="{{&mapImage}}"
-                                            data-map-json="{{&mapJson}}">
-                                        </canvas>
-                                    {{/subMaps}}
-                                </div>
-                            </div>
-                        {{/hasSubMaps}}
-                    </li>
-                {{/maps}}
-                </ul>
-            </div>
-            <input type="submit" class="button button-primary button-maps-wizard" value="Import Selected Maps"/>
-        </form>
-    </div>
-</div>