X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FChangeTags.php;h=204df45d94e91c7e9b3700b8ddde3817743e5324;hb=38a42ed82346c9e5bca0dc31b5d8256c2d6a63f7;hp=cbbe67ef8a8e604e896ebb1ed373d88f64fd1333;hpb=dc77abf2864bfd00a75c7fa5aae739fa8e4228e2;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/ChangeTags.php b/includes/ChangeTags.php
index cbbe67ef8a..204df45d94 100644
--- a/includes/ChangeTags.php
+++ b/includes/ChangeTags.php
@@ -1,56 +1,110 @@
 <?php
-
-if (!defined( 'MEDIAWIKI' ))
-	die;
+/**
+ * Recent changes tagging.
+ *
+ * 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
+ */
 
 class ChangeTags {
+
+	/**
+	 * Creates HTML for the given tags
+	 *
+	 * @param $tags String: Comma-separated list of tags
+	 * @param $page String: A label for the type of action which is being displayed,
+	 *                     for example: 'history', 'contributions' or 'newpages'
+	 *
+	 * @return Array with two items: (html, classes)
+	 *            - html: String: HTML for displaying the tags (empty string when param $tags is empty)
+	 *            - classes: Array of strings: CSS classes used in the generated html, one class for each tag
+	 *
+	 */
 	static function formatSummaryRow( $tags, $page ) {
-		if (!$tags)
-			return array('',array());
+		if( !$tags )
+			return array( '', array() );
 
 		$classes = array();
-		
+
 		$tags = explode( ',', $tags );
 		$displayTags = array();
 		foreach( $tags as $tag ) {
-			$displayTags[] = self::tagDescription( $tag );
-			$classes[] = "mw-tag-$tag";
+			$displayTags[] = Xml::tags(
+				'span',
+				array( 'class' => 'mw-tag-marker ' .
+								Sanitizer::escapeClass( "mw-tag-marker-$tag" ) ),
+				self::tagDescription( $tag )
+			);
+			$classes[] = Sanitizer::escapeClass( "mw-tag-$tag" );
 		}
+		$markers = '(' . implode( ', ', $displayTags ) . ')';
+		$markers = Xml::tags( 'span', array( 'class' => 'mw-tag-markers' ), $markers );
 
-		return array( '(' . implode( ', ', $displayTags ) . ')', $classes );
+		return array( $markers, $classes );
 	}
 
+	/**
+	 * Get a short description for a tag
+	 *
+	 * @param $tag String: tag
+	 *
+	 * @return String: Short description of the tag from "mediawiki:tag-$tag" if this message exists,
+	 *                 html-escaped version of $tag otherwise
+	 */
 	static function tagDescription( $tag ) {
-		$msg = wfMsgExt( "tag-$tag", 'parseinline' );
-		if ( wfEmptyMsg( "tag-$tag", $msg ) ) {
-			return htmlspecialchars($tag);
-		}
-		return $msg;
+		$msg = wfMessage( "tag-$tag" );
+		return $msg->exists() ? $msg->parse() : htmlspecialchars( $tag );
 	}
 
-	## Basic utility method to add tags to a particular change, given its rc_id, rev_id and/or log_id.
-	static function addTags( $tags, $rc_id=null, $rev_id=null, $log_id=null, $params = null ) {
-		if ( !is_array($tags) ) {
+	/**
+	 * Add tags to a change given its rc_id, rev_id and/or log_id
+	 *
+	 * @param $tags String|Array: Tags to add to the change
+	 * @param $rc_id int: rc_id of the change to add the tags to
+	 * @param $rev_id int: rev_id of the change to add the tags to
+	 * @param $log_id int: log_id of the change to add the tags to
+	 * @param $params String: params to put in the ct_params field of tabel 'change_tag'
+	 *
+	 * @return bool: false if no changes are made, otherwise true
+	 *
+	 * @exception MWException when $rc_id, $rev_id and $log_id are all null
+	 */
+	static function addTags( $tags, $rc_id = null, $rev_id = null, $log_id = null, $params = null ) {
+		if ( !is_array( $tags ) ) {
 			$tags = array( $tags );
 		}
 
 		$tags = array_filter( $tags ); // Make sure we're submitting all tags...
 
-		if (!$rc_id && !$rev_id && !$log_id) {
+		if( !$rc_id && !$rev_id && !$log_id ) {
 			throw new MWException( "At least one of: RCID, revision ID, and log ID MUST be specified when adding a tag to a change!" );
 		}
 
 		$dbr = wfGetDB( DB_SLAVE );
 
 		// Might as well look for rcids and so on.
-		if (!$rc_id) {
+		if( !$rc_id ) {
 			$dbr = wfGetDB( DB_MASTER ); // Info might be out of date, somewhat fractionally, on slave.
-			if ($log_id) {
+			if( $log_id ) {
 				$rc_id = $dbr->selectField( 'recentchanges', 'rc_id', array( 'rc_logid' => $log_id ), __METHOD__ );
-			} elseif ($rev_id) {
+			} elseif( $rev_id ) {
 				$rc_id = $dbr->selectField( 'recentchanges', 'rc_id', array( 'rc_this_oldid' => $rev_id ), __METHOD__ );
 			}
-		} elseif (!$log_id && !$rev_id) {
+		} elseif( !$log_id && !$rev_id ) {
 			$dbr = wfGetDB( DB_MASTER ); // Info might be out of date, somewhat fractionally, on slave.
 			$log_id = $dbr->selectField( 'recentchanges', 'rc_logid', array( 'rc_id' => $rc_id ), __METHOD__ );
 			$rev_id = $dbr->selectField( 'recentchanges', 'rc_this_oldid', array( 'rc_id' => $rc_id ), __METHOD__ );
@@ -63,8 +117,8 @@ class ChangeTags {
 		$prevTags = $prevTags ? $prevTags : '';
 		$prevTags = array_filter( explode( ',', $prevTags ) );
 		$newTags = array_unique( array_merge( $prevTags, $tags ) );
-		sort($prevTags);
-		sort($newTags);
+		sort( $prevTags );
+		sort( $newTags );
 
 		if ( $prevTags == $newTags ) {
 			// No change.
@@ -72,15 +126,28 @@ class ChangeTags {
 		}
 
 		$dbw = wfGetDB( DB_MASTER );
-		$dbw->replace( 'tag_summary', array( 'ts_rev_id', 'ts_rc_id', 'ts_log_id' ),  array_filter( array_merge( $tsConds, array( 'ts_tags' => implode( ',', $newTags ) ) ) ), __METHOD__ );
+		$dbw->replace(
+			'tag_summary',
+			array( 'ts_rev_id', 'ts_rc_id', 'ts_log_id' ),
+			array_filter( array_merge( $tsConds, array( 'ts_tags' => implode( ',', $newTags ) ) ) ),
+			__METHOD__
+		);
 
 		// Insert the tags rows.
 		$tagsRows = array();
 		foreach( $tags as $tag ) { // Filter so we don't insert NULLs as zero accidentally.
-			$tagsRows[] = array_filter( array( 'ct_tag' => $tag, 'ct_rc_id' => $rc_id, 'ct_log_id' => $log_id, 'ct_rev_id' => $rev_id, 'ct_params' => $params ) );
+			$tagsRows[] = array_filter(
+				array(
+					'ct_tag' => $tag,
+					'ct_rc_id' => $rc_id,
+					'ct_log_id' => $log_id,
+					'ct_rev_id' => $rev_id,
+					'ct_params' => $params
+				)
+			);
 		}
 
-		$dbw->insert( 'change_tag', $tagsRows, __METHOD__, array('IGNORE') );
+		$dbw->insert( 'change_tag', $tagsRows, __METHOD__, array( 'IGNORE' ) );
 
 		return true;
 	}
@@ -89,35 +156,50 @@ class ChangeTags {
 	 * Applies all tags-related changes to a query.
 	 * Handles selecting tags, and filtering.
 	 * Needs $tables to be set up properly, so we can figure out which join conditions to use.
-	*/
-	static function modifyDisplayQuery( &$tables, &$fields,  &$conds, &$join_conds, $filter_tag = false ) {
-		global $wgRequest;
-		
-		if ($filter_tag === false) {
+	 *
+	 * @param $tables String|Array: Tabel names, see DatabaseBase::select
+	 * @param $fields String|Array: Fields used in query, see DatabaseBase::select
+	 * @param $conds String|Array: conditions used in query, see DatabaseBase::select
+	 * @param $join_conds Array: join conditions, see DatabaseBase::select
+	 * @param $options Array: options, see Database::select
+	 * @param $filter_tag String: tag to select on
+	 *
+	 * @exception MWException when unable to determine appropriate JOIN condition for tagging
+	 *
+	 */
+	static function modifyDisplayQuery( &$tables, &$fields,  &$conds,
+										&$join_conds, &$options, $filter_tag = false ) {
+		global $wgRequest, $wgUseTagFilter;
+
+		if( $filter_tag === false ) {
 			$filter_tag = $wgRequest->getVal( 'tagfilter' );
 		}
 
 		// Figure out which conditions can be done.
-		$join_field = '';
-		if ( in_array('recentchanges', $tables) ) {
+		if ( in_array( 'recentchanges', $tables ) ) {
 			$join_cond = 'rc_id';
-		} elseif( in_array('logging', $tables) ) {
+		} elseif( in_array( 'logging', $tables ) ) {
 			$join_cond = 'log_id';
-		} elseif ( in_array('revision', $tables) ) {
+		} elseif ( in_array( 'revision', $tables ) ) {
 			$join_cond = 'rev_id';
 		} else {
-			throw new MWException( "Unable to determine appropriate JOIN condition for tagging." );
+			throw new MWException( 'Unable to determine appropriate JOIN condition for tagging.' );
 		}
 
 		// JOIN on tag_summary
 		$tables[] = 'tag_summary';
 		$join_conds['tag_summary'] = array( 'LEFT JOIN', "ts_$join_cond=$join_cond" );
 		$fields[] = 'ts_tags';
-		
-		if ($filter_tag) {
+
+		if( $wgUseTagFilter && $filter_tag ) {
 			// Somebody wants to filter on a tag.
 			// Add an INNER JOIN on change_tag
 
+			// FORCE INDEX -- change_tags will almost ALWAYS be the correct query plan.
+			global $wgOldChangeTagsIndex;
+			$index = $wgOldChangeTagsIndex ? 'ct_tag' : 'change_tag_tag_id';
+			$options['USE INDEX'] = array( 'change_tag' => $index );
+			unset( $options['FORCE INDEX'] );
 			$tables[] = 'change_tag';
 			$join_conds['change_tag'] = array( 'INNER JOIN', "ct_$join_cond=$join_cond" );
 			$conds['ct_tag'] = $filter_tag;
@@ -125,49 +207,67 @@ class ChangeTags {
 	}
 
 	/**
-	 * If $fullForm is set to false, then it returns an array of (label, form).
-	 * If $fullForm is true, it returns an entire form.
+	 * Build a text box to select a change tag
+	 *
+	 * @param $selected String: tag to select by default
+	 * @param $fullForm Boolean:
+	 *        - if false, then it returns an array of (label, form).
+	 *        - if true, it returns an entire form around the selector.
+	 * @param $title Title object to send the form to.
+	 *        Used when, and only when $fullForm is true.
+	 * @return String or array:
+	 *        - if $fullForm is false: Array with
+	 *        - if $fullForm is true: String, html fragment
 	 */
-	static function buildTagFilterSelector( $selected='', $fullForm = false /* used to put a full form around the selector */ ) {
+	public static function buildTagFilterSelector( $selected='', $fullForm = false, Title $title = null ) {
+		global $wgUseTagFilter;
 
-		if ( !count( self::listDefinedTags() ) )
+		if ( !$wgUseTagFilter || !count( self::listDefinedTags() ) )
 			return $fullForm ? '' : array();
-	
-		global $wgTitle;
-		
-		$data = array( wfMsgExt( 'tag-filter', 'parseinline' ), Xml::input( 'tagfilter', 20, $selected ) );
 
-		if (!$fullForm) {
+		$data = array( Html::rawElement( 'label', array( 'for' => 'tagfilter' ), wfMsgExt( 'tag-filter', 'parseinline' ) ),
+			Xml::input( 'tagfilter', 20, $selected, array( 'class' => 'mw-tagfilter-input' ) ) );
+
+		if ( !$fullForm ) {
 			return $data;
 		}
 
-		$html = implode( '&nbsp;', $data );
+		$html = implode( '&#160;', $data );
 		$html .= "\n" . Xml::element( 'input', array( 'type' => 'submit', 'value' => wfMsg( 'tag-filter-submit' ) ) );
-		$html .= "\n" . Xml::hidden( 'title', $wgTitle-> getPrefixedText() );
-		$html = Xml::tags( 'form', array( 'action' => $wgTitle->getLocalURL(), 'method' => 'get' ), $html );
+		$html .= "\n" . Html::hidden( 'title', $title->getPrefixedText() );
+		$html = Xml::tags( 'form', array( 'action' => $title->getLocalURL(), 'class' => 'mw-tagfilter-form', 'method' => 'get' ), $html );
 
 		return $html;
 	}
 
-	/** Basically lists defined tags which count even if they aren't applied to anything */
+	/**
+	 * Basically lists defined tags which count even if they aren't applied to anything.
+	 * Tags on items in table 'change_tag' which are not (or no longer) in table 'valid_tag'
+	 * are not included.
+	 *
+	 * Tries memcached first.
+	 *
+	 * @return Array of strings: tags
+	 */
 	static function listDefinedTags() {
 		// Caching...
 		global $wgMemc;
 		$key = wfMemcKey( 'valid-tags' );
-
-		if ($tags = $wgMemc->get( $key ))
+		$tags = $wgMemc->get( $key );
+		if ( $tags ) {
 			return $tags;
-	
+		}
+
 		$emptyTags = array();
 
 		// Some DB stuff
 		$dbr = wfGetDB( DB_SLAVE );
 		$res = $dbr->select( 'valid_tag', 'vt_tag', array(), __METHOD__ );
-		while( $row = $res->fetchObject() ) {
+		foreach ( $res as $row ) {
 			$emptyTags[] = $row->vt_tag;
 		}
-		
-		wfRunHooks( 'ListDefinedTags', array(&$emptyTags) );
+
+		wfRunHooks( 'ListDefinedTags', array( &$emptyTags ) );
 
 		$emptyTags = array_filter( array_unique( $emptyTags ) );
 
@@ -175,4 +275,4 @@ class ChangeTags {
 		$wgMemc->set( $key, $emptyTags, 300 );
 		return $emptyTags;
 	}
-}
\ No newline at end of file
+}