Elep

<?php
/*
 * Your installation or use of this SugarCRM file is subject to the applicable
 * terms available at
 * http://support.sugarcrm.com/Resources/Master_Subscription_Agreements/.
 * If you do not agree to all of the applicable terms or do not have the
 * authority to bind the entity as an authorized representative, then do not
 * install or use this SugarCRM file.
 *
 * Copyright (C) SugarCRM Inc. All rights reserved.
 */

global $theme, $mod_strings, $current_language;

global $href_string;
$href_string = "javascript:node_click('activetimeperiods','activetimeperiodsworksheet','div','get_worksheet')";
//language strings:
$mod_strings = return_module_language($current_language, 'Forecasts');
$GLOBALS['displayListView'] = true;

/**
 * @deprecated Will be removed in 15.1.0
 * @param $user_id
 * @param $forecast_type
 * @param $timeperiod_id
 * @param $allow_commit
 * @return void
 * @throws SugarApiExceptionNotFound
 */
function get_worksheet_defintion($user_id, $forecast_type, $timeperiod_id, $allow_commit = false)
{
    $GLOBALS['log']->fatal("Deprecated function get_worksheet_defintion called.");
    $lv = null;
    //global variable references.
    global $current_user;
    global $current_language;
    global $app_strings;
    global $even_bg, $odd_bg;
    global $mod_strings;

$sel_user = BeanFactory::getBean('Users', $user_id);

$json = new JSON();

//make list view happy.
    $_REQUEST['module'] = 'Forecasts';
    $_REQUEST['action'] = 'Index';

//initialize hierarchy helper function.
    $hhelper = new Common();
    $hhelper->set_current_user($user_id);
    $hhelper->setup();

$seedForecastOpportunities = BeanFactory::newBean('ForecastOpportunities');
    if (strtolower($forecast_type) == 'direct') {
        $lv = new ListViewSmarty();
        $lv->lvd->additionalDetailsAjax = false;
        $lv->showMassupdateFields = false;
        $where = 'opportunities.deleted=0 ';
        $where .= " AND opportunities.assigned_user_id = '$user_id'";
        $where .= ' AND opportunities.date_closed >= timeperiods.start_date';
        $where .= ' AND opportunities.date_closed <= timeperiods.end_date';
        $where .= " AND opportunities.sales_stage != '" . Opportunity::STAGE_CLOSED_LOST . "'";
        $where .= " AND timeperiods.id = '$timeperiod_id'";

$hhelper->get_timeperiod_start_end_date($timeperiod_id);
        $seedForecastOpportunities->current_user_id = $user_id;
        $seedForecastOpportunities->current_timeperiod_id = $timeperiod_id;

//set forecast owner details.
        $seedForecastOpportunities->fo_user_id = $current_user->id;
        $seedForecastOpportunities->fo_timeperiod_id = $timeperiod_id;
        //use the current users' forecsat type is allow commit is set.
        //this allows for seprate worksheets for same user on one page.
        if ($allow_commit) {
            $seedForecastOpportunities->fo_forecast_type = $forecast_type;
        } else {
            $seedForecastOpportunities->fo_forecast_type = 'Rollup';
        }

$opp_summary = $seedForecastOpportunities->get_opportunity_summary();

//build the summary information. do not show it if the logged in current view user is not the logged in
        //user.
        $directsummary = '';
        if ($allow_commit && $user_id == $current_user->id && ACLController::checkAccess('Forecasts', 'edit', true)) {
            $lv->ss->assign('commit_allowed', 'true');
        }

$lv->ss->assign('CURRENCY_SYMBOL', $seedForecastOpportunities->currency->symbol);

$prev_commit = $seedForecastOpportunities->get_last_committed_direct_forecast();
        $lv->ss->assign('PREV_COMMIT_DATE', $prev_commit['DATE_ENTERED']);
        $lv->ss->assign('PREV_BEST_CASE', $prev_commit['BEST_CASE']);
        $lv->ss->assign('PREV_LIKELY_CASE', $prev_commit['LIKELY_CASE']);
        $lv->ss->assign('PREV_WORST_CASE', $prev_commit['WORST_CASE']);

$totals = ['NAME' => translate('LBL_TOTAL_VALUE', 'Forecasts'), 'REVENUE' => $opp_summary['TOTAL_AMOUNT'], 'PROBABILITY' => '&nbsp;', 'WEIGHTED_VALUE' => $opp_summary['WEIGHTEDVALUE'], 'WK_BEST_CASE' => $opp_summary['TOTAL_WK_BEST_CASE'], 'WK_LIKELY_CASE' => $opp_summary['TOTAL_WK_LIKELY_CASE'], 'WK_WORST_CASE' => $opp_summary['TOTAL_WK_WORST_CASE'],];
        $lv->ss->assign('totals', $totals);
        $lv->ss->assign('COPY_LINK', buildExportLink('direct'));
        $lv->ss->assign('USER_ID', $current_user->id);
        $lv->ss->assign('TIMEPERIOD_ID', $timeperiod_id);
        if ($allow_commit) {
            $lv->ss->assign('FORECASTTYPE', $forecast_type); //top level forecast type.
        } else {
            $lv->ss->assign('FORECASTTYPE', 'Rollup'); //top level forecast type.
        }

//set current users forecast  details into the form.
        $lv->ss->assign('SEL_USER_ID', $user_id);
        $lv->ss->assign('SEL_TIMEPERIOD_ID', $timeperiod_id);
        $lv->ss->assign('SEL_FORECASTTYPE', $forecast_type);

//assign opp count and total weighted amount.
        $lv->ss->assign('CURRENTOPPORTUNITYCOUNT', $opp_summary['OPPORTUNITYCOUNT']);
        $lv->ss->assign('CURRENTWEIGHTEDVALUENUMBER', $opp_summary['WEIGHTEDVALUENUMBER']);
        //assign the qota amount.
        $lv->ss->assign('QUOTA_VALUE', $seedForecastOpportunities->get_quota());
        global $listViewDefs;
        include 'modules/Forecasts/metadata/listviewdefs.php';
        $lv->displayColumns = $listViewDefs['ForecastOpportunities'];

//disable some features.
        $lv->multiSelect = false;
        $lv->export = false;
        $lv->delete = false;
        $lv->select = false;
        $lv->show_mass_update_form = false;
        $lv->setup($seedForecastOpportunities, 'modules/Forecasts/ListViewForecast.tpl', $where);
    } else {
        //create where clause....
        if (user_owns_opps($user_id, null)) {
            $where = ' users.deleted=0 ';
            $where .= " AND (users.id = '$user_id'";
            $where .= " or users.reports_to_id = '$user_id')";
        } else {
            $where = ' users.deleted=0 ';
            $where .= " AND users.reports_to_id = '$user_id'";
        }

$hhelper->get_timeperiod_start_end_date($timeperiod_id);

//Get the forecasts created by the direct reports.
        $DirReportsFocus = new ForecastDirectReports();
        $DirReportsFocus->current_user_id = $user_id;
        $DirReportsFocus->current_timeperiod_id = $timeperiod_id;
        //list totals.
        $DirReportsFocus->compute_rollup_totals('', $where);
        //create totals array for all field in the list view.
        ///user_name, opportunities, weighted amount, committed amount, Date committed, Adjusted amount
        $totals = ['USER_NAME' => $mod_strings['LBL_TOTAL_VALUE'], 'BEST_CASE' => $DirReportsFocus->total_best_case_number, 'LIKELY_CASE' => $DirReportsFocus->total_likely_case_number, 'WORST_CASE' => $DirReportsFocus->total_worst_case_number, 'DATE_COMMITTED' => '&nbsp;', 'WK_BEST_CASE' => $DirReportsFocus->total_wk_best_case_number, 'WK_LIKELY_CASE' => $DirReportsFocus->total_wk_likely_case_number, 'WK_WORST_CASE' => $DirReportsFocus->total_wk_worst_case_number,];
        //build list view contents.
        if (ACLController::checkAccess('Forecasts', 'list', true)) {
            $lv = new ListViewSmarty();
            $lv->lvd->additionalDetailsAjax = false;
            global $listViewDefs;
            include 'modules/Forecasts/metadata/listviewdefs.php';
            $lv->displayColumns = $listViewDefs['ForecastDirectReports'];
            //disable some features.
            $lv->multiSelect = false;
            $lv->delete = false;
            $lv->select = false;
            $lv->export = false;
            $lv->show_mass_update_form = false;

$lv->setup($DirReportsFocus, 'modules/Forecasts/ListViewForecast.tpl', $where);

//assign logged in user's forecast details.
            //this is for user who owns the forecast.
            $lv->ss->assign('USER_ID', $current_user->id);
            $lv->ss->assign('TIMEPERIOD_ID', $timeperiod_id);
            $lv->ss->assign('FORECASTTYPE', 'Rollup'); //top level forecast type.

//set current users forecast  details into the form.
            $lv->ss->assign('SEL_USER_ID', $user_id);
            $lv->ss->assign('SEL_TIMEPERIOD_ID', $timeperiod_id);
            $lv->ss->assign('SEL_FORECASTTYPE', $forecast_type);

//commit allowed for this user.
            if ($allow_commit && $user_id == $current_user->id && ACLController::checkAccess('Forecasts', 'edit', true)) {
                $lv->ss->assign('commit_allowed', 'true');
                $lv->ss->assign('COPY_LINK', buildExportLink('rollup'));
            }
            $prev_commit = $DirReportsFocus->get_last_committed_forecast();
            $lv->ss->assign('PREV_COMMIT_DATE', $prev_commit['DATE_ENTERED']);
            $lv->ss->assign('PREV_BEST_CASE', $prev_commit['BEST_CASE']);
            $lv->ss->assign('PREV_LIKELY_CASE', $prev_commit['LIKELY_CASE']);
            $lv->ss->assign('PREV_WORST_CASE', $prev_commit['WORST_CASE']);

$lv->ss->assign('totals', $totals);
        }

$lv->ss->assign('CURRENCY_SYMBOL', $DirReportsFocus->currency->symbol);

$lv->ss->assign('CURRENTOPPORTUNITYCOUNT', $DirReportsFocus->total_opp_count);
        $lv->ss->assign('CURRENTWEIGHTEDVALUENUMBER', $DirReportsFocus->total_weigh_value_number);

//assign the qota amount.
        $lv->ss->assign('QUOTA_VALUE', $DirReportsFocus->get_quota());
    }

//process page urls.
    if (isset($lv->data['pageData']['urls']['endPage'])) {
        $lv->ss->assign('endPageJSON', processnavigation($lv->data['pageData']['urls']['endPage'], $json));
        $lv->data['pageData']['urls']['endPage'] = 'javascript:goToNav(3)';
    }
    if (isset($lv->data['pageData']['urls']['startPage'])) {
        $lv->ss->assign('startPageJSON', processnavigation($lv->data['pageData']['urls']['startPage'], $json));
        $lv->data['pageData']['urls']['startPage'] = 'javascript:goToNav(0)';
    }
    if (isset($lv->data['pageData']['urls']['nextPage'])) {
        $lv->ss->assign('nextPageJSON', processnavigation($lv->data['pageData']['urls']['nextPage'], $json));
        $lv->data['pageData']['urls']['nextPage'] = 'javascript:goToNav(2)';
    }
    if (isset($lv->data['pageData']['urls']['prevPage'])) {
        $lv->ss->assign('prevPageJSON', processnavigation($lv->data['pageData']['urls']['prevPage'], $json));
        $lv->data['pageData']['urls']['prevPage'] = 'javascript:goToNav(1)';
    }

//process display columns
    $orderby_array = processnavigation($lv->data['pageData']['urls']['orderBy']);
    //{$pageData.urls.orderBy}{$params.orderBy|default:$colHeader|lower}'
    foreach ($lv->displayColumns as $key => $values) {
        if (!empty($values['orderBy'])) {
            $orderby_array[$lv->lvd->var_order_by] = strtolower($values['orderBy']);
        } else {
            if (!empty($values['tablename'])) {
                $orderby_array[$lv->lvd->var_order_by] = $values['tablename'] . '.' . strtolower($key);
            } else {
                $orderby_array[$lv->lvd->var_order_by] = strtolower($key);
            }
        }
        $lv->displayColumns[$key]['order_by_object'] = $json->encode($orderby_array);
    }
    $lv->ss->assign('displayColumns', $lv->displayColumns);

//assign label values to the template.
    $lv->ss->assign('LBL_DV_LAST_COMMIT_DATE', $mod_strings['LBL_DV_LAST_COMMIT_DATE']);
    $lv->ss->assign('LBL_DV_LAST_COMMIT_AMOUNT', $mod_strings['LBL_DV_LAST_COMMIT_AMOUNT']);
    $lv->ss->assign('LBL_COMMIT_NOTE', $mod_strings['LBL_COMMIT_NOTE']);
    $lv->ss->assign('LBL_QC_COMMIT_BUTTON', $mod_strings['LBL_QC_COMMIT_BUTTON']);
    $lv->ss->assign('LBL_SAVE_WOKSHEET', $mod_strings['LBL_SAVE_WOKSHEET']);
    $lv->ss->assign('LBL_RESET_WOKSHEET', $mod_strings['LBL_RESET_WOKSHEET']);
    $lv->ss->assign('LBL_RESET_CHECK', $mod_strings['LBL_RESET_CHECK']);

$lv->ss->assign('LBL_BEST_CASE', $mod_strings['LBL_BEST_CASE']);
    $lv->ss->assign('LBL_LIKELY_CASE', $mod_strings['LBL_LIKELY_CASE']);
    $lv->ss->assign('LBL_WORST_CASE', $mod_strings['LBL_WORST_CASE']);
    $lv->ss->assign('ERR_FORECAST_AMOUNT', $mod_strings['ERR_FORECAST_AMOUNT']);
    $lv->ss->assign('LBL_COMMIT_MESSAGE', $mod_strings['LBL_COMMIT_MESSAGE']);
    $lv->ss->assign('LBL_SHOW_CHART', $mod_strings['LBL_SHOW_CHART']);
    $lv->ss->assign('LBL_FORECAST_FOR', $mod_strings['LBL_FORECAST_FOR']);

//
    $seps = get_number_seperators();
    $lv->ss->assign('NUM_GRP_SEP', $seps[0]);
    $lv->ss->assign('DEC_SEP', $seps[1]);

$forecast_for = $sel_user->name . ' ';
    if (strtolower($forecast_type) == 'direct') {
        $forecast_for .= $mod_strings['LBL_FMT_DIRECT_FORECAST'];
    } else {
        $forecast_for .= $mod_strings['LBL_FMT_ROLLUP_FORECAST'];
    }
    $lv->ss->assign('USER_FORECAST_TYPE', $forecast_for);
    $lv->ss->assign('LBL_TP_QUOTA', $mod_strings['LBL_TP_QUOTA']);

$contents = $lv->display(false);
    echo $contents;
}

