Merge lp:~thisfred/ubuntuone-client/science-fiction-double-feature into lp:ubuntuone-client

[Eric Casteleijn]

- Notifications can now be updated as well as appended to
- Messages can have a count, which can be updated after they are displayed

- Notifications can now be updated as well as appended to
- Messages can have a count, which can be updated after they are displayed

To test these features, put this in a python script, and run it from the root of the branch, (PYTHONPATH=. python /path/to/the/script.py):

from ubuntuone.platform import messaging, notification

n = notification.Notification("Is this thing on?")
mah_notification = n.send_notification("Mon titre", "Ceci, n'est pas updated.")
n.update_notification(
    mah_notification, "New Titles Please", "The updated message. Yay!")

def callback(indicator, message_time=None):
    """Hide the message again."""
    messaging.hide_message(indicator)

m = messaging.Messaging()
m.show_message("mom", callback, message_count=2)
raw_input(
    "The messaging menu should be at alert, with a message that has"
    "count 2. (Don't click it.) Hit enter to continue.")
m.update_count("mom", 5)
raw_input(
    "The messaging menu should be at alert, with a message that has"
    "count 5. Hit enter to continue.")

[Alejandro J. Cura (alecu)]

Really like the branch, but I would like to see some tests for the notification and messaging modules.

After discussing this with thisfred, he told me he would be doing said tests in a new branch.

review: Approve

[Facundo Batista (facundo)]

Ok!

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

There are additional revisions which have not been approved in review. Please seek review and approval of these new revisions.

[Ubuntu One Auto Pilot (otto-pilot)]

The attempt to merge lp:~thisfred/ubuntuone-client/science-fiction-double-feature into lp:ubuntuone-client failed. Below is the output from the failed tests.

/usr/bin/gnome-autogen.sh
checking for autoconf >= 2.53...
  testing autoconf2.50... not found.
  testing autoconf... found 2.67
checking for automake >= 1.10...
  testing automake-1.11... found 1.11.1
checking for libtool >= 1.5...
  testing libtoolize... found 2.2.6b
checking for intltool >= 0.30...
  testing intltoolize... found 0.41.1
checking for pkg-config >= 0.14.0...
  testing pkg-config... found 0.25
checking for gtk-doc >= 1.0...
  testing gtkdocize... found 1.16
Checking for required M4 macros...
Checking for forbidden M4 macros...
Processing ./configure.ac
Running libtoolize...
libtoolize: putting auxiliary files in `.'.
libtoolize: copying file `./ltmain.sh'
libtoolize: putting macros in AC_CONFIG_MACRO_DIR, `m4'.
libtoolize: copying file `m4/libtool.m4'
libtoolize: copying file `m4/ltoptions.m4'
libtoolize: copying file `m4/ltsugar.m4'
libtoolize: copying file `m4/ltversion.m4'
libtoolize: copying file `m4/lt~obsolete.m4'
Running intltoolize...
Running gtkdocize...
Running aclocal-1.11...
Running autoconf...
Running autoheader...
Running automake-1.11...
Running ./configure --enable-gtk-doc --enable-debug ...
checking for a BSD-compatible install... /usr/bin/install -c
checking whether build environment is sane... yes
checking for a thread-safe mkdir -p... /bin/mkdir -p
checking for gawk... gawk
checking whether make sets $(MAKE)... yes
checking for style of include used by make... GNU
checking for gcc... gcc
checking whether the C compiler works... yes
checking for C compiler default output file name... a.out
checking for suffix of executables...
checking whether we are cross compiling... no
checking for suffix of object files... o
checking whether we are using the GNU C compiler... yes
checking whether gcc accepts -g... yes
checking for gcc option to accept ISO C89... none needed
checking dependency style of gcc... gcc3
checking for library containing strerror... none required
checking for gcc... (cached) gcc
checking whether we are using the GNU C compiler... (cached) yes
checking whether gcc accepts -g... (cached) yes
checking for gcc option to accept ISO C89... (cached) none needed
checking dependency style of gcc... (cached) gcc3
checking build system type... i686-pc-linux-gnu
checking host system type... i686-pc-linux-gnu
checking for a sed that does not truncate output... /bin/sed
checking for grep that handles long lines and -e... /bin/grep
checking for egrep... /bin/grep -E
checking for fgrep... /bin/grep -F
checking for ld used by gcc... /usr/bin/ld
checking if the linker (/usr/bin/ld) is GNU ld... yes
checking for BSD- or MS-compatible name lister (nm)... /usr/bin/nm -B
checking the name lister (/usr/bin/nm -B) interface... BSD nm
checking whether ln -s works... yes
checking the maximum length of command line arguments... 1572864
checking whether the shell understands some XSI constructs... yes
checking whether the shell understands "+="... yes
checking for /usr/bin/ld option to reload object files... -r
checking for objdump... objdump
checking how to recogniz...

