443 lines
12 KiB
PHP
443 lines
12 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* @package Joomla.Platform
|
||
|
|
* @subpackage MediaWiki
|
||
|
|
*
|
||
|
|
* @copyright Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
|
||
|
|
* @license GNU General Public License version 2 or later; see LICENSE
|
||
|
|
*/
|
||
|
|
|
||
|
|
defined('JPATH_PLATFORM') or die;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* MediaWiki API Users class for the Joomla Platform.
|
||
|
|
*
|
||
|
|
* @package Joomla.Platform
|
||
|
|
* @subpackage MediaWiki
|
||
|
|
* @since 12.3
|
||
|
|
*/
|
||
|
|
class JMediawikiUsers extends JMediawikiObject
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* Method to login and get authentication tokens.
|
||
|
|
*
|
||
|
|
* @param string $lgname User Name.
|
||
|
|
* @param string $lgpassword Password.
|
||
|
|
* @param string $lgdomain Domain (optional).
|
||
|
|
*
|
||
|
|
* @return object
|
||
|
|
*
|
||
|
|
* @since 12.3
|
||
|
|
*/
|
||
|
|
public function login($lgname, $lgpassword, $lgdomain = null)
|
||
|
|
{
|
||
|
|
// Build the request path.
|
||
|
|
$path = '?action=login&lgname=' . $lgname . '&lgpassword=' . $lgpassword;
|
||
|
|
|
||
|
|
if (isset($lgdomain))
|
||
|
|
{
|
||
|
|
$path .= '&lgdomain=' . $lgdomain;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Send the request.
|
||
|
|
$response = $this->client->post($this->fetchUrl($path), null);
|
||
|
|
|
||
|
|
// Request path with login token.
|
||
|
|
$path = '?action=login&lgname=' . $lgname . '&lgpassword=' . $lgpassword . '&lgtoken=' . $this->validateResponse($response)->login['token'];
|
||
|
|
|
||
|
|
if (isset($lgdomain))
|
||
|
|
{
|
||
|
|
$path .= '&lgdomain=' . $lgdomain;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Set the session cookies returned.
|
||
|
|
$headers = (array) $this->options->get('headers');
|
||
|
|
$headers['Cookie'] = !empty($headers['Cookie']) ? empty($headers['Cookie']) : '';
|
||
|
|
$headers['Cookie'] = $headers['Cookie'] . $response->headers['Set-Cookie'];
|
||
|
|
$this->options->set('headers', $headers);
|
||
|
|
|
||
|
|
// Send the request again with the token.
|
||
|
|
$response = $this->client->post($this->fetchUrl($path), null);
|
||
|
|
$response_body = $this->validateResponse($response);
|
||
|
|
|
||
|
|
$headers = (array) $this->options->get('headers');
|
||
|
|
$cookie_prefix = $response_body->login['cookieprefix'];
|
||
|
|
$cookie = $cookie_prefix . 'UserID=' . $response_body->login['lguserid'] . '; ' . $cookie_prefix
|
||
|
|
. 'UserName=' . $response_body->login['lgusername'];
|
||
|
|
$headers['Cookie'] = $headers['Cookie'] . '; ' . $response->headers['Set-Cookie'] . '; ' . $cookie;
|
||
|
|
$this->options->set('headers', $headers);
|
||
|
|
|
||
|
|
return $this->validateResponse($response);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Method to logout and clear session data.
|
||
|
|
*
|
||
|
|
* @return object
|
||
|
|
*
|
||
|
|
* @since 12.3
|
||
|
|
*/
|
||
|
|
public function logout()
|
||
|
|
{
|
||
|
|
// Build the request path.
|
||
|
|
$path = '?action=login';
|
||
|
|
|
||
|
|
// @TODO clear internal data as well
|
||
|
|
|
||
|
|
// Send the request.
|
||
|
|
$response = $this->client->get($this->fetchUrl($path));
|
||
|
|
|
||
|
|
return $this->validateResponse($response);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Method to get user information.
|
||
|
|
*
|
||
|
|
* @param array $ususers A list of users to obtain the same information for.
|
||
|
|
* @param array $usprop What pieces of information to include.
|
||
|
|
*
|
||
|
|
* @return object
|
||
|
|
*
|
||
|
|
* @since 12.3
|
||
|
|
*/
|
||
|
|
public function getUserInfo(array $ususers, array $usprop = null)
|
||
|
|
{
|
||
|
|
// Build the request path.
|
||
|
|
$path = '?action=query&list=users';
|
||
|
|
|
||
|
|
// Append users to the request.
|
||
|
|
$path .= '&ususers=' . $this->buildParameter($ususers);
|
||
|
|
|
||
|
|
if (isset($usprop))
|
||
|
|
{
|
||
|
|
$path .= '&usprop' . $this->buildParameter($usprop);
|
||
|
|
}
|
||
|
|
|
||
|
|
// Send the request.
|
||
|
|
$response = $this->client->get($this->fetchUrl($path));
|
||
|
|
|
||
|
|
return $this->validateResponse($response);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Method to get current user information.
|
||
|
|
*
|
||
|
|
* @param array $uiprop What pieces of information to include.
|
||
|
|
*
|
||
|
|
* @return object
|
||
|
|
*
|
||
|
|
* @since 12.3
|
||
|
|
*/
|
||
|
|
public function getCurrentUserInfo(array $uiprop = null)
|
||
|
|
{
|
||
|
|
// Build the request path.
|
||
|
|
$path = '?action=query&meta=userinfo';
|
||
|
|
|
||
|
|
if (isset($uiprop))
|
||
|
|
{
|
||
|
|
$path .= '&uiprop' . $this->buildParameter($uiprop);
|
||
|
|
}
|
||
|
|
|
||
|
|
// Send the request.
|
||
|
|
$response = $this->client->get($this->fetchUrl($path));
|
||
|
|
|
||
|
|
return $this->validateResponse($response);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Method to get user contributions.
|
||
|
|
*
|
||
|
|
* @param string $ucuser The users to retrieve contributions for.
|
||
|
|
* @param string $ucuserprefix Retrieve contibutions for all users whose names begin with this value.
|
||
|
|
* @param integer $uclimit The users to retrieve contributions for.
|
||
|
|
* @param string $ucstart The start timestamp to return from.
|
||
|
|
* @param string $ucend The end timestamp to return to.
|
||
|
|
* @param boolean $uccontinue When more results are available, use this to continue.
|
||
|
|
* @param string $ucdir In which direction to enumerate.
|
||
|
|
* @param array $ucnamespace Only list contributions in these namespaces.
|
||
|
|
* @param array $ucprop Include additional pieces of information.
|
||
|
|
* @param array $ucshow Show only items that meet this criteria.
|
||
|
|
* @param string $uctag Only list revisions tagged with this tag.
|
||
|
|
* @param string $uctoponly Only list changes which are the latest revision
|
||
|
|
*
|
||
|
|
* @return object
|
||
|
|
*
|
||
|
|
* @since 12.3
|
||
|
|
*/
|
||
|
|
public function getUserContribs($ucuser = null, $ucuserprefix = null, $uclimit = null, $ucstart = null, $ucend = null, $uccontinue = null,
|
||
|
|
$ucdir = null, array $ucnamespace = null, array $ucprop = null, array $ucshow = null, $uctag = null, $uctoponly = null)
|
||
|
|
{
|
||
|
|
// Build the request path.
|
||
|
|
$path = '?action=query&list=usercontribs';
|
||
|
|
|
||
|
|
if (isset($ucuser))
|
||
|
|
{
|
||
|
|
$path .= '&ucuser=' . $ucuser;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (isset($ucuserprefix))
|
||
|
|
{
|
||
|
|
$path .= '&ucuserprefix=' . $ucuserprefix;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (isset($uclimit))
|
||
|
|
{
|
||
|
|
$path .= '&uclimit=' . $uclimit;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (isset($ucstart))
|
||
|
|
{
|
||
|
|
$path .= '&ucstart=' . $ucstart;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (isset($ucend))
|
||
|
|
{
|
||
|
|
$path .= '&ucend=' . $ucend;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($uccontinue)
|
||
|
|
{
|
||
|
|
$path .= '&uccontinue=';
|
||
|
|
}
|
||
|
|
|
||
|
|
if (isset($ucdir))
|
||
|
|
{
|
||
|
|
$path .= '&ucdir=' . $ucdir;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (isset($ucnamespace))
|
||
|
|
{
|
||
|
|
$path .= '&ucnamespace=' . $this->buildParameter($ucnamespace);
|
||
|
|
}
|
||
|
|
|
||
|
|
if (isset($ucprop))
|
||
|
|
{
|
||
|
|
$path .= '&ucprop=' . $this->buildParameter($ucprop);
|
||
|
|
}
|
||
|
|
|
||
|
|
if (isset($ucshow))
|
||
|
|
{
|
||
|
|
$path .= '&ucshow=' . $this->buildParameter($ucshow);
|
||
|
|
}
|
||
|
|
|
||
|
|
if (isset($uctag))
|
||
|
|
{
|
||
|
|
$path .= '&uctag=' . $uctag;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (isset($uctoponly))
|
||
|
|
{
|
||
|
|
$path .= '&uctoponly=' . $uctoponly;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Send the request.
|
||
|
|
$response = $this->client->get($this->fetchUrl($path));
|
||
|
|
|
||
|
|
return $this->validateResponse($response);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Method to block a user.
|
||
|
|
*
|
||
|
|
* @param string $user Username, IP address or IP range you want to block.
|
||
|
|
* @param string $expiry Relative expiry time, Default: never.
|
||
|
|
* @param string $reason Reason for block (optional).
|
||
|
|
* @param boolean $anononly Block anonymous users only.
|
||
|
|
* @param boolean $nocreate Prevent account creation.
|
||
|
|
* @param boolean $autoblock Automatically block the last used IP address, and any subsequent IP addresses they try to login from.
|
||
|
|
* @param boolean $noemail Prevent user from sending e-mail through the wiki.
|
||
|
|
* @param boolean $hidename Hide the username from the block log.
|
||
|
|
* @param boolean $allowusertalk Allow the user to edit their own talk page.
|
||
|
|
* @param boolean $reblock If the user is already blocked, overwrite the existing block.
|
||
|
|
* @param boolean $watchuser Watch the user/IP's user and talk pages.
|
||
|
|
*
|
||
|
|
* @return object
|
||
|
|
*
|
||
|
|
* @since 12.3
|
||
|
|
*/
|
||
|
|
public function blockUser($user, $expiry = null, $reason = null, $anononly = null, $nocreate = null, $autoblock = null, $noemail = null,
|
||
|
|
$hidename = null, $allowusertalk = null, $reblock = null, $watchuser = null)
|
||
|
|
{
|
||
|
|
// Get the token.
|
||
|
|
$token = $this->getToken($user, 'block');
|
||
|
|
|
||
|
|
// Build the request path.
|
||
|
|
$path = '?action=unblock';
|
||
|
|
|
||
|
|
// Build the request data.
|
||
|
|
$data = array(
|
||
|
|
'user' => $user,
|
||
|
|
'token' => $token,
|
||
|
|
'expiry' => $expiry,
|
||
|
|
'reason' => $reason,
|
||
|
|
'anononly' => $anononly,
|
||
|
|
'nocreate' => $nocreate,
|
||
|
|
'autoblock' => $autoblock,
|
||
|
|
'noemail' => $noemail,
|
||
|
|
'hidename' => $hidename,
|
||
|
|
'allowusetalk' => $allowusertalk,
|
||
|
|
'reblock' => $reblock,
|
||
|
|
'watchuser' => $watchuser
|
||
|
|
);
|
||
|
|
|
||
|
|
// Send the request.
|
||
|
|
$response = $this->client->post($this->fetchUrl($path), $data);
|
||
|
|
|
||
|
|
return $this->validateResponse($response);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Method to unblock a user.
|
||
|
|
*
|
||
|
|
* @param string $user Username, IP address or IP range you want to unblock.
|
||
|
|
* @param string $reason Reason for unblock (optional).
|
||
|
|
*
|
||
|
|
* @return object
|
||
|
|
*
|
||
|
|
* @since 12.3
|
||
|
|
*/
|
||
|
|
public function unBlockUserByName($user, $reason = null)
|
||
|
|
{
|
||
|
|
// Get the token.
|
||
|
|
$token = $this->getToken($user, 'unblock');
|
||
|
|
|
||
|
|
// Build the request path.
|
||
|
|
$path = '?action=unblock';
|
||
|
|
|
||
|
|
// Build the request data.
|
||
|
|
$data = array(
|
||
|
|
'user' => $user,
|
||
|
|
'token' => $token,
|
||
|
|
'reason' => $reason,
|
||
|
|
);
|
||
|
|
|
||
|
|
// Send the request.
|
||
|
|
$response = $this->client->post($this->fetchUrl($path), $data);
|
||
|
|
|
||
|
|
return $this->validateResponse($response);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Method to unblock a user.
|
||
|
|
*
|
||
|
|
* @param int $id Username, IP address or IP range you want to unblock.
|
||
|
|
* @param string $reason Reason for unblock (optional).
|
||
|
|
*
|
||
|
|
* @return object
|
||
|
|
*
|
||
|
|
* @since 12.3
|
||
|
|
*/
|
||
|
|
public function unBlockUserByID($id, $reason = null)
|
||
|
|
{
|
||
|
|
// Get the token.
|
||
|
|
$token = $this->getToken($id, 'unblock');
|
||
|
|
|
||
|
|
// Build the request path.
|
||
|
|
$path = '?action=unblock';
|
||
|
|
|
||
|
|
// Build the request data.
|
||
|
|
// TODO: $data doesn't seem to be used!
|
||
|
|
$data = array(
|
||
|
|
'id' => $id,
|
||
|
|
'token' => $token,
|
||
|
|
'reason' => $reason,
|
||
|
|
);
|
||
|
|
|
||
|
|
// Send the request.
|
||
|
|
$response = $this->client->get($this->fetchUrl($path));
|
||
|
|
|
||
|
|
return $this->validateResponse($response);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Method to assign a user to a group.
|
||
|
|
*
|
||
|
|
* @param string $username User name.
|
||
|
|
* @param array $add Add the user to these groups.
|
||
|
|
* @param array $remove Remove the user from these groups.
|
||
|
|
* @param string $reason Reason for the change.
|
||
|
|
*
|
||
|
|
* @return object
|
||
|
|
*
|
||
|
|
* @since 12.3
|
||
|
|
*/
|
||
|
|
public function assignGroup($username, $add = null, $remove = null, $reason = null)
|
||
|
|
{
|
||
|
|
// Get the token.
|
||
|
|
$token = $this->getToken($username, 'unblock');
|
||
|
|
|
||
|
|
// Build the request path.
|
||
|
|
$path = '?action=userrights';
|
||
|
|
|
||
|
|
// Build the request data.
|
||
|
|
$data = array(
|
||
|
|
'username' => $username,
|
||
|
|
'token' => $token,
|
||
|
|
'add' => $add,
|
||
|
|
'remove' => $remove,
|
||
|
|
'reason' => $reason
|
||
|
|
);
|
||
|
|
|
||
|
|
// Send the request.
|
||
|
|
$response = $this->client->post($this->fetchUrl($path), $data);
|
||
|
|
|
||
|
|
return $this->validateResponse($response);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Method to email a user.
|
||
|
|
*
|
||
|
|
* @param string $target User to send email to.
|
||
|
|
* @param string $subject Subject header.
|
||
|
|
* @param string $text Mail body.
|
||
|
|
* @param boolean $ccme Send a copy of this mail to me.
|
||
|
|
*
|
||
|
|
* @return object
|
||
|
|
*
|
||
|
|
* @since 12.3
|
||
|
|
*/
|
||
|
|
public function emailUser($target, $subject = null, $text = null, $ccme = null)
|
||
|
|
{
|
||
|
|
// Get the token.
|
||
|
|
$token = $this->getToken($target, 'emailuser');
|
||
|
|
|
||
|
|
// Build the request path.
|
||
|
|
$path = '?action=emailuser';
|
||
|
|
|
||
|
|
// Build the request data.
|
||
|
|
$data = array(
|
||
|
|
'target' => $target,
|
||
|
|
'token' => $token,
|
||
|
|
'subject' => $subject,
|
||
|
|
'text' => $text,
|
||
|
|
'ccme' => $ccme
|
||
|
|
);
|
||
|
|
|
||
|
|
// Send the request.
|
||
|
|
$response = $this->client->post($this->fetchUrl($path), $data);
|
||
|
|
|
||
|
|
return $this->validateResponse($response);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Method to get access token.
|
||
|
|
*
|
||
|
|
* @param string $user The User to get token.
|
||
|
|
* @param string $intoken The type of token.
|
||
|
|
*
|
||
|
|
* @return object
|
||
|
|
*
|
||
|
|
* @since 12.3
|
||
|
|
*/
|
||
|
|
public function getToken($user, $intoken)
|
||
|
|
{
|
||
|
|
// Build the request path.
|
||
|
|
$path = '?action=query&prop=info&intoken=' . $intoken . '&titles=User:' . $user;
|
||
|
|
|
||
|
|
// Send the request.
|
||
|
|
$response = $this->client->post($this->fetchUrl($path), null);
|
||
|
|
|
||
|
|
return (string) $this->validateResponse($response)->query->pages->page[$intoken . 'token'];
|
||
|
|
}
|
||
|
|
}
|