Merge lp:~renatofilho/qtorganizer5-eds/fix-1426519 into lp:qtorganizer5-eds

[Renato Araujo Oliveira Filho]

Implemented support for extended details.

Now you can set extended details (X-*, properties) for calendar items.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:76
http://jenkins.qa.ubuntu.com/job/qtorganizer5-eds-ci/197/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/qtorganizer5-eds-vivid-amd64-ci/4
    SUCCESS: http://jenkins.qa.ubuntu.com/job/qtorganizer5-eds-vivid-armhf-ci/4
        deb: http://jenkins.qa.ubuntu.com/job/qtorganizer5-eds-vivid-armhf-ci/4/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/qtorganizer5-eds-vivid-i386-ci/4/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/qtorganizer5-eds-ci/197/rebuild

review: Needs Fixing (continuous-integration)

[Charles Kerr (charlesk)]

Looks good to me. Thanks for the fast work, Renato!

[Charles Kerr (charlesk)]

review: Approve

[lp:~renatofilho/qtorganizer5-eds/fix-1426519]

77. By Renato Araujo Oliveira Filho on 2015-03-30

Fixed wait function to not block glib.
Fixed source creation process to avoid return unready sources.

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2014-09-22 13:18:51 +0000
+++ CMakeLists.txt	2015-03-30 17:59:30 +0000
@@ -9,6 +9,7 @@
 
 find_package(Qt5Core REQUIRED)
 add_definitions(-DQT_NO_KEYWORDS)
+add_definitions(-std=c++11)
 
 pkg_check_modules(GLIB REQUIRED glib-2.0>=2.32)
 pkg_check_modules(GIO REQUIRED gio-2.0>=2.32)
 
=== modified file 'organizer/qorganizer-eds-engine.cpp'
--- organizer/qorganizer-eds-engine.cpp	2015-03-24 17:56:44 +0000
+++ organizer/qorganizer-eds-engine.cpp	2015-03-30 17:59:30 +0000
@@ -61,6 +61,7 @@
 #include <QtOrganizer/QOrganizerEventOccurrence>
 #include <QtOrganizer/QOrganizerTodoOccurrence>
 #include <QtOrganizer/QOrganizerItemParent>
+#include <QtOrganizer/QOrganizerItemExtendedDetail>
 
 #include <glib.h>
 #include <libecal/libecal.h>
@@ -863,7 +864,7 @@
                                          requestData);
     } else {
         requestData->prepareToUpdate();
-        saveCollectionUpdateAsyncStart(requestData);
+        g_idle_add((GSourceFunc) saveCollectionUpdateAsyncStart, requestData);
     }
 }
 
@@ -884,16 +885,16 @@
     } else if (data->isLive()) {
         data->commitSourceCreated();
         data->prepareToUpdate();
-        saveCollectionUpdateAsyncStart(data);
+        g_idle_add((GSourceFunc) saveCollectionUpdateAsyncStart, data);
     }
 }
 
-void QOrganizerEDSEngine::saveCollectionUpdateAsyncStart(SaveCollectionRequestData *data)
+gboolean QOrganizerEDSEngine::saveCollectionUpdateAsyncStart(SaveCollectionRequestData *data)
 {
     // check if request was destroyed by the caller
     if (!data->isLive()) {
         releaseRequestData(data);
-        return;
+        return FALSE;
     }
 
     ESource *source = data->nextSourceToUpdate();
@@ -906,6 +907,7 @@
         data->finish();
         releaseRequestData(data);
     }
+    return FALSE;
 }
 
 void QOrganizerEDSEngine::saveCollectionUpdateAsynCommited(ESource *source,
@@ -926,7 +928,7 @@
     }
 
     if (data->isLive()) {
-        saveCollectionUpdateAsyncStart(data);
+        g_idle_add((GSourceFunc) saveCollectionUpdateAsyncStart, data);
     } else {
         releaseRequestData(data);
     }
