8f5513066dce676ebe09e03437d31feb48f55033
[tine20] / tine20 / Tinebase / Record / Abstract.php
1 <?php
2 /**
3  * Tine 2.0
4  * 
5  * @package     Tinebase
6  * @subpackage  Record
7  * @license     http://www.gnu.org/licenses/agpl.html AGPL Version 3
8  * @copyright   Copyright (c) 2007-2013 Metaways Infosystems GmbH (http://www.metaways.de)
9  * @author      Cornelius Weiss <c.weiss@metaways.de>
10  */
11
12 /**
13  * Abstract implemetation of Tinebase_Record_Interface
14  * 
15  * @package     Tinebase
16  * @subpackage  Record
17  */
18 abstract class Tinebase_Record_Abstract implements Tinebase_Record_Interface
19 {
20     /**
21      * ISO8601LONG datetime representation
22      */
23     const ISO8601LONG = 'Y-m-d H:i:s';
24     
25     /**
26      * holds the configuration object (must be declared in the concrete class)
27      *
28      * @var Tinebase_ModelConfiguration
29      */
30     protected static $_configurationObject = NULL;
31
32     /**
33      * Holds the model configuration (must be assigned in the concrete class)
34      * 
35      * @var array
36      */
37     protected static $_modelConfiguration = NULL;
38
39     /**
40      * should datas be validated on the fly(false) or only on demand(true)
41      *
42      * @var bool
43      */
44     public $bypassFilters;
45     
46     /**
47      * should datetimeFields be converted from iso8601 (or optionally others {@see $this->dateConversionFormat}) strings to DateTime objects and back 
48      *
49      * @var bool
50      */
51     public $convertDates;
52     
53     /**
54      * differnet format than iso8601 to use for conversions 
55      *
56      * @var string
57      */
58     public $dateConversionFormat = NULL;
59     
60     /**
61      * key in $_validators/$_properties array for the field which 
62      * represents the identifier
63      * NOTE: _Must_ be set by the derived classes!
64      * 
65      * @var string
66      */
67     protected $_identifier = NULL;
68     
69     /**
70      * application the record belongs to
71      * NOTE: _Must_ be set by the derived classes!
72      *
73      * @var string
74      */
75     protected $_application = NULL;
76     
77     /**
78      * stores if values got modified after loaded via constructor
79      * 
80      * @var bool
81      */
82     protected $_isDirty = false;
83     
84     /**
85      * holds properties of record
86      * 
87      * @var array 
88      */
89     protected $_properties = array();
90     
91     /**
92      * this filter get used when validating user generated content with Zend_Input_Filter
93      *
94      * @var array list of zend inputfilter
95      */
96     protected $_filters = array();
97     
98     /**
99      * Defintion of properties. All properties of record _must_ be declared here!
100      * This validators get used when validating user generated content with Zend_Input_Filter
101      * NOTE: _Must_ be set by the derived classes!
102      * 
103      * @var array list of zend validator
104      */
105     protected $_validators = array();
106     
107     /**
108      * the validators place there validation errors in this variable
109      * 
110      * @var array list of validation errors
111      */
112     protected $_validationErrors = array();
113     
114     /**
115      * name of fields containing datetime or an array of datetime
116      * information
117      *
118      * @var array list of datetime fields
119      */
120     protected $_datetimeFields = array();
121     
122     /**
123      * alarm datetime field
124      *
125      * @var string
126      */
127     protected $_alarmDateTimeField = '';
128     
129     /**
130      * name of fields containing time information
131      *
132      * @var array list of time fields
133      */
134     protected $_timeFields = array();
135
136     /**
137      * name of fields that should be omited from modlog
138      *
139      * @var array list of modlog omit fields
140      */
141     protected $_modlogOmitFields = array();
142     
143     /**
144      * name of fields that should not be persisted during create/update in backend
145      *
146      * @var array
147      * 
148      * @todo think about checking the setting of readonly field and not allow it
149      */
150     protected $_readOnlyFields = array();
151     
152     /**
153      * save state if data are validated
154      *
155      * @var bool
156      */
157     protected $_isValidated = false;
158     
159     /**
160      * fields to translate when translate() function is called
161      *
162      * @var array
163      */
164     protected $_toTranslate = array();
165     
166     /**
167      * holds instance of Zend_Filters
168      *
169      * @var array
170      */
171     protected static $_inputFilters = array();
172     
173     /**
174      * If model is relatable and a special config should be applied, this is configured here
175      * @var array
176      */
177     protected static $_relatableConfig = NULL;
178
179     /**
180      * if foreign Id fields should be resolved on search and get from json
181      * should have this format: 
182      *     array('Calendar_Model_Contact' => 'contact_id', ...)
183      * or for more fields:
184      *     array('Calendar_Model_Contact' => array('contact_id', 'customer_id), ...)
185      * (e.g. resolves contact_id with the corresponding Model)
186      * 
187      * @var array
188      */
189     protected static $_resolveForeignIdFields = NULL;
190     
191     /**
192      * this property holds all field information for autoboot strapping
193      * if this is not null, these properties will be overridden in the abstract constructor:
194      *     - _filters
195      *     - _validators
196      *     - _dateTimeFields
197      *     - _alarmDateTimeField
198      *     - _timeFields
199      *     - _modlogOmitFields
200      *     - _readOnlyFields
201      *     - _resolveForeignIdFields
202      * @var array
203      */
204     protected static $_fields = NULL;
205     
206     /**
207      * right, user must have to see the module for this model
208      */
209     protected static $_requiredRight = NULL;
210     
211     /******************************** functions ****************************************/
212     
213     /**
214      * Default constructor
215      * Constructs an object and sets its record related properties.
216      * 
217      * @todo what happens if not all properties in the datas are set?
218      * The default values must also be set, even if no filtering is done!
219      * 
220      * @param mixed $_data
221      * @param bool $bypassFilters sets {@see this->bypassFilters}
222      * @param mixed $convertDates sets {@see $this->convertDates} and optionaly {@see $this->$dateConversionFormat}
223      * @return void
224      * @throws Tinebase_Exception_Record_DefinitionFailure
225      */
226     public function __construct($_data = NULL, $_bypassFilters = false, $_convertDates = true)
227     {
228         // apply configuration
229         $this->_setFromConfigurationObject();
230         
231         if ($this->_identifier === NULL) {
232             throw new Tinebase_Exception_Record_DefinitionFailure('$_identifier is not declared');
233         }
234         
235         $this->bypassFilters = (bool)$_bypassFilters;
236         $this->convertDates = (bool)$_convertDates;
237         if (is_string($_convertDates)) {
238             $this->dateConversionFormat = $_convertDates;
239         }
240
241         if ($this->has('description') && (! (isset($this->_filters['description']) || array_key_exists('description', $this->_filters)))) {
242             $this->_filters['description'] = new Tinebase_Model_InputFilter_CrlfConvert();
243         }
244
245         if (is_array($_data)) {
246             $this->setFromArray($_data);
247         }
248         
249         $this->_isDirty = false;
250     }
251     
252     /**
253      * returns the configuration object
254      *
255      * @return Tinebase_ModelConfiguration|NULL
256      */
257     public static function getConfiguration()
258     {
259         if (! isset (static::$_modelConfiguration)) {
260             return NULL;
261         }
262         
263         if (! static::$_configurationObject) {
264             static::$_configurationObject = new Tinebase_ModelConfiguration(static::$_modelConfiguration);
265         }
266     
267         return static::$_configurationObject;
268     }
269     
270     /**
271      * returns the relation config
272      * 
273      * @deprecated
274      * @return array
275      */
276     public static function getRelatableConfig()
277     {
278         return static::$_relatableConfig;
279     }
280     
281     /**
282      * recursivly clone properties
283      */
284     public function __clone()
285     {
286         foreach ($this->_properties as $name => $value)
287         {
288             if (is_object($value)) {
289                 $this->_properties[$name] = clone $value;
290             } else if (is_array($value)) {
291                 foreach ($value as $arrKey => $arrValue) {
292                     if (is_object($arrValue)) {
293                         $value[$arrKey] = clone $arrValue;
294                     }
295                 }
296             }
297         }
298     }
299     
300     /**
301      * sets identifier of record
302      * 
303      * @param int identifier
304      * @return void
305      */
306     public function setId($_id)
307     {
308         // set internal state to "not validated"
309         $this->_isValidated = false;
310         
311         if ($this->bypassFilters === true) {
312             $this->_properties[$this->_identifier] = $_id;
313         } else {
314             $this->__set($this->_identifier, $_id);
315         }
316     }
317     
318     /**
319      * gets identifier of record
320      * 
321      * @return int identifier
322      */
323     public function getId()
324     {
325         if (! isset($this->_properties[$this->_identifier])) {
326             $this->setId(NULL);
327         }
328         return $this->_properties[$this->_identifier];
329     }
330     
331     /**
332      * gets application the records belongs to
333      * 
334      * @return string application
335      */
336     public function getApplication()
337     {
338         return $this->_application;
339     }
340     
341     /**
342      * returns id property of this model
343      *
344      * @return string
345      */
346     public function getIdProperty()
347     {
348         return $this->_identifier;
349     }
350     
351     /**
352      * sets the record related properties from user generated input.
353      * 
354      * Input-filtering and validation by Zend_Filter_Input can enabled and disabled
355      *
356      * @param array $_data            the new data to set
357      * @throws Tinebase_Exception_Record_Validation when content contains invalid or missing data
358      * 
359      * @todo remove custom fields handling (use Tinebase_Record_RecordSet for them)
360      */
361     public function setFromArray(array $_data)
362     {
363         if ($this->convertDates === true) {
364             if (! is_string($this->dateConversionFormat)) {
365                 $this->_convertISO8601ToDateTime($_data);
366             } else {
367                 $this->_convertCustomDateToDateTime($_data, $this->dateConversionFormat);
368             }
369             
370             $this->_convertTime($_data);
371         }
372         
373         // set internal state to "not validated"
374         $this->_isValidated = false;
375
376         // get custom fields
377         if ($this->has('customfields')) {
378             $application = Tinebase_Application::getInstance()->getApplicationByName($this->_application);
379             $customFields = Tinebase_CustomField::getInstance()->getCustomFieldsForApplication($application, get_class($this))->name;
380             $recordCustomFields = array();
381         } else {
382             $customFields = array();
383         }
384         
385         // make sure we run through the setters
386         $bypassFilter = $this->bypassFilters;
387         $this->bypassFilters = true;
388         foreach ($_data as $key => $value) {
389             if ((isset($this->_validators[$key]) || array_key_exists ($key, $this->_validators))) {
390                 $this->$key = $value;
391             } else if (in_array($key, $customFields)) {
392                 $recordCustomFields[$key] = $value;
393             }
394         }
395         if (!empty($recordCustomFields)) {
396             $this->customfields = $recordCustomFields;
397         }
398         
399         $this->bypassFilters = $bypassFilter;
400         if ($this->bypassFilters !== true) {
401             $this->isValid(true);
402         }
403     }
404     
405     /**
406      * wrapper for setFromJason which expects datetimes in array to be in
407      * users timezone and converts them to UTC
408      *
409      * @todo move this to a generic __call interceptor setFrom<API>InUsersTimezone
410      * 
411      * @param  string $_data json encoded data
412      * @throws Tinebase_Exception_Record_Validation when content contains invalid or missing data
413      */
414     public function setFromJsonInUsersTimezone($_data)
415     {
416         // change timezone of current php process to usertimezone to let new dates be in the users timezone
417         // NOTE: this is neccessary as creating the dates in UTC and just adding/substracting the timeshift would
418         //       lead to incorrect results on DST transistions 
419         date_default_timezone_set(Tinebase_Core::get(Tinebase_Core::USERTIMEZONE));
420
421         // NOTE: setFromArray creates new Tinebase_DateTimes of $this->datetimeFields
422         $this->setFromJson($_data);
423         
424         // convert $this->_datetimeFields into the configured server's timezone (UTC)
425         $this->setTimezone('UTC');
426         
427         // finally reset timzone of current php process to the configured server timezone (UTC)
428         date_default_timezone_set('UTC');
429     }
430     
431     /**
432      * Sets timezone of $this->_datetimeFields
433      * 
434      * @see Tinebase_DateTime::setTimezone()
435      * @param  string $_timezone
436      * @param  bool   $_recursive
437      * @return  void
438      * @throws Tinebase_Exception_Record_Validation
439      */
440     public function setTimezone($_timezone, $_recursive = TRUE)
441     {
442         foreach ($this->_datetimeFields as $field) {
443             if (!isset($this->_properties[$field])) continue;
444             
445             if (!is_array($this->_properties[$field])) {
446                 $toConvert = array($this->_properties[$field]);
447             } else {
448                 $toConvert = $this->_properties[$field];
449             }
450
451             
452             foreach ($toConvert as $field => &$value) {
453                 
454                 if (! method_exists($value, 'setTimezone')) {
455                     throw new Tinebase_Exception_Record_Validation($field . 'must be a method setTimezone');
456                 } 
457                 $value->setTimezone($_timezone);
458             } 
459         }
460         
461         if ($_recursive) {
462             foreach ($this->_properties as $property => $value) {
463                 if ($value && is_object($value) && 
464                         (in_array('Tinebase_Record_Interface', class_implements($value)) || 
465                         $value instanceof Tinebase_Record_Recordset) ) {
466                        
467                     $value->setTimezone($_timezone, TRUE);
468                 }
469             }
470         }
471     }
472     
473     /**
474      * returns array of fields with validation errors 
475      *
476      * @return array
477      */
478     public function getValidationErrors()
479     {
480         return $this->_validationErrors;
481     }
482     
483     /**
484      * returns array with record related properties 
485      *
486      * @param boolean $_recursive
487      * @return array
488      */
489     public function toArray($_recursive = TRUE)
490     {
491         /*
492         foreach ($this->_properties as $key => $value) {
493             if ($value instanceof DateTime) {
494                 $date = new Tinebase_DateTime($value->get(Tinebase_Record_Abstract::ISO8601LONG));
495                 $date->setTimezone($value->getTimezone());
496                 $this->_properties[$key] = $date;
497             }
498         }
499         */
500         $recordArray = $this->_properties;
501         if ($this->convertDates === true) {
502             if (! is_string($this->dateConversionFormat)) {
503                 $this->_convertDateTimeToString($recordArray, Tinebase_Record_Abstract::ISO8601LONG);
504             } else {
505                 $this->_convertDateTimeToString($recordArray, $this->dateConversionFormat);
506             }
507         }
508         
509         if ($_recursive) {
510             foreach ($recordArray as $property => $value) {
511                 if ($this->_hasToArray($value)) {
512                     $recordArray[$property] = $value->toArray();
513                 }
514             }
515         }
516         
517         return $recordArray;
518     }
519     
520     /**
521      * checks if variable has toArray()
522      * 
523      * @param mixed $mixed
524      * @return boolean
525      */
526     protected function _hasToArray($mixed)
527     {
528         return is_object($mixed) && method_exists($mixed, 'toArray');
529     }
530     
531     /**
532      * validate and filter the the internal data
533      *
534      * @param $_throwExceptionOnInvalidData
535      * @return bool
536      * @throws Tinebase_Exception_Record_Validation
537      */
538     public function isValid($_throwExceptionOnInvalidData = false)
539     {
540         if ($this->_isValidated === true) {
541             return true;
542         }
543         
544         $inputFilter = $this->_getFilter()
545             ->setData($this->_properties);
546         
547         if ($inputFilter->isValid()) {
548             // set $this->_properties with the filtered values
549             $this->_properties  = $inputFilter->getUnescaped();
550             $this->_isValidated = true;
551             
552             return true;
553         }
554         
555         $this->_validationErrors = array();
556         
557         foreach ($inputFilter->getMessages() as $fieldName => $errorMessage) {
558             $this->_validationErrors[] = array(
559                 'id'  => $fieldName,
560                 'msg' => $errorMessage
561             );
562         }
563         
564         if ($_throwExceptionOnInvalidData) {
565             $e = new Tinebase_Exception_Record_Validation('Some fields ' . implode(',', array_keys($inputFilter->getMessages()))
566                 . ' have invalid content');
567             
568             if (Tinebase_Core::isLogLevel(Zend_Log::ERR)) Tinebase_Core::getLogger()->err(__METHOD__ . '::' . __LINE__ . " "
569                 . $e->getMessage()
570                 . print_r($this->_validationErrors, true));
571             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
572                 . ' Record: ' . print_r($this->toArray(), true));
573             
574             throw $e;
575         }
576         
577         return false;
578     }
579     
580     /**
581      * apply filter
582      *
583      * @todo implement
584      */
585     public function applyFilter()
586     {
587         $this->isValid(true);
588     }
589     
590     /**
591      * sets record related properties
592      * 
593      * @param string _name of property
594      * @param mixed _value of property
595      * @throws Tinebase_Exception_UnexpectedValue
596      * @return void
597      */
598     public function __set($_name, $_value)
599     {
600         if (! (isset($this->_validators[$_name]) || array_key_exists ($_name, $this->_validators))) {
601             throw new Tinebase_Exception_UnexpectedValue($_name . ' is no property of $this->_properties');
602         }
603         
604         if ($this->bypassFilters !== true) {
605             $this->_properties[$_name] = $this->_validateField($_name, $_value);
606         } else {
607             $this->_properties[$_name] = $_value;
608             
609             $this->_isValidated = false;
610         }
611         
612         $this->_isDirty = true;
613     }
614     
615     protected function _validateField($name, $value)
616     {
617         $inputFilter = $this->_getFilter($name);
618         $inputFilter->setData(array(
619             $name => $value
620         ));
621         
622         if ($inputFilter->isValid()) {
623             return $inputFilter->getUnescaped($name);
624         }
625         
626         $this->_validationErrors = array();
627         
628         foreach($inputFilter->getMessages() as $fieldName => $errorMessage) {
629             $this->_validationErrors[] = array(
630                 'id'  => $fieldName,
631                 'msg' => $errorMessage
632             );
633         }
634         
635         $e = new Tinebase_Exception_Record_Validation('the field ' . implode(',', array_keys($inputFilter->getMessages())) . ' has invalid content');
636         Tinebase_Core::getLogger()->err(__METHOD__ . '::' . __LINE__ . ":\n" .
637             print_r($this->_validationErrors,true). $e);
638         throw $e;
639     }
640     
641     /**
642      * unsets record related properties
643      * 
644      * @param string _name of property
645      * @throws Tinebase_Exception_UnexpectedValue
646      * @return void
647      */
648     public function __unset($_name)
649     {
650         if (!(isset($this->_validators[$_name]) || array_key_exists ($_name, $this->_validators))) {
651             throw new Tinebase_Exception_UnexpectedValue($_name . ' is no property of $this->_properties');
652         }
653
654         unset($this->_properties[$_name]);
655         
656         $this->_isValidated = false;
657         
658         if ($this->bypassFilters !== true) {
659             $this->isValid(true);
660         }
661     }
662     
663     /**
664      * checkes if an propertiy is set
665      * 
666      * @param string _name name of property
667      * @return bool property is set or not
668      */
669     public function __isset($_name)
670     {
671         return isset($this->_properties[$_name]);
672     }
673     
674     /**
675      * gets record related properties
676      * 
677      * @param  string  $name  name of property
678      * @return mixed value of property
679      */
680     public function __get($name)
681     {
682         return (isset($this->_properties[$name]) || array_key_exists($name, $this->_properties))
683             ? $this->_properties[$name] 
684             : NULL;
685     }
686     
687    /** convert this to string
688     *
689     * @return string
690     */
691     public function __toString()
692     {
693        return print_r($this->toArray(), TRUE);
694     }
695     
696     /**
697      * returns a Zend_Filter for the $_filters and $_validators of this record class.
698      * we just create an instance of Filter if we really need it.
699      * 
700      * @return Zend_Filter_Input
701      */
702     protected function _getFilter($field = null)
703     {
704         $keyName = get_class($this) . $field;
705         
706         if (! (isset(self::$_inputFilters[$keyName]) || array_key_exists($keyName, self::$_inputFilters))) {
707             if ($field !== null) {
708                 $filters    = (isset($this->_filters[$field]) || array_key_exists($field, $this->_filters)) ? array($field => $this->_filters[$field]) : array();
709                 $validators = array($field => $this->_validators[$field]); 
710                 
711                 self::$_inputFilters[$keyName] = new Zend_Filter_Input($filters, $validators);
712             } else {
713                 self::$_inputFilters[$keyName] = new Zend_Filter_Input($this->_filters, $this->_validators);
714             }
715         }
716         
717         return self::$_inputFilters[$keyName];
718     }
719     
720     /**
721      * Converts Tinebase_DateTimes into custom representation
722      *
723      * @param array &$_toConvert
724      * @param string $_format
725      * @return void
726      */
727     protected function _convertDateTimeToString(&$_toConvert, $_format)
728     {
729         //$_format = "Y-m-d H:i:s";
730         foreach ($_toConvert as $field => &$value) {
731             if (! $value) {
732                 if (in_array($field, $this->_datetimeFields)) {
733                     $_toConvert[$field] = NULL;
734                 }
735             } elseif ($value instanceof DateTime) {
736                 $_toConvert[$field] = $value->format($_format);
737             } elseif (is_array($value)) {
738                 $this->_convertDateTimeToString($value, $_format);
739             }
740         }
741     }
742     
743     /**
744      * Converts iso8601 formated dates into Tinebase_DateTime representation
745      * 
746      * NOTE: Instead of using the Tinebase_DateTime build in date creation from iso, we 
747      *       first convert the dates to UNIX timestamp by hand and create Tinebase_DateTimes
748      *       from this timestamp. This brings a 15 times performance boost
749      *
750      * @param array &$_data
751      * 
752      * @return void
753      */
754     protected function _convertISO8601ToDateTime(array &$_data)
755     {
756         foreach ($this->_datetimeFields as $field) {
757             if (!isset($_data[$field]) || $_data[$field] instanceof DateTime) continue;
758             
759             if (! is_array($_data[$field]) && strpos($_data[$field], ',') !== false) {
760                 $_data[$field] = explode(',', $_data[$field]);
761             }
762             
763             try {
764                 if (is_array($_data[$field])) {
765                     foreach($_data[$field] as $dataKey => $dataValue) {
766                         if ($dataValue instanceof DateTime) continue;
767                         $_data[$field][$dataKey] =  (int)$dataValue == 0 ? NULL : new Tinebase_DateTime($dataValue);
768                     }
769                 } else {
770                     $_data[$field] = (int)$_data[$field] == 0 ? NULL : new Tinebase_DateTime($_data[$field]);
771                     
772                 }
773             } catch (Tinebase_DateTime_Exception $zde) {
774                 Tinebase_Core::getLogger()->warn(__METHOD__ . '::' . __LINE__ . ' Error while converting date field "' . $field . '": ' . $zde->getMessage());
775                 $_data[$field] = NULL;
776             }
777         }
778         
779     }
780     
781     /**
782      * Converts custom formated dates into Tinebase_DateTime representation
783      *
784      * @param array &$_data
785      * @param string $_format {@see Tinebase_DateTime}
786      * 
787      * @return void
788      */
789     protected function _convertCustomDateToDateTime(array &$_data, $_format)
790     {
791         foreach ($this->_datetimeFields as $field) {
792             if (!isset($_data[$field]) || $_data[$field] instanceof DateTime) continue;
793             
794             if (strpos($_data[$field], ',') !== false) {
795                 $_data[$field] = explode(',', $_data[$field]);
796             }
797             
798             if (is_array($_data[$field])) {
799                 foreach($_data[$field] as $dataKey => $dataValue) {
800                     if ($dataValue instanceof DateTime) continue;
801                     $_data[$field][$dataKey] =  (int)$dataValue == 0 ? NULL : new Tinebase_DateTime($dataValue);
802                 }
803             } else {
804                 $_data[$field] = (int)$_data[$field] == 0 ? NULL : new Tinebase_DateTime($_data[$field]);
805             }
806         }
807     }
808     
809     /**
810      * cut the timezone-offset from the iso representation in order to force 
811      * Tinebase_DateTime to create dates in the user timezone. otherwise they will be 
812      * created with Etc/GMT+<offset> as timezone which would lead to incorrect 
813      * results in datetime computations!
814      * 
815      * @param  string Tinebase_DateTime::ISO8601 representation of a datetime filed
816      * @return string ISO8601LONG representation ('Y-m-d H:i:s')
817      */
818     protected function _convertISO8601ToISO8601LONG($_ISO)
819     {
820         $cutedISO = preg_replace('/[+\-]{1}\d{2}:\d{2}/', '', $_ISO);
821         $cutedISO = str_replace('T', ' ', $cutedISO);
822         
823         return $cutedISO;
824     }
825     
826     /**
827      * Converts time into iso representation (hh:mm:ss)
828      *
829      * @param array &$_data
830      * @return void
831      * 
832      * @todo    add support for hh:mm:ss AM|PM
833      */
834     protected function _convertTime(&$_data)
835     {
836         foreach ($this->_timeFields as $field) {
837             if (!isset($_data[$field]) || empty($_data[$field])) {
838                 continue;
839             }
840             
841             $hhmmss = explode(":", $_data[$field]);
842             if (count($hhmmss) === 2) {
843                 // seconds missing
844                 $hhmmss[] = '00';
845             }
846             list($hours, $minutes, $seconds) = $hhmmss;
847             if (preg_match('/AM|PM/', $minutes)) {
848                 list($minutes, $notation) = explode(" ", $minutes);
849                 switch($notation) {
850                     case 'AM':
851                         $hours = ($hours == '12') ? 0 : $hours;
852                         break;
853                     case 'PM':
854                         $hours = $hours + 12;
855                         break;
856                 }
857                 $_data[$field] = implode(':', $hhmmss);
858             }
859         }
860     }
861     
862     /**
863      * returns the default filter group for this model
864      * @return string
865      */
866     protected static function _getDefaultFilterGroup()
867     {
868         return get_called_class() . 'Filter';
869     }
870     
871     /**
872      * required by ArrayAccess interface
873      */
874     public function offsetExists($_offset)
875     {
876         return isset($this->_properties[$_offset]);
877     }
878     
879     /**
880      * required by ArrayAccess interface
881      */
882     public function offsetGet($_offset)
883     {
884         return $this->__get($_offset);
885     }
886     
887     /**
888      * required by ArrayAccess interface
889      */
890     public function offsetSet($_offset, $_value)
891     {
892         return $this->__set($_offset, $_value);
893     }
894     
895     /**
896      * required by ArrayAccess interface
897      * @throws Tinebase_Exception_Record_NotAllowed
898      */
899     public function offsetUnset($_offset)
900     {
901         throw new Tinebase_Exception_Record_NotAllowed('Unsetting of properties is not allowed');
902     }
903     
904     /**
905      * required by IteratorAggregate interface
906      */
907     public function getIterator()
908     {
909         return new ArrayIterator($this->_properties);
910     }
911     
912     /**
913      * returns a random 40-character hexadecimal number to be used as 
914      * universal identifier (UID)
915      * 
916      * @param int|optional $_length the length of the uid, defaults to 40
917      * @return string 40-character hexadecimal number
918      */
919     public static function generateUID($_length = false)
920     {
921         $uid = sha1(mt_rand(). microtime());
922         
923         if ($_length !== false) {
924             $uid = substr($uid, 0, $_length);
925         }
926         
927         return $uid;
928     }
929     
930     /**
931     * converts a int, string or Tinebase_Record_Interface to a id
932     *
933     * @param int|string|Tinebase_Record_Abstract $_id the id to convert
934     * @param string $_modelName
935     * @return int|string
936     */
937     public static function convertId($_id, $_modelName = 'Tinebase_Record_Abstract')
938     {
939         if ($_id instanceof $_modelName) {
940             if (! $_id->getId()) {
941                 throw new Tinebase_Exception_InvalidArgument('No id set!');
942             }
943             $id = $_id->getId();
944         } elseif (is_array($_id)) {
945             throw new Tinebase_Exception_InvalidArgument('Id can not be an array!');
946         } else {
947             $id = $_id;
948         }
949     
950         if ($id === 0) {
951             throw new Tinebase_Exception_InvalidArgument($_modelName . '.id can not be 0!');
952         }
953     
954         return $id;
955     }
956     
957     /**
958      * returns a Tinebase_Record_Diff record with differences to the given record
959      * 
960      * @param Tinebase_Record_Interface $_record record for comparison
961      * @param array $omitFields omit fields (for example modlog fields)
962      * @return Tinebase_Record_Diff|NULL
963      */
964     public function diff($_record, $omitFields = array())
965     {
966         if (! $_record instanceof Tinebase_Record_Abstract) {
967             return $_record;
968         }
969         
970         $result = new Tinebase_Record_Diff(array(
971             'id'     => $this->getId(),
972             'model'  => get_class($_record),
973         ));
974         $diff = array();
975         foreach (array_keys($this->_validators) as $fieldName) {
976             if (in_array($fieldName, $omitFields)) {
977                 continue;
978             }
979             
980             $ownField = $this->__get($fieldName);
981             $recordField = $_record->$fieldName;
982             
983             if (in_array($fieldName, $this->_datetimeFields)) {
984                 if ($ownField instanceof DateTime
985                     && $recordField instanceof DateTime) {
986                     if ($ownField->compare($recordField) === 0) {
987                         continue;
988                     } else {
989                         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . 
990                             ' datetime for field ' . $fieldName . ' is not equal: '
991                             . $ownField->getIso() . ' != '
992                             . $recordField->getIso()
993                         );
994                     } 
995                 } else if (! $recordField instanceof DateTime && $ownField == $recordField) {
996                     continue;
997                 } 
998             } else if ($fieldName == $this->_identifier && $this->getId() == $_record->getId()) {
999                 continue;
1000             } else if ($ownField instanceof Tinebase_Record_Abstract || $ownField instanceof Tinebase_Record_RecordSet) {
1001                 if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ . 
1002                     ' Doing subdiff for field ' . $fieldName);
1003                 $subdiff = $ownField->diff($recordField);
1004                 if (is_object($subdiff) && ! $subdiff->isEmpty()) {
1005                     $diff[$fieldName] = $subdiff;
1006                 }
1007                 continue;
1008             } else if ($recordField instanceof Tinebase_Record_Abstract && is_scalar($ownField)) {
1009                 // maybe we have the id of the record -> just compare the id
1010                 if ($recordField->getId() == $ownField) {
1011                     continue;
1012                 } else {
1013                     $recordField = $recordField->getId();
1014                 }
1015             } else if ($ownField == $recordField) {
1016                 continue;
1017             } else if (empty($ownField) && empty($recordField)) {
1018                 continue;
1019             }
1020             
1021             $diff[$fieldName] = $recordField;
1022         }
1023         
1024         $result->diff = $diff;
1025         return $result;
1026     }
1027     
1028     /**
1029      * merge given record into $this
1030      * 
1031      * @param Tinebase_Record_Interface $record
1032      * @return Tinebase_Record_Interface
1033      */
1034     public function merge($record)
1035     {
1036         if (! $this->getId()) {
1037             $this->setId($record->getId());
1038         }
1039         $diff = $this->diff($record);
1040         if ($diff === null || empty($diff->diff)) {
1041             return $this;
1042         }
1043         
1044         foreach ($diff->diff as $field => $value) {
1045             if (empty($this->{$field})) {
1046                 $this->{$field} = $value;
1047             }
1048         }
1049         
1050         return $this;
1051     }
1052     
1053     /**
1054      * check if data got modified
1055      * 
1056      * @return boolean
1057      */
1058     public function isDirty()
1059     {
1060         return $this->_isDirty;
1061     }
1062     
1063     /**
1064      * returns TRUE if given record obsoletes this one
1065      * 
1066      * @param  Tinebase_Record_Interface $_record
1067      * @return bool
1068      */
1069     public function isObsoletedBy($_record)
1070     {
1071         if (get_class($_record) !== get_class($this)) {
1072             throw new Tinebase_Exception_InvalidArgument('Records could not be compared');
1073         } else if ($this->getId() && $_record->getId() !== $this->getId()) {
1074             throw new Tinebase_Exception_InvalidArgument('Record id mismatch');
1075         }
1076         
1077         if ($this->has('seq') && $_record->seq != $this->seq) {
1078             return $_record->seq > $this->seq;
1079         }
1080         
1081         return ($this->has('last_modified_time')) ? $_record->last_modified_time > $this->last_modified_time : TRUE;
1082     }
1083     
1084     /**
1085      * check if two records are equal
1086      * 
1087      * @param  Tinebase_Record_Interface $_record record for comparism
1088      * @param  array                     $_toOmit fields to omit
1089      * @return bool
1090      */
1091     public function isEqual($_record, array $_toOmit = array())
1092     {
1093         $diff = $this->diff($_record);
1094         return ($diff) ? $diff->isEmpty($_toOmit) : FALSE;
1095     }
1096     
1097     /**
1098      * translate this records' fields
1099      *
1100      */
1101     public function translate()
1102     {
1103         // get translation object
1104         if (!empty($this->_toTranslate)) {
1105             $translate = Tinebase_Translation::getTranslation($this->_application);
1106             
1107             foreach ($this->_toTranslate as $field) {
1108                 $this->$field = $translate->_($this->$field);
1109             }
1110         }
1111     }
1112
1113     /**
1114      * check if the model has a specific field (container_id for example)
1115      *
1116      * @param string $_field
1117      * @return boolean
1118      */
1119     public function has($_field) 
1120     {
1121         return ((isset($this->_validators[$_field]) || array_key_exists ($_field, $this->_validators)));
1122     }   
1123
1124     /**
1125      * get fields
1126      * 
1127      * @return array
1128      */
1129     public function getFields()
1130     {
1131         return array_keys($this->_validators);
1132     }
1133     
1134     /**
1135      * fills a record from json data
1136      *
1137      * @param string $_data json encoded data
1138      * @return void
1139      * 
1140      * @todo replace this (and setFromJsonInUsersTimezone) with Tinebase_Convert_Json::toTine20Model
1141      * @todo move custom _setFromJson to (custom) converter
1142      */
1143     public function setFromJson($_data)
1144     {
1145         if (is_array($_data)) {
1146             $recordData = $_data;
1147         } else {
1148             $recordData = Zend_Json::decode($_data);
1149         }
1150         
1151         // sanitize container id if it is an array
1152         if ($this->has('container_id') && isset($recordData['container_id']) && is_array($recordData['container_id']) && isset($recordData['container_id']['id']) ) {
1153             $recordData['container_id'] = $recordData['container_id']['id'];
1154         }
1155         
1156         $this->_setFromJson($recordData);
1157         $this->setFromArray($recordData);
1158     }
1159     
1160     /**
1161      * can be reimplemented by subclasses to modify values during setFromJson
1162      * @param array $_data the json decoded values
1163      * @return void
1164      */
1165     protected function _setFromJson(array &$_data)
1166     {
1167         
1168     }
1169
1170     /**
1171      * returns modlog omit fields
1172      *
1173      * @return array
1174      */
1175     public function getModlogOmitFields()
1176     {
1177         return $this->_modlogOmitFields;
1178     }
1179
1180     /**
1181      * returns read only fields
1182      *
1183      * @return array
1184      */
1185     public function getReadOnlyFields()
1186     {
1187         return $this->_readOnlyFields;
1188     }
1189
1190     /**
1191      * sets the non static properties by the created configuration object on instantiation
1192      */
1193     protected function _setFromConfigurationObject()
1194     {
1195         // set protected, non static properties
1196         $co = static::getConfiguration();
1197         if ($co && $mc = $co->toArray()) {
1198             foreach ($mc as $property => $value) {
1199                 $this->{$property} = $value;
1200             }
1201         }
1202     }
1203
1204     /**
1205      * returns the title of the record
1206      * 
1207      * @return string
1208      */
1209     public function getTitle()
1210     {
1211         $c = static::getConfiguration();
1212         
1213         // TODO: fallback, remove if all models use modelconfiguration
1214         if (! $c) {
1215             return $this->title;
1216         }
1217         
1218         // use vsprintf formatting if it is an array
1219         if (is_array($c->titleProperty)) {
1220             if (! is_array($c->titleProperty[1])) {
1221                 $propertyValues = array($this->{$c->titleProperty[1]});
1222             } else {
1223                 $propertyValues = array();
1224                 foreach($c->titleProperty[1] as $property) {
1225                     $propertyValues[] = $this->{$property};
1226                 }
1227             }
1228             return vsprintf($c->titleProperty[0], $propertyValues);
1229         } else {
1230             return $this->{$c->titleProperty};
1231         }
1232     }
1233     
1234     /**
1235      * returns the foreignId fields (used in Tinebase_Convert_Json)
1236      * @return array
1237      */
1238     public static function getResolveForeignIdFields()
1239     {
1240         return static::$_resolveForeignIdFields;
1241     }
1242     
1243     /**
1244      * returns all textfields having labels for the autocomplete field function
1245      * 
1246      * @return array
1247      */
1248     public static function getAutocompleteFields()
1249     {
1250         $keys = array();
1251         
1252         foreach (self::getConfiguration()->getFields() as $key => $fieldDef) {
1253             if ($fieldDef['type'] == 'string' || $fieldDef['type'] == 'text') {
1254                 $keys[] = $key;
1255             }
1256         }
1257         
1258         return $keys;
1259     }
1260 }