AlterDatabaseToMultiByteCharset::run() - Code Metrics - Elgg/Elgg - Measure and Improve Code Quality continuously with Scrutinizer

AlterDatabaseToMultiByteCharset::run() F
last analyzed 2024-03-25 11:14 UTC

↳ Parent: AlterDatabaseToMultiByteCharset

Complexity

Conditions	16
Paths	506

Size

Total Lines	107
Code Lines	57

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	272

Importance

Changes

Metric	Value
cc	16
eloc	57
nc	506
nop	2
dl	0
loc	107
ccs	0
cts	61
cp	0
crap	272
rs	2.0861
c	0
b	0
f	0

How to fix Long Method Complexity

<?php

namespace Elgg\Upgrades;

use Elgg\Upgrade\AsynchronousUpgrade;
use Elgg\Upgrade\Result;

/**
 * Updates database charset to utf8mb4
 */
class AlterDatabaseToMultiByteCharset extends AsynchronousUpgrade {

	private $utf8mb4_tables = [
		// InnoDB
		'access_collection_membership',
		'access_collections',
		'annotations',
		'api_users',
		'config',
		'entities',
		'entity_relationships',
		'metadata',
		'private_settings',
		'queue',
		'river',
		'system_log',
		'users_remember_me_cookies',
		'users_sessions',
		// MEMORY
		'hmac_cache',
		'users_apisessions',
	];

	// Columns with utf8 encoding and utf8_general_ci collation
	// $table => [
	//   $column => $index
	// ]

	private $non_mb4_columns = [
		'config' => [
			'name' => [
				'primary' => true,
				'name' => 'name',
				'unique' => false,
			],
		],
		'entities' => [
			'subtype' => [
				'primary' => false,
				'name' => 'subtype',
				'unique' => false,
			],
		],
		'queue' => [
			'name' => [
				'primary' => false,
				'name' => "name",
				'unique' => false,
			],
		],
		'users_sessions' => [
			'session' => [
				'primary' => true,
				'name' => 'session',
				'unique' => false,
			],
		],
		'hmac_cache' => [
			'hmac' => [
				'primary' => true,
				'name' => 'hmac',
				'unique' => false,
			],
		],
		'system_log' => [
			'object_class' => [
				'primary' => false,
				'name' => 'object_class',
				'unique' => false,
			],
			'object_type' => [
				'primary' => false,
				'name' => 'object_type',
				'unique' => false,
			],
			'object_subtype' => [
				'primary' => false,
				'name' => 'object_subtype',
				'unique' => false,
			],
			'event' => [
				'primary' => false,
				'name' => 'event',
				'unique' => false,
			],
			'river_key' => [
				'primary' => false,
				'name' => 'river_key',
				'unique' => false,
				'columns' => ['object_type', 'object_subtype', 'event']
			],
		]
	];

	/**
	 * {@inheritdoc}
	 */
	public function getVersion(): int {
		return 2017080900;
	}

	/**
	 * {@inheritdoc}
	 */
	public function needsIncrementOffset(): bool {
		return false;
	}

	/**
	 * {@inheritdoc}
	 */
	public function shouldBeSkipped(): bool {

		$config = _elgg_services()->dbConfig->getConnectionConfig();
		$rows = _elgg_services()->db->getConnection('read')->executeQuery("SHOW TABLE STATUS FROM `{$config['database']}`");

		$prefixed_table_names = array_map(function ($t) use ($config) {
			return "{$config['prefix']}{$t}";
		}, $this->utf8mb4_tables);

		foreach ($rows->fetchAllAssociative() as $row) {
			$row = (object) $row;
			if (in_array($row->Name, $prefixed_table_names) && $row->Collation !== 'utf8mb4_general_ci') {
				return false;
			}
		}

		return true;
	}

	/**
	 * {@inheritdoc}
	 */
	public function countItems(): int {
		return 1;
	}

