setup_cmd_database::connect() - Code Metrics - Inspection of "fix regexp to only match beginning of string" - EGroupware/egroupware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 16.1 ( ffd2d1...0b384f )

by Ralf

created 2017-03-09 15:48 UTC

setup_cmd_database::connect() B

↳ Parent: setup_cmd_database

Complexity

Conditions	5
Paths	4

Size

Total Lines	23
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	13
nc	4
nop	3
dl	0
loc	23
rs	8.5906
c	0
b	0
f	0

<?php
/**
 * eGgroupWare setup - test or create the database
 *
 * @link http://www.egroupware.org
 * @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
 * @package setup
 * @copyright (c) 2007-16 by Ralf Becker <RalfBecker-AT-outdoor-training.de>
 * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
 * @version $Id$
 */

use EGroupware\Api;

/**
 * setup command: test or create the database
 */
class setup_cmd_database extends setup_cmd
{
	/**
	 * Allow to run this command via setup-cli
	 */
	const SETUP_CLI_CALLABLE = true;

	/**
	 * Maximum length of database name (at least for MySQL this is the limit)
	 *
	 * @var int
	 */
	const MAX_DB_NAME_LEN = 16;

	/**
	 * Instance of Api\Db to connect or create the db
	 *
	 * @var Api\Db
	 */
	private $test_db;

	/**
	 * Constructor
	 *
	 * @param string/array $domain domain-name to customize the defaults or array with all parameters
	 * @param string $db_type db-type (mysql, pgsql, ...)
	 * @param string $db_host =null
	 * @param string $db_port =null
	 * @param string $db_name =null
	 * @param string $db_user =null
	 * @param string $db_pass =null
	 * @param string $db_root =null
	 * @param string $db_root_pw =null
	 * @param string $sub_command ='create_db' 'create_db', 'test_db', 'test_db_root'
	 * @param string $db_grant_host ='localhost' host/ip of webserver for grant
	 * @param boolean $make_db_name_unique =false true: if create fails because db exists,
	 * 	try creating a unique name by shortening the name and adding a number to it
	 */
	function __construct($domain,$db_type=null,$db_host=null,$db_port=null,$db_name=null,$db_user=null,$db_pass=null,
		$db_root=null,$db_root_pw=null,$sub_command='create_db',$db_grant_host='localhost',$make_db_name_unique=false)
	{
		if (!is_array($domain))
		{
			$data = array(
				'domain'  => $domain,
				'db_type' => $db_type,
				'db_host' => $db_host,
				'db_port' => $db_port,
				'db_name' => $db_name,
				'db_user' => $db_user,
				'db_pass' => $db_pass,
				'db_root' => $db_root,
				'db_root_pw' => $db_root_pw,
				'sub_command' => $sub_command,
				'db_grant_host' => $db_grant_host,
				'make_db_name_unique' => $make_db_name_unique,
			);
		}
		else
		{
			$data = $domain;
		}
		// need to incorporate correct defaults for given database type
		admin_cmd::__construct(array_merge(self::defaults($data['db_type']), array_diff($data, array(null))));
	}

	/**
	 * run the command: test or create database
	 *
	 * @param boolean $check_only =false only run the checks (and throw the exceptions), but not the command itself
	 * @return string success message
	 * @throws Exception(lang('Wrong credentials to access the header.inc.php file!'),2);
	 * @throws Exception('header.inc.php not found!');
	 */
	protected function exec($check_only=false)
	{
		if (!empty($this->domain) && !preg_match('/^([a-z0-9_-]+\.)*[a-z0-9]+/i',$this->domain))
		{
			throw new Api\Exception\WrongUserinput(lang("'%1' is no valid domain name!",$this->domain));
		}
		if ($this->remote_id && $check_only) return true;	// further checks can only done locally

		$this->_merge_defaults();
		//_debug_array($this->as_array());

		try {
			switch($this->sub_command)
			{
				case 'test_db_root':
					$msg = $this->connect($this->db_root,$this->db_root_pw,$this->db_meta);
					break;
				case 'test_db':
					$msg = $this->connect();
					break;
				case 'drop':
					$msg = $this->drop();
					break;
				case 'create_db':
				default:
					$msg = $this->create();
					break;
			}
		}
		catch (Exception $e) {
			// we catch the exception to properly restore the db
		}
		$this->restore_db();

		if ($e)
		{
			throw $e;
		}
		return $msg;
	}

