includes/WikiError.php

   1 <?php
   2 /**
   3  * MediaWiki error classes
   4  * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
   5  * http://www.mediawiki.org/
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  * http://www.gnu.org/copyleft/gpl.html
  21  *
  22  */
  23
  24 /**
  25  * Since PHP4 doesn't have exceptions, here's some error objects
  26  * loosely modeled on the standard PEAR_Error model...
  27  * @addtogroup Exception
  28  */
  29 class WikiError {
  30         /**
  31          * @param string $message
  32          */
  33         function __construct( $message ) {
  34                 $this->mMessage = $message;
  35         }
  36
  37         /**
  38          * @return string Plaintext error message to display
  39          */
  40         function getMessage() {
  41                 return $this->mMessage;
  42         }
  43
  44         /**
  45          * In following PEAR_Error model this could be formatted differently,
  46          * but so far it's not.
  47          * @return string
  48          */
  49         function toString() {
  50                 return $this->getMessage();
  51         }
  52
  53         /**
  54          * Returns true if the given object is a WikiError-descended
  55          * error object, false otherwise.
  56          *
  57          * @param mixed $object
  58          * @return bool
  59          * @static
  60          */
  61         public static function isError( $object ) {
  62                 return $object instanceof WikiError;
  63         }
  64 }
  65
  66 /**
  67  * Localized error message object
  68  * @addtogroup Exception
  69  */
  70 class WikiErrorMsg extends WikiError {
  71         /**
  72          * @param string $message Wiki message name
  73          * @param ... parameters to pass to wfMsg()
  74          */
  75         function WikiErrorMsg( $message/*, ... */ ) {
  76                 $args = func_get_args();
  77                 array_shift( $args );
  78                 $this->mMessage = wfMsgReal( $message, $args, true );
  79         }
  80 }
  81
  82 /**
  83  * @todo document
  84  * @addtogroup Exception
  85  */
  86 class WikiXmlError extends WikiError {
  87         /**
  88          * @param resource $parser
  89          * @param string $message
  90          */
  91         function WikiXmlError( $parser, $message = 'XML parsing error', $context = null, $offset = 0 ) {
  92                 $this->mXmlError = xml_get_error_code( $parser );
  93                 $this->mColumn = xml_get_current_column_number( $parser );
  94                 $this->mLine = xml_get_current_line_number( $parser );
  95                 $this->mByte = xml_get_current_byte_index( $parser );
  96                 $this->mContext = $this->_extractContext( $context, $offset );
  97                 $this->mMessage = $message;
  98                 xml_parser_free( $parser );
  99                 wfDebug( "WikiXmlError: " . $this->getMessage() . "\n" );
 100         }
 101
 102         /** @return string */
 103         function getMessage() {
 104                 return sprintf( '%s at line %d, col %d (byte %d%s): %s',
 105                         $this->mMessage,
 106                         $this->mLine,
 107                         $this->mColumn,
 108                         $this->mByte,
 109                         $this->mContext,
 110                         xml_error_string( $this->mXmlError ) );
 111         }
 112
 113         function _extractContext( $context, $offset ) {
 114                 if( is_null( $context ) ) {
 115                         return null;
 116                 } else {
 117                         // Hopefully integer overflow will be handled transparently here
 118                         $inlineOffset = $this->mByte - $offset;
 119                         return '; "' . substr( $context, $inlineOffset, 16 ) . '"';
 120                 }
 121         }
 122 }
 123
 124