第47章 RL-TCPnet之Web服务器的CGI实现

STM32

转帖

本章节为大家讲解RL-TCPnet的CGI脚本实现动态网页，前面第44章讲解了静态网页的设计，本章的动态网页是在静态网页的基础上实现，所以学习本章节前，务必保证已经掌握了静态网页的设计方法。

本章教程含STM32F407开发板和STM32F429开发板。

47.1 初学者重要提示

47.2 CGI函数

47.3 HTTP配置说明（Net_Config.c）

47.4 HTTP调试说明（Net_Debug.c）

47.5 制作HTML和CGI脚本文件

47.6 访问开发板Web服务器的方法

47.7 HTTP_CGI.c文件中接口函数讲解说明

47.8 实验例程说明（RTX）

47.9 总结

lee_st · 2018-1-14 04:49:48

47.1 初学者重要提示
1、学习本章节前，务必保证已经学习了第44，45和46章节，如果没有学习就直接学习本章节的话，将比较吃力，特别是CGI相关知识点的理解、网页制作以及工程建立的时候。
2、使用CGI脚本做网页更新时，整个页面都会重新加载，而后面章节学习的Ajax可以做网页局部刷新。

lee_st · 2018-1-14 04:50:05

47.2 CGI函数
CGI脚本涉及到以下5个函数：
（1）cgi_func
（2）cgi_process_data
（3）cgi_process_var
（4）http_accept_host
（5）cgx_content_type

lee_st · 2018-1-14 04:50:30

关于这5个函数的讲解及其使用方法可以看教程第 3 章 3.4 小节里面说的参考资料 rlarm.chm 文件：

lee_st · 2018-1-14 04:50:47

本章节除了讲解以上5个函数外，还需要讲解下面这个函数：http_get_var （这个函数在HTTP函数部分）
关于这些函数注意以下两点：
1、CGI的所有函数都不支持重入，也就是不支持多任务调用。
2、通过CGI脚本就可以实现动态HTML网页了。

lee_st · 2018-1-14 04:51:12

47.2.1 函数cgi_func
函数原型：
U16 cgi_func (

U8*  env,    /* 输入字符串地址 */

U8*  buf,    /* 输出缓冲区地址 */

U16  buflen, /* 输出缓冲区大小，单位字节*/

U32* pcgi ); /* 指针变量，指向一个不会被改变的变量 */

lee_st · 2018-1-14 04:51:28

函数描述：
函数cgi_func由RL-TCPnet脚本解析器调用，当解析RL-TCPnet的脚本时（以cgi结尾的脚本文件），输出HTTP响应的动态部分。脚本文件每个以命令c开头的语句，脚本解析器都会调用函数cgi_func。所以用户必须要编写此函数，以便解析和使用脚本文件中的输入字符。
1、第1个参数是CGI脚本的输入字符串地址，函数cgi_func需要这个参数创建动态响应。这个字符串就是CGI脚本文件中以命令c开头的语句中的字符串，字节数是相同的（不含控制字符，仅HTTP代码部分）。
2、第2个参数是输出缓冲区地址，用于写入HTTP响应字符串。
3、第3个参数是输出缓冲区大小，单位字节。
4、第4个参数是指向不会被HTTP服务器更改的变量，因此，用户可以用它存储函数cgi_func连续调用的参数，比如循环计数器、发送字节数、状态缓冲区地址等，亦或者任何其它应用均可。
5、返回值，返回写入到输出缓冲区的字节数。返回值是U16类型的，其中bit15和bit14还可以作为其它用途，而剩余的bit0-bit13表示的最大值是16383，足够表示TCP Socket的MSS最大报文段大小的1460字节。

lee_st · 2018-1-14 04:51:44

（1）bit15作为函数cgi_func是否重复调用的标志，如果此位设置为1，表示退出函数后，依然保持参数env, buflen和 pcgi的数值，并再次调用函数cgi_func，而参数buf会根据用户写入到输出缓冲区的字节数进行自动调整。如果此位设置为0，将不再重复调用。
   （2）如果bit14设置为1，取消数据包优化（见下面注意事项4），当前数据包立即被发送。如果bit14为0，不执行此操作。
使用这个函数要注意以下问题：
1.    写入到输出缓冲区的代码必须是HTML格式。
2.    CGI脚本中的c命令才会触发此函数。
3.    输出缓冲区的大小buflen会有所不同，因为输出缓冲区的大小是由TCP Socket的MSS最大报文段大小协商决定，局域网中一般是1400字节左右，但是也可减小到500字节，甚至更小。

lee_st · 2018-1-14 04:51:58

