MediaWiki  REL1_31
RaggettExternal.php
Go to the documentation of this file.
1 <?php
2 
3 namespace MediaWiki\Tidy;
4 
5 class RaggettExternal extends RaggettBase {
15  protected function cleanWrapped( $text, $stderr = false, &$retval = null ) {
16  $cleansource = '';
17  $opts = ' -utf8';
18 
19  if ( $stderr ) {
20  $descriptorspec = [
21  0 => [ 'pipe', 'r' ],
22  1 => [ 'file', wfGetNull(), 'a' ],
23  2 => [ 'pipe', 'w' ]
24  ];
25  } else {
26  $descriptorspec = [
27  0 => [ 'pipe', 'r' ],
28  1 => [ 'pipe', 'w' ],
29  2 => [ 'file', wfGetNull(), 'a' ]
30  ];
31  }
32 
33  $readpipe = $stderr ? 2 : 1;
34  $pipes = [];
35 
36  $process = proc_open(
37  "{$this->config['tidyBin']} -config {$this->config['tidyConfigFile']} " .
38  $this->config['tidyCommandLine'] . $opts, $descriptorspec, $pipes );
39 
40  // NOTE: At least on linux, the process will be created even if tidy is not installed.
41  // This means that missing tidy will be treated as a validation failure.
42 
43  if ( is_resource( $process ) ) {
44  // Theoretically, this style of communication could cause a deadlock
45  // here. If the stdout buffer fills up, then writes to stdin could
46  // block. This doesn't appear to happen with tidy, because tidy only
47  // writes to stdout after it's finished reading from stdin. Search
48  // for tidyParseStdin and tidySaveStdout in console/tidy.c
49  fwrite( $pipes[0], $text );
50  fclose( $pipes[0] );
51  while ( !feof( $pipes[$readpipe] ) ) {
52  $cleansource .= fgets( $pipes[$readpipe], 1024 );
53  }
54  fclose( $pipes[$readpipe] );
55  $retval = proc_close( $process );
56  } else {
57  wfWarn( "Unable to start external tidy process" );
58  $retval = -1;
59  }
60 
61  if ( !$stderr && $cleansource == '' && $text != '' ) {
62  // Some kind of error happened, so we couldn't get the corrected text.
63  // Just give up; we'll use the source text and append a warning.
64  $cleansource = null;
65  }
66 
67  return $cleansource;
68  }
69 
70  public function supportsValidate() {
71  return true;
72  }
73 }
MediaWiki\Tidy\RaggettBase
Definition: RaggettBase.php:5
php
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
MediaWiki\Tidy\RaggettExternal
Definition: RaggettExternal.php:5
wfGetNull
wfGetNull()
Get a platform-independent path to the null file, e.g.
Definition: GlobalFunctions.php:2940
MediaWiki\Tidy\RaggettExternal\supportsValidate
supportsValidate()
Return true if validate() can be used.
Definition: RaggettExternal.php:70
wfWarn
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
Definition: GlobalFunctions.php:1137
$retval
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account incomplete not yet checked for validity & $retval
Definition: hooks.txt:266
MediaWiki\Tidy
Definition: Balancer.php:27
MediaWiki\Tidy\RaggettExternal\cleanWrapped
cleanWrapped( $text, $stderr=false, &$retval=null)
Spawn an external HTML tidy process and get corrected markup back from it.
Definition: RaggettExternal.php:15