@@ -1081,11 +1083,10 @@
 bool QOrganizerEDSEngine::waitForRequestFinished(QOrganizerAbstractRequest* req, int msecs)
 {
     Q_ASSERT(req);
-    Q_UNUSED(msecs);
 
     RequestData *data = m_runningRequests.value(req);
     if (data) {
-        data->wait();
+        data->wait(msecs);
         // We can delete the operation already finished
         data->deleteLater();
     }
@@ -1619,6 +1620,20 @@
     e_cal_component_free_attendee_list(attendeeList);
 }
 
+void QOrganizerEDSEngine::parseExtendedDetails(ECalComponent *comp, QOrganizerItem *item)
+{
+    icalcomponent *icalcomp = e_cal_component_get_icalcomponent(comp);
+    for (icalproperty *prop = icalcomponent_get_first_property(icalcomp, ICAL_X_PROPERTY);
+         prop != NULL;
+         prop = icalcomponent_get_next_property (icalcomp, ICAL_X_PROPERTY)) {
+
+        QOrganizerItemExtendedDetail ex;
+        ex.setName(QString::fromUtf8(icalproperty_get_x_name(prop)));
+        ex.setData(QByteArray(icalproperty_get_x(prop)));
+        item->saveDetail(&ex);
+    }
+}
+
 QOrganizerItem *QOrganizerEDSEngine::parseEvent(ECalComponent *comp)
 {
     QOrganizerItem *event;
@@ -1841,6 +1856,7 @@
         parseTags(comp, item);
         parseReminders(comp, item);
         parseAttendeeList(comp, item);
+        parseExtendedDetails(comp, item);
 
         items << *item;
         delete item;
@@ -2160,6 +2176,25 @@
     e_cal_component_free_attendee_list(attendeeList);
 }
 
+void QOrganizerEDSEngine::parseExtendedDetails(const QOrganizerItem &item, ECalComponent *comp)
+{
+    icalcomponent *icalcomp = e_cal_component_get_icalcomponent(comp);
+    Q_FOREACH(const QOrganizerItemExtendedDetail &ex, item.details(QOrganizerItemDetail::TypeExtendedDetail)) {
+        // We only support QByteArray.
+        // We could use QStream serialization but it will make it impossible to read it from glib side, for example indicators.
+        QByteArray data = ex.data().toByteArray();
+        if (data.isEmpty()) {
+            qWarning() << "Invalid value for property" << ex.name()
+                       <<". EDS only supports QByteArray values for extended properties";
+            continue;
+        }
+
+        icalproperty *xProp = icalproperty_new_x(data.constData());
+        icalproperty_set_x_name(xProp, ex.name().toUtf8().constData());
+        icalcomponent_add_property(icalcomp, xProp);
+    }
+}
+
 bool QOrganizerEDSEngine::hasRecurrence(ECalComponent *comp)
 {
     char *rid = e_cal_component_get_recurid_as_string(comp);
@@ -2433,6 +2468,7 @@
         parseTags(item, comp);
         parseReminders(item, comp);
         parseAttendeeList(item, comp);
+        parseExtendedDetails(item, comp);
 
         if (!item.id().isNull()) {
             e_cal_component_commit_sequence(comp);
 
=== modified file 'organizer/qorganizer-eds-engine.h'
--- organizer/qorganizer-eds-engine.h	2015-03-24 17:56:44 +0000
+++ organizer/qorganizer-eds-engine.h	2015-03-30 17:59:30 +0000
@@ -168,6 +168,7 @@
     static void parseProgress(const QtOrganizer::QOrganizerItem &item, ECalComponent *comp);
     static void parseStatus(const QtOrganizer::QOrganizerItem &item, ECalComponent *comp);
     static void parseAttendeeList(const QtOrganizer::QOrganizerItem &item, ECalComponent *comp);
+    static void parseExtendedDetails(const QtOrganizer::QOrganizerItem &item, ECalComponent *comp);
 
     // ECalComponent -> QOrganizerItem
     static bool hasRecurrence(ECalComponent *comp);
@@ -193,6 +194,7 @@
     static void parseProgress(ECalComponent *comp, QtOrganizer::QOrganizerItem *item);
     static void parseStatus(ECalComponent *comp, QtOrganizer::QOrganizerItem *item);
     static void parseAttendeeList(ECalComponent *comp, QtOrganizer::QOrganizerItem *item);
+    static void parseExtendedDetails(ECalComponent *comp, QtOrganizer::QOrganizerItem *item);
 
     static QDateTime fromIcalTime(struct icaltimetype value, const char *tzId);
     static icaltimetype fromQDateTime(const QDateTime &dateTime, bool allDay, QByteArray *tzId);
@@ -234,7 +236,7 @@
     static void removeItemsAsyncStart(RemoveRequestData *data);
 
     void saveCollectionAsync(QtOrganizer::QOrganizerCollectionSaveRequest *req);
-    static void saveCollectionUpdateAsyncStart(SaveCollectionRequestData *data);
+    static gboolean saveCollectionUpdateAsyncStart(SaveCollectionRequestData *data);
     static void saveCollectionAsyncCommited(ESourceRegistry *registry, GAsyncResult *res, SaveCollectionRequestData *data);
     static void saveCollectionUpdateAsynCommited(ESource *source, GAsyncResult *res, SaveCollectionRequestData *data);
 
 
=== modified file 'organizer/qorganizer-eds-requestdata.cpp'
--- organizer/qorganizer-eds-requestdata.cpp	2015-03-06 22:47:19 +0000
+++ organizer/qorganizer-eds-requestdata.cpp	2015-03-30 17:59:30 +0000
@@ -19,7 +19,7 @@
 #include "qorganizer-eds-requestdata.h"
 
 #include <QtCore/QDebug>
-#include <QtCore/QCoreApplication>
+#include <QtCore/QTimer>
 
 #include <QtOrganizer/QOrganizerAbstractRequest>
 #include <QtOrganizer/QOrganizerManagerEngine>
@@ -81,12 +81,24 @@
     }
 }
 
