xref: /plugin/autotranslation/action.php (revision 5fa510d28b6011b7a44f63599b99fa559d67b2b5) 
1<?php
2/**
3 * Translation Plugin: Simple multilanguage plugin
4 *
5 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6 * @author     Andreas Gohr <andi@splitbrain.org>
7 * @author     Guy Brand <gb@isis.u-strasbg.fr>
8 */
9
10// must be run within Dokuwiki
11if(!defined('DOKU_INC')) die();
12
13if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN', DOKU_INC . 'lib/plugins/');
14require_once(DOKU_PLUGIN . 'action.php');
15
16class action_plugin_translation extends DokuWiki_Action_Plugin {
17
18    /**
19     * For the helper plugin
20     * @var helper_plugin_translation
21     */
22    var $helper = null;
23
24    var $locale;
25
26    /**
27     * Constructor. Load helper plugin
28     */
29    function action_plugin_translation() {
30        $this->helper =& plugin_load('helper', 'translation');
31    }
32
33    /**
34     * Register the events
35     */
36    function register(Doku_Event_Handler $controller) {
37        $scriptName = basename($_SERVER['PHP_SELF']);
38
39        // should the lang be applied to UI?
40        if($this->getConf('translateui')) {
41            switch($scriptName) {
42                case 'js.php':
43                    $controller->register_hook('INIT_LANG_LOAD', 'BEFORE', $this, 'translation_js');
44                    $controller->register_hook('JS_CACHE_USE', 'BEFORE', $this, 'translation_jscache');
45                    break;
46
47                case 'ajax.php':
48                    $controller->register_hook('INIT_LANG_LOAD', 'BEFORE', $this, 'translate_media_manager');
49                    break;
50
51                case 'mediamanager.php':
52                    $controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'setJsCacheKey');
53                    break;
54
55                default:
56                    $controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'setJsCacheKey');
57            }
58        }
59
60        if($scriptName !== 'js.php' && $scriptName !== 'ajax.php') {
61            $controller->register_hook('DOKUWIKI_STARTED', 'BEFORE', $this, 'translation_hook');
62            $controller->register_hook('MEDIAMANAGER_STARTED', 'BEFORE', $this, 'translation_hook');
63        }
64
65        $controller->register_hook('SEARCH_QUERY_PAGELOOKUP', 'AFTER', $this, 'translation_search');
66        $controller->register_hook('COMMON_PAGETPL_LOAD', 'AFTER', $this, 'page_template_replacement');
67    }
68
69    /**
70     * Hook Callback. Make current language available as page template placeholder and handle
71     * original language copying
72     *
73     * @param $event
74     * @param $args
75     */
76    function page_template_replacement(&$event, $args) {
77        global $ID;
78
79        // load orginal content as template?
80        if($this->getConf('copytrans') && $this->helper->istranslatable($ID, false)) {
81            // look for existing translations
82            $translations = $this->helper->getAvailableTranslations($ID);
83            if($translations) {
84                // find original language (might've been provided via parameter or use first translation)
85                $orig = (string) $_REQUEST['fromlang'];
86                if(!$orig) $orig = array_shift(array_keys($translations));
87
88                // load file
89                $origfile = $translations[$orig];
90                $event->data['tpl'] = io_readFile(wikiFN($origfile));
91
92                // prefix with warning
93                $warn = io_readFile($this->localFN('totranslate'));
94                if($warn) $warn .= "\n\n";
95                $event->data['tpl'] = $warn . $event->data['tpl'];
96
97                // show user a choice of translations if any
98                if(count($translations) > 1) {
99                    $links = array();
100                    foreach($translations as $t => $l) {
101                        $links[] = '<a href="' . wl($ID, array('do' => 'edit', 'fromlang' => $t)) . '">' . $this->helper->getLocalName($t) . '</a>';
102                    }
103
104                    msg(
105                        sprintf(
106                            $this->getLang('transloaded'),
107                            $this->helper->getLocalName($orig),
108                            join(', ', $links)
109                        )
110                    );
111                }
112
113            }
114        }
115
116        // apply placeholders
117        $event->data['tpl'] = str_replace('@LANG@', $this->helper->realLC(''), $event->data['tpl']);
118        $event->data['tpl'] = str_replace('@TRANS@', $this->helper->getLangPart($ID), $event->data['tpl']);
119    }
120
121    /**
122     * Hook Callback. Load correct translation when loading JavaScript
123     *
124     * @param $event
125     * @param $args
126     */
127    function translation_js(&$event, $args) {
128        global $conf;
129        if(!isset($_GET['lang'])) return;
130        if(!in_array($_GET['lang'], $this->helper->translations)) return;
131        $lang = $_GET['lang'];
132        $event->data = $lang;
133        $conf['lang'] = $lang;
134    }
135
136    /**
137     * Hook Callback. Pass language code to JavaScript dispatcher
138     *
139     * @param $event
140     * @param $args
141     * @return bool
142     */
143    function setJsCacheKey(&$event, $args) {
144        if(!isset($this->locale)) return false;
145        $count = count($event->data['script']);
146        for($i = 0; $i < $count; $i++) {
147            if(strpos($event->data['script'][$i]['src'], '/lib/exe/js.php') !== false) {
148                $event->data['script'][$i]['src'] .= '&lang=' . hsc($this->locale);
149            }
150        }
151
152        return false;
153    }
154
155    /**
156     * Hook Callback. Make sure the JavaScript is translation dependent
157     *
158     * @param $event
159     * @param $args
160     */
161    function translation_jscache(&$event, $args) {
162        if(!isset($_GET['lang'])) return;
163        if(!in_array($_GET['lang'], $this->helper->translations)) return;
164
165        $lang = $_GET['lang'];
166        // reuse the constructor to reinitialize the cache key
167        if(method_exists($event->data, '__construct')) {
168            // New PHP 5 style constructor
169            $event->data->__construct(
170                $event->data->key . $lang,
171                $event->data->ext
172            );
173        } else {
174            // Old PHP 4 style constructor - deprecated
175            $event->data->cache(
176                $event->data->key . $lang,
177                $event->data->ext
178            );
179        }
180    }
181
182    /**
183     * Hook Callback. Translate the AJAX loaded media manager
184     *
185     * @param $event
186     * @param $args
187     */
188    function translate_media_manager(&$event, $args) {
189        global $conf;
190        if(isset($_REQUEST['ID'])) {
191            $id = getID();
192            $lc = $this->helper->getLangPart($id);
193        } elseif(isset($_SESSION[DOKU_COOKIE]['translationlc'])) {
194            $lc = $_SESSION[DOKU_COOKIE]['translationlc'];
195        } else {
196            return;
197        }
198        if(!$lc) return;
199
200        $conf['lang'] = $lc;
201        $event->data = $lc;
202    }
203
204    /**
205     * Hook Callback. Change the UI language in foreign language namespaces
206     */
207    function translation_hook(&$event, $args) {
208        global $ID;
209        global $lang;
210        global $conf;
211        global $ACT;
212        // redirect away from start page?
213        if($this->conf['redirectstart'] && $ID == $conf['start'] && $ACT == 'show') {
214            $lc = $this->helper->getBrowserLang();
215            if(!$lc) $lc = $conf['lang'];
216            header('Location: ' . wl($lc . ':' . $conf['start'], '', true, '&'));
217            exit;
218        }
219
220        // check if we are in a foreign language namespace
221        $lc = $this->helper->getLangPart($ID);
222
223        // store language in session (for page related views only)
224        if(in_array($ACT, array('show', 'recent', 'diff', 'edit', 'preview', 'source', 'subscribe'))) {
225            $_SESSION[DOKU_COOKIE]['translationlc'] = $lc;
226        }
227        if(!$lc) $lc = $_SESSION[DOKU_COOKIE]['translationlc'];
228        if(!$lc) return;
229        $this->locale = $lc;
230
231        if(!$this->getConf('translateui')) {
232            return true;
233        }
234
235        if(file_exists(DOKU_INC . 'inc/lang/' . $lc . '/lang.php')) {
236            require(DOKU_INC . 'inc/lang/' . $lc . '/lang.php');
237        }
238        $conf['lang_before_translation'] = $conf['lang']; //store for later access in syntax plugin
239        $conf['lang'] = $lc;
240
241        return true;
242    }
243
244    /**
245     * Hook Callback.  Resort page match results so that results are ordered by translation, having the
246     * default language first
247     */
248    function translation_search(&$event, $args) {
249
250        if($event->data['has_titles']) {
251            // sort into translation slots
252            $res = array();
253            foreach($event->result as $r => $t) {
254                $tr = $this->helper->getLangPart($r);
255                if(!is_array($res["x$tr"])) $res["x$tr"] = array();
256                $res["x$tr"][] = array($r, $t);
257            }
258            // sort by translations
259            ksort($res);
260            // combine
261            $event->result = array();
262            foreach($res as $r) {
263                foreach($r as $l) {
264                    $event->result[$l[0]] = $l[1];
265                }
266            }
267        } else {
268            # legacy support for old DokuWiki hooks
269
270            // sort into translation slots
271            $res = array();
272            foreach($event->result as $r) {
273                $tr = $this->helper->getLangPart($r);
274                if(!is_array($res["x$tr"])) $res["x$tr"] = array();
275                $res["x$tr"][] = $r;
276            }
277            // sort by translations
278            ksort($res);
279            // combine
280            $event->result = array();
281            foreach($res as $r) {
282                $event->result = array_merge($event->result, $r);
283            }
284        }
285    }
286
287}
288
289//Setup VIM: ex: et ts=4 :
290