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
|
<?php
/*
* Created on June 1, 2008
* API for MediaWiki 1.8+
*
* Copyright (C) 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.,
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
* http://www.gnu.org/copyleft/gpl.html
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once ( "ApiBase.php" );
}
/**
* @ingroup API
*/
class ApiEmailUser extends ApiBase {
public function __construct( $main, $action ) {
parent :: __construct( $main, $action );
}
public function execute() {
global $wgUser;
// Check whether email is enabled
if ( !EmailUserForm::userEmailEnabled() )
$this->dieUsageMsg( array( 'usermaildisabled' ) );
$params = $this->extractRequestParams();
// Check required parameters
if ( !isset( $params['target'] ) )
$this->dieUsageMsg( array( 'missingparam', 'target' ) );
if ( !isset( $params['text'] ) )
$this->dieUsageMsg( array( 'missingparam', 'text' ) );
// Validate target
$targetUser = EmailUserForm::validateEmailTarget( $params['target'] );
if ( !( $targetUser instanceof User ) )
$this->dieUsageMsg( array( $targetUser ) );
// Check permissions
$error = EmailUserForm::getPermissionsError( $wgUser, $params['token'] );
if ( $error )
$this->dieUsageMsg( array( $error ) );
$form = new EmailUserForm( $targetUser, $params['text'], $params['subject'], $params['ccme'] );
$retval = $form->doSubmit();
if ( is_null( $retval ) )
$result = array( 'result' => 'Success' );
else
$result = array( 'result' => 'Failure',
'message' => $retval->getMessage() );
$this->getResult()->addValue( null, $this->getModuleName(), $result );
}
public function mustBePosted() {
return true;
}
public function isWriteMode() {
return true;
}
public function getAllowedParams() {
return array (
'target' => null,
'subject' => null,
'text' => null,
'token' => null,
'ccme' => false,
);
}
public function getParamDescription() {
return array (
'target' => 'User to send email to',
'subject' => 'Subject header',
'text' => 'Mail body',
'token' => 'A token previously acquired via prop=info',
'ccme' => 'Send a copy of this mail to me',
);
}
public function getDescription() {
return array(
'Email a user.'
);
}
public function getPossibleErrors() {
return array_merge( parent::getPossibleErrors(), array(
array( 'usermaildisabled' ),
array( 'missingparam', 'target' ),
array( 'missingparam', 'text' ),
) );
}
public function getTokenSalt() {
return '';
}
protected function getExamples() {
return array (
'api.php?action=emailuser&target=WikiSysop&text=Content'
);
}
public function getVersion() {
return __CLASS__ . ': $Id: ApiEmailUser.php 62599 2010-02-16 21:59:16Z reedy $';
}
}
|
