2 * collection4 - utils_cgi.c
3 * Copyright (C) 2010 Florian octo Forster
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (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 GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 * Boston, MA 02110-1301 USA
21 * Florian octo Forster <ff at octo.it>
34 #include "utils_cgi.h"
38 #include <fcgi_stdio.h>
45 typedef struct parameter_s parameter_t;
49 parameter_t *parameters;
50 size_t parameters_num;
53 static param_list_t *pl_global = NULL;
55 static char *uri_unescape_copy (char *dest, const char *src, size_t n) /* {{{ */
60 if ((dest == NULL) || (src == NULL) || (n < 1))
77 else if ((src_ptr[0] == '%')
78 && isxdigit ((int) src_ptr[1]) && isxdigit ((int) src_ptr[2]))
84 tmpstr[0] = src_ptr[1];
85 tmpstr[1] = src_ptr[2];
90 value = strtol (tmpstr, &endptr, /* base = */ 16);
91 if ((endptr == tmpstr) || (errno != 0))
97 *dest_ptr = (char) value;
104 *dest_ptr = *src_ptr;
111 } /* while (*src_ptr != 0) */
113 assert (*dest_ptr == 0);
115 } /* }}} char *uri_unescape_copy */
117 static char *uri_unescape (const char *string) /* {{{ */
124 uri_unescape_copy (buffer, string, sizeof (buffer));
126 return (strdup (buffer));
127 } /* }}} char *uri_unescape */
129 static int param_parse_keyval (param_list_t *pl, char *keyval) /* {{{ */
137 value_raw = strchr (key_raw, '=');
138 if (value_raw == NULL)
143 key = uri_unescape (key_raw);
147 value = uri_unescape (value_raw);
154 param_set (pl, key, value);
160 } /* }}} int param_parse_keyval */
162 static int parse_query_string (param_list_t *pl, /* {{{ */
168 if ((pl == NULL) || (query_string == NULL))
171 dummy = query_string;
172 while ((keyval = strtok (dummy, ";&")) != NULL)
175 param_parse_keyval (pl, keyval);
179 } /* }}} int parse_query_string */
181 int param_init (void) /* {{{ */
183 if (pl_global != NULL)
186 pl_global = param_create (/* query string = */ NULL);
187 if (pl_global == NULL)
191 } /* }}} int param_init */
193 void param_finish (void) /* {{{ */
195 param_destroy (pl_global);
197 } /* }}} void param_finish */
199 const char *param (const char *key) /* {{{ */
203 return (param_get (pl_global, key));
204 } /* }}} const char *param */
206 param_list_t *param_create (const char *query_string) /* {{{ */
211 if (query_string == NULL)
212 query_string = getenv ("QUERY_STRING");
214 if (query_string == NULL)
217 tmp = strdup (query_string);
221 pl = malloc (sizeof (*pl));
227 memset (pl, 0, sizeof (*pl));
229 parse_query_string (pl, tmp);
233 } /* }}} param_list_t *param_create */
235 param_list_t *param_clone (__attribute__((unused)) param_list_t *pl) /* {{{ */
237 /* FIXME: To be implemented. */
240 } /* }}} param_list_t *param_clone */
242 void param_destroy (param_list_t *pl) /* {{{ */
249 for (i = 0; i < pl->parameters_num; i++)
251 free (pl->parameters[i].key);
252 free (pl->parameters[i].value);
254 free (pl->parameters);
256 } /* }}} void param_destroy */
258 const char *param_get (param_list_t *pl, const char *name) /* {{{ */
262 if ((pl == NULL) || (name == NULL))
265 for (i = 0; i < pl->parameters_num; i++)
267 if ((name == NULL) && (pl->parameters[i].key == NULL))
268 return (pl->parameters[i].value);
269 else if ((name != NULL) && (pl->parameters[i].key != NULL)
270 && (strcmp (name, pl->parameters[i].key) == 0))
271 return (pl->parameters[i].value);
275 } /* }}} char *param_get */
277 static int param_add (param_list_t *pl, /* {{{ */
278 const char *key, const char *value)
282 tmp = realloc (pl->parameters,
283 sizeof (*pl->parameters) * (pl->parameters_num + 1));
286 pl->parameters = tmp;
287 tmp = pl->parameters + pl->parameters_num;
289 memset (tmp, 0, sizeof (*tmp));
290 tmp->key = strdup (key);
291 if (tmp->key == NULL)
294 tmp->value = strdup (value);
295 if (tmp->value == NULL)
301 pl->parameters_num++;
304 } /* }}} int param_add */
306 static int param_delete (param_list_t *pl, /* {{{ */
311 if ((pl == NULL) || (name == NULL))
314 for (i = 0; i < pl->parameters_num; i++)
315 if (strcasecmp (pl->parameters[i].key, name) == 0)
318 if (i >= pl->parameters_num)
321 if (i < (pl->parameters_num - 1))
325 p = pl->parameters[i];
326 pl->parameters[i] = pl->parameters[pl->parameters_num - 1];
327 pl->parameters[pl->parameters_num - 1] = p;
330 pl->parameters_num--;
331 free (pl->parameters[pl->parameters_num].key);
332 free (pl->parameters[pl->parameters_num].value);
335 } /* }}} int param_delete */
337 int param_set (param_list_t *pl, const char *name, /* {{{ */
344 if ((pl == NULL) || (name == NULL))
348 return (param_delete (pl, name));
351 for (i = 0; i < pl->parameters_num; i++)
353 if (strcasecmp (pl->parameters[i].key, name) == 0)
355 p = pl->parameters + i;
361 return (param_add (pl, name, value));
363 value_copy = strdup (value);
364 if (value_copy == NULL)
368 p->value = value_copy;
371 } /* }}} int param_set */
373 char *param_as_string (param_list_t *pl) /* {{{ */
384 for (i = 0; i < pl->parameters_num; i++)
386 uri_escape_copy (key, pl->parameters[i].key, sizeof (key));
387 uri_escape_copy (value, pl->parameters[i].value, sizeof (value));
390 strlcat (buffer, ";", sizeof (buffer));
391 strlcat (buffer, key, sizeof (buffer));
392 strlcat (buffer, "=", sizeof (buffer));
393 strlcat (buffer, value, sizeof (buffer));
396 return (strdup (buffer));
397 } /* }}} char *param_as_string */
399 int param_print_hidden (param_list_t *pl) /* {{{ */
408 for (i = 0; i < pl->parameters_num; i++)
410 html_escape_copy (key, pl->parameters[i].key, sizeof (key));
411 html_escape_copy (value, pl->parameters[i].value, sizeof (value));
413 printf (" <input type=\"hidden\" name=\"%s\" value=\"%s\" />\n",
418 } /* }}} int param_print_hidden */
420 char *uri_escape_copy (char *dest, const char *src, size_t n) /* {{{ */
434 else if ((((unsigned char) src[in]) < 32)
436 /* RFC 3986, gen-delims */
437 || (src[in] == ':') || (src[in] == '/') || (src[in] == '?')
438 || (src[in] == '#') || (src[in] == '[') || (src[in] == ']')
440 /* RFC 3986, sub-delims */
441 || (src[in] == '!') || (src[in] == '$') || (src[in] == '&')
442 || (src[in] == '(') || (src[in] == ')') || (src[in] == '*')
443 || (src[in] == '+') || (src[in] == ',') || (src[in] == ';')
444 || (src[in] == '=') || (src[in] == '\'')
446 || (((unsigned char) src[in]) >= 128))
453 snprintf (esc, sizeof (esc), "%%%02x", (unsigned int) src[in]);
455 dest[out+1] = esc[1];
456 dest[out+2] = esc[2];
470 } /* }}} char *uri_escape_copy */
472 char *uri_escape_buffer (char *buffer, size_t buffer_size) /* {{{ */
474 char temp[buffer_size];
476 uri_escape_copy (temp, buffer, buffer_size);
477 memcpy (buffer, temp, buffer_size);
480 } /* }}} char *uri_escape_buffer */
482 char *uri_escape (const char *string) /* {{{ */
489 uri_escape_copy (buffer, string, sizeof (buffer));
491 return (strdup (buffer));
492 } /* }}} char *uri_escape */
494 #define COPY_ENTITY(e) do { \
495 size_t len = strlen (e); \
496 if (dest_size < (len + 1)) \
498 strcpy (dest_ptr, (e)); \
503 char *json_escape_copy (char *dest, const char *src, size_t n) /* {{{ */
512 for (pos = 0; src[pos] != 0; pos++)
515 COPY_ENTITY ("\\\"");
516 else if (src[pos] == '\\')
517 COPY_ENTITY ("\\\\");
518 else if (((uint8_t) src[pos]) < 32)
520 if (src[pos] == '\n')
522 else if (src[pos] == '\r')
524 else if (src[pos] == '\t')
526 else if (src[pos] == '\b')
528 else if (src[pos] == '\f')
533 sprintf (buffer, "\\u%04"PRIx8, (uint8_t) src[pos]);
534 buffer[sizeof (buffer) - 1] = 0;
535 COPY_ENTITY (buffer);
540 *dest_ptr = src[pos];
551 } /* }}} char *json_escape_copy */
555 char *json_escape_buffer (char *buffer, size_t buffer_size)
557 char temp[buffer_size];
559 json_escape_copy (temp, buffer, buffer_size);
560 memcpy (buffer, temp, buffer_size);
563 } /* }}} char *json_escape_buffer */
565 char *json_escape (const char *string) /* {{{ */
572 json_escape_copy (buffer, string, sizeof (buffer));
574 return (strdup (buffer));
575 } /* }}} char *json_escape */
577 const char *script_name (void) /* {{{ */
581 ret = getenv ("SCRIPT_NAME");
583 ret = "collection4.fcgi";
586 } /* }}} char *script_name */
588 int time_to_rfc1123 (time_t t, char *buffer, size_t buffer_size) /* {{{ */
593 /* RFC 1123 *requires* the time to be GMT and the "GMT" timezone string.
594 * Apache will ignore the timezone if "localtime_r" and "%z" is used,
595 * resulting in weird behavior. */
596 if (gmtime_r (&t, &tm_tmp) == NULL)
599 status = strftime (buffer, buffer_size, "%a, %d %b %Y %T GMT", &tm_tmp);
604 } /* }}} int time_to_rfc1123 */
606 #define COPY_ENTITY(e) do { \
607 size_t len = strlen (e); \
608 if (dest_size < (len + 1)) \
610 strcpy (dest_ptr, (e)); \
615 char *html_escape_copy (char *dest, const char *src, size_t n) /* {{{ */
624 for (pos = 0; src[pos] != 0; pos++)
627 COPY_ENTITY (""");
628 else if (src[pos] == '<')
629 COPY_ENTITY ("<");
630 else if (src[pos] == '>')
631 COPY_ENTITY (">");
632 else if (src[pos] == '&')
633 COPY_ENTITY ("&");
636 *dest_ptr = src[pos];
647 } /* }}} char *html_escape_copy */
651 char *html_escape_buffer (char *buffer, size_t buffer_size) /* {{{ */
653 char tmp[buffer_size];
655 html_escape_copy (tmp, buffer, sizeof (tmp));
656 memcpy (buffer, tmp, buffer_size);
659 } /* }}} char *html_escape_buffer */
661 char *html_escape (const char *string) /* {{{ */
668 html_escape_copy (buffer, string, sizeof (buffer));
670 return (strdup (buffer));
671 } /* }}} char *html_escape */
673 int html_print_page (const char *title, /* {{{ */
674 const page_callbacks_t *cb, void *user_data)
678 printf ("Content-Type: text/html\n"
679 "X-Generator: "PACKAGE_STRING"\n"
683 title = "C₄: collection4 graph interface";
685 title_html = html_escape (title);
689 " <title>%s</title>\n"
690 " <link rel=\"stylesheet\" type=\"text/css\" href=\"../../share/"PACKAGE"/style.css\" />\n"
691 " <link rel=\"stylesheet\" type=\"text/css\" href=\"../../share/"PACKAGE"/rickshaw.min.css\" />\n"
692 " <script type=\"text/javascript\" src=\"../../share/"PACKAGE"/jquery-1.4.4.min.js\">\n"
694 " <script type=\"text/javascript\" src=\"../../share/"PACKAGE"/d3.min.js\">\n"
696 " <script type=\"text/javascript\" src=\"../../share/"PACKAGE"/rickshaw.min.js\">\n"
698 " <script type=\"text/javascript\" src=\"../../share/"PACKAGE"/collection.js\">\n"
704 " <table id=\"layout-table\">\n"
705 " <tr id=\"layout-top\">\n"
706 " <td id=\"layout-top-left\">");
707 if (cb->top_left != NULL)
708 (*cb->top_left) (user_data);
710 html_print_logo (NULL);
712 " <td id=\"layout-top-center\">");
713 if (cb->top_center != NULL)
714 (*cb->top_center) (user_data);
716 printf ("<h1>%s</h1>", title_html);
718 " <td id=\"layout-top-right\">");
719 if (cb->top_right != NULL)
720 (*cb->top_right) (user_data);
723 " <tr id=\"layout-middle\">\n"
724 " <td id=\"layout-middle-left\">");
725 if (cb->middle_left != NULL)
726 (*cb->middle_left) (user_data);
728 " <td id=\"layout-middle-center\">");
729 if (cb->middle_center != NULL)
730 (*cb->middle_center) (user_data);
732 " <td id=\"layout-middle-right\">");
733 if (cb->middle_right != NULL)
734 (*cb->middle_right) (user_data);
737 " <tr id=\"layout-bottom\">\n"
738 " <td id=\"layout-bottom-left\">");
739 if (cb->bottom_left != NULL)
740 (*cb->bottom_left) (user_data);
742 " <td id=\"layout-bottom-center\">");
743 if (cb->bottom_center != NULL)
744 (*cb->bottom_center) (user_data);
746 " <td id=\"layout-bottom-right\">");
747 if (cb->bottom_right != NULL)
748 (*cb->bottom_right) (user_data);
752 " <div class=\"footer\"><a href=\"http://octo.it/c4/\">"PACKAGE_STRING"</a></div>\n"
758 } /* }}} int html_print_page */
760 int html_print_logo (__attribute__((unused)) void *user_data) /* {{{ */
762 printf ("<a href=\"%s?action=list_graphs\" id=\"logo-canvas\">\n"
763 " <h1>C<sub>4</sub></h1>\n"
764 " <div id=\"logo-subscript\">collection 4</div>\n"
765 "</a>\n", script_name ());
768 } /* }}} int html_print_search_box */
770 int html_print_search_box (__attribute__((unused)) void *user_data) /* {{{ */
774 term_html = html_escape (param ("q"));
776 printf ("<form action=\"%s\" method=\"get\" id=\"search-form\">\n"
777 " <input type=\"hidden\" name=\"action\" value=\"search\" />\n"
778 " <input type=\"text\" name=\"q\" value=\"%s\" id=\"search-input\" />\n"
779 " <input type=\"submit\" name=\"button\" value=\"Search\" />\n"
782 (term_html != NULL) ? term_html : "");
787 } /* }}} int html_print_search_box */
789 /* vim: set sw=2 sts=2 et fdm=marker : */