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
|
package Config::Model::Backend::ShellVar;
use Carp;
use Mouse;
use Config::Model::Exception;
use File::Path;
use Log::Log4perl qw(get_logger :levels);
use Config::Model::BackendTrackOrder;
extends 'Config::Model::Backend::Any';
my $logger = get_logger("Backend::ShellVar");
has tracker => (
is => 'ro',
isa => 'Config::Model::BackendTrackOrder',
lazy_build => 1,
handles => [qw/get_ordered_element_names/],
);
sub _build_tracker {
my $self = shift;
return Config::Model::BackendTrackOrder->new(
backend_obj => $self,
node => $self->node,
) ;
}
sub annotation { return 1; }
sub read {
my $self = shift;
my %args = @_;
# args are:
# object => $obj, # Config::Model::Node object
# root => './my_test', # fake root directory, userd for tests
# config_dir => /etc/foo', # absolute path
# file => 'foo.conf', # file name
# file_path => './my_test/etc/foo/foo.conf'
# check => yes|no|skip
return 0 unless $args{file_path}->exists; # no file to read
my $check = $args{check} || 'yes';
my @lines = $args{file_path}->lines_utf8;
# try to get global comments (comments before a blank line)
$self->read_global_comments( \@lines, '#' );
my @assoc = $self->associates_comments_with_data( \@lines, '#' );
foreach my $item (@assoc) {
my ( $data, $c ) = @$item;
my ($k,$v) = split /\s*=\s*/, $data, 2; # make reader quite tolerant
$v =~ s/^["']|["']$//g;
if ($logger->is_debug) {
my $msg = "Loading key '$k' value '$v'";
$msg .= " comment: '$c'" if $c;
$logger->debug($msg);
}
$self->tracker->register_element($k);
my $obj = $self->node->fetch_element($k);
$obj->store( value => $v, check => $check );
$obj->annotation($c) if $c;
}
return 1;
}
sub write {
my $self = shift;
my %args = @_;
# args are:
# object => $obj, # Config::Model::Node object
# root => './my_test', # fake root directory, userd for tests
# config_dir => /etc/foo', # absolute path
# file => 'foo.conf', # file name
# file_path => './my_test/etc/foo/foo.conf'
# check => yes|no|skip
my $node = $args{object};
my @to_write;
# Using Config::Model::ObjTreeScanner would be overkill
foreach my $elt ( $self->get_ordered_element_names ) {
my $obj = $node->fetch_element($elt);
my $v = $node->grab_value($elt);
next unless defined $v;
push @to_write, [ qq!$elt="$v"!, $obj->annotation ];
}
if (@to_write) {
my $res = $self->write_global_comment( '#' );
foreach my $line_ref (@to_write) {
$res .= $self->write_data_and_comments( '#', @$line_ref );
}
$args{file_path}->spew_utf8($res);
}
return 1;
}
no Mouse;
__PACKAGE__->meta->make_immutable;
1;
# ABSTRACT: Read and write config as a C<SHELLVAR> data structure
__END__
=head1 SYNOPSIS
use Config::Model;
my $model = Config::Model->new;
$model->create_config_class (
name => "MyClass",
element => [
[qw/foo bar/] => {qw/type leaf value_type string/}
],
rw_config => {
backend => 'ShellVar',
config_dir => '/tmp',
file => 'foo.conf',
auto_create => 1,
}
);
my $inst = $model->instance(root_class_name => 'MyClass' );
my $root = $inst->config_root ;
$root->load('foo=FOO1 bar=BAR1' );
$inst->write_back ;
File C<foo.conf> now contains:
## This file was written by Config::Model
## You may modify the content of this file. Configuration
## modifications will be preserved. Modifications in
## comments may be mangled.
##
foo="FOO1"
bar="BAR1"
=head1 DESCRIPTION
This module is used directly by L<Config::Model> to read or write the
content of a configuration tree written with C<SHELLVAR> syntax in
C<Config::Model> configuration tree.
Note that undefined values are skipped for list element. I.e. if a
list element contains C<('a',undef,'b')>, the data structure
contains C<'a','b'>.
=head1 CONSTRUCTOR
=head2 new
Parameters: C<< ( node => $node_obj, name => 'shellvar' ) >>
Inherited from L<Config::Model::Backend::Any>. The constructor is
called by L<Config::Model::BackendMgr>.
=head2 read
Of all parameters passed to this read call-back, only C<file_path> is
used.
When a file is read, C<read> returns 1.
=head2 write
Of all parameters passed to this write call-back, only C<file_path> is
used.
C<write> returns 1.
=head1 AUTHOR
Dominique Dumont, (ddumont at cpan dot org)
=head1 SEE ALSO
L<Config::Model>,
L<Config::Model::BackendMgr>,
L<Config::Model::Backend::Any>,
=cut
|
