embedded_c.c 15 KB

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