handler_example.c

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2
   3 /* Cherokee
   4  *
   5  * Authors:
   6  *      Alvaro Lopez Ortega <alvaro@alobbs.com>
   7  *      Stefan de Konink <stefan@konink.de>
   8  *
   9  * Copyright (C) 2001-2008 Alvaro Lopez Ortega
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of version 2 of the GNU General Public
  13  * License as published by the Free Software Foundation.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  23  * USA
  24  */
  25
  26 #include "handler_example.h"
  27 #include <cherokee/cherokee.h>
  28
  29 /*
  30 #include "util.h"
  31 #include "connection.h"
  32 #include "connection-protected.h"
  33 #include "server.h"
  34 #include "server-protected.h"
  35 #include "plugin_loader.h"
  36 #include "connection_info.h"
  37 */
  38
  39 /* Plug-in initialization
  40  *
  41  * In this function you can use any of these:
  42  * http_delete | http_get | http_post | http_put
  43  *
  44  * For a full list: cherokee_http_method_t
  45  *
  46  * It is what your handler to be implements.
  47  *
  48  */
  49 PLUGIN_INFO_HANDLER_EASIEST_INIT (example, http_get);
  50
  51
  52 /* Methods implementation
  53  */
  54 static ret_t
  55 props_free (cherokee_handler_example_props_t *props)
  56 {
  57         return cherokee_module_props_free_base (MODULE_PROPS(props));
  58 }
  59
  60
  61 ret_t
  62 cherokee_handler_example_configure (cherokee_config_node_t *conf, cherokee_server_t *srv, cherokee_module_props_t **_props)
  63 {
  64         cherokee_list_t                      *i;
  65         cherokee_handler_example_props_t *props;
  66
  67         if (*_props == NULL) {
  68                 CHEROKEE_NEW_STRUCT (n, handler_example_props);
  69
  70                 cherokee_module_props_init_base (MODULE_PROPS(n),
  71                                                  MODULE_PROPS_FREE(props_free));
  72
  73         /* Look at handler_example.h
  74          * This is an example of configuration.
  75          */
  76                 n->example_config = false;
  77
  78                 *_props = MODULE_PROPS(n);
  79         }
  80
  81         props = PROP_EXAMPLE(*_props);
  82
  83         cherokee_config_node_foreach (i, conf) {
  84                 cherokee_config_node_t *subconf = CONFIG_NODE(i);
  85
  86                 if (equal_buf_str (&subconf->key, "example_config")) {
  87                         props->example_config = atoi(subconf->val.buf);
  88                 } else {
  89                         PRINT_MSG ("ERROR: Handler file: Unknown key: '%s'\n", subconf->key.buf);
  90                         return ret_error;
  91                 }
  92         }
  93
  94         return ret_ok;
  95 }
  96
  97 ret_t
  98 cherokee_handler_example_new  (cherokee_handler_t **hdl, cherokee_connection_t *cnt, cherokee_module_props_t *props)
  99 {
 100         ret_t ret;
 101         CHEROKEE_NEW_STRUCT (n, handler_example);
 102
 103         /* Init the base class object
 104          */
 105         cherokee_handler_init_base(HANDLER(n), cnt, HANDLER_PROPS(props), PLUGIN_INFO_HANDLER_PTR(example));
 106
 107         MODULE(n)->init         = (handler_func_init_t) cherokee_handler_example_init;
 108         MODULE(n)->free         = (module_func_free_t) cherokee_handler_example_free;
 109         HANDLER(n)->step        = (handler_func_step_t) cherokee_handler_example_step;
 110         HANDLER(n)->add_headers = (handler_func_add_headers_t) cherokee_handler_example_add_headers;
 111
 112         HANDLER(n)->support = hsupport_length | hsupport_range;
 113
 114         /* Init
 115          */
 116         ret = cherokee_buffer_init (&n->buffer);
 117         if (unlikely(ret != ret_ok))
 118                 return ret;
 119
 120         ret = cherokee_buffer_ensure_size (&n->buffer, 4*1024);
 121         if (unlikely(ret != ret_ok))
 122                 return ret;
 123
 124         *hdl = HANDLER(n);
 125         return ret_ok;
 126 }
 127
 128
 129 ret_t
 130 cherokee_handler_example_free (cherokee_handler_example_t *hdl)
 131 {
 132         cherokee_buffer_mrproper (&hdl->buffer);
 133         return ret_ok;
 134 }
 135
 136 static void
 137 example_build_page (cherokee_handler_example_t *hdl)
 138 {
 139     ret_t              ret;
 140     cherokee_server_t *srv;
 141     cherokee_buffer_t *buf;
 142
 143     /* Init
 144      */
 145     buf = &hdl->buffer;
 146     srv = HANDLER_SRV(hdl);
 147
 148     /* Useful output
 149      */
 150     cherokee_buffer_add_str (buf, "Hello World");
 151
 152     /* But we did configure something!
 153      */
 154     if (HDL_EXAMPLE_PROPS(hdl)->example_config) {
 155         cherokee_buffer_add_str (buf, "!!!");
 156     }
 157 }
 158
 159 ret_t
 160 cherokee_handler_example_init (cherokee_handler_example_t *hdl)
 161 {
 162         ret_t   ret;
 163         void   *param;
 164         cint_t  web_interface = 1;
 165
 166         /* Build the page
 167          */
 168         if (web_interface) {
 169                 example_build_page (hdl);
 170         }
 171
 172         hdl->action = send_page;
 173
 174         return ret_ok;
 175 }
 176
 177
 178 ret_t
 179 cherokee_handler_example_step (cherokee_handler_example_t *hdl, cherokee_buffer_t *buffer)
 180 {
 181         cherokee_buffer_add_buffer (buffer, &hdl->buffer);
 182         return ret_eof_have_data;
 183 }
 184
 185
 186 ret_t
 187 cherokee_handler_example_add_headers (cherokee_handler_example_t *hdl, cherokee_buffer_t *buffer)
 188 {
 189         cherokee_buffer_add_va (buffer, "Content-Length: %d"CRLF, hdl->buffer.len);
 190
 191         switch (hdl->action) {
 192         case send_page:
 193         default:
 194                 cherokee_buffer_add_str (buffer, "Content-Type: text/html"CRLF);
 195                     break;
 196         }
 197
 198         return ret_ok;
 199 }