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_TcHttpBasicHeaderParser_H\r
  28 #define NyLPC_TcHttpBasicHeaderParser_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 const char* NyLPC_THttpMethodType_toString(NyLPC_THttpMethodType i_method);\r
  75 \r
  76 /**\r
  77  * HTTPバージョンの定義値\r
  78  */\r
  79 typedef NyLPC_TUInt8 NyLPC_THttpVersion;\r
  80 #define NyLPC_THttpVersion_09           ((NyLPC_THttpVersion)0x01)\r
  81 #define NyLPC_THttpVersion_10           ((NyLPC_THttpVersion)0x02)\r
  82 #define NyLPC_THttpVersion_11           ((NyLPC_THttpVersion)0x03)\r
  83 #define NyLPC_THttpVersion_UNKNOWN      ((NyLPC_THttpVersion)0x04)\r
  84 \r
  85 \r
  86 typedef NyLPC_TUInt8 NyLPC_THttpHeaderType;\r
  87 #define NyLPC_THttpHeaderType_REQUEST  ((NyLPC_THttpHeaderType)0x01)\r
  88 #define NyLPC_THttpHeaderType_RESPONSE ((NyLPC_THttpHeaderType)0x02)\r
  89 \r
  90 \r
  91 typedef NyLPC_TUInt8 NyLPC_THttpMessgeHeader_Connection;\r
  92 #define NyLPC_THttpMessgeHeader_Connection_NONE  ((NyLPC_THttpMessgeHeader_Connection)0x01)\r
  93 #define NyLPC_THttpMessgeHeader_Connection_CLOSE ((NyLPC_THttpMessgeHeader_Connection)0x02)\r
  94 #define NyLPC_THttpMessgeHeader_Connection_KEEPALIVE ((NyLPC_THttpMessgeHeader_Connection)0x03)\r
  95 #define NyLPC_THttpMessgeHeader_Connection_UNKNOWN ((NyLPC_THttpMessgeHeader_Connection)0x10)\r
  96 \r
  97 typedef NyLPC_TUInt8 NyLPC_THttpMessgeHeader_TransferEncoding;\r
  98 #define NyLPC_THttpMessgeHeader_TransferEncoding_NONE    ((NyLPC_THttpMessgeHeader_TransferEncoding)0x01)       //TEはない\r
  99 #define NyLPC_THttpMessgeHeader_TransferEncoding_CHUNKED ((NyLPC_THttpMessgeHeader_TransferEncoding)0x02)\r
 100 #define NyLPC_THttpMessgeHeader_TransferEncoding_UNKNOWN ((NyLPC_THttpMessgeHeader_TransferEncoding)0x10)\r
 101 \r
 102 #define NyLPC_THttpContentLength_INVALID_LENGTH 0xFFFFFFFF\r
 103 \r
 104 \r
 105 \r
 106 \r
 107 \r
 108 /**\r
 109  * この構造体は、NyLPC_cHttpBasicHeaderParserの結果を格納します。\r
 110  */\r
 111 struct NyLPC_THttpBasicHeader\r
 112 {\r
 113         NyLPC_THttpHeaderType type;\r
 114         union{\r
 115                 struct{\r
 116                         NyLPC_THttpVersion version;\r
 117                         NyLPC_THttpMethodType method;\r
 118                 }req;\r
 119                 struct{\r
 120                         NyLPC_THttpVersion version;\r
 121                         NyLPC_TUInt32 status;\r
 122                 }res;\r
 123         }startline;\r
 124         NyLPC_THttpMessgeHeader_TransferEncoding transfer_encoding;\r
 125         NyLPC_TUInt32 content_length;\r
 126         NyLPC_THttpMessgeHeader_Connection connection;\r
 127 };\r
 128 \r
 129 /**\r
 130  * このヘッダが持続性接続を求めているか判定します。\r
 131  */\r
 132 NyLPC_TBool NyLPC_THttpBasicHeader_isPersistent(const struct NyLPC_THttpBasicHeader* i_struct);\r
 133 \r
 134 \r
 135 \r
 136 \r
 137 \r
 138 \r
 139 /**\r
 140  * コンフィギュレーション値。\r
 141  * ショートパラメータ解析バッファのサイズ\r
 142  */\r
 143 #define NyLPC_cHttpBasicHeaderParser_SIZE_OF_WBS 32\r
 144 \r
 145 \r
 146 \r
 147 \r
 148 /**\r
 149  * 独自のメッセージフィールドを受け取るイベントハンドラです。\r
 150  * メッセージハンドラはNyLPC_cHttpBasicHeaderParserから３種類のメッセージを受け取ります。\r
 151  * ハンドラは、NyLPC_TcHttpBasicHeaderParserが処理しないメッセージヘッダをパース中に、次の順番で呼び出されます。\r
 152  * <ol>\r
 153  * <li>開始メッセージ - i_nameに有効な文字列を指定して、そのフィールド値が入力される事を伝えます。i_cはnullです。\r
 154  * <li>フィールドメッセージ - i_nameにNULL,i_cに\0以外の文字を指定して、フィールド値が入力されている事を指示します。\r
 155  * <li>フィールドエンド - i_nameにNULL,i_cに0を指定して、フィールドが完了した事を指示します。\r
 156  * </ol>\r
 157 */\r
 158 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
 159 /**\r
 160  * リクエストのURL文字列を受け取るイベントハンドラです。\r
 161  * メッセージハンドラはNyLPC_cHttpBasicHeaderParserから３種類のメッセージを受け取ります。\r
 162  * ハンドラは、NyLPC_TcHttpBasicHeaderParserが処理しないメッセージヘッダをパース中に、次の順番で呼び出されます。\r
 163  * <ol>\r
 164  * <li>URLメッセージ - i_cに\0以外の文字を指定して、URL値が入力されている事を指示します。\r
 165  * <li>URLエンド - i_cに0を指定して、URLが完了した事を指示します。\r
 166  * </ol>\r
 167 */\r
 168 typedef NyLPC_TBool (*NyLPC_cHttpBasicHeaderParser_urlHandler) (NyLPC_TcHttpBasicHeaderParser_t* i_inst,NyLPC_TChar i_c,struct NyLPC_THttpBasicHeader* o_out);\r
 169 \r
 170 \r
 171 \r
 172 /**\r
 173  * HTTPヘッダパーサハンドラの集合です。\r
 174  * ハンドラにNULL指定の場合TRUEを返したと見なします。\r
 175  */\r
 176 struct NyLPC_TcHttpBasicHeaderParser_Handler\r
 177 {\r
 178         NyLPC_cHttpBasicHeaderParser_messageHandler messageHandler;\r
 179         NyLPC_cHttpBasicHeaderParser_urlHandler urlHandler;\r
 180 };\r
 181 \r
 182 \r
 183 \r
 184 /**\r
 185  * クラス構造体\r
 186  */\r
 187 struct NyLPC_TcHttpBasicHeaderParser\r
 188 {\r
 189         /**継承クラスで実装すべきインタフェイス*/\r
 190         const struct NyLPC_TcHttpBasicHeaderParser_Handler* _handler;\r
 191         NyLPC_TUInt16 _rcode;//_stがERRORの時にエラーコードを格納する。\r
 192         /** パースの実行状態*/\r
 193         NyLPC_TcHttpBasicHeaderParser_ST _st;\r
 194         /**ワーク文字列*/\r
 195         NyLPC_TcStr_t _wsb;\r
 196         /**ワーク文字列のバッファ*/\r
 197         char _wsb_buf[NyLPC_cHttpBasicHeaderParser_SIZE_OF_WBS];\r
 198 };\r
 199 \r
 200 \r
 201 void NyLPC_cHttpBasicHeaderParser_initialize(NyLPC_TcHttpBasicHeaderParser_t* i_inst,const struct NyLPC_TcHttpBasicHeaderParser_Handler* i_handler);\r
 202 #define NyLPC_cHttpBasicHeaderParser_finalize(i_inst)\r
 203 \r
 204 /**\r
 205  * パーサの開始処理をします。\r
 206  * 関数は、parseInit->parseChar[n回]->(parseStream)->parseFinishの順でコールします。\r
 207  * parseChar、又はparseStreamでエラーが発生した場合は、後続の関数を呼び出すことは出来ません。\r
 208  * parseCharでEOHに達した場合、parseCharまたはparseStreamを続けて呼ぶことは出来ません。\r
 209  * parseFinishはparseCharまたはparseStreamでEOHに達した場合のみ呼び出すことが出来ます。\r
 210  */\r
 211 void NyLPC_cHttpBasicHeaderParser_parseInit(NyLPC_TcHttpBasicHeaderParser_t* i_inst,struct NyLPC_THttpBasicHeader* o_out);\r
 212 \r
 213 /**\r
 214  * パーサの処理を閉じます。\r
 215  * @return\r
 216  * パース処理が正常に終了したかの真偽値\r
 217  */\r
 218 NyLPC_TBool NyLPC_cHttpBasicHeaderParser_parseFinish(NyLPC_TcHttpBasicHeaderParser_t* i_inst,struct NyLPC_THttpBasicHeader* o_out);\r
 219 \r
 220 /**\r
 221  * 文字列をパースします。\r
 222  * コール前にNyLPC_cHttpBasicHeaderParser_parseInitでパーサを開始してください。\r
 223  * @return\r
 224  * パースした文字数。エラーの場合-1です。\r
 225  * 0以上の場合、getParseStatusでパーサの状態を確認してください。\r
 226  */\r
 227 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
 228 \r
 229 \r
 230 /**\r
 231  * ストリームから読み出して、EOHに達するまでパースします。\r
 232  * コール前にNyLPC_cHttpBasicHeaderParser_parseInitでパーサを開始してください。\r
 233  * @return\r
 234  * 処理が正常に終了したかを返します。\r
 235  * TRUEの場合、ステータスはEOHに達しています。(parseFinishをコールできます。)\r
 236  */\r
 237 NyLPC_TBool NyLPC_cHttpBasicHeaderParser_parseStream(NyLPC_TcHttpBasicHeaderParser_t* i_inst,NyLPC_TiHttpPtrStream_t* i_stream,struct NyLPC_THttpBasicHeader* o_out);\r
 238 \r
 239 \r
 240 /**\r
 241  * parse関数がエラーの場合に、\r
 242  * 候補のエラーのステータスコードを返す。\r
 243  */\r
 244 #define NyLPC_cHttpBasicHeaderParser_getStatusCode(inst) ((inst)->_rcode)\r
 245 \r
 246 #ifdef __cplusplus\r
 247 }\r
 248 #endif /* __cplusplus */\r
 249 \r
 250 #endif\r