Merge lp:~unity-team/unity-scopes-api/staging-rtm into lp:unity-scopes-api/rtm-14.09

[Marcus Tomlinson]

Merge staging (Fixes bugs 1361221, 1376416, 1378805)

[Michi Henning (michihenning)]

Looks right to me, thanks!

review: Approve

[lp:~unity-team/unity-scopes-api/staging-rtm]

264. By Paweł Stołowski on 2014-12-02

Updated changelog.

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2014-10-09 06:01:15 +0000
+++ CMakeLists.txt	2014-12-02 13:46:56 +0000
@@ -195,7 +195,7 @@
 # API version
 set(UNITY_SCOPES_MAJOR 0)
 set(UNITY_SCOPES_MINOR 6)
-set(UNITY_SCOPES_MICRO 7)
+set(UNITY_SCOPES_MICRO 8)
 set(UNITY_SCOPES_SOVERSION 3)
 
 # Version for testing, with all symbols visible

=== modified file 'CONFIGFILES'
--- CONFIGFILES	2014-08-15 09:28:56 +0000
+++ CONFIGFILES	2014-12-02 13:46:56 +0000
@@ -102,7 +102,8 @@
   Note that the actual files are written into subdirectories of
   this directory, for example:
 
-  $HOME/.local/share/unity-scopes/<scope_id>/cache.db
+  $HOME/.local/share/unity-scopes/leaf-net/<scope_id>/some_file (for confined scopes)
+  and $HOME/.local/share/unity-scopes/unconfined/<scope_id>/some_file (for unconfined scopes).
 
 - ConfigDir
 

=== modified file 'RELEASE_NOTES.md'
--- RELEASE_NOTES.md	2014-10-10 17:07:01 +0000
+++ RELEASE_NOTES.md	2014-12-02 13:46:56 +0000
@@ -1,6 +1,10 @@
 Release notes
 =============
 
+Changes in version 0.6.8
+========================
+  - Replaced dbus-send with "list updated" pub/sub to invalidate smart scopes.
+
 Changes in version 0.6.7
 ========================
   - OnlineAccountClient fixes: run the internal event loop within its own context to avoid

