summaryrefslogtreecommitdiff
path: root/lib/Kolab/CalDAV/Schedule/Inbox.php
blob: 54970d5a34db65839dc113db0e731c5f17254fd4 (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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
<?php

/**
 * CalDAV scheduling inbox for the Kolab.
 *
 * @author Thomas Bruederli <bruederli@kolabsys.com>
 *
 * Copyright (C) 2013, 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/>.
 */

namespace Kolab\CalDAV\Schedule;

use Sabre\DAV;
use Sabre\CalDAV;
use Sabre\DAVACL;

/**
 * The CalDAV scheduling inbox
 */
class Inbox extends DAV\Collection implements DAV\ICollection, DAVACL\IACL
{
    /**
     * The principal Uri
     *
     * @var string
     */
    protected $principalUri;

    protected $principalId;

    /**
     * CalDAV backend
     *
     * @var Sabre\CalDAV\Backend\BackendInterface
     */
    protected $caldavBackend;

    /**
     * Constructor
     *
     * @param string $principalUri
     */
    public function __construct(CalDAV\Backend\BackendInterface $caldavBackend, $principalUri)
    {
        $this->caldavBackend = $caldavBackend;

        $principal = explode('/', $principalUri);
        $this->principalId = end($principal);
        $this->principalUri = $principalUri;

        $this->calendarInfo = array(
            'id' => 'inbox',
            'principaluri' => $principalUri,
        );
    }

    /**
     * Provide the URL for the default calendar for event scheduling
     */
    public function schedule_default_calendar_url()
    {
        if ($cal = $this->caldavBackend->get_default_calendar()) {
            return $this->principalId . '/' . $cal['uri'];
        }

        return false;
    }

    /**
     * Returns the name of the node.
     *
     * This is used to generate the url.
     *
     * @return string
     */
    public function getName()
    {
        console(__METHOD__);
        return 'inbox';
    }

    /**
     * Returns an array with all the child nodes
     *
     * @return \Sabre\DAV\INode[]
     */
    public function getChildren()
    {
        console(__METHOD__);

        $children = array();
        $objs = $this->caldavBackend->getSchedulingInboxObjects();
        foreach ($objs as $obj) {
            $children[] = new CalDAV\CalendarObject($this->caldavBackend, $this->calendarInfo, $obj);
        }

        return $children;
    }

    /**
     * Returns a child object, by its name.
     *
     * @param string $name
     * @throws Exception\NotFound
     * @return INode
     */
    public function getChild($name)
    {
        console(__METHOD__, $name);

        // TODO: improve this
        $objs = $this->caldavBackend->getSchedulingInboxObjects();
        foreach ($objs as $obj) {
            if ($obj['uri'] == $name) {
                return new CalDAV\CalendarObject($this->caldavBackend, $this->calendarInfo, $obj);
            }
        }

        throw new DAV\Exception\NotFound('File not found: ' . $name);
    }

    /**
     * Checks is a child-node exists.
     *
     * @param string $name
     * @return bool
     */
    public function childExists($name)
    {
        console(__METHOD__, $name);

        // TODO: improve this
        $objs = $this->caldavBackend->getSchedulingInboxObjects();
        foreach ($objs as $obj) {
            if ($obj['uri'] == $name) {
                return true;
            }
        }

        return false;
    }

    /**
     * Returns the owner principal
     *
     * This must be a url to a principal, or null if there's no owner
     *
     * @return string|null
     */
    public function getOwner()
    {
        return $this->principalUri;
    }

    /**
     * Returns a group principal
     *
     * This must be a url to a principal, or null if there's no owner
     *
     * @return string|null
     */
    public function getGroup()
    {
        return null;
    }

    /**
     * Returns a list of ACE's for this node.
     *
     * Each ACE has the following properties:
     *   * 'privilege', a string such as {DAV:}read or {DAV:}write. These are
     *     currently the only supported privileges
     *   * 'principal', a url to the principal who owns the node
     *   * 'protected' (optional), indicating that this ACE is not allowed to
     *      be updated.
     *
     * @return array
     */
    public function getACL() {

        return array(
            array(
                'privilege' => '{' . CalDAV\Plugin::NS_CALDAV . '}schedule-deliver-invite',
                'principal' => $this->getOwner(),
                'protected' => true,
            ),
            array(
                'privilege' => '{' . CalDAV\Plugin::NS_CALDAV . '}schedule-deliver-reply',
                'principal' => $this->getOwner(),
                'protected' => true,
            ),
            array(
                'privilege' => '{DAV:}read',
                'principal' => $this->getOwner(),
                'protected' => true,
            ),
            array(
                'privilege' => '{DAV:}unbind',
                'principal' => $this->getOwner(),
                'protected' => true,
            ),
        );
    }

    /**
     * Updates the ACL
     *
     * This method will receive a list of new ACE's.
     *
     * @param array $acl
     * @return void
     */
    public function setACL(array $acl)
    {
        throw new DAV\Exception\MethodNotAllowed('You\'re not allowed to update the ACL');
    }

    /**
     * Returns the list of supported privileges for this node.
     *
     * The returned data structure is a list of nested privileges.
     * See Sabre\DAVACL\Plugin::getDefaultSupportedPrivilegeSet for a simple
     * standard structure.
     *
     * If null is returned from this method, the default privilege set is used,
     * which is fine for most common usecases.
     *
     * @return array|null
     */
    public function getSupportedPrivilegeSet()
    {
        $default = DAVACL\Plugin::getDefaultSupportedPrivilegeSet();

        $default['aggregates'][] = array(
            'privilege' => '{' . CalDAV\Plugin::NS_CALDAV . '}schedule-deliver-invite',
        );
        $default['aggregates'][] = array(
            'privilege' => '{' . CalDAV\Plugin::NS_CALDAV . '}schedule-deliver-reply',
        );

        return $default;
    }

}