*Get range blocks to consider "anononly" while I'm at it
[lhc/web/wiklou.git] / includes / Block.php
1 <?php
2 /**
3 * Blocks and bans object
4 */
5
6 /**
7 * The block class
8 * All the functions in this class assume the object is either explicitly
9 * loaded or filled. It is not load-on-demand. There are no accessors.
10 *
11 * Globals used: $wgAutoblockExpiry, $wgAntiLockFlags
12 *
13 * @todo This could be used everywhere, but it isn't.
14 */
15 class Block
16 {
17 /* public*/ var $mAddress, $mUser, $mBy, $mReason, $mTimestamp, $mAuto, $mId, $mExpiry,
18 $mRangeStart, $mRangeEnd, $mAnonOnly, $mEnableAutoblock;
19 /* private */ var $mNetworkBits, $mIntegerAddr, $mForUpdate, $mFromMaster, $mByName;
20
21 const EB_KEEP_EXPIRED = 1;
22 const EB_FOR_UPDATE = 2;
23 const EB_RANGE_ONLY = 4;
24
25 function __construct( $address = '', $user = 0, $by = 0, $reason = '',
26 $timestamp = '' , $auto = 0, $expiry = '', $anonOnly = 0, $createAccount = 0, $enableAutoblock = 0 )
27 {
28 $this->mId = 0;
29 # Expand valid IPv6 addresses
30 $address = IP::sanitizeIP( $address );
31 $this->mAddress = $address;
32 $this->mUser = $user;
33 $this->mBy = $by;
34 $this->mReason = $reason;
35 $this->mTimestamp = wfTimestamp(TS_MW,$timestamp);
36 $this->mAuto = $auto;
37 $this->mAnonOnly = $anonOnly;
38 $this->mCreateAccount = $createAccount;
39 $this->mExpiry = self::decodeExpiry( $expiry );
40 $this->mEnableAutoblock = $enableAutoblock;
41
42 $this->mForUpdate = false;
43 $this->mFromMaster = false;
44 $this->mByName = false;
45 $this->initialiseRange();
46 }
47
48 static function newFromDB( $address, $user = 0, $killExpired = true )
49 {
50 $block = new Block();
51 $block->load( $address, $user, $killExpired );
52 if ( $block->isValid() ) {
53 return $block;
54 } else {
55 return null;
56 }
57 }
58
59 static function newFromID( $id )
60 {
61 $dbr = wfGetDB( DB_SLAVE );
62 $res = $dbr->resultObject( $dbr->select( 'ipblocks', '*',
63 array( 'ipb_id' => $id ), __METHOD__ ) );
64 $block = new Block;
65 if ( $block->loadFromResult( $res ) ) {
66 return $block;
67 } else {
68 return null;
69 }
70 }
71
72 function clear()
73 {
74 $this->mAddress = $this->mReason = $this->mTimestamp = '';
75 $this->mId = $this->mAnonOnly = $this->mCreateAccount =
76 $this->mEnableAutoblock = $this->mAuto = $this->mUser =
77 $this->mBy = 0;
78 $this->mByName = false;
79 }
80
81 /**
82 * Get the DB object and set the reference parameter to the query options
83 */
84 function &getDBOptions( &$options )
85 {
86 global $wgAntiLockFlags;
87 if ( $this->mForUpdate || $this->mFromMaster ) {
88 $db = wfGetDB( DB_MASTER );
89 if ( !$this->mForUpdate || ($wgAntiLockFlags & ALF_NO_BLOCK_LOCK) ) {
90 $options = array();
91 } else {
92 $options = array( 'FOR UPDATE' );
93 }
94 } else {
95 $db = wfGetDB( DB_SLAVE );
96 $options = array();
97 }
98 return $db;
99 }
100
101 /**
102 * Get a ban from the DB, with either the given address or the given username
103 *
104 * @param string $address The IP address of the user, or blank to skip IP blocks
105 * @param integer $user The user ID, or zero for anonymous users
106 * @param bool $killExpired Whether to delete expired rows while loading
107 *
108 */
109 function load( $address = '', $user = 0, $killExpired = true )
110 {
111 wfDebug( "Block::load: '$address', '$user', $killExpired\n" );
112
113 $options = array();
114 $db =& $this->getDBOptions( $options );
115
116 if ( 0 == $user && $address == '' ) {
117 # Invalid user specification, not blocked
118 $this->clear();
119 return false;
120 }
121
122 # Try user block
123 if ( $user ) {
124 $res = $db->resultObject( $db->select( 'ipblocks', '*', array( 'ipb_user' => $user ),
125 __METHOD__, $options ) );
126 if ( $this->loadFromResult( $res, $killExpired ) ) {
127 return true;
128 }
129 }
130
131 # Try IP block
132 # TODO: improve performance by merging this query with the autoblock one
133 # Slightly tricky while handling killExpired as well
134 if ( $address ) {
135 $conds = array( 'ipb_address' => $address, 'ipb_auto' => 0 );
136 $res = $db->resultObject( $db->select( 'ipblocks', '*', $conds, __METHOD__, $options ) );
137 if ( $this->loadFromResult( $res, $killExpired ) ) {
138 if ( $user && $this->mAnonOnly ) {
139 # Block is marked anon-only
140 # Whitelist this IP address against autoblocks and range blocks
141 $this->clear();
142 return false;
143 } else {
144 return true;
145 }
146 }
147 }
148
149 # Try range block
150 if ( $this->loadRange( $address, $killExpired, $user ) ) {
151 if ( $user && $this->mAnonOnly ) {
152 $this->clear();
153 return false;
154 } else {
155 return true;
156 }
157 }
158
159 # Try autoblock
160 if ( $address ) {
161 $conds = array( 'ipb_address' => $address, 'ipb_auto' => 1 );
162 if ( $user ) {
163 $conds['ipb_anon_only'] = 0;
164 }
165 $res = $db->resultObject( $db->select( 'ipblocks', '*', $conds, __METHOD__, $options ) );
166 if ( $this->loadFromResult( $res, $killExpired ) ) {
167 return true;
168 }
169 }
170
171 # Give up
172 $this->clear();
173 return false;
174 }
175
176 /**
177 * Fill in member variables from a result wrapper
178 */
179 function loadFromResult( ResultWrapper $res, $killExpired = true )
180 {
181 $ret = false;
182 if ( 0 != $res->numRows() ) {
183 # Get first block
184 $row = $res->fetchObject();
185 $this->initFromRow( $row );
186
187 if ( $killExpired ) {
188 # If requested, delete expired rows
189 do {
190 $killed = $this->deleteIfExpired();
191 if ( $killed ) {
192 $row = $res->fetchObject();
193 if ( $row ) {
194 $this->initFromRow( $row );
195 }
196 }
197 } while ( $killed && $row );
198
199 # If there were any left after the killing finished, return true
200 if ( $row ) {
201 $ret = true;
202 }
203 } else {
204 $ret = true;
205 }
206 }
207 $res->free();
208 return $ret;
209 }
210
211 /**
212 * Search the database for any range blocks matching the given address, and
213 * load the row if one is found.
214 */
215 function loadRange( $address, $killExpired = true, $user = 0 )
216 {
217 $iaddr = IP::toHex( $address );
218 if ( $iaddr === false ) {
219 # Invalid address
220 return false;
221 }
222
223 # Only scan ranges which start in this /16, this improves search speed
224 # Blocks should not cross a /16 boundary.
225 $range = substr( $iaddr, 0, 4 );
226
227 $options = array();
228 $db =& $this->getDBOptions( $options );
229 $conds = array(
230 "ipb_range_start LIKE '$range%'",
231 "ipb_range_start <= '$iaddr'",
232 "ipb_range_end >= '$iaddr'"
233 );
234
235 if ( $user ) {
236 $conds['ipb_anon_only'] = 0;
237 }
238
239 $res = $db->resultObject( $db->select( 'ipblocks', '*', $conds, __METHOD__, $options ) );
240 $success = $this->loadFromResult( $res, $killExpired );
241 return $success;
242 }
243
244 /**
245 * Determine if a given integer IPv4 address is in a given CIDR network
246 * @deprecated Use IP::isInRange
247 */
248 function isAddressInRange( $addr, $range ) {
249 return IP::isInRange( $addr, $range );
250 }
251
252 function initFromRow( $row )
253 {
254 $this->mAddress = $row->ipb_address;
255 $this->mReason = $row->ipb_reason;
256 $this->mTimestamp = wfTimestamp(TS_MW,$row->ipb_timestamp);
257 $this->mUser = $row->ipb_user;
258 $this->mBy = $row->ipb_by;
259 $this->mAuto = $row->ipb_auto;
260 $this->mAnonOnly = $row->ipb_anon_only;
261 $this->mCreateAccount = $row->ipb_create_account;
262 $this->mEnableAutoblock = $row->ipb_enable_autoblock;
263 $this->mId = $row->ipb_id;
264 $this->mExpiry = self::decodeExpiry( $row->ipb_expiry );
265 if ( isset( $row->user_name ) ) {
266 $this->mByName = $row->user_name;
267 } else {
268 $this->mByName = false;
269 }
270 $this->mRangeStart = $row->ipb_range_start;
271 $this->mRangeEnd = $row->ipb_range_end;
272 }
273
274 function initialiseRange()
275 {
276 $this->mRangeStart = '';
277 $this->mRangeEnd = '';
278
279 if ( $this->mUser == 0 ) {
280 list( $this->mRangeStart, $this->mRangeEnd ) = IP::parseRange( $this->mAddress );
281 }
282 }
283
284 /**
285 * Callback with a Block object for every block
286 * @return integer number of blocks;
287 */
288 /*static*/ function enumBlocks( $callback, $tag, $flags = 0 )
289 {
290 global $wgAntiLockFlags;
291
292 $block = new Block();
293 if ( $flags & Block::EB_FOR_UPDATE ) {
294 $db = wfGetDB( DB_MASTER );
295 if ( $wgAntiLockFlags & ALF_NO_BLOCK_LOCK ) {
296 $options = '';
297 } else {
298 $options = 'FOR UPDATE';
299 }
300 $block->forUpdate( true );
301 } else {
302 $db = wfGetDB( DB_SLAVE );
303 $options = '';
304 }
305 if ( $flags & Block::EB_RANGE_ONLY ) {
306 $cond = " AND ipb_range_start <> ''";
307 } else {
308 $cond = '';
309 }
310
311 $now = wfTimestampNow();
312
313 list( $ipblocks, $user ) = $db->tableNamesN( 'ipblocks', 'user' );
314
315 $sql = "SELECT $ipblocks.*,user_name FROM $ipblocks,$user " .
316 "WHERE user_id=ipb_by $cond ORDER BY ipb_timestamp DESC $options";
317 $res = $db->query( $sql, 'Block::enumBlocks' );
318 $num_rows = $db->numRows( $res );
319
320 while ( $row = $db->fetchObject( $res ) ) {
321 $block->initFromRow( $row );
322 if ( ( $flags & Block::EB_RANGE_ONLY ) && $block->mRangeStart == '' ) {
323 continue;
324 }
325
326 if ( !( $flags & Block::EB_KEEP_EXPIRED ) ) {
327 if ( $block->mExpiry && $now > $block->mExpiry ) {
328 $block->delete();
329 } else {
330 call_user_func( $callback, $block, $tag );
331 }
332 } else {
333 call_user_func( $callback, $block, $tag );
334 }
335 }
336 $db->freeResult( $res );
337 return $num_rows;
338 }
339
340 function delete()
341 {
342 if (wfReadOnly()) {
343 return false;
344 }
345 if ( !$this->mId ) {
346 throw new MWException( "Block::delete() now requires that the mId member be filled\n" );
347 }
348
349 $dbw = wfGetDB( DB_MASTER );
350 $dbw->delete( 'ipblocks', array( 'ipb_id' => $this->mId ), __METHOD__ );
351 return $dbw->affectedRows() > 0;
352 }
353
354 /**
355 * Insert a block into the block table.
356 *@return Whether or not the insertion was successful.
357 */
358 function insert()
359 {
360 wfDebug( "Block::insert; timestamp {$this->mTimestamp}\n" );
361 $dbw = wfGetDB( DB_MASTER );
362 $dbw->begin();
363
364 # Unset ipb_anon_only for user blocks, makes no sense
365 if ( $this->mUser ) {
366 $this->mAnonOnly = 0;
367 }
368
369 # Unset ipb_enable_autoblock for IP blocks, makes no sense
370 if ( !$this->mUser ) {
371 $this->mEnableAutoblock = 0;
372 }
373
374 # Don't collide with expired blocks
375 Block::purgeExpired();
376
377 $ipb_id = $dbw->nextSequenceValue('ipblocks_ipb_id_val');
378 $dbw->insert( 'ipblocks',
379 array(
380 'ipb_id' => $ipb_id,
381 'ipb_address' => $this->mAddress,
382 'ipb_user' => $this->mUser,
383 'ipb_by' => $this->mBy,
384 'ipb_reason' => $this->mReason,
385 'ipb_timestamp' => $dbw->timestamp($this->mTimestamp),
386 'ipb_auto' => $this->mAuto,
387 'ipb_anon_only' => $this->mAnonOnly,
388 'ipb_create_account' => $this->mCreateAccount,
389 'ipb_enable_autoblock' => $this->mEnableAutoblock,
390 'ipb_expiry' => self::encodeExpiry( $this->mExpiry, $dbw ),
391 'ipb_range_start' => $this->mRangeStart,
392 'ipb_range_end' => $this->mRangeEnd,
393 ), 'Block::insert', array( 'IGNORE' )
394 );
395 $affected = $dbw->affectedRows();
396 $dbw->commit();
397
398 if ($affected)
399 $this->doRetroactiveAutoblock();
400
401 return $affected;
402 }
403
404 /**
405 * Retroactively autoblocks the last IP used by the user (if it is a user)
406 * blocked by this Block.
407 *@return Whether or not a retroactive autoblock was made.
408 */
409 function doRetroactiveAutoblock() {
410 $dbr = wfGetDB( DB_SLAVE );
411 #If autoblock is enabled, autoblock the LAST IP used
412 # - stolen shamelessly from CheckUser_body.php
413
414 if ($this->mEnableAutoblock && $this->mUser) {
415 wfDebug("Doing retroactive autoblocks for " . $this->mAddress . "\n");
416
417 $row = $dbr->selectRow( 'recentchanges', array( 'rc_ip' ), array( 'rc_user_text' => $this->mAddress ),
418 __METHOD__ , array( 'ORDER BY' => 'rc_timestamp DESC' ) );
419
420 if ( !$row || !$row->rc_ip ) {
421 #No results, don't autoblock anything
422 wfDebug("No IP found to retroactively autoblock\n");
423 } else {
424 #Limit is 1, so no loop needed.
425 $retroblockip = $row->rc_ip;
426 return $this->doAutoblock($retroblockip);
427 }
428 }
429 }
430
431 /**
432 * Autoblocks the given IP, referring to this Block.
433 * @param $autoblockip The IP to autoblock.
434 * @return bool Whether or not an autoblock was inserted.
435 */
436 function doAutoblock( $autoblockip ) {
437 # Check if this IP address is already blocked
438 $dbw = wfGetDB( DB_MASTER );
439 $dbw->begin();
440
441 # If autoblocks are disabled, go away.
442 if ( !$this->mEnableAutoblock ) {
443 return;
444 }
445
446 # Check for presence on the autoblock whitelist
447 # TODO cache this?
448 $lines = explode( "\n", wfMsgForContentNoTrans( 'autoblock_whitelist' ) );
449
450 $ip = $autoblockip;
451
452 wfDebug("Checking the autoblock whitelist..\n");
453
454 foreach( $lines as $line ) {
455 # List items only
456 if ( substr( $line, 0, 1 ) !== '*' ) {
457 continue;
458 }
459
460 $wlEntry = substr($line, 1);
461 $wlEntry = trim($wlEntry);
462
463 wfDebug("Checking $ip against $wlEntry...");
464
465 # Is the IP in this range?
466 if (IP::isInRange( $ip, $wlEntry )) {
467 wfDebug(" IP $ip matches $wlEntry, not autoblocking\n");
468 #$autoblockip = null; # Don't autoblock a whitelisted IP.
469 return; #This /SHOULD/ introduce a dummy block - but
470 # I don't know a safe way to do so. -werdna
471 } else {
472 wfDebug( " No match\n" );
473 }
474 }
475
476 # It's okay to autoblock. Go ahead and create/insert the block.
477
478 $ipblock = Block::newFromDB( $autoblockip );
479 if ( $ipblock ) {
480 # If the user is already blocked. Then check if the autoblock would
481 # exceed the user block. If it would exceed, then do nothing, else
482 # prolong block time
483 if ($this->mExpiry &&
484 ($this->mExpiry < Block::getAutoblockExpiry($ipblock->mTimestamp))) {
485 return;
486 }
487 # Just update the timestamp
488 $ipblock->updateTimestamp();
489 return;
490 } else {
491 $ipblock = new Block;
492 }
493
494 # Make a new block object with the desired properties
495 wfDebug( "Autoblocking {$this->mAddress}@" . $autoblockip . "\n" );
496 $ipblock->mAddress = $autoblockip;
497 $ipblock->mUser = 0;
498 $ipblock->mBy = $this->mBy;
499 $ipblock->mReason = wfMsgForContent( 'autoblocker', $this->mAddress, $this->mReason );
500 $ipblock->mTimestamp = wfTimestampNow();
501 $ipblock->mAuto = 1;
502 $ipblock->mCreateAccount = $this->mCreateAccount;
503
504 # If the user is already blocked with an expiry date, we don't
505 # want to pile on top of that!
506 if($this->mExpiry) {
507 $ipblock->mExpiry = min ( $this->mExpiry, Block::getAutoblockExpiry( $this->mTimestamp ));
508 } else {
509 $ipblock->mExpiry = Block::getAutoblockExpiry( $this->mTimestamp );
510 }
511 # Insert it
512 return $ipblock->insert();
513 }
514
515 function deleteIfExpired()
516 {
517 $fname = 'Block::deleteIfExpired';
518 wfProfileIn( $fname );
519 if ( $this->isExpired() ) {
520 wfDebug( "Block::deleteIfExpired() -- deleting\n" );
521 $this->delete();
522 $retVal = true;
523 } else {
524 wfDebug( "Block::deleteIfExpired() -- not expired\n" );
525 $retVal = false;
526 }
527 wfProfileOut( $fname );
528 return $retVal;
529 }
530
531 function isExpired()
532 {
533 wfDebug( "Block::isExpired() checking current " . wfTimestampNow() . " vs $this->mExpiry\n" );
534 if ( !$this->mExpiry ) {
535 return false;
536 } else {
537 return wfTimestampNow() > $this->mExpiry;
538 }
539 }
540
541 function isValid()
542 {
543 return $this->mAddress != '';
544 }
545
546 function updateTimestamp()
547 {
548 if ( $this->mAuto ) {
549 $this->mTimestamp = wfTimestamp();
550 $this->mExpiry = Block::getAutoblockExpiry( $this->mTimestamp );
551
552 $dbw = wfGetDB( DB_MASTER );
553 $dbw->update( 'ipblocks',
554 array( /* SET */
555 'ipb_timestamp' => $dbw->timestamp($this->mTimestamp),
556 'ipb_expiry' => $dbw->timestamp($this->mExpiry),
557 ), array( /* WHERE */
558 'ipb_address' => $this->mAddress
559 ), 'Block::updateTimestamp'
560 );
561 }
562 }
563
564 /*
565 function getIntegerAddr()
566 {
567 return $this->mIntegerAddr;
568 }
569
570 function getNetworkBits()
571 {
572 return $this->mNetworkBits;
573 }*/
574
575 /**
576 * @return The blocker user ID.
577 */
578 public function getBy() {
579 return $this->mBy;
580 }
581
582 /**
583 * @return The blocker user name.
584 */
585 function getByName()
586 {
587 if ( $this->mByName === false ) {
588 $this->mByName = User::whoIs( $this->mBy );
589 }
590 return $this->mByName;
591 }
592
593 function forUpdate( $x = NULL ) {
594 return wfSetVar( $this->mForUpdate, $x );
595 }
596
597 function fromMaster( $x = NULL ) {
598 return wfSetVar( $this->mFromMaster, $x );
599 }
600
601 function getRedactedName() {
602 if ( $this->mAuto ) {
603 return '#' . $this->mId;
604 } else {
605 return $this->mAddress;
606 }
607 }
608
609 /**
610 * Encode expiry for DB
611 */
612 static function encodeExpiry( $expiry, $db ) {
613 if ( $expiry == '' || $expiry == Block::infinity() ) {
614 return Block::infinity();
615 } else {
616 return $db->timestamp( $expiry );
617 }
618 }
619
620 /**
621 * Decode expiry which has come from the DB
622 */
623 static function decodeExpiry( $expiry ) {
624 if ( $expiry == '' || $expiry == Block::infinity() ) {
625 return Block::infinity();
626 } else {
627 return wfTimestamp( TS_MW, $expiry );
628 }
629 }
630
631 static function getAutoblockExpiry( $timestamp )
632 {
633 global $wgAutoblockExpiry;
634 return wfTimestamp( TS_MW, wfTimestamp( TS_UNIX, $timestamp ) + $wgAutoblockExpiry );
635 }
636
637 static function normaliseRange( $range )
638 {
639 $parts = explode( '/', $range );
640 if ( count( $parts ) == 2 ) {
641 $shift = 32 - $parts[1];
642 $ipint = IP::toUnsigned( $parts[0] );
643 $ipint = $ipint >> $shift << $shift;
644 $newip = long2ip( $ipint );
645 $range = "$newip/{$parts[1]}";
646 }
647 return $range;
648 }
649
650 // For IPv6
651 static function normaliseRange6( $range ) {
652 $parts = explode( '/', $range );
653 if ( count( $parts ) == 2 ) {
654 $bits = $parts[1];
655 $ipint = IP::toUnsigned6( $parts[0] );
656 # Native 32 bit functions WONT work here!!!
657 # Convert to a padded binary number
658 $network = wfBaseConvert( $ipint, 10, 2, 128 );
659 # Truncate the last (128-$bits) bits and replace them with zeros
660 $network = str_pad( substr( $network, 0, $bits ), 128, 0, STR_PAD_RIGHT );
661 # Convert back to an integer
662 $network = wfBaseConvert( $network, 2, 10 );
663 # Reform octet address
664 $newip = IP::toOctet( $network );
665 $range = "$newip/{$parts[1]}";
666 }
667 return $range;
668 }
669
670 /**
671 * Purge expired blocks from the ipblocks table
672 */
673 static function purgeExpired() {
674 $dbw = wfGetDB( DB_MASTER );
675 $dbw->delete( 'ipblocks', array( 'ipb_expiry < ' . $dbw->addQuotes( $dbw->timestamp() ) ), __METHOD__ );
676 }
677
678 static function infinity() {
679 # This is a special keyword for timestamps in PostgreSQL, and
680 # works with CHAR(14) as well because "i" sorts after all numbers.
681 return 'infinity';
682
683 /*
684 static $infinity;
685 if ( !isset( $infinity ) ) {
686 $dbr = wfGetDB( DB_SLAVE );
687 $infinity = $dbr->bigTimestamp();
688 }
689 return $infinity;
690 */
691 }
692
693 }
694 ?>