maintenance/transstat.php

   1 <?php
   2 /**
   3  * Statistics about the localisation.
   4  *
   5  * @package MediaWiki
   6  * @subpackage Maintenance
   7  *
   8  * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
   9  * @author Ashar Voultoiz <thoane@altern.org>
  10  *
  11  * Output is posted from time to time on:
  12  * http://meta.wikimedia.org/wiki/Localization_statistics
  13  */
  14
  15 require_once( 'commandLine.inc' );
  16 require_once( 'languages.inc' );
  17
  18 if ( isset( $options['help'] ) ) {
  19         showUsage();
  20 }
  21 # Default output is WikiText
  22 if ( !isset( $options['output'] ) ) {
  23         $options['output'] = 'wiki';
  24 }
  25
  26 /** Print a usage message*/
  27 function showUsage() {
  28         print <<<END
  29 Usage: php transstat.php [--help] [--output=csv|text|wiki]
  30         --help : this helpful message
  31         --output : select an output engine one of:
  32                 * 'csv'  : Comma Separated Values.
  33                 * 'wiki' : MediaWiki syntax (default).
  34                 * 'text' : Text with tabs.
  35 Example: php maintenance/transstat.php --output=text
  36
  37 END;
  38         exit();
  39 }
  40
  41 /** A general output object. Need to be overriden */
  42 class statsOutput {
  43         function formatPercent( $subset, $total, $revert = false, $accuracy = 2 ) {
  44                 return @sprintf( '%.' . $accuracy . 'f%%', 100 * $subset / $total );
  45         }
  46
  47         # Override the following methods
  48         function heading() {
  49         }
  50         function footer() {
  51         }
  52         function blockstart() {
  53         }
  54         function blockend() {
  55         }
  56         function element( $in, $heading = false ) {
  57         }
  58 }
  59
  60 /** Outputs WikiText */
  61 class wikiStatsOutput extends statsOutput {
  62         function heading() {
  63                 echo "'''Note:''' These statistics can be generated by running <code>php maintenance/transstat.php</code>.\n\n";
  64                 echo "{| border=2 cellpadding=4 cellspacing=0 style=\"background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;\" width=100%\n";
  65         }
  66         function footer() {
  67                 echo "|}\n";
  68         }
  69         function blockstart() {
  70                 echo "|-\n";
  71         }
  72         function blockend() {
  73                 echo '';
  74         }
  75         function element( $in, $heading = false ) {
  76                 echo ($heading ? '!' : '|') . " $in\n";
  77         }
  78         function formatPercent( $subset, $total, $revert = false, $accuracy = 2 ) {
  79                 $v = @round(255 * $subset / $total);
  80                 if ( $revert ) {
  81                         $v = 255 - $v;
  82                 }
  83                 if ( $v < 128 ) {
  84                         # Red to Yellow
  85                         $red = 'FF';
  86                         $green = sprintf( '%02X', 2 * $v );
  87                 } else {
  88                         # Yellow to Green
  89                         $red = sprintf('%02X', 2 * ( 255 - $v ) );
  90                         $green = 'FF';
  91                 }
  92                 $blue = '00';
  93                 $color = $red . $green . $blue;
  94
  95                 $percent = statsOutput::formatPercent( $subset, $total, $revert, $accuracy );
  96                 return 'bgcolor="#'. $color .'" | '. $percent;
  97         }
  98 }
  99
 100 /** Output text. To be used on a terminal for example. */
 101 class textStatsOutput extends statsOutput {
 102         function element( $in, $heading = false ) {
 103                 echo $in."\t";
 104         }
 105         function blockend() {
 106                 echo "\n";
 107         }
 108 }
 109
 110 /** csv output. Some people love excel */
 111 class csvStatsOutput extends statsOutput {
 112         function element( $in, $heading = false ) {
 113                 echo $in . ";";
 114         }
 115         function blockend() {
 116                 echo "\n";
 117         }
 118 }
 119
 120 # Select an output engine
 121 switch ( $options['output'] ) {
 122         case 'wiki':
 123                 $wgOut = new wikiStatsOutput();
 124                 break;
 125         case 'text':
 126                 $wgOut = new textStatsOutput();
 127                 break;
 128         case 'csv':
 129                 $wgOut = new csvStatsOutput();
 130                 break;
 131         default:
 132                 showUsage();
 133 }
 134
 135 # Languages
 136 $wgLanguages = new languages();
 137
 138 # Header
 139 $wgOut->heading();
 140 $wgOut->blockstart();
 141 $wgOut->element( 'Language', true );
 142 $wgOut->element( 'Translated', true );
 143 $wgOut->element( '%', true );
 144 $wgOut->element( 'Same to English', true );
 145 $wgOut->element( '%', true );
 146 $wgOut->element( 'Obsolete', true );
 147 $wgOut->element( '%', true );
 148 $wgOut->blockend();
 149
 150 foreach ( $wgLanguages->getList() as $code ) {
 151         # Don't check English or RTL English
 152         if ( $code == 'en' || $code == 'enRTL' ) {
 153                 continue;
 154         }
 155
 156         # Calculate the numbers
 157         $name = $wgLang->getLanguageName( $code );
 158         $translatableMessagesNumber = count( $wgLanguages->getTranslatableMessages() );
 159         $localMessagesNumber = count( $wgLanguages->getMessagesFor( $code ) );
 160         $translatedMessagesNumber = count( $wgLanguages->getTranslatedMessages( $code ) );
 161         $translatedMessagesPercent = $wgOut->formatPercent( $translatedMessagesNumber, $translatableMessagesNumber );
 162         $duplicateMessagesNumber = count( $wgLanguages->getDuplicateMessages( $code ) );
 163         $duplicateMessagesPercent = $wgOut->formatPercent( $duplicateMessagesNumber, $translatedMessagesNumber, true );
 164         $obsoleteMessagesNumber = count( $wgLanguages->getObsoleteMessages( $code ) );
 165         $obsoleteMessagesPercent = $wgOut->formatPercent( $obsoleteMessagesNumber, $translatedMessagesNumber, true );
 166
 167         # Output them
 168         $wgOut->blockstart();
 169         $wgOut->element( "$name ($code)" );
 170         $wgOut->element( "$translatedMessagesNumber/$translatableMessagesNumber" );
 171         $wgOut->element( $translatedMessagesPercent );
 172         $wgOut->element( "$duplicateMessagesNumber/$translatedMessagesNumber" );
 173         $wgOut->element( $duplicateMessagesPercent );
 174         $wgOut->element( "$obsoleteMessagesNumber/$translatedMessagesNumber" );
 175         $wgOut->element( $obsoleteMessagesPercent );
 176         $wgOut->blockend();
 177 }
 178
 179 # Footer
 180 $wgOut->footer();
 181
 182 ?>