Merge lp:~michihenning/unity-scopes-api/app-directory into lp:unity-scopes-api/devel

[Michi Henning]

Added app_directory() method to ScopeBase. It returns the directory that is shared if an app and a scope are installed from a single click packages. The directory is writable to the app, but only readable to the scope, so the app can pass information to the scope, but not vice versa.

Updated doc accordingly and added new section to the tutorial for this.

Renamed DataDir config item in Runtime.ini to CacheDir, for consistency with the public API naming.

Added tests and tightened a few existing tests.

Added missing directory set methods to TypedScopeFixture.

Added app_directory() method to ScopeBase. It returns the directory that is shared if an app and a scope are installed from a single click packages. The directory is writable to the app, but only readable to the scope, so the app can pass information to the scope, but not vice versa.

Updated doc accordingly and added new section to the tutorial for this.

Renamed DataDir config item in Runtime.ini to CacheDir, for consistency with the public API naming.

Added tests and tightened a few existing tests.

Added missing directory set methods to TypedScopeFixture.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:536
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-ci/1307/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-amd64-ci/17
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-armhf-ci/17
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-armhf-ci/17/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-i386-ci/17

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-devel-ci/1307/rebuild

review: Approve (continuous-integration)

[Paweł Stołowski (stolowski)]

Looks good, but since it's not a small change, I have to find and comment on something ;)

-unity-scopes-api (0.6.8-0ubuntu1) UNRELEASED; urgency=medium
+unity-scopes-api (0.6.8-0ubuntu2) UNRELEASED; urgency=medium

Since it's unreleased, it should remain unchanged ('0.6.8-0ubuntu1').

review: Needs Fixing

[lp:~michihenning/unity-scopes-api/app-directory]

537. By Michi Henning on 2014-11-18

Merged devel and resolved conflicts. Fixed version
in changelog.

[Michi Henning (michihenning)]

> Looks good, but since it's not a small change, I have to find and comment on
> something ;)

I think Michal must have passed his genetic imprint to you before he left! ;-)

Thanks for spotting this, should be fixed now!

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:537
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-ci/1318/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-amd64-ci/28
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-armhf-ci/28
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-armhf-ci/28/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-i386-ci/28

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-devel-ci/1318/rebuild

review: Approve (continuous-integration)

[Paweł Stołowski (stolowski)]

Thanks, +1

review: Approve

=== modified file 'CONFIGFILES'
--- CONFIGFILES	2014-11-10 11:25:45 +0000
+++ CONFIGFILES	2014-11-18 20:53:45 +0000
@@ -92,9 +92,9 @@
   config group, otherwise the middleware can prematurely conclude that
   a locate() request failed to start a scope.
 
-- DataDir
+- CacheDir
 
-  The parent directory under which the run time writes scope-specific data files
+  The parent directory under which a scope can write scope-specific data files
   (such as caches).
 
   The default value is $HOME/.local/share/unity-scopes.
@@ -105,6 +105,22 @@
   $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).
 
+- AppDir
+
+  The parent directory under which a scope can read data provided by an
+  app that was installed from the same click package.
+
+  The default value is $HOME/.local/share.
+
+  Note that the actual directory is a subdirectory of
+  this directory, for example:
+
+  $HOME/.local/share/<app-pkgname>
+
+  The app has read/write permission for this directory and the files in it,
+  the scope has read-only permission, so communication is from the app to
+  the scope, not vice versa.
+
 - ConfigDir
 
   The parent directory under which the runtime writes the scope configration files.
@@ -116,6 +132,7 @@
 
   $HOME/.config/unity-scopes/<scope_id>/settings.ini
 
+
 Zmq.ini
 -------
 

=== modified file 'RELEASE_NOTES.md'
--- RELEASE_NOTES.md	2014-11-13 05:05:54 +0000
+++ RELEASE_NOTES.md	2014-11-18 20:53:45 +0000
@@ -7,6 +7,9 @@
   - Replaced dbus-send with "list updated" pub/sub to invalidate smart scopes.
   - Added support for Version attribute in scope.ini file, and added version() accessor
     to ScopeMetadata.
+  - Added app_directory() method ScopeBase for scopes that are installed from the same
+    click package as an app. This allows the app to share data with its scope (but
+    not vice versa).
   - Added missing methods for settings_definitions(), location_data_needed(),
     and child_scope_ids() to testing::ScopeMetadataBuilder.
 

=== modified file 'debian/changelog'
--- debian/changelog	2014-11-12 23:12:58 +0000
+++ debian/changelog	2014-11-18 20:53:45 +0000
@@ -1,16 +1,17 @@
-unity-scopes-api (0.6.8-0ubuntu2) UNRELEASED; urgency=medium
+unity-scopes-api (0.6.8-0ubuntu1) UNRELEASED; urgency=medium
 
   [ Pawel Stolowski ]
   * Added support for ChildScopes scope .ini option.
   * Replaced dbus-send with "list updated" pub/sub to invalidate smart scopes.
 
   [ Michi Henning ]
