Introducing special page modular extensions, making the board vote special page the...
[lhc/web/wiklou.git] / includes / GlobalFunctions.php
index 5692b46..515dd68 100644 (file)
@@ -5,9 +5,9 @@ $wgNumberOfArticles = -1; # Unset
 $wgTotalViews = -1;
 $wgTotalEdits = -1;
 
-include_once( "DatabaseFunctions.php" );
-include_once( "UpdateClasses.php" );
-include_once( "LogPage.php" );
+require_once( "DatabaseFunctions.php" );
+require_once( "UpdateClasses.php" );
+require_once( "LogPage.php" );
 
 /*
  * Compatibility functions
@@ -36,6 +36,31 @@ if( !function_exists('file_get_contents') ) {
        }
 }
 
+if( !function_exists('is_a') ) {
+       # Exists in PHP 4.2.0+
+       function is_a( $object, $class_name ) {
+               return
+                       (strcasecmp( get_class( $object, $class_name ) == 0) ||
+                        is_subclass_of( $object, $class_name ) );
+       }
+}
+
+# html_entity_decode exists in PHP 4.3.0+ but is FATALLY BROKEN even then,
+# with no UTF-8 support.
+function do_html_entity_decode( $string, $quote_style=ENT_COMPAT, $charset="ISO-8859-1" ) {
+       static $trans;
+       if( !isset( $trans ) ) {
+               $trans = array_flip( get_html_translation_table( HTML_ENTITIES, $quote_style ) );
+               # Assumes $charset will always be the same through a run, and only understands
+               # utf-8 or default. Note - mixing latin1 named entities and unicode numbered
+               # ones will result in a bad link.
+               if( strcasecmp( "utf-8", $charset ) == 0 ) {
+                       $trans = array_map( "utf8_encode", $trans );
+               }
+       }
+       return strtr( $string, $trans );
+}
+
 $wgRandomSeeded = false;
 
 function wfSeedRandom()
@@ -89,61 +114,21 @@ function wfFullUrlE( $a, $q = "" ) {
 
 }
 
-function wfImageUrl( $img )
-{
-       global $wgUploadPath;
-
-       $nt = Title::newFromText( $img );
-       if( !$nt ) return "";
+// orphan function wfThumbUrl( $img )
+//{
+//     global $wgUploadPath;
+//
+//     $nt = Title::newFromText( $img );
+//     if( !$nt ) return "";
+//
+//     $name = $nt->getDBkey();
+//     $hash = md5( $name );
+//
+//     $url = "{$wgUploadPath}/thumb/" . $hash{0} . "/" .
+//       substr( $hash, 0, 2 ) . "/{$name}";
+//     return wfUrlencode( $url );
+//}
 
-       $name = $nt->getDBkey();
-       $hash = md5( $name );
-
-       $url = "{$wgUploadPath}/" . $hash{0} . "/" .
-         substr( $hash, 0, 2 ) . "/{$name}";
-       return wfUrlencode( $url );
-}
-
-function wfImagePath( $img )
-{
-       global $wgUploadDirectory;
-
-       $nt = Title::newFromText( $img );
-       if( !$nt ) return "";
-
-       $name = $nt->getDBkey();
-       $hash = md5( $name );
-
-       $path = "{$wgUploadDirectory}/" . $hash{0} . "/" .
-         substr( $hash, 0, 2 ) . "/{$name}";
-       return $path;
-}
-
-function wfThumbUrl( $img )
-{
-       global $wgUploadPath;
-
-       $nt = Title::newFromText( $img );
-       if( !$nt ) return "";
-
-       $name = $nt->getDBkey();
-       $hash = md5( $name );
-
-       $url = "{$wgUploadPath}/thumb/" . $hash{0} . "/" .
-         substr( $hash, 0, 2 ) . "/{$name}";
-       return wfUrlencode( $url );
-}
-
-
-function wfImageThumbUrl( $name, $subdir="thumb" )
-{
-       global $wgUploadPath;
-
-       $hash = md5( $name );
-       $url = "{$wgUploadPath}/{$subdir}/" . $hash{0} . "/" .
-         substr( $hash, 0, 2 ) . "/{$name}";
-       return wfUrlencode($url);
-}
 
 function wfImageArchiveUrl( $name )
 {
@@ -188,6 +173,46 @@ function wfMungeToUtf8($string) {
        return $string;
 }
 
+# Converts a single UTF-8 character into the corresponding HTML character entity
+function wfUtf8Entity( $char ) {
+       # Find the length
+       $z = ord( $char{0} );
+       if ( $z & 0x80 ) {
+               $length = 0;
+               while ( $z & 0x80 ) {
+                       $length++;
+                       $z <<= 1;
+               }
+       } else {
+               $length = 1;
+       }
+       
+       if ( $length != strlen( $char ) ) {
+               return "";
+       }
+       if ( $length == 1 ) {
+               return $char;
+       }
+
+       # Mask off the length-determining bits and shift back to the original location
+       $z &= 0xff;
+       $z >>= $length;
+
+       # Add in the free bits from subsequent bytes
+       for ( $i=1; $i<$length; $i++ ) {
+               $z <<= 6;
+               $z |= ord( $char{$i} ) & 0x3f;
+       }
+
+       # Make entity
+       return "&#$z;";
+}
+
+# Converts all multi-byte characters in a UTF-8 string into the appropriate character entity
+function wfUtf8ToHTML($string) {
+       return preg_replace_callback( '/[\\xc0-\\xfd][\\x80-\\xbf]*/', 'wfUtf8Entity', $string );
+}
+
 function wfDebug( $text, $logonly = false )
 {
        global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly;
@@ -307,47 +332,6 @@ function wfCleanQueryVar( $var )
        wfDebugDieBacktrace( "Call to obsolete function wfCleanQueryVar(); use wgRequest instead" );
 }
 
