You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
549 lines
21 KiB
549 lines
21 KiB
<?php |
|
/** |
|
* @link http://www.yiiframework.com/ |
|
* @copyright Copyright (c) 2008 Yii Software LLC |
|
* @license http://www.yiiframework.com/license/ |
|
*/ |
|
|
|
namespace yii\console\controllers; |
|
|
|
use Yii; |
|
use yii\console\Controller; |
|
use yii\console\Exception; |
|
use yii\helpers\Console; |
|
use yii\helpers\FileHelper; |
|
use yii\helpers\VarDumper; |
|
use yii\i18n\GettextPoFile; |
|
|
|
/** |
|
* Extracts messages to be translated from source files. |
|
* |
|
* The extracted messages can be saved the following depending on `format` |
|
* setting in config file: |
|
* |
|
* - PHP message source files. |
|
* - ".po" files. |
|
* - Database. |
|
* |
|
* Usage: |
|
* 1. Create a configuration file using the 'message/config' command: |
|
* yii message/config /path/to/myapp/messages/config.php |
|
* 2. Edit the created config file, adjusting it for your web application needs. |
|
* 3. Run the 'message/extract' command, using created config: |
|
* yii message /path/to/myapp/messages/config.php |
|
* |
|
* @author Qiang Xue <qiang.xue@gmail.com> |
|
* @since 2.0 |
|
*/ |
|
class MessageController extends Controller |
|
{ |
|
/** |
|
* @var string controller default action ID. |
|
*/ |
|
public $defaultAction = 'extract'; |
|
|
|
|
|
/** |
|
* 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. |
|
* @return integer CLI exit code |
|
* @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 self::EXIT_CODE_NORMAL; |
|
} |
|
} |
|
copy(Yii::getAlias('@yii/views/messageConfig.php'), $filePath); |
|
$this->stdout("Configuration file template created at '{$filePath}'.\n\n", Console::FG_GREEN); |
|
return self::EXIT_CODE_NORMAL; |
|
} |
|
|
|
/** |
|
* 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"); |
|
} |
|
|
|
$config = array_merge([ |
|
'translator' => 'Yii::t', |
|
'overwrite' => false, |
|
'removeUnused' => false, |
|
'sort' => false, |
|
'format' => 'php', |
|
], require($configFile)); |
|
|
|
if (!isset($config['sourcePath'], $config['languages'])) { |
|
throw new Exception('The configuration file must specify "sourcePath" and "languages".'); |
|
} |
|
if (!is_dir($config['sourcePath'])) { |
|
throw new Exception("The source path {$config['sourcePath']} is not a valid directory."); |
|
} |
|
if (empty($config['format']) || !in_array($config['format'], ['php', 'po', 'db'])) { |
|
throw new Exception('Format should be either "php", "po" or "db".'); |
|
} |
|
if (in_array($config['format'], ['php', 'po'])) { |
|
if (!isset($config['messagePath'])) { |
|
throw new Exception('The configuration file must specify "messagePath".'); |
|
} elseif (!is_dir($config['messagePath'])) { |
|
throw new Exception("The message path {$config['messagePath']} is not a valid directory."); |
|
} |
|
} |
|
if (empty($config['languages'])) { |
|
throw new Exception("Languages cannot be empty."); |
|
} |
|
|
|
$files = FileHelper::findFiles(realpath($config['sourcePath']), $config); |
|
|
|
$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); |
|
} |
|
if ($config['format'] === 'po') { |
|
$catalog = isset($config['catalog']) ? $config['catalog'] : 'messages'; |
|
$this->saveMessagesToPO($messages, $dir, $config['overwrite'], $config['removeUnused'], $config['sort'], $catalog); |
|
} else { |
|
$this->saveMessagesToPHP($messages, $dir, $config['overwrite'], $config['removeUnused'], $config['sort']); |
|
} |
|
} |
|
} elseif ($config['format'] === 'db') { |
|
$db = \Yii::$app->get(isset($config['db']) ? $config['db'] : 'db'); |
|
if (!$db instanceof \yii\db\Connection) { |
|
throw new Exception('The "db" option must refer to a valid database application component.'); |
|
} |
|
$sourceMessageTable = isset($config['sourceMessageTable']) ? $config['sourceMessageTable'] : '{{%source_message}}'; |
|
$messageTable = isset($config['messageTable']) ? $config['messageTable'] : '{{%message}}'; |
|
$this->saveMessagesToDb( |
|
$messages, |
|
$db, |
|
$sourceMessageTable, |
|
$messageTable, |
|
$config['removeUnused'], |
|
$config['languages'] |
|
); |
|
} |
|
} |
|
|
|
/** |
|
* Saves messages to database |
|
* |
|
* @param array $messages |
|
* @param \yii\db\Connection $db |
|
* @param string $sourceMessageTable |
|
* @param string $messageTable |
|
* @param boolean $removeUnused |
|
* @param array $languages |
|
*/ |
|
protected function saveMessagesToDb($messages, $db, $sourceMessageTable, $messageTable, $removeUnused, $languages) |
|
{ |
|
$q = new \yii\db\Query; |
|
$current = []; |
|
|
|
foreach ($q->select(['id', 'category', 'message'])->from($sourceMessageTable)->all() as $row) { |
|
$current[$row['category']][$row['id']] = $row['message']; |
|
} |
|
|
|
$new = []; |
|
$obsolete = []; |
|
|
|
foreach ($messages as $category => $msgs) { |
|
$msgs = array_unique($msgs); |
|
|
|
if (isset($current[$category])) { |
|
$new[$category] = array_diff($msgs, $current[$category]); |
|
$obsolete += array_diff($current[$category], $msgs); |
|
} else { |
|
$new[$category] = $msgs; |
|
} |
|
} |
|
|
|
foreach (array_diff(array_keys($current), array_keys($messages)) as $category) { |
|
$obsolete += $current[$category]; |
|
} |
|
|
|
if (!$removeUnused) { |
|
foreach ($obsolete as $pk => $m) { |
|
if (mb_substr($m, 0, 2) === '@@' && mb_substr($m, -2) === '@@') { |
|
unset($obsolete[$pk]); |
|
} |
|
} |
|
} |
|
|
|
$obsolete = array_keys($obsolete); |
|
$this->stdout("Inserting new messages..."); |
|
$savedFlag = false; |
|
|
|
foreach ($new as $category => $msgs) { |
|
foreach ($msgs as $m) { |
|
$savedFlag = true; |
|
|
|
$db->createCommand() |
|
->insert($sourceMessageTable, ['category' => $category, 'message' => $m])->execute(); |
|
$lastID = $db->getLastInsertID(); |
|
foreach ($languages as $language) { |
|
$db->createCommand() |
|
->insert($messageTable, ['id' => $lastID, 'language' => $language])->execute(); |
|
} |
|
} |
|
} |
|
|
|
$this->stdout($savedFlag ? "saved.\n" : "Nothing new...skipped.\n"); |
|
$this->stdout($removeUnused ? "Deleting obsoleted messages..." : "Updating obsoleted messages..."); |
|
|
|
if (empty($obsolete)) { |
|
$this->stdout("Nothing obsoleted...skipped.\n"); |
|
} else { |
|
if ($removeUnused) { |
|
$db->createCommand() |
|
->delete($sourceMessageTable, ['in', 'id', $obsolete])->execute(); |
|
$this->stdout("deleted.\n"); |
|
} else { |
|
$db->createCommand() |
|
->update( |
|
$sourceMessageTable, |
|
['message' => new \yii\db\Expression("CONCAT('@@',message,'@@')")], |
|
['in', 'id', $obsolete] |
|
)->execute(); |
|
$this->stdout("updated.\n"); |
|
} |
|
} |
|
} |
|
|
|
/** |
|
* 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) |
|
{ |
|
$coloredFileName = Console::ansiFormat($fileName, [Console::FG_CYAN]); |
|
$this->stdout("Extracting messages from $coloredFileName...\n"); |
|
$subject = file_get_contents($fileName); |
|
$messages = []; |
|
foreach ((array)$translator as $currentTranslator) { |
|
$translatorTokens = token_get_all('<?php ' . $currentTranslator); |
|
array_shift($translatorTokens); |
|
|
|
$translatorTokensCount = count($translatorTokens); |
|
$matchedTokensCount = 0; |
|
$buffer = []; |
|
|
|
$tokens = token_get_all($subject); |
|
foreach ($tokens as $token) { |
|
// finding out translator call |
|
if ($matchedTokensCount < $translatorTokensCount) { |
|
if ($this->tokensEqual($token, $translatorTokens[$matchedTokensCount])) { |
|
$matchedTokensCount++; |
|
} else { |
|
$matchedTokensCount = 0; |
|
} |
|
} elseif ($matchedTokensCount === $translatorTokensCount) { |
|
// translator found |
|
|
|
// end of translator call or end of something that we can't extract |
|
if ($this->tokensEqual(')', $token)) { |
|
if (isset($buffer[0][0], $buffer[1], $buffer[2][0]) && $buffer[0][0] === T_CONSTANT_ENCAPSED_STRING && $buffer[1] === ',' && $buffer[2][0] === T_CONSTANT_ENCAPSED_STRING) { |
|
// is valid call we can extract |
|
|
|
$category = stripcslashes($buffer[0][1]); |
|
$category = mb_substr($category, 1, mb_strlen($category) - 2); |
|
|
|
$message = stripcslashes($buffer[2][1]); |
|
$message = mb_substr($message, 1, mb_strlen($message) - 2); |
|
|
|
$messages[$category][] = $message; |
|
} else { |
|
// invalid call or dynamic call we can't extract |
|
|
|
$line = Console::ansiFormat($this->getLine($buffer), [Console::FG_CYAN]); |
|
$skipping = Console::ansiFormat('Skipping line', [Console::FG_YELLOW]); |
|
$this->stdout("$skipping $line. Make sure both category and message are static strings.\n"); |
|
} |
|
|
|
// prepare for the next match |
|
$matchedTokensCount = 0; |
|
$buffer = []; |
|
} elseif ($token !== '(' && isset($token[0]) && !in_array($token[0], [T_WHITESPACE, T_COMMENT])) { |
|
// ignore comments, whitespaces and beginning of function call |
|
$buffer[] = $token; |
|
} |
|
} |
|
} |
|
} |
|
|
|
$this->stdout("\n"); |
|
|
|
return $messages; |
|
} |
|
|
|
/** |
|
* Finds out if two PHP tokens are equal |
|
* |
|
* @param array|string $a |
|
* @param array|string $b |
|
* @return boolean |
|
* @since 2.0.1 |
|
*/ |
|
protected function tokensEqual($a, $b) |
|
{ |
|
if (is_string($a) && is_string($b)) { |
|
return $a === $b; |
|
} elseif (isset($a[0], $a[1], $b[0], $b[1])) { |
|
return $a[0] === $b[0] && $a[1] == $b[1]; |
|
} |
|
return false; |
|
} |
|
|
|
/** |
|
* Finds out a line of the first non-char PHP token found |
|
* |
|
* @param array $tokens |
|
* @return int|string |
|
* @since 2.0.1 |
|
*/ |
|
protected function getLine($tokens) |
|
{ |
|
foreach ($tokens as $token) { |
|
if (isset($token[2])) { |
|
return $token[2]; |
|
} |
|
} |
|
return 'unknown'; |
|
} |
|
|
|
/** |
|
* Writes messages into PHP files |
|
* |
|
* @param array $messages |
|
* @param string $dirName name of the directory 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 |
|
*/ |
|
protected function saveMessagesToPHP($messages, $dirName, $overwrite, $removeUnused, $sort) |
|
{ |
|
foreach ($messages as $category => $msgs) { |
|
$file = str_replace("\\", '/', "$dirName/$category.php"); |
|
$path = dirname($file); |
|
FileHelper::createDirectory($path); |
|
$msgs = array_values(array_unique($msgs)); |
|
$coloredFileName = Console::ansiFormat($file, [Console::FG_CYAN]); |
|
$this->stdout("Saving messages to $coloredFileName...\n"); |
|
$this->saveMessagesCategoryToPHP($msgs, $file, $overwrite, $removeUnused, $sort, $category); |
|
} |
|
} |
|
|
|
/** |
|
* Writes category messages into PHP 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 $category message category |
|
*/ |
|
protected function saveMessagesCategoryToPHP($messages, $fileName, $overwrite, $removeUnused, $sort, $category) |
|
{ |
|
if (is_file($fileName)) { |
|
$existingMessages = require($fileName); |
|
sort($messages); |
|
ksort($existingMessages); |
|
if (array_keys($existingMessages) == $messages) { |
|
$this->stdout("Nothing new in \"$category\" category... Nothing to save.\n\n", Console::FG_GREEN); |
|
return; |
|
} |
|
$merged = []; |
|
$untranslated = []; |
|
foreach ($messages as $message) { |
|
if (array_key_exists($message, $existingMessages) && $existingMessages[$message] !== '') { |
|
$merged[$message] = $existingMessages[$message]; |
|
} else { |
|
$untranslated[] = $message; |
|
} |
|
} |
|
ksort($merged); |
|
sort($untranslated); |
|
$todo = []; |
|
foreach ($untranslated as $message) { |
|
$todo[$message] = ''; |
|
} |
|
ksort($existingMessages); |
|
foreach ($existingMessages as $message => $translation) { |
|
if (!$removeUnused && !isset($merged[$message]) && !isset($todo[$message])) { |
|
if (!empty($translation) && strncmp($translation, '@@', 2) === 0 && substr_compare($translation, '@@', -2, 2) === 0) { |
|
$todo[$message] = $translation; |
|
} else { |
|
$todo[$message] = '@@' . $translation . '@@'; |
|
} |
|
} |
|
} |
|
$merged = array_merge($todo, $merged); |
|
if ($sort) { |
|
ksort($merged); |
|
} |
|
if (false === $overwrite) { |
|
$fileName .= '.merged'; |
|
} |
|
$this->stdout("Translation merged.\n"); |
|
} else { |
|
$merged = []; |
|
foreach ($messages as $message) { |
|
$merged[$message] = ''; |
|
} |
|
ksort($merged); |
|
} |
|
|
|
|
|
$array = VarDumper::export($merged); |
|
$content = <<<EOD |
|
<?php |
|
/** |
|
* Message translations. |
|
* |
|
* This file is automatically generated by 'yii {$this->id}' command. |
|
* 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. |
|
* |
|
* NOTE: this file must be saved in UTF-8 encoding. |
|
*/ |
|
return $array; |
|
|
|
EOD; |
|
|
|
file_put_contents($fileName, $content); |
|
$this->stdout("Translation saved.\n\n", Console::FG_GREEN); |
|
} |
|
|
|
/** |
|
* Writes messages into PO file |
|
* |
|
* @param array $messages |
|
* @param string $dirName name of the directory 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 $catalog message catalog |
|
*/ |
|
protected function saveMessagesToPO($messages, $dirName, $overwrite, $removeUnused, $sort, $catalog) |
|
{ |
|
$file = str_replace("\\", '/', "$dirName/$catalog.po"); |
|
FileHelper::createDirectory(dirname($file)); |
|
$this->stdout("Saving messages to $file...\n"); |
|
|
|
$poFile = new GettextPoFile(); |
|
|
|
|
|
$merged = []; |
|
$todos = []; |
|
|
|
$hasSomethingToWrite = false; |
|
foreach ($messages as $category => $msgs) { |
|
$notTranslatedYet = []; |
|
$msgs = array_values(array_unique($msgs)); |
|
|
|
if (is_file($file)) { |
|
$existingMessages = $poFile->load($file, $category); |
|
|
|
sort($msgs); |
|
ksort($existingMessages); |
|
if (array_keys($existingMessages) == $msgs) { |
|
$this->stdout("Nothing new in \"$category\" category...\n"); |
|
|
|
sort($msgs); |
|
foreach ($msgs as $message) { |
|
$merged[$category . chr(4) . $message] = $existingMessages[$message]; |
|
} |
|
ksort($merged); |
|
continue; |
|
} |
|
|
|
// merge existing message translations with new message translations |
|
foreach ($msgs as $message) { |
|
if (array_key_exists($message, $existingMessages) && $existingMessages[$message] !== '') { |
|
$merged[$category . chr(4) . $message] = $existingMessages[$message]; |
|
} else { |
|
$notTranslatedYet[] = $message; |
|
} |
|
} |
|
ksort($merged); |
|
sort($notTranslatedYet); |
|
|
|
// collect not yet translated messages |
|
foreach ($notTranslatedYet as $message) { |
|
$todos[$category . chr(4) . $message] = ''; |
|
} |
|
|
|
// add obsolete unused messages |
|
foreach ($existingMessages as $message => $translation) { |
|
if (!$removeUnused && !isset($merged[$category . chr(4) . $message]) && !isset($todos[$category . chr(4) . $message])) { |
|
if (!empty($translation) && substr($translation, 0, 2) === '@@' && substr($translation, -2) === '@@') { |
|
$todos[$category . chr(4) . $message] = $translation; |
|
} else { |
|
$todos[$category . chr(4) . $message] = '@@' . $translation . '@@'; |
|
} |
|
} |
|
} |
|
|
|
$merged = array_merge($todos, $merged); |
|
if ($sort) { |
|
ksort($merged); |
|
} |
|
|
|
if ($overwrite === false) { |
|
$file .= '.merged'; |
|
} |
|
} else { |
|
sort($msgs); |
|
foreach ($msgs as $message) { |
|
$merged[$category . chr(4) . $message] = ''; |
|
} |
|
ksort($merged); |
|
} |
|
$this->stdout("Category \"$category\" merged.\n"); |
|
$hasSomethingToWrite = true; |
|
} |
|
if ($hasSomethingToWrite) { |
|
$poFile->save($file, $merged); |
|
$this->stdout("Translation saved.\n", Console::FG_GREEN); |
|
} else { |
|
$this->stdout("Nothing to save.\n", Console::FG_GREEN); |
|
} |
|
} |
|
}
|
|
|