	/**
	 * Connect to database
	 *
	 * @param string $user =null default $this->db_user
	 * @param string $pass =null default $this->db_pass
	 * @param string $name =null default $this->db_name
	 * @throws Api\Exception\WrongUserinput Can not connect to database ...
	 */
	private function connect($user=null,$pass=null,$name=null)
	{
		// propagate all db_* vars
		$this->test_db = new Api\Db(get_object_vars($this));

		$error_rep = error_reporting();
		error_reporting($error_rep & ~E_WARNING);	// switch warnings off, in case they are on
		try {
			$this->test_db->connect($name, null, null, $user, $pass);
		}
		catch (Exception $e) {
			// just give a nicer error, after switching error_reporting on again
		}
		error_reporting($error_rep);

		if ($e)
		{
			throw new Api\Exception\WrongUserinput(lang('Can not connect to %1 database %2 on host %3 using user %4!',
				$this->db_type,$name,$this->db_host.($this->db_port?':'.$this->db_port:''),$user).' ('.$e->getMessage().')');
		}
		return lang('Successful connected to %1 database %2 on %3 using user %4.',
				$this->db_type,$name,$this->db_host.($this->db_port?':'.$this->db_port:''),$user);
	}

	/**
	 * Check and if does not yet exist create the new database and user
	 *
	 * The check will fail if the database exists, but already contains tables
	 *
	 * if $this->make_db_name_unique is set, a decrementing nummeric prefix gets
	 * added to $this->db_name AND $this->db_user, if db already exists.
	 *
	 * @return string with success message
	 * @throws Api\Exception\WrongUserinput
	 */
	private function create()
	{
		static $try_make_unique = 0;	// to limit trials to create a unique name

		// shorten db-name/-user to self::MAX_DB_NAME_LEN chars
		if ($this->make_db_name_unique && strlen($this->db_name) > self::MAX_DB_NAME_LEN)
		{
			$this->set_defaults['db_name'] = $this->db_name =
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
			$this->set_defaults['db_user'] = $this->db_user = // change user too (otherwise existing user/db could not connect any more!)
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
				substr(str_replace(array('.', '-'), '_', $this->db_name),0,self::MAX_DB_NAME_LEN);
		}
		try {
			$msg = $this->connect();
		}
		catch (Api\Exception\WrongUserinput $e) {
			// db or user not working --> connect as root and create it
			try {
				$this->test_db->create_database($this->db_root,$this->db_root_pw,$this->db_charset,$this->db_grant_host);
				$this->connect();
			}
			catch(Api\Db\Exception $e) {	// catches failed to create database
				// try connect as root to check if wrong root/root_pw is the problem
				$this->connect($this->db_root,$this->db_root_pw,$this->db_meta);

				// if we should create a db with a unique name (try it only N times, not endless!)
				if ($this->make_db_name_unique && $try_make_unique++ < 20)
				{
					// check if we can connect as root to the db to create --> db exists already
					try {
						$this->connect($this->db_root,$this->db_root_pw);
						// create new db_name by incrementing an existing numeric postfix
						$matches = null;
						if (preg_match('/([0-9]+)$/',$this->db_name,$matches))
						{
							$num = (string)(++$matches[1]);
						}
						else	// or adding one starting with 2
						{
							$num = '2';
						}
						$this->set_defaults['db_name'] = $this->db_name =
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
						$this->set_defaults['db_user'] = $this->db_user = // change user too (otherwise existing user/db could not connect any more!)
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
							substr($this->db_name,0,self::MAX_DB_NAME_LEN-strlen($num)).$num;

						return $this->create();
					}
					catch (Api\Exception\WrongUserinput $e2)
					{
						// we can NOT connect to db as root --> ignore exception to give general error
					}
				}
				// if not give general error
				throw new Api\Exception\WrongUserinput(lang('Can not create %1 database %2 on %3 for user %4!',
					$this->db_type,$this->db_name,$this->db_host.($this->db_port?':'.$this->db_port:''),$this->db_user));
			}
			$msg = lang('Successful connected to %1 on %3 and created database %2 for user %4.',
					$this->db_type,$this->db_name,$this->db_host.($this->db_port?':'.$this->db_port:''),$this->db_user);
		}
		// check if it already contains tables
		if (($tables = $this->test_db->table_names()))
		{
			foreach($tables as &$table)
			{
				$table = $table['table_name'];
			}
			throw new Api\Exception\WrongUserinput(lang('%1 database %2 on %3 already contains the following tables:',
				$this->db_type,$this->db_name,$this->db_host.($this->db_port?':'.$this->db_port:'')).' '.
				implode(', ',$tables));
		}
		return $msg;
	}

