utvpn/utvpn-unix-v101-7101-public/src/Cedar/Console.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 // Console.h\r
  79 // Console.c のヘッダ\r
  80 \r
  81 #ifndef CONSOLE_H\r
  82 #define CONSOLE_H\r
  83 \r
  84 // 定数\r
  85 #define MAX_PROMPT_STRSIZE                      65536\r
  86 #define WIN32_DEFAULT_CONSOLE_WIDTH     100\r
  87 \r
  88 // コンソールの種類\r
  89 #define CONSOLE_LOCAL                           0       // ローカルコンソール\r
  90 #define CONSOLE_CSV                                     1       // CSV 出力モード\r
  91 \r
  92 // パラメータ補完プロンプト関数\r
  93 typedef wchar_t *(PROMPT_PROC)(CONSOLE *c, void *param);\r
  94 \r
  95 // パラメータ検証プロンプト関数\r
  96 typedef bool (EVAL_PROC)(CONSOLE *c, wchar_t *str, void *param);\r
  97 \r
  98 // パラメータ項目の定義\r
  99 struct PARAM\r
 100 {\r
 101         char *Name;                                     // パラメータ名\r
 102         PROMPT_PROC *PromptProc;        // パラメータが指定されていない場合に自動的に呼び出す\r
 103                                                                 // プロンプト関数 (NULL の場合は呼ばない)\r
 104         void *PromptProcParam;          // プロンプト関数に渡す任意のポインタ\r
 105         EVAL_PROC *EvalProc;            // パラメータ文字列検証関数\r
 106         void *EvalProcParam;            // 検証関数に渡す任意のポインタ\r
 107         char *Tmp;                                      // 一時変数\r
 108 };\r
 109 \r
 110 // パラメータ値内部データ\r
 111 struct PARAM_VALUE\r
 112 {\r
 113         char *Name;                                     // 名前\r
 114         char *StrValue;                         // 文字列値\r
 115         wchar_t *UniStrValue;           // Unicode 文字列値\r
 116         UINT IntValue;                          // 整数値\r
 117 };\r
 118 \r
 119 // コンソールサービス構造体\r
 120 struct CONSOLE\r
 121 {\r
 122         UINT ConsoleType;                                                                               // コンソールの種類\r
 123         UINT RetCode;                                                                                   // 最後の終了コード\r
 124         void *Param;                                                                                    // 任意のデータ\r
 125         void (*Free)(CONSOLE *c);                                                               // 解放関数\r
 126         wchar_t *(*ReadLine)(CONSOLE *c, wchar_t *prompt, bool nofile);         // 1 行読み込む関数\r
 127         char *(*ReadPassword)(CONSOLE *c, wchar_t *prompt);             // パスワードを読み込む関数\r
 128         bool (*Write)(CONSOLE *c, wchar_t *str);                                // 文字列を書き出す関数\r
 129         UINT (*GetWidth)(CONSOLE *c);                                                   // 画面の横幅の取得\r
 130 };\r
 131 \r
 132 // ローカルコンソールパラメータ\r
 133 struct LOCAL_CONSOLE_PARAM\r
 134 {\r
 135         IO *InFile;             // 入力ファイル\r
 136         BUF *InBuf;             // 入力バッファ\r
 137         IO *OutFile;    // 出力ファイル\r
 138         UINT Win32_OldConsoleWidth;     // 以前のコンソールサイズ\r
 139 };\r
 140 \r
 141 // コマンドプロシージャ\r
 142 typedef UINT (COMMAND_PROC)(CONSOLE *c, char *cmd_name, wchar_t *str, void *param);\r
 143 \r
 144 // コマンドの定義\r
 145 struct CMD\r
 146 {\r
 147         char *Name;                             // コマンド名\r
 148         COMMAND_PROC *Proc;             // プロシージャ関数\r
 149 };\r
 150 \r
 151 // パラメータの最小 / 最大値評価\r
 152 struct CMD_EVAL_MIN_MAX\r
 153 {\r
 154         char *StrName;\r
 155         UINT MinValue, MaxValue;\r
 156 };\r
 157 \r
 158 \r
 159 // 関数プロトタイプ\r
 160 wchar_t *Prompt(wchar_t *prompt_str);\r
 161 char *PromptA(wchar_t *prompt_str);\r
 162 bool PasswordPrompt(char *password, UINT size);\r
 163 void *SetConsoleRaw();\r
 164 void RestoreConsole(void *p);\r
 165 wchar_t *ParseCommandEx(wchar_t *str, wchar_t *name, TOKEN_LIST **param_list);\r
 166 wchar_t *ParseCommand(wchar_t *str, wchar_t *name);\r
 167 TOKEN_LIST *GetCommandNameList(wchar_t *str);\r
 168 char *ParseCommandA(wchar_t *str, char *name);\r
 169 LIST *NewParamValueList();\r
 170 int CmpParamValue(void *p1, void *p2);\r
 171 void FreeParamValueList(LIST *o);\r
 172 PARAM_VALUE *FindParamValue(LIST *o, char *name);\r
 173 char *GetParamStr(LIST *o, char *name);\r
 174 wchar_t *GetParamUniStr(LIST *o, char *name);\r
 175 UINT GetParamInt(LIST *o, char *name);\r
 176 bool GetParamYes(LIST *o, char *name);\r
 177 LIST *ParseCommandList(CONSOLE *c, char *cmd_name, wchar_t *command, PARAM param[], UINT num_param);\r
 178 bool IsNameInRealName(char *input_name, char *real_name);\r
 179 void GetOmissionName(char *dst, UINT size, char *src);\r
 180 bool IsOmissionName(char *input_name, char *real_name);\r
 181 TOKEN_LIST *GetRealnameCandidate(char *input_name, TOKEN_LIST *real_name_list);\r
 182 bool SeparateCommandAndParam(wchar_t *src, char **cmd, wchar_t **param);\r
 183 UINT GetConsoleWidth(CONSOLE *c);\r
 184 bool DispatchNextCmd(CONSOLE *c, char *prompt, CMD cmd[], UINT num_cmd, void *param);\r
 185 bool DispatchNextCmdEx(CONSOLE *c, wchar_t *exec_command, char *prompt, CMD cmd[], UINT num_cmd, void *param);\r
 186 void PrintCandidateHelp(CONSOLE *c, char *cmd_name, TOKEN_LIST *candidate_list, UINT left_space);\r
 187 UNI_TOKEN_LIST *SeparateStringByWidth(wchar_t *str, UINT width);\r
 188 void GetCommandHelpStr(char *command_name, wchar_t **description, wchar_t **args, wchar_t **help);\r
 189 void GetCommandParamHelpStr(char *command_name, char *param_name, wchar_t **description);\r
 190 bool CmdEvalMinMax(CONSOLE *c, wchar_t *str, void *param);\r
 191 wchar_t *CmdPrompt(CONSOLE *c, void *param);\r
 192 bool CmdEvalNotEmpty(CONSOLE *c, wchar_t *str, void *param);\r
 193 bool CmdEvalInt1(CONSOLE *c, wchar_t *str, void *param);\r
 194 bool CmdEvalIsFile(CONSOLE *c, wchar_t *str, void *param);\r
 195 bool CmdEvalSafe(CONSOLE *c, wchar_t *str, void *param);\r
 196 void PrintCmdHelp(CONSOLE *c, char *cmd_name, TOKEN_LIST *param_list);\r
 197 int CompareCandidateStr(void *p1, void *p2);\r
 198 bool IsHelpStr(char *str);\r
 199 \r
 200 CONSOLE *NewLocalConsole(wchar_t *infile, wchar_t *outfile);\r
 201 void ConsoleLocalFree(CONSOLE *c);\r
 202 wchar_t *ConsoleLocalReadLine(CONSOLE *c, wchar_t *prompt, bool nofile);\r
 203 char *ConsoleLocalReadPassword(CONSOLE *c, wchar_t *prompt);\r
 204 bool ConsoleLocalWrite(CONSOLE *c, wchar_t *str);\r
 205 void ConsoleWriteOutFile(CONSOLE *c, wchar_t *str, bool add_last_crlf);\r
 206 wchar_t *ConsoleReadNextFromInFile(CONSOLE *c);\r
 207 UINT ConsoleLocalGetWidth(CONSOLE *c);\r
 208 \r
 209 \r
 210 #endif  // CONSOLE_H\r
 211 \r
 212 \r
 213 \r