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