HowToGenerateI18NFiles: sfPakeI18n.php_patch01

<?php

pake_desc('initialize a new language file');
pake_task('init-i18n');
pake_alias('new', 'init-i18n');

/**
* create a language file scanning __() or i18n flags occurence
* @param string task name
* @param array task arguments
*/
function run_init_i18n($task, $args)
{

  $verbose = pakeApp::get_instance()->get_verbose();

  if (count($args) < 3)
  {
    throw new Exception('Syntax is: "init-i18n <application> <dest-language> <encoding>"');
  }

  $app    = $args[0];

  define('SF_ROOT_DIR',    sfConfig::get('sf_root_dir'));
  define('SF_APP',         $app);
  define('SF_ENVIRONMENT', 'dev');
  define('SF_DEBUG',       true);


  $appDir = SF_ROOT_DIR.DIRECTORY_SEPARATOR.'apps'.DIRECTORY_SEPARATOR.SF_APP;
  if ( !is_dir($appDir) )
  {
    throw new Exception("unknown application : $appDir");
  }
  require_once($appDir.DIRECTORY_SEPARATOR.'config'.DIRECTORY_SEPARATOR.'config.php');
  $context = sfContext::getInstance();

  if ( !$context->getI18n() )
  {
    throw new Exception("i18n not set in config/settings.yml");
  }

  $src_language = $culture = sfConfig::get('sf_i18n_default_culture');
  if ($src_language == null)
  {
    throw new Exception('please set i18n default culture in "config/i18n.yml"');
  }

  $dest_language = $args[1];
  $encoding = isset($args[2]) ? $args[2] : 'utf-8'; //TODO: find default encoding ?

  $lang = $context->getI18N()->setCulture($dest_language);
  $messageSource = $context->getI18N()->getGlobalMessageSource();
  if ($messageSource != null)
  {
    if ($verbose) echo '>> app    '.pakeApp::excerpt('starting i18n scan for "'.$app.'"'.' application')."\n";
    if ($verbose) echo '>>   default '.pakeApp::excerpt(' language : "'.$src_language).'"'."\n";

    //create dest file if not found
    if( $messageSource->init($dest_language, $src_language, $encoding) && $verbose)
    {
      echo '>>    file created'."\n";
    }

    //the empty transUnit array
    $transUnits = array();

    //Scan all the php file for __()
    $finder = sfFinder::type('file');
    $finder = $finder->name('*.php');
    $files = $finder->in(SF_ROOT_DIR.DIRECTORY_SEPARATOR.'apps'.DIRECTORY_SEPARATOR.SF_APP.DIRECTORY_SEPARATOR.'modules');
    foreach ($files as $aFile) {
      $transUnits = array_merge($transUnits, _updatePHPMessage($aFile) );
    }

    //scan for generator files params
    $finder = sfFinder::type('file');
    $finder = $finder->name('generator.yml');
    $files = $finder->in(SF_ROOT_DIR.DIRECTORY_SEPARATOR.'apps'.DIRECTORY_SEPARATOR.SF_APP.DIRECTORY_SEPARATOR.'modules');
    foreach ($files as $aFile) {
      $transUnits = array_merge($transUnits,_updateGeneratorMessage($aFile) );
    }

    //add standard known admin generated syntax
    //TODO : maybe we can simply scan the sfAdminGenerator classes for __(...)
    $transUnits[] = 'no results';
    $transUnits[] = 'actions';
    $transUnits[] = 'yes or no';
    $transUnits[] = 'yes';
    $transUnits[] = 'no';
    $transUnits[] = 'remove file';


    //scan for validator files params
    $finder = sfFinder::type('dir');
    $finder = $finder->name('validate');
    $dirs = $finder->in(SF_ROOT_DIR.DIRECTORY_SEPARATOR.'apps'.DIRECTORY_SEPARATOR.SF_APP.DIRECTORY_SEPARATOR.'modules');
    foreach ($dirs as $aDir) {
      $files = sfFinder::type('file')->name('*.yml')->in($aDir);
      foreach ($files as $aFile)
      {
        if ($verbose) echo '>>    val: '.pakeApp::excerpt($aFile)."\n";
        $transUnits = array_merge ($transUnits, _updateValidatorMessage($aFile) );
      }
    }

    //add untranslated messages
    foreach ($transUnits as $transUnit) {
      //check if the message exist
      $messageFormat = $context->getI18N()->getGlobalMessageFormat()->formatExists($transUnit);
      if (!$messageFormat)
      {
        //append if not found
        $messageSource->append($transUnit);
        if ($verbose) echo '>>     added '.pakeApp::excerpt(' : '.$transUnit)."\n";
      }
    }

    //save all untranslated messages
    $messageSource->save();
    } else {
      throw new Exception("no message source found create at least one 'message.$native_cult.xml' in 'apps/$app/i18n'");
    }

  }

  /**
  * @param string the file to scan
  * @return array transunits found
  */
  function _updatePHPMessage($aFile)
  {

    $verbose = pakeApp::get_instance()->get_verbose();

    //scan file content
    $fileContent = file_get_contents($aFile);
    if ($verbose) echo '>>   scan: '.pakeApp::excerpt($aFile)."\n";
    preg_match_all("/__\\(\\s*(['\"])(.+?)\\1(?:\\s*[,\\)])/",$fileContent, $out);
    return $out[2];
  }

  /**
  * @param string the file to scan
  * @return array transunits found
  */
  function _updateGeneratorMessage($aFile)
  {

    $verbose = pakeApp::get_instance()->get_verbose();
    $transUnits = array();

    //load and process the YAML file
    $genConfig = sfYaml::load($aFile);
    if (isset($genConfig['generator']['param']))
    {
      $param = $genConfig['generator']['param'];
      $labels = array("name", "title");
      get_array_elems($param, $labels, $transUnits);
    }
    return $transUnits;
  }

  /**
  * @param string the file to scan
  * @return array transunits found
  */
  function _updateValidatorMessage($aFile)
  {
    $verbose = pakeApp::get_instance()->get_verbose();
    $transUnits = array();
    //load and process the YAML file
    $valConfig = sfYaml::load($aFile);
    $labels = array("msg", "error");
    get_array_elems($valConfig, $labels, $transUnits);
    return $transUnits;
  }

  /**
   * @param string string to trim
   * @return string strimed string
   */
  function _trimString($string)
  {
    return preg_replace("/\\\\'/", '\'', $string);
  }


  ######################################
  #
  # Author: Lez Lytollis
  # (with help from Chris Boget and Andreas Pour)
  #
  # A recursive function to traverse a multi-dimensional array 
  # where the dimensions are not known
  #
  #######################################
  function get_array_elems($arrResult, $labels, &$transUnitsFound){
    while(list($key,$value)=each($arrResult)){
      if (is_array($value)){
        get_array_elems($value, $labels, $transUnitsFound);
      }
      else {
        for ($i=0; $i<count($value);$i++){
          foreach ($labels as $aLabel)
          {
            if (strpos($key,$aLabel) !== false)
            {
              $transUnitsFound[] = _trimString($value);
            }
          }
        }
      }
    }
  }

  ?>