Merge lp:~charlesk/indicator-datetime/lp-1426519-add-tag-for-menuitem-activation-url into lp:indicator-datetime/15.10

[Charles Kerr]

If the "X-CANONICAL-ACTIVATION-URL" x-prop is defined in the VTODO or VEVENT, use it for url delegation.

Sibling 15.04 MP: https://code.launchpad.net/~charlesk/indicator-datetime/lp-1426519-add-tag-for-menuitem-activation-url/+merge/253997

If the "X-CANONICAL-ACTIVATION-URL" x-prop is defined in the VTODO or VEVENT, use it for url delegation.

Since no clients are using this key yet, a little white-box testing is necessary:

Steps
1. in clock-app, create a repeating alarm
2. $ stop indicator-datetime
3. $ pkill -f evolution-calendar-factory
4. Edit ~/.local/share/evolution/tasks/${some-unique-epoch-id-generated-by-evolution}/tasks.ics:
   After the line "BEGIN:VTODO^M", insert a new line:
   X-CANONICAL-ACTIVATION-URL:http://www.canonical.com/^M
5. $ start indicator-datetime
6. pull down the indicator menu
7. click on the alarm that you edited in step 4

Expected result:
Browser should launch to http://www.canonical.com/

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

[Ted Gould (ted)]

review: Approve

[Ted Gould (ted)]

review: Approve

=== modified file 'src/engine-eds.cpp'
--- src/engine-eds.cpp	2015-04-06 19:58:34 +0000
+++ src/engine-eds.cpp	2015-05-08 00:22:35 +0000
@@ -34,9 +34,11 @@
 namespace indicator {
 namespace datetime {
 
-static constexpr char const * TAG_ALARM {"x-canonical-alarm"};
+static constexpr char const * TAG_ALARM    {"x-canonical-alarm"};
 static constexpr char const * TAG_DISABLED {"x-canonical-disabled"};
 
+static constexpr char const * X_PROP_ACTIVATION_URL {"X-CANONICAL-ACTIVATION-URL"};
+
 /****
 *****
 ****/
@@ -537,22 +539,39 @@
                 if (text.value)
                     appointment.summary = text.value;
 
+                auto icc = e_cal_component_get_icalcomponent(component); // component owns icc
+                if (icc)
+                {
+                    g_debug("%s", icalcomponent_as_ical_string(icc)); // libical owns this string; no leak
+
+                    auto icalprop = icalcomponent_get_first_property(icc, ICAL_X_PROPERTY);
+                    while (icalprop)
+                    {
+                        const char * x_name = icalproperty_get_x_name(icalprop);
+                        if ((x_name != nullptr) && !g_ascii_strcasecmp(x_name, X_PROP_ACTIVATION_URL))
+                        {
+                            const char * url = icalproperty_get_value_as_string(icalprop);
+                            if ((url != nullptr) && appointment.activation_url.empty())
+                                appointment.activation_url = url;
+                        }
+
+                        icalprop = icalcomponent_get_next_property(icc, ICAL_X_PROPERTY);
+                    }
+                }
+
                 appointment.begin = begin_dt;
                 appointment.end = end_dt;
                 appointment.color = subtask->color;
                 appointment.uid = uid;
                 appointment.type = type;
 
-                icalcomponent * icc = e_cal_component_get_icalcomponent(component);
-                g_debug("%s", icalcomponent_as_ical_string(icc)); // libical owns this string; no leak
-
                 auto e_alarms = e_cal_util_generate_alarms_for_comp(component,
                                                                     subtask->begin,
                                                                     subtask->end,
                                                                     const_cast<ECalComponentAlarmAction*>(omit.data()),
                                                                     e_cal_client_resolve_tzid_cb,
                                                                     subtask->client,
-                                                                    subtask->default_timezone);
+                                                                    nullptr);
 
                 std::map<DateTime,Alarm> alarms;
 
 
=== modified file 'tests/CMakeLists.txt'
--- tests/CMakeLists.txt	2015-04-06 00:19:01 +0000
+++ tests/CMakeLists.txt	2015-05-08 00:22:35 +0000
@@ -93,6 +93,7 @@
             ${GVFSD}                                               # arg7: gvfsd exec
             ${CMAKE_CURRENT_SOURCE_DIR}/${TEST_NAME}-config-files) # arg8: canned config files
 endfunction()
