tinyhttpd的使用与源码分析

  本着学习的目的下载到了tinnyhttpd的源码，首先阅读了一下readme文档，以下是tinnyhttpd的readme的大概意思:
  1.     这个软件是 J. David Blackstone在1999年写的，根据从http://www.gnu.org/获得的
  2. GNU通用公共许可证被允许修改和分发。
  3.   如果你使用这个软件或者测试这个代码，我将会非常感激，并想知道关于这件事情，
  4. 可以联系我jdavidb@sourceforge.net
  5.   这个软件并不能保证生产质量。没有提供任何形式的保证，甚至是某种目的的
  6. 默认的保证。如果你在你的计算机系统中使用这个软件造成了损坏，我不会负责的。
  7.   我写这个web服务器是在1999年的时候因为我的网络课程的一次作业。
  8. 我们被告知在一个最小型的服务器提供网页服务，以及告诉我们如果我们做了额
  9. 外的任务将会得到额外的学分。Perl向我展示了一些UNIX功能(学习了sockers以及fork)，
  10. 同时O'Reilly的关于UNIX系统与CGI和Perl写一个web客户端的书籍让我意识到我可以轻易
  11. 的制作一个web服务器来提供CGI功能。
  12.   现在如果你是一个apache核心团体的成员，你或许一点儿印象都没有，但是我的教授被搞定了。
  13. 测试color.cgi脚本例程然后输入"chartreuse."，让我看起来比较聪明一些。
  14.   Apache不会，但是我希望这个程序对于那些对http/socket编程感兴趣的人是一个好的教学工具，
  15. 就像UNIX系统调用一样。(这里有关于使用pipe，环境变量，forks等等)
  16.   一件最后的事情:如果你看到了我的web服务器或者(你是心不在焉的吗?)使用它，我都会非常高兴的知道这件事。
  17. 请给我发email。我或许不会真正的去更新程序，但是我想知道知道我帮助你学习了一些东西；
  19.   快乐的黑客
  20.                                                    J. David Blackstone

    其源代码网上资源很多，可以搜一下就可以找到下载链接，在拿到代码执行Makefile的时候可能会遇到-lsocket找不到，可以在Makefile里面讲这个库的引用直接删去即可。编译通过之后，将htdoc下面的color.cgi添加一个可执行权限，然后执行httpd可以拿到一个端口号，然后可以使用浏览器通过输入ip进行访问，例如我的访问方式如下：10.95.4.211:12345   其中12345代表端口号。

    一共500多行代码，其实在技巧上并没有多少让人眼前一亮的感觉，不如阅读cJSON源码的时候那种时刻都会感觉到闪光点存在。但是从整体上来看在结构上有许多可以去学习和借鉴的地方：
    服务端socket建立之后，便阻塞等待客户端来连接，每来一个连接就创建一个线程去处理这个连接。处理流程上，根据收到的请求方式来决定给客户端反馈的方式。有直接返回请求的文件，有执行cgi脚本产生的内容。其中解析数据的时候需要一些http协议相关的协议知识，另外就是在执行cgi的时候通过管道的重映射方式，将程序的输入和输出与cgi脚本的输入输出联系起来。对于整个网页的访问流程会有一些学习，比如说，发起一个网页访问的时候，其实就是向web服务器发起一个资源请求，web服务器接收到这个请求之后会根据携带的目录或者资源标识去找到请求的资源并发送到客户端。执行cgi脚本，其实也是将cgi脚本处理后所输出的内容发送给了客户端。
    对于cgi脚本没有接触过，html文本也就有一点点儿概念，所以就没有自己再做一下改编版的例程了。读一下理解了原理也是很好的。
    在读源码的时候有一些注释就顺道加上了，还有一些根据英文内容做了一下自己的理解。源码如下：
