Fixed bug with identity updating.

ident_switch.php

@@ -12,14 +12,13 @@ class ident_switch extends rcube_plugin
 {
 	public $task='?(?!login|logout).*';
 
-	private $table = 'ident_switch';
+	const TABLE = 'ident_switch';
-	private $my_postfix = '_iswitch';
+	const MY_POSTFIX = '_iswitch';
-	private $my_log = 'ident_switch';
 
 	// Flags user in database
-	private $db_enabled		= 1;
+	const DB_ENABLED		= 1;
-	private $db_secure_ssl	= 2;
+	const DB_SECURE_SSL		= 2;
-	private $db_secure_tls	= 4;
+	const DB_SECURE_TLS		= 4;
 
 	function init()
 	{
@@ -28,6 +27,8 @@ class ident_switch extends rcube_plugin
 		$this->add_hook('smtp_connect', array($this, 'on_smtp_connect'));
 		$this->add_hook('identity_form', array($this, 'on_identity_form'));
 		$this->add_hook('identity_update', array($this, 'on_identity_update'));
+		$this->add_hook('identity_create', array($this, 'on_identity_create'));
+		$this->add_hook('identity_create_after', array($this, 'on_identity_create_after'));
 		$this->add_hook('identity_delete', array($this, 'on_identity_delete'));
 		$this->add_hook('template_object_composeheaders', array($this, 'on_template_object_composeheaders'));
 
@@ -58,7 +59,7 @@ class ident_switch extends rcube_plugin
 		$rc = rcmail::get_instance();
 
 		// Currently selected identity
-		$iid = $_SESSION['iid' . $this->my_postfix];
+		$iid = $_SESSION['iid' . self::MY_POSTFIX];
 
 		$iid_int = 0;
 		if (is_int($iid))
@@ -70,8 +71,8 @@ class ident_switch extends rcube_plugin
 
 		// Get list of alternative accounts
 		$sOpt = '';
-		$sql = 'SELECT id, iid, label, username FROM ' . $rc->db->table_name($this->table) . ' WHERE user_id = ? AND flags & ? > 0';
+		$sql = 'SELECT id, iid, label, username FROM ' . $rc->db->table_name(self::TABLE) . ' WHERE user_id = ? AND flags & ? > 0';
-		$qRec = $rc->db->query($sql, $rc->user->data['user_id'], $this->db_enabled);
+		$qRec = $rc->db->query($sql, $rc->user->data['user_id'], self::DB_ENABLED);
 		while ($r = $rc->db->fetch_assoc($qRec))
 		{
 			$opts = array('value' => $r['id']);
@@ -145,7 +146,7 @@ class ident_switch extends rcube_plugin
 			if ($args['smtp_user'] == '%u')
 				$args['smtp_user'] = $rc->user->data['username'];
 			if ($args['smtp_pass'] == '%p')
-				$args['smtp_pass'] = $rc->decrypt($_SESSION['password' . $this->my_postfix]);
+				$args['smtp_pass'] = $rc->decrypt($_SESSION['password' . self::MY_POSTFIX]);
 		}
 
 		return $args;
@@ -157,7 +158,7 @@ class ident_switch extends rcube_plugin
 
 		// Do not show options for default identity
 		if (strcasecmp($args['record']['email'], $rc->user->data['username']) === 0)
-			return $args;
+				return $args;
 
 		$this->add_texts('localization');
 
@@ -184,7 +185,7 @@ class ident_switch extends rcube_plugin
 		// Load data if exists
 		if (isset($args['record']['identity_id']))
 		{
-			$sql = 'SELECT * FROM ' . $rc->db->table_name($this->table) . ' WHERE iid = ? AND user_id = ?';
+			$sql = 'SELECT * FROM ' . $rc->db->table_name(self::TABLE) . ' WHERE iid = ? AND user_id = ?';
 			$q = $rc->db->query($sql, $args['record']['identity_id'], $rc->user->ID);
 			$r = $rc->db->fetch_assoc($q);
 			if ($r)
@@ -193,11 +194,11 @@ class ident_switch extends rcube_plugin
 					$args['record']['ident_switch.form.' . $k] = $v;
 
 				// Parse flags
-				if ($r['flags'] & $this->db_enabled)
+				if ($r['flags'] & self::DB_ENABLED)
 					$args['record']['ident_switch.form.enabled'] = true;
-				if ($r['flags'] & $this->db_secure_tls) // TLS has priority
+				if ($r['flags'] & self::DB_SECURE_TLS) // TLS has priority
 					$args['record']['ident_switch.form.secure'] = 'tls';
-				elseif ($r['flags'] & $this->db_secure_ssl)
+				elseif ($r['flags'] & self::DB_SECURE_SSL)
 					$args['record']['ident_switch.form.secure'] = 'ssl';
 
 				// Set readonly if needed
@@ -225,104 +226,70 @@ class ident_switch extends rcube_plugin
 			return $args;
 
 		// Process boolean fields
-		$flags = 0;
+		if (!rcube_utils::get_input_value('_ident_switch_form_enabled', rcube_utils::INPUT_POST))
-		if (rcube_utils::get_input_value('_ident_switch_form_enabled', rcube_utils::INPUT_POST))
-			$flags |= $this->db_enabled;
-
-		if (!($flags & $this->db_enabled))
 		{
-			$this->sw_imap_off($args['iid']);
+			self::sw_imap_off($args['iid']);
 			return $args;
 		}
 
-		// Check field values
+		$data = self::check_field_values();
-		$errMsg = '';
+		if ($data['err'])
-
-		$fLabel = self::ntrim(rcube_utils::get_input_value('_ident_switch_form_label', rcube_utils::INPUT_POST));
-		if (strlen($fLabel) > 32)
-			$errMsg = 'label.long';
-		else
-		{
-			$fHost = self::ntrim(rcube_utils::get_input_value('_ident_switch_form_host', rcube_utils::INPUT_POST));
-			if (strlen($fHost) > 64)
-				$errMsg = 'host.long';
-			else
-			{
-				$fPort = self::ntrim(rcube_utils::get_input_value('_ident_switch_form_port', rcube_utils::INPUT_POST));
-				if ($fPort && !ctype_digit($fPort))
-					$errMsg = 'port.num';
-				else
-				{
-					if ($fPort && ($fPort <= 0 || $fPort > 65535))
-						$errMsg = 'port.range';
-					else
-					{
-						$fUser = self::ntrim(rcube_utils::get_input_value('_ident_switch_form_username', rcube_utils::INPUT_POST));
-						if (strlen($fUser) > 64)
-							$errMsg = 'user.long';
-						else
-						{
-							$fDelim = self::ntrim(rcube_utils::get_input_value('_ident_switch_form_delimiter', rcube_utils::INPUT_POST));
-							if (strlen($fDelim) > 1)
-								$errMsg = 'delim.long';
-						}
-					}
-				}
-			}
-		}
-
-		if ($errMsg)
 		{
 			$this->add_texts('localization');
-			$rc->output->show_message('ident_switch.err.' . $errMsg, 'error');
 			$args['abort'] = true;
+			$args['message'] = 'ident_switch.err.' . $data['err'];
 			return $args;
 		}
 
-		// Parse secure settings
+		$data['id'] = $args['id'];
-		$ssl = rcube_utils::get_input_value('_ident_switch_form_secure', rcube_utils::INPUT_POST);
+		self::save_field_values($rc, $data);
-		if (strcasecmp($ssl, 'tls') === 0)
-			$flags |= $this->db_secure_tls;
-		elseif (strcasecmp($ssl, 'ssl') === 0)
-			$flags |= $this->db_secure_ssl;
 
-		$sql = 'SELECT id, password FROM ' . $rc->db->table_name($this->table) . ' WHERE iid = ? AND user_id = ?';
+		return $args;
-		$q = $rc->db->query($sql, $args['id'], $rc->user->ID);
+	}
-		$r = $rc->db->fetch_assoc($q);
-		if ($r)
-		{ // Record already exists, will update it
-			$sql = 'UPDATE ' .
-				$rc->db->table_name($this->table) .
-				' SET flags = ?, label = ?, host = ?, port = ?, username = ?, password = ?, delimiter = ?, user_id = ?, iid = ?' .
-				' WHERE id = ?';
-		}
-		else if ($flags & $this->db_enabled)
-		{ // No record exists, create new one
-			$sql = 'INSERT INTO ' .
-				$rc->db->table_name($this->table) .
-				'(flags, label, host, port, username, password, delimiter, user_id, iid) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)';
-		}
 
-		if ($sql)
+	function on_identity_create($args)
+	{
+		$rc = rcmail::get_instance();
+
+		// Do not do anything for default identity
+		if (strcasecmp($args['record']['email'], $rc->user->data['username']) === 0)
+			return $args;
+
+		// Process boolean fields
+		if (!rcube_utils::get_input_value('_ident_switch_form_enabled', rcube_utils::INPUT_POST))
+				return $args;
+
+		$data = self::check_field_values();
+		if ($data['err'])
 		{
-			// Do we need to update pwd?
+			$this->add_texts('localization');
-			$fPass = rcube_utils::get_input_value('_ident_switch_form_password', rcube_utils::INPUT_POST);
+			$args['abort'] = true;
-			if ($fPass != $r['password'])
+			$args['message'] = 'ident_switch.err.' . $data['err'];
-				$fPass = $rc->encrypt($fPass);
+		}
 
-			$rc->db->query(
+		// Save data for _after (cannot pass with $args)
-				$sql,
+		$_SESSION['createData' . self::MY_POSTFIX] = $data;
-				$flags,
+
-				$fLabel,
+		return $args;
-				$fHost,
+	}
-				$fPort,
+
-				$fUser,
+	function on_identity_create_after($args)
-				$fPass,
+	{
-				$fDelim,
+		$rc = rcmail::get_instance();
-				$rc->user->ID,
+
-				$args['id'],
+		// Do not do anything for default identity
-				$r['id']
+		if (strcasecmp($args['record']['email'], $rc->user->data['username']) === 0)
-			);
+			return $args;
+
+		$data = $_SESSION['createData' . self::MY_POSTFIX];
+
+		unset($_SESSION['createData' . self::MY_POSTFIX]);
+		if (!$data || count($data) == 0)
+			self::write_log('Object with ident_switch values not found in session for ID = ' . $args['id'] . '.');
+		else
+		{
+			$data['id'] = $args['id'];
+			self::save_field_values($rc, $data);
 		}
 
 		return $args;
@@ -332,11 +299,11 @@ class ident_switch extends rcube_plugin
 	{
 		$rc = rcmail::get_instance();
 
-		$sql = 'DELETE FROM ' . $rc->db->table_name($this->table) . ' WHERE iid = ? AND user_id = ?';
+		$sql = 'DELETE FROM ' . $rc->db->table_name(self::TABLE) . ' WHERE iid = ? AND user_id = ?';
 		$q = $rc->db->query($sql, $args['id'], $rc->user->ID);
 
 		if ($rc->db->affected_rows($q))
-			$rc->write_log($this->my_log, 'Deleted associated information for identity with ID = ' . $args['id'] . '.');
+			self::write_log('Deleted associated information for identity with ID = ' . $args['id'] . '.');
 
 		return $args;
 	}
@@ -348,29 +315,126 @@ class ident_switch extends rcube_plugin
 			$rc = rcmail::get_instance();
 			if (strcasecmp($_SESSION['username'], $rc->user->data['username']) !== 0)
 			{
-				if (isset($_SESSION['iid' . $this->my_postfix]))
+				if (isset($_SESSION['iid' . self::MY_POSTFIX]))
-					$rc->output->add_script('plugin_switchIdent_fixIdent(' . $_SESSION['iid' . $this->my_postfix] . ');', 'docready');
+					$rc->output->add_script('plugin_switchIdent_fixIdent(' . $_SESSION['iid' . self::MY_POSTFIX] . ');', 'docready');
 				else
-					$rc->write_log($this->my_log, 'Special session variable with active identity ID not found.');
+					self::write_log('Special session variable with active identity ID not found.');
 			}
 		}
 	}
 
+	private static function check_field_values()
+	{
+		$retVal = array();
+
+		$retVal['label'] = self::ntrim(rcube_utils::get_input_value('_ident_switch_form_label', rcube_utils::INPUT_POST));
+		if (strlen($retVal['label']) > 32)
+			$retVal['err'] = 'label.long';
+		else
+		{
+			$retVal['host'] = self::ntrim(rcube_utils::get_input_value('_ident_switch_form_host', rcube_utils::INPUT_POST));
+			if (strlen($retVal['host']) > 64)
+				$retVal['err'] = 'host.long';
+			else
+			{
+				$retVal['port'] = self::ntrim(rcube_utils::get_input_value('_ident_switch_form_port', rcube_utils::INPUT_POST));
+				if ($retVal['port'] && !ctype_digit($retVal['port']))
+					$retVal['err'] = 'port.num';
+				else
+				{
+					if ($retVal['port'] && ($retVal['port'] <= 0 || $retVal['port'] > 65535))
+						$retVal['err'] = 'port.range';
+					else
+					{
+						$retVal['user'] = self::ntrim(rcube_utils::get_input_value('_ident_switch_form_username', rcube_utils::INPUT_POST));
+						if (strlen($retVal['user']) > 64)
+							$retVal['err'] = 'user.long';
+						else
+						{
+							$retVal['delim'] = self::ntrim(rcube_utils::get_input_value('_ident_switch_form_delimiter', rcube_utils::INPUT_POST));
+							if (strlen($retVal['delim']) > 1)
+								$retVal['err'] = 'delim.long';
+						}
+					}
+				}
+			}
+		}
+
+		// Get also password
+		$retVal['pass'] = rcube_utils::get_input_value('_ident_switch_form_password', rcube_utils::INPUT_POST);
+
+		// Parse secure settings
+		$retVal['flags'] = self::DB_ENABLED;
+		$ssl = rcube_utils::get_input_value('_ident_switch_form_secure', rcube_utils::INPUT_POST);
+		if (strcasecmp($ssl, 'tls') === 0)
+			$retVal['flags'] |= self::DB_SECURE_TLS;
+		elseif (strcasecmp($ssl, 'ssl') === 0)
+			$retVal['flags'] |= self::DB_SECURE_SSL;
+
+		return $retVal;
+	}
+
+
+	private static function save_field_values($rc, $data)
+	{
+		$sql = 'SELECT id, password FROM ' . $rc->db->table_name(self::TABLE) . ' WHERE iid = ? AND user_id = ?';
+		$q = $rc->db->query($sql, $data['id'], $rc->user->ID);
+		$r = $rc->db->fetch_assoc($q);
+		if ($r)
+		{ // Record already exists, will update it
+			$sql = 'UPDATE ' .
+				$rc->db->table_name(self::TABLE) .
+				' SET flags = ?, label = ?, host = ?, port = ?, username = ?, password = ?, delimiter = ?, user_id = ?, iid = ?' .
+				' WHERE id = ?';
+		}
+		else if ($data['flags'] & self::DB_ENABLED)
+		{ // No record exists, create new one
+			$sql = 'INSERT INTO ' .
+				$rc->db->table_name(self::TABLE) .
+				'(flags, label, host, port, username, password, delimiter, user_id, iid) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)';
+		}
+
+		if ($sql)
+		{
+			// Do we need to update pwd?
+			if ($data['pass'] != $r['password'])
+				$data['pass'] = $rc->encrypt($data['pass']);
+
+			$rc->db->query(
+				$sql,
+				$data['flags'],
+				$data['label'],
+				$data['host'],
+				$data['port'],
+				$data['user'],
+				$data['pass'],
+				$data['delim'],
+				$rc->user->ID,
+				$data['id'],
+				$r['id']
+			);
+
+			return true;
+		}
+
+		return false;
+	}
+
 	function on_switch()
 	{
 		$rc = rcmail::get_instance();
 
-		$my_postfix_len = strlen($this->my_postfix);
+		$my_postfix_len = strlen(self::MY_POSTFIX);
 		$identId = rcube_utils::get_input_value('_ident-id', rcube_utils::INPUT_POST);
 
 		if (-1 == $identId)
 		{ // Switch to main account
-			$rc->write_log($this->my_log, 'Switching mailbox back to default.');
+			self::write_log('Switching mailbox back to default.');
 
 			// Restore everything with STORAGE*my_postfix
 			foreach ($_SESSION as $k => $v)
 			{
-				if (strncasecmp($k, 'storage', 7) === 0 && substr_compare($k, $this->my_postfix, -$my_postfix_len, $my_postfix_len) === 0)
+				if (strncasecmp($k, 'storage', 7) === 0 && substr_compare($k, self::MY_POSTFIX, -$my_postfix_len, $my_postfix_len) === 0)
 				{
 					$realKey = substr($k, 0, -$my_postfix_len);
 					$_SESSION[$realKey] = $_SESSION[$k];
@@ -378,12 +442,12 @@ class ident_switch extends rcube_plugin
 				}
 			}
 			$_SESSION['username'] = $rc->user->data['username'];
-			$_SESSION['password'] = $_SESSION['password' . $this->my_postfix];
+			$_SESSION['password'] = $_SESSION['password' . self::MY_POSTFIX];
-			$_SESSION['iid' . $this->my_postfix] = -1;
+			$_SESSION['iid' . self::MY_POSTFIX] = -1;
 		}
 		else
 		{
-			$sql = 'SELECT host, flags, port, username, password, iid FROM ' . $rc->db->table_name($this->table) . ' WHERE id = ? AND user_id = ?';
+			$sql = 'SELECT host, flags, port, username, password, iid FROM ' . $rc->db->table_name(self::TABLE) . ' WHERE id = ? AND user_id = ?';
 			$q = $rc->db->query($sql, $identId ,$rc->user->ID);
 			$r = $rc->db->fetch_assoc($q);
 			if (is_array($r))
@@ -397,19 +461,16 @@ class ident_switch extends rcube_plugin
 					$r['username'] = $rIid['email'];
 				}
 
-				$rc->write_log(
+				self::write_log('Switching mailbox to one for identity with ID = ' . $r['iid'] . ' (username = \'' . $r['username'] . '\').');
-					$this->my_log,
-					'Switching mailbox to one for identity with ID = ' . $r['iid'] . ' (username = \'' . $r['username'] . '\').'
-				);
 
 				$def_port = 143; // Default port here!
 				$ssl = null;
-				if ($r['flags'] & $this->db_secure_tls)
+				if ($r['flags'] & self::DB_SECURE_TLS)
 				{
 					$ssl = 'tls';
 					$def_port = 143; // Default TLS port here!
 				}
-				elseif ($r['flags'] & $this->db_secure_ssl)
+				elseif ($r['flags'] & self::DB_SECURE_SSL)
 				{
 					$ssl = 'ssl';
 					$def_port = 993; // Default SSL port here!
@@ -425,30 +486,30 @@ class ident_switch extends rcube_plugin
 				{
 					foreach ($_SESSION as $k => $v)
 					{
-						if (strncasecmp($k, 'storage', 7) === 0 && substr_compare($k, $this->my_postfix, -$my_postfix_len, $my_postfix_len) !== 0)
+						if (strncasecmp($k, 'storage', 7) === 0 && substr_compare($k, self::MY_POSTFIX, -$my_postfix_len, $my_postfix_len) !== 0)
 						{
-							if (!$_SESSION[$k . $this->my_postfix])
+							if (!$_SESSION[$k . self::MY_POSTFIX])
-								$_SESSION[$k . $this->my_postfix] = $_SESSION[$k];
+								$_SESSION[$k . self::MY_POSTFIX] = $_SESSION[$k];
                             $rc->session->remove($k);
 						}
 					}
 				}
-				if (!$_SESSION['password' . $this->my_postfix])
+				if (!$_SESSION['password' . self::MY_POSTFIX])
-					$_SESSION['password' . $this->my_postfix] = $_SESSION['password'];
+					$_SESSION['password' . self::MY_POSTFIX] = $_SESSION['password'];
 
 				$_SESSION['storage_host'] = $r['host'] ? $r['host'] : 'localhost'; // Default host here!
 				$_SESSION['storage_ssl'] = $ssl;
 				$_SESSION['storage_port'] = $port;
 				$_SESSION['username'] = $r['username'];
 				$_SESSION['password'] = $r['password'];
-				$_SESSION['iid' . $this->my_postfix] = $r['iid'];
+				$_SESSION['iid' . self::MY_POSTFIX] = $r['iid'];
 
 				$rc->session->remove('folders');
 			}
 			else
 			{
 				// TODO: Show message in browser
-				$rc->write_log($this->my_log, 'Requested remote mailbox with ID = ' . $identId . ' not found.');
+				self::write_log('Requested remote mailbox with ID = ' . $identId . ' not found.');
 				return;
 			}
 		}
@@ -461,21 +522,20 @@ class ident_switch extends rcube_plugin
 		);
 	}
 
