4 * Administrator Plugin - Options Page
6 * This script creates separate page, that allows to review and modify
7 * SquirrelMail configuration file.
9 * @author Philippe Mingo
10 * @copyright © 1999-2005 The SquirrelMail Project Team
11 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
14 * @subpackage administrator
18 * parse the config file
20 * @param string $cfg_file
23 function parseConfig( $cfg_file ) {
27 $cfg = file( $cfg_file );
33 for ($i=0;$i<$l;$i++
) {
34 $line = trim( $cfg[$i] );
36 for ($j=0;$j<$s;$j++
) {
39 if ( $line{$j} == '=' ) {
40 // Ok, we've got a right value, lets detect what type
42 } else if ( $line{$j} == ';' ) {
49 if ( $line{$j} == ' ' ) {
53 // FIXME: this is only pour workaround for plugins[] array.
54 if ($line{$j}=='[' && $line{($j+
1)}==']') {
62 if ( $line{$j} == ';' ) {
67 if ( $line{$j} == '\\' ) {
70 } else if ( $line{$j} == $delimiter && $modifier === FALSE ) {
72 $newcfg[$key] = $value . $delimiter;
81 if ( $line{$j} == ';' ) {
82 $newcfg{$key} = $value;
91 $line{$j}.$line{$j+
1} == '*/' ) {
98 switch ( $line{$j} ) {
101 // Double quote string
102 $delimiter = $value = $line{$j};
109 if ( strtoupper( substr( $line, $j, 4 ) ) == 'TRUE' ) {
111 $newcfg{$key} = 'TRUE';
114 } else if ( strtoupper( substr( $line, $j, 5 ) ) == 'FALSE' ) {
115 $newcfg{$key} = 'FALSE';
119 // Number or function call
126 if ( $line{$j} == '$' ) {
127 // We must detect $key name
130 } else if ( $s < $j +
2 ) {
131 } else if ( strtoupper( substr( $line, $j, 7 ) ) == 'GLOBAL ' ) {
132 // Skip untill next ;
135 } else if ( $line{$j}.$line{$j+
1} == '/*' ) {
138 } else if ( $line{$j} == '#' ||
$line{$j}.$line{$j+
1} == '//' ) {
139 // Delete till the end of the line
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
156 * @param string $old_path path that has to be converted
157 * @return string new path
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);
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'
176 * @param string $old_path path that has to be converted
177 * @return string new path
180 function change_to_sm_path($old_path) {
181 if ( $old_path === '' ||
$old_path == "''" ) {
183 } elseif ( preg_match("/^(\/|http)/", $old_path) ) {
184 return "'" . $old_path . "'";
185 } elseif ( preg_match("/^(\$|SM_PATH)/", $old_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);
201 array_push($abs_path, $subdir);
204 foreach ($abs_path as $subdir) {
205 $new_path .= $subdir . '/';
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 . "'");
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 . "'";
221 /* ---------------------- main -------------------------- */
224 define('SM_PATH','../../');
226 /* SquirrelMail required files. */
227 require_once(SM_PATH
. 'include/validate.php');
228 require_once(SM_PATH
. 'functions/imap.php');
229 require_once(SM_PATH
. 'plugins/administrator/defines.php');
230 require_once(SM_PATH
. 'plugins/administrator/auth.php');
232 global $data_dir, $username;
234 if ( !adm_check_user() ) {
235 header('Location: ' . SM_PATH
. 'src/options.php') ;
239 displayPageHeader($color, 'None');
243 foreach ( $defcfg as $key => $def ) {
247 $cfgfile = SM_PATH
. 'config/config.php';
248 parseConfig( SM_PATH
. 'config/config_default.php' );
249 parseConfig( $cfgfile );
251 $colapse = array( 'Titles' => 'off',
252 'Group1' => getPref($data_dir, $username, 'adm_Group1', 'off' ),
253 'Group2' => getPref($data_dir, $username, 'adm_Group2', 'on' ),
254 'Group3' => getPref($data_dir, $username, 'adm_Group3', 'on' ),
255 'Group4' => getPref($data_dir, $username, 'adm_Group4', 'on' ),
256 'Group5' => getPref($data_dir, $username, 'adm_Group5', 'on' ),
257 'Group6' => getPref($data_dir, $username, 'adm_Group6', 'on' ),
258 'Group7' => getPref($data_dir, $username, 'adm_Group7', 'on' ),
259 'Group8' => getPref($data_dir, $username, 'adm_Group8', 'on' ),
260 'Group9' => getPref($data_dir, $username, 'adm_Group9', 'on' ),
261 'Group10' => getPref($data_dir, $username, 'adm_Group10', 'on' ),
262 'Group11' => getPref($data_dir, $username, 'adm_Group11', 'on' ) );
264 /* look in $_GET array for 'switch' */
265 if ( sqgetGlobalVar('switch', $switch, SQ_GET
) ) {
266 if ( $colapse[$switch] == 'on' ) {
267 $colapse[$switch] = 'off';
269 $colapse[$switch] = 'on';
271 setPref($data_dir, $username, "adm_$switch", $colapse[$switch] );
274 echo '<form action="options.php" method="post" name="options">' .
275 '<center><table width="95%" bgcolor="'.$color[5].'"><tr><td>'.
276 '<table width="100%" cellspacing="0" bgcolor="'.$color[4].'">'.
277 '<tr bgcolor="'.$color[5].'"><th colspan="2">'.
278 _("Configuration Administrator").'</th></tr>'.
279 '<tr bgcolor="'.$color[5].'"><td colspan="2" align="center"><small>'.
280 _("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.").
282 _("Run or consult conf.pl should you run into difficulty with your configuration.").
283 '</small></td></tr>';
286 $act_grp = 'Titles'; /* Active group */
288 foreach ( $newcfg as $k => $v ) {
289 $l = strtolower( $v );
290 $type = SMOPT_TYPE_UNDEFINED
;
291 $n = substr( $k, 1 );
292 $n = str_replace( '[', '_', $n );
293 $n = str_replace( ']', '_', $n );
297 if ( isset( $defcfg[$k] ) ) {
298 $name = $defcfg[$k]['name'];
299 $type = $defcfg[$k]['type'];
300 if ( isset( $defcfg[$k]['size'] ) ) {
301 $size = $defcfg[$k]['size'];
305 } else if ( $l == 'true' ) {
307 $type = SMOPT_TYPE_BOOLEAN
;
308 } else if ( $l == 'false' ) {
310 $type = SMOPT_TYPE_BOOLEAN
;
311 } else if ( $v{0} == "'" ) {
312 $type = SMOPT_TYPE_STRING
;
313 } else if ( $v{0} == '"' ) {
314 $type = SMOPT_TYPE_STRING
;
317 if ( substr( $k, 0, 7 ) == '$theme[' ) {
318 $type = SMOPT_TYPE_THEME
;
319 } else if ( substr( $k, 0, 9 ) == '$plugins[' ) {
320 $type = SMOPT_TYPE_PLUGINS
;
321 } else if ( substr( $k, 0, 13 ) == '$ldap_server[' ) {
322 $type = SMOPT_TYPE_LDAP
;
325 if ( $type == SMOPT_TYPE_TITLE ||
$colapse[$act_grp] == 'off' ) {
328 case SMOPT_TYPE_LDAP
:
329 case SMOPT_TYPE_PLUGINS
:
330 case SMOPT_TYPE_THEME
:
331 case SMOPT_TYPE_HIDDEN
:
333 case SMOPT_TYPE_EXTERNAL
:
334 echo "<tr><td>$name</td><td><b>" .
335 $defcfg[$k]['value'] .
338 case SMOPT_TYPE_TITLE
:
339 if ( $colapse[$k] == 'on' ) {
344 echo '<tr bgcolor="'.$color[0].'"><th colspan="2">'.
345 "<a href=\"options.php?switch=$k\" style=\"text-decoration:none\">".
346 '<b>'.$sw.'</b></a> '.$name.'</th></tr>';
349 case SMOPT_TYPE_COMMENT
:
350 $v = substr( $v, 1, strlen( $v ) - 2 );
351 echo "<tr><td>$name</td><td>".
353 $newcfg[$k] = "'$v'";
354 if ( isset( $defcfg[$k]['comment'] ) ) {
355 echo ' ' . $defcfg[$k]['comment'];
359 case SMOPT_TYPE_INTEGER
:
360 /* look for variable $e in POST, fill into $v */
361 if ( sqgetGlobalVar($e, $new_v, SQ_POST
) ) {
362 $v = intval( $new_v );
365 echo "<tr><td>$name</td><td>".
366 "<input size=\"10\" name=\"adm_$n\" value=\"$v\" />";
367 if ( isset( $defcfg[$k]['comment'] ) ) {
368 echo ' ' . $defcfg[$k]['comment'];
372 case SMOPT_TYPE_NUMLIST
:
373 if ( sqgetGlobalVar($e, $new_v, SQ_POST
) ) {
377 echo "<tr><td>$name</td><td>";
378 echo "<select name=\"adm_$n\">";
379 foreach ( $defcfg[$k]['posvals'] as $kp => $vp ) {
380 echo "<option value=\"$kp\"";
382 echo ' selected="selected"';
384 echo ">$vp</option>";
387 if ( isset( $defcfg[$k]['comment'] ) ) {
388 echo ' ' . $defcfg[$k]['comment'];
392 case SMOPT_TYPE_STRLIST
:
393 if ( sqgetGlobalVar($e, $new_v, SQ_POST
) ) {
394 $v = '"' . $new_v . '"';
397 echo "<tr><td>$name</td><td>".
398 "<select name=\"adm_$n\">";
399 foreach ( $defcfg[$k]['posvals'] as $kp => $vp ) {
400 echo "<option value=\"$kp\"";
401 if ( $kp == substr( $v, 1, strlen( $v ) - 2 ) ) {
402 echo ' selected="selected"';
404 echo ">$vp</option>";
407 if ( isset( $defcfg[$k]['comment'] ) ) {
408 echo ' ' . $defcfg[$k]['comment'];
413 case SMOPT_TYPE_TEXTAREA
:
414 if ( sqgetGlobalVar($e, $new_v, SQ_POST
) ) {
415 $v = '"' . $new_v . '"';
416 $newcfg[$k] = str_replace( "\n", '', $v );
418 echo "<tr><td valign=\"top\">$name</td><td>".
419 "<textarea cols=\"$size\" rows=\"4\" name=\"adm_$n\">" . substr( $v, 1, strlen( $v ) - 2 ) . "</textarea>";
420 if ( isset( $defcfg[$k]['comment'] ) ) {
421 echo ' ' . $defcfg[$k]['comment'];
425 case SMOPT_TYPE_STRING
:
426 if ( sqgetGlobalVar($e, $new_v, SQ_POST
) ) {
427 $v = '"' . $new_v . '"';
430 if ( $v == '""' && isset( $defcfg[$k]['default'] ) ) {
431 $v = "'" . $defcfg[$k]['default'] . "'";
434 echo "<tr><td>$name</td><td>".
435 "<input size=\"$size\" name=\"adm_$n\" value=\"" . substr( $v, 1, strlen( $v ) - 2 ) . '" />';
436 if ( isset( $defcfg[$k]['comment'] ) ) {
437 echo ' ' . $defcfg[$k]['comment'];
441 case SMOPT_TYPE_BOOLEAN
:
442 if ( sqgetGlobalVar($e, $new_v, SQ_POST
) ) {
446 $v = strtoupper( $v );
448 if ( $v == 'TRUE' ) {
449 $ct = ' checked="checked"';
453 $cf = ' checked="checked"';
455 echo "<tr><td>$name</td><td>" .
456 "<input$ct type=\"radio\" name=\"adm_$n\" value=\"TRUE\" />" . _("Yes") .
457 "<input$cf type=\"radio\" name=\"adm_$n\" value=\"FALSE\" />" . _("No");
458 if ( isset( $defcfg[$k]['comment'] ) ) {
459 echo ' ' . $defcfg[$k]['comment'];
463 case SMOPT_TYPE_PATH
:
464 if ( sqgetGlobalVar($e, $new_v, SQ_POST
) ) {
465 // FIXME: fix use of $data_dir in $attachment_dir
466 $v = change_to_sm_path($new_v);
469 if ( $v == "''" && isset( $defcfg[$k]['default'] ) ) {
470 $v = change_to_sm_path($defcfg[$k]['default']);
473 echo "<tr><td>$name</td><td>".
474 "<input size=\"$size\" name=\"adm_$n\" value=\"" . change_to_rel_path($v) . '" />';
475 if ( isset( $defcfg[$k]['comment'] ) ) {
476 echo ' ' . $defcfg[$k]['comment'];
481 echo "<tr><td>$name</td><td>" .
483 if ( isset( $defcfg[$k]['comment'] ) ) {
484 echo ' ' . $defcfg[$k]['comment'];
491 /* Special Themes Block */
492 if ( $colapse['Group7'] == 'off' ) {
494 echo '<tr><th>' . _("Theme Name") .
495 '</th><th>' . _("Theme Path") .
497 while ( isset( $newcfg["\$theme[$i]['NAME']"] ) ) {
498 $k1 = "\$theme[$i]['NAME']";
499 $e1 = "theme_name_$i";
500 if ( sqgetGlobalVar($e, $v1, SQ_POST
) ) {
501 $v1 = '"' . str_replace( '\"', '"', $v1 ) . '"';
502 $v1 = '"' . str_replace( '"', '\"', $v1 ) . '"';
507 $k2 = "\$theme[$i]['PATH']";
508 $e2 = "theme_path_$i";
509 if ( sqgetGlobalVar($e, $v2, SQ_POST
) ) {
510 $v2 = change_to_sm_path($v2);
515 $name = substr( $v1, 1, strlen( $v1 ) - 2 );
516 $path = change_to_rel_path($v2);
518 "<td align=\"right\">$i. <input name=\"$e1\" value=\"$name\" size=\"30\" /></td>".
519 "<td><input name=\"$e2\" value=\"$path\" size=\"40\" /></td>".
526 /* Special Plugins Block */
527 if ( $colapse['Group8'] == 'on' ) {
532 echo '<tr bgcolor="'.$color[0].'"><th colspan="2">'.
533 '<a href="options.php?switch=Group8" style="text-decoration:none"><b>'.
534 $sw.'</b></a> '._("Plugins").'</th></tr>';
536 if ( $colapse['Group8'] == 'off' ) {
538 $plugpath = SM_PATH
. 'plugins/';
539 if ( file_exists($plugpath) ) {
540 $fd = opendir( $plugpath );
541 $op_plugin = array();
543 while (false !== ($file = readdir($fd))) {
544 if ($file != '.' && $file != '..' && $file != 'CVS' && is_dir($plugpath . $file) ) {
545 $op_plugin[] = $file;
552 /* Lets get the plugins that are active */
554 if ( sqgetGlobalVar('plg', $v, SQ_POST
) ) {
555 foreach ( $op_plugin as $plg ) {
556 if ( sqgetGlobalVar("plgs_$plg", $v2, SQ_POST
) && $v2 == 'on' ) {
561 foreach ( $plugins as $plg ) {
562 $k = "\$plugins[$i]";
563 $newcfg[$k] = "'$plg'";
566 while ( isset( $newcfg["\$plugins[$i]"] ) ) {
567 $k = "\$plugins[$i]";
573 while ( isset( $newcfg["\$plugins[$i]"] ) ) {
574 $k = "\$plugins[$i]";
576 $plugins[] = substr( $v, 1, strlen( $v ) - 2 );
580 echo '<tr><td colspan="2"><input type="hidden" name="plg" value="on" /><center><table>';
581 foreach ( $op_plugin as $plg ) {
582 if ( in_array( $plg, $plugins ) ) {
583 $sw = ' checked="checked"';
588 if (file_exists(SM_PATH
. "plugins/$plg/README")) {
589 echo "<a href=\"../$plg/README\" target=\"_blank\">$plg</a>";
594 "<td><input$sw type=\"checkbox\" name=\"plgs_$plg\" /></td>".
597 echo '</table></center></td></tr>';
599 echo '<tr><td colspan="2" align="center">'.
600 sprintf(_("Plugin directory could not be found: %s"), $plugpath).
604 echo '<tr bgcolor="'.$color[5].'"><th colspan="2"><input value="'.
605 _("Change Settings").'" type="submit" /><br />'.
606 '<a href="'.SM_PATH
.'src/configtest.php" target="_blank">'.
607 _("Test Configuration")."</a></th></tr>\n".
608 '</table></td></tr></table></center></form>';
611 Write the options to the file.
614 if ( $fp = @fopen
( $cfgfile, 'w' ) ) {
615 fwrite( $fp, "<?php\n".
617 " * SquirrelMail Configuration File\n".
618 " * Created using the Administrator Plugin\n".
621 "global \$version;\n" );
623 foreach ( $newcfg as $k => $v ) {
624 if ( $k{0} == '$' && $v <> '' ||
is_int($v)) {
625 if ( substr( $k, 1, 11 ) == 'ldap_server' ) {
626 $v = substr( $v, 0, strlen( $v ) - 1 ) . "\n)";
627 $v = str_replace( 'array(', "array(\n\t", $v );
628 $v = str_replace( "',", "',\n\t", $v );
630 /* FIXME: add elseif that reverts plugins[#] to plugins[] */
631 fwrite( $fp, "$k = $v;\n" );
634 // add local config support
635 fwrite( $fp, "@include SM_PATH . 'config/config_local.php';\n" );
640 echo '<br /><p align="center"><big>'.
641 _("Config file can't be opened. Please check config.php.").