summaryrefslogtreecommitdiff
path: root/lib/Kolab/Utils/DAVBackend.php
blob: d772eb8a4d17fa69f7b49c9bf5359ef622a951d2 (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
<?php

/**
 * Utility class prividing a simple API to PHP's APC cache
 *
 * @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\Utils;

use \kolab_storage;
use \rcube_utils;

/**
 *
 */
class DAVBackend
{
    const IMAP_UID_KEY = '/shared/vendor/kolab/dav-uid';
    const IMAP_UID_KEY_PRIVATE = '/private/vendor/kolab/dav-uid';
    const IMAP_UID_KEY_CYRUS = '/shared/vendor/cmu/cyrus-imapd/uniqueid';

    /**
     * Getter for a kolab_storage_folder with the given UID
     *
     * @param string  Folder UID (saved in annotation)
     * @param string  Kolab folder type (for selecting candidates)
     * @return object \kolab_storage_folder instance
     */
    public static function get_storage_folder($uid, $type)
    {
        foreach (kolab_storage::get_folders($type) as $folder) {
            if (self::get_uid($folder) == $uid)
                return $folder;
        }

        return null;
    }

    /**
     * Helper method to extract folder UID metadata
     *
     * @param object \kolab_storage_folder Folder to get UID for
     * @return string Folder's UID
     */
    public static function get_uid($folder)
    {
        // color is defined in folder METADATA
        $metakeys = array(self::IMAP_UID_KEY_CYRUS, self::IMAP_UID_KEY, self::IMAP_UID_KEY_PRIVATE);
        $metadata = $folder->get_metadata($metakeys);
        foreach ($metakeys as $key) {
            if (($uid = $metadata[$key])) {
                return $uid;
            }
        }

        // generate a folder UID and set it to IMAP
        $uid = rtrim(chunk_split(md5($folder->name), 12, '-'), '-');
        self::set_uid($folder, $uid);

        return $uid;
    }

    /**
     * Helper method to set an UID value to the given IMAP folder instance
     *
     * @param object \kolab_storage_folder Folder to set UID
     * @param string Folder's UID
     * @return boolean True on succes, False on failure
     */
    public static function set_uid($folder, $uid)
    {
        if (!($success = $folder->set_metadata(array(self::IMAP_UID_KEY => $uid)))) {
            $success = $folder->set_metadata(array(self::IMAP_UID_KEY_PRIVATE => $uid));
        }
        return $success;
    }

    /**
     * Build an absolute URL with the given parameters
     */
    public static function abs_url($parts = array())
    {
        $schema = 'http';
        $default_port = 80;
        if (rcube_utils::https_check()) {
            $schema = 'https';
            $default_port = 443;
        }
        $url = $schema . '://' . $_SERVER['HTTP_HOST'];

        if ($_SERVER['SERVER_PORT'] != $default_port)
            $url .= ':' . $_SERVER['SERVER_PORT'];

        if (dirname($_SERVER['SCRIPT_NAME']) != '/')
            $url .= dirname($_SERVER['SCRIPT_NAME']);

        $url .= '/' . join('/', array_map('urlencode', $parts));

        return $url;
    }

}