Rename template variables in the Account and Admin Toggle templates to not use underscores.

docs/gotcha.txt

@@ -11,6 +11,14 @@ save you many hours of grief.
 --------------------------------------------------------------------
      * WebGUI now depends on PerlIO::eol, for doing line ending translation.
 
+     * As part of the migration to Template::Toolkit, we will be changing template
+       variables from using dots to underscores.  All templates using that namespace were
+       automatically upgraded to use the new variables.
+
+       In this version, these templates were updated:
+           Account Macro template
+           Admin Toggle Macro template
+
 7.10.0
 --------------------------------------------------------------------
      * Due to a bug in the 7.8.24-7.9.11 upgrade, the ordering of template

docs/templates.txt

@@ -3,6 +3,14 @@ templates, you will need to apply these changes manually to your copies.
 
 7.10.1
 
+  *  Account Macro template variables renamed:
+     account.url  => account_url
+     account.text => account_text
+
+  *  AdminToggle Macro template variables renamed:
+     toggle.url  => toggle_url
+     toggle.text => toggle_text
+
   *  Asset Report Template - asset-report/asset-report-default-template
      Remove the empty template attachment
 

docs/upgrades/upgrade_7.10.0-7.10.1.pl

@@ -33,7 +33,6 @@ my $session = start(); # this line required
 # upgrade functions go here
 uniqueProductLocations($session);
 removeBadSpanishFile($session);
-repackTemplates( $session );
 
 finish($session); # this line required
 
@@ -82,7 +81,7 @@ sub removeBadSpanishFile {
 sub repackTemplates {
     my $session = shift;
 
-    print "\n\t\tRepacking all templates, this may take a while..." unless $quiet;
+    print "\tRepacking all templates, this may take a while..." unless $quiet;
     my $sth = $session->db->read( "SELECT assetId, revisionDate FROM template" );
     while ( my ($assetId, $revisionDate) = $sth->array ) {
         my $asset       = WebGUI::Asset->newByDynamicClass( $session, $assetId, $revisionDate );
@@ -91,8 +90,9 @@ sub repackTemplates {
             template        => $asset->get('template'),
         });
     }
+    print "\t... DONE!\n" unless $quiet;
 
-    print "\n\t\tRepacking head tags in all assets, this may take a while..." unless $quiet;
+    print "\tRepacking head tags in all assets, this may take a while..." unless $quiet;
     $sth = $session->db->read( "SELECT assetId, revisionDate FROM assetData where usePackedHeadTags=1" );
     while ( my ($assetId, $revisionDate) = $sth->array ) {
         my $asset       = WebGUI::Asset->newByDynamicClass( $session, $assetId, $revisionDate );
@@ -101,8 +101,9 @@ sub repackTemplates {
             extraHeadTags       => $asset->get('extraHeadTags'),
         });
     }
+    print "\t... DONE!\n" unless $quiet;
 
-    print "\n\t\tRepacking all snippets, this may take a while..." unless $quiet;
+    print "\tRepacking all snippets, this may take a while..." unless $quiet;
     $sth = $session->db->read( "SELECT assetId, revisionDate FROM snippet" );
     while ( my ($assetId, $revisionDate) = $sth->array ) {
         my $asset       = WebGUI::Asset->newByDynamicClass( $session, $assetId, $revisionDate );
@@ -112,10 +113,50 @@ sub repackTemplates {
         });
     }
 
-    print "\n\t... DONE!\n" unless $quiet;
+    print "\t... DONE!\n" unless $quiet;
 }
 
 
+#----------------------------------------------------------------------------
+# Rename template variables
+sub renameAccountMacroTemplateVariables {
+    my $session = shift;
+
+    print "\tRename Account Macro template variables..." unless $quiet;
+    my $sth = $session->db->read( q|SELECT assetId, revisionDate FROM template where namespace="Macro/a_account"| );
+    while ( my ($assetId, $revisionDate) = $sth->array ) {
+        my $asset       = WebGUI::Asset->newByDynamicClass( $session, $assetId, $revisionDate );
+        next unless $asset;
+        my $template = $asset->get('template');
+        $template =~ s/account\.url/account_url/msg;
+        $template =~ s/account\.text/account_text/msg;
+        $asset->update({
+            template        => $template,
+        });
+    }
+    print "\t... DONE!\n" unless $quiet;
+}
+
+#----------------------------------------------------------------------------
+# Rename template variables
+sub renameAdminToggleMacroTemplateVariables {
+    my $session = shift;
+
+    print "\tRename Admin Toggle Macro template variables..." unless $quiet;
+    my $sth = $session->db->read( q|SELECT assetId, revisionDate FROM template where namespace="Macro/AdminToggle"| );
+    while ( my ($assetId, $revisionDate) = $sth->array ) {
+        my $asset       = WebGUI::Asset->newByDynamicClass( $session, $assetId, $revisionDate );
+        next unless $asset;
+        my $template = $asset->get('template');
+        $template =~ s/toggle\.url/toggle_url/msg;
+        $template =~ s/toggle\.text/toggle_text/msg;
+        $asset->update({
+            template        => $template,
+        });
+    }
+    print "\t... DONE!\n" unless $quiet;
+}
+
 #----------------------------------------------------------------------------
 # Describe what our function does
 #sub exampleFunction {
