includes/ChangeTags.php

   1 <?php
   2
   3 if (!defined( 'MEDIAWIKI' ))
   4         die;
   5
   6 class ChangeTags {
   7         static function formatSummaryRow( $tags, $page ) {
   8                 if (!$tags)
   9                         return array('',array());
  10
  11                 $classes = array();
  12
  13                 $tags = explode( ',', $tags );
  14                 $displayTags = array();
  15                 foreach( $tags as $tag ) {
  16                         $displayTags[] = Xml::tags( 'span',
  17                                                                 array( 'class' => "mw-tag-marker mw-tag-marker-$tag" ),
  18                                                                 self::tagDescription( $tag ) );
  19                         $classes[] = Sanitizer::escapeClass( "mw-tag-$tag" );
  20                 }
  21
  22                 $markers = '(' . implode( ', ', $displayTags ) . ')';
  23                 $markers = Xml::tags( 'span', array( 'class' => 'mw-tag-markers' ), $markers );
  24                 return array( $markers, $classes );
  25         }
  26
  27         static function tagDescription( $tag ) {
  28                 $msg = wfMsgExt( "tag-$tag", 'parseinline' );
  29                 if ( wfEmptyMsg( "tag-$tag", $msg ) ) {
  30                         return htmlspecialchars($tag);
  31                 }
  32                 return $msg;
  33         }
  34
  35         ## Basic utility method to add tags to a particular change, given its rc_id, rev_id and/or log_id.
  36         static function addTags( $tags, $rc_id=null, $rev_id=null, $log_id=null, $params = null ) {
  37                 if ( !is_array($tags) ) {
  38                         $tags = array( $tags );
  39                 }
  40
  41                 $tags = array_filter( $tags ); // Make sure we're submitting all tags...
  42
  43                 if (!$rc_id && !$rev_id && !$log_id) {
  44                         throw new MWException( "At least one of: RCID, revision ID, and log ID MUST be specified when adding a tag to a change!" );
  45                 }
  46
  47                 $dbr = wfGetDB( DB_SLAVE );
  48
  49                 // Might as well look for rcids and so on.
  50                 if (!$rc_id) {
  51                         $dbr = wfGetDB( DB_MASTER ); // Info might be out of date, somewhat fractionally, on slave.
  52                         if ($log_id) {
  53                                 $rc_id = $dbr->selectField( 'recentchanges', 'rc_id', array( 'rc_logid' => $log_id ), __METHOD__ );
  54                         } elseif ($rev_id) {
  55                                 $rc_id = $dbr->selectField( 'recentchanges', 'rc_id', array( 'rc_this_oldid' => $rev_id ), __METHOD__ );
  56                         }
  57                 } elseif (!$log_id && !$rev_id) {
  58                         $dbr = wfGetDB( DB_MASTER ); // Info might be out of date, somewhat fractionally, on slave.
  59                         $log_id = $dbr->selectField( 'recentchanges', 'rc_logid', array( 'rc_id' => $rc_id ), __METHOD__ );
  60                         $rev_id = $dbr->selectField( 'recentchanges', 'rc_this_oldid', array( 'rc_id' => $rc_id ), __METHOD__ );
  61                 }
  62
  63                 $tsConds = array_filter( array( 'ts_rc_id' => $rc_id, 'ts_rev_id' => $rev_id, 'ts_log_id' => $log_id ) );
  64
  65                 ## Update the summary row.
  66                 $prevTags = $dbr->selectField( 'tag_summary', 'ts_tags', $tsConds, __METHOD__ );
  67                 $prevTags = $prevTags ? $prevTags : '';
  68                 $prevTags = array_filter( explode( ',', $prevTags ) );
  69                 $newTags = array_unique( array_merge( $prevTags, $tags ) );
  70                 sort($prevTags);
  71                 sort($newTags);
  72
  73                 if ( $prevTags == $newTags ) {
  74                         // No change.
  75                         return false;
  76                 }
  77
  78                 $dbw = wfGetDB( DB_MASTER );
  79                 $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__ );
  80
  81                 // Insert the tags rows.
  82                 $tagsRows = array();
  83                 foreach( $tags as $tag ) { // Filter so we don't insert NULLs as zero accidentally.
  84                         $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 ) );
  85                 }
  86
  87                 $dbw->insert( 'change_tag', $tagsRows, __METHOD__, array('IGNORE') );
  88
  89                 return true;
  90         }
  91
  92         /**
  93          * Applies all tags-related changes to a query.
  94          * Handles selecting tags, and filtering.
  95          * Needs $tables to be set up properly, so we can figure out which join conditions to use.
  96         */
  97         static function modifyDisplayQuery( &$tables, &$fields,  &$conds,
  98                                                                                 &$join_conds, &$options, $filter_tag = false ) {
  99                 global $wgRequest, $wgUseTagFilter;
 100
 101                 if ($filter_tag === false) {
 102                         $filter_tag = $wgRequest->getVal( 'tagfilter' );
 103                 }
 104
 105                 // Figure out which conditions can be done.
 106                 $join_field = '';
 107                 if ( in_array('recentchanges', $tables) ) {
 108                         $join_cond = 'rc_id';
 109                 } elseif( in_array('logging', $tables) ) {
 110                         $join_cond = 'log_id';
 111                 } elseif ( in_array('revision', $tables) ) {
 112                         $join_cond = 'rev_id';
 113                 } else {
 114                         throw new MWException( "Unable to determine appropriate JOIN condition for tagging." );
 115                 }
 116
 117                 // JOIN on tag_summary
 118                 $tables[] = 'tag_summary';
 119                 $join_conds['tag_summary'] = array( 'LEFT JOIN', "ts_$join_cond=$join_cond" );
 120                 $fields[] = 'ts_tags';
 121
 122                 if ($wgUseTagFilter && $filter_tag) {
 123                         // Somebody wants to filter on a tag.
 124                         // Add an INNER JOIN on change_tag
 125
 126                         // FORCE INDEX -- change_tags will almost ALWAYS be the correct query plan.
 127                         $options['USE INDEX'] = array( 'change_tag' => 'change_tag_tag_id' );
 128                         unset( $options['FORCE INDEX'] );
 129                         $tables[] = 'change_tag';
 130                         $join_conds['change_tag'] = array( 'INNER JOIN', "ct_$join_cond=$join_cond" );
 131                         $conds['ct_tag'] = $filter_tag;
 132                 }
 133         }
 134
 135         /**
 136          * If $fullForm is set to false, then it returns an array of (label, form).
 137          * If $fullForm is true, it returns an entire form.
 138          */
 139         static function buildTagFilterSelector( $selected='', $fullForm = false /* used to put a full form around the selector */ ) {
 140                 global $wgUseTagFilter;
 141
 142                 if ( !$wgUseTagFilter || !count( self::listDefinedTags() ) )
 143                         return $fullForm ? '' : array();
 144
 145                 global $wgTitle;
 146
 147                 $data = array( wfMsgExt( 'tag-filter', 'parseinline' ), Xml::input( 'tagfilter', 20, $selected ) );
 148
 149                 if (!$fullForm) {
 150                         return $data;
 151                 }
 152
 153                 $html = implode( '&nbsp;', $data );
 154                 $html .= "\n" . Xml::element( 'input', array( 'type' => 'submit', 'value' => wfMsg( 'tag-filter-submit' ) ) );
 155                 $html .= "\n" . Xml::hidden( 'title', $wgTitle-> getPrefixedText() );
 156                 $html = Xml::tags( 'form', array( 'action' => $wgTitle->getLocalURL(), 'method' => 'get' ), $html );
 157
 158                 return $html;
 159         }
 160
 161         /** Basically lists defined tags which count even if they aren't applied to anything */
 162         static function listDefinedTags() {
 163                 // Caching...
 164                 global $wgMemc;
 165                 $key = wfMemcKey( 'valid-tags' );
 166
 167                 if ($tags = $wgMemc->get( $key ))
 168                         return $tags;
 169
 170                 $emptyTags = array();
 171
 172                 // Some DB stuff
 173                 $dbr = wfGetDB( DB_SLAVE );
 174                 $res = $dbr->select( 'valid_tag', 'vt_tag', array(), __METHOD__ );
 175                 while( $row = $res->fetchObject() ) {
 176                         $emptyTags[] = $row->vt_tag;
 177                 }
 178
 179                 wfRunHooks( 'ListDefinedTags', array(&$emptyTags) );
 180
 181                 $emptyTags = array_filter( array_unique( $emptyTags ) );
 182
 183                 // Short-term caching.
 184                 $wgMemc->set( $key, $emptyTags, 300 );
 185                 return $emptyTags;
 186         }
 187 }