df80f1ead5
New types 'text' and 'password' for where a <textarea> or <input type="password"> would be preferred over <input type="text">. Some timestamp parameters get actually tagged as 'timestamp'. 'submodule' types change the 'submodules' output property from a boolean to an object indicating the mapping from values to module paths. And they get an indication of the submodule parameter prefix (e.g. generator's "g"), if applicable. "generator" actually gets reported as a submodule type, using this new mechanism. action=paraminfo will now indicate ApiBase::PARAM_RANGE_ENFORCE status, and return better-formatted defaults for timestamps and booleans. Change-Id: Ic862d6f8fe13f7eb6b4298683514d33af5823e47
119 lines
2.8 KiB
PHP
119 lines
2.8 KiB
PHP
<?php
|
|
/**
|
|
*
|
|
*
|
|
* Created on June 1, 2008
|
|
*
|
|
* Copyright © 2008 Bryan Tong Minh <Bryan.TongMinh@Gmail.com>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
/**
|
|
* API Module to facilitate sending of emails to users
|
|
* @ingroup API
|
|
*/
|
|
class ApiEmailUser extends ApiBase {
|
|
|
|
public function execute() {
|
|
$params = $this->extractRequestParams();
|
|
|
|
// Validate target
|
|
$targetUser = SpecialEmailUser::getTarget( $params['target'] );
|
|
if ( !( $targetUser instanceof User ) ) {
|
|
$this->dieUsageMsg( array( $targetUser ) );
|
|
}
|
|
|
|
// Check permissions and errors
|
|
$error = SpecialEmailUser::getPermissionsError(
|
|
$this->getUser(),
|
|
$params['token'],
|
|
$this->getConfig()
|
|
);
|
|
if ( $error ) {
|
|
$this->dieUsageMsg( array( $error ) );
|
|
}
|
|
|
|
$data = array(
|
|
'Target' => $targetUser->getName(),
|
|
'Text' => $params['text'],
|
|
'Subject' => $params['subject'],
|
|
'CCMe' => $params['ccme'],
|
|
);
|
|
$retval = SpecialEmailUser::submit( $data, $this->getContext() );
|
|
|
|
if ( $retval instanceof Status ) {
|
|
// SpecialEmailUser sometimes returns a status
|
|
// sometimes it doesn't.
|
|
if ( $retval->isGood() ) {
|
|
$retval = true;
|
|
} else {
|
|
$retval = $retval->getErrorsArray();
|
|
}
|
|
}
|
|
|
|
if ( $retval === true ) {
|
|
$result = array( 'result' => 'Success' );
|
|
} else {
|
|
$result = array(
|
|
'result' => 'Failure',
|
|
'message' => $retval
|
|
);
|
|
}
|
|
|
|
$this->getResult()->addValue( null, $this->getModuleName(), $result );
|
|
}
|
|
|
|
public function mustBePosted() {
|
|
return true;
|
|
}
|
|
|
|
public function isWriteMode() {
|
|
return true;
|
|
}
|
|
|
|
public function getAllowedParams() {
|
|
return array(
|
|
'target' => array(
|
|
ApiBase::PARAM_TYPE => 'string',
|
|
ApiBase::PARAM_REQUIRED => true
|
|
),
|
|
'subject' => null,
|
|
'text' => array(
|
|
ApiBase::PARAM_TYPE => 'text',
|
|
ApiBase::PARAM_REQUIRED => true
|
|
),
|
|
'ccme' => false,
|
|
);
|
|
}
|
|
|
|
public function needsToken() {
|
|
return 'csrf';
|
|
}
|
|
|
|
protected function getExamplesMessages() {
|
|
return array(
|
|
'action=emailuser&target=WikiSysop&text=Content&token=123ABC'
|
|
=> 'apihelp-emailuser-example-email',
|
|
);
|
|
}
|
|
|
|
public function getHelpUrls() {
|
|
return 'https://www.mediawiki.org/wiki/API:Email';
|
|
}
|
|
}
|