1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
|
#! /usr/bin/python3
# -*- coding: utf-8 -*-
# Copyright(C) 2013 Mark Tully <markjtully@gmail.com>
# This program is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License version 3, as published
# by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranties of
# MERCHANTABILITY, SATISFACTORY QUALITY, 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 gettext
import html
import locale
import os
from xml.etree import cElementTree as ET
from gi.repository import GLib, Gio
from gi.repository import Unity
APP_NAME = 'unity-scope-yelp'
LOCAL_PATH = '/usr/share/locale/'
locale.setlocale(locale.LC_ALL, '')
gettext.bindtextdomain(APP_NAME, LOCAL_PATH)
gettext.textdomain(APP_NAME)
_ = gettext.gettext
GROUP_NAME = 'com.canonical.Unity.Scope.Help.Yelp'
UNIQUE_PATH = '/com/canonical/unity/scope/help/yelp'
SEARCH_HINT = _('Ubuntu Help')
NO_RESULTS_HINT = _('Sorry, there are no Ubuntu Help results that match your search.')
PROVIDER_CREDITS = _('')
SVG_DIR = '/usr/share/icons/unity-icon-theme/places/svg/'
PROVIDER_ICON = SVG_DIR + 'service-yelp.svg'
DEFAULT_RESULT_ICON = SVG_DIR + 'result-help.svg'
DEFAULT_RESULT_MIMETYPE = 'text/html'
DEFAULT_RESULT_TYPE = Unity.ResultType.DEFAULT
HELP_DIR = "/usr/share/help/"
YELP_CACHE = None
MAX_RESULTS = 25
YELP_EXECUTABLE = '/usr/bin/yelp'
c1 = {'id': 'help',
'name': _('Official Help Documents'),
'icon': SVG_DIR + 'group-installed.svg',
'renderer': Unity.CategoryRenderer.VERTICAL_TILE}
CATEGORIES = [c1]
FILTERS = []
m1 = {'id' :'manual',
'type' :'s',
'field':Unity.SchemaFieldType.OPTIONAL}
EXTRA_METADATA = [m1]
def _get_manuals_in_dir(dir, manuals):
"""Yield the manuals found in the given directory, omitting those
that have already been discovered."""
if not os.path.isdir(dir):
return
for manual in os.listdir(dir):
if manual in manuals:
continue
manualdir = os.path.join(dir, manual)
if os.path.isdir(manualdir):
manuals.add(manual)
yield manualdir
def get_manuals(helpdir):
"""Get the manuals found in the given directory according to the
user's locale."""
language, encoding = locale.getlocale()
manuals = set()
if language is not None:
languagedir = os.path.join(helpdir, language)
yield from _get_manuals_in_dir(languagedir, manuals)
# If the locale includes a country, look for manuals
if language[:2] != language:
languagedir = os.path.join(helpdir, language[:2])
yield from _get_manuals_in_dir(languagedir, manuals)
# Now return untranslated versions of remaining manuals.
languagedir = os.path.join(helpdir, 'C')
yield from _get_manuals_in_dir(languagedir, manuals)
def get_yelp_documents():
'''
Parses local help files for <desc> and 1st <title> tags and associates
them with the page's uri in self.data as: {uri, page description, page title}
If a help file has no <desc> or <title> tag, it is excluded.
'''
data = []
namespaces = {'m': 'http://projectmallard.org/1.0/'}
for manualdir in get_manuals(HELP_DIR):
for filename in os.listdir(manualdir):
filename = os.path.join(manualdir, filename)
if not (filename.endswith('page') and os.path.isfile(filename)):
continue
try:
tree = ET.parse(filename)
except ET.ParseError:
# Not an XML file
continue
if (tree.getroot().tag != '{http://projectmallard.org/1.0/}page' or
tree.getroot().get('type') != 'topic'):
# Not a Mallard documentation file.
continue
title = desc = ""
node = tree.find('m:title', namespaces)
if node is not None:
title = node.text
node = tree.find('m:info/m:desc', namespaces)
if node is not None:
desc = ''.join(node.itertext())
desc = desc.strip(' \t\n\r')
if desc == "":
desc = title
data.append((filename, title, desc, os.path.basename(manualdir)))
return data
def search(search, filters):
'''
Search for help documents matching the search string
'''
results = []
if len(search) < 2:
return results
global YELP_CACHE
if not YELP_CACHE:
YELP_CACHE = get_yelp_documents()
help_data = YELP_CACHE
search = search.lower()
for (filename, title, desc, manual) in help_data:
if len(results) >= MAX_RESULTS:
break
try:
if manual == "ubuntu-help":
icon_hint = Gio.ThemedIcon.new("distributor-logo").to_string()
else:
icon_hint = Gio.ThemedIcon.new(manual).to_string()
except:
icon_hint = Gio.ThemedIcon.new("help").to_string()
manual = "ubuntu-help"
if (search in title.lower() or
search in desc.lower() or
search in manual.lower()):
results.append({'uri': filename,
'icon': icon_hint,
'title': title,
'comment': desc,
'manual': manual.title()})
return results
class Previewer(Unity.ResultPreviewer):
def do_run(self):
image = Gio.ThemedIcon.new(self.result.icon_hint)
preview = Unity.GenericPreview.new(
self.result.title, html.escape(self.result.comment), image)
if self.result.metadata:
preview.props.subtitle = self.result.metadata['manual'].get_string()
icon = Gio.FileIcon.new (Gio.file_new_for_path(PROVIDER_ICON))
action = Unity.PreviewAction.new("open", _("Open"), icon)
preview.add_action(action)
return preview
# Classes below this point establish communication
# with Unity, you probably shouldn't modify them.
class MySearch(Unity.ScopeSearchBase):
def __init__(self, search_context):
super(MySearch, self).__init__()
self.set_search_context(search_context)
def do_run(self):
'''
Adds results to the model
'''
try:
result_set = self.search_context.result_set
for i in search(self.search_context.search_query,
self.search_context.filter_state):
if not 'uri' in i or not i['uri'] or i['uri'] == '':
continue
if not 'icon' in i or not i['icon'] or i['icon'] == '':
i['icon'] = DEFAULT_RESULT_ICON
if not 'mimetype' in i or not i['mimetype'] or i['mimetype'] == '':
i['mimetype'] = DEFAULT_RESULT_MIMETYPE
if not 'result_type' in i or not i['result_type'] or i['result_type'] == '':
i['result_type'] = DEFAULT_RESULT_TYPE
if not 'category' in i or not i['category'] or i['category'] == '':
i['category'] = 0
if not 'title' in i or not i['title']:
i['title'] = ''
if not 'comment' in i or not i['comment']:
i['comment'] = ''
if not 'dnd_uri' in i or not i['dnd_uri'] or i['dnd_uri'] == '':
i['dnd_uri'] = i['uri']
i['metadata'] = {}
if EXTRA_METADATA:
for e in i:
for m in EXTRA_METADATA:
if m['id'] == e:
i['metadata'][e] = i[e]
i['metadata']['provider_credits'] = GLib.Variant('s', PROVIDER_CREDITS)
result_set.add_result(**i)
except Exception as error:
print(error)
class Scope(Unity.AbstractScope):
def __init__(self):
Unity.AbstractScope.__init__(self)
def do_get_search_hint(self):
return SEARCH_HINT
def do_get_schema(self):
'''
Adds specific metadata fields
'''
schema = Unity.Schema.new()
if EXTRA_METADATA:
for m in EXTRA_METADATA:
schema.add_field(m['id'], m['type'], m['field'])
#FIXME should be REQUIRED for credits
schema.add_field('provider_credits', 's', Unity.SchemaFieldType.OPTIONAL)
return schema
def do_get_categories(self):
'''
Adds categories
'''
cs = Unity.CategorySet.new()
if CATEGORIES:
for c in CATEGORIES:
cat = Unity.Category.new(c['id'], c['name'],
Gio.ThemedIcon.new(c['icon']),
c['renderer'])
cs.add(cat)
return cs
def do_get_filters(self):
'''
Adds filters
'''
fs = Unity.FilterSet.new()
#if FILTERS:
#
return fs
def do_get_group_name(self):
return GROUP_NAME
def do_get_unique_name(self):
return UNIQUE_PATH
def do_create_search_for_query(self, search_context):
se = MySearch(search_context)
return se
def do_create_previewer(self, result, metadata):
rp = Previewer()
rp.set_scope_result(result)
rp.set_search_metadata(metadata)
return rp
def do_activate(self, result, metadata, id):
parameters = [YELP_EXECUTABLE, result.uri]
GLib.spawn_async(parameters)
return Unity.ActivationResponse(handled=Unity.HandledType.HIDE_DASH, goto_uri=None)
def load_scope():
return Scope()
|