Attachment 893992 Details for Bug 1096162 – Patch to add a working caja plugin

[patch] Patch to add a working caja plugin

rabbitvcs-0.16-cajastaticgobject.patch (text/plain), 22.45 KB, created by Patrick Monnerat on 2014-05-09 10:22:38 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Patrick Monnerat

Created: 2014-05-09 10:22:38 UTC

Size: 22.45 KB

patch

obsolete

>diff -Naurp rabbitvcs-0.16.orig/clients/caja-staticgobject/RabbitVCS.py rabbitvcs-0.16.new/clients/caja-staticgobject/RabbitVCS.py
>--- rabbitvcs-0.16.orig/clients/caja-staticgobject/RabbitVCS.py	1970-01-01 01:00:00.000000000 +0100
>+++ rabbitvcs-0.16.new/clients/caja-staticgobject/RabbitVCS.py	2014-03-31 19:30:10.580404225 +0200
>@@ -0,0 +1,607 @@
>+#
>+# This is an extension to the Caja file manager to allow better
>+# integration with the Subversion source control system.
>+#
>+# Copyright (C) 2006-2008 by Jason Field <jason@jasonfield.com>
>+# Copyright (C) 2007-2008 by Bruce van der Kooij <brucevdkooij@gmail.com>
>+# Copyright (C) 2008-2008 by Adam Plumb <adamplumb@gmail.com>
>+#
>+# RabbitVCS is free software; you can redistribute it and/or modify
>+# it under the terms of the GNU General Public License as published by
>+# the Free Software Foundation; either version 2 of the License, or
>+# (at your option) any later version.
>+#
>+# RabbitVCS is distributed in the hope that it will be useful,
>+# but WITHOUT ANY WARRANTY; without even the implied warranty of
>+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>+# GNU General Public License for more details.
>+#
>+# You should have received a copy of the GNU General Public License
>+# along with RabbitVCS;  If not, see <http://www.gnu.org/licenses/>.
>+#
>+
>+"""
>+
>+Our module for everything related to the Caja extension.
>+
>+"""
>+from __future__ import with_statement
>+
>+def log_all_exceptions(type, value, tb):
>+    import sys, traceback
>+    from rabbitvcs.util.log import Log
>+    log = Log("rabbitvcs.util.extensions.caja.RabbitVCS")
>+    log.exception_info("Error caught by master exception hook!",
>+                       (type, value, tb))
>+
>+    text = ''.join(traceback.format_exception(type, value,
>+                                              tb, limit=None))
>+
>+    try:
>+        import rabbitvcs.ui.dialog
>+        rabbitvcs.ui.dialog.ErrorNotification(text)
>+    except Exception, ex:
>+        log.exception("Additional exception when attempting"
>+                      " to display error dialog.")
>+        log.exception(ex)
>+        raise
>+
>+    sys.__excepthook__(type, value, tb)
>+
>+# import sys
>+# sys.excepthook = log_all_exceptions
>+
>+import copy
>+import os.path
>+from os.path import isdir, isfile, realpath, basename
>+import datetime
>+
>+import caja
>+import pysvn
>+import gobject
>+import gtk
>+
>+from rabbitvcs.vcs import VCS
>+import rabbitvcs.vcs.status
>+
>+from rabbitvcs.util.helper import launch_ui_window, launch_diff_tool
>+from rabbitvcs.util.helper import get_file_extension, get_common_directory
>+from rabbitvcs.util.helper import pretty_timedelta
>+from rabbitvcs.util.decorators import timeit, disable
>+from rabbitvcs.util.contextmenu import MenuBuilder, MainContextMenu, SEPARATOR, ContextMenuConditions
>+
>+import rabbitvcs.ui
>+import rabbitvcs.ui.property_page
>+
>+from rabbitvcs.util.log import Log, reload_log_settings
>+log = Log("rabbitvcs.util.extensions.caja.RabbitVCS")
>+
>+from rabbitvcs import gettext
>+_ = gettext.gettext
>+
>+from rabbitvcs import version as EXT_VERSION
>+
>+from rabbitvcs.util.settings import SettingsManager
>+settings = SettingsManager()
>+
>+import rabbitvcs.services.service
>+from rabbitvcs.services.checkerservice import StatusCheckerStub as StatusChecker
>+
>+class RabbitVCS(caja.InfoProvider, caja.MenuProvider,
>+                 caja.ColumnProvider, caja.PropertyPageProvider):
>+    """
>+    This is the main class that implements all of our awesome features.
>+
>+    """
>+
>+    #: This is our lookup table for C{CajaVFSFile}s which we need for attaching
>+    #: emblems. This is mostly a workaround for not being able to turn a path/uri
>+    #: into a C{CajaVFSFile}. It looks like:::
>+    #:
>+    #:     cajaVFSFile_table = {
>+    #:        "/foo/bar/baz": <CajaVFSFile>
>+    #:
>+    #:     }
>+    #:
>+    #: Keeping track of C{CajaVFSFile}s is a little bit complicated because
>+    #: when an item is moved (renamed) C{update_file_info} doesn't get called. So
>+    #: we also add C{CajaVFSFile}s to this table from C{get_file_items} etc.
>+    # FIXME: this may be the source of the memory hogging seen in the extension
>+    # script itself.
>+    cajaVFSFile_table = {}
>+
>+    #: This is in case we want to permanently enable invalidation of the status
>+    #: checker info.
>+    always_invalidate = True
>+
>+    #: When we get the statuses from the callback, put them here for further
>+    #: use. This is of the form: [("path/to", {...status dict...}), ...]
>+    statuses_from_callback = []
>+
>+    def get_local_path(self, path):
>+        return path.replace("file://", "")
>+
>+    def __init__(self):
>+        # Create a global client we can use to do VCS related stuff
>+        self.vcs_client = VCS()
>+
>+        self.status_checker = StatusChecker()
>+        
>+        self.status_checker.assert_version(EXT_VERSION)
>+        
>+        self.items_cache = {}
>+        
>+    def get_columns(self):
>+        """
>+        Return all the columns we support.
>+
>+        """
>+
>+        return (
>+            caja.Column(
>+                "RabbitVCS::status_column",
>+                "status",
>+                _("RVCS Status"),
>+                ""
>+            ),
>+            caja.Column(
>+                "RabbitVCS::revision_column",
>+                "revision",
>+                _("RVCS Revision"),
>+                ""
>+            ),
>+            caja.Column(
>+                "RabbitVCS::author_column",
>+                "author",
>+                _("RVCS Author"),
>+                ""
>+            ),
>+            caja.Column(
>+                "RabbitVCS::age_column",
>+                "age",
>+                _("RVCS Age"),
>+                ""
>+            )
>+        )
>+
>+    def update_file_info(self, item):
>+        """
>+
>+        C{update_file_info} is called only when:
>+
>+          - When you enter a directory (once for each item but only when the
>+            item was modified since the last time it was listed)
>+          - When you refresh (once for each item visible)
>+          - When an item viewable from the current window is created or modified
>+
>+        This is insufficient for our purpose because:
>+
>+          - You're not notified about items you don't see (which is needed to
>+            keep the emblem for the directories above the item up-to-date)
>+
>+        @type   item: CajaVFSFile
>+        @param  item:
>+
>+        """
>+        enable_emblems = bool(int(settings.get("general", "enable_emblems")))
>+        enable_attrs = bool(int(settings.get("general", "enable_attributes")))
>+        
>+        if not (enable_emblems or enable_attrs): return caja.OPERATION_COMPLETE
>+                
>+        if not self.valid_uri(item.get_uri()): return caja.OPERATION_FAILED
>+        
>+        path = rabbitvcs.util.helper.unquote_url(self.get_local_path(item.get_uri()))
>+
>+        # log.debug("update_file_info() called for %s" % path)
>+
>+        invalidate = False
>+        if path in self.cajaVFSFile_table:
>+            invalidate = True
>+
>+        # Always replace the item in the table with the one we receive, because
>+        # for example if an item is deleted and recreated the CajaVFSFile
>+        # we had before will be invalid (think pointers and such).
>+        self.cajaVFSFile_table[path] = item
>+
>+        # This check should be pretty obvious :-)
>+        # TODO: how come the statuses for a few directories are incorrect
>+        # when we remove this line (detected as working copies, even though
>+        # they are not)? That shouldn't happen.
>+        is_in_a_or_a_working_copy = self.vcs_client.is_in_a_or_a_working_copy(path)
>+        if not is_in_a_or_a_working_copy: return caja.OPERATION_COMPLETE
>+
>+        # Do our magic...
>+
>+        # I have added extra logic in cb_status, using a list
>+        # (paths_from_callback) that should allow us to work around this for
>+        # now. But it'd be good to have an actual status monitor.
>+
>+        found = False
>+        status = None
>+        # Could replace with (st for st in self.... if st.path ...).next()
>+        # Need to catch exception
>+        for idx in xrange(len(self.statuses_from_callback)):
>+            found = (self.statuses_from_callback[idx].path) == path
>+            if found: break
>+
>+        if found: # We're here because we were triggered by a callback
>+            status = self.statuses_from_callback[idx]
>+            del self.statuses_from_callback[idx]
>+
>+        # Don't bother the checker if we already have the info from a callback
>+        if not found:
>+            status = \
>+                self.status_checker.check_status(path,
>+                                                 recurse=True,
>+                                                 summary=True,
>+                                                 callback=self.cb_status,
>+                                                 invalidate=invalidate)
>+
>+        # FIXME: when did this get disabled?
>+        if enable_attrs: self.update_columns(item, path, status)
>+        if enable_emblems: self.update_status(item, path, status)
>+        
>+        return caja.OPERATION_COMPLETE
>+
>+    def update_columns(self, item, path, status):
>+        """
>+        Update the columns (attributes) for a given Caja item,
>+        filling them in with information from the version control
>+        server.
>+
>+        """
>+
>+        revision = ""
>+        if status.revision:
>+            revision = str(status.revision)
>+
>+        age = ""
>+        if status.date:
>+            age = pretty_timedelta(
>+                datetime.datetime.fromtimestamp(status.date),
>+                datetime.datetime.now()
>+            )
>+
>+        author = ""
>+        if status.author:
>+            author = str(status.author)
>+
>+        values = {
>+            "status": status.simple_content_status(),
>+            "revision": revision,
>+            "author": author,
>+            "age": age
>+        }
>+
>+        for key, value in values.items():
>+            item.add_string_attribute(key, value)
>+
>+    def update_status(self, item, path, status):
>+        import rabbitvcs.ui
>+        if status.summary in rabbitvcs.ui.STATUS_EMBLEMS:
>+            item.add_emblem(rabbitvcs.ui.STATUS_EMBLEMS[status.summary])
>+
>+    #~ @disable
>+    # @timeit
>+    # FIXME: this is a bottleneck. See generate_statuses() in
>+    # MainContextMenuConditions.
>+    def get_file_items_full(self, provider, window, items):
>+        """
>+        Menu activated with items selected. Caja also calls this function
>+        when rendering submenus, even though this is not needed since the entire
>+        menu has already been returned.
>+
>+        Note that calling C{cajaVFSFile.invalidate_extension_info()} will
>+        also cause get_file_items to be called.
>+
>+        @type   window: CajaNavigationWindow
>+        @param  window:
>+
>+        @type   items:  list of CajaVFSFile
>+        @param  items:
>+
>+        @rtype:         list of MenuItems
>+        @return:        The context menu entries to add to the menu.
>+
>+        """
>+
>+        paths = []
>+        for item in items:
>+            if self.valid_uri(item.get_uri()):
>+                path = rabbitvcs.util.helper.unquote_url(self.get_local_path(item.get_uri()))
>+                paths.append(path)
>+                self.cajaVFSFile_table[path] = item
>+
>+        if len(paths) == 0: return []
>+        
>+        # log.debug("get_file_items_full() called")
>+
>+        paths_str = "-".join(paths)
>+        
>+        conditions_dict = None
>+        if paths_str in self.items_cache:
>+            conditions_dict = self.items_cache[paths_str]
>+            if conditions_dict and conditions_dict != "in-progress":
>+                conditions = CajaMenuConditions(conditions_dict)
>+                menu = CajaMainContextMenu(self, window.get_data("base_dir"), paths, conditions).get_menu()
>+                return menu
>+        
>+        if conditions_dict != "in-progress":
>+            self.status_checker.generate_menu_conditions_async(provider, window.get_data("base_dir"), paths, self.update_file_items)        
>+            self.items_cache[path] = "in-progress"
>+            
>+        return ()
>+
>+    def get_file_items(self, window, items):
>+        paths = []
>+        for item in items:
>+            if self.valid_uri(item.get_uri()):
>+                path = rabbitvcs.util.helper.unquote_url(self.get_local_path(item.get_uri()))
>+                paths.append(path)
>+                self.cajaVFSFile_table[path] = item
>+
>+        if len(paths) == 0: return []
>+        
>+        # log.debug("get_file_items() called")
>+        
>+        return CajaMainContextMenu(self, window.get_data("base_dir"), paths).get_menu()
>+
>+    def update_file_items(self, provider, base_dir, paths, conditions_dict):
>+        paths_str = "-".join(paths)
>+        self.items_cache[paths_str] =  conditions_dict
>+        self.emit_items_updated_signal(provider)
>+
>+    #~ @disable
>+    # This is useful for profiling. Rename it to "get_background_items" and then
>+    # rename the real function "get_background_items_real". 
>+    def get_background_items_profile(self, window, item):
>+        import cProfile
>+        import rabbitvcs.util.helper
>+        
>+        path = rabbitvcs.util.helper.unquote_url(self.get_local_path(item.get_uri())).replace("/", ":")
>+        
>+        profile_data_file = os.path.join(
>+                               rabbitvcs.util.helper.get_home_folder(),
>+                               "checkerservice_%s.stats" % path)
>+        
>+        prof = cProfile.Profile()
>+        retval = prof.runcall(self.get_background_items_real, window, item)
>+        prof.dump_stats(profile_data_file)
>+        log.debug("Dumped: %s" % profile_data_file)
>+        return retval
>+       
>+    def get_background_items_full(self, provider, window, item):
>+        """
>+        Menu activated on entering a directory. Builds context menu for File
>+        menu and for window background.
>+
>+        @type   window: CajaNavigationWindow
>+        @param  window:
>+
>+        @type   item:   CajaVFSFile
>+        @param  item:
>+
>+        @rtype:         list of MenuItems
>+        @return:        The context menu entries to add to the menu.
>+
>+        """
>+
>+        if not self.valid_uri(item.get_uri()): return
>+        path = rabbitvcs.util.helper.unquote_url(self.get_local_path(item.get_uri()))
>+        self.cajaVFSFile_table[path] = item
>+
>+        # log.debug("get_background_items_full() called")
>+
>+        conditions_dict = None
>+        if path in self.items_cache:
>+            conditions_dict = self.items_cache[path]
>+            if conditions_dict and conditions_dict != "in-progress":
>+                conditions = CajaMenuConditions(conditions_dict)
>+                menu = CajaMainContextMenu(self, path, [path], conditions).get_menu()                
>+                return menu
>+
>+        window.set_data("base_dir", path)
>+
>+        if conditions_dict != "in-progress":
>+            self.status_checker.generate_menu_conditions_async(provider, path, [path], self.update_background_items)
>+            self.items_cache[path] = "in-progress"
>+                    
>+        return ()
>+
>+    def get_background_items(self, window, item):
>+        if not self.valid_uri(item.get_uri()): return
>+        path = rabbitvcs.util.helper.unquote_url(self.get_local_path(item.get_uri()))
>+        self.cajaVFSFile_table[path] = item
>+
>+        # log.debug("get_background_items() called")
>+        
>+        window.set_data("base_dir", path)
>+        
>+        return CajaMainContextMenu(self, path, [path]).get_menu()
>+
>+    def update_background_items(self, provider, base_dir, paths, conditions_dict):
>+        paths_str = "-".join(paths)
>+        conditions = CajaMenuConditions(conditions_dict)
>+        self.items_cache[paths_str] =  conditions_dict
>+        self.emit_items_updated_signal(provider)
>+
>+    #
>+    # Helper functions
>+    #
>+
>+    def valid_uri(self, uri):
>+        """
>+        Check whether or not it's a good idea to have RabbitVCS do
>+        its magic for this URI. Some examples of URI schemes:
>+
>+        x-caja-desktop:/// # e.g. mounted devices on the desktop
>+
>+        """
>+
>+        if not uri.startswith("file://"): return False
>+
>+        return True
>+
>+    #
>+    # Some methods to help with keeping emblems up-to-date
>+    #
>+
>+    def rescan_after_process_exit(self, proc, paths):
>+
>+        def do_check():
>+            # We'll check the paths first (these were the paths that
>+            # were originally passed along to the context menu).
>+            #
>+            # This is needed among other things for:
>+            #
>+            #   - When a directory is normal and you add files inside it
>+            #
>+            for path in paths:
>+                # We're not interested in the result now, just the callback
>+                self.status_checker.check_status(path,
>+                                                 recurse=True,
>+                                                 invalidate=True,
>+                                                 callback=self.cb_status,
>+                                                 summary=True)
>+
>+        self.execute_after_process_exit(proc, do_check)
>+
>+    def execute_after_process_exit(self, proc, func=None):
>+
>+        def is_process_still_alive():
>+            log.debug("is_process_still_alive() for pid: %i" % proc.pid)
>+            # First we need to see if the commit process is still running
>+
>+            retval = proc.poll()
>+
>+            log.debug("%s" % retval)
>+
>+            still_going = (retval is None)
>+
>+            if not still_going and callable(func):
>+                func()
>+
>+            return still_going
>+
>+        # Add our callback function on a 1 second timeout
>+        gobject.timeout_add_seconds(1, is_process_still_alive)
>+
>+    #
>+    # Some other methods
>+    #
>+
>+    def reload_settings(self, proc):
>+        """
>+        Used to re-load settings after the settings dialog has been closed.
>+
>+        FIXME: This probably doesn't belong here, ideally the settings manager
>+        does this itself and make sure everything is reloaded properly
>+        after the settings dialogs saves.
>+        """
>+
>+        def do_reload_settings():
>+            globals()["settings"] = SettingsManager()
>+            globals()["log"] = reload_log_settings()("rabbitvcs.util.extensions.caja")
>+            log.debug("Re-scanning settings")
>+
>+        self.execute_after_process_exit(proc, do_reload_settings)
>+
>+
>+    #
>+    # Callbacks
>+    #
>+
>+    def cb_status(self, status):
>+        """
>+        This is the callback that C{StatusMonitor} calls.
>+
>+        @type   path:   string
>+        @param  path:   The path of the item something interesting happened to.
>+
>+        @type   statuses: list of status objects
>+        @param  statuses: The statuses
>+        """
>+        if status.path in self.cajaVFSFile_table:
>+            item = self.cajaVFSFile_table[status.path]
>+            # We need to invalidate the extension info for only one reason:
>+            #
>+            # - Invalidating the extension info will cause Caja to remove all
>+            #   temporary emblems we applied so we don't have overlay problems
>+            #   (with ourselves, we'd still have some with other extensions).
>+            #
>+            # After invalidating C{update_file_info} applies the correct emblem.
>+            # Since invalidation triggers an "update_file_info" call, we can
>+            # tell it NOT to invalidate the status checker path.
>+            self.statuses_from_callback.append(status)
>+            # NOTE! There is a call to "update_file_info" WITHIN the call to
>+            # invalidate_extension_info() - beware recursion!
>+            item.invalidate_extension_info()
>+            if status.path in self.items_cache:
>+                del self.items_cache[status.path]
>+        else:
>+            log.debug("Path [%s] not found in file table" % status.path)
>+
>+    def get_property_pages(self, items):
>+
>+        paths = []
>+
>+        for item in items:
>+            if self.valid_uri(item.get_uri()):
>+                path = rabbitvcs.util.helper.unquote_url(self.get_local_path(item.get_uri()))
>+                
>+                if self.vcs_client.is_in_a_or_a_working_copy(path):
>+                    paths.append(path)
>+                    self.cajaVFSFile_table[path] = item
>+
>+        if len(paths) == 0: return []
>+
>+        label = rabbitvcs.ui.property_page.PropertyPageLabel(claim_domain=False).get_widget()
>+        page = rabbitvcs.ui.property_page.PropertyPage(paths, claim_domain=False).get_widget()
>+
>+        ppage = caja.PropertyPage('RabbitVCS::PropertyPage',
>+            label,
>+            page)
>+
>+        return [ppage]
>+
>+
>+from rabbitvcs.util.contextmenuitems import *
>+
>+class CajaContextMenu(MenuBuilder):
>+    """
>+    Provides a standard Caja context menu (ie. a list of
>+    "caja.MenuItem"s).
>+    """
>+
>+    signal = "activate"
>+
>+    def make_menu_item(self, item, id_magic):
>+        identifier = item.make_magic_id(id_magic)
>+
>+        menuitem = caja.MenuItem(
>+            name=identifier,
>+            label=item.make_label(),
>+            tip=item.tooltip,
>+            icon=item.icon
>+        )
>+
>+        if type(item) is MenuSeparator:
>+            item.make_insensitive(menuitem)
>+
>+        return menuitem
>+
>+    def attach_submenu(self, menu_node, submenu_list):
>+        submenu = caja.Menu()
>+        menu_node.set_submenu(submenu)
>+        [submenu.append_item(item) for item in submenu_list]
>+
>+    def top_level_menu(self, items):
>+        return items
>+
>+class CajaMenuConditions(ContextMenuConditions):
>+    def __init__(self, path_dict):
>+        self.path_dict = path_dict
>+
>+class CajaMainContextMenu(MainContextMenu):
>+    def get_menu(self):
>+        return CajaContextMenu(self.structure, self.conditions, self.callbacks).menu
>diff -Naurp rabbitvcs-0.16.orig/clients/caja-staticgobject/README rabbitvcs-0.16.new/clients/caja-staticgobject/README
>--- rabbitvcs-0.16.orig/clients/caja-staticgobject/README	1970-01-01 01:00:00.000000000 +0100
>+++ rabbitvcs-0.16.new/clients/caja-staticgobject/README	2014-02-16 10:07:47.000000000 +0100
>@@ -0,0 +1,28 @@
>+RabbitVCS Caja Extension
>+
>+This extension is meant to be used with the Caja (MATE) File Manager,
>+
>+Requirements:
>+    * caja
>+    * caja-python
>+    * python-dbus (> 0.80)
>+    * (all other RabbitVCS requirements)
>+
>+To install:
>+    To install for all users, copy RabbitVCS.py to:
>+        /usr/share/caja-python/extensions
>+    
>+    To install for a single user, copy RabbitVCS.py to:
>+        ~/.local/share/caja-python/extensions
>+    
>+    In both cases, you may need to create the caja-python/extensions folder.
>+    
>+    Restart nemo with the following commands:
>+        $ caja -q
>+        $ nohup caja > /dev/null &
>+
>+Troubleshooting:
>+
>+    See the known-issues section of our website:
>+        http://wiki.rabbitvcs.org/wiki/support/known-issues
>+

Actions: View | Diff

Attachments on bug 1096162: 893992 | 893993