Fix session autostart code - session_name() return value does not indicate session...
[squirrelmail.git] / plugins / newmail / functions.php
index cea3de729175be5a2fdcab505933685ee7e88124..c85f63e648fab25a88572e4fda3e0d916c1702e4 100644 (file)
@@ -5,7 +5,7 @@
  *
  * Functions
  *
- * @copyright © 2001-2006 The SquirrelMail Project Team
+ * @copyright © 2001-2007 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package plugins
  * @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);
@@ -51,7 +44,7 @@ function newmail_optpage_register_block_function() {
 
     /* Register Squirrelspell with the $optionpages array. */
     $optpage_blocks[] = array(
-        'name' => _("NewMail Options"),
+        'name' => _("New Mail 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
@@ -93,6 +86,11 @@ function newmail_sav_function() {
         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');
@@ -140,6 +138,7 @@ function newmail_pref_function() {
     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_media_enable = getPref($data_dir,$username,'newmail_enable');
@@ -155,6 +154,8 @@ function newmail_pref_function() {
 
     $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);
 }
 
 /**
@@ -165,7 +166,7 @@ function newmail_pref_function() {
 function newmail_set_loadinfo_function() {
     global $optpage, $optpage_name;
     if ($optpage=='newmail') {
-        $optpage_name=_("NewMail Options");
+        $optpage_name=_("New Mail Options");
     }
 }
 
@@ -173,24 +174,34 @@ 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,$unseen_notify, $newmail_recent;
+           $sent_folder,$totalNewArr, $newmail_unseen_notify, $unseen_notify, $newmail_recent;
 
-    //echo "GOT HOOK<br><pre>";
-    //var_dump($statusarr);
-    //echo "</pre><br>\n";
+    /* 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' ||
+    if (($newmail_media_enable == 'on' ||
         $newmail_popup == 'on' ||
-        $newmail_changetitle == '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') && ($unseen_notify == 2)) || ($unseen_notify == 3)) {
+        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'])) {
@@ -205,16 +216,18 @@ function newmail_folder_status($statusarr) {
  */
 function newmail_plugin_function() {
     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;
+           $newmail_recent, $newmail_changetitle, $imapConnection,
+           $newmail_mmedia, $newmail_allowsound, $newmail_userfile_type,
+           $newmail_popup_width, $newmail_popup_height, $totalNewArr,
+           $newmail_title_bar_singular, $newmail_title_bar_plural,
+           $org_title;
 
     if ($newmail_media_enable == 'on' ||
         $newmail_popup == 'on' ||
         $newmail_changetitle) {
 
+        $output = '';
+
         if (!empty($totalNewArr)) { $totalNew=array_sum($totalNewArr); }
         else { $totalNew=0; }
 
@@ -222,45 +235,64 @@ function newmail_plugin_function() {
         // will play the sound as follows:
 
         if ($newmail_changetitle) {
-            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".
-                "BeforeChangeTitle();\n".
-                "}\n".
-                "BeforeChangeTitle = window.onload;\n".
-                "window.onload = ChangeTitleLoad;\n".
-                "</script>\n";
+
+            // make sure default strings are in pot file
+            $ignore = _("%s New Message");
+            $ignore = _("%s New Messages");
+
+            $singular_title = "%s New Message";
+            $plural_title = "%s New Messages";
+            if (!empty($newmail_title_bar_singular))
+                $singular_title = $newmail_title_bar_singular;
+            if (!empty($newmail_title_bar_plural))
+                $plural_title = $newmail_title_bar_plural;
+            list($singular_title, $plural_title) = str_replace(array('###USERNAME###', '###ORG_TITLE###'), array($username, $org_title), array($singular_title, $plural_title));
+            $title = sprintf(ngettext($singular_title, $plural_title, $totalNew), $totalNew);
+
+//FIXME: remove HTML from core - put this into a template file
+            $output .= "<script type=\"text/javascript\">\n"
+                    . "function ChangeTitleLoad() {\n"
+                    . "var BeforeChangeTitle;\n"
+                    . 'window.parent.document.title = "'
+                    . $title
+                    . "\";\n"
+                    . "if (BeforeChangeTitle != null)\n"
+                    . "BeforeChangeTitle();\n"
+                    . "}\n"
+                    . "BeforeChangeTitle = window.onload;\n"
+                    . "window.onload = ChangeTitleLoad;\n"
+                    . "</script>\n";
         }
 
         // create media output if there are new email messages
         if ($newmail_allowsound && $totalNew > 0
-            && $newmail_media_enable == 'on'
-            && $newmail_media != '' ) {
-            echo newmail_create_media_tags($newmail_media);
+         && $newmail_media_enable == 'on'
+         && $newmail_media != '' ) {
+//FIXME: remove HTML from core - put this into a template file
+            $output .= newmail_create_media_tags($newmail_media);
         }
 
         if ($totalNew > 0 && $newmail_popup == 'on') {
-            // Idea by:  Nic Wolfe (Nic@TimelapseProductions.com)
-            // Web URL:  http://fineline.xs.mw
-            // More code from Tyler Akins
-            echo "<script type=\"text/javascript\">\n".
-                "<!--\n".
-                "function PopupScriptLoad() {\n".
-                'window.open("'.sqm_baseuri().'plugins/newmail/newmail.php?numnew='.$totalNew.
-                '", "SMPopup",'.
-                "\"width=$newmail_popup_width,height=$newmail_popup_height,scrollbars=no\");\n".
-                "if (BeforePopupScript != null)\n".
-                "BeforePopupScript();\n".
-                "}\n".
-                "BeforePopupScript = window.onload;\n".
-                "window.onload = PopupScriptLoad;\n".
-                "// End -->\n".
-                "</script>\n";
+//FIXME: remove HTML from core - put this into a template file
+            $output .= "<script type=\"text/javascript\">\n"
+                    . "<!--\n"
+                    . "function PopupScriptLoad() {\n"
+                    . 'window.open("'.sqm_baseuri().'plugins/newmail/newmail.php?numnew='.$totalNew
+                    . '", "SMPopup",'
+                    . "\"width=$newmail_popup_width,height=$newmail_popup_height,scrollbars=no\");\n"
+                    . "if (BeforePopupScript != null)\n"
+                    . "BeforePopupScript();\n"
+                    . "}\n"
+                    . "BeforePopupScript = window.onload;\n"
+                    . "window.onload = PopupScriptLoad;\n"
+                    . "// End -->\n"
+                    . "</script>\n";
         }
+
+        return array('left_main_after' => $output);
+
     }
+
 }
 
 // ----- end of hooked functions -----
@@ -711,4 +743,3 @@ function newmail_create_media_tags($newmail_media) {
     }
     return $ret_media;
 }
-?>
\ No newline at end of file