Merge branch 'release/0.1beta'

Author: EvanK

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Evan Kaufman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -25,4 +25,22 @@ I wrote this mostly for fun and because it's been a while since I dabbled in the
 Licensing
 --
 This software is released as open source under the MIT license:
-http://www.opensource.org/licenses/mit-license.php
+    http://www.opensource.org/licenses/mit-license.php
+
+
+Usage Example
+--
+This is an example configuration that would insert an `X-Fortune` header to every successful request.
+    # if mod_header is enabled...
+    <IfModule mod_header.c>
+        # load and configure mod_fortune (default path but custom max length)
+        LoadModule fortune_module modules/mod_fortune.so
+        
+        <IfModule mod_fortune.c>
+            FortuneMaxLength 1000
+            #FortuneProgram /usr/games/fortune
+        </IfModule>
+        
+        # set X-Fortune header for successful response, if env variable exists
+        Header onsuccess set X-Fortune %{FORTUNE_COOKIE}e env=FORTUNE_COOKIE
+    </IfModule>

mod_fortune.c

@@ -23,8 +23,27 @@
 /*
  * Include the core server components.
  */
+
+#include <unistd.h>
+
+#include "apr_lib.h"
+
 #include "httpd.h"
 #include "http_config.h"
+#include "http_log.h"
+
+/*
+ * This module
+ */
+module AP_MODULE_DECLARE_DATA fortune_module;
+
+/*
+ * This modules per-server configuration structure.
+ */
+typedef struct {
+    const char *maxlen;
+    const char *binloc;
+} modfortune_config;
 
 /*
  * Remove trailing newline(s) from pipe output
@@ -42,23 +61,44 @@ static char* mod_fortune_chomp_output(char* str)
  */
 static int mod_fortune_method_handler (request_rec *r)
 {
-    // assuming short fortune to be 160 chars (plus null char)
-    char fortune_output[161];
-    FILE *fortune_pipe;
+    // Get the module configuration
+    modfortune_config* svr = ap_get_module_config(r->server->module_config, &fortune_module);
 
-    // invoke "fortune -s" in a subshell
-    char fortune_cmd[] = "/usr/games/fortune -s";
-    fortune_pipe = popen(fortune_cmd, "r");
-    // if opening pipe fails, write a message to stderr
-    if (fortune_pipe == NULL) {
-        fprintf(stderr,"apache2_mod_fortune: Failed to open a pipe to '%s'.\n", fortune_cmd);
+    // short circuit early if binloc isnt executable
+    if (access(svr->binloc, X_OK) < 0) {
+        // presumably binloc is the default value, and that binary simply doesnt exist or isnt executable
+        ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r, "mod_fortune: Failed to find or execute %s", svr->binloc);
     }
-    // otherwise funnel pipe's output into cstring and set as environment variable
     else {
-        // TODO: fgets cuts off @ first newline...need to keep reading until EOF
-        fgets(fortune_output, sizeof(fortune_output)-1, fortune_pipe);
-        pclose(fortune_pipe);
-        apr_table_set(r->subprocess_env, "FORTUNE_COOKIE", mod_fortune_chomp_output(fortune_output) );
+        // estimate size of fortune output from config directive (short circuit if maxlen is not positive int)
+        int maxlen = atoi(svr->maxlen);
+        char *fortune_output = (char *) malloc((maxlen + 1) * sizeof(char));
+        strcpy(fortune_output, "");
+        
+        // dynamically allocate fortune_cmd based on size of its pieces (from config directives)
+        char *fortune_cmd = (char *) malloc((strlen(svr->binloc) + strlen(svr->maxlen) + 10) * sizeof(char));
+        sprintf(fortune_cmd, "%s -n %s -s", svr->binloc, svr->maxlen);
+        
+        // invoke in a subshell
+        FILE *fortune_pipe;
+        fortune_pipe = popen(fortune_cmd, "r");
+        
+        // if opening pipe fails, log a warning
+        if (fortune_pipe == NULL) {
+            ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r, "mod_fortune: Failed to open pipe to %s", fortune_cmd);
+        }
+        // otherwise funnel pipe's output into cstring and set as environment variable
+        else {
+            int fortune_size = fread(fortune_output, sizeof(char), maxlen, fortune_pipe);
+            fortune_output[ fortune_size ] = '\0';
+            pclose(fortune_pipe);
+            ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r, "mod_fortune: Retrieved fortune of %d chars", (int)strlen(fortune_output));
+            apr_table_set(r->subprocess_env, "FORTUNE_COOKIE", mod_fortune_chomp_output(fortune_output) );
+        }
+        
+        // deallocate dynamic cstrings we no longer need
+        free(fortune_output);
+        free(fortune_cmd);
     }
 
     // Return DECLINED so that the Apache core will keep looking for
