Merge lp:~thomas-voss/location-service/enable-kml-reporting into lp:location-service

[Thomas Voß]

Add reporting in KML format to locationd.monitor.

Add reporting in KML format to locationd.monitor.

[lp:~thomas-voss/location-service/enable-kml-reporting]

309. By Thomas Voß on 2017-05-10

Add boost-locale build dep.

[Simon Fels (morphis)]

LGTM

review: Approve

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2017-03-07 10:28:49 +0000
+++ CMakeLists.txt	2017-05-10 14:36:23 +0000
@@ -52,7 +52,7 @@
 include(GNUInstallDirs)
 
 find_package(PkgConfig)
-find_package(Boost COMPONENTS filesystem system program_options)
+find_package(Boost COMPONENTS filesystem locale system program_options)
 find_package(GLog)
 find_package(GFlags)
 find_package(Threads)

=== modified file 'debian/control'
--- debian/control	2017-03-30 12:47:19 +0000
+++ debian/control	2017-05-10 14:36:23 +0000
@@ -19,6 +19,7 @@
                graphviz,
                libapparmor-dev,
                libboost-filesystem-dev,
+               libboost-locale-dev,
                libboost-program-options-dev,
                libboost-system-dev,
                libdbus-1-dev,

=== modified file 'snapcraft.yaml'
--- snapcraft.yaml	2017-03-30 12:47:19 +0000
+++ snapcraft.yaml	2017-05-10 14:36:23 +0000
@@ -65,6 +65,7 @@
       - g++
       - libapparmor-dev
       - libboost-filesystem-dev
+      - libboost-locale-dev
       - libboost-program-options-dev
       - libboost-system-dev
       - libc6-dev

=== modified file 'src/location/cmds/monitor.cpp'
--- src/location/cmds/monitor.cpp	2017-05-05 09:37:12 +0000
+++ src/location/cmds/monitor.cpp	2017-05-10 14:36:23 +0000
@@ -25,33 +25,36 @@
 #include <location/glib/runtime.h>
 #include <location/runtime.h>
 
+#include <boost/locale.hpp>
+
+#include <iostream>
 #include <type_traits>
 
 namespace cli = location::util::cli;
 
-location::cmds::Monitor::PrintingDelegate::PrintingDelegate(std::ostream& out) : out{out}
+location::cmds::Monitor::TableOutputDelegate::TableOutputDelegate(std::ostream& out) : out{out}
 {
 }
 
-void location::cmds::Monitor::PrintingDelegate::on_new_position(const Update<Position>& pos)
+void location::cmds::Monitor::TableOutputDelegate::on_new_position(const Update<Position>& pos)
 {
     last_position_update = pos;
     print_row();
 }
 
-void location::cmds::Monitor::PrintingDelegate::on_new_heading(const Update<units::Degrees>& heading)
+void location::cmds::Monitor::TableOutputDelegate::on_new_heading(const Update<units::Degrees>& heading)
 {
     last_heading_update = heading;
     print_row();
 }
 
-void location::cmds::Monitor::PrintingDelegate::on_new_velocity(const Update<units::MetersPerSecond>& velocity)
+void location::cmds::Monitor::TableOutputDelegate::on_new_velocity(const Update<units::MetersPerSecond>& velocity)
 {
     last_velocity_update = velocity;
     print_row();
 }
 
-void location::cmds::Monitor::PrintingDelegate::print_header()
+void location::cmds::Monitor::TableOutputDelegate::print_header()
 {
     out << std::left << std::setw(15) << std::setfill(' ') << "lat.[deg]"
         << std::left << std::setw(15) << std::setfill(' ') << "lon.[deg]"
@@ -62,7 +65,7 @@
         << std::left << std::setw(15) << std::setfill(' ') << "vel.[m/s]" << std::endl;
 }
 
