embedded_c.c 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542
  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,8884"
  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. struct mg_form_data_handler {
  135. int (*field_found)(const char *key,
  136. size_t keylen,
  137. const char *value,
  138. size_t vallen,
  139. void *user_data);
  140. int (*file_found)(const char *key,
  141. size_t keylen,
  142. const char *filename,
  143. int *disposition,
  144. void *user_data);
  145. void *user_data;
  146. };
  147. int
  148. field_found(const char *key,
  149. size_t keylen,
  150. const char *value,
  151. size_t vallen,
  152. void *user_data)
  153. {
  154. struct mg_connection *conn = (struct mg_connection *)user_data;
  155. mg_write(conn, key, keylen);
  156. mg_printf(conn, " = ");
  157. mg_write(conn, value, vallen);
  158. mg_printf(conn, "\r\n");
  159. return 0;
  160. }
  161. int
  162. FormHandler(struct mg_connection *conn, void *cbdata)
  163. {
  164. /* Handler may access the request info using mg_get_request_info */
  165. const struct mg_request_info *req_info = mg_get_request_info(conn);
  166. int ret;
  167. struct mg_form_data_handler fdh = {field_found, 0, 0};
  168. /* TODO: Checks before calling handle_form_data ? */
  169. (void)req_info;
  170. mg_printf(conn, "HTTP/1.0 200 OK\r\nContent-Type: text/plain\r\n\r\n");
  171. fdh.user_data = (void *)conn;
  172. /* TODO: Handle the return value */
  173. ret = mg_handle_form_data(conn, &fdh);
  174. return 1;
  175. }
  176. int
  177. WebSocketStartHandler(struct mg_connection *conn, void *cbdata)
  178. {
  179. mg_printf(conn, "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n");
  180. mg_printf(conn, "<!DOCTYPE html>\n");
  181. mg_printf(conn, "<html>\n<head>\n");
  182. mg_printf(conn, "<meta charset=\"UTF-8\">\n");
  183. mg_printf(conn, "<title>Embedded websocket example</title>\n");
  184. #ifdef USE_WEBSOCKET
  185. /* mg_printf(conn, "<script type=\"text/javascript\"><![CDATA[\n"); ...
  186. * xhtml style */
  187. mg_printf(conn, "<script>\n");
  188. mg_printf(
  189. conn,
  190. "function load() {\n"
  191. " var wsproto = (location.protocol === 'https:') ? 'wss:' : 'ws:';\n"
  192. " connection = new WebSocket(wsproto + '//' + window.location.host + "
  193. "'/websocket');\n"
  194. " websock_text_field = "
  195. "document.getElementById('websock_text_field');\n"
  196. " connection.onmessage = function (e) {\n"
  197. " websock_text_field.innerHTML=e.data;\n"
  198. " }\n"
  199. " connection.onerror = function (error) {\n"
  200. " alert('WebSocket error');\n"
  201. " connection.close();\n"
  202. " }\n"
  203. "}\n");
  204. /* mg_printf(conn, "]]></script>\n"); ... xhtml style */
  205. mg_printf(conn, "</script>\n");
  206. mg_printf(conn, "</head>\n<body onload=\"load()\">\n");
  207. mg_printf(
  208. conn,
  209. "<div id='websock_text_field'>No websocket connection yet</div>\n");
  210. #else
  211. mg_printf(conn, "</head>\n<body>\n");
  212. mg_printf(conn, "Example not compiled with USE_WEBSOCKET\n");
  213. #endif
  214. mg_printf(conn, "</body>\n</html>\n");
  215. return 1;
  216. }
  217. #ifdef USE_WEBSOCKET
  218. /* MAX_WS_CLIENTS defines how many clients can connect to a websocket at the
  219. * same time. The value 5 is very small and used here only for demonstration;
  220. * it can be easily tested to connect more than MAX_WS_CLIENTS clients.
  221. * A real server should use a much higher number, or better use a dynamic list
  222. * of currently connected websocket clients. */
  223. #define MAX_WS_CLIENTS (5)
  224. struct t_ws_client {
  225. struct mg_connection *conn;
  226. int state;
  227. } static ws_clients[MAX_WS_CLIENTS];
  228. #define ASSERT(x) \
  229. { \
  230. if (!(x)) { \
  231. fprintf(stderr, \
  232. "Assertion failed in line %u\n", \
  233. (unsigned)__LINE__); \
  234. } \
  235. }
  236. int
  237. WebSocketConnectHandler(const struct mg_connection *conn, void *cbdata)
  238. {
  239. struct mg_context *ctx = mg_get_context(conn);
  240. int reject = 1;
  241. int i;
  242. mg_lock_context(ctx);
  243. for (i = 0; i < MAX_WS_CLIENTS; i++) {
  244. if (ws_clients[i].conn == NULL) {
  245. ws_clients[i].conn = (struct mg_connection *)conn;
  246. ws_clients[i].state = 1;
  247. mg_set_user_connection_data(conn, (void *)(ws_clients + i));
  248. reject = 0;
  249. break;
  250. }
  251. }
  252. mg_unlock_context(ctx);
  253. fprintf(stdout,
  254. "Websocket client %s\r\n\r\n",
  255. (reject ? "rejected" : "accepted"));
  256. return reject;
  257. }
  258. void
  259. WebSocketReadyHandler(struct mg_connection *conn, void *cbdata)
  260. {
  261. const char *text = "Hello from the websocket ready handler";
  262. struct t_ws_client *client = mg_get_user_connection_data(conn);
  263. mg_websocket_write(conn, WEBSOCKET_OPCODE_TEXT, text, strlen(text));
  264. fprintf(stdout, "Greeting message sent to websocket client\r\n\r\n");
  265. ASSERT(client->conn == conn);
  266. ASSERT(client->state == 1);
  267. client->state = 2;
  268. }
  269. int
  270. WebsocketDataHandler(struct mg_connection *conn,
  271. int bits,
  272. char *data,
  273. size_t len,
  274. void *cbdata)
  275. {
  276. struct t_ws_client *client = mg_get_user_connection_data(conn);
  277. ASSERT(client->conn == conn);
  278. ASSERT(client->state >= 1);
  279. fprintf(stdout, "Websocket got data:\r\n");
  280. fwrite(data, len, 1, stdout);
  281. fprintf(stdout, "\r\n\r\n");
  282. return 1;
  283. }
  284. void
  285. WebSocketCloseHandler(const struct mg_connection *conn, void *cbdata)
  286. {
  287. struct mg_context *ctx = mg_get_context(conn);
  288. struct t_ws_client *client = mg_get_user_connection_data(conn);
  289. ASSERT(client->conn == conn);
  290. ASSERT(client->state >= 1);
  291. mg_lock_context(ctx);
  292. client->state = 0;
  293. client->conn = NULL;
  294. mg_unlock_context(ctx);
  295. fprintf(stdout,
  296. "Client droped from the set of webserver connections\r\n\r\n");
  297. }
  298. void
  299. InformWebsockets(struct mg_context *ctx)
  300. {
  301. static unsigned long cnt = 0;
  302. char text[32];
  303. int i;
  304. sprintf(text, "%lu", ++cnt);
  305. mg_lock_context(ctx);
  306. for (i = 0; i < MAX_WS_CLIENTS; i++) {
  307. if (ws_clients[i].state == 2) {
  308. mg_websocket_write(ws_clients[i].conn,
  309. WEBSOCKET_OPCODE_TEXT,
  310. text,
  311. strlen(text));
  312. }
  313. }
  314. mg_unlock_context(ctx);
  315. }
  316. #endif
  317. int
  318. main(int argc, char *argv[])
  319. {
  320. const char *options[] = {"document_root",
  321. DOCUMENT_ROOT,
  322. "listening_ports",
  323. PORT,
  324. "request_timeout_ms",
  325. "10000",
  326. "error_log_file",
  327. "error.log",
  328. #ifdef USE_WEBSOCKET
  329. "websocket_timeout_ms",
  330. "3600000",
  331. #endif
  332. #ifndef NO_SSL
  333. "ssl_certificate",
  334. "../../resources/cert/server.pem",
  335. #endif
  336. 0};
  337. struct mg_callbacks callbacks;
  338. struct mg_context *ctx;
  339. struct mg_server_ports ports[32];
  340. int port_cnt, n;
  341. int err = 0;
  342. /* Check if libcivetweb has been built with all required features. */
  343. #ifdef USE_IPV6
  344. if (!mg_check_feature(8)) {
  345. fprintf(stderr,
  346. "Error: Embedded example built with IPv6 support, "
  347. "but civetweb library build without.\n");
  348. err = 1;
  349. }
  350. #endif
  351. #ifdef USE_WEBSOCKET
  352. if (!mg_check_feature(16)) {
  353. fprintf(stderr,
  354. "Error: Embedded example built with websocket support, "
  355. "but civetweb library build without.\n");
  356. err = 1;
  357. }
  358. #endif
  359. #ifndef NO_SSL
  360. if (!mg_check_feature(2)) {
  361. fprintf(stderr,
  362. "Error: Embedded example built with SSL support, "
  363. "but civetweb library build without.\n");
  364. err = 1;
  365. }
  366. #endif
  367. if (err) {
  368. fprintf(stderr, "Cannot start CivetWeb - inconsistent build.\n");
  369. return EXIT_FAILURE;
  370. }
  371. /* Start CivetWeb web server */
  372. memset(&callbacks, 0, sizeof(callbacks));
  373. ctx = mg_start(&callbacks, 0, options);
  374. /* Add handler EXAMPLE_URI, to explain the example */
  375. mg_set_request_handler(ctx, EXAMPLE_URI, ExampleHandler, 0);
  376. mg_set_request_handler(ctx, EXIT_URI, ExitHandler, 0);
  377. /* Add handler for /A* and special handler for /A/B */
  378. mg_set_request_handler(ctx, "/A", AHandler, 0);
  379. mg_set_request_handler(ctx, "/A/B", ABHandler, 0);
  380. /* Add handler for /B, /B/A, /B/B but not for /B* */
  381. mg_set_request_handler(ctx, "/B$", BXHandler, (void *)0);
  382. mg_set_request_handler(ctx, "/B/A$", BXHandler, (void *)1);
  383. mg_set_request_handler(ctx, "/B/B$", BXHandler, (void *)2);
  384. /* Add handler for all files with .foo extention */
  385. mg_set_request_handler(ctx, "**.foo$", FooHandler, 0);
  386. /* Add handler for /form (serve a file outside the document root) */
  387. mg_set_request_handler(ctx,
  388. "/form",
  389. FileHandler,
  390. (void *)"../../test/form.html");
  391. /* Add handler for form data */
  392. mg_set_request_handler(ctx,
  393. "/handle_form.embedded_c.example.callback",
  394. FormHandler,
  395. (void *)0);
  396. /* Add HTTP site to open a websocket connection */
  397. mg_set_request_handler(ctx, "/websocket", WebSocketStartHandler, 0);
  398. #ifdef USE_WEBSOCKET
  399. /* WS site for the websocket connection */
  400. mg_set_websocket_handler(ctx,
  401. "/websocket",
  402. WebSocketConnectHandler,
  403. WebSocketReadyHandler,
  404. WebsocketDataHandler,
  405. WebSocketCloseHandler,
  406. 0);
  407. #endif
  408. /* List all listening ports */
  409. memset(ports, 0, sizeof(ports));
  410. port_cnt = mg_get_server_ports(ctx, 32, ports);
  411. printf("\n%i listening ports:\n\n", port_cnt);
  412. for (n = 0; n < port_cnt && n < 32; n++) {
  413. const char *proto = ports[n].is_ssl ? "https" : "http";
  414. const char *host;
  415. if ((ports[n].protocol & 1) == 1) {
  416. /* IPv4 */
  417. host = "127.0.0.1";
  418. printf("Browse files at %s://%s:%i/\n", proto, host, ports[n].port);
  419. printf("Run example at %s://%s:%i%s\n",
  420. proto,
  421. host,
  422. ports[n].port,
  423. EXAMPLE_URI);
  424. printf(
  425. "Exit at %s://%s:%i%s\n", proto, host, ports[n].port, EXIT_URI);
  426. printf("\n");
  427. }
  428. if ((ports[n].protocol & 2) == 2) {
  429. /* IPv6 */
  430. host = "[::1]";
  431. printf("Browse files at %s://%s:%i/\n", proto, host, ports[n].port);
  432. printf("Run example at %s://%s:%i%s\n",
  433. proto,
  434. host,
  435. ports[n].port,
  436. EXAMPLE_URI);
  437. printf(
  438. "Exit at %s://%s:%i%s\n", proto, host, ports[n].port, EXIT_URI);
  439. printf("\n");
  440. }
  441. }
  442. /* Wait until the server should be closed */
  443. while (!exitNow) {
  444. #ifdef _WIN32
  445. Sleep(1000);
  446. #else
  447. sleep(1);
  448. #endif
  449. #ifdef USE_WEBSOCKET
  450. InformWebsockets(ctx);
  451. #endif
  452. }
  453. /* Stop the server */
  454. mg_stop(ctx);
  455. printf("Server stopped.\n");
  456. printf("Bye!\n");
  457. return EXIT_SUCCESS;
  458. }