@silexlabs/silex 3.7.0 → 3.9.0-canary.2

package/dist/{plugins/server/plugins/server → server/server/plugins}/FtpConnector.js

@@ -1,34 +1,16 @@
 "use strict";
-/*
- * Silex website builder, free/libre no-code tool for makers.
- * Copyright (c) 2023 lexoyo and Silex Labs foundation
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <https://www.gnu.org/licenses/>.
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 const basic_ftp_1 = require("basic-ftp");
-const connectors_1 = require("../../server/connectors/connectors");
-const validation_1 = require("../../server/utils/validation");
-const constants_1 = require("../../constants");
-const types_1 = require("../../types");
+const connectors_js_1 = require("../connectors/connectors.js");
+const validation_js_1 = require("../utils/validation.js");
+const constants_js_1 = require("../../common/constants.js");
+const types_js_1 = require("../../common/types.js");
 const path_1 = require("path");
 const os_1 = require("os");
 const uuid_1 = require("uuid");
 const promises_1 = require("fs/promises");
 const fs_1 = require("fs");
-const websiteDataSerialization_1 = require("../../server/utils/websiteDataSerialization");
-// **
-// Utils methos
+const websiteDataSerialization_js_1 = require("../utils/websiteDataSerialization.js");
 function formHtml(redirectTo, type, { host, user, pass, port, secure, storageRootPath, publicationPath, websiteUrl }, err = '') {
     return `
     ${err && `<div class="error">${err || ''}</div>`}
@@ -45,7 +27,7 @@ function formHtml(redirectTo, type, { host, user, pass, port, secure, storageRoo
         <input class="checkbox" type="checkbox" name="secure" value="true" ${secure ? 'checked' : ''} />
         <label for="secure">Secure</label>
       </div>
-      ${type === types_1.ConnectorType.STORAGE ? `
+      ${type === types_js_1.ConnectorType.STORAGE ? `
       <details>
         <summary>Storage options</summary>
         <p>If you are not sure, don't change this</p>
@@ -53,7 +35,7 @@ function formHtml(redirectTo, type, { host, user, pass, port, secure, storageRoo
         <input placeholder="/silex/" type="text" name="storageRootPath" value="${storageRootPath || '/silex/'}" />
       </details>
       ` : ''}
-      ${type === types_1.ConnectorType.HOSTING ? `
+      ${type === types_js_1.ConnectorType.HOSTING ? `
       <fieldset>
         <legend>Publication options</legend>
         <label for="publicationPath">Path where to publish</label>
@@ -177,11 +159,6 @@ details > p {
   margin-top: 10px;
 }
 `;
-/**
- * @class FtpConnector
- * @implements {HostingConnector}
- * @implements {StorageConnector}
- */
 class FtpConnector {
     connectorId = 'ftp';
     displayName = 'Ftp';
@@ -201,26 +178,22 @@ class FtpConnector {
         };
         if (!this.options.type)
             throw new Error('missing type in option of FtpConnector');
-        this.connectorType = (0, connectors_1.toConnectorEnum)(this.options.type);
+        this.connectorType = (0, connectors_js_1.toConnectorEnum)(this.options.type);
     }
-    // **
-    // Utils
     sessionData(session) {
         return session[`ftp-${this.options.type}`] ?? {};
     }
     rootPath(session) {
-        return this.connectorType === types_1.ConnectorType.STORAGE ?
-            (0, validation_1.requiredParam)(this.sessionData(session).storageRootPath, 'storage root path') :
-            (0, validation_1.requiredParam)(this.sessionData(session).publicationPath, 'publication path');
+        return this.connectorType === types_js_1.ConnectorType.STORAGE ?
+            (0, validation_js_1.requiredParam)(this.sessionData(session).storageRootPath, 'storage root path') :
+            (0, validation_js_1.requiredParam)(this.sessionData(session).publicationPath, 'publication path');
     }
-    // **
-    // FTP methods
     async write(ftp, path, content, progress) {
         ftp.trackProgress(info => {
             progress && progress(`Uploading ${info.bytes / 1000} KB}`);
         });
         progress && progress('Upload started');
-        await ftp.uploadFrom((0, connectors_1.contentToReadable)(content), path);
+        await ftp.uploadFrom((0, connectors_js_1.contentToReadable)(content), path);
         progress && progress('Upload complete');
     }
     async read(ftp, path) {
@@ -271,13 +244,9 @@ class FtpConnector {
             console.warn('ftp already closed');
         }
     }
