Merge lp:~charlesk/indicator-datetime/lp-1362341-disable-one-time-ubuntu-alarms-after-notification into lp:indicator-datetime/15.04

[Charles Kerr]

After a one-time Ubuntu alarm's notification is displayed, disable the alarm.

Description of the Change
=========================

This branch culls the bugfix for bug #1362341 from my development branch so that it's easier to review and to backport in isolation.

This patch adds the 'x-canonical-disabled' tag to the categories of one-time Ubuntu alarms after their notification has been shown.

Checklist
=========

> Are there any related MPs required for this MP to build/function as expected? Please list.

This MP stacks on top of lp:~charlesk/indicator-datetime/lp-1320880-shorter-notifications-for-calendar-events

> Is your branch in sync with latest trunk? (e.g. bzr pull lp:trunk -> no changes)

Yes

> Did the code build without warnings?

Yes

> Did the tests run successfully?

Yes

> Did you perform an exploratory manual test run of your code change and any related functionality?

Yes

> If you changed the packaging (debian), did you subscribe the ubuntu-unity team to this MP?

N/A

> What device (or emulator) has your component test plan been executed successfully on?

Krillin running ubuntu-touch/ubuntu-rtm/14.09

> What manual tests are relevant for this MP?

indicator-datetime/disable-one-time-alarms-after-notification

> Did you include a link to the MR Review Checklist Template to make your reviewer's life easier?

https://wiki.ubuntu.com/Process/Merges/Checklists/indicator-datetime

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:391
http://jenkins.qa.ubuntu.com/job/indicator-datetime-ci/289/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/indicator-datetime-vivid-amd64-ci/3
    SUCCESS: http://jenkins.qa.ubuntu.com/job/indicator-datetime-vivid-armhf-ci/3
        deb: http://jenkins.qa.ubuntu.com/job/indicator-datetime-vivid-armhf-ci/3/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/indicator-datetime-ci/289/rebuild

review: Approve (continuous-integration)

[Ted Gould (ted)]

review: Needs Information

[Ted Gould (ted)]

review: Approve

=== modified file 'include/datetime/engine-eds.h'
--- include/datetime/engine-eds.h	2014-09-17 16:51:51 +0000
+++ include/datetime/engine-eds.h	2014-12-08 03:12:45 +0000
@@ -51,9 +51,10 @@
     void get_appointments(const DateTime& begin,
                           const DateTime& end,
                           const Timezone& default_timezone,
-                          std::function<void(const std::vector<Appointment>&)> appointment_func);
+                          std::function<void(const std::vector<Appointment>&)> appointment_func) override;
+    void disable_ubuntu_alarm(const Appointment&) override;
 
-    core::Signal<>& changed();
+    core::Signal<>& changed() override;
 
 private:
     class Impl;

=== modified file 'include/datetime/engine-mock.h'
--- include/datetime/engine-mock.h	2014-09-17 16:51:51 +0000
+++ include/datetime/engine-mock.h	2014-12-08 03:12:45 +0000
@@ -44,14 +44,17 @@
     void get_appointments(const DateTime& /*begin*/,
                           const DateTime& /*end*/,
                           const Timezone& /*default_timezone*/,
-                          std::function<void(const std::vector<Appointment>&)> appointment_func) {
+                          std::function<void(const std::vector<Appointment>&)> appointment_func) override {
         appointment_func(m_appointments);
     }
 
-    core::Signal<>& changed() {
+    core::Signal<>& changed() override {
         return m_changed;
     }
 
+    void disable_ubuntu_alarm(const Appointment&) override {
+    }
+
 private:
     core::Signal<> m_changed;
     std::vector<Appointment> m_appointments;

=== modified file 'include/datetime/engine.h'
--- include/datetime/engine.h	2014-09-17 16:51:51 +0000
+++ include/datetime/engine.h	2014-12-08 03:12:45 +0000
@@ -50,6 +50,7 @@
                                   const DateTime& end,
                                   const Timezone& default_timezone,
                                   std::function<void(const std::vector<Appointment>&)> appointment_func) =0;
+    virtual void disable_ubuntu_alarm(const Appointment&) =0;
 
     virtual core::Signal<>& changed() =0;
 

=== modified file 'src/engine-eds.cpp'
--- src/engine-eds.cpp	2014-12-08 03:12:45 +0000
+++ src/engine-eds.cpp	2014-12-08 03:12:45 +0000
@@ -136,6 +136,22 @@
         }
     }
 
+    void disable_ubuntu_alarm(const Appointment& appointment)
+    {
+        if (appointment.is_ubuntu_alarm())
+        {
+            for (auto& kv : m_clients) // find the matching icalcomponent
+            {
+                e_cal_client_get_object(kv.second,
+                                        appointment.uid.c_str(),
+                                        nullptr,
+                                        m_cancellable,
+                                        on_object_ready_for_disable,
+                                        this);
+            }
+        }
+    }
+
 private:
 
     void set_dirty_now()
