Dev/utvpn/utvpn-unix-v101-7101-public/src/Mayaqua/Cfg.h

   1 // SoftEther UT-VPN SourceCode\r
   2 // \r
   3 // Copyright (C) 2004-2010 SoftEther Corporation.\r
   4 // Copyright (C) 2004-2010 University of Tsukuba, Japan.\r
   5 // Copyright (C) 2003-2010 Daiyuu Nobori.\r
   6 // All Rights Reserved.\r
   7 // \r
   8 // http://utvpn.tsukuba.ac.jp/\r
   9 // \r
  10 // This program is free software; you can redistribute it and/or\r
  11 // modify it under the terms of the GNU General Public License\r
  12 // version 2 as published by the Free Software Foundation.\r
  13 // \r
  14 // This program is distributed in the hope that it will be useful,\r
  15 // but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
  17 // GNU General Public License for more details.\r
  18 // \r
  19 // You should have received a copy of the GNU General Public License version 2\r
  20 // along with this program; if not, write to the Free Software\r
  21 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\r
  22 // \r
  23 // このファイルは GPL バージョン 2 ライセンスで公開されています。\r
  24 // 誰でもこのファイルの内容を複製、改変したり、改変したバージョンを再配布\r
  25 // することができます。ただし、原著作物を改変した場合は、原著作物の著作権表示\r
  26 // を除去することはできません。改変した著作物を配布する場合は、改変実施者の\r
  27 // 著作権表示を原著作物の著作権表示に付随して記載するようにしてください。\r
  28 // \r
  29 // この SoftEther UT-VPN オープンソース・プロジェクトは、日本国の\r
  30 // ソフトイーサ株式会社 (SoftEther Corporation, http://www.softether.co.jp/ )\r
  31 // および筑波大学 (University of Tsukuba, http://www.tsukuba.ac.jp/ ) によって\r
  32 // ホストされています。\r
  33 // 本プログラムの配布者は、本プログラムを、業としての利用以外のため、\r
  34 // および、試験または研究のために利用が行われることを想定して配布\r
  35 // しています。\r
  36 // SoftEther UT-VPN プロジェクトの Web サイトは http://utvpn.tsukuba.ac.jp/ に\r
  37 // あります。\r
  38 // 本ソフトウェアの不具合の修正、機能改良、セキュリティホールの修復などのコード\r
  39 // の改変を行った場合で、その成果物を SoftEther UT-VPN プロジェクトに提出して\r
  40 // いただける場合は、 http://utvpn.tsukuba.ac.jp/ までソースコードを送付して\r
  41 // ください。SoftEther UT-VPN プロジェクトの本体リリースまたはブランチリリース\r
  42 // に組み込みさせていただきます。\r
  43 // \r
  44 // GPL に基づいて原著作物が提供される本ソフトウェアの改良版を配布、販売する\r
  45 // 場合は、そのソースコードを GPL に基づいて誰にでも開示する義務が生じます。\r
  46 // \r
  47 // 本ソフトウェアに関連する著作権、特許権、商標権はソフトイーサ株式会社\r
  48 // (SoftEther Corporation) およびその他の著作権保持者が保有しています。\r
  49 // ソフトイーサ株式会社等はこれらの権利を放棄していません。本ソフトウェアの\r
  50 // 二次著作物を配布、販売する場合は、これらの権利を侵害しないようにご注意\r
  51 // ください。\r
  52 // \r
  53 // お願い: どのような通信ソフトウェアにも通常は必ず未発見の\r
  54 // セキュリティホールが潜んでいます。本ソースコードをご覧いただいた結果、\r
  55 // UT-VPN にセキュリティホールを発見された場合は、当該セキュリティホールの\r
  56 // 情報を不特定多数に開示される前に、必ず、ソフトイーサ株式会社\r
  57 // および脆弱性情報の届出を受け付ける公的機関まで通報いただき、\r
  58 // 公益保護にご協力いただきますようお願い申し上げます。\r
  59 // \r
  60 // ソフトイーサ株式会社は、当該セキュリティホールについて迅速に対処を\r
  61 // 行い、UT-VPN および UT-VPN に関連するソフトウェアのユーザー・顧客\r
  62 // を保護するための努力を行います。\r
  63 // \r
  64 // ソフトイーサへの届出先: http://www.softether.co.jp/jp/contact/\r
  65 // 日本国内の脆弱性情報届出受付公的機関:\r
  66 //         独立行政法人 情報処理推進機構\r
  67 //         http://www.ipa.go.jp/security/vuln/report/\r
  68 // \r
  69 // 上記各事項について不明な点は、ソフトイーサ株式会社までご連絡ください。\r
  70 // 連絡先: http://www.softether.co.jp/jp/contact/\r
  71 \r
  72 // -----------------------------------------------\r
  73 // [ChangeLog]\r
  74 // 2010.05.20\r
  75 //  新規リリース by SoftEther\r
  76 // -----------------------------------------------\r
  77 \r
  78 // Cfg.h\r
  79 // Cfg.c のヘッダ\r
  80 \r
  81 #ifndef CFG_H\r
  82 #define CFG_H\r
  83 \r
  84 // マクロ\r
  85 //#define       CHECK_CFG_NAME_EXISTS                   // 既存の名前との重複チェックを行う\r
  86 \r
  87 #define SAVE_BINARY_FILE_NAME_SWITCH    L"@save_binary"\r
  88 \r
  89 // 定数\r
  90 #define TAG_DECLARE                     "declare"\r
  91 #define TAG_STRING                      "string"\r
  92 #define TAG_INT                         "uint"\r
  93 #define TAG_INT64                       "uint64"\r
  94 #define TAG_BOOL                        "bool"\r
  95 #define TAG_BYTE                        "byte"\r
  96 #define TAG_TRUE                        "true"\r
  97 #define TAG_FALSE                       "false"\r
  98 #define TAG_END                         "end"\r
  99 #define TAG_ROOT                        "root"\r
 100 \r
 101 #define TAG_CPYRIGHT            "\xef\xbb\xbf# SoftEther UT-VPN Software Configuration File\r\n# \r\n# You can edit this file when the program is not working.\r\n# \r\n"\r
 102 #define TAG_BINARY                      "SEVPN_DB"\r
 103 \r
 104 // データ型\r
 105 #define ITEM_TYPE_INT           1               // int\r
 106 #define ITEM_TYPE_INT64         2               // int64\r
 107 #define ITEM_TYPE_BYTE          3               // byte\r
 108 #define ITEM_TYPE_STRING        4               // string\r
 109 #define ITEM_TYPE_BOOL          5               // bool\r
 110 \r
 111 // フォルダ\r
 112 struct FOLDER\r
 113 {\r
 114         char *Name;                             // フォルダ名\r
 115         LIST *Items;                    // アイテムのリスト\r
 116         LIST *Folders;                  // サブフォルダ\r
 117         struct FOLDER *Parent;  // 親フォルダ\r
 118 };\r
 119 \r
 120 // アイテム\r
 121 struct ITEM\r
 122 {\r
 123         char *Name;                             // アイテム名\r
 124         UINT Type;                              // データ型\r
 125         void *Buf;                              // データ\r
 126         UINT size;                              // データサイズ\r
 127         FOLDER *Parent;                 // 親フォルダ\r
 128 };\r
 129 \r
 130 // 設定ファイルリーダライタ\r
 131 struct CFG_RW\r
 132 {\r
 133         LOCK *lock;                             // ロック\r
 134         char *FileName;                 // ファイル名 (ANSI)\r
 135         wchar_t *FileNameW;             // ファイル名 (Unicode)\r
 136         IO *Io;                                 // IO\r
 137         UCHAR LashHash[SHA1_SIZE];      // 最後に書き込んだハッシュ値\r
 138         bool DontBackup;                // バックアップを使用しない\r
 139 };\r
 140 \r
 141 typedef bool (*ENUM_FOLDER)(FOLDER *f, void *param);\r
 142 typedef bool (*ENUM_ITEM)(ITEM *t, void *param);\r
 143 \r
 144 // 列挙用のパラメータ\r
 145 struct CFG_ENUM_PARAM\r
 146 {\r
 147         BUF *b;\r
 148         FOLDER *f;\r
 149         UINT depth;\r
 150 };\r
 151 \r
 152 int CmpItemName(void *p1, void *p2);\r
 153 int CmpFolderName(void *p1, void *p2);\r
 154 ITEM *CfgCreateItem(FOLDER *parent, char *name, UINT type, void *buf, UINT size);\r
 155 void CfgDeleteFolder(FOLDER *f);\r
 156 FOLDER *CfgCreateFolder(FOLDER *parent, char *name);\r
 157 void CfgEnumFolder(FOLDER *f, ENUM_FOLDER proc, void *param);\r
 158 TOKEN_LIST *CfgEnumFolderToTokenList(FOLDER *f);\r
 159 TOKEN_LIST *CfgEnumItemToTokenList(FOLDER *f);\r
 160 void CfgEnumItem(FOLDER *f, ENUM_ITEM proc, void *param);\r
 161 FOLDER *CfgFindFolder(FOLDER *parent, char *name);\r
 162 ITEM *CfgFindItem(FOLDER *parent, char *name);\r
 163 ITEM *CfgAddInt(FOLDER *f, char *name, UINT i);\r
 164 ITEM *CfgAddBool(FOLDER *f, char *name, bool b);\r
 165 ITEM *CfgAddInt64(FOLDER *f, char *name, UINT64 i);\r
 166 ITEM *CfgAddByte(FOLDER *f, char *name, void *buf, UINT size);\r
 167 ITEM *CfgAddBuf(FOLDER *f, char *name, BUF *b);\r
 168 ITEM *CfgAddStr(FOLDER *f, char *name, char *str);\r
 169 ITEM *CfgAddUniStr(FOLDER *f, char *name, wchar_t *str);\r
 170 FOLDER *CfgGetFolder(FOLDER *parent, char *name);\r
 171 UINT CfgGetInt(FOLDER *f, char *name);\r
 172 bool CfgGetBool(FOLDER *f, char *name);\r
 173 UINT64 CfgGetInt64(FOLDER *f, char *name);\r
 174 UINT CfgGetByte(FOLDER *f, char *name, void *buf, UINT size);\r
 175 BUF *CfgGetBuf(FOLDER *f, char *name);\r
 176 bool CfgGetStr(FOLDER *f, char *name, char *str, UINT size);\r
 177 bool CfgGetUniStr(FOLDER *f, char *name, wchar_t *str, UINT size);\r
 178 bool CfgIsItem(FOLDER *f, char *name);\r
 179 bool CfgIsFolder(FOLDER *f, char *name);\r
 180 void CfgTest();\r
 181 void CfgTest2(FOLDER *f, UINT n);\r
 182 char *CfgEscape(char *name);\r
 183 bool CfgCheckCharForName(char c);\r
 184 char *CfgUnescape(char *str);\r
 185 BUF *CfgFolderToBuf(FOLDER *f, bool textmode);\r
 186 BUF *CfgFolderToBufEx(FOLDER *f, bool textmode, bool no_banner);\r
 187 BUF *CfgFolderToBufText(FOLDER *f);\r
 188 BUF *CfgFolderToBufTextEx(FOLDER *f, bool no_banner);\r
 189 BUF *CfgFolderToBufBin(FOLDER *f);\r
 190 void CfgOutputFolderText(BUF *b, FOLDER *f, UINT depth);\r
 191 void CfgOutputFolderBin(BUF *b, FOLDER *f);\r
 192 void CfgAddLine(BUF *b, char *str, UINT depth);\r
 193 void CfgAddDeclare(BUF *b, char *name, UINT depth);\r
 194 void CfgAddEnd(BUF *b, UINT depth);\r
 195 void CfgAddData(BUF *b, UINT type, char *name, char *data, char *sub, UINT depth);\r
 196 UINT CfgStrToType(char *str);\r
 197 char *CfgTypeToStr(UINT type);\r
 198 void CfgAddItemText(BUF *b, ITEM *t, UINT depth);\r
 199 bool CfgEnumFolderProc(FOLDER *f, void *param);\r
 200 bool CfgEnumItemProc(ITEM *t, void *param);\r
 201 FOLDER *CfgBufTextToFolder(BUF *b);\r
 202 FOLDER *CfgBufBinToFolder(BUF *b);\r
 203 void CfgReadNextFolderBin(BUF *b, FOLDER *parent);\r
 204 char *CfgReadNextLine(BUF *b);\r
 205 bool CfgReadNextTextBuf(BUF *b, FOLDER *current);\r
 206 void CfgSave(FOLDER *f, char *name);\r
 207 void CfgSaveW(FOLDER *f, wchar_t *name);\r
 208 bool CfgSaveEx(CFG_RW *rw, FOLDER *f, char *name);\r
 209 bool CfgSaveExW(CFG_RW *rw, FOLDER *f, wchar_t *name);\r
 210 bool CfgSaveExW2(CFG_RW *rw, FOLDER *f, wchar_t *name, UINT *written_size);\r
 211 FOLDER *CfgRead(char *name);\r
 212 FOLDER *CfgReadW(wchar_t *name);\r
 213 FOLDER *CfgCreateRoot();\r
 214 void CfgTest();\r
 215 void CfgTest2(FOLDER *f, UINT n);\r
 216 CFG_RW *NewCfgRw(FOLDER **root, char *cfg_name);\r
 217 CFG_RW *NewCfgRwW(FOLDER **root, wchar_t *cfg_name);\r
 218 CFG_RW *NewCfgRwEx(FOLDER **root, char *cfg_name, bool dont_backup);\r
 219 CFG_RW *NewCfgRwExW(FOLDER **root, wchar_t *cfg_name, bool dont_backup);\r
 220 UINT SaveCfgRw(CFG_RW *rw, FOLDER *f);\r
 221 void FreeCfgRw(CFG_RW *rw);\r
 222 ITEM *CfgAddIp32(FOLDER *f, char *name, UINT ip);\r
 223 UINT CfgGetIp32(FOLDER *f, char *name);\r
 224 bool CfgGetIp6Addr(FOLDER *f, char *name, IPV6_ADDR *addr);\r
 225 ITEM *CfgAddIp6Addr(FOLDER *f, char *name, IPV6_ADDR *addr);\r
 226 bool FileCopy(char *src, char *dst);\r
 227 bool FileCopyW(wchar_t *src, wchar_t *dst);\r
 228 void BackupCfg(FOLDER *f, char *original);\r
 229 void BackupCfgW(FOLDER *f, wchar_t *original);\r
 230 \r
 231 #if     (!defined(CFG_C)) || (!defined(OS_UNIX))\r
 232 bool CfgGetIp(FOLDER *f, char *name, struct IP *ip);\r
 233 ITEM *CfgAddIp(FOLDER *f, char *name, struct IP *ip);\r
 234 #endif\r
 235 \r
 236 #endif  // CFG_H\r
 237 \r
 238 \r
 239 \r