Pages\Deprecated\PageMercenary

Complexity

Total Complexity

61

Size/Duplication

Total Lines	308
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	1
B	mercenaryDismiss()	0	17	6
B	mrc_mercenary_render()	0	60	8
B	loadParams()	0	7	5
A	modelMercenaryHire()	0	15	4
A	renderMercenaryLevelsAvail()	0	12	4
A	renderMercenaryReq()	0	11	4
A	fillDiscountTable()	0	7	2
A	mrc_officer_accessible()	0	17	3
C	mrc_mercenary_hire()	0	63	24

<?php
/**
 * Created by Gorlum 30.09.2017 8:28
 */

namespace Pages\Deprecated;

use \Exception;
use \SN;
use Unit\DBStaticUnit;
use \template;

class PageMercenary {

  /**
   * @var \classConfig $config
   */
  protected $config;
  /**
   * @var \classLocale $lang
   */
  protected $lang;

  /**
   * @var float[] $sn_powerup_buy_discounts
   */
  protected $sn_powerup_buy_discounts;

  /**
   * What we purchasing - Plans or Mercenaries?
   * @var int $mode
   */
  protected $mode = UNIT_MERCENARIES; // Or UNIT_PLANS

  /**
   * If purchased units are permanent?
   * @var bool $isUnitsPermanent
   */
  protected $isUnitsPermanent = false;

  /**
   * Multiplier for Alliance's purchases
   *
   * @var float $cost_alliance_multiplier
   */
  protected $cost_alliance_multiplier;

  public function __construct() {
    global $lang, $sn_powerup_buy_discounts;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

    lng_include('mrc_mercenary');
    lng_include('infos');

    $this->config = SN::$config;
    $this->lang = $lang;
    $this->sn_powerup_buy_discounts = $sn_powerup_buy_discounts;

    $this->loadParams();
  }

  protected function loadParams() {
    // Getting page mode
    $this->mode = sys_get_param_int('mode', UNIT_MERCENARIES);
    $this->mode = in_array($this->mode, array(UNIT_MERCENARIES, UNIT_PLANS)) ? $this->mode : UNIT_MERCENARIES;

    $this->isUnitsPermanent = $this->mode == UNIT_PLANS || !$this->config->empire_mercenary_temporary;
    $this->cost_alliance_multiplier = min(1, SN_IN_ALLY === true && $this->mode == UNIT_PLANS ? $this->config->ali_bonus_members : 1);
  }


