From 4428d7401cadb57fda7b89e4d428a6849c7b93d8 Mon Sep 17 00:00:00 2001
From: Eliot Berriot <contact@eliotberriot.com>
Date: Tue, 3 Jul 2018 08:21:48 +0200
Subject: [PATCH] Fixed #344: Implemented a basic but functionnal Github-like
search on federated tracks list
---
api/funkwhale_api/federation/filters.py | 18 +++++++++++++--
changes/changelog.d/344.feature | 22 +++++++++++++++++++
front/src/App.vue | 1 +
.../federation/LibraryTrackTable.vue | 14 ++++++++----
4 files changed, 49 insertions(+), 6 deletions(-)
create mode 100644 changes/changelog.d/344.feature
diff --git a/api/funkwhale_api/federation/filters.py b/api/funkwhale_api/federation/filters.py
index 3b5bfd73..ff7575ba 100644
--- a/api/funkwhale_api/federation/filters.py
+++ b/api/funkwhale_api/federation/filters.py
@@ -1,6 +1,7 @@
import django_filters
from funkwhale_api.common import fields
+from funkwhale_api.common import search
from . import models
@@ -23,8 +24,21 @@ class LibraryFilter(django_filters.FilterSet):
class LibraryTrackFilter(django_filters.FilterSet):
library = django_filters.CharFilter("library__uuid")
status = django_filters.CharFilter(method="filter_status")
- q = fields.SearchFilter(
- search_fields=["artist_name", "title", "album_title", "library__actor__domain"]
+ q = fields.SmartSearchFilter(
+ config=search.SearchConfig(
+ search_fields={
+ "domain": {"to": "library__actor__domain"},
+ "artist": {"to": "artist_name"},
+ "album": {"to": "album_title"},
+ "title": {"to": "title"},
+ },
+ filter_fields={
+ "domain": {"to": "library__actor__domain"},
+ "artist": {"to": "artist_name__iexact"},
+ "album": {"to": "album_title__iexact"},
+ "title": {"to": "title__iexact"},
+ },
+ )
)
def filter_status(self, queryset, field_name, value):
diff --git a/changes/changelog.d/344.feature b/changes/changelog.d/344.feature
new file mode 100644
index 00000000..6dc14667
--- /dev/null
+++ b/changes/changelog.d/344.feature
@@ -0,0 +1,22 @@
+Implemented a basic but functionnal Github-like search on federated tracks list (#344)
+
+
+Improved search on federated tracks list
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Having a powerful but easy-to-use search is important but difficult to achieve, especially
+if you do not want to have a real complex search interface.
+
+Github does a pretty good job with that, using a structured but simple query system
+(See https://help.github.com/articles/searching-issues-and-pull-requests/#search-only-issues-or-pull-requests).
+
+This release implements a limited but working subset of this query system. You can use it only on the federated
+tracks list (/manage/federation/tracks) at the moment, but depending on feedback it will be rolled-out on other pages as well.
+
+This is the type of query you can run:
+
+- ``hello world``: search for "hello" and "world" in all the available fields
+- ``hello in:artist`` search for results where artist name is "hello"
+- ``spring in:artist,album`` search for results where artist name or album title contain "spring"
+- ``artist:hello`` search for results where artist name equals "hello"
+- ``artist:"System of a Down" domain:instance.funkwhale`` search for results where artist name equals "System of a Down" and inside "instance.funkwhale" library
diff --git a/front/src/App.vue b/front/src/App.vue
index a6da038b..8e1abae7 100644
--- a/front/src/App.vue
+++ b/front/src/App.vue
@@ -236,6 +236,7 @@ html, body {
.discrete.link {
color: rgba(0, 0, 0, 0.87);
+ cursor: pointer;
}
.floated.buttons .button ~ .dropdown {
diff --git a/front/src/components/federation/LibraryTrackTable.vue b/front/src/components/federation/LibraryTrackTable.vue
index 64566396..08262919 100644
--- a/front/src/components/federation/LibraryTrackTable.vue
+++ b/front/src/components/federation/LibraryTrackTable.vue
@@ -2,7 +2,7 @@
<div>
<div class="ui inline form">
<div class="fields">
- <div class="ui field">
+ <div class="ui six wide field">
<label><translate>Search</translate></label>
<input type="text" v-model="search" :placeholder="labels.searchPlaceholder" />
</div>
@@ -56,16 +56,16 @@
<span :title="scope.obj.title">{{ scope.obj.title|truncate(30) }}</span>
</td>
<td>
- <span :title="scope.obj.artist_name">{{ scope.obj.artist_name|truncate(30) }}</span>
+ <span class="discrete link" @click="updateSearch({key: 'artist', value: scope.obj.artist_name})" :title="scope.obj.artist_name">{{ scope.obj.artist_name|truncate(30) }}</span>
</td>
<td>
- <span :title="scope.obj.album_title">{{ scope.obj.album_title|truncate(20) }}</span>
+ <span class="discrete link" @click="updateSearch({key: 'album', value: scope.obj.album_title})" :title="scope.obj.album_title">{{ scope.obj.album_title|truncate(20) }}</span>
</td>
<td>
<human-date :date="scope.obj.published_date"></human-date>
</td>
<td v-if="showLibrary">
- {{ scope.obj.library.actor.domain }}
+ <span class="discrete link" @click="updateSearch({key: 'domain', value: scope.obj.library.actor.domain})">{{ scope.obj.library.actor.domain }}</span>
</td>
</template>
</action-table>
@@ -120,6 +120,12 @@ export default {
this.fetchData()
},
methods: {
+ updateSearch ({key, value}) {
+ if (value.indexOf(' ') > -1) {
+ value = `"${value}"`
+ }
+ this.search = `${key}:${value}`
+ },
fetchData () {
let params = _.merge({
'page': this.page,
--
GitLab