RecoReco/Controller/RecurrenceController.php

<?php

namespace Kanboard\Plugin\RecoReco\Controller;

use Kanboard\Controller\BaseController;
use Kanboard\Model\TaskModel;

/**
 * The "Recurring schedule" modal: configure a card's calendar recurrence and store it in task
 * metadata. v0.2 is storage only -- no spawning (that is the CLI engine in later versions).
 *
 * Gate: a card can only be enabled when it has a due date (the recurrence anchor) and is not
 * already a native-recurring card (RecoReco and native recurrence are mutually exclusive).
 */
class RecurrenceController extends BaseController
{
    public function edit(array $values = array(), array $errors = array())
    {
        $task = $this->getTask();

        if (empty($values)) {
            $values = $this->getStoredValues($task);
        }

        $this->response->html($this->template->render('recoReco:recurrence/edit', array(
            'task' => $task,
            'values' => $values,
            'errors' => $errors,
            'columns_list' => $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,
        )));
    }

    public function save()
    {
        $task = $this->getTask();
        $input = $this->request->getValues();

        // Only a plain card (has a due date, not native-recurring) may be enabled.
        $can_recur = ! empty($task['date_due']) && $task['recurrence_status'] == TaskModel::RECURRING_STATUS_NONE;
        $enabled = ($can_recur && isset($input['recoreco_enabled']) && $input['recoreco_enabled'] == 1) ? 1 : 0;

        $frequency = isset($input['recoreco_frequency']) && array_key_exists($input['recoreco_frequency'], $this->getFrequencyList())
            ? $input['recoreco_frequency']
            : 'monthly_day';

        // Keep the lead time under one period (else a copy's fire time crosses the prior occurrence).
        $daysBefore = isset($input['recoreco_days_before']) && ctype_digit((string) $input['recoreco_days_before']) ? (int) $input['recoreco_days_before'] : 0;
        $daysBefore = min($daysBefore, $this->maxDaysBefore($frequency));

        $values = array(
            'recoreco_enabled' => $enabled,
            'recoreco_target_column' => isset($input['recoreco_target_column']) ? (int) $input['recoreco_target_column'] : (int) $task['column_id'],
            'recoreco_frequency' => $frequency,
            'recoreco_last_day' => isset($input['recoreco_last_day']) ? 1 : 0,
            'recoreco_days_before' => $daysBefore,
            '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
        // (v0.3) reads it to compute occurrences.
        if ($enabled) {
            $values['recoreco_anchor'] = (int) $task['date_due'];
        }

        $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);
    }

    private function getStoredValues(array $task)
    {
        $meta = $this->taskMetadataModel->getAll($task['id']);

        return array(
            'recoreco_enabled' => isset($meta['recoreco_enabled']) ? (int) $meta['recoreco_enabled'] : 0,
            'recoreco_target_column' => isset($meta['recoreco_target_column']) ? (int) $meta['recoreco_target_column'] : (int) $task['column_id'],
            '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,
        );
    }

    private function getFrequencyList()
    {
        return array(
            'yearly' => t('Yearly'),
            'monthly_day' => t('Monthly by day'),
            'monthly_dow' => t('Monthly by weekday'),
            'weekly' => t('Weekly'),
            'daily' => t('Daily'),
        );
    }

    /**
     * The largest allowed "days before" for a frequency -- kept strictly under one period so a
     * copy's fire time never crosses the previous occurrence. Daily = 0 (disabled).
     */
    private function maxDaysBefore($frequency)
    {
        switch ($frequency) {
            case 'daily':
                return 0;
            case 'weekly':
                return 6;
            case 'yearly':
                return 364;
            default: // monthly_day, monthly_dow
                return 27;
        }
    }
}