githubFork/roundcubemail.git

			@@ -5,7 +5,7 @@
			\| program/include/rcube_addressbook.php \|
			\| \|
			\| This file is part of the Roundcube Webmail client \|
			\| Copyright (C) 2006-2009, Roundcube Dev. - Switzerland \|
			\| Copyright (C) 2006-2011, The Roundcube Dev Team \|
			\| Licensed under the GNU GPL \|
			\| \|
			\| PURPOSE: \|
			@@ -27,13 +27,24 @@
			*/
			abstract class rcube_addressbook
			{
			/** public properties */
			var $primary_key;
			var $groups = false;
			var $readonly = true;
			var $ready = false;
			var $list_page = 1;
			var $page_size = 10;
			/ constants for error reporting /
			const ERROR_READ_ONLY = 1;
			const ERROR_NO_CONNECTION = 2;
			const ERROR_INCOMPLETE = 3;
			const ERROR_SAVING = 4;
			const ERROR_SEARCH = 5;

			/** public properties (mandatory) */
			public $primary_key;
			public $groups = false;
			public $readonly = true;
			public $ready = false;
			public $group_id = null;
			public $list_page = 1;
			public $page_size = 10;
			public $coltypes = array('name' => array('limit'=>1), 'firstname' => array('limit'=>1), 'surname' => array('limit'=>1), 'email' => array('limit'=>1));

			protected $error;

			/**
			* Save a search string for future listings
			@@ -55,6 +66,16 @@
			abstract function reset();

			/**
			* Refresh saved search set after data has changed
			*
			* @return mixed New search set
			*/
			function refresh_search()
			{
			return $this->get_search_set();
			}

			/**
			* List the current set of contact records
			*
			* @param array List of cols to show
			@@ -64,21 +85,16 @@
			abstract function list_records($cols=null, $subset=0);

			/**
			* List all active contact groups of this source
			*
			* @return array Indexed list of contact groups, each a hash array
			*/
			function list_groups() { }

			/**
			* Search records
			*
			* @param array List of fields to search in
			* @param string Search value
			* @param boolean True if results are requested, False if count only
			* @return Indexed list of contact records and 'count' value
			* @param boolean True to skip the count query (select only)
			* @param array List of fields that cannot be empty
			* @return object rcube_result_set List of contact records and 'count' value
			*/
			abstract function search($fields, $value, $strict=false, $select=true);
			abstract function search($fields, $value, $strict=false, $select=true, $nocount=false, $required=array());

			/**
			* Count number of available contacts in database
			@@ -99,9 +115,31 @@
			*
			* @param mixed record identifier(s)
			* @param boolean True to return record as associative array, otherwise a result set is returned
			*
			* @return mixed Result object with all record fields or False if not found
			*/
			abstract function get_record($id, $assoc=false);

			/**
			* Returns the last error occured (e.g. when updating/inserting failed)
			*
			* @return array Hash array with the following fields: type, message
			*/
			function get_error()
			{
			return $this->error;
			}

			/**
			* Setter for errors for internal use
			*
			* @param int Error type (one of this class' error constants)
			* @param string Error message (name of a text label)
			*/
			protected function set_error($type, $message)
			{
			$this->error = array('type' => $type, 'message' => $message);
			}

			/**
			* Close connection to source
			@@ -131,16 +169,41 @@
			$this->page_size = (int)$size;
			}


			/**
			* Setter for the current group
			* (empty, has to be re-implemented by extending class)
			* Check the given data before saving.
			* If input not valid, the message to display can be fetched using get_error()
			*
			* @param array Assoziative array with data to save
			* @return boolean True if input is valid, False if not.
			*/
			function set_group($gid) { }
			public function validate($save_data)
			{
			if (empty($save_data['name'])) {
			$this->set_error('warning', 'nonamewarning');
			return false;
			}

			// check validity of email addresses
			foreach ($this->get_col_values('email', $save_data, true) as $email) {
			if (strlen($email)) {
			if (!check_email(rcube_idn_to_ascii($email))) {
			$this->set_error('warning', rcube_label(array('name' => 'emailformaterror', 'vars' => array('email' => $email))));
			return false;
			}
			}
			}

			return true;
			}


			/**
			* Create a new contact record
			*
			* @param array Assoziative array with save data
			* Keys: Field name with optional section in the form FIELD:SECTION
			* Values: Field value. Can be either a string or an array of strings for multiple values
			* @param boolean True to check for duplicates first
			* @return mixed The created record ID on success, False on error
			*/
			@@ -150,10 +213,31 @@
			}

			/**
			* Create new contact records for every item in the record set
			*
			* @param object rcube_result_set Recordset to insert
			* @param boolean True to check for duplicates first
			* @return array List of created record IDs
			*/
			function insertMultiple($recset, $check=false)
			{
			$ids = array();
			if (is_object($recset) && is_a($recset, rcube_result_set)) {
			while ($row = $recset->next()) {
			if ($insert = $this->insert($row, $check))
			$ids[] = $insert;
			}
			}
			return $ids;
			}

			/**
			* Update a specific contact record
			*
			* @param mixed Record identifier
			* @param array Assoziative array with save data
			* Keys: Field name with optional section in the form FIELD:SECTION
			* Values: Field value. Can be either a string or an array of strings for multiple values
			* @return boolean True on success, False on error
			*/
			function update($id, $save_cols)
			@@ -180,6 +264,24 @@
			}

			/**
			* Setter for the current group
			* (empty, has to be re-implemented by extending class)
			*/
			function set_group($gid) { }

			/**
			* List all active contact groups of this source
			*
			* @param string Optional search string to match group name
			* @return array Indexed list of contact groups, each a hash array
			*/
			function list_groups($search = null)
			{
			/* empty for address books don't supporting groups */
			return array();
			}

			/**
			* Create a contact group with the given name
			*
			* @param string The group name
			@@ -190,7 +292,7 @@
			/* empty for address books don't supporting groups */
			return false;
			}


			/**
			* Delete the given group and all linked group members
			*
			@@ -202,7 +304,7 @@
			/* empty for address books don't supporting groups */
			return false;
			}


			/**
			* Rename a specific contact group
			*
			@@ -215,20 +317,20 @@
			/* empty for address books don't supporting groups */
			return false;
			}


			/**
			* Add the given contact records the a certain group
			*
			* @param string Group identifier
			* @param array List of contact identifiers to be added
			* @return int Number of contacts added
			* @return int Number of contacts added
			*/
			function add_to_group($group_id, $ids)
			{
			/* empty for address books don't supporting groups */
			return 0;
			}


			/**
			* Remove the given contact records from a certain group
			*
			@@ -241,4 +343,68 @@
			/* empty for address books don't supporting groups */
			return 0;
			}

			/**
			* Get group assignments of a specific contact record
			*
			* @param mixed Record identifier
			*
			* @return array List of assigned groups as ID=>Name pairs
			* @since 0.5-beta
			*/
			function get_record_groups($id)
			{
			/* empty for address books don't supporting groups */
			return array();
			}


			/**
			* Utility function to return all values of a certain data column
			* either as flat list or grouped by subtype
			*
			* @param string Col name
			* @param array Record data array as used for saving
			* @param boolean True to return one array with all values, False for hash array with values grouped by type
			* @return array List of column values
			*/
			function get_col_values($col, $data, $flat = false)
			{
			$out = array();
			foreach ($data as $c => $values) {
			if (strpos($c, $col) === 0) {
			if ($flat) {
			$out = array_merge($out, (array)$values);
			}
			else {
			list($f, $type) = explode(':', $c);
			$out[$type] = array_merge((array)$out[$type], (array)$values);
			}
			}
			}

			return $out;
			}


			/**
			* Normalize the given string for fulltext search.
			* Currently only optimized for Latin-1 characters; to be extended
			*
			* @param string Input string (UTF-8)
			* @return string Normalized string
			*/
			protected static function normalize_string($str)
			{
			$norm = strtolower(strtr(utf8_decode($str),
			'ÇçäâàåéêëèïîìÅÉöôòüûùÿøØáíóúñÑÁÂÀãÃÊËÈÍÎÏÓÔõÕÚÛÙýÝ',
			'ccaaaaeeeeiiiaeooouuuyooaiounnaaaaaeeeiiioooouuuyy'));

			return preg_replace(
			array('/[\s;\+\-\/]+/i', '/(\d)\s+(\d)/', '/\s\w{1,3}\s/'),
			array(' ', '\\1\\2', ' '),
			$norm);
			}

			}