From 478f45779f10450766b544eacce3f70b7e554cdf Mon Sep 17 00:00:00 2001
From: Aaron Schulz <aaron@users.mediawiki.org>
Date: Fri, 11 Dec 2009 06:57:37 +0000
Subject: [PATCH] (bug 20928) Added tri-state form for RevisionDelete when
 there are multiple items.

---
 includes/specials/SpecialRevisiondelete.php | 138 +++++++++++++++-----
 languages/messages/MessagesEn.php           |   7 +-
 2 files changed, 111 insertions(+), 34 deletions(-)

diff --git a/includes/specials/SpecialRevisiondelete.php b/includes/specials/SpecialRevisiondelete.php
index cc2a631d7c..f49e7458d0 100644
--- a/includes/specials/SpecialRevisiondelete.php
+++ b/includes/specials/SpecialRevisiondelete.php
@@ -181,6 +181,7 @@ class SpecialRevisionDelete extends UnlistedSpecialPage {
 		} else {
 			$this->showForm();
 		}
+		
 		$qc = $this->getLogQueryCond();
 		# Show relevant lines from the deletion log
 		$wgOut->addHTML( "<h2>" . htmlspecialchars( LogPage::logName( 'delete' ) ) . "</h2>\n" );
@@ -330,7 +331,6 @@ class SpecialRevisionDelete extends UnlistedSpecialPage {
 				$this->targetObj->getPrefixedText(), count( $this->ids ) );
 		}
 
-		$bitfields = 0;
 		$wgOut->addHTML( "<ul>" );
 
 		$where = $revObjs = array();
@@ -348,7 +348,6 @@ class SpecialRevisionDelete extends UnlistedSpecialPage {
 				$UserAllowed = false;
 			}
 			$numRevisions++;
-			$bitfields |= $item->getBits();
 			$wgOut->addHTML( $item->getHTML() );
 		}
 
@@ -370,7 +369,7 @@ class SpecialRevisionDelete extends UnlistedSpecialPage {
 					'action' => $this->getTitle()->getLocalUrl( array( 'action' => 'submit' ) ), 
 					'id' => 'mw-revdel-form-revisions' ) ) .
 				Xml::fieldset( wfMsg( 'revdelete-legend' ) ) .
-				$this->buildCheckBoxes( $bitfields ) .
+				$this->buildCheckBoxes() .
 				Xml::openElement( 'table' ) .
 				"<tr>\n" .
 					'<td class="mw-label">' .
@@ -438,20 +437,55 @@ class SpecialRevisionDelete extends UnlistedSpecialPage {
 	}
 	
 	/**
-	* @param $bitfields Interger: aggregate bitfield of all the bitfields
 	* @return String: HTML
 	*/
