experiments/clixon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
clixon/apps/restconf/restconf_libhttp_main.c
Olof hagsand 290558e7fa libhttp mods
2020-06-02 10:13:15 +02:00

605 lines
17 KiB
C
Raw Blame History

/*
*
***** BEGIN LICENSE BLOCK *****
Copyright (C) 2009-2019 Olof Hagsand
Copyright (C) 2020 Olof Hagsand and Rubicon Communications, LLC(Netgate)
This file is part of CLIXON.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Alternatively, the contents of this file may be used under the terms of
the GNU General Public License Version 3 or later (the "GPL"),
in which case the provisions of the GPL are applicable instead
of those above. If you wish to allow use of your version of this file only
under the terms of the GPL, and not to allow others to
use your version of this file under the terms of Apache License version 2,
indicate your decision by deleting the provisions above and replace them with
the notice and other provisions required by the GPL. If you do not delete
the provisions above, a recipient may use your version of this file under
the terms of any one of the Apache License version 2 or the GPL.
***** END LICENSE BLOCK *****
*/
/* XXX temp constant should go away, */
#undef _LIBHTTP_NYI
#ifdef HAVE_CONFIG_H
#include "clixon_config.h" /* generated by config & autoconf */
#endif
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <errno.h>
#include <signal.h>
#include <syslog.h>
#include <fcntl.h>
#include <time.h>
#include <limits.h>
#include <signal.h>
#include <sys/time.h>
#include <sys/wait.h>
#include <libgen.h>
#include <sys/stat.h> /* chmod */
/* libhttp */
#include <libhttp/libhttp.h>
/* cligen */
#include <cligen/cligen.h>
/* clicon */
#include <clixon/clixon.h>
/* restconf */
#include "restconf_lib.h"
#if 0 /* These are all dependent on FCGX */
#include "restconf_methods.h"
#include "restconf_methods_get.h"
#include "restconf_methods_post.h"
#include "restconf_stream.h"
#endif
/* Command line options to be passed to getopt(3) */
#define RESTCONF_OPTS "hD:f:l:p:d:y:a:u:o:P:"
/* Need global variable to for signal handler XXX */
static clicon_handle _CLICON_HANDLE = NULL;
/*! Signall terminates process
*/
static void
restconf_sig_term(int arg)
{
static int i=0;
if (i++ == 0)
clicon_log(LOG_NOTICE, "%s: %s: pid: %u Signal %d",
__PROGRAM__, __FUNCTION__, getpid(), arg);
else
exit(-1);
if (_CLICON_HANDLE){
#ifdef _LIBHTTP_NYI
stream_child_freeall(_CLICON_HANDLE);
#endif
restconf_terminate(_CLICON_HANDLE);
}
clicon_exit_set(); /* checked in event_loop() */
exit(-1);
}
static void
restconf_sig_child(int arg)
{
int status;
int pid;
if ((pid = waitpid(-1, &status, 0)) != -1 && WIFEXITED(status))
#ifdef _LIBHTTP_NYI
stream_child_free(_CLICON_HANDLE, pid);
#else
;
#endif
}
/*! Usage help routine
* @param[in] argv0 command line
* @param[in] h Clicon handle
*/
static void
usage(clicon_handle h,
char *argv0)
{
fprintf(stderr, "usage:%s [options]\n"
"where options are\n"
"\t-h \t\t Help\n"
"\t-D <level>\t Debug level\n"
"\t-f <file>\t Configuration file (mandatory)\n"
"\t-l <s|f<file>> \t Log on (s)yslog, (f)ile (syslog is default)\n"
"\t-p <dir>\t Yang directory path (see CLICON_YANG_DIR)\n"
"\t-d <dir>\t Specify restconf plugin directory dir (default: %s)\n"
"\t-y <file>\t Load yang spec file (override yang main module)\n"
"\t-a UNIX|IPv4|IPv6 Internal backend socket family\n"
"\t-u <path|addr>\t Internal socket domain path or IP addr (see -a)\n"
"\t-o \"<option>=<value>\" Give configuration option overriding config file (see clixon-config.yang)\n"
"\t-P <port>\t HTTP port (default 80)\n"
,
argv0,
clicon_restconf_dir(h)
);
exit(0);
}
/*! Create and append a libhttp option.
*/
static int
lh_opts_append(struct lh_opt_t **options,
int *len,
char *name,
char *value)
{
int retval = -1;
struct lh_opt_t *opt = NULL;
(*len)++;
if ((*options = realloc(*options, *len*sizeof(*opt))) == NULL){
clicon_err(OE_FATAL, errno, "realloc");
goto done;
}
opt = &(*options)[*len-1];
memset(opt, 0, sizeof(*opt));
if (name && (opt->name = strdup(name)) == NULL){
clicon_err(OE_FATAL, errno, "strdup");
goto done;
}
if (value && (opt->value = strdup(value)) == NULL){
clicon_err(OE_FATAL, errno, "strdup");
goto done;
}
retval = 0;
done:
return retval;
}
/*! Free a libhttp options list
*/
static int
lh_opts_free(struct lh_opt_t *options,
int len)
{
struct lh_opt_t *opt = NULL;
int i;
for (i=0; i<len; i++){
opt = &options[i];
if (opt->name)
free((char*)opt->name);
if (opt->value)
free((char*)opt->value);
}
if (options)
free(options);
return 0;
}
/*! Libhttp icoming request
*/
static int
cx_begin_request(struct lh_ctx_t *ctx,
struct lh_con_t *conn)
{
const struct lh_rqi_t *request_info = httplib_get_request_info(conn);
char content[100];
// Prepare the message we're going to send
int content_length = snprintf(content, sizeof(content),
"Hello from Clixon FOO! Remote port: %d",
request_info->remote_port);
fprintf(stderr, "%s\n", __FUNCTION__);
httplib_printf(ctx, conn,
"HTTP/1.1 200 OK\r\n"
"Content-Type: text/plain\r\n"
"Content-Length: %d\r\n" // Always set Content-Length
"\r\n"
"%s",
content_length, content);
return 0;
}
static void
cx_end_request(struct lh_ctx_t *ctx,
const struct lh_con_t *conn,
int reply_status_code )
{
fprintf(stderr, "%s\n", __FUNCTION__);
}
static int
cx_log_message(struct lh_ctx_t *ctx,
const struct lh_con_t *conn,
const char *message)
{
fprintf(stderr, "ERROR: %s\n", message);
return 0;
}
static int
cx_log_access(struct lh_ctx_t *ctx,
const struct lh_con_t *conn,
const char *message)
{
fprintf(stderr, "%s\n", __FUNCTION__);
return 0;
}
static int
cx_init_ssl(struct lh_ctx_t *ctx,
void *ssl_context,
void *user_data)
{
fprintf(stderr, "%s\n", __FUNCTION__);
return 0;
}
static void
cx_connection_close(struct lh_ctx_t *ctx,
const struct lh_con_t *conn)
{
fprintf(stderr, "%s\n", __FUNCTION__);
}
static const char *
cx_open_file(struct lh_ctx_t *ctx,
const struct lh_con_t *conn,
const char *path,
size_t *data_len)
{
fprintf(stderr, "%s\n", __FUNCTION__);
return NULL;
}
static void
cx_init_lua(struct lh_ctx_t *ctx,
const struct lh_con_t *conn,
void *lua_context)
{
fprintf(stderr, "%s\n", __FUNCTION__);
}
static int
cx_http_error(struct lh_ctx_t *ctx,
struct lh_con_t *conn,
int status)
{
fprintf(stderr, "%s\n", __FUNCTION__);
return 0;
}
static void
cx_init_context(struct lh_ctx_t *ctx)
{
fprintf(stderr, "%s\n", __FUNCTION__);
}
static void
cx_init_thread(struct lh_ctx_t *ctx,
int thread_type)
{
fprintf(stderr, "%s\n", __FUNCTION__);
}
static void
cx_exit_context(struct lh_ctx_t *ctx)
{
fprintf(stderr, "%s\n", __FUNCTION__);
}
/*! Main routine for libhttp restconf
*/
int
main(int argc,
char **argv)
{
int retval = -1;
char *argv0 = argv[0];
int c;
clicon_handle h;
char *dir;
int logdst = CLICON_LOG_SYSLOG;
yang_stmt *yspec = NULL;
int finish = 0;
int start = 1;
char *str;
clixon_plugin *cp = NULL;
uint32_t id = 0;
cvec *nsctx_global = NULL; /* Global namespace context */
size_t cligen_buflen;
size_t cligen_bufthreshold;
char *portstr = "80";
#ifdef _LIBHTTP_NYI
char *stream_path;
#endif
struct lh_ctx_t *ctx = NULL;
/* See XX_httplib_free_config_options, XX_httplib_init_options */
struct lh_opt_t *lh_opts = NULL;
int lh_opts_len = 0;
const struct lh_clb_t lh_callbacks = {cx_begin_request, cx_end_request, cx_log_message, cx_log_access, cx_init_ssl,
cx_connection_close, cx_open_file, cx_init_lua, cx_http_error,
cx_init_context, cx_init_thread, cx_exit_context};
/* In the startup, logs to stderr & debug flag set later */
clicon_log_init(__PROGRAM__, LOG_INFO, logdst);
/* Create handle */
if ((h = clicon_handle_init()) == NULL)
goto done;
_CLICON_HANDLE = h; /* for termination handling */
while ((c = getopt(argc, argv, RESTCONF_OPTS)) != -1)
switch (c) {
case 'h':
usage(h, argv[0]);
break;
case 'D' : /* debug */
if (sscanf(optarg, "%d", &debug) != 1)
usage(h, argv[0]);
break;
case 'f': /* override config file */
if (!strlen(optarg))
usage(h, argv[0]);
clicon_option_str_set(h, "CLICON_CONFIGFILE", optarg);
break;
case 'l': /* Log destination: s|e|o */
if ((logdst = clicon_log_opt(optarg[0])) < 0)
usage(h, argv[0]);
if (logdst == CLICON_LOG_FILE &&
strlen(optarg)>1 &&
clicon_log_file(optarg+1) < 0)
goto done;
break;
} /* switch getopt */
/*
* Logs, error and debug to stderr or syslog, set debug level
*/
clicon_log_init(__PROGRAM__, debug?LOG_DEBUG:LOG_INFO, logdst);
clicon_debug_init(debug, NULL);
clicon_log(LOG_NOTICE, "%s: %u Started", __PROGRAM__, getpid());
if (set_signal(SIGTERM, restconf_sig_term, NULL) < 0){
clicon_err(OE_DAEMON, errno, "Setting signal");
goto done;
}
if (set_signal(SIGINT, restconf_sig_term, NULL) < 0){
clicon_err(OE_DAEMON, errno, "Setting signal");
goto done;
}
if (set_signal(SIGCHLD, restconf_sig_child, NULL) < 0){
clicon_err(OE_DAEMON, errno, "Setting signal");
goto done;
}
/* Find and read configfile */
if (clicon_options_main(h) < 0)
goto done;
#ifdef _LIBHTTP_NYI
stream_path = clicon_option_str(h, "CLICON_STREAM_PATH");
#endif
/* Now rest of options, some overwrite option file */
optind = 1;
opterr = 0;
while ((c = getopt(argc, argv, RESTCONF_OPTS)) != -1)
switch (c) {
case 'h' : /* help */
case 'D' : /* debug */
case 'f': /* config file */
case 'l': /* log */
break; /* see above */
case 'p' : /* yang dir path */
if (clicon_option_add(h, "CLICON_YANG_DIR", optarg) < 0)
goto done;
break;
case 'd': /* Plugin directory */
if (!strlen(optarg))
usage(h, argv[0]);
clicon_option_str_set(h, "CLICON_RESTCONF_DIR", optarg);
break;
case 'y' : /* Load yang spec file (override yang main module) */
clicon_option_str_set(h, "CLICON_YANG_MAIN_FILE", optarg);
break;
case 'a': /* internal backend socket address family */
clicon_option_str_set(h, "CLICON_SOCK_FAMILY", optarg);
break;
case 'u': /* internal backend socket unix domain path or ip host */
if (!strlen(optarg))
usage(h, argv[0]);
clicon_option_str_set(h, "CLICON_SOCK", optarg);
break;
case 'o':{ /* Configuration option */
char *val;
if ((val = index(optarg, '=')) == NULL)
usage(h, argv0);
*val++ = '\0';
if (clicon_option_add(h, optarg, val) < 0)
goto done;
break;
}
case 'P': /* http port */
if (!strlen(optarg))
usage(h, argv[0]);
portstr=optarg;
break;
default:
usage(h, argv[0]);
break;
}
argc -= optind;
argv += optind;
/* See here for libhttp options XX_httplib_process_options
* - https://github.com/lammertb/libhttp/blob/master/doc/UserManual.md
* some options seem documented here: https://github.com/civetweb/civetweb/blob/master/docs/UserManual.md
*/
if (lh_opts_append(&lh_opts, &lh_opts_len, "listening_ports", portstr) < 0)
goto done;
if (lh_opts_append(&lh_opts, &lh_opts_len, "num_threads", "5") < 0)
goto done;
/* Access the remaining argv/argc options (after --) w clicon-argv_get() */
clicon_argv_set(h, argv0, argc, argv);
/* Init cligen buffers */
cligen_buflen = clicon_option_int(h, "CLICON_CLI_BUF_START");
cligen_bufthreshold = clicon_option_int(h, "CLICON_CLI_BUF_THRESHOLD");
cbuf_alloc_set(cligen_buflen, cligen_bufthreshold);
/* Add (hardcoded) netconf features in case ietf-netconf loaded here
* Otherwise it is loaded in netconf_module_load below
*/
if (netconf_module_features(h) < 0)
goto done;
/* Create top-level yang spec and store as option */
if ((yspec = yspec_new()) == NULL)
goto done;
clicon_dbspec_yang_set(h, yspec);
/* Treat unknown XML as anydata */
if (clicon_option_bool(h, "CLICON_YANG_UNKNOWN_ANYDATA") == 1)
xml_bind_yang_unknown_anydata(1);
/* Load restconf plugins before yangs are loaded (eg extension callbacks) */
if ((dir = clicon_restconf_dir(h)) != NULL)
if (clixon_plugins_load(h, CLIXON_PLUGIN_INIT, dir, NULL) < 0)
return -1;
/* Create a pseudo-plugin to create extension callback to set the ietf-routing
* yang-data extension for api-root top-level restconf function.
*/
if (clixon_pseudo_plugin(h, "pseudo restconf", &cp) < 0)
goto done;
cp->cp_api.ca_extension = restconf_main_extension_cb;
/* Load Yang modules
* 1. Load a yang module as a specific absolute filename */
if ((str = clicon_yang_main_file(h)) != NULL){
if (yang_spec_parse_file(h, str, yspec) < 0)
goto done;
}
/* 2. Load a (single) main module */
if ((str = clicon_yang_module_main(h)) != NULL){
if (yang_spec_parse_module(h, str, clicon_yang_module_revision(h),
yspec) < 0)
goto done;
}
/* 3. Load all modules in a directory */
if ((str = clicon_yang_main_dir(h)) != NULL){
if (yang_spec_load_dir(h, str, yspec) < 0)
goto done;
}
/* Load clixon lib yang module */
if (yang_spec_parse_module(h, "clixon-lib", NULL, yspec) < 0)
goto done;
/* Load yang module library, RFC7895 */
if (yang_modules_init(h) < 0)
goto done;
/* Load yang restconf module */
if (yang_spec_parse_module(h, "ietf-restconf", NULL, yspec)< 0)
goto done;
/* Add netconf yang spec, used as internal protocol */
if (netconf_module_load(h) < 0)
goto done;
/* Add system modules */
if (clicon_option_bool(h, "CLICON_STREAM_DISCOVERY_RFC8040") &&
yang_spec_parse_module(h, "ietf-restconf-monitoring", NULL, yspec)< 0)
goto done;
if (clicon_option_bool(h, "CLICON_STREAM_DISCOVERY_RFC5277") &&
yang_spec_parse_module(h, "clixon-rfc5277", NULL, yspec)< 0)
goto done;
/* Here all modules are loaded
* Compute and set canonical namespace context
*/
if (xml_nsctx_yangspec(yspec, &nsctx_global) < 0)
goto done;
if (clicon_nsctx_global_set(h, nsctx_global) < 0)
goto done;
/* Dump configuration options on debug */
if (debug)
clicon_option_dump(h, debug);
/* Call start function in all plugins before we go interactive
*/
if (clixon_plugin_start_all(h) < 0)
goto done;
/* Find and read configfile */
if (clicon_options_main(h) < 0)
goto done;
/* Terminate options list with NULL (must be the last) */
if (lh_opts_append(&lh_opts, &lh_opts_len, NULL, NULL) < 0)
goto done;
/* Start the web server. */
if ((ctx = httplib_start(&lh_callbacks, /* callbacks */
h, /* userdata - clixon handle*/
lh_opts /* options */
)) == NULL)
goto done;
while (finish == 0) {
finish = 1; /* If zero, dont finish request, initiate new */
clicon_debug(1, "------------");
if (start == 0){
/* Send hello request to backend to get session-id back
* This is done once at the beginning of the session and then this is
* used by the client, even though new TCP sessions are created for
* each message sent to the backend.
*/
if (clicon_hello_req(h, &id) < 0)
goto done;
clicon_session_id_set(h, id);
start++;
}
break; /* XXX */
}
pthread_exit(NULL);
/* Use options to select the port and document root among other things.
* Use callbacks to add your own hooks.
*/
retval = 0;
done:
if (ctx)
httplib_stop(ctx); /* to stop the server. */
#ifdef _LIBHTTP_NYI
stream_child_freeall(h);
#endif
lh_opts_free(lh_opts, lh_opts_len);
restconf_terminate(h);
return retval;
}
Reference in a new issue View git blame Copy permalink