X-Git-Url: http://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FWatchlistEditor.php;h=fcfdb782943fe0f3a3035e1598b32e75918f30b1;hb=b63ea56e49373afaf3faa486229a71785ba917bc;hp=525820476cc73ae9b3b8b614a89a975e4b5a69b9;hpb=71f2dd351697c23a91c85b01af0be7290698e5da;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/WatchlistEditor.php b/includes/WatchlistEditor.php index 525820476c..fcfdb78294 100644 --- a/includes/WatchlistEditor.php +++ b/includes/WatchlistEditor.php @@ -4,7 +4,7 @@ * Provides the UI through which users can perform editing * operations on their watchlist * - * @addtogroup Watchlist + * @ingroup Watchlist * @author Rob Church */ class WatchlistEditor { @@ -19,10 +19,10 @@ class WatchlistEditor { /** * Main execution point * - * @param User $user - * @param OutputPage $output - * @param WebRequest $request - * @param int $mode + * @param $user User + * @param $output OutputPage + * @param $request WebRequest + * @param $mode int */ public function execute( $user, $output, $request, $mode ) { global $wgUser; @@ -32,15 +32,8 @@ class WatchlistEditor { } switch( $mode ) { case self::EDIT_CLEAR: - $output->setPageTitle( wfMsg( 'watchlistedit-clear-title' ) ); - if( $request->wasPosted() && $this->checkToken( $request, $wgUser ) ) { - $this->clearWatchlist( $user ); - $user->invalidateCache(); - $output->addHtml( wfMsgExt( 'watchlistedit-clear-done', 'parse' ) ); - } else { - $this->showClearForm( $output, $user ); - } - break; + // The "Clear" link scared people too much. + // Pass on to the raw editor, from which it's very easy to clear. case self::EDIT_RAW: $output->setPageTitle( wfMsg( 'watchlistedit-raw-title' ) ); if( $request->wasPosted() && $this->checkToken( $request, $wgUser ) ) { @@ -84,23 +77,23 @@ class WatchlistEditor { $this->showNormalForm( $output, $user ); } } - + /** * Check the edit token from a form submission * - * @param WebRequest $request - * @param User $user + * @param $request WebRequest + * @param $user User * @return bool */ private function checkToken( $request, $user ) { - return $user->matchEditToken( $request->getVal( 'token' ), 'watchlistedit' ); + return $user->matchEditToken( $request->getVal( 'token' ), 'watchlistedit' ); } - + /** * Extract a list of titles from a blob of text, returning * (prefixed) strings; unwatchable titles are ignored * - * @param mixed $list + * @param $list mixed * @return array */ private function extractTitles( $list ) { @@ -120,20 +113,20 @@ class WatchlistEditor { } return array_unique( $titles ); } - + /** * Print out a list of linked titles * * $titles can be an array of strings or Title objects; the former * is preferred, since Titles are very memory-heavy * - * @param array $titles An array of strings, or Title objects - * @param OutputPage $output - * @param Skin $skin + * @param $titles An array of strings, or Title objects + * @param $output OutputPage + * @param $skin Skin */ private function showTitles( $titles, $output, $skin ) { $talk = wfMsgHtml( 'talkpagelinktext' ); - // Do a batch existence check + // Do a batch existence check $batch = new LinkBatch(); foreach( $titles as $title ) { if( !$title instanceof Title ) @@ -156,11 +149,11 @@ class WatchlistEditor { } $output->addHtml( "\n" ); } - + /** * Count the number of titles on a user's watchlist, excluding talk pages * - * @param User $user + * @param $user User * @return int */ private function countWatchlist( $user ) { @@ -169,16 +162,16 @@ class WatchlistEditor { $row = $dbr->fetchObject( $res ); return ceil( $row->count / 2 ); // Paranoia } - + /** * Prepare a list of titles on a user's watchlist (excluding talk pages) * and return an array of (prefixed) strings * - * @param User $user + * @param $user User * @return array */ private function getWatchlist( $user ) { - $list = array(); + $list = array(); $dbr = wfGetDB( DB_MASTER ); $res = $dbr->select( 'watchlist', @@ -194,17 +187,17 @@ class WatchlistEditor { if( $title instanceof Title && !$title->isTalkPage() ) $list[] = $title->getPrefixedText(); } - $res->free(); + $res->free(); } return $list; } - + /** * Get a list of titles on a user's watchlist, excluding talk pages, * and return as a two-dimensional array with namespace, title and * redirect status * - * @param User $user + * @param $user User * @return array */ private function getWatchlistInfo( $user ) { @@ -212,7 +205,7 @@ class WatchlistEditor { $dbr = wfGetDB( DB_MASTER ); $uid = intval( $user->getId() ); list( $watchlist, $page ) = $dbr->tableNamesN( 'watchlist', 'page' ); - $sql = "SELECT wl_namespace, wl_title, page_id, page_is_redirect + $sql = "SELECT wl_namespace, wl_title, page_id, page_len, page_is_redirect FROM {$watchlist} LEFT JOIN {$page} ON ( wl_namespace = page_namespace AND wl_title = page_title ) WHERE wl_user = {$uid}"; $res = $dbr->query( $sql, __METHOD__ ); @@ -223,7 +216,7 @@ class WatchlistEditor { if( $title instanceof Title ) { // Update the link cache while we're at it if( $row->page_id ) { - $cache->addGoodLinkObj( $row->page_id, $title ); + $cache->addGoodLinkObj( $row->page_id, $title, $row->page_len, $row->page_is_redirect ); } else { $cache->addBadLinkObj( $title ); } @@ -235,13 +228,13 @@ class WatchlistEditor { } return $titles; } - + /** * Show a message indicating the number of items on the user's watchlist, * and return this count for additional checking * - * @param OutputPage $output - * @param User $user + * @param $output OutputPage + * @param $user User * @return int */ private function showItemCount( $output, $user ) { @@ -253,11 +246,11 @@ class WatchlistEditor { } return $count; } - + /** * Remove all titles from a user's watchlist * - * @param User $user + * @param $user User */ private function clearWatchlist( $user ) { $dbw = wfGetDB( DB_MASTER ); @@ -270,8 +263,8 @@ class WatchlistEditor { * $titles can be an array of strings or Title objects; the former * is preferred, since Titles are very memory-heavy * - * @param array $titles An array of strings, or Title objects - * @param User $user + * @param $titles An array of strings, or Title objects + * @param $user User */ private function watchTitles( $titles, $user ) { $dbw = wfGetDB( DB_MASTER ); @@ -303,8 +296,8 @@ class WatchlistEditor { * $titles can be an array of strings or Title objects; the former * is preferred, since Titles are very memory-heavy * - * @param array $titles An array of strings, or Title objects - * @param User $user + * @param $titles An array of strings, or Title objects + * @param $user User */ private function unwatchTitles( $titles, $user ) { $dbw = wfGetDB( DB_MASTER ); @@ -334,32 +327,11 @@ class WatchlistEditor { } } - /** - * Show a confirmation form for users wishing to clear their watchlist - * - * @param OutputPage $output - * @param User $user - */ - private function showClearForm( $output, $user ) { - global $wgUser; - if( ( $count = $this->showItemCount( $output, $user ) ) > 0 ) { - $self = SpecialPage::getTitleFor( 'Watchlist' ); - $form = Xml::openElement( 'form', array( 'method' => 'post', - 'action' => $self->getLocalUrl( 'action=clear' ) ) ); - $form .= Xml::hidden( 'token', $wgUser->editToken( 'watchlistedit' ) ); - $form .= '
' . wfMsgHtml( 'watchlistedit-clear-legend' ) . ''; - $form .= wfMsgExt( 'watchlistedit-clear-confirm', 'parse' ); - $form .= '

