plugins/newmail/setup.php

   1 <?php
   2
   3    /**
   4     *  newmail.php
   5     *  (c)2000 by Michael Huttinger
   6     *
   7     *  Quite a hack -- but my first attempt at a plugin.  We were
   8     *  looking for a way to play a sound when there was unseen
   9     *  messages to look at.  Nice for users who keep the squirrel
  10     *  mail window up for long periods of time and want to know
  11     *  when mail arrives.
  12     *
  13     *  Basically, I hacked much of left_main.php into a plugin that
  14     *  goes through each mail folder and increments a flag if
  15     *  there are unseen messages.  If the final count of unseen
  16     *  folders is > 0, then we play a sound (using the HTML at the
  17     *  far end of this script).
  18     *
  19     *  This was tested with IE5.0 - but I hear Netscape works well,
  20     *  too (with a plugin).
  21     *
  22     *  $Id$
  23     *
  24     */
  25
  26     function CheckNewMailboxSound($imapConnection, $mailbox, $real_box, $delimeter, $unseen, &$total_unseen) {
  27         global $folder_prefix, $trash_folder, $sent_folder;
  28         global $color, $move_to_sent, $move_to_trash;
  29         global $unseen_notify, $unseen_type, $newmail_allbox, $newmail_recent;
  30         global $newmail_changetitle;
  31
  32         $mailboxURL = urlencode($real_box);
  33         $unseen_found = 0;
  34
  35         // Skip folders for Sent and Trash
  36
  37         if ($real_box == $sent_folder ||
  38             $real_box == $trash_folder) {
  39             return 0;
  40         }
  41
  42         if (($unseen_notify == 2 && $real_box == 'INBOX') ||
  43             ($unseen_notify == 3 && ($newmail_allbox == 'on' ||
  44                                      $real_box == 'INBOX'))) {
  45             $unseen = sqimap_unseen_messages($imapConnection, $real_box);
  46             $total_unseen += $unseen;
  47
  48             if($newmail_recent == 'on') {
  49                 $unseen = sqimap_mailbox_select( $imapConnection, $real_box, TRUE, TRUE);
  50             }
  51
  52             if ($unseen > 0) {
  53                 $unseen_found = 1;
  54             }
  55         }
  56         return( $unseen_found );
  57     }
  58
  59     function squirrelmail_plugin_init_newmail() {
  60         global $squirrelmail_plugin_hooks;
  61
  62         $squirrelmail_plugin_hooks['left_main_before']['newmail'] = 'newmail_plugin';
  63         $squirrelmail_plugin_hooks['optpage_register_block']['newmail'] = 'newmail_optpage_register_block';
  64         $squirrelmail_plugin_hooks['options_save']['newmail'] = 'newmail_sav';
  65         $squirrelmail_plugin_hooks['loading_prefs']['newmail'] = 'newmail_pref';
  66     }
  67
  68     function newmail_optpage_register_block() {
  69        // Gets added to the user's OPTIONS page.
  70        global $optpage_blocks;
  71
  72        if ( !soupNazi() ) {
  73
  74            /* Register Squirrelspell with the $optionpages array. */
  75            $optpage_blocks[] = array(
  76                'name' => _("NewMail Options"),
  77                'url'  => '../plugins/newmail/newmail_opt.php',
  78                'desc' => _("This configures settings for playing sounds and/or showing popup windows when new mail arrives."),
  79                'js'   => TRUE
  80             );
  81         }
  82     }
  83
  84     function newmail_sav() {
  85
  86         global $username,$data_dir;
  87         global $submit_newmail,$media_file,$media_reset,$media_enable,$media_popup;
  88         global $media_recent,$media_sel;
  89         global $media_allbox, $media_changetitle;
  90
  91         if ( isset($submit_newmail) ) {
  92
  93             if(isset($media_enable)) {
  94                 setPref($data_dir,$username,'newmail_enable',$media_enable);
  95             } else {
  96                 setPref($data_dir,$username,'newmail_enable','');
  97             }
  98             if(isset($media_popup)) {
  99                 setPref($data_dir,$username,'newmail_popup',$media_popup);
 100             } else {
 101                 setPref($data_dir,$username,'newmail_popup','');
 102             }
 103             if(isset($media_allbox)) {
 104                 setPref($data_dir,$username,'newmail_allbox',$media_allbox);
 105             } else {
 106                 setPref($data_dir,$username,'newmail_allbox','');
 107             }
 108             if(isset($media_recent)) {
 109                 setPref($data_dir,$username,'newmail_recent',$media_recent);
 110             } else {
 111                 setPref($data_dir,$username,'newmail_recent','');
 112             }
 113             if(isset($media_changetitle)) {
 114                 setPref($data_dir,$username,'newmail_changetitle',$media_changetitle);
 115             } else {
 116                 setPref($data_dir,$username,'newmail_changetitle','');
 117             }
 118             if(isset($media_sel)) {
 119                 if($media_sel == '(local media)') {
 120                     setPref($data_dir,$username,'newmail_media',StripSlashes($media_file));
 121                 } else {
 122                     setPref($data_dir,$username,'newmail_media',$media_sel);
 123                 }
 124             } else {
 125                 setPref($data_dir,$username,'newmail_media','');
 126             }
 127             echo '<center> ' . _("New Mail Notification options saved") . '</center>';
 128         }
 129     }
 130
 131     function newmail_pref() {
 132
 133         global $username,$data_dir;
 134         global $newmail_media,$newmail_enable,$newmail_popup,$newmail_allbox;
 135         global $newmail_recent, $newmail_changetitle;
 136
 137         $newmail_recent = getPref($data_dir,$username,'newmail_recent');
 138         $newmail_enable = getPref($data_dir,$username,'newmail_enable');
 139         $newmail_media = getPref($data_dir, $username, 'newmail_media', '../plugins/newmail/sounds/Notify.wav');
 140         $newmail_popup = getPref($data_dir, $username, 'newmail_popup');
 141         $newmail_allbox = getPref($data_dir, $username, 'newmail_allbox');
 142         $newmail_changetitle = getPref($data_dir, $username, 'newmail_changetitle');
 143
 144     }
 145
 146     function newmail_plugin() {
 147
 148         global $username,$key,$imapServerAddress,$imapPort;
 149         global $newmail_media,$newmail_enable,$newmail_popup,$newmail_recent;
 150         global $newmail_changetitle;
 151         global $imapConnection;
 152
 153         if ($newmail_enable == 'on' ||
 154             $newmail_popup == 'on' ||
 155             $newmail_changetitle) {
 156
 157             // open a connection on the imap port (143)
 158
 159             $boxes = sqimap_mailbox_list($imapConnection);
 160             $delimeter = sqimap_get_delimiter($imapConnection);
 161
 162             $status = 0;
 163             $totalNew = 0;
 164
 165             for ($i = 0;$i < count($boxes); $i++) {
 166
 167                 $line = '';
 168                 $mailbox = $boxes[$i]['formatted'];
 169
 170                 if (! isset($boxes[$i]['unseen']))
 171                     $boxes[$i]['unseen'] = '';
 172                 if ($boxes[$i]['flags']) {
 173                     $noselect = false;
 174                     for ($h = 0; $h < count($boxes[$i]['flags']); $h++) {
 175                         if (strtolower($boxes[$i]["flags"][$h]) == 'noselect')
 176                             $noselect = TRUE;
 177                     }
 178                     if (! $noselect) {
 179                         $status = $status + CheckNewMailboxSound($imapConnection, $mailbox,
 180                         $boxes[$i]['unformatted'], $delimeter, $boxes[$i]['unseen'],
 181                         $totalNew);
 182                     }
 183                 } else {
 184                     $status = $status + CheckNewMailboxSound($imapConnection, $mailbox, $boxes[$i]['unformatted'],
 185                         $delimeter, $boxes[$i]['unseen'], $totalNew);
 186                 }
 187
 188             }
 189
 190             // sqimap_logout($imapConnection);
 191
 192             // If we found unseen messages, then we
 193             // will play the sound as follows:
 194
 195             if ($newmail_changetitle) {
 196                 echo "<script language=\"javascript\">\n" .
 197                     "function ChangeTitleLoad() {\n";
 198                 if( $totalNew > 1 ) {
 199                     echo 'window.parent.document.title = "' .
 200                         sprintf(_("%s New Messages"), $totalNew ) .
 201                         "\";\n";
 202                 } else {
 203                     echo 'window.parent.document.title = "' .
 204                         sprintf(_("%s New Message"), $totalNew ) .
 205                         "\";\n";
 206                 }
 207                 echo    "if (BeforeChangeTitle != null)\n".
 208                             "BeforeChangeTitle();\n".
 209                     "}\n".
 210                     "BeforeChangeTitle = window.onload;\n".
 211                     "window.onload = ChangeTitleLoad;\n".
 212                     "</script>\n";
 213             }
 214
 215             if ($status > 0 && $newmail_enable == 'on') {
 216                 echo "<EMBED SRC=\"$newmail_media\" HIDDEN=TRUE AUTOSTART=TRUE>\n";
 217             }
 218             if ($status >0 && $newmail_popup == 'on') {
 219                 echo "<SCRIPT LANGUAGE=\"JavaScript\">\n".
 220                     "<!--\n".
 221                     "function PopupScriptLoad() {\n".
 222                     'window.open("../plugins/newmail/newmail.php", "SMPopup",'.
 223                                 "\"width=200,height=130,scrollbars=no\");\n".
 224                     "if (BeforePopupScript != null)\n".
 225                     "BeforePopupScript();\n".
 226                     "}\n".
 227                     "BeforePopupScript = window.onload;\n".
 228                     "window.onload = PopupScriptLoad;\n".
 229                     // Idea by:  Nic Wolfe (Nic@TimelapseProductions.com)
 230                     // Web URL:  http://fineline.xs.mw
 231                     // More code from Tyler Akins
 232                     "// End -->\n".
 233                     "</script>\n";
 234
 235             }
 236         }
 237     }
 238 ?>