4.    输出缓冲区的不同大小还有一个原因是HTTP Server会尝试优化生成的TCP数据包数，并将再次调用函数cgi_func来使用所有可用的缓冲区。当缓冲区中只有240个或更少的字节空闲时，将停止调用函数cgi_func，然后生成并发送数据包。如果要强制HTTP Server发送数据包，则此函数的返回值bit14置1。
5.    写到输出缓冲区的数据，不可以超过第三个参数buflen的大小，否则会造成内存指针链表的损坏，从而很容易造成系统崩溃。
6.    第1个参数的输入字符串可能包含单字符子命令，以此来告诉cgi_func如何正确的处理脚本。这些子命令没有规则，因此用户可以创建和使用自己的命令。
7.    对于每个HTTP会话，*pcgi（注意，这里是指的指针变量pcgi所指向的存储单元）变量都是独立的，也就是说新创建一个会话，都会有一个独立的*pvar变量。另外，每个会话首次调用函数cgi_func之前都会将变量*pcgi清零（注意，这里是指的指针变量pvar所指向的存储单元清零）。
8.    每次调用函数cgi_func必须更新*pcgi（注意，这里是指的指针变量pcgi所指向的存储单元）的内容，用户可以使用这个4字节变量存储任何格式的数据（官方手册中说的是必须更新，实际上，用不上的话，不用管）。

lee_st · 2018-1-14 04:52:13

使用举例：
U16 cgi_func (U8 *env, U8 *buf, U16 buflen, U32 *pcgi) {

  U16 len = 0;

  switch (env[0]) {

/* Analyze the environment string. It is the script 'c' line starting */

/* at position 2. What you write to the script file is returned here. */

case 'a' :

   /* Network parameters - file 'network.cgi' */

   ..

   break;

case 'b':

   /* LED control - file 'led.cgi' */

   ..

   break;

case 'c':

   /* TCP status - file 'tcp.cgi' */

   ..

   break;

case 'd':

   /* System password - file 'system.cgi' */

   switch (env[2]) {

      case '1':

      len = sprintf(buf,&env[4],http_EnAuth ? "Enabled" : "Disabled");

      break;

      case '2':

      len = sprintf(buf,&env[4],http_auth_passw);

      break;

   }

   break;

  }

  return (len);

}

lee_st · 2018-1-14 04:52:35

47.2.2 函数cgi_process_data
函数原型：
void cgi_process_data (

U8 code, /* 接收数据缓冲区中的数据类型 */

U8* dat, /* 来自POST方式的字符串地址 */

U16 len ); /* 字符串的字节数 */

lee_st · 2018-1-14 04:52:58

函数描述：
函数cgi_process_data处理CGI POST方式返回的数据。当用户使用Web浏览器操作POST方式的HTTP表时（如单选按钮、复选框、选择列表等），HTTP服务器会调用此函数。
1、函数cgi_process_data的三个参数与下表的对应关系：
   “代码”对应第1个参数code。
   “dat指针变量含义”对应第2个参数dat。
   “变量len的含义”对应第3个参数len。

lee_st · 2018-1-14 04:53:21

使用这个函数要注意以下问题：

lee_st · 2018-1-14 04:53:38

1. 仅POST方式才会触发HTTP服务器调用此函数，即METHOD = POST。

lee_st · 2018-1-14 04:53:55

2.    Web浏览器提供HTTP上传文件的文件名及其路径，而删除文件名中的路径信息是用户的责任。
3.    对于大文件，文件数据将分多次数据包进行接收。数据包的大小取决于TCP的MSS最大报文段大小，一般是1460字节。
4.    XML-POST是由webservice application生成的，例如微软的Silverlight。

lee_st · 2018-1-14 04:54:16

使用举例：
void cgi_process_data (U8 code, U8 *dat, U16 len) {

  /* This function is called by HTTP server to process the returned Data */

  /* for the CGI Form POST method. It is called on SUBMIT from the browser. */

  /* Parameters:                                                          */

  /* code  - callback context code                                     */

  /*          0 = www-url-encoded form data                               */

  /*          1 = filename for file upload (0-terminated string)          */

  /*          2 = file upload raw data                                  */

  /*          3 = end of file upload (file close requested)             */

  /*          4 = any xml encoded POST data (single or last stream)       */

  /*          5 = the same as 4, but with more xml data to follow       */

  /*             Use http_get_content_type() to check the content type */

  /* dat - pointer to POST received data                               */

  /* len - received data length                                        */

  U8 *var;

  switch (code) {

case 0:

   /* Url encoded form data received. */

   break;

case 1:

   /* Filename for file upload received as encoded by the browser. */

   /* It might contain an absolute path to a file from the sending */

   /* host. Open a file for writing. */

   return;

case 2:

   /* File content data received. Write data to a file. */

   /* This function will be called several times with */

   /* code 2 when a big file is being uploaded.       */

   return;

case 3:

   /* File upload finished. Close a file. */

   return;

case 4:

   /* XML encoded content type, last packet. */

   // pType = http_get_content_type ();

   /* check the content type for CGX file request. */

   /* pType is a pointer to a 0-terminated string  */

   /* For example: text/xml; charset=utf-8       */

   return;

case 5:

   /* XML encoded as under 4, but with more to follow. */

   return;

default:

   /* Ignore all other codes. */

   return;

  }

  if (len == 0) {

/* No data or all items (radio, checkbox) are off. */

return;

  }

  var = (U8 *)alloc_mem (40);

  do {

/* Parse all returned parameters. */

dat = http_get_var (dat, var, 40);

if (var[0] != 0) {

   if (str_scomp (var, "TICK1=") == __TRUE || str_scomp (var, "pg=") == __TRUE)

   {

      if (str_scomp (var, "pg=") == __TRUE)

      {

            LEDControl = 0;

      }



      if(*(var+9) =='1')

      {

         LEDControl |= 0x01;

      }

      else if(*(var+9) =='2')

      {

         LEDControl |= 0x02;

      }

      else if(*(var+9) =='3')

      {

         LEDControl |= 0x04;

      }

   }

}

  }while (dat);

  free_mem ((OS_FRAME *)var);

  if(LEDControl & 0x01)

  {

   bsp_LedOn(1);

  }

  else

  {

   bsp_LedOff(1);

  }

  if(LEDControl & 0x02)

  {

   bsp_LedOn(2);

  }

  else

  {

   bsp_LedOff(2);

  }

  if(LEDControl & 0x04)

  {

   bsp_LedOn(3);

  }

  else

  {

   bsp_LedOff(3);

  }

}

