lib/src/http/NyLPC_cHttpBasicHeaderParser.h

   1 /*********************************************************************************\r
   2  * PROJECT: MiMic\r
   3  * --------------------------------------------------------------------------------\r
   4  *\r
   5  * This file is part of MiMic\r
   6  * Copyright (C)2011 Ryo Iizuka\r
   7  *\r
   8  * MiMic is free software: you can redistribute it and/or modify\r
   9  * it under the terms of the GNU Lesser General Public License as published\r
  10  * by　the Free Software Foundation, either version 3 of the　License, or\r
  11  * (at your option) any later version.\r
  12  *\r
  13  * This program is distributed in the hope that it will be useful,\r
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  16  * GNU General Public License for more details.\r
  17  *\r
  18  * You should have received a copy of the GNU Lesser General Public License\r
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.\r
  20  *\r
  21  * For further information please contact.\r
  22  *      http://nyatla.jp/\r
  23  *      <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>\r
  24  *\r
  25  *********************************************************************************/\r
  26 \r
  27 #ifndef NyLPC_TcHttpBasicHeader_H\r
  28 #define NyLPC_TcHttpBasicHeader_H\r
  29 #include "NyLPC_stdlib.h"\r
  30 #include "NyLPC_cHttpStream.h"\r
  31 \r
  32 #ifdef __cplusplus\r
  33 extern "C" {\r
  34 #endif /* __cplusplus */\r
  35 \r
  36 /**\r
  37  * HeaderParserのステータス定義値。\r
  38  */\r
  39 typedef NyLPC_TUInt8 NyLPC_TcHttpBasicHeaderParser_ST;\r
  40 #define NyLPC_TcHttpBasicHeaderParser_ST_START                                  ((NyLPC_TcHttpBasicHeaderParser_ST)0x01)//HTTPステータスラインか、リクエストライン\r
  41 #define NyLPC_TcHttpBasicHeaderParser_ST_RL_URL                                 ((NyLPC_TcHttpBasicHeaderParser_ST)0x12)//URL\r
  42 #define NyLPC_TcHttpBasicHeaderParser_ST_RL_VERSION                             ((NyLPC_TcHttpBasicHeaderParser_ST)0x13)//VERSION\r
  43 #define NyLPC_TcHttpBasicHeaderParser_ST_SL_STATUSCODE                  ((NyLPC_TcHttpBasicHeaderParser_ST)0x21)//ステータスコード\r
  44 #define NyLPC_TcHttpBasicHeaderParser_ST_SL_REASON                              ((NyLPC_TcHttpBasicHeaderParser_ST)0x22)//Reason-Phrase\r
  45 #define NyLPC_TcHttpBasicHeaderParser_ST_MSGHEAD                                ((NyLPC_TcHttpBasicHeaderParser_ST)0x31)//MESSAGE\r
  46 #define NyLPC_TcHttpBasicHeaderParser_ST_MSGPARAM                               ((NyLPC_TcHttpBasicHeaderParser_ST)0x32)//MESSAGEパラメータ部\r
  47 #define NyLPC_TcHttpBasicHeaderParser_ST_MSG_CONTENTLENGTH              ((NyLPC_TcHttpBasicHeaderParser_ST)0x33)//MESSAGEContentLength\r
  48 #define NyLPC_TcHttpBasicHeaderParser_ST_MSG_CONNECTION                 ((NyLPC_TcHttpBasicHeaderParser_ST)0x34)//MESSAGEConnection\r
  49 #define NyLPC_TcHttpBasicHeaderParser_ST_MSG_TRANSFERENCODING   ((NyLPC_TcHttpBasicHeaderParser_ST)0x35)//TransferEncoding\r
  50 #define NyLPC_TcHttpBasicHeaderParser_ST_MSG_RANGE                              ((NyLPC_TcHttpBasicHeaderParser_ST)0x36)//Range\r
  51 #define NyLPC_TcHttpBasicHeaderParser_ST_EOH                                    ((NyLPC_TcHttpBasicHeaderParser_ST)0x7F)//終わり\r
  52 #define NyLPC_TcHttpBasicHeaderParser_ST_ERROR                                  ((NyLPC_TcHttpBasicHeaderParser_ST)0x80)//終わり\r
  53 /*\r
  54         プライベート関数\r
  55 */\r
  56 #define NyLPC_TcHttpBasicHeaderParser_ST_isError(i_v) ((i_v)==NyLPC_TcHttpBasicHeaderParser_ST_ERROR)\r
  57 \r
  58 \r
  59 \r
  60 /**\r
  61  * このクラスは、Httpヘッダのパーサを定義します。\r
  62  */\r
  63 typedef struct NyLPC_TcHttpBasicHeaderParser NyLPC_TcHttpBasicHeaderParser_t;\r
  64 \r
  65 \r
  66 /**\r
  67  * HTTPメソッドの定義値。\r
  68  */\r
  69 typedef NyLPC_TUInt8 NyLPC_THttpMethodType;\r
  70 #define NyLPC_THttpMethodType_GET                       ((NyLPC_THttpMethodType)0x01)\r
  71 #define NyLPC_THttpMethodType_POST                      ((NyLPC_THttpMethodType)0x02)\r
  72 #define NyLPC_THttpMethodType_HEAD                      ((NyLPC_THttpMethodType)0x03)\r
  73 \r
  74 /**\r
  75  * HTTPバージョンの定義値\r
  76  */\r
  77 typedef NyLPC_TUInt8 NyLPC_THttpVersion;\r
  78 #define NyLPC_THttpVersion_09           ((NyLPC_THttpVersion)0x01)\r
  79 #define NyLPC_THttpVersion_10           ((NyLPC_THttpVersion)0x02)\r
  80 #define NyLPC_THttpVersion_11           ((NyLPC_THttpVersion)0x03)\r
  81 #define NyLPC_THttpVersion_UNKNOWN      ((NyLPC_THttpVersion)0x04)\r
  82 \r
  83 \r
  84 typedef NyLPC_TUInt8 NyLPC_THttpHeaderType;\r
  85 #define NyLPC_THttpHeaderType_REQUEST  ((NyLPC_THttpHeaderType)0x01)\r
  86 #define NyLPC_THttpHeaderType_RESPONSE ((NyLPC_THttpHeaderType)0x02)\r
  87 \r
  88 \r
  89 typedef NyLPC_TUInt8 NyLPC_THttpMessgeHeader_Connection;\r
  90 #define NyLPC_THttpMessgeHeader_Connection_NONE  ((NyLPC_THttpMessgeHeader_Connection)0x01)\r
  91 #define NyLPC_THttpMessgeHeader_Connection_CLOSE ((NyLPC_THttpMessgeHeader_Connection)0x02)\r
  92 #define NyLPC_THttpMessgeHeader_Connection_KEEPALIVE ((NyLPC_THttpMessgeHeader_Connection)0x03)\r
  93 #define NyLPC_THttpMessgeHeader_Connection_UNKNOWN ((NyLPC_THttpMessgeHeader_Connection)0x10)\r
  94 \r
  95 typedef NyLPC_TUInt8 NyLPC_THttpMessgeHeader_TransferEncoding;\r
  96 #define NyLPC_THttpMessgeHeader_TransferEncoding_NONE    ((NyLPC_THttpMessgeHeader_TransferEncoding)0x01)       //TEはない\r
  97 #define NyLPC_THttpMessgeHeader_TransferEncoding_CHUNKED ((NyLPC_THttpMessgeHeader_TransferEncoding)0x02)\r
  98 #define NyLPC_THttpMessgeHeader_TransferEncoding_UNKNOWN ((NyLPC_THttpMessgeHeader_TransferEncoding)0x10)\r
  99 \r
 100 #define NyLPC_THttpContentLength_INVALID_LENGTH 0xFFFFFFFF\r
 101 \r
 102 \r
 103 \r
 104 \r
 105 \r
 106 /**\r
 107  * この構造体は、NyLPC_cHttpBasicHeaderParserの結果を格納します。\r
 108  */\r
 109 struct NyLPC_THttpBasicHeader\r
 110 {\r
 111         NyLPC_THttpHeaderType type;\r
 112         union{\r
 113                 struct{\r
 114                         NyLPC_THttpVersion version;\r
 115                         NyLPC_THttpMethodType method;\r
 116                 }req;\r
 117                 struct{\r
 118                         NyLPC_THttpVersion version;\r
 119                         NyLPC_TUInt32 status;\r
 120                 }res;\r
 121         }startline;\r
 122         NyLPC_THttpMessgeHeader_TransferEncoding transfer_encoding;\r
 123         NyLPC_TUInt32 content_length;\r
 124         NyLPC_THttpMessgeHeader_Connection connection;\r
 125 };\r
 126 \r
 127 /**\r
 128  * このヘッダが持続性接続を求めているか判定します。\r
 129  */\r
 130 NyLPC_TBool NyLPC_THttpBasicHeader_isPersistent(const struct NyLPC_THttpBasicHeader* i_struct);\r
 131 \r
 132 \r
 133 \r
 134 \r
 135 \r
 136 \r
 137 /**\r
 138  * コンフィギュレーション値。\r
 139  * ショートパラメータ解析バッファのサイズ\r
 140  */\r
 141 #define NyLPC_cHttpBasicHeaderParser_SIZE_OF_WBS 32\r
 142 \r
 143 \r
 144 \r
 145 \r
 146 /**\r
 147  * 独自のメッセージフィールドを受け取るイベントハンドラです。\r
 148  * メッセージハンドラはNyLPC_cHttpBasicHeaderParserから３種類のメッセージを受け取ります。\r
 149  * ハンドラは、NyLPC_TcHttpBasicHeaderParserが処理しないメッセージヘッダをパース中に、次の順番で呼び出されます。\r
 150  * <ol>\r
 151  * <li>開始メッセージ - i_nameに有効な文字列を指定して、そのフィールド値が入力される事を伝えます。i_cはnullです。\r
 152  * <li>フィールドメッセージ - i_nameにNULL,i_cに\0以外の文字を指定して、フィールド値が入力されている事を指示します。\r
 153  * <li>フィールドエンド - i_nameにNULL,i_cに0を指定して、フィールドが完了した事を指示します。\r
 154  * </ol>\r
 155 */\r
 156 typedef NyLPC_TBool (*NyLPC_cHttpBasicHeaderParser_messageHandler) (NyLPC_TcHttpBasicHeaderParser_t* i_inst,const NyLPC_TChar* i_name,NyLPC_TChar i_c,struct NyLPC_THttpBasicHeader* o_out);\r
 157 /**\r
 158  * リクエストのURL文字列を受け取るイベントハンドラです。\r
 159  * メッセージハンドラはNyLPC_cHttpBasicHeaderParserから３種類のメッセージを受け取ります。\r
 160  * ハンドラは、NyLPC_TcHttpBasicHeaderParserが処理しないメッセージヘッダをパース中に、次の順番で呼び出されます。\r
 161  * <ol>\r
 162  * <li>URLメッセージ - i_cに\0以外の文字を指定して、URL値が入力されている事を指示します。\r
 163  * <li>URLエンド - i_cに0を指定して、URLが完了した事を指示します。\r
 164  * </ol>\r
 165 */\r
 166 /**\r
 167 メッセージハンドラはNyLPC_cHttpBasicHeaderParserから３種類のメッセージを受け取ります。\r
 168         1.URLメッセージ - i_cに\0以外の文字を指定して、URL値が入力されている事を指示します。\r
 169         2.URLエンド - i_cに0を指定して、URLが完了した事を指示します。\r
 170 */\r
 171 typedef NyLPC_TBool (*NyLPC_cHttpBasicHeaderParser_urlHandler) (NyLPC_TcHttpBasicHeaderParser_t* i_inst,NyLPC_TChar i_c,struct NyLPC_THttpBasicHeader* o_out);\r
 172 \r
 173 \r
 174 \r
 175 struct NyLPC_TcHttpBasicHeaderParser_Handler\r
 176 {\r
 177         NyLPC_cHttpBasicHeaderParser_messageHandler messageHandler;\r
 178         NyLPC_cHttpBasicHeaderParser_urlHandler urlHandler;\r
 179 };\r
 180 \r
 181 \r
 182 \r
 183 /**\r
 184  * クラス構造体\r
 185  */\r
 186 struct NyLPC_TcHttpBasicHeaderParser\r
 187 {\r
 188         /**継承クラスで実装すべきインタフェイス*/\r
 189         const struct NyLPC_TcHttpBasicHeaderParser_Handler* _handler;\r
 190         NyLPC_TUInt16 _rcode;//_stがERRORの時にエラーコードを格納する。\r
 191         /** パースの実行状態*/\r
 192         NyLPC_TcHttpBasicHeaderParser_ST _st;\r
 193         /**ワーク文字列*/\r
 194         NyLPC_TcStr_t _wsb;\r
 195         /**ワーク文字列のバッファ*/\r
 196         char _wsb_buf[NyLPC_cHttpBasicHeaderParser_SIZE_OF_WBS];\r
 197 };\r
 198 \r
 199 \r
 200 void NyLPC_cHttpBasicHeaderParser_initialize(NyLPC_TcHttpBasicHeaderParser_t* i_inst,const struct NyLPC_TcHttpBasicHeaderParser_Handler* i_handler);\r
 201 #define NyLPC_cHttpBasicHeaderParser_finalize(i_inst)\r
 202 \r
 203 /**\r
 204  * パーサの開始処理をします。\r
 205  * 関数は、parseInit->parseChar[n回]->(parseStream)->parseFinishの順でコールします。\r
 206  * parseChar、又はparseStreamでエラーが発生した場合は、後続の関数を呼び出すことは出来ません。\r
 207  * parseCharでEOHに達した場合、parseCharまたはparseStreamを続けて呼ぶことは出来ません。\r
 208  * parseFinishはparseCharまたはparseStreamでEOHに達した場合のみ呼び出すことが出来ます。\r
 209  */\r
 210 void NyLPC_cHttpBasicHeaderParser_parseInit(NyLPC_TcHttpBasicHeaderParser_t* i_inst,struct NyLPC_THttpBasicHeader* o_out);\r
 211 \r
 212 /**\r
 213  * パーサの処理を閉じます。\r
 214  * @return\r
 215  * パース処理が正常に終了したかの真偽値\r
 216  */\r
 217 NyLPC_TBool NyLPC_cHttpBasicHeaderParser_parseFinish(NyLPC_TcHttpBasicHeaderParser_t* i_inst,struct NyLPC_THttpBasicHeader* o_out);\r
 218 \r
 219 /**\r
 220  * 文字列をパースします。\r
 221  * コール前にNyLPC_cHttpBasicHeaderParser_parseInitでパーサを開始してください。\r
 222  * @return\r
 223  * パースした文字数。エラーの場合-1です。\r
 224  * 0以上の場合、getParseStatusでパーサの状態を確認してください。\r
 225  */\r
 226 NyLPC_TInt32 NyLPC_cHttpBasicHeaderParser_parseChar(NyLPC_TcHttpBasicHeaderParser_t* i_inst,const NyLPC_TChar* i_c,NyLPC_TInt32 i_size,struct NyLPC_THttpBasicHeader* o_out);\r
 227 \r
 228 \r
 229 /**\r
 230  * ストリームから読み出して、EOHに達するまでパースします。\r
 231  * コール前にNyLPC_cHttpBasicHeaderParser_parseInitでパーサを開始してください。\r
 232  * @return\r
 233  * 処理が正常に終了したかを返します。\r
 234  * TRUEの場合、ステータスはEOHに達しています。(parseFinishをコールできます。)\r
 235  */\r
 236 NyLPC_TBool NyLPC_cHttpBasicHeaderParser_parseStream(NyLPC_TcHttpBasicHeaderParser_t* i_inst,NyLPC_TcHttpStream_t* i_stream,struct NyLPC_THttpBasicHeader* o_out);\r
 237 \r
 238 \r
 239 /**\r
 240  * parse関数がエラーの場合に、\r
 241  * 候補のエラーのステータスコードを返す。\r
 242  */\r
 243 #define NyLPC_cHttpBasicHeaderParser_getStatusCode(inst) ((inst)->_rcode)\r
 244 \r
 245 #ifdef __cplusplus\r
 246 }\r
 247 #endif /* __cplusplus */\r
 248 \r
 249 #endif\r