Merge lp:~mhr3/libunity/fix-1199715 into lp:libunity

[Michal Hruby]

Auto-close channels when their owner disappears from the bus

Auto-close channels when their owner disappears from the bus. Also ensure that the tracker class that manages subscopes for aggregator scopes closes the subscopes' channels when the master channel closes.

Also includes code that ensures that there are no reference cycles in the ScopeChannel class.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:294
http://jenkins.qa.ubuntu.com/job/libunity-ci/119/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/libunity-saucy-amd64-ci/104
    SUCCESS: http://jenkins.qa.ubuntu.com/job/libunity-saucy-armhf-ci/104
    SUCCESS: http://jenkins.qa.ubuntu.com/job/libunity-saucy-i386-ci/104

Click here to trigger a rebuild:
http://s-jenkins:8080/job/libunity-ci/119/rebuild

review: Approve (continuous-integration)

[Paweł Stołowski (stolowski)]

Yay, no more home scope crashes with this fix :)

review: Approve

=== modified file 'protocol/protocol-scope-interface.vala'
--- protocol/protocol-scope-interface.vala	2013-08-26 09:15:14 +0000
+++ protocol/protocol-scope-interface.vala	2013-09-24 09:09:27 +0000
@@ -131,7 +131,8 @@
       uint channel_type,
       HashTable<string, Variant> hints,
       Cancellable? cancellable = null,
-      out HashTable<string, Variant> out_hints) throws IOError;
+      out HashTable<string, Variant> out_hints,
+      BusName? sender = null) throws IOError;
 
   public abstract async void close_channel (
       string channel_id,

=== modified file 'src/unity-aggregator-scope-private.vala'
--- src/unity-aggregator-scope-private.vala	2013-08-19 12:00:49 +0000
+++ src/unity-aggregator-scope-private.vala	2013-09-24 09:09:27 +0000
@@ -593,6 +593,12 @@
     }
   }
 
