salesagility_SuiteCRM/modules/Campaigns/Subscriptions.php

<?php
 /**
  *
  * 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.
  *
  * 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
  * Free Software Foundation with the addition of the following permission added
  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  *
  * This program is distributed in the hope that it will be useful, but WITHOUT
  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
  * details.
  *
  * You should have received a copy of the GNU Affero General Public License along with
  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  * 02110-1301 USA.
  *
  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  *
  * The interactive user interfaces in modified source and object code versions
  * of this program must display Appropriate Legal Notices, as required under
  * Section 5 of the GNU Affero General Public License version 3.
  *
  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  * these Appropriate Legal Notices must retain the display of the "Powered by
  * SugarCRM" logo and "Supercharged by SuiteCRM" logo. If the display of the logos is not
  * reasonably feasible for technical reasons, the Appropriate Legal Notices must
  * display the words "Powered by SugarCRM" and "Supercharged by SuiteCRM".
  */

 if (!defined('sugarEntry') || !sugarEntry) {
     die('Not A Valid Entry Point');
 }

require_once('modules/Campaigns/utils.php');

global $mod_strings, $app_list_strings, $app_strings, $current_user, $import_bean_map;
global $import_file_name, $theme;

$focus = 0;
if (isset($_REQUEST['return_module'])) {
    if ($_REQUEST['return_module'] == 'Contacts') {
        $focus = BeanFactory::newBean('Contacts');
    }
    if ($_REQUEST['return_module'] == 'Leads') {
        $focus = BeanFactory::newBean('Leads');
    }
    if ($_REQUEST['return_module'] == 'Prospects') {
        $focus = BeanFactory::newBean('Prospects');
    }
}

if (isset($_REQUEST['record'])) {
    $GLOBALS['log']->debug("In Subscriptions, about to retrieve record: ".$_REQUEST['record']);
    $result = $focus->retrieve($_REQUEST['record']);
    if ($result == null) {
        sugar_die($app_strings['ERROR_NO_RECORD']);
    }
}


$this->ss->assign("MOD", $mod_strings);
$this->ss->assign("APP", $app_strings);

if (isset($_REQUEST['return_module'])) {
    $this->ss->assign("RETURN_MODULE", $_REQUEST['return_module']);
} else {
    $this->ss->assign("RETURN_MODULE", '');
}
if (isset($_REQUEST['return_id'])) {
    $this->ss->assign("RETURN_ID", $_REQUEST['return_id']);
} else {
    $this->ss->assign("RETURN_ID", '');
}
if (isset($_REQUEST['return_action'])) {
    $this->ss->assign("RETURN_ACTION", $_REQUEST['return_action']);
} else {
    $this->ss->assign("RETURN_ACTION", '');
}
if (isset($_REQUEST['record'])) {
    $this->ss->assign("RECORD", $_REQUEST['record']);
} else {
    $this->ss->assign("RECORD", '');
}

//if subsaction has been set, then process subscriptions
if (isset($_REQUEST['subs_action'])) {
    manageSubscriptions($focus);
    SugarApplication::redirect("index.php?module=" . $_REQUEST['return_module'] . "&action=" . $_REQUEST['return_action'] . "&record=" . $_REQUEST['record']);
}

//$title = $GLOBALS['app_strings']['LBL_MANAGE_SUBSCRIPTIONS_FOR'].$focus->name;
$params = array();
$params[]  = "<a href='index.php?module={$focus->module_dir}&action=index'>{$focus->module_dir}</a>";
$params[] = "<a href='index.php?module={$focus->module_dir}&action=DetailView&record={$focus->id}'>{$focus->name}</a>";
$params[] = $mod_strings['LBL_MANAGE_SUBSCRIPTIONS_TITLE'];
$title = getClassicModuleTitle($focus->module_dir, $params, true);
$orig_vals_str = printOriginalValues($focus);
$orig_vals_array = constructDDSubscriptionList($focus);

$this->ss->assign('APP', $app_strings);
$this->ss->assign('MOD', $mod_strings);
$this->ss->assign('title', $title);

$this->ss->assign('enabled_subs', $orig_vals_array[0]);
$this->ss->assign('disabled_subs', $orig_vals_array[1]);
$this->ss->assign('enabled_subs_string', $orig_vals_str[0]);
$this->ss->assign('disabled_subs_string', $orig_vals_str[1]);

$buttons = array(
    '<input id="save_button" title="'.$app_strings['LBL_SAVE_BUTTON_TITLE'].'" accessKey="'.$app_strings['LBL_SAVE_BUTTON_KEY'].'" onclick="save();this.form.action.value=\'Subscriptions\'; " type="submit" name="button" value="'.$app_strings['LBL_SAVE_BUTTON_LABEL'].'">',
    '<input id="cancel_button" title="'.$app_strings['LBL_CANCEL_BUTTON_TITLE'].'" accessKey="'.$app_strings['LBL_CANCEL_BUTTON_KEY'].'" onclick="this.form.action.value=\''.$this->ss->get_template_vars('RETURN_ACTION').'\'; this.form.module.value=\''.$this->ss->get_template_vars('RETURN_MODULE').'\';" type="submit" name="button" value="'.$app_strings['LBL_CANCEL_BUTTON_LABEL'].'">'
);
$this->ss->assign('BUTTONS', $buttons);
$this->ss->display('modules/Campaigns/Subscriptions.tpl');

