| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * options_display.php |
| 5 | * |
| 6 | * Displays all optinos about display preferences |
| 7 | * |
| 8 | * @copyright © 1999-2007 The SquirrelMail Project Team |
| 9 | * @license http://opensource.org/licenses/gpl-license.php GNU Public License |
| 10 | * @version $Id$ |
| 11 | * @package squirrelmail |
| 12 | */ |
| 13 | |
| 14 | /** Define the group constants for the display options page. */ |
| 15 | define('SMOPT_GRP_GENERAL', 0); |
| 16 | define('SMOPT_GRP_MAILBOX', 1); |
| 17 | define('SMOPT_GRP_MESSAGE', 2); |
| 18 | |
| 19 | global $use_iframe; |
| 20 | if (! isset($use_iframe)) $use_iframe=false; |
| 21 | |
| 22 | /** |
| 23 | * This function builds an array with all the information about |
| 24 | * the options available to the user, and returns it. The options |
| 25 | * are grouped by the groups in which they are displayed. |
| 26 | * For each option, the following information is stored: |
| 27 | * - name: the internal (variable) name |
| 28 | * - caption: the description of the option in the UI |
| 29 | * - type: one of SMOPT_TYPE_* |
| 30 | * - refresh: one of SMOPT_REFRESH_* |
| 31 | * - size: one of SMOPT_SIZE_* |
| 32 | * - save: the name of a function to call when saving this option |
| 33 | * @return array all option information |
| 34 | */ |
| 35 | function load_optpage_data_display() { |
| 36 | global $theme, $fontsets, $language, $languages,$aTemplateSet, |
| 37 | $default_use_mdn, $squirrelmail_language, $allow_thread_sort, |
| 38 | $show_alternative_names, $use_iframe, $use_icons, |
| 39 | $sTemplateID, $oTemplate, |
| 40 | $user_themes, $chosen_theme; |
| 41 | |
| 42 | /* Build a simple array into which we will build options. */ |
| 43 | $optgrps = array(); |
| 44 | $optvals = array(); |
| 45 | |
| 46 | /******************************************************/ |
| 47 | /* LOAD EACH GROUP OF OPTIONS INTO THE OPTIONS ARRAY. */ |
| 48 | /******************************************************/ |
| 49 | |
| 50 | /*** Load the General Options into the array ***/ |
| 51 | $optgrps[SMOPT_GRP_GENERAL] = _("General Display Options"); |
| 52 | $optvals[SMOPT_GRP_GENERAL] = array(); |
| 53 | |
| 54 | /* load the template set option */ |
| 55 | $templateset_values = array(); |
| 56 | |
| 57 | foreach ($aTemplateSet as $sKey => $aTemplateSetAttributes) { |
| 58 | $templateset_values[$aTemplateSetAttributes['NAME']] = $aTemplateSetAttributes['ID']; |
| 59 | } |
| 60 | ksort($templateset_values); |
| 61 | $templateset_values = array_flip($templateset_values); |
| 62 | // display template options only when there is more than one template |
| 63 | if (count($templateset_values)>1) { |
| 64 | $optvals[SMOPT_GRP_GENERAL][] = array( |
| 65 | 'name' => 'sTemplateID', |
| 66 | 'caption' => _("Skin"), |
| 67 | 'type' => SMOPT_TYPE_STRLIST, |
| 68 | 'refresh' => SMOPT_REFRESH_ALL, |
| 69 | 'posvals' => $templateset_values, |
| 70 | 'save' => 'save_option_template' |
| 71 | ); |
| 72 | } |
| 73 | |
| 74 | /* Load the theme option. */ |
| 75 | $theme_values = array(); |
| 76 | |
| 77 | // Always provide the template default first. |
| 78 | $theme_values['none'] = 'Template Default Theme'; |
| 79 | |
| 80 | // List alternate themes provided by templates first |
| 81 | $template_themes = $oTemplate->get_alternative_stylesheets(true); |
| 82 | asort($template_themes); |
| 83 | foreach ($template_themes as $sheet=>$name) { |
| 84 | $theme_values[$sheet] = 'Template Theme - '.htmlspecialchars($name); |
| 85 | } |
| 86 | // Next, list user-provided styles |
| 87 | asort($user_themes); |
| 88 | foreach ($user_themes as $style) { |
| 89 | if ($style['PATH'] == 'none') |
| 90 | continue; |
| 91 | $theme_values[$style['PATH']] = 'User Theme - '.htmlspecialchars($style['NAME']); |
| 92 | } |
| 93 | |
| 94 | if (count($user_themes) + count($template_themes) > 1) { |
| 95 | $optvals[SMOPT_GRP_GENERAL][] = array( |
| 96 | 'name' => 'chosen_theme', |
| 97 | 'caption' => _("Theme"), |
| 98 | 'type' => SMOPT_TYPE_STRLIST, |
| 99 | 'refresh' => SMOPT_REFRESH_ALL, |
| 100 | 'posvals' => $theme_values, |
| 101 | 'save' => 'css_theme_save' |
| 102 | ); |
| 103 | } |
| 104 | |
| 105 | /* Icon theme selection */ |
| 106 | if ($use_icons) { |
| 107 | global $icon_themes, $icon_theme; |
| 108 | |
| 109 | $temp = array(); |
| 110 | $value = 0; |
| 111 | for ($count = 0; $count < sizeof($icon_themes); $count++) { |
| 112 | $temp[$icon_themes[$count]['PATH']] = $icon_themes[$count]['NAME']; |
| 113 | } |
| 114 | if (sizeof($icon_themes) > 0) { |
| 115 | $optvals[SMOPT_GRP_GENERAL][] = array( |
| 116 | 'name' => 'icon_theme', |
| 117 | 'caption' => _("Icon Theme"), |
| 118 | 'type' => SMOPT_TYPE_STRLIST, |
| 119 | 'refresh' => SMOPT_REFRESH_NONE, |
| 120 | 'posvals' => $temp, |
| 121 | 'save' => 'icon_theme_save' |
| 122 | ); |
| 123 | } |
| 124 | } |
| 125 | |
| 126 | $fontset_values = array(); |
| 127 | $fontset_list = array(); |
| 128 | |
| 129 | if (!empty($fontsets) && is_array($fontsets)) { |
| 130 | |
| 131 | foreach (array_keys($fontsets) as $fontset_key) { |
| 132 | $fontset_list[$fontset_key]=$fontset_key; |
| 133 | } |
| 134 | ksort($fontset_list); |
| 135 | } |
| 136 | |
| 137 | if (count($fontset_list) > 1) { |
| 138 | $fontset_list = array_merge(array('' => _("Default font style")), $fontset_list); |
| 139 | $optvals[SMOPT_GRP_GENERAL][] = array( |
| 140 | 'name' => 'chosen_fontset', |
| 141 | 'caption' => _("Font style"), |
| 142 | 'type' => SMOPT_TYPE_STRLIST, |
| 143 | 'refresh' => SMOPT_REFRESH_ALL, |
| 144 | 'posvals' => $fontset_list |
| 145 | ); |
| 146 | } |
| 147 | |
| 148 | $optvals[SMOPT_GRP_GENERAL][] = array( |
| 149 | 'name' => 'chosen_fontsize', |
| 150 | 'caption' => _("Font size"), |
| 151 | 'type' => SMOPT_TYPE_STRLIST, |
| 152 | 'refresh' => SMOPT_REFRESH_ALL, |
| 153 | 'posvals' => array('' => _("Default font size"), |
| 154 | '8' => '8 px', |
| 155 | '10' => '10 px', |
| 156 | '12' => '12 px', |
| 157 | '14' => '14 px') |
| 158 | ); |
| 159 | |
| 160 | $language_values = array(); |
| 161 | foreach ($languages as $lang_key => $lang_attributes) { |
| 162 | if (isset($lang_attributes['NAME'])) { |
| 163 | $language_values[$lang_key] = $lang_attributes['NAME']; |
| 164 | if ( isset($show_alternative_names) && |
| 165 | $show_alternative_names && |
| 166 | isset($lang_attributes['ALTNAME']) ) { |
| 167 | $language_values[$lang_key] .= " / " . $lang_attributes['ALTNAME']; |
| 168 | } |
| 169 | } |
| 170 | } |
| 171 | |
| 172 | asort($language_values); |
| 173 | $language_values = |
| 174 | array_merge(array('' => _("Default")), $language_values); |
| 175 | $language = $squirrelmail_language; |
| 176 | |
| 177 | // add language selection only when more than 2 languages are available |
| 178 | // (default, English and some other) |
| 179 | if (count($language_values)>2) { |
| 180 | $optvals[SMOPT_GRP_GENERAL][] = array( |
| 181 | 'name' => 'language', |
| 182 | 'caption' => _("Language"), |
| 183 | 'type' => SMOPT_TYPE_STRLIST, |
| 184 | 'refresh' => SMOPT_REFRESH_ALL, |
| 185 | 'posvals' => $language_values, |
| 186 | 'htmlencoded' => true |
| 187 | ); |
| 188 | } |
| 189 | |
| 190 | /* Set values for the "use javascript" option. */ |
| 191 | $optvals[SMOPT_GRP_GENERAL][] = array( |
| 192 | 'name' => 'javascript_setting', |
| 193 | 'caption' => _("Use Javascript"), |
| 194 | 'type' => SMOPT_TYPE_STRLIST, |
| 195 | 'refresh' => SMOPT_REFRESH_ALL, |
| 196 | 'posvals' => array(SMPREF_JS_AUTODETECT => _("Autodetect"), |
| 197 | SMPREF_JS_ON => _("Always"), |
| 198 | SMPREF_JS_OFF => _("Never")), |
| 199 | 'save' => 'save_option_javascript_autodetect', |
| 200 | 'extra_attributes' => array('onclick' => 'document.forms[0].new_js_autodetect_results.value = \'' . SMPREF_JS_ON . '\';'), |
| 201 | ); |
| 202 | |
| 203 | $optvals[SMOPT_GRP_GENERAL][] = array( |
| 204 | 'name' => 'js_autodetect_results', |
| 205 | 'caption' => '', |
| 206 | 'type' => SMOPT_TYPE_HIDDEN, |
| 207 | 'refresh' => SMOPT_REFRESH_NONE |
| 208 | //'post_script' => $js_autodetect_script, |
| 209 | ); |
| 210 | |
| 211 | $optvals[SMOPT_GRP_GENERAL][] = array( |
| 212 | 'name' => 'hour_format', |
| 213 | 'caption' => _("Hour Format"), |
| 214 | 'type' => SMOPT_TYPE_STRLIST, |
| 215 | 'refresh' => SMOPT_REFRESH_FOLDERLIST, |
| 216 | 'posvals' => array(SMPREF_TIME_12HR => _("12-hour clock"), |
| 217 | SMPREF_TIME_24HR => _("24-hour clock")) |
| 218 | ); |
| 219 | |
| 220 | /*** Load the General Options into the array ***/ |
| 221 | $optgrps[SMOPT_GRP_MAILBOX] = _("Mailbox Display Options"); |
| 222 | $optvals[SMOPT_GRP_MAILBOX] = array(); |
| 223 | |
| 224 | $optvals[SMOPT_GRP_MAILBOX][] = array( |
| 225 | 'name' => 'show_num', |
| 226 | 'caption' => _("Number of Messages per Page"), |
| 227 | 'type' => SMOPT_TYPE_INTEGER, |
| 228 | 'refresh' => SMOPT_REFRESH_NONE, |
| 229 | 'size' => SMOPT_SIZE_TINY |
| 230 | ); |
| 231 | |
| 232 | $optvals[SMOPT_GRP_MAILBOX][] = array( |
| 233 | 'name' => 'alt_index_colors', |
| 234 | 'caption' => _("Enable Alternating Row Colors"), |
| 235 | 'type' => SMOPT_TYPE_BOOLEAN, |
| 236 | 'refresh' => SMOPT_REFRESH_NONE |
| 237 | ); |
| 238 | |
| 239 | $optvals[SMOPT_GRP_MAILBOX][] = array( |
| 240 | 'name' => 'fancy_index_highlite', |
| 241 | 'caption' => _("Enable Fancy Row Mouseover Highlighting"), |
| 242 | 'type' => SMOPT_TYPE_BOOLEAN, |
| 243 | 'refresh' => SMOPT_REFRESH_NONE |
| 244 | ); |
| 245 | |
| 246 | $optvals[SMOPT_GRP_MAILBOX][] = array( |
| 247 | 'name' => 'show_flag_buttons', |
| 248 | 'caption' => _("Show Flag / Unflag Buttons"), |
| 249 | 'type' => SMOPT_TYPE_BOOLEAN, |
| 250 | 'refresh' => SMOPT_REFRESH_NONE |
| 251 | ); |
| 252 | |
| 253 | $optvals[SMOPT_GRP_MAILBOX][] = array( |
| 254 | 'name' => 'show_copy_buttons', |
| 255 | 'caption' => _("Enable Message Copy Buttons"), |
| 256 | 'type' => SMOPT_TYPE_BOOLEAN, |
| 257 | 'refresh' => SMOPT_REFRESH_NONE |
| 258 | ); |
| 259 | |
| 260 | $optvals[SMOPT_GRP_MAILBOX][] = array( |
| 261 | 'name' => 'page_selector', |
| 262 | 'caption' => _("Enable Page Selector"), |
| 263 | 'type' => SMOPT_TYPE_BOOLEAN, |
| 264 | 'refresh' => SMOPT_REFRESH_NONE |
| 265 | ); |
| 266 | |
| 267 | $optvals[SMOPT_GRP_MAILBOX][] = array( |
| 268 | 'name' => 'compact_paginator', |
| 269 | 'caption' => _("Use Compact Page Selector"), |
| 270 | 'type' => SMOPT_TYPE_BOOLEAN, |
| 271 | 'refresh' => SMOPT_REFRESH_NONE |
| 272 | ); |
| 273 | |
| 274 | $optvals[SMOPT_GRP_MAILBOX][] = array( |
| 275 | 'name' => 'page_selector_max', |
| 276 | 'caption' => _("Maximum Number of Pages to Show"), |
| 277 | 'type' => SMOPT_TYPE_INTEGER, |
| 278 | 'refresh' => SMOPT_REFRESH_NONE, |
| 279 | 'size' => SMOPT_SIZE_TINY |
| 280 | ); |
| 281 | |
| 282 | $optvals[SMOPT_GRP_MAILBOX][] = array( |
| 283 | 'name' => 'show_full_date', |
| 284 | 'caption' => _("Always Show Full Date"), |
| 285 | 'type' => SMOPT_TYPE_BOOLEAN, |
| 286 | 'refresh' => SMOPT_REFRESH_NONE |
| 287 | ); |
| 288 | |
| 289 | $optvals[SMOPT_GRP_MAILBOX][] = array( |
| 290 | 'name' => 'truncate_sender', |
| 291 | 'caption' => _("Length of From/To Field (0 for full)"), |
| 292 | 'type' => SMOPT_TYPE_INTEGER, |
| 293 | 'refresh' => SMOPT_REFRESH_NONE, |
| 294 | 'size' => SMOPT_SIZE_TINY |
| 295 | ); |
| 296 | |
| 297 | $optvals[SMOPT_GRP_MAILBOX][] = array( |
| 298 | 'name' => 'truncate_subject', |
| 299 | 'caption' => _("Length of Subject Field (0 for full)"), |
| 300 | 'type' => SMOPT_TYPE_INTEGER, |
| 301 | 'refresh' => SMOPT_REFRESH_NONE, |
| 302 | 'size' => SMOPT_SIZE_TINY |
| 303 | ); |
| 304 | /* |
| 305 | FIXME! |
| 306 | disabled because the template doesn't support it (yet?) |
| 307 | $optvals[SMOPT_GRP_MAILBOX][] = array( |
| 308 | 'name' => 'show_recipient_instead', |
| 309 | 'caption' => _("Show recipient name if the message is from your default identity"), |
| 310 | 'type' => SMOPT_TYPE_BOOLEAN, |
| 311 | 'refresh' => SMOPT_REFRESH_NONE, |
| 312 | 'size' => SMOPT_SIZE_TINY |
| 313 | ); |
| 314 | */ |
| 315 | |
| 316 | if ($allow_thread_sort == TRUE) { |
| 317 | $optvals[SMOPT_GRP_MAILBOX][] = array( |
| 318 | 'name' => 'sort_by_ref', |
| 319 | 'caption' => _("Enable Thread Sort by References Header"), |
| 320 | 'type' => SMOPT_TYPE_BOOLEAN, |
| 321 | 'refresh' => SMOPT_REFRESH_ALL |
| 322 | ); |
| 323 | } |
| 324 | |
| 325 | |
| 326 | |
| 327 | /*** Load the General Options into the array ***/ |
| 328 | $optgrps[SMOPT_GRP_MESSAGE] = _("Message Display Options"); |
| 329 | $optvals[SMOPT_GRP_MESSAGE] = array(); |
| 330 | |
| 331 | $optvals[SMOPT_GRP_MESSAGE][] = array( |
| 332 | 'name' => 'wrap_at', |
| 333 | 'caption' => _("Wrap Incoming Text At"), |
| 334 | 'type' => SMOPT_TYPE_INTEGER, |
| 335 | 'refresh' => SMOPT_REFRESH_NONE, |
| 336 | 'size' => SMOPT_SIZE_TINY |
| 337 | ); |
| 338 | |
| 339 | $optvals[SMOPT_GRP_MESSAGE][] = array( |
| 340 | 'name' => 'show_html_default', |
| 341 | 'caption' => _("Show HTML Version by Default"), |
| 342 | 'type' => SMOPT_TYPE_BOOLEAN, |
| 343 | 'refresh' => SMOPT_REFRESH_NONE |
| 344 | ); |
| 345 | |
| 346 | if ($use_iframe) { |
| 347 | // Type is set to string in order to be able to use 100%. |
| 348 | $optvals[SMOPT_GRP_MESSAGE][] = array( |
| 349 | 'name' => 'iframe_height', |
| 350 | 'caption' => _("Height of inline frame"), |
| 351 | 'type' => SMOPT_TYPE_STRING, |
| 352 | 'size' => SMOPT_SIZE_TINY, |
| 353 | 'refresh' => SMOPT_REFRESH_NONE |
| 354 | ); |
| 355 | } |
| 356 | $optvals[SMOPT_GRP_MESSAGE][] = array( |
| 357 | 'name' => 'enable_forward_as_attachment', |
| 358 | 'caption' => _("Enable Forward as Attachment"), |
| 359 | 'type' => SMOPT_TYPE_BOOLEAN, |
| 360 | 'refresh' => SMOPT_REFRESH_NONE |
| 361 | ); |
| 362 | |
| 363 | $optvals[SMOPT_GRP_MESSAGE][] = array( |
| 364 | 'name' => 'show_xmailer_default', |
| 365 | 'caption' => _("Enable Mailer Display"), |
| 366 | 'type' => SMOPT_TYPE_BOOLEAN, |
| 367 | 'refresh' => SMOPT_REFRESH_NONE |
| 368 | ); |
| 369 | |
| 370 | $optvals[SMOPT_GRP_MESSAGE][] = array( |
| 371 | 'name' => 'attachment_common_show_images', |
| 372 | 'caption' => _("Display Attached Images with Message"), |
| 373 | 'type' => SMOPT_TYPE_BOOLEAN, |
| 374 | 'refresh' => SMOPT_REFRESH_NONE |
| 375 | ); |
| 376 | |
| 377 | if ($default_use_mdn) { |
| 378 | $optvals[SMOPT_GRP_MESSAGE][] = array( |
| 379 | 'name' => 'mdn_user_support', |
| 380 | 'caption' => _("Enable Mail Delivery Notification"), |
| 381 | 'type' => SMOPT_TYPE_BOOLEAN, |
| 382 | 'refresh' => SMOPT_REFRESH_NONE |
| 383 | ); |
| 384 | } |
| 385 | |
| 386 | $optvals[SMOPT_GRP_MESSAGE][] = array( |
| 387 | 'name' => 'delete_prev_next_display', |
| 388 | 'caption' => _("Show 'Delete & Prev/Next' Links"), |
| 389 | 'type' => SMOPT_TYPE_BOOLEAN, |
| 390 | 'refresh' => SMOPT_REFRESH_ALL |
| 391 | ); |
| 392 | |
| 393 | /* Assemble all this together and return it as our result. */ |
| 394 | $result = array( |
| 395 | 'grps' => $optgrps, |
| 396 | 'vals' => $optvals |
| 397 | ); |
| 398 | return ($result); |
| 399 | } |
| 400 | |
| 401 | /******************************************************************/ |
| 402 | /** Define any specialized save functions for this option page. ***/ |
| 403 | /******************************************************************/ |
| 404 | |
| 405 | /** |
| 406 | * This function saves a new template setting. |
| 407 | * It updates the template array. |
| 408 | */ |
| 409 | function save_option_template($option) { |
| 410 | global $aTemplateSet; |
| 411 | |
| 412 | /* Do checking to make sure new template is in the available templates array. */ |
| 413 | $templateset_in_array = false; |
| 414 | for ($i = 0; $i < count($aTemplateSet); ++$i) { |
| 415 | if ($aTemplateSet[$i]['ID'] == $option->new_value) { |
| 416 | $templateset_in_array = true; |
| 417 | break; |
| 418 | } |
| 419 | } |
| 420 | |
| 421 | if (!$templateset_in_array) { |
| 422 | $option->new_value = ''; |
| 423 | } else { |
| 424 | |
| 425 | // clear template cache when changing template sets |
| 426 | // (in order to do so, we have to change the global |
| 427 | // template set ID now... should not be a problem -- |
| 428 | // in fact, if we don't do it now, very anomalous |
| 429 | // problems occur) |
| 430 | // |
| 431 | global $sTemplateID; |
| 432 | $sTemplateID = $option->new_value; |
| 433 | Template::cache_template_file_hierarchy(TRUE); |
| 434 | |
| 435 | } |
| 436 | |
| 437 | /** |
| 438 | * TODO: If the template changes and we are using a template provided theme |
| 439 | * ($user_theme), do we want to reset $user_theme? |
| 440 | */ |
| 441 | /* Save the option like normal. */ |
| 442 | save_option($option); |
| 443 | } |
| 444 | |
| 445 | /** |
| 446 | * This function saves the javascript detection option. |
| 447 | */ |
| 448 | function save_option_javascript_autodetect($option) { |
| 449 | save_option($option); |
| 450 | checkForJavascript(TRUE); |
| 451 | } |
| 452 | |
| 453 | /** |
| 454 | * This function saves the user's icon theme setting |
| 455 | */ |
| 456 | function icon_theme_save($option) { |
| 457 | global $icon_themes; |
| 458 | |
| 459 | |
| 460 | // Don't assume the new value is there, double check |
| 461 | // and only save if found |
| 462 | $found = false; |
| 463 | while (!$found && (list($index, $data) = each($icon_themes))) { |
| 464 | if ($data['PATH'] == $option->new_value) |
| 465 | $found = true; |
| 466 | } |
| 467 | |
| 468 | if (!$found) |
| 469 | $option->new_value = 'none'; |
| 470 | |
| 471 | save_option($option); |
| 472 | } |
| 473 | |
| 474 | function css_theme_save ($option) { |
| 475 | global $user_themes, $oTemplate; |
| 476 | |
| 477 | // Don't assume the new value is there, double check |
| 478 | // and only save if found |
| 479 | $found = false; |
| 480 | reset($user_themes); |
| 481 | while (!$found && (list($index, $data) = each($user_themes))) { |
| 482 | if ($data['PATH'] == $option->new_value) |
| 483 | $found = true; |
| 484 | } |
| 485 | |
| 486 | if (!$found) { |
| 487 | $template_themes = $oTemplate->get_alternative_stylesheets(true); |
| 488 | while (!$found && (list($path, $name) = each($template_themes))) { |
| 489 | if ($path == $option->new_value) |
| 490 | $found = true; |
| 491 | } |
| 492 | } |
| 493 | |
| 494 | if (!$found) |
| 495 | $option->new_value = 'none'; |
| 496 | |
| 497 | save_option($option); |
| 498 | } |
| 499 | |
| 500 | |