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