  /**
   * @param array $user
   */
  public function mrc_mercenary_render($user) {
    $template = gettemplate('mrc_mercenary_hire');

    $operation_result = $this->modelMercenaryHire($user);
    if (!empty($operation_result)) {
      $template->assign_block_vars('result', $operation_result);
    }

    $this->fillDiscountTable($template);

    $user_dark_matter = mrc_get_level($user, [], RES_DARK_MATTER);
    foreach (sn_get_groups($this->mode == UNIT_PLANS ? 'plans' : 'mercenaries') as $mercenary_id) {
      $mercenary = get_unit_param($mercenary_id);

      $mercenary_level = mrc_get_level($user, [], $mercenary_id, false, true);
      $mercenary_level_bonus = max(0, mrc_get_level($user, [], $mercenary_id) - $mercenary_level);

      $currentUnitCostDM = 0;
      if ($this->isUnitsPermanent) {
        $currentUnitCostDM = eco_get_total_cost($mercenary_id, $mercenary_level);
        $currentUnitCostDM = $currentUnitCostDM[BUILD_CREATE][RES_DARK_MATTER] * $this->cost_alliance_multiplier;
      }
      $nextLevelCostData = eco_get_total_cost($mercenary_id, $mercenary_level + 1);
      $nextLevelCostDM = $nextLevelCostData[BUILD_CREATE][RES_DARK_MATTER] * $this->cost_alliance_multiplier;

      $mercenary_unit = DBStaticUnit::db_unit_by_location($user['id'], LOC_USER, $user['id'], $mercenary_id);
      $mercenary_time_start = strtotime($mercenary_unit['unit_time_start']);
      $mercenary_time_finish = strtotime($mercenary_unit['unit_time_finish']);
      $unitIsOutdated = $mercenary_time_finish && $mercenary_time_finish >= SN_TIME_NOW;
      $template->assign_block_vars('officer', array(
        'ID'                => $mercenary_id,
        'NAME'              => $this->lang['tech'][$mercenary_id],
        'DESCRIPTION'       => $this->lang['info'][$mercenary_id]['description'],
        'EFFECT'            => $this->lang['info'][$mercenary_id]['effect'],
        'COST'              => $nextLevelCostDM - $currentUnitCostDM,
        'COST_TEXT'         => prettyNumberStyledCompare($nextLevelCostDM - $currentUnitCostDM, $user_dark_matter),

It seems like $user_dark_matter can also be of type boolean; however, parameter $compareTo of prettyNumberStyledCompare() does only seem to accept integer|double, maybe add an additional type check?

        'LEVEL'             => $mercenary_level,
        'LEVEL_BONUS'       => $mercenary_level_bonus,
        'LEVEL_MAX'         => $mercenary['max'],
        'BONUS'             => tpl_render_unit_bonus_data($mercenary),
        'BONUS_TYPE'        => $mercenary[P_BONUS_TYPE],
        'HIRE_END'          => $unitIsOutdated ? date(FMT_DATE_TIME, $mercenary_time_finish) : '',
        'HIRE_LEFT_PERCENT' => $unitIsOutdated ? round(($mercenary_time_finish - SN_TIME_NOW) / ($mercenary_time_finish - $mercenary_time_start) * 100, 1) : 0,
        'CAN_BUY'           => $this->mrc_officer_accessible($user, $mercenary_id),
      ));

      $this->renderMercenaryLevelsAvail($user_dark_matter, $mercenary_id, $currentUnitCostDM, $template, $mercenary_level, $mercenary['max']);

It seems like $mercenary_level can also be of type boolean and double; however, parameter $mercenary_level of Pages\Deprecated\PageMercenary::renderMercenaryLevelsAvail() does only seem to accept integer, maybe add an additional type check?

It seems like $user_dark_matter can also be of type boolean; however, parameter $user_dark_matter of Pages\Deprecated\PageMercenary::renderMercenaryLevelsAvail() does only seem to accept double, maybe add an additional type check?

      $this->renderMercenaryReq($user, $mercenary, $template);
    }

    $template->assign_vars(array(
      'PAGE_HEADER'                => $this->lang['tech'][$this->mode],
      'MODE'                       => $this->mode,
      'IS_PERMANENT'               => intval($this->isUnitsPermanent),
      'EMPIRE_MERCENARY_TEMPORARY' => $this->config->empire_mercenary_temporary,
      'DARK_MATTER'                => $user_dark_matter,
    ));

    display($template, $this->lang['tech'][$this->mode]);
  }