+  * Added app_directory() method to ScopeBase.
   * Added support for Version attribute in scope.ini file, and added
     version() accessor to ScopeMetadata.
   * Added missing methods for settings_definitions(), location_data_needed(),
     and child_scope_ids() to testing::ScopeMetadataBuilder.
 
- -- Michi Henning <[e-mail]>  Thu, 13 Nov 2014 09:12:20 +1000
+ -- Michi Henning <[e-mail]>  Thu, 13 Nov 2014 13:10:09 +1000
 
 unity-scopes-api (0.6.7+14.10.20141014-0ubuntu1) 14.09; urgency=low
 

=== modified file 'debian/libunity-scopes3.symbols'
--- debian/libunity-scopes3.symbols	2014-11-18 08:46:17 +0000
+++ debian/libunity-scopes3.symbols	2014-11-18 20:53:45 +0000
@@ -396,10 +396,12 @@
  (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::app_directory() const@Base" 0replaceme
+ (c++)"unity::scopes::internal::RuntimeConfig::cache_directory() const@Base" 0replaceme
  (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
+ (c++)"unity::scopes::internal::RuntimeConfig::default_app_directory()@Base" 0replaceme
+ (c++)"unity::scopes::internal::RuntimeConfig::default_cache_directory()@Base" 0replaceme
  (c++)"unity::scopes::internal::RuntimeConfig::default_config_directory()@Base" 0.6.2+rtm+rtm+rtm+14.09.20140818
- (c++)"unity::scopes::internal::RuntimeConfig::default_data_directory()@Base" 0.5.2+14.10.20140709.2
  (c++)"unity::scopes::internal::RuntimeConfig::default_middleware_configfile() const@Base" 0.4.2+14.04.20140404.2
  (c++)"unity::scopes::internal::RuntimeConfig::default_middleware() const@Base" 0.4.2+14.04.20140404.2
  (c++)"unity::scopes::internal::RuntimeConfig::reap_expiry() const@Base" 0.4.5+14.10.20140513
@@ -417,6 +419,7 @@
  (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_app_dir() const@Base" 0replaceme
  (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
@@ -748,6 +751,7 @@
  (c++)"unity::scopes::Runtime::Runtime(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::Runtime::string_to_proxy(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&) const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::ScopeBase::activate(unity::scopes::Result const&, unity::scopes::ActionMetadata const&)@Base" 0.4.0+14.04.20140312.1
+ (c++)"unity::scopes::ScopeBase::app_directory() const@Base" 0replaceme
  (c++)"unity::scopes::ScopeBase::cache_directory() const@Base" 0.6.0+14.10.20140804.1
  (c++)"unity::scopes::ScopeBase::perform_action(unity::scopes::Result const&, unity::scopes::ActionMetadata const&, 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::ScopeBase::registry() const@Base" 0.6.0+14.10.20140804.1
@@ -875,8 +879,11 @@
  (c++)"unity::scopes::testing::StudentsTTest::one_sample(unity::scopes::testing::Sample const&, double, double)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::testing::StudentsTTest::Result::~Result()@Base" 0.4.2+14.04.20140404.2
  (c++)"unity::scopes::testing::StudentsTTest::two_independent_samples(unity::scopes::testing::Sample const&, unity::scopes::testing::Sample const&)@Base" 0.4.0+14.04.20140312.1
+ (c++)"unity::scopes::testing::TypedScopeFixtureHelper::set_app_directory(std::shared_ptr<unity::scopes::ScopeBase> const&, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0replaceme
+ (c++)"unity::scopes::testing::TypedScopeFixtureHelper::set_cache_directory(std::shared_ptr<unity::scopes::ScopeBase> const&, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0replaceme
  (c++)"unity::scopes::testing::TypedScopeFixtureHelper::set_registry(std::shared_ptr<unity::scopes::ScopeBase> const&, std::shared_ptr<unity::scopes::Registry> const&)@Base" 0.6.2+rtm+rtm+rtm+14.09.20140818
  (c++)"unity::scopes::testing::TypedScopeFixtureHelper::set_scope_directory(std::shared_ptr<unity::scopes::ScopeBase> const&, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0.6.6+14.10.20140916
+ (c++)"unity::scopes::testing::TypedScopeFixtureHelper::set_tmp_directory(std::shared_ptr<unity::scopes::ScopeBase> const&, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0replaceme
  (c++)"unity::scopes::TimeoutException::operator=(unity::scopes::TimeoutException const&)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::TimeoutException::self() const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::TimeoutException::~TimeoutException()@Base" 0.4.0+14.04.20140312.1

=== modified file 'doc/tutorial.dox'
--- doc/tutorial.dox	2014-11-10 11:25:45 +0000
+++ doc/tutorial.dox	2014-11-18 20:53:45 +0000
@@ -760,6 +760,34 @@
 }
 ~~~
 
+\subsection directories File system access
+
+Scopes that are installed from click packages are subject to confinement and are not allowed
+to access most parts of the file system. However, a few locations are available to a scope.
+You can access these paths by calling methods on \link unity::scopes::ScopeBase ScopeBase\endlink.
+
+\note Do not call these methods from the constructor of your `ScopeBase` implementation. If you
+do, these methods throw `LogicException`. Instead, call them from
+\link unity::scopes::ScopeBase::start() start()\endlink or any time thereafter.
+
+\link unity::scopes::ScopeBase::scope_directory() scope_directory()\endlink returns the path of the installation
+directory of the scope. This directory contains the scope's `.so` and `.ini` files, plus whatever other
+files you decide to package with your scope. The scope has read-only permission for this directory.
+
+\link unity::scopes::ScopeBase::cache_directory() cache_directory()\endlink returns the path of a
+directory that is (exclusively) writable for the scope. You can use this directory to store
+persistent information, such as a cache of results.
+
+\link unity::scopes::ScopeBase::app_directory() app_directory()\endlink returns the path of a
+read-only directory. If the scope is packaged together with an app, the app has permission to write
+files in this location, that is, this directory can be used make information provided by the app
+available to the scope (but not vice versa).
+
+\link unity::scopes::ScopeBase::tmp_directory() tmp_directory()\endlink returns the path of a
+read-only directory that is (exclusively) writable for the scope. This directory is periodically
+cleaned of unused files. The exact amount of time may vary, but is on the order of a few hours.
+The directory is also cleaned during reboot.
+
 \subsection online_accounts Online Accounts
 
 A scope may require access to an online account in order to evaluate particular results, perform certain actions, or

=== modified file 'include/unity/scopes/ScopeBase.h'
--- include/unity/scopes/ScopeBase.h	2014-11-03 05:31:30 +0000
+++ include/unity/scopes/ScopeBase.h	2014-11-18 20:53:45 +0000
@@ -272,10 +272,28 @@
     virtual std::string cache_directory() const final;
 
     /**
+    \brief Returns a directory that is shared with an app in the same click package.
+
+    If a scope and an app share a single click package, this directory and the
+    files in it are writable by the app, and read-only to the scope. This allows
+    the app to write information into the filesystem that can be read by the scope
+    (but not vice versa).
+
+    \note The app directory is available only after this ScopeBase is instantiated; do not
+    call this method from the constructor!
+
+    \return The root directory of a filesystem sub-tree that the scope shares with
+    an application installed from the same click-package.
+    \throws LogicException if called from the constructor of this instance.
+    */
+    virtual std::string app_directory() const final;
+
+    /**
     \brief Returns a tmp directory that is (exclusively) writable for the scope.
 
     This directory is periodically cleaned of unused files. The exact amount of time
-    may vary, but is on the order of a few hours.
+    may vary, but is on the order of a few hours. The directory is also cleaned
+    during reboot.
 
     \note The tmp directory is available only after this ScopeBase is instantiated; do not
     call this method from the constructor!

=== modified file 'include/unity/scopes/internal/RuntimeConfig.h'
--- include/unity/scopes/internal/RuntimeConfig.h	2014-11-03 05:31:30 +0000
+++ include/unity/scopes/internal/RuntimeConfig.h	2014-11-18 20:53:45 +0000
@@ -44,10 +44,12 @@
     std::string default_middleware_configfile() const;
     int reap_expiry() const;
     int reap_interval() const;
-    std::string data_directory() const;
+    std::string cache_directory() const;
+    std::string app_directory() const;
     std::string config_directory() const;
+    static std::string default_cache_directory();
+    static std::string default_app_directory();
     static std::string default_config_directory();
-    static std::string default_data_directory();
 
 private:
     std::string registry_identity_;
@@ -58,7 +60,8 @@
     std::string default_middleware_configfile_;
     int reap_expiry_;
     int reap_interval_;
-    std::string data_directory_;
+    std::string cache_directory_;
+    std::string app_directory_;
     std::string config_directory_;
 };
 

=== modified file 'include/unity/scopes/internal/RuntimeImpl.h'
--- include/unity/scopes/internal/RuntimeImpl.h	2014-11-03 05:31:30 +0000
+++ include/unity/scopes/internal/RuntimeImpl.h	2014-11-18 20:53:45 +0000
@@ -72,6 +72,7 @@
     bool confined() const;
     std::string confinement_type() const;
     std::string find_cache_dir() const;
+    std::string find_app_dir() const;
     std::string find_tmp_dir() const;
 
     bool destroyed_;
@@ -85,7 +86,8 @@
     mutable std::string ss_registry_identity_;
     int reap_expiry_;
     int reap_interval_;
-    std::string data_dir_;
+    std::string cache_dir_;
+    std::string app_dir_;
     std::string config_dir_;
     std::string tmp_dir_;
     mutable Reaper::SPtr reply_reaper_;

=== modified file 'include/unity/scopes/internal/ScopeBaseImpl.h'
--- include/unity/scopes/internal/ScopeBaseImpl.h	2014-11-03 05:31:30 +0000
+++ include/unity/scopes/internal/ScopeBaseImpl.h	2014-11-18 20:53:45 +0000
@@ -47,6 +47,9 @@
     void set_cache_directory(std::string const& path);
     std::string cache_directory() const;
 
+    void set_app_directory(std::string const& path);
+    std::string app_directory() const;
+
     void set_tmp_directory(std::string const& path);
     std::string tmp_directory() const;
 
@@ -64,6 +67,9 @@
     std::string cache_directory_;
     bool cache_dir_initialized_;
 
+    std::string app_directory_;
+    bool app_dir_initialized_;
+
     std::string tmp_directory_;
     bool tmp_dir_initialized_;
 

=== modified file 'include/unity/scopes/testing/TypedScopeFixture.h'
--- include/unity/scopes/testing/TypedScopeFixture.h	2014-11-03 05:31:30 +0000
+++ include/unity/scopes/testing/TypedScopeFixture.h	2014-11-18 20:53:45 +0000
@@ -53,13 +53,14 @@
     }
 };
 
-struct TypedScopeFixtureHelper
+class TypedScopeFixtureHelper
 {
-private:
+    static void set_scope_directory(std::shared_ptr<ScopeBase> const& scope, std::string const& path);
+    static void set_cache_directory(std::shared_ptr<ScopeBase> const& scope, std::string const& path);
+    static void set_app_directory(std::shared_ptr<ScopeBase> const& scope, std::string const& path);
+    static void set_tmp_directory(std::shared_ptr<ScopeBase> const& scope, std::string const& path);
     static void set_registry(std::shared_ptr<ScopeBase> const& scope, RegistryProxy const& r);
 
-    static void set_scope_directory(std::shared_ptr<ScopeBase> const& scope, std::string const& path);
-
     template<typename Scope>
     friend class TypedScopeFixture;
 };
@@ -86,6 +87,26 @@
         TypedScopeFixtureHelper::set_scope_directory(scope, path);
     }
 
+    void set_cache_directory(std::string const& path)
+    {
+        TypedScopeFixtureHelper::set_cache_directory(scope, path);
+    }
+
+    void set_app_directory(std::string const& path)
+    {
+        TypedScopeFixtureHelper::set_app_directory(scope, path);
+    }
+
+    void set_tmp_directory(std::string const& path)
+    {
+        TypedScopeFixtureHelper::set_tmp_directory(scope, path);
+    }
+
+    static void set_registry(std::shared_ptr<ScopeBase> const& scope, RegistryProxy const& r)
+    {
+        TypedScopeFixtureHelper::set_registry(scope, r);
+    }
+
     void TearDown()
     {
         EXPECT_NO_THROW(scope->stop());

=== modified file 'scoperegistry/scoperegistry.cpp'
--- scoperegistry/scoperegistry.cpp	2014-11-18 08:46:17 +0000
+++ scoperegistry/scoperegistry.cpp	2014-11-18 20:53:45 +0000
@@ -485,13 +485,17 @@
             identity = runtime->registry_identity();
             ss_reg_id = runtime->ss_registry_identity();
 
-            // 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,
+            // TODO: HACK: We create the root of the cache and app directories 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.
-            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);
+
+            string cache_root = rt_config.cache_directory() + "/leaf-net";
+            !boost::filesystem::exists(cache_root, ec) && ::mkdir(cache_root.c_str(), 0700);
+
+            string app_root = rt_config.app_directory();
+            !boost::filesystem::exists(app_root, ec) && ::mkdir(app_root.c_str(), 0700);
         } // Release memory for config parser
 
         // Make sure that the parent directories for confined scope tmp directory exist.

=== modified file 'src/scopes/ScopeBase.cpp'
--- src/scopes/ScopeBase.cpp	2014-08-14 17:23:22 +0000
+++ src/scopes/ScopeBase.cpp	2014-11-18 20:53:45 +0000
@@ -82,6 +82,11 @@
     return p->cache_directory();
 }
 
+std::string ScopeBase::app_directory() const
+{
+    return p->app_directory();
+}
+
 std::string ScopeBase::tmp_directory() const
 {
     return p->tmp_directory();

=== modified file 'src/scopes/internal/RuntimeConfig.cpp'
--- src/scopes/internal/RuntimeConfig.cpp	2014-08-13 17:07:12 +0000
+++ src/scopes/internal/RuntimeConfig.cpp	2014-11-18 20:53:45 +0000
@@ -46,7 +46,8 @@
 const string default_middleware_configfile_key = ".ConfigFile";
 const string reap_expiry_key = "Reap.Expiry";
 const string reap_interval_key = "Reap.Interval";
-const string data_dir_key = "DataDir";
+const string cache_dir_key = "CacheDir";
+const string app_dir_key = "AppDir";
 const string config_dir_key = "ConfigDir";
 
 }  // namespace
@@ -66,7 +67,8 @@
         reap_interval_ = DFLT_REAP_INTERVAL;
         try
         {
-            data_directory_ = default_data_directory();
+            cache_directory_ = default_cache_directory();
+            app_directory_ = default_app_directory();
             config_directory_ = default_config_directory();
         }
         catch (ResourceException const& e)
@@ -94,16 +96,28 @@
         {
             throw_ex("Illegal value (" + to_string(reap_interval_) + ") for " + reap_interval_key + ": value must be > 0");
         }
-        data_directory_ = get_optional_string(runtime_config_group, data_dir_key);
-        if (data_directory_.empty())
-        {
-            try
-            {
-                data_directory_ = default_data_directory();
-            }
-            catch (ResourceException const& e)
-            {
-                throw_ex("No DataDir configured and failed to get default");
+        cache_directory_ = get_optional_string(runtime_config_group, cache_dir_key);
+        if (cache_directory_.empty())
+        {
+            try
+            {
+                cache_directory_ = default_cache_directory();
+            }
+            catch (ResourceException const& e)
+            {
+                throw_ex("No CacheDir configured and failed to get default");
+            }
+        }
+        app_directory_ = get_optional_string(runtime_config_group, app_dir_key);
+        if (app_directory_.empty())
+        {
+            try
+            {
+                app_directory_ = default_app_directory();
+            }
+            catch (ResourceException const& e)
+            {
+                throw_ex("No AppDir configured and failed to get default");
             }
         }
         config_directory_ = get_optional_string(runtime_config_group, config_dir_key);
@@ -131,7 +145,8 @@
                                                 default_middleware_ + default_middleware_configfile_key,
                                                 reap_expiry_key,
                                                 reap_interval_key,
-                                                data_dir_key,
+                                                cache_dir_key,
+                                                app_dir_key,
                                                 config_dir_key
                                              }
                                           }
@@ -183,9 +198,14 @@
     return reap_interval_;
 }
 
-string RuntimeConfig::data_directory() const
-{
-    return data_directory_;
+string RuntimeConfig::cache_directory() const
+{
+    return cache_directory_;
+}
+
+string RuntimeConfig::app_directory() const
+{
+    return app_directory_;
 }
 
 string RuntimeConfig::config_directory() const
@@ -193,6 +213,26 @@
     return config_directory_;
 }
 
+string RuntimeConfig::default_cache_directory()
+{
+    char const* home = getenv("HOME");
+    if (!home || *home == '\0')
+    {
+        throw ResourceException("RuntimeConfig::default_cache_directory(): $HOME not set");
+    }
+    return string(home) + "/.local/share/unity-scopes";
+}
+
+string RuntimeConfig::default_app_directory()
+{
+    char const* home = getenv("HOME");
+    if (!home || *home == '\0')
+    {
+        throw ResourceException("RuntimeConfig::default_app_directory(): $HOME not set");
+    }
+    return string(home) + "/.local/share";
+}
+
 string RuntimeConfig::default_config_directory()
 {
     char const* home = getenv("HOME");
@@ -203,17 +243,6 @@
     return string(home) + "/.config/unity-scopes";
 }
 
-string RuntimeConfig::default_data_directory()
-{
-    char const* home = getenv("HOME");
-    if (!home || *home == '\0')
-    {
-        throw ResourceException("RuntimeConfig::default_data_directory(): $HOME not set");
-    }
-    return string(home) + "/.local/share/unity-scopes";
-}
-
-
 } // namespace internal
 
 } // namespace scopes

=== modified file 'src/scopes/internal/RuntimeImpl.cpp'
--- src/scopes/internal/RuntimeImpl.cpp	2014-10-10 07:01:36 +0000
+++ src/scopes/internal/RuntimeImpl.cpp	2014-11-18 20:53:45 +0000
@@ -102,7 +102,8 @@
             registry_ = make_shared<RegistryImpl>(registry_mw_proxy, this);
         }
 
-        data_dir_ = config.data_directory();
+        cache_dir_ = config.cache_directory();
+        app_dir_ = config.app_directory();
         config_dir_ = config.config_directory();
     }
     catch (unity::Exception const& e)
@@ -340,18 +341,15 @@
 
     auto mw = factory()->create(scope_id_, reg_conf.mw_kind(), reg_conf.mw_configfile());
 
-    {
-        boost::filesystem::path dir = boost::filesystem::canonical(scope_ini_file).parent_path();
-        scope_base->p->set_scope_directory(dir.native());
-    }
+    boost::filesystem::path scope_dir = boost::filesystem::canonical(scope_ini_file).parent_path();
+    scope_base->p->set_scope_directory(scope_dir.native());
 
     {
         // Try to open the scope settings database, if any.
         string config_dir = config_dir_ + "/" + scope_id_;
         string settings_db = config_dir + "/settings.ini";
 
-        string scope_dir = scope_base->scope_directory();
-        string settings_schema = scope_dir + "/" + scope_id_ + "-settings.ini";
+        string settings_schema = scope_dir.native() + "/" + scope_id_ + "-settings.ini";
 
         boost::system::error_code ec;
         if (boost::filesystem::exists(settings_schema, ec))
@@ -367,6 +365,7 @@
 
     scope_base->p->set_registry(registry_);
     scope_base->p->set_cache_directory(find_cache_dir());
+    scope_base->p->set_app_directory(find_app_dir());
     scope_base->p->set_tmp_directory(find_tmp_dir());
 
     try
@@ -489,8 +488,8 @@
 string RuntimeImpl::demangled_id() const
 {
     // 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
+    // such as YouTube, the scope id is <scope_id>_<app_id>
+    // The app directory and cache directory names are 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_;
@@ -528,10 +527,10 @@
 
 string RuntimeImpl::find_cache_dir() const
 {
-    // Create the data_dir_/<confinement-type>/<id> directories if they don't exist.
+    // Create the cache_dir_/<confinement-type>/<id> directories if they don't exist.
     boost::system::error_code ec;
-    !confined() && !boost::filesystem::exists(data_dir_, ec) && ::mkdir(data_dir_.c_str(), 0700);
-    string dir = data_dir_ + "/" + confinement_type();
+    !confined() && !boost::filesystem::exists(cache_dir_, ec) && ::mkdir(cache_dir_.c_str(), 0700);
+    string dir = cache_dir_ + "/" + confinement_type();
     !confined() && !boost::filesystem::exists(dir, ec) && ::mkdir(dir.c_str(), 0700);
 
     // A confined scope is allowed to create this dir.
@@ -541,6 +540,17 @@
     return dir;
 }
 
+string RuntimeImpl::find_app_dir() const
+{
+    // Create the app_dir_/<id> directories if they don't exist.
+    boost::system::error_code ec;
+    !confined() && !boost::filesystem::exists(app_dir_, ec) && ::mkdir(app_dir_.c_str(), 0700);
+    string dir = app_dir_ + "/" + demangled_id();
+    !confined() && !boost::filesystem::exists(dir, ec) && ::mkdir(dir.c_str(), 0700);
+
+    return dir;
+}
+
 string RuntimeImpl::find_tmp_dir() const
 {
     // Set tmp dir.

=== modified file 'src/scopes/internal/ScopeBaseImpl.cpp'
--- src/scopes/internal/ScopeBaseImpl.cpp	2014-07-11 06:28:13 +0000
+++ src/scopes/internal/ScopeBaseImpl.cpp	2014-11-18 20:53:45 +0000
@@ -38,6 +38,7 @@
 ScopeBaseImpl::ScopeBaseImpl()
     : scope_dir_initialized_(false)
     , cache_dir_initialized_(false)
+    , app_dir_initialized_(false)
     , registry_initialized_(false)
     , settings_db_initialized_(false)
 {
@@ -82,6 +83,27 @@
     return cache_directory_;
 }
 
+void ScopeBaseImpl::set_app_directory(std::string const& path)
+{
+    lock_guard<mutex> lock(mutex_);
+    app_directory_ = path;
+    app_dir_initialized_ = true;
+}
+
+std::string ScopeBaseImpl::app_directory() const
+{
+    lock_guard<mutex> lock(mutex_);
+    if (!app_dir_initialized_)
+    {
+        throw LogicException("ScopeBase::app_directory() cannot be called from constructor");
+    }
+    if (app_directory_.empty())
+    {
+        throw ConfigException("ScopeBase::app_directory(): no app directory available");
+    }
+    return app_directory_;
+}
+
 void ScopeBaseImpl::set_tmp_directory(std::string const& path)
 {
     lock_guard<mutex> lock(mutex_);

=== modified file 'src/scopes/testing/TypedScopeFixture.cpp'
--- src/scopes/testing/TypedScopeFixture.cpp	2014-09-16 09:10:07 +0000
+++ src/scopes/testing/TypedScopeFixture.cpp	2014-11-18 20:53:45 +0000
@@ -23,13 +23,30 @@
 using namespace unity::scopes::testing;
 
 /// @cond
+
+void TypedScopeFixtureHelper::set_scope_directory(std::shared_ptr<unity::scopes::ScopeBase> const& scope, std::string const& path)
+{
+    scope->p->set_scope_directory(path);
+}
+
+void TypedScopeFixtureHelper::set_cache_directory(std::shared_ptr<unity::scopes::ScopeBase> const& scope, std::string const& path)
+{
+    scope->p->set_cache_directory(path);
+}
+
+void TypedScopeFixtureHelper::set_app_directory(std::shared_ptr<unity::scopes::ScopeBase> const& scope, std::string const& path)
+{
+    scope->p->set_app_directory(path);
+}
+
+void TypedScopeFixtureHelper::set_tmp_directory(std::shared_ptr<unity::scopes::ScopeBase> const& scope, std::string const& path)
+{
+    scope->p->set_tmp_directory(path);
+}
+
 void TypedScopeFixtureHelper::set_registry(std::shared_ptr<unity::scopes::ScopeBase> const& scope, RegistryProxy const& r)
 {
     scope->p->set_registry(r);
 }
 
-void TypedScopeFixtureHelper::set_scope_directory(std::shared_ptr<unity::scopes::ScopeBase> const& scope, std::string const& path)
-{
-    scope->p->set_scope_directory(path);
-}
 /// @endcond

=== renamed file 'test/gtest/scopes/internal/RuntimeConfig/DataDir.ini' => 'test/gtest/scopes/internal/RuntimeConfig/CacheDir.ini'
--- test/gtest/scopes/internal/RuntimeConfig/DataDir.ini	2014-08-13 17:07:12 +0000
+++ test/gtest/scopes/internal/RuntimeConfig/CacheDir.ini	2014-11-18 20:53:45 +0000
@@ -1,3 +1,4 @@
 [Runtime]
-DataDir = Foo
-ConfigDir = Foo
+CacheDir = cachedir
+AppDir = appdir
+ConfigDir = configdir

=== modified file 'test/gtest/scopes/internal/RuntimeConfig/ConfigDir.ini'
--- test/gtest/scopes/internal/RuntimeConfig/ConfigDir.ini	2014-08-14 07:31:07 +0000
+++ test/gtest/scopes/internal/RuntimeConfig/ConfigDir.ini	2014-11-18 20:53:45 +0000
@@ -1,3 +1,4 @@
 [Runtime]
-DataDir = Foo
-ConfigDir = Foo
+CacheDir = cachedir
+AppDir = appdir
+ConfigDir = configdir

=== added file 'test/gtest/scopes/internal/RuntimeConfig/NoAppDir.ini'
--- test/gtest/scopes/internal/RuntimeConfig/NoAppDir.ini	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/internal/RuntimeConfig/NoAppDir.ini	2014-11-18 20:53:45 +0000
@@ -0,0 +1,2 @@
+[Runtime]
+CacheDir = cachedir

=== renamed file 'test/gtest/scopes/internal/RuntimeConfig/NoDataDir.ini' => 'test/gtest/scopes/internal/RuntimeConfig/NoCacheDir.ini'
--- test/gtest/scopes/internal/RuntimeConfig/NoDataDir.ini	2014-08-13 17:07:12 +0000
+++ test/gtest/scopes/internal/RuntimeConfig/NoCacheDir.ini	2014-11-18 20:53:45 +0000
@@ -1,2 +1,2 @@
 [Runtime]
-ConfigDir = Foo
\ No newline at end of file
+ConfigDir = configdir

=== modified file 'test/gtest/scopes/internal/RuntimeConfig/NoConfigDir.ini'
--- test/gtest/scopes/internal/RuntimeConfig/NoConfigDir.ini	2014-08-14 07:31:07 +0000
+++ test/gtest/scopes/internal/RuntimeConfig/NoConfigDir.ini	2014-11-18 20:53:45 +0000
@@ -1,2 +1,3 @@
 [Runtime]
-DataDir = Foo
+CacheDir = cachedir
+AppDir = appdir

=== modified file 'test/gtest/scopes/internal/RuntimeConfig/RuntimeConfig_test.cpp'
--- test/gtest/scopes/internal/RuntimeConfig/RuntimeConfig_test.cpp	2014-08-13 17:07:12 +0000
+++ test/gtest/scopes/internal/RuntimeConfig/RuntimeConfig_test.cpp	2014-11-18 20:53:45 +0000
@@ -42,28 +42,44 @@
     EXPECT_EQ(DFLT_REAP_INTERVAL, c.reap_interval());
 }
 
-TEST(RuntimeConfig, _default_data_dir)
+TEST(RuntimeConfig, _default_cache_dir)
 {
     setenv("HOME", TEST_SRC_DIR, 1);
 
     RuntimeConfig c("");
-    EXPECT_EQ(TEST_SRC_DIR "/.local/share/unity-scopes", c.data_directory());
-}
-
-TEST(RuntimeConfig, overridden_data_dir)
-{
-    unsetenv("HOME");
-
-    RuntimeConfig c(TEST_SRC_DIR "/DataDir.ini");
-    EXPECT_EQ("Foo", c.data_directory());
-}
-
-TEST(RuntimeConfig, overridden_data_dir_with_home_dir)
-{
-    setenv("HOME", TEST_SRC_DIR, 1);
-
-    RuntimeConfig c(TEST_SRC_DIR "/DataDir.ini");
-    EXPECT_EQ("Foo", c.data_directory());
+    EXPECT_EQ(TEST_SRC_DIR "/.local/share/unity-scopes", c.cache_directory());
+}
+
+TEST(RuntimeConfig, overridden_cache_dir)
+{
+    unsetenv("HOME");
+
+    RuntimeConfig c(TEST_SRC_DIR "/CacheDir.ini");
+    EXPECT_EQ("cachedir", c.cache_directory());
+}
+
+TEST(RuntimeConfig, overridden_cache_dir_with_home_dir)
+{
+    setenv("HOME", TEST_SRC_DIR, 1);
+
+    RuntimeConfig c(TEST_SRC_DIR "/CacheDir.ini");
+    EXPECT_EQ("cachedir", c.cache_directory());
+}
+
+TEST(RuntimeConfig, overridden_app_dir)
+{
+    unsetenv("HOME");
+
+    RuntimeConfig c(TEST_SRC_DIR "/CacheDir.ini");
+    EXPECT_EQ("appdir", c.app_directory());
+}
+
+TEST(RuntimeConfig, overridden_app_dir_with_home_dir)
+{
+    setenv("HOME", TEST_SRC_DIR, 1);
+
+    RuntimeConfig c(TEST_SRC_DIR "/ConfigDir.ini");
+    EXPECT_EQ("appdir", c.app_directory());
 }
 
 TEST(RuntimeConfig, overridden_config_dir)
@@ -71,7 +87,7 @@
     unsetenv("HOME");
 
     RuntimeConfig c(TEST_SRC_DIR "/ConfigDir.ini");
-    EXPECT_EQ("Foo", c.config_directory());
+    EXPECT_EQ("configdir", c.config_directory());
 }
 
 TEST(RuntimeConfig, overridden_config_dir_with_home_dir)
@@ -79,7 +95,7 @@
     setenv("HOME", TEST_SRC_DIR, 1);
 
     RuntimeConfig c(TEST_SRC_DIR "/ConfigDir.ini");
-    EXPECT_EQ("Foo", c.config_directory());
+    EXPECT_EQ("configdir", c.config_directory());
 }
 
 TEST(RuntimeConfig, exceptions)
@@ -124,14 +140,14 @@
     {
         unsetenv("HOME");
 
-        RuntimeConfig c(TEST_SRC_DIR "/NoDataDir.ini");
+        RuntimeConfig c(TEST_SRC_DIR "/NoCacheDir.ini");
         FAIL();
-        EXPECT_EQ("Foo", c.data_directory());
+        EXPECT_EQ("cachedir", c.cache_directory());
     }
     catch (ConfigException const& e)
     {
-        EXPECT_STREQ("unity::scopes::ConfigException: \"" TEST_SRC_DIR "/NoDataDir.ini\": No DataDir configured and "
-                     "failed to get default:\n    unity::ResourceException: RuntimeConfig::default_data_directory(): "
+        EXPECT_STREQ("unity::scopes::ConfigException: \"" TEST_SRC_DIR "/NoCacheDir.ini\": No CacheDir configured and "
+                     "failed to get default:\n    unity::ResourceException: RuntimeConfig::default_cache_directory(): "
                      "$HOME not set",
                      e.what());
     }
@@ -142,7 +158,7 @@
 
         RuntimeConfig c(TEST_SRC_DIR "/NoConfigDir.ini");
         FAIL();
-        EXPECT_EQ("Foo", c.data_directory());
+        EXPECT_EQ("cachedir", c.cache_directory());
     }
     catch (ConfigException const& e)
     {

=== modified file 'test/gtest/scopes/internal/RuntimeImpl/Runtime.ini.in'
--- test/gtest/scopes/internal/RuntimeImpl/Runtime.ini.in	2014-08-13 17:07:12 +0000
+++ test/gtest/scopes/internal/RuntimeImpl/Runtime.ini.in	2014-11-18 20:53:45 +0000
@@ -3,5 +3,6 @@
 Registry.ConfigFile = @CMAKE_CURRENT_BINARY_DIR@/Registry.ini
 Default.Middleware = Zmq
 Zmq.ConfigFile = @CMAKE_CURRENT_BINARY_DIR@/Zmq.ini
-DataDir = @CMAKE_CURRENT_BINARY_DIR@/cache_dir
-ConfigDir = @CMAKE_CURRENT_BINARY_DIR@/cache_dir
+CacheDir = @CMAKE_CURRENT_BINARY_DIR@/cache_dir
+AppDir = @CMAKE_CURRENT_BINARY_DIR@/app_dir
+ConfigDir = @CMAKE_CURRENT_BINARY_DIR@/config_dir

=== modified file 'test/gtest/scopes/internal/RuntimeImpl/RuntimeImpl_test.cpp'
--- test/gtest/scopes/internal/RuntimeImpl/RuntimeImpl_test.cpp	2014-09-08 05:55:39 +0000
+++ test/gtest/scopes/internal/RuntimeImpl/RuntimeImpl_test.cpp	2014-11-18 20:53:45 +0000
@@ -201,6 +201,7 @@
         EXPECT_EQ(tmpdir, testscope.tmp_directory());
 
         EXPECT_EQ(TEST_DIR "/cache_dir/unconfined/TestScope", testscope.cache_directory());
+        EXPECT_EQ(TEST_DIR "/app_dir/TestScope", testscope.app_directory());
 
         // Don't destroy the run time until after the scope has finished initializing.
         initialized.wait();
@@ -210,9 +211,9 @@
     }
 
     {
-        // Check that scopes that share a cache dir with an app (because
+        // Check that scopes that share an app dir with an app (because
         // the scope is packaged with the app in a single click package)
-        // share the app's cache directory.
+        // return the correct path for cache and app dir.
 
         string const scope_ini_file = TEST_DIR "/TestScope_TestScope.ini";
 
@@ -236,6 +237,7 @@
         EXPECT_EQ(tmpdir, testscope.tmp_directory());
 
         EXPECT_EQ(TEST_DIR "/cache_dir/unconfined/TestScope", testscope.cache_directory());
+        EXPECT_EQ(TEST_DIR "/app_dir/TestScope", testscope.app_directory());
 
         // Don't destroy the run time until after the scope has finished initializing.
         initialized.wait();