/**
 * @param Object user: object of type Forecasts/Common representing the user downline nodes will be created for.
 * @param object parent_node: object of type Node, codes created in this function will have this parent.
 * @version since 4.5
 * */
function add_downline($user, &$parent_node)
{
    $ret = [];
    $node = null;
    if (safeCount($user->my_direct_reports) > 0) {
        //add node for manager's direct forecasts. NOT if the user preference for opportunity ownership is set to false.
        if (user_owns_opps($user->current_user, null)) {
            $node = create_node($user->current_user, true, false, true);
            if (!empty($parent_node)) {
                $parent_node->add_node($node);
            }
            $ret[] = $node;
        }

foreach ($user->my_direct_reports as $id => $name) {
            $node = create_node($id);
            if (!empty($parent_node)) {
                $parent_node->add_node($node);
            }
            $ret[] = $node;
        }
    }
    return $ret;
}

/** create a new node for the tree widget
 * @param string user_id, primary key value of a valid sugar user.
 * @param string href script for the node.
 * @param boolean dynamic: allow dynamic loading of child node, defult is true
 * @param boolean force_direct:  force direct forecast for the node default false.
 * @param boolean top_level: is this the top level node, if yes add forecast type of node label, default false
 * @param boolean commit: commit of forecast is allowed from this node.
 */
