From: umherirrender Date: Fri, 8 Aug 2014 14:05:33 +0000 (+0200) Subject: Split RevisionDeleteAbstracts.php to separate files X-Git-Tag: 1.31.0-rc.0~14351^2 X-Git-Url: http://git.cyclocoop.org//%27http:/ie7-js.googlecode.com/svn/test/index.html/%27?a=commitdiff_plain;h=fbba43358e3114f9845a127bd57da94ace2a2520;p=lhc%2Fweb%2Fwiklou.git Split RevisionDeleteAbstracts.php to separate files Same as I244a66fe19c089df4bcabcf745536d99b2103bc4 Change-Id: I90cea070a8e24d82f0675f122c79326988351e08 --- diff --git a/includes/AutoLoader.php b/includes/AutoLoader.php index f7f4c59528..38e92b6059 100644 --- a/includes/AutoLoader.php +++ b/includes/AutoLoader.php @@ -893,8 +893,8 @@ $wgAutoloadLocalClasses = array( 'RevDelArchiveList' => 'includes/revisiondelete/RevDelArchiveList.php', 'RevDelFileItem' => 'includes/revisiondelete/RevDelFileItem.php', 'RevDelFileList' => 'includes/revisiondelete/RevDelFileList.php', - 'RevDelItem' => 'includes/revisiondelete/RevisionDeleteAbstracts.php', - 'RevDelList' => 'includes/revisiondelete/RevisionDeleteAbstracts.php', + 'RevDelItem' => 'includes/revisiondelete/RevDelItem.php', + 'RevDelList' => 'includes/revisiondelete/RevDelList.php', 'RevDelLogItem' => 'includes/revisiondelete/RevDelLogItem.php', 'RevDelLogList' => 'includes/revisiondelete/RevDelLogList.php', 'RevDelRevisionItem' => 'includes/revisiondelete/RevDelRevisionItem.php', diff --git a/includes/revisiondelete/RevDelItem.php b/includes/revisiondelete/RevDelItem.php new file mode 100644 index 0000000000..ebdbf3a8ac --- /dev/null +++ b/includes/revisiondelete/RevDelItem.php @@ -0,0 +1,62 @@ +ids = $ids; + } + + /** + * Get the DB field name associated with the ID list. + * This used to populate the log_search table for finding log entries. + * Override this function. + * @return string|null + */ + public static function getRelationType() { + return null; + } + + /** + * Get the user right required for this list type + * Override this function. + * @since 1.22 + * @return string|null + */ + public static function getRestriction() { + return null; + } + + /** + * Get the revision deletion constant for this list type + * Override this function. + * @since 1.22 + * @return int|null + */ + public static function getRevdelConstant() { + return null; + } + + /** + * Suggest a target for the revision deletion + * Optionally override this function. + * @since 1.22 + * @param Title|null $target User-supplied target + * @param array $ids + * @return Title|null + */ + public static function suggestTarget( $target, array $ids ) { + return $target; + } + + /** + * Set the visibility for the revisions in this list. Logging and + * transactions are done here. + * + * @param array $params Associative array of parameters. Members are: + * value: The integer value to set the visibility to + * comment: The log comment. + * perItemStatus: Set if you want per-item status reports + * @return Status + * @since 1.23 Added 'perItemStatus' param + */ + public function setVisibility( $params ) { + $bitPars = $params['value']; + $comment = $params['comment']; + $perItemStatus = isset( $params['perItemStatus'] ) ? $params['perItemStatus'] : false; + + $this->res = false; + $dbw = wfGetDB( DB_MASTER ); + $this->doQuery( $dbw ); + $dbw->begin( __METHOD__ ); + $status = Status::newGood(); + $missing = array_flip( $this->ids ); + $this->clearFileOps(); + $idsForLog = array(); + $authorIds = $authorIPs = array(); + + if ( $perItemStatus ) { + $status->itemStatuses = array(); + } + + // @codingStandardsIgnoreStart Generic.CodeAnalysis.ForLoopWithTestFunctionCall.NotAllowed + for ( $this->reset(); $this->current(); $this->next() ) { + // @codingStandardsIgnoreEnd + $item = $this->current(); + unset( $missing[$item->getId()] ); + + if ( $perItemStatus ) { + $itemStatus = Status::newGood(); + $status->itemStatuses[$item->getId()] = $itemStatus; + } else { + $itemStatus = $status; + } + + $oldBits = $item->getBits(); + // Build the actual new rev_deleted bitfield + $newBits = RevisionDeleter::extractBitfield( $bitPars, $oldBits ); + + if ( $oldBits == $newBits ) { + $itemStatus->warning( 'revdelete-no-change', $item->formatDate(), $item->formatTime() ); + $status->failCount++; + continue; + } elseif ( $oldBits == 0 && $newBits != 0 ) { + $opType = 'hide'; + } elseif ( $oldBits != 0 && $newBits == 0 ) { + $opType = 'show'; + } else { + $opType = 'modify'; + } + + if ( $item->isHideCurrentOp( $newBits ) ) { + // Cannot hide current version text + $itemStatus->error( 'revdelete-hide-current', $item->formatDate(), $item->formatTime() ); + $status->failCount++; + continue; + } + if ( !$item->canView() ) { + // Cannot access this revision + $msg = ( $opType == 'show' ) ? + 'revdelete-show-no-access' : 'revdelete-modify-no-access'; + $itemStatus->error( $msg, $item->formatDate(), $item->formatTime() ); + $status->failCount++; + continue; + } + // Cannot just "hide from Sysops" without hiding any fields + if ( $newBits == Revision::DELETED_RESTRICTED ) { + $itemStatus->warning( 'revdelete-only-restricted', $item->formatDate(), $item->formatTime() ); + $status->failCount++; + continue; + } + + // Update the revision + $ok = $item->setBits( $newBits ); + + if ( $ok ) { + $idsForLog[] = $item->getId(); + $status->successCount++; + if ( $item->getAuthorId() > 0 ) { + $authorIds[] = $item->getAuthorId(); + } elseif ( IP::isIPAddress( $item->getAuthorName() ) ) { + $authorIPs[] = $item->getAuthorName(); + } + } else { + $itemStatus->error( 'revdelete-concurrent-change', $item->formatDate(), $item->formatTime() ); + $status->failCount++; + } + } + + // Handle missing revisions + foreach ( $missing as $id => $unused ) { + if ( $perItemStatus ) { + $status->itemStatuses[$id] = Status::newFatal( 'revdelete-modify-missing', $id ); + } else { + $status->error( 'revdelete-modify-missing', $id ); + } + $status->failCount++; + } + + if ( $status->successCount == 0 ) { + $dbw->rollback( __METHOD__ ); + return $status; + } + + // Save success count + $successCount = $status->successCount; + + // Move files, if there are any + $status->merge( $this->doPreCommitUpdates() ); + if ( !$status->isOK() ) { + // Fatal error, such as no configured archive directory + $dbw->rollback( __METHOD__ ); + return $status; + } + + // Log it + $this->updateLog( array( + 'title' => $this->title, + 'count' => $successCount, + 'newBits' => $newBits, + 'oldBits' => $oldBits, + 'comment' => $comment, + 'ids' => $idsForLog, + 'authorIds' => $authorIds, + 'authorIPs' => $authorIPs + ) ); + $dbw->commit( __METHOD__ ); + + // Clear caches + $status->merge( $this->doPostCommitUpdates() ); + return $status; + } + + /** + * Reload the list data from the master DB. This can be done after setVisibility() + * to allow $item->getHTML() to show the new data. + */ + function reloadFromMaster() { + $dbw = wfGetDB( DB_MASTER ); + $this->res = $this->doQuery( $dbw ); + } + + /** + * Record a log entry on the action + * @param array $params Associative array of parameters: + * newBits: The new value of the *_deleted bitfield + * oldBits: The old value of the *_deleted bitfield. + * title: The target title + * ids: The ID list + * comment: The log comment + * authorsIds: The array of the user IDs of the offenders + * authorsIPs: The array of the IP/anon user offenders + * @throws MWException + */ + protected function updateLog( $params ) { + // Get the URL param's corresponding DB field + $field = RevisionDeleter::getRelationType( $this->getType() ); + if ( !$field ) { + throw new MWException( "Bad log URL param type!" ); + } + // Put things hidden from sysops in the oversight log + if ( ( $params['newBits'] | $params['oldBits'] ) & $this->getSuppressBit() ) { + $logType = 'suppress'; + } else { + $logType = 'delete'; + } + // Add params for effected page and ids + $logParams = $this->getLogParams( $params ); + // Actually add the deletion log entry + $log = new LogPage( $logType ); + $logid = $log->addEntry( $this->getLogAction(), $params['title'], + $params['comment'], $logParams, $this->getUser() ); + // Allow for easy searching of deletion log items for revision/log items + $log->addRelations( $field, $params['ids'], $logid ); + $log->addRelations( 'target_author_id', $params['authorIds'], $logid ); + $log->addRelations( 'target_author_ip', $params['authorIPs'], $logid ); + } + + /** + * Get the log action for this list type + * @return string + */ + public function getLogAction() { + return 'revision'; + } + + /** + * Get log parameter array. + * @param array $params Associative array of log parameters, same as updateLog() + * @return array + */ + public function getLogParams( $params ) { + return array( + $this->getType(), + implode( ',', $params['ids'] ), + "ofield={$params['oldBits']}", + "nfield={$params['newBits']}" + ); + } + + /** + * Clear any data structures needed for doPreCommitUpdates() and doPostCommitUpdates() + * STUB + */ + public function clearFileOps() { + } + + /** + * A hook for setVisibility(): do batch updates pre-commit. + * STUB + * @return Status + */ + public function doPreCommitUpdates() { + return Status::newGood(); + } + + /** + * A hook for setVisibility(): do any necessary updates post-commit. + * STUB + * @return Status + */ + public function doPostCommitUpdates() { + return Status::newGood(); + } + + /** + * Get the integer value of the flag used for suppression + */ + abstract public function getSuppressBit(); +} diff --git a/includes/revisiondelete/RevisionDeleteAbstracts.php b/includes/revisiondelete/RevisionDeleteAbstracts.php deleted file mode 100644 index e92a53329f..0000000000 --- a/includes/revisiondelete/RevisionDeleteAbstracts.php +++ /dev/null @@ -1,357 +0,0 @@ -ids = $ids; - } - - /** - * Get the DB field name associated with the ID list. - * This used to populate the log_search table for finding log entries. - * Override this function. - * @return string|null - */ - public static function getRelationType() { - return null; - } - - /** - * Get the user right required for this list type - * Override this function. - * @since 1.22 - * @return string|null - */ - public static function getRestriction() { - return null; - } - - /** - * Get the revision deletion constant for this list type - * Override this function. - * @since 1.22 - * @return int|null - */ - public static function getRevdelConstant() { - return null; - } - - /** - * Suggest a target for the revision deletion - * Optionally override this function. - * @since 1.22 - * @param Title|null $target User-supplied target - * @param array $ids - * @return Title|null - */ - public static function suggestTarget( $target, array $ids ) { - return $target; - } - - /** - * Set the visibility for the revisions in this list. Logging and - * transactions are done here. - * - * @param array $params Associative array of parameters. Members are: - * value: The integer value to set the visibility to - * comment: The log comment. - * perItemStatus: Set if you want per-item status reports - * @return Status - * @since 1.23 Added 'perItemStatus' param - */ - public function setVisibility( $params ) { - $bitPars = $params['value']; - $comment = $params['comment']; - $perItemStatus = isset( $params['perItemStatus'] ) ? $params['perItemStatus'] : false; - - $this->res = false; - $dbw = wfGetDB( DB_MASTER ); - $this->doQuery( $dbw ); - $dbw->begin( __METHOD__ ); - $status = Status::newGood(); - $missing = array_flip( $this->ids ); - $this->clearFileOps(); - $idsForLog = array(); - $authorIds = $authorIPs = array(); - - if ( $perItemStatus ) { - $status->itemStatuses = array(); - } - - // @codingStandardsIgnoreStart Generic.CodeAnalysis.ForLoopWithTestFunctionCall.NotAllowed - for ( $this->reset(); $this->current(); $this->next() ) { - // @codingStandardsIgnoreEnd - $item = $this->current(); - unset( $missing[$item->getId()] ); - - if ( $perItemStatus ) { - $itemStatus = Status::newGood(); - $status->itemStatuses[$item->getId()] = $itemStatus; - } else { - $itemStatus = $status; - } - - $oldBits = $item->getBits(); - // Build the actual new rev_deleted bitfield - $newBits = RevisionDeleter::extractBitfield( $bitPars, $oldBits ); - - if ( $oldBits == $newBits ) { - $itemStatus->warning( 'revdelete-no-change', $item->formatDate(), $item->formatTime() ); - $status->failCount++; - continue; - } elseif ( $oldBits == 0 && $newBits != 0 ) { - $opType = 'hide'; - } elseif ( $oldBits != 0 && $newBits == 0 ) { - $opType = 'show'; - } else { - $opType = 'modify'; - } - - if ( $item->isHideCurrentOp( $newBits ) ) { - // Cannot hide current version text - $itemStatus->error( 'revdelete-hide-current', $item->formatDate(), $item->formatTime() ); - $status->failCount++; - continue; - } - if ( !$item->canView() ) { - // Cannot access this revision - $msg = ( $opType == 'show' ) ? - 'revdelete-show-no-access' : 'revdelete-modify-no-access'; - $itemStatus->error( $msg, $item->formatDate(), $item->formatTime() ); - $status->failCount++; - continue; - } - // Cannot just "hide from Sysops" without hiding any fields - if ( $newBits == Revision::DELETED_RESTRICTED ) { - $itemStatus->warning( 'revdelete-only-restricted', $item->formatDate(), $item->formatTime() ); - $status->failCount++; - continue; - } - - // Update the revision - $ok = $item->setBits( $newBits ); - - if ( $ok ) { - $idsForLog[] = $item->getId(); - $status->successCount++; - if ( $item->getAuthorId() > 0 ) { - $authorIds[] = $item->getAuthorId(); - } elseif ( IP::isIPAddress( $item->getAuthorName() ) ) { - $authorIPs[] = $item->getAuthorName(); - } - } else { - $itemStatus->error( 'revdelete-concurrent-change', $item->formatDate(), $item->formatTime() ); - $status->failCount++; - } - } - - // Handle missing revisions - foreach ( $missing as $id => $unused ) { - if ( $perItemStatus ) { - $status->itemStatuses[$id] = Status::newFatal( 'revdelete-modify-missing', $id ); - } else { - $status->error( 'revdelete-modify-missing', $id ); - } - $status->failCount++; - } - - if ( $status->successCount == 0 ) { - $dbw->rollback( __METHOD__ ); - return $status; - } - - // Save success count - $successCount = $status->successCount; - - // Move files, if there are any - $status->merge( $this->doPreCommitUpdates() ); - if ( !$status->isOK() ) { - // Fatal error, such as no configured archive directory - $dbw->rollback( __METHOD__ ); - return $status; - } - - // Log it - $this->updateLog( array( - 'title' => $this->title, - 'count' => $successCount, - 'newBits' => $newBits, - 'oldBits' => $oldBits, - 'comment' => $comment, - 'ids' => $idsForLog, - 'authorIds' => $authorIds, - 'authorIPs' => $authorIPs - ) ); - $dbw->commit( __METHOD__ ); - - // Clear caches - $status->merge( $this->doPostCommitUpdates() ); - return $status; - } - - /** - * Reload the list data from the master DB. This can be done after setVisibility() - * to allow $item->getHTML() to show the new data. - */ - function reloadFromMaster() { - $dbw = wfGetDB( DB_MASTER ); - $this->res = $this->doQuery( $dbw ); - } - - /** - * Record a log entry on the action - * @param array $params Associative array of parameters: - * newBits: The new value of the *_deleted bitfield - * oldBits: The old value of the *_deleted bitfield. - * title: The target title - * ids: The ID list - * comment: The log comment - * authorsIds: The array of the user IDs of the offenders - * authorsIPs: The array of the IP/anon user offenders - * @throws MWException - */ - protected function updateLog( $params ) { - // Get the URL param's corresponding DB field - $field = RevisionDeleter::getRelationType( $this->getType() ); - if ( !$field ) { - throw new MWException( "Bad log URL param type!" ); - } - // Put things hidden from sysops in the oversight log - if ( ( $params['newBits'] | $params['oldBits'] ) & $this->getSuppressBit() ) { - $logType = 'suppress'; - } else { - $logType = 'delete'; - } - // Add params for effected page and ids - $logParams = $this->getLogParams( $params ); - // Actually add the deletion log entry - $log = new LogPage( $logType ); - $logid = $log->addEntry( $this->getLogAction(), $params['title'], - $params['comment'], $logParams, $this->getUser() ); - // Allow for easy searching of deletion log items for revision/log items - $log->addRelations( $field, $params['ids'], $logid ); - $log->addRelations( 'target_author_id', $params['authorIds'], $logid ); - $log->addRelations( 'target_author_ip', $params['authorIPs'], $logid ); - } - - /** - * Get the log action for this list type - * @return string - */ - public function getLogAction() { - return 'revision'; - } - - /** - * Get log parameter array. - * @param array $params Associative array of log parameters, same as updateLog() - * @return array - */ - public function getLogParams( $params ) { - return array( - $this->getType(), - implode( ',', $params['ids'] ), - "ofield={$params['oldBits']}", - "nfield={$params['newBits']}" - ); - } - - /** - * Clear any data structures needed for doPreCommitUpdates() and doPostCommitUpdates() - * STUB - */ - public function clearFileOps() { - } - - /** - * A hook for setVisibility(): do batch updates pre-commit. - * STUB - * @return Status - */ - public function doPreCommitUpdates() { - return Status::newGood(); - } - - /** - * A hook for setVisibility(): do any necessary updates post-commit. - * STUB - * @return Status - */ - public function doPostCommitUpdates() { - return Status::newGood(); - } - - /** - * Get the integer value of the flag used for suppression - */ - abstract public function getSuppressBit(); -} - -/** - * Abstract base class for deletable items - */ -abstract class RevDelItem extends RevisionItemBase { - /** - * Returns true if the item is "current", and the operation to set the given - * bits can't be executed for that reason - * STUB - * @param int $newBits - * @return bool - */ - public function isHideCurrentOp( $newBits ) { - return false; - } - - /** - * Get the current deletion bitfield value - */ - abstract public function getBits(); - - /** - * Set the visibility of the item. This should do any necessary DB queries. - * - * The DB update query should have a condition which forces it to only update - * if the value in the DB matches the value fetched earlier with the SELECT. - * If the update fails because it did not match, the function should return - * false. This prevents concurrency problems. - * - * @param int $newBits - * @return bool Success - */ - abstract public function setBits( $newBits ); - - /** - * Get the return information about the revision for the API - * @since 1.23 - * @param ApiResult $result API result object - * @return array Data for the API result - */ - abstract public function getApiData( ApiResult $result ); -}