MessageController.php 11.8 KB
Newer Older
Qiang Xue committed
1 2 3 4
<?php
/**
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @link http://www.yiiframework.com/
Qiang Xue committed
5
 * @copyright Copyright (c) 2008 Yii Software LLC
Qiang Xue committed
6 7 8
 * @license http://www.yiiframework.com/license/
 */

9 10
namespace yii\console\controllers;

11
use Yii;
12
use yii\console\Controller;
13 14
use yii\console\Exception;
use yii\helpers\FileHelper;
15

Qiang Xue committed
16
/**
17
 * This command extracts messages to be translated from source files.
Alexander Makarov committed
18 19 20 21 22 23
 * The extracted messages can be saved the following depending on `format`
 * setting in config file:
 *
 * - PHP message source files.
 * - ".po" files.
 * - Database.
Qiang Xue committed
24
 *
25
 * Usage:
26 27
 * 1. Create a configuration file using the 'message/config' command:
 *    yii message/config /path/to/myapp/messages/config.php
28
 * 2. Edit the created config file, adjusting it for your web application needs.
29
 * 3. Run the 'message/extract' command, using created config:
30 31
 *    yii message /path/to/myapp/messages/config.php
 *
Qiang Xue committed
32
 * @author Qiang Xue <qiang.xue@gmail.com>
33
 * @since 2.0
Qiang Xue committed
34
 */
