From 25c99926957688340d794a92f4b47632943f6901 Mon Sep 17 00:00:00 2001 From: Charles Kerr Date: Wed, 17 Jun 2015 23:52:52 -0500 Subject: add (failing) regression test for x-canonical-alarm components whose valarms have no triggers --- tests/CMakeLists.txt | 1 + tests/print-to.h | 24 +++++++ tests/test-eds-ics-missing-trigger.cpp | 116 +++++++++++++++++++++++++++++++++ tests/test-eds-ics-missing-trigger.ics | 45 +++++++++++++ 4 files changed, 186 insertions(+) create mode 100644 tests/test-eds-ics-missing-trigger.cpp create mode 100644 tests/test-eds-ics-missing-trigger.ics diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 1e22100..123aa9a 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -98,6 +98,7 @@ add_eds_ics_test_by_name(test-eds-ics-all-day-events) add_eds_ics_test_by_name(test-eds-ics-repeating-events) add_eds_ics_test_by_name(test-eds-ics-nonrepeating-events) add_eds_ics_test_by_name(test-eds-ics-repeating-valarms) +add_eds_ics_test_by_name(test-eds-ics-missing-trigger) # disabling the timezone unit tests because they require diff --git a/tests/print-to.h b/tests/print-to.h index f4af2f7..357925f 100644 --- a/tests/print-to.h +++ b/tests/print-to.h @@ -47,6 +47,30 @@ PrintTo(const Alarm& alarm, std::ostream* os) *os << '}'; } +void +PrintTo(const Appointment& appointment, std::ostream* os) +{ + *os << '{'; + + *os << "{uid:'" << appointment.uid << "'}" + << "{color:'" << appointment.color << "'}" + << "{summary:'" << appointment.summary << "'}" + << "{activation_url:'" << appointment.activation_url << "'}"; + + *os << "{begin:"; + PrintTo(appointment.begin, os); + *os << '}'; + + *os << "{end:"; + PrintTo(appointment.end, os); + *os << '}'; + + for(const auto& alarm : appointment.alarms) + PrintTo(alarm, os); + + *os << '}'; +} + } // namespace datetime } // namespace indicator } // namespace unity diff --git a/tests/test-eds-ics-missing-trigger.cpp b/tests/test-eds-ics-missing-trigger.cpp new file mode 100644 index 0000000..ba87011 --- /dev/null +++ b/tests/test-eds-ics-missing-trigger.cpp @@ -0,0 +1,116 @@ +/* + * 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 . + * + * Authors: + * Charles Kerr + */ + +#include + +#include +#include +#include +#include + +#include + +#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, MissingTriggers) +{ + // start the EDS engine + auto engine = std::make_shared(); + + // we need a consistent timezone for the planner and our local DateTimes + constexpr char const * zone_str {"America/Chicago"}; + auto tz = std::make_shared(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(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& 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); + } + + // build expected: one-time alarm + std::vector expected; + Appointment a; + a.type = Appointment::UBUNTU_ALARM; + a.uid = "20150617T211838Z-6217-32011-2036-1@ubuntu-phablet"; + a.color = "#becedd"; + a.summary = "One Time Alarm"; + a.begin = DateTime { gtz, 2015, 6, 18, 10, 0, 0}; + a.end = a.begin; + a.alarms.resize(1); + a.alarms[0].audio_url = "file:///usr/share/sounds/ubuntu/ringtones/Suru arpeggio.ogg"; + a.alarms[0].time = a.begin; + a.alarms[0].text = a.summary; + expected.push_back(a); + + // build expected: recurring alarm + a.uid = "20150617T211913Z-6217-32011-2036-5@ubuntu-phablet"; + a.summary = "Recurring Alarm"; + a.alarms[0].text = a.summary; + std::array recurrences { + DateTime{ gtz, 2015, 6, 18, 10, 1, 0 }, + DateTime{ gtz, 2015, 6, 19, 10, 1, 0 }, + DateTime{ gtz, 2015, 6, 20, 10, 1, 0 }, + DateTime{ gtz, 2015, 6, 21, 10, 1, 0 }, + DateTime{ gtz, 2015, 6, 22, 10, 1, 0 }, + DateTime{ gtz, 2015, 6, 23, 10, 1, 0 }, + DateTime{ gtz, 2015, 6, 24, 10, 1, 0 }, + DateTime{ gtz, 2015, 6, 25, 10, 1, 0 }, + DateTime{ gtz, 2015, 6, 26, 10, 1, 0 }, + DateTime{ gtz, 2015, 6, 27, 10, 1, 0 }, + DateTime{ gtz, 2015, 6, 28, 10, 1, 0 }, + DateTime{ gtz, 2015, 6, 29, 10, 1, 0 }, + DateTime{ gtz, 2015, 6, 30, 10, 1, 0 }, + DateTime{ gtz, 2015, 7, 1, 10, 1, 0 } + }; + for (const auto& time : recurrences) { + a.begin = a.end = a.alarms[0].time = time; + expected.push_back(a); + } + + // the planner should match what we've got in the calendar.ics file + const auto appts = planner->appointments().get(); + EXPECT_EQ(expected, appts); + + // cleanup + g_time_zone_unref(gtz); +} diff --git a/tests/test-eds-ics-missing-trigger.ics b/tests/test-eds-ics-missing-trigger.ics new file mode 100644 index 0000000..048e7f2 --- /dev/null +++ b/tests/test-eds-ics-missing-trigger.ics @@ -0,0 +1,45 @@ +BEGIN:VCALENDAR +CALSCALE:GREGORIAN +PRODID:-//Ximian//NONSGML Evolution Calendar//EN +VERSION:2.0 +X-EVOLUTION-DATA-REVISION:2015-06-17T21:19:13.980613Z(3) +BEGIN:VTODO +UID:20150617T211838Z-6217-32011-2036-1@ubuntu-phablet +DTSTAMP:20150617T211838Z +DTSTART:20150618T100000 +SUMMARY:One Time Alarm +CATEGORIES:x-canonical-alarm +CREATED:20150617T211838Z +LAST-MODIFIED:20150617T211838Z +BEGIN:VALARM +X-EVOLUTION-ALARM-UID:20150617T211838Z-6217-32011-2036-2@ubuntu-phablet +ACTION:AUDIO +ATTACH:file:///usr/share/sounds/ubuntu/ringtones/Suru arpeggio.ogg +END:VALARM +BEGIN:VALARM +X-EVOLUTION-ALARM-UID:20150617T211838Z-6217-32011-2036-3@ubuntu-phablet +ACTION:DISPLAY +DESCRIPTION:One Time Alarm +END:VALARM +END:VTODO +BEGIN:VTODO +UID:20150617T211913Z-6217-32011-2036-5@ubuntu-phablet +DTSTAMP:20150617T211913Z +DTSTART:20150618T100100 +RRULE:FREQ=DAILY +SUMMARY:Recurring Alarm +CATEGORIES:x-canonical-alarm +CREATED:20150617T211913Z +LAST-MODIFIED:20150617T211913Z +BEGIN:VALARM +X-EVOLUTION-ALARM-UID:20150617T211913Z-6217-32011-2036-6@ubuntu-phablet +ACTION:AUDIO +ATTACH:file:///usr/share/sounds/ubuntu/ringtones/Suru arpeggio.ogg +END:VALARM +BEGIN:VALARM +X-EVOLUTION-ALARM-UID:20150617T211913Z-6217-32011-2036-7@ubuntu-phablet +ACTION:DISPLAY +DESCRIPTION:Recurring Alarm +END:VALARM +END:VTODO +END:VCALENDAR -- cgit v1.2.3 From 23dc0fd91060fdd2f0d26a7b5bf22a952f08301f Mon Sep 17 00:00:00 2001 From: Charles Kerr Date: Wed, 17 Jun 2015 23:53:52 -0500 Subject: if older clock-app alarms don't have triggers, add them. --- src/engine-eds.cpp | 137 ++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 135 insertions(+), 2 deletions(-) diff --git a/src/engine-eds.cpp b/src/engine-eds.cpp index b171fda..b6b4f5e 100644 --- a/src/engine-eds.cpp +++ b/src/engine-eds.cpp @@ -297,10 +297,14 @@ private: // add the client to our collection auto self = static_cast(gself); g_debug("got a client for %s", e_cal_client_get_local_attachment_store(E_CAL_CLIENT(client))); - self->m_clients[e_client_get_source(client)] = E_CAL_CLIENT(client); + auto source = e_client_get_source(client); + auto ecc = E_CAL_CLIENT(client); + self->m_clients[source] = ecc; + + self->ensure_client_alarms_have_triggers(ecc); // now create a view for it so that we can listen for changes - e_cal_client_get_view (E_CAL_CLIENT(client), + e_cal_client_get_view (ecc, "#t", // match all self->m_cancellable, on_client_view_ready, @@ -409,6 +413,135 @@ private: static_cast(gself)->set_dirty_soon(); } + /*** + **** + ***/ + + // old ubuntu-clock-app alarms created VTODO VALARMS without the + // required 'TRIGGER' property... http://pad.lv/1465806 + + void ensure_client_alarms_have_triggers(ECalClient* client) + { + // ask the EDS server for all the ubuntu-clock-app alarms... + + auto sexp = g_strdup_printf("has-categories? '%s'", TAG_ALARM); + + e_cal_client_get_object_list_as_comps( + client, + sexp, + m_cancellable, + ensure_client_alarms_have_triggers_async_cb, + this); + + g_clear_pointer(&sexp, g_free); + } + + static void ensure_client_alarms_have_triggers_async_cb( + GObject * oclient, + GAsyncResult * res, + gpointer gself) + { + ECalClient * client = E_CAL_CLIENT(oclient); + GError * error = nullptr; + GSList * components = nullptr; + + if (e_cal_client_get_object_list_as_comps_finish(client, + res, + &components, + &error)) + { + auto self = static_cast(gself); + self->ensure_canonical_alarms_have_triggers(client, components); + e_cal_client_free_ecalcomp_slist(components); + } + else if (error != nullptr) + { + if (!g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED)) + g_warning("can't get clock-app alarm list: %s", error->message); + + g_error_free(error); + } + } + + void ensure_canonical_alarms_have_triggers(ECalClient * client, + GSList * components) + { + GSList * modify_slist = nullptr; + + // for each component.. + for (auto l=components; l!=nullptr; l=l->next) + { + bool changed = false; + + // for each alarm... + auto component = E_CAL_COMPONENT(l->data); + auto auids = e_cal_component_get_alarm_uids(component); + for(auto l=auids; l!=nullptr; l=l->next) + { + auto auid = static_cast(l->data); + auto alarm = e_cal_component_get_alarm(component, auid); + if (alarm == nullptr) + continue; + + // if the alarm has no trigger, add one. + ECalComponentAlarmTrigger trigger; + e_cal_component_alarm_get_trigger(alarm, &trigger); + if (trigger.type == E_CAL_COMPONENT_ALARM_TRIGGER_NONE) + { + trigger.type = E_CAL_COMPONENT_ALARM_TRIGGER_RELATIVE_START; + trigger.u.rel_duration = icaldurationtype_from_int(0); + e_cal_component_alarm_set_trigger (alarm, trigger); + changed = true; + } + + g_clear_pointer(&alarm, e_cal_component_alarm_free); + } + g_clear_pointer(&auids, cal_obj_uid_list_free); + + if (changed) + { + auto icc = e_cal_component_get_icalcomponent(component); // icc owned by ecc + modify_slist = g_slist_prepend(modify_slist, icc); + } + } + + if (modify_slist != nullptr) + { + e_cal_client_modify_objects(client, + modify_slist, + E_CAL_OBJ_MOD_ALL, + m_cancellable, + ensure_canonical_alarms_have_triggers_async_cb, + this); + + g_clear_pointer(&modify_slist, g_slist_free); + } + } + + // log a warning if e_cal_client_modify_objects() failed + static void ensure_canonical_alarms_have_triggers_async_cb( + GObject * oclient, + GAsyncResult * res, + gpointer /*gself*/) + { + GError * error = nullptr; + + e_cal_client_modify_objects_finish (E_CAL_CLIENT(oclient), res, &error); + + if (error != nullptr) + { + if (!g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED)) + g_warning("couldn't add alarm triggers: %s", error->message); + + g_error_free(error); + } + } + + /*** + **** + ***/ + + typedef std::function&)> appointment_func; struct Task -- cgit v1.2.3