.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Config::Model::Backend::Any 3pm" .TH Config::Model::Backend::Any 3pm "2017-05-14" "perl v5.24.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Config::Model::Backend::Any \- Virtual class for other backends .SH "VERSION" .IX Header "VERSION" version 2.097 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& package Config::Model::Backend::Foo ; \& use Mouse ; \& \& extends \*(AqConfig::Model::Backend::Any\*(Aq; \& \& # optional \& sub suffix { \& return \*(Aq.conf\*(Aq; \& } \& \& # mandatory \& sub read { \& my $self = shift ; \& my %args = @_ ; \& \& # args are: \& # root => \*(Aq./my_test\*(Aq, # fake root directory, used for tests \& # config_dir => /etc/foo\*(Aq, # absolute path \& # file => \*(Aqfoo.conf\*(Aq, # file name \& # file_path => \*(Aq./my_test/etc/foo/foo.conf\*(Aq \& # io_handle => $io # IO::File object opened for read \& # check => yes|no|skip \& \& return 0 unless defined $args{io_handle} ; # or die, your choice \& \& # read the file line by line \& # we assume the file contain lines like \*(Aqkey=value\*(Aq \& foreach ($args{io_handle}\->getlines) { \& chomp ; # remove trailing \en \& s/#.*// ; # remove any comment \& next unless /\eS/; # skip blank line \& \& # $data is \*(Aqfoo=bar\*(Aq which is compatible with load \& $self\->node\->load(steps => $_, check => $args{check} ) ; \& } \& return 1 ; \& } \& \& # mandatory \& sub write { \& my $self = shift ; \& my %args = @_ ; \& \& # args are: \& # root => \*(Aq./my_test\*(Aq, # fake root directory, used for tests \& # config_dir => /etc/foo\*(Aq, # absolute path \& # file => \*(Aqfoo.conf\*(Aq, # file name \& # file_path => \*(Aq./my_test/etc/foo/foo.conf\*(Aq \& # io_handle => $io # IO::File object opened for write \& # check => yes|no|skip \& \& my $ioh = $args{io_handle} ; \& \& # read the content of the configuration tree \& foreach my $elt ($self\->node\->children) { \& # read the value from element $elt \& my $v = $self\->node\->grab_value($elt) ; \& \& # write value in file \& $ioh\->print(qq!$elt="$v"\en!) if defined $v ; \& } \& \& return 1; \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Some application have configuration files with a syntax which is not supported by existing \f(CW\*(C`Config::Model::Backend::*\*(C'\fR classes. .PP In this case a new backend must be written. \f(CW\*(C`Config::Model::Backend::Any\*(C'\fR was created to facilitate this task. .PP The new backend class must use Mouse and must extends (inherit) \&\f(CW\*(C`Config::Model::Backend::Any\*(C'\fR. .SH "How to write your own backend" .IX Header "How to write your own backend" .SS "Declare the new backend in a node of the model" .IX Subsection "Declare the new backend in a node of the model" As explained in \*(L"Backend specification\*(R" in Config::Model::BackendMgr, the new backend must be declared as an attribute of a Config::Model::Node specification. .PP Let's say your new backend is \f(CW\*(C`Config::Model::Backend::Foo\*(C'\fR. This new backend can be specified with: .PP .Vb 5 \& read_config => [ { \& backend => \*(AqFoo\*(Aq , # can also be \*(Aqfoo\*(Aq \& config_dir => \*(Aq/etc/cfg_dir\*(Aq \& file => \*(Aqfoo.conf\*(Aq, # optional \& }] .Ve .PP (The backend class name is constructed with \f(CW\*(C`ucfirst($backend_name)\*(C'\fR) .PP \&\f(CW\*(C`read_config\*(C'\fR can also have custom parameters that are passed verbatim to \f(CW\*(C`Config::Model::Backend::Foo\*(C'\fR methods: .PP .Vb 6 \& read_config => [ { \& backend => \*(AqFoo\*(Aq , # can also be \*(Aqfoo\*(Aq \& config_dir => \*(Aq/etc/cfg_dir\*(Aq \& file => \*(Aqfoo.conf\*(Aq, # optional \& my_param => \*(Aqmy_value\*(Aq, \& } ] .Ve .PP \&\f(CW\*(C`Config::Model::Backend::Foo\*(C'\fR class must inherit (extend) Config::Model::Backend::Any and is expected to provide the following methods: .IP "read" 4 .IX Item "read" \&\f(CW\*(C`read()\*(C'\fR is called with the following parameters: .Sp .Vb 9 \& %custom_parameters, # e.g. my_param => \*(Aqmy_value\*(Aq in the example above \& object => $obj, # Config::Model::Node object \& root => $root_dir, # fake root directory, used for tests \& backend => $backend, # backend name \& config_dir => $read_dir, # path below root \& file => \*(Aqfoo.conf\*(Aq, # file name \& file_path => $full_name, # full file name (root+path+file) \& io_handle => $io_file # IO::File object opened for read \& check => [yes|no|skip] .Ve .Sp The IO::File object is undef if the file cannot be read. .Sp This method must return 1 if the read was successful, 0 otherwise. .Sp Following the \f(CW\*(C`my_param\*(C'\fR example above, \f(CW%custom_parameters\fR contains \&\f(CW\*(C` ( \*(Aqmy_param\*(Aq , \*(Aqmy_value\*(Aq ) \*(C'\fR, so \f(CW\*(C`read()\*(C'\fR is called with \&\f(CW\*(C`root\*(C'\fR, \f(CW\*(C`config_dir\*(C'\fR, \f(CW\*(C`file_path\*(C'\fR, \f(CW\*(C`io_handle\*(C'\fR \fBand\fR \&\f(CW\*(C`my_param => \*(Aqmy_value\*(Aq\*(C'\fR. .IP "write" 4 .IX Item "write" \&\f(CW\*(C`write()\*(C'\fR is called with the following parameters: .Sp .Vb 10 \& %$custom_parameters, # e.g. my_param => \*(Aqmy_value\*(Aq in the example above \& object => $obj, # Config::Model::Node object \& root => $root_dir, # fake root directory, used for tests \& auto_create => $auto_create, # boolean specified in backend declaration \& auto_delete => $auto_delete, # boolean specified in backend declaration \& backend => $backend, # backend name \& config_dir => $write_dir, # override from instance \& file => \*(Aqfoo.conf\*(Aq, # file name \& file_path => $full_name, # full file name (root+path+file) \& io_handle => $fh, # IO::File object \& write => 1, # always \& check => [ yes|no|skip] , \& backup => [ undef || \*(Aq\*(Aq || suffix ] # backup strategy required by user .Ve .Sp The IO::File object is undef if the file cannot be written to. .Sp This method must return 1 if the write was successful, 0 otherwise .Sp If \f(CW\*(C`io_handle\*(C'\fR is defined, the backup has already been done before opening the config file. If \f(CW\*(C`io_handle\*(C'\fR is not defined, there's not enough information in the model to read the configuration file and create the backup. Your \f(CW\*(C`write()\*(C'\fR method will have to do the backup requested by user. .Sp When both \f(CW\*(C`config_dir\*(C'\fR and \f(CW\*(C`file\*(C'\fR are specified, the backend manager opens the configuration file for write (and thus clobbers it) before calling the \f(CW\*(C`write\*(C'\fR call-back with the file handle with \f(CW\*(C`io_handle\*(C'\fR parameter. \f(CW\*(C`write\*(C'\fR should use this handle to write data in the target configuration file. .Sp If this behavior causes problem, the solution is either to override \&\f(CW\*(C`skip_open\*(C'\fR method in your backend that returns \f(CW1\fR. .SS "How to test your new backend" .IX Subsection "How to test your new backend" Using Config::Model::Tester, you can test your model with your backend following the instructions given in Config::Model::Tester. .PP You can also test your backend with a minimal model (and Config::Model::Tester). In this case, you need to specify a small model to test in a \f(CW\*(C`*\-test\-conf.pl\*(C'\fR file. See the IniFile backend test for an example and its examples files . .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .ie n .SS "new ( node => $node_obj, name => backend_name )" .el .SS "new ( node => \f(CW$node_obj\fP, name => backend_name )" .IX Subsection "new ( node => $node_obj, name => backend_name )" The constructor should be used only by Config::Model::Node. .SH "Methods to override" .IX Header "Methods to override" .SS "annotation" .IX Subsection "annotation" Whether the backend supports reading and writing annotation (a.k.a comments). Default is 0. Override this method to return 1 if your backend supports annotations. .SS "suffix" .IX Subsection "suffix" Suffix of the configuration file. This method returns \f(CW\*(C`undef\*(C'\fR by default. .SS "read" .IX Subsection "read" Read the configuration file. This method must be overridden. .SS "write" .IX Subsection "write" Write the configuration file. This method must be overridden. .SH "Methods" .IX Header "Methods" .SS "node" .IX Subsection "node" Return the node (a Config::Model::Node) holding this backend. .SS "instance" .IX Subsection "instance" Return the instance (a Config::Model::Instance) holding this configuration. .SS "show_message( string )" .IX Subsection "show_message( string )" Show a message to \s-1STDOUT \s0(unless overridden). Delegated to \*(L"show_message( string )\*(R" in Config::Model::Instance. .SS "read_global_comments" .IX Subsection "read_global_comments" Parameters: .IP "\(bu" 4 array ref of string containing the lines to be parsed .IP "\(bu" 4 A string to specify how a comment is started. Each character is recognized as a comment starter (e.g '\f(CW\*(C`#;\*(C'\fR' allow a comment to begin with '\f(CW\*(C`#\*(C'\fR' or '\f(CW\*(C`;\*(C'\fR') .PP Read the global comments (i.e. the first block of comments until the first blank or non comment line) and store them as root node annotation. .PP Example: .PP .Vb 2 \& $self\->read_global_comments( \e@lines, \*(Aq;\*(Aq); \& $self\->read_global_comments( \e@lines, \*(Aq#;\*(Aq); .Ve .SS "associates_comments_with_data" .IX Subsection "associates_comments_with_data" Parameters: .IP "\(bu" 4 array ref of string containing the lines to be parsed .IP "\(bu" 4 A string to specify how a comment is started. Each character is recognized as a comment starter (e.g '\f(CW\*(C`#;\*(C'\fR' allow a comment to begin with '\f(CW\*(C`#\*(C'\fR' or '\f(CW\*(C`;\*(C'\fR') .PP This method extracts comments from the passed lines and associate them with actual data found in the file lines. Data is associated with comments preceding or on the same line as the data. Returns a list of [ data, comment ]. .PP Example: .PP .Vb 8 \& my @lines = ( \& \*(Aq# Foo comments\*(Aq, \& \*(Aqfoo= 1\*(Aq, \& \*(AqBaz = 0 # Baz comments\*(Aq \& ); \& my @res = $self\->associates_comments_with_data( \e@lines, \*(Aq#\*(Aq) \& # @res is: \& # ( [ \*(Aqfoo= 1\*(Aq, \*(AqFoo comments\*(Aq ] , [ \*(AqBaz = 0\*(Aq , \*(AqBaz comments\*(Aq ] ) .Ve .SS "write_global_comments( io_handle , comment_char)" .IX Subsection "write_global_comments( io_handle , comment_char)" Write global comments from configuration root annotation into the io_handle (if defined). Returns the string written to the io_handle. .SS "write_data_and_comments( io_handle , comment_char , data1, comment1, data2, comment2 ...)" .IX Subsection "write_data_and_comments( io_handle , comment_char , data1, comment1, data2, comment2 ...)" Write data and comments in the \f(CW\*(C`io_handle\*(C'\fR (if defined). Comments are written before the data. Returns the string written to the io_handle. If a data is undef, the comment is written on its own line. .SH "AUTHOR" .IX Header "AUTHOR" Dominique Dumont, (ddumont at cpan dot org) .SH "SEE ALSO" .IX Header "SEE ALSO" Config::Model, Config::Model::BackendMgr, Config::Model::Node, Config::Model::Backend::Yaml, .SH "AUTHOR" .IX Header "AUTHOR" Dominique Dumont .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is Copyright (c) 2005\-2016 by Dominique Dumont. .PP This is free software, licensed under: .PP .Vb 1 \& The GNU Lesser General Public License, Version 2.1, February 1999 .Ve