SPB Git

Repository Public

query.ts 17.7 KB 315 lines typescript

1// SP Mail Next — langage de recherche : analyse PURE de la syntaxe d'opérateurs et traduction en filtre JMAP (aucun accès réseau ni base).2// Sur-ensemble de web/src/mail/search.ts : mêmes clés et synonymes français, plus cc/bcc/body/is/label/in/larger/smaller/filename,3// la négation (-terme), les expressions entre guillemets et OR entre termes. Une entrée invalide ne lève jamais : elle produit `errors`.4import type { Folder } from "../mailjmap.js"56export type Op = "text" | "from" | "to" | "cc" | "bcc" | "subject" | "body" | "filename" | "label" | "in" | "has" | "is" | "before" | "after" | "larger" | "smaller"7export type Term = {8  op: Op9  /** Valeur normalisée (rôle canonique pour `in:`, état canonique pour `is:`, texte tel que saisi sinon). */10  value: string11  negated: boolean12  /** Expression entre guillemets (texte libre). */13  phrase?: boolean14  /** Jeton d'origine et sa position dans la requête (pour les pastilles et le surlignage des erreurs). */15  raw: string; start: number; end: number16  /** Les termes d'un même groupe sont reliés par OR ; les groupes sont reliés par AND. */17  group: number18  /** before:/after: — instant UTC effectivement comparé. */19  date?: string20  /** larger:/smaller: — taille en octets. */21  bytes?: number22}23export type QueryError = { token: string; start: number; end: number; code: string; message: string }24export type Filter = Record<string, unknown>25export type Parsed = { terms: Term[]; filters: Filter | null; errors: QueryError[] }26export type ParseOptions = { now?: Date; tz?: string }2728export const MAX_QUERY_LENGTH = 100029export const MAX_TERMS = 503031// ------------------------------------------------------------------ vocabulaire32/** Minuscules, sans accents : « Après » → « apres », « à » → « a ». */33export const fold = (s: string) => s.normalize("NFD").replace(/\p{M}+/gu, "").toLowerCase()34const squash = (s: string) => fold(s).replace(/[\s_'’-]+/g, "")3536const KEYS: Record<string, Op> = {37  from: "from", de: "from", expediteur: "from", sender: "from",38  to: "to", a: "to", pour: "to", destinataire: "to",39  cc: "cc", bcc: "bcc", cci: "bcc",40  subject: "subject", sujet: "subject", objet: "subject",41  body: "body", corps: "body", texte: "body", contenu: "body",42  has: "has", avec: "has", contient: "has",43  is: "is", est: "is",44  label: "label", etiquette: "label", libelle: "label", tag: "label",45  in: "in", dans: "in", dossier: "in", folder: "in",46  before: "before", avant: "before", older: "before", older_than: "before",47  after: "after", apres: "after", since: "after", depuis: "after", newer: "after", newer_than: "after",48  larger: "larger", bigger: "larger", plusgrand: "larger", plusde: "larger",49  smaller: "smaller", pluspetit: "smaller", moinsde: "smaller",50  filename: "filename", file: "filename", fichier: "filename", nom: "filename",51}52const HAS_ATTACHMENT = new Set(["attachment", "attachments", "piece", "pieces", "piecejointe", "piecesjointes", "pj", "fichier", "fichiers", "file", "files"])53const IS: Record<string, string> = {54  unread: "unread", unseen: "unread", new: "unread", nonlu: "unread", nonlus: "unread", nouveau: "unread",55  read: "read", seen: "read", lu: "read", lus: "read",56  starred: "starred", flagged: "starred", star: "starred", important: "starred", suivi: "starred", etoile: "starred", marque: "starred",57  pinned: "pinned", epingle: "pinned",58  snoozed: "snoozed", reporte: "snoozed", enattente: "snoozed",59  followup: "followup", relance: "followup", arelancer: "followup", asuivre: "followup",60  answered: "answered", replied: "answered", repondu: "answered",61  forwarded: "forwarded", transfere: "forwarded",62  draft: "draft", brouillon: "draft",63}64/** État `is:` → mot-clé JMAP ; `unread` est l'absence de `$seen`. */65const IS_KEYWORD: Record<string, { keyword: string; present: boolean }> = {66  unread: { keyword: "$seen", present: false }, read: { keyword: "$seen", present: true }, starred: { keyword: "$flagged", present: true },67  pinned: { keyword: "$pinned", present: true }, snoozed: { keyword: "$snoozed", present: true }, followup: { keyword: "$followup", present: true },68  answered: { keyword: "$answered", present: true }, forwarded: { keyword: "$forwarded", present: true }, draft: { keyword: "$draft", present: true },69}70const IN: Record<string, string> = {71  inbox: "inbox", reception: "inbox", boite: "inbox", boitedereception: "inbox",72  sent: "sent", envoyes: "sent", envoye: "sent", sentitems: "sent",73  drafts: "drafts", draft: "drafts", brouillons: "drafts", brouillon: "drafts",74  trash: "trash", bin: "trash", corbeille: "trash", deleted: "trash", deleteditems: "trash",75  junk: "junk", spam: "junk", indesirables: "junk", indesirable: "junk", pourriel: "junk", junkmail: "junk",76  archive: "archive", archives: "archive",77  all: "all", any: "all", anywhere: "all", tout: "all", tous: "all", partout: "all",78  snoozed: "snoozed", reportes: "snoozed",79}80export const ROLES = ["inbox", "sent", "drafts", "trash", "junk", "archive"] as const8182// ------------------------------------------------------------------ dates et tailles83const jmapDate = (ms: number) => new Date(ms).toISOString().replace(/\.\d{3}Z$/, "Z")84export function validTz(tz: string | undefined): string {85  if (!tz) return "UTC"86  try { new Intl.DateTimeFormat("en-US", { timeZone: tz }); return tz } catch { return "UTC" }87}88function zonedParts(at: number, tz: string) {89  const p = new Intl.DateTimeFormat("en-US", { timeZone: tz, hourCycle: "h23", year: "numeric", month: "2-digit", day: "2-digit", hour: "2-digit", minute: "2-digit", second: "2-digit" }).formatToParts(new Date(at))90  const g = (t: string) => Number(p.find((x) => x.type === t)?.value ?? 0)91  return { y: g("year"), m: g("month"), d: g("day"), h: g("hour"), mi: g("minute"), s: g("second") }92}93const tzOffset = (at: number, tz: string) => { const z = zonedParts(at, tz); return Date.UTC(z.y, z.m - 1, z.d, z.h, z.mi, z.s) - Math.floor(at / 1000) * 1000 }94/** Minuit (début de journée) du jour civil y-m-d dans le fuseau `tz`, en millisecondes UTC. */95export function zonedMidnight(y: number, m: number, d: number, tz: string): number {96  const guess = Date.UTC(y, m - 1, d)97  const t = guess - tzOffset(guess, tz)98  return guess - tzOffset(t, tz)99}100/**101 * Valeur de date → instant comparé. Jour civil (AAAA-MM-JJ, today, yesterday) : `after` = début du jour, `before` = fin du jour (jour inclus,102 * comme le client web). Durée relative (7d, 2w, 3m, 1y, 12h) : l'instant « maintenant − durée » pour les deux opérateurs.103 */104export function resolveDate(op: "before" | "after", value: string, now: Date, tz: string): number | null {105  const v = squash(value)106  const day = (y: number, m: number, d: number) => (op === "after" ? zonedMidnight(y, m, d, tz) : zonedMidnight(y, m, d + 1, tz))107  const abs = /^(\d{4})[-/](\d{2})[-/](\d{2})$/.exec(value.trim())108  if (abs) {109    const [y, m, d] = [Number(abs[1]), Number(abs[2]), Number(abs[3])]110    const check = new Date(Date.UTC(y, m - 1, d))111    if (check.getUTCFullYear() !== y || check.getUTCMonth() !== m - 1 || check.getUTCDate() !== d || y < 1970 || y > 2200) return null112    return day(y, m, d)113  }114  if (v === "today" || v === "aujourdhui") { const z = zonedParts(now.getTime(), tz); return day(z.y, z.m, z.d) }115  if (v === "yesterday" || v === "hier") { const z = zonedParts(now.getTime(), tz); return day(z.y, z.m, z.d - 1) }116  const rel = /^(\d{1,4})(h|d|j|w|m|y|a)$/.exec(v)117  if (rel) {118    const n = Number(rel[1])119    const t = new Date(now.getTime())120    switch (rel[2]) {121      case "h": t.setTime(t.getTime() - n * 3600_000); break122      case "d": case "j": t.setTime(t.getTime() - n * 86400_000); break123      case "w": t.setTime(t.getTime() - n * 7 * 86400_000); break124      case "m": t.setUTCMonth(t.getUTCMonth() - n); break125      default: t.setUTCFullYear(t.getUTCFullYear() - n)126    }127    return Number.isNaN(t.getTime()) ? null : t.getTime()128  }129  return null130}131/** « 10k », « 5m », « 1,5mo », « 2g », « 300 » → octets (multiples de 1024). */132export function resolveSize(value: string): number | null {133  const m = /^(\d+(?:[.,]\d+)?)(b|o|k|kb|ko|m|mb|mo|g|gb|go)?$/.exec(fold(value).replace(/\s+/g, ""))134  if (!m) return null135  const mult = !m[2] || m[2] === "b" || m[2] === "o" ? 1 : m[2][0] === "k" ? 1024 : m[2][0] === "m" ? 1024 ** 2 : 1024 ** 3136  const n = Math.round(Number(m[1].replace(",", ".")) * mult)137  return Number.isFinite(n) && n <= 1e13 ? n : null138}139140// ------------------------------------------------------------------ analyse141const TOKEN = /(-)?(?:([\p{L}_]+):(?:"([^"]*)"|(\S*))|"([^"]*)"?|(\S+))/gu142143/** Analyse la requête. Ne lève jamais : tout jeton invalide est écarté et décrit dans `errors`. */144export function parseQuery(input: unknown, opts: ParseOptions = {}): Parsed {145  const errors: QueryError[] = []146  let q = typeof input === "string" ? input : ""147  if (q.length > MAX_QUERY_LENGTH) {148    errors.push({ token: "", start: MAX_QUERY_LENGTH, end: q.length, code: "query_too_long", message: `The query is longer than ${MAX_QUERY_LENGTH} characters; the rest was ignored` })149    q = q.slice(0, MAX_QUERY_LENGTH)150  }151  const now = opts.now ?? new Date()152  const tz = validTz(opts.tz)153  const terms: Term[] = []154  let group = -1155  let pendingOr: { token: string; start: number; end: number } | null = null156  const err = (m: RegExpMatchArray, code: string, message: string) => { errors.push({ token: m[0], start: m.index!, end: m.index! + m[0].length, code, message }) }157  const push = (m: RegExpMatchArray, t: Pick<Term, "op" | "value"> & Partial<Term>) => {158    if (terms.length >= MAX_TERMS) { if (!errors.some((e) => e.code === "too_many_terms")) err(m, "too_many_terms", `At most ${MAX_TERMS} terms are used; the rest was ignored`); return }159    if (pendingOr && group >= 0) pendingOr = null160    else group++161    terms.push({ negated: !!m[1], raw: m[0], start: m.index!, end: m.index! + m[0].length, group, ...t })162  }163  for (const m of q.matchAll(TOKEN)) {164    if (m[2] === undefined && m[5] === undefined && !m[1] && (m[6] === "OR" || m[6] === "OU")) {165      if (group < 0 || pendingOr) err(m, "dangling_or", "`OR` must stand between two terms")166      else pendingOr = { token: m[0], start: m.index!, end: m.index! + m[0].length }167      continue168    }169    const hadOr = pendingOr170    one(m)171    // Le terme qui suivait OR était invalide : le OR ne relie plus rien.172    if (hadOr && pendingOr === hadOr) pendingOr = null173  }174  function one(m: RegExpMatchArray) {175    if (m[2] !== undefined) {176      const op = KEYS[fold(m[2])]177      const value = (m[3] ?? m[4] ?? "").replace(/^"|"$/g, "").trim()178      // Clé inconnue (« http://… », « note:x ») : le jeton entier est du texte libre, comme dans le client web.179      if (!op) { push(m, { op: "text", value: m[1] ? m[0].slice(1) : m[0] }); return }180      if (!value) { err(m, "empty_value", `\`${m[2]}:\` needs a value`); return }181      switch (op) {182        case "has":183          if (HAS_ATTACHMENT.has(squash(value))) push(m, { op, value: "attachment" })184          else err(m, "invalid_value", "Only `has:attachment` is supported")185          break186        case "is": {187          const state = IS[squash(value)]188          if (state) push(m, { op, value: state })189          else err(m, "invalid_value", `Unknown state \`${value}\` (unread, read, starred, pinned, snoozed, followup, answered, forwarded, draft)`)190          break191        }192        case "before": case "after": {193          const t = resolveDate(op, value, now, tz)194          if (t === null) err(m, "invalid_date", "Dates are YYYY-MM-DD, today, yesterday, or a duration such as 7d, 2w, 3m, 1y")195          else push(m, { op, value, date: jmapDate(t) })196          break197        }198        case "larger": case "smaller": {199          const bytes = resolveSize(value)200          if (bytes === null) err(m, "invalid_size", "Sizes are a number with an optional unit: 500, 10k, 5m, 1g")201          else push(m, { op, value, bytes })202          break203        }204        case "in":205          push(m, { op, value: IN[squash(value)] ?? value })206          break207        default:208          push(m, { op, value })209      }210    } else if (m[5] !== undefined) {211      if (m[5].trim()) push(m, { op: "text", value: m[5].trim(), phrase: true })212    } else if (m[6] !== undefined && m[6] !== "-") push(m, { op: "text", value: m[6] }) // un « - » isolé est ignoré213  }214  if (pendingOr) errors.push({ ...(pendingOr as { token: string; start: number; end: number }), code: "dangling_or", message: "`OR` must stand between two terms" })215  // filename: se vérifie sur les noms des pièces jointes après la requête : il ne peut pas être une branche d'un OR.216  for (const t of terms) if (t.op === "filename" && terms.some((o) => o !== t && o.group === t.group))217    errors.push({ token: t.raw, start: t.start, end: t.end, code: "filename_in_or", message: "`filename:` cannot be combined with OR; it is treated as `has:attachment` here" })218  return { terms, filters: compileFilter(terms).filter, errors }219}220221// ------------------------------------------------------------------ traduction en filtre JMAP222export type CompileContext = {223  /** Dossiers de la boîte visée. */224  folders: Pick<Folder, "id" | "name" | "role">[]225  /** Nom d'étiquette (replié par `fold`) → mot-clé `lbl_…`. */226  labels: Map<string, string>227}228export type Compiled = {229  /** null : la requête ne peut rien trouver dans cette boîte (dossier absent, étiquette inconnue). */230  filter: Filter | null231  /** Vérification complémentaire sur le message chargé (noms de pièces jointes) ; null s'il n'y en a pas. */232  post: ((email: { attachments?: { name?: string | null }[] | null }) => boolean) | null233  errors: QueryError[]234}235const ANY = Symbol("any"), NONE = Symbol("none")236type Leaf = Filter | typeof ANY | typeof NONE237const not = (c: Leaf): Leaf => (c === ANY ? NONE : c === NONE ? ANY : { operator: "NOT", conditions: [c] })238239/** Dossiers désignés par `in:<valeur>` dans une boîte (rôle canonique, « snoozed », ou nom de dossier sans casse ni accents). */240export function foldersFor(value: string, folders: CompileContext["folders"]): string[] {241  if ((ROLES as readonly string[]).includes(value)) return folders.filter((f) => f.role === value).map((f) => f.id)242  const v = fold(value)243  return folders.filter((f) => fold(f.name) === v).map((f) => f.id)244}245246/**247 * Traduit les termes en filtre JMAP. Sans contexte (`ctx` absent) la forme est symbolique et indépendante de la boîte :248 * `{ label: "nom" }`, `{ in: "inbox" }`, `{ filename: "x" }` — c'est le champ `filters` rendu aux clients.249 * Portée par défaut : tout sauf la corbeille et les indésirables, à moins qu'un `in:` positif ne dise où chercher.250 */251export function compileFilter(terms: Term[], ctx?: CompileContext): Compiled {252  const errors: QueryError[] = []253  const posts: ((names: string[]) => boolean)[] = []254  const fail = (t: Term, code: string, message: string) => { errors.push({ token: t.raw, start: t.start, end: t.end, code, message }) }255  const leaf = (t: Term, alone: boolean): Leaf => {256    let c: Leaf257    switch (t.op) {258      case "text": c = { text: t.phrase ? `"${t.value.replace(/"/g, "")}"` : t.value }; break259      case "from": case "to": case "cc": case "bcc": case "subject": case "body": c = { [t.op]: t.value }; break260      case "has": return { hasAttachment: !t.negated }261      case "is": { const k = IS_KEYWORD[t.value]; return k.present !== t.negated ? { hasKeyword: k.keyword } : { notKeyword: k.keyword } }262      case "before": c = { before: t.date }; break263      case "after": c = { after: t.date }; break264      case "larger": c = { minSize: t.bytes }; break265      case "smaller": c = { maxSize: t.bytes }; break266      case "label": {267        if (!ctx) { c = { label: t.value }; break }268        const kw = /^lbl_[0-9a-f]{8}$/.test(t.value) ? t.value : ctx.labels.get(fold(t.value))269        if (!kw) { fail(t, "unknown_label", `No label is named \`${t.value}\``); c = NONE; break }270        return t.negated ? { notKeyword: kw } : { hasKeyword: kw }271      }272      case "in": {273        if (t.value === "all") { c = ANY; break }274        if (!ctx) { c = { in: t.value }; break }275        const ids = foldersFor(t.value, ctx.folders)276        if (!ids.length) { fail(t, "unknown_folder", `No folder \`${t.value}\` in this mailbox`); c = NONE; break }277        c = ids.length === 1 ? { inMailbox: ids[0] } : { operator: "OR", conditions: ids.map((id) => ({ inMailbox: id })) }278        break279      }280      case "filename": {281        if (!ctx) { c = { filename: t.value }; break }282        if (alone) {283          const needle = fold(t.value)284          posts.push((names) => names.some((n) => fold(n).includes(needle)) !== t.negated)285          return t.negated ? ANY : { hasAttachment: true }286        }287        c = { hasAttachment: true }288        break289      }290    }291    return t.negated ? not(c) : c292  }293  const groups = new Map<number, Term[]>()294  for (const t of terms) groups.set(t.group, [...(groups.get(t.group) ?? []), t])295  const and: Filter[] = []296  let impossible = false297  for (const g of groups.values()) {298    const leaves = g.map((t) => leaf(t, g.length === 1))299    if (leaves.includes(ANY)) continue300    const real = leaves.filter((l): l is Filter => l !== NONE)301    if (!real.length) { impossible = true; continue }302    and.push(real.length === 1 ? real[0] : { operator: "OR", conditions: real })303  }304  if (!terms.some((t) => t.op === "in" && !t.negated)) {305    if (!ctx) and.push({ notIn: ["trash", "junk"] })306    else {307      const hidden = ctx.folders.filter((f) => f.role === "trash" || f.role === "junk").map((f) => f.id)308      if (hidden.length) and.push({ inMailboxOtherThan: hidden })309    }310  }311  const filter: Filter | null = impossible ? null : and.length === 0 ? {} : and.length === 1 ? and[0] : { operator: "AND", conditions: and }312  const post = posts.length ? (e: { attachments?: { name?: string | null }[] | null }) => { const names = (e.attachments ?? []).map((a) => String(a.name ?? "")); return posts.every((p) => p(names)) } : null313  return { filter, post, errors }314}315
Files main
Menu

Theme