typo3-typescript-sources 13.4.20

package/install/module/settings/presets.ts

@@ -0,0 +1,147 @@
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+import 'bootstrap';
+import { AbstractInteractableModule, type ModuleLoadedResponseWithButtons } from '../abstract-interactable-module';
+import Modal from '@typo3/backend/modal';
+import Notification from '@typo3/backend/notification';
+import AjaxRequest from '@typo3/core/ajax/ajax-request';
+import Router from '../../router';
+import RegularEvent from '@typo3/core/event/regular-event';
+import type { AjaxResponse } from '@typo3/core/ajax/ajax-response';
+import type { ModalElement } from '@typo3/backend/modal';
+import type MessageInterface from '@typo3/install/message-interface';
+
+enum Identifiers {
+  activateTrigger = '.t3js-presets-activate',
+  imageExecutable = '.t3js-presets-image-executable',
+  imageExecutableTrigger = '.t3js-presets-image-executable-trigger'
+}
+
+type PresetsWrittenResponse = {
+  status: MessageInterface[],
+  success: boolean,
+};
+
+/**
+ * Module: @typo3/install/module/presets
+ */
+class Presets extends AbstractInteractableModule {
+  public override initialize(currentModal: ModalElement): void {
+    super.initialize(currentModal);
+    this.getContent();
+
+    // Load content with post data on click 'custom image executable path'
+    new RegularEvent('click', (event: Event): void => {
+      event.preventDefault();
+      this.getCustomImagePathContent();
+    }).delegateTo(currentModal, Identifiers.imageExecutableTrigger);
+
+    // Write out selected preset
+    new RegularEvent('click', (event: Event): void => {
+      event.preventDefault();
+      this.activate();
+    }).delegateTo(currentModal, Identifiers.activateTrigger);
+
+    // Automatically select the custom preset if a value in one of its input fields is changed
+
+    currentModal.querySelectorAll('.t3js-custom-preset').forEach((element: HTMLInputElement) => {
+      new RegularEvent('input', (event: Event, target: HTMLElement): void => {
+        currentModal.querySelector<HTMLInputElement>(`#${target.dataset.radio}`).checked = true;
+      }).delegateTo(element, '.t3js-custom-preset');
+    });
+  }
+
+  private getContent(): void {
+    const modalContent = this.getModalBody();
+    (new AjaxRequest(Router.getUrl('presetsGetContent')))
+      .get({ cache: 'no-cache' })
+      .then(
+        async (response: AjaxResponse): Promise<void> => {
+          const data: ModuleLoadedResponseWithButtons = await response.resolve();
+          if (data.success === true && data.html !== 'undefined' && data.html.length > 0) {
+            modalContent.innerHTML = data.html;
+            Modal.setButtons(data.buttons);
+          } else {
+            Notification.error('Something went wrong', 'The request was not processed successfully. Please check the browser\'s console and TYPO3\'s log.');
+          }
+        },
+        (error: AjaxResponse): void => {
+          Router.handleAjaxError(error, modalContent);
+        },
+      );
+  }
+
+  private getCustomImagePathContent(): void {
+    const modalContent = this.getModalBody();
+    const presetsContentToken = this.getModuleContent().dataset.presetsContentToken;
+    (new AjaxRequest(Router.getUrl()))
+      .post({
+        install: {
+          token: presetsContentToken,
+          action: 'presetsGetContent',
+          values: {
+            Image: {
+              additionalSearchPath: (this.findInModal(Identifiers.imageExecutable) as HTMLInputElement).value,
+            },
+          },
+        },
+      })
+      .then(
+        async (response: AjaxResponse): Promise<void> => {
+          const data = await response.resolve();
+          if (data.success === true && data.html !== 'undefined' && data.html.length > 0) {
+            modalContent.innerHTML = data.html;
+          } else {
+            Notification.error('Something went wrong', 'The request was not processed successfully. Please check the browser\'s console and TYPO3\'s log.');
+          }
+        },
+        (error: AjaxResponse): void => {
+          Router.handleAjaxError(error, modalContent);
+        },
+      );
+  }
+
+  private activate(): void {
+    this.setModalButtonsState(false);
+
+    const modalContent = this.getModalBody();
+    const executeToken: string = this.getModuleContent().dataset.presetsActivateToken;
+    const postData: Record<string, string> = {};
+    const formData = new FormData(this.findInModal('form'));
+    for (const [name, value] of formData) {
+      postData[name] = value.toString();
+    }
+    postData['install[action]'] = 'presetsActivate';
+    postData['install[token]'] = executeToken;
+    (new AjaxRequest(Router.getUrl())).post(postData).then(
+      async (response: AjaxResponse): Promise<void> => {
+        const data: PresetsWrittenResponse = await response.resolve();
+        if (data.success === true && Array.isArray(data.status)) {
+          data.status.forEach((element: MessageInterface): void => {
+            Notification.showMessage(element.title, element.message, element.severity);
+          });
+        } else {
+          Notification.error('Something went wrong', 'The request was not processed successfully. Please check the browser\'s console and TYPO3\'s log.');
+        }
+      },
+      (error: AjaxResponse): void => {
+        Router.handleAjaxError(error, modalContent);
+      },
+    ).finally((): void => {
+      this.setModalButtonsState(true);
+    });
+  }
+}
+
+export default new Presets();

