src/plugins/http_static/http_static.c

   1 /*
   2  * Copyright (c) 2017-2022 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #include <vnet/vnet.h>
  17 #include <vnet/plugin/plugin.h>
  18 #include <http_static/http_static.h>
  19
  20 #include <vlibapi/api.h>
  21 #include <vlibmemory/api.h>
  22 #include <vpp/app/version.h>
  23
  24 /* define message IDs */
  25 #include <http_static/http_static.api_enum.h>
  26 #include <http_static/http_static.api_types.h>
  27
  28 #include <vpp/api/types.h>
  29
  30 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
  31
  32 #define REPLY_MSG_ID_BASE hsm->msg_id_base
  33 #include <vlibapi/api_helper_macros.h>
  34
  35 __clib_export void
  36 hss_register_url_handler (hss_url_handler_fn fp, const char *url,
  37                           http_req_method_t request_type)
  38 {
  39   hss_main_t *hsm = &hss_main;
  40   uword *p, *url_table;
  41
  42   url_table = (request_type == HTTP_REQ_GET) ? hsm->get_url_handlers :
  43                                                hsm->post_url_handlers;
  44
  45   p = hash_get_mem (url_table, url);
  46
  47   if (p)
  48     {
  49       clib_warning ("WARNING: attempt to replace handler for %s '%s' ignored",
  50                     (request_type == HTTP_REQ_GET) ? "GET" : "POST", url);
  51       return;
  52     }
  53
  54   hash_set_mem (url_table, url, (uword) fp);
  55
  56   /*
  57    * Need to update the hash table pointer in http_static_server_main
  58    * in case we just expanded it...
  59    */
  60   if (request_type == HTTP_REQ_GET)
  61     hsm->get_url_handlers = url_table;
  62   else
  63     hsm->post_url_handlers = url_table;
  64 }
  65
  66 /** \brief API helper function for vl_api_http_static_enable_t messages
  67  */
  68 static int
  69 hss_enable_api (u32 fifo_size, u32 cache_limit, u32 prealloc_fifos,
  70                 u32 private_segment_size, u8 *www_root, u8 *uri)
  71 {
  72   hss_main_t *hsm = &hss_main;
  73   int rv;
  74
  75   hsm->fifo_size = fifo_size;
  76   hsm->cache_size = cache_limit;
  77   hsm->prealloc_fifos = prealloc_fifos;
  78   hsm->private_segment_size = private_segment_size;
  79   hsm->www_root = format (0, "%s%c", www_root, 0);
  80   hsm->uri = format (0, "%s%c", uri, 0);
  81
  82   if (vec_len (hsm->www_root) < 2)
  83     return VNET_API_ERROR_INVALID_VALUE;
  84
  85   if (hsm->app_index != ~0)
  86     return VNET_API_ERROR_APP_ALREADY_ATTACHED;
  87
  88   vnet_session_enable_disable (hsm->vlib_main, 1 /* turn on TCP, etc. */);
  89
  90   rv = hss_create (hsm->vlib_main);
  91   switch (rv)
  92     {
  93     case 0:
  94       break;
  95     default:
  96       vec_free (hsm->www_root);
  97       vec_free (hsm->uri);
  98       return VNET_API_ERROR_INIT_FAILED;
  99     }
 100   return 0;
 101 }
 102
 103 /* API message handler */
 104 static void vl_api_http_static_enable_t_handler
 105   (vl_api_http_static_enable_t * mp)
 106 {
 107   vl_api_http_static_enable_reply_t *rmp;
 108   hss_main_t *hsm = &hss_main;
 109   int rv;
 110
 111   mp->uri[ARRAY_LEN (mp->uri) - 1] = 0;
 112   mp->www_root[ARRAY_LEN (mp->www_root) - 1] = 0;
 113
 114   rv =
 115     hss_enable_api (ntohl (mp->fifo_size), ntohl (mp->cache_size_limit),
 116                     ntohl (mp->prealloc_fifos),
 117                     ntohl (mp->private_segment_size), mp->www_root, mp->uri);
 118
 119   REPLY_MACRO (VL_API_HTTP_STATIC_ENABLE_REPLY);
 120 }
 121
 122 #include <http_static/http_static.api.c>
 123 static clib_error_t *
 124 hss_api_init (vlib_main_t *vm)
 125 {
 126   hss_main_t *hsm = &hss_main;
 127
 128   /* Ask for a correctly-sized block of API message decode slots */
 129   hsm->msg_id_base = setup_message_id_table ();
 130
 131   return 0;
 132 }
 133
 134 VLIB_INIT_FUNCTION (hss_api_init);
 135
 136 VLIB_PLUGIN_REGISTER () =
 137 {
 138   .version = VPP_BUILD_VER,
 139   .description = "HTTP Static Server"
 140 };
 141
 142 /*
 143  * fd.io coding-style-patch-verification: ON
 144  *
 145  * Local Variables:
 146  * eval: (c-set-style "gnu")
 147  * End:
 148  */