Source for file imap_mailbox.php

Documentation is available at imap_mailbox.php

  1. <?php
  2.  
  3. /**
  4.  * imap_mailbox.php
  5.  *
  6.  * This implements all functions that manipulate mailboxes
  7.  *
  8.  * @copyright 1999-2012 The SquirrelMail Project Team
  9.  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  10.  * @version $Id: imap_mailbox.php 14346 2012-12-09 12:06:30Z kink $
  11.  * @package squirrelmail
  12.  * @subpackage imap
  13.  */
  14.  
  15. /** UTF7 support */
  16. require_once(SM_PATH . 'functions/imap_utf7_local.php');
  17.  
  18.  
  19. /**
  20.  * Mailboxes class
  21.  *
  22.  * FIXME. This class should be extracted and placed in a separate file that
  23.  * can be included before we start the session. That makes caching of the tree
  24.  * possible. On a refresh mailboxes from left_main.php the only function that
  25.  * should be called is the sqimap_get_status_mbx_tree. In case of subscribe
  26.  * / rename / delete / new we have to create methods for adding/changing the
  27.  * mailbox in the mbx_tree without the need for a refresh.
  28.  *
  29.  * Some code fragments are present in 1.3.0 - 1.4.4.
  30.  * @package squirrelmail
  31.  * @subpackage imap
  32.  * @since 1.5.0
  33.  */
  34. class mailboxes {
  35.     var $mailboxname_full = '', $mailboxname_sub= '', $is_noselect = false, $is_noinferiors = false,
  36.         $is_special = false, $is_root = false, $is_inbox = false, $is_sent = false,
  37.         $is_trash = false, $is_draft = false,  $mbxs = array(),
  38.         $unseen = false, $total = false, $recent = false;
  39.  
  40.     function addMbx($mbx, $delimiter, $start, $specialfirst) {
  41.         $ary = explode($delimiter, $mbx->mailboxname_full);
  42.         $mbx_parent =& $this;
  43.         for ($i = $start, $c = count($ary)-1; $i < $c; $i++) {
  44.             $mbx_childs =& $mbx_parent->mbxs;
  45.             $found = false;
  46.             if ($mbx_childs) {
  47.                 foreach ($mbx_childs as $key => $parent) {
  48.                     if ($parent->mailboxname_sub == $ary[$i]) {
  49.                         $mbx_parent =& $mbx_parent->mbxs[$key];
  50.                         $found = true;
  51.                         break;
  52.                     }
  53.                 }
  54.             }
  55.             if (!$found) {
  56.                 $no_select_mbx = new mailboxes();
  57.                 if (isset($mbx_parent->mailboxname_full) && $mbx_parent->mailboxname_full != '') {
  58.                     $no_select_mbx->mailboxname_full = $mbx_parent->mailboxname_full.$delimiter.$ary[$i];
  59.                 } else {
  60.                     $no_select_mbx->mailboxname_full = $ary[$i];
  61.                 }
  62.                 $no_select_mbx->mailboxname_sub = $ary[$i];
  63.                 $no_select_mbx->is_noselect = true;
  64.                 $mbx_parent->mbxs[] = $no_select_mbx;
  65.                 $i--;
  66.             }
  67.         }
  68.         $mbx_parent->mbxs[] = $mbx;
  69.         if ($mbx->is_special && $specialfirst) {
  70.             usort($mbx_parent->mbxs, 'sortSpecialMbx');
  71.         }
  72.     }
  73. }
  74.  
  75. /**
  76.  * array callback used for sorting in mailboxes class
  77.  * @param object $a 
  78.  * @param object $b 
  79.  * @return integer see php strnatcasecmp()
  80.  * @since 1.3.0
  81.  */
  82. function sortSpecialMbx($a, $b) {
  83.     if ($a->is_inbox) {
  84.         $acmp = '0'. $a->mailboxname_full;
  85.     } else if ($a->is_special) {
  86.         $acmp = '1'. $a->mailboxname_full;
  87.     } else {
  88.         $acmp = '2' . $a->mailboxname_full;
  89.     }
  90.     if ($b->is_inbox) {
  91.         $bcmp = '0'. $b->mailboxname_full;
  92.     }else if ($b->is_special) {
  93.         $bcmp = '1' . $b->mailboxname_full;
  94.     } else {
  95.         $bcmp = '2' . $b->mailboxname_full;
  96.     }
  97.     return strnatcasecmp($acmp, $bcmp);
  98. }
  99.  
  100. /**
  101.  * @param array $ary 
  102.  * @return array 
  103.  * @since 1.5.0
  104.  */
  105. function compact_mailboxes_response($ary) {
  106.     /*
  107.      * Workaround for mailboxes returned as literal
  108.      * FIXME : Doesn't work if the mailbox name is multiple lines
  109.      * (larger then fgets buffer)
  110.      */
  111.     for ($i = 0, $iCnt=count($ary); $i < $iCnt; $i++) {
  112.         if (isset($ary[$i + 1]) && substr($ary[$i], -3) == "}\r\n") {
  113.             if (preg_match('/^(\* [A-Z]+.*)\{[0-9]+\}([ \n\r\t]*)$/', $ary[$i], $regs)) {
  114.                 $ary[$i] = $regs[1] . '"' . addslashes(trim($ary[$i+1])) . '"' . $regs[2];
  115.                 array_splice($ary, $i+1, 2);
  116.             }
  117.         }
  118.     }
  119.     /* remove duplicates and ensure array is contiguous */
  120.     return array_values(array_unique($ary));
  121. }
  122.  
  123. /**
  124.  * Extract the mailbox name from an untagged LIST (7.2.2) or LSUB (7.2.3) answer
  125.  * (LIST|LSUB) (<Flags list>) (NIL|"<separator atom>") <mailbox name string>\r\n
  126.  * mailbox name in quoted string MUST be unquoted and stripslashed (sm API)
  127.  *
  128.  * Originally stored in functions/strings.php. Since 1.2.6 stored in
  129.  * functions/imap_mailbox.php
  130.  * @param string $line imap LIST/LSUB response line
  131.  * @return string mailbox name
  132.  */
  133. function find_mailbox_name($line) {
  134.     if (preg_match('/^\* (?:LIST|LSUB) \([^\)]*\) (?:NIL|\"[^\"]*\") ([^\r\n]*)[\r\n]*$/i', $line, $regs)) {
  135.         if (substr($regs[1], 0, 1) == '"')
  136.             return stripslashes(substr($regs[1], 1, -1));
  137.         return $regs[1];
  138.     }
  139.     return '';
  140. }
  141.  
  142. /**
  143.  * Detects if mailbox has noselect flag (can't store messages)
  144.  * In versions older than 1.4.5 function checks only LSUB responses
  145.  * and can produce pcre warnings.
  146.  * @param string $lsub_line mailbox line from untagged LIST or LSUB response
  147.  * @return bool whether this is a Noselect mailbox.
  148.  * @since 1.3.2
  149.  */
  150. function check_is_noselect ($lsub_line) {
  151.     return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noselect[^\)]*\)/i", $lsub_line);
  152. }
  153.  
  154. /**
  155.  * Detects if mailbox has noinferiors flag (can't store subfolders)
  156.  * @param string $lsub_line mailbox line from untagged LIST or LSUB response
  157.  * @return bool whether this is a Noinferiors mailbox.
  158.  * @since 1.5.0
  159.  */
  160. function check_is_noinferiors ($lsub_line) {
  161.     return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noinferiors[^\)]*\)/i", $lsub_line);
  162. }
  163.  
  164. /**
  165.  * Detects mailbox's parent folder
  166.  *
  167.  * If $haystack is a full mailbox name, and $needle is the mailbox
  168.  * separator character, returns the second last part of the full
  169.  * mailbox name (i.e. the mailbox's parent mailbox)
  170.  *
  171.  * Originally stored in functions/strings.php. Since 1.2.6 stored in
  172.  * functions/imap_mailbox.php
  173.  * @param string $haystack full mailbox name
  174.  * @param string $needle delimiter
  175.  * @return string parent mailbox
  176.  */
  177. function readMailboxParent($haystack, $needle) {
  178.     if ($needle == '') {
  179.         $ret = '';
  180.     } else {
  181.         $parts = explode($needle, $haystack);
  182.         $elem = array_pop($parts);
  183.         while ($elem == '' && count($parts)) {
  184.             $elem = array_pop($parts);
  185.         }
  186.         $ret = join($needle, $parts);
  187.     }
  188.     return( $ret );
  189. }
  190.  
  191. /**
  192.  * Check if $subbox is below the specified $parentbox
  193.  * @param string $subbox potential sub folder
  194.  * @param string $parentbox potential parent
  195.  * @return boolean 
  196.  * @since 1.2.3
  197.  */
  198. function isBoxBelow( $subbox, $parentbox ) {
  199.     global $delimiter;
  200.     /*
  201.      * Eliminate the obvious mismatch, where the
  202.      * subfolder path is shorter than that of the potential parent
  203.      */
  204.     if ( strlen($subbox) < strlen($parentbox) ) {
  205.       return false;
  206.     }
  207.     /* check for delimiter */
  208.     if (substr($parentbox,-1) != $delimiter) {
  209.         $parentbox .= $delimiter;
  210.     }
  211.  
  212.     return (substr($subbox,0,strlen($parentbox)) == $parentbox);
  213. }
  214.  
  215. /**
  216.  * Defines special mailboxes: given a mailbox name, it checks if this is a
  217.  * "special" one: INBOX, Trash, Sent or Draft.
  218.  *
  219.  * Since 1.2.5 function includes special_mailbox hook.
  220.  *
  221.  * Since 1.4.3 hook supports more than one plugin.
  222.  *
  223. //FIXME: make $subfolders_of_inbox_are_special a configuration setting in conf.pl and config.php
  224.  * Since 1.4.22/1.5.2, the administrator can add
  225.  * $subfolders_of_inbox_are_special = TRUE;
  226.  * to config/config_local.php and all subfolders
  227.  * of the INBOX will be treated as special.
  228.  *
  229.  * @param string $box mailbox name
  230.  * @param boolean $include_subs (since 1.5.2) if true, subfolders of system
  231.  *   folders are special. if false, subfolders are not special mailboxes
  232.  *   unless they are tagged as special in 'special_mailbox' hook.
  233.  * @return boolean 
  234.  * @since 1.2.3
  235.  */
  236. function isSpecialMailbox($box,$include_subs=true) {
  237.     global $subfolders_of_inbox_are_special;
  238.     $ret = ( ($subfolders_of_inbox_are_special && isInboxMailbox($box,$include_subs)) ||
  239.              (!$subfolders_of_inbox_are_special && strtolower($box) == 'inbox') ||
  240.              isTrashMailbox($box,$include_subs) || 
  241.              isSentMailbox($box,$include_subs) || 
  242.              isDraftMailbox($box,$include_subs) );
  243.  
  244.     if ( !$ret ) {
  245.         $ret = boolean_hook_function('special_mailbox', $box, 1);
  246.     }
  247.     return $ret;
  248. }
  249.  
  250. /**
  251.  * Detects if mailbox is the Inbox folder or subfolder of the Inbox
  252.  *
  253.  * @param string $box The mailbox name to test
  254.  * @param boolean $include_subs If true, subfolders of system folders
  255.  *                               are special.  If false, subfolders are
  256.  *                               not special mailboxes.
  257.  *
  258.  * @return boolean Whether this is the Inbox or a child thereof.
  259.  *
  260.  * @since 1.4.22
  261.  */
  262. function isInboxMailbox($box, $include_subs=TRUE) {
  263.    return ((strtolower($box) == 'inbox')
  264.         || ($include_subs && isBoxBelow(strtolower($box), 'inbox')));
  265. }
  266.  
  267. /**
  268.  * Detects if mailbox is a Trash folder or subfolder of Trash
  269.  * @param string $box mailbox name
  270.  * @param boolean $include_subs (since 1.5.2) if true, subfolders of system
  271.  *   folders are special. if false, subfolders are not special mailboxes.
  272.  * @return bool whether this is a Trash folder
  273.  * @since 1.4.0
  274.  */
  275. function isTrashMailbox ($box,$include_subs=true) {
  276.     global $trash_folder, $move_to_trash;
  277.     return $move_to_trash && $trash_folder &&
  278.            ( $box == $trash_folder || 
  279.              ($include_subs && isBoxBelow($box, $trash_folder)) );
  280. }
  281.  
  282. /**
  283.  * Detects if mailbox is a Sent folder or subfolder of Sent
  284.  * @param string $box mailbox name
  285.  * @param boolean $include_subs (since 1.5.2) if true, subfolders of system
  286.  *   folders are special. if false, subfolders are not special mailboxes.
  287.  * @return bool whether this is a Sent folder
  288.  * @since 1.4.0
  289.  */
  290. function isSentMailbox($box,$include_subs=true) {
  291.    global $sent_folder, $move_to_sent;
  292.    return $move_to_sent && $sent_folder &&
  293.           ( $box == $sent_folder || 
  294.             ($include_subs && isBoxBelow($box, $sent_folder)) );
  295. }
  296.  
  297. /**
  298.  * Detects if mailbox is a Drafts folder or subfolder of Drafts
  299.  * @param string $box mailbox name
  300.  * @param boolean $include_subs (since 1.5.2) if true, subfolders of system
  301.  *   folders are special. if false, subfolders are not special mailboxes.
  302.  * @return bool whether this is a Draft folder
  303.  * @since 1.4.0
  304.  */
  305. function isDraftMailbox($box,$include_subs=true) {
  306.    global $draft_folder, $save_as_draft;
  307.    return $save_as_draft &&
  308.           ( $box == $draft_folder || 
  309.             ($include_subs && isBoxBelow($box, $draft_folder)) );
  310. }
  311.  
  312. /**
  313.  * Is the given folder "sent-like" in nature?
  314.  *
  315.  * The most obvious use of this is to know what folders you usually
  316.  * want to show the To field instead of the From field on the mailbox list
  317.  *
  318.  * This function returns TRUE if the given folder is the sent
  319.  * folder (or any of its subfolders) or if it is the draft
  320.  * folder (or any of its subfolders)
  321.  *
  322.  * @param string $mailbox 
  323.  *
  324.  * @return boolean See explanation above
  325.  *
  326.  */
  327. function handleAsSent($mailbox) {
  328.     global $handleAsSent_result;
  329.  
  330.     /* First check if this is the sent or draft folder. */
  331.     $handleAsSent_result = isSentMailbox($mailbox) || isDraftMailbox($mailbox);
  332.  
  333.     /* Then check the result of the handleAsSent hook. */
  334.     do_hook('check_handleAsSent_result', $mailbox);
  335.  
  336.     /* And return the result. */
  337.     return $handleAsSent_result;
  338. }
  339.  
  340. /**
  341.  * Expunges a mailbox
  342.  *
  343.  * WARNING: Select mailbox before calling this function.
  344.  *
  345.  * permanently removes all messages that have the \Deleted flag
  346.  * set from the selected mailbox. See EXPUNGE command chapter in
  347.  * IMAP RFC.
  348.  * @param stream $imap_stream imap connection resource
  349.  * @param string $mailbox mailbox name (unused since 1.1.3).
  350.  * @param boolean $handle_errors error handling control (displays error_box on error).
  351.  * @param mixed $id (since 1.3.0) integer message id or array with integer ids
  352.  * @return integer number of expunged messages
  353.  * @since 1.0 or older
  354.  */
  355. function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, $id='') {
  356.     if ($id) {
  357.         if (is_array($id)) {
  358.             $id = sqimap_message_list_squisher($id);
  359.         }
  360.         $id = ' '.$id;
  361.         $uid = TRUE;
  362.     } else {
  363.         $uid = false;
  364.     }
  365.     $read = sqimap_run_command($imap_stream, 'EXPUNGE'.$id, $handle_errors,
  366.                                $response, $message, $uid);
  367.     $cnt = 0;
  368.  
  369.     if (is_array($read)) {
  370.         foreach ($read as $r) {
  371.             if (preg_match('/^\*\s[0-9]+\sEXPUNGE/AUi',$r,$regs)) {
  372.                 $cnt++;
  373.             }
  374.         }
  375.     }
  376.     return $cnt;
  377. }
  378.  
  379. /**
  380.  * Checks whether or not the specified mailbox exists
  381.  *
  382.  * @param stream $imap_stream imap connection resource
  383.  * @param string $mailbox mailbox name
  384.  * @param array $mailboxlist (since 1.5.1) optional array of mailboxes from
  385.  *   sqimap_get_mailboxes() (to avoid having to talk to imap server)
  386.  * @return boolean 
  387.  * @since 1.0 or older
  388.  */
  389. function sqimap_mailbox_exists ($imap_stream, $mailbox, $mailboxlist=null) {
  390.     if (!isset($mailbox) || empty($mailbox)) {
  391.         return false;
  392.     }
  393.  
  394.     if (is_array($mailboxlist)) {
  395.         // use previously retrieved mailbox list
  396.         foreach ($mailboxlist as $mbox) {
  397.             if ($mbox['unformatted-dm'] == $mailbox) { return true; }
  398.         }
  399.         return false;
  400.     } else {
  401.         // go to imap server
  402.         $mbx = sqimap_run_command($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mailbox),
  403.                                   true, $response, $message);
  404.         return isset($mbx[0]);
  405.     }
  406. }
  407.  
  408. /**
  409.  * Selects a mailbox
  410.  * Before 1.3.0 used more arguments and returned data depended on those arguments.
  411.  * @param stream $imap_stream imap connection resource
  412.  * @param string $mailbox mailbox name
  413.  * @return array results of select command (on success - permanentflags, flags and rights)
  414.  * @since 1.0 or older
  415.  */
  416. function sqimap_mailbox_select ($imap_stream, $mailbox) {
  417.     if (empty($mailbox)) {
  418.         return;
  419.     }
  420.  
  421.     // cleanup $mailbox in order to prevent IMAP injection attacks
  422.     $mailbox = str_replace(array("\r","\n"), array("",""),$mailbox);
  423.  
  424.     /**
  425.      * Default UW IMAP server configuration allows to access other files
  426.      * on server. $imap_server_type is not checked because interface can
  427.      * be used with 'other' or any other server type setting. $mailbox
  428.      * variable can be modified in any script that uses variable from GET
  429.      * or POST. This code blocks all standard SquirrelMail IMAP API requests
  430.      * that use mailbox with full path (/etc/passwd) or with ../ characters
  431.      * in path (../../etc/passwd)
  432.      */
  433.     if (strstr($mailbox, '../') || substr($mailbox, 0, 1) == '/') {
  434.         global $oTemplate;
  435.         error_box(sprintf(_("Invalid mailbox name: %s"),sm_encode_html_special_chars($mailbox)));
  436.         sqimap_logout($imap_stream);
  437.         $oTemplate->display('footer.tpl');
  438.         die();
  439.     }
  440.  
  441.     $read = sqimap_run_command($imap_stream, 'SELECT ' . sqimap_encode_mailbox_name($mailbox),
  442.                                true, $response, $message);
  443.     $result = array();
  444.     for ($i = 0, $cnt = count($read); $i < $cnt; $i++) {
  445.         if (preg_match('/^\*\s+OK\s\[(\w+)\s(\w+)\]/',$read[$i], $regs)) {
  446.             $result[strtoupper($regs[1])] = $regs[2];
  447.         } else if (preg_match('/^\*\s([0-9]+)\s(\w+)/',$read[$i], $regs)) {
  448.             $result[strtoupper($regs[2])] = $regs[1];
  449.         } else {
  450.             if (preg_match("/PERMANENTFLAGS(.*)/i",$read[$i], $regs)) {
  451.                 $regs[1]=trim(preg_replace (  array ("/\(/","/\)/","/\]/") ,'', $regs[1])) ;
  452.                 $result['PERMANENTFLAGS'] = explode(' ',strtolower($regs[1]));
  453.             } else if (preg_match("/FLAGS(.*)/i",$read[$i], $regs)) {
  454.                 $regs[1]=trim(preg_replace (  array ("/\(/","/\)/") ,'', $regs[1])) ;
  455.                 $result['FLAGS'] = explode(' ',strtolower($regs[1]));
  456.             }
  457.         }
  458.     }
  459.     if (!isset($result['PERMANENTFLAGS'])) {
  460.         $result['PERMANENTFLAGS'] = $result['FLAGS'];
  461.     }
  462.     if (preg_match('/^\[(.+)\]/',$message, $regs)) {
  463.         $result['RIGHTS']=strtoupper($regs[1]);
  464.     }
  465.  
  466.     return $result;
  467. }
  468.  
  469. /**
  470.  * Creates a folder.
  471.  *
  472.  * Mailbox is automatically subscribed.
  473.  *
  474.  * Set $type to string that does not match 'noselect' (case insensitive),
  475.  * if you don't want to prepend delimiter to mailbox name. Please note
  476.  * that 'noinferiors' might be used someday as keyword for folders
  477.  * that store only messages.
  478.  * @param stream $imap_steam imap connection resource
  479.  * @param string $mailbox mailbox name
  480.  * @param string $type folder type.
  481.  * @since 1.0 or older
  482.  */
  483. function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
  484.     global $delimiter;
  485.     if (strtolower($type) == 'noselect') {
  486.         $create_mailbox = $mailbox . $delimiter;
  487.     } else {
  488.         $create_mailbox = $mailbox;
  489.     }
  490.  
  491.     $read_ary = sqimap_run_command($imap_stream, 'CREATE ' .
  492.                                    sqimap_encode_mailbox_name($create_mailbox),
  493.                                    true, $response, $message);
  494.     sqimap_subscribe ($imap_stream, $mailbox);
  495. }
  496.  
  497. /**
  498.  * Subscribes to an existing folder.
  499.  * @param stream $imap_stream imap connection resource
  500.  * @param string $mailbox mailbox name
  501.  * @param boolean $debug (since 1.5.1)
  502.  * @since 1.0 or older
  503.  */
  504. function sqimap_subscribe ($imap_stream, $mailbox,$debug=true) {
  505.     $read_ary = sqimap_run_command($imap_stream, 'SUBSCRIBE ' .
  506.                                    sqimap_encode_mailbox_name($mailbox),
  507.                                    $debug, $response, $message);
  508. }
  509.  
  510. /**
  511.  * Unsubscribes from an existing folder
  512.  * @param stream $imap_stream imap connection resource
  513.  * @param string $mailbox mailbox name
  514.  * @since 1.0 or older
  515.  */
  516. function sqimap_unsubscribe ($imap_stream, $mailbox) {
  517.     $read_ary = sqimap_run_command($imap_stream, 'UNSUBSCRIBE ' .
  518.                                    sqimap_encode_mailbox_name($mailbox),
  519.                                    false, $response, $message);
  520. }
  521.  
  522. /**
  523.  * Deletes the given folder
  524.  * Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook
  525.  * @param stream $imap_stream imap connection resource
  526.  * @param string $mailbox mailbox name
  527.  * @since 1.0 or older
  528.  */
  529. function sqimap_mailbox_delete ($imap_stream, $mailbox) {
  530.     global $data_dir, $username;
  531.     sqimap_unsubscribe ($imap_stream, $mailbox);
  532.  
  533.     if (sqimap_mailbox_exists($imap_stream, $mailbox)) {
  534.  
  535.         $read_ary = sqimap_run_command($imap_stream, 'DELETE ' .
  536.                                        sqimap_encode_mailbox_name($mailbox),
  537.                                        true, $response, $message);
  538.         if ($response !== 'OK') {
  539.             // subscribe again
  540.             sqimap_subscribe ($imap_stream, $mailbox);
  541.         } else {
  542.             $temp = array(&$mailbox, 'delete', '');
  543.             do_hook('rename_or_delete_folder', $temp);
  544.             removePref($data_dir, $username, "thread_$mailbox");
  545.             removePref($data_dir, $username, "collapse_folder_$mailbox");
  546.         }
  547.     }
  548. }
  549.  
  550. /**
  551.  * Determines if the user is subscribed to the folder or not
  552.  * @param stream $imap_stream imap connection resource
  553.  * @param string $mailbox mailbox name
  554.  * @return boolean 
  555.  * @since 1.2.0
  556.  */
  557. function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
  558.     $boxesall = sqimap_mailbox_list ($imap_stream);
  559.     foreach ($boxesall as $ref) {
  560.         if ($ref['unformatted'] == $folder) {
  561.             return true;
  562.         }
  563.     }
  564.     return false;
  565. }
  566.  
  567. /**
  568.  * Renames a mailbox.
  569.  * Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook
  570.  * @param stream $imap_stream imap connection resource
  571.  * @param string $old_name mailbox name
  572.  * @param string $new_name new mailbox name
  573.  * @since 1.2.3
  574.  */
  575. function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
  576.     if ( $old_name != $new_name ) {
  577.         global $delimiter, $imap_server_type, $data_dir, $username;
  578.         if ( substr( $old_name, -1 ) == $delimiter  ) {
  579.             $old_name = substr( $old_name, 0, strlen( $old_name ) - 1 );
  580.             $new_name = substr( $new_name, 0, strlen( $new_name ) - 1 );
  581.             $postfix = $delimiter;
  582.         } else {
  583.             $postfix = '';
  584.         }
  585.  
  586.         $boxesall = sqimap_mailbox_list_all($imap_stream);
  587.         $cmd = 'RENAME ' . sqimap_encode_mailbox_name($old_name) .
  588.                      ' ' . sqimap_encode_mailbox_name($new_name);
  589.         $data = sqimap_run_command($imap_stream, $cmd, true, $response, $message);
  590.         sqimap_unsubscribe($imap_stream, $old_name.$postfix);
  591.         $oldpref_thread = getPref($data_dir, $username, 'thread_'.$old_name.$postfix);
  592.         $oldpref_collapse = getPref($data_dir, $username, 'collapse_folder_'.$old_name.$postfix);
  593.         removePref($data_dir, $username, 'thread_'.$old_name.$postfix);
  594.         removePref($data_dir, $username, 'collapse_folder_'.$old_name.$postfix);
  595.         sqimap_subscribe($imap_stream, $new_name.$postfix);
  596.         setPref($data_dir, $username, 'thread_'.$new_name.$postfix, $oldpref_thread);
  597.         setPref($data_dir, $username, 'collapse_folder_'.$new_name.$postfix, $oldpref_collapse);
  598.         $temp = array(&$old_name, 'rename', &$new_name);
  599.         do_hook('rename_or_delete_folder', $temp);
  600.         $l = strlen( $old_name ) + 1;
  601.         $p = 'unformatted';
  602.  
  603.         foreach ($boxesall as $box) {
  604.             if (substr($box[$p], 0, $l) == $old_name . $delimiter) {
  605.                 $new_sub = $new_name . $delimiter . substr($box[$p], $l);
  606.                 /* With Cyrus IMAPd >= 2.0 rename is recursive, so don't check for errors here */
  607.                 if ($imap_server_type == 'cyrus') {
  608.                     $cmd = 'RENAME "' . $box[$p] . '" "' . $new_sub . '"';
  609.                     $data = sqimap_run_command($imap_stream, $cmd, false,
  610.                                                $response, $message);
  611.                 }
  612.                 $was_subscribed = sqimap_mailbox_is_subscribed($imap_stream, $box[$p]);
  613.                 if ( $was_subscribed ) {
  614.                     sqimap_unsubscribe($imap_stream, $box[$p]);
  615.                 }
  616.                 $oldpref_thread = getPref($data_dir, $username, 'thread_'.$box[$p]);
  617.                 $oldpref_collapse = getPref($data_dir, $username, 'collapse_folder_'.$box[$p]);
  618.                 removePref($data_dir, $username, 'thread_'.$box[$p]);
  619.                 removePref($data_dir, $username, 'collapse_folder_'.$box[$p]);
  620.                 if ( $was_subscribed ) {
  621.                     sqimap_subscribe($imap_stream, $new_sub);
  622.                 }
  623.                 setPref($data_dir, $username, 'thread_'.$new_sub, $oldpref_thread);
  624.                 setPref($data_dir, $username, 'collapse_folder_'.$new_sub, $oldpref_collapse);
  625.                 $temp = array(&$box[$p], 'rename', &$new_sub);
  626.                 do_hook('rename_or_delete_folder', $temp);
  627.             }
  628.         }
  629.     }
  630. }
  631.  
  632. /**
  633.  * Formats a mailbox into parts for the $boxesall array
  634.  *
  635.  * The parts are:
  636.  * <ul>
  637.  *   <li>raw            - Raw LIST/LSUB response from the IMAP server
  638.  *   <li>formatted      - nicely formatted folder name
  639.  *   <li>unformatted    - unformatted, but with delimiter at end removed
  640.  *   <li>unformatted-dm - folder name as it appears in raw response
  641.  *   <li>unformatted-disp - unformatted without $folder_prefix
  642.  *   <li>id             - TODO: document me
  643.  *   <li>flags          - TODO: document me
  644.  * </ul>
  645.  * Before 1.2.0 used third argument for delimiter.
  646.  *
  647.  * Before 1.5.1 used second argument for lsub line. Argument was removed in order to use
  648.  * find_mailbox_name() on the raw input. Since 1.5.1 includes RFC3501 names in flags
  649.  * array (for example, "\NoSelect" in addition to "noselect")
  650.  * @param array $line 
  651.  * @return array 
  652.  * @since 1.0 or older
  653.  * @todo document id and flags keys in boxes array and function arguments.
  654.  */
  655. function sqimap_mailbox_parse ($line) {
  656.     global $folder_prefix, $delimiter;
  657.  
  658.     /* Process each folder line */
  659.     for ($g = 0, $cnt = count($line); $g < $cnt; ++$g) {
  660.         /* Store the raw IMAP reply */
  661.         if (isset($line[$g])) {
  662.             $boxesall[$g]['raw'] = $line[$g];
  663.         } else {
  664.             $boxesall[$g]['raw'] = '';
  665.         }
  666.  
  667.         /* Count number of delimiters ($delimiter) in folder name */
  668.         $mailbox = find_mailbox_name($line[$g]);
  669.         $dm_count = substr_count($mailbox, $delimiter);
  670.         if (substr($mailbox, -1) == $delimiter) {
  671.             /* If name ends in delimiter, decrement count by one */
  672.             $dm_count--;
  673.         }
  674.  
  675.         /* Format folder name, but only if it's a INBOX.* or has a parent. */
  676.         $boxesallbyname[$mailbox] = $g;
  677.         $parentfolder = readMailboxParent($mailbox, $delimiter);
  678.         if ( (strtolower(substr($mailbox, 0, 5)) == "inbox") ||
  679.              (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
  680.              (isset($boxesallbyname[$parentfolder]) &&
  681.               (strlen($parentfolder) > 0) ) ) {
  682.             $indent = $dm_count - (substr_count($folder_prefix, $delimiter));
  683.             if ($indent > 0) {
  684.                 $boxesall[$g]['formatted'] = str_repeat('&nbsp;&nbsp;', $indent);
  685.             } else {
  686.                 $boxesall[$g]['formatted'] = '';
  687.             }
  688.             $boxesall[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
  689.         } else {
  690.             $boxesall[$g]['formatted']  = imap_utf7_decode_local($mailbox);
  691.         }
  692.  
  693.         $boxesall[$g]['unformatted-dm'] = $mailbox;
  694.         if (substr($mailbox, -1) == $delimiter) {
  695.             $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
  696.         }
  697.         $boxesall[$g]['unformatted'] = $mailbox;
  698.         if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix) {
  699.             $mailbox = substr($mailbox, strlen($folder_prefix));
  700.         }
  701.         $boxesall[$g]['unformatted-disp'] = $mailbox;
  702.         $boxesall[$g]['id'] = $g;
  703.  
  704.         $boxesall[$g]['flags'] = array();
  705.         if (isset($line[$g]) && preg_match('/\(([^)]*)\)/',$line[$g],$regs) ) {
  706.             /**
  707.              * Since 1.5.1 flags are stored with RFC3501 naming
  708.              * and also the old way for backwards compatibility
  709.              * so for example "\NoSelect" and "noselect"
  710.              */
  711.             $flags = trim($regs[1]);
  712.             if ($flags) {
  713.                 $flagsarr = explode(' ',$flags);
  714.                 $flagsarrnew=$flagsarr;
  715.                 // add old type
  716.                 foreach ($flagsarr as $flag) {
  717.                     $flagsarrnew[]=strtolower(str_replace('\\', '',$flag));
  718.                 }
  719.                 $boxesall[$g]['flags']=$flagsarrnew;
  720.             }
  721.         }
  722.     }
  723.     return $boxesall;
  724. }
  725.  
  726. /**
  727.  * Returns an array of mailboxes available.  Separated from sqimap_mailbox_option_list()
  728.  * below for template development.
  729.  * 
  730.  * @author Steve Brown
  731.  * @since 1.5.2
  732.  */
  733. function sqimap_mailbox_option_array($imap_stream, $folder_skip = 0, $boxes = 0,
  734.                                     $flag = 'noselect', $use_long_format = false ) {
  735.     global $username, $data_dir, $translate_special_folders, $sent_folder, 
  736.         $trash_folder, $draft_folder;
  737.  
  738.     $delimiter = sqimap_get_delimiter($imap_stream);
  739.  
  740.     $mbox_options = '';
  741.     if ( $use_long_format ) {
  742.         $shorten_box_names = 0;
  743.     } else {
  744.         $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_MAILBOX_SELECT_INDENTED);
  745.     }
  746.  
  747.     if ($boxes == 0) {
  748.         $boxes = sqimap_mailbox_list($imap_stream);
  749.     }
  750.  
  751.     $a = array();
  752.     foreach ($boxes as $boxes_part) {
  753.         if ($flag == NULL || (is_array($boxes_part['flags'])
  754.                       && !in_array($flag, $boxes_part['flags']))) {
  755.             $box = $boxes_part['unformatted'];
  756.  
  757.             if ($folder_skip != 0 && in_array($box, $folder_skip) ) {
  758.                 continue;
  759.             }
  760.             $lowerbox = strtolower($box);
  761.             // mailboxes are casesensitive => inbox.sent != inbox.Sent
  762.             // nevermind, to many dependencies this should be fixed!
  763.  
  764.             if (strtolower($box) == 'inbox') { // inbox is special and not casesensitive
  765.                 $box2 = _("INBOX");
  766.             } else {
  767.                 switch ($shorten_box_names)
  768.                 {
  769.                   case SMPREF_MAILBOX_SELECT_DELIMITED:
  770.                       if ($translate_special_folders && $boxes_part['unformatted-dm']==$sent_folder) {
  771.                           /*
  772.                            * calculate pad level from number of delimiters. do it inside if control in order 
  773.                            * to reduce number of calculations. Other folders don't need it.
  774.                            */
  775.                           $pad = str_pad('',7 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'.&nbsp;');
  776.                           // i18n: Name of Sent folder
  777.                           $box2 = $pad . _("Sent");
  778.                       } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$trash_folder) {
  779.                           $pad = str_pad('',7 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'.&nbsp;');
  780.                           // i18n: Name of Trash folder
  781.                           $box2 = $pad . _("Trash");
  782.                       } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$draft_folder) {
  783.                           $pad = str_pad('',7 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'.&nbsp;');
  784.                           // i18n: Name of Drafts folder
  785.                           $box2 = $pad . _("Drafts");
  786.                       } else {
  787.                           $box2 = str_replace('&amp;nbsp;&amp;nbsp;', '.&nbsp;', sm_encode_html_special_chars($boxes_part['formatted']));
  788.                       }
  789.                     break;
  790.                   case SMPREF_MAILBOX_SELECT_INDENTED:
  791.                       if ($translate_special_folders && $boxes_part['unformatted-dm']==$sent_folder) {
  792.                           $pad = str_pad('',12 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'&nbsp;&nbsp;');
  793.                           $box2 = $pad . _("Sent");
  794.                       } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$trash_folder) {
  795.                           $pad = str_pad('',12 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'&nbsp;&nbsp;');
  796.                           $box2 = $pad . _("Trash");
  797.                       } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$draft_folder) {
  798.                           $pad = str_pad('',12 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'&nbsp;&nbsp;');
  799.                           $box2 = $pad . _("Drafts");
  800.                       } else {
  801.                           $box2 = str_replace('&amp;nbsp;&amp;nbsp;', '&nbsp;&nbsp;', sm_encode_html_special_chars($boxes_part['formatted']));
  802.                       }
  803.                     break;
  804.                   default:  /* default, long names, style = 0 */
  805.                     $box2 = str_replace(' ', '&nbsp;', sm_encode_html_special_chars(imap_utf7_decode_local($boxes_part['unformatted-disp'])));
  806.                     break;
  807.                 }
  808.             }
  809.             
  810.             $a[sm_encode_html_special_chars($box)] = $box2;
  811.         }
  812.     }
  813.     
  814.     return $a;
  815. }
  816.  
  817. /**
  818.  * Returns list of options (to be echoed into select statement
  819.  * based on available mailboxes and separators
  820.  * Caller should surround options with <select ...> </select> and
  821.  * any formatting.
  822.  * @param stream $imap_stream imap connection resource to query for mailboxes
  823.  * @param array $show_selected array containing list of mailboxes to pre-select (0 if none)
  824.  * @param array $folder_skip array of folders to keep out of option list (compared in lower)
  825.  * @param $boxes list of already fetched boxes (for places like folder panel, where
  826.  *             you know these options will be shown 3 times in a row.. (most often unset).
  827.  * @param string $flag (since 1.4.1) flag to check for in mailbox flags, used to filter out mailboxes.
  828.  *            'noselect' by default to remove unselectable mailboxes.
  829.  *            'noinferiors' used to filter out folders that can not contain subfolders.
  830.  *            NULL to avoid flag check entirely.
  831.  *            NOTE: noselect and noiferiors are used internally. The IMAP representation is
  832.  *                  \NoSelect and \NoInferiors
  833.  * @param boolean $use_long_format (since 1.4.1) override folder display preference and always show full folder name.
  834.  * @return string html formated mailbox selection options
  835.  * @since 1.3.2
  836.  */
  837. function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_skip = 0, $boxes = 0,
  838.                                     $flag = 'noselect', $use_long_format = false ) {
  839.     global $username, $data_dir, $translate_special_folders, $sent_folder, 
  840.         $trash_folder, $draft_folder;
  841.  
  842.     $boxes = sqimap_mailbox_option_array($imap_stream, $folder_skip, $boxes, $flag, $use_long_format);
  843.     
  844.     $str = '';
  845.     foreach ($boxes as $value=>$option) {
  846.         $lowerbox = strtolower(sm_encode_html_special_chars($value));
  847.         $sel = false;
  848.         if ($show_selected != 0) {
  849.             reset($show_selected);
  850.             while (!$sel && (list($x, $val) = each($show_selected))) {
  851.                 if (strtolower($value) == strtolower(sm_encode_html_special_chars($val))) {
  852.                     $sel = true;
  853.                 }
  854.             }
  855.         }
  856.         
  857.         $str .= '<option value="'. $value .'"'. ($sel ? ' selected="selected"' : '').'>'. $option ."</option>\n";
  858.     }
  859.     
  860.     return $str;
  861. }
  862.  
  863. /**
  864.  * Returns sorted mailbox lists in several different ways.
  865.  *
  866.  * Since 1.5.1 most of the functionality has been moved to new function sqimap_get_mailboxes
  867.  *
  868.  * See comment on sqimap_mailbox_parse() for info about the returned array.
  869.  * @param resource $imap_stream imap connection resource
  870.  * @param boolean $force force update of mailbox listing. available since 1.4.2 and 1.5.0
  871.  * @return array list of mailboxes
  872.  * @since 1.0 or older
  873.  */
  874. function sqimap_mailbox_list($imap_stream, $force=false) {
  875.     global $boxesnew,$show_only_subscribed_folders;
  876.     if (!sqgetGlobalVar('boxesnew',$boxesnew,SQ_SESSION) || $force) {
  877.         $boxesnew=sqimap_get_mailboxes($imap_stream,$force,$show_only_subscribed_folders);
  878.     }
  879.     return $boxesnew;
  880. }
  881.  
  882. /**
  883.  * Returns a list of all folders, subscribed or not
  884.  *
  885.  * Since 1.5.1 code moved to sqimap_get_mailboxes()
  886.  *
  887.  * @param stream $imap_stream imap connection resource
  888.  * @return array see sqimap_mailbox_parse()
  889.  * @since 1.0 or older
  890.  */
  891. function sqimap_mailbox_list_all($imap_stream) {
  892.     global $show_only_subscribed_folders;
  893.     // fourth argument prevents registration of retrieved list of mailboxes in session
  894.     $boxes=sqimap_get_mailboxes($imap_stream,true,false,false);
  895.     return $boxes;
  896. }
  897.  
  898.  
  899. /**
  900.  * Gets the list of mailboxes for sqimap_maolbox_tree and sqimap_mailbox_list
  901.  *
  902.  * This is because both of those functions had duplicated logic, but with slightly different
  903.  * implementations. This will make both use the same implementation, which should make it
  904.  * easier to maintain and easier to modify in the future
  905.  * @param stream $imap_stream imap connection resource
  906.  * @param bool $force force a reload and ignore cache
  907.  * @param bool $show_only_subscribed controls listing of visible or all folders
  908.  * @param bool $session_register controls registration of retrieved data in session.
  909.  * @return object boxesnew - array of mailboxes and their attributes
  910.  * @since 1.5.1
  911.  */
  912. function sqimap_get_mailboxes($imap_stream,$force=false,$show_only_subscribed=true,$session_register=true) {
  913.     global    $show_only_subscribed_folders,$noselect_fix_enable,$folder_prefix,
  914.             $list_special_folders_first,$imap_server_type;
  915.     $inbox_subscribed = false;
  916.     $listsubscribed = sqimap_capability($imap_stream,'LIST-SUBSCRIBED');
  917.  
  918.     if ($show_only_subscribed) { $show_only_subscribed=$show_only_subscribed_folders; }
  919.  
  920.     //require_once(SM_PATH . 'include/load_prefs.php');
  921.  
  922.     /**
  923.      * There are three main listing commands we can use in IMAP:
  924.      * LSUB        shows just the list of subscribed folders
  925.      *            may include flags, but these are not necessarily accurate or authoratative
  926.      *            \NoSelect has special meaning: the folder does not exist -OR- it means this
  927.      *            folder is not subscribed but children may be
  928.      *            [RFC-2060]
  929.      * LIST        this shows every mailbox on the system
  930.      *            flags are always included and are accurate and authoratative
  931.      *            \NoSelect means folder should not be selected
  932.      *            [RFC-2060]
  933.      * LIST (SUBSCRIBED)    implemented with LIST-SUBSCRIBED extension
  934.      *            this is like list but returns only subscribed folders
  935.      *            flag meanings are like LIST, not LSUB
  936.      *            \NonExistent means mailbox doesn't exist
  937.      *            \PlaceHolder means parent is not valid (selectable), but one or more children are
  938.      *            \NoSelect indeed means that the folder should not be selected
  939.      *            IMAPEXT-LIST-EXTENSIONS-04 August 2003 B. Leiba
  940.      */
  941.     if (!$show_only_subscribed) {
  942.         $lsub = 'LIST';
  943.         $sub_cache_name='list_cache';
  944.     }  elseif ($listsubscribed) {
  945.         $lsub = 'LIST (SUBSCRIBED)';
  946.         $sub_cache_name='listsub_cache';
  947.     } else {
  948.         $lsub = 'LSUB';
  949.         $sub_cache_name='lsub_cache';
  950.     }
  951.  
  952.     // Some IMAP servers allow subfolders to exist even if the parent folders do not
  953.     // This fixes some problems with the folder list when this is the case, causing the
  954.     // NoSelect folders to be displayed
  955.     if ($noselect_fix_enable) {
  956.         $lsub_args = "$lsub \"$folder_prefix\" \"*%\"";
  957.         $list_args = "LIST \"$folder_prefix\" \"*%\"";
  958.     } else {
  959.         $lsub_args = "$lsub \"$folder_prefix\" \"*\"";
  960.         $list_args = "LIST \"$folder_prefix\" \"*\"";
  961.     }
  962.  
  963.     // get subscribed mailbox list from cache (session)
  964.     // if not there, then get it from the imap server and store in cache
  965.  
  966.     if (!$force) {
  967.         sqgetGlobalVar($sub_cache_name,$lsub_cache,SQ_SESSION);
  968.     }
  969.  
  970.     $lsub_assoc_ary=array();
  971.     if (!empty($lsub_cache)) {
  972.         $lsub_assoc_ary=$lsub_cache;
  973.     } else {
  974.         $lsub_ary = sqimap_run_command ($imap_stream, $lsub_args, true, $response, $message);
  975.         $lsub_ary = compact_mailboxes_response($lsub_ary);
  976.         if (!empty($lsub_ary)) {
  977.             foreach ($lsub_ary as $rawline) {
  978.                 $temp_mailbox_name=find_mailbox_name($rawline);
  979.                 $lsub_assoc_ary[$temp_mailbox_name]=$rawline;
  980.             }
  981.             unset($lsub_ary);
  982.             sqsession_register($lsub_assoc_ary,$sub_cache_name);
  983.         }
  984.     }
  985.  
  986.     // Now to get the mailbox flags
  987.     // The LSUB response may return \NoSelect flags, etc. but it is optional
  988.     // according to RFC3501, and even when returned it may not be accurate
  989.     // or authoratative. LIST will always return accurate results.
  990.     if (($lsub == 'LIST') || ($lsub == 'LIST (SUBSCRIBED)')) {
  991.         // we've already done a LIST or LIST (SUBSCRIBED)
  992.         // and NOT a LSUB, so no need to do it again
  993.         $list_assoc_ary  = $lsub_assoc_ary;
  994.     } else {
  995.         // we did a LSUB so now we need to do a LIST
  996.         // first see if it is in cache
  997.         $list_cache_name='list_cache';
  998.         if (!$force) {
  999.             sqgetGlobalVar($list_cache_name,$list_cache,SQ_SESSION);
  1000.         }
  1001.  
  1002.         if (!empty($list_cache)) {
  1003.             $list_assoc_ary=$list_cache;
  1004.             // we could store this in list_cache_name but not necessary
  1005.         } else {
  1006.             // not in cache so we need to go get it from the imap server
  1007.             $list_assoc_ary = array();
  1008.             $list_ary = sqimap_run_command($imap_stream, $list_args,
  1009.                                            true, $response, $message);
  1010.             $list_ary = compact_mailboxes_response($list_ary);
  1011.             if (!empty($list_ary)) {
  1012.                 foreach ($list_ary as $rawline) {
  1013.                     $temp_mailbox_name=find_mailbox_name($rawline);
  1014.                     $list_assoc_ary[$temp_mailbox_name]=$rawline;
  1015.                 }
  1016.                 unset($list_ary);
  1017.                 sqsession_register($list_assoc_ary,$list_cache_name);
  1018.             }
  1019.         }
  1020.     }
  1021.  
  1022.     // If they aren't subscribed to the inbox, then add it anyway (if its in LIST)
  1023.     $inbox_subscribed=false;
  1024.     if (!empty($lsub_assoc_ary)) {
  1025.         foreach ($lsub_assoc_ary as $temp_mailbox_name=>$rawline) {
  1026.             if (strtoupper($temp_mailbox_name) == 'INBOX') {
  1027.                 $inbox_subscribed=true;
  1028.             }
  1029.         }
  1030.     }
  1031.     if (!$inbox_subscribed)  {
  1032.         if (!empty($list_assoc_ary)) {
  1033.             foreach ($list_assoc_ary as $temp_mailbox_name=>$rawline) {
  1034.                 if (strtoupper($temp_mailbox_name) == 'INBOX') {
  1035.                     $lsub_assoc_ary[$temp_mailbox_name]=$rawline;
  1036.                 }
  1037.             }
  1038.         }
  1039.     }
  1040.  
  1041.     // Now we have the raw output, we need to create an array of mailbox names we will return
  1042.     if (!$show_only_subscribed) {
  1043.         $final_folders_assoc_ary=$list_assoc_ary;
  1044.     } else {
  1045.         /**
  1046.          * only show subscribed folders
  1047.          * we need to merge the folders here... we can't trust the flags, etc. from the lsub_assoc_array
  1048.          * so we use the lsub_assoc_array as the list of folders and the values come from list_assoc_array
  1049.          */
  1050.         if (!empty($lsub_assoc_ary)) {
  1051.             foreach ($lsub_assoc_ary as $temp_mailbox_name=>$rawline) {
  1052.                 if (!empty($list_assoc_ary[$temp_mailbox_name])) {
  1053.                     $final_folders_assoc_ary[$temp_mailbox_name]=$list_assoc_ary[$temp_mailbox_name];
  1054.                 }
  1055.             }
  1056.         }
  1057.     }
  1058.  
  1059.  
  1060.     // Now produce a flat, sorted list
  1061.     if (!empty($final_folders_assoc_ary)) {
  1062.         uksort($final_folders_assoc_ary,'strnatcasecmp');
  1063.         foreach ($final_folders_assoc_ary as $temp_mailbox_name=>$rawline) {
  1064.             $final_folders_ary[]=$rawline;
  1065.         }
  1066.     }
  1067.  
  1068.     // this will put it into an array we can use later
  1069.     // containing:
  1070.     // raw    - Raw LIST/LSUB response from the IMAP server
  1071.     // formatted - formatted folder name
  1072.     // unformatted - unformatted, but with the delimiter at the end removed
  1073.     // unformated-dm - folder name as it appears in raw response
  1074.     // unformatted-disp - unformatted without $folder_prefix
  1075.     // id - the array element number (0, 1, 2, etc.)
  1076.     // flags - mailbox flags
  1077.     if (!empty($final_folders_ary)) {
  1078.         $boxesall = sqimap_mailbox_parse($final_folders_ary);
  1079.     } else {
  1080.         // they have no mailboxes
  1081.         $boxesall=array();
  1082.     }
  1083.  
  1084.     /* Now, lets sort for special folders */
  1085.     $boxesnew = $used = array();
  1086.  
  1087.     /* Find INBOX */
  1088.     $cnt = count($boxesall);
  1089.     $used = array_pad($used,$cnt,false);
  1090.     $has_inbox = false;
  1091.     for($k = 0; $k < $cnt; ++$k) {
  1092.         if (strtoupper($boxesall[$k]['unformatted']) == 'INBOX') {
  1093.             $boxesnew[] = $boxesall[$k];
  1094.             $used[$k] = true;
  1095.             $has_inbox = true;
  1096.             break;
  1097.         }
  1098.     }
  1099.  
  1100.     if ($has_inbox == false) {
  1101.         // do a list request for inbox because we should always show
  1102.         // inbox even if the user isn't subscribed to it.
  1103.         $inbox_ary = sqimap_run_command($imap_stream, 'LIST "" "INBOX"',
  1104.                                         true, $response, $message);
  1105.         $inbox_ary = compact_mailboxes_response($inbox_ary);
  1106.         if (count($inbox_ary)) {
  1107.             $inbox_entry = sqimap_mailbox_parse($inbox_ary);
  1108.             // add it on top of the list
  1109.             if (!empty($boxesnew)) {
  1110.                 array_unshift($boxesnew,$inbox_entry[0]);
  1111.             } else {
  1112.                 $boxesnew[]=$inbox_entry[0];
  1113.             }
  1114.             /* array_unshift($used,true); */
  1115.         }
  1116.     }
  1117.  
  1118.     /* List special folders and their subfolders, if requested. */
  1119.     if ($list_special_folders_first) {
  1120.         for($k = 0; $k < $cnt; ++$k) {
  1121.             if (!$used[$k] && isSpecialMailbox($boxesall[$k]['unformatted'])) {
  1122.                 $boxesnew[] = $boxesall[$k];
  1123.                 $used[$k]   = true;
  1124.             }
  1125.         }
  1126.     }
  1127.  
  1128.     /* Find INBOX's children */
  1129.     for($k = 0; $k < $cnt; ++$k) {
  1130.         $isboxbelow=isBoxBelow(strtoupper($boxesall[$k]['unformatted']),'INBOX');
  1131.         if (strtoupper($boxesall[$k]['unformatted']) == 'INBOX') {
  1132.             $is_inbox=1;
  1133.         } else {
  1134.             $is_inbox=0;
  1135.         }
  1136.  
  1137.         if (!$used[$k] && $isboxbelow && $is_inbox) {
  1138.             $boxesnew[] = $boxesall[$k];
  1139.             $used[$k] = true;
  1140.         }
  1141.     }
  1142.  
  1143.     /* Rest of the folders */
  1144.     for($k = 0; $k < $cnt; $k++) {
  1145.         if (!$used[$k]) {
  1146.             $boxesnew[] = $boxesall[$k];
  1147.         }
  1148.     }
  1149.     /**
  1150.      * Don't register boxes in session, if $session_register is set to false
  1151.      * Prevents registration of sqimap_mailbox_list_all() results.
  1152.      */
  1153.     if ($session_register) sqsession_register($boxesnew,'boxesnew');
  1154.     return $boxesnew;
  1155. }
  1156.  
  1157. /**
  1158.  * Fills mailbox object
  1159.  *
  1160.  * this is passed the mailbox array by left_main.php
  1161.  * who has previously obtained it from sqimap_get_mailboxes
  1162.  * that way, the raw mailbox list is available in left_main to other
  1163.  * things besides just sqimap_mailbox_tree
  1164.  * imap_stream is just used now to get status info
  1165.  *
  1166.  * most of the functionality is moved to sqimap_get_mailboxes
  1167.  * also takes care of TODO items:
  1168.  * caching mailbox tree
  1169.  * config setting for UW imap section (not needed now)
  1170.  *
  1171.  * Some code fragments are present in 1.3.0 - 1.4.4.
  1172.  * @param stream $imap_stream imap connection resource
  1173.  * @param array $lsub_ary output array from sqimap_get_mailboxes (contains mailboxes and flags)
  1174.  * @return object see mailboxes class.
  1175.  * @since 1.5.0
  1176.  */
  1177. function sqimap_mailbox_tree($imap_stream,$lsub_ary) {
  1178.  
  1179.     $sorted_lsub_ary = array();
  1180.     $cnt = count($lsub_ary);
  1181.     for ($i = 0; $i < $cnt; $i++) {
  1182.         $mbx=$lsub_ary[$i]['unformatted'];
  1183.         $flags=$lsub_ary[$i]['flags'];
  1184.  
  1185.         $noinferiors=0;
  1186.         if (in_array('\Noinferiors',$flags)) { $noinferiors=1; }
  1187.         if (in_array('\NoInferiors',$flags)) { $noinferiors=1; }
  1188.         if (in_array('\HasNoChildren',$flags)) { $noinferiors=1; }
  1189.  
  1190.         $noselect=0;
  1191.         if (in_array('\NoSelect',$flags)) { $noselect=1; }
  1192.         /**
  1193.          * LIST (SUBSCRIBED) has two new flags, \NonExistent which means the mailbox is subscribed to
  1194.          * but doesn't exist, and \PlaceHolder which is similar (but not the same) as \NoSelect
  1195.          * For right now, we'll treat these the same as \NoSelect and this behavior can be changed
  1196.          * later if needed
  1197.          */
  1198.         if (in_array('\NonExistent',$flags)) { $noselect=1; }
  1199.         if (in_array('\PlaceHolder',$flags)) { $noselect=1; }
  1200.         $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors);
  1201.     }
  1202.  
  1203.     $sorted_lsub_ary = array_values($sorted_lsub_ary);
  1204.     usort($sorted_lsub_ary, 'mbxSort');
  1205.     $boxestree = sqimap_fill_mailbox_tree($sorted_lsub_ary,false,$imap_stream);
  1206.     return $boxestree;
  1207. }
  1208.  
  1209. /**
  1210.  * Callback function used for sorting mailboxes in sqimap_mailbox_tree
  1211.  * @param string $a 
  1212.  * @param string $b 
  1213.  * @return integer see php strnatcasecmp()
  1214.  * @since 1.5.1
  1215.  */
  1216. function mbxSort($a, $b) {
  1217.     return strnatcasecmp($a['mbx'], $b['mbx']);
  1218. }
  1219.  
  1220. /**
  1221.  * Fills mailbox object
  1222.  *
  1223.  * Some code fragments are present in 1.3.0 - 1.4.4.
  1224.  * @param array $mbx_ary 
  1225.  * @param $mbxs 
  1226.  * @param stream $imap_stream imap connection resource
  1227.  * @return object see mailboxes class
  1228.  * @since 1.5.0
  1229.  */
  1230. function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) {
  1231.     global $data_dir, $username, $list_special_folders_first,
  1232.            $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
  1233.            $move_to_trash, $move_to_sent, $save_as_draft,
  1234.            $delimiter, $imap_server_type;
  1235.  
  1236.     // $special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder);
  1237.  
  1238.     /* create virtual root node */
  1239.     $mailboxes= new mailboxes();
  1240.     $mailboxes->is_root = true;
  1241.     $trail_del = false;
  1242.     $start = 0;
  1243.  
  1244.     if (isset($folder_prefix) && ($folder_prefix != '')) {
  1245.         $start = substr_count($folder_prefix,$delimiter);
  1246.         if (strrpos($folder_prefix, $delimiter) == (strlen($folder_prefix)-1)) {
  1247.             $mailboxes->mailboxname_full = substr($folder_prefix,0, (strlen($folder_prefix)-1));
  1248.         } else {
  1249.             $mailboxes->mailboxname_full = $folder_prefix;
  1250.             $start++;
  1251.         }
  1252.         $mailboxes->mailboxname_sub = $mailboxes->mailboxname_full;
  1253.     } else {
  1254.         $start = 0;
  1255.     }
  1256.  
  1257.     $cnt = count($mbx_ary);
  1258.     for ($i=0; $i < $cnt; $i++) {
  1259.         if ($mbx_ary[$i]['mbx'] !='' ) {
  1260.             $mbx = new mailboxes();
  1261.             $mailbox = $mbx_ary[$i]['mbx'];
  1262.  
  1263.             /*
  1264.              * Set the is_special flag if it concerned a special mailbox.
  1265.              * Used for displaying the special folders on top in the mailbox
  1266.              * tree displaying code.
  1267.              */
  1268.             $mbx->is_special |= ($mbx->is_inbox = (strtoupper($mailbox) == 'INBOX'));
  1269.             $mbx->is_special |= ($mbx->is_trash = isTrashMailbox($mailbox));
  1270.             $mbx->is_special |= ($mbx->is_sent = isSentMailbox($mailbox));
  1271.             $mbx->is_special |= ($mbx->is_draft = isDraftMailbox($mailbox));
  1272.  
  1273.             if (!$mbx->is_special)
  1274.                 $mbx->is_special = boolean_hook_function('special_mailbox', $mailbox, 1);
  1275.  
  1276.             if (isset($mbx_ary[$i]['unseen'])) {
  1277.                 $mbx->unseen = $mbx_ary[$i]['unseen'];
  1278.             }
  1279.             if (isset($mbx_ary[$i]['nummessages'])) {
  1280.                 $mbx->total = $mbx_ary[$i]['nummessages'];
  1281.             }
  1282.  
  1283.             $mbx->is_noselect = $mbx_ary[$i]['noselect'];
  1284.             $mbx->is_noinferiors = $mbx_ary[$i]['noinferiors'];
  1285.  
  1286.             $r_del_pos = strrpos($mbx_ary[$i]['mbx'], $delimiter);
  1287.             if ($r_del_pos) {
  1288.                 $mbx->mailboxname_sub = substr($mbx_ary[$i]['mbx'],$r_del_pos+1);
  1289.             } else {   /* mailbox is root folder */
  1290.                 $mbx->mailboxname_sub = $mbx_ary[$i]['mbx'];
  1291.             }
  1292.             $mbx->mailboxname_full = $mbx_ary[$i]['mbx'];
  1293.  
  1294.             $mailboxes->addMbx($mbx, $delimiter, $start, $list_special_folders_first);
  1295.         }
  1296.     }
  1297.     sqimap_utf7_decode_mbx_tree($mailboxes);
  1298.     sqimap_get_status_mbx_tree($imap_stream,$mailboxes);
  1299.     return $mailboxes;
  1300. }
  1301.  
  1302. /**
  1303.  * @param object $mbx_tree 
  1304.  * @since 1.5.0
  1305.  */
  1306. function sqimap_utf7_decode_mbx_tree(&$mbx_tree) {
  1307.     global $draft_folder, $sent_folder, $trash_folder, $translate_special_folders;
  1308.  
  1309.     /* decode folder name and set mailboxname_sub */
  1310.     if ($translate_special_folders && strtoupper($mbx_tree->mailboxname_full) == 'INBOX') {
  1311.         $mbx_tree->mailboxname_sub = _("INBOX");
  1312.     } elseif ($translate_special_folders && $mbx_tree->mailboxname_full == $draft_folder) {
  1313.         $mbx_tree->mailboxname_sub = _("Drafts");
  1314.     } elseif ($translate_special_folders && $mbx_tree->mailboxname_full == $sent_folder) {
  1315.         $mbx_tree->mailboxname_sub = _("Sent");
  1316.     } elseif ($translate_special_folders && $mbx_tree->mailboxname_full == $trash_folder) {
  1317.         $mbx_tree->mailboxname_sub = _("Trash");
  1318.     } else {
  1319.         $mbx_tree->mailboxname_sub = imap_utf7_decode_local($mbx_tree->mailboxname_sub);
  1320.     }
  1321.  
  1322.     if ($mbx_tree->mbxs) {
  1323.         $iCnt = count($mbx_tree->mbxs);
  1324.         for ($i=0;$i<$iCnt;++$i) {
  1325.             sqimap_utf7_decode_mbx_tree($mbx_tree->mbxs[$i]);
  1326.         }
  1327.     }
  1328. }
  1329.  
  1330. /**
  1331.  * @param object $mbx_tree 
  1332.  * @param array $aMbxs 
  1333.  * @since 1.5.0
  1334.  */
  1335. function sqimap_tree_to_ref_array(&$mbx_tree,&$aMbxs) {
  1336.    if ($mbx_tree)
  1337.    $aMbxs[] =& $mbx_tree;
  1338.    if ($mbx_tree->mbxs) {
  1339.       $iCnt = count($mbx_tree->mbxs);
  1340.       for ($i=0;$i<$iCnt;++$i) {
  1341.          sqimap_tree_to_ref_array($mbx_tree->mbxs[$i],$aMbxs);
  1342.       }
  1343.    }
  1344. }
  1345.  
  1346. /**
  1347.  * @param stream $imap_stream imap connection resource
  1348.  * @param object $mbx_tree 
  1349.  * @since since 1.5.0
  1350.  */
  1351. function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) {
  1352.     global $unseen_notify, $unseen_type, $trash_folder,$move_to_trash;
  1353.     $aMbxs = $aQuery = array();
  1354.     sqimap_tree_to_ref_array($mbx_tree,$aMbxs);
  1355.     // remove the root node
  1356.     array_shift($aMbxs);
  1357.  
  1358.     if($unseen_notify == 3) {
  1359.         $cnt = count($aMbxs);
  1360.         for($i=0;$i<$cnt;++$i) {
  1361.             $oMbx =& $aMbxs[$i];
  1362.             if (!$oMbx->is_noselect) {
  1363.                 $mbx = $oMbx->mailboxname_full;
  1364.                 if ($unseen_type == 2 ||
  1365.                    ($move_to_trash && $oMbx->mailboxname_full == $trash_folder)) {
  1366.                    $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (MESSAGES UNSEEN RECENT)';
  1367.                 } else {
  1368.                    $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (UNSEEN RECENT)';
  1369.                 }
  1370.                 sqimap_prepare_pipelined_query($query,$tag,$aQuery,false);
  1371.             } else {
  1372.                 $oMbx->unseen = $oMbx->total = $oMbx->recent = false;
  1373.                 $tag = false;
  1374.             }
  1375.             $oMbx->tag = $tag;
  1376.             $aMbxs[$i] =& $oMbx;
  1377.         }
  1378.         // execute all the queries at once
  1379.         $aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage);
  1380.         $cnt = count($aMbxs);
  1381.         for($i=0;$i<$cnt;++$i) {
  1382.             $oMbx =& $aMbxs[$i];
  1383.             $tag = $oMbx->tag;
  1384.             if ($tag && $aServerResponse[$tag] == 'OK') {
  1385.                 $sResponse = implode('', $aResponse[$tag]);
  1386.                 if (preg_match('/UNSEEN\s+([0-9]+)/i', $sResponse, $regs)) {
  1387.                     $oMbx->unseen = $regs[1];
  1388.                 }
  1389.                 if (preg_match('/MESSAGES\s+([0-9]+)/i', $sResponse, $regs)) {
  1390.                     $oMbx->total = $regs[1];
  1391.                 }
  1392.                 if (preg_match('/RECENT\s+([0-9]+)/i', $sResponse, $regs)) {
  1393.                     $oMbx->recent = $regs[1];
  1394.                 }
  1395.  
  1396.            }
  1397.            unset($oMbx->tag);
  1398.         }
  1399.     } else if ($unseen_notify == 2) { // INBOX only
  1400.         $cnt = count($aMbxs);
  1401.         for($i=0;$i<$cnt;++$i) {
  1402.             $oMbx =& $aMbxs[$i];
  1403.             if (strtoupper($oMbx->mailboxname_full) == 'INBOX' ||
  1404.                ($move_to_trash && $oMbx->mailboxname_full == $trash_folder)) {
  1405.                  if ($unseen_type == 2 ||
  1406.                    ($oMbx->mailboxname_full == $trash_folder && $move_to_trash)) {
  1407.                     $aStatus = sqimap_status_messages($imap_stream,$oMbx->mailboxname_full);
  1408.                     $oMbx->unseen = $aStatus['UNSEEN'];
  1409.                     $oMbx->total  = $aStatus['MESSAGES'];
  1410.                     $oMbx->recent = $aStatus['RECENT'];
  1411.                 } else {
  1412.                     $oMbx->unseen = sqimap_unseen_messages($imap_stream,$oMbx->mailboxname_full);
  1413.                 }
  1414.                 $aMbxs[$i] =& $oMbx;
  1415.                 if (!$move_to_trash && $trash_folder) {
  1416.                     break;
  1417.                 } else {
  1418.                    // trash comes after INBOX
  1419.                    if ($oMbx->mailboxname_full == $trash_folder) {
  1420.                       break;
  1421.                    }
  1422.                 }
  1423.             }
  1424.         }
  1425.     }
  1426.  
  1427.     $cnt = count($aMbxs);
  1428.     for($i=0;$i<$cnt;++$i) {
  1429.          $oMbx =& $aMbxs[$i];
  1430.          unset($hook_status);
  1431.          if (!empty($oMbx->unseen)) { $hook_status['UNSEEN']=$oMbx->unseen; }
  1432.          if (!empty($oMbx->total)) { $hook_status['MESSAGES']=$oMbx->total; }
  1433.          if (!empty($oMbx->recent)) { $hook_status['RECENT']=$oMbx->recent; }
  1434.          if (!empty($hook_status))
  1435.          {
  1436.               $hook_status['MAILBOX']=$oMbx->mailboxname_full;
  1437.               $hook_status['CALLER']='sqimap_get_status_mbx_tree'; // helps w/ debugging
  1438.               do_hook('folder_status', $hook_status);
  1439.          }
  1440.     }
  1441. }
  1442.  
  1443. /**
  1444.  * Checks if folder is noselect (can't store messages)
  1445.  *
  1446.  * Function does not check if folder subscribed.
  1447.  * @param stream $oImapStream imap connection resource
  1448.  * @param string $sImapFolder imap folder name
  1449.  * @param object $oBoxes mailboxes class object.
  1450.  * @return boolean true, when folder has noselect flag. false in any other case.
  1451.  * @since 1.5.1
  1452.  */
  1453. function sqimap_mailbox_is_noselect($oImapStream,$sImapFolder,&$oBoxes) {
  1454.     // build mailbox object if it is not available
  1455.     if (! is_object($oBoxes)) $oBoxes=sqimap_mailbox_list($oImapStream);
  1456.     foreach($oBoxes as $box) {
  1457.         if ($box['unformatted']==$sImapFolder) {
  1458.             return (bool) check_is_noselect($box['raw']);
  1459.         }
  1460.     }
  1461.     return false;
  1462. }
  1463.  
  1464. /**
  1465.  * Checks if folder is noinferiors (can't store other folders)
  1466.  *
  1467.  * Function does not check if folder subscribed.
  1468.  * @param stream $oImapStream imap connection resource
  1469.  * @param string $sImapFolder imap folder name
  1470.  * @param object $oBoxes mailboxes class object.
  1471.  * @return boolean true, when folder has noinferiors flag. false in any other case.
  1472.  * @since 1.5.1
  1473.  */
  1474. function sqimap_mailbox_is_noinferiors($oImapStream,$sImapFolder,&$oBoxes) {
  1475.     // build mailbox object if it is not available
  1476.     if (! is_object($oBoxes)) $oBoxes=sqimap_mailbox_list($oImapStream);
  1477.     foreach($oBoxes as $box) {
  1478.         if ($box['unformatted']==$sImapFolder) {
  1479.             return (bool) check_is_noinferiors($box['raw']);
  1480.         }
  1481.     }
  1482.     return false;
  1483. }

Documentation generated on Wed, 19 Jun 2013 04:19:39 +0200 by phpDocumentor 1.4.3