This file is indexed.

/usr/share/unity-scopes/clementine/unity_clementine_daemon.py is in unity-scope-clementine 0.1+13.10.20130723-0ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
#! /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/>.

from gi.repository import GLib, Gio
from gi.repository import Unity
import gettext
import urllib.parse
import hashlib
import unicodedata
import os
import shutil
import sqlite3

APP_NAME = 'unity-scope-clementine'
LOCAL_PATH = '/usr/share/locale/'
gettext.bindtextdomain(APP_NAME, LOCAL_PATH)
gettext.textdomain(APP_NAME)
_ = gettext.gettext

GROUP_NAME = 'com.canonical.Unity.Scope.Music.Clementine'
UNIQUE_PATH = '/com/canonical/unity/scope/music/clementine'

SEARCH_HINT = _('Search Clementime')
NO_RESULTS_HINT = _('Sorry, there are no Clementine results that match your search.')
PROVIDER_CREDITS = _('')
SVG_DIR = '/usr/share/icons/unity-icon-theme/places/svg/'
PROVIDER_ICON = SVG_DIR + 'service-clementine.svg'
DEFAULT_RESULT_ICON = SVG_DIR + 'result-clementine.svg'
DEFAULT_RESULT_MIMETYPE = 'taglib/mp3'
DEFAULT_RESULT_TYPE = Unity.ResultType.PERSONAL
CLEMENTINE_DBFILE = os.getenv("HOME") + "/.config/Clementine/clementine.db"
CLEMENTINE_BACKUP_FILE = os.getenv("HOME") + "/.config/Clementine/clementine-scope-backup.db"

c1 = {'id': 'songs',
      'name': _('Songs'),
      'icon': SVG_DIR + 'group-installed.svg',
      'renderer': Unity.CategoryRenderer.VERTICAL_TILE}
c2 = {'id': 'albums',
      'name': _('Albums'),
      'icon': SVG_DIR + 'group-installed.svg',
      'renderer': Unity.CategoryRenderer.VERTICAL_TILE}
CATEGORIES = [c1, c2]

FILTERS = []

m1 = {'id': 'album',
      'type': 's',
      'field': Unity.SchemaFieldType.OPTIONAL}
m2 = {'id': 'artist',
      'type': 's',
      'field': Unity.SchemaFieldType.OPTIONAL}
m3 = {'id': 'genre',
      'type': 's',
      'field': Unity.SchemaFieldType.OPTIONAL}
m4 = {'id': 'year',
      'type': 'i',
      'field': Unity.SchemaFieldType.OPTIONAL}
m5 = {'id': 'track_length',
      'type': 'i',
      'field': Unity.SchemaFieldType.OPTIONAL}
m6 = {'id': 'track_number',
      'type': 'i',
      'field': Unity.SchemaFieldType.OPTIONAL}
EXTRA_METADATA = [m1, m2, m3, m4, m5, m6]

SEARCH_SQL = '''SELECT title, filename, artist, album, albumartist, art_automatic, year, genre, art_manual, track, length
                FROM songs
                WHERE album LIKE '%%%s%%' OR artist LIKE '%%%s%%' OR title LIKE '%%%s%%' ORDER BY track'''

ALBUM_SQL = '''SELECT title, filename, artist, album, albumartist, art_automatic, year, genre, art_manual, track, length
               FROM songs
               WHERE album LIKE '%%%s%%' AND artist LIKE '%%%s%%' ORDER BY track'''


def get_music_from_clementine(query):
    '''
    Parses Clementine's database into a form we can use using the supplied SQL query
    '''
    tracks = []
    if not os.path.exists(CLEMENTINE_BACKUP_FILE):
        return tracks

    conn = sqlite3.connect(CLEMENTINE_BACKUP_FILE)
    cursor = conn.cursor()
    cursor.execute(query)
    tracks = cursor.fetchall()
    cursor.close()
    return tracks


def get_album_art(track):
    # First try manually set album art
    if not track[8] is None:
        if not track[8] == "(embedded)":
            return track[8]

    # Next try automatically set album art
    if not track[5] is None:
        if not track[5] == "(embedded)":
            return track[5]

    # Try thumbnailing any embedded album art and use that
    hashname = '%s\t%s' % (unicodedata.normalize("NFKD", track[4]), unicodedata.normalize("NFKD", track[3]))
    file_hash = hashlib.md5(hashname.encode('utf-8')).hexdigest()
    tb_filename = os.path.join(os.path.expanduser("~/.cache/media-art"), ("album-" + file_hash)) + ".jpg"
    if os.path.exists(tb_filename):
        return tb_filename
    else:
        try:
            from mutagen import File
            trackfile = track[1][7:]
            trackfile.replace("%20", " ")
            trackfile = urllib.parse.unquote(trackfile)
            audio = File(trackfile)
            if "APIC" in audio:
                artwork = audio.tags["APIC:"].data
                if not os.path.exists(os.path.expanduser("~/.cache/media-art")):
                    os.makedirs(os.path.expanduser("~/.cache/media-art"))
                with open(tb_filename, "wb") as img:
                    img.write(artwork)
                return tb_filename
            else:
                return "audio-x-generic"
        except:
            # Otherwise, return a generic audio icon
            return "audio-x-generic"


