* @package addressbook * @copyright (c) 2007 by Ralf Becker * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License * @version $Id$ */ /** * Addressbook - tracking object */ class addressbook_tracking extends bo_tracking { /** * Application we are tracking (required!) * * @var string */ var $app = 'addressbook'; /** * Name of the id-field, used as id in the history log (required!) * * @var string */ var $id_field = 'id'; /** * Name of the field with the creator id, if the creator of an entry should be notified * * @var string */ var $creator_field = 'creator'; /** * Name of the field with the id(s) of assinged users, if they should be notified * * @var string */ var $assigned_field; /** * Translate field-name to 2-char history status * * @var array */ var $field2history = array( ); /** * Should the user (passed to the track method or current user if not passed) be used as sender or get_config('sender') * * @var boolean */ var $prefer_user_as_sender = false; /** * Instance of the bocontacts class calling us * * @access private * @var addressbook_bo */ var $contacts; /** * Constructor * * @param addressbook_bo $bocontacts * @return tracker_tracking */ function __construct(addressbook_bo $bocontacts) { $this->contacts = $bocontacts; if (is_object($bocontacts->somain) && is_array($bocontacts->somain->db_cols)) { $this->field2history = array_combine($bocontacts->somain->db_cols, $bocontacts->somain->db_cols); // no need to store these unset($this->field2history['modified']); unset($this->field2history['modifier']); unset($this->field2history['etag']); // we currently can only track text unset($this->field2history['jpegphoto']); } // custom fields are now handled by parent::__construct('addressbook') parent::__construct('addressbook'); } /** * Get a notification-config value * * @param string $what * - 'copy' array of email addresses notifications should be copied too, can depend on $data * - 'lang' string lang code for copy mail * - 'sender' string send email address * @param array $data current entry * @param array $old=null old/last state of the entry or null for a new entry * @return mixed */ function get_config($name,$data,$old=null) { //echo "

addressbook_tracking::get_config($name,".print_r($data,true).",...)

\n"; switch($name) { case 'copy': if ($data['is_contactform']) { $copy = preg_split('/, ?/',$data['email_contactform']); if ($data['email_copytoreceiver']) $copy[] = $data['email']; return $copy; } break; case 'sender': if ($data['is_contactform']) { //echo "

addressbook_tracking::get_config($name,...) email={$data['email']}, n_given={$data['n_given']}, n_family={$data['n_family']}

\n"; return $data['email'] ? $data['n_given'].' '.$data['n_family'].' <'.$data['email'].'>' : null; } break; } return null; } /** * Override changes to do some special handling of the text country field vs the country code * * If the country name was changed at all, use the translated name from the country code as the other value. * Otherwise, use country code. * * @internal use only track($data,$old) * @param array $data current entry * @param array $old=null old/last state of the entry or null for a new entry * @param boolean $deleted=null can be set to true to let the tracking know the item got deleted or undelted * @param array $changed_fields=null changed fields from ealier call to $this->changed_fields($data,$old), to not compute it again * @return int number of log-entries made */ protected function save_history(array $data,array $old=null,$deleted=null,array $changed_fields=null) { if (is_null($changed_fields)) { $changed_fields = self::changed_fields($data,$old); } if (!$changed_fields) return 0; foreach(array('adr_one_countryname' => 'adr_one_countrycode', 'adr_two_countryname' => 'adr_two_countrycode') as $name => $code) { // Only codes involved, but old text name is automatically added when loaded if($old[$code] && $data[$code]) { unset($changed_fields[array_search($name, $changed_fields)]); continue; } // Code and a text name if(in_array($name, $changed_fields) && in_array($code, $changed_fields)) { if($data[$code]) { $data[$name] = $GLOBALS['egw']->country->get_full_name($data[$code], true); } unset($changed_fields[array_search($code, $changed_fields)]); } } //error_log(__METHOD__.__LINE__.' ChangedFields:'.array2string($changed_fields)); return parent::save_history($data,$old,$deleted,$changed_fields); } /** * Get the modified / new message (1. line of mail body) for a given entry, can be reimplemented * * @param array $data * @param array $old * @return string */ function get_message($data,$old) { if (!$data['modified'] || !$old) { return lang('New contact submitted by %1 at %2', common::grab_owner_name($data['creator']), $this->datetime($data['created'])); } return lang('Contact modified by %1 at %2', common::grab_owner_name($data['modifier']), $this->datetime($data['modified'])); } /** * Get the subject of the notification * * @param array $data * @param array $old * @return string */ function get_subject($data,$old) { if ($data['is_contactform']) { $prefix = ($data['subject_contactform'] ? $data['subject_contactform'] : lang('Contactform')).': '; } return $prefix.$this->contacts->link_title($data); } /** * Get the details of an entry * * @param array $data * * @return array of details as array with values for keys 'label','value','type' */ function get_details($data) { foreach($this->contacts->contact_fields as $name => $label) { if (!$data[$name] && $name != 'owner') continue; switch($name) { case 'n_prefix': case 'n_given': case 'n_middle': case 'n_family': case 'n_suffix': // already in n_fn case 'n_fileas': case 'id': case 'tid': break; case 'created': case 'modified': $details[$name] = array( 'label' => $label, 'value' => $this->datetime($data[$name]), ); break; case 'bday': if ($data[$name]) { list($y,$m,$d) = explode('-',$data[$name]); $details[$name] = array( 'label' => $label, 'value' => common::dateformatorder($y,$m,$d,true), ); } break; case 'owner': case 'creator': case 'modifier': $details[$name] = array( 'label' => $label, 'value' => common::grab_owner_name($data[$name]), ); break; case 'cat_id': if ($data[$name]) { $cats = array(); foreach(is_array($data[$name]) ? $data[$name] : explode(',',$data[$name]) as $cat_id) { $cats[] = $GLOBALS['egw']->cats->id2name($cat_id); } $details[$name] = array( 'label' => $label, 'value' => explode(', ',$cats), ); } case 'note': $details[$name] = array( 'label' => $label, 'value' => $data[$name], 'type' => 'multiline', ); break; default: $details[$name] = array( 'label' => $label, 'value' => $data[$name], ); break; } } if ($this->contacts->customfields) { foreach($this->contacts->customfields as $name => $custom) { if (!$header_done) { $details['custom'] = array( 'value' => lang('Custom fields').':', 'type' => 'reply', ); $header_done = true; } $details['#'.$name] = array( 'label' => $custom['label'], 'value' => $custom['type'] == 'select' ? $custom['values'][$data['#'.$name]] : $data['#'.$name], ); } } return $details; } }