	/**
	 * Drop database and user
	 *
	 * @return string with success message
	 * @throws Api\Exception\WrongUserinput
	 * @throws Api\Db\Exception if database not exist
	 */
	private function drop()
	{
		$this->connect($this->db_root,$this->db_root_pw,$this->db_meta);
		$this->test_db->query('DROP DATABASE '.$this->test_db->name_quote($this->db_name),__LINE__,__FILE__);
		$msg = lang('Datebase %1 droped.',$this->db_name);
		try {
			$this->test_db->query('DROP USER '.$this->test_db->quote($this->db_user).'@'.
				$this->test_db->quote($this->db_grant_host?$this->db_grant_host:'%'),__LINE__,__FILE__);
		}
		catch (Api\Db\Exception $e) {
			unset($e);
			// we make this no fatal error, as the granthost might be something else ...
			$msg .= ' '.lang('Error dropping User!');
		}
		return $msg;
	}

	/**
	 * Return default database settings for a given domain
	 *
	 * @param string $db_type ='mysqli'
	 * @return array
	 */
	static function defaults($db_type='mysqli')
	{
		switch($db_type)
		{
			case 'mysql':
			default:
				$db_type = $meta_db = 'mysql';
				break;
			case 'pgsql':
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
				$meta_db = 'template1';
				break;
		}
		return array(
			'db_type' => $db_type,
			'db_host' => 'localhost',
			'db_port' => 3306,
			'db_name' => 'egw_$domain',
			'db_user' => 'egw_$domain',
			'db_pass' => self::randomstring(),
			'db_root' => 'root',
			'db_root_pw' => '',	// not really a default
			'db_meta' => $meta_db,
			'db_charset' => 'utf-8',
			'db_grant_host' => 'localhost',
		);
	}

	/**
	 * Merges the default into the current properties, if they are empty or contain placeholders
	 */
	private function _merge_defaults()
	{
		foreach(self::defaults() as $name => $default)
		{
			if (!$this->$name)
			{
				//echo "<p>setting $name='{$this->$name}' to it's default='$default'</p>\n";
				$this->set_defaults[$name] = $this->$name = $default;
			}
			if (strpos($this->$name,'$domain') !== false)
			{
				// limit names to 16 chars (16 char is user-name limit in MySQL)
				$this->set_defaults[$name] = $this->$name =
					substr(str_replace(array('$domain','.','-'),array($this->domain,'_','_'),$this->$name),
					0,self::MAX_DB_NAME_LEN);
			}
		}
	}
}


