Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F6082599
sendConfirmAndMigrateEmail.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
5 KB
Referenced Files
None
Subscribers
None
sendConfirmAndMigrateEmail.php
View Options
<?php
namespace
MediaWiki\Extension\CentralAuth\Maintenance
;
$IP
=
getenv
(
'MW_INSTALL_PATH'
);
if
(
$IP
===
false
)
{
$IP
=
__DIR__
.
'/../../..'
;
}
require_once
"$IP/maintenance/Maintenance.php"
;
use
MediaWiki\Extension\CentralAuth\User\CentralAuthUser
;
use
MediaWiki\Extension\CentralAuth\User\EmailableUser
;
use
MediaWiki\Maintenance\Maintenance
;
use
MediaWiki\WikiMap\WikiMap
;
/**
* This maintenance script is used to resend confirmation emails to users with
* unattached accounts in the hopes that we will then be able to automatically
* attach some unattached accounts. In addition, by using an EmailableUser object
* we are able to override the contents of the email and send them to Special:MergeAccount
* instead of Special:ConfirmEmail and thus put them right into the workflow to attach
* accounts by password.
*
* THIS MUST BE RUN ON THE LOCAL WIKI SO THAT THE EMAIL IS SENT IN THE CORRECT LANGUAGE
*/
class
SendConfirmAndMigrateEmail
extends
Maintenance
{
/**
* Whether to send to accounts with confirmed emails
* @var bool
*/
private
$sendToConfirmed
;
/**
* How long to wait in between emails
*
* @var int
*/
private
$sleep
;
/**
* @var bool
*/
private
$dryrun
;
/**
* @var string|bool
*/
private
$resume
;
/** @var float */
protected
$start
;
/** @var int */
protected
$sent
;
/** @var int */
protected
$total
;
public
function
__construct
()
{
parent
::
__construct
();
$this
->
requireExtension
(
'CentralAuth'
);
$this
->
addDescription
(
"Resends the 'confirm your email address email' with a link to "
.
"Special:MergeAccount"
);
$this
->
start
=
microtime
(
true
);
$this
->
sent
=
0
;
$this
->
total
=
0
;
$this
->
addOption
(
'userlist'
,
'List of usernames'
,
false
,
true
);
$this
->
addOption
(
'username'
,
'The user name to migrate'
,
false
,
true
,
'u'
);
$this
->
addOption
(
'confirmed'
,
'Send email to confirmed accounts'
,
false
,
false
);
$this
->
addOption
(
'sleep'
,
'How long to wait in between emails (default 1 second)'
,
false
,
true
);
$this
->
addOption
(
'dryrun'
,
'Don
\'
t actually send any emails'
,
false
,
false
);
$this
->
addOption
(
'resume'
,
'Which username to resume after'
,
false
,
true
);
$this
->
setBatchSize
(
1000
);
}
public
function
execute
()
{
$this
->
sendToConfirmed
=
$this
->
getOption
(
'confirmed'
,
false
);
$this
->
sleep
=
(
int
)
$this
->
getOption
(
'sleep'
,
1
);
$this
->
dryrun
=
$this
->
hasOption
(
'dryrun'
);
$this
->
resume
=
$this
->
getOption
(
'resume'
,
true
);
// check to see if we are processing a single username
if
(
$this
->
getOption
(
'username'
,
false
)
!==
false
)
{
$username
=
$this
->
getOption
(
'username'
);
$this
->
resendConfirmationEmail
(
$username
);
}
elseif
(
$this
->
getOption
(
'userlist'
,
false
)
!==
false
)
{
$list
=
$this
->
getOption
(
'userlist'
);
if
(
!
is_file
(
$list
)
)
{
$this
->
output
(
"ERROR - File not found: $list
\n
"
);
exit
(
1
);
}
$file
=
fopen
(
$list
,
'r'
);
if
(
$file
===
false
)
{
$this
->
output
(
"ERROR - Could not open file: $list
\n
"
);
exit
(
1
);
}
// phpcs:ignore Generic.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition
while
(
$username
=
fgets
(
$file
)
)
{
// trim the \n
$username
=
trim
(
$username
);
if
(
$this
->
resume
!==
true
)
{
if
(
$username
===
$this
->
resume
)
{
$this
->
resume
=
true
;
}
continue
;
}
$this
->
resendConfirmationEmail
(
$username
);
if
(
$this
->
total
%
$this
->
mBatchSize
==
0
)
{
$this
->
output
(
"Waiting for replicas to catch up ... "
);
if
(
!
$this
->
dryrun
)
{
$this
->
waitForReplication
();
}
$this
->
output
(
"done
\n
"
);
}
}
fclose
(
$file
);
}
else
{
$this
->
output
(
"ERROR - No username or list of usernames given
\n
"
);
exit
(
1
);
}
$this
->
report
();
$this
->
output
(
"done.
\n
"
);
}
/**
* @param string $username
*/
private
function
resendConfirmationEmail
(
$username
)
{
$wikiID
=
WikiMap
::
getCurrentWikiId
();
$this
->
total
++;
$this
->
output
(
"Sending confirmation email for: '$username@$wikiID'
\n
"
);
// we want to start with the local user
$user
=
EmailableUser
::
newFromName
(
$username
);
if
(
$user
===
false
)
{
$this
->
output
(
"ERROR: $username is an invalid username
\n
"
);
return
;
}
$user
->
load
();
if
(
!
$this
->
sendToConfirmed
&&
$user
->
isEmailConfirmed
()
)
{
$this
->
output
(
"ERROR: The user '$username@$wikiID' already has a confirmed email address
\n
"
);
return
;
}
$central
=
CentralAuthUser
::
getInstance
(
$user
);
if
(
!
$central
->
exists
()
)
{
$this
->
output
(
"ERROR: No global account for '$username'
\n
"
);
return
;
}
if
(
!
$central
->
isAttached
()
)
{
$this
->
output
(
"ERROR: '$username@$wikiID' is not attached to the global user
\n
"
);
return
;
}
$unattached
=
$central
->
queryUnattached
();
if
(
count
(
$unattached
)
==
0
)
{
$this
->
output
(
"ERROR: No unattached accounts for '$username'
\n
"
);
return
;
}
if
(
$this
->
dryrun
)
{
$this
->
output
(
"Would have sent email
\n
"
);
return
;
}
if
(
$user
->
sendConfirmAndMigrateMail
()
)
{
$this
->
output
(
"Sent email to $username
\n
"
);
$this
->
sent
++;
sleep
(
$this
->
sleep
);
}
else
{
$this
->
output
(
"ERROR: Sending confirm and migrate email failed for '$username@$wikiID'
\n
"
);
}
}
private
function
report
()
{
$delta
=
microtime
(
true
)
-
$this
->
start
;
$this
->
output
(
sprintf
(
"%s: %s processed %d usernames (%.1f/sec), %d (%.1f%%) emails sent
\n
"
,
WikiMap
::
getCurrentWikiId
(),
wfTimestamp
(
TS_DB
),
$this
->
total
,
$this
->
total
/
$delta
,
$this
->
sent
,
$this
->
total
>
0
?
(
$this
->
sent
/
$this
->
total
*
100.0
)
:
0
)
);
}
}
$maintClass
=
SendConfirmAndMigrateEmail
::
class
;
require_once
RUN_MAINTENANCE_IF_MAIN
;
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Oct 5 2026, 12:10 (6 w, 1 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
df/c1/5e0dce66012e60b66d039e85756e
Default Alt Text
sendConfirmAndMigrateEmail.php (5 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment