Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
What's new
10
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Open sidebar
scripts
mediawiki-auth-mahara
Commits
32be5f77
Commit
32be5f77
authored
Sep 27, 2010
by
Brett Wilkins
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Adding maharaAuth file
parents
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
289 additions
and
0 deletions
+289
-0
MaharaAuth.php
MaharaAuth.php
+289
-0
No files found.
MaharaAuth.php
0 → 100644
View file @
32be5f77
<?php
/**
*/
# Copyright (C) 2004 Brion Vibber <brion@pobox.com>
# http://www.mediawiki.org/
#
# 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
/**
* Authentication plugin interface. Instantiate a subclass of AuthPlugin
* and set $wgAuth to it to authenticate against some external tool.
*
* The default behavior is not to do anything, and use the local user
* database for all authentication. A subclass can require that all
* accounts authenticate externally, or use it only as a fallback; also
* you can transparently create internal wiki accounts the first time
* someone logs in who can be authenticated externally.
*/
class
MaharaAuth
extends
AuthPlugin
{
/**
* Check whether there exists a user account with the given name.
* The name will be normalized to MediaWiki's requirements, so
* you might need to munge it (for instance, for lowercase initial
* letters).
*
* @param $username String: username.
* @return bool
*/
$dbname
;
$host
;
$dbname
;
$prefix
;
$dbuser
;
$dbpass
;
public
__construct
(
$dbname
,
$host
=
'localhost'
,
$prefix
=
''
,
$user
=
''
,
$password
=
''
)
{
$this
->
dbname
=
$dbname
;
$this
->
host
=
$host
;
$this
->
prefix
=
$prefix
;
$this
->
dbuser
=
$user
;
$this
->
dbpass
=
$password
;
}
public
function
userExists
(
$username
)
{
$db
=
new
Database
(
$this
->
dbhost
,
$this
->
dbuser
,
$this
->
dbpass
,
$this
->
dbname
);
$sql
=
"SELECT username* FROM "
.
$this
->
prefix
.
"usr where username = '"
.
$username
.
"';"
;
$res
=
$db
->
query
(
$sql
);
$val
=
$db
->
fetchRow
(
$res
);
$db
->
close
();
if
(
!
empty
(
$val
)
&&
$val
>
0
)
{
return
true
;
}
return
false
;
}
/**
* Check if a username+password pair is a valid login.
* The name will be normalized to MediaWiki's requirements, so
* you might need to munge it (for instance, for lowercase initial
* letters).
*
* @param $username String: username.
* @param $password String: user password.
* @return bool
*/
public
function
authenticate
(
$username
,
$password
)
{
# Override this!
return
false
;
}
/**
* Modify options in the login template.
*
* @param $template UserLoginTemplate object.
*/
public
function
modifyUITemplate
(
&
$template
)
{
# Override this!
$template
->
set
(
'usedomain'
,
false
);
}
/**
* Set the domain this plugin is supposed to use when authenticating.
*
* @param $domain String: authentication domain.
*/
public
function
setDomain
(
$domain
)
{
$this
->
domain
=
$domain
;
}
/**
* Check to see if the specific domain is a valid domain.
*
* @param $domain String: authentication domain.
* @return bool
*/
public
function
validDomain
(
$domain
)
{
# Override this!
return
true
;
}
/**
* When a user logs in, optionally fill in preferences and such.
* For instance, you might pull the email address or real name from the
* external user database.
*
* The User object is passed by reference so it can be modified; don't
* forget the & on your function declaration.
*
* @param User $user
*/
public
function
updateUser
(
&
$user
)
{
# Override this and do something
return
true
;
}
/**
* Return true if the wiki should create a new local account automatically
* when asked to login a user who doesn't exist locally but does in the
* external auth database.
*
* If you don't automatically create accounts, you must still create
* accounts in some way. It's not possible to authenticate without
* a local account.
*
* This is just a question, and shouldn't perform any actions.
*
* @return bool
*/
public
function
autoCreate
()
{
return
false
;
}
/**
* Can users change their passwords?
*
* @return bool
*/
public
function
allowPasswordChange
()
{
return
true
;
}
/**
* Set the given password in the authentication database.
* As a special case, the password may be set to null to request
* locking the password to an unusable value, with the expectation
* that it will be set later through a mail reset or other method.
*
* Return true if successful.
*
* @param $user User object.
* @param $password String: password.
* @return bool
*/
public
function
setPassword
(
$user
,
$password
)
{
return
true
;
}
/**
* Update user information in the external authentication database.
* Return true if successful.
*
* @param $user User object.
* @return bool
*/
public
function
updateExternalDB
(
$user
)
{
return
true
;
}
/**
* Check to see if external accounts can be created.
* Return true if external accounts can be created.
* @return bool
*/
public
function
canCreateAccounts
()
{
return
false
;
}
/**
* Add a user to the external authentication database.
* Return true if successful.
*
* @param User $user - only the name should be assumed valid at this point
* @param string $password
* @param string $email
* @param string $realname
* @return bool
*/
public
function
addUser
(
$user
,
$password
,
$email
=
''
,
$realname
=
''
)
{
return
true
;
}
/**
* Return true to prevent logins that don't authenticate here from being
* checked against the local database's password fields.
*
* This is just a question, and shouldn't perform any actions.
*
* @return bool
*/
public
function
strict
()
{
return
false
;
}
/**
* Check if a user should authenticate locally if the global authentication fails.
* If either this or strict() returns true, local authentication is not used.
*
* @param $username String: username.
* @return bool
*/
public
function
strictUserAuth
(
$username
)
{
return
false
;
}
/**
* When creating a user account, optionally fill in preferences and such.
* For instance, you might pull the email address or real name from the
* external user database.
*
* The User object is passed by reference so it can be modified; don't
* forget the & on your function declaration.
*
* @param $user User object.
* @param $autocreate bool True if user is being autocreated on login
*/
public
function
initUser
(
&
$user
,
$autocreate
=
false
)
{
# Override this to do something.
}
/**
* If you want to munge the case of an account name before the final
* check, now is your chance.
*/
public
function
getCanonicalName
(
$username
)
{
return
$username
;
}
/**
* Get an instance of a User object
*
* @param $user User
* @public
*/
public
function
getUserInstance
(
User
&
$user
)
{
return
new
AuthPluginUser
(
$user
);
}
}
class
AuthPluginUser
{
function
__construct
(
$user
)
{
# Override this!
}
public
function
getId
()
{
# Override this!
return
-
1
;
}
public
function
isLocked
()
{
# Override this!
return
false
;
}
public
function
isHidden
()
{
# Override this!
return
false
;
}
public
function
resetAuthToken
()
{
# Override this!
return
true
;
}
}
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment