Source for file options.php

Documentation is available at options.php

  1. <?php
  2.  
  3. /**
  4.  * Administrator Plugin - Options Page
  5.  *
  6.  * This script creates separate page, that allows to review and modify
  7.  * SquirrelMail configuration file.
  8.  *
  9.  * @author Philippe Mingo
  10.  * @copyright &copy; 1999-2006 The SquirrelMail Project Team
  11.  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  12.  * @version $Id: options.php,v 1.57 2006/08/02 18:05:33 tokul Exp $
  13.  * @package plugins
  14.  * @subpackage administrator
  15.  */
  16.  
  17. /**
  18.  * parse the config file
  19.  *
  20.  * @param string $cfg_file 
  21.  * @access private
  22.  */
  23. function parseConfig( $cfg_file ) {
  24.  
  25.     global $newcfg;
  26.  
  27.     $cfg = file( $cfg_file );
  28.     $mode = '';
  29.     $l = count( $cfg );
  30.     $modifier = FALSE;
  31.     $arraykey = 0;
  32.  
  33.     for ($i=0;$i<$l;$i++) {
  34.         $line = trim( $cfg[$i] );
  35.         $s = strlen( $line );
  36.         for ($j=0;$j<$s;$j++) {
  37.             switch ( $mode ) {
  38.             case '=':
  39.                 if ( $line{$j} == '=' ) {
  40.                     // Ok, we've got a right value, lets detect what type
  41.                     $mode = 'D';
  42.                 } else if ( $line{$j} == ';' ) {
  43.                     // hu! end of command
  44.                     $key = $mode = '';
  45.                 }
  46.                 break;
  47.             case 'K':
  48.                 // Key detect
  49.                 if ( $line{$j} == ' ' ) {
  50.                     $mode = '=';
  51.                 } else {
  52.                     $key .= $line{$j};
  53.                     // FIXME: this is only pour workaround for plugins[] array.
  54.                     if ($line{$j}=='[' && $line{($j+1)}==']') {
  55.                         $key .= $arraykey;
  56.                         $arraykey++;
  57.                     }
  58.                 }
  59.                 break;
  60.             case ';':
  61.                 // Skip until next ;
  62.                 if ( $line{$j} == ';' ) {
  63.                     $mode = '';
  64.                 }
  65.                 break;
  66.             case 'S':
  67.                 if ( $line{$j} == '\\' ) {
  68.                     $value .= $line{$j};
  69.                     $modifier = TRUE;
  70.                 } else if ( $line{$j} == $delimiter && $modifier === FALSE ) {
  71.                     // End of string;
  72.                     $newcfg[$key] = $value . $delimiter;
  73.                     $key = $value = '';
  74.                     $mode = ';';
  75.                 } else {
  76.                     $value .= $line{$j};
  77.                     $modifier = FALSE;
  78.                 }
  79.                 break;
  80.             case 'N':
  81.                 if ( $line{$j} == ';' ) {
  82.                     $newcfg{$key} = $value;
  83.                     $key = $mode = '';
  84.                 } else {
  85.                     $value .= $line{$j};
  86.                 }
  87.                 break;
  88.             case 'C':
  89.                 // Comments
  90.                 if ( $s > $j + 1  &&
  91.                      $line{$j}.$line{$j+1} == '*/' ) {
  92.                     $mode = '';
  93.                     $j++;
  94.                 }
  95.                 break;
  96.             case 'D':
  97.                 // Delimiter detect
  98.                 switch ( $line{$j} ) {
  99.                 case '"':
  100.                 case "'":
  101.                     // Double quote string
  102.                     $delimiter = $value = $line{$j};
  103.                     $mode = 'S';
  104.                     break;
  105.                 case ' ':
  106.                     // Nothing yet
  107.                     break;
  108.                 default:
  109.                     if ( strtoupper( substr( $line, $j, 4 ) ) == 'TRUE'  ) {
  110.                         // Boolean TRUE
  111.                         $newcfg{$key} = 'TRUE';
  112.                         $key = '';
  113.                         $mode = ';';
  114.                     } else if ( strtoupper( substr( $line, $j, 5 ) ) == 'FALSE'  ) {
  115.                         $newcfg{$key} = 'FALSE';
  116.                         $key = '';
  117.                         $mode = ';';
  118.                     } else {
  119.                         // Number or function call
  120.                         $mode = 'N';
  121.                         $value = $line{$j};
  122.                     }
  123.                 }
  124.                 break;
  125.             default:
  126.                 if ( $line{$j} == '$' ) {
  127.                     // We must detect $key name
  128.                     $mode = 'K';
  129.                     $key = '$';
  130.                 } else if ( $s < $j + 2 ) {
  131.                 } else if ( strtoupper( substr( $line, $j, 7 ) ) == 'GLOBAL ' ) {
  132.                     // Skip untill next ;
  133.                     $mode = ';';
  134.                     $j += 6;
  135.                 } else if ( $line{$j}.$line{$j+1} == '/*' ) {
  136.                     $mode = 'C';
  137.                     $j++;
  138.                 } else if ( $line{$j} == '#' || $line{$j}.$line{$j+1} == '//' ) {
  139.                     // Delete till the end of the line
  140.                     $j = $s;
  141.                 }
  142.             }
  143.         }
  144.     }
  145. }
  146.  
  147. /**
  148.  * Change paths containing SM_PATH to admin-friendly paths
  149.  * relative to the config dir, i.e.:
  150.  *    ''                          --> <empty string>
  151.  *    SM_PATH . 'images/logo.gif' --> ../images/logo.gif
  152.  *    '/absolute/path/logo.gif'   --> /absolute/path/logo.gif
  153.  *    'http://whatever/'          --> http://whatever
  154.  *  Note removal of quotes in returned value
  155.  *
  156.  * @param string $old_path path that has to be converted
  157.  * @return string new path
  158.  * @access private
  159.  */
  160. function change_to_rel_path($old_path) {
  161.     $new_path = str_replace("SM_PATH . '", "../", $old_path);
  162.     $new_path = str_replace("../config/","", $new_path);
  163.     $new_path = str_replace("'","", $new_path);
  164.     return $new_path;
  165. }
  166.  
  167. /**
  168.  * Change relative path (relative to config dir) to
  169.  *  internal SM_PATH, i.e.:
  170.  *     empty_string            --> ''
  171.  *     ../images/logo.gif      --> SM_PATH . 'images/logo.gif'
  172.  *     images/logo.gif         --> SM_PATH . 'config/images/logo.gif'
  173.  *     /absolute/path/logo.gif --> '/absolute/path/logo.gif'
  174.  *     http://whatever/        --> 'http://whatever'
  175.  *
  176.  * @param string $old_path path that has to be converted
  177.  * @return string new path
  178.  * @access private
  179. */
  180. function change_to_sm_path($old_path) {
  181.     if ( $old_path === '' || $old_path == "''" ) {
  182.         return "''";
  183.     } elseif ( preg_match("/^(\/|http)/", $old_path) ) {
  184.         return "'" . $old_path . "'";
  185.     } elseif ( preg_match("/^(\$|SM_PATH)/", $old_path) ) {
  186.         return $old_path;
  187.     }
  188.  
  189.     $new_path = '';
  190.     $rel_path = explode("../", $old_path);
  191.     if ( count($rel_path) > 2 ) {
  192.         // Since we're relative to the config dir,
  193.         // more than 1 ../ puts us OUTSIDE the SM tree.
  194.         // get full path to config.php, then pop the filename
  195.         $abs_path = explode('/', realpath (SM_PATH . 'config/config.php'));
  196.         array_pop ($abs_path);
  197.         foreach ( $rel_path as $subdir ) {
  198.             if ( $subdir === '' ) {
  199.                 array_pop ($abs_path);
  200.             } else {
  201.                 array_push($abs_path, $subdir);
  202.             }
  203.         }
  204.         foreach ($abs_path as $subdir) {
  205.             $new_path .= $subdir . '/';
  206.         }
  207.         $new_path = "'$new_path'";
  208.     } elseif ( count($rel_path) > 1 ) {
  209.         // we're within the SM tree, prepend SM_PATH
  210.         $new_path = str_replace('../',"SM_PATH . '", $old_path . "'");
  211.     } else {
  212.         // Last, if it's a relative path without a .. prefix,
  213.         // we're somewhere within the config dir, so prepend
  214.         //  SM_PATH . 'config/
  215.         $new_path = "SM_PATH . 'config/" . $old_path . "'";
  216.     }
  217.     return $new_path;
  218. }
  219.  
  220.  
  221. /* ---------------------- main -------------------------- */
  222. /** main SquirrelMail include */
  223. require('../../include/init.php');
  224. /* configuration definitions */
  225. include_once(SM_PATH . 'plugins/administrator/defines.php');
  226. /* additional functions */
  227. include_once(SM_PATH . 'plugins/administrator/auth.php');
  228.  
  229. global $data_dir, $username;
  230.  
  231. if ( !adm_check_user() ) {
  232.     header('Location: ' . SM_PATH . 'src/options.php') ;
  233.     exit;
  234. }
  235.  
  236. displayPageHeader($color, 'None');
  237.  
  238. $newcfg = array( );
  239.  
  240. foreach ( $defcfg as $key => $def ) {
  241.     $newcfg[$key] = '';
  242. }
  243.  
  244. $cfgfile = SM_PATH . 'config/config.php';
  245. parseConfig( SM_PATH . 'config/config_default.php' );
  246. parseConfig( $cfgfile );
  247.  
  248. $colapse = array( 'Titles' => 'off',
  249.                   'Group1' => getPref($data_dir, $username, 'adm_Group1', 'off' ),
  250.                   'Group2' => getPref($data_dir, $username, 'adm_Group2', 'on' ),
  251.                   'Group3' => getPref($data_dir, $username, 'adm_Group3', 'on' ),
  252.                   'Group4' => getPref($data_dir, $username, 'adm_Group4', 'on' ),
  253.                   'Group5' => getPref($data_dir, $username, 'adm_Group5', 'on' ),
  254.                   'Group6' => getPref($data_dir, $username, 'adm_Group6', 'on' ),
  255.                   'Group7' => getPref($data_dir, $username, 'adm_Group7', 'on' ),
  256.                   'Group8' => getPref($data_dir, $username, 'adm_Group8', 'on' ),
  257.                   'Group9' => getPref($data_dir, $username, 'adm_Group9', 'on' ),
  258.                   'Group10' => getPref($data_dir, $username, 'adm_Group10', 'on' ),
  259.                   'Group11' => getPref($data_dir, $username, 'adm_Group11', 'on' ) );
  260.  
  261. /* look in $_GET array for 'switch' */
  262. if ( sqgetGlobalVar('switch', $switch, SQ_GET) ) {
  263.     if ( $colapse[$switch] == 'on' ) {
  264.         $colapse[$switch] = 'off';
  265.     } else {
  266.         $colapse[$switch] = 'on';
  267.     }
  268.     setPref($data_dir, $username, "adm_$switch", $colapse[$switch] );
  269. }
  270.  
  271. echo '<form action="options.php" method="post" name="options">' .
  272.      '<table width="95%" align="center" bgcolor="'.$color[5].'"><tr><td>'.
  273.      '<table width="100%" cellspacing="0" bgcolor="'.$color[4].'">'.
  274.      '<tr bgcolor="'.$color[5].'"><th colspan="2">'.
  275.      _("Configuration Administrator").'</th></tr>'.
  276.      '<tr bgcolor="'.$color[5].'"><td colspan="2" align="center"><small>'.
  277.      _("Note: it is recommended that you configure your system using conf.pl, and not this plugin. conf.pl contains additional information regarding the purpose of variables and appropriate values, as well as additional verification steps.").
  278.      '<br />'.
  279.      _("Run or consult conf.pl should you run into difficulty with your configuration.").
  280.      '</small></td></tr>';
  281.  
  282.  
  283. $act_grp = 'Titles';  /* Active group */
  284.  
  285. foreach ( $newcfg as $k => $v ) {
  286.     $l = strtolower( $v );
  287.     $type = SMOPT_TYPE_UNDEFINED;
  288.     $n = substr( $k, 1 );
  289.     $n = str_replace( '[', '_', $n );
  290.     $n = str_replace( ']', '_', $n );
  291.     $e = 'adm_' . $n;
  292.     $name = $k;
  293.     $size = 50;
  294.     if ( isset( $defcfg[$k] ) ) {
  295.         $name = $defcfg[$k]['name'];
  296.         $type = $defcfg[$k]['type'];
  297.         if ( isset( $defcfg[$k]['size'] ) ) {
  298.             $size = $defcfg[$k]['size'];
  299.         } else {
  300.             $size = 40;
  301.         }
  302.     } else if ( $l == 'true' ) {
  303.         $v = 'TRUE';
  304.         $type = SMOPT_TYPE_BOOLEAN;
  305.     } else if ( $l == 'false' ) {
  306.         $v = 'FALSE';
  307.         $type = SMOPT_TYPE_BOOLEAN;
  308.     } else if ( $v{0} == "'" ) {
  309.         $type = SMOPT_TYPE_STRING;
  310.     } else if ( $v{0} == '"' ) {
  311.         $type = SMOPT_TYPE_STRING;
  312.     }
  313.  
  314.     if ( substr( $k, 0, 7 ) == '$theme[' ) {
  315.         $type = SMOPT_TYPE_THEME;
  316.     } else if ( substr( $k, 0, 9 ) == '$plugins[' ) {
  317.         $type = SMOPT_TYPE_PLUGINS;
  318.     } else if ( substr( $k, 0, 13 ) == '$ldap_server[' ) {
  319.         $type = SMOPT_TYPE_LDAP;
  320.     } else if ( substr( $k, 0, 9 ) == '$fontsets' ||
  321.                 substr( $k, 0, 13 ) == '$aTemplateSet' ) {
  322.         $type = SMOPT_TYPE_CUSTOM;
  323.     }
  324.  
  325.     if ( $type == SMOPT_TYPE_TITLE || $colapse[$act_grp] == 'off' ) {
  326.  
  327.         switch ( $type ) {
  328.         case SMOPT_TYPE_LDAP:
  329.         case SMOPT_TYPE_CUSTOM:
  330.         case SMOPT_TYPE_PLUGINS:
  331.         case SMOPT_TYPE_THEME:
  332.         case SMOPT_TYPE_HIDDEN:
  333.             break;
  334.         case SMOPT_TYPE_EXTERNAL:
  335.             echo "<tr><td>$name</td><td><b>" .
  336.                  $defcfg[$k]['value'] .
  337.                  '</b></td></tr>';
  338.             break;
  339.         case SMOPT_TYPE_TITLE:
  340.             if ( $colapse[$k] == 'on' ) {
  341.                 $sw = '(+)';
  342.             } else {
  343.                 $sw = '(-)';
  344.             }
  345.             echo '<tr bgcolor="'.$color[0].'"><th colspan="2">'.
  346.                  "<a href=\"options.php?switch=$k\" style=\"text-decoration:none\">".
  347.                  '<b>'.$sw.'</b></a> '.$name.'</th></tr>';
  348.             $act_grp = $k;
  349.             break;
  350.         case SMOPT_TYPE_COMMENT:
  351.             $v = substr( $v, 1, strlen( $v ) - 2 );
  352.             echo "<tr><td>$name</td><td>".
  353.                  "<b>$v</b>";
  354.             $newcfg[$k] = "'$v'";
  355.             if ( isset( $defcfg[$k]['comment'] ) ) {
  356.                 echo ' &nbsp; ' . $defcfg[$k]['comment'];
  357.             }
  358.             echo "</td></tr>\n";
  359.             break;
  360.         case SMOPT_TYPE_INTEGER:
  361.             /* look for variable $e in POST, fill into $v */
  362.             if ( sqgetGlobalVar($e, $new_v, SQ_POST) ) {
  363.                 $v = intval( $new_v );
  364.                 $newcfg[$k] = $v;
  365.             }
  366.             echo "<tr><td>$name</td><td>".
  367.                  "<input size=\"10\" name=\"adm_$n\" value=\"$v\" />";
  368.             if ( isset( $defcfg[$k]['comment'] ) ) {
  369.                 echo ' &nbsp; ' . $defcfg[$k]['comment'];
  370.             }
  371.             echo "</td></tr>\n";
  372.             break;
  373.         case SMOPT_TYPE_NUMLIST:
  374.             if (  sqgetGlobalVar($e, $new_v, SQ_POST) ) {
  375.                 $v = $new_v;
  376.                 $newcfg[$k] = $v;
  377.             }
  378.             echo "<tr><td>$name</td><td>";
  379.             echo "<select name=\"adm_$n\">";
  380.             foreach ( $defcfg[$k]['posvals'] as $kp => $vp ) {
  381.                 echo "<option value=\"$kp\"";
  382.                 if ( $kp == $v ) {
  383.                     echo ' selected="selected"';
  384.                 }
  385.                 echo ">$vp</option>";
  386.             }
  387.             echo '</select>';
  388.             if ( isset( $defcfg[$k]['comment'] ) ) {
  389.                 echo ' &nbsp; ' . $defcfg[$k]['comment'];
  390.             }
  391.             echo "</td></tr>\n";
  392.             break;
  393.         case SMOPT_TYPE_STRLIST:
  394.             if (  sqgetGlobalVar($e, $new_v, SQ_POST) ) {
  395.                 $v = '"' . $new_v . '"';
  396.                 $newcfg[$k] = $v;
  397.             }
  398.             echo "<tr><td>$name</td><td>".
  399.                  "<select name=\"adm_$n\">";
  400.             foreach ( $defcfg[$k]['posvals'] as $kp => $vp ) {
  401.                 echo "<option value=\"$kp\"";
  402.                 if ( $kp == substr( $v, 1, strlen( $v ) - 2 ) ) {
  403.                     echo ' selected="selected"';
  404.                 }
  405.                 echo ">$vp</option>";
  406.             }
  407.             echo '</select>';
  408.             if ( isset( $defcfg[$k]['comment'] ) ) {
  409.                 echo ' &nbsp; ' . $defcfg[$k]['comment'];
  410.             }
  411.             echo "</td></tr>\n";
  412.             break;
  413.  
  414.         case SMOPT_TYPE_TEXTAREA:
  415.             if (  sqgetGlobalVar($e, $new_v, SQ_POST) ) {
  416.                 $v = '"' . addslashes($new_v) . '"';
  417.                 $newcfg[$k] = str_replace( "\n", '', $v );
  418.             }
  419.             echo "<tr><td valign=\"top\">$name</td><td>"
  420.                 ."<textarea cols=\"$size\" rows=\"4\" name=\"adm_$n\">" 
  421.                 .htmlspecialchars(stripslashes(substr( $v, 1, strlen( $v ) - 2 )))
  422.                 ."</textarea>";
  423.             if ( isset( $defcfg[$k]['comment'] ) ) {
  424.                 echo ' &nbsp; ' . $defcfg[$k]['comment'];
  425.             }
  426.             echo "</td></tr>\n";
  427.             break;
  428.         case SMOPT_TYPE_STRING:
  429.             if (  sqgetGlobalVar($e, $new_v, SQ_POST) )&