-	protected function sw_imap_off($iid)
+	private static function sw_imap_off($iid)
 	{
 		$rc = rcmail::get_instance();
 		
-		$sql = 'UPDATE ' . $rc->db->table_name($this->table) . ' SET flags = flags & ? WHERE iid = ? AND user_id = ?';
+		$sql = 'UPDATE ' . $rc->db->table_name(self::TABLE) . ' SET flags = flags & ? WHERE iid = ? AND user_id = ?';
-		$rc->db->query($sql, ~$this->db_enabled, $iid, $rc->user->ID);
+		$rc->db->query($sql, ~self::DB_ENABLED, $iid, $rc->user->ID);
 	}
 
-	protected function get_preconfig($email)
+	private function get_preconfig($email)
 	{
 		$dom = substr(strstr($email, '@'), 1);
 		if (!$dom)
 			return false;
 
-		//$this->load_config('config.inc.php.dist'); Don't need it yet
 		$this->load_config(); // config.inc.php
 
 		$cfg = rcmail::get_instance()->config->get('ident_switch.preconfig', array());
@@ -489,16 +549,13 @@ class ident_switch extends rcube_plugin
 		return $cfg;
 	}
 
-	protected function apply_preconfig(&$record)
+	private function apply_preconfig(&$record)
 	{
 		$email = $record['email'];
 		$cfg = $this->get_preconfig($email);
 		if (is_array($cfg))
 		{
-			rcmail::get_instance()->write_log(
+			self::write_log('Applying predefined configuration for \'' . $email . '\'.');
-				$this->my_log,
-				'Applying predefined configuration for \'' . $email . '\'.'
-			);
 
 			if ($cfg['host'])
 			{ // Parse and set host and related
@@ -542,7 +599,7 @@ class ident_switch extends rcube_plugin
 		}
 	}
 
-	protected static function ntrim($str)
+	private static function ntrim($str)
 	{
 		if (is_null($str))
 			return $str;
@@ -553,4 +610,9 @@ class ident_switch extends rcube_plugin
 
 		return $s;
 	}
+
+	private static function write_log($txt)
+	{
+		rcmail::get_instance()->write_log('ident_switch', $txt);
+	}
 }