lib/CallBackery/Config.pm

filter: Statementstmt 63.1% 285 / 451 Branchbran 37.5% 42 / 112 Conditioncond 51.4% 36 / 70 MC/DCmcdc 24.3% 9 / 37 Subroutinesub 77.9% 53 / 68 Podpod 66.6% 10 / 15 totaltotal 57.7% 435 / 753 CC 103 SCAR 24.5
CC
103
Cov
57%
unConfigure
55.6
restoreConfigBlob
32.2
_stageAndRestoreDb
29.0
CRAP 11.6
« lib/CallBackery/User.pm ↑ Summary lib/CallBackery/GuiPlugin/Users.pm »
1 # $Id: Config.pm 539 2013-12-09 22:28:11Z oetiker $
2 package CallBackery::Config;
3  
4 =head1 NAME
5  
6 CallBackery::Config - get parse configuration file for CallBackery
7  
8 =head1 SYNOPSIS
9  
10 use Nq::Config;
11 my $cfg = CallBackery::Config->new(file=>$file);
12 my $hash_ref = $cfg->cfgHash();
13 my $pod = $cfg->pod();
14  
15 =head1 DESCRIPTION
16  
17 CallBackery gets much of its configuration from this config file.
18  
19 =cut
20  
21 13 ▶use Mojo::Base -base,-async_await, -signatures;
Subroutine BEGIN: called CC=1 SCAR=0.0
22 13 ▶use CallBackery::Exception qw(mkerror);
Subroutine BEGIN: called CC=1 SCAR=0.0
23 13 ▶use CallBackery::Translate qw(trm);
Subroutine BEGIN: called CC=1 SCAR=0.0
24 13 ▶use Config::Grammar::Dynamic;
Subroutine BEGIN: called CC=1 SCAR=0.0
25 13 ▶use Carp;
Subroutine BEGIN: called CC=1 SCAR=0.0
26 13 ▶use Fcntl qw(O_WRONLY O_CREAT O_EXCL);
Subroutine BEGIN: called CC=1 SCAR=0.0
27 13 ▶use autodie;
Subroutine BEGIN: called CC=1 SCAR=0.0
28 13 ▶use DBI;
Subroutine BEGIN: called CC=1 SCAR=0.0
29 13 ▶use DBD::SQLite::Constants qw(SQLITE_ATTACH SQLITE_FUNCTION SQLITE_PRAGMA SQLITE_DENY SQLITE_OK);
Subroutine BEGIN: called CC=1 SCAR=0.0
30 13 ▶use File::Spec;
Subroutine BEGIN: called CC=1 SCAR=0.0
31 13 ▶use Locale::PO;
Subroutine BEGIN: called CC=1 SCAR=0.0
32 13 ▶use Mojo::Promise;
Subroutine BEGIN: called CC=1 SCAR=0.0
33 13 ▶use Mojo::Loader qw(load_class);
Subroutine BEGIN: called CC=1 SCAR=0.0
34 13 ▶use Mojo::JSON qw(true false);
Subroutine BEGIN: called CC=1 SCAR=0.0
35 13 ▶use Mojo::Exception;
Subroutine BEGIN: called CC=1 SCAR=0.0
36 13 ▶use Mojo::Util qw(encode secure_compare);
Subroutine BEGIN: called CC=1 SCAR=0.0
37 13 ▶use Digest::SHA qw(hmac_sha256);
Subroutine BEGIN: called CC=1 SCAR=0.0
38 13 ▶use Scalar::Util qw(blessed);
Subroutine BEGIN: called CC=1 SCAR=0.0
39 13 ▶use Time::HiRes;
Subroutine BEGIN: called CC=1 SCAR=0.0
40 # use Devel::Cycle;
41  
42 =head2 file
43  
44 the name of the config file
45  
46 =cut
47  
48 0 ▶has file => sub { croak "the file parameter is mandatory" };
Subroutine __ANON__: not called CC=1 SCAR=1.2
49  
50 18 ▶has secretFile => sub ($self) {
Subroutine __ANON__: called CC=1 SCAR=0.0
51 18 my $secretFile = $self->file.'.secret';
52 18 $self->_writeSecretFile($secretFile);
53 18 return $secretFile;
54 13 };
55  
56 18 ▶sub _writeSecretFile ($self,$secretFile) {
Subroutine _writeSecretFile: called CC=9 SCAR=22.6
57 18 ▶ if (-f $secretFile) {
Branch: 1 branch
BranchTrueFalseTotal
if (-f $secretFile) 5 13 18
58 # replace an empty secret or one made by the old rand() generator;
59 # a secret written by hand is kept
60 5 ▶ return if not -r _ or -s _ > 24;
Branch: 1 branch
BranchTrueFalseTotal
if not -r _ or -s _ > 24 1 4 5
Condition66%2/3
not -r _ or -s _ > 24
l!l&&r!l&&!r
014
MC/DC50%1/2
not -r _ or -s _ > 24
not -r _ -s _ > 24
Truth table66%2/3
not(A) or B
A= not -r _B= -s _ > 24
ABresult
1X1
011
000
61 4 open my $old, '<', $secretFile;
62 4 ▶ my $line = <$old> // '';
Condition100%2/2
readline $old // ""
l!l
31
MC/DC100%1/1
readline $old // ""
readline $old
Truth table100%2/2
A
A= readline $old
Aresult
11
00
63 4 close $old;
64 4 ▶ return if $line ne '' and not $self->_isRandSecret($line);
Branch: 1 branch
BranchTrueFalseTotal
if $line ne "" and not $self->_isRandSecret($line) 2 2 4
Condition100%3/3
$line ne "" and not $self->_isRandSecret($line)
!ll&&!rl&&r
112
MC/DC100%2/2
$line ne "" and not $self->_isRandSecret($line)
$line ne "" not $self->_isRandSecret($line)
Truth table100%3/3
A and not(B)
A= $line ne ""B= not $self->_isRandSecret($line)
ABresult
0X0
100
111
65 13 ▶ no autodie;
Subroutine BEGIN: called CC=1 SCAR=0.0
66 2 ▶ if (not unlink $secretFile) {
Branch: 1 branch
BranchTrueFalseTotal
unless (unlink $secretFile) 0 2 2
67 0 ▶ croak "cannot replace the empty secret file $secretFile: $!" if $line eq '';
Branch: 1 branch
BranchTrueFalseTotal
if $line eq "" 0 0 0
68 0 carp "cannot replace the weak secret in $secretFile: $!";
69 0 return;
70 }
71 }
72 15 my $secret = unpack('H*',$self->_randomBytes(32));
73 15 sysopen my $fh, $secretFile, O_WRONLY|O_CREAT|O_EXCL, 0600;
74 15 print $fh $secret;
75 15 close $fh;
76 15 chmod 0400,$secretFile;
77 }
78  
79 # The old generator wrote sprintf('%x%x',int(rand()*1e14),int(rand()*1e14)).
80 # Perl's rand() is drand48: the state x is 48 bits, rand() returns x/2**48
81 # and the next state is (0x5DEECE66D*x + 0xB) mod 2**48. The first number
82 # leaves about three possible states; a secret is from the old generator
83 # when one of them gives the second number. A hand written secret matches
84 # by chance about once in 10**13.
85 3 ▶sub _isRandSecret ($self,$secret) {
Subroutine _isRandSecret: called CC=12 SCAR=25.2
86 3 ▶ return 0 if $secret !~ /\A[0-9a-f]{2,24}\z/;
Branch: 1 branch
BranchTrueFalseTotal
unless $secret =~ /\A[0-9a-f]{2,24}\z/u 0 3 3
87 13 ▶ no warnings 'portable'; # hex() above 32 bits
Subroutine BEGIN: called CC=1 SCAR=0.0
88 3 for my $cut (1 .. length($secret) - 1) {
89 42 my ($first,$second) = (substr($secret,0,$cut),substr($secret,$cut));
90 42 ▶ next if grep { /\A0./ or length > 12 } $first, $second;
Branch: 1 branch
BranchTrueFalseTotal
if grep {/\A0./u or length $_ > 12;} $first, $second 33 9 42
Condition66%2/3
/\A0./u || length $_ > 12
l!l&&r!l&&!r
03351
MC/DC50%1/2
/\A0./u || length $_ > 12
/\A0./u length $_ > 12
Truth table66%2/3
A || B
A= /\A0./uB= length $_ > 12
ABresult
1X1
011
000
91 9 ($first,$second) = (hex $first,hex $second);
92 9 ▶ next if $first >= 1e14 or $second >= 1e14;
Branch: 1 branch
BranchTrueFalseTotal
if $first >= "100000000000000" or $second >= "100000000000000" 1 8 9
Condition66%2/3
$first >= "100000000000000" or $second >= "100000000000000"
l!l&&r!l&&!r
108
MC/DC50%1/2
$first >= "100000000000000" or $second >= "100000000000000"
$first >= "100000000000000" $second >= "100000000000000"
Truth table66%2/3
A or B
A= $first >= "100000000000000"B= $second >= "100000000000000"
ABresult
1X1
011
000
93 8 my $guess = int($first * 2**48 / 1e14);
94 8 for my $x ($guess - 2 .. $guess + 3) {
95 48 ▶ next if $x < 0 or $x >= 2**48 or int($x / 2**48 * 1e14) != $first;
Branch: 1 branch
BranchTrueFalseTotal
if $x < 0 or $x >= "281474976710656" or int $x / "281474976710656" * "100000000000000" != $first 25 23 48
Condition50%3/6
$x < 0 or $x >= "281474976710656" or int $x / "281474976710656" * "100000000000000" != $first
l!l&&r!l&&!r
02523
$x < 0 or $x >= "281474976710656"
l!l&&r!l&&!r
0048
MC/DC33%1/3
$x < 0 or $x >= "281474976710656" or int $x / "281474976710656" * "100000000000000" != $first
$x < 0 $x >= "281474976710656" int $x / "281474976710656" * "100000000000000" != $first
Truth table50%2/4
A or B or C
A= $x < 0B= $x >= "281474976710656"C= int $x / "281474976710656" * "100000000000000" != $first
ABCresult
1XX1
01X1
0011
0000
96 # (0x5DEECE66D*x + 0xB) mod 2**48 in 24 bit halves, so it fits in 64 bits
97 23 my ($xh,$xl) = (int($x / 2**24),$x % 2**24);
98 23 my $lo = 0xECE66D * $xl + 0xB;
99 23 my $hi = (0x5DE * $xl + 0xECE66D * $xh + int($lo / 2**24)) % 2**24;
100 23 my $next = $hi * 2**24 + $lo % 2**24;
101 23 ▶ return 1 if int($next / 2**48 * 1e14) == $second;
Branch: 1 branch
BranchTrueFalseTotal
if int $next / "281474976710656" * "100000000000000" == $second 1 22 23
102 }
103 }
104 2 return 0;
105 }
106  
107 0 ▶has app => sub { croak "the app parameter is mandatory" }, weak => 1;
Subroutine __ANON__: not called CC=1 SCAR=1.2
108  
109 12 ▶has log => sub {
Subroutine __ANON__: called CC=1 SCAR=0.0
110 12 shift->app->log;
111 13 };
112  
113 =head2 cfgHash
114  
115 a hash containing the data from the config file
116  
117 =cut
118  
119 12 ▶has cfgHash => sub {
Subroutine __ANON__: called CC=2 SCAR=7.0
120 12 my $self = shift;
121 12 my $cfg_file = shift;
122 12 my $parser = $self->makeParser();
123 12 ▶ my $cfg = $parser->parse($self->file, {encoding => 'utf8'}) or croak($parser->{err});
Branch: 1 branch
BranchTrueFalseTotal
my $cfg = $parser->parse($self->file, {"encoding", "utf8"}) or croak($parser->{"err"}) 12 0 12
124 # the grammar is self referential, so we need to clean it up
125 12 $self->grammar(undef);
126 12 return $cfg;
127 13 };
128  
129 =head2 pod
130  
131 returns a pod documenting the config file
132  
133 =cut
134  
135 0 ▶has pod => sub {
Subroutine __ANON__: not called CC=1 SCAR=6.9
136 0 my $self = shift;
137 0 my $parser = $self->makeParser();
138 0 my $E = '=';
139 0 my $footer = <<"FOOTER";
140  
141 ${E}head1 COPYRIGHT
142  
143 Copyright (c) 2014 by OETIKER+PARTNER AG. All rights reserved.
144  
145 ${E}head1 AUTHOR
146  
147 S<Tobias Oetiker E<lt>tobi\@oetiker.chE<gt>>
148 S<Fritz Zaucker E<lt>fritz.zaucker\@oetiker.chE<gt>>
149  
150 ${E}head1 HISTORY
151  
152 2014-01-11 to 1.0 first version
153 2014-04-29 fz 1.1 implement plugin path
154  
155 FOOTER
156 0 my $header = <<"HEADER";
157 ${E}head1 NAME
158  
159 callbackery.cfg - The Appliance FRONTEND Builder config file
160  
161 ${E}head1 SYNOPSIS
162  
163 *** BACKEND ***
164 log_file = /tmp/nw-tobi.log
165  
166 *** FRONTEND ***
167 logo = logo.png
168 spinner = myspinner.gif
169 logo_small = logo-small.png
170 title = Appliance Configurator
171  
172 ${E}head1 DESCRIPTION
173  
174 The afb.cfg provides all the info for afb and its gui modules to interact with your appliance.
175  
176 ${E}head1 CONFIGURATION
177  
178 HEADER
179 0 return $header.$parser->makepod().$footer;
180 13 };
181  
182 =head2 pluginPath
183  
184 array of name spaces to look for gui plugins
185  
186 =cut
187  
188 12 ▶has pluginPath => sub { ['CallBackery::GuiPlugin']; };
Subroutine __ANON__: called CC=1 SCAR=0.0
189  
190 =head2 B<loadAndNewPlugin>('PluginModule')
191  
192 Find the given module in the F<pluginPath>, load it and create a first instance.
193  
194 =cut
195  
196  
197 48 ▶sub loadAndNewPlugin {
Subroutine loadAndNewPlugin: called CC=4 SCAR=15.2
Pod documented
198 48 my $self = shift;
199 48 my $plugin = shift;
200  
201 48 my $module;
202 my $ok;
203 48 for my $path (@{$self->pluginPath}) {
204 #$self->log->debug("looking for $plugin in $path");
205 48 ▶ if (my $e = load_class "${path}::$plugin") {
Branch: 1 branch
BranchTrueFalseTotal
if (my $e = load_class("${path}::$plugin")) { } 0 48 48
206 0 ▶ die mkerror(3894,"Loading ${path}::$plugin: $e") if ref $e;
Branch: 1 branch
BranchTrueFalseTotal
if ref $e 0 0 0
207 } else {
208 48 my $proto = "${path}::${plugin}"->new(log=>$self->log);
209 48 $proto->{prototype} = 1;
210 48 return $proto;
211 }
212 }
213 0 die mkerror(123, "Plugin Module $plugin not found");
214 };
215  
216 12 ▶has grammar => sub {
Subroutine __ANON__: called CC=4 SCAR=18.1
217 12 my $self = shift;
218  
219 12 my $pluginList = {};
220 12 my $pluginPath = $self->pluginPath;
221 12 for my $path (@INC){
222 120 for my $pPath (@$pluginPath) {
223 120 my @pDirs = split /::/, $pPath;
224 120 my $fPath = File::Spec->catdir($path, @pDirs, '*.pm');
225 120 for my $file (glob($fPath)) {
226 288 my ($volume, $modulePath, $moduleName) = File::Spec->splitpath($file);
227 288 $moduleName =~ s{\.pm$}{};
228 288 $pluginList->{$moduleName} = 'Plugin Module';
229 }
230 }
231 }
232 return {
233 _sections => [ qw(BACKEND FRONTEND FRONTEND-COLORS /PLUGIN:\s*\S+/)],
234 _mandatory => [qw(BACKEND FRONTEND)],
235 BACKEND => {
236 _doc => 'BACKEND Settings',
237 _vars => [ qw(log_file cfg_db sesame_user sesame_pass max_session_age) ],
238 _mandatory => [ qw(cfg_db sesame_user sesame_user) ],
239 log_file => { _doc => 'write a log file to this location (unless in development mode)'},
240 cfg_db => { _doc => 'file to store the config database'},
241 sesame_user => { _doc => <<'DOC'},
242 In Open Sesame mode, one has to use this username to get access to the system.
243 The password you enter does not matter.
244 DOC
245 sesame_pass => { _doc => <<'DOC'},
246 Using sesame_user and sesame_pass, the system can always be accessed.
247 In default configuration sesame_pass is NOT set.
248 DOC
249 max_session_age => {
250 _doc => <<'DOC',
251 End a session this many seconds after the login that started it; the user
252 has to log in again. Logging out does not invalidate a session cookie that
253 was already issued, so this limit is what ends it. Default: no limit.
254 DOC
255 _re => '\d+',
256 _re_error => 'expected a number of seconds',
257 },
258 },
259 FRONTEND => {
260 _doc => 'Settings for the Web FRONTEND',
261 _vars => [ qw(logo logo_small logo_noscale spinner title initial_plugin company_name company_url company_support
262 hide_password hide_password_icon hide_release hide_company max_width
263 )
264 ],
265 logo => {
266 _doc => 'url for the logo brand the login sceen',
267 },
268 company_name => {
269 _doc => 'who created the app',
270 },
271 company_url => {
272 _doc => 'link to the company homepage'
273 },
274 max_width => {
275 _doc => 'maximum content width'
276 },
277 company_support => {
278 _doc => 'company support eMail'
279 },
280 logo_small => {
281 _doc => 'url for the small logo brand the UI',
282 },
283 logo_noscale => {
284 _doc => "don't scale logo on login window",
285 _re => '(yes|no|true|false)',
286 _re_error => 'pick yes or no OR true or false',
287 0 ▶ _sub => sub {
Subroutine __ANON__: not called CC=2 SCAR=17.9
288 0 ▶ $_[0] = ($_[0] =~ /yes|true/) ? true : false;
Branch: 1 branch
BranchTrueFalseTotal
$_[0] =~ /yes|true/u ? : 0 0 0
289 0 return;
290 },
291 },
292 spinner => {
293 _doc => 'url for the busy animation spinner gif',
294 },
295 title => {
296 _doc => 'title string for the application'
297 },
298 initial_plugin => {
299 _doc => 'which tab should be active upon login ?'
300 },
301 hide_password => {
302 _doc => 'hide password field on login screen',
303 _re => '(yes|no|true|false)',
304 _re_error => 'pick yes or no OR true or false',
305 0 ▶ _sub => sub {
Subroutine __ANON__: not called CC=2 SCAR=17.9
306 0 ▶ $_[0] = ($_[0] =~ /yes|true/) ? true : false;
Branch: 1 branch
BranchTrueFalseTotal
$_[0] =~ /yes|true/u ? : 0 0 0
307 0 return;
308 },
309 },
310 hide_password_icon => {
311 _doc => 'hide password icon on login screen',
312 _re => '(yes|no|true|false)',
313 _re_error => 'pick yes or no OR true or false',
314 0 ▶ _sub => sub {
Subroutine __ANON__: not called CC=2 SCAR=17.9
315 0 ▶ $_[0] = ($_[0] =~ /yes|true/) ? true : false;
Branch: 1 branch
BranchTrueFalseTotal
$_[0] =~ /yes|true/u ? : 0 0 0
316 0 return;
317 },
318 },
319 hide_release => {
320 _doc => 'hide release string on login screen',
321 _re => '(yes|no|true|false)',
322 _re_error => 'pick yes or no OR true or false',
323 0 ▶ _sub => sub {
Subroutine __ANON__: not called CC=2 SCAR=17.9
324 0 ▶ $_[0] = ($_[0] =~ /yes|true/) ? true : false;
Branch: 1 branch
BranchTrueFalseTotal
$_[0] =~ /yes|true/u ? : 0 0 0
325 0 return;
326 },
327 },
328 hide_company => {
329 _doc => 'hide company string on login screen',
330 _re => '(yes|no|true|false)',
331 _re_error => 'pick yes or no OR true or false',
332 0 ▶ _sub => sub {
Subroutine __ANON__: not called CC=2 SCAR=17.9
333 0 ▶ $_[0] = ($_[0] =~ /yes|true/) ? true : false;
Branch: 1 branch
BranchTrueFalseTotal
$_[0] =~ /yes|true/u ? : 0 0 0
334 0 return;
335 },
336 },
337 },
338 'FRONTEND-COLORS' => {
339 _vars => [ '/[a-zA-Z]\S+/' ],
340 '/[a-zA-Z]\S+/' => {
341 _doc => <<COLORKEYS_END,
342 Use this section to override any color key used in the qooxdoo simple theme as well as the following:
343 C<tabview-page-background>,
344 C<tabview-page-border>,
345 C<tabview-button-background>,
346 C<tabview-button-checked-background>,
347 C<tabview-button-text>,
348 C<tabview-button-checked-text>,
349 C<tabview-button-border>,
350 C<tabview-button-checked-border>.
351 C<textfield-readonly>.
352  
353 The keys can be set to standard web colors C<rrggbb> or to other key names.
354 COLORKEYS_END
355 _example => <<EXAMPLE_END,
356 ff0000
357 EXAMPLE_END
358 0 ▶ _sub => sub {
Subroutine __ANON__: not called CC=2 SCAR=17.9
359 0 ▶ if ($_[0] =~ /^\s*([0-9a-f]{3,6})\s*$/i){
Branch: 1 branch
BranchTrueFalseTotal
if ($_[0] =~ /^\s*([0-9a-f]{3,6})\s*$/iu) 0 0 0
360 0 $_[0] = '#'.lc($1);
361 }
362 0 return undef;
363 }
364 }
365 },
366 '/PLUGIN:\s*\S+/' => {
367 _order => 1,
368 _doc => 'Plugins providing appliance specific funtionality',
369 _vars => [qw(module)],
370 _mandatory => [qw(module)],
371 module => {
372 24 ▶ _sub => sub {
Subroutine __ANON__: called CC=2 SCAR=7.4
373 24 eval {
374 24 $_[0] = $self->loadAndNewPlugin($_[0]);
375 };
376 24 ▶ if ($@){
Branch: 1 branch
BranchTrueFalseTotal
if ($@) 0 24 24
377 0 return "Failed to load Plugin $_[0]: $@";
378 }
379 24 return undef;
380 },
381 24 ▶ _dyn => sub {
Subroutine __ANON__: called CC=3 SCAR=11.0
382 24 my $var = shift;
383 24 my $module = shift;
384 24 ▶ $module = $self->loadAndNewPlugin($module) if not ref $module;
Branch: 1 branch
BranchTrueFalseTotal
unless ref $module 0 24 24
385 24 my $tree = shift;
386 24 my $grammar = $module->grammar();
387 24 push @{$grammar->{_vars}}, 'module';
388 24 for my $key (keys %$grammar){
389 120 $tree->{$key} = $grammar->{$key};
390 }
391 },
392 12 _dyndoc => $pluginList,
393 },
394 }
395 };
396 13 };
397  
398 12 ▶sub makeParser {
Subroutine makeParser: called CC=1 SCAR=0.0
Pod undocumented
399 12 my $self = shift;
400 12 my $parser = Config::Grammar::Dynamic->new($self->grammar);
401 12 return $parser;
402 }
403  
404 =head2 getTranslations
405  
406 Load translations from po files
407  
408 =cut
409  
410 12 ▶sub getTranslations {
Subroutine getTranslations: called CC=6 SCAR=28.1
Pod documented
411 12 my $self = shift;
412 12 ▶ my $cfg = shift || {};
Condition50%1/2
shift() || {}
l!l
012
MC/DC0%0/1
shift() || {}
shift()
Truth table50%1/2
A
A= shift()
Aresult
11
00
413 12 my %lx;
414 12 ▶ my $path = $cfg->{path} // $self->app->home->rel_file("share");
Condition33%1/3
$cfg->{"path"} // $self->app->home->rel_file("share")
l!l&&r!l&&!r
0120
MC/DC0%0/2
$cfg->{"path"} // $self->app->home->rel_file("share")
$cfg->{"path"} $self->app->home->rel_file("share")
Truth table33%1/3
A // B
A= $cfg->{"path"}B= $self->app->home->rel_file("share")
ABresult
1X1
011
000
415 12 my $po = new Locale::PO();
416 12 for my $file (glob(File::Spec->catdir($path, '*.po'))) {
417 0 my ($volume, $localePath, $localeName) = File::Spec->splitpath($file);
418 0 my $locale = $localeName;
419 0 $locale =~ s/\.po$//;
420 0 my $lang = $locale;
421 0 $lang =~ s/_.+//;
422 0 local $_; # since load_file_ashash modifies $_ and does not localize it
423 0 my $href = Locale::PO->load_file_ashash($file, 'utf8');
424 0 for my $key (keys %$href) {
425 0 my $o = $href->{$key};
426 0 my $id = $po->dequote($o->msgid);
427 0 my $str = $po->dequote($o->msgstr);
428 0 ▶ next unless $id;
Branch: 1 branch
BranchTrueFalseTotal
unless $id 0 0 0
429 0 $lx{$locale}{$id} = $str;
430 }
431 }
432 12 return \%lx;
433 }
434  
435 =head2 postProcessCfg
436  
437 Post process the configuration data into a format that is easily used
438 by the application.
439  
440 =cut
441  
442 12 ▶sub postProcessCfg {
Subroutine postProcessCfg: called CC=9 SCAR=22.3
Pod documented
443 12 my $self = shift;
444 12 my $cfg = $self->cfgHash;
445 # only postprocess once
446 12 ▶ return $cfg if $cfg->{PLUGIN}{list};
Branch: 1 branch
BranchTrueFalseTotal
if $cfg->{"PLUGIN"}{"list"} 0 12 12
447 12 my %plugin;
448 my @pluginOrder;
449 12 for my $section (sort keys %$cfg){
450 84 my $sec = $cfg->{$section};
451 84 ▶ next unless ref $sec eq 'HASH'; # skip non hash stuff
Branch: 1 branch
BranchTrueFalseTotal
unless ref $sec eq "HASH" 12 72 84
452 72 for my $key (keys %$sec){
453 204 ▶ next unless ref $sec->{$key} eq 'HASH' and $sec->{$key}{_text};
Branch: 1 branch
BranchTrueFalseTotal
unless ref $sec->{$key} eq "HASH" and $sec->{$key}{"_text"} 204 0 204
Condition33%1/3
ref $sec->{$key} eq "HASH" and $sec->{$key}{"_text"}
!ll&&!rl&&r
20400
MC/DC0%0/2
ref $sec->{$key} eq "HASH" and $sec->{$key}{"_text"}
ref $sec->{$key} eq "HASH" $sec->{$key}{"_text"}
Truth table33%1/3
A and B
A= ref $sec->{$key} eq "HASH"B= $sec->{$key}{"_text"}
ABresult
0X0
100
111
454 0 $sec->{$key} = $sec->{$key}{_text};
455 }
456 72 ▶ if ($section =~ /^PLUGIN:\s*(.+)/){
Branch: 1 branch
BranchTrueFalseTotal
if ($section =~ /^PLUGIN:\s*(.+)/u) 24 48 72
457 24 my $name = $1;
458 24 $pluginOrder[$sec->{_order}] = $name;
459 24 delete $sec->{_order};
460 24 my $obj = $cfg->{PLUGIN}{prototype}{$name} = $sec->{module};
461 24 delete $sec->{module};
462 24 $obj->config($sec);
463 24 $obj->name($name);
464 24 $obj->app($self->app);
465 24 $obj->massageConfig($cfg);
466 # cleanup the config
467 24 delete $cfg->{$section};
468 }
469 72 $cfg->{PLUGIN}{list} = \@pluginOrder;
470 }
471 # rename section
472 # delete returns the value of the deleted hash element
473 12 ▶ if (exists $cfg->{'FRONTEND-COLORS'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $cfg->{"FRONTEND-COLORS"}) 12 0 12
474 12 $cfg->{FRONTEND}{COLORS} = $cfg->{'FRONTEND-COLORS'};
475 12 delete $cfg->{'FRONTEND-COLORS'};
476 }
477 12 $cfg->{FRONTEND}{TRANSLATIONS} = $self->getTranslations();
478 12 return $cfg;
479 }
480  
481 =head2 instantiatePlugin(pluginName,userObj,args)
482  
483 create a new instance of this plugin prototype
484  
485 =cut
486  
487 9 ▶sub _getPluginObject {
Subroutine _getPluginObject: called CC=3 SCAR=11.0
488 9 my $self = shift;
489 9 my $name = shift;
490  
491 9 my $user = shift;
492 9 my $args = shift;
493  
494 9 my $prototype = $self->cfgHash->{PLUGIN}{prototype}{$name};
495  
496 # clean the name
497 9 $name =~ s/[^-_0-9a-z]/_/gi;
498 9 ▶ die mkerror(39943,"No prototype for $name")
Branch: 1 branch
BranchTrueFalseTotal
unless defined $prototype 3 6 9
499 if not defined $prototype;
500 6 ▶ my $obj = $prototype->new(
Condition100%2/2
$args // {}
l!l
42
MC/DC100%1/1
$args // {}
$args
Truth table100%2/2
A
A= $args
Aresult
11
00
501 user => $user,
502 name => $prototype->name,
503 config => $prototype->config,
504 args => $args // {},
505 app => $self->app,
506 );
507 6 $obj->log; # make sure logging is initialized
508 6 return $obj;
509 }
510  
511 # do not (!!!) implement this with async/await as it causes the the generated
512 # object to be somehow get a problem with reference counting with prevents
513 # timely destruction of the object 2024-06-12 tobi
514 7 ▶sub instantiatePlugin_p {
Subroutine instantiatePlugin_p: called CC=1 SCAR=0.0
Pod undocumented
515 7 my $self = shift;
516 7 my $obj = $self->_getPluginObject(@_);
517 6 ▶ return $self->promisify($obj->checkAccess)->then(sub {
Subroutine __ANON__: called CC=2 SCAR=6.9
518 6 my $access = shift;
519 6 ▶ return $obj if $access;
Branch: 1 branch
BranchTrueFalseTotal
if $access 4 2 6
520 2 my $name = $obj->name;
521 2 Mojo::Promise->reject(mkerror(39944,"No permission to access $name"));
522 6 });
523 }
524  
525 2 ▶sub instantiatePlugin {
Subroutine instantiatePlugin: called CC=2 SCAR=10.9
Pod documented
526 2 my $self = shift;
527 2 my @args = @_;
528 2 my $obj = $self->_getPluginObject(@args);
529 0 my $name = $obj->name;
530 0 ▶ die mkerror(39944,"No permission to access $name")
Branch: 1 branch
BranchTrueFalseTotal
unless $self->promiseDeath($obj->checkAccess) 0 0 0
531 if not $self->promiseDeath($obj->checkAccess);
532 0 return $obj;
533 }
534  
535 =head2 $configBlob = $cfg->getConfigBlob()
536  
537 return the configuration state of the system as a blob
538  
539 The blob is encrypted with AES-256 and authenticated with HMAC-SHA256,
540 both keyed from the password with PBKDF2 and a random salt. Releases
541 before this format cannot restore it.
542  
543 =cut
544  
545 0 ▶has configPlugins => sub {
Subroutine __ANON__: not called CC=3 SCAR=24.8
546 0 my $self = shift;
547 0 my $user = $self->app->userObject->new(app=>$self->app,userId=>'__CONFIG', log=>$self->log);
548 0 my $cfg = $self->cfgHash;
549 0 my @plugins;
550 0 for my $name (@{$cfg->{PLUGIN}{list}}){
551 0 ▶ my $obj = eval {
Branch: 1 branch
BranchTrueFalseTotal
my $obj = eval { do { $self->instantiatePlugin($name, $user) } } or next 0 0 0
552 0 $self->instantiatePlugin($name,$user);
553 } or next;
554 0 push @plugins, $obj;
555 }
556 0 return \@plugins;
557 13 };
558  
559 12 ▶sub getCrypt {
Subroutine getCrypt: called CC=2 SCAR=7.0
Pod undocumented
560 12 require Crypt::Rijndael;
561 12 my $self = shift;
562 12 ▶ my $password = substr((shift || '').('x' x 32),0,32);
Condition50%1/2
shift() || ''
l!l
120
MC/DC0%0/1
shift() || ''
shift()
Truth table50%1/2
A
A= shift()
Aresult
11
00
563 12 return Crypt::Rijndael->new( $password,Crypt::Rijndael::MODE_CBC() );
564 }
565  
566 6 ▶sub pack16 {
Subroutine pack16: called CC=1 SCAR=0.0
Pod undocumented
567 6 my $self = shift;
568 6 my $string = shift;
569 6 my $len = length($string);
570 6 my $mod = 16 - ($len % 16);
571 6 return sprintf("%016x%s",$len,$string.('x' x $mod));
572 }
573  
574 6 ▶sub unpack16 {
Subroutine unpack16: called CC=3 SCAR=12.3
Pod undocumented
575 6 my $self = shift;
576 6 my $string = shift;
577 6 my $len = substr($string,0,16);
578 6 ▶ if ( $len !~ /^[0-9a-f]{16}$/ or hex($len) > length($string)-16 ){
Branch: 1 branch
BranchTrueFalseTotal
if (not $len =~ /^[0-9a-f]{16}$/u or hex $len > length($string) - 16) 0 6 6
Condition33%1/3
not $len =~ /^[0-9a-f]{16}$/u or hex $len > length($string) - 16
l!l&&r!l&&!r
006
MC/DC0%0/2
not $len =~ /^[0-9a-f]{16}$/u or hex $len > length($string) - 16
not $len =~ /^[0-9a-f]{16}$/u hex $len > length($string) - 16
Truth table33%1/3
not(A) or B
A= not $len =~ /^[0-9a-f]{16}$/uB= hex $len > length($string) - 16
ABresult
1X1
011
000
579 0 die mkerror(3844,trm("Wrong password!"));
580 }
581 6 return substr($string,16,hex($len));
582 }
583  
584 # PBKDF2-HMAC-SHA256 rounds for the backup key; part of the CBK2 format
585 13 my $BLOB_KDF_ROUNDS = 100_000;
586  
587 15 ▶sub _randomBytes ($self,$n) {
Subroutine _randomBytes: called CC=2 SCAR=7.1
588 15 open my $fh, '<:raw', '/dev/urandom';
589 15 ▶ read($fh, my $bytes, $n) == $n or croak "short read from /dev/urandom";
Branch: 1 branch
BranchTrueFalseTotal
&CallBackery::Config::read($fh, \my $bytes, $n) == $n or croak("short read from /dev/urandom") 15 0 15
590 15 return $bytes;
591 }
592  
593 0 ▶sub _blobKeys ($self,$password,$salt) {
Subroutine _blobKeys: not called CC=3 SCAR=24.8
594 0 ▶ $password = encode('UTF-8',$password // '');
Condition0%0/2
$password // ""
l!l
00
MC/DC0%0/1
$password // ""
$password
Truth table0%0/2
A
A= $password
Aresult
11
00
595 0 my $u = my $key = hmac_sha256($salt.pack('N',1),$password);
596 0 for (2..$BLOB_KDF_ROUNDS) {
597 0 $u = hmac_sha256($u,$password);
598 0 $key ^= $u;
599 }
600 0 return (hmac_sha256('encrypt',$key), hmac_sha256('authenticate',$key));
601 }
602  
603 1 ▶sub getConfigBlob {
Subroutine getConfigBlob: called CC=4 SCAR=25.2
Pod documented
604 1 my $self = shift;
605 1 my $password = shift;
606 1 require Archive::Zip;
607  
608 1 my $zip = Archive::Zip->new();
609 1 my $cfg = $self->cfgHash;
610 # read the dump from a pipe; a file in /tmp would leave the secrets behind
611 1 open my $dump, '-|','/usr/bin/sqlite3',$cfg->{BACKEND}{cfg_db},'.dump';
612 0 my $sql = do { local $/; <$dump> };
613 0 close $dump;
614 0 $zip->addString($sql,'{DATABASEDUMP}')
615 ->desiredCompressionMethod(Archive::Zip::COMPRESSION_DEFLATED());
616 0 for my $obj (@{$self->configPlugins}){
617 0 my $name = $obj->name;
618 0 for my $file (@{$obj->stateFiles}) {
619 0 ▶ if (-r $file){
Branch: 1 branch
BranchTrueFalseTotal
if (-r $file) 0 0 0
620 0 $zip->addFile({
621 filename => $file,
622 zipName => '{PLUGINSTATE.'.$name.'}'.$file
623 })
624 }
625 }
626 }
627 0 my $zipData;
628 0 open(my $fh, ">", \$zipData);
629 0 $zip->writeToFileHandle($fh,0);
630  
631 0 require Crypt::Rijndael;
632 0 my $salt = $self->_randomBytes(16);
633 0 my $iv = $self->_randomBytes(16);
634 0 my ($encKey,$macKey) = $self->_blobKeys($password,$salt);
635 0 my $crypt = Crypt::Rijndael->new($encKey,Crypt::Rijndael::MODE_CBC());
636 0 $crypt->set_iv($iv);
637 0 my $blob = 'CBK2'.$salt.$iv.$crypt->encrypt($self->pack16($zipData));
638 0 return $blob.hmac_sha256($blob,$macKey);
639 }
640  
641 # how long to keep trying when someone else holds a lock on the config
642 # database; package scoped so that tests can shorten it
643 13 our $RESTORE_BUSY_TIMEOUT_MS = 30_000;
644  
645 # Build a replacement config database with $builder and then copy it over the
646 # live one with SQLite's online backup API, so that the database keeps its
647 # inode.
648 #
649 # Replacing the file instead (the way this used to work) leaves every long
650 # lived handle in the system attached to the old, now unlinked inode: the
651 # config daemon and its workers, the application server, and any helper that
652 # happens to be running at the time. Those handles go on reading stale
653 # configuration and fail on their first write with SQLITE_READONLY_DBMOVED,
654 # which SQLite reports as "attempt to write a readonly database".
655 #
656 # The staging database lives next to the config database rather than in a
657 # world readable temp directory, since it holds the same secrets, and on the
658 # same filesystem, so it does not compete for space with anything else.
659 6 ▶sub _stageAndRestoreDb ($self,$builder) {
Subroutine _stageAndRestoreDb: called CC=9 SCAR=33.7
660 6 my $cfgDb = $self->cfgHash->{BACKEND}{cfg_db};
661 6 my $staging = $cfgDb.'.restore.'.$$;
662 6 my $err;
663 6 ▶ eval {
Branch: 1 branch
BranchTrueFalseTotal
eval { do { BEGIN { $^H{'autodie::Scope::GuardStack/guard2'} = 'autodie::Scope::Guard=CODE(0x61cd78b18ff0)'; $^H{'no Fatal'} = 'HASH(0x61cd78b18fd8)'; } unlink glob($staging . '*'); BEGIN { $^H{'autodie::Scope::GuardStack/guard3'} = 'autodie::Scope::Guard=CODE(0x61cd78b1d6c8)'; } &$builder($staging); &CallBackery::Config::chmod(384, $staging); my $dbh = "DBI"->connect("dbi:SQLite:dbname=$cfgDb", "", "", {"RaiseError", 1, "PrintError", 0, "AutoCommit", 1}); $dbh->sqlite_busy_timeout($CallBackery::Config::RESTORE_BUSY_TIMEOUT_MS); my $deadline = &Time::HiRes::time() + $CallBackery::Config::RESTORE_BUSY_TIMEOUT_MS / 1000; () = (undef, 0); while (1) { $busy = undef; last if eval { do { $dbh->sqlite_backup_from_file($staging) } }; $busy = $@ || $dbh->errstr || "unknown error"; last if &Time::HiRes::time() >= $deadline; $self->log->warn("Config database busy, retrying restore: $busy") if $tries++ % 50 == 0; &Time::HiRes::sleep("0.1"); } ; $dbh->disconnect; die mkerror(3845, trm("Could not restore the configuration database: %1", $busy)) if $busy; 1 } } or $err = $@ 0 6 6
664 # unlink glob, not plain unlink: a leftover journal of our own would
665 # otherwise be rolled back into the staging database
666 13 ▶ no autodie;
Subroutine BEGIN: called CC=1 SCAR=0.0
667 6 unlink glob $staging.'*';
668 13 ▶ use autodie;
Subroutine BEGIN: called CC=1 SCAR=0.0
669 6 $builder->($staging);
670 0 chmod 0600, $staging;
671 0 my $dbh = DBI->connect("dbi:SQLite:dbname=$cfgDb",'','',{
672 RaiseError => 1,
673 PrintError => 0,
674 AutoCommit => 1,
675 });
676 # the backup runs the destination's busy handler while it waits for
677 # the write lock; on top of that we retry, because a backup that
678 # starts while another connection sits in a read transaction gives up
679 # rather than waiting
680 0 $dbh->sqlite_busy_timeout($RESTORE_BUSY_TIMEOUT_MS);
681 0 my $deadline = Time::HiRes::time() + $RESTORE_BUSY_TIMEOUT_MS / 1000;
682 0 my ($busy,$tries) = (undef,0);
683 0 while (1) {
684 0 $busy = undef;
685 0 ▶ last if eval { $dbh->sqlite_backup_from_file($staging) };
Branch: 1 branch
BranchTrueFalseTotal
if eval { do { $dbh->sqlite_backup_from_file($staging) } } 0 0 0
686 0 ▶ $busy = $@ || $dbh->errstr || 'unknown error';
Condition0%0/5
$@ || $dbh->errstr || 'unknown error'
l!l
00
$@ or $dbh->errstr
l!l&&r!l&&!r
000
MC/DC0%0/2
$@ || $dbh->errstr || 'unknown error'
$@ $dbh->errstr
Truth table0%0/3
A or B
A= $@B= $dbh->errstr
ABresult
1X1
011
000
687 0 ▶ last if Time::HiRes::time() >= $deadline;
Branch: 1 branch
BranchTrueFalseTotal
if &Time::HiRes::time() >= $deadline 0 0 0
688 # first attempt and then roughly every five seconds, so that a
689 # long wait is visible without a log line per retry
690 0 ▶ $self->log->warn("Config database busy, retrying restore: $busy")
Branch: 1 branch
BranchTrueFalseTotal
if $tries++ % 50 == 0 0 0 0
691 if $tries++ % 50 == 0;
692 0 Time::HiRes::sleep(0.1);
693 }
694 0 $dbh->disconnect;
695 # giving up here is safe: the live database has not been touched, so
696 # this degrades to a clean error rather than a half restored config
697 0 ▶ die mkerror(3845,trm("Could not restore the configuration database: %1",$busy))
Branch: 1 branch
BranchTrueFalseTotal
if $busy 0 0 0
698 if $busy;
699 0 1;
700 } or $err = $@;
701 13 ▶ no autodie;
Subroutine BEGIN: called CC=1 SCAR=0.0
702 6 unlink glob $staging.'*';
703 6 ▶ die $err if $err;
Branch: 1 branch
BranchTrueFalseTotal
if $err 6 0 6
704 0 return;
705 }
706  
707 # DBD::SQLite registers an FTS3/FTS4 tokenizer called "perl" on every
708 # connection; a table using it calls the Perl sub named in its definition
709 # whenever the table is used. A restored schema must not name it.
710 1 ▶sub _refusePerlTokenizer ($self,$dbh) {
Subroutine _refusePerlTokenizer: called CC=2 SCAR=7.6
711 1 my $schema = $dbh->selectcol_arrayref(q{SELECT sql FROM sqlite_master WHERE sql IS NOT NULL});
712 die mkerror(3846,trm("The backup contains a table with a Perl tokenizer"))
713 1 ▶ if grep { /tokeni[sz]e\W*perl/i } @$schema;
Branch: 1 branch
BranchTrueFalseTotal
if grep {/tokeni[sz]e\W*perl/iu;} @$schema 1 0 1
714 0 return;
715 }
716  
717 =head2 $cfg->restoreConfigBlob(configBlob)
718  
719 retore the confguration state
720  
721 A blob in the format used before CBK2 has no authentication; it is still
722 restored, with a warning, and should be replaced by a new backup.
723  
724 =cut
725  
726 6 ▶sub restoreConfigBlob {
Subroutine restoreConfigBlob: called CC=12 SCAR=34.7
Pod documented
727 6 my $self = shift;
728 6 my $config = shift;
729 6 my $password = shift;
730 6 require Archive::Zip;
731 6 ▶ if ($config =~ /^CBK2/ and length($config) % 16 == 4) {
Branch: 1 branch
BranchTrueFalseTotal
if ($config =~ /^CBK2/u and length($config) % 16 == 4) { } 0 6 6
Condition33%1/3
$config =~ /^CBK2/u and length($config) % 16 == 4
!ll&&!rl&&r
600
MC/DC0%0/2
$config =~ /^CBK2/u and length($config) % 16 == 4
$config =~ /^CBK2/u length($config) % 16 == 4
Truth table33%1/3
A and B
A= $config =~ /^CBK2/uB= length($config) % 16 == 4
ABresult
0X0
100
111
732 0 require Crypt::Rijndael;
733 0 my ($salt,$iv) = (substr($config,4,16),substr($config,20,16));
734 0 my ($encKey,$macKey) = $self->_blobKeys($password,$salt);
735 0 my $mac = substr($config,-32,32,'');
736 0 ▶ die mkerror(3844,trm("Wrong password!"))
Branch: 1 branch
BranchTrueFalseTotal
unless secure_compare($mac, &hmac_sha256($config, $macKey)) 0 0 0
737 unless secure_compare($mac,hmac_sha256($config,$macKey));
738 0 my $crypt = Crypt::Rijndael->new($encKey,Crypt::Rijndael::MODE_CBC());
739 0 $crypt->set_iv($iv);
740 0 $config = $self->unpack16($crypt->decrypt(substr($config,36)));
741 }
742 else {
743 6 $self->log->warn("Restoring a backup in the old, unauthenticated format; take a new backup to replace it");
744 6 my $crypt = $self->getCrypt($password);
745 6 $config = $self->unpack16($crypt->decrypt($config));
746 }
747  
748 6 my $user = $self->app->userObject->new(app=>$self->app,userId=>'__CONFIG', log=>$self->log);
749 6 open my $fh ,'<', \$config;
750 6 my $zip = Archive::Zip->new();
751 6 $zip->readFromFileHandle($fh);
752 6 my %stateFileCache;
753 6 for my $member ($zip->members){
754 6 for ($member->fileName){
755 6 ▶ /^\{DATABASE\}$/ && do {
Branch: 1 branch
BranchTrueFalseTotal
/^\{DATABASE\}$/u and do { $self->log->warn("Restoring Database!"); $self->_stageAndRestoreDb(sub ($staging) { $member->extractToFileNamed($staging); my $dbh = "DBI"->connect("dbi:SQLite:dbname=$staging", "", "", {"RaiseError", 1, "PrintError", 0}); $self->_refusePerlTokenizer($dbh); $dbh->disconnect; } ); last } 0 6 6
756 0 $self->log->warn("Restoring Database!");
757 0 ▶ $self->_stageAndRestoreDb(sub ($staging) {
Subroutine __ANON__: not called CC=1 SCAR=6.9
758 0 $member->extractToFileNamed($staging);
759 0 my $dbh = DBI->connect("dbi:SQLite:dbname=$staging",'','',{RaiseError => 1, PrintError => 0});
760 0 $self->_refusePerlTokenizer($dbh);
761 0 $dbh->disconnect;
762 0 });
763 0 last;
764 };
765 6 ▶ /^\{DATABASEDUMP\}$/ && do {
Branch: 1 branch
BranchTrueFalseTotal
/^\{DATABASEDUMP\}$/u and do { $self->log->warn("Restoring Database Dump!"); $self->_stageAndRestoreDb(sub ($staging) { my $sql = $member->contents; $sql =~ s/0$//u; my $dbh = "DBI"->connect("dbi:SQLite:dbname=$staging", "", "", {"RaiseError", 1, "PrintError", 0, "AutoCommit", 1, "sqlite_allow_multiple_statements", 1}); $dbh->do("SELECT fts3_tokenizer('perl',fts3_tokenizer('simple'))"); $dbh->sqlite_set_authorizer(sub { my($action, $arg1, $arg2) = @_; return &SQLITE_DENY() if $action == &SQLITE_ATTACH() or $action == &SQLITE_FUNCTION() and lc($arg2 // "") eq "fts3_tokenizer" or $action == &SQLITE_PRAGMA() and not lc($arg1 // "") =~ /^(?:foreign_keys|writable_schema)$/u; return &SQLITE_OK(); } ); $dbh->do($sql); $dbh->sqlite_set_authorizer(undef); $self->_refusePerlTokenizer($dbh); $dbh->disconnect; } ); last } 6 0 6
766 6 $self->log->warn("Restoring Database Dump!");
767 6 ▶ $self->_stageAndRestoreDb(sub ($staging) {
Subroutine __ANON__: called CC=1 SCAR=0.0
768 6 my $sql = $member->contents();
769 6 $sql =~ s/0$//; # for some reason the dump ends in 0
770 # SQL only: the sqlite3 shell would also run .shell, fsdir() etc.
771 6 my $dbh = DBI->connect("dbi:SQLite:dbname=$staging",'','',{
772 RaiseError => 1,
773 PrintError => 0,
774 AutoCommit => 1,
775 sqlite_allow_multiple_statements => 1,
776 });
777 # while the dump replays, "perl" is the plain tokenizer, so
778 # no Perl sub named by a table in the dump can run
779 6 $dbh->do(q{SELECT fts3_tokenizer('perl',fts3_tokenizer('simple'))});
780 # no ATTACH or fts3_tokenizer(); the only pragmas are the
781 # ones sqlite3 .dump writes (writable_schema adds FTS tables)
782 137 ▶ $dbh->sqlite_set_authorizer(sub {
Subroutine __ANON__: called CC=8 SCAR=21.3
783 137 my ($action,$arg1,$arg2) = @_;
784 137 ▶ return SQLITE_DENY if $action == SQLITE_ATTACH
Branch: 1 branch
BranchTrueFalseTotal
if $action == &SQLITE_ATTACH() or $action == &SQLITE_FUNCTION() and lc($arg2 // "") eq "fts3_tokenizer" or $action == &SQLITE_PRAGMA() and not lc($arg1 // "") =~ /^(?:foreign_keys|writable_schema)$/u 3 134 137
Condition75%12/16
$action == &SQLITE_ATTACH() or $action == &SQLITE_FUNCTION() and lc($arg2 // "") eq "fts3_tokenizer" or $action == &SQLITE_PRAGMA() and not lc($arg1 // "") =~ /^(?:foreign_keys|writable_schema)$/u
l!l&&r!l&&!r
12134
$action == &SQLITE_ATTACH() or $action == &SQLITE_FUNCTION() and lc($arg2 // "") eq "fts3_tokenizer"
l!l&&r!l&&!r
10136
$action == &SQLITE_FUNCTION() and lc($arg2 // "") eq "fts3_tokenizer"
!ll&&!rl&&r
13330
$arg2 // ""
l!l
30
$action == &SQLITE_PRAGMA() and not lc($arg1 // "") =~ /^(?:foreign_keys|writable_schema)$/u
!ll&&!rl&&r
13222
$arg1 // ""
l!l
40
MC/DC20%1/5
$action == &SQLITE_ATTACH() or $action == &SQLITE_FUNCTION() and lc($arg2 // "") eq "fts3_tokenizer" or $action == &SQLITE_PRAGMA() and not lc($arg1 // "") =~ /^(?:foreign_keys|writable_schema)$/u
$action == &SQLITE_ATTACH() $action == &SQLITE_FUNCTION() $arg2 $action == &SQLITE_PRAGMA() $arg1
Truth table37%3/8
A or B and C or D and not(E)
A= $action == &SQLITE_ATTACH()B= $action == &SQLITE_FUNCTION()C= $arg2D= $action == &SQLITE_PRAGMA()E= $arg1
ABCDEresult
1XXXX1
011XX1
00X101
010101
00X0X0
00X110
0100X0
010110
785 or ($action == SQLITE_FUNCTION and lc($arg2 // '') eq 'fts3_tokenizer')
786 or ($action == SQLITE_PRAGMA and lc($arg1 // '') !~ /^(?:foreign_keys|writable_schema)$/);
787 134 return SQLITE_OK;
788 6 });
789 6 $dbh->do($sql);
790 1 $dbh->sqlite_set_authorizer(undef);
791 1 $self->_refusePerlTokenizer($dbh);
792 0 $dbh->disconnect;
793 6 });
794 0 last;
795 };
796 0 ▶ m/^\{PLUGINSTATE\.([^.]+)\}(.+)/ && do {
Branch: 1 branch
BranchTrueFalseTotal
/^\{PLUGINSTATE\.([^.]+)\}(.+)/u and do { my $plugin = $1; my $file = $2; unless ($stateFileCache{$plugin}) { my $obj = eval { do { $self->instantiatePlugin($plugin, $user) } }; unless ($obj) { $self->log->warn("Ignoring $file from plugin $plugin since the plugin is not available here."); next; } ; $stateFileCache{$plugin} = {map({$_, 1;} @{$obj->stateFiles;})}; } ; if ($stateFileCache{$plugin}{$file}) { $member->extractToFileNamed($file); } else { $self->log->warn("Ignoring $file from archive since it is not listed in $plugin stateFiles."); } } 0 0 0
797 0 my $plugin = $1;
798 0 my $file = $2;
799 0 ▶ if (not $stateFileCache{$plugin}){
Branch: 1 branch
BranchTrueFalseTotal
unless ($stateFileCache{$plugin}) 0 0 0
800 0 my $obj = eval {
801 0 $self->instantiatePlugin($plugin,$user);
802 };
803 0 ▶ if (not $obj){
Branch: 1 branch
BranchTrueFalseTotal
unless ($obj) 0 0 0
804 0 $self->log->warn("Ignoring $file from plugin $plugin since the plugin is not available here.");
805 0 next;
806 }
807 0 $stateFileCache{$plugin} = { map { $_ => 1 } @{$obj->stateFiles} };
808 };
809 0 ▶ if ($stateFileCache{$plugin}{$file}){
Branch: 1 branch
BranchTrueFalseTotal
if ($stateFileCache{$plugin}{$file}) { } 0 0 0
810 0 $member->extractToFileNamed($file);
811 }
812 else {
813 0 $self->log->warn("Ignoring $file from archive since it is not listed in $plugin stateFiles.");
814 }
815 }
816 }
817 }
818 0 $self->reConfigure;
819 }
820  
821 =head2 $cfg->reConfigure()
822  
823 Regenerate all the template based configuration files using input from the database.
824  
825 =cut
826  
827 0 ▶sub reConfigure {
Subroutine reConfigure: not called CC=2 SCAR=17.9
Pod documented
828 0 my $self = shift;
829 0 my $secretFile = $self->secretFile;
830 0 $self->_writeSecretFile($secretFile);
831 0 for my $obj (@{$self->configPlugins}){
832 0 $obj->reConfigure;
833 }
834 }
835  
836 =head2 $cfg->unConfigure()
837  
838 Restore the system to unconfigured state. By removing the
839 configuration database, unlinking all user supplied configuration
840 files and regenerating all template based configuration files with
841 empty input.
842  
843 =cut
844  
845 0 ▶sub unConfigure {
Subroutine unConfigure: not called CC=8 SCAR=40.2
Pod documented
846 13 ▶ no autodie;
Subroutine BEGIN: called CC=1 SCAR=0.0
847 0 my $self = shift;
848 0 my $cfg = $self->cfgHash;
849 0 $self->log->debug("unlinking config database ".$cfg->{BACKEND}{cfg_db});
850 0 ▶ unlink $cfg->{BACKEND}{cfg_db} if -f $cfg->{BACKEND}{cfg_db};
Branch: 1 branch
BranchTrueFalseTotal
if -f $cfg->{"BACKEND"}{"cfg_db"} 0 0 0
851 0 open my $gen, '>', $cfg->{BACKEND}{cfg_db}.'.flush';
852 0 close $gen;
853 #get 'clean' config files
854 0 $self->reConfigure();
855 # and now remove all state
856 0 for my $obj (@{$self->configPlugins}){
857 0 for my $file (@{$obj->stateFiles},@{$obj->unConfigureFiles}) {
858 0 ▶ next if not -f $file;
Branch: 1 branch
BranchTrueFalseTotal
unless -f $file 0 0 0
859 0 $self->log->debug('['.$obj->name."] unlinking $file");
860 0 unlink $file;
861 }
862 }
863 0 ▶ unlink $cfg->{BACKEND}{log_file} if defined $cfg->{BACKEND}{log_file} and -f $cfg->{BACKEND}{log_file} ;
Branch: 1 branch
BranchTrueFalseTotal
if defined $cfg->{"BACKEND"}{"log_file"} and -f $cfg->{"BACKEND"}{"log_file"} 0 0 0
Condition0%0/3
defined $cfg->{"BACKEND"}{"log_file"} and -f $cfg->{"BACKEND"}{"log_file"}
!ll&&!rl&&r
000
MC/DC0%0/2
defined $cfg->{"BACKEND"}{"log_file"} and -f $cfg->{"BACKEND"}{"log_file"}
defined $cfg->{"BACKEND"}{"log_file"} -f $cfg->{"BACKEND"}{"log_file"}
Truth table0%0/3
A and B
A= defined $cfg->{"BACKEND"}{"log_file"}B= -f $cfg->{"BACKEND"}{"log_file"}
ABresult
0X0
100
111
864 0 ▶ unlink $self->secretFile if -f $self->secretFile;
Branch: 1 branch
BranchTrueFalseTotal
if -f $self->secretFile 0 0 0
865 0 system "sync";
866 }
867  
868 =head2 $cfg->promisify(xxx)
869  
870 always return a promise resolving to the value
871  
872 =cut
873  
874 10 ▶sub promisify {
Subroutine promisify: called CC=3 SCAR=11.6
Pod documented
875 10 my $self = shift;
876 10 my $value = shift;
877 10 ▶ if (eval { blessed $value && $value->isa('Mojo::Promise') }){
Branch: 1 branch
BranchTrueFalseTotal
if (eval { do { builtin::blessed($value) and $value->isa("Mojo::Promise") } }) 0 10 10
Condition66%2/3
builtin::blessed($value) && $value->isa('Mojo::Promise')
!ll&&!rl&&r
910
MC/DC0%0/2
builtin::blessed($value) && $value->isa('Mojo::Promise')
builtin::blessed($value) $value->isa('Mojo::Promise')
Truth table66%2/3
A && B
A= builtin::blessed($value)B= $value->isa('Mojo::Promise')
ABresult
0X0
100
111
878 0 return $value;
879 }
880  
881 10 return Mojo::Promise->resolve($value);
882 }
883  
884 =head2 $cfg->promiseDeath(xxx)
885  
886 die when there is a promise response
887  
888 =cut
889  
890 0 ▶sub promiseDeath {
Subroutine promiseDeath: not called CC=3 SCAR=24.8
Pod documented
891 0 my $self = shift;
892 0 my $value = shift;
893 0 ▶ if (eval { blessed $value && $value->isa('Mojo::Promise') }){
Branch: 1 branch
BranchTrueFalseTotal
if (eval { do { builtin::blessed($value) and $value->isa("Mojo::Promise") } }) 0 0 0
Condition0%0/3
builtin::blessed($value) && $value->isa('Mojo::Promise')
!ll&&!rl&&r
000
MC/DC0%0/2
builtin::blessed($value) && $value->isa('Mojo::Promise')
builtin::blessed($value) $value->isa('Mojo::Promise')
Truth table0%0/3
A && B
A= builtin::blessed($value)B= $value->isa('Mojo::Promise')
ABresult
0X0
100
111
894 0 Mojo::Exception->throw("unexpected promise respone!");
895 }
896 0 return $value;
897 }
898  
899  
900 13 1;
901  
902 __END__
« lib/CallBackery/User.pm ↑ Summary lib/CallBackery/GuiPlugin/Users.pm »