resources/src/mediawiki.widgets.datetime/DateTimeFormatter.js

   1 ( function () {
   2
   3         /**
   4          * Provides various methods needed for formatting dates and times.
   5          *
   6          * @class
   7          * @abstract
   8          * @mixins OO.EventEmitter
   9          *
  10          * @constructor
  11          * @param {Object} [config] Configuration options
  12          * @cfg {string} [format='@default'] May be a key from the {@link #static-formats static formats},
  13          *  or a format specification as defined by {@link #method-parseFieldSpec parseFieldSpec}
  14          *  and {@link #method-getFieldForTag getFieldForTag}.
  15          * @cfg {boolean} [local=false] Whether dates are local time or UTC
  16          * @cfg {string[]} [fullZones] Time zone indicators. Array of 2 strings, for
  17          *  UTC and local time.
  18          * @cfg {string[]} [shortZones] Abbreviated time zone indicators. Array of 2
  19          *  strings, for UTC and local time.
  20          * @cfg {Date} [defaultDate] Default date, for filling unspecified components.
  21          *  Defaults to the current date and time (with 0 milliseconds).
  22          */
  23         mw.widgets.datetime.DateTimeFormatter = function MwWidgetsDatetimeDateTimeFormatter( config ) {
  24                 this.constructor.static.setupDefaults();
  25
  26                 config = $.extend( {
  27                         format: '@default',
  28                         local: false,
  29                         fullZones: this.constructor.static.fullZones,
  30                         shortZones: this.constructor.static.shortZones
  31                 }, config );
  32
  33                 // Mixin constructors
  34                 OO.EventEmitter.call( this );
  35
  36                 // Properties
  37                 if ( this.constructor.static.formats[ config.format ] ) {
  38                         this.format = this.constructor.static.formats[ config.format ];
  39                 } else {
  40                         this.format = config.format;
  41                 }
  42                 this.local = !!config.local;
  43                 this.fullZones = config.fullZones;
  44                 this.shortZones = config.shortZones;
  45                 if ( config.defaultDate instanceof Date ) {
  46                         this.defaultDate = config.defaultDate;
  47                 } else {
  48                         this.defaultDate = new Date();
  49                         if ( this.local ) {
  50                                 this.defaultDate.setMilliseconds( 0 );
  51                         } else {
  52                                 this.defaultDate.setUTCMilliseconds( 0 );
  53                         }
  54                 }
  55         };
  56
  57         /* Setup */
  58
  59         OO.initClass( mw.widgets.datetime.DateTimeFormatter );
  60         OO.mixinClass( mw.widgets.datetime.DateTimeFormatter, OO.EventEmitter );
  61
  62         /* Static */
  63
  64         /**
  65          * Default format specifications. See the {@link #format format} parameter.
  66          *
  67          * @static
  68          * @inheritable
  69          * @property {Object}
  70          */
  71         mw.widgets.datetime.DateTimeFormatter.static.formats = {};
  72
  73         /**
  74          * Default time zone indicators
  75          *
  76          * @static
  77          * @inheritable
  78          * @property {string[]}
  79          */
  80         mw.widgets.datetime.DateTimeFormatter.static.fullZones = null;
  81
  82         /**
  83          * Default abbreviated time zone indicators
  84          *
  85          * @static
  86          * @inheritable
  87          * @property {string[]}
  88          */
  89         mw.widgets.datetime.DateTimeFormatter.static.shortZones = null;
  90
  91         mw.widgets.datetime.DateTimeFormatter.static.setupDefaults = function () {
  92                 if ( !this.fullZones ) {
  93                         this.fullZones = [
  94                                 mw.msg( 'timezone-utc' ),
  95                                 mw.msg( 'timezone-local' )
  96                         ];
  97                 }
  98                 if ( !this.shortZones ) {
  99                         this.shortZones = [
 100                                 'Z',
 101                                 this.fullZones[ 1 ].substr( 0, 1 ).toUpperCase()
 102                         ];
 103                         if ( this.shortZones[ 1 ] === 'Z' ) {
 104                                 this.shortZones[ 1 ] = 'L';
 105                         }
 106                 }
 107         };
 108
 109         /* Events */
 110
 111         /**
 112          * A `local` event is emitted when the 'local' flag is changed.
 113          *
 114          * @event local
 115          */
 116
 117         /* Methods */
 118
 119         /**
 120          * Whether dates are in local time or UTC
 121          *
 122          * @return {boolean} True if local time
 123          */
 124         mw.widgets.datetime.DateTimeFormatter.prototype.getLocal = function () {
 125                 return this.local;
 126         };
 127
 128         // eslint-disable-next-line valid-jsdoc
 129         /**
 130          * Toggle whether dates are in local time or UTC
 131          *
 132          * @param {boolean} [flag] Set the flag instead of toggling it
 133          * @fires local
 134          * @chainable
 135          */
 136         mw.widgets.datetime.DateTimeFormatter.prototype.toggleLocal = function ( flag ) {
 137                 if ( flag === undefined ) {
 138                         flag = !this.local;
 139                 } else {
 140                         flag = !!flag;
 141                 }
 142                 if ( this.local !== flag ) {
 143                         this.local = flag;
 144                         this.emit( 'local', this.local );
 145                 }
 146                 return this;
 147         };
 148
 149         /**
 150          * Get the default date
 151          *
 152          * @return {Date}
 153          */
 154         mw.widgets.datetime.DateTimeFormatter.prototype.getDefaultDate = function () {
 155                 return new Date( this.defaultDate.getTime() );
 156         };
 157
 158         /**
 159          * Fetch the field specification array for this object.
 160          *
 161          * See {@link #parseFieldSpec parseFieldSpec} for details on the return value structure.
 162          *
 163          * @return {Array}
 164          */
 165         mw.widgets.datetime.DateTimeFormatter.prototype.getFieldSpec = function () {
 166                 return this.parseFieldSpec( this.format );
 167         };
 168
 169         /**
 170          * Parse a format string into a field specification
 171          *
 172          * The input is a string containing tags formatted as ${tag|param|param...}
 173          * (for editable fields) and $!{tag|param|param...} (for non-editable fields).
 174          * Most tags are defined by {@link #getFieldForTag getFieldForTag}, but a few
 175          * are defined here:
 176          * - ${intercalary|X|text}: Text that is only displayed when the 'intercalary'
 177          *   component is X.
 178          * - ${not-intercalary|X|text}: Text that is displayed unless the 'intercalary'
 179          *   component is X.
 180          *
 181          * Elements of the returned array are strings or objects. Strings are meant to
 182          * be displayed as-is. Objects are as returned by {@link #getFieldForTag getFieldForTag}.
 183          *
 184          * @protected
 185          * @param {string} format
 186          * @return {Array}
 187          */
 188         mw.widgets.datetime.DateTimeFormatter.prototype.parseFieldSpec = function ( format ) {
 189                 var m, last, tag, params, spec,
 190                         ret = [],
 191                         re = /(.*?)(\$(!?)\{([^}]+)\})/g;
 192
 193                 last = 0;
 194                 while ( ( m = re.exec( format ) ) !== null ) {
 195                         last = re.lastIndex;
 196
 197                         if ( m[ 1 ] !== '' ) {
 198                                 ret.push( m[ 1 ] );
 199                         }
 200
 201                         params = m[ 4 ].split( '|' );
 202                         tag = params.shift();
 203                         spec = this.getFieldForTag( tag, params );
 204                         if ( spec ) {
 205                                 if ( m[ 3 ] === '!' ) {
 206                                         spec.editable = false;
 207                                 }
 208                                 ret.push( spec );
 209                         } else {
 210                                 ret.push( m[ 2 ] );
 211                         }
 212                 }
 213                 if ( last < format.length ) {
 214                         ret.push( format.substr( last ) );
 215                 }
 216
 217                 return ret;
 218         };
 219
 220         /**
 221          * Turn a tag into a field specification object
 222          *
 223          * Fields implemented here are:
 224          * - ${intercalary|X|text}: Text that is only displayed when the 'intercalary'
 225          *   component is X.
 226          * - ${not-intercalary|X|text}: Text that is displayed unless the 'intercalary'
 227          *   component is X.
 228          * - ${zone|#}: Timezone offset, "+0000" format.
 229          * - ${zone|:}: Timezone offset, "+00:00" format.
 230          * - ${zone|short}: Timezone from 'shortZones' configuration setting.
 231          * - ${zone|full}: Timezone from 'fullZones' configuration setting.
 232          *
 233          * @protected
 234          * @abstract
 235          * @param {string} tag
 236          * @param {string[]} params
 237          * @return {Object|null} Field specification object, or null if the tag+params are unrecognized.
 238          * @return {string|null} return.component Date component corresponding to this field, if any.
 239          * @return {boolean} return.editable Whether this field is editable.
 240          * @return {string} return.type What kind of field this is:
 241          *  - 'static': The field is a static string; component will be null.
 242          *  - 'number': The field is generally numeric.
 243          *  - 'string': The field is generally textual.
 244          *  - 'boolean': The field is a boolean.
 245          *  - 'toggleLocal': The field represents {@link #getLocal this.getLocal()}.
 246          *    Editing should directly call {@link #toggleLocal this.toggleLocal()}.
 247          * @return {boolean} return.calendarComponent Whether this field is part of a calendar, e.g.
 248          *  part of the date instead of the time.
 249          * @return {number} return.size Maximum number of characters in the field (when
 250          *  the 'intercalary' component is falsey). If 0, the field should be hidden entirely.
 251          * @return {Object.<string,number>} return.intercalarySize Map from
 252          *  'intercalary' component values to overridden sizes.
 253          * @return {string} return.value For type='static', the string to display.
 254          * @return {function(Mixed): string} return.formatValue A function to format a
 255          *  component value as a display string.
 256          * @return {function(string): Mixed} return.parseValue A function to parse a
 257          *  display string into a component value. If parsing fails, returns undefined.
 258          */
 259         mw.widgets.datetime.DateTimeFormatter.prototype.getFieldForTag = function ( tag, params ) {
 260                 var c, spec = null;
 261
 262                 switch ( tag ) {
 263                         case 'intercalary':
 264                         case 'not-intercalary':
 265                                 if ( params.length < 2 || !params[ 0 ] ) {
 266                                         return null;
 267                                 }
 268                                 spec = {
 269                                         component: null,
 270                                         calendarComponent: false,
 271                                         editable: false,
 272                                         type: 'static',
 273                                         value: params.slice( 1 ).join( '|' ),
 274                                         size: 0,
 275                                         intercalarySize: {}
 276                                 };
 277                                 if ( tag === 'intercalary' ) {
 278                                         spec.intercalarySize[ params[ 0 ] ] = spec.value.length;
 279                                 } else {
 280                                         spec.size = spec.value.length;
 281                                         spec.intercalarySize[ params[ 0 ] ] = 0;
 282                                 }
 283                                 return spec;
 284
 285                         case 'zone':
 286                                 switch ( params[ 0 ] ) {
 287                                         case '#':
 288                                         case ':':
 289                                                 c = params[ 0 ] === '#' ? '' : ':';
 290                                                 return {
 291                                                         component: 'zone',
 292                                                         calendarComponent: false,
 293                                                         editable: true,
 294                                                         type: 'toggleLocal',
 295                                                         size: 5 + c.length,
 296                                                         formatValue: function ( v ) {
 297                                                                 var o, r;
 298                                                                 if ( v ) {
 299                                                                         o = new Date().getTimezoneOffset();
 300                                                                         r = String( Math.abs( o ) % 60 );
 301                                                                         while ( r.length < 2 ) {
 302                                                                                 r = '0' + r;
 303                                                                         }
 304                                                                         r = String( Math.floor( Math.abs( o ) / 60 ) ) + c + r;
 305                                                                         while ( r.length < 4 + c.length ) {
 306                                                                                 r = '0' + r;
 307                                                                         }
 308                                                                         return ( o <= 0 ? '+' : '−' ) + r;
 309                                                                 } else {
 310                                                                         return '+00' + c + '00';
 311                                                                 }
 312                                                         },
 313                                                         parseValue: function ( v ) {
 314                                                                 var m;
 315                                                                 v = String( v ).trim();
 316                                                                 if ( ( m = /^([+-−])([0-9]{1,2}):?([0-9]{2})$/.test( v ) ) ) {
 317                                                                         return ( m[ 2 ] * 60 + m[ 3 ] ) * ( m[ 1 ] === '+' ? -1 : 1 );
 318                                                                 } else {
 319                                                                         return undefined;
 320                                                                 }
 321                                                         }
 322                                                 };
 323
 324                                         case 'short':
 325                                         case 'full':
 326                                                 spec = {
 327                                                         component: 'zone',
 328                                                         calendarComponent: false,
 329                                                         editable: true,
 330                                                         type: 'toggleLocal',
 331                                                         values: params[ 0 ] === 'short' ? this.shortZones : this.fullZones,
 332                                                         formatValue: this.formatSpecValue,
 333                                                         parseValue: this.parseSpecValue
 334                                                 };
 335                                                 spec.size = Math.max.apply(
 336                                                         // eslint-disable-next-line no-jquery/no-map-util
 337                                                         null, $.map( spec.values, function ( v ) { return v.length; } )
 338                                                 );
 339                                                 return spec;
 340                                 }
 341                                 return null;
 342
 343                         default:
 344                                 return null;
 345                 }
 346         };
 347
 348         /**
 349          * Format a value for a field specification
 350          *
 351          * 'this' must be the field specification object. The intention is that you
 352          * could just assign this function as the 'formatValue' for each field spec.
 353          *
 354          * Besides the publicly-documented fields, uses the following:
 355          * - values: Enumerated values for the field
 356          * - zeropad: Whether to pad the number with zeros.
 357          *
 358          * @protected
 359          * @param {Mixed} v
 360          * @return {string}
 361          */
 362         mw.widgets.datetime.DateTimeFormatter.prototype.formatSpecValue = function ( v ) {
 363                 if ( v === undefined || v === null ) {
 364                         return '';
 365                 }
 366
 367                 if ( typeof v === 'boolean' || this.type === 'toggleLocal' ) {
 368                         v = v ? 1 : 0;
 369                 }
 370
 371                 if ( this.values ) {
 372                         return this.values[ v ];
 373                 }
 374
 375                 v = String( v );
 376                 if ( this.zeropad ) {
 377                         while ( v.length < this.size ) {
 378                                 v = '0' + v;
 379                         }
 380                 }
 381                 return v;
 382         };
 383
 384         /**
 385          * Parse a value for a field specification
 386          *
 387          * 'this' must be the field specification object. The intention is that you
 388          * could just assign this function as the 'parseValue' for each field spec.
 389          *
 390          * Besides the publicly-documented fields, uses the following:
 391          * - values: Enumerated values for the field
 392          *
 393          * @protected
 394          * @param {string} v
 395          * @return {number|string|null}
 396          */
 397         mw.widgets.datetime.DateTimeFormatter.prototype.parseSpecValue = function ( v ) {
 398                 var k, re;
 399
 400                 if ( v === '' ) {
 401                         return null;
 402                 }
 403
 404                 if ( !this.values ) {
 405                         v = +v;
 406                         if ( this.type === 'boolean' || this.type === 'toggleLocal' ) {
 407                                 return isNaN( v ) ? undefined : !!v;
 408                         } else {
 409                                 return isNaN( v ) ? undefined : v;
 410                         }
 411                 }
 412
 413                 // eslint-disable-next-line no-restricted-properties
 414                 if ( v.normalize ) {
 415                         // eslint-disable-next-line no-restricted-properties
 416                         v = v.normalize();
 417                 }
 418                 re = new RegExp( '^\\s*' + mw.RegExp.escape( v ), 'i' );
 419                 for ( k in this.values ) {
 420                         k = +k;
 421                         if ( !isNaN( k ) && re.test( this.values[ k ] ) ) {
 422                                 if ( this.type === 'boolean' || this.type === 'toggleLocal' ) {
 423                                         return !!k;
 424                                 } else {
 425                                         return k;
 426                                 }
 427                         }
 428                 }
 429                 return undefined;
 430         };
 431
 432         /**
 433          * Get components from a Date object
 434          *
 435          * Most specific components are defined by the subclass. "Global" components
 436          * are:
 437          * - intercalary: {string} Non-falsey values are used to indicate intercalary days.
 438          * - zone: {number} Timezone offset in minutes.
 439          *
 440          * @abstract
 441          * @param {Date|null} date
 442          * @return {Object} Components
 443          */
 444         mw.widgets.datetime.DateTimeFormatter.prototype.getComponentsFromDate = function ( date ) {
 445                 // Should be overridden by subclass
 446                 return {
 447                         zone: this.local ? date.getTimezoneOffset() : 0
 448                 };
 449         };
 450
 451         /**
 452          * Get a Date object from components
 453          *
 454          * @param {Object} components Date components
 455          * @return {Date}
 456          */
 457         mw.widgets.datetime.DateTimeFormatter.prototype.getDateFromComponents = function ( /* components */ ) {
 458                 // Should be overridden by subclass
 459                 return new Date();
 460         };
 461
 462         /**
 463          * Adjust a date
 464          *
 465          * @param {Date|null} date To be adjusted
 466          * @param {string} component To adjust
 467          * @param {number} delta Adjustment amount
 468          * @param {string} mode Adjustment mode:
 469          *  - 'overflow': "Jan 32" => "Feb 1", "Jan 33" => "Feb 2", "Feb 0" => "Jan 31", etc.
 470          *  - 'wrap': "Jan 32" => "Jan 1", "Jan 33" => "Jan 2", "Jan 0" => "Jan 31", etc.
 471          *  - 'clip': "Jan 32" => "Jan 31", "Feb 32" => "Feb 28" (or 29), "Feb 0" => "Feb 1", etc.
 472          * @return {Date} Adjusted date
 473          */
 474         mw.widgets.datetime.DateTimeFormatter.prototype.adjustComponent = function ( date /* , component, delta, mode */ ) {
 475                 // Should be overridden by subclass
 476                 return date;
 477         };
 478
 479         /**
 480          * Get the column headings (weekday abbreviations) for a calendar grid
 481          *
 482          * Null-valued columns are hidden if getCalendarData() returns no "day" object
 483          * for all days in that column.
 484          *
 485          * @abstract
 486          * @return {Array} string or null
 487          */
 488         mw.widgets.datetime.DateTimeFormatter.prototype.getCalendarHeadings = function () {
 489                 // Should be overridden by subclass
 490                 return [];
 491         };
 492
 493         /**
 494          * Test whether two dates are in the same calendar grid
 495          *
 496          * @abstract
 497          * @param {Date} date1
 498          * @param {Date} date2
 499          * @return {boolean}
 500          */
 501         mw.widgets.datetime.DateTimeFormatter.prototype.sameCalendarGrid = function ( date1, date2 ) {
 502                 // Should be overridden by subclass
 503                 return date1.getTime() === date2.getTime();
 504         };
 505
 506         /**
 507          * Test whether the date parts of two Dates are equal
 508          *
 509          * @param {Date} date1
 510          * @param {Date} date2
 511          * @return {boolean}
 512          */
 513         mw.widgets.datetime.DateTimeFormatter.prototype.datePartIsEqual = function ( date1, date2 ) {
 514                 if ( this.local ) {
 515                         return (
 516                                 date1.getFullYear() === date2.getFullYear() &&
 517                                 date1.getMonth() === date2.getMonth() &&
 518                                 date1.getDate() === date2.getDate()
 519                         );
 520                 } else {
 521                         return (
 522                                 date1.getUTCFullYear() === date2.getUTCFullYear() &&
 523                                 date1.getUTCMonth() === date2.getUTCMonth() &&
 524                                 date1.getUTCDate() === date2.getUTCDate()
 525                         );
 526                 }
 527         };
 528
 529         /**
 530          * Test whether the time parts of two Dates are equal
 531          *
 532          * @param {Date} date1
 533          * @param {Date} date2
 534          * @return {boolean}
 535          */
 536         mw.widgets.datetime.DateTimeFormatter.prototype.timePartIsEqual = function ( date1, date2 ) {
 537                 if ( this.local ) {
 538                         return (
 539                                 date1.getHours() === date2.getHours() &&
 540                                 date1.getMinutes() === date2.getMinutes() &&
 541                                 date1.getSeconds() === date2.getSeconds() &&
 542                                 date1.getMilliseconds() === date2.getMilliseconds()
 543                         );
 544                 } else {
 545                         return (
 546                                 date1.getUTCHours() === date2.getUTCHours() &&
 547                                 date1.getUTCMinutes() === date2.getUTCMinutes() &&
 548                                 date1.getUTCSeconds() === date2.getUTCSeconds() &&
 549                                 date1.getUTCMilliseconds() === date2.getUTCMilliseconds()
 550                         );
 551                 }
 552         };
 553
 554         /**
 555          * Test whether toggleLocal() changes the date part
 556          *
 557          * @param {Date} date
 558          * @return {boolean}
 559          */
 560         mw.widgets.datetime.DateTimeFormatter.prototype.localChangesDatePart = function ( date ) {
 561                 return (
 562                         date.getUTCFullYear() !== date.getFullYear() ||
 563                         date.getUTCMonth() !== date.getMonth() ||
 564                         date.getUTCDate() !== date.getDate()
 565                 );
 566         };
 567
 568         /**
 569          * Create a new Date by merging the date part from one with the time part from
 570          * another.
 571          *
 572          * @param {Date} datepart
 573          * @param {Date} timepart
 574          * @return {Date}
 575          */
 576         mw.widgets.datetime.DateTimeFormatter.prototype.mergeDateAndTime = function ( datepart, timepart ) {
 577                 var ret = new Date( datepart.getTime() );
 578
 579                 if ( this.local ) {
 580                         ret.setHours(
 581                                 timepart.getHours(),
 582                                 timepart.getMinutes(),
 583                                 timepart.getSeconds(),
 584                                 timepart.getMilliseconds()
 585                         );
 586                 } else {
 587                         ret.setUTCHours(
 588                                 timepart.getUTCHours(),
 589                                 timepart.getUTCMinutes(),
 590                                 timepart.getUTCSeconds(),
 591                                 timepart.getUTCMilliseconds()
 592                         );
 593                 }
 594
 595                 return ret;
 596         };
 597
 598         /**
 599          * Get data for a calendar grid
 600          *
 601          * A "day" object is:
 602          * - display: {string} Display text for the day.
 603          * - date: {Date} Date to use when the day is selected.
 604          * - extra: {string|null} 'prev' or 'next' on days used to fill out the weeks
 605          *   at the start and end of the month.
 606          *
 607          * In any one result object, 'extra' + 'display' will always be unique.
 608          *
 609          * @abstract
 610          * @param {Date|null} current Current date
 611          * @return {Object} Data
 612          * @return {string} return.header String to display as the calendar header
 613          * @return {string} return.monthComponent Component to adjust by ±1 to change months.
 614          * @return {string} return.dayComponent Component to adjust by ±1 to change days.
 615          * @return {string} [return.weekComponent] Component to adjust by ±1 to change
 616          *   weeks. If omitted, the dayComponent should be adjusted by ±the number of
 617          *   non-nullable columns returned by this.getCalendarHeadings() to change weeks.
 618          * @return {Array} return.rows Array of arrays of "day" objects or null/undefined.
 619          */
 620         mw.widgets.datetime.DateTimeFormatter.prototype.getCalendarData = function ( /* components */ ) {
 621                 // Should be overridden by subclass
 622                 return {
 623                         header: '',
 624                         monthComponent: 'month',
 625                         dayComponent: 'day',
 626                         rows: []
 627                 };
 628         };
 629
 630 }() );