' . Xml::submitButton( wfMsg( 'watchlistedit-clear-submit' ) ) . '

'; - $form .= '
'; - $output->addHtml( $form ); - } - } - /** * Show the standard watchlist editing form * - * @param OutputPage $output - * @param User $user + * @param $output OutputPage + * @param $user User */ private function showNormalForm( $output, $user ) { global $wgUser; @@ -384,11 +356,11 @@ class WatchlistEditor { $output->addHtml( $form ); } } - + /** * Get the correct "heading" for a namespace * - * @param int $namespace + * @param $namespace int * @return string */ private function getNamespaceHeading( $namespace ) { @@ -396,14 +368,14 @@ class WatchlistEditor { ? wfMsgHtml( 'blanknamespace' ) : htmlspecialchars( $GLOBALS['wgContLang']->getFormattedNsText( $namespace ) ); } - + /** * Build a single list item containing a check box selecting a title * and a link to that title, with various additional bits * - * @param Title $title - * @param bool $redirect - * @param Skin $skin + * @param $title Title + * @param $redirect bool + * @param $skin Skin * @return string */ private function buildRemoveLine( $title, $redirect, $skin ) { @@ -415,18 +387,18 @@ class WatchlistEditor { $tools[] = $skin->makeKnownLinkObj( $title, wfMsgHtml( 'history_short' ), 'action=history' ); } if( $title->getNamespace() == NS_USER && !$title->isSubpage() ) { - $tools[] = $skin->makeKnownLinkObj( SpecialPage::getTitleFor( 'Contributions' ), wfMsgHtml( 'contributions' ), 'target=' . $title->getPartialUrl() ); + $tools[] = $skin->makeKnownLinkObj( SpecialPage::getTitleFor( 'Contributions', $title->getText() ), wfMsgHtml( 'contributions' ) ); } return '
  • ' . Xml::check( 'titles[]', false, array( 'value' => $title->getPrefixedText() ) ) . $link . ' (' . implode( ' | ', $tools ) . ')' . '
    • '; } - + /** * Show a form for editing the watchlist in "raw" mode * - * @param OutputPage $output - * @param User $user + * @param $output OutputPage + * @param $user User */ public function showRawForm( $output, $user ) { global $wgUser; @@ -449,13 +421,13 @@ class WatchlistEditor { $form .= ''; $output->addHtml( $form ); } - + /** * Determine whether we are editing the watchlist, and if so, what * kind of editing operation * - * @param WebRequest $request - * @param mixed $par + * @param $request WebRequest + * @param $par mixed * @return int */ public static function getMode( $request, $par ) { @@ -471,23 +443,20 @@ class WatchlistEditor { return false; } } - + /** * Build a set of links for convenient navigation * between watchlist viewing and editing modes * - * @param Skin $skin Skin to use + * @param $skin Skin to use * @return string */ public static function buildTools( $skin ) { $tools = array(); - $self = SpecialPage::getTitleFor( 'Watchlist' ); - $modes = array( 'view' => '', 'edit' => 'edit', 'raw' => 'raw', 'clear' => 'clear' ); - foreach( $modes as $mode => $action ) { - $action = $action ? "action={$action}" : ''; - $tools[] = $skin->makeKnownLinkObj( $self, wfMsgHtml( "watchlisttools-{$mode}" ), $action ); + $modes = array( 'view' => false, 'edit' => 'edit', 'raw' => 'raw' ); + foreach( $modes as $mode => $subpage ) { + $tools[] = $skin->makeKnownLinkObj( SpecialPage::getTitleFor( 'Watchlist', $subpage ), wfMsgHtml( "watchlisttools-{$mode}" ) ); } return implode( ' | ', $tools ); } - }