Merge lp:~jamesh/mediascanner2/query-artists into lp:mediascanner2

[James Henstridge]

Add MediaStore::queryArtists() method, needed for the new scope design.

Add MediaStore::queryArtists() method, needed for the new scope design.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:258
http://jenkins.qa.ubuntu.com/job/mediascanner2-ci/108/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mediascanner2-utopic-amd64-ci/49
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mediascanner2-utopic-armhf-ci/49
        deb: http://jenkins.qa.ubuntu.com/job/mediascanner2-utopic-armhf-ci/49/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mediascanner2-utopic-i386-ci/49

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mediascanner2-ci/108/rebuild

review: Approve (continuous-integration)

[Jussi Pakkanen (jpakkane)]

Looking really nice.

review: Approve

=== modified file 'debian/libmediascanner-2.0-0.symbols'
--- debian/libmediascanner-2.0-0.symbols	2014-07-25 07:35:08 +0000
+++ debian/libmediascanner-2.0-0.symbols	2014-07-25 07:35:08 +0000
@@ -66,6 +66,7 @@
  (c++)"mediascanner::MediaStore::listGenres(mediascanner::Filter const&) const@Base" 0replaceme
  (c++)"mediascanner::MediaStore::listArtists(mediascanner::Filter const&) const@Base" 0replaceme
  (c++)"mediascanner::MediaStore::queryAlbums(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, int) const@Base" 0.101+14.10.20140613
+ (c++)"mediascanner::MediaStore::queryArtists(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, int) const@Base" 0replaceme
  (c++)"mediascanner::MediaStore::getAlbumSongs(mediascanner::Album const&) const@Base" 0.101+14.10.20140613
  (c++)"mediascanner::MediaStore::listAlbumArtists(mediascanner::Filter const&) const@Base" 0replaceme
  (c++)"mediascanner::MediaStore::size() const@Base" 0.101+14.10.20140613
@@ -119,14 +120,15 @@
  (c++)"VTT for mediascanner::MediaStore@Base" 0.101+14.10.20140625
  (c++)"vtable for mediascanner::MediaStore@Base" 0.101+14.10.20140625
  (c++)"vtable for mediascanner::MediaStoreBase@Base" 0.101+14.10.20140625
+ (c++)"virtual thunk to mediascanner::MediaStore::listAlbumArtists(mediascanner::Filter const&) const@Base" 0replaceme
  (c++)"virtual thunk to mediascanner::MediaStore::listGenres(mediascanner::Filter const&) const@Base" 0replaceme
  (c++)"virtual thunk to mediascanner::MediaStore::~MediaStore()@Base" 0.101+14.10.20140625
  (c++)"virtual thunk to mediascanner::MediaStore::lookup(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&) const@Base" 0.101+14.10.20140625
  (c++)"virtual thunk to mediascanner::MediaStore::query(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, mediascanner::MediaType, int) const@Base" 0.101+14.10.20140625
  (c++)"virtual thunk to mediascanner::MediaStore::queryAlbums(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, int) const@Base" 0.101+14.10.20140625
+ (c++)"virtual thunk to mediascanner::MediaStore::queryArtists(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, int) const@Base" 0replaceme
  (c++)"virtual thunk to mediascanner::MediaStore::getAlbumSongs(mediascanner::Album const&) const@Base" 0.101+14.10.20140625
  (c++)"virtual thunk to mediascanner::MediaStore::getETag(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&) const@Base" 0.101+14.10.20140625
  (c++)"virtual thunk to mediascanner::MediaStore::listSongs(mediascanner::Filter const&) const@Base" 0replaceme
  (c++)"virtual thunk to mediascanner::MediaStore::listAlbums(mediascanner::Filter const&) const@Base" 0replaceme
  (c++)"virtual thunk to mediascanner::MediaStore::listArtists(mediascanner::Filter const&) const@Base" 0replaceme
- (c++)"virtual thunk to mediascanner::MediaStore::listAlbumArtists(mediascanner::Filter const&) const@Base" 0replaceme

