MediaWiki REL1_32
makeRepo.php
Go to the documentation of this file.
1<?php
2
3require __DIR__ . '/../Maintenance.php';
4
5class HHVMMakeRepo extends Maintenance {
6 function __construct() {
7 parent::__construct();
8 $this->addDescription( 'Compile PHP sources for this MediaWiki instance, ' .
9 'and generate an HHVM bytecode file to be used with HHVM\'s ' .
10 'RepoAuthoritative mode. The MediaWiki core installation path and ' .
11 'all registered extensions are automatically searched for the file ' .
12 'extensions *.php, *.inc, *.php5 and *.phtml.' );
13 $this->addOption( 'output', 'Output filename', true, true, 'o' );
14 $this->addOption( 'input-dir', 'Add an input directory. ' .
15 'This can be specified multiple times.', false, true, 'd', true );
16 $this->addOption( 'exclude-dir', 'Directory to exclude. ' .
17 'This can be specified multiple times.', false, true, false, true );
18 $this->addOption( 'extension', 'Extra file extension', false, true, false, true );
19 $this->addOption( 'hhvm', 'Location of HHVM binary', false, true );
20 $this->addOption( 'base-dir', 'The root of all source files. ' .
21 'This must match hhvm.server.source_root in the server\'s configuration file. ' .
22 'By default, the MW core install path will be used.',
23 false, true );
24 $this->addOption( 'verbose', 'Log level 0-3', false, true, 'v' );
25 }
26
27 private static function startsWith( $subject, $search ) {
28 return substr( $subject, 0, strlen( $search ) === $search );
29 }
30
31 function execute() {
33
34 $dirs = [ $IP ];
35
36 foreach ( $wgExtensionCredits as $type => $extensions ) {
37 foreach ( $extensions as $extension ) {
38 if ( isset( $extension['path'] )
39 && !self::startsWith( $extension['path'], $IP )
40 ) {
41 $dirs[] = dirname( $extension['path'] );
42 }
43 }
44 }
45
46 $dirs = array_merge( $dirs, $this->getOption( 'input-dir', [] ) );
47 $fileExts =
48 [
49 'php' => true,
50 'inc' => true,
51 'php5' => true,
52 'phtml' => true
53 ] +
54 array_flip( $this->getOption( 'extension', [] ) );
55
56 $dirs = array_unique( $dirs );
57
58 $baseDir = $this->getOption( 'base-dir', $IP );
59 $excludeDirs = array_map( 'realpath', $this->getOption( 'exclude-dir', [] ) );
60
61 if ( $baseDir !== '' && substr( $baseDir, -1 ) !== '/' ) {
62 $baseDir .= '/';
63 }
64
65 $unfilteredFiles = [ "$IP/LocalSettings.php" ];
66 foreach ( $dirs as $dir ) {
67 $this->appendDir( $unfilteredFiles, $dir );
68 }
69
70 $files = [];
71 foreach ( $unfilteredFiles as $file ) {
72 $dotPos = strrpos( $file, '.' );
73 $slashPos = strrpos( $file, '/' );
74 if ( $dotPos === false || $slashPos === false || $dotPos < $slashPos ) {
75 continue;
76 }
77 $extension = substr( $file, $dotPos + 1 );
78 if ( !isset( $fileExts[$extension] ) ) {
79 continue;
80 }
81 $canonical = realpath( $file );
82 foreach ( $excludeDirs as $excluded ) {
83 if ( self::startsWith( $canonical, $excluded ) ) {
84 continue 2;
85 }
86 }
87 if ( self::startsWith( $file, $baseDir ) ) {
88 $file = substr( $file, strlen( $baseDir ) );
89 }
90 $files[] = $file;
91 }
92
93 $files = array_unique( $files );
94
95 print "Found " . count( $files ) . " files in " .
96 count( $dirs ) . " directories\n";
97
98 $tmpDir = wfTempDir() . '/mw-make-repo' . mt_rand( 0, 1 << 31 );
99 if ( !mkdir( $tmpDir ) ) {
100 $this->fatalError( 'Unable to create temporary directory' );
101 }
102 file_put_contents( "$tmpDir/file-list", implode( "\n", $files ) );
103
104 $hhvm = $this->getOption( 'hhvm', 'hhvm' );
105 $verbose = $this->getOption( 'verbose', 3 );
106 $cmd = wfEscapeShellArg(
107 $hhvm,
108 '--hphp',
109 '--target', 'hhbc',
110 '--format', 'binary',
111 '--force', '1',
112 '--keep-tempdir', '1',
113 '--log', $verbose,
114 '-v', 'AllVolatile=true',
115 '--input-dir', $baseDir,
116 '--input-list', "$tmpDir/file-list",
117 '--output-dir', $tmpDir );
118 print "$cmd\n";
119 passthru( $cmd, $ret );
120 if ( $ret ) {
121 $this->cleanupTemp( $tmpDir );
122 $this->fatalError( "Error: HHVM returned error code $ret" );
123 }
124 if ( !rename( "$tmpDir/hhvm.hhbc", $this->getOption( 'output' ) ) ) {
125 $this->cleanupTemp( $tmpDir );
126 $this->fatalError( "Error: unable to rename output file" );
127 }
128 $this->cleanupTemp( $tmpDir );
129 return 0;
130 }
131
132 private function cleanupTemp( $tmpDir ) {
133 if ( file_exists( "$tmpDir/hhvm.hhbc" ) ) {
134 unlink( "$tmpDir/hhvm.hhbc" );
135 }
136 if ( file_exists( "$tmpDir/Stats.js" ) ) {
137 unlink( "$tmpDir/Stats.js" );
138 }
139
140 unlink( "$tmpDir/file-list" );
141 rmdir( $tmpDir );
142 }
143
144 private function appendDir( &$files, $dir ) {
145 $iter = new RecursiveIteratorIterator(
146 new RecursiveDirectoryIterator(
147 $dir,
148 FilesystemIterator::UNIX_PATHS
149 ),
150 RecursiveIteratorIterator::LEAVES_ONLY
151 );
152 foreach ( $iter as $file => $fileInfo ) {
153 if ( $fileInfo->isFile() ) {
154 $files[] = $file;
155 }
156 }
157 }
158}
159
160$maintClass = HHVMMakeRepo::class;
$wgExtensionCredits
An array of information about installed extensions keyed by their type.
wfTempDir()
Tries to get the system directory for temporary files.
wfEscapeShellArg(... $args)
Version of escapeshellarg() that works better on Windows.
$IP
Definition WebStart.php:41
__construct()
Default constructor.
Definition makeRepo.php:6
execute()
Do the actual work.
Definition makeRepo.php:31
static startsWith( $subject, $search)
Definition makeRepo.php:27
appendDir(&$files, $dir)
Definition makeRepo.php:144
cleanupTemp( $tmpDir)
Definition makeRepo.php:132
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getOption( $name, $default=null)
Get an option, or return the default.
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
while(( $__line=Maintenance::readconsole()) !==false) print
Definition eval.php:64
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition hooks.txt:2055
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition hooks.txt:2054
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
require_once RUN_MAINTENANCE_IF_MAIN
$maintClass
Definition makeRepo.php:160