@@ -67,6 +107,75 @@ static int mod_fortune_method_handler (request_rec *r)
     return DECLINED;
 }
 
+/*
+ * Set the max length of fortunes to retrieve
+ */
+static const char * set_modfortune_maxlen(cmd_parms *parms, void *dummy, const char *arg)
+{
+    if (!apr_isdigit(arg[0]))
+        return "FortuneMaxLength: length must be numeric";
+    
+    if (atoi((char *)arg) < 1)
+        return "FortuneMaxLength: must be at least one character long";
+    
+    modfortune_config* svr = ap_get_module_config(parms->server->module_config, &fortune_module);
+    svr->maxlen = (char *) arg;
+    
+    return NULL;
+}
+
+/*
+ * Set the location of the executable fortune binary
+ */
+static const char * set_modfortune_binloc(cmd_parms *parms, void *dummy, const char *arg)
+{
+    char *binloc = (char *) arg;
+    
+    if (access(binloc, F_OK) < 0)
+        return "FortuneProgram: file must exist";
+    
+    if (access(binloc, X_OK) < 0)
+        return "FortuneProgram: file must be executable";
+    
+    modfortune_config* svr = ap_get_module_config(parms->server->module_config, &fortune_module);
+    svr->binloc = binloc;
+    
+    return NULL;
+}
+
+/**
+ * A declaration of the configuration directives that are supported by this module.
+ */
+static const command_rec mod_fortune_cmds[] =
+{
+    AP_INIT_TAKE1(
+        "FortuneMaxLength",
+        set_modfortune_maxlen,
+        NULL,
+        OR_ALL,//RSRC_CONF,
+        "FortuneMaxLength <integer> -- the maximum length in characters of fortune to retrieve."
+    ),
+    AP_INIT_TAKE1(
+        "FortuneProgram",
+        set_modfortune_binloc,
+        NULL,
+        OR_ALL,//RSRC_CONF,
+        "FortuneProgram <string> -- the location of the executable fortune binary."
+    ),
+    {NULL}
+};
+
+/**
+ * Creates the per-server configuration records.
+ */
+static void* create_modfortune_config(apr_pool_t* pool, server_rec* s) {
+    modfortune_config* svr = apr_pcalloc(pool, sizeof(modfortune_config));
+    /* Set up the default values for fields of svr */
+    svr->maxlen = "160";
+    svr->binloc = "/usr/games/fortune";
+    return svr ;
+}
+
 /*
  * This function is a callback and it declares what other functions
  * should be called for request processing and configuration requests.
@@ -85,9 +194,9 @@ module AP_MODULE_DECLARE_DATA fortune_module =
     STANDARD20_MODULE_STUFF,
     NULL,
     NULL,
+    create_modfortune_config,   /* Create config rec for host */
     NULL,
-    NULL,
-    NULL,
-    mod_fortune_register_hooks,            /* callback for registering hooks */
+    mod_fortune_cmds,           /* Configuration directives */
+    mod_fortune_register_hooks, /* Hook into APR API */
 };