-    // **
-    // Connector interface
     getOptions(formData) {
         return {
-            // Storage
             storageRootPath: formData['storageRootPath'],
-            // Hosting
             publicationPath: formData['publicationPath'],
             websiteUrl: formData['websiteUrl'],
         };
@@ -294,18 +263,14 @@ class FtpConnector {
     }
     async getSettingsForm(session, redirectTo) { return null; }
     async setToken(session, token) {
-        // Check all required params are present
         const { host, user, pass, port, secure = false, publicationPath, storageRootPath, websiteUrl } = token;
-        (0, validation_1.requiredParam)(session, 'session');
-        (0, validation_1.requiredParam)(host, 'host');
-        (0, validation_1.requiredParam)(user, 'user');
-        (0, validation_1.requiredParam)(pass, 'pass');
-        (0, validation_1.requiredParam)(port, 'port');
-        // Check if the connection is valid
+        (0, validation_js_1.requiredParam)(session, 'session');
+        (0, validation_js_1.requiredParam)(host, 'host');
+        (0, validation_js_1.requiredParam)(user, 'user');
+        (0, validation_js_1.requiredParam)(pass, 'pass');
+        (0, validation_js_1.requiredParam)(port, 'port');
         const ftp = await this.getClient({ host, user, pass, port, secure });
-        // Save the token
         session[`ftp-${this.connectorType}`] = { host, user, pass, port, secure, publicationPath, storageRootPath, websiteUrl };
-        // Clean up
         this.closeClient(ftp);
     }
     async logout(session) {
@@ -315,7 +280,7 @@ class FtpConnector {
         return {
             name: this.sessionData(session).user,
             picture: 'data:image/svg+xml,%3Csvg xmlns=\'http://www.w3.org/2000/svg\' height=\'1em\' viewBox=\'0 0 448 512\'%3E%3C!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2023 Fonticons, Inc. --%3E%3Cpath d=\'M224 256A128 128 0 1 0 224 0a128 128 0 1 0 0 256zm-45.7 48C79.8 304 0 383.8 0 482.3C0 498.7 13.3 512 29.7 512H418.3c16.4 0 29.7-13.3 29.7-29.7C448 383.8 368.2 304 269.7 304H178.3z\'/%3E%3C/svg%3E',
-            storage: await (0, connectors_1.toConnectorData)(session, this)
+            storage: await (0, connectors_js_1.toConnectorData)(session, this)
         };
     }
     async isLoggedIn(session) {
@@ -332,23 +297,21 @@ class FtpConnector {
         }
     }
     async setWebsiteMeta(session, id, data) {
-        const websiteId = (0, validation_1.requiredParam)(id, 'website id');
-        const path = (0, path_1.join)(this.rootPath(session), websiteId, constants_1.WEBSITE_META_DATA_FILE);
+        const websiteId = (0, validation_js_1.requiredParam)(id, 'website id');
+        const path = (0, path_1.join)(this.rootPath(session), websiteId, constants_js_1.WEBSITE_META_DATA_FILE);
         const ftp = await this.getClient(this.sessionData(session));
-        await this.write(ftp, path, (0, websiteDataSerialization_1.stringify)(data));
+        await this.write(ftp, path, (0, websiteDataSerialization_js_1.stringify)(data));
         this.closeClient(ftp);
     }
     async getWebsiteMeta(session, id) {
         try {
-            const websiteId = (0, validation_1.requiredParam)(id, 'website id');
+            const websiteId = (0, validation_js_1.requiredParam)(id, 'website id');
             const ftp = await this.getClient(this.sessionData(session));
-            // Get stats for the website folder
             const folder = (0, path_1.join)(this.rootPath(session), websiteId);
-            const path = (0, path_1.join)(this.rootPath(session), websiteId, constants_1.WEBSITE_META_DATA_FILE);
+            const path = (0, path_1.join)(this.rootPath(session), websiteId, constants_js_1.WEBSITE_META_DATA_FILE);
             const readable = await this.read(ftp, path);
-            const meta = JSON.parse(await (0, connectors_1.contentToString)(readable));
+            const meta = JSON.parse(await (0, connectors_js_1.contentToString)(readable));
             this.closeClient(ftp);
-            // Return all meta
             return {
                 websiteId,
                 ...meta,
@@ -359,31 +322,16 @@ class FtpConnector {
             throw err;
         }
     }
-    // **
-    // Storage interface
-    /**
-     * Create necessary folders
-     * Assets and root folders
-     */
     async createWebsite(session) {
         const ftp = await this.getClient(this.sessionData(session));
-        // Generate a random id
         const id = (0, uuid_1.v4)();
-        // // create root folder
-        // const rootPath = join(this.storageRootPath(session), id)
-        // await this.mkdir(ftp, rootPath)
-        // create assets folder
         const assetsPath = (0, path_1.join)(this.rootPath(session), id, '/assets');
         await this.mkdir(ftp, assetsPath);
-        // create website data file
-        const websiteDataPath = (0, path_1.join)(this.rootPath(session), id, constants_1.WEBSITE_DATA_FILE);
-        await this.write(ftp, websiteDataPath, (0, websiteDataSerialization_1.stringify)(types_1.EMPTY_WEBSITE));
-        // create website meta data file
-        const websiteMetaDataPath = (0, path_1.join)(this.rootPath(session), id, constants_1.WEBSITE_META_DATA_FILE);
-        await this.write(ftp, websiteMetaDataPath, (0, websiteDataSerialization_1.stringify)({}));
-        // Clean up
+        const websiteDataPath = (0, path_1.join)(this.rootPath(session), id, constants_js_1.WEBSITE_DATA_FILE);
+        await this.write(ftp, websiteDataPath, (0, websiteDataSerialization_js_1.stringify)(types_js_1.EMPTY_WEBSITE));
+        const websiteMetaDataPath = (0, path_1.join)(this.rootPath(session), id, constants_js_1.WEBSITE_META_DATA_FILE);
+        await this.write(ftp, websiteMetaDataPath, (0, websiteDataSerialization_js_1.stringify)({}));
         this.closeClient(ftp);
-        // All good
         return id;
     }
     async listWebsites(session) {
@@ -401,19 +349,17 @@ class FtpConnector {
     async readWebsite(session, websiteId) {
         const storageRootPath = this.rootPath(session);
         const ftp = await this.getClient(this.sessionData(session));
-        const websiteDataPath = (0, path_1.join)(storageRootPath, websiteId, constants_1.WEBSITE_DATA_FILE);
+        const websiteDataPath = (0, path_1.join)(storageRootPath, websiteId, constants_js_1.WEBSITE_DATA_FILE);
         try {
             const websiteDataStream = await this.read(ftp, websiteDataPath);
-            const websiteDataContent = await (0, connectors_1.contentToString)(websiteDataStream);
-            // Check if this is the new split format by trying to parse
+            const websiteDataContent = await (0, connectors_js_1.contentToString)(websiteDataStream);
             const parsedData = JSON.parse(websiteDataContent);
-            // Use the merge function to reconstruct website data
             const pageLoader = async (pagePath) => {
                 const fullPath = (0, path_1.join)(storageRootPath, websiteId, pagePath);
                 const pageStream = await this.read(ftp, fullPath);
-                return await (0, connectors_1.contentToString)(pageStream);
+                return await (0, connectors_js_1.contentToString)(pageStream);
             };
-            const result = await (0, websiteDataSerialization_1.merge)(websiteDataContent, pageLoader);
+            const result = await (0, websiteDataSerialization_js_1.merge)(websiteDataContent, pageLoader);
             this.closeClient(ftp);
             return result;
         }
@@ -425,12 +371,8 @@ class FtpConnector {
     async updateWebsite(session, websiteId, data) {
         const storageRootPath = this.rootPath(session);
         const ftp = await this.getClient(this.sessionData(session));
-        // Use the split function to create separate files for pages
-        const filesToWrite = (0, websiteDataSerialization_1.split)(data);
-        // Get the pages folder path from website data
-        const pagesFolder = (0, websiteDataSerialization_1.getPagesFolder)(data);
-        // **
-        // Delete pages that are not in the new website data
+        const filesToWrite = (0, websiteDataSerialization_js_1.split)(data);
+        const pagesFolder = (0, websiteDataSerialization_js_1.getPagesFolder)(data);
         const pagesPath = (0, path_1.join)(storageRootPath, websiteId, pagesFolder);
         try {
             const existingPageFiles = await this.readdir(ftp, pagesPath);
@@ -444,9 +386,7 @@ class FtpConnector {
             }
         }
         catch (error) {
-            // Ignore error if pages directory doesn't exist yet
         }
-        // Ensure the pages directory exists before writing page files
         const hasPageFiles = filesToWrite.some(f => f.path.startsWith(pagesFolder));
         if (hasPageFiles) {
             await this.mkdir(ftp, pagesPath);
@@ -479,49 +419,42 @@ class FtpConnector {
         return this.writeFile(session, id, files, this.options.assetsFolder, statusCbk);
     }
     async writeFile(session, id, files, relativePath, statusCbk) {
-        // Connect to FTP server
         statusCbk && statusCbk({
             message: 'Connecting to FTP server',
-            status: types_1.JobStatus.IN_PROGRESS,
+            status: types_js_1.JobStatus.IN_PROGRESS,
         });
         const ftp = await this.getClient(this.sessionData(session));
         const rootPath = this.rootPath(session);
-        // Make sure that root folder exists
         statusCbk && statusCbk({
             message: 'Making sure that root folder exists',
-            status: types_1.JobStatus.IN_PROGRESS,
+            status: types_js_1.JobStatus.IN_PROGRESS,
         });
-        // Useless as ftp write will create the folder
-        // await this.mkdir(ftp, rootPath)
-        // Write files
         let lastFile;
         try {
-            // Sequentially write files
             for (const file of files) {
                 statusCbk && statusCbk({
                     message: `Writing file ${file.path}`,
-                    status: types_1.JobStatus.IN_PROGRESS,
+                    status: types_js_1.JobStatus.IN_PROGRESS,
                 });
                 const dstPath = (0, path_1.join)(this.options.path, rootPath, id, relativePath, file.path);
                 lastFile = file;
                 const result = await this.write(ftp, dstPath, file.content, message => {
                     statusCbk && statusCbk({
                         message: `Writing file ${file.path.split('/').pop()} to ${dstPath.split('/').slice(0, -1).join('/')}: ${message}`,
-                        status: types_1.JobStatus.IN_PROGRESS,
+                        status: types_js_1.JobStatus.IN_PROGRESS,
                     });
                 });
             }
             this.closeClient(ftp);
             statusCbk && statusCbk({
                 message: `Finished writing ${files.length} files to ${rootPath}`,
-                status: types_1.JobStatus.SUCCESS,
+                status: types_js_1.JobStatus.SUCCESS,
             });
         }
         catch (err) {
-            // Not sure why it never gets here
             statusCbk && statusCbk({
                 message: `Error writing file ${lastFile?.path}: ${err.message}`,
-                status: types_1.JobStatus.ERROR,
+                status: types_js_1.JobStatus.ERROR,
             });
             this.closeClient(ftp);
         }
@@ -542,10 +475,7 @@ class FtpConnector {
         await Promise.all(paths.map((path) => this.unlink(ftp, (0, path_1.join)(this.options.path, storageRootPath, id, this.options.assetsFolder, path))));
         this.closeClient(ftp);
     }
-    // **
-    // Hosting interface
     async getUrl(session, id) {
-        // FIXME: do not store websiteUrl in the session, but in the website data
         console.warn('FIXME: do not store websiteUrl in the session, but in the website data');
         return this.sessionData(session).websiteUrl ?? '';
     }
@@ -553,23 +483,19 @@ class FtpConnector {
         const job = startJob(`Publishing to ${this.displayName}`);
         job.logs = [[`Publishing to ${this.displayName}`]];
         job.errors = [[]];
-        // Create folders
         const rootPath = this.rootPath(session);
         const ftp = await this.getClient(this.sessionData(session));
         await this.mkdir(ftp, rootPath);
         await this.mkdir(ftp, (0, path_1.join)(rootPath, this.options.assetsFolder));
         await this.mkdir(ftp, (0, path_1.join)(rootPath, this.options.cssFolder));
-        // Write files
-        // Do not await for the result, return the job and continue the publication in the background
         this.writeFile(session, '', files, '', async ({ status, message }) => {
-            // Update the job status
             job.status = status;
             job.message = message;
             job.logs[0].push(message);
-            if (status === types_1.JobStatus.SUCCESS) {
+            if (status === types_js_1.JobStatus.SUCCESS) {
                 jobSuccess(job.jobId, message);
             }
-            else if (status === types_1.JobStatus.ERROR) {
+            else if (status === types_js_1.JobStatus.ERROR) {
                 job.errors[0].push(message);
                 jobError(job.jobId, message);
             }
@@ -578,4 +504,3 @@ class FtpConnector {
     }
 }
 exports.default = FtpConnector;
-//# sourceMappingURL=FtpConnector.js.map