@silexlabs/silex 3.0.0-alpha.39 → 3.0.0-alpha.41

package/src/plugins/WebsitePlugin.js

@@ -1,207 +0,0 @@
-const { Router } = require('express')
-const { resolve } = require('path')
-const formidable = require('formidable')
-
-const { noCache } = require('./Cache')
-const { defaultSite } = require('../../')
-
-const EVENT_READ_START = 'EVENT_READ_START'
-const EVENT_READ_END = 'EVENT_READ_END'
-const EVENT_DELETE_START = 'EVENT_WRITE_START'
-const EVENT_DELETE_END = 'EVENT_WRITE_END'
-const EVENT_WRITE_START = 'EVENT_WRITE_START'
-const EVENT_WRITE_END = 'EVENT_WRITE_END'
-const EVENT_ASSET_READ_START = 'EVENT_ASSET_READ_START'
-const EVENT_ASSET_READ_END = 'EVENT_ASSET_READ_END'
-const EVENT_ASSET_WRITE_START = 'EVENT_ASSET_WRITE_START'
-const EVENT_ASSET_WRITE_END = 'EVENT_ASSET_WRITE_END'
-
-module.exports = async function(config, opts = {}) {
-  // Options with defaults
-  const options = {
-    // Defaults
-    backend: 'src/plugins/DefaultBackend.js',
-    // Default data for new websites
-    defaultSite,
-    // Options
-    ...opts
-  }
-
-  // Link to the desired backend
-  const backend = resolve(__dirname, '../..', options.backend)
-  const { assetsDir, assetUrl, init, writeData, readData, list, del } = require(backend)
-
-  config.on('silex:startup:start', ({app}) => {
-    const router = Router()
-
-    // website specials
-    router.get('/website', readWebsite)
-    router.post('/website', writeWebsite)
-    router.delete('/website', deleteWebsite)
-    router.get(/\/assets\/(.*)/, readAsset)
-    router.post('/assets', writeAsset)
-
-    app.use(noCache,  router)
-  })
-
-  async function readWebsite(req, res) {
-    const { id } = req.query
-    if(id) {
-      // Returns a website data
-      try {
-        config.emit(EVENT_READ_START, { req, id })
-        const data = await readData(id)
-        config.emit(EVENT_READ_END, { req, res, data, id })
-        res
-          .type('application/json')
-          .send({
-            ...options.defaultSite,
-            ...data,
-          })
-      } catch (err) {
-        if(err.code === 'ENOENT') {
-          console.error('Read file error, website does not exist', err)
-          res.status(404).json({ message: 'Read file error, website does not exist: ' + err.message, code: err.code})
-        } else {
-          console.error('Read file error', err)
-          res.status(400).json({ message: err.message, code: err.code})
-        }
-      }
-    } else {
-      // list websites
-      try {
-        config.emit(EVENT_READ_START, { req, id })
-        const data = await list()
-        config.emit(EVENT_READ_END, { req, res, data, id })
-        res
-          .type('application/json')
-          .send(data)
-      } catch (err) {
-        console.error('List sites error', err)
-        res.status(400).json({ message: err.message, code: err.code })
-      }
-    }
-  }
-
-  function fromBody(body) {
-    try {
-      return [{
-        assets: body.assets,
-        pages: body.pages,
-        files: body.files,
-        styles: body.styles,
-        settings: body.settings,
-        publication: body.publication,
-        name: body.name,
-        fonts: body.fonts,
-        symbols: body.symbols,
-      }, null]
-    } catch(err) {
-      console.error('Could not parse body data', body, err)
-      return [null, err]
-    }
-  }
-
-  async function writeWebsite(req, res) {
-    const id = req.query.id
-    const [data, err] = fromBody(req.body)
-    if(err) {
-      res.status(400).json({ message: 'Error writing data file, could not parse the provided body: ' + err.message, code: err.code})
-      return
-    }
-    config.emit(EVENT_WRITE_START, { req, id, data })
-    try {
-      await init(id)
-      await writeData(id, data)
-    } catch (err) {
-      console.error('Error writing data file', err)
-      res.status(500).json({ message: 'Error writing data file: ' + err.message, code: err.code})
-      return
-    }
-
-    config.emit(EVENT_WRITE_END, { res, req, id, data })
-
-    res.json({
-      message: 'OK',
-    })
-  }
-
-  async function deleteWebsite(req, res) {
-    const { id } = req.query
-    if(id) {
-      try {
-        config.emit(EVENT_DELETE_START, { req, id })
-        const data = await del(id)
-        config.emit(EVENT_DELETE_END, { req, res, data, id })
-        res
-          .type('application/json')
-          .send(data)
-      } catch (err) {
-        if(err.code === 'ENOENT') {
-          console.error('Delete file error, website does not exist', err)
-          res.status(404).json({ message: 'Delete file error, website does not exist: ' + err.message, code: err.code})
-        } else {
-          console.error('Delete file error', err)
-          res.status(400).json({ message: err.message, code: err.code})
-        }
-      }
-    } else {
-      // list websites
-      try {
-        config.emit(EVENT_DELETE_START, { req, id })
-        const data = await list()
-        config.emit(EVENT_DELETE_END, { req, res, data, id })
-        res
-          .type('application/json')
-          .send(data)
-      } catch (err) {
-        console.error('List sites error', err)
-        res.status(400).json({ message: err.message, code: err.code })
-      }
-    }
-  }
-
-  async function readAsset(req, res) {
-    const id = req.query.id
-    const fileName = req.params[0]
-    const uploadDir = await assetsDir(id)
-    config.emit(EVENT_ASSET_READ_START, { req, id, fileName, uploadDir })
-    res.sendFile(`${uploadDir}/${fileName}`)
-    config.emit(EVENT_ASSET_READ_END, { req, id, fileName, uploadDir })
-  }
-
-  async function writeAsset(req, res) {
-    const id = req.query.id
-    // FIXME: assetsDir and assetsUrl will both download the site settings file => get both in 1 call
-    const uploadDir = await assetsDir(id)
-
-    const form = formidable({
-      uploadDir,
-      filename: (name, ext, part, _form) => `${name}${ext}`,
-      multiples: true,
-      keepExtensions: true,
-    })
-
-    form.parse(req, async (err, fields, files) => {
-      if (err) {
-        console.error('Error parsing upload data', err)
-        res
-          .status(400)
-          .json({ message: 'Error parsing upload data: ' + err.message, code: err.code})
-        return
-      }
-      Promise.all(
-        [].concat(files['files[]']) // may be an array or 1 element
-          .map(file => {
-            const { originalFilename, filepath } = file
-            return assetUrl(id, originalFilename)
-          })
-      )
-        .then(data => {
-          config.emit(EVENT_ASSET_WRITE_START, { req, id, uploadDir, form, data })
-          res.json({ data })
-          config.emit(EVENT_ASSET_WRITE_END, { res, req, id, uploadDir, form, data })
-        })
-    })
-  }
-}

