Merge lp:~voldyman/granite/contractor-wid-dep-new-Contractor into lp:~elementary-pantheon/granite/granite

[Akshay Shekher]

the contractor widgets have been deprecated and the Services/Contractor.vala has been updated to work with the new Contractor API

[Sergey "Shnatsel" Davidoff (shnatsel)]

This seems to break the ABI (according to Rico's check in deb-packaging) even thought it shouldn't.

review: Needs Fixing

[lp:~voldyman/granite/contractor-wid-dep-new-Contractor]

557. By Akshay Shekher on 2013-04-10

Deprecated ContractorView and ContractorMenu. Added support for the new contractor API in services/Contractor.vala

558. By Akshay Shekher on 2013-04-10

Change the constructor of Contractor.vala to private

559. By Akshay Shekher on 2013-04-13

Changed GenericContract to ContractorContract and renamed arguments

560. By Akshay Shekher on 2013-04-13

fixed coding style

561. By Akshay Shekher on 2013-04-18

More OO contractor interface

Unmerged revisions

=== modified file 'demo/main.vala'
--- demo/main.vala	2013-03-20 15:42:25 +0000
+++ demo/main.vala	2013-04-10 16:09:20 +0000
@@ -13,7 +13,7 @@
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
     Lesser General Public License for more details.
- 
+
     You should have received a copy of the GNU Lesser General
     Public License along with this library; if not, write to the
     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
@@ -275,33 +275,6 @@
         right_sep.draw = false;
         right_sep.set_expand (true);
         main_toolbar.insert (right_sep, -1);
-
-        // Contractor
-        var contractor_tab = new Gtk.Box (Gtk.Orientation.VERTICAL, 0);
-        var text_view = new Gtk.TextView ();
-
-        var hash_tables = Granite.Services.Contractor.get_contract ("/.zip", "application/zip");
-        foreach (var hash_table in hash_tables) {
-            text_view.buffer.text += hash_table.lookup ("Name")
-                                  + ": " + hash_table.lookup ("Description")
-                                  + " icon: " + hash_table.lookup ("Exec") + "\n";
-        }
-
-        contractor_tab.add (text_view);
-        contractor_tab.add (new Granite.Widgets.ContractorView ("file:///home/user/file.txt", "text/plain"));
-        var contractor_menu = new Granite.Widgets.ContractorMenu ("/home/user/file.txt", "text");
-        var contractor_button_image = new Gtk.Image.from_icon_name ("document-export",
-                                                                     Gtk.IconSize.LARGE_TOOLBAR);
-        var contractor_tool_item = new Granite.Widgets.ToolButtonWithMenu (contractor_button_image,
-                                                                            "Share", contractor_menu);
-        main_toolbar.insert (contractor_tool_item, -1);
-
-        contractor_tool_item.halign = contractor_tool_item.valign = Gtk.Align.CENTER;
-
-        var contractor_item = new SourceListItem ("Contractor");
-        contractor_item.page_num = page_switcher.append_page (contractor_tab, null);
-        services_category.add (contractor_item);
-
         // Search Entry
         var search_entry = new Granite.Widgets.SearchBar ("Search");
         var search_item = new Gtk.ToolItem ();
@@ -343,42 +316,42 @@
 
     private void show_light_window () {
         var light_window = new Granite.Widgets.LightWindow ();
-        
+
         var light_window_notebook = new Granite.Widgets.StaticNotebook ();
         var entry = new Gtk.Entry ();
         var open_drop = new Gtk.ComboBoxText ();
         var open_lbl = new LLabel ("Alwas Open Mpeg Video Files with Audience");
-        
+
         var grid = new Gtk.Grid ();
         grid.attach (new Gtk.Image.from_icon_name ("video-x-generic", Gtk.IconSize.DIALOG), 0, 0, 1, 2);
         grid.attach (entry, 1, 0, 1, 1);
         grid.attach (new LLabel ("1.13 GB, Mpeg Video File"), 1, 1, 1, 1);
-        
+
         grid.attach (light_window_notebook, 0, 2, 2, 1);
-        
+
         var general = new Gtk.Grid ();
         general.attach (new LLabel.markup ("<b>Info:</b>"), 0, 0, 2, 1);
-        
+
         general.attach (new LLabel.right ("Created:"), 0, 1, 1, 1);
         general.attach (new LLabel.right ("Modified:"), 0, 2, 1, 1);
         general.attach (new LLabel.right ("Opened:"), 0, 3, 1, 1);
         general.attach (new LLabel.right ("Mimetype:"), 0, 4, 1, 1);
         general.attach (new LLabel.right ("Location:"), 0, 5, 1, 1);
-        
+
         general.attach (new LLabel ("Today at 9:50 PM"), 1, 1, 1, 1);
         general.attach (new LLabel ("Today at 9:50 PM"), 1, 2, 1, 1);
         general.attach (new LLabel ("Today at 10:00 PM"), 1, 3, 1, 1);
         general.attach (new LLabel ("video/mpeg"), 1, 4, 1, 1);
         general.attach (new LLabel ("/home/daniel/Downloads"), 1, 5, 1, 1);
-        
+
         general.attach (new LLabel.markup ("<b>Open with:</b>"), 0, 6, 2, 1);
         general.attach (open_drop, 0, 7, 2, 1);
         general.attach (open_lbl, 0, 8, 2, 1);
-        
+
         light_window_notebook.append_page (general, new Gtk.Label ("General"));
         light_window_notebook.append_page (new Gtk.Label ("More"), new Gtk.Label ("More"));
         light_window_notebook.append_page (new Gtk.Label ("Sharing"), new Gtk.Label ("Sharing"));
-        
+
         open_lbl.margin_left = 24;
         open_drop.margin_left = 12;
         open_drop.append ("audience", "Audience");
@@ -389,7 +362,7 @@
         entry.text = "Cool Hand Luke";
         general.column_spacing = 6;
         general.row_spacing = 6;
-        
+
         light_window.add (grid);
         light_window.show_all ();
     }
 
=== modified file 'lib/Services/Contractor.vala'
--- lib/Services/Contractor.vala	2013-04-04 20:05:38 +0000
+++ lib/Services/Contractor.vala	2013-04-10 16:09:20 +0000
@@ -1,5 +1,6 @@
 /***
-    Copyright (C) 2011-2013 Lucas Baudin <[e-mail]>
+    Copyright (C) 2011-2013 Lucas Baudin <[e-mail]>,
+                            Akshay Shekher <[e-mail]>
 
     This program or library is free software; you can redistribute it
     and/or modify it under the terms of the GNU Lesser General Public
@@ -10,7 +11,7 @@
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
     Lesser General Public License for more details.
- 
+
     You should have received a copy of the GNU Lesser General
     Public License along with this library; if not, write to the
     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
@@ -19,86 +20,176 @@
 
 namespace Granite.Services {
 
-    [DBus (name = "org.elementary.contractor")]
-    interface ContractorDBus : Object
-    {
+    public struct GenericContract {
+        string id;
+        string display_name;
+        string description;
+        string icon_path;
+    }
+
+    [DBus (name = "org.elementary.Contractor")]
+    interface ContractorDBus : Object {
+        public abstract GenericContract[] list_all_contracts () throws Error;
+        public abstract GenericContract[] get_contracts_by_mime (string mime_type) throws Error;
+        public abstract GenericContract[] get_contracts_by_mimelist (string[] mime_types) throws Error;
+        public abstract int execute_with_uri (string id, string path) throws Error;
+        public abstract int execute_with_uri_list (string id, string[] path) throws Error;
+        [Deprecated]
         public abstract GLib.HashTable<string,string>[] GetServicesByLocation (string strlocation, string? file_mime="")    throws IOError;
+        [Deprecated]
         public abstract GLib.HashTable<string,string>[] GetServicesByLocationsList (GLib.HashTable<string,string>[] locations)  throws IOError;
     }
 
     /**
      * A way to handle contractor, a way to communicate between apps.
-     * 
-     * /!\ Highly unstable API
+     *
      */
-    public class Contractor : Object
-    {
+    public class Contractor : Object {
 
         internal ContractorDBus contract;
 
         internal static Contractor? contractor = null;
 
         /**
-         * This creates a new Contractor 
+         * This creates a new Contractor
          */
-        public Contractor()
-        {
-            try
-            {
+        public Contractor () {
+            try {
                 contract = Bus.get_proxy_sync (BusType.SESSION,
-                                               "org.elementary.contractor",
+                                               "org.elementary.Contractor",
                                                "/org/elementary/contractor");
-            }
-            catch (IOError e)
-            {
-                stderr.printf ("%s\n", e.message);
-            }
-        }
-
-        internal static void ensure ()
-        {
-            if(contractor == null) contractor = new Contractor ();
-        }
-
-        /**
-         * This searches for available contracts of a particular file
-         * 
+            } catch (IOError e) {
+                stderr.printf ("%s\n", e.message);
+            }
+        }
+
+        internal static void ensure () {
+            if (contractor == null) {
+                contractor = new Contractor ();
+            }
+        }
+        /**
+         * Lists all the contracts
+         *
+         * @return an array of struct GenericContract
+         */
+        public static GenericContract[] list_all_contracts () {
+            ensure ();
+            GenericContract[] contracts = null;
+
+            try {
+                contracts = contractor.contract.list_all_contracts ();
+            } catch (Error e) {
+                stderr.printf ("%s\n", e.message);
+            }
+
+            return contracts;
+        }
+        /**
+         * This searches for available contracts of a particular file
+         *
+         * @param mime mime type of file
+         * @return an array of struct GenericContract
+         */
+        public static GenericContract[] get_contracts_by_mime (string mime_type) {
+            ensure ();
+            GenericContract[] contracts = null;
+
+            try {
+                contracts = contractor.contract.get_contracts_by_mime (mime_type);
+            } catch (IOError e) {
+                stderr.printf ("%s\n", e.message);
+            }
+
+            return contracts;
+        }
+
+        /**
+         * generate contracts for a list of mime types. the contracts which support
+         * all of them are returned
+         *
+         * @param locations Array of MimeTypes
+         * @return array of struct (GenericContract)
+         */
+        public static GenericContract[] get_contracts_by_mimelist (string[] mime_types) {
+            ensure ();
+            GenericContract[] contracts = null;
+
+            try {
+                contracts = contractor.contract.get_contracts_by_mimelist (mime_types);
+            } catch (IOError e) {
+                stderr.printf ("%s\n", e.message);
+            }
+
+            return contracts;
+        }
+        /**
+         * This executes the exec parameter provided by the contract of given id
+         * with the path as arguments
+         *
+         * @param id id of the contract
+         * @param paths path to execute
+         * @return int status of execution
+         */
+        public static int execute_with_uri (string id, string path) {
+            ensure ();
+            int ret_val = 1;
+
+            try {
+                ret_val = contractor.contract.execute_with_uri (id, path);
+            } catch (Error e) {
+                stderr.printf ("%s\n", e.message);
+            }
+            return ret_val;
+        }
+        /**
+         * This executes the exec parameter provided by the contract of given id
+         * with the paths as arguments
+         *
+         * @param id id of the contract
+         * @param paths array of paths to execute
+         * @return int status of execution
+         */
+        public static int execute_with_uri_list (string id, string[] paths) {
+            ensure ();
+            int ret_val = 1;
+
+            try {
+                ret_val = contractor.contract.execute_with_uri_list (id, paths);
+            } catch (Error e) {
+                stderr.printf ("%s\n", e.message);
+            }
+            return ret_val;
+        }
+        /**
+         * The functions below have been deprecated in order to support the
+         * the new contractor API.
+         */
+
+        /**
+         * This searches for available contracts of a particular file
+         *
          * @param uri uri of file
          * @param mime mime type of file
          * @return Hashtable of available contracts
          */
-        public static GLib.HashTable<string,string>[] get_contract(string uri, string mime)
-        {
-            ensure ();
-            GLib.HashTable<string,string>[] contracts = null;
-
-            try {
-                contracts = contractor.contract.GetServicesByLocation(uri, mime);
-            }catch (IOError e) {
-                stderr.printf ("%s\n", e.message);
-            }
-
-            return contracts;
+        [Deprecated]
+        public static GLib.HashTable<string,string>[] get_contract(string uri, string mime) {
+
+            return { new GLib.HashTable<string,string> (null, null) };
         }
 
         /**
          * generate contracts for rguments and filter them by  common parent mimetype.
-         * 
+         *
          * @param locations Hashtable of locations
          * @return Hashtable of available contracts
          */
-        public static GLib.HashTable<string,string>[] get_selection_contracts (GLib.HashTable<string, string>[] locations)
-        {
-            ensure ();
-            GLib.HashTable<string,string>[] contracts = null;
-
-            try {
-                contracts = contractor.contract.GetServicesByLocationsList (locations);
-            }catch (IOError e) {
-                stderr.printf ("%s\n", e.message);
-            }
-
-            return contracts;
+        [Deprecated]
+        public static GLib.HashTable<string,string>[] get_selection_contracts (GLib.HashTable<string, string>[] locations) {
+
+            return { new GLib.HashTable<string,string> (null, null) };
         }
     }
 }
+
 
=== modified file 'lib/Widgets/ContractorMenu.vala'
--- lib/Widgets/ContractorMenu.vala	2013-03-20 15:42:25 +0000
+++ lib/Widgets/ContractorMenu.vala	2013-04-10 16:09:20 +0000
@@ -10,7 +10,7 @@
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
     Lesser General Public License for more details.
- 
+
     You should have received a copy of the GNU Lesser General
     Public License along with this library; if not, write to the
     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
@@ -20,6 +20,7 @@
 /**
  * This class provides a simple menu for managing Contractor.
  */
+[Deprecated]
 public class Granite.Widgets.ContractorMenu : Gtk.Menu {
     /**
      * The Hashtable of available contracts
@@ -32,12 +33,12 @@
     public delegate void ContractCallback ();
     private string filepath;
     private string filemime;
-    
+
     /**
      * Passes when contract is clicked
      */
     public signal void contract_activated (string contract_name);
-    
+
     /**
      * Makes new Contractor Meu
      *
@@ -49,7 +50,7 @@
         filemime = mime;
         load_items (filename, mime);
     }
-    
+
     /**
      * Adds new item to Contractor Menu
      *
@@ -73,7 +74,7 @@
         insert(item, position);
         item.show ();
     }
-    
+
     /**
      * Deletes a group of menu items
      *
@@ -85,14 +86,14 @@
                 remove (item);
         });
     }
-    
+
     private void load_items (string filename, string mime) {
         contracts = Granite.Services.Contractor.get_contract (filename, mime);
         execs = new Gee.HashMap<string,string> ();
-        
+
         for (int i=0;i<contracts.length;i++) {
             execs[contracts[i].lookup ("Name")] = contracts[i].lookup ("Exec");
-            
+
             var item = new Gtk.ImageMenuItem ();
             item.set_always_show_image (true);
             var image = new Gtk.Image.from_icon_name (contracts[i].lookup ("IconName"), Gtk.IconSize.MENU);
@@ -109,7 +110,7 @@
             item.show_all ();
         }
     }
-    
+
     /**
      * Updates Contractor menu items
      *
@@ -118,24 +119,24 @@
      */
     public void update (string? filename, string? mime) {
         this.foreach ((w) => {remove (w);});
-        
+
         string fn = "";
         string mm = "";
-        
+
         if (filename != null) {
             fn = filename;
             filepath = filename;
         } else {
             fn = filepath;
         }
-        
+
         if (mime != null) {
             mm = mime;
             filemime = mime;
         } else {
             mm = filemime;
         }
-    
+
         load_items (fn, mm);
     }
 }
 
=== modified file 'lib/Widgets/ContractorView.vala'
--- lib/Widgets/ContractorView.vala	2013-03-20 15:42:25 +0000
+++ lib/Widgets/ContractorView.vala	2013-04-10 16:09:20 +0000
@@ -10,7 +10,7 @@
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
     Lesser General Public License for more details.
- 
+
     You should have received a copy of the GNU Lesser General
     Public License along with this library; if not, write to the
     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
@@ -22,20 +22,21 @@
 /**
  * This class provides a simple way to look at contracts from Contractor
  */
+[Deprecated ()]
 public class Granite.Widgets.ContractorView : TreeView {
-    
+
     /**
      * indicates if it was possible to connect to contractor
      */
     public bool contractor_available;
-    
+
     public delegate void ContractCallback ();
     private Gee.HashMap<int, DelegateWrapper?> outsiders;
     private int[] blacklisted_pos;
     private ListStore list;
 
     private struct DelegateWrapper { unowned ContractCallback method; }
-    
+
     /**
      * the index of the currently selected contract
      */
@@ -49,17 +50,17 @@
             this.set_cursor (new TreePath.from_string (value.to_string ()), null, false);
         }
     }
-    
+
     /**
      * A contract was launched using double clicking
      */
     public signal void executed ();
-    
+
     /**
      * the original array of contracts returned by contractor
      */
     HashTable<string,string>[] contracts;
-    
+
     /**
      * Create the default ContractorView
      *
@@ -73,17 +74,17 @@
         list = new ListStore (2, typeof (Gdk.Pixbuf), typeof (string));
         outsiders = new Gee.HashMap<int, DelegateWrapper?> ();
         this.model = list;
-        
+
         /* GUI */
         this.headers_visible = false;
         this.hexpand = true;
-        
+
         /* Events */
-        row_activated.connect (() => { 
+        row_activated.connect (() => {
             run_selected ();
             executed ();
         });
-        
+
         /* View */
         var cell1 = new CellRendererPixbuf ();
         cell1.set_padding (5, 8);
@@ -102,9 +103,9 @@
             string message = contractor_installed ? _("Could not contact Contractor. You may need to install it") : _("No action found for this file");
             try {
                 var icon = IconTheme.get_default ().load_icon (
-                    contractor_installed ? Gtk.Stock.DIALOG_ERROR : Gtk.Stock.DIALOG_INFO, 
+                    contractor_installed ? Gtk.Stock.DIALOG_ERROR : Gtk.Stock.DIALOG_INFO,
                     icon_size, 0);
-                list.set (it, 
+                list.set (it,
                     0, icon, 1, message);
             }
             catch (Error e) {
@@ -114,7 +115,7 @@
         }
         else {
             contractor_available = true;
-            
+
             for (var i=0; i<this.contracts.length; i++){
                 TreeIter it;
                 list.append (out it);
@@ -122,8 +123,8 @@
                 if (show_contract_name)
                     text = "<b>"+this.contracts[i].lookup ("Name")+"</b>\n"+text;
                 try{
-                    list.set (it, 
-                        0, IconTheme.get_default ().load_icon (this.contracts[i].lookup ("IconName"), 
+                    list.set (it,
+                        0, IconTheme.get_default ().load_icon (this.contracts[i].lookup ("IconName"),
                         icon_size, 0), 1, text);
                 }
                 catch (Error e) {
@@ -133,7 +134,7 @@
             this.selected = 0;
         }
     }
-    
+
     /**
      * A method to add items to the tree
      *
@@ -148,21 +149,21 @@
     public void add_item (string name, string desc, string icon_name, int icon_size, int position, ContractCallback method) {
         TreeIter it;
         list.insert (out it, position);
-        
+
         string text = "<b>" + name + "</b>\n" + desc;
-        
+
         try{
             list.set (it, 0, IconTheme.get_default ().load_icon (icon_name, icon_size, 0), 1, text);
         } catch (Error e) {
             error (e.message);
         }
-        
+
         DelegateWrapper wr = { method };
         outsiders[position] = wr;
-        
+
         this.selected = 0;
     }
-    
+
     public void name_blacklist (string[] names) {
         TreeIter it;
         TreeIter it2;
@@ -171,25 +172,25 @@
         int cur_pos = 0;
         list.get_iter_first (out it);
         list.get_iter_first (out it2);
-        
+
         while (true) {
 	        list.get_value (it, 1, out value);
 	        check = list.iter_next (ref it2);
 	        string text = value.get_string ();
-	        
+
 	        if (text[3:text.index_of ("</b>")] in names) {
 	            list.remove (it);
 	            blacklisted_pos += cur_pos;
             }
 	        if (!check)
 	            break;
-	            
+
             it = it2;
-	        cur_pos++;	            
+	        cur_pos++;
         }
     }
-        
-    
+
+
     public void run_selected () {
         if (this.selected in outsiders.keys ) {
             outsiders[this.selected].method ();