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 th helper plugin 20 * @var helper_plugin_translation 21 */ 22 var $hlp = null; 23 24 var $locale; 25 26 /** 27 * Constructor. Load helper plugin 28 */ 29 function action_plugin_translation(){ 30 $this->hlp =& plugin_load('helper', 'translation'); 31 } 32 33 /** 34 * Registe the events 35 */ 36 function register(&$controller) { 37 // should the lang be applied to UI? 38 $scriptName = basename($_SERVER['PHP_SELF']); 39 if($this->getConf('translateui')){ 40 switch ($scriptName) { 41 case 'js.php': 42 $controller->register_hook('INIT_LANG_LOAD', 'BEFORE', $this, 'translation_js'); 43 $controller->register_hook('JS_CACHE_USE', 'BEFORE', $this, 'translation_jscache'); 44 break; 45 46 case 'ajax.php': 47 $controller->register_hook('INIT_LANG_LOAD', 'BEFORE', $this, 'translate_media_manager'); 48 break; 49 50 case 'mediamanager.php': 51 $controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'setJsCacheKey'); 52 break; 53 54 default: 55 $controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'setJsCacheKey'); 56 } 57 } 58 59 if ($scriptName !== 'js.php' && $scriptName !== 'ajax.php') { 60 $controller->register_hook('DOKUWIKI_STARTED', 'BEFORE', $this, 'translation_hook'); 61 $controller->register_hook('MEDIAMANAGER_STARTED', 'BEFORE', $this, 'translation_hook'); 62 } 63 64 $controller->register_hook('SEARCH_QUERY_PAGELOOKUP', 'AFTER', $this, 'translation_search'); 65 $controller->register_hook('COMMON_PAGETPL_LOAD', 'AFTER', $this, 'page_template_replacement'); 66 } 67 68 /** 69 * Hook Callback. Make current language available as page template placeholder and handle 70 * original language copying 71 * 72 * @param $event 73 * @param $args 74 */ 75 function page_template_replacement(&$event, $args) { 76 global $ID; 77 78 // load orginal content as template? 79 if($this->getConf('copytrans') && $this->hlp->istranslatable($ID, false)) { 80 // look for existing translations 81 $translations = $this->hlp->getAvailableTranslations($ID); 82 if($translations) { 83 // find original language (might've been provided via parameter or use first translation) 84 $orig = (string) $_REQUEST['fromlang']; 85 if(!$orig) $orig = array_shift(array_keys($translations)); 86 87 // load file 88 $origfile = $translations[$orig]; 89 $event->data['tpl'] = io_readFile(wikiFN($origfile)); 90 91 // prefix with warning 92 $warn = io_readFile($this->localFN('totranslate')); 93 if($warn) $warn .= "\n\n"; 94 $event->data['tpl'] = $warn . $event->data['tpl']; 95 96 // show user a choice of translations if any 97 if(count($translations) > 1){ 98 $links = array(); 99 foreach($translations as $t => $l){ 100 $links[] = '<a href="'.wl($ID,array('do'=>'edit','fromlang'=>$t)).'">'.$this->hlp->getLocalName($t).'</a>'; 101 } 102 103 msg(sprintf( 104 $this->getLang('transloaded'), 105 $this->hlp->getLocalName($orig), 106 join(', ', $links) 107 ) 108 ); 109 } 110 111 112 } 113 } 114 115 // apply placeholders 116 $event->data['tpl'] = str_replace('@LANG@', $this->hlp->realLC(''), $event->data['tpl']); 117 $event->data['tpl'] = str_replace('@TRANS@', $this->hlp->getLangPart($ID), $event->data['tpl']); 118 } 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->hlp->trans)) 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->hlp->trans)) return; 164 165 $lang = $_GET['lang']; 166 // reuse the constructor to reinitialize the cache key 167 $event->data->cache( 168 $event->data->key . $lang, 169 $event->data->ext 170 ); 171 } 172 173 /** 174 * Hook Callback. Translate the AJAX loaded media manager 175 * 176 * @param $event 177 * @param $args 178 */ 179 function translate_media_manager(&$event, $args) { 180 global $conf; 181 if (isset($_REQUEST['ID'])) { 182 $id = getID(); 183 $lc = $this->hlp->getLangPart($id); 184 } elseif (isset($_SESSION[DOKU_COOKIE]['translationlc'])) { 185 $lc = $_SESSION[DOKU_COOKIE]['translationlc']; 186 } else { 187 return; 188 } 189 $conf['lang'] = $lc; 190 $event->data = $lc; 191 } 192 193 /** 194 * Hook Callback. Change the UI language in foreign language namespaces 195 */ 196 function translation_hook(&$event, $args) { 197 global $ID; 198 global $lang; 199 global $conf; 200 global $ACT; 201 // redirect away from start page? 202 if($this->conf['redirectstart'] && $ID == $conf['start'] && $ACT == 'show'){ 203 $lc = $this->hlp->getBrowserLang(); 204 if(!$lc) $lc = $conf['lang']; 205 header('Location: '.wl($lc.':'.$conf['start'],'',true,'&')); 206 exit; 207 } 208 209 // check if we are in a foreign language namespace 210 $lc = $this->hlp->getLangPart($ID); 211 212 // store language in session (for page related views only) 213 if(in_array($ACT,array('show','recent','diff','edit','preview','source','subscribe'))){ 214 $_SESSION[DOKU_COOKIE]['translationlc'] = $lc; 215 } 216 if(!$lc) $lc = $_SESSION[DOKU_COOKIE]['translationlc']; 217 if(!$lc) return; 218 $this->locale = $lc; 219 220 if (!$this->getConf('translateui')) { 221 return true; 222 } 223 224 if(file_exists(DOKU_INC.'inc/lang/'.$lc.'/lang.php')) { 225 require(DOKU_INC.'inc/lang/'.$lc.'/lang.php'); 226 } 227 $conf['lang_before_translation'] = $conf['lang']; //store for later access in syntax plugin 228 $conf['lang'] = $lc; 229 230 return true; 231 } 232 233 /** 234 * Hook Callback. Resort page match results so that results are ordered by translation, having the 235 * default language first 236 */ 237 function translation_search(&$event, $args) { 238 239 if($event->data['has_titles']){ 240 // sort into translation slots 241 $res = array(); 242 foreach($event->result as $r => $t){ 243 $tr = $this->hlp->getLangPart($r); 244 if(!is_array($res["x$tr"])) $res["x$tr"] = array(); 245 $res["x$tr"][] = array($r,$t); 246 } 247 // sort by translations 248 ksort($res); 249 // combine 250 $event->result = array(); 251 foreach($res as $r){ 252 foreach($r as $l){ 253 $event->result[$l[0]] = $l[1]; 254 } 255 } 256 }else{ 257 # legacy support for old DokuWiki hooks 258 259 // sort into translation slots 260 $res = array(); 261 foreach($event->result as $r){ 262 $tr = $this->hlp->getLangPart($r); 263 if(!is_array($res["x$tr"])) $res["x$tr"] = array(); 264 $res["x$tr"][] = $r; 265 } 266 // sort by translations 267 ksort($res); 268 // combine 269 $event->result = array(); 270 foreach($res as $r){ 271 $event->result = array_merge($event->result,$r); 272 } 273 } 274 } 275 276} 277 278//Setup VIM: ex: et ts=4 : 279