Merge lp:~mandel/ubuntuone-client/notification-center-support into lp:ubuntuone-client

[Manuel de la Peña]

- Added support for the notification center and growl (LP: #1044315).

- Added support for the notification center and growl (LP: #1044315).

The following dependencies have been added which are probably no in your system:

http://pypi.python.org/pypi/pync/1.1 => notification center support
https://github.com/kfdm/gntp/ => growl support

You can test it IRL by starting sd and adding a big file to the Ubuntu One folder, you should see a notificaiton.

[lp:~mandel/ubuntuone-client/notification-center-support]

1308. By Manuel de la Peña on 2012-08-31

Compare ints no strings.

1309. By Manuel de la Peña on 2012-08-31

Do not use growl all the time.

[dobey (dobey)]

+APPLICATION_NAME = 'Ubuntu One Client'

We shouldn't duplicate this string in multiple places. Also, I think this should probably just be 'Ubuntu One'.

Also, what do these 2 notifications actually look like? Can you provide screen shots of them?

review: Needs Fixing

[lp:~mandel/ubuntuone-client/notification-center-support]

1310. By Manuel de la Peña on 2012-08-31

Do not duplicate strings.

[Manuel de la Peña (mandel)]

Images of how it looks:

Growl support: http://imgur.com/QnMu6,jZwvj
Notification center support: http://imgur.com/QnMu6,jZwvj#1

The proper icon is missing because we have to discuss its locations in the fs once the app has been packaged.

[dobey (dobey)]

This does need to pass the icon argument on to the upstream API calls though, where applicable. And perhaps a comment stating it is ignored for pync because the API doesn't accept it as an argument.

[Mike McCracken (mikemc)]

A couple of issues:

- gntp won't work if growl isn't installed. It only talks to an existing growl, so we'll get tracebacks on 10.6 and 10.7 for lots of people…

- pync depends on terminal-notifier, which is a separate .app that calls NSNotification Center.
pync downloads that if it can't find it in a hard-coded spot, which is kind of awkward. we can put terminal-notifier there, but we'll have to strip out the apple-copyrighted Terminal.icns, which is in the terminal-notifier app for some reason.

We should probably look at using PyObjC, which would let us either directly call NSNotificationCenter and Growl, or (even better) just use the Growl 2.0 ObjC api via PyObjC, which lets us use one API and support growl on 10.6/7, and either growl or NC on 10.8, depending on user choice.

Also, as of 1.3 or so, Growl doesn't need to install anything to show notifications - that was an annoying issue previously.

here's the description from the Growl 2.0 API readme:

 1. Growl.app is installed, and the user has configured growl to NOT use NC
 ▪ Notifications work as before. Notification tickets are sent to the Growl.app which displays them and performs actions and displays notifications as configured by the user
 2. Growl.app is installed, and the user has configured Growl.app to use NC
 ▪ Growl.framework detects this state from within the app and notifications are sent directly to NC from the app's process. Additionally, notification tickets are sent to growl which performs any associated actions. Growl.app displays nothing.
 3. Growl.app is not installed
 ▪ Growl.framework detects this state from within the app and notifications are sent directly to NC from the app's process. Nothing else is done.

review: Needs Fixing

Unmerged revisions

1310. By Manuel de la Peña on 2012-08-31

Do not duplicate strings.

1309. By Manuel de la Peña on 2012-08-31

Do not use growl all the time.

1308. By Manuel de la Peña on 2012-08-31

Compare ints no strings.

1307. By Manuel de la Peña on 2012-08-31

Added support for growl in older versions. Added tests.

1306. By Manuel de la Peña on 2012-08-30

Do call notify.

1305. By Manuel de la Peña on 2012-08-30

Added support for the os x 10.8 notification center.

=== added file 'tests/platform/notification/test_darwin.py'
--- tests/platform/notification/test_darwin.py	1970-01-01 00:00:00 +0000
+++ tests/platform/notification/test_darwin.py	2012-08-31 15:37:20 +0000
@@ -0,0 +1,150 @@
+# Copyright 2012 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, 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, see <http://www.gnu.org/licenses/>.
+#
+# In addition, as a special exception, the copyright holders give
+# permission to link the code of portions of this program with the
+# OpenSSL library under certain conditions as described in each
+# individual source file, and distribute linked combinations
+# including the two.
+# You must obey the GNU General Public License in all respects
+# for all of the code used other than OpenSSL.  If you modify
+# file(s) with this exception, you may extend this exception to your
+# version of the file(s), but you are not obligated to do so.  If you
+# do not wish to do so, delete this exception statement from your
+# version.  If you delete this exception statement from all source
+# files in the program, then also delete it here.
+"""Test the notification modules for darwin."""
+
+import os
+
+from twisted.internet import defer
+from twisted.trial.unittest import TestCase
+
+from ubuntuone.platform.notification import darwin
+
+
+class CorrectImportTestCase(TestCase):
+    """Test that the correct module is used."""
+
+    @defer.inlineCallbacks
+    def setUp(self):
+        """Set the different tests."""
+        yield super(CorrectImportTestCase, self).setUp()
+        self.current_version = '10.8.1'
+
+        def fake_mac_ver():
+            """Return a fake version."""
+            return [self.current_version, ('','',''), 'x86_64']
+
+        self.patch(darwin.platform, 'mac_ver', fake_mac_ver)
+
+    def test_import_notification_center(self):
+        """Import the notification center."""
+        self.current_version = '10.8.1'
+        module = darwin.get_module()
+        self.assertEqual(darwin.notification_center, module)
+
+
+    def test_import_growl(self):
+        """Import growl."""
+        self.current_version = '10.7.2'
+        module = darwin.get_module()
+        self.assertEqual(darwin.growl, module)
+
+
+class GrowlTestCase(TestCase):
+    """Test the grown support."""
+
+    @defer.inlineCallbacks
+    def setUp(self):
+        """Set the tests."""
+        yield super(GrowlTestCase, self).setUp()
+        self.can_register = True
+        self.called = []
+        self.title = 'Title'
+        self.message = 'le message'
+
+        def fake_register(my_self):
+            """Fake the registration."""
+            self.called.append('register')
+            if not self.can_register:
+                raise Exception('Connection refused.')
+
+        self.patch(darwin.growl.GrowlNotifier, 'register', fake_register)
+
+        def fake_notify(my_self, noteType=None, title=None, description=None,
+                sticky=None, priority=0):
+            """Fake a notification."""
+            self.called.append(('notify', noteType, title, description,
+                sticky, priority))
+
+        self.patch(darwin.growl.GrowlNotifier, 'notify', fake_notify)
+
+    def test_notify_can_register(self):
+        """Test a notification when we can register."""
+        self.can_register = True
+        notification = darwin.growl.Notification()
+        notification.send_notification(self.title, self.message)
+        self.assertIn('register', self.called)
+        notify_args = self.called[1]
+        self.assertIn('New Messages', notify_args)
+        self.assertIn(self.title, notify_args)
+        self.assertIn(self.message, notify_args)
+        self.assertIn(1, notify_args)
+        self.assertIn(False, notify_args)
+
+    def test_notify_fail_register(self):
+        """Test a notification when we cannot register."""
+        self.can_register = False
+        notification = darwin.growl.Notification()
+        notification.send_notification(self.title, self.message)
+        self.assertIn('register', self.called)
+        self.assertEqual(1, len(self.called))
+
+
+class NotificationCenterTestCase(TestCase):
+    """Test the notification center implementation."""
+
+    @defer.inlineCallbacks
+    def setUp(self):
+        """Set the tests."""
+        yield super(NotificationCenterTestCase, self).setUp()
+        self.title = 'Title'
+        self.message = 'le message'
+        self.called = []
+
+        def fake_notify(message, title=None, group=None):
+            """Fake the notify event."""
+            self.called.extend(('notify', message, title, group))
+
+        self.patch(darwin.notification_center.Notifier, 'notify',
+                fake_notify)
+        self.notification = darwin.notification_center.Notification()
+
+    def test_append(self):
+        """Test when we are appending messages."""
+        self.notification.send_notification(self.title, self.message,
+                append=True)
+        self.assertIn(self.title, self.called)
+        self.assertIn(self.message, self.called)
+        self.assertIn(self.notification.application_name, self.called)
+
+
+    def test_not_append(self):
+        """Test not appending messages."""
+        self.notification.send_notification(self.title, self.message,
+                append=False)
+        self.assertIn(self.title, self.called)
+        self.assertIn(self.message, self.called)
+        self.assertNotIn(self.notification.application_name, self.called)

=== modified file 'ubuntuone/platform/filesystem_notifications/monitor/darwin/fsevents_client.py'
--- ubuntuone/platform/filesystem_notifications/monitor/darwin/fsevents_client.py	2012-08-22 15:03:24 +0000
+++ ubuntuone/platform/filesystem_notifications/monitor/darwin/fsevents_client.py	2012-08-31 15:37:20 +0000
@@ -46,6 +46,7 @@
 ACTIONS = {
     fsevents.IN_CREATE: IN_CREATE,
     fsevents.IN_DELETE: IN_DELETE,
+    fsevents.IN_ATTRIB: IN_MODIFY,
     fsevents.IN_MODIFY: IN_MODIFY,
     fsevents.IN_MOVED_FROM: IN_MOVED_FROM,
     fsevents.IN_MOVED_TO: IN_MOVED_TO,

=== modified file 'ubuntuone/platform/notification/__init__.py'
--- ubuntuone/platform/notification/__init__.py	2012-05-02 13:15:46 +0000
+++ ubuntuone/platform/notification/__init__.py	2012-08-31 15:37:20 +0000
@@ -35,6 +35,9 @@
 if sys.platform == "win32":
     from ubuntuone.platform.notification import windows
     source = windows
+elif sys.platform == "darwin":
+    from ubuntuone.platform.notification import darwin
+    source = darwin
 else:
     from ubuntuone.platform.notification import linux
     source = linux

=== added directory 'ubuntuone/platform/notification/darwin'
=== added file 'ubuntuone/platform/notification/darwin/__init__.py'
--- ubuntuone/platform/notification/darwin/__init__.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/platform/notification/darwin/__init__.py	2012-08-31 15:37:20 +0000
@@ -0,0 +1,53 @@
+# Copyright 2012 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, 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, see <http://www.gnu.org/licenses/>.
+#
+# In addition, as a special exception, the copyright holders give
+# permission to link the code of portions of this program with the
+# OpenSSL library under certain conditions as described in each
+# individual source file, and distribute linked combinations
+# including the two.
+# You must obey the GNU General Public License in all respects
+# for all of the code used other than OpenSSL.  If you modify
+# file(s) with this exception, you may extend this exception to your
+# version of the file(s), but you are not obligated to do so.  If you
+# do not wish to do so, delete this exception statement from your
+# version.  If you delete this exception statement from all source
+# files in the program, then also delete it here.
+"""Notification support for darwin."""
+
+import platform
+
+MAC_OS_X = 10
+MOUNTAIN_LION = 8
+
+
+def get_module():
+    """Return the module to be used."""
+
+    # get the current mac version and decide if we use the notification or we
+    # don't
+    version = platform.mac_ver()[0].split('.')
+
+    if int(version[0]) >= MAC_OS_X and int(version[1]) >= MOUNTAIN_LION:
+        from ubuntuone.platform.notification.darwin import notification_center
+        return notification_center
+    else:
+        from ubuntuone.platform.notification.darwin import growl
+        return growl
+
+
+source = get_module()
+APPLICATION_NAME = source.APPLICATION_NAME
+
+Notification = source.Notification

=== added file 'ubuntuone/platform/notification/darwin/growl.py'
--- ubuntuone/platform/notification/darwin/growl.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/platform/notification/darwin/growl.py	2012-08-31 15:37:20 +0000
@@ -0,0 +1,53 @@
+# Copyright 2012 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, 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, see <http://www.gnu.org/licenses/>.
+#
+# In addition, as a special exception, the copyright holders give
+# permission to link the code of portions of this program with the
+# OpenSSL library under certain conditions as described in each
+# individual source file, and distribute linked combinations
+# including the two.
+# You must obey the GNU General Public License in all respects
+# for all of the code used other than OpenSSL.  If you modify
+# file(s) with this exception, you may extend this exception to your
+# version of the file(s), but you are not obligated to do so.  If you
+# do not wish to do so, delete this exception statement from your
+# version.  If you delete this exception statement from all source
+# files in the program, then also delete it here.
+"""Module that implements notification of the end user."""
+
+from gntp.notifier import GrowlNotifier
+
+from ubuntuone.status.notification import AbstractNotification, APPLICATION_NAME
+
+
+class Notification(AbstractNotification):
+    """Notification of the end user."""
+
+    def __init__(self, application_name=APPLICATION_NAME):
+        self.application_name = application_name
+        self.notifier = GrowlNotifier(applicationName = self.application_name,
+                notifications = ['New Updates','New Messages'],
+                defaultNotifications = ['New Messages'])
+        try:
+            self.notifier.register()
+        except:
+            # we get a connection error if the user has an old version of growl
+            # therefore we wont be able to send notifications
+            self.notifier = None
+
+    def send_notification(self, title, message, icon=None, append=True):
+        """Send a notification using the underlying library."""
+        if self.notifier:
+            self.notifier.notify(noteType='New Messages', title=title,
+                    description=message, sticky=False, priority=1)

=== added file 'ubuntuone/platform/notification/darwin/notification_center.py'
--- ubuntuone/platform/notification/darwin/notification_center.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/platform/notification/darwin/notification_center.py	2012-08-31 15:37:20 +0000
@@ -0,0 +1,49 @@
+# Copyright 2012 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, 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, see <http://www.gnu.org/licenses/>.
+#
+# In addition, as a special exception, the copyright holders give
+# permission to link the code of portions of this program with the
+# OpenSSL library under certain conditions as described in each
+# individual source file, and distribute linked combinations
+# including the two.
+# You must obey the GNU General Public License in all respects
+# for all of the code used other than OpenSSL.  If you modify
+# file(s) with this exception, you may extend this exception to your
+# version of the file(s), but you are not obligated to do so.  If you
+# do not wish to do so, delete this exception statement from your
+# version.  If you delete this exception statement from all source
+# files in the program, then also delete it here.
+"""Module that implements notification of the end user."""
+
+import os
+
+from pync import Notifier
+
+from ubuntuone.status.notification import AbstractNotification, APPLICATION_NAME
+
+
+class Notification(AbstractNotification):
+    """Notification of the end user."""
+
+    def __init__(self, application_name=APPLICATION_NAME):
+        self.application_name = application_name
+        self.notifier = Notifier
+
+    def send_notification(self, title, message, icon=None, append=True):
+        """Send a notification using the underlying library."""
+        if append:
+            self.notifier.notify(message, title=title,
+                    group=self.application_name)
+        else:
+            self.notifier.notify(message, title=title)