From d9dd5f284a2c5ea8aee3e94df7ce54d3fb111523 Mon Sep 17 00:00:00 2001
From: Colin Kuskie <colink@perldreamer.com>
Date: Mon, 20 Sep 2010 15:20:28 -0700
Subject: [PATCH] Rename template variables in the Account and Admin Toggle
 templates to not use underscores.

---
 docs/gotcha.txt                        |  8 ++++
 docs/templates.txt                     |  8 ++++
 docs/upgrades/upgrade_7.10.0-7.10.1.pl | 54 +++++++++++++++++++++++---
 3 files changed, 65 insertions(+), 5 deletions(-)

diff --git a/docs/gotcha.txt b/docs/gotcha.txt
index aacaa2fce..66d4758b6 100644
--- a/docs/gotcha.txt
+++ b/docs/gotcha.txt
@@ -25,6 +25,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
diff --git a/docs/templates.txt b/docs/templates.txt
index 921d98dd5..8680a747a 100644
--- a/docs/templates.txt
+++ b/docs/templates.txt
@@ -13,6 +13,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
 
diff --git a/docs/upgrades/upgrade_7.10.0-7.10.1.pl b/docs/upgrades/upgrade_7.10.0-7.10.1.pl
index 0878e6bd1..d96abd1fa 100644
--- a/docs/upgrades/upgrade_7.10.0-7.10.1.pl
+++ b/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().")");