From 322202189759513603bd6fbde0a18ffa192160c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Oudot?= Date: Fri, 22 Jan 2010 11:25:37 +0000 Subject: [PATCH] Portal: * Use HTML templates to send fancy reset password mail, with translations * Send the new password by mail instead of diplaying it n the web page * Remove the need to configure : the value is now set with help of {DOCUMENT_ROOT} --- build/lemonldap-ng/Makefile | 14 ++-- modules/lemonldap-ng-portal/example/error.pl | 3 +- .../lemonldap-ng-portal/example/index_skin.pl | 11 +-- modules/lemonldap-ng-portal/example/mail.pl | 7 +- .../example/skins/common/mail_confirm.tpl | 11 +++ .../example/skins/common/mail_footer.tpl | 11 +++ .../example/skins/common/mail_header.tpl | 17 +++++ .../example/skins/common/mail_password.tpl | 9 +++ .../example/skins/pastel/mail.tpl | 5 -- .../example/skins/pastel/styles.css | 2 +- .../lib/Lemonldap/NG/Portal/MailReset.pm | 67 +++++++++++++++++-- .../lib/Lemonldap/NG/Portal/Menu.pm | 3 +- .../lib/Lemonldap/NG/Portal/PasswordDBDBI.pm | 4 +- .../lib/Lemonldap/NG/Portal/PasswordDBLDAP.pm | 4 +- .../lib/Lemonldap/NG/Portal/Simple.pm | 7 +- .../lib/Lemonldap/NG/Portal/_SMTP.pm | 18 +++-- .../lib/Lemonldap/NG/Portal/_i18n.pm | 10 +-- 17 files changed, 148 insertions(+), 55 deletions(-) create mode 100644 modules/lemonldap-ng-portal/example/skins/common/mail_confirm.tpl create mode 100644 modules/lemonldap-ng-portal/example/skins/common/mail_footer.tpl create mode 100644 modules/lemonldap-ng-portal/example/skins/common/mail_header.tpl create mode 100644 modules/lemonldap-ng-portal/example/skins/common/mail_password.tpl diff --git a/build/lemonldap-ng/Makefile b/build/lemonldap-ng/Makefile index f44a0266a..6000cd335 100644 --- a/build/lemonldap-ng/Makefile +++ b/build/lemonldap-ng/Makefile @@ -310,8 +310,6 @@ install_portal_site: install_conf_dir @cp -pR --remove-destination ${SRCPORTALDIR}/example/error.pl ${RPORTALDIR} @cp -pR --remove-destination ${SRCPORTALDIR}/example/mail.pl ${RPORTALDIR} @cp -pR --remove-destination ${SRCPORTALDIR}/example/apps ${RPORTALDIR} - @$(PERL) -i -pe 's#__SKINDIR__#$(PORTALDIR)/skins#; \ - s#__APPSXMLFILE__#$(CONFDIR)/apps-list.xml#;' ${RPORTALDIR}/index.pl ${RPORTALDIR}/error.pl ${RPORTALDIR}/mail.pl @cp -pR --remove-destination ${SRCPORTALDIR}/example/skins/* $(RPORTALSKINSDIR) @if [ "$(PORTALDIR)/skins/" != "$(PORTALSKINSDIR)/" ]; then \ for skin in $$(ls lemonldap-ng-portal/example/skins/); do \ @@ -546,9 +544,9 @@ debian-diff: @for i in $(PORTALSKINS); do \ $(DIFF) -x 'jquery*' lemonldap-ng-portal/example/skins/$$i /usr/share/lemonldap-ng/portal-skins/$$i; \ done ||true - @$(DIFF) -I '$$skin_dir' -I '$$appsxmlfile' lemonldap-ng-portal/example/index_skin.pl /var/lib/lemonldap-ng/portal/index.pl ||true - @$(DIFF) -I '$$skin_dir' lemonldap-ng-portal/example/error.pl /var/lib/lemonldap-ng/portal/error.pl ||true - @$(DIFF) -I '$$skin_dir' lemonldap-ng-portal/example/mail.pl /var/lib/lemonldap-ng/portal/mail.pl ||true + @$(DIFF) lemonldap-ng-portal/example/index_skin.pl /var/lib/lemonldap-ng/portal/index.pl ||true + @$(DIFF) lemonldap-ng-portal/example/error.pl /var/lib/lemonldap-ng/portal/error.pl ||true + @$(DIFF) lemonldap-ng-portal/example/mail.pl /var/lib/lemonldap-ng/portal/mail.pl ||true @# Handler @$(DIFF) lemonldap-ng-handler/lib/Lemonldap/NG/Handler /usr/share/perl5/Lemonldap/NG/Handler ||true @# Common @@ -570,9 +568,9 @@ default-diff: @$(DIFF) lemonldap-ng-portal/example/scripts/purgeCentralCache $(LMPREFIX)/bin/purgeCentralCache ||true @$(DIFF) lemonldap-ng-portal/example/scripts/buildPortalWSDL $(LMPREFIX)/bin/buildPortalWSDL ||true @$(DIFF) lemonldap-ng-portal/example/skins $(LMPREFIX)/htdocs/portal/skins ||true - @$(DIFF) -I '$$skin_dir' -I '$$appsxmlfile' lemonldap-ng-portal/example/index_skin.pl $(LMPREFIX)/htdocs/portal/index.pl ||true - @$(DIFF) -I '$$skin_dir' lemonldap-ng-portal/example/error.pl $(LMPREFIX)/htdocs/portal/error.pl ||true - @$(DIFF) -I '$$skin_dir' lemonldap-ng-portal/example/mail.pl $(LMPREFIX)/htdocs/portal/mail.pl ||true + @$(DIFF) lemonldap-ng-portal/example/index_skin.pl $(LMPREFIX)/htdocs/portal/index.pl ||true + @$(DIFF) lemonldap-ng-portal/example/error.pl $(LMPREFIX)/htdocs/portal/error.pl ||true + @$(DIFF) lemonldap-ng-portal/example/mail.pl $(LMPREFIX)/htdocs/portal/mail.pl ||true @# Handler @$(DIFF) lemonldap-ng-handler/lib/Lemonldap/NG/Handler /usr/local/share/perl/5.10.0/Lemonldap/NG/Handler ||true @$(DIFF) lemonldap-ng-handler/example/MyHandler.pm $(LMPREFIX)/handler/MyHandler.pm ||true diff --git a/modules/lemonldap-ng-portal/example/error.pl b/modules/lemonldap-ng-portal/example/error.pl index cba69cc0e..62b05cb0b 100755 --- a/modules/lemonldap-ng-portal/example/error.pl +++ b/modules/lemonldap-ng-portal/example/error.pl @@ -1,8 +1,6 @@ #!/usr/bin/perl use HTML::Template; -my $skin_dir = "__SKINDIR__"; - my $portal = Lemonldap::NG::Portal::SharedConf->new( # PORTAL CUSTOMIZATION @@ -11,6 +9,7 @@ my $portal = Lemonldap::NG::Portal::SharedConf->new( ); my $skin = $portal->{portalSkin}; +my $skin_dir = $ENV{DOCUMENT_ROOT} . "skins"; my $portal_url = $portal->{portal}; my $logout_url = "$portal_url?logout=1"; diff --git a/modules/lemonldap-ng-portal/example/index_skin.pl b/modules/lemonldap-ng-portal/example/index_skin.pl index 77a0132f6..9eafc6b37 100755 --- a/modules/lemonldap-ng-portal/example/index_skin.pl +++ b/modules/lemonldap-ng-portal/example/index_skin.pl @@ -4,11 +4,6 @@ use Lemonldap::NG::Portal::SharedConf; use HTML::Template; use strict; -# Menu configuration -my $skin_dir = "__SKINDIR__"; -my $appsxmlfile = "__APPSXMLFILE__"; -my $appsimgpath = "apps/"; - my $portal = Lemonldap::NG::Portal::SharedConf->new( { @@ -149,7 +144,7 @@ my $portal = Lemonldap::NG::Portal::SharedConf->new( # Get skin value my $skin = $portal->{portalSkin}; - +my $skin_dir = $ENV{DOCUMENT_ROOT} . "skins"; my ( $skinfile, %templateParams ); #################### @@ -180,10 +175,6 @@ if ( $portal->process() ) { my $menu = Lemonldap::NG::Portal::Menu->new( { portalObject => $portal, - apps => { - xmlfile => "$appsxmlfile", - imgpath => "$appsimgpath", - }, modules => { appslist => $portal->{portalDisplayAppslist}, password => $portal->{portalDisplayChangePassword}, diff --git a/modules/lemonldap-ng-portal/example/mail.pl b/modules/lemonldap-ng-portal/example/mail.pl index 5816209d4..b6875546e 100755 --- a/modules/lemonldap-ng-portal/example/mail.pl +++ b/modules/lemonldap-ng-portal/example/mail.pl @@ -4,12 +4,11 @@ use Lemonldap::NG::Portal::MailReset; use HTML::Template; use strict; -my $skin_dir = "__SKINDIR__"; - # Load portal module my $portal = Lemonldap::NG::Portal::MailReset->new(); my $skin = $portal->{portalSkin}; +my $skin_dir = $ENV{DOCUMENT_ROOT} . "skins"; my $portal_url = $portal->{portal}; # Process @@ -33,10 +32,6 @@ $template->param( DISPLAY_FORM => 1 ) if ( $portal->{error} == PE_MAILFORMEMPTY or ( $portal->{error} == PE_BADCREDENTIALS and !$portal->{mail_token} ) ); -# Display password if change is OK -$template->param( NEW_PASSWORD => $portal->{reset_password} ) - if ( $portal->{error} == PE_PASSWORD_OK ); - print $portal->header('text/html; charset=utf8'); print $template->output; diff --git a/modules/lemonldap-ng-portal/example/skins/common/mail_confirm.tpl b/modules/lemonldap-ng-portal/example/skins/common/mail_confirm.tpl new file mode 100644 index 000000000..346c25e7a --- /dev/null +++ b/modules/lemonldap-ng-portal/example/skins/common/mail_confirm.tpl @@ -0,0 +1,11 @@ + + +

+,
+
+ + + +

+ + diff --git a/modules/lemonldap-ng-portal/example/skins/common/mail_footer.tpl b/modules/lemonldap-ng-portal/example/skins/common/mail_footer.tpl new file mode 100644 index 000000000..bc3674412 --- /dev/null +++ b/modules/lemonldap-ng-portal/example/skins/common/mail_footer.tpl @@ -0,0 +1,11 @@ + + + + + diff --git a/modules/lemonldap-ng-portal/example/skins/common/mail_header.tpl b/modules/lemonldap-ng-portal/example/skins/common/mail_header.tpl new file mode 100644 index 000000000..3e701f857 --- /dev/null +++ b/modules/lemonldap-ng-portal/example/skins/common/mail_header.tpl @@ -0,0 +1,17 @@ +
+ + + +
diff --git a/modules/lemonldap-ng-portal/example/skins/common/mail_password.tpl b/modules/lemonldap-ng-portal/example/skins/common/mail_password.tpl new file mode 100644 index 000000000..58c5f8b02 --- /dev/null +++ b/modules/lemonldap-ng-portal/example/skins/common/mail_password.tpl @@ -0,0 +1,9 @@ + + +

+,
+
+ $password +

+ + diff --git a/modules/lemonldap-ng-portal/example/skins/pastel/mail.tpl b/modules/lemonldap-ng-portal/example/skins/pastel/mail.tpl index 0512b428f..41799b825 100644 --- a/modules/lemonldap-ng-portal/example/skins/pastel/mail.tpl +++ b/modules/lemonldap-ng-portal/example/skins/pastel/mail.tpl @@ -27,11 +27,6 @@
- - -

- - "> diff --git a/modules/lemonldap-ng-portal/example/skins/pastel/styles.css b/modules/lemonldap-ng-portal/example/skins/pastel/styles.css index c02e0f3ae..937301a9a 100644 --- a/modules/lemonldap-ng-portal/example/skins/pastel/styles.css +++ b/modules/lemonldap-ng-portal/example/skins/pastel/styles.css @@ -20,7 +20,7 @@ margin:20px; } a img,:link img,:visited img { -border:none +border:none; } a, a:link, a:visited { diff --git a/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/MailReset.pm b/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/MailReset.pm index a94aba606..490620719 100644 --- a/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/MailReset.pm +++ b/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/MailReset.pm @@ -12,6 +12,7 @@ our $VERSION = '0.1'; use Lemonldap::NG::Portal::Simple qw(:all); use base qw(Lemonldap::NG::Portal::SharedConf Exporter); +use HTML::Template; *EXPORT_OK = *Lemonldap::NG::Portal::Simple::EXPORT_OK; *EXPORT_TAGS = *Lemonldap::NG::Portal::Simple::EXPORT_TAGS; @@ -24,6 +25,7 @@ use base qw(Lemonldap::NG::Portal::SharedConf Exporter); # - extractMailInfo # - storeMailSession # - sendConfirmationMail +# - sendPasswordMail # - portal core module: # - setMacros # - setLocalGroups @@ -44,7 +46,7 @@ sub process { $self->{error} = $self->_subProcess( qw(smtpInit userDBInit passwordDBInit extractMailInfo getUser setSessionInfo setMacros setLocalGroups setGroups - storeMailSession sendConfirmationMail resetPassword) + storeMailSession sendConfirmationMail resetPassword sendPasswordMail) ); return ( ( @@ -139,16 +141,71 @@ sub sendConfirmationMail { # Build confirmation url my $url = $self->{mailUrl} . "?mail_token=" . $self->{id}; - # Replace variables in mail body - $self->{mailBody} =~ s/\$url/$url/g; - $self->{mailBody} =~ s/\$(\w+)/$self->{sessionInfo}->{$1}/g; + # Build mail content + my $subject = $self->{mailConfirmSubject}; + my $body; + my $html; + if ( $self->{mailConfirmBody} ) { + + # We use a specific text message, no html + $body = $self->{mailConfirmBody}; + } + else { + + # Use HTML template + my $template = HTML::Template->new( + filename => $ENV{DOCUMENT_ROOT} . "skins/common/mail_confirm.tpl", + filter => sub { $self->translate_template(@_) } + ); + $body = $template->output(); + $html = 1; + } + + # Replace variables in body + $body =~ s/\$url/$url/g; + $body =~ s/\$(\w+)/$self->{sessionInfo}->{$1}/g; # Send mail - return PE_MAILERROR unless $self->send_mail( $self->{mail} ); + return PE_MAILERROR + unless $self->send_mail( $self->{mail}, $subject, $body, $html ); PE_MAILOK; } +sub sendPasswordMail { + my ($self) = @_; + + # Build mail content + my $subject = $self->{mailSubject}; + my $body; + my $html; + if ( $self->{mailBody} ) { + + # We use a specific text message, no html + $body = $self->{mailBody}; + } + else { + + # Use HTML template + my $template = HTML::Template->new( + filename => $ENV{DOCUMENT_ROOT} . "skins/common/mail_password.tpl", + filter => sub { $self->translate_template(@_) } + ); + $body = $template->output(); + $html = 1; + } + + # Replace variables in body + my $password = $self->{reset_password}; + $body =~ s/\$password/$password/g; + $body =~ s/\$(\w+)/$self->{sessionInfo}->{$1}/g; + + # Send mail + return PE_MAILERROR + unless $self->send_mail( $self->{mail}, $subject, $body, $html ); + + PE_MAILOK; +} 1; __END__ diff --git a/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/Menu.pm b/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/Menu.pm index ef810a0b1..535674a17 100644 --- a/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/Menu.pm +++ b/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/Menu.pm @@ -78,7 +78,6 @@ sub new { #&Lemonldap::NG::Portal::Simple::getSessionInfo( $self->{portalObject} ); # Default values - $self->{apps}->{xmlfile} ||= 'apps-list.xml'; $self->{apps}->{imgpath} ||= 'apps/'; $self->{modules}->{appslist} = 0 unless defined $self->{modules}->{appslist}; @@ -463,7 +462,7 @@ sub _isCategoryEmpty { } # Test this category - if ( $apphash->{type} eq "category" ) { + if ( $apphash->{type} and $apphash->{type} eq "category" ) { # Temporary store 'options' my $tmp_options = $apphash->{options}; diff --git a/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/PasswordDBDBI.pm b/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/PasswordDBDBI.pm index b8b863235..e4cefc1b9 100644 --- a/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/PasswordDBDBI.pm +++ b/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/PasswordDBDBI.pm @@ -108,10 +108,10 @@ sub resetPassword { return PE_ERROR unless $result; - # Store password to display it to the user + # Store password to forward it to the user $self->{reset_password} = $password; - PE_PASSWORD_OK; + PE_OK; } 1; diff --git a/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/PasswordDBLDAP.pm b/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/PasswordDBLDAP.pm index 3f2228afc..0d901c64d 100644 --- a/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/PasswordDBLDAP.pm +++ b/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/PasswordDBLDAP.pm @@ -106,10 +106,10 @@ sub resetPassword { $self->lmLog( "pwdReset set to TRUE", 'debug' ); } - # Store password to display it to the user + # Store password to forward it to the user $self->{reset_password} = $password; - PE_PASSWORD_OK; + PE_OK; } 1; diff --git a/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/Simple.pm b/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/Simple.pm index 672556b27..102779234 100644 --- a/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/Simple.pm +++ b/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/Simple.pm @@ -270,6 +270,8 @@ sub getConf { # Set default values. sub setDefaultValues { my $self = shift; + $self->{portal} ||= + "http" . ( $ENV{HTTPS} ? 's' : '' ) . '://' . $self->server_name(); $self->{whatToTrace} ||= 'uid'; $self->{whatToTrace} =~ s/^\$//; $self->{httpOnly} = 1 unless ( defined( $self->{httpOnly} ) ); @@ -296,8 +298,9 @@ sub setDefaultValues { $self->{mailLDAPFilter} ||= '(&(mail=$mail)(objectClass=inetOrgPerson))'; $self->{randomPasswordRegexp} ||= '[A-Z]{3}[a-z]{5}.\d{2}'; $self->{mailFrom} ||= "noreply@" . $self->{domain}; - $self->{mailSubject} ||= "[LemonLDAP::NG] Reset password confirmation"; - $self->{mailBody} ||= 'Click here to reset your password: $url'; + $self->{mailSubject} ||= "[LemonLDAP::NG] Your new password"; + $self->{mailConfirmSubject} ||= + "[LemonLDAP::NG] Password reset confirmation"; $self->{mailSessionKey} ||= 'mail'; $self->{mailUrl} ||= $self->{portal} . "/mail.pl"; $self->{issuerDB} ||= 'Null'; diff --git a/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/_SMTP.pm b/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/_SMTP.pm index a1fb71869..25c0c797b 100644 --- a/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/_SMTP.pm +++ b/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/_SMTP.pm @@ -25,24 +25,32 @@ sub gen_password { ## @method int send_mail() # Send mail -# @param mail mail +# @param mail recipient address +# @param subject mail subject +# @param body mail body +# @param html optional set content type to HTML # @return boolean result sub send_mail { my $self = shift; my $mail = shift; + my $subject = shift; + my $body = shift; + my $html = shift; $self->lmLog( "SMTP From " . $self->{mailFrom}, 'debug' ); $self->lmLog( "SMTP To " . $mail, 'debug' ); - $self->lmLog( "SMTP Subject " . $self->{mailSubject}, 'debug' ); - $self->lmLog( "SMTP Body " . $self->{mailBody}, 'debug' ); + $self->lmLog( "SMTP Subject " . $subject, 'debug' ); + $self->lmLog( "SMTP Body " . $body, 'debug' ); + $self->lmLog( "SMTP HTML flag " . ($html?"on":"off"), 'debug' ); eval { my $message = MIME::Lite->new( From => $self->{mailFrom}, To => $mail, - Subject => $self->{mailSubject}, + Subject => $subject, Type => "TEXT", - Data => $self->{mailBody}, + Data => $body, ); + $message->attr("content-type" => "text/html; charset=utf-8") if $html; $self->{SMTPServer} ? $message->send( "smtp", $self->{SMTPServer} ) : $message->send(); diff --git a/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/_i18n.pm b/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/_i18n.pm index e92b5b5a8..2227e7700 100644 --- a/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/_i18n.pm +++ b/modules/lemonldap-ng-portal/lib/Lemonldap/NG/Portal/_i18n.pm @@ -161,8 +161,8 @@ sub error_fr { "Confirmation demandée", "Veuillez saisir votre adresse mail", "La clé de confirmation est invalide ou trop ancienne", - "L'envoi du mail de confirmation a échoué", - "Un mail de confirmation vient d'être envoyé", + "L'envoi du mail a échoué", + "Un mail vous a été envoyé", ]; } @@ -217,7 +217,7 @@ sub error_en { 'Please provide your mail address', 'Confirmation key is invalid or too old', 'An error occurs when sending mail', - 'Confirmation mail has been sent', + 'A mail has been sent', ]; } @@ -272,8 +272,8 @@ sub error_ro { 'Confirmare necesare', 'Vă rugăm să introduceţi adresa dvs. de e-mail', 'Cheie de confirmare este invalid sau prea veche', - 'Trimiterea mail de confirmare nu a reuşit', - 'Un e-mail de confirmare a fost trimis', + 'Trimiterea mail nu a reuşit', + 'Un e-mail a fost trimis', ]; }