/usr/share/perl5/Config/Model/Annotation.pm is in libconfig-model-perl 2.005-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | #
# This file is part of Config-Model
#
# This software is Copyright (c) 2012 by Dominique Dumont, Krzysztof Tyszecki.
#
# This is free software, licensed under:
#
# The GNU Lesser General Public License, Version 2.1, February 1999
#
# Copyright (c) 2010 Dominique Dumont.
#
# This file is part of Config-Model.
#
# Config-Model 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 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; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
package Config::Model::Annotation;
{
$Config::Model::Annotation::VERSION = '2.005';
}
use Any::Moose ;
use English ;
use File::Path;
use IO::File ;
use Data::Dumper ;
#use Log::Log4perl qw(get_logger :levels);
use Config::Model::Exception ;
use Config::Model::Node ;
use Config::Model::ObjTreeScanner;
#use strict ;
use Carp;
#use warnings FATAL => qw(all);
use Carp qw/croak confess cluck/;
#my $logger = get_logger("Annotation") ;
=head1 NAME
Config::Model::Annotation - Read and write configuration annotations
=head1 VERSION
version 2.005
=head1 SYNOPSIS
use Config::Model ;
use Log::Log4perl qw(:easy) ;
Log::Log4perl->easy_init($WARN);
# define configuration tree object
my $model = Config::Model->new ;
$model ->create_config_class (
name => "MyClass",
element => [
[qw/foo bar/] => {
type => 'leaf',
value_type => 'string'
},
baz => {
type => 'hash',
index_type => 'string' ,
cargo => {
type => 'leaf',
value_type => 'string',
},
},
],
) ;
my $inst = $model->instance(root_class_name => 'MyClass' );
my $root = $inst->config_root ;
# put some data in config tree the hard way
$root->fetch_element('foo')->store('yada') ;
$root->fetch_element('baz')->fetch_with_id('en')->store('hello') ;
# put annotation the hard way
$root->fetch_element('foo')->annotation('english') ;
$root->fetch_element('baz')->fetch_with_id('en')->annotation('also english') ;
# put more data the easy way
my $step = 'baz:fr=bonjour#french baz:hr="dobar dan"#croatian';
$root->load( step => $step ) ;
# dump resulting tree with annotations
print $root->dump_tree;
# save annotations
my $annotate_saver = Config::Model::Annotation
-> new (
config_class_name => 'MyClass',
instance => $inst ,
root_dir => '/tmp/', # for test
) ;
$annotate_saver->save ;
# now check content of /tmp/config-model/MyClass-note.pl
=head1 DESCRIPTION
This module provides an object that read and write annotations (a bit
like comments) to and from a configuration tree and save them in a file (not
configuration file)
Depending on the effective id of the process, the annotation will be
saved in:
=over
=item *
C<< /var/lib/config-model/<model_name>-note.yml >> for root (EUID == 0)
=item *
C<< ~/.config-model/<model_name>-note.yml >> for normal user (EUID > 0)
=back
=head1 CONSTRUCTOR
Quite standard. The constructor is passed a L<Config::Model::Instance>
object.
=cut
has 'instance' => ( is => 'ro', isa => 'Config::Model::Instance', required => 1 );
has 'config_class_name' => ( is => 'ro', isa => 'Str', required => 1 ) ;
has 'file' => ( is => 'ro', isa => 'Str', lazy =>1, builder => '_set_file' ) ;
has 'dir' => ( is => 'ro', isa => 'Str', lazy =>1, builder => '_set_dir' ) ;
has 'root_dir' => ( is => 'ro', isa => 'Str|Undef', default => '') ;
sub _set_file {
my $self = shift ;
return $self->dir.$self->config_class_name . '-note.pl' ;
}
sub _set_dir {
my $self = shift ;
my $dir = $self->root_dir ? $self->root_dir
: $EUID ? "/var/lib/"
: "~/." ;
$dir .= "config-model/" ;
return $dir ;
}
#sub new {
# my $proto = shift ;
# my $class = ref($proto) || $proto ;
# my $instance = shift ;
#
# my $self
# = {
# instance => $instance ,
# };
#
# bless $self, $class;
#
#}
#
=head1 METHODS
=head2 save()
Save annotations in a file (See L<DESCRIPTION>)
=cut
sub save {
my $self = shift ;
my $dir = $self->dir ;
mkpath ($dir, { mode => 0755, verbose => 0}) unless -d $dir ;
my $h = $self->get_annotation_hash ;
my $data = Dumper($h) ;
my $io = IO::File->new($self->file, 'w',0644)
|| croak "Can't open $dir".$self->file.": $!";
print $io $data ;
$io->close ;
}
sub get_annotation_hash {
my $self = shift ;
my %data ;
my $scanner = Config::Model::ObjTreeScanner
->new(
leaf_cb => \&my_leaf_cb ,
hash_element_cb => \&my_hash_element_cb,
list_element_cb => \&my_list_element_cb,
node_element_cb => \&my_node_element_cb,
fallback => 'all',
) ;
my $root = $self->instance->config_root ;
$scanner->scan_node(\%data,$root) ;
return \%data ;
}
# WARNING: not a method
sub my_hash_element_cb {
my ($scanner, $data_ref,$node,$element_name,@keys) = @_ ;
# custom code using $data_ref
store_note_in_data($data_ref, $node->fetch_element($element_name) ) ;
# resume exploration
map {$scanner->scan_hash($data_ref,$node,$element_name,$_)} @keys ;
}
# WARNING: not a method
sub my_node_element_cb {
my ($scanner, $data_ref,$node,$element_name,$key, $contained_node) = @_;
# your custom code using $data_ref
store_note_in_data($data_ref, $contained_node ) ;
# explore next node
$scanner->scan_node($data_ref,$contained_node);
}
# WARNING: not a method
sub my_list_element_cb {
my ($scanner, $data_ref,$node,$element_name,@idx) = @_ ;
# custom code using $data_ref
store_note_in_data($data_ref, $node->fetch_element($element_name) ) ;
# resume exploration (if needed)
map {$scanner->scan_list($data_ref,$node,$element_name,$_)} @idx ;
# note: scan_list and scan_hash are equivalent
}
# WARNING: not a method
sub my_leaf_cb {
my ($scanner, $data_ref,$node,$element_name,$index, $leaf_object) = @_ ;
store_note_in_data($data_ref, $leaf_object) ;
}
# WARNING: not a method
sub store_note_in_data {
my ($data_ref,$obj) = @_ ;
my $note = $obj -> annotation ;
return unless $note ;
my $key = $obj -> location ;
$data_ref->{$key} = $note ;
}
=head2 load()
Loads annotations from a file (See L<DESCRIPTION>)
=cut
sub load {
my $self = shift ;
my $f = $self->file ;
return unless -e $f ;
my $hash = do $f || croak "can't do $f:$!";
my $root = $self->instance->config_root ;
foreach my $path (keys %$hash ) {
my $obj = eval {$root ->grab(step => $path, autoadd => 0) } ;
next if $@ ; # skip annotation of unknown elements
$obj->annotation($hash->{$path}) ;
}
}
no Any::Moose ;
__PACKAGE__ -> meta->make_immutable;
1;
=head1 AUTHOR
Dominique Dumont, (ddumont at cpan dot org)
=head1 SEE ALSO
L<Config::Model>,
L<Config::Model::Node>,
L<Config::Model::Loader>,
L<Config::Model::Searcher>,
L<Config::Model::Value>,
=cut
|