Compare commits
11 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| f5d5ffa7c9 | |||
| ba4a2fbbd0 | |||
| 8502b4f15d | |||
| 4eae02faed | |||
| d47ca98fb3 | |||
| 9373d43e96 | |||
| fc1f38fb30 | |||
| 9b486970d3 | |||
| daac5f3b54 | |||
| e9fc5df763 | |||
| d790c73ab5 |
@@ -38,10 +38,94 @@
|
||||
}
|
||||
}
|
||||
|
||||
// "Follow FinanceBuddy installments": when on, the current/limit fields mirror FinanceBuddy's
|
||||
// live installment current/total and are disabled (so they do not post, keeping FinanceBuddy the
|
||||
// single source of truth); when off, they restore RecoReco's own stored values.
|
||||
function applyFollow(checkbox) {
|
||||
var group = checkbox.closest(".recoreco-limit-group");
|
||||
if (!group) { return; }
|
||||
|
||||
var count = group.querySelector('input[name="recoreco_count"]');
|
||||
var limit = group.querySelector('input[name="recoreco_limit"]');
|
||||
if (!count || !limit) { return; }
|
||||
|
||||
if (checkbox.checked) {
|
||||
count.value = group.getAttribute("data-fb-current");
|
||||
limit.value = group.getAttribute("data-fb-total");
|
||||
} else {
|
||||
count.value = group.getAttribute("data-rr-count");
|
||||
limit.value = group.getAttribute("data-rr-limit");
|
||||
}
|
||||
|
||||
count.disabled = checkbox.checked;
|
||||
limit.disabled = checkbox.checked;
|
||||
}
|
||||
|
||||
// Trigger column: it can never be the target, so hide+disable that option and reset to Any if it
|
||||
// was selected; the invert checkbox only means something for a specific column.
|
||||
function applyTrigger() {
|
||||
var target = document.querySelector('select[name="recoreco_target_column"]');
|
||||
var trigger = document.querySelector('select[name="recoreco_trigger_column"]');
|
||||
var invert = document.querySelector('input[name="recoreco_trigger_invert"]');
|
||||
if (!target || !trigger) { return; }
|
||||
|
||||
for (var i = 0; i < trigger.options.length; i++) {
|
||||
var isTarget = trigger.options[i].value === target.value;
|
||||
trigger.options[i].hidden = isTarget;
|
||||
trigger.options[i].disabled = isTarget;
|
||||
}
|
||||
if (trigger.value === target.value) { trigger.value = "any"; }
|
||||
|
||||
if (invert) {
|
||||
var invertDisabled = (trigger.value === "any");
|
||||
invert.disabled = invertDisabled;
|
||||
var invertLabel = invert.closest("label");
|
||||
if (invertLabel) { invertLabel.style.opacity = invertDisabled ? "0.5" : ""; }
|
||||
}
|
||||
}
|
||||
|
||||
// Move-mode makes copies moot, so grey out "Link copies to the template" while it is checked
|
||||
// (disabled -> it won't post, so the saved value is 0).
|
||||
function applyMove() {
|
||||
var move = document.querySelector('input[name="recoreco_move"]');
|
||||
var link = document.querySelector('input[name="recoreco_link_copies"]');
|
||||
if (!move || !link) { return; }
|
||||
|
||||
link.disabled = move.checked;
|
||||
var label = link.closest("label");
|
||||
if (label) { label.style.opacity = move.checked ? "0.5" : ""; }
|
||||
}
|
||||
|
||||
// Italicize the card's current column in the target/trigger dropdowns, so you can see where it
|
||||
// sits right now. (<option> styling is honored by Chrome/Firefox; Safari may ignore it.)
|
||||
function applyCurrentItalic() {
|
||||
var form = document.querySelector('form[data-recoreco-current]');
|
||||
if (!form) { return; }
|
||||
|
||||
var current = form.getAttribute("data-recoreco-current");
|
||||
var selects = form.querySelectorAll('select[name="recoreco_target_column"], select[name="recoreco_trigger_column"]');
|
||||
for (var s = 0; s < selects.length; s++) {
|
||||
for (var i = 0; i < selects[s].options.length; i++) {
|
||||
if (selects[s].options[i].value === current) {
|
||||
selects[s].options[i].style.fontStyle = "italic";
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
document.addEventListener("change", function (e) {
|
||||
if (e.target && e.target.name === "recoreco_frequency") {
|
||||
apply(e.target);
|
||||
}
|
||||
if (e.target && e.target.name === "recoreco_follow_finance") {
|
||||
applyFollow(e.target);
|
||||
}
|
||||
if (e.target && (e.target.name === "recoreco_target_column" || e.target.name === "recoreco_trigger_column")) {
|
||||
applyTrigger();
|
||||
}
|
||||
if (e.target && e.target.name === "recoreco_move") {
|
||||
applyMove();
|
||||
}
|
||||
});
|
||||
|
||||
if (window.MutationObserver) {
|
||||
@@ -50,6 +134,9 @@
|
||||
if (select) {
|
||||
select.setAttribute("data-recoreco-init", "1");
|
||||
apply(select);
|
||||
applyTrigger();
|
||||
applyMove();
|
||||
applyCurrentItalic();
|
||||
}
|
||||
}).observe(document.body, { childList: true, subtree: true });
|
||||
}
|
||||
|
||||
@@ -21,8 +21,12 @@ class RecurrenceController extends BaseController
|
||||
$columns = $this->targetColumns($task);
|
||||
$meta = $this->taskMetadataModel->getAll($task['id']);
|
||||
|
||||
// The "Follow FinanceBuddy installments" option only appears when FinanceBuddy is enabled on
|
||||
// this board (installed but not enabled means no installment data to follow).
|
||||
$fb_enabled = (int) $this->projectMetadataModel->get($task['project_id'], 'financebuddy_enabled', 0) === 1;
|
||||
|
||||
if (empty($values)) {
|
||||
$values = $this->getStoredValues($meta, $task, $columns);
|
||||
$values = $this->getStoredValues($meta, $task, $columns, $fb_enabled);
|
||||
}
|
||||
|
||||
$this->response->html($this->template->render('recoReco:recurrence/edit', array(
|
||||
@@ -30,12 +34,16 @@ class RecurrenceController extends BaseController
|
||||
'values' => $values,
|
||||
'errors' => $errors,
|
||||
'columns_list' => $columns,
|
||||
'all_columns' => $this->columnModel->getList($task['project_id']),
|
||||
'frequency_list' => $this->getFrequencyList(),
|
||||
'has_due_date' => ! empty($task['date_due']),
|
||||
'is_native' => $task['recurrence_status'] != TaskModel::RECURRING_STATUS_NONE,
|
||||
'has_target' => ! empty($columns),
|
||||
'is_clone' => isset($meta['recoreco_clone']) && $meta['recoreco_clone'] == 1,
|
||||
'source_id' => isset($meta['recoreco_source']) ? (int) $meta['recoreco_source'] : 0,
|
||||
'fb_enabled' => $fb_enabled,
|
||||
'fb_current' => isset($meta['financebuddy_installment_current']) ? $meta['financebuddy_installment_current'] : '',
|
||||
'fb_total' => isset($meta['financebuddy_installment_total']) ? $meta['financebuddy_installment_total'] : '',
|
||||
)));
|
||||
}
|
||||
|
||||
@@ -78,6 +86,29 @@ class RecurrenceController extends BaseController
|
||||
$values['recoreco_anchor'] = (int) $task['date_due'];
|
||||
}
|
||||
|
||||
// Finite-plan limit. When FinanceBuddy is enabled on the board and "Follow" is on, RecoReco
|
||||
// reads its installment total/current live at run time -- so nothing is stored here and the
|
||||
// standalone limit/counter are left untouched (the modal greys them). Otherwise store the
|
||||
// standalone limit (blank/0 = forever) and the 1-based progress counter (seedable).
|
||||
$fb_enabled = (int) $this->projectMetadataModel->get($task['project_id'], 'financebuddy_enabled', 0) === 1;
|
||||
$follow = $fb_enabled && isset($input['recoreco_follow_finance']) && $input['recoreco_follow_finance'] == 1;
|
||||
$values['recoreco_follow_finance'] = $follow ? 1 : 0;
|
||||
|
||||
if (! $follow) {
|
||||
$values['recoreco_limit'] = (isset($input['recoreco_limit']) && ctype_digit((string) $input['recoreco_limit'])) ? (int) $input['recoreco_limit'] : 0;
|
||||
$values['recoreco_count'] = (isset($input['recoreco_count']) && ctype_digit((string) $input['recoreco_count']) && (int) $input['recoreco_count'] >= 1) ? (int) $input['recoreco_count'] : 1;
|
||||
}
|
||||
|
||||
// Trigger column + move-mode (v1.9).
|
||||
$allColumns = $this->columnModel->getList($task['project_id']);
|
||||
$trig = isset($input['recoreco_trigger_column']) ? (string) $input['recoreco_trigger_column'] : 'any';
|
||||
$values['recoreco_trigger_column'] = ($trig !== 'any' && array_key_exists((int) $trig, $allColumns)) ? (int) $trig : 'any';
|
||||
$values['recoreco_trigger_invert'] = isset($input['recoreco_trigger_invert']) ? 1 : 0;
|
||||
$values['recoreco_move'] = isset($input['recoreco_move']) ? 1 : 0;
|
||||
if ($values['recoreco_move'] === 1) {
|
||||
$values['recoreco_follow_finance'] = 0; // Follow-FinanceBuddy is N/A in move-mode
|
||||
}
|
||||
|
||||
$this->taskMetadataModel->save($task['id'], $values);
|
||||
|
||||
// Reconcile the template's duplicate links with the setting right away.
|
||||
@@ -89,13 +120,13 @@ class RecurrenceController extends BaseController
|
||||
return $this->response->redirect($this->helper->url->to('TaskViewController', 'show', array('task_id' => $task['id'])), true);
|
||||
}
|
||||
|
||||
// Columns the copy can land in: every column except the template's own (the copy must move).
|
||||
// Target columns: ALL of the project's columns. This used to exclude the card's own column (a
|
||||
// duplicate copy "must move"), but move-mode legitimately rests the card IN the target, so the
|
||||
// target must be any column -- otherwise a moved card's own target vanishes from the dropdown and
|
||||
// a re-save would silently reset it. `target != trigger` is enforced in the modal instead.
|
||||
private function targetColumns(array $task)
|
||||
{
|
||||
$columns = $this->columnModel->getList($task['project_id']);
|
||||
unset($columns[$task['column_id']]);
|
||||
|
||||
return $columns;
|
||||
return $this->columnModel->getList($task['project_id']);
|
||||
}
|
||||
|
||||
// A stored/posted target, if still a valid non-current column; otherwise the first one (or 0).
|
||||
@@ -112,7 +143,7 @@ class RecurrenceController extends BaseController
|
||||
return empty($keys) ? 0 : (int) $keys[0];
|
||||
}
|
||||
|
||||
private function getStoredValues(array $meta, array $task, array $columns)
|
||||
private function getStoredValues(array $meta, array $task, array $columns, $fb_enabled)
|
||||
{
|
||||
return array(
|
||||
'recoreco_enabled' => isset($meta['recoreco_enabled']) ? (int) $meta['recoreco_enabled'] : 0,
|
||||
@@ -121,6 +152,13 @@ class RecurrenceController extends BaseController
|
||||
'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,
|
||||
// Follow defaults ON for a fresh card on a FinanceBuddy board; otherwise the stored choice.
|
||||
'recoreco_follow_finance' => isset($meta['recoreco_follow_finance']) ? (int) $meta['recoreco_follow_finance'] : ($fb_enabled ? 1 : 0),
|
||||
'recoreco_limit' => isset($meta['recoreco_limit']) ? (int) $meta['recoreco_limit'] : 0,
|
||||
'recoreco_count' => isset($meta['recoreco_count']) ? (int) $meta['recoreco_count'] : 1,
|
||||
'recoreco_move' => isset($meta['recoreco_move']) ? (int) $meta['recoreco_move'] : 0,
|
||||
'recoreco_trigger_column' => isset($meta['recoreco_trigger_column']) ? $meta['recoreco_trigger_column'] : 'any',
|
||||
'recoreco_trigger_invert' => isset($meta['recoreco_trigger_invert']) ? (int) $meta['recoreco_trigger_invert'] : 0,
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
@@ -83,10 +83,19 @@ class RecoRecoModel extends Base
|
||||
return 0;
|
||||
}
|
||||
|
||||
// Native wins: if the card became native-recurring, RecoReco yields (decision 13).
|
||||
// Native wins: if the card became native-recurring, RecoReco yields (decision 13). Leave a
|
||||
// visible trail in the task's activity stream, attributed to the card's owner (creator_id has
|
||||
// a FK to users, so a system id like 0 would make the insert fail silently -- no user 0).
|
||||
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)');
|
||||
$this->projectActivityModel->createEvent(
|
||||
(int) $task['project_id'],
|
||||
$task_id,
|
||||
(int) $task['creator_id'],
|
||||
'recoreco.task.disable',
|
||||
array('task' => array('id' => $task_id, 'title' => $task['title']))
|
||||
);
|
||||
return 0;
|
||||
}
|
||||
|
||||
@@ -112,6 +121,73 @@ class RecoRecoModel extends Base
|
||||
// Default off: only keep the duplicate link when explicitly turned on.
|
||||
$linkCopies = isset($meta['recoreco_link_copies']) && $meta['recoreco_link_copies'] == 1;
|
||||
|
||||
// Finite-plan stop. RecoReco caps its own recurrence, either by its own limit (standalone) or
|
||||
// by following FinanceBuddy. When follow is on, FinanceBuddy governs: the plan is finite only
|
||||
// if the card has a numeric installment total, so an ordinary recurring bill (money but no
|
||||
// installments) recurs forever -- and any stale standalone limit is ignored. In follow mode
|
||||
// the numbers are read LIVE from FinanceBuddy (never copied), so a mid-plan start, a
|
||||
// re-purchase, or an extend all just work by editing FinanceBuddy. A blank/0 limit means
|
||||
// recur forever. The spawn loop below stops when counter > limit (1-based; counter ends on
|
||||
// limit+1).
|
||||
$followIntent = isset($meta['recoreco_follow_finance']) && $meta['recoreco_follow_finance'] == 1;
|
||||
$fbTotal = isset($meta['financebuddy_installment_total']) ? (string) $meta['financebuddy_installment_total'] : '';
|
||||
$fbHasTotal = $fbTotal !== '' && ctype_digit($fbTotal);
|
||||
$follow = $followIntent && $fbHasTotal;
|
||||
|
||||
if ($followIntent) {
|
||||
$limit = $fbHasTotal ? (int) $fbTotal : 0; // following FinanceBuddy; no total => forever
|
||||
} else {
|
||||
$limitRaw = isset($meta['recoreco_limit']) ? (string) $meta['recoreco_limit'] : '';
|
||||
$limit = ($limitRaw !== '' && ctype_digit($limitRaw)) ? (int) $limitRaw : 0;
|
||||
}
|
||||
|
||||
// Standalone progress counter (1-based "next occurrence"). Unused in follow mode, where the
|
||||
// counter is FinanceBuddy's live installment_current instead.
|
||||
$count = isset($meta['recoreco_count']) && ctype_digit((string) $meta['recoreco_count']) ? (int) $meta['recoreco_count'] : 1;
|
||||
|
||||
// Trigger gate (cross-cutting, both modes): fire only while the card is in a triggering column,
|
||||
// and never while it sits in the target (Gate 2, uniform).
|
||||
$col = (int) $task['column_id'];
|
||||
$trig = isset($meta['recoreco_trigger_column']) ? $meta['recoreco_trigger_column'] : 'any';
|
||||
$invert = isset($meta['recoreco_trigger_invert']) && $meta['recoreco_trigger_invert'] == 1;
|
||||
$base = ($trig === 'any') ? true : ($invert ? ($col !== (int) $trig) : ($col === (int) $trig));
|
||||
|
||||
if (! ($base && $col !== $targetColumn)) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
// Move-mode: relocate the single card to the target instead of spawning a clone. No back-fill,
|
||||
// no clone metadata. Honors the standalone limit (save() forced follow=0, so $limit is it).
|
||||
if (isset($meta['recoreco_move']) && $meta['recoreco_move'] == 1) {
|
||||
$cursor = (int) $task['date_due'];
|
||||
|
||||
if ($cursor - $daysBefore * 86400 >= $horizon) {
|
||||
return 0; // not due yet
|
||||
}
|
||||
|
||||
if ($limit > 0 && $count > $limit) {
|
||||
$this->completePlan($task, $task_id); // safety: re-armed after completion
|
||||
return 0;
|
||||
}
|
||||
|
||||
$this->taskPositionModel->movePosition($task['project_id'], $task_id, $targetColumn, 1, $task['swimlane_id'], false);
|
||||
|
||||
$next = $this->calculator()->occurrenceFrom($anchor, $frequency, $lastDay, $cursor, false);
|
||||
if ($next !== null && $next > $cursor) {
|
||||
$this->setDue($task_id, $next); // advance one period
|
||||
}
|
||||
|
||||
if ($limit > 0) {
|
||||
$count++;
|
||||
$this->setCount($task_id, $count);
|
||||
if ($count > $limit) {
|
||||
$this->completePlan($task, $task_id);
|
||||
}
|
||||
}
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
// Phase 1 -- walk forward from the cursor, collecting every occurrence whose fire time has
|
||||
// arrived. The loop exits on the first occurrence still ahead of the horizon, which is then
|
||||
// the "next future" one to park on.
|
||||
@@ -140,23 +216,53 @@ class RecoRecoModel extends Base
|
||||
|
||||
// Phase 3 -- spawn each kept occurrence, dated to that occurrence. Idempotent: skip any that
|
||||
// this template has already spawned (survives a run overlapping cron on the same occurrence).
|
||||
// Two guards enforce the finite-plan limit: the leading one catches an already-complete plan
|
||||
// (a re-enabled done template, or a back-fill overshoot); the trailing one disables the
|
||||
// instant this run's spawn completes the plan.
|
||||
$spawned = 0;
|
||||
$completed = false;
|
||||
|
||||
foreach ($toSpawn as $occurrence) {
|
||||
$counter = $follow ? $this->financeCurrent($task_id) : $count;
|
||||
|
||||
if ($limit > 0 && $counter > $limit) {
|
||||
$completed = true;
|
||||
break;
|
||||
}
|
||||
|
||||
if ($this->cloneExists($task_id, $occurrence)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// duplicate() copies the template's date_due onto the clone, so set it to this occurrence
|
||||
// first, then spawn.
|
||||
// first, then spawn. spawn() fires the hook that lets FinanceBuddy advance its installment.
|
||||
$this->setDue($task_id, $occurrence);
|
||||
$this->spawn($task, $targetColumn);
|
||||
$spawned++;
|
||||
|
||||
// Standalone advances its own counter (only meaningful with a limit set); follow mode
|
||||
// relies on FinanceBuddy having advanced its installment during spawn().
|
||||
if (! $follow && $limit > 0) {
|
||||
$count++;
|
||||
$this->setCount($task_id, $count);
|
||||
}
|
||||
|
||||
$counter = $follow ? $this->financeCurrent($task_id) : $count;
|
||||
|
||||
if ($limit > 0 && $counter > $limit) {
|
||||
$completed = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// Phase 4 -- park the cursor on the next future occurrence and stop.
|
||||
// Phase 4 -- park the cursor on the next future occurrence. When the plan just completed,
|
||||
// disable the template (its p(total+1) tombstone is already in place) and log it.
|
||||
$this->setDue($task_id, $nextFuture);
|
||||
|
||||
if ($completed) {
|
||||
$this->completePlan($task, $task_id);
|
||||
}
|
||||
|
||||
// Reconcile the duplicate links with the setting (removes both new and old ones when off).
|
||||
$this->syncCloneLinks($task_id, $linkCopies);
|
||||
|
||||
@@ -218,6 +324,46 @@ class RecoRecoModel extends Base
|
||||
$this->db->table(TaskModel::TABLE)->eq('id', $task_id)->update(array('date_due' => $due));
|
||||
}
|
||||
|
||||
/**
|
||||
* FinanceBuddy's live "next installment to spawn" for a task (1-based), read fresh because
|
||||
* FinanceBuddy advances it on every spawn. Defaults to 1 when absent or non-numeric. RecoReco
|
||||
* only reads this key -- it never writes FinanceBuddy metadata.
|
||||
*
|
||||
* @param int $task_id
|
||||
* @return int
|
||||
*/
|
||||
private function financeCurrent($task_id)
|
||||
{
|
||||
$current = $this->taskMetadataModel->get($task_id, 'financebuddy_installment_current', 1);
|
||||
|
||||
return ctype_digit((string) $current) ? (int) $current : 1;
|
||||
}
|
||||
|
||||
private function setCount($task_id, $count)
|
||||
{
|
||||
$this->taskMetadataModel->save($task_id, array('recoreco_count' => (int) $count));
|
||||
}
|
||||
|
||||
/**
|
||||
* A finite plan reached its limit: disable the template and record it in the activity stream,
|
||||
* attributed to the card owner (creator_id has a FK to users, so a system id would fail silently).
|
||||
*
|
||||
* @param array $task
|
||||
* @param int $task_id
|
||||
*/
|
||||
private function completePlan(array $task, $task_id)
|
||||
{
|
||||
$this->taskMetadataModel->save($task_id, array('recoreco_enabled' => 0));
|
||||
$this->logger->info('RecoReco: plan complete on task '.$task_id.' (recurrence disabled)');
|
||||
$this->projectActivityModel->createEvent(
|
||||
(int) $task['project_id'],
|
||||
$task_id,
|
||||
(int) $task['creator_id'],
|
||||
'recoreco.task.complete',
|
||||
array('task' => array('id' => $task_id, 'title' => $task['title']))
|
||||
);
|
||||
}
|
||||
|
||||
private function spawn(array $template, $targetColumn)
|
||||
{
|
||||
// The template's date_due is already the occurrence (setDue), so duplicate() copies it onto
|
||||
@@ -252,6 +398,20 @@ class RecoRecoModel extends Base
|
||||
$payload = array('source_task_id' => (int) $template['id'], 'new_task_id' => (int) $newId);
|
||||
$this->hook->reference('recoreco:task:spawned', $payload);
|
||||
|
||||
// Record the spawn in the clone's activity stream, attributed to the template's owner
|
||||
// (creator_id has a FK to users, so a system id like 0 would silently fail the insert).
|
||||
$this->projectActivityModel->createEvent(
|
||||
(int) $template['project_id'],
|
||||
$newId,
|
||||
(int) $template['creator_id'],
|
||||
'recoreco.task.spawn',
|
||||
array(
|
||||
'task' => array('id' => $newId, 'title' => $template['title']),
|
||||
'template_id' => (int) $template['id'],
|
||||
'template_title' => $template['title'],
|
||||
)
|
||||
);
|
||||
|
||||
return $newId;
|
||||
}
|
||||
|
||||
|
||||
@@ -24,6 +24,13 @@ class Plugin extends Base
|
||||
// the same scheduler pass as cron. Admin-only for free via the shared 'ConfigController' ACL.
|
||||
$this->template->hook->attach('template:config:sidebar', 'recoReco:config/sidebar');
|
||||
|
||||
// Activity-stream entries. The feed renders each event via event/<name-with-underscores>, so
|
||||
// map our two event names to the plugin templates (a spawn on the new card, and the yield to
|
||||
// native recurrence on the template). createEvent() writes the rows directly from the model.
|
||||
$this->template->setTemplateOverride('event/recoreco_task_spawn', 'recoReco:event/recoreco_task_spawn');
|
||||
$this->template->setTemplateOverride('event/recoreco_task_disable', 'recoReco:event/recoreco_task_disable');
|
||||
$this->template->setTemplateOverride('event/recoreco_task_complete', 'recoReco:event/recoreco_task_complete');
|
||||
|
||||
// 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') {
|
||||
@@ -55,7 +62,7 @@ class Plugin extends Base
|
||||
|
||||
public function getPluginVersion()
|
||||
{
|
||||
return '1.4.0';
|
||||
return '1.9.4';
|
||||
}
|
||||
|
||||
public function getPluginHomepage()
|
||||
|
||||
69
README.md
69
README.md
@@ -8,6 +8,13 @@ A card marked recurring **stays** as a template; on schedule, RecoReco spawns a
|
||||
(non-recurring) copy into a column you choose. The template advances to the next date; the copy
|
||||
keeps the fired date.
|
||||
|
||||
> **A note on card order.** Because the template keeps its identity (and its id) for the life of the
|
||||
> plan while its due date advances, the template ends up as the *oldest* id carrying the *latest*
|
||||
> date. The spawned copies, by contrast, are ordered naturally (older copy = older id = older date).
|
||||
> This is intentional: a stable, editable template that stays in place is worth more than making the
|
||||
> one generator card sort by date. Native Kanboard recurrence avoids the mismatch only by
|
||||
> reincarnating the card every cycle, which RecoReco deliberately does not do.
|
||||
|
||||
RecoReco is opt-in per card and inert until you mark a card, so it needs no per-board setting. It
|
||||
leaves native recurrence untouched (the two are mutually exclusive per card).
|
||||
|
||||
@@ -44,11 +51,49 @@ You can trigger the exact same pass by hand -- either on the CLI (`php cli recor
|
||||
the **Run now** button under **Settings -> RecoReco** (admin only). The button and cron do the
|
||||
identical thing.
|
||||
|
||||
## Stopping a finite plan
|
||||
|
||||
By default a recurring card recurs forever. To make it stop, give it a **limit** in the Recurring
|
||||
schedule dialog:
|
||||
|
||||
- **Stop after N recurrences** -- a plain count; blank or 0 means recur forever. RecoReco keeps a
|
||||
1-based progress counter and turns the recurrence off once it passes the limit.
|
||||
- **Follow FinanceBuddy installments** -- shown only on boards where FinanceBuddy is enabled (and on
|
||||
by default there). RecoReco reads the card's installment total and current *live* from FinanceBuddy
|
||||
(never copied) and stops after the last installment. Because the numbers are read fresh, editing
|
||||
them in FinanceBuddy just works: start mid-plan (enter `222/420`), re-purchase (reset the current
|
||||
installment), or extend (raise the total) -- no RecoReco bookkeeping to keep in sync.
|
||||
|
||||
When a followed plan ends, the parked template is left one past the last installment (`p4/3` for a
|
||||
three-installment plan) as a visible "spent" marker, its recurrence off, with an activity-stream
|
||||
entry recording the completion.
|
||||
|
||||
## Trigger column and move-mode
|
||||
|
||||
Two options in the Recurring schedule dialog change *where* and *how* a card recurs:
|
||||
|
||||
- **Trigger column.** By default (`Any`) a card fires wherever it sits. Set a **Trigger column** and
|
||||
it only fires while parked there -- so a template spawns only from its "active" column, and moving
|
||||
it elsewhere quietly pauses it. The **`any but selected`** checkbox inverts the choice (fire in
|
||||
every column *except* the selected one, e.g. "any but Archive"). The **target column never
|
||||
triggers**, in any mode -- this is what lets a moved card come to rest in the target without
|
||||
re-firing. (One edge to know: a *duplicate* template dragged into its own target column no longer
|
||||
spawns; previously it fired from any column. Templates normally sit elsewhere, so this rarely
|
||||
bites.)
|
||||
- **Move instead of copy.** Tick **"Move the card instead of creating a copy"** and RecoReco
|
||||
relocates the *one* card to the target column each period instead of spawning a clone -- made for a
|
||||
recurring chore you don't want piling up copies. Pair it with a trigger column: e.g. trigger =
|
||||
`Done`, target = `Todo` -- cron moves the card `Done -> Todo` when it's due; you do the task and
|
||||
drag it back to `Done`; repeat. Move-mode honors the recurrence limit (stop after N moves) but not
|
||||
the FinanceBuddy follow (there is no copy to advance an installment on). Moves are silent (no
|
||||
"moved to column" notification each period).
|
||||
|
||||
## Status
|
||||
|
||||
All five frequencies work (yearly, monthly by day, monthly by weekday, weekly, daily) with the
|
||||
last-day rule, board recurrence icons, backfill with the 12-occurrence cap, the Run-now button, and
|
||||
the FinanceBuddy installment hand-off.
|
||||
last-day rule, board recurrence icons, backfill with the 12-occurrence cap, the Run-now button, a
|
||||
recurrence limit (standalone or following FinanceBuddy installments), the FinanceBuddy installment
|
||||
hand-off, a per-card trigger column, and move-mode (relocate instead of copy).
|
||||
|
||||
## Requirements
|
||||
|
||||
@@ -64,3 +109,23 @@ no database migration. Then add the cron entry above.
|
||||
## License
|
||||
|
||||
AGPL-3.0. See LICENSE.
|
||||
|
||||
## More Kanboard plugins by Dr. Beco
|
||||
|
||||
All free and AGPL-3.0, at [code.beco.cc](https://code.beco.cc/beco):
|
||||
|
||||
- **[FinanceBuddy](https://code.beco.cc/beco/FinanceBuddy)** -- attach a money value (debit/credit
|
||||
and installments) to cards, shown on the card and totalled per column.
|
||||
- **[QualKard](https://code.beco.cc/beco/QualKard)** -- flashcard spaced repetition: grade a card by
|
||||
dragging it to a column, and it comes back when due (needs RecoReco).
|
||||
- **[WorkspaceOrg](https://code.beco.cc/beco/WorkspaceOrg)** -- group your projects into personal
|
||||
per-user workspaces, shown on a "My workspaces" dashboard page with a badge on each project.
|
||||
- **[OrganonTweaks](https://code.beco.cc/beco/OrganonTweaks)** -- an umbrella of small
|
||||
quality-of-life board tweaks: remove an empty column, always show the comment icon, emphasize due
|
||||
dates, extra search keywords and shared board filters, and more.
|
||||
- **[BulkMoveTasks](https://code.beco.cc/beco/BulkMoveTasks)** -- move every task from one board
|
||||
column to another in a single action.
|
||||
- **[ShrinkVertically](https://code.beco.cc/beco/ShrinkVertically)** -- shrink vertically-collapsed
|
||||
board columns so the horizontal scrollbar stays within reach.
|
||||
- **[TweakDrag](https://code.beco.cc/beco/TweakDrag)** -- board drag and touch niceties:
|
||||
drag-to-scroll, a wider column gap, and smoother card dragging.
|
||||
|
||||
@@ -1,10 +1,14 @@
|
||||
<?php $type = $this->RecoRecoHelper->iconType($task) ?>
|
||||
<?php /* Calendar glyph (RecoReco is calendar recurrence), coloured by role so the template and its
|
||||
copies are distinct at a glance, and distinct from Kanboard's native refresh recurrence icon:
|
||||
dark blue = the recurring template (original), orange/dark-yellow = a generated copy.
|
||||
Inline colour is CSP-safe (style-src allows 'unsafe-inline'); no stylesheet needed. */ ?>
|
||||
<?php if ($type === 'template'): ?>
|
||||
<span title="<?= t('RecoReco: recurring template') ?>">
|
||||
<i class="fa fa-refresh fa-rotate-90" role="img" aria-label="<?= t('RecoReco: recurring template') ?>"></i>
|
||||
<i class="fa fa-calendar" style="color: #1f4e99;" role="img" aria-label="<?= t('RecoReco: recurring template') ?>"></i>
|
||||
</span>
|
||||
<?php elseif ($type === 'clone'): ?>
|
||||
<span title="<?= t('RecoReco: generated copy') ?>">
|
||||
<i class="fa fa-refresh fa-rotate-90 fa-inverse" role="img" aria-label="<?= t('RecoReco: generated copy') ?>"></i>
|
||||
<i class="fa fa-calendar" style="color: #e08e0b;" role="img" aria-label="<?= t('RecoReco: generated copy') ?>"></i>
|
||||
</span>
|
||||
<?php endif ?>
|
||||
|
||||
9
Template/event/recoreco_task_complete.php
Normal file
9
Template/event/recoreco_task_complete.php
Normal file
@@ -0,0 +1,9 @@
|
||||
<p class="activity-title">
|
||||
<?= e('RecoReco finished the recurrence plan on %s and turned recurrence off',
|
||||
$this->url->link(t('#%d', $task['id']), 'TaskViewController', 'show', array('task_id' => $task['id']))
|
||||
) ?>
|
||||
<small class="activity-date"><?= $this->dt->datetime($date_creation) ?></small>
|
||||
</p>
|
||||
<div class="activity-description">
|
||||
<p class="activity-task-title"><?= $this->text->e($task['title']) ?></p>
|
||||
</div>
|
||||
9
Template/event/recoreco_task_disable.php
Normal file
9
Template/event/recoreco_task_disable.php
Normal file
@@ -0,0 +1,9 @@
|
||||
<p class="activity-title">
|
||||
<?= e('RecoReco disabled recurrence on %s -- the card now uses Kanboard built-in recurrence',
|
||||
$this->url->link(t('#%d', $task['id']), 'TaskViewController', 'show', array('task_id' => $task['id']))
|
||||
) ?>
|
||||
<small class="activity-date"><?= $this->dt->datetime($date_creation) ?></small>
|
||||
</p>
|
||||
<div class="activity-description">
|
||||
<p class="activity-task-title"><?= $this->text->e($task['title']) ?></p>
|
||||
</div>
|
||||
10
Template/event/recoreco_task_spawn.php
Normal file
10
Template/event/recoreco_task_spawn.php
Normal file
@@ -0,0 +1,10 @@
|
||||
<p class="activity-title">
|
||||
<?= e('RecoReco created %s from the recurring template %s',
|
||||
$this->url->link(t('#%d', $task['id']), 'TaskViewController', 'show', array('task_id' => $task['id'])),
|
||||
$this->url->link($this->text->e($template_title), 'TaskViewController', 'show', array('task_id' => $template_id))
|
||||
) ?>
|
||||
<small class="activity-date"><?= $this->dt->datetime($date_creation) ?></small>
|
||||
</p>
|
||||
<div class="activity-description">
|
||||
<p class="activity-task-title"><?= $this->text->e($task['title']) ?></p>
|
||||
</div>
|
||||
@@ -33,7 +33,7 @@
|
||||
<p class="alert alert-info"><?= t('Add a target column first.') ?></p>
|
||||
<?php endif ?>
|
||||
|
||||
<form method="post" action="<?= $this->url->href('RecurrenceController', 'save', array('plugin' => 'RecoReco', 'task_id' => $task['id'])) ?>" autocomplete="off">
|
||||
<form method="post" action="<?= $this->url->href('RecurrenceController', 'save', array('plugin' => 'RecoReco', 'task_id' => $task['id'])) ?>" autocomplete="off" data-recoreco-current="<?= (int) $task['column_id'] ?>">
|
||||
<?= $this->form->csrf() ?>
|
||||
|
||||
<?= $this->form->label(t('Make recurring'), 'recoreco_enabled') ?>
|
||||
@@ -46,9 +46,21 @@
|
||||
</label>
|
||||
</div>
|
||||
|
||||
<?= $this->form->label(t('Target column (where the copy appears)'), 'recoreco_target_column') ?>
|
||||
<?= $this->form->label(t('Target column'), 'recoreco_target_column') ?>
|
||||
<?= $this->form->select('recoreco_target_column', $columns_list, $values) ?>
|
||||
|
||||
<?= $this->form->label(t('Trigger column'), 'recoreco_trigger_column') ?>
|
||||
<div class="recoreco-trigger" style="display:flex; align-items:center; gap:8px;">
|
||||
<?= $this->form->select('recoreco_trigger_column', array('any' => t('Any')) + $all_columns, $values) ?>
|
||||
<label style="white-space:nowrap;">
|
||||
<input type="checkbox" name="recoreco_trigger_invert" value="1" <?= $values['recoreco_trigger_invert'] == 1 ? 'checked="checked"' : '' ?>> <?= t('any but selected') ?>
|
||||
</label>
|
||||
</div>
|
||||
<p class="form-help"><?= t('Recurrence fires only while the card sits in a triggering column; the target column never triggers.') ?></p>
|
||||
|
||||
<?= $this->form->checkbox('recoreco_move', t('Move the card instead of creating a copy'), 1, $values['recoreco_move'] == 1) ?>
|
||||
<p class="form-help"><?= t('Relocate this one card to the target column each period instead of spawning a copy.') ?></p>
|
||||
|
||||
<?= $this->form->label(t('Frequency'), 'recoreco_frequency') ?>
|
||||
<?= $this->form->select('recoreco_frequency', $frequency_list, $values) ?>
|
||||
|
||||
@@ -62,6 +74,32 @@
|
||||
<?= $this->form->checkbox('recoreco_link_copies', t('Link copies to the template'), 1, $values['recoreco_link_copies'] == 1) ?>
|
||||
<p class="form-help"><?= t('Links each copy back to the template (a count and quick navigation). Off by default.') ?></p>
|
||||
|
||||
<?php $following = $fb_enabled && $values['recoreco_follow_finance'] == 1 ?>
|
||||
<?php $limit_display = (int) $values['recoreco_limit'] > 0 ? (int) $values['recoreco_limit'] : '' ?>
|
||||
<div class="recoreco-limit-group"
|
||||
data-fb-current="<?= $this->text->e($fb_current) ?>"
|
||||
data-fb-total="<?= $this->text->e($fb_total) ?>"
|
||||
data-rr-count="<?= (int) $values['recoreco_count'] ?>"
|
||||
data-rr-limit="<?= $this->text->e($limit_display) ?>">
|
||||
|
||||
<?php if ($fb_enabled): ?>
|
||||
<?= $this->form->checkbox('recoreco_follow_finance', t('Follow FinanceBuddy installments'), 1, $following) ?>
|
||||
<p class="form-help"><?= t('Stop recurring when the installment plan ends, following the card total and current installment.') ?></p>
|
||||
<?php endif ?>
|
||||
|
||||
<?= $this->form->label(t('Recurrence'), 'recoreco_count') ?>
|
||||
<div class="recoreco-limit-inline" style="display:flex; align-items:center; gap:6px;">
|
||||
<input type="number" name="recoreco_count" min="1" style="width:5em;"
|
||||
value="<?= $this->text->e($following ? $fb_current : $values['recoreco_count']) ?>"
|
||||
<?= $following ? 'disabled="disabled"' : '' ?>>
|
||||
<span><?= t('of') ?></span>
|
||||
<input type="number" name="recoreco_limit" min="1" style="width:5em;"
|
||||
value="<?= $this->text->e($following ? $fb_total : $limit_display) ?>"
|
||||
<?= $following ? 'disabled="disabled"' : '' ?>>
|
||||
</div>
|
||||
<p class="form-help"><?= t('Current recurrence and how many to run. Leave the second box empty to recur forever.') ?></p>
|
||||
</div>
|
||||
|
||||
<?= $this->modal->submitButtons() ?>
|
||||
</form>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user