summaryrefslogtreecommitdiffstats
path: root/common/app/l10n/extract.php
blob: 1384827ab3976183d0902388d8db70814de61847 (plain)
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
<?php

/*
 * This is a file parser to extract localizable strings from moonmoon
 *
 * It will scan the whole moonmoon repository for php files, extract
 * localized strings and their localization notes and create .lang files.
 * Existing translations will be automatically updated.
 * A short report will be displayed afterwards.
 *
 * The easiest way to add a new locale is just to create an empty .lang file and then run the script
 *
 * The script scans for the files in the l10n/ folder to know which locales are supported
 */

$root = __DIR__ . '/../../';

require_once __DIR__ . '/../app.php';

if ($conf['debug'] !== true) {
    die('Please enable the debug mode to use extract.php.');
}

$GLOBALS['english'] = array();

/*
 * This is a file parser to extract localizable strings (in .php files)
 * $GLOBALS['english'] is populated with localizable strings and their associated localization notes
 *
 */

function extract_l10n_strings($file) {
    $lines    = file($file);
    $patterns = array('/_g\([\'"](.*?)[\'"]\)/', '/getString\([\'"](.*?)[\'"]\)/',);

    foreach ($lines as $line) {

        // Skip comments
        if($line[0] == '#' || $line[0] == '/') continue;

        // parsing logic
        foreach($patterns as $pattern) {
            if(preg_match_all($pattern, $line, $matches, PREG_PATTERN_ORDER)) {
                foreach($matches[1] as $val) {

                    // Do not extract php variables calls or empty strings
                    if($val[0] == '$' || $val == '') continue;

                    // Is there a localization comment ?
                    $l10n_note = explode("',", $val);

                    // Also test strings in double quotes
                    if(count($l10n_note) == 1) {
                        $l10n_note = explode('",', $val);
                    }

                    // Extract cleaned up strings
                    if(count($l10n_note) == 2) {
                        $l10n_str  = trim($l10n_note[0]);
                        $l10n_note = trim(substr(trim($l10n_note[1]),1)); # Remove quote at begining of string
                    } else {
                        $l10n_str  = trim($val);
                        $l10n_note = '';
                    }

                    if(!array_key_exists($l10n_str, $GLOBALS['english'])) {
                        $GLOBALS['english'][$l10n_str] = array($l10n_str, $l10n_note);
                    }
                }
            }
        }
    }
}

/*
 * This is a function echoing $GLOBALS['english'] in .lang format
 * Typical usage would be:
 *     <?php
 *     extract_l10n_strings('.');
 *     show_l10n_strings() ;
 */

function show_l10n_strings() {

    header('Content-Type:text/plain');

    foreach($GLOBALS['english'] as $val) {
        if($val[1]) {
            echo '# ' . $val[1] . "\n";
        }
        echo ";$val[0]\n";
        echo "$val[0]\n\n\n";
    }
}

/*
 * Recursively scan  files in a folder
 * returns an array of file paths
 */

function find_all_files($dir) {

    $result = array();
    $root = scandir($dir);

    $ignore = array('.', '..', '.git', '.svn', '.hg', 'cache', '.gitignore', 'lib');

    foreach($root as $value) {

        if(in_array($value, $ignore)) {
            continue;
        }

        if(is_file("$dir/$value")) {
            $split = explode('.', $value);
            if(end($split) == 'php'){
                $result[] = "$dir/$value";
            }
            continue;
        }

        foreach(find_all_files("$dir/$value") as $value) {
            $result[]=$value;
        }
    }

    return $result;
}

function update_lang_files($source, $dest) {

    $files = find_all_files($source);

    foreach($files as $file) {
        extract_l10n_strings($file);
    }


    $files = scandir($dest);
    $ignore = array('.', '..');


    // list locales
    $locales = array();
    foreach($files as $file) {

        if(in_array($file, $ignore)) {
            continue;
        }

        $split   = explode('.', $file);

        if($split[1] == 'lang') {
            $locales[] = $split[0];
        }
     }


     foreach($locales as $locale) {
        $status[$locale] = 0;
        $lang_file_path  = $dest . '/' . $locale;

        Simplel10n::load($lang_file_path);

        ob_start();
        foreach($GLOBALS['english'] as $key => $val) {
            $warning = '';
            $value   = @Simplel10n::extractString($key);

            if($value == $val[0]) {
                $status[$locale]++;
                $warning = ' ** String needs translation **';
            }

            if($val[1]) {
                echo '# Translation note: ' . $val[1] . $warning . "\n";
            } elseif($warning != '') {
                echo '# Translation note: ' . $warning . "\n";
            }

            echo ";$val[0]\n";
            echo $value . "\n\n\n";
        }

        $content = ob_get_contents();
        ob_end_clean();
        file_put_contents($lang_file_path. '.lang', $content);

        unset($GLOBALS['locale']);
     }


     // Display a short status report
     header('Content-Type:text/plain');
     echo "Number of English strings: " . count($GLOBALS['english']) . "\n";
     echo "Your installation has these languages installed: " . implode(', ', $locales) . "\n";
     foreach($locales as $val) {
        echo $val . " has " . $status[$val] . " untranslated strings.\n";
     }
}

update_lang_files($root, $root . 'app/l10n');