http://www.mediawiki.org/wiki/Special:Code/MediaWiki/97920
Revision: 97920
Author: catrope
Date: 2011-09-23 14:49:21 +0000 (Fri, 23 Sep 2011)
Log Message:
-----------
MoodBar: Add list=moodbarcomments API module, and add indexes to go with it
Modified Paths:
--------------
trunk/extensions/MoodBar/MoodBar.php
trunk/extensions/MoodBar/sql/MoodBar.sql
Added Paths:
-----------
trunk/extensions/MoodBar/ApiQueryMoodBarComments.php
Added: trunk/extensions/MoodBar/ApiQueryMoodBarComments.php
===================================================================
--- trunk/extensions/MoodBar/ApiQueryMoodBarComments.php
(rev 0)
+++ trunk/extensions/MoodBar/ApiQueryMoodBarComments.php 2011-09-23
14:49:21 UTC (rev 97920)
@@ -0,0 +1,160 @@
+<?php
+
+class ApiQueryMoodBarComments extends ApiQueryBase {
+ public function __construct( $query, $moduleName ) {
+ parent::__construct( $query, $moduleName, 'mbc' );
+ }
+
+ public function execute() {
+ $params = $this->extractRequestParams();
+
+ // Build the query
+ $this->addTables( array( 'moodbar_feedback', 'user' ) );
+ $this->addJoinConds( array( 'user' => array( 'LEFT JOIN',
'user_id=mbf_user_id' ) ) );
+ $this->addFields( array( 'user_name', 'mbf_id', 'mbf_type',
'mbf_timestamp', 'mbf_user_id', 'mbf_user_ip',
+ 'mbf_comment' ) );
+
+ $sortDesc = $params['dir'] == 'older';
+ $dir = $sortDesc ? ' DESC' : '';
+ $orderFields = array();
+ $useTypeFromContinue = false;
+ if ( count( $params['type'] ) ) {
+ $this->addWhereFld( 'mbf_type', $params['type'] );
+ if ( count( $params['type'] ) > 1 ) {
+ $orderFields[] = 'mbf_type' . $dir;
+ $useTypeFromContinue = true;
+ }
+ }
+ if ( $params['user'] !== null ) {
+ $user = User::newFromName( $params['user'] );
+ if ( !$user || $user->isAnon() ) {
+ $this->addWhereFld( 'mbf_user_id', 0 );
+ $this->addWhereFld( 'mbf_user_ip',
$params['user'] );
+ } else {
+ $this->addWhereFld( 'mbf_user_id',
$user->getID() );
+ $this->addWhere( 'mbf_user_ip IS NULL' );
+ }
+ }
+
+ if ( $params['continue'] !== null ) {
+ $this->applyContinue( $params['continue'], $sortDesc,
$useTypeFromContinue );
+ }
+
+ $orderFields[] = 'mbf_timestamp' . $dir;
+ $this->addOption( 'ORDER BY', $orderFields );
+ $this->addOption( 'LIMIT', $params['limit'] + 1 );
+
+ $res = $this->select( __METHOD__ );
+ $result = $this->getResult();
+ $count = 0;
+ foreach ( $res as $row ) {
+ if ( ++$count > $params['limit'] ) {
+ // We've reached the one extra which shows that
there are additional rows. Stop here
+ $this->setContinueEnumParameter( 'continue',
$this->getContinue( $row ) );
+ break;
+ }
+
+ $vals = $this->extractRowInfo( $row );
+ $fit = $result->addValue( array( 'query',
$this->getModuleName() ), null, $vals );
+ if ( !$fit ) {
+ $this->setContinueEnumParameter( 'continue',
$this->getContinue( $row ) );
+ break;
+ }
+ }
+ $result->setIndexedTagName_internal( array( 'query',
$this->getModuleName() ), 'comment' );
+ }
+
+ protected function getContinue( $row ) {
+ $ts = wfTimestamp( TS_MW, $row->mbf_timestamp );
+ return "$ts|{$row->mbf_type}|{$row->mbf_id}";
+ }
+
+ protected function applyContinue( $continue, $sortDesc, $useType ) {
+ $vals = explode( '|', $continue, 4 );
+ if ( count( $vals ) !== 3 ) {
+ // TODO this should be a standard message in ApiBase
+ $this->dieUsage( 'Invalid continue param. You should
pass the original value returned by the previous query', 'badcontinue' );
+ }
+
+ $db = $this->getDB();
+ $ts = $db->addQuotes( $db->timestamp( $vals[0] ) );
+ $type = $db->addQuotes( $vals[1] );
+ $id = intval( $vals[2] );
+ $op = $sortDesc ? '<' : '>';
+ // TODO there should be a standard way to do this in
DatabaseBase or ApiQueryBase something
+ if ( $useType ) {
+ $this->addWhere( "mbf_type $op $type OR " .
+ "(mbf_type = $type AND " .
+ "(mbf_timestamp $op $ts OR " .
+ "(mbf_timestamp = $ts AND " .
+ "mbf_id $op= $id)))"
+ );
+ } else {
+ $this->addWhere( "mbf_timestamp $op $ts OR " .
+ "(mbf_timestamp = $ts AND " .
+ "mbf_id $op= $id)"
+ );
+ }
+ }
+
+ protected function extractRowInfo( $row ) {
+ $r = array(
+ 'id' => intval( $row->mbf_id ),
+ 'type' => $row->mbf_type,
+ 'timestamp' => wfTimestamp( TS_ISO_8601,
$row->mbf_timestamp ),
+ 'userid' => intval( $row->mbf_user_id ),
+ 'username' => $row->mbf_user_ip === null ?
$row->user_name : $row->mbf_user_ip,
+ );
+ ApiResult::setContent( $r, $row->mbf_comment );
+ return $r;
+ }
+
+ public function getAllowedParams() {
+ return array(
+ 'limit' => array(
+ ApiBase::PARAM_DFLT => 10,
+ ApiBase::PARAM_TYPE => 'limit',
+ ApiBase::PARAM_MIN => 1,
+ ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
+ ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
+ ),
+ 'dir' => array(
+ ApiBase::PARAM_DFLT => 'older',
+ ApiBase::PARAM_TYPE => array(
+ 'newer',
+ 'older'
+ )
+ ),
+ 'continue' => null,
+ 'type' => array(
+ ApiBase::PARAM_TYPE =>
MBFeedbackItem::getValidTypes(),
+ ApiBase::PARAM_ISMULTI => true,
+ ApiBase::PARAM_DFLT => '', // all
+ ),
+ 'user' => array(
+ ApiBase::PARAM_TYPE => 'user',
+ ),
+ );
+ }
+
+ public function getVersion() {
+ return __CLASS__ . ': $Id$';
+ }
+
+ public function getParamDescription() {
+ return array(
+ 'limit' => 'How many comments to return',
+ 'continue' => 'When more results are available, use
this to continue',
+ 'type' => 'Only return comments of the given type(s).
If not set or empty, return all comments',
+ 'user' =>' Only return comments submitted by the given
user',
+ );
+ }
+
+ public function getDescription() {
+ return 'List all feedback comments submitted through the
MoodBar extension.';
+ }
+
+ public function getCacheMode( $params ) {
+ return 'public';
+ }
+}
Property changes on: trunk/extensions/MoodBar/ApiQueryMoodBarComments.php
___________________________________________________________________
Added: svn:keywords
+ Id
Added: svn:eol-style
+ native
Modified: trunk/extensions/MoodBar/MoodBar.php
===================================================================
--- trunk/extensions/MoodBar/MoodBar.php 2011-09-23 14:14:55 UTC (rev
97919)
+++ trunk/extensions/MoodBar/MoodBar.php 2011-09-23 14:49:21 UTC (rev
97920)
@@ -20,6 +20,8 @@
// API
$wgAutoloadClasses['ApiMoodBar'] = dirname(__FILE__).'/ApiMoodBar.php';
$wgAPIModules['moodbar'] = 'ApiMoodBar';
+$wgAutoloadClasses['ApiQueryMoodBarComments'] = dirname( __FILE__ ).
'/ApiQueryMoodBarComments.php';
+$wgAPIListModules['moodbarcomments'] = 'ApiQueryMoodBarComments';
// Hooks
$wgAutoloadClasses['MoodBarHooks'] = dirname(__FILE__).'/MoodBar.hooks.php';
Modified: trunk/extensions/MoodBar/sql/MoodBar.sql
===================================================================
--- trunk/extensions/MoodBar/sql/MoodBar.sql 2011-09-23 14:14:55 UTC (rev
97919)
+++ trunk/extensions/MoodBar/sql/MoodBar.sql 2011-09-23 14:49:21 UTC (rev
97920)
@@ -23,8 +23,12 @@
mbf_locale varchar(32) binary null, -- The locale of the user's browser
mbf_editing tinyint unsigned not null, -- Whether or not the user was
editing
mbf_bucket varchar(128) binary null -- Bucket, for A/B testing
-) /*$wgDBtableOptions*/;
+) /*$wgDBTableOptions*/;
-- A little overboard with the indexes perhaps, but we want to be able to dice
this data a lot!
CREATE INDEX /*i*/type_timestamp ON /*_*/moodbar_feedback
(mbf_type,mbf_timestamp);
CREATE INDEX /*i*/title_type ON /*_*/moodbar_feedback
(mbf_namespace,mbf_title,mbf_type,mbf_timestamp);
+-- CREATE INDEX /*i*/mbf_namespace_title_timestamp ON /*_*/moodbar_feedback
(mbf_namespace, mbf_title, mbf_timestamp); --maybe in the future if we actually
do per-page filtering
+CREATE INDEX /*i*/mbf_userid_ip_timestamp ON /*_*/moodbar_feedback
(mbf_user_id, mbf_user_ip, mbf_timestamp);
+CREATE INDEX /*i*/mbf_type_userid_ip_timestamp ON /*_*/moodbar_feedback
(mbf_type, mbf_user_id, mbf_user_ip, mbf_timestamp);
+CREATE INDEX /*i*/mbf_timestamp ON /*_*/moodbar_feedback (mbf_timestamp);
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
