From 4936809746de8452d6537e65d16ca026286f1adb Mon Sep 17 00:00:00 2001
From: Coleman Watts <coleman@civicrm.org>
Date: Thu, 23 Jul 2015 21:46:36 -0400
Subject: [PATCH] CRM-16860 - Refactor out CRM_Upgrade_Incremental_Legacy

---
 CRM/Upgrade/Form.php                             | 14 ++++++--------
 .../Incremental/{Legacy.php => General.php}      | 16 ++++------------
 2 files changed, 10 insertions(+), 20 deletions(-)
 rename CRM/Upgrade/Incremental/{Legacy.php => General.php} (92%)

diff --git a/CRM/Upgrade/Form.php b/CRM/Upgrade/Form.php
index e2dcf1ca3c..b3eed3f6e5 100644
--- a/CRM/Upgrade/Form.php
+++ b/CRM/Upgrade/Form.php
@@ -763,21 +763,19 @@ SET    version = '$version'
    * @param $latestVer
    */
   public function setPreUpgradeMessage(&$preUpgradeMessage, $currentVer, $latestVer) {
-    CRM_Upgrade_Incremental_Legacy::setPreUpgradeMessage($preUpgradeMessage, $currentVer, $latestVer);
+    // check for changed message templates
+    CRM_Upgrade_Incremental_General::checkMessageTemplate($preUpgradeMessage, $latestVer, $currentVer);
+    // set global messages
+    CRM_Upgrade_Incremental_General::setPreUpgradeMessage($preUpgradeMessage, $currentVer, $latestVer);
 
     // Scan through all php files and see if any file is interested in setting pre-upgrade-message
     // based on $currentVer, $latestVer.
     // Please note, at this point upgrade hasn't started executing queries.
     $revisions = $this->getRevisionSequence();
     foreach ($revisions as $rev) {
-      if (version_compare($currentVer, $rev) < 0 &&
-        version_compare($rev, '3.2.alpha1') > 0
-      ) {
+      if (version_compare($currentVer, $rev) < 0) {
         $versionObject = $this->incrementalPhpObject($rev);
-        if (is_callable(array(
-          $versionObject,
-          'setPreUpgradeMessage',
-        ))) {
+        if (is_callable(array($versionObject, 'setPreUpgradeMessage'))) {
           $versionObject->setPreUpgradeMessage($preUpgradeMessage, $rev, $currentVer);
         }
       }
diff --git a/CRM/Upgrade/Incremental/Legacy.php b/CRM/Upgrade/Incremental/General.php
similarity index 92%
rename from CRM/Upgrade/Incremental/Legacy.php
rename to CRM/Upgrade/Incremental/General.php
index f9a9aae2cb..8d85862846 100644
--- a/CRM/Upgrade/Incremental/Legacy.php
+++ b/CRM/Upgrade/Incremental/General.php
@@ -34,10 +34,9 @@
  */
 
 /**
- * This class is a container for legacy upgrade logic which predates
- * the current 'CRM/Incremental/php/*' structure.
+ * This class contains generic upgrade logic which runs regardless of version.
  */
-class CRM_Upgrade_Incremental_Legacy {
+class CRM_Upgrade_Incremental_General {
 
   /**
    * Compute any messages which should be displayed before upgrade.
@@ -48,12 +47,6 @@ class CRM_Upgrade_Incremental_Legacy {
    * @param $latestVer
    */
   public static function setPreUpgradeMessage(&$preUpgradeMessage, $currentVer, $latestVer) {
-    $upgrade = new CRM_Upgrade_Form();
-    $template = CRM_Core_Smarty::singleton();
-
-    // check for changed message templates
-    self::checkMessageTemplate($template, $preUpgradeMessage, $latestVer, $currentVer);
-
     // http://issues.civicrm.org/jira/browse/CRM-13572
     // Depending on how the code was upgraded, some sites may still have copies of old
     // source files left behind. This is often a forgivable offense, but it's quite
@@ -88,12 +81,11 @@ class CRM_Upgrade_Incremental_Legacy {
   }
 
   /**
-   * @param $template
    * @param $message
    * @param $latestVer
    * @param $currentVer
    */
-  public static function checkMessageTemplate(&$template, &$message, $latestVer, $currentVer) {
+  public static function checkMessageTemplate(&$message, $latestVer, $currentVer) {
 
     $sql = "SELECT orig.workflow_id as workflow_id,
              orig.msg_title as title
@@ -106,7 +98,7 @@ class CRM_Upgrade_Incremental_Legacy {
                 )
             )";
 
-    $dao = &CRM_Core_DAO::executeQuery($sql);
+    $dao = CRM_Core_DAO::executeQuery($sql);
     while ($dao->fetch()) {
       $workflows[$dao->workflow_id] = $dao->title;
     }
-- 
2.25.1