apps/bookmark.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  *
   9  * Copyright (C)2003 by Benjamin Metzler
  10  *
  11  * All files in this archive are subject to the GNU General Public License.
  12  * See the file COPYING in the source tree root for full license agreement.
  13  *
  14  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  15  * KIND, either express or implied.
  16  *
  17  ****************************************************************************/
  18
  19 #include <stdio.h>
  20 #include <stdlib.h>
  21 #include <string.h>
  22 #include <stdbool.h>
  23
  24 #include "applimits.h"
  25 #include "lcd.h"
  26 #include "action.h"
  27 #include "usb.h"
  28 #include "audio.h"
  29 #include "playlist.h"
  30 #include "settings.h"
  31 #include "tree.h"
  32 #include "bookmark.h"
  33 #include "dir.h"
  34 #include "status.h"
  35 #include "system.h"
  36 #include "errno.h"
  37 #include "icons.h"
  38 #include "atoi.h"
  39 #include "string.h"
  40 #include "menu.h"
  41 #include "lang.h"
  42 #include "screens.h"
  43 #include "status.h"
  44 #include "debug.h"
  45 #include "kernel.h"
  46 #include "sprintf.h"
  47 #include "talk.h"
  48 #include "misc.h"
  49 #include "abrepeat.h"
  50 #include "splash.h"
  51 #include "yesno.h"
  52 #include "list.h"
  53 #include "plugin.h"
  54
  55 #if (LCD_DEPTH > 1) || (defined(HAVE_LCD_REMOTE) && (LCD_REMOTE_DEPTH > 1))
  56 #include "backdrop.h"
  57 #endif
  58
  59 #define MAX_BOOKMARKS 10
  60 #define MAX_BOOKMARK_SIZE  350
  61 #define RECENT_BOOKMARK_FILE ROCKBOX_DIR "/most-recent.bmark"
  62
  63 /* Used to buffer bookmarks while displaying the bookmark list. */
  64 struct bookmark_list
  65 {
  66     const char* filename;
  67     size_t buffer_size;
  68     int start;
  69     int count;
  70     int total_count;
  71     bool show_dont_resume;
  72     bool reload;
  73     char* items[];
  74 };
  75
  76 static bool  add_bookmark(const char* bookmark_file_name, const char* bookmark,
  77                           bool most_recent);
  78 static bool  check_bookmark(const char* bookmark);
  79 static char* create_bookmark(void);
  80 static bool  delete_bookmark(const char* bookmark_file_name, int bookmark_id);
  81 static void  say_bookmark(const char* bookmark,
  82                           int bookmark_id);
  83 static bool play_bookmark(const char* bookmark);
  84 static bool  generate_bookmark_file_name(const char *in);
  85 static const char* skip_token(const char* s);
  86 static const char* int_token(const char* s, int* dest);
  87 static const char* long_token(const char* s, long* dest);
  88 static const char* bool_token(const char* s, bool* dest);
  89 static bool  parse_bookmark(const char *bookmark,
  90                             int *resume_index,
  91                             int *resume_offset,
  92                             int *resume_seed,
  93                             int *resume_first_index,
  94                             char* resume_file,
  95                             unsigned int resume_file_size,
  96                             long* ms,
  97                             int * repeat_mode,
  98                             bool *shuffle,
  99                             char* file_name);
 100 static int buffer_bookmarks(struct bookmark_list* bookmarks, int first_line);
 101 static char* get_bookmark_info(int list_index, void* data, char *buffer);
 102 static char* select_bookmark(const char* bookmark_file_name, bool show_dont_resume);
 103 static bool  system_check(void);
 104 static bool  write_bookmark(bool create_bookmark_file);
 105 static int   get_bookmark_count(const char* bookmark_file_name);
 106
 107 static char global_temp_buffer[MAX_PATH+1];
 108 /* File name created by generate_bookmark_file_name */
 109 static char global_bookmark_file_name[MAX_PATH];
 110 static char global_read_buffer[MAX_BOOKMARK_SIZE];
 111 /* Bookmark created by create_bookmark*/
 112 static char global_bookmark[MAX_BOOKMARK_SIZE];
 113 /* Filename from parsed bookmark (can be made local where needed) */
 114 static char global_filename[MAX_PATH];
 115
 116 /* ----------------------------------------------------------------------- */
 117 /* This is the interface function from the main menu.                      */
 118 /* ----------------------------------------------------------------------- */
 119 bool bookmark_create_menu(void)
 120 {
 121     write_bookmark(true);
 122     return false;
 123 }
 124
 125 /* ----------------------------------------------------------------------- */
 126 /* This function acts as the load interface from the main menu             */
 127 /* This function determines the bookmark file name and then loads that file*/
 128 /* for the user.  The user can then select a bookmark to load.             */
 129 /* If no file/directory is currently playing, the menu item does not work. */
 130 /* ----------------------------------------------------------------------- */
 131 bool bookmark_load_menu(void)
 132 {
 133     if (system_check())
 134     {
 135         char* name = playlist_get_name(NULL, global_temp_buffer,
 136                                        sizeof(global_temp_buffer));
 137         if (generate_bookmark_file_name(name))
 138         {
 139             char* bookmark = select_bookmark(global_bookmark_file_name, false);
 140
 141             if (bookmark != NULL)
 142             {
 143                 return play_bookmark(bookmark);
 144             }
 145         }
 146     }
 147
 148     return false;
 149 }
 150
 151 /* ----------------------------------------------------------------------- */
 152 /* Gives the user a list of the Most Recent Bookmarks.  This is an         */
 153 /* interface function                                                      */
 154 /* ----------------------------------------------------------------------- */
 155 bool bookmark_mrb_load()
 156 {
 157     char* bookmark = select_bookmark(RECENT_BOOKMARK_FILE, false);
 158
 159     if (bookmark != NULL)
 160     {
 161         return play_bookmark(bookmark);
 162     }
 163
 164     return false;
 165 }
 166
 167 /* ----------------------------------------------------------------------- */
 168 /* This function handles an autobookmark creation.  This is an interface   */
 169 /* function.                                                               */
 170 /* ----------------------------------------------------------------------- */
 171 bool bookmark_autobookmark(void)
 172 {
 173     if (!system_check())
 174         return false;
 175
 176     audio_pause();    /* first pause playback */
 177     switch (global_settings.autocreatebookmark)
 178     {
 179         case BOOKMARK_YES:
 180             return write_bookmark(true);
 181
 182         case BOOKMARK_NO:
 183             return false;
 184
 185         case BOOKMARK_RECENT_ONLY_YES:
 186             return write_bookmark(false);
 187     }
 188 #ifdef HAVE_LCD_BITMAP
 189     unsigned char *lines[]={ID2P(LANG_AUTO_BOOKMARK_QUERY)};
 190     struct text_message message={(char **)lines, 1};
 191 #else
 192     unsigned char *lines[]={ID2P(LANG_AUTO_BOOKMARK_QUERY),
 193                             str(LANG_CONFIRM_WITH_BUTTON)};
 194     struct text_message message={(char **)lines, 2};
 195 #endif
 196 #if LCD_DEPTH > 1
 197     show_main_backdrop(); /* switch to main backdrop as we may come from wps */
 198 #endif
 199 #if defined(HAVE_REMOTE_LCD) && LCD_REMOTE_DEPTH > 1
 200     show_remote_main_backdrop();
 201 #endif
 202     gui_syncstatusbar_draw(&statusbars, false);
 203     if(gui_syncyesno_run(&message, NULL, NULL)==YESNO_YES)
 204     {
 205         if (global_settings.autocreatebookmark == BOOKMARK_RECENT_ONLY_ASK)
 206             return write_bookmark(false);
 207         else
 208             return write_bookmark(true);
 209     }
 210     return false;
 211 }
 212
 213 /* ----------------------------------------------------------------------- */
 214 /* This function takes the current current resume information and writes   */
 215 /* that to the beginning of the bookmark file.                             */
 216 /* This file will contain N number of bookmarks in the following format:   */
 217 /* resume_index*resume_offset*resume_seed*resume_first_index*              */
 218 /* resume_file*milliseconds*MP3 Title*                                     */
 219 /* ------------------------------------------------------------------------*/
 220 static bool write_bookmark(bool create_bookmark_file)
 221 {
 222     bool   success=false;
 223     char*  bookmark;
 224
 225     if (!system_check())
 226        return false; /* something didn't happen correctly, do nothing */
 227
 228     bookmark = create_bookmark();
 229     if (!bookmark)
 230        return false; /* something didn't happen correctly, do nothing */
 231
 232     if (global_settings.usemrb)
 233         success = add_bookmark(RECENT_BOOKMARK_FILE, bookmark, true);
 234
 235
 236     /* writing the bookmark */
 237     if (create_bookmark_file)
 238     {
 239         char* name = playlist_get_name(NULL, global_temp_buffer,
 240                                        sizeof(global_temp_buffer));
 241         if (generate_bookmark_file_name(name))
 242         {
 243             success = add_bookmark(global_bookmark_file_name, bookmark, false);
 244         }
 245     }
 246
 247     gui_syncsplash(HZ, success ? ID2P(LANG_BOOKMARK_CREATE_SUCCESS)
 248         : ID2P(LANG_BOOKMARK_CREATE_FAILURE));
 249
 250     return true;
 251 }
 252
 253 /* ----------------------------------------------------------------------- */
 254 /* This function adds a bookmark to a file.                                */
 255 /* ------------------------------------------------------------------------*/
 256 static bool add_bookmark(const char* bookmark_file_name, const char* bookmark,
 257                          bool most_recent)
 258 {
 259     int    temp_bookmark_file = 0;
 260     int    bookmark_file = 0;
 261     int    bookmark_count = 0;
 262     char*  playlist = NULL;
 263     char*  cp;
 264     char*  tmp;
 265     int    len = 0;
 266     bool   unique = false;
 267
 268     /* Opening up a temp bookmark file */
 269     snprintf(global_temp_buffer, sizeof(global_temp_buffer),
 270              "%s.tmp", bookmark_file_name);
 271     temp_bookmark_file = open(global_temp_buffer,
 272                               O_WRONLY | O_CREAT | O_TRUNC);
 273     if (temp_bookmark_file < 0)
 274         return false; /* can't open the temp file */
 275
 276     if (most_recent && (global_settings.usemrb == BOOKMARK_UNIQUE_ONLY))
 277     {
 278         playlist = strchr(bookmark,'/');
 279         cp = strrchr(bookmark,';');
 280         len = cp - playlist;
 281         unique = true;
 282     }
 283
 284     /* Writing the new bookmark to the begining of the temp file */
 285     write(temp_bookmark_file, bookmark, strlen(bookmark));
 286     write(temp_bookmark_file, "\n", 1);
 287     bookmark_count++;
 288
 289     /* Reading in the previous bookmarks and writing them to the temp file */
 290     bookmark_file = open(bookmark_file_name, O_RDONLY);
 291     if (bookmark_file >= 0)
 292     {
 293         while (read_line(bookmark_file, global_read_buffer,
 294                          sizeof(global_read_buffer)) > 0)
 295         {
 296             /* The MRB has a max of MAX_BOOKMARKS in it */
 297             /* This keeps it from getting too large */
 298             if (most_recent && (bookmark_count >= MAX_BOOKMARKS))
 299                 break;
 300
 301             cp  = strchr(global_read_buffer,'/');
 302             tmp = strrchr(global_read_buffer,';');
 303             if (check_bookmark(global_read_buffer) &&
 304                (!unique || len != tmp -cp || strncmp(playlist,cp,len)))
 305             {
 306                 bookmark_count++;
 307                 write(temp_bookmark_file, global_read_buffer,
 308                       strlen(global_read_buffer));
 309                 write(temp_bookmark_file, "\n", 1);
 310             }
 311         }
 312         close(bookmark_file);
 313     }
 314     close(temp_bookmark_file);
 315
 316     remove(bookmark_file_name);
 317     rename(global_temp_buffer, bookmark_file_name);
 318
 319     return true;
 320 }
 321
 322
 323 /* ----------------------------------------------------------------------- */
 324 /* This function takes the system resume data and formats it into a valid  */
 325 /* bookmark.                                                               */
 326 /* ----------------------------------------------------------------------- */
 327 static char* create_bookmark()
 328 {
 329     int resume_index = 0;
 330     char *file;
 331
 332     /* grab the currently playing track */
 333     struct mp3entry *id3 = audio_current_track();
 334     if(!id3)
 335         return NULL;
 336
 337     /* Get some basic resume information */
 338     /* queue_resume and queue_resume_index are not used and can be ignored.*/
 339     playlist_get_resume_info(&resume_index);
 340
 341     /* Get the currently playing file minus the path */
 342     /* This is used when displaying the available bookmarks */
 343     file = strrchr(id3->path,'/');
 344     if(NULL == file)
 345         return NULL;
 346
 347     /* create the bookmark */
 348     snprintf(global_bookmark, sizeof(global_bookmark),
 349              "%d;%ld;%d;%d;%ld;%d;%d;%s;%s",
 350              resume_index,
 351              id3->offset,
 352              playlist_get_seed(NULL),
 353              0,
 354              id3->elapsed,
 355              global_settings.repeat_mode,
 356              global_settings.playlist_shuffle,
 357              playlist_get_name(NULL, global_temp_buffer,
 358                 sizeof(global_temp_buffer)),
 359              file+1);
 360
 361     /* checking to see if the bookmark is valid */
 362     if (check_bookmark(global_bookmark))
 363         return global_bookmark;
 364     else
 365         return NULL;
 366 }
 367
 368 static bool check_bookmark(const char* bookmark)
 369 {
 370     return parse_bookmark(bookmark,
 371                           NULL,NULL,NULL, NULL,
 372                           NULL,0,NULL,NULL,
 373                           NULL, NULL);
 374 }
 375
 376 /* ----------------------------------------------------------------------- */
 377 /* This function will determine if an autoload is necessary.  This is an   */
 378 /* interface function.                                                     */
 379 /* ------------------------------------------------------------------------*/
 380 bool bookmark_autoload(const char* file)
 381 {
 382     int  fd;
 383
 384     if(global_settings.autoloadbookmark == BOOKMARK_NO)
 385         return false;
 386
 387     /*Checking to see if a bookmark file exists.*/
 388     if(!generate_bookmark_file_name(file))
 389     {
 390         return false;
 391     }
 392     fd = open(global_bookmark_file_name, O_RDONLY);
 393     if(fd<0)
 394         return false;
 395     close(fd);
 396     if(global_settings.autoloadbookmark == BOOKMARK_YES)
 397     {
 398         return bookmark_load(global_bookmark_file_name, true);
 399     }
 400     else
 401     {
 402         char* bookmark = select_bookmark(global_bookmark_file_name, true);
 403
 404         if (bookmark != NULL)
 405         {
 406             return play_bookmark(bookmark);
 407         }
 408
 409         return false;
 410     }
 411 }
 412
 413 /* ----------------------------------------------------------------------- */
 414 /* This function loads the bookmark information into the resume memory.    */
 415 /* This is an interface function.                                          */
 416 /* ------------------------------------------------------------------------*/
 417 bool bookmark_load(const char* file, bool autoload)
 418 {
 419     int  fd;
 420     char* bookmark = NULL;;
 421
 422     if(autoload)
 423     {
 424         fd = open(file, O_RDONLY);
 425         if(fd >= 0)
 426         {
 427             if(read_line(fd, global_read_buffer, sizeof(global_read_buffer)) > 0)
 428                 bookmark=global_read_buffer;
 429             close(fd);
 430         }
 431     }
 432     else
 433     {
 434         /* This is not an auto-load, so list the bookmarks */
 435         bookmark = select_bookmark(file, false);
 436     }
 437
 438     if (bookmark != NULL)
 439     {
 440         return play_bookmark(bookmark);
 441     }
 442
 443     return true;
 444 }
 445
 446
 447 static int get_bookmark_count(const char* bookmark_file_name)
 448 {
 449     int read_count = 0;
 450     int file = open(bookmark_file_name, O_RDONLY);
 451
 452     if(file < 0)
 453         return -1;
 454
 455     while(read_line(file, global_read_buffer, sizeof(global_read_buffer)) > 0)
 456     {
 457         read_count++;
 458     }
 459
 460     close(file);
 461     return read_count;
 462 }
 463
 464 static int buffer_bookmarks(struct bookmark_list* bookmarks, int first_line)
 465 {
 466     char* dest = ((char*) bookmarks) + bookmarks->buffer_size - 1;
 467     int read_count = 0;
 468     int file = open(bookmarks->filename, O_RDONLY);
 469
 470     if (file < 0)
 471     {
 472         return -1;
 473     }
 474
 475     if ((first_line != 0) && ((size_t) filesize(file) < bookmarks->buffer_size
 476             - sizeof(*bookmarks) - (sizeof(char*) * bookmarks->total_count)))
 477     {
 478         /* Entire file fits in buffer */
 479         first_line = 0;
 480     }
 481
 482     bookmarks->start = first_line;
 483     bookmarks->count = 0;
 484     bookmarks->reload = false;
 485
 486     while(read_line(file, global_read_buffer, sizeof(global_read_buffer)) > 0)
 487     {
 488         read_count++;
 489
 490         if (read_count >= first_line)
 491         {
 492             dest -= strlen(global_read_buffer) + 1;
 493
 494             if (dest < ((char*) bookmarks) + sizeof(*bookmarks)
 495                 + (sizeof(char*) * (bookmarks->count + 1)))
 496             {
 497                 break;
 498             }
 499
 500             strcpy(dest, global_read_buffer);
 501             bookmarks->items[bookmarks->count] = dest;
 502             bookmarks->count++;
 503         }
 504     }
 505
 506     close(file);
 507     return bookmarks->start + bookmarks->count;
 508 }
 509
 510 static char* get_bookmark_info(int list_index, void* data, char *buffer)
 511 {
 512     struct bookmark_list* bookmarks = (struct bookmark_list*) data;
 513     int     index = list_index / 2;
 514     int     resume_index = 0;
 515     long    resume_time = 0;
 516     bool    shuffle = false;
 517
 518     if (bookmarks->show_dont_resume)
 519     {
 520         if (index == 0)
 521         {
 522             return list_index % 2 == 0
 523                 ? (char*) str(LANG_BOOKMARK_DONT_RESUME) : " ";
 524         }
 525
 526         index--;
 527     }
 528
 529     if (bookmarks->reload || (index >= bookmarks->start + bookmarks->count)
 530         || (index < bookmarks->start))
 531     {
 532         int read_index = index;
 533
 534         /* Using count as a guide on how far to move could possibly fail
 535          * sometimes. Use byte count if that is a problem?
 536          */
 537
 538         if (read_index != 0)
 539         {
 540             /* Move count * 3 / 4 items in the direction the user is moving,
 541              * but don't go too close to the end.
 542              */
 543             int offset = bookmarks->count;
 544             int max = bookmarks->total_count - (bookmarks->count / 2);
 545
 546             if (read_index < bookmarks->start)
 547             {
 548                 offset *= 3;
 549             }
 550
 551             read_index = index - offset / 4;
 552
 553             if (read_index > max)
 554             {
 555                 read_index = max;
 556             }
 557
 558             if (read_index < 0)
 559             {
 560                 read_index = 0;
 561             }
 562         }
 563
 564         if (buffer_bookmarks(bookmarks, read_index) <= index)
 565         {
 566             return "";
 567         }
 568     }
 569
 570     if (!parse_bookmark(bookmarks->items[index - bookmarks->start],
 571         &resume_index, NULL, NULL, NULL, NULL, 0, &resume_time, NULL,
 572         &shuffle, global_filename))
 573     {
 574         return list_index % 2 == 0 ? (char*) str(LANG_BOOKMARK_INVALID) : " ";
 575     }
 576
 577     if (list_index % 2 == 0)
 578     {
 579         char* dot = strrchr(global_filename, '.');
 580
 581         if (dot)
 582         {
 583             *dot = '\0';
 584         }
 585
 586         return global_filename;
 587     }
 588     else
 589     {
 590         char time_buf[32];
 591
 592         format_time(time_buf, sizeof(time_buf), resume_time);
 593         snprintf(buffer, MAX_PATH, "%s, %d%s", time_buf, resume_index + 1,
 594             shuffle ? (char*) str(LANG_BOOKMARK_SHUFFLE) : "");
 595         return buffer;
 596     }
 597 }
 598
 599 /* ----------------------------------------------------------------------- */
 600 /* This displays a the bookmarks in a file and allows the user to          */
 601 /* select one to play.                                                     */
 602 /* ------------------------------------------------------------------------*/
 603 static char* select_bookmark(const char* bookmark_file_name, bool show_dont_resume)
 604 {
 605     struct bookmark_list* bookmarks;
 606     struct gui_synclist list;
 607     int last_item = -2;
 608     int item = 0;
 609     int action;
 610     size_t size;
 611     bool exit = false;
 612     bool refresh = true;
 613
 614     bookmarks = plugin_get_buffer(&size);
 615     bookmarks->buffer_size = size;
 616     bookmarks->show_dont_resume = show_dont_resume;
 617     bookmarks->filename = bookmark_file_name;
 618     bookmarks->start = 0;
 619     gui_synclist_init(&list, &get_bookmark_info, (void*) bookmarks, false, 2);
 620     gui_synclist_set_title(&list, str(LANG_BOOKMARK_SELECT_BOOKMARK),
 621         Icon_Bookmark);
 622     gui_syncstatusbar_draw(&statusbars, true);
 623
 624     while (!exit)
 625     {
 626         gui_syncstatusbar_draw(&statusbars, false);
 627
 628         if (refresh)
 629         {
 630             int count = get_bookmark_count(bookmark_file_name);
 631             bookmarks->total_count = count;
 632
 633             if (bookmarks->total_count < 1)
 634             {
 635                 /* No more bookmarks, delete file and exit */
 636                 gui_syncsplash(HZ, ID2P(LANG_BOOKMARK_LOAD_EMPTY));
 637                 remove(bookmark_file_name);
 638                 return NULL;
 639             }
 640
 641             if (bookmarks->show_dont_resume)
 642             {
 643                 count++;
 644                 item++;
 645             }
 646
 647             gui_synclist_set_nb_items(&list, count * 2);
 648
 649             if (item >= count)
 650             {
 651                 /* Selected item has been deleted */
 652                 item = count - 1;
 653                 gui_synclist_select_item(&list, item * 2);
 654             }
 655
 656             buffer_bookmarks(bookmarks, bookmarks->start);
 657             gui_synclist_draw(&list);
 658             refresh = false;
 659         }
 660
 661         action = get_action(CONTEXT_BOOKMARKSCREEN, HZ / 2);
 662         gui_synclist_do_button(&list, action, LIST_WRAP_UNLESS_HELD);
 663         item = gui_synclist_get_sel_pos(&list) / 2;
 664
 665         if (bookmarks->show_dont_resume)
 666         {
 667             item--;
 668         }
 669
 670         if (item != last_item && talk_menus_enabled())
 671         {
 672             last_item = item;
 673
 674             if (item == -1)
 675             {
 676                 talk_id(LANG_BOOKMARK_DONT_RESUME, true);
 677             }
 678             else
 679             {
 680                 say_bookmark(bookmarks->items[item - bookmarks->start], item);
 681             }
 682         }
 683
 684         if (action == ACTION_STD_CONTEXT)
 685         {
 686             MENUITEM_STRINGLIST(menu_items, ID2P(LANG_BOOKMARK_CONTEXT_MENU),
 687                 NULL, ID2P(LANG_BOOKMARK_CONTEXT_RESUME),
 688                 ID2P(LANG_BOOKMARK_CONTEXT_DELETE));
 689             static const int menu_actions[] =
 690             {
 691                 ACTION_STD_OK, ACTION_BMS_DELETE
 692             };
 693             int selection = do_menu(&menu_items, NULL);
 694
 695             refresh = true;
 696
 697             if (selection >= 0 && selection <=
 698                 (int) (sizeof(menu_actions) / sizeof(menu_actions[0])))
 699             {
 700                 action = menu_actions[selection];
 701             }
 702         }
 703
 704         switch (action)
 705         {
 706         case ACTION_STD_OK:
 707             if (item >= 0)
 708             {
 709                 return bookmarks->items[item - bookmarks->start];
 710             }
 711
 712             /* Else fall through */
 713
 714         case ACTION_TREE_WPS:
 715         case ACTION_STD_CANCEL:
 716             exit = true;
 717             break;
 718
 719         case ACTION_BMS_DELETE:
 720             if (item >= 0)
 721             {
 722                 delete_bookmark(bookmark_file_name, item);
 723                 bookmarks->reload = true;
 724                 refresh = true;
 725                 last_item = -2;
 726             }
 727             break;
 728
 729         default:
 730             if (default_event_handler(action) == SYS_USB_CONNECTED)
 731             {
 732                 exit = true;
 733             }
 734
 735             break;
 736         }
 737     }
 738
 739     return NULL;
 740 }
 741
 742 /* ----------------------------------------------------------------------- */
 743 /* This function takes a location in a bookmark file and deletes that      */
 744 /* bookmark.                                                               */
 745 /* ------------------------------------------------------------------------*/
 746 static bool delete_bookmark(const char* bookmark_file_name, int bookmark_id)
 747 {
 748     int temp_bookmark_file = 0;
 749     int bookmark_file = 0;
 750     int bookmark_count = 0;
 751
 752     /* Opening up a temp bookmark file */
 753     snprintf(global_temp_buffer, sizeof(global_temp_buffer),
 754              "%s.tmp", bookmark_file_name);
 755     temp_bookmark_file = open(global_temp_buffer,
 756                               O_WRONLY | O_CREAT | O_TRUNC);
 757
 758     if (temp_bookmark_file < 0)
 759         return false; /* can't open the temp file */
 760
 761     /* Reading in the previous bookmarks and writing them to the temp file */
 762     bookmark_file = open(bookmark_file_name, O_RDONLY);
 763     if (bookmark_file >= 0)
 764     {
 765         while (read_line(bookmark_file, global_read_buffer,
 766                          sizeof(global_read_buffer)) > 0)
 767         {
 768             if (bookmark_id != bookmark_count)
 769             {
 770                 write(temp_bookmark_file, global_read_buffer,
 771                       strlen(global_read_buffer));
 772                 write(temp_bookmark_file, "\n", 1);
 773             }
 774             bookmark_count++;
 775         }
 776         close(bookmark_file);
 777     }
 778     close(temp_bookmark_file);
 779
 780     remove(bookmark_file_name);
 781     rename(global_temp_buffer, bookmark_file_name);
 782
 783     return true;
 784 }
 785
 786 /* ----------------------------------------------------------------------- */
 787 /* This function parses a bookmark, says the voice UI part of it.          */
 788 /* ------------------------------------------------------------------------*/
 789 static void say_bookmark(const char* bookmark,
 790                          int bookmark_id)
 791 {
 792     int resume_index;
 793     long ms;
 794     char dir[MAX_PATH];
 795     bool enqueue = false; /* only the first voice is not queued */
 796
 797     if (!parse_bookmark(bookmark, &resume_index, NULL, NULL, NULL,
 798         dir, sizeof(dir), &ms, NULL, NULL, NULL))
 799     {
 800         talk_id(LANG_BOOKMARK_INVALID, true);
 801         return;
 802     }
 803
 804 /* disabled, because transition between talkbox and voice UI clip is not nice */
 805 #if 0
 806     if (global_settings.talk_dir >= 3)
 807     {   /* "talkbox" enabled */
 808         char* last = strrchr(dir, '/');
 809         if (last)
 810         {   /* compose filename for talkbox */
 811             strncpy(last + 1, dir_thumbnail_name, sizeof(dir)-(last-dir)-1);
 812             talk_file(dir, enqueue);
 813             enqueue = true;
 814         }
 815     }
 816 #endif
 817     talk_id(VOICE_EXT_BMARK, enqueue);
 818     talk_number(bookmark_id + 1, true);
 819     talk_id(VOICE_BOOKMARK_SELECT_INDEX_TEXT, true);
 820     talk_number(resume_index + 1, true);
 821     talk_id(LANG_TIME, true);
 822     if (ms / 60000)
 823         talk_value(ms / 60000, UNIT_MIN, true);
 824     talk_value((ms % 60000) / 1000, UNIT_SEC, true);
 825 }
 826
 827 /* ----------------------------------------------------------------------- */
 828 /* This function parses a bookmark and then plays it.                      */
 829 /* ------------------------------------------------------------------------*/
 830 static bool play_bookmark(const char* bookmark)
 831 {
 832     int index;
 833     int offset;
 834     int seed;
 835
 836     if (parse_bookmark(bookmark,
 837                        &index,
 838                        &offset,
 839                        &seed,
 840                        NULL,
 841                        global_temp_buffer,
 842                        sizeof(global_temp_buffer),
 843                        NULL,
 844                        &global_settings.repeat_mode,
 845                        &global_settings.playlist_shuffle,
 846                        global_filename))
 847     {
 848         bookmark_play(global_temp_buffer, index, offset, seed,
 849             global_filename);
 850         return true;
 851     }
 852
 853     return false;
 854 }
 855
 856 static const char* skip_token(const char* s)
 857 {
 858     while (*s && *s != ';')
 859     {
 860         s++;
 861     }
 862
 863     if (*s)
 864     {
 865         s++;
 866     }
 867
 868     return s;
 869 }
 870
 871 static const char* int_token(const char* s, int* dest)
 872 {
 873     if (dest != NULL)
 874     {
 875         *dest = atoi(s);
 876     }
 877
 878     return skip_token(s);
 879 }
 880
 881 static const char* long_token(const char* s, long* dest)
 882 {
 883     if (dest != NULL)
 884     {
 885         *dest = atoi(s);    /* Should be atol, but we don't have it. */
 886     }
 887
 888     return skip_token(s);
 889 }
 890
 891 static const char* bool_token(const char* s, bool* dest)
 892 {
 893     if (dest != NULL)
 894     {
 895         *dest = atoi(s) != 0;
 896     }
 897
 898     return skip_token(s);
 899 }
 900
 901 /* ----------------------------------------------------------------------- */
 902 /* This function takes a bookmark and parses it.  This function also       */
 903 /* validates the bookmark.  Passing in NULL for an output variable         */
 904 /* indicates that value is not requested.                                  */
 905 /* ----------------------------------------------------------------------- */
 906 static bool parse_bookmark(const char *bookmark,
 907                            int *resume_index,
 908                            int *resume_offset,
 909                            int *resume_seed,
 910                            int *resume_first_index,
 911                            char* resume_file,
 912                            unsigned int resume_file_size,
 913                            long* ms,
 914                            int * repeat_mode, bool *shuffle,
 915                            char* file_name)
 916 {
 917     const char* s = bookmark;
 918     const char* end;
 919
 920     s = int_token(s,  resume_index);
 921     s = int_token(s,  resume_offset);
 922     s = int_token(s,  resume_seed);
 923     s = int_token(s,  resume_first_index);
 924     s = long_token(s, ms);
 925     s = int_token(s,  repeat_mode);
 926     s = bool_token(s, shuffle);
 927
 928     if (*s == 0)
 929     {
 930         return false;
 931     }
 932
 933     end = strchr(s, ';');
 934
 935     if (resume_file != NULL)
 936     {
 937         size_t len = (end == NULL) ? strlen(s) : (size_t) (end - s);
 938
 939         len = MIN(resume_file_size - 1, len);
 940         strncpy(resume_file, s, len);
 941         resume_file[len] = 0;
 942     }
 943
 944     if (end != NULL && file_name != NULL)
 945     {
 946         end++;
 947         strncpy(file_name, end, MAX_PATH - 1);
 948         file_name[MAX_PATH - 1] = 0;
 949     }
 950
 951     return true;
 952 }
 953
 954 /* ----------------------------------------------------------------------- */
 955 /* This function is used by multiple functions and is used to generate a   */
 956 /* bookmark named based off of the input.                                  */
 957 /* Changing this function could result in how the bookmarks are stored.    */
 958 /* it would be here that the centralized/decentralized bookmark code       */
 959 /* could be placed.                                                        */
 960 /* ----------------------------------------------------------------------- */
 961 static bool generate_bookmark_file_name(const char *in)
 962 {
 963     int len = strlen(in);
 964
 965     /* if this is a root dir MP3, rename the bookmark file root_dir.bmark */
 966     /* otherwise, name it based on the in variable */
 967     if (!strcmp("/", in))
 968         strcpy(global_bookmark_file_name, "/root_dir.bmark");
 969     else
 970     {
 971         strcpy(global_bookmark_file_name, in);
 972         if(global_bookmark_file_name[len-1] == '/')
 973             len--;
 974         strcpy(&global_bookmark_file_name[len], ".bmark");
 975     }
 976
 977     return true;
 978 }
 979
 980 /* ----------------------------------------------------------------------- */
 981 /* Returns true if a bookmark file exists for the current playlist         */
 982 /* ----------------------------------------------------------------------- */
 983 bool bookmark_exist(void)
 984 {
 985     bool exist=false;
 986
 987     if(system_check())
 988     {
 989         char* name = playlist_get_name(NULL, global_temp_buffer,
 990                                        sizeof(global_temp_buffer));
 991         if (generate_bookmark_file_name(name))
 992         {
 993             int fd=open(global_bookmark_file_name, O_RDONLY);
 994             if (fd >=0)
 995             {
 996                 close(fd);
 997                 exist=true;
 998             }
 999         }
1000     }
1001
1002     return exist;
1003 }
1004
1005 /* ----------------------------------------------------------------------- */
1006 /* Checks the current state of the system and returns if it is in a        */
1007 /* bookmarkable state.                                                     */
1008 /* ----------------------------------------------------------------------- */
1009 /* Inputs:                                                                 */
1010 /* ----------------------------------------------------------------------- */
1011 /* Outputs:                                                                */
1012 /* return bool:  Indicates if the system was in a bookmarkable state       */
1013 /* ----------------------------------------------------------------------- */
1014 static bool system_check(void)
1015 {
1016     int resume_index = 0;
1017
1018     if (!(audio_status() && audio_current_track()))
1019     {
1020         /* no track playing */
1021         return false;
1022     }
1023
1024     /* Checking to see if playing a queued track */
1025     if (playlist_get_resume_info(&resume_index) == -1)
1026     {
1027         /* something bad happened while getting the queue information */
1028         return false;
1029     }
1030     else if (playlist_modified(NULL))
1031     {
1032         /* can't bookmark while in the queue */
1033         return false;
1034     }
1035
1036     return true;
1037 }
1038