def search(search, filters):
    '''
    Search for help documents matching the search string
    '''
    results = []
    shutil.copy2(CLEMENTINE_DBFILE, CLEMENTINE_BACKUP_FILE)
    tracks = get_music_from_clementine(SEARCH_SQL % (search, search, search))
    albumresults = []

    for track in tracks:
        title = "" if track[0] is None else track[0]
        uri = "" if track[1] is None else track[1].decode('utf-8')
        artist = "" if track[2] is None else track[2]
        album = "" if track[3] is None else track[3]
        albumartist = "" if track[4] is None else track[4]
        year = 0 if track[6] is None else track[6]
        genre = "" if track[7] is None else track[7]
        track_length = 0 if track[10] is None else track[10] / 1000000000
        track_number = 0 if track[9] is None else track[9]

        albumart = get_album_art(track)
        albumuri = "album://" + albumartist + "/" + album
        results.append({'uri': urllib.parse.unquote(uri),
                        'icon': albumart,
                        'category': 0,
                        'title': title,
                        'album': GLib.Variant('s', album),
                        'artist': GLib.Variant('s', artist),
                        'genre': GLib.Variant('s', genre),
                        'year': GLib.Variant('i', year),
                        'track_length': GLib.Variant('i', track_length),
                        'track_number': GLib.Variant('i', track_number)})

        if album not in albumresults:
            results.append({'uri': albumuri,
                            'icon': albumart,
                            'category': 1,
                            'title': album,
                            'album': GLib.Variant('s', album),
                            'artist': GLib.Variant('s', artist),
                            'genre': GLib.Variant('s', genre),
                            'year': GLib.Variant('i', year)})
            albumresults.append(album)
    return results


class Preview(Unity.ResultPreviewer):

    def do_run(self):
        album = self.result.metadata['album'].get_string()
        artist = self.result.metadata['artist'].get_string()
        preview = Unity.MusicPreview.new(self.result.title, '', None)
        preview.props.image_source_uri = 'file://%s' % self.result.icon_hint
        preview.props.subtitle = self.result.metadata['artist'].get_string()
        if self.result.uri.startswith("album://"):
            tracks = get_music_from_clementine(ALBUM_SQL % (album, artist))
            for track in tracks:
                track = Unity.TrackMetadata.full(track[1].decode('utf-8'),
                                                 track[9],
                                                 track[0],
                                                 track[2],
                                                 track[3],
                                                 track[10] / 1000000000)
                preview.add_track(track)
        else:
            track = Unity.TrackMetadata.full(self.result.uri,
                                             self.result.metadata['track_number'].get_int32(),
                                             self.result.title,
                                             self.result.metadata['artist'].get_string(),
                                             self.result.metadata['album'].get_string(),
                                             self.result.metadata['track_length'].get_int32())
            preview.add_track(track)

        icon = Gio.FileIcon.new(Gio.file_new_for_path(PROVIDER_ICON))
        view_action = Unity.PreviewAction.new("play", _("Play"), None)
        preview.add_action(view_action)
        show_action = Unity.PreviewAction.new("show", _("Show in Folder"), None)
        preview.add_action(show_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['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_activate(self, result, metadata, id):
        album = result.metadata['album'].get_string()
        artist = result.metadata['artist'].get_string()

        if id == 'show':
            if result.uri.startswith("album://"):
                tracks = get_music_from_clementine(ALBUM_SQL % (album, artist))
                filename = tracks[0][1].decode('utf-8')
            else:
                filename = result.uri
            dirname = os.path.dirname(filename)
            os.system("xdg-open '%s'" % str(dirname))
        else:
            albumtracks = ''
            if result.uri.startswith('album://'):
                tracks = get_music_from_clementine(ALBUM_SQL % (album, artist))
                for track in tracks:
                    albumtracks = '%s \'%s\'' % (albumtracks, track[1].decode('utf-8'))
            else:
                albumtracks = result.uri
            os.system('clementine -a %s' % albumtracks)

        return Unity.ActivationResponse(handled=Unity.HandledType.HIDE_DASH, goto_uri=None)

    def do_create_previewer(self, result, metadata):
        rp = Preview()
        rp.set_scope_result(result)
        rp.set_search_metadata(metadata)
        return rp


def load_scope():
    return Scope()