summaryrefslogtreecommitdiff
path: root/plugins/kolab_tags/lib/kolab_tags_backend.php
blob: d79a6bfe7cd8d8aaba9f1b509be35736e546d999 (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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
<?php

/**
 * Kolab Tags backend
 *
 * @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_backend
{
    private $folders;
    private $tag_cols = array('name', 'category', 'color', 'parent', 'iconName', 'priority', 'members');

    const FOLDER_TYPE  = 'configuration';
    const OBJECT_TYPE  = 'relation';
    const CATEGORY     = 'tag';


    /**
     * Class constructor
     */
    public function __construct()
    {
    }

    /**
     * Initializes config object and dependencies
     */
    private function load()
    {
        // nothing to be done here
        if (isset($this->folders)) {
            return;
        }

        $this->folders = kolab_storage::get_folders(self::FOLDER_TYPE);

        foreach ($this->folders as $folder) {
            if ($folder->default) {
                $this->default = $folder;
                break;
            }
        }

        // if no folder is set as default, choose the first one
        if (!$this->default) {
            $this->default = reset($this->folders);
        }

        // check if configuration folder exist
        if ($this->default && $this->default->name) {
            $this->enabled = true;
        }
    }

    /**
     * Tags list
     *
     * @param array $filter Search filter
     *
     * @return array List of tags
     */
    public function list_tags($filter = array())
    {
        $this->load();

        $default  = true;
        $taglist  = array();
        $filter[] = array('type', '=', self::OBJECT_TYPE);

        foreach ($this->folders as $folder) {
            // we only want to read from default folder
            if ($default && !$folder->default) {
                continue;
            }

            foreach ($folder->select($filter) as $object) {
                if ($object['category'] == self::CATEGORY) {
                    // @TODO: we need uid, name, color and members only?
                    $taglist[] = $object;
                }
            }
        }

        return $taglist;
    }

    /**
     * Create tag object
     *
     * @param array $tag Tag data
     *
     * @return boolean|array Tag data on success, False on failure
     */
    public function create($tag)
    {
        $this->load();

        if (!$this->default) {
            return false;
        }

        $tag = array_intersect_key($tag, array_combine($this->tag_cols, $this->tag_cols));
        $tag['type']     = 'relation';
        $tag['category'] = self::CATEGORY;

        // Create the object
        $result = $this->default->save($tag, self::FOLDER_TYPE . '.' . self::OBJECT_TYPE);

        return $result ? $tag : false;
    }

    /**
     * Update tag object
     *
     * @param array $tag Tag data
     *
     * @return boolean|array Tag data on success, False on failure
     */
    public function update($tag)
    {
        // get tag object data, we need _mailbox
        $list    = $this->list_tags(array(array('uid', '=', $tag['uid'])));
        $old_tag = $list[0];

        if (!$old_tag) {
            return false;
        }

        $tag = array_intersect_key($tag, array_combine($this->tag_cols, $this->tag_cols));
        $tag = array_merge($old_tag, $tag);

        // find folder object
        foreach ($this->folders as $folder) {
            if ($folder->name == $tag['_mailbox']) {
                break;
            }
        }

        // Update the object
        $result = $folder->save($tag, self::FOLDER_TYPE . '.' . self::OBJECT_TYPE, $tag['uid']);

        return $result ? $tag : false;
    }

    /**
     * Remove tag object
     *
     * @param string $uid Object unique identifier
     *
     * @return boolean True on success, False on failure
     */
    public function remove($uid)
    {
        // get tag object data, we need _mailbox
        $list = $this->list_tags(array(array('uid', '=', $uid)));
        $tag  = $list[0];

        if (!$tag) {
            return false;
        }

        // find folder object
        foreach ($this->folders as $folder) {
            if ($folder->name == $tag['_mailbox']) {
                break;
            }
        }

        return $folder->delete($uid);
    }
}