12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345 |
- <?php
- /**
- * Implements the User class for the %MediaWiki software.
- *
- * 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
- */
- use MediaWiki\Block\AbstractBlock;
- use MediaWiki\Block\DatabaseBlock;
- use MediaWiki\Block\SystemBlock;
- use MediaWiki\MediaWikiServices;
- use MediaWiki\Session\SessionManager;
- use MediaWiki\Session\Token;
- use MediaWiki\Auth\AuthManager;
- use MediaWiki\Auth\AuthenticationResponse;
- use MediaWiki\Auth\AuthenticationRequest;
- use MediaWiki\User\UserIdentity;
- use MediaWiki\Logger\LoggerFactory;
- use Wikimedia\Assert\Assert;
- use Wikimedia\IPSet;
- use Wikimedia\ScopedCallback;
- use Wikimedia\Rdbms\Database;
- use Wikimedia\Rdbms\DBExpectedError;
- use Wikimedia\Rdbms\IDatabase;
- /**
- * The User object encapsulates all of the user-specific settings (user_id,
- * name, rights, email address, options, last login time). Client
- * classes use the getXXX() functions to access these fields. These functions
- * do all the work of determining whether the user is logged in,
- * whether the requested option can be satisfied from cookies or
- * whether a database query is needed. Most of the settings needed
- * for rendering normal pages are set in the cookie to minimize use
- * of the database.
- */
- class User implements IDBAccessObject, UserIdentity {
- /**
- * Number of characters required for the user_token field.
- */
- const TOKEN_LENGTH = 32;
- /**
- * An invalid string value for the user_token field.
- */
- const INVALID_TOKEN = '*** INVALID ***';
- /**
- * Version number to tag cached versions of serialized User objects. Should be increased when
- * {@link $mCacheVars} or one of it's members changes.
- */
- const VERSION = 14;
- /**
- * Exclude user options that are set to their default value.
- * @since 1.25
- */
- const GETOPTIONS_EXCLUDE_DEFAULTS = 1;
- /**
- * @since 1.27
- */
- const CHECK_USER_RIGHTS = true;
- /**
- * @since 1.27
- */
- const IGNORE_USER_RIGHTS = false;
- /**
- * Array of Strings List of member variables which are saved to the
- * shared cache (memcached). Any operation which changes the
- * corresponding database fields must call a cache-clearing function.
- * @showinitializer
- * @var string[]
- */
- protected static $mCacheVars = [
- // user table
- 'mId',
- 'mName',
- 'mRealName',
- 'mEmail',
- 'mTouched',
- 'mToken',
- 'mEmailAuthenticated',
- 'mEmailToken',
- 'mEmailTokenExpires',
- 'mRegistration',
- 'mEditCount',
- // user_groups table
- 'mGroupMemberships',
- // user_properties table
- 'mOptionOverrides',
- // actor table
- 'mActorId',
- ];
- /** Cache variables */
- // @{
- /** @var int */
- public $mId;
- /** @var string */
- public $mName;
- /** @var int|null */
- protected $mActorId;
- /** @var string */
- public $mRealName;
- /** @var string */
- public $mEmail;
- /** @var string TS_MW timestamp from the DB */
- public $mTouched;
- /** @var string TS_MW timestamp from cache */
- protected $mQuickTouched;
- /** @var string */
- protected $mToken;
- /** @var string */
- public $mEmailAuthenticated;
- /** @var string */
- protected $mEmailToken;
- /** @var string */
- protected $mEmailTokenExpires;
- /** @var string */
- protected $mRegistration;
- /** @var int */
- protected $mEditCount;
- /** @var UserGroupMembership[] Associative array of (group name => UserGroupMembership object) */
- protected $mGroupMemberships;
- /** @var array */
- protected $mOptionOverrides;
- // @}
- // @{
- /**
- * @var bool Whether the cache variables have been loaded.
- */
- public $mOptionsLoaded;
- /**
- * @var array|bool Array with already loaded items or true if all items have been loaded.
- */
- protected $mLoadedItems = [];
- // @}
- /**
- * @var string Initialization data source if mLoadedItems!==true. May be one of:
- * - 'defaults' anonymous user initialised from class defaults
- * - 'name' initialise from mName
- * - 'id' initialise from mId
- * - 'actor' initialise from mActorId
- * - 'session' log in from session if possible
- *
- * Use the User::newFrom*() family of functions to set this.
- */
- public $mFrom;
- /**
- * Lazy-initialized variables, invalidated with clearInstanceCache
- */
- /** @var int|bool */
- protected $mNewtalk;
- /** @var string */
- protected $mDatePreference;
- /** @var string */
- public $mBlockedby;
- /** @var string */
- protected $mHash;
- /** @var string */
- protected $mBlockreason;
- /** @var array */
- protected $mEffectiveGroups;
- /** @var array */
- protected $mImplicitGroups;
- /** @var array */
- protected $mFormerGroups;
- /** @var AbstractBlock */
- protected $mGlobalBlock;
- /** @var bool */
- protected $mLocked;
- /** @var bool */
- public $mHideName;
- /** @var array */
- public $mOptions;
- /** @var WebRequest */
- private $mRequest;
- /** @var AbstractBlock */
- public $mBlock;
- /** @var bool */
- protected $mAllowUsertalk;
- /** @var AbstractBlock|bool */
- private $mBlockedFromCreateAccount = false;
- /** @var int User::READ_* constant bitfield used to load data */
- protected $queryFlagsUsed = self::READ_NORMAL;
- /** @var int[] */
- public static $idCacheByName = [];
- /**
- * Lightweight constructor for an anonymous user.
- * Use the User::newFrom* factory functions for other kinds of users.
- *
- * @see newFromName()
- * @see newFromId()
- * @see newFromActorId()
- * @see newFromConfirmationCode()
- * @see newFromSession()
- * @see newFromRow()
- */
- public function __construct() {
- $this->clearInstanceCache( 'defaults' );
- }
- /**
- * @return string
- */
- public function __toString() {
- return (string)$this->getName();
- }
- public function &__get( $name ) {
- // A shortcut for $mRights deprecation phase
- if ( $name === 'mRights' ) {
- $copy = $this->getRights();
- return $copy;
- } elseif ( !property_exists( $this, $name ) ) {
- // T227688 - do not break $u->foo['bar'] = 1
- wfLogWarning( 'tried to get non-existent property' );
- $this->$name = null;
- return $this->$name;
- } else {
- wfLogWarning( 'tried to get non-visible property' );
- $null = null;
- return $null;
- }
- }
- public function __set( $name, $value ) {
- // A shortcut for $mRights deprecation phase, only known legitimate use was for
- // testing purposes, other uses seem bad in principle
- if ( $name === 'mRights' ) {
- MediaWikiServices::getInstance()->getPermissionManager()->overrideUserRightsForTesting(
- $this,
- is_null( $value ) ? [] : $value
- );
- } elseif ( !property_exists( $this, $name ) ) {
- $this->$name = $value;
- } else {
- wfLogWarning( 'tried to set non-visible property' );
- }
- }
- /**
- * Test if it's safe to load this User object.
- *
- * You should typically check this before using $wgUser or
- * RequestContext::getUser in a method that might be called before the
- * system has been fully initialized. If the object is unsafe, you should
- * use an anonymous user:
- * \code
- * $user = $wgUser->isSafeToLoad() ? $wgUser : new User;
- * \endcode
- *
- * @since 1.27
- * @return bool
- */
- public function isSafeToLoad() {
- global $wgFullyInitialised;
- // The user is safe to load if:
- // * MW_NO_SESSION is undefined AND $wgFullyInitialised is true (safe to use session data)
- // * mLoadedItems === true (already loaded)
- // * mFrom !== 'session' (sessions not involved at all)
- return ( !defined( 'MW_NO_SESSION' ) && $wgFullyInitialised ) ||
- $this->mLoadedItems === true || $this->mFrom !== 'session';
- }
- /**
- * Load the user table data for this object from the source given by mFrom.
- *
- * @param int $flags User::READ_* constant bitfield
- */
- public function load( $flags = self::READ_NORMAL ) {
- global $wgFullyInitialised;
- if ( $this->mLoadedItems === true ) {
- return;
- }
- // Set it now to avoid infinite recursion in accessors
- $oldLoadedItems = $this->mLoadedItems;
- $this->mLoadedItems = true;
- $this->queryFlagsUsed = $flags;
- // If this is called too early, things are likely to break.
- if ( !$wgFullyInitialised && $this->mFrom === 'session' ) {
- \MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
- ->warning( 'User::loadFromSession called before the end of Setup.php', [
- 'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
- ] );
- $this->loadDefaults();
- $this->mLoadedItems = $oldLoadedItems;
- return;
- }
- switch ( $this->mFrom ) {
- case 'defaults':
- $this->loadDefaults();
- break;
- case 'id':
- // Make sure this thread sees its own changes, if the ID isn't 0
- if ( $this->mId != 0 ) {
- $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
- if ( $lb->hasOrMadeRecentMasterChanges() ) {
- $flags |= self::READ_LATEST;
- $this->queryFlagsUsed = $flags;
- }
- }
- $this->loadFromId( $flags );
- break;
- case 'actor':
- case 'name':
- // Make sure this thread sees its own changes
- $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
- if ( $lb->hasOrMadeRecentMasterChanges() ) {
- $flags |= self::READ_LATEST;
- $this->queryFlagsUsed = $flags;
- }
- list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $flags );
- $row = wfGetDB( $index )->selectRow(
- 'actor',
- [ 'actor_id', 'actor_user', 'actor_name' ],
- $this->mFrom === 'name' ? [ 'actor_name' => $this->mName ] : [ 'actor_id' => $this->mActorId ],
- __METHOD__,
- $options
- );
- if ( !$row ) {
- // Ugh.
- $this->loadDefaults( $this->mFrom === 'name' ? $this->mName : false );
- } elseif ( $row->actor_user ) {
- $this->mId = $row->actor_user;
- $this->loadFromId( $flags );
- } else {
- $this->loadDefaults( $row->actor_name, $row->actor_id );
- }
- break;
- case 'session':
- if ( !$this->loadFromSession() ) {
- // Loading from session failed. Load defaults.
- $this->loadDefaults();
- }
- Hooks::run( 'UserLoadAfterLoadFromSession', [ $this ] );
- break;
- default:
- throw new UnexpectedValueException(
- "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
- }
- }
- /**
- * Load user table data, given mId has already been set.
- * @param int $flags User::READ_* constant bitfield
- * @return bool False if the ID does not exist, true otherwise
- */
- public function loadFromId( $flags = self::READ_NORMAL ) {
- if ( $this->mId == 0 ) {
- // Anonymous users are not in the database (don't need cache)
- $this->loadDefaults();
- return false;
- }
- // Try cache (unless this needs data from the master DB).
- // NOTE: if this thread called saveSettings(), the cache was cleared.
- $latest = DBAccessObjectUtils::hasFlags( $flags, self::READ_LATEST );
- if ( $latest ) {
- if ( !$this->loadFromDatabase( $flags ) ) {
- // Can't load from ID
- return false;
- }
- } else {
- $this->loadFromCache();
- }
- $this->mLoadedItems = true;
- $this->queryFlagsUsed = $flags;
- return true;
- }
- /**
- * @since 1.27
- * @param string $dbDomain
- * @param int $userId
- */
- public static function purge( $dbDomain, $userId ) {
- $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
- $key = $cache->makeGlobalKey( 'user', 'id', $dbDomain, $userId );
- $cache->delete( $key );
- }
- /**
- * @since 1.27
- * @param WANObjectCache $cache
- * @return string
- */
- protected function getCacheKey( WANObjectCache $cache ) {
- $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
- return $cache->makeGlobalKey( 'user', 'id', $lbFactory->getLocalDomainID(), $this->mId );
- }
- /**
- * @param WANObjectCache $cache
- * @return string[]
- * @since 1.28
- */
- public function getMutableCacheKeys( WANObjectCache $cache ) {
- $id = $this->getId();
- return $id ? [ $this->getCacheKey( $cache ) ] : [];
- }
- /**
- * Load user data from shared cache, given mId has already been set.
- *
- * @return bool True
- * @since 1.25
- */
- protected function loadFromCache() {
- $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
- $data = $cache->getWithSetCallback(
- $this->getCacheKey( $cache ),
- $cache::TTL_HOUR,
- function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
- $setOpts += Database::getCacheSetOptions( wfGetDB( DB_REPLICA ) );
- wfDebug( "User: cache miss for user {$this->mId}\n" );
- $this->loadFromDatabase( self::READ_NORMAL );
- $this->loadGroups();
- $this->loadOptions();
- $data = [];
- foreach ( self::$mCacheVars as $name ) {
- $data[$name] = $this->$name;
- }
- $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX, $this->mTouched ), $ttl );
- // if a user group membership is about to expire, the cache needs to
- // expire at that time (T163691)
- foreach ( $this->mGroupMemberships as $ugm ) {
- if ( $ugm->getExpiry() ) {
- $secondsUntilExpiry = wfTimestamp( TS_UNIX, $ugm->getExpiry() ) - time();
- if ( $secondsUntilExpiry > 0 && $secondsUntilExpiry < $ttl ) {
- $ttl = $secondsUntilExpiry;
- }
- }
- }
- return $data;
- },
- [ 'pcTTL' => $cache::TTL_PROC_LONG, 'version' => self::VERSION ]
- );
- // Restore from cache
- foreach ( self::$mCacheVars as $name ) {
- $this->$name = $data[$name];
- }
- return true;
- }
- /** @name newFrom*() static factory methods */
- // @{
- /**
- * Static factory method for creation from username.
- *
- * This is slightly less efficient than newFromId(), so use newFromId() if
- * you have both an ID and a name handy.
- *
- * @param string $name Username, validated by Title::newFromText()
- * @param string|bool $validate Validate username. Takes the same parameters as
- * User::getCanonicalName(), except that true is accepted as an alias
- * for 'valid', for BC.
- *
- * @return User|bool User object, or false if the username is invalid
- * (e.g. if it contains illegal characters or is an IP address). If the
- * username is not present in the database, the result will be a user object
- * with a name, zero user ID and default settings.
- */
- public static function newFromName( $name, $validate = 'valid' ) {
- if ( $validate === true ) {
- $validate = 'valid';
- }
- $name = self::getCanonicalName( $name, $validate );
- if ( $name === false ) {
- return false;
- }
- // Create unloaded user object
- $u = new User;
- $u->mName = $name;
- $u->mFrom = 'name';
- $u->setItemLoaded( 'name' );
- return $u;
- }
- /**
- * Static factory method for creation from a given user ID.
- *
- * @param int $id Valid user ID
- * @return User The corresponding User object
- */
- public static function newFromId( $id ) {
- $u = new User;
- $u->mId = $id;
- $u->mFrom = 'id';
- $u->setItemLoaded( 'id' );
- return $u;
- }
- /**
- * Static factory method for creation from a given actor ID.
- *
- * @since 1.31
- * @param int $id Valid actor ID
- * @return User The corresponding User object
- */
- public static function newFromActorId( $id ) {
- $u = new User;
- $u->mActorId = $id;
- $u->mFrom = 'actor';
- $u->setItemLoaded( 'actor' );
- return $u;
- }
- /**
- * Returns a User object corresponding to the given UserIdentity.
- *
- * @since 1.32
- *
- * @param UserIdentity $identity
- *
- * @return User
- */
- public static function newFromIdentity( UserIdentity $identity ) {
- if ( $identity instanceof User ) {
- return $identity;
- }
- return self::newFromAnyId(
- $identity->getId() === 0 ? null : $identity->getId(),
- $identity->getName() === '' ? null : $identity->getName(),
- $identity->getActorId() === 0 ? null : $identity->getActorId()
- );
- }
- /**
- * Static factory method for creation from an ID, name, and/or actor ID
- *
- * This does not check that the ID, name, and actor ID all correspond to
- * the same user.
- *
- * @since 1.31
- * @param int|null $userId User ID, if known
- * @param string|null $userName User name, if known
- * @param int|null $actorId Actor ID, if known
- * @param bool|string $dbDomain remote wiki to which the User/Actor ID applies, or false if none
- * @return User
- */
- public static function newFromAnyId( $userId, $userName, $actorId, $dbDomain = false ) {
- // Stop-gap solution for the problem described in T222212.
- // Force the User ID and Actor ID to zero for users loaded from the database
- // of another wiki, to prevent subtle data corruption and confusing failure modes.
- if ( $dbDomain !== false ) {
- $userId = 0;
- $actorId = 0;
- }
- $user = new User;
- $user->mFrom = 'defaults';
- if ( $actorId !== null ) {
- $user->mActorId = (int)$actorId;
- if ( $user->mActorId !== 0 ) {
- $user->mFrom = 'actor';
- }
- $user->setItemLoaded( 'actor' );
- }
- if ( $userName !== null && $userName !== '' ) {
- $user->mName = $userName;
- $user->mFrom = 'name';
- $user->setItemLoaded( 'name' );
- }
- if ( $userId !== null ) {
- $user->mId = (int)$userId;
- if ( $user->mId !== 0 ) {
- $user->mFrom = 'id';
- }
- $user->setItemLoaded( 'id' );
- }
- if ( $user->mFrom === 'defaults' ) {
- throw new InvalidArgumentException(
- 'Cannot create a user with no name, no ID, and no actor ID'
- );
- }
- return $user;
- }
- /**
- * Factory method to fetch whichever user has a given email confirmation code.
- * This code is generated when an account is created or its e-mail address
- * has changed.
- *
- * If the code is invalid or has expired, returns NULL.
- *
- * @param string $code Confirmation code
- * @param int $flags User::READ_* bitfield
- * @return User|null
- */
- public static function newFromConfirmationCode( $code, $flags = 0 ) {
- $db = ( $flags & self::READ_LATEST ) == self::READ_LATEST
- ? wfGetDB( DB_MASTER )
- : wfGetDB( DB_REPLICA );
- $id = $db->selectField(
- 'user',
- 'user_id',
- [
- 'user_email_token' => md5( $code ),
- 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
- ]
- );
- return $id ? self::newFromId( $id ) : null;
- }
- /**
- * Create a new user object using data from session. If the login
- * credentials are invalid, the result is an anonymous user.
- *
- * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
- * @return User
- */
- public static function newFromSession( WebRequest $request = null ) {
- $user = new User;
- $user->mFrom = 'session';
- $user->mRequest = $request;
- return $user;
- }
- /**
- * Create a new user object from a user row.
- * The row should have the following fields from the user table in it:
- * - either user_name or user_id to load further data if needed (or both)
- * - user_real_name
- * - all other fields (email, etc.)
- * It is useless to provide the remaining fields if either user_id,
- * user_name and user_real_name are not provided because the whole row
- * will be loaded once more from the database when accessing them.
- *
- * @param stdClass $row A row from the user table
- * @param array|null $data Further data to load into the object
- * (see User::loadFromRow for valid keys)
- * @return User
- */
- public static function newFromRow( $row, $data = null ) {
- $user = new User;
- $user->loadFromRow( $row, $data );
- return $user;
- }
- /**
- * Static factory method for creation of a "system" user from username.
- *
- * A "system" user is an account that's used to attribute logged actions
- * taken by MediaWiki itself, as opposed to a bot or human user. Examples
- * might include the 'Maintenance script' or 'Conversion script' accounts
- * used by various scripts in the maintenance/ directory or accounts such
- * as 'MediaWiki message delivery' used by the MassMessage extension.
- *
- * This can optionally create the user if it doesn't exist, and "steal" the
- * account if it does exist.
- *
- * "Stealing" an existing user is intended to make it impossible for normal
- * authentication processes to use the account, effectively disabling the
- * account for normal use:
- * - Email is invalidated, to prevent account recovery by emailing a
- * temporary password and to disassociate the account from the existing
- * human.
- * - The token is set to a magic invalid value, to kill existing sessions
- * and to prevent $this->setToken() calls from resetting the token to a
- * valid value.
- * - SessionManager is instructed to prevent new sessions for the user, to
- * do things like deauthorizing OAuth consumers.
- * - AuthManager is instructed to revoke access, to invalidate or remove
- * passwords and other credentials.
- *
- * @param string $name Username
- * @param array $options Options are:
- * - validate: As for User::getCanonicalName(), default 'valid'
- * - create: Whether to create the user if it doesn't already exist, default true
- * - steal: Whether to "disable" the account for normal use if it already
- * exists, default false
- * @return User|null
- * @since 1.27
- */
- public static function newSystemUser( $name, $options = [] ) {
- $options += [
- 'validate' => 'valid',
- 'create' => true,
- 'steal' => false,
- ];
- $name = self::getCanonicalName( $name, $options['validate'] );
- if ( $name === false ) {
- return null;
- }
- $dbr = wfGetDB( DB_REPLICA );
- $userQuery = self::getQueryInfo();
- $row = $dbr->selectRow(
- $userQuery['tables'],
- $userQuery['fields'],
- [ 'user_name' => $name ],
- __METHOD__,
- [],
- $userQuery['joins']
- );
- if ( !$row ) {
- // Try the master database...
- $dbw = wfGetDB( DB_MASTER );
- $row = $dbw->selectRow(
- $userQuery['tables'],
- $userQuery['fields'],
- [ 'user_name' => $name ],
- __METHOD__,
- [],
- $userQuery['joins']
- );
- }
- if ( !$row ) {
- // No user. Create it?
- return $options['create']
- ? self::createNew( $name, [ 'token' => self::INVALID_TOKEN ] )
- : null;
- }
- $user = self::newFromRow( $row );
- // A user is considered to exist as a non-system user if it can
- // authenticate, or has an email set, or has a non-invalid token.
- if ( $user->mEmail || $user->mToken !== self::INVALID_TOKEN ||
- AuthManager::singleton()->userCanAuthenticate( $name )
- ) {
- // User exists. Steal it?
- if ( !$options['steal'] ) {
- return null;
- }
- AuthManager::singleton()->revokeAccessForUser( $name );
- $user->invalidateEmail();
- $user->mToken = self::INVALID_TOKEN;
- $user->saveSettings();
- SessionManager::singleton()->preventSessionsForUser( $user->getName() );
- }
- return $user;
- }
- // @}
- /**
- * Get the username corresponding to a given user ID
- * @param int $id User ID
- * @return string|bool The corresponding username
- */
- public static function whoIs( $id ) {
- return UserCache::singleton()->getProp( $id, 'name' );
- }
- /**
- * Get the real name of a user given their user ID
- *
- * @param int $id User ID
- * @return string|bool The corresponding user's real name
- */
- public static function whoIsReal( $id ) {
- return UserCache::singleton()->getProp( $id, 'real_name' );
- }
- /**
- * Get database id given a user name
- * @param string $name Username
- * @param int $flags User::READ_* constant bitfield
- * @return int|null The corresponding user's ID, or null if user is nonexistent
- */
- public static function idFromName( $name, $flags = self::READ_NORMAL ) {
- // Don't explode on self::$idCacheByName[$name] if $name is not a string but e.g. a User object
- $name = (string)$name;
- $nt = Title::makeTitleSafe( NS_USER, $name );
- if ( is_null( $nt ) ) {
- // Illegal name
- return null;
- }
- if ( !( $flags & self::READ_LATEST ) && array_key_exists( $name, self::$idCacheByName ) ) {
- return is_null( self::$idCacheByName[$name] ) ? null : (int)self::$idCacheByName[$name];
- }
- list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $flags );
- $db = wfGetDB( $index );
- $s = $db->selectRow(
- 'user',
- [ 'user_id' ],
- [ 'user_name' => $nt->getText() ],
- __METHOD__,
- $options
- );
- if ( $s === false ) {
- $result = null;
- } else {
- $result = (int)$s->user_id;
- }
- if ( count( self::$idCacheByName ) >= 1000 ) {
- self::$idCacheByName = [];
- }
- self::$idCacheByName[$name] = $result;
- return $result;
- }
- /**
- * Reset the cache used in idFromName(). For use in tests.
- */
- public static function resetIdByNameCache() {
- self::$idCacheByName = [];
- }
- /**
- * Does the string match an anonymous IP address?
- *
- * This function exists for username validation, in order to reject
- * usernames which are similar in form to IP addresses. Strings such
- * as 300.300.300.300 will return true because it looks like an IP
- * address, despite not being strictly valid.
- *
- * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
- * address because the usemod software would "cloak" anonymous IP
- * addresses like this, if we allowed accounts like this to be created
- * new users could get the old edits of these anonymous users.
- *
- * @param string $name Name to match
- * @return bool
- */
- public static function isIP( $name ) {
- return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
- || IP::isIPv6( $name );
- }
- /**
- * Is the user an IP range?
- *
- * @since 1.30
- * @return bool
- */
- public function isIPRange() {
- return IP::isValidRange( $this->mName );
- }
- /**
- * Is the input a valid username?
- *
- * Checks if the input is a valid username, we don't want an empty string,
- * an IP address, anything that contains slashes (would mess up subpages),
- * is longer than the maximum allowed username size or doesn't begin with
- * a capital letter.
- *
- * @param string $name Name to match
- * @return bool
- */
- public static function isValidUserName( $name ) {
- global $wgMaxNameChars;
- if ( $name == ''
- || self::isIP( $name )
- || strpos( $name, '/' ) !== false
- || strlen( $name ) > $wgMaxNameChars
- || $name != MediaWikiServices::getInstance()->getContentLanguage()->ucfirst( $name )
- ) {
- return false;
- }
- // Ensure that the name can't be misresolved as a different title,
- // such as with extra namespace keys at the start.
- $parsed = Title::newFromText( $name );
- if ( is_null( $parsed )
- || $parsed->getNamespace()
- || strcmp( $name, $parsed->getPrefixedText() ) ) {
- return false;
- }
- // Check an additional blacklist of troublemaker characters.
- // Should these be merged into the title char list?
- $unicodeBlacklist = '/[' .
- '\x{0080}-\x{009f}' . # iso-8859-1 control chars
- '\x{00a0}' . # non-breaking space
- '\x{2000}-\x{200f}' . # various whitespace
- '\x{2028}-\x{202f}' . # breaks and control chars
- '\x{3000}' . # ideographic space
- '\x{e000}-\x{f8ff}' . # private use
- ']/u';
- if ( preg_match( $unicodeBlacklist, $name ) ) {
- return false;
- }
- return true;
- }
- /**
- * Usernames which fail to pass this function will be blocked
- * from user login and new account registrations, but may be used
- * internally by batch processes.
- *
- * If an account already exists in this form, login will be blocked
- * by a failure to pass this function.
- *
- * @param string $name Name to match
- * @return bool
- */
- public static function isUsableName( $name ) {
- global $wgReservedUsernames;
- // Must be a valid username, obviously ;)
- if ( !self::isValidUserName( $name ) ) {
- return false;
- }
- static $reservedUsernames = false;
- if ( !$reservedUsernames ) {
- $reservedUsernames = $wgReservedUsernames;
- Hooks::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
- }
- // Certain names may be reserved for batch processes.
- foreach ( $reservedUsernames as $reserved ) {
- if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
- $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->plain();
- }
- if ( $reserved == $name ) {
- return false;
- }
- }
- return true;
- }
- /**
- * Return the users who are members of the given group(s). In case of multiple groups,
- * users who are members of at least one of them are returned.
- *
- * @param string|array $groups A single group name or an array of group names
- * @param int $limit Max number of users to return. The actual limit will never exceed 5000
- * records; larger values are ignored.
- * @param int|null $after ID the user to start after
- * @return UserArrayFromResult
- */
- public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
- if ( $groups === [] ) {
- return UserArrayFromResult::newFromIDs( [] );
- }
- $groups = array_unique( (array)$groups );
- $limit = min( 5000, $limit );
- $conds = [ 'ug_group' => $groups ];
- if ( $after !== null ) {
- $conds[] = 'ug_user > ' . (int)$after;
- }
- $dbr = wfGetDB( DB_REPLICA );
- $ids = $dbr->selectFieldValues(
- 'user_groups',
- 'ug_user',
- $conds,
- __METHOD__,
- [
- 'DISTINCT' => true,
- 'ORDER BY' => 'ug_user',
- 'LIMIT' => $limit,
- ]
- ) ?: [];
- return UserArray::newFromIDs( $ids );
- }
- /**
- * Usernames which fail to pass this function will be blocked
- * from new account registrations, but may be used internally
- * either by batch processes or by user accounts which have
- * already been created.
- *
- * Additional blacklisting may be added here rather than in
- * isValidUserName() to avoid disrupting existing accounts.
- *
- * @param string $name String to match
- * @return bool
- */
- public static function isCreatableName( $name ) {
- global $wgInvalidUsernameCharacters;
- // Ensure that the username isn't longer than 235 bytes, so that
- // (at least for the builtin skins) user javascript and css files
- // will work. (T25080)
- if ( strlen( $name ) > 235 ) {
- wfDebugLog( 'username', __METHOD__ .
- ": '$name' invalid due to length" );
- return false;
- }
- // Preg yells if you try to give it an empty string
- if ( $wgInvalidUsernameCharacters !== '' &&
- preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name )
- ) {
- wfDebugLog( 'username', __METHOD__ .
- ": '$name' invalid due to wgInvalidUsernameCharacters" );
- return false;
- }
- return self::isUsableName( $name );
- }
- /**
- * Is the input a valid password for this user?
- *
- * @param string $password Desired password
- * @return bool
- */
- public function isValidPassword( $password ) {
- // simple boolean wrapper for checkPasswordValidity
- return $this->checkPasswordValidity( $password )->isGood();
- }
- /**
- * Check if this is a valid password for this user
- *
- * Returns a Status object with a set of messages describing
- * problems with the password. If the return status is fatal,
- * the action should be refused and the password should not be
- * checked at all (this is mainly meant for DoS mitigation).
- * If the return value is OK but not good, the password can be checked,
- * but the user should not be able to set their password to this.
- * The value of the returned Status object will be an array which
- * can have the following fields:
- * - forceChange (bool): if set to true, the user should not be
- * allowed to log with this password unless they change it during
- * the login process (see ResetPasswordSecondaryAuthenticationProvider).
- * - suggestChangeOnLogin (bool): if set to true, the user should be prompted for
- * a password change on login.
- *
- * @param string $password Desired password
- * @return Status
- * @since 1.23
- */
- public function checkPasswordValidity( $password ) {
- global $wgPasswordPolicy;
- $upp = new UserPasswordPolicy(
- $wgPasswordPolicy['policies'],
- $wgPasswordPolicy['checks']
- );
- $status = Status::newGood( [] );
- $result = false; // init $result to false for the internal checks
- if ( !Hooks::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
- $status->error( $result );
- return $status;
- }
- if ( $result === false ) {
- $status->merge( $upp->checkUserPassword( $this, $password ), true );
- return $status;
- }
- if ( $result === true ) {
- return $status;
- }
- $status->error( $result );
- return $status; // the isValidPassword hook set a string $result and returned true
- }
- /**
- * Given unvalidated user input, return a canonical username, or false if
- * the username is invalid.
- * @param string $name User input
- * @param string|bool $validate Type of validation to use:
- * - false No validation
- * - 'valid' Valid for batch processes
- * - 'usable' Valid for batch processes and login
- * - 'creatable' Valid for batch processes, login and account creation
- *
- * @throws InvalidArgumentException
- * @return bool|string
- */
- public static function getCanonicalName( $name, $validate = 'valid' ) {
- // Force usernames to capital
- $name = MediaWikiServices::getInstance()->getContentLanguage()->ucfirst( $name );
- # Reject names containing '#'; these will be cleaned up
- # with title normalisation, but then it's too late to
- # check elsewhere
- if ( strpos( $name, '#' ) !== false ) {
- return false;
- }
- // Clean up name according to title rules,
- // but only when validation is requested (T14654)
- $t = ( $validate !== false ) ?
- Title::newFromText( $name, NS_USER ) : Title::makeTitle( NS_USER, $name );
- // Check for invalid titles
- if ( is_null( $t ) || $t->getNamespace() !== NS_USER || $t->isExternal() ) {
- return false;
- }
- $name = $t->getText();
- switch ( $validate ) {
- case false:
- break;
- case 'valid':
- if ( !self::isValidUserName( $name ) ) {
- $name = false;
- }
- break;
- case 'usable':
- if ( !self::isUsableName( $name ) ) {
- $name = false;
- }
- break;
- case 'creatable':
- if ( !self::isCreatableName( $name ) ) {
- $name = false;
- }
- break;
- default:
- throw new InvalidArgumentException(
- 'Invalid parameter value for $validate in ' . __METHOD__ );
- }
- return $name;
- }
- /**
- * Set cached properties to default.
- *
- * @note This no longer clears uncached lazy-initialised properties;
- * the constructor does that instead.
- *
- * @param string|bool $name
- * @param int|null $actorId
- */
- public function loadDefaults( $name = false, $actorId = null ) {
- $this->mId = 0;
- $this->mName = $name;
- $this->mActorId = $actorId;
- $this->mRealName = '';
- $this->mEmail = '';
- $this->mOptionOverrides = null;
- $this->mOptionsLoaded = false;
- $loggedOut = $this->mRequest && !defined( 'MW_NO_SESSION' )
- ? $this->mRequest->getSession()->getLoggedOutTimestamp() : 0;
- if ( $loggedOut !== 0 ) {
- $this->mTouched = wfTimestamp( TS_MW, $loggedOut );
- } else {
- $this->mTouched = '1'; # Allow any pages to be cached
- }
- $this->mToken = null; // Don't run cryptographic functions till we need a token
- $this->mEmailAuthenticated = null;
- $this->mEmailToken = '';
- $this->mEmailTokenExpires = null;
- $this->mRegistration = wfTimestamp( TS_MW );
- $this->mGroupMemberships = [];
- Hooks::run( 'UserLoadDefaults', [ $this, $name ] );
- }
- /**
- * Return whether an item has been loaded.
- *
- * @param string $item Item to check. Current possibilities:
- * - id
- * - name
- * - realname
- * @param string $all 'all' to check if the whole object has been loaded
- * or any other string to check if only the item is available (e.g.
- * for optimisation)
- * @return bool
- */
- public function isItemLoaded( $item, $all = 'all' ) {
- return ( $this->mLoadedItems === true && $all === 'all' ) ||
- ( isset( $this->mLoadedItems[$item] ) && $this->mLoadedItems[$item] === true );
- }
- /**
- * Set that an item has been loaded
- *
- * @param string $item
- */
- protected function setItemLoaded( $item ) {
- if ( is_array( $this->mLoadedItems ) ) {
- $this->mLoadedItems[$item] = true;
- }
- }
- /**
- * Load user data from the session.
- *
- * @return bool True if the user is logged in, false otherwise.
- */
- private function loadFromSession() {
- // MediaWiki\Session\Session already did the necessary authentication of the user
- // returned here, so just use it if applicable.
- $session = $this->getRequest()->getSession();
- $user = $session->getUser();
- if ( $user->isLoggedIn() ) {
- $this->loadFromUserObject( $user );
- // If this user is autoblocked, set a cookie to track the block. This has to be done on
- // every session load, because an autoblocked editor might not edit again from the same
- // IP address after being blocked.
- MediaWikiServices::getInstance()->getBlockManager()->trackBlockWithCookie( $this );
- // Other code expects these to be set in the session, so set them.
- $session->set( 'wsUserID', $this->getId() );
- $session->set( 'wsUserName', $this->getName() );
- $session->set( 'wsToken', $this->getToken() );
- return true;
- }
- return false;
- }
- /**
- * Set the 'BlockID' cookie depending on block type and user authentication status.
- *
- * @deprecated since 1.34 Use BlockManager::trackBlockWithCookie instead
- */
- public function trackBlockWithCookie() {
- MediaWikiServices::getInstance()->getBlockManager()->trackBlockWithCookie( $this );
- }
- /**
- * Load user and user_group data from the database.
- * $this->mId must be set, this is how the user is identified.
- *
- * @param int $flags User::READ_* constant bitfield
- * @return bool True if the user exists, false if the user is anonymous
- */
- public function loadFromDatabase( $flags = self::READ_LATEST ) {
- // Paranoia
- $this->mId = intval( $this->mId );
- if ( !$this->mId ) {
- // Anonymous users are not in the database
- $this->loadDefaults();
- return false;
- }
- list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $flags );
- $db = wfGetDB( $index );
- $userQuery = self::getQueryInfo();
- $s = $db->selectRow(
- $userQuery['tables'],
- $userQuery['fields'],
- [ 'user_id' => $this->mId ],
- __METHOD__,
- $options,
- $userQuery['joins']
- );
- $this->queryFlagsUsed = $flags;
- Hooks::run( 'UserLoadFromDatabase', [ $this, &$s ] );
- if ( $s !== false ) {
- // Initialise user table data
- $this->loadFromRow( $s );
- $this->mGroupMemberships = null; // deferred
- $this->getEditCount(); // revalidation for nulls
- return true;
- }
- // Invalid user_id
- $this->mId = 0;
- $this->loadDefaults();
- return false;
- }
- /**
- * Initialize this object from a row from the user table.
- *
- * @param stdClass $row Row from the user table to load.
- * @param array|null $data Further user data to load into the object
- *
- * user_groups Array of arrays or stdClass result rows out of the user_groups
- * table. Previously you were supposed to pass an array of strings
- * here, but we also need expiry info nowadays, so an array of
- * strings is ignored.
- * user_properties Array with properties out of the user_properties table
- */
- protected function loadFromRow( $row, $data = null ) {
- if ( !is_object( $row ) ) {
- throw new InvalidArgumentException( '$row must be an object' );
- }
- $all = true;
- $this->mGroupMemberships = null; // deferred
- if ( isset( $row->actor_id ) ) {
- $this->mActorId = (int)$row->actor_id;
- if ( $this->mActorId !== 0 ) {
- $this->mFrom = 'actor';
- }
- $this->setItemLoaded( 'actor' );
- } else {
- $all = false;
- }
- if ( isset( $row->user_name ) && $row->user_name !== '' ) {
- $this->mName = $row->user_name;
- $this->mFrom = 'name';
- $this->setItemLoaded( 'name' );
- } else {
- $all = false;
- }
- if ( isset( $row->user_real_name ) ) {
- $this->mRealName = $row->user_real_name;
- $this->setItemLoaded( 'realname' );
- } else {
- $all = false;
- }
- if ( isset( $row->user_id ) ) {
- $this->mId = intval( $row->user_id );
- if ( $this->mId !== 0 ) {
- $this->mFrom = 'id';
- }
- $this->setItemLoaded( 'id' );
- } else {
- $all = false;
- }
- if ( isset( $row->user_id ) && isset( $row->user_name ) && $row->user_name !== '' ) {
- self::$idCacheByName[$row->user_name] = $row->user_id;
- }
- if ( isset( $row->user_editcount ) ) {
- $this->mEditCount = $row->user_editcount;
- } else {
- $all = false;
- }
- if ( isset( $row->user_touched ) ) {
- $this->mTouched = wfTimestamp( TS_MW, $row->user_touched );
- } else {
- $all = false;
- }
- if ( isset( $row->user_token ) ) {
- // The definition for the column is binary(32), so trim the NULs
- // that appends. The previous definition was char(32), so trim
- // spaces too.
- $this->mToken = rtrim( $row->user_token, " \0" );
- if ( $this->mToken === '' ) {
- $this->mToken = null;
- }
- } else {
- $all = false;
- }
- if ( isset( $row->user_email ) ) {
- $this->mEmail = $row->user_email;
- $this->mEmailAuthenticated = wfTimestampOrNull( TS_MW, $row->user_email_authenticated );
- $this->mEmailToken = $row->user_email_token;
- $this->mEmailTokenExpires = wfTimestampOrNull( TS_MW, $row->user_email_token_expires );
- $this->mRegistration = wfTimestampOrNull( TS_MW, $row->user_registration );
- } else {
- $all = false;
- }
- if ( $all ) {
- $this->mLoadedItems = true;
- }
- if ( is_array( $data ) ) {
- if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
- if ( $data['user_groups'] === [] ) {
- $this->mGroupMemberships = [];
- } else {
- $firstGroup = reset( $data['user_groups'] );
- if ( is_array( $firstGroup ) || is_object( $firstGroup ) ) {
- $this->mGroupMemberships = [];
- foreach ( $data['user_groups'] as $row ) {
- $ugm = UserGroupMembership::newFromRow( (object)$row );
- $this->mGroupMemberships[$ugm->getGroup()] = $ugm;
- }
- }
- }
- }
- if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
- $this->loadOptions( $data['user_properties'] );
- }
- }
- }
- /**
- * Load the data for this user object from another user object.
- *
- * @param User $user
- */
- protected function loadFromUserObject( $user ) {
- $user->load();
- foreach ( self::$mCacheVars as $var ) {
- $this->$var = $user->$var;
- }
- }
- /**
- * Load the groups from the database if they aren't already loaded.
- */
- private function loadGroups() {
- if ( is_null( $this->mGroupMemberships ) ) {
- $db = ( $this->queryFlagsUsed & self::READ_LATEST )
- ? wfGetDB( DB_MASTER )
- : wfGetDB( DB_REPLICA );
- $this->mGroupMemberships = UserGroupMembership::getMembershipsForUser(
- $this->mId, $db );
- }
- }
- /**
- * Add the user to the group if he/she meets given criteria.
- *
- * Contrary to autopromotion by \ref $wgAutopromote, the group will be
- * possible to remove manually via Special:UserRights. In such case it
- * will not be re-added automatically. The user will also not lose the
- * group if they no longer meet the criteria.
- *
- * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
- *
- * @return array Array of groups the user has been promoted to.
- *
- * @see $wgAutopromoteOnce
- */
- public function addAutopromoteOnceGroups( $event ) {
- global $wgAutopromoteOnceLogInRC;
- if ( wfReadOnly() || !$this->getId() ) {
- return [];
- }
- $toPromote = Autopromote::getAutopromoteOnceGroups( $this, $event );
- if ( $toPromote === [] ) {
- return [];
- }
- if ( !$this->checkAndSetTouched() ) {
- return []; // raced out (bug T48834)
- }
- $oldGroups = $this->getGroups(); // previous groups
- $oldUGMs = $this->getGroupMemberships();
- foreach ( $toPromote as $group ) {
- $this->addGroup( $group );
- }
- $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
- $newUGMs = $this->getGroupMemberships();
- // update groups in external authentication database
- Hooks::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false, $oldUGMs, $newUGMs ] );
- $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
- $logEntry->setPerformer( $this );
- $logEntry->setTarget( $this->getUserPage() );
- $logEntry->setParameters( [
- '4::oldgroups' => $oldGroups,
- '5::newgroups' => $newGroups,
- ] );
- $logid = $logEntry->insert();
- if ( $wgAutopromoteOnceLogInRC ) {
- $logEntry->publish( $logid );
- }
- return $toPromote;
- }
- /**
- * Builds update conditions. Additional conditions may be added to $conditions to
- * protected against race conditions using a compare-and-set (CAS) mechanism
- * based on comparing $this->mTouched with the user_touched field.
- *
- * @param IDatabase $db
- * @param array $conditions WHERE conditions for use with Database::update
- * @return array WHERE conditions for use with Database::update
- */
- protected function makeUpdateConditions( IDatabase $db, array $conditions ) {
- if ( $this->mTouched ) {
- // CAS check: only update if the row wasn't changed sicne it was loaded.
- $conditions['user_touched'] = $db->timestamp( $this->mTouched );
- }
- return $conditions;
- }
- /**
- * Bump user_touched if it didn't change since this object was loaded
- *
- * On success, the mTouched field is updated.
- * The user serialization cache is always cleared.
- *
- * @return bool Whether user_touched was actually updated
- * @since 1.26
- */
- protected function checkAndSetTouched() {
- $this->load();
- if ( !$this->mId ) {
- return false; // anon
- }
- // Get a new user_touched that is higher than the old one
- $newTouched = $this->newTouchedTimestamp();
- $dbw = wfGetDB( DB_MASTER );
- $dbw->update( 'user',
- [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
- $this->makeUpdateConditions( $dbw, [
- 'user_id' => $this->mId,
- ] ),
- __METHOD__
- );
- $success = ( $dbw->affectedRows() > 0 );
- if ( $success ) {
- $this->mTouched = $newTouched;
- $this->clearSharedCache( 'changed' );
- } else {
- // Clears on failure too since that is desired if the cache is stale
- $this->clearSharedCache( 'refresh' );
- }
- return $success;
- }
- /**
- * Clear various cached data stored in this object. The cache of the user table
- * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
- *
- * @param bool|string $reloadFrom Reload user and user_groups table data from a
- * given source. May be "name", "id", "actor", "defaults", "session", or false for no reload.
- */
- public function clearInstanceCache( $reloadFrom = false ) {
- global $wgFullyInitialised;
- $this->mNewtalk = -1;
- $this->mDatePreference = null;
- $this->mBlockedby = -1; # Unset
- $this->mHash = false;
- $this->mEffectiveGroups = null;
- $this->mImplicitGroups = null;
- $this->mGroupMemberships = null;
- $this->mOptions = null;
- $this->mOptionsLoaded = false;
- $this->mEditCount = null;
- // Replacement of former `$this->mRights = null` line
- if ( $wgFullyInitialised && $this->mFrom ) {
- MediaWikiServices::getInstance()->getPermissionManager()->invalidateUsersRightsCache(
- $this
- );
- }
- if ( $reloadFrom ) {
- $this->mLoadedItems = [];
- $this->mFrom = $reloadFrom;
- }
- }
- /** @var array|null */
- private static $defOpt = null;
- /** @var string|null */
- private static $defOptLang = null;
- /**
- * Reset the process cache of default user options. This is only necessary
- * if the wiki configuration has changed since defaults were calculated,
- * and as such should only be performed inside the testing suite that
- * regularly changes wiki configuration.
- */
- public static function resetGetDefaultOptionsForTestsOnly() {
- Assert::invariant( defined( 'MW_PHPUNIT_TEST' ), 'Unit tests only' );
- self::$defOpt = null;
- self::$defOptLang = null;
- }
- /**
- * Combine the language default options with any site-specific options
- * and add the default language variants.
- *
- * @return array Array of String options
- */
- public static function getDefaultOptions() {
- global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgDefaultSkin;
- $contLang = MediaWikiServices::getInstance()->getContentLanguage();
- if ( self::$defOpt !== null && self::$defOptLang === $contLang->getCode() ) {
- // The content language does not change (and should not change) mid-request, but the
- // unit tests change it anyway, and expect this method to return values relevant to the
- // current content language.
- return self::$defOpt;
- }
- self::$defOpt = $wgDefaultUserOptions;
- // Default language setting
- self::$defOptLang = $contLang->getCode();
- self::$defOpt['language'] = self::$defOptLang;
- foreach ( LanguageConverter::$languagesWithVariants as $langCode ) {
- if ( $langCode === $contLang->getCode() ) {
- self::$defOpt['variant'] = $langCode;
- } else {
- self::$defOpt["variant-$langCode"] = $langCode;
- }
- }
- // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
- // since extensions may change the set of searchable namespaces depending
- // on user groups/permissions.
- foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
- self::$defOpt['searchNs' . $nsnum] = (bool)$val;
- }
- self::$defOpt['skin'] = Skin::normalizeKey( $wgDefaultSkin );
- Hooks::run( 'UserGetDefaultOptions', [ &self::$defOpt ] );
- return self::$defOpt;
- }
- /**
- * Get a given default option value.
- *
- * @param string $opt Name of option to retrieve
- * @return string Default option value
- */
- public static function getDefaultOption( $opt ) {
- $defOpts = self::getDefaultOptions();
- return $defOpts[$opt] ?? null;
- }
- /**
- * Get blocking information
- *
- * TODO: Move this into the BlockManager, along with block-related properties.
- *
- * @param bool $fromReplica Whether to check the replica DB first.
- * To improve performance, non-critical checks are done against replica DBs.
- * Check when actually saving should be done against master.
- */
- private function getBlockedStatus( $fromReplica = true ) {
- if ( $this->mBlockedby != -1 ) {
- return;
- }
- wfDebug( __METHOD__ . ": checking...\n" );
- // Initialize data...
- // Otherwise something ends up stomping on $this->mBlockedby when
- // things get lazy-loaded later, causing false positive block hits
- // due to -1 !== 0. Probably session-related... Nothing should be
- // overwriting mBlockedby, surely?
- $this->load();
- // TODO: Block checking shouldn't really be done from the User object. Block
- // checking can involve checking for IP blocks, cookie blocks, and/or XFF blocks,
- // which need more knowledge of the request context than the User should have.
- // Since we do currently check blocks from the User, we have to do the following
- // here:
- // - Check if this is the user associated with the main request
- // - If so, pass the relevant request information to the block manager
- $request = null;
- // The session user is set up towards the end of Setup.php. Until then,
- // assume it's a logged-out user.
- $sessionUser = RequestContext::getMain()->getUser();
- $globalUserName = $sessionUser->isSafeToLoad()
- ? $sessionUser->getName()
- : IP::sanitizeIP( $sessionUser->getRequest()->getIP() );
- if ( $this->getName() === $globalUserName ) {
- // This is the global user, so we need to pass the request
- $request = $this->getRequest();
- }
- // @phan-suppress-next-line PhanAccessMethodInternal It's the only allowed use
- $block = MediaWikiServices::getInstance()->getBlockManager()->getUserBlock(
- $this,
- $request,
- $fromReplica
- );
- if ( $block ) {
- $this->mBlock = $block;
- $this->mBlockedby = $block->getByName();
- $this->mBlockreason = $block->getReason();
- $this->mHideName = $block->getHideName();
- $this->mAllowUsertalk = $block->isUsertalkEditAllowed();
- } else {
- $this->mBlock = null;
- $this->mBlockedby = '';
- $this->mBlockreason = '';
- $this->mHideName = 0;
- $this->mAllowUsertalk = false;
- }
- // Avoid PHP 7.1 warning of passing $this by reference
- $thisUser = $this;
- // Extensions
- Hooks::run( 'GetBlockedStatus', [ &$thisUser ], '1.34' );
- }
- /**
- * Whether the given IP is in a DNS blacklist.
- *
- * @deprecated since 1.34 Use BlockManager::isDnsBlacklisted.
- * @param string $ip IP to check
- * @param bool $checkWhitelist Whether to check the whitelist first
- * @return bool True if blacklisted.
- */
- public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
- return MediaWikiServices::getInstance()->getBlockManager()
- ->isDnsBlacklisted( $ip, $checkWhitelist );
- }
- /**
- * Whether the given IP is in a given DNS blacklist.
- *
- * @deprecated since 1.34 Check via BlockManager::isDnsBlacklisted instead.
- * @param string $ip IP to check
- * @param string|array $bases Array of Strings: URL of the DNS blacklist
- * @return bool True if blacklisted.
- */
- public function inDnsBlacklist( $ip, $bases ) {
- wfDeprecated( __METHOD__, '1.34' );
- $found = false;
- // @todo FIXME: IPv6 ??? (https://bugs.php.net/bug.php?id=33170)
- if ( IP::isIPv4( $ip ) ) {
- // Reverse IP, T23255
- $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
- foreach ( (array)$bases as $base ) {
- // Make hostname
- // If we have an access key, use that too (ProjectHoneypot, etc.)
- $basename = $base;
- if ( is_array( $base ) ) {
- if ( count( $base ) >= 2 ) {
- // Access key is 1, base URL is 0
- $host = "{$base[1]}.$ipReversed.{$base[0]}";
- } else {
- $host = "$ipReversed.{$base[0]}";
- }
- $basename = $base[0];
- } else {
- $host = "$ipReversed.$base";
- }
- // Send query
- $ipList = gethostbynamel( $host );
- if ( $ipList ) {
- wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
- $found = true;
- break;
- }
- wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
- }
- }
- return $found;
- }
- /**
- * Check if an IP address is in the local proxy list
- *
- * @deprecated since 1.34 Use BlockManager::getUserBlock instead.
- * @param string $ip
- * @return bool
- */
- public static function isLocallyBlockedProxy( $ip ) {
- wfDeprecated( __METHOD__, '1.34' );
- global $wgProxyList;
- if ( !$wgProxyList ) {
- return false;
- }
- if ( !is_array( $wgProxyList ) ) {
- // Load values from the specified file
- $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
- }
- $resultProxyList = [];
- $deprecatedIPEntries = [];
- // backward compatibility: move all ip addresses in keys to values
- foreach ( $wgProxyList as $key => $value ) {
- $keyIsIP = IP::isIPAddress( $key );
- $valueIsIP = IP::isIPAddress( $value );
- if ( $keyIsIP && !$valueIsIP ) {
- $deprecatedIPEntries[] = $key;
- $resultProxyList[] = $key;
- } elseif ( $keyIsIP && $valueIsIP ) {
- $deprecatedIPEntries[] = $key;
- $resultProxyList[] = $key;
- $resultProxyList[] = $value;
- } else {
- $resultProxyList[] = $value;
- }
- }
- if ( $deprecatedIPEntries ) {
- wfDeprecated(
- 'IP addresses in the keys of $wgProxyList (found the following IP addresses in keys: ' .
- implode( ', ', $deprecatedIPEntries ) . ', please move them to values)', '1.30' );
- }
- $proxyListIPSet = new IPSet( $resultProxyList );
- return $proxyListIPSet->match( $ip );
- }
- /**
- * Is this user subject to rate limiting?
- *
- * @return bool True if rate limited
- */
- public function isPingLimitable() {
- global $wgRateLimitsExcludedIPs;
- if ( IP::isInRanges( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
- // No other good way currently to disable rate limits
- // for specific IPs. :P
- // But this is a crappy hack and should die.
- return false;
- }
- return !$this->isAllowed( 'noratelimit' );
- }
- /**
- * Primitive rate limits: enforce maximum actions per time period
- * to put a brake on flooding.
- *
- * The method generates both a generic profiling point and a per action one
- * (suffix being "-$action".
- *
- * @note When using a shared cache like memcached, IP-address
- * last-hit counters will be shared across wikis.
- *
- * @param string $action Action to enforce; 'edit' if unspecified
- * @param int $incrBy Positive amount to increment counter by [defaults to 1]
- * @return bool True if a rate limiter was tripped
- */
- public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
- // Avoid PHP 7.1 warning of passing $this by reference
- $user = $this;
- // Call the 'PingLimiter' hook
- $result = false;
- if ( !Hooks::run( 'PingLimiter', [ &$user, $action, &$result, $incrBy ] ) ) {
- return $result;
- }
- global $wgRateLimits;
- if ( !isset( $wgRateLimits[$action] ) ) {
- return false;
- }
- $limits = array_merge(
- [ '&can-bypass' => true ],
- $wgRateLimits[$action]
- );
- // Some groups shouldn't trigger the ping limiter, ever
- if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
- return false;
- }
- $keys = [];
- $id = $this->getId();
- $userLimit = false;
- $isNewbie = $this->isNewbie();
- $cache = ObjectCache::getLocalClusterInstance();
- if ( $id == 0 ) {
- // limits for anons
- if ( isset( $limits['anon'] ) ) {
- $keys[$cache->makeKey( 'limiter', $action, 'anon' )] = $limits['anon'];
- }
- } elseif ( isset( $limits['user'] ) ) {
- // limits for logged-in users
- $userLimit = $limits['user'];
- }
- // limits for anons and for newbie logged-in users
- if ( $isNewbie ) {
- // ip-based limits
- if ( isset( $limits['ip'] ) ) {
- $ip = $this->getRequest()->getIP();
- $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
- }
- // subnet-based limits
- if ( isset( $limits['subnet'] ) ) {
- $ip = $this->getRequest()->getIP();
- $subnet = IP::getSubnet( $ip );
- if ( $subnet !== false ) {
- $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
- }
- }
- }
- // Check for group-specific permissions
- // If more than one group applies, use the group with the highest limit ratio (max/period)
- foreach ( $this->getGroups() as $group ) {
- if ( isset( $limits[$group] ) ) {
- if ( $userLimit === false
- || $limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
- ) {
- $userLimit = $limits[$group];
- }
- }
- }
- // limits for newbie logged-in users (override all the normal user limits)
- if ( $id !== 0 && $isNewbie && isset( $limits['newbie'] ) ) {
- $userLimit = $limits['newbie'];
- }
- // Set the user limit key
- if ( $userLimit !== false ) {
- // phan is confused because &can-bypass's value is a bool, so it assumes
- // that $userLimit is also a bool here.
- // @phan-suppress-next-line PhanTypeInvalidExpressionArrayDestructuring
- list( $max, $period ) = $userLimit;
- wfDebug( __METHOD__ . ": effective user limit: $max in {$period}s\n" );
- $keys[$cache->makeKey( 'limiter', $action, 'user', $id )] = $userLimit;
- }
- // ip-based limits for all ping-limitable users
- if ( isset( $limits['ip-all'] ) ) {
- $ip = $this->getRequest()->getIP();
- // ignore if user limit is more permissive
- if ( $isNewbie || $userLimit === false
- || $limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
- $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
- }
- }
- // subnet-based limits for all ping-limitable users
- if ( isset( $limits['subnet-all'] ) ) {
- $ip = $this->getRequest()->getIP();
- $subnet = IP::getSubnet( $ip );
- if ( $subnet !== false ) {
- // ignore if user limit is more permissive
- if ( $isNewbie || $userLimit === false
- || $limits['ip-all'][0] / $limits['ip-all'][1]
- > $userLimit[0] / $userLimit[1] ) {
- $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
- }
- }
- }
- $triggered = false;
- foreach ( $keys as $key => $limit ) {
- // phan is confused because &can-bypass's value is a bool, so it assumes
- // that $userLimit is also a bool here.
- // @phan-suppress-next-line PhanTypeInvalidExpressionArrayDestructuring
- list( $max, $period ) = $limit;
- $summary = "(limit $max in {$period}s)";
- $count = $cache->get( $key );
- // Already pinged?
- if ( $count && $count >= $max ) {
- wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
- "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
- $triggered = true;
- } else {
- wfDebug( __METHOD__ . ": adding record for $key $summary\n" );
- if ( $incrBy > 0 ) {
- $cache->add( $key, 0, intval( $period ) ); // first ping
- }
- }
- if ( $incrBy > 0 ) {
- $cache->incrWithInit( $key, (int)$period, $incrBy, $incrBy );
- }
- }
- return $triggered;
- }
- /**
- * Check if user is blocked
- *
- * @deprecated since 1.34, use User::getBlock() or
- * PermissionManager::isBlockedFrom() or
- * PermissionManager::userCan() instead.
- *
- * @param bool $fromReplica Whether to check the replica DB instead of
- * the master. Hacked from false due to horrible probs on site.
- * @return bool True if blocked, false otherwise
- */
- public function isBlocked( $fromReplica = true ) {
- return $this->getBlock( $fromReplica ) instanceof AbstractBlock &&
- $this->getBlock()->appliesToRight( 'edit' );
- }
- /**
- * Get the block affecting the user, or null if the user is not blocked
- *
- * @param bool $fromReplica Whether to check the replica DB instead of the master
- * @return AbstractBlock|null
- */
- public function getBlock( $fromReplica = true ) {
- $this->getBlockedStatus( $fromReplica );
- return $this->mBlock instanceof AbstractBlock ? $this->mBlock : null;
- }
- /**
- * Check if user is blocked from editing a particular article
- *
- * @param Title $title Title to check
- * @param bool $fromReplica Whether to check the replica DB instead of the master
- * @return bool
- *
- * @deprecated since 1.33,
- * use MediaWikiServices::getInstance()->getPermissionManager()->isBlockedFrom(..)
- *
- */
- public function isBlockedFrom( $title, $fromReplica = false ) {
- return MediaWikiServices::getInstance()->getPermissionManager()
- ->isBlockedFrom( $this, $title, $fromReplica );
- }
- /**
- * If user is blocked, return the name of the user who placed the block
- * @return string Name of blocker
- */
- public function blockedBy() {
- $this->getBlockedStatus();
- return $this->mBlockedby;
- }
- /**
- * If user is blocked, return the specified reason for the block
- * @return string Blocking reason
- */
- public function blockedFor() {
- $this->getBlockedStatus();
- return $this->mBlockreason;
- }
- /**
- * If user is blocked, return the ID for the block
- * @return int Block ID
- */
- public function getBlockId() {
- $this->getBlockedStatus();
- return ( $this->mBlock ? $this->mBlock->getId() : false );
- }
- /**
- * Check if user is blocked on all wikis.
- * Do not use for actual edit permission checks!
- * This is intended for quick UI checks.
- *
- * @param string $ip IP address, uses current client if none given
- * @return bool True if blocked, false otherwise
- */
- public function isBlockedGlobally( $ip = '' ) {
- return $this->getGlobalBlock( $ip ) instanceof AbstractBlock;
- }
- /**
- * Check if user is blocked on all wikis.
- * Do not use for actual edit permission checks!
- * This is intended for quick UI checks.
- *
- * @param string $ip IP address, uses current client if none given
- * @return AbstractBlock|null Block object if blocked, null otherwise
- * @throws FatalError
- * @throws MWException
- */
- public function getGlobalBlock( $ip = '' ) {
- if ( $this->mGlobalBlock !== null ) {
- return $this->mGlobalBlock ?: null;
- }
- // User is already an IP?
- if ( IP::isIPAddress( $this->getName() ) ) {
- $ip = $this->getName();
- } elseif ( !$ip ) {
- $ip = $this->getRequest()->getIP();
- }
- // Avoid PHP 7.1 warning of passing $this by reference
- $user = $this;
- $blocked = false;
- $block = null;
- Hooks::run( 'UserIsBlockedGlobally', [ &$user, $ip, &$blocked, &$block ] );
- if ( $blocked && $block === null ) {
- // back-compat: UserIsBlockedGlobally didn't have $block param first
- $block = new SystemBlock( [
- 'address' => $ip,
- 'systemBlock' => 'global-block'
- ] );
- }
- $this->mGlobalBlock = $blocked ? $block : false;
- return $this->mGlobalBlock ?: null;
- }
- /**
- * Check if user account is locked
- *
- * @return bool True if locked, false otherwise
- */
- public function isLocked() {
- if ( $this->mLocked !== null ) {
- return $this->mLocked;
- }
- // Reset for hook
- $this->mLocked = false;
- Hooks::run( 'UserIsLocked', [ $this, &$this->mLocked ] );
- return $this->mLocked;
- }
- /**
- * Check if user account is hidden
- *
- * @return bool True if hidden, false otherwise
- */
- public function isHidden() {
- if ( $this->mHideName !== null ) {
- return (bool)$this->mHideName;
- }
- $this->getBlockedStatus();
- if ( !$this->mHideName ) {
- // Reset for hook
- $this->mHideName = false;
- Hooks::run( 'UserIsHidden', [ $this, &$this->mHideName ], '1.34' );
- }
- return (bool)$this->mHideName;
- }
- /**
- * Get the user's ID.
- * @return int The user's ID; 0 if the user is anonymous or nonexistent
- */
- public function getId() {
- if ( $this->mId === null && $this->mName !== null &&
- ( self::isIP( $this->mName ) || ExternalUserNames::isExternal( $this->mName ) )
- ) {
- // Special case, we know the user is anonymous
- return 0;
- }
- if ( !$this->isItemLoaded( 'id' ) ) {
- // Don't load if this was initialized from an ID
- $this->load();
- }
- return (int)$this->mId;
- }
- /**
- * Set the user and reload all fields according to a given ID
- * @param int $v User ID to reload
- */
- public function setId( $v ) {
- $this->mId = $v;
- $this->clearInstanceCache( 'id' );
- }
- /**
- * Get the user name, or the IP of an anonymous user
- * @return string User's name or IP address
- */
- public function getName() {
- if ( $this->isItemLoaded( 'name', 'only' ) ) {
- // Special case optimisation
- return $this->mName;
- }
- $this->load();
- if ( $this->mName === false ) {
- // Clean up IPs
- $this->mName = IP::sanitizeIP( $this->getRequest()->getIP() );
- }
- return $this->mName;
- }
- /**
- * Set the user name.
- *
- * This does not reload fields from the database according to the given
- * name. Rather, it is used to create a temporary "nonexistent user" for
- * later addition to the database. It can also be used to set the IP
- * address for an anonymous user to something other than the current
- * remote IP.
- *
- * @note User::newFromName() has roughly the same function, when the named user
- * does not exist.
- * @param string $str New user name to set
- */
- public function setName( $str ) {
- $this->load();
- $this->mName = $str;
- }
- /**
- * Get the user's actor ID.
- * @since 1.31
- * @param IDatabase|null $dbw Assign a new actor ID, using this DB handle, if none exists
- * @return int The actor's ID, or 0 if no actor ID exists and $dbw was null
- */
- public function getActorId( IDatabase $dbw = null ) {
- if ( !$this->isItemLoaded( 'actor' ) ) {
- $this->load();
- }
- if ( !$this->mActorId && $dbw ) {
- $q = [
- 'actor_user' => $this->getId() ?: null,
- 'actor_name' => (string)$this->getName(),
- ];
- if ( $q['actor_user'] === null && self::isUsableName( $q['actor_name'] ) ) {
- throw new CannotCreateActorException(
- 'Cannot create an actor for a usable name that is not an existing user'
- );
- }
- if ( $q['actor_name'] === '' ) {
- throw new CannotCreateActorException( 'Cannot create an actor for a user with no name' );
- }
- $dbw->insert( 'actor', $q, __METHOD__, [ 'IGNORE' ] );
- if ( $dbw->affectedRows() ) {
- $this->mActorId = (int)$dbw->insertId();
- } else {
- // Outdated cache?
- // Use LOCK IN SHARE MODE to bypass any MySQL REPEATABLE-READ snapshot.
- $this->mActorId = (int)$dbw->selectField(
- 'actor',
- 'actor_id',
- $q,
- __METHOD__,
- [ 'LOCK IN SHARE MODE' ]
- );
- if ( !$this->mActorId ) {
- throw new CannotCreateActorException(
- "Cannot create actor ID for user_id={$this->getId()} user_name={$this->getName()}"
- );
- }
- }
- $this->invalidateCache();
- $this->setItemLoaded( 'actor' );
- }
- return (int)$this->mActorId;
- }
- /**
- * Get the user's name escaped by underscores.
- * @return string Username escaped by underscores.
- */
- public function getTitleKey() {
- return str_replace( ' ', '_', $this->getName() );
- }
- /**
- * Check if the user has new messages.
- * @return bool True if the user has new messages
- */
- public function getNewtalk() {
- $this->load();
- // Load the newtalk status if it is unloaded (mNewtalk=-1)
- if ( $this->mNewtalk === -1 ) {
- $this->mNewtalk = false; # reset talk page status
- // Check memcached separately for anons, who have no
- // entire User object stored in there.
- if ( !$this->mId ) {
- global $wgDisableAnonTalk;
- if ( $wgDisableAnonTalk ) {
- // Anon newtalk disabled by configuration.
- $this->mNewtalk = false;
- } else {
- $this->mNewtalk = $this->checkNewtalk( 'user_ip', $this->getName() );
- }
- } else {
- $this->mNewtalk = $this->checkNewtalk( 'user_id', $this->mId );
- }
- }
- return (bool)$this->mNewtalk;
- }
- /**
- * Return the data needed to construct links for new talk page message
- * alerts. If there are new messages, this will return an associative array
- * with the following data:
- * wiki: The database name of the wiki
- * link: Root-relative link to the user's talk page
- * rev: The last talk page revision that the user has seen or null. This
- * is useful for building diff links.
- * If there are no new messages, it returns an empty array.
- * @note This function was designed to accomodate multiple talk pages, but
- * currently only returns a single link and revision.
- * @return array
- */
- public function getNewMessageLinks() {
- // Avoid PHP 7.1 warning of passing $this by reference
- $user = $this;
- $talks = [];
- if ( !Hooks::run( 'UserRetrieveNewTalks', [ &$user, &$talks ] ) ) {
- return $talks;
- }
- if ( !$this->getNewtalk() ) {
- return [];
- }
- $utp = $this->getTalkPage();
- $dbr = wfGetDB( DB_REPLICA );
- // Get the "last viewed rev" timestamp from the oldest message notification
- $timestamp = $dbr->selectField( 'user_newtalk',
- 'MIN(user_last_timestamp)',
- $this->isAnon() ? [ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
- __METHOD__ );
- $rev = $timestamp ? Revision::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
- return [
- [
- 'wiki' => WikiMap::getWikiIdFromDbDomain( WikiMap::getCurrentWikiDbDomain() ),
- 'link' => $utp->getLocalURL(),
- 'rev' => $rev
- ]
- ];
- }
- /**
- * Get the revision ID for the last talk page revision viewed by the talk
- * page owner.
- * @return int|null Revision ID or null
- */
- public function getNewMessageRevisionId() {
- $newMessageRevisionId = null;
- $newMessageLinks = $this->getNewMessageLinks();
- // Note: getNewMessageLinks() never returns more than a single link
- // and it is always for the same wiki, but we double-check here in
- // case that changes some time in the future.
- if ( $newMessageLinks && count( $newMessageLinks ) === 1
- && WikiMap::isCurrentWikiId( $newMessageLinks[0]['wiki'] )
- && $newMessageLinks[0]['rev']
- ) {
- /** @var Revision $newMessageRevision */
- $newMessageRevision = $newMessageLinks[0]['rev'];
- $newMessageRevisionId = $newMessageRevision->getId();
- }
- return $newMessageRevisionId;
- }
- /**
- * Internal uncached check for new messages
- *
- * @see getNewtalk()
- * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
- * @param string|int $id User's IP address for anonymous users, User ID otherwise
- * @return bool True if the user has new messages
- */
- protected function checkNewtalk( $field, $id ) {
- $dbr = wfGetDB( DB_REPLICA );
- $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__ );
- return $ok !== false;
- }
- /**
- * Add or update the new messages flag
- * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
- * @param string|int $id User's IP address for anonymous users, User ID otherwise
- * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
- * @return bool True if successful, false otherwise
- */
- protected function updateNewtalk( $field, $id, $curRev = null ) {
- // Get timestamp of the talk page revision prior to the current one
- $prevRev = $curRev ? $curRev->getPrevious() : false;
- $ts = $prevRev ? $prevRev->getTimestamp() : null;
- // Mark the user as having new messages since this revision
- $dbw = wfGetDB( DB_MASTER );
- $dbw->insert( 'user_newtalk',
- [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
- __METHOD__,
- [ 'IGNORE' ] );
- if ( $dbw->affectedRows() ) {
- wfDebug( __METHOD__ . ": set on ($field, $id)\n" );
- return true;
- }
- wfDebug( __METHOD__ . " already set ($field, $id)\n" );
- return false;
- }
- /**
- * Clear the new messages flag for the given user
- * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
- * @param string|int $id User's IP address for anonymous users, User ID otherwise
- * @return bool True if successful, false otherwise
- */
- protected function deleteNewtalk( $field, $id ) {
- $dbw = wfGetDB( DB_MASTER );
- $dbw->delete( 'user_newtalk',
- [ $field => $id ],
- __METHOD__ );
- if ( $dbw->affectedRows() ) {
- wfDebug( __METHOD__ . ": killed on ($field, $id)\n" );
- return true;
- }
- wfDebug( __METHOD__ . ": already gone ($field, $id)\n" );
- return false;
- }
- /**
- * Update the 'You have new messages!' status.
- * @param bool $val Whether the user has new messages
- * @param Revision|null $curRev New, as yet unseen revision of the user talk
- * page. Ignored if null or !$val.
- */
- public function setNewtalk( $val, $curRev = null ) {
- if ( wfReadOnly() ) {
- return;
- }
- $this->load();
- $this->mNewtalk = $val;
- if ( $this->isAnon() ) {
- $field = 'user_ip';
- $id = $this->getName();
- } else {
- $field = 'user_id';
- $id = $this->getId();
- }
- if ( $val ) {
- $changed = $this->updateNewtalk( $field, $id, $curRev );
- } else {
- $changed = $this->deleteNewtalk( $field, $id );
- }
- if ( $changed ) {
- $this->invalidateCache();
- }
- }
- /**
- * Generate a current or new-future timestamp to be stored in the
- * user_touched field when we update things.
- *
- * @return string Timestamp in TS_MW format
- */
- private function newTouchedTimestamp() {
- $time = time();
- if ( $this->mTouched ) {
- $time = max( $time, wfTimestamp( TS_UNIX, $this->mTouched ) + 1 );
- }
- return wfTimestamp( TS_MW, $time );
- }
- /**
- * Clear user data from memcached
- *
- * Use after applying updates to the database; caller's
- * responsibility to update user_touched if appropriate.
- *
- * Called implicitly from invalidateCache() and saveSettings().
- *
- * @param string $mode Use 'refresh' to clear now or 'changed' to clear before DB commit
- */
- public function clearSharedCache( $mode = 'refresh' ) {
- if ( !$this->getId() ) {
- return;
- }
- $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
- $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
- $key = $this->getCacheKey( $cache );
- if ( $mode === 'refresh' ) {
- $cache->delete( $key, 1 ); // low tombstone/"hold-off" TTL
- } else {
- $lb->getConnectionRef( DB_MASTER )->onTransactionPreCommitOrIdle(
- function () use ( $cache, $key ) {
- $cache->delete( $key );
- },
- __METHOD__
- );
- }
- }
- /**
- * Immediately touch the user data cache for this account
- *
- * Calls touch() and removes account data from memcached
- */
- public function invalidateCache() {
- $this->touch();
- $this->clearSharedCache( 'changed' );
- }
- /**
- * Update the "touched" timestamp for the user
- *
- * This is useful on various login/logout events when making sure that
- * a browser or proxy that has multiple tenants does not suffer cache
- * pollution where the new user sees the old users content. The value
- * of getTouched() is checked when determining 304 vs 200 responses.
- * Unlike invalidateCache(), this preserves the User object cache and
- * avoids database writes.
- *
- * @since 1.25
- */
- public function touch() {
- $id = $this->getId();
- if ( $id ) {
- $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
- $key = $cache->makeKey( 'user-quicktouched', 'id', $id );
- $cache->touchCheckKey( $key );
- $this->mQuickTouched = null;
- }
- }
- /**
- * Validate the cache for this account.
- * @param string $timestamp A timestamp in TS_MW format
- * @return bool
- */
- public function validateCache( $timestamp ) {
- return ( $timestamp >= $this->getTouched() );
- }
- /**
- * Get the user touched timestamp
- *
- * Use this value only to validate caches via inequalities
- * such as in the case of HTTP If-Modified-Since response logic
- *
- * @return string TS_MW Timestamp
- */
- public function getTouched() {
- $this->load();
- if ( $this->mId ) {
- if ( $this->mQuickTouched === null ) {
- $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
- $key = $cache->makeKey( 'user-quicktouched', 'id', $this->mId );
- $this->mQuickTouched = wfTimestamp( TS_MW, $cache->getCheckKeyTime( $key ) );
- }
- return max( $this->mTouched, $this->mQuickTouched );
- }
- return $this->mTouched;
- }
- /**
- * Get the user_touched timestamp field (time of last DB updates)
- * @return string TS_MW Timestamp
- * @since 1.26
- */
- public function getDBTouched() {
- $this->load();
- return $this->mTouched;
- }
- /**
- * Set the password and reset the random token.
- * Calls through to authentication plugin if necessary;
- * will have no effect if the auth plugin refuses to
- * pass the change through or if the legal password
- * checks fail.
- *
- * As a special case, setting the password to null
- * wipes it, so the account cannot be logged in until
- * a new password is set, for instance via e-mail.
- *
- * @deprecated since 1.27, use AuthManager instead
- * @param string $str New password to set
- * @throws PasswordError On failure
- * @return bool
- */
- public function setPassword( $str ) {
- wfDeprecated( __METHOD__, '1.27' );
- return $this->setPasswordInternal( $str );
- }
- /**
- * Set the password and reset the random token unconditionally.
- *
- * @deprecated since 1.27, use AuthManager instead
- * @param string|null $str New password to set or null to set an invalid
- * password hash meaning that the user will not be able to log in
- * through the web interface.
- */
- public function setInternalPassword( $str ) {
- wfDeprecated( __METHOD__, '1.27' );
- $this->setPasswordInternal( $str );
- }
- /**
- * Actually set the password and such
- * @since 1.27 cannot set a password for a user not in the database
- * @param string|null $str New password to set or null to set an invalid
- * password hash meaning that the user will not be able to log in
- * through the web interface.
- * @return bool Success
- */
- private function setPasswordInternal( $str ) {
- $manager = AuthManager::singleton();
- // If the user doesn't exist yet, fail
- if ( !$manager->userExists( $this->getName() ) ) {
- throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
- }
- $status = $this->changeAuthenticationData( [
- 'username' => $this->getName(),
- 'password' => $str,
- 'retype' => $str,
- ] );
- if ( !$status->isGood() ) {
- \MediaWiki\Logger\LoggerFactory::getInstance( 'authentication' )
- ->info( __METHOD__ . ': Password change rejected: '
- . $status->getWikiText( null, null, 'en' ) );
- return false;
- }
- $this->setOption( 'watchlisttoken', false );
- SessionManager::singleton()->invalidateSessionsForUser( $this );
- return true;
- }
- /**
- * Changes credentials of the user.
- *
- * This is a convenience wrapper around AuthManager::changeAuthenticationData.
- * Note that this can return a status that isOK() but not isGood() on certain types of failures,
- * e.g. when no provider handled the change.
- *
- * @param array $data A set of authentication data in fieldname => value format. This is the
- * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
- * @return Status
- * @since 1.27
- */
- public function changeAuthenticationData( array $data ) {
- $manager = AuthManager::singleton();
- $reqs = $manager->getAuthenticationRequests( AuthManager::ACTION_CHANGE, $this );
- $reqs = AuthenticationRequest::loadRequestsFromSubmission( $reqs, $data );
- $status = Status::newGood( 'ignored' );
- foreach ( $reqs as $req ) {
- $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
- }
- if ( $status->getValue() === 'ignored' ) {
- $status->warning( 'authenticationdatachange-ignored' );
- }
- if ( $status->isGood() ) {
- foreach ( $reqs as $req ) {
- $manager->changeAuthenticationData( $req );
- }
- }
- return $status;
- }
- /**
- * Get the user's current token.
- * @param bool $forceCreation Force the generation of a new token if the
- * user doesn't have one (default=true for backwards compatibility).
- * @return string|null Token
- */
- public function getToken( $forceCreation = true ) {
- global $wgAuthenticationTokenVersion;
- $this->load();
- if ( !$this->mToken && $forceCreation ) {
- $this->setToken();
- }
- if ( !$this->mToken ) {
- // The user doesn't have a token, return null to indicate that.
- return null;
- }
- if ( $this->mToken === self::INVALID_TOKEN ) {
- // We return a random value here so existing token checks are very
- // likely to fail.
- return MWCryptRand::generateHex( self::TOKEN_LENGTH );
- }
- if ( $wgAuthenticationTokenVersion === null ) {
- // $wgAuthenticationTokenVersion not in use, so return the raw secret
- return $this->mToken;
- }
- // $wgAuthenticationTokenVersion in use, so hmac it.
- $ret = MWCryptHash::hmac( $wgAuthenticationTokenVersion, $this->mToken, false );
- // The raw hash can be overly long. Shorten it up.
- $len = max( 32, self::TOKEN_LENGTH );
- if ( strlen( $ret ) < $len ) {
- // Should never happen, even md5 is 128 bits
- throw new \UnexpectedValueException( 'Hmac returned less than 128 bits' );
- }
- return substr( $ret, -$len );
- }
- /**
- * Set the random token (used for persistent authentication)
- * Called from loadDefaults() among other places.
- *
- * @param string|bool $token If specified, set the token to this value
- */
- public function setToken( $token = false ) {
- $this->load();
- if ( $this->mToken === self::INVALID_TOKEN ) {
- \MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
- ->debug( __METHOD__ . ": Ignoring attempt to set token for system user \"$this\"" );
- } elseif ( !$token ) {
- $this->mToken = MWCryptRand::generateHex( self::TOKEN_LENGTH );
- } else {
- $this->mToken = $token;
- }
- }
- /**
- * Get the user's e-mail address
- * @return string User's email address
- */
- public function getEmail() {
- $this->load();
- Hooks::run( 'UserGetEmail', [ $this, &$this->mEmail ] );
- return $this->mEmail;
- }
- /**
- * Get the timestamp of the user's e-mail authentication
- * @return string TS_MW timestamp
- */
- public function getEmailAuthenticationTimestamp() {
- $this->load();
- Hooks::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated ] );
- return $this->mEmailAuthenticated;
- }
- /**
- * Set the user's e-mail address
- * @param string $str New e-mail address
- */
- public function setEmail( $str ) {
- $this->load();
- if ( $str == $this->mEmail ) {
- return;
- }
- $this->invalidateEmail();
- $this->mEmail = $str;
- Hooks::run( 'UserSetEmail', [ $this, &$this->mEmail ] );
- }
- /**
- * Set the user's e-mail address and a confirmation mail if needed.
- *
- * @since 1.20
- * @param string $str New e-mail address
- * @return Status
- */
- public function setEmailWithConfirmation( $str ) {
- global $wgEnableEmail, $wgEmailAuthentication;
- if ( !$wgEnableEmail ) {
- return Status::newFatal( 'emaildisabled' );
- }
- $oldaddr = $this->getEmail();
- if ( $str === $oldaddr ) {
- return Status::newGood( true );
- }
- $type = $oldaddr != '' ? 'changed' : 'set';
- $notificationResult = null;
- if ( $wgEmailAuthentication && $type === 'changed' ) {
- // Send the user an email notifying the user of the change in registered
- // email address on their previous email address
- $change = $str != '' ? 'changed' : 'removed';
- $notificationResult = $this->sendMail(
- wfMessage( 'notificationemail_subject_' . $change )->text(),
- wfMessage( 'notificationemail_body_' . $change,
- $this->getRequest()->getIP(),
- $this->getName(),
- $str )->text()
- );
- }
- $this->setEmail( $str );
- if ( $str !== '' && $wgEmailAuthentication ) {
- // Send a confirmation request to the new address if needed
- $result = $this->sendConfirmationMail( $type );
- if ( $notificationResult !== null ) {
- $result->merge( $notificationResult );
- }
- if ( $result->isGood() ) {
- // Say to the caller that a confirmation and notification mail has been sent
- $result->value = 'eauth';
- }
- } else {
- $result = Status::newGood( true );
- }
- return $result;
- }
- /**
- * Get the user's real name
- * @return string User's real name
- */
- public function getRealName() {
- if ( !$this->isItemLoaded( 'realname' ) ) {
- $this->load();
- }
- return $this->mRealName;
- }
- /**
- * Set the user's real name
- * @param string $str New real name
- */
- public function setRealName( $str ) {
- $this->load();
- $this->mRealName = $str;
- }
- /**
- * Get the user's current setting for a given option.
- *
- * @param string $oname The option to check
- * @param string|array|null $defaultOverride A default value returned if the option does not exist
- * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
- * @return string|array|int|null User's current value for the option
- * @see getBoolOption()
- * @see getIntOption()
- */
- public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
- global $wgHiddenPrefs;
- $this->loadOptions();
- # We want 'disabled' preferences to always behave as the default value for
- # users, even if they have set the option explicitly in their settings (ie they
- # set it, and then it was disabled removing their ability to change it). But
- # we don't want to erase the preferences in the database in case the preference
- # is re-enabled again. So don't touch $mOptions, just override the returned value
- if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
- return self::getDefaultOption( $oname );
- }
- if ( array_key_exists( $oname, $this->mOptions ) ) {
- return $this->mOptions[$oname];
- }
- return $defaultOverride;
- }
- /**
- * Get all user's options
- *
- * @param int $flags Bitwise combination of:
- * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
- * to the default value. (Since 1.25)
- * @return array
- */
- public function getOptions( $flags = 0 ) {
- global $wgHiddenPrefs;
- $this->loadOptions();
- $options = $this->mOptions;
- # We want 'disabled' preferences to always behave as the default value for
- # users, even if they have set the option explicitly in their settings (ie they
- # set it, and then it was disabled removing their ability to change it). But
- # we don't want to erase the preferences in the database in case the preference
- # is re-enabled again. So don't touch $mOptions, just override the returned value
- foreach ( $wgHiddenPrefs as $pref ) {
- $default = self::getDefaultOption( $pref );
- if ( $default !== null ) {
- $options[$pref] = $default;
- }
- }
- if ( $flags & self::GETOPTIONS_EXCLUDE_DEFAULTS ) {
- $options = array_diff_assoc( $options, self::getDefaultOptions() );
- }
- return $options;
- }
- /**
- * Get the user's current setting for a given option, as a boolean value.
- *
- * @param string $oname The option to check
- * @return bool User's current value for the option
- * @see getOption()
- */
- public function getBoolOption( $oname ) {
- return (bool)$this->getOption( $oname );
- }
- /**
- * Get the user's current setting for a given option, as an integer value.
- *
- * @param string $oname The option to check
- * @param int $defaultOverride A default value returned if the option does not exist
- * @return int User's current value for the option
- * @see getOption()
- */
- public function getIntOption( $oname, $defaultOverride = 0 ) {
- $val = $this->getOption( $oname );
- if ( $val == '' ) {
- $val = $defaultOverride;
- }
- return intval( $val );
- }
- /**
- * Set the given option for a user.
- *
- * You need to call saveSettings() to actually write to the database.
- *
- * @param string $oname The option to set
- * @param mixed $val New value to set
- */
- public function setOption( $oname, $val ) {
- $this->loadOptions();
- // Explicitly NULL values should refer to defaults
- if ( is_null( $val ) ) {
- $val = self::getDefaultOption( $oname );
- }
- $this->mOptions[$oname] = $val;
- }
- /**
- * Get a token stored in the preferences (like the watchlist one),
- * resetting it if it's empty (and saving changes).
- *
- * @param string $oname The option name to retrieve the token from
- * @return string|bool User's current value for the option, or false if this option is disabled.
- * @see resetTokenFromOption()
- * @see getOption()
- * @deprecated since 1.26 Applications should use the OAuth extension
- */
- public function getTokenFromOption( $oname ) {
- global $wgHiddenPrefs;
- $id = $this->getId();
- if ( !$id || in_array( $oname, $wgHiddenPrefs ) ) {
- return false;
- }
- $token = $this->getOption( $oname );
- if ( !$token ) {
- // Default to a value based on the user token to avoid space
- // wasted on storing tokens for all users. When this option
- // is set manually by the user, only then is it stored.
- $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
- }
- return $token;
- }
- /**
- * Reset a token stored in the preferences (like the watchlist one).
- * *Does not* save user's preferences (similarly to setOption()).
- *
- * @param string $oname The option name to reset the token in
- * @return string|bool New token value, or false if this option is disabled.
- * @see getTokenFromOption()
- * @see setOption()
- */
- public function resetTokenFromOption( $oname ) {
- global $wgHiddenPrefs;
- if ( in_array( $oname, $wgHiddenPrefs ) ) {
- return false;
- }
- $token = MWCryptRand::generateHex( 40 );
- $this->setOption( $oname, $token );
- return $token;
- }
- /**
- * Return a list of the types of user options currently returned by
- * User::getOptionKinds().
- *
- * Currently, the option kinds are:
- * - 'registered' - preferences which are registered in core MediaWiki or
- * by extensions using the UserGetDefaultOptions hook.
- * - 'registered-multiselect' - as above, using the 'multiselect' type.
- * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
- * - 'userjs' - preferences with names starting with 'userjs-', intended to
- * be used by user scripts.
- * - 'special' - "preferences" that are not accessible via User::getOptions
- * or User::setOptions.
- * - 'unused' - preferences about which MediaWiki doesn't know anything.
- * These are usually legacy options, removed in newer versions.
- *
- * The API (and possibly others) use this function to determine the possible
- * option types for validation purposes, so make sure to update this when a
- * new option kind is added.
- *
- * @see User::getOptionKinds
- * @return array Option kinds
- */
- public static function listOptionKinds() {
- return [
- 'registered',
- 'registered-multiselect',
- 'registered-checkmatrix',
- 'userjs',
- 'special',
- 'unused'
- ];
- }
- /**
- * Return an associative array mapping preferences keys to the kind of a preference they're
- * used for. Different kinds are handled differently when setting or reading preferences.
- *
- * See User::listOptionKinds for the list of valid option types that can be provided.
- *
- * @see User::listOptionKinds
- * @param IContextSource $context
- * @param array|null $options Assoc. array with options keys to check as keys.
- * Defaults to $this->mOptions.
- * @return array The key => kind mapping data
- */
- public function getOptionKinds( IContextSource $context, $options = null ) {
- $this->loadOptions();
- if ( $options === null ) {
- $options = $this->mOptions;
- }
- $preferencesFactory = MediaWikiServices::getInstance()->getPreferencesFactory();
- $prefs = $preferencesFactory->getFormDescriptor( $this, $context );
- $mapping = [];
- // Pull out the "special" options, so they don't get converted as
- // multiselect or checkmatrix.
- $specialOptions = array_fill_keys( $preferencesFactory->getSaveBlacklist(), true );
- foreach ( $specialOptions as $name => $value ) {
- unset( $prefs[$name] );
- }
- // Multiselect and checkmatrix options are stored in the database with
- // one key per option, each having a boolean value. Extract those keys.
- $multiselectOptions = [];
- foreach ( $prefs as $name => $info ) {
- if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
- ( isset( $info['class'] ) && $info['class'] == HTMLMultiSelectField::class ) ) {
- $opts = HTMLFormField::flattenOptions( $info['options'] );
- $prefix = $info['prefix'] ?? $name;
- foreach ( $opts as $value ) {
- $multiselectOptions["$prefix$value"] = true;
- }
- unset( $prefs[$name] );
- }
- }
- $checkmatrixOptions = [];
- foreach ( $prefs as $name => $info ) {
- if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
- ( isset( $info['class'] ) && $info['class'] == HTMLCheckMatrix::class ) ) {
- $columns = HTMLFormField::flattenOptions( $info['columns'] );
- $rows = HTMLFormField::flattenOptions( $info['rows'] );
- $prefix = $info['prefix'] ?? $name;
- foreach ( $columns as $column ) {
- foreach ( $rows as $row ) {
- $checkmatrixOptions["$prefix$column-$row"] = true;
- }
- }
- unset( $prefs[$name] );
- }
- }
- // $value is ignored
- foreach ( $options as $key => $value ) {
- if ( isset( $prefs[$key] ) ) {
- $mapping[$key] = 'registered';
- } elseif ( isset( $multiselectOptions[$key] ) ) {
- $mapping[$key] = 'registered-multiselect';
- } elseif ( isset( $checkmatrixOptions[$key] ) ) {
- $mapping[$key] = 'registered-checkmatrix';
- } elseif ( isset( $specialOptions[$key] ) ) {
- $mapping[$key] = 'special';
- } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
- $mapping[$key] = 'userjs';
- } else {
- $mapping[$key] = 'unused';
- }
- }
- return $mapping;
- }
- /**
- * Reset certain (or all) options to the site defaults
- *
- * The optional parameter determines which kinds of preferences will be reset.
- * Supported values are everything that can be reported by getOptionKinds()
- * and 'all', which forces a reset of *all* preferences and overrides everything else.
- *
- * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
- * [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ]
- * for backwards-compatibility.
- * @param IContextSource|null $context Context source used when $resetKinds
- * does not contain 'all', passed to getOptionKinds().
- * Defaults to RequestContext::getMain() when null.
- */
- public function resetOptions(
- $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
- IContextSource $context = null
- ) {
- $this->load();
- $defaultOptions = self::getDefaultOptions();
- if ( !is_array( $resetKinds ) ) {
- $resetKinds = [ $resetKinds ];
- }
- if ( in_array( 'all', $resetKinds ) ) {
- $newOptions = $defaultOptions;
- } else {
- if ( $context === null ) {
- $context = RequestContext::getMain();
- }
- $optionKinds = $this->getOptionKinds( $context );
- $resetKinds = array_intersect( $resetKinds, self::listOptionKinds() );
- $newOptions = [];
- // Use default values for the options that should be deleted, and
- // copy old values for the ones that shouldn't.
- foreach ( $this->mOptions as $key => $value ) {
- if ( in_array( $optionKinds[$key], $resetKinds ) ) {
- if ( array_key_exists( $key, $defaultOptions ) ) {
- $newOptions[$key] = $defaultOptions[$key];
- }
- } else {
- $newOptions[$key] = $value;
- }
- }
- }
- Hooks::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions, $resetKinds ] );
- $this->mOptions = $newOptions;
- $this->mOptionsLoaded = true;
- }
- /**
- * Get the user's preferred date format.
- * @return string User's preferred date format
- */
- public function getDatePreference() {
- // Important migration for old data rows
- if ( is_null( $this->mDatePreference ) ) {
- global $wgLang;
- $value = $this->getOption( 'date' );
- $map = $wgLang->getDatePreferenceMigrationMap();
- if ( isset( $map[$value] ) ) {
- $value = $map[$value];
- }
- $this->mDatePreference = $value;
- }
- return $this->mDatePreference;
- }
- /**
- * Determine based on the wiki configuration and the user's options,
- * whether this user must be over HTTPS no matter what.
- *
- * @return bool
- */
- public function requiresHTTPS() {
- global $wgSecureLogin;
- if ( !$wgSecureLogin ) {
- return false;
- }
- $https = $this->getBoolOption( 'prefershttps' );
- Hooks::run( 'UserRequiresHTTPS', [ $this, &$https ] );
- if ( $https ) {
- $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
- }
- return $https;
- }
- /**
- * Get the user preferred stub threshold
- *
- * @return int
- */
- public function getStubThreshold() {
- global $wgMaxArticleSize; # Maximum article size, in Kb
- $threshold = $this->getIntOption( 'stubthreshold' );
- if ( $threshold > $wgMaxArticleSize * 1024 ) {
- // If they have set an impossible value, disable the preference
- // so we can use the parser cache again.
- $threshold = 0;
- }
- return $threshold;
- }
- /**
- * Get the permissions this user has.
- * @return string[] permission names
- *
- * @deprecated since 1.34, use MediaWikiServices::getInstance()->getPermissionManager()
- * ->getUserPermissions(..) instead
- *
- */
- public function getRights() {
- return MediaWikiServices::getInstance()->getPermissionManager()->getUserPermissions( $this );
- }
- /**
- * Get the list of explicit group memberships this user has.
- * The implicit * and user groups are not included.
- *
- * @return string[] Array of internal group names (sorted since 1.33)
- */
- public function getGroups() {
- $this->load();
- $this->loadGroups();
- return array_keys( $this->mGroupMemberships );
- }
- /**
- * Get the list of explicit group memberships this user has, stored as
- * UserGroupMembership objects. Implicit groups are not included.
- *
- * @return UserGroupMembership[] Associative array of (group name => UserGroupMembership object)
- * @since 1.29
- */
- public function getGroupMemberships() {
- $this->load();
- $this->loadGroups();
- return $this->mGroupMemberships;
- }
- /**
- * Get the list of implicit group memberships this user has.
- * This includes all explicit groups, plus 'user' if logged in,
- * '*' for all accounts, and autopromoted groups
- * @param bool $recache Whether to avoid the cache
- * @return array Array of String internal group names
- */
- public function getEffectiveGroups( $recache = false ) {
- if ( $recache || is_null( $this->mEffectiveGroups ) ) {
- $this->mEffectiveGroups = array_unique( array_merge(
- $this->getGroups(), // explicit groups
- $this->getAutomaticGroups( $recache ) // implicit groups
- ) );
- // Avoid PHP 7.1 warning of passing $this by reference
- $user = $this;
- // Hook for additional groups
- Hooks::run( 'UserEffectiveGroups', [ &$user, &$this->mEffectiveGroups ] );
- // Force reindexation of groups when a hook has unset one of them
- $this->mEffectiveGroups = array_values( array_unique( $this->mEffectiveGroups ) );
- }
- return $this->mEffectiveGroups;
- }
- /**
- * Get the list of implicit group memberships this user has.
- * This includes 'user' if logged in, '*' for all accounts,
- * and autopromoted groups
- * @param bool $recache Whether to avoid the cache
- * @return array Array of String internal group names
- */
- public function getAutomaticGroups( $recache = false ) {
- if ( $recache || is_null( $this->mImplicitGroups ) ) {
- $this->mImplicitGroups = [ '*' ];
- if ( $this->getId() ) {
- $this->mImplicitGroups[] = 'user';
- $this->mImplicitGroups = array_unique( array_merge(
- $this->mImplicitGroups,
- Autopromote::getAutopromoteGroups( $this )
- ) );
- }
- if ( $recache ) {
- // Assure data consistency with rights/groups,
- // as getEffectiveGroups() depends on this function
- $this->mEffectiveGroups = null;
- }
- }
- return $this->mImplicitGroups;
- }
- /**
- * Returns the groups the user has belonged to.
- *
- * The user may still belong to the returned groups. Compare with getGroups().
- *
- * The function will not return groups the user had belonged to before MW 1.17
- *
- * @return array Names of the groups the user has belonged to.
- */
- public function getFormerGroups() {
- $this->load();
- if ( is_null( $this->mFormerGroups ) ) {
- $db = ( $this->queryFlagsUsed & self::READ_LATEST )
- ? wfGetDB( DB_MASTER )
- : wfGetDB( DB_REPLICA );
- $res = $db->select( 'user_former_groups',
- [ 'ufg_group' ],
- [ 'ufg_user' => $this->mId ],
- __METHOD__ );
- $this->mFormerGroups = [];
- foreach ( $res as $row ) {
- $this->mFormerGroups[] = $row->ufg_group;
- }
- }
- return $this->mFormerGroups;
- }
- /**
- * Get the user's edit count.
- * @return int|null Null for anonymous users
- */
- public function getEditCount() {
- if ( !$this->getId() ) {
- return null;
- }
- if ( $this->mEditCount === null ) {
- /* Populate the count, if it has not been populated yet */
- $dbr = wfGetDB( DB_REPLICA );
- // check if the user_editcount field has been initialized
- $count = $dbr->selectField(
- 'user', 'user_editcount',
- [ 'user_id' => $this->mId ],
- __METHOD__
- );
- if ( $count === null ) {
- // it has not been initialized. do so.
- $count = $this->initEditCountInternal( $dbr );
- }
- $this->mEditCount = $count;
- }
- return (int)$this->mEditCount;
- }
- /**
- * Add the user to the given group. This takes immediate effect.
- * If the user is already in the group, the expiry time will be updated to the new
- * expiry time. (If $expiry is omitted or null, the membership will be altered to
- * never expire.)
- *
- * @param string $group Name of the group to add
- * @param string|null $expiry Optional expiry timestamp in any format acceptable to
- * wfTimestamp(), or null if the group assignment should not expire
- * @return bool
- */
- public function addGroup( $group, $expiry = null ) {
- $this->load();
- $this->loadGroups();
- if ( $expiry ) {
- $expiry = wfTimestamp( TS_MW, $expiry );
- }
- if ( !Hooks::run( 'UserAddGroup', [ $this, &$group, &$expiry ] ) ) {
- return false;
- }
- // create the new UserGroupMembership and put it in the DB
- $ugm = new UserGroupMembership( $this->mId, $group, $expiry );
- if ( !$ugm->insert( true ) ) {
- return false;
- }
- $this->mGroupMemberships[$group] = $ugm;
- // Refresh the groups caches, and clear the rights cache so it will be
- // refreshed on the next call to $this->getRights().
- $this->getEffectiveGroups( true );
- MediaWikiServices::getInstance()->getPermissionManager()->invalidateUsersRightsCache( $this );
- $this->invalidateCache();
- return true;
- }
- /**
- * Remove the user from the given group.
- * This takes immediate effect.
- * @param string $group Name of the group to remove
- * @return bool
- */
- public function removeGroup( $group ) {
- $this->load();
- if ( !Hooks::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
- return false;
- }
- $ugm = UserGroupMembership::getMembership( $this->mId, $group );
- // delete the membership entry
- if ( !$ugm || !$ugm->delete() ) {
- return false;
- }
- $this->loadGroups();
- unset( $this->mGroupMemberships[$group] );
- // Refresh the groups caches, and clear the rights cache so it will be
- // refreshed on the next call to $this->getRights().
- $this->getEffectiveGroups( true );
- MediaWikiServices::getInstance()->getPermissionManager()->invalidateUsersRightsCache( $this );
- $this->invalidateCache();
- return true;
- }
- /**
- * Alias of isLoggedIn() with a name that describes its actual functionality. UserIdentity has
- * only this new name and not the old isLoggedIn() variant.
- *
- * @return bool True if user is registered on this wiki, i.e., has a user ID. False if user is
- * anonymous or has no local account (which can happen when importing). This is equivalent to
- * getId() != 0 and is provided for code readability.
- * @since 1.34
- */
- public function isRegistered() {
- return $this->getId() != 0;
- }
- /**
- * Get whether the user is logged in
- * @return bool
- */
- public function isLoggedIn() {
- return $this->isRegistered();
- }
- /**
- * Get whether the user is anonymous
- * @return bool
- */
- public function isAnon() {
- return !$this->isRegistered();
- }
- /**
- * @return bool Whether this user is flagged as being a bot role account
- * @since 1.28
- */
- public function isBot() {
- if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
- return true;
- }
- $isBot = false;
- Hooks::run( "UserIsBot", [ $this, &$isBot ] );
- return $isBot;
- }
- /**
- * Check if user is allowed to access a feature / make an action
- *
- * @deprecated since 1.34, use MediaWikiServices::getInstance()
- * ->getPermissionManager()->userHasAnyRights(...) instead
- *
- * @param string ...$permissions Permissions to test
- * @return bool True if user is allowed to perform *any* of the given actions
- */
- public function isAllowedAny( ...$permissions ) {
- return MediaWikiServices::getInstance()
- ->getPermissionManager()
- ->userHasAnyRight( $this, ...$permissions );
- }
- /**
- * @deprecated since 1.34, use MediaWikiServices::getInstance()
- * ->getPermissionManager()->userHasAllRights(...) instead
- * @param string ...$permissions Permissions to test
- * @return bool True if the user is allowed to perform *all* of the given actions
- */
- public function isAllowedAll( ...$permissions ) {
- return MediaWikiServices::getInstance()
- ->getPermissionManager()
- ->userHasAllRights( $this, ...$permissions );
- }
- /**
- * Internal mechanics of testing a permission
- *
- * @deprecated since 1.34, use MediaWikiServices::getInstance()
- * ->getPermissionManager()->userHasRight(...) instead
- *
- * @param string $action
- *
- * @return bool
- */
- public function isAllowed( $action = '' ) {
- return MediaWikiServices::getInstance()->getPermissionManager()
- ->userHasRight( $this, $action );
- }
- /**
- * Check whether to enable recent changes patrol features for this user
- * @return bool True or false
- */
- public function useRCPatrol() {
- global $wgUseRCPatrol;
- return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
- }
- /**
- * Check whether to enable new pages patrol features for this user
- * @return bool True or false
- */
- public function useNPPatrol() {
- global $wgUseRCPatrol, $wgUseNPPatrol;
- return (
- ( $wgUseRCPatrol || $wgUseNPPatrol )
- && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
- );
- }
- /**
- * Check whether to enable new files patrol features for this user
- * @return bool True or false
- */
- public function useFilePatrol() {
- global $wgUseRCPatrol, $wgUseFilePatrol;
- return (
- ( $wgUseRCPatrol || $wgUseFilePatrol )
- && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
- );
- }
- /**
- * Get the WebRequest object to use with this object
- *
- * @return WebRequest
- */
- public function getRequest() {
- if ( $this->mRequest ) {
- return $this->mRequest;
- }
- global $wgRequest;
- return $wgRequest;
- }
- /**
- * Check the watched status of an article.
- * @since 1.22 $checkRights parameter added
- * @param Title $title Title of the article to look at
- * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
- * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
- * @return bool
- */
- public function isWatched( $title, $checkRights = self::CHECK_USER_RIGHTS ) {
- if ( $title->isWatchable() && ( !$checkRights || $this->isAllowed( 'viewmywatchlist' ) ) ) {
- return MediaWikiServices::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
- }
- return false;
- }
- /**
- * Watch an article.
- * @since 1.22 $checkRights parameter added
- * @param Title $title Title of the article to look at
- * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
- * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
- */
- public function addWatch( $title, $checkRights = self::CHECK_USER_RIGHTS ) {
- if ( !$checkRights || $this->isAllowed( 'editmywatchlist' ) ) {
- MediaWikiServices::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
- $this,
- [ $title->getSubjectPage(), $title->getTalkPage() ]
- );
- }
- $this->invalidateCache();
- }
- /**
- * Stop watching an article.
- * @since 1.22 $checkRights parameter added
- * @param Title $title Title of the article to look at
- * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
- * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
- */
- public function removeWatch( $title, $checkRights = self::CHECK_USER_RIGHTS ) {
- if ( !$checkRights || $this->isAllowed( 'editmywatchlist' ) ) {
- $store = MediaWikiServices::getInstance()->getWatchedItemStore();
- $store->removeWatch( $this, $title->getSubjectPage() );
- $store->removeWatch( $this, $title->getTalkPage() );
- }
- $this->invalidateCache();
- }
- /**
- * Clear the user's notification timestamp for the given title.
- * If e-notif e-mails are on, they will receive notification mails on
- * the next change of the page if it's watched etc.
- * @note If the user doesn't have 'editmywatchlist', this will do nothing.
- * @param Title &$title Title of the article to look at
- * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
- */
- public function clearNotification( &$title, $oldid = 0 ) {
- global $wgUseEnotif, $wgShowUpdatedMarker;
- // Do nothing if the database is locked to writes
- if ( wfReadOnly() ) {
- return;
- }
- // Do nothing if not allowed to edit the watchlist
- if ( !$this->isAllowed( 'editmywatchlist' ) ) {
- return;
- }
- // If we're working on user's talk page, we should update the talk page message indicator
- if ( $title->getNamespace() == NS_USER_TALK && $title->getText() == $this->getName() ) {
- // Avoid PHP 7.1 warning of passing $this by reference
- $user = $this;
- if ( !Hooks::run( 'UserClearNewTalkNotification', [ &$user, $oldid ] ) ) {
- return;
- }
- // Try to update the DB post-send and only if needed...
- DeferredUpdates::addCallableUpdate( function () use ( $title, $oldid ) {
- if ( !$this->getNewtalk() ) {
- return; // no notifications to clear
- }
- // Delete the last notifications (they stack up)
- $this->setNewtalk( false );
- // If there is a new, unseen, revision, use its timestamp
- if ( $oldid ) {
- $rl = MediaWikiServices::getInstance()->getRevisionLookup();
- $oldRev = $rl->getRevisionById( $oldid, Title::READ_LATEST );
- if ( $oldRev ) {
- $newRev = $rl->getNextRevision( $oldRev );
- if ( $newRev ) {
- // TODO: actually no need to wrap in a revision,
- // setNewtalk really only needs a RevRecord
- $this->setNewtalk( true, new Revision( $newRev ) );
- }
- }
- }
- } );
- }
- if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
- return;
- }
- if ( $this->isAnon() ) {
- // Nothing else to do...
- return;
- }
- // Only update the timestamp if the page is being watched.
- // The query to find out if it is watched is cached both in memcached and per-invocation,
- // and when it does have to be executed, it can be on a replica DB
- // If this is the user's newtalk page, we always update the timestamp
- $force = '';
- if ( $title->getNamespace() == NS_USER_TALK && $title->getText() == $this->getName() ) {
- $force = 'force';
- }
- MediaWikiServices::getInstance()->getWatchedItemStore()
- ->resetNotificationTimestamp( $this, $title, $force, $oldid );
- }
- /**
- * Resets all of the given user's page-change notification timestamps.
- * If e-notif e-mails are on, they will receive notification mails on
- * the next change of any watched page.
- * @note If the user doesn't have 'editmywatchlist', this will do nothing.
- */
- public function clearAllNotifications() {
- global $wgUseEnotif, $wgShowUpdatedMarker;
- // Do nothing if not allowed to edit the watchlist
- if ( wfReadOnly() || !$this->isAllowed( 'editmywatchlist' ) ) {
- return;
- }
- if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
- $this->setNewtalk( false );
- return;
- }
- $id = $this->getId();
- if ( !$id ) {
- return;
- }
- $watchedItemStore = MediaWikiServices::getInstance()->getWatchedItemStore();
- $watchedItemStore->resetAllNotificationTimestampsForUser( $this );
- // We also need to clear here the "you have new message" notification for the own
- // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
- }
- /**
- * Compute experienced level based on edit count and registration date.
- *
- * @return string 'newcomer', 'learner', or 'experienced'
- */
- public function getExperienceLevel() {
- global $wgLearnerEdits,
- $wgExperiencedUserEdits,
- $wgLearnerMemberSince,
- $wgExperiencedUserMemberSince;
- if ( $this->isAnon() ) {
- return false;
- }
- $editCount = $this->getEditCount();
- $registration = $this->getRegistration();
- $now = time();
- $learnerRegistration = wfTimestamp( TS_MW, $now - $wgLearnerMemberSince * 86400 );
- $experiencedRegistration = wfTimestamp( TS_MW, $now - $wgExperiencedUserMemberSince * 86400 );
- if ( $editCount < $wgLearnerEdits ||
- $registration > $learnerRegistration ) {
- return 'newcomer';
- }
- if ( $editCount > $wgExperiencedUserEdits &&
- $registration <= $experiencedRegistration
- ) {
- return 'experienced';
- }
- return 'learner';
- }
- /**
- * Persist this user's session (e.g. set cookies)
- *
- * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
- * is passed.
- * @param bool|null $secure Whether to force secure/insecure cookies or use default
- * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
- */
- public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
- $this->load();
- if ( $this->mId == 0 ) {
- return;
- }
- $session = $this->getRequest()->getSession();
- if ( $request && $session->getRequest() !== $request ) {
- $session = $session->sessionWithRequest( $request );
- }
- $delay = $session->delaySave();
- if ( !$session->getUser()->equals( $this ) ) {
- if ( !$session->canSetUser() ) {
- \MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
- ->warning( __METHOD__ .
- ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
- );
- return;
- }
- $session->setUser( $this );
- }
- $session->setRememberUser( $rememberMe );
- if ( $secure !== null ) {
- $session->setForceHTTPS( $secure );
- }
- $session->persist();
- ScopedCallback::consume( $delay );
- }
- /**
- * Log this user out.
- */
- public function logout() {
- // Avoid PHP 7.1 warning of passing $this by reference
- $user = $this;
- if ( Hooks::run( 'UserLogout', [ &$user ] ) ) {
- $this->doLogout();
- }
- }
- /**
- * Clear the user's session, and reset the instance cache.
- * @see logout()
- */
- public function doLogout() {
- $session = $this->getRequest()->getSession();
- if ( !$session->canSetUser() ) {
- \MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
- ->warning( __METHOD__ . ": Cannot log out of an immutable session" );
- $error = 'immutable';
- } elseif ( !$session->getUser()->equals( $this ) ) {
- \MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
- ->warning( __METHOD__ .
- ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
- );
- // But we still may as well make this user object anon
- $this->clearInstanceCache( 'defaults' );
- $error = 'wronguser';
- } else {
- $this->clearInstanceCache( 'defaults' );
- $delay = $session->delaySave();
- $session->unpersist(); // Clear cookies (T127436)
- $session->setLoggedOutTimestamp( time() );
- $session->setUser( new User );
- $session->set( 'wsUserID', 0 ); // Other code expects this
- $session->resetAllTokens();
- ScopedCallback::consume( $delay );
- $error = false;
- }
- \MediaWiki\Logger\LoggerFactory::getInstance( 'authevents' )->info( 'Logout', [
- 'event' => 'logout',
- 'successful' => $error === false,
- 'status' => $error ?: 'success',
- ] );
- }
- /**
- * Save this user's settings into the database.
- * @todo Only rarely do all these fields need to be set!
- */
- public function saveSettings() {
- if ( wfReadOnly() ) {
- // @TODO: caller should deal with this instead!
- // This should really just be an exception.
- MWExceptionHandler::logException( new DBExpectedError(
- null,
- "Could not update user with ID '{$this->mId}'; DB is read-only."
- ) );
- return;
- }
- $this->load();
- if ( $this->mId == 0 ) {
- return; // anon
- }
- // Get a new user_touched that is higher than the old one.
- // This will be used for a CAS check as a last-resort safety
- // check against race conditions and replica DB lag.
- $newTouched = $this->newTouchedTimestamp();
- $dbw = wfGetDB( DB_MASTER );
- $dbw->doAtomicSection( __METHOD__, function ( IDatabase $dbw, $fname ) use ( $newTouched ) {
- $dbw->update( 'user',
- [ /* SET */
- 'user_name' => $this->mName,
- 'user_real_name' => $this->mRealName,
- 'user_email' => $this->mEmail,
- 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
- 'user_touched' => $dbw->timestamp( $newTouched ),
- 'user_token' => strval( $this->mToken ),
- 'user_email_token' => $this->mEmailToken,
- 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires ),
- ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
- 'user_id' => $this->mId,
- ] ), $fname
- );
- if ( !$dbw->affectedRows() ) {
- // Maybe the problem was a missed cache update; clear it to be safe
- $this->clearSharedCache( 'refresh' );
- // User was changed in the meantime or loaded with stale data
- $from = ( $this->queryFlagsUsed & self::READ_LATEST ) ? 'master' : 'replica';
- LoggerFactory::getInstance( 'preferences' )->warning(
- "CAS update failed on user_touched for user ID '{user_id}' ({db_flag} read)",
- [ 'user_id' => $this->mId, 'db_flag' => $from ]
- );
- throw new MWException( "CAS update failed on user_touched. " .
- "The version of the user to be saved is older than the current version."
- );
- }
- $dbw->update(
- 'actor',
- [ 'actor_name' => $this->mName ],
- [ 'actor_user' => $this->mId ],
- $fname
- );
- } );
- $this->mTouched = $newTouched;
- $this->saveOptions();
- Hooks::run( 'UserSaveSettings', [ $this ] );
- $this->clearSharedCache( 'changed' );
- $this->getUserPage()->purgeSquid();
- }
- /**
- * If only this user's username is known, and it exists, return the user ID.
- *
- * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
- * @return int
- */
- public function idForName( $flags = 0 ) {
- $s = trim( $this->getName() );
- if ( $s === '' ) {
- return 0;
- }
- $db = ( ( $flags & self::READ_LATEST ) == self::READ_LATEST )
- ? wfGetDB( DB_MASTER )
- : wfGetDB( DB_REPLICA );
- $options = ( ( $flags & self::READ_LOCKING ) == self::READ_LOCKING )
- ? [ 'LOCK IN SHARE MODE' ]
- : [];
- $id = $db->selectField( 'user',
- 'user_id', [ 'user_name' => $s ], __METHOD__, $options );
- return (int)$id;
- }
- /**
- * Add a user to the database, return the user object
- *
- * @param string $name Username to add
- * @param array $params Array of Strings Non-default parameters to save to
- * the database as user_* fields:
- * - email: The user's email address.
- * - email_authenticated: The email authentication timestamp.
- * - real_name: The user's real name.
- * - options: An associative array of non-default options.
- * - token: Random authentication token. Do not set.
- * - registration: Registration timestamp. Do not set.
- *
- * @return User|null User object, or null if the username already exists.
- */
- public static function createNew( $name, $params = [] ) {
- foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
- if ( isset( $params[$field] ) ) {
- wfDeprecated( __METHOD__ . " with param '$field'", '1.27' );
- unset( $params[$field] );
- }
- }
- $user = new User;
- $user->load();
- $user->setToken(); // init token
- if ( isset( $params['options'] ) ) {
- $user->mOptions = $params['options'] + (array)$user->mOptions;
- unset( $params['options'] );
- }
- $dbw = wfGetDB( DB_MASTER );
- $noPass = PasswordFactory::newInvalidPassword()->toString();
- $fields = [
- 'user_name' => $name,
- 'user_password' => $noPass,
- 'user_newpassword' => $noPass,
- 'user_email' => $user->mEmail,
- 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated ),
- 'user_real_name' => $user->mRealName,
- 'user_token' => strval( $user->mToken ),
- 'user_registration' => $dbw->timestamp( $user->mRegistration ),
- 'user_editcount' => 0,
- 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
- ];
- foreach ( $params as $name => $value ) {
- $fields["user_$name"] = $value;
- }
- return $dbw->doAtomicSection( __METHOD__, function ( IDatabase $dbw, $fname ) use ( $fields ) {
- $dbw->insert( 'user', $fields, $fname, [ 'IGNORE' ] );
- if ( $dbw->affectedRows() ) {
- $newUser = self::newFromId( $dbw->insertId() );
- $newUser->mName = $fields['user_name'];
- $newUser->updateActorId( $dbw );
- // Load the user from master to avoid replica lag
- $newUser->load( self::READ_LATEST );
- } else {
- $newUser = null;
- }
- return $newUser;
- } );
- }
- /**
- * Add this existing user object to the database. If the user already
- * exists, a fatal status object is returned, and the user object is
- * initialised with the data from the database.
- *
- * Previously, this function generated a DB error due to a key conflict
- * if the user already existed. Many extension callers use this function
- * in code along the lines of:
- *
- * $user = User::newFromName( $name );
- * if ( !$user->isLoggedIn() ) {
- * $user->addToDatabase();
- * }
- * // do something with $user...
- *
- * However, this was vulnerable to a race condition (T18020). By
- * initialising the user object if the user exists, we aim to support this
- * calling sequence as far as possible.
- *
- * Note that if the user exists, this function will acquire a write lock,
- * so it is still advisable to make the call conditional on isLoggedIn(),
- * and to commit the transaction after calling.
- *
- * @throws MWException
- * @return Status
- */
- public function addToDatabase() {
- $this->load();
- if ( !$this->mToken ) {
- $this->setToken(); // init token
- }
- if ( !is_string( $this->mName ) ) {
- throw new RuntimeException( "User name field is not set." );
- }
- $this->mTouched = $this->newTouchedTimestamp();
- $dbw = wfGetDB( DB_MASTER );
- $status = $dbw->doAtomicSection( __METHOD__, function ( IDatabase $dbw, $fname ) {
- $noPass = PasswordFactory::newInvalidPassword()->toString();
- $dbw->insert( 'user',
- [
- 'user_name' => $this->mName,
- 'user_password' => $noPass,
- 'user_newpassword' => $noPass,
- 'user_email' => $this->mEmail,
- 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
- 'user_real_name' => $this->mRealName,
- 'user_token' => strval( $this->mToken ),
- 'user_registration' => $dbw->timestamp( $this->mRegistration ),
- 'user_editcount' => 0,
- 'user_touched' => $dbw->timestamp( $this->mTouched ),
- ], $fname,
- [ 'IGNORE' ]
- );
- if ( !$dbw->affectedRows() ) {
- // Use locking reads to bypass any REPEATABLE-READ snapshot.
- $this->mId = $dbw->selectField(
- 'user',
- 'user_id',
- [ 'user_name' => $this->mName ],
- $fname,
- [ 'LOCK IN SHARE MODE' ]
- );
- $loaded = false;
- if ( $this->mId && $this->loadFromDatabase( self::READ_LOCKING ) ) {
- $loaded = true;
- }
- if ( !$loaded ) {
- throw new MWException( $fname . ": hit a key conflict attempting " .
- "to insert user '{$this->mName}' row, but it was not present in select!" );
- }
- return Status::newFatal( 'userexists' );
- }
- $this->mId = $dbw->insertId();
- self::$idCacheByName[$this->mName] = $this->mId;
- $this->updateActorId( $dbw );
- return Status::newGood();
- } );
- if ( !$status->isGood() ) {
- return $status;
- }
- // Clear instance cache other than user table data and actor, which is already accurate
- $this->clearInstanceCache();
- $this->saveOptions();
- return Status::newGood();
- }
- /**
- * Update the actor ID after an insert
- * @param IDatabase $dbw Writable database handle
- */
- private function updateActorId( IDatabase $dbw ) {
- $dbw->insert(
- 'actor',
- [ 'actor_user' => $this->mId, 'actor_name' => $this->mName ],
- __METHOD__
- );
- $this->mActorId = (int)$dbw->insertId();
- }
- /**
- * If this user is logged-in and blocked,
- * block any IP address they've successfully logged in from.
- * @return bool A block was spread
- */
- public function spreadAnyEditBlock() {
- if ( $this->isLoggedIn() && $this->getBlock() ) {
- return $this->spreadBlock();
- }
- return false;
- }
- /**
- * If this (non-anonymous) user is blocked,
- * block the IP address they've successfully logged in from.
- * @return bool A block was spread
- */
- protected function spreadBlock() {
- wfDebug( __METHOD__ . "()\n" );
- $this->load();
- if ( $this->mId == 0 ) {
- return false;
- }
- $userblock = DatabaseBlock::newFromTarget( $this->getName() );
- if ( !$userblock ) {
- return false;
- }
- return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
- }
- /**
- * Get whether the user is explicitly blocked from account creation.
- * @return bool|AbstractBlock
- */
- public function isBlockedFromCreateAccount() {
- $this->getBlockedStatus();
- if ( $this->mBlock && $this->mBlock->appliesToRight( 'createaccount' ) ) {
- return $this->mBlock;
- }
- # T15611: if the IP address the user is trying to create an account from is
- # blocked with createaccount disabled, prevent new account creation there even
- # when the user is logged in
- if ( $this->mBlockedFromCreateAccount === false && !$this->isAllowed( 'ipblock-exempt' ) ) {
- $this->mBlockedFromCreateAccount = DatabaseBlock::newFromTarget(
- null, $this->getRequest()->getIP()
- );
- }
- return $this->mBlockedFromCreateAccount instanceof AbstractBlock
- && $this->mBlockedFromCreateAccount->appliesToRight( 'createaccount' )
- ? $this->mBlockedFromCreateAccount
- : false;
- }
- /**
- * Get whether the user is blocked from using Special:Emailuser.
- * @return bool
- */
- public function isBlockedFromEmailuser() {
- $this->getBlockedStatus();
- return $this->mBlock && $this->mBlock->appliesToRight( 'sendemail' );
- }
- /**
- * Get whether the user is blocked from using Special:Upload
- *
- * @since 1.33
- * @return bool
- */
- public function isBlockedFromUpload() {
- $this->getBlockedStatus();
- return $this->mBlock && $this->mBlock->appliesToRight( 'upload' );
- }
- /**
- * Get whether the user is allowed to create an account.
- * @return bool
- */
- public function isAllowedToCreateAccount() {
- return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
- }
- /**
- * Get this user's personal page title.
- *
- * @return Title User's personal page title
- */
- public function getUserPage() {
- return Title::makeTitle( NS_USER, $this->getName() );
- }
- /**
- * Get this user's talk page title.
- *
- * @return Title User's talk page title
- */
- public function getTalkPage() {
- $title = $this->getUserPage();
- return $title->getTalkPage();
- }
- /**
- * Determine whether the user is a newbie. Newbies are either
- * anonymous IPs, or the most recently created accounts.
- * @return bool
- */
- public function isNewbie() {
- return !$this->isAllowed( 'autoconfirmed' );
- }
- /**
- * Check to see if the given clear-text password is one of the accepted passwords
- * @deprecated since 1.27, use AuthManager instead
- * @param string $password User password
- * @return bool True if the given password is correct, otherwise False
- */
- public function checkPassword( $password ) {
- wfDeprecated( __METHOD__, '1.27' );
- $manager = AuthManager::singleton();
- $reqs = AuthenticationRequest::loadRequestsFromSubmission(
- $manager->getAuthenticationRequests( AuthManager::ACTION_LOGIN ),
- [
- 'username' => $this->getName(),
- 'password' => $password,
- ]
- );
- $res = $manager->beginAuthentication( $reqs, 'null:' );
- switch ( $res->status ) {
- case AuthenticationResponse::PASS:
- return true;
- case AuthenticationResponse::FAIL:
- // Hope it's not a PreAuthenticationProvider that failed...
- LoggerFactory::getInstance( 'authentication' )
- ->info( __METHOD__ . ': Authentication failed: ' . $res->message->plain() );
- return false;
- default:
- throw new BadMethodCallException(
- 'AuthManager returned a response unsupported by ' . __METHOD__
- );
- }
- }
- /**
- * Check if the given clear-text password matches the temporary password
- * sent by e-mail for password reset operations.
- *
- * @deprecated since 1.27, use AuthManager instead
- * @param string $plaintext
- * @return bool True if matches, false otherwise
- */
- public function checkTemporaryPassword( $plaintext ) {
- wfDeprecated( __METHOD__, '1.27' );
- // Can't check the temporary password individually.
- return $this->checkPassword( $plaintext );
- }
- /**
- * Initialize (if necessary) and return a session token value
- * which can be used in edit forms to show that the user's
- * login credentials aren't being hijacked with a foreign form
- * submission.
- *
- * @since 1.27
- * @param string|array $salt Array of Strings Optional function-specific data for hashing
- * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
- * @return MediaWiki\Session\Token The new edit token
- */
- public function getEditTokenObject( $salt = '', $request = null ) {
- if ( $this->isAnon() ) {
- return new LoggedOutEditToken();
- }
- if ( !$request ) {
- $request = $this->getRequest();
- }
- return $request->getSession()->getToken( $salt );
- }
- /**
- * Initialize (if necessary) and return a session token value
- * which can be used in edit forms to show that the user's
- * login credentials aren't being hijacked with a foreign form
- * submission.
- *
- * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
- *
- * @since 1.19
- * @param string|array $salt Array of Strings Optional function-specific data for hashing
- * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
- * @return string The new edit token
- */
- public function getEditToken( $salt = '', $request = null ) {
- return $this->getEditTokenObject( $salt, $request )->toString();
- }
- /**
- * Check given value against the token value stored in the session.
- * A match should confirm that the form was submitted from the
- * user's own login session, not a form submission from a third-party
- * site.
- *
- * @param string $val Input value to compare
- * @param string|array $salt Optional function-specific data for hashing
- * @param WebRequest|null $request Object to use or null to use $wgRequest
- * @param int|null $maxage Fail tokens older than this, in seconds
- * @return bool Whether the token matches
- */
- public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
- return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
- }
- /**
- * Check given value against the token value stored in the session,
- * ignoring the suffix.
- *
- * @param string $val Input value to compare
- * @param string|array $salt Optional function-specific data for hashing
- * @param WebRequest|null $request Object to use or null to use $wgRequest
- * @param int|null $maxage Fail tokens older than this, in seconds
- * @return bool Whether the token matches
- */
- public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
- $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token::SUFFIX;
- return $this->matchEditToken( $val, $salt, $request, $maxage );
- }
- /**
- * Generate a new e-mail confirmation token and send a confirmation/invalidation
- * mail to the user's given address.
- *
- * @param string $type Message to send, either "created", "changed" or "set"
- * @return Status
- */
- public function sendConfirmationMail( $type = 'created' ) {
- global $wgLang;
- $expiration = null; // gets passed-by-ref and defined in next line.
- $token = $this->confirmationToken( $expiration );
- $url = $this->confirmationTokenUrl( $token );
- $invalidateURL = $this->invalidationTokenUrl( $token );
- $this->saveSettings();
- if ( $type == 'created' || $type === false ) {
- $message = 'confirmemail_body';
- $type = 'created';
- } elseif ( $type === true ) {
- $message = 'confirmemail_body_changed';
- $type = 'changed';
- } else {
- // Messages: confirmemail_body_changed, confirmemail_body_set
- $message = 'confirmemail_body_' . $type;
- }
- $mail = [
- 'subject' => wfMessage( 'confirmemail_subject' )->text(),
- 'body' => wfMessage( $message,
- $this->getRequest()->getIP(),
- $this->getName(),
- $url,
- $wgLang->userTimeAndDate( $expiration, $this ),
- $invalidateURL,
- $wgLang->userDate( $expiration, $this ),
- $wgLang->userTime( $expiration, $this ) )->text(),
- 'from' => null,
- 'replyTo' => null,
- ];
- $info = [
- 'type' => $type,
- 'ip' => $this->getRequest()->getIP(),
- 'confirmURL' => $url,
- 'invalidateURL' => $invalidateURL,
- 'expiration' => $expiration
- ];
- Hooks::run( 'UserSendConfirmationMail', [ $this, &$mail, $info ] );
- return $this->sendMail( $mail['subject'], $mail['body'], $mail['from'], $mail['replyTo'] );
- }
- /**
- * Send an e-mail to this user's account. Does not check for
- * confirmed status or validity.
- *
- * @param string $subject Message subject
- * @param string $body Message body
- * @param User|null $from Optional sending user; if unspecified, default
- * $wgPasswordSender will be used.
- * @param MailAddress|null $replyto Reply-To address
- * @return Status
- */
- public function sendMail( $subject, $body, $from = null, $replyto = null ) {
- global $wgPasswordSender;
- if ( $from instanceof User ) {
- $sender = MailAddress::newFromUser( $from );
- } else {
- $sender = new MailAddress( $wgPasswordSender,
- wfMessage( 'emailsender' )->inContentLanguage()->text() );
- }
- $to = MailAddress::newFromUser( $this );
- return UserMailer::send( $to, $sender, $subject, $body, [
- 'replyTo' => $replyto,
- ] );
- }
- /**
- * Generate, store, and return a new e-mail confirmation code.
- * A hash (unsalted, since it's used as a key) is stored.
- *
- * @note Call saveSettings() after calling this function to commit
- * this change to the database.
- *
- * @param string &$expiration Accepts the expiration time
- * @return string New token
- */
- protected function confirmationToken( &$expiration ) {
- global $wgUserEmailConfirmationTokenExpiry;
- $now = time();
- $expires = $now + $wgUserEmailConfirmationTokenExpiry;
- $expiration = wfTimestamp( TS_MW, $expires );
- $this->load();
- $token = MWCryptRand::generateHex( 32 );
- $hash = md5( $token );
- $this->mEmailToken = $hash;
- $this->mEmailTokenExpires = $expiration;
- return $token;
- }
- /**
- * Return a URL the user can use to confirm their email address.
- * @param string $token Accepts the email confirmation token
- * @return string New token URL
- */
- protected function confirmationTokenUrl( $token ) {
- return $this->getTokenUrl( 'ConfirmEmail', $token );
- }
- /**
- * Return a URL the user can use to invalidate their email address.
- * @param string $token Accepts the email confirmation token
- * @return string New token URL
- */
- protected function invalidationTokenUrl( $token ) {
- return $this->getTokenUrl( 'InvalidateEmail', $token );
- }
- /**
- * Internal function to format the e-mail validation/invalidation URLs.
- * This uses a quickie hack to use the
- * hardcoded English names of the Special: pages, for ASCII safety.
- *
- * @note Since these URLs get dropped directly into emails, using the
- * short English names avoids insanely long URL-encoded links, which
- * also sometimes can get corrupted in some browsers/mailers
- * (T8957 with Gmail and Internet Explorer).
- *
- * @param string $page Special page
- * @param string $token
- * @return string Formatted URL
- */
- protected function getTokenUrl( $page, $token ) {
- // Hack to bypass localization of 'Special:'
- $title = Title::makeTitle( NS_MAIN, "Special:$page/$token" );
- return $title->getCanonicalURL();
- }
- /**
- * Mark the e-mail address confirmed.
- *
- * @note Call saveSettings() after calling this function to commit the change.
- *
- * @return bool
- */
- public function confirmEmail() {
- // Check if it's already confirmed, so we don't touch the database
- // and fire the ConfirmEmailComplete hook on redundant confirmations.
- if ( !$this->isEmailConfirmed() ) {
- $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
- Hooks::run( 'ConfirmEmailComplete', [ $this ] );
- }
- return true;
- }
- /**
- * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
- * address if it was already confirmed.
- *
- * @note Call saveSettings() after calling this function to commit the change.
- * @return bool Returns true
- */
- public function invalidateEmail() {
- $this->load();
- $this->mEmailToken = null;
- $this->mEmailTokenExpires = null;
- $this->setEmailAuthenticationTimestamp( null );
- $this->mEmail = '';
- Hooks::run( 'InvalidateEmailComplete', [ $this ] );
- return true;
- }
- /**
- * Set the e-mail authentication timestamp.
- * @param string $timestamp TS_MW timestamp
- */
- public function setEmailAuthenticationTimestamp( $timestamp ) {
- $this->load();
- $this->mEmailAuthenticated = $timestamp;
- Hooks::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated ] );
- }
- /**
- * Is this user allowed to send e-mails within limits of current
- * site configuration?
- * @return bool
- */
- public function canSendEmail() {
- global $wgEnableEmail, $wgEnableUserEmail;
- if ( !$wgEnableEmail || !$wgEnableUserEmail || !$this->isAllowed( 'sendemail' ) ) {
- return false;
- }
- $canSend = $this->isEmailConfirmed();
- // Avoid PHP 7.1 warning of passing $this by reference
- $user = $this;
- Hooks::run( 'UserCanSendEmail', [ &$user, &$canSend ] );
- return $canSend;
- }
- /**
- * Is this user allowed to receive e-mails within limits of current
- * site configuration?
- * @return bool
- */
- public function canReceiveEmail() {
- return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
- }
- /**
- * Is this user's e-mail address valid-looking and confirmed within
- * limits of the current site configuration?
- *
- * @note If $wgEmailAuthentication is on, this may require the user to have
- * confirmed their address by returning a code or using a password
- * sent to the address from the wiki.
- *
- * @return bool
- */
- public function isEmailConfirmed() {
- global $wgEmailAuthentication;
- $this->load();
- // Avoid PHP 7.1 warning of passing $this by reference
- $user = $this;
- $confirmed = true;
- if ( Hooks::run( 'EmailConfirmed', [ &$user, &$confirmed ] ) ) {
- if ( $this->isAnon() ) {
- return false;
- }
- if ( !Sanitizer::validateEmail( $this->mEmail ) ) {
- return false;
- }
- if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
- return false;
- }
- return true;
- }
- return $confirmed;
- }
- /**
- * Check whether there is an outstanding request for e-mail confirmation.
- * @return bool
- */
- public function isEmailConfirmationPending() {
- global $wgEmailAuthentication;
- return $wgEmailAuthentication &&
- !$this->isEmailConfirmed() &&
- $this->mEmailToken &&
- $this->mEmailTokenExpires > wfTimestamp();
- }
- /**
- * Get the timestamp of account creation.
- *
- * @return string|bool|null Timestamp of account creation, false for
- * non-existent/anonymous user accounts, or null if existing account
- * but information is not in database.
- */
- public function getRegistration() {
- if ( $this->isAnon() ) {
- return false;
- }
- $this->load();
- return $this->mRegistration;
- }
- /**
- * Get the timestamp of the first edit
- *
- * @return string|bool Timestamp of first edit, or false for
- * non-existent/anonymous user accounts.
- */
- public function getFirstEditTimestamp() {
- return $this->getEditTimestamp( true );
- }
- /**
- * Get the timestamp of the latest edit
- *
- * @since 1.33
- * @return string|bool Timestamp of first edit, or false for
- * non-existent/anonymous user accounts.
- */
- public function getLatestEditTimestamp() {
- return $this->getEditTimestamp( false );
- }
- /**
- * Get the timestamp of the first or latest edit
- *
- * @param bool $first True for the first edit, false for the latest one
- * @return string|bool Timestamp of first or latest edit, or false for
- * non-existent/anonymous user accounts.
- */
- private function getEditTimestamp( $first ) {
- if ( $this->getId() == 0 ) {
- return false; // anons
- }
- $dbr = wfGetDB( DB_REPLICA );
- $actorWhere = ActorMigration::newMigration()->getWhere( $dbr, 'rev_user', $this );
- $tsField = isset( $actorWhere['tables']['temp_rev_user'] )
- ? 'revactor_timestamp' : 'rev_timestamp';
- $sortOrder = $first ? 'ASC' : 'DESC';
- $time = $dbr->selectField(
- [ 'revision' ] + $actorWhere['tables'],
- $tsField,
- [ $actorWhere['conds'] ],
- __METHOD__,
- [ 'ORDER BY' => "$tsField $sortOrder" ],
- $actorWhere['joins']
- );
- if ( !$time ) {
- return false; // no edits
- }
- return wfTimestamp( TS_MW, $time );
- }
- /**
- * Get the permissions associated with a given list of groups
- *
- * @deprecated since 1.34, use MediaWikiServices::getInstance()->getPermissionManager()
- * ->getGroupPermissions() instead
- *
- * @param array $groups Array of Strings List of internal group names
- * @return array Array of Strings List of permission key names for given groups combined
- */
- public static function getGroupPermissions( $groups ) {
- return MediaWikiServices::getInstance()->getPermissionManager()->getGroupPermissions( $groups );
- }
- /**
- * Get all the groups who have a given permission
- *
- * @deprecated since 1.34, use MediaWikiServices::getInstance()->getPermissionManager()
- * ->getGroupsWithPermission() instead
- *
- * @param string $role Role to check
- * @return array Array of Strings List of internal group names with the given permission
- */
- public static function getGroupsWithPermission( $role ) {
- return MediaWikiServices::getInstance()->getPermissionManager()->getGroupsWithPermission( $role );
- }
- /**
- * Check, if the given group has the given permission
- *
- * If you're wanting to check whether all users have a permission, use
- * User::isEveryoneAllowed() instead. That properly checks if it's revoked
- * from anyone.
- *
- * @deprecated since 1.34, use MediaWikiServices::getInstance()->getPermissionManager()
- * ->groupHasPermission(..) instead
- *
- * @since 1.21
- * @param string $group Group to check
- * @param string $role Role to check
- * @return bool
- */
- public static function groupHasPermission( $group, $role ) {
- return MediaWikiServices::getInstance()->getPermissionManager()
- ->groupHasPermission( $group, $role );
- }
- /**
- * Check if all users may be assumed to have the given permission
- *
- * We generally assume so if the right is granted to '*' and isn't revoked
- * on any group. It doesn't attempt to take grants or other extension
- * limitations on rights into account in the general case, though, as that
- * would require it to always return false and defeat the purpose.
- * Specifically, session-based rights restrictions (such as OAuth or bot
- * passwords) are applied based on the current session.
- *
- * @deprecated since 1.34, use MediaWikiServices::getInstance()->getPermissionManager()
- * ->isEveryoneAllowed() instead
- *
- * @param string $right Right to check
- *
- * @return bool
- * @since 1.22
- */
- public static function isEveryoneAllowed( $right ) {
- return MediaWikiServices::getInstance()->getPermissionManager()->isEveryoneAllowed( $right );
- }
- /**
- * Return the set of defined explicit groups.
- * The implicit groups (by default *, 'user' and 'autoconfirmed')
- * are not included, as they are defined automatically, not in the database.
- * @return array Array of internal group names
- */
- public static function getAllGroups() {
- global $wgGroupPermissions, $wgRevokePermissions;
- return array_values( array_diff(
- array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
- self::getImplicitGroups()
- ) );
- }
- /**
- * Get a list of all available permissions.
- *
- * @deprecated since 1.34, use PermissionManager::getAllPermissions() instead
- *
- * @return string[] Array of permission names
- */
- public static function getAllRights() {
- return MediaWikiServices::getInstance()->getPermissionManager()->getAllPermissions();
- }
- /**
- * Get a list of implicit groups
- * TODO: Should we deprecate this? It's trivial, but we don't want to encourage use of globals.
- *
- * @return array Array of Strings Array of internal group names
- */
- public static function getImplicitGroups() {
- global $wgImplicitGroups;
- return $wgImplicitGroups;
- }
- /**
- * Returns an array of the groups that a particular group can add/remove.
- *
- * @param string $group The group to check for whether it can add/remove
- * @return array [ 'add' => [ addablegroups ],
- * 'remove' => [ removablegroups ],
- * 'add-self' => [ addablegroups to self ],
- * 'remove-self' => [ removable groups from self ] ]
- */
- public static function changeableByGroup( $group ) {
- global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
- $groups = [
- 'add' => [],
- 'remove' => [],
- 'add-self' => [],
- 'remove-self' => []
- ];
- if ( empty( $wgAddGroups[$group] ) ) {
- // Don't add anything to $groups
- } elseif ( $wgAddGroups[$group] === true ) {
- // You get everything
- $groups['add'] = self::getAllGroups();
- } elseif ( is_array( $wgAddGroups[$group] ) ) {
- $groups['add'] = $wgAddGroups[$group];
- }
- // Same thing for remove
- if ( empty( $wgRemoveGroups[$group] ) ) {
- // Do nothing
- } elseif ( $wgRemoveGroups[$group] === true ) {
- $groups['remove'] = self::getAllGroups();
- } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
- $groups['remove'] = $wgRemoveGroups[$group];
- }
- // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
- if ( empty( $wgGroupsAddToSelf['user'] ) || $wgGroupsAddToSelf['user'] !== true ) {
- foreach ( $wgGroupsAddToSelf as $key => $value ) {
- if ( is_int( $key ) ) {
- $wgGroupsAddToSelf['user'][] = $value;
- }
- }
- }
- if ( empty( $wgGroupsRemoveFromSelf['user'] ) || $wgGroupsRemoveFromSelf['user'] !== true ) {
- foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
- if ( is_int( $key ) ) {
- $wgGroupsRemoveFromSelf['user'][] = $value;
- }
- }
- }
- // Now figure out what groups the user can add to him/herself
- if ( empty( $wgGroupsAddToSelf[$group] ) ) {
- // Do nothing
- } elseif ( $wgGroupsAddToSelf[$group] === true ) {
- // No idea WHY this would be used, but it's there
- $groups['add-self'] = self::getAllGroups();
- } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
- $groups['add-self'] = $wgGroupsAddToSelf[$group];
- }
- if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
- // Do nothing
- } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
- $groups['remove-self'] = self::getAllGroups();
- } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
- $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
- }
- return $groups;
- }
- /**
- * Returns an array of groups that this user can add and remove
- * @return array [ 'add' => [ addablegroups ],
- * 'remove' => [ removablegroups ],
- * 'add-self' => [ addablegroups to self ],
- * 'remove-self' => [ removable groups from self ] ]
- */
- public function changeableGroups() {
- if ( $this->isAllowed( 'userrights' ) ) {
- // This group gives the right to modify everything (reverse-
- // compatibility with old "userrights lets you change
- // everything")
- // Using array_merge to make the groups reindexed
- $all = array_merge( self::getAllGroups() );
- return [
- 'add' => $all,
- 'remove' => $all,
- 'add-self' => [],
- 'remove-self' => []
- ];
- }
- // Okay, it's not so simple, we will have to go through the arrays
- $groups = [
- 'add' => [],
- 'remove' => [],
- 'add-self' => [],
- 'remove-self' => []
- ];
- $addergroups = $this->getEffectiveGroups();
- foreach ( $addergroups as $addergroup ) {
- $groups = array_merge_recursive(
- $groups, $this->changeableByGroup( $addergroup )
- );
- $groups['add'] = array_unique( $groups['add'] );
- $groups['remove'] = array_unique( $groups['remove'] );
- $groups['add-self'] = array_unique( $groups['add-self'] );
- $groups['remove-self'] = array_unique( $groups['remove-self'] );
- }
- return $groups;
- }
- /**
- * Schedule a deferred update to update the user's edit count
- */
- public function incEditCount() {
- if ( $this->isAnon() ) {
- return; // sanity
- }
- DeferredUpdates::addUpdate(
- new UserEditCountUpdate( $this, 1 ),
- DeferredUpdates::POSTSEND
- );
- }
- /**
- * This method should not be called outside User/UserEditCountUpdate
- *
- * @param int $count
- */
- public function setEditCountInternal( $count ) {
- $this->mEditCount = $count;
- }
- /**
- * Initialize user_editcount from data out of the revision table
- *
- * @internal This method should not be called outside User/UserEditCountUpdate
- * @param IDatabase $dbr Replica database
- * @return int Number of edits
- */
- public function initEditCountInternal( IDatabase $dbr ) {
- // Pull from a replica DB to be less cruel to servers
- // Accuracy isn't the point anyway here
- $actorWhere = ActorMigration::newMigration()->getWhere( $dbr, 'rev_user', $this );
- $count = (int)$dbr->selectField(
- [ 'revision' ] + $actorWhere['tables'],
- 'COUNT(*)',
- [ $actorWhere['conds'] ],
- __METHOD__,
- [],
- $actorWhere['joins']
- );
- $dbw = wfGetDB( DB_MASTER );
- $dbw->update(
- 'user',
- [ 'user_editcount' => $count ],
- [
- 'user_id' => $this->getId(),
- 'user_editcount IS NULL OR user_editcount < ' . (int)$count
- ],
- __METHOD__
- );
- return $count;
- }
- /**
- * Get the description of a given right
- *
- * @since 1.29
- * @param string $right Right to query
- * @return string Localized description of the right
- */
- public static function getRightDescription( $right ) {
- $key = "right-$right";
- $msg = wfMessage( $key );
- return $msg->isDisabled() ? $right : $msg->text();
- }
- /**
- * Get the name of a given grant
- *
- * @since 1.29
- * @param string $grant Grant to query
- * @return string Localized name of the grant
- */
- public static function getGrantName( $grant ) {
- $key = "grant-$grant";
- $msg = wfMessage( $key );
- return $msg->isDisabled() ? $grant : $msg->text();
- }
- /**
- * Add a newuser log entry for this user.
- * Before 1.19 the return value was always true.
- *
- * @deprecated since 1.27, AuthManager handles logging
- * @param string|bool $action Account creation type.
- * - String, one of the following values:
- * - 'create' for an anonymous user creating an account for himself.
- * This will force the action's performer to be the created user itself,
- * no matter the value of $wgUser
- * - 'create2' for a logged in user creating an account for someone else
- * - 'byemail' when the created user will receive its password by e-mail
- * - 'autocreate' when the user is automatically created (such as by CentralAuth).
- * - Boolean means whether the account was created by e-mail (deprecated):
- * - true will be converted to 'byemail'
- * - false will be converted to 'create' if this object is the same as
- * $wgUser and to 'create2' otherwise
- * @param string $reason User supplied reason
- * @return bool true
- */
- public function addNewUserLogEntry( $action = false, $reason = '' ) {
- return true; // disabled
- }
- /**
- * Add an autocreate newuser log entry for this user
- * Used by things like CentralAuth and perhaps other authplugins.
- * Consider calling addNewUserLogEntry() directly instead.
- *
- * @deprecated since 1.27, AuthManager handles logging
- * @return bool
- */
- public function addNewUserLogEntryAutoCreate() {
- wfDeprecated( __METHOD__, '1.27' );
- $this->addNewUserLogEntry( 'autocreate' );
- return true;
- }
- /**
- * Load the user options either from cache, the database or an array
- *
- * @param array|null $data Rows for the current user out of the user_properties table
- */
- protected function loadOptions( $data = null ) {
- $this->load();
- if ( $this->mOptionsLoaded ) {
- return;
- }
- $this->mOptions = self::getDefaultOptions();
- if ( !$this->getId() ) {
- // For unlogged-in users, load language/variant options from request.
- // There's no need to do it for logged-in users: they can set preferences,
- // and handling of page content is done by $pageLang->getPreferredVariant() and such,
- // so don't override user's choice (especially when the user chooses site default).
- $variant = MediaWikiServices::getInstance()->getContentLanguage()->getDefaultVariant();
- $this->mOptions['variant'] = $variant;
- $this->mOptions['language'] = $variant;
- $this->mOptionsLoaded = true;
- return;
- }
- // Maybe load from the object
- if ( !is_null( $this->mOptionOverrides ) ) {
- wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
- foreach ( $this->mOptionOverrides as $key => $value ) {
- $this->mOptions[$key] = $value;
- }
- } else {
- if ( !is_array( $data ) ) {
- wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
- // Load from database
- $dbr = ( $this->queryFlagsUsed & self::READ_LATEST )
- ? wfGetDB( DB_MASTER )
- : wfGetDB( DB_REPLICA );
- $res = $dbr->select(
- 'user_properties',
- [ 'up_property', 'up_value' ],
- [ 'up_user' => $this->getId() ],
- __METHOD__
- );
- $this->mOptionOverrides = [];
- $data = [];
- foreach ( $res as $row ) {
- // Convert '0' to 0. PHP's boolean conversion considers them both
- // false, but e.g. JavaScript considers the former as true.
- // @todo: T54542 Somehow determine the desired type (string/int/bool)
- // and convert all values here.
- if ( $row->up_value === '0' ) {
- $row->up_value = 0;
- }
- $data[$row->up_property] = $row->up_value;
- }
- }
- foreach ( $data as $property => $value ) {
- $this->mOptionOverrides[$property] = $value;
- $this->mOptions[$property] = $value;
- }
- }
- // Replace deprecated language codes
- $this->mOptions['language'] = LanguageCode::replaceDeprecatedCodes(
- $this->mOptions['language']
- );
- $this->mOptionsLoaded = true;
- Hooks::run( 'UserLoadOptions', [ $this, &$this->mOptions ] );
- }
- /**
- * Saves the non-default options for this user, as previously set e.g. via
- * setOption(), in the database's "user_properties" (preferences) table.
- * Usually used via saveSettings().
- */
- protected function saveOptions() {
- $this->loadOptions();
- // Not using getOptions(), to keep hidden preferences in database
- $saveOptions = $this->mOptions;
- // Allow hooks to abort, for instance to save to a global profile.
- // Reset options to default state before saving.
- if ( !Hooks::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
- return;
- }
- $userId = $this->getId();
- $insert_rows = []; // all the new preference rows
- foreach ( $saveOptions as $key => $value ) {
- // Don't bother storing default values
- $defaultOption = self::getDefaultOption( $key );
- if ( ( $defaultOption === null && $value !== false && $value !== null )
- || $value != $defaultOption
- ) {
- $insert_rows[] = [
- 'up_user' => $userId,
- 'up_property' => $key,
- 'up_value' => $value,
- ];
- }
- }
- $dbw = wfGetDB( DB_MASTER );
- $res = $dbw->select( 'user_properties',
- [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__ );
- // Find prior rows that need to be removed or updated. These rows will
- // all be deleted (the latter so that INSERT IGNORE applies the new values).
- $keysDelete = [];
- foreach ( $res as $row ) {
- if ( !isset( $saveOptions[$row->up_property] )
- || strcmp( $saveOptions[$row->up_property], $row->up_value ) != 0
- ) {
- $keysDelete[] = $row->up_property;
- }
- }
- if ( count( $keysDelete ) ) {
- // Do the DELETE by PRIMARY KEY for prior rows.
- // In the past a very large portion of calls to this function are for setting
- // 'rememberpassword' for new accounts (a preference that has since been removed).
- // Doing a blanket per-user DELETE for new accounts with no rows in the table
- // caused gap locks on [max user ID,+infinity) which caused high contention since
- // updates would pile up on each other as they are for higher (newer) user IDs.
- // It might not be necessary these days, but it shouldn't hurt either.
- $dbw->delete( 'user_properties',
- [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__ );
- }
- // Insert the new preference rows
- $dbw->insert( 'user_properties', $insert_rows, __METHOD__, [ 'IGNORE' ] );
- }
- /**
- * Return the list of user fields that should be selected to create
- * a new user object.
- * @deprecated since 1.31, use self::getQueryInfo() instead.
- * @return array
- */
- public static function selectFields() {
- wfDeprecated( __METHOD__, '1.31' );
- return [
- 'user_id',
- 'user_name',
- 'user_real_name',
- 'user_email',
- 'user_touched',
- 'user_token',
- 'user_email_authenticated',
- 'user_email_token',
- 'user_email_token_expires',
- 'user_registration',
- 'user_editcount',
- ];
- }
- /**
- * Return the tables, fields, and join conditions to be selected to create
- * a new user object.
- * @since 1.31
- * @return array With three keys:
- * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
- * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
- * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
- */
- public static function getQueryInfo() {
- $ret = [
- 'tables' => [ 'user', 'user_actor' => 'actor' ],
- 'fields' => [
- 'user_id',
- 'user_name',
- 'user_real_name',
- 'user_email',
- 'user_touched',
- 'user_token',
- 'user_email_authenticated',
- 'user_email_token',
- 'user_email_token_expires',
- 'user_registration',
- 'user_editcount',
- 'user_actor.actor_id',
- ],
- 'joins' => [
- 'user_actor' => [ 'JOIN', 'user_actor.actor_user = user_id' ],
- ],
- ];
- return $ret;
- }
- /**
- * Factory function for fatal permission-denied errors
- *
- * @since 1.22
- * @param string $permission User right required
- * @return Status
- */
- static function newFatalPermissionDeniedStatus( $permission ) {
- global $wgLang;
- $groups = [];
- foreach ( MediaWikiServices::getInstance()
- ->getPermissionManager()
- ->getGroupsWithPermission( $permission ) as $group ) {
- $groups[] = UserGroupMembership::getLink( $group, RequestContext::getMain(), 'wiki' );
- }
- if ( $groups ) {
- return Status::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
- }
- return Status::newFatal( 'badaccess-group0' );
- }
- /**
- * Get a new instance of this user that was loaded from the master via a locking read
- *
- * Use this instead of the main context User when updating that user. This avoids races
- * where that user was loaded from a replica DB or even the master but without proper locks.
- *
- * @return User|null Returns null if the user was not found in the DB
- * @since 1.27
- */
- public function getInstanceForUpdate() {
- if ( !$this->getId() ) {
- return null; // anon
- }
- $user = self::newFromId( $this->getId() );
- if ( !$user->loadFromId( self::READ_EXCLUSIVE ) ) {
- return null;
- }
- return $user;
- }
- /**
- * Checks if two user objects point to the same user.
- *
- * @since 1.25 ; takes a UserIdentity instead of a User since 1.32
- * @param UserIdentity $user
- * @return bool
- */
- public function equals( UserIdentity $user ) {
- // XXX it's not clear whether central ID providers are supposed to obey this
- return $this->getName() === $user->getName();
- }
- /**
- * Checks if usertalk is allowed
- *
- * @return bool
- */
- public function isAllowUsertalk() {
- return $this->mAllowUsertalk;
- }
- }
|