summaryrefslogtreecommitdiff
path: root/includes/Init.php
diff options
context:
space:
mode:
Diffstat (limited to 'includes/Init.php')
-rw-r--r--includes/Init.php184
1 files changed, 184 insertions, 0 deletions
diff --git a/includes/Init.php b/includes/Init.php
new file mode 100644
index 00000000..de867282
--- /dev/null
+++ b/includes/Init.php
@@ -0,0 +1,184 @@
+<?php
+
+/**
+ * Some functions that are useful during startup.
+ */
+class MWInit {
+ static $compilerVersion;
+
+ /**
+ * Get the version of HipHop used to compile, or false if MediaWiki was not
+ * compiled. This works by having our build script insert a special function
+ * into the compiled code.
+ */
+ static function getCompilerVersion() {
+ if ( self::$compilerVersion === null ) {
+ if ( self::functionExists( 'wfHipHopCompilerVersion' ) ) {
+ self::$compilerVersion = wfHipHopCompilerVersion();
+ } else {
+ self::$compilerVersion = false;
+ }
+ }
+ return self::$compilerVersion;
+ }
+
+ /**
+ * Returns true if we are running under HipHop, whether in compiled or
+ * interpreted mode.
+ *
+ * @return bool
+ */
+ static function isHipHop() {
+ return function_exists( 'hphp_thread_set_warmup_enabled' );
+ }
+
+ /**
+ * Get a fully-qualified path for a source file relative to $IP. Including
+ * such a path under HipHop will force the file to be interpreted. This is
+ * useful for configuration files.
+ *
+ * @param $file string
+ *
+ * @return string
+ */
+ static function interpretedPath( $file ) {
+ global $IP;
+ return "$IP/$file";
+ }
+
+ /**
+ * If we are running code compiled by HipHop, this will pass through the
+ * input path, assumed to be relative to $IP. If the code is interpreted,
+ * it will converted to a fully qualified path. It is necessary to use a
+ * path which is relative to $IP in order to make HipHop use its compiled
+ * code.
+ *
+ * @param $file string
+ *
+ * @return string
+ */
+ static function compiledPath( $file ) {
+ global $IP;
+
+ if ( defined( 'MW_COMPILED' ) ) {
+ return "phase3/$file";
+ } else {
+ return "$IP/$file";
+ }
+ }
+
+ /**
+ * The equivalent of MWInit::interpretedPath() but for files relative to the
+ * extensions directory.
+ *
+ * @param $file string
+ * @return string
+ */
+ static function extInterpretedPath( $file ) {
+ return self::getExtensionsDirectory() . '/' . $file;
+ }
+
+ /**
+ * The equivalent of MWInit::compiledPath() but for files relative to the
+ * extensions directory. Any files referenced in this way must be registered
+ * for compilation by including them in $wgCompiledFiles.
+ * @param $file string
+ * @return string
+ */
+ static function extCompiledPath( $file ) {
+ if ( defined( 'MW_COMPILED' ) ) {
+ return "extensions/$file";
+ } else {
+ return self::getExtensionsDirectory() . '/' . $file;
+ }
+ }
+
+ /**
+ * Register an extension setup file and return its path for compiled
+ * inclusion. Use this function in LocalSettings.php to add extensions
+ * to the build. For example:
+ *
+ * require( MWInit::extSetupPath( 'ParserFunctions/ParserFunctions.php' ) );
+ *
+ * @param $extRel string The path relative to the extensions directory, as defined by
+ * $wgExtensionsDirectory.
+ *
+ * @return string
+ */
+ static function extSetupPath( $extRel ) {
+ $baseRel = "extensions/$extRel";
+ if ( defined( 'MW_COMPILED' ) ) {
+ return $baseRel;
+ } else {
+ global $wgCompiledFiles;
+ $wgCompiledFiles[] = $baseRel;
+ return self::getExtensionsDirectory() . '/' . $extRel;
+ }
+ }
+
+ /**
+ * @return bool|string
+ */
+ static function getExtensionsDirectory() {
+ global $wgExtensionsDirectory, $IP;
+ if ( $wgExtensionsDirectory === false ) {
+ $wgExtensionsDirectory = "$IP/../extensions";
+ }
+ return $wgExtensionsDirectory;
+ }
+
+ /**
+ * Determine whether a class exists, using a method which works under HipHop.
+ *
+ * Note that it's not possible to implement this with any variant of
+ * class_exists(), because class_exists() returns false for classes which
+ * are compiled in.
+ *
+ * Calling class_exists() on a literal string causes the class to be made
+ * "volatile", which means (as of March 2011) that the class is broken and
+ * can't be used at all. So don't do that. See
+ * https://github.com/facebook/hiphop-php/issues/314
+ *
+ * @param $class string
+ *
+ * @return bool
+ */
+ static function classExists( $class ) {
+ try {
+ $r = new ReflectionClass( $class );
+ } catch( ReflectionException $r ) {
+ $r = false;
+ }
+ return $r !== false;
+ }
+
+ /**
+ * Determine whether a function exists, using a method which works under
+ * HipHop.
+ *
+ * @param $function string
+ *
+ * @return bool
+ */
+ static function functionExists( $function ) {
+ try {
+ $r = new ReflectionFunction( $function );
+ } catch( ReflectionException $r ) {
+ $r = false;
+ }
+ return $r !== false;
+ }
+
+ /**
+ * Call a static method of a class with variable arguments without causing
+ * it to become volatile.
+ * @param $className string
+ * @param $methodName string
+ * @param $args array
+ *
+ */
+ static function callStaticMethod( $className, $methodName, $args ) {
+ $r = new ReflectionMethod( $className, $methodName );
+ return $r->invokeArgs( null, $args );
+ }
+}