Merge lp:~frederik-elwert/askubuntu-lens/add_texdoc_scope into lp:askubuntu-lens

[Frederik Elwert]

I added a scope for searching texdoc. This is packaged as a separate package unity-scope-texdoc.

I did not yet add apparmor support, as I am not very familiar with it. I could need some advice as if this should be added to the scope and how.

[lp:~frederik-elwert/askubuntu-lens/add_texdoc_scope]

57. By Frederik Elwert on 2012-07-20

Handle additional exception when retrieving PDF titles.

[Mark Tully (markjtully)]

Apologies for the really long delay. I've finally got around to doing something about this.

I've created a new source package called unity-lens-help-extras (https://code.launchpad.net/~markjtully/askubuntu-lens/extras) to contain scopes not included in quantal's universe repositories and added this scope and a devhelp scope to it (so far). These are now available either for installation via my PPA or the askubuntu-tools PPA (https://code.launchpad.net/~askubuntu-tools/+archive/ppa).

I've removed all the apparmor stuff from all these scopes for now as it was really only required for submission to the software centre.

Setting this to merged (even though it has been merged to a different branch than specified)

review: Approve

=== modified file '.bzrignore'
--- .bzrignore	2012-06-21 23:43:09 +0000
+++ .bzrignore	2012-07-20 23:01:30 +0000
@@ -19,3 +19,5 @@
 ./debian/unity-scope-asklibreoffice
 ./debian/unity-scope-asklibreoffice.debhelper.log
 ./debian/unity-scope-manpages.debhelper.log
+./debian/unity-scope-texdoc
+./debian/unity-scope-texdoc.debhelper.log

=== modified file 'debian/control'
--- debian/control	2012-07-11 20:15:00 +0000
+++ debian/control	2012-07-20 23:01:30 +0000
@@ -67,6 +67,27 @@
  computer.  After installing this scope, 
  you will need to log out and log back in again in order to use it.
 
+Package: unity-scope-texdoc
+Enhances: unity-lens-help
+Architecture: all
+Depends: ${misc:Depends},
+         python2.7 | python2.6,
+         python (>= 2.6),
+         python (<< 2.8),
+         gir1.2-unity-5.0,
+         gir1.2-dee-1.0,
+         unity-lens-help,
+         texlive-base
+Suggests: apparmor (>= 2.3), python-pypdf
+XB-AppName: TexDoc Scope
+XB-Icon: icons/help-lens-logo.png
+XB-Screenshot-Url: http://software-center.ubuntu.com/site_media/screenshots/2012/01/usc-screenshot.png
+XB-Category: Accessories;
+Description: TeXDoc scope for Help Lens
+ A scope for the Unity Help Lens to search TeX documentation on your
+ computer.  After installing this scope, 
+ you will need to log out and log back in again in order to use it.
+
 Package: unity-scope-sumo
 Enhances: unity-lens-help
 Architecture: all

=== added file 'debian/unity-scope-texdoc.install'
--- debian/unity-scope-texdoc.install	1970-01-01 00:00:00 +0000
+++ debian/unity-scope-texdoc.install	2012-07-20 23:01:30 +0000
@@ -0,0 +1,3 @@
+usr/lib/unity-lens-help/unity-texdoc-daemon
+usr/share/dbus-1/services/unity-scope-texdoc.service
+usr/share/unity/lenses/help/unity-scope-texdoc.scope

=== added directory 'scopes/texdoc'
=== added file 'scopes/texdoc/unity-scope-texdoc.scope'
--- scopes/texdoc/unity-scope-texdoc.scope	1970-01-01 00:00:00 +0000
+++ scopes/texdoc/unity-scope-texdoc.scope	2012-07-20 23:01:30 +0000
@@ -0,0 +1,5 @@
+[Scope]
+DBusName=net.launchpad.scope.help.texdoc
+DBusPath=/net/launchpad/scope/help/texdoc
+ScopeIdentifier=texdoc
+ScopeName=TeXDoc

=== added file 'scopes/texdoc/unity-scope-texdoc.service'
--- scopes/texdoc/unity-scope-texdoc.service	1970-01-01 00:00:00 +0000
+++ scopes/texdoc/unity-scope-texdoc.service	2012-07-20 23:01:30 +0000
@@ -0,0 +1,3 @@
+[D-BUS Service]
+Name=net.launchpad.scope.help.texdoc
+Exec=/usr/lib/unity-lens-help/unity-texdoc-daemon

=== added file 'scopes/texdoc/unity-texdoc-daemon'
--- scopes/texdoc/unity-texdoc-daemon	1970-01-01 00:00:00 +0000
+++ scopes/texdoc/unity-texdoc-daemon	2012-07-20 23:01:30 +0000
@@ -0,0 +1,212 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+"""
+#    Copyright (C) 2012  Frederik Elwert <[e-mail]>
+#                  2012  Pawel Stolowski <[e-mail]>
+#                  2012  Mark Tully <[e-mail]>
+
+#    This program 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 3 of the License, or
+#    (at your option) any later version.
+
+#    This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+
+import sys
+import re
+import os.path
+from subprocess import Popen, PIPE
+from mimetypes import guess_type
+from HTMLParser import HTMLParser
+
+try:
+    from pyPdf import PdfFileReader
+    from pyPdf.utils import PdfReadError
+    pdf_available = True
+except ImportError:
+    pdf_available = False
+
+# Unity imports
+from gi.repository import GLib
+from gi.repository import GObject
+from gi.repository import Gio
+from gi.repository import Gtk
+from gi.repository import Unity
+
+BUS_NAME = "net.launchpad.scope.help.texdoc"
+
+EVERYTHING = 0
+OFFICIAL = 1
+COMMUNITY = 2
+TECHNICAL = 3
+TAGS = 4
+
+TEXDOC_RE = re.compile('^\s*(\d+)\s+(.+?)$')
+
+
+class Daemon (object):
+    """ Manpages Daemon searches manpages for results matching query
+    """
+    def __init__(self):
+        """ Sets up the texdoc scope
+        """
+        self.scope = Unity.Scope.new("/net/launchpad/scope/help/texdoc")
+
+        # Listen for changes and requests
+        self.scope.props.search_in_global = False
+        self.scope.connect("search-changed", self.on_search_changed)
+        self.scope.connect("filters-changed", self.on_filters_changed)
+        self.scope.connect("notify::active", self.on_lens_active)
+        self.scope.export()
+
+    def on_filters_changed(self, *_):
+        """ Called when a filter is clicked.  Queue's a new search
+        """
+        self.scope.queue_search_changed(Unity.SearchType.DEFAULT)
+
+    def on_lens_active(self, *_):
+        """ Called when the lens is activated.  Queue's a new search
+        """
+        if self.scope.props.active:
+            self.scope.queue_search_changed(Unity.SearchType.DEFAULT)
+
+    def on_search_changed(self, scope, search=None, search_type=0, cancellable=None):
+        """ Called when the search is changed.  Gets the search string and search
+        type and passes it to update_results_model()
+        Args:
+          scope: a scope object
+          search: the search string
+          search_type: the search type (global or local)
+          cancellable: cancellable object
+        """
+        if hasattr(search, "props"):
+            search_string = search.props.search_string
+        else:
+            search_string = ""
+
+        if search_type == Unity.SearchType.DEFAULT:
+            results = scope.props.results_model
+        else:
+            results = scope.props.global_results_model
+
+        print "Search changed to: '%s'" % search_string
+        self.update_results_model(search_string, results)
+        if hasattr(search, "finished"):
+            search.finished()
+
+    def update_results_model(self, search, model, _global=False):
+        """ Takes the search string and runs apropos <search string>
+        Parses its results and adds them to the model
+        Args:
+          search: the search string
+          model: the model object that results are added to
+        """
+        model.clear()
+
+        scope_active = False
+        e = self.scope.get_filter("sources")
+        if not e.props.filtering:
+            scope_active = True
+        for source in e.options:
+            if source.props.id == "texdoc":
+                if source.props.active:
+                    scope_active = True
+
+        if scope_active:
+            result = []
+            if len(search) > 2:   # don't run texdoc for strings shorter than 3 chars
+                proc = Popen(["texdoc", "--list", "--nointeract", search],
+                             stdout=PIPE)
+                os.waitpid(proc.pid, 0)
+                out = proc.communicate()[0]
+                for line in out.splitlines():
+                    m = TEXDOC_RE.match(line)
+                    if m:
+                        result.append(m.group(2))
+            for res in result:
+                info = self.get_file_info(res)
+                if info['mimetype']:
+                    # Only handle known file types, otherwise we might get
+                    # Makefiles and things like that.
+                    model.append(info['uri'], info['icon'].to_string(),
+                                 TECHNICAL, info['mimetype'], info['filename'],
+                                 info['title'], info['uri'])
+
+    def get_file_info(self, filepath):
+        info = {}
+        info['uri'] = 'file://' + filepath
+        info['filename'] = os.path.basename(filepath)
+        info['mimetype'] = guess_type(info['uri'])[0] or ''
+        if info['mimetype']:
+            info['icon'] = Gio.content_type_get_icon(info['mimetype'])
+            if info['mimetype'] == 'application/pdf' and pdf_available:
+                info['title'] = self.get_pdf_title(filepath)
+            elif info['mimetype'] == 'text/html':
+                info['title'] = self.get_html_title(filepath)
+            else:
+                info['title'] = ''
+        else:
+            info['icon'] = Gio.ThemedIcon.new('text-x-generic')
+            info['title'] = ''
+        return info
+
+    def get_pdf_title(self, filepath):
+        with open(filepath, 'rb') as pdffile:
+            reader = PdfFileReader(pdffile)
+            try:
+                return reader.documentInfo.title or ''
+            except (PdfReadError, AttributeError):
+                return ''
+
+    def get_html_title(self, filepath):
+
+        class HTMLTitleParser(HTMLParser):
+            def __init__(self):
+                HTMLParser.__init__(self)
+                self.is_title = False
+                self.title_complete = False
+                self.title = ''
+            def handle_starttag(self, tag, attrs):
+                if tag == 'title':
+                    self.is_title = True
+            def handle_data(self, data):
+                if self.is_title:
+                    self.title += data
+            def handle_endtag(self, tag):
+                if tag == 'title':
+                    self.title_complete = True
+                    self.is_title = False
+
+        with open(filepath, 'r') as htmlfile:
+            parser = HTMLTitleParser()
+            for line in htmlfile:
+                parser.feed(line)
+                if parser.title_complete:
+                    return parser.title
+        return ''
+
+
+if __name__ == "__main__":
+    session_bus_connection = Gio.bus_get_sync(Gio.BusType.SESSION, None)
+    session_bus = Gio.DBusProxy.new_sync(session_bus_connection, 0, None,
+        'org.freedesktop.DBus', '/org/freedesktop/DBus',
+        'org.freedesktop.DBus', None)
+    result = session_bus.call_sync('RequestName',
+        GLib.Variant("(su)", (BUS_NAME, 0x4)), 0, -1, None)
+    result = result.unpack()[0]
+    # We could try to do some automated rescue when this happens:
+    if result != 1:
+        print >> sys.stderr, "Failed to own name %s. Bailing out." % BUS_NAME
+        print >> sys.stderr, "Do you have another instance running?"
+        raise SystemExit(1)
+    daemon = Daemon()
+    print "entering the main loop"
+    GObject.MainLoop().run()

=== modified file 'setup.py'
--- setup.py	2012-07-11 20:23:45 +0000
+++ setup.py	2012-07-20 23:01:30 +0000
@@ -18,6 +18,7 @@
         'scopes/yelp/unity-lens-help-daemon',
         'scopes/askubuntu/unity-askubuntu-daemon',
         'scopes/manpages/unity-manpages-daemon',
+        'scopes/texdoc/unity-texdoc-daemon',
         'scopes/sumo/unity-sumo-daemon',
         'scopes/asklibreoffice/unity-asklibreoffice-daemon',
       ],
@@ -25,11 +26,13 @@
         ('/usr/share/unity/lenses/help', ['scopes/yelp/help.lens',
                                           'scopes/askubuntu/unity-scope-askubuntu.scope',
                                           'scopes/manpages/unity-scope-manpages.scope',
+                                          'scopes/texdoc/unity-scope-texdoc.scope',
                                           'scopes/sumo/unity-scope-sumo.scope',
                                           'scopes/asklibreoffice/unity-scope-asklibreoffice.scope']),
         ('/usr/share/dbus-1/services', ['scopes/yelp/unity-lens-help.service',
                                    'scopes/askubuntu/unity-scope-askubuntu.service',
                                    'scopes/manpages/unity-scope-manpages.service',
+                                   'scopes/texdoc/unity-scope-texdoc.service',
                                    'scopes/sumo/unity-scope-sumo.service',
                                    'scopes/asklibreoffice/unity-scope-asklibreoffice.service']),
         ('/etc/apparmor.d', ['scopes/yelp/usr.lib.unity-lens-help.unity-lens-help-daemon',