src/screen_search.c

   1 /* ncmpc (Ncurses MPD Client)
   2  * (c) 2004-2017 The Music Player Daemon Project
   3  * Project homepage: http://musicpd.org
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  */
  19
  20 #include "screen_search.h"
  21 #include "screen_interface.h"
  22 #include "screen_status.h"
  23 #include "screen.h"
  24 #include "i18n.h"
  25 #include "options.h"
  26 #include "charset.h"
  27 #include "mpdclient.h"
  28 #include "strfsong.h"
  29 #include "utils.h"
  30 #include "screen_utils.h"
  31 #include "screen_browser.h"
  32 #include "filelist.h"
  33
  34 #include <string.h>
  35 #include <glib.h>
  36
  37 enum {
  38         SEARCH_URI = MPD_TAG_COUNT + 100,
  39         SEARCH_ARTIST_TITLE
  40 };
  41
  42 static const struct {
  43         const char *name;
  44         const char *localname;
  45 } search_tag[MPD_TAG_COUNT] = {
  46         [MPD_TAG_ARTIST] = { "artist", N_("artist") },
  47         [MPD_TAG_ALBUM] = { "album", N_("album") },
  48         [MPD_TAG_TITLE] = { "title", N_("title") },
  49         [MPD_TAG_TRACK] = { "track", N_("track") },
  50         [MPD_TAG_NAME] = { "name", N_("name") },
  51         [MPD_TAG_GENRE] = { "genre", N_("genre") },
  52         [MPD_TAG_DATE] = { "date", N_("date") },
  53         [MPD_TAG_COMPOSER] = { "composer", N_("composer") },
  54         [MPD_TAG_PERFORMER] = { "performer", N_("performer") },
  55         [MPD_TAG_COMMENT] = { "comment", N_("comment") },
  56 };
  57
  58 static int
  59 search_get_tag_id(const char *name)
  60 {
  61         if (g_ascii_strcasecmp(name, "file") == 0 ||
  62             strcasecmp(name, _("file")) == 0)
  63                 return SEARCH_URI;
  64
  65         for (unsigned i = 0; i < MPD_TAG_COUNT; ++i)
  66                 if (search_tag[i].name != NULL &&
  67                     (strcasecmp(search_tag[i].name, name) == 0 ||
  68                      strcasecmp(search_tag[i].localname, name) == 0))
  69                         return i;
  70
  71         return -1;
  72 }
  73
  74 typedef struct {
  75         enum mpd_tag_type table;
  76         const char *label;
  77 } search_type_t;
  78
  79 static search_type_t mode[] = {
  80         { MPD_TAG_TITLE, N_("Title") },
  81         { MPD_TAG_ARTIST, N_("Artist") },
  82         { MPD_TAG_ALBUM, N_("Album") },
  83         { SEARCH_URI, N_("Filename") },
  84         { SEARCH_ARTIST_TITLE, N_("Artist + Title") },
  85         { 0, NULL }
  86 };
  87
  88 static GList *search_history = NULL;
  89 static gchar *pattern = NULL;
  90 static gboolean advanced_search_mode = FALSE;
  91
  92 static struct screen_browser browser;
  93
  94 static const char *const help_text[] = {
  95         "Quick     -  Enter a string and ncmpc will search according",
  96         "             to the current search mode (displayed above).",
  97         "",
  98         "Advanced  -  <tag>:<search term> [<tag>:<search term>...]",
  99         "               Example: artist:radiohead album:pablo honey",
 100         "",
 101         "               Available tags: artist, album, title, track,",
 102         "               name, genre, date composer, performer, comment, file",
 103         "",
 104 };
 105
 106 /* search info */
 107 static const char *
 108 lw_search_help_callback(unsigned idx, gcc_unused void *data)
 109 {
 110         assert(idx < G_N_ELEMENTS(help_text));
 111
 112         return help_text[idx];
 113 }
 114
 115 /* sanity check search mode value */
 116 static void
 117 search_check_mode(void)
 118 {
 119         int max = 0;
 120
 121         while (mode[max].label != NULL)
 122                 max++;
 123         if (options.search_mode < 0)
 124                 options.search_mode = 0;
 125         else if (options.search_mode >= max)
 126                 options.search_mode = max-1;
 127 }
 128
 129 static void
 130 search_clear(bool clear_pattern)
 131 {
 132         if (browser.filelist) {
 133                 filelist_free(browser.filelist);
 134                 browser.filelist = filelist_new();
 135                 list_window_set_length(browser.lw, 0);
 136         }
 137         if (clear_pattern && pattern) {
 138                 g_free(pattern);
 139                 pattern = NULL;
 140         }
 141 }
 142
 143 static struct filelist *
 144 search_simple_query(struct mpd_connection *connection, bool exact_match,
 145                     int table, gchar *local_pattern)
 146 {
 147         struct filelist *list;
 148         gchar *filter_utf8 = locale_to_utf8(local_pattern);
 149
 150         if (table == SEARCH_ARTIST_TITLE) {
 151                 mpd_command_list_begin(connection, false);
 152
 153                 mpd_search_db_songs(connection, exact_match);
 154                 mpd_search_add_tag_constraint(connection, MPD_OPERATOR_DEFAULT,
 155                                               MPD_TAG_ARTIST, filter_utf8);
 156                 mpd_search_commit(connection);
 157
 158                 mpd_search_db_songs(connection, exact_match);
 159                 mpd_search_add_tag_constraint(connection, MPD_OPERATOR_DEFAULT,
 160                                               MPD_TAG_TITLE, filter_utf8);
 161                 mpd_search_commit(connection);
 162
 163                 mpd_command_list_end(connection);
 164
 165                 list = filelist_new_recv(connection);
 166                 filelist_no_duplicates(list);
 167         } else if (table == SEARCH_URI) {
 168                 mpd_search_db_songs(connection, exact_match);
 169                 mpd_search_add_uri_constraint(connection, MPD_OPERATOR_DEFAULT,
 170                                               filter_utf8);
 171                 mpd_search_commit(connection);
 172
 173                 list = filelist_new_recv(connection);
 174         } else {
 175                 mpd_search_db_songs(connection, exact_match);
 176                 mpd_search_add_tag_constraint(connection, MPD_OPERATOR_DEFAULT,
 177                                               table, filter_utf8);
 178                 mpd_search_commit(connection);
 179
 180                 list = filelist_new_recv(connection);
 181         }
 182
 183         g_free(filter_utf8);
 184         return list;
 185 }
 186
 187 /*-----------------------------------------------------------------------
 188  * NOTE: This code exists to test a new search ui,
 189  *       Its ugly and MUST be redesigned before the next release!
 190  *-----------------------------------------------------------------------
 191  */
 192 static struct filelist *
 193 search_advanced_query(struct mpd_connection *connection, char *query)
 194 {
 195         advanced_search_mode = FALSE;
 196         if (strchr(query, ':') == NULL)
 197                 return NULL;
 198
 199         char **strv = g_strsplit_set(query, ": ", 0);
 200
 201         int table[10];
 202         memset(table, 0, 10*sizeof(int));
 203
 204         char *arg[10];
 205         memset(arg, 0, 10*sizeof(char *));
 206
 207         int i = 0, j = 0;
 208         while (strv[i] && strlen(strv[i]) > 0 && i < 9) {
 209                 int id = search_get_tag_id(strv[i]);
 210                 if (id == -1) {
 211                         if (table[j]) {
 212                                 char *tmp = arg[j];
 213                                 arg[j] = g_strdup_printf("%s %s", arg[j], strv[i]);
 214                                 g_free(tmp);
 215                         } else {
 216                                 screen_status_printf(_("Bad search tag %s"), strv[i]);
 217                         }
 218                         i++;
 219                 } else if (strv[i+1] == NULL || strlen(strv[i+1]) == 0) {
 220                         screen_status_printf(_("No argument for search tag %s"), strv[i]);
 221                         i++;
 222                         //        j--;
 223                         //table[j] = -1;
 224                 } else {
 225                         table[j] = id;
 226                         arg[j] = locale_to_utf8(strv[i+1]); // FREE ME
 227                         j++;
 228                         table[j] = -1;
 229                         arg[j] = NULL;
 230                         i = i + 2;
 231                         advanced_search_mode = TRUE;
 232                 }
 233         }
 234
 235         g_strfreev(strv);
 236
 237         if (!advanced_search_mode || j == 0) {
 238                 for (i = 0; arg[i] != NULL; ++i)
 239                         g_free(arg[i]);
 240                 return NULL;
 241         }
 242
 243         /*-----------------------------------------------------------------------
 244          * NOTE (again): This code exists to test a new search ui,
 245          *               Its ugly and MUST be redesigned before the next release!
 246          *             + the code below should live in mpdclient.c
 247          *-----------------------------------------------------------------------
 248          */
 249         /** stupid - but this is just a test...... (fulhack)  */
 250         mpd_search_db_songs(connection, false);
 251
 252         for (i = 0; i < 10 && arg[i] != NULL; i++) {
 253                 if (table[i] == SEARCH_URI)
 254                         mpd_search_add_uri_constraint(connection,
 255                                                       MPD_OPERATOR_DEFAULT,
 256                                                       arg[i]);
 257                 else
 258                         mpd_search_add_tag_constraint(connection,
 259                                                       MPD_OPERATOR_DEFAULT,
 260                                                       table[i], arg[i]);
 261         }
 262
 263         mpd_search_commit(connection);
 264         struct filelist *fl = filelist_new_recv(connection);
 265         if (!mpd_response_finish(connection)) {
 266                 filelist_free(fl);
 267                 fl = NULL;
 268         }
 269
 270         for (i = 0; arg[i] != NULL; ++i)
 271                 g_free(arg[i]);
 272
 273         return fl;
 274 }
 275
 276 static struct filelist *
 277 do_search(struct mpdclient *c, char *query)
 278 {
 279         struct mpd_connection *connection = mpdclient_get_connection(c);
 280         if (connection == NULL)
 281                 return NULL;
 282
 283         struct filelist *fl = search_advanced_query(connection, query);
 284         if (fl != NULL)
 285                 return fl;
 286
 287         if (mpd_connection_get_error(connection) != MPD_ERROR_SUCCESS) {
 288                 mpdclient_handle_error(c);
 289                 return NULL;
 290         }
 291
 292         fl = search_simple_query(connection, FALSE,
 293                                  mode[options.search_mode].table,
 294                                  query);
 295         if (fl == NULL)
 296                 mpdclient_handle_error(c);
 297         return fl;
 298 }
 299
 300 static void
 301 screen_search_reload(struct mpdclient *c)
 302 {
 303         if (pattern == NULL)
 304                 return;
 305
 306         if (browser.filelist != NULL) {
 307                 filelist_free(browser.filelist);
 308                 browser.filelist = NULL;
 309         }
 310
 311         browser.filelist = do_search(c, pattern);
 312         if (browser.filelist == NULL)
 313                 browser.filelist = filelist_new();
 314         list_window_set_length(browser.lw, filelist_length(browser.filelist));
 315
 316         screen_browser_sync_highlights(browser.filelist, &c->playlist);
 317 }
 318
 319 static void
 320 search_new(struct mpdclient *c)
 321 {
 322         if (!mpdclient_is_connected(c))
 323                 return;
 324
 325         search_clear(true);
 326
 327         g_free(pattern);
 328         pattern = screen_readln(_("Search"),
 329                                 NULL,
 330                                 &search_history,
 331                                 NULL);
 332
 333         if (pattern == NULL) {
 334                 list_window_reset(browser.lw);
 335                 return;
 336         }
 337
 338         screen_search_reload(c);
 339 }
 340
 341 static void
 342 screen_search_init(WINDOW *w, int cols, int rows)
 343 {
 344         browser.lw = list_window_init(w, cols, rows);
 345         if (options.search_format != NULL) {
 346                 browser.song_format = options.search_format;
 347         } else {
 348                 browser.song_format = options.list_format;
 349         }
 350         list_window_set_length(browser.lw, G_N_ELEMENTS(help_text));
 351 }
 352
 353 static void
 354 screen_search_quit(void)
 355 {
 356         if (search_history)
 357                 string_list_free(search_history);
 358         if (browser.filelist)
 359                 filelist_free(browser.filelist);
 360         list_window_free(browser.lw);
 361
 362         if (pattern) {
 363                 g_free(pattern);
 364                 pattern = NULL;
 365         }
 366 }
 367
 368 static void
 369 screen_search_open(gcc_unused struct mpdclient *c)
 370 {
 371         //  if( pattern==NULL )
 372         //    search_new(screen, c);
 373         // else
 374         screen_status_printf(_("Press %s for a new search"),
 375                              get_key_names(CMD_SCREEN_SEARCH, false));
 376         search_check_mode();
 377 }
 378
 379 static void
 380 screen_search_resize(int cols, int rows)
 381 {
 382         list_window_resize(browser.lw, cols, rows);
 383 }
 384
 385 static void
 386 screen_search_paint(void)
 387 {
 388         if (browser.filelist) {
 389                 browser.lw->hide_cursor = false;
 390                 screen_browser_paint(&browser);
 391         } else {
 392                 browser.lw->hide_cursor = true;
 393                 list_window_paint(browser.lw, lw_search_help_callback, NULL);
 394         }
 395 }
 396
 397 static const char *
 398 screen_search_get_title(char *str, size_t size)
 399 {
 400         if (advanced_search_mode && pattern)
 401                 g_snprintf(str, size, _("Search: %s"), pattern);
 402         else if (pattern)
 403                 g_snprintf(str, size,
 404                            _("Search: Results for %s [%s]"),
 405                            pattern,
 406                            _(mode[options.search_mode].label));
 407         else
 408                 g_snprintf(str, size, _("Search: Press %s for a new search [%s]"),
 409                            get_key_names(CMD_SCREEN_SEARCH, false),
 410                            _(mode[options.search_mode].label));
 411
 412         return str;
 413 }
 414
 415 static void
 416 screen_search_update(struct mpdclient *c)
 417 {
 418         if (browser.filelist != NULL && c->events & MPD_IDLE_QUEUE) {
 419                 screen_browser_sync_highlights(browser.filelist, &c->playlist);
 420                 screen_search_paint();
 421         }
 422 }
 423
 424 static bool
 425 screen_search_cmd(struct mpdclient *c, command_t cmd)
 426 {
 427         switch (cmd) {
 428         case CMD_SEARCH_MODE:
 429                 options.search_mode++;
 430                 if (mode[options.search_mode].label == NULL)
 431                         options.search_mode = 0;
 432                 screen_status_printf(_("Search mode: %s"),
 433                                      _(mode[options.search_mode].label));
 434                 /* fall through */
 435         case CMD_SCREEN_UPDATE:
 436                 screen_search_reload(c);
 437                 screen_search_paint();
 438                 return true;
 439
 440         case CMD_SCREEN_SEARCH:
 441                 search_new(c);
 442                 screen_search_paint();
 443                 return true;
 444
 445         case CMD_CLEAR:
 446                 search_clear(true);
 447                 list_window_reset(browser.lw);
 448                 screen_search_paint();
 449                 return true;
 450
 451         default:
 452                 break;
 453         }
 454
 455         if (browser.filelist != NULL &&
 456             browser_cmd(&browser, c, cmd)) {
 457                 if (screen_is_visible(&screen_search))
 458                         screen_search_paint();
 459                 return true;
 460         }
 461
 462         return false;
 463 }
 464
 465 const struct screen_functions screen_search = {
 466         .init = screen_search_init,
 467         .exit = screen_search_quit,
 468         .open = screen_search_open,
 469         .resize = screen_search_resize,
 470         .paint = screen_search_paint,
 471         .update = screen_search_update,
 472         .cmd = screen_search_cmd,
 473         .get_title = screen_search_get_title,
 474 };