xref: /plugin/bez/mdl/Task.php (revision f6c2876135650d1dd3f8c6036cde2606ec2ab0c4)

<?php

namespace dokuwiki\plugin\bez\mdl;

use dokuwiki\plugin\bez\meta\ConsistencyViolationException;
use dokuwiki\plugin\bez\meta\Mailer;
use dokuwiki\plugin\bez\meta\PermissionDeniedException;
use dokuwiki\plugin\bez\meta\ValidationException;
use dokuwiki\plugin\struct\types\DateTime;

class Task extends Entity {

    protected $id;

	protected $original_poster, $assignee, $closed_by;

	protected $private, $lock;

	protected $state, $type;

	protected $create_date, $last_activity_date, $last_modification_date, $close_date;

	protected $cost, $plan_date, $all_day_event, $start_time, $finish_time;

	protected $content, $content_html;

	protected $thread_id, $thread_comment_id, $task_program_id;

	/** @var \dokuwiki\plugin\bez\mdl\Thread */
	protected $thread;

	/** @var Thread_comment */
	protected $thread_comment;

	//virtual
    protected $task_program_name, $priority, $coordinator;

	public static function get_columns() {
		return array('id',
            'original_poster', 'assignee', 'closed_by',
            'private', 'lock',
            'state', 'type',
            'create_date', 'last_activity_date', 'last_modification_date', 'close_date',
            'cost', 'plan_date', 'all_day_event', 'start_time', 'finish_time',
            'content', 'content_html',
            'thread_id', 'thread_comment_id', 'task_program_id');
	}

	public static function get_acl_columns() {
	    return array_merge(parent::get_acl_columns(), array('participants'));
    }

	public static function get_types() {
	    return array('correction', 'corrective', 'preventive', 'program');
    }

    public static function get_states() {
        return array('opened', 'done');
    }

    public function __get($property) {
        if ($property == 'thread') {
            if ($this->thread_id == null) {
                return null;
            }
            if ($this->thread == null || $this->thread_id != $this->thread->id) {
                $this->thread = $this->model->threadFactory->get_one($this->thread_id);
            }
            return $this->thread;

        } elseif($property == 'thread_comment') {
            if ($this->thread_comment_id == null) {
                return null;
            }
            if ($this->thread_comment == null || $this->thread_comment_id != $this->thread_comment->id) {
                $this->thread_comment = $this->model->thread_commentFactory->get_one($this->thread_comment_id);
            }
            return $this->thread_comment;

        } elseif($property == 'priority' || $property == 'coordinator' || $property == 'task_program_name') {
            return $this->$property;
        }
        return parent::__get($property);
    }

