summaryrefslogtreecommitdiff
path: root/lib/Kolab/FreeBusy/Directory.php
blob: 1c70f7501d0a14e329307317a1a0a9b4253435e5 (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
<?php

/**
 * This file is part of the Kolab Server Free/Busy Service
 *
 * @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\FreeBusy;

/**
 * Abstract class representing an address directory for free/busy data lookups
 */
abstract class Directory
{
	protected $config;

	/**
	 * Factory method creating an instace of Directory according to config
	 *
	 * @param array Hash array with config
	 */
	public static function factory($config)
	{
		switch (strtolower($config['type'])) {
			case 'ldap':
				return new DirectoryLDAP($config);

			case 'static':
			case 'external':
				return new DirectoryStatic($config);

			default:
				Logger::get('directory')->addError("Invalid directory type '" . $config['type'] . "'!");
		}

		return null;
	}

	/**
	 * Resolve the given username to a Entity object
	 *
	 * @param string Username/Email to resolve
	 * @return object Entity if found, otherwise False
	 */
	abstract public function resolve($user);

	/**
	 * Retrieve free/busy data for the given user.
	 *
	 * @param string Username or email to resolve
	 * @param boolean Get extemded free-busy if possible
	 * @return string VCalendar container if found, False otherwise
	 */
	public function getFreeBusyData($user, $extended = false)
	{
		// resolve user record first
		if ($user = $this->resolve($user)) {
			$fbsource = $this->config['fbsource'];
			if ($source = Source::Factory($fbsource)) {
				// forward request to Source instance
				if ($data = $source->getFreeBusyData($this->postprocessAttrib($user), $extended)) {
					// send data through the according format converter
					$converter = Format::factory($this->config['format']);
					$data = $converter->toVCalendar($data);
				}

				return $data;
			}
		}

		return false;
	}

	/**
	 * Modify attribute values according to config
	 */
	protected function postprocessAttrib($attrib)
	{
		if (!empty($this->config['lc_attributes'])) {
			foreach ((array)$this->config['lc_attributes'] as $key) {
				if (!empty($attrib[$key]))
					$attrib[$key] = strtolower($attrib[$key]);
			}
		}

		return $attrib;
	}

}