[Ubuntu One Auto Pilot (otto-pilot)]

The attempt to merge lp:~thisfred/ubuntuone-client/science-fiction-double-feature into lp:ubuntuone-client failed. Below is the output from the failed tests.

/usr/bin/gnome-autogen.sh
checking for autoconf >= 2.53...
  testing autoconf2.50... not found.
  testing autoconf... found 2.67
checking for automake >= 1.10...
  testing automake-1.11... found 1.11.1
checking for libtool >= 1.5...
  testing libtoolize... found 2.2.6b
checking for intltool >= 0.30...
  testing intltoolize... found 0.41.1
checking for pkg-config >= 0.14.0...
  testing pkg-config... found 0.25
checking for gtk-doc >= 1.0...
  testing gtkdocize... found 1.16
Checking for required M4 macros...
Checking for forbidden M4 macros...
Processing ./configure.ac
Running libtoolize...
libtoolize: putting auxiliary files in `.'.
libtoolize: copying file `./ltmain.sh'
libtoolize: putting macros in AC_CONFIG_MACRO_DIR, `m4'.
libtoolize: copying file `m4/libtool.m4'
libtoolize: copying file `m4/ltoptions.m4'
libtoolize: copying file `m4/ltsugar.m4'
libtoolize: copying file `m4/ltversion.m4'
libtoolize: copying file `m4/lt~obsolete.m4'
Running intltoolize...
Running gtkdocize...
Running aclocal-1.11...
Running autoconf...
Running autoheader...
Running automake-1.11...
Running ./configure --enable-gtk-doc --enable-debug ...
checking for a BSD-compatible install... /usr/bin/install -c
checking whether build environment is sane... yes
checking for a thread-safe mkdir -p... /bin/mkdir -p
checking for gawk... gawk
checking whether make sets $(MAKE)... yes
checking for style of include used by make... GNU
checking for gcc... gcc
checking whether the C compiler works... yes
checking for C compiler default output file name... a.out
checking for suffix of executables...
checking whether we are cross compiling... no
checking for suffix of object files... o
checking whether we are using the GNU C compiler... yes
checking whether gcc accepts -g... yes
checking for gcc option to accept ISO C89... none needed
checking dependency style of gcc... gcc3
checking for library containing strerror... none required
checking for gcc... (cached) gcc
checking whether we are using the GNU C compiler... (cached) yes
checking whether gcc accepts -g... (cached) yes
checking for gcc option to accept ISO C89... (cached) none needed
checking dependency style of gcc... (cached) gcc3
checking build system type... i686-pc-linux-gnu
checking host system type... i686-pc-linux-gnu
checking for a sed that does not truncate output... /bin/sed
checking for grep that handles long lines and -e... /bin/grep
checking for egrep... /bin/grep -E
checking for fgrep... /bin/grep -F
checking for ld used by gcc... /usr/bin/ld
checking if the linker (/usr/bin/ld) is GNU ld... yes
checking for BSD- or MS-compatible name lister (nm)... /usr/bin/nm -B
checking the name lister (/usr/bin/nm -B) interface... BSD nm
checking whether ln -s works... yes
checking the maximum length of command line arguments... 1572864
checking whether the shell understands some XSI constructs... yes
checking whether the shell understands "+="... yes
checking for /usr/bin/ld option to reload object files... -r
checking for objdump... objdump
checking how to recogniz...