=== modified file 'src/mediascanner/CMakeLists.txt'
--- src/mediascanner/CMakeLists.txt	2014-06-24 10:33:29 +0000
+++ src/mediascanner/CMakeLists.txt	2014-07-25 07:35:08 +0000
@@ -32,6 +32,7 @@
 
 install(FILES
   Album.hh
+  Filter.hh
   MediaFile.hh
   MediaFileBuilder.hh
   MediaStore.hh

=== modified file 'src/mediascanner/MediaStore.cc'
--- src/mediascanner/MediaStore.cc	2014-07-25 07:35:08 +0000
+++ src/mediascanner/MediaStore.cc	2014-07-25 07:35:08 +0000
@@ -58,6 +58,7 @@
     MediaFile lookup(const std::string &filename) const;
     std::vector<MediaFile> query(const std::string &q, MediaType type, int limit=-1) const;
     std::vector<Album> queryAlbums(const std::string &core_term, int limit=-1) const;
+    std::vector<string> queryArtists(const std::string &q, int limit=-1) const;
     std::vector<MediaFile> getAlbumSongs(const Album& album) const;
     std::string getETag(const std::string &filename) const;
 
@@ -471,6 +472,40 @@
     }
 }
 
+vector<string> MediaStorePrivate::queryArtists(const string &q, int limit) const {
+    if (q.empty()) {
+        Statement query(db, R"(
+SELECT artist FROM media
+WHERE type = ? AND artist <> ''
+GROUP BY artist
+LIMIT ?
+)");
+        query.bind(1, (int)AudioMedia);
+        query.bind(2, limit);
+        vector<string> result;
+        while (query.step()) {
+            result.push_back(query.getText(0));
+        }
+        return result;
+    } else {
+        Statement query(db, R"(
+SELECT artist FROM media
+WHERE rowid IN (SELECT docid FROM media_fts WHERE media_fts MATCH ?)
+AND type == ? AND artist <> ''
+GROUP BY artist
+LIMIT ?
+)");
+        query.bind(1, q + "*");
+        query.bind(2, (int)AudioMedia);
+        query.bind(3, limit);
+        vector<string> result;
+        while (query.step()) {
+            result.push_back(query.getText(0));
+        }
+        return result;
+    }
+}
+
 vector<MediaFile> MediaStorePrivate::getAlbumSongs(const Album& album) const {
     Statement query(db, R"(
 SELECT filename, content_type, etag, title, date, artist, album, album_artist, genre, disc_number, track_number, duration, width, height, latitude, longitude, type FROM media
@@ -731,6 +766,11 @@
     return p->queryAlbums(core_term, limit);
 }
 
+std::vector<string> MediaStore::queryArtists(const std::string &q, int limit) const {
+    std::lock_guard<std::mutex> lock(p->dbMutex);
+    return p->queryArtists(q, limit);
+}
+
 std::vector<MediaFile> MediaStore::getAlbumSongs(const Album& album) const {
     std::lock_guard<std::mutex> lock(p->dbMutex);
     return p->getAlbumSongs(album);

=== modified file 'src/mediascanner/MediaStore.hh'
--- src/mediascanner/MediaStore.hh	2014-07-25 07:35:08 +0000
+++ src/mediascanner/MediaStore.hh	2014-07-25 07:35:08 +0000
@@ -47,6 +47,7 @@
     virtual MediaFile lookup(const std::string &filename) const override;
     virtual std::vector<MediaFile> query(const std::string &q, MediaType type, int limit=-1) const override;
     virtual std::vector<Album> queryAlbums(const std::string &core_term, int limit=-1) const override;
+    virtual std::vector<std::string> queryArtists(const std::string &q, int limit=-1) const override;
     virtual std::vector<MediaFile> getAlbumSongs(const Album& album) const override;
     virtual std::string getETag(const std::string &filename) const override;
     virtual std::vector<MediaFile> listSongs(const Filter &filter) const override;

=== modified file 'src/mediascanner/MediaStoreBase.hh'
--- src/mediascanner/MediaStoreBase.hh	2014-07-25 07:35:08 +0000
+++ src/mediascanner/MediaStoreBase.hh	2014-07-25 07:35:08 +0000
@@ -42,6 +42,7 @@
     virtual MediaFile lookup(const std::string &filename) const = 0;
     virtual std::vector<MediaFile> query(const std::string &q, MediaType type, int limit=-1) const = 0;
     virtual std::vector<Album> queryAlbums(const std::string &core_term, int limit=-1) const = 0;
+    virtual std::vector<std::string> queryArtists(const std::string &q, int limit=-1) const = 0;
     virtual std::vector<MediaFile> getAlbumSongs(const Album& album) const = 0;
     virtual std::string getETag(const std::string &filename) const = 0;
     virtual std::vector<MediaFile> listSongs(const Filter &filter) const = 0;

=== modified file 'src/ms-dbus/dbus-interface.hh'
--- src/ms-dbus/dbus-interface.hh	2014-06-10 04:58:51 +0000
+++ src/ms-dbus/dbus-interface.hh	2014-07-25 07:35:08 +0000
@@ -93,6 +93,19 @@
         }
     };
 
