-
Notifications
You must be signed in to change notification settings - Fork 5
/
QuestionPoster.php
555 lines (494 loc) · 12.8 KB
/
QuestionPoster.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
<?php
namespace GrowthExperiments\HelpPanel\QuestionPoster;
use CommentStoreComment;
use Config;
use Content;
use DerivativeContext;
use ExtensionRegistry;
use FatalError;
use Flow\Container;
use GrowthExperiments\HelpPanel\QuestionRecord;
use GrowthExperiments\HelpPanel\QuestionStoreFactory;
use Hooks;
use IContextSource;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\WikiPageFactory;
use MediaWiki\Revision\SlotRecord;
use MediaWiki\Storage\PageUpdater;
use MWException;
use Status;
use Title;
use UserNotLoggedIn;
use WikiPage;
use WikitextContent;
/**
* Base class for sending messages containing user questions to some target page.
*/
abstract class QuestionPoster {
/**
* @var WikiPageFactory
*/
private $wikiPageFactory;
/**
* @var IContextSource
*/
private $context;
/**
* @var bool
*/
private $isFirstEdit;
/**
* @var Config
*/
private $config;
/**
* @var Title
*/
private $targetTitle;
/**
* @var string
*/
private $resultUrl;
/**
* @var PageUpdater
*/
protected $pageUpdater;
/**
* @var mixed
*/
private $revisionId;
/**
* @var string
*/
protected $relevantTitle;
/**
* @var string
*/
private $postedOnTimestamp;
/**
* @var QuestionRecord[]
*/
private $existingQuestionsByUser;
/**
* @var string
*/
private $body;
/**
* @var string
*/
private $sectionHeader;
/**
* @param WikiPageFactory $wikiPageFactory
* @param IContextSource $context
* @param string $body
* @param string $relevantTitle
* @throws UserNotLoggedIn
*/
public function __construct(
WikiPageFactory $wikiPageFactory, IContextSource $context, $body, $relevantTitle = ''
) {
$this->wikiPageFactory = $wikiPageFactory;
$this->context = $context;
$this->relevantTitle = $relevantTitle;
if ( $this->getContext()->getUser()->isAnon() ) {
throw new UserNotLoggedIn();
}
$this->config = $this->getContext()->getConfig();
$this->isFirstEdit = ( $this->getContext()->getUser()->getEditCount() === 0 );
$this->targetTitle = $this->getTargetTitle();
$page = new WikiPage( $this->targetTitle );
$this->pageUpdater = $page->newPageUpdater( $this->getContext()->getUser() );
$this->body = trim( $body );
}
/**
* Load the current user's existing questions.
*/
protected function loadExistingQuestions() {
$questionStore = QuestionStoreFactory::newFromContextAndStorage(
$this->getContext(),
$this->getQuestionStoragePref()
);
$this->existingQuestionsByUser = $questionStore->loadQuestions();
}
/**
* @return Status
* @throws MWException
* @throws \Exception
*/
public function submit() {
$this->loadExistingQuestions();
$this->postedOnTimestamp = wfTimestamp();
$this->setSectionHeader();
$contentModel = $this->getTargetContentModel();
if ( $contentModel === CONTENT_MODEL_WIKITEXT ) {
$status = $this->submitWikitext();
} elseif (
ExtensionRegistry::getInstance()->isLoaded( 'Flow' ) &&
$contentModel === CONTENT_MODEL_FLOW_BOARD
) {
$status = $this->submitStructuredDiscussions();
} else {
throw new \Exception( "Content model $contentModel is not supported." );
}
if ( $status->isGood() ) {
$this->saveNewQuestion();
}
return $status;
}
/**
* @return string Content model of the target page. One of the CONTENT_MODEL_* constants.
*/
protected function getTargetContentModel() {
return $this->targetTitle->getContentModel();
}
/**
* @return Status
* @throws MWException
* @throws \Exception
*/
private function submitWikitext() {
$content = $this->makeWikitextContent();
$contentStatus = $this->checkContent( $content );
if ( !$contentStatus->isGood() ) {
return $contentStatus;
}
$permissionStatus = $this->checkPermissions( $content );
if ( !$permissionStatus->isGood() ) {
return $permissionStatus;
}
$this->getPageUpdater()->addTag( $this->getTag() );
$this->getPageUpdater()->setContent( SlotRecord::MAIN, $content );
$newRev = $this->getPageUpdater()->saveRevision(
CommentStoreComment::newUnsavedComment(
$this->getContext()
->msg( 'newsectionsummary' )
->params(
MediaWikiServices::getInstance()
->getParserFactory()
->create()
->stripSectionName( $this->getSectionHeader() )
)
->text()
)
);
if ( !$this->getPageUpdater()->getStatus()->isGood() ) {
return $this->getPageUpdater()->getStatus();
}
$this->revisionId = $newRev->getId();
$this->targetTitle->setFragment(
MediaWikiServices::getInstance()
->getParser()
->guessSectionNameFromWikiText( $this->getSectionHeader() )
);
$this->setResultUrl( $this->targetTitle->getLinkURL() );
return Status::newGood();
}
/**
* @return Status
* @throws MWException
*/
private function submitStructuredDiscussions() {
$workflowLoaderFactory = Container::get( 'factory.loader.workflow' );
$loader = $workflowLoaderFactory->createWorkflowLoader( $this->targetTitle );
$blocks = $loader->handleSubmit(
$this->getContext(),
'new-topic',
[
'topiclist' => [
'topic' => $this->getSectionHeader(),
'content' => $this->getBody(),
'format' => 'wikitext',
],
]
);
$status = Status::newGood();
foreach ( $blocks as $block ) {
if ( $block->hasErrors() ) {
$errors = $block->getErrors();
foreach ( $errors as $errorKey ) {
$status->fatal( $block->getErrorMessage( $errorKey ) );
}
}
}
if ( !$status->isOK() ) {
return $status;
}
$commitMetadata = $loader->commit( $blocks );
$topicTitle = Title::newFromText( $commitMetadata['topiclist']['topic-page'] );
$this->setResultUrl( $topicTitle->getLinkURL() );
$this->revisionId = $commitMetadata['topiclist']['topic-id']->getAlphadecimal();
return Status::newGood();
}
private function getNumberedSectionHeaderIfDuplicatesExist( $sectionHeader ) {
$sectionHeaders = array_map(
function ( QuestionRecord $questionRecord ) {
return $questionRecord->getSectionHeader();
},
$this->existingQuestionsByUser
);
$counter = 1;
while ( in_array( $counter === 1 ? $sectionHeader : "$sectionHeader ($counter)",
$sectionHeaders ) ) {
$counter++;
}
return $counter === 1 ? $sectionHeader : $sectionHeader . ' (' . $counter . ')';
}
/**
* @param Content $content
* @return Status
* @throws FatalError
* @throws MWException
*/
protected function checkPermissions( $content ) {
$userPermissionStatus = $this->checkUserPermissions();
if ( !$userPermissionStatus->isGood() ) {
return $userPermissionStatus;
}
$editFilterMergedContentHookStatus = $this->runEditFilterMergedContentHook(
$content,
$this->getSectionHeaderTemplate()
);
if ( !$editFilterMergedContentHookStatus->isGood() ) {
return $editFilterMergedContentHookStatus;
}
return Status::newGood();
}
/**
* The tag to add to the edit.
*/
abstract protected function getTag();
/**
* Create a Content object with the header and question text provided by the user.
*
* @return Content|null
* @throws MWException
*/
protected function makeWikitextContent() {
$wikitextContent = new WikitextContent(
$this->addSignature( $this->getBody() )
);
$header = $this->getSectionHeader();
$parent = $this->getPageUpdater()->grabParentRevision();
if ( !$parent ) {
return $wikitextContent->addSectionHeader( $header );
}
$existingContent = $parent->getContent( SlotRecord::MAIN );
if ( !$existingContent ) {
return null;
}
return $existingContent->replaceSection(
'new',
$wikitextContent,
$header
);
}
/**
* @return PageUpdater
*/
protected function getPageUpdater() {
return $this->pageUpdater;
}
/**
* Add signature unless already set.
*
* @param string $body
* @return string
*/
private function addSignature( $body ) {
if ( strpos( $body, '~~~~' ) === false ) {
$body .= " --~~~~";
}
return $body;
}
/**
* @return Status
*/
public function validateRelevantTitle() {
$title = Title::newFromText( $this->relevantTitle );
return $title && $title->isValid() ?
Status::newGood() :
Status::newFatal( 'growthexperiments-help-panel-questionposter-invalid-title' );
}
/**
* @return string
*/
public function getResultUrl() {
return $this->resultUrl;
}
/**
* @return int
*/
public function getRevisionId() {
return $this->revisionId;
}
/**
* @return bool
*/
public function isFirstEdit() {
return $this->isFirstEdit;
}
/**
* Get the section header template for the question posted by the user.
*
* This method is used for generating the comment summary as well as the
* section header in the edit.
*
* @return string
*/
abstract protected function getSectionHeaderTemplate();
/**
* Set the result URL to go directly to the newly created question.
*
* @param string $resultUrl
*/
private function setResultUrl( $resultUrl ) {
$this->resultUrl = $resultUrl;
}
/**
* Set the section header with a timestamp (wikitext only) and number.
*
* THe number is appended for flow posts. For wikitext posts, a number is appended
* only if duplicate headers exist, which can happen when questions
* are posted within the same minute.
*/
protected function setSectionHeader() {
$this->sectionHeader = $this->getSectionHeaderTemplate();
// If wikitext, override the section header to include the timestamp.
if ( $this->getTargetContentModel() === CONTENT_MODEL_WIKITEXT ) {
$this->sectionHeader .= ' ' . $this->getContext()
->msg( 'parentheses' )
->plaintextParams( $this->getFormattedPostedOnTimestamp() )
->inContentLanguage()
->escaped();
}
$this->sectionHeader = $this->getNumberedSectionHeaderIfDuplicatesExist(
$this->sectionHeader
);
}
/**
* @return string
*/
private function getSectionHeader() {
return $this->sectionHeader;
}
/**
* @return string
*/
private function getPostedOnTimestamp() {
return $this->postedOnTimestamp;
}
/**
* Timezone adjustment, site default format, and site default time zone are used for formatting.
* @return string
*/
private function getFormattedPostedOnTimestamp() {
return MediaWikiServices::getInstance()->getContentLanguage()
->timeanddate( $this->getPostedOnTimestamp(), true, false, '' );
}
/**
* @return Title The page where the question should be posted.
*/
protected function getTargetTitle() : Title {
$title = $this->getDirectTargetTitle();
if ( $title->isRedirect() ) {
$page = $this->wikiPageFactory->newFromTitle( $title );
return $page->getRedirectTarget();
}
return $title;
}
/**
* @return Title The page where the question should be posted (barring redirects).
*/
abstract protected function getDirectTargetTitle();
/**
* @return IContextSource
*/
final protected function getContext() {
return $this->context;
}
/**
* The preference name where the posted question will be stored.
*
* @return string
*/
abstract protected function getQuestionStoragePref();
/**
* @return Status
* @throws \Exception
*/
protected function checkUserPermissions() {
$permissionsManager = MediaWikiServices::getInstance()->getPermissionManager();
$errors = $permissionsManager->getPermissionErrors(
'edit',
$this->getContext()->getUser(),
$this->targetTitle
);
if ( count( $errors ) ) {
$key = array_shift( $errors[0] );
$message = $this->getContext()->msg( $key )
->params( $errors[0] )
->parse();
return Status::newFatal( $message );
}
return Status::newGood();
}
/**
* @param Content $content
* @param string $summary
* @return Status
* @throws MWException
* @throws FatalError
*/
protected function runEditFilterMergedContentHook( Content $content, $summary ) {
$derivativeContext = new DerivativeContext( $this->getContext() );
$derivativeContext->setConfig( MediaWikiServices::getInstance()->getMainConfig() );
$derivativeContext->setTitle( $this->targetTitle );
$derivativeContext->setWikiPage( WikiPage::factory( $this->targetTitle ) );
$status = new Status();
if ( !Hooks::run( 'EditFilterMergedContent', [
$derivativeContext,
$content,
$status,
$summary,
$derivativeContext->getUser(),
false
] ) ) {
if ( $status->isGood() ) {
$status->fatal( 'hookaborted' );
}
return $status;
}
return $status;
}
private function getBody() {
return $this->body;
}
/**
* Validate that $content is an instance of Content
*
* @param Content|null $content
* @return Status
*/
protected function checkContent( $content ) {
return $content instanceof Content ?
Status::newGood() :
Status::newFatal(
'apierror-missingcontent-revid',
$this->getPageUpdater()->grabParentRevision()->getId()
);
}
private function saveNewQuestion() {
$question = new QuestionRecord(
$this->getBody(),
$this->getSectionHeader(),
$this->revisionId,
$this->getPostedOnTimestamp(),
$this->getResultUrl(),
$this->getTargetContentModel()
);
QuestionStoreFactory::newFromContextAndStorage(
$this->getContext(),
$this->getQuestionStoragePref()
)->add( $question );
}
}