tinnyhttpd.c
  1. /* 程序是在 Sparc Solaris 2.6.上编译的
  2.  * 如果要在Linux上编译:
  3.  *  1) 注释 #include <pthread.h> line.
  4.  *  2) 注释掉定义的newthread变量.
  5.  *  3) 注释掉pthread_create().
  6.  *  4) 取消注释accept_request().
  7.  *  5) 从Makefile移除 -lsocket
  8.  */
  9. #include <stdio.h>
  10. #include <sys/socket.h>
  11. #include <sys/types.h>
  12. #include <netinet/in.h>
  13. #include <arpa/inet.h>
  14. #include <unistd.h>
  15. #include <ctype.h>
  16. #include <strings.h>
  17. #include <string.h>
  18. #include <sys/stat.h>
  19. #include <pthread.h>
  20. #include <sys/wait.h>
  21. #include <stdlib.h>
  23. #define ISspace(x) isspace((int)(x))
  25. #define SERVER_STRING "Server: jdbhttpd/0.1.0\r\n"
  27. void accept_request(int);
  28. void bad_request(int);
  29. void cat(int, FILE *);
  30. void cannot_execute(int);
  31. void error_die(const char *);
  32. void execute_cgi(int, const char *, const char *, const char *);
  33. int get_line(int, char *, int);
  34. void headers(int, const char *);
  35. void not_found(int);
  36. void serve_file(int, const char *);
  37. int startup(u_short *);
  38. void unimplemented(int);
  40. /**********************************************************************/
  41. /* 一个请求是的accept调用返回。合适的处理这个请求
  42.  * 参数: 连接到服务器的socket
  43. /**********************************************************************/
  44. void accept_request(int client)
  45. {
  46.  char buf[1024];
  47.  int numchars;
  48.  char method[255];
  49.  char url[255];
  50.  char path[512];
  51.  size_t i, j;
  52.  struct stat st;
  53.  int cgi = 0;      /* 为真时，服务器确定是一个cgi程序*/
  54.  char *query_string = NULL;
  55. //获取一行
  56.  numchars = get_line(client, buf, sizeof(buf));
  57.  i = 0; j = 0;//将读到的一行内容的行为备份到method中
  58.  while (!ISspace(buf[j]) && (i < sizeof(method) - 1))
  59.  {//读取直到空行
  60.   method[i] = buf[j];
  61.   i++; j++;
  62.  }
  63.  method[i] = '\0';//结束字符
  64. //如果不"GET"或者"POST"请求，那么就不做处理
  65.  if (strcasecmp(method, "GET") && strcasecmp(method, "POST"))
  66.  {
  67.   unimplemented(client);
  68.   return;
  69.  }
  70. //如果是post请求，那么置一个标志位
  71.  if (strcasecmp(method, "POST") == 0)
  72.   cgi = 1;
  73.  //在这里获取url
  74.  i = 0;
  75.  while (ISspace(buf[j]) && (j < sizeof(buf)))
  76.   j++;
  77.  while (!ISspace(buf[j]) && (i < sizeof(url) - 1) && (j < sizeof(buf)))
  78.  {
  79.   url[i] = buf[j];
  80.   i++; j++;
  81.  }
  82.  url[i] = '\0';
  83.  
  84.  if (strcasecmp(method, "GET") == 0)
  85.  {
  86.   query_string = url;
  87.   while ((*query_string != '?') && (*query_string != '\0'))
  88.    query_string++;
  89.   if (*query_string == '?')
  90.   {
  91.    cgi = 1;
  92.    *query_string = '\0';
  93.    query_string++;
  94.   }
  95.  }
  96.  //拼接资源目录
  97.  sprintf(path, "htdocs%s", url);
  98.  if (path[strlen(path) - 1] == '/')
  99.   strcat(path, "index.html");//如果没有url目录那么就是访问主页
  100.  if (stat(path, &st) == -1) 
  101.  {
  102.   while ((numchars > 0) && strcmp("\n", buf))  /* read & discard headers */
  103.    numchars = get_line(client, buf, sizeof(buf));
  104.   not_found(client);
  105.  }
  106.  else
  107.  {
  108.   if ((st.st_mode & S_IFMT) == S_IFDIR)
  109.    strcat(path, "/index.html");//拼接目录
  110.   if ((st.st_mode & S_IXUSR) ||
  111.       (st.st_mode & S_IXGRP) ||
  112.       (st.st_mode & S_IXOTH)    )
  113.    cgi = 1;
  114.   if (!cgi)//根据cgi的标志位选择如何进行返回
  115.    serve_file(client, path);
  116.   else
  117.    execute_cgi(client, path, method, query_string);
  118.  }
  120.  close(client);
  121. }
  124. /**********************************************************************/
  125. /* 通知客户端请求造成了一个错误
  126. /**********************************************************************/
  127. void bad_request(int client)
  128. {
  129.  char buf[1024];
  130. //拼接字符串发送出去
  131.  sprintf(buf, "HTTP/1.0 400 BAD REQUEST\r\n");
  132.  send(client, buf, sizeof(buf), 0);
  133.  sprintf(buf, "Content-type: text/html\r\n");
  134.  send(client, buf, sizeof(buf), 0);
  135.  sprintf(buf, "\r\n");
  136.  send(client, buf, sizeof(buf), 0);
  137.  sprintf(buf, "<P>Your browser sent a bad request, ");
  138.  send(client, buf, sizeof(buf), 0);
  139.  sprintf(buf, "such as a POST without a Content-Length.\r\n");
  140.  send(client, buf, sizeof(buf), 0);
  141. }
  143. /**********************************************************************/
  144. /* Put the entire contents of a file out on a socket.  This function
  145.  * is named after the UNIX "cat" command, because it might have been
  146.  * easier just to do something like pipe, fork, and exec("cat").
  147.  * Parameters: the client socket descriptor
  148.  *             FILE pointer for the file to cat */
  149. /**********************************************************************/
  150. /**********************************************************************/
  151. /* 通过sockt将整个文件发送出去.  这个命令一个nuix的cat命令命名，因为它
  152.  * 或许比较容易的去做管道所做的事情，比如fork 然后执行cat
  153. /**********************************************************************/
  154. void cat(int client, FILE *resource)
  155. {
  156.  char buf[1024];
  158.  fgets(buf, sizeof(buf), resource);
  159.  while (!feof(resource))
  160.  {//将源文件发送出去
  161.   send(client, buf, strlen(buf), 0);
  162.   fgets(buf, sizeof(buf), resource);
  163.  }
  164. }
  166. /**********************************************************************/
  167. /* 通知客户端cgi文件无法被执行
  168. /**********************************************************************/
  169. void cannot_execute(int client)
  170. {
  171.  char buf[1024];
  172.  //组装字符串发出去
  173.  sprintf(buf, "HTTP/1.0 500 Internal Server Error\r\n");
  174.  send(client, buf, strlen(buf), 0);
  175.  sprintf(buf, "Content-type: text/html\r\n");
  176.  send(client, buf, strlen(buf), 0);
  177.  sprintf(buf, "\r\n");
  178.  send(client, buf, strlen(buf), 0);
  179.  sprintf(buf, "<P>Error prohibited CGI execution.\r\n");
  180.  send(client, buf, strlen(buf), 0);
  181. }
  183. /**********************************************************************/
  184. /* 使用perror()打印错误信息 (适用于系统错误; 依赖于代表系统调用错误的errorno)
  185.  * 使程序退出执行 */
  186. /**********************************************************************/
  187. void error_die(const char *sc)
  188. {
  189.  perror(sc);
  190.  exit(1);
  191. }
  194. /**********************************************************************/
  195. /* 执行一个cgi脚本，需要恰当的设置环境变量
  196. /**********************************************************************/
  197. void execute_cgi(int client, const char *path,
  198.                  const char *method, const char *query_string)
  199. {
  200.  char buf[1024];
  201.  int cgi_output[2];
  202.  int cgi_input[2];
  203.  pid_t pid;
  204.  int status;
  205.  int i;
  206.  char c;
  207.  int numchars = 1;
  208.  int content_length = -1;
  210.  buf[0] = 'A'; buf[1] = '\0';
  211.  if (strcasecmp(method, "GET") == 0)
  212.   while ((numchars > 0) && strcmp("\n", buf))  /* read & discard headers */
  213.    numchars = get_line(client, buf, sizeof(buf));
  214.  else    /* POST */
  215.  {//获取执行cgi相关的信息
  216.   numchars = get_line(client, buf, sizeof(buf));
  217.   while ((numchars > 0) && strcmp("\n", buf))
  218.   {
  219.    buf[15] = '\0';
  220.    if (strcasecmp(buf, "Content-Length:") == 0)
  221.     content_length = atoi(&(buf[16]));
  222.    numchars = get_line(client, buf, sizeof(buf));
  223.   }
  224.   if (content_length == -1) {
  225.    bad_request(client);
  226.    return;
  227.   }
  228.  }
  230.  sprintf(buf, "HTTP/1.0 200 OK\r\n");
  231.  send(client, buf, strlen(buf), 0);
  233.  if (pipe(cgi_output) < 0) {
  234.   cannot_execute(client);
  235.   return;
  236.  }
  237.  if (pipe(cgi_input) < 0) {
  238.   cannot_execute(client);
  239.   return;
  240.  }
  242.  if ( (pid = fork()) < 0 ) {
  243.   cannot_execute(client);
  244.   return;
  245.  }
  246.  if (pid == 0)  /* child: CGI script */
  247.  {
  248.   char meth_env[255];
  249.   char query_env[255];
  250.   char length_env[255];
  251.  //子进程中设置环境变量，重映射标准输入输出为打开的管道
  252.   dup2(cgi_output[1], 1);
  253.   dup2(cgi_input[0], 0);
  254.   close(cgi_output[0]);
  255.   close(cgi_input[1]);
  256.   sprintf(meth_env, "REQUEST_METHOD=%s", method);
  257.   putenv(meth_env);
  258.   if (strcasecmp(method, "GET") == 0) {
  259.    sprintf(query_env, "QUERY_STRING=%s", query_string);
  260.    putenv(query_env);
  261.   }
  262.   else {   /* POST */
  263.    sprintf(length_env, "CONTENT_LENGTH=%d", content_length);
  264.    putenv(length_env);
  265.   }
  266.   execl(path, path, NULL);//设置好了环境变量之后就执行cgi脚本
  267.   exit(0);
  268.  } 
  269.  else 
  270.  {    /* parent */
  271.   close(cgi_output[1]);
  272.   close(cgi_input[0]);
  273.   if (strcasecmp(method, "POST") == 0)
  274.    for (i = 0; i < content_length; i++) 
  275.    {//将接受到的参数写入管道其实就是为了给cgi脚本传参数
  276.     recv(client, &c, 1, 0);
  277.     write(cgi_input[1], &c, 1);
  278.    }
  279.   while (read(cgi_output[0], &c, 1) > 0)
  280.    send(client, &c, 1, 0);//接受cgi脚本的输出
  282.   close(cgi_output[0]);
  283.   close(cgi_input[1]);
  284.   waitpid(pid, &status, 0);
  285.  }
  286. }
  289. /**********************************************************************/
  290. /* 从socket中获取一行, 不论这一行是以一个换行符\n还是\r或者是\r\n。遇到'\0'
  291.  * 时结束读取内容。如果在完成读取之前没有换行提示，那么这个字符串就以'\0'结尾
  292.  * 如果上述的三个行结束标记被读取到，那么这个字符串的最后一个字符是回车换行符
  293.  * 字符串会以'\0'结尾
  294.  * 参数: socket 套接字
  295.  *       buf	保存信息的缓存区
  296.  *       size   缓冲区的大小
  297.  * 返回: 保存的字节数，不含'\0'
  298. /**********************************************************************/
  299. int get_line(int sock, char *buf, int size)
  300. {
  301.  int i = 0;
  302.  char c = '\0';
  303.  int n;
  304. //寻找'\n'直到超出缓冲区大小
  305.  while ((i < size - 1) && (c != '\n'))
  306.  {//接收一个字符
  307.   n = recv(sock, &c, 1, 0);
  308. //  printf("%02X\n", c);
  309.   if (n > 0)
  310.   {
  311.    if (c == '\r')
  312.    {//处理\r\n的情况，再取一个直接进行判断一次
  313.     n = recv(sock, &c, 1, MSG_PEEK);
  314.     /* DEBUG printf("%02X\n", c); */
  315.     if ((n > 0) && (c == '\n'))
  316.      recv(sock, &c, 1, 0);//如果是那么就把这个字符读出来
  317.     else
  318.      c = '\n';//否则就将\r变成\n
  319.    }
  320.    buf[i] = c;//放到缓存中
  321.    i++;
  322.   }
  323.   else
  324.    c = '\n';//没有接收到数据，那么就认为接收到'\n'触发退出条件
  325.  }
  326.  buf[i] = '\0';//将'\0'填充到末尾
  327.  
  328.  return(i);//返回字节数
  329. }
  331. /**********************************************************************/
  332. /* Return the informational HTTP headers about a file. */
  333. /* Parameters: the socket to print the headers on
  334.  *             the name of the file */
  335. /**********************************************************************/
  336. /**********************************************************************/
  337. /* 返回一个关于文件信息的HTTP头. */
  338. /**********************************************************************/
  339. void headers(int client, const char *filename)
  340. {
  341.  char buf[1024];
  342.  (void)filename;  /* could use filename to determine file type */
  343. //组装字符串发送出去
  344.  strcpy(buf, "HTTP/1.0 200 OK\r\n");
  345.  send(client, buf, strlen(buf), 0);
  346.  strcpy(buf, SERVER_STRING);
  347.  send(client, buf, strlen(buf), 0);
  348.  sprintf(buf, "Content-Type: text/html\r\n");
  349.  send(client, buf, strlen(buf), 0);
  350.  strcpy(buf, "\r\n");
  351.  send(client, buf, strlen(buf), 0);
  352. }
  354. /**********************************************************************/
  355. /* 给出一个404错误 */
  356. /**********************************************************************/
  357. void not_found(int client)
  358. {
  359.  char buf[1024];
  360. //组装发送
  361.  sprintf(buf, "HTTP/1.0 404 NOT FOUND\r\n");
  362.  send(client, buf, strlen(buf), 0);
  363.  sprintf(buf, SERVER_STRING);
  364.  send(client, buf, strlen(buf), 0);
  365.  sprintf(buf, "Content-Type: text/html\r\n");
  366.  send(client, buf, strlen(buf), 0);
  367.  sprintf(buf, "\r\n");
  368.  send(client, buf, strlen(buf), 0);
  369.  sprintf(buf, "<HTML><TITLE>Not Found</TITLE>\r\n");
  370.  send(client, buf, strlen(buf), 0);
  371.  sprintf(buf, "<BODY><P>The server could not fulfill\r\n");
  372.  send(client, buf, strlen(buf), 0);
  373.  sprintf(buf, "your request because the resource specified\r\n");
  374.  send(client, buf, strlen(buf), 0);
  375.  sprintf(buf, "is unavailable or nonexistent.\r\n");
  376.  send(client, buf, strlen(buf), 0);
  377.  sprintf(buf, "</BODY></HTML>\r\n");
  378.  send(client, buf, strlen(buf), 0);
  379. }
  382. /**********************************************************************/
  383. /* 发送一个规则文件到客户端. 使用headers, 上报错误如果发生错误
  384. /**********************************************************************/
  385. void serve_file(int client, const char *filename)
  386. {
  387.  FILE *resource = NULL;
  388.  int numchars = 1;
  389.  char buf[1024];
  391.  buf[0] = 'A'; buf[1] = '\0';
  392.  while ((numchars > 0) && strcmp("\n", buf))  /* read & discard headers */
  393.   numchars = get_line(client, buf, sizeof(buf));
  394.  //打开文件
  395.  resource = fopen(filename, "r");
  396.  if (resource == NULL)
  397.   not_found(client);
  398.  else
  399.  {//组织头部
  400.   headers(client, filename);
  401.   cat(client, resource);//传输文件到客户端
  402.  }
  403.  fclose(resource);
  404. }
  407. /**********************************************************************
  408.  * 这个函数在一个指定的端口上启动一个监听web连接的处理。如果*port==0，那么
  409.  * 就动态的申请一个端口号然后修改*port的值
  410.  * 参数: 指向待连接端口号值的指针
  411.  * 返回: socket 
  412.  **********************************************************************/
  413. int startup(u_short *port)
  414. {
  415.  int httpd = 0;
  416.  struct sockaddr_in name;
  417.  //建立socket
  418.  httpd = socket(PF_INET, SOCK_STREAM, 0);
  419.  if (httpd == -1)
  420.   error_die("socket");
  421.  memset(&name, 0, sizeof(name));
  422.  //为绑定做准备后进行绑定
  423.  name.sin_family = AF_INET;
  424.  name.sin_port = htons(*port);
  425.  name.sin_addr.s_addr = htonl(INADDR_ANY);
  426.  if (bind(httpd, (struct sockaddr *)&name, sizeof(name)) < 0)
  427.   error_die("bind");
  428.  if (*port == 0)  /* if dynamically allocating a port */
  429.  {//如果port传入的原值为0 ，那么动态的端口号进行回填
  430.   int namelen = sizeof(name);
  431.   //用于获取一个套接字的名字。它用于一个已捆绑或已连接套接字s，本地地址将被返回
  432.   if (getsockname(httpd, (struct sockaddr *)&name, &namelen) == -1)
  433.    error_die("getsockname");
  434.   *port = ntohs(name.sin_port);//回填
  435.  }
  436.  if (listen(httpd, 5) < 0)
  437.   error_die("listen");
  438.  return(httpd);
  439. }
  442. /**********************************************************************/
  443. /* 通知客户端，请求方法还不支持
  444.  * 参数: 客户端socket */
  445. /**********************************************************************/
  446. void unimplemented(int client)
  447. {
  448.  char buf[1024];
  449. //组装一个xml说明文件进行返回到client
  450.  sprintf(buf, "HTTP/1.0 501 Method Not Implemented\r\n");
  451.  send(client, buf, strlen(buf), 0);
  452.  sprintf(buf, SERVER_STRING);
  453.  send(client, buf, strlen(buf), 0);
  454.  sprintf(buf, "Content-Type: text/html\r\n");
  455.  send(client, buf, strlen(buf), 0);
  456.  sprintf(buf, "\r\n");
  457.  send(client, buf, strlen(buf), 0);
  458.  sprintf(buf, "<HTML><HEAD><TITLE>Method Not Implemented\r\n");
  459.  send(client, buf, strlen(buf), 0);
  460.  sprintf(buf, "</TITLE></HEAD>\r\n");
  461.  send(client, buf, strlen(buf), 0);
  462.  sprintf(buf, "<BODY><P>HTTP request method not supported.\r\n");
  463.  send(client, buf, strlen(buf), 0);
  464.  sprintf(buf, "</BODY></HTML>\r\n");
  465.  send(client, buf, strlen(buf), 0);
  466. }
  468. /**********************************************************************/
  470. int main(void)
  471. {
  472.  int server_sock = -1;
  473.  u_short port = 0;
  474.  int client_sock = -1;
  475.  struct sockaddr_in client_name;
  476.  int client_name_len = sizeof(client_name);
  477.  pthread_t newthread;
  478.  //打开服务器socket等待连接
  479.  server_sock = startup(&port);
  480.  printf("httpd running on port %d\n", port);
  481.  while (1)
  482.  {
  483.     //等待连接
  484. 	client_sock = accept(server_sock, (struct sockaddr *)&client_name, &client_name_len);
  485. 	if (client_sock == -1)
  486. 		error_die("accept");//如果连接失败那么就打印下错误然后退出
  487. 	//连接成功则为这次连接创建一个线程进行处理
  488. 	if (pthread_create(&newthread , NULL, accept_request, client_sock) != 0)
  489. 		perror("pthread_create");
  490.  }
  491.  close(server_sock);
  493.  return(0);
  494. }







附件列表

     

    posted on 2017-08-28 11:31  cfzhang  阅读(694)  评论(0)  编辑  收藏  举报

    导航