MediaWiki REL1_28
SpecialComparePages.php
Go to the documentation of this file.
1<?php
32
33 // Stored objects
34 protected $opts, $skin;
35
36 // Some internal settings
37 protected $showNavigation = false;
38
39 public function __construct() {
40 parent::__construct( 'ComparePages' );
41 }
42
49 public function execute( $par ) {
50 $this->setHeaders();
51 $this->outputHeader();
52 $this->getOutput()->addModuleStyles( 'mediawiki.special.comparepages.styles' );
53
54 $form = HTMLForm::factory( 'ooui', [
55 'Page1' => [
56 'type' => 'title',
57 'name' => 'page1',
58 'label-message' => 'compare-page1',
59 'size' => '40',
60 'section' => 'page1',
61 'validation-callback' => [ $this, 'checkExistingTitle' ],
62 ],
63 'Revision1' => [
64 'type' => 'int',
65 'name' => 'rev1',
66 'label-message' => 'compare-rev1',
67 'size' => '8',
68 'section' => 'page1',
69 'validation-callback' => [ $this, 'checkExistingRevision' ],
70 ],
71 'Page2' => [
72 'type' => 'title',
73 'name' => 'page2',
74 'label-message' => 'compare-page2',
75 'size' => '40',
76 'section' => 'page2',
77 'validation-callback' => [ $this, 'checkExistingTitle' ],
78 ],
79 'Revision2' => [
80 'type' => 'int',
81 'name' => 'rev2',
82 'label-message' => 'compare-rev2',
83 'size' => '8',
84 'section' => 'page2',
85 'validation-callback' => [ $this, 'checkExistingRevision' ],
86 ],
87 'Action' => [
88 'type' => 'hidden',
89 'name' => 'action',
90 ],
91 'Diffonly' => [
92 'type' => 'hidden',
93 'name' => 'diffonly',
94 ],
95 'Unhide' => [
96 'type' => 'hidden',
97 'name' => 'unhide',
98 ],
99 ], $this->getContext(), 'compare' );
100 $form->setSubmitTextMsg( 'compare-submit' );
101 $form->suppressReset();
102 $form->setMethod( 'get' );
103 $form->setSubmitCallback( [ __CLASS__, 'showDiff' ] );
104
105 $form->loadData();
106 $form->displayForm( '' );
107 $form->trySubmit();
108 }
109
110 public static function showDiff( $data, HTMLForm $form ) {
111 $rev1 = self::revOrTitle( $data['Revision1'], $data['Page1'] );
112 $rev2 = self::revOrTitle( $data['Revision2'], $data['Page2'] );
113
114 if ( $rev1 && $rev2 ) {
115 $revision = Revision::newFromId( $rev1 );
116
117 if ( $revision ) { // NOTE: $rev1 was already checked, should exist.
118 $contentHandler = $revision->getContentHandler();
119 $de = $contentHandler->createDifferenceEngine( $form->getContext(),
120 $rev1,
121 $rev2,
122 null, // rcid
123 ( $data['Action'] == 'purge' ),
124 ( $data['Unhide'] == '1' )
125 );
126 $de->showDiffPage( true );
127 }
128 }
129 }
130
131 public static function revOrTitle( $revision, $title ) {
132 if ( $revision ) {
133 return $revision;
134 } elseif ( $title ) {
135 $title = Title::newFromText( $title );
136 if ( $title instanceof Title ) {
137 return $title->getLatestRevID();
138 }
139 }
140
141 return null;
142 }
143
144 public function checkExistingTitle( $value, $alldata ) {
145 if ( $value === '' || $value === null ) {
146 return true;
147 }
148 $title = Title::newFromText( $value );
149 if ( !$title instanceof Title ) {
150 return $this->msg( 'compare-invalid-title' )->parseAsBlock();
151 }
152 if ( !$title->exists() ) {
153 return $this->msg( 'compare-title-not-exists' )->parseAsBlock();
154 }
155
156 return true;
157 }
158
159 public function checkExistingRevision( $value, $alldata ) {
160 if ( $value === '' || $value === null ) {
161 return true;
162 }
163 $revision = Revision::newFromId( $value );
164 if ( $revision === null ) {
165 return $this->msg( 'compare-revision-not-exists' )->parseAsBlock();
166 }
167
168 return true;
169 }
170
171 protected function getGroupName() {
172 return 'pagetools';
173 }
174}
getContext()
Get the base IContextSource object.
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition HTMLForm.php:128
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition HTMLForm.php:275
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
Definition Revision.php:110
Implements Special:ComparePages.
static revOrTitle( $revision, $title)
checkExistingTitle( $value, $alldata)
static showDiff( $data, HTMLForm $form)
execute( $par)
Show a form for filtering namespace and username.
checkExistingRevision( $value, $alldata)
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Parent class for all special pages.
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
getOutput()
Get the OutputPage being used for this instance.
getContext()
Gets the context this SpecialPage is executed in.
msg()
Wrapper around wfMessage that sets the current context.
Represents a title within MediaWiki.
Definition Title.php:36
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:986
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