-function wfSpecialPage()
-{
-       global $wgUser, $wgOut, $wgTitle, $wgLang;
-
-       /* FIXME: this list probably shouldn't be language-specific, per se */
-       $validSP = $wgLang->getValidSpecialPages();
-       $sysopSP = $wgLang->getSysopSpecialPages();
-       $devSP = $wgLang->getDeveloperSpecialPages();
-
-       $wgOut->setArticleRelated( false );
-       $wgOut->setRobotpolicy( "noindex,follow" );
-
-       $bits = split( "/", $wgTitle->getDBkey(), 2 );
-       $t = $bits[0];
-       if( empty( $bits[1] ) ) {
-               $par = NULL;
-       } else {
-               $par = $bits[1];
-       }
-
-       if ( array_key_exists( $t, $validSP ) ||
-         ( $wgUser->isSysop() && array_key_exists( $t, $sysopSP ) ) ||
-         ( $wgUser->isDeveloper() && array_key_exists( $t, $devSP ) ) ) {
-               if($par !== NULL)
-                       $wgTitle = Title::makeTitle( Namespace::getSpecial(), $t );
-
-               $wgOut->setPageTitle( wfMsg( strtolower( $wgTitle->getText() ) ) );
-
-               $inc = "Special" . $t . ".php";
-               include_once( $inc );
-               $call = "wfSpecial" . $t;
-               $call( $par );
-       } else if ( array_key_exists( $t, $sysopSP ) ) {
-               $wgOut->sysopRequired();
-       } else if ( array_key_exists( $t, $devSP ) ) {
-               $wgOut->developerRequired();
-       } else {
-               $wgOut->errorpage( "nosuchspecialpage", "nospecialpagetext" );
-       }
-}
-
 function wfSearch( $s )
 {
        $se = new SearchEngine( $s );
@@ -470,21 +454,24 @@ function wfImageArchiveDir( $fname , $subdir="archive")
 
        $hash = md5( $fname );
        $oldumask = umask(0);
+       
+       # Suppress warning messages here; if the file itself can't
+       # be written we'll worry about it then.
        $archive = "{$wgUploadDirectory}/{$subdir}";
-       if ( ! is_dir( $archive ) ) { mkdir( $archive, 0777 ); }
+       if ( ! is_dir( $archive ) ) { @mkdir( $archive, 0777 ); }
        $archive .= "/" . $hash{0};
-       if ( ! is_dir( $archive ) ) { mkdir( $archive, 0777 ); }
+       if ( ! is_dir( $archive ) ) { @mkdir( $archive, 0777 ); }
        $archive .= "/" . substr( $hash, 0, 2 );
-       if ( ! is_dir( $archive ) ) { mkdir( $archive, 0777 ); }
+       if ( ! is_dir( $archive ) ) { @mkdir( $archive, 0777 ); }
 
        umask( $oldumask );
        return $archive;
 }
 
