thedesk/app/js/common/time.js

231 lines
7.3 KiB
JavaScript
Raw Normal View History

2018-01-28 23:22:43 +11:00
/**
* Timeago is a jQuery plugin that makes it easy to support automatically
* updating fuzzy timestamps (e.g. "4 minutes ago" or "about 1 day ago").
*
* @name timeago
* @version 1.6.1
* @requires jQuery v1.2.3+
* @author Ryan McGeary
* @license MIT License - http://www.opensource.org/licenses/mit-license.php
*
* For usage and examples, visit:
* http://timeago.yarp.com/
*
* Copyright (c) 2008-2017, Ryan McGeary (ryan -[at]- mcgeary [*dot*] org)
*/
(function (factory) {
if (typeof define === 'function' && define.amd) {
// AMD. Register as an anonymous module.
2020-08-02 17:08:07 +10:00
define(['jquery'], factory)
2018-01-28 23:22:43 +11:00
} else if (typeof module === 'object' && typeof module.exports === 'object') {
2020-08-02 17:08:07 +10:00
factory(require('jquery'))
2018-01-28 23:22:43 +11:00
} else {
// Browser globals
2020-08-02 17:08:07 +10:00
factory(jQuery)
2018-01-28 23:22:43 +11:00
}
}(function ($) {
2019-05-19 17:39:30 +10:00
$.timeago = function (timestamp) {
2018-01-28 23:22:43 +11:00
if (timestamp instanceof Date) {
2020-08-02 17:08:07 +10:00
return inWords(timestamp)
2018-01-28 23:22:43 +11:00
} else if (typeof timestamp === "string") {
2020-08-02 17:08:07 +10:00
return inWords($.timeago.parse(timestamp))
2018-01-28 23:22:43 +11:00
} else if (typeof timestamp === "number") {
2020-08-02 17:08:07 +10:00
return inWords(new Date(timestamp))
2018-01-28 23:22:43 +11:00
} else {
2020-08-02 17:08:07 +10:00
return inWords($.timeago.datetime(timestamp))
2018-01-28 23:22:43 +11:00
}
2020-08-02 17:08:07 +10:00
}
var $t = $.timeago
2018-01-28 23:22:43 +11:00
$.extend($.timeago, {
settings: {
refreshMillis: 60000,
allowPast: true,
allowFuture: false,
localeTitle: false,
cutoff: 0,
autoDispose: true,
strings: {
2019-08-31 01:09:01 +10:00
prefixAgo: lang.lang_time_prefixAgo,
prefixFromNow: lang.lang_time_prefixFromNow,
suffixAgo: lang.lang_time_suffixAgo,
suffixFromNow: lang.lang_time_suffixFromNow,
inPast: lang.lang_time_inPast,
seconds: lang.lang_time_seconds,
minute: lang.lang_time_minute,
minutes: lang.lang_time_minutes,
hour: lang.lang_time_hour,
hours: lang.lang_time_hours,
day: lang.lang_time_day,
days: lang.lang_time_days,
month: lang.lang_time_month,
months: lang.lang_time_months,
year: lang.lang_time_year,
years: lang.lang_time_years,
2018-01-28 23:22:43 +11:00
wordSeparator: " ",
numbers: []
}
},
2019-05-19 17:39:30 +10:00
inWords: function (distanceMillis) {
if (!this.settings.allowPast && !this.settings.allowFuture) {
2020-08-02 17:08:07 +10:00
throw 'timeago allowPast and allowFuture settings can not both be set to false.'
2018-01-28 23:22:43 +11:00
}
2020-08-02 17:08:07 +10:00
var $l = this.settings.strings
var prefix = $l.prefixAgo
var suffix = $l.suffixAgo
2018-01-28 23:22:43 +11:00
if (this.settings.allowFuture) {
if (distanceMillis < 0) {
2020-08-02 17:08:07 +10:00
prefix = $l.prefixFromNow
suffix = $l.suffixFromNow
2018-01-28 23:22:43 +11:00
}
}
if (!this.settings.allowPast && distanceMillis >= 0) {
2020-08-02 17:08:07 +10:00
return this.settings.strings.inPast
2018-01-28 23:22:43 +11:00
}
2020-08-02 17:08:07 +10:00
var seconds = Math.abs(distanceMillis) / 1000
var minutes = seconds / 60
var hours = minutes / 60
var days = hours / 24
var years = days / 365
2018-01-28 23:22:43 +11:00
function substitute(stringOrFunction, number) {
2020-08-02 17:08:07 +10:00
var string = $.isFunction(stringOrFunction) ? stringOrFunction(number, distanceMillis) : stringOrFunction
var value = ($l.numbers && $l.numbers[number]) || number
return string.replace(/%d/i, value)
2018-01-28 23:22:43 +11:00
}
var words = seconds < 45 && substitute($l.seconds, Math.round(seconds)) ||
seconds < 90 && substitute($l.minute, 1) ||
minutes < 45 && substitute($l.minutes, Math.round(minutes)) ||
minutes < 90 && substitute($l.hour, 1) ||
hours < 24 && substitute($l.hours, Math.round(hours)) ||
hours < 42 && substitute($l.day, 1) ||
days < 30 && substitute($l.days, Math.round(days)) ||
days < 45 && substitute($l.month, 1) ||
days < 365 && substitute($l.months, Math.round(days / 30)) ||
years < 1.5 && substitute($l.year, 1) ||
2020-08-02 17:08:07 +10:00
substitute($l.years, Math.round(years))
2018-01-28 23:22:43 +11:00
2020-08-02 17:08:07 +10:00
var separator = $l.wordSeparator || ""
if ($l.wordSeparator === undefined) { separator = " " }
return $.trim([prefix, words, suffix].join(separator))
2018-01-28 23:22:43 +11:00
},
2019-05-19 17:39:30 +10:00
parse: function (iso8601) {
2020-08-02 17:08:07 +10:00
var s = $.trim(iso8601)
s = s.replace(/\.\d+/, "") // remove milliseconds
s = s.replace(/-/, "/").replace(/-/, "/")
s = s.replace(/T/, " ").replace(/Z/, " UTC")
s = s.replace(/([\+\-]\d\d)\:?(\d\d)/, " $1$2") // -04:00 -> -0400
s = s.replace(/([\+\-]\d\d)$/, " $100") // +09 -> +0900
return new Date(s)
2018-01-28 23:22:43 +11:00
},
2019-05-19 17:39:30 +10:00
datetime: function (elem) {
2020-08-02 17:08:07 +10:00
var iso8601 = $t.isTime(elem) ? $(elem).attr("datetime") : $(elem).attr("title")
return $t.parse(iso8601)
2018-01-28 23:22:43 +11:00
},
2019-05-19 17:39:30 +10:00
isTime: function (elem) {
2018-01-28 23:22:43 +11:00
// jQuery's `is()` doesn't play well with HTML5 in IE
2020-08-02 17:08:07 +10:00
return $(elem).get(0).tagName.toLowerCase() === "time" // $(elem).is("time");
2018-01-28 23:22:43 +11:00
}
2020-08-02 17:08:07 +10:00
})
2018-01-28 23:22:43 +11:00
// functions that can be called via $(el).timeago('action')
// init is default when no action is given
// functions are called with context of a single element
var functions = {
2019-05-19 17:39:30 +10:00
init: function () {
2020-08-02 17:08:07 +10:00
functions.dispose.call(this)
var refresh_el = $.proxy(refresh, this)
refresh_el()
var $s = $t.settings
2018-01-28 23:22:43 +11:00
if ($s.refreshMillis > 0) {
2020-08-02 17:08:07 +10:00
this._timeagoInterval = setInterval(refresh_el, $s.refreshMillis)
2018-01-28 23:22:43 +11:00
}
},
2019-05-19 17:39:30 +10:00
update: function (timestamp) {
2020-08-02 17:08:07 +10:00
var date = (timestamp instanceof Date) ? timestamp : $t.parse(timestamp)
$(this).data('timeago', { datetime: date })
2018-01-28 23:22:43 +11:00
if ($t.settings.localeTitle) {
2020-08-02 17:08:07 +10:00
$(this).attr("title", date.toLocaleString())
2018-01-28 23:22:43 +11:00
}
2020-08-02 17:08:07 +10:00
refresh.apply(this)
2018-01-28 23:22:43 +11:00
},
2019-05-19 17:39:30 +10:00
updateFromDOM: function () {
2020-08-02 17:08:07 +10:00
$(this).data('timeago', { datetime: $t.parse($t.isTime(this) ? $(this).attr("datetime") : $(this).attr("title")) })
refresh.apply(this)
2018-01-28 23:22:43 +11:00
},
dispose: function () {
if (this._timeagoInterval) {
2020-08-02 17:08:07 +10:00
window.clearInterval(this._timeagoInterval)
this._timeagoInterval = null
2018-01-28 23:22:43 +11:00
}
}
2020-08-02 17:08:07 +10:00
}
2018-01-28 23:22:43 +11:00
2019-05-19 17:39:30 +10:00
$.fn.timeago = function (action, options) {
2020-08-02 17:08:07 +10:00
var fn = action ? functions[action] : functions.init
2018-01-28 23:22:43 +11:00
if (!fn) {
2020-08-02 17:08:07 +10:00
throw new Error("Unknown function name '" + action + "' for timeago")
2018-01-28 23:22:43 +11:00
}
// each over objects here and call the requested function
2019-05-19 17:39:30 +10:00
this.each(function () {
2020-08-02 17:08:07 +10:00
fn.call(this, options)
})
return this
}
2018-01-28 23:22:43 +11:00
function refresh() {
2020-08-02 17:08:07 +10:00
var $s = $t.settings
2018-01-28 23:22:43 +11:00
//check if it's still visible
2019-05-19 17:39:30 +10:00
if ($s.autoDispose && !$.contains(document.documentElement, this)) {
2018-01-28 23:22:43 +11:00
//stop if it has been removed
2020-08-02 17:08:07 +10:00
$(this).timeago("dispose")
return this
2018-01-28 23:22:43 +11:00
}
2020-08-02 17:08:07 +10:00
var data = prepareData(this)
2018-01-28 23:22:43 +11:00
if (!isNaN(data.datetime)) {
2019-05-19 17:39:30 +10:00
if ($s.cutoff === 0 || Math.abs(distance(data.datetime)) < $s.cutoff) {
2020-08-02 17:08:07 +10:00
$(this).text(inWords(data.datetime))
2018-01-28 23:22:43 +11:00
} else {
if ($(this).attr('title').length > 0) {
2020-08-02 17:08:07 +10:00
$(this).text($(this).attr('title'))
2018-01-28 23:22:43 +11:00
}
}
}
2020-08-02 17:08:07 +10:00
return this
2018-01-28 23:22:43 +11:00
}
function prepareData(element) {
2020-08-02 17:08:07 +10:00
element = $(element)
2018-01-28 23:22:43 +11:00
if (!element.data("timeago")) {
2020-08-02 17:08:07 +10:00
element.data("timeago", { datetime: $t.datetime(element) })
var text = $.trim(element.text())
2018-01-28 23:22:43 +11:00
if ($t.settings.localeTitle) {
2020-08-02 17:08:07 +10:00
element.attr("title", element.data('timeago').datetime.toLocaleString())
2018-01-28 23:22:43 +11:00
} else if (text.length > 0 && !($t.isTime(element) && element.attr("title"))) {
2020-08-02 17:08:07 +10:00
element.attr("title", text)
2018-01-28 23:22:43 +11:00
}
}
2020-08-02 17:08:07 +10:00
return element.data("timeago")
2018-01-28 23:22:43 +11:00
}
function inWords(date) {
2020-08-02 17:08:07 +10:00
return $t.inWords(distance(date))
2018-01-28 23:22:43 +11:00
}
function distance(date) {
2020-08-02 17:08:07 +10:00
return (new Date().getTime() - date.getTime())
2018-01-28 23:22:43 +11:00
}
// fix for IE6 suckage
2020-08-02 17:08:07 +10:00
document.createElement("abbr")
document.createElement("time")
}))