From 38b878589ffb08d2272169d2529703e887933be9 Mon Sep 17 00:00:00 2001 From: Charles Kerr Date: Tue, 17 Dec 2013 22:03:12 -0600 Subject: add planner + tests --- include/datetime/planner-eds.h | 49 +++++ include/datetime/planner.h | 71 +++++++ src/planner-eds.cpp | 419 +++++++++++++++++++++++++++++++++++++++++ tests/test-planner-eds.cc | 70 +++++++ tests/test-planner.cc | 68 +++++++ 5 files changed, 677 insertions(+) create mode 100644 include/datetime/planner-eds.h create mode 100644 include/datetime/planner.h create mode 100644 src/planner-eds.cpp create mode 100644 tests/test-planner-eds.cc create mode 100644 tests/test-planner.cc diff --git a/include/datetime/planner-eds.h b/include/datetime/planner-eds.h new file mode 100644 index 0000000..43f222e --- /dev/null +++ b/include/datetime/planner-eds.h @@ -0,0 +1,49 @@ +/* + * Copyright 2013 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 + */ + +#ifndef INDICATOR_DATETIME_PLANNER_EDS_H +#define INDICATOR_DATETIME_PLANNER_EDS_H + +#include + +#include // unique_ptr + +namespace unity { +namespace indicator { +namespace datetime { + +/** + * \brief Planner which uses EDS as its backend + */ +class PlannerEds: public Planner +{ +public: + PlannerEds(); + virtual ~PlannerEds(); + +private: + class Impl; + std::unique_ptr impl_; +}; + +} // namespace datetime +} // namespace indicator +} // namespace unity + +#endif // INDICATOR_DATETIME_PLANNER_EDS_H diff --git a/include/datetime/planner.h b/include/datetime/planner.h new file mode 100644 index 0000000..4d27a2b --- /dev/null +++ b/include/datetime/planner.h @@ -0,0 +1,71 @@ +/* + * Copyright 2013 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 + */ + +#ifndef INDICATOR_DATETIME_PLANNER_H +#define INDICATOR_DATETIME_PLANNER_H + +#include +#include + +#include + +#include + +namespace unity { +namespace indicator { +namespace datetime { + +/** + * \brief Simple appointment book + */ +class Planner +{ +public: + virtual ~Planner() =default; + + /** + * \brief Timestamp used to determine the appointments in the `upcoming' and `thisMonth' properties. + * Setting this value will cause the planner to re-query its backend and + * update the `upcoming' and `thisMonth' properties. + */ + core::Property time; + + /** + * \brief The next few appointments that follow the time specified in the time property. + */ + core::Property> upcoming; + + /** + * \brief The appointments that occur in the same month as the time property + */ + core::Property> thisMonth; + +protected: + Planner() =default; + +private: + Planner(const Planner&) =delete; + Planner& operator=(const Planner&) =delete; +}; + +} // namespace datetime +} // namespace indicator +} // namespace unity + +#endif // INDICATOR_DATETIME_PLANNER_H diff --git a/src/planner-eds.cpp b/src/planner-eds.cpp new file mode 100644 index 0000000..804d98e --- /dev/null +++ b/src/planner-eds.cpp @@ -0,0 +1,419 @@ +/* + * Copyright 2013 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 + +namespace unity { +namespace indicator { +namespace datetime { + +/**** +***** +****/ + +G_DEFINE_QUARK ("source-client", source_client) + + +class PlannerEds::Impl +{ +public: + + Impl (PlannerEds& owner): + owner_(owner), + cancellable_(g_cancellable_new()) + { + e_source_registry_new (cancellable_, on_source_registry_ready, this); + + owner_.time.changed().connect([this](const DateTime& dt) { + g_message ("planner's datetime property changed to %s; calling rebuildSoon()", g_date_time_format(dt.get(), "%F %T")); + rebuildSoon(); + }); + + rebuildSoon(); + } + + ~Impl() + { + g_cancellable_cancel (cancellable_); + g_clear_object (&cancellable_); + + if (rebuild_tag_) + g_source_remove (rebuild_tag_); + + if (source_registry_) + g_signal_handlers_disconnect_by_data (source_registry_, this); + g_clear_object (&source_registry_); + } + +private: + + static void on_source_registry_ready (GObject* /*source*/, GAsyncResult* res, gpointer gself) + { + GError * error = NULL; + auto r = e_source_registry_new_finish (res, &error); + if (error != NULL) + { + if (!g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED)) + g_warning ("indicator-datetime cannot show EDS appointments: %s", error->message); + + g_error_free (error); + } + else + { + auto self = static_cast(gself); + + g_signal_connect (r, "source-added", G_CALLBACK(on_source_added), self); + g_signal_connect (r, "source-removed", G_CALLBACK(on_source_removed), self); + g_signal_connect (r, "source-changed", G_CALLBACK(on_source_changed), self); + g_signal_connect (r, "source-disabled", G_CALLBACK(on_source_disabled), self); + g_signal_connect (r, "source-enabled", G_CALLBACK(on_source_enabled), self); + + self->source_registry_ = r; + + GList* sources = e_source_registry_list_sources (r, E_SOURCE_EXTENSION_CALENDAR); + for (auto l=sources; l!=nullptr; l=l->next) + on_source_added (r, E_SOURCE(l->data), gself); + g_list_free_full (sources, g_object_unref); + } + } + + static void on_source_added(ESourceRegistry* registry, ESource* source, gpointer gself) + { + auto self = static_cast(gself); + + self->sources_.insert(E_SOURCE(g_object_ref(source))); + + if (e_source_get_enabled(source)) + on_source_enabled(registry, source, gself); + } + + static void on_source_enabled (ESourceRegistry* /*registry*/, ESource* source, gpointer gself) + { + auto self = static_cast(gself); + + e_cal_client_connect (source, + E_CAL_CLIENT_SOURCE_TYPE_EVENTS, + self->cancellable_, + on_client_connected, + gself); + } + + static void on_client_connected (GObject* /*source*/, GAsyncResult * res, gpointer gself) + { + GError * error = nullptr; + EClient * client = e_cal_client_connect_finish (res, &error); + if (error) + { + if (!g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED)) + g_warning ("indicator-datetime cannot connect to EDS source: %s", error->message); + + g_error_free (error); + } + else + { + // we've got a new connected ECalClient, so store it & notify clients + g_object_set_qdata_full (G_OBJECT(e_client_get_source(client)), + source_client_quark(), + client, + g_object_unref); + + g_message ("client connected; calling rebuildSoon()"); + static_cast(gself)->rebuildSoon(); + } + } + + static void on_source_disabled (ESourceRegistry* /*registry*/, ESource* source, gpointer gself) + { + gpointer e_cal_client; + + // if this source has a connected ECalClient, remove it & notify clients + if ((e_cal_client = g_object_steal_qdata (G_OBJECT(source), source_client_quark()))) + { + g_object_unref (e_cal_client); + + g_message ("source disabled; calling rebuildSoon()"); + static_cast(gself)->rebuildSoon(); + } + } + + static void on_source_removed (ESourceRegistry* registry, ESource* source, gpointer gself) + { + auto self = static_cast(gself); + + on_source_disabled (registry, source, gself); + + self->sources_.erase (source); + g_object_unref (source); + } + + static void on_source_changed (ESourceRegistry* /*registry*/, ESource* /*source*/, gpointer gself) + { + g_message ("source changed; calling rebuildSoon()"); + static_cast(gself)->rebuildSoon(); + } + +private: + + typedef std::function&)> appointment_func; + + struct Task + { + Impl* impl_; + appointment_func func_; + std::vector appointments_; + Task (Impl* impl, const appointment_func& func): impl_(impl), func_(func) {} + }; + + struct AppointmentSubtask + { + std::shared_ptr task_; + ECalClient * client_; + std::string color_; + AppointmentSubtask (const std::shared_ptr& task, ECalClient* client, const char* color): + task_(task), client_(client), color_(color) {} + }; + + void rebuildSoon() + { + const static guint ARBITRARY_INTERVAL_SECS = 2; + + if (rebuild_tag_ == 0) + rebuild_tag_ = g_timeout_add_seconds (ARBITRARY_INTERVAL_SECS, rebuildNowStatic, this); + } + + static gboolean rebuildNowStatic (gpointer gself) + { + auto self = static_cast(gself); + self->rebuild_tag_ = 0; + self->rebuildNow(); + return G_SOURCE_REMOVE; + } + + void rebuildNow() + { + GDateTime* calendar_date = owner_.time.get().get(); + GDateTime* begin; + GDateTime* end; + int y, m, d; + g_message ("in rebuildNow"); + + // get all the appointments in the calendar month + g_date_time_get_ymd(calendar_date, &y, &m, &d); + begin = g_date_time_new_local(y, m, 1, 0, 0, 0.1); + end = g_date_time_new_local(y, m, g_date_get_days_in_month(GDateMonth(m),GDateYear(y)), 23, 59, 59.9); + if (begin && end) + { + getAppointments(begin, end, [this](const std::vector& appointments) { + g_message ("got %d appointments in this calendar month", (int)appointments.size()); + }); + } + g_clear_pointer(&begin, g_date_time_unref); + g_clear_pointer(&end, g_date_time_unref); + + // get the upcoming appointments + begin = g_date_time_ref(calendar_date); + end = g_date_time_add_months(begin, 1); + if (begin && end) + { + getAppointments(begin, end, [this](const std::vector& appointments) { + g_message ("got %d upcoming appointments", (int)appointments.size()); + }); + } + g_clear_pointer(&begin, g_date_time_unref); + g_clear_pointer(&end, g_date_time_unref); + g_clear_pointer(&calendar_date, g_date_time_unref); + } + + void getAppointments(GDateTime* begin_dt, GDateTime* end_dt, appointment_func func) + { + const auto begin = g_date_time_to_unix(begin_dt); + const auto end = g_date_time_to_unix(end_dt); + g_message ("getting all appointments from [%s ... %s]", g_date_time_format (begin_dt, "%F %T"), + g_date_time_format (end_dt, "%F %T")); + + /** + *** init the default timezone + **/ + + icaltimezone * default_timezone = nullptr; + + const auto tz = g_date_time_get_timezone_abbreviation (owner_.time.get().get()); + g_message ("%s tz is %s", G_STRLOC, tz); + if (tz && *tz) + { + default_timezone = icaltimezone_get_builtin_timezone (tz); + + if (default_timezone == nullptr) // maybe str is a tzid? + default_timezone = icaltimezone_get_builtin_timezone_from_tzid (tz); + + g_debug ("default_timezone is %p", default_timezone); + } + + /** + *** walk through the sources to build the appointment list + **/ + + std::shared_ptr main_task (new Task(this, func), [](Task* task){ + g_message("time to delete task %p", task); + task->func_(task->appointments_); + }); + + for (auto& source : sources_) + { + auto client = E_CAL_CLIENT (g_object_get_qdata (G_OBJECT(source), source_client_quark())); + if (client == nullptr) + continue; + + if (default_timezone != nullptr) + e_cal_client_set_default_timezone (client, default_timezone); + + // start a new subtask to enumerate all the components in this client. + auto extension = e_source_get_extension (source, E_SOURCE_EXTENSION_CALENDAR); + const auto color = e_source_selectable_get_color (E_SOURCE_SELECTABLE(extension)); + g_message ("calling e_cal_client_generate_instances for %p", client); + e_cal_client_generate_instances (client, + begin, + end, + cancellable_, + my_get_appointments_foreach, + new AppointmentSubtask (main_task, client, color), + [](gpointer g){delete static_cast(g);}); + } + } + + struct UrlSubtask + { + std::shared_ptr task_; + Appointment appointment_; + UrlSubtask (const std::shared_ptr& task, const Appointment& appointment): task_(task), appointment_(appointment) {} + }; + + static gboolean + my_get_appointments_foreach (ECalComponent* component, + time_t begin, + time_t end, + gpointer gsubtask) + { + const auto vtype = e_cal_component_get_vtype(component); + auto subtask = static_cast(gsubtask); + + if ((vtype == E_CAL_COMPONENT_EVENT) || (vtype == E_CAL_COMPONENT_TODO)) + { + const gchar* uid = NULL; + e_cal_component_get_uid (component, &uid); + + auto status = ICAL_STATUS_NONE; + e_cal_component_get_status (component, &status); + + if ((uid != NULL) && + (status != ICAL_STATUS_COMPLETED) && + (status != ICAL_STATUS_CANCELLED)) + { + Appointment appointment; + + /* Determine whether this is a recurring event. + NB: icalrecurrencetype supports complex recurrence patterns; + however, since design only allows daily recurrence, + that's all we support here. */ + GSList * recur_list; + e_cal_component_get_rrule_list (component, &recur_list); + for (auto l=recur_list; l!=NULL; l=l->next) + { + const auto recur = static_cast(l->data); + appointment.is_daily |= ((recur->freq == ICAL_DAILY_RECURRENCE) + && (recur->interval == 1)); + } + e_cal_component_free_recur_list (recur_list); + + ECalComponentText text; + text.value = ""; + e_cal_component_get_summary (component, &text); + + appointment.begin = g_date_time_new_from_unix_local (begin); + appointment.end = g_date_time_new_from_unix_local (end); + appointment.color = subtask->color_; + appointment.is_event = vtype == E_CAL_COMPONENT_EVENT; + appointment.summary = text.value; + appointment.uid = uid; + + GList * alarm_uids = e_cal_component_get_alarm_uids (component); + appointment.has_alarms = alarm_uids != nullptr; + cal_obj_uid_list_free (alarm_uids); + + e_cal_client_get_attachment_uris (subtask->client_, + uid, + NULL, + subtask->task_->impl_->cancellable_, + on_appointment_uris_ready, + new UrlSubtask(subtask->task_, appointment)); + } + } + + return G_SOURCE_CONTINUE; + } + + static void on_appointment_uris_ready (GObject* client, GAsyncResult* res, gpointer gsubtask) + { + auto subtask = static_cast(gsubtask); + + GSList * uris = nullptr; + GError * error = nullptr; + e_cal_client_get_attachment_uris_finish (E_CAL_CLIENT(client), res, &uris, &error); + if (error != NULL) + { + if (!g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED)) + g_warning ("Error getting appointment uris: %s", error->message); + + g_error_free (error); + } + else if (uris != NULL) + { + subtask->appointment_.url = (const char*) uris->data; // copy the first URL + g_debug ("found url '%s' for appointment '%s'", subtask->appointment_.url.c_str(), subtask->appointment_.summary.c_str()); + e_client_util_free_string_slist (uris); + } + + g_message ("adding appointment '%s' '%s'", subtask->appointment_.summary.c_str(), subtask->appointment_.url.c_str()); + subtask->task_->appointments_.push_back (subtask->appointment_); + delete subtask; + } + +private: + + PlannerEds& owner_; + std::set sources_; + GCancellable * cancellable_ = nullptr; + ESourceRegistry * source_registry_ = nullptr; + guint rebuild_tag_ = 0; +}; + +PlannerEds::PlannerEds(): impl_(new Impl(*this)) {} + +PlannerEds::~PlannerEds() =default; + +} // namespace datetime +} // namespace indicator +} // namespace unity diff --git a/tests/test-planner-eds.cc b/tests/test-planner-eds.cc new file mode 100644 index 0000000..986a45e --- /dev/null +++ b/tests/test-planner-eds.cc @@ -0,0 +1,70 @@ +/* + * Copyright 2013 Canonical Ltd. + * + * Authors: + * Charles Kerr + * + * 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 . + */ + +#include "clock-mock.h" +#include "glib-fixture.h" + +#include + +#include + +#include +#include + +using unity::indicator::datetime::Appointment; +using unity::indicator::datetime::DateTime; +using unity::indicator::datetime::PlannerEds; + +/*** +**** +***/ + +class PlannerEdsFixture: public GlibFixture +{ + private: + + typedef GlibFixture super; + + protected: + + virtual void SetUp () + { + super::SetUp (); + } + + virtual void TearDown () + { + super::TearDown (); + } +}; + +/*** +**** +***/ + +TEST_F (PlannerEdsFixture, HelloWorld) +{ + DateTime dt; + dt = g_date_time_new_now_local(); + + PlannerEds planner; + planner.time.set (dt); + g_main_loop_run (loop); +} + diff --git a/tests/test-planner.cc b/tests/test-planner.cc new file mode 100644 index 0000000..8c74366 --- /dev/null +++ b/tests/test-planner.cc @@ -0,0 +1,68 @@ +/* + * Copyright 2013 Canonical Ltd. + * + * Authors: + * Charles Kerr + * + * 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 . + */ + +#include "clock-mock.h" +#include "glib-fixture.h" + +#include +#include + +#include + +#include +#include + +using unity::indicator::datetime::Appointment; + +/*** +**** +***/ + +typedef GlibFixture PlannerFixture; + + +TEST_F (PlannerFixture, HelloWorld) +{ + GDateTime * halloween = g_date_time_new_local (2020, 10, 31, 18, 30, 59); + GDateTime * christmas = g_date_time_new_local (2020, 12, 25, 0, 0, 0); + + Appointment a; + a.summary = "Test"; + a.begin = halloween; + a.end = g_date_time_add_hours (halloween, 1); + const Appointment b = a; + a.summary = "Foo"; + + EXPECT_EQ (a.summary, "Foo"); + EXPECT_EQ (b.summary, "Test"); + EXPECT_EQ (0, g_date_time_compare (a.begin(), b.begin())); + EXPECT_EQ (0, g_date_time_compare (a.end(), b.end())); + + Appointment c; + c.begin = christmas; + c.end = g_date_time_add_hours (christmas, 1); + Appointment d; + d = c; + EXPECT_EQ (0, g_date_time_compare (c.begin(), d.begin())); + EXPECT_EQ (0, g_date_time_compare (c.end(), d.end())); + a = d; + EXPECT_EQ (0, g_date_time_compare (d.begin(), a.begin())); + EXPECT_EQ (0, g_date_time_compare (d.end(), a.end())); +} + -- cgit v1.2.3