+add_eds_test_by_name(test-eds-tasks)
 add_eds_test_by_name(test-eds-valarms)
 
 
 
=== added directory 'tests/test-eds-tasks-config-files'
=== added directory 'tests/test-eds-tasks-config-files/.config'
=== added directory 'tests/test-eds-tasks-config-files/.config/evolution'
=== added directory 'tests/test-eds-tasks-config-files/.config/evolution/sources'
=== added file 'tests/test-eds-tasks-config-files/.config/evolution/sources/system-proxy.source'
--- tests/test-eds-tasks-config-files/.config/evolution/sources/system-proxy.source	1970-01-01 00:00:00 +0000
+++ tests/test-eds-tasks-config-files/.config/evolution/sources/system-proxy.source	2015-05-08 00:22:35 +0000
@@ -0,0 +1,21 @@
+
+[Data Source]
+DisplayName=Default Proxy Settings
+Enabled=true
+Parent=
+
+[Proxy]
+Method=default
+IgnoreHosts=localhost;127.0.0.0/8;::1;
+AutoconfigUrl=
+FtpHost=
+FtpPort=0
+HttpAuthPassword=
+HttpAuthUser=
+HttpHost=
+HttpPort=8080
+HttpUseAuth=false
+HttpsHost=
+HttpsPort=0
+SocksHost=
+SocksPort=0
 
=== added directory 'tests/test-eds-tasks-config-files/.local'
=== added directory 'tests/test-eds-tasks-config-files/.local/share'
=== added directory 'tests/test-eds-tasks-config-files/.local/share/evolution'
=== added directory 'tests/test-eds-tasks-config-files/.local/share/evolution/tasks'
=== added directory 'tests/test-eds-tasks-config-files/.local/share/evolution/tasks/system'
=== added file 'tests/test-eds-tasks-config-files/.local/share/evolution/tasks/system/tasks.ics'
--- tests/test-eds-tasks-config-files/.local/share/evolution/tasks/system/tasks.ics	1970-01-01 00:00:00 +0000
+++ tests/test-eds-tasks-config-files/.local/share/evolution/tasks/system/tasks.ics	2015-05-08 00:22:35 +0000
@@ -0,0 +1,28 @@
+BEGIN:VCALENDAR
+CALSCALE:GREGORIAN
+PRODID:-//Ximian//NONSGML Evolution Calendar//EN
+VERSION:2.0
+X-EVOLUTION-DATA-REVISION:2015-05-07T21:14:49.315443Z(0)
+BEGIN:VTODO
+UID:20150507T211449Z-4262-32011-1418-1@ubuntu-phablet
+DTSTAMP:20150508T211449Z
+DTSTART:20150508T164000
+RRULE:FREQ=WEEKLY;BYDAY=FR
+SUMMARY:Alarm
+CATEGORIES:x-canonical-alarm
+CREATED:20150507T211449Z
+LAST-MODIFIED:20150507T211449Z
+BEGIN:VALARM
+X-EVOLUTION-ALARM-UID:20150507T211449Z-4262-32011-1418-2@ubuntu-phablet
+ACTION:AUDIO
+ATTACH:file:///usr/share/sounds/ubuntu/ringtones/Suru arpeggio.ogg
+TRIGGER;VALUE=DURATION;RELATED=START:PT0S
+END:VALARM
+BEGIN:VALARM
+X-EVOLUTION-ALARM-UID:20150507T211449Z-4262-32011-1418-3@ubuntu-phablet
+ACTION:DISPLAY
+DESCRIPTION:Alarm
+TRIGGER;VALUE=DURATION;RELATED=START:PT0S
+END:VALARM
+END:VTODO
+END:VCALENDAR
 