=== modified file 'debian/changelog'
--- debian/changelog	2014-11-07 20:23:45 +0000
+++ debian/changelog	2014-12-02 13:46:56 +0000
@@ -1,3 +1,12 @@
+unity-scopes-api (0.6.8-0ubuntu1) UNRELEASED; urgency=medium
+
+  * Replaced dbus-send with "list updated" pub/sub to invalidate smart scopes (LP:
+    #1361221)
+  * Guarded attempts to create directories that must exist but cannot be created by
+    confined scopes. (LP: #1376416, LP: #1378805)
+
+ -- Marcus Tomlinson <[e-mail]>  Wed, 22 Oct 2014 17:44:46 +0200
+
 unity-scopes-api (0.6.7+15.04.20141107.1~rtm-0ubuntu1) 14.09; urgency=low
 
   [ Pawel Stolowski ]

=== modified file 'debian/libunity-scopes3.symbols'
--- debian/libunity-scopes3.symbols	2014-09-25 12:56:03 +0000
+++ debian/libunity-scopes3.symbols	2014-12-02 13:46:56 +0000
@@ -377,7 +377,7 @@
  (c++)"unity::scopes::internal::RegistryObject::remove_desktop_file(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0.6.6+14.10.20140916
  (c++)"unity::scopes::internal::RegistryObject::remove_local_scope(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::RegistryObject::ScopeExecData::~ScopeExecData()@Base" 0.4.2+14.04.20140404.2
- (c++|arch=amd64)"unity::scopes::internal::RegistryObject::ScopeExecData::ScopeExecData(unity::scopes::internal::RegistryObject::ScopeExecData const&)@Base" 0.6.6+14.10.20140916
+ (c++)"unity::scopes::internal::RegistryObject::ScopeExecData::ScopeExecData(unity::scopes::internal::RegistryObject::ScopeExecData const&)@Base" 0.6.6+14.10.20140916
  (c++)"unity::scopes::internal::RegistryObject::ScopeProcess::clear_handle_unlocked()@Base" 0.4.2+14.04.20140404.2
  (c++)"unity::scopes::internal::RegistryObject::ScopeProcess::exec(core::posix::ChildProcess::DeathObserver&, std::shared_ptr<unity::scopes::internal::Executor>)@Base" 0.4.3+14.10.20140428
  (c++)"unity::scopes::internal::RegistryObject::ScopeProcess::expand_custom_exec()@Base" 0.5.0+14.10.20140619
@@ -394,6 +394,7 @@
  (c++)"unity::scopes::internal::RegistryObject::ScopeProcess::wait_for_state(std::unique_lock<std::mutex>&, unity::scopes::internal::RegistryObject::ScopeProcess::ProcessState) const@Base" 0.4.5+14.10.20140513
  (c++)"unity::scopes::internal::RegistryObject::ScopeProcess::wait_for_state(unity::scopes::internal::RegistryObject::ScopeProcess::ProcessState) const@Base" 0.4.5+14.10.20140513
  (c++)"unity::scopes::internal::RegistryObject::set_remote_registry(std::shared_ptr<unity::scopes::internal::MWRegistry> const&)@Base" 0.4.0+14.04.20140312.1
+ (c++)"unity::scopes::internal::RegistryObject::ss_list_update()@Base" 0replaceme
  (c++)"unity::scopes::internal::RegistryObject::state_receiver()@Base" 0.4.2+14.04.20140404.2
  (c++)"unity::scopes::internal::RuntimeConfig::config_directory() const@Base" 0.6.2+rtm+rtm+rtm+14.09.20140818
  (c++)"unity::scopes::internal::RuntimeConfig::data_directory() const@Base" 0.5.2+14.10.20140709.2
@@ -410,10 +411,14 @@
  (c++)"unity::scopes::internal::RuntimeConfig::ss_configfile() const@Base" 0.4.4+14.10.20140508
  (c++)"unity::scopes::internal::RuntimeConfig::ss_registry_identity() const@Base" 0.4.4+14.10.20140508
  (c++)"unity::scopes::internal::RuntimeImpl::async_pool() const@Base" 0.4.3+14.10.20140428
+ (c++)"unity::scopes::internal::RuntimeImpl::confined() const@Base" 0replaceme
+ (c++)"unity::scopes::internal::RuntimeImpl::confinement_type() const@Base" 0replaceme
  (c++)"unity::scopes::internal::RuntimeImpl::create(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0.4.0+14.04.20140312.1
+ (c++)"unity::scopes::internal::RuntimeImpl::demangled_id() const@Base" 0replaceme
  (c++)"unity::scopes::internal::RuntimeImpl::destroy()@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::RuntimeImpl::factory() const@Base" 0.4.0+14.04.20140312.1
- (c++)"unity::scopes::internal::RuntimeImpl::find_cache_dir(std::basic_string<char, std::char_traits<char>, std::allocator<char> >&) const@Base" 0.6.0+14.10.20140804.1
+ (c++)"unity::scopes::internal::RuntimeImpl::find_cache_dir() const@Base" 0replaceme
+ (c++)"unity::scopes::internal::RuntimeImpl::find_tmp_dir() const@Base" 0replaceme
  (c++)"unity::scopes::internal::RuntimeImpl::future_queue() const@Base" 0.4.3+14.10.20140428
  (c++)"unity::scopes::internal::RuntimeImpl::proxy_to_string(std::shared_ptr<unity::scopes::Object> const&) const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::RuntimeImpl::registry_configfile() const@Base" 0.4.0+14.04.20140312.1

=== modified file 'include/unity/scopes/internal/DfltConfig.h.in'
--- include/unity/scopes/internal/DfltConfig.h.in	2014-08-11 13:03:21 +0000
+++ include/unity/scopes/internal/DfltConfig.h.in	2014-12-02 13:46:56 +0000
@@ -39,7 +39,6 @@
 static constexpr char const* DFLT_MIDDLEWARE_INI = DFLT_ZMQ_MIDDLEWARE_INI;
 static constexpr char const* DFLT_SCOPE_INSTALL_DIR = "@CMAKE_INSTALL_PREFIX@/@LIB_INSTALL_PREFIX@/@UNITY_SCOPES_LIB@";
 static constexpr char const* DFLT_OEM_INSTALL_DIR = "/custom/@LIB_INSTALL_PREFIX@/@UNITY_SCOPES_LIB@";
-static constexpr char const* DFLT_CONFINEMENT_TYPE = "leaf-net";
 
 static constexpr int DFLT_SS_HTTP_TIMEOUT = 20;              // seconds
 static constexpr int DFLT_SS_REG_REFRESH_RATE = 86400;       // 24 hours as seconds

=== modified file 'include/unity/scopes/internal/RegistryObject.h'
--- include/unity/scopes/internal/RegistryObject.h	2014-09-15 14:15:10 +0000
+++ include/unity/scopes/internal/RegistryObject.h	2014-12-02 13:46:56 +0000
@@ -85,6 +85,8 @@
     void create_desktop_file(ScopeMetadata const& metadata);
     void remove_desktop_file(std::string const& scope_id);
 
+    void ss_list_update();
+
     class ScopeProcess
     {
     public:
@@ -144,6 +146,8 @@
     mutable std::mutex mutex_;
 
     MWPublisher::SPtr publisher_;
+    MWSubscriber::SPtr ss_list_update_subscriber_;
+    std::shared_ptr<core::ScopedConnection> ss_list_update_connection_;
     bool generate_desktop_files_;
 };
 

=== modified file 'include/unity/scopes/internal/RuntimeImpl.h'
--- include/unity/scopes/internal/RuntimeImpl.h	2014-08-14 13:19:28 +0000
+++ include/unity/scopes/internal/RuntimeImpl.h	2014-12-02 13:46:56 +0000
@@ -69,7 +69,11 @@
 private:
     RuntimeImpl(std::string const& scope_id, std::string const& configfile);
     void waiter_thread(ThreadSafeQueue<std::future<void>>::SPtr const& queue) const noexcept;
-    std::string find_cache_dir(std::string& confinement_type) const;
+    std::string demangled_id() const;
+    bool confined() const;
+    std::string confinement_type() const;
+    std::string find_cache_dir() const;
+    std::string find_tmp_dir() const;
 
     bool destroyed_;
     std::string scope_id_;

=== modified file 'include/unity/scopes/internal/smartscopes/SSRegistryObject.h'
--- include/unity/scopes/internal/smartscopes/SSRegistryObject.h	2014-08-20 07:58:15 +0000
+++ include/unity/scopes/internal/smartscopes/SSRegistryObject.h	2014-12-02 13:46:56 +0000
@@ -98,6 +98,7 @@
 
     bool caching_enabled_;
     std::string locale_;
+    MWPublisher::SPtr publisher_;
 };
 
 }  // namespace smartscopes

