Ethna.php

   1 <?php
   2 // vim: foldmethod=marker
   3 /**
   4  *  Ethna.php
   5  *
   6  *  @author     Masaki Fujimoto <fujimoto@php.net>
   7  *  @license    http://www.opensource.org/licenses/bsd-license.php The BSD License
   8  *  @package    Ethna
   9  *  @version    $Id$
  10  */
  11
  12 //
  13 //  PEAR OS_WINDOWS constant replacement.
  14 //
  15 //  PEAR の OS_WINDOWS 定数は、defined関数で
  16 //  既に定義されているかをチェックしていない。
  17 //  よって require_once 'PEAR.php' とすると
  18 //  E_NOTICEが出ることから、Windows環境判定用
  19 //  として独自の定数を定義する
  20 //
  21 if (substr(PHP_OS, 0, 3) == 'WIN'
  22  && !defined('ETHNA_OS_WINDOWS')) {
  23     define('ETHNA_OS_WINDOWS', true);
  24 } elseif (!defined('ETHNA_OS_WINDOWS')) {
  25     define('ETHNA_OS_WINDOWS', false);
  26 }
  27 //  PHP 5.1.0 以降向けの変更
  28 //  date.timezone が設定されていないと
  29 //  E_STRICT|WARNING が発生する
  30 if (!ini_get('date.timezone')) {
  31     ini_set('date.timezone', 'Asia/Tokyo');
  32 }
  33
  34 if (!defined('PATH_SEPARATOR')) {
  35     if (ETHNA_OS_WINDOWS) {
  36         /** include_path separator(Windows) */
  37         define('PATH_SEPARATOR', ';');
  38     } else {
  39         /** include_path separator(Unix) */
  40         define('PATH_SEPARATOR', ':');
  41     }
  42 }
  43 if (!defined('DIRECTORY_SEPARATOR')) {
  44     if (ETHNA_OS_WINDOWS) {
  45         /** directory separator(Windows) */
  46         define('DIRECTORY_SEPARATOR', '\\');
  47     } else {
  48         /** separator(Unix) */
  49         define('DIRECTORY_SEPARATOR', '/');
  50     }
  51 }
  52
  53 /** バージョン定義 */
  54 define('ETHNA_VERSION', '2.5.0-preview6 $Git$');
  55
  56 /**
  57  * ダミーのエラーモード
  58  * PEAR非依存、かつ互換性を維持するためのもの
  59  */
  60 define('ETHNA_ERROR_DUMMY', 'dummy');
  61
  62 /** Ethnaベースディレクトリ定義 */
  63 define('ETHNA_BASE', dirname(__FILE__));
  64
  65 require_once ETHNA_BASE . '/class/Ethna_ActionClass.php';
  66 require_once ETHNA_BASE . '/class/Ethna_ActionError.php';
  67 require_once ETHNA_BASE . '/class/Ethna_ActionForm.php';
  68 require_once ETHNA_BASE . '/class/Ethna_AppManager.php';
  69 require_once ETHNA_BASE . '/class/Ethna_AppObject.php';
  70 require_once ETHNA_BASE . '/class/Ethna_AppSQL.php';
  71 require_once ETHNA_BASE . '/class/Ethna_AppSearchObject.php';
  72 require_once ETHNA_BASE . '/class/Ethna_Backend.php';
  73 require_once ETHNA_BASE . '/class/Ethna_CacheManager.php';
  74 require_once ETHNA_BASE . '/class/Ethna_Config.php';
  75 require_once ETHNA_BASE . '/class/Ethna_Controller.php';
  76 require_once ETHNA_BASE . '/class/Ethna_ClassFactory.php';
  77 require_once ETHNA_BASE . '/class/Ethna_DB.php';
  78 require_once ETHNA_BASE . '/class/Ethna_Error.php';
  79 require_once ETHNA_BASE . '/class/Ethna_Filter.php';
  80 require_once ETHNA_BASE . '/class/Ethna_Handle.php';
  81 require_once ETHNA_BASE . '/class/Ethna_I18N.php';
  82 require_once ETHNA_BASE . '/class/Ethna_Logger.php';
  83 require_once ETHNA_BASE . '/class/Ethna_MailSender.php';
  84 require_once ETHNA_BASE . '/class/Ethna_Session.php';
  85 require_once ETHNA_BASE . '/class/Ethna_Generator.php';
  86 require_once ETHNA_BASE . '/class/Ethna_UrlHandler.php';
  87 require_once ETHNA_BASE . '/class/Ethna_Util.php';
  88 require_once ETHNA_BASE . '/class/Ethna_ViewClass.php';
  89 require_once ETHNA_BASE . '/class/View/Ethna_View_Json.php';
  90 require_once ETHNA_BASE . '/class/View/Ethna_View_Redirect.php';
  91 require_once ETHNA_BASE . '/class/View/Ethna_View_403.php';
  92 require_once ETHNA_BASE . '/class/View/Ethna_View_404.php';
  93 require_once ETHNA_BASE . '/class/View/Ethna_View_500.php';
  94 require_once ETHNA_BASE . '/class/View/Ethna_View_List.php';
  95 require_once ETHNA_BASE . '/class/Ethna_Plugin.php';
  96 require_once ETHNA_BASE . '/class/Ethna_Renderer.php';
  97 require_once ETHNA_BASE . '/class/CLI/Ethna_CLI_ActionClass.php';
  98
  99 if (extension_loaded('soap')) {
 100     require_once ETHNA_BASE . '/class/SOAP/Ethna_SOAP_ActionForm.php';
 101     require_once ETHNA_BASE . '/class/SOAP/Ethna_SOAP_Gateway.php';
 102     require_once ETHNA_BASE . '/class/SOAP/Ethna_SOAP_GatewayGenerator.php';
 103     require_once ETHNA_BASE . '/class/SOAP/Ethna_SOAP_Util.php';
 104     require_once ETHNA_BASE . '/class/SOAP/Ethna_SOAP_WsdlGenerator.php';
 105 }
 106
 107 /** ゲートウェイ: WWW */
 108 define('GATEWAY_WWW', 1);
 109
 110 /** ゲートウェイ: CLI */
 111 define('GATEWAY_CLI', 2);
 112
 113 /** ゲートウェイ: XMLRPC */
 114 define('GATEWAY_XMLRPC', 3);
 115
 116 /** ゲートウェイ: SOAP */
 117 define('GATEWAY_SOAP', 4);
 118
 119
 120 /** DB種別定義: R/W */
 121 define('DB_TYPE_RW', 1);
 122
 123 /** DB種別定義: R/O */
 124 define('DB_TYPE_RO', 2);
 125
 126 /** DB種別定義: Misc  */
 127 define('DB_TYPE_MISC', 3);
 128
 129
 130 /** 要素型: 整数 */
 131 define('VAR_TYPE_INT', 1);
 132
 133 /** 要素型: 浮動小数点数 */
 134 define('VAR_TYPE_FLOAT', 2);
 135
 136 /** 要素型: 文字列 */
 137 define('VAR_TYPE_STRING', 3);
 138
 139 /** 要素型: 日付 */
 140 define('VAR_TYPE_DATETIME', 4);
 141
 142 /** 要素型: 真偽値 */
 143 define('VAR_TYPE_BOOLEAN', 5);
 144
 145 /** 要素型: ファイル */
 146 define('VAR_TYPE_FILE', 6);
 147
 148
 149 /** フォーム型: text */
 150 define('FORM_TYPE_TEXT', 1);
 151
 152 /** フォーム型: password */
 153 define('FORM_TYPE_PASSWORD', 2);
 154
 155 /** フォーム型: textarea */
 156 define('FORM_TYPE_TEXTAREA', 3);
 157
 158 /** フォーム型: select */
 159 define('FORM_TYPE_SELECT', 4);
 160
 161 /** フォーム型: radio */
 162 define('FORM_TYPE_RADIO', 5);
 163
 164 /** フォーム型: checkbox */
 165 define('FORM_TYPE_CHECKBOX', 6);
 166
 167 /** フォーム型: button */
 168 define('FORM_TYPE_SUBMIT', 7);
 169
 170 /** フォーム型: file */
 171 define('FORM_TYPE_FILE', 8);
 172
 173 /** フォーム型: button */
 174 define('FORM_TYPE_BUTTON', 9);
 175
 176 /** フォーム型: hidden */
 177 define('FORM_TYPE_HIDDEN', 10);
 178
 179
 180 /** エラーコード: 一般エラー */
 181 define('E_GENERAL', 1);
 182
 183 /** エラーコード: DB接続エラー */
 184 define('E_DB_CONNECT', 2);
 185
 186 /** エラーコード: DB設定なし */
 187 define('E_DB_NODSN', 3);
 188
 189 /** エラーコード: DBクエリエラー */
 190 define('E_DB_QUERY', 4);
 191
 192 /** エラーコード: DBユニークキーエラー */
 193 define('E_DB_DUPENT', 5);
 194
 195 /** エラーコード: DB種別エラー */
 196 define('E_DB_INVALIDTYPE', 6);
 197
 198 /** エラーコード: セッションエラー(有効期限切れ) */
 199 define('E_SESSION_EXPIRE', 16);
 200
 201 /** エラーコード: セッションエラー(IPアドレスチェックエラー) */
 202 define('E_SESSION_IPCHECK', 17);
 203
 204 /** エラーコード: アクション未定義エラー */
 205 define('E_APP_UNDEFINED_ACTION', 32);
 206
 207 /** エラーコード: アクションクラス未定義エラー */
 208 define('E_APP_UNDEFINED_ACTIONCLASS', 33);
 209
 210 /** エラーコード: アプリケーションオブジェクトID重複エラー */
 211 define('E_APP_DUPENT', 34);
 212
 213 /** エラーコード: アプリケーションメソッドが存在しない */
 214 define('E_APP_NOMETHOD', 35);
 215
 216 /** エラーコード: ロックエラー */
 217 define('E_APP_LOCK', 36);
 218
 219 /** エラーコード: 読み込みエラー */
 220 define('E_APP_READ', 37);
 221
 222 /** エラーコード: 書き込みエラー */
 223 define('E_APP_WRITE', 38);
 224
 225 /** エラーコード: CSV分割エラー(行継続) */
 226 define('E_UTIL_CSV_CONTINUE', 64);
 227
 228 /** エラーコード: フォーム値型エラー(スカラー引数に配列指定) */
 229 define('E_FORM_WRONGTYPE_SCALAR', 128);
 230
 231 /** エラーコード: フォーム値型エラー(配列引数にスカラー指定) */
 232 define('E_FORM_WRONGTYPE_ARRAY', 129);
 233
 234 /** エラーコード: フォーム値型エラー(整数型) */
 235 define('E_FORM_WRONGTYPE_INT', 130);
 236
 237 /** エラーコード: フォーム値型エラー(浮動小数点数型) */
 238 define('E_FORM_WRONGTYPE_FLOAT', 131);
 239
 240 /** エラーコード: フォーム値型エラー(日付型) */
 241 define('E_FORM_WRONGTYPE_DATETIME', 132);
 242
 243 /** エラーコード: フォーム値型エラー(BOOL型) */
 244 define('E_FORM_WRONGTYPE_BOOLEAN', 133);
 245
 246 /** エラーコード: フォーム値型エラー(FILE型) */
 247 define('E_FORM_WRONGTYPE_FILE', 134);
 248
 249 /** エラーコード: フォーム値必須エラー */
 250 define('E_FORM_REQUIRED', 135);
 251
 252 /** エラーコード: フォーム値最小値エラー(整数型) */
 253 define('E_FORM_MIN_INT', 136);
 254
 255 /** エラーコード: フォーム値最小値エラー(浮動小数点数型) */
 256 define('E_FORM_MIN_FLOAT', 137);
 257
 258 /** エラーコード: フォーム値最小値エラー(文字列型) */
 259 define('E_FORM_MIN_STRING', 138);
 260
 261 /** エラーコード: フォーム値最小値エラー(日付型) */
 262 define('E_FORM_MIN_DATETIME', 139);
 263
 264 /** エラーコード: フォーム値最小値エラー(ファイル型) */
 265 define('E_FORM_MIN_FILE', 140);
 266
 267 /** エラーコード: フォーム値最大値エラー(整数型) */
 268 define('E_FORM_MAX_INT', 141);
 269
 270 /** エラーコード: フォーム値最大値エラー(浮動小数点数型) */
 271 define('E_FORM_MAX_FLOAT', 142);
 272
 273 /** エラーコード: フォーム値最大値エラー(文字列型) */
 274 define('E_FORM_MAX_STRING', 143);
 275
 276 /** エラーコード: フォーム値最大値エラー(日付型) */
 277 define('E_FORM_MAX_DATETIME', 144);
 278
 279 /** エラーコード: フォーム値最大値エラー(ファイル型) */
 280 define('E_FORM_MAX_FILE', 145);
 281
 282 /** エラーコード: フォーム値文字種(正規表現)エラー */
 283 define('E_FORM_REGEXP', 146);
 284
 285 /** エラーコード: フォーム値数値(カスタムチェック)エラー */
 286 define('E_FORM_INVALIDVALUE', 147);
 287
 288 /** エラーコード: フォーム値文字種(カスタムチェック)エラー */
 289 define('E_FORM_INVALIDCHAR', 148);
 290
 291 /** エラーコード: 確認用エントリ入力エラー */
 292 define('E_FORM_CONFIRM', 149);
 293
 294 /** エラーコード: キャッシュタイプ不正 */
 295 define('E_CACHE_INVALID_TYPE', 192);
 296
 297 /** エラーコード: キャッシュ値なし */
 298 define('E_CACHE_NO_VALUE', 193);
 299
 300 /** エラーコード: キャッシュ有効期限 */
 301 define('E_CACHE_EXPIRED', 194);
 302
 303 /** エラーコード: キャッシュエラー(その他) */
 304 define('E_CACHE_GENERAL', 195);
 305
 306 /** エラーコード: プラグインが見つからない */
 307 define('E_PLUGIN_NOTFOUND', 196);
 308
 309 /** エラーコード: プラグインエラー(その他) */
 310 define('E_PLUGIN_GENERAL', 197);
 311
 312 if (defined('E_STRICT') == false) {
 313     /** PHP 5との互換保持定義 */
 314     define('E_STRICT', 2048);
 315 }
 316
 317 /** Ethnaグローバル変数: エラーコールバック関数 */
 318 $GLOBALS['_Ethna_error_callback_list'] = array();
 319
 320 /** Ethnaグローバル変数: エラーメッセージ */
 321 $GLOBALS['_Ethna_error_message_list'] = array();
 322
 323
 324 // {{{ Ethna
 325 /**
 326  *  Ethnaフレームワーククラス
 327  *
 328  *  @author     Masaki Fujimoto <fujimoto@php.net>
 329  *  @access     public
 330  *  @package    Ethna
 331  */
 332 class Ethna
 333 {
 334     /**
 335      *  渡されたオブジェクトが Ethna_Error オブジェクト
 336      *  またはそのサブクラスのオブジェクトかどうかチェックします。
 337      *
 338      *  @param mixed  $data    チェックする変数
 339      *  @param mixed  $msgcode チェックするエラーメッセージまたはエラーコード
 340      *  @return mixed 変数が、Ethna_Error の場合に TRUEを返します。
 341      *                第2引数が設定された場合は、さらに 所与された $msgcode
 342      *                を含む場合のみ TRUEを返します。
 343      *  @static
 344      */
 345     function isError($data, $msgcode = NULL)
 346     {
 347         if (!is_object($data)) {
 348             return false;
 349         }
 350
 351         $class_name = get_class($data);
 352         if (strcasecmp($class_name, 'Ethna_Error') === 0
 353          || is_subclass_of($data, 'Ethna_Error')) {
 354             if ($msgcode == NULL) {
 355                 return true;
 356             } elseif ($data->getCode() == $msgcode) {
 357                 return true;
 358             }
 359         }
 360
 361         return false;
 362     }
 363
 364     /**
 365      *  Ethna_Errorオブジェクトを生成する(エラーレベル:E_USER_ERROR)
 366      *
 367      *  @access public
 368      *  @param  string  $message            エラーメッセージ
 369      *  @param  int     $code               エラーコード
 370      *  @static
 371      */
 372     function &raiseError($message, $code = E_GENERAL)
 373     {
 374         $userinfo = null;
 375         if (func_num_args() > 2) {
 376             $userinfo = array_slice(func_get_args(), 2);
 377             if (count($userinfo) == 1 && is_array($userinfo[0])) {
 378                 $userinfo = $userinfo[0];
 379             }
 380         }
 381         $error = new Ethna_Error($message, $code, ETHNA_ERROR_DUMMY, E_USER_ERROR, $userinfo, 'Ethna_Error');
 382         return $error;
 383     }
 384
 385     /**
 386      *  Ethna_Errorオブジェクトを生成する(エラーレベル:E_USER_WARNING)
 387      *
 388      *  @access public
 389      *  @param  string  $message            エラーメッセージ
 390      *  @param  int     $code               エラーコード
 391      *  @static
 392      */
 393     function &raiseWarning($message, $code = E_GENERAL)
 394     {
 395         $userinfo = null;
 396         if (func_num_args() > 2) {
 397             $userinfo = array_slice(func_get_args(), 2);
 398             if (count($userinfo) == 1 && is_array($userinfo[0])) {
 399                 $userinfo = $userinfo[0];
 400             }
 401         }
 402
 403         $error = new Ethna_Error($message, $code, ETHNA_ERROR_DUMMY, E_USER_WARNING, $userinfo, 'Ethna_Error');
 404         return $error;
 405     }
 406
 407     /**
 408      *  Ethna_Errorオブジェクトを生成する(エラーレベル:E_USER_NOTICE)
 409      *
 410      *  @access public
 411      *  @param  string  $message            エラーメッセージ
 412      *  @param  int     $code               エラーコード
 413      *  @static
 414      */
 415     function &raiseNotice($message, $code = E_GENERAL)
 416     {
 417         $userinfo = null;
 418         if (func_num_args() > 2) {
 419             $userinfo = array_slice(func_get_args(), 2);
 420             if (count($userinfo) == 1 && is_array($userinfo[0])) {
 421                 $userinfo = $userinfo[0];
 422             }
 423         }
 424
 425         $error = new Ethna_Error($message, $code, ETHNA_ERROR_DUMMY, E_USER_NOTICE, $userinfo, 'Ethna_Error');
 426         return $error;
 427     }
 428
 429     /**
 430      *  エラー発生時の(フレームワークとしての)コールバック関数を設定する
 431      *
 432      *  @access public
 433      *  @param  mixed   string:コールバック関数名 array:コールバッククラス(名|オブジェクト)+メソッド名
 434      *  @static
 435      */
 436     function setErrorCallback($callback)
 437     {
 438         $GLOBALS['_Ethna_error_callback_list'][] = $callback;
 439     }
 440
 441     /**
 442      *  エラー発生時の(フレームワークとしての)コールバック関数をクリアする
 443      *
 444      *  @access public
 445      *  @static
 446      */
 447     function clearErrorCallback()
 448     {
 449         $GLOBALS['_Ethna_error_callback_list'] = array();
 450     }
 451
 452     /**
 453      *  エラー発生時の処理を行う(コールバック関数/メソッドを呼び出す)
 454      *
 455      *  @access public
 456      *  @param  object  Ethna_Error     Ethna_Errorオブジェクト
 457      *  @static
 458      */
 459     function handleError(&$error)
 460     {
 461         for ($i = 0; $i < count($GLOBALS['_Ethna_error_callback_list']); $i++) {
 462             $callback =& $GLOBALS['_Ethna_error_callback_list'][$i];
 463             if (is_array($callback) == false) {
 464                 call_user_func($callback, $error);
 465             } else if (is_object($callback[0])) {
 466                 $object =& $callback[0];
 467                 $method = $callback[1];
 468
 469                 // perform some more checks?
 470                 $object->$method($error);
 471             } else {
 472                 //  call statically
 473                 call_user_func($callback, $error);
 474             }
 475         }
 476     }
 477 }
 478 // }}}
 479