-void RequestData::wait()
+void RequestData::wait(int msec)
 {
     QMutexLocker locker(&m_waiting);
-    while(!m_finished) {
-        QCoreApplication::processEvents(QEventLoop::AllEvents, 100);
+    QEventLoop *loop = new QEventLoop;
+    QOrganizerAbstractRequest *req = m_req.data();
+    QObject::connect(req, &QOrganizerAbstractRequest::stateChanged, [req, loop](QOrganizerAbstractRequest::State newState) {
+        if (newState != QOrganizerAbstractRequest::ActiveState) {
+            loop->quit();
+        }
+    });
+    QTimer timeout;
+    if (msec > 0) {
+        timeout.setInterval(msec);
+        timeout.setSingleShot(true);
+        timeout.start();
     }
+    loop->exec(QEventLoop::AllEvents|QEventLoop::WaitForMoreEvents);
+    delete loop;
 }
 
 bool RequestData::isWaiting()
 
=== modified file 'organizer/qorganizer-eds-requestdata.h'
--- organizer/qorganizer-eds-requestdata.h	2015-03-06 22:47:19 +0000
+++ organizer/qorganizer-eds-requestdata.h	2015-03-30 17:59:30 +0000
@@ -42,7 +42,7 @@
     virtual void cancel();
     void deleteLater();
     virtual void finish(QtOrganizer::QOrganizerManager::Error error, QtOrganizer::QOrganizerAbstractRequest::State state) = 0;
-    void wait();
+    void wait(int msec = 0);
     bool isWaiting();
 
     template<class T>
 
=== modified file 'tests/unittest/CMakeLists.txt'
--- tests/unittest/CMakeLists.txt	2015-03-24 17:56:44 +0000
+++ tests/unittest/CMakeLists.txt	2015-03-30 17:59:30 +0000
@@ -38,7 +38,6 @@
 )
 
 add_definitions(-DTEST_SUITE)
-add_definitions(-std=c++11)
 
 declare_test(itemid-test)
 declare_test(parseecal-test)
 
=== modified file 'tests/unittest/event-test.cpp'
--- tests/unittest/event-test.cpp	2014-10-29 14:19:47 +0000
+++ tests/unittest/event-test.cpp	2015-03-30 17:59:30 +0000
@@ -806,7 +806,6 @@
         QList<QOrganizerItemId> ids;
         QOrganizerItemFetchHint hint;
         ids << items[0].id();
