Merge lp:~charlesk/indicator-datetime/lp-1387231-honor-x-canonical-disabled-tag into lp:indicator-datetime/rtm-14.09

[Charles Kerr]

Add support for x-canonical-alarm and x-canonical-disabled tags in VTODO categories so that disabled alarms will not be displayed.

Same MP as proposed for Vivid @ https://code.launchpad.net/~charlesk/indicator-datetime/lp-1387231-honor-x-canonical-disabled-tag/+merge/243938

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

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

This piece adds support for noticing the x-canonical-alarm and x-canonical-disabled tags in VTODO's categories so that the indicator will know to not show disabled alarms.

Checklist
=========

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

No

> 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-proposed image 173

> What manual tests are relevant for this MP?

indicator-datetime/disabled-alarms

> 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

[Ted Gould (ted)]

review: Approve

=== modified file 'debian/changelog'
--- debian/changelog	2014-10-09 13:35:54 +0000
+++ debian/changelog	2014-12-10 04:00:35 +0000
@@ -1,3 +1,10 @@
+indicator-datetime (13.10.0+15.04.20141103-0ubuntu1) vivid; urgency=low
+
+  [ Ted Gould ]
+  * Small tag typo in integration test
+
+ -- Ubuntu daily release <[e-mail]>  Mon, 03 Nov 2014 21:04:05 +0000
+
 indicator-datetime (13.10.0+14.10.20141009-0ubuntu1) utopic; urgency=low
 
   [ Charles Kerr ]