-function wfRecordUpload( $name, $oldver, $size, $desc )
+function wfRecordUpload( $name, $oldver, $size, $desc, $copyStatus = "", $source = "" )
 {
        global $wgUser, $wgLang, $wgTitle, $wgOut, $wgDeferredUpdateList;
-       global $wgUseCopyrightUpload , $wpUploadCopyStatus , $wpUploadSource ;
+       global $wgUseCopyrightUpload
        
        $fname = "wfRecordUpload";
 
@@ -499,8 +486,8 @@ function wfRecordUpload( $name, $oldver, $size, $desc )
        if ( $wgUseCopyrightUpload )
          {
            $textdesc = "== " . wfMsg ( "filedesc" ) . " ==\n" . $desc . "\n" .
-             "== " . wfMsg ( "filestatus" ) . " ==\n" . $wpUploadCopyStatus . "\n" .
-             "== " . wfMsg ( "filesource" ) . " ==\n" . $wpUploadSource ;
+             "== " . wfMsg ( "filestatus" ) . " ==\n" . $copyStatus . "\n" .
+             "== " . wfMsg ( "filesource" ) . " ==\n" . $source ;
          }
        else $textdesc = $desc ;
 
@@ -759,6 +746,27 @@ function wfPurgeSquidServers ($urlArr) {
        SquidUpdate::purge( $urlArr );
 }
 
+# Windows-compatible version of escapeshellarg()
+function wfEscapeShellArg( )
+{
+       $args = func_get_args();
+       $first = true;
+       $retVal = "";
+       foreach ( $args as $arg ) {
+               if ( !$first ) { 
+                       $retVal .= " ";
+               } else {
+                       $first = false;
+               }
+
+               if (substr(php_uname(), 0, 7) == "Windows") {
+                       $retVal .= '"' . str_replace( '"','\"', $arg ) . '"';
+               } else {
+                       $retVal .= escapeshellarg( $arg );
+               }
+       }
+       return $retVal;
+}
 
 # wfMerge attempts to merge differences between three texts. 
 # Returns true for a clean merge and false for failure or a conflict.
@@ -771,6 +779,8 @@ function wfMerge( $old, $mine, $yours, &$result ){
        if(! file_exists( $wgDiff3 ) ){ 
                return false;
        }
+
+       # Make temporary files
        $td = "/tmp/";
        $oldtextFile = fopen( $oldtextName = tempnam( $td, "merge-old-" ), "w" );
        $mytextFile = fopen( $mytextName = tempnam( $td, "merge-mine-" ), "w" );
@@ -779,8 +789,13 @@ function wfMerge( $old, $mine, $yours, &$result ){
        fwrite( $oldtextFile, $old ); fclose( $oldtextFile ); 
        fwrite( $mytextFile, $mine ); fclose( $mytextFile ); 
        fwrite( $yourtextFile, $yours ); fclose( $yourtextFile );
-       $cmd = "{$wgDiff3} -a --overlap-only $mytextName $oldtextName $yourtextName";
-       $handle = popen( $cmd, "r" );
+
+       # Check for a conflict
+    $cmd = wfEscapeShellArg( $wgDiff3 ) . " -a --overlap-only " .
+      wfEscapeShellArg( $mytextName ) . " " .
+      wfEscapeShellArg( $oldtextName ) . " " .
+      wfEscapeShellArg( $yourtextName );
+    $handle = popen( $cmd, "r" );
 
        if( fgets( $handle ) ){
                $conflict = true;
@@ -788,7 +803,10 @@ function wfMerge( $old, $mine, $yours, &$result ){
                $conflict = false;
        }
        pclose( $handle );
-       $cmd = "{$wgDiff3} -a -e --merge $mytextName $oldtextName $yourtextName";
+
+       # Merge differences
+       $cmd = wfEscapeShellArg( $wgDiff3 ) . " -a -e --merge " . 
+         wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
        $handle = popen( $cmd, "r" );
        $result = "";
        do {
@@ -807,11 +825,103 @@ function wfVarDump( $var )
 {
        global $wgOut;
        $s = str_replace("\n","<br>\n", var_export( $var, true ) . "\n");
-       if ( headers_sent() ) {
+       if ( headers_sent() || !@is_object( $wgOut ) ) {
                print $s;
        } else {
                $wgOut->addHTML( $s );
        }
 }
 
+# Provide a simple HTTP error.
+function wfHttpError( $code, $label, $desc ) {
+       global $wgOut;
+       $wgOut->disable();
+       header( "HTTP/1.0 $code $label" );
+       header( "Status: $code $label" );
+       $wgOut->sendCacheControl();
+       
+       # Don't send content if it's a HEAD request.
+       if( $_SERVER['REQUEST_METHOD'] == 'HEAD' ) {
+               header( "Content-type: text/plain" );
+               print "$desc\n";
+       }
+}
+
+# Converts an Accept-* header into an array mapping string values to quality factors
+function wfAcceptToPrefs( $accept, $def = "*/*" ) {
+       # No arg means accept anything (per HTTP spec)
+       if( !$accept ) {
+               return array( $def => 1 );
+       }
+       
+       $prefs = array();
+       
+       $parts = explode( ",", $accept );
+       
+       foreach( $parts as $part ) {
+               # FIXME: doesn't deal with params like 'text/html; level=1'
+               @list( $value, $qpart ) = explode( ";", $part );
+               if( !isset( $qpart ) ) {
+                       $prefs[$value] = 1;
+               } elseif( preg_match( '/q\s*=\s*(\d*\.\d+)/', $qpart, $match ) ) {
+                       $prefs[$value] = $match[1];
+               }
+       }
+       
+       return $prefs;
+}
+
+/* private */ function mimeTypeMatch( $type, $avail ) {
+       if( array_key_exists($type, $avail) ) {
+               return $type;
+       } else {
+               $parts = explode( '/', $type );
+               if( array_key_exists( $parts[0] . '/*', $avail ) ) {
+                       return $parts[0] . '/*';
+               } elseif( array_key_exists( '*/*', $avail ) ) {
+                       return '*/*';
+               } else {
+                       return NULL;
+               }
+       }
+}
+
+# FIXME: doesn't handle params like 'text/plain; charset=UTF-8'
+# XXX: generalize to negotiate other stuff
+function wfNegotiateType( $cprefs, $sprefs ) {
+       $combine = array();
+       
+       foreach( array_keys($sprefs) as $type ) {
+               $parts = explode( '/', $type );
+               if( $parts[1] != '*' ) {
+                       $ckey = mimeTypeMatch( $type, $cprefs );
+                       if( $ckey ) {
+                               $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
+                       }
+               }
+       }
+       
+       foreach( array_keys( $cprefs ) as $type ) {
+               $parts = explode( '/', $type );
+               if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
+                       $skey = mimeTypeMatch( $type, $sprefs );
+                       if( $skey ) {
+                               $combine[$type] = $sprefs[$skey] * $cprefs[$type];
+                       }
+               }
+       }
+       
+       $bestq = 0;
+       $besttype = NULL;
+       
+       foreach( array_keys( $combine ) as $type ) {
+               if( $combine[$type] > $bestq ) {
+                       $besttype = $type;
+                       $bestq = $combine[$type];
+               }
+       }
+       
+       return $besttype;
+}
+
 ?>