Merge lp:~knitzsche/day-scope/bugfix-1543793-english-moon-phase-names into lp:day-scope

[Kyle Nitzsche]

lunar phase names are returned from the web api without the expected space in them. So for example we get "fullmoon". Translators have been adding the space. This MR fixes the string after the translation has been retrieved if the string is unchanged: that is, if it is still in English, "fullmoon" becomes "Full moon" (and the same for all eight moon phases).

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2016-01-26 07:06:29 +0000
+++ CMakeLists.txt	2016-02-09 21:55:26 +0000
@@ -1,4 +1,4 @@
-set(VERSION "1.2.2")
+set(VERSION "1.3.1")
 
 # Supress qDebug() output
 ADD_DEFINITIONS( -DQT_NO_DEBUG_OUTPUT )
@@ -66,7 +66,7 @@
 include(GNUInstallDirs)
 
 include(FindPkgConfig)
-pkg_check_modules(UNITY_SCOPES libunity-scopes>=0.4.0 REQUIRED)
+pkg_check_modules(UNITY_SCOPES libunity-scopes>=0.6.0 REQUIRED)
 
 include_directories(
   "${CMAKE_SOURCE_DIR}/include"

=== modified file 'include/query.h'
--- include/query.h	2015-08-06 06:01:34 +0000
+++ include/query.h	2016-02-09 21:55:26 +0000
@@ -49,7 +49,7 @@
     QCoreApplication *app;
     QNetworkAccessManager manager;
     QEventLoop loop;
-    QMap<QString,QString> getSuns();
+    QMap<QString,QString> getSuns(QFile &, QFile &);
     QString cacheDir_;
     QString mUserAgent;
     QString getLunarPhase(QFile &, QFile &);
@@ -72,14 +72,22 @@
 
     QFile lunarData_f;
     QString lunarData_filename;
+    QFile sunData_f;
+    QString sunData_filename;
     QFile lunarLastRefresh_f;
     QString lunarLastRefresh_filename;
+    QFile sunsLastRefresh_f;
+    QString sunsLastRefresh_filename;
     QString phase;
-    bool useNetwork(QFile &, QFile &);
+    QMap<QString,QString> suns;
+    bool useNetworkLunar(QFile &, QFile &);
+    bool useNetworkSuns(QFile &, QFile &);
     QString formatToday();
     QString parseLunarPhase(QJsonDocument &);
-    void getFromNetwork(QFile &, QFile &);
-    void getFromLocal(QFile &, QFile &);
+    void getLunarFromNetwork(QFile &, QFile &);
+    void getLunarFromLocal(QFile &, QFile &);
+    void getSunsFromNetwork(QFile &, QFile &);
+    void getSunsFromLocal(QFile &, QFile &);
 };
 
 #endif

=== modified file 'src/CMakeLists.txt'
--- src/CMakeLists.txt	2015-03-30 16:16:43 +0000
+++ src/CMakeLists.txt	2016-02-09 21:55:26 +0000
@@ -1,3 +1,9 @@
+add_library(${SO_NAME} SHARED
+    preview.cpp
+    query.cpp
+    scope.cpp
+)
+
 add_definitions(
   -DGETTEXT_PACKAGE=\"${PROJECT_NAME}\"
   -DGETTEXT_LOCALEDIR=\"${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LOCALEDIR}\"
@@ -5,12 +11,6 @@
 
 include_directories(${UNITY_SCOPES_INCLUDE_DIRS})
 
-add_library(${SO_NAME} SHARED
-    preview.cpp
-    query.cpp
-    scope.cpp
-)
-
 find_package(Qt5Core REQUIRED)
 find_package(Qt5Network REQUIRED)
 qt5_use_modules(${SO_NAME} Core Network)

=== modified file 'src/query.cpp'
--- src/query.cpp	2015-09-11 06:24:31 +0000
+++ src/query.cpp	2016-02-09 21:55:26 +0000
@@ -84,11 +84,14 @@
     scope_(scope),
     cacheDir_(cacheDir_)
 {
-    qDebug() << "==== cacheDir_ = " << cacheDir_;
     lunarData_filename = QString("%1/LunarData.json").arg(cacheDir_);
     lunarData_f.setFileName(lunarData_filename);
+    sunData_filename = QString("%1/SunData.json").arg(cacheDir_);
+    sunData_f.setFileName(sunData_filename);
     lunarLastRefresh_filename = QString("%1/LastRefresh.txt").arg(cacheDir_);
     lunarLastRefresh_f.setFileName(lunarLastRefresh_filename);
+    sunsLastRefresh_filename = QString("%1/SunLastRefresh.txt").arg(cacheDir_);
+    sunsLastRefresh_f.setFileName(sunsLastRefresh_filename);
 }
 
 Query::~Query()
@@ -103,22 +106,74 @@
     return QString("<strong>%1</strong>").arg(str);
 }
 
