embedded_c.c 16 KB

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