@@ -178,6 +219,9 @@ sub start {
 sub finish {
     my $session = shift;
     updateTemplates($session);
+    repackTemplates( $session );
+    renameAccountMacroTemplateVariables( $session );
+    renameAdminToggleMacroTemplateVariables( $session );
     my $versionTag = WebGUI::VersionTag->getWorking($session);
     $versionTag->commit;
     $session->db->write("insert into webguiVersion values (".$session->db->quote($toVersion).",'upgrade',".time().")");

lib/WebGUI/Help/Macro_AdminToggle.pm

@@ -6,7 +6,16 @@ our $HELP = {
     'admin toggle' => {
         title     => 'admin toggle title',
         body      => '',
-        variables => [ { 'name' => 'toggle.url' }, { 'name' => 'toggle.text' } ],
+        variables => [
+            {
+                name => 'toggle_url',
+                description => 'toggle.url',
+            },
+            {
+                name => 'toggle_text',
+                description => 'toggle.text',
+            },
+        ],
         fields    => [],
         related   => []
     },

lib/WebGUI/Help/Macro_a_account.pm

@@ -7,7 +7,16 @@ our $HELP = {
         title     => 'account title',
         body      => '',
         fields    => [],
-        variables => [ { 'name' => 'account.url' }, { 'name' => 'account.text' } ],
+        variables => [
+            {
+                name => 'account_url',
+                description => 'account.url',
+            },
+            {
+                name => 'account_text',
+                description => 'account.text',
+            }
+        ],
         related   => []
     },
 

lib/WebGUI/Macro/AdminToggle.pm

@@ -52,12 +52,12 @@ sub process {
     my $i18n = WebGUI::International->new($session,'Macro_AdminToggle');
     my %var;
     if ($session->var->isAdminOn) {
-        $var{'toggle.url'} = $session->url->page('op=switchOffAdmin');
+        $var{'toggle_url'} = $session->url->page('op=switchOffAdmin');
-        $var{'toggle.text'} = $turnOff || $i18n->get(517);
+        $var{'toggle_text'} = $turnOff || $i18n->get(517);
     }
     else {
-        $var{'toggle.url'} = $session->url->page('op=switchOnAdmin');
+        $var{'toggle_url'} = $session->url->page('op=switchOnAdmin');
-        $var{'toggle.text'} = $turnOn || $i18n->get(516);
+        $var{'toggle_text'} = $turnOn || $i18n->get(516);
     }
     my $template = $templateName    ? WebGUI::Asset::Template->newByUrl($session, $templateName)
                                     : WebGUI::Asset::Template->new($session, "PBtmpl0000000000000036");

lib/WebGUI/Macro/a_account.pm

@@ -44,8 +44,8 @@ sub process {
 	my  @param = @_;
 	return $session->url->page("op=auth;method=init") if ($param[0] eq "linkonly");
 	my $i18n = WebGUI::International->new($session,'Macro_a_account');
-	$var{'account.url'} = $session->url->page('op=auth;method=init');
+	$var{'account_url'} = $session->url->page('op=auth;method=init');
-	$var{'account.text'} = $param[0] || $i18n->get(46);
+	$var{'account_text'} = $param[0] || $i18n->get(46);
 	if ($param[1]) {
 		return  WebGUI::Asset::Template->newByUrl($session,$param[1])->process(\%var);
 	} else {

t/Macro/AdminToggle.t

@@ -145,7 +145,7 @@ sub addTemplate {
 		className => 'WebGUI::Asset::Template',
 		url => 'admintoggle-test',
 		namespace => 'Macro/AdminToggle',
-		template => "HREF=<tmpl_var toggle.url>\nLABEL=<tmpl_var toggle.text>",
+		template => "HREF=<tmpl_var toggle_url>\nLABEL=<tmpl_var toggle_text>",
 		id => 'AdminToggleTemplate--Z',
         usePacked => 0,
 	};

t/Macro/a_account.t

@@ -92,7 +92,7 @@ sub addTemplate {
 		className => 'WebGUI::Asset::Template',
 		url => 'a_account-test',
 		namespace => 'Macro/a_account',
-		template => "HREF=<tmpl_var account.url>\nLABEL=<tmpl_var account.text>",
+		template => "HREF=<tmpl_var account_url>\nLABEL=<tmpl_var account_text>",
 		id => 'testTemplatea_account1',
         usePacked => 1,
 	};