summaryrefslogtreecommitdiff
path: root/lib/ext/Syncroton/Registry.php
blob: 5460f96dccbcfd91e329c396d2a423ecd94e1af7 (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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
<?php
/**
 * Zend Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://framework.zend.com/license/new-bsd
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@zend.com so we can send you a copy immediately.
 *
 * @package    Syncroton
 * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 * @version    $Id: Registry.php 10020 2009-08-18 14:34:09Z j.fischer@metaways.de $
 */

/**
 * Generic storage class helps to manage global data.
 *
 * @package    Syncroton
 * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Syncroton_Registry extends ArrayObject
{
    const CALENDAR_DATA_CLASS = 'calendar_data_class';
    const CONTACTS_DATA_CLASS = 'contacts_data_class';
    const EMAIL_DATA_CLASS    = 'email_data_class';
    const NOTES_DATA_CLASS    = 'notes_data_class';
    const TASKS_DATA_CLASS    = 'tasks_data_class';
    const GAL_DATA_CLASS      = 'gal_data_class';
    
    const DEFAULT_POLICY      = 'default_policy';
    const PING_TIMEOUT        = 'ping_timeout';
    const QUIET_TIME          = 'quiet_time';
    
    const DATABASE            = 'database';
    const TRANSACTIONMANAGER  = 'transactionmanager';
    
    const CONTENTSTATEBACKEND = 'contentstatebackend';
    const DEVICEBACKEND       = 'devicebackend';
    const FOLDERBACKEND       = 'folderbackend';
    const POLICYBACKEND       = 'policybackend';
    const SYNCSTATEBACKEND    = 'syncstatebackend';
    
    /**
     * Class name of the singleton registry object.
     * @var string
     */
    private static $_registryClassName = 'Syncroton_Registry';

    /**
     * Registry object provides storage for shared objects.
     * @var Syncroton_Registry
     */
    private static $_registry = null;

    /**
     * Retrieves the default registry instance.
     *
     * @return Syncroton_Registry
     */
    public static function getInstance()
    {
        if (self::$_registry === null) {
            self::init();
        }

        return self::$_registry;
    }

    /**
     * @return Zend_Db_Adapter_Abstract
     */
    public static function getDatabase()
    {
        return self::get(self::DATABASE);
    }
    
    /**
     * return transaction manager class 
     * 
     * @return Syncroton_TransactionManagerInterface
     */
    public static function getTransactionManager()
    {
        if (!self::isRegistered(self::TRANSACTIONMANAGER)) {
            self::set(self::TRANSACTIONMANAGER, Syncroton_TransactionManager::getInstance());
        }
        
        return self::get(self::TRANSACTIONMANAGER);
    } 
    
    /**
     * Set the default registry instance to a specified instance.
     *
     * @param Syncroton_Registry $registry An object instance of type Syncroton_Registry,
     *   or a subclass.
     * @return void
     * @throws Zend_Exception if registry is already initialized.
     */
    public static function setInstance(Syncroton_Registry $registry)
    {
        if (self::$_registry !== null) {
            require_once 'Zend/Exception.php';
            throw new Zend_Exception('Registry is already initialized');
        }

        self::setClassName(get_class($registry));
        self::$_registry = $registry;
    }

    /**
     * Initialize the default registry instance.
     *
     * @return void
     */
    protected static function init()
    {
        self::setInstance(new self::$_registryClassName());
    }

    /**
     * Set the class name to use for the default registry instance.
     * Does not affect the currently initialized instance, it only applies
     * for the next time you instantiate.
     *
     * @param string $registryClassName
     * @return void
     * @throws Zend_Exception if the registry is initialized or if the
     *   class name is not valid.
     */
    public static function setClassName($registryClassName = 'Syncroton_Registry')
    {
        if (self::$_registry !== null) {
            require_once 'Zend/Exception.php';
            throw new Zend_Exception('Registry is already initialized');
        }

        if (!is_string($registryClassName)) {
            require_once 'Zend/Exception.php';
            throw new Zend_Exception("Argument is not a class name");
        }

        /**
         * @see Zend_Loader
         */
        if (!class_exists($registryClassName)) {
            require_once 'Zend/Loader.php';
            Zend_Loader::loadClass($registryClassName);
        }

        self::$_registryClassName = $registryClassName;
    }

    /**
     * Unset the default registry instance.
     * Primarily used in tearDown() in unit tests.
     * @returns void
     */
    public static function _unsetInstance()
    {
        self::$_registry = null;
    }

    /**
     * getter method, basically same as offsetGet().
     *
     * This method can be called from an object of type Syncroton_Registry, or it
     * can be called statically.  In the latter case, it uses the default
     * static instance stored in the class.
     *
     * @param string $index - get the value associated with $index
     * @return mixed
     * @throws Zend_Exception if no entry is registerd for $index.
     */
    public static function get($index)
    {
        $instance = self::getInstance();

        if (!$instance->offsetExists($index)) {
            require_once 'Zend/Exception.php';
            throw new Zend_Exception("No entry is registered for key '$index'");
        }

        return $instance->offsetGet($index);
    }
    
    /**
     * returns content state backend
     * 
     * creates Syncroton_Backend_Content on the fly if not before via
     * Syncroton_Registry::set(self::CONTENTSTATEBACKEND, $backend);
     * 
     * @return Syncroton_Backend_IContent
     */
    public static function getContentStateBackend()
    {
        if (!self::isRegistered(self::CONTENTSTATEBACKEND)) {
            self::set(self::CONTENTSTATEBACKEND, new Syncroton_Backend_Content(self::getDatabase()));
        }
        
        return self::get(self::CONTENTSTATEBACKEND);
    }

    /**
     * returns device backend
     * 
     * creates Syncroton_Backend_Device on the fly if not before via
     * Syncroton_Registry::set(self::DEVICEBACKEND, $backend);
     * 
     * @return Syncroton_Backend_IDevice
     */
    public static function getDeviceBackend()
    {
        if (!self::isRegistered(self::DEVICEBACKEND)) {
            self::set(self::DEVICEBACKEND, new Syncroton_Backend_Device(self::getDatabase()));
        }
        
        return self::get(self::DEVICEBACKEND);
    }

    /**
     * returns folder backend
     * 
     * creates Syncroton_Backend_Folder on the fly if not before via
     * Syncroton_Registry::set(self::FOLDERBACKEND, $backend);
     * 
     * @return Syncroton_Backend_IFolder
     */
    public static function getFolderBackend()
    {
        if (!self::isRegistered(self::FOLDERBACKEND)) {
            self::set(self::FOLDERBACKEND, new Syncroton_Backend_Folder(self::getDatabase()));
        }
        
        return self::get(self::FOLDERBACKEND);
    }

    /**
     * return ping timeout 
     * 
     * sleep "ping timeout" seconds between folder checks in Ping and Sync command 
     * 
     * @return int
     */
    public static function getPingTimeout()
    {
        if (!self::isRegistered(self::PING_TIMEOUT)) {
            return 60;
        }
        
        return self::get(self::PING_TIMEOUT);
    }
    
    /**
     * returns policy backend
     * 
     * creates Syncroton_Backend_Policy on the fly if not set before via
     * Syncroton_Registry::set(self::POLICYBACKEND, $backend);
     * 
     * @return Syncroton_Backend_ISyncState
     */
    public static function getPolicyBackend()
    {
        if (!self::isRegistered(self::POLICYBACKEND)) {
            self::set(self::POLICYBACKEND, new Syncroton_Backend_Policy(self::getDatabase()));
        }
        
        return self::get(self::POLICYBACKEND);
    }

    /**
     * return quiet time 
     * 
     * don't check folders if last sync was "quiet time" seconds ago 
     * 
     * @return int
     */
    public static function getQuietTime()
    {
        if (!self::isRegistered(self::QUIET_TIME)) {
            return 180;
        }
        
        return self::get(self::QUIET_TIME);
    }
    
    /**
     * returns syncstate backend
     * 
     * creates Syncroton_Backend_SyncState on the fly if not before via
     * Syncroton_Registry::set(self::SYNCSTATEBACKEND, $backend);
     * 
     * @return Syncroton_Backend_ISyncState
     */
    public static function getSyncStateBackend()
    {
        if (!self::isRegistered(self::SYNCSTATEBACKEND)) {
            self::set(self::SYNCSTATEBACKEND, new Syncroton_Backend_SyncState(self::getDatabase()));
        }
        
        return self::get(self::SYNCSTATEBACKEND);
    }

    /**
     * setter method, basically same as offsetSet().
     *
     * This method can be called from an object of type Syncroton_Registry, or it
     * can be called statically.  In the latter case, it uses the default
     * static instance stored in the class.
     *
     * @param string $index The location in the ArrayObject in which to store
     *   the value.
     * @param mixed $value The object to store in the ArrayObject.
     * @return void
     */
    public static function set($index, $value)
    {
        $instance = self::getInstance();
        $instance->offsetSet($index, $value);
    }

    public static function setDatabase(Zend_Db_Adapter_Abstract $db)
    {
        self::set(self::DATABASE, $db);
    }
    
    public static function setCalendarDataClass($className)
    {
        if (!class_exists($className)) {
            throw new InvalidArgumentException('invalid $_className provided');
        }
    
        self::set(self::CALENDAR_DATA_CLASS, $className);
    }
    
    public static function setContactsDataClass($className)
    {
        if (!class_exists($className)) {
            throw new InvalidArgumentException('invalid $_className provided');
        }
    
        self::set(self::CONTACTS_DATA_CLASS, $className);
    }
    
    public static function setEmailDataClass($className)
    {
        if (!class_exists($className)) {
            throw new InvalidArgumentException('invalid $_className provided');
        }
    
        self::set(self::EMAIL_DATA_CLASS, $className);
    }
    
    public static function setNotesDataClass($className)
    {
        if (!class_exists($className)) {
            throw new InvalidArgumentException('invalid $_className provided');
        }

        self::set(self::NOTES_DATA_CLASS, $className);
    }

    public static function setTasksDataClass($className)
    {
        if (!class_exists($className)) {
            throw new InvalidArgumentException('invalid $_className provided');
        }
    
        self::set(self::TASKS_DATA_CLASS, $className);
    }

    public static function setGALDataClass($className)
    {
        if (!class_exists($className)) {
            throw new InvalidArgumentException('invalid $_className provided');
        }

        self::set(self::GAL_DATA_CLASS, $className);
    }

    public static function setTransactionManager($manager)
    {
        self::set(self::TRANSACTIONMANAGER, $manager);
    }
    
    /**
     * Returns TRUE if the $index is a named value in the registry,
     * or FALSE if $index was not found in the registry.
     *
     * @param  string $index
     * @return boolean
     */
    public static function isRegistered($index)
    {
        if (self::$_registry === null) {
            return false;
        }
        return self::$_registry->offsetExists($index);
    }

    /**
     * Constructs a parent ArrayObject with default
     * ARRAY_AS_PROPS to allow acces as an object
     *
     * @param array $array data array
     * @param integer $flags ArrayObject flags
     */
    public function __construct($array = array(), $flags = parent::ARRAY_AS_PROPS)
    {
        parent::__construct($array, $flags);
    }

    /**
     * @param string $index
     * @returns mixed
     *
     * Workaround for http://bugs.php.net/bug.php?id=40442 (ZF-960).
     */
    public function offsetExists($index)
    {
        return array_key_exists($index, $this);
    }

}