From 76bb4f66c40df84fce278c0a155685bb8a03d7cd Mon Sep 17 00:00:00 2001
From: "s.samko" <serhii.samko@salesagility.com>
Date: Thu, 6 Jun 2024 12:32:39 +0100
Subject: [PATCH] Fix #2009 - Default for Campaign Type field causes incorrect
 wizard

---
 modules/Campaigns/WizardNewsletter.php | 31 ++++---------
 modules/Campaigns/utils.php            | 64 ++++++++++++++++++++++++--
 2 files changed, 70 insertions(+), 25 deletions(-)

diff --git a/modules/Campaigns/WizardNewsletter.php b/modules/Campaigns/WizardNewsletter.php
index c05e4fcabae..f5e4fd231e4 100755
--- a/modules/Campaigns/WizardNewsletter.php
+++ b/modules/Campaigns/WizardNewsletter.php
@@ -1,14 +1,12 @@
 <?php
-if (!defined('sugarEntry') || !sugarEntry) {
-    die('Not A Valid Entry Point');
-}
+
 /**
  *
  * SugarCRM Community Edition is a customer relationship management program developed by
  * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
  *
  * SuiteCRM is an extension to SugarCRM Community Edition developed by SalesAgility Ltd.
- * Copyright (C) 2011 - 2018 SalesAgility Ltd.
+ * Copyright (C) 2011 - 2024 SalesAgility Ltd.
  *
  * This program is free software; you can redistribute it and/or modify it under
  * the terms of the GNU Affero General Public License version 3 as published by the
@@ -41,15 +39,14 @@
  * display the words "Powered by SugarCRM" and "Supercharged by SuiteCRM".
  */
 
-
+if (!defined('sugarEntry') || !sugarEntry) {
+    die('Not A Valid Entry Point');
+}
 
 /******** general UI Stuff ***********/
 
-
-
 require_once('modules/Campaigns/utils.php');
 
-
 global $app_strings;
 global $timedate;
 global $app_list_strings;
@@ -119,20 +116,12 @@
 
 
 //set the campaign type based on wizardtype value from request object
-$campaign_type = 'newsletter';
-if ((isset($_REQUEST['wizardtype'])  && $_REQUEST['wizardtype']==1)  ||  ($focus->campaign_type=='NewsLetter')) {
-    $campaign_type = 'newsletter';
-    $ss->assign("CAMPAIGN_DIAGNOSTIC_LINK", diagnose());
-} elseif ((isset($_REQUEST['wizardtype'])  && $_REQUEST['wizardtype']==2)  || ($focus->campaign_type=='Email')) {
-    $campaign_type = 'email';
-    $ss->assign("CAMPAIGN_DIAGNOSTIC_LINK", diagnose());
-} elseif ((isset($_REQUEST['wizardtype'])  && $_REQUEST['wizardtype']==4) || ($focus->campaign_type == 'Survey')) {
-    $campaign_type = 'survey';
-    $ss->assign("CAMPAIGN_DIAGNOSTIC_LINK", diagnose());
-} else {
-    $campaign_type = 'general';
-}
+$campaign_type = '';
+
+$wizardType = $_REQUEST['wizardtype'] ?? '';
 
+$campaign_type = assignCampaignType($focus, $wizardType, checkRequestWizardType($wizardType));
+$ss->assign("CAMPAIGN_DIAGNOSTIC_LINK", diagnose());
 
 //******** CAMPAIGN HEADER AND BUDGET UI DIV Stuff (both divs) **********/
 /// Users Popup
diff --git a/modules/Campaigns/utils.php b/modules/Campaigns/utils.php
index 1599f7fe3df..a0c86d2c532 100755
--- a/modules/Campaigns/utils.php
+++ b/modules/Campaigns/utils.php
@@ -1,14 +1,12 @@
 <?php
-if (!defined('sugarEntry') || !sugarEntry) {
-    die('Not A Valid Entry Point');
-}
+
 /**
  *
  * SugarCRM Community Edition is a customer relationship management program developed by
  * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
  *
  * SuiteCRM is an extension to SugarCRM Community Edition developed by SalesAgility Ltd.
- * Copyright (C) 2011 - 2018 SalesAgility Ltd.
+ * Copyright (C) 2011 - 2024 SalesAgility Ltd.
  *
  * This program is free software; you can redistribute it and/or modify it under
  * the terms of the GNU Affero General Public License version 3 as published by the
@@ -49,6 +47,10 @@
  * Contributor(s): ______________________________________..
  ********************************************************************************/
 
+if (!defined('sugarEntry') || !sugarEntry) {
+    die('Not A Valid Entry Point');
+}
+
 /*
  *returns a list of objects a message can be scoped by, the list contacts the current campaign
  *name and list of all prospects associated with this campaign..
@@ -1202,3 +1204,57 @@ function isValidWebToPersonModule(string $module): bool
 
     return in_array($module, $validModules, true);
 }
+
+/**
+ * Helper function to check request data is present;
+ * @param string $requestWizardType
+ * @return bool
+ */
+function checkRequestWizardType(string $requestWizardType): bool
+{
+    if (isset($requestWizardType) && !empty($requestWizardType)) {
+        return true;
+    }
+
+    return false;
+}
+
+/**
+ *  Assigns a value of campaign type wheather recieved from $_REQUEST object
+ *  (values from WizardHomeStart.tpl) or based on the bean properties;
+ * @param SugarBean $focus
+ * @param bool $requestWizardType
+ * @return string
+ */
+function assignCampaignType(SugarBean $focus, string $wizardType, bool $requestWizardType): string
+{
+    $campaignType = '';
+
+    $campaignTypes = [
+        'NewsLetter' => 'newsletter',
+        'Email' => 'email',
+        'General' => 'general',
+        'Survey' => 'survey',
+    ];
+
+    if ($requestWizardType) {
+        switch ($wizardType) {
+            case '1':
+                $campaignType = $campaignTypes['NewsLetter'];
+                break;
+            case '2':
+                $campaignType = $campaignTypes['Email'];
+                break;
+            case '4':
+                $campaignType = $campaignTypes['Survey'];
+                break;
+            case '3':
+            default:
+                $campaignType = $campaignTypes['General'];
+        }
+    } else {
+        $campaignType = $campaignTypes[$focus->campaign_type] ?? $campaignTypes['General'];
+    }
+
+    return $campaignType;
+}