Code

screen_*: eliminate redundant wrefresh() calls
[ncmpc.git] / src / screen_lyrics.c
index 51bb903a88ad108edb153d7a9f946433021646fd..b937e79bc3792ca16030d766178989d746faec9c 100644 (file)
@@ -1,32 +1,40 @@
 /* ncmpc (Ncurses MPD Client)
- * (c) 2004-2009 The Music Player Daemon Project
+ * (c) 2004-2017 The Music Player Daemon Project
  * Project homepage: http://musicpd.org
+ *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
-
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
-
+ *
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-*/
+ */
 
-#include <sys/stat.h>
+#include "screen_lyrics.h"
+#include "screen_interface.h"
+#include "screen_status.h"
+#include "screen_file.h"
+#include "screen_song.h"
 #include "i18n.h"
 #include "options.h"
 #include "mpdclient.h"
-#include "command.h"
 #include "screen.h"
-#include "strfsong.h"
 #include "lyrics.h"
 #include "screen_text.h"
+#include "screen_utils.h"
+#include "ncu.h"
 
+#include <assert.h>
+#include <errno.h>
+#include <sys/stat.h>
+#include <sys/wait.h>
 #include <stdlib.h>
 #include <string.h>
 #include <glib.h>
 
 static struct screen_text text;
 
-static const struct mpd_song *next_song;
+static struct mpd_song *next_song;
+static bool follow = false;
+/** Set if the cursor position shall be kept during the next lyrics update. */
+static bool reloading = false;
 
 static struct {
        struct mpd_song *song;
 
-       char *artist, *title;
+       char *artist, *title, *plugin_name;
 
        struct plugin_cycle *loader;
+
+       guint loader_timeout;
 } current;
 
 static void
@@ -53,6 +66,16 @@ screen_lyrics_abort(void)
                current.loader = NULL;
        }
 
+       if (current.loader_timeout != 0) {
+               g_source_remove(current.loader_timeout);
+               current.loader_timeout = 0;
+       }
+
+       if (current.plugin_name != NULL) {
+               g_free(current.plugin_name);
+               current.plugin_name = NULL;
+       }
+
        if (current.artist != NULL) {
                g_free(current.artist);
                current.artist = NULL;
@@ -60,11 +83,11 @@ screen_lyrics_abort(void)
 
        if (current.title != NULL) {
                g_free(current.title);
-               current.artist = NULL;
+               current.title = NULL;
        }
 
        if (current.song != NULL) {
-               mpd_freeSong(current.song);
+               mpd_song_free(current.song);
                current.song = NULL;
        }
 }
@@ -82,15 +105,21 @@ lyrics_repaint_if_active(void)
        }
 }
 
+static void
+path_lyr_file(char *path, size_t size,
+               const char *artist, const char *title)
+{
+       snprintf(path, size, "%s/.lyrics/%s - %s.txt",
+                       getenv("HOME"), artist, title);
+}
+
 static bool
 exists_lyr_file(const char *artist, const char *title)
 {
        char path[1024];
-       struct stat result;
-
-       snprintf(path, 1024, "%s/.lyrics/%s - %s.txt",
-                getenv("HOME"), artist, title);
+       path_lyr_file(path, 1024, artist, title);
 
+       struct stat result;
        return (stat(path, &result) == 0);
 }
 
@@ -98,13 +127,11 @@ static FILE *
 create_lyr_file(const char *artist, const char *title)
 {
        char path[1024];
-
        snprintf(path, 1024, "%s/.lyrics",
                 getenv("HOME"));
        mkdir(path, S_IRWXU);
 
-       snprintf(path, 1024, "%s/.lyrics/%s - %s.txt",
-                getenv("HOME"), artist, title);
+       path_lyr_file(path, 1024, artist, title);
 
        return fopen(path, "w");
 }
@@ -112,14 +139,11 @@ create_lyr_file(const char *artist, const char *title)
 static int
 store_lyr_hd(void)
 {
-       FILE *lyr_file;
-       unsigned i;
-
-       lyr_file = create_lyr_file(current.artist, current.title);
+       FILE *lyr_file = create_lyr_file(current.artist, current.title);
        if (lyr_file == NULL)
                return -1;
 
-       for (i = 0; i < text.lines->len; ++i)
+       for (unsigned i = 0; i < text.lines->len; ++i)
                fprintf(lyr_file, "%s\n",
                        (const char*)g_ptr_array_index(text.lines, i));
 
@@ -127,55 +151,121 @@ store_lyr_hd(void)
        return 0;
 }
 
