X-Git-Url: http://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FQueryPage.php;h=948875139a07c28f4d5ec3819ea49747da979f64;hb=97d93d850c1b66941f70c8df9a888d626264b488;hp=019533335b1204346e150b1a26318e2d36deb557;hpb=b0f510df565d206379d543efdc2b7550d4585107;p=lhc%2Fweb%2Fwiklou.git
diff --git a/includes/QueryPage.php b/includes/QueryPage.php
index 019533335b..948875139a 100644
--- a/includes/QueryPage.php
+++ b/includes/QueryPage.php
@@ -1,102 +1,444 @@
-listoutput;
+ *
+ * @param bool $bool
+ */
+ function setListoutput( $bool ) {
+ $this->listoutput = $bool;
+ }
+ /**
+ * Subclasses return their name here. Make sure the name is also
+ * specified in SpecialPage.php and in Language.php as a language message
+ * param.
+ */
function getName() {
- return "";
+ return '';
}
- # Subclasses return a SQL query here.
+ /**
+ * Subclasses return an SQL query here.
+ *
+ * Note that the query itself should return the following four columns:
+ * 'type' (your special page's name), 'namespace', 'title', and 'value'
+ * *in that order*. 'value' is used for sorting.
+ *
+ * These may be stored in the querycache table for expensive queries,
+ * and that cached data will be returned sometimes, so the presence of
+ * extra fields can't be relied upon. The cached 'value' column will be
+ * an integer; non-numeric values are useful only for sorting the initial
+ * query.
+ *
+ * Don't include an ORDER or LIMIT clause, this will be added.
+ */
+ function getSQL() {
+ return "SELECT 'sample' as type, 0 as namespace, 'Sample result' as title, 42 as value";
+ }
+
+ /**
+ * Override to sort by increasing values
+ */
+ function sortDescending() {
+ return true;
+ }
- function getSQL( $offset, $limit ) {
- return "";
+ function getOrder() {
+ return ' ORDER BY value ' .
+ ($this->sortDescending() ? 'DESC' : '');
}
- # Is this query expensive (for some definition of expensive)? Then we
- # don't let it run in miser mode. $wgDisableQueryPages causes all query
- # pages to be declared expensive. Some query pages are always expensive.
+ /**
+ * Is this query expensive (for some definition of expensive)? Then we
+ * don't let it run in miser mode. $wgDisableQueryPages causes all query
+ * pages to be declared expensive. Some query pages are always expensive.
+ */
function isExpensive( ) {
global $wgDisableQueryPages;
return $wgDisableQueryPages;
}
- # Formats the results of the query for display. The skin is the current
- # skin; you can use it for making links. The result is a single row of
- # result data. You should be able to grab SQL results off of it.
+ /**
+ * Whether or not the output of the page in question is retrived from
+ * the database cache.
+ *
+ * @return bool
+ */
+ function isCached() {
+ global $wgMiserMode;
+
+ return $this->isExpensive() && $wgMiserMode;
+ }
+
+ /**
+ * Sometime we dont want to build rss / atom feeds.
+ */
+ function isSyndicated() {
+ return true;
+ }
+ /**
+ * Formats the results of the query for display. The skin is the current
+ * skin; you can use it for making links. The result is a single row of
+ * result data. You should be able to grab SQL results off of it.
+ * If the function return "false", the line output will be skipped.
+ */
function formatResult( $skin, $result ) {
- return "";
+ return '';
}
- # This is the actual workhorse. It does everything needed to make a
- # real, honest-to-gosh query page.
+ /**
+ * The content returned by this function will be output before any result
+ */
+ function getPageHeader( ) {
+ return '';
+ }
- function doQuery( $offset, $limit ) {
+ /**
+ * If using extra form wheely-dealies, return a set of parameters here
+ * as an associative array. They will be encoded and added to the paging
+ * links (prev/next/lengths).
+ * @return array
+ */
+ function linkParameters() {
+ return array();
+ }
- global $wgUser, $wgOut, $wgLang, $wgMiserMode;
+ /**
+ * Some special pages (for example SpecialListusers) might not return the
+ * current object formatted, but return the previous one instead.
+ * Setting this to return true, will call one more time wfFormatResult to
+ * be sure that the very last result is formatted and shown.
+ */
+ function tryLastResult( ) {
+ return false;
+ }
- $sname = $this->getName();
- $fname = get_class($this) . "::doQuery";
+ /**
+ * Clear the cache and save new results
+ */
+ function recache( $limit, $ignoreErrors = true ) {
+ $fname = get_class($this) . '::recache';
+ $dbw =& wfGetDB( DB_MASTER );
+ $dbr =& wfGetDB( DB_SLAVE, array( $this->getName(), 'QueryPage::recache', 'vslow' ) );
+ if ( !$dbw || !$dbr ) {
+ return false;
+ }
+
+ $querycache = $dbr->tableName( 'querycache' );
- if ( $this->isExpensive( ) ) {
+ if ( $ignoreErrors ) {
+ $ignoreW = $dbw->ignoreErrors( true );
+ $ignoreR = $dbr->ignoreErrors( true );
+ }
- $vsp = $wgLang->getValidSpecialPages();
- $logpage = new LogPage( "!" . $vsp[$sname] );
- $logpage->mUpdateRecentChanges = false;
+ # Clear out any old cached data
+ $dbw->delete( 'querycache', array( 'qc_type' => $this->getName() ), $fname );
+ # Do query
+ $sql = $this->getSQL() . $this->getOrder();
+ if ($limit !== false)
+ $sql = $dbr->limitResult($sql, $limit, 0);
+ $res = $dbr->query($sql, $fname);
+ $num = false;
+ if ( $res ) {
+ $num = $dbr->numRows( $res );
+ # Fetch results
+ $insertSql = "INSERT INTO $querycache (qc_type,qc_namespace,qc_title,qc_value) VALUES ";
+ $first = true;
+ while ( $res && $row = $dbr->fetchObject( $res ) ) {
+ if ( $first ) {
+ $first = false;
+ } else {
+ $insertSql .= ',';
+ }
+ if ( isset( $row->value ) ) {
+ $value = $row->value;
+ } else {
+ $value = '';
+ }
- if ( $wgMiserMode ) {
- $logpage->showAsDisabledPage();
- return;
+ $insertSql .= '(' .
+ $dbw->addQuotes( $row->type ) . ',' .
+ $dbw->addQuotes( $row->namespace ) . ',' .
+ $dbw->addQuotes( $row->title ) . ',' .
+ $dbw->addQuotes( $value ) . ')';
+ }
+
+ # Save results into the querycache table on the master
+ if ( !$first ) {
+ if ( !$dbw->query( $insertSql, $fname ) ) {
+ // Set result to false to indicate error
+ $dbr->freeResult( $res );
+ $res = false;
+ }
+ }
+ if ( $res ) {
+ $dbr->freeResult( $res );
+ }
+ if ( $ignoreErrors ) {
+ $dbw->ignoreErrors( $ignoreW );
+ $dbr->ignoreErrors( $ignoreR );
}
}
+ return $num;
+ }
+
+ /**
+ * This is the actual workhorse. It does everything needed to make a
+ * real, honest-to-gosh query page.
+ *
+ * @param $offset database query offset
+ * @param $limit database query limit
+ * @param $shownavigation show navigation like "next 200"?
+ */
+ function doQuery( $offset, $limit, $shownavigation=true ) {
+ global $wgUser, $wgOut, $wgContLang;
+
+ $sname = $this->getName();
+ $fname = get_class($this) . '::doQuery';
+ $sql = $this->getSQL();
+ $dbr =& wfGetDB( DB_SLAVE );
+ $querycache = $dbr->tableName( 'querycache' );
- $sql = $this->getSQL( $offset, $limit );
+ $wgOut->setSyndicated( $this->isSyndicated() );
- $res = wfQuery( $sql, DB_READ, $fname );
+ if ( $this->isCached() ) {
+ $type = $dbr->strencode( $sname );
+ $sql =
+ "SELECT qc_type as type, qc_namespace as namespace,qc_title as title, qc_value as value
+ FROM $querycache WHERE qc_type='$type'";
+ if ( ! $this->listoutput )
+ $wgOut->addWikiText( wfMsg( 'perfcached' ) );
+ }
+
+ $sql .= $this->getOrder();
+ $sql = $dbr->limitResult($sql, $limit, $offset);
+ $res = $dbr->query( $sql );
+ $num = $dbr->numRows($res);
+
+ $this->preprocessResults( $dbr, $res );
$sk = $wgUser->getSkin( );
- $top = wfShowingResults( $offset, $limit );
- $wgOut->addHTML( "{$top}\n" );
+ if($shownavigation) {
+ $wgOut->addHTML( $this->getPageHeader() );
+ $top = wfShowingResults( $offset, $num);
+ $wgOut->addHTML( "
{$top}\n" );
- $sl = wfViewPrevNext( $offset, $limit, $wgLang->specialPage( $sname ) );
- $wgOut->addHTML( "
{$sl}\n" );
+ # often disable 'next' link when we reach the end
+ $atend = $num < $limit;
- $s = "
";
- while ( $obj = wfFetchObject( $res ) ) {
- $format = $this->formatResult( $sk, $obj );
- $s .= "- {$format}
\n";
+ $sl = wfViewPrevNext( $offset, $limit ,
+ $wgContLang->specialPage( $sname ),
+ wfArrayToCGI( $this->linkParameters() ), $atend );
+ $wgOut->addHTML( "
{$sl}\n" );
}
- wfFreeResult( $res );
- $s .= "
";
- $wgOut->addHTML( $s );
- $wgOut->addHTML( "{$sl}\n" );
+ if ( $num > 0 ) {
+ $s = array();
+ if ( ! $this->listoutput )
+ $s[] = "
";
- # Saving cache
+ # Only read at most $num rows, because $res may contain the whole 1000
+ for ( $i = 0; $i < $num && $obj = $dbr->fetchObject( $res ); $i++ ) {
+ $format = $this->formatResult( $sk, $obj );
+ if ( $format ) {
+ $attr = ( isset ( $obj->usepatrol ) && $obj->usepatrol &&
+ $obj->patrolled == 0 ) ? ' class="not-patrolled"' : '';
+ $s[] = $this->listoutput ? $format : "{$format}\n";
+ }
+ }
- if ( $this->isExpensive() && $offset == 0 && $limit >= 50 ) {
- $logpage->replaceContent( $s );
+ if($this->tryLastResult()) {
+ // flush the very last result
+ $obj = null;
+ $format = $this->formatResult( $sk, $obj );
+ if( $format ) {
+ $attr = ( isset ( $obj->usepatrol ) && $obj->usepatrol &&
+ $obj->patrolled == 0 ) ? ' class="not-patrolled"' : '';
+ $s[] = "{$format}\n";
+ }
+ }
+
+ $dbr->freeResult( $res );
+ if ( ! $this->listoutput )
+ $s[] = '
';
+ $str = $this->listoutput ? $wgContLang->listToText( $s ) : implode( '', $s );
+ $wgOut->addHTML( $str );
}
+ if($shownavigation) {
+ $wgOut->addHTML( "{$sl}
\n" );
+ }
+ return $num;
}
-}
-# This is a subclass for very simple queries that are just looking for page
-# titles that match some criteria. It formats each result item as a link to
-# that page.
+ /**
+ * Do any necessary preprocessing of the result object.
+ * You should pass this by reference: &$db , &$res
+ */
+ function preprocessResults( $db, $res ) {}
+
+ /**
+ * Similar to above, but packaging in a syndicated feed instead of a web page
+ */
+ function doFeed( $class = '' ) {
+ global $wgFeedClasses;
+
+ if( isset($wgFeedClasses[$class]) ) {
+ $feed = new $wgFeedClasses[$class](
+ $this->feedTitle(),
+ $this->feedDesc(),
+ $this->feedUrl() );
+ $feed->outHeader();
+
+ $dbr =& wfGetDB( DB_SLAVE );
+ $sql = $this->getSQL() . $this->getOrder();
+ $sql = $dbr->limitResult( $sql, 50, 0 );
+ $res = $dbr->query( $sql, 'QueryPage::doFeed' );
+ while( $obj = $dbr->fetchObject( $res ) ) {
+ $item = $this->feedResult( $obj );
+ if( $item ) $feed->outItem( $item );
+ }
+ $dbr->freeResult( $res );
+
+ $feed->outFooter();
+ return true;
+ } else {
+ return false;
+ }
+ }
+
+ /**
+ * Override for custom handling. If the titles/links are ok, just do
+ * feedItemDesc()
+ */
+ function feedResult( $row ) {
+ if( !isset( $row->title ) ) {
+ return NULL;
+ }
+ $title = Title::MakeTitle( intval( $row->namespace ), $row->title );
+ if( $title ) {
+ $date = isset( $row->timestamp ) ? $row->timestamp : '';
+ $comments = '';
+ if( $title ) {
+ $talkpage = $title->getTalkPage();
+ $comments = $talkpage->getFullURL();
+ }
+
+ return new FeedItem(
+ $title->getPrefixedText(),
+ $this->feedItemDesc( $row ),
+ $title->getFullURL(),
+ $date,
+ $this->feedItemAuthor( $row ),
+ $comments);
+ } else {
+ return NULL;
+ }
+ }
+
+ function feedItemDesc( $row ) {
+ return isset( $row->comment ) ? htmlspecialchars( $row->comment ) : '';
+ }
+
+ function feedItemAuthor( $row ) {
+ return isset( $row->user_text ) ? $row->user_text : '';
+ }
+
+ function feedTitle() {
+ global $wgLanguageCode, $wgSitename;
+ $page = SpecialPage::getPage( $this->getName() );
+ $desc = $page->getDescription();
+ return "$wgSitename - $desc [$wgLanguageCode]";
+ }
+
+ function feedDesc() {
+ return wfMsg( 'tagline' );
+ }
+
+ function feedUrl() {
+ $title = Title::MakeTitle( NS_SPECIAL, $this->getName() );
+ return $title->getFullURL();
+ }
+}
+/**
+ * This is a subclass for very simple queries that are just looking for page
+ * titles that match some criteria. It formats each result item as a link to
+ * that page.
+ *
+ * @package MediaWiki
+ */
class PageQueryPage extends QueryPage {
function formatResult( $skin, $result ) {
- return $skin->makeKnownLink( $result->cur_title, "" );
+ global $wgContLang;
+ $nt = Title::makeTitle( $result->namespace, $result->title );
+ return $skin->makeKnownLinkObj( $nt, htmlspecialchars( $wgContLang->convert( $nt->getPrefixedText() ) ) );
}
}