/usr/lib/python2.7/dist-packages/Mailnag/plugins/libnotifyplugin.py is in mailnag 1.0.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 | #!/usr/bin/env python2
# -*- coding: utf-8 -*-
#
# libnotifyplugin.py
#
# Copyright 2013, 2014 Patrick Ulbrich <zulu99@gmx.net>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
# MA 02110-1301, USA.
#
import os
import dbus
import threading
from gi.repository import Notify, Gio, Gtk
from common.plugins import Plugin, HookTypes
from common.i18n import _
from common.subproc import start_subprocess
from common.exceptions import InvalidOperationException
from daemon.mails import sort_mails
MAX_VISIBLE_MAILS_LIMIT = 20.0
NOTIFICATION_MODE_COUNT = '0'
NOTIFICATION_MODE_SUMMARY = '1'
NOTIFICATION_MODE_SINGLE = '2'
plugin_defaults = {
'notification_mode' : NOTIFICATION_MODE_SUMMARY,
'max_visible_mails' : '10'
}
class LibNotifyPlugin(Plugin):
def __init__(self):
# dict that tracks all notifications that need to be closed
self._notifications = {}
self._initialized = False
self._lock = threading.Lock()
self._notification_server_wait_event = threading.Event()
self._notification_server_ready = False
self._is_gnome = False
self._mails_added_hook = None
self._mails_removed_hook = None
def enable(self):
self._max_mails = int(self.get_config()['max_visible_mails'])
self._notification_server_wait_event.clear()
self._notification_server_ready = False
self._notifications = {}
# initialize Notification
if not self._initialized:
Notify.init("Mailnag")
self._is_gnome = (os.environ['GDMSESSION'] == 'gnome')
self._initialized = True
def mails_added_hook(new_mails, all_mails):
self._notify_async(new_mails, all_mails)
def mails_removed_hook(remaining_mails):
if remaining_mails == 0:
# no mails (e.g. email client has been launched) -> close notifications
self._close_notifications()
self._mails_added_hook = mails_added_hook
self._mails_removed_hook = mails_removed_hook
controller = self.get_mailnag_controller()
hooks = controller.get_hooks()
hooks.register_hook_func(HookTypes.MAILS_ADDED,
self._mails_added_hook)
hooks.register_hook_func(HookTypes.MAILS_REMOVED,
self._mails_removed_hook)
def disable(self):
controller = self.get_mailnag_controller()
hooks = controller.get_hooks()
if self._mails_added_hook != None:
hooks.unregister_hook_func(HookTypes.MAILS_ADDED,
self._mails_added_hook)
self._mails_added_hook = None
if self._mails_removed_hook != None:
hooks.unregister_hook_func(HookTypes.MAILS_REMOVED,
self._mails_removed_hook)
self._mails_removed_hook = None
# Abort possible notification server wait
self._notification_server_wait_event.set()
# Close all open notifications
# (must be called after _notification_server_wait_event.set()
# to prevent a possible deadlock)
self._close_notifications()
def get_manifest(self):
return (_("LibNotify Notifications"),
_("Shows a popup when new mails arrive."),
"1.0",
"Patrick Ulbrich <zulu99@gmx.net>",
False)
def get_default_config(self):
return plugin_defaults
def has_config_ui(self):
return True
def get_config_ui(self):
box = Gtk.Box()
box.set_spacing(12)
box.set_orientation(Gtk.Orientation.VERTICAL)
label = Gtk.Label()
label.set_markup('<b>%s</b>' % _('Notification mode:'))
label.set_alignment(0.0, 0.0)
box.pack_start(label, False, False, 0)
inner_box = Gtk.Box()
inner_box.set_spacing(6)
inner_box.set_orientation(Gtk.Orientation.VERTICAL)
cb_count = Gtk.RadioButton(label = _('Count of new mails'))
inner_box.pack_start(cb_count, False, False, 0)
cb_summary = Gtk.RadioButton(label = _('Summary of new mails'), group = cb_count)
inner_box.pack_start(cb_summary, False, False, 0)
cb_single = Gtk.RadioButton(label = _('One notification per new mail'), group = cb_count)
inner_box.pack_start(cb_single, False, False, 0)
alignment = Gtk.Alignment()
alignment.set_padding(0, 6, 18, 0)
alignment.add(inner_box)
box.pack_start(alignment, False, False, 0)
label = Gtk.Label()
label.set_markup('<b>%s</b>' % _('Maximum number of visible mails:'))
label.set_alignment(0.0, 0.0)
box.pack_start(label, False, False, 0)
spinner = Gtk.SpinButton.new_with_range(1.0, MAX_VISIBLE_MAILS_LIMIT, 1.0)
alignment = Gtk.Alignment()
alignment.set_padding(0, 0, 18, 0)
alignment.add(spinner)
box.pack_start(alignment, False, False, 0)
return box
def load_ui_from_config(self, config_ui):
config = self.get_config()
inner_box = config_ui.get_children()[1].get_child()
cb = inner_box.get_children()[int(config['notification_mode'])]
cb.set_active(True)
max_mails = float(config['max_visible_mails'])
spinner = config_ui.get_children()[3].get_child()
spinner.set_value(max_mails)
def save_ui_to_config(self, config_ui):
config = self.get_config()
inner_box = config_ui.get_children()[1].get_child()
idx = 0
for cb in inner_box.get_children():
if cb.get_active():
config['notification_mode'] = str(idx)
break
idx += 1
spinner = config_ui.get_children()[3].get_child()
max_mails = spinner.get_value()
config['max_visible_mails'] = str(int(max_mails))
def _notify_async(self, new_mails, all_mails):
def thread():
with self._lock:
# The desktop session may have started Mailnag
# before the libnotify dbus daemon.
if not self._notification_server_ready:
if not self._wait_for_notification_server():
return
self._notification_server_ready = True
config = self.get_config()
if config['notification_mode'] == NOTIFICATION_MODE_COUNT:
self._notify_count(len(all_mails))
elif config['notification_mode'] == NOTIFICATION_MODE_SUMMARY:
self._notify_summary(new_mails, all_mails)
else:
self._notify_single(new_mails)
t = threading.Thread(target = thread)
t.start()
def _notify_summary(self, new_mails, all_mails):
summary = ""
body = ""
# The mail list (all_mails) is sorted by date (mails with most recent
# date on top). New mails with no date or older mails that come in
# delayed won't be listed on top. So if a mail with no or an older date
# arrives, it gives the impression that the top most mail (i.e. the mail
# with the most recent date) is re-notified.
# To fix that, simply put new mails on top explicitly.
mails = new_mails + [m for m in all_mails if m not in new_mails]
if len(self._notifications) == 0:
self._notifications['0'] = self._get_notification(" ", None, None) # empty string will emit a gtk warning
ubound = len(mails) if len(mails) <= self._max_mails else self._max_mails
for i in range(ubound):
if self._is_gnome:
body += "%s:\n<i>%s</i>\n\n" % (self._get_sender(mails[i]), mails[i].subject)
else:
body += "%s - %s\n" % (ellipsize(self._get_sender(mails[i]), 20), ellipsize(mails[i].subject, 20))
if len(mails) > self._max_mails:
if self._is_gnome:
body += "<i>%s</i>" % _("(and {0} more)").format(str(len(mails) - self._max_mails))
else:
body += _("(and {0} more)").format(str(len(mails) - self._max_mails))
if len(mails) > 1: # multiple new emails
summary = _("You have {0} new mails.").format(str(len(mails)))
else:
summary = _("You have a new mail.")
self._notifications['0'].update(summary, body, "mail-unread")
self._notifications['0'].show()
def _notify_single(self, mails):
# In single notification mode new mails are
# added to the *bottom* of the notification list.
mails = sort_mails(mails, sort_desc = False)
for mail in mails:
n = self._get_notification(self._get_sender(mail), mail.subject, "mail-unread")
notification_id = str(id(n))
if self._is_gnome:
n.add_action("mark-as-read", _("Mark as read"),
self._notification_action_handler, (mail, notification_id))
n.show()
self._notifications[notification_id] = n
def _notify_count(self, count):
if len(self._notifications) == 0:
self._notifications['0'] = self._get_notification(" ", None, None) # empty string will emit a gtk warning
if count > 1: # multiple new emails
summary = _("You have {0} new mails.").format(str(count))
else:
summary = _("You have a new mail.")
self._notifications['0'].update(summary, None, "mail-unread")
self._notifications['0'].show()
def _close_notifications(self):
with self._lock:
for n in self._notifications.itervalues():
n.close()
self._notifications = {}
def _get_notification(self, summary, body, icon):
n = Notify.Notification.new(summary, body, icon)
n.set_category("email")
if self._is_gnome:
n.add_action("default", "default", self._notification_action_handler, None)
return n
def _wait_for_notification_server(self):
bus = dbus.SessionBus()
while not bus.name_has_owner('org.freedesktop.Notifications'):
self._notification_server_wait_event.wait(5)
if self._notification_server_wait_event.is_set():
return False
return True
def _notification_action_handler(self, n, action, user_data):
with self._lock:
if action == "default":
mailclient = get_default_mail_reader()
if mailclient != None:
start_subprocess(mailclient)
# clicking the notification bubble has closed all notifications
# so clear the reference array as well.
self._notifications = {}
elif action == "mark-as-read":
controller = self.get_mailnag_controller()
try:
controller.mark_mail_as_read(user_data[0].id)
except InvalidOperationException:
pass
# clicking the action has closed the notification
# so remove its reference.
del self._notifications[user_data[1]]
def _get_sender(self, mail):
name, addr = mail.sender
if len(name) > 0: return name
else: return addr
def get_default_mail_reader():
mail_reader = None
app_info = Gio.AppInfo.get_default_for_type ("x-scheme-handler/mailto", False)
if app_info != None:
executable = Gio.AppInfo.get_executable(app_info)
if (executable != None) and (len(executable) > 0):
mail_reader = executable
return mail_reader
def ellipsize(str, max_len):
if max_len < 3: max_len = 3
if len(str) <= max_len:
return str
else:
return str[0:max_len - 3] + '...'
|