+static int
+delete_lyr_hd(void)
+{
+       if (!exists_lyr_file(current.artist, current.title))
+               return -1;
+
+       char path[1024];
+       path_lyr_file(path, 1024, current.artist, current.title);
+       if (unlink(path) != 0)
+               return -2;
+
+       return 0;
+}
+
 static void
 screen_lyrics_set(const GString *str)
 {
-       screen_text_set(&text, str);
+       if (reloading) {
+               unsigned saved_start = text.lw->start;
+
+               screen_text_set(&text, str->str);
+
+               /* restore the cursor and ensure that it's still valid */
+               text.lw->start = saved_start;
+               list_window_fetch_cursor(text.lw);
+       } else {
+               screen_text_set(&text, str->str);
+       }
+
+       reloading = false;
 
        /* paint new data */
 
        lyrics_repaint_if_active();
-
-       if (options.lyrics_autosave &&
-           !exists_lyr_file(current.artist, current.title))
-               store_lyr_hd();
 }
 
 static void
-screen_lyrics_callback(const GString *result, G_GNUC_UNUSED void *data)
+screen_lyrics_callback(const GString *result, const bool success,
+                      const char *plugin_name, gcc_unused void *data)
 {
        assert(current.loader != NULL);
 
+       current.plugin_name = g_strdup(plugin_name);
+
+       /* Display result, which may be lyrics or error messages */
        if (result != NULL)
                screen_lyrics_set(result);
-       else
+
+       if (success == true) {
+               if (options.lyrics_autosave &&
+                   !exists_lyr_file(current.artist, current.title))
+                       store_lyr_hd();
+       } else {
                /* translators: no lyrics were found for the song */
                screen_status_message (_("No lyrics"));
+       }
+
+       if (current.loader_timeout != 0) {
+               g_source_remove(current.loader_timeout);
+               current.loader_timeout = 0;
+       }
+
+       plugin_stop(current.loader);
+       current.loader = NULL;
+}
 
+static gboolean
+screen_lyrics_timeout_callback(gpointer gcc_unused data)
+{
        plugin_stop(current.loader);
        current.loader = NULL;
+
+       screen_status_printf(_("Lyrics timeout occurred after %d seconds"),
+                            options.lyrics_timeout);
+
+       current.loader_timeout = 0;
+       return FALSE;
 }
 
 static void
 screen_lyrics_load(const struct mpd_song *song)
 {
-       char buffer[MAX_SONGNAME_LENGTH];
-
        assert(song != NULL);
 
        screen_lyrics_abort();
        screen_text_clear(&text);
 
-       current.song = mpd_songDup(song);
+       const char *artist = mpd_song_get_tag(song, MPD_TAG_ARTIST, 0);
+       const char *title = mpd_song_get_tag(song, MPD_TAG_TITLE, 0);
 
-       strfsong(buffer, sizeof(buffer), "%artist%", song);
-       current.artist = g_strdup(buffer);
-
-       strfsong(buffer, sizeof(buffer), "%title%", song);
-       current.title = g_strdup(buffer);
+       current.song = mpd_song_dup(song);
+       current.artist = g_strdup(artist);
+       current.title = g_strdup(title);
 
        current.loader = lyrics_load(current.artist, current.title,
                                     screen_lyrics_callback, NULL);
+
+       if (options.lyrics_timeout != 0) {
+               current.loader_timeout =
+                       g_timeout_add_seconds(options.lyrics_timeout,
+                                             screen_lyrics_timeout_callback,
+                                             NULL);
+       }
+}
+
+static void
+screen_lyrics_reload(void)
+{
+       if (current.loader == NULL && current.artist != NULL &&
+           current.title != NULL) {
+               reloading = true;
+               current.loader = lyrics_load(current.artist, current.title,
+                                            screen_lyrics_callback, NULL);
+               screen_text_repaint(&text);
+       }
 }
 
 static void
@@ -199,19 +289,35 @@ lyrics_exit(void)
 }
 
 static void
-lyrics_open(mpdclient_t *c)
+lyrics_open(struct mpdclient *c)
 {
-       if (next_song == NULL)
-               next_song = c->song;
+       const struct mpd_song *next_song_c =
+               next_song != NULL ? next_song : c->song;
 
-       if (next_song != NULL &&
+       if (next_song_c != NULL &&
            (current.song == NULL ||
-            strcmp(next_song->file, current.song->file) != 0))
-               screen_lyrics_load(next_song);
+            strcmp(mpd_song_get_uri(next_song_c),
+                   mpd_song_get_uri(current.song)) != 0))
+               screen_lyrics_load(next_song_c);
 
-       next_song = NULL;
+       if (next_song != NULL) {
+               mpd_song_free(next_song);
+               next_song = NULL;
+       }
 }
 
+static void
+lyrics_update(struct mpdclient *c)
+{
+       if (!follow)
+               return;
+
+       if (c->song != NULL &&
+           (current.song == NULL ||
+            strcmp(mpd_song_get_uri(c->song),
+                   mpd_song_get_uri(current.song)) != 0))
+               screen_lyrics_load(c->song);
+}
 
 static const char *
 lyrics_title(char *str, size_t size)
