Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F6105530
OATHAuthModuleRegistry.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
3 KB
Referenced Files
None
Subscribers
None
OATHAuthModuleRegistry.php
View Options
<?php
/**
* 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
*/
namespace
MediaWiki\Extension\OATHAuth
;
use
InvalidArgumentException
;
use
Wikimedia\ObjectFactory\ObjectFactory
;
use
Wikimedia\Rdbms\IConnectionProvider
;
class
OATHAuthModuleRegistry
{
/** @var array|null */
private
?
array
$moduleIds
=
null
;
public
function
__construct
(
private
readonly
IConnectionProvider
$dbProvider
,
private
readonly
ObjectFactory
$objectFactory
,
private
readonly
array
$modules
,
)
{
}
public
function
moduleExists
(
string
$moduleKey
):
bool
{
return
isset
(
$this
->
getModules
()[
$moduleKey
]
);
}
public
function
getModuleByKey
(
string
$key
):
IModule
{
if
(
!
isset
(
$this
->
getModules
()[
$key
]
)
)
{
throw
new
InvalidArgumentException
(
"No such two-factor module $key"
);
}
$data
=
$this
->
getModules
()[
$key
];
if
(
is_callable
(
$data
)
)
{
$module
=
$data
();
}
else
{
$module
=
$this
->
objectFactory
->
createObject
(
$data
,
[
'assertClass'
=>
IModule
::
class
]
);
}
return
$module
;
}
/**
* Get all modules registered on the wiki
*
* @return IModule[]
*/
public
function
getAllModules
():
array
{
$modules
=
[];
foreach
(
$this
->
getModules
()
as
$key
=>
$callback
)
{
$modules
[
$key
]
=
$this
->
getModuleByKey
(
$key
);
}
return
$modules
;
}
/**
* Returns the numerical ID for the module with the specified key.
*/
public
function
getModuleId
(
string
$key
):
int
{
$ids
=
$this
->
getModuleIds
();
if
(
isset
(
$ids
[
$key
]
)
)
{
return
$ids
[
$key
];
}
throw
new
InvalidArgumentException
(
"Module $key does not seem to exist"
);
}
public
function
getModuleIds
():
array
{
if
(
$this
->
moduleIds
===
null
)
{
$this
->
moduleIds
=
$this
->
getModuleIdsFromDatabase
(
false
);
}
$missing
=
array_diff
(
array_keys
(
$this
->
getModules
()
),
array_keys
(
$this
->
moduleIds
)
);
if
(
$missing
)
{
$insert
=
$this
->
dbProvider
->
getPrimaryDatabase
(
'virtual-oathauth'
)
->
newInsertQueryBuilder
()
->
insertInto
(
'oathauth_types'
)
->
caller
(
__METHOD__
);
foreach
(
$missing
as
$name
)
{
$insert
->
row
(
[
'oat_name'
=>
$name
]
);
}
$insert
->
execute
();
$this
->
moduleIds
=
$this
->
getModuleIdsFromDatabase
(
true
);
}
return
$this
->
moduleIds
;
}
private
function
getModuleIdsFromDatabase
(
bool
$fromPrimary
):
array
{
$ids
=
[];
if
(
$fromPrimary
)
{
$dbr
=
$this
->
dbProvider
->
getPrimaryDatabase
(
'virtual-oathauth'
);
}
else
{
$dbr
=
$this
->
dbProvider
->
getReplicaDatabase
(
'virtual-oathauth'
);
}
$rows
=
$dbr
->
newSelectQueryBuilder
()
->
select
(
[
'oat_id'
,
'oat_name'
]
)
->
from
(
'oathauth_types'
)
->
caller
(
__METHOD__
)
->
fetchResultSet
();
foreach
(
$rows
as
$row
)
{
$ids
[
$row
->
oat_name
]
=
(
int
)
$row
->
oat_id
;
}
return
$ids
;
}
private
function
getModules
():
array
{
return
$this
->
modules
;
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Oct 6 2026, 12:45 (6 w, 2 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
63/cd/f196c5c0c32ca3e3140103737c90
Default Alt Text
OATHAuthModuleRegistry.php (3 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment