jenkins-bot has submitted this change and it was merged.
Change subject: Initial checkin
......................................................................
Initial checkin
Change-Id: I36163c320c8a3969d6c44b958b967afed8adbac1
---
A .jshintrc
A ApiFeatureUsage.alias.php
A ApiFeatureUsage.php
A ApiFeatureUsageQueryEngine.php
A ApiFeatureUsageQueryEngineElastica.php
A ApiQueryFeatureUsage.php
A COPYING
A SpecialApiFeatureUsage.php
A htmlform/HTMLDateField.php
A htmlform/HTMLDateRangeField.php
A htmlform/ext.apifeatureusage.htmlform.js
A i18n/en.json
A i18n/qqq.json
A modules/ext.apifeatureusage.css
14 files changed, 1,324 insertions(+), 0 deletions(-)
Approvals:
Aaron Schulz: Looks good to me, approved
jenkins-bot: Verified
diff --git a/.jshintrc b/.jshintrc
new file mode 100644
index 0000000..0967ef4
--- /dev/null
+++ b/.jshintrc
@@ -0,0 +1 @@
+{}
diff --git a/ApiFeatureUsage.alias.php b/ApiFeatureUsage.alias.php
new file mode 100644
index 0000000..b98dec9
--- /dev/null
+++ b/ApiFeatureUsage.alias.php
@@ -0,0 +1,15 @@
+<?php
+/**
+ * Aliases for apifeatureusage
+ *
+ * @file
+ * @ingroup Extensions
+ */
+// @codingStandardsIgnoreFile
+
+$specialPageAliases = array();
+
+/** English (English) */
+$specialPageAliases['en'] = array(
+ 'ApiFeatureUsage' => array( 'ApiFeatureUsage' ),
+);
diff --git a/ApiFeatureUsage.php b/ApiFeatureUsage.php
new file mode 100644
index 0000000..a9cbc4c
--- /dev/null
+++ b/ApiFeatureUsage.php
@@ -0,0 +1,79 @@
+<?php
+/**
+ * Query a logging data source (e.g. Elasticsearch/Logstash) for API feature
+ * usage statistics
+ * Copyright (C) 2014 Brad Jorsch <[email protected]>
+ * http://www.mediawiki.org/
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ */
+
+# Alert the user that this is not a valid entry point to MediaWiki if they try
+# to access the special pages file directly.
+if ( !defined( 'MEDIAWIKI' ) ) {
+ echo <<<EOT
+<p>This is the ApiFeatureUsage extension. To enable it, put the following line
+in LocalSettings.php:</p>
+<pre>require_once( "\$IP/extensions/ApiFeatureUsage/ApiFeatureUsage.php"
);</pre>
+EOT;
+ exit( 1 );
+}
+
+$wgExtensionCredits['specialpage'][] = array(
+ 'path' => __FILE__,
+ 'name' => 'ApiFeatureUsage',
+ 'author' => 'Brad Jorsch',
+ 'url' => 'https://www.mediawiki.org/wiki/Extension:ApiFeatureUsage',
+ 'descriptionmsg' => 'apifeatureusage-desc',
+ 'version' => '1.0',
+);
+
+$wgAutoloadClasses['SpecialApiFeatureUsage'] = __DIR__ .
'/SpecialApiFeatureUsage.php';
+$wgAutoloadClasses['ApiQueryFeatureUsage'] = __DIR__ .
'/ApiQueryFeatureUsage.php';
+$wgAutoloadClasses['ApiFeatureUsageQueryEngine'] = __DIR__ .
'/ApiFeatureUsageQueryEngine.php';
+$wgAutoloadClasses['ApiFeatureUsageQueryEngineElastica'] = __DIR__ .
'/ApiFeatureUsageQueryEngineElastica.php';
+
+$wgMessagesDirs['ApiFeatureUsage'] = __DIR__ . '/i18n';
+$wgExtensionMessagesFiles['ApiFeatureUsageAlias'] = __DIR__ .
'/ApiFeatureUsage.alias.php';
+$wgSpecialPages['ApiFeatureUsage'] = 'SpecialApiFeatureUsage';
+$wgSpecialPageGroups['ApiFeatureUsage'] = 'wiki';
+$wgAPIMetaModules['featureusage'] = 'ApiQueryFeatureUsage';
+$wgConfigRegistry['ApiFeatureUsage'] = 'GlobalVarConfig::newInstance';
+
+$wgResourceModules['ext.apifeatureusage'] = array(
+ 'localBasePath' => __DIR__ . '/modules',
+ 'remoteExtPath' => 'ApiFeatureUsage/modules',
+ 'styles' => 'ext.apifeatureusage.css',
+ 'position' => 'top',
+);
+
+/**
+ * Engine configuration. Must contain either a 'class' or a 'factory' member;
+ * other members depend on the engine.
+ */
+$wgApiFeatureUsageQueryEngineConf = array();
+
+/**
+ * @todo HTMLForm stuff should be migrated to core
+ */
+$wgAutoloadClasses['ApiFeatureUsage_HTMLDateField'] = __DIR__ .
'/htmlform/HTMLDateField.php';
+$wgAutoloadClasses['ApiFeatureUsage_HTMLDateRangeField'] = __DIR__ .
'/htmlform/HTMLDateRangeField.php';
+$wgAutoloadClasses['ApiFeatureUsage_HTMLFormRadioRangeColumnLabels'] = __DIR__
. '/htmlform/HTMLFormRadioRangeColumnLabels.php';
+$wgResourceModules['ext.apifeatureusage.htmlform'] = array(
+ 'localBasePath' => __DIR__ . '/htmlform',
+ 'remoteExtPath' => 'ApiFeatureUsage/htmlform',
+ 'scripts' => 'ext.apifeatureusage.htmlform.js',
+);
diff --git a/ApiFeatureUsageQueryEngine.php b/ApiFeatureUsageQueryEngine.php
new file mode 100644
index 0000000..a7b12f0
--- /dev/null
+++ b/ApiFeatureUsageQueryEngine.php
@@ -0,0 +1,44 @@
+<?php
+abstract class ApiFeatureUsageQueryEngine {
+ public $options;
+
+ /**
+ * @return ApiFeatureUsageQueryEngine
+ */
+ public static function getEngine( Config $config ) {
+ $conf = $config->get( 'ApiFeatureUsageQueryEngineConf' );
+ if ( isset( $conf['factory'] ) ) {
+ return $conf['factory']( $conf );
+ } elseif ( isset( $conf['class'] ) ) {
+ return new $conf['class']( $conf );
+ } else {
+ throw new MWException(
'$wgApiFeatureUsageQueryEngineConf does not define an engine' );
+ }
+ }
+
+ /**
+ * @param array $options
+ */
+ public function __construct( array $options ) {
+ $this->options = $options;
+ }
+
+ /**
+ * Execute the query
+ *
+ * Status object's value is an array of arrays, with the subarrays each
+ * having keys 'feature', 'date', and 'count'.
+ *
+ * @param string $agent
+ * @param MWTimestamp $start
+ * @param MWTimestamp $end
+ * @return Status
+ */
+ abstract public function execute( $agent, MWTimestamp $start,
MWTimestamp $end );
+
+ /**
+ * Get a suggested date range
+ * @return MWTimestamp[]
+ */
+ abstract public function suggestDateRange();
+}
diff --git a/ApiFeatureUsageQueryEngineElastica.php
b/ApiFeatureUsageQueryEngineElastica.php
new file mode 100644
index 0000000..3b38364
--- /dev/null
+++ b/ApiFeatureUsageQueryEngineElastica.php
@@ -0,0 +1,177 @@
+<?php
+/**
+ * Query feature usage data from Elasticsearch.
+ *
+ * Config fields are:
+ * serverList: Array of servers to connect to
+ * maxConnectionAttempts: Maximum connection attempts
+ * indexPrefix: Index prefix
+ * indexFormat: Date format string for index
+ * type: Elasticsearch type to be searched
+ * featureField: Name of the field holding $feature
+ * timestampField: Name of the field holding the timestamp
+ * agentField: Name of the field holding the user agent
+ */
+class ApiFeatureUsageQueryEngineElastica extends ApiFeatureUsageQueryEngine {
+ private $client = null;
+ private $indexNames = null;
+
+ public function __construct( array $options ) {
+ $options += array(
+ 'indexPrefix' => 'apifeatureusage-',
+ 'indexFormat' => 'Y.m.d',
+ 'type' => 'api-feature-usage-sanitized',
+ 'featureField' => 'feature',
+ 'timestampField' => '@timestamp',
+ 'agentField' => 'agent',
+ );
+
+ parent::__construct( $options );
+ }
+
+ protected function getClient() {
+ if ( !$this->client ) {
+ $connection = new
ApiFeatureUsageQueryEngineElasticaConnection( $this->options );
+ $this->client = $connection->getClient2();
+ }
+ return $this->client;
+ }
+
+ protected function getIndexNames() {
+ if ( !$this->indexNames ) {
+ $this->indexNames =
$this->getClient()->getCluster()->getIndexNames();
+ }
+ return $this->indexNames;
+ }
+
+ public function execute( $agent, MWTimestamp $start, MWTimestamp $end )
{
+ $status = Status::newGood( array() );
+
+ $query = new Elastica\Query();
+
+ $bools = new Elastica\Filter\Bool();
+ $bools->addMust( new Elastica\Filter\Prefix(
$this->options['agentField'], $agent ) );
+ $bools->addMust( new Elastica\Filter\Range(
$this->options['timestampField'], array(
+ 'from' => $start->getTimestamp( TS_ISO_8601 ),
+ 'to' => $end->getTimestamp( TS_ISO_8601 ),
+ ) ) );
+ $query->setQuery( new Elastica\Query\Filtered( null, $bools ) );
+
+ $termsAgg = new Elastica\Aggregation\Terms( 'feature' );
+ $termsAgg->setField( $this->options['featureField'] );
+ $termsAgg->setSize( 0 );
+
+ $datesAgg = new Elastica\Aggregation\DateHistogram(
+ 'date', $this->options['timestampField'], 'day'
+ );
+ $datesAgg->setFormat( 'yyyy-MM-dd' );
+
+ $termsAgg->addAggregation( $datesAgg );
+ $query->addAggregation( $termsAgg );
+
+ $search = new Elastica\Search( $this->getClient() );
+ $search->setOption(
+ Elastica\Search::OPTION_SEARCH_TYPE,
Elastica\Search::OPTION_SEARCH_TYPE_COUNT
+ );
+
+ $allIndexes = $this->getIndexNames();
+ $indexes = array();
+ $skippedAny = false;
+ $s = clone $start->timestamp;
+ $s->setTime( 0, 0, 0 );
+ $oneday = new DateInterval( 'P1D' );
+ while ( $s <= $end->timestamp ) {
+ $index = $this->options['indexPrefix'] . $s->format(
$this->options['indexFormat'] );
+ if ( in_array( $index, $allIndexes ) ) {
+ $indexes[] = $index;
+ } else {
+ $skippedAny = true;
+ }
+ $s->add( $oneday );
+ }
+ if ( !$indexes ) {
+ // No dates in range
+ $status->warning( 'apifeatureusage-no-indexes' );
+ return $status;
+ }
+ if ( $skippedAny ) {
+ $status->warning( 'apifeatureusage-missing-indexes' );
+ }
+
+ $search->addType( $this->options['type'] );
+ $search->setQuery( $query );
+
+ $res = $search->search();
+
+ if ( $res->getResponse()->hasError() ) {
+ return Status::newFatal(
+ 'apifeatureusage-elasticsearch-error',
$res->getResponse()->getError()
+ );
+ }
+
+ $ret = array();
+ $aggs = $res->getAggregations();
+ if ( isset( $aggs['feature'] ) ) {
+ foreach ( $aggs['feature']['buckets'] as $feature ) {
+ foreach ( $feature['date']['buckets'] as $date
) {
+ $ret[] = array(
+ 'feature' => $feature['key'],
+ 'date' =>
$date['key_as_string'],
+ 'count' => $date['doc_count'],
+ );
+ }
+ }
+ }
+ $status->value = $ret;
+
+ return $status;
+ }
+
+ public function suggestDateRange() {
+ $start = new MWTimestamp();
+ $start->setTimezone( 'UTC' );
+ $start->timestamp->setTime( 0, 0, 0 );
+ $end = new MWTimestamp();
+ $end->setTimezone( 'UTC' );
+
+ $oneday = new DateInterval( 'P1D' );
+ $allIndexes = $this->getIndexNames();
+ while ( true ) {
+ $start->timestamp->sub( $oneday );
+ $index = $this->options['indexPrefix'] .
$start->format( $this->options['indexFormat'] );
+ if ( !in_array( $index, $allIndexes ) ) {
+ $start->timestamp->add( $oneday );
+ return array( $start, $end );
+ }
+ }
+ }
+}
+
+/**
+ * Class to create the connection
+ */
+class ApiFeatureUsageQueryEngineElasticaConnection extends ElasticaConnection {
+ private $options = array();
+
+ public function __construct( $options = null ) {
+ if ( !is_array( $options ) ) {
+ $options = array();
+ }
+
+ if ( empty( $options['serverList'] ) || !is_array(
$options['serverList'] ) ) {
+ throw new MWException( __METHOD__ . ': serverList is
not set or is not valid.' );
+ }
+
+ $this->options = $options + array(
+ 'maxConnectionAttempts' => 1,
+ );
+ }
+
+ public function getServerList() {
+ return $this->options['serverList'];
+ }
+
+ public function getMaxConnectionAttempts() {
+ return $this->options['maxConnectionAttempts'];
+ }
+}
diff --git a/ApiQueryFeatureUsage.php b/ApiQueryFeatureUsage.php
new file mode 100644
index 0000000..cf7b247
--- /dev/null
+++ b/ApiQueryFeatureUsage.php
@@ -0,0 +1,87 @@
+<?php
+class ApiQueryFeatureUsage extends ApiQueryBase {
+
+ public function __construct( ApiQuery $query, $moduleName ) {
+ parent::__construct( $query, $moduleName, 'afu' );
+ }
+
+ function execute() {
+ $params = $this->extractRequestParams();
+
+ $agent = $params['agent'] === null
+ ? $this->getMain()->getUserAgent()
+ : $params['agent'];
+ if ( empty( $agent ) ) {
+ $encParamName = $this->encodeParamName( $paramName );
+ $this->dieUsage( 'Cannot query an empty user agent',
"bad_$encParamName" );
+ }
+
+ $conf = ConfigFactory::getDefaultInstance()->makeConfig(
'ApiFeatureUsage' );
+ $engine = ApiFeatureUsageQueryEngine::getEngine( $conf );
+
+ if ( $params['start'] === null || $params['end'] === null ) {
+ list( $start, $end ) = $engine->suggestDateRange();
+ }
+ if ( $params['start'] !== null ) {
+ $start = new MWTimestamp( $params['start'] );
+ $start->setTimezone( 'UTC' );
+ }
+ if ( $params['end'] !== null ) {
+ $end = new MWTimestamp( $params['end'] );
+ $end->setTimezone( 'UTC' );
+ }
+
+ $status = $engine->execute( $agent, $start, $end );
+ if ( !$status->isOk() ) {
+ $this->dieStatus( $status );
+ }
+
+ foreach ( $status->getWarningsArray() as $warning ) {
+ if ( !$warning instanceof Message ) {
+ $key = array_shift( $warning );
+ $warning = $this->msg( $key, $warning );
+ }
+ $this->setWarning( $warning->inLanguage( 'en'
)->useDatabase( false )->plain() );
+ }
+
+ $r = array(
+ 'agent' => $agent,
+ 'start' => $start->getTimestamp( TS_ISO_8601 ),
+ 'end' => $end->getTimestamp( TS_ISO_8601 ),
+ 'usage' => $status->value,
+ );
+
+ $this->getResult()->setIndexedTagName( $r['usage'], 'v' );
+ $this->getResult()->addValue( 'query', $this->getModuleName(),
$r );
+ }
+
+ public function getAllowedParams() {
+ return array(
+ 'start' => array(
+ ApiBase::PARAM_TYPE => 'timestamp',
+ ),
+ 'end' => array(
+ ApiBase::PARAM_TYPE => 'timestamp',
+ ),
+ 'agent' => array(
+ ApiBase::PARAM_TYPE => 'string',
+ ),
+ 'features' => array(
+ ApiBase::PARAM_TYPE => 'string',
+ ApiBase::PARAM_ISMULTI => true,
+ ),
+ );
+ }
+
+ protected function getExamplesMessages() {
+ return array(
+ 'action=query&meta=apifeatureusage'
+ => 'apihelp-query+userinfo-example-simple',
+ );
+ }
+
+ public function getHelpUrls() {
+ return
'https://www.mediawiki.org/wiki/Extension:ApiFeatureUsage';
+ }
+
+}
diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000..d159169
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,339 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
diff --git a/SpecialApiFeatureUsage.php b/SpecialApiFeatureUsage.php
new file mode 100644
index 0000000..f5238b0
--- /dev/null
+++ b/SpecialApiFeatureUsage.php
@@ -0,0 +1,131 @@
+<?php
+class SpecialApiFeatureUsage extends SpecialPage {
+ private $engine = null;
+
+ function __construct() {
+ parent::__construct( 'ApiFeatureUsage' );
+ }
+
+ function execute( $par ) {
+ $this->setHeaders();
+ $this->checkPermissions();
+
+ /** @todo These should be migrated to core, once the jquery.ui
+ * objectors write their own date picker. */
+ if ( !isset( HTMLForm::$typeMappings['date'] ) || !isset(
HTMLForm::$typeMappings['daterange'] ) ) {
+ HTMLForm::$typeMappings['date'] =
'ApiFeatureUsage_HTMLDateField';
+ HTMLForm::$typeMappings['daterange'] =
'ApiFeatureUsage_HTMLDateRangeField';
+ $this->getOutput()->addModules(
'ext.apifeatureusage.htmlform' );
+ }
+
+ $request = $this->getRequest();
+
+ $conf = ConfigFactory::getDefaultInstance()->makeConfig(
'ApiFeatureUsage' );
+ $this->engine = ApiFeatureUsageQueryEngine::getEngine( $conf );
+ list( $start, $end ) = $this->engine->suggestDateRange();
+
+ $form = new HTMLForm( array(
+ 'agent' => array(
+ 'type' => 'text',
+ 'default' => '',
+ 'label-message' =>
'apifeatureusage-agent-label',
+ 'required' => true,
+ ),
+
+ 'dates' => array(
+ 'type' => 'daterange',
+ 'label-message' =>
'apifeatureusage-dates-label',
+ 'layout-message' =>
'apifeatureusage-dates-layout',
+ 'absolute' => true,
+ 'required' => true,
+ 'default' => array(
+ $start->format( 'Y-m-d' ),
+ $end->format( 'Y-m-d' ),
+ ),
+ ),
+ ), $this->getContext() );
+ $form->setMethod( 'get' );
+ $form->setSubmitCallback( array( $this, 'onSubmit' ) );
+ $form->setWrapperLegend( $this->msg( 'apifeatureusage-legend' )
);
+ $form->addHeaderText( $this->msg( 'apifeatureusage-text'
)->parseAsBlock() );
+ $form->setSubmitTextMsg( 'apifeatureusage-submit' );
+
+ $form->prepareForm();
+ if ( $request->getCheck( 'wpagent' ) || $request->getCheck(
'wpdates' ) ) {
+ $status = $form->trySubmit();
+ } else {
+ $status = false;
+ }
+ $form->displayForm( $status );
+
+ if ( $status instanceof Status && $status->isOk() ) {
+ $out = $this->getOutput();
+ $out->addModuleStyles( 'ext.apifeatureusage' );
+
+ $warnings = array();
+ foreach ( $status->getWarningsArray() as $warning ) {
+ if ( !$warning instanceof Message ) {
+ $key = array_shift( $warning );
+ $warning = $this->msg( $key, $warning );
+ }
+ $warnings[] = $warning->plain();
+ }
+ if ( $warnings ) {
+ if ( count( $warnings ) > 1 ) {
+ $warnings = "\n* " . join( "\n* ",
$warnings );
+ } else {
+ $warnings = $warnings[0];
+ }
+ $out->wrapWikiMsg( "<div
class='error'>\n$1\n</div>",
+ array( 'apifeatureusage-warnings',
$warnings )
+ );
+ }
+
+ $lang = $this->getLanguage();
+ $rows = array();
+ foreach ( $status->value as $row ) {
+ $cells = array();
+ $cells[] = Html::element( 'td', array(),
$row['feature'] );
+ $cells[] = Html::rawElement( 'td', array(),
+ Html::element( 'time', array(),
$row['date'] )
+ );
+ $cells[] = Html::element( 'td', array( 'class'
=> 'count' ),
+ $lang->formatNum( $row['count'] )
+ );
+
+ $rows[] = Html::rawElement( 'tr', array(),
join( '', $cells ) );
+ }
+ $this->getOutput()->addHTML(
+ Html::rawElement( 'table', array( 'class' =>
'wikitable sortable apifeatureusage' ),
+ Html::rawElement( 'thead', array(),
+ Html::rawElement( 'tr', array(),
+ Html::rawElement( 'th',
array(),
+ $this->msg(
'apifeatureusage-column-feature' )->parse()
+ ) .
+ Html::rawElement( 'th',
array(),
+ $this->msg(
'apifeatureusage-column-date' )->parse()
+ ) .
+ Html::rawElement( 'th',
array(),
+ $this->msg(
'apifeatureusage-column-uses' )->parse()
+ )
+ )
+ ) .
+ Html::rawElement( 'tbody', array(),
join( '', $rows ) )
+ )
+ );
+ }
+ }
+
+ public function onSubmit( $data, $form ) {
+ wfProfileIn( __METHOD__ );
+
+ $agent = $data['agent'];
+ $start = new MWTimestamp( $data['dates'][0] . 'T00:00:00Z' );
+ $end = new MWTimestamp( $data['dates'][1] . 'T23:59:59Z' );
+
+ $status = $this->engine->execute( $agent, $start, $end );
+ wfProfileOut( __METHOD__ );
+ return $status;
+ }
+
+}
diff --git a/htmlform/HTMLDateField.php b/htmlform/HTMLDateField.php
new file mode 100644
index 0000000..e9a098b
--- /dev/null
+++ b/htmlform/HTMLDateField.php
@@ -0,0 +1,118 @@
+<?php
+
+/**
+ * A field that will contain a date
+ *
+ * Currently recognizes only YYYY-MM-DD formatted dates.
+ *
+ * Besides the parameters recognized by HTMLTextField, additional recognized
+ * parameters in the field descriptor array include:
+ * min - The minimum date to allow, in any recognized format.
+ * max - The maximum date to allow, in any recognized format.
+ * placeholder - The default comes from the htmlform-date-placeholder message.
+ *
+ * The result is a formatted date.
+ *
+ * @todo These should be migrated to core, once the jquery.ui objectors write
+ * their own date picker.
+ */
+class ApiFeatureUsage_HTMLDateField extends HTMLTextField {
+ function getSize() {
+ return isset( $this->mParams['size'] ) ? $this->mParams['size']
: 10;
+ }
+
+ public function getAttributes( array $list ) {
+ $parentList = array_diff( $list, array( 'min', 'max' ) );
+ $ret = parent::getAttributes( $parentList );
+
+ if ( in_array( 'placeholder', $list ) && !isset(
$ret['placeholder'] ) ) {
+ $ret['placeholder'] = $this->msg(
'apifeatureusage-htmlform-date-placeholder' )->text();
+ }
+
+ if ( in_array( 'min', $list ) && isset( $this->mParams['min'] )
) {
+ $min = $this->parseDate( $this->mParams['min'] );
+ if ( $min ) {
+ $ret['min'] = $this->formatDate( $min );
+ // Because Html::expandAttributes filters it out
+ $ret['data-min'] = $ret['min'];
+ }
+ }
+ if ( in_array( 'max', $list ) && isset( $this->mParams['max'] )
) {
+ $max = $this->parseDate( $this->mParams['max'] );
+ if ( $max ) {
+ $ret['max'] = $this->formatDate( $max );
+ // Because Html::expandAttributes filters it out
+ $ret['data-max'] = $ret['max'];
+ }
+ }
+
+ $ret['type'] = 'date';
+
+ return $ret;
+ }
+
+ function loadDataFromRequest( $request ) {
+ if ( !$request->getCheck( $this->mName ) ) {
+ return $this->getDefault();
+ }
+
+ $value = $request->getText( $this->mName );
+ $date = $this->parseDate( $value );
+ return $date ? $this->formatDate( $date ) : $value;
+ }
+
+ function validate( $value, $alldata ) {
+ $p = parent::validate( $value, $alldata );
+
+ if ( $p !== true ) {
+ return $p;
+ }
+
+ if ( $value === '' ) {
+ // required was already checked by parent::validate
+ return true;
+ }
+
+ $date = $this->parseDate( $value );
+ if ( !$date ) {
+ return $this->msg(
'apifeatureusage-htmlform-date-invalid' )->parseAsBlock();
+ }
+
+ if ( isset( $this->mParams['min'] ) ) {
+ $min = $this->parseDate( $this->mParams['min'] );
+ if ( $min && $date < $min ) {
+ return $this->msg(
'apifeatureusage-htmlform-date-toolow', $this->formatDate( $min ) )
+ ->parseAsBlock();
+ }
+ }
+
+ if ( isset( $this->mParams['max'] ) ) {
+ $max = $this->parseDate( $this->mParams['max'] );
+ if ( $max && $date > $max ) {
+ return $this->msg(
'apifeatureusage-htmlform-date-toohigh', $this->formatDate( $max ) )
+ ->parseAsBlock();
+ }
+ }
+
+ return true;
+ }
+
+ protected function parseDate( $value ) {
+ $value = trim( $value );
+
+ /* @todo: Language should probably provide a "parseDate" method
of some sort. */
+ try {
+ $date = new DateTime( "$value T00:00:00+0000", new
DateTimeZone( 'GMT' ) );
+ return $date->getTimestamp();
+ } catch ( Exception $ex ) {
+ return 0;
+ }
+ }
+
+ protected function formatDate( $value ) {
+ // For now just use Y-m-d. At some point someone may want to
add a
+ // config option.
+ return gmdate( 'Y-m-d', $value );
+ }
+
+}
diff --git a/htmlform/HTMLDateRangeField.php b/htmlform/HTMLDateRangeField.php
new file mode 100644
index 0000000..1c39b32
--- /dev/null
+++ b/htmlform/HTMLDateRangeField.php
@@ -0,0 +1,206 @@
+<?php
+
+/**
+ * A field that will contain a date range
+ *
+ * Besides the parameters recognized by HTMLDateField, additional recognized
+ * parameters in the field descriptor array include:
+ * absolute - Boolean, whether to select the end date absolutely rather
+ * than as a number of days offset from the start date.
+ * options - If specified, the "number of days" field is displayed as a
+ * <select>. Otherwise it's an 'int' textbox.
+ * min-days - If the "number of days" field is a textbox, this is the minimum
+ * allowed. If less than 1, 1 is used.
+ * max-days - If the "number of days" field is a textbox, this is the maximum
+ * allowed.
+ * layout-message - The starting date field (as $1) and "number of days" or
+ * ending date field (as $2) are layed out using this message. Default is
+ * 'apifeatureusage-htmlform-daterange-relative-layout' or
+ * 'apifeatureusage-htmlform-daterange-absolute-layout', depending on
'absolute'.
+ *
+ * The result is an empty array or an array with two values, the first being
+ * the starting date and the second being either the number of days or the
+ * ending date.
+ *
+ * @todo These should be migrated to core, once the jquery.ui objectors write
+ * their own date picker.
+ */
+class ApiFeatureUsage_HTMLDateRangeField extends ApiFeatureUsage_HTMLDateField
{
+ function loadDataFromRequest( $request ) {
+ $absolute = !empty( $this->mParams['absolute'] );
+ if ( !$request->getCheck( $this->mName ) ||
+ !$request->getCheck( $this->mName . ( $absolute ?
'-end' : '-days' ) )
+ ) {
+ return $this->getDefault();
+ }
+
+ $value1 = $request->getText( $this->mName );
+ if ( $value1 !== '' ) {
+ $startDate = $this->parseDate( $value1 );
+ $value1 = $startDate ? $this->formatDate( $startDate )
: $value1;
+ }
+
+ if ( $absolute ) {
+ $value2 = $request->getText( $this->mName . '-end' );
+ if ( $value2 !== '' ) {
+ $endDate = $this->parseDate( $value2 );
+ $value2 = $endDate ? $this->formatDate(
$endDate ) : $value2;
+ }
+ } else {
+ $value2 = $request->getText( $this->mName . '-days' );
+ }
+
+ if ( $value1 === '' && ( !$absolute || $value2 === '' ) ) {
+ return array();
+ }
+
+ return array( $value1, $value2 );
+ }
+
+ function validate( $value, $alldata ) {
+ if ( $this->isHidden( $alldata ) ) {
+ return true;
+ }
+
+ if ( $value === array() ) {
+ if ( isset( $this->mParams['required'] ) &&
$this->mParams['required'] !== false ) {
+ return $this->msg( 'htmlform-required'
)->parse();
+ }
+ return true;
+ }
+
+ $p = parent::validate( $value[0], $alldata );
+ if ( $p !== true ) {
+ return $p;
+ }
+
+ if ( !empty( $this->mParams['absolute'] ) ) {
+ if ( $value[0] === '' || $value[1] === '' ) {
+ return $this->msg(
'apifeatureusage-htmlform-daterange-error-partial' )->parse();
+ }
+
+ $endDate = $value[1];
+ if ( $this->parseDate( $value[0] ) >= $this->parseDate(
$value[1] ) ) {
+ return $this->msg(
'apifeatureusage-htmlform-daterange-end-before-start' )->parseAsBlock();
+ }
+ } else {
+ $opts = $this->getOptions();
+ if ( $opts ) {
+ if ( !in_array( $value[1], $opts ) ) {
+ return $this->msg(
'apifeatureusage-htmlform-daterange-days-badoption' )->parseAsBlock();
+ }
+ } else {
+ if ( !preg_match( '/^(\+|\-)?\d+$/', trim(
$value[1] ) ) ) {
+ return $this->msg(
'apifeatureusage-htmlform-daterange-days-invalid' )->parseAsBlock();
+ }
+
+ if ( isset( $this->mParams['min-days'] ) ) {
+ $min = max( 1,
$this->mParams['min-days'] );
+ } else {
+ $min = 1;
+ }
+ if ( $min > $value[1] ) {
+ return $this->msg(
'apifeatureusage-htmlform-daterange-days-toolow' )->numParams( $min )
+ ->parseAsBlock();
+ }
+
+ if ( isset( $this->mParams['max-days'] ) ) {
+ $max = $this->mParams['max-days'];
+
+ if ( $max < $value[1] ) {
+ return $this->msg(
'apifeatureusage-htmlform-daterange-days-toohigh' )->numParams( $max )
+ ->parseAsBlock();
+ }
+ }
+ }
+
+ $endDate = $this->formatDate( $this->parseDate(
$value[0] ) + $value[1] * 86400 );
+ }
+
+ $p = parent::validate( $endDate, $alldata );
+ if ( $p !== true ) {
+ return $p;
+ }
+
+ return true;
+ }
+
+ function getInputHTML( $value ) {
+ if ( $value === array() ) {
+ $value = array( '', '' );
+ }
+
+ $startpicker = parent::getInputHTML( $value[0] );
+
+ if ( !empty( $this->mParams['absolute'] ) ) {
+ $msg =
'apifeatureusage-htmlform-daterange-absolute-layout';
+ $oldName = $this->mName;
+ $oldID= $this->mID;
+ $this->mName .= '-end';
+ $this->mID .= '-end';
+ $endpicker = parent::getInputHTML( $value[1] );
+ $this->mName = $oldName;
+ $this->mID = $oldID;
+ } else {
+ $msg =
'apifeatureusage-htmlform-daterange-relative-layout';
+ $opts = $this->getOptions();
+ if ( $opts ) {
+ $select = new XmlSelect(
+ $this->mName . '-days', $this->mID .
'-days', strval( $value[1] )
+ );
+
+ if ( !empty( $this->mParams['disabled'] ) ) {
+ $select->setAttribute( 'disabled',
'disabled' );
+ }
+
+ if ( isset( $this->mParams['tabindex'] ) ) {
+ $select->setAttribute( 'tabindex',
$this->mParams['tabindex'] );
+ }
+
+ if ( $this->mClass !== '' ) {
+ $select->setAttribute( 'class',
$this->mClass );
+ }
+
+ $select->addOptions( $this->getOptions() );
+
+ $endpicker = $select->getHTML();
+ } else {
+ $textAttribs = array(
+ 'id' => $this->mID . '-days',
+ 'size' => $this->getSize(),
+ 'min' => 1,
+ );
+
+ if ( $this->mClass !== '' ) {
+ $textAttribs['class'] = $this->mClass;
+ }
+
+ $allowedParams = array(
+ 'required',
+ 'autofocus',
+ 'disabled',
+ 'tabindex'
+ );
+
+ $textAttribs += $this->getAttributes(
$allowedParams );
+
+ if ( isset( $this->mParams['min-days'] ) ) {
+ $textAttribs['min'] = max( 1,
$this->mParams['min-days'] );
+ }
+
+ if ( isset( $this->mParams['max-days'] ) ) {
+ $textAttribs['max'] =
$this->mParams['max-days'];
+ }
+
+ $endpicker = Html::input( $this->mName .
'-days', $value[1], 'number', $textAttribs );
+ }
+ }
+
+ if ( isset( $this->mParams['layout-message'] ) ) {
+ $msg = $this->mParams['layout-message'];
+ }
+
+ return $this->msg( $msg )->rawParams( $startpicker, $endpicker
)->parse();
+ }
+
+}
diff --git a/htmlform/ext.apifeatureusage.htmlform.js
b/htmlform/ext.apifeatureusage.htmlform.js
new file mode 100644
index 0000000..212d70a
--- /dev/null
+++ b/htmlform/ext.apifeatureusage.htmlform.js
@@ -0,0 +1,40 @@
+/**
+ * Utility functions for HTMLForm date picker
+ */
+( function ( mw, $ ) {
+
+ mw.hook( 'htmlform.enhance' ).add( function ( $root ) {
+ var inputs, i;
+
+ inputs = $root.find( 'input[type=date]' );
+ if ( inputs.length === 0 ) {
+ return;
+ }
+
+ // Assume that if the browser implements validation for <input
type=date>
+ // (so it rejects "bogus" as a value) then it supports a date
picker too.
+ i = document.createElement( 'input' );
+ i.setAttribute( 'type', 'date' );
+ i.value = 'bogus';
+ if ( i.value === 'bogus' ) {
+ mw.loader.using( 'jquery.ui.datepicker', function () {
+ inputs.each( function () {
+ var $i = $( this );
+ // Reset the type, Just In Case
+ $i.prop( 'type', 'text' );
+ $i.datepicker( {
+ dateFormat: 'yy-mm-dd',
+ constrainInput: true,
+ showOn: 'focus',
+ changeMonth: true,
+ changeYear: true,
+ showButtonPanel: true,
+ minDate: $i.data( 'min' ),
+ maxDate: $i.data( 'max' ),
+ } );
+ } );
+ } );
+ }
+ } );
+
+}( mediaWiki, jQuery ) );
diff --git a/i18n/en.json b/i18n/en.json
new file mode 100644
index 0000000..5cc9209
--- /dev/null
+++ b/i18n/en.json
@@ -0,0 +1,42 @@
+{
+ "@metadata": {
+ "authors": [
+ "Brad Jorsch"
+ ]
+ },
+ "apifeatureusage": "Api feature usage",
+ "apifeatureusage-desc": "Get a summary of logged API feature usages for
a user agent.",
+ "apifeatureusage-elasticsearch-error": "Elasticsearch error: $1",
+ "apifeatureusage-legend": "API feature usage",
+ "apifeatureusage-text": "",
+ "apifeatureusage-agent-label": "User agent:",
+ "apifeatureusage-dates-label": "Date range:",
+ "apifeatureusage-dates-layout": "$1 – $2",
+ "apifeatureusage-submit": "Fetch data",
+ "apifeatureusage-no-indexes": "No data is available for the specified
date range.",
+ "apifeatureusage-missing-indexes": "No data is available for part of
the specified date range.",
+ "apifeatureusage-warnings": "Warning: $1",
+ "apifeatureusage-column-feature": "Feature",
+ "apifeatureusage-column-date": "Date",
+ "apifeatureusage-column-uses": "Uses",
+ "apihelp-query+featureusage-description": "Get a summary of logged API
feature usages for a user agent.",
+ "apihelp-query+featureusage-param-start": "Start of date range to
query.",
+ "apihelp-query+featureusage-param-end": "End of date range to query.",
+ "apihelp-query+featureusage-param-agent": "User agent to query. If not
specified, the agent in the request will be queried.",
+ "apihelp-query+featureusage-param-features": "If specified, return
details on only these features.",
+ "apihelp-query+userinfo-example-simple": "Query feature usage for the
current user agent",
+
+ "apifeatureusage-htmlform-date-placeholder": "YYYY-MM-DD",
+ "apifeatureusage-htmlform-date-invalid": "The value you specified is
not a recognized date. Try using YYYY-MM-DD format.",
+ "apifeatureusage-htmlform-date-toolow": "The value you specified is
before the earliest allowed date of $1.",
+ "apifeatureusage-htmlform-date-toohigh": "The value you specified is
after the latest allowed date of $1.",
+ "apifeatureusage-htmlform-daterange-relative-layout": "Start on $1 and
run for $2 days",
+ "apifeatureusage-htmlform-daterange-absolute-layout": "Start on $1 and
end on $2",
+ "apifeatureusage-htmlform-daterange-days-badoption": "The value you
specified for the number of days to run is not a valid option.",
+ "apifeatureusage-htmlform-daterange-days-invalid": "The value you
specified for the number of days to run is not an integer.",
+ "apifeatureusage-htmlform-daterange-days-toolow": "The value you
specified for the number of days to run is below the minimum of
{{PLURAL:$1|$1}}.",
+ "apifeatureusage-htmlform-daterange-days-toohigh": "The value you
specified for the number of days to run is above the maximum of
{{PLURAL:$1|$1}}.",
+ "apifeatureusage-htmlform-daterange-end-before-start": "The end date
given is before the start date.",
+ "apifeatureusage-htmlform-daterange-error-partial": "Both date fields
must be filled or left empty.",
+ "apifeatureusage-htmlform-radiorange-missing-message": "Please specify
a value for column $1"
+}
diff --git a/i18n/qqq.json b/i18n/qqq.json
new file mode 100644
index 0000000..81cafae
--- /dev/null
+++ b/i18n/qqq.json
@@ -0,0 +1,42 @@
+{
+ "@metadata": {
+ "authors": [
+ "Brad Jorsch"
+ ]
+ },
+ "apifeatureusage": "{{doc-special|ApiFeatureUsage}}\nThe name of the
[[mw:Extension:ApiFeatureUsage|ApiFeatureUsage extension]].",
+ "apifeatureusage-desc": "{{desc|name=Api Feature
Usage|url=http://www.mediawiki.org/wiki/Extension:ApiFeatureUsage}}\n\nSee
definition of [[w:User agent|user agent]] on Wikipedia.",
+ "apifeatureusage-elasticsearch-error": "Used to wrap an Elasticsearch
error when reporting it up the stack.\n\nParameters:\n* $1 - Error message from
Elasticsearch.",
+ "apifeatureusage-legend": "Used as a fieldset legend on
[[Special:ApiFeatureUsage]].",
+ "apifeatureusage-text": "{{optional}} Displayed above the form on
[[Special:ApiFeatureUsage]].",
+ "apifeatureusage-agent-label": "Form field label on
[[Special:ApiFeatureUsage]].\n\nSee definition of [[w:User agent|user agent]]
on Wikipedia.",
+ "apifeatureusage-dates-label": "Form field label on
[[Special:ApiFeatureUsage]].",
+ "apifeatureusage-dates-layout": "{{optional}} Used to lay out the text
fields for the date range input on
[[Special:ApiFeatureUsage]].\n\nParameters:\n* $1 - HTML for the starting date
control.\n* $2 - HTML for the second date control.\nSee also:\n*
{{msg-mw|apifeatureusage-htmlform-daterange-absolute-layout}}",
+ "apifeatureusage-submit": "Submit button label on
[[Special:ApiFeatureUsage]].",
+ "apifeatureusage-no-indexes": "Used as a warning message.",
+ "apifeatureusage-missing-indexes": "Used as a warning message.",
+ "apifeatureusage-warnings": "Used to wrap warning messages.",
+ "apifeatureusage-column-feature": "Column header for output table.",
+ "apifeatureusage-column-date": "Column header for output table. Dates
in the column are in the UTC timezone, formatted as Y-m-d (similar to ISO 8601
format).",
+ "apifeatureusage-column-uses": "Column header for output table.",
+ "apihelp-query+featureusage-description":
"{{doc-apihelp-description|query+featureusage|info=See definition of [[w:User
agent|user agent]] on Wikipedia.}}",
+ "apihelp-query+featureusage-param-start":
"{{doc-apihelp-param|query+featureusage|start}}",
+ "apihelp-query+featureusage-param-end":
"{{doc-apihelp-param|query+featureusage|end}}",
+ "apihelp-query+featureusage-param-agent":
"{{doc-apihelp-param|query+featureusage|agent|info=See definition of [[w:User
agent|user agent]] on Wikipedia.}}",
+ "apihelp-query+featureusage-param-features":
"{{doc-apihelp-param|query+featureusage|features}}",
+ "apihelp-query+userinfo-example-simple":
"{{doc-apihelp-example|query+featureusage|info=See definition of [[w:User
agent|user agent]] on Wikipedia.}}",
+
+ "apifeatureusage-htmlform-date-placeholder": "Used as initial
placeholder text in \"date\" input boxes. This date MUST be formatted in the
https://en.wikipedia.org/wiki/ISO_8601 format. You can localise the letters to
your language or script, but you should not change the format.",
+ "apifeatureusage-htmlform-date-invalid": "Used as error message in HTML
forms. This date MUST be formatted in the
https://en.wikipedia.org/wiki/ISO_8601 format. You can localise the letters to
your language or script, but you should not change the format.\n\n*
{{msg-mw|Htmlform-invalid-input}}\n*
{{msg-mw|Apifeatureusage-htmlform-date-placeholder}}\n*
{{msg-mw|Apifeatureusage-htmlform-date-toolow}}\n*
{{msg-mw|Apifeatureusage-htmlform-date-toohigh}}\n*
{{msg-mw|Htmlform-required}}",
+ "apifeatureusage-htmlform-date-toolow": "Used as error message in HTML
forms. Parameters:\n* $1 - minimum date\nSee also:\n*
{{msg-mw|Htmlform-invalid-input}}\n* {{msg-mw|Htmlform-required}}\n*
{{msg-mw|Apifeatureusage-htmlform-date-invalid}}\n*
{{msg-mw|Apifeatureusage-htmlform-date-toohigh}}",
+ "apifeatureusage-htmlform-date-toohigh": "Used as error message in HTML
forms. Parameters:\n* $1 - maximum date\nSee also:\n*
{{msg-mw|Htmlform-invalid-input}}\n* {{msg-mw|Htmlform-required}}\n*
{{msg-mw|Apifeatureusage-htmlform-date-invalid}}\n*
{{msg-mw|Apifeatureusage-htmlform-date-toolow}}",
+ "apifeatureusage-htmlform-daterange-relative-layout": "Used to give
context to the form fields in an HTML form date-range element.\n* $1 - HTML for
the starting date control\n* $2 - HTML for the number-of-days control. This is
an input field to be added by the user and the number is not shown initially,
so \"days\" should be translated as a generic plural of an unknown number.",
+ "apifeatureusage-htmlform-daterange-absolute-layout": "Used to give
context to the form fields in an HTML form date-range element.\n* $1 - HTML for
the starting date control\n* $2 - HTML for the ending date control",
+ "apifeatureusage-htmlform-daterange-days-badoption": "Used as error
message in HTML forms.\n\n* {{msg-mw|Htmlform-invalid-input}}\n*
{{msg-mw|Htmlform-required}}\n* {{msg-mw|Htmlform-int-invalid}}\n*
{{msg-mw|Htmlform-int-toolow}}\n* {{msg-mw|Htmlform-int-toohigh}}\n*
{{msg-mw|Apifeatureusage-htmlform-date-invalid}}\n*
{{msg-mw|Apifeatureusage-htmlform-date-toolow}}\n*
{{msg-mw|Apifeatureusage-htmlform-date-toohigh}}\n*
{{msg-mw|Apifeatureusage-htmlform-daterange-invalid}}\n*
{{msg-mw|Apifeatureusage-htmlform-daterange-toolow}}\n*
{{msg-mw|Apifeatureusage-htmlform-daterange-toohigh}}",
+ "apifeatureusage-htmlform-daterange-days-invalid": "Used as error
message in HTML forms.\n\n* {{msg-mw|Htmlform-invalid-input}}\n*
{{msg-mw|Htmlform-required}}\n* {{msg-mw|Htmlform-int-invalid}}\n*
{{msg-mw|Htmlform-int-toolow}}\n* {{msg-mw|Htmlform-int-toohigh}}\n*
{{msg-mw|Apifeatureusage-htmlform-date-invalid}}\n*
{{msg-mw|Apifeatureusage-htmlform-date-toolow}}\n*
{{msg-mw|Apifeatureusage-htmlform-date-toohigh}}\n*
{{msg-mw|Apifeatureusage-htmlform-daterange-badoption}}\n*
{{msg-mw|Apifeatureusage-htmlform-daterange-toolow}}\n*
{{msg-mw|Apifeatureusage-htmlform-daterange-toohigh}}",
+ "apifeatureusage-htmlform-daterange-days-toolow": "Used as error
message in HTML forms. Parameters:\n* $1 - minimum value\nSee also:\n*
{{msg-mw|Htmlform-invalid-input}}\n* {{msg-mw|Htmlform-required}}\n*
{{msg-mw|Htmlform-int-invalid}}\n* {{msg-mw|Htmlform-int-toolow}}\n*
{{msg-mw|Htmlform-int-toohigh}}\n*
{{msg-mw|Apifeatureusage-htmlform-date-invalid}}\n*
{{msg-mw|Apifeatureusage-htmlform-date-toolow}}\n*
{{msg-mw|Apifeatureusage-htmlform-date-toohigh}}\n*
{{msg-mw|Apifeatureusage-htmlform-daterange-badoption}}\n*
{{msg-mw|Apifeatureusage-htmlform-daterange-invalid}}\n*
{{msg-mw|Apifeatureusage-htmlform-daterange-toohigh}}",
+ "apifeatureusage-htmlform-daterange-days-toohigh": "Used as error
message in HTML forms. Parameters:\n* $1 - maximum value\nSee also:\n*
{{msg-mw|Htmlform-invalid-input}}\n* {{msg-mw|Htmlform-required}}\n*
{{msg-mw|Htmlform-int-invalid}}\n* {{msg-mw|Htmlform-int-toolow}}\n*
{{msg-mw|Htmlform-int-toohigh}}\n*
{{msg-mw|Apifeatureusage-htmlform-date-invalid}}\n*
{{msg-mw|Apifeatureusage-htmlform-date-toolow}}\n*
{{msg-mw|Apifeatureusage-htmlform-date-toohigh}}\n*
{{msg-mw|Apifeatureusage-htmlform-daterange-badoption}}\n*
{{msg-mw|Apifeatureusage-htmlform-daterange-invalid}}\n*
{{msg-mw|Apifeatureusage-htmlform-daterange-toolow}}",
+ "apifeatureusage-htmlform-daterange-end-before-start": "Used as error
message in HTML forms.",
+ "apifeatureusage-htmlform-daterange-error-partial": "Used as error
message in HTML forms.",
+ "apifeatureusage-htmlform-radiorange-missing-message": "Used as error
message in HTML forms. Parameters:\n* $1 - Column number"
+}
diff --git a/modules/ext.apifeatureusage.css b/modules/ext.apifeatureusage.css
new file mode 100644
index 0000000..6994853
--- /dev/null
+++ b/modules/ext.apifeatureusage.css
@@ -0,0 +1,3 @@
+table.apifeatureusage td.count {
+ text-align: right;
+}
--
To view, visit https://gerrit.wikimedia.org/r/174787
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I36163c320c8a3969d6c44b958b967afed8adbac1
Gerrit-PatchSet: 3
Gerrit-Project: mediawiki/extensions/ApiFeatureUsage
Gerrit-Branch: master
Gerrit-Owner: Anomie <[email protected]>
Gerrit-Reviewer: Aaron Schulz <[email protected]>
Gerrit-Reviewer: Anomie <[email protected]>
Gerrit-Reviewer: BryanDavis <[email protected]>
Gerrit-Reviewer: Chad <[email protected]>
Gerrit-Reviewer: Legoktm <[email protected]>
Gerrit-Reviewer: Manybubbles <[email protected]>
Gerrit-Reviewer: Siebrand <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
