MediaWiki  1.30.0
QuestyCaptcha.class.php
Go to the documentation of this file.
1 <?php
2 
11 use MediaWiki\Auth\AuthenticationRequest;
12 
14  // used for questycaptcha-edit, questycaptcha-addurl, questycaptcha-badlogin,
15  // questycaptcha-createaccount, questycaptcha-create, questycaptcha-sendemail via getMessage()
16  protected static $messagePrefix = 'questycaptcha-';
17 
24  function keyMatch( $answer, $info ) {
25  if ( is_array( $info['answer'] ) ) {
26  return in_array( strtolower( $answer ), array_map( 'strtolower', $info['answer'] ) );
27  } else {
28  return strtolower( $answer ) == strtolower( $info['answer'] );
29  }
30  }
31 
35  function addCaptchaAPI( &$resultArr ) {
36  $captcha = $this->getCaptcha();
37  $index = $this->storeCaptcha( $captcha );
38  $resultArr['captcha'] = $this->describeCaptchaType();
39  $resultArr['captcha']['id'] = $index;
40  $resultArr['captcha']['question'] = $captcha['question'];
41  }
42 
46  public function describeCaptchaType() {
47  return [
48  'type' => 'question',
49  'mime' => 'text/html',
50  ];
51  }
52 
56  function getCaptcha() {
57  global $wgCaptchaQuestions;
58 
59  // Backwards compatibility
60  if ( $wgCaptchaQuestions === array_values( $wgCaptchaQuestions ) ) {
61  return $wgCaptchaQuestions[ mt_rand( 0, count( $wgCaptchaQuestions ) - 1 ) ];
62  }
63 
64  $question = array_rand( $wgCaptchaQuestions, 1 );
65  $answer = $wgCaptchaQuestions[ $question ];
66  return [ 'question' => $question, 'answer' => $answer ];
67  }
68 
73  function getFormInformation( $tabIndex = 1 ) {
74  $captcha = $this->getCaptcha();
75  if ( !$captcha ) {
76  die(
77  "No questions found; set some in LocalSettings.php using the format from QuestyCaptcha.php."
78  );
79  }
80  $index = $this->storeCaptcha( $captcha );
81  return [
82  'html' => "<p><label for=\"wpCaptchaWord\">{$captcha['question']}</label> " .
83  Html::element( 'input', [
84  'name' => 'wpCaptchaWord',
85  'id' => 'wpCaptchaWord',
86  'class' => 'mw-ui-input',
87  'required',
88  'autocomplete' => 'off',
89  'tabindex' => $tabIndex ] ) . // tab in before the edit textarea
90  "</p>\n" .
91  Xml::element( 'input', [
92  'type' => 'hidden',
93  'name' => 'wpCaptchaId',
94  'id' => 'wpCaptchaId',
95  'value' => $index ] )
96  ];
97  }
98 
99  function showHelp() {
100  global $wgOut;
101  $wgOut->setPageTitle( wfMessage( 'captchahelp-title' )->text() );
102  $wgOut->addWikiMsg( 'questycaptchahelp-text' );
103  if ( CaptchaStore::get()->cookiesNeeded() ) {
104  $wgOut->addWikiMsg( 'captchahelp-cookies-needed' );
105  }
106  }
107 
113  public function getCaptchaInfo( $captchaData, $id ) {
114  return $captchaData['question'];
115  }
116 
123  public function onAuthChangeFormFields( array $requests, array $fieldInfo,
124  array &$formDescriptor, $action ) {
126  $req =
127  AuthenticationRequest::getRequestByClass( $requests,
129  if ( !$req ) {
130  return;
131  }
132 
133  // declare RAW HTML output.
134  $formDescriptor['captchaInfo']['raw'] = true;
135  $formDescriptor['captchaWord']['label-message'] = null;
136  }
137 }
QuestyCaptcha::getFormInformation
getFormInformation( $tabIndex=1)
Definition: QuestyCaptcha.class.php:73
CaptchaStore\get
static get()
Get somewhere to store captcha data that will persist between requests.
Definition: CaptchaStore.php:44
QuestyCaptcha
Definition: QuestyCaptcha.class.php:13
QuestyCaptcha::$messagePrefix
static $messagePrefix
Definition: QuestyCaptcha.class.php:16
captcha-old.count
count
Definition: captcha-old.py:249
text
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:12
QuestyCaptcha::describeCaptchaType
describeCaptchaType()
Definition: QuestyCaptcha.class.php:46
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
$req
this hook is for auditing only $req
Definition: hooks.txt:988
SimpleCaptcha\$action
string $action
Used to select the right message.
Definition: Captcha.php:20
QuestyCaptcha::getCaptcha
getCaptcha()
Definition: QuestyCaptcha.class.php:56
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:35
Xml\element
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:39
QuestyCaptcha::getCaptchaInfo
getCaptchaInfo( $captchaData, $id)
Definition: QuestyCaptcha.class.php:113
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
SimpleCaptcha
Demo CAPTCHA (not for production usage) and base class for real CAPTCHAs.
Definition: Captcha.php:9
SimpleCaptcha\storeCaptcha
storeCaptcha( $info)
Generate a captcha session ID and save the info in PHP's session storage.
Definition: Captcha.php:1030
QuestyCaptcha::keyMatch
keyMatch( $answer, $info)
Validate a captcha response.
Definition: QuestyCaptcha.class.php:24
QuestyCaptcha::onAuthChangeFormFields
onAuthChangeFormFields(array $requests, array $fieldInfo, array &$formDescriptor, $action)
Definition: QuestyCaptcha.class.php:123
$requests
Allows to change the fields on the form that will be generated are created Can be used to omit specific feeds from being outputted You must not use this hook to add use OutputPage::addFeedLink() instead. & $feedLinks hooks can tweak the array to change how login etc forms should look $requests
Definition: hooks.txt:304
QuestyCaptcha::addCaptchaAPI
addCaptchaAPI(&$resultArr)
Definition: QuestyCaptcha.class.php:35
wfMessage
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
Html\element
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
QuestyCaptcha::showHelp
showHelp()
Show a page explaining what this wacky thing is.
Definition: QuestyCaptcha.class.php:99
$wgOut
$wgOut
Definition: Setup.php:819
array
the array() calling protocol came about after MediaWiki 1.4rc1.