35
class MessageController extends Controller
Qiang Xue committed
36
{
Digimon committed
37 38 39 40
	/**
	 * @var string controller default action ID.
	 */
	public $defaultAction = 'extract';
41 42


Digimon committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
	/**
	 * Creates a configuration file for the "extract" command.
	 *
	 * The generated configuration file contains detailed instructions on
	 * how to customize it to fit for your needs. After customization,
	 * you may use this configuration file with the "extract" command.
	 *
	 * @param string $filePath output file name or alias.
	 * @throws Exception on failure.
	 */
	public function actionConfig($filePath)
	{
		$filePath = Yii::getAlias($filePath);
		if (file_exists($filePath)) {
			if (!$this->confirm("File '{$filePath}' already exists. Do you wish to overwrite it?")) {
				return;
			}
		}
		copy(Yii::getAlias('@yii/views/messageConfig.php'), $filePath);
		echo "Configuration file template created at '{$filePath}'.\n\n";
	}
64

Digimon committed
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
	/**
	 * Extracts messages to be translated from source code.
	 *
	 * This command will search through source code files and extract
	 * messages that need to be translated in different languages.
	 *
	 * @param string $configFile the path or alias of the configuration file.
	 * You may use the "yii message/config" command to generate
	 * this file and then customize it for your needs.
	 * @throws Exception on failure.
	 */
	public function actionExtract($configFile)
	{
		$configFile = Yii::getAlias($configFile);
		if (!is_file($configFile)) {
			throw new Exception("The configuration file does not exist: $configFile");
		}
82

Digimon committed
83 84 85 86 87 88 89
		$config = array_merge([
			'translator' => 'Yii::t',
			'overwrite' => false,
			'removeUnused' => false,
			'sort' => false,
			'format' => 'php',
		], require($configFile));
Qiang Xue committed
90

Digimon committed
91 92 93 94 95 96 97
		if (!isset($config['sourcePath'], $config['messagePath'], $config['languages'])) {
			throw new Exception('The configuration file must specify "sourcePath", "messagePath" and "languages".');
		}
		if (!is_dir($config['sourcePath'])) {
			throw new Exception("The source path {$config['sourcePath']} is not a valid directory.");
		}
		if (in_array($config['format'], ['php', 'po'])) {
98 99 100
			if (!is_dir($config['messagePath'])) {
				throw new Exception("The message path {$config['messagePath']} is not a valid directory.");
			}
Digimon committed
101 102 103 104 105
		}
		if (empty($config['languages'])) {
			throw new Exception("Languages cannot be empty.");
		}
		if (empty($config['format']) || !in_array($config['format'], ['php', 'po', 'db'])) {
106
			throw new Exception('Format should be either "php", "po" or "db".');
Digimon committed
107
		}
Qiang Xue committed
108

Digimon committed
109
		$files = FileHelper::findFiles(realpath($config['sourcePath']), $config);
Qiang Xue committed
110

Digimon committed
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
		$messages = [];
		foreach ($files as $file) {
			$messages = array_merge_recursive($messages, $this->extractMessages($file, $config['translator']));
		}
		if (in_array($config['format'], ['php', 'po'])) {
			foreach ($config['languages'] as $language) {
				$dir = $config['messagePath'] . DIRECTORY_SEPARATOR . $language;
				if (!is_dir($dir)) {
					@mkdir($dir);
				}
				foreach ($messages as $category => $msgs) {
					$file = str_replace("\\", '/', "$dir/$category." . $config['format']);
					$path = dirname($file);
					if (!is_dir($path)) {
						mkdir($path, 0755, true);
					}
					$msgs = array_values(array_unique($msgs));
					$this->generateMessageFile($msgs, $file, $config['overwrite'], $config['removeUnused'], $config['sort'], $config['format']);
				}
			}
Alexander Makarov committed
131
		} elseif ($config['format'] === 'db') {
Digimon committed
132 133
			$dbConnection = \Yii::$app->getComponent(isset($config['connectionID']) ? $config['connectionID'] : 'db');
			if (!$dbConnection instanceof \yii\db\Connection) {
Alexander Makarov committed
134
				throw new Exception('The "connectionID" must refer to a valid database application component.');
Digimon committed
135
			}
Alexander Makarov committed
136
			$sourceMessageTable = isset($config['sourceMessageTable']) ? $config['sourceMessageTable'] : 'SourceMessage';
137
			$res = [];
Digimon committed
138 139
			foreach ($config['languages'] as $language) {
				foreach ($messages as $category => $msgs) {
140
					$res[$category] = $msgs;
Digimon committed
141 142
				}
			}
143 144 145 146 147 148
			$this->saveMessagesToDb(
				$res,
				$dbConnection,
				$sourceMessageTable,
				$config['removeUnused']
			);
Digimon committed
149 150
		}
	}
Qiang Xue committed
151

Digimon committed
152
	/**
Alexander Makarov committed
153 154 155 156 157 158 159
	 * Saves messages to database
	 *
	 * @param array $messages
	 * @param \yii\db\Connection $dbConnection
	 * @param string $sourceMessageTable
	 * @param boolean $removeUnused
	 */
160 161
	protected function saveMessagesToDb($messages, $dbConnection, $sourceMessageTable, $removeUnused)
	{
Digimon committed
162 163
		$q = new \yii\db\Query;
		$current = [];
Qiang Xue committed
164

Digimon committed
165 166 167
		foreach ($q->select(['id', 'category', 'message'])->from($sourceMessageTable)->all() as $row) {
			$current[$row['category']][$row['id']] = $row['message'];
		}
Qiang Xue committed
168

Digimon committed
169
		$new = [];
Alexander Makarov committed
170
		$obsolete = [];
171

Digimon committed
172 173
		foreach ($messages as $category => $msgs) {
			$msgs = array_unique($msgs);
174

Digimon committed
175 176
			if (isset($current[$category])) {
				$new[$category] = array_diff($msgs, $current[$category]);
Alexander Makarov committed
177
				$obsolete = array_diff($current[$category], $msgs);
Digimon committed
178 179 180 181
			} else {
				$new[$category] = $msgs;
			}
		}
182

Digimon committed
183
		foreach (array_diff(array_keys($current), array_keys($messages)) as $category) {
Alexander Makarov committed
184
			$obsolete += $current[$category];
Digimon committed
185
		}
186

Digimon committed
187
		if (!$removeUnused) {
Alexander Makarov committed
188
			foreach ($obsolete as $pk => $m) {
189
				if (mb_substr($m, 0, 2) === '@@' && mb_substr($m, -2) === '@@') {
Alexander Makarov committed
190
					unset($obsolete[$pk]);
Digimon committed
191 192 193
				}
			}
		}
194

Alexander Makarov committed
195
		$obsolete = array_keys($obsolete);
Digimon committed
196 197
		echo "Inserting new messages...";
		$savedFlag = false;
198

Alexander Makarov committed
199
		foreach ($new  as $category => $msgs) {
Digimon committed
200 201
			foreach ($msgs as $m) {
				$savedFlag = true;
202

Digimon committed
203 204 205 206
				$dbConnection->createCommand()
					->insert($sourceMessageTable, ['category' => $category, 'message' => $m])->execute();
			}
		}
207

Digimon committed
208 209
		echo $savedFlag ? "saved.\n" : "nothing new...skipped.\n";
		echo $removeUnused ? "Deleting obsoleted messages..." : "Updating obsoleted messages...";
210

Alexander Makarov committed
211
		if (empty($obsolete)) {
Digimon committed
212 213 214 215
			echo "nothing obsoleted...skipped.\n";
		} else {
			if ($removeUnused) {
				$dbConnection->createCommand()
Alexander Makarov committed
216
					->delete($sourceMessageTable, ['in', 'id', $obsolete])->execute();
Digimon committed
217 218 219 220 221 222
			echo "deleted.\n";
			} else {
				$dbConnection->createCommand()
					->update(
						$sourceMessageTable,
						['message' => new \yii\db\Expression("CONCAT('@@',message,'@@')")],
Alexander Makarov committed
223
						['in', 'id', $obsolete]
Digimon committed
224 225 226 227 228
					)->execute();
				echo "updated.\n";
			}
		}
	}
229 230


Digimon committed
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
	/**
	 * Extracts messages from a file
	 *
	 * @param string $fileName name of the file to extract messages from
	 * @param string $translator name of the function used to translate messages
	 * @return array
	 */
	protected function extractMessages($fileName, $translator)
	{
		echo "Extracting messages from $fileName...\n";
		$subject = file_get_contents($fileName);
		$messages = [];
		if (!is_array($translator)) {
			$translator = [$translator];
		}
		foreach ($translator as $currentTranslator) {
			$n = preg_match_all(
				'/\b' . $currentTranslator . '\s*\(\s*(\'.*?(?<!\\\\)\'|".*?(?<!\\\\)")\s*,\s*(\'.*?(?<!\\\\)\'|".*?(?<!\\\\)")\s*[,\)]/s',
				$subject, $matches, PREG_SET_ORDER);
			for ($i = 0; $i < $n; ++$i) {
				if (($pos = strpos($matches[$i][1], '.')) !== false) {
					$category = substr($matches[$i][1], $pos + 1, -1);
				} else {
					$category = substr($matches[$i][1], 1, -1);
				}
				$message = $matches[$i][2];
				$messages[$category][] = eval("return $message;"); // use eval to eliminate quote escape
			}
		}
		return $messages;
	}

	/**
	 * Writes messages into file
	 *
	 * @param array $messages
	 * @param string $fileName name of the file to write to
	 * @param boolean $overwrite if existing file should be overwritten without backup
	 * @param boolean $removeUnused if obsolete translations should be removed
	 * @param boolean $sort if translations should be sorted
	 * @param string $format output format
	 */
	protected function generateMessageFile($messages, $fileName, $overwrite, $removeUnused, $sort, $format)
	{
		echo "Saving messages to $fileName...";
		if (is_file($fileName)) {
			if($format === 'po'){
				$translated = file_get_contents($fileName);
				preg_match_all('/(?<=msgid ").*(?="\n(#*)msgstr)/', $translated, $keys);
				preg_match_all('/(?<=msgstr ").*(?="\n\n)/', $translated, $values);
				$translated = array_combine($keys[0], $values[0]);
			} else {
				$translated = require($fileName);
			}
			sort($messages);
			ksort($translated);
			if (array_keys($translated) == $messages) {
				echo "nothing new...skipped.\n";
				return;
			}
			$merged = [];
			$untranslated = [];
			foreach ($messages as $message) {
				if($format === 'po'){
					$message = preg_replace('/\"/', '\"', $message);
				}
				if (array_key_exists($message, $translated) && strlen($translated[$message]) > 0) {
					$merged[$message] = $translated[$message];
				} else {
					$untranslated[] = $message;
				}
			}
			ksort($merged);
			sort($untranslated);
			$todo = [];
			foreach ($untranslated as $message) {
				$todo[$message] = '';
			}
			ksort($translated);
			foreach ($translated as $message => $translation) {
				if (!isset($merged[$message]) && !isset($todo[$message]) && !$removeUnused) {
					if (substr($translation, 0, 2) === '@@' && substr($translation, -2) === '@@') {
						$todo[$message] = $translation;
					} else {
						$todo[$message] = '@@' . $translation . '@@';
					}
				}
			}
			$merged = array_merge($todo, $merged);
			if ($sort) {
				ksort($merged);
			}
			if (false === $overwrite) {
				$fileName .= '.merged';
			}
			if ($format === 'po'){
				$out_str = '';
				foreach ($merged as $k => $v){
					$k = preg_replace('/(\")|(\\\")/', "\\\"", $k);
					$v = preg_replace('/(\")|(\\\")/', "\\\"", $v);
					if (substr($v, 0, 2) === '@@' && substr($v, -2) === '@@') {
						$out_str .= "#msgid \"$k\"\n";
						$out_str .= "#msgstr \"$v\"\n";
					} else {
						$out_str .= "msgid \"$k\"\n";
						$out_str .= "msgstr \"$v\"\n";
					}
					$out_str .= "\n";
				}
				$merged = $out_str;
			}
			echo "translation merged.\n";
		} else {
			if ($format === 'po') {
				$merged = '';
				sort($messages);
				foreach($messages as $message) {
					$message = preg_replace('/(\")|(\\\")/', '\\\"', $message);
					$merged .= "msgid \"$message\"\n";
					$merged .= "msgstr \"\"\n";
					$merged .= "\n";
				}
			} else {
				$merged = [];
				foreach ($messages as $message) {
					$merged[$message] = '';
				}
				ksort($merged);
			}
			echo "saved.\n";
		}
		if ($format === 'po') {
			$content = $merged;
		} else {
			$array = str_replace("\r", '', var_export($merged, true));
			$content = <<<EOD
Qiang Xue committed
367 368 369 370
<?php
/**
 * Message translations.
 *
371
 * This file is automatically generated by 'yii {$this->id}' command.
Qiang Xue committed
372 373 374 375 376 377 378 379 380 381 382
 * It contains the localizable messages extracted from source code.
 * You may modify this file by translating the extracted messages.
 *
 * Each array element represents the translation (value) of a message (key).
 * If the value is empty, the message is considered as not translated.
 * Messages that no longer need translation will have their translations
 * enclosed between a pair of '@@' marks.
 *
 * Message string can be used with plural forms format. Check i18n section
 * of the guide for details.
 *
383
 * NOTE: this file must be saved in UTF-8 encoding.
Qiang Xue committed
384 385 386 387
 */
return $array;

EOD;
Digimon committed
388 389 390
		}
		file_put_contents($fileName, $content);
	}
Qiang Xue committed
391
}