  protected function mrc_mercenary_hire($user, $mercenary_id) {
    if (!in_array($mercenary_id, sn_get_groups($this->mode == UNIT_PLANS ? 'plans' : 'mercenaries'))) {
      throw new Exception('mrc_msg_error_wrong_mercenary', ERR_ERROR);
    }

    if (!$this->mrc_officer_accessible($user, $mercenary_id)) {
      throw new Exception('mrc_msg_error_requirements', ERR_ERROR);
    }

    $mercenary_level = sys_get_param_int('mercenary_level');
    if ($mercenary_level < 0 || $mercenary_level > get_unit_param($mercenary_id, P_MAX_STACK)) {
      throw new Exception('mrc_msg_error_wrong_level', ERR_ERROR);
    }

    $mercenary_period = sys_get_param_int('mercenary_period');
    if ($mercenary_level && !array_key_exists($mercenary_period, $this->sn_powerup_buy_discounts)) {
      throw new Exception('mrc_msg_error_wrong_period', ERR_ERROR);
    }

    sn_db_transaction_start();

    $mercenary_level_old = mrc_get_level($user, [], $mercenary_id, true, true);
    if ($this->config->empire_mercenary_temporary && $mercenary_level_old && $mercenary_level) {
      throw new Exception('mrc_msg_error_already_hired', ERR_ERROR); // Can't hire already hired temp mercenary - dismiss first
    } elseif ($this->config->empire_mercenary_temporary && !$mercenary_level_old && !$mercenary_level) {
      throw new Exception('', ERR_NONE); // Can't dismiss (!$mercenary_level) not hired (!$mercenary_level_old) temp mercenary. But no error
    }

    if ($mercenary_level) {
      $darkmater_cost = eco_get_total_cost($mercenary_id, $mercenary_level);
      if (!$this->config->empire_mercenary_temporary && $mercenary_level_old) {
        $darkmater_cost_old = eco_get_total_cost($mercenary_id, $mercenary_level_old);
        $darkmater_cost[BUILD_CREATE][RES_DARK_MATTER] -= $darkmater_cost_old[BUILD_CREATE][RES_DARK_MATTER];
      }
      $darkmater_cost = ceil($darkmater_cost[BUILD_CREATE][RES_DARK_MATTER] * $mercenary_period * $this->sn_powerup_buy_discounts[$mercenary_period] / $this->config->empire_mercenary_base_period);
    } else {
      $darkmater_cost = 0;
    }
    $darkmater_cost *= $this->cost_alliance_multiplier;

    if (mrc_get_level($user, [], RES_DARK_MATTER) < $darkmater_cost) {
      throw new Exception('mrc_msg_error_no_resource', ERR_ERROR);
    }

    $this->mercenaryDismiss($user, $mercenary_id, $darkmater_cost, $mercenary_level);

    if ($darkmater_cost && $mercenary_level) {
      DBStaticUnit::db_unit_set_insert(
        "unit_player_id = {$user['id']},
        unit_location_type = " . LOC_USER . ",
        unit_location_id = {$user['id']},
        unit_type = {$this->mode},
        unit_snid = {$mercenary_id},
        unit_level = {$mercenary_level},
        unit_time_start = " . (!$this->isUnitsPermanent ? 'FROM_UNIXTIME(' . SN_TIME_NOW . ')' : 'null') . ",
        unit_time_finish = " . (!$this->isUnitsPermanent ? 'FROM_UNIXTIME(' . (SN_TIME_NOW + $mercenary_period) . ')' : 'null')
      );

      rpg_points_change($user['id'], $this->mode == UNIT_PLANS ? RPG_PLANS : RPG_MERCENARY, -($darkmater_cost),
        sprintf($this->lang[$this->mode == UNIT_PLANS ? 'mrc_plan_bought_log' : 'mrc_mercenary_hired_log'], $this->lang['tech'][$mercenary_id], $mercenary_id, $darkmater_cost, round($mercenary_period / PERIOD_DAY)));
    }
    sn_db_transaction_commit();
    sys_redirect($_SERVER['REQUEST_URI']);
  }

  protected function mrc_officer_accessible(&$user, $mercenary_id) {
    $mercenary_info = get_unit_param($mercenary_id);

    if ($this->config->empire_mercenary_temporary || $mercenary_info[P_UNIT_TYPE] == UNIT_PLANS) {
      return true;
    }

//    if (isset($mercenary_info[P_REQUIRE])) {

55% of this comment could be valid code. Did you maybe forget this after debugging?

//      foreach ($mercenary_info[P_REQUIRE] as $unit_id => $unit_level) {
//        if (mrc_get_level($user, [], $unit_id) < $unit_level) {
//          return false;
//        }
//      }
//    }
//
//    return true;
    return eco_can_build_unit($user, [], $mercenary_id) == BUILD_ALLOWED;
  }

  /**
   * @param \template $template
   */
  protected function fillDiscountTable($template) {
    foreach ($this->sn_powerup_buy_discounts as $hire_period => $hire_discount) {
      $template->assign_block_vars('period', array(
        'LENGTH'   => $hire_period,
        'TEXT'     => $this->lang['mrc_period_list'][$hire_period],
        'DISCOUNT' => $hire_period / $this->config->empire_mercenary_base_period * $hire_discount,
        'SELECTED' => $hire_period == $this->config->empire_mercenary_base_period,
      ));
    }
  }

