include/options/compose.php

   1 <?php
   2
   3 /**
   4  * options_compose.php
   5  *
   6  * Displays all options concerning composing of new messages
   7  *
   8  * @copyright 1999-2022 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 this options page. */
  15 define('SMOPT_GRP_COMPOSE', 0);
  16 define('SMOPT_GRP_COMPOSE_REPLY', 1);
  17
  18 /**
  19  * This function builds an array with all the information about
  20  * the options available to the user, and returns it. The options
  21  * are grouped by the groups in which they are displayed.
  22  * For each option, the following information is stored:
  23  * - name: the internal (variable) name
  24  * - caption: the description of the option in the UI
  25  * - type: one of SMOPT_TYPE_*
  26  * - refresh: one of SMOPT_REFRESH_*
  27  * - size: one of SMOPT_SIZE_*
  28  * - save: the name of a function to call when saving this option
  29  * @return array all option information
  30  */
  31 function load_optpage_data_compose() {
  32
  33     /* Build a simple array into which we will build options. */
  34     $optgrps = array();
  35     $optvals = array();
  36
  37     /******************************************************/
  38     /* LOAD EACH GROUP OF OPTIONS INTO THE OPTIONS ARRAY. */
  39     /******************************************************/
  40
  41     /*** Load the General Compose Options into the array ***/
  42     $optgrps[SMOPT_GRP_COMPOSE] = _("General Message Composition");
  43     $optvals[SMOPT_GRP_COMPOSE] = array();
  44
  45     $optvals[SMOPT_GRP_COMPOSE][] = array(
  46         'name'    => 'editor_size',
  47         'caption' => _("Width of Editor Window"),
  48         'type'    => SMOPT_TYPE_INTEGER,
  49         'refresh' => SMOPT_REFRESH_NONE,
  50         'size'    => SMOPT_SIZE_TINY
  51     );
  52
  53     $optvals[SMOPT_GRP_COMPOSE][] = array(
  54         'name'    => 'editor_height',
  55         'caption' => _("Height of Editor Window"),
  56         'type'    => SMOPT_TYPE_INTEGER,
  57         'refresh' => SMOPT_REFRESH_NONE,
  58         'size'    => SMOPT_SIZE_TINY
  59     );
  60
  61     $optvals[SMOPT_GRP_COMPOSE][] = array(
  62         'name'    => 'location_of_buttons',
  63         'caption' => _("Location of Buttons when Composing"),
  64         'type'    => SMOPT_TYPE_STRLIST,
  65         'refresh' => SMOPT_REFRESH_NONE,
  66         'posvals' => array(SMPREF_LOC_TOP     => _("Before headers"),
  67                            SMPREF_LOC_BETWEEN => _("Between headers and message body"),
  68                            SMPREF_LOC_BOTTOM  => _("After message body"))
  69     );
  70
  71
  72     $optvals[SMOPT_GRP_COMPOSE][] = array(
  73         'name'    => 'use_javascript_addr_book',
  74         'caption' => _("Address Book Display Format"),
  75         'type'    => SMOPT_TYPE_STRLIST,
  76         'refresh' => SMOPT_REFRESH_NONE,
  77         'posvals' => array('1' => _("Pop-up window"),
  78                            '0' => _("In-page"))
  79     );
  80
  81
  82     $optvals[SMOPT_GRP_COMPOSE][] = array(
  83         'name'    => 'addrsrch_fullname',
  84         'caption' => _("Format of Addresses Added From Address Book"),
  85         'type'    => SMOPT_TYPE_STRLIST,
  86         'refresh' => SMOPT_REFRESH_NONE,
  87         'posvals' => array('noprefix' => _("No prefix/Address only"),
  88                            'nickname' => _("Nickname and address"),
  89                            'fullname' => _("Full name and address"))
  90     );
  91
  92
  93     $optvals[SMOPT_GRP_COMPOSE][] = array(
  94         'name'    => 'compose_new_win',
  95         'caption' => _("Compose Messages in New Window"),
  96         'type'    => SMOPT_TYPE_BOOLEAN,
  97         'refresh' => SMOPT_REFRESH_ALL
  98     );
  99
 100     $optvals[SMOPT_GRP_COMPOSE][] = array(
 101         'name'    => 'compose_width',
 102         'caption' => _("Width of Compose Window"),
 103         'type'    => SMOPT_TYPE_INTEGER,
 104         'refresh' => SMOPT_REFRESH_ALL,
 105         'size'    => SMOPT_SIZE_TINY
 106     );
 107
 108     $optvals[SMOPT_GRP_COMPOSE][] = array(
 109         'name'    => 'compose_height',
 110         'caption' => _("Height of Compose Window"),
 111         'type'    => SMOPT_TYPE_INTEGER,
 112         'refresh' => SMOPT_REFRESH_ALL,
 113         'size'    => SMOPT_SIZE_TINY
 114     );
 115
 116
 117     /*** Load the General Options into the array ***/
 118     $optgrps[SMOPT_GRP_COMPOSE_REPLY] = _("Replying and Forwarding Messages");
 119     $optvals[SMOPT_GRP_COMPOSE_REPLY] = array();
 120
 121     $optvals[SMOPT_GRP_COMPOSE_REPLY][] = array(
 122         'name'    => 'do_not_reply_to_self',
 123         'caption' => _("Send Replies To My Own Messages To Previous Recipient"),
 124         'type'    => SMOPT_TYPE_BOOLEAN,
 125         'refresh' => SMOPT_REFRESH_NONE
 126     );
 127
 128     $optvals[SMOPT_GRP_COMPOSE_REPLY][] = array(
 129         'name'    => 'include_self_reply_all',
 130         'caption' => _("Include Me in CC when I Reply All"),
 131         'type'    => SMOPT_TYPE_BOOLEAN,
 132         'refresh' => SMOPT_REFRESH_NONE
 133     );
 134
 135     $optvals[SMOPT_GRP_COMPOSE_REPLY][] = array(
 136         'name'    => 'return_to_message_after_reply',
 137         'caption' => _("Return to Original Message After Replying"),
 138         'type'    => SMOPT_TYPE_BOOLEAN,
 139         'refresh' => SMOPT_REFRESH_NONE
 140     );
 141
 142     $optvals[SMOPT_GRP_COMPOSE_REPLY][] = array(
 143         'name'    => 'sig_first',
 144         'caption' => _("Prepend Signature before Reply/Forward Text"),
 145         'type'    => SMOPT_TYPE_BOOLEAN,
 146         'refresh' => SMOPT_REFRESH_NONE
 147     );
 148
 149     $optvals[SMOPT_GRP_COMPOSE_REPLY][] = array(
 150         'name'    => 'body_quote',
 151         'caption' => _("Prefix for Original Message when Replying"),
 152         'type'    => SMOPT_TYPE_STRING,
 153         'refresh' => SMOPT_REFRESH_NONE,
 154         'size'    => SMOPT_SIZE_TINY,
 155         'save'    => 'save_option_reply_prefix'
 156     );
 157
 158     $optvals[SMOPT_GRP_COMPOSE_REPLY][] = array(
 159         'name'    => 'reply_focus',
 160         'caption' => _("Cursor Position when Replying"),
 161         'type'    => SMOPT_TYPE_STRLIST,
 162         'refresh' => SMOPT_REFRESH_NONE,
 163         'posvals' => array('' => _("To: field"),
 164                            'focus' => _("Focus in body"),
 165                            'select' => _("Select body"),
 166                            'none' => _("No focus"))
 167     );
 168
 169     $optvals[SMOPT_GRP_COMPOSE_REPLY][] = array(
 170         'name'    => 'strip_sigs',
 171         'caption' => _("Strip signature when replying"),
 172         'type'    => SMOPT_TYPE_BOOLEAN,
 173         'refresh' => SMOPT_REFRESH_NONE
 174     );
 175
 176     /* Assemble all this together and return it as our result. */
 177     $result = array(
 178         'grps' => $optgrps,
 179         'vals' => $optvals
 180     );
 181     return ($result);
 182 }
 183
 184 /******************************************************************/
 185 /** Define any specialized save functions for this option page. ***/
 186 /**                                                             ***/
 187 /** You must add every function that is set in save parameter   ***/
 188 /******************************************************************/
 189
 190 /**
 191  * This function saves the reply prefix (body_quote) character(s)
 192  * @param object $option
 193  */
 194 function save_option_reply_prefix($option) {
 195
 196     // save as "NONE" if it was blanked out
 197     //
 198     if (empty($option->new_value)) $option->new_value = 'NONE';
 199
 200
 201     // Save the option like normal.
 202     //
 203     save_option($option);
 204
 205 }