=== modified file 'scoperegistry/scoperegistry.cpp'
--- scoperegistry/scoperegistry.cpp	2014-09-15 14:15:10 +0000
+++ scoperegistry/scoperegistry.cpp	2014-12-02 13:46:56 +0000
@@ -20,10 +20,7 @@
 #include "ScopesWatcher.h"
 
 #include <unity/scopes/internal/IniSettingsSchema.h>
-#include <unity/scopes/internal/MiddlewareFactory.h>
-#include <unity/scopes/internal/MWRegistry.h>
 #include <unity/scopes/internal/RegistryConfig.h>
-#include <unity/scopes/internal/RegistryObject.h>
 #include <unity/scopes/internal/RuntimeConfig.h>
 #include <unity/scopes/internal/RuntimeImpl.h>
 #include <unity/scopes/internal/ScopeConfig.h>
@@ -31,18 +28,10 @@
 #include <unity/scopes/internal/ScopeMetadataImpl.h>
 #include <unity/scopes/ScopeExceptions.h>
 #include <unity/UnityExceptions.h>
-#include <unity/util/ResourcePtr.h>
 
 #include <boost/algorithm/string.hpp>
 #include <boost/filesystem/operations.hpp>
 
-#include <algorithm>
-#include <cassert>
-#include <fstream>
-#include <iostream>
-#include <map>
-#include <set>
-
 #include <sys/stat.h>  // TODO: remove this once hack for creating data root dir is removed
 
 using namespace scoperegistry;
@@ -497,13 +486,22 @@
             // TODO: HACK: We create the root of the data directory for confined scopes,
             //       in case the scope is confined and the dir doesn't exist
             //       yet. This really should be done by the click-installation but,
-            //       prior to RTM, we don't rely on that. We check whether the
-            //       directory exists first to avoid getting noise in the Apparmor log.
+            //       prior to RTM, we don't rely on that.
             string data_root = rt_config.data_directory() + "/leaf-net";
             boost::system::error_code ec;
             !boost::filesystem::exists(data_root, ec) && ::mkdir(data_root.c_str(), 0700);
         } // Release memory for config parser
 
