Mercurial > hg > rc2
annotate program/include/rcmail.php @ 19:b6a96bdd6b29
More cleaning up php8 Warnings/deprecations
| author | Charlie Root |
|---|---|
| date | Wed, 08 Oct 2025 08:50:44 -0400 |
| parents | dd5ed6ef69c9 |
| children | 73124dd49283 |
| rev | line source |
|---|---|
| 0 | 1 <?php |
| 2 | |
| 3 /** | |
| 4 +-----------------------------------------------------------------------+ | |
| 5 | program/include/rcmail.php | | |
| 6 | | | |
| 7 | This file is part of the Roundcube Webmail client | | |
| 8 | Copyright (C) 2008-2014, The Roundcube Dev Team | | |
| 9 | Copyright (C) 2011-2014, Kolab Systems AG | | |
| 10 | | | |
| 11 | Licensed under the GNU General Public License version 3 or | | |
| 12 | any later version with exceptions for skins & plugins. | | |
| 13 | See the README file for a full license statement. | | |
| 14 | | | |
| 15 | PURPOSE: | | |
| 16 | Application class providing core functions and holding | | |
| 17 | instances of all 'global' objects like db- and imap-connections | | |
| 18 +-----------------------------------------------------------------------+ | |
| 19 | Author: Thomas Bruederli <roundcube@gmail.com> | | |
| 20 | Author: Aleksander Machniak <alec@alec.pl> | | |
| 21 +-----------------------------------------------------------------------+ | |
| 22 */ | |
| 23 | |
| 24 /** | |
| 25 * Application class of Roundcube Webmail | |
| 26 * implemented as singleton | |
| 27 * | |
| 28 * @package Webmail | |
| 29 */ | |
| 30 class rcmail extends rcube | |
| 31 { | |
| 32 /** | |
| 33 * Main tasks. | |
| 34 * | |
| 35 * @var array | |
| 36 */ | |
| 37 static public $main_tasks = array('mail','settings','addressbook','login','logout','utils','dummy'); | |
| 38 | |
| 39 /** | |
| 40 * Current task. | |
| 41 * | |
| 42 * @var string | |
| 43 */ | |
| 44 public $task; | |
| 45 | |
| 46 /** | |
| 47 * Current action. | |
| 48 * | |
| 49 * @var string | |
| 50 */ | |
| 51 public $action = ''; | |
| 52 public $comm_path = './'; | |
| 53 public $filename = ''; | |
|
15
85a746e95663
slowly working through deprecations/warnings from 8.3
Charlie Root
parents:
0
diff
changeset
|
54 public $login_error; |
| 0 | 55 |
| 56 private $address_books = array(); | |
| 57 private $action_map = array(); | |
| 58 | |
| 59 | |
| 60 const ERROR_STORAGE = -2; | |
| 61 const ERROR_INVALID_REQUEST = 1; | |
| 62 const ERROR_INVALID_HOST = 2; | |
| 63 const ERROR_COOKIES_DISABLED = 3; | |
| 64 const ERROR_RATE_LIMIT = 4; | |
| 65 | |
| 66 | |
| 67 /** | |
| 68 * This implements the 'singleton' design pattern | |
| 69 * | |
| 70 * @param integer $mode Ignored rcube::get_instance() argument | |
| 71 * @param string $env Environment name to run (e.g. live, dev, test) | |
| 72 * | |
| 73 * @return rcmail The one and only instance | |
| 74 */ | |
| 75 static function get_instance($mode = 0, $env = '') | |
| 76 { | |
| 77 if (!self::$instance || !is_a(self::$instance, 'rcmail')) { | |
| 78 self::$instance = new rcmail($env); | |
| 79 // init AFTER object was linked with self::$instance | |
| 80 self::$instance->startup(); | |
| 81 } | |
| 82 | |
| 83 return self::$instance; | |
| 84 } | |
| 85 | |
| 86 /** | |
| 87 * Initial startup function | |
| 88 * to register session, create database and imap connections | |
| 89 */ | |
| 90 protected function startup() | |
| 91 { | |
| 92 $this->init(self::INIT_WITH_DB | self::INIT_WITH_PLUGINS); | |
| 93 | |
| 94 // set filename if not index.php | |
| 95 if (($basename = basename($_SERVER['SCRIPT_FILENAME'])) && $basename != 'index.php') { | |
| 96 $this->filename = $basename; | |
| 97 } | |
| 98 | |
| 99 // load all configured plugins | |
| 100 $plugins = (array) $this->config->get('plugins', array()); | |
| 101 $required_plugins = array('filesystem_attachments', 'jqueryui'); | |
| 102 $this->plugins->load_plugins($plugins, $required_plugins); | |
| 103 | |
| 104 // start session | |
| 105 $this->session_init(); | |
| 106 | |
| 107 // create user object | |
| 108 $this->set_user(new rcube_user($_SESSION['user_id'])); | |
| 109 | |
| 110 // set task and action properties | |
| 111 $this->set_task(rcube_utils::get_input_value('_task', rcube_utils::INPUT_GPC)); | |
| 112 $this->action = asciiwords(rcube_utils::get_input_value('_action', rcube_utils::INPUT_GPC)); | |
| 113 | |
| 114 // reset some session parameters when changing task | |
| 115 if ($this->task != 'utils') { | |
| 116 // we reset list page when switching to another task | |
| 117 // but only to the main task interface - empty action (#1489076, #1490116) | |
| 118 // this will prevent from unintentional page reset on cross-task requests | |
| 119 if ($this->session && $_SESSION['task'] != $this->task && empty($this->action)) { | |
| 120 $this->session->remove('page'); | |
| 121 | |
| 122 // set current task to session | |
| 123 $_SESSION['task'] = $this->task; | |
| 124 } | |
| 125 } | |
| 126 | |
| 127 // init output class (not in CLI mode) | |
| 128 if (!empty($_REQUEST['_remote'])) { | |
| 129 $GLOBALS['OUTPUT'] = $this->json_init(); | |
| 130 } | |
| 131 else if ($_SERVER['REMOTE_ADDR']) { | |
| 132 $GLOBALS['OUTPUT'] = $this->load_gui(!empty($_REQUEST['_framed'])); | |
| 133 } | |
| 134 | |
| 135 // run init method on all the plugins | |
| 136 $this->plugins->init($this, $this->task); | |
| 137 } | |
| 138 | |
| 139 /** | |
| 140 * Setter for application task | |
| 141 * | |
| 142 * @param string $task Task to set | |
| 143 */ | |
| 144 public function set_task($task) | |
| 145 { | |
| 146 if (php_sapi_name() == 'cli') { | |
| 147 $task = 'cli'; | |
| 148 } | |
| 149 else if (!$this->user || !$this->user->ID) { | |
| 150 $task = 'login'; | |
| 151 } | |
| 152 else { | |
| 153 $task = asciiwords($task, true) ?: 'mail'; | |
| 154 } | |
| 155 | |
| 156 $this->task = $task; | |
| 157 $this->comm_path = $this->url(array('task' => $this->task)); | |
| 158 | |
| 159 if (!empty($_REQUEST['_framed'])) { | |
| 160 $this->comm_path .= '&_framed=1'; | |
| 161 } | |
| 162 | |
| 163 if ($this->output) { | |
| 164 $this->output->set_env('task', $this->task); | |
| 165 $this->output->set_env('comm_path', $this->comm_path); | |
| 166 } | |
| 167 } | |
| 168 | |
| 169 /** | |
| 170 * Setter for system user object | |
| 171 * | |
| 172 * @param rcube_user $user Current user instance | |
| 173 */ | |
| 174 public function set_user($user) | |
| 175 { | |
| 176 parent::set_user($user); | |
| 177 | |
| 178 $lang = $this->language_prop($this->config->get('language', $_SESSION['language'])); | |
| 179 $_SESSION['language'] = $this->user->language = $lang; | |
| 180 | |
| 181 // set localization | |
| 182 setlocale(LC_ALL, $lang . '.utf8', $lang . '.UTF-8', 'en_US.utf8', 'en_US.UTF-8'); | |
| 183 | |
| 184 // Workaround for http://bugs.php.net/bug.php?id=18556 | |
| 185 // Also strtoupper/strtolower and other methods are locale-aware | |
| 186 // for these locales it is problematic (#1490519) | |
| 187 if (in_array($lang, array('tr_TR', 'ku', 'az_AZ'))) { | |
| 188 setlocale(LC_CTYPE, 'en_US.utf8', 'en_US.UTF-8', 'C'); | |
| 189 } | |
| 190 } | |
| 191 | |
| 192 /** | |
| 193 * Return instance of the internal address book class | |
| 194 * | |
| 195 * @param string $id Address book identifier (-1 for default addressbook) | |
| 196 * @param boolean $writeable True if the address book needs to be writeable | |
| 197 * | |
| 198 * @return rcube_contacts Address book object | |
| 199 */ | |
| 200 public function get_address_book($id, $writeable = false) | |
| 201 { | |
| 202 $contacts = null; | |
| 203 $ldap_config = (array)$this->config->get('ldap_public'); | |
| 204 | |
| 205 // 'sql' is the alias for '0' used by autocomplete | |
| 206 if ($id == 'sql') | |
| 207 $id = '0'; | |
| 208 else if ($id == -1) { | |
| 209 $id = $this->config->get('default_addressbook'); | |
| 210 $default = true; | |
| 211 } | |
| 212 | |
| 213 // use existing instance | |
| 214 if (isset($this->address_books[$id]) && ($this->address_books[$id] instanceof rcube_addressbook)) { | |
| 215 $contacts = $this->address_books[$id]; | |
| 216 } | |
| 217 else if ($id && $ldap_config[$id]) { | |
| 218 $domain = $this->config->mail_domain($_SESSION['storage_host']); | |
| 219 $contacts = new rcube_ldap($ldap_config[$id], $this->config->get('ldap_debug'), $domain); | |
| 220 } | |
| 221 else if ($id === '0') { | |
| 222 $contacts = new rcube_contacts($this->db, $this->get_user_id()); | |
| 223 } | |
| 224 else { | |
| 225 $plugin = $this->plugins->exec_hook('addressbook_get', array('id' => $id, 'writeable' => $writeable)); | |
| 226 | |
| 227 // plugin returned instance of a rcube_addressbook | |
| 228 if ($plugin['instance'] instanceof rcube_addressbook) { | |
| 229 $contacts = $plugin['instance']; | |
| 230 } | |
| 231 } | |
| 232 | |
| 233 // when user requested default writeable addressbook | |
| 234 // we need to check if default is writeable, if not we | |
| 235 // will return first writeable book (if any exist) | |
| 236 if ($contacts && $default && $contacts->readonly && $writeable) { | |
| 237 $contacts = null; | |
| 238 } | |
| 239 | |
| 240 // Get first addressbook from the list if configured default doesn't exist | |
| 241 // This can happen when user deleted the addressbook (e.g. Kolab folder) | |
| 242 if (!$contacts && (!$id || $default)) { | |
| 243 $source = reset($this->get_address_sources($writeable, !$default)); | |
| 244 if (!empty($source)) { | |
| 245 $contacts = $this->get_address_book($source['id']); | |
| 246 if ($contacts) { | |
| 247 $id = $source['id']; | |
| 248 } | |
| 249 } | |
| 250 } | |
| 251 | |
| 252 if (!$contacts) { | |
| 253 // there's no default, just return | |
| 254 if ($default) { | |
| 255 return null; | |
| 256 } | |
| 257 | |
| 258 self::raise_error(array( | |
| 259 'code' => 700, | |
| 260 'file' => __FILE__, | |
| 261 'line' => __LINE__, | |
| 262 'message' => "Addressbook source ($id) not found!" | |
| 263 ), | |
| 264 true, true); | |
| 265 } | |
| 266 | |
| 267 // add to the 'books' array for shutdown function | |
| 268 $this->address_books[$id] = $contacts; | |
| 269 | |
| 270 if ($writeable && $contacts->readonly) { | |
| 271 return null; | |
| 272 } | |
| 273 | |
| 274 // set configured sort order | |
| 275 if ($sort_col = $this->config->get('addressbook_sort_col')) { | |
| 276 $contacts->set_sort_order($sort_col); | |
| 277 } | |
| 278 | |
| 279 return $contacts; | |
| 280 } | |
| 281 | |
| 282 /** | |
| 283 * Return identifier of the address book object | |
| 284 * | |
| 285 * @param rcube_addressbook $object Addressbook source object | |
| 286 * | |
| 287 * @return string Source identifier | |
| 288 */ | |
| 289 public function get_address_book_id($object) | |
| 290 { | |
| 291 foreach ($this->address_books as $index => $book) { | |
| 292 if ($book === $object) { | |
| 293 return $index; | |
| 294 } | |
| 295 } | |
| 296 } | |
| 297 | |
| 298 /** | |
| 299 * Return address books list | |
| 300 * | |
| 301 * @param boolean $writeable True if the address book needs to be writeable | |
| 302 * @param boolean $skip_hidden True if the address book needs to be not hidden | |
| 303 * | |
| 304 * @return array Address books array | |
| 305 */ | |
| 306 public function get_address_sources($writeable = false, $skip_hidden = false) | |
| 307 { | |
| 308 $abook_type = (string) $this->config->get('address_book_type'); | |
| 309 $ldap_config = (array) $this->config->get('ldap_public'); | |
| 310 $autocomplete = (array) $this->config->get('autocomplete_addressbooks'); | |
| 311 $list = array(); | |
| 312 | |
| 313 // We are using the DB address book or a plugin address book | |
| 314 if (!empty($abook_type) && strtolower($abook_type) != 'ldap') { | |
| 315 if (!isset($this->address_books['0'])) { | |
| 316 $this->address_books['0'] = new rcube_contacts($this->db, $this->get_user_id()); | |
| 317 } | |
| 318 | |
| 319 $list['0'] = array( | |
| 320 'id' => '0', | |
| 321 'name' => $this->gettext('personaladrbook'), | |
| 322 'groups' => $this->address_books['0']->groups, | |
| 323 'readonly' => $this->address_books['0']->readonly, | |
| 324 'undelete' => $this->address_books['0']->undelete && $this->config->get('undo_timeout'), | |
| 325 'autocomplete' => in_array('sql', $autocomplete), | |
| 326 ); | |
| 327 } | |
| 328 | |
| 329 if (!empty($ldap_config)) { | |
| 330 foreach ($ldap_config as $id => $prop) { | |
| 331 // handle misconfiguration | |
| 332 if (empty($prop) || !is_array($prop)) { | |
| 333 continue; | |
| 334 } | |
| 335 | |
| 336 $list[$id] = array( | |
| 337 'id' => $id, | |
| 338 'name' => html::quote($prop['name']), | |
| 339 'groups' => !empty($prop['groups']) || !empty($prop['group_filters']), | |
| 340 'readonly' => !$prop['writable'], | |
| 341 'hidden' => $prop['hidden'], | |
| 342 'autocomplete' => in_array($id, $autocomplete) | |
| 343 ); | |
| 344 } | |
| 345 } | |
| 346 | |
| 347 $plugin = $this->plugins->exec_hook('addressbooks_list', array('sources' => $list)); | |
| 348 $list = $plugin['sources']; | |
| 349 | |
| 350 foreach ($list as $idx => $item) { | |
| 351 // register source for shutdown function | |
| 352 if (!is_object($this->address_books[$item['id']])) { | |
| 353 $this->address_books[$item['id']] = $item; | |
| 354 } | |
| 355 // remove from list if not writeable as requested | |
| 356 if ($writeable && $item['readonly']) { | |
| 357 unset($list[$idx]); | |
| 358 } | |
| 359 // remove from list if hidden as requested | |
| 360 else if ($skip_hidden && $item['hidden']) { | |
| 361 unset($list[$idx]); | |
| 362 } | |
| 363 } | |
| 364 | |
| 365 return $list; | |
| 366 } | |
| 367 | |
| 368 /** | |
| 369 * Getter for compose responses. | |
| 370 * These are stored in local config and user preferences. | |
| 371 * | |
| 372 * @param boolean $sorted True to sort the list alphabetically | |
| 373 * @param boolean $user_only True if only this user's responses shall be listed | |
| 374 * | |
| 375 * @return array List of the current user's stored responses | |
| 376 */ | |
| 377 public function get_compose_responses($sorted = false, $user_only = false) | |
| 378 { | |
| 379 $responses = array(); | |
| 380 | |
| 381 if (!$user_only) { | |
| 382 foreach ($this->config->get('compose_responses_static', array()) as $response) { | |
| 383 if (empty($response['key'])) { | |
| 384 $response['key'] = substr(md5($response['name']), 0, 16); | |
| 385 } | |
| 386 | |
| 387 $response['static'] = true; | |
| 388 $response['class'] = 'readonly'; | |
| 389 | |
| 390 $k = $sorted ? '0000-' . mb_strtolower($response['name']) : $response['key']; | |
| 391 $responses[$k] = $response; | |
| 392 } | |
| 393 } | |
| 394 | |
| 395 foreach ($this->config->get('compose_responses', array()) as $response) { | |
| 396 if (empty($response['key'])) { | |
| 397 $response['key'] = substr(md5($response['name']), 0, 16); | |
| 398 } | |
| 399 | |
| 400 $k = $sorted ? mb_strtolower($response['name']) : $response['key']; | |
| 401 $responses[$k] = $response; | |
| 402 } | |
| 403 | |
| 404 // sort list by name | |
| 405 if ($sorted) { | |
| 406 ksort($responses, SORT_LOCALE_STRING); | |
| 407 } | |
| 408 | |
| 409 $responses = array_values($responses); | |
| 410 | |
| 411 $hook = $this->plugins->exec_hook('get_compose_responses', array( | |
| 412 'list' => $responses, | |
| 413 'sorted' => $sorted, | |
| 414 'user_only' => $user_only, | |
| 415 )); | |
| 416 | |
| 417 return $hook['list']; | |
| 418 } | |
| 419 | |
| 420 /** | |
| 421 * Init output object for GUI and add common scripts. | |
| 422 * This will instantiate a rcmail_output_html object and set | |
| 423 * environment vars according to the current session and configuration | |
| 424 * | |
| 425 * @param boolean $framed True if this request is loaded in a (i)frame | |
| 426 * | |
| 427 * @return rcube_output Reference to HTML output object | |
| 428 */ | |
| 429 public function load_gui($framed = false) | |
| 430 { | |
| 431 // init output page | |
| 432 if (!($this->output instanceof rcmail_output_html)) { | |
| 433 $this->output = new rcmail_output_html($this->task, $framed); | |
| 434 } | |
| 435 | |
| 436 // set refresh interval | |
| 437 $this->output->set_env('refresh_interval', $this->config->get('refresh_interval', 0)); | |
| 438 $this->output->set_env('session_lifetime', $this->config->get('session_lifetime', 0) * 60); | |
| 439 | |
| 440 if ($framed) { | |
| 441 $this->comm_path .= '&_framed=1'; | |
| 442 $this->output->set_env('framed', true); | |
| 443 } | |
| 444 | |
| 445 $this->output->set_env('task', $this->task); | |
| 446 $this->output->set_env('action', $this->action); | |
| 447 $this->output->set_env('comm_path', $this->comm_path); | |
| 448 $this->output->set_charset(RCUBE_CHARSET); | |
| 449 | |
| 450 if ($this->user && $this->user->ID) { | |
| 451 $this->output->set_env('user_id', $this->user->get_hash()); | |
| 452 } | |
| 453 | |
| 454 // set compose mode for all tasks (message compose step can be triggered from everywhere) | |
| 455 $this->output->set_env('compose_extwin', $this->config->get('compose_extwin',false)); | |
| 456 | |
| 457 // add some basic labels to client | |
| 458 $this->output->add_label('loading', 'servererror', 'connerror', 'requesttimedout', | |
| 459 'refreshing', 'windowopenerror', 'uploadingmany', 'close'); | |
| 460 | |
| 461 return $this->output; | |
| 462 } | |
| 463 | |
| 464 /** | |
| 465 * Create an output object for JSON responses | |
| 466 * | |
| 467 * @return rcube_output Reference to JSON output object | |
| 468 */ | |
| 469 public function json_init() | |
| 470 { | |
| 471 if (!($this->output instanceof rcmail_output_json)) { | |
| 472 $this->output = new rcmail_output_json($this->task); | |
| 473 } | |
| 474 | |
| 475 return $this->output; | |
| 476 } | |
| 477 | |
| 478 /** | |
| 479 * Create session object and start the session. | |
| 480 */ | |
| 481 public function session_init() | |
| 482 { | |
| 483 parent::session_init(); | |
| 484 | |
| 485 // set initial session vars | |
| 486 if (!$_SESSION['user_id']) { | |
| 487 $_SESSION['temp'] = true; | |
| 488 } | |
| 489 | |
| 490 // restore skin selection after logout | |
| 19 | 491 if (!empty($_SESSION['temp']) && !empty($_SESSION['skin'])) { |
| 0 | 492 $this->config->set('skin', $_SESSION['skin']); |
| 493 } | |
| 494 } | |
| 495 | |
| 496 /** | |
| 497 * Perform login to the mail server and to the webmail service. | |
| 498 * This will also create a new user entry if auto_create_user is configured. | |
| 499 * | |
| 500 * @param string $username Mail storage (IMAP) user name | |
| 501 * @param string $password Mail storage (IMAP) password | |
| 502 * @param string $host Mail storage (IMAP) host | |
| 503 * @param bool $cookiecheck Enables cookie check | |
| 504 * | |
| 505 * @return boolean True on success, False on failure | |
| 506 */ | |
| 507 function login($username, $password, $host = null, $cookiecheck = false) | |
| 508 { | |
| 509 $this->login_error = null; | |
| 510 | |
| 511 if (empty($username)) { | |
| 512 return false; | |
| 513 } | |
| 514 | |
| 515 if ($cookiecheck && empty($_COOKIE)) { | |
| 516 $this->login_error = self::ERROR_COOKIES_DISABLED; | |
| 517 return false; | |
| 518 } | |
| 519 | |
| 520 $username_filter = $this->config->get('login_username_filter'); | |
| 521 $username_maxlen = $this->config->get('login_username_maxlen', 1024); | |
| 522 $password_maxlen = $this->config->get('login_password_maxlen', 1024); | |
| 523 $default_host = $this->config->get('default_host'); | |
| 524 $default_port = $this->config->get('default_port'); | |
| 525 $username_domain = $this->config->get('username_domain'); | |
| 526 $login_lc = $this->config->get('login_lc', 2); | |
| 527 | |
| 528 // check input for security (#1490500) | |
| 529 if (($username_maxlen && strlen($username) > $username_maxlen) | |
| 530 || ($username_filter && !preg_match($username_filter, $username)) | |
| 531 || ($password_maxlen && strlen($password) > $password_maxlen) | |
| 532 ) { | |
| 533 $this->login_error = self::ERROR_INVALID_REQUEST; | |
| 534 return false; | |
| 535 } | |
| 536 | |
| 537 // host is validated in rcmail::autoselect_host(), so here | |
| 538 // we'll only handle unset host (if possible) | |
| 539 if (!$host && !empty($default_host)) { | |
| 540 if (is_array($default_host)) { | |
| 541 $key = key($default_host); | |
| 542 $host = is_numeric($key) ? $default_host[$key] : $key; | |
| 543 } | |
| 544 else { | |
| 545 $host = $default_host; | |
| 546 } | |
| 547 | |
| 548 $host = rcube_utils::parse_host($host); | |
| 549 } | |
| 550 | |
| 551 if (!$host) { | |
| 552 $this->login_error = self::ERROR_INVALID_HOST; | |
| 553 return false; | |
| 554 } | |
| 555 | |
| 556 // parse $host URL | |
| 557 $a_host = parse_url($host); | |
| 558 if ($a_host['host']) { | |
| 559 $host = $a_host['host']; | |
| 560 $ssl = (isset($a_host['scheme']) && in_array($a_host['scheme'], array('ssl','imaps','tls'))) ? $a_host['scheme'] : null; | |
| 561 | |
| 562 if (!empty($a_host['port'])) | |
| 563 $port = $a_host['port']; | |
| 564 else if ($ssl && $ssl != 'tls' && (!$default_port || $default_port == 143)) | |
| 565 $port = 993; | |
| 566 } | |
| 567 | |
| 568 if (!$port) { | |
| 569 $port = $default_port; | |
| 570 } | |
| 571 | |
| 572 // Check if we need to add/force domain to username | |
| 573 if (!empty($username_domain)) { | |
| 574 $domain = is_array($username_domain) ? $username_domain[$host] : $username_domain; | |
| 575 | |
| 576 if ($domain = rcube_utils::parse_host((string)$domain, $host)) { | |
| 577 $pos = strpos($username, '@'); | |
| 578 | |
| 579 // force configured domains | |
| 580 if ($pos !== false && $this->config->get('username_domain_forced')) { | |
| 581 $username = substr($username, 0, $pos) . '@' . $domain; | |
| 582 } | |
| 583 // just add domain if not specified | |
| 584 else if ($pos === false) { | |
| 585 $username .= '@' . $domain; | |
| 586 } | |
| 587 } | |
| 588 } | |
| 589 | |
| 590 // Convert username to lowercase. If storage backend | |
| 591 // is case-insensitive we need to store always the same username (#1487113) | |
| 592 if ($login_lc) { | |
| 593 if ($login_lc == 2 || $login_lc === true) { | |
| 594 $username = mb_strtolower($username); | |
| 595 } | |
| 596 else if (strpos($username, '@')) { | |
| 597 // lowercase domain name | |
| 598 list($local, $domain) = explode('@', $username); | |
| 599 $username = $local . '@' . mb_strtolower($domain); | |
| 600 } | |
| 601 } | |
| 602 | |
| 603 // try to resolve email address from virtuser table | |
| 604 if (strpos($username, '@') && ($virtuser = rcube_user::email2user($username))) { | |
| 605 $username = $virtuser; | |
| 606 } | |
| 607 | |
| 608 // Here we need IDNA ASCII | |
| 609 // Only rcube_contacts class is using domain names in Unicode | |
| 610 $host = rcube_utils::idn_to_ascii($host); | |
| 611 $username = rcube_utils::idn_to_ascii($username); | |
| 612 | |
| 613 // user already registered -> overwrite username | |
| 614 if ($user = rcube_user::query($username, $host)) { | |
| 615 $username = $user->data['username']; | |
| 616 | |
| 617 // Brute-force prevention | |
| 618 if ($user->is_locked()) { | |
| 619 $this->login_error = self::ERROR_RATE_LIMIT; | |
| 620 return false; | |
| 621 } | |
| 622 } | |
| 623 | |
| 624 $storage = $this->get_storage(); | |
| 625 | |
| 626 // try to log in | |
| 627 if (!$storage->connect($host, $username, $password, $port, $ssl)) { | |
| 628 if ($user) { | |
| 629 $user->failed_login(); | |
| 630 } | |
| 631 | |
| 632 // Wait a second to slow down brute-force attacks (#1490549) | |
| 633 sleep(1); | |
| 634 return false; | |
| 635 } | |
| 636 | |
| 637 // user already registered -> update user's record | |
| 638 if (is_object($user)) { | |
| 639 // update last login timestamp | |
| 640 $user->touch(); | |
| 641 } | |
| 642 // create new system user | |
| 643 else if ($this->config->get('auto_create_user')) { | |
| 644 if ($created = rcube_user::create($username, $host)) { | |
| 645 $user = $created; | |
| 646 } | |
| 647 else { | |
| 648 self::raise_error(array( | |
| 649 'code' => 620, | |
| 650 'file' => __FILE__, | |
| 651 'line' => __LINE__, | |
| 652 'message' => "Failed to create a user record. Maybe aborted by a plugin?" | |
| 653 ), | |
| 654 true, false); | |
| 655 } | |
| 656 } | |
| 657 else { | |
| 658 self::raise_error(array( | |
| 659 'code' => 621, | |
| 660 'file' => __FILE__, | |
| 661 'line' => __LINE__, | |
| 662 'message' => "Access denied for new user $username. 'auto_create_user' is disabled" | |
| 663 ), | |
| 664 true, false); | |
| 665 } | |
| 666 | |
| 667 // login succeeded | |
| 668 if (is_object($user) && $user->ID) { | |
| 669 // Configure environment | |
| 670 $this->set_user($user); | |
| 671 $this->set_storage_prop(); | |
| 672 | |
| 673 // set session vars | |
| 674 $_SESSION['user_id'] = $user->ID; | |
| 675 $_SESSION['username'] = $user->data['username']; | |
| 676 $_SESSION['storage_host'] = $host; | |
| 677 $_SESSION['storage_port'] = $port; | |
| 678 $_SESSION['storage_ssl'] = $ssl; | |
| 679 $_SESSION['password'] = $this->encrypt($password); | |
| 680 $_SESSION['login_time'] = time(); | |
| 681 | |
| 682 $timezone = rcube_utils::get_input_value('_timezone', rcube_utils::INPUT_GPC); | |
| 683 if ($timezone && is_string($timezone) && $timezone != '_default_') { | |
| 684 $_SESSION['timezone'] = $timezone; | |
| 685 } | |
| 686 | |
| 687 // fix some old settings according to namespace prefix | |
| 688 $this->fix_namespace_settings($user); | |
| 689 | |
| 690 // set/create special folders | |
| 691 $this->set_special_folders(); | |
| 692 | |
| 693 // clear all mailboxes related cache(s) | |
| 694 $storage->clear_cache('mailboxes', true); | |
| 695 | |
| 696 return true; | |
| 697 } | |
| 698 | |
| 699 return false; | |
| 700 } | |
| 701 | |
| 702 /** | |
| 703 * Returns error code of last login operation | |
| 704 * | |
| 705 * @return int Error code | |
| 706 */ | |
| 707 public function login_error() | |
| 708 { | |
| 709 if ($this->login_error) { | |
| 710 return $this->login_error; | |
| 711 } | |
| 712 | |
| 713 if ($this->storage && $this->storage->get_error_code() < -1) { | |
| 714 return self::ERROR_STORAGE; | |
| 715 } | |
| 716 } | |
| 717 | |
| 718 /** | |
| 719 * Auto-select IMAP host based on the posted login information | |
| 720 * | |
| 721 * @return string Selected IMAP host | |
| 722 */ | |
| 723 public function autoselect_host() | |
| 724 { | |
| 725 $default_host = $this->config->get('default_host'); | |
| 726 $host = null; | |
| 727 | |
| 728 if (is_array($default_host)) { | |
| 729 $post_host = rcube_utils::get_input_value('_host', rcube_utils::INPUT_POST); | |
| 730 $post_user = rcube_utils::get_input_value('_user', rcube_utils::INPUT_POST); | |
| 731 | |
| 732 list(, $domain) = explode('@', $post_user); | |
| 733 | |
| 734 // direct match in default_host array | |
| 735 if ($default_host[$post_host] || in_array($post_host, array_values($default_host))) { | |
| 736 $host = $post_host; | |
| 737 } | |
| 738 // try to select host by mail domain | |
| 739 else if (!empty($domain)) { | |
| 740 foreach ($default_host as $storage_host => $mail_domains) { | |
| 741 if (is_array($mail_domains) && in_array_nocase($domain, $mail_domains)) { | |
| 742 $host = $storage_host; | |
| 743 break; | |
| 744 } | |
| 745 else if (stripos($storage_host, $domain) !== false || stripos(strval($mail_domains), $domain) !== false) { | |
| 746 $host = is_numeric($storage_host) ? $mail_domains : $storage_host; | |
| 747 break; | |
| 748 } | |
| 749 } | |
| 750 } | |
| 751 | |
| 752 // take the first entry if $host is still not set | |
| 753 if (empty($host)) { | |
| 754 $key = key($default_host); | |
| 755 $host = is_numeric($key) ? $default_host[$key] : $key; | |
| 756 } | |
| 757 } | |
| 758 else if (empty($default_host)) { | |
| 759 $host = rcube_utils::get_input_value('_host', rcube_utils::INPUT_POST); | |
| 760 } | |
| 761 else { | |
| 762 $host = rcube_utils::parse_host($default_host); | |
| 763 } | |
| 764 | |
| 765 return $host; | |
| 766 } | |
| 767 | |
| 768 /** | |
| 769 * Destroy session data and remove cookie | |
| 770 */ | |
| 771 public function kill_session() | |
| 772 { | |
| 773 $this->plugins->exec_hook('session_destroy'); | |
| 774 | |
| 775 $this->session->kill(); | |
| 776 $_SESSION = array('language' => $this->user->language, 'temp' => true, 'skin' => $this->config->get('skin')); | |
| 777 $this->user->reset(); | |
| 778 } | |
| 779 | |
| 780 /** | |
| 781 * Do server side actions on logout | |
| 782 */ | |
| 783 public function logout_actions() | |
| 784 { | |
| 785 $storage = $this->get_storage(); | |
| 786 $logout_expunge = $this->config->get('logout_expunge'); | |
| 787 $logout_purge = $this->config->get('logout_purge'); | |
| 788 $trash_mbox = $this->config->get('trash_mbox'); | |
| 789 | |
| 790 if ($logout_purge && !empty($trash_mbox)) { | |
| 791 $storage->clear_folder($trash_mbox); | |
| 792 } | |
| 793 | |
| 794 if ($logout_expunge) { | |
| 795 $storage->expunge_folder('INBOX'); | |
| 796 } | |
| 797 | |
| 798 // Try to save unsaved user preferences | |
| 799 if (!empty($_SESSION['preferences'])) { | |
| 800 $this->user->save_prefs(unserialize($_SESSION['preferences'])); | |
| 801 } | |
| 802 } | |
| 803 | |
| 804 /** | |
| 805 * Build a valid URL to this instance of Roundcube | |
| 806 * | |
| 807 * @param mixed $p Either a string with the action or | |
| 808 * url parameters as key-value pairs | |
| 809 * @param boolean $absolute Build an URL absolute to document root | |
| 810 * @param boolean $full Create fully qualified URL including http(s):// and hostname | |
| 811 * @param bool $secure Return absolute URL in secure location | |
| 812 * | |
| 813 * @return string Valid application URL | |
| 814 */ | |
| 815 public function url($p, $absolute = false, $full = false, $secure = false) | |
| 816 { | |
| 817 if (!is_array($p)) { | |
| 818 if (strpos($p, 'http') === 0) { | |
| 819 return $p; | |
| 820 } | |
| 821 | |
| 822 $p = array('_action' => @func_get_arg(0)); | |
| 823 } | |
| 824 | |
| 825 $pre = array(); | |
| 19 | 826 $task = ($p['_task']??null) ?: (($p['task']??null) ?: $this->task); |
| 0 | 827 $pre['_task'] = $task; |
| 828 unset($p['task'], $p['_task']); | |
| 829 | |
| 830 $url = $this->filename; | |
| 831 $delm = '?'; | |
| 832 | |
| 833 foreach (array_merge($pre, $p) as $key => $val) { | |
| 834 if ($val !== '' && $val !== null) { | |
| 835 $par = $key[0] == '_' ? $key : '_'.$key; | |
| 836 $url .= $delm.urlencode($par).'='.urlencode($val); | |
| 837 $delm = '&'; | |
| 838 } | |
| 839 } | |
| 840 | |
|
17
dd5ed6ef69c9
Slowly cleaning up more php8 Warnings/deprecations
Charlie Root
parents:
15
diff
changeset
|
841 $base_path = strval(($_SERVER['REDIRECT_SCRIPT_URL']??null) ?: $_SERVER['SCRIPT_NAME']); |
| 0 | 842 $base_path = preg_replace('![^/]+$!', '', $base_path); |
| 843 | |
| 844 if ($secure && ($token = $this->get_secure_url_token(true))) { | |
| 845 // add token to the url | |
| 846 $url = $token . '/' . $url; | |
| 847 | |
| 848 // remove old token from the path | |
| 849 $base_path = rtrim($base_path, '/'); | |
| 850 $base_path = preg_replace('/\/[a-zA-Z0-9]{' . strlen($token) . '}$/', '', $base_path); | |
| 851 | |
| 852 // this need to be full url to make redirects work | |
| 853 $absolute = true; | |
| 854 } | |
| 855 else if ($secure && ($token = $this->get_request_token())) | |
| 856 $url .= $delm . '_token=' . urlencode($token); | |
| 857 | |
| 858 if ($absolute || $full) { | |
| 859 // add base path to this Roundcube installation | |
| 860 if ($base_path == '') $base_path = '/'; | |
| 861 $prefix = $base_path; | |
| 862 | |
| 863 // prepend protocol://hostname:port | |
| 864 if ($full) { | |
| 865 $prefix = rcube_utils::resolve_url($prefix); | |
| 866 } | |
| 867 | |
| 868 $prefix = rtrim($prefix, '/') . '/'; | |
| 869 } | |
| 870 else { | |
| 871 $prefix = './'; | |
| 872 } | |
| 873 | |
| 874 return $prefix . $url; | |
| 875 } | |
| 876 | |
| 877 /** | |
| 878 * Function to be executed in script shutdown | |
| 879 */ | |
| 880 public function shutdown() | |
| 881 { | |
| 882 parent::shutdown(); | |
| 883 | |
| 884 foreach ($this->address_books as $book) { | |
| 885 if (is_object($book) && is_a($book, 'rcube_addressbook')) { | |
| 886 $book->close(); | |
| 887 } | |
| 888 } | |
| 889 | |
| 890 // write performance stats to logs/console | |
| 891 if ($this->config->get('devel_mode') || $this->config->get('performance_stats')) { | |
| 892 // make sure logged numbers use unified format | |
| 893 setlocale(LC_NUMERIC, 'en_US.utf8', 'en_US.UTF-8', 'en_US', 'C'); | |
| 894 | |
| 895 if (function_exists('memory_get_usage')) { | |
| 896 $mem = $this->show_bytes(memory_get_usage()); | |
| 897 } | |
| 898 if (function_exists('memory_get_peak_usage')) { | |
| 899 $mem .= '/'.$this->show_bytes(memory_get_peak_usage()); | |
| 900 } | |
| 901 | |
| 902 $log = $this->task . ($this->action ? '/'.$this->action : '') . ($mem ? " [$mem]" : ''); | |
| 903 | |
| 904 if (defined('RCMAIL_START')) { | |
| 905 self::print_timer(RCMAIL_START, $log); | |
| 906 } | |
| 907 else { | |
| 908 self::console($log); | |
| 909 } | |
| 910 } | |
| 911 } | |
| 912 | |
| 913 /** | |
| 914 * CSRF attack prevention code. Raises error when check fails. | |
| 915 * | |
| 916 * @param int $mode Request mode | |
| 917 */ | |
| 918 public function request_security_check($mode = rcube_utils::INPUT_POST) | |
| 919 { | |
| 920 // check request token | |
| 921 if (!$this->check_request($mode)) { | |
| 922 $error = array('code' => 403, 'message' => "Request security check failed"); | |
| 923 self::raise_error($error, false, true); | |
| 924 } | |
| 925 | |
| 926 // check referer if configured | |
| 927 if ($this->config->get('referer_check') && !rcube_utils::check_referer()) { | |
| 928 $error = array('code' => 403, 'message' => "Referer check failed"); | |
| 929 self::raise_error($error, true, true); | |
| 930 } | |
| 931 } | |
| 932 | |
| 933 /** | |
| 934 * Registers action aliases for current task | |
| 935 * | |
| 936 * @param array $map Alias-to-filename hash array | |
| 937 */ | |
| 938 public function register_action_map($map) | |
| 939 { | |
| 940 if (is_array($map)) { | |
| 941 foreach ($map as $idx => $val) { | |
| 942 $this->action_map[$idx] = $val; | |
| 943 } | |
| 944 } | |
| 945 } | |
| 946 | |
| 947 /** | |
| 948 * Returns current action filename | |
| 949 * | |
| 950 * @param array $map Alias-to-filename hash array | |
| 951 */ | |
| 952 public function get_action_file() | |
| 953 { | |
| 954 if (!empty($this->action_map[$this->action])) { | |
| 955 return $this->action_map[$this->action]; | |
| 956 } | |
| 957 | |
| 958 return strtr($this->action, '-', '_') . '.inc'; | |
| 959 } | |
| 960 | |
| 961 /** | |
| 962 * Fixes some user preferences according to namespace handling change. | |
| 963 * Old Roundcube versions were using folder names with removed namespace prefix. | |
| 964 * Now we need to add the prefix on servers where personal namespace has prefix. | |
| 965 * | |
| 966 * @param rcube_user $user User object | |
| 967 */ | |
| 968 private function fix_namespace_settings($user) | |
| 969 { | |
| 970 $prefix = $this->storage->get_namespace('prefix'); | |
| 971 $prefix_len = strlen($prefix); | |
| 972 | |
| 973 if (!$prefix_len) { | |
| 974 return; | |
| 975 } | |
| 976 | |
| 977 if ($this->config->get('namespace_fixed')) { | |
| 978 return; | |
| 979 } | |
| 980 | |
| 981 $prefs = array(); | |
| 982 | |
| 983 // Build namespace prefix regexp | |
| 984 $ns = $this->storage->get_namespace(); | |
| 985 $regexp = array(); | |
| 986 | |
| 987 foreach ($ns as $entry) { | |
| 988 if (!empty($entry)) { | |
| 989 foreach ($entry as $item) { | |
| 990 if (strlen($item[0])) { | |
| 991 $regexp[] = preg_quote($item[0], '/'); | |
| 992 } | |
| 993 } | |
| 994 } | |
| 995 } | |
| 996 $regexp = '/^('. implode('|', $regexp).')/'; | |
| 997 | |
| 998 // Fix preferences | |
| 999 $opts = array('drafts_mbox', 'junk_mbox', 'sent_mbox', 'trash_mbox', 'archive_mbox'); | |
| 1000 foreach ($opts as $opt) { | |
| 1001 if ($value = $this->config->get($opt)) { | |
| 1002 if ($value != 'INBOX' && !preg_match($regexp, $value)) { | |
| 1003 $prefs[$opt] = $prefix.$value; | |
| 1004 } | |
| 1005 } | |
| 1006 } | |
| 1007 | |
| 1008 if (($search_mods = $this->config->get('search_mods')) && !empty($search_mods)) { | |
| 1009 $folders = array(); | |
| 1010 foreach ($search_mods as $idx => $value) { | |
| 1011 if ($idx != 'INBOX' && $idx != '*' && !preg_match($regexp, $idx)) { | |
| 1012 $idx = $prefix.$idx; | |
| 1013 } | |
| 1014 $folders[$idx] = $value; | |
| 1015 } | |
| 1016 | |
| 1017 $prefs['search_mods'] = $folders; | |
| 1018 } | |
| 1019 | |
| 1020 if (($threading = $this->config->get('message_threading')) && !empty($threading)) { | |
| 1021 $folders = array(); | |
| 1022 foreach ($threading as $idx => $value) { | |
| 1023 if ($idx != 'INBOX' && !preg_match($regexp, $idx)) { | |
| 1024 $idx = $prefix.$idx; | |
| 1025 } | |
| 1026 $folders[$prefix.$idx] = $value; | |
| 1027 } | |
| 1028 | |
| 1029 $prefs['message_threading'] = $folders; | |
| 1030 } | |
| 1031 | |
| 1032 if ($collapsed = $this->config->get('collapsed_folders')) { | |
| 1033 $folders = explode('&&', $collapsed); | |
| 1034 $count = count($folders); | |
| 1035 $folders_str = ''; | |
| 1036 | |
| 1037 if ($count) { | |
| 1038 $folders[0] = substr($folders[0], 1); | |
| 1039 $folders[$count-1] = substr($folders[$count-1], 0, -1); | |
| 1040 } | |
| 1041 | |
| 1042 foreach ($folders as $value) { | |
| 1043 if ($value != 'INBOX' && !preg_match($regexp, $value)) { | |
| 1044 $value = $prefix.$value; | |
| 1045 } | |
| 1046 $folders_str .= '&'.$value.'&'; | |
| 1047 } | |
| 1048 | |
| 1049 $prefs['collapsed_folders'] = $folders_str; | |
| 1050 } | |
| 1051 | |
| 1052 $prefs['namespace_fixed'] = true; | |
| 1053 | |
| 1054 // save updated preferences and reset imap settings (default folders) | |
| 1055 $user->save_prefs($prefs); | |
| 1056 $this->set_storage_prop(); | |
| 1057 } | |
| 1058 | |
| 1059 /** | |
| 1060 * Overwrite action variable | |
| 1061 * | |
| 1062 * @param string $action New action value | |
| 1063 */ | |
| 1064 public function overwrite_action($action) | |
| 1065 { | |
| 1066 $this->action = $action; | |
| 1067 $this->output->set_env('action', $action); | |
| 1068 } | |
| 1069 | |
| 1070 /** | |
| 1071 * Set environment variables for specified config options | |
| 1072 * | |
| 1073 * @param array $options List of configuration option names | |
| 1074 */ | |
| 1075 public function set_env_config($options) | |
| 1076 { | |
| 1077 foreach ((array) $options as $option) { | |
| 1078 if ($this->config->get($option)) { | |
| 1079 $this->output->set_env($option, true); | |
| 1080 } | |
| 1081 } | |
| 1082 } | |
| 1083 | |
| 1084 /** | |
| 1085 * Returns RFC2822 formatted current date in user's timezone | |
| 1086 * | |
| 1087 * @return string Date | |
| 1088 */ | |
| 1089 public function user_date() | |
| 1090 { | |
| 1091 // get user's timezone | |
| 1092 try { | |
| 1093 $tz = new DateTimeZone($this->config->get('timezone')); | |
| 1094 $date = new DateTime('now', $tz); | |
| 1095 } | |
| 1096 catch (Exception $e) { | |
| 1097 $date = new DateTime(); | |
| 1098 } | |
| 1099 | |
| 1100 return $date->format('r'); | |
| 1101 } | |
| 1102 | |
| 1103 /** | |
| 1104 * Write login data (name, ID, IP address) to the 'userlogins' log file. | |
| 1105 */ | |
| 1106 public function log_login($user = null, $failed_login = false, $error_code = 0) | |
| 1107 { | |
| 1108 if (!$this->config->get('log_logins')) { | |
| 1109 return; | |
| 1110 } | |
| 1111 | |
| 1112 // failed login | |
| 1113 if ($failed_login) { | |
| 1114 // don't fill the log with complete input, which could | |
| 1115 // have been prepared by a hacker | |
| 1116 if (strlen($user) > 256) { | |
| 1117 $user = substr($user, 0, 256) . '...'; | |
| 1118 } | |
| 1119 | |
| 1120 $message = sprintf('Failed login for %s from %s in session %s (error: %d)', | |
| 1121 $user, rcube_utils::remote_ip(), session_id(), $error_code); | |
| 1122 } | |
| 1123 // successful login | |
| 1124 else { | |
| 1125 $user_name = $this->get_user_name(); | |
| 1126 $user_id = $this->get_user_id(); | |
| 1127 | |
| 1128 if (!$user_id) { | |
| 1129 return; | |
| 1130 } | |
| 1131 | |
| 1132 $message = sprintf('Successful login for %s (ID: %d) from %s in session %s', | |
| 1133 $user_name, $user_id, rcube_utils::remote_ip(), session_id()); | |
| 1134 } | |
| 1135 | |
| 1136 // log login | |
| 1137 self::write_log('userlogins', $message); | |
| 1138 } | |
| 1139 | |
| 1140 /** | |
| 1141 * Create a HTML table based on the given data | |
| 1142 * | |
| 1143 * @param array $attrib Named table attributes | |
| 1144 * @param mixed $table_data Table row data. Either a two-dimensional array | |
| 1145 * or a valid SQL result set | |
| 1146 * @param array $show_cols List of cols to show | |
| 1147 * @param string $id_col Name of the identifier col | |
| 1148 * | |
| 1149 * @return string HTML table code | |
| 1150 */ | |
| 1151 public function table_output($attrib, $table_data, $show_cols, $id_col) | |
| 1152 { | |
| 1153 $table = new html_table($attrib); | |
| 1154 | |
| 1155 // add table header | |
| 1156 if (!$attrib['noheader']) { | |
| 1157 foreach ($show_cols as $col) { | |
| 1158 $table->add_header($col, $this->Q($this->gettext($col))); | |
| 1159 } | |
| 1160 } | |
| 1161 | |
| 1162 if (!is_array($table_data)) { | |
| 1163 $db = $this->get_dbh(); | |
| 1164 while ($table_data && ($sql_arr = $db->fetch_assoc($table_data))) { | |
| 1165 $table->add_row(array('id' => 'rcmrow' . rcube_utils::html_identifier($sql_arr[$id_col]))); | |
| 1166 | |
| 1167 // format each col | |
| 1168 foreach ($show_cols as $col) { | |
| 1169 $table->add($col, $this->Q($sql_arr[$col])); | |
| 1170 } | |
| 1171 } | |
| 1172 } | |
| 1173 else { | |
| 1174 foreach ($table_data as $row_data) { | |
| 1175 $class = !empty($row_data['class']) ? $row_data['class'] : null; | |
| 1176 if (!empty($attrib['rowclass'])) | |
| 1177 $class = trim($class . ' ' . $attrib['rowclass']); | |
| 1178 $rowid = 'rcmrow' . rcube_utils::html_identifier($row_data[$id_col]); | |
| 1179 | |
| 1180 $table->add_row(array('id' => $rowid, 'class' => $class)); | |
| 1181 | |
| 1182 // format each col | |
| 1183 foreach ($show_cols as $col) { | |
| 1184 $val = is_array($row_data[$col]) ? $row_data[$col][0] : $row_data[$col]; | |
| 1185 $table->add($col, empty($attrib['ishtml']) ? $this->Q($val) : $val); | |
| 1186 } | |
| 1187 } | |
| 1188 } | |
| 1189 | |
| 1190 return $table->show($attrib); | |
| 1191 } | |
| 1192 | |
| 1193 /** | |
| 1194 * Convert the given date to a human readable form | |
| 1195 * This uses the date formatting properties from config | |
| 1196 * | |
| 1197 * @param mixed $date Date representation (string, timestamp or DateTime object) | |
| 1198 * @param string $format Date format to use | |
| 1199 * @param bool $convert Enables date conversion according to user timezone | |
| 1200 * | |
| 1201 * @return string Formatted date string | |
| 1202 */ | |
| 1203 public function format_date($date, $format = null, $convert = true) | |
| 1204 { | |
|
15
85a746e95663
slowly working through deprecations/warnings from 8.3
Charlie Root
parents:
0
diff
changeset
|
1205 $today = false; |
|
85a746e95663
slowly working through deprecations/warnings from 8.3
Charlie Root
parents:
0
diff
changeset
|
1206 |
| 0 | 1207 if (is_object($date) && is_a($date, 'DateTime')) { |
| 1208 $timestamp = $date->format('U'); | |
| 1209 } | |
| 1210 else { | |
| 1211 if (!empty($date)) { | |
| 1212 $timestamp = rcube_utils::strtotime($date); | |
| 1213 } | |
| 1214 | |
| 1215 if (empty($timestamp)) { | |
| 1216 return ''; | |
| 1217 } | |
| 1218 | |
| 1219 try { | |
| 1220 $date = new DateTime("@".$timestamp); | |
| 1221 } | |
| 1222 catch (Exception $e) { | |
| 1223 return ''; | |
| 1224 } | |
| 1225 } | |
| 1226 | |
| 1227 if ($convert) { | |
| 1228 try { | |
| 1229 // convert to the right timezone | |
| 1230 $stz = date_default_timezone_get(); | |
| 1231 $tz = new DateTimeZone($this->config->get('timezone')); | |
| 1232 $date->setTimezone($tz); | |
| 1233 date_default_timezone_set($tz->getName()); | |
| 1234 | |
| 1235 $timestamp = $date->format('U'); | |
| 1236 } | |
| 1237 catch (Exception $e) { | |
| 1238 } | |
| 1239 } | |
| 1240 | |
| 1241 // define date format depending on current time | |
| 1242 if (!$format) { | |
| 1243 $now = time(); | |
| 1244 $now_date = getdate($now); | |
| 1245 $today_limit = mktime(0, 0, 0, $now_date['mon'], $now_date['mday'], $now_date['year']); | |
| 1246 $week_limit = mktime(0, 0, 0, $now_date['mon'], $now_date['mday']-6, $now_date['year']); | |
| 1247 $pretty_date = $this->config->get('prettydate'); | |
| 1248 | |
| 1249 if ($pretty_date && $timestamp > $today_limit && $timestamp <= $now) { | |
| 1250 $format = $this->config->get('date_today', $this->config->get('time_format', 'H:i')); | |
| 1251 $today = true; | |
| 1252 } | |
| 1253 else if ($pretty_date && $timestamp > $week_limit && $timestamp <= $now) { | |
| 1254 $format = $this->config->get('date_short', 'D H:i'); | |
| 1255 } | |
| 1256 else { | |
| 1257 $format = $this->config->get('date_long', 'Y-m-d H:i'); | |
| 1258 } | |
| 1259 } | |
| 1260 | |
| 1261 // strftime() format | |
| 1262 if (preg_match('/%[a-z]+/i', $format)) { | |
| 1263 $format = strftime($format, $timestamp); | |
| 1264 if ($stz) { | |
| 1265 date_default_timezone_set($stz); | |
| 1266 } | |
| 1267 return $today ? ($this->gettext('today') . ' ' . $format) : $format; | |
| 1268 } | |
| 1269 | |
| 1270 // parse format string manually in order to provide localized weekday and month names | |
| 1271 // an alternative would be to convert the date() format string to fit with strftime() | |
| 1272 $out = ''; | |
| 1273 for ($i=0; $i<strlen($format); $i++) { | |
| 1274 if ($format[$i] == "\\") { // skip escape chars | |
| 1275 continue; | |
| 1276 } | |
| 1277 | |
| 1278 // write char "as-is" | |
| 1279 if ($format[$i] == ' ' || $format[$i-1] == "\\") { | |
| 1280 $out .= $format[$i]; | |
| 1281 } | |
| 1282 // weekday (short) | |
| 1283 else if ($format[$i] == 'D') { | |
| 1284 $out .= $this->gettext(strtolower(date('D', $timestamp))); | |
| 1285 } | |
| 1286 // weekday long | |
| 1287 else if ($format[$i] == 'l') { | |
| 1288 $out .= $this->gettext(strtolower(date('l', $timestamp))); | |
| 1289 } | |
| 1290 // month name (short) | |
| 1291 else if ($format[$i] == 'M') { | |
| 1292 $out .= $this->gettext(strtolower(date('M', $timestamp))); | |
| 1293 } | |
| 1294 // month name (long) | |
| 1295 else if ($format[$i] == 'F') { | |
| 1296 $out .= $this->gettext('long'.strtolower(date('M', $timestamp))); | |
| 1297 } | |
| 1298 else if ($format[$i] == 'x') { | |
| 1299 $out .= strftime('%x %X', $timestamp); | |
| 1300 } | |
| 1301 else { | |
| 1302 $out .= date($format[$i], $timestamp); | |
| 1303 } | |
| 1304 } | |
| 1305 | |
| 1306 if ($today) { | |
| 1307 $label = $this->gettext('today'); | |
| 1308 // replcae $ character with "Today" label (#1486120) | |
| 1309 if (strpos($out, '$') !== false) { | |
| 1310 $out = preg_replace('/\$/', $label, $out, 1); | |
| 1311 } | |
| 1312 else { | |
| 1313 $out = $label . ' ' . $out; | |
| 1314 } | |
| 1315 } | |
| 1316 | |
| 1317 if ($stz) { | |
| 1318 date_default_timezone_set($stz); | |
| 1319 } | |
| 1320 | |
| 1321 return $out; | |
| 1322 } | |
| 1323 | |
| 1324 /** | |
| 1325 * Return folders list in HTML | |
| 1326 * | |
| 1327 * @param array $attrib Named parameters | |
| 1328 * | |
| 1329 * @return string HTML code for the gui object | |
| 1330 */ | |
| 1331 public function folder_list($attrib) | |
| 1332 { | |
| 1333 static $a_mailboxes; | |
| 1334 | |
| 1335 $attrib += array('maxlength' => 100, 'realnames' => false, 'unreadwrap' => ' (%s)'); | |
| 1336 | |
| 1337 $type = $attrib['type'] ? $attrib['type'] : 'ul'; | |
| 1338 unset($attrib['type']); | |
| 1339 | |
| 1340 if ($type == 'ul' && !$attrib['id']) { | |
| 1341 $attrib['id'] = 'rcmboxlist'; | |
| 1342 } | |
| 1343 | |
| 1344 if (empty($attrib['folder_name'])) { | |
| 1345 $attrib['folder_name'] = '*'; | |
| 1346 } | |
| 1347 | |
| 1348 // get current folder | |
| 1349 $storage = $this->get_storage(); | |
| 1350 $mbox_name = $storage->get_folder(); | |
| 1351 | |
| 1352 // build the folders tree | |
| 1353 if (empty($a_mailboxes)) { | |
| 1354 // get mailbox list | |
| 1355 $a_folders = $storage->list_folders_subscribed( | |
| 1356 '', $attrib['folder_name'], $attrib['folder_filter']); | |
| 1357 $delimiter = $storage->get_hierarchy_delimiter(); | |
| 1358 $a_mailboxes = array(); | |
| 1359 | |
| 1360 foreach ($a_folders as $folder) { | |
| 1361 $this->build_folder_tree($a_mailboxes, $folder, $delimiter); | |
| 1362 } | |
| 1363 } | |
| 1364 | |
| 1365 // allow plugins to alter the folder tree or to localize folder names | |
| 1366 $hook = $this->plugins->exec_hook('render_mailboxlist', array( | |
| 1367 'list' => $a_mailboxes, | |
| 1368 'delimiter' => $delimiter, | |
| 1369 'type' => $type, | |
| 1370 'attribs' => $attrib, | |
| 1371 )); | |
| 1372 | |
| 1373 $a_mailboxes = $hook['list']; | |
| 1374 $attrib = $hook['attribs']; | |
| 1375 | |
| 1376 if ($type == 'select') { | |
| 1377 $attrib['is_escaped'] = true; | |
| 1378 $select = new html_select($attrib); | |
| 1379 | |
| 1380 // add no-selection option | |
| 1381 if ($attrib['noselection']) { | |
| 1382 $select->add(html::quote($this->gettext($attrib['noselection'])), ''); | |
| 1383 } | |
| 1384 | |
| 1385 $this->render_folder_tree_select($a_mailboxes, $mbox_name, $attrib['maxlength'], $select, $attrib['realnames']); | |
| 1386 $out = $select->show($attrib['default']); | |
| 1387 } | |
| 1388 else { | |
| 1389 $js_mailboxlist = array(); | |
| 1390 $tree = $this->render_folder_tree_html($a_mailboxes, $mbox_name, $js_mailboxlist, $attrib); | |
| 1391 | |
| 1392 if ($type != 'js') { | |
| 1393 $out = html::tag('ul', $attrib, $tree, html::$common_attrib); | |
| 1394 | |
| 1395 $this->output->include_script('treelist.js'); | |
| 1396 $this->output->add_gui_object('mailboxlist', $attrib['id']); | |
| 1397 $this->output->set_env('unreadwrap', $attrib['unreadwrap']); | |
| 1398 $this->output->set_env('collapsed_folders', (string) $this->config->get('collapsed_folders')); | |
| 1399 } | |
| 1400 | |
| 1401 $this->output->set_env('mailboxes', $js_mailboxlist); | |
| 1402 | |
| 1403 // we can't use object keys in javascript because they are unordered | |
| 1404 // we need sorted folders list for folder-selector widget | |
| 1405 $this->output->set_env('mailboxes_list', array_keys($js_mailboxlist)); | |
| 1406 } | |
| 1407 | |
| 1408 // add some labels to client | |
| 1409 $this->output->add_label('purgefolderconfirm', 'deletemessagesconfirm'); | |
| 1410 | |
| 1411 return $out; | |
| 1412 } | |
| 1413 | |
| 1414 /** | |
| 1415 * Return folders list as html_select object | |
| 1416 * | |
| 1417 * @param array $p Named parameters | |
| 1418 * | |
| 1419 * @return html_select HTML drop-down object | |
| 1420 */ | |
| 1421 public function folder_selector($p = array()) | |
| 1422 { | |
| 1423 $realnames = $this->config->get('show_real_foldernames'); | |
| 1424 $p += array('maxlength' => 100, 'realnames' => $realnames, 'is_escaped' => true); | |
| 1425 $a_mailboxes = array(); | |
| 1426 $storage = $this->get_storage(); | |
| 1427 | |
| 1428 if (empty($p['folder_name'])) { | |
| 1429 $p['folder_name'] = '*'; | |
| 1430 } | |
| 1431 | |
| 1432 if ($p['unsubscribed']) { | |
| 1433 $list = $storage->list_folders('', $p['folder_name'], $p['folder_filter'], $p['folder_rights']); | |
| 1434 } | |
| 1435 else { | |
| 1436 $list = $storage->list_folders_subscribed('', $p['folder_name'], $p['folder_filter'], $p['folder_rights']); | |
| 1437 } | |
| 1438 | |
| 1439 $delimiter = $storage->get_hierarchy_delimiter(); | |
| 1440 | |
| 1441 if (!empty($p['exceptions'])) { | |
| 1442 $list = array_diff($list, (array) $p['exceptions']); | |
| 1443 } | |
| 1444 | |
| 1445 if (!empty($p['additional'])) { | |
| 1446 foreach ($p['additional'] as $add_folder) { | |
| 1447 $add_items = explode($delimiter, $add_folder); | |
| 1448 $folder = ''; | |
| 1449 while (count($add_items)) { | |
| 1450 $folder .= array_shift($add_items); | |
| 1451 | |
| 1452 // @TODO: sorting | |
| 1453 if (!in_array($folder, $list)) { | |
| 1454 $list[] = $folder; | |
| 1455 } | |
| 1456 | |
| 1457 $folder .= $delimiter; | |
| 1458 } | |
| 1459 } | |
| 1460 } | |
| 1461 | |
| 1462 foreach ($list as $folder) { | |
| 1463 $this->build_folder_tree($a_mailboxes, $folder, $delimiter); | |
| 1464 } | |
| 1465 | |
| 1466 $select = new html_select($p); | |
| 1467 | |
| 1468 if ($p['noselection']) { | |
| 1469 $select->add(html::quote($p['noselection']), ''); | |
| 1470 } | |
| 1471 | |
| 1472 $this->render_folder_tree_select($a_mailboxes, $mbox, $p['maxlength'], $select, $p['realnames'], 0, $p); | |
| 1473 | |
| 1474 return $select; | |
| 1475 } | |
| 1476 | |
| 1477 /** | |
| 1478 * Create a hierarchical array of the mailbox list | |
| 1479 */ | |
| 1480 public function build_folder_tree(&$arrFolders, $folder, $delm = '/', $path = '') | |
| 1481 { | |
| 1482 // Handle namespace prefix | |
| 1483 $prefix = ''; | |
| 1484 if (!$path) { | |
| 1485 $n_folder = $folder; | |
| 1486 $folder = $this->storage->mod_folder($folder); | |
| 1487 | |
| 1488 if ($n_folder != $folder) { | |
| 1489 $prefix = substr($n_folder, 0, -strlen($folder)); | |
| 1490 } | |
| 1491 } | |
| 1492 | |
| 1493 $pos = strpos($folder, $delm); | |
| 1494 | |
| 1495 if ($pos !== false) { | |
| 1496 $subFolders = substr($folder, $pos+1); | |
| 1497 $currentFolder = substr($folder, 0, $pos); | |
| 1498 | |
| 1499 // sometimes folder has a delimiter as the last character | |
| 1500 if (!strlen($subFolders)) { | |
| 1501 $virtual = false; | |
| 1502 } | |
| 1503 else if (!isset($arrFolders[$currentFolder])) { | |
| 1504 $virtual = true; | |
| 1505 } | |
| 1506 else { | |
| 1507 $virtual = $arrFolders[$currentFolder]['virtual']; | |
| 1508 } | |
| 1509 } | |
| 1510 else { | |
| 1511 $subFolders = false; | |
| 1512 $currentFolder = $folder; | |
| 1513 $virtual = false; | |
| 1514 } | |
| 1515 | |
| 1516 $path .= $prefix . $currentFolder; | |
| 1517 | |
| 1518 if (!isset($arrFolders[$currentFolder])) { | |
| 1519 $arrFolders[$currentFolder] = array( | |
| 1520 'id' => $path, | |
| 1521 'name' => rcube_charset::convert($currentFolder, 'UTF7-IMAP'), | |
| 1522 'virtual' => $virtual, | |
| 1523 'folders' => array() | |
| 1524 ); | |
| 1525 } | |
| 1526 else { | |
| 1527 $arrFolders[$currentFolder]['virtual'] = $virtual; | |
| 1528 } | |
| 1529 | |
| 1530 if (strlen($subFolders)) { | |
| 1531 $this->build_folder_tree($arrFolders[$currentFolder]['folders'], $subFolders, $delm, $path.$delm); | |
| 1532 } | |
| 1533 } | |
| 1534 | |
| 1535 /** | |
| 1536 * Return html for a structured list <ul> for the mailbox tree | |
| 1537 */ | |
| 1538 public function render_folder_tree_html(&$arrFolders, &$mbox_name, &$jslist, $attrib, $nestLevel = 0) | |
| 1539 { | |
| 1540 $maxlength = intval($attrib['maxlength']); | |
| 1541 $realnames = (bool)$attrib['realnames']; | |
| 1542 $msgcounts = $this->storage->get_cache('messagecount'); | |
| 1543 $collapsed = $this->config->get('collapsed_folders'); | |
| 1544 $realnames = $this->config->get('show_real_foldernames'); | |
| 1545 | |
| 1546 $out = ''; | |
| 1547 foreach ($arrFolders as $folder) { | |
| 1548 $title = null; | |
| 1549 $folder_class = $this->folder_classname($folder['id']); | |
| 1550 $is_collapsed = strpos($collapsed, '&'.rawurlencode($folder['id']).'&') !== false; | |
| 1551 $unread = $msgcounts ? intval($msgcounts[$folder['id']]['UNSEEN']) : 0; | |
| 1552 | |
| 1553 if ($folder_class && !$realnames) { | |
| 1554 $foldername = $this->gettext($folder_class); | |
| 1555 } | |
| 1556 else { | |
| 1557 $foldername = $folder['name']; | |
| 1558 | |
| 1559 // shorten the folder name to a given length | |
| 1560 if ($maxlength && $maxlength > 1) { | |
| 1561 $fname = abbreviate_string($foldername, $maxlength); | |
| 1562 if ($fname != $foldername) { | |
| 1563 $title = $foldername; | |
| 1564 } | |
| 1565 $foldername = $fname; | |
| 1566 } | |
| 1567 } | |
| 1568 | |
| 1569 // make folder name safe for ids and class names | |
| 1570 $folder_id = rcube_utils::html_identifier($folder['id'], true); | |
| 1571 $classes = array('mailbox'); | |
| 1572 | |
| 1573 // set special class for Sent, Drafts, Trash and Junk | |
| 1574 if ($folder_class) { | |
| 1575 $classes[] = $folder_class; | |
| 1576 } | |
| 1577 | |
| 1578 if ($folder['id'] == $mbox_name) { | |
| 1579 $classes[] = 'selected'; | |
| 1580 } | |
| 1581 | |
| 1582 if ($folder['virtual']) { | |
| 1583 $classes[] = 'virtual'; | |
| 1584 } | |
| 1585 else if ($unread) { | |
| 1586 $classes[] = 'unread'; | |
| 1587 } | |
| 1588 | |
| 1589 $js_name = $this->JQ($folder['id']); | |
| 1590 $html_name = $this->Q($foldername) . ($unread ? html::span('unreadcount', sprintf($attrib['unreadwrap'], $unread)) : ''); | |
| 1591 $link_attrib = $folder['virtual'] ? array() : array( | |
| 1592 'href' => $this->url(array('_mbox' => $folder['id'])), | |
| 1593 'onclick' => sprintf("return %s.command('list','%s',this,event)", rcmail_output::JS_OBJECT_NAME, $js_name), | |
| 1594 'rel' => $folder['id'], | |
| 1595 'title' => $title, | |
| 1596 ); | |
| 1597 | |
| 1598 $out .= html::tag('li', array( | |
| 1599 'id' => "rcmli" . $folder_id, | |
| 1600 'class' => join(' ', $classes), | |
| 1601 'noclose' => true | |
| 1602 ), | |
| 1603 html::a($link_attrib, $html_name)); | |
| 1604 | |
| 1605 if (!empty($folder['folders'])) { | |
| 1606 $out .= html::div('treetoggle ' . ($is_collapsed ? 'collapsed' : 'expanded'), ' '); | |
| 1607 } | |
| 1608 | |
| 1609 $jslist[$folder['id']] = array( | |
| 1610 'id' => $folder['id'], | |
| 1611 'name' => $foldername, | |
| 1612 'virtual' => $folder['virtual'], | |
| 1613 ); | |
| 1614 | |
| 1615 if (!empty($folder_class)) { | |
| 1616 $jslist[$folder['id']]['class'] = $folder_class; | |
| 1617 } | |
| 1618 | |
| 1619 if (!empty($folder['folders'])) { | |
| 1620 $out .= html::tag('ul', array('style' => ($is_collapsed ? "display:none;" : null)), | |
| 1621 $this->render_folder_tree_html($folder['folders'], $mbox_name, $jslist, $attrib, $nestLevel+1)); | |
| 1622 } | |
| 1623 | |
| 1624 $out .= "</li>\n"; | |
| 1625 } | |
| 1626 | |
| 1627 return $out; | |
| 1628 } | |
| 1629 | |
| 1630 /** | |
| 1631 * Return html for a flat list <select> for the mailbox tree | |
| 1632 */ | |
| 1633 public function render_folder_tree_select(&$arrFolders, &$mbox_name, $maxlength, &$select, $realnames = false, $nestLevel = 0, $opts = array()) | |
| 1634 { | |
| 1635 $out = ''; | |
| 1636 | |
| 1637 foreach ($arrFolders as $folder) { | |
| 1638 // skip exceptions (and its subfolders) | |
| 1639 if (!empty($opts['exceptions']) && in_array($folder['id'], $opts['exceptions'])) { | |
| 1640 continue; | |
| 1641 } | |
| 1642 | |
| 1643 // skip folders in which it isn't possible to create subfolders | |
| 1644 if (!empty($opts['skip_noinferiors'])) { | |
| 1645 $attrs = $this->storage->folder_attributes($folder['id']); | |
| 1646 if ($attrs && in_array_nocase('\\Noinferiors', $attrs)) { | |
| 1647 continue; | |
| 1648 } | |
| 1649 } | |
| 1650 | |
| 1651 if (!$realnames && ($folder_class = $this->folder_classname($folder['id']))) { | |
| 1652 $foldername = $this->gettext($folder_class); | |
| 1653 } | |
| 1654 else { | |
| 1655 $foldername = $folder['name']; | |
| 1656 | |
| 1657 // shorten the folder name to a given length | |
| 1658 if ($maxlength && $maxlength > 1) { | |
| 1659 $foldername = abbreviate_string($foldername, $maxlength); | |
| 1660 } | |
| 1661 } | |
| 1662 | |
| 1663 $select->add(str_repeat(' ', $nestLevel*4) . html::quote($foldername), $folder['id']); | |
| 1664 | |
| 1665 if (!empty($folder['folders'])) { | |
| 1666 $out .= $this->render_folder_tree_select($folder['folders'], $mbox_name, $maxlength, | |
| 1667 $select, $realnames, $nestLevel+1, $opts); | |
| 1668 } | |
| 1669 } | |
| 1670 | |
| 1671 return $out; | |
| 1672 } | |
| 1673 | |
| 1674 /** | |
| 1675 * Return internal name for the given folder if it matches the configured special folders | |
| 1676 */ | |
| 1677 public function folder_classname($folder_id) | |
| 1678 { | |
| 1679 if ($folder_id == 'INBOX') { | |
| 1680 return 'inbox'; | |
| 1681 } | |
| 1682 | |
| 1683 // for these mailboxes we have localized labels and css classes | |
| 1684 foreach (array('sent', 'drafts', 'trash', 'junk') as $smbx) | |
| 1685 { | |
| 1686 if ($folder_id === $this->config->get($smbx.'_mbox')) { | |
| 1687 return $smbx; | |
| 1688 } | |
| 1689 } | |
| 1690 } | |
| 1691 | |
| 1692 /** | |
| 1693 * Try to localize the given IMAP folder name. | |
| 1694 * UTF-7 decode it in case no localized text was found | |
| 1695 * | |
| 1696 * @param string $name Folder name | |
| 1697 * @param bool $with_path Enable path localization | |
| 1698 * @param bool $path_remove Remove the path | |
| 1699 * | |
| 1700 * @return string Localized folder name in UTF-8 encoding | |
| 1701 */ | |
| 1702 public function localize_foldername($name, $with_path = false, $path_remove = false) | |
| 1703 { | |
| 1704 $realnames = $this->config->get('show_real_foldernames'); | |
| 1705 | |
| 1706 if (!$realnames && ($folder_class = $this->folder_classname($name))) { | |
| 1707 return $this->gettext($folder_class); | |
| 1708 } | |
| 1709 | |
| 1710 $storage = $this->get_storage(); | |
| 1711 $delimiter = $storage->get_hierarchy_delimiter(); | |
| 1712 | |
| 1713 // Remove the path | |
| 1714 if ($path_remove) { | |
| 1715 if (strpos($name, $delimiter)) { | |
| 1716 $path = explode($delimiter, $name); | |
| 1717 $name = array_pop($path); | |
| 1718 } | |
| 1719 } | |
| 1720 // try to localize path of the folder | |
| 1721 else if ($with_path && !$realnames) { | |
| 1722 $path = explode($delimiter, $name); | |
| 1723 $count = count($path); | |
| 1724 | |
| 1725 if ($count > 1) { | |
| 1726 for ($i = 1; $i < $count; $i++) { | |
| 1727 $folder = implode($delimiter, array_slice($path, 0, -$i)); | |
| 1728 if ($folder_class = $this->folder_classname($folder)) { | |
| 1729 $name = implode($delimiter, array_slice($path, $count - $i)); | |
| 1730 $name = rcube_charset::convert($name, 'UTF7-IMAP'); | |
| 1731 | |
| 1732 return $this->gettext($folder_class) . $delimiter . $name; | |
| 1733 } | |
| 1734 } | |
| 1735 } | |
| 1736 } | |
| 1737 | |
| 1738 return rcube_charset::convert($name, 'UTF7-IMAP'); | |
| 1739 } | |
| 1740 | |
| 1741 /** | |
| 1742 * Localize folder path | |
| 1743 */ | |
| 1744 public function localize_folderpath($path) | |
| 1745 { | |
| 1746 $protect_folders = $this->config->get('protect_default_folders'); | |
| 1747 $delimiter = $this->storage->get_hierarchy_delimiter(); | |
| 1748 $path = explode($delimiter, $path); | |
| 1749 $result = array(); | |
| 1750 | |
| 1751 foreach ($path as $idx => $dir) { | |
| 1752 $directory = implode($delimiter, array_slice($path, 0, $idx+1)); | |
| 1753 if ($protect_folders && $this->storage->is_special_folder($directory)) { | |
| 1754 unset($result); | |
| 1755 $result[] = $this->localize_foldername($directory); | |
| 1756 } | |
| 1757 else { | |
| 1758 $result[] = rcube_charset::convert($dir, 'UTF7-IMAP'); | |
| 1759 } | |
| 1760 } | |
| 1761 | |
| 1762 return implode($delimiter, $result); | |
| 1763 } | |
| 1764 | |
| 1765 /** | |
| 1766 * Return HTML for quota indicator object | |
| 1767 * | |
| 1768 * @param array $attrib Named parameters | |
| 1769 * | |
| 1770 * @return string HTML code for the quota indicator object | |
| 1771 */ | |
| 1772 public static function quota_display($attrib) | |
| 1773 { | |
| 1774 $rcmail = rcmail::get_instance(); | |
| 1775 | |
| 1776 if (!$attrib['id']) { | |
| 1777 $attrib['id'] = 'rcmquotadisplay'; | |
| 1778 } | |
| 1779 | |
| 1780 $_SESSION['quota_display'] = !empty($attrib['display']) ? $attrib['display'] : 'text'; | |
| 1781 | |
| 1782 $rcmail->output->add_gui_object('quotadisplay', $attrib['id']); | |
| 1783 | |
| 1784 $quota = $rcmail->quota_content($attrib); | |
| 1785 | |
| 1786 $rcmail->output->add_script('rcmail.set_quota('.rcube_output::json_serialize($quota).');', 'docready'); | |
| 1787 | |
| 1788 return html::span($attrib, ' '); | |
| 1789 } | |
| 1790 | |
| 1791 /** | |
| 1792 * Return (parsed) quota information | |
| 1793 * | |
| 1794 * @param array $attrib Named parameters | |
| 1795 * @param array $folder Current folder | |
| 1796 * | |
| 1797 * @return array Quota information | |
| 1798 */ | |
| 1799 public function quota_content($attrib = null, $folder = null) | |
| 1800 { | |
| 1801 $quota = $this->storage->get_quota($folder); | |
| 1802 $quota = $this->plugins->exec_hook('quota', $quota); | |
| 1803 | |
| 1804 $quota_result = (array) $quota; | |
| 1805 $quota_result['type'] = isset($_SESSION['quota_display']) ? $_SESSION['quota_display'] : ''; | |
| 1806 $quota_result['folder'] = $folder !== null && $folder !== '' ? $folder : 'INBOX'; | |
| 1807 | |
| 19 | 1808 if (($quota['total']??0) > 0) { |
| 0 | 1809 if (!isset($quota['percent'])) { |
| 1810 $quota_result['percent'] = min(100, round(($quota['used']/max(1,$quota['total']))*100)); | |
| 1811 } | |
| 1812 | |
| 1813 $title = sprintf('%s / %s (%.0f%%)', | |
| 1814 $this->show_bytes($quota['used'] * 1024), | |
| 1815 $this->show_bytes($quota['total'] * 1024), | |
| 1816 $quota_result['percent'] | |
| 1817 ); | |
| 1818 | |
| 1819 $quota_result['title'] = $title; | |
| 1820 | |
| 1821 if ($attrib['width']) { | |
| 1822 $quota_result['width'] = $attrib['width']; | |
| 1823 } | |
| 1824 if ($attrib['height']) { | |
| 1825 $quota_result['height'] = $attrib['height']; | |
| 1826 } | |
| 1827 | |
| 1828 // build a table of quota types/roots info | |
| 1829 if (($root_cnt = count($quota_result['all'])) > 1 || count($quota_result['all'][key($quota_result['all'])]) > 1) { | |
| 1830 $table = new html_table(array('cols' => 3, 'class' => 'quota-info')); | |
| 1831 | |
| 1832 $table->add_header(null, self::Q($this->gettext('quotatype'))); | |
| 1833 $table->add_header(null, self::Q($this->gettext('quotatotal'))); | |
| 1834 $table->add_header(null, self::Q($this->gettext('quotaused'))); | |
| 1835 | |
| 1836 foreach ($quota_result['all'] as $root => $data) { | |
| 1837 if ($root_cnt > 1 && $root) { | |
| 1838 $table->add(array('colspan' => 3, 'class' => 'root'), self::Q($root)); | |
| 1839 } | |
| 1840 | |
| 1841 if ($storage = $data['storage']) { | |
| 1842 $percent = min(100, round(($storage['used']/max(1,$storage['total']))*100)); | |
| 1843 | |
| 1844 $table->add('name', self::Q($this->gettext('quotastorage'))); | |
| 1845 $table->add(null, $this->show_bytes($storage['total'] * 1024)); | |
| 1846 $table->add(null, sprintf('%s (%.0f%%)', $this->show_bytes($storage['used'] * 1024), $percent)); | |
| 1847 } | |
| 1848 if ($message = $data['message']) { | |
| 1849 $percent = min(100, round(($message['used']/max(1,$message['total']))*100)); | |
| 1850 | |
| 1851 $table->add('name', self::Q($this->gettext('quotamessage'))); | |
| 1852 $table->add(null, intval($message['total'])); | |
| 1853 $table->add(null, sprintf('%d (%.0f%%)', $message['used'], $percent)); | |
| 1854 } | |
| 1855 } | |
| 1856 | |
| 1857 $quota_result['table'] = $table->show(); | |
| 1858 } | |
| 1859 } | |
| 1860 else { | |
| 1861 $unlimited = $this->config->get('quota_zero_as_unlimited'); | |
| 1862 $quota_result['title'] = $this->gettext($unlimited ? 'unlimited' : 'unknown'); | |
| 1863 $quota_result['percent'] = 0; | |
| 1864 } | |
| 1865 | |
| 1866 // cleanup | |
| 1867 unset($quota_result['abort']); | |
| 1868 if (empty($quota_result['table'])) { | |
| 1869 unset($quota_result['all']); | |
| 1870 } | |
| 1871 | |
| 1872 return $quota_result; | |
| 1873 } | |
| 1874 | |
| 1875 /** | |
| 1876 * Outputs error message according to server error/response codes | |
| 1877 * | |
| 1878 * @param string $fallback Fallback message label | |
| 1879 * @param array $fallback_args Fallback message label arguments | |
| 1880 * @param string $suffix Message label suffix | |
| 1881 * @param array $params Additional parameters (type, prefix) | |
| 1882 */ | |
| 1883 public function display_server_error($fallback = null, $fallback_args = null, $suffix = '', $params = array()) | |
| 1884 { | |
| 1885 $err_code = $this->storage->get_error_code(); | |
| 1886 $res_code = $this->storage->get_response_code(); | |
| 1887 $args = array(); | |
| 1888 | |
| 1889 if ($res_code == rcube_storage::NOPERM) { | |
| 1890 $error = 'errornoperm'; | |
| 1891 } | |
| 1892 else if ($res_code == rcube_storage::READONLY) { | |
| 1893 $error = 'errorreadonly'; | |
| 1894 } | |
| 1895 else if ($res_code == rcube_storage::OVERQUOTA) { | |
| 1896 $error = 'erroroverquota'; | |
| 1897 } | |
| 1898 else if ($err_code && ($err_str = $this->storage->get_error_str())) { | |
| 1899 // try to detect access rights problem and display appropriate message | |
| 1900 if (stripos($err_str, 'Permission denied') !== false) { | |
| 1901 $error = 'errornoperm'; | |
| 1902 } | |
| 1903 // try to detect full mailbox problem and display appropriate message | |
| 1904 // there can be e.g. "Quota exceeded" / "quotum would exceed" / "Over quota" | |
| 1905 else if (stripos($err_str, 'quot') !== false && preg_match('/exceed|over/i', $err_str)) { | |
| 1906 $error = 'erroroverquota'; | |
| 1907 } | |
| 1908 else { | |
| 1909 $error = 'servererrormsg'; | |
| 1910 $args = array('msg' => rcube::Q($err_str)); | |
| 1911 } | |
| 1912 } | |
| 1913 else if ($err_code < 0) { | |
| 1914 $error = 'storageerror'; | |
| 1915 } | |
| 1916 else if ($fallback) { | |
| 1917 $error = $fallback; | |
| 1918 $args = $fallback_args; | |
| 1919 $params['prefix'] = false; | |
| 1920 } | |
| 1921 | |
| 1922 if ($error) { | |
| 1923 if ($suffix && $this->text_exists($error . $suffix)) { | |
| 1924 $error .= $suffix; | |
| 1925 } | |
| 1926 | |
| 1927 $msg = $this->gettext(array('name' => $error, 'vars' => $args)); | |
| 1928 | |
| 1929 if ($params['prefix'] && $fallback) { | |
| 1930 $msg = $this->gettext(array('name' => $fallback, 'vars' => $fallback_args)) . ' ' . $msg; | |
| 1931 } | |
| 1932 | |
| 1933 $this->output->show_message($msg, $params['type'] ?: 'error'); | |
| 1934 } | |
| 1935 } | |
| 1936 | |
| 1937 /** | |
| 1938 * Output HTML editor scripts | |
| 1939 * | |
| 1940 * @param string $mode Editor mode | |
| 1941 */ | |
| 1942 public function html_editor($mode = '') | |
| 1943 { | |
| 1944 $spellcheck = intval($this->config->get('enable_spellcheck')); | |
| 1945 $spelldict = intval($this->config->get('spellcheck_dictionary')); | |
| 1946 $disabled_plugins = array(); | |
| 1947 $disabled_buttons = array(); | |
| 1948 $extra_plugins = array(); | |
| 1949 $extra_buttons = array(); | |
| 1950 | |
| 1951 if (!$spellcheck) { | |
| 1952 $disabled_plugins[] = 'spellchecker'; | |
| 1953 } | |
| 1954 | |
| 1955 $hook = $this->plugins->exec_hook('html_editor', array( | |
| 1956 'mode' => $mode, | |
| 1957 'disabled_plugins' => $disabled_plugins, | |
| 1958 'disabled_buttons' => $disabled_buttons, | |
| 1959 'extra_plugins' => $extra_plugins, | |
| 1960 'extra_buttons' => $extra_buttons, | |
| 1961 )); | |
| 1962 | |
| 1963 if ($hook['abort']) { | |
| 1964 return; | |
| 1965 } | |
| 1966 | |
| 1967 $lang_codes = array($_SESSION['language']); | |
| 1968 $assets_dir = $this->config->get('assets_dir') ?: INSTALL_PATH; | |
| 1969 | |
| 1970 if ($pos = strpos($_SESSION['language'], '_')) { | |
| 1971 $lang_codes[] = substr($_SESSION['language'], 0, $pos); | |
| 1972 } | |
| 1973 | |
| 1974 foreach ($lang_codes as $code) { | |
| 1975 if (file_exists("$assets_dir/program/js/tinymce/langs/$code.js")) { | |
| 1976 $lang = $code; | |
| 1977 break; | |
| 1978 } | |
| 1979 } | |
| 1980 | |
| 1981 if (empty($lang)) { | |
| 1982 $lang = 'en'; | |
| 1983 } | |
| 1984 | |
| 1985 $config = array( | |
| 1986 'mode' => $mode, | |
| 1987 'lang' => $lang, | |
| 1988 'skin_path' => $this->output->get_skin_path(), | |
| 1989 'spellcheck' => $spellcheck, // deprecated | |
| 1990 'spelldict' => $spelldict, | |
| 1991 'disabled_plugins' => $hook['disabled_plugins'], | |
| 1992 'disabled_buttons' => $hook['disabled_buttons'], | |
| 1993 'extra_plugins' => $hook['extra_plugins'], | |
| 1994 'extra_buttons' => $hook['extra_buttons'], | |
| 1995 ); | |
| 1996 | |
| 1997 $this->output->add_label('selectimage', 'addimage', 'selectmedia', 'addmedia'); | |
| 1998 $this->output->set_env('editor_config', $config); | |
| 1999 $this->output->include_css('program/resources/tinymce/browser.css'); | |
| 2000 $this->output->include_script('tinymce/tinymce.min.js'); | |
| 2001 $this->output->include_script('editor.js'); | |
| 2002 } | |
| 2003 | |
| 2004 /** | |
| 2005 * File upload progress handler. | |
| 2006 */ | |
| 2007 public function upload_progress() | |
| 2008 { | |
| 2009 $params = array( | |
| 2010 'action' => $this->action, | |
| 2011 'name' => rcube_utils::get_input_value('_progress', rcube_utils::INPUT_GET), | |
| 2012 ); | |
| 2013 | |
| 2014 if (function_exists('uploadprogress_get_info')) { | |
| 2015 $status = uploadprogress_get_info($params['name']); | |
| 2016 | |
| 2017 if (!empty($status)) { | |
| 2018 $params['current'] = $status['bytes_uploaded']; | |
| 2019 $params['total'] = $status['bytes_total']; | |
| 2020 } | |
| 2021 } | |
| 2022 | |
| 2023 if (!isset($status) && filter_var(ini_get('apc.rfc1867'), FILTER_VALIDATE_BOOLEAN) | |
| 2024 && ini_get('apc.rfc1867_name') | |
| 2025 ) { | |
| 2026 $prefix = ini_get('apc.rfc1867_prefix'); | |
| 2027 $status = apc_fetch($prefix . $params['name']); | |
| 2028 | |
| 2029 if (!empty($status)) { | |
| 2030 $params['current'] = $status['current']; | |
| 2031 $params['total'] = $status['total']; | |
| 2032 } | |
| 2033 } | |
| 2034 | |
| 2035 if (!isset($status) && filter_var(ini_get('session.upload_progress.enabled'), FILTER_VALIDATE_BOOLEAN) | |
| 2036 && ini_get('session.upload_progress.name') | |
| 2037 ) { | |
| 2038 $key = ini_get('session.upload_progress.prefix') . $params['name']; | |
| 2039 | |
| 2040 $params['total'] = $_SESSION[$key]['content_length']; | |
| 2041 $params['current'] = $_SESSION[$key]['bytes_processed']; | |
| 2042 } | |
| 2043 | |
| 2044 if (!empty($params['total'])) { | |
| 2045 $total = $this->show_bytes($params['total'], $unit); | |
| 2046 switch ($unit) { | |
| 2047 case 'GB': | |
| 2048 $gb = $params['current']/1073741824; | |
| 2049 $current = sprintf($gb >= 10 ? "%d" : "%.1f", $gb); | |
| 2050 break; | |
| 2051 case 'MB': | |
| 2052 $mb = $params['current']/1048576; | |
| 2053 $current = sprintf($mb >= 10 ? "%d" : "%.1f", $mb); | |
| 2054 break; | |
| 2055 case 'KB': | |
| 2056 $current = round($params['current']/1024); | |
| 2057 break; | |
| 2058 case 'B': | |
| 2059 default: | |
| 2060 $current = $params['current']; | |
| 2061 break; | |
| 2062 } | |
| 2063 | |
| 2064 $params['percent'] = round($params['current']/$params['total']*100); | |
| 2065 $params['text'] = $this->gettext(array( | |
| 2066 'name' => 'uploadprogress', | |
| 2067 'vars' => array( | |
| 2068 'percent' => $params['percent'] . '%', | |
| 2069 'current' => $current, | |
| 2070 'total' => $total | |
| 2071 ) | |
| 2072 )); | |
| 2073 } | |
| 2074 | |
| 2075 $this->output->command('upload_progress_update', $params); | |
| 2076 $this->output->send(); | |
| 2077 } | |
| 2078 | |
| 2079 /** | |
| 2080 * Initializes file uploading interface. | |
| 2081 * | |
| 2082 * @param int $max_size Optional maximum file size in bytes | |
| 2083 * | |
| 2084 * @return string Human-readable file size limit | |
| 2085 */ | |
| 2086 public function upload_init($max_size = null) | |
| 2087 { | |
| 2088 // Enable upload progress bar | |
| 2089 if ($seconds = $this->config->get('upload_progress')) { | |
| 2090 if (function_exists('uploadprogress_get_info')) { | |
| 2091 $field_name = 'UPLOAD_IDENTIFIER'; | |
| 2092 } | |
| 2093 if (!$field_name && filter_var(ini_get('apc.rfc1867'), FILTER_VALIDATE_BOOLEAN)) { | |
| 2094 $field_name = ini_get('apc.rfc1867_name'); | |
| 2095 } | |
| 2096 if (!$field_name && filter_var(ini_get('session.upload_progress.enabled'), FILTER_VALIDATE_BOOLEAN)) { | |
| 2097 $field_name = ini_get('session.upload_progress.name'); | |
| 2098 } | |
| 2099 | |
| 2100 if ($field_name) { | |
| 2101 $this->output->set_env('upload_progress_name', $field_name); | |
| 2102 $this->output->set_env('upload_progress_time', (int) $seconds); | |
| 2103 } | |
| 2104 } | |
| 2105 | |
| 2106 // find max filesize value | |
| 2107 $max_filesize = rcube_utils::max_upload_size(); | |
| 2108 if ($max_size && $max_size < $max_filesize) { | |
| 2109 $max_filesize = $max_size; | |
| 2110 } | |
| 2111 | |
| 2112 $max_filesize_txt = $this->show_bytes($max_filesize); | |
| 2113 $this->output->set_env('max_filesize', $max_filesize); | |
| 2114 $this->output->set_env('filesizeerror', $this->gettext(array( | |
| 2115 'name' => 'filesizeerror', 'vars' => array('size' => $max_filesize_txt)))); | |
| 2116 | |
| 2117 if ($max_filecount = ini_get('max_file_uploads')) { | |
| 2118 $this->output->set_env('max_filecount', $max_filecount); | |
| 2119 $this->output->set_env('filecounterror', $this->gettext(array( | |
| 2120 'name' => 'filecounterror', 'vars' => array('count' => $max_filecount)))); | |
| 2121 } | |
| 2122 | |
| 2123 return $max_filesize_txt; | |
| 2124 } | |
| 2125 | |
| 2126 /** | |
| 2127 * Upload form object | |
| 2128 * | |
| 2129 * @param array $attrib Object attributes | |
| 2130 * @param string $name Form object name | |
| 2131 * @param string $action Form action name | |
| 2132 * @param array $input_attr File input attributes | |
| 2133 * | |
| 2134 * @return string HTML output | |
| 2135 */ | |
| 2136 public function upload_form($attrib, $name, $action, $input_attr = array()) | |
| 2137 { | |
| 2138 // Get filesize, enable upload progress bar | |
| 2139 $max_filesize = $this->upload_init(); | |
| 2140 | |
| 2141 $hint = html::div('hint', $this->gettext(array('name' => 'maxuploadsize', 'vars' => array('size' => $max_filesize)))); | |
| 2142 | |
| 2143 if ($attrib['mode'] == 'hint') { | |
| 2144 return $hint; | |
| 2145 } | |
| 2146 | |
| 2147 // set defaults | |
| 2148 $attrib += array('id' => 'rcmUploadbox', 'buttons' => 'yes'); | |
| 2149 | |
| 2150 $event = rcmail_output::JS_OBJECT_NAME . ".command('$action', this.form)"; | |
| 2151 $form_id = $attrib['id'] . 'Frm'; | |
| 2152 | |
| 2153 // Default attributes of file input and form | |
| 2154 $input_attr += array( | |
| 2155 'id' => $attrib['id'] . 'Input', | |
| 2156 'type' => 'file', | |
| 2157 'name' => '_attachments[]', | |
| 2158 ); | |
| 2159 | |
| 2160 $form_attr = array( | |
| 2161 'id' => $form_id, | |
| 2162 'name' => $name, | |
| 2163 'method' => 'post', | |
| 2164 'enctype' => 'multipart/form-data' | |
| 2165 ); | |
| 2166 | |
| 2167 if ($attrib['mode'] == 'smart') { | |
| 2168 unset($attrib['buttons']); | |
| 2169 $form_attr['class'] = 'smart-upload'; | |
| 2170 $input_attr = array_merge($input_attr, array( | |
| 2171 // #5854: Chrome does not execute onchange when selecting the same file. | |
| 2172 // To fix this we reset the input using null value. | |
| 2173 'onchange' => "$event; this.value=null", | |
| 2174 'class' => 'smart-upload', | |
| 2175 'tabindex' => '-1', | |
| 2176 )); | |
| 2177 } | |
| 2178 | |
| 2179 $input = new html_inputfield($input_attr); | |
| 2180 $content = $attrib['prefix'] . $input->show(); | |
| 2181 | |
| 2182 if ($attrib['mode'] != 'smart') { | |
| 2183 $content = html::div(null, $content); | |
| 2184 $content .= $hint; | |
| 2185 } | |
| 2186 | |
| 2187 if (rcube_utils::get_boolean($attrib['buttons'])) { | |
| 2188 $button = new html_inputfield(array('type' => 'button')); | |
| 2189 $content .= html::div('buttons', | |
| 2190 $button->show($this->gettext('close'), array('class' => 'button', 'onclick' => "$('#{$attrib['id']}').hide()")) . ' ' . | |
| 2191 $button->show($this->gettext('upload'), array('class' => 'button mainaction', 'onclick' => $event)) | |
| 2192 ); | |
| 2193 } | |
| 2194 | |
| 2195 $this->output->add_gui_object($name, $form_id); | |
| 2196 | |
| 2197 return html::div($attrib, $this->output->form_tag($form_attr, $content)); | |
| 2198 } | |
| 2199 | |
| 2200 /** | |
| 2201 * Outputs uploaded file content (with image thumbnails support | |
| 2202 * | |
| 2203 * @param array $file Upload file data | |
| 2204 */ | |
| 2205 public function display_uploaded_file($file) | |
| 2206 { | |
| 2207 if (empty($file)) { | |
| 2208 return; | |
| 2209 } | |
| 2210 | |
| 2211 $file = $this->plugins->exec_hook('attachment_display', $file); | |
| 2212 | |
| 2213 if ($file['status']) { | |
| 2214 if (empty($file['size'])) { | |
| 2215 $file['size'] = $file['data'] ? strlen($file['data']) : @filesize($file['path']); | |
| 2216 } | |
| 2217 | |
| 2218 // generate image thumbnail for file browser in HTML editor | |
| 2219 if (!empty($_GET['_thumbnail'])) { | |
| 2220 $temp_dir = $this->config->get('temp_dir'); | |
| 2221 $thumbnail_size = 80; | |
| 2222 $mimetype = $file['mimetype']; | |
| 2223 $file_ident = $file['id'] . ':' . $file['mimetype'] . ':' . $file['size']; | |
| 2224 $cache_basename = $temp_dir . '/' . md5($file_ident . ':' . $this->user->ID . ':' . $thumbnail_size); | |
| 2225 $cache_file = $cache_basename . '.thumb'; | |
| 2226 | |
| 2227 // render thumbnail image if not done yet | |
| 2228 if (!is_file($cache_file)) { | |
| 2229 if (!$file['path']) { | |
| 2230 $orig_name = $filename = $cache_basename . '.tmp'; | |
| 2231 file_put_contents($orig_name, $file['data']); | |
| 2232 } | |
| 2233 else { | |
| 2234 $filename = $file['path']; | |
| 2235 } | |
| 2236 | |
| 2237 $image = new rcube_image($filename); | |
| 2238 if ($imgtype = $image->resize($thumbnail_size, $cache_file, true)) { | |
| 2239 $mimetype = 'image/' . $imgtype; | |
| 2240 | |
| 2241 if ($orig_name) { | |
| 2242 unlink($orig_name); | |
| 2243 } | |
| 2244 } | |
| 2245 } | |
| 2246 | |
| 2247 if (is_file($cache_file)) { | |
| 2248 // cache for 1h | |
| 2249 $this->output->future_expire_header(3600); | |
| 2250 header('Content-Type: ' . $mimetype); | |
| 2251 header('Content-Length: ' . filesize($cache_file)); | |
| 2252 | |
| 2253 readfile($cache_file); | |
| 2254 exit; | |
| 2255 } | |
| 2256 } | |
| 2257 | |
| 2258 header('Content-Type: ' . $file['mimetype']); | |
| 2259 header('Content-Length: ' . $file['size']); | |
| 2260 | |
| 2261 if ($file['data']) { | |
| 2262 echo $file['data']; | |
| 2263 } | |
| 2264 else if ($file['path']) { | |
| 2265 readfile($file['path']); | |
| 2266 } | |
| 2267 } | |
| 2268 } | |
| 2269 | |
| 2270 /** | |
| 2271 * Initializes client-side autocompletion. | |
| 2272 */ | |
| 2273 public function autocomplete_init() | |
| 2274 { | |
| 2275 static $init; | |
| 2276 | |
| 2277 if ($init) { | |
| 2278 return; | |
| 2279 } | |
| 2280 | |
| 2281 $init = 1; | |
| 2282 | |
| 2283 if (($threads = (int)$this->config->get('autocomplete_threads')) > 0) { | |
| 2284 $book_types = (array) $this->config->get('autocomplete_addressbooks', 'sql'); | |
| 2285 if (count($book_types) > 1) { | |
| 2286 $this->output->set_env('autocomplete_threads', $threads); | |
| 2287 $this->output->set_env('autocomplete_sources', $book_types); | |
| 2288 } | |
| 2289 } | |
| 2290 | |
| 2291 $this->output->set_env('autocomplete_max', (int)$this->config->get('autocomplete_max', 15)); | |
| 2292 $this->output->set_env('autocomplete_min_length', $this->config->get('autocomplete_min_length')); | |
| 2293 $this->output->add_label('autocompletechars', 'autocompletemore'); | |
| 2294 } | |
| 2295 | |
| 2296 /** | |
| 2297 * Returns supported font-family specifications | |
| 2298 * | |
| 2299 * @param string $font Font name | |
| 2300 * | |
| 2301 * @param string|array Font-family specification array or string (if $font is used) | |
| 2302 */ | |
| 2303 public static function font_defs($font = null) | |
| 2304 { | |
| 2305 $fonts = array( | |
| 2306 'Andale Mono' => '"Andale Mono",Times,monospace', | |
| 2307 'Arial' => 'Arial,Helvetica,sans-serif', | |
| 2308 'Arial Black' => '"Arial Black","Avant Garde",sans-serif', | |
| 2309 'Book Antiqua' => '"Book Antiqua",Palatino,serif', | |
| 2310 'Courier New' => '"Courier New",Courier,monospace', | |
| 2311 'Georgia' => 'Georgia,Palatino,serif', | |
| 2312 'Helvetica' => 'Helvetica,Arial,sans-serif', | |
| 2313 'Impact' => 'Impact,Chicago,sans-serif', | |
| 2314 'Tahoma' => 'Tahoma,Arial,Helvetica,sans-serif', | |
| 2315 'Terminal' => 'Terminal,Monaco,monospace', | |
| 2316 'Times New Roman' => '"Times New Roman",Times,serif', | |
| 2317 'Trebuchet MS' => '"Trebuchet MS",Geneva,sans-serif', | |
| 2318 'Verdana' => 'Verdana,Geneva,sans-serif', | |
| 2319 ); | |
| 2320 | |
| 2321 if ($font) { | |
| 2322 return $fonts[$font]; | |
| 2323 } | |
| 2324 | |
| 2325 return $fonts; | |
| 2326 } | |
| 2327 | |
| 2328 /** | |
| 2329 * Create a human readable string for a number of bytes | |
| 2330 * | |
| 2331 * @param int $bytes Number of bytes | |
| 2332 * @param string &$unit Size unit | |
| 2333 * | |
| 2334 * @return string Byte string | |
| 2335 */ | |
| 2336 public function show_bytes($bytes, &$unit = null) | |
| 2337 { | |
| 2338 if ($bytes >= 1073741824) { | |
| 2339 $unit = 'GB'; | |
| 2340 $gb = $bytes/1073741824; | |
| 2341 $str = sprintf($gb >= 10 ? "%d " : "%.1f ", $gb) . $this->gettext($unit); | |
| 2342 } | |
| 2343 else if ($bytes >= 1048576) { | |
| 2344 $unit = 'MB'; | |
| 2345 $mb = $bytes/1048576; | |
| 2346 $str = sprintf($mb >= 10 ? "%d " : "%.1f ", $mb) . $this->gettext($unit); | |
| 2347 } | |
| 2348 else if ($bytes >= 1024) { | |
| 2349 $unit = 'KB'; | |
| 2350 $str = sprintf("%d ", round($bytes/1024)) . $this->gettext($unit); | |
| 2351 } | |
| 2352 else { | |
| 2353 $unit = 'B'; | |
| 2354 $str = sprintf('%d ', $bytes) . $this->gettext($unit); | |
| 2355 } | |
| 2356 | |
| 2357 return $str; | |
| 2358 } | |
| 2359 | |
| 2360 /** | |
| 2361 * Returns real size (calculated) of the message part | |
| 2362 * | |
| 2363 * @param rcube_message_part $part Message part | |
| 2364 * | |
| 2365 * @return string Part size (and unit) | |
| 2366 */ | |
| 2367 public function message_part_size($part) | |
| 2368 { | |
| 2369 if (isset($part->d_parameters['size'])) { | |
| 2370 $size = $this->show_bytes((int)$part->d_parameters['size']); | |
| 2371 } | |
| 2372 else { | |
| 2373 $size = $part->size; | |
| 2374 | |
| 2375 if ($size === 0) { | |
| 2376 $part->exact_size = true; | |
| 2377 } | |
| 2378 | |
| 2379 if ($part->encoding == 'base64') { | |
| 2380 $size = $size / 1.33; | |
| 2381 } | |
| 2382 | |
| 2383 $size = $this->show_bytes($size); | |
| 2384 } | |
| 2385 | |
| 2386 if (!$part->exact_size) { | |
| 2387 $size = '~' . $size; | |
| 2388 } | |
| 2389 | |
| 2390 return $size; | |
| 2391 } | |
| 2392 | |
| 2393 /** | |
| 2394 * Returns message UID(s) and IMAP folder(s) from GET/POST data | |
| 2395 * | |
| 2396 * @param string $uids UID value to decode | |
| 2397 * @param string $mbox Default mailbox value (if not encoded in UIDs) | |
| 2398 * @param bool $is_multifolder Will be set to True if multi-folder request | |
| 2399 * | |
| 2400 * @return array List of message UIDs per folder | |
| 2401 */ | |
| 2402 public static function get_uids($uids = null, $mbox = null, &$is_multifolder = false) | |
| 2403 { | |
| 2404 // message UID (or comma-separated list of IDs) is provided in | |
| 2405 // the form of <ID>-<MBOX>[,<ID>-<MBOX>]* | |
| 2406 | |
| 2407 $_uid = $uids ?: rcube_utils::get_input_value('_uid', rcube_utils::INPUT_GPC); | |
| 2408 $_mbox = $mbox ?: (string) rcube_utils::get_input_value('_mbox', rcube_utils::INPUT_GPC); | |
| 2409 | |
| 2410 // already a hash array | |
| 2411 if (is_array($_uid) && !isset($_uid[0])) { | |
| 2412 return $_uid; | |
| 2413 } | |
| 2414 | |
| 2415 $result = array(); | |
| 2416 | |
| 2417 // special case: * | |
| 2418 if ($_uid == '*' && is_object($_SESSION['search'][1]) && $_SESSION['search'][1]->multi) { | |
| 2419 $is_multifolder = true; | |
| 2420 // extract the full list of UIDs per folder from the search set | |
| 2421 foreach ($_SESSION['search'][1]->sets as $subset) { | |
| 2422 $mbox = $subset->get_parameters('MAILBOX'); | |
| 2423 $result[$mbox] = $subset->get(); | |
| 2424 } | |
| 2425 } | |
| 2426 else { | |
| 2427 if (is_string($_uid)) | |
| 2428 $_uid = explode(',', $_uid); | |
| 2429 | |
| 2430 // create a per-folder UIDs array | |
| 2431 foreach ((array)$_uid as $uid) { | |
| 2432 list($uid, $mbox) = explode('-', $uid, 2); | |
| 2433 if (!strlen($mbox)) { | |
| 2434 $mbox = $_mbox; | |
| 2435 } | |
| 2436 else { | |
| 2437 $is_multifolder = true; | |
| 2438 } | |
| 2439 | |
| 2440 if ($uid == '*') { | |
| 2441 $result[$mbox] = $uid; | |
| 2442 } | |
| 2443 else { | |
| 2444 $result[$mbox][] = $uid; | |
| 2445 } | |
| 2446 } | |
| 2447 } | |
| 2448 | |
| 2449 return $result; | |
| 2450 } | |
| 2451 | |
| 2452 /** | |
| 2453 * Get resource file content (with assets_dir support) | |
| 2454 * | |
| 2455 * @param string $name File name | |
| 2456 * | |
| 2457 * @return string File content | |
| 2458 */ | |
| 2459 public function get_resource_content($name) | |
| 2460 { | |
| 2461 if (!strpos($name, '/')) { | |
| 2462 $name = "program/resources/$name"; | |
| 2463 } | |
| 2464 | |
| 2465 $assets_dir = $this->config->get('assets_dir'); | |
| 2466 | |
| 2467 if ($assets_dir) { | |
| 2468 $path = slashify($assets_dir) . $name; | |
| 2469 if (@file_exists($path)) { | |
| 2470 $name = $path; | |
| 2471 } | |
| 2472 } | |
| 2473 | |
| 2474 return file_get_contents($name, false); | |
| 2475 } | |
| 2476 | |
| 2477 /** | |
| 2478 * Converts HTML content into plain text | |
| 2479 * | |
| 2480 * @param string $html HTML content | |
| 2481 * @param array $options Conversion parameters (width, links, charset) | |
| 2482 * | |
| 2483 * @return string Plain text | |
| 2484 */ | |
| 2485 public function html2text($html, $options = array()) | |
| 2486 { | |
| 2487 $default_options = array( | |
| 2488 'links' => true, | |
| 2489 'width' => 75, | |
| 2490 'body' => $html, | |
| 2491 'charset' => RCUBE_CHARSET, | |
| 2492 ); | |
| 2493 | |
| 2494 $options = array_merge($default_options, (array) $options); | |
| 2495 | |
| 2496 // Plugins may want to modify HTML in another/additional way | |
| 2497 $options = $this->plugins->exec_hook('html2text', $options); | |
| 2498 | |
| 2499 // Convert to text | |
| 2500 if (!$options['abort']) { | |
| 2501 $converter = new rcube_html2text($options['body'], | |
| 2502 false, $options['links'], $options['width'], $options['charset']); | |
| 2503 | |
| 2504 $options['body'] = rtrim($converter->get_text()); | |
| 2505 } | |
| 2506 | |
| 2507 return $options['body']; | |
| 2508 } | |
| 2509 | |
| 2510 /** | |
| 2511 * Connect to the mail storage server with stored session data | |
| 2512 * | |
| 2513 * @return bool True on success, False on error | |
| 2514 */ | |
| 2515 public function storage_connect() | |
| 2516 { | |
| 2517 $storage = $this->get_storage(); | |
| 2518 | |
| 2519 if ($_SESSION['storage_host'] && !$storage->is_connected()) { | |
| 2520 $host = $_SESSION['storage_host']; | |
| 2521 $user = $_SESSION['username']; | |
| 2522 $port = $_SESSION['storage_port']; | |
| 2523 $ssl = $_SESSION['storage_ssl']; | |
| 2524 $pass = $this->decrypt($_SESSION['password']); | |
| 2525 | |
| 2526 if (!$storage->connect($host, $user, $pass, $port, $ssl)) { | |
| 2527 if (is_object($this->output)) { | |
| 2528 $this->output->show_message('storageerror', 'error'); | |
| 2529 } | |
| 2530 } | |
| 2531 else { | |
| 2532 $this->set_storage_prop(); | |
| 2533 } | |
| 2534 } | |
| 2535 | |
| 2536 return $storage->is_connected(); | |
| 2537 } | |
| 2538 } |