feat(unitproc/bkt-replace_contractions):Add Bash function
[BK-2020-03.git] / user / bkdatev
CommitLineData
4143a6ea
SBS
1#!/usr/bin/env bash
2# Desc: Baltakatei's verbose date command
3# Usage: bkdatev [args]
4# Example: bkdatev --date="2001-09-11T09:02:59-04"
a1198d8e 5# Version: 1.0.0
79cb35dc 6# Depends: GNU Coreutils 8.32, Bash 3.2.57
4143a6ea
SBS
7# Ref/Attrib: [1] "ISO 8601". Wikipedia. https://en.wikipedia.org/wiki/ISO_8601
8# [2] "Changing the Locale in Wine" https://stackoverflow.com/a/16428951
9# [3] "Shanghai vs Beijing" https://bugs.launchpad.net/ubuntu/+source/libgweather/+bug/228554
10# Notes: * Check `ls -R /usr/share/zoneinfo` for time zone names.
11# * Check `cat /usr/share/i18n/SUPPORTED` for supported locales.
12# * For list of valid locales, see: https://manpages.ubuntu.com/manpages/bionic/man3/DateTime::Locale::Catalog.3pm.html
13# * Locations chosen for population, personal signifiance, and spatial coverage.
514ae735 14# * For International Atomic Time (TAI), use offsets from UTC provided in `/usr/share/zoneinfo/leap-seconds.list`.
79cb35dc
SBS
15# * Compatibility with macOS may be limited if any arguments
16# are provided when running `bkdatev`; e.g. passing a
17# `--date` option to `bkdatev` will fail.
4143a6ea 18
b29fc43b
SBS
19yell() { echo "$0: $*" >&2; }
20die() { yell "$*"; exit 111; }
21must() { "$@" || die "cannot $*"; }
22insertStr() {
23 # Desc: Inserts a string into another string at a specified position.
24 # Input: arg1: str str_rec String to receive insertion
25 # arg2: int pos Insertion position (0 = append to front)
26 # arg3: str str_ins String to be inserted
27 # Output: stdout: Combined string
28 # Version: 0.0.2
29 # Depends: BK-2020-03: yell(), die(), must()
30 # Ref/Attrib: * BK-2020-03: https://gitlab.com/baltakatei/baltakatei-exdev/
31 # * Cooper, Mendel. “Advanced Bash-Scripting Guide: Manipulating Strings”. tldp.org https://tldp.org/LDP/abs/html/string-manipulation.html
32
33 local str_rec pos str_ins re len_str_rec;
34 local pfx_pos_start pfx_len pfx;
35 local sfx_pos_start sfx_len sfx;
36
37 # Check args
38 if [[ $# -ne 3 ]]; then
39 yell "ERROR:Invalid argument count:$#";
40 return 1; fi;
41 re='^[0-9]+$';
42 if [[ ! "$2" =~ $re ]]; then
43 yell "ERROR:Not an int:$2";
44 return 1; fi;
45 str_rec="$1";
46 pos="$2";
47 str_ins="$3";
48
49 # Calculate string stats
50 len_str_rec="${#str_rec}";
51
52 # Form prefix
53 pfx_pos_start="0";
54 pfx_len="$pos";
55 pfx="${str_rec:$pfx_pos_start:$pfx_len}";
56
57 # Form suffix
58 sfx_pos_start="$(( pos ))";
59 sfx_len="$(( len_str_rec - pos ))";
60 sfx="${str_rec:$sfx_pos_start:$sfx_len}";
61
62 # Print output to stdout
63 printf "%s%s%s\n" "$pfx" "$str_ins" "$sfx";
64}; # Insert string provided at indicated position via stdout
4143a6ea
SBS
65line_sep() {
66 # Input: var: n_ln
67 local skip_every=4;
68 ((n_ln++));
69 if ! ((n_ln % "$skip_every")); then
70 printf "\n";
71 fi;
72 return 0;
73}; # periodically print separating blank line
b29fc43b
SBS
74get_tz_offset() {
75 # Desc: Get from 'date' the timezone UTC offset in a way
76 # compatible with both GNU Coreutils and BSD versions.
77 # Input: env var: TZ (time zone for date; e.g. 'America/Denver')
047dfcb9 78 # args: $@ # passed onto `date`
b29fc43b
SBS
79 # Depends: date (GNU Coreutils 8.32 or BSD), rev
80 local ntz ntz ntz_out;
81 local last2;
82
83 # Get numeric time zone string in way compatible with GNU Coreutils and BSD
047dfcb9 84 ntz="$(date "+%z" "$@")"; # e.g. "+0530"
b29fc43b
SBS
85
86 # Check if last two characters are trailing zeros that can be removed.
87 last2="${ntz:3:2}"; # assumes $ntz is 5 characters (i.e. "±HHMM")
88 #last2="$(rev <<< $ntz)" && last2="${last2:0:2}" && last2="$(rev <<< "$last2")";
89 if [[ "$last2" == "00" ]]; then
90 ## ntz_out is truncated by 2 characters
be603b6f
SBS
91 len_ntz="${#ntz}";
92 len_ntz_out="$(( len_ntz - 2 ))";
93 ntz_out=""${ntz:0:$len_ntz_out};
b29fc43b
SBS
94 else
95 ## ntz_out is ntz with semicolon inserted after HH
96 ntz_out="$(insertStr "$ntz" 3 ":" )";
97 fi;
98
99 # Output via stdout
100 printf "%s" "$ntz_out";
101}; # Format numeric time zone (for BSD date compatibility)
4143a6ea
SBS
102print_dateline() {
103 # Input: var: $id
104 # var: $fs_1
105 # var: $fs_2
106 # var: $fs_3
047dfcb9 107 # args: $@ # passed on to `date`
b29fc43b 108 # env var: TZ (time zone for date; e.g. 'America/Denver')
4143a6ea
SBS
109 # Output: stdout
110 # Depends: printf, date
b29fc43b 111 # get_tz_offset()
4143a6ea 112 # Ref/Attrib: * Truncate string in printf https://stackoverflow.com/a/46812677
b29fc43b 113 local s_1 s_2 s_2_tz s_3 s_4;
4143a6ea
SBS
114
115 s_1="$id";
b29fc43b
SBS
116 s_2="$(date "$@" "$fs_1")"; # ISO-8601 without numeric timezone
117 s_3="$(date "$@" "$fs_2")"; # Alternate ISO-8601 expressions
118 s_4="$(date "$@" "$fs_3")"; # locale-specific date strings
047dfcb9 119
b29fc43b
SBS
120 # Append numeric timezone to $s_2 with appropriate format
121 # (e.g. '-07' for 'Arizona', '+05:45' for 'Asia/Kathmandu')
047dfcb9 122 s_2_tz="$(get_tz_offset "$@")";
b29fc43b 123 s_2="$( printf "%s%s" "$s_2" "$s_2_tz" )";
4143a6ea
SBS
124
125 printf "%-10.10s %-25.25s (%-20.20s) (%s)" "$s_1" "$s_2" "$s_3" "$s_4";
126 printf "\n";
127
128 unset fs_1 fs_2 fs_3 fs_4;
129 }; # print line of dates
130main() {
131 n_ln=0; # for line_sep()
06ff9ce1 132 unset LC_TIME; # Fall back to time zone-specific locale settings.
4143a6ea
SBS
133
134 # format strings
b29fc43b 135 fs_iso8601="+%Y-%m-%dT%H:%M:%S"; # typical ISO-8601 without timezone
4143a6ea
SBS
136 fs_iso8601_etc="+%G-W%V-%u, %Y-%j"; # alternate ISO-8601 dates
137 fs_locale="+%Z; %A; %c"; # locale-specific date strings
138
139 # vars for print_dateline()
140 fs_1="$fs_iso8601";
141 fs_2="$fs_iso8601_etc";
142 fs_3="$fs_locale";
143
144 # UTC (pop. (2021): 7,837,000,000)
145 (
146 export TZ=UTC;
147 id="UTC";
e202e295 148 fs_3="+%s seconds since 1970-01-01T00:00+00";
4143a6ea
SBS
149 print_dateline "$@";
150 ); line_sep;
151
152 # Hawaii
153 (
154 export TZ=US/Hawaii;
155 export LANG="haw-US.UTF8";
156 id="HAWAII";
157 print_dateline "$@";
158 ); line_sep;
159
160 # Los Angeles, USA
161 (
162 export TZ=America/Los_Angeles;
163 export LANG="en_US.UTF-8";
164 id="LOS ANGELES";
165 print_dateline "$@";
166 ); line_sep;
167
168 # Denver, USA (pop. (2021): 711,463)
169 (
170 export TZ=America/Denver;
171 export LANG="en_US.UTF-8";
172 id="DENVER";
173 print_dateline "$@";
174 ); line_sep;
175
176 # Chicago, USA (pop. (2021): 711,463)
177 (
178 export TZ=America/Chicago;
179 export LANG="en_US.UTF-8";
180 id="CHICAGO";
181 print_dateline "$@";
182 ); line_sep;
183
184 # Mexico City, Mexico (pop. (2018): 21,804,515)
185 (
186 export TZ=America/Mexico_City;
187 export LANG="es_MX.UTF8";
188 id="MEXICO CITY";
189 print_dateline "$@";
190 ); line_sep;
191
192 # Panama City, Panama
193 (
194 export TZ=America/Panama;
195 export LANG="es_PA.UTF8";
196 id="PANAMA CITY";
197 print_dateline "$@";
198 ); line_sep;
199
200 # New York, USA (pop. (2018): 20,140,470)
201 (
202 export TZ=America/New_York;
203 export LANG="en_US.UTF-8";
204 id="NEW YORK";
205 print_dateline "$@";
206 ); line_sep;
207
208 # São Paulo, Brazil
209 (
210 export TZ=America/Sao_Paulo;
211 export LANG="pt_BR.UTF8";
212 id="SAO PAULO";
213 print_dateline "$@";
214 ); line_sep;
215
216 # Buenos Aires
217 (
218 export TZ=America/Argentina/Buenos_Aires;
219 export LANG="es_AR.UTF8";
220 id="BUENOS AIRES";
221 print_dateline "$@";
222 ); line_sep;
223
224 # London, England
225 (
226 export TZ=Europe/London;
227 export LANG="en_GB.UTF-8";
228 id="LONDON";
229 print_dateline "$@";
230 ); line_sep;
231
232 # Kinshasa, Africa
233 (
234 export TZ=Africa/Kinshasa;
235 export LANG="ln_CD.UTF8";
236 id="KINSHASA";
237 print_dateline "$@";
238 ); line_sep;
239
240 # Lagos, Africa
241 (
242 export TZ=Africa/Lagos;
243 export LANG="en_NG.UTF8";
244 id="LAGOS";
245 print_dateline "$@";
246 ); line_sep;
247
248 # Paris, France
249 (
250 export TZ=Europe/Paris;
251 export LANG="fr_FR.UTF8";
252 id="PARIS";
253 print_dateline "$@";
254 ); line_sep;
255
256 # Stockholm, Sweden
257 (
258 export TZ=Europe/Stockholm;
259 export LANG="sv_SE.UTF8";
260 id="STOCKHOLM";
261 print_dateline "$@";
262 ); line_sep;
263
21933f0c
SBS
264 # Helsinki, Finland
265 (
266 export TZ=Europe/Helsinki;
267 export LANG="fi_FI.UTF8";
268 id="HELSINKI";
269 print_dateline "$@";
270 ); line_sep;
271
4143a6ea
SBS
272 # Cairo, Egypt
273 (
274 export TZ=Africa/Cairo;
275 export LANG="ar_EG.UTF8";
276 id="CAIRO";
277 print_dateline "$@";
278 ); line_sep;
279
a1198d8e
SBS
280 # Gaza City, Palestine (pop. (2017): 590,481)
281 (
282 export TZ=Asia/Gaza;
283 export LANG="ar_JO.UTF-8"; # ar_PS is missing as of 2023-10-18, using ar_JO as closest substitute.
284 id="GAZA";
285 print_dateline "$@";
286 ); line_sep;
287
288 # Tel Aviv, Israel (pop. (2021): 467,875)
289 (
290 export TZ=Asia/Tel_Aviv;
291 export LANG="he_IL.UTF-8";
292 id="TEL AVIV";
293 print_dateline "$@";
294 ); line_sep;
295
4143a6ea
SBS
296 # Athens (pop. (2020): 3,526,887)
297 (
298 export TZ=Europe/Athens;
299 export LANG="el_GR.UTF8";
300 id="ATHENS";
301 print_dateline "$@";
302 ); line_sep;
303
304 # Istanbul (pop. (2020): 13,719,061)
305 (
306 export TZ=Asia/Istanbul;
307 export LANG="tr_TR.UTF8";
308 id="ISTANBUL";
309 print_dateline "$@";
310 ); line_sep;
311
312 # Tehran, Iran
313 (
314 export TZ=Asia/Tehran;
315 export LANG="fa_IR.UTF8";
316 id="TEHRAN";
317 print_dateline "$@";
318 ); line_sep;
319
320 # Moscow, Russia
321 (
322 export TZ=Europe/Moscow;
323 export LANG="ru_RU.UTF-8";
324 id="MOSCOW";
325 print_dateline "$@";
326 ); line_sep;
327
328 # Kyiv, Ukraine (pop. (2021): 2,962,180)
329 (
330 export TZ=Europe/Kyiv;
331 export LANG="uk_UA.UTF-8";
332 id="KYIV";
333 print_dateline "$@";
334 ); line_sep;
335
336 # Delhi, India (pop. (2018): 29,000,000)
337 (
338 export TZ=Asia/Kolkata;
339 export LANG="hi_IN.UTF-8";
340 id="DELHI";
341 print_dateline "$@";
342 ); line_sep;
343
344 # Jakarta, Indonesia (pop. (2018): 33,430,285)
345 (
346 export TZ=Asia/Jakarta;
347 export LANG="id_ID.UTF8";
348 id="JAKARTA";
349 print_dateline "$@";
350 ); line_sep;
351
352 # Singapore, Singapore (pop (2018): 5,792,000)
353 (
354 export TZ=Asia/Singapore;
355 export LANG="en_SG.UTF-8";
356 id="SINGAPORE";
357 print_dateline "$@";
358 ); line_sep;
359
360 # Beijing, China (pop. (2018): 19,618,000)
361 (
362 export TZ=Asia/Shanghai; # [3]
363 export LANG="zh_CN.UTF-8";
364 id="BEIJING";
365 print_dateline "$@";
366 ); line_sep;
367
20857531
SBS
368 # Taipei, Taiwan (pop (2019): 7,034,084)
369 (
370 export TZ=Asia/Taipei; # [3]
371 export LANG="zh_TW.UTF-8";
372 id="TAIPEI";
373 print_dateline "$@";
374 ); line_sep;
375
4143a6ea
SBS
376 # Tokyo, Japan (pop. (2018): 37,274,000)
377 (
378 export TZ=Asia/Tokyo;
379 export LANG="ja_JP.UTF8";
380 id="TOKYO";
381 print_dateline "$@";
382 ); line_sep;
383
384 # Seoul, South Korea (pop. (2018): 25,514,000)
385 (
386 export TZ=Asia/Seoul;
387 export LANG="ko_KR.UTF8";
388 id="SEOUL";
389 print_dateline "$@";
390 ); line_sep;
391
20857531
SBS
392 # Pyongyang, North Korea
393 (
394 export TZ=Asia/Pyongyang;
395 export LANG="ko_KP.UTF8";
396 id="PYONGYANG";
397 print_dateline "$@";
398 ); line_sep;
399
4143a6ea
SBS
400 # Sydney, Australia
401 (
402 export TZ=Australia/Sydney;
403 export LANG="en_AU.UTF8";
404 id="SYDNEY";
405 print_dateline "$@";
406 ); line_sep;
407
408 # Guam
409 (
410 export TZ=Pacific/Guam;
411 export LANG="en_GU.UTF8";
412 id="GUAM";
413 print_dateline "$@";
414 ); line_sep;
415
416 # Auckland, New Zealand
417 (
418 export TZ=Pacific/Auckland;
419 export LANG="en_NZ.UTF8";
420 id="AUCKLAND";
421 print_dateline "$@";
422 ); line_sep;
423
424 return 0;
425}; # main program
426
427main "$@";
b29fc43b
SBS
428
429# Author: Steven Baltakatei Sandoval
430# License: GPLv3+