File vendors/shells/gettext.php | BEdita API doc

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234

<?php
/*-----8<--------------------------------------------------------------------
 * 
 * BEdita - a semantic content management framework
 * 
 * Copyright 2008 ChannelWeb Srl, Chialab Srl
 * 
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published 
 * by the Free Software Foundation, either version 3 of the License, or 
 * (at your option) any later version.
 * BEdita is distributed WITHOUT ANY WARRANTY; without even the implied 
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License 
 * version 3 along with BEdita (see LICENSE.LGPL).
 * If not, see <http://gnu.org/licenses/lgpl-3.0.html>.
 * 
 *------------------------------------------------------------------->8-----
 */

/**
 * Gettext shell: methods to parse templates/php files, extract i18n entries and update
 * .po files (gettext files)
 * 
 * @version     $Revision$
 * @modifiedby      $LastChangedBy$
 * @lastmodified    $LastChangedDate$
 * 
 * $Id$
 */
class GettextShell extends Shell {

    protected $poResult = array();
    
    // "fix" string - strip slashes, escape and convert new lines to \n
    private function fs($str)
    {
        $str = stripslashes($str);
        $str = str_replace('"', '\"', $str);
        $str = str_replace("\n", '\n', $str);
        return $str;
    }

    // rips gettext strings from $file
    private function parseFile($file, $extension)
    {
        $content = @file_get_contents($file);
    
        if (empty($content)) {
            return;
        }
    
        if($extension === "tpl") {
            $this->parseTplContent($content);
        } else if($extension === "php") {
            $this->parsePhpContent($content);
        }
    }

    private function parseTplContent($content) {
        // tpl regexp, look for {t}text to translate{/t}
        $l = preg_quote('{');
        $r = preg_quote('}');
        $t = preg_quote('t');
        $rgxp = "/{$l}\s*({$t})\s*([^{$r}]*){$r}([^{$l}]*){$l}\/\\1{$r}/";
        $matches = array();
        preg_match_all($rgxp, $content, $matches);
        for ($i=0; $i < count($matches[0]); $i++) {
            // TODO: handle plural forms, file lines...!!!
            $item = $this->fs($matches[3][$i]);
            if(!in_array($item, $this->poResult)) {
                $this->poResult[] = $item;
            }
        }
        
    }
    
    private function parsePhpContent($content) {
        
        $p  = preg_quote("(");
        $q1 = preg_quote("'");
        $q2 = preg_quote('"');
        
        // looks for __("text to translate",true)
        // or __('text to translate',true), result in matches[1] or in matches[2]
        $rgxp     = "/__\s*{$p}\s*{$q2}" . "([^{$q2}]*)" . "{$q2}" . "|" . "__\s*{$p}\s*{$q1}" . "([^{$q1}]*)" . "{$q1}/";
        
        $matches = array();
        preg_match_all($rgxp, $content, $matches);

        for ($i=0; $i < count($matches[0]); $i++) {
            // TODO: handle plural forms, file lines...!!!
            $item = $this->fs($matches[1][$i]);
            if(empty($item)) {
                $item = $this->fs($matches[2][$i]);
            }
            if(!in_array($item, $this->poResult)) {
                $this->poResult[] = $item;
            }
        }
    }
    
    // go through a directory
    private function parseDir($dir)
    {
        $folder = new Folder($dir);
        $tree = $folder->tree($dir, false);
        foreach ($tree as $files) {
            foreach ($files as $file) {
                if (!is_dir($file)) {
                    $f = new File($file);
                    $info = $f->info();
                    if(isset($info['extension'])) {
                        $this->parseFile($file, $info['extension']);
                    }
                }
            }
        }
    }

