apps/plugins/shortcuts/shortcuts_view.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2007 Bryan Childs
  11  * Copyright (c) 2007 Alexander Levin
  12  *
  13  * This program is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU General Public License
  15  * as published by the Free Software Foundation; either version 2
  16  * of the License, or (at your option) any later version.
  17  *
  18  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19  * KIND, either express or implied.
  20  *
  21  ****************************************************************************/
  22
  23 #include "shortcuts.h"
  24
  25 PLUGIN_HEADER
  26
  27 enum sc_list_action_type
  28 {
  29     SCLA_NONE,
  30     SCLA_SELECT,
  31     SCLA_DELETE,
  32     SCLA_USB,
  33 };
  34
  35
  36 static char *link_filename;
  37 static bool user_file;
  38 static bool usb_connected = false;
  39
  40 enum sc_list_action_type draw_sc_list(struct gui_synclist *gui_sc);
  41
  42 /* Will be passed sc_file* as data */
  43 char* build_sc_list(int selected_item, void *data,
  44                     char *buffer, size_t buffer_len);
  45
  46 /* Returns true iff we should leave the main loop */
  47 bool list_sc(void);
  48
  49 bool goto_entry(char *file_or_dir);
  50 bool ends_with(char *str, char *suffix);
  51
  52
  53 enum sc_list_action_type draw_sc_list(struct gui_synclist *gui_sc)
  54 {
  55     int button;
  56
  57     rb->gui_synclist_draw(gui_sc);
  58
  59     while (true) {
  60         /* user input */
  61         button = rb->get_action(CONTEXT_LIST, TIMEOUT_BLOCK);
  62         if (rb->gui_synclist_do_button(gui_sc, &button,
  63                                             LIST_WRAP_UNLESS_HELD)) {
  64             /* automatic handling of user input.
  65             * _UNLESS_HELD can be _ON or _OFF also
  66             * selection changed, so redraw */
  67             continue;
  68         }
  69         switch (button) { /* process the user input */
  70             case ACTION_STD_OK:
  71                 return SCLA_SELECT;
  72             case ACTION_STD_MENU:
  73                 /* Only allow delete entries in the default file
  74                  * since entries can be appended (with a plugin)
  75                  * to the default file only. The behaviour is thus
  76                  * symmetric in this respect. */
  77                 if (!user_file) {
  78                     return SCLA_DELETE;
  79                 }
  80                 break;
  81             case ACTION_STD_CANCEL:
  82                 return SCLA_NONE;
  83             default:
  84                 if (rb->default_event_handler(button) == SYS_USB_CONNECTED) {
  85                     return SCLA_USB;
  86                 }
  87         }
  88     }
  89 }
  90
  91
  92 char* build_sc_list(int selected_item, void *data,
  93                     char *buffer, size_t buffer_len)
  94 {
  95     sc_file_t *file = (sc_file_t*)data;
  96
  97     if (!is_valid_index(file, selected_item)) {
  98         return NULL;
  99     }
 100     sc_entry_t *entry = file->entries + selected_item;
 101     rb->snprintf(buffer, buffer_len, "%s", entry->disp);
 102     return buffer;
 103 }
 104
 105
 106 bool list_sc(void)
 107 {
 108     int selected_item = 0;
 109     enum sc_list_action_type action = SCLA_NONE;
 110     struct gui_synclist gui_sc;
 111
 112     /* Setup the GUI list object, draw it to the screen,
 113      * and then handle the user input to it */
 114     rb->gui_synclist_init(&gui_sc, &build_sc_list, &sc_file, false, 1, NULL);
 115     rb->gui_synclist_set_title(&gui_sc,
 116         (user_file?"Shortcuts (sealed)":"Shortcuts (editable)"), NOICON);
 117     rb->gui_synclist_set_nb_items(&gui_sc, sc_file.entry_cnt);
 118     rb->gui_synclist_limit_scroll(&gui_sc, false);
 119     rb->gui_synclist_select_item(&gui_sc, 0);
 120
 121     /* Draw the prepared widget to the LCD now */
 122     action = draw_sc_list(&gui_sc);
 123     if (action == SCLA_USB) {
 124         usb_connected = true;
 125         return true;
 126     }
 127
 128     /* which item do we action? */
 129     selected_item = rb->gui_synclist_get_sel_pos(&gui_sc);
 130
 131     if (!is_valid_index(&sc_file, selected_item)) {
 132         /* This should never happen */
 133         rb->splash(HZ*2, "Bad entry selected!");
 134         return true;
 135     }
 136
 137     /* perform the following actions if the user "selected"
 138      * the item in the list (i.e. they want to go there
 139      * in the filebrowser tree */
 140     switch(action) {
 141         case SCLA_SELECT:
 142             return goto_entry(sc_file.entries[selected_item].path);
 143         case SCLA_DELETE:
 144             rb->splashf(HZ, "Deleting %s", sc_file.entries[selected_item].disp);
 145             remove_entry(&sc_file, selected_item);
 146             dump_sc_file(&sc_file, link_filename);
 147             return (sc_file.entry_cnt == 0);
 148         default:
 149             return true;
 150     }
 151 }
 152
 153
 154 bool goto_entry(char *file_or_dir)
 155 {
 156     DEBUGF("Trying to go to '%s'...\n", file_or_dir);
 157
 158     bool is_dir = ends_with(file_or_dir, PATH_SEPARATOR);
 159     bool exists;
 160     char *what;
 161     if (is_dir) {
 162         what = "Directory";
 163         exists = rb->dir_exists(file_or_dir);
 164     } else {
 165         what = "File";
 166         exists = rb->file_exists(file_or_dir);
 167     }
 168
 169     if (!exists) {
 170         rb->splashf(HZ*2, "%s %s no longer exists on disk", what, file_or_dir);
 171         return false;
 172     }
 173     /* Set the browsers dirfilter to the global setting
 174      * This is required in case the plugin was launched
 175      * from the plugins browser, in which case the
 176      * dirfilter is set to only display .rock files */
 177     rb->set_dirfilter(rb->global_settings->dirfilter);
 178
 179     /* Change directory to the entry selected by the user */
 180     rb->set_current_file(file_or_dir);
 181     return true;
 182 }
 183
 184
 185 bool ends_with(char *string, char *suffix)
 186 {
 187     unsigned int str_len = rb->strlen(string);
 188     unsigned int sfx_len = rb->strlen(suffix);
 189     if (str_len < sfx_len)
 190         return false;
 191     return (rb->strncmp(string + str_len - sfx_len, suffix, sfx_len) == 0);
 192 }
 193
 194
 195 enum plugin_status plugin_start(const void* void_parameter)
 196 {
 197     bool leave_loop;
 198
 199     /* This is a viewer, so a parameter must have been specified */
 200     if (void_parameter == NULL) {
 201         rb->splash(HZ*2, "No parameter specified!");
 202         return PLUGIN_ERROR;
 203     }
 204     link_filename = (char*)void_parameter;
 205     user_file = (rb->strcmp(link_filename, SHORTCUTS_FILENAME) != 0);
 206
 207     allocate_memory(&memory_buf, &memory_bufsize);
 208
 209     if (!load_sc_file(&sc_file, link_filename, true,
 210             memory_buf, memory_bufsize)) {
 211         DEBUGF("Could not load %s\n", link_filename);
 212         return PLUGIN_ERROR;
 213     }
 214     if (sc_file.entry_cnt==0) {
 215         rb->splash(HZ*2, "No shortcuts in the file!");
 216         return PLUGIN_OK;
 217     } else if ((sc_file.entry_cnt==1) && user_file) {
 218         /* if there's only one entry in the user .link file,
 219          * go straight to it without displaying the menu
 220          * thus allowing 'quick links' */
 221         goto_entry(sc_file.entries[0].path);
 222         return PLUGIN_OK;
 223     }
 224
 225     do {
 226         /* Display a menu to choose between the entries */
 227         leave_loop = list_sc();
 228     } while (!leave_loop);
 229
 230     return usb_connected ? PLUGIN_USB_CONNECTED : PLUGIN_OK;
 231 }