function create_node($user_id, $href = true, $dynamic = true, $force_direct = false, $top_level = false, $commit = false)
{
    global $href_string;
    global $mod_strings;

$user = new Common();
    $user->set_current_user($user_id);
    $user->setup();

$rollup = true;
    $node_name = $user->my_name;
    if ($force_direct or safeCount($user->my_direct_reports) == 0) {
        $rollup = false;
    }
    if ($top_level) {
        if ($rollup) {
            $node_name .= ' ' . $mod_strings['LBL_FMT_ROLLUP_FORECAST'];
        } else {
            $node_name .= ' ' . $mod_strings['LBL_FMT_DIRECT_FORECAST'];
        }
    }
    $node = new Node($user_id, $node_name);
    if ($href) {
        $node->set_property('href', $href_string);
    }
    $node->expanded = !$dynamic;
    $node->dynamic_load = $dynamic;

//if user has downline set the forecast type property.
    if (!$rollup) {
        $node->set_property('forecasttype', 'Direct', true);
        $node->dynamic_load = false;
    } else {
        $node->set_property('forecasttype', 'Rollup', true);
    }
    $node->set_property('commit', $commit, true);
    return $node;
}

/* returns true if the passed user can own opportunities, this function should only be used for users
 * who are managers.
 */
function user_owns_opps($user_id = null, $user = null)
{
    if (empty($user)) {
        $user = BeanFactory::getBean('Users', $user_id);
    }
    $pref_no_opps = $user->getPreference('no_opps', 'global');
    if ($pref_no_opps == 'on') {
        return false;
    } else {
        return true;
    }
}