+        // Make sure that the parent directories for confined scope tmp directory exist.
+        {
+            string dir = string("/run/user/") + std::to_string(geteuid());
+            dir += "/scopes";
+            boost::system::error_code ec;
+            !boost::filesystem::exists(dir, ec) && ::mkdir(dir.c_str(), 0700 | S_ISVTX);
+            dir += "/leaf-net";
+            !boost::filesystem::exists(dir, ec) && ::mkdir(dir.c_str(), 0700 | S_ISVTX);
+        }
+
         // Collect the registry config data.
 
         string mw_kind;

=== modified file 'scoperunner/scoperunner.cpp'
--- scoperunner/scoperunner.cpp	2014-08-28 00:20:56 +0000
+++ scoperunner/scoperunner.cpp	2014-12-02 13:46:56 +0000
@@ -16,16 +16,8 @@
  * Authored by: Michi Henning <[e-mail]>
  */
 
-#include <unity/scopes/internal/MWRegistry.h>
-#include <unity/scopes/internal/MWStateReceiver.h>
-#include <unity/scopes/internal/RegistryConfig.h>
-#include <unity/scopes/internal/RuntimeConfig.h>
 #include <unity/scopes/internal/RuntimeImpl.h>
-#include <unity/scopes/internal/ScopeConfig.h>
 #include <unity/scopes/internal/ScopeLoader.h>
-#include <unity/scopes/internal/ScopeObject.h>
-#include <unity/scopes/internal/ThreadSafeQueue.h>
-#include <unity/scopes/ScopeExceptions.h>
 #include <unity/UnityExceptions.h>
 
 #include <boost/algorithm/string.hpp>
@@ -33,13 +25,6 @@
 #include <core/posix/signal.h>
 #include <core/posix/this_process.h>
 
-#include <cassert>
-#include <future>
-#include <iostream>
-#include <string>
-#include <unordered_map>
-#include <vector>
-
 using namespace std;
 using namespace unity::scopes;
 using namespace unity::scopes::internal;

=== modified file 'src/scopes/internal/RegistryObject.cpp'
--- src/scopes/internal/RegistryObject.cpp	2014-10-06 08:17:09 +0000
+++ src/scopes/internal/RegistryObject.cpp	2014-12-02 13:46:56 +0000
@@ -78,6 +78,15 @@
         try
         {
             publisher_ = middleware->create_publisher(middleware->runtime()->registry_identity());
+
+            ss_list_update_subscriber_ = middleware->create_subscriber(middleware->runtime()->ss_registry_identity());
+            ss_list_update_connection_ = std::make_shared<core::ScopedConnection>
+            (
+                ss_list_update_subscriber_->message_received().connect([this](string const&)
+                {
+                    ss_list_update();
+                })
+            );
         }
         catch (std::exception const& e)
         {
@@ -415,6 +424,15 @@
     }
 }
 
+void RegistryObject::ss_list_update()
+{
+    if (publisher_)
+    {
+        // Send a blank message to subscribers to inform them that the samrt scopes proxy has been updated
+        publisher_->send_message("");
+    }
+}
+
 RegistryObject::ScopeProcess::ScopeProcess(ScopeExecData exec_data, std::weak_ptr<MWPublisher> const& publisher)
     : exec_data_(exec_data)
     , reg_publisher_(publisher)

=== modified file 'src/scopes/internal/RuntimeImpl.cpp'
--- src/scopes/internal/RuntimeImpl.cpp	2014-09-08 05:55:39 +0000
+++ src/scopes/internal/RuntimeImpl.cpp	2014-12-02 13:46:56 +0000
@@ -350,17 +350,12 @@
         string config_dir = config_dir_ + "/" + scope_id_;
         string settings_db = config_dir + "/settings.ini";
 
-        string scope_data_dir = data_dir_ + "/" + scope_id_;
         string scope_dir = scope_base->scope_directory();
-
         string settings_schema = scope_dir + "/" + scope_id_ + "-settings.ini";
+
         boost::system::error_code ec;
         if (boost::filesystem::exists(settings_schema, ec))
         {
-            // Make sure the data directories exist. (No permission for group and others; data might be sensitive.)
-            !boost::filesystem::exists(data_dir_, ec) && ::mkdir(data_dir_.c_str(), 0700);
-            !boost::filesystem::exists(scope_data_dir, ec) && ::mkdir(scope_data_dir.c_str(), 0700);
-
             shared_ptr<SettingsDB> db(SettingsDB::create_from_ini_file(settings_db, settings_schema));
             scope_base->p->set_settings_db(db);
         }