=== modified file 'tests/status/test_aggregator.py'
--- tests/status/test_aggregator.py	2011-01-31 18:11:09 +0000
+++ tests/status/test_aggregator.py	2011-02-01 19:10:23 +0000
@@ -25,11 +25,13 @@
 
 from ubuntuone.devtools.handlers import MementoHandler
 from ubuntuone.status import aggregator
+from ubuntuone.status.notification import AbstractNotification
+
 from ubuntuone.syncdaemon.status_listener import StatusListener
 from ubuntuone.syncdaemon.volume_manager import Share, UDF
 
 
-class FakeNotification(object):
+class FakeNotification(AbstractNotification):
     """A fake notification class."""
 
     def __init__(self, application_name="fake app"):
@@ -40,19 +42,37 @@
     def send_notification(self, title, message, icon=None, append=False):
         """Show a notification to the user."""
         self.notifications_shown.append((title, message, icon, append))
+        return len(self.notifications_shown)
+
+    def update_notification(self, notification, new_title, new_message,
+                            new_icon=None):
+        """Update the notification with a new message body."""
+        title, old_message, icon, append = self.notifications_shown[
+            notification]
+        if new_icon is not None:
+            icon = new_icon
+        self.notifications_shown[notification] = (
+            new_title, new_message, icon, append)
 
 
 class FakeMessaging(object):
     """A fake messaging class."""
 
     def __init__(self, application_name="fake app"):
-        self.messages_shown = []
+        self.messages_shown = {}
         self.application_name = application_name
 
-    def show_message(self, subtype, sender, body, callback, message_time=None):
+    def show_message(self, sender, callback, message_time=None,
+                     message_count=None, icon=None):
         """Show a message to the user."""
-        self.messages_shown.append(
-            (subtype, sender, body, callback, message_time))
+        self.messages_shown[sender] = (
+            callback, message_time, message_count, icon)
+
+    def update_count(self, sender, new_count):
+        """Update the count for an existing indicator."""
+        callback, message_time, _, icon = self.messages_shown[sender]
+        self.messages_shown[sender] = (
+            callback, message_time, new_count, icon)
 
 
 class DelayedBufferTestCase(TestCase):

=== modified file 'ubuntuone/platform/linux/messaging.py'
--- ubuntuone/platform/linux/messaging.py	2011-01-28 18:50:34 +0000
+++ ubuntuone/platform/linux/messaging.py	2011-02-01 19:10:23 +0000
@@ -48,7 +48,8 @@
             self.server.set_desktop_file(
                 "/usr/share/applications/ubuntuone-control-panel-gtk.desktop")
 
-    def show_message(self, sender, callback, message_time=None, icon=None):
+    def show_message(self, sender, callback, message_time=None,
+                     message_count=None, icon=None):
         """Show a message in the messaging menu."""
         if USE_INDICATE:
             indicator = self.indicators[sender] = indicate.Indicator()
@@ -59,13 +60,20 @@
 
             if icon is not None:
                 indicator.set_property_icon("icon", icon)
-            if message_time is None:
-                message_time = time()
-            indicator.set_property_time("time", message_time)
+            if message_count is not None:
+                indicator.set_property("count", str(message_count))
+            else:
+                if message_time is None:
+                    message_time = time()
+                indicator.set_property_time("time", message_time)
             indicator.set_property("draw-attention", "true")
             self.server.show()
             indicator.show()
 
+    def update_count(self, sender, new_count):
+        """Update the count for an existing indicator."""
+        self.indicators[sender].set_property("count", str(new_count))
+
 
 def hide_message(indicator):
     """Remove the message once it has been dealt with."""

