apps/filetree.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2005 by Björn Stenberg
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21 #include <stdlib.h>
  22 #include <file.h>
  23 #include <dir.h>
  24 #include <string.h>
  25 #include <kernel.h>
  26 #include <lcd.h>
  27 #include <debug.h>
  28 #include <font.h>
  29 #include <limits.h>
  30 #include "bookmark.h"
  31 #include "tree.h"
  32 #include "settings.h"
  33 #include "filetypes.h"
  34 #include "talk.h"
  35 #include "playlist.h"
  36 #include "gwps.h"
  37 #include "lang.h"
  38 #include "language.h"
  39 #include "screens.h"
  40 #include "plugin.h"
  41 #include "rolo.h"
  42 #include "sprintf.h"
  43 #include "splash.h"
  44 #include "cuesheet.h"
  45 #include "filetree.h"
  46 #include "misc.h"
  47 #include "strnatcmp.h"
  48 #ifdef HAVE_LCD_BITMAP
  49 #include "keyboard.h"
  50 #endif
  51
  52 #if CONFIG_TUNER
  53 #include "radio.h"
  54 #endif
  55
  56 #include "backdrop.h"
  57
  58 static int compare_sort_dir; /* qsort key for sorting directories */
  59
  60 int ft_build_playlist(struct tree_context* c, int start_index)
  61 {
  62     int i;
  63     int start=start_index;
  64
  65     struct entry *dircache = c->dircache;
  66
  67     for(i = 0;i < c->filesindir;i++)
  68     {
  69         if((dircache[i].attr & FILE_ATTR_MASK) == FILE_ATTR_AUDIO)
  70         {
  71             if (playlist_add(dircache[i].name) < 0)
  72                 break;
  73         }
  74         else
  75         {
  76             /* Adjust the start index when se skip non-MP3 entries */
  77             if(i < start)
  78                 start_index--;
  79         }
  80     }
  81
  82     return start_index;
  83 }
  84
  85 /* Start playback of a playlist, checking for bookmark autoload, modified
  86  * playlists, etc., as required. Returns false if playback wasn't started,
  87  * or started via bookmark autoload, true otherwise.
  88  *
  89  * Pointers to both the full pathname and the separated parts needed to
  90  * avoid allocating yet another path buffer on the stack (and save some
  91  * code; the caller typically needs to create the full pathname anyway)...
  92  */
  93 bool ft_play_playlist(char* pathname, char* dirname, char* filename)
  94 {
  95     if (global_settings.party_mode && audio_status())
  96     {
  97         splash(HZ, ID2P(LANG_PARTY_MODE));
  98         return false;
  99     }
 100
 101     if (bookmark_autoload(pathname))
 102     {
 103         return false;
 104     }
 105
 106     splash(0, ID2P(LANG_WAIT));
 107
 108     /* about to create a new current playlist...
 109        allow user to cancel the operation */
 110     if (!warn_on_pl_erase())
 111         return false;
 112
 113     if (playlist_create(dirname, filename) != -1)
 114     {
 115         if (global_settings.playlist_shuffle)
 116         {
 117             playlist_shuffle(current_tick, -1);
 118         }
 119
 120         playlist_start(0, 0);
 121         return true;
 122     }
 123
 124     return false;
 125 }
 126
 127 /* walk a directory and check all dircache entries if a .talk file exists */
 128 static void check_file_thumbnails(struct tree_context* c)
 129 {
 130     int i;
 131     struct dirent *entry;
 132     struct entry* dircache = c->dircache;
 133     DIR *dir;
 134
 135     dir = opendir(c->currdir);
 136     if(!dir)
 137         return;
 138     /* mark all files as non talking, except the .talk ones */
 139     for (i=0; i < c->filesindir; i++)
 140     {
 141         if (dircache[i].attr & ATTR_DIRECTORY)
 142             continue; /* we're not touching directories */
 143
 144         if (strcasecmp(file_thumbnail_ext,
 145             &dircache[i].name[strlen(dircache[i].name)
 146                               - strlen(file_thumbnail_ext)]))
 147         {   /* no .talk file */
 148             dircache[i].attr &= ~FILE_ATTR_THUMBNAIL; /* clear */
 149         }
 150         else
 151         {   /* .talk file, we later let them speak themselves */
 152             dircache[i].attr |= FILE_ATTR_THUMBNAIL; /* set */
 153         }
 154     }
 155
 156     while((entry = readdir(dir)) != 0) /* walk directory */
 157     {
 158         int ext_pos;
 159
 160         ext_pos = strlen((char *)entry->d_name) - strlen(file_thumbnail_ext);
 161         if (ext_pos <= 0 /* too short to carry ".talk" */
 162             || (entry->attribute & ATTR_DIRECTORY) /* no file */
 163             || strcasecmp((char *)&entry->d_name[ext_pos], file_thumbnail_ext))
 164         {   /* or doesn't end with ".talk", no candidate */
 165             continue;
 166         }
 167
 168         /* terminate the (disposable) name in dir buffer,
 169            this truncates off the ".talk" without needing an extra buffer */
 170         entry->d_name[ext_pos] = '\0';
 171
 172         /* search corresponding file in dir cache */
 173         for (i=0; i < c->filesindir; i++)
 174         {
 175             if (!strcasecmp(dircache[i].name, (char *)entry->d_name))
 176             {   /* match */
 177                 dircache[i].attr |= FILE_ATTR_THUMBNAIL; /* set the flag */
 178                 break; /* exit search loop, because we found it */
 179             }
 180         }
 181     }
 182     closedir(dir);
 183 }
 184
 185 /* support function for qsort() */
 186 static int compare(const void* p1, const void* p2)
 187 {
 188     struct entry* e1 = (struct entry*)p1;
 189     struct entry* e2 = (struct entry*)p2;
 190     int criteria;
 191
 192     if (e1->attr & ATTR_DIRECTORY && e2->attr & ATTR_DIRECTORY)
 193     {   /* two directories */
 194         criteria = compare_sort_dir;
 195
 196 #ifdef HAVE_MULTIVOLUME
 197         if (e1->attr & ATTR_VOLUME || e2->attr & ATTR_VOLUME)
 198         {   /* a volume identifier is involved */
 199             if (e1->attr & ATTR_VOLUME && e2->attr & ATTR_VOLUME)
 200                 criteria = SORT_ALPHA; /* two volumes: sort alphabetically */
 201             else /* only one is a volume: volume first */
 202                 return (e2->attr & ATTR_VOLUME) - (e1->attr & ATTR_VOLUME);
 203         }
 204 #endif
 205
 206     }
 207     else if (!(e1->attr & ATTR_DIRECTORY) && !(e2->attr & ATTR_DIRECTORY))
 208     {   /* two files */
 209         criteria = global_settings.sort_file;
 210     }
 211     else /* dir and file, dir goes first */
 212         return (e2->attr & ATTR_DIRECTORY) - (e1->attr & ATTR_DIRECTORY);
 213
 214     switch(criteria)
 215     {
 216         case SORT_TYPE:
 217         case SORT_TYPE_REVERSED:
 218         {
 219             int t1 = e1->attr & FILE_ATTR_MASK;
 220             int t2 = e2->attr & FILE_ATTR_MASK;
 221
 222             if (!t1) /* unknown type */
 223                 t1 = INT_MAX; /* gets a high number, to sort after known */
 224             if (!t2) /* unknown type */
 225                 t2 = INT_MAX; /* gets a high number, to sort after known */
 226
 227             if (t1 != t2) /* if different */
 228                 return (t1 - t2) * (criteria == SORT_TYPE_REVERSED ? -1 : 1);
 229             /* else fall through to alphabetical sorting */
 230         }
 231
 232         case SORT_DATE:
 233         case SORT_DATE_REVERSED:
 234             /* Ignore SORT_TYPE */
 235             if (criteria == SORT_DATE || criteria == SORT_DATE_REVERSED)
 236             {
 237                 if (e1->time_write != e2->time_write)
 238                     return (e1->time_write - e2->time_write)
 239                            * (criteria == SORT_DATE_REVERSED ? -1 : 1);
 240                 /* else fall through to alphabetical sorting */
 241             }
 242
 243         case SORT_ALPHA:
 244         case SORT_ALPHA_REVERSED:
 245         {
 246             if (global_settings.sort_case)
 247             {
 248                 if (global_settings.interpret_numbers == SORT_INTERPRET_AS_NUMBER)
 249                     return strnatcmp(e1->name, e2->name)
 250                            * (criteria == SORT_ALPHA_REVERSED ? -1 : 1);
 251                 else
 252                     return strncmp(e1->name, e2->name, MAX_PATH)
 253                            * (criteria == SORT_ALPHA_REVERSED ? -1 : 1);
 254             }
 255             else
 256             {
 257                 if (global_settings.interpret_numbers == SORT_INTERPRET_AS_NUMBER)
 258                     return strnatcasecmp(e1->name, e2->name)
 259                            * (criteria == SORT_ALPHA_REVERSED ? -1 : 1);
 260                 else
 261                     return strncasecmp(e1->name, e2->name, MAX_PATH)
 262                            * (criteria == SORT_ALPHA_REVERSED ? -1 : 1);
 263             }
 264         }
 265
 266     }
 267     return 0; /* never reached */
 268 }
 269
 270 /* load and sort directory into dircache. returns NULL on failure. */
 271 int ft_load(struct tree_context* c, const char* tempdir)
 272 {
 273     int i;
 274     int name_buffer_used = 0;
 275     DIR *dir;
 276
 277     if (tempdir)
 278         dir = opendir(tempdir);
 279     else
 280         dir = opendir(c->currdir);
 281     if(!dir)
 282         return -1; /* not a directory */
 283
 284     c->dirsindir = 0;
 285     c->dirfull = false;
 286
 287     for ( i=0; i < global_settings.max_files_in_dir; i++ ) {
 288         int len;
 289         struct dirent *entry = readdir(dir);
 290         struct entry* dptr =
 291             (struct entry*)(c->dircache + i * sizeof(struct entry));
 292         if (!entry)
 293             break;
 294
 295         len = strlen((char *)entry->d_name);
 296
 297         /* skip directories . and .. */
 298         if ((entry->attribute & ATTR_DIRECTORY) &&
 299             (((len == 1) && (!strncmp((char *)entry->d_name, ".", 1))) ||
 300              ((len == 2) && (!strncmp((char *)entry->d_name, "..", 2))))) {
 301             i--;
 302             continue;
 303         }
 304
 305         /* Skip FAT volume ID */
 306         if (entry->attribute & ATTR_VOLUME_ID) {
 307             i--;
 308             continue;
 309         }
 310
 311         /* filter out dotfiles and hidden files */
 312         if (*c->dirfilter != SHOW_ALL &&
 313             ((entry->d_name[0]=='.') ||
 314             (entry->attribute & ATTR_HIDDEN))) {
 315             i--;
 316             continue;
 317         }
 318
 319         dptr->attr = entry->attribute;
 320
 321         /* check for known file types */
 322         if ( !(dptr->attr & ATTR_DIRECTORY) )
 323             dptr->attr |= filetype_get_attr((char *)entry->d_name);
 324
 325         /* filter out non-visible files */
 326         if ((!(dptr->attr & ATTR_DIRECTORY) && (
 327             (*c->dirfilter == SHOW_PLAYLIST &&
 328              (dptr->attr & FILE_ATTR_MASK) != FILE_ATTR_M3U) ||
 329             ((*c->dirfilter == SHOW_MUSIC &&
 330              (dptr->attr & FILE_ATTR_MASK) != FILE_ATTR_AUDIO) &&
 331              (dptr->attr & FILE_ATTR_MASK) != FILE_ATTR_M3U) ||
 332             (*c->dirfilter == SHOW_SUPPORTED && !filetype_supported(dptr->attr)))) ||
 333             (*c->dirfilter == SHOW_WPS && (dptr->attr & FILE_ATTR_MASK) != FILE_ATTR_WPS) ||
 334 #ifdef HAVE_REMOTE_LCD
 335             (*c->dirfilter == SHOW_RWPS && (dptr->attr & FILE_ATTR_MASK) != FILE_ATTR_RWPS) ||
 336 #endif
 337 #if CONFIG_TUNER
 338             (*c->dirfilter == SHOW_FMR && (dptr->attr & FILE_ATTR_MASK) != FILE_ATTR_FMR) ||
 339 #endif
 340             (*c->dirfilter == SHOW_CFG && (dptr->attr & FILE_ATTR_MASK) != FILE_ATTR_CFG) ||
 341             (*c->dirfilter == SHOW_LNG && (dptr->attr & FILE_ATTR_MASK) != FILE_ATTR_LNG) ||
 342             (*c->dirfilter == SHOW_MOD && (dptr->attr & FILE_ATTR_MASK) != FILE_ATTR_MOD) ||
 343             (*c->dirfilter == SHOW_FONT && (dptr->attr & FILE_ATTR_MASK) != FILE_ATTR_FONT) ||
 344             (*c->dirfilter == SHOW_PLUGINS && (dptr->attr & FILE_ATTR_MASK) != FILE_ATTR_ROCK))
 345         {
 346             i--;
 347             continue;
 348         }
 349
 350         if (len > c->name_buffer_size - name_buffer_used - 1) {
 351             /* Tell the world that we ran out of buffer space */
 352             c->dirfull = true;
 353             break;
 354         }
 355         dptr->name = &c->name_buffer[name_buffer_used];
 356         dptr->time_write =
 357             (long)entry->wrtdate<<16 |
 358             (long)entry->wrttime; /* in one # */
 359         strcpy(dptr->name, (char *)entry->d_name);
 360         name_buffer_used += len + 1;
 361
 362         if (dptr->attr & ATTR_DIRECTORY) /* count the remaining dirs */
 363             c->dirsindir++;
 364     }
 365     c->filesindir = i;
 366     c->dirlength = i;
 367     closedir(dir);
 368
 369     compare_sort_dir = c->sort_dir;
 370     qsort(c->dircache,i,sizeof(struct entry),compare);
 371
 372     /* If thumbnail talking is enabled, make an extra run to mark files with
 373        associated thumbnails, so we don't do unsuccessful spinups later. */
 374     if (global_settings.talk_file_clip)
 375         check_file_thumbnails(c); /* map .talk to ours */
 376
 377     return 0;
 378 }
 379
 380 int ft_enter(struct tree_context* c)
 381 {
 382     int rc = 0;
 383     char buf[MAX_PATH];
 384     struct entry *dircache = c->dircache;
 385     struct entry* file = &dircache[c->selected_item];
 386     bool reload_dir = false;
 387     bool start_wps = false;
 388     bool exit_func = false;
 389
 390     if (c->currdir[1])
 391         snprintf(buf,sizeof(buf),"%s/%s",c->currdir, file->name);
 392     else
 393         snprintf(buf,sizeof(buf),"/%s",file->name);
 394
 395     if (file->attr & ATTR_DIRECTORY) {
 396         memcpy(c->currdir, buf, sizeof(c->currdir));
 397         if ( c->dirlevel < MAX_DIR_LEVELS )
 398             c->selected_item_history[c->dirlevel] = c->selected_item;
 399         c->dirlevel++;
 400         c->selected_item=0;
 401     }
 402     else {
 403         int seed = current_tick;
 404         bool play = false;
 405         int start_index=0;
 406
 407         switch ( file->attr & FILE_ATTR_MASK ) {
 408             case FILE_ATTR_M3U:
 409                 play = ft_play_playlist(buf, c->currdir, file->name);
 410
 411                 if (play)
 412                 {
 413                     start_index = 0;
 414                 }
 415
 416                 break;
 417
 418             case FILE_ATTR_AUDIO:
 419                 if (bookmark_autoload(c->currdir))
 420                     break;
 421
 422                 splash(0, ID2P(LANG_WAIT));
 423
 424                 /* about to create a new current playlist...
 425                    allow user to cancel the operation */
 426                 if (!warn_on_pl_erase())
 427                     break;
 428
 429                 if (global_settings.party_mode && audio_status())
 430                 {
 431                     playlist_insert_track(NULL, buf,
 432                                           PLAYLIST_INSERT_LAST, true, true);
 433                     splash(HZ, ID2P(LANG_QUEUE_LAST));
 434                 }
 435                 else if (playlist_create(c->currdir, NULL) != -1)
 436                 {
 437                     start_index = ft_build_playlist(c, c->selected_item);
 438                     if (global_settings.playlist_shuffle)
 439                     {
 440                         start_index = playlist_shuffle(seed, start_index);
 441
 442                         /* when shuffling dir.: play all files
 443                            even if the file selected by user is
 444                            not the first one */
 445                         if (!global_settings.play_selected)
 446                             start_index = 0;
 447                     }
 448
 449                     playlist_start(start_index, 0);
 450                     play = true;
 451                 }
 452                 break;
 453
 454 #if CONFIG_TUNER
 455                 /* fmr preset file */
 456             case FILE_ATTR_FMR:
 457                 splash(0, ID2P(LANG_WAIT));
 458
 459                 /* Preset inside the default folder. */
 460                 if(!strncasecmp(FMPRESET_PATH, buf, strlen(FMPRESET_PATH)))
 461                 {
 462                     set_file(buf, global_settings.fmr_file, MAX_FILENAME);
 463                     radio_load_presets(global_settings.fmr_file);
 464                     if(!in_radio_screen())
 465                         radio_screen();
 466                 }
 467                 /*
 468                  * Preset outside default folder, we can choose such only
 469                  * if we are out of the radio screen, so the check for the
 470                  * radio status isn't neccessary
 471                  */
 472                 else
 473                 {
 474                     radio_load_presets(buf);
 475                     radio_screen();
 476                 }
 477
 478                 break;
 479 #endif
 480
 481
 482                 /* wps config file */
 483             case FILE_ATTR_WPS:
 484                 splash(0, ID2P(LANG_WAIT));
 485 #if LCD_DEPTH > 1
 486                 unload_wps_backdrop();
 487 #endif
 488                 wps_data_load(gui_wps[0].data, &screens[0], buf, true);
 489                 set_file(buf, (char *)global_settings.wps_file,
 490                          MAX_FILENAME);
 491                 break;
 492
 493 #if defined(HAVE_REMOTE_LCD) && (NB_SCREENS > 1)
 494                 /* remote-wps config file */
 495             case FILE_ATTR_RWPS:
 496                 splash(0, ID2P(LANG_WAIT));
 497 #if defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1
 498                 unload_remote_wps_backdrop();
 499 #endif
 500                 wps_data_load(gui_wps[1].data, &screens[1], buf, true);
 501                 set_file(buf, (char *)global_settings.rwps_file,
 502                          MAX_FILENAME);
 503                 break;
 504 #endif
 505
 506             case FILE_ATTR_CFG:
 507                 splash(0, ID2P(LANG_WAIT));
 508                 if (!settings_load_config(buf,true))
 509                     break;
 510                 splash(HZ, ID2P(LANG_SETTINGS_LOADED));
 511                 break;
 512
 513             case FILE_ATTR_BMARK:
 514                 splash(0, ID2P(LANG_WAIT));
 515                 bookmark_load(buf, false);
 516                 reload_dir = true;
 517                 break;
 518
 519             case FILE_ATTR_LNG:
 520                 splash(0, ID2P(LANG_WAIT));
 521                 if(!lang_load(buf)) {
 522                     set_file(buf, (char *)global_settings.lang_file,
 523                              MAX_FILENAME);
 524                     talk_init(); /* use voice of same language */
 525                     splash(HZ, ID2P(LANG_LANGUAGE_LOADED));
 526                 }
 527                 break;
 528
 529 #ifdef HAVE_LCD_BITMAP
 530             case FILE_ATTR_FONT:
 531                 splash(0, ID2P(LANG_WAIT));
 532                 font_load(buf);
 533                 set_file(buf, (char *)global_settings.font_file, MAX_FILENAME);
 534                 break;
 535
 536             case FILE_ATTR_KBD:
 537                 splash(0, ID2P(LANG_WAIT));
 538                 if (!load_kbd(buf))
 539                     splash(HZ, ID2P(LANG_KEYBOARD_LOADED));
 540                 set_file(buf, (char *)global_settings.kbd_file, MAX_FILENAME);
 541                 break;
 542 #endif
 543
 544 #ifndef SIMULATOR
 545                 /* firmware file */
 546             case FILE_ATTR_MOD:
 547                 splash(0, ID2P(LANG_WAIT));
 548                 rolo_load(buf);
 549                 break;
 550 #endif
 551
 552                 /* plugin file */
 553             case FILE_ATTR_ROCK:
 554                 if (global_settings.party_mode && audio_status()) {
 555                     splash(HZ, ID2P(LANG_PARTY_MODE));
 556                     break;
 557                 }
 558
 559                 if (plugin_load(buf,NULL) == PLUGIN_USB_CONNECTED)
 560                 {
 561                     if(*c->dirfilter > NUM_FILTER_MODES)
 562                         /* leave sub-browsers after usb, doing
 563                            otherwise might be confusing to the user */
 564                         exit_func = true;
 565                     else
 566                         reload_dir = true;
 567                 }
 568                 break;
 569
 570             case FILE_ATTR_CUE:
 571                 display_cuesheet_content(buf);
 572                 break;
 573
 574             default:
 575             {
 576                 const char* plugin;
 577
 578                 if (global_settings.party_mode && audio_status()) {
 579                     splash(HZ, ID2P(LANG_PARTY_MODE));
 580                     break;
 581                 }
 582
 583                 plugin = filetype_get_plugin(file);
 584                 if (plugin)
 585                 {
 586                     if (plugin_load(plugin,buf) == PLUGIN_USB_CONNECTED)
 587                         reload_dir = true;
 588                 }
 589                 break;
 590             }
 591         }
 592
 593         if ( play ) {
 594             /* the resume_index must always be the index in the
 595                shuffled list in case shuffle is enabled */
 596             global_status.resume_index = start_index;
 597             global_status.resume_offset = 0;
 598             status_save();
 599
 600             start_wps = true;
 601         }
 602         else {
 603             if (*c->dirfilter > NUM_FILTER_MODES &&
 604                 *c->dirfilter != SHOW_CFG &&
 605                 *c->dirfilter != SHOW_FONT &&
 606                 *c->dirfilter != SHOW_PLUGINS)
 607             {
 608                 exit_func = true;
 609             }
 610         }
 611     }
 612
 613     if (reload_dir)
 614         rc = 1;
 615     if (start_wps)
 616         rc = 2;
 617     if (exit_func)
 618         rc = 3;
 619
 620     return rc;
 621 }
 622
 623 int ft_exit(struct tree_context* c)
 624 {
 625     extern char lastfile[]; /* from tree.c */
 626     char buf[MAX_PATH];
 627     int rc = 0;
 628     bool exit_func = false;
 629
 630     int i = strlen(c->currdir);
 631     if (i>1) {
 632         while (c->currdir[i-1]!='/')
 633             i--;
 634         strcpy(buf,&c->currdir[i]);
 635         if (i==1)
 636             c->currdir[i]=0;
 637         else
 638             c->currdir[i-1]=0;
 639
 640         if (*c->dirfilter > NUM_FILTER_MODES && c->dirlevel < 1)
 641             exit_func = true;
 642
 643         c->dirlevel--;
 644         if ( c->dirlevel < MAX_DIR_LEVELS )
 645             c->selected_item=c->selected_item_history[c->dirlevel];
 646         else
 647             c->selected_item=0;
 648
 649         /* if undefined position */
 650         if (c->selected_item == -1)
 651             strcpy(lastfile, buf);
 652     }
 653     else
 654     {
 655         if (*c->dirfilter > NUM_FILTER_MODES && c->dirlevel < 1)
 656             exit_func = true;
 657     }
 658
 659     if (exit_func)
 660         rc = 3;
 661
 662     return rc;
 663 }