@@ -506,6 +522,67 @@
  
         return G_SOURCE_CONTINUE;
     }
+
+    /***
+    ****
+    ***/
+
+    static void on_object_ready_for_disable(GObject      * client,
+                                            GAsyncResult * result,
+                                            gpointer       gself)
+    {
+        icalcomponent * icc = nullptr;
+        if (e_cal_client_get_object_finish (E_CAL_CLIENT(client), result, &icc, nullptr))
+        {
+            struct icaltimetype itt = icalcomponent_get_recurrenceid(icc);
+            if (icaltime_is_null_time(itt))
+            {
+                g_debug("'%s' appears to be a one-time alarm... adding 'disabled' tag.",
+                        icalcomponent_as_ical_string(icc));
+
+                auto ecc = e_cal_component_new_from_icalcomponent (icc); // takes ownership of icc
+                icc = nullptr;
+
+                if (ecc != nullptr)
+                {
+                    // add TAG_DISABLED to the list of categories
+                    GSList * old_categories = nullptr;
+                    e_cal_component_get_categories_list(ecc, &old_categories);
+                    auto new_categories = g_slist_copy(old_categories);
+                    new_categories = g_slist_append(new_categories, const_cast<char*>(TAG_DISABLED));
+                    e_cal_component_set_categories_list(ecc, new_categories);
+                    g_slist_free(new_categories);
+                    e_cal_component_free_categories_list(old_categories);
+                    e_cal_client_modify_object(E_CAL_CLIENT(client),
+                                               e_cal_component_get_icalcomponent(ecc),
+                                               E_CAL_OBJ_MOD_THIS,
+                                               static_cast<Impl*>(gself)->m_cancellable,
+                                               on_disable_done,
+                                               nullptr);
+
+                    g_clear_object(&ecc);
+                }
+            }
+
+            g_clear_pointer(&icc, icalcomponent_free);
+        }
+    }
+
+    static void on_disable_done (GObject* gclient, GAsyncResult *res, gpointer)
+    {
+        GError * error = nullptr;
+        if (!e_cal_client_modify_object_finish (E_CAL_CLIENT(gclient), res, &error))
+        {
+            if (!g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
+                g_warning("indicator-datetime cannot mark one-time alarm as disabled: %s", error->message);
+
+            g_error_free(error);
+        }
+    }
+
+    /***
+    ****
+    ***/
  
     core::Signal<> m_changed;
     std::set<ESource*> m_sources;
@@ -541,6 +618,11 @@
     p->get_appointments(begin, end, tz, func);
 }
 
+void EdsEngine::disable_ubuntu_alarm(const Appointment& appointment)
+{
+    p->disable_ubuntu_alarm(appointment);
+}
+
 /***
 ****
 ***/

=== modified file 'src/main.cpp'
--- src/main.cpp	2014-09-16 20:25:52 +0000
+++ src/main.cpp	2014-12-08 03:12:45 +0000
@@ -139,7 +139,10 @@
     auto alarm_queue = create_simple_alarm_queue(state->clock, snooze_planner, engine, timezone_);
     auto on_snooze = [snooze_planner](const Appointment& a) {snooze_planner->add(a);};
     auto on_ok = [](const Appointment&){};
-    auto on_alarm_reached = [&snap, &on_snooze, &on_ok](const Appointment& a) {(*snap)(a, on_snooze, on_ok);};
+    auto on_alarm_reached = [&engine, &snap, &on_snooze, &on_ok](const Appointment& a) {
+        (*snap)(a, on_snooze, on_ok);
+        engine->disable_ubuntu_alarm(a);
+    };
     alarm_queue->alarm_reached().connect(on_alarm_reached);
 
     // create the menus

=== modified file 'tests/manual'
--- tests/manual	2014-12-08 03:12:45 +0000
+++ tests/manual	2014-12-08 03:12:45 +0000
@@ -48,6 +48,16 @@
 		<dd>When the alarm is enabled, the alarm icon should reappear.</dd>
 </dl>
 
+Test-case indicator-datetime/disable-one-time-alarms-after-notification
+<dl>
+	<dt>Create and save an upcoming nonrepeating alarm in ubuntu-clock-app</dt>
+		<dd>Confirm that the alarm icon appears next to the current time in unity's indicator display</dd>
+	<dt>Wait until the alarm time is reached</dt>
+		<dd>Confirm that the alarm notification is shown</dd>
+		<dd>Confirm that the alarm's sound is played while the alarm notification is present</dd>
+		<dd>Confirm that the one-time alarm is disabled after the notification is shown. NOTE: due to a refresh bug in clock-app you may need to refresh its alarms page (by swapping back to the main page, then the alarm page again, this is tracked in #1362341) in order to see the alarm change from enabled to disabled.</dd>
+</dl>
+
 Test-case indicator-datetime/calendar-event-notification
 <dl>
 	<dt>In the calendar app, create and save a new upcoming calendar event that will occur in the next few minutes.</dt>