-void location::cmds::Monitor::PrintingDelegate::print_row()
+void location::cmds::Monitor::TableOutputDelegate::print_row()
 {
     if (last_position_update)
     {
@@ -115,17 +118,73 @@
 
 }
 
+location::cmds::Monitor::KmlOutputDelegate::KmlOutputDelegate(std::ostream& out) : out{out}
+{
+    // We have to imbue the right locale to make sure that formatting
+    // of floating point numbers is correct.
+    out.imbue(std::locale("C"));
+
+    out << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>"
+        << "<kml xmlns=\"http://www.opengis.net/kml/2.2\">"
+        << "<Folder><open>1</open><name>Recorded positions</name>";
+}
+
+location::cmds::Monitor::KmlOutputDelegate::~KmlOutputDelegate()
+{
+    out << "</Folder></kml>";
+}
+
+void location::cmds::Monitor::KmlOutputDelegate::on_new_position(const Update<Position>& pos)
+{
+    static constexpr const char* placemark_pattern
+    {
+        "<Placemark><name>{1}</name><Point><coordinates>{2},{3},{4}</coordinates></Point></Placemark>"
+    };
+
+    out << boost::locale::format(placemark_pattern)
+           % pos.when.time_since_epoch().count()
+           % pos.value.longitude().value()
+           % pos.value.latitude().value()
+           % (pos.value.altitude() ? pos.value.altitude()->value() : 0.);
+}
+
+void location::cmds::Monitor::KmlOutputDelegate::on_new_heading(const Update<units::Degrees>&)
+{
+    // Empty on purpose.
+}
+
+void location::cmds::Monitor::KmlOutputDelegate::on_new_velocity(const Update<units::MetersPerSecond>&)
+{
+    // Empty on purpose.
+}
+
 location::cmds::Monitor::Monitor(const std::shared_ptr<Delegate>& delegate)
     : CommandWithFlagsAndAction{cli::Name{"monitor"}, cli::Usage{"monitor"}, cli::Description{"monitors the daemon"}},
       delegate{delegate},
-      bus{dbus::Bus::system}
+      bus{dbus::Bus::system},
+      output_format{OutputFormat::table}
 {
     flag(cli::make_flag(cli::Name{"bus"}, cli::Description{"bus instance to connect to, defaults to system"}, bus));
+    flag(cli::make_flag(cli::Name{"output-format"}, cli::Description{"output format in {table, kml}"}, output_format));
+
     action([this](const Context& ctxt)
     {
         glib::Runtime runtime{glib::Runtime::WithOwnMainLoop{}};
         runtime.redirect_logging();
 
+        if (!Monitor::delegate)
+        {
+            switch (output_format)
+            {
+            case OutputFormat::table:
+                Monitor::delegate = std::make_shared<TableOutputDelegate>();
+                break;
+            case OutputFormat::kml:
+                Monitor::delegate = std::make_shared<KmlOutputDelegate>();
+                break;
+            }
+        }
+
         location::dbus::stub::Service::create(bus, [this, &ctxt](const Result<location::dbus::stub::Service::Ptr>& result) mutable
         {
             if (!result)
@@ -171,3 +230,15 @@
         return runtime.run();
     });
 }
+
+std::istream& location::cmds::operator>>(std::istream& in, location::cmds::Monitor::OutputFormat& format)
+{
+    std::string s; in >> s;
+
+    if (s == "kml")
+        format = location::cmds::Monitor::OutputFormat::kml;
+    if (s == "table")
+        format = location::cmds::Monitor::OutputFormat::table;
+
+    return in;
+}

=== modified file 'src/location/cmds/monitor.h'
--- src/location/cmds/monitor.h	2017-05-05 09:37:12 +0000
+++ src/location/cmds/monitor.h	2017-05-10 14:36:23 +0000
@@ -38,6 +38,13 @@
 class LOCATION_DLL_PUBLIC Monitor : public util::cli::CommandWithFlagsAndAction
 {
 public:
+    // Format enumerates all known output formats.
+    enum class OutputFormat
+    {
+        table, // Prints a table of values.
+        kml      // Prints incoming updates as kml.
+    };
+
     // Delegate abstracts handling of incoming updates.
     class Delegate : public util::DoNotCopyOrMove
     {
@@ -51,11 +58,11 @@
     };
 
     // PrintingDelegate implements Delegate, printing updates to the given output stream.
-    class PrintingDelegate : public Delegate
+    class TableOutputDelegate : public Delegate
     {
     public:
         // PrintingDelegate initializes a new instance with out.
-        PrintingDelegate(std::ostream& out = std::cout);
+        TableOutputDelegate(std::ostream& out = std::cout);
 
         // From Delegate
         void on_new_position(const Update<Position>& pos) override;
@@ -72,14 +79,38 @@
         Optional<Update<units::MetersPerSecond>> last_velocity_update;
     };
 
+    class KmlOutputDelegate : public Delegate
+    {
+    public:
+        // KmlDelegate initializes a new instance with out.
+        KmlOutputDelegate(std::ostream& out = std::cout);
+        ~KmlOutputDelegate();
+
+        // From Delegate
+        void on_new_position(const Update<Position>& pos) override;
+        void on_new_heading(const Update<units::Degrees>& heading) override;
+        void on_new_velocity(const Update<units::MetersPerSecond>& velocity) override;
+
+    private:
+        std::ostream& out;
+        Optional<Update<Position>> last_position_update;
+        Optional<Update<units::Degrees>> last_heading_update;
+        Optional<Update<units::MetersPerSecond>> last_velocity_update;
+    };
+
     // Monitor initializes a new instance.
-    Monitor(const std::shared_ptr<Delegate>& delegate = std::make_shared<PrintingDelegate>());
+    Monitor(const std::shared_ptr<Delegate>& delegate = std::shared_ptr<Delegate>{});
 
 private:
     std::shared_ptr<Delegate> delegate; // All updates are forwarded to a delegate.
     dbus::Bus bus;                      // The bus we should connect to.
+    OutputFormat output_format;                // The output format.
 };
-}
-}
+
+// operator>> parses format from in.
+std::istream& operator>>(std::istream& in, Monitor::OutputFormat& format);
+
+}  // namespace cmds
+}  // namespace location
 
 #endif // LOCATION_CMDS_MONITOR_H_