=== added file 'tests/test-eds-tasks.cpp'
--- tests/test-eds-tasks.cpp	1970-01-01 00:00:00 +0000
+++ tests/test-eds-tasks.cpp	2015-05-08 00:22:35 +0000
@@ -0,0 +1,101 @@
+/*
+ * Copyright 2015 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/>.
+ *
+ * Authors:
+ *   Charles Kerr <[e-mail]>
+ */
+
+#include <algorithm>
+
+#include <datetime/alarm-queue-simple.h>
+#include <datetime/clock-mock.h>
+#include <datetime/engine-eds.h>
+#include <datetime/planner-range.h>
+
+#include <gtest/gtest.h>
+
+#include "glib-fixture.h"
+#include "print-to.h"
+#include "timezone-mock.h"
+#include "wakeup-timer-mock.h"
+
+using namespace unity::indicator::datetime;
+using VAlarmFixture = GlibFixture;
+
+/***
+****
+***/
+
+TEST_F(VAlarmFixture, MultipleAppointments)
+{
+    // start the EDS engine
+    auto engine = std::make_shared<EdsEngine>();
+
+    // we need a consistent timezone for the planner and our local DateTimes
+    constexpr char const * zone_str {"America/Chicago"};
+    auto tz = std::make_shared<MockTimezone>(zone_str);
+    auto gtz = g_time_zone_new(zone_str);
+
+    // make a planner that looks at the first half of 2015 in EDS
+    auto planner = std::make_shared<SimpleRangePlanner>(engine, tz);
+    const DateTime range_begin {gtz, 2015,1, 1, 0, 0, 0.0};
+    const DateTime range_end   {gtz, 2015,6,31,23,59,59.5};
+    planner->range().set(std::make_pair(range_begin, range_end));
+
+    // give EDS a moment to load
+    if (planner->appointments().get().empty()) {
+        g_message("waiting a moment for EDS to load...");
+        auto on_appointments_changed = [this](const std::vector<Appointment>& appointments){
+            g_message("ah, they loaded");
+            if (!appointments.empty())
+                g_main_loop_quit(loop);
+        };
+        core::ScopedConnection conn(planner->appointments().changed().connect(on_appointments_changed));
+        constexpr int max_wait_sec = 10;
+        wait_msec(max_wait_sec * G_TIME_SPAN_MILLISECOND);
+    }
+   
+    // what we expect to get...
+    Appointment expected_appt;
+    expected_appt.uid = "20150507T211449Z-4262-32011-1418-1@ubuntu-phablet";
+    expected_appt.color = "#becedd";
+    expected_appt.summary = "Alarm";
+    std::array<Alarm,8> expected_alarms = {
+        Alarm({"Alarm", "file:///usr/share/sounds/ubuntu/ringtones/Suru arpeggio.ogg", DateTime(gtz,2015,5, 8,16,40,0)}),
+        Alarm({"Alarm", "file:///usr/share/sounds/ubuntu/ringtones/Suru arpeggio.ogg", DateTime(gtz,2015,5,15,16,40,0)}),
+        Alarm({"Alarm", "file:///usr/share/sounds/ubuntu/ringtones/Suru arpeggio.ogg", DateTime(gtz,2015,5,22,16,40,0)}),
+        Alarm({"Alarm", "file:///usr/share/sounds/ubuntu/ringtones/Suru arpeggio.ogg", DateTime(gtz,2015,5,29,16,40,0)}),
+        Alarm({"Alarm", "file:///usr/share/sounds/ubuntu/ringtones/Suru arpeggio.ogg", DateTime(gtz,2015,6, 5,16,40,0)}),
+        Alarm({"Alarm", "file:///usr/share/sounds/ubuntu/ringtones/Suru arpeggio.ogg", DateTime(gtz,2015,6,12,16,40,0)}),
+        Alarm({"Alarm", "file:///usr/share/sounds/ubuntu/ringtones/Suru arpeggio.ogg", DateTime(gtz,2015,6,19,16,40,0)}),
+        Alarm({"Alarm", "file:///usr/share/sounds/ubuntu/ringtones/Suru arpeggio.ogg", DateTime(gtz,2015,6,26,16,40,0)})
+    };
+
+    // compare it to what we actually loaded...
+    const auto appts = planner->appointments().get();
+    EXPECT_EQ(expected_alarms.size(), appts.size());
+    for (size_t i=0, n=expected_alarms.size(); i<n; i++) {
+        const auto& appt = appts[i];
+        EXPECT_EQ(expected_appt.uid, appt.uid);
+        EXPECT_EQ(expected_appt.color, appt.color);
+        EXPECT_EQ(expected_appt.summary, appt.summary);
+        EXPECT_EQ(1, appt.alarms.size());
+        EXPECT_EQ(expected_alarms[i], appt.alarms[0]);
+    }
+    
+
+    // cleanup
+    g_time_zone_unref(gtz);
+}