commit 4a7653f195251864e6a2c3a03c65d286e9cece1d
parent 0b368777369276853d534aef49066eed871f84f7
Author: Joris Vink <joris@coders.se>
Date: Mon, 4 Aug 2014 19:00:25 +0200
Add a parameters example.
This example shows how the parameter system in Kore works
and how to use it properly.
Diffstat:
3 files changed, 117 insertions(+), 0 deletions(-)
diff --git a/examples/parameters/.gitignore b/examples/parameters/.gitignore
@@ -0,0 +1,5 @@
+*.o
+.objs
+parameters.so
+assets.h
+cert
diff --git a/examples/parameters/conf/parameters.conf b/examples/parameters/conf/parameters.conf
@@ -0,0 +1,24 @@
+# Placeholder configuration
+
+bind 127.0.0.1 8888
+pidfile kore.pid
+ssl_no_compression
+load ./parameters.so
+
+# The validator used to validate the 'id' parameter
+# defined below. We'll use a simple regex to make sure
+# it only matches positive numbers.
+validator v_id regex ^[0-9]*$
+
+domain 127.0.0.1 {
+ certfile cert/server.crt
+ certkey cert/server.key
+
+ static / page
+
+ # The parameters allowed for "/" (GET method).
+ params get / {
+ # Validate the id parameter with the v_id validator.
+ validate id v_id
+ }
+}
diff --git a/examples/parameters/src/parameters.c b/examples/parameters/src/parameters.c
@@ -0,0 +1,88 @@
+/*
+ * Copyright (c) 2014 Joris Vink <joris@coders.se>
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#include <kore/kore.h>
+#include <kore/http.h>
+
+int page(struct http_request *);
+
+int
+page(struct http_request *req)
+{
+ int p;
+ u_int16_t id;
+ u_int32_t len;
+ char *sid;
+ struct kore_buf *buf;
+
+ /*
+ * Before we are able to obtain any parameters given to
+ * us via the query string we must tell Kore to parse and
+ * validate them.
+ *
+ * NOTE: All parameters MUST be declared in a params {} block
+ * inside the configuration for Kore! Kore will filter out
+ * any parameters not explicitly defined.
+ *
+ * See conf/parameters.conf on how that is done, this is an
+ * important step as without the params block you will never
+ * get any parameters returned from Kore.
+ *
+ * http_populate_arguments() returns the number of arguments
+ * that were succesfully processed and are available.
+ */
+ p = http_populate_arguments(req);
+
+ /* If we had no arguments available what so ever, return 400. */
+ if (p == 0) {
+ http_response(req, 400, NULL, 0);
+ return (KORE_RESULT_OK);
+ }
+
+ /*
+ * Lets grab the "id" parameter if available. Kore can obtain
+ * parameters in different data types native to C.
+ *
+ * In this scenario, lets grab it both as an actual string and
+ * as an u_int16_t (unsigned short).
+ *
+ * If you grab it as a string, you can immediately ask for
+ * the correct length as well, excluding the NUL terminator.
+ *
+ * When trying to obtain a parameter as something else then
+ * a string, Kore will automatically check if the value fits
+ * in said data type.
+ *
+ * For example if id is 65536 it won't fit in an u_int16_t
+ * and Kore will return an error when trying to read it as such.
+ */
+
+ buf = kore_buf_create(128);
+
+ /* Grab it as a string, we shouldn't free the result in sid. */
+ if (http_argument_get_string("id", &sid, &len))
+ kore_buf_appendf(buf, "id as a string: '%s' (%d)\n", sid, len);
+
+ /* Grab it as an actual u_int16_t. */
+ if (http_argument_get_uint16("id", &id))
+ kore_buf_appendf(buf, "id as an u_int16_t: %d\n", id);
+
+ /* Now return the result to the client with a 200 status code. */
+ http_response(req, 200, buf->data, buf->offset);
+ kore_buf_free(buf);
+
+ return (KORE_RESULT_OK);
+}
