summaryrefslogtreecommitdiff
path: root/www/wiki/includes/api/ApiEmailUser.php
diff options
context:
space:
mode:
Diffstat (limited to 'www/wiki/includes/api/ApiEmailUser.php')
-rw-r--r--www/wiki/includes/api/ApiEmailUser.php115
1 files changed, 115 insertions, 0 deletions
diff --git a/www/wiki/includes/api/ApiEmailUser.php b/www/wiki/includes/api/ApiEmailUser.php
new file mode 100644
index 00000000..535a3e80
--- /dev/null
+++ b/www/wiki/includes/api/ApiEmailUser.php
@@ -0,0 +1,115 @@
+<?php
+/**
+ * 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'], $this->getUser() );
+ if ( !( $targetUser instanceof User ) ) {
+ switch ( $targetUser ) {
+ case 'notarget':
+ $this->dieWithError( 'apierror-notarget' );
+ case 'noemail':
+ $this->dieWithError( [ 'noemail', $params['target'] ] );
+ case 'nowikiemail':
+ $this->dieWithError( 'nowikiemailtext', 'nowikiemail' );
+ default:
+ $this->dieWithError( [ 'apierror-unknownerror', $targetUser ] );
+ }
+ }
+
+ // Check permissions and errors
+ $error = SpecialEmailUser::getPermissionsError(
+ $this->getUser(),
+ $params['token'],
+ $this->getConfig()
+ );
+ if ( $error ) {
+ $this->dieWithError( $error );
+ }
+
+ $data = [
+ 'Target' => $targetUser->getName(),
+ 'Text' => $params['text'],
+ 'Subject' => $params['subject'],
+ 'CCMe' => $params['ccme'],
+ ];
+ $retval = SpecialEmailUser::submit( $data, $this->getContext() );
+ if ( !$retval instanceof Status ) {
+ // This is probably the reason
+ $retval = Status::newFatal( 'hookaborted' );
+ }
+
+ $result = array_filter( [
+ 'result' => $retval->isGood() ? 'Success' : ( $retval->isOK() ? 'Warnings' : 'Failure' ),
+ 'warnings' => $this->getErrorFormatter()->arrayFromStatus( $retval, 'warning' ),
+ 'errors' => $this->getErrorFormatter()->arrayFromStatus( $retval, 'error' ),
+ ] );
+
+ $this->getResult()->addValue( null, $this->getModuleName(), $result );
+ }
+
+ public function mustBePosted() {
+ return true;
+ }
+
+ public function isWriteMode() {
+ return true;
+ }
+
+ public function getAllowedParams() {
+ return [
+ 'target' => [
+ ApiBase::PARAM_TYPE => 'string',
+ ApiBase::PARAM_REQUIRED => true
+ ],
+ 'subject' => null,
+ 'text' => [
+ ApiBase::PARAM_TYPE => 'text',
+ ApiBase::PARAM_REQUIRED => true
+ ],
+ 'ccme' => false,
+ ];
+ }
+
+ public function needsToken() {
+ return 'csrf';
+ }
+
+ protected function getExamplesMessages() {
+ return [
+ 'action=emailuser&target=WikiSysop&text=Content&token=123ABC'
+ => 'apihelp-emailuser-example-email',
+ ];
+ }
+
+ public function getHelpUrls() {
+ return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Email';
+ }
+}