*
* Functions
*
- * @copyright © 2001-2005 The SquirrelMail Project Team
+ * @copyright 2001-2020 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);
/* 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
if ( sqgetGlobalVar('submit_newmail', $submit, SQ_POST) ) {
$media_enable = '';
$media_popup = '';
- $media_allbox = '';
$media_recent = '';
$media_changetitle = '';
$media_sel = '';
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);
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');
*/
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_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);
}
/**
function newmail_set_loadinfo_function() {
global $optpage, $optpage_name;
if ($optpage=='newmail') {
- $optpage_name=_("NewMail Options");
+ $optpage_name=_("New Mail Options");
}
}
-/**
- * Insert needed data in left_main
- */
-function newmail_plugin_function() {
- global $username, $newmail_media, $newmail_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;
- if ($newmail_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);
+/* 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;
- $status = 0;
- $totalNew = 0;
+ /* if $newmail_unseen_notify is set to zero, plugin follows $unseen_notify */
+ if ($newmail_unseen_notify == 0)
+ $newmail_unseen_notify = $unseen_notify;
- for ($i = 0;$i < count($boxes); $i++) {
+ $mailbox=$statusarr['MAILBOX'];
- $mailbox = $boxes[$i]['formatted'];
+ 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 (! 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);
+ 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'];
}
}
+ }
+}
- // sqimap_logout($imapConnection);
+/**
+ * Insert needed data in left_main
+ */
+function newmail_plugin_function() {
+ global $username, $newmail_media, $newmail_media_enable, $newmail_popup,
+ $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; }
// If we found unseen messages, then we
// will play the sound as follows:
if ($newmail_changetitle) {
- echo "<script language=\"javascript\" 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_enable == 'on' && $newmail_media != '' ) {
- echo newmail_create_media_tags($newmail_media);
+ if ($newmail_allowsound && $totalNew > 0
+ && $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 language=\"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 -----
-/**
- * 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
* @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
+ * @todo add ogg and svg support
*/
function newmail_media_object_ie($object,$type,$path,$args=array(),$addsuffix) {
$ret_ie='';
/**
* Converts media attributes to string
* Warning:
- * * attribute values are automatically sanitized by htmlspecialchars()
+ * * attribute values are automatically sanitized by sm_encode_html_special_chars()
* * 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 . '="' . sm_encode_html_special_chars($value) . '" ';
}
return $ret_args;
}
}
return $ret_media;
}
-?>
\ No newline at end of file
projects / squirrelmail.git / blobdiff