-
Notifications
You must be signed in to change notification settings - Fork 5
/
Code.gs
1236 lines (885 loc) · 43.7 KB
/
Code.gs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* ***********************************************************************************
*
* Bible linker for Google Docs
*
* A Google Documents Apps Script that searches for Bible verses and creates links to
* a selection of online Bible sources.
*
* For more information, visit: https://github.com/majal/bible-linker-google-docs
*
* v2.0.0-beta-2.0.3
*
*********************************************************************************** */
/**
* @OnlyCurrentDoc
*/
////////////////////////////////////////////////////////////
// Global variables and function, needed for dynamic menu //
////////////////////////////////////////////////////////////
var testing = false;
const BIBLE_DATA_SOURCES = {
"default": "en_jw",
"en_jw": {
"displayName": "English (JW.org)",
"url": [
"https://raw.githubusercontent.com/majal/bible-linker-google-docs/main/bible-data/en_jw.json",
"https://pastebin.com/raw/0W8738GK"
],
"bibleVersions": [
"en_jw_nwt",
"en_jw_nwt_wol",
"en_jw_nwtsty",
"en_jw_nwtsty_wol",
"en_jw_nwtrbi8",
"en_jw_nwtrbi8_wol",
"en_jw_kjv",
"en_jw_kjv_wol",
"en_jw_by",
"en_jw_by_wol",
"en_jw_asv",
"en_jw_asv_wol",
"en_jw_ebr",
"en_jw_ebr_wol",
"en_jw_int",
"en_jw_int_wol"
],
"strings": {
"activate": {
"appTitle": "Bible Linker",
"activationItem": "Activate Bible Linker",
"activationTitle": "Bible Linker Enabled",
"activationMsg": "You may now use Bible Linker. Please navigate again to the menu to use it."
},
"errors": {
"nullBibleData": {
"title": "Bible data is no longer available",
"message": "Bible Linker will run using the default Bible data instead."
},
"downloadJSON": {
"title": "Failed to get data source",
"messageBeforeSingular": "There was a problem fetching the following data source:\n\n",
"messageAfterSingular": "\n\nIs the link accessible? Has the JSON been linted for errors?",
"messageBeforePlural": "There were problems fetching the following data sources:\n\n",
"messageAfterPlural": "\n\nAre the link accessible? Has the JSON files been linted for errors?"
}
}
}
},
"es_jw": {
"displayName": "Español (JW.org)",
"url": [
"https://raw.githubusercontent.com/majal/bible-linker-google-docs/main/bible-data/es_jw.json",
"https://pastebin.com/raw/3GjkEhdB"
],
"bibleVersions": [
"es_jw_nwt",
"es_jw_nwt_wol",
"es_jw_nwtsty",
"es_jw_nwtsty_wol",
"es_jw_nwtrbi8",
"es_jw_nwtrbi8_wol"
],
"strings": {
"activate": {
"appTitle": "Bible Linker",
"activationItem": "Activate Bible Linker",
"activationTitle": "Bible Linker Enabled",
"activationMsg": "You may now use Bible Linker. Please navigate again to the menu to use it."
},
"errors": {
"nullBibleData": {
"title": "Bible data is no longer available",
"message": "Bible Linker will run using the default Bible data instead."
},
"downloadJSON": {
"title": "Failed to get data source",
"messageBeforeSingular": "There was a problem fetching the following data source:\n\n",
"messageAfterSingular": "\n\nIs the link accessible? Has the JSON been linted for errors?",
"messageBeforePlural": "There were problems fetching the following data sources:\n\n",
"messageAfterPlural": "\n\nAre the link accessible? Has the JSON files been linted for errors?"
}
}
}
},
"custom": {
"displayName": "Custom data source",
"strings": {
"activate": {
"appTitle": "Bible Linker",
"activationItem": "Activate Bible Linker",
"activationTitle": "Bible Linker Enabled",
"activationMsg": "You may now use Bible Linker. Please navigate again to the menu to use it."
},
"errors": {
"nullBibleData": {
"title": "Custom Bible data is no longer available",
"message": "Bible Linker will run using the default Bible data instead."
},
"downloadJSON": {
"title": "Failed to get data source",
"messageBeforeSingular": "There was a problem fetching the following data source:\n\n",
"messageAfterSingular": "\n\nIs the link accessible? Has the JSON been linted for errors?",
"messageBeforePlural": "There were problems fetching the following data sources:\n\n",
"messageAfterPlural": "\n\nAre the link accessible? Has the JSON files been linted for errors?"
}
}
}
}
};
const dynamicFunctionVersion = 'dfv_';
const dynamicFunctionSource = 'dfs_';
var dynamicMenuGenerateDone = false;
//////////////////
// Dynamic menu //
//////////////////
dynamicMenuGenerate();
function dynamicMenuGenerate() {
dynamicMenuGenerateDone = false;
let bibleDataSource, bibleVersions;
// Try-catch to check if PropertiesService is available
// If ScriptApp.AuthMode is FULL
try {
const userProperties = PropertiesService.getUserProperties();
bibleDataSource = userProperties.getProperty('bibleDataSource');
bibleVersions = userProperties.getProperty('bibleVersions');
// Error mitigation in case JSON from PropertiesService is malformed
try {
bibleVersions = JSON.parse(bibleVersions);
} catch {
bibleVersions = BIBLE_DATA_SOURCES[BIBLE_DATA_SOURCES.default].bibleVersions;
userProperties.setProperty('bibleVersions', bibleVersions);
};
// Error mitigation in case bibleVersions is falsy
if ( ! bibleVersions ) {
bibleVersions = BIBLE_DATA_SOURCES[BIBLE_DATA_SOURCES.default].bibleVersions;
userProperties.setProperty('bibleVersions', bibleVersions);
};
// If ScriptApp.AuthMode is NONE or LIMITED
} catch {
bibleDataSource = BIBLE_DATA_SOURCES.default;
bibleVersions = BIBLE_DATA_SOURCES[BIBLE_DATA_SOURCES.default].bibleVersions;
};
// Debugging
// Logger.log('dynamicMenuGenerate().bibleDataSource: ' + bibleDataSource);
// Logger.log('dynamicMenuGenerate().bibleVersions: ' + bibleVersions);
// Generate bibleVersion function names for the dynamic menu
for ( let i = 0; i < bibleVersions.length; i++ ) {
var dynamicMenuBibleVersion = dynamicFunctionVersion + bibleDataSource + '_' + bibleVersions[i];
this[dynamicMenuBibleVersion] = function() { bibleLinker(bibleDataSource, bibleVersions[i]); };
};
// Generate bibleDataSource function names for the dynamic menu
for ( let dsk of Object.keys(BIBLE_DATA_SOURCES) ) {
if ( dsk == 'default' ) continue;
var dynamicMenuBibleDataSource = dynamicFunctionSource + dsk;
this[dynamicMenuBibleDataSource] = function() { chooseDataSource(dsk); };
};
dynamicMenuGenerateDone = true;
}; // END: dynamicMenuGenerate()
//////////
// Main //
//////////
function createMenu() {
// Wait for dynamicMenuGenerate() to complete
while ( ! dynamicMenuGenerateDone ) Utilities.sleep(5);
// Get user's last used bibleDataSource and bibleVersion
const userProperties = PropertiesService.getUserProperties();
let bibleDataSource = userProperties.getProperty('bibleDataSource');
let bibleDataSourceInit = bibleDataSource;
let bibleVersion = userProperties.getProperty('bibleVersion');
// If there is no bibleDataSource
// or bibleDataSource not included in current list (keys)
// then set to default value
if ( ! bibleDataSource
|| ! Object.keys(BIBLE_DATA_SOURCES).includes(bibleDataSource) ) {
bibleDataSource = BIBLE_DATA_SOURCES.default;
};
// Fetch bibleData from external source, if bibleData is null reset to default
let bibleData = bibleDataSource == 'custom' ? getBibleDataCustom() : getBibleData(BIBLE_DATA_SOURCES[bibleDataSource].url, bibleDataSource);
// Access Docs UI
var ui = DocumentApp.getUi();
// Check if bibleData is still valid
if ( ! bibleData ) {
ui.alert(BIBLE_DATA_SOURCES[bibleDataSource].strings.errors.nullBibleData.title, BIBLE_DATA_SOURCES[bibleDataSource].strings.errors.nullBibleData.message, ui.ButtonSet.OK);
bibleDataSource = BIBLE_DATA_SOURCES.default;
bibleData = getBibleData(BIBLE_DATA_SOURCES[bibleDataSource].url, bibleDataSource);
};
// Set bibleVersion to default if not found in Bible data
if ( ! Object.keys(bibleData.bibleVersions).includes(bibleVersion) ) bibleVersion = bibleData.bibleVersions.default;
// Load bibleVersions into array, except 'default'
let bibleVersions = [];
for ( let bvk of Object.keys(bibleData.bibleVersions) ) {
if ( bvk == 'default' ) continue;
// Add key to end of array
bibleVersions.splice(bibleVersions.length, 0, bvk);
};
userProperties.setProperty('bibleVersions', JSON.stringify(bibleVersions));
// Re-run dynamicMenuGenerate() before setting menu entries, in case bibleDataSource changed
if ( bibleDataSourceInit != bibleDataSource ) dynamicMenuGenerate();
// Wait for dynamicMenuGenerate() to complete
while ( ! dynamicMenuGenerateDone ) Utilities.sleep(5);
// Get needed strings and values
let displayName = bibleData.bibleVersions[bibleVersion].displayName;
let selectorSelected = bibleData.strings.menu.selector.selected;
let selectorUnselected = bibleData.strings.menu.selector.unselected;
let lengthLimit = bibleData.strings.menu.lengthLimit;
let customLabel = bibleData.strings.menu.customLabel;
// Add Bible Linker to Docs menu
let menu = testing ?
ui.createMenu('Test: Bible Linker').addItem( bibleData.strings.menu.doLink + ' ' + displayName, dynamicFunctionVersion + bibleDataSource + '_' + bibleVersion ).addSeparator()
:
ui.createAddonMenu().addItem( bibleData.strings.menu.doLink + ' ' + displayName, dynamicFunctionVersion + bibleDataSource + '_' + bibleVersion ).addSeparator();
// let menu = ui.createAddonMenu().addItem( bibleData.strings.menu.doLink + ' ' + displayName, dynamicFunctionVersion + bibleDataSource + '_' + bibleVersion ).addSeparator();
// let menu = ui.createMenu('Test: Bible Linker').addItem( bibleData.strings.menu.doLink + ' ' + displayName, dynamicFunctionVersion + bibleDataSource + '_' + bibleVersion ).addSeparator(); // For testing
// Set bibleVersions submenu
let menuChooseBibleVersion = ui.createMenu(bibleData.strings.menu.chooseBibleVersion);
// Load dynamic values to bibleVersions submenu
for ( let bibleVersionDynamic of Object.keys(bibleData.bibleVersions) ) {
if ( bibleVersionDynamic == 'default' ) continue;
let bibleVersionDisplayName = bibleData.bibleVersions[bibleVersionDynamic].displayName;
// If bibleVersionDisplayName is over lengthLimit, truncate and add ellipsis …
bibleVersionDisplayName = bibleVersionDisplayName.length > lengthLimit ? bibleVersionDisplayName.substring(0, lengthLimit) + '\u00a0…' : bibleVersionDisplayName;
// Generate function names for dynamic submenu
dynamicMenuBibleVersions = dynamicFunctionVersion + bibleDataSource + '_' + bibleVersionDynamic;
// Add pointer at the beginning of the selected menu item
let pointer = bibleVersion == bibleVersionDynamic ? selectorSelected : selectorUnselected;
// Add menu item
menuChooseBibleVersion.addItem(pointer + bibleVersionDisplayName, dynamicMenuBibleVersions);
};
// Set bibleDataSource submenu
var menuChooseBibleDataSource = ui.createMenu(bibleData.strings.menu.chooseDataSource);
// Load dynamic values to bibleDataSources submenu
for ( let bibleDataSourceDynamic of Object.keys(BIBLE_DATA_SOURCES) ) {
if ( bibleDataSourceDynamic == 'default' ) continue;
let bibleDataSourceDisplayName = BIBLE_DATA_SOURCES[bibleDataSourceDynamic].displayName;
// Only show custom data source if actually present
if ( bibleDataSourceDynamic == 'custom' ) {
let customBibleData = userProperties.getProperty('customBibleData');
if ( ! customBibleData ) continue;
bibleDataSourceDisplayName = customLabel ? customLabel + customBibleData : customBibleData;
};
// If bibleDataSourceDisplayName is over lengthLimit, truncate and add ellipsis …
bibleDataSourceDisplayName = bibleDataSourceDisplayName.length > lengthLimit ? bibleDataSourceDisplayName.substring(0, lengthLimit) + '\u00a0…' : bibleDataSourceDisplayName;
// Generate function names for dynamic submenu
dynamicMenuBibleDataSource = dynamicFunctionSource + bibleDataSourceDynamic;
// Add pointer at the beginning of the selected menu item
let pointer = bibleDataSource == bibleDataSourceDynamic ? selectorSelected : selectorUnselected;
// Add menu item
menuChooseBibleDataSource.addItem(pointer + bibleDataSourceDisplayName, dynamicMenuBibleDataSource);
};
// Add submenu item to set custom data source
menuChooseBibleDataSource
.addSeparator()
.addItem(bibleData.strings.menu.customDataSource, 'setCustomDataSource');
// Get studyToolsDisplayName
let studyToolsDisplayName = bibleData.html.studyTools.displayName;
// Create menu
menu
.addSubMenu(menuChooseBibleVersion)
.addSubMenu(menuChooseBibleDataSource)
.addSeparator()
.addItem(studyToolsDisplayName, 'studyTools')
.addToUi();
}; // END: function createMenu()
////////////////////
// Core functions //
////////////////////
function bibleLinker(bibleDataSource, bibleVersion) {
// If there is no bibleDataSource
// or bibleDataSource not included in current list (keys)
// then set to default value
if ( ! bibleDataSource
|| ! Object.keys(BIBLE_DATA_SOURCES).includes(bibleDataSource) ) {
bibleDataSource = BIBLE_DATA_SOURCES.default;
};
// Fetch bibleData from external source, throw error if bibleData is null
let bibleData = bibleDataSource == 'custom' ? getBibleDataCustom() : getBibleData(BIBLE_DATA_SOURCES[bibleDataSource].url, bibleDataSource);
// Access Docs UI
var ui = DocumentApp.getUi();
// Check if bibleData is still valid
if ( ! bibleData ) {
ui.alert(BIBLE_DATA_SOURCES[bibleDataSource].strings.errors.nullBibleData.title, BIBLE_DATA_SOURCES[bibleDataSource].strings.errors.nullBibleData.message, ui.ButtonSet.OK);
bibleDataSource = BIBLE_DATA_SOURCES.default;
bibleData = getBibleData(BIBLE_DATA_SOURCES[bibleDataSource].url, bibleDataSource);
};
// Set bibleVersion to default if not found in Bible data
if ( ! Object.keys(bibleData.bibleVersions).includes(bibleVersion) ) bibleVersion = bibleData.bibleVersions.default;
// Load bibleVersions into array, except 'default'
let bibleVersions = [];
for ( let bvk of Object.keys(bibleData.bibleVersions) ) {
if ( bvk == 'default' ) continue;
// Add key to end of array
bibleVersions.splice(bibleVersions.length, 0, bvk);
};
// Save last used values to user preferences
const userProperties = PropertiesService.getUserProperties();
userProperties.setProperty('bibleDataSource', bibleDataSource);
userProperties.setProperty('bibleVersion', bibleVersion);
userProperties.setProperty('bibleVersions', JSON.stringify(bibleVersions));
// Initialize Google Document
var doc = DocumentApp.getActiveDocument();
// Note if document has active selection
var docSelection = doc.getSelection();
// Get single-chapter Bible books
var bookSingleChapters = bibleData.bookSingleChapters;
// Get search RegExes
var searchRegexMultiChapters = bibleData.regEx.search.multiChapters;
var searchRegexSingleChapters = bibleData.regEx.search.singleChapters;
// Get whitespace RegEx, set to default if null
var ws = bibleData.regEx.whitespace;
// Get error messages
var errorMsgParserTitle = bibleData.strings.errorMessages.parserError.title;
var errorMsgParserBefore = bibleData.strings.errorMessages.parserError.messageBefore;
var errorMsgParserAfter = bibleData.strings.errorMessages.parserError.messageAfter;
//Initialize variables to use in loops
var bookNum, bookName, searchRegex;
// Expand bookNames with spaces to RegEx whitespaces
for (bookName of Object.values(bibleData.bookNames)) {
// Get initial length as it will change later with the additions (splice)
let bookNameLengthInit = bookName.length;
for ( let i=0; i < bookNameLengthInit; i++ ) {
if ( bookName[i].includes(' ') ) {
let nbspName = bookName[i].replace(/ /g, ws);
// Replace only if next name is different than previous name
if ( nbspName != bookName[bookName.length-1] ) bookName.splice(bookName.length, 0, nbspName);
};
};
};
// Get book numbers, process each
for (bookNum of Object.keys(bibleData.bookNames)) {
// If bookNum is string (which likely is...), convert to integer
if ( typeof bookNum != 'number' ) bookNum = parseInt(bookNum, 10);
// If bibleVersion has booksExclude, skip
let booksExclude = bibleData.bibleVersions[bibleVersion].booksExclude;
if ( booksExclude && booksExclude.includes(bookNum) ) continue;
// Get book names, process each
for (bookName of Object.values(bibleData.bookNames[bookNum])) {
// Modify RegEx format if it is a single-chapter book
if ( bookSingleChapters.includes(bookNum) ) {
searchRegex = bookName + ws + searchRegexSingleChapters;
} else {
searchRegex = bookName + ws + searchRegexMultiChapters;
};
///////////////////////////////////////////////////////////////////////////
// For each bookName, each selection or whole document, perform a search //
///////////////////////////////////////////////////////////////////////////
// Initialize variables
var searchElement, searchResult, searchResultTextSlice;
// Search only selected text if present
if (docSelection) {
var rangeElements = docSelection.getRangeElements();
// Search within each selection element and pass results to parser
for (let n=0; n < rangeElements.length; n++) {
searchElement = rangeElements[n].getElement();
searchResult = searchElement.findText(searchRegex);
// Note if selection is only a part of the element (single line)
let searchElementStart = rangeElements[n].getStartOffset();
let searchElementEnd = rangeElements[n].getEndOffsetInclusive();
// Send found matches to parser
try {
// If whole line is selected start and end will be -1
// https://developers.google.com/apps-script/reference/document/range-element#getendoffsetinclusive
if (searchElementStart == -1 && searchElementEnd == -1) {
bibleParse(bibleData, bibleVersion, bookNum, searchResult, searchElement, searchRegex);
} else {
bibleParse(bibleData, bibleVersion, bookNum, searchResult, searchElement, searchRegex, searchElementStart, searchElementEnd);
};
} catch {
// Show text where search error occurred, ask to submit error report
searchResultTextSlice = searchResult.getElement().asText().getText().slice(searchResult.getStartOffset(), searchResult.getEndOffsetInclusive() + 1);
ui.alert(errorMsgParserTitle, errorMsgParserBefore + searchResultTextSlice + errorMsgParserAfter, ui.ButtonSet.OK);
};
};
// Perform search on whole document
} else {
searchElement = doc.getBody();
searchResult = searchElement.findText(searchRegex);
// Send found matches to parser
try {
bibleParse(bibleData, bibleVersion, bookNum, searchResult, searchElement, searchRegex);
} catch {
// Show text where search error occurred, ask to submit error report
searchResultTextSlice = searchResult.getElement().asText().getText().slice(searchResult.getStartOffset(), searchResult.getEndOffsetInclusive() + 1);
ui.alert(errorMsgParserTitle, errorMsgParserBefore + searchResultTextSlice + errorMsgParserAfter, ui.ButtonSet.OK);
};
}; // END: For each bookName, each selection or whole document, perform a search
}; // END: Get book names, process each
}; // END: Get book numbers, process each
// Receate menu
createMenu();
}; // END: function bibleLinker(bibleDataSource, bibleVersion)
function bibleParse(bibleData, bibleVersion, bookNum, searchResult, searchElement, searchRegex, searchElementStart, searchElementEnd) {
// Get whitespace RegEx, set to default if null
var ws = bibleData.regEx.whitespace;
// Variable(s) and constant(s)
var bookSingleChapters = bibleData.bookSingleChapters;
// Cycle through each Bible reference found
while (searchResult != null) {
// Get reference start and end offsets
let searchResultStart = searchResult.getStartOffset();
let searchResultEnd = searchResult.getEndOffsetInclusive();
// Isolate reference text
let searchResultAstext = searchResult.getElement().asText();
let searchResultText = searchResultAstext.getText();
let searchResultTextSlice = searchResultText.slice(searchResultStart, searchResultEnd + 1);
//////////////////////////////////////////////////////////////////
// Split Bible references into linkable parts: referenceSplits, //
// saved as arrays within an array for individual processing //
//////////////////////////////////////////////////////////////////
// Split to arrays for every semicolon then save to splitsSemicolon
let splitsSemicolon = searchResultTextSlice.split(';');
// Add back the removed semicolon(s), all array values except the last one
for ( let i=0; i < splitsSemicolon.length-1; i++ ) {
splitsSemicolon[i] += ';';
};
let referenceSplits = [];
// For every splitsSemicolon generated ...
for ( let i=0; i < splitsSemicolon.length; i++ ) {
// Split to arrays within array for every comma, then save to referenceSplits
referenceSplits.push(splitsSemicolon[i].split(','));
// If comma split(s) occured ...
if ( referenceSplits[i].length > 1 ) {
// For rejoining consecutive verses: run for all split array values except the last one
for ( let j=0; j < referenceSplits[i].length-1; j++ ) {
// If verses separated by commas are consecutive, join together as one reference
let verseNow = parseInt(referenceSplits[i][j].match(/\d+$/g)[0], 10);
let verseNext = parseInt(referenceSplits[i][j+1].match(/\d+;*$/g)[0].replace(';', ''), 10);
if ( verseNow + 1 == verseNext ) {
referenceSplits[i][j] += ',' + referenceSplits[i][j+1];
referenceSplits[i].splice(j+1, 1);
};
// Add back the removed comma(s) if next array exist, except for the last array value
// Conditional IF added due to the splice above which pulled the last array value
if (referenceSplits[i][j+1]) referenceSplits[i][j] += ',';
};
};
};
/////////////////////////////////////////////////////////////////////
// Generate variables for the linker: //
// chapterStart, verseStart, verseEnd, chapterEnd, referenceStart, //
// and referenceEnd for every referenceSplit to pass on to linker //
/////////////////////////////////////////////////////////////////////
let referenceStart = searchResultStart, referenceEnd;
let chapterStart, verseStart, verseEnd, chapterEnd;
// Get chapters in each referenceSplits
for ( let i=0; i < referenceSplits.length; i++ ) {
// Chapter is always 1 for single-chapter Bible books
if ( bookSingleChapters.includes(bookNum) ) {
chapterStart = chapterEnd = 1;
// For multi-chapter books, which is the usual case
} else {
// Get chapter End and Start
let chapters = referenceSplits[i][0].match(/\d+:/g);
if ( chapters.length == 1 ) {
chapterStart = chapterEnd = parseInt(chapters[0].replace(':', ''), 10);
} else {
chapterStart = parseInt(chapters[0].replace(':', ''), 10);
chapterEnd = parseInt(chapters[1].replace(':', ''), 10);
};
};
// Get verses in each referenceSplits
for ( let j=0; j < referenceSplits[i].length; j++ ) {
// For single-chapter Bible books
if ( bookSingleChapters.includes(bookNum) ) {
verseStart = parseInt(referenceSplits[i][j].match(/^\D*\d+/g)[0].replace(/^\D*/g, ''), 10);
// For multi-chapter Bible books
} else {
if ( referenceSplits[i][j].includes(':') ) {
verseStart = parseInt(referenceSplits[i][j].match(/:\d+/g)[0].replace(':', ''), 10);
} else {
let re1 = new RegExp('^' + ws + '\\d+', 'g');
let re2 = new RegExp('^' + ws, 'g');
verseStart = parseInt(referenceSplits[i][j].match(re1)[0].replace(re2, ''), 10);
};
};
verseEnd = parseInt(referenceSplits[i][j].match(/\d+[,;]*$/g)[0].replace(/[,;]$/g, ''), 10);
// Determine referenceEnd, and linkable start and end
referenceEnd = referenceStart + referenceSplits[i][j].length;
// referenceStart is set by the previous iteration of: while (searchResult != null)
// linkableStart is referenceStart with the first [0-9] in the referenceSplit
let linkableStart = referenceStart + referenceSplits[i][j].search(/\d/);
// If linking is from the beginning of the reference text
if ( i == 0 && j == 0 ) linkableStart = referenceStart;
// linkableEnd is referenceStart with the last [0-9] in the referenceSplit
let linkableEnd = referenceStart + referenceSplits[i][j].search(/\d\D*$/);
// Check if the book's chapters and verses are within valid values
let chapterMax = Object.keys(bibleData.bibleChapterVerseCount[bookNum.toString()]).length;
let verseStartMax = bibleData.bibleChapterVerseCount[bookNum.toString()][chapterEnd.toString()];
let verseEndMax = bibleData.bibleChapterVerseCount[bookNum.toString()][chapterStart.toString()];
if ( 0 < chapterEnd && chapterEnd <= chapterMax && 0 < verseStart && verseStart <= verseStartMax && 0 < verseEnd && verseEnd <= verseEndMax ) {
// Only set links if:
// (1) there is no selection (null)
// (2) or full line is selected
// (3) or searchResult is within selection range // +1 is a quirk of .getEndOffsetInclusive()
if ( (!searchElementStart || !searchElementEnd)
|| (searchElementStart == -1 && searchElementEnd == -1)
|| (searchResultStart >= searchElementStart && searchResultStart + referenceSplits[i][j].length <= searchElementEnd + 1) ) {
/////////////////////////////////////////////
// This is where the actual linking occurs //
/////////////////////////////////////////////
let url = getUrl(bibleData, bibleVersion, bookNum, chapterStart, verseStart, verseEnd, chapterEnd);
searchResultAstext.setLinkUrl(linkableStart, linkableEnd, url);
};
} else {
// Error message that reference is out of range?
};
// Set referenceStart for the next iteration
referenceStart = referenceEnd;
};
}; // END: Generate variables for the linker
// Find the next searchResult in: while (searchResult != null)
searchResult = searchElement.findText(searchRegex, searchResult);
}; // END: Cycle through each Bible reference found: while (searchResult != null)
}; // END: function bibleParse(bibleData, bibleVersion, bookNum, searchResult, searchElement, searchRegex, searchElementStart, searchElementEnd)
function getUrl(bibleData, bibleVersion, bookNum, chapterStart, verseStart, verseEnd, chapterEnd) {
// Get bookNames from bookNum
var bookNameAbbr1 = bibleData.bookNames[bookNum][0];
var bookNameAbbr2 = bibleData.bookNames[bookNum][1];
var bookNameFull = bibleData.bookNames[bookNum][2];
// Convert any integers to string, at times setting values
bookNum = bookNum.toString();
chapterStart = chapterStart.toString();
verseStart = verseStart.toString();
if ( ! verseEnd ) verseEnd = verseStart;
if ( verseEnd !== verseStart ) verseEnd = verseEnd.toString();
if ( ! chapterEnd ) chapterEnd = chapterStart;
if ( chapterEnd !== chapterStart ) chapterEnd = chapterEnd.toString();
// Format book numbers, chapters, and verses
var targetLength, padString;
// Pad bookNum as defined in data source
if ( bibleData.bibleVersions[bibleVersion].padStart.bookNum ) {
targetLength = bibleData.bibleVersions[bibleVersion].padStart.bookNum.targetLength;
padString = bibleData.bibleVersions[bibleVersion].padStart.bookNum.padString;
bookNum = bookNum.padStart(targetLength, padString);
};
// Pad chapters as defined in data source
if ( bibleData.bibleVersions[bibleVersion].padStart.chapter ) {
targetLength = bibleData.bibleVersions[bibleVersion].padStart.chapter.targetLength;
padString = bibleData.bibleVersions[bibleVersion].padStart.chapter.padString;
chapterStart = chapterStart.padStart(targetLength, padString);
chapterEnd = chapterEnd.padStart(targetLength, padString);
};
// Pad verses as defined in data source
if ( bibleData.bibleVersions[bibleVersion].padStart.verse ) {
targetLength = bibleData.bibleVersions[bibleVersion].padStart.verse.targetLength;
padString = bibleData.bibleVersions[bibleVersion].padStart.verse.padString;
verseStart = verseStart.padStart(targetLength, padString);
verseEnd = verseEnd.padStart(targetLength, padString);
};
// Get URL format for replacement
let url = bibleData.bibleVersions[bibleVersion].urlFormat;
// Replace strings to format final URL
url = url
.replace(/<<bookNum>>/g, bookNum)
.replace(/<<chapterStart>>/g, chapterStart)
.replace(/<<verseStart>>/g, verseStart)
.replace(/<<verseEnd>>/g, verseEnd)
.replace(/<<chapterEnd>>/g, chapterEnd)
.replace(/<bookNameAbbr1>>/g, bookNameAbbr1)
.replace(/<<bookNameAbbr2>>/g, bookNameAbbr2)
.replace(/<<bookNameFull>>/g, bookNameFull);
// Remove range in URL if single verse scripture only
if ( chapterStart === chapterEnd && verseStart === verseEnd ) url = url.replace(/-[0-9]+$|-[0-9]+:[0-9]+:[0-9]+$/, '');
return url;
}; // END: function getUrl(bibleData, bibleVersion, bookNum, chapterStart, verseStart, verseEnd, chapterEnd)
/////////////////////
// Other functions //
/////////////////////
function getBibleData(bibleDataSourceUrl, bibleDataSource) {
// If there is no bibleDataSource
// or bibleDataSource not included in current list (keys)
// then set to default value
if ( ! bibleDataSource
|| ! Object.keys(BIBLE_DATA_SOURCES).includes(bibleDataSource) ) {
bibleDataSource = BIBLE_DATA_SOURCES.default;
};
// Get error messages
let title = BIBLE_DATA_SOURCES[bibleDataSource].strings.errors.downloadJSON.title;
let messageBeforeSingular = BIBLE_DATA_SOURCES[bibleDataSource].strings.errors.downloadJSON.messageBeforeSingular;
let messageAfterSingular = BIBLE_DATA_SOURCES[bibleDataSource].strings.errors.downloadJSON.messageAfterSingular;
let messageBeforePlural = BIBLE_DATA_SOURCES[bibleDataSource].strings.errors.downloadJSON.messageBeforePlural;
let messageAfterPlural = BIBLE_DATA_SOURCES[bibleDataSource].strings.errors.downloadJSON.messageAfterPlural;
// Access Docs UI
var ui = DocumentApp.getUi();
// Define variables
let bibleData, bibleDataJSON;
// Check if data source contains multiple URLs (isArray)
if ( Array.isArray(bibleDataSourceUrl) ) {
// For each URL in array, exit once a proper JSON is found
for ( let i = 0; i < bibleDataSourceUrl.length; i++ ) {
// Try to download JSON
try {
bibleData = UrlFetchApp.fetch(bibleDataSourceUrl[i]);
// Continue with next URL in array if URL is invalid
} catch {
continue;
};
// If JSON exists and downloadable
if ( bibleData.getResponseCode() == 200 ) {
// Return and exit if valid JSON
try {
bibleDataJSON = JSON.parse(bibleData.getContentText());
return bibleDataJSON;
// Continue with next URL in array if JSON is invalid
} catch {
continue;
};
};
};
// If no valid JSON is found among all the URLs
if ( ! bibleDataJSON ) {
// Send alert to UI and return null
ui.alert(title, messageBeforePlural + bibleDataSourceUrl.join('\n') + messageAfterPlural, ui.ButtonSet.OK);
return null;
};
// If data source contain only a single URL string
} else {
// Try to download JSON
try {
bibleData = UrlFetchApp.fetch(bibleDataSourceUrl);
// If URL invalid, send alert to UI and return null
} catch {
ui.alert(title, messageBeforeSingular + bibleDataSourceUrl + messageAfterSingular, ui.ButtonSet.OK);
return null;
};
// Return and exit if valid JSON
try {
bibleDataJSON = JSON.parse(bibleData.getContentText());
return bibleDataJSON;
// If not a valid JSON, send alert to UI and return null
} catch {
ui.alert(title, messageBeforeSingular + bibleDataSourceUrl + messageAfterSingular, ui.ButtonSet.OK);
return null;
};
}; // END: Check if data source contains multiple URLs (isArray)
}; // END: getBibleData(bibleDataSourceUrl, bibleDataSource)
function getBibleDataCustom() {
const userProperties = PropertiesService.getUserProperties();
let customBibleData = userProperties.getProperty('customBibleData');
// Try if customBibleData is a JSON object
try {
let url = JSON.parse(customBibleData).url;
// If JSON contains URL
if ( url ) {
return getBibleData(url, 'custom');
// If JSON does not contains URL, reset to default
} else {
userProperties.setProperty('bibleDataSource', BIBLE_DATA_SOURCES.default);
userProperties.setProperty('bibleVersions', BIBLE_DATA_SOURCES[BIBLE_DATA_SOURCES.default].bibleVersions);
userProperties.deleteProperty('customBibleData');
createMenu();
};
// If customBibleData is not JSON
} catch {
return getBibleData(customBibleData, 'custom');
};
};
function chooseDataSource(bibleDataSource) {
// If there is no bibleDataSource
// or bibleDataSource not included in current list (keys)
// then set to default value
if ( ! bibleDataSource
|| ! Object.keys(BIBLE_DATA_SOURCES).includes(bibleDataSource) ) {
bibleDataSource = BIBLE_DATA_SOURCES.default;
};
// Fetch bibleData from external source, throw error if bibleData is null
let bibleData = bibleDataSource == 'custom' ? getBibleDataCustom() : getBibleData(BIBLE_DATA_SOURCES[bibleDataSource].url, bibleDataSource);
// Access Docs UI
var ui = DocumentApp.getUi();
// Check if bibleData is still valid
if ( ! bibleData ) {
ui.alert(BIBLE_DATA_SOURCES[bibleDataSource].strings.errors.nullBibleData.title, BIBLE_DATA_SOURCES[bibleDataSource].strings.errors.nullBibleData.message, ui.ButtonSet.OK);
bibleDataSource = BIBLE_DATA_SOURCES.default;
bibleData = getBibleData(BIBLE_DATA_SOURCES[bibleDataSource].url, bibleDataSource);
};
let updateTitle = bibleData.strings.bibleDataSource.update.title;
let updateMessageBefore = bibleData.strings.bibleDataSource.update.messageBefore;
let updateMessageAfter = bibleData.strings.bibleDataSource.update.messageAfter;
// Load bibleVersions into array, except 'default'
var bibleVersions = [];
for ( let bvk of Object.keys(bibleData.bibleVersions) ) {
if ( bvk == 'default' ) continue;
// Add key to end of array
bibleVersions.splice(bibleVersions.length, 0, bvk);
};
// Set bibleDataSource to user preferences
const userProperties = PropertiesService.getUserProperties();
userProperties.setProperty('bibleDataSource', bibleDataSource);
userProperties.setProperty('bibleVersions', JSON.stringify(bibleVersions));
// Recreate menu
createMenu();
// Inform user of change of data source
ui.alert(updateTitle, updateMessageBefore + BIBLE_DATA_SOURCES[bibleDataSource].displayName + updateMessageAfter, ui.ButtonSet.OK);
};
function setCustomDataSource() {
// Get user's last used bibleDataSource
const userProperties = PropertiesService.getUserProperties();
let bibleDataSource = userProperties.getProperty('bibleDataSource');
// If there is no bibleDataSource
// or bibleDataSource not included in current list (keys)
// then set to default value
if ( ! bibleDataSource
|| ! Object.keys(BIBLE_DATA_SOURCES).includes(bibleDataSource) ) {
bibleDataSource = BIBLE_DATA_SOURCES.default;
};
// Fetch bibleData from external source, throw error if bibleData is null
let bibleData = bibleDataSource == 'custom' ? getBibleDataCustom() : getBibleData(BIBLE_DATA_SOURCES[bibleDataSource].url, bibleDataSource);
// Access Docs UI
var ui = DocumentApp.getUi();
// Check if bibleData is still valid
if ( ! bibleData ) {