~unity-team/unity-lens-music/6.0

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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
/*
 * Copyright (C) 2011 Canonical Ltd
 *
 * 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 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/>.
 *
 * Authored by Alex Launi <alex.launi@canonical.com>
 *
 */

using Gee;
using GLib;
using Sqlite;

namespace Unity.MusicLens {

  public errordomain DatabaseError {
    FAILED_TO_OPEN
  }
	
  /**
   * Abstracts talking to the banshee collection database
   */
  public class BansheeCollection : Object
  {
    private const int MAX_RESULTS = 100;
    
    private Database db;

    public BansheeCollection () throws DatabaseError
    {
      int rc = Database.open ("%s/banshee-1/banshee.db".printf (Environment.get_user_config_dir ()), out db);
      
      if (rc != Sqlite.OK) {
	printerr ("failed to open db, %d, %s\n", rc, db.errmsg ());
	throw new DatabaseError.FAILED_TO_OPEN ("Failed to open banshee database");
      }	
    }

    /**
     * Performs a search on the banshee db
     */
    public void search (LensSearch search, 
                        SearchType search_type, 
                        GLib.List<FilterParser>? filters = null, 
                        int max_results = -1,
                        int category_override = -1)
    {
      const int TRACK_TITLE = 0;
      const int TRACK_URI = 1;
      const int TRACK_MIMETYPE = 2;
      const int ALBUM_TITLE = 3;
      const int ALBUM_ARTWORKID = 4;
      const int ARTIST_NAME = 5;

      int rc = 0;
      Statement stmt;

      var results_model = search.results_model;
      var helper_model = results_model;
      if (category_override >= 0)
      {
        helper_model = new Dee.SequenceModel ();
        helper_model.set_schema_full (results_model.get_schema ());
      }

      // use a tree set to ensure we don't duplicate albums
      TreeSet<string> albums = new TreeSet<string> ();
      string filters_sql = build_sql_from_filters (filters);

      // BUILD SQL STATEMENT
      string sql = """SELECT CoreTracks.Title, CoreTracks.Uri, CoreTracks.MimeType, CoreAlbums.Title, CoreAlbums.ArtworkID, CoreArtists.Name                      FROM CoreTracks 
                      CROSS JOIN CoreArtists, CoreAlbums 
                      WHERE CoreArtists.ArtistID = CoreTracks.ArtistID 
                                                   AND CoreAlbums.AlbumID = CoreTracks.AlbumID 
                                                   AND CoreTracks.PrimarySourceID = 1 
						   AND ((CoreArtists.NameLowered LIKE '%%%s%%' ESCAPE '\' 
						  	 AND CoreArtists.NameLowered IS NOT NULL) 
						        OR (CoreAlbums.TitleLowered LIKE '%%%s%%' ESCAPE '\' 
						  	    AND CoreAlbums.TitleLowered IS NOT NULL) 
						  	OR (CoreTracks.TitleLowered LIKE '%%%s%%' ESCAPE '\' 
						  	    AND CoreTracks.TitleLowered IS NOT NULL)
                                                       )
                                 %s
                      ORDER BY CoreTracks.Score DESC
                      LIMIT 0, %d;""".printf (search.search_string,
                                              search.search_string,
                                              search.search_string,
                                              filters_sql,
                                              max_results == -1 ? MAX_RESULTS : max_results);
			
      rc = execute_sql (sql, out stmt);
      if (stmt == null)
	return;

      do {
	rc = stmt.step ();
	switch (rc) {
	case Sqlite.DONE:
	  break;
	case Sqlite.ROW:
      string artwork_path = get_album_artwork_path (stmt.column_text (ALBUM_ARTWORKID));
      if (artwork_path == null || artwork_path == "" || !FileUtils.test(artwork_path, FileTest.EXISTS))
          artwork_path = ALBUM_MISSING_ICON_PATH;

      Track track = new Track ();
	  track.title = stmt.column_text (TRACK_TITLE);
	  track.artist = stmt.column_text (ARTIST_NAME);
	  track.uri = stmt.column_text (TRACK_URI);
	  track.mime_type = stmt.column_text (TRACK_MIMETYPE);          
	  track.artwork_path = artwork_path;
	  
	  Album album = new Album ();
	  album.title = stmt.column_text (ALBUM_TITLE);
	  album.artist = stmt.column_text (ARTIST_NAME);
	  album.uri = "album://%s/%s".printf (album.artist, album.title);
	  album.artwork_path = artwork_path;
	  
	  uint category_id = Category.SONGS;
	  if (category_override >= 0)
	    category_id = category_override;
      
	  helper_model.append (track.uri, artwork_path, category_id,
                               track.mime_type, track.title, track.artist,
                               track.uri);

	  if (albums.add (album.artist + album.title)) {
	    StringBuilder uri_list_builder = new StringBuilder ();
	    foreach (string uri in get_track_uris (album)) {
	      uri_list_builder.append ("'");
	      uri_list_builder.append (uri);
	      uri_list_builder.append ("' ");
	    }

            category_id = Category.ALBUMS;
            if (category_override >= 0)
              category_id = category_override;
	  
            results_model.append (album.uri, album.artwork_path, category_id,
                                  "audio/mp3", album.title, album.artist,
                                  uri_list_builder.str);
	  }

	  break;
	default:
	  break;
	}
      } while (rc == Sqlite.ROW);

      if (helper_model == results_model) return;

      // we need to do this because the dash doesn't care about position
      // of a newly added row in the model - it just appends it
      var iter = helper_model.get_first_iter ();
      var last = helper_model.get_last_iter ();
      while (iter != last)
      {
        var row = helper_model.get_row (iter);
        results_model.append_row (row);
        iter = helper_model.next (iter);
      }
    }