-	protected function buildCheckBoxes( $bitfields ) {
+	protected function buildCheckBoxes() {
+		global $wgRequest;
+		
 		$html = '<table>';
-		// FIXME: all items checked for just one rev are checked, even if not set for the others
-		foreach( $this->checks as $item ) {
-			list( $message, $name, $field ) = $item;
-			$innerHTML = Xml::checkLabel( wfMsg($message), $name, $name, $bitfields & $field );
-			if( $field == Revision::DELETED_RESTRICTED )
-				$innerHTML = "<b>$innerHTML</b>";
-			$line = Xml::tags( 'td', array( 'class' => 'mw-input' ), $innerHTML );
-			$html .= '<tr>' . $line . "</tr>\n";
+		// If there is just one item, use checkboxes
+		$list = $this->getList();
+		if( $list->length() == 1 ) {
+			$list->reset();
+			$bitfield = $list->current()->getBits(); // existing field
+			if( $this->submitClicked ) {
+				$bitfield = $this->extractBitfield( $this->extractBitParams($wgRequest), $bitfield );
+			}
+			foreach( $this->checks as $item ) {
+				list( $message, $name, $field ) = $item;
+				$innerHTML = Xml::checkLabel( wfMsg($message), $name, $name, $bitfield & $field );
+				if( $field == Revision::DELETED_RESTRICTED )
+					$innerHTML = "<b>$innerHTML</b>";
+				$line = Xml::tags( 'td', array( 'class' => 'mw-input' ), $innerHTML );
+				$html .= "<tr>$line</tr>\n";
+			}
+		// Otherwise, use tri-state radios
+		} else {
+			$html .= '<tr>';
+			$html .= '<th>'.wfMsgHtml('revdelete-radio-same').'</th><th>&nbsp;</th>';
+			$html .= '<th>'.wfMsgHtml('revdelete-radio-unset').'</th><th>&nbsp;</th>';
+			$html .= '<th>'.wfMsgHtml('revdelete-radio-set').'</th><th>&nbsp;</th>';
+			$html .= '<th></th></tr>';
+			foreach( $this->checks as $item ) {
+				list( $message, $name, $field ) = $item;
+				// If there are several items, use third state by default...
+				if( $this->submitClicked ) {
+					$selected = $wgRequest->getInt( $name, 0 /* unchecked */ );
+				} else {
+					$selected = -1; // use existing field
+				}
+				$line = '<td>' . Xml::radio( $name, -1, $selected == -1 ) . '</td><td>&nbsp;</td>';
+				$line .= '<td>' . Xml::radio( $name, 0, $selected == 0 ) . '</td><td>&nbsp;</td>';
+				$line .= '<td>' . Xml::radio( $name, 1, $selected == 1 ) . '</td><td>&nbsp;</td>';
+				$label = wfMsgHtml($message);
+				if( $field == Revision::DELETED_RESTRICTED ) {
+					$label = "<b>$label</b>";
+				}
+				$line .= "<td>$label</td>";
+				$html .= "<tr>$line</tr>\n";
+			}
 		}
+		
 		$html .= '</table>';
 		return $html;
 	}
@@ -467,7 +501,7 @@ class SpecialRevisionDelete extends UnlistedSpecialPage {
 			$wgOut->addWikiMsg( 'sessionfailure' );
 			return false;
 		}
-		$bitfield = $this->extractBitfield( $request );
+		$bitParams = $this->extractBitParams( $request );
 		$listReason = $request->getText( 'wpRevDeleteReasonList', 'other' ); // from dropdown
 		$comment = $listReason;
 		if( $comment != 'other' && $this->otherReason != '' ) {
@@ -477,12 +511,12 @@ class SpecialRevisionDelete extends UnlistedSpecialPage {
 			$comment = $this->otherReason;
 		}
 		# Can the user set this field?
-		if( $bitfield & Revision::DELETED_RESTRICTED && !$wgUser->isAllowed('suppressrevision') ) {
+		if( $bitParams[Revision::DELETED_RESTRICTED]==1 && !$wgUser->isAllowed('suppressrevision') ) {
 			$wgOut->permissionRequired( 'suppressrevision' );
 			return false;
 		}
 		# If the save went through, go to success message...
-		$status = $this->save( $bitfield, $comment, $this->targetObj );
+		$status = $this->save( $bitParams, $comment, $this->targetObj );
 		if ( $status->isGood() ) {
 			$this->success();
 			return true;
@@ -515,32 +549,52 @@ class SpecialRevisionDelete extends UnlistedSpecialPage {
 	}
 
 	/**
-	 * Put together a rev_deleted bitfield from the submitted checkboxes
+	 * Put together an array that contains -1, 0, or the *_deleted const for each bit
 	 * @param $request WebRequest
-	 * @return Integer
+	 * @return array
 	 */
-	protected function extractBitfield( $request ) {
-		$bitfield = 0;
+	protected function extractBitParams( $request ) {
+		$bitfield = array();
 		foreach( $this->checks as $item ) {
 			list( /* message */ , $name, $field ) = $item;
-			if( $request->getCheck( $name ) ) {
-				$bitfield |= $field;
+			$val = $request->getInt( $name, 0 /* unchecked */ );
+			if( $val < -1 || $val > 1) {
+				$val = -1; // -1 for existing value
 			}
+			$bitfield[$field] = $val;
+		}
+		if( !isset($bitfield[Revision::DELETED_RESTRICTED]) ) {
+			$bitfield[Revision::DELETED_RESTRICTED] = 0;
 		}
 		return $bitfield;
 	}
+	
+	/**
+	 * Put together a rev_deleted bitfield
+	 * @param $bitPars array extractBitParams() params
+	 * @param $oldfield int current bitfield
+	 * @return array
+	 */
+	public static function extractBitfield( $bitPars, $oldfield ) {
+		// Build the actual new rev_deleted bitfield
+		$newBits = 0;
+		foreach( $bitPars as $const => $val ) {
+			if( $val == 1 ) {
+				$newBits |= $const; // $const is the *_deleted const
+			} else if( $val == -1 ) {
+				$newBits |= ($oldfield & $const); // use existing
+			}
+		}
+		return $newBits;
+	}
 
 	/**
 	 * Do the write operations. Simple wrapper for RevDel_*List::setVisibility().
 	 */
 	protected function save( $bitfield, $reason, $title ) {
-		// Don't allow simply locking the interface for no reason
-		if( $bitfield == Revision::DELETED_RESTRICTED ) {
-			return Status::newFatal( 'revdelete-only-restricted' );
-		}
-		return $this->getList()->setVisibility( array(
-			'value' => $bitfield,
-			'comment' => $reason ) );
+		return $this->getList()->setVisibility(
+			array( 'value' => $bitfield, 'comment' => $reason )
+		);
 	}
 }
 
@@ -711,7 +765,7 @@ abstract class RevDel_List {
 	 * @return Status
 	 */
 	public function setVisibility( $params ) {
-		$newBits = $params['value'];
+		$bitPars = $params['value'];
 		$comment = $params['comment'];
 
 		$this->res = false;
@@ -728,8 +782,10 @@ abstract class RevDel_List {
 			$item = $this->current();
 			unset( $missing[ $item->getId() ] );
 
-			// Make error messages less vague
 			$oldBits = $item->getBits();
+			// Build the actual new rev_deleted bitfield
+			$newBits = SpecialRevisionDelete::extractBitfield( $bitPars, $oldBits );
+
 			if ( $oldBits == $newBits ) {
 				$status->warning( 'revdelete-no-change', $item->formatDate(), $item->formatTime() );
 				$status->failCount++;
@@ -750,11 +806,18 @@ abstract class RevDel_List {
 			}
 			if ( !$item->canView() ) {
 				// Cannot access this revision
-				$msg = $opType == 'show' ? 'revdelete-show-no-access' : 'revdelete-modify-no-access';
+				$msg = ($opType == 'show') ?
+					'revdelete-show-no-access' : 'revdelete-modify-no-access';
 				$status->error( $msg, $item->formatDate(), $item->formatTime() );
 				$status->failCount++;
 				continue;
 			}
+			// Cannot just "hide from Sysops" without hiding any fields
+			if( $newBits == Revision::DELETED_RESTRICTED ) {
+				$status->warning( 'revdelete-only-restricted', $item->formatDate(), $item->formatTime() );
+				$status->failCount++;
+				continue;
+			} 
 
 			// Update the revision
 			$ok = $item->setBits( $newBits );
@@ -920,6 +983,17 @@ abstract class RevDel_List {
 		$this->initCurrent();
 		return $this->current;
 	}
+	
+	/**
+	 * Get the number of items in the list.
+	 */
+	public function length() {
+		if( !$this->res ) {
+			return 0;
+		} else {
+			return $this->res->numRows();
+		}
+	}
 
 	/**
 	 * Clear any data structures needed for doPreCommitUpdates() and doPostCommitUpdates()
diff --git a/languages/messages/MessagesEn.php b/languages/messages/MessagesEn.php
index aa9b7cf4b6..b643e24665 100644
--- a/languages/messages/MessagesEn.php
+++ b/languages/messages/MessagesEn.php
@@ -1477,12 +1477,15 @@ Other administrators on {{SITENAME}} will still be able to access the hidden con
 *: ''home addresses and telephone numbers, social security numbers, etc.''",
 'revdelete-legend'            => 'Set visibility restrictions',
 'revdelete-hide-text'         => 'Hide revision text',
+'revdelete-hide-image'        => 'Hide file content',
 'revdelete-hide-name'         => 'Hide action and target',
 'revdelete-hide-comment'      => 'Hide edit comment',
 'revdelete-hide-user'         => "Hide editor's username/IP address",
 'revdelete-hide-restricted'   => 'Suppress data from administrators as well as others',
+'revdelete-radio-same'        => '(leave)',
+'revdelete-radio-set'         => 'Yes',
+'revdelete-radio-unset'       => 'No',
 'revdelete-suppress'          => 'Suppress data from administrators as well as others',
-'revdelete-hide-image'        => 'Hide file content',
 'revdelete-unsuppress'        => 'Remove restrictions on restored revisions',
 'revdelete-log'               => 'Reason for deletion:',
 'revdelete-submit'            => 'Apply to selected {{PLURAL:$1|revision|revisions}}',
@@ -1516,7 +1519,7 @@ You do not have access to it.',
 'revdelete-no-change'         => "'''Warning:''' the item dated $2, $1 already had the requested visibility settings.",
 'revdelete-concurrent-change' => 'Error modifying the item dated $2, $1: its status appears to have been changed by someone else while you attempted to modify it.
 Please check the logs.',
-'revdelete-only-restricted'   => 'You cannot suppress items from view by administrators without also selecting one of the other suppression options.',
+'revdelete-only-restricted'   => 'Error hiding the item dated $2, $1: you cannot suppress items from view by administrators without also selecting one of the other visibility options.',
 'revdelete-reason-dropdown'   => '*Common delete reasons
 ** Copyright violation
 ** Inappropriate personal information
-- 
2.20.1