Doxygen doc
This commit is contained in:
Xavier Guimard
parent
a8601a0e5f
commit
29b8c86848
|
|
@ -43,7 +43,6 @@
|
|||
# implementation of DoxyGen::PerlFilter.
|
||||
#
|
||||
|
||||
|
||||
## @class
|
||||
# Filter from perl syntax API docs to Doxygen-compatible syntax.
|
||||
# This class is meant to be used as a filter for the
|
||||
|
|
@ -64,11 +63,26 @@ sub filter {
|
|||
my $current_class = "";
|
||||
my $file = [];
|
||||
my $endMark = 1;
|
||||
my ( $cc, $cl, $lc, $ll ) = ( 0, 0, 0, 0 );
|
||||
while (<$infh>) {
|
||||
$endMark = 0 if(/\s*use\s+AutoLoader/);
|
||||
$endMark = 0 if (/^\s*use\s+AutoLoader/);
|
||||
last if ( $endMark and /^__END__$/ );
|
||||
#next if (/^$/);
|
||||
$cc = ( /^\s*#/ ? 1 : 0 );
|
||||
$lc = ( /[\{\}\[\];]\s*$/ ? 1 : 0 );
|
||||
if ( $cc or $cl or $ll or not(@$file) ) {
|
||||
push( @$file, $_ );
|
||||
}
|
||||
else {
|
||||
$file->[ $#{$file} ] =~ s/[\r\n]/ /g;
|
||||
$file->[ $#{$file} ] .= $_;
|
||||
}
|
||||
$cl = $cc;
|
||||
$ll = $lc;
|
||||
$cl++ if(/\s#/);
|
||||
}
|
||||
|
||||
#print STDERR @$file;
|
||||
$self->file_contents($file);
|
||||
my $objcontext =
|
||||
grep( /^\s*use\s+base\s/, @$file )
|
||||
|
|
@ -87,7 +101,8 @@ sub filter {
|
|||
while ( $_ = $file->[ $line++ ] ) {
|
||||
if (/^#\s?(.+)/s) {
|
||||
push @more, $1;
|
||||
} else {
|
||||
}
|
||||
else {
|
||||
last;
|
||||
}
|
||||
}
|
||||
|
|
@ -96,7 +111,8 @@ sub filter {
|
|||
$self->start("\@$command $args");
|
||||
$self->more(@more);
|
||||
$self->end;
|
||||
} elsif ($command eq 'class') {
|
||||
}
|
||||
elsif ( $command eq 'class' ) {
|
||||
$objcontext = 1;
|
||||
unless ($args) {
|
||||
($args) = /package\s(.*);/;
|
||||
|
|
@ -106,30 +122,32 @@ sub filter {
|
|||
$self->print("};\n");
|
||||
}
|
||||
$current_class = $args;
|
||||
$self->emit_class( $args, $line, [
|
||||
"\@$command $args",
|
||||
@more,
|
||||
"\@nosubgrouping"
|
||||
] );
|
||||
} elsif ($command eq 'imethod') {
|
||||
$self->emit_class( $args, $line,
|
||||
[ "\@$command $args", @more, "\@nosubgrouping" ] );
|
||||
}
|
||||
elsif ( $command eq 'imethod' ) {
|
||||
unless ($args) {
|
||||
($args) = $self->analyze_sub( $line - 1 );
|
||||
}
|
||||
$args = $self->munge_parameters($args);
|
||||
$self->push($self->protection($args).' Initialization Methods');
|
||||
$self->push(
|
||||
$self->protection($args) . ' Initialization Methods' );
|
||||
$self->start("\@fn $args")->more(@more)->end;
|
||||
$self->print( $args, ";\n" );
|
||||
$self->pop;
|
||||
} elsif ($command eq 'apmethod') {
|
||||
}
|
||||
elsif ( $command eq 'apmethod' ) {
|
||||
unless ($args) {
|
||||
($args) = $self->analyze_sub( $line - 1 );
|
||||
}
|
||||
$args = $self->munge_parameters($args);
|
||||
$self->push($self->protection($args).' Authentication Process Methods');
|
||||
$self->push( $self->protection($args)
|
||||
. ' Authentication Process Methods' );
|
||||
$self->start("\@fn $args")->more(@more)->end;
|
||||
$self->print( $args, ";\n" );
|
||||
$self->pop;
|
||||
} elsif ($command eq 'rmethod') {
|
||||
}
|
||||
elsif ( $command eq 'rmethod' ) {
|
||||
unless ($args) {
|
||||
($args) = $self->analyze_sub( $line - 1 );
|
||||
}
|
||||
|
|
@ -138,7 +156,8 @@ sub filter {
|
|||
$self->start("\@fn $args")->more(@more)->end;
|
||||
$self->print( $args, ";\n" );
|
||||
$self->pop;
|
||||
} elsif ($command eq 'cmethod') {
|
||||
}
|
||||
elsif ( $command eq 'cmethod' ) {
|
||||
unless ($args) {
|
||||
($args) = $self->analyze_sub( $line - 1 );
|
||||
}
|
||||
|
|
@ -147,16 +166,19 @@ sub filter {
|
|||
$self->start("\@fn $args")->more(@more)->end;
|
||||
$self->print( $args, ";\n" );
|
||||
$self->pop;
|
||||
} elsif ($command eq 'ifn') {
|
||||
}
|
||||
elsif ( $command eq 'ifn' ) {
|
||||
unless ($args) {
|
||||
($args) = $self->analyze_sub( $line - 1 );
|
||||
}
|
||||
$args = $self->munge_parameters($args);
|
||||
$self->push($self->protection($args).' Initialization Functions');
|
||||
$self->push(
|
||||
$self->protection($args) . ' Initialization Functions' );
|
||||
$self->start("\@fn $args")->more(@more)->end;
|
||||
$self->print( $args, ";\n" );
|
||||
$self->pop;
|
||||
} elsif ($command eq 'rfn') {
|
||||
}
|
||||
elsif ( $command eq 'rfn' ) {
|
||||
unless ($args) {
|
||||
($args) = $self->analyze_sub( $line - 1 );
|
||||
}
|
||||
|
|
@ -165,7 +187,8 @@ sub filter {
|
|||
$self->start("\@fn $args")->more(@more)->end;
|
||||
$self->print( $args, ";\n" );
|
||||
$self->pop;
|
||||
} elsif ($command eq 'fn') {
|
||||
}
|
||||
elsif ( $command eq 'fn' ) {
|
||||
unless ($args) {
|
||||
($args) = $self->analyze_sub( $line - 1 );
|
||||
}
|
||||
|
|
@ -174,7 +197,8 @@ sub filter {
|
|||
$self->start("\@fn $args")->more(@more)->end;
|
||||
$self->print( $args, ";\n" );
|
||||
$self->pop;
|
||||
} elsif ($command eq 'method') {
|
||||
}
|
||||
elsif ( $command eq 'method' ) {
|
||||
unless ($args) {
|
||||
($args) = $self->analyze_sub( $line - 1 );
|
||||
}
|
||||
|
|
@ -183,23 +207,29 @@ sub filter {
|
|||
$self->start("\@fn $args")->more(@more)->end;
|
||||
$self->print( $args, ";\n" );
|
||||
$self->pop;
|
||||
} elsif ($command eq 'enum') {
|
||||
}
|
||||
elsif ( $command eq 'enum' ) {
|
||||
$self->start("\@$command $args");
|
||||
$self->more(@more);
|
||||
$self->end;
|
||||
$self->print("$command $args;\n");
|
||||
} else {
|
||||
}
|
||||
else {
|
||||
$self->start("\@$command $args");
|
||||
$self->more(@more);
|
||||
$self->end;
|
||||
}
|
||||
|
||||
# We ate a line when we got the rest of the comment lines
|
||||
redo if defined $_;
|
||||
} elsif (/^use\s+([\w:]+)/) {
|
||||
}
|
||||
elsif (/^use\s+([\w:]+)/) {
|
||||
my $inc = $1;
|
||||
|
||||
#$inc =~ s/::/\//g;
|
||||
$self->print("#include \"$inc.pm\"\n");
|
||||
} elsif (/^package\s+([\w:]+)/) {
|
||||
}
|
||||
elsif (/^package\s+([\w:]+)/) {
|
||||
if ($current_class) {
|
||||
$self->flush;
|
||||
$self->print("};\n");
|
||||
|
|
@ -207,18 +237,27 @@ sub filter {
|
|||
next unless ($objcontext);
|
||||
$current_class = $1;
|
||||
$self->emit_class( $current_class, $line );
|
||||
} elsif (/^\s*sub\s+([\w:]+)/) {
|
||||
}
|
||||
elsif (/^\s*sub\s+([\w:]+)/) {
|
||||
my ( $proto, $name, @args ) = $self->analyze_sub( $line - 1 );
|
||||
if ( $current_class && @args && ( $args[0] eq "\$self" ) ) {
|
||||
$self->push( $self->protection($proto) . ' Object Methods' );
|
||||
$proto =~ s/\$self,*\s*//;
|
||||
} elsif( $current_class && @args && ($args[0] eq "\$self") ) {
|
||||
$self->push($self->protection($proto).' Initialization Methods');
|
||||
}
|
||||
elsif ( $current_class && @args && ( $args[0] eq "\$self" ) ) {
|
||||
$self->push(
|
||||
$self->protection($proto) . ' Initialization Methods' );
|
||||
$proto =~ s/\$self,*\s*//;
|
||||
} elsif( $current_class
|
||||
&& ((@args && ($args[0] eq "\$class")) || ($name eq "new")) ) {
|
||||
}
|
||||
elsif (
|
||||
$current_class
|
||||
&& ( ( @args && ( $args[0] eq "\$class" ) )
|
||||
|| ( $name eq "new" ) )
|
||||
)
|
||||
{
|
||||
$self->push( $self->protection($proto) . ' Class Methods' );
|
||||
} else {
|
||||
}
|
||||
else {
|
||||
$self->push( $self->protection($proto) . ' Functions' );
|
||||
}
|
||||
$proto = $self->munge_parameters($proto);
|
||||
|
|
@ -232,8 +271,6 @@ sub filter {
|
|||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
## @method @ analyze_sub( int line )
|
||||
# analyzes a subroutine declaration starting at the given line. Tries
|
||||
# to determine whicht arguments it takes.
|
||||
|
|
@ -255,7 +292,12 @@ sub analyze_sub {
|
|||
}
|
||||
else {
|
||||
my $forward = 5;
|
||||
for( my $i=0; $forward && ($i+$line <= $#$file) && ! $proto; $i++ ) {
|
||||
for (
|
||||
my $i = 0 ;
|
||||
$forward && ( $i + $line <= $#$file ) && !$proto ;
|
||||
$i++
|
||||
)
|
||||
{
|
||||
$_ = $file->[ $i + $line ];
|
||||
if (/^\s*my\s*\((.*)\)\s*=\s*\@_/) {
|
||||
$proto = $1;
|
||||
|
|
@ -267,6 +309,7 @@ sub analyze_sub {
|
|||
$args[$3] = $2;
|
||||
}
|
||||
elsif (/shift\s*->\s*[a-z0-9_]+\(/) {
|
||||
|
||||
# assuming anonymously used shifted value is $self
|
||||
push( @args, '$self' );
|
||||
}
|
||||
|
|
@ -292,11 +335,10 @@ sub analyze_sub {
|
|||
if ( substr( $name, 0, 1 ) eq "_" ) {
|
||||
$protection = "protected";
|
||||
}
|
||||
return( "$protection retval $name( ".join(", ", @args )." )", $name, @args );
|
||||
return ( "$protection retval $name( " . join( ", ", @args ) . " )",
|
||||
$name, @args );
|
||||
}
|
||||
|
||||
|
||||
|
||||
## @method emit_class( string class, int line, arrayref doc )
|
||||
# Emit one class definition. If the doc parameter is defined,
|
||||
# emits the array as a comment just before the class definition,
|
||||
|
|
@ -314,20 +356,32 @@ sub emit_class {
|
|||
if (/^\s*(?:use base|\@ISA\s*=|\@${class}::ISA\s*=)\s+(.+);/) {
|
||||
push @current_isa, eval $1;
|
||||
$file->[ $line - 1 ] = "\n";
|
||||
} elsif (/^\s*(?:use|require)\s+([\w:]+)/) {
|
||||
}
|
||||
elsif (/^\s*(?:use|require)\s+([\w:]+)/) {
|
||||
my $inc = $1;
|
||||
$links{$1||'public'}{$inc} = $2 . ($3 ? "\n* $3" : '') if (/#\s*link\s+(?:(private|protected|public)\s+)?(\S+)(?:\s+(.*))?\s*$/);
|
||||
$links{ $1 || 'public' }{$inc} = $2 . ( $3 ? "\n* $3" : '' )
|
||||
if (
|
||||
/#\s*link\s+(?:(private|protected|public)\s+)?(\S+)(?:\s+(.*))?\s*$/
|
||||
);
|
||||
push @current_priv_isa, $inc if (/#\s*inherits/);
|
||||
$inc =~ s/::/\//g;
|
||||
$inc =~ s#Lemonldap/NG/(\w+)#"lemonldap-ng-".lc($1)."/lib/Lemonldap/NG/$1"#e;
|
||||
print STDERR $inc;
|
||||
$inc =~
|
||||
s#Lemonldap/NG/(\w+)#"lemonldap-ng-".lc($1)."/lib/Lemonldap/NG/$1"#e;
|
||||
|
||||
#print STDERR $inc;
|
||||
push @current_include, $inc;
|
||||
$file->[ $line - 1 ] = "\n";
|
||||
} elsif (/^package/) {
|
||||
}
|
||||
elsif (/^package/) {
|
||||
last;
|
||||
} elsif (/#\s*inherits\s+([\w:]+)/) {
|
||||
}
|
||||
elsif (/#\s*inherits\s+([\w:]+)/) {
|
||||
push @current_priv_isa, $1;
|
||||
} elsif (/#\s*link\s+([\w:]+)\s+(?:(private|protected|public)\s+)?(\S+)(?:\s+(.*))?\s*$/) {
|
||||
}
|
||||
elsif (
|
||||
/#\s*link\s+([\w:]+)\s+(?:(private|protected|public)\s+)?(\S+)(?:\s+(.*))?\s*$/
|
||||
)
|
||||
{
|
||||
$links{ $2 || 'public' }{$1} = $3 . ( $4 ? "\n* $4" : '' );
|
||||
}
|
||||
}
|
||||
|
|
@ -367,8 +421,6 @@ sub emit_class {
|
|||
$self->print("public:\n") unless ( $links{public} );
|
||||
}
|
||||
|
||||
|
||||
|
||||
## @method arrayref file_contents( arrayref contents )
|
||||
# set/get an array containing the whole input file, each
|
||||
# line at one array index.
|
||||
|
|
@ -382,8 +434,6 @@ sub file_contents {
|
|||
return ( $self->{"$id file"} );
|
||||
}
|
||||
|
||||
|
||||
|
||||
## @method munge_parameters($args)
|
||||
# Munge the argument list. Because DoxyGen does not seem to handle $, @ and %
|
||||
# as argument types properly, we replace them with full length strings.
|
||||
|
|
@ -417,5 +467,4 @@ sub munge_parameters {
|
|||
return $args;
|
||||
}
|
||||
|
||||
|
||||
1;
|
||||
|
|
|
|||
|
|
@ -1,7 +1,12 @@
|
|||
## @file
|
||||
# Lemonldap::NG manager main file
|
||||
|
||||
## @class
|
||||
# Lemonldap::NG manager main class
|
||||
package Lemonldap::NG::Manager;
|
||||
|
||||
use strict;
|
||||
use Lemonldap::NG::Handler::CGI qw(:globalStorage :locationRules);
|
||||
use Lemonldap::NG::Handler::CGI qw(:globalStorage :locationRules); #inherits
|
||||
use Lemonldap::NG::Manager::Help; #inherits
|
||||
|
||||
our $VERSION = '0.93';
|
||||
|
|
@ -17,6 +22,10 @@ BEGIN {
|
|||
*process = *doall;
|
||||
}
|
||||
|
||||
## @cmethod Lemonldap::NG::Manager new(hashRef args)
|
||||
# Class constructor.
|
||||
#@param args hash reference
|
||||
#@return Lemonldap::NG::Manager object
|
||||
sub new {
|
||||
my ( $class, $args ) = @_;
|
||||
my $self = $class->SUPER::new($args)
|
||||
|
|
@ -63,9 +72,12 @@ sub new {
|
|||
return $self;
|
||||
}
|
||||
|
||||
## @method string menu()
|
||||
# Build the tree menu.
|
||||
# @return HTML string
|
||||
sub menu {
|
||||
my $self = shift;
|
||||
require Lemonldap::NG::Manager::Downloader; #inherits
|
||||
require Lemonldap::NG::Manager::Downloader;
|
||||
return
|
||||
'<ul class="simpleTree">'
|
||||
. $self->li( 'root', 'root' )
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
##@file
|
||||
# Configuration tree file
|
||||
|
||||
##@class Lemonldap::NG::Manager::Downloader
|
||||
# Configuration tree builder
|
||||
package Lemonldap::NG::Manager::Downloader;
|
||||
|
||||
use MIME::Base64;
|
||||
|
|
@ -8,6 +13,11 @@ use Data::Dumper;
|
|||
require Lemonldap::NG::Manager::_Struct; #inherits
|
||||
require Lemonldap::NG::Manager::_i18n; #inherits
|
||||
|
||||
## @method string node(string node)
|
||||
# Build the part of the tree that does not depends of the the configuration.
|
||||
# Call corresp(), ajaxNode(), confNode() or itself with li() and span().
|
||||
#@param $node Node to display
|
||||
#@return HTML string
|
||||
sub node {
|
||||
my ( $self, $node ) = @_;
|
||||
my $res;
|
||||
|
|
@ -71,6 +81,15 @@ sub node {
|
|||
return $res;
|
||||
}
|
||||
|
||||
## @method string confNode(string node, string target, string help, string js)
|
||||
# Build the part of the tree that does not depends of the the configuration.
|
||||
# Call ajaxNode(), itself, keyToH(), li(), span().
|
||||
# @param node Unique identifier for the node
|
||||
# @param target String that represents the type and the position of the
|
||||
# parameter in the configuration
|
||||
# @param help Help chapter to display when selected
|
||||
# @param js Javascript function to launch when selected
|
||||
# @return HTML string
|
||||
sub confNode {
|
||||
my ( $self, $node, $target, $help, $js ) = @_;
|
||||
my $res;
|
||||
|
|
@ -164,6 +183,11 @@ sub confNode {
|
|||
return $res;
|
||||
}
|
||||
|
||||
## @method hashref keyToH(string key, hashref h)
|
||||
# Return the part of $h corresponding to $key.
|
||||
# Example, if $h={a=>{b=>{c=>1}}} and $key='/a/b' then keyToH() will
|
||||
# return {c=>1}
|
||||
# @return hashref
|
||||
sub keyToH {
|
||||
my ( $self, $key, $h ) = @_;
|
||||
$key =~ s/^\///;
|
||||
|
|
@ -174,6 +198,19 @@ sub keyToH {
|
|||
return $h;
|
||||
}
|
||||
|
||||
## @method array corresp(string key,boolean last)
|
||||
# Search a the key $key in the hashref Lemonldap::NG::Manager::struct().
|
||||
# If $key is not set, uses Lemonldap::NG::Manager::struct().
|
||||
# If the URL parameter key is set, uses Lemonldap::NG::Manager::cstruct()
|
||||
# with this parameter.
|
||||
# This function call itself 1 time if the key is not found using cstruct()
|
||||
# using the flag $last.
|
||||
# @return An array containing :
|
||||
# - the (sub)structure of the menu
|
||||
# - the help chapter (using inheritance of the up key)
|
||||
# - the optional javascript function to use when node is selected
|
||||
# @param key string
|
||||
# @param last optional boolean
|
||||
sub corresp {
|
||||
my ( $self, $key, $last ) = @_;
|
||||
$key =~ s/^\///;
|
||||
|
|
@ -218,6 +255,10 @@ sub corresp {
|
|||
return $h, $help, $js;
|
||||
}
|
||||
|
||||
## @method protected hashref conf()
|
||||
# If configuration is not in memory, calls
|
||||
# Lemonldap::NG::Common::Conf::getConf() and returns it.
|
||||
# @return Lemonldap::NG configuration
|
||||
sub conf {
|
||||
my $self = shift;
|
||||
return $self->{_conf} if ( $self->{_conf} );
|
||||
|
|
@ -230,6 +271,10 @@ sub conf {
|
|||
return $self->{_conf};
|
||||
}
|
||||
|
||||
## @method protected Lemonldap::NG::Common::Conf confObj()
|
||||
# At the first call, creates a new Lemonldap::NG::Common::Conf object and
|
||||
# return it. This object is cached for later calls.
|
||||
# @return Lemonldap::NG::Common::Conf object
|
||||
sub confObj {
|
||||
my $self = shift;
|
||||
return $self->{_confObj} if ( $self->{_confObj} );
|
||||
|
|
@ -244,11 +289,17 @@ sub confObj {
|
|||
return $self->{_confObj};
|
||||
}
|
||||
|
||||
## @method protected void ajaxnode(string id, string text, string param)
|
||||
# Display tree node with Ajax functions inside for opening the node.
|
||||
# @param $id HTML id of the element.
|
||||
## @method protected string ajaxnode(string id,string text,string param,string help,string js,string data,boolean noT)
|
||||
# Returns a tree node with Ajax functions inside for opening the node later.
|
||||
# Call li() and span().
|
||||
# @param $id HTML id of the element
|
||||
# @param $text text to display
|
||||
# @param $param Parameters for the Ajax query
|
||||
# @param $help Help chapter to display
|
||||
# @param $js Javascript function to call when selected
|
||||
# @param $data Value of the parameter
|
||||
# @param $noT Optional flag to block translation
|
||||
# @return HTML string
|
||||
sub ajaxNode {
|
||||
my ( $self, $id, $text, $param, $help, $js, $data, $noT ) = @_;
|
||||
$param .= "&cfgNum=$self->{cfgNum}";
|
||||
|
|
@ -262,6 +313,16 @@ sub ajaxNode {
|
|||
. "}</li></ul></li>\n";
|
||||
}
|
||||
|
||||
## @method protected string span(string id,string text,string param,string help,string js,string data,boolean noT)
|
||||
# Return the span part of the node
|
||||
# @param $id HTML id of the element
|
||||
# @param $text text to display
|
||||
# @param $param Parameters for the Ajax query
|
||||
# @param $help Help chapter to display
|
||||
# @param $js Javascript function to call when selected
|
||||
# @param $data Value of the parameter
|
||||
# @param $noT Optional flag to block translation
|
||||
# @return HTML string
|
||||
sub span {
|
||||
my ( $self, $id, $text, $data, $js, $help, $noT ) = @_;
|
||||
use Carp qw(cluck);
|
||||
|
|
@ -281,6 +342,11 @@ sub span {
|
|||
";
|
||||
}
|
||||
|
||||
## @method protected string li(string id,string class)
|
||||
# Returns the LI part of the node.
|
||||
# @param $id HTML id of the element
|
||||
# @param $class CSS class
|
||||
# @return HTML string
|
||||
sub li {
|
||||
my ( $self, $id, $class ) = @_;
|
||||
$id = "li_" . encode_base64( $id, '' );
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
## @file
|
||||
# Test uploaded parameters and store new configuration
|
||||
|
||||
## @class
|
||||
# Test uploaded parameters and store new configuration
|
||||
package Lemonldap::NG::Manager::Uploader;
|
||||
|
||||
use strict;
|
||||
|
|
@ -8,12 +13,16 @@ use MIME::Base64;
|
|||
# TODO
|
||||
use Data::Dumper;
|
||||
use Lemonldap::NG::Common::Safelib; #link protected safe Safe object
|
||||
use Lemonldap::NG::Manager::Downloader;
|
||||
use Lemonldap::NG::Manager::_Struct;
|
||||
use Lemonldap::NG::Manager::Downloader; #inherits
|
||||
use Lemonldap::NG::Manager::_Struct; #inherits
|
||||
|
||||
our $VERSION = '0.1';
|
||||
our ( $stylesheet, $parser );
|
||||
|
||||
## @method void confUpload(ref rdata)
|
||||
# Parse rdata to find parameters using XSLT, test them and tries to store the
|
||||
# new configuration
|
||||
# @param $rdata pointer to posted datas
|
||||
sub confUpload {
|
||||
my ( $self, $rdata ) = @_;
|
||||
$$rdata =~ s/<img.*?>//g;
|
||||
|
|
@ -113,12 +122,11 @@ sub confUpload {
|
|||
$self->lmLog( "No default value found for $k", 'warn' );
|
||||
}
|
||||
}
|
||||
print LOG "Ignore $node\n";
|
||||
}
|
||||
|
||||
#print STDERR Dumper( $newConf, \%errors, \%warnings );
|
||||
close LOG;
|
||||
$res->{result}->{cfgNum} = $self->confObj->saveConf($newConf) unless($res->{errors});
|
||||
#print STDERR Dumper( $newConf, $res );
|
||||
$res->{result}->{cfgNum} = $self->confObj->saveConf($newConf)
|
||||
unless ( $res->{errors} );
|
||||
my $buf = '{';
|
||||
my $i = 0;
|
||||
while ( my ( $type, $h ) = each %$res ) {
|
||||
|
|
@ -129,10 +137,21 @@ sub confUpload {
|
|||
$i++;
|
||||
}
|
||||
$buf .= '}';
|
||||
print $self->header( -type => 'application/json', -Content_Length => length($buf) ).$buf;
|
||||
print $self->header(
|
||||
-type => 'application/json',
|
||||
-Content_Length => length($buf)
|
||||
) . $buf;
|
||||
$self->quit();
|
||||
}
|
||||
|
||||
## @method protected array applyTest(void* test,string value)
|
||||
# Apply the test to the value and return the result and an optional message
|
||||
# returned by the test if the sub ref.
|
||||
# @param $test Ref to a regexp or a sub
|
||||
# @param $value Value to test
|
||||
# @return Array containing:
|
||||
# - the test result
|
||||
# - an optional message
|
||||
sub applyTest {
|
||||
my ( $self, $test, $value ) = @_;
|
||||
my ( $res, $msg );
|
||||
|
|
@ -145,6 +164,8 @@ sub applyTest {
|
|||
return ( $res, $msg );
|
||||
}
|
||||
|
||||
## @method protected array getConfTests(string id)
|
||||
# Call Lemonldap::NG::Manager::_Struct::testStruct().
|
||||
sub getConfTests {
|
||||
my ( $self, $id ) = @_;
|
||||
my ( $confKey, $tmp ) = ( $id =~ /^(.*?)(?:\/(.*))?$/ );
|
||||
|
|
@ -155,6 +176,11 @@ sub getConfTests {
|
|||
return ( $confKey, $h );
|
||||
}
|
||||
|
||||
## @method protected array findAllConfKeys(hashref h)
|
||||
# Parse a tree structure to find all nodes corresponding to a configuration
|
||||
# value.
|
||||
# @param $h Tree structure
|
||||
# @return Array of configuration parameter names
|
||||
sub findAllConfKeys {
|
||||
my ( $self, $h ) = @_;
|
||||
my @res = ();
|
||||
|
|
@ -172,6 +198,13 @@ sub findAllConfKeys {
|
|||
return @res;
|
||||
}
|
||||
|
||||
## @method protected void setKeyToH(hashref h,string key,string k2,string value)
|
||||
# Insert key=>$value in $h at the position declared with $key. If $k2 is set,
|
||||
# insert key=>{$k2=>$value}. Note that $key is splited with "/". The last part
|
||||
# is used as key.
|
||||
# @param $h New Lemonldap::NG configuration
|
||||
# @param $key String "/path/key"
|
||||
# @param $k2 Optional subkey
|
||||
sub setKeyToH {
|
||||
my $value = pop;
|
||||
my ( $self, $h, $key, $k2 ) = @_;
|
||||
|
|
@ -196,12 +229,18 @@ sub setKeyToH {
|
|||
}
|
||||
}
|
||||
|
||||
## @method private XML::LibXML parser()
|
||||
# @return XML::LibXML object (cached in global $parser variable)
|
||||
sub parser {
|
||||
my $self = shift;
|
||||
return $parser if ($parser);
|
||||
$parser = XML::LibXML->new();
|
||||
}
|
||||
|
||||
## @method private XML::LibXSLT stylesheet()
|
||||
# Returns XML::LibXSLT parser (cached in global $stylesheet variable). Use
|
||||
# datas stored at the end of this file to initialize the object.
|
||||
# @return XML::LibXSLT object
|
||||
sub stylesheet {
|
||||
my $self = shift;
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,19 @@
|
|||
## @file
|
||||
# Manager tree structure and tests
|
||||
|
||||
## @class
|
||||
# Manager tree structure and tests
|
||||
package Lemonldap::NG::Manager::_Struct;
|
||||
|
||||
use strict;
|
||||
our $VERSION = '0.1';
|
||||
|
||||
## @method protected hashref cstruct(hashref h,string k)
|
||||
# Merge $h with the structure produced with $k and return it.
|
||||
# Used to manage virtual hosts.
|
||||
#@param $h Result of struct()
|
||||
#@param $k Name of the virtual host
|
||||
#@return Tree structure
|
||||
sub cstruct {
|
||||
shift;
|
||||
my ( $h, $k ) = @_;
|
||||
|
|
@ -23,6 +34,11 @@ sub cstruct {
|
|||
return $h;
|
||||
}
|
||||
|
||||
## @method protected hashref struct(hashref h,string k)
|
||||
# Returns the tree structure
|
||||
#@param $h Result of struct()
|
||||
#@param $k Name of the virtual host
|
||||
#@return Tree structure
|
||||
sub struct {
|
||||
return {
|
||||
_nodes => [qw(n:generalParameters n:groups n:virtualHosts)],
|
||||
|
|
@ -129,6 +145,9 @@ sub struct {
|
|||
};
|
||||
}
|
||||
|
||||
## @method protected hashref testStruct()
|
||||
# Returns the tests to do with the datas uploaded.
|
||||
# @return hashref
|
||||
sub testStruct {
|
||||
my $assignTest = qr/(?<=[^=<!>\?])=(?![=~])/;
|
||||
my $assignMsg = 'containsAnAssignment';
|
||||
|
|
@ -302,6 +321,8 @@ sub testStruct {
|
|||
};
|
||||
}
|
||||
|
||||
## @method protected hashref defaultConf()
|
||||
#@return Hashref of default values
|
||||
sub defaultConf {
|
||||
return {
|
||||
authentication => 'LDAP',
|
||||
|
|
@ -316,17 +337,4 @@ sub defaultConf {
|
|||
};
|
||||
}
|
||||
|
||||
sub newNode {
|
||||
virtualHost => {
|
||||
'*' => {
|
||||
exportedHeaders => { 'Auth-User' => '$uid' },
|
||||
locationRules => { 'default' => 'deny' },
|
||||
}
|
||||
},
|
||||
groups => { 'NewGroup' => '0', },
|
||||
macro => { 'NewMacro' => '', },
|
||||
globalStorageOptions => { 'NewOption' => '', },
|
||||
;
|
||||
}
|
||||
|
||||
1;
|
||||
|
|
|
|||
|
|
@ -11,8 +11,11 @@ use strict;
|
|||
use AutoLoader qw(AUTOLOAD);
|
||||
our $VERSION = '0.5';
|
||||
|
||||
## @fn void import(string lang)
|
||||
# Import messages
|
||||
## @method string translate(string text,string lang)
|
||||
# Returns $text translated in $lang.
|
||||
#@param $text textId
|
||||
#@param $lang Optional language string. If not set, uses Accept-Language
|
||||
# HTTP header.
|
||||
sub translate {
|
||||
my ( $self, $text, $lang ) = @_;
|
||||
return $text unless ( $text =~ /[a-z]/ );
|
||||
|
|
@ -39,6 +42,7 @@ sub translate {
|
|||
*en_us = *en;
|
||||
|
||||
1;
|
||||
__END__
|
||||
|
||||
sub en {
|
||||
return {
|
||||
|
|
@ -106,130 +110,3 @@ sub fr {
|
|||
};
|
||||
}
|
||||
|
||||
__END__
|
||||
|
||||
=pod
|
||||
=cut
|
||||
|
||||
sub en {
|
||||
return {
|
||||
apacheSessionModule => 'Apache::Session module',
|
||||
applyConf => 'Apply',
|
||||
areYouSure => 'Are you sure ?',
|
||||
authenticationType => 'Authentication Type',
|
||||
canNotReadApplyConfFile => 'Configuration not applied: cannot read configuration file',
|
||||
changesAppliedLater => 'Changes will be effective within 10 minutes. Use "apachectl reload" on concerned servers for immediate reloading',
|
||||
checkLogs => 'Check Apache logs',
|
||||
confSaved => 'Configuration saved with number',
|
||||
configLoaded => 'Configuration loaded',
|
||||
configurationDeleted => 'Configuration deleted',
|
||||
configurationNotDeleted => 'Configuration not deleted',
|
||||
configurationWasChanged => 'Configuration has been changed since you got it',
|
||||
confirmDeleteConf => "You're going to delete configuration. Do you confirm ?",
|
||||
containsAnAssignment => 'contains an assignment ("="). Possible confusion with "==".',
|
||||
deleteConf => 'Delete',
|
||||
deleteNode => 'Delete',
|
||||
deleteVirtualHost => 'Delete virtual host',
|
||||
error => 'Error',
|
||||
field => 'Field',
|
||||
group => 'Group',
|
||||
httpHeaders => 'HTTP Headers',
|
||||
invalidLine => 'Invalid Line',
|
||||
invalidVirtualHostName => 'Invalid virtual host name',
|
||||
invalidWhatToTrace => "Data to use in Apache's logs can contain only an exported attribute or a macro",
|
||||
isNotANumber => 'is not a number',
|
||||
isNotAValidAttributeName => 'is not a valid attribute name',
|
||||
isNotAValidCookieName => 'is not a valid cookie name',
|
||||
isNotAValidDomainName => 'is not a valid domain name',
|
||||
isNotAValidGroupName => 'is not a valid group name',
|
||||
isNotAValidHTTPHeaderName => 'is not a valid HTTP header name',
|
||||
isNotAValidLDAPAttributeName => 'is not a valid LDAP attribute name',
|
||||
isNotAValidMacroName => 'is not a valid macro name',
|
||||
isNotAValidVirtualHostName => 'is not a valid virtual host name',
|
||||
lastConf => 'Last',
|
||||
locationRules => 'Rules',
|
||||
macro => 'Macro',
|
||||
newGSOpt => 'New Option',
|
||||
newGroup => 'New Group',
|
||||
newHeader => 'New Header',
|
||||
newMacro => 'New Macro',
|
||||
newVar => 'New Variable',
|
||||
newVirtualHost => 'New Virtual Host',
|
||||
nextConf => 'Next',
|
||||
prevConf => 'Previous',
|
||||
result => 'Result',
|
||||
rule => 'Rule',
|
||||
saveConf => 'Save',
|
||||
saveFailure => 'Save failure',
|
||||
syntaxError => 'Syntax error',
|
||||
unableToSave => 'Your browser does not support XMLHTTPRequest objects: fail to save.',
|
||||
unknownError => 'Unknown error',
|
||||
unknownErrorInVars => 'Unknown error in exported attributes',
|
||||
userGroups => 'User Groups',
|
||||
value => 'Value',
|
||||
waitingResult => 'Waiting result...',
|
||||
warningConfNotApplied => 'You have to reload handlers to take the saved configuration in account',
|
||||
};
|
||||
}
|
||||
|
||||
sub fr {
|
||||
return {
|
||||
apacheSessionModule => 'Module Apache::Session',
|
||||
applyConf => 'Appliquer',
|
||||
areYouSure => 'Êtes vous sur ?',
|
||||
authenticationType => "Type d'authentification",
|
||||
canNotReadApplyConfFile => 'Configuration non appliquée: impossible de lire le fichier de configuration',
|
||||
changesAppliedLater => "Les changements seront effectifs d'ici 10 minutes. Utilisez \"apachectl reload\" sur les serveurs concernés pour forcer la prise en compte immédiate",
|
||||
checkLogs => "Consultez les journaux d'Apache",
|
||||
confSaved => 'Configuration sauvegardée sous le numéro',
|
||||
configLoaded => 'Configuration chargée',
|
||||
configurationDeleted => 'Configuration éffacée',
|
||||
configurationNotDeleted => 'Configuration non éffacée',
|
||||
configurationWasChanged => "configuration modifiée depuis que vous l'avez téléchargée",
|
||||
confirmDeleteConf => 'Vous allez effacer cette configuration. Confirmez-vous ?',
|
||||
containsAnAssignment => 'contient une affectation ("="). Confusion possible avec "==".',
|
||||
deleteConf => 'Effacer',
|
||||
deleteNode => 'Supprimer',
|
||||
deleteVirtualHost => "Supprimer l'hôte virtuel",
|
||||
error => 'Erreur',
|
||||
field => 'Champ',
|
||||
group => 'Groupe',
|
||||
httpHeaders => 'En-têtes HTTP',
|
||||
invalidLine => 'Ligne invalide',
|
||||
invalidVirtualHostName => "Nom de d'hôte virtuel incorrect",
|
||||
invalidWhatToTrace => "La donnée à inscrire dans les journaux ne peut contenir qu'un attribut exporté ou une macro",
|
||||
isNotANumber => "n'est pas un nombre",
|
||||
isNotAValidAttributeName => "n'est pas un nom d'attribut valide",
|
||||
isNotAValidCookieName => "n'est pas un nom de cookie valide",
|
||||
isNotAValidDomainName => "n'est pas un nom de domaine valide",
|
||||
isNotAValidGroupName => "n'est pas un nom de groupe valide",
|
||||
isNotAValidHTTPHeaderName => "n'est pas un nom d'en-tête HTTP valide",
|
||||
isNotAValidLDAPAttributeName => "n'est pas un nom d'attribut LDAP valide",
|
||||
isNotAValidMacroName => "n'est pas un nom de macro valide",
|
||||
isNotAValidVirtualHostName => "n'est pas un nom d'hôte virtuel valide",
|
||||
lastConf => 'Dernière',
|
||||
locationRules => 'Règles',
|
||||
macro => 'Macro',
|
||||
macros => 'Macros',
|
||||
newGSOpt => 'Nouvelle option',
|
||||
newGroup => 'Nouveau groupe',
|
||||
newHeader => 'Nouvel en-tête',
|
||||
newMacro => 'Nouvelle macro',
|
||||
newVar => 'Nouvelle variable',
|
||||
newVirtualHost => 'Nouvel hôte virtuel',
|
||||
nextConf => 'Suivante',
|
||||
prevConf => 'Précédente',
|
||||
result => 'Résultat',
|
||||
rule => 'Règle',
|
||||
saveConf => 'Sauvegarder',
|
||||
saveFailure => 'Échec de la sauvegarde',
|
||||
syntaxError => 'Erreur de syntaxe',
|
||||
unableToSave => 'Votre navigateur ne supporte pas les objets XMLHTTPRequest: sauvegarde impossible.',
|
||||
unknownError => 'Erreur inconnue',
|
||||
unknownErrorInVars => 'Erreur inconnue dans les attributs exportés',
|
||||
userGroups => "Groupes d'utilisateurs",
|
||||
value => 'Valeur',
|
||||
waitingResult => 'En attente...',
|
||||
warningConfNotApplied => 'Vous devez recharger les agents pour que la configuration sauvegardée soit appliquée',
|
||||
};
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user