1 /***************************************************************************
2 * Copyright (C) 2007,2008,2009 Øyvind Harboe *
3 * oyvind.harboe@zylin.com *
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 *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
21 /* some bits were copied from ahttpd which is under eCos license and
28 #include "telnet_server.h"
29 #include <target/target.h>
31 #include <microhttpd.h>
35 #define PAGE_NOT_FOUND "<html><head><title > File not found</title></head><body > File not found</body></html>"
37 static pthread_mutex_t mutex;
39 void openocd_sleep_prelude(void)
41 pthread_mutex_unlock(&mutex);
44 void openocd_sleep_postlude(void)
46 pthread_mutex_lock(&mutex);
51 int loadFile(const char *name, void **data, size_t *len);
53 static const char *appendf(const char *prev, const char *format, ...)
57 char *string = alloc_vprintf(format, ap);
63 string2 = alloc_printf("%s%s", (prev == NULL) ? "" : prev, string);
77 static const char *httpd_exec_cgi_tcl_error(Jim_Interp *interp)
82 t = appendf(t, "<html><body>\n");
84 t = appendf(t, "Runtime error, file \"%s\", line %d:<br>",
85 interp->errorFileName, interp->errorLine);
86 t = appendf(t, " %s < br>", Jim_GetString(interp->result, NULL));
87 Jim_ListLength(interp, interp->stackTrace, &len);
88 for (i = 0; i < len; i += 3)
91 const char *proc, *file, *line;
93 Jim_ListIndex(interp, interp->stackTrace, i, &objPtr, JIM_NONE);
94 proc = Jim_GetString(objPtr, NULL);
95 Jim_ListIndex(interp, interp->stackTrace, i + 1, &objPtr, JIM_NONE);
96 file = Jim_GetString(objPtr, NULL);
97 Jim_ListIndex(interp, interp->stackTrace, i + 2, &objPtr, JIM_NONE);
98 line = Jim_GetString(objPtr, NULL);
99 t = appendf(t, "In procedure '%s' called at file \"%s\", line %s < br>",
102 t = appendf(t, "</html></body>\n");
107 static int httpd_Jim_Command_writeform(Jim_Interp *interp, int argc,
108 Jim_Obj * const *argv)
112 Jim_WrongNumArgs(interp, 1, argv, "method ?CMD_ARGV ...?");
115 char *name = (char*) Jim_GetString(argv[1], NULL);
116 char *file = (char*) Jim_GetString(argv[2], NULL);
124 const char *script = alloc_printf("set dummy_val $httppostdata(%s); set dummy_val",
126 retcode = Jim_Eval_Named(interp, script, __FILE__, __LINE__);
127 free((void *) script);
128 if (retcode != JIM_OK)
131 data = Jim_GetString(Jim_GetResult(interp), &actual);
133 FILE *f = fopen(file, "wb");
136 Jim_SetResultString(interp, "Could not create file", -1);
140 int result = fwrite(data, 1, actual, f);
143 if (result != actual)
145 Jim_SetResultString(interp, "Could not write to file", -1);
153 httpd_Jim_Command_formfetch(Jim_Interp *interp,
155 Jim_Obj *const *argv)
159 Jim_WrongNumArgs(interp, 1, argv, "method ?CMD_ARGV ...?");
162 char *name = (char*)Jim_GetString(argv[1], NULL);
165 const char *script = alloc_printf("set dummy_val $httppostdata(%s); set dummy_val",
167 int retcode = Jim_Eval_Named(interp, script, __FILE__, __LINE__);
168 free((void *) script);
169 if (retcode != JIM_OK)
171 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
174 Jim_SetResult(interp, Jim_GetResult(interp));
184 struct MHD_PostProcessor *postprocessor;
188 int complete; /* did we receive the entire post ? */
192 static void request_completed(void *cls, struct MHD_Connection *connection,
193 void **con_cls, enum MHD_RequestTerminationCode toe)
195 struct httpd_request *r = (struct httpd_request*) *con_cls;
200 if (r->postprocessor)
202 openocd_sleep_postlude();
203 MHD_destroy_post_processor(r->postprocessor);
204 openocd_sleep_prelude();
211 /* append to said key in dictionary */
212 static void append_key(Jim_Interp *interp,
213 struct httpd_request *r, const char *key,
214 const char *data, size_t off, size_t size)
216 Jim_Obj *keyObj = Jim_NewStringObj(interp, key, -1);
217 Jim_IncrRefCount(keyObj);
218 Jim_Obj *value = NULL;
220 Jim_Obj *dict = Jim_GetVariableStr(interp, "httppostdata", 0);
224 if (Jim_DictKey(interp, dict, keyObj, &value, 0) != JIM_OK)
230 Jim_IncrRefCount(value);
236 value = Jim_NewStringObj(interp, "", -1);
237 Jim_IncrRefCount(value);
241 /* create a new object we append to and insert into this location */
242 Jim_Obj *newObj = Jim_NewStringObj(interp, "", -1);
243 Jim_IncrRefCount(newObj);
244 Jim_AppendObj(interp, newObj, value);
245 Jim_AppendString(interp, newObj, data, size);
246 /* uhh... use name here of dictionary */
247 dict = Jim_NewStringObj(interp, "httppostdata", -1);
248 Jim_IncrRefCount(dict);
249 Jim_SetDictKeysVector(interp, dict, &keyObj, 1, newObj);
250 Jim_DecrRefCount(interp, dict);
251 Jim_DecrRefCount(interp, value);
252 Jim_DecrRefCount(interp, newObj);
253 Jim_DecrRefCount(interp, keyObj);
256 /* append data to each key */
257 static int iterate_post(void *con_cls, enum MHD_ValueKind kind,
258 const char *key, const char *filename, const char *content_type,
259 const char *transfer_encoding, const char *data, uint64_t off,
262 struct httpd_request *r = (struct httpd_request*) con_cls;
264 append_key(r->interp, r, key, data, off, size);
269 static int record_arg(void *cls, enum MHD_ValueKind kind, const char *key,
272 struct httpd_request *r = (struct httpd_request*) cls;
273 append_key(r->interp, r, key, value, 0, strlen(value));
278 static int handle_request(Jim_Interp *interp,
279 struct MHD_Connection * connection, const char * url)
281 struct MHD_Response * response;
285 suffix = strrchr(url, '.');
286 if ((suffix != NULL) && (strcmp(suffix, ".tcl") == 0))
288 printf("Run tcl %s\n", url);
292 const char *script = alloc_printf(
293 "global httpdata; source {%s}; set httpdata", url);
294 retcode = Jim_Eval_Named(interp, script, __FILE__, __LINE__);
295 free((void *) script);
297 if (retcode != JIM_OK)
299 printf("Tcl failed\n");
300 const char *t = httpd_exec_cgi_tcl_error(interp);
304 response = MHD_create_response_from_data(strlen(t), (void *) t,
306 ret = MHD_queue_response(connection,
307 MHD_HTTP_INTERNAL_SERVER_ERROR, response);
308 MHD_destroy_response(response);
314 /* FIX!!! how to handle mime types??? */
317 result = Jim_GetString(Jim_GetResult(interp), &reslen);
319 response = MHD_create_response_from_data(reslen, (void *) result,
321 ret = MHD_queue_response(connection,
322 MHD_HTTP_INTERNAL_SERVER_ERROR, response);
323 MHD_destroy_response(response);
332 int retval = loadFile(url, &data, &len);
333 if (retval != ERROR_OK)
335 printf("Did not find %s\n", url);
337 response = MHD_create_response_from_data(strlen(PAGE_NOT_FOUND),
338 (void *) PAGE_NOT_FOUND, MHD_NO, MHD_NO);
339 ret = MHD_queue_response(connection, MHD_HTTP_NOT_FOUND, response);
340 MHD_destroy_response(response);
344 LOG_DEBUG("Serving %s length=%zu", url, len);
345 /* serve file directly */
346 response = MHD_create_response_from_data(len, data, MHD_YES, MHD_NO);
347 /* Should we expose mimetype via tcl here or just let the browser
349 MHD_add_response_header(response, "Content-Type", "image/png");
352 ret = MHD_queue_response(connection, MHD_HTTP_OK, response);
353 MHD_destroy_response(response);
360 static int ahc_echo_inner(void * cls, struct MHD_Connection * connection,
361 const char * url, const char * method, const char * version,
362 const char * upload_data, size_t * upload_data_size, void ** ptr)
364 Jim_Interp *interp = (Jim_Interp *)cls;
367 if (0 == strcmp(method, "POST"))
371 else if (0 == strcmp(method, "GET"))
376 return MHD_NO; /* unexpected method */
379 struct httpd_request *r;
382 /* The first time only the headers are valid,
383 do not respond in the first round... */
385 *ptr = malloc(sizeof(struct httpd_request));
388 memset(*ptr, 0, sizeof(struct httpd_request));
390 r = (struct httpd_request *) *ptr;
393 Jim_SetVariableStr(interp, "httppostdata", Jim_NewDictObj(interp, NULL, 0));
395 /* fill in url query strings in dictionary */
396 MHD_get_connection_values(connection, MHD_GET_ARGUMENT_KIND,
401 r->postprocessor = MHD_create_post_processor(connection, 2048
402 * 1024, &iterate_post, r);
408 r = (struct httpd_request *) *ptr;
412 /* consume post data */
413 if (*upload_data_size)
415 MHD_post_process(r->postprocessor, upload_data, *upload_data_size);
416 *upload_data_size = 0;
426 /* hand over to request who will be using it. */
430 /* FIX!!!! we need more advanced handling of url's to avoid them
431 * being subverted to evil purposes
434 const char *httpd_dir = PKGDATADIR "/httpd";
438 url++; /* skip '/' */
443 const char *file_name = alloc_printf("%s/%s", httpd_dir, url);
444 int result = handle_request(interp, connection, file_name);
445 free((void *)file_name);
450 static int ahc_echo(void * cls, struct MHD_Connection * connection,
451 const char * url, const char * method, const char * version,
452 const char * upload_data, size_t * upload_data_size, void ** ptr)
456 openocd_sleep_postlude();
458 result = ahc_echo_inner(cls, connection, url, method, version, upload_data, upload_data_size, ptr);
460 openocd_sleep_prelude();
465 static struct MHD_Daemon * d;
467 static const struct command_registration httpd_command_handlers[] = {
470 .jim_handler = &httpd_Jim_Command_formfetch,
471 .mode = COMMAND_EXEC,
472 .usage = "<parameter_name>",
473 .help = "Reads a posted form value.",
477 .jim_handler = &httpd_Jim_Command_writeform,
478 .mode = COMMAND_EXEC,
479 .usage = "<parameter_name> <file>",
480 .help = "Writes a form value to a file.",
482 COMMAND_REGISTRATION_DONE
485 int httpd_start(struct command_context *cmd_ctx)
487 pthread_mutexattr_t attr;
488 pthread_mutexattr_init(&attr);
489 pthread_mutex_init(&mutex, &attr);
492 LOG_USER("Launching httpd server on port %d", port);
493 d = MHD_start_daemon(MHD_USE_SELECT_INTERNALLY, port, NULL, NULL,
494 &ahc_echo, cmd_ctx->interp,
495 MHD_OPTION_NOTIFY_COMPLETED, request_completed, NULL, /* Closure... what's that??? */
500 return register_commands(cmd_ctx, NULL, httpd_command_handlers);
503 void httpd_stop(void)
506 pthread_mutex_destroy(&mutex);