Build package / php-lint (8.4) (push) Successful in 43s
Build package / php-lint (8.5) (push) Successful in 40s
Build package / xml-lint (push) Successful in 12s
Build package / unit-tests (push) Successful in 38s
Build package / package (push) Successful in 52s
revert Let each workflow watch the due date or the start date
Deck 1.18 added a start date to cards (Card::$startdate), so a workflow
no longer has to mean "overdue". Each rule now carries a date_field
('due' | 'start'), chosen in the settings form next to board and stacks.
Existing rules keep the due date: the new column's default supplies it
for every stored row, so there is no backfill step, and
Workflow::getDateFieldOrDue() covers entities that were never near the
database as well as hand-edited values. The controller is the one place
that rejects an unknown value instead of normalising it - a client
asking for a rule it would not get should hear about it.
The probe for the field is property_exists(), not method_exists():
Deck's entities declare no getter as real code - getStartdate(),
getDuedate(), even getId() all go through Entity::__call(), which
method_exists() ignores by definition. A method_exists() guard would
have been false on every Deck version and would have turned every
start-date rule into a silent no-op.
assertDeckAvailable() now also refuses Deck older than 1.18.0. That
floor cannot live in appinfo/info.xml - neither the server's nor the app
store's schema has an app-to-app dependency element - but
<nextcloud min-version="34"> already implies it, since 1.18.x is the
only Deck release line published for Nextcloud 34.
isOverdue() becomes hasPassed(): one function for both dates, since the
comparison and the argument against Deck's day-truncating
getDaysUntilDue() are identical for either.
Also carries a pending NcSelect icon-alignment fix that was already in
the working tree.
Bump to 34.1.0.
206 lines
6.3 KiB
PHP
206 lines
6.3 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace OCA\WorkflowDeckAutomation\Controller;
|
|
|
|
use OCA\WorkflowDeckAutomation\Db\Workflow;
|
|
use OCA\WorkflowDeckAutomation\Db\WorkflowMapper;
|
|
use OCA\WorkflowDeckAutomation\Service\DeckIntegrationService;
|
|
use OCA\WorkflowDeckAutomation\Service\DeckUnavailableException;
|
|
use OCP\AppFramework\Db\DoesNotExistException;
|
|
use OCP\AppFramework\Http;
|
|
use OCP\AppFramework\Http\Attribute\NoAdminRequired;
|
|
use OCP\AppFramework\Http\DataResponse;
|
|
use OCP\AppFramework\OCS\OCSBadRequestException;
|
|
use OCP\AppFramework\OCS\OCSNotFoundException;
|
|
use OCP\AppFramework\OCS\OCSPreconditionFailedException;
|
|
use OCP\AppFramework\OCSController;
|
|
use OCP\IRequest;
|
|
use OCP\IUserSession;
|
|
|
|
class WorkflowController extends OCSController {
|
|
public function __construct(
|
|
string $appName,
|
|
IRequest $request,
|
|
private WorkflowMapper $workflowMapper,
|
|
private DeckIntegrationService $deckService,
|
|
private IUserSession $userSession,
|
|
) {
|
|
parent::__construct($appName, $request);
|
|
}
|
|
|
|
private function currentUserId(): string {
|
|
$user = $this->userSession->getUser();
|
|
if ($user === null) {
|
|
throw new OCSPreconditionFailedException('Not logged in');
|
|
}
|
|
return $user->getUID();
|
|
}
|
|
|
|
#[NoAdminRequired]
|
|
public function index(): DataResponse {
|
|
$workflows = $this->workflowMapper->findAllForUser($this->currentUserId());
|
|
return new DataResponse(array_map(static fn (Workflow $w) => $w->jsonSerialize(), $workflows));
|
|
}
|
|
|
|
/**
|
|
* @param string[] $filterUserIds
|
|
* @param int[] $filterLabelIds
|
|
*/
|
|
#[NoAdminRequired]
|
|
public function create(
|
|
string $title,
|
|
int $boardId,
|
|
int $sourceStackId,
|
|
int $targetStackId,
|
|
array $filterUserIds = [],
|
|
array $filterLabelIds = [],
|
|
bool $notifyEmail = false,
|
|
bool $enabled = true,
|
|
): DataResponse {
|
|
$this->validate($title, $boardId, $sourceStackId, $targetStackId);
|
|
|
|
$workflow = new Workflow();
|
|
$workflow->setUserId($this->currentUserId());
|
|
$this->applyFields($workflow, $title, $boardId, $sourceStackId, $targetStackId, $filterUserIds, $filterLabelIds, $notifyEmail, $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,
|
|
string $title,
|
|
int $boardId,
|
|
int $sourceStackId,
|
|
int $targetStackId,
|
|
array $filterUserIds = [],
|
|
array $filterLabelIds = [],
|
|
bool $notifyEmail = false,
|
|
bool $enabled = true,
|
|
): DataResponse {
|
|
$this->validate($title, $boardId, $sourceStackId, $targetStackId);
|
|
|
|
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, $notifyEmail, $enabled);
|
|
$workflow = $this->workflowMapper->update($workflow);
|
|
|
|
return new DataResponse($workflow->jsonSerialize());
|
|
}
|
|
|
|
#[NoAdminRequired]
|
|
public function destroy(int $id): DataResponse {
|
|
try {
|
|
$workflow = $this->workflowMapper->findForUser($id, $this->currentUserId());
|
|
} catch (DoesNotExistException $e) {
|
|
throw new OCSNotFoundException('Workflow not found');
|
|
}
|
|
|
|
$this->workflowMapper->delete($workflow);
|
|
return new DataResponse([]);
|
|
}
|
|
|
|
#[NoAdminRequired]
|
|
public function boards(): DataResponse {
|
|
$this->assertDeck();
|
|
return new DataResponse($this->deckService->listBoardsForCurrentUser());
|
|
}
|
|
|
|
#[NoAdminRequired]
|
|
public function stacks(int $boardId): DataResponse {
|
|
$this->assertDeck();
|
|
return new DataResponse($this->deckService->listStacks($boardId));
|
|
}
|
|
|
|
#[NoAdminRequired]
|
|
public function labels(int $boardId): DataResponse {
|
|
$this->assertDeck();
|
|
return new DataResponse($this->deckService->listLabels($boardId));
|
|
}
|
|
|
|
#[NoAdminRequired]
|
|
public function participants(int $boardId): DataResponse {
|
|
$this->assertDeck();
|
|
return new DataResponse($this->deckService->listParticipants($boardId));
|
|
}
|
|
|
|
private function assertDeck(): void {
|
|
$user = $this->userSession->getUser();
|
|
if ($user === null) {
|
|
throw new OCSPreconditionFailedException('Not logged in');
|
|
}
|
|
try {
|
|
$this->deckService->assertDeckAvailable($user);
|
|
} catch (DeckUnavailableException $e) {
|
|
throw new OCSPreconditionFailedException('Deck is not available: ' . $e->getMessage());
|
|
}
|
|
}
|
|
|
|
private function validate(string $title, int $boardId, int $sourceStackId, int $targetStackId): void {
|
|
if (trim($title) === '') {
|
|
throw new OCSBadRequestException('Title must not be empty');
|
|
}
|
|
if ($sourceStackId === $targetStackId) {
|
|
throw new OCSBadRequestException('Source and target stack must differ');
|
|
}
|
|
|
|
// Reject references to boards or stacks that are gone (or were never
|
|
// the user's) instead of storing a workflow that can only fail later.
|
|
// assertDeck() ran first, so an empty list here means "not there",
|
|
// not "Deck is unreachable".
|
|
$this->assertDeck();
|
|
|
|
$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');
|
|
}
|
|
|
|
$stackIds = array_map(
|
|
static fn (array $stack) => (int)$stack['id'],
|
|
$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');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param string[] $filterUserIds
|
|
* @param int[] $filterLabelIds
|
|
*/
|
|
private function applyFields(
|
|
Workflow $workflow,
|
|
string $title,
|
|
int $boardId,
|
|
int $sourceStackId,
|
|
int $targetStackId,
|
|
array $filterUserIds,
|
|
array $filterLabelIds,
|
|
bool $notifyEmail,
|
|
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->setNotifyEmail($notifyEmail);
|
|
$workflow->setEnabled($enabled);
|
|
}
|
|
}
|