-
Notifications
You must be signed in to change notification settings - Fork 4
/
cg_check.js
3415 lines (3169 loc) · 135 KB
/
cg_check.js
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
/**
* cg_check.js
*
* Validate content guide metadata
*/
import process from "process";
import { readFileSync } from "fs";
import chalk from "chalk";
import { parseXmlString } from "libxmljs2";
import { attribute, elementize, quote } from "./phlib/phlib.js";
import { mpeg7 } from "./MPEG7_definitions.js";
import { tva, tvaEA, tvaEC } from "./TVA_definitions.js";
import { dvbi } from "./DVB-I_definitions.js";
import { TVAschema, __dirname_linux } from "./data_locations.js";
import ErrorList, { WARNING, APPLICATION } from "./error_list.js";
import { isCRIDURI, isTAGURI } from "./URI_checks.js";
import { xPath, xPathM, isIn, isIni, unEntity, parseISOduration, CountChildElements, DuplicatedValue } from "./utils.js";
import { isHTTPURL, isDVBLocator, isUTCDateTime } from "./pattern_checks.js";
import { ValidatePromotionalStillImage } from "./related_material_checks.js";
import { cg_InvalidHrefValue, NoChildElement, keys } from "./common_errors.js";
import { checkAttributes, checkTopElementsAndCardinality, hasChild, SchemaCheck, SchemaLoad, SchemaVersionCheck } from "./schema_checks.js";
import { checkLanguage, GetNodeLanguage, checkXMLLangs } from "./multilingual_element.js";
import writeOut from "./logger.js";
import { CURRENT, OLD } from "./globals.js";
import {
LoadGenres,
LoadRatings,
LoadVideoCodecCS,
LoadAudioCodecCS,
LoadAudioPresentationCS,
LoadAccessibilityPurpose,
LoadAudioPurpose,
LoadSubtitleCarriages,
LoadSubtitleCodings,
LoadSubtitlePurposes,
LoadLanguages,
LoadCountries,
} from "./classification_scheme_loaders.js";
import { LoadCredits } from "./role_loader.js";
import CheckAccessibilityAttributes from "./accessibility_attributes_checks.js";
// convenience/readability values
const DEFAULT_LANGUAGE = "***";
const CATEGORY_GROUP_NAME = '"category group"';
const CG_REQUEST_SCHEDULE_TIME = "Time";
const CG_REQUEST_SCHEDULE_NOWNEXT = "NowNext";
const CG_REQUEST_SCHEDULE_WINDOW = "Window";
const CG_REQUEST_PROGRAM = "ProgInfo";
const CG_REQUEST_MORE_EPISODES = "MoreEpisodes";
const CG_REQUEST_BS_CATEGORIES = "bsCategories";
const CG_REQUEST_BS_LISTS = "bsLists";
const CG_REQUEST_BS_CONTENTS = "bsContents";
const supportedRequests = [
{ value: CG_REQUEST_SCHEDULE_TIME, label: "Schedule Info (time stamp)" },
{ value: CG_REQUEST_SCHEDULE_NOWNEXT, label: "Schedule Info (now/next)" },
{ value: CG_REQUEST_SCHEDULE_WINDOW, label: "Schedule Info (window)" },
{ value: CG_REQUEST_PROGRAM, label: "Program Info" },
{ value: CG_REQUEST_MORE_EPISODES, label: "More Episodes" },
{ value: CG_REQUEST_BS_CATEGORIES, label: "Box Set Categories" },
{ value: CG_REQUEST_BS_LISTS, label: "Box Set Lists" },
{ value: CG_REQUEST_BS_CONTENTS, label: "Box Set Contents" },
];
const SCHEMA_r0 = 0,
SCHEMA_r1 = 1,
SCHEMA_r2 = 2,
SCHEMA_unknown = -1;
const SchemaVersions = [
{
namespace: TVAschema.v2024.namespace,
version: SCHEMA_r2,
filename: TVAschema.v2024.file,
schema: null,
status: CURRENT,
},
{
namespace: TVAschema.v2023.namespace,
version: SCHEMA_r1,
filename: TVAschema.v2023.file,
schema: null,
status: OLD,
},
{
namespace: TVAschema.v2019.namespace,
version: SCHEMA_r0,
filename: TVAschema.v2019.file,
schema: null,
status: OLD,
},
];
/**
* determine the schema version (and hence the specificaion version) in use
*
* @param {String} namespace The namespace used in defining the schema
* @returns {integer} Representation of the schema version or error code if unknown
*/
let SchemaVersion = (namespace) => {
let x = SchemaVersions.find((ver) => ver.namespace == namespace);
return x ? x.version : SCHEMA_unknown;
};
/**
* converts a decimal representation of a string to a number
*
* @param {string} str string contining the decimal value
* @returns {integer} the decimal representation of the string, or 0 is non-digits are included
*/
function valUnsignedInt(str) {
const intRegex = /[\d]+/;
let s = str.match(intRegex);
return s[0] === str ? parseInt(str, 10) : 0;
}
/**
* checks is the specified element (elem) has an attribute named attrName and that its value is on the given list)
*
* @param {XMLnode} elem the XML element to be checked
* @param {string} attrName the name of the attribute carrying the boolean value
* @param {string} errCode the error number used as a prefix for reporting errors
* @param {Class} errs errors found in validaton
* @param {array} allowed the set or permitted values
* @param {boolean} isRequired true if the specificed attribued is required to be specified for the element
*/
function AllowedValue(elem, attrName, errCode, errs, allowed, isRequired = true) {
if (!elem) {
errs.addError({ type: APPLICATION, code: `${errCode}-0`, message: "AllowedValue() called with elem==null" });
return;
}
if (elem.attr(attrName)) {
if (!isIn(allowed, elem.attr(attrName).value())) {
let str = "";
allowed.forEach((value) => (str = str + (str.length ? " or " : "") + value));
errs.addError({
code: `${errCode}-1`,
message: `${attrName.attribute(`${elem.parent().name}.${elem.name()}`)} must be ${str}`,
fragment: elem,
});
}
} else if (isRequired)
errs.addError({
code: `${errCode}-2`,
message: `${attrName.attribute()} must be specified for ${elem.parent().name()}.${elem.name()}`,
fragment: elem,
});
}
/**
* checks is the specified element (elem) has an attribute named attrName and that its value is "true" or "false"
*
* @param {XMLnode} elem the XML element to be checked
* @param {string} attrName the name of the attribute carrying the boolean value
* @param {string} errCode the error number used as a prefix for reporting errors
* @param {Class} errs errors found in validaton
* @param {boolean} isRequired true if the specificed attribued is required to be specified for the element
*/
function BooleanValue(elem, attrName, errCode, errs, isRequired = true) {
AllowedValue(elem, attrName, errCode, errs, ["true", "false"], isRequired);
}
/**
* checks is the specified element (elem) has an attribute named attrName and that its value is "true"
*
* @param {XMLnode} elem the XML element to be checked
* @param {string} attrName the name of the attribute carrying the boolean value
* @param {string} errCode the error number used as a prefix for reporting errors
* @param {Class} errs errors found in validaton
* @param {boolean} isRequired true if the specificed attribued is required to be specified for the element
*/
function TrueValue(elem, attrName, errCode, errs, isRequired = true) {
AllowedValue(elem, attrName, errCode, errs, ["true"], isRequired);
}
/**
* checks is the specified element (elem) has an attribute named attrName and that its value is "false"
*
* @param {XMLnode} elem the XML element to be checked
* @param {string} attrName the name of the attribute carrying the boolean value
* @param {string} errCode the error number used as a prefix for reporting errors
* @param {Class} errs errors found in validaton
* @param {boolean} isRequired true if the specificed attribued is required to be specified for the element
*/
function FalseValue(elem, attrName, errCode, errs, isRequired = true) {
AllowedValue(elem, attrName, errCode, errs, ["false"], isRequired);
}
if (!Array.prototype.forEachSubElement) {
// based on the polyfill at https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach
/*
* alternate to Array.prototype.forEach that only returns XML tree nodes that are elements
*/
Array.prototype.forEachSubElement = function (callback, thisArg) {
if (this == null) {
throw new TypeError("Array.prototype.forEachSubElement called on null or undefined");
}
var T, k;
// 1. Let O be the result of calling toObject() passing the
// |this| value as the argument.
var O = Object(this);
// 2. Let lenValue be the result of calling the Get() internal
// method of O with the argument "length".
// 3. Let len be toUint32(lenValue).
var len = O.length >>> 0;
// 4. If isCallable(callback) is false, throw a TypeError exception.
// See: https://es5.github.com/#x9.11
if (typeof callback !== "function") {
throw new TypeError(`${callback} is not a function`);
}
// 5. If thisArg was supplied, let T be thisArg; else let
// T be undefined.
if (arguments.length > 1) {
T = thisArg;
}
// 6. Let k be 0
k = 0;
// 7. Repeat, while k < len
while (k < len) {
var kValue;
// a. Let Pk be ToString(k).
// This is implicit for LHS operands of the in operator
// b. Let kPresent be the result of calling the HasProperty
// internal method of O with argument Pk.
// This step can be combined with c
// c. If kPresent is true, then
if (k in O) {
// i. Let kValue be the result of calling the Get internal
// method of O with argument Pk.
kValue = O[k];
// ii. Call the Call internal method of callback with T as
// the this value and argument list containing kValue, k, and O.
if (kValue.type() == "element") callback.call(T, kValue, k, O);
}
// d. Increase k by 1.
k++;
}
// 8. return undefined
};
}
/**
* @param {string} genre the value to check as being a restart availability genre
* @retuwns {boolean} trus id the value provided is a valid restart availability genre
*/
export var isRestartAvailability = (genre) => [dvbi.RESTART_AVAILABLE, dvbi.RESTART_CHECK, dvbi.RESTART_PENDING].includes(genre);
export default class ContentGuideCheck {
#numRequests;
#knownLanguages;
#allowedGenres;
#allowedVideoSchemes;
#allowedAudioSchemes;
#audioPresentationCSvalues;
#allowedCreditItemRoles;
#allowedRatings;
#knownCountries;
#accessibilityPurposes;
#audioPurposes;
#subtitleCarriages;
#subtitleCodings;
#subtitlePurposes;
constructor(useURLs, opts, async = true) {
this.#numRequests = 0;
this.supportedRequests = supportedRequests;
this.#knownLanguages = opts?.languages ? opts.languages : LoadLanguages(useURLs, async);
this.#allowedGenres = opts?.genres ? opts.genres : LoadGenres(useURLs, async);
this.#allowedVideoSchemes = opts?.videofmts ? opts.videofmts : LoadVideoCodecCS(useURLs, async);
this.#allowedAudioSchemes = opts?.audiofmts ? opts.audiofmts : LoadAudioCodecCS(useURLs, async);
this.#audioPresentationCSvalues = opts?.audiopres ? opts?.audiopres : LoadAudioPresentationCS(useURLs, async);
this.#allowedCreditItemRoles = opts?.credits ? opts.credits : LoadCredits(useURLs, async);
this.#allowedRatings = opts?.ratings ? opts.ratings : LoadRatings(useURLs, async);
this.#knownCountries = opts?.countries ? opts.countries : LoadCountries(useURLs, async);
this.#accessibilityPurposes = opts?.accessibilities ? opts.accessibilities : LoadAccessibilityPurpose(useURLs, async);
this.#audioPurposes = opts?.audiopurps ? opts.audiopurps : LoadAudioPurpose(useURLs, async);
this.#subtitleCarriages = opts?.stcarriage ? opts.stcarriage : LoadSubtitleCarriages(useURLs, async);
this.#subtitleCodings = opts?.stcodings ? opts.stcodings : LoadSubtitleCodings(useURLs, async);
this.#subtitlePurposes = opts?.stpurposes ? opts.stpurposes : LoadSubtitlePurposes(useURLs, async);
// TODO - change this to support sync/asyna and file/url reading
console.log(chalk.yellow.underline("loading content guide schemas..."));
SchemaVersions.forEach((version) => {
process.stdout.write(chalk.yellow(`..loading ${version.version} ${version.namespace} from ${version.filename} `));
let schema = readFileSync(version.filename).toString().replace(`schemaLocation="./`, `schemaLocation="${__dirname_linux}/`);
version.schema = parseXmlString(schema);
console.log(version.schema ? chalk.green("OK") : chalk.red.bold("FAIL"));
});
}
stats() {
let res = {};
res.numRequests = this.#numRequests;
this.#knownLanguages.stats(res);
res.numAllowedGenres = this.#allowedGenres.count();
res.numCreditItemRoles = this.#allowedCreditItemRoles.count();
res.numRatings = this.#allowedRatings.count();
res.numAudioPurposes = this.#audioPurposes.count();
return res;
}
/*private*/ #doSchemaVerification(TVAdoc, props, errs, errCode) {
let _rc = true;
let x = SchemaVersions.find((s) => s.namespace == props.namespace);
if (x && x.schema) {
SchemaCheck(TVAdoc, x.schema, errs, `${errCode}:${SchemaVersion(props.namespace)}`);
SchemaVersionCheck(props, TVAdoc, x.status, errs, `${errCode}a`);
} else _rc = false;
return _rc;
}
/**
* check if the specificed element has the named child element
*
* @param {XMLnode} node the node to check
* @param {string} elementName the name of the child element
* @returns {boolean} true if an element named node.elementName exists, else false
*/
/* private */ #hasElement(node, elementName) {
if (!node) return false;
return node.childNodes().find((c) => c.type() == "element" && c.name() == elementName);
}
/**
* check that the serviceIdRef attribute is a TAG URI and report warnings
*
* @param {XMLnode} elem the node containing the element being checked
* @param {Class} errs errors found in validaton
* @param {string} errCode error code prefix to be used in reports
* @returns {string} the serviceIdRef, whether it is valid of not
*/
/* private */ #checkTAGUri(elem, errs, errCode) {
if (elem && elem.attr(tva.a_serviceIDRef)) {
let svcID = elem.attr(tva.a_serviceIDRef).value();
if (!isTAGURI(svcID))
errs.addError({
type: WARNING,
code: errCode,
key: keys.k_InvalidTag,
message: `${tva.a_serviceIDRef.attribute(elem.name())} ${svcID.quote()} is not a TAG URI`,
line: elem.line(),
});
return svcID;
}
return "";
}
/**
* validate the <Synopsis> elements
*
* @param {object} props Metadata of the XML document
* @param {XMLnode} BasicDescription the element whose children should be checked
* @param {array} requiredLengths @length attributes that are required to be present
* @param {array} optionalLengths @length attributes that can optionally be present
* @param {Class} errs errors found in validaton
* @param {string} errCode error code prefix to be used in reports
*/
/* private */ #ValidateSynopsis(props, BasicDescription, requiredLengths, optionalLengths, errs, errCode) {
if (!BasicDescription) {
errs.addError({
type: APPLICATION,
code: "SY000",
message: "ValidateSynopsis() called with BasicDescription==null",
});
return;
}
let synopsisLengthError = (label, length, actual) => `length of ${tva.a_length.attribute(tva.e_Synopsis)}=${label.quote()} exceeds ${length} characters, measured(${actual})`;
let singleLengthLangError = (length, lang) => `only a single ${tva.e_Synopsis.elementize()} is permitted per length (${length}) and language (${lang})`;
let requiredSynopsisError = (length) => `a ${tva.e_Synopsis.elementize()} with ${tva.a_length.attribute()}=${length.quote()} is required`;
let s = 0,
Synopsis,
hasShort = false,
hasMedium = false,
hasLong = false;
let shortLangs = [],
mediumLangs = [],
longLangs = [];
while ((Synopsis = BasicDescription.get(xPath(props.prefix, tva.e_Synopsis, ++s), props.schema)) != null) {
checkAttributes(Synopsis, [tva.a_length], [tva.a_lang], tvaEA.Synopsis, errs, `${errCode}-1`);
const synopsisLang = GetNodeLanguage(Synopsis, false, errs, `${errCode}-2`, this.#knownLanguages);
const synopsisLength = Synopsis.attr(tva.a_length) ? Synopsis.attr(tva.a_length).value() : null;
if (synopsisLength) {
if (isIn(requiredLengths, synopsisLength) || isIn(optionalLengths, synopsisLength)) {
const _len = unEntity(Synopsis.text()).length;
switch (synopsisLength) {
case tva.SYNOPSIS_SHORT_LABEL:
if (_len > tva.SYNOPSIS_SHORT_LENGTH)
errs.addError({
code: `${errCode}-11`,
message: synopsisLengthError(tva.SYNOPSIS_SHORT_LABEL, tva.SYNOPSIS_SHORT_LENGTH, _len),
fragment: Synopsis,
key: keys.k_LengthError,
});
hasShort = true;
break;
case tva.SYNOPSIS_MEDIUM_LABEL:
if (_len > tva.SYNOPSIS_MEDIUM_LENGTH)
errs.addError({
code: `${errCode}-12`,
message: synopsisLengthError(tva.SYNOPSIS_MEDIUM_LABEL, tva.SYNOPSIS_MEDIUM_LENGTH, _len),
fragment: Synopsis,
key: keys.k_LengthError,
});
hasMedium = true;
break;
case tva.SYNOPSIS_LONG_LABEL:
if (_len > tva.SYNOPSIS_LONG_LENGTH)
errs.addError({
code: `${errCode}-13`,
message: synopsisLengthError(tva.SYNOPSIS_LONG_LABEL, tva.SYNOPSIS_LONG_LENGTH, _len),
fragment: Synopsis,
key: keys.k_LengthError,
});
hasLong = true;
break;
}
} else
errs.addError({
code: `${errCode}-14`,
message: `${tva.a_length.attribute()}=${synopsisLength.quote()} is not permitted for this request type`,
fragment: Synopsis,
key: "unexpected length",
});
}
if (synopsisLang && synopsisLength) {
switch (synopsisLength) {
case tva.SYNOPSIS_SHORT_LABEL:
if (isIn(shortLangs, synopsisLang))
errs.addError({
code: `${errCode}-16`,
message: singleLengthLangError(synopsisLength, synopsisLang),
fragment: Synopsis,
key: keys.k_DuplicatedSynopsisLength,
});
else shortLangs.push(synopsisLang);
break;
case tva.SYNOPSIS_MEDIUM_LABEL:
if (isIn(mediumLangs, synopsisLang))
errs.addError({
code: `${errCode}-17`,
message: singleLengthLangError(synopsisLength, synopsisLang),
fragment: Synopsis,
key: keys.k_DuplicatedSynopsisLength,
});
else mediumLangs.push(synopsisLang);
break;
case tva.SYNOPSIS_LONG_LABEL:
if (isIn(longLangs, synopsisLang))
errs.addError({
code: `${errCode}-18`,
message: singleLengthLangError(synopsisLength, synopsisLang),
fragment: Synopsis,
key: keys.k_DuplicatedSynopsisLength,
});
else longLangs.push(synopsisLang);
break;
}
}
}
if (isIn(requiredLengths, tva.SYNOPSIS_SHORT_LABEL) && !hasShort)
errs.addError({
code: `${errCode}-19`,
message: requiredSynopsisError(tva.SYNOPSIS_SHORT_LABEL),
line: BasicDescription.line(),
key: keys.k_MissingSynopsisLength,
});
if (isIn(requiredLengths, tva.SYNOPSIS_MEDIUM_LABEL) && !hasMedium)
errs.addError({
code: `${errCode}-20`,
message: requiredSynopsisError(tva.SYNOPSIS_MEDIUM_LABEL),
line: BasicDescription.line(),
key: keys.k_MissingSynopsisLength,
});
if (isIn(requiredLengths, tva.SYNOPSIS_LONG_LABEL) && !hasLong)
errs.addError({
code: `${errCode}-21`,
message: requiredSynopsisError(tva.SYNOPSIS_LONG_LABEL),
line: BasicDescription.line(),
key: keys.k_MissingSynopsisLength,
});
}
/**
* validate the <Keyword> elements specified
*
* @param {object} props Metadata of the XML document
* @param {XMLnode} BasicDescription the element whose children should be checked
* @param {integer} minKeywords the minimum number of keywords
* @param {integer} maxKeywords the maximum number of keywords
* @param {Class} errs errors found in validaton
* @param {string} errCode error code prefix to be used in reports
*/
/* private */ #ValidateKeyword(props, BasicDescription, minKeywords, maxKeywords, errs, errCode) {
if (!BasicDescription) {
errs.addError({
type: APPLICATION,
code: "KW000",
message: "ValidateKeyword() called with BasicDescription=null",
});
return;
}
let k = 0,
Keyword,
counts = [];
while ((Keyword = BasicDescription.get(xPath(props.prefix, tva.e_Keyword, ++k), props.schema)) != null) {
checkAttributes(Keyword, [], [tva.a_lang, tva.a_type], tvaEA.Keyword, errs, `${errCode}-1`);
let keywordType = Keyword.attr(tva.a_type) ? Keyword.attr(tva.a_type).value() : tva.DEFAULT_KEYWORD_TYPE;
let keywordLang = GetNodeLanguage(Keyword, false, errs, `${errCode}-2`, this.#knownLanguages);
if (counts[keywordLang] === undefined) counts[keywordLang] = [Keyword];
else counts[keywordLang].push(Keyword);
if (keywordType != tva.KEYWORD_TYPE_MAIN && keywordType != tva.KEYWORD_TYPE_OTHER)
errs.addError({
code: `${errCode}-11`,
key: keys.k_InvalidKeywordType,
message: `${tva.a_type.attribute()}=${keywordType.quote()} not permitted for ${tva.e_Keyword.elementize()}`,
fragment: Keyword,
});
if (unEntity(Keyword.text()).length > dvbi.MAX_KEYWORD_LENGTH)
errs.addError({
code: `${errCode}-12`,
message: `length of ${tva.e_Keyword.elementize()} is greater than ${dvbi.MAX_KEYWORD_LENGTH}`,
fragment: Keyword,
key: keys.k_InvalidKeywordType,
});
}
for (let i in counts) {
if (counts[i].length != 0 && counts[i].length > maxKeywords)
errs.addError({
code: `${errCode}-13`,
key: "excess keywords",
message: `More than ${maxKeywords} ${tva.e_Keyword.elementize()} element${maxKeywords > 1 ? "s" : ""} specified${
i == DEFAULT_LANGUAGE ? "" : " for language " + i.quote()
}`,
multiElementError: counts[i],
});
}
}
/**
* validate the <Genre> elements specified
*
* @param {object} props Metadata of the XML document
* @param {XMLnode} BasicDescription the element whose children should be checked
* @param {Class} errs errors found in validaton
* @param {string} errCode error code prefix to be used in reports
*/
/* private */ #ValidateGenre(props, BasicDescription, errs, errCode) {
if (!BasicDescription) {
errs.addError({ type: APPLICATION, code: "GE000", message: "ValidateGenre() called with BasicDescription=null" });
return;
}
let g = 0,
Genre;
while ((Genre = BasicDescription.get(xPath(props.prefix, tva.e_Genre, ++g), props.schema)) != null) {
const genreType = Genre.attr(tva.a_type) ? Genre.attr(tva.a_type).value() : tva.DEFAULT_GENRE_TYPE;
if (genreType != tva.GENRE_TYPE_MAIN) {
errs.addError({
code: `${errCode}-1`,
key: "disallowed genre type",
message: `${tva.a_type.attribute(tva.e_Genre)}=${genreType.quote()} not permitted for ${tva.e_Genre.elementize()}`,
fragment: Genre,
});
errs.errorDescription({
code: `${errCode}-1`,
clause: "A177 clause 6.10.5",
description: `${tva.a_type.attribute(tva.e_Genre)} must be "${tva.GENRE_TYPE_MAIN}", semantic definitions of ${tva.e_Genre.elementize()}`,
});
}
const genreValue = Genre.attr(tva.a_href) ? Genre.attr(tva.a_href).value() : "";
if (!this.#allowedGenres.isIn(genreValue)) {
errs.addError({
code: `${errCode}-2`,
key: "invalid genre",
message: `invalid ${tva.a_href.attribute()} value ${genreValue.quote()} for ${tva.e_Genre.elementize()}`,
fragment: Genre,
});
errs.errorDescription({
code: `${errCode}-2`,
clause: "A177 clause 6.10.5",
description: `The value of ${tva.a_href.attribute(tva.e_Genre)} must be as specified in the semantic definitions of ${tva.e_Genre.elementize()}`,
});
}
}
}
/**
* validate the <ParentalGuidance> elements specified.
*
* @param {object} props Metadata of the XML document
* @param {XMLnode} BasicDescription the element whose children should be checked
* @param {Class} errs errors found in validaton
* @param {string} errCode error code prefix to be used in reports
*/
/* private */ #Validate_ParentalGuidance(props, BasicDescription, errs, errCode) {
if (!BasicDescription) {
errs.addError({
type: APPLICATION,
code: "PG000",
message: "Validate_ParentalGuidance() called with BasicDescription=null",
});
return;
}
const UNSPECIFIED_COUNTRY = "*!*";
let foundCountries = [];
let pg = 0,
ParentalGuidance;
while ((ParentalGuidance = BasicDescription.get(xPath(props.prefix, tva.e_ParentalGuidance, ++pg), props.schema)) != null) {
let pgCountries = UNSPECIFIED_COUNTRY;
if (hasChild(ParentalGuidance, tva.e_CountryCodes)) pgCountries = ParentalGuidance.get(xPath(props.prefix, tva.e_CountryCodes), props.schema).text();
const pgCountriesList = pgCountries.split(",");
pgCountriesList.forEach((pgCountry) => {
let thisCountry = foundCountries.find((c) => c.country == pgCountry);
if (!thisCountry) {
thisCountry = { country: pgCountry, pgCount: 0, MinimumAge: null, ParentalRating: null };
foundCountries.push(thisCountry);
}
if (pgCountry != UNSPECIFIED_COUNTRY && !this.#knownCountries.isISO3166code(pgCountry))
errs.addError({
code: `${errCode}-5`,
key: keys.k_ParentalGuidance,
message: `invalid country code (${pgCountry}) specified`,
fragment: ParentalGuidance.get(xPath(props.prefix, tva.e_CountryCodes), props.schema),
});
// first <ParentalGuidance> element must contain an <mpeg7:MinimumAge> element
if (ParentalGuidance.childNodes())
ParentalGuidance.childNodes().forEachSubElement((pgChild) => {
switch (pgChild.name()) {
case tva.e_MinimumAge:
checkAttributes(pgChild, [], [], tvaEA.MinimumAge, errs, `${errCode}-10`);
if (thisCountry.MinimumAge) {
// only one minimum age value is permitted per country
errs.addError({
code: `${errCode}-11`,
key: keys.k_ParentalGuidance,
message: `only a single ${tva.e_ParentalGuidance.elementize()} containing ${tva.e_MinimumAge.elementize()} can be specified per country ${
pgCountry == UNSPECIFIED_COUNTRY ? "" : `(${pgCountry})`
}`,
fragment: pgChild,
});
}
thisCountry.MinimumAge = pgChild;
let age = pgChild.text().parseInt();
if ((age < 4 || age > 18) && age != 255)
errs.addError({
code: `${errCode}-12`,
key: keys.k_ParentalGuidance,
message: `value of ${tva.e_MinimumAge.elementize()} must be between 4 and 18 (to align with parental_rating_descriptor) or be 255`,
fragment: pgChild,
});
break;
case tva.e_ParentalRating:
checkAttributes(pgChild, [tva.a_href], [], tvaEA.ParentalRating, errs, `${errCode}-20`);
if (thisCountry.ParentalRating) {
// only one parental rating value is permitted per country
errs.addError({
code: `${errCode}-21`,
key: keys.k_ParentalGuidance,
message: `only a single ${tva.e_ParentalGuidance.elementize()} containing ${tva.e_ParentalRating.elementize()} can be specified per country ${
pgCountry == UNSPECIFIED_COUNTRY ? "" : `(${pgCountry})`
}`,
fragment: pgChild,
});
}
if (pgChild.attr(tva.a_href)) {
const rating = pgChild.attr(tva.a_href).value();
if (this.#allowedRatings.hasScheme(rating)) {
if (!this.#allowedRatings.isIn(rating))
errs.addError({
code: `${errCode}-22`,
key: keys.k_ParentalGuidance,
fragment: pgChild,
message: `invalid rating term "${rating}"`,
});
} else
errs.addError({
type: WARNING,
code: `${errCode}-23`,
key: keys.k_ParentalGuidance,
message: "foreign (non DVB or TVA) parental rating scheme used",
fragment: pgChild,
});
if (rating.startsWith(dvbi.DTG_CONTENT_WARNING_CS_SCHEME)) {
// <ExplanatoryText> is required for DTG Content Warning CS
if (!hasChild(ParentalGuidance, tva.e_ExplanatoryText))
errs.addError({
code: `${errCode}-24`,
key: keys.k_ParentalGuidance,
message: `${tva.e_ExplanatoryText.elementize()} is required for DTGContentWarningCS`,
fragment: ParentalGuidance,
});
}
}
thisCountry.ParentalRating = pgChild;
break;
case tva.e_ExplanatoryText:
checkAttributes(pgChild, [tva.a_length], [tva.a_lang], tvaEA.ExplanatoryText, errs, `${errCode}-30`);
if (pgChild.attr(tva.a_length)) {
if (pgChild.attr(tva.a_length).value() != tva.v_lengthLong)
errs.addError({
code: `${errCode}-31`,
message: `${tva.a_length.attribute()}=${pgChild.attr(tva.a_length).value().quote()} is not allowed for ${tva.e_ExplanatoryText.elementize()}`,
fragment: pgChild,
key: keys.k_LengthError,
});
}
if (unEntity(pgChild.text()).length > dvbi.MAX_EXPLANATORY_TEXT_LENGTH)
errs.addError({
code: `${errCode}-32`,
message: `length of ${tva._ExplanatoryText.elementize()} cannot exceed ${dvbi.MAX_EXPLANATORY_TEXT_LENGTH} characters`,
fragment: pgChild,
key: keys.k_LengthError,
});
break;
}
});
checkXMLLangs(tva.e_ExplanatoryText, `${BasicDescription.name()}.${tva.e_ParentalGuidance}`, ParentalGuidance, errs, `${errCode}-50`, this.#knownLanguages);
});
}
// now check that for each country, there is a MinimumAge element specified
foundCountries.forEach((pgCountry) => {
if (pgCountry.ParentalRating && !pgCountry.MinimumAge)
errs.addError({
code: `${errCode}-60`,
key: keys.k_ParentalGuidance,
message: `a ${tva.e_ParentalGuidance.elementize()} element contining ${tva.e_MinimumAge.elementize()} is not specified for ${
pgCountry.country == UNSPECIFIED_COUNTRY ? "default country" : pgCountry.country
}`,
fragment: pgCountry.ParentalRating,
});
});
}
/**
* validate the <CreditsList> elements specified
*
* @param {object} props Metadata of the XML document
* @param {XMLnode} BasicDescription the element whose children should be checked
* @param {Class} errs errors found in validaton
* @param {string} errCode error code prefix to be used in reports
*/
/* private */ #ValidateCreditsList(props, BasicDescription, errs, errCode) {
if (!BasicDescription) {
errs.addError({
type: APPLICATION,
code: "CL000",
message: "ValidateCreditsList() called with BasicDescription==null",
});
return;
}
/**
* validate a name (either PersonName of Character) to ensure a single GivenName is present with a single optional FamilyName
*
* @param {XMLnode} elem the element whose children should be checked
* @param {Class} errs errors found in validaton
* @param {string} errCode error code prefix to be used in reports
*/
function ValidateName(elem, errs, errCode) {
function checkNamePart(elem, errs, errCode) {
if (unEntity(elem.text()).length > dvbi.MAX_NAME_PART_LENGTH)
errs.addError({
code: errCode,
fragment: elem,
message: `${elem.name().elementize()} in ${elem.parent().name().elementize()} is longer than ${dvbi.MAX_NAME_PART_LENGTH} characters`,
key: keys.k_LengthError,
});
}
if (!elem) {
errs.addError({ type: APPLICATION, code: "VN000", message: "ValidateName() called with elem==null" });
return;
}
let familyNameCount = [],
givenNameCount = 0;
if (elem.childNodes())
elem.childNodes().forEachSubElement((subElem) => {
switch (subElem.name()) {
case tva.e_GivenName:
givenNameCount++;
checkNamePart(subElem, errs, `${errCode}-2`);
break;
case tva.e_FamilyName:
familyNameCount.push(subElem);
checkNamePart(subElem, errs, `${errCode}-3`);
break;
}
});
if (givenNameCount == 0)
errs.addError({
code: `${errCode}-4`,
message: `${tva.e_GivenName.elementize()} is mandatory in ${elem.name().elementize()}`,
line: elem.line(),
key: "missing element",
});
if (familyNameCount.length > 1)
errs.addError({
code: `${errCode}-5`,
message: `only a single ${tva.e_FamilyName.elementize()} is permitted in ${elem.name().elementize()}`,
multiElementError: familyNameCount,
key: "multiple element",
});
}
const CreditsList = BasicDescription.get(xPath(props.prefix, tva.e_CreditsList), props.schema);
if (CreditsList) {
let ci = 0,
numCreditsItems = 0,
CreditsItem;
while ((CreditsItem = CreditsList.get(xPath(props.prefix, tva.e_CreditsItem, ++ci), props.schema)) != null) {
numCreditsItems++;
checkAttributes(CreditsItem, [tva.a_role], [], tvaEA.CreditsItem, errs, `${errCode}-1`);
if (CreditsItem.attr(tva.a_role)) {
const CreditsItemRole = CreditsItem.attr(tva.a_role).value();
if (!this.#allowedCreditItemRoles.isIn(CreditsItemRole))
errs.addError({
code: `${errCode}-2`,
message: `${CreditsItemRole.quote()} is not valid for ${tva.a_role.attribute(tva.e_CreditsItem)}`,
fragment: CreditsItem,
key: keys.k_InvalidValue,
});
}
let foundPersonName = [],
foundCharacter = [],
foundOrganizationName = [];
if (CreditsItem.childNodes())
CreditsItem.childNodes().forEachSubElement((elem) => {
switch (elem.name()) {
case tva.e_PersonName:
foundPersonName.push(elem);
// required to have a GivenName optionally have a FamilyName
ValidateName(elem, errs, `${errCode}-11`);
checkXMLLangs(tva.e_GivenName, tva.e_PersonName, elem, errs, `${errCode}-12`, this.#knownLanguages);
checkXMLLangs(tva.e_FamilyName, tva.e_PersonName, elem, errs, `${errCode}-13`, this.#knownLanguages);
break;
case tva.e_Character:
foundCharacter.push(elem);
// required to have a GivenName optionally have a FamilyName
ValidateName(elem, errs, `${errCode}-21`);
checkXMLLangs(tva.e_GivenName, tva.e_Character, elem, errs, `${errCode}-22`, this.#knownLanguages);
checkXMLLangs(tva.e_FamilyName, tva.e_Character, elem, errs, `${errCode}-23`, this.#knownLanguages);
break;
case tva.e_OrganizationName:
foundOrganizationName.push(elem);
if (unEntity(elem.text()).length > dvbi.MAX_ORGANIZATION_NAME_LENGTH)
errs.addError({
code: `${errCode}-31`,
message: `length of ${tva.e_OrganizationName.elementize()} in ${tva.e_CreditsItem.elementize()} exceeds ${dvbi.MAX_ORGANIZATION_NAME_LENGTH} characters`,
fragment: elem,
key: keys.k_LengthError,
});
break;
default:
if (elem.name() != "text")
errs.addError({
code: `${errCode}-91`,
message: `extra element ${elem.name().elementize()} found in ${tva.e_CreditsItem.elementize()}`,
fragment: elem,
key: "unexpected element",
});
}
});
let singleElementError = (elementName, parentElementName) => `only a single ${elementName.elementize()} is permitted in ${parentElementName.elementize()}`;
checkXMLLangs(tva.e_OrganizationName, tva.e_CreditsItem, CreditsItem, errs, `${errCode}-11`, this.#knownLanguages);
if (foundPersonName.length > 1)
errs.addError({
code: `${errCode}-51`,
message: singleElementError(tva.e_PersonName, tva.e_CreditsItem),
multiElementError: foundPersonName,
key: keys.k_InvalidElement,
});
if (foundCharacter.length > 1)
errs.addError({
code: `${errCode}-52`,
message: singleElementError(tva.e_Character, tva.e_CreditsItem),
multiElementError: foundCharacter,
key: keys.k_InvalidElement,
});
if (foundOrganizationName.length > 1)
errs.addError({
code: `${errCode}-53`,
message: singleElementError(tva.e_OrganizationName, tva.e_CreditsItem),
multiElementError: foundOrganizationName,
key: keys.k_InvalidElement,
});
if (foundCharacter.length > 0 && foundPersonName.length == 0)
errs.addError({
code: `${errCode}-54`,
message: `${tva.e_Character.elementize()} in ${tva.e_CreditsItem.elementize()} requires ${tva.e_PersonName.elementize()}`,
line: CreditsItem.line(),
key: keys.k_InvalidElement,
});
if (foundOrganizationName.length > 0 && (foundPersonName.length > 0 || foundCharacter.length > 0))
errs.addError({
code: `${errCode}-55`,
message: `${tva.e_OrganizationName.elementize()} can only be present when ${tva.e_PersonName.elementize()} and ${tva.e_OrganizationName.elementize()} are absent in ${tva.e_CreditsItem.elementize()}`,
line: CreditsItem.line(),
key: keys.k_InvalidElement,
});
}
if (numCreditsItems > dvbi.MAX_CREDITS_ITEMS)
errs.addError({
code: `${errCode}-16`,
message: `a maximum of ${dvbi.MAX_CREDITS_ITEMS} ${tva.e_CreditsItem.elementize()} elements are permitted in ${tva.e_CreditsList.elementize()}`,
line: CreditsItem.line(),
key: `excess ${tva.e_CreditsItem.elementize()}`,
});
}
}
/**
* validate the <RelatedMaterial> elements specified
*
* @param {object} props Metadata of the XML document
* @param {XMLnode} BasicDescription the element whose children should be checked
* @param {Class} errs errors found in validaton
*/
/* private */ #ValidateRelatedMaterial_PromotionalStillImage(props, BasicDescription, errs) {
if (!BasicDescription) {
errs.addError({
type: APPLICATION,
code: "RMPSI000",
message: "ValidateRelatedMaterial_PromotionalStillImage() called with BasicDescription==null",
});
return;
}
let rm = 0,
RelatedMaterial;
while ((RelatedMaterial = BasicDescription.get(xPath(props.prefix, tva.e_RelatedMaterial, ++rm), props.schema)) != null)
ValidatePromotionalStillImage(RelatedMaterial, errs, "RMPSI001", BasicDescription.name().elementize(), this.#knownLanguages);
}
/**
* validate the <RelatedMaterial> elements containing pagination links
*
* @param {object} props Metadata of the XML document
* @param {XMLnode} BasicDescription the element whose children should be checked
* @param {Class} errs errors found in validaton
* @param {string} Location The location of the Basic Description element
*/
/* private */ #ValidateRelatedMaterial_Pagination(props, BasicDescription, errs, Location) {
if (!BasicDescription) {
errs.addError({
type: APPLICATION,
code: "VP000",
message: "ValidateRelatedMaterial_Pagination() called with BasicDescription==null",
});
return;
}
function checkLinkCounts(errs, elements, label, errCode) {
if (elements.length > 1) {
errs.addError({
code: errCode,
message: `more than 1 ${quote(`${label} pagination`)} link is specified`,
multiElementError: elements,
});
return true;
}
return false;
}