@@ -225,9 +331,16 @@ lyrics_title(char *str, size_t size)
                return str;
        } else if (current.artist != NULL && current.title != NULL &&
                   !screen_text_is_empty(&text)) {
-               snprintf(str, size, "%s: %s - %s",
-                        _("Lyrics"),
-                        current.artist, current.title);
+               int n;
+               n = snprintf(str, size, "%s: %s - %s",
+                            _("Lyrics"),
+                            current.artist, current.title);
+
+               if (options.lyrics_show_plugin && current.plugin_name != NULL &&
+                   (unsigned int) n < size - 1)
+                       snprintf(str + n, size - n, " (%s)",
+                                current.plugin_name);
+
                return str;
        } else
                return _("Lyrics");
@@ -239,8 +352,74 @@ lyrics_paint(void)
        screen_text_paint(&text);
 }
 
+/* save current lyrics to a file and run editor on it */
+static void
+lyrics_edit(void)
+{
+       char *editor = options.text_editor;
+       if (editor == NULL) {
+               screen_status_message(_("Editor not configured"));
+               return;
+       }
+
+       if (options.text_editor_ask) {
+               char *buf = g_strdup_printf(
+                   _("Do you really want to start an editor and edit these lyrics [%s/%s]? "),
+                                           YES, NO);
+               bool really = screen_get_yesno(buf, false);
+               g_free(buf);
+               if (!really) {
+                       screen_status_message(_("Aborted"));
+                       return;
+               }
+       }
+
+       if (store_lyr_hd() < 0)
+               return;
+
+       ncu_deinit();
+
+       /* TODO: fork/exec/wait won't work on Windows, but building a command
+          string for system() is too tricky */
+       int status;
+       pid_t pid = fork();
+       if (pid == -1) {
+               screen_status_printf(("%s (%s)"), _("Can't start editor"), g_strerror(errno));
+               ncu_init();
+               return;
+       } else if (pid == 0) {
+               char path[1024];
+               path_lyr_file(path, sizeof(path), current.artist, current.title);
+               execlp(editor, editor, path, NULL);
+               /* exec failed, do what system does */
+               _exit(127);
+       } else {
+               int ret;
+               do {
+                       ret = waitpid(pid, &status, 0);
+               } while (ret == -1 && errno == EINTR);
+       }
+
+       ncu_init();
+
+       /* TODO: hardly portable */
+       if (WIFEXITED(status)) {
+               if (WEXITSTATUS(status) == 0)
+                       /* update to get the changes */
+                       screen_lyrics_reload();
+               else if (WEXITSTATUS(status) == 127)
+                       screen_status_message(_("Can't start editor"));
+               else
+                       screen_status_printf(_("Editor exited unexpectedly (%d)"),
+                                            WEXITSTATUS(status));
+       } else if (WIFSIGNALED(status)) {
+               screen_status_printf(_("Editor exited unexpectedly (signal %d)"),
+                                    WTERMSIG(status));
+       }
+}
+
 static bool
-lyrics_cmd(mpdclient_t *c, command_t cmd)
+lyrics_cmd(struct mpdclient *c, command_t cmd)
 {
        if (screen_text_cmd(&text, c, cmd))
                return true;
@@ -258,12 +437,31 @@ lyrics_cmd(mpdclient_t *c, command_t cmd)
                        /* lyrics for the song were saved on hard disk */
                        screen_status_message (_("Lyrics saved"));
                return true;
+       case CMD_DELETE:
+               if (current.loader == NULL && current.artist != NULL &&
+                   current.title != NULL) {
+                       switch (delete_lyr_hd()) {
+                       case 0:
+                               screen_status_message (_("Lyrics deleted"));
+                               break;
+                       case -1:
+                               screen_status_message (_("No saved lyrics"));
+                               break;
+                       }
+               }
+               return true;
        case CMD_LYRICS_UPDATE:
                if (c->song != NULL) {
                        screen_lyrics_load(c->song);
-                       screen_text_repaint(&text);
+                       screen_text_paint(&text);
                }
                return true;
+       case CMD_EDIT:
+               lyrics_edit();
+               return true;
+       case CMD_SELECT:
+               screen_lyrics_reload();
+               return true;
 
 #ifdef ENABLE_SONG_SCREEN
        case CMD_SCREEN_SONG:
@@ -297,6 +495,7 @@ const struct screen_functions screen_lyrics = {
        .init = lyrics_screen_init,
        .exit = lyrics_exit,
        .open = lyrics_open,
+       .update = lyrics_update,
        .close = NULL,
        .resize = lyrics_resize,
        .paint = lyrics_paint,
@@ -305,10 +504,11 @@ const struct screen_functions screen_lyrics = {
 };
 
 void
-screen_lyrics_switch(struct mpdclient *c, const struct mpd_song *song)
+screen_lyrics_switch(struct mpdclient *c, const struct mpd_song *song, bool f)
 {
        assert(song != NULL);
 
-       next_song = song;
+       follow = f;
+       next_song = mpd_song_dup(song);
        screen_switch(&screen_lyrics, c);
 }