rfe #9353: Welcome message template

docs/changelog/7.x.x.txt

@@ -1,4 +1,5 @@
 7.7.1
+ - rfe #9353: Welcome message template
 
 7.7.0
  - fixed #9913: New Content Side Bar missing in Asset window

docs/upgrades/upgrade_7.7.0-7.7.1.pl

@@ -32,8 +32,17 @@ my $session = start(); # this line required
 
 # upgrade functions go here
 
+addWelcomeMessageTemplateToSettings( $session );
+
 finish($session); # this line required
 
+sub addWelcomeMessageTemplateToSettings {
+    my $session = shift;
+    print "\tAdding welcome message template to settings \n" unless $quiet;
+
+    $session->db->write("insert into settings values ('webguiWelcomeMessageTemplate', 'PBtmpl0000000000000015');");
+    print "Done.\n" unless $quiet;
+}
 
 #----------------------------------------------------------------------------
 # Describe what our function does

lib/WebGUI/Auth.pm

@@ -298,11 +298,14 @@ sub createAccountSave {
     $self->saveParams($userId,$self->authMethod,$properties);
 
 	if ($self->getSetting("sendWelcomeMessage")){
-		my $authInfo = "\n\n".$i18n->get(50).": ".$username;
+        my $var;
-		$authInfo .= "\n".$i18n->get(51).": ".$password if($password);
+        $var->{welcomeMessage}      = $self->getSetting("welcomeMessage");
-		$authInfo .= "\n\n";
+        $var->{newUser_username}    = $username;
-		WebGUI::Inbox->new($self->session)->addMessage({
+        $var->{newUser_password}    = $password;
-			message	=> $self->getSetting("welcomeMessage").$authInfo,
+        my $message = WebGUI::Asset::Template->new($self->session,$self->getSetting('welcomeMessageTemplate'))->process($var);
+        WebGUI::Macro::process($self->session,\$message);
+        WebGUI::Inbox->new($self->session)->addMessage({
+            message => $message,
 			subject	=> $i18n->get(870),
 			userId	=> $self->userId,
             status  => 'completed',

lib/WebGUI/Auth/WebGUI.pm

@@ -497,7 +497,7 @@ sub editUserSettingsForm {
         -label     => $i18n->get(868,'WebGUI'),
         -hoverHelp => $i18n->get('868 help','WebGUI'),
     );
-    $f->textarea(
+    $f->HTMLArea(
         -name      => "webguiWelcomeMessage",
         -value     => $self->session->setting->get("webguiWelcomeMessage"),
         -label     => $i18n->get(869,'WebGUI'),
@@ -577,6 +577,13 @@ sub editUserSettingsForm {
 		-label     => $i18n->get("password recovery template"),
 		-hoverHelp => $i18n->get("password recovery template help")
     );
+    $f->template(
+        -name      => "webguiWelcomeMessageTemplate",
+        -value     => $self->session->setting->get("webguiWelcomeMessageTemplate"),
+        -namespace => "Auth/WebGUI/Welcome",
+        -label     => $i18n->get("welcome message template"),
+        -hoverHelp => $i18n->get("welcome message template help")
+    );
     $f->template(
         -name      => "webguiAccountActivationTemplate",
         -value     => $self->session->setting->get("webguiAccountActivationTemplate"),
@@ -635,6 +642,7 @@ sub editUserSettingsFormSave {
 	$s->set("webguiExpiredPasswordTemplate", $f->process("webguiExpiredPasswordTemplate","template"));
 	$s->set("webguiLoginTemplate", $f->process("webguiLoginTemplate","template"));
 	$s->set("webguiPasswordRecoveryTemplate", $f->process("webguiPasswordRecoveryTemplate","template"));
+    $s->set("webguiWelcomeMessageTemplate", $f->process("webguiWelcomeMessageTemplate","template"));
     $s->set("webguiAccountActivationTemplate", $f->process("webguiAccountActivationTemplate","template")); 
 
     if (@errors) {

lib/WebGUI/Help/AuthWebGUI.pm

@@ -163,6 +163,18 @@ our $HELP = {
         related   => [],
     },
 
+    'webgui welcome message template' => {
+        title => 'welcome message template title',
+        body  => '',
+        variables => [
+            { 'name' => 'welcomeMessage' },
+            { 'name' => 'newUser_username' },
+            { 'name' => 'newUser_password' },
+        ],
+        fields  => [],
+        related => []
+    },
+
     'account activation template' => {
         title => 'account activation template title',
         body  => '',

lib/WebGUI/Inbox/Message.pm

@@ -163,14 +163,9 @@ sub create {
             $preface = sprintf($i18n->get('from user preface'), $fromUser->username);
         }
         my $msg = (defined $properties->{emailMessage}) ? $properties->{emailMessage} : $self->{_properties}{message};
-		if ($msg =~ m/\<.*\>/) {
+		$msg = '<p>' . $preface . '</p><br />'.$msg if($preface ne "");
-            $msg = '<p>' . $preface . '</p><br />'.$msg if($preface ne "");
+        $mail->addHtml($msg);
-			$mail->addHtml($msg);
+        $mail->addFooter;
-		} else {
-            $msg = $preface."\n\n".$msg if($preface ne "");
-			$mail->addText($msg);
-		}
-		$mail->addFooter;
 		$mail->queue;
 	}
 	$self->{_session} = $session;

lib/WebGUI/i18n/English/AuthWebGUI.pm

@@ -65,7 +65,7 @@ our $I18N = {
     'account activation template title' => {
         message => q|WebGUI Authentication Account Activation Mail Template|,
         lastUpdated => 1230600500,
-        context => q|The title of the help page for the webgui auth welcome message template.|,
+        context => q|The title of the help page for the webgui auth account activition mail template.|,
     },
 
     'account activation template' => {
@@ -85,6 +85,32 @@ our $I18N = {
         lastUpdated => 1230600500,
     },
 
+    'welcome message template title' => {
+        message => q|WebGUI Authentication Welcome Message Template|,
+        lastUpdated => 0,
+        context => q|The title of the help page for the webgui auth welcome message template.|,
+    },
+
+    'welcome message template' => {
+        message => q|Welcome Message Template|,
+        lastUpdated => 0,
+        context => q|The label for the 'welcome message template' field on the Authentication tab of the Settings
+screen.|,
+    },
+
+    'welcome message template help' => {
+        message => q|Select a template for the welcome message that is sent to new users.|,
+        lastUpdated => 0,
+        context => q|The description of the 'welcome message template' field on the Authentication tab of the
+Settings screen, displayed as hoverhelp.|,
+    },
+
+    'welcomeMessage' => {
+        message => q|The welcome message as defined in the authentication settings.|,
+        lastUpdated => 0,
+        context => q|Description of the welcomeMessage tmpl_var for the template help.|,
+    },
+
 	'use captcha' => {
 		message => q|Use captcha image?|,
 		lastUpdated => 1078852836
@@ -764,6 +790,12 @@ our $I18N = {
         message     => 'Username of registering user',
     },
 
+    'newUser_password' => {
+        message => q|The password for the newly created account.|,
+        lastUpdated => 0,
+        context => q|Description of the newUser_password tmpl_var for the template help.|,
+    },
+
 };
 
 1;