Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Patrick Niebeling
|
4464e5ad3c | ||
|
Patrick Niebeling
|
9e1a15bab0 | ||
|
Patrick Niebeling
|
8268f1068d | ||
|
Patrick Niebeling
|
5bd3181f10 | ||
|
Patrick Niebeling
|
7612344726 | ||
|
Patrick Niebeling
|
35903772eb | ||
|
Patrick Niebeling
|
5083607ac4 | ||
|
Patrick Niebeling
|
c7baa8c67f | ||
|
Patrick Niebeling
|
e5b5f25748 | ||
|
Patrick Niebeling
|
ebf48b0707 | ||
|
Patrick Niebeling
|
30e644a001 | ||
|
Patrick Niebeling
|
860e8b7bbb | ||
|
Patrick Niebeling
|
1ffc0765ea | ||
|
Patrick Niebeling
|
578b235f08 | ||
|
Patrick Niebeling
|
27717205cd | ||
|
Patrick Niebeling
|
ed684cca4f | ||
|
Patrick Niebeling
|
0904292c73 | ||
|
Patrick Niebeling
|
e84123654e | ||
|
Patrick Niebeling
|
ada16cb101 | ||
 gnilebein
|
7c7c52cb1c | ||
|
Patrick Niebeling
|
dfec88d396 | ||
|
gnilebein
|
28b4edc811 |
No files matched your search
@@ -0,0 +1,84 @@
|
||||
name: Publish to App Store
|
||||
|
||||
# Manual only: pushes an already published v* release to apps.nextcloud.com.
|
||||
# It does not build anything - it signs the exact tarball build-main.yml
|
||||
# attached to the Gitea release, because the App Store downloads the file from
|
||||
# that URL and checks the signature against it. That release only exists if
|
||||
# the checks were green, so this workflow needs no `needs:` of its own.
|
||||
#
|
||||
# Secrets:
|
||||
# APPSTORE_PRIVATE_KEY workflow_deck_automation.key (PEM, the key the App
|
||||
# Store certificate was issued for)
|
||||
# APPSTORE_TOKEN API token from https://apps.nextcloud.com/account/token
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
tag:
|
||||
description: 'Release-Tag, z. B. v35.2.3'
|
||||
required: true
|
||||
type: string
|
||||
|
||||
jobs:
|
||||
appstore:
|
||||
runs-on: gitea-runner-server03
|
||||
permissions:
|
||||
contents: read
|
||||
env:
|
||||
TAG: ${{ inputs.tag }}
|
||||
DOWNLOAD_URL: ${{ gitea.server_url }}/${{ gitea.repository }}/releases/download/${{ inputs.tag }}/workflow_deck_automation.tar.gz
|
||||
steps:
|
||||
- name: Check tag
|
||||
run: |
|
||||
# latest-main is rebuilt on every push, so its tarball (and signature)
|
||||
# would not stay valid - only real version tags go to the store.
|
||||
if ! printf '%s' "$TAG" | grep -Eq '^v[0-9]+\.[0-9]+\.[0-9]+$'; then
|
||||
echo "::error::'$TAG' is not a version tag (vX.Y.Z)"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Download release tarball
|
||||
run: |
|
||||
# Anonymous on purpose: the App Store fetches this URL without
|
||||
# credentials, so a private or missing release has to fail here.
|
||||
curl -fsSL "$DOWNLOAD_URL" -o workflow_deck_automation.tar.gz
|
||||
|
||||
- name: Check version in tarball
|
||||
run: |
|
||||
VERSION=$(tar -xzOf workflow_deck_automation.tar.gz workflow_deck_automation/appinfo/info.xml \
|
||||
| sed -n 's:.*<version>\(.*\)</version>.*:\1:p')
|
||||
if [ "v$VERSION" != "$TAG" ]; then
|
||||
echo "::error::info.xml says version '$VERSION', tag is '$TAG'"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Sign and upload
|
||||
env:
|
||||
PRIVATE_KEY: ${{ secrets.APPSTORE_PRIVATE_KEY }}
|
||||
APPSTORE_TOKEN: ${{ secrets.APPSTORE_TOKEN }}
|
||||
run: |
|
||||
set -e
|
||||
if [ -z "$PRIVATE_KEY" ] || [ -z "$APPSTORE_TOKEN" ]; then
|
||||
echo "::error::APPSTORE_PRIVATE_KEY and APPSTORE_TOKEN must be set"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
KEY_FILE=$(mktemp)
|
||||
trap 'rm -f "$KEY_FILE"' EXIT
|
||||
chmod 600 "$KEY_FILE"
|
||||
printf '%s\n' "$PRIVATE_KEY" > "$KEY_FILE"
|
||||
|
||||
# -A keeps the base64 on one line, so it can go into the JSON as is.
|
||||
SIGNATURE=$(openssl dgst -sha512 -sign "$KEY_FILE" workflow_deck_automation.tar.gz | openssl base64 -A)
|
||||
|
||||
STATUS=$(curl -sS -o response.json -w '%{http_code}' -X POST \
|
||||
-H "Authorization: Token $APPSTORE_TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d "{\"download\":\"$DOWNLOAD_URL\",\"signature\":\"$SIGNATURE\",\"nightly\":false}" \
|
||||
https://apps.nextcloud.com/api/v1/apps/releases)
|
||||
|
||||
cat response.json; echo
|
||||
# 201 = new release, 200 = existing release replaced
|
||||
case "$STATUS" in
|
||||
200|201) echo "App Store accepted $TAG (HTTP $STATUS)" ;;
|
||||
*) echo "::error::App Store answered HTTP $STATUS"; exit 1 ;;
|
||||
esac
|
||||
@@ -1,220 +1,186 @@
|
||||
# CLAUDE.md
|
||||
|
||||
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
||||
Leitfaden für Claude Code (claude.ai/code) in diesem Repository.
|
||||
|
||||
## What this is
|
||||
## Worum es geht
|
||||
|
||||
A Nextcloud app (`workflow_deck_automation`, namespace `WorkflowDeckAutomation`) targeting **Nextcloud Hub 26 Spring (server 34.x)**. It lets each user configure, from their personal settings, automation "workflows" that move [Deck](https://github.com/nextcloud/deck) cards from one stack to another once their due date or start date has passed, with optional assigned-user/label filters and an email notification. A background `Job` evaluates all enabled workflows on every cron pass.
|
||||
Nextcloud-App `workflow_deck_automation` (Namespace `WorkflowDeckAutomation`) für **Nextcloud 35** (`main`, `min-version="35" max-version="35"`). Jeder Nutzer legt in seinen persönlichen Einstellungen „Workflows“ an, die [Deck](https://github.com/nextcloud/deck)-Karten von einem Stack in einen anderen verschieben, sobald ihr Fälligkeits- oder Startdatum erreicht ist (`trigger_date`, pro Workflow), optional mit Mail. Es gibt bewusst **keine Kartenfilter**: ein Workflow verschiebt *jede* Karte seines Quell-Stacks, deren Datum erreicht ist. Ein Hintergrund-`Job` wertet alle aktiven Workflows bei jedem Cron-Lauf aus.
|
||||
|
||||
## Non-negotiable architectural constraint
|
||||
## Harte Vorgabe: keine HTTP/OCS-Aufrufe gegen Deck
|
||||
|
||||
**No HTTP/OCS calls against Deck, anywhere.** Every read (boards, stacks, cards, labels, assigned users) and the card move itself must go through Deck's own internal PHP classes (`OCA\Deck\Service\CardService`, `StackService`, `BoardService`, `OCA\Deck\Db\CardMapper`, …), resolved in-process via `\OCP\Server::get()`. This was an explicit, repeated product requirement from the user — do not "fix" it by switching to `IClientService`/`curl` against `/ocs/...`, even though that would be the more conventional cross-app integration approach.
|
||||
Alle Lesezugriffe (Boards, Stacks, Karten) und das Verschieben laufen über Decks interne PHP-Klassen (`OCA\Deck\Service\*`, `OCA\Deck\Db\*`), in-process per `\OCP\Server::get()`. Das ist eine ausdrückliche, wiederholte Anforderung des Nutzers – nicht auf `IClientService`/`curl` gegen `/ocs/...` „umbauen“.
|
||||
|
||||
All Deck access is funneled through `lib/Service/DeckIntegrationService.php` — it is the *only* class that references `OCA\Deck\*`. If you need new Deck data, extend that class rather than reaching into Deck internals from elsewhere. Every call in there is wrapped (`class_exists()` checks, `IAppManager::isEnabledForUser('deck', …)`, try/catch → `DeckUnavailableException`) because `OCA\Deck\*` is not a documented/stable public API — it has no `@since` markers and can change between Deck releases without notice.
|
||||
**Nur `lib/Service/DeckIntegrationService.php` referenziert `OCA\Deck\*`.** Neue Deck-Daten → diese Klasse erweitern. Jeder Aufruf dort ist abgesichert (`class_exists()`, `IAppManager::isEnabledForUser('deck', …)`, try/catch → `DeckUnavailableException`), weil `OCA\Deck\*` keine stabile, dokumentierte API ist (keine `@since`-Marker).
|
||||
|
||||
## `method_exists()` cannot see Deck's getters — use `property_exists()`
|
||||
## Impersonation im Hintergrundjob – Decks eingefrorene `$userId`
|
||||
|
||||
`Card`, `Board`, `Label`, `Acl` and `Assignment` declare **no getters as real code**. `getStartdate()`, `getDuedate()`, `getDeletedAt()`, `getArchived()`, even `getId()` are `@method` docblocks resolved by `OCP\AppFramework\Db\Entity::__call()` (`Entity` itself declares neither `getId()` nor `setId()`). `method_exists()` ignores `__call()` by definition, so **every `method_exists($deckEntity, 'getSomething')` probe in this app is permanently false**, on every Deck version, and the guarded branch is dead code that fails open or closed without a sound.
|
||||
`WorkflowRunner` gruppiert Workflows nach Owner und impersoniert jeden nacheinander, in zwei Schritten (beide im `finally` via `clearImpersonation()` zurückgesetzt):
|
||||
|
||||
`DeckIntegrationService::getCardDate()` therefore probes `property_exists($card, 'startdate')` — the protected property declaration is visible, and it is exactly what `Entity::getter()` checks before throwing `BadFunctionCallException`. Use that shape for any new optional Deck field.
|
||||
1. `IUserSession::setUser()` + `IRootFolder::getUserFolder()` – für die wenigen Dienste, die die Session lesen. Nebensächlich.
|
||||
2. `DeckIntegrationService::beginUserContext()` – **der tragende Teil.**
|
||||
|
||||
**Known dead probes still in the tree** (each one a separate fix, none of them yet made — verify against a live instance before touching, since the symptoms are silent):
|
||||
**Deck liest für Berechtigungen nie die Session.** `PermissionService` (hinter jeder Prüfung, auch in `CardService::reorder()`), `CardService`, `BoardService` und `ActivityManager` halten `private ?string $userId` aus dem `userId`-Service des Deck-Containers – *shared*, also einmal pro Prozess aufgelöst. Im Cron ist das nie der impersonierte Nutzer, sondern `null` (wenn vorher ein Deck-Job lief) oder der erste Owner. `null` lässt jede Prüfung mit `NoPermissionException` scheitern.
|
||||
|
||||
- `getCardLabelIds()` / `extractParticipantUid()` — always return `[]`/`null`, so **label and assigned-user filters cannot match any card**, and ACL participants never reach the settings dropdown. Only the board owner survives, because `RelationalObject::getPrimaryKey()` *is* real code — which is why the bug is invisible on a private board (empty ACL, owner = the user themselves) and looks fixed.
|
||||
- `getActiveCardsInStack()`'s `getDeletedAt` check — trashed cards are moved.
|
||||
- `findStackIds()`'s `getDeletedAt` check — a board in the trash is not recognised as gone.
|
||||
- `isBoardHidden()` — dead, but masked by `getUserBoards(null, false)` doing the filtering server-side.
|
||||
`beginUserContext()` überschreibt daher das private Feld per Reflection und `endUserContext()` stellt es wieder her. `PermissionService` ist Pflicht: klappt das Pinnen nicht, wirft die Methode und der Runner **überspringt den Nutzer komplett**. Die anderen drei sind best effort (nur Activity-Zuordnung/Unread-Zähler).
|
||||
|
||||
## The Deck version floor lives in code, because info.xml cannot express it
|
||||
**Regel:** Bevor ein weiterer `OCA\Deck\*`-Dienst im Runner genutzt wird, prüfen, ob er eine eingefrorene `$userId` trägt – der Fehler ist still und nutzerübergreifend. Bevorzugt Mapper (QBMapper ohne Nutzerzustand) oder Methoden mit explizitem uid-Parameter verwenden. Deshalb wird `BoardService::getUserBoards()` nicht verwendet.
|
||||
|
||||
`DeckIntegrationService::MIN_DECK_VERSION` (`1.18.0`) plus the `version_compare()` in `assertDeckAvailable()` is the *only* enforcement point for "this app needs a recent Deck". Neither the server's `resources/app-info.xsd` nor the app store's `info.xsd` has an app-to-app dependency element — `<dependencies>` takes only `php`, `database`, `command`, `lib`, `owncloud`, `nextcloud`, `architecture`, `backend`. Don't go looking for a `<app min-version=…>`; it does not exist in either schema.
|
||||
Der Datumsvergleich `WorkflowRunner::hasPassed()`, `TriggerDate`, `LoopDetector` und die Empfängerregel `NotificationPolicy::shouldNotify()` sind bewusst `static` und seiteneffektfrei, also ohne Deck unit-testbar (`tests/Unit/Service/`). Das sind die einzigen getesteten Teile der App. Neue reine Logik in dieser Form halten.
|
||||
|
||||
`<nextcloud min-version="34" max-version="34"/>` already does most of the work and is the strictest pin available: **Deck 1.18.x is the only Deck release line declaring `>=34.0.0,<35.0.0`**, and 1.18.0 is exactly the release that added the card start date (`Card::$startdate`, PR #7749). So on any Nextcloud this app installs on, Deck already has that field, and 1.17.x cannot be enabled at all (its own `max-version` is 33, so a server upgrade to 34 disables it). What the version check still covers is a Deck dropped in by hand or checked out from git.
|
||||
## Workflows werden deaktiviert, wenn Board/Stack verschwinden
|
||||
|
||||
`version_compare()` sorts `1.18.0-beta.x` *below* `1.18.0`. That is intended — pre-releases of that line may predate the field. Since `assertDeckAvailable()` is called from both the controller (→ `OCSPreconditionFailedException`, visible as an error on the settings page) and the runner (→ skip + info log), a too-old Deck degrades in both places instead of failing halfway through a card move.
|
||||
`WorkflowRunner::findBrokenTarget()` prüft vor jedem Lauf Board und Stacks; fehlt etwas, wird der Workflow abgeschaltet (`enabled = false`) und einmalig gemailt. Invarianten:
|
||||
|
||||
## Per-user impersonation in the background job
|
||||
- **Nur positives Wissen deaktiviert.** `findStackIds()` liefert `null` nur bei „Board-Zeile weg“ (`DoesNotExistException`, Decks `NotFoundException`), „Board im Papierkorb“ (`deleted_at > 0`) oder „uid hat keine Leserechte“ – alles andere *wirft*, und der Runner überspringt den Workflow. Degradiert die Methode auf `[]`/`null`, deaktiviert ein Deck-Ausfall alle Workflows der Instanz und mailt alle Nutzer an.
|
||||
- **`findStackIds()` fragt nie einen Deck-Dienst, *wer* fragt.** Sie bekommt die uid als Argument und nutzt nur `BoardMapper`/`StackMapper` plus `PermissionService::getPermissions($boardId, $userId)` mit expliziter uid. Nicht zu `StackService::findAll($boardId)` „vereinfachen“ – genau das prüfte gegen die eingefrorene `null`-uid, warf `NoPermissionException`, wurde als „Board weg“ gelesen und verschickte Deaktivierungsmails für intakte Boards.
|
||||
- **`NoPermissionException` beweist nichts** und steht deshalb bewusst nicht in `isMissing()`.
|
||||
- **Die Deaktivierungsmail ignoriert `notifyMode` und `notifyChannel`** (die betreffen verschobene Karten) und geht immer nur an den Owner, zusätzlich als Nextcloud-Benachrichtigung, falls die Notifications-App aktiv ist. Sie bleibt einmalig, weil `findAllEnabled()` deaktivierte Workflows nicht mehr lädt.
|
||||
|
||||
`RunWorkflowsJob` has no logged-in user by default and must evaluate workflows belonging to many different users within one PHP process. `lib/Service/WorkflowRunner.php` therefore groups workflows by owner and impersonates each owner in turn. **Impersonation here is two steps, and `IUserSession::setUser()` is the one that barely matters:**
|
||||
Archivierte Boards lösen das nicht aus (sie bleiben lesbar). Ihre Workflows bleiben aktiv, werden aber übersprungen: `runWorkflow()` fragt nach `findBrokenTarget()` `DeckIntegrationService::isBoardArchived()` (`BoardMapper`, `false` bei fehlendem Board, sonst wirft es). Im Dropdown erscheinen archivierte Boards nie, auch nicht beim Bearbeiten (dann leert das Formular Board und Stapel und zeigt einen Hinweis). In der Übersicht werden sie markiert.
|
||||
|
||||
1. `IUserSession::setUser()` — for the handful of Nextcloud services that do read the live session, plus `IRootFolder::getUserFolder()` for Deck helpers that expect an initialised user FS.
|
||||
2. `DeckIntegrationService::beginUserContext()` — pins **Deck itself** to that user. This is the load-bearing half.
|
||||
## Ein Workflow gehört dem Board-Owner, nicht seinem Ersteller
|
||||
|
||||
Both are undone in a `finally` (`WorkflowRunner::clearImpersonation()`).
|
||||
Wird ein Board in Deck übertragen, wandern seine Workflows mit.
|
||||
|
||||
**Deck does not read the session for permissions. At all.** `PermissionService` — the class behind every permission check, including the ones inside `CardService::reorder()` — takes the current user as `private ?string $userId`, and so do `CardService`, `BoardService` and `ActivityManager`. That string comes from the app container's `userId` service, which is `ISession::get('user_id')` registered via `registerService()`, i.e. **shared**: Pimple resolves it once and caches it for the whole process, and `ServerContainer` caches Deck's app container just as long. Whoever was active when Deck's container first built `PermissionService` is who every later check is evaluated against.
|
||||
- **„Meine Boards“** = `listOwnedBoards($uid)` → `BoardMapper::findAllByOwner($uid)` (keine geteilten Boards, keine eingefrorene uid). Diese Mapper-Methode filtert weder Papierkorb noch Archiv: Papierkorb-Boards werden verworfen, archivierte mit `archived: true` behalten (Workflows sichtbar, aber nicht im Dropdown, von `validate()` abgelehnt, vom Runner übersprungen). Wirft statt `[]` zurückzugeben – `[]` würde alle Workflows des Nutzers verstecken.
|
||||
- **Auflisten/Bearbeiten/Löschen** nur über `board_id IN (listOwnedBoards)` (`WorkflowMapper::findAllForBoards()`, `WorkflowController::findOwnWorkflow()`). `user_id` spielt keine Rolle – keine `user_id`-Abfragen im Controller wieder einführen.
|
||||
- **Anlegen/Speichern** validiert gegen dieselbe Liste und setzt `user_id` auf den aktuellen Nutzer.
|
||||
- **Runner:** `followBoardOwner()` → `findBoardOwner()` (`BoardMapper::find()`) schreibt einen abweichenden Owner in `user_id` zurück. Lauf und Mails gehen also an den aktuellen Owner. Ein verschwundenes Board behält den letzten Owner, damit `findBrokenTarget()` ihn anmailen kann.
|
||||
|
||||
In cron that is *never* the user being impersonated: `null` if any Deck-owned background job ran earlier in the same `cron.php` pass, otherwise the first workflow owner touched. `null` fails every check, so Deck answers `NoPermissionException` for perfectly intact boards. This produced a real bug — see the next section. `beginUserContext()` therefore swaps that private field directly (there is no API), records the old value, and `endUserContext()` puts it back. `PermissionService` is mandatory: if it can't be pinned, `beginUserContext()` throws and the runner **skips that user entirely** rather than acting under someone else's permissions. The other three are best-effort (they only affect activity attribution and unread counts).
|
||||
`user_id` heißt also nur „als wer läuft der Job / wer bekommt Mail“.
|
||||
|
||||
Consequence for `getUserBoards()`: `listBoardsForCurrentUser()` stays **request-only** anyway — Deck may already have cached board lists behind that field, and the job has no use for a board *list*; it asks `findStackIds()` about one known board id. Before using any other `OCA\Deck\*` service from the runner, check whether it carries a frozen `$userId` — the failure mode is silent and user-crossing, not an error.
|
||||
## Mails über verschobene Karten folgen Decks Benachrichtigungseinstellung
|
||||
|
||||
The filter logic (`WorkflowRunner::cardMatchesFilters()`, `::hasPassed()`, `::findDeadFilters()`) is deliberately `static` and side-effect-free so it's unit-testable without a real Deck installation — see `tests/Unit/Service/WorkflowRunnerFilterTest.php`. Keep new pure logic in that shape; it is the only part of this app that has tests at all.
|
||||
`notify_mode` (`NotificationPolicy::MODES`) ersetzt seit `Version1002…`/`Version1003…` das frühere `notify_email` (`true` → `owner`):
|
||||
|
||||
## Due date or start date, per workflow
|
||||
- `off`: keine Mail. `owner`: nur der Board-Owner, ohne Rücksicht auf seine Deck-Einstellung (altes Verhalten).
|
||||
- `board`: alle Board-Berechtigten, gefiltert nach deren Deck-Nutzereinstellung `deck` / `board:<id>:notify-due` (`off`/`assigned`/`all`, Default `assigned`). `NotificationPolicy::shouldNotify()` bildet Decks Regel aus `NotificationHelper::sendCardDuedate()` nach und ist reine, getestete Logik. Dazu gehört: Der Owner eines ungeteilten Boards wird außer bei `off` immer benachrichtigt.
|
||||
- `DeckIntegrationService::findNotificationRecipients()` nutzt nur uid-explizite Bausteine: `PermissionService::findUsers($boardId, true)` (Owner + ACL, löst Gruppen/Circles auf, `true` umgeht den Prozess-Cache), `AssignmentMapper::isUserAssigned()` (auch Gruppen-/Circle-Zuweisungen) und `IConfig`. `FederatedUser` wird übersprungen. Bei jedem Fehler wirft die Methode, und der Runner verschickt dann **keine** Mail, statt an eine falsch aufgelöste Empfängerliste zu schicken.
|
||||
- Der Runner sammelt verschobene Karten in `$pendingNotices` und verschickt **nach** der Nutzer-Schleife (also ohne Impersonation) je nach `notify_channel` des Workflows eine Sammelmail pro Empfänger und Lauf und/oder eine Nextcloud-Benachrichtigung pro Karte.
|
||||
|
||||
Each workflow carries a `date_field` (`'due'` | `'start'`, `Workflow::DATE_FIELD_*`) deciding which Deck card date it watches. `WorkflowRunner::hasPassed()` (formerly `isOverdue()`) is one function for both, because the comparison is identical — the raw timestamp against `$now` — and the whole argument against Deck's day-truncating `getDaysUntilDue()` applies unchanged to the start date. What differs is only the wording, in the UI and in `NotificationMailer`.
|
||||
## Nextcloud-Benachrichtigungen sind ein zweiter Kanal, keine zweite Empfängerregel
|
||||
|
||||
Three places keep an unknown value from becoming a surprise trigger, and all three resolve **towards the due date**, because that is what every workflow meant before the choice existed:
|
||||
`notify_channel` (`NotificationPolicy::CHANNELS`: `mail`/`notification`/`both`, Default und Migrationswert `mail`, `Version1004…`) sagt nur, *wie* die über `notify_mode` ermittelten Empfänger informiert werden. `NotificationPolicy::sendsMail()`/`sendsNotification()` sind reine, getestete Logik. Unbekannte Werte zählen als `mail`.
|
||||
|
||||
- the column default `'due'`, which is also the entire migration for existing rows (`Version1001Date20260825120000`, a separate step because `Version1000…` is wrapped in `hasTable()` and would never reach an existing install),
|
||||
- `Workflow::getDateFieldOrDue()`, for entities that were never near the database and for hand-edited rows,
|
||||
- `DeckIntegrationService::CARD_DATE_PROPERTIES`'s `?? DEFAULT_CARD_DATE`.
|
||||
- **`NotificationPusher`** legt über `OCP\Notification\IManager` eine Benachrichtigung **pro Karte** an (Objekt `card`/Karten-ID, Subject `card_moved`) und räumt vorher per `markProcessed()` eine ältere zur selben Karte weg. Gespeichert werden nur Rohwerte (Titel, IDs), keine Texte.
|
||||
- **`Notification\Notifier`** (per `registerNotifierService()` in `Application::register()`) baut daraus deutsche Texte und ignoriert `$languageCode`. Titel sind Nutzereingaben und gehen nur als Rich-Objekte (`deck-card`, `deck-board`, `highlight`) in den Text, nie ins Template, sonst würde ein `{…}` im Titel als Platzhalter gelesen. Der Notifier fragt **Deck nicht**: Er läuft beim Abruf durch irgendeinen Nutzer, und Deck-Dienste hätten dort die eingefrorene uid.
|
||||
- **Ohne Notifications-App passiert nichts:** `NotificationPusher::isAvailableFor()` prüft `IAppManager::isEnabledForUser('notifications', $user)` pro Empfänger und kehrt stumm zurück. Kein Fallback auf Mail, kein Fehler-Log. Die Einstellungsseite bekommt denselben Check als `data-notifications-available` und zeigt dann einen Hinweis.
|
||||
- Push aufs Handy/Desktop ist Sache der Notifications-App (Push-Proxy bzw. `notify_push`), nicht dieser App.
|
||||
|
||||
The controller is the exception: it *rejects* an unknown `dateField` instead of normalising it, since a client asking for a rule it would not get should hear about it.
|
||||
## Nur Deutsch, keine Übersetzungen
|
||||
|
||||
## Workflows are auto-disabled when their Deck targets vanish
|
||||
Die App wird nur intern genutzt und spricht ausschließlich Deutsch. Oberfläche, Controller-Fehlermeldungen (erscheinen im Formular), Sektionsname, Mails und Nextcloud-Benachrichtigungen sind direkt auf Deutsch geschrieben. Es gibt kein `IL10N` und keinen `l10n/`-Ordner. Nextclouds eigene Mail-Fußzeile wird per `addFooter('', 'de')` ebenfalls deutsch, sonst würde sie im Cron der Instanz-Standardsprache folgen. Log-Meldungen bleiben englisch. Neue nutzersichtbare Texte auf Deutsch schreiben, mit „du“ wie im Rest der App.
|
||||
|
||||
`WorkflowRunner::findBrokenTarget()` checks board and stacks before every run and, if something is gone, switches the workflow off (`enabled = false`) and sends a one-off mail. Two invariants hold this together and must survive refactors:
|
||||
## Fälligkeits- oder Startdatum löst das Verschieben aus
|
||||
|
||||
- **Only positive knowledge disables.** `DeckIntegrationService::findStackIds()` returns `null` only for "board row gone" (`DoesNotExistException`, Deck's `NotFoundException`), "board in the trash" (`deleted_at > 0`), or "this uid has no read permission" — and *throws* for everything else. The runner skips the workflow on a throw. If you make that method degrade to `[]`/`null` on generic errors, a Deck outage will disable every workflow on the instance and mail every user about it.
|
||||
- **`findStackIds()` must never ask a Deck service to figure out *who* is asking.** It takes the uid as an argument and is assembled from pieces that cannot answer for the wrong user: `BoardMapper`/`StackMapper` are plain QBMappers with no user state, and `PermissionService::getPermissions($boardId, $userId)` is handed the uid explicitly instead of falling back to the frozen field. Do not "simplify" it back to a single `StackService::findAll($boardId)` — that is precisely what broke. `StackService::findAll()` runs `checkPermission()` with no uid, which falls through to the construction-time `$userId`; with that frozen to `null` in cron, Deck threw `NoPermissionException` for an untouched board, the old code read that as "board is gone", and users got "your workflow was deactivated" mails for boards sitting right in front of them. This layer stays correct even if `beginUserContext()` silently degrades.
|
||||
- **`NoPermissionException` is not evidence of anything.** It is deliberately *not* in `isMissing()`. Deck raises it for every failed check regardless of cause.
|
||||
- **The mail ignores the `notifyEmail` flag** — that flag is about moved cards; this is a notice that the user's configuration stopped working. It stays a one-off simply because a disabled workflow is not picked up by `findAllEnabled()` again.
|
||||
`trigger_date` (`TriggerDate::ALL`: `due`/`start`, Default und Migrationswert `due`, `Version1005…`) wählt pro Workflow, welches Kartendatum der Runner mit „jetzt“ vergleicht. Unbekannte Werte zählen als `due`. Karten ohne das gewählte Datum bleiben liegen.
|
||||
|
||||
Archived boards deliberately do *not* trigger this (they stay readable, so `findStackIds()` succeeds), even though they're filtered out of the settings dropdowns.
|
||||
- **`startdate` gibt es erst seit Deck 1.18.** `Card`-Getter sind magisch (`Entity::__call`), `method_exists()` sieht sie nicht und `getStartdate()` würde erst beim Aufruf werfen. Daher `DeckIntegrationService::supportsStartdate()` (`property_exists`). Der Runner liest `getStartdate()` nur bei `start` und überspringt solche Workflows ohne Deaktivierung, wenn Deck das Feld nicht kennt. Der Controller lehnt `start` dann ab.
|
||||
- **Texte:** `TriggerDate::describeReason()` liefert den Satzteil („ist überfällig“ / „hat ihr Startdatum erreicht“) für Mail und Notifier. `NotificationPusher` speichert `triggerDate` in den Subject-Parametern. Ältere Benachrichtigungen ohne den Schlüssel gelten als `due`.
|
||||
- **Empfänger:** Auch Startdatums-Workflows nutzen bei `notify_mode = board` Decks `notify-due`-Einstellung. Deck hat keine eigene für das Startdatum.
|
||||
|
||||
## Dead filters are surfaced, never disabled
|
||||
## Keine Schleifen, kein Quelle = Ziel
|
||||
|
||||
`findBrokenTarget()` covers the board and the two stacks — **not** `filter_user_ids` / `filter_label_ids`. Those are plain id lists compared with `array_intersect()` in `cardMatchesFilters()`, so an entry that no longer exists simply stops matching. With three labels of which one was deleted that is exactly right, and disabling would be wrong.
|
||||
Jeder aktive Workflow ist eine Kante „Quell-Stack → Ziel-Stack“. `LoopDetector` (rein, getestet) findet Kreise. „Quelle = Ziel“ ist ein Kreis der Länge 1. Das Auslöse-Datum wird bewusst ignoriert: Bei S1→S2 per Start und S2→S1 per Fälligkeit pendelt jede Karte, bei der beide Daten erreicht sind. Ohne Prüfung würde der Runner sie sogar im selben Lauf hin- und herschieben (jeder Workflow liest seinen Quell-Stack neu), mit einer Benachrichtigung pro Bewegung. Ketten sind erlaubt.
|
||||
|
||||
The pathological case is a filter whose entries are *all* gone: the workflow keeps running, updates `last_run`, and matches nothing — forever, with no mail, no log line and a healthy-looking row. It happens on deleted labels and just as easily on a user losing board access, because Deck's `BoardService::deleteAcl()` calls `assignedUsersMapper->deleteByParticipantOnBoard()` and wipes that user's card assignments.
|
||||
- **Controller:** `validate()` → `assertNoLoop()` lehnt einen *aktiven* Workflow ab, dessen Ziel über die anderen aktiven Workflows des Boards zu seiner Quelle zurückführt, und nennt sie. Deaktivierte Workflows zählen nicht. Beim Aktivieren läuft dieselbe Prüfung, weil auch das über `update()` geht.
|
||||
- **Runner und Liste:** Altbestand kann trotzdem Kreise bilden. `run()` überspringt alle Workflows auf einem Kreis (nur Log, keine Deaktivierung, keine Mail), und `index()` liefert `loop: true`, das die Oberfläche rot markiert.
|
||||
- Stack-IDs sind in Deck boardübergreifend eindeutig, deshalb darf der Runner alle Workflows der Instanz in einen Graphen werfen.
|
||||
|
||||
Two low-stakes signals, no state and no migration:
|
||||
## Fälligkeit wird als UTC-Zeitpunkt verglichen
|
||||
|
||||
- `WorkflowRunner::warnAboutDeadFilters()` logs a warning on every run.
|
||||
- `workflowIssues` in `src/PersonalSettings.vue` marks the row red.
|
||||
Decks `duedate` und `startdate` sind `DATETIME`-Spalten ohne Zeitzone mit UTC-Uhrzeit (Frontend sendet `toISOString()`). `Entity` baut daraus `new \DateTime($string)` in PHPs Standardzone, die Nextcloud auf UTC setzt. `WorkflowRunner::asStoredUtc()` legt die Uhrzeit trotzdem ausdrücklich auf UTC fest, damit das Ergebnis nicht von dieser Standardzone abhängt. Decks eigene Pfade `Card::getDaysUntilDue()` (tagesgenau) und `CardMapper::findOverdue()` (vergleicht mit dem `NOW()` der Datenbank, also Ortszeit) sind dafür ungeeignet und werden nicht verwendet.
|
||||
|
||||
Both obey the same rule as the disable path: **only positive knowledge**. `DeckIntegrationService::findFilterOptions()` therefore *throws* instead of degrading to `[]` — unlike its siblings `listLabels()`/`listParticipants()`, which are wrapped in `call(…, [])` for the dropdowns, where an empty list is harmless. On the JS side the per-board caches store `null` for a failed request, and `isDeadFilter()` returns false for `null`; storing `[]` there would report every stack and filter of the board as deleted the moment one request fails. Don't collapse those two states back together.
|
||||
## Kartenfilter wurden entfernt
|
||||
|
||||
Deliberately no mail and no `enabled = false`: one board edit can revive the filter, and there is no "already warned" column to keep a mail one-off with (unlike the disable case, which is one-off for free because a disabled workflow is never picked up again).
|
||||
Die früheren Filter (`filter_user_ids`/`filter_label_ids`) wurden auf Wunsch entfernt. `Version1001Date20260930120000` löscht die Spalten, und gefilterte Workflows laufen seitdem *ungefiltert* weiter (bewusste Entscheidung). Die Spalten müssen gelöscht bleiben: `Entity::fromRow()` ruft pro Spalte einen Setter auf, den `Workflow` nicht mehr hat. Mit entfernt wurden: Labels-/Participants-Endpunkte, `listLabels()`/`listParticipants()`/`findFilterOptions()` und `CardService::enrichCards()` in `getActiveCardsInStack()` (lief über `BoardService::find()` mit eingefrorener uid). Die Karten dort sind also **nicht angereichert** (keine `assignedUsers`/Labels).
|
||||
|
||||
## The job has no interval — one run per cron pass
|
||||
## Der Job hat kein Intervall
|
||||
|
||||
`RunWorkflowsJob` extends `OCP\BackgroundJob\Job`, **not** `TimedJob`, so it runs every time cron picks it up. There is no interval and no knob: the cadence *is* the instance's cron cadence. Don't reintroduce one — an earlier version read `workflow_deck_automation.interval` from `config.php` (default 300, 60s floor), and that config key is gone as of v0.2.0. `TimedJob` with `setInterval(0)` would behave nearly identically but keeps an interval concept nothing uses.
|
||||
`RunWorkflowsJob` erweitert `OCP\BackgroundJob\Job`, **nicht** `TimedJob`: ein Lauf pro Cron-Durchgang, kein Intervall, keine Konfiguration (der frühere `config.php`-Schlüssel `workflow_deck_automation.interval` ist seit v0.2.0 weg). Nicht wieder einführen.
|
||||
|
||||
**Time sensitivity is what actually decides whether the job runs at all.** `OC\Core\Service\CronService::runCli()` reads `maintenance_window_start` (default `100`, i.e. unset) and, whenever the current UTC hour is outside `[start, start+4]`, calls `jobList->getNext($onlyTimeSensitive = true)` — time-insensitive jobs are then skipped for the other 20 hours of the day. This app shipped `TIME_INSENSITIVE` once: on an instance with a maintenance window configured (Nextcloud's admin overview nags admins into setting one) the job simply never ran, showing `last_run = 1970-01-01` in `occ background-job:list` indefinitely. Note this gate only exists in `runCli()`, so it doesn't apply to ajax/webcron mode, and passing job classes explicitly (`occ background-job:worker '<class>'`) bypasses it — which is exactly why manual testing can look fine while cron does nothing.
|
||||
**Zeitkritikalität entscheidet, ob der Job überhaupt läuft.** `CronService::runCli()` holt außerhalb des Wartungsfensters (`maintenance_window_start` … +4 h UTC) nur zeitkritische Jobs (`getNext($onlyTimeSensitive = true)`). Eine frühere Version war `TIME_INSENSITIVE` und lief auf Instanzen mit Wartungsfenster nie (`last_run = 1970-01-01`). Manuelle Tests (`background-job:worker '<Klasse>'`, Ajax/Webcron) umgehen dieses Gate, deshalb wirkt dort alles normal.
|
||||
|
||||
Being a plain `Job` makes that unreachable rather than merely declared. `getNext()` filters on the `time_sensitive` *column* of `oc_jobs`; `JobList::add()` doesn't write the column at all (it takes the `TIME_SENSITIVE` default), and the only place that ever lowers it is a one-way ratchet in `JobList::setLastRun()`:
|
||||
|
||||
```php
|
||||
if ($job instanceof TimedJob && !$job->isTimeSensitive()) {
|
||||
$query->set('time_sensitive', $query->createNamedParameter(IJob::TIME_INSENSITIVE));
|
||||
}
|
||||
```
|
||||
|
||||
There is no `else`, and a non-`TimedJob` never enters it. Note `setTimeSensitivity()`/`isTimeSensitive()` live on `TimedJob`, not on `Job` — so there is nothing to declare here, and nothing that can go wrong.
|
||||
|
||||
**Rows written by an older version keep their stamp.** Once stamped `TIME_INSENSITIVE` it stays that way: re-registering an existing job (app update, `app:enable`) takes `add()`'s update branch, which leaves the column alone. An instance that ran the pre-v0.1.0-fix build still needs its row fixed once:
|
||||
Als einfacher `Job` ist das ausgeschlossen: `JobList::add()` schreibt die Spalte `time_sensitive` nicht (Default `TIME_SENSITIVE`), und nur `JobList::setLastRun()` senkt sie – ausschließlich für `TimedJob && !isTimeSensitive()`, ohne Rückweg. Alte, einmal als insensitive gestempelte Zeilen bleiben es (auch nach App-Update). Einmalig reparieren:
|
||||
|
||||
```sql
|
||||
UPDATE oc_jobs SET time_sensitive = 0
|
||||
WHERE class = 'OCA\\WorkflowDeckAutomation\\BackgroundJob\\RunWorkflowsJob';
|
||||
```
|
||||
|
||||
or, without DB access, `occ background-job:delete <id>` followed by `occ app:disable workflow_deck_automation && occ app:enable workflow_deck_automation` to get a freshly inserted row. Fresh installs are unaffected.
|
||||
oder `occ background-job:delete <id>`, dann `occ app:disable workflow_deck_automation && occ app:enable workflow_deck_automation`.
|
||||
|
||||
To debug this job on a server: `occ background-job:list --class '<class>'` for its id and last run, then `occ background-job:execute <id> --force-execute` to run it right now without waiting for cron. `occ background-job:worker` takes **job classes**, not an app id.
|
||||
Debuggen: `occ background-job:list --class '<Klasse>'` (ID, letzter Lauf), dann `occ background-job:execute <id> --force-execute`. `background-job:worker` erwartet **Job-Klassen**, keine App-ID.
|
||||
|
||||
## Registration is declarative, not Bootstrap-based
|
||||
## Registrierung deklarativ statt über Bootstrap
|
||||
|
||||
Background jobs and classic personal settings are registered in `appinfo/info.xml` (`<background-jobs>`, `<settings><personal>/<personal-section>`), **not** via `IRegistrationContext` in `lib/AppInfo/Application.php` — that interface has no `registerBackgroundJob()`/`registerSettings()` methods on NC 34. `Application.php` is intentionally near-empty.
|
||||
Hintergrundjob und persönliche Einstellungen stehen in `appinfo/info.xml` (`<background-jobs>`, `<settings><personal>/<personal-section>`). `IRegistrationContext` hat dafür keine Methoden. `lib/AppInfo/Application.php` ist absichtlich fast leer und registriert nur den `Notifier` (dafür gibt es keinen `info.xml`-Eintrag).
|
||||
|
||||
## Commands
|
||||
## Architektur
|
||||
|
||||
**PHP and npm are not available in the local dev sandbox this repo is normally edited from.** Do not try to run `composer`, `php`, or `npm` locally to verify changes — they will fail with "command not found". Verification happens by pushing to `main` (or opening a PR) and checking the Gitea Actions run; the self-hosted runner tag is `gitea-runner-server03` (see `.gitea/workflows/*.yml`, all pinned to that `runs-on:` label).
|
||||
- **UI:** `src/PersonalSettings.vue` (Vue 3), gemountet aus `templates/settings/personal.php` (Sektion: `lib/Settings/PersonalSection.php` + `Personal.php`) → `src/api.js` → `lib/Controller/WorkflowController.php` (`OCSController`, Routen in `appinfo/routes.php`, `/ocs/v2.php/apps/workflow_deck_automation/api/v1/...`).
|
||||
- **Speicher:** `lib/Db/Workflow.php` / `WorkflowMapper.php`, Tabelle `wfda_workflows` (Migrationen in `lib/Migration/`).
|
||||
- **Automation:** `RunWorkflowsJob` → `WorkflowRunner` → `DeckIntegrationService` (alle Deck-Aufrufe), `NotificationMailer` (`IMailer`, an die Account-Adressen der Empfänger, nie an eine eingegebene Adresse) und `NotificationPusher` (`IManager`, Texte aus `lib/Notification/Notifier.php`).
|
||||
- Controller (Dropdowns) und Runner (Karten lesen/verschieben) nutzen denselben `DeckIntegrationService`.
|
||||
- **Doku:** `README.md` richtet sich an Anwender und Admins und enthält keine Klassennamen. `DEVELOPMENT.md` ist für Entwickler (Aufbau, Datenmodell, Tests, CI, Release, Fehlersuche). Neue Nutzer-Funktionen in der README beschreiben, technische Details in `DEVELOPMENT.md`. Beide Dateien sind per `Makefile` vom Paket ausgeschlossen.
|
||||
|
||||
Commands as they'd run in CI/on a machine that has the tools:
|
||||
## Befehle und Verifikation
|
||||
|
||||
**Lokal gibt es kein PHP und kein npm** (Windows, siehe `CLAUDE.local.md`) – `composer`/`php`/`npm` nicht lokal ausführen. Verifiziert wird über Push/PR und den Gitea-Actions-Lauf (Runner `gitea-runner-server03`).
|
||||
|
||||
```bash
|
||||
composer install
|
||||
composer run lint # php -l over lib/ and tests/
|
||||
composer run cs:check # nextcloud/coding-standard (php-cs-fixer); composer run cs:fix to auto-fix
|
||||
composer run test:unit # PHPUnit — pure logic only, no live Deck/Nextcloud instance needed
|
||||
composer run lint # php -l über lib/ und tests/
|
||||
composer run cs:check # nextcloud/coding-standard; cs:fix korrigiert
|
||||
composer run test:unit # PHPUnit, nur reine Logik
|
||||
vendor/bin/phpunit --filter <testName> tests/Unit/Service/WorkflowRunnerTest.php
|
||||
|
||||
npm install # no package-lock.json is committed (gitignored) — use install, not `npm ci`
|
||||
npm run build # production build
|
||||
npm run watch # rebuild on change during development
|
||||
npm install # nicht `npm ci`: Lockfiles sind absichtlich nicht committet
|
||||
npm run build # bzw. npm run watch
|
||||
```
|
||||
|
||||
To run a single PHPUnit test: `vendor/bin/phpunit --filter testUserFilterIsOrAgainstAssignedUsers tests/Unit/Service/WorkflowRunnerFilterTest.php`.
|
||||
`composer.lock` und `package-lock.json` stehen in `.gitignore` → CI muss `composer install`/`npm install` verwenden (`npm ci` hat den Build schon einmal gebrochen). Die Deck-Integration lässt sich nur auf einer echten Nextcloud+Deck-Instanz testen.
|
||||
|
||||
There is no meaningful way to test the Deck integration itself outside a real Nextcloud+Deck instance (`php occ background-job:worker 'OCA\WorkflowDeckAutomation\BackgroundJob\RunWorkflowsJob'` — the argument is a job *class*, not an app id) — the unit tests intentionally stop at the pure filter logic.
|
||||
## Release und CI
|
||||
|
||||
### Release process
|
||||
**Versionsschema:** `<Nextcloud-Major>.<minor>.<patch>`. Die erste Zahl entspricht `min-/max-version` in `info.xml` und ändert sich nur mit der unterstützten NC-Major (dann `minor.patch` = `0.0`). `0.x`-Versionen stammen aus der Zeit davor. Die 34er-Linie existiert nur noch als Tags (`v34.*`). Kein Branch.
|
||||
|
||||
**Versioning scheme (from 34.0.0 on): `<nextcloud-major>.<minor>.<patch>`.** The leading number tracks the minimum/maximum Nextcloud major version declared in `appinfo/info.xml`'s `<dependencies><nextcloud .../>` (currently `min-version="34" max-version="34"`), not this app's own feature history - so it only changes when the supported Nextcloud major changes (e.g. dropping/adding NC 34 support bumps to `35.0.0`), and resets `minor`/`patch` to `0.0` at that point. Ordinary fixes/features within the same supported NC major bump `minor`/`patch` as usual (semver-ish, without a leading `0.`). Versions before `34.0.0` (`0.1.x`/`0.2.x`) predate this scheme.
|
||||
1. `<version>` in `appinfo/info.xml` und `version` in `package.json` synchron erhöhen.
|
||||
2. Committen, nach `main` pushen, `build-main.yml` muss grün sein.
|
||||
3. `git tag vX.Y.Z && git push origin vX.Y.Z` → Checks, Frontend-Build, `make appstore`, Release mit `workflow_deck_automation.tar.gz`.
|
||||
|
||||
1. Bump `<version>` in `appinfo/info.xml` and `version` in `package.json` (keep them in sync).
|
||||
2. Commit, push to `main`, confirm the run of `.gitea/workflows/build-main.yml` is green.
|
||||
3. `git tag vX.Y.Z && git push origin vX.Y.Z` — this triggers the tag branch of the same workflow, which re-runs the checks, builds the frontend, runs `make appstore`, and attaches `workflow_deck_automation.tar.gz` as the asset on a normal (non-pre-) release for that tag.
|
||||
Ist ein Tag-Build fehlgeschlagen und **nie ein Artefakt entstanden**, den Tag auf den Fix verschieben statt die Version zu erhöhen (`git tag -d vX.Y.Z && git tag -a vX.Y.Z -m "..." && git push origin :refs/tags/vX.Y.Z && git push origin vX.Y.Z`). Der Job löscht ein vorhandenes Release vorher. Nach einem veröffentlichten Artefakt den Tag nicht mehr verschieben.
|
||||
|
||||
**If the tagged build fails and no artifact was ever produced**, fix the issue on `main` and *move* the existing tag to the fixed commit instead of bumping to a new version number (`git tag -d vX.Y.Z && git tag -a vX.Y.Z -m "..." && git push origin :refs/tags/vX.Y.Z && git push origin vX.Y.Z`) — this is how `v0.1.0` was handled through several build fixes before it first built successfully. The job deletes any pre-existing *release* for the tag before creating the new one, so a moved tag republishes cleanly instead of failing on a duplicate asset name. Once a version has actually produced a published artifact, don't move its tag anymore; bump normally instead.
|
||||
**`.gitea/workflows/build-main.yml` ist der einzige Build-/Release-Workflow** (Checks `php-lint` mit PHP 8.4 und 8.5, `xml-lint`, `unit-tests` + Job `package`), damit `needs:` das Release an grüne Checks koppelt. Nicht wieder aufteilen.
|
||||
|
||||
**No `actions/upload-artifact` anywhere — and don't reintroduce it.** This self-hosted Gitea instance identifies as GHES to the official `actions/*` JS actions, which refuse to run `@actions/artifact` v2.0.0+ (used internally by `upload-artifact@v4` and later) against GHES: `GHESNotSupportedError`, which pinned us to `@v3` for a while. Publishing through the Gitea release REST API with `curl` sidesteps that version-specific backend API entirely, so the build workflow uses that instead. `actions/checkout` and `actions/setup-node` were never affected — only the artifact upload/download actions are, because they're the ones talking to a versioned backend rather than just running local commands — and can stay on their latest majors.
|
||||
**`.gitea/workflows/appstore.yml` ist nur manuell (`workflow_dispatch`) und soll so bleiben.** Er baut nicht selbst, sondern signiert den Tarball eines vorhandenen `v*`-Release und meldet dessen Gitea-Download-URL beim App Store an (Secrets `APPSTORE_PRIVATE_KEY`, `APPSTORE_TOKEN`). Signiert wird genau die Datei hinter der URL. Nach dem Store-Upload darf der Tag also nicht mehr verschoben werden, sonst passt die Signatur nicht mehr. `latest-main` wird abgelehnt. Kein `appinfo/signature.json` (Code-Signing): Das braucht der Store nicht, und Nextcloud prüft es bei Nicht-Core-Apps nur, wenn die Datei existiert.
|
||||
|
||||
### One workflow for everything
|
||||
- `package` baut *und* veröffentlicht in einem Job und braucht nur Node (`make appstore` ist reines `mkdir`/`tar`/`rm`).
|
||||
- Bei `pull_request` wird `Publish release` übersprungen (`if: gitea.event_name == 'push'`) und der Job ist nur ein Build-Check.
|
||||
- Push auf `main` → Pre-Release `latest-main`, Release *und* Tag werden jedes Mal neu erzeugt (Download-Link zeigt immer den neuesten Build). `v*`-Tag → normales Release. Dabei wird **nie der Tag** gelöscht (Flag `RECREATE_TAG`).
|
||||
- **Kein `actions/upload-artifact`:** Gitea gibt sich als GHES aus, `@actions/artifact` ≥ 2 verweigert dann (`GHESNotSupportedError`). Veröffentlicht wird per `curl` gegen die Gitea-Release-API. `checkout`/`setup-node` sind nicht betroffen.
|
||||
- **Kein PAT nötig:** Auth über das automatische `secrets.GITEA_TOKEN` mit `permissions: contents: write`. Bei 403: prüfen, ob die Token-Berechtigung des Repos/der Org auf *Restricted* steht (deckelt `permissions:`). Das ist eine Einstellung, kein Workflow-Bug.
|
||||
|
||||
`.gitea/workflows/build-main.yml` is the *only* workflow: it carries the checks (`php-lint` across 8.2/8.3/8.4, `xml-lint`, `unit-tests`) and the `package` job that builds and publishes. They used to be four separate workflow files, which meant they all triggered independently on the same push and a `latest-main` release was published even when PHPUnit was red. `needs:` only works between jobs of the same workflow (and Gitea's `workflow_run` can depend on one workflow at a time), so gating the release on the checks required merging them into this file. Don't split them back out.
|
||||
## Frontend-Build-Fallen (alle erst in CI aufgefallen)
|
||||
|
||||
Consequences of that shape, all intentional:
|
||||
- **`vite` muss zum Peer von `@nextcloud/vite-config` passen** (aktuell `vite@^7.3.6`), sonst `ERESOLVE`. Beim Update von `vite-config` dessen `peerDependencies.vite` prüfen.
|
||||
- **`"type": "module"` in `package.json`**, sonst scheitert `vite.config.js` am ESM-only-Paket.
|
||||
- **`tsconfig.json` und `typescript` als devDependency sind Pflicht**, obwohl es kein TypeScript gibt: `@nextcloud/vite-config` importiert über sein Barrel `vite-plugin-dts`, das `typescript` als Peer braucht. Ohne das Paket crasht es beim Laden (`Cannot read properties of undefined (reading 'useCaseSensitiveFileNames')`). `typescript` nahe an der Version von `vite-config` halten (aktuell `^5.9.3`).
|
||||
- **`createAppConfig` stellt die App-ID vor jeden Entry-Namen:** `personal-settings` → `js/workflow_deck_automation-personal-settings.mjs`. `Util::addScript()`/`addStyle()` in `lib/Settings/Personal.php` brauchen diesen vollen Namen (`Application::APP_ID . '-personal-settings'`). Falsch → **leere Einstellungsseite**, nur `Could not find resource …` im Log. Umbenennungen in `vite.config.js` auch dort nachziehen.
|
||||
- Die eigentliche CSS steckt in einem gehashten `*.chunk.css`. Die Entry-CSS ist ein ~100-Byte-Stub (`createEmptyCSSEntryPoints`). Das ist korrekt, also Code-Splitting nicht abschalten.
|
||||
|
||||
- **`package` builds *and* publishes in one job.** Handing the tarball to a separate publish job would need `actions/upload-artifact` (unusable here, see above) or `actions/cache` — a second Gitea backend API in the critical path for no gain.
|
||||
- **The workflow also runs on `pull_request`**, where the `Publish release` step is skipped via `if: gitea.event_name == 'push'` and the job degrades into a frontend-build check. That matters: `npm run build` used to run only on `main`, so no PR ever exercised it.
|
||||
- **Tags now get linted and tested too.** Previously the check workflows triggered only on `main` pushes and PRs, so a `v*` tag published completely unverified.
|
||||
## `@nextcloud/vue` 9 (Vue 3) – v8-Idiome scheitern still
|
||||
|
||||
It runs on pushes to `main` **and** on `v*` tags, and the publish step branches on `gitea.ref`:
|
||||
- **Kein `.sync`:** `NcTextField`/`NcCheckboxRadioSwitch` → `v-model`. `:value.sync` lässt den Wert auf dem Startwert stehen.
|
||||
- **`NcSelect`: `label` ist der Anzeige-Schlüssel der Optionen** (vue-select), die Beschriftung ist `input-label`. `label="Board"` rendert überall `undefined`.
|
||||
- **`NcButton`: `variant` = Stil, `type` = nativer Button-Typ**, `native-type` gibt es nicht mehr. Ein übrig gebliebenes `type="primary"` wird zu `submit`, und Abbrechen schickt das Formular ab.
|
||||
- `NcSelect`s `reduce` erreicht vue-select nur per Attribut-Fallthrough (funktioniert, ist aber undokumentiert).
|
||||
- `NcNoteCard` nutzt weiterhin `type` (`success|info|warning|error`).
|
||||
|
||||
- **`main`** → rolling pre-release tagged `latest-main`; both the release *and* the tag are deleted and recreated each run, so the download URL for `workflow_deck_automation.tar.gz` always serves the newest `main` build.
|
||||
- **`v*`** → normal release on the tag that was just pushed. Only a stale release is deleted here — **never the tag**, since deleting it would destroy the ref that triggered the run. That's what the `RECREATE_TAG` flag guards.
|
||||
## Deck-Interna, die man kennen muss
|
||||
|
||||
The `latest-main` half exists so a build can be grabbed and copied onto the server (`nextcloud.gnilebein.de`) without cutting a version tag first — it produced `v0.1.0`-shaped raw-repo confusion once already when the app directory was populated by copying the git working tree instead of a built package; this gives a one-click alternative to that mistake.
|
||||
|
||||
Note that `make appstore` is pure `mkdir`/`tar`/`rm` — no `composer`, no `php`. The `package` job therefore needs Node only; a `setup-php` step *there* would be dead weight (the deleted release workflow had one). PHP is set up in the check jobs, which is a different job and a different container.
|
||||
|
||||
**No manually created token is needed.** The publish step authenticates with `secrets.GITEA_TOKEN`, the token Gitea injects into every Actions job automatically (Gitea 1.27.1 here). The job declares `permissions: contents: write`, which Gitea maps to *Code: write* (needed to delete the `latest-main` tag) plus *Releases: write* (creating the release and uploading the asset).
|
||||
|
||||
This replaced an earlier hand-made `RELEASE_TOKEN` repo secret. If the publish step ever starts returning 403s, check the repo/org **default token permission mode**: `permissions:` requests are clamped by `MaxTokenPermissions`, so a repository switched from *Permissive* (the backwards-compatible default) to *Restricted* silently downgrades releases to read-only and no `permissions:` block can raise it back. That's a repo setting, not a workflow bug — don't "fix" it by reintroducing a PAT before checking.
|
||||
|
||||
## Data flow / architecture map
|
||||
|
||||
- **UI**: `src/PersonalSettings.vue` (Vue 3, mounted from `templates/settings/personal.php` into the section registered by `lib/Settings/PersonalSection.php` + `lib/Settings/Personal.php`) talks to `lib/Controller/WorkflowController.php` (an `OCSController`) via `src/api.js`, hitting OCS routes declared in `appinfo/routes.php` (`/ocs/v2.php/apps/workflow_deck_automation/api/v1/...`).
|
||||
- **Storage**: `lib/Db/Workflow.php` (Entity) / `lib/Db/WorkflowMapper.php` (QBMapper) over the `wfda_workflows` table, created in `lib/Migration/Version1000Date20260813120000.php`. Filter fields (`filter_user_ids`, `filter_label_ids`) are stored as JSON-encoded arrays in text columns, not join tables.
|
||||
- **Automation**: `lib/BackgroundJob/RunWorkflowsJob.php` (plain `Job`, one run per cron pass) → `lib/Service/WorkflowRunner.php` (per-user impersonation + filtering, both filters OR-within-themselves and AND-between-each-other) → `lib/Service/DeckIntegrationService.php` (all actual Deck class calls) and `lib/Service/NotificationMailer.php` (email via `OCP\Mail\IMailer` to the workflow owner's account address, never a manually-entered address).
|
||||
- Both the controller's board/stack/label/participant lookups (for populating the settings UI dropdowns) and the runner's card reads/moves go through the same `DeckIntegrationService` — there is no separate read path.
|
||||
|
||||
## Composer/npm lockfiles are intentionally not committed
|
||||
|
||||
`.gitignore` excludes `composer.lock` and `package-lock.json`. This means CI must use `composer install`/`npm install`, not `composer install --no-dev` assumptions tied to a lock file or `npm ci` (which hard-requires a lock file and will fail otherwise — this has already broken the build workflow once). If you add a lockfile-dependent step, either commit the lockfile deliberately or keep using the non-`ci`/non-locked install form.
|
||||
|
||||
## Frontend build gotchas already hit (don't reintroduce)
|
||||
|
||||
None of these were discoverable locally — there's no npm here (see "Local-only notes" below), so all three were only caught by an actual Gitea Actions run against the build workflow:
|
||||
|
||||
- **`vite` version must satisfy `@nextcloud/vite-config`'s peer requirement.** `package.json` pins `@nextcloud/vite-config` to `^2.2.0`, which currently resolves to `2.5.4` and peer-requires `vite@^7.3.6`. If you bump `@nextcloud/vite-config`, check its `peerDependencies.vite` and bump our `vite` devDependency to match, or `npm install` fails with `ERESOLVE`.
|
||||
- **`package.json` needs `"type": "module"`.** `vite.config.js` uses `import`/`export` syntax and `@nextcloud/vite-config` is ESM-only; without `"type": "module"`, Node treats `.js` as CommonJS and `vite build` fails trying to `require()` an ESM-only package.
|
||||
- **A `tsconfig.json` must exist at the repo root, even though this project has no TypeScript source.** `@nextcloud/vite-config`'s `index.js` barrel statically re-exports `createLibConfig` from `libConfig.js`, which imports `vite-plugin-dts` at module scope — that import chain runs just from importing `createAppConfig`, regardless of whether `createLibConfig` is ever called. The minimal `tsconfig.json` in this repo exists to give that a config to resolve, not because we write TypeScript. On its own this did **not** fix the crash below — see the next bullet.
|
||||
- **`typescript` must be an explicit devDependency.** `vite-plugin-dts` (pulled in transitively by the bullet above, version `^4.5.4` as of `@nextcloud/vite-config@2.5.4`) peer-depends on `typescript: "*"` but doesn't install it itself. Without a `typescript` devDependency in our own `package.json`, nothing provides that package, and `vite-plugin-dts`'s `@volar/typescript` integration crashes at module-load time — before `vite.config.js`'s own code or `tsconfig.json` are ever consulted — with `Cannot read properties of undefined (reading 'useCaseSensitiveFileNames')` (`proxyCreateProgram`). This is the actual fix; `tsconfig.json` existing is necessary but not sufficient. Keep `typescript` reasonably close to the version `@nextcloud/vite-config` itself develops against (currently `^5.9.3`) if you bump either.
|
||||
- **`createAppConfig` prefixes every entry name with the app id**, so the entry `personal-settings` is emitted as `js/workflow_deck_automation-personal-settings.mjs` and `css/workflow_deck_automation-personal-settings.css`. `Util::addScript()`/`addStyle()` take that *full on-disk basename* (minus extension), not the bare entry name — `lib/Settings/Personal.php` therefore passes `Application::APP_ID . '-personal-settings'`. Getting this wrong produces a **silently blank settings page**: the template's empty mount `<div>` renders fine, and the only symptom is `Could not find resource workflow_deck_automation/js/….js to load` (`jsresourceloader`) plus a matching `Could not find resource file "/apps/workflow_deck_automation/css/….css"` in `nextcloud.log`. If you rename the entry in `vite.config.js`, rename it in `Personal.php` too.
|
||||
- **The bulk of the CSS lives in a hashed `*.chunk.css`**, loaded at runtime by the `.mjs` bundle (`cssCodeSplit: true`). The `css/workflow_deck_automation-personal-settings.css` that `addStyle()` points at is the ~100-byte stub produced by `createEmptyCSSEntryPoints: true`. A near-empty entry CSS file is expected — don't "fix" it by turning off code splitting.
|
||||
|
||||
## `@nextcloud/vue` 9 component API (Vue 3) — the v8 idioms silently do nothing
|
||||
|
||||
This app is on `@nextcloud/vue` ^9 / Vue 3. The v8 (Vue 2) prop spellings that most Nextcloud app code online still uses either fail silently or, worse, land as stray DOM attributes instead of erroring:
|
||||
|
||||
- **No `.sync`.** Vue 3 removed it. `NcTextField` and `NcCheckboxRadioSwitch` both bind through `modelValue`/`update:modelValue`, so it's `v-model="x"` — `:value.sync="x"` / `:checked.sync="x"` leave the bound state permanently at its initial value. That's how `form.title` stayed `''` and every save died on "Bitte einen Titel angeben."
|
||||
- **`NcSelect`'s `label` prop is the *option display key*, not a caption** (it's vue-select's). Passing `label="Board"` makes it read `option.Board` on every option and render `undefined` for all of them. The visible caption prop is `input-label`.
|
||||
- **`NcButton`: `variant` is the style, `type` is the native button type**, and `native-type` no longer exists (v8's `type="primary"` + `native-type="submit"` → v9's `variant="primary"` + `type="submit"`). A leftover `type="primary"` renders `<button type="primary">`, which HTML treats as the invalid-value default `submit` — so a *cancel* button silently submits the form.
|
||||
- `NcSelect`'s `reduce` is not declared on `NcSelect` itself; it reaches vue-select through attribute fallthrough (NcSelect's root element *is* the `VueSelect` component and it doesn't set `inheritAttrs: false`). It works, but it's fallthrough, not a documented prop.
|
||||
- `NcNoteCard`'s prop is still `type` (`success|info|warning|error`) — not everything was renamed to `variant`.
|
||||
|
||||
## Deck entities are "relational": getters don't return the uid string
|
||||
|
||||
Deck's `RelationalEntity` swaps resolved relations for an `OCA\Deck\Db\RelationalObject` once an entity is enriched. So on an enriched board/card, `$acl->getParticipant()`, `$board->getOwner()` and a card assignment's participant return a `RelationalObject` (wrapping `OCA\Deck\Db\User`/`Group`/`Circle`), **not** a uid — the uid is its `getPrimaryKey()`. Probing for `getUID()` on the returned object finds nothing and yields `null`, which is how the settings UI's user dropdown came up empty *and* why the runner's assigned-user filter could never match. `DeckIntegrationService::unwrapUid()` handles both shapes (bare string and `RelationalObject`); route any new participant/owner field through it.
|
||||
|
||||
Two more Deck facts that bit us in the same pass: a board's ACL does **not** contain its owner (a private board has an empty ACL, so participants must be seeded with `$board->getOwner()`), and ACL entries can be groups (`type === 1`) whose members have to be expanded via `IGroupManager`.
|
||||
|
||||
**`BoardService::getUserBoards()` defaults to `$includeArchived = true`, and that flag also gates the `deleted_at = 0` condition** — with the default you get archived *and* trashed boards back. We call `getUserBoards(null, false)` (with a fallback to the no-arg form if Deck ever changes the signature) and still dedupe by id afterwards, because it merges own/group/circle boards and can return the same board twice. Stacks need no such handling: `StackMapper::findAll()` filters `deleted_at = 0` unconditionally and stacks have no archived state.
|
||||
|
||||
## Local-only notes
|
||||
|
||||
`CLAUDE.local.md` (gitignored) carries session-specific environment notes (e.g. "no PHP/npm available locally"). Check it at the start of work in this repo — it's not duplicated here since it can change independently of the committed guidance.
|
||||
- **Relationale Entities:** Auf angereicherten Entities liefern `$acl->getParticipant()`, `$board->getOwner()` oder Assignment-Teilnehmer ein `RelationalObject` statt einer uid (uid = `getPrimaryKey()`). Neue Teilnehmer-/Owner-Felder immer über `DeckIntegrationService::unwrapUid()` laufen lassen.
|
||||
- Die ACL eines Boards enthält **nicht** den Owner (privates Board = leere ACL). ACL-Einträge können Gruppen (`type === 1`) oder Circles sein.
|
||||
- `StackMapper::findAll()` filtert `deleted_at = 0` selbst. Stacks haben keinen Archivstatus.
|
||||
- **Entity-Getter sind magisch** (`Entity::__call`, z. B. `getDeletedAt()`, `getArchived()`, `getStartdate()`). `method_exists()` ist für sie immer `false`. Vorhandensein per `property_exists()` prüfen (`DeckIntegrationService::isTrashed()`/`isArchived()`/`supportsStartdate()`). Mit `method_exists()` wurden früher Karten aus dem Papierkorb verschoben, und Papierkorb- wie Archiv-Boards blieben unerkannt.
|
||||
- Der Deck-Quellcode liegt lokal unter `C:\Users\pani\Documents\git-privat\nextcloud-deck` und dient zum Nachprüfen von Interna.
|
||||
+136
@@ -0,0 +1,136 @@
|
||||
# Entwicklung
|
||||
|
||||
Informationen für Entwickler und Admins, die tiefer einsteigen. Die Nutzer-Doku steht in der [README](README.md). Ausführliche Hintergründe zu den Stolperfallen, also warum etwas genau so gebaut ist, stehen in [CLAUDE.md](CLAUDE.md).
|
||||
|
||||
## Aufbau
|
||||
|
||||
- **Keine HTTP/OCS-Aufrufe gegen Deck.** Lesen (Boards, Stapel, Karten, Board-Mitglieder) und das Verschieben laufen ausschließlich über Decks interne PHP-Klassen im selben Prozess. Sämtlicher Deck-Zugriff ist in [`lib/Service/DeckIntegrationService.php`](lib/Service/DeckIntegrationService.php) gebündelt.
|
||||
- `OCA\Deck\*` ist keine stabile öffentliche API. Jeder Zugriff ist deshalb abgesichert: `class_exists()`-Checks, Prüfung ob Deck aktiviert ist, try/catch mit Logging.
|
||||
- Nach größeren Deck-Updates lohnt sich ein Blick ins Nextcloud-Log.
|
||||
- **Hintergrundjob:** [`RunWorkflowsJob`](lib/BackgroundJob/RunWorkflowsJob.php) ist ein einfacher `Job` ohne Intervall. Er läuft bei jedem Cron-Durchlauf und ruft [`WorkflowRunner`](lib/Service/WorkflowRunner.php) auf.
|
||||
- **Rechte-Kontext:** Der Runner arbeitet die Workflows nach Eigentümer gruppiert ab und setzt Deck jeweils auf diesen Nutzer, per `DeckIntegrationService::beginUserContext()`. Decks Berechtigungsprüfungen lesen nämlich nicht die Session, sondern eine pro Prozess festgelegte Nutzer-ID.
|
||||
- **E-Mail:** [`NotificationMailer`](lib/Service/NotificationMailer.php) verschickt über Nextclouds `IMailer`. Die Empfänger ermittelt `DeckIntegrationService::findNotificationRecipients()`, die Entscheidungsregel steckt in [`NotificationPolicy`](lib/Service/NotificationPolicy.php).
|
||||
- **Nextcloud-Benachrichtigungen:** [`NotificationPusher`](lib/Service/NotificationPusher.php) legt sie über `OCP\Notification\IManager` an, eine pro Karte, an dieselben Empfänger wie die Mail. Er speichert nur Rohwerte. Den deutschen Text baut [`Notifier`](lib/Notification/Notifier.php), registriert in `Application::register()`. Ist die App `notifications` für einen Empfänger nicht aktiv, wird nichts angelegt. Push aufs Handy übernimmt die Notifications-App selbst.
|
||||
- **Oberfläche:** [`src/PersonalSettings.vue`](src/PersonalSettings.vue) (Vue 3, `@nextcloud/vue` 9) spricht über [`src/api.js`](src/api.js) mit dem OCS-Controller [`WorkflowController`](lib/Controller/WorkflowController.php).
|
||||
|
||||
## Datenmodell
|
||||
|
||||
Die Tabelle `wfda_workflows` enthält eine Zeile pro Workflow:
|
||||
|
||||
| Spalte | Bedeutung |
|
||||
| --- | --- |
|
||||
| `board_id`, `source_stack_id`, `target_stack_id` | Deck-IDs |
|
||||
| `user_id` | Board-Eigentümer, in dessen Namen der Job läuft. Wird bei jedem Lauf aus Deck aktualisiert. |
|
||||
| `trigger_date` | `due` oder `start`: Fälligkeits- oder Startdatum löst das Verschieben aus |
|
||||
| `notify_mode` | `off`, `owner` oder `board` (wer) |
|
||||
| `notify_channel` | `mail`, `notification` oder `both` (wie) |
|
||||
| `enabled`, `last_run` | aktiv? / letzter Lauf |
|
||||
|
||||
Migrationen in [`lib/Migration/`](lib/Migration/):
|
||||
- `Version1000…` legt die Tabelle an.
|
||||
- `Version1001…` entfernt die früheren Filter-Spalten.
|
||||
- `Version1002…` und `Version1003…` ersetzen `notify_email` durch `notify_mode`. Ein gesetztes Häkchen wird dabei zu `owner`.
|
||||
- `Version1004…` fügt `notify_channel` hinzu. Bestehende Workflows bekommen `mail`.
|
||||
- `Version1005…` fügt `trigger_date` hinzu. Bestehende Workflows bekommen `due`.
|
||||
|
||||
Migrationen laufen nur, wenn die App-Version steigt.
|
||||
|
||||
## Lokales Setup
|
||||
|
||||
Voraussetzungen: PHP 8.4+, Composer, Node.js 24 mit npm.
|
||||
|
||||
```bash
|
||||
composer install
|
||||
npm install # nicht `npm ci`: Lockfiles werden bewusst nicht committet
|
||||
npm run build # Produktions-Build
|
||||
npm run watch # Entwicklung mit automatischem Rebuild
|
||||
```
|
||||
|
||||
## Tests und Linting
|
||||
|
||||
```bash
|
||||
composer run lint # php -l über lib/ und tests/
|
||||
composer run cs:check # nextcloud/coding-standard (cs:fix korrigiert)
|
||||
composer run test:unit # PHPUnit
|
||||
```
|
||||
|
||||
Die Unit-Tests decken nur reine Logik ab, ohne Deck-Installation:
|
||||
- Datumsvergleich für Fälligkeits- und Startdatum (`WorkflowRunner::hasPassed()`)
|
||||
- Auslöser und Begründungstext (`TriggerDate`)
|
||||
- Schleifenerkennung (`LoopDetector`)
|
||||
- Empfängerregel (`NotificationPolicy::shouldNotify()`)
|
||||
- Benachrichtigungsweg (`NotificationPolicy::sendsMail()`/`sendsNotification()`)
|
||||
|
||||
Die Deck-Anbindung lässt sich nur auf einer echten Nextcloud-Instanz mit Deck testen:
|
||||
|
||||
```bash
|
||||
# Job-ID und letzten Lauf anzeigen
|
||||
php occ background-job:list --class 'OCA\WorkflowDeckAutomation\BackgroundJob\RunWorkflowsJob'
|
||||
|
||||
# Sofort ausführen, ohne auf Cron zu warten
|
||||
php occ background-job:execute <id> --force-execute
|
||||
```
|
||||
|
||||
## Build, CI und Release
|
||||
|
||||
`make appstore` erzeugt `build/artifacts/appstore/workflow_deck_automation.tar.gz`.
|
||||
|
||||
Gebaut und veröffentlicht wird in [`.gitea/workflows/build-main.yml`](.gitea/workflows/build-main.yml):
|
||||
|
||||
| Job | Zweck |
|
||||
| --- | --- |
|
||||
| `php-lint` | `php -l` mit PHP 8.4 und 8.5 |
|
||||
| `xml-lint` | prüft `appinfo/info.xml` gegen das Appstore-Schema |
|
||||
| `unit-tests` | PHPUnit |
|
||||
| `package` | Frontend-Build und `make appstore`. Läuft nur, wenn die Checks grün sind. |
|
||||
|
||||
Das Paket wird als Release veröffentlicht:
|
||||
- Bei jedem Push auf `main` als Pre-Release **`latest-main`**, das jedes Mal neu erzeugt wird.
|
||||
- Bei einem `v*`-Tag als reguläres Release.
|
||||
- Bei Pull Requests wird nur gebaut, nicht veröffentlicht.
|
||||
|
||||
**Versionen** folgen dem Schema `<Nextcloud-Major>.<minor>.<patch>`. Die unterstützte Nextcloud-Version steht in `appinfo/info.xml`.
|
||||
|
||||
Ablauf für ein Release:
|
||||
1. Version in `appinfo/info.xml` und `package.json` gleich anheben.
|
||||
2. Auf `main` pushen und warten, bis die Pipeline grün ist.
|
||||
3. `git tag -a vX.Y.Z -m "…" && git push origin vX.Y.Z`.
|
||||
4. Optional in den App Store: in Gitea unter *Actions* den Workflow „Publish to App Store“ von Hand starten und den Tag angeben.
|
||||
|
||||
### App Store
|
||||
|
||||
[`.gitea/workflows/appstore.yml`](.gitea/workflows/appstore.yml) läuft nur von Hand (`workflow_dispatch`). Er baut nichts selbst. Er lädt den Tarball eines vorhandenen `vX.Y.Z`-Release ohne Anmeldung herunter und prüft, ob die Version in `info.xml` zum Tag passt. Dann signiert er das Archiv (SHA-512) und meldet die Download-URL samt Signatur an die App-Store-API. Der Store lädt den Tarball danach selbst von Gitea. Die Releases müssen deshalb öffentlich erreichbar sein, und ein Tag darf nach dem Store-Upload nicht mehr verschoben werden.
|
||||
|
||||
Benötigte Repository-Secrets:
|
||||
|
||||
| Secret | Inhalt |
|
||||
| --- | --- |
|
||||
| `APPSTORE_PRIVATE_KEY` | privater Schlüssel (PEM), zu dem Nextcloud das App-Zertifikat ausgestellt hat |
|
||||
| `APPSTORE_TOKEN` | API-Token von <https://apps.nextcloud.com/account/token> |
|
||||
|
||||
Einmalig vorher: Zertifikat über [nextcloud/app-certificate-requests](https://github.com/nextcloud/app-certificate-requests) beantragen und die App auf apps.nextcloud.com registrieren. Die App wird nicht per Code-Signing (`appinfo/signature.json`) signiert. Nextcloud prüft Apps, die nicht zum Core gehören, nur dann, wenn diese Datei vorhanden ist.
|
||||
|
||||
Einzelheiten, etwa zum Verschieben eines Tags nach einem fehlgeschlagenen Build, stehen in [CLAUDE.md](CLAUDE.md).
|
||||
|
||||
## Fehlersuche: Der Job läuft nur nachts oder gar nicht
|
||||
|
||||
Nextcloud überspringt „nicht zeitkritische“ Jobs außerhalb des Wartungsfensters (`maintenance_window_start` in der `config.php`). Bis einschließlich v0.1.0 war dieser Job als nicht zeitkritisch markiert. Diese Markierung bleibt in der Spalte `oc_jobs.time_sensitive` stehen, auch nach App-Updates.
|
||||
|
||||
Symptom: Der Job läuft nur im 4-Stunden-Wartungsfenster, oder `occ background-job:list` zeigt als letzten Lauf `1970-01-01`.
|
||||
|
||||
Einmalig korrigieren:
|
||||
|
||||
```sql
|
||||
UPDATE oc_jobs SET time_sensitive = 0
|
||||
WHERE class = 'OCA\\WorkflowDeckAutomation\\BackgroundJob\\RunWorkflowsJob';
|
||||
```
|
||||
|
||||
Oder ohne Datenbankzugriff den Job löschen und durch Aus- und Einschalten der App neu registrieren:
|
||||
|
||||
```bash
|
||||
php occ background-job:delete <id>
|
||||
php occ app:disable workflow_deck_automation
|
||||
php occ app:enable workflow_deck_automation
|
||||
```
|
||||
|
||||
Die frühere `config.php`-Option `workflow_deck_automation.interval` (bis v0.1.0) wird ignoriert und kann entfernt werden.
|
||||
@@ -0,0 +1,661 @@
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero General Public License from time to time. Such new versions
|
||||
will be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU Affero General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU Affero General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU Affero General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
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
|
||||
(at your option) 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/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
@@ -24,6 +24,7 @@ appstore: clean
|
||||
--exclude=./.php-cs-fixer.cache \
|
||||
--exclude=./phpunit.xml \
|
||||
--exclude=./README.md \
|
||||
--exclude=./DEVELOPMENT.md \
|
||||
--exclude=./Makefile \
|
||||
--exclude=./CLAUDE.md \
|
||||
--exclude=./CLAUDE.local.md \
|
||||
|
||||
@@ -1,153 +1,115 @@
|
||||
# Deck Workflow-Automatisierung
|
||||
|
||||
Nextcloud-App für **Nextcloud Hub 26 Spring (Server 34.x)**, die Karten der [Deck](https://github.com/nextcloud/deck)-App automatisch von einem Stapel in einen anderen verschiebt, sobald ihr Fälligkeits- oder Startdatum erreicht ist, und optional eine E-Mail-Benachrichtigung verschickt.
|
||||
Nextcloud-App, die Karten der [Deck](https://apps.nextcloud.com/apps/deck)-App automatisch von einem Stapel in einen anderen verschiebt, sobald ihr Fälligkeits- oder Startdatum erreicht ist, und auf Wunsch per E-Mail oder Nextcloud-Benachrichtigung (Push) darüber informiert.
|
||||
|
||||
Setzt **Deck ab 1.18.0** voraus (die Version, die das Startdatum eingeführt hat) — auf Nextcloud 34 ist das automatisch erfüllt, da 1.18.x die einzige dort freigegebene Deck-Reihe ist.
|
||||
Die Regeln („Workflows“) richtet der **Eigentümer eines Boards** selbst in seinen **persönlichen Einstellungen** ein. Admin-Rechte braucht er dafür nicht. Für geteilte Boards anderer Nutzer lassen sich keine Workflows anlegen.
|
||||
|
||||
Ersetzt das früher genutzte eigenständige PHP-Cron-Skript durch eine vollwertige App mit Oberfläche in den **persönlichen Einstellungen** — jeder Nutzer kann dort seine eigenen Regeln ("Workflows") anlegen, ohne Admin-Rechte oder Server-Zugriff zu benötigen.
|
||||
> Entwickler-Informationen (Aufbau, Tests, Build, Release) stehen in [DEVELOPMENT.md](DEVELOPMENT.md).
|
||||
|
||||
## Funktionsumfang
|
||||
## Was die App macht
|
||||
|
||||
Pro Workflow lässt sich konfigurieren:
|
||||
Ein Workflow besteht aus einem Board, einem **Quell-Stapel**, einem **Ziel-Stapel** und dem **Datum**, das das Verschieben auslöst. Bei jedem Durchlauf verschiebt die App **alle Karten** des Quell-Stapels, bei denen dieses Datum erreicht ist, oben in den Ziel-Stapel.
|
||||
|
||||
- Quell-Board und Quell-Stapel
|
||||
- Ziel-Stapel, in den die Karten verschoben werden
|
||||
- **auslösendes Datum: Fälligkeitsdatum oder Startdatum der Karte** (Karten ohne das gewählte Datum werden nie verschoben; Regeln aus älteren Versionen laufen unverändert auf dem Fälligkeitsdatum)
|
||||
- optionaler Filter auf zugewiesene Benutzer (Karte muss **mindestens einem** der gewählten Benutzer zugewiesen sein)
|
||||
- optionaler Filter auf Labels/Tags (Karte muss **mindestens eines** der gewählten Labels haben)
|
||||
- Checkbox: E-Mail-Benachrichtigung an den Workflow-Besitzer, sobald eine Karte verschoben wurde
|
||||
- **Fälligkeitsdatum** (Standard): Die Karte wird verschoben, sobald sie überfällig ist, also ihr Fälligkeitsdatum samt Uhrzeit überschritten ist.
|
||||
- **Startdatum**: Die Karte wird verschoben, sobald ihr Startdatum samt Uhrzeit erreicht ist. Das Startdatum setzt du in Deck in den Kartendetails neben dem Fälligkeitsdatum.
|
||||
|
||||
Ein Nutzer kann beliebig viele Workflows anlegen, bearbeiten, deaktivieren oder löschen.
|
||||
Karten ohne das gewählte Datum sowie erledigte, archivierte oder gelöschte Karten bleiben liegen.
|
||||
|
||||
## Architektur
|
||||
Beispiele:
|
||||
- Ein Workflow „Waiting → ToDo“ holt jede Karte aus „Waiting / Blocked“ nach „Work in Progress / ToDo“, sobald ihr Fälligkeitsdatum erreicht ist.
|
||||
- Ein Workflow „Geplant → In Arbeit“ mit Startdatum holt jede Karte aus „Geplant“ nach „In Arbeit“, sobald an ihrem Startdatum die Arbeit beginnen soll.
|
||||
|
||||
- **Keine HTTP/OCS-Aufrufe gegen Deck.** Alles Lesen (Boards, Stapel, Karten, Labels, zugewiesene Benutzer) und das Verschieben von Karten läuft ausschließlich über Decks eigene interne PHP-Klassen (`OCA\Deck\Service\CardService`, `StackService`, `BoardService`, `OCA\Deck\Db\CardMapper`, …), aufgelöst per Dependency Injection direkt im selben PHP-Prozess. Sämtlicher Deck-Zugriff ist in [`lib/Service/DeckIntegrationService.php`](lib/Service/DeckIntegrationService.php) gebündelt.
|
||||
- **Hintergrundjob statt Seitenaufruf.** [`lib/BackgroundJob/RunWorkflowsJob.php`](lib/BackgroundJob/RunWorkflowsJob.php) ist ein einfacher `Job` ohne eigenes Intervall: Er läuft bei jedem Cron-Durchlauf von Nextcloud (üblicherweise alle 5 Minuten) und ruft [`lib/Service/WorkflowRunner.php`](lib/Service/WorkflowRunner.php) auf.
|
||||
- **Rechte-Kontext je Nutzer.** Ein Hintergrundjob hat standardmäßig keinen eingeloggten Nutzer, muss aber die Regeln mehrerer Nutzer in einem einzigen Lauf auswerten. Der `WorkflowRunner` "verkörpert" deshalb für die Dauer der jeweiligen Workflows kurzzeitig den entsprechenden Besitzer. Dazu gehört mehr als `IUserSession::setUser()`: Decks Berechtigungsprüfungen lesen die Session gar nicht, sondern eine Benutzer-ID, die beim Bau des Deck-Containers einmal pro Prozess eingefroren wird. `DeckIntegrationService::beginUserContext()` setzt diesen Wert für die Dauer der Verkörperung auf den Workflow-Besitzer und stellt ihn danach wieder her; schlägt das fehl, wird der Nutzer in diesem Lauf übersprungen, statt unter fremden Rechten zu arbeiten.
|
||||
- **E-Mail** läuft über Nextclouds eigenen `IMailer` (nutzt also den in der Nextcloud-Administration hinterlegten Mailserver) und geht an die im Profil des Workflow-Besitzers hinterlegte Adresse.
|
||||
## Einrichtung (für Administratoren)
|
||||
|
||||
### Wichtiger Hinweis zu Decks internen Klassen
|
||||
1. App nach `apps/workflow_deck_automation` auf den Server kopieren, zum Beispiel aus dem Release-Archiv `workflow_deck_automation.tar.gz`, und unter *Apps* aktivieren.
|
||||
2. Die [Deck-App](https://apps.nextcloud.com/apps/deck) muss installiert und für die Nutzer aktiviert sein.
|
||||
3. Die [Hintergrundjobs](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/background_jobs_configuration.html) müssen auf *Cron* stehen.
|
||||
4. Für E-Mails muss in der Nextcloud-Administration ein Mailserver eingerichtet sein.
|
||||
5. Für Nextcloud-Benachrichtigungen muss die App **Benachrichtigungen** (`notifications`) aktiviert sein, was sie standardmäßig ist. Fehlt sie, verschickt die App einfach keine Benachrichtigungen. E-Mails kommen trotzdem.
|
||||
|
||||
`OCA\Deck\*` ist keine dokumentierte, stabile öffentliche API von Deck (keine `@since`-Markierungen, keine offizielle Zusicherung von Abwärtskompatibilität). Diese App verwendet sie trotzdem bewusst direkt, wie es die Vorgabe verlangt — jeder Zugriff läuft defensiv abgesichert über `DeckIntegrationService` (Prüfung, ob Deck aktiviert ist, `class_exists()`-Checks, try/catch mit Logging statt Absturz). Nach größeren Deck-Updates lohnt sich ein Blick ins Nextcloud-Log, falls Workflows plötzlich nicht mehr greifen.
|
||||
Die Workflows laufen bei **jedem** Cron-Durchlauf von Nextcloud, üblicherweise alle 5 Minuten. Ein eigenes Intervall gibt es nicht.
|
||||
|
||||
## Installation
|
||||
## Workflows anlegen
|
||||
|
||||
1. App in `apps/workflow_deck_automation` des Nextcloud-Servers ablegen (oder über den Appstore-Build aus der CI, siehe unten).
|
||||
2. In der Nextcloud-Administration unter *Apps* aktivieren.
|
||||
3. Die [Deck-App](https://apps.nextcloud.com/apps/deck) muss installiert und für die jeweiligen Nutzer aktiviert sein.
|
||||
4. Sicherstellen, dass der [Hintergrundjob-Modus](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/background_jobs_configuration.html) auf *Cron (empfohlen)* steht, damit `RunWorkflowsJob` regelmäßig läuft.
|
||||
Die Einstellungen liegen unter **Persönliche Einstellungen → Deck Workflow-Automatisierung**. Dort legst du Workflows an und kannst sie bearbeiten, deaktivieren oder löschen.
|
||||
|
||||
## Benutzung
|
||||
- **Board:** Zur Auswahl stehen nur Boards, deren **Eigentümer** du bist. Geteilte, archivierte und gelöschte Boards erscheinen nicht.
|
||||
- **Quell- und Ziel-Stapel:** Das müssen zwei verschiedene Stapel desselben Boards sein.
|
||||
- **Karte verschieben, wenn:** das Fälligkeitsdatum überschritten oder das Startdatum erreicht ist.
|
||||
- **Keine Schleifen:** Ein aktiver Workflow darf mit den anderen aktiven Workflows des Boards keinen Kreis bilden, etwa „A → B“ und „B → A“. Sonst würden Karten bei jedem Durchlauf hin- und hergeschoben. Beim Speichern wird das abgelehnt, mit den Namen der beteiligten Workflows. Das gilt unabhängig davon, ob die Workflows nach Fälligkeits- oder Startdatum verschieben. Ketten wie „A → B“ und „B → C“ sind erlaubt.
|
||||
- **Benachrichtigung bei verschobenen Karten** und **Benachrichtigen per:** siehe unten.
|
||||
- **Workflow aktiv:** Deaktivierte Workflows bleiben gespeichert, verschieben aber nichts.
|
||||
|
||||
Jeder Nutzer findet die Einstellungen unter **Persönliche Einstellungen → Deck Workflow-Automatisierung**. Dort können neue Workflows angelegt, bestehende bearbeitet oder gelöscht werden. Die Dropdowns für Board/Stapel/Label/Benutzer werden live aus Deck geladen. Zur Auswahl stehen nur aktive Boards — archivierte und im Papierkorb liegende Boards sowie gelöschte Stapel blendet Deck bzw. die App aus.
|
||||
Ein Workflow gehört immer dem Eigentümer des Boards. Überträgst du ein Board in Deck an jemand anderen, wandern seine Workflows mit: Der neue Eigentümer sieht und verwaltet sie ab sofort, und die Karten werden in seinem Namen verschoben.
|
||||
|
||||
### Gelöschte Boards und Stapel
|
||||
## Benachrichtigungen
|
||||
|
||||
Ein Workflow verweist per ID auf ein Board und zwei Stapel. Wird eines davon in Deck gelöscht, passiert Folgendes:
|
||||
Pro Workflow stellst du ein, **wer** über verschobene Karten informiert wird und **wie**.
|
||||
|
||||
- **Beim Speichern** werden Board und Stapel geprüft; ein Workflow auf nicht mehr existierende Ziele lässt sich gar nicht erst anlegen.
|
||||
- **In der Übersicht** wird ein betroffener Workflow rot markiert („Board nicht mehr vorhanden", „Quell-Stapel nicht mehr vorhanden" …).
|
||||
- **Im Hintergrundjob** wird der Workflow automatisch deaktiviert und der Besitzer einmalig per E-Mail informiert — unabhängig davon, ob für den Workflow „E-Mail senden" aktiviert ist, denn hier geht es nicht um verschobene Karten, sondern darum, dass die Automatisierung nicht mehr läuft. Danach bleibt es still: Ein deaktivierter Workflow wird nicht erneut ausgewertet.
|
||||
### Wer?
|
||||
|
||||
Ist Deck vorübergehend nicht erreichbar, wird **nicht** deaktiviert — der Job überspringt den Workflow und versucht es beim nächsten Lauf erneut. Archivierte Boards lösen die Deaktivierung ebenfalls nicht aus, sie sind nur in den Auswahlfeldern ausgeblendet.
|
||||
|
||||
### Gelöschte Labels und entfernte Benutzer
|
||||
|
||||
Filter sind ein anderer Fall: Sie werden **nicht** deaktiviert. Wird eines von drei ausgewählten Labels gelöscht, greifen die anderen beiden weiter — das abzuschalten wäre falsch.
|
||||
|
||||
Problematisch ist nur der Grenzfall, dass **alle** Einträge eines Filters verschwunden sind. Der Workflow läuft dann weiter, kann aber keine einzige Karte mehr treffen. Das passiert bei gelöschten Labels und ebenso, wenn ein gefilterter Benutzer die Board-Freigabe verliert — Deck entfernt dabei alle seine Kartenzuweisungen auf diesem Board.
|
||||
|
||||
Damit dieser Zustand nicht unsichtbar bleibt:
|
||||
|
||||
- **In der Übersicht** wird der Workflow rot markiert („Label-Filter trifft keine Karte mehr", „Benutzer-Filter trifft keine Karte mehr").
|
||||
- **Im Hintergrundjob** landet bei jedem Lauf eine Warnung im `nextcloud.log`.
|
||||
|
||||
Keine E-Mail und keine Deaktivierung: Ein einziger Board-Klick kann den Filter wieder lebendig machen. Und wie bei Board und Stapel gilt auch hier — lässt sich das Board gerade nicht abfragen, wird nichts gemeldet statt etwas Falsches.
|
||||
|
||||
## Ausführungstakt
|
||||
|
||||
Der Hintergrundjob hat **kein eigenes Intervall** und ist auch nicht konfigurierbar: Er läuft bei **jedem** Cron-Durchlauf von Nextcloud. Der Takt ist damit exakt der des System-Crons — üblicherweise alle 5 Minuten, bei einem häufiger eingerichteten Cron entsprechend öfter.
|
||||
|
||||
> Bis einschließlich v0.1.0 gab es dafür die `config.php`-Option `workflow_deck_automation.interval`. Sie ist entfallen und wird ignoriert; ein vorhandener Eintrag kann aus der `config.php` entfernt werden.
|
||||
|
||||
### Der Job läuft nur nachts bzw. gar nicht
|
||||
|
||||
Nextcloud merkt sich in der Spalte `time_sensitive` der Tabelle `oc_jobs`, ob ein Job zeitkritisch ist, und überspringt „unkritische" Jobs außerhalb des Wartungsfensters. `JobList::setLastRun()` setzt diese Spalte nur in eine Richtung — von „zeitkritisch" auf „unkritisch", nie zurück. Wer eine ältere Version dieser App installiert hatte (bis einschließlich v0.1.0 war der Job `TIME_INSENSITIVE`), hat diesen Stempel noch in der Datenbank. Er wird weder durch ein App-Update noch durch `app:enable` zurückgesetzt.
|
||||
|
||||
Symptom: Ist in der `config.php` ein `maintenance_window_start` gesetzt, läuft der Job nur in diesem 4-Stunden-Fenster und den Rest des Tages gar nicht.
|
||||
|
||||
Einmalig korrigieren:
|
||||
|
||||
```sql
|
||||
UPDATE oc_jobs SET time_sensitive = 0
|
||||
WHERE class = 'OCA\\WorkflowDeckAutomation\\BackgroundJob\\RunWorkflowsJob';
|
||||
```
|
||||
|
||||
Ohne Datenbankzugriff geht es auch über `occ`, indem der Job gelöscht und durch Aus-/Einschalten der App neu registriert wird:
|
||||
|
||||
```bash
|
||||
php occ background-job:list --class 'OCA\WorkflowDeckAutomation\BackgroundJob\RunWorkflowsJob'
|
||||
php occ background-job:delete <id>
|
||||
php occ app:disable workflow_deck_automation
|
||||
php occ app:enable workflow_deck_automation
|
||||
```
|
||||
|
||||
Neuinstallationen sind nicht betroffen.
|
||||
|
||||
## Entwicklung
|
||||
|
||||
Voraussetzungen: PHP 8.2+, Composer, Node.js 24+, npm 11+.
|
||||
|
||||
```bash
|
||||
composer install
|
||||
npm install
|
||||
npm run build # einmaliger Produktions-Build
|
||||
npm run watch # Entwicklung mit automatischem Rebuild
|
||||
```
|
||||
|
||||
### Tests & Linting
|
||||
|
||||
```bash
|
||||
composer run lint # php -l über lib/ und tests/
|
||||
composer run cs:check # nextcloud/coding-standard (php-cs-fixer)
|
||||
composer run test:unit # PHPUnit — reine Filter-Logik, benötigt keine Deck-Installation
|
||||
```
|
||||
|
||||
Ein echter End-to-End-Test (Karte anlegen, Workflow konfigurieren, Hintergrundjob auslösen, Verschiebung + Mail prüfen) lässt sich nur gegen eine echte Nextcloud-34-Instanz mit installierter Deck-App durchführen, z. B. per:
|
||||
|
||||
```bash
|
||||
# Job-ID und letzten Lauf anzeigen
|
||||
php occ background-job:list --class 'OCA\WorkflowDeckAutomation\BackgroundJob\RunWorkflowsJob'
|
||||
|
||||
# Sofort ausführen, ohne auf den nächsten Cron-Durchlauf zu warten
|
||||
php occ background-job:execute <id> --force-execute
|
||||
|
||||
# Oder dauerhaft als Worker laufen lassen (Argument ist die Job-Klasse, keine App-ID)
|
||||
php occ background-job:worker 'OCA\WorkflowDeckAutomation\BackgroundJob\RunWorkflowsJob'
|
||||
```
|
||||
|
||||
### Release-Paket bauen
|
||||
|
||||
```bash
|
||||
make appstore
|
||||
```
|
||||
|
||||
Erzeugt `build/artifacts/appstore/workflow_deck_automation.tar.gz`.
|
||||
|
||||
## CI (Gitea Actions)
|
||||
|
||||
In [`.gitea/workflows/`](.gitea/workflows/):
|
||||
|
||||
| Workflow | Zweck |
|
||||
| Einstellung | Wer wird informiert? |
|
||||
| --- | --- |
|
||||
| `lint-php.yml` | `php -l` über eine PHP-8.2–8.4-Matrix |
|
||||
| `lint-info-xml.yml` | validiert `appinfo/info.xml` gegen das Appstore-XML-Schema |
|
||||
| `phpunit.yml` | führt die PHPUnit-Tests aus (SQLite/rein logisch, kein DB-Service nötig) |
|
||||
| `build-main.yml` | baut Frontend + Appstore-Archiv und veröffentlicht es als Release-Asset — bei Push auf `main` als rollendes Pre-Release `latest-main`, bei Push eines `v*`-Tags als reguläres Release |
|
||||
| **Keine Benachrichtigung** | niemand |
|
||||
| **Nur an mich** | der Eigentümer des Boards, unabhängig von seinen Deck-Einstellungen |
|
||||
| **An Board-Mitglieder laut ihrer Deck-Einstellung** | alle, die das Board sehen dürfen, je nach ihrer eigenen Deck-Einstellung (siehe unten) |
|
||||
|
||||
## Datenmodell
|
||||
Bei der dritten Stufe entscheidet jedes Board-Mitglied selbst. Dazu gehören der Eigentümer, Personen mit Freigabe sowie Mitglieder freigegebener Gruppen und Teams. Die Einstellung liegt in Deck im Menü **…** neben dem Board unter **Fälligkeitserinnerungen**:
|
||||
|
||||
Workflows werden in der Tabelle `wfda_workflows` gespeichert (siehe [`lib/Migration/Version1000Date20260813120000.php`](lib/Migration/Version1000Date20260813120000.php)): eine Zeile pro Workflow, mit `user_id`-Bezug, Board-/Stapel-IDs, JSON-kodierten Filterlisten sowie `enabled`/`notify_email`/`last_run`.
|
||||
- **Alle Karten:** für jede verschobene Karte
|
||||
- **Zugewiesene Karten** (Deck-Standard): nur für Karten, denen man zugewiesen ist, direkt oder über eine Gruppe oder ein Team
|
||||
- **Keine Benachrichtigungen:** nie
|
||||
|
||||
Bei einem Board, das mit niemandem geteilt ist, bekommt der Eigentümer jede Karte gemeldet, außer er hat die Erinnerungen ausgeschaltet. So verhält sich auch Deck selbst.
|
||||
|
||||
Das gilt genauso für Workflows mit Startdatum. Deck hat für das Startdatum keine eigene Benachrichtigungseinstellung.
|
||||
|
||||
### Wie?
|
||||
|
||||
| Einstellung | Was kommt an? |
|
||||
| --- | --- |
|
||||
| **E-Mail** (Standard) | eine Sammel-E-Mail pro Durchlauf |
|
||||
| **Nextcloud-Benachrichtigung (Push)** | eine Benachrichtigung pro Karte in der Glocke oben rechts und als Push-Nachricht in den Nextcloud-Apps auf Handy und Desktop |
|
||||
| **E-Mail und Nextcloud-Benachrichtigung** | beides |
|
||||
|
||||
Die Empfänger sind in allen drei Fällen dieselben.
|
||||
|
||||
**Inhalt der E-Mail:** Jeder Empfänger bekommt pro Durchlauf höchstens **eine** E-Mail, auch wenn mehrere Karten verschoben wurden. Pro Karte steht darin ein Satz wie:
|
||||
|
||||
> „Essensvorräte prüfen“ (Board „Persönlich“) ist überfällig und wurde von „Waiting / Blocked“ nach „Work in Progress / ToDo“ verschoben.
|
||||
|
||||
Bei Workflows mit Startdatum heißt es stattdessen:
|
||||
|
||||
> „Essensvorräte prüfen“ (Board „Persönlich“) hat ihr Startdatum erreicht und wurde von „Geplant“ nach „In Arbeit“ verschoben.
|
||||
|
||||
Der Kartentitel ist ein Link direkt zur Karte in Deck. Die Kartenbeschreibung wird nicht mitgeschickt.
|
||||
|
||||
**Inhalt der Nextcloud-Benachrichtigung:** „*Kartentitel* wurde nach *Ziel-Stapel* verschoben“, darunter Board, Quell-Stapel und ob die Karte überfällig ist oder ihr Startdatum erreicht hat. Ein Klick öffnet die Karte. Wird dieselbe Karte später noch einmal verschoben, ersetzt die neue Benachrichtigung die alte.
|
||||
|
||||
**Keine E-Mail erhalten?**
|
||||
- Ist in deinem Nextcloud-Profil eine E-Mail-Adresse hinterlegt? Ohne Adresse wird die E-Mail übersprungen.
|
||||
- Welche Stufe und welcher Weg sind im Workflow eingestellt?
|
||||
- Bei „An Board-Mitglieder“: Was steht in Deck unter *Fälligkeitserinnerungen* für dieses Board?
|
||||
|
||||
**Keine Push-Nachricht erhalten?**
|
||||
- Ist die App *Benachrichtigungen* aktiviert? Die Einstellungsseite weist darauf hin, wenn nicht.
|
||||
- Für Push aufs Handy muss dort die Nextcloud-App angemeldet sein und Benachrichtigungen erlauben.
|
||||
|
||||
Deck schickt zusätzlich seine eigene Erinnerung, wenn eine Karte fällig wird. Sie kommt von Deck, nicht von dieser App, und lässt sich in Deck unter *Fälligkeitserinnerungen* abschalten.
|
||||
|
||||
## Wenn Board oder Stapel gelöscht werden
|
||||
|
||||
- **In der Übersicht** wird der Workflow rot markiert, zum Beispiel „Board nicht mehr vorhanden“ oder „Quell-Stapel nicht mehr vorhanden“.
|
||||
- **Beim nächsten Durchlauf** wird der Workflow automatisch deaktiviert. Der Eigentümer bekommt einmalig eine E-Mail und, wenn die App *Benachrichtigungen* aktiv ist, eine Nextcloud-Benachrichtigung. Das gilt unabhängig davon, was für verschobene Karten eingestellt ist. Danach kommt keine weitere Erinnerung.
|
||||
- **Schleifen aus älteren Workflows** (gespeichert vor der Schleifenprüfung) werden in der Übersicht rot markiert und beim Durchlauf übersprungen, bis du einen der Workflows änderst oder deaktivierst.
|
||||
- **Archivierte Boards** deaktivieren den Workflow nicht. Er bleibt gespeichert, wird aber in der Übersicht markiert („Board archiviert, wird übersprungen“) und verschiebt nichts, bis du das Board in Deck aus dem Archiv holst. Archivierte Boards lassen sich auch nicht auswählen. Beim Bearbeiten eines solchen Workflows musst du ein anderes Board wählen.
|
||||
- **Ist Deck vorübergehend nicht erreichbar**, passiert nichts: Der Workflow wird übersprungen und beim nächsten Durchlauf erneut versucht.
|
||||
|
||||
Um einen deaktivierten Workflow wieder zu nutzen, stellst du ein vorhandenes Board und vorhandene Stapel ein und aktivierst ihn wieder.
|
||||
|
||||
## Sprache
|
||||
|
||||
Die App ist für den internen Einsatz gedacht und durchgehend **deutsch**: Oberfläche, Fehlermeldungen, E-Mails und Benachrichtigungen.
|
||||
|
||||
## Lizenz
|
||||
|
||||
|
||||
+15
-21
@@ -4,49 +4,43 @@
|
||||
<id>workflow_deck_automation</id>
|
||||
<name lang="de">Deck Workflow-Automatisierung</name>
|
||||
<name lang="en">Deck Workflow Automation</name>
|
||||
<summary lang="de">Verschiebt Deck-Karten automatisch anhand konfigurierbarer Regeln</summary>
|
||||
<summary lang="en">Automatically moves Deck cards based on configurable rules</summary>
|
||||
<summary lang="de">Verschiebt Deck-Karten automatisch, sobald ihr Fälligkeits- oder Startdatum erreicht ist</summary>
|
||||
<summary lang="en">Automatically moves Deck cards once their due date or start date is reached</summary>
|
||||
<description lang="de"><![CDATA[
|
||||
Diese App erlaubt es jedem Nutzer, in den persönlichen Einstellungen eigene Automatisierungs-Workflows für die Deck-App anzulegen:
|
||||
Diese App erlaubt es jedem Nutzer, in den persönlichen Einstellungen Automatisierungs-Workflows für seine eigenen Deck-Boards anzulegen:
|
||||
|
||||
* Quell-Board und Quell-Stapel wählen
|
||||
* Ziel-Stapel wählen, in den die Karten verschoben werden
|
||||
* je Regel wählen, ob das Fälligkeits- oder das Startdatum der Karte ausgewertet wird
|
||||
* optional nach zugewiesenen Benutzern filtern
|
||||
* optional nach Labels/Tags filtern
|
||||
* optional eine E-Mail-Benachrichtigung an sich selbst aktivieren
|
||||
* wählen, ob das Fälligkeitsdatum oder das Startdatum der Karte das Verschieben auslöst
|
||||
* optional benachrichtigen, per E-Mail und/oder als Nextcloud-Benachrichtigung (Push): nur sich selbst oder alle Board-Mitglieder gemäß ihrer Deck-Benachrichtigungseinstellung
|
||||
|
||||
Ein Hintergrundjob prüft regelmäßig alle aktiven Workflows und verschiebt Karten, deren gewähltes Datum in der Vergangenheit liegt, ausschließlich über die internen PHP-Klassen der Deck-App (keine HTTP/OCS-Aufrufe).
|
||||
|
||||
Voraussetzung: Nextcloud 34 und die Deck-App ab Version 1.18.0 – die einzige Deck-Reihe, die für Nextcloud 34 freigegeben ist.
|
||||
Ein Hintergrundjob prüft regelmäßig alle aktiven Workflows und verschiebt Karten, deren Fälligkeits- bzw. Startdatum erreicht wurde.
|
||||
]]></description>
|
||||
<description lang="en"><![CDATA[
|
||||
This app lets every user configure their own Deck automation workflows from Personal settings:
|
||||
This app lets every user configure Deck automation workflows for the boards they own from Personal settings:
|
||||
|
||||
* pick a source board and source stack
|
||||
* pick a destination stack the cards get moved to
|
||||
* pick, per rule, whether the card's due date or its start date is evaluated
|
||||
* optionally filter by assigned users
|
||||
* optionally filter by labels/tags
|
||||
* optionally enable an email notification to themselves
|
||||
* choose whether the card's due date or start date triggers the move
|
||||
* optionally notify by email and/or Nextcloud notification (push): themselves only, or every board member according to their Deck notification setting
|
||||
|
||||
A background job periodically evaluates all enabled workflows and moves cards whose chosen date lies in the past, using Deck's own internal PHP classes only (no HTTP/OCS calls).
|
||||
|
||||
Requires Nextcloud 34 and Deck 1.18.0 or newer - the only Deck release line supported on Nextcloud 34.
|
||||
A background job periodically evaluates all enabled workflows and moves cards whose due date or start date has been reached.
|
||||
]]></description>
|
||||
<version>34.1.0</version>
|
||||
<version>35.4.0</version>
|
||||
<licence>agpl</licence>
|
||||
<author mail="patrick@niebel.ing">Patrick Niebeling</author>
|
||||
<namespace>WorkflowDeckAutomation</namespace>
|
||||
<category>organization</category>
|
||||
<category>tools</category>
|
||||
<bugs>https://github.com/pniebeling/workflow_deck_automation/issues</bugs>
|
||||
<website>https://gitea.gnilebein.de/gnilebein/nextcloud-workflow-deck-automation</website>
|
||||
<bugs>https://gitea.gnilebein.de/gnilebein/nextcloud-workflow-deck-automation/issues</bugs>
|
||||
<repository type="git">https://gitea.gnilebein.de/gnilebein/nextcloud-workflow-deck-automation.git</repository>
|
||||
<dependencies>
|
||||
<php min-version="8.4" max-version="8.5"/>
|
||||
<database min-version="9.4">pgsql</database>
|
||||
<database>sqlite</database>
|
||||
<database min-version="8.0">mysql</database>
|
||||
<nextcloud min-version="34" max-version="34"/>
|
||||
<nextcloud min-version="35" max-version="35"/>
|
||||
</dependencies>
|
||||
<background-jobs>
|
||||
<job>OCA\WorkflowDeckAutomation\BackgroundJob\RunWorkflowsJob</job>
|
||||
|
||||
@@ -11,7 +11,5 @@ return [
|
||||
|
||||
['name' => 'workflow#boards', 'url' => '/api/v1/boards', 'verb' => 'GET'],
|
||||
['name' => 'workflow#stacks', 'url' => '/api/v1/boards/{boardId}/stacks', 'verb' => 'GET'],
|
||||
['name' => 'workflow#labels', 'url' => '/api/v1/boards/{boardId}/labels', 'verb' => 'GET'],
|
||||
['name' => 'workflow#participants', 'url' => '/api/v1/boards/{boardId}/participants', 'verb' => 'GET'],
|
||||
],
|
||||
];
|
||||
@@ -4,6 +4,7 @@ declare(strict_types=1);
|
||||
|
||||
namespace OCA\WorkflowDeckAutomation\AppInfo;
|
||||
|
||||
use OCA\WorkflowDeckAutomation\Notification\Notifier;
|
||||
use OCP\AppFramework\App;
|
||||
use OCP\AppFramework\Bootstrap\IBootContext;
|
||||
use OCP\AppFramework\Bootstrap\IBootstrap;
|
||||
@@ -16,7 +17,13 @@ class Application extends App implements IBootstrap {
|
||||
parent::__construct(self::APP_ID);
|
||||
}
|
||||
|
||||
/**
|
||||
* Background job and settings are declared in info.xml; the notifier is
|
||||
* the one thing that has to be registered here. Without the
|
||||
* notifications app it is simply never asked.
|
||||
*/
|
||||
public function register(IRegistrationContext $context): void {
|
||||
$context->registerNotifierService(Notifier::class);
|
||||
}
|
||||
|
||||
public function boot(IBootContext $context): void {
|
||||
|
||||
@@ -8,6 +8,9 @@ use OCA\WorkflowDeckAutomation\Db\Workflow;
|
||||
use OCA\WorkflowDeckAutomation\Db\WorkflowMapper;
|
||||
use OCA\WorkflowDeckAutomation\Service\DeckIntegrationService;
|
||||
use OCA\WorkflowDeckAutomation\Service\DeckUnavailableException;
|
||||
use OCA\WorkflowDeckAutomation\Service\LoopDetector;
|
||||
use OCA\WorkflowDeckAutomation\Service\NotificationPolicy;
|
||||
use OCA\WorkflowDeckAutomation\Service\TriggerDate;
|
||||
use OCP\AppFramework\Db\DoesNotExistException;
|
||||
use OCP\AppFramework\Http;
|
||||
use OCP\AppFramework\Http\Attribute\NoAdminRequired;
|
||||
@@ -33,47 +36,53 @@ class WorkflowController extends OCSController {
|
||||
private function currentUserId(): string {
|
||||
$user = $this->userSession->getUser();
|
||||
if ($user === null) {
|
||||
throw new OCSPreconditionFailedException('Not logged in');
|
||||
throw new OCSPreconditionFailedException('Nicht angemeldet');
|
||||
}
|
||||
return $user->getUID();
|
||||
}
|
||||
|
||||
/**
|
||||
* Every workflow on a board the user owns, no matter who created it: a
|
||||
* workflow belongs to its board's owner, and follows the board when
|
||||
* Deck transfers it.
|
||||
*/
|
||||
#[NoAdminRequired]
|
||||
public function index(): DataResponse {
|
||||
$workflows = $this->workflowMapper->findAllForUser($this->currentUserId());
|
||||
return new DataResponse(array_map(static fn (Workflow $w) => $w->jsonSerialize(), $workflows));
|
||||
$workflows = $this->workflowMapper->findAllForBoards($this->ownedBoardIds());
|
||||
|
||||
// validate() keeps new loops out, but workflows stored before that
|
||||
// check can still form one; the runner skips them, the list says why.
|
||||
$looping = LoopDetector::findLoopingWorkflows(LoopDetector::edgesOf(
|
||||
array_filter($workflows, static fn (Workflow $w) => (bool)$w->getEnabled()),
|
||||
));
|
||||
|
||||
return new DataResponse(array_map(
|
||||
static fn (Workflow $w) => $w->jsonSerialize() + ['loop' => in_array((int)$w->getId(), $looping, true)],
|
||||
$workflows,
|
||||
));
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string[] $filterUserIds
|
||||
* @param int[] $filterLabelIds
|
||||
*/
|
||||
#[NoAdminRequired]
|
||||
public function create(
|
||||
string $title,
|
||||
int $boardId,
|
||||
int $sourceStackId,
|
||||
int $targetStackId,
|
||||
array $filterUserIds = [],
|
||||
array $filterLabelIds = [],
|
||||
string $dateField = Workflow::DATE_FIELD_DUE,
|
||||
bool $notifyEmail = false,
|
||||
string $triggerDate = TriggerDate::DUE,
|
||||
string $notifyMode = NotificationPolicy::MODE_OFF,
|
||||
string $notifyChannel = NotificationPolicy::CHANNEL_MAIL,
|
||||
bool $enabled = true,
|
||||
): DataResponse {
|
||||
$this->validate($title, $boardId, $sourceStackId, $targetStackId, $dateField);
|
||||
$this->validate(null, $title, $boardId, $sourceStackId, $targetStackId, $triggerDate, $notifyMode, $notifyChannel, $enabled);
|
||||
|
||||
$workflow = new Workflow();
|
||||
$workflow->setUserId($this->currentUserId());
|
||||
$this->applyFields($workflow, $title, $boardId, $sourceStackId, $targetStackId, $filterUserIds, $filterLabelIds, $dateField, $notifyEmail, $enabled);
|
||||
$this->applyFields($workflow, $title, $boardId, $sourceStackId, $targetStackId, $triggerDate, $notifyMode, $notifyChannel, $enabled);
|
||||
|
||||
$workflow = $this->workflowMapper->insert($workflow);
|
||||
return new DataResponse($workflow->jsonSerialize(), Http::STATUS_CREATED);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string[] $filterUserIds
|
||||
* @param int[] $filterLabelIds
|
||||
*/
|
||||
#[NoAdminRequired]
|
||||
public function update(
|
||||
int $id,
|
||||
@@ -81,21 +90,18 @@ class WorkflowController extends OCSController {
|
||||
int $boardId,
|
||||
int $sourceStackId,
|
||||
int $targetStackId,
|
||||
array $filterUserIds = [],
|
||||
array $filterLabelIds = [],
|
||||
string $dateField = Workflow::DATE_FIELD_DUE,
|
||||
bool $notifyEmail = false,
|
||||
string $triggerDate = TriggerDate::DUE,
|
||||
string $notifyMode = NotificationPolicy::MODE_OFF,
|
||||
string $notifyChannel = NotificationPolicy::CHANNEL_MAIL,
|
||||
bool $enabled = true,
|
||||
): DataResponse {
|
||||
$this->validate($title, $boardId, $sourceStackId, $targetStackId, $dateField);
|
||||
$workflow = $this->findOwnWorkflow($id);
|
||||
$this->validate($id, $title, $boardId, $sourceStackId, $targetStackId, $triggerDate, $notifyMode, $notifyChannel, $enabled);
|
||||
|
||||
try {
|
||||
$workflow = $this->workflowMapper->findForUser($id, $this->currentUserId());
|
||||
} catch (DoesNotExistException $e) {
|
||||
throw new OCSNotFoundException('Workflow not found');
|
||||
}
|
||||
|
||||
$this->applyFields($workflow, $title, $boardId, $sourceStackId, $targetStackId, $filterUserIds, $filterLabelIds, $dateField, $notifyEmail, $enabled);
|
||||
// Kept in step with the board owner so the job runs as, and mails,
|
||||
// the right user; validate() made sure the editor owns the board.
|
||||
$workflow->setUserId($this->currentUserId());
|
||||
$this->applyFields($workflow, $title, $boardId, $sourceStackId, $targetStackId, $triggerDate, $notifyMode, $notifyChannel, $enabled);
|
||||
$workflow = $this->workflowMapper->update($workflow);
|
||||
|
||||
return new DataResponse($workflow->jsonSerialize());
|
||||
@@ -103,12 +109,7 @@ class WorkflowController extends OCSController {
|
||||
|
||||
#[NoAdminRequired]
|
||||
public function destroy(int $id): DataResponse {
|
||||
try {
|
||||
$workflow = $this->workflowMapper->findForUser($id, $this->currentUserId());
|
||||
} catch (DoesNotExistException $e) {
|
||||
throw new OCSNotFoundException('Workflow not found');
|
||||
}
|
||||
|
||||
$workflow = $this->findOwnWorkflow($id);
|
||||
$this->workflowMapper->delete($workflow);
|
||||
return new DataResponse([]);
|
||||
}
|
||||
@@ -116,7 +117,7 @@ class WorkflowController extends OCSController {
|
||||
#[NoAdminRequired]
|
||||
public function boards(): DataResponse {
|
||||
$this->assertDeck();
|
||||
return new DataResponse($this->deckService->listBoardsForCurrentUser());
|
||||
return new DataResponse($this->ownedBoards());
|
||||
}
|
||||
|
||||
#[NoAdminRequired]
|
||||
@@ -125,42 +126,70 @@ class WorkflowController extends OCSController {
|
||||
return new DataResponse($this->deckService->listStacks($boardId));
|
||||
}
|
||||
|
||||
#[NoAdminRequired]
|
||||
public function labels(int $boardId): DataResponse {
|
||||
$this->assertDeck();
|
||||
return new DataResponse($this->deckService->listLabels($boardId));
|
||||
private function findOwnWorkflow(int $id): Workflow {
|
||||
try {
|
||||
$workflow = $this->workflowMapper->findById($id);
|
||||
} catch (DoesNotExistException $e) {
|
||||
throw new OCSNotFoundException('Workflow nicht gefunden');
|
||||
}
|
||||
|
||||
if (!in_array($workflow->getBoardId(), $this->ownedBoardIds(), true)) {
|
||||
// Same answer as for a missing id: don't reveal other users' workflows.
|
||||
throw new OCSNotFoundException('Workflow nicht gefunden');
|
||||
}
|
||||
return $workflow;
|
||||
}
|
||||
|
||||
#[NoAdminRequired]
|
||||
public function participants(int $boardId): DataResponse {
|
||||
/**
|
||||
* @return array<int, array{id: int, title: string, archived: bool}>
|
||||
*/
|
||||
private function ownedBoards(): array {
|
||||
$userId = $this->currentUserId();
|
||||
$this->assertDeck();
|
||||
return new DataResponse($this->deckService->listParticipants($boardId));
|
||||
try {
|
||||
return $this->deckService->listOwnedBoards($userId);
|
||||
} catch (DeckUnavailableException $e) {
|
||||
throw new OCSPreconditionFailedException('Deine Deck-Boards konnten nicht geladen werden: ' . $e->getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return int[]
|
||||
*/
|
||||
private function ownedBoardIds(): array {
|
||||
return array_map(static fn (array $board) => $board['id'], $this->ownedBoards());
|
||||
}
|
||||
|
||||
private function assertDeck(): void {
|
||||
$user = $this->userSession->getUser();
|
||||
if ($user === null) {
|
||||
throw new OCSPreconditionFailedException('Not logged in');
|
||||
throw new OCSPreconditionFailedException('Nicht angemeldet');
|
||||
}
|
||||
try {
|
||||
$this->deckService->assertDeckAvailable($user);
|
||||
} catch (DeckUnavailableException $e) {
|
||||
throw new OCSPreconditionFailedException('Deck is not available: ' . $e->getMessage());
|
||||
throw new OCSPreconditionFailedException('Deck ist nicht verfügbar: ' . $e->getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
private function validate(string $title, int $boardId, int $sourceStackId, int $targetStackId, string $dateField): void {
|
||||
/**
|
||||
* @param ?int $id the workflow being changed, `null` for a new one
|
||||
*/
|
||||
private function validate(?int $id, string $title, int $boardId, int $sourceStackId, int $targetStackId, string $triggerDate, string $notifyMode, string $notifyChannel, bool $enabled): void {
|
||||
if (trim($title) === '') {
|
||||
throw new OCSBadRequestException('Title must not be empty');
|
||||
throw new OCSBadRequestException('Bitte einen Titel angeben.');
|
||||
}
|
||||
if ($sourceStackId === $targetStackId) {
|
||||
throw new OCSBadRequestException('Source and target stack must differ');
|
||||
throw new OCSBadRequestException('Quell- und Ziel-Stapel müssen sich unterscheiden.');
|
||||
}
|
||||
// Rejected rather than silently normalised to 'due': a client sending
|
||||
// something else is asking for a rule it would not get, and the runner
|
||||
// falls back to the due date without a word.
|
||||
if (!in_array($dateField, Workflow::DATE_FIELDS, true)) {
|
||||
throw new OCSBadRequestException('Unknown date field: ' . $dateField);
|
||||
if (!TriggerDate::isValid($triggerDate)) {
|
||||
throw new OCSBadRequestException('Ungültiges Datum für die Verschiebung, erlaubt sind: ' . implode(', ', TriggerDate::ALL));
|
||||
}
|
||||
if (!NotificationPolicy::isValidMode($notifyMode)) {
|
||||
throw new OCSBadRequestException('Ungültige Benachrichtigungs-Einstellung, erlaubt sind: ' . implode(', ', NotificationPolicy::MODES));
|
||||
}
|
||||
if (!NotificationPolicy::isValidChannel($notifyChannel)) {
|
||||
throw new OCSBadRequestException('Ungültiger Benachrichtigungsweg, erlaubt sind: ' . implode(', ', NotificationPolicy::CHANNELS));
|
||||
}
|
||||
|
||||
// Reject references to boards or stacks that are gone (or were never
|
||||
@@ -168,13 +197,22 @@ class WorkflowController extends OCSController {
|
||||
// assertDeck() ran first, so an empty list here means "not there",
|
||||
// not "Deck is unreachable".
|
||||
$this->assertDeck();
|
||||
if ($triggerDate === TriggerDate::START && !$this->deckService->supportsStartdate()) {
|
||||
throw new OCSBadRequestException('Die installierte Deck-Version kennt kein Startdatum.');
|
||||
}
|
||||
|
||||
$boardIds = array_map(
|
||||
static fn (array $board) => (int)$board['id'],
|
||||
$this->deckService->listBoardsForCurrentUser(),
|
||||
);
|
||||
if (!in_array($boardId, $boardIds, true)) {
|
||||
throw new OCSBadRequestException('The selected board does not exist or is not accessible');
|
||||
// Only boards the user owns are listed, so this also enforces the
|
||||
// owner rule. Archived boards stay listed (their workflows must stay
|
||||
// visible) but are no target for a new or changed workflow.
|
||||
$board = null;
|
||||
foreach ($this->ownedBoards() as $candidate) {
|
||||
if ($candidate['id'] === $boardId) {
|
||||
$board = $candidate;
|
||||
break;
|
||||
}
|
||||
}
|
||||
if ($board === null || $board['archived']) {
|
||||
throw new OCSBadRequestException('Das gewählte Board existiert nicht, ist archiviert oder gehört dir nicht.');
|
||||
}
|
||||
|
||||
$stackIds = array_map(
|
||||
@@ -182,34 +220,59 @@ class WorkflowController extends OCSController {
|
||||
$this->deckService->listStacks($boardId),
|
||||
);
|
||||
if (!in_array($sourceStackId, $stackIds, true) || !in_array($targetStackId, $stackIds, true)) {
|
||||
throw new OCSBadRequestException('The selected stack does not exist on this board');
|
||||
throw new OCSBadRequestException('Der gewählte Stapel existiert auf diesem Board nicht.');
|
||||
}
|
||||
|
||||
// A disabled workflow moves nothing and can close no loop; it is
|
||||
// checked again when it gets switched on, which also goes through here.
|
||||
if ($enabled) {
|
||||
$this->assertNoLoop($id, $boardId, $sourceStackId, $targetStackId);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string[] $filterUserIds
|
||||
* @param int[] $filterLabelIds
|
||||
* Rejects a workflow whose target stack leads back to its source through
|
||||
* the board's other enabled workflows — cards would circle forever. See
|
||||
* LoopDetector.
|
||||
*/
|
||||
private function assertNoLoop(?int $id, int $boardId, int $sourceStackId, int $targetStackId): void {
|
||||
$others = [];
|
||||
foreach ($this->workflowMapper->findAllForBoards([$boardId]) as $other) {
|
||||
if ($other->getId() !== $id && $other->getEnabled()) {
|
||||
$others[(int)$other->getId()] = $other;
|
||||
}
|
||||
}
|
||||
|
||||
$path = LoopDetector::findPath(LoopDetector::edgesOf($others), $targetStackId, $sourceStackId);
|
||||
if ($path === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
$titles = array_map(static fn (int $otherId) => '„' . $others[$otherId]->getTitle() . '“', $path);
|
||||
throw new OCSBadRequestException(sprintf(
|
||||
'Zusammen mit %s würde dieser Workflow eine Schleife bilden, in der Karten immer wieder hin- und hergeschoben werden. Wähle einen anderen Ziel-Stapel oder deaktiviere einen der Workflows.',
|
||||
implode(', ', $titles),
|
||||
));
|
||||
}
|
||||
|
||||
private function applyFields(
|
||||
Workflow $workflow,
|
||||
string $title,
|
||||
int $boardId,
|
||||
int $sourceStackId,
|
||||
int $targetStackId,
|
||||
array $filterUserIds,
|
||||
array $filterLabelIds,
|
||||
string $dateField,
|
||||
bool $notifyEmail,
|
||||
string $triggerDate,
|
||||
string $notifyMode,
|
||||
string $notifyChannel,
|
||||
bool $enabled,
|
||||
): void {
|
||||
$workflow->setTitle($title);
|
||||
$workflow->setBoardId($boardId);
|
||||
$workflow->setSourceStackId($sourceStackId);
|
||||
$workflow->setTargetStackId($targetStackId);
|
||||
$workflow->setFilterUserIds($filterUserIds === [] ? null : json_encode(array_values($filterUserIds)));
|
||||
$workflow->setFilterLabelIds($filterLabelIds === [] ? null : json_encode(array_values($filterLabelIds)));
|
||||
$workflow->setDateField($dateField);
|
||||
$workflow->setNotifyEmail($notifyEmail);
|
||||
$workflow->setTriggerDate($triggerDate);
|
||||
$workflow->setNotifyMode($notifyMode);
|
||||
$workflow->setNotifyChannel($notifyChannel);
|
||||
$workflow->setEnabled($enabled);
|
||||
}
|
||||
}
|
||||
+15
-70
@@ -18,37 +18,26 @@ use OCP\DB\Types;
|
||||
* @method void setSourceStackId(int $sourceStackId)
|
||||
* @method int getTargetStackId()
|
||||
* @method void setTargetStackId(int $targetStackId)
|
||||
* @method string|null getFilterUserIds()
|
||||
* @method void setFilterUserIds(?string $filterUserIds)
|
||||
* @method string|null getFilterLabelIds()
|
||||
* @method void setFilterLabelIds(?string $filterLabelIds)
|
||||
* @method string|null getDateField()
|
||||
* @method void setDateField(string $dateField)
|
||||
* @method bool getNotifyEmail()
|
||||
* @method void setNotifyEmail(bool $notifyEmail)
|
||||
* @method string getTriggerDate()
|
||||
* @method void setTriggerDate(string $triggerDate)
|
||||
* @method string getNotifyMode()
|
||||
* @method void setNotifyMode(string $notifyMode)
|
||||
* @method string getNotifyChannel()
|
||||
* @method void setNotifyChannel(string $notifyChannel)
|
||||
* @method bool getEnabled()
|
||||
* @method void setEnabled(bool $enabled)
|
||||
* @method \DateTime|null getLastRun()
|
||||
* @method void setLastRun(?\DateTime $lastRun)
|
||||
*/
|
||||
class Workflow extends Entity implements \JsonSerializable {
|
||||
/** Deck's `Card::$duedate` — the card is picked up once it is overdue. */
|
||||
public const DATE_FIELD_DUE = 'due';
|
||||
|
||||
/** Deck's `Card::$startdate` — the card is picked up once its start date has been reached. */
|
||||
public const DATE_FIELD_START = 'start';
|
||||
|
||||
public const DATE_FIELDS = [self::DATE_FIELD_DUE, self::DATE_FIELD_START];
|
||||
|
||||
protected $userId;
|
||||
protected $title;
|
||||
protected $boardId;
|
||||
protected $sourceStackId;
|
||||
protected $targetStackId;
|
||||
protected $filterUserIds;
|
||||
protected $filterLabelIds;
|
||||
protected $dateField;
|
||||
protected $notifyEmail;
|
||||
protected $triggerDate;
|
||||
protected $notifyMode;
|
||||
protected $notifyChannel;
|
||||
protected $enabled;
|
||||
protected $lastRun;
|
||||
|
||||
@@ -59,56 +48,13 @@ class Workflow extends Entity implements \JsonSerializable {
|
||||
$this->addType('boardId', Types::INTEGER);
|
||||
$this->addType('sourceStackId', Types::INTEGER);
|
||||
$this->addType('targetStackId', Types::INTEGER);
|
||||
$this->addType('filterUserIds', Types::STRING);
|
||||
$this->addType('filterLabelIds', Types::STRING);
|
||||
$this->addType('dateField', Types::STRING);
|
||||
$this->addType('notifyEmail', Types::BOOLEAN);
|
||||
$this->addType('triggerDate', Types::STRING);
|
||||
$this->addType('notifyMode', Types::STRING);
|
||||
$this->addType('notifyChannel', Types::STRING);
|
||||
$this->addType('enabled', Types::BOOLEAN);
|
||||
$this->addType('lastRun', Types::DATETIME);
|
||||
}
|
||||
|
||||
/**
|
||||
* The date field to evaluate, never anything else.
|
||||
*
|
||||
* Rows written before the column existed carry 'due' from the schema
|
||||
* default, but a freshly constructed entity holds `null` and a hand-edited
|
||||
* row could hold anything. Falling back to the due date keeps the old
|
||||
* behaviour for every value that is not explicitly the start date — the
|
||||
* safe direction, since 'due' is what every workflow meant before this
|
||||
* choice existed.
|
||||
*
|
||||
* @return self::DATE_FIELD_*
|
||||
*/
|
||||
public function getDateFieldOrDue(): string {
|
||||
$field = $this->getDateField();
|
||||
return in_array($field, self::DATE_FIELDS, true) ? $field : self::DATE_FIELD_DUE;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function getFilterUserIdsArray(): array {
|
||||
return $this->decodeIds($this->getFilterUserIds());
|
||||
}
|
||||
|
||||
/**
|
||||
* @return int[]
|
||||
*/
|
||||
public function getFilterLabelIdsArray(): array {
|
||||
return array_map('intval', $this->decodeIds($this->getFilterLabelIds()));
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
private function decodeIds(?string $json): array {
|
||||
if ($json === null || $json === '') {
|
||||
return [];
|
||||
}
|
||||
$decoded = json_decode($json, true);
|
||||
return is_array($decoded) ? array_values($decoded) : [];
|
||||
}
|
||||
|
||||
public function jsonSerialize(): array {
|
||||
return [
|
||||
'id' => $this->getId(),
|
||||
@@ -117,10 +63,9 @@ class Workflow extends Entity implements \JsonSerializable {
|
||||
'boardId' => $this->getBoardId(),
|
||||
'sourceStackId' => $this->getSourceStackId(),
|
||||
'targetStackId' => $this->getTargetStackId(),
|
||||
'filterUserIds' => $this->getFilterUserIdsArray(),
|
||||
'filterLabelIds' => $this->getFilterLabelIdsArray(),
|
||||
'dateField' => $this->getDateFieldOrDue(),
|
||||
'notifyEmail' => (bool)$this->getNotifyEmail(),
|
||||
'triggerDate' => (string)$this->getTriggerDate(),
|
||||
'notifyMode' => (string)$this->getNotifyMode(),
|
||||
'notifyChannel' => (string)$this->getNotifyChannel(),
|
||||
'enabled' => (bool)$this->getEnabled(),
|
||||
'lastRun' => $this->getLastRun()?->format(\DateTimeInterface::ATOM),
|
||||
];
|
||||
|
||||
@@ -22,24 +22,27 @@ class WorkflowMapper extends QBMapper {
|
||||
* @throws DoesNotExistException
|
||||
* @throws MultipleObjectsReturnedException
|
||||
*/
|
||||
public function findForUser(int $id, string $userId): Workflow {
|
||||
public function findById(int $id): Workflow {
|
||||
$qb = $this->db->getQueryBuilder();
|
||||
$qb->select('*')
|
||||
->from($this->getTableName())
|
||||
->where($qb->expr()->eq('id', $qb->createNamedParameter($id, IQueryBuilder::PARAM_INT)))
|
||||
->andWhere($qb->expr()->eq('user_id', $qb->createNamedParameter($userId)));
|
||||
->where($qb->expr()->eq('id', $qb->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
|
||||
|
||||
return $this->findEntity($qb);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param int[] $boardIds
|
||||
* @return Workflow[]
|
||||
*/
|
||||
public function findAllForUser(string $userId): array {
|
||||
public function findAllForBoards(array $boardIds): array {
|
||||
if ($boardIds === []) {
|
||||
return [];
|
||||
}
|
||||
$qb = $this->db->getQueryBuilder();
|
||||
$qb->select('*')
|
||||
->from($this->getTableName())
|
||||
->where($qb->expr()->eq('user_id', $qb->createNamedParameter($userId)))
|
||||
->where($qb->expr()->in('board_id', $qb->createNamedParameter($boardIds, IQueryBuilder::PARAM_INT_ARRAY)))
|
||||
->orderBy('id', 'ASC');
|
||||
|
||||
return $this->findEntities($qb);
|
||||
|
||||
@@ -1,47 +0,0 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace OCA\WorkflowDeckAutomation\Migration;
|
||||
|
||||
use Closure;
|
||||
use OCA\WorkflowDeckAutomation\Db\Workflow;
|
||||
use OCP\DB\ISchemaWrapper;
|
||||
use OCP\DB\Types;
|
||||
use OCP\Migration\IOutput;
|
||||
use OCP\Migration\SimpleMigrationStep;
|
||||
|
||||
/**
|
||||
* Adds the per-workflow choice between Deck's due date and its start date.
|
||||
*
|
||||
* A separate migration rather than an edit to Version1000...: that one is
|
||||
* wrapped in `if (!$schema->hasTable(...))`, so changing it would only ever
|
||||
* reach fresh installs.
|
||||
*
|
||||
* The `default` is what migrates the existing rows — every workflow written
|
||||
* before this release was evaluated against the due date, and the column
|
||||
* default gives exactly that without a backfill step.
|
||||
*/
|
||||
class Version1001Date20260825120000 extends SimpleMigrationStep {
|
||||
public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
|
||||
/** @var ISchemaWrapper $schema */
|
||||
$schema = $schemaClosure();
|
||||
|
||||
if (!$schema->hasTable('wfda_workflows')) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$table = $schema->getTable('wfda_workflows');
|
||||
if ($table->hasColumn('date_field')) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$table->addColumn('date_field', Types::STRING, [
|
||||
'notnull' => true,
|
||||
'length' => 16,
|
||||
'default' => Workflow::DATE_FIELD_DUE,
|
||||
]);
|
||||
|
||||
return $schema;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace OCA\WorkflowDeckAutomation\Migration;
|
||||
|
||||
use Closure;
|
||||
use OCP\DB\ISchemaWrapper;
|
||||
use OCP\Migration\IOutput;
|
||||
use OCP\Migration\SimpleMigrationStep;
|
||||
|
||||
/**
|
||||
* Drops the assigned-user and label filters. Workflows that had one keep
|
||||
* running, now unfiltered — that was an explicit product decision.
|
||||
*
|
||||
* The columns have to go rather than just be ignored: Entity::fromRow()
|
||||
* calls a setter for every selected column, and the Workflow entity no
|
||||
* longer has these properties.
|
||||
*/
|
||||
class Version1001Date20260930120000 extends SimpleMigrationStep {
|
||||
public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
|
||||
/** @var ISchemaWrapper $schema */
|
||||
$schema = $schemaClosure();
|
||||
|
||||
if (!$schema->hasTable('wfda_workflows')) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$table = $schema->getTable('wfda_workflows');
|
||||
$changed = false;
|
||||
foreach (['filter_user_ids', 'filter_label_ids'] as $column) {
|
||||
if ($table->hasColumn($column)) {
|
||||
$table->dropColumn($column);
|
||||
$changed = true;
|
||||
}
|
||||
}
|
||||
|
||||
return $changed ? $schema : null;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,64 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace OCA\WorkflowDeckAutomation\Migration;
|
||||
|
||||
use Closure;
|
||||
use OCP\DB\ISchemaWrapper;
|
||||
use OCP\DB\QueryBuilder\IQueryBuilder;
|
||||
use OCP\DB\Types;
|
||||
use OCP\IDBConnection;
|
||||
use OCP\Migration\IOutput;
|
||||
use OCP\Migration\SimpleMigrationStep;
|
||||
|
||||
/**
|
||||
* Replaces the yes/no `notify_email` flag with `notify_mode`
|
||||
* (off / owner / board, see NotificationPolicy::MODES).
|
||||
*
|
||||
* Existing workflows keep behaving exactly as before: a set flag becomes
|
||||
* `owner` — the only recipient the flag ever had — everything else `off`.
|
||||
* The old column is dropped by the next step, once the values are copied.
|
||||
*/
|
||||
class Version1002Date20261001120000 extends SimpleMigrationStep {
|
||||
public function __construct(
|
||||
private IDBConnection $db,
|
||||
) {
|
||||
}
|
||||
|
||||
public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
|
||||
/** @var ISchemaWrapper $schema */
|
||||
$schema = $schemaClosure();
|
||||
|
||||
if (!$schema->hasTable('wfda_workflows')) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$table = $schema->getTable('wfda_workflows');
|
||||
if ($table->hasColumn('notify_mode')) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$table->addColumn('notify_mode', Types::STRING, [
|
||||
'notnull' => true,
|
||||
'length' => 16,
|
||||
'default' => 'off',
|
||||
]);
|
||||
|
||||
return $schema;
|
||||
}
|
||||
|
||||
public function postSchemaChange(IOutput $output, Closure $schemaClosure, array $options): void {
|
||||
/** @var ISchemaWrapper $schema */
|
||||
$schema = $schemaClosure();
|
||||
if (!$schema->hasTable('wfda_workflows') || !$schema->getTable('wfda_workflows')->hasColumn('notify_email')) {
|
||||
return;
|
||||
}
|
||||
|
||||
$qb = $this->db->getQueryBuilder();
|
||||
$qb->update('wfda_workflows')
|
||||
->set('notify_mode', $qb->createNamedParameter('owner'))
|
||||
->where($qb->expr()->eq('notify_email', $qb->createNamedParameter(true, IQueryBuilder::PARAM_BOOL)));
|
||||
$qb->executeStatement();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace OCA\WorkflowDeckAutomation\Migration;
|
||||
|
||||
use Closure;
|
||||
use OCP\DB\ISchemaWrapper;
|
||||
use OCP\Migration\IOutput;
|
||||
use OCP\Migration\SimpleMigrationStep;
|
||||
|
||||
/**
|
||||
* Drops `notify_email` now that Version1002Date20261001120000 has copied it
|
||||
* into `notify_mode`. It has to go rather than be ignored: Entity::fromRow()
|
||||
* calls a setter per selected column, and Workflow no longer has one.
|
||||
*/
|
||||
class Version1003Date20261001120100 extends SimpleMigrationStep {
|
||||
public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
|
||||
/** @var ISchemaWrapper $schema */
|
||||
$schema = $schemaClosure();
|
||||
|
||||
if (!$schema->hasTable('wfda_workflows')) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$table = $schema->getTable('wfda_workflows');
|
||||
if (!$table->hasColumn('notify_email')) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$table->dropColumn('notify_email');
|
||||
return $schema;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace OCA\WorkflowDeckAutomation\Migration;
|
||||
|
||||
use Closure;
|
||||
use OCP\DB\ISchemaWrapper;
|
||||
use OCP\DB\Types;
|
||||
use OCP\Migration\IOutput;
|
||||
use OCP\Migration\SimpleMigrationStep;
|
||||
|
||||
/**
|
||||
* Adds `notify_channel` (mail / notification / both, see
|
||||
* NotificationPolicy::CHANNELS): how the recipients chosen by `notify_mode`
|
||||
* hear about moved cards. Existing workflows get `mail`, the only channel
|
||||
* there was, so nothing changes for them.
|
||||
*/
|
||||
class Version1004Date20261002120000 extends SimpleMigrationStep {
|
||||
public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
|
||||
/** @var ISchemaWrapper $schema */
|
||||
$schema = $schemaClosure();
|
||||
|
||||
if (!$schema->hasTable('wfda_workflows')) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$table = $schema->getTable('wfda_workflows');
|
||||
if ($table->hasColumn('notify_channel')) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$table->addColumn('notify_channel', Types::STRING, [
|
||||
'notnull' => true,
|
||||
'length' => 16,
|
||||
'default' => 'mail',
|
||||
]);
|
||||
|
||||
return $schema;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace OCA\WorkflowDeckAutomation\Migration;
|
||||
|
||||
use Closure;
|
||||
use OCP\DB\ISchemaWrapper;
|
||||
use OCP\DB\Types;
|
||||
use OCP\Migration\IOutput;
|
||||
use OCP\Migration\SimpleMigrationStep;
|
||||
|
||||
/**
|
||||
* Adds `trigger_date` (due / start, see TriggerDate::ALL): whether a card
|
||||
* moves once its due date or once its start date is reached. Existing
|
||||
* workflows get `due`, the only trigger there was, so nothing changes for
|
||||
* them.
|
||||
*/
|
||||
class Version1005Date20261003120000 extends SimpleMigrationStep {
|
||||
public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
|
||||
/** @var ISchemaWrapper $schema */
|
||||
$schema = $schemaClosure();
|
||||
|
||||
if (!$schema->hasTable('wfda_workflows')) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$table = $schema->getTable('wfda_workflows');
|
||||
if ($table->hasColumn('trigger_date')) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$table->addColumn('trigger_date', Types::STRING, [
|
||||
'notnull' => true,
|
||||
'length' => 16,
|
||||
'default' => 'due',
|
||||
]);
|
||||
|
||||
return $schema;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,152 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace OCA\WorkflowDeckAutomation\Notification;
|
||||
|
||||
use OCA\WorkflowDeckAutomation\AppInfo\Application;
|
||||
use OCA\WorkflowDeckAutomation\Service\NotificationMailer;
|
||||
use OCA\WorkflowDeckAutomation\Service\NotificationPusher;
|
||||
use OCA\WorkflowDeckAutomation\Service\TriggerDate;
|
||||
use OCP\IURLGenerator;
|
||||
use OCP\Notification\INotification;
|
||||
use OCP\Notification\INotifier;
|
||||
use OCP\Notification\UnknownNotificationException;
|
||||
|
||||
/**
|
||||
* Turns the values NotificationPusher stored into text. German only, like
|
||||
* the rest of the app — the language Nextcloud asks for is ignored.
|
||||
*
|
||||
* Deliberately asks Deck nothing: the stored titles are the ones from the
|
||||
* moment the card moved, and a Deck lookup here would run as whoever
|
||||
* happens to fetch notifications (see CLAUDE.md on Deck's frozen uid).
|
||||
*/
|
||||
class Notifier implements INotifier {
|
||||
public function __construct(
|
||||
private IURLGenerator $urlGenerator,
|
||||
) {
|
||||
}
|
||||
|
||||
public function getID(): string {
|
||||
return Application::APP_ID;
|
||||
}
|
||||
|
||||
public function getName(): string {
|
||||
return 'Deck Workflow-Automatisierung';
|
||||
}
|
||||
|
||||
public function prepare(INotification $notification, string $languageCode): INotification {
|
||||
if ($notification->getApp() !== Application::APP_ID) {
|
||||
throw new UnknownNotificationException();
|
||||
}
|
||||
|
||||
$notification->setIcon($this->urlGenerator->getAbsoluteURL($this->urlGenerator->imagePath(Application::APP_ID, 'app-dark.svg')));
|
||||
$params = $notification->getSubjectParameters();
|
||||
|
||||
switch ($notification->getSubject()) {
|
||||
case NotificationPusher::SUBJECT_CARD_MOVED:
|
||||
$this->prepareCardMoved($notification, $params);
|
||||
return $notification;
|
||||
case NotificationPusher::SUBJECT_WORKFLOW_DISABLED:
|
||||
$this->prepareWorkflowDisabled($notification, $params);
|
||||
return $notification;
|
||||
default:
|
||||
throw new UnknownNotificationException();
|
||||
}
|
||||
}
|
||||
|
||||
private function prepareCardMoved(INotification $notification, array $params): void {
|
||||
$cardId = $notification->getObjectId();
|
||||
$boardId = (string)($params['boardId'] ?? '');
|
||||
$boardTitle = (string)($params['boardTitle'] ?? '');
|
||||
$targetStackTitle = (string)($params['targetStackTitle'] ?? '');
|
||||
$cardUrl = $this->urlGenerator->getAbsoluteURL('/apps/deck/board/' . $boardId . '/card/' . $cardId);
|
||||
|
||||
// Every title is user input and goes in as a rich object, never into
|
||||
// the template itself — a title containing "{…}" would otherwise be
|
||||
// read as a placeholder.
|
||||
$objects = [
|
||||
'deck-card' => [
|
||||
'type' => 'deck-card',
|
||||
'id' => $cardId,
|
||||
'name' => (string)($params['cardTitle'] ?? ''),
|
||||
'boardname' => $boardTitle,
|
||||
'stackname' => $targetStackTitle,
|
||||
'link' => $cardUrl,
|
||||
],
|
||||
'deck-board' => [
|
||||
'type' => 'deck-board',
|
||||
'id' => $boardId,
|
||||
'name' => $boardTitle,
|
||||
'link' => $this->urlGenerator->getAbsoluteURL('/apps/deck/board/' . $boardId),
|
||||
],
|
||||
'source-stack' => [
|
||||
'type' => 'highlight',
|
||||
'id' => (string)($params['sourceStackId'] ?? ''),
|
||||
'name' => (string)($params['sourceStackTitle'] ?? ''),
|
||||
],
|
||||
'target-stack' => [
|
||||
'type' => 'highlight',
|
||||
'id' => (string)($params['targetStackId'] ?? ''),
|
||||
'name' => $targetStackTitle,
|
||||
],
|
||||
];
|
||||
|
||||
$notification->setLink($cardUrl);
|
||||
self::setText(
|
||||
$notification,
|
||||
'{deck-card} wurde nach {target-stack} verschoben',
|
||||
sprintf(
|
||||
'Die Karte auf {deck-board} %s und wurde automatisch von {source-stack} nach {target-stack} verschoben.',
|
||||
// Missing on notifications from before the start date existed,
|
||||
// which were all about due dates.
|
||||
TriggerDate::describeReason((string)($params['triggerDate'] ?? TriggerDate::DUE)),
|
||||
),
|
||||
$objects,
|
||||
);
|
||||
}
|
||||
|
||||
private function prepareWorkflowDisabled(INotification $notification, array $params): void {
|
||||
$settingsUrl = $this->urlGenerator->getAbsoluteURL('/settings/user/' . Application::APP_ID);
|
||||
|
||||
$objects = [
|
||||
'workflow' => [
|
||||
'type' => 'highlight',
|
||||
'id' => $notification->getObjectId(),
|
||||
'name' => (string)($params['workflowTitle'] ?? ''),
|
||||
'link' => $settingsUrl,
|
||||
],
|
||||
];
|
||||
|
||||
$notification->setLink($settingsUrl);
|
||||
self::setText(
|
||||
$notification,
|
||||
'Workflow {workflow} wurde deaktiviert',
|
||||
sprintf(
|
||||
'Er wurde automatisch ausgeschaltet, weil %s, und verschiebt keine Karten mehr. Lösche ihn oder stelle ein vorhandenes Board und vorhandene Stapel ein, um ihn wieder zu aktivieren.',
|
||||
NotificationMailer::describeBrokenTarget((string)($params['brokenTarget'] ?? '')),
|
||||
),
|
||||
$objects,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the rich texts and their plain fallback (used by clients without
|
||||
* rich text support), with titles in German quotes there.
|
||||
*
|
||||
* @param array<string, array{name: string}> $objects
|
||||
*/
|
||||
private static function setText(INotification $notification, string $subject, string $message, array $objects): void {
|
||||
$plain = [];
|
||||
foreach ($objects as $key => $object) {
|
||||
$plain['{' . $key . '}'] = '„' . $object['name'] . '“';
|
||||
}
|
||||
|
||||
// strtr() replaces in a single pass, so a title that itself contains
|
||||
// a placeholder is left as it is.
|
||||
$notification->setParsedSubject(strtr($subject, $plain))
|
||||
->setRichSubject($subject, $objects)
|
||||
->setParsedMessage(strtr($message, $plain))
|
||||
->setRichMessage($message, $objects);
|
||||
}
|
||||
}
|
||||
@@ -4,7 +4,7 @@ declare(strict_types=1);
|
||||
|
||||
namespace OCA\WorkflowDeckAutomation\Service;
|
||||
|
||||
use DateTimeInterface;
|
||||
use OCA\Deck\Db\AssignmentMapper;
|
||||
use OCA\Deck\Db\BoardMapper;
|
||||
use OCA\Deck\Db\Card;
|
||||
use OCA\Deck\Db\CardMapper;
|
||||
@@ -15,9 +15,8 @@ use OCA\Deck\Service\PermissionService;
|
||||
use OCA\Deck\Service\StackService;
|
||||
use OCP\App\IAppManager;
|
||||
use OCP\AppFramework\Db\DoesNotExistException;
|
||||
use OCP\IGroupManager;
|
||||
use OCP\IConfig;
|
||||
use OCP\IUser;
|
||||
use OCP\IUserManager;
|
||||
use OCP\Server;
|
||||
use Psr\Log\LoggerInterface;
|
||||
use ReflectionProperty;
|
||||
@@ -37,35 +36,9 @@ class DeckIntegrationService {
|
||||
private const DECK_APP_ID = 'deck';
|
||||
|
||||
/**
|
||||
* Oldest Deck this app will talk to.
|
||||
*
|
||||
* Deck 1.18.0 is the release that added the card start date
|
||||
* (`Card::$startdate`, PR #7749), which the start-date workflows read.
|
||||
* The floor cannot live in appinfo/info.xml: neither the server's
|
||||
* app-info.xsd nor the app store's info.xsd has an app-to-app dependency
|
||||
* element, only <nextcloud>.
|
||||
*
|
||||
* That pin does most of the work anyway — Deck 1.18.x is the only release
|
||||
* line declaring `>=34.0.0,<35.0.0`, so on the Nextcloud 34 this app
|
||||
* requires, every installable Deck already carries the field. What is left
|
||||
* for this check is a Deck put in place by hand or from git.
|
||||
*
|
||||
* version_compare() sorts `1.18.0-beta.x` *below* `1.18.0`, and that is
|
||||
* intended: the betas of that line may predate the field.
|
||||
*/
|
||||
private const MIN_DECK_VERSION = '1.18.0';
|
||||
|
||||
/**
|
||||
* Deck's Acl::PERMISSION_TYPE_* values, inlined so this class keeps
|
||||
* working (degrading to "treat it as a user") if Deck ever moves or
|
||||
* renames the constants.
|
||||
*/
|
||||
private const ACL_TYPE_USER = 0;
|
||||
private const ACL_TYPE_GROUP = 1;
|
||||
|
||||
/**
|
||||
* Deck's Acl::PERMISSION_READ, inlined for the same reason. It is the key
|
||||
* under which PermissionService::getPermissions() reports read access.
|
||||
* Deck's Acl::PERMISSION_READ, inlined so a moved or renamed constant
|
||||
* cannot fatal this class. It is the key under which
|
||||
* PermissionService::getPermissions() reports read access.
|
||||
*/
|
||||
private const ACL_PERMISSION_READ = 0;
|
||||
|
||||
@@ -88,35 +61,14 @@ class DeckIntegrationService {
|
||||
'OCA\Deck\Activity\ActivityManager',
|
||||
];
|
||||
|
||||
/**
|
||||
* `Workflow::DATE_FIELD_*` mapped to the property on Deck's Card entity.
|
||||
* Kept here rather than on the Workflow so this class stays the only one
|
||||
* that has to know what Deck calls its columns.
|
||||
*/
|
||||
private const CARD_DATE_PROPERTIES = [
|
||||
'due' => 'duedate',
|
||||
'start' => 'startdate',
|
||||
];
|
||||
|
||||
private const DEFAULT_CARD_DATE = 'due';
|
||||
|
||||
/**
|
||||
* @var list<array{ReflectionProperty, object, ?string}>
|
||||
*/
|
||||
private array $identityRestore = [];
|
||||
|
||||
/**
|
||||
* Card properties already reported as missing, so the warning in
|
||||
* getCardDate() is one line per process instead of one per card.
|
||||
*
|
||||
* @var array<string, true>
|
||||
*/
|
||||
private array $reportedMissingCardProperties = [];
|
||||
|
||||
public function __construct(
|
||||
private IAppManager $appManager,
|
||||
private IUserManager $userManager,
|
||||
private IGroupManager $groupManager,
|
||||
private IConfig $config,
|
||||
private LoggerInterface $logger,
|
||||
) {
|
||||
}
|
||||
@@ -206,71 +158,80 @@ class DeckIntegrationService {
|
||||
if (!$this->appManager->isEnabledForUser(self::DECK_APP_ID, $user)) {
|
||||
throw new DeckUnavailableException('Deck is not enabled for user ' . $user->getUID());
|
||||
}
|
||||
|
||||
$version = $this->appManager->getAppVersion(self::DECK_APP_ID);
|
||||
if ($version === '' || version_compare($version, self::MIN_DECK_VERSION, '<')) {
|
||||
throw new DeckUnavailableException(sprintf(
|
||||
'Deck %s is installed, but %s or newer is required',
|
||||
$version !== '' ? $version : '(unknown version)',
|
||||
self::MIN_DECK_VERSION,
|
||||
));
|
||||
}
|
||||
|
||||
if (!class_exists(CardService::class) || !class_exists(BoardService::class) || !class_exists(StackService::class)) {
|
||||
throw new DeckUnavailableException('Deck internal classes are not available');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<int, array{id: int, title: string}>
|
||||
*
|
||||
* Only ever call this from a *request*: getUserBoards() reads the uid
|
||||
* BoardService froze at construction time, and beginUserContext() cannot
|
||||
* help here — it repoints that field, but Deck may already have cached
|
||||
* board lists behind it, and the job has no use for a board *list*
|
||||
* anyway. It asks findStackIds() about one known board id instead.
|
||||
* Whether Deck's cards carry a start date (`deck_cards.startdate`, added
|
||||
* in Deck 1.18). Checked on the property, not with method_exists():
|
||||
* Entity getters are magic, so getStartdate() would only fail when called.
|
||||
*/
|
||||
public function listBoardsForCurrentUser(): array {
|
||||
$boards = $this->call(function () {
|
||||
$boardService = $this->resolve(BoardService::class);
|
||||
try {
|
||||
// getUserBoards(?int $since, bool $includeArchived, …): with
|
||||
// the default $includeArchived = true, Deck skips the
|
||||
// `archived = false AND deleted_at = 0` conditions entirely,
|
||||
// so archived *and* trashed boards come back. Ask for the
|
||||
// filtered query instead of sorting them out afterwards.
|
||||
return $boardService->getUserBoards(null, false);
|
||||
} catch (Throwable $e) {
|
||||
// Older/newer Deck with a different signature: fall back to
|
||||
// the unfiltered call, isBoardHidden() below still filters.
|
||||
return $boardService->getUserBoards();
|
||||
}
|
||||
}, []);
|
||||
public function supportsStartdate(): bool {
|
||||
return class_exists(Card::class) && property_exists(Card::class, 'startdate');
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether a Deck board or card sits in Deck's trash (`deleted_at > 0`).
|
||||
*
|
||||
* Read through property_exists(), never method_exists(): Entity getters
|
||||
* are magic (`__call`), so method_exists() is always false for them —
|
||||
* which is how trashed cards used to be moved and trashed boards went
|
||||
* unnoticed.
|
||||
*/
|
||||
private static function isTrashed(object $entity): bool {
|
||||
return property_exists($entity, 'deletedAt') && (int)$entity->getDeletedAt() > 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether a Deck board is archived. Same magic-getter caveat as
|
||||
* isTrashed().
|
||||
*/
|
||||
private static function isArchived(object $entity): bool {
|
||||
return property_exists($entity, 'archived') && (bool)$entity->getArchived();
|
||||
}
|
||||
|
||||
/**
|
||||
* The boards `$userId` owns — the only boards workflows may live on, and
|
||||
* the boards whose workflows that user sees and manages.
|
||||
*
|
||||
* One query: BoardMapper::findAllByOwner() is `WHERE owner = :uid`, so
|
||||
* shared boards never come back, and as a plain QBMapper it has none of
|
||||
* the frozen-uid state of BoardService::getUserBoards(). It does return
|
||||
* archived and trashed boards; trashed ones are dropped here, archived
|
||||
* ones are kept but flagged — their workflows still exist and must stay
|
||||
* visible, but the board is no target for a new or changed workflow, and
|
||||
* the runner skips it.
|
||||
*
|
||||
* Throws instead of degrading to `[]`: an empty list would read as "you
|
||||
* own no boards" and hide every workflow the user has.
|
||||
*
|
||||
* @return array<int, array{id: int, title: string, archived: bool}>
|
||||
* @throws DeckUnavailableException
|
||||
*/
|
||||
public function listOwnedBoards(string $userId): array {
|
||||
$boards = $this->call(
|
||||
fn () => $this->resolve(BoardMapper::class)->findAllByOwner($userId),
|
||||
[],
|
||||
true,
|
||||
);
|
||||
|
||||
// Deck merges own/group/circle boards, so the same board can come
|
||||
// back more than once; and boards in the trash or archived ones are
|
||||
// no useful automation target. Keyed by id => deduplicated.
|
||||
$result = [];
|
||||
foreach ($boards as $board) {
|
||||
$id = (int)$board->getId();
|
||||
if (isset($result[$id]) || $this->isBoardHidden($board)) {
|
||||
if (self::isTrashed($board)) {
|
||||
continue;
|
||||
}
|
||||
$id = (int)$board->getId();
|
||||
$title = $board->getTitle();
|
||||
$result[$id] = [
|
||||
$result[] = [
|
||||
'id' => $id,
|
||||
'title' => (is_string($title) && $title !== '') ? $title : ('#' . $id),
|
||||
'archived' => self::isArchived($board),
|
||||
];
|
||||
}
|
||||
|
||||
return array_values($result);
|
||||
}
|
||||
|
||||
private function isBoardHidden(mixed $board): bool {
|
||||
if (method_exists($board, 'getDeletedAt') && (int)$board->getDeletedAt() > 0) {
|
||||
return true;
|
||||
}
|
||||
return method_exists($board, 'getArchived') && $board->getArchived() === true;
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -313,7 +274,7 @@ class DeckIntegrationService {
|
||||
public function findStackIds(int $boardId, string $userId): ?array {
|
||||
try {
|
||||
$board = $this->resolve(BoardMapper::class)->find($boardId);
|
||||
if (method_exists($board, 'getDeletedAt') && (int)$board->getDeletedAt() > 0) {
|
||||
if (self::isTrashed($board)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@@ -343,6 +304,137 @@ class DeckIntegrationService {
|
||||
return array_map(static fn ($stack) => (int)$stack->getId(), $stacks);
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether the board is archived — workflows on archived boards stay
|
||||
* stored and enabled but move nothing until the board is unarchived.
|
||||
*
|
||||
* Read through BoardMapper like findBoardOwner(). `false` if the board
|
||||
* row is gone, so findBrokenTarget() still gets to disable the workflow;
|
||||
* every other failure throws.
|
||||
*
|
||||
* @throws DeckUnavailableException
|
||||
*/
|
||||
public function isBoardArchived(int $boardId): bool {
|
||||
try {
|
||||
$board = $this->resolve(BoardMapper::class)->find($boardId);
|
||||
} catch (DeckUnavailableException $e) {
|
||||
throw $e;
|
||||
} catch (Throwable $e) {
|
||||
if ($this->isMissing($e)) {
|
||||
return false;
|
||||
}
|
||||
throw new DeckUnavailableException('Could not read board ' . $boardId . ': ' . $e->getMessage(), 0, $e);
|
||||
}
|
||||
|
||||
return self::isArchived($board);
|
||||
}
|
||||
|
||||
/**
|
||||
* The uid of the board's current owner — the user a workflow on that
|
||||
* board belongs to. Workflows follow the board: when Deck transfers its
|
||||
* ownership, they move to the new owner along with it.
|
||||
*
|
||||
* Read through BoardMapper, a plain QBMapper without user state, so it
|
||||
* answers the same in a request and in cron. Trashed and archived boards
|
||||
* still report their owner. `null` only if the board row is gone; every
|
||||
* other failure throws, like findStackIds().
|
||||
*
|
||||
* @throws DeckUnavailableException
|
||||
*/
|
||||
public function findBoardOwner(int $boardId): ?string {
|
||||
try {
|
||||
$board = $this->resolve(BoardMapper::class)->find($boardId);
|
||||
} catch (DeckUnavailableException $e) {
|
||||
throw $e;
|
||||
} catch (Throwable $e) {
|
||||
if ($this->isMissing($e)) {
|
||||
return null;
|
||||
}
|
||||
throw new DeckUnavailableException('Could not read owner of board ' . $boardId . ': ' . $e->getMessage(), 0, $e);
|
||||
}
|
||||
|
||||
$owner = $this->unwrapUid($board->getOwner());
|
||||
if ($owner === null) {
|
||||
throw new DeckUnavailableException('Board ' . $boardId . ' has no readable owner');
|
||||
}
|
||||
return $owner;
|
||||
}
|
||||
|
||||
/**
|
||||
* Who should hear about each of the given (moved) cards, according to
|
||||
* every board member's own Deck notification setting for this board —
|
||||
* the "Notifications: none / assigned cards / all cards" menu, stored as
|
||||
* the user preference `deck` / `board:<id>:notify-due`. The decision
|
||||
* itself is NotificationPolicy::shouldNotify(), a copy of Deck's rules.
|
||||
*
|
||||
* Like findStackIds(), assembled only from pieces that take the users
|
||||
* explicitly and never consult Deck's frozen `$userId`:
|
||||
* PermissionService::findUsers() reads the owner and ACL through mappers
|
||||
* and expands groups and circles itself; AssignmentMapper is a plain
|
||||
* mapper that also resolves group/circle assignments; the preference is
|
||||
* read straight from IConfig.
|
||||
*
|
||||
* Throws on any failure, so the caller can log and skip the mail instead
|
||||
* of mailing a half-resolved or wrong set of people.
|
||||
*
|
||||
* @param int[] $cardIds
|
||||
* @return array<int, list<string>> card id => uids to notify
|
||||
* @throws DeckUnavailableException
|
||||
*/
|
||||
public function findNotificationRecipients(int $boardId, array $cardIds): array {
|
||||
try {
|
||||
$board = $this->resolve(BoardMapper::class)->find($boardId, false, true);
|
||||
$owner = $this->unwrapUid($board->getOwner());
|
||||
// Deck notifies the owner of a board nobody else can see about
|
||||
// every card: "assigned" means nothing there.
|
||||
$unshared = count($board->getAcl() ?? []) === 0;
|
||||
|
||||
// `true` bypasses PermissionService's per-process cache, which
|
||||
// would otherwise outlive ACL changes for the whole cron pass.
|
||||
$participants = $this->resolve(PermissionService::class)->findUsers($boardId, true);
|
||||
$assignments = $this->resolve(AssignmentMapper::class);
|
||||
|
||||
$settings = [];
|
||||
foreach ($participants as $uid => $participant) {
|
||||
// Users of other instances (FederatedUser) have no local
|
||||
// account and no preference to read.
|
||||
if (!is_a($participant, 'OCA\Deck\Db\User')) {
|
||||
continue;
|
||||
}
|
||||
// Numeric uids come back as integer array keys.
|
||||
$uid = (string)$uid;
|
||||
$settings[$uid] = (string)$this->config->getUserValue(
|
||||
$uid,
|
||||
self::DECK_APP_ID,
|
||||
'board:' . $boardId . ':notify-due',
|
||||
NotificationPolicy::DECK_DEFAULT,
|
||||
);
|
||||
}
|
||||
|
||||
$recipients = [];
|
||||
foreach ($cardIds as $cardId) {
|
||||
$recipients[$cardId] = [];
|
||||
foreach ($settings as $uid => $setting) {
|
||||
$uid = (string)$uid;
|
||||
$notify = NotificationPolicy::shouldNotify(
|
||||
$setting,
|
||||
$unshared && $uid === $owner,
|
||||
static fn (): bool => (bool)$assignments->isUserAssigned($cardId, $uid),
|
||||
);
|
||||
if ($notify) {
|
||||
$recipients[$cardId][] = $uid;
|
||||
}
|
||||
}
|
||||
}
|
||||
} catch (DeckUnavailableException $e) {
|
||||
throw $e;
|
||||
} catch (Throwable $e) {
|
||||
throw new DeckUnavailableException('Could not resolve notification recipients for board ' . $boardId . ': ' . $e->getMessage(), 0, $e);
|
||||
}
|
||||
|
||||
return $recipients;
|
||||
}
|
||||
|
||||
/**
|
||||
* Deck's own exception classes are referenced by name: `is_a()` with a
|
||||
* string simply returns false when the class does not exist, so a missing
|
||||
@@ -361,51 +453,6 @@ class DeckIntegrationService {
|
||||
return is_a($e, 'OCA\Deck\NotFoundException');
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array<int, array{id: int, title: string, color: string|null}>
|
||||
*/
|
||||
public function listLabels(int $boardId): array {
|
||||
$labels = $this->call(fn () => $this->readLabels($boardId), []);
|
||||
|
||||
return array_map(
|
||||
static fn ($label) => ['id' => (int)$label->getId(), 'title' => $label->getTitle(), 'color' => $label->getColor()],
|
||||
$labels,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* What a workflow's filters *could* legitimately refer to on this board.
|
||||
*
|
||||
* Unlike listLabels()/listParticipants() this throws instead of degrading
|
||||
* to an empty list, because its only caller draws a conclusion from
|
||||
* emptiness ("this filter cannot match anything any more"). Same rule as
|
||||
* findStackIds(): a Deck hiccup must never be read as positive knowledge.
|
||||
*
|
||||
* @return array{labelIds: int[], participantUids: string[]}
|
||||
* @throws DeckUnavailableException
|
||||
*/
|
||||
public function findFilterOptions(int $boardId): array {
|
||||
try {
|
||||
$board = $this->readBoard($boardId);
|
||||
|
||||
return [
|
||||
'labelIds' => array_map(
|
||||
static fn ($label) => (int)$label->getId(),
|
||||
$board->getLabels() ?? [],
|
||||
),
|
||||
'participantUids' => array_values(array_unique($this->collectParticipantUids($board))),
|
||||
];
|
||||
} catch (DeckUnavailableException $e) {
|
||||
throw $e;
|
||||
} catch (Throwable $e) {
|
||||
$this->logger->error('Could not read filter options of board ' . $boardId . ': ' . $e->getMessage(), [
|
||||
'app' => 'workflow_deck_automation',
|
||||
'exception' => $e,
|
||||
]);
|
||||
throw new DeckUnavailableException('Deck call failed: ' . $e->getMessage(), 0, $e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Titles of a workflow's board and stacks, for the notification mail.
|
||||
*
|
||||
@@ -439,85 +486,9 @@ class DeckIntegrationService {
|
||||
return $title !== '' ? $title : ('#' . $id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Everyone who can hold a card on this board: the board owner (who is
|
||||
* *not* part of the ACL — a private board has an empty ACL) plus every
|
||||
* ACL entry, with group shares expanded to their members.
|
||||
*
|
||||
* @return array<int, array{uid: string, displayName: string}>
|
||||
*/
|
||||
public function listParticipants(int $boardId): array {
|
||||
$uids = $this->call(fn () => $this->collectParticipantUids($this->readBoard($boardId)), []);
|
||||
|
||||
$participants = [];
|
||||
foreach ($uids as $uid) {
|
||||
if (isset($participants[$uid])) {
|
||||
continue;
|
||||
}
|
||||
$participants[$uid] = [
|
||||
'uid' => $uid,
|
||||
'displayName' => $this->userManager->get($uid)?->getDisplayName() ?? $uid,
|
||||
];
|
||||
}
|
||||
|
||||
return array_values($participants);
|
||||
}
|
||||
|
||||
/**
|
||||
* The enriched board — `$fullDetails = true` is what populates labels and
|
||||
* the ACL. Shared by every caller that needs one so a single Deck read
|
||||
* serves them all.
|
||||
*/
|
||||
private function readBoard(int $boardId): mixed {
|
||||
return $this->resolve(BoardService::class)->find($boardId, true);
|
||||
}
|
||||
|
||||
private function readLabels(int $boardId): array {
|
||||
return $this->readBoard($boardId)->getLabels() ?? [];
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[] may contain duplicates
|
||||
*/
|
||||
private function collectParticipantUids(mixed $board): array {
|
||||
$uids = [];
|
||||
$owner = $this->unwrapUid($board->getOwner());
|
||||
if ($owner !== null) {
|
||||
$uids[] = $owner;
|
||||
}
|
||||
|
||||
foreach ($board->getAcl() ?? [] as $entry) {
|
||||
$principal = $this->extractParticipantUid($entry);
|
||||
if ($principal === null) {
|
||||
continue;
|
||||
}
|
||||
$type = method_exists($entry, 'getType') ? (int)$entry->getType() : self::ACL_TYPE_USER;
|
||||
if ($type === self::ACL_TYPE_GROUP) {
|
||||
array_push($uids, ...$this->groupMemberUids($principal));
|
||||
} elseif ($type === self::ACL_TYPE_USER) {
|
||||
$uids[] = $principal;
|
||||
}
|
||||
// Circles and federated shares are skipped: their members
|
||||
// cannot be resolved to plain uids here.
|
||||
}
|
||||
|
||||
return $uids;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
private function groupMemberUids(string $groupId): array {
|
||||
$group = $this->groupManager->get($groupId);
|
||||
if ($group === null) {
|
||||
return [];
|
||||
}
|
||||
return array_map(static fn (IUser $user) => $user->getUID(), $group->getUsers());
|
||||
}
|
||||
|
||||
/**
|
||||
* Cards in the given stack that are neither archived, deleted nor marked
|
||||
* done, enriched so getAssignedUsers()/getLabels() are populated.
|
||||
* done.
|
||||
*
|
||||
* The `deletedAt` check is not redundant: Deck's
|
||||
* `CardMapper::findAllByStack()` filters on `stack_id` and
|
||||
@@ -529,20 +500,15 @@ class DeckIntegrationService {
|
||||
*/
|
||||
public function getActiveCardsInStack(int $stackId): array {
|
||||
return $this->call(function () use ($stackId) {
|
||||
$cardMapper = $this->resolve(CardMapper::class);
|
||||
$cardService = $this->resolve(CardService::class);
|
||||
|
||||
$cards = $cardMapper->findAllByStack($stackId);
|
||||
// enrichCards() mutates each $cards entry in place (labels, assigned users, ...) but
|
||||
// *returns* CardDetails wrappers whose own fields (duedate, stackId, ...) were never
|
||||
// copied from the wrapped card - only its overridden jsonSerialize() reads through to
|
||||
// them. Capturing that return value here made every card's getDuedate()/getDaysUntilDue()
|
||||
// resolve to null, so hasPassed() was always false and no workflow ever matched a card.
|
||||
// Keep using the original, now-enriched $cards instead.
|
||||
$cardService->enrichCards($cards);
|
||||
// Deliberately not enriched: CardService::enrichCards() only adds
|
||||
// labels, assignees and comment counts, and runs
|
||||
// BoardService::find(), a permission check against Deck's frozen
|
||||
// uid (see beginUserContext()). Assignments, where needed for
|
||||
// mails, come from findNotificationRecipients() instead.
|
||||
$cards = $this->resolve(CardMapper::class)->findAllByStack($stackId);
|
||||
|
||||
return array_values(array_filter($cards, static function (Card $card) {
|
||||
if (method_exists($card, 'getDeletedAt') && (int)$card->getDeletedAt() > 0) {
|
||||
if (self::isTrashed($card)) {
|
||||
return false;
|
||||
}
|
||||
return !$card->getArchived() && $card->getDone() === null;
|
||||
@@ -550,74 +516,6 @@ class DeckIntegrationService {
|
||||
}, []);
|
||||
}
|
||||
|
||||
/**
|
||||
* The card date a workflow is evaluated against: Deck's due date or its
|
||||
* start date, per `Workflow::DATE_FIELD_*`. Anything unrecognised reads the
|
||||
* due date, which is what every workflow meant before the choice existed.
|
||||
*
|
||||
* The guard is `property_exists()`, deliberately, and this is the one thing
|
||||
* to get right here: **`method_exists()` cannot see Deck's getters.**
|
||||
* `Card`, `Board`, `Label`, `Acl` and `Assignment` declare none of them as
|
||||
* real code — `getStartdate()`, `getDuedate()`, even `getId()` all go
|
||||
* through `OCP\AppFramework\Db\Entity::__call()`, and `method_exists()`
|
||||
* ignores `__call()` by definition. A `method_exists($card, 'getStartdate')`
|
||||
* probe would therefore be false on *every* Deck version and silently turn
|
||||
* every start-date workflow into a no-op. `property_exists()` sees the
|
||||
* protected `$startdate` declaration and is exactly what `Entity::getter()`
|
||||
* checks internally before throwing.
|
||||
*
|
||||
* In practice the property is always there — `assertDeckAvailable()`
|
||||
* enforces Deck >= MIN_DECK_VERSION, which is the release that added it —
|
||||
* so this branch is a backstop for a hand-installed Deck, loud enough to be
|
||||
* found in the log rather than silently matching nothing.
|
||||
*/
|
||||
public function getCardDate(Card $card, string $dateField): ?DateTimeInterface {
|
||||
$property = self::CARD_DATE_PROPERTIES[$dateField] ?? self::CARD_DATE_PROPERTIES[self::DEFAULT_CARD_DATE];
|
||||
|
||||
if (!property_exists($card, $property)) {
|
||||
if (!isset($this->reportedMissingCardProperties[$property])) {
|
||||
$this->reportedMissingCardProperties[$property] = true;
|
||||
$this->logger->warning(
|
||||
'This Deck version has no Card::$' . $property . '; workflows using it cannot match any card',
|
||||
['app' => 'workflow_deck_automation'],
|
||||
);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
$value = $property === 'startdate' ? $card->getStartdate() : $card->getDuedate();
|
||||
return $value instanceof DateTimeInterface ? $value : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function getCardAssignedUserIds(Card $card): array {
|
||||
$assigned = $card->getAssignedUsers() ?? [];
|
||||
$uids = [];
|
||||
foreach ($assigned as $entry) {
|
||||
$uid = $this->extractParticipantUid($entry);
|
||||
if ($uid !== null) {
|
||||
$uids[] = $uid;
|
||||
}
|
||||
}
|
||||
return $uids;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return int[]
|
||||
*/
|
||||
public function getCardLabelIds(Card $card): array {
|
||||
$labels = $card->getLabels() ?? [];
|
||||
$ids = [];
|
||||
foreach ($labels as $label) {
|
||||
if (method_exists($label, 'getId')) {
|
||||
$ids[] = (int)$label->getId();
|
||||
}
|
||||
}
|
||||
return $ids;
|
||||
}
|
||||
|
||||
/**
|
||||
* Moves a card to another stack using Deck's own reorder logic
|
||||
* (the exact same code path behind Deck's "move card" action).
|
||||
@@ -664,31 +562,6 @@ class DeckIntegrationService {
|
||||
return Server::get($class);
|
||||
}
|
||||
|
||||
/**
|
||||
* Deck's assignment/ACL entries are internal, undocumented value
|
||||
* objects whose exact accessor shape has changed across versions, so
|
||||
* we probe the common accessor names defensively instead of relying
|
||||
* on one fixed method signature.
|
||||
*/
|
||||
private function extractParticipantUid(mixed $entry): ?string {
|
||||
$uid = $this->unwrapUid($entry);
|
||||
if ($uid !== null) {
|
||||
return $uid;
|
||||
}
|
||||
if (!is_object($entry)) {
|
||||
return null;
|
||||
}
|
||||
foreach (['getParticipant', 'getUid', 'getParticipantUid', 'getUserId'] as $method) {
|
||||
if (method_exists($entry, $method)) {
|
||||
$uid = $this->unwrapUid($entry->$method());
|
||||
if ($uid !== null) {
|
||||
return $uid;
|
||||
}
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Turns whatever Deck hands out for a "participant"/"owner" field into
|
||||
* a plain uid.
|
||||
|
||||
@@ -0,0 +1,91 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace OCA\WorkflowDeckAutomation\Service;
|
||||
|
||||
/**
|
||||
* Finds workflows that would hand cards around in a circle — pure logic, no
|
||||
* Nextcloud or Deck dependencies, so it is unit-testable like
|
||||
* NotificationPolicy.
|
||||
*
|
||||
* Every enabled workflow is an edge "source stack → target stack". Two
|
||||
* workflows S1 → S2 and S2 → S1 move a card back and forth on every run,
|
||||
* and since the runner reads each source stack afresh, even within a single
|
||||
* run — with a notice each time. The trigger date is deliberately ignored:
|
||||
* with S1 → S2 by start date and S2 → S1 by due date, every card whose two
|
||||
* dates have both passed still circles. A workflow whose source is its own
|
||||
* target is the shortest such loop.
|
||||
*
|
||||
* Deck's stack ids are unique across boards, so edges from several boards
|
||||
* can be passed in together without mixing anything up.
|
||||
*/
|
||||
class LoopDetector {
|
||||
/**
|
||||
* The edges for findPath() and findLoopingWorkflows(). Typed only in the
|
||||
* docblock, so the tests need no Nextcloud classes.
|
||||
*
|
||||
* @param iterable<\OCA\WorkflowDeckAutomation\Db\Workflow> $workflows
|
||||
* @return array<int, array{0: int, 1: int}>
|
||||
*/
|
||||
public static function edgesOf(iterable $workflows): array {
|
||||
$edges = [];
|
||||
foreach ($workflows as $workflow) {
|
||||
$edges[(int)$workflow->getId()] = [(int)$workflow->getSourceStackId(), (int)$workflow->getTargetStackId()];
|
||||
}
|
||||
return $edges;
|
||||
}
|
||||
|
||||
/**
|
||||
* The workflows leading from stack $from to stack $to, in order, or
|
||||
* `null` if there is no way. `[]` if $from already is $to.
|
||||
*
|
||||
* @param array<int, array{0: int, 1: int}> $edges workflow id => [source stack id, target stack id]
|
||||
* @return list<int>|null
|
||||
*/
|
||||
public static function findPath(array $edges, int $from, int $to): ?array {
|
||||
if ($from === $to) {
|
||||
return [];
|
||||
}
|
||||
|
||||
// Breadth-first, remembering how each stack was reached.
|
||||
$reachedBy = [$from => null];
|
||||
$queue = [$from];
|
||||
while ($queue !== []) {
|
||||
$stack = array_shift($queue);
|
||||
foreach ($edges as $id => [$source, $target]) {
|
||||
if ($source !== $stack || array_key_exists($target, $reachedBy)) {
|
||||
continue;
|
||||
}
|
||||
$reachedBy[$target] = [$id, $stack];
|
||||
if ($target === $to) {
|
||||
$path = [];
|
||||
for ($at = $to; $reachedBy[$at] !== null; $at = $reachedBy[$at][1]) {
|
||||
array_unshift($path, $reachedBy[$at][0]);
|
||||
}
|
||||
return $path;
|
||||
}
|
||||
$queue[] = $target;
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Ids of the workflows that lie on a loop: those whose target leads back
|
||||
* to their own source.
|
||||
*
|
||||
* @param array<int, array{0: int, 1: int}> $edges workflow id => [source stack id, target stack id]
|
||||
* @return list<int>
|
||||
*/
|
||||
public static function findLoopingWorkflows(array $edges): array {
|
||||
$looping = [];
|
||||
foreach ($edges as $id => [$source, $target]) {
|
||||
if (self::findPath($edges, $target, $source) !== null) {
|
||||
$looping[] = $id;
|
||||
}
|
||||
}
|
||||
return $looping;
|
||||
}
|
||||
}
|
||||
@@ -6,7 +6,6 @@ namespace OCA\WorkflowDeckAutomation\Service;
|
||||
|
||||
use OCA\Deck\Db\Card;
|
||||
use OCA\WorkflowDeckAutomation\Db\Workflow;
|
||||
use OCP\IL10N;
|
||||
use OCP\IURLGenerator;
|
||||
use OCP\IUser;
|
||||
use OCP\Mail\IEMailTemplate;
|
||||
@@ -15,89 +14,137 @@ use OCP\Util;
|
||||
use Psr\Log\LoggerInterface;
|
||||
use Throwable;
|
||||
|
||||
/**
|
||||
* The app is used internally only and speaks German, like its settings
|
||||
* page: texts are written in German directly instead of going through
|
||||
* IL10N with English source strings and a translation file.
|
||||
*/
|
||||
class NotificationMailer {
|
||||
private const APP_ID = 'workflow_deck_automation';
|
||||
|
||||
private const SENDER_NAME = 'Deck Workflow-Automatisierung';
|
||||
|
||||
/**
|
||||
* Descriptions are unbounded in Deck; keep the mail readable and well
|
||||
* clear of any MTA size limits.
|
||||
* Language of Nextcloud's own footer text ("automatically sent email,
|
||||
* please do not reply"), which would otherwise follow the instance
|
||||
* default — in cron there is no request to take a language from.
|
||||
*/
|
||||
private const MAX_DESCRIPTION_LENGTH = 2000;
|
||||
private const FOOTER_LANGUAGE = 'de';
|
||||
|
||||
public function __construct(
|
||||
private IMailer $mailer,
|
||||
private IURLGenerator $urlGenerator,
|
||||
private IL10N $l10n,
|
||||
private LoggerInterface $logger,
|
||||
) {
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array{board: string, sourceStack: string, targetStack: string} $targets
|
||||
* titles resolved by DeckIntegrationService::describeTargets()
|
||||
* One mail listing every card moved for $recipient in this run — they
|
||||
* may come from several workflows and boards.
|
||||
*
|
||||
* @param non-empty-list<array{workflow: Workflow, card: Card, targets: array{board: string, sourceStack: string, targetStack: string}}> $entries
|
||||
* targets are the titles resolved by DeckIntegrationService::describeTargets()
|
||||
*/
|
||||
public function sendCardMovedNotification(IUser $user, Workflow $workflow, Card $card, array $targets): void {
|
||||
$email = $user->getEMailAddress();
|
||||
public function sendCardsMovedNotification(IUser $recipient, array $entries): void {
|
||||
$email = $recipient->getEMailAddress();
|
||||
if ($email === null || $email === '') {
|
||||
$this->logger->info('Skipping notification for workflow ' . $workflow->getId() . ': user ' . $user->getUID() . ' has no email address', [
|
||||
'app' => 'workflow_deck_automation',
|
||||
$this->logger->info('Skipping moved-cards mail: user ' . $recipient->getUID() . ' has no email address', [
|
||||
'app' => self::APP_ID,
|
||||
]);
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
$cardLink = $this->urlGenerator->getAbsoluteURL(
|
||||
'/apps/deck/board/' . $workflow->getBoardId() . '/card/' . $card->getId(),
|
||||
);
|
||||
$count = count($entries);
|
||||
|
||||
$template = $this->mailer->createEMailTemplate('workflow_deck_automation.CardMoved', [
|
||||
'cardTitle' => $card->getTitle(),
|
||||
'workflowTitle' => $workflow->getTitle(),
|
||||
try {
|
||||
$template = $this->mailer->createEMailTemplate(self::APP_ID . '.CardsMoved', [
|
||||
'count' => $count,
|
||||
'cardTitles' => array_map(static fn (array $entry) => $entry['card']->getTitle(), $entries),
|
||||
]);
|
||||
$template->setSubject($this->l10n->t('Deck card moved: %s', [$card->getTitle()]));
|
||||
$template->setSubject($count === 1
|
||||
? sprintf('Deck-Karte verschoben: %s', $entries[0]['card']->getTitle())
|
||||
: sprintf('%d Deck-Karten verschoben', $count));
|
||||
$template->addHeader();
|
||||
$template->addHeading($this->l10n->t('A card was moved automatically'), false);
|
||||
// Two whole strings rather than one sentence with an interpolated
|
||||
// reason: the trigger is the point of the mail, and a translator
|
||||
// needs to see it in the sentence to get the grammar right.
|
||||
$reason = $workflow->getDateFieldOrDue() === Workflow::DATE_FIELD_START
|
||||
? $this->l10n->t(
|
||||
'The card "%1$s" was moved because its start date has been reached (workflow "%2$s").',
|
||||
[$card->getTitle(), $workflow->getTitle()],
|
||||
)
|
||||
: $this->l10n->t(
|
||||
'The card "%1$s" was moved because it is overdue (workflow "%2$s").',
|
||||
[$card->getTitle(), $workflow->getTitle()],
|
||||
);
|
||||
$template->addBodyText($reason);
|
||||
// Single-argument addBodyText() runs htmlspecialchars() itself, so
|
||||
// these board- and stack-titles (user input) are safe as-is —
|
||||
// unlike the description below, which passes both parts.
|
||||
$template->addBodyText($this->l10n->t(
|
||||
'Board "%1$s": moved from "%2$s" to "%3$s".',
|
||||
[$targets['board'], $targets['sourceStack'], $targets['targetStack']],
|
||||
));
|
||||
$this->addCardDescription($template, $card);
|
||||
$template->addBodyButton($this->l10n->t('Open card'), $cardLink);
|
||||
$template->addFooter();
|
||||
$template->addHeading($count === 1
|
||||
? 'Eine Karte wurde automatisch verschoben'
|
||||
: sprintf('%d Karten wurden automatisch verschoben', $count), false);
|
||||
|
||||
foreach ($entries as $entry) {
|
||||
$this->addCard($template, $entry['workflow'], $entry['card'], $entry['targets']);
|
||||
}
|
||||
|
||||
$template->addFooter('', self::FOOTER_LANGUAGE);
|
||||
|
||||
$message = $this->mailer->createMessage();
|
||||
$message->setTo([$email => $user->getDisplayName()]);
|
||||
$message->setFrom([Util::getDefaultEmailAddress('noreply') => $this->l10n->t('Deck Workflow Automation')]);
|
||||
$message->setTo([$email => $recipient->getDisplayName()]);
|
||||
$message->setFrom([Util::getDefaultEmailAddress('noreply') => self::SENDER_NAME]);
|
||||
$message->useTemplate($template);
|
||||
|
||||
$failedRecipients = $this->mailer->send($message);
|
||||
if (!empty($failedRecipients)) {
|
||||
$this->logger->error('Notification mail for card ' . $card->getId() . ' failed for: ' . implode(', ', $failedRecipients), [
|
||||
'app' => 'workflow_deck_automation',
|
||||
$this->logger->error('Moved-cards mail failed for: ' . implode(', ', $failedRecipients), [
|
||||
'app' => self::APP_ID,
|
||||
]);
|
||||
}
|
||||
} catch (Throwable $e) {
|
||||
$this->logger->error('Could not send notification mail for card ' . $card->getId() . ': ' . $e->getMessage(), [
|
||||
'app' => 'workflow_deck_automation',
|
||||
$this->logger->error('Could not send moved-cards mail to ' . $recipient->getUID() . ': ' . $e->getMessage(), [
|
||||
'app' => self::APP_ID,
|
||||
'exception' => $e,
|
||||
]);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array{board: string, sourceStack: string, targetStack: string} $targets
|
||||
*/
|
||||
private function addCard(IEMailTemplate $template, Workflow $workflow, Card $card, array $targets): void {
|
||||
// The card description and the workflow's name are deliberately left
|
||||
// out — the mail only says what moved where, and why. The card title
|
||||
// itself is the link to the card.
|
||||
$sentence = '„%1$s“ (Board „%2$s“) %5$s und wurde von „%3$s“ nach „%4$s“ verschoben.';
|
||||
$reason = TriggerDate::describeReason((string)$workflow->getTriggerDate());
|
||||
$url = $this->urlGenerator->getAbsoluteURL('/apps/deck/board/' . $workflow->getBoardId() . '/card/' . $card->getId());
|
||||
|
||||
// With both parts passed, addBodyText() escapes nothing: every title
|
||||
// is user input and has to be escaped here for the HTML part.
|
||||
$html = sprintf(
|
||||
$sentence,
|
||||
'<a href="' . self::escape($url) . '">' . self::escape($card->getTitle()) . '</a>',
|
||||
self::escape($targets['board']),
|
||||
self::escape($targets['sourceStack']),
|
||||
self::escape($targets['targetStack']),
|
||||
self::escape($reason),
|
||||
);
|
||||
$plain = sprintf(
|
||||
$sentence,
|
||||
$card->getTitle(),
|
||||
$targets['board'],
|
||||
$targets['sourceStack'],
|
||||
$targets['targetStack'],
|
||||
$reason,
|
||||
) . PHP_EOL . $url;
|
||||
|
||||
$template->addBodyText($html, $plain);
|
||||
}
|
||||
|
||||
private static function escape(string $text): string {
|
||||
return htmlspecialchars($text, ENT_QUOTES, 'UTF-8');
|
||||
}
|
||||
|
||||
/**
|
||||
* Completes "… wurde ausgeschaltet, weil %s." — shared with
|
||||
* Notification\Notifier so mail and notification give the same reason.
|
||||
*
|
||||
* @param WorkflowRunner::TARGET_* $brokenTarget
|
||||
*/
|
||||
public static function describeBrokenTarget(string $brokenTarget): string {
|
||||
return match ($brokenTarget) {
|
||||
WorkflowRunner::TARGET_SOURCE_STACK => 'sein Quell-Stapel nicht mehr existiert',
|
||||
WorkflowRunner::TARGET_TARGET_STACK => 'sein Ziel-Stapel nicht mehr existiert',
|
||||
default => 'sein Board nicht mehr existiert oder für dich nicht mehr verfügbar ist',
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* One-off notice that a workflow was switched off because the board or
|
||||
* stack it points at is gone.
|
||||
@@ -108,81 +155,49 @@ class NotificationMailer {
|
||||
$email = $user->getEMailAddress();
|
||||
if ($email === null || $email === '') {
|
||||
$this->logger->info('Cannot notify about disabled workflow ' . $workflow->getId() . ': user ' . $user->getUID() . ' has no email address', [
|
||||
'app' => 'workflow_deck_automation',
|
||||
'app' => self::APP_ID,
|
||||
]);
|
||||
return;
|
||||
}
|
||||
|
||||
$reason = match ($brokenTarget) {
|
||||
WorkflowRunner::TARGET_SOURCE_STACK => $this->l10n->t('its source stack no longer exists'),
|
||||
WorkflowRunner::TARGET_TARGET_STACK => $this->l10n->t('its target stack no longer exists'),
|
||||
default => $this->l10n->t('its board no longer exists or is no longer available to you'),
|
||||
};
|
||||
$reason = self::describeBrokenTarget($brokenTarget);
|
||||
|
||||
try {
|
||||
$settingsLink = $this->urlGenerator->getAbsoluteURL('/settings/user/workflow_deck_automation');
|
||||
$settingsLink = $this->urlGenerator->getAbsoluteURL('/settings/user/' . self::APP_ID);
|
||||
|
||||
$template = $this->mailer->createEMailTemplate('workflow_deck_automation.WorkflowDisabled', [
|
||||
$template = $this->mailer->createEMailTemplate(self::APP_ID . '.WorkflowDisabled', [
|
||||
'workflowTitle' => $workflow->getTitle(),
|
||||
]);
|
||||
$template->setSubject($this->l10n->t('Deck workflow deactivated: %s', [$workflow->getTitle()]));
|
||||
$template->setSubject(sprintf('Deck-Workflow deaktiviert: %s', $workflow->getTitle()));
|
||||
$template->addHeader();
|
||||
$template->addHeading($this->l10n->t('A workflow was deactivated'), false);
|
||||
$template->addBodyText($this->l10n->t(
|
||||
'The workflow "%1$s" was switched off automatically because %2$s. No cards are being moved by it any more.',
|
||||
[$workflow->getTitle(), $reason],
|
||||
$template->addHeading('Ein Workflow wurde deaktiviert', false);
|
||||
$template->addBodyText(sprintf(
|
||||
'Der Workflow „%1$s“ wurde automatisch ausgeschaltet, weil %2$s. Er verschiebt keine Karten mehr.',
|
||||
$workflow->getTitle(),
|
||||
$reason,
|
||||
));
|
||||
$template->addBodyText($this->l10n->t(
|
||||
'Delete the workflow or point it at an existing board and stack to reactivate it. You will not be reminded about this workflow again.',
|
||||
));
|
||||
$template->addBodyButton($this->l10n->t('Open settings'), $settingsLink);
|
||||
$template->addFooter();
|
||||
$template->addBodyText(
|
||||
'Lösche den Workflow oder stelle ein vorhandenes Board und vorhandene Stapel ein, um ihn wieder zu aktivieren. An diesen Workflow wirst du nicht noch einmal erinnert.',
|
||||
);
|
||||
$template->addBodyButton('Einstellungen öffnen', $settingsLink);
|
||||
$template->addFooter('', self::FOOTER_LANGUAGE);
|
||||
|
||||
$message = $this->mailer->createMessage();
|
||||
$message->setTo([$email => $user->getDisplayName()]);
|
||||
$message->setFrom([Util::getDefaultEmailAddress('noreply') => $this->l10n->t('Deck Workflow Automation')]);
|
||||
$message->setFrom([Util::getDefaultEmailAddress('noreply') => self::SENDER_NAME]);
|
||||
$message->useTemplate($template);
|
||||
|
||||
$failedRecipients = $this->mailer->send($message);
|
||||
if (!empty($failedRecipients)) {
|
||||
$this->logger->error('Deactivation mail for workflow ' . $workflow->getId() . ' failed for: ' . implode(', ', $failedRecipients), [
|
||||
'app' => 'workflow_deck_automation',
|
||||
'app' => self::APP_ID,
|
||||
]);
|
||||
}
|
||||
} catch (Throwable $e) {
|
||||
$this->logger->error('Could not send deactivation mail for workflow ' . $workflow->getId() . ': ' . $e->getMessage(), [
|
||||
'app' => 'workflow_deck_automation',
|
||||
'app' => self::APP_ID,
|
||||
'exception' => $e,
|
||||
]);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Appends the card's description, if it has one.
|
||||
*
|
||||
* Deck stores the description as Markdown. It is sent as-is rather than
|
||||
* rendered: pulling a Markdown parser in just for the mail would be a
|
||||
* lot of machinery, and unrendered Markdown still reads fine.
|
||||
*/
|
||||
private function addCardDescription(IEMailTemplate $template, Card $card): void {
|
||||
$description = trim((string)$card->getDescription());
|
||||
if ($description === '') {
|
||||
return;
|
||||
}
|
||||
|
||||
if (mb_strlen($description) > self::MAX_DESCRIPTION_LENGTH) {
|
||||
$description = mb_substr($description, 0, self::MAX_DESCRIPTION_LENGTH) . ' […]';
|
||||
}
|
||||
|
||||
$template->addBodyText($this->l10n->t('Card content:'));
|
||||
|
||||
// addBodyText() only runs htmlspecialchars() when it has to build the
|
||||
// plain-text part itself. Passing both parts means escaping is on us
|
||||
// -- and it has to be, because a card description is user input that
|
||||
// would otherwise land unescaped in the HTML mail.
|
||||
$template->addBodyText(
|
||||
nl2br(htmlspecialchars($description, ENT_QUOTES, 'UTF-8'), false),
|
||||
$description,
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,94 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace OCA\WorkflowDeckAutomation\Service;
|
||||
|
||||
/**
|
||||
* Who hears about a moved card, and how — pure logic, no Nextcloud or Deck
|
||||
* dependencies, so it is unit-testable like WorkflowRunner::hasPassed().
|
||||
*/
|
||||
class NotificationPolicy {
|
||||
/** No mail at all. */
|
||||
public const MODE_OFF = 'off';
|
||||
/** Only the workflow's owner (the board owner), regardless of Deck settings. */
|
||||
public const MODE_OWNER = 'owner';
|
||||
/** Everyone with access to the board, filtered by their own Deck setting. */
|
||||
public const MODE_BOARD = 'board';
|
||||
|
||||
public const MODES = [self::MODE_OFF, self::MODE_OWNER, self::MODE_BOARD];
|
||||
|
||||
/** One mail per recipient and run. */
|
||||
public const CHANNEL_MAIL = 'mail';
|
||||
/** One Nextcloud notification (bell, push to the mobile apps) per card. */
|
||||
public const CHANNEL_NOTIFICATION = 'notification';
|
||||
public const CHANNEL_BOTH = 'both';
|
||||
|
||||
public const CHANNELS = [self::CHANNEL_MAIL, self::CHANNEL_NOTIFICATION, self::CHANNEL_BOTH];
|
||||
|
||||
/**
|
||||
* Values of Deck's per-user, per-board preference
|
||||
* `deck` / `board:<boardId>:notify-due` (Deck's
|
||||
* ConfigService::SETTING_BOARD_NOTIFICATION_DUE_*), inlined so a renamed
|
||||
* constant cannot fatal this app. It is the board's "Notifications" menu
|
||||
* in Deck — the due-date reminder setting, which is exactly what fits a
|
||||
* card being moved because it fell due.
|
||||
*/
|
||||
public const DECK_OFF = 'off';
|
||||
public const DECK_ASSIGNED = 'assigned';
|
||||
public const DECK_ALL = 'all';
|
||||
/** What Deck assumes for a user who never touched the setting. */
|
||||
public const DECK_DEFAULT = self::DECK_ASSIGNED;
|
||||
|
||||
public static function isValidMode(string $mode): bool {
|
||||
return in_array($mode, self::MODES, true);
|
||||
}
|
||||
|
||||
public static function isValidChannel(string $channel): bool {
|
||||
return in_array($channel, self::CHANNELS, true);
|
||||
}
|
||||
|
||||
/**
|
||||
* An unknown channel counts as `mail`, the column default — mail was the
|
||||
* only channel before the column existed.
|
||||
*/
|
||||
public static function sendsMail(string $channel): bool {
|
||||
return $channel !== self::CHANNEL_NOTIFICATION;
|
||||
}
|
||||
|
||||
public static function sendsNotification(string $channel): bool {
|
||||
return $channel === self::CHANNEL_NOTIFICATION || $channel === self::CHANNEL_BOTH;
|
||||
}
|
||||
|
||||
/**
|
||||
* Mirrors Deck's own decision in NotificationHelper::sendCardDuedate():
|
||||
*
|
||||
* - `off` never notifies — not even the owner of an unshared board;
|
||||
* - `all` always notifies;
|
||||
* - the owner of an unshared board is notified for every card, since on a
|
||||
* board nobody else can see "assigned" would otherwise mean nothing;
|
||||
* - `assigned` notifies users assigned to the card, directly or through a
|
||||
* group or circle.
|
||||
*
|
||||
* An unknown value is treated as Deck's default. Deck rejects anything
|
||||
* else when storing the setting, so that only happens if the preference
|
||||
* was edited by hand.
|
||||
*
|
||||
* @param bool|callable(): bool $isAssigned a callable is only invoked when
|
||||
* the answer actually depends on it — it costs a query per user
|
||||
*/
|
||||
public static function shouldNotify(string $deckSetting, bool $isOwnerOfUnsharedBoard, bool|callable $isAssigned): bool {
|
||||
if (!in_array($deckSetting, [self::DECK_OFF, self::DECK_ASSIGNED, self::DECK_ALL], true)) {
|
||||
$deckSetting = self::DECK_DEFAULT;
|
||||
}
|
||||
|
||||
if ($deckSetting === self::DECK_OFF) {
|
||||
return false;
|
||||
}
|
||||
if ($deckSetting === self::DECK_ALL || $isOwnerOfUnsharedBoard) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return is_callable($isAssigned) ? (bool)$isAssigned() : $isAssigned;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,134 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace OCA\WorkflowDeckAutomation\Service;
|
||||
|
||||
use OCA\Deck\Db\Card;
|
||||
use OCA\WorkflowDeckAutomation\AppInfo\Application;
|
||||
use OCA\WorkflowDeckAutomation\Db\Workflow;
|
||||
use OCP\App\IAppManager;
|
||||
use OCP\AppFramework\Utility\ITimeFactory;
|
||||
use OCP\IUser;
|
||||
use OCP\Notification\IManager;
|
||||
use Psr\Log\LoggerInterface;
|
||||
use Throwable;
|
||||
|
||||
/**
|
||||
* Nextcloud notifications (the bell, and from there push to the mobile and
|
||||
* desktop clients) — the counterpart to NotificationMailer. Only the raw
|
||||
* values are stored here; Notification\Notifier turns them into text when a
|
||||
* client fetches the notification.
|
||||
*
|
||||
* Without the notifications app nothing is sent and nothing is logged as an
|
||||
* error: the app is optional, and IManager would just drop the notification.
|
||||
*/
|
||||
class NotificationPusher {
|
||||
public const SUBJECT_CARD_MOVED = 'card_moved';
|
||||
public const SUBJECT_WORKFLOW_DISABLED = 'workflow_disabled';
|
||||
|
||||
public const OBJECT_CARD = 'card';
|
||||
public const OBJECT_WORKFLOW = 'workflow';
|
||||
|
||||
private const NOTIFICATIONS_APP = 'notifications';
|
||||
|
||||
public function __construct(
|
||||
private IManager $notificationManager,
|
||||
private IAppManager $appManager,
|
||||
private ITimeFactory $timeFactory,
|
||||
private LoggerInterface $logger,
|
||||
) {
|
||||
}
|
||||
|
||||
public function isAvailableFor(IUser $user): bool {
|
||||
try {
|
||||
return $this->appManager->isEnabledForUser(self::NOTIFICATIONS_APP, $user);
|
||||
} catch (Throwable $e) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* One notification per card, unlike the mail: each one links its card
|
||||
* and can be dismissed on its own. An older notification about the same
|
||||
* card is removed first, so a card that comes back and falls due again
|
||||
* is not listed twice.
|
||||
*
|
||||
* @param non-empty-list<array{workflow: Workflow, card: Card, targets: array{board: string, sourceStack: string, targetStack: string}}> $entries
|
||||
*/
|
||||
public function sendCardsMovedNotification(IUser $recipient, array $entries): void {
|
||||
if (!$this->isAvailableFor($recipient)) {
|
||||
return;
|
||||
}
|
||||
|
||||
foreach ($entries as $entry) {
|
||||
$workflow = $entry['workflow'];
|
||||
$card = $entry['card'];
|
||||
$targets = $entry['targets'];
|
||||
|
||||
try {
|
||||
$this->dismiss($recipient, self::OBJECT_CARD, (string)$card->getId(), self::SUBJECT_CARD_MOVED);
|
||||
|
||||
$notification = $this->notificationManager->createNotification();
|
||||
$notification->setApp(Application::APP_ID)
|
||||
->setUser($recipient->getUID())
|
||||
->setDateTime($this->timeFactory->getDateTime())
|
||||
->setObject(self::OBJECT_CARD, (string)$card->getId())
|
||||
->setSubject(self::SUBJECT_CARD_MOVED, [
|
||||
'cardTitle' => (string)$card->getTitle(),
|
||||
'boardId' => $workflow->getBoardId(),
|
||||
'boardTitle' => $targets['board'],
|
||||
'sourceStackId' => $workflow->getSourceStackId(),
|
||||
'sourceStackTitle' => $targets['sourceStack'],
|
||||
'targetStackId' => $workflow->getTargetStackId(),
|
||||
'targetStackTitle' => $targets['targetStack'],
|
||||
'triggerDate' => (string)$workflow->getTriggerDate(),
|
||||
]);
|
||||
$this->notificationManager->notify($notification);
|
||||
} catch (Throwable $e) {
|
||||
$this->logger->error('Could not notify ' . $recipient->getUID() . ' about moved card ' . $card->getId() . ': ' . $e->getMessage(), [
|
||||
'app' => Application::APP_ID,
|
||||
'exception' => $e,
|
||||
]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Companion to NotificationMailer::sendWorkflowDisabledNotification().
|
||||
*
|
||||
* @param WorkflowRunner::TARGET_* $brokenTarget
|
||||
*/
|
||||
public function sendWorkflowDisabledNotification(IUser $user, Workflow $workflow, string $brokenTarget): void {
|
||||
if (!$this->isAvailableFor($user)) {
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
$notification = $this->notificationManager->createNotification();
|
||||
$notification->setApp(Application::APP_ID)
|
||||
->setUser($user->getUID())
|
||||
->setDateTime($this->timeFactory->getDateTime())
|
||||
->setObject(self::OBJECT_WORKFLOW, (string)$workflow->getId())
|
||||
->setSubject(self::SUBJECT_WORKFLOW_DISABLED, [
|
||||
'workflowTitle' => (string)$workflow->getTitle(),
|
||||
'brokenTarget' => $brokenTarget,
|
||||
]);
|
||||
$this->notificationManager->notify($notification);
|
||||
} catch (Throwable $e) {
|
||||
$this->logger->error('Could not notify ' . $user->getUID() . ' about disabled workflow ' . $workflow->getId() . ': ' . $e->getMessage(), [
|
||||
'app' => Application::APP_ID,
|
||||
'exception' => $e,
|
||||
]);
|
||||
}
|
||||
}
|
||||
|
||||
private function dismiss(IUser $user, string $objectType, string $objectId, string $subject): void {
|
||||
$notification = $this->notificationManager->createNotification();
|
||||
$notification->setApp(Application::APP_ID)
|
||||
->setUser($user->getUID())
|
||||
->setObject($objectType, $objectId)
|
||||
->setSubject($subject);
|
||||
$this->notificationManager->markProcessed($notification);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace OCA\WorkflowDeckAutomation\Service;
|
||||
|
||||
/**
|
||||
* Which of a card's dates moves it — pure logic, no Nextcloud or Deck
|
||||
* dependencies, so it is unit-testable like NotificationPolicy.
|
||||
*/
|
||||
class TriggerDate {
|
||||
/** Deck's `duedate`: the card is moved once it is overdue. */
|
||||
public const DUE = 'due';
|
||||
/** Deck's `startdate`: the card is moved once its start date is reached. */
|
||||
public const START = 'start';
|
||||
|
||||
public const ALL = [self::DUE, self::START];
|
||||
|
||||
public static function isValid(string $trigger): bool {
|
||||
return in_array($trigger, self::ALL, true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Completes "„<card>“ … %s und wurde … verschoben" — shared by
|
||||
* NotificationMailer and Notification\Notifier so mail and notification
|
||||
* give the same reason. An unknown value counts as `due`, the column
|
||||
* default — the due date was the only trigger before the column existed.
|
||||
*/
|
||||
public static function describeReason(string $trigger): string {
|
||||
return $trigger === self::START
|
||||
? 'hat ihr Startdatum erreicht'
|
||||
: 'ist überfällig';
|
||||
}
|
||||
}
|
||||
+248
-140
@@ -4,7 +4,9 @@ declare(strict_types=1);
|
||||
|
||||
namespace OCA\WorkflowDeckAutomation\Service;
|
||||
|
||||
use DateTimeImmutable;
|
||||
use DateTimeInterface;
|
||||
use DateTimeZone;
|
||||
use OCA\Deck\Db\Card;
|
||||
use OCA\WorkflowDeckAutomation\Db\Workflow;
|
||||
use OCA\WorkflowDeckAutomation\Db\WorkflowMapper;
|
||||
@@ -17,8 +19,8 @@ use Psr\Log\LoggerInterface;
|
||||
use Throwable;
|
||||
|
||||
/**
|
||||
* Evaluates all enabled workflows and moves the cards whose watched date -
|
||||
* Deck's due date or its start date, per workflow - has passed.
|
||||
* Evaluates all enabled workflows and moves every card whose due date or
|
||||
* start date — whichever the workflow uses, see TriggerDate — has passed.
|
||||
*
|
||||
* This runner has to evaluate rules for many different users within a
|
||||
* single background-job process, so workflows are grouped by owner and
|
||||
@@ -37,10 +39,20 @@ class WorkflowRunner {
|
||||
|
||||
private ?IUser $impersonationRestore = null;
|
||||
|
||||
/**
|
||||
* Moved cards per recipient uid, collected over the whole run. Each
|
||||
* entry's workflow says whether it goes out by mail, as a Nextcloud
|
||||
* notification, or both.
|
||||
*
|
||||
* @var array<string, list<array{workflow: Workflow, card: Card, targets: array{board: string, sourceStack: string, targetStack: string}}>>
|
||||
*/
|
||||
private array $pendingNotices = [];
|
||||
|
||||
public function __construct(
|
||||
private WorkflowMapper $workflowMapper,
|
||||
private DeckIntegrationService $deckService,
|
||||
private NotificationMailer $mailer,
|
||||
private NotificationPusher $pusher,
|
||||
private IUserManager $userManager,
|
||||
private IUserSession $userSession,
|
||||
private IRootFolder $rootFolder,
|
||||
@@ -55,8 +67,25 @@ class WorkflowRunner {
|
||||
return;
|
||||
}
|
||||
|
||||
// The controller refuses to store a loop, but workflows saved before
|
||||
// that check — including ones whose source is their own target — can
|
||||
// still form one. They would move the same cards on every run, with a
|
||||
// notice each time, so they are left out until the user fixes them;
|
||||
// the settings page marks them.
|
||||
$looping = LoopDetector::findLoopingWorkflows(LoopDetector::edgesOf($workflows));
|
||||
|
||||
$this->pendingNotices = [];
|
||||
$byUser = [];
|
||||
$owners = [];
|
||||
foreach ($workflows as $workflow) {
|
||||
$this->followBoardOwner($workflow, $owners);
|
||||
if (in_array((int)$workflow->getId(), $looping, true)) {
|
||||
$this->logger->warning('Skipping workflow {id}: it moves cards in a loop together with other workflows', [
|
||||
'app' => 'workflow_deck_automation',
|
||||
'id' => $workflow->getId(),
|
||||
]);
|
||||
continue;
|
||||
}
|
||||
$byUser[$workflow->getUserId()][] = $workflow;
|
||||
}
|
||||
|
||||
@@ -77,6 +106,57 @@ class WorkflowRunner {
|
||||
]);
|
||||
}
|
||||
}
|
||||
|
||||
$this->sendPendingNotices();
|
||||
}
|
||||
|
||||
/**
|
||||
* A workflow belongs to its board's owner, not to whoever created it: if
|
||||
* Deck transferred the board, the workflow moves along to the new owner —
|
||||
* it then runs as them, and they get its mails.
|
||||
*
|
||||
* Only a known owner rewrites `user_id`. A board that is gone keeps its
|
||||
* last owner, so findBrokenTarget() can disable the workflow and mail
|
||||
* them; a Deck error keeps it too, and the run just goes ahead as before.
|
||||
*
|
||||
* @param array<int, ?string> $owners per-run cache, board id => owner
|
||||
*/
|
||||
private function followBoardOwner(Workflow $workflow, array &$owners): void {
|
||||
$boardId = $workflow->getBoardId();
|
||||
if (!array_key_exists($boardId, $owners)) {
|
||||
try {
|
||||
$owners[$boardId] = $this->deckService->findBoardOwner($boardId);
|
||||
} catch (Throwable $e) {
|
||||
$this->logger->warning('Could not determine the owner of board {board}: ' . $e->getMessage(), [
|
||||
'app' => 'workflow_deck_automation',
|
||||
'board' => $boardId,
|
||||
]);
|
||||
$owners[$boardId] = null;
|
||||
}
|
||||
}
|
||||
|
||||
$owner = $owners[$boardId];
|
||||
if ($owner === null || $owner === $workflow->getUserId()) {
|
||||
return;
|
||||
}
|
||||
|
||||
$this->logger->info('Workflow {id} follows board {board} to its new owner {owner}.', [
|
||||
'app' => 'workflow_deck_automation',
|
||||
'id' => $workflow->getId(),
|
||||
'board' => $boardId,
|
||||
'owner' => $owner,
|
||||
]);
|
||||
$workflow->setUserId($owner);
|
||||
try {
|
||||
$this->workflowMapper->update($workflow);
|
||||
} catch (Throwable $e) {
|
||||
// Not persisted, but this run still goes to the right user; the
|
||||
// next one tries again.
|
||||
$this->logger->warning('Could not store the new owner of workflow {id}: ' . $e->getMessage(), [
|
||||
'app' => 'workflow_deck_automation',
|
||||
'id' => $workflow->getId(),
|
||||
]);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -149,6 +229,25 @@ class WorkflowRunner {
|
||||
return;
|
||||
}
|
||||
|
||||
// An archived board is intact, just shelved: the workflow is skipped,
|
||||
// not disabled, and resumes once the board is unarchived.
|
||||
try {
|
||||
$archived = $this->deckService->isBoardArchived($workflow->getBoardId());
|
||||
} catch (DeckUnavailableException $e) {
|
||||
$this->logger->warning('Could not check whether the board of workflow {id} is archived: ' . $e->getMessage(), [
|
||||
'app' => 'workflow_deck_automation',
|
||||
'id' => $workflow->getId(),
|
||||
]);
|
||||
return;
|
||||
}
|
||||
if ($archived) {
|
||||
$this->logger->debug('Skipping workflow {id}: its board is archived', [
|
||||
'app' => 'workflow_deck_automation',
|
||||
'id' => $workflow->getId(),
|
||||
]);
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
$cards = $this->deckService->getActiveCardsInStack($workflow->getSourceStackId());
|
||||
} catch (DeckUnavailableException $e) {
|
||||
@@ -159,53 +258,142 @@ class WorkflowRunner {
|
||||
return;
|
||||
}
|
||||
|
||||
$filterUserIds = $workflow->getFilterUserIdsArray();
|
||||
$filterLabelIds = $workflow->getFilterLabelIdsArray();
|
||||
$this->warnAboutDeadFilters($workflow, $filterUserIds, $filterLabelIds);
|
||||
|
||||
// Resolved at most once per run, and only if a card actually moves
|
||||
// and the workflow wants a mail — this is decoration, not a check.
|
||||
$targets = null;
|
||||
$trigger = (string)$workflow->getTriggerDate();
|
||||
if ($trigger === TriggerDate::START && !$this->deckService->supportsStartdate()) {
|
||||
// Not disabled: the workflow is intact, Deck is just too old for
|
||||
// it, and comes back to life with a Deck update.
|
||||
$this->logger->warning('Skipping workflow {id}: this Deck version has no start date', [
|
||||
'app' => 'workflow_deck_automation',
|
||||
'id' => $workflow->getId(),
|
||||
]);
|
||||
return;
|
||||
}
|
||||
|
||||
$moved = [];
|
||||
$now = $this->timeFactory->getDateTime();
|
||||
$dateField = $workflow->getDateFieldOrDue();
|
||||
|
||||
foreach ($cards as $card) {
|
||||
if (!self::hasPassed($this->deckService->getCardDate($card, $dateField), $now)) {
|
||||
// Anything but `start` counts as `due`, the column default.
|
||||
$date = $trigger === TriggerDate::START ? $card->getStartdate() : $card->getDuedate();
|
||||
if (!self::hasPassed($date, $now)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$assignedUserIds = $this->deckService->getCardAssignedUserIds($card);
|
||||
$labelIds = $this->deckService->getCardLabelIds($card);
|
||||
if (!self::cardMatchesFilters($assignedUserIds, $labelIds, $filterUserIds, $filterLabelIds)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$this->logger->info('Card {card} ("{title}") matches workflow {id} on its {dateField} date; moving to stack {target}.', [
|
||||
$this->logger->info('Card {card} ("{title}") matches workflow {id}; moving to stack {target}.', [
|
||||
'app' => 'workflow_deck_automation',
|
||||
'card' => $card->getId(),
|
||||
'title' => $card->getTitle(),
|
||||
'id' => $workflow->getId(),
|
||||
'dateField' => $dateField,
|
||||
'target' => $workflow->getTargetStackId(),
|
||||
]);
|
||||
|
||||
if (!$this->moveCard($workflow, $card)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($workflow->getNotifyEmail()) {
|
||||
$targets ??= $this->deckService->describeTargets(
|
||||
$workflow->getBoardId(),
|
||||
$workflow->getSourceStackId(),
|
||||
$workflow->getTargetStackId(),
|
||||
);
|
||||
$this->mailer->sendCardMovedNotification($user, $workflow, $card, $targets);
|
||||
if ($this->moveCard($workflow, $card)) {
|
||||
$moved[] = $card;
|
||||
}
|
||||
}
|
||||
|
||||
$workflow->setLastRun($this->timeFactory->getDateTime());
|
||||
$this->workflowMapper->update($workflow);
|
||||
|
||||
if ($moved !== []) {
|
||||
$this->queueNotices($user, $workflow, $moved);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Works out who hears about the moved cards and parks them in
|
||||
* $pendingNotices; sendPendingNotices() delivers them at the end of the
|
||||
* run. The recipients are the same for mail and notification.
|
||||
*
|
||||
* Notices are decoration, not part of the move: nothing in here may fail
|
||||
* the workflow, and if Deck cannot say who wants one, nobody gets one
|
||||
* rather than people who asked Deck for silence.
|
||||
*
|
||||
* @param Card[] $cards
|
||||
*/
|
||||
private function queueNotices(IUser $owner, Workflow $workflow, array $cards): void {
|
||||
$cardIds = array_map(static fn (Card $card): int => (int)$card->getId(), $cards);
|
||||
|
||||
switch ($workflow->getNotifyMode()) {
|
||||
case NotificationPolicy::MODE_OWNER:
|
||||
$recipients = array_fill_keys($cardIds, [$owner->getUID()]);
|
||||
break;
|
||||
case NotificationPolicy::MODE_BOARD:
|
||||
try {
|
||||
$recipients = $this->deckService->findNotificationRecipients($workflow->getBoardId(), $cardIds);
|
||||
} catch (DeckUnavailableException $e) {
|
||||
$this->logger->warning('No mails or notifications for workflow {id}: ' . $e->getMessage(), [
|
||||
'app' => 'workflow_deck_automation',
|
||||
'id' => $workflow->getId(),
|
||||
]);
|
||||
return;
|
||||
}
|
||||
break;
|
||||
default:
|
||||
return;
|
||||
}
|
||||
|
||||
$targets = $this->deckService->describeTargets(
|
||||
$workflow->getBoardId(),
|
||||
$workflow->getSourceStackId(),
|
||||
$workflow->getTargetStackId(),
|
||||
);
|
||||
|
||||
foreach ($cards as $card) {
|
||||
foreach ($recipients[(int)$card->getId()] ?? [] as $uid) {
|
||||
$this->pendingNotices[$uid][] = [
|
||||
'workflow' => $workflow,
|
||||
'card' => $card,
|
||||
'targets' => $targets,
|
||||
];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* One mail per recipient and run, however many cards and workflows it
|
||||
* covers — a board with twenty overdue cards and fifteen members would
|
||||
* otherwise send three hundred mails at once. Nextcloud notifications
|
||||
* go out per card instead: they are grouped in the bell anyway, and each
|
||||
* one links its card.
|
||||
*
|
||||
* Runs after the per-user loop, so no impersonation is active any more.
|
||||
*/
|
||||
private function sendPendingNotices(): void {
|
||||
$pending = $this->pendingNotices;
|
||||
$this->pendingNotices = [];
|
||||
|
||||
foreach ($pending as $uid => $entries) {
|
||||
// Same reasoning as in run(): nothing may escape.
|
||||
try {
|
||||
$recipient = $this->userManager->get((string)$uid);
|
||||
if ($recipient === null || !$recipient->isEnabled()) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$mailEntries = array_values(array_filter(
|
||||
$entries,
|
||||
static fn (array $entry): bool => NotificationPolicy::sendsMail((string)$entry['workflow']->getNotifyChannel()),
|
||||
));
|
||||
$notificationEntries = array_values(array_filter(
|
||||
$entries,
|
||||
static fn (array $entry): bool => NotificationPolicy::sendsNotification((string)$entry['workflow']->getNotifyChannel()),
|
||||
));
|
||||
|
||||
if ($mailEntries !== []) {
|
||||
$this->mailer->sendCardsMovedNotification($recipient, $mailEntries);
|
||||
}
|
||||
if ($notificationEntries !== []) {
|
||||
$this->pusher->sendCardsMovedNotification($recipient, $notificationEntries);
|
||||
}
|
||||
} catch (Throwable $e) {
|
||||
$this->logger->error('Could not notify {user} about moved cards: ' . $e->getMessage(), [
|
||||
'app' => 'workflow_deck_automation',
|
||||
'user' => $uid,
|
||||
'exception' => $e,
|
||||
]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -249,11 +437,14 @@ class WorkflowRunner {
|
||||
'target' => $brokenTarget,
|
||||
]);
|
||||
|
||||
// Sent regardless of the workflow's notifyEmail setting: that flag is
|
||||
// about moved cards, this is a one-off notice that the automation the
|
||||
// user configured has been switched off. It stays one-off because a
|
||||
// disabled workflow is not picked up again.
|
||||
// Sent to the owner regardless of the workflow's notifyMode and
|
||||
// notifyChannel: those are about moved cards, this is a one-off notice
|
||||
// that the automation the user configured has been switched off — by
|
||||
// mail as always, and in the bell too if the notifications app is
|
||||
// there. It stays one-off because a disabled workflow is not picked
|
||||
// up again.
|
||||
$this->mailer->sendWorkflowDisabledNotification($user, $workflow, $brokenTarget);
|
||||
$this->pusher->sendWorkflowDisabledNotification($user, $workflow, $brokenTarget);
|
||||
}
|
||||
|
||||
private function moveCard(Workflow $workflow, Card $card): bool {
|
||||
@@ -280,55 +471,8 @@ class WorkflowRunner {
|
||||
}
|
||||
|
||||
/**
|
||||
* A filter whose every entry has been deleted from the board is not an
|
||||
* error — the workflow still runs, it just cannot match a single card any
|
||||
* more, forever, without anything in the UI or the log saying so. That is
|
||||
* the one failure mode of this app that is completely invisible, so it
|
||||
* gets a log line on every run.
|
||||
*
|
||||
* Explicitly *not* a reason to disable the workflow or mail the user: a
|
||||
* filter with three labels of which one was deleted still works as
|
||||
* intended, and even a fully dead filter may be one board edit away from
|
||||
* being live again. The settings page shows the same condition in red.
|
||||
*
|
||||
* @param string[] $filterUserIds
|
||||
* @param int[] $filterLabelIds
|
||||
*/
|
||||
private function warnAboutDeadFilters(Workflow $workflow, array $filterUserIds, array $filterLabelIds): void {
|
||||
if ($filterUserIds === [] && $filterLabelIds === []) {
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
$options = $this->deckService->findFilterOptions($workflow->getBoardId());
|
||||
} catch (DeckUnavailableException $e) {
|
||||
// Same rule as everywhere else: no answer is not a bad answer.
|
||||
$this->logger->debug('Could not check the filters of workflow {id}: ' . $e->getMessage(), [
|
||||
'app' => 'workflow_deck_automation',
|
||||
'id' => $workflow->getId(),
|
||||
]);
|
||||
return;
|
||||
}
|
||||
|
||||
$dead = self::findDeadFilters($filterUserIds, $filterLabelIds, $options['participantUids'], $options['labelIds']);
|
||||
|
||||
if ($dead !== []) {
|
||||
$this->logger->warning(
|
||||
'Workflow {id} can no longer match any card: none of its ' . implode('/', $dead)
|
||||
. ' filter entries exists on board {board} any more',
|
||||
[
|
||||
'app' => 'workflow_deck_automation',
|
||||
'id' => $workflow->getId(),
|
||||
'board' => $workflow->getBoardId(),
|
||||
],
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether the card date a workflow watches - its due date or its start date,
|
||||
* see Workflow::DATE_FIELD_* - lies in the past. A card without that date set
|
||||
* is never picked up.
|
||||
* Whether the card's trigger date (due or start date, see TriggerDate)
|
||||
* lies before $now.
|
||||
*
|
||||
* Compares the card's actual timestamp against $now instead of Deck's own
|
||||
* Card::getDaysUntilDue(), which truncates both sides to midnight before diffing
|
||||
@@ -336,69 +480,33 @@ class WorkflowRunner {
|
||||
* for any card whose due time has already passed today. That silently held back
|
||||
* every card for up to 24h after it actually fell due; comparing the raw datetime
|
||||
* instead matches what Deck's own UI shows (e.g. "vor 2 Stunden") and has no
|
||||
* day-rounding step to get wrong. The same reasoning applies unchanged to the
|
||||
* start date, which is why this is one function and not two.
|
||||
* day-rounding step to get wrong.
|
||||
*
|
||||
* Both sides are compared as absolute instants, and the card's date is
|
||||
* first pinned to UTC via asStoredUtc() — see there for why.
|
||||
*/
|
||||
public static function hasPassed(?DateTimeInterface $cardDate, DateTimeInterface $now): bool {
|
||||
return $cardDate !== null && $cardDate < $now;
|
||||
public static function hasPassed(?DateTimeInterface $date, DateTimeInterface $now): bool {
|
||||
return $date !== null && self::asStoredUtc($date) < $now;
|
||||
}
|
||||
|
||||
/**
|
||||
* Which filters cannot match anything any more, because not one of their
|
||||
* entries is still offered by the board. An empty filter is not dead, it
|
||||
* is "no restriction on this dimension" — the same reading as in
|
||||
* cardMatchesFilters(), and getting it backwards would report every
|
||||
* unfiltered workflow as broken.
|
||||
* Deck's `duedate` and `startdate` are DATETIME columns without a zone
|
||||
* that hold UTC wall-clock time: Deck's frontend sends `toISOString()`,
|
||||
* and the value is written as plain `Y-m-d H:i:s`. Entity hydrates it
|
||||
* with `new \DateTime($string)`, i.e. in PHP's *default* timezone —
|
||||
* correct only because Nextcloud sets that default to UTC during
|
||||
* bootstrap. Reading the wall clock and pinning it to UTC explicitly
|
||||
* makes the comparison independent of that default, so a server or CLI
|
||||
* running with a local default zone cannot shift every date by its UTC
|
||||
* offset.
|
||||
*
|
||||
* Static and side-effect free for the same reason as the matching logic:
|
||||
* testable without a Deck installation.
|
||||
*
|
||||
* @param string[] $filterUserIds
|
||||
* @param int[] $filterLabelIds
|
||||
* @param string[] $boardUserIds everyone who can hold a card on the board
|
||||
* @param int[] $boardLabelIds the board's remaining labels
|
||||
* @return string[] any of 'label', 'user', in that order
|
||||
* Deck itself has two timezone-sensitive paths this deliberately avoids:
|
||||
* Card::getDaysUntilDue() (day-truncated, see hasPassed()) and
|
||||
* CardMapper::findOverdue(), which compares the UTC column against the
|
||||
* database's `NOW()` — the DB session's local time.
|
||||
*/
|
||||
public static function findDeadFilters(
|
||||
array $filterUserIds,
|
||||
array $filterLabelIds,
|
||||
array $boardUserIds,
|
||||
array $boardLabelIds,
|
||||
): array {
|
||||
$dead = [];
|
||||
if ($filterLabelIds !== [] && array_intersect($filterLabelIds, $boardLabelIds) === []) {
|
||||
$dead[] = 'label';
|
||||
}
|
||||
if ($filterUserIds !== [] && array_intersect($filterUserIds, $boardUserIds) === []) {
|
||||
$dead[] = 'user';
|
||||
}
|
||||
return $dead;
|
||||
}
|
||||
|
||||
/**
|
||||
* Pure filter-matching logic (kept static/side-effect free so it can
|
||||
* be unit tested without real Deck objects). Both filters are OR
|
||||
* inside themselves and AND between each other: an empty filter list
|
||||
* means "no restriction on this dimension".
|
||||
*
|
||||
* @param string[] $cardAssignedUserIds
|
||||
* @param int[] $cardLabelIds
|
||||
* @param string[] $filterUserIds
|
||||
* @param int[] $filterLabelIds
|
||||
*/
|
||||
public static function cardMatchesFilters(
|
||||
array $cardAssignedUserIds,
|
||||
array $cardLabelIds,
|
||||
array $filterUserIds,
|
||||
array $filterLabelIds,
|
||||
): bool {
|
||||
if ($filterUserIds !== [] && array_intersect($filterUserIds, $cardAssignedUserIds) === []) {
|
||||
return false;
|
||||
}
|
||||
if ($filterLabelIds !== [] && array_intersect($filterLabelIds, $cardLabelIds) === []) {
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
private static function asStoredUtc(DateTimeInterface $date): DateTimeImmutable {
|
||||
return new DateTimeImmutable($date->format('Y-m-d H:i:s.u'), new DateTimeZone('UTC'));
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -5,17 +5,31 @@ declare(strict_types=1);
|
||||
namespace OCA\WorkflowDeckAutomation\Settings;
|
||||
|
||||
use OCA\WorkflowDeckAutomation\AppInfo\Application;
|
||||
use OCA\WorkflowDeckAutomation\Service\NotificationPusher;
|
||||
use OCP\AppFramework\Http\TemplateResponse;
|
||||
use OCP\IUserSession;
|
||||
use OCP\Settings\ISettings;
|
||||
use OCP\Util;
|
||||
|
||||
class Personal implements ISettings {
|
||||
public function __construct(
|
||||
private NotificationPusher $pusher,
|
||||
private IUserSession $userSession,
|
||||
) {
|
||||
}
|
||||
|
||||
public function getForm(): TemplateResponse {
|
||||
// The bundle names carry the app-id prefix that @nextcloud/vite-config adds.
|
||||
Util::addScript(Application::APP_ID, Application::APP_ID . '-personal-settings');
|
||||
Util::addStyle(Application::APP_ID, Application::APP_ID . '-personal-settings');
|
||||
|
||||
return new TemplateResponse(Application::APP_ID, 'settings/personal', [], '');
|
||||
// Only used for a hint in the form: without the notifications app the
|
||||
// job silently sends no Nextcloud notifications.
|
||||
$user = $this->userSession->getUser();
|
||||
|
||||
return new TemplateResponse(Application::APP_ID, 'settings/personal', [
|
||||
'notificationsAvailable' => $user !== null && $this->pusher->isAvailableFor($user),
|
||||
], '');
|
||||
}
|
||||
|
||||
public function getSection(): string {
|
||||
|
||||
@@ -5,13 +5,11 @@ declare(strict_types=1);
|
||||
namespace OCA\WorkflowDeckAutomation\Settings;
|
||||
|
||||
use OCA\WorkflowDeckAutomation\AppInfo\Application;
|
||||
use OCP\IL10N;
|
||||
use OCP\IURLGenerator;
|
||||
use OCP\Settings\IIconSection;
|
||||
|
||||
class PersonalSection implements IIconSection {
|
||||
public function __construct(
|
||||
private IL10N $l10n,
|
||||
private IURLGenerator $urlGenerator,
|
||||
) {
|
||||
}
|
||||
@@ -21,7 +19,8 @@ class PersonalSection implements IIconSection {
|
||||
}
|
||||
|
||||
public function getName(): string {
|
||||
return $this->l10n->t('Deck workflow automation');
|
||||
// German only, like the rest of this internal app.
|
||||
return 'Deck Workflow-Automatisierung';
|
||||
}
|
||||
|
||||
public function getPriority(): int {
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "workflow_deck_automation",
|
||||
"version": "34.1.0",
|
||||
"version": "35.4.0",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"description": "Automates moving overdue Deck cards between stacks, configurable per user.",
|
||||
|
||||
+201
-177
@@ -1,7 +1,7 @@
|
||||
<template>
|
||||
<NcSettingsSection
|
||||
name="Deck Workflow-Automatisierung"
|
||||
description="Verschiebt Karten automatisch aus einem Deck-Stapel in einen anderen, sobald ihr Fälligkeits- oder Startdatum erreicht ist. Ein Hintergrundjob prüft die Regeln alle paar Minuten.">
|
||||
description="Verschiebt Karten aus einem Deck-Stapel automatisch in einen anderen Stapel, sobald ihr Fälligkeits- oder Startdatum erreicht ist. Ein Hintergrundjob prüft die Regeln alle paar Minuten.">
|
||||
<NcNoteCard v-if="loadError" type="error">
|
||||
{{ loadError }}
|
||||
</NcNoteCard>
|
||||
@@ -14,18 +14,19 @@
|
||||
<table v-if="workflows.length" class="wfda-table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Board</th>
|
||||
<th>Titel</th>
|
||||
<th>Von Stapel</th>
|
||||
<th>Nach Stapel</th>
|
||||
<th>Auslöser</th>
|
||||
<th>Filter</th>
|
||||
<th>E-Mail</th>
|
||||
<th>Benachrichtigung</th>
|
||||
<th>Aktiv</th>
|
||||
<th />
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr v-for="workflow in workflows" :key="workflow.id">
|
||||
<tr v-for="workflow in sortedWorkflows" :key="workflow.id">
|
||||
<td>{{ boardLabel(workflow.boardId) }}</td>
|
||||
<td>
|
||||
{{ workflow.title }}
|
||||
<span v-if="workflowIssues[workflow.id]" class="wfda-issue">
|
||||
@@ -34,17 +35,9 @@
|
||||
</td>
|
||||
<td>{{ stackLabel(workflow.boardId, workflow.sourceStackId) }}</td>
|
||||
<td>{{ stackLabel(workflow.boardId, workflow.targetStackId) }}</td>
|
||||
<td>{{ dateFieldLabel(workflow.dateField) }}</td>
|
||||
<td>
|
||||
<span v-if="!workflow.filterUserIds.length && !workflow.filterLabelIds.length">–</span>
|
||||
<span v-else>
|
||||
<span v-if="workflow.filterUserIds.length">{{ workflow.filterUserIds.length }} Benutzer</span>
|
||||
<span v-if="workflow.filterUserIds.length && workflow.filterLabelIds.length">, </span>
|
||||
<span v-if="workflow.filterLabelIds.length">{{ workflow.filterLabelIds.length }} Label</span>
|
||||
</span>
|
||||
</td>
|
||||
<td>{{ workflow.notifyEmail ? 'Ja' : 'Nein' }}</td>
|
||||
<td>{{ workflow.enabled ? 'Ja' : 'Nein' }}</td>
|
||||
<td>{{ triggerLabel(workflow) }}</td>
|
||||
<td>{{ notifyLabel(workflow) }}</td>
|
||||
<td>{{ yesNo(workflow.enabled) }}</td>
|
||||
<td class="wfda-actions">
|
||||
<NcButton variant="tertiary" @click="editWorkflow(workflow)">
|
||||
Bearbeiten
|
||||
@@ -77,6 +70,12 @@
|
||||
:reduce="option => option.value"
|
||||
placeholder="Board wählen"
|
||||
@update:model-value="onBoardChange" />
|
||||
<NcNoteCard v-if="archivedBoardNote" type="warning">
|
||||
{{ archivedBoardNote }}
|
||||
</NcNoteCard>
|
||||
<NcNoteCard v-if="!boardOptions.length" type="info">
|
||||
Workflows können nur für Boards angelegt werden, deren Eigentümer du bist.
|
||||
</NcNoteCard>
|
||||
|
||||
<NcSelect
|
||||
v-model="form.sourceStackId"
|
||||
@@ -94,55 +93,61 @@
|
||||
:disabled="!form.boardId"
|
||||
placeholder="Ziel-Stapel wählen" />
|
||||
|
||||
<fieldset class="wfda-fieldset">
|
||||
<legend>Auslösendes Datum</legend>
|
||||
<!--
|
||||
v-model + value + type="radio" + a shared name is the
|
||||
@nextcloud/vue 9 radio API: v-model carries the group's
|
||||
current value, value the one this button stands for. Do
|
||||
not reach for :checked.sync here - Vue 3 dropped .sync,
|
||||
and it would silently never update.
|
||||
-->
|
||||
<fieldset class="wfda-notify">
|
||||
<legend>Karte verschieben, wenn</legend>
|
||||
<NcCheckboxRadioSwitch
|
||||
v-model="form.dateField"
|
||||
value="due"
|
||||
name="wfda-date-field"
|
||||
type="radio">
|
||||
Fälligkeitsdatum überschritten
|
||||
</NcCheckboxRadioSwitch>
|
||||
<NcCheckboxRadioSwitch
|
||||
v-model="form.dateField"
|
||||
value="start"
|
||||
name="wfda-date-field"
|
||||
type="radio">
|
||||
Startdatum erreicht
|
||||
v-for="option in triggerOptions"
|
||||
:key="option.value"
|
||||
v-model="form.triggerDate"
|
||||
type="radio"
|
||||
name="wfda-trigger-date"
|
||||
:value="option.value">
|
||||
{{ option.label }}
|
||||
</NcCheckboxRadioSwitch>
|
||||
<p class="wfda-hint">
|
||||
Karten ohne das gewählte Datum werden nie verschoben.
|
||||
Karten ohne das gewählte Datum bleiben liegen.
|
||||
</p>
|
||||
</fieldset>
|
||||
|
||||
<NcSelect
|
||||
v-model="form.filterUserIds"
|
||||
input-label="Nur für zugewiesene Benutzer (optional)"
|
||||
:options="participantOptions"
|
||||
:reduce="option => option.value"
|
||||
:disabled="!form.boardId"
|
||||
multiple
|
||||
placeholder="Alle Benutzer" />
|
||||
<fieldset class="wfda-notify">
|
||||
<legend>Benachrichtigung bei verschobenen Karten</legend>
|
||||
<NcCheckboxRadioSwitch
|
||||
v-for="option in notifyOptions"
|
||||
:key="option.value"
|
||||
v-model="form.notifyMode"
|
||||
type="radio"
|
||||
name="wfda-notify-mode"
|
||||
:value="option.value">
|
||||
{{ option.label }}
|
||||
</NcCheckboxRadioSwitch>
|
||||
<p v-if="form.notifyMode === 'board'" class="wfda-hint">
|
||||
Jedes Board-Mitglied wird entsprechend seiner eigenen
|
||||
Deck-Einstellung „Benachrichtigungen“ für dieses Board informiert: bei „Alle Karten“ immer,
|
||||
bei „Zugewiesene Karten“ nur für Karten, denen es zugewiesen ist, bei „Keine“ nie.
|
||||
</p>
|
||||
</fieldset>
|
||||
|
||||
<NcSelect
|
||||
v-model="form.filterLabelIds"
|
||||
input-label="Nur mit Label (optional)"
|
||||
:options="labelOptions"
|
||||
:reduce="option => option.value"
|
||||
:disabled="!form.boardId"
|
||||
multiple
|
||||
placeholder="Alle Labels" />
|
||||
|
||||
<NcCheckboxRadioSwitch v-model="form.notifyEmail">
|
||||
Benachrichtigungs-E-Mail an mich senden
|
||||
</NcCheckboxRadioSwitch>
|
||||
<fieldset v-if="form.notifyMode !== 'off'" class="wfda-notify">
|
||||
<legend>Benachrichtigen per</legend>
|
||||
<NcCheckboxRadioSwitch
|
||||
v-for="option in channelOptions"
|
||||
:key="option.value"
|
||||
v-model="form.notifyChannel"
|
||||
type="radio"
|
||||
name="wfda-notify-channel"
|
||||
:value="option.value">
|
||||
{{ option.label }}
|
||||
</NcCheckboxRadioSwitch>
|
||||
<p class="wfda-hint">
|
||||
Mehrere Karten eines Laufs werden zu einer E-Mail zusammengefasst.
|
||||
Nextcloud-Benachrichtigungen erscheinen pro Karte in der Glocke und als Push-Nachricht
|
||||
in den Nextcloud-Apps auf Handy und Desktop.
|
||||
</p>
|
||||
<NcNoteCard v-if="!props.notificationsAvailable && form.notifyChannel !== 'mail'" type="warning">
|
||||
Die App „Benachrichtigungen“ ist auf dieser Nextcloud nicht aktiviert.
|
||||
Nextcloud-Benachrichtigungen werden deshalb nicht verschickt.
|
||||
</NcNoteCard>
|
||||
</fieldset>
|
||||
|
||||
<NcCheckboxRadioSwitch v-model="form.enabled">
|
||||
Workflow aktiv
|
||||
@@ -178,34 +183,75 @@ import {
|
||||
createWorkflow,
|
||||
deleteWorkflow,
|
||||
fetchBoards,
|
||||
fetchLabels,
|
||||
fetchParticipants,
|
||||
fetchStacks,
|
||||
fetchWorkflows,
|
||||
updateWorkflow,
|
||||
} from './api.js'
|
||||
|
||||
const props = defineProps({
|
||||
// Whether the notifications app is enabled for the current user, from
|
||||
// the data attribute set in templates/settings/personal.php.
|
||||
notificationsAvailable: {
|
||||
type: Boolean,
|
||||
default: true,
|
||||
},
|
||||
})
|
||||
|
||||
const loading = ref(true)
|
||||
const loadError = ref('')
|
||||
const workflows = ref([])
|
||||
const boards = ref([])
|
||||
// Per board, and `null` whenever the request failed — see loadStacksFor().
|
||||
const stacksByBoard = reactive({})
|
||||
const labelsByBoard = reactive({})
|
||||
const participantsByBoard = reactive({})
|
||||
|
||||
const showForm = ref(false)
|
||||
const saving = ref(false)
|
||||
const formError = ref('')
|
||||
const editingId = ref(null)
|
||||
// Shown when the workflow being edited sits on an archived board.
|
||||
const archivedBoardNote = ref('')
|
||||
|
||||
const stackOptions = ref([])
|
||||
const labelOptions = ref([])
|
||||
const participantOptions = ref([])
|
||||
// Which board the three lists above currently belong to.
|
||||
// Which board the list above currently belongs to.
|
||||
const loadedBoardId = ref(null)
|
||||
|
||||
const boardOptions = computed(() => boards.value.map((board) => ({ value: board.id, label: board.title })))
|
||||
const collator = new Intl.Collator(undefined, { numeric: true, sensitivity: 'base' })
|
||||
|
||||
// The backend only returns boards the user owns. Archived ones are in there
|
||||
// so their workflows keep a board name, but are never offered — not even
|
||||
// when editing a workflow that sits on one, see editWorkflow().
|
||||
const boardOptions = computed(() => boards.value
|
||||
.filter((board) => !board.archived)
|
||||
.map((board) => ({ value: board.id, label: board.title }))
|
||||
.sort((a, b) => collator.compare(a.label, b.label)))
|
||||
|
||||
/**
|
||||
* Alphabetical by the columns as displayed, left to right: board, title,
|
||||
* source stack, target stack, trigger, notification, active.
|
||||
*/
|
||||
const sortedWorkflows = computed(() => {
|
||||
const sortKeys = (workflow) => [
|
||||
boardLabel(workflow.boardId),
|
||||
workflow.title,
|
||||
stackLabel(workflow.boardId, workflow.sourceStackId),
|
||||
stackLabel(workflow.boardId, workflow.targetStackId),
|
||||
triggerLabel(workflow),
|
||||
notifyLabel(workflow),
|
||||
yesNo(workflow.enabled),
|
||||
]
|
||||
return workflows.value
|
||||
.map((workflow) => ({ workflow, keys: sortKeys(workflow) }))
|
||||
.sort((a, b) => {
|
||||
for (let i = 0; i < a.keys.length; i++) {
|
||||
const result = collator.compare(a.keys[i], b.keys[i])
|
||||
if (result !== 0) {
|
||||
return result
|
||||
}
|
||||
}
|
||||
return a.workflow.id - b.workflow.id
|
||||
})
|
||||
.map((entry) => entry.workflow)
|
||||
})
|
||||
|
||||
// Source and target must differ, so each dropdown hides what the other one
|
||||
// already holds — the error message on save stays as the backstop for
|
||||
@@ -214,21 +260,17 @@ const sourceStackOptions = computed(() => stackOptions.value.filter((option) =>
|
||||
const targetStackOptions = computed(() => stackOptions.value.filter((option) => option.value !== form.sourceStackId))
|
||||
|
||||
/**
|
||||
* Workflows that stopped working, keyed by id. Two different kinds:
|
||||
*
|
||||
* - Board or stacks deleted in Deck. The background job switches these off
|
||||
* by itself, but a row that just stopped working needs to say so instead
|
||||
* of looking healthy.
|
||||
* - Every entry of a filter deleted from the board. Nothing switches those
|
||||
* off — deliberately, since one deleted label out of three is harmless —
|
||||
* yet a filter that cannot match a single card any more is otherwise
|
||||
* completely invisible: the workflow keeps running and moves nothing.
|
||||
* Workflows that do not run as configured, keyed by id: board or stacks
|
||||
* deleted in Deck (the background job switches these off by itself), board
|
||||
* archived, or part of a loop (both skipped). A row that just stopped
|
||||
* working needs to say so instead of looking healthy.
|
||||
*/
|
||||
const workflowIssues = computed(() => {
|
||||
const issues = {}
|
||||
|
||||
for (const workflow of workflows.value) {
|
||||
if (!boards.value.some((board) => board.id === workflow.boardId)) {
|
||||
const board = boards.value.find((entry) => entry.id === workflow.boardId)
|
||||
if (!board) {
|
||||
issues[workflow.id] = 'Board nicht mehr vorhanden'
|
||||
continue
|
||||
}
|
||||
@@ -248,35 +290,25 @@ const workflowIssues = computed(() => {
|
||||
}
|
||||
}
|
||||
|
||||
const dead = []
|
||||
if (isDeadFilter(workflow.filterLabelIds, labelsByBoard[workflow.boardId], 'id')) {
|
||||
dead.push('Label-Filter')
|
||||
// Not disabled, just skipped by the background job until the board
|
||||
// is taken out of the archive again.
|
||||
if (board.archived) {
|
||||
issues[workflow.id] = 'Board archiviert, wird übersprungen'
|
||||
continue
|
||||
}
|
||||
if (isDeadFilter(workflow.filterUserIds, participantsByBoard[workflow.boardId], 'uid')) {
|
||||
dead.push('Benutzer-Filter')
|
||||
}
|
||||
if (dead.length > 1) {
|
||||
issues[workflow.id] = `${dead.join(' und ')} treffen keine Karte mehr`
|
||||
} else if (dead.length) {
|
||||
issues[workflow.id] = `${dead[0]} trifft keine Karte mehr`
|
||||
|
||||
// Set by the server for workflows stored before loops were refused;
|
||||
// the background job skips them.
|
||||
if (workflow.loop) {
|
||||
issues[workflow.id] = workflow.sourceStackId === workflow.targetStackId
|
||||
? 'Quell- und Ziel-Stapel sind gleich, wird übersprungen'
|
||||
: 'Bildet mit anderen Workflows eine Schleife, wird übersprungen'
|
||||
}
|
||||
}
|
||||
|
||||
return issues
|
||||
})
|
||||
|
||||
/**
|
||||
* True only on positive knowledge: the filter has entries, the board's list
|
||||
* was actually loaded, and not one entry is still on it. A failed request
|
||||
* (null) says nothing and must not turn a healthy row red.
|
||||
*/
|
||||
function isDeadFilter(selected, available, key) {
|
||||
if (!selected.length || !available) {
|
||||
return false
|
||||
}
|
||||
return !selected.some((value) => available.some((entry) => entry[key] === value))
|
||||
}
|
||||
|
||||
const form = reactive(emptyForm())
|
||||
|
||||
function emptyForm() {
|
||||
@@ -285,16 +317,53 @@ function emptyForm() {
|
||||
boardId: null,
|
||||
sourceStackId: null,
|
||||
targetStackId: null,
|
||||
filterUserIds: [],
|
||||
filterLabelIds: [],
|
||||
dateField: 'due',
|
||||
notifyEmail: false,
|
||||
triggerDate: 'due',
|
||||
notifyMode: 'off',
|
||||
notifyChannel: 'mail',
|
||||
enabled: true,
|
||||
}
|
||||
}
|
||||
|
||||
function dateFieldLabel(dateField) {
|
||||
return dateField === 'start' ? 'Startdatum' : 'Fälligkeit'
|
||||
// Values match TriggerDate::ALL on the server.
|
||||
const triggerOptions = [
|
||||
{ value: 'due', label: 'das Fälligkeitsdatum überschritten ist (Karte ist überfällig)', short: 'Fälligkeit' },
|
||||
{ value: 'start', label: 'das Startdatum erreicht ist', short: 'Startdatum' },
|
||||
]
|
||||
|
||||
// Values match NotificationPolicy::MODES on the server.
|
||||
const notifyOptions = [
|
||||
{ value: 'off', label: 'Keine Benachrichtigung', short: 'Keine' },
|
||||
{ value: 'owner', label: 'Nur an mich', short: 'Nur ich' },
|
||||
{ value: 'board', label: 'An Board-Mitglieder laut ihrer Deck-Einstellung', short: 'Board-Mitglieder' },
|
||||
]
|
||||
|
||||
// Values match NotificationPolicy::CHANNELS on the server.
|
||||
const channelOptions = [
|
||||
{ value: 'mail', label: 'E-Mail', short: 'E-Mail' },
|
||||
{ value: 'notification', label: 'Nextcloud-Benachrichtigung (Push)', short: 'Push' },
|
||||
{ value: 'both', label: 'E-Mail und Nextcloud-Benachrichtigung', short: 'E-Mail + Push' },
|
||||
]
|
||||
|
||||
function triggerLabel(workflow) {
|
||||
return triggerOptions.find((option) => option.value === workflow.triggerDate)?.short ?? workflow.triggerDate
|
||||
}
|
||||
|
||||
function notifyLabel(workflow) {
|
||||
const mode = notifyOptions.find((option) => option.value === workflow.notifyMode)?.short ?? workflow.notifyMode
|
||||
if (workflow.notifyMode === 'off') {
|
||||
return mode
|
||||
}
|
||||
const channel = channelOptions.find((option) => option.value === workflow.notifyChannel)?.short ?? workflow.notifyChannel
|
||||
return `${mode} (${channel})`
|
||||
}
|
||||
|
||||
function boardLabel(boardId) {
|
||||
const board = boards.value.find((entry) => entry.id === boardId)
|
||||
return board ? board.title : `#${boardId}`
|
||||
}
|
||||
|
||||
function yesNo(value) {
|
||||
return value ? 'Ja' : 'Nein'
|
||||
}
|
||||
|
||||
function stackLabel(boardId, stackId) {
|
||||
@@ -316,23 +385,6 @@ async function loadStacksFor(boardId) {
|
||||
stacksByBoard[boardId] = await fetchStacks(boardId).catch(() => null)
|
||||
}
|
||||
|
||||
/**
|
||||
* Labels and participants of a board — needed only to judge whether a stored
|
||||
* filter can still match anything, so this is fetched just for the boards of
|
||||
* workflows that actually use filters.
|
||||
*/
|
||||
async function loadFiltersFor(boardId) {
|
||||
if (!boardId || labelsByBoard[boardId]) {
|
||||
return
|
||||
}
|
||||
const [labels, participants] = await Promise.all([
|
||||
fetchLabels(boardId).catch(() => null),
|
||||
fetchParticipants(boardId).catch(() => null),
|
||||
])
|
||||
labelsByBoard[boardId] = labels
|
||||
participantsByBoard[boardId] = participants
|
||||
}
|
||||
|
||||
async function loadAll() {
|
||||
loading.value = true
|
||||
loadError.value = ''
|
||||
@@ -340,13 +392,7 @@ async function loadAll() {
|
||||
const [loadedWorkflows, loadedBoards] = await Promise.all([fetchWorkflows(), fetchBoards()])
|
||||
workflows.value = loadedWorkflows
|
||||
boards.value = loadedBoards
|
||||
await Promise.all(loadedWorkflows.flatMap((workflow) => {
|
||||
const pending = [loadStacksFor(workflow.boardId)]
|
||||
if (workflow.filterLabelIds.length || workflow.filterUserIds.length) {
|
||||
pending.push(loadFiltersFor(workflow.boardId))
|
||||
}
|
||||
return pending
|
||||
}))
|
||||
await Promise.all(loadedWorkflows.map((workflow) => loadStacksFor(workflow.boardId)))
|
||||
} catch (e) {
|
||||
loadError.value = 'Konnte Workflows oder Deck-Boards nicht laden. Ist die Deck-App aktiviert?'
|
||||
} finally {
|
||||
@@ -355,36 +401,25 @@ async function loadAll() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Fills the stack/label/user dropdowns for a board without touching the
|
||||
* current selection — that separation matters: editing a workflow has to
|
||||
* load the same options but must keep the stored stacks and filters.
|
||||
* Fills the stack dropdowns for a board without touching the current
|
||||
* selection — that separation matters: editing a workflow has to load the
|
||||
* same options but must keep the stored stacks.
|
||||
*/
|
||||
async function loadBoardOptions(boardId) {
|
||||
stackOptions.value = []
|
||||
labelOptions.value = []
|
||||
participantOptions.value = []
|
||||
loadedBoardId.value = boardId ?? null
|
||||
|
||||
if (!boardId) {
|
||||
return
|
||||
}
|
||||
|
||||
// One failing endpoint must not take the other two dropdowns down with it.
|
||||
const [stacks, labels, participants] = await Promise.all([
|
||||
fetchStacks(boardId).catch(() => null),
|
||||
fetchLabels(boardId).catch(() => null),
|
||||
fetchParticipants(boardId).catch(() => null),
|
||||
])
|
||||
const stacks = await fetchStacks(boardId).catch(() => null)
|
||||
|
||||
// Feed the overview's caches too, so its red markers agree with what the
|
||||
// Feed the overview's cache too, so its red markers agree with what the
|
||||
// form just loaded. `null` propagates on purpose: it means "unknown".
|
||||
stacksByBoard[boardId] = stacks
|
||||
labelsByBoard[boardId] = labels
|
||||
participantsByBoard[boardId] = participants
|
||||
|
||||
stackOptions.value = (stacks ?? []).map((stack) => ({ value: stack.id, label: stack.title }))
|
||||
labelOptions.value = (labels ?? []).map((label) => ({ value: label.id, label: label.title }))
|
||||
participantOptions.value = (participants ?? []).map((participant) => ({ value: participant.uid, label: participant.displayName }))
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -399,8 +434,9 @@ async function onBoardChange(boardId) {
|
||||
|
||||
form.sourceStackId = null
|
||||
form.targetStackId = null
|
||||
form.filterUserIds = []
|
||||
form.filterLabelIds = []
|
||||
if (boardId) {
|
||||
archivedBoardNote.value = ''
|
||||
}
|
||||
|
||||
await loadBoardOptions(boardId)
|
||||
}
|
||||
@@ -409,27 +445,33 @@ function startCreate() {
|
||||
Object.assign(form, emptyForm())
|
||||
editingId.value = null
|
||||
formError.value = ''
|
||||
archivedBoardNote.value = ''
|
||||
loadBoardOptions(null)
|
||||
showForm.value = true
|
||||
}
|
||||
|
||||
async function editWorkflow(workflow) {
|
||||
// An archived board is not offered and would be refused on save, so the
|
||||
// form starts without it rather than holding an id no option matches.
|
||||
const archivedBoard = boards.value.find((board) => board.id === workflow.boardId && board.archived)
|
||||
archivedBoardNote.value = archivedBoard
|
||||
? `Das Board „${archivedBoard.title}“ ist archiviert. Wähle ein anderes Board oder hole es in Deck aus dem Archiv.`
|
||||
: ''
|
||||
|
||||
Object.assign(form, {
|
||||
title: workflow.title,
|
||||
boardId: workflow.boardId,
|
||||
sourceStackId: workflow.sourceStackId,
|
||||
targetStackId: workflow.targetStackId,
|
||||
filterUserIds: [...workflow.filterUserIds],
|
||||
filterLabelIds: [...workflow.filterLabelIds],
|
||||
// Workflows stored before this field existed come back without it.
|
||||
dateField: workflow.dateField || 'due',
|
||||
notifyEmail: workflow.notifyEmail,
|
||||
boardId: archivedBoard ? null : workflow.boardId,
|
||||
sourceStackId: archivedBoard ? null : workflow.sourceStackId,
|
||||
targetStackId: archivedBoard ? null : workflow.targetStackId,
|
||||
triggerDate: workflow.triggerDate || 'due',
|
||||
notifyMode: workflow.notifyMode,
|
||||
notifyChannel: workflow.notifyChannel || 'mail',
|
||||
enabled: workflow.enabled,
|
||||
})
|
||||
editingId.value = workflow.id
|
||||
formError.value = ''
|
||||
showForm.value = true
|
||||
await loadBoardOptions(workflow.boardId)
|
||||
await loadBoardOptions(form.boardId)
|
||||
}
|
||||
|
||||
function cancelForm() {
|
||||
@@ -531,23 +573,13 @@ onMounted(loadAll)
|
||||
border-radius: var(--border-radius-large);
|
||||
}
|
||||
|
||||
.wfda-form-actions {
|
||||
display: flex;
|
||||
gap: 8px;
|
||||
}
|
||||
|
||||
.wfda-fieldset {
|
||||
.wfda-notify {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 4px;
|
||||
/* The form already draws its own frame; the browser default would put a
|
||||
second box around just this group. */
|
||||
border: none;
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.wfda-fieldset legend {
|
||||
.wfda-notify legend {
|
||||
font-weight: bold;
|
||||
margin-bottom: 4px;
|
||||
}
|
||||
@@ -557,16 +589,8 @@ onMounted(loadAll)
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
/*
|
||||
* NcSelect positions the clear/open icons (.vs__actions) absolutely relative
|
||||
* to the outer .v-select wrapper, while the dropdown menu itself opens
|
||||
* relative to .vs__dropdown-toggle (its $refs.toggle) — normally the same
|
||||
* box, but any width mismatch between the two (e.g. from global Nextcloud
|
||||
* input styles bleeding into the scoped component) shifts the icons off the
|
||||
* visible border of single-value selects like Board/Quell-/Ziel-Stapel.
|
||||
* Anchoring both to .vs__dropdown-toggle keeps them in sync.
|
||||
*/
|
||||
:deep(.v-select.select:not(.vs--multiple) .vs__dropdown-toggle) {
|
||||
position: relative;
|
||||
.wfda-form-actions {
|
||||
display: flex;
|
||||
gap: 8px;
|
||||
}
|
||||
</style>
|
||||
-10
@@ -33,13 +33,3 @@ export async function fetchStacks(boardId) {
|
||||
const { data } = await axios.get(ocsUrl(`/boards/${boardId}/stacks`))
|
||||
return data.ocs.data
|
||||
}
|
||||
|
||||
export async function fetchLabels(boardId) {
|
||||
const { data } = await axios.get(ocsUrl(`/boards/${boardId}/labels`))
|
||||
return data.ocs.data
|
||||
}
|
||||
|
||||
export async function fetchParticipants(boardId) {
|
||||
const { data } = await axios.get(ocsUrl(`/boards/${boardId}/participants`))
|
||||
return data.ocs.data
|
||||
}
|
||||
+3
-1
@@ -3,5 +3,7 @@ import PersonalSettings from './PersonalSettings.vue'
|
||||
|
||||
const mountPoint = document.getElementById('workflow-deck-automation-personal-settings')
|
||||
if (mountPoint) {
|
||||
createApp(PersonalSettings).mount(mountPoint)
|
||||
createApp(PersonalSettings, {
|
||||
notificationsAvailable: mountPoint.dataset.notificationsAvailable === '1',
|
||||
}).mount(mountPoint)
|
||||
}
|
||||
@@ -1,4 +1,5 @@
|
||||
<?php
|
||||
/** @var array $_ */
|
||||
?>
|
||||
<div id="workflow-deck-automation-personal-settings"></div>
|
||||
<div id="workflow-deck-automation-personal-settings"
|
||||
data-notifications-available="<?php p($_['notificationsAvailable'] ? '1' : '0'); ?>"></div>
|
||||
@@ -1,43 +0,0 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace OCA\WorkflowDeckAutomation\Tests\Unit\Db;
|
||||
|
||||
use OCA\WorkflowDeckAutomation\Db\Workflow;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
class WorkflowTest extends TestCase {
|
||||
public function testDateFieldDefaultsToDueWhenUnset(): void {
|
||||
// The column default covers rows written before date_field existed,
|
||||
// but an entity built in PHP has never been near the database.
|
||||
$this->assertSame(Workflow::DATE_FIELD_DUE, (new Workflow())->getDateFieldOrDue());
|
||||
}
|
||||
|
||||
public function testDateFieldIsKeptWhenKnown(): void {
|
||||
$workflow = new Workflow();
|
||||
|
||||
$workflow->setDateField(Workflow::DATE_FIELD_START);
|
||||
$this->assertSame(Workflow::DATE_FIELD_START, $workflow->getDateFieldOrDue());
|
||||
|
||||
$workflow->setDateField(Workflow::DATE_FIELD_DUE);
|
||||
$this->assertSame(Workflow::DATE_FIELD_DUE, $workflow->getDateFieldOrDue());
|
||||
}
|
||||
|
||||
public function testUnknownDateFieldFallsBackToDue(): void {
|
||||
// A hand-edited row must not silently switch a workflow to a trigger
|
||||
// nobody configured; the due date is what every workflow meant before
|
||||
// this choice existed.
|
||||
$workflow = new Workflow();
|
||||
$workflow->setDateField('whenever');
|
||||
|
||||
$this->assertSame(Workflow::DATE_FIELD_DUE, $workflow->getDateFieldOrDue());
|
||||
}
|
||||
|
||||
public function testDateFieldIsSerialisedForTheSettingsUi(): void {
|
||||
$workflow = new Workflow();
|
||||
$workflow->setDateField(Workflow::DATE_FIELD_START);
|
||||
|
||||
$this->assertSame(Workflow::DATE_FIELD_START, $workflow->jsonSerialize()['dateField']);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,76 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace OCA\WorkflowDeckAutomation\Tests\Unit\Service;
|
||||
|
||||
use OCA\WorkflowDeckAutomation\Service\LoopDetector;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
class LoopDetectorTest extends TestCase {
|
||||
public function testNoWorkflowsHaveNoLoop(): void {
|
||||
$this->assertSame([], LoopDetector::findLoopingWorkflows([]));
|
||||
}
|
||||
|
||||
public function testSameSourceAndTargetIsALoop(): void {
|
||||
$this->assertSame([1], LoopDetector::findLoopingWorkflows([1 => [10, 10]]));
|
||||
}
|
||||
|
||||
public function testTwoWorkflowsBackAndForthAreALoop(): void {
|
||||
$this->assertSame([1, 2], LoopDetector::findLoopingWorkflows([
|
||||
1 => [10, 20],
|
||||
2 => [20, 10],
|
||||
]));
|
||||
}
|
||||
|
||||
public function testLongerCircleIsALoop(): void {
|
||||
$this->assertSame([1, 2, 3], LoopDetector::findLoopingWorkflows([
|
||||
1 => [10, 20],
|
||||
2 => [20, 30],
|
||||
3 => [30, 10],
|
||||
]));
|
||||
}
|
||||
|
||||
public function testChainIsNoLoop(): void {
|
||||
$this->assertSame([], LoopDetector::findLoopingWorkflows([
|
||||
1 => [10, 20],
|
||||
2 => [20, 30],
|
||||
]));
|
||||
}
|
||||
|
||||
public function testOnlyWorkflowsOnTheCircleAreReported(): void {
|
||||
// 1 feeds into the circle 2 → 3 → 2 and 4 leads out of it; neither
|
||||
// lies on it.
|
||||
$this->assertSame([2, 3], LoopDetector::findLoopingWorkflows([
|
||||
1 => [10, 20],
|
||||
2 => [20, 30],
|
||||
3 => [30, 20],
|
||||
4 => [30, 40],
|
||||
]));
|
||||
}
|
||||
|
||||
public function testTwoWorkflowsFromTheSameSourceAreNoLoop(): void {
|
||||
$this->assertSame([], LoopDetector::findLoopingWorkflows([
|
||||
1 => [10, 20],
|
||||
2 => [10, 30],
|
||||
]));
|
||||
}
|
||||
|
||||
public function testFindPathListsTheWorkflowsInOrder(): void {
|
||||
$edges = [
|
||||
7 => [30, 10],
|
||||
5 => [10, 20],
|
||||
6 => [20, 30],
|
||||
];
|
||||
$this->assertSame([5, 6], LoopDetector::findPath($edges, 10, 30));
|
||||
$this->assertSame([6, 7], LoopDetector::findPath($edges, 20, 10));
|
||||
}
|
||||
|
||||
public function testFindPathWithoutConnectionIsNull(): void {
|
||||
$this->assertNull(LoopDetector::findPath([1 => [10, 20]], 20, 10));
|
||||
}
|
||||
|
||||
public function testFindPathToItselfIsEmpty(): void {
|
||||
$this->assertSame([], LoopDetector::findPath([], 10, 10));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,82 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace OCA\WorkflowDeckAutomation\Tests\Unit\Service;
|
||||
|
||||
use OCA\WorkflowDeckAutomation\Service\NotificationPolicy;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
class NotificationPolicyTest extends TestCase {
|
||||
public function testOffNeverNotifies(): void {
|
||||
$this->assertFalse(NotificationPolicy::shouldNotify('off', false, true));
|
||||
// Not even the owner of an unshared board — "off" is "off" in Deck too.
|
||||
$this->assertFalse(NotificationPolicy::shouldNotify('off', true, true));
|
||||
}
|
||||
|
||||
public function testAllAlwaysNotifies(): void {
|
||||
$this->assertTrue(NotificationPolicy::shouldNotify('all', false, false));
|
||||
$this->assertTrue(NotificationPolicy::shouldNotify('all', true, false));
|
||||
}
|
||||
|
||||
public function testAssignedNotifiesOnlyAssignedUsers(): void {
|
||||
$this->assertTrue(NotificationPolicy::shouldNotify('assigned', false, true));
|
||||
$this->assertFalse(NotificationPolicy::shouldNotify('assigned', false, false));
|
||||
}
|
||||
|
||||
public function testOwnerOfUnsharedBoardIsNotifiedWithAssigned(): void {
|
||||
$this->assertTrue(NotificationPolicy::shouldNotify('assigned', true, false));
|
||||
}
|
||||
|
||||
public function testUnknownSettingFallsBackToDeckDefault(): void {
|
||||
$this->assertTrue(NotificationPolicy::shouldNotify('', false, true));
|
||||
$this->assertFalse(NotificationPolicy::shouldNotify('bogus', false, false));
|
||||
$this->assertTrue(NotificationPolicy::shouldNotify('bogus', true, false));
|
||||
}
|
||||
|
||||
public function testAssignmentIsOnlyLookedUpWhenItMatters(): void {
|
||||
$lookup = function (): bool {
|
||||
$this->fail('assignment lookup must not run');
|
||||
};
|
||||
$this->assertFalse(NotificationPolicy::shouldNotify('off', false, $lookup));
|
||||
$this->assertTrue(NotificationPolicy::shouldNotify('all', false, $lookup));
|
||||
$this->assertTrue(NotificationPolicy::shouldNotify('assigned', true, $lookup));
|
||||
|
||||
$this->assertTrue(NotificationPolicy::shouldNotify('assigned', false, static fn (): bool => true));
|
||||
$this->assertFalse(NotificationPolicy::shouldNotify('assigned', false, static fn (): bool => false));
|
||||
}
|
||||
|
||||
public function testModes(): void {
|
||||
foreach (['off', 'owner', 'board'] as $mode) {
|
||||
$this->assertTrue(NotificationPolicy::isValidMode($mode));
|
||||
}
|
||||
$this->assertFalse(NotificationPolicy::isValidMode(''));
|
||||
$this->assertFalse(NotificationPolicy::isValidMode('all'));
|
||||
}
|
||||
|
||||
public function testChannels(): void {
|
||||
foreach (['mail', 'notification', 'both'] as $channel) {
|
||||
$this->assertTrue(NotificationPolicy::isValidChannel($channel));
|
||||
}
|
||||
$this->assertFalse(NotificationPolicy::isValidChannel(''));
|
||||
$this->assertFalse(NotificationPolicy::isValidChannel('push'));
|
||||
}
|
||||
|
||||
public function testChannelDecidesMailAndNotification(): void {
|
||||
$this->assertTrue(NotificationPolicy::sendsMail('mail'));
|
||||
$this->assertFalse(NotificationPolicy::sendsNotification('mail'));
|
||||
|
||||
$this->assertFalse(NotificationPolicy::sendsMail('notification'));
|
||||
$this->assertTrue(NotificationPolicy::sendsNotification('notification'));
|
||||
|
||||
$this->assertTrue(NotificationPolicy::sendsMail('both'));
|
||||
$this->assertTrue(NotificationPolicy::sendsNotification('both'));
|
||||
}
|
||||
|
||||
public function testUnknownChannelFallsBackToMail(): void {
|
||||
$this->assertTrue(NotificationPolicy::sendsMail(''));
|
||||
$this->assertFalse(NotificationPolicy::sendsNotification(''));
|
||||
$this->assertTrue(NotificationPolicy::sendsMail('bogus'));
|
||||
$this->assertFalse(NotificationPolicy::sendsNotification('bogus'));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace OCA\WorkflowDeckAutomation\Tests\Unit\Service;
|
||||
|
||||
use OCA\WorkflowDeckAutomation\Service\TriggerDate;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
class TriggerDateTest extends TestCase {
|
||||
public function testKnownTriggersAreValid(): void {
|
||||
$this->assertTrue(TriggerDate::isValid('due'));
|
||||
$this->assertTrue(TriggerDate::isValid('start'));
|
||||
}
|
||||
|
||||
public function testUnknownTriggersAreInvalid(): void {
|
||||
$this->assertFalse(TriggerDate::isValid(''));
|
||||
$this->assertFalse(TriggerDate::isValid('duedate'));
|
||||
$this->assertFalse(TriggerDate::isValid('Start'));
|
||||
}
|
||||
|
||||
public function testReasonNamesTheTriggeringDate(): void {
|
||||
$this->assertSame('ist überfällig', TriggerDate::describeReason('due'));
|
||||
$this->assertSame('hat ihr Startdatum erreicht', TriggerDate::describeReason('start'));
|
||||
}
|
||||
|
||||
public function testUnknownTriggerIsDescribedAsDue(): void {
|
||||
// Notifications stored before the column existed carry no trigger.
|
||||
$this->assertSame('ist überfällig', TriggerDate::describeReason(''));
|
||||
}
|
||||
}
|
||||
@@ -1,83 +0,0 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace OCA\WorkflowDeckAutomation\Tests\Unit\Service;
|
||||
|
||||
use DateTimeImmutable;
|
||||
use OCA\WorkflowDeckAutomation\Service\WorkflowRunner;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
class WorkflowRunnerFilterTest extends TestCase {
|
||||
public function testHasPassedReturnsFalseWithoutADate(): void {
|
||||
$this->assertFalse(WorkflowRunner::hasPassed(null, new DateTimeImmutable('2026-01-15 12:00:00')));
|
||||
}
|
||||
|
||||
public function testHasPassedReturnsFalseForAFutureDate(): void {
|
||||
$now = new DateTimeImmutable('2026-01-15 12:00:00');
|
||||
$this->assertFalse(WorkflowRunner::hasPassed($now->modify('+1 hour'), $now));
|
||||
$this->assertFalse(WorkflowRunner::hasPassed($now->modify('+3 days'), $now));
|
||||
}
|
||||
|
||||
public function testHasPassedReturnsTrueForAPastDate(): void {
|
||||
$now = new DateTimeImmutable('2026-01-15 12:00:00');
|
||||
$this->assertTrue(WorkflowRunner::hasPassed($now->modify('-1 hour'), $now));
|
||||
$this->assertTrue(WorkflowRunner::hasPassed($now->modify('-30 days'), $now));
|
||||
}
|
||||
|
||||
public function testHasPassedReturnsTrueForATimeEarlierTheSameDay(): void {
|
||||
// Regression: comparing whole calendar days (as Deck's own
|
||||
// Card::getDaysUntilDue() does) reports a card due earlier today as
|
||||
// "0 days until due", not overdue, until the calendar date rolls
|
||||
// over - holding every card back for up to 24h after it actually
|
||||
// fell due. hasPassed() must compare the real timestamps instead.
|
||||
$now = new DateTimeImmutable('2026-01-15 12:00:00');
|
||||
$this->assertTrue(WorkflowRunner::hasPassed(new DateTimeImmutable('2026-01-15 06:00:00'), $now));
|
||||
}
|
||||
|
||||
public function testNoFiltersMatchesAnyCard(): void {
|
||||
$this->assertTrue(WorkflowRunner::cardMatchesFilters(['alice'], [1, 2], [], []));
|
||||
$this->assertTrue(WorkflowRunner::cardMatchesFilters([], [], [], []));
|
||||
}
|
||||
|
||||
public function testUserFilterIsOrAgainstAssignedUsers(): void {
|
||||
$this->assertTrue(WorkflowRunner::cardMatchesFilters(['alice', 'bob'], [], ['bob', 'carol'], []));
|
||||
$this->assertFalse(WorkflowRunner::cardMatchesFilters(['alice'], [], ['bob', 'carol'], []));
|
||||
}
|
||||
|
||||
public function testLabelFilterIsOrAgainstCardLabels(): void {
|
||||
$this->assertTrue(WorkflowRunner::cardMatchesFilters([], [1, 2], [], [2, 3]));
|
||||
$this->assertFalse(WorkflowRunner::cardMatchesFilters([], [1], [], [2, 3]));
|
||||
}
|
||||
|
||||
public function testUserAndLabelFiltersAreCombinedWithAnd(): void {
|
||||
// user matches, label does not -> overall false
|
||||
$this->assertFalse(WorkflowRunner::cardMatchesFilters(['alice'], [1], ['alice'], [99]));
|
||||
// both match -> true
|
||||
$this->assertTrue(WorkflowRunner::cardMatchesFilters(['alice'], [1], ['alice'], [1]));
|
||||
}
|
||||
|
||||
public function testEmptyFiltersAreNeverDead(): void {
|
||||
// "no restriction" must not be reported as a broken filter, however
|
||||
// little the board has left to offer.
|
||||
$this->assertSame([], WorkflowRunner::findDeadFilters([], [], [], []));
|
||||
$this->assertSame([], WorkflowRunner::findDeadFilters([], [], ['alice'], [1]));
|
||||
}
|
||||
|
||||
public function testFilterSurvivesAsLongAsOneEntryRemains(): void {
|
||||
$this->assertSame([], WorkflowRunner::findDeadFilters(['alice', 'bob'], [1, 2], ['bob'], [2]));
|
||||
}
|
||||
|
||||
public function testFilterIsDeadWhenEveryEntryIsGone(): void {
|
||||
$this->assertSame(['label'], WorkflowRunner::findDeadFilters([], [1, 2], [], [3]));
|
||||
$this->assertSame(['user'], WorkflowRunner::findDeadFilters(['alice'], [], ['bob'], []));
|
||||
$this->assertSame(
|
||||
['label', 'user'],
|
||||
WorkflowRunner::findDeadFilters(['alice'], [1], ['bob'], [2]),
|
||||
);
|
||||
}
|
||||
|
||||
public function testAnEmptyBoardKillsOnlyTheFiltersThatAreSet(): void {
|
||||
$this->assertSame(['label'], WorkflowRunner::findDeadFilters([], [1], [], []));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,67 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace OCA\WorkflowDeckAutomation\Tests\Unit\Service;
|
||||
|
||||
use DateTimeImmutable;
|
||||
use DateTimeZone;
|
||||
use OCA\WorkflowDeckAutomation\Service\WorkflowRunner;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
class WorkflowRunnerTest extends TestCase {
|
||||
private static function utc(string $time): DateTimeImmutable {
|
||||
return new DateTimeImmutable($time, new DateTimeZone('UTC'));
|
||||
}
|
||||
|
||||
public function testHasPassedReturnsFalseWithoutDate(): void {
|
||||
$this->assertFalse(WorkflowRunner::hasPassed(null, self::utc('2026-01-15 12:00:00')));
|
||||
}
|
||||
|
||||
public function testHasPassedReturnsFalseForFutureDate(): void {
|
||||
$now = self::utc('2026-01-15 12:00:00');
|
||||
$this->assertFalse(WorkflowRunner::hasPassed($now->modify('+1 hour'), $now));
|
||||
$this->assertFalse(WorkflowRunner::hasPassed($now->modify('+3 days'), $now));
|
||||
}
|
||||
|
||||
public function testHasPassedReturnsTrueForPastDate(): void {
|
||||
$now = self::utc('2026-01-15 12:00:00');
|
||||
$this->assertTrue(WorkflowRunner::hasPassed($now->modify('-1 hour'), $now));
|
||||
$this->assertTrue(WorkflowRunner::hasPassed($now->modify('-30 days'), $now));
|
||||
}
|
||||
|
||||
public function testHasPassedReturnsTrueForATimeEarlierTheSameDay(): void {
|
||||
// Regression: comparing whole calendar days (as Deck's own
|
||||
// Card::getDaysUntilDue() does) reports a card due earlier today as
|
||||
// "0 days until due", not overdue, until the calendar date rolls
|
||||
// over - holding every card back for up to 24h after it actually
|
||||
// fell due. hasPassed() must compare the real timestamps instead.
|
||||
$now = self::utc('2026-01-15 12:00:00');
|
||||
$this->assertTrue(WorkflowRunner::hasPassed(self::utc('2026-01-15 06:00:00'), $now));
|
||||
}
|
||||
|
||||
public function testHasPassedReadsTheStoredWallClockAsUtc(): void {
|
||||
// What Entity hydration produces if PHP's default zone is not UTC:
|
||||
// the stored UTC wall clock "12:00", tagged with the local zone.
|
||||
$date = new DateTimeImmutable('2026-07-15 12:00:00', new DateTimeZone('Europe/Berlin'));
|
||||
|
||||
// Taken at face value that would be 10:00 UTC and already passed.
|
||||
$this->assertFalse(WorkflowRunner::hasPassed($date, self::utc('2026-07-15 11:30:00')));
|
||||
$this->assertTrue(WorkflowRunner::hasPassed($date, self::utc('2026-07-15 12:00:01')));
|
||||
}
|
||||
|
||||
public function testHasPassedComparesNowAsAnAbsoluteInstant(): void {
|
||||
$date = self::utc('2026-07-15 12:00:00');
|
||||
$berlin = new DateTimeZone('Europe/Berlin');
|
||||
|
||||
// 13:30 in Berlin (CEST) is 11:30 UTC - not yet passed.
|
||||
$this->assertFalse(WorkflowRunner::hasPassed($date, new DateTimeImmutable('2026-07-15 13:30:00', $berlin)));
|
||||
// 14:30 in Berlin is 12:30 UTC - passed.
|
||||
$this->assertTrue(WorkflowRunner::hasPassed($date, new DateTimeImmutable('2026-07-15 14:30:00', $berlin)));
|
||||
}
|
||||
|
||||
public function testHasPassedIsFalseAtTheExactInstant(): void {
|
||||
$now = self::utc('2026-01-15 12:00:00');
|
||||
$this->assertFalse(WorkflowRunner::hasPassed($now, $now));
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user