<?php
-
/**
* options_order.php
*
- * Copyright (c) 1999-2001 The SquirrelMail Development Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
- * Displays message highlighting options
+ * Displays messagelist column order options
*
- * $Id$
+ * @copyright © 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage prefs
*/
-/*****************************************************************/
-/*** THIS FILE NEEDS TO HAVE ITS FORMATTING FIXED!!! ***/
-/*** PLEASE DO SO AND REMOVE THIS COMMENT SECTION. ***/
-/*** + Base level indent should begin at left margin, as ***/
-/*** the require_once below looks. ***/
-/*** + All identation should consist of four space blocks ***/
-/*** + Tab characters are evil. ***/
-/*** + all comments should use "slash-star ... star-slash" ***/
-/*** style -- no pound characters, no slash-slash style ***/
-/*** + FLOW CONTROL STATEMENTS (if, while, etc) SHOULD ***/
-/*** ALWAYS USE { AND } CHARACTERS!!! ***/
-/*** + Please use ' instead of ", when possible. Note " ***/
-/*** should always be used in _( ) function calls. ***/
-/*** Thank you for your help making the SM code more readable. ***/
-/*****************************************************************/
-
-require_once('../src/validate.php');
-require_once('../functions/display_messages.php');
-require_once('../functions/imap.php');
-require_once('../functions/array.php');
-require_once('../functions/plugin.php');
-
-
- if (! isset($action)) { $action = ''; }
- if ($action == 'delete' && isset($theid)) {
- removePref($data_dir, $username, "highlight$theid");
- } else if ($action == 'save') {
- }
- displayPageHeader($color, 'None');
-?>
- <br>
-<table width=95% align=center border=0 cellpadding=2 cellspacing=0>
-<tr><td align="center" bgcolor="<?php echo $color[0] ?>">
-
- <b><?php echo _("Options") . " - " . _("Index Order"); ?></b>
-
- <table width="100%" border="0" cellpadding="1" cellspacing="1">
- <tr><td bgcolor="<?php echo $color[4] ?>" align="center"><br>
-
- <table width=100% cellpadding=2 cellspacing=0 border=0>
-<?php
+/** This is the options_order page */
+define('PAGE_NAME', 'options_order');
- $available[1] = _("Checkbox");
- $available[2] = _("From");
- $available[3] = _("Date");
- $available[4] = _("Subject");
- $available[5] = _("Flags");
- $available[6] = _("Size");
-
- if (! isset($method)) { $method = ''; }
-
- if ($method == 'up' && $num > 1) {
- $prev = $num-1;
- $tmp = $index_order[$prev];
- $index_order[$prev] = $index_order[$num];
- $index_order[$num] = $tmp;
- } else if ($method == 'down' && $num < count($index_order)) {
- $next = $num++;
- $tmp = $index_order[$next];
- $index_order[$next] = $index_order[$num];
- $index_order[$num] = $tmp;
- } else if ($method == 'remove' && $num) {
- for ($i=1; $i < 8; $i++) {
- removePref($data_dir, $username, "order$i");
- }
- for ($j=1,$i=1; $i <= count($index_order); $i++) {
- if ($i != $num) {
- $new_ary[$j] = $index_order[$i];
- $j++;
- }
- }
- $index_order = array();
- $index_order = $new_ary;
- if (count($index_order) < 1) {
- include_once('../src/load_prefs.php');
- }
- } else if ($method == 'add' && $add) {
- // User should not be able to insert PHP-code here
- $add = str_replace ('<?', '..', $add);
- $add = ereg_replace ('<.*script.*language.*php.*>', '..', $add);
- $add = str_replace ('<%', '..', $add);
- $index_order[count($index_order)+1] = $add;
+/**
+ * Include the SquirrelMail initialization file.
+ */
+require('../include/init.php');
+
+/* SquirrelMail required files. */
+require_once(SM_PATH . 'functions/forms.php');
+
+/* get globals */
+if (sqgetGlobalVar('num', $num, SQ_GET)) {
+ $num = (int) $num;
+} else {
+ $num = false;
+}
+if (!sqgetGlobalVar('method', $method)) {
+ $method = '';
+} else {
+ $method = htmlspecialchars($method);
+}
+if (!sqgetGlobalVar('positions', $pos, SQ_GET)) {
+ $pos = 0;
+} else {
+ $pos = (int) $pos;
+}
+
+if (!sqgetGlobalVar('account', $account, SQ_GET)) {
+ $iAccount = 0;
+} else {
+ $iAccount = (int) $account;
+}
+
+if (sqgetGlobalVar('mailbox', $mailbox, SQ_GET)) {
+ $aMailboxPrefs = unserialize(getPref($data_dir, $username, "pref_".$iAccount.'_'.$mailbox));
+ if (isset($aMailboxPrefs[MBX_PREF_COLUMNS])) {
+ $index_order = $aMailboxPrefs[MBX_PREF_COLUMNS];
}
+} else {
+ $index_order_ser = getPref($data_dir, $username, 'index_order');
+ if ($index_order_ser) {
+ $index_order=unserialize($index_order_ser);
+ }
+}
+if (!isset($index_order)) {
+ if (isset($internal_date_sort) && $internal_date_sort == false) {
+ $index_order = array(SQM_COL_CHECK,SQM_COL_FROM,SQM_COL_DATE,SQM_COL_FLAGS,SQM_COL_ATTACHMENT,SQM_COL_PRIO,SQM_COL_SUBJ);
+ } else {
+ $index_order = array(SQM_COL_CHECK,SQM_COL_FROM,SQM_COL_INT_DATE,SQM_COL_FLAGS,SQM_COL_ATTACHMENT,SQM_COL_PRIO,SQM_COL_SUBJ);
+ }
+}
+
+if (!sqgetGlobalVar('account', $account, SQ_GET)) {
+ $account = 0; // future work, multiple imap accounts
+} else {
+ $account = (int) $account;
+}
+
+/* end of get globals */
+
+/***************************************************************/
+/* Finally, display whatever page we are supposed to show now. */
+/***************************************************************/
+
+displayPageHeader($color, null, (isset($optpage_data['xtra']) ? $optpage_data['xtra'] : ''));
- if ($method) {
- for ($i=1; $i <= count($index_order); $i++) {
- setPref($data_dir, $username, "order$i", $index_order[$i]);
- }
- }
- echo '<table cellspacing="0" cellpadding="0" border="0" width="65%"><tr><td>' . "\n";
- echo _("The index order is the order that the columns are arranged in the message index. You can add, remove, and move columns around to customize them to fit your needs.");
- echo '</td></tr></table><br>';
-
- if (count($index_order))
- {
- echo '<table cellspacing="0" cellpadding="0" border="0">' . "\n";
- for ($i=1; $i <= count($index_order); $i++) {
- $tmp = $index_order[$i];
- echo '<tr>';
- echo "<td><small><a href=\"options_order.php?method=up&num=$i\">". _("up") ."</a></small></td>\n";
- echo '<td><small> | </small></td>' . "\n";
- echo "<td><small><a href=\"options_order.php?method=down&num=$i\">". _("down") . "</a></small></td>\n";
- echo '<td><small> | </small></td>' . "\n";
- echo '<td>';
- // Always show the subject
- if ($tmp != 4)
- echo "<small><a href=\"options_order.php?method=remove&num=$i\">" . _("remove") . '</a></small>';
- echo "</td>\n";
- echo '<td><small> - </small></td>' . "\n";
- echo '<td>' . $available[$tmp] . "</td>\n";
- echo "</tr>\n";
- }
- echo "</table>\n";
- }
-
- if (count($index_order) != count($available)) {
- echo '<form name="f" method="post" action="options_order.php">';
- echo '<select name="add">';
- for ($i=1; $i <= count($available); $i++) {
- $found = false;
- for ($j=1; $j <= count($index_order); $j++) {
- if ($index_order[$j] == $i) {
- $found = true;
- }
- }
- if (!$found) {
- echo "<option value=\"$i\">$available[$i]</option>";
+
+/**
+ * Change the column order of a mailbox
+ *
+ * @param array $index_order (reference) contains an ordered list with columns
+ * @param string $method action to take, move, add and remove are supported
+ * @param int $num target column
+ * @param int $pos positions to move a column in the index_order array
+ * @return bool $r A change in the ordered list took place.
+ */
+function change_columns_list(&$index_order,$method,$num,$pos=0) {
+ $r = false;
+ switch ($method) {
+ case 'move': $r = sqm_array_move_value($index_order,$num,$pos); break;
+ case 'add':
+ $index_order[] = (int) $num;
+ $r = true;
+ /**
+ * flush the cache in order to retrieve the new columns
+ */
+ sqsession_unregister('mailbox_cache');
+ break;
+ case 'remove':
+ if(in_array($num, $index_order)) {
+ unset($index_order[array_search($num, $index_order)]);
+ $index_order = array_values($index_order);
+ $r = true;
+ }
+ break;
+ default: break;
+ }
+ return $r;
+}
+
+/**
+ * Column to string translation array
+ */
+$available[SQM_COL_CHECK] = _("Checkbox");
+$available[SQM_COL_FROM] = _("From");
+$available[SQM_COL_DATE] = _("Date");
+$available[SQM_COL_SUBJ] = _("Subject");
+$available[SQM_COL_FLAGS] = _("Flags");
+$available[SQM_COL_SIZE] = _("Size");
+$available[SQM_COL_PRIO] = _("Priority");
+$available[SQM_COL_ATTACHMENT] = _("Attachments");
+$available[SQM_COL_INT_DATE] = _("Received");
+$available[SQM_COL_TO] = _("To");
+$available[SQM_COL_CC] = _("Cc");
+$available[SQM_COL_BCC] = _("Bcc");
+
+if (change_columns_list($index_order,$method,$num,$pos)) {
+ if ($method) {
+ // TODO, bound index_order to mailbox and make a difference between the global index_order and mailbox bounded index_order
+ setPref($data_dir, $username, 'index_order', serialize($index_order));
+ }
+}
+
+
+$opts = array();
+if (count($index_order) != count($available)) {
+ for ($i=0; $i < count($available); $i++) {
+ if (!in_array($i,$index_order)) {
+ $opts[$i] = $available[$i];
}
- }
- echo '</select>';
- echo '<input type="hidden" value="add" name="method">';
- echo '<input type="submit" value="'._("Add").'" name="submit">';
- echo '</form>';
- }
+ }
+}
+
+// FIXME: why are we using this? $PHP_SELF is already a global var processed (and therefore trustworthy) by init.php
+sqgetGlobalVar('PHP_SELF', $PHP_SELF, SQ_SERVER);
+$x = isset($mailbox) && $mailbox ? '&mailbox='.urlencode($mailbox) : '';
- echo '<p><a href="../src/options.php">' . _("Return to options page") . '</a></p><br>';
+$oTemplate->assign('fields', $available);
+$oTemplate->assign('current_order', $index_order);
+$oTemplate->assign('not_used', $opts);
+$oTemplate->assign('always_show', array(SQM_COL_SUBJ, SQM_COL_FLAGS));
-?>
- </td></tr>
- </table>
+// FIXME: (related to the above) $PHP_SELF might already have a query string... don't assume otherwise here by adding the ? sign!!
+$oTemplate->assign('move_up', $PHP_SELF .'?method=move&positions=-1'. $x .'&num=');
+$oTemplate->assign('move_down', $PHP_SELF .'?method=move&positions=1'. $x .'&num=');
+$oTemplate->assign('remove', $PHP_SELF .'?method=remove'. $x .'&num=');
+$oTemplate->assign('add', $PHP_SELF.'?method=add'.$x.'&num=');
+$oTemplate->assign('addField_action', $PHP_SELF);
- </td></tr>
- </table>
+$oTemplate->display('options_order.tpl');
-</td></tr>
-</table>
-</body></html>
+$oTemplate->display('footer.tpl');