	/**
	 * {@inheritdoc}
	 */
	public function run(Result $result, $offset): Result {

		$config = _elgg_services()->dbConfig->getConnectionConfig();

		try {
			// check if we need to change a global variable
			$db_result = _elgg_services()->db->getConnection('read')->executeQuery("SHOW GLOBAL VARIABLES LIKE 'innodb_large_prefix'");
			$rows = $db_result->fetchAllAssociative();
			
			if (empty($rows) || $rows[0]['Value'] === 'OFF') {
				// required to allow bigger index sizes required for utf8mb4
				_elgg_services()->db->getConnection('write')->executeStatement("SET GLOBAL innodb_large_prefix = 'ON'");
			}
		} catch (\Exception $e) {
			// something went wrong, maybe database permissions, or version
			$result->addFailures();
			$result->addError("Failure to set 'innodb_large_prefix'. Ask your database administrator for more information.");
			$result->addError("Alternatively ask the database administrator to (temporarily) set 'innodb_large_prefix' to 'ON'.");
			$result->addError($e->getMessage());
			
			return $result;
		}
		
		try {
			// alter table structure
			$connection = _elgg_services()->db->getConnection('write');
			$connection->executeStatement("
				ALTER DATABASE
    			`{$config['database']}`
    			CHARACTER SET = utf8mb4
    			COLLATE = utf8mb4_unicode_ci
			");

			foreach ($this->utf8mb4_tables as $table) {
				if (!empty($this->non_mb4_columns[$table])) {
					foreach ($this->non_mb4_columns[$table] as $column => $index) {
						if ($index) {
							if ($index['primary']) {
								$connection->executeStatement("
									ALTER TABLE {$config['prefix']}{$table}
									DROP PRIMARY KEY
								");
							} else {
								$connection->executeStatement("
									ALTER TABLE {$config['prefix']}{$table}
									DROP KEY {$index['name']}
								");
							}
						}
					}
				}

				$connection->executeStatement("
					ALTER TABLE {$config['prefix']}{$table}
					ROW_FORMAT=DYNAMIC
				");

				$connection->executeStatement("
					ALTER TABLE {$config['prefix']}{$table}
					CONVERT TO CHARACTER SET utf8mb4
					COLLATE utf8mb4_general_ci
				");

				if (!empty($this->non_mb4_columns[$table])) {
					foreach ($this->non_mb4_columns[$table] as $column => $index) {
						if (empty($index['columns'])) {
							// Alter table only if the key is not composite
							$connection->executeStatement("
								ALTER TABLE {$config['prefix']}{$table}
								MODIFY $column VARCHAR(255)
								CHARACTER SET utf8
								COLLATE utf8_unicode_ci
							");
						}

						if (!$index) {
							continue;
						}

						$sql = "ADD";
						if ($index['unique']) {
							$sql .= " UNIQUE ({$index['name']})";
						} else if ($index['primary']) {
							$sql .= " PRIMARY KEY ({$index['name']})";
						} else {
							$key_columns = elgg_extract('columns', $index, [$column]);
							$key_columns = implode(',', $key_columns);
							$sql .= " KEY {$index['name']} ($key_columns)";
						}

						$connection->executeStatement("
							ALTER TABLE {$config['prefix']}{$table}
							$sql
						");
					}
				}
			}
		} catch (\Exception $e) {
			$result->addFailures();
			$result->addError($e->getMessage());
			
			return $result;
		}

		$result->addSuccesses();

		return $result;
	}
}


1		<?php
2
3		namespace Elgg\Upgrades;
4
5		use Elgg\Upgrade\AsynchronousUpgrade;
6		use Elgg\Upgrade\Result;
7
8		/**
9		* Updates database charset to utf8mb4
10		*/
11		class AlterDatabaseToMultiByteCharset extends AsynchronousUpgrade {
12
13		private $utf8mb4_tables = [
14		// InnoDB
15		'access_collection_membership',
16		'access_collections',
17		'annotations',
18		'api_users',
19		'config',
20		'entities',
21		'entity_relationships',
22		'metadata',
23		'private_settings',
24		'queue',
25		'river',
26		'system_log',
27		'users_remember_me_cookies',
28		'users_sessions',
29		// MEMORY
30		'hmac_cache',
31		'users_apisessions',
32		];
33
34		// Columns with utf8 encoding and utf8_general_ci collation
35		// $table => [
36		// $column => $index
37		// ]
38
39		private $non_mb4_columns = [
40		'config' => [
41		'name' => [
42		'primary' => true,
43		'name' => 'name',
44		'unique' => false,
45		],
46		],
47		'entities' => [
48		'subtype' => [
49		'primary' => false,
50		'name' => 'subtype',
51		'unique' => false,
52		],
53		],
54		'queue' => [
55		'name' => [
56		'primary' => false,
57		'name' => "name",
58		'unique' => false,
59		],
60		],
61		'users_sessions' => [
62		'session' => [
63		'primary' => true,
64		'name' => 'session',
65		'unique' => false,
66		],
67		],
68		'hmac_cache' => [
69		'hmac' => [
70		'primary' => true,
71		'name' => 'hmac',
72		'unique' => false,
73		],
74		],
75		'system_log' => [
76		'object_class' => [
77		'primary' => false,
78		'name' => 'object_class',
79		'unique' => false,
80		],
81		'object_type' => [
82		'primary' => false,
83		'name' => 'object_type',
84		'unique' => false,
85		],
86		'object_subtype' => [
87		'primary' => false,
88		'name' => 'object_subtype',
89		'unique' => false,
90		],
91		'event' => [
92		'primary' => false,
93		'name' => 'event',
94		'unique' => false,
95		],
96		'river_key' => [
97		'primary' => false,
98		'name' => 'river_key',
99		'unique' => false,
100		'columns' => ['object_type', 'object_subtype', 'event']
101		],
102		]
103		];
104
105		/**
106		* {@inheritdoc}
107		*/
108	7	public function getVersion(): int {
109	7	return 2017080900;
110		}
111
112		/**
113		* {@inheritdoc}
114		*/
115		public function needsIncrementOffset(): bool {
116		return false;
117		}
118
119		/**
120		* {@inheritdoc}
121		*/
122		public function shouldBeSkipped(): bool {
123
124		$config = _elgg_services()->dbConfig->getConnectionConfig();
125		$rows = _elgg_services()->db->getConnection('read')->executeQuery("SHOW TABLE STATUS FROM `{$config['database']}`");
126
127		$prefixed_table_names = array_map(function ($t) use ($config) {
128		return "{$config['prefix']}{$t}";
129		}, $this->utf8mb4_tables);
130
131		foreach ($rows->fetchAllAssociative() as $row) {
132		$row = (object) $row;
133		if (in_array($row->Name, $prefixed_table_names) && $row->Collation !== 'utf8mb4_general_ci') {
134		return false;
135		}
136		}
137
138		return true;
139		}
140
141		/**
142		* {@inheritdoc}
143		*/
144		public function countItems(): int {
145		return 1;
146		}
147
148		/**
149		* {@inheritdoc}
150		*/
151		public function run(Result $result, $offset): Result {
152
153		$config = _elgg_services()->dbConfig->getConnectionConfig();
154
155		try {
156		// check if we need to change a global variable
157		$db_result = _elgg_services()->db->getConnection('read')->executeQuery("SHOW GLOBAL VARIABLES LIKE 'innodb_large_prefix'");
158		$rows = $db_result->fetchAllAssociative();
159
160		if (empty($rows) \|\| $rows[0]['Value'] === 'OFF') {
161		// required to allow bigger index sizes required for utf8mb4
162		_elgg_services()->db->getConnection('write')->executeStatement("SET GLOBAL innodb_large_prefix = 'ON'");
163		}
164		} catch (\Exception $e) {
165		// something went wrong, maybe database permissions, or version
166		$result->addFailures();
167		$result->addError("Failure to set 'innodb_large_prefix'. Ask your database administrator for more information.");
168		$result->addError("Alternatively ask the database administrator to (temporarily) set 'innodb_large_prefix' to 'ON'.");
169		$result->addError($e->getMessage());
170
171		return $result;
172		}
173
174		try {
175		// alter table structure
176		$connection = _elgg_services()->db->getConnection('write');
177		$connection->executeStatement("
178		ALTER DATABASE
179		`{$config['database']}`
180		CHARACTER SET = utf8mb4
181		COLLATE = utf8mb4_unicode_ci
182		");
183
184		foreach ($this->utf8mb4_tables as $table) {
185		if (!empty($this->non_mb4_columns[$table])) {
186		foreach ($this->non_mb4_columns[$table] as $column => $index) {
187		if ($index) {
188		if ($index['primary']) {
189		$connection->executeStatement("
190		ALTER TABLE {$config['prefix']}{$table}
191		DROP PRIMARY KEY
192		");
193		} else {
194		$connection->executeStatement("
195		ALTER TABLE {$config['prefix']}{$table}
196		DROP KEY {$index['name']}
197		");
198		}
199		}
200		}
201		}
202
203		$connection->executeStatement("
204		ALTER TABLE {$config['prefix']}{$table}
205		ROW_FORMAT=DYNAMIC
206		");
207
208		$connection->executeStatement("
209		ALTER TABLE {$config['prefix']}{$table}
210		CONVERT TO CHARACTER SET utf8mb4
211		COLLATE utf8mb4_general_ci
212		");
213
214		if (!empty($this->non_mb4_columns[$table])) {
215		foreach ($this->non_mb4_columns[$table] as $column => $index) {
216		if (empty($index['columns'])) {
217		// Alter table only if the key is not composite
218		$connection->executeStatement("
219		ALTER TABLE {$config['prefix']}{$table}
220		MODIFY $column VARCHAR(255)
221		CHARACTER SET utf8
222		COLLATE utf8_unicode_ci
223		");
224		}
225
226		if (!$index) {
227		continue;
228		}
229
230		$sql = "ADD";
231		if ($index['unique']) {
232		$sql .= " UNIQUE ({$index['name']})";
233		} else if ($index['primary']) {
234		$sql .= " PRIMARY KEY ({$index['name']})";
235		} else {
236		$key_columns = elgg_extract('columns', $index, [$column]);
237		$key_columns = implode(',', $key_columns);
238		$sql .= " KEY {$index['name']} ($key_columns)";
239		}
240
241		$connection->executeStatement("
242		ALTER TABLE {$config['prefix']}{$table}
243		$sql
244		");
245		}
246		}
247		}
248		} catch (\Exception $e) {
249		$result->addFailures();
250		$result->addError($e->getMessage());
251
252		return $result;
253		}
254
255		$result->addSuccesses();
256
257		return $result;
258		}
259		}
260

Elgg / Elgg

AlterDatabaseToMultiByteCharset::run() F last analyzed 2024-03-25 11:14 UTC

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

AlterDatabaseToMultiByteCharset::run() F
last analyzed 2024-03-25 11:14 UTC