@@ -371,25 +366,8 @@
     }
 
     scope_base->p->set_registry(registry_);
-
-    string confinement_type;
-    scope_base->p->set_cache_directory(find_cache_dir(confinement_type));
-
-    {
-        // Set tmp dir.
-        // We need to create any directories under /run/user/<uid> because they might not
-        // exist. (/run/user/<uid> gets cleaned out periodically.)
-        string path = string("/run/user/") + std::to_string(geteuid());
-        path += "/scopes";
-        boost::system::error_code ec;
-        !boost::filesystem::exists(path, ec) && ::mkdir(path.c_str(), 0700);
-        path += "/" + confinement_type;
-        !boost::filesystem::exists(path, ec) && ::mkdir(path.c_str(), 0700);
-        path += "/" + scope_id_;
-        !boost::filesystem::exists(path, ec) && ::mkdir(path.c_str(), 0700);
-
-        scope_base->p->set_tmp_directory(path);
-    }
+    scope_base->p->set_cache_directory(find_cache_dir());
+    scope_base->p->set_tmp_directory(find_tmp_dir());
 
     try
     {
@@ -508,23 +486,15 @@
     }
 }
 
-string RuntimeImpl::find_cache_dir(string& confinement_type) const
+string RuntimeImpl::demangled_id() const
 {
-    // Find out whether we are confined. aa_getcon() returns -1 in that case.
-    char* con = nullptr;
-    char* mode;
-    int rc = aa_getcon(&con, &mode);
-    // Only con (not mode) must be deallocated
-    free(con);
-    confinement_type = rc == -1 ? "leaf-net" : "unconfined";
-
     // For scopes that are in a click package together with an app,
     // such as YouTube, the cache directory is shared between the app and
     // the scope. The cache directory name is the scope ID up to the first
     // underscore. For example, com.ubuntu.scopes.youtube_youtube is the
     // scope ID, but the cache dir name is com.ubuntu.scopes.youtube.
     auto id = scope_id_;
-    if (confinement_type == "leaf-net")
+    if (confined())
     {
         auto pos = id.find('_');
         if (pos != string::npos)
@@ -532,14 +502,61 @@
             id = id.substr(0, pos);
         }
     }
-
+    return id;
+}
+
+bool RuntimeImpl::confined() const
+{
+    auto is_confined = []
+    {
+        // Find out whether we are confined. aa_getcon() returns -1 in that case.
+        char* con = nullptr;
+        char* mode;
+        int rc = aa_getcon(&con, &mode);
+        // Only con (not mode) must be deallocated
+        free(con);
+        return rc == -1;
+    };
+    static bool confined = is_confined();
+    return confined;
+}
+
+string RuntimeImpl::confinement_type() const
+{
+    return confined() ? "leaf-net" : "unconfined";
+}
+
+string RuntimeImpl::find_cache_dir() const
+{
     // Create the data_dir_/<confinement-type>/<id> directories if they don't exist.
     boost::system::error_code ec;
-    !boost::filesystem::exists(data_dir_, ec) && ::mkdir(data_dir_.c_str(), 0700);
-    string dir = data_dir_ + "/" + confinement_type;
-    !boost::filesystem::exists(dir, ec) && ::mkdir(dir.c_str(), 0700);
-    dir += "/" + id;
-    !boost::filesystem::exists(dir, ec) && ::mkdir(dir.c_str(), 0700);
+    !confined() && !boost::filesystem::exists(data_dir_, ec) && ::mkdir(data_dir_.c_str(), 0700);
+    string dir = data_dir_ + "/" + confinement_type();
+    !confined() && !boost::filesystem::exists(dir, ec) && ::mkdir(dir.c_str(), 0700);
+
+    // A confined scope is allowed to create this dir.
+    dir += "/" + demangled_id();
+    !boost::filesystem::exists(dir, ec) && ::mkdir(dir.c_str(), 0700);
+
+    return dir;
+}
+
+string RuntimeImpl::find_tmp_dir() const
+{
+    // Set tmp dir.
+    // We need to create any directories under /run/user/<uid> because they might not
+    // exist. We set the sticky bit because, without this, things in
+    // /run/user may be deleted if not accessed for more than six hours.
+    string dir = string("/run/user/") + std::to_string(geteuid());
+    dir += "/scopes";
+    boost::system::error_code ec;
+    !confined() && !boost::filesystem::exists(dir, ec) && ::mkdir(dir.c_str(), 0700 | S_ISVTX);
+    dir += "/" + confinement_type();
+    !confined() && !boost::filesystem::exists(dir, ec) && ::mkdir(dir.c_str(), 0700 | S_ISVTX);
+
+    // A confined scope is allowed to create this dir.
+    dir += "/" + scope_id_;  // Not demangled, use the real scope ID.
+    !boost::filesystem::exists(dir, ec) && ::mkdir(dir.c_str(), 0700 | S_ISVTX);
 
     return dir;
 }

