1 /* ncmpc (Ncurses MPD Client)
2 * (c) 2004-2009 The Music Player Daemon Project
3 * Project homepage: http://musicpd.org
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
20 #include "conf.h"
21 #include "config.h"
22 #include "defaults.h"
23 #include "i18n.h"
24 #include "command.h"
25 #include "colors.h"
26 #include "screen_list.h"
28 #include <ctype.h>
29 #include <stdio.h>
30 #include <errno.h>
31 #include <stdlib.h>
32 #include <unistd.h>
33 #include <string.h>
34 #include <sys/types.h>
35 #include <sys/stat.h>
36 #include <fcntl.h>
37 #include <glib.h>
39 #define MAX_LINE_LENGTH 1024
40 #define COMMENT_TOKEN '#'
42 /* configuration field names */
43 #define CONF_ENABLE_COLORS "enable-colors"
44 #define CONF_SCROLL_OFFSET "scroll-offset"
45 #define CONF_AUTO_CENTER "auto-center"
46 #define CONF_WIDE_CURSOR "wide-cursor"
47 #define CONF_KEY_DEFINITION "key"
48 #define CONF_COLOR "color"
49 #define CONF_COLOR_DEFINITION "colordef"
50 #define CONF_LIST_FORMAT "list-format"
51 #define CONF_STATUS_FORMAT "status-format"
52 #define CONF_XTERM_TITLE_FORMAT "xterm-title-format"
53 #define CONF_LIST_WRAP "wrap-around"
54 #define CONF_FIND_WRAP "find-wrap"
55 #define CONF_FIND_SHOW_LAST "find-show-last"
56 #define CONF_AUDIBLE_BELL "audible-bell"
57 #define CONF_VISIBLE_BELL "visible-bell"
58 #define CONF_BELL_ON_WRAP "bell-on-wrap"
59 #define CONF_STATUS_MESSAGE_TIME "status-message-time"
60 #define CONF_XTERM_TITLE "set-xterm-title"
61 #define CONF_ENABLE_MOUSE "enable-mouse"
62 #define CONF_CROSSFADE_TIME "crossfade-time"
63 #define CONF_SEARCH_MODE "search-mode"
64 #define CONF_HIDE_CURSOR "hide-cursor"
65 #define CONF_SEEK_TIME "seek-time"
66 #define CONF_SCREEN_LIST "screen-list"
67 #define CONF_TIMEDISPLAY_TYPE "timedisplay-type"
68 #define CONF_HOST "host"
69 #define CONF_PORT "port"
70 #define CONF_PASSWORD "password"
71 #define CONF_LYRICS_TIMEOUT "lyrics-timeout"
72 #define CONF_SHOW_SPLASH "show-splash"
73 #define CONF_SCROLL "scroll"
74 #define CONF_SCROLL_SEP "scroll-sep"
75 #define CONF_VISIBLE_BITRATE "visible-bitrate"
76 #define CONF_WELCOME_SCREEN_LIST "welcome-screen-list"
77 #define CONF_DISPLAY_TIME "display-time"
78 #define CONF_JUMP_PREFIX_ONLY "jump-prefix-only"
79 #define CONF_LYRICS_AUTOSAVE "lyrics-autosave"
81 static bool
82 str2bool(char *str)
83 {
84 return strcasecmp(str, "yes") == 0 || strcasecmp(str, "true") == 0 ||
85 strcasecmp(str, "on") == 0 || strcasecmp(str, "1") == 0;
86 }
88 static void
89 print_error(const char *msg, const char *input)
90 {
91 fprintf(stderr, "%s: %s ('%s')\n",
92 /* To translators: prefix for error messages */
93 _("Error"), msg, input);
94 }
96 static int
97 parse_key_value(char *str, char **end)
98 {
99 if (*str == '\'') {
100 if (str[1] == '\'' || str[2] != '\'') {
101 print_error(_("Malformed hotkey definition"), str);
102 return -1;
103 }
105 *end = str + 3;
106 return str[1];
107 } else {
108 long value = strtol(str, end, 0);
109 if (*end == str) {
110 print_error(_("Malformed hotkey definition"), str);
111 return -1;
112 }
114 return (int)value;
115 }
116 }
118 static int
119 parse_key_definition(char *str)
120 {
121 char buf[MAX_LINE_LENGTH];
122 char *p;
123 size_t len = strlen(str), i;
124 int j,key;
125 int keys[MAX_COMMAND_KEYS];
126 command_t cmd;
128 /* get the command name */
129 i=0;
130 j=0;
131 memset(buf, 0, MAX_LINE_LENGTH);
132 while (i < len && str[i] != '=' && !g_ascii_isspace(str[i]))
133 buf[j++] = str[i++];
134 if( (cmd=get_key_command_from_name(buf)) == CMD_NONE ) {
135 /* the hotkey configuration contains an unknown
136 command */
137 print_error(_("Unknown command"), buf);
138 return -1;
139 }
141 /* skip whitespace */
142 while (i < len && (str[i] == '=' || g_ascii_isspace(str[i])))
143 i++;
145 /* get the value part */
146 memset(buf, 0, MAX_LINE_LENGTH);
147 g_strlcpy(buf, str+i, MAX_LINE_LENGTH);
148 if (*buf == 0) {
149 /* the hotkey configuration line is incomplete */
150 print_error(_("Incomplete hotkey configuration"), str);
151 return -1;
152 }
154 /* parse key values */
155 i = 0;
156 key = 0;
157 p = buf;
158 memset(keys, 0, sizeof(int)*MAX_COMMAND_KEYS);
159 while (i < MAX_COMMAND_KEYS && *p != 0 &&
160 (key = parse_key_value(p, &p)) >= 0) {
161 keys[i++] = key;
162 while (*p==',' || *p==' ' || *p=='\t')
163 p++;
164 }
166 if (key < 0)
167 return -1;
169 return assign_keys(cmd, keys);
170 }
172 static bool
173 parse_timedisplay_type(const char *str)
174 {
175 if (strcmp(str, "elapsed") == 0)
176 return false;
177 else if (strcmp(str, "remaining") == 0)
178 return true;
179 else {
180 /* translators: ncmpc supports displaying the
181 "elapsed" or "remaining" time of a song being
182 played; in this case, the configuration file
183 contained an invalid setting */
184 print_error(_("Bad time display type"), str);
185 return false;
186 }
187 }
189 #ifdef ENABLE_COLORS
190 static char *
191 separate_value(char *p)
192 {
193 char *value;
195 value = strchr(p, '=');
196 if (value == NULL) {
197 /* an equals sign '=' was expected while parsing a
198 configuration file line */
199 fprintf(stderr, "%s\n", _("Missing '='"));
200 return NULL;
201 }
203 *value++ = 0;
205 g_strchomp(p);
206 return g_strchug(value);
207 }
209 static int
210 parse_color(char *str)
211 {
212 char *value;
214 value = separate_value(str);
215 if (value == NULL)
216 return -1;
218 return colors_assign(str, value);
219 }
221 /**
222 * Returns the first non-whitespace character after the next comma
223 * character, or the end of the string. This is used to parse comma
224 * separated values.
225 */
226 static char *
227 after_comma(char *p)
228 {
229 char *comma = strchr(p, ',');
231 if (comma != NULL) {
232 *comma++ = 0;
233 comma = g_strchug(comma);
234 } else
235 comma = p + strlen(p);
237 g_strchomp(p);
238 return comma;
239 }
241 static int
242 parse_color_definition(char *str)
243 {
244 char buf[MAX_LINE_LENGTH];
245 char *value;
246 short color, rgb[3];
248 value = separate_value(str);
249 if (value == NULL)
250 return -1;
252 /* get the command name */
253 color = colors_str2color(str);
254 if (color < 0) {
255 print_error(_("Bad color name"), buf);
256 return -1;
257 }
259 /* parse r,g,b values */
261 for (unsigned i = 0; i < 3; ++i) {
262 char *next = after_comma(value), *endptr;
263 if (*value == 0) {
264 print_error(_("Incomplete color definition"), str);
265 return -1;
266 }
268 rgb[i] = strtol(value, &endptr, 0);
269 if (endptr == value || *endptr != 0) {
270 print_error(_("Invalid number"), value);
271 return -1;
272 }
274 value = next;
275 }
277 if (*value != 0) {
278 print_error(_("Malformed color definition"), str);
279 return -1;
280 }
282 return colors_define(str, rgb[0], rgb[1], rgb[2]);
283 }
284 #endif
286 static char *
287 get_format(char *str)
288 {
289 gsize len = strlen(str);
291 if (str && str[0]=='\"' && str[len-1] == '\"') {
292 str[len - 1] = '\0';
293 str++;
294 }
296 return g_strdup(str);
297 }
299 static char **
300 check_screen_list(char *value)
301 {
302 char **tmp = g_strsplit_set(value, " \t,", 100);
303 char **screen = NULL;
304 int i = 0, j = 0;
306 while( tmp && tmp[i] ) {
307 char *name = g_ascii_strdown(tmp[i], -1);
308 if (*name != '\0') {
309 if (screen_lookup_name(name) == NULL) {
310 /* an unknown screen name was specified in the
311 configuration file */
312 print_error(_("Unknown screen name"), name);
313 free(name);
314 } else {
315 screen = g_realloc(screen, (j+2)*sizeof(char *));
316 screen[j++] = name;
317 screen[j] = NULL;
318 }
319 }
320 i++;
321 }
322 g_strfreev(tmp);
323 if( screen == NULL )
324 return g_strsplit_set(DEFAULT_SCREEN_LIST, " ", 0);
326 return screen;
327 }
329 static int
330 get_search_mode(char *value)
331 {
332 char * test;
333 int mode;
334 mode= strtol(value, &test, 10);
335 if (*test == '\0')
336 {
337 if (0 <= mode && mode <= 4)
338 return mode;
339 else
340 {
341 print_error(_("Invalid search mode"),value);
342 return 0;
343 }
344 }
345 else
346 {
347 for (int i = 0; value[i] != '\0'; i++)
348 value[i] = tolower(value[i]);
350 // TODO: modify screen_search so that its own list of modes can be used
351 // for comparison instead of specifying them here
352 if (strcmp(value, "title") == 0)
353 return 0;
354 else if (strcmp(value, "artist") == 0)
355 return 1;
356 else if (strcmp(value, "album") == 0)
357 return 2;
358 else if (strcmp(value, "filename") == 0)
359 return 3;
360 else if (strcmp(value, "artist+album") == 0)
361 return 4;
362 else
363 {
364 print_error(_("Unknown search mode"),value);
365 return 0;
366 }
367 }
368 }
370 static bool
371 parse_line(char *line)
372 {
373 size_t len = strlen(line), i = 0, j = 0;
374 char name[MAX_LINE_LENGTH];
375 char value[MAX_LINE_LENGTH];
376 bool match_found;
378 /* get the name part */
379 while (i < len && line[i] != '=' &&
380 !g_ascii_isspace(line[i])) {
381 name[j++] = line[i++];
382 }
384 name[j] = '\0';
386 /* skip '=' and whitespace */
387 while (i < len && (line[i] == '=' || g_ascii_isspace(line[i])))
388 i++;
390 /* get the value part */
391 j = 0;
392 while (i < len)
393 value[j++] = line[i++];
394 value[j] = '\0';
396 match_found = true;
398 /* key definition */
399 if (!strcasecmp(CONF_KEY_DEFINITION, name))
400 parse_key_definition(value);
401 /* enable colors */
402 else if(!strcasecmp(CONF_ENABLE_COLORS, name))
403 #ifdef ENABLE_COLORS
404 options.enable_colors = str2bool(value);
405 #else
406 {}
407 #endif
408 else if (!strcasecmp(CONF_SCROLL_OFFSET, name))
409 options.scroll_offset = atoi(value);
410 /* auto center */
411 else if (!strcasecmp(CONF_AUTO_CENTER, name))
412 options.auto_center = str2bool(value);
413 /* color assignment */
414 else if (!strcasecmp(CONF_COLOR, name))
415 #ifdef ENABLE_COLORS
416 parse_color(value);
417 #else
418 {}
419 #endif
420 /* wide cursor */
421 else if (!strcasecmp(CONF_WIDE_CURSOR, name))
422 options.wide_cursor = str2bool(value);
423 else if (strcasecmp(name, "hardware-cursor") == 0)
424 options.hardware_cursor = str2bool(value);
425 /* welcome screen list */
426 else if (!strcasecmp(CONF_WELCOME_SCREEN_LIST, name))
427 options.welcome_screen_list = str2bool(value);
428 /* visible bitrate */
429 else if (!strcasecmp(CONF_VISIBLE_BITRATE, name))
430 options.visible_bitrate = str2bool(value);
431 /* timer display type */
432 else if (!strcasecmp(CONF_TIMEDISPLAY_TYPE, name))
433 options.display_remaining_time = parse_timedisplay_type(value);
434 /* color definition */
435 else if (!strcasecmp(CONF_COLOR_DEFINITION, name))
436 #ifdef ENABLE_COLORS
437 parse_color_definition(value);
438 #else
439 {}
440 #endif
441 /* list format string */
442 else if (!strcasecmp(CONF_LIST_FORMAT, name)) {
443 g_free(options.list_format);
444 options.list_format = get_format(value);
445 /* status format string */
446 } else if (!strcasecmp(CONF_STATUS_FORMAT, name)) {
447 g_free(options.status_format);
448 options.status_format = get_format(value);
449 /* xterm title format string */
450 } else if (!strcasecmp(CONF_XTERM_TITLE_FORMAT, name)) {
451 g_free(options.xterm_title_format);
452 options.xterm_title_format = get_format(value);
453 } else if (!strcasecmp(CONF_LIST_WRAP, name))
454 options.list_wrap = str2bool(value);
455 else if (!strcasecmp(CONF_FIND_WRAP, name))
456 options.find_wrap = str2bool(value);
457 else if (!strcasecmp(CONF_FIND_SHOW_LAST,name))
458 options.find_show_last_pattern = str2bool(value);
459 else if (!strcasecmp(CONF_AUDIBLE_BELL, name))
460 options.audible_bell = str2bool(value);
461 else if (!strcasecmp(CONF_VISIBLE_BELL, name))
462 options.visible_bell = str2bool(value);
463 else if (!strcasecmp(CONF_BELL_ON_WRAP, name))
464 options.bell_on_wrap = str2bool(value);
465 else if (!strcasecmp(CONF_STATUS_MESSAGE_TIME, name))
466 options.status_message_time = atoi(value);
467 else if (!strcasecmp(CONF_XTERM_TITLE, name))
468 options.enable_xterm_title = str2bool(value);
469 else if (!strcasecmp(CONF_ENABLE_MOUSE, name))
470 #ifdef HAVE_GETMOUSE
471 options.enable_mouse = str2bool(value);
472 #else
473 {}
474 #endif
475 else if (!strcasecmp(CONF_CROSSFADE_TIME, name))
476 options.crossfade_time = atoi(value);
477 else if (!strcasecmp(CONF_SEARCH_MODE, name))
478 options.search_mode = get_search_mode(value);
479 else if (!strcasecmp(CONF_HIDE_CURSOR, name))
480 options.hide_cursor = atoi(value);
481 else if (!strcasecmp(CONF_SEEK_TIME, name))
482 options.seek_time = atoi(value);
483 else if (!strcasecmp(CONF_SCREEN_LIST, name)) {
484 g_strfreev(options.screen_list);
485 options.screen_list = check_screen_list(value);
486 } else if (!strcasecmp(CONF_SHOW_SPLASH, name)) {
487 /* the splash screen was removed */
488 } else if (!strcasecmp(CONF_HOST, name))
489 options.host = get_format(value);
490 else if (!strcasecmp(CONF_PORT, name))
491 options.port = atoi(get_format(value));
492 else if (!strcasecmp(CONF_PASSWORD, name))
493 options.password = get_format(value);
494 else if (!strcasecmp(CONF_LYRICS_TIMEOUT, name))
495 #ifdef ENABLE_LYRICS_SCREEN
496 options.lyrics_timeout = atoi(get_format(value));
497 #else
498 {}
499 #endif
500 else if (!strcasecmp(CONF_SCROLL, name))
501 options.scroll = str2bool(value);
502 else if (!strcasecmp(CONF_SCROLL_SEP, name)) {
503 g_free(options.scroll_sep);
504 options.scroll_sep = get_format(value);
505 } else if (!strcasecmp(CONF_DISPLAY_TIME, name))
506 #ifdef NCMPC_MINI
507 {}
508 #else
509 options.display_time = str2bool(value);
510 #endif
511 else if (!strcasecmp(CONF_JUMP_PREFIX_ONLY, name))
512 #ifdef NCMPC_MINI
513 {}
514 #else
515 options.jump_prefix_only = str2bool(value);
516 #endif
517 else if (!strcasecmp(CONF_LYRICS_AUTOSAVE, name))
518 #ifdef ENABLE_LYRICS_SCREEN
519 options.lyrics_autosave = str2bool(value);
520 #else
521 {}
522 #endif
523 else
524 match_found = false;
526 if (!match_found)
527 print_error(_("Unknown configuration parameter"),
528 name);
530 return match_found;
531 }
533 static int
534 read_rc_file(char *filename)
535 {
536 FILE *file;
537 char line[MAX_LINE_LENGTH];
539 if (filename == NULL)
540 return -1;
542 file = fopen(filename, "r");
543 if (file == NULL) {
544 perror(filename);
545 return -1;
546 }
548 while (fgets(line, sizeof(line), file) != NULL) {
549 char *p = g_strchug(line);
551 if (*p != 0 && *p != COMMENT_TOKEN)
552 parse_line(g_strchomp(p));
553 }
555 fclose(file);
556 return 0;
557 }
559 int
560 check_user_conf_dir(void)
561 {
562 int retval;
563 char *directory = g_build_filename(g_get_home_dir(), "." PACKAGE, NULL);
565 if (g_file_test(directory, G_FILE_TEST_IS_DIR)) {
566 g_free(directory);
567 return 0;
568 }
570 retval = mkdir(directory, 0755);
571 g_free(directory);
572 return retval;
573 }
575 char *
576 get_user_key_binding_filename(void)
577 {
578 return g_build_filename(g_get_home_dir(), "." PACKAGE, "keys", NULL);
579 }
581 int
582 read_configuration(void)
583 {
584 char *filename = NULL;
586 /* check for command line configuration file */
587 if (options.config_file)
588 filename = g_strdup(options.config_file);
590 /* check for user configuration ~/.ncmpc/config */
591 if (filename == NULL) {
592 filename = g_build_filename(g_get_home_dir(),
593 "." PACKAGE, "config", NULL);
594 if (!g_file_test(filename, G_FILE_TEST_IS_REGULAR)) {
595 g_free(filename);
596 filename = NULL;
597 }
598 }
600 /* check for global configuration SYSCONFDIR/ncmpc/config */
601 if (filename == NULL) {
602 filename = g_build_filename(SYSCONFDIR, PACKAGE, "config", NULL);
603 if (!g_file_test(filename, G_FILE_TEST_IS_REGULAR)) {
604 g_free(filename);
605 filename = NULL;
606 }
607 }
609 /* load configuration */
610 if (filename) {
611 read_rc_file(filename);
612 g_free(filename);
613 filename = NULL;
614 }
616 /* check for command line key binding file */
617 if (options.key_file)
618 filename = g_strdup(options.key_file);
620 /* check for user key bindings ~/.ncmpc/keys */
621 if (filename == NULL) {
622 filename = get_user_key_binding_filename();
623 if (!g_file_test(filename, G_FILE_TEST_IS_REGULAR)) {
624 g_free(filename);
625 filename = NULL;
626 }
627 }
629 /* check for global key bindings SYSCONFDIR/ncmpc/keys */
630 if (filename == NULL) {
631 filename = g_build_filename(SYSCONFDIR, PACKAGE, "keys", NULL);
632 if (!g_file_test(filename, G_FILE_TEST_IS_REGULAR)) {
633 g_free(filename);
634 filename = NULL;
635 }
636 }
638 /* load key bindings */
639 if (filename) {
640 read_rc_file(filename);
641 g_free(filename);
642 filename = NULL;
643 }
645 return 0;
646 }