|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* @author Qiang Xue <qiang.xue@gmail.com>
|
|
|
|
* @link http://www.yiiframework.com/
|
|
|
|
* @copyright Copyright (c) 2008 Yii Software LLC
|
|
|
|
* @license http://www.yiiframework.com/license/
|
|
|
|
*/
|
|
|
|
|
|
|
|
namespace yii\console\controllers;
|
|
|
|
|
|
|
|
use yii\console\Controller;
|
|
|
|
use yii\console\Exception;
|
|
|
|
use yii\helpers\FileHelper;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This command extracts messages to be translated from source files.
|
|
|
|
* The extracted messages are saved as PHP message source files
|
|
|
|
* under the specified directory.
|
|
|
|
*
|
|
|
|
* @author Qiang Xue <qiang.xue@gmail.com>
|
|
|
|
* @since 2.0
|
|
|
|
*/
|
|
|
|
class MessageController extends Controller
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* @var string controller default action ID.
|
|
|
|
*/
|
|
|
|
public $defaultAction = 'generate';
|
|
|
|
/**
|
|
|
|
* Searches for messages to be translated in the specified
|
|
|
|
* source files and compiles them into PHP arrays as message source.
|
|
|
|
*
|
|
|
|
* @param string $config the path of the configuration file. You can find
|
|
|
|
* an example in framework/messages/config.php.
|
|
|
|
* @throws \yii\console\Exception on failure.
|
|
|
|
*
|
|
|
|
* The file can be placed anywhere and must be a valid PHP script which
|
|
|
|
* returns an array of name-value pairs. Each name-value pair represents
|
|
|
|
* a configuration option.
|
|
|
|
*
|
|
|
|
* The following options are available:
|
|
|
|
*
|
|
|
|
* - sourcePath: string, root directory of all source files.
|
|
|
|
* - messagePath: string, root directory containing message translations.
|
|
|
|
* - languages: array, list of language codes that the extracted messages
|
|
|
|
* should be translated to. For example, array('zh_cn', 'en_au').
|
|
|
|
* - fileTypes: array, a list of file extensions (e.g. 'php', 'xml').
|
|
|
|
* Only the files whose extension name can be found in this list
|
|
|
|
* will be processed. If empty, all files will be processed.
|
|
|
|
* - exclude: array, a list of directory and file exclusions. Each
|
|
|
|
* exclusion can be either a name or a path. If a file or directory name
|
|
|
|
* or path matches the exclusion, it will not be copied. For example,
|
|
|
|
* an exclusion of '.svn' will exclude all files and directories whose
|
|
|
|
* name is '.svn'. And an exclusion of '/a/b' will exclude file or
|
|
|
|
* directory 'sourcePath/a/b'.
|
|
|
|
* - translator: the name of the function for translating messages.
|
|
|
|
* Defaults to 'Yii::t'. This is used as a mark to find messages to be
|
|
|
|
* translated.
|
|
|
|
* - overwrite: if message file must be overwritten with the merged messages.
|
|
|
|
* - removeOld: if message no longer needs translation it will be removed,
|
|
|
|
* instead of being enclosed between a pair of '@@' marks.
|
|
|
|
* - sort: sort messages by key when merging, regardless of their translation
|
|
|
|
* state (new, obsolete, translated.)
|
|
|
|
*/
|
|
|
|
public function actionGenerate($config)
|
|
|
|
{
|
|
|
|
if (!is_file($config)) {
|
|
|
|
throw new Exception("the configuration file {$config} does not exist.");
|
|
|
|
}
|
|
|
|
|
|
|
|
$config = require($config);
|
|
|
|
|
|
|
|
$translator = 'Yii::t';
|
|
|
|
extract($config);
|
|
|
|
|
|
|
|
if (!isset($sourcePath, $messagePath, $languages)) {
|
|
|
|
throw new Exception('The configuration file must specify "sourcePath", "messagePath" and "languages".');
|
|
|
|
}
|
|
|
|
if (!is_dir($sourcePath)) {
|
|
|
|
throw new Exception("The source path {$sourcePath} is not a valid directory.");
|
|
|
|
}
|
|
|
|
if (!is_dir($messagePath)) {
|
|
|
|
throw new Exception("The message path {$messagePath} is not a valid directory.");
|
|
|
|
}
|
|
|
|
if (empty($languages)) {
|
|
|
|
throw new Exception("Languages cannot be empty.");
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!isset($overwrite)) {
|
|
|
|
$overwrite = false;
|
|
|
|
}
|
|
|
|
if (!isset($removeOld)) {
|
|
|
|
$removeOld = false;
|
|
|
|
}
|
|
|
|
if (!isset($sort)) {
|
|
|
|
$sort = false;
|
|
|
|
}
|
|
|
|
|
|
|
|
$options = array();
|
|
|
|
if (isset($fileTypes)) {
|
|
|
|
$options['fileTypes'] = $fileTypes;
|
|
|
|
}
|
|
|
|
if (isset($exclude)) {
|
|
|
|
$options['exclude'] = $exclude;
|
|
|
|
}
|
|
|
|
$files = FileHelper::findFiles(realpath($sourcePath), $options);
|
|
|
|
|
|
|
|
$messages = array();
|
|
|
|
foreach ($files as $file) {
|
|
|
|
$messages = array_merge_recursive($messages, $this->extractMessages($file, $translator));
|
|
|
|
}
|
|
|
|
|
|
|
|
foreach ($languages as $language) {
|
|
|
|
$dir = $messagePath . DIRECTORY_SEPARATOR . $language;
|
|
|
|
if (!is_dir($dir)) {
|
|
|
|
@mkdir($dir);
|
|
|
|
}
|
|
|
|
foreach ($messages as $category => $msgs) {
|
|
|
|
$msgs = array_values(array_unique($msgs));
|
|
|
|
$this->generateMessageFile($msgs, $dir . DIRECTORY_SEPARATOR . $category . '.php', $overwrite, $removeOld, $sort);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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);
|
|
|
|
$n = preg_match_all(
|
|
|
|
'/\b' . $translator . '\s*\(\s*(\'.*?(?<!\\\\)\'|".*?(?<!\\\\)")\s*,\s*(\'.*?(?<!\\\\)\'|".*?(?<!\\\\)")\s*[,\)]/s',
|
|
|
|
$subject, $matches, PREG_SET_ORDER);
|
|
|
|
$messages = array();
|
|
|
|
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 $removeOld if obsolete translations should be removed
|
|
|
|
* @param boolean $sort if translations should be sorted
|
|
|
|
*/
|
|
|
|
protected function generateMessageFile($messages, $fileName, $overwrite, $removeOld, $sort)
|
|
|
|
{
|
|
|
|
echo "Saving messages to $fileName...";
|
|
|
|
if (is_file($fileName)) {
|
|
|
|
$translated = require($fileName);
|
|
|
|
sort($messages);
|
|
|
|
ksort($translated);
|
|
|
|
if (array_keys($translated) == $messages) {
|
|
|
|
echo "nothing new...skipped.\n";
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
$merged = array();
|
|
|
|
$untranslated = array();
|
|
|
|
foreach ($messages as $message) {
|
|
|
|
if (!empty($translated[$message])) {
|
|
|
|
$merged[$message] = $translated[$message];
|
|
|
|
} else {
|
|
|
|
$untranslated[] = $message;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
ksort($merged);
|
|
|
|
sort($untranslated);
|
|
|
|
$todo = array();
|
|
|
|
foreach ($untranslated as $message) {
|
|
|
|
$todo[$message] = '';
|
|
|
|
}
|
|
|
|
ksort($translated);
|
|
|
|
foreach ($translated as $message => $translation) {
|
|
|
|
if (!isset($merged[$message]) && !isset($todo[$message]) && !$removeOld) {
|
|
|
|
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';
|
|
|
|
}
|
|
|
|
echo "translation merged.\n";
|
|
|
|
} else {
|
|
|
|
$merged = array();
|
|
|
|
foreach ($messages as $message) {
|
|
|
|
$merged[$message] = '';
|
|
|
|
}
|
|
|
|
ksort($merged);
|
|
|
|
echo "saved.\n";
|
|
|
|
}
|
|
|
|
$array = str_replace("\r", '', var_export($merged, true));
|
|
|
|
$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);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates template of configuration file for [[actionGenerate]].
|
|
|
|
* @param string $configFile output file name.
|
|
|
|
* @throws \yii\console\Exception on failure.
|
|
|
|
*/
|
|
|
|
public function actionTemplate($configFile)
|
|
|
|
{
|
|
|
|
$template = <<<EOD
|
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* Configuration file for the "yii {$this->id}" console command.
|
|
|
|
*/
|
|
|
|
return array(
|
|
|
|
'sourcePath' => __DIR__,
|
|
|
|
'messagePath' => __DIR__ . DIRECTORY_SEPARATOR . 'messages',
|
|
|
|
'languages' => array(),
|
|
|
|
'fileTypes' => array('php'),
|
|
|
|
'overwrite' => true,
|
|
|
|
'exclude' => array(
|
|
|
|
'.svn',
|
|
|
|
'.gitignore',
|
|
|
|
'.gitkeep',
|
|
|
|
'.hgignore',
|
|
|
|
'.hgkeep',
|
|
|
|
'/messages',
|
|
|
|
),
|
|
|
|
);
|
|
|
|
EOD;
|
|
|
|
if (file_exists($configFile)) {
|
|
|
|
if (!$this->confirm("File '{$configFile}' already exists. Do you wish to overwrite it?")) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if (!file_put_contents($configFile, $template)) {
|
|
|
|
throw new Exception("Unable to write template file '{$configFile}'.");
|
|
|
|
} else {
|
|
|
|
echo "Configuration file template created at '{$configFile}'.\n\n";
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|