package/install/module/settings/system-maintainer.ts

@@ -0,0 +1,111 @@
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+import 'bootstrap';
+import { AbstractInteractableModule, type ModuleLoadedResponseWithButtons } from '../abstract-interactable-module';
+import Modal from '@typo3/backend/modal';
+import Notification from '@typo3/backend/notification';
+import AjaxRequest from '@typo3/core/ajax/ajax-request';
+import Router from '../../router';
+import RegularEvent from '@typo3/core/event/regular-event';
+import type { SelectPure } from 'select-pure/lib/components';
+import type { AjaxResponse } from '@typo3/core/ajax/ajax-response';
+import type { ModalElement } from '@typo3/backend/modal';
+import type MessageInterface from '@typo3/install/message-interface';
+
+enum Identifiers {
+  writeTrigger = '.t3js-systemMaintainer-write',
+  selectPureField = '.t3js-systemMaintainer-select-pure'
+}
+
+type SystemMaintainerListResponse = ModuleLoadedResponseWithButtons & {
+  users: {
+    uid: number;
+    username: string;
+    disable: boolean;
+    isSystemMaintainer: boolean;
+  }[];
+};
+
+type SystemMaintainersWrittenResponse = {
+  status: MessageInterface[],
+  success: boolean,
+};
+
+/**
+ * Module: @typo3/install/module/system-maintainer
+ */
+class SystemMaintainer extends AbstractInteractableModule {
+  public override initialize(currentModal: ModalElement): void {
+    super.initialize(currentModal);
+
+    this.loadModuleFrameAgnostic('select-pure').then((): void => {
+      this.getList();
+    });
+
+    new RegularEvent('click', (event: Event): void => {
+      event.preventDefault();
+      this.write();
+    }).delegateTo(currentModal, Identifiers.writeTrigger);
+  }
+
+  private getList(): void {
+    const modalContent = this.getModalBody();
+    (new AjaxRequest(Router.getUrl('systemMaintainerGetList')))
+      .get({ cache: 'no-cache' })
+      .then(
+        async (response: AjaxResponse): Promise<void> => {
+          const data: SystemMaintainerListResponse = await response.resolve();
+          if (data.success === true) {
+            modalContent.innerHTML = data.html;
+            Modal.setButtons(data.buttons);
+          }
+        },
+        (error: AjaxResponse): void => {
+          Router.handleAjaxError(error, modalContent);
+        }
+      );
+  }
+
+  private write(): void {
+    this.setModalButtonsState(false);
+
+    const modalContent = this.getModalBody();
+    const executeToken = this.getModuleContent().dataset.systemMaintainerWriteToken;
+    const selectedUsers: string[] = (this.findInModal(Identifiers.selectPureField) as SelectPure).values;
+    (new AjaxRequest(Router.getUrl())).post({
+      install: {
+        users: selectedUsers,
+        token: executeToken,
+        action: 'systemMaintainerWrite',
+      },
+    }).then(async (response: AjaxResponse): Promise<void> => {
+      const data: SystemMaintainersWrittenResponse = await response.resolve();
+      if (data.success === true) {
+        if (Array.isArray(data.status)) {
+          data.status.forEach((element: MessageInterface): void => {
+            Notification.success(element.title, element.message);
+          });
+        }
+      } else {
+        Notification.error('Something went wrong', 'The request was not processed successfully. Please check the browser\'s console and TYPO3\'s log.');
+      }
+    }, (error: AjaxResponse): void => {
+      Router.handleAjaxError(error, modalContent);
+    }).finally((): void => {
+      this.setModalButtonsState(true);
+    });
+  }
+}
+
+export default new SystemMaintainer();

