Merge branch '2013.03'
[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') && (! 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 (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          
443         foreach ($this->_datetimeFields as $field) {
444             if (!isset($this->_properties[$field])) continue;
445             
446             if (!is_array($this->_properties[$field])) {
447                 $toConvert = array($this->_properties[$field]);
448             } else {
449                 $toConvert = $this->_properties[$field];
450             }
451
452             
453             foreach ($toConvert as $field => &$value) {
454                 
455                 if (! method_exists($value, 'setTimezone')) {
456                     throw new Tinebase_Exception_Record_Validation($field . 'must be a method setTimezone');
457                 } 
458                 $value->setTimezone($_timezone);
459             } 
460         }
461         
462         if ($_recursive) {
463             foreach ($this->_properties as $property => $value) {
464                 if (is_object($value) && 
465                         (in_array('Tinebase_Record_Interface', class_implements($value)) || 
466                         $value instanceof Tinebase_Record_Recordset) ) {
467                        
468                     $value->setTimezone($_timezone, TRUE);
469                 }
470             }
471         }
472         
473     }
474     
475     /**
476      * returns array of fields with validation errors 
477      *
478      * @return array
479      */
480     public function getValidationErrors()
481     {
482         return $this->_validationErrors;
483     }
484     
485     /**
486      * returns array with record related properties 
487      *
488      * @param boolean $_recursive
489      * @return array
490      */
491     public function toArray($_recursive = TRUE)
492     {
493         /*
494         foreach ($this->_properties as $key => $value) {
495             if ($value instanceof DateTime) {
496                 $date = new Tinebase_DateTime($value->get(Tinebase_Record_Abstract::ISO8601LONG));
497                 $date->setTimezone($value->getTimezone());
498                 $this->_properties[$key] = $date;
499             }
500         }
501         */
502         $recordArray = $this->_properties;
503         if ($this->convertDates === true) {
504             if (! is_string($this->dateConversionFormat)) {
505                 $this->_convertDateTimeToString($recordArray, Tinebase_Record_Abstract::ISO8601LONG);
506             } else {
507                 $this->_convertDateTimeToString($recordArray, $this->dateConversionFormat);
508             }
509         }
510         
511         if ($_recursive) {
512             foreach ($recordArray as $property => $value) {
513                 if ($this->_hasToArray($value)) {
514                     $recordArray[$property] = $value->toArray();
515                 }
516             }
517         }
518         
519         return $recordArray;
520     }
521     
522     /**
523      * checks if variable has toArray()
524      * 
525      * @param mixed $mixed
526      * @return boolean
527      */
528     protected function _hasToArray($mixed)
529     {
530         return (is_object($mixed) && 
531                         (in_array('Tinebase_Record_Interface', class_implements($mixed)) || 
532                         $mixed instanceof Tinebase_Record_Recordset) ||
533                         (is_object($mixed) && method_exists($mixed, 'toArray')));
534     }
535     
536     /**
537      * validate and filter the the internal data
538      *
539      * @param $_throwExceptionOnInvalidData
540      * @return bool
541      * @throws Tinebase_Exception_Record_Validation
542      */
543     public function isValid($_throwExceptionOnInvalidData = false)
544     {
545         if ($this->_isValidated === false) {
546             
547             $inputFilter = $this->_getFilter();
548             $inputFilter->setData($this->_properties);
549             
550             if ($inputFilter->isValid()) {
551                 // set $this->_properties with the filtered values
552                 $this->_properties = $inputFilter->getUnescaped();
553                 $this->_isValidated = true;
554                 
555             } else {
556                 $this->_validationErrors = array();
557                 
558                 foreach($inputFilter->getMessages() as $fieldName => $errorMessage) {
559                     //print_r($inputFilter->getMessages());
560                     $this->_validationErrors[] = array(
561                         'id'  => $fieldName,
562                         'msg' => $errorMessage
563                     );
564                 }
565                 if ($_throwExceptionOnInvalidData) {
566                     $e = new Tinebase_Exception_Record_Validation('some fields ' . implode(',', array_keys($inputFilter->getMessages())) . ' have invalid content');
567                     Tinebase_Core::getLogger()->err(__METHOD__ . '::' . __LINE__ . ":\n" .
568                         print_r($this->_validationErrors,true). $e);
569                     throw $e;
570                 }
571             }
572         }
573         
574         return $this->_isValidated;
575     }
576     
577     /**
578      * apply filter
579      *
580      * @todo implement
581      */
582     public function applyFilter()
583     {
584         $this->isValid(true);
585         
586     }
587     
588     /**
589      * sets record related properties
590      * 
591      * @param string _name of property
592      * @param mixed _value of property
593      * @throws Tinebase_Exception_UnexpectedValue
594      * @return void
595      */
596     public function __set($_name, $_value)
597     {
598         if (! array_key_exists ($_name, $this->_validators)) {
599             throw new Tinebase_Exception_UnexpectedValue($_name . ' is no property of $this->_properties');
600         }
601         
602         $this->_properties[$_name] = $_value;
603         $this->_isValidated = false;
604         $this->_isDirty     = true;
605         
606         if ($this->bypassFilters !== true) {
607             $this->isValid(true);
608         }
609     }
610     
611     /**
612      * unsets record related properties
613      * 
614      * @param string _name of property
615      * @throws Tinebase_Exception_UnexpectedValue
616      * @return void
617      */
618     public function __unset($_name)
619     {
620         if (!array_key_exists ($_name, $this->_validators)) {
621             throw new Tinebase_Exception_UnexpectedValue($_name . ' is no property of $this->_properties');
622         }
623         
624         unset($this->_properties[$_name]);
625         
626         $this->_isValidated = false;
627         
628         if ($this->bypassFilters !== true) {
629             $this->isValid(true);
630         }
631     }
632     
633     /**
634      * checkes if an propertiy is set
635      * 
636      * @param string _name name of property
637      * @return bool property is set or not
638      */
639     public function __isset($_name)
640     {
641         return isset($this->_properties[$_name]);
642     }
643     
644     /**
645      * gets record related properties
646      * 
647      * @param string _name of property
648      * @throws Tinebase_Exception_UnexpectedValue
649      * @return mixed value of property
650      */
651     public function __get($_name)
652     {
653         if (!array_key_exists ($_name, $this->_validators)) {
654             throw new Tinebase_Exception_UnexpectedValue($_name . ' is no property of $this->_properties');
655         }
656         
657         return array_key_exists($_name, $this->_properties) ? $this->_properties[$_name] : NULL;
658     }
659     
660    /** convert this to string
661     *
662     * @return string
663     */
664     public function __toString()
665     {
666        return print_r($this->toArray(), TRUE);
667     }
668     
669     /**
670      * returns a Zend_Filter for the $_filters and $_validators of this record class.
671      * we just create an instance of Filter if we really need it.
672      * 
673      * @return Zend_Filter_Input
674      */
675     protected function _getFilter()
676     {
677         $myClassName = get_class($this);
678         
679         if (! array_key_exists($myClassName, self::$_inputFilters)) {
680             self::$_inputFilters[$myClassName] = new Zend_Filter_Input($this->_filters, $this->_validators);
681         }
682         return self::$_inputFilters[$myClassName];
683     }
684     
685     /**
686      * Converts Tinebase_DateTimes into custom representation
687      *
688      * @param array &$_toConvert
689      * @param string $_format
690      * @return void
691      */
692     protected function _convertDateTimeToString(&$_toConvert, $_format)
693     {
694         //$_format = "Y-m-d H:i:s";
695         foreach ($_toConvert as $field => &$value) {
696             if ($value instanceof DateTime) {
697                 $_toConvert[$field] = $value->format($_format);
698             } elseif (is_array($value)) {
699                 $this->_convertDateTimeToString($value, $_format);
700             } elseif (! $value && in_array($field, $this->_datetimeFields)) {
701                 $_toConvert[$field] = NULL;
702             }
703         }
704     }
705     
706     /**
707      * Converts iso8601 formated dates into Tinebase_DateTime representation
708      * 
709      * NOTE: Instead of using the Tinebase_DateTime build in date creation from iso, we 
710      *       first convert the dates to UNIX timestamp by hand and create Tinebase_DateTimes
711      *       from this timestamp. This brings a 15 times performance boost
712      *
713      * @param array &$_data
714      * 
715      * @return void
716      */
717     protected function _convertISO8601ToDateTime(array &$_data)
718     {
719         foreach ($this->_datetimeFields as $field) {
720             if (!isset($_data[$field]) || $_data[$field] instanceof DateTime) continue;
721             
722             if (! is_array($_data[$field]) && strpos($_data[$field], ',') !== false) {
723                 $_data[$field] = explode(',', $_data[$field]);
724             }
725             
726             try {
727                 if (is_array($_data[$field])) {
728                     foreach($_data[$field] as $dataKey => $dataValue) {
729                         if ($dataValue instanceof DateTime) continue;
730                         $_data[$field][$dataKey] =  (int)$dataValue == 0 ? NULL : new Tinebase_DateTime($dataValue);
731                     }
732                 } else {
733                     $_data[$field] = (int)$_data[$field] == 0 ? NULL : new Tinebase_DateTime($_data[$field]);
734                     
735                 }
736             } catch (Tinebase_DateTime_Exception $zde) {
737                 Tinebase_Core::getLogger()->warn(__METHOD__ . '::' . __LINE__ . ' Error while converting date field "' . $field . '": ' . $zde->getMessage());
738                 $_data[$field] = NULL;
739             }
740         }
741         
742     }
743     
744     /**
745      * Converts custom formated dates into Tinebase_DateTime representation
746      *
747      * @param array &$_data
748      * @param string $_format {@see Tinebase_DateTime}
749      * 
750      * @return void
751      */
752     protected function _convertCustomDateToDateTime(array &$_data, $_format)
753     {
754         foreach ($this->_datetimeFields as $field) {
755             if (!isset($_data[$field]) || $_data[$field] instanceof DateTime) continue;
756             
757             if (strpos($_data[$field], ',') !== false) {
758                 $_data[$field] = explode(',', $_data[$field]);
759             }
760             
761             if (is_array($_data[$field])) {
762                 foreach($_data[$field] as $dataKey => $dataValue) {
763                     if ($dataValue instanceof DateTime) continue;
764                     $_data[$field][$dataKey] =  (int)$dataValue == 0 ? NULL : new Tinebase_DateTime($dataValue);
765                 }
766             } else {
767                 $_data[$field] = (int)$_data[$field] == 0 ? NULL : new Tinebase_DateTime($_data[$field]);
768             }
769         }
770     }
771     
772     /**
773      * cut the timezone-offset from the iso representation in order to force 
774      * Tinebase_DateTime to create dates in the user timezone. otherwise they will be 
775      * created with Etc/GMT+<offset> as timezone which would lead to incorrect 
776      * results in datetime computations!
777      * 
778      * @param  string Tinebase_DateTime::ISO8601 representation of a datetime filed
779      * @return string ISO8601LONG representation ('Y-m-d H:i:s')
780      */
781     protected function _convertISO8601ToISO8601LONG($_ISO)
782     {
783         $cutedISO = preg_replace('/[+\-]{1}\d{2}:\d{2}/', '', $_ISO);
784         $cutedISO = str_replace('T', ' ', $cutedISO);
785         
786         return $cutedISO;
787     }
788     
789     /**
790      * Converts time into iso representation (hh:mm:ss)
791      *
792      * @param array &$_data
793      * @return void
794      * 
795      * @todo    add support for hh:mm:ss AM|PM
796      */
797     protected function _convertTime(&$_data)
798     {
799         foreach ($this->_timeFields as $field) {
800             if (!isset($_data[$field]) || empty($_data[$field])) {
801                 continue;
802             }
803             
804             $hhmmss = explode(":", $_data[$field]);
805             if (count($hhmmss) === 2) {
806                 // seconds missing
807                 $hhmmss[] = '00';
808             }
809             list($hours, $minutes, $seconds) = $hhmmss;
810             if (preg_match('/AM|PM/', $minutes)) {
811                 list($minutes, $notation) = explode(" ", $minutes);
812                 switch($notation) {
813                     case 'AM':
814                         $hours = ($hours == '12') ? 0 : $hours;
815                         break;
816                     case 'PM':
817                         $hours = $hours + 12;
818                         break;
819                 }
820                 $_data[$field] = implode(':', $hhmmss);
821             }
822         }
823     }
824     
825     /**
826      * returns the default filter group for this model
827      * @return string
828      */
829     protected static function _getDefaultFilterGroup()
830     {
831         return get_called_class() . 'Filter';
832     }
833     
834     /**
835      * required by ArrayAccess interface
836      */
837     public function offsetExists($_offset)
838     {
839         return isset($this->_properties[$_offset]);
840     }
841     
842     /**
843      * required by ArrayAccess interface
844      */
845     public function offsetGet($_offset)
846     {
847         return $this->__get($_offset);
848     }
849     
850     /**
851      * required by ArrayAccess interface
852      */
853     public function offsetSet($_offset, $_value)
854     {
855         return $this->__set($_offset, $_value);
856     }
857     
858     /**
859      * required by ArrayAccess interface
860      * @throws Tinebase_Exception_Record_NotAllowed
861      */
862     public function offsetUnset($_offset)
863     {
864         throw new Tinebase_Exception_Record_NotAllowed('Unsetting of properties is not allowed');
865     }
866     
867     /**
868      * required by IteratorAggregate interface
869      */
870     public function getIterator()
871     {
872         return new ArrayIterator($this->_properties);
873     }
874     
875     /**
876      * returns a random 40-character hexadecimal number to be used as 
877      * universal identifier (UID)
878      * 
879      * @param int|optional $_length the length of the uid, defaults to 40
880      * @return string 40-character hexadecimal number
881      */
882     public static function generateUID($_length = false)
883     {
884         $uid = sha1(mt_rand(). microtime());
885         
886         if ($_length !== false) {
887             $uid = substr($uid, 0, $_length);
888         }
889         
890         return $uid;
891     }
892     
893     /**
894     * converts a int, string or Tinebase_Record_Interface to a id
895     *
896     * @param int|string|Tinebase_Record_Abstract $_id the id to convert
897     * @param string $_modelName
898     * @return int|string
899     */
900     public static function convertId($_id, $_modelName = 'Tinebase_Record_Abstract')
901     {
902         if ($_id instanceof $_modelName) {
903             if (! $_id->getId()) {
904                 throw new Tinebase_Exception_InvalidArgument('No id set!');
905             }
906             $id = $_id->getId();
907         } elseif (is_array($_id)) {
908             throw new Tinebase_Exception_InvalidArgument('Id can not be an array!');
909         } else {
910             $id = $_id;
911         }
912     
913         if ($id === 0) {
914             throw new Tinebase_Exception_InvalidArgument($_modelName . '.id can not be 0!');
915         }
916     
917         return $id;
918     }
919     
920     /**
921      * returns a Tinebase_Record_Diff record with differences to the given record
922      * 
923      * @param  Tinebase_Record_Interface $_record record for comparison
924      * @return Tinebase_Record_Diff|NULL
925      */
926     public function diff($_record)
927     {
928         if (! $_record instanceof Tinebase_Record_Abstract) {
929             return $_record;
930         }
931         
932         $result = new Tinebase_Record_Diff(array(
933             'id'     => $this->getId(),
934             'model'  => get_class($_record),
935         ));
936         $diff = array();
937         foreach (array_keys($this->_validators) as $fieldName) {
938             $ownField = $this->__get($fieldName);
939             $recordField = $_record->$fieldName;
940             
941             if (in_array($fieldName, $this->_datetimeFields)) {
942                 if ($ownField instanceof DateTime
943                     && $recordField instanceof DateTime) {
944                     if ($ownField->compare($recordField) === 0) {
945                         continue;
946                     } else {
947                         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . 
948                             ' datetime for field ' . $fieldName . ' is not equal: '
949                             . $ownField->getIso() . ' != '
950                             . $recordField->getIso()
951                         );
952                     } 
953                 } else if (! $recordField instanceof DateTime && $ownField == $recordField) {
954                     continue;
955                 } 
956             } else if ($fieldName == $this->_identifier && $this->getId() == $_record->getId()) {
957                 continue;
958             } else if ($ownField instanceof Tinebase_Record_Abstract || $ownField instanceof Tinebase_Record_RecordSet) {
959                 if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ . 
960                     ' Doing subdiff for field ' . $fieldName);
961                 $subdiff = $ownField->diff($recordField);
962                 if (is_object($subdiff) && ! $subdiff->isEmpty()) {
963                     $diff[$fieldName] = $subdiff;
964                 }
965                 continue;
966             } else if ($recordField instanceof Tinebase_Record_Abstract && is_scalar($ownField)) {
967                 // maybe we have the id of the record -> just compare the id
968                 if ($recordField->getId() == $ownField) {
969                     continue;
970                 } else {
971                     $recordField = $recordField->getId();
972                 }
973             } else if ($ownField == $recordField) {
974                 continue;
975             } else if (empty($ownField) && empty($recordField)) {
976                 continue;
977             }
978             
979             $diff[$fieldName] = $recordField;
980         }
981         
982         $result->diff = $diff;
983         return $result;
984     }
985     
986     /**
987      * check if data got modified
988      * 
989      * @return boolean
990      */
991     public function isDirty()
992     {
993         return $this->_isDirty;
994     }
995     
996     /**
997      * returns TRUE if given record obsoletes this one
998      * 
999      * @param  Tinebase_Record_Interface $_record
1000      * @return bool
1001      */
1002     public function isObsoletedBy($_record)
1003     {
1004         if (get_class($_record) !== get_class($this)) {
1005             throw new Tinebase_Exception_InvalidArgument('Records could not be compared');
1006         } else if ($this->getId() && $_record->getId() !== $this->getId()) {
1007             throw new Tinebase_Exception_InvalidArgument('Record id mismatch');
1008         }
1009         
1010         if ($this->has('seq') && $_record->seq != $this->seq) {
1011             return $_record->seq > $this->seq;
1012         }
1013         
1014         return ($this->has('last_modified_time')) ? $_record->last_modified_time > $this->last_modified_time : TRUE;
1015     }
1016     
1017     /**
1018      * check if two records are equal
1019      * 
1020      * @param  Tinebase_Record_Interface $_record record for comparism
1021      * @param  array                     $_toOmit fields to omit
1022      * @return bool
1023      */
1024     public function isEqual($_record, array $_toOmit = array())
1025     {
1026         $diff = $this->diff($_record);
1027         return ($diff) ? $diff->isEmpty($_toOmit) : FALSE;
1028     }
1029     
1030     /**
1031      * translate this records' fields
1032      *
1033      */
1034     public function translate()
1035     {
1036         // get translation object
1037         if (!empty($this->_toTranslate)) {
1038             $translate = Tinebase_Translation::getTranslation($this->_application);
1039             
1040             foreach ($this->_toTranslate as $field) {
1041                 $this->$field = $translate->_($this->$field);
1042             }
1043         }
1044     }
1045
1046     /**
1047      * check if the model has a specific field (container_id for example)
1048      *
1049      * @param string $_field
1050      * @return boolean
1051      */
1052     public function has($_field) 
1053     {
1054         return (array_key_exists ($_field, $this->_validators));
1055     }   
1056
1057     /**
1058      * get fields
1059      * 
1060      * @return array
1061      */
1062     public function getFields()
1063     {
1064         return array_keys($this->_validators);
1065     }
1066     
1067     /**
1068      * fills a record from json data
1069      *
1070      * @param string $_data json encoded data
1071      * @return void
1072      * 
1073      * @todo replace this (and setFromJsonInUsersTimezone) with Tinebase_Convert_Json::toTine20Model
1074      * @todo move custom _setFromJson to (custom) converter
1075      */
1076     public function setFromJson($_data)
1077     {
1078         if (is_array($_data)) {
1079             $recordData = $_data;
1080         } else {
1081             $recordData = Zend_Json::decode($_data);
1082         }
1083         
1084         // sanitize container id if it is an array
1085         if ($this->has('container_id') && isset($recordData['container_id']) && is_array($recordData['container_id']) && isset($recordData['container_id']['id']) ) {
1086             $recordData['container_id'] = $recordData['container_id']['id'];
1087         }
1088         
1089         $this->_setFromJson($recordData);
1090         $this->setFromArray($recordData);
1091     }
1092     
1093     /**
1094      * can be reimplemented by subclasses to modify values during setFromJson
1095      * @param array $_data the json decoded values
1096      * @return void
1097      */
1098     protected function _setFromJson(array &$_data)
1099     {
1100         
1101     }
1102
1103     /**
1104      * returns modlog omit fields
1105      *
1106      * @return array
1107      */
1108     public function getModlogOmitFields()
1109     {
1110         return $this->_modlogOmitFields;
1111     }
1112
1113     /**
1114      * returns read only fields
1115      *
1116      * @return array
1117      */
1118     public function getReadOnlyFields()
1119     {
1120         return $this->_readOnlyFields;
1121     }
1122
1123     /**
1124      * sets the non static properties by the created configuration object on instantiation
1125      */
1126     protected function _setFromConfigurationObject()
1127     {
1128         // set protected, non static properties
1129         $co = static::getConfiguration();
1130         if ($co && $mc = $co->toArray()) {
1131             foreach ($mc as $property => $value) {
1132                 $this->{$property} = $value;
1133             }
1134         }
1135     }
1136
1137     /**
1138      * returns the foreignId fields (used in Tinebase_Convert_Json)
1139      * @return array
1140      */
1141     public static function getResolveForeignIdFields()
1142     {
1143         return static::$_resolveForeignIdFields;
1144     }
1145 }