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 &copy; 1999-2006 The SquirrelMail Project Team
  9.  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  10.  * @version $Id: personal.php,v 1.8.2.8 2006/02/03 22:27:51 jervfors Exp $
  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,
  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.     $optvals[SMOPT_GRP_CONTACT][] = array(
  103.         'name'    => 'reply_to',
  104.         'caption' => _("Reply To"),
  105.         'type'    => SMOPT_TYPE_STRING,
  106.         'refresh' => SMOPT_REFRESH_NONE,
  107.         'size'    => SMOPT_SIZE_HUGE
  108.     );
  109.  
  110.     $optvals[SMOPT_GRP_CONTACT][] = array(
  111.         'name'    => 'signature',
  112.         'caption' => _("Signature"),
  113.         'type'    => SMOPT_TYPE_TEXTAREA,
  114.         'refresh' => SMOPT_REFRESH_NONE,
  115.         'size'    => SMOPT_SIZE_MEDIUM,
  116.         'save'    => 'save_option_signature'
  117.     );
  118.  
  119.     if ($edit_identity) {
  120.         $identities_link_value = '<a href="options_identities.php">'
  121.                                . _("Edit Advanced Identities")
  122.                                . '</a> '
  123.                                . _("(discards changes made on this form so far)");
  124.         $optvals[SMOPT_GRP_CONTACT][] = array(
  125.             'name'    => 'identities_link',
  126.             'caption' => _("Multiple Identities"),
  127.             'type'    => SMOPT_TYPE_COMMENT,
  128.             'refresh' => SMOPT_REFRESH_NONE,
  129.             'comment' =>  $identities_link_value
  130.         );
  131.     }
  132.  
  133.     if ( $tzChangeAllowed ) {
  134.         $TZ_ARRAY[SMPREF_NONE] = _("Same as server");
  135.         $tzfile = SM_PATH . 'locale/timezones.cfg';
  136.         if ((!is_readable($tzfile)) or (!$fd = fopen($tzfile,'r'))) {
  137.             $message = _("Error opening timezone config, contact administrator.");
  138.         }
  139.  
  140.         // TODO: make error user friendly
  141.         if (isset($message)) {
  142.             plain_error_message($message, $color);
  143.             exit;
  144.         }
  145.         while (!feof ($fd)) {
  146.             $zone = fgets($fd, 1024);
  147.             if( $zone ) {
  148.                 $zone = trim($zone);
  149.                 $TZ_ARRAY[$zone] = $zone;
  150.             }
  151.         }
  152.         fclose ($fd);
  153.  
  154.         $optgrps[SMOPT_GRP_TZ] = _("Timezone Options");
  155.         $optvals[SMOPT_GRP_TZ] = array();
  156.  
  157.         $optvals[SMOPT_GRP_TZ][] = array(
  158.             'name'    => 'timezone',
  159.             'caption' => _("Your current timezone"),
  160.             'type'    => SMOPT_TYPE_STRLIST,
  161.             'refresh' => SMOPT_REFRESH_NONE,
  162.             'posvals' => $TZ_ARRAY
  163.         );
  164.     }
  165.  
  166.     /*** Load the Reply Citation Options into the array ***/
  167.     $optgrps[SMOPT_GRP_REPLY] = _("Reply Citation Options");
  168.     $optvals[SMOPT_GRP_REPLY] = array();
  169.  
  170.     $optvals[SMOPT_GRP_REPLY][] = array(
  171.         'name'    => 'reply_citation_style',
  172.         'caption' => _("Reply Citation Style"),
  173.         'type'    => SMOPT_TYPE_STRLIST,
  174.         'refresh' => SMOPT_REFRESH_NONE,
  175.         'posvals' => array(SMPREF_NONE    => _("No Citation"),
  176.                            'author_said'  => _("AUTHOR Wrote"),
  177.                            'date_time_author' => _("On DATE, AUTHOR Wrote"),
  178.                            'quote_who'    => _("Quote Who XML"),
  179.                            'user-defined' => _("User-Defined"))
  180.     );
  181.  
  182.     $optvals[SMOPT_GRP_REPLY][] = array(
  183.         'name'    => 'reply_citation_start',
  184.         'caption' => _("User-Defined Citation Start"),
  185.         'type'    => SMOPT_TYPE_STRING,
  186.         'refresh' => SMOPT_REFRESH_NONE,
  187.         'size'    => SMOPT_SIZE_MEDIUM
  188.     );
  189.  
  190.     $optvals[SMOPT_GRP_REPLY][] = array(
  191.         'name'    => 'reply_citation_end',
  192.         'caption' => _("User-Defined Citation End"),
  193.         'type'    => SMOPT_TYPE_STRING,
  194.         'refresh' => SMOPT_REFRESH_NONE,
  195.         'size'    => SMOPT_SIZE_MEDIUM
  196.     );
  197.  
  198.     /*** Load the Signature Options into the array ***/
  199.     $optgrps[SMOPT_GRP_SIG] = _("Signature Options");
  200.     $optvals[SMOPT_GRP_SIG] = array();
  201.  
  202.     $optvals[SMOPT_GRP_SIG][] = array(
  203.         'name'    => 'use_signature',
  204.         'caption' => _("Use Signature"),
  205.         'type'    => SMOPT_TYPE_BOOLEAN,
  206.         'refresh' => SMOPT_REFRESH_NONE
  207.     );
  208.  
  209.     $optvals[SMOPT_GRP_SIG][] = array(
  210.         'name'    => 'prefix_sig',
  211.         'caption' => _("Prefix Signature with '-- ' Line"),
  212.         'type'    => SMOPT_TYPE_BOOLEAN,
  213.         'refresh' => SMOPT_REFRESH_NONE
  214.     );
  215.  
  216.     /* Assemble all this together and return it as our result. */
  217.     $result = array(
  218.         'grps' => $optgrps,
  219.         'vals' => $optvals
  220.     );
  221.     return ($result);
  222. }
  223.  
  224. /******************************************************************/
  225. /** Define any specialized save functions for this option page. ***/
  226. /******************************************************************/
  227.  
  228. /**
  229.  * Saves the signature option.
  230.  */
  231. function save_option_signature($option) {
  232.     global $data_dir, $username;
  233.     setSig($data_dir, $username, 'g', $option->new_value);
  234. }
  235.  
  236. ?>

Documentation generated on Sat, 07 Oct 2006 16:33:01 +0300 by phpDocumentor 1.3.0RC6