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
|
# Copyright (c) 2007-2011 Dominique Dumont.
#
# This file is part of Config-Model-Itself.
#
# Config-Model-Itself is free software; you can redistribute it
# and/or modify it under the terms of the GNU Lesser Public License
# as published by the Free Software Foundation; either version 2.1
# of the License, or (at your option) any later version.
#
# Config-Model-Itself is distributed in the hope that it will be
# useful, but WITHOUT ANY WARRANTY; without even the implied
# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the GNU Lesser Public License for more details.
#
# You should have received a copy of the GNU Lesser Public License
# along with Config-Model-Itself; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
use strict;
use warnings;
my @warp_in_string_like_parameter = (
warp => {
follow => {
'type' => '?type',
'vtype' => '?value_type',
},
'rules' => [
'$type eq "leaf" and ($vtype eq "uniline" or $vtype eq "string" or $vtype eq "enum")'
=> { level => 'normal', }
]
},
);
my %warn_if_match_payload = (
type => 'hash',
index_type => 'string',
level => 'hidden',
cargo => {
type => 'node',
config_class_name => 'Itself::CommonElement::WarnIfMatch',
},
@warp_in_string_like_parameter,
);
my @warp_in_leaf_parameter = (
warp => {
follow => {
'type' => '?type',
'vtype' => '?value_type',
},
'rules' => [
'$type eq "leaf"' => { level => 'normal', }
]
},
);
my %warn_if = (
type => 'hash',
index_type => 'string',
level => 'hidden',
cargo => {
type => 'node',
config_class_name => 'Itself::CommonElement::WarnIfMatch',
},
@warp_in_leaf_parameter,
);
my %assert_payload = (
type => 'hash',
index_type => 'string',
level => 'hidden',
cargo => {
type => 'node',
config_class_name => 'Itself::CommonElement::Assert',
},
@warp_in_leaf_parameter,
);
return [
[
name => 'Itself::CommonElement::WarnIfMatch',
element => [
msg => {
type => 'leaf',
value_type => 'string',
description =>
'Warning message to show user. "$_" contains the bad value. Example "value $_ is bad". Leave blank or undef to use generated message',
},
fix => {
type => 'leaf',
value_type => 'string',
description =>
'Perl instructions to fix the value. These instructions may be triggered by user. $_ contains the value to fix. $_ is stored as the new value once the instructions are done. C<$self> contains the value object. Use with care.',
},
],
],
[
name => 'Itself::CommonElement::Assert',
include => 'Itself::CommonElement::WarnIfMatch',
include_after => 'code',
element => [
code => {
type => 'leaf',
value_type => 'string',
description =>
'Perl instructions to test the value. $_ contains the value to test. C<$self> contains the value object. Use with care.',
},
],
],
[
name => 'Itself::CommonElement',
# warp often depend on this one, so list it first
'element' => [
'mandatory' => {
type => 'leaf',
value_type => 'boolean',
level => 'hidden',
warp => {
follow => '?type',
'rules' => {
'leaf' => {
upstream_default => 0,
level => 'normal',
}
}
}
},
# node element (may be within a hash or list)
'config_class_name' => {
type => 'leaf',
level => 'hidden',
value_type => 'reference',
refer_to => '! class',
warp => {
follow => { t => '?type' },
rules => [
'$t eq "warped_node" ' => {
# should be able to warp refer_to ??
level => 'normal',
},
'$t eq "node"' => {
# should be able to warp refer_to ??
level => 'normal',
mandatory => 1,
},
]
}
},
# warped_node: warp parameter for warped_node. They must be
# warped out when type is not a warped_node
# end warp elements for warped_node
# leaf element
'choice' => {
type => 'list',
level => 'hidden',
description => 'Specify the possible values of an enum. This can also be used in a '
.'reference element so the possible enum value will be the combination of the '
.'specified choice and the referred to values',
warp => {
follow => {
t => '?type',
vt => '?value_type',
},
'rules' => [
' ($t eq "leaf" and ( $vt eq "enum"
or $vt eq "reference")
)
or $t eq "check_list"' => { level => 'normal', },
]
},
cargo => { type => 'leaf', value_type => 'uniline' },
},
'min' => {
type => 'leaf',
value_type => 'number',
level => 'hidden',
description => 'minimum value',
warp => {
follow => {
'type' => '?type',
'vtype' => '?value_type',
},
'rules' => [
' $type eq "leaf"
and ( $vtype eq "integer"
or $vtype eq "number"
)
'
=> { level => 'normal', }
]
}
},
'max' => {
type => 'leaf',
value_type => 'number',
level => 'hidden',
description => 'maximum value',
warp => {
follow => {
'type' => '?type',
'vtype' => '?value_type',
},
'rules' => [
' $type eq "leaf"
and ( $vtype eq "integer"
or $vtype eq "number"
)
'
=> { level => 'normal', }
]
}
},
'min_index' => {
type => 'leaf',
value_type => 'integer',
level => 'hidden',
description => 'minimum number of keys',
warp => {
follow => { 'type' => '?type', },
'rules' => [
'$type eq "hash"' =>
{ level => 'normal', },
]
}
},
'max_index' => {
type => 'leaf',
value_type => 'integer',
level => 'hidden',
description => 'maximum number of keys',
warp => {
follow => { 'type' => '?type', },
'rules' => [
'$type eq "hash" or $type eq "list"' =>
{ level => 'normal', },
]
}
},
'default' => {
type => 'leaf',
level => 'hidden',
value_type => 'string',
description => 'Specify default value. This default value is written '
.'in the configuration data',
warp => {
follow => { 't' => '?type' },
'rules' => [ '$t eq "leaf"' => { level => 'normal', } ]
}
},
'upstream_default' => {
type => 'leaf',
level => 'hidden',
value_type => 'string',
description =>
'Another way to specify a default value. But this default value is considered as "built_in" the application and is not written in the configuration data (unless modified)',
warp => {
follow => { 't' => '?type' },
'rules' => [ '$t eq "leaf"' => { level => 'normal', } ]
}
},
'convert' => {
type => 'leaf',
value_type => 'enum',
level => 'hidden',
description => 'Convert value or index to uppercase (uc) or lowercase (lc).',
warp => {
follow => { 't' => '?type' },
'rules' => [
'$t eq "leaf" or $t eq "hash"' => {
choice => [qw/uc lc/],
level => 'normal',
}
]
}
},
'match' => {
type => 'leaf',
value_type => 'uniline',
level => 'hidden',
description =>
'Perl regular expression to assert the validity of the value. To check the '
. q!whole value, use C<^> and C<$>. For instance C<^foo|bar$> allows !
. q!C<foo> or C<bar> but not C<foobar>. To be case insentive, !
. q!use the C<(?i)> extended pattern. For instance, the regexp !
. q!C<^(?i)foo|bar$> also allows the values !
. q!C<Foo> and C<Bar>.!,
@warp_in_string_like_parameter,
},
'assert' => {
%assert_payload,
description =>
'Raise an error if the test code snippet does returns false. Note this snippet is '
. 'also run on undefined value, which may not be what you want.',
},
'warn_if' => {
%assert_payload,
description => 'Warn user if the code snippet returns true',
},
'warn_unless' => {
%assert_payload,
description =>
'Warn user if the code snippet returns false',
},
'warn_if_match' => {
%warn_if_match_payload,
description =>
'Warn user if a I<defined> value matches the regular expression. ',
},
'warn_unless_match' => {
%warn_if_match_payload,
description =>
'Warn user if I<defined> value does not match the regular expression',
},
'warn' => {
type => 'leaf',
value_type => 'string',
level => 'hidden',
description =>
'Unconditionally issue a warning with this string when this parameter is used. This should be used mostly with "accept"',
warp => {
follow => { t => '?type' },
'rules' => [ '$t eq "leaf"' => { level => 'normal', }, ]
},
},
'grammar' => {
type => 'leaf',
value_type => 'string',
level => 'hidden',
description =>
"Feed this grammar to Parse::RecDescent to perform validation",
@warp_in_string_like_parameter,
},
'default_list' => {
type => 'check_list',
level => 'hidden',
refer_to => '- choice',
description => 'Specify items checked by default',
warp => {
follow => { t => '?type', o => '?ordered' },
'rules' => [
'$t eq "check_list" and not $o ' =>
{ level => 'normal', },
'$t eq "check_list" and $o ' => {
level => 'normal',
ordered => 1,
},
]
},
},
'upstream_default_list' => {
type => 'check_list',
level => 'hidden',
refer_to => '- choice',
description =>
'Specify items checked by default in the application',
warp => {
follow => { t => '?type', o => '?ordered' },
'rules' => [
'$t eq "check_list" and not $o ' =>
{ level => 'normal', },
'$t eq "check_list" and $o ' => {
level => 'normal',
ordered => 1,
},
]
},
},
# hash element
# list element
],
],
];
|
