includes/WatchlistEditor.php

   1 <?php
   2
   3 /**
   4  * Provides the UI through which users can perform editing
   5  * operations on their watchlist
   6  *
   7  * @addtogroup Watchlist
   8  * @author Rob Church <robchur@gmail.com>
   9  */
  10 class WatchlistEditor {
  11
  12         /**
  13          * Editing modes
  14          */
  15         const EDIT_CLEAR = 1;
  16         const EDIT_RAW = 2;
  17         const EDIT_NORMAL = 3;
  18
  19         /**
  20          * Main execution point
  21          *
  22          * @param User $user
  23          * @param OutputPage $output
  24          * @param WebRequest $request
  25          * @param int $mode
  26          */
  27         public function execute( $user, $output, $request, $mode ) {
  28                 global $wgUser;
  29                 if( wfReadOnly() ) {
  30                         $output->readOnlyPage();
  31                         return;
  32                 }
  33                 switch( $mode ) {
  34                         case self::EDIT_CLEAR:
  35                                 // The "Clear" link scared people too much.
  36                                 // Pass on to the raw editor, from which it's very easy to clear.
  37                         case self::EDIT_RAW:
  38                                 $output->setPageTitle( wfMsg( 'watchlistedit-raw-title' ) );
  39                                 if( $request->wasPosted() && $this->checkToken( $request, $wgUser ) ) {
  40                                         $wanted = $this->extractTitles( $request->getText( 'titles' ) );
  41                                         $current = $this->getWatchlist( $user );
  42                                         if( count( $wanted ) > 0 ) {
  43                                                 $toWatch = array_diff( $wanted, $current );
  44                                                 $toUnwatch = array_diff( $current, $wanted );
  45                                                 $this->watchTitles( $toWatch, $user );
  46                                                 $this->unwatchTitles( $toUnwatch, $user );
  47                                                 $user->invalidateCache();
  48                                                 if( count( $toWatch ) > 0 || count( $toUnwatch ) > 0 )
  49                                                         $output->addHtml( wfMsgExt( 'watchlistedit-raw-done', 'parse' ) );
  50                                                 if( ( $count = count( $toWatch ) ) > 0 ) {
  51                                                         $output->addHtml( wfMsgExt( 'watchlistedit-raw-added', 'parse', $count ) );
  52                                                         $this->showTitles( $toWatch, $output, $wgUser->getSkin() );
  53                                                 }
  54                                                 if( ( $count = count( $toUnwatch ) ) > 0 ) {
  55                                                         $output->addHtml( wfMsgExt( 'watchlistedit-raw-removed', 'parse', $count ) );
  56                                                         $this->showTitles( $toUnwatch, $output, $wgUser->getSkin() );
  57                                                 }
  58                                         } else {
  59                                                 $this->clearWatchlist( $user );
  60                                                 $user->invalidateCache();
  61                                                 $output->addHtml( wfMsgExt( 'watchlistedit-raw-removed', 'parse', count( $current ) ) );
  62                                                 $this->showTitles( $current, $output, $wgUser->getSkin() );
  63                                         }
  64                                 }
  65                                 $this->showRawForm( $output, $user );
  66                                 break;
  67                         case self::EDIT_NORMAL:
  68                                 $output->setPageTitle( wfMsg( 'watchlistedit-normal-title' ) );
  69                                 if( $request->wasPosted() && $this->checkToken( $request, $wgUser ) ) {
  70                                         $titles = $this->extractTitles( $request->getArray( 'titles' ) );
  71                                         $this->unwatchTitles( $titles, $user );
  72                                         $user->invalidateCache();
  73                                         $output->addHtml( wfMsgExt( 'watchlistedit-normal-done', 'parse',
  74                                                 $GLOBALS['wgLang']->formatNum( count( $titles ) ) ) );
  75                                         $this->showTitles( $titles, $output, $wgUser->getSkin() );
  76                                 }
  77                                 $this->showNormalForm( $output, $user );
  78                 }
  79         }
  80
  81         /**
  82          * Check the edit token from a form submission
  83          *
  84          * @param WebRequest $request
  85          * @param User $user
  86          * @return bool
  87          */
  88         private function checkToken( $request, $user ) {
  89                 return $user->matchEditToken( $request->getVal( 'token' ), 'watchlistedit' );
  90         }
  91
  92         /**
  93          * Extract a list of titles from a blob of text, returning
  94          * (prefixed) strings; unwatchable titles are ignored
  95          *
  96          * @param mixed $list
  97          * @return array
  98          */
  99         private function extractTitles( $list ) {
 100                 $titles = array();
 101                 if( !is_array( $list ) ) {
 102                         $list = explode( "\n", trim( $list ) );
 103                         if( !is_array( $list ) )
 104                                 return array();
 105                 }
 106                 foreach( $list as $text ) {
 107                         $text = trim( $text );
 108                         if( strlen( $text ) > 0 ) {
 109                                 $title = Title::newFromText( $text );
 110                                 if( $title instanceof Title && $title->isWatchable() )
 111                                         $titles[] = $title->getPrefixedText();
 112                         }
 113                 }
 114                 return array_unique( $titles );
 115         }
 116
 117         /**
 118          * Print out a list of linked titles
 119          *
 120          * $titles can be an array of strings or Title objects; the former
 121          * is preferred, since Titles are very memory-heavy
 122          *
 123          * @param array $titles An array of strings, or Title objects
 124          * @param OutputPage $output
 125          * @param Skin $skin
 126          */
 127         private function showTitles( $titles, $output, $skin ) {
 128                 $talk = wfMsgHtml( 'talkpagelinktext' );
 129                 // Do a batch existence check
 130                 $batch = new LinkBatch();
 131                 foreach( $titles as $title ) {
 132                         if( !$title instanceof Title )
 133                                 $title = Title::newFromText( $title );
 134                         if( $title instanceof Title ) {
 135                                 $batch->addObj( $title );
 136                                 $batch->addObj( $title->getTalkPage() );
 137                         }
 138                 }
 139                 $batch->execute();
 140                 // Print out the list
 141                 $output->addHtml( "<ul>\n" );
 142                 foreach( $titles as $title ) {
 143                         if( !$title instanceof Title )
 144                                 $title = Title::newFromText( $title );
 145                         if( $title instanceof Title ) {
 146                                 $output->addHtml( "<li>" . $skin->makeLinkObj( $title )
 147                                 . ' (' . $skin->makeLinkObj( $title->getTalkPage(), $talk ) . ")</li>\n" );
 148                         }
 149                 }
 150                 $output->addHtml( "</ul>\n" );
 151         }
 152
 153         /**
 154          * Count the number of titles on a user's watchlist, excluding talk pages
 155          *
 156          * @param User $user
 157          * @return int
 158          */
 159         private function countWatchlist( $user ) {
 160                 $dbr = wfGetDB( DB_MASTER );
 161                 $res = $dbr->select( 'watchlist', 'COUNT(*) AS count', array( 'wl_user' => $user->getId() ), __METHOD__ );
 162                 $row = $dbr->fetchObject( $res );
 163                 return ceil( $row->count / 2 ); // Paranoia
 164         }
 165
 166         /**
 167          * Prepare a list of titles on a user's watchlist (excluding talk pages)
 168          * and return an array of (prefixed) strings
 169          *
 170          * @param User $user
 171          * @return array
 172          */
 173         private function getWatchlist( $user ) {
 174                 $list = array();
 175                 $dbr = wfGetDB( DB_MASTER );
 176                 $res = $dbr->select(
 177                         'watchlist',
 178                         '*',
 179                         array(
 180                                 'wl_user' => $user->getId(),
 181                         ),
 182                         __METHOD__
 183                 );
 184                 if( $res->numRows() > 0 ) {
 185                         while( $row = $res->fetchObject() ) {
 186                                 $title = Title::makeTitleSafe( $row->wl_namespace, $row->wl_title );
 187                                 if( $title instanceof Title && !$title->isTalkPage() )
 188                                         $list[] = $title->getPrefixedText();
 189                         }
 190                         $res->free();
 191                 }
 192                 return $list;
 193         }
 194
 195         /**
 196          * Get a list of titles on a user's watchlist, excluding talk pages,
 197          * and return as a two-dimensional array with namespace, title and
 198          * redirect status
 199          *
 200          * @param User $user
 201          * @return array
 202          */
 203         private function getWatchlistInfo( $user ) {
 204                 $titles = array();
 205                 $dbr = wfGetDB( DB_MASTER );
 206                 $uid = intval( $user->getId() );
 207                 list( $watchlist, $page ) = $dbr->tableNamesN( 'watchlist', 'page' );
 208                 $sql = "SELECT wl_namespace, wl_title, page_id, page_len, page_is_redirect,
 209                         page_namespace, page_title
 210                         FROM {$watchlist} LEFT JOIN {$page} ON ( wl_namespace = page_namespace
 211                         AND wl_title = page_title ) WHERE wl_user = {$uid}";
 212                 $res = $dbr->query( $sql, __METHOD__ );
 213                 if( $res && $dbr->numRows( $res ) > 0 ) {
 214                         $cache = LinkCache::singleton();
 215                         while( $row = $dbr->fetchObject( $res ) ) {
 216                                 $title = Title::newFromRow( $row );
 217                                 if( $title instanceof Title ) {
 218                                         // Update the link cache while we're at it
 219                                         if( $row->page_id ) {
 220                                                 $cache->addGoodLinkObj( $row->page_id, $title );
 221                                         } else {
 222                                                 $cache->addBadLinkObj( $title );
 223                                         }
 224                                         // Ignore non-talk
 225                                         if( !$title->isTalkPage() )
 226                                                 $titles[$row->wl_namespace][$row->wl_title] = $row->page_is_redirect;
 227                                 }
 228                         }
 229                 }
 230                 return $titles;
 231         }
 232
 233         /**
 234          * Show a message indicating the number of items on the user's watchlist,
 235          * and return this count for additional checking
 236          *
 237          * @param OutputPage $output
 238          * @param User $user
 239          * @return int
 240          */
 241         private function showItemCount( $output, $user ) {
 242                 if( ( $count = $this->countWatchlist( $user ) ) > 0 ) {
 243                         $output->addHtml( wfMsgExt( 'watchlistedit-numitems', 'parse',
 244                                 $GLOBALS['wgLang']->formatNum( $count ) ) );
 245                 } else {
 246                         $output->addHtml( wfMsgExt( 'watchlistedit-noitems', 'parse' ) );
 247                 }
 248                 return $count;
 249         }
 250
 251         /**
 252          * Remove all titles from a user's watchlist
 253          *
 254          * @param User $user
 255          */
 256         private function clearWatchlist( $user ) {
 257                 $dbw = wfGetDB( DB_MASTER );
 258                 $dbw->delete( 'watchlist', array( 'wl_user' => $user->getId() ), __METHOD__ );
 259         }
 260
 261         /**
 262          * Add a list of titles to a user's watchlist
 263          *
 264          * $titles can be an array of strings or Title objects; the former
 265          * is preferred, since Titles are very memory-heavy
 266          *
 267          * @param array $titles An array of strings, or Title objects
 268          * @param User $user
 269          */
 270         private function watchTitles( $titles, $user ) {
 271                 $dbw = wfGetDB( DB_MASTER );
 272                 $rows = array();
 273                 foreach( $titles as $title ) {
 274                         if( !$title instanceof Title )
 275                                 $title = Title::newFromText( $title );
 276                         if( $title instanceof Title ) {
 277                                 $rows[] = array(
 278                                         'wl_user' => $user->getId(),
 279                                         'wl_namespace' => ( $title->getNamespace() & ~1 ),
 280                                         'wl_title' => $title->getDBkey(),
 281                                         'wl_notificationtimestamp' => null,
 282                                 );
 283                                 $rows[] = array(
 284                                         'wl_user' => $user->getId(),
 285                                         'wl_namespace' => ( $title->getNamespace() | 1 ),
 286                                         'wl_title' => $title->getDBkey(),
 287                                         'wl_notificationtimestamp' => null,
 288                                 );
 289                         }
 290                 }
 291                 $dbw->insert( 'watchlist', $rows, __METHOD__, 'IGNORE' );
 292         }
 293
 294         /**
 295          * Remove a list of titles from a user's watchlist
 296          *
 297          * $titles can be an array of strings or Title objects; the former
 298          * is preferred, since Titles are very memory-heavy
 299          *
 300          * @param array $titles An array of strings, or Title objects
 301          * @param User $user
 302          */
 303         private function unwatchTitles( $titles, $user ) {
 304                 $dbw = wfGetDB( DB_MASTER );
 305                 foreach( $titles as $title ) {
 306                         if( !$title instanceof Title )
 307                                 $title = Title::newFromText( $title );
 308                         if( $title instanceof Title ) {
 309                                 $dbw->delete(
 310                                         'watchlist',
 311                                         array(
 312                                                 'wl_user' => $user->getId(),
 313                                                 'wl_namespace' => ( $title->getNamespace() & ~1 ),
 314                                                 'wl_title' => $title->getDBkey(),
 315                                         ),
 316                                         __METHOD__
 317                                 );
 318                                 $dbw->delete(
 319                                         'watchlist',
 320                                         array(
 321                                                 'wl_user' => $user->getId(),
 322                                                 'wl_namespace' => ( $title->getNamespace() | 1 ),
 323                                                 'wl_title' => $title->getDBkey(),
 324                                         ),
 325                                         __METHOD__
 326                                 );
 327                         }
 328                 }
 329         }
 330
 331         /**
 332          * Show the standard watchlist editing form
 333          *
 334          * @param OutputPage $output
 335          * @param User $user
 336          */
 337         private function showNormalForm( $output, $user ) {
 338                 global $wgUser;
 339                 if( ( $count = $this->showItemCount( $output, $user ) ) > 0 ) {
 340                         $self = SpecialPage::getTitleFor( 'Watchlist' );
 341                         $form  = Xml::openElement( 'form', array( 'method' => 'post',
 342                                 'action' => $self->getLocalUrl( 'action=edit' ) ) );
 343                         $form .= Xml::hidden( 'token', $wgUser->editToken( 'watchlistedit' ) );
 344                         $form .= '<fieldset><legend>' . wfMsgHtml( 'watchlistedit-normal-legend' ) . '</legend>';
 345                         $form .= wfMsgExt( 'watchlistedit-normal-explain', 'parse' );
 346                         foreach( $this->getWatchlistInfo( $user ) as $namespace => $pages ) {
 347                                 $form .= '<h2>' . $this->getNamespaceHeading( $namespace ) . '</h2>';
 348                                 $form .= '<ul>';
 349                                 foreach( $pages as $dbkey => $redirect ) {
 350                                         $title = Title::makeTitleSafe( $namespace, $dbkey );
 351                                         $form .= $this->buildRemoveLine( $title, $redirect, $wgUser->getSkin() );
 352                                 }
 353                                 $form .= '</ul>';
 354                         }
 355                         $form .= '<p>' . Xml::submitButton( wfMsg( 'watchlistedit-normal-submit' ) ) . '</p>';
 356                         $form .= '</fieldset></form>';
 357                         $output->addHtml( $form );
 358                 }
 359         }
 360
 361         /**
 362          * Get the correct "heading" for a namespace
 363          *
 364          * @param int $namespace
 365          * @return string
 366          */
 367         private function getNamespaceHeading( $namespace ) {
 368                 return $namespace == NS_MAIN
 369                         ? wfMsgHtml( 'blanknamespace' )
 370                         : htmlspecialchars( $GLOBALS['wgContLang']->getFormattedNsText( $namespace ) );
 371         }
 372
 373         /**
 374          * Build a single list item containing a check box selecting a title
 375          * and a link to that title, with various additional bits
 376          *
 377          * @param Title $title
 378          * @param bool $redirect
 379          * @param Skin $skin
 380          * @return string
 381          */
 382         private function buildRemoveLine( $title, $redirect, $skin ) {
 383                 $link = $skin->makeLinkObj( $title );
 384                 if( $redirect )
 385                         $link = '<span class="watchlistredir">' . $link . '</span>';
 386                 $tools[] = $skin->makeLinkObj( $title->getTalkPage(), wfMsgHtml( 'talkpagelinktext' ) );
 387                 if( $title->exists() ) {
 388                         $tools[] = $skin->makeKnownLinkObj( $title, wfMsgHtml( 'history_short' ), 'action=history' );
 389                 }
 390                 if( $title->getNamespace() == NS_USER && !$title->isSubpage() ) {
 391                         $tools[] = $skin->makeKnownLinkObj( SpecialPage::getTitleFor( 'Contributions', $title->getText() ), wfMsgHtml( 'contributions' ) );
 392                 }
 393                 return '<li>'
 394                         . Xml::check( 'titles[]', false, array( 'value' => $title->getPrefixedText() ) )
 395                         . $link . ' (' . implode( ' | ', $tools ) . ')' . '</li>';
 396                 }
 397
 398         /**
 399          * Show a form for editing the watchlist in "raw" mode
 400          *
 401          * @param OutputPage $output
 402          * @param User $user
 403          */
 404         public function showRawForm( $output, $user ) {
 405                 global $wgUser;
 406                 $this->showItemCount( $output, $user );
 407                 $self = SpecialPage::getTitleFor( 'Watchlist' );
 408                 $form  = Xml::openElement( 'form', array( 'method' => 'post',
 409                         'action' => $self->getLocalUrl( 'action=raw' ) ) );
 410                 $form .= Xml::hidden( 'token', $wgUser->editToken( 'watchlistedit' ) );
 411                 $form .= '<fieldset><legend>' . wfMsgHtml( 'watchlistedit-raw-legend' ) . '</legend>';
 412                 $form .= wfMsgExt( 'watchlistedit-raw-explain', 'parse' );
 413                 $form .= Xml::label( wfMsg( 'watchlistedit-raw-titles' ), 'titles' );
 414                 $form .= "<br />\n";
 415                 $form .= Xml::openElement( 'textarea', array( 'id' => 'titles', 'name' => 'titles',
 416                         'rows' => $wgUser->getIntOption( 'rows' ), 'cols' => $wgUser->getIntOption( 'cols' ) ) );
 417                 $titles = $this->getWatchlist( $user );
 418                 foreach( $titles as $title )
 419                         $form .= htmlspecialchars( $title ) . "\n";
 420                 $form .= '</textarea>';
 421                 $form .= '<p>' . Xml::submitButton( wfMsg( 'watchlistedit-raw-submit' ) ) . '</p>';
 422                 $form .= '</fieldset></form>';
 423                 $output->addHtml( $form );
 424         }
 425
 426         /**
 427          * Determine whether we are editing the watchlist, and if so, what
 428          * kind of editing operation
 429          *
 430          * @param WebRequest $request
 431          * @param mixed $par
 432          * @return int
 433          */
 434         public static function getMode( $request, $par ) {
 435                 $mode = strtolower( $request->getVal( 'action', $par ) );
 436                 switch( $mode ) {
 437                         case 'clear':
 438                                 return self::EDIT_CLEAR;
 439                         case 'raw':
 440                                 return self::EDIT_RAW;
 441                         case 'edit':
 442                                 return self::EDIT_NORMAL;
 443                         default:
 444                                 return false;
 445                 }
 446         }
 447
 448         /**
 449          * Build a set of links for convenient navigation
 450          * between watchlist viewing and editing modes
 451          *
 452          * @param Skin $skin Skin to use
 453          * @return string
 454          */
 455         public static function buildTools( $skin ) {
 456                 $tools = array();
 457                 $modes = array( 'view' => false, 'edit' => 'edit', 'raw' => 'raw' );
 458                 foreach( $modes as $mode => $subpage ) {
 459                         $tools[] = $skin->makeKnownLinkObj( SpecialPage::getTitleFor( 'Watchlist', $subpage ), wfMsgHtml( "watchlisttools-{$mode}" ) );
 460                 }
 461                 return implode( ' | ', $tools );
 462         }
 463
 464 }