2020-01-22 17:56:38 +01:00
/ * *
* EGroupware eTemplate2 - JS Date object
*
* @license http : //opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @package etemplate
* @subpackage api
* @link http : //www.egroupware.org
* @author Nathan Gray
* @copyright Nathan Gray 2011
* /
/ * e g w : u s e s
/ v e n d o r / b o w e r - a s s e t / j q u e r y / d i s t / j q u e r y . j s ;
2021-11-10 11:55:28 +01:00
/ a p i / j s / j q u e r y / j q u e r y - u i / j q u e r y - u i . j s ;
2020-01-22 17:56:38 +01:00
lib / date ;
et2_core_inputWidget ;
et2_core_valueWidget ;
* /
import './et2_core_common' ;
2020-02-13 19:56:52 +01:00
import { ClassWithAttributes } from "./et2_core_inheritance" ;
import { et2_createWidget , et2_register_widget , et2_widget , WidgetConfig } from "./et2_core_widget" ;
import { et2_valueWidget } from './et2_core_valueWidget'
import { et2_inputWidget } from './et2_core_inputWidget'
import { et2_selectbox } from './et2_widget_selectbox'
2020-01-22 17:56:38 +01:00
import { et2_DOMWidget } from "./et2_core_DOMWidget" ;
// lib/date.js:
declare function date ( format : string , timestamp? : string | number | Date ) ;
// all calls to jQueryUI.datetimepicker as jQuery.datepicker give errors which are currently suppressed with @ts-ignore
// adding npm package @types/jquery.ui.datetimepicker did NOT help :(
/ * *
* Class which implements the "date" XET - Tag
*
* Dates are passed to the server in ISO8601 format ( "Y-m-d\TH:i:sP" ) , and data_format is
* handled server - side .
*
* Widgets uses jQuery date - and time - picker for desktop browsers and
* HTML5 input fields for mobile devices to get their native UI for date / time entry .
* /
2020-01-22 20:12:36 +01:00
export class et2_date extends et2_inputWidget
2020-01-22 17:56:38 +01:00
{
static readonly _attributes : any = {
"value" : {
"type" : "any"
} ,
"type" : {
"ignore" : false
} ,
"blur" : {
"name" : "Placeholder" ,
"type" : "string" ,
"default" : "" ,
"description" : "This text get displayed if an input-field is empty and does not have the input-focus (blur). It can be used to show a default value or a kind of help-text."
} ,
"data_format" : {
"ignore" : true ,
"description" : "Date/Time format. Can be set as an options to date widget" ,
"default" : ''
} ,
year_range : {
name : "Year range" ,
type : "string" ,
default : "c-10:c+10" ,
description : "The range of years displayed in the year drop-down: either relative to today's year (\"-nn:+nn\"), relative to the currently selected year (\"c-nn:c+nn\"), absolute (\"nnnn:nnnn\"), or combinations of these formats (\"nnnn:-nn\"). Note that this option only affects what appears in the drop-down, to restrict which dates may be selected use the min and/or max options."
} ,
min : {
"name" : "Minimum" ,
"type" : "any" ,
"default" : et2_no_init ,
"description" : ' Minimum allowed date . Multiple types supported : \
Date : A date object containing the minimum date . \
Number : A number of days from today . For example 2 represents two days from today and - 1 represents yesterday . \
String : A string in the user \ 's date format, or a relative date. Relative dates must contain value and period pairs; valid periods are "y" for years, "m" for months, "w" for weeks, and "d" for days. For example, "+1m +7d" represents one month and seven days from today.'
} ,
max : {
"name" : "Maximum" ,
"type" : "any" ,
"default" : et2_no_init ,
"description" : ' Maximum allowed date . Multiple types supported : \
Date : A date object containing the maximum date . \
Number : A number of days from today . For example 2 represents two days from today and - 1 represents yesterday . \
String : A string in the user \ 's date format, or a relative date. Relative dates must contain value and period pairs; valid periods are "y" for years, "m" for months, "w" for weeks, and "d" for days. For example, "+1m +7d" represents one month and seven days from today.'
} ,
inline : {
"name" : "Inline" ,
"type" : "boolean" ,
"default" : false ,
"description" : "Instead of an input field with a popup calendar, the calendar is displayed inline, with no input field"
}
} ;
2020-03-30 18:28:48 +02:00
public static readonly legacyOptions : string [ ] = [ "data_format" ] ;
2020-01-22 17:56:38 +01:00
date : Date ;
span : JQuery ;
input_date : JQuery = null ;
is_mobile : boolean = false ;
dateFormat : string ;
timeFormat : string ;
/ * *
* Constructor
* /
constructor ( _parent , _attrs? : WidgetConfig , _child? : object )
{
// Call the inherited constructor
2020-01-22 18:38:33 +01:00
super ( _parent , _attrs , ClassWithAttributes . extendAttributes ( et2_date . _attributes , _child || { } ) ) ;
2020-01-22 17:56:38 +01:00
this . date = new Date ( ) ;
this . date . setUTCHours ( 0 ) ;
this . date . setMinutes ( 0 ) ;
this . date . setSeconds ( 0 ) ;
this . createInputWidget ( ) ;
}
createInputWidget ( )
{
this . span = jQuery ( document . createElement ( this . options . inline ? 'div' : "span" ) ) . addClass ( "et2_date" ) ;
this . input_date = jQuery ( document . createElement ( this . options . inline ? "div" : "input" ) ) ;
if ( this . options . blur ) this . input_date . attr ( 'placeholder' , this . egw ( ) . lang ( this . options . blur ) ) ;
this . input_date . addClass ( "et2_date" ) . attr ( "type" , "text" )
. attr ( "size" , 7 ) // strlen("10:00pm")=7
. appendTo ( this . span ) ;
this . setDOMNode ( this . span [ 0 ] ) ;
// inline calendar is not existing in html5, so allways use datepicker instead
this . is_mobile = egwIsMobile ( ) && ! this . options . inline ;
if ( this . is_mobile )
{
this . dateFormat = 'yy-mm-dd' ;
this . timeFormat = 'HH:mm' ;
switch ( this . getType ( ) )
{
case 'date' :
this . input_date . attr ( 'type' , 'date' ) ;
break ;
case 'date-time' :
this . input_date . attr ( 'type' , 'datetime-local' ) ;
break ;
case 'date-timeonly' :
this . input_date . addClass ( "et2_time" ) ;
this . input_date . attr ( 'type' , 'time' ) ;
break ;
}
}
else
{
this . dateFormat = this . egw ( ) . dateTimeFormat ( this . egw ( ) . preference ( "dateformat" ) ) ;
this . timeFormat = this . egw ( ) . preference ( "timeformat" ) == 12 ? "h:mmtt" : "HH:mm" ;
// jQuery-UI date picker
if ( this . getType ( ) != 'date-timeonly' )
{
this . egw ( ) . calendar ( this . input_date , this . getType ( ) == "date-time" ) ;
}
else
{
this . input_date . addClass ( "et2_time" ) ;
this . egw ( ) . time ( this . input_date ) ;
}
// Avoid collision of datepicker dialog with input field
var widget = this ;
this . input_date . datepicker ( 'option' , 'beforeShow' , function ( input , inst ) {
var cal = inst . dpDiv ;
setTimeout ( function ( ) {
var $input = jQuery ( input ) ;
var inputOffset = $input . offset ( ) ;
// position the datepicker in freespace zone
// avoid datepicker calendar collision with input field
if ( cal . height ( ) + inputOffset . top > window . innerHeight )
{
cal . position ( {
my : "left center" ,
at : 'right bottom' ,
collision : 'flip fit' ,
of : input
} ) ;
}
// Add tooltip to Today/Now button
jQuery ( '[data-handler="today"]' , cal ) . attr ( 'title' ,
widget . getType ( ) == 'date' ? egw . lang ( 'Today' ) : egw . lang ( 'Now' )
) ;
} , 0 ) ;
} )
. datepicker ( 'option' , 'onClose' , function ( dateText , inst ) {
// Lose focus, avoids an issue with focus
// not allowing datepicker to re-open
inst . input . blur ( ) ;
} ) ;
}
// Update internal value when changed
var self = this ;
this . input_date . bind ( 'change' , function ( e ) {
self . set_value ( this . value ) ;
return false ;
} ) ;
// Framewok skips nulls, but null needs to be processed here
if ( this . options . value == null )
{
this . set_value ( null ) ;
}
}
set_type ( _type )
{
if ( _type != this . getType ( ) )
{
super . setType ( _type ) ;
this . createInputWidget ( ) ;
}
}
/ * *
* Dynamic disable or enable datepicker
*
* @param { boolean } _ro
* /
set_readonly ( _ro )
{
if ( this . input_date && ! this . input_date . attr ( 'disabled' ) != ! _ro )
{
2020-01-22 20:12:36 +01:00
this . input_date . prop ( 'disabled' , ! ! _ro )
2020-01-22 17:56:38 +01:00
. datepicker ( 'option' , 'disabled' , ! ! _ro ) ;
}
}
/ * *
* Set ( full ) year of current date
*
* @param { number } _value 4 - digit year
* /
set_year ( _value )
{
this . date . setUTCFullYear ( _value ) ;
this . set_value ( this . date ) ;
}
/ * *
* Set month ( 1 . . 12 ) of current date
*
* @param { number } _value 1 . . 12
* /
set_month ( _value )
{
this . date . setUTCMonth ( _value - 1 ) ;
this . set_value ( this . date ) ;
}
/ * *
* Set day of current date
*
* @param { number } _value 1 . . 31
* /
set_date ( _value )
{
this . date . setUTCDate ( _value ) ;
this . set_value ( this . date ) ;
}
/ * *
* Set hour ( 0 . . 23 ) of current date
*
* @param { number } _value 0 . . 23
* /
set_hours ( _value )
{
this . date . setUTCHours ( _value ) ;
this . set_value ( this . date ) ;
}
/ * *
* Set minute ( 0 . . 59 ) of current date
*
* @param { number } _value 0 . . 59
* /
set_minutes ( _value )
{
this . date . setUTCMinutes ( _value ) ;
this . set_value ( this . date ) ;
}
/ * *
* Get ( full ) year of current date
*
* @return { number | null } 4 - digit year or null for empty
* /
get_year ( )
{
return this . input_date . val ( ) == "" ? null : this . date . getUTCFullYear ( ) ;
}
/ * *
* Get month ( 1 . . 12 ) of current date
*
* @return { number | null } 1 . . 12 or null for empty
* /
get_month ( )
{
return this . input_date . val ( ) == "" ? null : this . date . getUTCMonth ( ) + 1 ;
}
/ * *
* Get day of current date
*
* @return { number | null } 1 . . 31 or null for empty
* /
get_date ( )
{
return this . input_date . val ( ) == "" ? null : this . date . getUTCDate ( ) ;
}
/ * *
* Get hour ( 0 . . 23 ) of current date
*
* @return { number | null } 0 . . 23 or null for empty
* /
get_hours ( )
{
return this . input_date . val ( ) == "" ? null : this . date . getUTCHours ( ) ;
}
/ * *
* Get minute ( 0 . . 59 ) of current date
*
* @return { number | null } 0 . . 59 or null for empty
* /
get_minutes ( )
{
return this . input_date . val ( ) == "" ? null : this . date . getUTCMinutes ( ) ;
}
/ * *
* Get timestamp
*
* You can use set_value to set a timestamp .
*
* @return { number | null } timestamp ( seconds since 1970 - 01 - 01 )
* /
get_time ( )
{
return this . input_date . val ( ) == "" ? null : this . date . getTime ( ) ;
}
/ * *
* The range of years displayed in the year drop - down : either relative
* to today ' s year ( "-nn:+nn" ) , relative to the currently selected year
* ( "c-nn:c+nn" ) , absolute ( "nnnn:nnnn" ) , or combinations of these formats
* ( "nnnn:-nn" ) . Note that this option only affects what appears in the
* drop - down , to restrict which dates may be selected use the min_date
* and / or max_date options .
* @param { string } _value
* /
set_year_range ( _value )
{
if ( this . input_date && this . getType ( ) == 'date' && ! this . is_mobile )
{
this . input_date . datepicker ( 'option' , 'yearRange' , _value ) ;
}
this . options . year_range = _value ;
}
/ * *
* Set the minimum allowed date
*
* The minimum selectable date . When set to null , there is no minimum .
* Multiple types supported :
* Date : A date object containing the minimum date .
* Number : A number of days from today . For example 2 represents two days
* from today and - 1 represents yesterday .
* String : A string in the format defined by the dateFormat option , or a
* relative date . Relative dates must contain value and period pairs ;
* valid periods are "y" for years , "m" for months , "w" for weeks , and
* "d" for days . For example , "+1m +7d" represents one month and seven
* days from today .
* @param { Date | Number | String } _value
* /
set_min ( _value )
{
2021-10-19 22:15:37 +02:00
// minDate option checks the type, so make sure we're passing numbers as numbers (0, not "0")
// @ts-ignore
if ( typeof _value === "string" && ! isNaN ( _value ) && "" + parseInt ( _value ) == _value )
{
_value = parseInt ( _value ) ;
}
2020-01-22 17:56:38 +01:00
if ( this . input_date )
{
2021-10-19 22:15:37 +02:00
if ( this . is_mobile )
2020-01-22 17:56:38 +01:00
{
this . input_date . attr ( 'min' , this . _relativeDate ( _value ) ) ;
}
else
{
// Check for full timestamp
if ( typeof _value == 'string' && _value . match ( /(\d{4})-(\d{2})-(\d{2})T(\d{2})\:(\d{2})\:(\d{2})(?:\.\d{3})?(?:Z|[+-](\d{2})\:(\d{2}))/ ) )
{
_value = new Date ( _value ) ;
// Add timezone offset back in, or formatDate will lose those hours
var formatDate = new Date ( _value . valueOf ( ) + this . date . getTimezoneOffset ( ) * 60 * 1000 ) ;
if ( this . getType ( ) == 'date' )
{
_value = jQuery . datepicker . formatDate ( this . dateFormat , formatDate ) ;
}
}
this . input_date . datepicker ( 'option' , 'minDate' , _value ) ;
}
}
this . options . min = _value ;
}
/ * *
* Convert non html5 min or max attributes described above to timestamps
*
* @param { string | Date } _value
* /
_relativeDate ( _value )
{
if ( typeof _value == 'string' && _value . match ( /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}/ ) ) return _value ;
// @ts-ignore
return jQuery . datepicker . _determineDate ( jQuery . datepicker , _value , this . date ) . toJSON ( ) ;
}
/ * *
* Set the maximum allowed date
*
* The maximum selectable date . When set to null , there is no maximum .
* Multiple types supported :
* Date : A date object containing the maximum date .
* Number : A number of days from today . For example 2 represents two days
* from today and - 1 represents yesterday .
* String : A string in the format defined by the dateFormat option , or a
* relative date . Relative dates must contain value and period pairs ;
* valid periods are "y" for years , "m" for months , "w" for weeks , and
* "d" for days . For example , "+1m +7d" represents one month and seven
* days from today .
* @param { Date | Number | String } _value
* /
set_max ( _value )
{
2021-10-19 22:15:37 +02:00
// maxDate option checks the type, so make sure we're passing numbers as numbers (0, not "0")
// @ts-ignore
if ( typeof _value === "string" && ! isNaN ( _value ) && "" + parseInt ( _value ) == _value )
{
_value = parseInt ( _value ) ;
}
2020-01-22 17:56:38 +01:00
if ( this . input_date )
{
2021-10-19 22:15:37 +02:00
if ( this . is_mobile )
2020-01-22 17:56:38 +01:00
{
this . input_date . attr ( 'max' , this . _relativeDate ( _value ) ) ;
}
else
{
// Check for full timestamp
if ( typeof _value == 'string' && _value . match ( /(\d{4})-(\d{2})-(\d{2})T(\d{2})\:(\d{2})\:(\d{2})(?:\.\d{3})?(?:Z|[+-](\d{2})\:(\d{2}))/ ) )
{
_value = new Date ( _value ) ;
// Add timezone offset back in, or formatDate will lose those hours
var formatDate = new Date ( _value . valueOf ( ) + this . date . getTimezoneOffset ( ) * 60 * 1000 ) ;
if ( this . getType ( ) == 'date' )
{
_value = jQuery . datepicker . formatDate ( this . dateFormat , formatDate ) ;
}
}
this . input_date . datepicker ( 'option' , 'maxDate' , _value ) ;
}
}
this . options . max = _value ;
}
/ * *
* Setting date
*
* @param { string | number | Date } _value supported are the following formats :
* - Date object with usertime as UTC value
* - string like Date . toJSON ( )
* - string or number with timestamp in usertime like server - side uses it
* - string starting with + or - to add / substract given number of seconds from current value , "+600" to add 10 minutes
* /
set_value ( _value )
{
var old_value = this . _oldValue ;
if ( _value === null || _value === "" || _value === undefined ||
// allow 0 as empty-value for date and date-time widgets, as that is used a lot eg. in InfoLog
_value == 0 && ( this . getType ( ) == 'date-time' || this . getType ( ) == 'date' ) )
{
if ( this . input_date )
{
this . input_date . val ( "" ) ;
}
if ( this . _oldValue !== et2_no_init && old_value !== _value )
{
this . change ( this . input_date ) ;
}
this . _oldValue = _value ;
return ;
}
// timestamp in usertime, convert to 'Y-m-d\\TH:i:s\\Z', as we do on server-side with equivalent of PHP date()
if ( typeof _value == 'number' || typeof _value == 'string' && ! isNaN ( < number > < unknown > _value ) && _value [ 0 ] != '+' && _value [ 0 ] != '-' )
{
_value = date ( 'Y-m-d\\TH:i:s\\Z' , _value ) ;
}
// Check for full timestamp
if ( typeof _value == 'string' && _value . match ( /^(\d{4})-(\d{2})-(\d{2})T(\d{2})\:(\d{2})\:(\d{2})(?:\.\d{3})?(?:Z|[+-](\d{2})\:(\d{2})|)$/ ) )
{
_value = new Date ( _value ) ;
}
// Handle just time as a string in the form H:i
if ( typeof _value == 'string' && isNaN ( < number > < unknown > _value ) )
{
try {
// silently fix skiped minutes or times with just one digit, as parser is quite pedantic ;-)
var fix_reg = new RegExp ( ( this . getType ( ) == "date-timeonly" ? '^' : ' ' ) + '([0-9]+)(:[0-9]*)?( ?(a|p)m?)?$' , 'i' ) ;
var matches = _value . match ( fix_reg ) ;
if ( matches && ( matches [ 1 ] . length < 2 || matches [ 2 ] === undefined || matches [ 2 ] . length < 3 ||
matches [ 3 ] && matches [ 3 ] != 'am' && matches [ 3 ] != 'pm' ) )
{
if ( matches [ 1 ] . length < 2 && ! matches [ 3 ] ) matches [ 1 ] = '0' + matches [ 1 ] ;
if ( matches [ 2 ] === undefined ) matches [ 2 ] = ':00' ;
while ( matches [ 2 ] . length < 3 ) matches [ 2 ] = ':0' + matches [ 2 ] . substr ( 1 ) ;
_value = _value . replace ( fix_reg , ( this . getType ( ) == "date-timeonly" ? '' : ' ' ) + matches [ 1 ] + matches [ 2 ] + matches [ 3 ] ) ;
if ( matches [ 4 ] !== undefined ) matches [ 3 ] = matches [ 4 ] . toLowerCase ( ) == 'a' ? 'am' : 'pm' ;
}
switch ( this . getType ( ) )
{
case "date-timeonly" :
// @ts-ignore
var parsed = jQuery . datepicker . parseTime ( this . timeFormat , _value ) ;
if ( ! parsed ) // parseTime returns false
{
this . set_validation_error ( this . egw ( ) . lang ( "'%1' has an invalid format !!!" , _value ) ) ;
return ;
}
this . set_validation_error ( false ) ;
// this.date is on current date, changing it in get_value() to 1970-01-01, gives a time-difference, if we are currently on DST
this . date . setDate ( 1 ) ;
this . date . setMonth ( 0 ) ;
this . date . setFullYear ( 1970 ) ;
// Avoid javascript timezone offset, hour is in 'user time'
this . date . setUTCHours ( parsed . hour ) ;
this . date . setMinutes ( parsed . minute ) ;
if ( this . input_date . val ( ) != _value )
{
this . input_date . val ( _value ) ;
// @ts-ignore
this . input_date . timepicker ( 'setTime' , _value ) ;
if ( this . _oldValue !== et2_no_init )
{
this . change ( this . input_date ) ;
}
}
this . _oldValue = this . date . toJSON ( ) ;
return ;
default :
// Parse customfields's date with storage data_format to date object
// Or generally any date widgets with fixed date/time format
if ( this . id . match ( /^#/g ) && this . options . value == _value || ( this . options . data_format && this . options . value == _value ) )
{
switch ( this . getType ( ) )
{
case 'date' :
var parsed = jQuery . datepicker . parseDate ( this . egw ( ) . dateTimeFormat ( this . options . data_format ) , _value ) ;
break ;
case 'date-time' :
var DTformat = this . options . data_format . split ( ' ' ) ;
// @ts-ignore
var parsed = jQuery . datepicker . parseDateTime ( this . egw ( ) . dateTimeFormat ( DTformat [ 0 ] ) , this . egw ( ) . dateTimeFormat ( DTformat [ 1 ] ) , _value ) ;
}
}
else // Parse other date widgets date with timepicker date/time format to date onject
{
// @ts-ignore
var parsed = jQuery . datepicker . parseDateTime ( this . dateFormat ,
this . timeFormat , _value . replace ( 'T' , ' ' ) ) ;
if ( ! parsed )
{
this . set_validation_error ( this . egw ( ) . lang ( "%1' han an invalid format !!!" , _value ) ) ;
return ;
}
}
// Update local variable, but remove the timezone offset that
// javascript adds when we parse
if ( parsed )
{
this . date = new Date ( parsed . valueOf ( ) - parsed . getTimezoneOffset ( ) * 60000 ) ;
}
this . set_validation_error ( false ) ;
}
}
// catch exception from unparsable date and display it empty instead
catch ( e ) {
return this . set_value ( null ) ;
}
} else if ( typeof _value == 'object' && _value . date ) {
this . date = _value . date ;
} else if ( typeof _value == 'object' && _value . valueOf ) {
this . date = _value ;
} else
// string starting with + or - --> add/substract number of seconds from current value
{
this . date . setTime ( this . date . getTime ( ) + 1000 * parseInt ( _value ) ) ;
}
// Update input - popups do, but framework doesn't
_value = '' ;
// Add timezone offset back in, or formatDate will lose those hours
var formatDate = new Date ( this . date . valueOf ( ) + this . date . getTimezoneOffset ( ) * 60 * 1000 ) ;
if ( this . getType ( ) != 'date-timeonly' )
{
_value = jQuery . datepicker . formatDate ( this . dateFormat , formatDate ) ;
}
if ( this . getType ( ) != 'date' )
{
if ( this . getType ( ) != 'date-timeonly' ) _value += this . is_mobile ? 'T' : ' ' ;
// @ts-ignore
_value += jQuery . datepicker . formatTime ( this . timeFormat , {
hour : formatDate.getHours ( ) ,
minute : formatDate.getMinutes ( ) ,
seconds : 0 ,
timezone : 0
} ) ;
}
if ( this . options . inline )
{
this . input_date . datepicker ( "setDate" , formatDate ) ;
}
else
{
this . input_date . val ( _value ) ;
}
if ( this . _oldValue !== et2_no_init && old_value != this . getValue ( ) )
{
this . change ( this . input_date ) ;
}
this . _oldValue = _value ;
}
getValue ( )
{
if ( this . input_date . val ( ) == "" )
{
// User blanked the box
return null ;
}
// date-timeonly returns just the seconds, without any date!
if ( this . getType ( ) == 'date-timeonly' )
{
this . date . setUTCDate ( 1 ) ;
this . date . setUTCMonth ( 0 ) ;
this . date . setUTCFullYear ( 1970 ) ;
}
else if ( this . getType ( ) == 'date' )
{
this . date . setUTCHours ( 0 ) ;
this . date . setUTCMinutes ( 0 ) ;
}
// Convert to timestamp - no seconds
this . date . setSeconds ( 0 , 0 ) ;
return ( this . date && typeof this . date . toJSON != 'undefined' && this . date . toJSON ( ) ) ? this . date . toJSON ( ) . replace ( /\.\d{3}Z$/ , 'Z' ) : this . date ;
}
}
et2_register_widget ( et2_date , [ "date" , "date-time" , "date-timeonly" ] ) ;
/ * *
* Class which implements the "date-duration" XET - Tag
* /
2020-01-22 20:12:36 +01:00
export class et2_date_duration extends et2_date
2020-01-22 17:56:38 +01:00
{
static readonly _attributes : any = {
"data_format" : {
"name" : "Data format" ,
"default" : "m" ,
"type" : "string" ,
2021-02-05 14:57:38 +01:00
"description" : "Units to read/store the data. 'd' = days (float), 'h' = hours (float), 'm' = minutes (int), 's' = seconds (int)."
2020-01-22 17:56:38 +01:00
} ,
"display_format" : {
"name" : "Display format" ,
"default" : "dhm" ,
"type" : "string" ,
2021-02-05 14:57:38 +01:00
"description" : "Permitted units for displaying the data. 'd' = days, 'h' = hours, 'm' = minutes, 's' = seconds. Use combinations to give a choice. Default is 'dh' = days or hours with selectbox."
} ,
"select_unit" : {
"name" : "Select unit or input per unit" ,
"default" : true ,
"type" : "boolean" ,
"description" : "Display a unit-selection for multiple units, or an input field per unit."
2020-01-22 17:56:38 +01:00
} ,
"percent_allowed" : {
"name" : "Percent allowed" ,
"default" : false ,
"type" : "boolean" ,
"description" : "Allows to enter a percentage."
} ,
"hours_per_day" : {
"name" : "Hours per day" ,
"default" : 8 ,
"type" : "integer" ,
"description" : "Number of hours in a day, for converting between hours and (working) days."
} ,
"empty_not_0" : {
"name" : "0 or empty" ,
"default" : false ,
"type" : "boolean" ,
"description" : "Should the widget differ between 0 and empty, which get then returned as NULL"
} ,
"short_labels" : {
"name" : "Short labels" ,
"default" : false ,
"type" : "boolean" ,
"description" : "use d/h/m instead of day/hour/minute"
} ,
"step" : {
"name" : "Step limit" ,
"default" : 'any' ,
"type" : "string" ,
"description" : "Works with the min and max attributes to limit the increments at which a numeric or date-time value can be set."
}
} ;
2020-03-30 18:28:48 +02:00
public static readonly legacyOptions : string [ ] = [ "data_format" , "display_format" , "hours_per_day" , "empty_not_0" , "short_labels" ] ;
2020-01-22 17:56:38 +01:00
2021-02-05 14:57:38 +01:00
time_formats : { d : "d" , h : "h" , m : "m" , s : "s" } ;
2020-01-22 17:56:38 +01:00
// @ts-ignore baseWidget defines node as HTMLElement
node : JQuery ;
duration : JQuery ;
2020-02-13 19:56:52 +01:00
format : JQuery = null ;
2020-01-22 17:56:38 +01:00
/ * *
* Constructor
* /
constructor ( _parent , _attrs? : WidgetConfig , _child? : object )
{
// Call the inherited constructor
2020-01-22 18:38:33 +01:00
super ( _parent , _attrs , ClassWithAttributes . extendAttributes ( et2_date_duration . _attributes , _child || { } ) ) ;
2020-01-22 17:56:38 +01:00
// Legacy option put percent in with display format
if ( this . options . display_format . indexOf ( "%" ) != - 1 )
{
this . options . percent_allowed = true ;
this . options . display_format = this . options . display_format . replace ( "%" , "" ) ;
}
// Clean formats
2021-02-05 14:57:38 +01:00
this . options . display_format = this . options . display_format . replace ( /[^dhms]/ , '' ) ;
2020-01-22 17:56:38 +01:00
if ( ! this . options . display_format )
{
// @ts-ignore
this . options . display_format = this . attributes . display_format [ "default" ] ;
}
// Get translations
this . time_formats = {
2021-02-05 14:57:38 +01:00
d : this.options.short_labels ? this . egw ( ) . lang ( "d" ) : this . egw ( ) . lang ( "Days" ) ,
h : this.options.short_labels ? this . egw ( ) . lang ( "h" ) : this . egw ( ) . lang ( "Hours" ) ,
m : this.options.short_labels ? this . egw ( ) . lang ( "m" ) : this . egw ( ) . lang ( "Minutes" ) ,
s : this.options.short_labels ? this . egw ( ) . lang ( "s" ) : this . egw ( ) . lang ( "Seconds" )
2020-01-22 17:56:38 +01:00
} ,
this . createInputWidget ( ) ;
}
createInputWidget ( )
{
// Create nodes
this . node = jQuery ( document . createElement ( "span" ) )
. addClass ( 'et2_date_duration' ) ;
2021-02-05 14:57:38 +01:00
let inputs = [ ] ;
for ( let i = this . options.select_unit?1 :this.options.display_format.length ; i > 0 ; -- i )
{
let input = document . createElement ( "input" ) ;
inputs . push ( input ) ;
if ( ! this . options . select_unit )
{
let attr :any = { min : 0 } ;
switch ( this . options . display_format [ this . options . display_format . length - i ] )
{
case 's' :
attr . max = 60 ;
attr . title = this . egw ( ) . lang ( 'Seconds' ) ;
break ;
case 'm' :
attr . max = 60 ;
attr . title = this . egw ( ) . lang ( 'Minutes' ) ;
break ;
case 'h' :
attr . max = 24 ;
attr . title = this . egw ( ) . lang ( 'Hours' ) ;
break ;
case 'd' :
attr . title = this . egw ( ) . lang ( 'Days' ) ;
break ;
}
jQuery ( input ) . attr ( attr ) ;
}
}
this . duration = jQuery ( inputs )
2020-01-22 17:56:38 +01:00
. addClass ( 'et2_date_duration' )
2021-02-05 14:57:38 +01:00
. attr ( {
type : 'number' ,
size : 3 ,
step :this.options.step ,
lang : this.egw ( ) . preference ( 'number_format' ) [ 0 ] === "," ? "en-150" : "en-001"
} ) ;
2020-01-22 17:56:38 +01:00
this . node . append ( this . duration ) ;
var self = this ;
// seems the 'invalid' event doesn't work in all browsers, eg. FF therefore
// we use focusout event to check the valifdity of input right after user
// enters the value.
this . duration . on ( 'focusout' , function ( ) {
if ( ! ( < HTMLInputElement > self . duration [ 0 ] ) . checkValidity ( ) )
return self . duration . change ( ) ;
} ) ;
}
/ * *
* Clientside validation
*
* @param { array } _messages
* /
isValid ( _messages )
{
var ok = true ;
// if we have a html5 validation error, show it, as this.input.val() will be empty!
2021-02-09 14:51:10 +01:00
for ( let i = 0 ; this . duration && i < this . duration . length ; ++ i )
2020-01-22 17:56:38 +01:00
{
2021-02-09 14:51:10 +01:00
if ( this . duration [ i ] &&
( < HTMLInputElement > this . duration [ i ] ) . validationMessage &&
! ( < HTMLInputElement > this . duration [ i ] ) . validity . stepMismatch )
{
_messages . push ( ( < HTMLInputElement > this . duration [ i ] ) . validationMessage ) ;
ok = false ;
}
2020-01-22 17:56:38 +01:00
}
return super . isValid ( _messages ) && ok ;
}
attachToDOM ( )
{
2021-02-09 14:51:10 +01:00
if ( this . duration )
2020-01-22 17:56:38 +01:00
{
2021-02-09 14:51:10 +01:00
for ( let i = 0 ; i < this . duration . length ; ++ i )
{
let node = this . duration [ i ] ;
jQuery ( node ) . bind ( "change.et2_inputWidget" , this , function ( e ) {
e . data . change ( this ) ;
} ) ;
}
2020-01-22 17:56:38 +01:00
}
return et2_DOMWidget . prototype . attachToDOM . apply ( this , arguments ) ;
}
getDOMNode ( )
{
return this . node [ 0 ] ;
}
getInputNode ( )
{
return this . duration [ 0 ] ;
}
/ * *
* Use id on node , same as DOMWidget
*
* @param { string } _value id to set
* /
set_id ( _value )
{
this . id = _value ;
var node = this . getDOMNode ( ) ;
if ( node )
{
if ( _value != "" )
{
node . setAttribute ( "id" , this . getInstanceManager ( ) . uniqueId + '_' + this . id ) ;
}
else
{
node . removeAttribute ( "id" ) ;
}
}
}
2021-02-05 14:57:38 +01:00
private _unit2seconds ( _unit )
{
switch ( _unit )
{
case 's' :
return 1 ;
case 'm' :
return 60 ;
case 'h' :
return 3600 ;
case 'd' :
return 3600 * this . options . hours_per_day ;
}
}
2021-02-22 09:52:15 +01:00
private _unit_from_value ( _value , _unit , _highest )
2021-02-05 14:57:38 +01:00
{
_value *= this . _unit2seconds ( this . data_format ) ;
// get value for given _unit
switch ( _unit )
{
case 's' :
2021-02-22 09:52:15 +01:00
return _highest ? _value : _value % 60 ;
2021-02-05 14:57:38 +01:00
case 'm' :
2021-02-22 09:52:15 +01:00
_value = Math . floor ( _value / 60 ) ;
return _highest ? _value : _value % 60 ;
2021-02-05 14:57:38 +01:00
case 'h' :
2021-02-22 09:52:15 +01:00
_value = Math . floor ( _value / 3600 ) ;
return _highest ? _value : _value % this . options . hours_per_day ;
2021-02-05 14:57:38 +01:00
case 'd' :
return Math . floor ( _value / 3600 * this . options . hours_per_day ) ;
}
}
2020-01-22 17:56:38 +01:00
set_value ( _value )
{
this . options . value = _value ;
2021-02-05 14:57:38 +01:00
if ( ! this . options . select_unit && this . options . display_format . length > 1 )
{
for ( let i = this . options . display_format . length ; -- i >= 0 ; )
{
2021-03-29 18:02:55 +02:00
jQuery ( this . duration [ i ] ) . val ( this . _unit_from_value ( _value , this . options . display_format [ i ] , ! i ) ) ;
2021-02-05 14:57:38 +01:00
}
return ;
}
2020-02-10 23:32:31 +01:00
var display = this . _convert_to_display ( parseFloat ( _value ) ) ;
2020-01-22 17:56:38 +01:00
// Set display
if ( this . duration [ 0 ] . nodeName == "INPUT" )
{
this . duration . val ( display . value ) ;
}
else
{
this . duration . text ( display . value + " " ) ;
}
// Set unit as figured for display
2020-09-11 20:22:34 +02:00
if ( display . unit && display . unit != this . options . display_format )
2020-01-22 17:56:38 +01:00
{
if ( this . format && this . format . children ( ) . length > 1 ) {
jQuery ( "option[value='" + display . unit + "']" , this . format ) . attr ( 'selected' , 'selected' ) ;
}
else
{
this . format . text ( display . unit ? this . time_formats [ display . unit ] : '' ) ;
}
}
}
2020-02-07 17:30:43 +01:00
set_display_format ( format )
{
2020-09-11 20:22:34 +02:00
if ( format . length < 1 )
2020-02-07 17:30:43 +01:00
{
this . node . remove ( 'select.et2_date_duration' ) ;
2020-08-28 21:53:23 +02:00
this . format . remove ( ) ;
2020-02-13 19:56:52 +01:00
this . format = null ;
2020-02-07 17:30:43 +01:00
}
this . options . display_format = format ;
2021-02-05 14:57:38 +01:00
if ( ( this . format == null || this . format . is ( 'select' ) ) &&
( this . options . display_format . length <= 1 || this . options . readonly || ! this . options . select_unit ) )
2020-02-10 23:32:31 +01:00
{
2020-02-13 19:56:52 +01:00
if ( this . format )
{
this . format . remove ( ) ;
}
this . format = jQuery ( document . createElement ( 'span' ) ) . appendTo ( this . node ) ;
2020-02-10 23:32:31 +01:00
}
2021-02-05 14:57:38 +01:00
if ( ! this . options . select_unit && this . options . display_format . length > 1 )
{
// no unit selection or display
this . format . hide ( ) ;
}
else if ( this . options . display_format . length > 1 && ! this . options . readonly )
2020-02-07 17:30:43 +01:00
{
2020-02-13 19:56:52 +01:00
if ( this . format && ! this . format . is ( 'select' ) ) {
this . format . remove ( ) ;
this . format = null ;
}
if ( ! this . format )
{
this . format = jQuery ( document . createElement ( "select" ) )
2020-02-07 17:30:43 +01:00
. addClass ( 'et2_date_duration' ) ;
2020-02-13 19:56:52 +01:00
this . node . append ( this . format ) ;
}
2020-02-07 17:30:43 +01:00
2020-02-13 19:56:52 +01:00
this . format . empty ( ) ;
2020-02-07 17:30:43 +01:00
for ( var i = 0 ; i < this . options . display_format . length ; i ++ ) {
this . format . append ( "<option value='" + this . options . display_format [ i ] + "'>" + this . time_formats [ this . options . display_format [ i ] ] + "</option>" ) ;
}
}
else if ( this . time_formats [ this . options . display_format ] )
{
2020-02-13 19:56:52 +01:00
this . format . text ( this . time_formats [ this . options . display_format ] ) ;
2020-02-07 17:30:43 +01:00
}
else
{
2020-02-13 19:56:52 +01:00
this . format . text ( this . time_formats [ "m" ] ) ;
2020-02-07 17:30:43 +01:00
}
}
2020-01-22 17:56:38 +01:00
/ * *
* Converts the value in data format into value in display format .
*
* @param _value int / float Data in data format
*
* @return Object { value : Value in display format , unit : unit for display }
* /
_convert_to_display ( _value )
{
2021-02-05 14:57:38 +01:00
if ( ! this . options . select_unit )
{
let vals = [ ] ;
for ( let i = 0 ; i < this . options . display_format . length ; ++ i )
{
let unit = this . options . display_format [ i ] ;
2021-02-22 09:52:15 +01:00
let val = this . _unit_from_value ( _value , unit , i === 0 ) ;
2021-02-05 14:57:38 +01:00
if ( unit === 's' || unit === 'm' || unit === 'h' && this . options . display_format [ 0 ] === 'd' )
{
vals . push ( sprintf ( '%02d' , val ) ) ;
}
else
{
vals . push ( val ) ;
}
}
return { value : vals.join ( ':' ) , unit : '' } ;
}
2020-01-22 17:56:38 +01:00
if ( _value )
{
// Put value into minutes for further processing
switch ( this . options . data_format )
{
case 'd' :
_value *= this . options . hours_per_day ;
// fall-through
case 'h' :
_value *= 60 ;
break ;
2021-02-05 14:57:38 +01:00
case 's' :
_value /= 60.0 ;
break ;
2020-01-22 17:56:38 +01:00
}
}
// Figure out best unit for display
var _unit = this . options . display_format == "d" ? "d" : "h" ;
if ( this . options . display_format . indexOf ( 'm' ) > - 1 && _value && _value < 60 )
{
_unit = 'm' ;
}
else if ( this . options . display_format . indexOf ( 'd' ) > - 1 && _value >= 60 * this . options . hours_per_day )
{
_unit = 'd' ;
}
_value = this . options . empty_not_0 && _value === '' || ! this . options . empty_not_0 && ! _value ? '' :
( _unit == 'm' ? parseInt ( _value ) : ( Math . round ( ( _value / 60.0 / ( _unit == 'd' ? this . options.hours_per_day : 1 ) ) * 100 ) / 100 ) ) ;
if ( _value === '' ) _unit = '' ;
// use decimal separator from user prefs
var format = this . egw ( ) . preference ( 'number_format' ) ;
var sep = format ? format [ 0 ] : '.' ;
if ( typeof _value == 'string' && format && sep && sep != '.' )
{
_value = _value . replace ( '.' , sep ) ;
}
return { value : _value , unit :_unit } ;
}
/ * *
* Change displayed value into storage value and return
* /
getValue ( )
{
2021-02-05 14:57:38 +01:00
if ( ! this . options . select_unit && this . options . display_format . length > 1 )
{
let value = 0 ;
for ( let i = this . options . display_format . length ; -- i >= 0 ; )
{
value += parseInt ( < string > jQuery ( this . duration [ i ] ) . val ( ) ) * this . _unit2seconds ( this . options . display_format [ i ] ) ;
}
if ( this . options . data_format !== 's' )
{
value /= this . _unit2seconds ( this . options . data_format ) ;
}
return this . options . data_format === 'm' ? Math . round ( value ) : value ;
}
2020-01-22 17:56:38 +01:00
var value = this . duration . val ( ) . replace ( ',' , '.' ) ;
if ( value === '' )
{
return this . options . empty_not_0 ? '' : 0 ;
}
// Put value into minutes for further processing
switch ( this . format && this . format . val ( ) ? this . format . val ( ) : this . options . display_format )
{
case 'd' :
value *= this . options . hours_per_day ;
// fall-through
case 'h' :
value *= 60 ;
break ;
}
// Minutes should be an integer. Floating point math.
2021-02-05 14:57:38 +01:00
if ( this . options . data_format !== 's' )
{
value = Math . round ( value ) ;
}
2020-01-22 17:56:38 +01:00
switch ( this . options . data_format )
{
case 'd' :
value /= this . options . hours_per_day ;
// fall-through
case 'h' :
value /= 60.0 ;
break ;
2021-02-05 14:57:38 +01:00
case 's' :
value = Math . round ( value * 60.0 ) ;
break ;
2020-01-22 17:56:38 +01:00
}
return value ;
}
}
et2_register_widget ( et2_date_duration , [ "date-duration" ] ) ;
/ * *
* r / o date - duration
* /
2020-01-22 20:12:36 +01:00
export class et2_date_duration_ro extends et2_date_duration implements et2_IDetachedDOM
2020-01-22 17:56:38 +01:00
{
createInputWidget ( )
{
this . node = jQuery ( document . createElement ( "span" ) ) ;
this . duration = jQuery ( document . createElement ( "span" ) ) . appendTo ( this . node ) ;
this . format = jQuery ( document . createElement ( "span" ) ) . appendTo ( this . node ) ;
}
/ * *
* Code for implementing et2_IDetachedDOM
* Fast - clonable read - only widget that only deals with DOM nodes , not the widget tree
* /
/ * *
* Build a list of attributes which can be set when working in the
* "detached" mode in the _attrs array which is provided
* by the calling code .
*
* @param { array } _attrs array to add further attributes to
* /
getDetachedAttributes ( _attrs )
{
_attrs . push ( "value" ) ;
}
/ * *
* Returns an array of DOM nodes . The ( relativly ) same DOM - Nodes have to be
* passed to the "setDetachedAttributes" function in the same order .
*
* @return { array }
* /
getDetachedNodes ( )
{
return [ this . duration [ 0 ] , this . format [ 0 ] ] ;
}
/ * *
* Sets the given associative attribute - > value array and applies the
* attributes to the given DOM - Node .
*
* @param _nodes is an array of nodes which has to be in the same order as
* the nodes returned by "getDetachedNodes"
* @param _values is an associative array which contains a subset of attributes
* returned by the "getDetachedAttributes" function and sets them to the
* given values .
* /
setDetachedAttributes ( _nodes , _values )
{
for ( var i = 0 ; i < _nodes . length ; i ++ ) {
// Clear the node
for ( var j = _nodes [ i ] . childNodes . length - 1 ; j >= 0 ; j -- )
{
_nodes [ i ] . removeChild ( _nodes [ i ] . childNodes [ j ] ) ;
}
}
if ( typeof _values . value !== 'undefined' )
{
_values . value = parseFloat ( _values . value ) ;
}
if ( _values . value )
{
var display = this . _convert_to_display ( _values . value ) ;
_nodes [ 0 ] . appendChild ( document . createTextNode ( display . value ) ) ;
_nodes [ 1 ] . appendChild ( document . createTextNode ( display . unit ) ) ;
}
}
}
et2_register_widget ( et2_date_duration_ro , [ "date-duration_ro" ] ) ;
/ * *
* et2_date_ro is the readonly implementation of some date widget .
* /
2020-01-22 20:12:36 +01:00
export class et2_date_ro extends et2_valueWidget implements et2_IDetachedDOM
2020-01-22 17:56:38 +01:00
{
/ * *
* Ignore all more advanced attributes .
* /
static readonly _attributes : any = {
"value" : {
"type" : "string"
} ,
"type" : {
"ignore" : false
} ,
"data_format" : {
"ignore" : true ,
"description" : "Format data is in. This is not used client-side because it's always a timestamp client side."
} ,
min : { ignore : true } ,
max : { ignore : true } ,
year_range : { ignore : true }
} ;
2020-03-30 18:28:48 +02:00
public static readonly legacyOptions : [ "data_format" ] ;
2020-01-22 17:56:38 +01:00
/ * *
* Internal container for working easily with dates
* /
date : Date = new Date ( ) ;
value : string = "" ;
span : JQuery ;
/ * *
* Constructor
* /
constructor ( _parent , _attrs? : WidgetConfig , _child? : object )
{
// Call the inherited constructor
2020-01-22 18:38:33 +01:00
super ( _parent , _attrs , ClassWithAttributes . extendAttributes ( et2_date_ro . _attributes , _child || { } ) ) ;
2020-01-22 17:56:38 +01:00
this . _labelContainer = jQuery ( document . createElement ( "label" ) )
. addClass ( "et2_label" ) ;
this . span = jQuery ( document . createElement ( this . getType ( ) == "date-since" || this . getType ( ) == "date-time_today" ? "span" : "time" ) )
. addClass ( "et2_date_ro et2_label" )
. appendTo ( this . _labelContainer ) ;
this . setDOMNode ( this . _labelContainer [ 0 ] ) ;
}
set_value ( _value )
{
if ( typeof _value == 'undefined' ) _value = 0 ;
this . value = _value ;
if ( _value == 0 || _value == null )
{
this . span . attr ( "datetime" , "" ) . text ( "" ) ;
return ;
}
if ( typeof _value == 'string' && _value . match ( /(\d{4})-(\d{2})-(\d{2})T(\d{2})\:(\d{2})\:(\d{2})(?:\.\d{3})?(?:Z|[+-](\d{2})\:(\d{2}))/ ) )
{
this . date = new Date ( _value ) ;
this . date = new Date ( this . date . valueOf ( ) + ( this . date . getTimezoneOffset ( ) * 60 * 1000 ) ) ;
}
else if ( typeof _value == 'string' && ( isNaN ( < number > < unknown > _value ) ||
this . options . data_format && this . options . data_format . substr ( 0 , 3 ) === 'Ymd' ) )
{
try {
// data_format is not handled server-side for custom-fields in nextmatch
// as parseDateTime requires a separate between date and time, we fix the value here
switch ( this . options . data_format )
{
case 'Ymd' :
case 'YmdHi' :
case 'YmdHis' :
_value = _value . substr ( 0 , 4 ) + '-' + _value . substr ( 4 , 2 ) + '-' + _value . substr ( 6 , 2 ) + ' ' +
( _value . substr ( 8 , 2 ) || '00' ) + ':' + ( _value . substr ( 10 , 2 ) || '00' ) + ':' + ( _value . substr ( 12 , 2 ) || '00' ) ;
break ;
}
// parseDateTime to handle string PHP: DateTime local date/time format
// @ts-ignore
var parsed = ( typeof jQuery . datepicker . parseDateTime ( "yy-mm-dd" , "hh:mm:ss" , _value ) != 'undefined' ) ?
// @ts-ignore
jQuery . datepicker . parseDateTime ( "yy-mm-dd" , "hh:mm:ss" , _value ) :
// @ts-ignore
jQuery . datepicker . parseDateTime ( this . egw ( ) . preference ( 'dateformat' ) , this . egw ( ) . preference ( 'timeformat' ) == '24' ? 'H:i' : 'g:i a' , _value ) ;
}
// display unparsable dates as empty
catch ( e ) {
this . span . attr ( "datetime" , "" ) . text ( "" ) ;
return ;
}
var text = new Date ( parsed ) ;
// Update local variable, but remove the timezone offset that javascript adds
if ( parsed )
{
this . date = new Date ( text . valueOf ( ) - ( text . getTimezoneOffset ( ) * 60 * 1000 ) ) ;
}
// JS dates use milliseconds
this . date . setTime ( text . valueOf ( ) ) ;
}
else
{
// _value is timestamp in usertime, ready to be used with date() function identical to PHP date()
this . date = _value ;
}
var display = this . date . toString ( ) ;
switch ( this . getType ( ) ) {
case "time_or_date" :
case "date-time_today" :
// Today - just the time
if ( date ( 'Y-m-d' , this . date ) == date ( 'Y-m-d' ) )
{
display = date ( this . egw ( ) . preference ( 'timeformat' ) == '24' ? 'H:i' : 'g:i a' , this . date ) ;
}
else if ( this . getType ( ) === "time_or_date" )
{
display = date ( this . egw ( ) . preference ( 'dateformat' ) , this . date ) ;
}
// Before today - date and time
else
{
display = date ( this . egw ( ) . preference ( 'dateformat' ) + " " +
( this . egw ( ) . preference ( 'timeformat' ) == '24' ? 'H:i' : 'g:i a' ) , this . date ) ;
}
break ;
case "date" :
display = date ( this . egw ( ) . preference ( 'dateformat' ) , this . date ) ;
break ;
case "date-timeonly" :
display = date ( this . egw ( ) . preference ( 'timeformat' ) == '24' ? 'H:i' : 'g:i a' , this . date ) ;
break ;
case "date-time" :
display = date ( this . egw ( ) . preference ( 'dateformat' ) + " " +
( this . egw ( ) . preference ( 'timeformat' ) == '24' ? 'H:i' : 'g:i a' ) , this . date ) ;
break ;
case "date-since" :
var unit2label = {
'Y' : 'years' ,
'm' : 'month' ,
'd' : 'days' ,
'H' : 'hours' ,
'i' : 'minutes' ,
's' : 'seconds'
} ;
var unit2s = {
'Y' : 31536000 ,
'm' : 2628000 ,
'd' : 86400 ,
'H' : 3600 ,
'i' : 60 ,
's' : 1
} ;
var d = new Date ( ) ;
var diff = Math . round ( d . valueOf ( ) / 1000 ) - Math . round ( this . date . valueOf ( ) / 1000 ) ;
display = '' ;
for ( var unit in unit2s )
{
var unit_s = unit2s [ unit ] ;
if ( diff >= unit_s || unit == 's' )
{
display = Math . round ( diff / unit_s ) + ' ' + this . egw ( ) . lang ( unit2label [ unit ] ) ;
break ;
}
}
break ;
}
this . span . attr ( "datetime" , date ( "Y-m-d H:i:s" , this . date ) ) . text ( display ) ;
}
set_label ( label )
{
// Remove current label
this . _labelContainer . contents ( )
. filter ( function ( ) { return this . nodeType == 3 ; } ) . remove ( ) ;
var parts = et2_csvSplit ( label , 2 , "%s" ) ;
this . _labelContainer . prepend ( parts [ 0 ] ) ;
this . _labelContainer . append ( parts [ 1 ] ) ;
this . label = label ;
// add class if label is empty
this . _labelContainer . toggleClass ( 'et2_label_empty' , ! label || ! parts [ 0 ] ) ;
}
/ * *
* Creates a list of attributes which can be set when working in the
* "detached" mode . The result is stored in the _attrs array which is provided
* by the calling code .
*
* @param { array } _attrs array to add further attributes to
* /
getDetachedAttributes ( _attrs )
{
_attrs . push ( "label" , "value" , "class" ) ;
}
/ * *
* Returns an array of DOM nodes . The ( relatively ) same DOM - Nodes have to be
* passed to the "setDetachedAttributes" function in the same order .
*
* @return { array }
* /
getDetachedNodes ( )
{
return [ this . _labelContainer [ 0 ] , this . span [ 0 ] ] ;
}
/ * *
* Sets the given associative attribute - > value array and applies the
* attributes to the given DOM - Node .
*
* @param _nodes is an array of nodes which have to be in the same order as
* the nodes returned by "getDetachedNodes"
* @param _values is an associative array which contains a subset of attributes
* returned by the "getDetachedAttributes" function and sets them to the
* given values .
* /
setDetachedAttributes ( _nodes , _values )
{
this . _labelContainer = jQuery ( _nodes [ 0 ] ) ;
this . span = jQuery ( _nodes [ 1 ] ) ;
this . set_value ( _values [ "value" ] ) ;
if ( _values [ "label" ] )
{
this . set_label ( _values [ "label" ] ) ;
}
if ( _values [ "class" ] )
{
this . span . addClass ( _values [ "class" ] ) ;
}
}
}
et2_register_widget ( et2_date_ro , [ "date_ro" , "date-time_ro" , "date-since" , "date-time_today" , "time_or_date" , "date-timeonly_ro" ] ) ;
/ * *
* Widget for selecting a date range
* /
2020-01-22 20:12:36 +01:00
export class et2_date_range extends et2_inputWidget
2020-01-22 17:56:38 +01:00
{
static readonly _attributes : any = {
value : {
"type" : "any" ,
"description" : "An object with keys 'from' and 'to' for absolute ranges, or a relative range string"
} ,
relative : {
name : 'Relative' ,
type : 'boolean' ,
description : 'Is the date range relative (this week) or absolute (2016-02-15 - 2016-02-21). This will affect the value returned.'
}
2020-02-07 17:30:43 +01:00
} ;
2020-01-22 17:56:38 +01:00
div : JQuery ;
from : et2_date ;
to : et2_date ;
select : et2_selectbox ;
/ * *
* Constructor
* /
constructor ( _parent , _attrs? : WidgetConfig , _child? : object )
{
// Call the inherited constructor
2020-01-22 18:38:33 +01:00
super ( _parent , _attrs , ClassWithAttributes . extendAttributes ( et2_date_range . _attributes , _child || { } ) ) ;
2020-01-22 17:56:38 +01:00
this . div = jQuery ( document . createElement ( 'div' ) )
. attr ( { class : 'et2_date_range' } ) ;
this . from = null ;
this . to = null ;
this . select = null ;
// Set domid
this . set_id ( this . id ) ;
this . setDOMNode ( this . div [ 0 ] ) ;
this . _createWidget ( ) ;
this . set_relative ( this . options . relative || false ) ;
}
_createWidget ( )
{
var widget = this ;
this . from = < et2_date > et2_createWidget ( 'date' , {
id : this.id + '[from]' ,
blur : egw.lang ( 'From' ) ,
2021-10-22 13:27:37 +02:00
onchange ( _node , _widget ) {
widget . to . set_min ( widget . from . getValue ( ) ) ;
if ( _node instanceof jQuery ) widget . onchange . call ( widget , _widget , widget ) ;
}
2020-01-22 17:56:38 +01:00
} , this ) ;
this . to = < et2_date > et2_createWidget ( 'date' , {
id : this.id + '[to]' ,
blur : egw.lang ( 'To' ) ,
2021-10-22 13:27:37 +02:00
onchange ( _node , _widget ) {
widget . from . set_max ( widget . to . getValue ( ) ) ;
if ( _node instanceof jQuery ) widget . onchange . call ( widget , _widget , widget ) ;
}
2020-01-22 17:56:38 +01:00
} , this ) ;
this . select = < et2_selectbox > < unknown > et2_createWidget ( 'select' , {
id : this.id + '[relative]' ,
select_options : et2_date_range.relative_dates ,
empty_label : this.options.blur || 'All'
} , this ) ;
this . select . loadingFinished ( ) ;
}
/ * *
* Function which allows iterating over the complete widget tree .
* Overridden here to avoid problems with children when getting value
*
* @param _callback is the function which should be called for each widget
* @param _context is the context in which the function should be executed
* @param _type is an optional parameter which specifies a class / interface
* the elements have to be instanceOf .
* /
iterateOver ( _callback , _context , _type )
{
if ( typeof _type == "undefined" )
{
_type = et2_widget ;
}
if ( this . isInTree ( ) && this . instanceOf ( _type ) )
{
_callback . call ( _context , this ) ;
}
}
/ * *
* Toggles relative or absolute dates
*
* @param { boolean } _value
* /
set_relative ( _value )
{
this . options . relative = _value ;
if ( this . options . relative )
{
jQuery ( this . from . getDOMNode ( ) ) . hide ( ) ;
jQuery ( this . to . getDOMNode ( ) ) . hide ( ) ;
}
else
{
jQuery ( this . select . getDOMNode ( ) ) . hide ( ) ;
}
}
set_value ( value )
{
// @ts-ignore
if ( ! value || typeof value == 'null' )
{
this . select . set_value ( '' ) ;
this . from . set_value ( null ) ;
this . to . set_value ( null ) ;
}
// Relative
if ( value && typeof value === 'string' )
{
this . _set_relative_value ( value ) ;
}
else if ( value && typeof value . from === 'undefined' && value [ 0 ] )
{
value = {
from : value [ 0 ] ,
to : value [ 1 ] || new Date ( ) . valueOf ( ) / 1000
} ;
}
else if ( value && value . from && value . to )
{
this . from . set_value ( value . from ) ;
this . to . set_value ( value . to ) ;
}
}
getValue ( )
{
return this . options . relative ?
this . select . getValue ( ) :
{ from : this . from . getValue ( ) , to : this.to.getValue ( ) } ;
}
_set_relative_value ( _value )
{
if ( this . options . relative )
{
jQuery ( this . select . getDOMNode ( ) ) . show ( ) ;
}
// Show description
this . select . set_value ( _value ) ;
var tempDate = new Date ( ) ;
var today = new Date ( tempDate . getFullYear ( ) , tempDate . getMonth ( ) , tempDate . getDate ( ) , 0 , - tempDate . getTimezoneOffset ( ) , 0 ) ;
// Use strings to avoid references
this . from . set_value ( today . toJSON ( ) ) ;
this . to . set_value ( today . toJSON ( ) ) ;
var relative = null ;
for ( var index in et2_date_range . relative_dates )
{
if ( et2_date_range . relative_dates [ index ] . value === _value )
{
relative = et2_date_range . relative_dates [ index ] ;
break ;
}
}
if ( relative )
{
var dates = [ "from" , "to" ] ;
var value = today . toJSON ( ) ;
for ( var i = 0 ; i < dates . length ; i ++ )
{
var date = dates [ i ] ;
if ( typeof relative [ date ] == "function" )
{
value = relative [ date ] ( new Date ( value ) ) ;
}
else
{
value = this [ date ] . _relativeDate ( relative [ date ] ) ;
}
this [ date ] . set_value ( value ) ;
}
}
}
// Class Constants
static readonly relative_dates = [
// Start and end are relative offsets, see et2_date.set_min()
// or Date objects
{
value : 'Today' ,
2020-04-15 19:21:53 +02:00
label : egw.lang ( 'Today' ) ,
2020-01-22 17:56:38 +01:00
from ( date ) { return date ; } ,
to ( date ) { return date ; }
} ,
{
2020-04-15 19:21:53 +02:00
label : egw.lang ( 'Yesterday' ) ,
2020-01-22 17:56:38 +01:00
value : 'Yesterday' ,
from ( date ) {
date . setUTCDate ( date . getUTCDate ( ) - 1 ) ;
return date ;
} ,
to : ''
} ,
{
2020-04-15 19:21:53 +02:00
label : egw.lang ( 'This week' ) ,
2020-01-22 17:56:38 +01:00
value : 'This week' ,
from ( date ) { return egw . week_start ( date ) ; } ,
to ( date ) {
date . setUTCDate ( date . getUTCDate ( ) + 6 ) ;
return date ;
}
} ,
{
2020-04-15 19:21:53 +02:00
label : egw.lang ( 'Last week' ) ,
2020-01-22 17:56:38 +01:00
value : 'Last week' ,
from ( date ) {
var d = egw . week_start ( date ) ;
d . setUTCDate ( d . getUTCDate ( ) - 7 ) ;
return d ;
} ,
to ( date ) {
date . setUTCDate ( date . getUTCDate ( ) + 6 ) ;
return date ;
}
} ,
{
2020-04-15 19:21:53 +02:00
label : egw.lang ( 'This month' ) ,
2020-01-22 17:56:38 +01:00
value : 'This month' ,
from ( date )
{
date . setUTCDate ( 1 ) ;
return date ;
} ,
to ( date )
{
date . setUTCMonth ( date . getUTCMonth ( ) + 1 ) ;
date . setUTCDate ( 0 ) ;
return date ;
}
} ,
{
2020-04-15 19:21:53 +02:00
label : egw.lang ( 'Last month' ) ,
2020-01-22 17:56:38 +01:00
value : 'Last month' ,
from ( date )
{
date . setUTCMonth ( date . getUTCMonth ( ) - 1 ) ;
date . setUTCDate ( 1 ) ;
return date ;
} ,
to ( date )
{
date . setUTCMonth ( date . getUTCMonth ( ) + 1 ) ;
date . setUTCDate ( 0 ) ;
return date ;
}
} ,
{
2020-04-15 19:21:53 +02:00
label : egw.lang ( 'Last 3 months' ) ,
2020-01-22 17:56:38 +01:00
value : 'Last 3 months' ,
from ( date )
{
date . setUTCMonth ( date . getUTCMonth ( ) - 2 ) ;
date . setUTCDate ( 1 ) ;
return date ;
} ,
to ( date )
{
date . setUTCMonth ( date . getUTCMonth ( ) + 3 ) ;
date . setUTCDate ( 0 ) ;
return date ;
}
} ,
/ *
'This quarter' = > array ( 0 , 0 , 0 , 0 , 0 , 0 , 0 , 0 ) , // Just a marker, needs special handling
'Last quarter' = > array ( 0 , - 4 , 0 , 0 , 0 , - 4 , 0 , 0 ) , // Just a marker
* /
{
2020-04-15 19:21:53 +02:00
label : egw.lang ( 'This year' ) ,
2020-01-22 17:56:38 +01:00
value : 'This year' ,
from ( d ) {
d . setUTCMonth ( 0 ) ;
d . setUTCDate ( 1 ) ;
return d ;
} ,
to ( d ) {
d . setUTCMonth ( 11 ) ;
d . setUTCDate ( 31 ) ;
return d ;
}
} ,
{
2020-04-15 19:21:53 +02:00
label : egw.lang ( 'Last year' ) ,
2020-01-22 17:56:38 +01:00
value : 'Last year' ,
from ( d ) {
d . setUTCMonth ( 0 ) ;
d . setUTCDate ( 1 ) ;
d . setUTCYear ( d . getUTCYear ( ) - 1 ) ;
return d ;
} ,
to ( d ) {
d . setUTCMonth ( 11 ) ;
d . setUTCDate ( 31 ) ;
d . setUTCYear ( d . getUTCYear ( ) - 1 ) ;
return d ;
}
}
/ * S t i l l n e e d e d ?
'2 years ago' = > array ( - 2 , 0 , 0 , 0 , - 1 , 0 , 0 , 0 ) ,
'3 years ago' = > array ( - 3 , 0 , 0 , 0 , - 2 , 0 , 0 , 0 ) ,
* /
] ;
}
et2_register_widget ( et2_date_range , [ "date-range" ] ) ;