    /**
     * Computes path for album artwork.
     */
    private string get_album_artwork_path (string artwork_id)
    {
        string album_art_dir = "%s/media-art/".printf (Environment.get_user_cache_dir ());
        string artwork_path = "%s/%s.jpg".printf (album_art_dir, artwork_id);
        return artwork_path;
    }

    /**
     * Creates Track object out of single row of Statement result data.
     */
    private Track get_track (Statement stmt)
    {
        const int TRACK_URI = 0;
        const int TRACK_TITLE = 1;
        const int ARTIST_NAME = 2;
        const int ALBUM_TITLE = 3;
        const int ALBUM_ARTWORKID = 4;
        const int TRACK_MIMETYPE = 5;
        const int TRACK_GENRE = 6;
        const int TRACK_NUMBER = 7;
        const int TRACK_YEAR = 8;
        const int TRACK_PLAYCOUNT = 9;
        const int TRACK_DURATION = 10;

        Track track = new Track();

        track.uri = stmt.column_text (TRACK_URI);
        track.title = stmt.column_text (TRACK_TITLE);
        track.artist = stmt.column_text (ARTIST_NAME);
        track.album = stmt.column_text (ALBUM_TITLE);
        track.artwork_path = get_album_artwork_path (stmt.column_text (ALBUM_ARTWORKID));
        track.mime_type = stmt.column_text (TRACK_MIMETYPE);
        track.genre = stmt.column_text (TRACK_GENRE);
        track.track_number = stmt.column_int (TRACK_NUMBER);
        track.year = stmt.column_int (TRACK_YEAR);
        track.play_count = stmt.column_int (TRACK_PLAYCOUNT);
        track.duration = stmt.column_int (TRACK_DURATION);
        
        return track;
    }

    /**
     * Returns single track.
     */
    public Track? get_album_track (string uri)
    {
        string sql = "SELECT 
                         CoreTracks.Uri,
                         CoreTracks.Title,
                         CoreArtists.Name,
                         CoreAlbums.Title,
                         CoreAlbums.ArtworkID,
                         CoreTracks.MimeType,
                         CoreTracks.Genre,
                         CoreTracks.TrackNumber,
                         CoreTracks.Year,
                         CoreTracks.PlayCount,
                         CoreTracks.Duration
                    FROM CoreTracks 
                    CROSS JOIN CoreAlbums, CoreArtists 
                    WHERE CoreTracks.URI IS ?
                          AND CoreArtists.ArtistID = CoreTracks.ArtistID 
                          AND CoreAlbums.AlbumID = CoreTracks.AlbumID";

        Statement stmt;
        int rc = execute_sql (sql, out stmt);
        stmt.bind_text (1, uri);
        rc = stmt.step ();
        if (rc == Sqlite.ROW)
        {
            return get_track (stmt);
        }
        return null;
    }