+  private void channel_owner_lost (ScopeChannel channel)
+  {
+    var empty = new HashTable<string, Variant> (str_hash, str_equal);
+    close_channel.begin (channel.id, empty, null);
+  }
+
   private void on_proxy_categories_changed (string scope_id, ScopeProxy proxy)
   {
     if (category_merger is CategoryMergerByField)
@@ -1395,7 +1401,8 @@
       uint channel_type,
       HashTable<string, Variant> hints,
       GLib.Cancellable? cancellable,
-      out HashTable<string, Variant> out_hints) throws IOError
+      out HashTable<string, Variant> out_hints,
+      BusName? sender = null) throws IOError
   {
     Unity.AggregatorScope aggscope = owner as Unity.AggregatorScope;
 
@@ -1435,6 +1442,11 @@
     if (channel.transfer_model != null)
     {
       yield Internal.Utils.wait_for_model_synchronization (channel.transfer_model);
+      if (sender != null)
+      {
+        channel.watch_owner (_dbus_connection, sender);
+        channel.owner_lost.connect (this.channel_owner_lost);
+      }
     }
 
     _channels[channel.id] = channel;

=== modified file 'src/unity-deprecated-scope-impl.vala'
--- src/unity-deprecated-scope-impl.vala	2013-07-24 13:15:22 +0000
+++ src/unity-deprecated-scope-impl.vala	2013-09-24 09:09:27 +0000
@@ -608,7 +608,8 @@
       uint channel_type,
       HashTable<string, Variant> hints,
       GLib.Cancellable? cancellable,
-      out HashTable<string, Variant> out_hints) throws IOError
+      out HashTable<string, Variant> out_hints,
+      BusName? sender) throws IOError
   {
     ChannelFlags flags = ChannelFlags.from_hints (hints);
     var channel = new ScopeChannel ((ChannelType) channel_type);

=== modified file 'src/unity-scope-channel.vala'
--- src/unity-scope-channel.vala	2013-07-15 09:56:14 +0000
+++ src/unity-scope-channel.vala	2013-09-24 09:09:27 +0000
@@ -55,6 +55,9 @@
 
   private string last_push_search_string;
   private GLib.List<Dee.SerializableModel> pushed_models = new GLib.List<Dee.SerializableModel> ();
+  private OwnerWatcher? watcher;
+
+  public signal void owner_lost ();
 
   public ScopeChannel (ChannelType channel_type_)
   {
@@ -64,6 +67,14 @@
     model_lock = new Utils.AsyncMutex ();
   }
 
+  ~ScopeChannel ()
+  {
+    if (watcher != null)
+    {
+      watcher.unwatch ();
+    }
+  }
+
   public SearchType get_search_type ()
   {
     SearchType search_type = channel_type == ChannelType.DEFAULT ?
@@ -71,24 +82,19 @@
     return search_type;
   }
 
-  private Dee.SerializableModel create_backend_model (
-    HashTable<string, string> metadata_schema,
-    bool no_filtering,
-    out Dee.SerializableModel real_backend)
+  private static Dee.SerializableModel create_filter_model (
+      Dee.Model backend, HashTable<string, string> metadata_schema)
   {
-    var backend = new Dee.SequenceModel ();
-    real_backend = backend;
-    if (no_filtering || metadata_schema.size () == 0) return backend;
-
     var types = new HashTable<string, VariantType> (str_hash, str_equal);
     metadata_schema.for_each ((field, schema) =>
     {
       types[field] = new VariantType (schema);
     });
+
     var model = new Dee.FilterModel (
       backend, Dee.Filter.new (
         () => {}, // no need for map func, the model is empty on creation
-        (orig_model, iter, filter_model) => 
+        (orig_model, iter, filter_model) =>
         {
           // check that the row contains all required metadata
           var metadata = orig_model.get_value (iter, METADATA_COLUMN);
@@ -112,6 +118,18 @@
     return model;
   }
 
+  private Dee.SerializableModel create_backend_model (
+      HashTable<string, string> metadata_schema,
+      bool no_filtering,
+      out Dee.SerializableModel real_backend)
+  {
+    var backend = new Dee.SequenceModel ();
+    real_backend = backend;
+    if (no_filtering || metadata_schema.size () == 0) return backend;
+
+    return create_filter_model (backend, metadata_schema);
+  }
+
   public string create_channel (string swarm_name,
                                 HashTable<string, string> metadata_schema,
                                 HashTable<string, string> optional_metadata,
@@ -277,6 +295,49 @@
 
     return pushed_models.copy ();
   }
+
+  /* Separate class to ensure we don't have reference cycles */
+  private class OwnerWatcher
+  {
+    private uint owner_changed_signal_id;
+    private unowned ScopeChannel owner_channel;
+    private DBusConnection dbus_connection;
+    
+    public OwnerWatcher (ScopeChannel channel, DBusConnection connection, BusName owner)
+    {
+      owner_channel = channel;
+      dbus_connection = connection;
+      owner_changed_signal_id = dbus_connection.signal_subscribe (null,
+          "org.freedesktop.DBus", "NameOwnerChanged", null, owner,
+          DBusSignalFlags.NONE, this.owner_changed);
+    }
+
+    private void owner_changed (DBusConnection con, string sender_name,
+                                string obj_path, string ifc_name,
+                                string sig_name, Variant parameters)
+    {
+      string new_owner = parameters.get_child_value (2).get_string ();
+      if (new_owner == "")
+      {
+        owner_channel.owner_lost ();
+      }
+    }
+
+    public void unwatch ()
+    {
+      if (owner_changed_signal_id != 0)
+      {
+        dbus_connection.signal_unsubscribe (owner_changed_signal_id);
+        owner_changed_signal_id = 0;
+      }
+    }
+  }
+
+  public void watch_owner (DBusConnection connection, BusName owner)
+  {
+    if (watcher != null) watcher.unwatch ();
+    watcher = new OwnerWatcher (this, connection, owner);
+  }
 }
 
 } /* namespace Unity.Internal */

=== modified file 'src/unity-scope-dbus-impl.vala'
--- src/unity-scope-dbus-impl.vala	2013-08-15 15:54:43 +0000
+++ src/unity-scope-dbus-impl.vala	2013-09-24 09:09:27 +0000
@@ -716,7 +716,8 @@
       uint channel_type,
       HashTable<string, Variant> hints,
       GLib.Cancellable? cancellable,
-      out HashTable<string, Variant> out_hints) throws IOError
+      out HashTable<string, Variant> out_hints,
+      BusName? sender) throws IOError
   {
     ChannelFlags flags = ChannelFlags.from_hints (hints);
     var channel = new ScopeChannel ((ChannelType) channel_type);
@@ -740,6 +741,11 @@
     if (channel.transfer_model != null)
     {
       yield Internal.Utils.wait_for_model_synchronization (channel.transfer_model);
+      if (sender != null)
+      {
+        channel.watch_owner (_dbus_connection, sender);
+        channel.owner_lost.connect (this.channel_owner_lost);
+      }
     }
 
     _channels[channel.id] = channel;
@@ -760,6 +766,12 @@
     return channel;
   }
 