=== modified file 'include/datetime/appointment.h'
--- include/datetime/appointment.h	2014-06-24 01:26:09 +0000
+++ include/datetime/appointment.h	2014-12-10 04:00:35 +0000
@@ -35,12 +35,15 @@
 struct Appointment
 {
 public:
+    enum Type { EVENT, UBUNTU_ALARM };
+    Type type = EVENT;
+    bool is_ubuntu_alarm() const { return type == UBUNTU_ALARM; }
+
     std::string color; 
     std::string summary;
     std::string url;
     std::string uid;
     std::string audio_url;
-    bool has_alarms = false;
     DateTime begin;
     DateTime end;
 

=== modified file 'src/actions-live.cpp'
--- src/actions-live.cpp	2014-03-25 21:28:54 +0000
+++ src/actions-live.cpp	2014-12-10 04:00:35 +0000
@@ -138,7 +138,7 @@
 {
     if (!appt.url.empty())
         dispatch_url(appt.url);
-    else if (appt.has_alarms)
+    else if (appt.is_ubuntu_alarm())
         phone_open_alarm_app();
     else
         phone_open_calendar_app(DateTime::NowLocal());

=== modified file 'src/appointment.cpp'
--- src/appointment.cpp	2014-10-07 18:45:03 +0000
+++ src/appointment.cpp	2014-12-10 04:00:35 +0000
@@ -29,12 +29,12 @@
 
 bool Appointment::operator==(const Appointment& that) const
 {
-    return (color==that.color)
+    return (type==that.type)
+        && (uid==that.uid)
+        && (color==that.color)
         && (summary==that.summary)
         && (url==that.url)
         && (audio_url==that.audio_url)
-        && (uid==that.uid)
-        && (has_alarms==that.has_alarms)
         && (begin==that.begin)
         && (end==that.end);
 }

=== modified file 'src/engine-eds.cpp'
--- src/engine-eds.cpp	2014-09-17 16:51:51 +0000
+++ src/engine-eds.cpp	2014-12-10 04:00:35 +0000
@@ -33,6 +33,9 @@
 namespace indicator {
 namespace datetime {
 
+static constexpr char const * TAG_ALARM {"x-canonical-alarm"};
+static constexpr char const * TAG_DISABLED {"x-canonical-disabled"};
+
 /****
 *****
 ****/
@@ -375,8 +378,6 @@
         static_cast<Impl*>(gself)->set_dirty_soon();
     }
 
-private:
-
     typedef std::function<void(const std::vector<Appointment>&)> appointment_func;
 
     struct Task
@@ -425,7 +426,22 @@
                      uid,
                      (int)status);
 
+            // look for the in-house tags
+            bool disabled = false;
+            Appointment::Type type = Appointment::EVENT;
+            GSList * categ_list = nullptr;
+            e_cal_component_get_categories_list (component, &categ_list);
+            for (GSList * l=categ_list; l!=nullptr; l=l->next) {
+                auto tag = static_cast<const char*>(l->data);
+                if (!g_strcmp0(tag, TAG_ALARM))
+                    type = Appointment::UBUNTU_ALARM;
+                if (!g_strcmp0(tag, TAG_DISABLED))
+                    disabled = true;
+            }
+            e_cal_component_free_categories_list(categ_list);
+
             if ((uid != nullptr) &&
+                (!disabled) &&
                 (status != ICAL_STATUS_COMPLETED) &&
                 (status != ICAL_STATUS_CANCELLED))
             {
@@ -441,12 +457,12 @@
                 appointment.end = end_dt;
                 appointment.color = subtask->color;
                 appointment.uid = uid;
+                appointment.type = type;
 
                 // Look through all of this component's alarms
                 // for DISPLAY or AUDIO url attachments.
                 // If we find any, use them for appointment.url and audio_sound
                 auto alarm_uids = e_cal_component_get_alarm_uids(component);
-                appointment.has_alarms = alarm_uids != nullptr;
                 for(auto walk=alarm_uids; appointment.url.empty() && walk!=nullptr; walk=walk->next)
                 {
                     auto alarm = e_cal_component_get_alarm(component, static_cast<const char*>(walk->data));

=== modified file 'src/menu.cpp'
--- src/menu.cpp	2014-10-03 19:22:31 +0000
+++ src/menu.cpp	2014-12-10 04:00:35 +0000
@@ -316,7 +316,7 @@
             g_menu_item_set_attribute (menu_item, "x-canonical-time", "x", unix_time);
             g_menu_item_set_attribute (menu_item, "x-canonical-time-format", "s", fmt.c_str());
 
-            if (appt.has_alarms)
+            if (appt.is_ubuntu_alarm())
             {
                 g_menu_item_set_attribute (menu_item, "x-canonical-type", "s", "com.canonical.indicator.alarm");
                 g_menu_item_set_attribute_value(menu_item, G_MENU_ATTRIBUTE_ICON, get_serialized_alarm_icon());
@@ -509,16 +509,16 @@
     GVariant* create_header_state()
     {
         // are there alarms?
-        bool has_alarms = false;
+        bool has_ubuntu_alarms = false;
         for(const auto& appointment : m_upcoming)
-            if((has_alarms = appointment.has_alarms))
+            if((has_ubuntu_alarms = appointment.is_ubuntu_alarm()))
                 break;
 
         GVariantBuilder b;
         g_variant_builder_init(&b, G_VARIANT_TYPE_VARDICT);
         g_variant_builder_add(&b, "{sv}", "title", g_variant_new_string (_("Time & Date")));
         g_variant_builder_add(&b, "{sv}", "visible", g_variant_new_boolean (TRUE));
-        if (has_alarms)
+        if (has_ubuntu_alarms)
         {
             auto label = m_formatter->header.get();
             auto a11y = g_strdup_printf(_("%s (has alarms)"), label.c_str());

=== modified file 'src/snap.cpp'
--- src/snap.cpp	2014-09-17 17:30:48 +0000
+++ src/snap.cpp	2014-12-10 04:00:35 +0000
@@ -63,12 +63,6 @@
                     appointment_func snooze,
                     appointment_func ok)
     {
-        if (!appointment.has_alarms)
-        {
-            ok(appointment);
-            return;
-        }
-
         // force the system to stay awake
         auto awake = std::make_shared<uin::Awake>(m_engine->app_name());
 

=== modified file 'tests/manual'
--- tests/manual	2014-10-09 13:35:42 +0000
+++ tests/manual	2014-12-10 04:00:35 +0000
@@ -25,7 +25,7 @@
 Test-case indicator-datetime/timestamp-wakeup
 <dl>
         <dt>Unplug the phone from any USB connection and put it to sleep</dt>
-        <dd>Reawaken the device.</dt>
+        <dt>Reawaken the device.</dt>
                 <dd>The indicator should be showing the correct time.</dd>
 </dl>
 
@@ -33,13 +33,21 @@
 <dl>
 	<dt>Create and save an upcoming alarm in ubuntu-clock-app</dt>
 	<dt>Unplug the phone from any USB connection and put it to sleep</dt>
-		<dd>Confirm that the alarm sounds on time even if the phone is asleep.
-		(Note: if in doubt about sleep you can see in the syslog whether the
-		device actually suspended or whether the suspend was aborted)</dd>
+		<dd>Confirm that the alarm sounds on time even if the phone is asleep.  (Note: if in doubt about sleep you can see in the syslog whether the device actually suspended or whether the suspend was aborted)</dd>
 		<dd>Confirm that the screen comes on when the alarm is triggered.<dd>
 		<dd>If the device supports haptic feedback, confirm the alarm vibrates.</dd>
 </dl>
 
+Test-case indicator-datetime/disabled-alarms
+<dl>
+	<dt>Create and save an upcoming 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>Disable the alarm in ubuntu-clock-app</dt>
+		<dd>When all alarms are disabled or removed, the alarm icon should disappear.</dd>
+	<dt>Re-enable the alarm in ubuntu-clock-app</dt>
+		<dd>When the alarm is enabled, the alarm icon should reappear.</dd>
+</dl>
+
 Test-case indicator-datetime/alarm-timezone
 <dl>
 	<dt>In ubuntu-system-settings, change your timezone to a zone you're not in</dt>
@@ -53,8 +61,7 @@
 <dl>
 	<dt>Create and save an upcoming alarm in ubuntu-clock-app</dt>
 	<dt>When the alarm goes off, press the 'Snooze' button</dt>
-		<dd>The alarm should go away, then reappear N minutes later.
-		By default the N is 5 minutes but will be configurable from ubuntu-clock-app.</dd>
+		<dd>The alarm should go away, then reappear N minutes later. By default the N is 5 minutes but will be configurable from ubuntu-clock-app.</dd>
 	<dt>When the snoozed alarm reappears, press the 'OK' button</dt>
 		<dd>This time when the alarm is dismissed, it should not reappear.</dd>
 </dl>
@@ -63,16 +70,14 @@
 <dl>
 	<dt>Edit an alarm that's already passed. (see previous test)</dt>
 	<dt>Unplug the phone from any USB connection and put it to sleep</dt>
-		<dd>Confirm that the alarm sounds on time even if the phone is asleep.
-		(Note: if in doubt about sleep you can see in the syslog whether the
-		device actually suspended or whether the suspend was aborted)</dd>
+		<dd>Confirm that the alarm sounds on time even if the phone is asleep. (Note: if in doubt about sleep you can see in the syslog whether the device actually suspended or whether the suspend was aborted)</dd>
 		<dd>Confirm that the screen comes on when the alarm is triggered.<dd>
 		<dd>If the device supports haptic feedback, confirm the alarm vibrates.</dd>
 </dl>
 
 Test-case indicator-datetime/tell-snap-decision-to-dismiss
 <dl>
-	<dt>Set an alarm and wait for it to arrive.</td>
+	<dt>Set an alarm and wait for it to arrive.</dt>
 		<dd>Alarm should go off at the specified time</dd>
 	<dt>Press the 'Dismiss' button in the alarm's snap decision popup before the sound stops.</dt>
 		<dd>Popup should disappear</dd>

=== modified file 'tests/manual-test-snap.cpp'
--- tests/manual-test-snap.cpp	2014-09-17 16:51:51 +0000
+++ tests/manual-test-snap.cpp	2014-12-10 04:00:35 +0000
@@ -69,7 +69,7 @@
     a.summary = "Alarm";
     a.url = "alarm:///hello-world";
     a.uid = "D4B57D50247291478ED31DED17FF0A9838DED402";
-    a.has_alarms = true;
+    a.type = Appointment::UBUNTU_ALARM;
     auto begin = g_date_time_new_local(2014,12,25,0,0,0);
     auto end = g_date_time_add_full(begin,0,0,1,0,0,-1);
     a.begin = begin;

=== modified file 'tests/test-actions.cpp'
--- tests/test-actions.cpp	2014-09-17 16:51:51 +0000
+++ tests/test-actions.cpp	2014-12-10 04:00:35 +0000
@@ -39,7 +39,7 @@
         a1.summary = "Alarm";
         a1.summary = "http://www.example.com/";
         a1.uid = "example";
-        a1.has_alarms = true;
+        a1.type = Appointment::UBUNTU_ALARM;
         a1.begin = a1.end = tomorrow;
 
         Appointment a2; // a non-alarm appointment
@@ -47,7 +47,7 @@
         a2.summary = "Other Text";
         a2.summary = "http://www.monkey.com/";
         a2.uid = "monkey";
-        a2.has_alarms = false;
+        a1.type = Appointment::EVENT;
         a2.begin = a2.end = tomorrow;
 
         return std::vector<Appointment>({a1, a2});

=== modified file 'tests/test-alarm-queue.cpp'
--- tests/test-alarm-queue.cpp	2014-04-25 03:34:42 +0000
+++ tests/test-alarm-queue.cpp	2014-12-10 04:00:35 +0000
@@ -80,7 +80,7 @@
         a1.summary = "Alarm";
         a1.summary = "http://www.example.com/";
         a1.uid = "example";
-        a1.has_alarms = true;
+        a1.type = Appointment::UBUNTU_ALARM;
         a1.begin = tomorrow_begin;
         a1.end = tomorrow_end;
 
@@ -92,7 +92,7 @@
         a2.summary = "Other Text";
         a2.summary = "http://www.monkey.com/";
         a2.uid = "monkey";
-        a2.has_alarms = false;
+        a1.type = Appointment::EVENT;
         a2.begin = ubermorgen_begin;
         a2.end = ubermorgen_end;
 

=== modified file 'tests/test-live-actions.cpp'
--- tests/test-live-actions.cpp	2014-09-17 16:51:51 +0000
+++ tests/test-live-actions.cpp	2014-12-10 04:00:35 +0000
@@ -312,11 +312,11 @@
 
     a.uid = "some-uid";
     a.begin = DateTime::NowLocal();
-    a.has_alarms = false;
+    a.type = Appointment::EVENT;
     m_actions->phone_open_appointment(a);
     EXPECT_EQ(calendar_app_url, m_live_actions->last_url);
 
-    a.has_alarms = true;
+    a.type = Appointment::UBUNTU_ALARM;
     m_actions->phone_open_appointment(a);
     EXPECT_EQ(clock_app_url, m_live_actions->last_url);
 

=== modified file 'tests/test-menus.cpp'
--- tests/test-menus.cpp	2014-09-17 16:51:51 +0000
+++ tests/test-menus.cpp	2014-12-10 04:00:35 +0000
@@ -191,7 +191,7 @@
         a1.summary = "Alarm";
         a1.summary = "http://www.example.com/";
         a1.uid = "example";
-        a1.has_alarms = true;
+        a1.type = Appointment::UBUNTU_ALARM;
         a1.begin = a1.end = tomorrow;
 
         Appointment a2; // a non-alarm appointment
@@ -199,7 +199,7 @@
         a2.summary = "Other Text";
         a2.summary = "http://www.monkey.com/";
         a2.uid = "monkey";
-        a2.has_alarms = false;
+        a1.type = Appointment::EVENT;
         a2.begin = a2.end = tomorrow;
 
         return std::vector<Appointment>({a1, a2});
@@ -212,7 +212,7 @@
         //  confirm it has the right x-canonical-type
         gchar * str = nullptr;
         g_menu_model_get_item_attribute(section, index, "x-canonical-type", "s", &str);
-        if (appt.has_alarms)
+        if (appt.is_ubuntu_alarm())
             EXPECT_STREQ("com.canonical.indicator.alarm", str);
         else
             EXPECT_STREQ("com.canonical.indicator.appointment", str);
@@ -245,7 +245,7 @@
         g_clear_pointer(&str, g_free);
 
         // confirm that alarms have an icon
-        if (appt.has_alarms)
+        if (appt.is_ubuntu_alarm())
         {
             auto v = g_menu_model_get_item_attribute_value(section,
                                                            index,

=== modified file 'tests/test-snap.cpp'
--- tests/test-snap.cpp	2014-09-17 16:51:51 +0000
+++ tests/test-snap.cpp	2014-12-10 04:00:35 +0000
@@ -108,7 +108,7 @@
     appt.summary = "Alarm";
     appt.url = "alarm:///hello-world";
     appt.uid = "D4B57D50247291478ED31DED17FF0A9838DED402";
-    appt.has_alarms = true;
+    appt.type = Appointment::EVENT;
     auto begin = g_date_time_new_local(2014,12,25,0,0,0);
     auto end = g_date_time_add_full(begin,0,0,1,0,0,-1);
     appt.begin = begin;