summaryrefslogtreecommitdiff
path: root/plugins/kolab_tags/kolab_tags.php
blob: c3a184694180eab1a0b3ddc0ec7f74be7b4095b2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
<?php

/**
 * Kolab Tags
 *
 * @author Aleksander Machniak <machniak@kolabsys.com>
 *
 * Copyright (C) 2014, Kolab Systems AG <contact@kolabsys.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

class kolab_tags extends rcube_plugin
{
    public $task = 'mail';
    public $rc;
    public $home;

    private $engine;

    public function init()
    {
        $this->rc = rcube::get_instance();

        // Register hooks to display tags in message subject
        $this->add_hook('messages_list', array($this, 'messages_list'));
        $this->add_hook('message_headers_output', array($this, 'message_headers_output'));

        // Searching by tags
        $this->add_hook('imap_search_before', array($this, 'imap_search_before'));

        // Plugin actions for tag management
        $this->register_action('plugin.kolab_tags', array($this, 'actions'));

        // Load UI from startup hook
        $this->add_hook('startup', array($this, 'startup'));
    }

    /**
     * Creates kolab_files_engine instance
     */
    private function engine()
    {
        if ($this->engine === null) {
            // the files module can be enabled/disabled by the kolab_auth plugin
            if ($this->rc->config->get('kolab_tags_disabled') || !$this->rc->config->get('kolab_tags_enabled', true)) {
                return $this->engine = false;
            }

//            $this->load_config();

            require_once $this->home . DIRECTORY_SEPARATOR . 'lib' . DIRECTORY_SEPARATOR . 'kolab_tags_engine.php';

            $this->engine = new kolab_tags_engine($this);
        }

        return $this->engine;
    }

    /**
     * Startup hook handler, initializes/enables Files UI
     */
    public function startup($args)
    {
        // call this from startup to give a chance to set
        // kolab_files_enabled/disabled in kolab_auth plugin
        if ($this->rc->output->type != 'html') {
            return;
        }

        if ($this->rc->action == 'print') {
            return;
        }

        if ($engine = $this->engine()) {
            $engine->ui();
        }
    }

    /**
     * Engine actions handler
     */
    public function actions()
    {
        if ($engine = $this->engine()) {
            $engine->actions();
        }
    }

    /**
     * Handler for messages list
     */
    public function messages_list($args)
    {
        if ($engine = $this->engine()) {
            $args = $engine->messages_list_handler($args);
        }

        return $args;
    }

    /**
     * Handler for message headers
     */
    public function message_headers_output($args)
    {
        // this hook can be executed many times
        if ($this->mail_headers_done) {
            return $args;
        }

        $this->mail_headers_done = true;

        if ($engine = $this->engine()) {
            $args = $engine->message_headers_handler($args);
        }

        return $args;
    }

    /**
     * Handler for messages searching
     */
    public function imap_search_before($args)
    {
        // if search filter contains tag mark
        if (preg_match('/^(kolab_tags_[0-9]{10,}:([^:]+):)/', $args['search'], $m) && ($engine = $this->engine())) {
            $this->current_tags   = $args['search_tags'] = explode(',', $m[2]);
            $this->current_filter = $args['search']      = substr($args['search'], strlen($m[1]));

            // modify search arguments
            $args = $engine->imap_search_handler($args);

            unset($args['search_tags']);

            // send current search properties to the browser
            $this->rc->output->set_env('search_filter_selected', $this->current_filter);
            $this->rc->output->set_env('selected_tags', $this->current_tags);
        }

        return $args;
    }
}