embedded_c.c 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505
  1. /*
  2. * Copyright (c) 2013-2015 the CivetWeb developers
  3. * Copyright (c) 2013 No Face Press, LLC
  4. * License http://opensource.org/licenses/mit-license.php MIT License
  5. */
  6. /* Simple example program on how to use CivetWeb embedded into a C program. */
  7. #ifdef _WIN32
  8. #include <Windows.h>
  9. #else
  10. #include <unistd.h>
  11. #endif
  12. #include <stdlib.h>
  13. #include <string.h>
  14. #include "civetweb.h"
  15. #define DOCUMENT_ROOT "."
  16. #ifdef NO_SSL
  17. #ifdef USE_IPV6
  18. #define PORT "[::]:8888"
  19. #else
  20. #define PORT "8888"
  21. #endif
  22. #else
  23. #ifdef USE_IPV6
  24. #define PORT "[::]:8888r,[::]:8843s"
  25. #else
  26. #define PORT "8888r,8843s"
  27. #endif
  28. #endif
  29. #define EXAMPLE_URI "/example"
  30. #define EXIT_URI "/exit"
  31. int exitNow = 0;
  32. int
  33. ExampleHandler(struct mg_connection *conn, void *cbdata)
  34. {
  35. mg_printf(conn, "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n");
  36. mg_printf(conn, "<html><body>");
  37. mg_printf(conn, "<h2>This is an example text from a C handler</h2>");
  38. mg_printf(
  39. conn,
  40. "<p>To see a page from the A handler <a href=\"A\">click A</a></p>");
  41. mg_printf(conn,
  42. "<p>To see a page from the A handler <a href=\"A/A\">click "
  43. "A/A</a></p>");
  44. mg_printf(conn,
  45. "<p>To see a page from the A/B handler <a "
  46. "href=\"A/B\">click A/B</a></p>");
  47. mg_printf(conn,
  48. "<p>To see a page from the B handler (0) <a "
  49. "href=\"B\">click B</a></p>");
  50. mg_printf(conn,
  51. "<p>To see a page from the B handler (1) <a "
  52. "href=\"B/A\">click B/A</a></p>");
  53. mg_printf(conn,
  54. "<p>To see a page from the B handler (2) <a "
  55. "href=\"B/B\">click B/B</a></p>");
  56. mg_printf(conn,
  57. "<p>To see a page from the *.foo handler <a "
  58. "href=\"xy.foo\">click xy.foo</a></p>");
  59. mg_printf(conn,
  60. "<p>To see a page from the FileHandler handler <a "
  61. "href=\"form\">click form</a> (this is the form test page)</p>");
  62. #ifdef USE_WEBSOCKET
  63. mg_printf(conn,
  64. "<p>To test websocket handler <a href=\"/websocket\">click "
  65. "websocket</a></p>");
  66. #endif
  67. mg_printf(conn, "<p>To exit <a href=\"%s\">click exit</a></p>", EXIT_URI);
  68. mg_printf(conn, "</body></html>\n");
  69. return 1;
  70. }
  71. int
  72. ExitHandler(struct mg_connection *conn, void *cbdata)
  73. {
  74. mg_printf(conn, "HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\n\r\n");
  75. mg_printf(conn, "Server will shut down.\n");
  76. mg_printf(conn, "Bye!\n");
  77. exitNow = 1;
  78. return 1;
  79. }
  80. int
  81. AHandler(struct mg_connection *conn, void *cbdata)
  82. {
  83. mg_printf(conn, "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n");
  84. mg_printf(conn, "<html><body>");
  85. mg_printf(conn, "<h2>This is the A handler!!!</h2>");
  86. mg_printf(conn, "</body></html>\n");
  87. return 1;
  88. }
  89. int
  90. ABHandler(struct mg_connection *conn, void *cbdata)
  91. {
  92. mg_printf(conn, "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n");
  93. mg_printf(conn, "<html><body>");
  94. mg_printf(conn, "<h2>This is the AB handler!!!</h2>");
  95. mg_printf(conn, "</body></html>\n");
  96. return 1;
  97. }
  98. int
  99. BXHandler(struct mg_connection *conn, void *cbdata)
  100. {
  101. /* Handler may access the request info using mg_get_request_info */
  102. const struct mg_request_info *req_info = mg_get_request_info(conn);
  103. mg_printf(conn, "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n");
  104. mg_printf(conn, "<html><body>");
  105. mg_printf(conn, "<h2>This is the BX handler %p!!!</h2>", cbdata);
  106. mg_printf(conn, "<p>The actual uri is %s</p>", req_info->uri);
  107. mg_printf(conn, "</body></html>\n");
  108. return 1;
  109. }
  110. int
  111. FooHandler(struct mg_connection *conn, void *cbdata)
  112. {
  113. /* Handler may access the request info using mg_get_request_info */
  114. const struct mg_request_info *req_info = mg_get_request_info(conn);
  115. mg_printf(conn, "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n");
  116. mg_printf(conn, "<html><body>");
  117. mg_printf(conn, "<h2>This is the Foo handler!!!</h2>");
  118. mg_printf(conn,
  119. "<p>The request was:<br><pre>%s %s HTTP/%s</pre></p>",
  120. req_info->request_method,
  121. req_info->uri,
  122. req_info->http_version);
  123. mg_printf(conn, "</body></html>\n");
  124. return 1;
  125. }
  126. int
  127. FileHandler(struct mg_connection *conn, void *cbdata)
  128. {
  129. /* In this handler, we ignore the req_info and send the file "fileName". */
  130. const char *fileName = (const char *)cbdata;
  131. mg_send_file(conn, fileName);
  132. return 1;
  133. }
  134. int
  135. FormHandler(struct mg_connection *conn, void *cbdata)
  136. {
  137. /* Handler may access the request info using mg_get_request_info */
  138. const struct mg_request_info *req_info = mg_get_request_info(conn);
  139. int ret;
  140. struct mg_form_data_handler *fdh = 0;
  141. /* TODO: Checks before calling handle_form_data ? */
  142. (void)req_info;
  143. ret = handle_form_data(conn, fdh);
  144. return 1;
  145. }
  146. int
  147. WebSocketStartHandler(struct mg_connection *conn, void *cbdata)
  148. {
  149. mg_printf(conn, "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n");
  150. mg_printf(conn, "<!DOCTYPE html>\n");
  151. mg_printf(conn, "<html>\n<head>\n");
  152. mg_printf(conn, "<meta charset=\"UTF-8\">\n");
  153. mg_printf(conn, "<title>Embedded websocket example</title>\n");
  154. #ifdef USE_WEBSOCKET
  155. /* mg_printf(conn, "<script type=\"text/javascript\"><![CDATA[\n"); ...
  156. * xhtml style */
  157. mg_printf(conn, "<script>\n");
  158. mg_printf(
  159. conn,
  160. "function load() {\n"
  161. " var wsproto = (location.protocol === 'https:') ? 'wss:' : 'ws:';\n"
  162. " connection = new WebSocket(wsproto + '//' + window.location.host + "
  163. "'/websocket');\n"
  164. " websock_text_field = "
  165. "document.getElementById('websock_text_field');\n"
  166. " connection.onmessage = function (e) {\n"
  167. " websock_text_field.innerHTML=e.data;\n"
  168. " }\n"
  169. " connection.onerror = function (error) {\n"
  170. " alert('WebSocket error');\n"
  171. " connection.close();\n"
  172. " }\n"
  173. "}\n");
  174. /* mg_printf(conn, "]]></script>\n"); ... xhtml style */
  175. mg_printf(conn, "</script>\n");
  176. mg_printf(conn, "</head>\n<body onload=\"load()\">\n");
  177. mg_printf(
  178. conn,
  179. "<div id='websock_text_field'>No websocket connection yet</div>\n");
  180. #else
  181. mg_printf(conn, "</head>\n<body>\n");
  182. mg_printf(conn, "Example not compiled with USE_WEBSOCKET\n");
  183. #endif
  184. mg_printf(conn, "</body>\n</html>\n");
  185. return 1;
  186. }
  187. #ifdef USE_WEBSOCKET
  188. /* MAX_WS_CLIENTS defines how many clients can connect to a websocket at the
  189. * same time. The value 5 is very small and used here only for demonstration;
  190. * it can be easily tested to connect more than MAX_WS_CLIENTS clients.
  191. * A real server should use a much higher number, or better use a dynamic list
  192. * of currently connected websocket clients. */
  193. #define MAX_WS_CLIENTS (5)
  194. struct t_ws_client {
  195. struct mg_connection *conn;
  196. int state;
  197. } static ws_clients[MAX_WS_CLIENTS];
  198. #define ASSERT(x) \
  199. { \
  200. if (!(x)) { \
  201. fprintf(stderr, \
  202. "Assertion failed in line %u\n", \
  203. (unsigned)__LINE__); \
  204. } \
  205. }
  206. int
  207. WebSocketConnectHandler(const struct mg_connection *conn, void *cbdata)
  208. {
  209. struct mg_context *ctx = mg_get_context(conn);
  210. int reject = 1;
  211. int i;
  212. mg_lock_context(ctx);
  213. for (i = 0; i < MAX_WS_CLIENTS; i++) {
  214. if (ws_clients[i].conn == NULL) {
  215. ws_clients[i].conn = (struct mg_connection *)conn;
  216. ws_clients[i].state = 1;
  217. mg_set_user_connection_data(conn, (void *)(ws_clients + i));
  218. reject = 0;
  219. break;
  220. }
  221. }
  222. mg_unlock_context(ctx);
  223. fprintf(stdout,
  224. "Websocket client %s\r\n\r\n",
  225. (reject ? "rejected" : "accepted"));
  226. return reject;
  227. }
  228. void
  229. WebSocketReadyHandler(struct mg_connection *conn, void *cbdata)
  230. {
  231. const char *text = "Hello from the websocket ready handler";
  232. struct t_ws_client *client = mg_get_user_connection_data(conn);
  233. mg_websocket_write(conn, WEBSOCKET_OPCODE_TEXT, text, strlen(text));
  234. fprintf(stdout, "Greeting message sent to websocket client\r\n\r\n");
  235. ASSERT(client->conn == conn);
  236. ASSERT(client->state == 1);
  237. client->state = 2;
  238. }
  239. int
  240. WebsocketDataHandler(struct mg_connection *conn,
  241. int bits,
  242. char *data,
  243. size_t len,
  244. void *cbdata)
  245. {
  246. struct t_ws_client *client = mg_get_user_connection_data(conn);
  247. ASSERT(client->conn == conn);
  248. ASSERT(client->state >= 1);
  249. fprintf(stdout, "Websocket got data:\r\n");
  250. fwrite(data, len, 1, stdout);
  251. fprintf(stdout, "\r\n\r\n");
  252. return 1;
  253. }
  254. void
  255. WebSocketCloseHandler(const struct mg_connection *conn, void *cbdata)
  256. {
  257. struct mg_context *ctx = mg_get_context(conn);
  258. struct t_ws_client *client = mg_get_user_connection_data(conn);
  259. ASSERT(client->conn == conn);
  260. ASSERT(client->state >= 1);
  261. mg_lock_context(ctx);
  262. client->state = 0;
  263. client->conn = NULL;
  264. mg_unlock_context(ctx);
  265. fprintf(stdout,
  266. "Client droped from the set of webserver connections\r\n\r\n");
  267. }
  268. void
  269. InformWebsockets(struct mg_context *ctx)
  270. {
  271. static unsigned long cnt = 0;
  272. char text[32];
  273. int i;
  274. sprintf(text, "%lu", ++cnt);
  275. mg_lock_context(ctx);
  276. for (i = 0; i < MAX_WS_CLIENTS; i++) {
  277. if (ws_clients[i].state == 2) {
  278. mg_websocket_write(ws_clients[i].conn,
  279. WEBSOCKET_OPCODE_TEXT,
  280. text,
  281. strlen(text));
  282. }
  283. }
  284. mg_unlock_context(ctx);
  285. }
  286. #endif
  287. int
  288. main(int argc, char *argv[])
  289. {
  290. const char *options[] = {"document_root",
  291. DOCUMENT_ROOT,
  292. "listening_ports",
  293. PORT,
  294. "request_timeout_ms",
  295. "10000",
  296. "error_log_file",
  297. "error.log",
  298. #ifdef USE_WEBSOCKET
  299. "websocket_timeout_ms",
  300. "3600000",
  301. #endif
  302. #ifndef NO_SSL
  303. "ssl_certificate",
  304. "../../resources/cert/server.pem",
  305. #endif
  306. 0};
  307. struct mg_callbacks callbacks;
  308. struct mg_context *ctx;
  309. struct mg_server_ports ports[32];
  310. int port_cnt, n;
  311. int err = 0;
  312. /* Check if libcivetweb has been built with all required features. */
  313. #ifdef USE_IPV6
  314. if (!mg_check_feature(8)) {
  315. fprintf(stderr,
  316. "Error: Embedded example built with IPv6 support, "
  317. "but civetweb library build without.\n");
  318. err = 1;
  319. }
  320. #endif
  321. #ifdef USE_WEBSOCKET
  322. if (!mg_check_feature(16)) {
  323. fprintf(stderr,
  324. "Error: Embedded example built with websocket support, "
  325. "but civetweb library build without.\n");
  326. err = 1;
  327. }
  328. #endif
  329. #ifndef NO_SSL
  330. if (!mg_check_feature(2)) {
  331. fprintf(stderr,
  332. "Error: Embedded example built with SSL support, "
  333. "but civetweb library build without.\n");
  334. err = 1;
  335. }
  336. #endif
  337. if (err) {
  338. fprintf(stderr, "Cannot start CivetWeb - inconsistent build.\n");
  339. return EXIT_FAILURE;
  340. }
  341. /* Start CivetWeb web server */
  342. memset(&callbacks, 0, sizeof(callbacks));
  343. ctx = mg_start(&callbacks, 0, options);
  344. /* Add handler EXAMPLE_URI, to explain the example */
  345. mg_set_request_handler(ctx, EXAMPLE_URI, ExampleHandler, 0);
  346. mg_set_request_handler(ctx, EXIT_URI, ExitHandler, 0);
  347. /* Add handler for /A* and special handler for /A/B */
  348. mg_set_request_handler(ctx, "/A", AHandler, 0);
  349. mg_set_request_handler(ctx, "/A/B", ABHandler, 0);
  350. /* Add handler for /B, /B/A, /B/B but not for /B* */
  351. mg_set_request_handler(ctx, "/B$", BXHandler, (void *)0);
  352. mg_set_request_handler(ctx, "/B/A$", BXHandler, (void *)1);
  353. mg_set_request_handler(ctx, "/B/B$", BXHandler, (void *)2);
  354. /* Add handler for all files with .foo extention */
  355. mg_set_request_handler(ctx, "**.foo$", FooHandler, 0);
  356. /* Add handler for /form (serve a file outside the document root) */
  357. mg_set_request_handler(ctx,
  358. "/form",
  359. FileHandler,
  360. (void *)"../../test/form.html");
  361. /* Add handler for form data */
  362. mg_set_request_handler(ctx,
  363. "/handle_form.embedded_c.example.callback",
  364. FormHandler,
  365. (void *)0);
  366. /* Add HTTP site to open a websocket connection */
  367. mg_set_request_handler(ctx, "/websocket", WebSocketStartHandler, 0);
  368. #ifdef USE_WEBSOCKET
  369. /* WS site for the websocket connection */
  370. mg_set_websocket_handler(ctx,
  371. "/websocket",
  372. WebSocketConnectHandler,
  373. WebSocketReadyHandler,
  374. WebsocketDataHandler,
  375. WebSocketCloseHandler,
  376. 0);
  377. #endif
  378. /* List all listening ports */
  379. memset(ports, 0, sizeof(ports));
  380. port_cnt = mg_get_server_ports(ctx, 32, ports);
  381. printf("\n%i listening ports:\n\n", port_cnt);
  382. for (n = 0; n < port_cnt && n < 32; n++) {
  383. const char *proto = ports[n].is_ssl ? "https" : "http";
  384. const char *host;
  385. if ((ports[n].protocol & 1) == 1) {
  386. /* IPv4 */
  387. host = "127.0.0.1";
  388. printf("Browse files at %s://%s:%i/\n", proto, host, ports[n].port);
  389. printf("Run example at %s://%s:%i%s\n",
  390. proto,
  391. host,
  392. ports[n].port,
  393. EXAMPLE_URI);
  394. printf(
  395. "Exit at %s://%s:%i%s\n", proto, host, ports[n].port, EXIT_URI);
  396. printf("\n");
  397. }
  398. if ((ports[n].protocol & 2) == 2) {
  399. /* IPv6 */
  400. host = "[::1]";
  401. printf("Browse files at %s://%s:%i/\n", proto, host, ports[n].port);
  402. printf("Run example at %s://%s:%i%s\n",
  403. proto,
  404. host,
  405. ports[n].port,
  406. EXAMPLE_URI);
  407. printf(
  408. "Exit at %s://%s:%i%s\n", proto, host, ports[n].port, EXIT_URI);
  409. printf("\n");
  410. }
  411. }
  412. /* Wait until the server should be closed */
  413. while (!exitNow) {
  414. #ifdef _WIN32
  415. Sleep(1000);
  416. #else
  417. sleep(1);
  418. #endif
  419. #ifdef USE_WEBSOCKET
  420. InformWebsockets(ctx);
  421. #endif
  422. }
  423. /* Stop the server */
  424. mg_stop(ctx);
  425. printf("Server stopped.\n");
  426. printf("Bye!\n");
  427. return EXIT_SUCCESS;
  428. }