	public function __construct($model, $defaults=array()) {
		parent::__construct($model, $defaults);

		$this->validator->set_rules(array(
            'assignee' => array(array('dw_user'), 'NOT NULL'),
            'cost' => array(array('numeric'), 'NULL'),
			'plan_date' => array(array('iso_date'), 'NOT NULL'),
			'all_day_event' => array(array('select', array('0', '1')), 'NOT NULL'),
			'start_time' => array(array('time'), 'NULL'),
			'finish_time' => array(array('time'), 'NULL'),
            'content' => array(array('length', 10000), 'NOT NULL'),
            'thread_comment_id' => array(array('numeric'), 'NULL'),
            'task_program_id' => array(array('numeric'), 'NULL')
		));

		//we've created empty object
		if ($this->id === NULL) {
            $this->original_poster = $this->model->user_nick;
            $this->create_date = date('c');
            $this->last_activity_date = $this->create_date;
            $this->last_modification_date = $this->create_date;

            $this->state = 'opened';

            if (isset($defaults['thread'])) {
                $this->thread = $defaults['thread'];
                $this->thread_id = $this->thread->id;
                $this->coordinator = $this->thread->coordinator;

                if ($this->thread->private == '1') {
                    $this->private = '1';
                }

                $this->type = 'correction';

                if (isset($defaults['thread_comment'])) {
                    $this->thread_comment = $defaults['thread_comment'];
                    $this->thread_comment_id = $this->thread_comment->id;

                    if ($this->thread_comment->type == 'cause') {
                        $this->type = 'corrective';
                    } else {
                        $this->type = 'preventive';
                    }
                }
            } else {
                $this->type = 'program';
            }


            if ($this->thread_id == '') {
                $this->validator->set_rules(array(
                                                'task_program_id' => array(array('numeric'), 'NOT NULL'),
                                            ));
                //this field is unused in program tasks
                $this->validator->delete_rule('thread_comment_id');
            }

            //everyone can report their own program tasks
            if ($this->type == 'program') {
                $this->acl->grant('content', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('plan_date', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('start_time', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('finish_time', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('all_day_event', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('task_program_id', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('cost', BEZ_PERMISSION_CHANGE);
            }

            if ($this->type == 'program' && $this->model->get_level() >= BEZ_AUTH_LEADER) {
                $this->acl->grant('assignee', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('participants', BEZ_PERMISSION_CHANGE);
            }

            if ($this->type != 'program' && $this->coordinator == $this->model->user_nick) {
                $this->acl->grant('content', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('plan_date', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('start_time', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('finish_time', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('all_day_event', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('task_program_id', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('cost', BEZ_PERMISSION_CHANGE);

                $this->acl->grant('assignee', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('participants', BEZ_PERMISSION_CHANGE);
            }

        //we get object form db
		} else {
            if (isset($defaults['thread']) && $this->thread_id == $defaults['thread']->id) {
                $this->thread = $defaults['thread'];
            }

            if (isset($defaults['thread_comment']) && $this->thread_comment_id == $defaults['thread_comment']->id) {
                $this->thread_comment = $defaults['thread_comment'];
            }

            if ($this->thread_id == '') {
                $this->validator->set_rules(array(
                                                'task_program_id' => array(array('numeric'), 'NOT NULL'),
                                            ));
                //this field is unused in program tasks
                $this->validator->delete_rule('thread_comment_id');
            }

            //private tasks
            if ($this->model->level < BEZ_AUTH_ADMIN && $this->private == '1') {
                if ($this->get_participant($this->model->user_nick) === false &&
                    ($this->thread_id != '' && $this->__get('thread')->get_participant($this->model->user_nick) === false)) {
                    $this->acl->revoke(self::get_select_columns(), BEZ_AUTH_LEADER);
                    return;
                }
            }

            //user can close their tasks
            if ($this->assignee == $this->model->user_nick || $this->model->get_level() >= BEZ_AUTH_LEADER) {
                $this->acl->grant('state', BEZ_PERMISSION_CHANGE);
            }

            if ($this->type == 'program' && $this->original_poster == $this->model->user_nick) {
                $this->acl->grant('content', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('plan_date', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('start_time', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('finish_time', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('all_day_event', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('task_program_id', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('cost', BEZ_PERMISSION_CHANGE);
            }

            if (($this->type != 'program' && $this->coordinator == $this->model->user_nick) ||
                ($this->model->get_level() >= BEZ_AUTH_LEADER)) {
                $this->acl->grant('content', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('plan_date', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('start_time', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('finish_time', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('all_day_event', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('task_program_id', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('cost', BEZ_PERMISSION_CHANGE);

                $this->acl->grant('assignee', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('participants', BEZ_PERMISSION_CHANGE);
                $this->acl->grant('state', BEZ_PERMISSION_CHANGE);
            }
        }
    }

    public function update_virutal() {
        if ($this->state == 'done') {
            $this->priority = '';
        } else {
            $now = date('Y-m-d');
            $plus_1_month = date('Y-m-d', strtotime('+1 month'));

            if ($this->plan_date >= $plus_1_month) {
                $this->priority = '0';
            } elseif ($this->plan_date >= $now) {
                $this->priority = '1';
            } else {
                $this->priority = '2';
            }
        }
    }

	public function set_data($post, $filter=NULL) {
        //all day event
        if (!isset($post['all_day_event'])) {
            $post['all_day_event'] = '0';
        }

        parent::set_data($post);

        $this->purge();

        if ($this->thread_id == '') {
            $this->type = 'program';
        } elseif ($this->thread_comment_id == '') {
            $this->type = 'correction';
        } elseif ($this->__get('thread_comment')->type == 'cause') {
            $this->type = 'corrective';
        } else {
            $this->type = 'preventive';
        }

        if (!isset($post['assignee'])) {
            $this->assignee = $this->model->user_nick;
        }

        //update dates
        $this->last_modification_date = date('c');
        $this->last_activity_date = $this->last_modification_date;

        //update virtual
        $this->update_virutal();

		return true;
	}

    public function set_state($state) {
	    if ($this->acl_of('state') < BEZ_PERMISSION_CHANGE) {
	        throw new PermissionDeniedException();
        }

        if (!in_array($state, array('opened', 'done'))) {
	        throw new ValidationException('task', array('sholud be opened or done'));
        }

        //nothing to do
        if ($state == $this->state) {
	        return;
        }

        if ($state == 'done') {
            $this->state = $state;
            $this->closed_by = $this->model->user_nick;
            $this->close_date = date('c');

            $this->model->sqlite->query("UPDATE {$this->get_table_name()} SET state=?, closed_by=?, close_date=? WHERE id=?",
                $this->state,
                $this->closed_by,
                $this->close_date,
                $this->id);
        //reopen the task
        } else {
            $this->model->sqlite->query("UPDATE {$this->get_table_name()} SET state=? WHERE id=?", $state, $this->id);
        }

        $this->state = $state;
    }

    public function set_task_program($taks_program_id) {
	    $this->task_program_id = $taks_program_id;
    }

    public function update_last_activity() {
        $this->last_activity_date = date('c');
        $this->model->sqlite->query('UPDATE task SET last_activity_date=? WHERE id=?',
                                    $this->last_activity_date, $this->id);
    }

    public function can_add_comments() {
        if ($this->thread_id != '' && $this->thread->state == 'closed') {
            return false;
        }

        if ($this->state == 'opened' ||
            ($this->state == 'done' &&
                $this->acl_of('state') >= BEZ_PERMISSION_CHANGE)) {
            return true;
        }

        return false;
    }

    public function can_add_participants() {
        return in_array($this->state, array('opened'));
    }

    public function get_participants($filter='') {
        if ($this->id === NULL) {
            return array();
        }

        $sql = 'SELECT * FROM task_participant WHERE';
        $possible_flags = array('original_poster', 'assignee', 'commentator', 'subscribent');
        if ($filter != '') {
            if (!in_array($filter, $possible_flags)) {
                throw new \Exception("unknown flag $filter");
            }
            $sql .= " $filter=1 AND";
        }
        $sql .= ' task_id=? AND removed=0 ORDER BY user_id';

        $r = $this->model->sqlite->query($sql, $this->id);
        $pars = $this->model->sqlite->res2arr($r);
        $participants = array();
        foreach ($pars as $par) {
            $participants[$par['user_id']] = $par;
        }

        return $participants;
    }

    public function get_participant($user_id, $can_be_removed=false) {
        if ($this->id === NULL) {
            return array();
        }

        $q = 'SELECT * FROM task_participant WHERE task_id=? AND user_id=?';
        if (!$can_be_removed) {
            $q .= ' AND removed=0';
        }
        $r = $this->model->sqlite->query($q, $this->id, $user_id);
        $par = $this->model->sqlite->res2row($r);
        if (!is_array($par)) {
            return false;
        }

        return $par;
    }

    public function is_subscribent($user_id=null) {
        if ($user_id == null) {
            $user_id = $this->model->user_nick;
        }
        $par = $this->get_participant($user_id);
        if ($par['subscribent'] == 1) {
            return true;
        }
        return false;
    }

    public function remove_participant_flags($user_id, $flags) {
        //thread not saved yet
        if ($this->id === NULL) {
            throw new \Exception('cannot remove flags from not saved thread');
        }

        $participant = $this->get_participant($user_id, true);
        if ($participant === false) {
            throw new ConsistencyViolationException("$user_id isn't participant");
        }

        $possible_flags = array('original_poster', 'assignee', 'commentator', 'subscribent');
        if (array_intersect($flags, $possible_flags) != $flags) {
            throw new \Exception('unknown flags');
        }

        $set = implode(',', array_map(function ($v) { return "$v=0"; }, $flags));

        $sql = "UPDATE task_participant SET $set WHERE task_id=? AND user_id=?";
        $this->model->sqlite->query($sql, $this->id, $user_id);

    }

    public function set_participant_flags($user_id, $flags=array()) {
        //thread not saved yet
        if ($this->id === NULL) {
            throw new \Exception('cannot add flags to not saved thread');
        }

        //validate user
        if (!$this->model->userFactory->exists($user_id)) {
            throw new \Exception("$user_id isn't dokuwiki user");
        }

        $possible_flags = array('original_poster', 'assignee', 'commentator', 'subscribent');
        if (array_intersect($flags, $possible_flags) != $flags) {
            throw new \Exception('unknown flags');
        }

        $participant = $this->get_participant($user_id, true);
        if ($participant == false) {
            $participant = array_fill_keys($possible_flags, 0);

            $participant['task_id'] = $this->id;
            $participant['user_id'] = $user_id;
            $participant['added_by'] = $this->model->user_nick;
            $participant['added_date'] = date('c');

            $values = array_merge($participant, array_fill_keys($flags, 1));
            $this->model->sqlite->storeEntry('task_participant', $values);
        } else {
            $set = implode(',', array_map(function($flag) { return "$flag=1"; }, $flags));

            if ($participant['removed'] == '1') {
                $set .= ',removed=0';
            }

            $q = "UPDATE task_participant SET $set WHERE task_id=? AND user_id=?";
            $this->model->sqlite->query($q, $this->id, $user_id);
        }
    }

    public function remove_participant($user_id) {
        //thread not saved yet
        if ($this->id === NULL) {
            throw new \Exception('cannot remove flags from not saved thread');
        }

        $participant = $this->get_participant($user_id);
        if ($participant === false) {
            throw new ConsistencyViolationException("$user_id isn't participant");
        }

        if ($participant['assignee'] == '1') {
            throw new ConsistencyViolationException("cannot remove assignee");
        }

        $q = "UPDATE task_participant SET removed=1 WHERE task_id=? AND user_id=?";
        $this->model->sqlite->query($q, $this->id, $user_id);

    }

    public function pin($thread_id) {
        if ($this->acl_of('thread_id') < BEZ_PERMISSION_CHANGE) {
            throw new PermissionDeniedException();
        }
        if ($this->thread_id != '') {
            throw new ConsistencyViolationException('task already pinned to thread');
        }

        //check if thread exists and isn't closed
        $q = "SELECT id, private FROM thread_view WHERE id = ? AND state IN ('opened', 'done')";
        $r = $this->model->sqlite->query($q, $thread_id);
        $thread = $this->model->sqlite->res_fetch_assoc($r);
        if (!$thread) {
            throw new ValidationException("task", array('thread_id' => 'pin_task'));
        }

        //if thread was private task is also private
        $q = "UPDATE task SET type='correction', thread_id=?";
        if ($thread['private']) {
            $q .= ", private=1";
        }
        $q .= " WHERE id=?";
        $this->model->sqlite->query($q, $thread_id, $this->id);
    }

    public function unpin() {
        if ($this->acl_of('thread_id') < BEZ_PERMISSION_CHANGE) {
            throw new PermissionDeniedException();
        }

        $q = "UPDATE task SET type='program', thread_id='', private=0 WHERE id=?";
        $this->model->sqlite->query($q, $this->id);
    }

    public function invite($client) {
        $this->set_participant_flags($client, array('subscribent'));
        $this->mail_notify_invite($client);
    }

    protected function html_link_url() {
        $tpl = $this->model->action->get_tpl();
        return $tpl->url('task', 'tid', $this->id);
    }

    protected function html_link_content() {
        $ret = '';
        if ($this->thread_id != '') {
            $ret .= '#'.$this->thread_id . ' ';
        }
        return $ret . '#z' . $this->id;
    }

    protected function getMailSubject()
    {
        return parent::getMailSubject() . ' #z'.$this->id. ' ' . $this->task_program_name; // TODO: Change the autogenerated stub
    }

    public function mail_task_box(&$attachedImages) {
        $tpl = $this->model->action->get_tpl();

        //render style
        $less = new \lessc();
        $less->addImportDir(DOKU_PLUGIN . 'bez/style/');
        $style = $less->compileFile(DOKU_PLUGIN . 'bez/style/task.less');

        //render content for mail
        $old_content_html = $this->content_html;
        $this->content_html = p_render('bez_xhtmlmail', p_get_instructions($this->content), $info);
        $attachedImages = array_merge($attachedImages, $info['img']);

        $tpl->set('task', $this);
        $tpl->set('style', $style);
        $tpl->set('no_actions', true);
        $task_box = $this->model->action->bez_tpl_include('task_box', true);

        $this->content_html = $old_content_html;

        return $task_box;
    }

    public function mail_task(&$attachedImages) {
        $tpl = $this->model->action->get_tpl();

        $task_box = $this->mail_task_box($attachedImages);
        $tpl->set('content', $task_box);
        $content = $this->model->action->bez_tpl_include('mail/task', true);

        return $content;
    }

    public function mail_notify_assignee() {
        $tpl = $this->model->action->get_tpl();

        //we don't want who
        $tpl->set('who', $this->model->user_nick);
        $tpl->set('action', 'mail_task_assignee');
        $attachedImages = array();
        $content = $this->mail_task($attachedImages);
        $this->mail_notify($content, array($this->assignee), $attachedImages);
    }

    public function mail_notify_remind($users=false, $days=1) {
        $tpl = $this->model->action->get_tpl();

        //we don't want who
        $tpl->set('who', '');
        $tpl->set('action', 'mail_task_remind');
        $tpl->set('action_replacements', array($days));
        $attachedImages = array();
        $content = $this->mail_task($attachedImages);
        $this->mail_notify($content, $users, $attachedImages);
    }

    public function mail_notify_invite($client) {
        $users = array($client);
        $tpl = $this->model->action->get_tpl();

        //we don't want who
        $tpl->set('who', $this->model->user_nick);
        $tpl->set('action', 'mail_task_invite');
        $attachedImages = array();
        $content = $this->mail_task($attachedImages);
        $this->mail_notify($content, $users, $attachedImages);
    }

    public function mail_notify_change_state($action='') {
        $tpl = $this->model->action->get_tpl();

        $tpl->set('who', $this->model->user_nick);
        $tpl->set('action', $action);
        $attachedImages = array();
        $content = $this->mail_task($attachedImages);
        $this->mail_notify($content, false, $attachedImages);
    }

}