package/install/module/upgrade/core-update.ts

@@ -0,0 +1,255 @@
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+import { AbstractInteractableModule, type ModuleLoadedResponseWithButtons } from '../abstract-interactable-module';
+import Modal from '@typo3/backend/modal';
+import Notification from '@typo3/backend/notification';
+import AjaxRequest from '@typo3/core/ajax/ajax-request';
+import { FlashMessage } from '../../renderable/flash-message';
+import Severity from '../../renderable/severity';
+import Router from '../../router';
+import RegularEvent from '@typo3/core/event/regular-event';
+import type { AjaxResponse } from '@typo3/core/ajax/ajax-response';
+import type { ModalElement } from '@typo3/backend/modal';
+import type MessageInterface from '../../message-interface';
+
+enum Identifiers {
+  output = '.t3js-coreUpdate-output',
+  updateButton = '.t3js-coreUpdate-button'
+}
+
+type ActionItem = {
+  loadingMessage: string;
+  finishMessage: string;
+  nextActionName: string;
+};
+
+type ActionQueue = {
+  [k: string]: ActionItem;
+};
+
+class CoreUpdate extends AbstractInteractableModule {
+  private readonly actionQueue: ActionQueue = {
+    coreUpdateIsUpdateAvailable: {
+      loadingMessage: 'Checking for possible regular or security update',
+      finishMessage: undefined,
+      nextActionName: undefined,
+    },
+    coreUpdateCheckPreConditions: {
+      loadingMessage: 'Checking if update is possible',
+      finishMessage: 'System can be updated',
+      nextActionName: 'coreUpdateDownload',
+    },
+    coreUpdateDownload: {
+      loadingMessage: 'Downloading new core',
+      finishMessage: undefined,
+      nextActionName: 'coreUpdateVerifyChecksum',
+    },
+    coreUpdateVerifyChecksum: {
+      loadingMessage: 'Verifying checksum of downloaded core',
+      finishMessage: undefined,
+      nextActionName: 'coreUpdateUnpack',
+    },
+    coreUpdateUnpack: {
+      loadingMessage: 'Unpacking core',
+      finishMessage: undefined,
+      nextActionName: 'coreUpdateMove',
+    },
+    coreUpdateMove: {
+      loadingMessage: 'Moving core',
+      finishMessage: undefined,
+      nextActionName: 'coreUpdateActivate',
+    },
+    coreUpdateActivate: {
+      loadingMessage: 'Activating core',
+      finishMessage: 'Core updated - please reload your browser',
+      nextActionName: undefined,
+    },
+  };
+
+  /**
+   * Clone of a DOM object acts as button template
+   */
+  private buttonTemplate: HTMLElement = null;
+
+  /**
+   * Fetching the templates out of the DOM
+   */
+  public override initialize(currentModal: ModalElement): void {
+    super.initialize(currentModal);
+
+    this.loadModuleFrameAgnostic('@typo3/install/renderable/flash-message.js').then(async (): Promise<void> => {
+      await this.getData();
+      this.buttonTemplate = this.findInModal(Identifiers.updateButton)?.cloneNode(true) as HTMLElement;
+    });
+
+    new RegularEvent('click', (event: Event, target: HTMLElement): void => {
+      event.preventDefault();
+
+      if (!target.hasAttribute('data-action')) {
+        this.callAction('coreUpdateIsUpdateAvailable');
+        return;
+      }
+
+      const action = target.dataset.action;
+      this.findInModal(Identifiers.output).innerHTML = '';
+      switch (action) {
+        case 'updateDevelopment':
+          this.update('development');
+          break;
+        case 'updateRegular':
+          this.update('regular');
+          break;
+        default:
+          throw 'Unknown update action "' + action + '"';
+      }
+    }).delegateTo(currentModal, '.t3js-coreUpdate-init');
+  }
+
+  private getData(): Promise<void> {
+    const modalContent = this.getModalBody();
+    return (new AjaxRequest(Router.getUrl('coreUpdateGetData')))
+      .get({ cache: 'no-cache' })
+      .then(
+        async (response: AjaxResponse): Promise<void> => {
+          const data: ModuleLoadedResponseWithButtons = await response.resolve();
+          if (data.success === true) {
+            modalContent.innerHTML = data.html;
+            Modal.setButtons(data.buttons);
+          } else {
+            Notification.error('Something went wrong', 'The request was not processed successfully. Please check the browser\'s console and TYPO3\'s log.');
+          }
+        },
+        (error: AjaxResponse): void => {
+          Router.handleAjaxError(error, modalContent);
+        }
+      );
+  }
+
+  /**
+   * Execute core update.
+   *
+   * @param type Either 'development' or 'regular'
+   */
+  private update(type: string): void {
+    if (type !== 'development') {
+      type = 'regular';
+    }
+    this.callAction('coreUpdateCheckPreConditions', type);
+  }
+
+  /**
+   * Generic method to call actions from the queue
+   *
+   * @param actionName Name of the action to be called
+   * @param type Update type (optional)
+   */
+  private callAction(actionName: string, type?: string): void {
+    const data: any = {
+      install: {
+        action: actionName,
+      },
+    };
+    if (type !== undefined) {
+      data.install.type = type;
+    }
+    this.addLoadingMessage(this.actionQueue[actionName].loadingMessage);
+    (new AjaxRequest(Router.getUrl()))
+      .withQueryArguments(data)
+      .get({ cache: 'no-cache' })
+      .then(
+        async (response: AjaxResponse): Promise<void> => {
+          // @todo: build a map containing the desired type for the response of `actionName`
+          const result = await response.resolve();
+          const canContinue = this.handleResult(result, this.actionQueue[actionName].finishMessage);
+          if (canContinue === true && (this.actionQueue[actionName].nextActionName !== undefined)) {
+            this.callAction(this.actionQueue[actionName].nextActionName, type);
+          }
+        },
+        (error: AjaxResponse): void => {
+          Router.handleAjaxError(error, this.getModalBody());
+        }
+      );
+  }
+
+  /**
+   * Handle ajax result of core update step.
+   */
+  private handleResult(data: any, successMessage: string): boolean {
+    const canContinue: boolean = data.success;
+    this.removeLoadingMessage();
+
+    if (data.status && typeof (data.status) === 'object') {
+      this.showStatusMessages(data.status);
+    }
+    if (data.action && typeof (data.action) === 'object') {
+      this.showActionButton(data.action);
+    }
+    if (canContinue && successMessage) {
+      this.addMessage(Severity.ok, successMessage);
+    }
+    return canContinue;
+  }
+
+  /**
+   * Add a loading message with some text.
+   *
+   * @param messageTitle
+   */
+  private addLoadingMessage(messageTitle: string): void {
+    this.addMessage(Severity.loading, messageTitle);
+  }
+
+  /**
+   * Remove an enabled loading message
+   */
+  private removeLoadingMessage(): void {
+    this.findInModal(Identifiers.output).querySelector('typo3-install-flashmessage')?.remove();
+  }
+
+  /**
+   * Show a list of status messages
+   *
+   * @param messages
+   */
+  private showStatusMessages(messages: MessageInterface[]): void {
+    for (const element of messages) {
+      this.addMessage(element.severity, element.title ?? '', element.message ?? '');
+    }
+  }
+
+  /**
+   * Show an action button
+   *
+   * @param button
+   */
+  private showActionButton(button: any): void {
+    const domButton = this.buttonTemplate;
+    if (button.action) {
+      domButton.setAttribute('data-action', button.action);
+    }
+    if (button.title) {
+      domButton.innerText = button.title;
+    }
+    this.findInModal(Identifiers.updateButton).replaceWith(domButton);
+  }
+
+  /**
+   * Show a status message
+   */
+  private addMessage(severity: number, title: string, message?: string): void {
+    this.findInModal(Identifiers.output).append(FlashMessage.create(severity, title, message));
+  }
+}
+
+export default new CoreUpdate();