  /**
   * @param $user
   *
   * @return array
   */
  protected function modelMercenaryHire($user) {
    $operation_result = [];
    if ($mercenary_id = sys_get_param_int('mercenary_id')) {
      try {
        $this->mrc_mercenary_hire($user, $mercenary_id);
      } catch (Exception $e) {
        sn_db_transaction_rollback();
        $operation_result = array(
          'STATUS'  => in_array($e->getCode(), array(ERR_NONE, ERR_WARNING, ERR_ERROR)) ? $e->getCode() : ERR_ERROR,
          'MESSAGE' => $this->lang[$e->getMessage()],
        );
      }
    }

    return $operation_result;
  }

  /**
   * @param array $user
   * @param int   $mercenary_id
   * @param float $darkmater_cost
   * @param int   $mercenary_level
   */
  protected function mercenaryDismiss($user, $mercenary_id, $darkmater_cost, $mercenary_level) {
    if ((!$darkmater_cost || !$mercenary_level) && $this->isUnitsPermanent) {
      return;
    }

    $unit_row = DBStaticUnit::db_unit_by_location($user['id'], LOC_USER, $user['id'], $mercenary_id);
    if (is_array($unit_row) && ($dismiss_left_days = floor((strtotime($unit_row['unit_time_finish']) - SN_TIME_NOW) / PERIOD_DAY))) {
      $dismiss_full_cost = eco_get_total_cost($mercenary_id, $unit_row['unit_level']);
      $dismiss_full_cost = $dismiss_full_cost[BUILD_CREATE][RES_DARK_MATTER];

      $dismiss_full_days = round((strtotime($unit_row['unit_time_finish']) - strtotime($unit_row['unit_time_start'])) / PERIOD_DAY);
      rpg_points_change($user['id'], RPG_MERCENARY_DISMISSED, 0,
        sprintf($this->lang['mrc_mercenary_dismissed_log'], $this->lang['tech'][$mercenary_id], $mercenary_id, $dismiss_full_cost, $dismiss_full_days,
          $unit_row['unit_time_start'], $unit_row['unit_time_finish'], $dismiss_left_days, floor($dismiss_full_cost * $dismiss_left_days / $dismiss_full_days)
        ));
    }
    DBStaticUnit::db_unit_list_delete($user['id'], LOC_USER, $user['id'], $mercenary_id);
  }

  /**
   * @param           $user
   * @param           $mercenary
   * @param template  $template
   */
  protected function renderMercenaryReq(&$user, $mercenary, $template) {
    if (empty($mercenary[P_REQUIRE]) || !is_array($mercenary[P_REQUIRE])) {
      return;
    }

    foreach ($mercenary[P_REQUIRE] as $requireUnitId => $requireLevel) {
      $template->assign_block_vars('officer.require', $q = [
        'ID'             => $requireUnitId,
        'LEVEL_GOT'      => mrc_get_level($user, [], $requireUnitId),
        'LEVEL_REQUIRED' => $requireLevel,
        'NAME'           => \HelperString::htmlSafe($this->lang['tech'][$requireUnitId])
      ]);
    }
  }

  /**
   * @param float    $user_dark_matter
   * @param int      $mercenary_id
   * @param float    $currentCost
   * @param template $template
   * @param int      $mercenary_level
   * @param          $mercenary_max_level
   */
  protected function renderMercenaryLevelsAvail($user_dark_matter, $mercenary_id, $currentCost, $template, $mercenary_level, $mercenary_max_level) {
    $upgrade_cost = 1;
    for (
      $i = $this->config->empire_mercenary_temporary ? 1 : $mercenary_level + 1;
      $mercenary_max_level ? ($i <= $mercenary_max_level) : $upgrade_cost <= $user_dark_matter;
      $i++
    ) {
      $newCost = eco_get_total_cost($mercenary_id, $i);
      $upgrade_cost = $newCost[BUILD_CREATE][RES_DARK_MATTER] * $this->cost_alliance_multiplier - $currentCost;
      $template->assign_block_vars('officer.level', array(
        'VALUE' => $i,
        'PRICE' => $upgrade_cost,
      ));
    }
  }

}