+    struct QueryArtists {
+        typedef MediaStoreInterface Interface;
+
+        inline static const std::string& name() {
+            static std::string s = "QueryArtists";
+            return s;
+        }
+
+        inline static const std::chrono::milliseconds default_timeout() {
+            return std::chrono::seconds{1};
+        }
+    };
+
     struct GetAlbumSongs {
         typedef MediaStoreInterface Interface;
 

=== modified file 'src/ms-dbus/service-skeleton.cc'
--- src/ms-dbus/service-skeleton.cc	2014-07-25 07:35:08 +0000
+++ src/ms-dbus/service-skeleton.cc	2014-07-25 07:35:08 +0000
@@ -64,6 +64,11 @@
                 &Private::handle_query_albums,
                 this,
                 std::placeholders::_1));
+        object->install_method_handler<MediaStoreInterface::QueryArtists>(
+            std::bind(
+                &Private::handle_query_artists,
+                this,
+                std::placeholders::_1));
         object->install_method_handler<MediaStoreInterface::GetAlbumSongs>(
             std::bind(
                 &Private::handle_get_album_songs,
@@ -221,6 +226,26 @@
         impl->access_bus()->send(reply);
     }
 
+    void handle_query_artists(const Message::Ptr &message) {
+        if (!check_access(message, AudioMedia))
+            return;
+
+        std::string query;
+        int32_t limit;
+        message->reader() >> query >> limit;
+        Message::Ptr reply;
+        try {
+            auto artists = store->queryArtists(query, limit);
+            reply = Message::make_method_return(message);
+            reply->writer() << artists;
+        } catch (const std::exception &e) {
+            reply = Message::make_error(
+                message, MediaStoreInterface::Errors::Error::name(),
+                e.what());
+        }
+        impl->access_bus()->send(reply);
+    }
+
     void handle_get_album_songs(const Message::Ptr &message) {
         if (!check_access(message, AudioMedia))
             return;

=== modified file 'src/ms-dbus/service-stub.cc'
--- src/ms-dbus/service-stub.cc	2014-07-25 07:35:08 +0000
+++ src/ms-dbus/service-stub.cc	2014-07-25 07:35:08 +0000
@@ -66,6 +66,13 @@
     return result.value();
 }
 
+std::vector<string> ServiceStub::queryArtists(const string &q, int limit) const {
+    auto result = p->object->invoke_method_synchronously<MediaStoreInterface::QueryArtists, std::vector<string>>(q, (int32_t)limit);
+    if (result.is_error())
+        throw std::runtime_error(result.error().print());
+    return result.value();
+}
+
 std::vector<MediaFile> ServiceStub::getAlbumSongs(const Album& album) const {
     auto result = p->object->invoke_method_synchronously<MediaStoreInterface::GetAlbumSongs, std::vector<MediaFile>>(album);
     if (result.is_error())

=== modified file 'src/ms-dbus/service-stub.hh'
--- src/ms-dbus/service-stub.hh	2014-07-25 07:35:08 +0000
+++ src/ms-dbus/service-stub.hh	2014-07-25 07:35:08 +0000
@@ -45,6 +45,7 @@
     virtual MediaFile lookup(const std::string &filename) const override;
     virtual std::vector<MediaFile> query(const std::string &q, MediaType type, int limit=-1) const override;
     virtual std::vector<Album> queryAlbums(const std::string &core_term, int limit=-1) const override;
+    virtual std::vector<std::string> queryArtists(const std::string &q, int limit=-1) const override;
     virtual std::vector<MediaFile> getAlbumSongs(const Album& album) const override;
     virtual std::string getETag(const std::string &filename) const override;
     virtual std::vector<MediaFile> listSongs(const Filter &filter) const override;

=== modified file 'test/test_mediastore.cc'
--- test/test_mediastore.cc	2014-07-25 07:35:08 +0000
+++ test/test_mediastore.cc	2014-07-25 07:35:08 +0000
@@ -552,6 +552,117 @@
     EXPECT_EQ(1, albums.size());
 }
 
+TEST_F(MediaStoreTest, queryArtists) {
+    MediaFile audio1 = MediaFileBuilder("/home/username/Music/track1.ogg")
+        .setType(AudioMedia)
+        .setTitle("TitleOne")
+        .setAuthor("ArtistOne")
+        .setAlbum("AlbumOne")
+        .setAlbumArtist("Various Artists")
+        .setDiscNumber(1)
+        .setTrackNumber(1);
+    MediaFile audio2 = MediaFileBuilder("/home/username/Music/track2.ogg")
+        .setType(AudioMedia)
+        .setTitle("TitleTwo")
+        .setAuthor("ArtistTwo")
+        .setAlbum("AlbumOne")
+        .setAlbumArtist("Various Artists")
+        .setDiscNumber(1)
+        .setTrackNumber(2);
+    MediaFile audio3 = MediaFileBuilder("/home/username/Music/track3.ogg")
+        .setType(AudioMedia)
+        .setTitle("TitleThree")
+        .setAuthor("ArtistThree")
+        .setAlbum("AlbumOne")
+        .setAlbumArtist("Various Artists")
+        .setDiscNumber(2)
+        .setTrackNumber(1);
+    MediaFile audio4 = MediaFileBuilder("/home/username/Music/fname.ogg")
+        .setType(AudioMedia)
+        .setTitle("TitleFour")
+        .setAuthor("ArtistFour")
+        .setAlbum("AlbumTwo")
+        .setAlbumArtist("ArtistFour")
+        .setTrackNumber(1);
+
+    MediaStore store(":memory:", MS_READ_WRITE);
+    store.insert(audio1);
+    store.insert(audio2);
+    store.insert(audio3);
+    store.insert(audio4);
+
+    // Query a track title
+    vector<string> artists = store.queryArtists("TitleOne");
+    ASSERT_EQ(artists.size(), 1);
+    EXPECT_EQ(artists[0], "ArtistOne");
+
+    // Query an album name
+    artists = store.queryArtists("AlbumTwo");
+    ASSERT_EQ(artists.size(), 1);
+    EXPECT_EQ(artists[0], "ArtistFour");
+
+    // Query an artist name
+    artists = store.queryArtists("ArtistTwo");
+    ASSERT_EQ(artists.size(), 1);
+    EXPECT_EQ(artists[0], "ArtistTwo");
+}
+
+TEST_F(MediaStoreTest, queryArtists_limit) {
+    MediaFile audio1 = MediaFileBuilder("/home/username/Music/track1.ogg")
+        .setType(AudioMedia)
+        .setTitle("TitleOne")
+        .setAuthor("ArtistOne")
+        .setAlbum("AlbumOne")
+        .setAlbumArtist("Various Artists")
+        .setDiscNumber(1)
+        .setTrackNumber(1);
+    MediaFile audio2 = MediaFileBuilder("/home/username/Music/track2.ogg")
+        .setType(AudioMedia)
+        .setTitle("TitleTwo")
+        .setAuthor("ArtistTwo")
+        .setAlbum("AlbumOne")
+        .setAlbumArtist("Various Artists")
+        .setDiscNumber(1)
+        .setTrackNumber(2);
+
+    MediaStore store(":memory:", MS_READ_WRITE);
+    store.insert(audio1);
+    store.insert(audio2);
+
+    vector<string> artists = store.queryArtists("Artist");
+    EXPECT_EQ(2, artists.size());
+    artists = store.queryArtists("Artist", 1);
+    EXPECT_EQ(1, artists.size());
+}
+
+TEST_F(MediaStoreTest, queryArtists_empty) {
+    MediaFile audio1 = MediaFileBuilder("/home/username/Music/track1.ogg")
+        .setType(AudioMedia)
+        .setTitle("TitleOne")
+        .setAuthor("ArtistOne")
+        .setAlbum("AlbumOne")
+        .setAlbumArtist("Various Artists")
+        .setDiscNumber(1)
+        .setTrackNumber(1);
+    MediaFile audio2 = MediaFileBuilder("/home/username/Music/track2.ogg")
+        .setType(AudioMedia)
+        .setTitle("TitleTwo")
+        .setAuthor("ArtistTwo")
+        .setAlbum("AlbumOne")
+        .setAlbumArtist("Various Artists")
+        .setDiscNumber(1)
+        .setTrackNumber(2);
+
+    MediaStore store(":memory:", MS_READ_WRITE);
+    store.insert(audio1);
+    store.insert(audio2);
+
+    vector<string> artists = store.queryArtists("");
+    EXPECT_EQ(2, artists.size());
+    artists = store.queryArtists("", 1);
+    EXPECT_EQ(1, artists.size());
+}
+
 TEST_F(MediaStoreTest, getAlbumSongs) {
     MediaFile audio1 = MediaFileBuilder("/home/username/Music/track1.ogg")
         .setType(AudioMedia)