@silexlabs/silex 3.0.1-0 → 3.0.1

package/src/ts/plugins/server/FtpConnector.ts

@@ -16,16 +16,18 @@
  */
 
 import { Client } from 'basic-ftp'
-import { PassThrough, Readable, Writable } from 'stream'
+import { Readable } from 'stream'
 import { ConnectorFile, ConnectorFileContent, HostingConnector, StatusCallback, StorageConnector, contentToReadable, contentToString, toConnectorData, toConnectorEnum} from '../../server/connectors/connectors'
 import { requiredParam } from '../../server/utils/validation'
 import { WEBSITE_DATA_FILE, WEBSITE_META_DATA_FILE } from '../../constants'
 import { ConnectorType, ConnectorUser, WebsiteMeta, FileMeta, JobData, JobStatus, WebsiteId, PublicationJobData, WebsiteMetaFileContent, defaultWebsiteData, WebsiteData, ConnectorOptions } from '../../types'
-import { jobError, jobSuccess, startJob } from '../../server/jobs'
 import { ServerConfig } from '../../server/config'
 import { join } from 'path'
-import { type } from 'os'
+import { tmpdir } from 'os'
 import { v4 as uuid } from 'uuid'
+import { JobManager } from '../../server/jobs'
+import { mkdtemp, rm, rmdir } from 'fs/promises'
+import { createReadStream } from 'fs'
 
 /**
  * @fileoverview FTP connector for Silex
@@ -64,6 +66,7 @@ export interface FtpOptions {
   type: ConnectorType
   path: string
   assetsFolder: string
+  cssFolder: string // For publication only
   authorizeUrl: string
   authorizePath: string
 }
@@ -228,7 +231,7 @@ details > p {
 export default class FtpConnector implements StorageConnector<FtpSession> {
   connectorId = 'ftp'
   displayName = 'Ftp'
-  icon = 'ftp'
+  icon = '/assets/ftp.png'
   options: FtpOptions
   connectorType: ConnectorType
   color = '#ffffff'
@@ -238,8 +241,9 @@ export default class FtpConnector implements StorageConnector<FtpSession> {
     this.options = {
       path: '',
       assetsFolder: 'assets',
-      authorizeUrl: '/api/authorize/ftp/',
-      authorizePath: '/api/authorize/ftp/',
+      cssFolder: 'css',
+      authorizeUrl: './api/authorize/ftp/',
+      authorizePath: './api/authorize/ftp/',
       ...opts,
     } as FtpOptions
     if(!this.options.type) throw new Error('missing type in option of FtpConnector')
@@ -270,9 +274,13 @@ export default class FtpConnector implements StorageConnector<FtpSession> {
   }
 
   private async read(ftp: Client, path: string): Promise<Readable> {
-    const stream = new PassThrough()
-    await ftp.downloadTo(stream, path)
-    return stream
+    const tempDir = await mkdtemp(join(tmpdir(), 'silex-tmp'))
+    const tempPath = join(tempDir, 'silex-ftp.tmp')
+    await ftp.downloadTo(tempPath, path)
+    const rStream = createReadStream(tempPath)
+    await rm(tempPath)
+    await rmdir(tempDir)
+    return rStream
   }
 
   private async readdir(ftp: Client, path: string): Promise<FileMeta[]> {
@@ -335,7 +343,6 @@ export default class FtpConnector implements StorageConnector<FtpSession> {
 
   async getLoginForm(session: FtpSession, redirectTo: string): Promise<string | null> {
     const { host, user, pass, port, secure, publicationPath, storageRootPath, websiteUrl } = this.sessionData(session)
-    requiredParam(type, 'connector type')
     return `
         <style>
           ${formCss}
@@ -370,7 +377,7 @@ export default class FtpConnector implements StorageConnector<FtpSession> {
   async getUser(session: FtpSession): Promise<ConnectorUser> {
     return {
       name: this.sessionData(session).user,
-      picture: 'data://image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAA',
+      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 toConnectorData(session, this)
     }
   }
@@ -402,8 +409,6 @@ export default class FtpConnector implements StorageConnector<FtpSession> {
       const ftp = await this.getClient(this.sessionData(session))
       // Get stats for the website folder
       const folder = join(this.rootPath(session), websiteId)
-      const lastMod = await ftp.lastMod(folder)
-      // Read the meta data file to get the meta data set by the user
       const path = join(this.rootPath(session), websiteId, WEBSITE_META_DATA_FILE)
       const readable = await this.read(ftp, path)
       const meta = JSON.parse(await contentToString(readable)) as WebsiteMetaFileContent
@@ -411,9 +416,6 @@ export default class FtpConnector implements StorageConnector<FtpSession> {
       // Return all meta
       return {
         websiteId,
-        //url: await this.getFileUrl(session, websiteId, WEBSITE_DATA_FILE_NAME),
-        createdAt: lastMod,
-        updatedAt: lastMod,
         ...meta,
       }
     } catch(err) {
@@ -488,11 +490,33 @@ export default class FtpConnector implements StorageConnector<FtpSession> {
     this.closeClient(ftp)
   }
 
+  async duplicateWebsite(session: FtpSession, websiteId: string): Promise<void> {
+    const newWebsiteId = uuid()
+    const storageRootPath = this.rootPath(session)
+    const ftp = await this.getClient(this.sessionData(session))
+    const websitePath = join(storageRootPath, websiteId)
+    const newWebsitePath = join(storageRootPath, newWebsiteId)
+    const tempDir = await mkdtemp(tmpdir())
+    await ftp.downloadToDir(websitePath, tempDir)
+    await ftp.uploadFromDir(tempDir, newWebsitePath)
+    this.closeClient(ftp)
+  }
+
   async writeAssets(
     session: any,
     id: WebsiteId,
     files: ConnectorFile[],
     statusCbk?: StatusCallback,
+  ): Promise<void> {
+    return this.writeFile(session, id, files, this.options.assetsFolder, statusCbk)
+  }
+
+  async writeFile(
+    session: any,
+    id: WebsiteId,
+    files: ConnectorFile[],
+    relativePath: string,
+    statusCbk?: StatusCallback,
   ): Promise<void> {
     // Connect to FTP server
     statusCbk && statusCbk({
@@ -517,7 +541,7 @@ export default class FtpConnector implements StorageConnector<FtpSession> {
           message: `Writing file ${file.path}`,
           status: JobStatus.IN_PROGRESS,
         })
-        const dstPath = join(this.options.path, rootPath, id, this.options.assetsFolder, file.path)
+        const dstPath = join(this.options.path, rootPath, id, relativePath, file.path)
         lastFile = file
         const result = await this.write(ftp, dstPath, file.content, message => {
           statusCbk && statusCbk({
@@ -546,7 +570,7 @@ export default class FtpConnector implements StorageConnector<FtpSession> {
     const storageRootPath = this.rootPath(session)
     const ftp = await this.getClient(this.sessionData(session))
     const dirPath = join(this.options.path, storageRootPath, id, this.options.assetsFolder, path)
-    const asset = this.read(ftp, dirPath)
+    const asset = await this.read(ftp, dirPath)
     this.closeClient(ftp)
     return asset
   }
@@ -568,7 +592,7 @@ export default class FtpConnector implements StorageConnector<FtpSession> {
     return this.sessionData(session).websiteUrl ?? ''
   }
 
-  async publish(session: FtpSession, id: string, files: ConnectorFile[]): Promise<JobData> {
+  async publish(session: FtpSession, id: WebsiteId, files: ConnectorFile[], {startJob, jobSuccess, jobError}: JobManager): Promise<JobData> {
     const job = startJob(`Publishing to ${this.displayName}`) as PublicationJobData
     job.logs = [[`Publishing to ${this.displayName}`]]
     job.errors = [[]]
@@ -576,9 +600,11 @@ export default class FtpConnector implements StorageConnector<FtpSession> {
     const rootPath = this.rootPath(session)
     const ftp = await this.getClient(this.sessionData(session))
     await this.mkdir(ftp, rootPath)
-    await this.mkdir(ftp, join(rootPath, 'assets'))
+    await this.mkdir(ftp, join(rootPath, this.options.assetsFolder))
+    await this.mkdir(ftp, join(rootPath, this.options.cssFolder))
     // Write files
-    this.writeAssets(session, '', files, async ({status, message}) => {
+    // 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