includes/parser/DateFormatter.php

   1 <?php
   2
   3 /**
   4  * Date formatter, recognises dates in plain text and formats them accoding to user preferences.
   5  * @todo preferences, OutputPage
   6  * @ingroup Parser
   7  */
   8 class DateFormatter
   9 {
  10         var $mSource, $mTarget;
  11         var $monthNames = '', $rxDM, $rxMD, $rxDMY, $rxYDM, $rxMDY, $rxYMD;
  12
  13         var $regexes, $pDays, $pMonths, $pYears;
  14         var $rules, $xMonths, $preferences;
  15
  16         const ALL = -1;
  17         const NONE = 0;
  18         const MDY = 1;
  19         const DMY = 2;
  20         const YMD = 3;
  21         const ISO1 = 4;
  22         const LASTPREF = 4;
  23         const ISO2 = 5;
  24         const YDM = 6;
  25         const DM = 7;
  26         const MD = 8;
  27         const LAST = 8;
  28
  29         /**
  30          * @todo document
  31          */
  32         function DateFormatter() {
  33                 global $wgContLang;
  34
  35                 $this->monthNames = $this->getMonthRegex();
  36                 for ( $i=1; $i<=12; $i++ ) {
  37                         $this->xMonths[$wgContLang->lc( $wgContLang->getMonthName( $i ) )] = $i;
  38                         $this->xMonths[$wgContLang->lc( $wgContLang->getMonthAbbreviation( $i ) )] = $i;
  39                 }
  40
  41                 $this->regexTrail = '(?![a-z])/iu';
  42
  43                 # Partial regular expressions
  44                 $this->prxDM = '\[\[(\d{1,2})[ _](' . $this->monthNames . ')]]';
  45                 $this->prxMD = '\[\[(' . $this->monthNames . ')[ _](\d{1,2})]]';
  46                 $this->prxY = '\[\[(\d{1,4}([ _]BC|))]]';
  47                 $this->prxISO1 = '\[\[(-?\d{4})]]-\[\[(\d{2})-(\d{2})]]';
  48                 $this->prxISO2 = '\[\[(-?\d{4})-(\d{2})-(\d{2})]]';
  49
  50                 # Real regular expressions
  51                 $this->regexes[self::DMY] = "/{$this->prxDM} *,? *{$this->prxY}{$this->regexTrail}";
  52                 $this->regexes[self::YDM] = "/{$this->prxY} *,? *{$this->prxDM}{$this->regexTrail}";
  53                 $this->regexes[self::MDY] = "/{$this->prxMD} *,? *{$this->prxY}{$this->regexTrail}";
  54                 $this->regexes[self::YMD] = "/{$this->prxY} *,? *{$this->prxMD}{$this->regexTrail}";
  55                 $this->regexes[self::DM] = "/{$this->prxDM}{$this->regexTrail}";
  56                 $this->regexes[self::MD] = "/{$this->prxMD}{$this->regexTrail}";
  57                 $this->regexes[self::ISO1] = "/{$this->prxISO1}{$this->regexTrail}";
  58                 $this->regexes[self::ISO2] = "/{$this->prxISO2}{$this->regexTrail}";
  59
  60                 # Extraction keys
  61                 # See the comments in replace() for the meaning of the letters
  62                 $this->keys[self::DMY] = 'jFY';
  63                 $this->keys[self::YDM] = 'Y jF';
  64                 $this->keys[self::MDY] = 'FjY';
  65                 $this->keys[self::YMD] = 'Y Fj';
  66                 $this->keys[self::DM] = 'jF';
  67                 $this->keys[self::MD] = 'Fj';
  68                 $this->keys[self::ISO1] = 'ymd'; # y means ISO year
  69                 $this->keys[self::ISO2] = 'ymd';
  70
  71                 # Target date formats
  72                 $this->targets[self::DMY] = '[[F j|j F]] [[Y]]';
  73                 $this->targets[self::YDM] = '[[Y]], [[F j|j F]]';
  74                 $this->targets[self::MDY] = '[[F j]], [[Y]]';
  75                 $this->targets[self::YMD] = '[[Y]] [[F j]]';
  76                 $this->targets[self::DM] = '[[F j|j F]]';
  77                 $this->targets[self::MD] = '[[F j]]';
  78                 $this->targets[self::ISO1] = '[[Y|y]]-[[F j|m-d]]';
  79                 $this->targets[self::ISO2] = '[[y-m-d]]';
  80
  81                 # Rules
  82                 #            pref    source       target
  83                 $this->rules[self::DMY][self::MD]       = self::DM;
  84                 $this->rules[self::ALL][self::MD]       = self::MD;
  85                 $this->rules[self::MDY][self::DM]       = self::MD;
  86                 $this->rules[self::ALL][self::DM]       = self::DM;
  87                 $this->rules[self::NONE][self::ISO2]    = self::ISO1;
  88
  89                 $this->preferences = array(
  90                         'default' => self::NONE,
  91                         'dmy' => self::DMY,
  92                         'mdy' => self::MDY,
  93                         'ymd' => self::YMD,
  94                         'ISO 8601' => self::ISO1,
  95                 );
  96         }
  97
  98         /**
  99          * Get a DateFormatter object
 100          *
 101          * @return DateFormatter object
 102          */
 103         public static function &getInstance() {
 104                 global $wgMemc;
 105                 static $dateFormatter = false;
 106                 if ( !$dateFormatter ) {
 107                         $dateFormatter = $wgMemc->get( wfMemcKey( 'dateformatter' ) );
 108                         if ( !$dateFormatter ) {
 109                                 $dateFormatter = new DateFormatter;
 110                                 $wgMemc->set( wfMemcKey( 'dateformatter' ), $dateFormatter, 3600 );
 111                         }
 112                 }
 113                 return $dateFormatter;
 114         }
 115
 116         /**
 117          * @param $preference String: User preference
 118          * @param $text String: Text to reformat
 119          */
 120         function reformat( $preference, $text ) {
 121                 if ( isset( $this->preferences[$preference] ) ) {
 122                         $preference = $this->preferences[$preference];
 123                 } else {
 124                         $preference = self::NONE;
 125                 }
 126                 for ( $i=1; $i<=self::LAST; $i++ ) {
 127                         $this->mSource = $i;
 128                         if ( isset ( $this->rules[$preference][$i] ) ) {
 129                                 # Specific rules
 130                                 $this->mTarget = $this->rules[$preference][$i];
 131                         } elseif ( isset ( $this->rules[self::ALL][$i] ) ) {
 132                                 # General rules
 133                                 $this->mTarget = $this->rules[self::ALL][$i];
 134                         } elseif ( $preference ) {
 135                                 # User preference
 136                                 $this->mTarget = $preference;
 137                         } else {
 138                                 # Default
 139                                 $this->mTarget = $i;
 140                         }
 141                         $text = preg_replace_callback( $this->regexes[$i], array( &$this, 'replace' ), $text );
 142                 }
 143                 return $text;
 144         }
 145
 146         /**
 147          * @param $matches
 148          */
 149         function replace( $matches ) {
 150                 # Extract information from $matches
 151                 $bits = array();
 152                 $key = $this->keys[$this->mSource];
 153                 for ( $p=0; $p < strlen($key); $p++ ) {
 154                         if ( $key{$p} != ' ' ) {
 155                                 $bits[$key{$p}] = $matches[$p+1];
 156                         }
 157                 }
 158
 159                 return $this->formatDate( $bits );
 160         }
 161
 162         function formatDate( $bits ) {
 163                 $format = $this->targets[$this->mTarget];
 164
 165                 # Construct new date
 166                 $text = '';
 167                 $fail = false;
 168
 169                 // Pre-generate y/Y stuff because we need the year for the <span> title.
 170                 if ( !isset( $bits['y'] ) )
 171                         $bits['y'] = $this->makeIsoYear( $bits['Y'] );
 172                 if ( !isset( $bits['Y'] ) )
 173                         $bits['Y'] = $this->makeNormalYear( $bits['y'] );
 174
 175                 for ( $p=0; $p < strlen( $format ); $p++ ) {
 176                         $char = $format{$p};
 177                         switch ( $char ) {
 178                                 case 'd': # ISO day of month
 179                                         if ( !isset($bits['d']) ) {
 180                                                 $text .= sprintf( '%02d', $bits['j'] );
 181                                         } else {
 182                                                 $text .= $bits['d'];
 183                                         }
 184                                         break;
 185                                 case 'm': # ISO month
 186                                         if ( !isset($bits['m']) ) {
 187                                                 $m = $this->makeIsoMonth( $bits['F'] );
 188                                                 if ( !$m || $m == '00' ) {
 189                                                         $fail = true;
 190                                                 } else {
 191                                                         $text .= $m;
 192                                                 }
 193                                         } else {
 194                                                 $text .= $bits['m'];
 195                                         }
 196                                         break;
 197                                 case 'y': # ISO year
 198                                         $text .= $bits['y'];
 199                                         break;
 200                                 case 'j': # ordinary day of month
 201                                         if ( !isset($bits['j']) ) {
 202                                                 $text .= intval( $bits['d'] );
 203                                         } else {
 204                                                 $text .= $bits['j'];
 205                                         }
 206                                         break;
 207                                 case 'F': # long month
 208                                         if ( !isset( $bits['F'] ) ) {
 209                                                 $m = intval($bits['m']);
 210                                                 if ( $m > 12 || $m < 1 ) {
 211                                                         $fail = true;
 212                                                 } else {
 213                                                         global $wgContLang;
 214                                                         $text .= $wgContLang->getMonthName( $m );
 215                                                 }
 216                                         } else {
 217                                                 $text .= ucfirst( $bits['F'] );
 218                                         }
 219                                         break;
 220                                 case 'Y': # ordinary (optional BC) year
 221                                         $text .= $bits['Y'];
 222                                         break;
 223                                 default:
 224                                         $text .= $char;
 225                         }
 226                 }
 227                 if ( $fail ) {
 228                         $text = $matches[0];
 229                 }
 230
 231                 $isoDate = $bits['y'].$bits['m'].$bits['d'];
 232
 233                 // Output is not strictly HTML (it's wikitext), but <span> is whitelisted.
 234                 $text = Xml::tags( 'span',
 235                                         array( 'class' => 'mw-formatted-date', 'title' => $isoDate ), $text );
 236
 237                 return $text;
 238         }
 239
 240         /**
 241          * @todo document
 242          */
 243         function getMonthRegex() {
 244                 global $wgContLang;
 245                 $names = array();
 246                 for( $i = 1; $i <= 12; $i++ ) {
 247                         $names[] = $wgContLang->getMonthName( $i );
 248                         $names[] = $wgContLang->getMonthAbbreviation( $i );
 249                 }
 250                 return implode( '|', $names );
 251         }
 252
 253         /**
 254          * Makes an ISO month, e.g. 02, from a month name
 255          * @param $monthName String: month name
 256          * @return string ISO month name
 257          */
 258         function makeIsoMonth( $monthName ) {
 259                 global $wgContLang;
 260
 261                 $n = $this->xMonths[$wgContLang->lc( $monthName )];
 262                 return sprintf( '%02d', $n );
 263         }
 264
 265         /**
 266          * @todo document
 267          * @param $year String: Year name
 268          * @return string ISO year name
 269          */
 270         function makeIsoYear( $year ) {
 271                 # Assumes the year is in a nice format, as enforced by the regex
 272                 if ( substr( $year, -2 ) == 'BC' ) {
 273                         $num = intval(substr( $year, 0, -3 )) - 1;
 274                         # PHP bug note: sprintf( "%04d", -1 ) fails poorly
 275                         $text = sprintf( '-%04d', $num );
 276
 277                 } else {
 278                         $text = sprintf( '%04d', $year );
 279                 }
 280                 return $text;
 281         }
 282
 283         /**
 284          * @todo document
 285          */
 286         function makeNormalYear( $iso ) {
 287                 if ( $iso{0} == '-' ) {
 288                         $text = (intval( substr( $iso, 1 ) ) + 1) . ' BC';
 289                 } else {
 290                         $text = intval( $iso );
 291                 }
 292                 return $text;
 293         }
 294 }