Source for file setup.php

Documentation is available at setup.php

  1. <?php
  2.  
  3. /**
  4.  * newmail.php
  5.  *
  6.  * Copyright (c) 1999-2020 The SquirrelMail Project Team
  7.  * Copyright (c) 2000 by Michael Huttinger
  8.  * Licensed under the GNU GPL. For full terms see the file COPYING.
  9.  *
  10.  * Quite a hack -- but my first attempt at a plugin.  We were
  11.  * looking for a way to play a sound when there was unseen
  12.  * messages to look at.  Nice for users who keep the squirrel
  13.  * mail window up for long periods of time and want to know
  14.  * when mail arrives.
  15.  *
  16.  * Basically, I hacked much of left_main.php into a plugin that
  17.  * goes through each mail folder and increments a flag if
  18.  * there are unseen messages.  If the final count of unseen
  19.  * folders is > 0, then we play a sound (using the HTML at the
  20.  * far end of this script).
  21.  *
  22.  * This was tested with IE5.0 - but I hear Netscape works well,
  23.  * too (with a plugin).
  24.  *
  25.  * @version $Id: setup.php 14840 2020-01-07 07:42:38Z pdontthink $
  26.  * @package plugins
  27.  * @subpackage new_mail
  28.  */
  29.  
  30. /**
  31.  * Checks if mailbox contains new messages.
  32.  *
  33.  * @param stream $imapConnection 
  34.  * @param string $mailbox FIXME: option is not used
  35.  * @param string $real_box unformated mailbox name
  36.  * @param string $delimeter FIXME: option is not used
  37.  * @param string $unseen FIXME: option is not used
  38.  * @param integer $total_new number of new messages
  39.  * @return bool true, if there are new messages
  40.  */
  41. function CheckNewMailboxSound($imapConnection, $mailbox, $real_box, $delimeter, $unseen, &$total_new) {
  42.     global $folder_prefix, $trash_folder, $sent_folder,
  43.         $color, $move_to_sent, $move_to_trash,
  44.         $unseen_notify, $unseen_type, $newmail_allbox, 
  45.         $newmail_recent, $newmail_changetitle;
  46.  
  47.     $mailboxURL = urlencode($real_box);
  48.     $unseen = $recent = 0;
  49.  
  50.     // Skip folders for Sent and Trash
  51.  
  52.     if ($real_box == $sent_folder ||
  53.         $real_box == $trash_folder) {
  54.         return 0;
  55.     }
  56.  
  57.     if (($unseen_notify == 2 && $real_box == 'INBOX') ||
  58.         ($unseen_notify == 3 && ($newmail_allbox == 'on' ||
  59.                                  $real_box == 'INBOX'))) {
  60.         $status = sqimap_status_messages( $imapConnection, $real_box);
  61.         if($newmail_recent == 'on') {
  62.             $total_new += $status['RECENT'];
  63.         } else {
  64.             $total_new += $status['UNSEEN'];
  65.         }
  66.         if ($total_new) {
  67.             return 1;
  68.         }
  69.     }
  70.     return 0;
  71. }
  72.  
  73. function squirrelmail_plugin_init_newmail() {
  74.     global $squirrelmail_plugin_hooks;
  75.  
  76.     $squirrelmail_plugin_hooks['left_main_before']['newmail'] = 'newmail_plugin';
  77.     $squirrelmail_plugin_hooks['optpage_register_block']['newmail'] = 'newmail_optpage_register_block';
  78.     $squirrelmail_plugin_hooks['options_save']['newmail'] = 'newmail_sav';
  79.     $squirrelmail_plugin_hooks['loading_prefs']['newmail'] = 'newmail_pref';
  80.     $squirrelmail_plugin_hooks['optpage_set_loadinfo']['newmail'] = 'newmail_set_loadinfo';
  81. }
  82.  
  83. function newmail_optpage_register_block() {
  84.     // Gets added to the user's OPTIONS page.
  85.     global $optpage_blocks;
  86.  
  87.     if ( !soupNazi() ) {
  88.  
  89.         /* Register Squirrelspell with the $optionpages array. */
  90.         $optpage_blocks[] = array(
  91.             'name' => _("NewMail Options"),
  92.             'url'  => SM_PATH . 'plugins/newmail/newmail_opt.php',
  93.             'desc' => _("This configures settings for playing sounds and/or showing popup windows when new mail arrives."),
  94.             'js'   => TRUE
  95.             );
  96.     }
  97. }
  98.  
  99. function newmail_sav() {
  100.     global $data_dir, $username;
  101.  
  102.     if ( sqgetGlobalVar('submit_newmail', $submit, SQ_POST) ) {
  103.         $media_enable = '';
  104.         $media_popup = '';
  105.         $media_allbox = '';
  106.         $media_recent = '';
  107.         $media_changetitle = '';
  108.         $media_sel = '';
  109.  
  110.         sqgetGlobalVar('media_enable',         $media_enable,         SQ_POST);
  111.         sqgetGlobalVar('media_popup',          $media_popup,          SQ_POST);
  112.         sqgetGlobalVar('media_allbox',         $media_allbox,         SQ_POST);
  113.         sqgetGlobalVar('media_recent',         $media_recent,         SQ_POST);
  114.         sqgetGlobalVar('media_changetitle',    $media_changetitle,    SQ_POST);
  115.         sqgetGlobalVar('popup_height',         $newmail_popup_height, SQ_POST);
  116.         sqgetGlobalVar('popup_width',          $newmail_popup_width,  SQ_POST);        
  117.  
  118.         setPref($data_dir,$username,'newmail_enable',$media_enable);
  119.         setPref($data_dir,$username,'newmail_popup', $media_popup);
  120.         setPref($data_dir,$username,'newmail_allbox',$media_allbox);
  121.         setPref($data_dir,$username,'newmail_recent',$media_recent);
  122.         setPref($data_dir,$username,'newmail_popup_height',$newmail_popup_height);
  123.         setPref($data_dir,$username,'newmail_popup_width',$newmail_popup_width);
  124.         setPref($data_dir,$username,'newmail_changetitle',$media_changetitle);
  125.             
  126.         if( sqgetGlobalVar('media_sel', $media_sel, SQ_POST) &&
  127.             ($media_sel == '(none)' || $media_sel == '(local media)') ) {
  128.             removePref($data_dir,$username,'newmail_media');
  129.         } else {
  130.             setPref($data_dir,$username,'newmail_media',$media_sel);
  131.         }
  132.     }
  133. }
  134.  
  135. function newmail_pref() {
  136.     global $username, $data_dir, $newmail_media, $newmail_enable, $newmail_popup,
  137.            $newmail_allbox, $newmail_recent, $newmail_changetitle, $newmail_popup_height,
  138.            $newmail_popup_width;
  139.     
  140.  
  141.     $newmail_recent = getPref($data_dir,$username,'newmail_recent');
  142.     $newmail_enable = getPref($data_dir,$username,'newmail_enable');
  143.     $newmail_media = getPref($data_dir, $username, 'newmail_media', '(none)');
  144.     $newmail_popup = getPref($data_dir, $username, 'newmail_popup');
  145.     $newmail_allbox = getPref($data_dir, $username, 'newmail_allbox');
  146.     $newmail_popup_height = getPref($data_dir, $username, 'newmail_popup_height',130);
  147.     $newmail_popup_width = getPref($data_dir, $username, 'newmail_popup_width',200);
  148.     $newmail_changetitle = getPref($data_dir, $username, 'newmail_changetitle');
  149.  
  150. }
  151.  
  152. /**
  153.  * Set loadinfo data
  154.  *
  155.  * Used by option page when saving settings.
  156.  */
  157. function newmail_set_loadinfo() {
  158.     global $optpage, $optpage_name;
  159.     if ($optpage=='newmail') {
  160.         $optpage_name=_("NewMail Options");
  161.     }
  162. }
  163.  
  164. function newmail_plugin() {
  165.     global $username, $key, $imapServerAddress, $imapPort,
  166.         $newmail_media, $newmail_enable, $newmail_popup,
  167.         $newmail_popup_height, $newmail_popup_width, $newmail_recent, 
  168.         $newmail_changetitle, $imapConnection;
  169.  
  170.     include_once(SM_PATH . 'functions/display_messages.php');
  171.  
  172.     if ($newmail_enable == 'on' ||
  173.         $newmail_popup == 'on' ||
  174.         $newmail_changetitle) {
  175.  
  176.         // open a connection on the imap port (143)
  177.         $boxes = sqimap_mailbox_list($imapConnection);
  178.         $delimeter = sqimap_get_delimiter($imapConnection);
  179.  
  180.         $status = 0;
  181.         $totalNew = 0;
  182.  
  183.         for ($i = 0;$i < count($boxes); $i++) {
  184.  
  185.             $line = '';
  186.             $mailbox = $boxes[$i]['formatted'];
  187.  
  188.             if (! isset($boxes[$i]['unseen'])) {
  189.                 $boxes[$i]['unseen'] = '';
  190.             }
  191.             if ($boxes[$i]['flags']) {
  192.                 $noselect = false;
  193.                 for ($h = 0; $h < count($boxes[$i]['flags']); $h++) {
  194.                     if (strtolower($boxes[$i]["flags"][$h]) == 'noselect') {
  195.                         $noselect = TRUE;
  196.                     }
  197.                 }
  198.                 if (! $noselect) {
  199.                     $status += CheckNewMailboxSound($imapConnection, 
  200.                                                     $mailbox,
  201.                                                     $boxes[$i]['unformatted'], 
  202.                                                     $delimeter, 
  203.                                                     $boxes[$i]['unseen'],
  204.                                                     $totalNew);
  205.                 }
  206.             } else {
  207.                 $status += CheckNewMailboxSound($imapConnection, 
  208.                                                 $mailbox, 
  209.                                                 $boxes[$i]['unformatted'],
  210.                                                 $delimeter, 
  211.                                                 $boxes[$i]['unseen'], 
  212.                                                 $totalNew);
  213.             }
  214.  
  215.         }
  216.  
  217.         // sqimap_logout($imapConnection);
  218.  
  219.         // If we found unseen messages, then we
  220.         // will play the sound as follows:
  221.  
  222.         if ($newmail_changetitle) {
  223.             global $org_title;
  224.             echo "<script language=\"javascript\" type=\"text/javascript\">\n" .
  225.                 "function ChangeTitleLoad() {\n";
  226.             if( $totalNew > 1 || $totalNew == 0 ) {
  227.                 echo 'window.parent.document.title = "' . $org_title . ' [' .
  228.                     sprintf(_("%s New Messages"), $totalNew ) . 
  229.                     "]\";\n";
  230.             } else {
  231.                 echo 'window.parent.document.title = "' . $org_title . ' [' .
  232.                     sprintf(_("%s New Message"), $totalNew ) . 
  233.                     "]\";\n";
  234.             }
  235.             echo    "if (BeforeChangeTitle != null)\n".
  236.                 "BeforeChangeTitle();\n".
  237.                 "}\n".
  238.                 "BeforeChangeTitle = window.onload;\n".
  239.                 "window.onload = ChangeTitleLoad;\n".
  240.                 "</script>\n";
  241.         }
  242.  
  243.         if ($totalNew > 0 && $newmail_enable == 'on' && $newmail_media != '' && $newmail_media != '(none)') {
  244.             $newmail_media=sqm_baseuri().'plugins/newmail/sounds/'.basename($newmail_media);
  245.             echo '<embed src="'.sm_encode_html_special_chars($newmail_media)
  246.                 ."\" hidden=\"true\" autostart=\"true\" width=\"2\" height=\"2\">\n";
  247.         }
  248.         if ($totalNew > 0 && $newmail_popup == 'on') {
  249.             echo "<script language=\"JavaScript\">\n".
  250.                 "<!--\n".
  251.                 "function PopupScriptLoad() {\n".
  252.                 'window.open("'.sqm_baseuri().'plugins/newmail/newmail.php?numnew='.$totalNew.
  253.                 '", "SMPopup",'.
  254.                 "\"width=" . (int)$newmail_popup_width . ",height=" . (int)$newmail_popup_height . ",scrollbars=no\");\n".
  255.                 "if (BeforePopupScript != null)\n".
  256.                 "BeforePopupScript();\n".
  257.                 "}\n".
  258.                 "BeforePopupScript = window.onload;\n".
  259.                 "window.onload = PopupScriptLoad;\n".
  260.                 // Idea by:  Nic Wolfe ([email protected])
  261.                 // Web URL:  http://fineline.xs.mw
  262.                 // More code from Tyler Akins
  263.                 "// End -->\n".
  264.                 "</script>\n";
  265.         }
  266.     }
  267. }

Documentation generated on Mon, 13 Jan 2020 04:25:18 +0100 by phpDocumentor 1.4.3