lee_st · 2018-1-14 04:54:31

47.2.3 函数cgi_process_var
函数原型：
void cgi_process_var (

U8* qs ); /* Pointer to QUERY_STRING returned from the GET method. */

lee_st · 2018-1-14 04:54:47

函数描述：
函数cgi_process_var处理从CGI GET方式返回的环境变量QUERY_STRING（就是个字符串），当用户使用Web浏览器操作GET方式的HTTP表单时（如单选按钮、复选框、选择列表等），HTTP服务器会调用此函数。
1、第1个参数是环境变量QUERY_STRING的地址，实际就是个字符串地址。

lee_st · 2018-1-14 04:55:05

使用这个函数要注意以下问题：
1. 环境变量QUERY_STRING以空格结尾，即此字符串以空格结尾。
2. 仅GET方式才会触发HTTP服务器调用此函数，即METHOD = GET。

lee_st · 2018-1-14 04:55:24

使用举例：
void cgi_process_var (U8 *qs) {

  /* This function is called by HTTP server to process the Querry_String */

  /* for the CGI Form GET method. It is called on SUBMIT from the browser. */

  /*.The Querry_String.is SPACE terminated.                               */

  U8 *var;

  int s[4];

  var = (U8 *)alloc_mem (40);

  do {

/* Loop through all the parameters. */

qs = http_get_var (qs, var, 40);

/* Check the returned string, 'qs' now points to the next. */

if (var[0] != 0) {

   /* Returned string is non 0-length. */

   if (str_scomp (var, "ip=") == __TRUE) {

      /* My IP address parameter. */

      sscanf ((const char *)&var[3], "%d.%d.%d.%d",&s[0],&s[1],&s[2],&s[3]);

      LocM.IpAdr[0] = s[0];

      LocM.IpAdr[1] = s[1];

      LocM.IpAdr[2] = s[2];

      LocM.IpAdr[3] = s[3];

   }

   else if (str_scomp (var, "msk=") == __TRUE) {

      /* Net mask parameter. */

      sscanf ((const char *)&var[4], "%d.%d.%d.%d",&s[0],&s[1],&s[2],&s[3]);

      LocM.NetMask[0] = s[0];

      LocM.NetMask[1] = s[1];

      LocM.NetMask[2] = s[2];

      LocM.NetMask[3] = s[3];

   }

   else if (str_scomp (var, "gw=") == __TRUE) {

      /* Default gateway parameter. */

      sscanf ((const char *)&var[3], "%d.%d.%d.%d",&s[0],&s[1],&s[2],&s[3]);

      LocM.DefGW[0] = s[0];

      LocM.DefGW[1] = s[1];

      LocM.DefGW[2] = s[2];

      LocM.DefGW[3] = s[3];

   }

   else if (str_scomp (var, "pdns=") == __TRUE) {

      /* Default gateway parameter. */

      sscanf ((const char *)&var[5], "%d.%d.%d.%d",&s[0],&s[1],&s[2],&s[3]);

      LocM.PriDNS[0]  = s[0];

      LocM.PriDNS[1]  = s[1];

      LocM.PriDNS[2]  = s[2];

      LocM.PriDNS[3]  = s[3];

   }

   else if (str_scomp (var, "sdns=") == __TRUE) {

      /* Default gateway parameter. */

      sscanf ((const char *)&var[5], "%d.%d.%d.%d",&s[0],&s[1],&s[2],&s[3]);

      LocM.SecDNS[0]  = s[0];

      LocM.SecDNS[1]  = s[1];

      LocM.SecDNS[2]  = s[2];

      LocM.SecDNS[3]  = s[3];

   }

}

  }while (qs);

  free_mem ((OS_FRAME *)var);

}

搜索历史

第47章 RL-TCPnet之Web服务器的CGI实现

评分

相关推荐

115 条评论

评分

评分

评分

评分

评分

评分

评分

评分

评分

评分

评论

精选推荐

热门帖

站长推荐 /6