+  private void channel_owner_lost (ScopeChannel channel)
+  {
+    var empty = new HashTable<string, Variant> (str_hash, str_equal);
+    close_channel.begin (channel.id, empty, null);
+  }
+
   public async void close_channel (
       string channel_id,
       HashTable<string, Variant> hints,

=== modified file 'src/unity-scope-tracker.vala'
--- src/unity-scope-tracker.vala	2013-07-23 17:40:45 +0000
+++ src/unity-scope-tracker.vala	2013-09-24 09:09:27 +0000
@@ -243,9 +243,36 @@
       synchronizer.receiver.set_qdata<Dee.Model?> (DEDUP_MODEL_QUARK, null);
       synchronizers.remove (master_channel_id);
     }
-    // FIXME: close child scopes' channels
+
+    // close child scopes' channels
+    var channel_keys_to_close = new HashTable<string, ScopeProxy> (str_hash, str_equal);
+    // get all channel_ids associated with this master_channel_id
+    for (int i = 0; i < scope_proxy_arr.length; i++)
+    {
+      var channel_key = get_channel_key (master_channel_id, scope_proxy_arr[i]);
+      if (channel_key in scope_channel_ids)
+      {
+        if (scope_channel_ids[channel_key].get_data () != null)
+        {
+          channel_keys_to_close[channel_key] = scope_proxy_arr[i];
+        }
+      }
+    }
+
+    var iter = HashTableIter<string, ScopeProxy> (channel_keys_to_close);
+    unowned string channel_key;
+    unowned ScopeProxy proxy;
+
+    while (iter.next (out channel_key, out proxy))
+    {
+      var child_channel_id = scope_channel_ids[channel_key].get_data ();
+      if (child_channel_id == null) continue;
+      proxy.close_channel.begin (child_channel_id, null);
+      scope_channel_ids.remove (channel_key);
+      scope_models.remove (channel_key);
+    }
   }
-  
+
   private async void wait_for_seqnum (Dee.SharedModel model, uint64 seqnum)
     throws Error
   {

=== modified file 'tools/unity-tool-ui.vala'
--- tools/unity-tool-ui.vala	2013-03-22 11:41:02 +0000
+++ tools/unity-tool-ui.vala	2013-09-24 09:09:27 +0000
@@ -318,7 +318,7 @@
                   categories_row_added_cb(dee_categories_model, iter);
 
                 var is_global = search_type_global_rbutton.get_active();
-                scope_proxy.open_channel.begin(is_global ? 1 : 0, new HashTable<string, Variant>(null, null), null, (obj, res) =>
+                scope_proxy.open_channel.begin(is_global ? 1 : 0, new HashTable<string, Variant>(null, null), null, null, (obj, res) =>
                 {
                   var proxy = obj as Protocol.ScopeService;
                   HashTable<string, Variant> hints;