From 778c0b997f7d5b4d005d20746be2596ac7bca6fa Mon Sep 17 00:00:00 2001 From: Xavier Guimard Date: Wed, 4 Jan 2017 20:22:04 +0000 Subject: [PATCH] Update POD (#595) --- .../lib/Lemonldap/NG/Common.pm | 16 +- .../NG/Common/Apache/Session/SOAP.pm | 18 +- .../lib/Lemonldap/NG/Common/CGI.pm | 34 ++- .../lib/Lemonldap/NG/Common/CGI/SOAPServer.pm | 71 ------- .../Lemonldap/NG/Common/CGI/SOAPService.pm | 67 ------ .../lib/Lemonldap/NG/Common/Conf.pm | 87 ++------ .../lib/Lemonldap/NG/Common/Conf/SOAP.pm | 198 ------------------ .../lib/Lemonldap/NG/Common/PSGI.pm | 16 +- .../lib/Lemonldap/NG/Common/PSGI/Request.pm | 186 ++++++---------- .../lib/Lemonldap/NG/Common/PSGI/Router.pm | 16 +- .../lib/Lemonldap/NG/Common/Safelib.pm | 67 ------ 11 files changed, 109 insertions(+), 667 deletions(-) diff --git a/lemonldap-ng-common/lib/Lemonldap/NG/Common.pm b/lemonldap-ng-common/lib/Lemonldap/NG/Common.pm index 08a047b99..b9ec3edc2 100644 --- a/lemonldap-ng-common/lib/Lemonldap/NG/Common.pm +++ b/lemonldap-ng-common/lib/Lemonldap/NG/Common.pm @@ -2,8 +2,6 @@ package Lemonldap::NG::Common; our $VERSION = '2.0.0'; -use strict; - 1; __END__ @@ -24,13 +22,11 @@ This package contains common files. L, L, L -=head1 AUTHOR +=head1 AUTHORS =over -=item Clement Oudot, Eclem.oudot@gmail.comE - -=item Xavier Guimard, Ex.guimard@free.frE +=item LemonLDAP::NG team L =back @@ -46,13 +42,7 @@ L =head1 COPYRIGHT AND LICENSE -=over - -=item Copyright (C) 2008-2016 by Xavier Guimard, Ex.guimard@free.frE - -=item Copyright (C) 2010-2016 by Clement Oudot, Eclem.oudot@gmail.comE - -=back +See COPYING file for details. This library is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by diff --git a/lemonldap-ng-common/lib/Lemonldap/NG/Common/Apache/Session/SOAP.pm b/lemonldap-ng-common/lib/Lemonldap/NG/Common/Apache/Session/SOAP.pm index ddfefc601..59b1d2d8f 100644 --- a/lemonldap-ng-common/lib/Lemonldap/NG/Common/Apache/Session/SOAP.pm +++ b/lemonldap-ng-common/lib/Lemonldap/NG/Common/Apache/Session/SOAP.pm @@ -398,15 +398,11 @@ L, L, L, L, L -=head1 AUTHOR +=head1 AUTHORS =over -=item Clement Oudot, Eclem.oudot@gmail.comE - -=item François-Xavier Deltombe, Efxdeltombe@gmail.com.E - -=item Xavier Guimard, Ex.guimard@free.frE +=item LemonLDAP::NG team L =back @@ -422,15 +418,7 @@ L =head1 COPYRIGHT AND LICENSE -=over - -=item Copyright (C) 2008-2013 by Xavier Guimard, Ex.guimard@free.frE - -=item Copyright (C) 2012 by François-Xavier Deltombe, Efxdeltombe@gmail.com.E - -=item Copyright (C) 2010-2012 by Clement Oudot, Eclem.oudot@gmail.comE - -=back +See COPYING file for details. This library is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by diff --git a/lemonldap-ng-common/lib/Lemonldap/NG/Common/CGI.pm b/lemonldap-ng-common/lib/Lemonldap/NG/Common/CGI.pm index 3270ee3ae..ea8b9c750 100644 --- a/lemonldap-ng-common/lib/Lemonldap/NG/Common/CGI.pm +++ b/lemonldap-ng-common/lib/Lemonldap/NG/Common/CGI.pm @@ -472,8 +472,7 @@ __END__ =encoding utf8 -Lemonldap::NG::Common::CGI - Simple module to extend L to manage -HTTP "If-Modified-Since / 304 Not Modified" system. +Lemonldap::NG::Common::CGI - Simple module to extend L. DEPRECATED =head1 SYNOPSIS @@ -487,7 +486,10 @@ HTTP "If-Modified-Since / 304 Not Modified" system. =head1 DESCRIPTION Lemonldap::NG::Common::CGI just add header_public subroutine to CGI module to -avoid printing HTML elements that can be cached. +avoid printing HTML elements that can be cached. It manage HTTP +"If-Modified-Since / 304 Not Modified" system. + +This module has been deprecated, now use FastCGI/PSGI packages. =head1 METHODS @@ -496,22 +498,18 @@ avoid printing HTML elements that can be cached. header_public works like header (see L) but the first argument has to be a filename: the last modify date of this file is used for reference. -=head2 EXPORT - =head1 SEE ALSO -L, L, -L +L, L, +L, L, +L, L, +L -=head1 AUTHOR +=head1 AUTHORS =over -=item Clement Oudot, Eclem.oudot@gmail.comE - -=item François-Xavier Deltombe, Efxdeltombe@gmail.com.E - -=item Xavier Guimard, Ex.guimard@free.frE +=item LemonLDAP::NG team L =back @@ -527,15 +525,7 @@ L =head1 COPYRIGHT AND LICENSE -=over - -=item Copyright (C) 2008-2016 by Xavier Guimard, Ex.guimard@free.frE - -=item Copyright (C) 2012-2013 by François-Xavier Deltombe, Efxdeltombe@gmail.com.E - -=item Copyright (C) 2010-2016 by Clement Oudot, Eclem.oudot@gmail.comE - -=back +See COPYING file for details. This library is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by diff --git a/lemonldap-ng-common/lib/Lemonldap/NG/Common/CGI/SOAPServer.pm b/lemonldap-ng-common/lib/Lemonldap/NG/Common/CGI/SOAPServer.pm index 694bf00b8..db087c0d6 100644 --- a/lemonldap-ng-common/lib/Lemonldap/NG/Common/CGI/SOAPServer.pm +++ b/lemonldap-ng-common/lib/Lemonldap/NG/Common/CGI/SOAPServer.pm @@ -83,74 +83,3 @@ sub handle { } 1; -__END__ - -=head1 NAME - -=encoding utf8 - -Lemonldap::NG::Common::CGI::SOAPServer - Extends L to be compatible -with L. - -=head1 SYNOPSIS - - use CGI; - use Lemonldap::NG::Common::CGI::SOAPServer; - - my $cgi = CGI->new(); - Lemonldap::NG::Common::CGI::SOAPServer->dispatch_to('same as SOAP::Lite') - ->handle($cgi) - -=head1 DESCRIPTION - -This extension just extend L handle() method to load datas from -a L object instead of STDIN. - -=head1 SEE ALSO - -L, L - -=head1 AUTHOR - -=over - -=item Clement Oudot, Eclem.oudot@gmail.comE - -=item Xavier Guimard, Ex.guimard@free.frE - -=back - -=head1 BUG REPORT - -Use OW2 system to report bug or ask for features: -L - -=head1 DOWNLOAD - -Lemonldap::NG is available at -L - -=head1 COPYRIGHT AND LICENSE - -=over - -=item Copyright (C) 2008-2010 by Xavier Guimard, Ex.guimard@free.frE - -=item Copyright (C) 2010-2012 by Clement Oudot, Eclem.oudot@gmail.comE - -=back - -This library is free software; you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2, or (at your option) -any later version. - -This program 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 General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program. If not, see L. - -=cut diff --git a/lemonldap-ng-common/lib/Lemonldap/NG/Common/CGI/SOAPService.pm b/lemonldap-ng-common/lib/Lemonldap/NG/Common/CGI/SOAPService.pm index 6fb8f0fba..16976cac0 100644 --- a/lemonldap-ng-common/lib/Lemonldap/NG/Common/CGI/SOAPService.pm +++ b/lemonldap-ng-common/lib/Lemonldap/NG/Common/CGI/SOAPService.pm @@ -43,70 +43,3 @@ sub AUTOLOAD { } 1; - -__END__ - -=head1 NAME - -=encoding utf8 - -Lemonldap::NG::Common::CGI::SOAPService - Wrapper for all SOAP functions of -Lemonldap::NG CGIs. - -=head1 SYNOPSIS - -See L - -=head1 DESCRIPTION - -Private class used by L to control SOAP functions -access. - -=head1 SEE ALSO - -L, L - -=head1 AUTHOR - -=over - -=item Clement Oudot, Eclem.oudot@gmail.comE - -=item Xavier Guimard, Ex.guimard@free.frE - -=back - -=head1 BUG REPORT - -Use OW2 system to report bug or ask for features: -L - -=head1 DOWNLOAD - -Lemonldap::NG is available at -L - -=head1 COPYRIGHT AND LICENSE - -=over - -=item Copyright (C) 2009-2010 by Xavier Guimard, Ex.guimard@free.frE - -=item Copyright (C) 2010-2012 by Clement Oudot, Eclem.oudot@gmail.comE - -=back - -This library is free software; you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2, or (at your option) -any later version. - -This program 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 General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program. If not, see L. - -=cut diff --git a/lemonldap-ng-common/lib/Lemonldap/NG/Common/Conf.pm b/lemonldap-ng-common/lib/Lemonldap/NG/Common/Conf.pm index a4fb8d8b8..aa42c198b 100644 --- a/lemonldap-ng-common/lib/Lemonldap/NG/Common/Conf.pm +++ b/lemonldap-ng-common/lib/Lemonldap/NG/Common/Conf.pm @@ -453,6 +453,8 @@ Web-SSO configuration. =head1 SYNOPSIS use Lemonldap::NG::Common::Conf; + # Lemonldap::NG::Common::Conf reads loacl configuration from lemonldap-ng.ini. + # Parameters can be overriden in a hash: my $confAccess = new Lemonldap::NG::Common::Conf( { type=>'File', @@ -469,69 +471,39 @@ Web-SSO configuration. }, }, ) or die "Unable to build Lemonldap::NG::Common::Conf, see Apache logs"; + # Next, get global configuration. Note that local parameters override global + # ones my $config = $confAccess->getConf(); =head1 DESCRIPTION -Lemonldap::NG::Common::Conf provides a simple interface to access to -Lemonldap::NG Web-SSO configuration. It is used by L, -L and L. +Lemonldap::NG::Common::Conf is used by all Lemonldap::NG packages to access to +local/global configuration. =head2 SUBROUTINES =over -=item * B (constructor): it takes different arguments depending on the -chosen type. Examples: +=item * B (constructor) + +It can takes any Lemonldap::NG parameter to override configuration. The +'confFile' parameter can be used to override lemonldap-ng.ini path. +Examples: =over -=item * B: +=item * B $confAccess = new Lemonldap::NG::Common::Conf( - { - type => 'File', - dirName => '/var/lib/lemonldap-ng/', - }); - -=item * B: + { confFile => '/opt/lemonldap-ng.ini' } ); +=item * B: $confAccess = new Lemonldap::NG::Common::Conf( - { - type => 'DBI', - dbiChain => 'DBI:mysql:database=lemonldap-ng;host=1.2.3.4', - dbiUser => 'lemonldap' - dbiPassword => 'pass' - dbiTable => 'lmConfig', - }); - -=item * B: - $confAccess = new Lemonldap::NG::Common::Conf( - { - type => 'SOAP', - proxy => 'http://auth.example.com/index.pl/config', - proxyOptions => { - timeout => 5, - }, - }); - -SOAP configuration access is a sort of proxy: the portal is configured to use -the real session storage type (DBI or File for example). See HTML documentation -for more. - -=item * B: - $confAccess = new Lemonldap::NG::Common::Conf( - { - type => 'LDAP', - ldapServer => 'ldap://localhost', - ldapConfBranch => 'ou=conf,ou=applications,dc=example,dc=com', - ldapBindDN => 'cn=manager,dc=example,dc=com", - ldapBindPassword => 'secret' - }); + { + type => 'File', + dirName => '/var/lib/lemonldap-ng/conf', + }); =back -WARNING: You have to use the same storage type on all Lemonldap::NG parts in -the same server. - =item * B: returns a hash reference to the configuration. it takes a hash reference as first argument containing 2 optional parameters: @@ -552,20 +524,13 @@ getConf returns all (C