package/src/ts/client/grapesjs/publish.ts

@@ -1,403 +0,0 @@
-/*
- * 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/>.
- */
-
-import {html, render} from 'lit-html'
-import {map} from 'lit-html/directives/map.js'
-import grapesjs from 'grapesjs/dist/grapes.min.js'
-import { getPageSlug } from '../../page'
-import { onAll } from '../utils'
-
-// constants
-const pluginName = 'publish'
-export const cmdPublish = 'publish-open-dialog'
-let _token = null
-let id
-let rootUrl
-
-// plugin code
-export const publishPlugin = grapesjs.plugins.add(pluginName, (editor, opts) => {
-  opts = {
-    appendTo: 'options',
-    ...opts,
-  }
-  // Global config
-  rootUrl = opts.rootUrl
-  id = opts.id
-  // Keep track of the token
-  editor.on('login:success', async ({ getUser, getToken }) => {
-    _token = await getToken()
-  })
-  // add publication settings to the website
-  editor.on('storage:start:store', (data) => {
-    data.publication = editor.getModel().get('publication')
-  })
-  editor.on('storage:end:load', (data) => {
-    const model = editor.getModel()
-    model.set('publication', data.publication || {})
-  })
-  editor.Panels.addButton(opts.appendTo, {
-    id: 'publish-button',
-    className: 'silex-button--size publish-button',
-    command: cmdPublish,
-    attributes: { title: 'Publish' },
-    label: '<span class="fa fa-rocket"></span><span class="silex-button--small">Publish</span>',
-  })
-  editor.Commands.add(cmdPublish, {
-    run(editor) { openDialog(editor) },
-    stop(editor) { closeDialog(editor) },
-  })
-})
-
-export function getDialogElements() {
-  const el = document.querySelector('#publish-dialog')
-  return el ? {
-    dialog: el,
-    primary: el.querySelector('#publish-button--primary'),
-    secondary: el.querySelector('#publish-button--secondary'),
-  } : null
-}
-function createDialogElements() {
-  const el = document.createElement('div')
-  el.id = 'publish-dialog'
-  el.className = 'silex-dialog-inline silex-dialog gjs-two-color'
-  document.body.append(el)
-  return getDialogElements()
-}
-function move(rect) {
-  Object.keys(rect).forEach(key => dialog.style[key] = rect[key] + 'px')
-}
-function update(editor) {
-  render(html`
-    ${ open ? html`
-      <main>
-        ${ status === STATUS_PENDING ? html`
-          <p>Publication in progress</p>
-        ` : ''}
-        ${ status === STATUS_SUCCESS ? html`
-          <p>Publication success</p>
-          ${ url ? html`<a href="${url}" target="_blank">Click here to view the published website</a>` : ''}
-        ` : ''}
-        ${ status === STATUS_ERROR ? html`
-          <p>Publication error</p>
-          <div>${ errorMessage }</div>
-        ` : ''}
-        ${ state?.running ? html`
-          <progress
-            value=""
-            style="width: 100%;"
-          ></progress>
-        ` : ''}
-        ${ state.logs?.length ? html`
-          <details>
-            <summary>Logs</summary>
-            <pre style="
-              max-width: 100%;
-              max-height: 50vh;
-              overflow: auto;
-              font-size: x-small;
-              "
-            >${ cleanup(state.logs) }
-            </pre>
-          </details>
-        ` : '' }
-        ${ state.errors?.length ? html`
-          <details>
-            <summary>Errors</summary>
-            <pre style="
-              max-width: 100%;
-              max-height: 50vh;
-              overflow: auto;
-              font-size: x-small;
-              "
-            >${ cleanup(state.errors) }
-            </pre>
-          </details>
-        ` : '' }
-      </main>
-      <footer>
-        ${ status === STATUS_PENDING ? '' : html`
-          <button
-            class="silex-button silex-button--primary"
-            id="publish-button--primary"
-            @click=${() => startPublication(editor)}
-          >Publish</button>
-        `}
-        <button
-          class="silex-button silex-button--secondary"
-          id="publish-button--secondary"
-          @click=${() => editor.Commands.stop(cmdPublish)}
-        >Close</button>
-      </footer>
-    ` : ''}
-  `, dialog)
-  if(open) {
-    dialog.classList.remove('silex-dialog-hide')
-  } else {
-    dialog.classList.add('silex-dialog-hide')
-  }
-}
-export const STATUS_NONE='STATUS_NONE'
-export const STATUS_PENDING='STATUS_PENDING'
-export const STATUS_ERROR='STATUS_ERROR'
-export const STATUS_SUCCESS='STATUS_SUCCESS'
-export let status = STATUS_NONE
-export let open = false
-let errorMessage = ''
-let dialog
-let url // from the result of the first fetch when publishing
-let state = {
-  queued: false,
-  error: false,
-  running: false,
-  logs: [],
-  errors: [],
-}
-
-function cleanup(arr: string[][]): string {
-  return arr[arr.length-1]
-    ?.map(str => str.replace(/\[.*\]/g, '').trim())
-    ?.filter(str => !!str)
-    ?.join('\n')
-}
-
-function displayError(editor, message) {
-  console.error(message)
-  errorMessage = message
-  status = STATUS_ERROR
-  update(editor)
-}
-export async function closeDialog(editor) {
-  open = false
-  update(editor)
-}
-export async function toggleDialog(editor) {
-  if(open) closeDialog(editor)
-  else openDialog(editor)
-}
-export async function openDialog(editor) {
-  open = true
-
-  // Position
-  const buttonEl = editor.Panels.getPanel('options').view.el
-    .querySelector('.publish-button')
-  const rect = buttonEl.getBoundingClientRect()
-
-  const width = 450
-  const padding = 10 * 2
-  const minHeight = 50
-  if(!dialog) dialog = createDialogElements().dialog
-  move({
-    left: rect.right - width - padding,
-    top: rect.bottom + 10,
-    width,
-    minHeight,
-  })
-
-  // Publication
-  if(status === STATUS_NONE) {
-    startPublication(editor)
-  } else {
-    update(editor)
-  }
-}
-export async function startPublication(editor) {
-  if(status === STATUS_PENDING) throw new Error('Publication is already in progress')
-  status = STATUS_PENDING
-  update(editor)
-  editor.trigger('publish:before')
-  const projectData = editor.getProjectData()
-  const siteSettings = editor.getModel().get('settings')
-  const publicationSettings = editor.getModel().get('publication')
-  // Update assets URL to display outside the editor
-  const assetsFolderUrl = publicationSettings?.assets?.url
-  if(assetsFolderUrl) {
-    const publishedUrl = path => `${assetsFolderUrl}/${path.split('/').pop()}`
-    // New URLs for assets, according to site config
-    onAll(editor, c => {
-      // Attributes
-      if(c.get('type') === 'image') {
-        const path = c.get('src')
-        c.set('tmp-src', path)
-        c.set('src', publishedUrl(path))
-      }
-      //// Inline styles
-      //// This is handled by the editor.Css.getAll loop
-      //const bgUrl = c.getStyle()['background-image']?.match(/url\('(.*)'\)/)?.pop()
-      //if(bgUrl) {
-      //  c.set('tmp-bg-url', bgUrl)
-      //  c.setStyle({
-      //    ...c.getStyle(),
-      //    'background-image': `url('${publishedUrl(bgUrl)}')`,
-      //  })
-      //}
-    })
-    editor.Css.getAll()
-      .forEach(c => {
-        const bgUrl = c.getStyle()['background-image']?.match(/url\('(.*)'\)/)?.pop()
-        if(bgUrl) {
-          c.setStyle({
-            ...c.getStyle(),
-            'background-image': `url('${publishedUrl(bgUrl)}')`,
-          })
-          c.set('tmp-bg-url-css', bgUrl)
-        }
-      })
-  }
-  // Build the files structure
-  const files = await getFiles(editor, {siteSettings, publicationSettings})
-
-  // Create the data to send to the server
-  const data = {
-    ...projectData,
-    settings: siteSettings,
-    publication: publicationSettings,
-    id,
-    files,
-  }
-  // Reset asset URLs
-  if(assetsFolderUrl) {
-    onAll(editor, c => {
-      if(c.get('type') === 'image' && c.has('tmp-src')) {
-        c.set('src', c.get('tmp-src'))
-        c.set('tmp-src')
-      }
-      //// This is handled by the editor.Css.getAll loop
-      //if(c.getStyle()['background-image'] && c.has('tmp-bg-url')) {
-      //  c.setStyle({
-      //    ...c.getStyle(),
-      //    'background-image': `url('${c.get('tmp-bg-url')}')`,
-      //  })
-      //  c.set('tmp-bg-url')
-      //}
-    })
-    editor.Css.getAll()
-      .forEach(c => {
-        if(c.has('tmp-bg-url-css')) {
-          c.setStyle({
-            ...c.getStyle(),
-            'background-image': `url('${c.get('tmp-bg-url-css')}')`,
-          })
-          c.set('tmp-bg-url-css')
-        }
-      })
-  }
-  editor.trigger('publish:start', data)
-  let res
-  let json
-  try {
-    res = await fetch(`${ rootUrl }publish`, {
-      method: 'POST',
-      body: JSON.stringify({
-        data,
-        token: _token,
-      }),
-      headers: {
-        'Content-Type': 'application/json'
-      },
-    })
-  } catch(e) {
-    displayError(editor, `An error occured, your site is not published. ${e.message}`)
-    editor.trigger('publish:stop', {success: false, message: e.message})
-    return
-  }
-  try {
-    json = await res.json()
-  } catch(e) {
-    displayError(editor, `Could not parse the server response, your site may be published. ${e.message}`)
-    editor.trigger('publish:stop', {success: false, message: e.message})
-    return
-  }
-  if(!res.ok) {
-    displayError(editor, `An network error occured, your site is not published. ${json.message}`)
-    editor.trigger('publish:stop', {success: false, message: json.message})
-    return
-  }
-  url = json.url
-  if(json.statusUrl) {
-    trackProgress(editor, json.statusUrl)
-  } else {
-    status = STATUS_SUCCESS
-    update(editor)
-    editor.trigger('publish:stop', {success: true})
-  }
-}
-
-async function getFiles(editor, {siteSettings, publicationSettings, }) {
-  return editor.Pages.getAll().map(page => {
-    const pageSettings = page.get('settings')
-    const pageName = publicationSettings?.autoHomePage !== false && page.get('type') === 'main' ? 'index' : (page.get('name') || page.get('type'))
-    function getSetting(name) {
-      return (pageSettings || {})[name] || (siteSettings || [])[name] || ''
-    }
-    const component = page.getMainComponent()
-    const slug = getPageSlug(pageName)
-    return {
-      html: `
-      <!DOCTYPE html>
-      <html lang="${ getSetting('lang') }">
-      <head>
-      <link rel="stylesheet" href="${publicationSettings?.css?.url || ''}/${slug}.css" />
-      ${ siteSettings?.head || '' }
-      ${ pageSettings?.head || '' }
-      <title>${ getSetting('title') }</title>
-      <link rel="icon" href="${ getSetting('favicon') }" />
-      ${
-  ['description', 'og:title', 'og:description', 'og:image']
-    .map(prop => `<meta property="${ prop }" content="${ getSetting(prop) }"/>`)
-    .join('\n')
-}
-      </head>
-      ${ editor.getHtml({ component }) }
-      </html>
-      `,
-      css: editor.getCss({ component }),
-      cssPath: `${ publicationSettings?.css?.path || '' }/${slug}${publicationSettings?.css?.ext || '.css'}`,
-      htmlPath: `${ publicationSettings?.html?.path || '' }/${slug}${publicationSettings?.html?.ext || '.html'}`,
-    }
-  })
-}
-
-export async function trackProgress(editor, statusUrl) {
-  let res
-  let json
-  try {
-    res = await fetch(statusUrl)
-  } catch(e) {
-    displayError(editor, `An error occured, your site is not published. ${e.message}`)
-    editor.trigger('publish:stop', {success: false, message: e.message})
-    return
-  }
-  try {
-    state = await res.json()
-  } catch(e) {
-    displayError(editor, `Could not parse the server response, your site may be published. ${e.message}`)
-    editor.trigger('publish:stop', {success: false, message: e.message})
-    return
-  }
-  if(!res.ok) {
-    displayError(editor, `An network error occured, your site is not published. ${res.statusText}`)
-    editor.trigger('publish:stop', {success: false, message: `An network error occured, your site is not published. ${res.statusText}`})
-    return
-  }
-  if(state.running) {
-    setTimeout(() => trackProgress(editor, statusUrl), 2000)
-  } else {
-    status = state.error ? STATUS_ERROR : STATUS_SUCCESS
-    editor.trigger('publish:stop', {success: state.error})
-  }
-  update(editor)
-}