Changeset db656f3332551668dbf8656d8dcd05fe917ddcd7

Timestamp:

09/06/08 23:51:16 (5 years ago)

Author:

Theo Schlossnagle <jesus@omniti.com>

git-committer:

Theo Schlossnagle <jesus@omniti.com> 1220745076 +0000

git-parent:

[aa6712ff5754eb2cffd6bc6260529c77b5878dbe]

git-author:

Theo Schlossnagle <jesus@omniti.com> 1220745076 +0000

Message:

pull help and docs into the console, refs #21

Files:

• buildtools/xml2h (added)
• configure.in (modified) (1 diff)
• src/Makefile.in (modified) (2 diffs)
• src/modules/Makefile.in (modified) (9 diffs)
• src/modules/dns.c (modified) (2 diffs)
• src/modules/http.c (modified) (6 diffs)
• src/modules/lua.c (modified) (4 diffs)
• src/modules/module-online.xsl (added)
• src/modules/postgres.c (modified) (2 diffs)
• src/modules/snmp.c (modified) (2 diffs)
• src/modules/ssh2.c (modified) (2 diffs)
• src/noit_conf.c (modified) (1 diff)
• src/noit_console.c (modified) (1 diff)
• src/noit_console.h (modified) (4 diffs)
• src/noit_console_state.c (modified) (11 diffs)
• src/noit_module.c (modified) (2 diffs)
• src/noit_module.h (modified) (4 diffs)

configure.in

@@ -212 +212 @@
-AC_MSG_RESULT([$XML2LIBS])
-
+AC_CHECK_FUNC(xmlParseDocument, , [AC_MSG_ERROR(*** libxml2 is required ***)])
+
+AC_MSG_CHECKING([libxslt cflags])
+XSLTCFLAGS=`xslt-config --cflags`
+CFLAGS="$CFLAGS $XSLTCFLAGS"
+AC_MSG_RESULT([$XSLTCFLAGS])
+
+AC_MSG_CHECKING([libxslt libs])
+XSLTLIBS=`xslt-config --libs`
+LIBS="$LIBS $XSLTLIBS"
+AC_MSG_RESULT([$XSLTLIBS])
+
+AC_CHECK_FUNC(xsltParseStylesheetDoc, , [AC_MSG_ERROR(*** libxslt is required ***)])
+
-APRPREFIX="`apr-1-config --prefix`"
-AC_MSG_CHECKING([libserf cflags])

src/Makefile.in

@@ -9 +9 @@
-PGLIBS=@PGLIBS@
-INSTALL=@INSTALL@
+XML2H=@top_srcdir@/buildtools/xml2h
-
-prefix=@prefix@
@@ -97 +98 @@
-        @echo "- compiling $<"
-
+noit_module.o:  module-online.h
+
+module-online.h:        modules/module-online.xsl
+        @echo "- making module-online.h (StyleSheet include"
+        @$(XML2H) helpStyleXML < modules/module-online.xsl > $@
+
-noit_tokenizer.c:       noit_tokenizer.re
-        @re2c -o $@ noit_tokenizer.re

src/modules/Makefile.in

@@ -1 @@
-
+ .xml .xmlh
-
-CC=@CC@
@@ -18 +18 @@
-XSLTPROC=@XSLTPROC@
-XMLLINT=@XMLLINT@
+XML2H=@top_srcdir@/buildtools/xml2h
-
-top_srcdir=@top_srcdir@
@@ -27 +28 @@
-all:    $(MODULES)
-
+.xml.xmlh:
+        @$(XML2H) `echo $< | sed -e 's/\.xml$$//;'`_xml_description < $< > $@
+
-lua.@MODULEEXT@:        lua.lo lua_noit.lo
-        @$(MODULELD) $(LDFLAGS) -o $@ lua.lo lua_noit.lo ../lua/liblua.lo
-        @echo "- linking $@"
-
-
+ lua.xmlh
-        @$(CC) $(CPPFLAGS) $(SHCFLAGS) -I$(top_srcdir)/src/lua/src -c lua.c -o $@
-        @echo "- compiling $<"
@@ -43 +47 @@
-        @echo "- linking $@"
-
-
+ postgres.xmlh
-        @$(CC) $(CPPFLAGS) $(SHCFLAGS) $(PGCFLAGS) -c $< -o $@
-        @echo "- compiling $<"
@@ -51 +55 @@
-        @echo "- linking $@"
-
-
+ dns.xmlh
-        @$(CC) $(CPPFLAGS) $(SHCFLAGS) -c $< -o $@
-        @echo "- compiling $<"
@@ -59 +63 @@
-        @echo "- linking $@"
-
-
+ http.xmlh resmon.xmlh resmon_part.xmlh
-        @$(CC) $(CPPFLAGS) $(SHCFLAGS) -I$(top_srcdir)/src/serf @SERFCFLAGS@ -c http.c -o $@
-        @echo "- compiling $<"
@@ -71 +75 @@
-        @echo "- linking $@"
-
+ssh2.lo:        ssh2.xmlh
+
-ping_icmp.@MODULEEXT@:  ping_icmp.lo
-        @$(MODULELD) $(LDFLAGS) -o $@ $<
@@ -78 +84 @@
-        @$(MODULELD) $(LDFLAGS) -o $@ $<
-        @echo "- linking $@"
+
+snmp.lo:        snmp.xmlh
-
-.c.lo:
@@ -95 +103 @@
-
-clean:
-
+ *.xmlh

