embedded_c.c 16 KB

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