=== modified file 'src/scopes/internal/smartscopes/SSRegistryObject.cpp'
--- src/scopes/internal/smartscopes/SSRegistryObject.cpp	2014-08-26 04:00:56 +0000
+++ src/scopes/internal/smartscopes/SSRegistryObject.cpp	2014-12-02 13:46:56 +0000
@@ -22,6 +22,7 @@
 #include <unity/scopes/internal/JsonSettingsSchema.h>
 #include <unity/scopes/internal/RegistryException.h>
 #include <unity/scopes/internal/RuntimeConfig.h>
+#include <unity/scopes/internal/RuntimeImpl.h>
 #include <unity/scopes/internal/ScopeImpl.h>
 #include <unity/scopes/internal/ScopeMetadataImpl.h>
 #include <unity/scopes/internal/smartscopes/HttpClientQt.h>
@@ -31,8 +32,6 @@
 
 #include <iostream>
 
-static const char* c_dbussend_cmd = "dbus-send /com/canonical/unity/scopes com.canonical.unity.scopes.InvalidateResults string:smart-scopes";
-
 namespace unity
 {
 
@@ -86,6 +85,18 @@
     }
 
     refresh_thread_ = std::thread(&SSRegistryObject::refresh_thread, this);
+
+    if (middleware)
+    {
+        try
+        {
+            publisher_ = middleware->create_publisher(middleware->runtime()->ss_registry_identity());
+        }
+        catch (std::exception const& e)
+        {
+            std::cerr << "SSRegistryObject(): failed to create registry publisher: " << e.what() << std::endl;
+        }
+    }
 }
 
 SSRegistryObject::~SSRegistryObject()
@@ -372,11 +383,10 @@
         scopes_ = new_scopes_;
     }
 
-    if (changed)
+    if (changed && publisher_)
     {
-        // something has changed, send invalidate signal
-        int result = safe_system_call(c_dbussend_cmd);
-        (void)result;
+        // Send a blank message to subscribers to inform them that the smart scopes registry has been updated
+        publisher_->send_message("");
     }
 }
 

=== modified file 'src/scopes/internal/smartscopes/SmartScope.cpp'
--- src/scopes/internal/smartscopes/SmartScope.cpp	2014-09-22 13:43:00 +0000
+++ src/scopes/internal/smartscopes/SmartScope.cpp	2014-12-02 13:46:56 +0000
@@ -160,7 +160,8 @@
         }
     };
 
-    ///! TODO: country (+location data)
+
+    ///! TODO: detailed location data
     int query_id = 0;
     std::string session_id;
     std::string agent;
@@ -186,9 +187,18 @@
     {
         agent = metadata["user-agent"].get_string();
     }
+    std::string country_code;
+    if (metadata.has_location())
+    {
+        auto location = metadata.location();
+        if (location.has_country_code())
+        {
+            country_code = location.country_code();
+        }
+    }
 
     search_handle_ = ss_client_->search(handler, base_url_, query_.query_string(), query_.department_id(), session_id, query_id, hints_.form_factor(),
-            settings(), query_.filter_state().serialize(), hints_.locale(), "", agent, hints_.cardinality());
+            settings(), query_.filter_state().serialize(), hints_.locale(), country_code, agent, hints_.cardinality());
     search_handle_->wait();
 
     std::cout << "SmartScope: query for \"" << scope_id_ << "\": \"" << query_.query_string() << "\" complete" << std::endl;
@@ -256,7 +266,7 @@
         }
     };
 
-    ///! TODO: country (+location data)
+    ///! TODO: country (+location data) - Preview metadata does not currently contain location data
     std::string session_id;
     std::string agent;
     auto const metadata = action_metadata();