Skip to content

Fix account creation when a captcha is required #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jajm wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix account creation when a captcha is required #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions config/module.config.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
'factories' => [
'Scripto\Form\Element\MediaTypeSelect' => Scripto\Service\Form\Element\MediaTypeSelectFactory::class,
'Scripto\Form\ModuleConfigForm' => Scripto\Service\Form\ModuleConfigFormFactory::class,
'Scripto\Form\CreateAccountForm' => Scripto\Service\Form\CreateAccountFormFactory::class,
],
],
'controllers' => [
Expand Down
5 changes: 1 addition & 4 deletions src/Controller/PublicApp/IndexController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,7 @@ public function createAccountAction()
if ($form->isValid()) {
$formData = $form->getData();
try {
$this->scripto()->apiClient()->createAccount(
$formData['username'], $formData['password'], $formData['retype'],
$formData['email'], $formData['realname']
);
$this->scripto()->apiClient()->createAccount($formData);
$this->messenger()->addSuccess('Your Scripto account has been created! Please check your email for a link to activate your account.'); // @translate
return $this->redirect()->toRoute('scripto');
} catch (CreateaccountException $e) {
Expand Down
191 changes: 122 additions & 69 deletions src/Form/CreateAccountForm.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,53 +7,94 @@ class CreateAccountForm extends Form
{
public function init()
{
$this->add([
'type' => 'text',
'name' => 'username',
'options' => [
'label' => 'Username', // @translate
],
'attributes' => [
'required' => true,
],
]);
$this->add([
'type' => 'password',
'name' => 'password',
'options' => [
'label' => 'Password', // @translate
],
'attributes' => [
'required' => true,
],
]);
$this->add([
'type' => 'password',
'name' => 'retype',
'options' => [
'label' => 'Confirm password', // @translate
],
'attributes' => [
'required' => true,
],
]);
$this->add([
'type' => 'email',
'name' => 'email',
'options' => [
'label' => 'Email address', // @translate
],
'attributes' => [
'required' => true,
],
]);
$this->add([
'type' => 'text',
'name' => 'realname',
'options' => [
'label' => 'Real name', // @translate
],
]);
$fields = $this->getOption('fields') ?? [];

if (isset($fields['username'])) {
$this->add([
'type' => 'text',
'name' => 'username',
'options' => [
'label' => 'Username', // @translate
],
'attributes' => [
'required' => true,
],
]);
}

if (isset($fields['password'])) {
$this->add([
'type' => 'password',
'name' => 'password',
'options' => [
'label' => 'Password', // @translate
],
'attributes' => [
'required' => true,
],
]);
}

if (isset($fields['retype'])) {
$this->add([
'type' => 'password',
'name' => 'retype',
'options' => [
'label' => 'Confirm password', // @translate
],
'attributes' => [
'required' => true,
],
]);
}

if (isset($fields['email'])) {
$this->add([
'type' => 'email',
'name' => 'email',
'options' => [
'label' => 'Email address', // @translate
],
'attributes' => [
'required' => true,
],
]);
}

if (isset($fields['realname'])) {
$this->add([
'type' => 'text',
'name' => 'realname',
'options' => [
'label' => 'Real name', // @translate
],
]);
}

if (isset($fields['captchaId'])) {
$captchaId = $fields['captchaId']['value'];
$this->add([
'name' => 'captchaId',
'type' => 'hidden',
'attributes' => [
'value' => $captchaId,
],
]);
}

if (isset($fields['captchaWord'])) {
$this->add([
'name' => 'captchaWord',
'type' => 'text',
'options' => [
'label' => sprintf('CAPTCHA: %s', $fields['captchaInfo']['value']),
],
'attributes' => [
'required' => true,
],
]);
}

$this->add([
'name' => 'submit',
'type' => 'submit',
Expand All @@ -63,29 +104,41 @@ public function init()
]);

$inputFilter = $this->getInputFilter();
$inputFilter->add([
'name' => 'username',
'required' => true,
]);
$inputFilter->add([
'name' => 'password',
'required' => true,
]);
$inputFilter->add([
'name' => 'retype',
'required' => true,
'validators' => [
[
'name' => 'identical',
'options' => [
'token' => 'password',

if (isset($fields['username'])) {
$inputFilter->add([
'name' => 'username',
'required' => true,
]);
}

if (isset($fields['password'])) {
$inputFilter->add([
'name' => 'password',
'required' => true,
]);
}

if (isset($fields['retype'])) {
$inputFilter->add([
'name' => 'retype',
'required' => true,
'validators' => [
[
'name' => 'identical',
'options' => [
'token' => 'password',
],
],
],
],
]);
$inputFilter->add([
'name' => 'email',
'required' => true,
]);
]);
}

if (isset($fields['email'])) {
$inputFilter->add([
'name' => 'email',
'required' => true,
]);
}
}
}
38 changes: 26 additions & 12 deletions src/Mediawiki/ApiClient.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -901,34 +901,48 @@ public function queryUserInfo()
return $this->userInfo;
}

/**
* Retrieve the list of fields available to build the user creation form
*
* @return array An associative array of all the available fields
*/
public function getCreateAccountFields()
{
$res = $this->request([
'action' => 'query',
'meta' => 'authmanagerinfo',
'amirequestsfor' => 'create',
'amimergerequestfields' => '1',
]);

// Some Mediawiki captcha stores need cookies to be set (CaptchaSessionStore)
$this->session->cookies = $this->httpClient->getCookies();

return $res['query']['authmanagerinfo']['fields'];
}

/**
* Create a MediaWiki account using the default requests.
*
* @link https://www.mediawiki.org/wiki/API:Account_creation
* @param string $username Username for authentication
* @param string $password Password for authentication
* @param string $retype Retype password
* @param string $email Email address
* @param string $realname Real name of the user
* @param array $data Data to be sent to API for the 'createaccount'
* action. Keys should be the same as the result of
* getCreateAccountFields
* @return array The successful create account result
*/
public function createAccount($username, $password, $retype, $email, $realname)
public function createAccount(array $data): array
{
$query = $this->request([
'action' => 'query',
'meta' => 'tokens',
'type' => 'createaccount',
]);
$createaccount = $this->request([
$data = array_merge($data, [
'action' => 'createaccount',
'createreturnurl' => 'http://example.com/', // currently unused but required
'createtoken' => $query['query']['tokens']['createaccounttoken'],
'username' => $username,
'password' => $password,
'retype' => $password,
'email' => $email,
'realname' => $realname,
]);
$createaccount = $this->request($data);
if (isset($createaccount['error'])) {
throw new Exception\CreateaccountException($createaccount['error']['info']);
}
Expand Down
18 changes: 18 additions & 0 deletions src/Service/Form/CreateAccountFormFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?php
namespace Scripto\Service\Form;

use Scripto\Form\CreateAccountForm;
use Laminas\ServiceManager\Factory\FactoryInterface;
use Interop\Container\ContainerInterface;

class CreateAccountFormFactory implements FactoryInterface
{
public function __invoke(ContainerInterface $services, $requestedName, array $options = null)
{
$apiClient = $services->get('Scripto\Mediawiki\ApiClient');

$form = new CreateAccountForm(null, ['fields' => $apiClient->getCreateAccountFields()]);

return $form;
}
}