do not extern 'interp' from command.c
[openocd.git] / src / server / httpd.c
index 103c92f03d1ce118af6a54a7430cbc13d65d12a5..b346ca2ee68663eb6fc0a5310fcbce3517d31125 100644 (file)
@@ -1,9 +1,7 @@
 /***************************************************************************
- *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
+ *   Copyright (C) 2007,2008,2009 Øyvind Harboe                            *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
- *   Copyright (C) 2008 Free Software Foundation
- *                                                                         *
  *   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     *
 #include "config.h"
 #endif
 
-#include "replacements.h"
-
-#include "server.h"
-
-#include "log.h"
 #include "telnet_server.h"
 #include "target.h"
 
-#include <command.h>
-#include <string.h>
-#include <stdlib.h>
-#include <errno.h>
-#include <unistd.h>
-#include <sys/types.h>
-#include <fcntl.h>
+#include <microhttpd.h>
+#include <pthread.h>
 #include <signal.h>
 
-#include <sys/types.h>
-#include <sys/select.h>
-#include <sys/socket.h>
-#include <microhttpd.h>
-#include <stdlib.h>
-#include <string.h>
-#include <stdio.h>
+#define PAGE_NOT_FOUND "<html><head><title > File not found</title></head><body > File not found</body></html>"
+
+static pthread_mutex_t mutex;
+
+void openocd_sleep_prelude(void)
+{
+       pthread_mutex_unlock(&mutex);
+}
+
+void openocd_sleep_postlude(void)
+{
+       pthread_mutex_lock(&mutex);
+}
+
 
-#define PAGE_NOT_FOUND "<html><head><title>File not found</title></head><body>File not found</body></html>"
+
+int loadFile(const char *name, void **data, size_t *len);
 
 static const char *appendf(const char *prev, const char *format, ...)
 {
@@ -87,7 +83,7 @@ static const char *httpd_exec_cgi_tcl_error(Jim_Interp *interp)
 
        t = appendf(t, "Runtime error, file \"%s\", line %d:<br>",
                        interp->errorFileName, interp->errorLine);
-       t = appendf(t, "    %s<br>", Jim_GetString(interp->result, NULL));
+       t = appendf(t, "    %s < br>", Jim_GetString(interp->result, NULL));
        Jim_ListLength(interp, interp->stackTrace, &len);
        for (i = 0; i < len; i += 3)
        {
@@ -100,7 +96,7 @@ static const char *httpd_exec_cgi_tcl_error(Jim_Interp *interp)
                file = Jim_GetString(objPtr, NULL);
                Jim_ListIndex(interp, interp->stackTrace, i + 2, &objPtr, JIM_NONE);
                line = Jim_GetString(objPtr, NULL);
-               t = appendf(t, "In procedure '%s' called at file \"%s\", line %s<br>",
+               t = appendf(t, "In procedure '%s' called at file \"%s\", line %s < br>",
                                proc, file, line);
        }
        t = appendf(t, "</html></body>\n");
@@ -113,7 +109,7 @@ static int httpd_Jim_Command_writeform(Jim_Interp *interp, int argc,
 {
        if (argc != 3)
        {
-               Jim_WrongNumArgs(interp, 1, argv, "method ?args ...?");
+               Jim_WrongNumArgs(interp, 1, argv, "method ?CMD_ARGV ...?");
                return JIM_ERR;
        }
        char *name = (char*) Jim_GetString(argv[1], NULL);
@@ -127,30 +123,26 @@ static int httpd_Jim_Command_writeform(Jim_Interp *interp, int argc,
 
        const char *script = alloc_printf("set dummy_val $httppostdata(%s); set dummy_val",
                        name);
-       retcode = Jim_Eval_Named(interp, script, "httpd.c", __LINE__ );
+       retcode = Jim_Eval_Named(interp, script, __FILE__, __LINE__);
        free((void *) script);
        if (retcode != JIM_OK)
                return retcode;
 
        data = Jim_GetString(Jim_GetResult(interp), &actual);
 
-       FILE *f;
-       f = fopen(file, "wb");
-       if (f != NULL)
+       FILE *f = fopen(file, "wb");
+       if (NULL == f)
        {
-               int ok;
-               ok = fwrite(data, 1, actual, f) == actual;
-               fclose(f);
-
-               if (!ok)
-               {
-                       Jim_SetResultString(interp, "Could not write to file", -1);
-                       return JIM_ERR;
-               }
+               Jim_SetResultString(interp, "Could not create file", -1);
+               return JIM_ERR;
        }
-       else
+
+       int result = fwrite(data, 1, actual, f);
+       fclose(f);
+
+       if (result != actual)
        {
-               Jim_SetResultString(interp, "Could not create file", -1);
+               Jim_SetResultString(interp, "Could not write to file", -1);
                return JIM_ERR;
        }
        return JIM_OK;
@@ -162,9 +154,9 @@ httpd_Jim_Command_formfetch(Jim_Interp *interp,
                                    int argc,
                                    Jim_Obj *const *argv)
 {
-    if (argc!=2)
+    if (argc != 2)
     {
-        Jim_WrongNumArgs(interp, 1, argv, "method ?args ...?");
+        Jim_WrongNumArgs(interp, 1, argv, "method ?CMD_ARGV ...?");
         return JIM_ERR;
     }
     char *name = (char*)Jim_GetString(argv[1], NULL);
@@ -172,7 +164,7 @@ httpd_Jim_Command_formfetch(Jim_Interp *interp,
 
     const char *script = alloc_printf("set dummy_val $httppostdata(%s); set dummy_val",
                        name);
-       int retcode = Jim_Eval_Named(interp, script, "httpd.c", __LINE__ );
+       int retcode = Jim_Eval_Named(interp, script, __FILE__, __LINE__);
        free((void *) script);
        if (retcode != JIM_OK)
        {
@@ -188,6 +180,7 @@ httpd_Jim_Command_formfetch(Jim_Interp *interp,
 struct httpd_request
 {
        int post;
+       Jim_Interp *interp;
        struct MHD_PostProcessor *postprocessor;
 
        //Jim_Obj *dict;
@@ -206,49 +199,69 @@ static void request_completed(void *cls, struct MHD_Connection *connection,
 
        if (r->postprocessor)
        {
+               openocd_sleep_postlude();
                MHD_destroy_post_processor(r->postprocessor);
+               openocd_sleep_prelude();
        }
 
        free(r);
        *con_cls = NULL;
 }
 
-/* append to said key in dictonary */
-static void append_key(struct httpd_request *r, const char *key,
+/* append to said key in dictionary */
+static void append_key(Jim_Interp *interp,
+               struct httpd_request *r, const char *key,
                const char *data, size_t off, size_t size)
 {
        Jim_Obj *keyObj = Jim_NewStringObj(interp, key, -1);
+       Jim_IncrRefCount(keyObj);
        Jim_Obj *value = NULL;
 
        Jim_Obj *dict = Jim_GetVariableStr(interp, "httppostdata", 0);
 
-       if (dict!=NULL)
+       if (dict != NULL)
        {
                if (Jim_DictKey(interp, dict, keyObj, &value, 0) != JIM_OK)
                {
                         value = NULL;
                }
+               else
+               {
+                       Jim_IncrRefCount(value);
+               }
        }
+
        if (value == NULL)
+       {
                value = Jim_NewStringObj(interp, "", -1);
+               Jim_IncrRefCount(value);
+
+       }
 
        /* create a new object we append to and insert into this location */
        Jim_Obj *newObj = Jim_NewStringObj(interp, "", -1);
+       Jim_IncrRefCount(newObj);
        Jim_AppendObj(interp, newObj, value);
        Jim_AppendString(interp, newObj, data, size);
        /* uhh... use name here of dictionary */
-       Jim_SetDictKeysVector(interp, Jim_NewStringObj(interp, "httppostdata", -1), &keyObj, 1, newObj);
+       dict = Jim_NewStringObj(interp, "httppostdata", -1);
+       Jim_IncrRefCount(dict);
+       Jim_SetDictKeysVector(interp, dict, &keyObj, 1, newObj);
+       Jim_DecrRefCount(interp, dict);
+       Jim_DecrRefCount(interp, value);
+       Jim_DecrRefCount(interp, newObj);
+       Jim_DecrRefCount(interp, keyObj);
 }
 
 /* append data to each key */
 static int iterate_post(void *con_cls, enum MHD_ValueKind kind,
                const char *key, const char *filename, const char *content_type,
-               const char *transfer_encoding, const char *data, size_t off,
+               const char *transfer_encoding, const char *data, uint64_t off,
                size_t size)
 {
        struct httpd_request *r = (struct httpd_request*) con_cls;
 
-       append_key(r, key, data, off, size);
+       append_key(r->interp, r, key, data, off, size);
 
        return MHD_YES;
 }
@@ -257,12 +270,13 @@ static int record_arg(void *cls, enum MHD_ValueKind kind, const char *key,
                const char *value)
 {
        struct httpd_request *r = (struct httpd_request*) cls;
-       append_key(r, key, value, 0, strlen(value));
+       append_key(r->interp, r, key, value, 0, strlen(value));
        return MHD_YES;
 }
 
 
-int handle_request(struct MHD_Connection * connection, const char * url)
+static int handle_request(Jim_Interp *interp,
+               struct MHD_Connection * connection, const char * url)
 {
        struct MHD_Response * response;
 
@@ -277,10 +291,10 @@ int handle_request(struct MHD_Connection * connection, const char * url)
 
                const char *script = alloc_printf(
                                "global httpdata; source {%s}; set httpdata", url);
-               retcode = Jim_Eval_Named(interp, script, "httpd.c", __LINE__ );
+               retcode = Jim_Eval_Named(interp, script, __FILE__, __LINE__);
                free((void *) script);
 
-               if (retcode == JIM_ERR)
+               if (retcode != JIM_OK)
                {
                        printf("Tcl failed\n");
                        const char *t = httpd_exec_cgi_tcl_error(interp);
@@ -313,7 +327,7 @@ int handle_request(struct MHD_Connection * connection, const char * url)
        else
        {
                void *data;
-               int len;
+               size_t len;
 
                int retval = loadFile(url, &data, &len);
                if (retval != ERROR_OK)
@@ -327,10 +341,13 @@ int handle_request(struct MHD_Connection * connection, const char * url)
                        return ret;
                }
 
-               LOG_DEBUG("Serving %s length=%d", url, len);
+               LOG_DEBUG("Serving %s length=%zu", url, len);
                /* serve file directly */
                response = MHD_create_response_from_data(len, data, MHD_YES, MHD_NO);
+               /* Should we expose mimetype via tcl here or just let the browser
+                  guess?
                MHD_add_response_header(response, "Content-Type", "image/png");
+               */
 
                ret = MHD_queue_response(connection, MHD_HTTP_OK, response);
                MHD_destroy_response(response);
@@ -340,10 +357,11 @@ int handle_request(struct MHD_Connection * connection, const char * url)
        }
 }
 
-static int ahc_echo(void * cls, struct MHD_Connection * connection,
+static int ahc_echo_inner(void * cls, struct MHD_Connection * connection,
                const char * url, const char * method, const char * version,
-               const char * upload_data, unsigned int * upload_data_size, void ** ptr)
+               const char * upload_data, size_t * upload_data_size, void ** ptr)
 {
+       Jim_Interp *interp = (Jim_Interp *)cls;
        int post = 0;
 
        if (0 == strcmp(method, "POST"))
@@ -370,18 +388,18 @@ static int ahc_echo(void * cls, struct MHD_Connection * connection,
                memset(*ptr, 0, sizeof(struct httpd_request));
 
                r = (struct httpd_request *) *ptr;
-
+               r->interp = interp;
                r->post = post;
                Jim_SetVariableStr(interp, "httppostdata", Jim_NewDictObj(interp, NULL, 0));
 
-               /* fill in url query strings in dictonary */
+               /* fill in url query strings in dictionary */
                MHD_get_connection_values(connection, MHD_GET_ARGUMENT_KIND,
                                record_arg, r);
 
                if (r->post)
                {
                        r->postprocessor = MHD_create_post_processor(connection, 2048
-                                       * 1024, iterate_post, r);
+                                       * 1024, &iterate_post, r);
                }
 
                return MHD_YES;
@@ -413,7 +431,7 @@ static int ahc_echo(void * cls, struct MHD_Connection * connection,
         * being subverted to evil purposes
         */
 
-       const char *httpd_dir=PKGLIBDIR "/httpd";
+       const char *httpd_dir = PKGDATADIR "/httpd";
 
        if (*url=='/')
        {
@@ -422,54 +440,69 @@ static int ahc_echo(void * cls, struct MHD_Connection * connection,
        if (!*url)
                url="index.tcl";
 
-       const char *file_name=alloc_printf("%s/%s", httpd_dir, url);
-       int result = handle_request(connection, file_name);
+       const char *file_name = alloc_printf("%s/%s", httpd_dir, url);
+       int result = handle_request(interp, connection, file_name);
        free((void *)file_name);
        return result;
 }
 
+
+static int ahc_echo(void * cls, struct MHD_Connection * connection,
+               const char * url, const char * method, const char * version,
+               const char * upload_data, size_t * upload_data_size, void ** ptr)
+{
+       int result;
+
+       openocd_sleep_postlude();
+
+       result = ahc_echo_inner(cls, connection, url, method, version, upload_data, upload_data_size, ptr);
+
+       openocd_sleep_prelude();
+
+       return result;
+}
+
 static struct MHD_Daemon * d;
 
-int httpd_start(void)
+static const struct command_registration httpd_command_handlers[] = {
+       {
+               .name = "formfetch",
+               .jim_handler = &httpd_Jim_Command_formfetch,
+               .mode = COMMAND_EXEC,
+               .usage = "<parameter_name>",
+               .help = "Reads a posted form value.",
+       },
+       {
+               .name = "writeform",
+               .jim_handler = &httpd_Jim_Command_writeform,
+               .mode = COMMAND_EXEC,
+               .usage = "<parameter_name> <file>",
+               .help = "Writes a form value to a file.",
+       },
+       COMMAND_REGISTRATION_DONE
+};
+
+int httpd_start(struct command_context *cmd_ctx)
 {
+       pthread_mutexattr_t attr;
+       pthread_mutexattr_init(&attr);
+       pthread_mutex_init(&mutex, &attr);
 
        int port = 8888;
        LOG_USER("Launching httpd server on port %d", port);
        d = MHD_start_daemon(MHD_USE_SELECT_INTERNALLY, port, NULL, NULL,
-                       &ahc_echo, NULL, /* could be data for handler, but we only have a single handler, use global variables instead */
+                       &ahc_echo, cmd_ctx->interp,
                        MHD_OPTION_NOTIFY_COMPLETED, request_completed, NULL, /* Closure... what's that??? */
                        MHD_OPTION_END);
        if (d == NULL)
                return ERROR_FAIL;
 
-       Jim_CreateCommand(interp,
-                                                 "formfetch",
-                                                 httpd_Jim_Command_formfetch,
-                                                 NULL,
-                                                 NULL);
-
-    Jim_CreateCommand(interp,
-                      "writeform",
-                      httpd_Jim_Command_writeform,
-                      NULL,
-                      NULL);
-
-
-       return ERROR_OK;
+       return register_commands(cmd_ctx, NULL, httpd_command_handlers);
 }
 
 void httpd_stop(void)
 {
        MHD_stop_daemon(d);
-}
-
-void openocd_sleep_prelude(void)
-{
-       /* FIX!!!! add locking here!!!! */
-}
-
-void openocd_sleep_postlude(void)
-{
-       /* FIX!!!! add locking here!!!! */
+       pthread_mutex_destroy(&mutex);
 }
 

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)