Source for file personal.php

Documentation is available at personal.php

  1. <?php
  2.  
  3. /**
  4.  * options_personal.php
  5.  *
  6.  * Displays all options relating to personal information
  7.  *
  8.  * @copyright 1999-2020 The SquirrelMail Project Team
  9.  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  10.  * @version $Id: personal.php 14840 2020-01-07 07:42:38Z pdontthink $
  11.  * @package squirrelmail
  12.  */
  13.  
  14. /** SquirrelMail required files. */
  15. require_once(SM_PATH . 'functions/imap.php');
  16.  
  17. /* Define the group constants for the personal options page. */
  18. define('SMOPT_GRP_CONTACT', 0);
  19. define('SMOPT_GRP_REPLY', 1);
  20. define('SMOPT_GRP_SIG', 2);
  21. define('SMOPT_GRP_TZ', 3);
  22.  
  23. /**
  24.  * This function builds an array with all the information about
  25.  * the options available to the user, and returns it. The options
  26.  * are grouped by the groups in which they are displayed.
  27.  * For each option, the following information is stored:
  28.  * - name: the internal (variable) name
  29.  * - caption: the description of the option in the UI
  30.  * - type: one of SMOPT_TYPE_*
  31.  * - refresh: one of SMOPT_REFRESH_*
  32.  * - size: one of SMOPT_SIZE_*
  33.  * - save: the name of a function to call when saving this option
  34.  * @return array all option information
  35.  */
  36. function load_optpage_data_personal() {
  37.     global $data_dir, $username, $edit_identity, $edit_name, $edit_reply_to,
  38.            $full_name, $reply_to, $email_address, $signature, $tzChangeAllowed,
  39.            $color;
  40.  
  41.     /* Set the values of some global variables. */
  42.     $full_name = getPref($data_dir, $username, 'full_name');
  43.     $reply_to = getPref($data_dir, $username, 'reply_to');
  44.     $email_address  = getPref($data_dir, $username, 'email_address');
  45.     $signature  = getSig($data_dir, $username, 'g');
  46.  
  47.     /* Build a simple array into which we will build options. */
  48.     $optgrps = array();
  49.     $optvals = array();
  50.  
  51.     /******************************************************/
  52.     /* LOAD EACH GROUP OF OPTIONS INTO THE OPTIONS ARRAY. */
  53.     /******************************************************/
  54.  
  55.     /*** Load the Contact Information Options into the array ***/
  56.     $optgrps[SMOPT_GRP_CONTACT] = _("Name and Address Options");
  57.     $optvals[SMOPT_GRP_CONTACT] = array();
  58.  
  59.     /* Build a simple array into which we will build options. */
  60.     $optvals = array();
  61.  
  62.     if (!isset($edit_identity)) {
  63.         $edit_identity = TRUE;
  64.     }
  65.  
  66.     if ($edit_identity || $edit_name) {
  67.         $optvals[SMOPT_GRP_CONTACT][] = array(
  68.             'name'    => 'full_name',
  69.             'caption' => _("Full Name"),
  70.             'type'    => SMOPT_TYPE_STRING,
  71.             'refresh' => SMOPT_REFRESH_NONE,
  72.             'size'    => SMOPT_SIZE_HUGE
  73.         );
  74.     } else {
  75.         $optvals[SMOPT_GRP_CONTACT][] = array(
  76.             'name'    => 'full_name',
  77.             'caption' => _("Full Name"),
  78.             'type'    => SMOPT_TYPE_COMMENT,
  79.             'refresh' => SMOPT_REFRESH_NONE,
  80.             'comment' => $full_name
  81.         );
  82.     }
  83.  
  84.     if ($edit_identity) {
  85.         $optvals[SMOPT_GRP_CONTACT][] = array(
  86.             'name'    => 'email_address',
  87.             'caption' => _("E-mail Address"),
  88.             'type'    => SMOPT_TYPE_STRING,
  89.             'refresh' => SMOPT_REFRESH_NONE,
  90.             'size'    => SMOPT_SIZE_HUGE
  91.         );
  92.     } else {
  93.         $optvals[SMOPT_GRP_CONTACT][] = array(
  94.             'name'    => 'email_address',
  95.             'caption' => _("E-mail Address"),
  96.             'type'    => SMOPT_TYPE_COMMENT,
  97.             'refresh' => SMOPT_REFRESH_NONE,
  98.             'comment' => $email_address
  99.         );
  100.     }
  101.  
  102.     if ($edit_identity || $edit_reply_to) {
  103.         $optvals[SMOPT_GRP_CONTACT][] = array(
  104.             'name'    => 'reply_to',
  105.             'caption' => _("Reply To"),
  106.             'type'    => SMOPT_TYPE_STRING,
  107.             'refresh' => SMOPT_REFRESH_NONE,
  108.             'size'    => SMOPT_SIZE_HUGE
  109.         );
  110.     } else {
  111. //TODO: For many users, this is redundant to the email address above, especially if not editable -- so here instead of a comment, we could just hide it... in fact, that's what we'll do, but keep this code for posterity in case someone decides we shouldn't do this
  112. /*
  113.         $optvals[SMOPT_GRP_CONTACT][] = array(
  114.             'name'    => 'reply_to',
  115.             'caption' => _("Reply To"),
  116.             'type'    => SMOPT_TYPE_COMMENT,
  117.             'refresh' => SMOPT_REFRESH_NONE,
  118.             'comment' => $reply_to,
  119.         );
  120. */
  121.     }
  122.  
  123.     $optvals[SMOPT_GRP_CONTACT][] = array(
  124.         'name'    => 'signature',
  125.         'caption' => _("Signature"),
  126.         'type'    => SMOPT_TYPE_TEXTAREA,
  127.         'refresh' => SMOPT_REFRESH_NONE,
  128.         'size'    => SMOPT_SIZE_MEDIUM,
  129.         'save'    => 'save_option_signature'
  130.     );
  131.  
  132.     $identities_count = getPref($data_dir, $username, 'identities', 0);
  133.     if ($identities_count > 1 || $edit_identity) {
  134.         $identities_link_value = '<a href="options_identities.php">'
  135.                                . _("Edit Advanced Identities")
  136.                                . '</a> '
  137.                                . _("(discards changes made on this form so far)");
  138.         $optvals[SMOPT_GRP_CONTACT][] = array(
  139.             'name'    => 'identities_link',
  140.             'caption' => _("Multiple Identities"),
  141.             'type'    => SMOPT_TYPE_COMMENT,
  142.             'refresh' => SMOPT_REFRESH_NONE,
  143.             'comment' =>  $identities_link_value
  144.         );
  145.     }
  146.  
  147.     if ( $tzChangeAllowed || function_exists('date_default_timezone_set')) {
  148.         $TZ_ARRAY[SMPREF_NONE] = _("Same as server");
  149.         $tzfile = SM_PATH . 'locale/timezones.cfg';
  150.         if ((!is_readable($tzfile)) or (!$fd = fopen($tzfile,'r'))) {
  151.             $message = _("Error opening timezone config, contact administrator.");
  152.         }
  153.  
  154.         // TODO: make error user friendly
  155.         if (isset($message)) {
  156.             plain_error_message($message, $color);
  157.             exit;
  158.         }
  159.         while (!feof ($fd)) {
  160.             $zone = fgets($fd, 1024);
  161.             if( $zone ) {
  162.                 $zone = trim($zone);
  163.                 $TZ_ARRAY[$zone] = $zone;
  164.             }
  165.         }
  166.         fclose ($fd);
  167.  
  168.         $optgrps[SMOPT_GRP_TZ] = _("Timezone Options");
  169.         $optvals[SMOPT_GRP_TZ] = array();
  170.  
  171.         $optvals[SMOPT_GRP_TZ][] = array(
  172.             'name'    => 'timezone',
  173.             'caption' => _("Your current timezone"),
  174.             'type'    => SMOPT_TYPE_STRLIST,
  175.             'refresh' => SMOPT_REFRESH_NONE,
  176.             'posvals' => $TZ_ARRAY
  177.         );
  178.     }
  179.  
  180.     /*** Load the Reply Citation Options into the array ***/
  181.     $optgrps[SMOPT_GRP_REPLY] = _("Reply Citation Options");
  182.     $optvals[SMOPT_GRP_REPLY] = array();
  183.  
  184.     $optvals[SMOPT_GRP_REPLY][] = array(
  185.         'name'    => 'reply_citation_style',
  186.         'caption' => _("Reply Citation Style"),
  187.         'type'    => SMOPT_TYPE_STRLIST,
  188.         'refresh' => SMOPT_REFRESH_NONE,
  189.         'posvals' => array(SMPREF_NONE    => _("No Citation"),
  190.                            'author_said'  => _("AUTHOR Wrote"),
  191.                            'date_time_author' => _("On DATE, AUTHOR Wrote"),
  192.                            'quote_who'    => _("Quote Who XML"),
  193.                            'user-defined' => _("User-Defined"))
  194.     );
  195.  
  196.     $optvals[SMOPT_GRP_REPLY][] = array(
  197.         'name'    => 'reply_citation_start',
  198.         'caption' => _("User-Defined Citation Start"),
  199.         'type'    => SMOPT_TYPE_STRING,
  200.         'refresh' => SMOPT_REFRESH_NONE,
  201.         'size'    => SMOPT_SIZE_MEDIUM
  202.     );
  203.  
  204.     $optvals[SMOPT_GRP_REPLY][] = array(
  205.         'name'    => 'reply_citation_end',
  206.         'caption' => _("User-Defined Citation End"),
  207.         'type'    => SMOPT_TYPE_STRING,
  208.         'refresh' => SMOPT_REFRESH_NONE,
  209.         'size'    => SMOPT_SIZE_MEDIUM
  210.     );
  211.  
  212.     /*** Load the Signature Options into the array ***/
  213.     $optgrps[SMOPT_GRP_SIG] = _("Signature Options");
  214.     $optvals[SMOPT_GRP_SIG] = array();
  215.  
  216.     $optvals[SMOPT_GRP_SIG][] = array(
  217.         'name'    => 'use_signature',
  218.         'caption' => _("Use Signature"),
  219.         'type'    => SMOPT_TYPE_BOOLEAN,
  220.         'refresh' => SMOPT_REFRESH_NONE
  221.     );
  222.  
  223.     $optvals[SMOPT_GRP_SIG][] = array(
  224.         'name'    => 'prefix_sig',
  225.         'caption' => _("Prefix Signature with '-- ' Line"),
  226.         'type'    => SMOPT_TYPE_BOOLEAN,
  227.         'refresh' => SMOPT_REFRESH_NONE
  228.     );
  229.  
  230.     /* Assemble all this together and return it as our result. */
  231.     $result = array(
  232.         'grps' => $optgrps,
  233.         'vals' => $optvals
  234.     );
  235.     return ($result);
  236. }
  237.  
  238. /******************************************************************/
  239. /** Define any specialized save functions for this option page. ***/
  240. /******************************************************************/
  241.  
  242. /**
  243.  * Saves the signature option.
  244.  */
  245. function save_option_signature($option) {
  246.     global $data_dir, $username;
  247.     setSig($data_dir, $username, 'g', $option->new_value);
  248. }

Documentation generated on Mon, 13 Jan 2020 04:25:10 +0100 by phpDocumentor 1.4.3