1
0

DateTimeShortcuts.js 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417
  1. /*global Calendar, findPosX, findPosY, get_format, gettext, gettext_noop, interpolate, ngettext, quickElement*/
  2. // Inserts shortcut buttons after all of the following:
  3. // <input type="text" class="vDateField">
  4. // <input type="text" class="vTimeField">
  5. 'use strict';
  6. {
  7. const DateTimeShortcuts = {
  8. calendars: [],
  9. calendarInputs: [],
  10. clockInputs: [],
  11. clockHours: {
  12. default_: [
  13. [gettext_noop('Now'), -1],
  14. [gettext_noop('Midnight'), 0],
  15. [gettext_noop('6 a.m.'), 6],
  16. [gettext_noop('Noon'), 12],
  17. [gettext_noop('6 p.m.'), 18]
  18. ]
  19. },
  20. dismissClockFunc: [],
  21. dismissCalendarFunc: [],
  22. calendarDivName1: 'calendarbox', // name of calendar <div> that gets toggled
  23. calendarDivName2: 'calendarin', // name of <div> that contains calendar
  24. calendarLinkName: 'calendarlink', // name of the link that is used to toggle
  25. clockDivName: 'clockbox', // name of clock <div> that gets toggled
  26. clockLinkName: 'clocklink', // name of the link that is used to toggle
  27. shortCutsClass: 'datetimeshortcuts', // class of the clock and cal shortcuts
  28. timezoneWarningClass: 'timezonewarning', // class of the warning for timezone mismatch
  29. timezoneOffset: 0,
  30. init: function() {
  31. const body = document.getElementsByTagName('body')[0];
  32. const serverOffset = body.dataset.adminUtcOffset;
  33. if (serverOffset) {
  34. const localOffset = new Date().getTimezoneOffset() * -60;
  35. DateTimeShortcuts.timezoneOffset = localOffset - serverOffset;
  36. }
  37. for (const inp of document.getElementsByTagName('input')) {
  38. if (inp.type === 'text' && inp.classList.contains('vTimeField')) {
  39. DateTimeShortcuts.addClock(inp);
  40. DateTimeShortcuts.addTimezoneWarning(inp);
  41. }
  42. else if (inp.type === 'text' && inp.classList.contains('vDateField')) {
  43. DateTimeShortcuts.addCalendar(inp);
  44. DateTimeShortcuts.addTimezoneWarning(inp);
  45. }
  46. }
  47. },
  48. // Return the current time while accounting for the server timezone.
  49. now: function() {
  50. const body = document.getElementsByTagName('body')[0];
  51. const serverOffset = body.dataset.adminUtcOffset;
  52. if (serverOffset) {
  53. const localNow = new Date();
  54. const localOffset = localNow.getTimezoneOffset() * -60;
  55. localNow.setTime(localNow.getTime() + 1000 * (serverOffset - localOffset));
  56. return localNow;
  57. } else {
  58. return new Date();
  59. }
  60. },
  61. // Add a warning when the time zone in the browser and backend do not match.
  62. addTimezoneWarning: function(inp) {
  63. const warningClass = DateTimeShortcuts.timezoneWarningClass;
  64. let timezoneOffset = DateTimeShortcuts.timezoneOffset / 3600;
  65. // Only warn if there is a time zone mismatch.
  66. if (!timezoneOffset) {
  67. return;
  68. }
  69. // Check if warning is already there.
  70. if (inp.parentNode.querySelectorAll('.' + warningClass).length) {
  71. return;
  72. }
  73. let message;
  74. if (timezoneOffset > 0) {
  75. message = ngettext(
  76. 'Note: You are %s hour ahead of server time.',
  77. 'Note: You are %s hours ahead of server time.',
  78. timezoneOffset
  79. );
  80. }
  81. else {
  82. timezoneOffset *= -1;
  83. message = ngettext(
  84. 'Note: You are %s hour behind server time.',
  85. 'Note: You are %s hours behind server time.',
  86. timezoneOffset
  87. );
  88. }
  89. message = interpolate(message, [timezoneOffset]);
  90. const warning = document.createElement('span');
  91. warning.className = warningClass;
  92. warning.textContent = message;
  93. inp.parentNode.appendChild(document.createElement('br'));
  94. inp.parentNode.appendChild(warning);
  95. },
  96. // Add clock widget to a given field
  97. addClock: function(inp) {
  98. const num = DateTimeShortcuts.clockInputs.length;
  99. DateTimeShortcuts.clockInputs[num] = inp;
  100. DateTimeShortcuts.dismissClockFunc[num] = function() { DateTimeShortcuts.dismissClock(num); return true; };
  101. // Shortcut links (clock icon and "Now" link)
  102. const shortcuts_span = document.createElement('span');
  103. shortcuts_span.className = DateTimeShortcuts.shortCutsClass;
  104. inp.parentNode.insertBefore(shortcuts_span, inp.nextSibling);
  105. const now_link = document.createElement('a');
  106. now_link.href = "#";
  107. now_link.textContent = gettext('Now');
  108. now_link.addEventListener('click', function(e) {
  109. e.preventDefault();
  110. DateTimeShortcuts.handleClockQuicklink(num, -1);
  111. });
  112. const clock_link = document.createElement('a');
  113. clock_link.href = '#';
  114. clock_link.id = DateTimeShortcuts.clockLinkName + num;
  115. clock_link.addEventListener('click', function(e) {
  116. e.preventDefault();
  117. // avoid triggering the document click handler to dismiss the clock
  118. e.stopPropagation();
  119. DateTimeShortcuts.openClock(num);
  120. });
  121. quickElement(
  122. 'span', clock_link, '',
  123. 'class', 'clock-icon',
  124. 'title', gettext('Choose a Time')
  125. );
  126. shortcuts_span.appendChild(document.createTextNode('\u00A0'));
  127. shortcuts_span.appendChild(now_link);
  128. shortcuts_span.appendChild(document.createTextNode('\u00A0|\u00A0'));
  129. shortcuts_span.appendChild(clock_link);
  130. // Create clock link div
  131. //
  132. // Markup looks like:
  133. // <div id="clockbox1" class="clockbox module">
  134. // <h2>Choose a time</h2>
  135. // <ul class="timelist">
  136. // <li><a href="#">Now</a></li>
  137. // <li><a href="#">Midnight</a></li>
  138. // <li><a href="#">6 a.m.</a></li>
  139. // <li><a href="#">Noon</a></li>
  140. // <li><a href="#">6 p.m.</a></li>
  141. // </ul>
  142. // <p class="calendar-cancel"><a href="#">Cancel</a></p>
  143. // </div>
  144. const clock_box = document.createElement('div');
  145. clock_box.style.display = 'none';
  146. clock_box.style.position = 'absolute';
  147. clock_box.className = 'clockbox module';
  148. clock_box.id = DateTimeShortcuts.clockDivName + num;
  149. document.body.appendChild(clock_box);
  150. clock_box.addEventListener('click', function(e) { e.stopPropagation(); });
  151. quickElement('h2', clock_box, gettext('Choose a time'));
  152. const time_list = quickElement('ul', clock_box);
  153. time_list.className = 'timelist';
  154. // The list of choices can be overridden in JavaScript like this:
  155. // DateTimeShortcuts.clockHours.name = [['3 a.m.', 3]];
  156. // where name is the name attribute of the <input>.
  157. const name = typeof DateTimeShortcuts.clockHours[inp.name] === 'undefined' ? 'default_' : inp.name;
  158. DateTimeShortcuts.clockHours[name].forEach(function(element) {
  159. const time_link = quickElement('a', quickElement('li', time_list), gettext(element[0]), 'href', '#');
  160. time_link.addEventListener('click', function(e) {
  161. e.preventDefault();
  162. DateTimeShortcuts.handleClockQuicklink(num, element[1]);
  163. });
  164. });
  165. const cancel_p = quickElement('p', clock_box);
  166. cancel_p.className = 'calendar-cancel';
  167. const cancel_link = quickElement('a', cancel_p, gettext('Cancel'), 'href', '#');
  168. cancel_link.addEventListener('click', function(e) {
  169. e.preventDefault();
  170. DateTimeShortcuts.dismissClock(num);
  171. });
  172. document.addEventListener('keyup', function(event) {
  173. if (event.which === 27) {
  174. // ESC key closes popup
  175. DateTimeShortcuts.dismissClock(num);
  176. event.preventDefault();
  177. }
  178. });
  179. },
  180. openClock: function(num) {
  181. const clock_box = document.getElementById(DateTimeShortcuts.clockDivName + num);
  182. const clock_link = document.getElementById(DateTimeShortcuts.clockLinkName + num);
  183. // Recalculate the clockbox position
  184. // is it left-to-right or right-to-left layout ?
  185. if (window.getComputedStyle(document.body).direction !== 'rtl') {
  186. clock_box.style.left = findPosX(clock_link) + 17 + 'px';
  187. }
  188. else {
  189. // since style's width is in em, it'd be tough to calculate
  190. // px value of it. let's use an estimated px for now
  191. clock_box.style.left = findPosX(clock_link) - 110 + 'px';
  192. }
  193. clock_box.style.top = Math.max(0, findPosY(clock_link) - 30) + 'px';
  194. // Show the clock box
  195. clock_box.style.display = 'block';
  196. document.addEventListener('click', DateTimeShortcuts.dismissClockFunc[num]);
  197. },
  198. dismissClock: function(num) {
  199. document.getElementById(DateTimeShortcuts.clockDivName + num).style.display = 'none';
  200. document.removeEventListener('click', DateTimeShortcuts.dismissClockFunc[num]);
  201. },
  202. handleClockQuicklink: function(num, val) {
  203. let d;
  204. if (val === -1) {
  205. d = DateTimeShortcuts.now();
  206. }
  207. else {
  208. d = new Date(1970, 1, 1, val, 0, 0, 0);
  209. }
  210. DateTimeShortcuts.clockInputs[num].value = d.strftime(get_format('TIME_INPUT_FORMATS')[0]);
  211. DateTimeShortcuts.clockInputs[num].focus();
  212. DateTimeShortcuts.dismissClock(num);
  213. },
  214. // Add calendar widget to a given field.
  215. addCalendar: function(inp) {
  216. const num = DateTimeShortcuts.calendars.length;
  217. DateTimeShortcuts.calendarInputs[num] = inp;
  218. DateTimeShortcuts.dismissCalendarFunc[num] = function() { DateTimeShortcuts.dismissCalendar(num); return true; };
  219. // Shortcut links (calendar icon and "Today" link)
  220. const shortcuts_span = document.createElement('span');
  221. shortcuts_span.className = DateTimeShortcuts.shortCutsClass;
  222. inp.parentNode.insertBefore(shortcuts_span, inp.nextSibling);
  223. const today_link = document.createElement('a');
  224. today_link.href = '#';
  225. today_link.appendChild(document.createTextNode(gettext('Today')));
  226. today_link.addEventListener('click', function(e) {
  227. e.preventDefault();
  228. DateTimeShortcuts.handleCalendarQuickLink(num, 0);
  229. });
  230. const cal_link = document.createElement('a');
  231. cal_link.href = '#';
  232. cal_link.id = DateTimeShortcuts.calendarLinkName + num;
  233. cal_link.addEventListener('click', function(e) {
  234. e.preventDefault();
  235. // avoid triggering the document click handler to dismiss the calendar
  236. e.stopPropagation();
  237. DateTimeShortcuts.openCalendar(num);
  238. });
  239. quickElement(
  240. 'span', cal_link, '',
  241. 'class', 'date-icon',
  242. 'title', gettext('Choose a Date')
  243. );
  244. shortcuts_span.appendChild(document.createTextNode('\u00A0'));
  245. shortcuts_span.appendChild(today_link);
  246. shortcuts_span.appendChild(document.createTextNode('\u00A0|\u00A0'));
  247. shortcuts_span.appendChild(cal_link);
  248. // Create calendarbox div.
  249. //
  250. // Markup looks like:
  251. //
  252. // <div id="calendarbox3" class="calendarbox module">
  253. // <h2>
  254. // <a href="#" class="link-previous">&lsaquo;</a>
  255. // <a href="#" class="link-next">&rsaquo;</a> February 2003
  256. // </h2>
  257. // <div class="calendar" id="calendarin3">
  258. // <!-- (cal) -->
  259. // </div>
  260. // <div class="calendar-shortcuts">
  261. // <a href="#">Yesterday</a> | <a href="#">Today</a> | <a href="#">Tomorrow</a>
  262. // </div>
  263. // <p class="calendar-cancel"><a href="#">Cancel</a></p>
  264. // </div>
  265. const cal_box = document.createElement('div');
  266. cal_box.style.display = 'none';
  267. cal_box.style.position = 'absolute';
  268. cal_box.className = 'calendarbox module';
  269. cal_box.id = DateTimeShortcuts.calendarDivName1 + num;
  270. document.body.appendChild(cal_box);
  271. cal_box.addEventListener('click', function(e) { e.stopPropagation(); });
  272. // next-prev links
  273. const cal_nav = quickElement('div', cal_box);
  274. const cal_nav_prev = quickElement('a', cal_nav, '<', 'href', '#');
  275. cal_nav_prev.className = 'calendarnav-previous';
  276. cal_nav_prev.addEventListener('click', function(e) {
  277. e.preventDefault();
  278. DateTimeShortcuts.drawPrev(num);
  279. });
  280. const cal_nav_next = quickElement('a', cal_nav, '>', 'href', '#');
  281. cal_nav_next.className = 'calendarnav-next';
  282. cal_nav_next.addEventListener('click', function(e) {
  283. e.preventDefault();
  284. DateTimeShortcuts.drawNext(num);
  285. });
  286. // main box
  287. const cal_main = quickElement('div', cal_box, '', 'id', DateTimeShortcuts.calendarDivName2 + num);
  288. cal_main.className = 'calendar';
  289. DateTimeShortcuts.calendars[num] = new Calendar(DateTimeShortcuts.calendarDivName2 + num, DateTimeShortcuts.handleCalendarCallback(num));
  290. DateTimeShortcuts.calendars[num].drawCurrent();
  291. // calendar shortcuts
  292. const shortcuts = quickElement('div', cal_box);
  293. shortcuts.className = 'calendar-shortcuts';
  294. let day_link = quickElement('a', shortcuts, gettext('Yesterday'), 'href', '#');
  295. day_link.addEventListener('click', function(e) {
  296. e.preventDefault();
  297. DateTimeShortcuts.handleCalendarQuickLink(num, -1);
  298. });
  299. shortcuts.appendChild(document.createTextNode('\u00A0|\u00A0'));
  300. day_link = quickElement('a', shortcuts, gettext('Today'), 'href', '#');
  301. day_link.addEventListener('click', function(e) {
  302. e.preventDefault();
  303. DateTimeShortcuts.handleCalendarQuickLink(num, 0);
  304. });
  305. shortcuts.appendChild(document.createTextNode('\u00A0|\u00A0'));
  306. day_link = quickElement('a', shortcuts, gettext('Tomorrow'), 'href', '#');
  307. day_link.addEventListener('click', function(e) {
  308. e.preventDefault();
  309. DateTimeShortcuts.handleCalendarQuickLink(num, +1);
  310. });
  311. // cancel bar
  312. const cancel_p = quickElement('p', cal_box);
  313. cancel_p.className = 'calendar-cancel';
  314. const cancel_link = quickElement('a', cancel_p, gettext('Cancel'), 'href', '#');
  315. cancel_link.addEventListener('click', function(e) {
  316. e.preventDefault();
  317. DateTimeShortcuts.dismissCalendar(num);
  318. });
  319. document.addEventListener('keyup', function(event) {
  320. if (event.which === 27) {
  321. // ESC key closes popup
  322. DateTimeShortcuts.dismissCalendar(num);
  323. event.preventDefault();
  324. }
  325. });
  326. },
  327. openCalendar: function(num) {
  328. const cal_box = document.getElementById(DateTimeShortcuts.calendarDivName1 + num);
  329. const cal_link = document.getElementById(DateTimeShortcuts.calendarLinkName + num);
  330. const inp = DateTimeShortcuts.calendarInputs[num];
  331. // Determine if the current value in the input has a valid date.
  332. // If so, draw the calendar with that date's year and month.
  333. if (inp.value) {
  334. const format = get_format('DATE_INPUT_FORMATS')[0];
  335. const selected = inp.value.strptime(format);
  336. const year = selected.getUTCFullYear();
  337. const month = selected.getUTCMonth() + 1;
  338. const re = /\d{4}/;
  339. if (re.test(year.toString()) && month >= 1 && month <= 12) {
  340. DateTimeShortcuts.calendars[num].drawDate(month, year, selected);
  341. }
  342. }
  343. // Recalculate the clockbox position
  344. // is it left-to-right or right-to-left layout ?
  345. if (window.getComputedStyle(document.body).direction !== 'rtl') {
  346. cal_box.style.left = findPosX(cal_link) + 17 + 'px';
  347. }
  348. else {
  349. // since style's width is in em, it'd be tough to calculate
  350. // px value of it. let's use an estimated px for now
  351. cal_box.style.left = findPosX(cal_link) - 180 + 'px';
  352. }
  353. cal_box.style.top = Math.max(0, findPosY(cal_link) - 75) + 'px';
  354. cal_box.style.display = 'block';
  355. document.addEventListener('click', DateTimeShortcuts.dismissCalendarFunc[num]);
  356. },
  357. dismissCalendar: function(num) {
  358. document.getElementById(DateTimeShortcuts.calendarDivName1 + num).style.display = 'none';
  359. document.removeEventListener('click', DateTimeShortcuts.dismissCalendarFunc[num]);
  360. },
  361. drawPrev: function(num) {
  362. DateTimeShortcuts.calendars[num].drawPreviousMonth();
  363. },
  364. drawNext: function(num) {
  365. DateTimeShortcuts.calendars[num].drawNextMonth();
  366. },
  367. handleCalendarCallback: function(num) {
  368. let format = get_format('DATE_INPUT_FORMATS')[0];
  369. // the format needs to be escaped a little
  370. format = format.replace('\\', '\\\\')
  371. .replace('\r', '\\r')
  372. .replace('\n', '\\n')
  373. .replace('\t', '\\t')
  374. .replace("'", "\\'");
  375. return function(y, m, d) {
  376. DateTimeShortcuts.calendarInputs[num].value = new Date(y, m - 1, d).strftime(format);
  377. DateTimeShortcuts.calendarInputs[num].focus();
  378. document.getElementById(DateTimeShortcuts.calendarDivName1 + num).style.display = 'none';
  379. };
  380. },
  381. handleCalendarQuickLink: function(num, offset) {
  382. const d = DateTimeShortcuts.now();
  383. d.setDate(d.getDate() + offset);
  384. DateTimeShortcuts.calendarInputs[num].value = d.strftime(get_format('DATE_INPUT_FORMATS')[0]);
  385. DateTimeShortcuts.calendarInputs[num].focus();
  386. DateTimeShortcuts.dismissCalendar(num);
  387. }
  388. };
  389. window.addEventListener('load', DateTimeShortcuts.init);
  390. window.DateTimeShortcuts = DateTimeShortcuts;
  391. }