From: Russ Combs <rucombs@cisco.com>
Date: Fri, 5 Sep 2014 20:14:07 +0000 (-0400)
Subject: help on plugins
X-Git-Tag: 3.0.0-233~1417^2~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=316f57f966f162bfaac0aa9ad499451ea35cdd4a;p=thirdparty%2Fsnort3.git

help on plugins
---

diff --git a/src/main/help.cc b/src/main/help.cc
index fabf633a8..6d2f8b392 100644
--- a/src/main/help.cc
+++ b/src/main/help.cc
@@ -140,7 +140,7 @@ void help_signals(SnortConfig*, const char*)
 enum HelpType {
     HT_CFG, HT_CMD, HT_GID, HT_IPS, HT_MOD,
     HT_BUF, HT_LST, HT_PLG, HT_DDR, HT_DBR,
-    HT_SHO
+    HT_HMO, HT_HPL
 };
 
 static void show_help(SnortConfig* sc, const char* val, HelpType ht)
@@ -181,9 +181,12 @@ static void show_help(SnortConfig* sc, const char* val, HelpType ht)
     case HT_DBR:
         ModuleManager::dump_rules(val);
         break;
-    case HT_SHO:
+    case HT_HMO:
         ModuleManager::show_modules();
         break;
+    case HT_HPL:
+        PluginManager::show_plugins();
+        break;
     }
     ModuleManager::term();
     PluginManager::release_plugins();
@@ -228,7 +231,12 @@ void help_module(SnortConfig* sc, const char* val)
 
 void help_modules(SnortConfig* sc, const char* val)
 {
-    show_help(sc, val, HT_SHO);
+    show_help(sc, val, HT_HMO);
+}
+
+void help_plugins(SnortConfig* sc, const char* val)
+{
+    show_help(sc, val, HT_HPL);
 }
 
 void list_modules(SnortConfig* sc, const char* val)
diff --git a/src/main/help.h b/src/main/help.h
index 8853bac5c..d1d64d76c 100644
--- a/src/main/help.h
+++ b/src/main/help.h
@@ -37,6 +37,7 @@ void help_buffers(SnortConfig* sc, const char*);
 void help_builtin(SnortConfig* sc, const char*);
 void help_module(SnortConfig* sc, const char*);
 void help_modules(SnortConfig* sc, const char*);
+void help_plugins(SnortConfig* sc, const char*);
 void help_version(SnortConfig*, const char*);
 
 void list_modules(SnortConfig* sc, const char*);
diff --git a/src/main/snort_module.cc b/src/main/snort_module.cc
index 14c8a4e7e..6d5e775e2 100644
--- a/src/main/snort_module.cc
+++ b/src/main/snort_module.cc
@@ -258,7 +258,10 @@ static const Parameter s_params[] =
       "<module> output description of given module" },
 
     { "--help-modules", Parameter::PT_IMPLIED, nullptr, nullptr,
-      "list all modules with brief help" },
+      "list all available modules with brief help" },
+
+    { "--help-plugins", Parameter::PT_IMPLIED, nullptr, nullptr,
+      "list all available plugins with brief help" },
 
     { "--help-options", Parameter::PT_STRING, "(optional)", nullptr,
       "<option prefix> output matching command line option quick help" },
@@ -579,6 +582,9 @@ bool SnortModule::set(const char*, Value& v, SnortConfig* sc)
     else if ( v.is("--help-modules") )
         help_modules(sc, v.get_string());
 
+    else if ( v.is("--help-plugins") )
+        help_plugins(sc, v.get_string());
+
     else if ( v.is("--help-options") )
         help_options(sc, v.get_string());
 
diff --git a/src/managers/plugin_manager.cc b/src/managers/plugin_manager.cc
index ed8792937..7ac18a1d0 100644
--- a/src/managers/plugin_manager.cc
+++ b/src/managers/plugin_manager.cc
@@ -349,6 +349,17 @@ void PluginManager::list_plugins()
     }
 }
 
+void PluginManager::show_plugins()
+{
+    PlugMap::iterator it;
+
+    for ( it = plug_map.begin(); it != plug_map.end(); ++it )
+    {
+        Plugin& p = it->second;
+        cout << p.key << ": " << p.api->help << endl;
+    }
+}
+
 void PluginManager::dump_plugins()
 {
     DataManager::dump_plugins();
diff --git a/src/managers/plugin_manager.h b/src/managers/plugin_manager.h
index a9dc8da3d..801e2d2d8 100644
--- a/src/managers/plugin_manager.h
+++ b/src/managers/plugin_manager.h
@@ -47,6 +47,7 @@ public:
     // plugin methods
     static void load_plugins(const char* lib_paths);
     static void list_plugins();
+    static void show_plugins();
     static void dump_plugins();
     static void release_plugins();
     static const BaseApi* get_api(PlugType, const char* name);