/**
 * Generate chart for current user's forecast history
 */
function get_chart_for_user($user = null, $user_id = null, $forecast_type = 'Direct')
{

if (empty($user)) {
        $user = BeanFactory::getBean('Users', $user_id);
    }
    require_once 'modules/Forecasts/Charts.php';
    $chart = new forecast_charts();
    return $chart->forecast_history($user, TimeDate::getInstance()->nowDb(), $forecast_type, 5);
}

/**
 * Display the export link
 * @param echo Bool set true if you want it echo'd, set false to have contents returned
 * @return string export link html
 */
function buildExportLink($forecast_type)
{

global $mod_strings;

$buttons = ["<a href='javascript: void(0);'>" . $mod_strings['LBL_COPY'] . '</a>'];

if ($forecast_type == 'direct') {
        $buttons[] = "<a onclick='copy_amount(\"direct\",\"amount\")' href='#'>" . $mod_strings['LBL_COPY_AMOUNT'] . '</a>';
        $buttons[] = "<a onclick='copy_amount(\"direct\",\"weigh\")' href='#'>" . $mod_strings['LBL_COPY_WEIGH_AMOUNT'] . '</a>';
        $buttons[] = "<a onclick='copy_amount(\"direct\",\"worksheet\")' href='#'>" . $mod_strings['LBL_WORKSHEET_AMOUNT'] . '</a>';
    } else {
        $buttons[] = "<a onclick='copy_amount(\"rollup\",\"amount\")' href='#'>" . $mod_strings['LBL_COPY_WEIGH_AMOUNT'] . '</a>';
        $buttons[] = "<a onclick='copy_amount(\"rollup\",\"worksheet\")' href='#'>" . $mod_strings['LBL_WORKSHEET_AMOUNT'] . '</a>';
    }

return $buttons;
}