Mercurial > hg > rc2
annotate program/include/rcmail_output_html.php @ 22:303b85d5b561
More cleaning up php8 Warnings/deprecations
| author | Charlie Root |
|---|---|
| date | Wed, 15 Oct 2025 14:06:27 -0400 |
| parents | b631c1c7a3ce |
| children |
| rev | line source |
|---|---|
| 0 | 1 <?php |
| 2 | |
| 3 /** | |
| 4 +-----------------------------------------------------------------------+ | |
| 5 | program/include/rcmail_output_html.php | | |
| 6 | | | |
| 7 | This file is part of the Roundcube Webmail client | | |
| 8 | Copyright (C) 2006-2014, The Roundcube Dev Team | | |
| 9 | | | |
| 10 | Licensed under the GNU General Public License version 3 or | | |
| 11 | any later version with exceptions for skins & plugins. | | |
| 12 | See the README file for a full license statement. | | |
| 13 | | | |
| 14 | PURPOSE: | | |
| 15 | Class to handle HTML page output using a skin template. | | |
| 16 | | | |
| 17 +-----------------------------------------------------------------------+ | |
| 18 | Author: Thomas Bruederli <roundcube@gmail.com> | | |
| 19 +-----------------------------------------------------------------------+ | |
| 20 */ | |
| 21 | |
| 22 /** | |
| 23 * Class to create HTML page output using a skin template | |
| 24 * | |
| 25 * @package Webmail | |
| 26 * @subpackage View | |
| 27 */ | |
| 28 class rcmail_output_html extends rcmail_output | |
| 29 { | |
| 30 public $type = 'html'; | |
| 31 | |
| 32 protected $message; | |
| 33 protected $template_name; | |
| 34 protected $objects = array(); | |
| 35 protected $js_env = array(); | |
| 36 protected $js_labels = array(); | |
| 37 protected $js_commands = array(); | |
| 38 protected $skin_paths = array(); | |
| 39 protected $scripts_path = ''; | |
| 40 protected $script_files = array(); | |
| 41 protected $css_files = array(); | |
| 42 protected $scripts = array(); | |
| 43 protected $default_template = "<html>\n<head><title></title></head>\n<body></body>\n</html>"; | |
| 44 protected $header = ''; | |
| 45 protected $footer = ''; | |
| 46 protected $body = ''; | |
| 47 protected $base_path = ''; | |
| 48 protected $assets_path; | |
| 49 protected $assets_dir = RCUBE_INSTALL_PATH; | |
| 50 protected $devel_mode = false; | |
| 51 | |
| 52 // deprecated names of templates used before 0.5 | |
| 53 protected $deprecated_templates = array( | |
| 54 'contact' => 'showcontact', | |
| 55 'contactadd' => 'addcontact', | |
| 56 'contactedit' => 'editcontact', | |
| 57 'identityedit' => 'editidentity', | |
| 58 'messageprint' => 'printmessage', | |
| 59 ); | |
| 60 | |
| 61 /** | |
| 62 * Constructor | |
| 63 */ | |
| 64 public function __construct($task = null, $framed = false) | |
| 65 { | |
| 66 parent::__construct(); | |
| 67 | |
| 68 $this->devel_mode = $this->config->get('devel_mode'); | |
| 69 | |
| 70 $this->set_env('task', $task); | |
| 71 $this->set_env('x_frame_options', $this->config->get('x_frame_options', 'sameorigin')); | |
| 72 $this->set_env('standard_windows', (bool) $this->config->get('standard_windows')); | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
73 $this->set_env('locale', !empty($_SESSION['language']) ? $_SESSION['language'] : 'en_US'); |
| 0 | 74 $this->set_env('devel_mode', $this->devel_mode); |
| 75 | |
| 76 // add cookie info | |
| 77 $this->set_env('cookie_domain', ini_get('session.cookie_domain')); | |
| 78 $this->set_env('cookie_path', ini_get('session.cookie_path')); | |
| 79 $this->set_env('cookie_secure', filter_var(ini_get('session.cookie_secure'), FILTER_VALIDATE_BOOLEAN)); | |
| 80 | |
| 81 // load the correct skin (in case user-defined) | |
| 82 $skin = $this->config->get('skin'); | |
| 83 $this->set_skin($skin); | |
| 84 $this->set_env('skin', $skin); | |
| 85 | |
| 86 $this->set_assets_path($this->config->get('assets_path'), $this->config->get('assets_dir')); | |
| 87 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
88 if (!empty($_REQUEST['_extwin'])) { |
| 0 | 89 $this->set_env('extwin', 1); |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
90 } |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
91 |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
92 if ($this->framed || $framed) { |
| 0 | 93 $this->set_env('framed', 1); |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
94 } |
| 0 | 95 |
| 96 $lic = <<<EOF | |
| 97 /* | |
| 98 @licstart The following is the entire license notice for the | |
| 99 JavaScript code in this page. | |
| 100 | |
| 101 Copyright (C) 2005-2014 The Roundcube Dev Team | |
| 102 | |
| 103 The JavaScript code in this page is free software: you can redistribute | |
| 104 it and/or modify it under the terms of the GNU General Public License | |
| 105 as published by the Free Software Foundation, either version 3 of | |
| 106 the License, or (at your option) any later version. | |
| 107 | |
| 108 The code is distributed WITHOUT ANY WARRANTY; without even the implied | |
| 109 warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | |
| 110 See the GNU GPL for more details. | |
| 111 | |
| 112 @licend The above is the entire license notice | |
| 113 for the JavaScript code in this page. | |
| 114 */ | |
| 115 EOF; | |
| 116 // add common javascripts | |
| 117 $this->add_script($lic, 'head_top'); | |
| 118 $this->add_script('var '.self::JS_OBJECT_NAME.' = new rcube_webmail();', 'head_top'); | |
| 119 | |
| 120 // don't wait for page onload. Call init at the bottom of the page (delayed) | |
| 121 $this->add_script(self::JS_OBJECT_NAME.'.init();', 'docready'); | |
| 122 | |
| 123 $this->scripts_path = 'program/js/'; | |
| 124 $this->include_script('jquery.min.js'); | |
| 125 $this->include_script('common.js'); | |
| 126 $this->include_script('app.js'); | |
| 127 | |
| 128 // register common UI objects | |
| 129 $this->add_handlers(array( | |
| 130 'loginform' => array($this, 'login_form'), | |
| 131 'preloader' => array($this, 'preloader'), | |
| 132 'username' => array($this, 'current_username'), | |
| 133 'message' => array($this, 'message_container'), | |
| 134 'charsetselector' => array($this, 'charset_selector'), | |
| 135 'aboutcontent' => array($this, 'about_content'), | |
| 136 )); | |
| 137 } | |
| 138 | |
| 139 /** | |
| 140 * Set environment variable | |
| 141 * | |
| 142 * @param string $name Property name | |
| 143 * @param mixed $value Property value | |
| 144 * @param boolean $addtojs True if this property should be added | |
| 145 * to client environment | |
| 146 */ | |
| 147 public function set_env($name, $value, $addtojs = true) | |
| 148 { | |
| 149 $this->env[$name] = $value; | |
| 150 | |
| 151 if ($addtojs || isset($this->js_env[$name])) { | |
| 152 $this->js_env[$name] = $value; | |
| 153 } | |
| 154 } | |
| 155 | |
| 156 /** | |
| 157 * Parse and set assets path | |
| 158 * | |
| 159 * @param string $path Assets path URL (relative or absolute) | |
| 160 * @param string $fs_dif Assets path in filesystem | |
| 161 */ | |
| 162 public function set_assets_path($path, $fs_dir = null) | |
| 163 { | |
| 164 if (empty($path)) { | |
| 165 return; | |
| 166 } | |
| 167 | |
| 168 $path = rtrim($path, '/') . '/'; | |
| 169 | |
| 170 // handle relative assets path | |
| 171 if (!preg_match('|^https?://|', $path) && $path[0] != '/') { | |
| 172 // save the path to search for asset files later | |
| 173 $this->assets_dir = $path; | |
| 174 | |
| 175 $base = preg_replace('/[?#&].*$/', '', $_SERVER['REQUEST_URI']); | |
| 176 $base = rtrim($base, '/'); | |
| 177 | |
| 178 // remove url token if exists | |
| 179 if ($len = intval($this->config->get('use_secure_urls'))) { | |
| 180 $_base = explode('/', $base); | |
| 181 $last = count($_base) - 1; | |
| 182 $length = $len > 1 ? $len : 16; // as in rcube::get_secure_url_token() | |
| 183 | |
| 184 // we can't use real token here because it | |
| 185 // does not exists in unauthenticated state, | |
| 186 // hope this will not produce false-positive matches | |
| 187 if ($last > -1 && preg_match('/^[a-f0-9]{' . $length . '}$/', $_base[$last])) { | |
| 188 $path = '../' . $path; | |
| 189 } | |
| 190 } | |
| 191 } | |
| 192 | |
| 193 // set filesystem path for assets | |
| 194 if ($fs_dir) { | |
| 195 if ($fs_dir[0] != '/') { | |
| 196 $fs_dir = realpath(RCUBE_INSTALL_PATH . $fs_dir); | |
| 197 } | |
| 198 // ensure the path ends with a slash | |
| 199 $this->assets_dir = rtrim($fs_dir, '/') . '/'; | |
| 200 } | |
| 201 | |
| 202 $this->assets_path = $path; | |
| 203 $this->set_env('assets_path', $path); | |
| 204 } | |
| 205 | |
| 206 /** | |
| 207 * Getter for the current page title | |
| 208 * | |
| 209 * @return string The page title | |
| 210 */ | |
| 211 protected function get_pagetitle() | |
| 212 { | |
| 213 if (!empty($this->pagetitle)) { | |
| 214 $title = $this->pagetitle; | |
| 215 } | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
216 else if (isset($this->env['task'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
217 if ($this->env['task'] == 'login') { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
218 $title = $this->app->gettext([ |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
219 'name' => 'welcome', |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
220 'vars' => ['product' => $this->config->get('product_name')] |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
221 ]); |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
222 } |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
223 else { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
224 $title = ucfirst($this->env['task']); |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
225 } |
| 0 | 226 } |
| 227 else { | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
228 $title = ''; |
| 0 | 229 } |
| 230 | |
| 231 return $title; | |
| 232 } | |
| 233 | |
| 234 /** | |
| 235 * Set skin | |
| 236 * | |
| 237 * @param string $skin Skin name | |
| 238 * | |
| 239 * @return bool True if the skin exist and is readable, False otherwise | |
| 240 */ | |
| 241 public function set_skin($skin) | |
| 242 { | |
| 243 // Sanity check to prevent from path traversal vulnerability (#1490620) | |
| 244 if (strpos($skin, '/') !== false || strpos($skin, "\\") !== false) { | |
| 245 rcube::raise_error(array( | |
| 246 'file' => __FILE__, | |
| 247 'line' => __LINE__, | |
| 248 'message' => 'Invalid skin name' | |
| 249 ), true, false); | |
| 250 | |
| 251 return false; | |
| 252 } | |
| 253 | |
| 254 $valid = false; | |
| 255 $path = RCUBE_INSTALL_PATH . 'skins/'; | |
| 256 | |
| 257 if (!empty($skin) && is_dir($path . $skin) && is_readable($path . $skin)) { | |
| 258 $skin_path = 'skins/' . $skin; | |
| 259 $valid = true; | |
| 260 } | |
| 261 else { | |
| 262 $skin_path = $this->config->get('skin_path'); | |
| 263 if (!$skin_path) { | |
| 264 $skin_path = 'skins/' . rcube_config::DEFAULT_SKIN; | |
| 265 } | |
| 266 $valid = !$skin; | |
| 267 } | |
| 268 | |
| 269 $skin_path = rtrim($skin_path, '/'); | |
| 270 | |
| 271 $this->config->set('skin_path', $skin_path); | |
| 272 $this->base_path = $skin_path; | |
| 273 | |
| 274 // register skin path(s) | |
| 275 $this->skin_paths = array(); | |
| 276 $this->load_skin($skin_path); | |
| 277 | |
| 278 return $valid; | |
| 279 } | |
| 280 | |
| 281 /** | |
| 282 * Helper method to recursively read skin meta files and register search paths | |
| 283 */ | |
| 284 private function load_skin($skin_path) | |
| 285 { | |
| 286 $this->skin_paths[] = $skin_path; | |
| 287 | |
| 288 // read meta file and check for dependencies | |
| 289 $meta = @file_get_contents(RCUBE_INSTALL_PATH . $skin_path . '/meta.json'); | |
| 290 $meta = @json_decode($meta, true); | |
| 291 | |
| 292 $meta['path'] = $skin_path; | |
| 293 $path_elements = explode('/', $skin_path); | |
| 294 $skin_id = end($path_elements); | |
| 295 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
296 if (empty($meta['name'])) { |
| 0 | 297 $meta['name'] = $skin_id; |
| 298 } | |
| 299 | |
| 300 $this->skins[$skin_id] = $meta; | |
| 301 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
302 if (!empty($meta['extends'])) { |
| 0 | 303 $path = RCUBE_INSTALL_PATH . 'skins/'; |
| 304 if (is_dir($path . $meta['extends']) && is_readable($path . $meta['extends'])) { | |
| 305 $this->load_skin('skins/' . $meta['extends']); | |
| 306 } | |
| 307 } | |
| 308 } | |
| 309 | |
| 310 /** | |
| 311 * Check if a specific template exists | |
| 312 * | |
| 313 * @param string $name Template name | |
| 314 * | |
| 315 * @return boolean True if template exists | |
| 316 */ | |
| 317 public function template_exists($name) | |
| 318 { | |
| 319 foreach ($this->skin_paths as $skin_path) { | |
| 320 $filename = RCUBE_INSTALL_PATH . $skin_path . '/templates/' . $name . '.html'; | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
321 if ( |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
322 (is_file($filename) && is_readable($filename)) |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
323 || (!empty($this->deprecated_templates[$name]) && $this->template_exists($this->deprecated_templates[$name])) |
| 0 | 324 ) { |
| 325 return true; | |
| 326 } | |
| 327 } | |
| 328 | |
| 329 return false; | |
| 330 } | |
| 331 | |
| 332 /** | |
| 333 * Find the given file in the current skin path stack | |
| 334 * | |
| 335 * @param string $file File name/path to resolve (starting with /) | |
| 336 * @param string &$skin_path Reference to the base path of the matching skin | |
| 337 * @param string $add_path Additional path to search in | |
| 338 * | |
| 339 * @return mixed Relative path to the requested file or False if not found | |
| 340 */ | |
| 341 public function get_skin_file($file, &$skin_path = null, $add_path = null) | |
| 342 { | |
| 343 $skin_paths = $this->skin_paths; | |
| 344 if ($add_path) { | |
| 345 array_unshift($skin_paths, $add_path); | |
| 346 } | |
| 347 | |
| 348 foreach ($skin_paths as $skin_path) { | |
| 349 $path = realpath(RCUBE_INSTALL_PATH . $skin_path . $file); | |
| 350 | |
| 351 if ($path && is_file($path)) { | |
| 352 return $skin_path . $file; | |
| 353 } | |
| 354 | |
| 355 if ($this->assets_dir != RCUBE_INSTALL_PATH) { | |
| 356 $path = realpath($this->assets_dir . $skin_path . $file); | |
| 357 | |
| 358 if ($path && is_file($path)) { | |
| 359 return $skin_path . $file; | |
| 360 } | |
| 361 } | |
| 362 } | |
| 363 | |
| 364 return false; | |
| 365 } | |
| 366 | |
| 367 /** | |
| 368 * Register a GUI object to the client script | |
| 369 * | |
| 370 * @param string $obj Object name | |
| 371 * @param string $id Object ID | |
| 372 */ | |
| 373 public function add_gui_object($obj, $id) | |
| 374 { | |
| 375 $this->add_script(self::JS_OBJECT_NAME.".gui_object('$obj', '$id');"); | |
| 376 } | |
| 377 | |
| 378 /** | |
| 379 * Call a client method | |
| 380 * | |
| 381 * @param string Method to call | |
| 382 * @param ... Additional arguments | |
| 383 */ | |
| 384 public function command() | |
| 385 { | |
| 386 $cmd = func_get_args(); | |
| 387 if (strpos($cmd[0], 'plugin.') !== false) | |
| 388 $this->js_commands[] = array('triggerEvent', $cmd[0], $cmd[1]); | |
| 389 else | |
| 390 $this->js_commands[] = $cmd; | |
| 391 } | |
| 392 | |
| 393 /** | |
| 394 * Add a localized label to the client environment | |
| 395 */ | |
| 396 public function add_label() | |
| 397 { | |
| 398 $args = func_get_args(); | |
| 399 | |
| 400 if (count($args) == 1 && is_array($args[0])) { | |
| 401 $args = $args[0]; | |
| 402 } | |
| 403 | |
| 404 foreach ($args as $name) { | |
| 405 $this->js_labels[$name] = $this->app->gettext($name); | |
| 406 } | |
| 407 } | |
| 408 | |
| 409 /** | |
| 410 * Invoke display_message command | |
| 411 * | |
| 412 * @param string $message Message to display | |
| 413 * @param string $type Message type [notice|confirm|error] | |
| 414 * @param array $vars Key-value pairs to be replaced in localized text | |
| 415 * @param boolean $override Override last set message | |
| 416 * @param int $timeout Message display time in seconds | |
| 417 * | |
| 418 * @uses self::command() | |
| 419 */ | |
| 420 public function show_message($message, $type='notice', $vars=null, $override=true, $timeout=0) | |
| 421 { | |
| 422 if ($override || !$this->message) { | |
| 423 if ($this->app->text_exists($message)) { | |
| 424 if (!empty($vars)) | |
| 425 $vars = array_map(array('rcube','Q'), $vars); | |
| 426 $msgtext = $this->app->gettext(array('name' => $message, 'vars' => $vars)); | |
| 427 } | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
428 else { |
| 0 | 429 $msgtext = $message; |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
430 } |
| 0 | 431 |
| 432 $this->message = $message; | |
| 433 $this->command('display_message', $msgtext, $type, $timeout * 1000); | |
| 434 } | |
| 435 } | |
| 436 | |
| 437 /** | |
| 438 * Delete all stored env variables and commands | |
| 439 * | |
| 440 * @param bool $all Reset all env variables (including internal) | |
| 441 */ | |
| 442 public function reset($all = false) | |
| 443 { | |
| 444 $framed = $this->framed; | |
| 445 $env = $all ? null : array_intersect_key($this->env, array('extwin'=>1, 'framed'=>1)); | |
| 446 | |
| 447 parent::reset(); | |
| 448 | |
| 449 // let some env variables survive | |
| 450 $this->env = $this->js_env = $env; | |
| 451 $this->framed = $framed || $this->env['framed']; | |
| 452 $this->js_labels = array(); | |
| 453 $this->js_commands = array(); | |
| 454 $this->script_files = array(); | |
| 455 $this->scripts = array(); | |
| 456 $this->header = ''; | |
| 457 $this->footer = ''; | |
| 458 $this->body = ''; | |
| 459 | |
| 460 // load defaults | |
| 461 if (!$all) { | |
| 462 $this->__construct(); | |
| 463 } | |
| 464 } | |
| 465 | |
| 466 /** | |
| 467 * Redirect to a certain url | |
| 468 * | |
| 469 * @param mixed $p Either a string with the action or url parameters as key-value pairs | |
| 470 * @param int $delay Delay in seconds | |
| 471 * @param bool $secure Redirect to secure location (see rcmail::url()) | |
| 472 */ | |
| 473 public function redirect($p = array(), $delay = 1, $secure = false) | |
| 474 { | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
475 if (!empty($this->env['extwin'])) |
| 0 | 476 $p['extwin'] = 1; |
| 477 $location = $this->app->url($p, false, false, $secure); | |
| 478 header('Location: ' . $location); | |
| 479 exit; | |
| 480 } | |
| 481 | |
| 482 /** | |
| 483 * Send the request output to the client. | |
| 484 * This will either parse a skin tempalte or send an AJAX response | |
| 485 * | |
| 486 * @param string $templ Template name | |
| 487 * @param boolean $exit True if script should terminate (default) | |
| 488 */ | |
| 489 public function send($templ = null, $exit = true) | |
| 490 { | |
| 491 if ($templ != 'iframe') { | |
| 492 // prevent from endless loops | |
| 493 if ($exit != 'recur' && $this->app->plugins->is_processing('render_page')) { | |
| 494 rcube::raise_error(array('code' => 505, 'type' => 'php', | |
| 495 'file' => __FILE__, 'line' => __LINE__, | |
| 496 'message' => 'Recursion alert: ignoring output->send()'), true, false); | |
| 497 return; | |
| 498 } | |
| 499 $this->parse($templ, false); | |
| 500 } | |
| 501 else { | |
| 502 $this->framed = true; | |
| 503 $this->write(); | |
| 504 } | |
| 505 | |
| 506 // set output asap | |
| 507 ob_flush(); | |
| 508 flush(); | |
| 509 | |
| 510 if ($exit) { | |
| 511 exit; | |
| 512 } | |
| 513 } | |
| 514 | |
| 515 /** | |
| 516 * Process template and write to stdOut | |
| 517 * | |
| 518 * @param string $template HTML template content | |
| 519 */ | |
| 520 public function write($template = '') | |
| 521 { | |
| 522 if (!empty($this->script_files)) { | |
| 523 $this->set_env('request_token', $this->app->get_request_token()); | |
| 524 } | |
| 525 | |
| 526 $commands = $this->get_js_commands($framed); | |
| 527 | |
| 528 // if all js commands go to parent window we can ignore all | |
| 529 // script files and skip rcube_webmail initialization (#1489792) | |
| 530 if ($framed) { | |
| 531 $this->scripts = array(); | |
| 532 $this->script_files = array(); | |
| 533 $this->header = ''; | |
| 534 $this->footer = ''; | |
| 535 } | |
| 536 | |
| 537 // write all javascript commands | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
538 if (!empty($commands)) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
539 $this->add_script($commands, 'head_top'); |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
540 } |
| 0 | 541 |
| 542 // allow (legal) iframe content to be loaded | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
543 $iframe = $this->framed || !empty($this->env['framed']); |
| 0 | 544 if (!headers_sent() && $iframe && ($xopt = $this->app->config->get('x_frame_options', 'sameorigin'))) { |
| 545 if (strtolower($xopt) != 'sameorigin') { | |
| 546 header('X-Frame-Options: sameorigin', true); | |
| 547 } | |
| 548 } | |
| 549 | |
| 550 // call super method | |
| 551 $this->_write($template, $this->config->get('skin_path')); | |
| 552 } | |
| 553 | |
| 554 /** | |
| 555 * Parse a specific skin template and deliver to stdout (or return) | |
| 556 * | |
| 557 * @param string $name Template name | |
| 558 * @param boolean $exit Exit script | |
| 559 * @param boolean $write Don't write to stdout, return parsed content instead | |
| 560 * | |
| 561 * @link http://php.net/manual/en/function.exit.php | |
| 562 */ | |
| 563 function parse($name = 'main', $exit = true, $write = true) | |
| 564 { | |
| 565 $plugin = false; | |
| 566 $realname = $name; | |
| 567 $plugin_skin_paths = array(); | |
| 568 | |
| 569 $this->template_name = $realname; | |
| 570 | |
| 571 $temp = explode('.', $name, 2); | |
| 572 if (count($temp) > 1) { | |
| 573 $plugin = $temp[0]; | |
| 574 $name = $temp[1]; | |
| 575 $skin_dir = $plugin . '/skins/' . $this->config->get('skin'); | |
| 576 | |
| 577 // apply skin search escalation list to plugin directory | |
| 578 foreach ($this->skin_paths as $skin_path) { | |
| 579 $plugin_skin_paths[] = $this->app->plugins->url . $plugin . '/' . $skin_path; | |
| 580 } | |
| 581 | |
| 582 // add fallback to default skin | |
| 583 if (is_dir($this->app->plugins->dir . $plugin . '/skins/default')) { | |
| 584 $skin_dir = $plugin . '/skins/default'; | |
| 585 $plugin_skin_paths[] = $this->app->plugins->url . $skin_dir; | |
| 586 } | |
| 587 | |
| 588 // prepend plugin skin paths to search list | |
| 589 $this->skin_paths = array_merge($plugin_skin_paths, $this->skin_paths); | |
| 590 } | |
| 591 | |
| 592 // find skin template | |
| 593 $path = false; | |
| 594 foreach ($this->skin_paths as $skin_path) { | |
| 595 $path = RCUBE_INSTALL_PATH . "$skin_path/templates/$name.html"; | |
| 596 | |
| 597 // fallback to deprecated template names | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
598 if (!is_readable($path) && !empty($this->deprecated_templates[$realname])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
599 $dname = $this->deprecated_templates[$realname]; |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
600 $path = RCUBE_INSTALL_PATH . "$skin_path/templates/$dname.html"; |
| 0 | 601 |
| 602 if (is_readable($path)) { | |
| 603 rcube::raise_error(array( | |
| 604 'code' => 502, 'file' => __FILE__, 'line' => __LINE__, | |
| 605 'message' => "Using deprecated template '$dname' in $skin_path/templates. Please rename to '$realname'" | |
| 606 ), true, false); | |
| 607 } | |
| 608 } | |
| 609 | |
| 610 if (is_readable($path)) { | |
| 611 $this->config->set('skin_path', $skin_path); | |
| 612 // set base_path to core skin directory (not plugin's skin) | |
| 613 $this->base_path = preg_replace('!plugins/\w+/!', '', $skin_path); | |
| 614 $skin_dir = preg_replace('!^plugins/!', '', $skin_path); | |
| 615 break; | |
| 616 } | |
| 617 else { | |
| 618 $path = false; | |
| 619 } | |
| 620 } | |
| 5 | 621 #rcube::write_log('mail',"skin: $skin_path $realname $path"); |
| 0 | 622 |
| 623 // read template file | |
| 624 if (!$path || ($templ = @file_get_contents($path)) === false) { | |
| 625 rcube::raise_error(array( | |
| 626 'code' => 404, | |
| 627 'type' => 'php', | |
| 628 'line' => __LINE__, | |
| 629 'file' => __FILE__, | |
| 630 'message' => 'Error loading template for '.$realname | |
| 631 ), true, $write); | |
| 632 | |
| 633 $this->skin_paths = array_slice($this->skin_paths, count($plugin_skin_paths)); | |
| 634 return false; | |
| 635 } | |
| 636 | |
| 637 // replace all path references to plugins/... with the configured plugins dir | |
| 638 // and /this/ to the current plugin skin directory | |
| 639 if ($plugin) { | |
| 640 $templ = preg_replace( | |
| 641 array('/\bplugins\//', '/(["\']?)\/this\//'), | |
| 642 array($this->app->plugins->url, '\\1'.$this->app->plugins->url.$skin_dir.'/'), | |
| 643 $templ | |
| 644 ); | |
| 645 } | |
| 646 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
647 // parse for special tags |
| 0 | 648 $output = $this->parse_conditions($templ); |
| 649 $output = $this->parse_xml($output); | |
| 5 | 650 #rcube::write_log('mail',"px: ".strlen($output)); |
| 0 | 651 |
| 652 // trigger generic hook where plugins can put additional content to the page | |
| 653 $hook = $this->app->plugins->exec_hook("render_page", array('template' => $realname, 'content' => $output)); | |
| 654 | |
| 655 // save some memory | |
| 656 $output = $hook['content']; | |
| 657 unset($hook['content']); | |
| 658 | |
| 659 // remove plugin skin paths from current context | |
| 660 $this->skin_paths = array_slice($this->skin_paths, count($plugin_skin_paths)); | |
| 661 | |
| 662 if (!$write) { | |
| 663 return $this->postrender($output); | |
| 664 } | |
| 665 | |
| 666 $this->write(trim($output)); | |
| 667 | |
| 668 if ($exit) { | |
| 669 exit; | |
| 670 } | |
| 671 } | |
| 672 | |
| 673 /** | |
| 674 * Return executable javascript code for all registered commands | |
| 675 */ | |
| 676 protected function get_js_commands(&$framed = null) | |
| 677 { | |
| 678 $out = ''; | |
| 679 $parent_commands = 0; | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
680 $parent_prefix = ''; |
| 0 | 681 $top_commands = array(); |
| 682 | |
| 683 // these should be always on top, | |
| 684 // e.g. hide_message() below depends on env.framed | |
| 685 if (!$this->framed && !empty($this->js_env)) { | |
| 686 $top_commands[] = array('set_env', $this->js_env); | |
| 687 } | |
| 688 if (!empty($this->js_labels)) { | |
| 689 $top_commands[] = array('add_label', $this->js_labels); | |
| 690 } | |
| 691 | |
| 692 // unlock interface after iframe load | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
693 $unlock = isset($_REQUEST['_unlock']) ? preg_replace('/[^a-z0-9]/i', '', $_REQUEST['_unlock']) : 0; |
| 0 | 694 if ($this->framed) { |
| 695 $top_commands[] = array('iframe_loaded', $unlock); | |
| 696 } | |
| 697 else if ($unlock) { | |
| 698 $top_commands[] = array('hide_message', $unlock); | |
| 699 } | |
| 700 | |
| 701 $commands = array_merge($top_commands, $this->js_commands); | |
| 702 | |
| 703 foreach ($commands as $i => $args) { | |
| 704 $method = array_shift($args); | |
| 705 $parent = $this->framed || preg_match('/^parent\./', $method); | |
| 706 | |
| 707 foreach ($args as $i => $arg) { | |
| 708 $args[$i] = self::json_serialize($arg, $this->devel_mode); | |
| 709 } | |
| 710 | |
| 711 if ($parent) { | |
| 712 $parent_commands++; | |
| 713 $method = preg_replace('/^parent\./', '', $method); | |
| 714 $parent_prefix = 'if (window.parent && parent.' . self::JS_OBJECT_NAME . ') parent.'; | |
| 715 $method = $parent_prefix . self::JS_OBJECT_NAME . '.' . $method; | |
| 716 } | |
| 717 else { | |
| 718 $method = self::JS_OBJECT_NAME . '.' . $method; | |
| 719 } | |
| 720 | |
| 721 $out .= sprintf("%s(%s);\n", $method, implode(',', $args)); | |
| 722 } | |
| 723 | |
| 724 $framed = $parent_prefix && $parent_commands == count($commands); | |
| 725 | |
| 726 // make the output more compact if all commands go to parent window | |
| 727 if ($framed) { | |
| 728 $out = "if (window.parent && parent." . self::JS_OBJECT_NAME . ") {\n" | |
| 729 . str_replace($parent_prefix, "\tparent.", $out) | |
| 730 . "}\n"; | |
| 731 } | |
| 732 | |
| 733 return $out; | |
| 734 } | |
| 735 | |
| 736 /** | |
| 737 * Make URLs starting with a slash point to skin directory | |
| 738 * | |
| 739 * @param string $str Input string | |
| 740 * @param bool $search_path True if URL should be resolved using the current skin path stack | |
| 741 * | |
| 742 * @return string URL | |
| 743 */ | |
| 744 public function abs_url($str, $search_path = false) | |
| 745 { | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
746 if (isset($str[0]) && $str[0] == '/') { |
| 0 | 747 if ($search_path && ($file_url = $this->get_skin_file($str, $skin_path))) { |
| 748 return $file_url; | |
| 749 } | |
| 750 | |
| 751 return $this->base_path . $str; | |
| 752 } | |
| 753 | |
| 754 return $str; | |
| 755 } | |
| 756 | |
| 757 /** | |
| 758 * Show error page and terminate script execution | |
| 759 * | |
| 760 * @param int $code Error code | |
| 761 * @param string $message Error message | |
| 762 */ | |
| 763 public function raise_error($code, $message) | |
| 764 { | |
| 765 global $__page_content, $ERROR_CODE, $ERROR_MESSAGE; | |
| 766 | |
| 767 $ERROR_CODE = $code; | |
| 768 $ERROR_MESSAGE = $message; | |
| 769 | |
| 770 include RCUBE_INSTALL_PATH . 'program/steps/utils/error.inc'; | |
| 771 exit; | |
| 772 } | |
| 773 | |
| 774 /** | |
| 775 * Modify path by adding URL prefix if configured | |
| 776 */ | |
| 777 public function asset_url($path) | |
| 778 { | |
| 779 // iframe content can't be in a different domain | |
| 780 // @TODO: check if assests are on a different domain | |
| 781 | |
| 782 if (!$this->assets_path || in_array($path[0], array('?', '/', '.')) || strpos($path, '://')) { | |
| 783 return $path; | |
| 784 } | |
| 785 | |
| 786 return $this->assets_path . $path; | |
| 787 } | |
| 788 | |
| 789 | |
| 790 /***** Template parsing methods *****/ | |
| 791 | |
| 792 /** | |
| 793 * Replace all strings ($varname) | |
| 794 * with the content of the according global variable. | |
| 795 */ | |
| 796 protected function parse_with_globals($input) | |
| 797 { | |
| 798 $GLOBALS['__version'] = html::quote(RCMAIL_VERSION); | |
| 799 $GLOBALS['__comm_path'] = html::quote($this->app->comm_path); | |
| 800 $GLOBALS['__skin_path'] = html::quote($this->base_path); | |
| 801 | |
| 802 return preg_replace_callback('/\$(__[a-z0-9_\-]+)/', | |
| 803 array($this, 'globals_callback'), $input); | |
| 804 } | |
| 805 | |
| 806 /** | |
| 807 * Callback function for preg_replace_callback() in parse_with_globals() | |
| 808 */ | |
| 809 protected function globals_callback($matches) | |
| 810 { | |
| 811 return $GLOBALS[$matches[1]]; | |
| 812 } | |
| 813 | |
| 814 /** | |
| 815 * Correct absolute paths in images and other tags | |
| 816 * add timestamp to .js and .css filename | |
| 817 */ | |
| 818 protected function fix_paths($output) | |
| 819 { | |
| 820 return preg_replace_callback( | |
| 821 '!(src|href|background)=(["\']?)([a-z0-9/_.-]+)(["\'\s>])!i', | |
| 822 array($this, 'file_callback'), $output); | |
| 823 } | |
| 824 | |
| 825 /** | |
| 826 * Callback function for preg_replace_callback in fix_paths() | |
| 827 * | |
| 828 * @return string Parsed string | |
| 829 */ | |
| 830 protected function file_callback($matches) | |
| 831 { | |
| 832 $file = $matches[3]; | |
| 833 $file = preg_replace('!^/this/!', '/', $file); | |
| 834 | |
| 835 // correct absolute paths | |
| 836 if ($file[0] == '/') { | |
| 837 $file = $this->base_path . $file; | |
| 838 } | |
| 839 | |
| 840 // add file modification timestamp | |
| 841 if (preg_match('/\.(js|css)$/', $file, $m)) { | |
| 842 $file = $this->file_mod($file); | |
| 843 } | |
| 844 | |
| 845 return $matches[1] . '=' . $matches[2] . $file . $matches[4]; | |
| 846 } | |
| 847 | |
| 848 /** | |
| 849 * Correct paths of asset files according to assets_path | |
| 850 */ | |
| 851 protected function fix_assets_paths($output) | |
| 852 { | |
| 853 return preg_replace_callback( | |
| 854 '!(src|href|background)=(["\']?)([a-z0-9/_.?=-]+)(["\'\s>])!i', | |
| 855 array($this, 'assets_callback'), $output); | |
| 856 } | |
| 857 | |
| 858 /** | |
| 859 * Callback function for preg_replace_callback in fix_assets_paths() | |
| 860 * | |
| 861 * @return string Parsed string | |
| 862 */ | |
| 863 protected function assets_callback($matches) | |
| 864 { | |
| 865 $file = $this->asset_url($matches[3]); | |
| 866 | |
| 867 return $matches[1] . '=' . $matches[2] . $file . $matches[4]; | |
| 868 } | |
| 869 | |
| 870 /** | |
| 871 * Modify file by adding mtime indicator | |
| 872 */ | |
| 873 protected function file_mod($file) | |
| 874 { | |
| 875 $fs = false; | |
| 876 $ext = substr($file, strrpos($file, '.') + 1); | |
| 877 | |
| 878 // use minified file if exists (not in development mode) | |
| 879 if (!$this->devel_mode && !preg_match('/\.min\.' . $ext . '$/', $file)) { | |
| 880 $minified_file = substr($file, 0, strlen($ext) * -1) . 'min.' . $ext; | |
| 881 if ($fs = @filemtime($this->assets_dir . $minified_file)) { | |
| 882 return $minified_file . '?s=' . $fs; | |
| 883 } | |
| 884 } | |
| 885 | |
| 886 if ($fs = @filemtime($this->assets_dir . $file)) { | |
| 887 $file .= '?s=' . $fs; | |
| 888 } | |
| 889 | |
| 890 return $file; | |
| 891 } | |
| 892 | |
| 893 /** | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
894 * Public wrapper to dip into template parsing. |
| 0 | 895 * |
| 896 * @param string $input Template content | |
| 897 * | |
| 898 * @return string | |
| 899 * @uses rcmail_output_html::parse_xml() | |
| 900 * @since 0.1-rc1 | |
| 901 */ | |
| 902 public function just_parse($input) | |
| 903 { | |
| 904 $input = $this->parse_conditions($input); | |
| 905 $input = $this->parse_xml($input); | |
| 906 $input = $this->postrender($input); | |
| 907 | |
| 908 return $input; | |
| 909 } | |
| 910 | |
| 911 /** | |
| 912 * Parse for conditional tags | |
| 913 */ | |
| 914 protected function parse_conditions($input) | |
| 915 { | |
| 916 $matches = preg_split('/<roundcube:(if|elseif|else|endif)\s+([^>]+)>\n?/is', $input, 2, PREG_SPLIT_DELIM_CAPTURE); | |
| 917 if ($matches && count($matches) == 4) { | |
| 918 if (preg_match('/^(else|endif)$/i', $matches[1])) { | |
| 919 return $matches[0] . $this->parse_conditions($matches[3]); | |
| 920 } | |
| 921 | |
| 922 $attrib = html::parse_attrib_string($matches[2]); | |
| 923 | |
| 924 if (isset($attrib['condition'])) { | |
| 925 $condmet = $this->check_condition($attrib['condition']); | |
| 926 $submatches = preg_split('/<roundcube:(elseif|else|endif)\s+([^>]+)>\n?/is', $matches[3], 2, PREG_SPLIT_DELIM_CAPTURE); | |
| 927 | |
| 928 if ($condmet) { | |
| 929 $result = $submatches[0]; | |
| 930 if ($submatches[1] != 'endif') { | |
| 931 $result .= preg_replace('/.*<roundcube:endif\s+[^>]+>\n?/Uis', '', $submatches[3], 1); | |
| 932 } | |
| 933 else { | |
| 934 $result .= $submatches[3]; | |
| 935 } | |
| 936 } | |
| 937 else { | |
| 938 $result = "<roundcube:$submatches[1] $submatches[2]>" . $submatches[3]; | |
| 939 } | |
| 940 | |
| 941 return $matches[0] . $this->parse_conditions($result); | |
| 942 } | |
| 943 | |
| 944 rcube::raise_error(array( | |
| 945 'code' => 500, 'line' => __LINE__, 'file' => __FILE__, | |
| 946 'message' => "Unable to parse conditional tag " . $matches[2] | |
| 947 ), true, false); | |
| 948 } | |
| 949 | |
| 950 return $input; | |
| 951 } | |
| 952 | |
| 953 /** | |
| 954 * Determines if a given condition is met | |
| 955 * | |
| 956 * @param string $condition Condition statement | |
| 957 * | |
| 958 * @return boolean True if condition is met, False if not | |
| 959 * @todo Extend this to allow real conditions, not just "set" | |
| 960 */ | |
| 961 protected function check_condition($condition) | |
| 962 { | |
| 963 return $this->eval_expression($condition); | |
| 964 } | |
| 965 | |
| 966 /** | |
| 967 * Inserts hidden field with CSRF-prevention-token into POST forms | |
| 968 */ | |
| 969 protected function alter_form_tag($matches) | |
| 970 { | |
| 971 $out = $matches[0]; | |
| 972 $attrib = html::parse_attrib_string($matches[1]); | |
| 973 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
974 if (!empty($attrib['method']) && strtolower($attrib['method']) == 'post') { |
| 0 | 975 $hidden = new html_hiddenfield(array('name' => '_token', 'value' => $this->app->get_request_token())); |
| 976 $out .= "\n" . $hidden->show(); | |
| 977 } | |
| 978 | |
| 979 return $out; | |
| 980 } | |
| 981 | |
| 982 /** | |
| 983 * Parse & evaluate a given expression and return its result. | |
| 984 * | |
| 985 * @param string $expression Expression statement | |
| 986 * | |
| 987 * @return mixed Expression result | |
| 988 */ | |
| 989 protected function eval_expression($expression) | |
| 990 { | |
| 991 $expression = preg_replace( | |
| 992 array( | |
| 993 '/session:([a-z0-9_]+)/i', | |
| 994 '/config:([a-z0-9_]+)(:([a-z0-9_]+))?/i', | |
| 995 '/env:([a-z0-9_]+)/i', | |
| 996 '/request:([a-z0-9_]+)/i', | |
| 997 '/cookie:([a-z0-9_]+)/i', | |
| 998 '/browser:([a-z0-9_]+)/i', | |
| 999 '/template:name/i', | |
| 1000 ), | |
| 1001 array( | |
| 1002 "\$_SESSION['\\1']", | |
| 1003 "\$this->app->config->get('\\1',rcube_utils::get_boolean('\\3'))", | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1004 "(\$this->env['\\1'] ?? null)", |
| 0 | 1005 "rcube_utils::get_input_value('\\1', rcube_utils::INPUT_GPC)", |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1006 "(\$_COOKIE['\\1'] ?? null)", |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1007 "(\$this->browser->{'\\1'} ?? null)", |
| 0 | 1008 "'{$this->template_name}'", |
| 1009 ), | |
| 1010 $expression | |
| 1011 ); | |
| 1012 | |
| 1013 // Note: We used create_function() before but it's deprecated in PHP 7.2 | |
| 1014 // and really it was just a wrapper on eval(). | |
| 1015 return eval("return ($expression);"); | |
| 1016 } | |
| 1017 | |
| 1018 /** | |
| 1019 * Search for special tags in input and replace them | |
| 1020 * with the appropriate content | |
| 1021 * | |
| 1022 * @param string $input Input string to parse | |
| 1023 * | |
| 1024 * @return string Altered input string | |
| 1025 * @todo Use DOM-parser to traverse template HTML | |
| 1026 * @todo Maybe a cache. | |
| 1027 */ | |
| 1028 protected function parse_xml($input) | |
| 1029 { | |
| 1030 return preg_replace_callback('/<roundcube:([-_a-z]+)\s+((?:[^>]|\\\\>)+)(?<!\\\\)>/Ui', array($this, 'xml_command'), $input); | |
| 1031 } | |
| 1032 | |
| 1033 /** | |
| 1034 * Callback function for parsing an xml command tag | |
| 1035 * and turn it into real html content | |
| 1036 * | |
| 1037 * @param array $matches Matches array of preg_replace_callback | |
| 1038 * | |
| 1039 * @return string Tag/Object content | |
| 1040 */ | |
| 1041 protected function xml_command($matches) | |
| 1042 { | |
| 1043 $command = strtolower($matches[1]); | |
| 1044 $attrib = html::parse_attrib_string($matches[2]); | |
| 1045 | |
| 1046 // empty output if required condition is not met | |
| 1047 if (!empty($attrib['condition']) && !$this->check_condition($attrib['condition'])) { | |
| 1048 return ''; | |
| 1049 } | |
| 1050 | |
| 1051 // localize title and summary attributes | |
| 1052 if ($command != 'button' && !empty($attrib['title']) && $this->app->text_exists($attrib['title'])) { | |
| 1053 $attrib['title'] = $this->app->gettext($attrib['title']); | |
| 1054 } | |
| 1055 if ($command != 'button' && !empty($attrib['summary']) && $this->app->text_exists($attrib['summary'])) { | |
| 1056 $attrib['summary'] = $this->app->gettext($attrib['summary']); | |
| 1057 } | |
| 1058 | |
| 1059 // execute command | |
| 1060 switch ($command) { | |
| 1061 // return a button | |
| 1062 case 'button': | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1063 if (!empty($attrib['name']) || !empty($attrib['command'])) { |
| 5 | 1064 #rcube::write_log('lab',"button in: ".print_r($attrib,true)); |
| 1065 $but = $this->button($attrib); | |
| 1066 #rcube::write_log('lab',"button out:\n$but"); | |
| 1067 return $but; | |
| 1068 | |
| 0 | 1069 } |
| 1070 break; | |
| 1071 | |
| 1072 // frame | |
| 1073 case 'frame': | |
| 1074 return $this->frame($attrib); | |
| 1075 break; | |
| 1076 | |
| 1077 // show a label | |
| 1078 case 'label': | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1079 if (!empty($attrib['expression'])) { |
| 0 | 1080 $attrib['name'] = $this->eval_expression($attrib['expression']); |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1081 } |
| 0 | 1082 |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1083 if (!empty($attrib['name']) || !empty($attrib['command'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1084 $vars = $attrib + ['product' => $this->config->get('product_name')]; |
| 0 | 1085 unset($vars['name'], $vars['command']); |
| 1086 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1087 $label = $this->app->gettext($attrib + ['vars' => $vars]); |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1088 $quoting = null; |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1089 |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1090 if (!empty($attrib['quoting'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1091 $quoting = strtolower($attrib['quoting']); |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1092 } |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1093 else if (isset($attrib['html'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1094 $quoting = rcube_utils::get_boolean((string) $attrib['html']) ? 'no' : ''; |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1095 } |
| 0 | 1096 |
| 1097 // 'noshow' can be used in skins to define new labels | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1098 if (!empty($attrib['noshow'])) { |
| 0 | 1099 return ''; |
| 1100 } | |
| 1101 | |
| 1102 switch ($quoting) { | |
| 1103 case 'no': | |
| 1104 case 'raw': | |
| 1105 break; | |
| 1106 case 'javascript': | |
| 1107 case 'js': | |
| 1108 $label = rcube::JQ($label); | |
| 1109 break; | |
| 1110 default: | |
| 1111 $label = html::quote($label); | |
| 1112 break; | |
| 1113 } | |
| 1114 | |
| 1115 return $label; | |
| 1116 } | |
| 1117 break; | |
| 1118 | |
| 1119 case 'add_label': | |
| 1120 $this->add_label($attrib['name']); | |
| 1121 break; | |
| 1122 | |
| 1123 // include a file | |
| 1124 case 'include': | |
| 1125 $old_base_path = $this->base_path; | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1126 $attr_skin_path = !empty($attrib['skinpath']) ? $attrib['skinpath'] : null; |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1127 |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1128 if (!empty($attrib['skin_path'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1129 $attr_skin_path = $attrib['skin_path']; |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1130 } |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1131 |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1132 if ($path = $this->get_skin_file($attrib['file'], $skin_path, $attr_skin_path)) { |
| 0 | 1133 // set base_path to core skin directory (not plugin's skin) |
| 1134 $this->base_path = preg_replace('!plugins/\w+/!', '', $skin_path); | |
| 1135 $path = realpath(RCUBE_INSTALL_PATH . $path); | |
| 1136 } | |
| 1137 | |
| 1138 if (is_readable($path)) { | |
| 1139 if ($this->config->get('skin_include_php')) { | |
| 1140 $incl = $this->include_php($path); | |
| 1141 } | |
| 1142 else { | |
| 1143 $incl = file_get_contents($path); | |
| 1144 } | |
| 1145 $incl = $this->parse_conditions($incl); | |
| 1146 $incl = $this->parse_xml($incl); | |
| 1147 $incl = $this->fix_paths($incl); | |
| 1148 $this->base_path = $old_base_path; | |
| 1149 return $incl; | |
| 1150 } | |
| 1151 break; | |
| 1152 | |
| 1153 case 'plugin.include': | |
| 1154 $hook = $this->app->plugins->exec_hook("template_plugin_include", $attrib); | |
| 1155 return $hook['content']; | |
| 1156 | |
| 1157 // define a container block | |
| 1158 case 'container': | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1159 if (!empty($attrib['name']) && !empty($attrib['id'])) { |
| 0 | 1160 $this->command('gui_container', $attrib['name'], $attrib['id']); |
| 1161 // let plugins insert some content here | |
| 1162 $hook = $this->app->plugins->exec_hook("template_container", $attrib); | |
| 1163 return $hook['content']; | |
| 1164 } | |
| 1165 break; | |
| 1166 | |
| 1167 // return code for a specific application object | |
| 1168 case 'object': | |
| 1169 $object = strtolower($attrib['name']); | |
| 1170 $content = ''; | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1171 $handler = null; |
| 0 | 1172 |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1173 if (!empty($this->object_handlers[$object])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1174 $handler = $this->object_handlers[$object]; |
| 0 | 1175 } |
| 1176 // execute object handler function | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1177 if (is_callable($handler)) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1178 |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1179 // We assume that objects with src attribute are internal (in most |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1180 // cases this is a watermark frame). We need this to make sure assets_path |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1181 // is added to the internal assets paths |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1182 $external = empty($attrib['src']); |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1183 $content = call_user_func($handler, $attrib); |
| 0 | 1184 } |
| 1185 else if ($object == 'doctype') { | |
| 1186 $content = html::doctype($attrib['value']); | |
| 1187 } | |
| 1188 else if ($object == 'logo') { | |
| 1189 $attrib += array('alt' => $this->xml_command(array('', 'object', 'name="productname"'))); | |
| 1190 | |
| 1191 if ($logo = $this->config->get('skin_logo')) { | |
| 1192 if (is_array($logo)) { | |
| 1193 if ($template_logo = $logo[$this->template_name]) { | |
| 1194 $attrib['src'] = $template_logo; | |
| 1195 } | |
| 1196 elseif ($template_logo = $logo['*']) { | |
| 1197 $attrib['src'] = $template_logo; | |
| 1198 } | |
| 1199 } | |
| 1200 else { | |
| 1201 $attrib['src'] = $logo; | |
| 1202 } | |
| 1203 } | |
| 1204 | |
| 1205 $content = html::img($attrib); | |
| 1206 } | |
| 1207 else if ($object == 'productname') { | |
| 1208 $name = $this->config->get('product_name', 'Roundcube Webmail'); | |
| 1209 $content = html::quote($name); | |
| 1210 } | |
| 1211 else if ($object == 'version') { | |
| 1212 $ver = (string)RCMAIL_VERSION; | |
| 1213 if (is_file(RCUBE_INSTALL_PATH . '.svn/entries')) { | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1214 if (preg_match('/Revision:\s(\d+)/', (string) @shell_exec('svn info'), $regs)) |
| 0 | 1215 $ver .= ' [SVN r'.$regs[1].']'; |
| 1216 } | |
| 1217 else if (is_file(RCUBE_INSTALL_PATH . '.git/index')) { | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1218 if (preg_match('/Date:\s+([^\n]+)/', (string) @shell_exec('git log -1'), $regs)) { |
| 0 | 1219 if ($date = date('Ymd.Hi', strtotime($regs[1]))) { |
| 1220 $ver .= ' [GIT '.$date.']'; | |
| 1221 } | |
| 1222 } | |
| 1223 } | |
| 1224 $content = html::quote($ver); | |
| 1225 } | |
| 1226 else if ($object == 'steptitle') { | |
| 1227 $content = html::quote($this->get_pagetitle()); | |
| 1228 } | |
| 1229 else if ($object == 'pagetitle') { | |
| 1230 if ($this->devel_mode && !empty($_SESSION['username'])) | |
| 1231 $title = $_SESSION['username'].' :: '; | |
| 1232 else if ($prod_name = $this->config->get('product_name')) | |
| 1233 $title = $prod_name . ' :: '; | |
| 1234 else | |
| 1235 $title = ''; | |
| 1236 $title .= $this->get_pagetitle(); | |
| 1237 $content = html::quote($title); | |
| 1238 } | |
| 1239 | |
| 1240 // exec plugin hooks for this template object | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1241 $hook = $this->app->plugins->exec_hook("template_object_$object", $attrib + array('content' => (string) $content)); |
| 0 | 1242 |
| 1243 if (strlen($hook['content']) && !empty($external)) { | |
| 1244 $object_id = uniqid('TEMPLOBJECT:', true); | |
| 1245 $this->objects[$object_id] = $hook['content']; | |
| 1246 $hook['content'] = $object_id; | |
| 1247 } | |
| 1248 | |
| 1249 return $hook['content']; | |
| 1250 | |
| 1251 // return code for a specified eval expression | |
| 1252 case 'exp': | |
| 1253 return html::quote($this->eval_expression($attrib['expression'])); | |
| 1254 | |
| 1255 // return variable | |
| 1256 case 'var': | |
| 1257 $var = explode(':', $attrib['name']); | |
| 1258 $name = $var[1]; | |
| 1259 $value = ''; | |
| 1260 | |
| 1261 switch ($var[0]) { | |
| 1262 case 'env': | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1263 $value = $this->env[$name] ?? null; |
| 0 | 1264 break; |
| 1265 case 'config': | |
| 1266 $value = $this->config->get($name); | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1267 if (is_array($value) && !empty($value[$_SESSION['storage_host']])) { |
| 0 | 1268 $value = $value[$_SESSION['storage_host']]; |
| 1269 } | |
| 1270 break; | |
| 1271 case 'request': | |
| 1272 $value = rcube_utils::get_input_value($name, rcube_utils::INPUT_GPC); | |
| 1273 break; | |
| 1274 case 'session': | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1275 $value = $_SESSION[$name] ?? ''; |
| 0 | 1276 break; |
| 1277 case 'cookie': | |
| 1278 $value = htmlspecialchars($_COOKIE[$name]); | |
| 1279 break; | |
| 1280 case 'browser': | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1281 $value = $this->browser->{$name} ?? ''; |
| 0 | 1282 break; |
| 1283 } | |
| 1284 | |
| 1285 if (is_array($value)) { | |
| 1286 $value = implode(', ', $value); | |
| 1287 } | |
| 1288 | |
| 1289 return html::quote($value); | |
| 1290 | |
| 1291 case 'form': | |
| 1292 return $this->form_tag($attrib); | |
| 1293 } | |
| 1294 return ''; | |
| 1295 } | |
| 1296 | |
| 1297 /** | |
| 1298 * Include a specific file and return it's contents | |
| 1299 * | |
| 1300 * @param string $file File path | |
| 1301 * | |
| 1302 * @return string Contents of the processed file | |
| 1303 */ | |
| 1304 protected function include_php($file) | |
| 1305 { | |
| 1306 ob_start(); | |
| 1307 include $file; | |
| 1308 $out = ob_get_contents(); | |
| 1309 ob_end_clean(); | |
| 1310 | |
| 1311 return $out; | |
| 1312 } | |
| 1313 | |
| 1314 /** | |
| 1315 * Put objects' content back into template output | |
| 1316 */ | |
| 1317 protected function postrender($output) | |
| 1318 { | |
| 1319 // insert objects' contents | |
| 1320 foreach ($this->objects as $key => $val) { | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1321 $output = str_replace($key, (string) $val, $output, $count); |
| 0 | 1322 if ($count) { |
| 1323 $this->objects[$key] = null; | |
| 1324 } | |
| 1325 } | |
| 1326 | |
| 1327 // make sure all <form> tags have a valid request token | |
| 1328 $output = preg_replace_callback('/<form\s+([^>]+)>/Ui', array($this, 'alter_form_tag'), $output); | |
| 1329 | |
| 1330 return $output; | |
| 1331 } | |
| 1332 | |
| 1333 /** | |
| 1334 * Create and register a button | |
| 1335 * | |
| 1336 * @param array $attrib Named button attributes | |
| 1337 * | |
| 1338 * @return string HTML button | |
| 1339 * @todo Remove all inline JS calls and use jQuery instead. | |
| 1340 * @todo Remove all sprintf()'s - they are pretty, but also slow. | |
| 1341 */ | |
| 1342 public function button($attrib) | |
| 1343 { | |
| 1344 static $s_button_count = 100; | |
| 1345 static $disabled_actions = null; | |
| 1346 | |
| 1347 // these commands can be called directly via url | |
| 1348 $a_static_commands = array('compose', 'list', 'preferences', 'folders', 'identities'); | |
| 1349 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1350 if (empty($attrib['command']) && empty($attrib['name']) && empty($attrib['href'])) { |
| 0 | 1351 return ''; |
| 1352 } | |
| 1353 | |
| 1354 // try to find out the button type | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1355 if (!empty($attrib['type'])) { |
| 0 | 1356 $attrib['type'] = strtolower($attrib['type']); |
| 1357 if ($pos = strpos($attrib['type'], '-menuitem')) { | |
| 1358 $attrib['type'] = substr($attrib['type'], 0, -9); | |
| 1359 $menuitem = true; | |
| 1360 } | |
| 1361 } | |
| 1362 else { | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1363 $attrib['type'] = (!empty($attrib['image']) || !empty($attrib['imagepas']) || !empty($attrib['imageact'])) ? 'image' : 'link'; |
| 0 | 1364 } |
| 1365 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1366 $command = $attrib['command']??''; |
| 0 | 1367 |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1368 if (!empty($attrib['task'])) { |
| 0 | 1369 $element = $command = $attrib['task'] . '.' . $command; |
| 1370 } | |
| 1371 else { | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1372 $element = (!empty($this->env['task']) ? $this->env['task'] . '.' : '') . $command; |
| 0 | 1373 } |
| 1374 | |
| 1375 if ($disabled_actions === null) { | |
| 1376 $disabled_actions = (array) $this->config->get('disabled_actions'); | |
| 1377 } | |
| 1378 | |
| 1379 // remove buttons for disabled actions | |
| 1380 if (in_array($element, $disabled_actions)) { | |
| 1381 return ''; | |
| 1382 } | |
| 1383 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1384 if (empty($attrib['image'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1385 if (!empty($attrib['imagepas'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1386 $attrib['image'] = $attrib['imagepas']; |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1387 } |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1388 else if (!empty($attrib['imageact'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1389 $attrib['image'] = $attrib['imageact']; |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1390 } |
| 0 | 1391 } |
| 1392 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1393 if (empty($attrib['id'])) { |
| 0 | 1394 $attrib['id'] = sprintf('rcmbtn%d', $s_button_count++); |
| 1395 } | |
| 1396 // get localized text for labels and titles | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1397 $domain = !empty($attrib['domain']) ? $attrib['domain'] : null; |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1398 if (!empty($attrib['title'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1399 $attrib['title'] = html::quote($this->app->gettext($attrib['title'], $domain)); |
| 0 | 1400 } |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1401 if (!empty($attrib['label'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1402 $attrib['label'] = html::quote($this->app->gettext($attrib['label'], $domain)); |
| 0 | 1403 } |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1404 if (!empty($attrib['alt'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1405 $attrib['alt'] = html::quote($this->app->gettext($attrib['alt'], $domain)); |
| 0 | 1406 } |
| 1407 | |
| 1408 // set accessibility attributes | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1409 if (empty($attrib['role'])) { |
| 0 | 1410 $attrib['role'] = 'button'; |
| 1411 } | |
| 1412 if (!empty($attrib['class']) && !empty($attrib['classact']) || !empty($attrib['imagepas']) && !empty($attrib['imageact'])) { | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1413 if (array_key_exists('tabindex', $attrib)) { |
| 0 | 1414 $attrib['data-tabindex'] = $attrib['tabindex']; |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1415 } |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1416 $attrib['tabindex'] = '-1'; // disable button by default |
| 0 | 1417 $attrib['aria-disabled'] = 'true'; |
| 1418 } | |
| 1419 | |
| 1420 // set title to alt attribute for IE browsers | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1421 if ($this->browser->ie && empty($attrib['title']) && !empty($attrib['alt'])) { |
| 0 | 1422 $attrib['title'] = $attrib['alt']; |
| 1423 } | |
| 1424 | |
| 1425 // add empty alt attribute for XHTML compatibility | |
| 1426 if (!isset($attrib['alt'])) { | |
| 1427 $attrib['alt'] = ''; | |
| 1428 } | |
| 1429 | |
| 1430 // register button in the system | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1431 if (!empty($attrib['command'])) { |
| 0 | 1432 $this->add_script(sprintf( |
| 1433 "%s.register_button('%s', '%s', '%s', '%s', '%s', '%s');", | |
| 1434 self::JS_OBJECT_NAME, | |
| 1435 $command, | |
| 1436 $attrib['id'], | |
| 1437 $attrib['type'], | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1438 !empty($attrib['imageact']) ? $this->abs_url($attrib['imageact']) : (!empty($attrib['classact']) ? $attrib['classact'] : ''), |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1439 !empty($attrib['imagesel']) ? $this->abs_url($attrib['imagesel']) : (!empty($attrib['classsel']) ? $attrib['classsel'] : ''), |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1440 !empty($attrib['imageover']) ? $this->abs_url($attrib['imageover']) : '' |
| 0 | 1441 )); |
| 1442 | |
| 1443 // make valid href to specific buttons | |
| 1444 if (in_array($attrib['command'], rcmail::$main_tasks)) { | |
| 1445 $attrib['href'] = $this->app->url(array('task' => $attrib['command'])); | |
| 1446 $attrib['onclick'] = sprintf("return %s.command('switch-task','%s',this,event)", self::JS_OBJECT_NAME, $attrib['command']); | |
| 1447 } | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1448 else if (!empty($attrib['task']) && in_array($attrib['task'], rcmail::$main_tasks)) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1449 $attrib['href'] = $this->app->url(['action' => $attrib['command'], 'task' => $attrib['task']]); |
| 0 | 1450 } |
| 1451 else if (in_array($attrib['command'], $a_static_commands)) { | |
| 1452 $attrib['href'] = $this->app->url(array('action' => $attrib['command'])); | |
| 1453 } | |
| 1454 else if (($attrib['command'] == 'permaurl' || $attrib['command'] == 'extwin') && !empty($this->env['permaurl'])) { | |
| 1455 $attrib['href'] = $this->env['permaurl']; | |
| 1456 } | |
| 1457 } | |
| 1458 | |
| 1459 // overwrite attributes | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1460 if (empty($attrib['href'])) { |
| 0 | 1461 $attrib['href'] = '#'; |
| 1462 } | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1463 |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1464 if (!empty($attrib['task'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1465 if (!empty($attrib['classact'])) { |
| 0 | 1466 $attrib['class'] = $attrib['classact']; |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1467 } |
| 0 | 1468 } |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1469 else if ($command && empty($attrib['onclick'])) { |
| 0 | 1470 $attrib['onclick'] = sprintf( |
| 1471 "return %s.command('%s','%s',this,event)", | |
| 1472 self::JS_OBJECT_NAME, | |
| 1473 $command, | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1474 !empty($attrib['prop']) ? $attrib['prop'] : '' |
| 0 | 1475 ); |
| 1476 } | |
| 1477 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1478 $out = ''; |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1479 $btn_content = null; |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1480 $link_attrib = []; |
| 0 | 1481 |
| 1482 // generate image tag | |
| 1483 if ($attrib['type'] == 'image') { | |
| 1484 $attrib_str = html::attrib_string( | |
| 1485 $attrib, | |
| 1486 array( | |
| 1487 'style', 'class', 'id', 'width', 'height', 'border', 'hspace', | |
| 1488 'vspace', 'align', 'alt', 'tabindex', 'title' | |
| 1489 ) | |
| 1490 ); | |
| 1491 $btn_content = sprintf('<img src="%s"%s />', $this->abs_url($attrib['image']), $attrib_str); | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1492 if (!empty($attrib['label'])) { |
| 0 | 1493 $btn_content .= ' '.$attrib['label']; |
| 1494 } | |
| 1495 $link_attrib = array('href', 'onclick', 'onmouseover', 'onmouseout', 'onmousedown', 'onmouseup', 'target'); | |
| 1496 } | |
| 1497 else if ($attrib['type'] == 'link') { | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1498 $btn_content = $attrib['content'] ?? (!empty($attrib['label']) ? $attrib['label'] : $attrib['command']); |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1499 $link_attrib = array_merge(html::$common_attrib, ['href', 'onclick', 'tabindex', 'target', 'rel']); |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1500 if (!empty($attrib['innerclass'])) { |
| 0 | 1501 $btn_content = html::span($attrib['innerclass'], $btn_content); |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1502 } |
| 0 | 1503 } |
| 1504 else if ($attrib['type'] == 'input') { | |
| 1505 $attrib['type'] = 'button'; | |
| 1506 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1507 if (!empty($attrib['label'])) { |
| 0 | 1508 $attrib['value'] = $attrib['label']; |
| 1509 } | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1510 if (!empty($attrib['command'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1511 $attrib['disabled'] = 'disabled'; |
| 0 | 1512 } |
| 1513 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1514 $out = html::tag('input', $attrib, null, ['type', 'value', 'onclick', 'id', 'class', 'style', 'tabindex', 'disabled']); |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1515 } |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1516 else { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1517 if (!empty($attrib['label'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1518 $attrib['value'] = $attrib['label']; |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1519 } |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1520 if (!empty($attrib['command'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1521 $attrib['disabled'] = 'disabled'; |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1522 } |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1523 |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1524 $content = $attrib['content'] ?? $attrib['label']; |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1525 $out = html::tag('button', $attrib, $content, ['type', 'value', 'onclick', 'id', 'class', 'style', 'tabindex', 'disabled']); |
| 0 | 1526 } |
| 1527 | |
| 1528 // generate html code for button | |
| 1529 if ($btn_content) { | |
| 1530 $attrib_str = html::attrib_string($attrib, $link_attrib); | |
| 1531 $out = sprintf('<a%s>%s</a>', $attrib_str, $btn_content); | |
| 1532 } | |
| 1533 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1534 if (!empty($attrib['wrapper'])) { |
| 0 | 1535 $out = html::tag($attrib['wrapper'], null, $out); |
| 1536 } | |
| 1537 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1538 if (!empty($menuitem)) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1539 $class = !empty($attrib['menuitem-class']) ? ' class="' . $attrib['menuitem-class'] . '"' : ''; |
| 0 | 1540 $out = '<li role="menuitem"' . $class . '>' . $out . '</li>'; |
| 1541 } | |
| 1542 | |
| 1543 return $out; | |
| 1544 } | |
| 1545 | |
| 1546 /** | |
| 1547 * Link an external script file | |
| 1548 * | |
| 1549 * @param string $file File URL | |
| 1550 * @param string $position Target position [head|foot] | |
| 1551 */ | |
| 1552 public function include_script($file, $position='head') | |
| 1553 { | |
| 1554 if (!preg_match('|^https?://|i', $file) && $file[0] != '/') { | |
| 1555 $file = $this->file_mod($this->scripts_path . $file); | |
| 1556 } | |
| 1557 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1558 if (!isset($this->script_files[$position]) || !is_array($this->script_files[$position])) { |
| 0 | 1559 $this->script_files[$position] = array(); |
| 1560 } | |
| 1561 | |
| 1562 if (!in_array($file, $this->script_files[$position])) { | |
| 1563 $this->script_files[$position][] = $file; | |
| 1564 } | |
| 1565 } | |
| 1566 | |
| 1567 /** | |
| 1568 * Add inline javascript code | |
| 1569 * | |
| 1570 * @param string $script JS code snippet | |
| 1571 * @param string $position Target position [head|head_top|foot] | |
| 1572 */ | |
| 1573 public function add_script($script, $position='head') | |
| 1574 { | |
| 1575 if (!isset($this->scripts[$position])) { | |
| 1576 $this->scripts[$position] = "\n" . rtrim($script); | |
| 1577 } | |
| 1578 else { | |
| 1579 $this->scripts[$position] .= "\n" . rtrim($script); | |
| 1580 } | |
| 1581 } | |
| 1582 | |
| 1583 /** | |
| 1584 * Link an external css file | |
| 1585 * | |
| 1586 * @param string $file File URL | |
| 1587 */ | |
| 1588 public function include_css($file) | |
| 1589 { | |
| 1590 $this->css_files[] = $file; | |
| 1591 } | |
| 1592 | |
| 1593 /** | |
| 1594 * Add HTML code to the page header | |
| 1595 * | |
| 1596 * @param string $str HTML code | |
| 1597 */ | |
| 1598 public function add_header($str) | |
| 1599 { | |
| 1600 $this->header .= "\n" . $str; | |
| 1601 } | |
| 1602 | |
| 1603 /** | |
| 1604 * Add HTML code to the page footer | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1605 * To be added right before </body> |
| 0 | 1606 * |
| 1607 * @param string $str HTML code | |
| 1608 */ | |
| 1609 public function add_footer($str) | |
| 1610 { | |
| 1611 $this->footer .= "\n" . $str; | |
| 1612 } | |
| 1613 | |
| 1614 /** | |
| 1615 * Process template and write to stdOut | |
| 1616 * | |
| 1617 * @param string $templ HTML template | |
| 1618 * @param string $base_path Base for absolute paths | |
| 1619 */ | |
| 1620 protected function _write($templ = '', $base_path = '') | |
| 1621 { | |
| 1622 $output = trim($templ); | |
| 1623 | |
| 1624 if (empty($output)) { | |
| 1625 $output = html::doctype('html5') . "\n" . $this->default_template; | |
| 1626 $is_empty = true; | |
| 1627 } | |
| 1628 | |
| 1629 // set default page title | |
| 1630 if (empty($this->pagetitle)) { | |
| 1631 $this->pagetitle = 'Roundcube Mail'; | |
| 1632 } | |
| 1633 | |
| 1634 // declare page language | |
| 1635 if (!empty($_SESSION['language'])) { | |
| 1636 $lang = substr($_SESSION['language'], 0, 2); | |
| 1637 $output = preg_replace('/<html/', '<html lang="' . html::quote($lang) . '"', $output, 1); | |
| 1638 if (!headers_sent()) { | |
| 1639 header('Content-Language: ' . $lang); | |
| 1640 } | |
| 1641 } | |
| 1642 | |
| 1643 // replace specialchars in content | |
| 1644 $page_title = html::quote($this->pagetitle); | |
| 1645 $page_header = ''; | |
| 1646 $page_footer = ''; | |
| 1647 | |
| 1648 // include meta tag with charset | |
| 1649 if (!empty($this->charset)) { | |
| 1650 if (!headers_sent()) { | |
| 1651 header('Content-Type: text/html; charset=' . $this->charset); | |
| 1652 } | |
| 1653 $page_header = '<meta http-equiv="content-type"'; | |
| 1654 $page_header.= ' content="text/html; charset='; | |
| 1655 $page_header.= $this->charset . '" />'."\n"; | |
| 1656 } | |
| 1657 | |
| 1658 // definition of the code to be placed in the document header and footer | |
| 1659 if (is_array($this->script_files['head'])) { | |
| 1660 foreach ($this->script_files['head'] as $file) { | |
| 1661 $page_header .= html::script($file); | |
| 1662 } | |
| 1663 } | |
| 1664 | |
| 1665 $head_script = $this->scripts['head_top'] . $this->scripts['head']; | |
| 1666 if (!empty($head_script)) { | |
| 1667 $page_header .= html::script(array(), $head_script); | |
| 1668 } | |
| 1669 | |
| 1670 if (!empty($this->header)) { | |
| 1671 $page_header .= $this->header; | |
| 1672 } | |
| 1673 | |
| 1674 // put docready commands into page footer | |
| 1675 if (!empty($this->scripts['docready'])) { | |
| 1676 $this->add_script('$(document).ready(function(){ ' . $this->scripts['docready'] . "\n});", 'foot'); | |
| 1677 } | |
| 1678 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1679 if (!empty($this->script_files['foot'])) { |
| 0 | 1680 foreach ($this->script_files['foot'] as $file) { |
| 1681 $page_footer .= html::script($file); | |
| 1682 } | |
| 1683 } | |
| 1684 | |
| 1685 if (!empty($this->footer)) { | |
| 1686 $page_footer .= $this->footer . "\n"; | |
| 1687 } | |
| 1688 | |
| 1689 if (!empty($this->scripts['foot'])) { | |
| 1690 $page_footer .= html::script(array(), $this->scripts['foot']); | |
| 1691 } | |
| 1692 | |
| 1693 // find page header | |
| 1694 if ($hpos = stripos($output, '</head>')) { | |
| 1695 $page_header .= "\n"; | |
| 1696 } | |
| 1697 else { | |
| 1698 if (!is_numeric($hpos)) { | |
| 1699 $hpos = stripos($output, '<body'); | |
| 1700 } | |
| 1701 if (!is_numeric($hpos) && ($hpos = stripos($output, '<html'))) { | |
| 1702 while ($output[$hpos] != '>') { | |
| 1703 $hpos++; | |
| 1704 } | |
| 1705 $hpos++; | |
| 1706 } | |
| 1707 $page_header = "<head>\n<title>$page_title</title>\n$page_header\n</head>\n"; | |
| 1708 } | |
| 1709 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1710 // add page header |
| 0 | 1711 if ($hpos) { |
| 1712 $output = substr_replace($output, $page_header, $hpos, 0); | |
| 1713 } | |
| 1714 else { | |
| 1715 $output = $page_header . $output; | |
| 1716 } | |
| 1717 | |
| 1718 // add page footer | |
| 1719 if (($fpos = strripos($output, '</body>')) || ($fpos = strripos($output, '</html>'))) { | |
| 1720 $output = substr_replace($output, $page_footer."\n", $fpos, 0); | |
| 1721 } | |
| 1722 else { | |
| 1723 $output .= "\n".$page_footer; | |
| 1724 } | |
| 1725 | |
| 1726 // add css files in head, before scripts, for speed up with parallel downloads | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1727 if (!empty($this->css_files) && empty($is_empty) |
| 0 | 1728 && (($pos = stripos($output, '<script ')) || ($pos = stripos($output, '</head>'))) |
| 1729 ) { | |
| 1730 $css = ''; | |
| 1731 foreach ($this->css_files as $file) { | |
| 1732 $css .= html::tag('link', array('rel' => 'stylesheet', | |
| 1733 'type' => 'text/css', 'href' => $file, 'nl' => true)); | |
| 1734 } | |
| 1735 $output = substr_replace($output, $css, $pos, 0); | |
| 1736 } | |
| 1737 | |
| 1738 $output = $this->parse_with_globals($this->fix_paths($output)); | |
| 1739 | |
| 1740 if ($this->assets_path) { | |
| 1741 $output = $this->fix_assets_paths($output); | |
| 1742 } | |
| 1743 | |
| 1744 $output = $this->postrender($output); | |
| 1745 | |
| 1746 // trigger hook with final HTML content to be sent | |
| 1747 $hook = $this->app->plugins->exec_hook("send_page", array('content' => $output)); | |
| 1748 if (!$hook['abort']) { | |
| 1749 if ($this->charset != RCUBE_CHARSET) { | |
| 1750 echo rcube_charset::convert($hook['content'], RCUBE_CHARSET, $this->charset); | |
| 1751 } | |
| 1752 else { | |
| 1753 echo $hook['content']; | |
| 1754 } | |
| 1755 } | |
| 1756 } | |
| 1757 | |
| 1758 /** | |
| 1759 * Returns iframe object, registers some related env variables | |
| 1760 * | |
| 1761 * @param array $attrib HTML attributes | |
| 1762 * @param boolean $is_contentframe Register this iframe as the 'contentframe' gui object | |
| 1763 * | |
| 1764 * @return string IFRAME element | |
| 1765 */ | |
| 1766 public function frame($attrib, $is_contentframe = false) | |
| 1767 { | |
| 1768 static $idcount = 0; | |
| 1769 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1770 if (empty($attrib['id'])) { |
| 0 | 1771 $attrib['id'] = 'rcmframe' . ++$idcount; |
| 1772 } | |
| 1773 | |
| 1774 $attrib['name'] = $attrib['id']; | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1775 $attrib['src'] = !empty($attrib['src']) ? $this->abs_url($attrib['src'], true) : 'program/resources/blank.gif'; |
| 0 | 1776 |
| 1777 // register as 'contentframe' object | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1778 if ($is_contentframe || !empty($attrib['contentframe'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1779 $this->set_env('contentframe', !empty($attrib['contentframe']) ? $attrib['contentframe'] : $attrib['name']); |
| 0 | 1780 $this->set_env('blankpage', $this->asset_url($attrib['src'])); |
| 1781 } | |
| 1782 | |
| 1783 return html::iframe($attrib); | |
| 1784 } | |
| 1785 | |
| 1786 | |
| 1787 /* ************* common functions delivering gui objects ************** */ | |
| 1788 | |
| 1789 /** | |
| 1790 * Create a form tag with the necessary hidden fields | |
| 1791 * | |
| 1792 * @param array $attrib Named tag parameters | |
| 1793 * @param string $content HTML content of the form | |
| 1794 * | |
| 1795 * @return string HTML code for the form | |
| 1796 */ | |
| 1797 public function form_tag($attrib, $content = null) | |
| 1798 { | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1799 $hidden = ''; |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1800 |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1801 if (!empty($this->env['extwin'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1802 $hiddenfield = new html_hiddenfield(['name' => '_extwin', 'value' => '1']); |
| 0 | 1803 $hidden = $hiddenfield->show(); |
| 1804 } | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1805 else if ($this->framed || !empty($this->env['framed'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1806 $hiddenfield = new html_hiddenfield(['name' => '_framed', 'value' => '1']); |
| 0 | 1807 $hidden = $hiddenfield->show(); |
| 1808 } | |
| 1809 | |
| 1810 if (!$content) { | |
| 1811 $attrib['noclose'] = true; | |
| 1812 } | |
| 1813 | |
| 1814 return html::tag('form', | |
| 1815 $attrib + array('action' => $this->app->comm_path, 'method' => "get"), | |
| 1816 $hidden . $content, | |
| 1817 array('id','class','style','name','method','action','enctype','onsubmit') | |
| 1818 ); | |
| 1819 } | |
| 1820 | |
| 1821 /** | |
| 1822 * Build a form tag with a unique request token | |
| 1823 * | |
| 1824 * @param array $attrib Named tag parameters including 'action' and 'task' values | |
| 1825 * which will be put into hidden fields | |
| 1826 * @param string $content Form content | |
| 1827 * | |
| 1828 * @return string HTML code for the form | |
| 1829 */ | |
| 1830 public function request_form($attrib, $content = '') | |
| 1831 { | |
| 1832 $hidden = new html_hiddenfield(); | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1833 |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1834 if (!empty($attrib['task'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1835 $hidden->add(['name' => '_task', 'value' => $attrib['task']]); |
| 0 | 1836 } |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1837 |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1838 if (!empty($attrib['action'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1839 $hidden->add(['name' => '_action', 'value' => $attrib['action']]); |
| 0 | 1840 } |
| 1841 | |
| 1842 // we already have a <form> tag | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1843 if (!empty($attrib['form'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1844 if ($this->framed || !empty($this->env['framed'])) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1845 $hidden->add(['name' => '_framed', 'value' => '1']); |
| 0 | 1846 } |
| 1847 | |
| 1848 return $hidden->show() . $content; | |
| 1849 } | |
| 1850 | |
| 1851 unset($attrib['task'], $attrib['request']); | |
| 1852 $attrib['action'] = './'; | |
| 1853 | |
| 1854 return $this->form_tag($attrib, $hidden->show() . $content); | |
| 1855 } | |
| 1856 | |
| 1857 /** | |
| 1858 * GUI object 'username' | |
| 1859 * Showing IMAP username of the current session | |
| 1860 * | |
| 1861 * @param array $attrib Named tag parameters (currently not used) | |
| 1862 * | |
| 1863 * @return string HTML code for the gui object | |
| 1864 */ | |
| 1865 public function current_username($attrib) | |
| 1866 { | |
| 1867 static $username; | |
| 1868 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1869 // already fetched |
| 0 | 1870 if (!empty($username)) { |
| 1871 return $username; | |
| 1872 } | |
| 1873 | |
| 1874 // Current username is an e-mail address | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1875 if (isset($_SESSION['username']) && strpos($_SESSION['username'], '@')) { |
| 0 | 1876 $username = $_SESSION['username']; |
| 1877 } | |
| 1878 // get e-mail address from default identity | |
| 1879 else if ($sql_arr = $this->app->user->get_identity()) { | |
| 1880 $username = $sql_arr['email']; | |
| 1881 } | |
| 1882 else { | |
| 1883 $username = $this->app->user->get_username(); | |
| 1884 } | |
| 1885 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1886 $username = rcube_utils::idn_to_utf8($username); |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1887 |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1888 return html::quote($username); |
| 0 | 1889 } |
| 1890 | |
| 1891 /** | |
| 1892 * GUI object 'loginform' | |
| 1893 * Returns code for the webmail login form | |
| 1894 * | |
| 1895 * @param array $attrib Named parameters | |
| 1896 * | |
| 1897 * @return string HTML code for the gui object | |
| 1898 */ | |
| 1899 protected function login_form($attrib) | |
| 1900 { | |
| 1901 $default_host = $this->config->get('default_host'); | |
| 1902 $autocomplete = (int) $this->config->get('login_autocomplete'); | |
| 1903 | |
| 1904 $_SESSION['temp'] = true; | |
| 1905 | |
| 1906 // save original url | |
| 1907 $url = rcube_utils::get_input_value('_url', rcube_utils::INPUT_POST); | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1908 if (empty($url) |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1909 && !empty($_SERVER['QUERY_STRING']) |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1910 && !preg_match('/_(task|action)=logout/', $_SERVER['QUERY_STRING']) |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1911 ) { |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1912 $url = $_SERVER['QUERY_STRING']; |
|
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
1913 } |
| 0 | 1914 |
| 1915 // Disable autocapitalization on iPad/iPhone (#1488609) | |
| 1916 $attrib['autocapitalize'] = 'off'; | |
| 1917 | |
| 1918 $form_name = !empty($attrib['form']) ? $attrib['form'] : 'form'; | |
| 1919 | |
| 1920 // set atocomplete attribute | |
| 1921 $user_attrib = $autocomplete > 0 ? array() : array('autocomplete' => 'off'); | |
| 1922 $host_attrib = $autocomplete > 0 ? array() : array('autocomplete' => 'off'); | |
| 1923 $pass_attrib = $autocomplete > 1 ? array() : array('autocomplete' => 'off'); | |
| 1924 | |
| 1925 $input_task = new html_hiddenfield(array('name' => '_task', 'value' => 'login')); | |
| 1926 $input_action = new html_hiddenfield(array('name' => '_action', 'value' => 'login')); | |
| 1927 $input_tzone = new html_hiddenfield(array('name' => '_timezone', 'id' => 'rcmlogintz', 'value' => '_default_')); | |
| 1928 $input_url = new html_hiddenfield(array('name' => '_url', 'id' => 'rcmloginurl', 'value' => $url)); | |
| 1929 $input_user = new html_inputfield(array('name' => '_user', 'id' => 'rcmloginuser', 'required' => 'required') | |
| 1930 + $attrib + $user_attrib); | |
| 1931 $input_pass = new html_passwordfield(array('name' => '_pass', 'id' => 'rcmloginpwd', 'required' => 'required') | |
| 1932 + $attrib + $pass_attrib); | |
| 1933 $input_host = null; | |
| 1934 | |
| 1935 if (is_array($default_host) && count($default_host) > 1) { | |
| 1936 $input_host = new html_select(array('name' => '_host', 'id' => 'rcmloginhost')); | |
| 1937 | |
| 1938 foreach ($default_host as $key => $value) { | |
| 1939 if (!is_array($value)) { | |
| 1940 $input_host->add($value, (is_numeric($key) ? $value : $key)); | |
| 1941 } | |
| 1942 else { | |
| 1943 $input_host = null; | |
| 1944 break; | |
| 1945 } | |
| 1946 } | |
| 1947 } | |
| 1948 else if (is_array($default_host) && ($host = key($default_host)) !== null) { | |
| 1949 $hide_host = true; | |
| 1950 $input_host = new html_hiddenfield(array( | |
| 1951 'name' => '_host', 'id' => 'rcmloginhost', 'value' => is_numeric($host) ? $default_host[$host] : $host) + $attrib); | |
| 1952 } | |
| 1953 else if (empty($default_host)) { | |
| 1954 $input_host = new html_inputfield(array('name' => '_host', 'id' => 'rcmloginhost') | |
| 1955 + $attrib + $host_attrib); | |
| 1956 } | |
| 1957 | |
| 1958 $this->add_gui_object('loginform', $form_name); | |
| 1959 | |
| 1960 // create HTML table with two cols | |
| 1961 $table = new html_table(array('cols' => 2)); | |
| 1962 | |
| 1963 $table->add('title', html::label('rcmloginuser', html::quote($this->app->gettext('username')))); | |
| 1964 $table->add('input', $input_user->show(rcube_utils::get_input_value('_user', rcube_utils::INPUT_GPC))); | |
| 1965 | |
| 1966 $table->add('title', html::label('rcmloginpwd', html::quote($this->app->gettext('password')))); | |
| 1967 $table->add('input', $input_pass->show()); | |
| 1968 | |
| 1969 // add host selection row | |
| 1970 if (is_object($input_host) && !$hide_host) { | |
| 1971 $table->add('title', html::label('rcmloginhost', html::quote($this->app->gettext('server')))); | |
| 1972 $table->add('input', $input_host->show(rcube_utils::get_input_value('_host', rcube_utils::INPUT_GPC))); | |
| 1973 } | |
| 1974 | |
| 1975 $out = $input_task->show(); | |
| 1976 $out .= $input_action->show(); | |
| 1977 $out .= $input_tzone->show(); | |
| 1978 $out .= $input_url->show(); | |
| 1979 $out .= $table->show(); | |
| 1980 | |
| 22 | 1981 if (isset($hide_host)) { |
| 0 | 1982 $out .= $input_host->show(); |
| 1983 } | |
| 1984 | |
| 1985 if (rcube_utils::get_boolean($attrib['submit'])) { | |
| 1986 $submit = new html_inputfield(array('type' => 'submit', 'id' => 'rcmloginsubmit', | |
| 1987 'class' => 'button mainaction', 'value' => $this->app->gettext('login'))); | |
| 1988 $out .= html::p('formbuttons', $submit->show()); | |
| 1989 } | |
| 1990 | |
| 1991 // surround html output with a form tag | |
| 1992 if (empty($attrib['form'])) { | |
| 1993 $out = $this->form_tag(array('name' => $form_name, 'method' => 'post'), $out); | |
| 1994 } | |
| 1995 | |
| 1996 // include script for timezone detection | |
| 1997 $this->include_script('jstz.min.js'); | |
| 1998 | |
| 1999 return $out; | |
| 2000 } | |
| 2001 | |
| 2002 /** | |
| 2003 * GUI object 'preloader' | |
| 2004 * Loads javascript code for images preloading | |
| 2005 * | |
| 2006 * @param array $attrib Named parameters | |
| 2007 * @return void | |
| 2008 */ | |
| 2009 protected function preloader($attrib) | |
| 2010 { | |
| 2011 $images = preg_split('/[\s\t\n,]+/', $attrib['images'], -1, PREG_SPLIT_NO_EMPTY); | |
| 2012 $images = array_map(array($this, 'abs_url'), $images); | |
| 2013 $images = array_map(array($this, 'asset_url'), $images); | |
| 2014 | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
2015 if (empty($images) || (isset($_REQUEST['_task']) && $_REQUEST['_task'] == 'logout')) { |
| 0 | 2016 return; |
| 2017 } | |
| 2018 | |
| 2019 $this->add_script('var images = ' . self::json_serialize($images, $this->devel_mode) .'; | |
| 2020 for (var i=0; i<images.length; i++) { | |
| 2021 img = new Image(); | |
| 2022 img.src = images[i]; | |
| 2023 }', 'docready'); | |
| 2024 } | |
| 2025 | |
| 2026 /** | |
| 2027 * GUI object 'searchform' | |
| 2028 * Returns code for search function | |
| 2029 * | |
| 2030 * @param array $attrib Named parameters | |
| 2031 * | |
| 2032 * @return string HTML code for the gui object | |
| 2033 */ | |
| 2034 protected function search_form($attrib) | |
| 2035 { | |
| 2036 // add some labels to client | |
| 2037 $this->add_label('searching'); | |
| 2038 | |
| 2039 $attrib['name'] = '_q'; | |
| 2040 | |
| 2041 if (empty($attrib['id'])) { | |
| 2042 $attrib['id'] = 'rcmqsearchbox'; | |
| 2043 } | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
2044 if (isset($attrib['type']) && $attrib['type'] == 'search' && !$this->browser->khtml) { |
| 0 | 2045 unset($attrib['type'], $attrib['results']); |
| 2046 } | |
| 2047 | |
| 2048 $input_q = new html_inputfield($attrib); | |
| 2049 $out = $input_q->show(); | |
| 2050 | |
| 2051 $this->add_gui_object('qsearchbox', $attrib['id']); | |
| 2052 | |
| 2053 // add form tag around text field | |
| 2054 if (empty($attrib['form'])) { | |
| 2055 $out = $this->form_tag(array( | |
| 2056 'name' => "rcmqsearchform", | |
| 2057 'onsubmit' => self::JS_OBJECT_NAME . ".command('search'); return false", | |
| 2058 'style' => "display:inline" | |
| 2059 ), $out); | |
| 2060 } | |
| 2061 | |
| 2062 return $out; | |
| 2063 } | |
| 2064 | |
| 2065 /** | |
| 2066 * Builder for GUI object 'message' | |
| 2067 * | |
|
18
b631c1c7a3ce
More cleaning up more php8 Warnings/deprecations,
Charlie Root
parents:
5
diff
changeset
|
2068 * @param array $attrib Named tag parameters |
| 0 | 2069 * @return string HTML code for the gui object |
| 2070 */ | |
| 2071 protected function message_container($attrib) | |
| 2072 { | |
| 2073 if (isset($attrib['id']) === false) { | |
| 2074 $attrib['id'] = 'rcmMessageContainer'; | |
| 2075 } | |
| 2076 | |
| 2077 $this->add_gui_object('message', $attrib['id']); | |
| 2078 | |
| 2079 return html::div($attrib, ''); | |
| 2080 } | |
| 2081 | |
| 2082 /** | |
| 2083 * GUI object 'charsetselector' | |
| 2084 * | |
| 2085 * @param array $attrib Named parameters for the select tag | |
| 2086 * | |
| 2087 * @return string HTML code for the gui object | |
| 2088 */ | |
| 2089 public function charset_selector($attrib) | |
| 2090 { | |
| 2091 // pass the following attributes to the form class | |
| 2092 $field_attrib = array('name' => '_charset'); | |
| 2093 foreach ($attrib as $attr => $value) { | |
| 2094 if (in_array($attr, array('id', 'name', 'class', 'style', 'size', 'tabindex'))) { | |
| 2095 $field_attrib[$attr] = $value; | |
| 2096 } | |
| 2097 } | |
| 2098 | |
| 2099 $charsets = array( | |
| 2100 'UTF-8' => 'UTF-8 ('.$this->app->gettext('unicode').')', | |
| 2101 'US-ASCII' => 'ASCII ('.$this->app->gettext('english').')', | |
| 2102 'ISO-8859-1' => 'ISO-8859-1 ('.$this->app->gettext('westerneuropean').')', | |
| 2103 'ISO-8859-2' => 'ISO-8859-2 ('.$this->app->gettext('easterneuropean').')', | |
| 2104 'ISO-8859-4' => 'ISO-8859-4 ('.$this->app->gettext('baltic').')', | |
| 2105 'ISO-8859-5' => 'ISO-8859-5 ('.$this->app->gettext('cyrillic').')', | |
| 2106 'ISO-8859-6' => 'ISO-8859-6 ('.$this->app->gettext('arabic').')', | |
| 2107 'ISO-8859-7' => 'ISO-8859-7 ('.$this->app->gettext('greek').')', | |
| 2108 'ISO-8859-8' => 'ISO-8859-8 ('.$this->app->gettext('hebrew').')', | |
| 2109 'ISO-8859-9' => 'ISO-8859-9 ('.$this->app->gettext('turkish').')', | |
| 2110 'ISO-8859-10' => 'ISO-8859-10 ('.$this->app->gettext('nordic').')', | |
| 2111 'ISO-8859-11' => 'ISO-8859-11 ('.$this->app->gettext('thai').')', | |
| 2112 'ISO-8859-13' => 'ISO-8859-13 ('.$this->app->gettext('baltic').')', | |
| 2113 'ISO-8859-14' => 'ISO-8859-14 ('.$this->app->gettext('celtic').')', | |
| 2114 'ISO-8859-15' => 'ISO-8859-15 ('.$this->app->gettext('westerneuropean').')', | |
| 2115 'ISO-8859-16' => 'ISO-8859-16 ('.$this->app->gettext('southeasterneuropean').')', | |
| 2116 'WINDOWS-1250' => 'Windows-1250 ('.$this->app->gettext('easterneuropean').')', | |
| 2117 'WINDOWS-1251' => 'Windows-1251 ('.$this->app->gettext('cyrillic').')', | |
| 2118 'WINDOWS-1252' => 'Windows-1252 ('.$this->app->gettext('westerneuropean').')', | |
| 2119 'WINDOWS-1253' => 'Windows-1253 ('.$this->app->gettext('greek').')', | |
| 2120 'WINDOWS-1254' => 'Windows-1254 ('.$this->app->gettext('turkish').')', | |
| 2121 'WINDOWS-1255' => 'Windows-1255 ('.$this->app->gettext('hebrew').')', | |
| 2122 'WINDOWS-1256' => 'Windows-1256 ('.$this->app->gettext('arabic').')', | |
| 2123 'WINDOWS-1257' => 'Windows-1257 ('.$this->app->gettext('baltic').')', | |
| 2124 'WINDOWS-1258' => 'Windows-1258 ('.$this->app->gettext('vietnamese').')', | |
| 2125 'ISO-2022-JP' => 'ISO-2022-JP ('.$this->app->gettext('japanese').')', | |
| 2126 'ISO-2022-KR' => 'ISO-2022-KR ('.$this->app->gettext('korean').')', | |
| 2127 'ISO-2022-CN' => 'ISO-2022-CN ('.$this->app->gettext('chinese').')', | |
| 2128 'EUC-JP' => 'EUC-JP ('.$this->app->gettext('japanese').')', | |
| 2129 'EUC-KR' => 'EUC-KR ('.$this->app->gettext('korean').')', | |
| 2130 'EUC-CN' => 'EUC-CN ('.$this->app->gettext('chinese').')', | |
| 2131 'BIG5' => 'BIG5 ('.$this->app->gettext('chinese').')', | |
| 2132 'GB2312' => 'GB2312 ('.$this->app->gettext('chinese').')', | |
| 2133 ); | |
| 2134 | |
| 2135 if ($post = rcube_utils::get_input_value('_charset', rcube_utils::INPUT_POST)) { | |
| 2136 $set = $post; | |
| 2137 } | |
| 2138 else if (!empty($attrib['selected'])) { | |
| 2139 $set = $attrib['selected']; | |
| 2140 } | |
| 2141 else { | |
| 2142 $set = $this->get_charset(); | |
| 2143 } | |
| 2144 | |
| 2145 $set = strtoupper($set); | |
| 2146 if (!isset($charsets[$set]) && preg_match('/^[A-Z0-9-]+$/', $set)) { | |
| 2147 $charsets[$set] = $set; | |
| 2148 } | |
| 2149 | |
| 2150 $select = new html_select($field_attrib); | |
| 2151 $select->add(array_values($charsets), array_keys($charsets)); | |
| 2152 | |
| 2153 return $select->show($set); | |
| 2154 } | |
| 2155 | |
| 2156 /** | |
| 2157 * Include content from config/about.<LANG>.html if available | |
| 2158 */ | |
| 2159 protected function about_content($attrib) | |
| 2160 { | |
| 2161 $content = ''; | |
| 2162 $filenames = array( | |
| 2163 'about.' . $_SESSION['language'] . '.html', | |
| 2164 'about.' . substr($_SESSION['language'], 0, 2) . '.html', | |
| 2165 'about.html', | |
| 2166 ); | |
| 2167 foreach ($filenames as $file) { | |
| 2168 $fn = RCUBE_CONFIG_DIR . $file; | |
| 2169 if (is_readable($fn)) { | |
| 2170 $content = file_get_contents($fn); | |
| 2171 $content = $this->parse_conditions($content); | |
| 2172 $content = $this->parse_xml($content); | |
| 2173 break; | |
| 2174 } | |
| 2175 } | |
| 2176 | |
| 2177 return $content; | |
| 2178 } | |
| 2179 } |