/*
 *This function constructs Drag and Drop multiselect box of subscriptions for display in manage subscription form
*/
function constructDDSubscriptionList($focus, $classname='')
{
    require_once("include/templates/TemplateDragDropChooser.php");
    global $mod_strings;
    $unsubs_arr = '';
    $subs_arr =  '';

    // Lets start by creating the subscription and unsubscription arrays
    $subscription_arrays = get_subscription_lists($focus);
    $unsubs_arr = $subscription_arrays['unsubscribed'];
    $subs_arr =  $subscription_arrays['subscribed'];

    $comb_array = array();
    $comb_array [0] = array();
    $comb_array [1] = array();

    foreach ($subs_arr as $key=>$val) {
        $comb_array [0][$val] = $key;
    }


    foreach ($unsubs_arr as $key=>$val) {
        $comb_array [1][$val] = $key;
    }

    return $comb_array ;
}


 /*
 *This function constructs multiselect box of subscriptions for display in manage subscription form
 */
 function printOriginalValues($focus)
 {
     $return_arr = [];

     // Lets start by creating the subscription and unsubscription arrays
     $subscription_arrays = get_subscription_lists($focus);
     $unsubs_arr = $subscription_arrays['unsubscribed'];
     $subs_arr = $subscription_arrays['subscribed'];

     //    ORIG_UNSUBS_VALUES
     $unsubs_vals = ' ';
     $subs_vals = ' ';
     foreach ($subs_arr as $name => $id) {
         $subs_vals .= ", $id";
     }
     $return_arr[] = $subs_vals;

     foreach ($unsubs_arr as $name => $id) {
         $unsubs_vals .= ", $id";
     }

     $return_arr[] = $unsubs_vals;

     return $return_arr;
 }


/*
 * Perform Subscription management work.  This function processes selected subscriptions and calls the
 * right methods to subscribe or unsubscribe the user
 * */

function manageSubscriptions($focus)
{


    //Process Subscription Lists first
    //compare current list of subscriptions to original list and see if there are any additions
    $orig_subscription_arr = array();
    $curr_subscription_arr = array();
    //build array of original subscriptions
    if (isset($_REQUEST['orig_enabled_values'])  && ! empty($_REQUEST['orig_enabled_values'])) {
        $orig_subscription_arr = explode(",", $_REQUEST['orig_enabled_values']);
        $orig_subscription_arr = process_subscriptions($orig_subscription_arr);
    }

    //build array of current subscriptions
    if (isset($_REQUEST['enabled_subs'])  && ! empty($_REQUEST['enabled_subs'])) {
        $curr_subscription_arr = explode(",", $_REQUEST['enabled_subs']);
        $curr_subscription_arr = process_subscriptions($curr_subscription_arr);
    }

    //compare both arrays and find differences
    $i=0;
    while ($i<((is_countable($curr_subscription_arr) ? count($curr_subscription_arr) : 0)/2)) {
        //if current subscription existed in original subscription list, do nothing
        if (in_array($curr_subscription_arr['campaign'.$i], $orig_subscription_arr)) {
            //nothing to process
        } else {
            //current subscription is new, so subscribe
            subscribe($curr_subscription_arr['campaign'.$i], $curr_subscription_arr['prospect_list'.$i], $focus);
        }
        $i = $i +1;
    }

    //Now process UnSubscription Lists first
    //compare current list of subscriptions to original list and see if there are any additions
    $orig_unsubscription_arr = array();
    $curr_unsubscription_arr = array();

    //build array of original subscriptions
    if (isset($_REQUEST['orig_disabled_values'])  && ! empty($_REQUEST['orig_disabled_values'])) {
        $orig_unsubscription_arr = explode(",", $_REQUEST['orig_disabled_values']);
        $orig_unsubscription_arr = process_subscriptions($orig_unsubscription_arr);
    }

    //build array of current subscriptions
    if (isset($_REQUEST['disabled_subs'])  && ! empty($_REQUEST['disabled_subs'])) {
        $curr_unsubscription_arr = explode(",", $_REQUEST['disabled_subs']);
        $curr_unsubscription_arr = process_subscriptions($curr_unsubscription_arr);
    }
    //compare both arrays and find differences
    $i=0;
    while ($i<((is_countable($curr_unsubscription_arr) ? count($curr_unsubscription_arr) : 0)/2)) {
        //if current subscription existed in original subscription list, do nothing
        if (in_array($curr_unsubscription_arr['campaign'.$i], $orig_unsubscription_arr)) {
            //nothing to process
        } else {
            //current subscription is new, so subscribe
            unsubscribe($curr_unsubscription_arr['campaign'.$i], $focus);
        }
        $i = $i +1;
    }
}