src/modules/dns.c

@@ -666 +666 @@
-}
-
+#include "dns.xmlh"
-noit_module_t dns = {
-  {
@@ -672 +673 @@
-    "dns",
-    "DNS RR checker",
+    dns_xml_description,
-    dns_onload
-  },

src/modules/http.c

@@ -893 +893 @@
-  return 0;
-}
+
+#include "http.xmlh"
-noit_module_t http = {
-  {
@@ -899 +901 @@
-    "http",
-    "libserf-based HTTP and HTTPS resource checker",
+    http_xml_description,
-    serf_onload
-  },
@@ -907 +910 @@
-};
-
+#include "resmon.xmlh"
-noit_module_t resmon = {
-  {
@@ -913 +917 @@
-    "resmon",
-    "libserf-based resmon resource checker",
+    resmon_xml_description,
-    serf_onload
-  },
@@ -921 +926 @@
-};
-
+#include "resmon_part.xmlh"
-noit_module_t resmon_part = {
-  {
@@ -927 +933 @@
-    "resmon_part",
-    "resmon part resource checker",
+    resmon_part_xml_description,
-    serf_onload
-  },

src/modules/lua.c

@@ -144 +144 @@
-}
-static int
+noit_lua_module_set_description(lua_State *L) {
+  noit_module_t *module;
+  if(lua_gettop(L) != 1) luaL_error(L, "wrong number of arguments");
+  module = lua_touserdata(L, lua_upvalueindex(1));
+  module->hdr.description = strdup(lua_tostring(L, 1));
+  return 0;
+}
+static int
+noit_lua_module_set_name(lua_State *L) {
+  noit_module_t *module;
+  if(lua_gettop(L) != 1) luaL_error(L, "wrong number of arguments");
+  module = lua_touserdata(L, lua_upvalueindex(1));
+  module->hdr.name = strdup(lua_tostring(L, 1));
+  return 0;
+}
+static int
+noit_lua_module_set_xml_description(lua_State *L) {
+  noit_module_t *module;
+  if(lua_gettop(L) != 1) luaL_error(L, "wrong number of arguments");
+  module = lua_touserdata(L, lua_upvalueindex(1));
+  module->hdr.xml_description = strdup(lua_tostring(L, 1));
+  return 0;
+}
+static int
-noit_module_index_func(lua_State *L) {
+  noit_module_t **udata, *module;
+  const char *k;
-  int n;
-  n = lua_gettop(L);    /* number of arguments */
@@ -151 +177 @@
-    luaL_error(L, "metatable error, arg1 not a noit_module_t!");
-  }
+  udata = lua_touserdata(L, 1);
+  module = *udata;
+  if(!lua_isstring(L, 2)) {
+    luaL_error(L, "metatable error, arg2 not a string!");
+  }
+  k = lua_tostring(L, 2);
+  switch(*k) {
+    case 'd':
+      if(!strcmp(k, "description")) {
+        lua_pushlightuserdata(L, module);
+        lua_pushcclosure(L, noit_lua_module_set_description, 1);
+      }
+      else break;
+      return 1;
+    case 'n':
+      if(!strcmp(k, "name")) {
+        lua_pushlightuserdata(L, module);
+        lua_pushcclosure(L, noit_lua_module_set_name, 1);
+      }
+      else break;
+      return 1;
+    case 'x':
+      if(!strcmp(k, "xml_description")) {
+        lua_pushlightuserdata(L, module);
+        lua_pushcclosure(L, noit_lua_module_set_xml_description, 1);
+      }
+      else break;
+      return 1;
+    default:
+      break;
+  }
+  luaL_error(L, "noit_module_t no such element: %s", k);
-  return 0;
-}
@@ -732 +790 @@
-}
-
+#include "lua.xmlh"
-noit_module_loader_t lua = {
-  {
@@ -738 +797 @@
-    "lua",
-    "Lua check loader",
+    lua_xml_description,
-    noit_lua_loader_onload,
-  },

src/modules/postgres.c

@@ -256 +256 @@
-}
-
+#include "postgres.xmlh"
-noit_module_t postgres = {
-  {
@@ -262 +263 @@
-    "postgres",
-    "PostgreSQL Checker",
+    postgres_xml_description,
-    postgres_onload
-  },

src/modules/snmp.c

@@ -465 +465 @@
-  return 0;
-}
+
+#include "snmp.xmlh"
-noit_module_t snmp = {
-  {
@@ -471 +473 @@
-    "snmp",
-    "SNMP collection",
+    snmp_xml_description,
-    noit_snmp_onload
-  },

src/modules/ssh2.c

@@ -300 +300 @@
-}
-
+#include "ssh2.xmlh"
-noit_module_t ssh2 = {
-  {
@@ -306 +307 @@
-    "ssh2",
-    "Secure Shell version 2 checker",
+    ssh2_xml_description,
-    ssh2_onload
-  },

src/noit_conf.c

@@ -445 +445 @@
-    return noit_conf_set_string(section,path,"true");
-  return noit_conf_set_string(section,path,"false");
-}
-
-static int
-noit_console_write_xml(void *vncct, const char *buffer, int len) {
-  noit_console_closure_t ncct = vncct;
-  return nc_write(ncct, buffer, len);
-}
-static int
-noit_console_close_xml(void *vncct) {
-  return 0;
-}
-