    public function update() {
        
        $tplPath = VIEWS;
        $phpPath = APP."controllers".DS;
        $localePath = APP."locale".DS;
        $poName = "default.po";
        if (isset($this->params['frontend'])) {
            $f = new Folder($this->params['frontend']);
            $tplPath = $f->path.DS."views".DS;
            $localePath = $f->path.DS."locale".DS;
            $phpPath = $f->path.DS."controllers".DS;
        } else if (isset($this->params['plugin'])) {
            $f = new Folder(BEDITA_MODULES_PATH . DS . $this->params['plugin']);
            $tplPath = $f->path.DS."views".DS;
            $localePath = $f->path.DS."locale".DS;
            $phpPath = $f->path.DS."controllers".DS;
            $poName = $this->params['plugin'] . ".po";
        }       
        $this->out("Creating master .po file");
        $this->out("Search in: $tplPath");
        $this->parseDir($tplPath);
        $this->out("Search in: $phpPath");
        $this->parseDir($phpPath);
        // write .pot file
        $potFilename = $localePath."master.pot";
        $this->out("Writing new .pot file: $potFilename");
        $pot = new File($potFilename, true);
        $headerPot = "msgid \"\"\nmsgstr \"\""
            . "\n\"POT-Creation-Date: ". date("Y-m-d H:i:s") . "\\n\""
            . "\n\"MIME-Version: 1.0\"\n\"Content-Transfer-Encoding: 8bit\\n\""
            . "\n\"Language-Team: BEdita I18N & I10N Team\\n\""
            . "\n\"Project-Id-Version: BEdita 3\\n\""
            . "\n\"Plural-Forms: nplurals=2; plural=(n != 1);\\n\""
            . "\n\"Content-Type: text/plain; charset=utf-8\\n\"\n";
        $pot->write($headerPot);
        sort($this->poResult);
        foreach ($this->poResult as $res) {
            $pot->write("\n\nmsgid \"". $res ."\"");
            $pot->write("\nmsgstr \"\"");
        }
        $pot->close();
        $this->hr();
        $this->out("Merging master.pot with current .po files");
        $this->hr();
        $resCmd = array();
        exec("which msgmerge 2>&1", $resCmd);
        if (empty($resCmd[0])) {
            $this->out("ERROR: msgmerge not available. Please install gettext utilities.");
            return;
        }
        $headerPo = "msgid \"\"\nmsgstr \"\""
            . "\n\"Project-Id-Version: BEdita 3\\n\""
            . "\n\"POT-Creation-Date: ". date("Y-m-d H:i:s") . "\\n\""
            . "\n\"PO-Revision-Date: \\n\""
            . "\n\"Last-Translator: \\n\""
            . "\n\"Language-Team: BEdita I18N & I10N Team\\n\""
            . "\n\"Language: \\n\""
            . "\n\"MIME-Version: 1.0\\n\""
            . "\n\"Content-Type: text/plain; charset=utf-8\\n\""
            . "\n\"Content-Transfer-Encoding: 8bit\\n\""
            . "\n\"Plural-Forms: nplurals=2; plural=(n != 1);\\n\"\n";
        $folder = new Folder($localePath);
        $ls = $folder->read();
        foreach ($ls[0] as $loc) {
            if($loc[0] != '.') { // only "regular" dirs...
                $this->out("Language: $loc");
                $poFile = $localePath. $loc . DS . "LC_MESSAGES" . DS . $poName;
                if (!file_exists($poFile)) {
                    $newPoFile = new File($poFile, true);
                    $newPoFile->write($headerPo);
                    $newPoFile->close();
                }
                $this->out("Merging $poFile");
                $mergeCmd = "msgmerge --backup=off -N -U " . $poFile . " " . $potFilename;
                exec($mergeCmd);
                $this->analyzePoFile($poFile);
                $this->hr();
            }
        }
        $this->out('Done');
    }

    private function analyzePoFile($poFileName) {
        $lines = file($poFileName);
        $numItems = $numNotTranslated = 0;
        foreach ($lines as $k => $l) {
            if(strpos($l, "msgid \"") === 0) {
                $numItems++;
            } if(strpos($l, "msgstr \"\"") === 0) {
                if(!isset($lines[$k+1])) {
                    $numNotTranslated++;
                } else if(strpos($lines[$k+1], "\"") !== 0){
                    $numNotTranslated++;
                }
            }
        }
        $perc = number_format((($numItems-$numNotTranslated)*100.)/$numItems, 1);
        $this->out("Translated ". ($numItems-$numNotTranslated) . " of $numItems items - $perc %");
    }
    
    function help() {
        $this->out('Available functions:');
        $this->out('1. update [-frontend <frontend path>] [-plugin <plugin name>]: create master.pot and merge .po files');
        $this->out(' ');
        $this->out("    -frontend \t create frontend master.pot looking at <frontend path> [use frontend /app path]");
        $this->out(' ');
        $this->out("    -plugin \t  create .pot and po files for specific plugin ");
        $this->out(' ');
    }
    
}

?>

Classes

Interfaces

Exceptions