-        qDebug() << "Find for id" << ids;
         QList<QOrganizerItem> newItems = m_engine->items(ids, hint, &errorMap, &error);
         QCOMPARE(newItems.size(), 1);
 
@@ -819,6 +818,65 @@
         QCOMPARE(newAttendee.participationRole(), attendee.participationRole());
         QCOMPARE(newAttendee.participationStatus(), attendee.participationStatus());
     }
+
+    void testExtendedProperties()
+    {
+        static QString displayLabelValue = QStringLiteral("event with collection attendee");
+        static QString descriptionValue = QStringLiteral("event without collection");
+        QOrganizerItemId itemId;
+        QDateTime currentTime = QDateTime::currentDateTime();
+
+        {
+            // create a item with X-URL
+            QOrganizerEvent event;
+            event.setStartDateTime(currentTime);
+            event.setEndDateTime(currentTime.addSecs(60 * 30));
+            event.setDisplayLabel(displayLabelValue);
+            event.setDescription(descriptionValue);
+
+            QOrganizerItemExtendedDetail ex;
+            ex.setName(QStringLiteral("X-URL"));
+            ex.setData(QByteArray("http://canonical.com"));
+            event.saveDetail(&ex);
+
+            // save the new item
+            QtOrganizer::QOrganizerManager::Error error;
+            QMap<int, QtOrganizer::QOrganizerManager::Error> errorMap;
+            QList<QOrganizerItem> items;
+            QSignalSpy createdItem(m_engine, SIGNAL(itemsAdded(QList<QOrganizerItemId>)));
+            items << event;
+            bool saveResult = m_engine->saveItems(&items,
+                                                  QList<QtOrganizer::QOrganizerItemDetail::DetailType>(),
+                                                  &errorMap,
+                                                  &error);
+            QTRY_COMPARE(createdItem.count(), 1);
+            QVERIFY(saveResult);
+            QCOMPARE(error, QOrganizerManager::NoError);
+            QCOMPARE(items.size(), 1);
+            QVERIFY(errorMap.isEmpty());
+            QVERIFY(!items[0].id().isNull());
+            QCOMPARE(items[0].details(QOrganizerItemDetail::TypeExtendedDetail).size(), 1);
+            itemId = items[0].id();
+        }
+
+        // fetch for the item
+        {
+            QtOrganizer::QOrganizerManager::Error error;
+            QMap<int, QtOrganizer::QOrganizerManager::Error> errorMap;
+            QList<QOrganizerItemId> ids;
+            QOrganizerItemFetchHint hint;
+            ids << itemId;
+            QList<QOrganizerItem> items = m_engine->items(ids, hint, &errorMap, &error);
+            QCOMPARE(items.size(), 1);
+
+            QList<QOrganizerItemDetail> exs = items[0].details(QOrganizerItemDetail::TypeExtendedDetail);
+            QCOMPARE(exs.size(), 1);
+            QCOMPARE(exs[0].value(QOrganizerItemExtendedDetail::FieldName).toString(),
+                    QStringLiteral("X-URL"));
+            QCOMPARE(exs[0].value(QOrganizerItemExtendedDetail::FieldData).toByteArray(),
+                    QByteArray("http://canonical.com"));
+        }
+    }
 };
 
 const QString EventTest::collectionTypePropertyName = QStringLiteral("collection-type");
 
=== modified file 'tests/unittest/run-eds-test.sh'
--- tests/unittest/run-eds-test.sh	2014-10-28 20:54:11 +0000
+++ tests/unittest/run-eds-test.sh	2015-03-30 17:59:30 +0000
@@ -12,7 +12,7 @@
 export QT_QPA_PLATFORM=minimal
 export HOME=$TEST_TMP_DIR
 export XDG_RUNTIME_DIR=$TEST_TMP_DIR
-export XDG_CACHE_HOME=$TEST_TMP_DIR}/.cache
+export XDG_CACHE_HOME=$TEST_TMP_DIR/.cache
 export XDG_CONFIG_HOME=$TEST_TMP_DIR/.config
 export XDG_DATA_HOME=$TEST_TMP_DIR/.local/share
 export XDG_DESKTOP_DIR=$TEST_TMP_DIR