src/screen_search.c

   1 /*
   2  * $Id$
   3  *
   4  * (c) 2004 by Kalle Wallin <kaw@linux.se>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18  *
  19  */
  20
  21 #include "config.h"
  22
  23 #ifndef DISABLE_SEARCH_SCREEN
  24 #include "ncmpc.h"
  25 #include "options.h"
  26 #include "support.h"
  27 #include "mpdclient.h"
  28 #include "strfsong.h"
  29 #include "command.h"
  30 #include "screen.h"
  31 #include "utils.h"
  32 #include "screen_utils.h"
  33 #include "screen_browse.h"
  34 #include "gcc.h"
  35
  36 #include <ctype.h>
  37 #include <stdlib.h>
  38 #include <string.h>
  39 #include <glib.h>
  40 #include <ncurses.h>
  41
  42 /* new search stuff with qball's libmpdclient */
  43 #define FUTURE
  44
  45
  46 #ifdef FUTURE
  47
  48 extern gint mpdclient_finish_command(mpdclient_t *c);
  49
  50 typedef struct {
  51         int id;
  52         const char *name;
  53         const char *localname;
  54 } search_tag_t;
  55
  56 static search_tag_t search_tag[] = {
  57   { MPD_TAG_ITEM_ARTIST,   "artist",    N_("artist") },
  58   { MPD_TAG_ITEM_ALBUM,    "album",     N_("album") },
  59   { MPD_TAG_ITEM_TITLE,    "title",     N_("title") },
  60   { MPD_TAG_ITEM_TRACK,    "track",     N_("track") },
  61   { MPD_TAG_ITEM_NAME,     "name",      N_("name") },
  62   { MPD_TAG_ITEM_GENRE,    "genre",     N_("genre") },
  63   { MPD_TAG_ITEM_DATE,     "date",      N_("date") },
  64   { MPD_TAG_ITEM_COMPOSER, "composer",  N_("composer") },
  65   { MPD_TAG_ITEM_PERFORMER,"performer", N_("performer") },
  66   { MPD_TAG_ITEM_COMMENT,  "comment",   N_("comment") },
  67   { MPD_TAG_ITEM_FILENAME, "filename",  N_("file") },
  68   { -1,                    NULL,        NULL }
  69 };
  70
  71 static int
  72 search_get_tag_id(char *name)
  73 {
  74   int i;
  75
  76   i=0;
  77   while( search_tag[i].name )
  78     {
  79       if( strcasecmp(search_tag[i].name, name)==0 ||
  80           strcasecmp(search_tag[i].localname, name)==0 )
  81         return search_tag[i].id;
  82       i++;
  83     }
  84   return -1;
  85 }
  86
  87 #endif
  88
  89
  90 #define SEARCH_TITLE    0
  91 #define SEARCH_ARTIST   1
  92 #define SEARCH_ALBUM    2
  93 #define SEARCH_FILE     3
  94
  95 #define SEARCH_ARTIST_TITLE 999
  96
  97 typedef struct {
  98         int table;
  99         const char *label;
 100 } search_type_t;
 101
 102 static search_type_t mode[] = {
 103   { MPD_TABLE_TITLE,     N_("Title") },
 104   { MPD_TABLE_ARTIST,    N_("Artist") },
 105   { MPD_TABLE_ALBUM,     N_("Album") },
 106   { MPD_TABLE_FILENAME,  N_("Filename") },
 107   { SEARCH_ARTIST_TITLE, N_("Artist + Title") },
 108   { 0, NULL }
 109 };
 110
 111 static list_window_t *lw = NULL;
 112 static mpdclient_filelist_t *filelist = NULL;
 113 static GList *search_history = NULL;
 114 static gchar *pattern = NULL;
 115 static gboolean advanced_search_mode = FALSE;
 116
 117
 118 /* search info */
 119 static const char *
 120 lw_search_help_callback(unsigned idx, mpd_unused int *highlight,
 121                         mpd_unused void *data)
 122 {
 123         unsigned text_rows;
 124         static const char *text[] = {
 125                 "Quick  - just enter a string and ncmpc will search according",
 126                 "               to the current search mode (displayed above).",
 127                 "",
 128                 "Advanced  -  <tag>:<search term> [<tag>:<search term>...]",
 129                 "                       Example: artist:radiohead album:pablo honey",
 130                 "",
 131                 "                  avalible tags: artist, album, title, track,",
 132                 "                  name, genre, date composer, performer, comment, file",
 133                 "",
 134                 NULL
 135         };
 136
 137         text_rows=0;
 138         while (text[text_rows])
 139                 text_rows++;
 140
 141         if (idx < text_rows)
 142                 return text[idx];
 143         return NULL;
 144 }
 145
 146 /* the playlist have been updated -> fix highlights */
 147 static void
 148 playlist_changed_callback(mpdclient_t *c, int event, mpd_unused gpointer data)
 149 {
 150   if( filelist==NULL )
 151     return;
 152   D("screen_search.c> playlist_callback() [%d]\n", event);
 153   switch(event)
 154     {
 155     case PLAYLIST_EVENT_CLEAR:
 156       clear_highlights(filelist);
 157       break;
 158     default:
 159       sync_highlights(c, filelist);
 160       break;
 161     }
 162 }
 163
 164 /* sanity check search mode value */
 165 static void
 166 search_check_mode(void)
 167 {
 168   int max = 0;
 169
 170   while( mode[max].label != NULL )
 171     max++;
 172   if( options.search_mode<0 )
 173     options.search_mode = 0;
 174   else if( options.search_mode>=max )
 175     options.search_mode = max-1;
 176 }
 177
 178 static void
 179 search_clear(mpd_unused screen_t *screen, mpdclient_t *c,
 180              gboolean clear_pattern)
 181 {
 182         if (filelist) {
 183                 mpdclient_remove_playlist_callback(c, playlist_changed_callback);
 184                 mpdclient_filelist_free(filelist);
 185                 filelist = NULL;
 186         }
 187         if (clear_pattern && pattern) {
 188                 g_free(pattern);
 189                 pattern = NULL;
 190         }
 191 }
 192
 193 #ifdef FUTURE
 194 static mpdclient_filelist_t *
 195 filelist_search(mpdclient_t *c, mpd_unused int exact_match, int table,
 196                 gchar *local_pattern)
 197 {
 198   mpdclient_filelist_t *list, *list2;
 199
 200   if( table == SEARCH_ARTIST_TITLE )
 201     {
 202       list = mpdclient_filelist_search(c, FALSE, MPD_TABLE_ARTIST,
 203                                        local_pattern);
 204       list2 = mpdclient_filelist_search(c, FALSE, MPD_TABLE_TITLE,
 205                                         local_pattern);
 206
 207       list->length += list2->length;
 208       list->list = g_list_concat(list->list, list2->list);
 209       list->list = g_list_sort(list->list, compare_filelistentry_format);
 210       list->updated = TRUE;
 211     }
 212   else
 213     {
 214       list = mpdclient_filelist_search(c, FALSE, table, local_pattern);
 215     }
 216
 217   return list;
 218 }
 219
 220 /*-----------------------------------------------------------------------
 221  * NOTE: This code exists to test a new search ui,
 222  *       Its ugly and MUST be redesigned before the next release!
 223  *-----------------------------------------------------------------------
 224  */
 225 static mpdclient_filelist_t *
 226 search_advanced_query(char *query, mpdclient_t *c)
 227 {
 228         int i,j;
 229         char **strv;
 230         int table[10];
 231         char *arg[10];
 232         mpdclient_filelist_t *fl = NULL;
 233
 234         advanced_search_mode = FALSE;
 235         if( g_strrstr(query, ":") == NULL )
 236                 return NULL;
 237
 238         strv = g_strsplit_set(query, ": ", 0);
 239
 240         i=0;
 241         while (strv[i]) {
 242                 D("strv[%d] = \"%s\"\n", i, strv[i]);
 243                 i++;
 244         }
 245
 246         memset(table, 0, 10*sizeof(int));
 247         memset(arg, 0, 10*sizeof(char *));
 248
 249         i=0;
 250         j=0;
 251         while (strv[i] && strlen(strv[i]) > 0 && i < 9) {
 252                 int id = search_get_tag_id(strv[i]);
 253                 if (id == -1) {
 254                         if (table[j]) {
 255                                 char *tmp = arg[j];
 256                                 arg[j] = g_strdup_printf("%s %s", arg[j], strv[i]);
 257                                 g_free(tmp);
 258                         } else {
 259                                 D("Bad search tag %s\n", strv[i]);
 260                                 screen_status_printf(_("Bad search tag %s"), strv[i]);
 261                         }
 262                         i++;
 263                 } else if (strv[i+1] == NULL || strlen(strv[i+1]) == 0) {
 264                         D("No argument for search tag %s\n", strv[i]);
 265                         screen_status_printf(_("No argument for search tag %s"), strv[i]);
 266                         i++;
 267                         //        j--;
 268                         //table[j] = -1;
 269                 } else {
 270                         table[j] = id;
 271                         arg[j] = locale_to_utf8(strv[i+1]); // FREE ME
 272                         j++;
 273                         table[j] = -1;
 274                         arg[j] = NULL;
 275                         i = i + 2;
 276                         advanced_search_mode = TRUE;
 277                 }
 278         }
 279
 280         g_strfreev(strv);
 281
 282
 283         if (advanced_search_mode && j > 0) {
 284                 int iter;
 285                 mpd_InfoEntity *entity;
 286
 287                 /*-----------------------------------------------------------------------
 288                  * NOTE (again): This code exists to test a new search ui,
 289                  *               Its ugly and MUST be redesigned before the next release!
 290                  *             + the code below should live in mpdclient.c
 291                  *-----------------------------------------------------------------------
 292                  */
 293                 /** stupid - but this is just a test...... (fulhack)  */
 294                 mpd_startSearch(c->connection, FALSE);
 295
 296                 for(iter = 0; iter < 10; iter++) {
 297                         mpd_addConstraintSearch(c->connection, table[iter], arg[iter]);
 298                 }
 299
 300                 mpd_commitSearch(c->connection);
 301
 302                 fl = g_malloc0(sizeof(mpdclient_filelist_t));
 303
 304                 while ((entity=mpd_getNextInfoEntity(c->connection)))  {
 305                         filelist_entry_t *entry = g_malloc0(sizeof(filelist_entry_t));
 306
 307                         entry->entity = entity;
 308                         fl->list = g_list_append(fl->list, (gpointer) entry);
 309                         fl->length++;
 310                 }
 311
 312                 if (mpdclient_finish_command(c) && fl)
 313                         mpdclient_filelist_free(fl);
 314
 315                 fl->updated = TRUE;
 316         }
 317
 318         i=0;
 319         while( arg[i] )
 320                 g_free(arg[i++]);
 321
 322         return fl;
 323 }
 324 #else
 325 #define search_advanced_query(pattern,c) (NULL)
 326 #endif
 327
 328 static void
 329 search_new(screen_t *screen, mpdclient_t *c)
 330 {
 331   search_clear(screen, c, TRUE);
 332
 333   pattern = screen_readln(screen->status_window.w,
 334                           _("Search: "),
 335                           NULL,
 336                           &search_history,
 337                           NULL);
 338
 339   if( pattern && strcmp(pattern,"")==0 )
 340     {
 341       g_free(pattern);
 342       pattern=NULL;
 343     }
 344
 345   if( pattern==NULL )
 346     {
 347       list_window_reset(lw);
 348       return;
 349     }
 350
 351   if( !MPD_VERSION_LT(c, 0, 12, 0) )
 352     filelist = search_advanced_query(pattern, c);
 353   if( !advanced_search_mode && filelist==NULL )
 354     filelist = filelist_search(c,
 355                                FALSE,
 356                                mode[options.search_mode].table,
 357                                pattern);
 358   sync_highlights(c, filelist);
 359   mpdclient_install_playlist_callback(c, playlist_changed_callback);
 360   list_window_check_selected(lw, filelist->length);
 361 }
 362
 363
 364
 365 static void
 366 init(WINDOW *w, int cols, int rows)
 367 {
 368         lw = list_window_init(w, cols, rows);
 369 }
 370
 371 static void
 372 quit(void)
 373 {
 374         if (search_history)
 375                 string_list_free(search_history);
 376         if (filelist)
 377                 mpdclient_filelist_free(filelist);
 378         list_window_free(lw);
 379
 380         if (pattern) {
 381                 g_free(pattern);
 382                 pattern = NULL;
 383         }
 384 }
 385
 386 static void
 387 open(mpd_unused screen_t *screen, mpd_unused mpdclient_t *c)
 388 {
 389   //  if( pattern==NULL )
 390   //    search_new(screen, c);
 391   // else
 392   screen_status_printf(_("Press %s for a new search"),
 393                          get_key_names(CMD_SCREEN_SEARCH,0));
 394   search_check_mode();
 395 }
 396
 397 static void
 398 resize(int cols, int rows)
 399 {
 400   lw->cols = cols;
 401   lw->rows = rows;
 402 }
 403
 404 static void
 405 paint(mpd_unused screen_t *screen, mpdclient_t *c)
 406 {
 407   lw->clear = 1;
 408
 409   if( filelist )
 410     {
 411       lw->flags = 0;
 412       list_window_paint(lw, browse_lw_callback, (void *) filelist);
 413       filelist->updated = FALSE;
 414     }
 415   else
 416     {
 417       lw->flags = LW_HIDE_CURSOR;
 418       list_window_paint(lw, lw_search_help_callback, NULL);
 419       if( !MPD_VERSION_LT(c, 0, 12, 0) )
 420         g_strdup_printf("Advanced search disabled (MPD version < 0.12.0");
 421       //      wmove(lw->w, 0, 0);
 422       //wclrtobot(lw->w);
 423     }
 424   wnoutrefresh(lw->w);
 425 }
 426
 427 static void
 428 update(screen_t *screen, mpdclient_t *c)
 429 {
 430   if( filelist==NULL || filelist->updated )
 431     {
 432       paint(screen, c);
 433       return;
 434     }
 435   list_window_paint(lw, browse_lw_callback, (void *) filelist);
 436   wnoutrefresh(lw->w);
 437 }
 438
 439 static const char *
 440 get_title(char *str, size_t size)
 441 {
 442   if( advanced_search_mode && pattern )
 443     g_snprintf(str, size, _("Search: %s"), pattern);
 444   else if( pattern )
 445     g_snprintf(str, size,
 446                _("Search: Results for %s [%s]"),
 447                pattern,
 448                _(mode[options.search_mode].label));
 449   else
 450     g_snprintf(str, size, _("Search: Press %s for a new search [%s]"),
 451                get_key_names(CMD_SCREEN_SEARCH,0),
 452                _(mode[options.search_mode].label));
 453
 454   return str;
 455 }
 456
 457 static int
 458 search_cmd(screen_t *screen, mpdclient_t *c, command_t cmd)
 459 {
 460   switch(cmd)
 461     {
 462     case CMD_PLAY:
 463        browse_handle_enter(screen, c, lw, filelist);
 464       return 1;
 465
 466     case CMD_SELECT:
 467       if( browse_handle_select(screen, c, lw, filelist) == 0 )
 468         {
 469           /* continue and select next item... */
 470           cmd = CMD_LIST_NEXT;
 471         }
 472       /* call list_window_cmd to go to the next item */
 473       return list_window_cmd(lw, filelist->length, cmd);
 474
 475     case CMD_SELECT_ALL:
 476       browse_handle_select_all (screen, c, lw, filelist);
 477       paint (screen, c);
 478       return 0;
 479
 480     case CMD_SEARCH_MODE:
 481       options.search_mode++;
 482       if( mode[options.search_mode].label == NULL )
 483         options.search_mode = 0;
 484       screen_status_printf(_("Search mode: %s"),
 485                            _(mode[options.search_mode].label));
 486       /* continue and update... */
 487     case CMD_SCREEN_UPDATE:
 488       if( pattern )
 489         {
 490           search_clear(screen, c, FALSE);
 491           filelist = filelist_search(c,
 492                                      FALSE,
 493                                      mode[options.search_mode].table,
 494                                      pattern);
 495           sync_highlights(c, filelist);
 496         }
 497       return 1;
 498
 499     case CMD_SCREEN_SEARCH:
 500       search_new(screen, c);
 501       return 1;
 502
 503     case CMD_CLEAR:
 504       search_clear(screen, c, TRUE);
 505       list_window_reset(lw);
 506       return 1;
 507
 508     case CMD_LIST_FIND:
 509     case CMD_LIST_RFIND:
 510     case CMD_LIST_FIND_NEXT:
 511     case CMD_LIST_RFIND_NEXT:
 512       if( filelist )
 513         return screen_find(screen,
 514                            lw, filelist->length,
 515                            cmd, browse_lw_callback, (void *) filelist);
 516       else
 517         return 1;
 518
 519     case CMD_MOUSE_EVENT:
 520       return browse_handle_mouse_event(screen,c,lw,filelist);
 521
 522     default:
 523       if( filelist )
 524         return list_window_cmd(lw, filelist->length, cmd);
 525     }
 526
 527   return 0;
 528 }
 529
 530 const struct screen_functions screen_search = {
 531         .init = init,
 532         .exit = quit,
 533         .open = open,
 534         .resize = resize,
 535         .paint = paint,
 536         .update = update,
 537         .cmd = search_cmd,
 538         .get_title = get_title,
 539 };
 540
 541 #endif /* ENABLE_SEARCH_SCREEN */