-
Notifications
You must be signed in to change notification settings - Fork 127
/
Base.php
247 lines (231 loc) · 7.48 KB
/
Base.php
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
<?php
/**
* Copyright 2004-2017 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Storage
* @author Gunnar Wrobel <wrobel@pardus.de>
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
*/
/**
* The basis for Kolab storage access.
*
* @category Kolab
* @package Kolab_Storage
* @author Gunnar Wrobel <wrobel@pardus.de>
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
*/
abstract class Horde_Kolab_Storage_Base
implements Horde_Kolab_Storage
{
/**
* The master Kolab storage system.
*
* @var Horde_Kolab_Storage_Driver
*/
protected $_master;
/**
* The query handler.
*
* @var Horde_Kolab_Storage_QuerySet
*/
protected $_query_set;
/**
* The factory for generating additional resources.
*
* @var Horde_Kolab_Storage_Factory
*/
protected $_factory;
/**
* The cache.
*
* @var Horde_Kolab_Storage_Cache
*/
protected $_cache;
/**
* A logger.
*
* @var Horde_Log_Logger
*/
protected $_logger;
/**
* Additional parameters.
*
* @var array
*/
protected $_params;
/**
* List instances.
*
* @var array
*/
protected $_lists;
/**
* Data instances.
*
* @var array
*/
protected $_data;
/**
* Constructor.
*
* @param Horde_Kolab_Storage_Driver $master The primary connection
* driver.
* @param Horde_Kolab_Storage_QuerySet $query_set The query handler.
* @param Horde_Kolab_Storage_Factory $factory The factory.
* @param Horde_Kolab_Storage_Cache $cache The cache.
* @param Horde_Log_Logger $logger A logger.
* @param array $params Additional parameters.
*/
public function __construct(Horde_Kolab_Storage_Driver $master,
Horde_Kolab_Storage_QuerySet $query_set,
Horde_Kolab_Storage_Factory $factory,
Horde_Kolab_Storage_Cache $cache,
$logger,
array $params = array())
{
$this->_master = $master;
$this->_query_set = $query_set;
$this->_factory = $factory;
$this->_cache = $cache;
$this->_logger = $logger;
$this->_params = $params;
}
/**
* Get a folder list object for a "system" user.
*
* @param string $type The type of system user.
*
* @return Horde_Kolab_Storage_List_Tools The handler for the list of
* folders present in the Kolab
* backend.
*/
public function getSystemList($type)
{
if (!isset($this->_params['system'][$type])) {
if (!isset($this->_params['system'][''])) {
throw new Horde_Kolab_Storage_Exception(
'No system users are available!'
);
} else {
$params = $this->_params['system'][''];
}
} else {
$params = $this->_params['system'][$type];
}
return $this->getList(
$this->_factory->createDriver(array('params' => $params))
);
}
/**
* Get the folder list object.
*
* @params Horde_Kolab_Storage_Driver $driver Optional driver as backend
* for the list.
*
* @return Horde_Kolab_Storage_List_Tools The handler for the list of
* folders present in the Kolab
* backend.
*/
public function getList(Horde_Kolab_Storage_Driver $driver = null)
{
if ($driver === null) {
$driver = $this->_master;
}
if (!isset($this->_lists[$driver->getId()])) {
$this->_lists[$driver->getId()] = new Horde_Kolab_Storage_List_Tools(
$driver, $this->_cache, $this->_logger, $this->_params
);
}
return $this->_lists[$driver->getId()];
}
/**
* Get a Folder object.
*
* @param string $folder The folder name.
*
* @return Horde_Kolab_Storage_Folder The Kolab folder object.
*/
public function getFolder($folder)
{
return new Horde_Kolab_Storage_Folder_Base(
$this->getList()->getQuery(
Horde_Kolab_Storage_List_Tools::QUERY_BASE
),
$folder
);
}
/**
* Return a data handler for accessing data in the specified folder.
*
* @param mixed $folder The name of the folder or an instance
* representing the folder.
* @param string $object_type The type of data we want to access in the
* folder.
* @param int $data_version Format version of the object data.
*
* @return Horde_Kolab_Storage_Data The data object.
*/
public function getData($folder, $object_type = null, $data_version = 1)
{
if ($folder instanceof Horde_Kolab_Storage_Folder) {
$folder_key = $folder->getPath();
} else {
$folder_key = $folder;
}
$key = join(
'@',
array(
$data_version,
$object_type,
$folder_key,
$this->_master->getId()
)
);
if (!isset($this->_data[$key])) {
if (!$folder instanceof Horde_Kolab_Storage_Folder) {
$folder = $this->getFolder($folder);
}
$this->_data[$key] = $this->_createData(
$folder,
$this->_master,
$this->_factory,
$object_type,
$data_version
);
if (isset($this->_params['logger'])) {
$this->_data[$key] = new Horde_Kolab_Storage_Data_Decorator_Log(
$this->_data[$key], $this->_params['logger']
);
}
$this->_query_set->addDataQuerySet($this->_data[$key]);
}
return $this->_data[$key];
}
/**
* Return a data handler for accessing data in the specified folder.
*
* @param mixed $folder The name of the folder or
* an instance representing
* the folder.
* @param Horde_Kolab_Storage_Driver $master The primary connection
* driver.
* @param Horde_Kolab_Storage_Factory $factory The factory.
* @param string $object_type The type of data we want
* to access in the folder.
* @param int $data_version Format version of the
* object data.
*
* @return Horde_Kolab_Data The data object.
*/
abstract protected function _createData(
$folder,
Horde_Kolab_Storage_Driver $master,
Horde_Kolab_Storage_Factory $factory,
$object_type = null,
$data_version = 1
);
}