Initial groundwork to use phpdocumentor.
[squirrelmail.git] / plugins / delete_move_next / setup.php
index 293cd35b440b1f8e17a84b494756f582ec8c59b7..8c8c306809dc5f95fba1f4126b3bbedf6b43012a 100644 (file)
@@ -7,19 +7,25 @@
  *   deletes or moves currently displayed message and displays
  *   next or previous message.
  *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Copyright (c) 1999-2003 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * $Id$
+ * @package plugins
+ * @subpackage delete_move_next
  */
 
+/**
+ * Initialize the plugin
+ * @return void
+ */
 function squirrelmail_plugin_init_delete_move_next() {
     global $squirrelmail_plugin_hooks;
-    
+
     $squirrelmail_plugin_hooks['html_top']['delete_move_next'] = 'delete_move_next_action';
     $squirrelmail_plugin_hooks['right_main_after_header']['delete_move_next'] = 'delete_move_next_action';
     $squirrelmail_plugin_hooks['read_body_bottom']['delete_move_next'] = 'delete_move_next_read_b';
-    $squirrelmail_plugin_hooks['read_body_top']['delete_move_next'] = 'delete_move_next_read_t';
+    $squirrelmail_plugin_hooks['read_body_menu_bottom']['delete_move_next'] = 'delete_move_next_read_t';
     $squirrelmail_plugin_hooks['options_display_inside']['delete_move_next'] = 'delete_move_next_display_inside';
     $squirrelmail_plugin_hooks['options_display_save']['delete_move_next'] = 'delete_move_next_display_save';
     $squirrelmail_plugin_hooks['loading_prefs']['delete_move_next'] = 'delete_move_next_loading_prefs';
@@ -32,13 +38,26 @@ function squirrelmail_plugin_init_delete_move_next() {
 
 function fix_sort_array () {
     global $username, $data_dir, $allow_server_sort, $allow_thread_sort,
-    $mailbox, $imapConnection, $sort;
-    if ($allow_server_sort == true) {
-        $server_sort_array = sqimap_get_sort_order($imapConnection, $sort);
+    $thread_sort_messages, 
+    $mailbox, $imapConnection, $sort, $uid_support, $mbx_response;
+    
+    // Got to grab this out of prefs, since it isn't saved from mailbox_view.php
+    if ($allow_thread_sort) {
+        $thread_sort_messages = getPref($data_dir, $username, "thread_$mailbox",0); 
     }
-    $thread_sort_messages = getPref($username, $data_dir, "thread_$mailbox");
-    if ($allow_thread_sort == true && $thread_sort_messages == 1) {
-        $server_sort_array = get_thread_sort($imapConnection);
+    
+    switch (true) {
+      case ($allow_thread_sort && $thread_sort_messages):
+          $server_sort_array = get_thread_sort($imapConnection);
+          break;
+      case ($allow_server_sort):
+          $server_sort_array = sqimap_get_sort_order($imapConnection, $sort, $mbx_response);
+          break;
+      case ($uid_support):
+          $server_sort_array = sqimap_get_php_sort_order($imapConnection, $mbx_response);
+          break;
+      default:
+          break;
     }
 }
 
@@ -53,19 +72,18 @@ function fix_sort_array () {
 
 function delete_move_del_arr_elem($arr, $index) {
     $tmp = array();
-    $lim = count($arr);
     $j = 0;
-    for ($i = 0; $i < $lim; $i++) {
-        if ($i != $index) {
-            $tmp[$j++] = $arr[$i];
-        }
+    foreach ($arr as $v) {
+        if ($j != $index) {
+           $tmp[] = $v;
+         }
+         $j++;
     }
     return $tmp;
 }
 
 function delete_move_show_msg_array() {
     global $msort, $msgs;
-    
     $keys = array_keys($msort);
     for ($i = 0; $i < count($keys); $i++) {
         echo '<p>key ' . $keys[$i] . ' msgid ' . $msgs[$keys[$i]]['ID'] . '</p>';
@@ -74,22 +92,20 @@ function delete_move_show_msg_array() {
 
 
 function delete_move_expunge_from_all($id) {
-    global $msgs, $msort, $sort, $imapConnection, $mailbox;
-    
-    // delete_move_show_msg_array();
-    
+    global $msgs, $msort, $sort, $imapConnection, $mailbox, $uid_support;
     $delAt = -1;
     for ($i = 0; $i < count($msort); $i++) {
         if ($msgs[$i]['ID'] == $id) {
             $delAt = $i;
         } elseif ($msgs[$i]['ID'] > $id) {
-            $msgs[$i]['ID']--;
+            if (!$uid_support) {
+               $msgs[$i]['ID']--;
+            }
         }
     }
-    
+
     $msgs = delete_move_del_arr_elem($msgs, $delAt);
     $msort = delete_move_del_arr_elem($msort, $delAt);
-    
     if ($sort < 6) {
         if ($sort % 2) {
             asort($msort);
@@ -97,19 +113,31 @@ function delete_move_expunge_from_all($id) {
             arsort($msort);
         }
     }
-    
+    sqsession_register($msgs, 'msgs');
+    sqsession_register($msort, 'msort');
+
     sqimap_mailbox_expunge($imapConnection, $mailbox, true);
 }
 
 function delete_move_next_action() {
 
-    global $PHP_SELF,
-           $delete_id, $move_id;
+    global $PHP_SELF;
+
+    if ( !check_php_version(4,1) ) {
+        global $_GET, $_POST;
+    }
+
+    if (isset($_GET['delete_id'])) {
+        $delete_id = $_GET['delete_id'];
+    }
+    if (isset($_POST['move_id'])) {
+        $move_id = $_POST['move_id'];
+    }       
 
-    if ($delete_id) {
+    if (isset($delete_id)) {
         delete_move_next_delete();
         fix_sort_array();
-    } elseif ($move_id) {
+    } elseif (isset($move_id)) {
         delete_move_next_move();
         fix_sort_array();
     }
@@ -138,40 +166,35 @@ function delete_move_next_read_b() {
 function delete_move_next_read($currloc) {
     global $delete_move_next_formATtop, $delete_move_next_formATbottom,
            $color, $where, $what, $currentArrayIndex, $passed_id,
-           $urlMailbox, $sort, $startMessage, $delete_id, $move_id,
-           $imapConnection, $auto_expunge, $move_to_trash;
+           $mailbox, $sort, $startMessage, $delete_id, $move_id,
+           $imapConnection, $auto_expunge, $move_to_trash, $mbx_response,
+           $uid_support, $passed_ent_id;
+
+    $urlMailbox = urlencode($mailbox);
+
+    if (!isset($passed_ent_id)) $passed_ent_id = 0;
 
-    if (!(($where && $what) || ($currentArrayIndex == -1))) {
-        $next = findNextMessage();
-        $prev = findPreviousMessage();
+    if (!(($where && $what) || ($currentArrayIndex == -1)) && !$passed_ent_id) {
+        $next = findNextMessage($passed_id);
+        $prev = findPreviousMessage($mbx_response['EXISTS'], $passed_id);
         $prev_if_del = $prev;
         $next_if_del = $next;
-        if ($auto_expunge || $move_to_trash) {
+        if (!$uid_support && ($auto_expunge || $move_to_trash)) {
             if ($prev_if_del > $passed_id) {
                 $prev_if_del--;
             }
             if ($next_if_del > $passed_id) {
                 $next_if_del--;
             }
-        }    
-        
-       /* Base is illegal within documents 
+        }
+
+        /* Base is illegal within documents 
         * $location = get_location();
         * echo "<base href=\"$location/\">" . */
         echo '<table cellspacing=0 width="100%" border=0 cellpadding=2>'.
              '<tr>'.
                  "<td bgcolor=\"$color[9]\" width=\"100%\" align=center><small>";
-    
-        if ($prev > 0) {
-            echo "<a href=\"read_body.php?passed_id=$prev&amp;mailbox=$urlMailbox&amp;sort=$sort&amp;startMessage=$startMessage&amp;show_more=0\">" . _("Previous") . "</A>&nbsp;|&nbsp;\n";
-        } else {
-            echo _("Previous") . "&nbsp;|&nbsp;";
-        }
-        if ($next > 0) {
-            echo "<a href=\"read_body.php?passed_id=$next&amp;mailbox=$urlMailbox&amp;sort=$sort&amp;startMessage=$startMessage&amp;show_more=0\">" . _("Next") . "</A>&nbsp;|&nbsp;\n";
-        } else {
-            echo _("Next") . "&nbsp;|&nbsp;";
-        }
+
         if ($prev > 0){
             echo "<a href=\"read_body.php?passed_id=$prev_if_del&amp;mailbox=$urlMailbox&amp;sort=$sort&amp;startMessage=$startMessage&amp;show_more=0&amp;delete_id=$passed_id\">" . _("Delete & Prev") . "</a>" . "&nbsp;|&nbsp;\n";
         }
@@ -184,18 +207,18 @@ function delete_move_next_read($currloc) {
             echo _("Delete & Next");
         }
         echo '</small></td></tr>';
-        
+
         if ($next_if_del < 0) {
             $next_if_del = $prev_if_del;
         }
-        if (($delete_move_next_formATtop == 'on') && ($currloc == 'top')){
+        if (($delete_move_next_formATtop == 'on') && ($currloc == 'top')) {
             if ($next_if_del > 0) {
                 delete_move_next_moveNextForm($next_if_del);
             } else {
                 delete_move_next_moveRightMainForm();
             }
         }
-        if (($delete_move_next_formATbottom != 'off') && ($currloc == 'bottom')){
+        if (($delete_move_next_formATbottom != 'off') && ($currloc == 'bottom')) {
             if ($next_if_del > 0) {
                 delete_move_next_moveNextForm($next_if_del);
             } else {
@@ -207,32 +230,26 @@ function delete_move_next_read($currloc) {
 }
 
 function get_move_target_list() {
-    global $imapConnection;
-    
-    $boxes = sqimap_mailbox_list($imapConnection);
-    for ($i = 0; $i < count($boxes); $i++) {  
-        if (!in_array('noselect', $boxes[$i]['flags'])) {
-            $box = $boxes[$i]['unformatted'];
-            $box2 = str_replace(' ', '&nbsp;', $boxes[$i]['unformatted-disp']);
-            if ( $box2 == 'INBOX' ) {
-                $box2 = _("INBOX");
-            }
-            echo "<option value=\"$box\">$box2</option>\n";
-        }
+    global $imapConnection, $lastTargetMailbox;
+    if (isset($lastTargetMailbox) && !empty($lastTargetMailbox)) {
+        echo sqimap_mailbox_option_list($imapConnection, array(strtolower($lastTargetMailbox)));
+    }
+    else {
+        echo sqimap_mailbox_option_list($imapConnection);
     }
 }
 
 function delete_move_next_moveNextForm($next) {
 
     global $color, $where, $what, $currentArrayIndex, $passed_id,
-           $urlMailbox, $sort, $startMessage, $delete_id, $move_id,
+           $mailbox, $sort, $startMessage, $delete_id, $move_id,
            $imapConnection;
 
     echo '<tr>'.
          "<td bgcolor=\"$color[9]\" width=\"100%\" align=\"center\">".
            '<form action="read_body.php" method="post"><small>'.
             "<input type=\"hidden\" name=\"passed_id\" value=\"$next\">".
-            "<input type=\"hidden\" name=\"mailbox\" value=\"$urlMailbox\">".
+            "<input type=\"hidden\" name=\"mailbox\" value=\"".$mailbox."\">".
             "<input type=\"hidden\" name=\"sort\" value=\"$sort\">".
             "<input type=\"hidden\" name=\"startMessage\" value=\"$startMessage\">".
             "<input type=\"hidden\" name=\"show_more\" value=\"0\">".
@@ -251,13 +268,13 @@ function delete_move_next_moveNextForm($next) {
 function delete_move_next_moveRightMainForm() {
 
     global $color, $where, $what, $currentArrayIndex, $passed_id,
-           $urlMailbox, $sort, $startMessage, $delete_id, $move_id,
+           $mailbox, $sort, $startMessage, $delete_id, $move_id,
            $imapConnection;
 
-    echo '<tr>' .      
+    echo '<tr>' .
             "<td bgcolor=\"$color[9]\" width=\"100%\" align=\"center\">".
             '<form action="right_main.php" method="post"><small>' .
-            "<input type=\"hidden\" name=\"mailbox\" value=\"$urlMailbox\">".
+            "<input type=\"hidden\" name=\"mailbox\" value=\"".$mailbox."\">".
             "<input type=\"hidden\" name=\"sort\" value=\"$sort\">".
             "<input type=\"hidden\" name=\"startMessage\" value=\"$startMessage\">".
             "<input type=\"hidden\" name=\"move_id\" value=\"$passed_id\">".
@@ -275,54 +292,74 @@ function delete_move_next_moveRightMainForm() {
 
 
 function delete_move_next_delete() {
-    global $imapConnection, $delete_id, $mailbox, $auto_expunge;
-    
+    global $imapConnection, $auto_expunge;
+
+    if ( !check_php_version(4,1) ) {
+        global $_GET;
+    }
+
+    $delete_id = $_GET['delete_id'];
+    $mailbox = $_GET['mailbox'];
+
     sqimap_messages_delete($imapConnection, $delete_id, $delete_id, $mailbox);
-    if ($auto_expunge){
+    if ($auto_expunge) {
         delete_move_expunge_from_all($delete_id);
-        // sqimap_mailbox_expunge($imapConnection, $mailbox, true);    
+        // sqimap_mailbox_expunge($imapConnection, $mailbox, true);
     }
 }
 
 function delete_move_next_move() {
-    global $imapConnection, $move_id, $targetMailbox, $auto_expunge, $mailbox;
-    
+    global $imapConnection, $mailbox, $auto_expunge, $lastTargetMailbox;
+
+    if ( !check_php_version(4,1) ) {
+        global $_POST;
+    }
+
+    $move_id = $_POST['move_id'];
+    $mailbox = $_POST['mailbox'];
+    $targetMailbox = $_POST['targetMailbox'];
+
     // Move message
     sqimap_messages_copy($imapConnection, $move_id, $move_id, $targetMailbox);
-    sqimap_messages_flag($imapConnection, $move_id, $move_id, 'Deleted');
+    sqimap_messages_flag($imapConnection, $move_id, $move_id, 'Deleted', true);
     if ($auto_expunge) {
         delete_move_expunge_from_all($move_id);
         // sqimap_mailbox_expunge($imapConnection, $mailbox, true);
     }
+
+    if ($targetMailbox != $lastTargetMailbox) {
+        $lastTargetMailbox = $targetMailbox;
+        sqsession_register('lastTargetMailbox' , $lastTargetMailbox);
+    }
 }
 
 function delete_move_next_display_inside() {
     global $username,$data_dir,
         $delete_move_next_t, $delete_move_next_formATtop,
         $delete_move_next_b, $delete_move_next_formATbottom;
-    
+
     echo "<tr><td align=right valign=top>\n".
          _("Delete/Move/Next Buttons:") . "</td>\n".
          "<td><input type=checkbox name=delete_move_next_ti";
-         
+
     if ($delete_move_next_t == 'on') {
         echo " checked";
     }
     echo '> ' . _("Display at top").
          " <input type=checkbox name=delete_move_next_formATtopi";
-         
+
     if ($delete_move_next_formATtop == 'on') {
         echo ' checked';
     }
-    echo '> ' . _("with move option") . '<br>';    
-    
+    echo '> ' . _("with move option") . '<br>';
+
     echo '<input type=checkbox name=delete_move_next_bi';
     if($delete_move_next_b != 'off') {
         echo ' checked';
     }
     echo '> ' . _("Display at bottom") .
          '<input type=checkbox name=delete_move_next_formATbottomi';
-         
+
     if ($delete_move_next_formATbottom != 'off') {
         echo ' checked';
     }
@@ -332,29 +369,44 @@ function delete_move_next_display_inside() {
 
 function delete_move_next_display_save() {
 
-    global $username,$data_dir,
-           $delete_move_next_ti, $delete_move_next_formATtopi,
-           $delete_move_next_bi, $delete_move_next_formATbottomi;
-    
+    global $username,$data_dir;
+
+    if ( !check_php_version(4,1) ) {
+        global $_POST;
+    }
+
+    if (isset($_POST['delete_move_next_ti'])) {
+        $delete_move_next_ti = $_POST['delete_move_next_ti'];
+    }
+    if (isset($_POST['delete_move_next_bi'])) {
+        $delete_move_next_bi = $_POST['delete_move_next_bi'];
+    }
+    if (isset($_POST['delete_move_next_formATtopi'])) {
+        $delete_move_next_formATtopi = $_POST['delete_move_next_formATtopi'];
+    }
+    if (isset($_POST['delete_move_next_formATbottomi'])) {
+        $delete_move_next_formATbottomi = $_POST['delete_move_next_formATbottomi'];
+    }
+
     if (isset($delete_move_next_ti)) {
         setPref($data_dir, $username, 'delete_move_next_t', 'on');
     } else {
         setPref($data_dir, $username, 'delete_move_next_t', "off");
     }
-    
+
     if (isset($delete_move_next_formATtopi)) {
         setPref($data_dir, $username, 'delete_move_next_formATtop', 'on');
     } else {
         setPref($data_dir, $username, 'delete_move_next_formATtop', "off");
     }
-    
-    
+
+
     if (isset($delete_move_next_bi)) {
         setPref($data_dir, $username, 'delete_move_next_b', 'on');
     } else {
         setPref($data_dir, $username, 'delete_move_next_b', "off");
     }
-    
+
     if (isset($delete_move_next_formATbottomi)) {
         setPref($data_dir, $username, 'delete_move_next_formATbottom', 'on');
     } else {
@@ -368,7 +420,7 @@ function delete_move_next_loading_prefs() {
     global $username,$data_dir,
            $delete_move_next_t, $delete_move_next_formATtop,
            $delete_move_next_b, $delete_move_next_formATbottom;
-    
+
     $delete_move_next_t = getPref($data_dir, $username, 'delete_move_next_t');
     $delete_move_next_b = getPref($data_dir, $username, 'delete_move_next_b');
     $delete_move_next_formATtop = getPref($data_dir, $username, 'delete_move_next_formATtop');