-bool Query::useNetwork(QFile &data, QFile &lastRefresh)
-{
-    qDebug() << "==== useNetwork()";
-    data.close();
-    if (!data.open(QIODevice::ReadOnly))
-    {
-        qWarning() << "===== The JSON file missing!";
-        data.close();
-        data.remove();
-        return true;
-    }
-
-    lastRefresh.close();
-    if (!lastRefresh.open(QIODevice::ReadOnly))
-    {
-        qWarning() << "===== The TXT file missing!";
+
+bool Query::useNetworkSuns(QFile &data, QFile &lastRefresh)
+{
+
+    if (!search_metadata().has_location() || !search_metadata().internet_connectivity() == us::QueryMetadata::Connected)
+	return false;
+
+    qDebug() << "==== useNetworkSuns()";
+    data.close();
+    if (!data.open(QIODevice::ReadOnly))
+    {
+        qWarning() << "===== The suns data JSON file missing";
+        data.close();
+        data.remove();
+        return true;
+    }
+    lastRefresh.close();
+    if (!lastRefresh.open(QIODevice::ReadOnly))
+    {
+        qWarning() << "===== The suns last refresh cache file missing.";
+        lastRefresh.remove();
+        return true;
+    }
+    else
+    {
+        QDate today = QDate::currentDate();
+        QByteArray cachedDate_ba = lastRefresh.readAll();
+        lastRefresh.close();
+        QString cachedDate_qstr = QString(cachedDate_ba);
+        QDate cachedDate = QDate::fromString(cachedDate_qstr.trimmed(), "yyyy-MM-dd");
+        if (!cachedDate.isValid())
+        {
+            qWarning() << "===== Timestamp in last refresh sun data file is invalid!";
+            lastRefresh.remove();
+            return true;
+        }
+        if (cachedDate != today)
+        {
+            qDebug() << "==== Suns cache date not today, so use network.";
+            lastRefresh.remove();
+            data.remove();
+            return true;
+        }
+    }
+    return false;
+}
+
+bool Query::useNetworkLunar(QFile &data, QFile &lastRefresh)
+{
+    qDebug() << "==== useNetworkLunar()";
+
+
+    if (!search_metadata().has_location() || !search_metadata().internet_connectivity() == us::QueryMetadata::Connected)
+        return false;
+
+    data.close();
+    if (!data.open(QIODevice::ReadOnly))
+    {
+        qWarning() << "===== The lunar data JSON file cannot be read";
+        data.close();
+        data.remove();
+        return true;
+    }
+
+    lastRefresh.close();
+    if (!lastRefresh.open(QIODevice::ReadOnly))
+    {
+        qWarning() << "===== The lunar last refresh cannot be read.";
         lastRefresh.remove();
         return true;
     }
@@ -133,13 +188,13 @@
         QDate rDate_da = QDate::fromString(rDate_qstr.trimmed(), "yyyy-MM-dd");
         if (!rDate_da.isValid())
         {
-            qWarning() << "===== Time stamp is invalid!";
+            qWarning() << "===== The lunar timestamp is invalid!";
             lastRefresh.remove();
             return true;
         }
         if ((rDate_da == oneMonthAgo) || (rDate_da < oneMonthAgo))
         {
-            qDebug() << "==== An overdue using of caching result.";
+            qDebug() << "==== Lunar timestamp indicates we need to refresh cache from web.";
             lastRefresh.remove();
             data.remove();
             return true;
@@ -150,19 +205,39 @@
     return false;
 }
 
-void Query::getFromNetwork(QFile &data, QFile &lastRefresh)
-{
-    qDebug() << "==== getFromNetwork()";
+void Query::getSunsFromNetwork(QFile &sunData, QFile &lastRefresh)
+{
+    if (search_metadata().has_location() && search_metadata().internet_connectivity() == us::QueryMetadata::Connected)
+    {
+        qDebug() << "==== getSunsFromNetwork()";
+        if (!haveSignature)
+        {
+            makeSignature();
+        }
+    suns = getSuns(sunData, lastRefresh);
+    }
+    else
+    {
+        qDebug() << "==== DAY. no location";
+        suns["sunrise"] = QString::fromStdString(_("No Information"));
+        suns["sunset"] = QString::fromStdString(_("No Information"));
+    }
+}
+
+
+void Query::getLunarFromNetwork(QFile &lunarData, QFile &lastRefresh)
+{
+    qDebug() << "==== getLunarFromNetwork()";
     if (!haveSignature)
     {
         makeSignature();
     }
-    phase = getLunarPhase(data, lastRefresh);
+    phase = getLunarPhase(lunarData, lastRefresh);
 }
 
-void Query::getFromLocal(QFile &data, QFile &lastRefresh)
+void Query::getLunarFromLocal(QFile &data, QFile &lastRefresh)
 {
-    qDebug() << "==== getFromLocal()";
+    qDebug() << "==== getLunarFromLocal()";
     data.close();
     if (data.open(QIODevice::ReadOnly))
     {
@@ -183,21 +258,56 @@
                 phase = parseLunarPhase(doc);
                 if (phase.isEmpty())
                 {
-                    qWarning() << "!!!!! Weird case, need to check local cache file.";
-                    qWarning() << "===== Request moon phase from network.";
-                    getFromNetwork(data, lastRefresh);
+                    qWarning() << "===== Lunar cache file invalid. Request moon phase from network.";
+                    getLunarFromNetwork(data, lastRefresh);
                 }
             }
             else
             {
-                getFromNetwork(data, lastRefresh);
+                getLunarFromNetwork(data, lastRefresh);
                 return;
             }
         }
     }
     else
     {
-        getFromNetwork(data, lastRefresh);
+        getLunarFromNetwork(data, lastRefresh);
+    }
+}
+
+void Query::getSunsFromLocal(QFile &data, QFile &lastRefresh)
+{
+    qDebug() << "==== getSunsFromLocal()";
+    data.close();
+    if (data.open(QIODevice::ReadOnly))
+    {
+        QByteArray ba = data.readAll();
+        QJsonParseError err;
+        QJsonDocument doc = QJsonDocument::fromJson(ba, &err);
+
+        if (err.error != QJsonParseError::NoError)
+        {
+            qWarning() << "Cannot parse sunset/rise info from cache file: " << err.errorString();
+            data.remove();
+        }
+        else
+        {
+            QJsonObject obj = doc.object();
+            if (obj.contains("sunrise") && obj.contains("sunset"))
+            {
+                QString sunr = obj["sunrise"].toString();
+                suns["sunrise"] = sunr.split(" ")[1];
+                QString sunset = obj["sunset"].toString();
+                suns["sunset"] = sunset.split(" ")[1];
+            } else {
+                qWarning()<<"Day scope. cached suns file cannot be parsed. Deleting it.";
+                lastRefresh.remove();
+            }
+        }
+    }
+    else
+    {
+        getLunarFromNetwork(data, lastRefresh);
     }
 }
 
@@ -221,16 +331,23 @@
     }
     catch (unity::Exception const &e)
     {
-        qWarning() << "Location object not found: " << QString::fromStdString(e.what());
+        qWarning() << "Location object not found and exception is caught: " << QString::fromStdString(e.what());
     }
 
-    if (useNetwork(lunarData_f, lunarLastRefresh_f))
-    {
-        getFromNetwork(lunarData_f, lunarLastRefresh_f);
+    if (useNetworkSuns(sunData_f, sunsLastRefresh_f))
+    {
+	getSunsFromNetwork(sunData_f, sunsLastRefresh_f);
+    } else {
+	getSunsFromLocal(sunData_f, sunsLastRefresh_f);
+   }
+
+    if (useNetworkLunar(lunarData_f, lunarLastRefresh_f))
+    {
+        getLunarFromNetwork(lunarData_f, lunarLastRefresh_f);
     }
     else
     {
-        getFromLocal(lunarData_f, lunarLastRefresh_f);
+        getLunarFromLocal(lunarData_f, lunarLastRefresh_f);
     }
 
     if (QString::fromStdString(phase.toStdString()).isEmpty())
@@ -240,6 +357,23 @@
     else
     {
         phase = _(phase.toStdString().c_str());
+        //correct english. Note that current translations provide corrections 
+        if (phase == "waningcrescent") 
+            phase = "Waning crescent";
+        else if (phase == "thirdquarter") 
+            phase = "Third quarter";
+        else if (phase == "waninggibbous")
+            phase = "Waning gibbous";
+        else if (phase == "fullmoon" )
+            phase = "Full moon";
+        else if (phase == "waxinggibbous")
+            phase = "Waxing gibbous";
+        else if (phase == "firstquarter")
+            phase = "First quarter";
+        else if (phase == "waxingcrescent")
+            phase = "Waxing crescent";
+        else if (phase == "newmoon")
+            phase = "New moon";
     }
 
     // Initial date info
@@ -261,7 +395,6 @@
     string icon_path =
         QString("%1/images/calendar-app_day-%2.png").arg(QString::fromStdString(scope_.scope_directory())).arg(today.toString("dd")).toStdString();
     date_res.set_art(icon_path);
-    qDebug() << "====DAY: getSuns. ICON PATH:" << QString::fromStdString(icon_path);
 
     us::VariantBuilder builder;
     builder.add_tuple({
@@ -278,9 +411,8 @@
 
     if (search_metadata().has_location() && search_metadata().internet_connectivity() == us::QueryMetadata::Connected)
     {
-        qDebug() << "==== DAY. has location";
+        qDebug() << "==== we have location && network";
         us::Location loc = search_metadata().location();
-        QMap<QString,QString> suns = getSuns();
         if (suns.size() >= 2) {
             sunrise_time = suns["sunrise"];
             sunset_time = suns["sunset"];
@@ -321,9 +453,13 @@
 
 }
 
-QMap<QString,QString> Query::getSuns() {
+QMap<QString,QString> Query::getSuns(QFile &cache_f, QFile &lastRefresh) {
     qDebug() << "=== DAY getSuns()";
     qDebug() << "=== DAY lat long before suns: " << lat << " " << lng;
+
+    cache_f.remove();
+    lastRefresh.remove();
+
     QString lat_ = lat;
     QString lng_ = lng;
     if (lat_.startsWith("-"))
@@ -348,7 +484,7 @@
     QEventLoop loop;
 
     QObject::connect(&manager, SIGNAL(finished(QNetworkReply*)), &loop, SLOT(quit()));
-    QObject::connect(&manager, &QNetworkAccessManager::finished,[&suns, this](QNetworkReply *msg) {
+    QObject::connect(&manager, &QNetworkAccessManager::finished,[&lastRefresh, &cache_f, &suns, this](QNetworkReply *msg) {
 
         QByteArray data = msg->readAll();
         QJsonParseError err;
@@ -356,6 +492,18 @@
         if (err.error != QJsonParseError::NoError)
             qCritical() << "Failed to parse server data: " << err.errorString();
 
+	if (cache_f.open(QIODevice::ReadWrite | QIODevice::Truncate | QIODevice::Text))
+	{
+            cache_f.write(doc.toJson());
+            cache_f.close();
+            QDate today = QDate::currentDate();
+            QString today_qstr = today.toString("yyyy-MM-dd");
+            if (lastRefresh.open(QIODevice::ReadWrite | QIODevice::Truncate))
+            {
+                lastRefresh.write(today_qstr.toUtf8());
+                lastRefresh.close();
+            }
+	}
         QJsonObject obj = doc.object();
         QString sunr = obj["sunrise"].toString();
         suns["sunrise"] = sunr.split(" ")[1];