2 * This file is part of DisOrder.
3 * Copyright (C) 2004-2008, 2011 Richard Kettlewell
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 3 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
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 /** @file cgi/options.c
21 * Options represent an additional configuration system private to the
25 #include "disorder-cgi.h"
27 /** @brief State for parsing an options file */
28 struct read_options_state
{
29 /** @brief Filename */
32 /** @brief Line number */
38 static void option__readfile(const char *name
);
40 static void option__label(int attribute((unused
)) nvec
,
42 option_set(vec
[0], vec
[1]);
45 static void option__include(int attribute((unused
)) nvec
,
47 option__readfile(vec
[0]);
50 /** @brief Definition of an option command */
51 static struct option
{
52 /** @brief Command name */
54 /** @brief Minimum number of arguments */
56 /** @brief Maximum number of arguments */
58 /** @brief Command handler */
59 void (*handler
)(int nvec
, char **vec
);
61 { "include", 1, 1, option__include
},
62 { "label", 2, 2, option__label
},
65 static void option__split_error(const char *msg
,
67 struct read_options_state
*cs
= u
;
69 disorder_error(0, "%s:%d: %s", cs
->name
, cs
->line
, msg
);
72 static void option__readfile(const char *name
) {
76 struct read_options_state cs
;
78 if(!(cs
.name
= mx_find(name
, 1/*report*/)))
80 if(!(fp
= fopen(cs
.name
, "r")))
81 disorder_fatal(errno
, "error opening %s", cs
.name
);
83 while(!inputline(cs
.name
, fp
, &buffer
, '\n')) {
85 if(!(vec
= split(buffer
, &n
, SPLIT_COMMENTS
|SPLIT_QUOTES
,
86 option__split_error
, &cs
)))
90 if((i
= TABLE_FIND(options
, name
, vec
[0])) == -1) {
91 disorder_error(0, "%s:%d: unknown option '%s'", cs
.name
, cs
.line
, vec
[0]);
96 if(n
< options
[i
].minargs
) {
97 disorder_error(0, "%s:%d: too few arguments to '%s'", cs
.name
, cs
.line
, vec
[-1]);
100 if(n
> options
[i
].maxargs
) {
101 disorder_error(0, "%s:%d: too many arguments to '%s'", cs
.name
, cs
.line
, vec
[-1]);
104 options
[i
].handler(n
, vec
);
109 static void option__init(void) {
110 static int have_read_options
;
112 if(!have_read_options
) {
113 have_read_options
= 1;
114 labels
= hash_new(sizeof (char *));
115 option__readfile("options");
119 /** @brief Set an option
120 * @param name Option name
121 * @param value Option value
123 * If the option was already set its value is replaced.
125 * @p name and @p value are copied.
127 void option_set(const char *name
, const char *value
) {
128 char *v
= xstrdup(value
);
131 hash_add(labels
, name
, &v
, HASH_INSERT_OR_REPLACE
);
134 /** @brief Get a label
135 * @param key Name of label
136 * @return Value of label (never NULL)
138 * If label images.X isn't found then the return value is
139 * <url.static>X.png, allowing url.static to be used to provide a base
140 * for all images with per-image overrides.
142 * Otherwise undefined labels expand to their last (dot-separated)
145 const char *option_label(const char *key
) {
150 lptr
= hash_find(labels
, key
);
154 if(!strncmp(key
, "images.", 7)) {
155 static const char *url_static
;
156 /* images.X defaults to <url.static>X.png */
159 url_static
= option_label("url.static");
160 byte_xasprintf((char **)&label
, "%s%s.png", url_static
, key
+ 7);
161 } else if((label
= strrchr(key
, '.')))
162 /* X.Y defaults to Y */
165 /* otherwise default to label name */
170 /** @brief Test whether a label exists
171 * @param key Name of label
172 * @return 1 if label exists, otherwise 0
174 * Labels that don't exist still have an expansion (per option_label()
175 * documentation), and possibly not even a placeholder one.
177 int option_label_exists(const char *key
) {
179 return !!hash_find(labels
, key
);