=== modified file 'ubuntuone/platform/linux/notification.py'
--- ubuntuone/platform/linux/notification.py	2011-01-28 16:30:01 +0000
+++ ubuntuone/platform/linux/notification.py	2011-02-01 19:10:23 +0000
@@ -49,3 +49,10 @@
                 notification.set_hint_string('append', '')
             notification.show()
             return notification
+
+    def update_notification(self, notification, new_title, new_message,
+                            new_icon=None):
+        """Update the notification with a new message body."""
+        if USE_PYNOTIFY:
+            notification.update(new_title, new_message, new_icon)
+            notification.show()

=== added file 'ubuntuone/platform/windows/messaging.py'
--- ubuntuone/platform/windows/messaging.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/platform/windows/messaging.py	2011-02-01 19:10:23 +0000
@@ -0,0 +1,44 @@
+# ubuntuone.syncdaemon.platform.messaging - Messages to the user
+#
+# Author: Eric Casteleijn <[e-mail]>
+#
+# Copyright 2011 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/>.
+"""Module that implements sending messages to the end user."""
+
+# TODO: We may want to enable different messaging systems. When none
+# of them are available, we should fall back to silently discarding
+# messages.
+
+from ubuntuone.status.messaging import AbstractMessaging
+
+APPLICATION_NAME = 'Ubuntu One Client'
+
+
+class Messaging(AbstractMessaging):
+    """Notification of the end user."""
+
+    def show_message(self, sender, callback, message_time=None,
+                     message_count=None, icon=None):
+        """Show a message in the messaging menu."""
+        pass
+
+    def update_count(self, sender, new_count):
+        """Update the count for an existing indicator."""
+        pass
+
+
+def hide_message(indicator):
+    """Remove the message once it has been dealt with."""
+    pass

=== modified file 'ubuntuone/platform/windows/notification.py'
--- ubuntuone/platform/windows/notification.py	2011-01-18 22:27:02 +0000
+++ ubuntuone/platform/windows/notification.py	2011-02-01 19:10:23 +0000
@@ -34,3 +34,8 @@
         """Send a notification using the underlying library."""
         # TODO: Send notifications. Dummy class is here to not break
         # on windows.
+
+    def update_notification(self, notification, new_title, new_message,
+                            new_icon=None):
+        """Update the notification with a new message body."""
+

=== modified file 'ubuntuone/status/messaging.py'
--- ubuntuone/status/messaging.py	2011-01-26 23:30:46 +0000
+++ ubuntuone/status/messaging.py	2011-02-01 19:10:23 +0000
@@ -27,9 +27,11 @@
 
     __metaclass__ = ABCMeta
 
-    # pylint: disable=W0613,R0201
     @abstractmethod
-    def show_message(self, sender, callback, message_time=None, icon=None):
+    def show_message(self, sender, callback, message_time=None,
+                     message_count=None, icon=None):
         """Show a message in the messaging menu."""
-        return NotImplemented
-    # pylint: enable=W0613,R0201
+
+    @abstractmethod
+    def update_count(self, sender, new_count):
+        """Update the count for an existing indicator."""

=== modified file 'ubuntuone/status/notification.py'
--- ubuntuone/status/notification.py	2011-01-13 20:39:08 +0000
+++ ubuntuone/status/notification.py	2011-02-01 19:10:23 +0000
@@ -27,9 +27,11 @@
 
     __metaclass__ = ABCMeta
 
-    # pylint: disable=W0613,R0201
     @abstractmethod
-    def send_notification(self, title, message, icon, append):
+    def send_notification(self, title, message, icon=None, append=False):
         """Send a notification to the end user."""
-        return NotImplemented
-    # pylint: enable=W0613,R0201
+
+    @abstractmethod
+    def update_notification(self, notification, new_title, new_message,
+                            new_icon=None):
+        """Update the notification with a new message body."""