1		<?php
2		/**
3		* eGgroupWare setup - test or create the database
4		*
5		* @link http://www.egroupware.org
6		* @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
7		* @package setup
8		* @copyright (c) 2007-16 by Ralf Becker <RalfBecker-AT-outdoor-training.de>
9		* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
10		* @version $Id$
11		*/
12
13		use EGroupware\Api;
14
15		/**
16		* setup command: test or create the database
17		*/
18		class setup_cmd_database extends setup_cmd
19		{
20		/**
21		* Allow to run this command via setup-cli
22		*/
23		const SETUP_CLI_CALLABLE = true;
24
25		/**
26		* Maximum length of database name (at least for MySQL this is the limit)
27		*
28		* @var int
29		*/
30		const MAX_DB_NAME_LEN = 16;
31
32		/**
33		* Instance of Api\Db to connect or create the db
34		*
35		* @var Api\Db
36		*/
37		private $test_db;
38
39		/**
40		* Constructor
41		*
42		* @param string/array $domain domain-name to customize the defaults or array with all parameters
43		* @param string $db_type db-type (mysql, pgsql, ...)
44		* @param string $db_host =null
45		* @param string $db_port =null
46		* @param string $db_name =null
47		* @param string $db_user =null
48		* @param string $db_pass =null
49		* @param string $db_root =null
50		* @param string $db_root_pw =null
51		* @param string $sub_command ='create_db' 'create_db', 'test_db', 'test_db_root'
52		* @param string $db_grant_host ='localhost' host/ip of webserver for grant
53		* @param boolean $make_db_name_unique =false true: if create fails because db exists,
54		* try creating a unique name by shortening the name and adding a number to it
55		*/
56		function __construct($domain,$db_type=null,$db_host=null,$db_port=null,$db_name=null,$db_user=null,$db_pass=null,
57		$db_root=null,$db_root_pw=null,$sub_command='create_db',$db_grant_host='localhost',$make_db_name_unique=false)
58		{
59		if (!is_array($domain))
60		{
61		$data = array(
62		'domain' => $domain,
63		'db_type' => $db_type,
64		'db_host' => $db_host,
65		'db_port' => $db_port,
66		'db_name' => $db_name,
67		'db_user' => $db_user,
68		'db_pass' => $db_pass,
69		'db_root' => $db_root,
70		'db_root_pw' => $db_root_pw,
71		'sub_command' => $sub_command,
72		'db_grant_host' => $db_grant_host,
73		'make_db_name_unique' => $make_db_name_unique,
74		);
75		}
76		else
77		{
78		$data = $domain;
79		}
80		// need to incorporate correct defaults for given database type
81		admin_cmd::__construct(array_merge(self::defaults($data['db_type']), array_diff($data, array(null))));
82		}
83
84		/**
85		* run the command: test or create database
86		*
87		* @param boolean $check_only =false only run the checks (and throw the exceptions), but not the command itself
88		* @return string success message
89		* @throws Exception(lang('Wrong credentials to access the header.inc.php file!'),2);
90		* @throws Exception('header.inc.php not found!');
91		*/
92		protected function exec($check_only=false)
93		{
94	View Code Duplication	if (!empty($this->domain) && !preg_match('/^([a-z0-9_-]+\.)*[a-z0-9]+/i',$this->domain))
95		{
96		throw new Api\Exception\WrongUserinput(lang("'%1' is no valid domain name!",$this->domain));
97		}
98		if ($this->remote_id && $check_only) return true; // further checks can only done locally
99
100		$this->_merge_defaults();
101		//_debug_array($this->as_array());
102
103		try {
104		switch($this->sub_command)
105		{
106		case 'test_db_root':
107		$msg = $this->connect($this->db_root,$this->db_root_pw,$this->db_meta);
108		break;
109		case 'test_db':
110		$msg = $this->connect();
111		break;
112		case 'drop':
113		$msg = $this->drop();
114		break;
115		case 'create_db':
116		default:
117		$msg = $this->create();
118		break;
119		}
120		}
121		catch (Exception $e) {
122		// we catch the exception to properly restore the db
123		}
124		$this->restore_db();
125
126		if ($e)
127		{
128		throw $e;
129		}
130		return $msg;
131		}
132
133		/**
134		* Connect to database
135		*
136		* @param string $user =null default $this->db_user
137		* @param string $pass =null default $this->db_pass
138		* @param string $name =null default $this->db_name
139		* @throws Api\Exception\WrongUserinput Can not connect to database ...
140		*/
141		private function connect($user=null,$pass=null,$name=null)
142		{
143		// propagate all db_* vars
144		$this->test_db = new Api\Db(get_object_vars($this));
145
146		$error_rep = error_reporting();
147		error_reporting($error_rep & ~E_WARNING); // switch warnings off, in case they are on
148		try {
149		$this->test_db->connect($name, null, null, $user, $pass);
150		}
151		catch (Exception $e) {
152		// just give a nicer error, after switching error_reporting on again
153		}
154		error_reporting($error_rep);
155
156		if ($e)
157		{
158		throw new Api\Exception\WrongUserinput(lang('Can not connect to %1 database %2 on host %3 using user %4!',
159		$this->db_type,$name,$this->db_host.($this->db_port?':'.$this->db_port:''),$user).' ('.$e->getMessage().')');
160		}
161		return lang('Successful connected to %1 database %2 on %3 using user %4.',
162		$this->db_type,$name,$this->db_host.($this->db_port?':'.$this->db_port:''),$user);
163		}
164
165		/**
166		* Check and if does not yet exist create the new database and user
167		*
168		* The check will fail if the database exists, but already contains tables
169		*
170		* if $this->make_db_name_unique is set, a decrementing nummeric prefix gets
171		* added to $this->db_name AND $this->db_user, if db already exists.
172		*
173		* @return string with success message
174		* @throws Api\Exception\WrongUserinput
175		*/
176		private function create()
177		{
178		static $try_make_unique = 0; // to limit trials to create a unique name
179
180		// shorten db-name/-user to self::MAX_DB_NAME_LEN chars
181		if ($this->make_db_name_unique && strlen($this->db_name) > self::MAX_DB_NAME_LEN)
182		{
183		$this->set_defaults['db_name'] = $this->db_name =
		0 ignored issues – show Documentation introduced 2016-05-29 12:41 UTC by Report Bug Copy Issue Report The property `db_name` does not exist on `object<setup_cmd_database>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
184		$this->set_defaults['db_user'] = $this->db_user = // change user too (otherwise existing user/db could not connect any more!)
		0 ignored issues – show Documentation introduced 2016-05-29 12:41 UTC by Report Bug Copy Issue Report The property `db_user` does not exist on `object<setup_cmd_database>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
185		substr(str_replace(array('.', '-'), '_', $this->db_name),0,self::MAX_DB_NAME_LEN);
186		}
187		try {
188		$msg = $this->connect();
189		}
190		catch (Api\Exception\WrongUserinput $e) {
191		// db or user not working --> connect as root and create it
192		try {
193		$this->test_db->create_database($this->db_root,$this->db_root_pw,$this->db_charset,$this->db_grant_host);
194		$this->connect();
195		}
196		catch(Api\Db\Exception $e) { // catches failed to create database
197		// try connect as root to check if wrong root/root_pw is the problem
198		$this->connect($this->db_root,$this->db_root_pw,$this->db_meta);
199
200		// if we should create a db with a unique name (try it only N times, not endless!)
201		if ($this->make_db_name_unique && $try_make_unique++ < 20)
202		{
203		// check if we can connect as root to the db to create --> db exists already
204		try {
205		$this->connect($this->db_root,$this->db_root_pw);
206		// create new db_name by incrementing an existing numeric postfix
207		$matches = null;
208		if (preg_match('/([0-9]+)$/',$this->db_name,$matches))
209		{
210		$num = (string)(++$matches[1]);
211		}
212		else // or adding one starting with 2
213		{
214		$num = '2';
215		}
216		$this->set_defaults['db_name'] = $this->db_name =
		0 ignored issues – show Documentation introduced 2016-05-29 12:41 UTC by Report Bug Copy Issue Report The property `db_name` does not exist on `object<setup_cmd_database>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
217		$this->set_defaults['db_user'] = $this->db_user = // change user too (otherwise existing user/db could not connect any more!)
		0 ignored issues – show Documentation introduced 2016-05-29 12:41 UTC by Report Bug Copy Issue Report The property `db_user` does not exist on `object<setup_cmd_database>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
218		substr($this->db_name,0,self::MAX_DB_NAME_LEN-strlen($num)).$num;
219
220		return $this->create();
221		}
222		catch (Api\Exception\WrongUserinput $e2)
223		{
224		// we can NOT connect to db as root --> ignore exception to give general error
225		}
226		}
227		// if not give general error
228		throw new Api\Exception\WrongUserinput(lang('Can not create %1 database %2 on %3 for user %4!',
229		$this->db_type,$this->db_name,$this->db_host.($this->db_port?':'.$this->db_port:''),$this->db_user));
230		}
231		$msg = lang('Successful connected to %1 on %3 and created database %2 for user %4.',
232		$this->db_type,$this->db_name,$this->db_host.($this->db_port?':'.$this->db_port:''),$this->db_user);
233		}
234		// check if it already contains tables
235		if (($tables = $this->test_db->table_names()))
236		{
237		foreach($tables as &$table)
238		{
239		$table = $table['table_name'];
240		}
241		throw new Api\Exception\WrongUserinput(lang('%1 database %2 on %3 already contains the following tables:',
242		$this->db_type,$this->db_name,$this->db_host.($this->db_port?':'.$this->db_port:'')).' '.
243		implode(', ',$tables));
244		}
245		return $msg;
246		}
247
248		/**
249		* Drop database and user
250		*
251		* @return string with success message
252		* @throws Api\Exception\WrongUserinput
253		* @throws Api\Db\Exception if database not exist
254		*/
255		private function drop()
256		{
257		$this->connect($this->db_root,$this->db_root_pw,$this->db_meta);
258		$this->test_db->query('DROP DATABASE '.$this->test_db->name_quote($this->db_name),__LINE__,__FILE__);
259		$msg = lang('Datebase %1 droped.',$this->db_name);
260		try {
261		$this->test_db->query('DROP USER '.$this->test_db->quote($this->db_user).'@'.
262		$this->test_db->quote($this->db_grant_host?$this->db_grant_host:'%'),__LINE__,__FILE__);
263		}
264		catch (Api\Db\Exception $e) {
265		unset($e);
266		// we make this no fatal error, as the granthost might be something else ...
267		$msg .= ' '.lang('Error dropping User!');
268		}
269		return $msg;
270		}
271
272		/**
273		* Return default database settings for a given domain
274		*
275		* @param string $db_type ='mysqli'
276		* @return array
277		*/
278		static function defaults($db_type='mysqli')
279		{
280		switch($db_type)
281		{
282		case 'mysql':
283		default:
284		$db_type = $meta_db = 'mysql';
285		break;
286		case 'pgsql':
		0 ignored issues – show Unused Code introduced 2016-05-29 12:41 UTC by Report Bug Copy Issue Report `case 'pgsql': $meta_...'template1'; break;` does not seem to be reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
287		$meta_db = 'template1';
288		break;
289		}
290		return array(
291		'db_type' => $db_type,
292		'db_host' => 'localhost',
293		'db_port' => 3306,
294		'db_name' => 'egw_$domain',
295		'db_user' => 'egw_$domain',
296		'db_pass' => self::randomstring(),
297		'db_root' => 'root',
298		'db_root_pw' => '', // not really a default
299		'db_meta' => $meta_db,
300		'db_charset' => 'utf-8',
301		'db_grant_host' => 'localhost',
302		);
303		}
304
305		/**
306		* Merges the default into the current properties, if they are empty or contain placeholders
307		*/
308		private function _merge_defaults()
309		{
310		foreach(self::defaults() as $name => $default)
311		{
312		if (!$this->$name)
313		{
314		//echo "<p>setting $name='{$this->$name}' to it's default='$default'</p>\n";
315		$this->set_defaults[$name] = $this->$name = $default;
316		}
317		if (strpos($this->$name,'$domain') !== false)
318		{
319		// limit names to 16 chars (16 char is user-name limit in MySQL)
320		$this->set_defaults[$name] = $this->$name =
321		substr(str_replace(array('$domain','.','-'),array($this->domain,'_','_'),$this->$name),
322		0,self::MAX_DB_NAME_LEN);
323		}
324		}
325		}
326		}
327

EGroupware / egroupware

Push — 16.1 ( ffd2d1...0b384f )

setup_cmd_database::connect() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like