alchemy_cms 7.3.4 → 7.4.0

data/app/helpers/alchemy/admin/navigation_helper.rb

@@ -11,6 +11,7 @@ module Alchemy
       #   The Hash representing a Alchemy module
       #
       def alchemy_main_navigation_entry(alchemy_module)
+        validate_controller_existence!(alchemy_module)
         render(
           "alchemy/admin/partials/main_navigation_entry",
           alchemy_module: alchemy_module,
@@ -126,7 +127,7 @@ module Alchemy
       #
       def route_from_engine_or_main_app(engine_name, url_options)
         if engine_name.present?
-          eval(engine_name).url_for(url_options) # rubocop:disable Security/Eval
+          send(engine_name).url_for(url_options)
         else
           main_app.url_for(url_options)
         end
@@ -141,6 +142,26 @@ module Alchemy
         url_options_for_navigation_entry(alchemy_module["navigation"] || {})
       end
 
+      # Validates the existence of a given controller configuration.
+      #
+      # @param String
+      #   The controller name
+      def validate_controller_existence!(definition_hash)
+        controllers = [definition_hash["navigation"]["controller"]]
+
+        if definition_hash["navigation"]["sub_navigation"].is_a?(Array)
+          controllers.concat(definition_hash["navigation"]["sub_navigation"].map { |x| x["controller"] })
+        end
+
+        controllers.each do |controller|
+          controller_const_name = "#{controller.camelize}Controller"
+          controller_const_name.constantize
+        rescue NameError
+          raise "Error in AlchemyCMS module definition: '#{definition_hash["name"]}'. Could not find the " \
+            "matching controller class #{controller_const_name} for the specified controller: '#{controller}'"
+        end
+      end
+
       # Returns a url options hash for given navigation entry.
       #
       # @param [Hash]

data/app/javascript/alchemy_admin/components/action.js

@@ -1,4 +1,5 @@
 import { reloadPreview } from "alchemy_admin/components/preview_window"
+import { closeCurrentDialog } from "alchemy_admin/dialog"
 import IngredientAnchorLink from "alchemy_admin/ingredient_anchor_link"
 
 class Action extends HTMLElement {
@@ -10,7 +11,7 @@ class Action extends HTMLElement {
       // add a intermediate closeCurrentDialog - action
       // this will be gone, if all dialogs are working with a promise and
       // we don't have to implicitly close the dialog
-      closeCurrentDialog: Alchemy.closeCurrentDialog,
+      closeCurrentDialog,
       reloadPreview,
       updateAnchorIcon: IngredientAnchorLink.updateIcon
     }

data/app/javascript/alchemy_admin/components/dialog_link.js

@@ -1,13 +1,4 @@
-export const DEFAULTS = {
-  header_height: 36,
-  size: "400x300",
-  padding: true,
-  title: "",
-  modal: true,
-  overflow: "visible",
-  ready: () => {},
-  closed: () => {}
-}
+import { Dialog } from "alchemy_admin/dialog"
 
 export class DialogLink extends HTMLAnchorElement {
   constructor() {
@@ -23,10 +14,7 @@ export class DialogLink extends HTMLAnchorElement {
   }
 
   openDialog() {
-    this.dialog = new Alchemy.Dialog(
-      this.getAttribute("href"),
-      this.dialogOptions
-    )
+    this.dialog = new Dialog(this.getAttribute("href"), this.dialogOptions)
     this.dialog.open()
   }
 
@@ -34,10 +22,7 @@ export class DialogLink extends HTMLAnchorElement {
     const options = this.dataset.dialogOptions
       ? JSON.parse(this.dataset.dialogOptions)
       : {}
-    return {
-      ...DEFAULTS,
-      ...options
-    }
+    return options
   }
 
   get disabled() {

data/app/javascript/alchemy_admin/components/element_editor.js

@@ -40,6 +40,15 @@ export class ElementEditor extends HTMLElement {
       return
     }
 
+    // When newly created, focus the element and refresh the preview
+    if (this.hasAttribute("created")) {
+      this.focusElement()
+      this.previewWindow?.refresh().then(() => {
+        this.focusElementPreview()
+      })
+      this.removeAttribute("created")
+    }
+
     // Init GUI elements
     ImageLoader.init(this)
     fileEditors(

data/app/javascript/alchemy_admin/components/elements_window.js

@@ -2,6 +2,7 @@ import SortableElements from "alchemy_admin/sortable_elements"
 
 class ElementsWindow extends HTMLElement {
   #visible = true
+  #turboFrame = null
 
   constructor() {
     super()
@@ -19,6 +20,7 @@ class ElementsWindow extends HTMLElement {
         ?.trigger("FocusElementEditor.Alchemy")
     }
     SortableElements()
+    this.resize()
   }
 
   collapseAllElements() {
@@ -38,10 +40,12 @@ class ElementsWindow extends HTMLElement {
     this.toggleButton
       .querySelector("alchemy-icon")
       .setAttribute("name", "menu-unfold")
+    this.resize()
   }
 
   hide() {
     document.body.classList.remove("elements-window-visible")
+    document.body.style.removeProperty("--elements-window-width")
     this.#visible = false
     this.toggleButton.closest("sl-tooltip").content = Alchemy.t("Show elements")
     this.toggleButton
@@ -49,6 +53,17 @@ class ElementsWindow extends HTMLElement {
       .setAttribute("name", "menu-fold")
   }
 
+  resize(width) {
+    if (width === undefined) {
+      width = this.widthFromCookie
+    }
+
+    if (width) {
+      document.body.style.setProperty("--elements-window-width", `${width}px`)
+      document.cookie = `alchemy-elements-window-width=${width}; SameSite=Lax; Path=/;`
+    }
+  }
+
   get collapseButton() {
     return this.querySelector("#collapse-all-elements-button")
   }
@@ -61,6 +76,25 @@ class ElementsWindow extends HTMLElement {
     return document.getElementById("alchemy_preview_window")
   }
 
+  get turboFrame() {
+    if (!this.#turboFrame) {
+      this.#turboFrame = this.closest("turbo-frame")
+    }
+    return this.#turboFrame
+  }
+
+  get widthFromCookie() {
+    return document.cookie
+      .split("; ")
+      .find((row) => row.startsWith("alchemy-elements-window-width="))
+      ?.split("=")[1]
+  }
+
+  set isDragged(dragged) {
+    this.turboFrame.style.transitionProperty = dragged ? "none" : null
+    this.turboFrame.style.pointerEvents = dragged ? "none" : null
+  }
+
   #attachEvents() {
     this.collapseButton?.addEventListener("click", () => {
       this.collapseAllElements()

data/app/javascript/alchemy_admin/components/elements_window_handle.js

@@ -0,0 +1,65 @@
+class ElementsWindowHandle extends HTMLElement {
+  #dragging = false
+  #elementsWindow = null
+  #previewWindow = null
+
+  constructor() {
+    super()
+
+    this.addEventListener("mousedown", this)
+    window.addEventListener("mousemove", this)
+    window.addEventListener("mouseup", this)
+  }
+
+  handleEvent(event) {
+    switch (event.type) {
+      case "mousedown":
+        event.stopPropagation()
+        this.onMouseDown()
+        break
+      case "mouseup":
+        this.onMouseUp()
+        break
+      case "mousemove":
+        if (this.#dragging) {
+          this.onDrag(event.pageX)
+        }
+        break
+    }
+  }
+
+  onMouseDown() {
+    this.#dragging = true
+    this.elementsWindow.isDragged = true
+    this.previewWindow.isDragged = true
+    this.classList.add("is-dragged")
+  }
+
+  onMouseUp() {
+    this.#dragging = false
+    this.elementsWindow.isDragged = false
+    this.previewWindow.isDragged = false
+    this.classList.remove("is-dragged")
+  }
+
+  onDrag(pageX) {
+    const elementWindowWidth = window.innerWidth - pageX
+    this.elementsWindow.resize(elementWindowWidth)
+  }
+
+  get elementsWindow() {
+    if (!this.#elementsWindow) {
+      this.#elementsWindow = document.querySelector("alchemy-elements-window")
+    }
+    return this.#elementsWindow
+  }
+
+  get previewWindow() {
+    if (!this.#previewWindow) {
+      this.#previewWindow = document.getElementById("alchemy_preview_window")
+    }
+    return this.#previewWindow
+  }
+}
+
+customElements.define("alchemy-elements-window-handle", ElementsWindowHandle)

data/app/javascript/alchemy_admin/components/icon.js

@@ -6,8 +6,8 @@ class Icon extends HTMLElement {
   constructor() {
     super()
     this.spriteUrl = document
-      .querySelector('meta[name="alchemy-icon-sprite"]')
-      .getAttribute("content")
+      .querySelector('link[rel="preload"][as="image"]')
+      .getAttribute("href")
   }
 
   connectedCallback() {

data/app/javascript/alchemy_admin/components/index.js

@@ -8,6 +8,7 @@ import "alchemy_admin/components/dialog_link"
 import "alchemy_admin/components/dom_id_select"
 import "alchemy_admin/components/element_editor"
 import "alchemy_admin/components/elements_window"
+import "alchemy_admin/components/elements_window_handle"
 import "alchemy_admin/components/list_filter"
 import "alchemy_admin/components/message"
 import "alchemy_admin/components/growl"

data/app/javascript/alchemy_admin/components/preview_window.js

@@ -1,5 +1,3 @@
-const MIN_WIDTH = 240
-
 class PreviewWindow extends HTMLIFrameElement {
   #afterLoad
   #reloadIcon
@@ -38,9 +36,6 @@ class PreviewWindow extends HTMLIFrameElement {
   }
 
   resize(width) {
-    if (width < MIN_WIDTH) {
-      width = MIN_WIDTH
-    }
     this.style.width = `${width}px`
   }
 
@@ -58,6 +53,11 @@ class PreviewWindow extends HTMLIFrameElement {
     })
   }
 
+  set isDragged(dragged) {
+    this.style.transitionProperty = dragged ? "none" : null
+    this.style.pointerEvents = dragged ? "none" : null
+  }
+
   #attachEvents() {
     this.reloadButton?.addEventListener("click", (evt) => {
       evt.preventDefault()

data/app/javascript/alchemy_admin/components/uploader/file_upload.js

@@ -200,7 +200,7 @@ export class FileUpload extends AlchemyHTMLElement {
       const response = JSON.parse(this.request.responseText)
       return response["message"]
     } catch (error) {
-      return translate("Could not parse JSON result")
+      return `${this.request.status}: ${this.request.statusText}`
     }
   }
 

data/app/javascript/alchemy_admin/confirm_dialog.js

@@ -3,20 +3,18 @@ import pleaseWaitOverlay from "alchemy_admin/please_wait_overlay"
 import { createHtmlElement } from "alchemy_admin/utils/dom_helpers"
 import { translate } from "alchemy_admin/i18n"
 
+const DEFAULTS = {
+  size: "300x100",
+  title: translate("Please confirm"),
+  ok_label: translate("Yes"),
+  cancel_label: translate("No"),
+  on_ok() {}
+}
+
 class ConfirmDialog {
   constructor(message, options = {}) {
-    const DEFAULTS = {
-      size: "300x100",
-      title: translate("Please confirm"),
-      ok_label: translate("Yes"),
-      cancel_label: translate("No"),
-      on_ok() {}
-    }
-
-    options = { ...DEFAULTS, ...options }
-
     this.message = message
-    this.options = options
+    this.options = { ...DEFAULTS, ...options }
     this.#build()
     this.#bindEvents()
   }

data/app/javascript/alchemy_admin/dialog.js

@@ -0,0 +1,329 @@
+import Hotkeys from "alchemy_admin/hotkeys"
+import Spinner from "alchemy_admin/spinner"
+
+// Collection of all current dialog instances
+const currentDialogs = []
+
+const DEFAULTS = {
+  header_height: 36,
+  size: "400x300",
+  padding: true,
+  title: "",
+  modal: true,
+  overflow: "visible",
+  ready: () => {},
+  closed: () => {}
+}
+
+export class Dialog {
+  // Arguments:
+  //  - url: The url to load the content from via ajax
+  //  - options: A object holding options
+  //    - size: The maximum size of the Dialog
+  //    - title: The title of the Dialog
+  constructor(url, options = {}) {
+    this.url = url
+    this.options = { ...DEFAULTS, ...options }
+    this.$document = $(document)
+    this.$window = $(window)
+    this.$body = $("body")
+    const size = this.options.size.split("x")
+    this.width = parseInt(size[0], 10)
+    this.height = parseInt(size[1], 10)
+    this.build()
+    this.resize()
+  }
+
+  // Opens the Dialog and loads the content via ajax.
+  open() {
+    this.dialog.trigger("Alchemy.DialogOpen")
+    this.bind_close_events()
+    window.requestAnimationFrame(() => {
+      this.dialog_container.addClass("open")
+      if (this.overlay != null) {
+        return this.overlay.addClass("open")
+      }
+    })
+    this.$body.addClass("prevent-scrolling")
+    currentDialogs.push(this)
+    this.load()
+  }
+
+  // Closes the Dialog and removes it from the DOM
+  close() {
+    this.dialog.trigger("DialogClose.Alchemy")
+    this.$document.off("keydown")
+    this.dialog_container.removeClass("open")
+    if (this.overlay != null) {
+      this.overlay.removeClass("open")
+    }
+    this.$document.on(
+      "webkitTransitionEnd transitionend oTransitionEnd",
+      () => {
+        this.$document.off("webkitTransitionEnd transitionend oTransitionEnd")
+        this.dialog_container.remove()
+        if (this.overlay != null) {
+          this.overlay.remove()
+        }
+        this.$body.removeClass("prevent-scrolling")
+        currentDialogs.pop(this)
+        if (this.options.closed != null) {
+          return this.options.closed()
+        }
+      }
+    )
+    return true
+  }
+
+  // Loads the content via ajax and replaces the Dialog body with server response.
+  load() {
+    this.show_spinner()
+    $.get(this.url, (data) => {
+      this.replace(data)
+    }).fail((xhr) => {
+      this.show_error(xhr)
+    })
+  }
+
+  // Reloads the Dialog content
+  reload() {
+    this.dialog_body.empty()
+    this.load()
+  }
+
+  // Replaces the dialog body with given content and initializes it.
+  replace(data) {
+    this.remove_spinner()
+    this.dialog_body.hide()
+    this.dialog_body.html(data)
+    this.init()
+    this.dialog[0].dispatchEvent(
+      new CustomEvent("DialogReady.Alchemy", {
+        bubbles: true,
+        detail: {
+          body: this.dialog_body[0]
+        }
+      })
+    )
+    if (this.options.ready != null) {
+      this.options.ready(this.dialog_body)
+    }
+    this.dialog_body.show()
+  }
+
+  // Adds a spinner into Dialog body
+  show_spinner() {
+    this.spinner = new Spinner("medium")
+    this.spinner.spin(this.dialog_body[0])
+  }
+
+  // Removes the spinner from Dialog body
+  remove_spinner() {
+    this.spinner.stop()
+  }
+
+  // Initializes the Dialog body
+  init() {
+    Hotkeys(this.dialog_body)
+    this.watch_remote_forms()
+  }
+
+  // Watches ajax requests inside of dialog body and replaces the content accordingly
+  watch_remote_forms() {
+    const $form = $('[data-remote="true"]', this.dialog_body)
+
+    $form.on("ajax:success", (event) => {
+      const xhr = event.detail[2]
+      const content_type = xhr.getResponseHeader("Content-Type")
+      if (content_type.match(/javascript/)) {
+        return
+      } else {
+        this.dialog_body.html(xhr.responseText)
+        this.init()
+      }
+    })
+
+    $form.on("ajax:error", (event) => {
+      const statusText = event.detail[1]
+      const xhr = event.detail[2]
+      this.show_error(xhr, statusText)
+    })
+  }
+
+  // Displays an error message
+  show_error(xhr, statusText) {
+    if (xhr.status === 422) {
+      this.dialog_body.html(xhr.responseText)
+      this.init()
+      return
+    }
+
+    const { error_body, error_header, error_type } = this.error_messages(
+      xhr,
+      statusText
+    )
+
+    const $errorDiv = $(`<alchemy-message type="${error_type}">
+      <h1>${error_header}</h1>
+      <p>${error_body}</p>
+    </alchemy-message>`)
+
+    this.dialog_body.html($errorDiv)
+  }
+
+  // Returns error message based on xhr status
+  error_messages(xhr, statusText) {
+    let error_body,
+      error_header,
+      error_type = "warning"
+
+    switch (xhr.status) {
+      case 0:
+        error_header = "The server does not respond."
+        error_body = "Please check server and try again."
+        break
+      case 403:
+        error_header = "You are not authorized!"
+        error_body = "Please close this window."
+        break
+      default:
+        error_type = "error"
+        if (statusText) {
+          error_header = statusText
+          console.error(xhr.responseText)
+        } else {
+          error_header = `${xhr.statusText} (${xhr.status})`
+        }
+        error_body = "Please check log and try again."
+    }
+
+    return { error_header, error_body, error_type }
+  }
+
+  // Binds close events on:
+  // - Close button
+  // - Overlay (if the Dialog is a modal)
+  // - ESC Key
+  bind_close_events() {
+    this.close_button.on("click", () => {
+      this.close()
+    })
+    this.dialog_container.addClass("closable").on("click", (e) => {
+      if (e.target !== this.dialog_container.get(0)) {
+        return true
+      }
+      this.close()
+      return false
+    })
+    this.$document.keydown((e) => {
+      if (e.which === 27) {
+        this.close()
+        return false
+      } else {
+        return true
+      }
+    })
+  }
+
+  // Builds the html structure of the Dialog
+  build() {
+    this.dialog_container = $('<div class="alchemy-dialog-container" />')
+    this.dialog = $('<div class="alchemy-dialog" />')
+    this.dialog_body = $('<div class="alchemy-dialog-body" />')
+    this.dialog_header = $('<div class="alchemy-dialog-header" />')
+    this.dialog_title = $('<div class="alchemy-dialog-title" />')
+    this.close_button = $(
+      '<a class="alchemy-dialog-close"><alchemy-icon name="close"></alchemy-icon></a>'
+    )
+    this.dialog_title.text(this.options.title)
+    this.dialog_header.append(this.dialog_title)
+    this.dialog_header.append(this.close_button)
+    this.dialog.append(this.dialog_header)
+    this.dialog.append(this.dialog_body)
+    this.dialog_container.append(this.dialog)
+    if (this.options.modal) {
+      this.dialog.addClass("modal")
+    }
+    if (this.options.padding) {
+      this.dialog_body.addClass("padded")
+    }
+    if (this.options.modal) {
+      this.overlay = $('<div class="alchemy-dialog-overlay" />')
+      this.$body.append(this.overlay)
+    }
+    this.$body.append(this.dialog_container)
+  }
+
+  // Sets the correct size of the dialog
+  // It normalizes the given size, so that it never acceeds the window size.
+  resize() {
+    const { width, height } = this.getSize()
+
+    this.dialog.css({
+      width: width,
+      "min-height": height,
+      overflow: this.options.overflow
+    })
+
+    if (this.options.overflow === "hidden") {
+      this.dialog_body.css({
+        height: height,
+        overflow: "auto"
+      })
+    } else {
+      this.dialog_body.css({
+        "min-height": height,
+        overflow: "visible"
+      })
+    }
+  }
+
+  getSize() {
+    const padding = this.options.padding ? 16 : 0
+    const doc_width = this.$window.width()
+    const doc_height = this.$window.height()
+
+    let width = this.width
+    let height = this.height
+
+    if (width >= doc_width) {
+      width = doc_width - padding
+    }
+
+    if (height >= doc_height) {
+      height = doc_height - padding - DEFAULTS.header_height
+    }
+
+    return { width, height }
+  }
+}
+
+// Gets the last dialog instantiated, which is the current one.
+export function currentDialog() {
+  const { length } = currentDialogs
+  if (length === 0) {
+    return
+  }
+  return currentDialogs[length - 1]
+}
+
+// Utility function to close the current Dialog
+//
+// You can pass a callback function, that gets triggered after the Dialog gets closed.
+//
+export function closeCurrentDialog(callback) {
+  const dialog = currentDialog()
+  if (dialog != null) {
+    dialog.options.closed = callback
+    return dialog.close()
+  }
+}
+
+// Utility function to open a new Dialog
+export function openDialog(url, options) {
+  if (!url) {
+    throw "No url given! Please provide an url."
+  }
+  const dialog = new Dialog(url, options)
+  dialog.open()
+}

data/app/javascript/alchemy_admin/hotkeys.js

@@ -1,4 +1,5 @@
 import "keymaster"
+import { openDialog } from "alchemy_admin/dialog"
 
 const bindedHotkeys = []
 
@@ -7,7 +8,7 @@ function showHelp(evt) {
     !$(evt.target).is("input, textarea") &&
     String.fromCharCode(evt.which) === "?"
   ) {
-    Alchemy.openDialog("/admin/help", {
+    openDialog("/admin/help", {
       title: Alchemy.t("help"),
       size: "400x492"
     })
@@ -18,7 +19,7 @@ function showHelp(evt) {
 }
 
 export default function (scope = document) {
-  // The scope can be a jQuery object because we still use jQuery in Alchemy.Dialog.
+  // The scope can be a jQuery object because we still use jQuery in alchemy_admin/dialog.js.
   if (scope instanceof jQuery) {
     scope = scope[0]
   }