src/noit_console.c

@@ -454 +454 @@
-};
-
+int
+noit_console_write_xml(void *vncct, const char *buffer, int len) {
+  noit_console_closure_t ncct = vncct;
+  return nc_write(ncct, buffer, len);
+}
+
+int
+noit_console_close_xml(void *vncct) {
+  return 0;
+}
+
-void
-noit_console_init() {

src/noit_console.h

@@ -34 +34 @@
-/* This performs a pop (exiting if at toplevel) */
-extern cmd_info_t console_command_exit;
+extern cmd_info_t console_command_help;
-extern cmd_info_t console_command_shutdown;
-extern cmd_info_t console_command_restart;
@@ -59 +60 @@
-
-typedef struct _console_state_stack {
+  char *name;
-  noit_console_state_t *state;
-  void *userdata;
@@ -121 +123 @@
-
-API_EXPORT(int)
+  noit_console_help(noit_console_closure_t ncct, int argc, char **argv,
+                    noit_console_state_t *, void *);
+
+API_EXPORT(int)
-  noit_console_shutdown(noit_console_closure_t ncct, int argc, char **argv,
-                        noit_console_state_t *, void *);
@@ -171 +177 @@
-         noit_console_state_t *dstate, void *closure);
-
+API_EXPORT(int)
+  noit_console_write_xml(void *vncct, const char *buffer, int len);
+
+API_EXPORT(int)
+  noit_console_close_xml(void *vncct);
+
+API_EXPORT(void)
+  noit_console_add_help(const char *topic, console_cmd_func_t topic_func);
+
-#endif

src/noit_console_state.c

@@ -12 +12 @@
-#include "noit_console.h"
-#include "noit_tokenizer.h"
+#include "noit_module.h"
-
-#include <netinet/in.h>
@@ -17 +18 @@
-#include <pcre.h>
-
+int cmd_info_comparek(const void *akv, const void *bv) {
+  char *ak = (char *)akv;
+  cmd_info_t *b = (cmd_info_t *)bv;
+  return strcasecmp(ak, b->name);
+}
+int cmd_info_compare(const void *av, const void *bv) {
+  cmd_info_t *a = (cmd_info_t *)av;
+  cmd_info_t *b = (cmd_info_t *)bv;
+  return strcasecmp(a->name, b->name);
+}
+
+cmd_info_t console_command_help = {
+  "help", noit_console_help, NULL, NULL
+};
-cmd_info_t console_command_exit = {
-  "exit", noit_console_state_pop, NULL, NULL
@@ -27 +42 @@
-};
-
+void
+noit_console_add_help(const char *topic, console_cmd_func_t topic_func) {
+  noit_console_state_t *s = console_command_help.dstate;
+  if(!s) {
+    console_command_help.dstate = s = calloc(1, sizeof(*s));
+    noit_skiplist_init(&s->cmds);
+    noit_skiplist_set_compare(&s->cmds, cmd_info_compare, cmd_info_comparek);
+  }
+  noit_console_state_add_cmd(s, NCSCMD(topic, topic_func, NULL, NULL));
+}
-
-static char *
@@ -194 +219 @@
-
-int
+noit_console_render_help(noit_console_closure_t ncct,
+                         noit_console_state_t *dstate) {
+  noit_skiplist_node *iter = NULL;
+  if(!dstate) {
+    nc_printf(ncct, "No help available.\n");
+    return -1;
+  }
+  for(iter = noit_skiplist_getlist(&dstate->cmds); iter;
+      noit_skiplist_next(&dstate->cmds,&iter)) {
+    cmd_info_t *cmd = iter->data;
+    if(strcmp(cmd->name, "help")) nc_printf(ncct, "  ==> '%s'\n", cmd->name);
+  }
+  return 0;
+}
+
+int
-noit_console_state_delegate(noit_console_closure_t ncct,
-                            int argc, char **argv,
@@ -201 +242 @@
-
-  if(argc == 0) {
-c_printf(ncct, "arguments expected\n"
-/* XXX: noit_console_render_help(dstate); */
+oit_console_render_help(ncct, dstate
+nc_printf(ncct, "incomplete command.\n");
-    return -1;
-  }
@@ -221 +262 @@
-
-  if(!argc) {
+    noit_console_render_help(ncct, stack->state);
-    nc_printf(ncct, "arguments expected\n");
-    return -1;
@@ -266 +308 @@
-    }
-  }
+  if(ncct->state_stack->name) free(ncct->state_stack->name);
+  ncct->state_stack->name = strdup(cmd->name);
-  return cmd->func(ncct, argc-1, argv+1, cmd->dstate, cmd->closure);
-}
@@ -271 +315 @@
-noit_console_state_do(noit_console_closure_t ncct, int argc, char **argv) {
-  return _noit_console_state_do(ncct, ncct->state_stack, argc, argv);
-}
-
-int cmd_info_comparek(const void *akv, const void *bv) {
-  char *ak = (char *)akv;
-  cmd_info_t *b = (cmd_info_t *)bv;
-  return strcasecmp(ak, b->name);
-}
-int cmd_info_compare(const void *av, const void *bv) {
-  cmd_info_t *a = (cmd_info_t *)av;
-  cmd_info_t *b = (cmd_info_t *)bv;
-  return strcasecmp(a->name, b->name);
-}
-
@@ -292 +325 @@
-  noit_console_state_add_cmd(s,
-      NCSCMD("apply", noit_console_generic_apply, NULL, NULL));
+  noit_console_state_add_cmd(s, &console_command_help);
-  return s;
-}
@@ -375 +409 @@
-  exit(1);
-}
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-int
-noit_console_state_pop(noit_console_closure_t ncct, int argc, char **argv,
@@ -394 +461 @@
-  current->last = NULL;
-  if(current->state->statefree) current->state->statefree(current->state);
+  if(current->name) free(current->name);
-  free(current);
-  noit_console_state_init(ncct);

src/noit_module.c

@@ -8 +8 @@
-#include <stdio.h>
-#include <dlfcn.h>
+
+#include <libxml/parser.h>
+#include <libxslt/xslt.h>
+#include <libxslt/xsltInternals.h>
+#include <libxslt/transform.h>
-
-#include "noit_module.h"
@@ -172 +177 @@
-}
-
+#include "module-online.h"
+
+void noit_module_print_help(noit_console_closure_t ncct,
+                            noit_module_t *module, int examples) {
+  const char *params[3] = { NULL };
+  xmlDocPtr help = NULL, output = NULL;
+  xmlOutputBufferPtr out;
+  xmlCharEncodingHandlerPtr enc;
+  static xmlDocPtr helpStyleDoc = NULL;
+  static xsltStylesheetPtr helpStyle = NULL;
+  if(!helpStyle) {
+    if(!helpStyleDoc)
+      helpStyleDoc = xmlParseMemory(helpStyleXML, strlen(helpStyleXML));
+    if(!helpStyleDoc) {
+      nc_printf(ncct, "Invalid XML for style XML\n");
+      return;
+    }
+    helpStyle = xsltParseStylesheetDoc(helpStyleDoc);
+  }
+  if(!helpStyle) {
+    nc_printf(ncct, "no available stylesheet.\n");
+    return;
+  }
+  if(!module) {
+    nc_printf(ncct, "no module\n");
+    return;
+  }
+  if(!module->hdr.xml_description) {
+    nc_printf(ncct, "%s is undocumented, complain to the vendor.\n",
+              module->hdr.name);
+    return;
+  }
+  help = xmlParseMemory(module->hdr.xml_description,
+                        strlen(module->hdr.xml_description));
+  if(!help) {
+    nc_printf(ncct, "%s module has invalid XML documentation.\n",
+              module->hdr.name);
+    return;
+  }
+
+  if(examples) {
+    params[0] = "example";
+    params[1] = "'1'";
+    params[2] = NULL;
+  }
+  output = xsltApplyStylesheet(helpStyle, help, params);
+  if(!output) {
+    nc_printf(ncct, "formatting failed.\n");
+    goto out;
+  }
+
+  enc = xmlGetCharEncodingHandler(XML_CHAR_ENCODING_UTF8);
+  out = xmlOutputBufferCreateIO(noit_console_write_xml,
+                                noit_console_close_xml,
+                                ncct, enc);
+  xmlSaveFormatFileTo(out, output, "utf8", 1);
+
+ out:
+  if(help) xmlFreeDoc(help);
+  if(output) xmlFreeDoc(output);
+}
+
+int
+noit_module_help(noit_console_closure_t ncct,
+                 int argc, char **argv,
+                 noit_console_state_t *state, void *closure) {
+  if(argc == 0) { 
+    /* List modules */ 
+    noit_hash_iter iter = NOIT_HASH_ITER_ZERO;
+    const char *name;
+    int klen;
+    noit_image_t *hdr;
+
+    nc_printf(ncct, "= Loaders and Modules =\n");
+    while(noit_hash_next(&loaders, &iter, (const char **)&name, &klen,
+                         (void **)&hdr)) {
+      nc_printf(ncct, "  %s\n", hdr->name);
+    }
+    memset(&iter, 0, sizeof(iter));
+    while(noit_hash_next(&modules, &iter, (const char **)&name, &klen,
+                         (void **)&hdr)) {
+      nc_printf(ncct, "  %s\n", hdr->name);
+    }
+    return 0;
+  } 
+  else if(argc == 1 || 
+          (argc == 2 && !strcmp(argv[1], "examples"))) { 
+    /* help for a specific module */ 
+    noit_module_t *mod; 
+    mod = noit_module_lookup(argv[0]); 
+    noit_module_print_help(ncct, mod, argc == 2); 
+    return 0; 
+  } 
+  nc_printf(ncct, "help module [ <modulename> [ examples ] ]\n");
+  return -1;
+}
+
-void noit_module_init() {
-  noit_conf_section_t *sections;
-  int i, cnt = 0;
+
+  noit_console_add_help("module", noit_module_help);
-
-  /* Load our module loaders */

src/noit_module.h

@@ -12 +12 @@
-
-#define NOIT_LOADER_MAGIC         0xA7AD7104
-3
+4
-
-typedef struct _noit_image {
@@ -19 +19 @@
-  char *name;
-  char *description;
+  char *xml_description;
-  int (*onload)(struct _noit_image *);
-  void *opaque_handle;
@@ -42 +43 @@
-
-#define NOIT_MODULE_MAGIC         0x4017DA7A
-2
+3
-
-typedef struct _noit_module {
@@ -85 +86 @@
-API_EXPORT(void)
-  noit_module_set_userdata(noit_module_t *mod, void *newdata);
-
+
+
+
-
-#endif