SPB Git

Repository Public

useSieve.ts 5.7 KB 125 lines typescript

1// Script Sieve unique « spmail » : il porte les règles de tri ET la réponse automatique.2// Sur Stalwart un seul script est actif : on n'active donc jamais VacationResponse (son script « vacation » désactiverait le nôtre).3import { useCallback, useState } from "react"4import { assertSet } from "../../jmap/client"5import { JmapSetError } from "../../jmap/errors"6import { CAP, type Id, type VacationResponse } from "../../jmap/types"7import { SIEVE_SCRIPT_NAME, emptySieveConfig, generateSieve, parseSieveConfig, type SieveConfig } from "../../mail/sieve"8import { folderByRole, type Account } from "../../state/app"9import { clientFor, folderPath } from "../../state/mail"10import { toastError, useLoad, type Load } from "./shared"1112export interface SieveData {13  /** identifiant du script « spmail », s'il existe */14  scriptId: Id | null15  /** notre script est celui que le serveur exécute */16  active: boolean17  config: SieveConfig18  /** script écrit à la main (sans configuration structurée relisible) */19  custom: boolean20  /** texte du script tel que stocké ("" s'il n'existe pas) */21  raw: string22  /** réponse automatique activée par un autre client (VacationResponse), sinon null */23  legacy: VacationResponse | null24}2526export interface SieveApi {27  state: Load<SieveData>28  reload: () => void29  saving: boolean30  /** refus du script par le serveur (ligne, colonne) */31  scriptError: string | null32  clearScriptError: () => void33  saveConfig: (config: SieveConfig) => Promise<boolean>34  saveRaw: (text: string) => Promise<boolean>35  /** null = script valide, sinon la description de l'erreur */36  validate: (text: string) => Promise<string | null>37  /** script que produirait cette configuration pour cette boîte */38  generate: (config: SieveConfig) => string39}4041const SIEVE_TYPE = "application/sieve"4243export function trashPathOf(account: Account | undefined): string {44  const trash = folderByRole(account, "trash")45  return trash ? folderPath(account, trash) : "Deleted Items"46}4748export function useSieve(mb: string, account: Account | undefined): SieveApi {49  const [saving, setSaving] = useState(false)50  const [scriptError, setScriptError] = useState<string | null>(null)51  const trashPath = trashPathOf(account)5253  const { state, reload, setData } = useLoad<SieveData>(async (signal) => {54    const c = clientFor(mb)55    const b = c.batch()56    const scripts = b.add("SieveScript/get", { ids: null }, CAP.sieve)57    const vacation = b.add("VacationResponse/get", { ids: null }, CAP.vacation)58    await b.send(signal)59    const script = scripts.result.list.find((s) => s.name === SIEVE_SCRIPT_NAME)60    const legacy = vacation.error ? null : (vacation.result.list.find((v) => v.isEnabled) ?? null)61    if (!script) return { scriptId: null, active: false, config: emptySieveConfig(), custom: false, raw: "", legacy }62    const raw = await c.downloadText(script.blobId, SIEVE_TYPE, signal)63    const config = parseSieveConfig(raw)64    return { scriptId: script.id, active: script.isActive, config: config ?? emptySieveConfig(), custom: !config, raw, legacy }65  }, mb)6667  const data = state.status === "ready" ? state.data : null6869  /** Téléverse le script, le range sous le nom « spmail » et l'active. */70  const write = useCallback(71    async (text: string): Promise<boolean> => {72      if (!data || saving) return false73      setSaving(true)74      setScriptError(null)75      try {76        const c = clientFor(mb)77        if (data.legacy) {78          // l'ancienne réponse automatique d'abord : les deux ne doivent jamais se disputer le script actif79          const off = await c.call("VacationResponse/set", { update: { singleton: { isEnabled: false } } }, CAP.vacation)80          assertSet("VacationResponse/set", off, "singleton")81        }82        const { blobId } = await c.upload(new Blob([text], { type: SIEVE_TYPE }), SIEVE_TYPE)83        let scriptId = data.scriptId84        if (scriptId) {85          const res = await c.call("SieveScript/set", { update: { [scriptId]: { blobId } }, onSuccessActivateScript: scriptId }, CAP.sieve)86          assertSet("SieveScript/set", res, scriptId)87        } else {88          const res = await c.call("SieveScript/set", { create: { s: { name: SIEVE_SCRIPT_NAME, blobId } }, onSuccessActivateScript: "#s" }, CAP.sieve)89          assertSet("SieveScript/set", res, "s")90          scriptId = res.created?.s?.id ?? null91        }92        if (!scriptId) {93          reload() // identifiant inconnu : on relit l'état du serveur94          return true95        }96        const config = parseSieveConfig(text)97        setData({ scriptId, active: true, config: config ?? emptySieveConfig(), custom: !config, raw: text, legacy: null })98        return true99      } catch (e) {100        if (e instanceof JmapSetError && e.error.type === "invalidScript") setScriptError(e.error.description || e.error.type)101        else toastError(e)102        return false103      } finally {104        setSaving(false)105      }106    },107    [data, saving, mb, reload, setData],108  )109110  const generate = useCallback((config: SieveConfig) => generateSieve(config, trashPath), [trashPath])111  const saveConfig = useCallback((config: SieveConfig) => write(generateSieve(config, trashPath)), [write, trashPath])112113  const validate = useCallback(114    async (text: string): Promise<string | null> => {115      const c = clientFor(mb)116      const { blobId } = await c.upload(new Blob([text], { type: SIEVE_TYPE }), SIEVE_TYPE)117      const res = await c.call("SieveScript/validate", { blobId }, CAP.sieve)118      return res.error ? res.error.description || res.error.type : null119    },120    [mb],121  )122123  return { state, reload, saving, scriptError, clearScriptError: useCallback(() => setScriptError(null), []), saveConfig, saveRaw: write, validate, generate }124}125
Files main
Menu

Theme