Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 18b31e6d62 | |||
| d64986d2ee | |||
| 1fa3acae74 | |||
| d0d32db177 | |||
| dc63a031e1 |
32
Console/RecoRecoCommand.php
Normal file
32
Console/RecoRecoCommand.php
Normal file
@@ -0,0 +1,32 @@
|
||||
<?php
|
||||
|
||||
namespace Kanboard\Plugin\RecoReco\Console;
|
||||
|
||||
use Kanboard\Console\BaseCommand;
|
||||
use Kanboard\Plugin\RecoReco\Model\RecoRecoModel;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
|
||||
/**
|
||||
* CLI entry point for the RecoReco engine. Run by cron (four times a day from v1.0). Can be run by
|
||||
* hand to test: ./cli recoreco:run
|
||||
*/
|
||||
class RecoRecoCommand extends BaseCommand
|
||||
{
|
||||
protected function configure()
|
||||
{
|
||||
$this
|
||||
->setName('recoreco:run')
|
||||
->setDescription('Spawn RecoReco calendar-scheduled cards whose occurrence is due');
|
||||
}
|
||||
|
||||
protected function execute(InputInterface $input, OutputInterface $output): int
|
||||
{
|
||||
$model = new RecoRecoModel($this->container);
|
||||
$count = $model->run();
|
||||
|
||||
$output->writeln('RecoReco: spawned '.$count.' card(s).');
|
||||
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
@@ -52,6 +52,7 @@ class RecurrenceController extends BaseController
|
||||
'recoreco_frequency' => $frequency,
|
||||
'recoreco_last_day' => isset($input['recoreco_last_day']) ? 1 : 0,
|
||||
'recoreco_days_before' => isset($input['recoreco_days_before']) && ctype_digit((string) $input['recoreco_days_before']) ? (int) $input['recoreco_days_before'] : 0,
|
||||
'recoreco_link_copies' => isset($input['recoreco_link_copies']) ? 1 : 0,
|
||||
);
|
||||
|
||||
// Capture the anchor (the due date at enable time) -- the drift-free pattern. The engine
|
||||
@@ -61,6 +62,12 @@ class RecurrenceController extends BaseController
|
||||
}
|
||||
|
||||
$this->taskMetadataModel->save($task['id'], $values);
|
||||
|
||||
// Reconcile the template's duplicate links with the setting right away (removes existing
|
||||
// links to its RecoReco clones when the option is off).
|
||||
$model = new \Kanboard\Plugin\RecoReco\Model\RecoRecoModel($this->container);
|
||||
$model->syncCloneLinks($task['id'], $values['recoreco_link_copies'] == 1);
|
||||
|
||||
$this->flash->success(t('Recurring schedule saved.'));
|
||||
|
||||
return $this->response->redirect($this->helper->url->to('TaskViewController', 'show', array('task_id' => $task['id'])), true);
|
||||
@@ -76,6 +83,7 @@ class RecurrenceController extends BaseController
|
||||
'recoreco_frequency' => isset($meta['recoreco_frequency']) ? $meta['recoreco_frequency'] : 'monthly_day',
|
||||
'recoreco_last_day' => isset($meta['recoreco_last_day']) ? (int) $meta['recoreco_last_day'] : 0,
|
||||
'recoreco_days_before' => isset($meta['recoreco_days_before']) ? (int) $meta['recoreco_days_before'] : 0,
|
||||
'recoreco_link_copies' => isset($meta['recoreco_link_copies']) ? (int) $meta['recoreco_link_copies'] : 0,
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
206
Model/OccurrenceCalculator.php
Normal file
206
Model/OccurrenceCalculator.php
Normal file
@@ -0,0 +1,206 @@
|
||||
<?php
|
||||
|
||||
namespace Kanboard\Plugin\RecoReco\Model;
|
||||
|
||||
/**
|
||||
* Pure calendar math for RecoReco.
|
||||
*
|
||||
* Given an anchor due date (the drift-free pattern: it carries the day-of-month, the weekday, and
|
||||
* the time), a frequency, and the "last day" flag, it computes occurrence datetimes. It has NO
|
||||
* container dependencies, so it is unit-testable in isolation (Test/OccurrenceCalculatorTest.php).
|
||||
*
|
||||
* Occurrences are always computed from the anchor, never by marching a clamped date forward, so a
|
||||
* "30th" schedule goes 30, 28/29, 30, 30... and never drifts.
|
||||
*/
|
||||
class OccurrenceCalculator
|
||||
{
|
||||
const MAX_MONTHS = 120;
|
||||
const MAX_YEARS = 20;
|
||||
|
||||
/**
|
||||
* The earliest occurrence at/after $reference (when $inclusive) or strictly after it.
|
||||
*
|
||||
* @param int $anchor Unix timestamp: the pattern.
|
||||
* @param string $frequency daily | weekly | monthly_day | monthly_dow | yearly
|
||||
* @param bool $lastDay
|
||||
* @param int $reference Unix timestamp.
|
||||
* @param bool $inclusive
|
||||
* @return int|null Occurrence timestamp, or null for an unknown frequency.
|
||||
*/
|
||||
public function occurrenceFrom($anchor, $frequency, $lastDay, $reference, $inclusive = false)
|
||||
{
|
||||
$anchor = (int) $anchor;
|
||||
$reference = (int) $reference;
|
||||
$lastDay = (bool) $lastDay;
|
||||
$inclusive = (bool) $inclusive;
|
||||
|
||||
switch ($frequency) {
|
||||
case 'daily':
|
||||
return $this->daily($anchor, $reference, $inclusive);
|
||||
case 'weekly':
|
||||
return $this->weekly($anchor, $reference, $inclusive);
|
||||
case 'monthly_day':
|
||||
return $this->monthlyByDay($anchor, $lastDay, $reference, $inclusive);
|
||||
case 'monthly_dow':
|
||||
return $this->monthlyByWeekday($anchor, $lastDay, $reference, $inclusive);
|
||||
case 'yearly':
|
||||
return $this->yearly($anchor, $lastDay, $reference, $inclusive);
|
||||
default:
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
private function daily($anchor, $reference, $inclusive)
|
||||
{
|
||||
$h = (int) date('G', $anchor);
|
||||
$i = (int) date('i', $anchor);
|
||||
$s = (int) date('s', $anchor);
|
||||
$y = (int) date('Y', $reference);
|
||||
$m = (int) date('n', $reference);
|
||||
$d = (int) date('j', $reference);
|
||||
|
||||
for ($k = 0; $k < 3; $k++) {
|
||||
$o = mktime($h, $i, $s, $m, $d + $k, $y);
|
||||
|
||||
if ($this->matches($o, $reference, $inclusive)) {
|
||||
return $o;
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
private function weekly($anchor, $reference, $inclusive)
|
||||
{
|
||||
$h = (int) date('G', $anchor);
|
||||
$i = (int) date('i', $anchor);
|
||||
$s = (int) date('s', $anchor);
|
||||
$w = (int) date('w', $anchor);
|
||||
$y = (int) date('Y', $reference);
|
||||
$m = (int) date('n', $reference);
|
||||
$d = (int) date('j', $reference);
|
||||
|
||||
for ($k = 0; $k < 8; $k++) {
|
||||
$o = mktime($h, $i, $s, $m, $d + $k, $y);
|
||||
|
||||
if ((int) date('w', $o) === $w && $this->matches($o, $reference, $inclusive)) {
|
||||
return $o;
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
private function monthlyByDay($anchor, $lastDay, $reference, $inclusive)
|
||||
{
|
||||
$anchorDay = (int) date('j', $anchor);
|
||||
$h = (int) date('G', $anchor);
|
||||
$i = (int) date('i', $anchor);
|
||||
$s = (int) date('s', $anchor);
|
||||
|
||||
$y = (int) date('Y', $reference);
|
||||
$m = (int) date('n', $reference);
|
||||
|
||||
for ($k = 0; $k < self::MAX_MONTHS; $k++) {
|
||||
$lastDom = (int) date('t', mktime(0, 0, 0, $m, 1, $y));
|
||||
$day = $lastDay ? $lastDom : min($anchorDay, $lastDom);
|
||||
$o = mktime($h, $i, $s, $m, $day, $y);
|
||||
|
||||
if ($this->matches($o, $reference, $inclusive)) {
|
||||
return $o;
|
||||
}
|
||||
|
||||
$this->nextMonth($m, $y);
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
private function monthlyByWeekday($anchor, $lastDay, $reference, $inclusive)
|
||||
{
|
||||
$h = (int) date('G', $anchor);
|
||||
$i = (int) date('i', $anchor);
|
||||
$s = (int) date('s', $anchor);
|
||||
$w = (int) date('w', $anchor);
|
||||
$k = intdiv((int) date('j', $anchor) - 1, 7) + 1; // 1..5: which occurrence of $w in the month
|
||||
|
||||
$y = (int) date('Y', $reference);
|
||||
$m = (int) date('n', $reference);
|
||||
|
||||
for ($j = 0; $j < self::MAX_MONTHS; $j++) {
|
||||
$day = $lastDay ? $this->lastWeekdayOfMonth($y, $m, $w) : $this->nthWeekdayOfMonth($y, $m, $w, $k);
|
||||
|
||||
if ($day !== null) {
|
||||
$o = mktime($h, $i, $s, $m, $day, $y);
|
||||
|
||||
if ($this->matches($o, $reference, $inclusive)) {
|
||||
return $o;
|
||||
}
|
||||
}
|
||||
|
||||
$this->nextMonth($m, $y);
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
private function yearly($anchor, $lastDay, $reference, $inclusive)
|
||||
{
|
||||
$month = (int) date('n', $anchor);
|
||||
$anchorDay = (int) date('j', $anchor);
|
||||
$h = (int) date('G', $anchor);
|
||||
$i = (int) date('i', $anchor);
|
||||
$s = (int) date('s', $anchor);
|
||||
|
||||
$y = (int) date('Y', $reference);
|
||||
|
||||
for ($j = 0; $j < self::MAX_YEARS; $j++) {
|
||||
$lastDom = (int) date('t', mktime(0, 0, 0, $month, 1, $y));
|
||||
$day = $lastDay ? $lastDom : min($anchorDay, $lastDom);
|
||||
$o = mktime($h, $i, $s, $month, $day, $y);
|
||||
|
||||
if ($this->matches($o, $reference, $inclusive)) {
|
||||
return $o;
|
||||
}
|
||||
|
||||
$y++;
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
// The day-of-month of the k-th weekday $w in month $m/$y, or null if that month has no k-th one.
|
||||
private function nthWeekdayOfMonth($y, $m, $w, $k)
|
||||
{
|
||||
$firstDow = (int) date('w', mktime(0, 0, 0, $m, 1, $y));
|
||||
$firstW = 1 + (($w - $firstDow + 7) % 7);
|
||||
$day = $firstW + ($k - 1) * 7;
|
||||
$lastDom = (int) date('t', mktime(0, 0, 0, $m, 1, $y));
|
||||
|
||||
return $day <= $lastDom ? $day : null;
|
||||
}
|
||||
|
||||
// The day-of-month of the last weekday $w in month $m/$y.
|
||||
private function lastWeekdayOfMonth($y, $m, $w)
|
||||
{
|
||||
$lastDom = (int) date('t', mktime(0, 0, 0, $m, 1, $y));
|
||||
$lastDow = (int) date('w', mktime(0, 0, 0, $m, $lastDom, $y));
|
||||
|
||||
return $lastDom - (($lastDow - $w + 7) % 7);
|
||||
}
|
||||
|
||||
private function matches($occurrence, $reference, $inclusive)
|
||||
{
|
||||
return $inclusive ? $occurrence >= $reference : $occurrence > $reference;
|
||||
}
|
||||
|
||||
private function nextMonth(&$m, &$y)
|
||||
{
|
||||
$m++;
|
||||
|
||||
if ($m > 12) {
|
||||
$m = 1;
|
||||
$y++;
|
||||
}
|
||||
}
|
||||
}
|
||||
222
Model/RecoRecoModel.php
Normal file
222
Model/RecoRecoModel.php
Normal file
@@ -0,0 +1,222 @@
|
||||
<?php
|
||||
|
||||
namespace Kanboard\Plugin\RecoReco\Model;
|
||||
|
||||
use Kanboard\Core\Base;
|
||||
use Kanboard\Model\TaskModel;
|
||||
|
||||
/**
|
||||
* The RecoReco engine: find enabled templates and spawn their due occurrences.
|
||||
*
|
||||
* Called by the recoreco:run CLI command. v0.3 handles monthly-by-day and fires everything whose
|
||||
* fire time has arrived (fire time = occurrence - days_before); v1.0 adds the 4-window cron horizon.
|
||||
*
|
||||
* Per template: the native-recurrence yield (decision 13), first-run init / manual-edit re-anchor,
|
||||
* then a catch-up loop that duplicates the card into the target column and advances the cursor.
|
||||
*/
|
||||
class RecoRecoModel extends Base
|
||||
{
|
||||
const CATCHUP_CAP = 24;
|
||||
|
||||
private $calc;
|
||||
|
||||
public function run($now = null)
|
||||
{
|
||||
$now = $now ?: time();
|
||||
$horizon = $this->horizon($now);
|
||||
$spawned = 0;
|
||||
|
||||
$task_ids = $this->db->table('task_has_metadata')
|
||||
->eq('name', 'recoreco_enabled')
|
||||
->eq('value', '1')
|
||||
->findAllByColumn('task_id');
|
||||
|
||||
foreach ($task_ids as $task_id) {
|
||||
$spawned += $this->processTemplate((int) $task_id, $now, $horizon);
|
||||
}
|
||||
|
||||
return $spawned;
|
||||
}
|
||||
|
||||
/**
|
||||
* The look-ahead horizon for this run: fire everything whose fire time is before it. Computed as
|
||||
* "ceil now to the next 6h boundary, then +12h", which lands on the four daily runs:
|
||||
* 05:58 -> 18:00, 11:58 -> 00:00, 17:58 -> 06:00, 23:58 -> 12:00. Gives a 12h look-ahead with a
|
||||
* 6h overlap between runs, so a missed run is covered by its neighbour. Past-due occurrences are
|
||||
* naturally included (their fire time is < now < horizon) -- that is the catch-up.
|
||||
*
|
||||
* @param int $now
|
||||
* @return int
|
||||
*/
|
||||
private function horizon($now)
|
||||
{
|
||||
$startOfDay = mktime(0, 0, 0, (int) date('n', $now), (int) date('j', $now), (int) date('Y', $now));
|
||||
$boundaryHour = (intdiv((int) date('G', $now), 6) + 1) * 6;
|
||||
|
||||
return $startOfDay + $boundaryHour * 3600 + 12 * 3600;
|
||||
}
|
||||
|
||||
public function processTemplate($task_id, $now, $horizon)
|
||||
{
|
||||
$task = $this->taskFinderModel->getById($task_id);
|
||||
|
||||
if (empty($task)) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
// Native wins: if the card became native-recurring, RecoReco yields (decision 13).
|
||||
if ($task['recurrence_status'] != TaskModel::RECURRING_STATUS_NONE) {
|
||||
$this->taskMetadataModel->save($task_id, array('recoreco_enabled' => 0));
|
||||
$this->logger->info('RecoReco: disabled on task '.$task_id.' (now native-recurring)');
|
||||
return 0;
|
||||
}
|
||||
|
||||
$meta = $this->taskMetadataModel->getAll($task_id);
|
||||
$frequency = isset($meta['recoreco_frequency']) ? $meta['recoreco_frequency'] : '';
|
||||
|
||||
// All five frequencies are supported since v1.1; skip anything unknown.
|
||||
if (! in_array($frequency, array('daily', 'weekly', 'monthly_day', 'monthly_dow', 'yearly'), true)) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
$anchor = isset($meta['recoreco_anchor']) ? (int) $meta['recoreco_anchor'] : 0;
|
||||
|
||||
if ($anchor <= 0) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
$lastDay = isset($meta['recoreco_last_day']) && $meta['recoreco_last_day'] == 1;
|
||||
$daysBefore = isset($meta['recoreco_days_before']) ? (int) $meta['recoreco_days_before'] : 0;
|
||||
$targetColumn = isset($meta['recoreco_target_column']) ? (int) $meta['recoreco_target_column'] : (int) $task['column_id'];
|
||||
// Default off: only keep the duplicate link when explicitly turned on.
|
||||
$linkCopies = isset($meta['recoreco_link_copies']) && $meta['recoreco_link_copies'] == 1;
|
||||
|
||||
$cursor = (int) $task['date_due'];
|
||||
$synced = isset($meta['recoreco_synced_due']) ? (int) $meta['recoreco_synced_due'] : null;
|
||||
|
||||
if ($synced === null) {
|
||||
// First run after enabling: place the cursor on the first occurrence.
|
||||
$cursor = $this->firstCursor($anchor, $frequency, $lastDay, $now);
|
||||
$this->setDue($task_id, $cursor);
|
||||
} elseif ($cursor !== $synced) {
|
||||
// The user hand-edited the due date -> re-anchor to it (a reschedule).
|
||||
$anchor = $cursor;
|
||||
$this->taskMetadataModel->save($task_id, array('recoreco_anchor' => $anchor));
|
||||
$this->setDue($task_id, $cursor);
|
||||
}
|
||||
|
||||
// Fire every occurrence whose fire time is before this run's horizon (this includes
|
||||
// past-due ones -> catch-up), advancing the cursor each time.
|
||||
$spawned = 0;
|
||||
$fireTime = $cursor - $daysBefore * 86400;
|
||||
|
||||
while ($fireTime < $horizon && $spawned < self::CATCHUP_CAP) {
|
||||
$this->spawn($task, $targetColumn);
|
||||
|
||||
$next = $this->calculator()->occurrenceFrom($anchor, $frequency, $lastDay, $cursor, false);
|
||||
|
||||
if ($next === null || $next <= $cursor) {
|
||||
break;
|
||||
}
|
||||
|
||||
$cursor = $next;
|
||||
$this->setDue($task_id, $cursor);
|
||||
$fireTime = $cursor - $daysBefore * 86400;
|
||||
$spawned++;
|
||||
}
|
||||
|
||||
// Reconcile the duplicate links with the setting (removes both new and old ones when off).
|
||||
$this->syncCloneLinks($task_id, $linkCopies);
|
||||
|
||||
return $spawned;
|
||||
}
|
||||
|
||||
/**
|
||||
* Reconcile a template's "is a duplicate of" links with the link-copies setting. When off, remove
|
||||
* the links to THIS template's own RecoReco clones (identified by recoreco_source, so manual
|
||||
* links are left untouched). When on, do nothing -- new spawns already carry the link.
|
||||
*
|
||||
* @param int $template_id
|
||||
* @param bool $linkCopies
|
||||
*/
|
||||
public function syncCloneLinks($template_id, $linkCopies)
|
||||
{
|
||||
if ($linkCopies) {
|
||||
return;
|
||||
}
|
||||
|
||||
foreach ($this->taskLinkModel->getAll($template_id) as $link) {
|
||||
$opposite = (int) $link['task_id'];
|
||||
|
||||
if ((int) $this->taskMetadataModel->get($opposite, 'recoreco_source', 0) === (int) $template_id) {
|
||||
$this->taskLinkModel->remove($link['id']);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The first occurrence: respect an explicitly future anchor (the due date the user set) as the
|
||||
* first one; otherwise jump to the next occurrence on/after now.
|
||||
*/
|
||||
private function firstCursor($anchor, $frequency, $lastDay, $now)
|
||||
{
|
||||
if ($anchor >= $now) {
|
||||
return $anchor;
|
||||
}
|
||||
|
||||
return $this->calculator()->occurrenceFrom($anchor, $frequency, $lastDay, $now, true);
|
||||
}
|
||||
|
||||
private function setDue($task_id, $cursor)
|
||||
{
|
||||
// Advance the template's due date directly (no task events) + mirror it for edit detection.
|
||||
$this->db->table(TaskModel::TABLE)->eq('id', $task_id)->update(array('date_due' => $cursor));
|
||||
$this->taskMetadataModel->save($task_id, array('recoreco_synced_due' => $cursor));
|
||||
}
|
||||
|
||||
private function spawn(array $template, $targetColumn)
|
||||
{
|
||||
// The template's date_due is already the occurrence (setDue), so duplicate() copies it onto
|
||||
// the clone. duplicate() copies fields + tags + links + subtasks, but NO metadata, so the
|
||||
// clone is not a template.
|
||||
$newId = $this->taskDuplicationModel->duplicate($template['id']);
|
||||
|
||||
if ($newId === false) {
|
||||
$this->logger->error('RecoReco: duplicate failed for task '.$template['id']);
|
||||
return false;
|
||||
}
|
||||
|
||||
// duplicate() lands the clone in the source column; move it to the chosen target (top).
|
||||
if ($targetColumn > 0 && $targetColumn != $template['column_id']) {
|
||||
$this->taskPositionModel->movePosition($template['project_id'], $newId, $targetColumn, 1, $template['swimlane_id']);
|
||||
}
|
||||
|
||||
// Reset the "[DUPLICATE]" prefix back to the source title (no events).
|
||||
$this->taskModificationModel->update(array('id' => $newId, 'title' => $template['title']), false);
|
||||
|
||||
// Kanboard's duplicate() adds an "is a duplicate of" task link between the template and the
|
||||
// clone. It is reconciled with the recoreco_link_copies setting by syncCloneLinks() after
|
||||
// the spawn loop (kept when on, removed when off).
|
||||
|
||||
// Mark the clone: white icon + cannot itself be made recurring; record its source template.
|
||||
$this->taskMetadataModel->save($newId, array(
|
||||
'recoreco_clone' => 1,
|
||||
'recoreco_source' => $template['id'],
|
||||
));
|
||||
|
||||
// Signal FinanceBuddy (advance the installment). Harmless no-op if nothing listens.
|
||||
$payload = array('source_task_id' => (int) $template['id'], 'new_task_id' => (int) $newId);
|
||||
$this->hook->reference('recoreco:task:spawned', $payload);
|
||||
|
||||
return $newId;
|
||||
}
|
||||
|
||||
private function calculator()
|
||||
{
|
||||
if ($this->calc === null) {
|
||||
$this->calc = new OccurrenceCalculator();
|
||||
}
|
||||
|
||||
return $this->calc;
|
||||
}
|
||||
}
|
||||
@@ -11,6 +11,12 @@ class Plugin extends Base
|
||||
// "Recurring schedule" entry in the task Actions sidebar, right after the basic actions
|
||||
// (next to native "Edit recurrence"). Opens the RecoReco config modal.
|
||||
$this->template->hook->attach('template:task:sidebar:after-basic-actions', 'recoReco:task/sidebar_action');
|
||||
|
||||
// The scheduling engine runs from the CLI (cron). Registered CLI-only so web requests do
|
||||
// not build the console app.
|
||||
if (php_sapi_name() === 'cli') {
|
||||
$this->container['cli']->add(new \Kanboard\Plugin\RecoReco\Console\RecoRecoCommand($this->container));
|
||||
}
|
||||
}
|
||||
|
||||
public function getPluginName()
|
||||
@@ -30,7 +36,7 @@ class Plugin extends Base
|
||||
|
||||
public function getPluginVersion()
|
||||
{
|
||||
return '0.2.1';
|
||||
return '1.1.0';
|
||||
}
|
||||
|
||||
public function getPluginHomepage()
|
||||
|
||||
23
README.md
23
README.md
@@ -21,21 +21,36 @@ leaves native recurrence untouched (the two are mutually exclusive per card).
|
||||
- **Lead time:** "create the copy N days before the due date", so the card shows up early enough
|
||||
to act on; the copy is still due on the real day.
|
||||
|
||||
## Scheduling (cron)
|
||||
|
||||
The engine runs from the CLI command `recoreco:run`. Add it to cron **four times a day** -- at
|
||||
05:58, 11:58, 17:58 and 23:58:
|
||||
|
||||
```
|
||||
58 5,11,17,23 * * * cd /path/to/kanboard && php cli recoreco:run >> /var/log/recoreco.log 2>&1
|
||||
```
|
||||
|
||||
(Point the path at your install and run it as the user that owns Kanboard's data.) Each run looks
|
||||
ahead 12 hours; the runs overlap by 6 hours, so a single missed run is covered by the next one, and
|
||||
any occurrence whose time is already past is still caught up. `days before` shifts a copy earlier
|
||||
within that lead. You can also run it by hand any time: `php cli recoreco:run`.
|
||||
|
||||
## Status
|
||||
|
||||
Early development. This version adds the **Recurring schedule** modal (a task sidebar action) and
|
||||
stores the settings in task metadata. The scheduling engine and the cron command arrive in the
|
||||
following versions.
|
||||
Working for **monthly by day** (with the last-day rule), driven by cron. The remaining frequencies
|
||||
(yearly, weekly, daily, monthly by weekday), the recurrence icons, and the FinanceBuddy
|
||||
installment hand-off arrive in the following versions.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Kanboard >= 1.2.0
|
||||
- cron (to run `recoreco:run`)
|
||||
|
||||
## Installation
|
||||
|
||||
Copy this folder into your Kanboard installation as `plugins/RecoReco/`. The directory name must be
|
||||
exactly `RecoReco` (Kanboard derives the plugin namespace from the folder name). No build step and
|
||||
no database migration.
|
||||
no database migration. Then add the cron entry above.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
@@ -34,6 +34,11 @@
|
||||
<?= $this->form->label(t('Create the copy this many days before the due date'), 'recoreco_days_before') ?>
|
||||
<input type="number" name="recoreco_days_before" min="0" value="<?= $this->text->e($values['recoreco_days_before']) ?>">
|
||||
|
||||
<?= $this->form->checkbox('recoreco_link_copies', t('Link copies to the template'), 1, $values['recoreco_link_copies'] == 1) ?>
|
||||
<p class="form-help">
|
||||
<?= t('When on, the template keeps a link to each copy -- a running count and one-click navigation to every one. Off by default; best left off for frequent (daily/weekly) schedules to avoid piling up links.') ?>
|
||||
</p>
|
||||
|
||||
|
||||
<?= $this->modal->submitButtons() ?>
|
||||
</form>
|
||||
|
||||
165
Test/OccurrenceCalculatorTest.php
Normal file
165
Test/OccurrenceCalculatorTest.php
Normal file
@@ -0,0 +1,165 @@
|
||||
<?php
|
||||
|
||||
/*
|
||||
* Standalone test for the RecoReco date math -- no Kanboard / PHPUnit harness needed.
|
||||
* Run with: php Test/OccurrenceCalculatorTest.php
|
||||
*
|
||||
* OccurrenceCalculator is pure, so this exercises the highest-risk correctness surface (month
|
||||
* lengths, leap years, the last-day rule, the drift-free clamp).
|
||||
*/
|
||||
|
||||
require __DIR__.'/../Model/OccurrenceCalculator.php';
|
||||
|
||||
use Kanboard\Plugin\RecoReco\Model\OccurrenceCalculator;
|
||||
|
||||
date_default_timezone_set('UTC');
|
||||
|
||||
$calc = new OccurrenceCalculator();
|
||||
$failures = 0;
|
||||
|
||||
function ts($str)
|
||||
{
|
||||
return strtotime($str.' UTC');
|
||||
}
|
||||
|
||||
function check($label, $got, $expected, &$failures)
|
||||
{
|
||||
$ok = $got === $expected;
|
||||
$g = $got === null ? 'null' : date('Y-m-d H:i', $got);
|
||||
$e = $expected === null ? 'null' : date('Y-m-d H:i', $expected);
|
||||
echo ($ok ? 'PASS' : 'FAIL').' '.$label.' got='.$g.' expected='.$e."\n";
|
||||
if (! $ok) {
|
||||
$failures++;
|
||||
}
|
||||
}
|
||||
|
||||
// 1. Plain day-of-month: the 15th, every month.
|
||||
check(
|
||||
'monthly 15th, next after Jan 20',
|
||||
$calc->occurrenceFrom(ts('2023-01-15 10:30'), 'monthly_day', false, ts('2023-01-20 00:00'), false),
|
||||
ts('2023-02-15 10:30'),
|
||||
$failures
|
||||
);
|
||||
|
||||
// 2. Drift-free clamp: the 30th -> Feb clamps to 28 -> back to 30 in March (NOT 28).
|
||||
check(
|
||||
'30th -> Feb (non-leap) clamps to 28',
|
||||
$calc->occurrenceFrom(ts('2023-01-30 09:00'), 'monthly_day', false, ts('2023-01-30 09:00'), false),
|
||||
ts('2023-02-28 09:00'),
|
||||
$failures
|
||||
);
|
||||
check(
|
||||
'30th -> March returns to 30 (no drift)',
|
||||
$calc->occurrenceFrom(ts('2023-01-30 09:00'), 'monthly_day', false, ts('2023-02-28 09:00'), false),
|
||||
ts('2023-03-30 09:00'),
|
||||
$failures
|
||||
);
|
||||
|
||||
// 3. Last-day rule: last day of each month.
|
||||
check(
|
||||
'last-day: Jan 31 -> Feb 28 (non-leap)',
|
||||
$calc->occurrenceFrom(ts('2023-01-31 08:00'), 'monthly_day', true, ts('2023-01-31 08:00'), false),
|
||||
ts('2023-02-28 08:00'),
|
||||
$failures
|
||||
);
|
||||
check(
|
||||
'last-day: Feb -> March 31',
|
||||
$calc->occurrenceFrom(ts('2023-01-31 08:00'), 'monthly_day', true, ts('2023-02-28 08:00'), false),
|
||||
ts('2023-03-31 08:00'),
|
||||
$failures
|
||||
);
|
||||
|
||||
// 4. Leap year: last day of Feb 2024 is the 29th.
|
||||
check(
|
||||
'last-day: Feb 2024 -> 29th (leap)',
|
||||
$calc->occurrenceFrom(ts('2024-01-31 08:00'), 'monthly_day', true, ts('2024-02-01 00:00'), false),
|
||||
ts('2024-02-29 08:00'),
|
||||
$failures
|
||||
);
|
||||
|
||||
// 5. Inclusive vs exclusive at an exact occurrence.
|
||||
check(
|
||||
'inclusive returns the same instant',
|
||||
$calc->occurrenceFrom(ts('2023-03-10 12:00'), 'monthly_day', false, ts('2023-03-10 12:00'), true),
|
||||
ts('2023-03-10 12:00'),
|
||||
$failures
|
||||
);
|
||||
check(
|
||||
'exclusive skips to next month',
|
||||
$calc->occurrenceFrom(ts('2023-03-10 12:00'), 'monthly_day', false, ts('2023-03-10 12:00'), false),
|
||||
ts('2023-04-10 12:00'),
|
||||
$failures
|
||||
);
|
||||
|
||||
// 6. Daily: same time every day.
|
||||
check(
|
||||
'daily -> next day same time',
|
||||
$calc->occurrenceFrom(ts('2023-03-10 09:30'), 'daily', false, ts('2023-03-10 12:00'), false),
|
||||
ts('2023-03-11 09:30'),
|
||||
$failures
|
||||
);
|
||||
|
||||
// 7. Weekly: same weekday every 7 days (2023-03-07 is a Tuesday).
|
||||
check(
|
||||
'weekly -> +7 days on the same weekday',
|
||||
$calc->occurrenceFrom(ts('2023-03-07 08:00'), 'weekly', false, ts('2023-03-07 08:00'), false),
|
||||
ts('2023-03-14 08:00'),
|
||||
$failures
|
||||
);
|
||||
|
||||
// 8. Monthly by weekday: 2nd Tuesday (2023-03-14) -> 2nd Tuesday of April (2023-04-11).
|
||||
check(
|
||||
'monthly-by-weekday: 2nd Tuesday -> next month 2nd Tuesday',
|
||||
$calc->occurrenceFrom(ts('2023-03-14 07:00'), 'monthly_dow', false, ts('2023-03-14 07:00'), false),
|
||||
ts('2023-04-11 07:00'),
|
||||
$failures
|
||||
);
|
||||
|
||||
// 9. Monthly by weekday, last: last Tuesday of March (2023-03-28) -> last Tuesday of April (04-25).
|
||||
check(
|
||||
'monthly-by-weekday last: last Tue -> next month last Tue',
|
||||
$calc->occurrenceFrom(ts('2023-03-28 07:00'), 'monthly_dow', true, ts('2023-03-28 07:00'), false),
|
||||
ts('2023-04-25 07:00'),
|
||||
$failures
|
||||
);
|
||||
|
||||
// 10. Yearly: same month/day next year.
|
||||
check(
|
||||
'yearly -> next year same date',
|
||||
$calc->occurrenceFrom(ts('2023-03-15 10:00'), 'yearly', false, ts('2023-03-15 10:00'), false),
|
||||
ts('2024-03-15 10:00'),
|
||||
$failures
|
||||
);
|
||||
|
||||
// 11. Yearly last-day on Feb 29 (leap) -> next year Feb 28.
|
||||
check(
|
||||
'yearly last-day: 2024-02-29 -> 2025-02-28',
|
||||
$calc->occurrenceFrom(ts('2024-02-29 08:00'), 'yearly', true, ts('2024-02-29 08:00'), false),
|
||||
ts('2025-02-28 08:00'),
|
||||
$failures
|
||||
);
|
||||
|
||||
// 12. Yearly numeric Feb 29 -> clamps to 28 in a non-leap year, back to 29 in the next leap year.
|
||||
check(
|
||||
'yearly numeric 29-Feb -> 2025 clamps to 28',
|
||||
$calc->occurrenceFrom(ts('2024-02-29 08:00'), 'yearly', false, ts('2024-02-29 08:00'), false),
|
||||
ts('2025-02-28 08:00'),
|
||||
$failures
|
||||
);
|
||||
check(
|
||||
'yearly numeric 29-Feb -> 2028 back to 29 (leap)',
|
||||
$calc->occurrenceFrom(ts('2024-02-29 08:00'), 'yearly', false, ts('2027-03-01 00:00'), false),
|
||||
ts('2028-02-29 08:00'),
|
||||
$failures
|
||||
);
|
||||
|
||||
// 13. Unknown frequency returns null.
|
||||
check(
|
||||
'unknown frequency -> null',
|
||||
$calc->occurrenceFrom(ts('2023-03-10 12:00'), 'nope', false, ts('2023-03-10 12:00'), false),
|
||||
null,
|
||||
$failures
|
||||
);
|
||||
|
||||
echo "\n".($failures === 0 ? 'ALL PASSED' : $failures.' FAILURE(S)')."\n";
|
||||
exit($failures === 0 ? 0 : 1);
|
||||
Reference in New Issue
Block a user