Plugins like listcommands should not close their own pages without displaying errors...
[squirrelmail.git] / plugins / newmail / functions.php
index ecb41ecd2a8a2bb931112dc6642c4d2df6f9b72f..f92de319fc095da2800db6dcfb0245586ab3ddd8 100644 (file)
@@ -1,20 +1,18 @@
 <?php
+
 /**
  * SquirrelMail NewMail plugin
  *
  * Functions
+ *
+ * @copyright &copy; 2001-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package plugins
  * @subpackage newmail
+ * @todo add midi support
  */
 
-/** @ignore */
-if (! defined('SM_PATH')) define('SM_PATH','../../');
-
-/**
- * sqm_baseuri() function for setups that don't load it by default
- */
-include_once(SM_PATH . 'functions/display_messages.php');
 
 /** file type defines */
 define('SM_NEWMAIL_FILETYPE_WAV',2);
@@ -44,27 +42,24 @@ function newmail_optpage_register_block_function() {
     // Gets added to the user's OPTIONS page.
     global $optpage_blocks;
 
-    if ( checkForJavascript() ) {
-        /* Register Squirrelspell with the $optionpages array. */
-        $optpage_blocks[] = array(
-            'name' => _("NewMail Options"),
-            'url'  => sqm_baseuri() . 'plugins/newmail/newmail_opt.php',
-            'desc' => _("This configures settings for playing sounds and/or showing popup windows when new mail arrives."),
-            'js'   => TRUE
-            );
-    }
+    /* Register Squirrelspell with the $optionpages array. */
+    $optpage_blocks[] = array(
+        'name' => _("NewMail Options"),
+        'url'  => sqm_baseuri() . 'plugins/newmail/newmail_opt.php',
+        'desc' => _("This configures settings for playing sounds and/or showing popup windows when new mail arrives."),
+        'js'   => TRUE
+        );
 }
 
 /**
  * Save newmail plugin settings
  */
 function newmail_sav_function() {
-    global $data_dir, $username, $_FILES;
+    global $data_dir, $username, $_FILES, $newmail_uploadsounds;
 
     if ( sqgetGlobalVar('submit_newmail', $submit, SQ_POST) ) {
         $media_enable = '';
         $media_popup = '';
-        $media_allbox = '';
         $media_recent = '';
         $media_changetitle = '';
         $media_sel = '';
@@ -73,7 +68,6 @@ function newmail_sav_function() {
 
         sqgetGlobalVar('media_enable',      $media_enable,      SQ_POST);
         sqgetGlobalVar('media_popup',       $media_popup,       SQ_POST);
-        sqgetGlobalVar('media_allbox',      $media_allbox,      SQ_POST);
         sqgetGlobalVar('media_recent',      $media_recent,      SQ_POST);
         sqgetGlobalVar('media_changetitle', $media_changetitle, SQ_POST);
         sqgetGlobalVar('popup_width',       $popup_width,       SQ_POST);
@@ -87,12 +81,16 @@ function newmail_sav_function() {
 
         setPref($data_dir,$username,'newmail_enable',$media_enable);
         setPref($data_dir,$username,'newmail_popup', $media_popup);
-        setPref($data_dir,$username,'newmail_allbox',$media_allbox);
         setPref($data_dir,$username,'newmail_recent',$media_recent);
         setPref($data_dir,$username,'newmail_changetitle',$media_changetitle);
         setPref($data_dir,$username,'newmail_popup_width',$popup_width);
         setPref($data_dir,$username,'newmail_popup_height',$popup_height);
 
+        if (sqgetGlobalVar('newmail_unseen_notify', $newmail_unseen_notify, SQ_POST)) {
+            $newmail_unseen_notify = (int) $newmail_unseen_notify;
+            setPref($data_dir,$username,'newmail_unseen_notify',$newmail_unseen_notify);
+        }
+
         if( sqgetGlobalVar('media_sel', $media_sel, SQ_POST) &&
             $media_sel == '(none)' ) {
             removePref($data_dir,$username,'newmail_media');
@@ -101,7 +99,7 @@ function newmail_sav_function() {
         }
 
         // process uploaded file
-        if (isset($_FILES['media_file']['tmp_name']) && $_FILES['media_file']['tmp_name']!='') {
+        if ($newmail_uploadsounds && isset($_FILES['media_file']['tmp_name']) && $_FILES['media_file']['tmp_name']!='') {
             // set temp file and get media file name
             $newmail_tempmedia=getHashedDir($username, $data_dir) . "/$username.tempsound";
             $newmail_mediafile=getHashedFile($username, $data_dir, $username . '.sound');
@@ -136,22 +134,28 @@ function newmail_sav_function() {
  */
 function newmail_pref_function() {
     global $username,$data_dir;
-    global $newmail_media,$newmail_enable,$newmail_popup,$newmail_allbox;
+    global $newmail_media,$newmail_media_enable,$newmail_popup;
     global $newmail_recent, $newmail_changetitle;
     global $newmail_userfile_type, $newmail_userfile_name;
     global $newmail_popup_width, $newmail_popup_height;
+    global $newmail_unseen_notify;
 
     $newmail_recent = getPref($data_dir,$username,'newmail_recent');
-    $newmail_enable = getPref($data_dir,$username,'newmail_enable');
+    $newmail_media_enable = getPref($data_dir,$username,'newmail_enable');
     $newmail_media = getPref($data_dir, $username, 'newmail_media', '(none)');
+    // remove full location from setting (since SM 1.5.1 plugin uses only filename).
+    if ($newmail_media!='(none)')
+        $newmail_media = basename($newmail_media);
+
     $newmail_popup = getPref($data_dir, $username, 'newmail_popup');
     $newmail_popup_width = getPref($data_dir, $username, 'newmail_popup_width',200);
     $newmail_popup_height = getPref($data_dir, $username, 'newmail_popup_height',130);
-    $newmail_allbox = getPref($data_dir, $username, 'newmail_allbox');
     $newmail_changetitle = getPref($data_dir, $username, 'newmail_changetitle');
 
     $newmail_userfile_type = getPref($data_dir, $username, 'newmail_userfile_type');
     $newmail_userfile_name = getPref($data_dir,$username,'newmail_userfile_name','');
+
+    $newmail_unseen_notify = getPref($data_dir,$username,'newmail_unseen_notify',0);
 }
 
 /**
@@ -166,72 +170,75 @@ function newmail_set_loadinfo_function() {
     }
 }
 
+
+/* Receive the status of the folder and do something with it */
+function newmail_folder_status($statusarr) {
+    global $newmail_media_enable,$newmail_popup,$newmail_changetitle,$trash_folder,
+           $sent_folder,$totalNewArr, $newmail_unseen_notify, $unseen_notify, $newmail_recent;
+
+    /* if $newmail_unseen_notify is set to zero, plugin follows $unseen_notify */
+    if ($newmail_unseen_notify == 0)
+        $newmail_unseen_notify = $unseen_notify;
+
+    $mailbox=$statusarr['MAILBOX'];
+
+    if (($newmail_media_enable == 'on' ||
+        $newmail_popup == 'on' ||
+        $newmail_changetitle == 'on') &&
+        /**
+         * make sure that $newmail_unseen_notify is set to supported value,
+         * currently (1.5.2cvs) SMPREF_UNSEEN_NORMAL has highest integer value
+         * in SMPREF_UNSEEN constants
+         */
+        ($newmail_unseen_notify > SMPREF_UNSEEN_NONE && $newmail_unseen_notify <= SMPREF_UNSEEN_NORMAL)) {
+
+        // Skip folders for Sent and Trash
+        // TODO: make this optional
+        if ($statusarr['MAILBOX'] == $sent_folder || $statusarr['MAILBOX'] == $trash_folder) {
+            return 0;
+        }
+
+        if ((($mailbox == 'INBOX') && ($newmail_unseen_notify == SMPREF_UNSEEN_INBOX)) ||
+            ($newmail_unseen_notify == SMPREF_UNSEEN_SPECIAL && isSpecialMailbox($mailbox)) ||
+            ($newmail_unseen_notify == SMPREF_UNSEEN_NORMAL && ! isSpecialMailbox($mailbox)) ||
+            ($newmail_unseen_notify == SMPREF_UNSEEN_ALL)) {
+            if (($newmail_recent == 'on') && (!empty($statusarr['RECENT']))) {
+                $totalNewArr[$mailbox] = $statusarr['RECENT'];
+            } elseif ($newmail_recent != 'on' && !empty($statusarr['UNSEEN'])) {
+                $totalNewArr[$mailbox] = $statusarr['UNSEEN'];
+            }
+        }
+    }
+}
+
 /**
  * Insert needed data in left_main
  */
 function newmail_plugin_function() {
-    global $username, $newmail_media, $newmail_enable, $newmail_popup,
+    global $username, $newmail_media, $newmail_media_enable, $newmail_popup,
         $newmail_recent, $newmail_changetitle, $imapConnection, $PHP_SELF;
     global $newmail_mmedia, $newmail_allowsound;
     global $newmail_userfile_type;
     global $newmail_popup_width, $newmail_popup_height;
+    global $totalNewArr;
 
-    if ($newmail_enable == 'on' ||
+    if ($newmail_media_enable == 'on' ||
         $newmail_popup == 'on' ||
         $newmail_changetitle) {
 
-        // open a connection on the imap port (143)
-
-        $boxes = sqimap_mailbox_list($imapConnection);
-        $delimeter = sqimap_get_delimiter($imapConnection);
-
-        $status = 0;
-        $totalNew = 0;
-
-        for ($i = 0;$i < count($boxes); $i++) {
-
-            $mailbox = $boxes[$i]['formatted'];
-
-            if (! isset($boxes[$i]['unseen'])) {
-                $boxes[$i]['unseen'] = '';
-            }
-            if ($boxes[$i]['flags']) {
-                $noselect = false;
-                for ($h = 0; $h < count($boxes[$i]['flags']); $h++) {
-                    if (strtolower($boxes[$i]["flags"][$h]) == 'noselect') {
-                        $noselect = TRUE;
-                    }
-                }
-                if (! $noselect) {
-                    $status += CheckNewMailboxSound($imapConnection,
-                                                    $mailbox,
-                                                    $boxes[$i]['unformatted'],
-                                                    $delimeter,
-                                                    $boxes[$i]['unseen'],
-                                                    $totalNew);
-                }
-            } else {
-                $status += CheckNewMailboxSound($imapConnection,
-                                                $mailbox,
-                                                $boxes[$i]['unformatted'],
-                                                $delimeter,
-                                                $boxes[$i]['unseen'],
-                                                $totalNew);
-            }
-        }
-
-        // sqimap_logout($imapConnection);
+        if (!empty($totalNewArr)) { $totalNew=array_sum($totalNewArr); }
+        else { $totalNew=0; }
 
         // If we found unseen messages, then we
         // will play the sound as follows:
 
         if ($newmail_changetitle) {
-            echo "<script language=\"javascript\" type=\"text/javascript\">\n" .
+            echo "<script type=\"text/javascript\">\n" .
                 "function ChangeTitleLoad() {\n";
             echo 'window.parent.document.title = "' .
                 sprintf(ngettext("%s New Message","%s New Messages",$totalNew), $totalNew) .
                 "\";\n";
-            echo    "if (BeforeChangeTitle != null)\n".
+            echo "if (BeforeChangeTitle != null)\n".
                 "BeforeChangeTitle();\n".
                 "}\n".
                 "BeforeChangeTitle = window.onload;\n".
@@ -240,7 +247,9 @@ function newmail_plugin_function() {
         }
 
         // create media output if there are new email messages
-        if ($newmail_allowsound && $totalNew > 0 && $newmail_enable == 'on' && $newmail_media != '' ) {
+        if ($newmail_allowsound && $totalNew > 0
+            && $newmail_media_enable == 'on'
+            && $newmail_media != '' ) {
             echo newmail_create_media_tags($newmail_media);
         }
 
@@ -248,7 +257,7 @@ function newmail_plugin_function() {
             // Idea by:  Nic Wolfe (Nic@TimelapseProductions.com)
             // Web URL:  http://fineline.xs.mw
             // More code from Tyler Akins
-            echo "<script language=\"JavaScript\">\n".
+            echo "<script type=\"text/javascript\">\n".
                 "<!--\n".
                 "function PopupScriptLoad() {\n".
                 'window.open("'.sqm_baseuri().'plugins/newmail/newmail.php?numnew='.$totalNew.
@@ -267,45 +276,7 @@ function newmail_plugin_function() {
 
 // ----- end of hooked functions -----
 
-/**
- * Checks if mailbox contains new messages.
- *
- * @param stream $imapConnection
- * @param string $mailbox FIXME: option is not used
- * @param string $real_box unformated mailbox name
- * @param string $delimeter FIXME: option is not used
- * @param string $unseen FIXME: option is not used
- * @param integer $total_new number of new messages
- * @return bool true, if there are new messages
- */
-function CheckNewMailboxSound($imapConnection, $mailbox, $real_box, $delimeter, $unseen, &$total_new) {
-    global $trash_folder, $sent_folder,
-        $unseen_notify, $newmail_allbox,
-        $newmail_recent;
-
-    $mailboxURL = urlencode($real_box);
-
-    // Skip folders for Sent and Trash
-    if ($real_box == $sent_folder ||
-        $real_box == $trash_folder) {
-        return 0;
-    }
 
-    if (($unseen_notify == 2 && $real_box == 'INBOX') ||
-        ($unseen_notify == 3 && ($newmail_allbox == 'on' ||
-                                 $real_box == 'INBOX'))) {
-        $status = sqimap_status_messages( $imapConnection, $real_box);
-        if($newmail_recent == 'on') {
-            $total_new += $status['RECENT'];
-        } else {
-            $total_new += $status['UNSEEN'];
-        }
-        if ($total_new) {
-            return 1;
-        }
-    }
-    return 0;
-}
 
 /**
  * Function tries to detect if file contents match declared file type
@@ -421,13 +392,15 @@ function newmail_media_objects($object,$types,$path,$args=array(),$extra='',$add
 
     if (isset($newmail_mediacompat_mode) && $newmail_mediacompat_mode)
         $ret.= newmail_media_embed($object,$types[0],$path,$args,$addsuffix);
-    // add $extra code inside objects 
+    // add $extra code inside objects
     if ($extra!='')
         $ret.=$extra . "\n";
 
+    // close embed tags
     if (isset($newmail_mediacompat_mode) && $newmail_mediacompat_mode)
         $ret.= newmail_media_embed_close($types[0]);
 
+    // close w3.org nested objects
     foreach (array_reverse($types) as $type) {
         $ret.= newmail_media_object_close($type);
     }
@@ -511,6 +484,7 @@ function newmail_media_object($object,$type,$path,$args=array(),$addsuffix=true)
  * @param array $args media object attributes
  * @param bool $addsuffix controls addition of suffix to media object url
  * @return string object html tags and attributes required by selected media type.
+ * @todo add ogg and svg support
  */
 function newmail_media_object_ie($object,$type,$path,$args=array(),$addsuffix) {
     $ret_ie='';
@@ -552,7 +526,7 @@ function newmail_media_object_ie($object,$type,$path,$args=array(),$addsuffix) {
 
 /**
  * Creates embed tags of multimedia object
- *        
+ *
  * docs about embed
  * Apple: http://www.apple.com/quicktime/authoring/embed.html
  *
@@ -593,11 +567,33 @@ function newmail_media_embed($object,$type,$path,$args=array(),$addsuffix=true)
             .' name="' . $object .'" ' . "\n"
             .' type="audio/x-wav">' . "\n";
         break;
+    case SM_NEWMAIL_FILETYPE_SVG:
+        if ($addsuffix) $suffix='.svg';
+        $ret_embed='<embed src="' . $path . $object . $suffix . '" '. "\n"
+            .'hidden="true" autostart="true" '. "\n"
+            .$sArgs . "\n"
+            .'name="' . $object .'" ' . "\n"
+            .'type="image/svg-xml" ' . "\n"
+            .'pluginspage="http://www.adobe.com/svg/viewer/install/">' . "\n";
+        break;
     case SM_NEWMAIL_FILETYPE_OGG:
+        if ($addsuffix) $suffix='.ogg';
+        $ret_embed='<embed src="' . $path . $object . $suffix . '" '. "\n"
+            .' hidden="true" autostart="true" '. "\n"
+            .' ' .$sArgs . "\n"
+            .' name="' . $object .'" ' . "\n"
+            .' type="application/ogg">' . "\n";
+        break;
     case SM_NEWMAIL_FILETYPE_MP3:
-    case SM_NEWMAIL_FILETYPE_SVG:
+        if ($addsuffix) $suffix='.mp3';
+        $ret_embed='<embed src="' . $path . $object . $suffix . '" '. "\n"
+            .' hidden="true" autostart="true" '. "\n"
+            .' ' .$sArgs . "\n"
+            .' name="' . $object .'" ' . "\n"
+            .' type="audio/mpeg">' . "\n";
+        break;
     default:
-        $ret_embed='';    
+        $ret_embed='';
     }
     return $ret_embed;
 }
@@ -605,7 +601,7 @@ function newmail_media_embed($object,$type,$path,$args=array(),$addsuffix=true)
 /**
  * Adds closing tags for ie object
  * Warning:
- * * This is internal function, use newmail_media_objects() instead 
+ * * This is internal function, use newmail_media_objects() instead
  * @param integer $type media object type
  * @return string closing tag of media object
  */
@@ -620,7 +616,7 @@ function newmail_media_object_ie_close($type) {
     case SM_NEWMAIL_FILETYPE_OGG:
     case SM_NEWMAIL_FILETYPE_SVG:
     default:
-        $ret_end='';    
+        $ret_end='';
     }
     return $ret_end;
 }
@@ -628,7 +624,7 @@ function newmail_media_object_ie_close($type) {
 /**
  * Adds closing tags for object
  * Warning:
- * * This is internal function, use newmail_media_objects() instead 
+ * * This is internal function, use newmail_media_objects() instead
  * @param integer $type media object type
  * @return string closing tag of media object
  */
@@ -643,7 +639,7 @@ function newmail_media_object_close($type) {
         $ret_end="</object>\n";
         break;
     default:
-        $ret_end='';    
+        $ret_end='';
     }
     return $ret_end;
 }
@@ -651,7 +647,7 @@ function newmail_media_object_close($type) {
 /**
  * Adds closing tags for object
  * Warning:
- * * This is internal function, use newmail_media_objects() instead 
+ * * This is internal function, use newmail_media_objects() instead
  * @param integer $type media object type
  * @return string closing tag of media object
  */
@@ -660,13 +656,13 @@ function newmail_media_embed_close($type) {
     switch ($type) {
     case SM_NEWMAIL_FILETYPE_SWF:
     case SM_NEWMAIL_FILETYPE_WAV:
-       $ret_end="</embed>\n";
-        break;
     case SM_NEWMAIL_FILETYPE_OGG:
     case SM_NEWMAIL_FILETYPE_MP3:
     case SM_NEWMAIL_FILETYPE_SVG:
+       $ret_end="</embed>\n";
+        break;
     default:
-        $ret_end='';    
+        $ret_end='';
     }
     return $ret_end;
 }
@@ -675,14 +671,14 @@ function newmail_media_embed_close($type) {
  * Converts media attributes to string
  * Warning:
  * * attribute values are automatically sanitized by htmlspecialchars()
- * * This is internal function, use newmail_media_objects() instead 
+ * * This is internal function, use newmail_media_objects() instead
  * @param array $args array with object attributes
  * @return string string with object attributes
  */
 function newmail_media_prepare_args($args) {
     $ret_args='';
     foreach ($args as $arg => $value) {
-        $ret_args.= $arg . '="' . htmlspecialchars($value) . '" '; 
+        $ret_args.= $arg . '="' . htmlspecialchars($value) . '" ';
     }
     return $ret_args;
 }
@@ -726,4 +722,3 @@ function newmail_create_media_tags($newmail_media) {
     }
     return $ret_media;
 }
-?>
\ No newline at end of file