    /**
     * Returns all tracks of an album.
     */
    public SList<Track> get_album_tracks_detailed (string album_title, string album_artist)
    {
               string sql = "SELECT 
                         CoreTracks.Uri,
                         CoreTracks.Title,
                         CoreArtists.Name,
                         CoreAlbums.Title,
                         CoreAlbums.ArtworkID,
                         CoreTracks.MimeType,
                         CoreTracks.Genre,
                         CoreTracks.TrackNumber,
                         CoreTracks.Year,
                         CoreTracks.PlayCount,
                         CoreTracks.Duration
                    FROM CoreTracks 
                    CROSS JOIN CoreAlbums, CoreArtists 
                    WHERE CoreArtists.ArtistID = CoreTracks.ArtistID 
                          AND CoreAlbums.AlbumID = CoreTracks.AlbumID 
                          AND CoreAlbums.Title IS ?
                          AND CoreArtists.Name IS ?
                          AND CoreTracks.URI IS NOT NULL
                    ORDER BY CoreTracks.TrackNumber ASC";

        Statement stmt;
        int rc = execute_sql (sql, out stmt);
        stmt.bind_text (1, album_title);
        stmt.bind_text (2, album_artist);

        SList<Track> tracks = new SList<Track>();
      
        do {
            rc = stmt.step ();
            switch (rc) {
                case Sqlite.DONE:
                    break;
                case Sqlite.ROW:
                    tracks.append (get_track (stmt));
                    break;
                default:
                    break;
            }
        } while (rc == Sqlite.ROW);

        return tracks;
    }
    
    /**
     * returns an array like {uri://, uri://, ...}
     */
    public string[] get_track_uris (Album album)
    {
      const int URI_COLUMN = 0;
      
      int rc;
      Statement stmt;
      
      string sql = "SELECT CoreTracks.Uri 
                    FROM CoreTracks 
                    CROSS JOIN CoreAlbums, CoreArtists 
                    WHERE CoreArtists.ArtistID = CoreTracks.ArtistID 
                          AND CoreAlbums.AlbumID = CoreTracks.AlbumID 
                          AND CoreAlbums.Title IS '%s'
                          AND CoreArtists.Name IS '%s'
                          AND CoreTracks.URI IS NOT NULL
                    ORDER BY CoreTracks.TrackNumber ASC".printf (album.title, album.artist);

      rc = execute_sql (sql, out stmt);
      
      ArrayList<string> uris = new ArrayList<string> ();
      
      do {
	rc = stmt.step ();
	switch (rc) {
	case Sqlite.DONE:
	  break;
	case Sqlite.ROW:
	  uris.add (stmt.column_text (URI_COLUMN));
	  break;
	default:
	  break;
	}
      } while (rc == Sqlite.ROW);
      
      return uris.to_array ();
    }
    
    /**
     * returns a string like "AND (Table.Column IS filter OR Table.OtherCol IS filter2) 
     * AND (Table.OtherColAgain IS AnotherFilter)" 
     */
    private string build_sql_from_filters (GLib.List<FilterParser> filters)
    {
      if (filters == null || filters.length () == 0)
	return "";
      
      var builder = new StringBuilder ();
      
      foreach (FilterParser parser in filters)
      {
	BansheeFilterParser bparser;
	if (parser is GenreFilterParser)
	  bparser = new BansheeGenreFilterParser (parser as GenreFilterParser);
	else if (parser is DecadeFilterParser)
	  bparser = new BansheeDecadeFilterParser (parser as DecadeFilterParser);
	else
	  {
	    warning ("Recieved an unimplemented filter type");
	    continue;	    
	  }

        string parsed = bparser.parse ();

        if (parsed == null || parsed == "")
          continue;
	
        builder.append (" AND ");
        builder.append (parsed);
      }

      builder.append (" ");
      return builder.str;
    }

    private int execute_sql (string sql, out Statement stmt)
    {
      int rc;
      debug ("preparing to execute sql %s\n", sql);
      
      if ((rc = db.prepare_v2 (sql, -1, out stmt, null)) == 1)
	{
	  warning ("SQL Error: %d, %s\n", rc, db.errmsg ());
        }
      
      return rc;
    }
  }
}