관리-도구

편집 파일: shipping.php

<?php
/**
 * shipping class
 *
 * @copyright Copyright 2003-2023 Zen Cart Development Team
 * @copyright Portions Copyright 2003 osCommerce
 * @license http://www.zen-cart.com/license/2_0.txt GNU Public License V2.0
 * @version $Id: Scott C Wilson 2022 Oct 16 Modified in v1.5.8a $
 */
if (!defined('IS_ADMIN_FLAG')) {
    die('Illegal Access');
}
/**
 * shipping class
 * Class used for interfacing with shipping modules
 *
 */
class shipping extends base
{
    /**
     * $enabled allows notifier to turn off shipping method
     * @var boolean
     */
    public $enabled;
    /**
     * $modules is an array of installed shipping module names can be altered by notifier
     * @var array
     */
    public $modules;
    /**
     * $abort_legacy_calculations allows a notifier to enable the calculate_boxes_weight_and_tare method
     * @var boolean
     */
    public $abort_legacy_calculations;

public function __construct($module = null)
    {
        global $PHP_SELF, $messageStack, $languageLoader;

if (defined('MODULE_SHIPPING_INSTALLED') && !empty(MODULE_SHIPPING_INSTALLED)) {
            $this->modules = explode(';', MODULE_SHIPPING_INSTALLED);
        }
        $this->notify('NOTIFY_SHIPPING_CLASS_GET_INSTALLED_MODULES', $module);

if (empty($this->modules)) {
            return;
        }

$include_modules = [];

if (!empty($module) && (in_array(substr($module['id'], 0, strpos($module['id'], '_')) . '.' . substr($PHP_SELF, (strrpos($PHP_SELF, '.')+1)), $this->modules))) {
            $include_modules[] = [
            'class' => substr($module['id'], 0, strpos($module['id'], '_')),
            'file' => substr($module['id'], 0, strpos($module['id'], '_')) . '.' . substr($PHP_SELF, (strrpos($PHP_SELF, '.')+1))
            ];
        } else {
            foreach($this->modules as $value) {
                $class = substr($value, 0, strrpos($value, '.'));
                $include_modules[] = [
                    'class' => $class,
                    'file' => $value
                ];
            }
        }

for ($i = 0, $n = count($include_modules); $i < $n; $i++) {
            $lang_file = null;
            $module_file = DIR_WS_MODULES . 'shipping/' . $include_modules[$i]['file'];
            if (IS_ADMIN_FLAG === true) {
                $lang_file = zen_get_file_directory(DIR_FS_CATALOG . DIR_WS_LANGUAGES . $_SESSION['language'] . '/modules/shipping/', $include_modules[$i]['file'], 'false');
                $module_file = DIR_FS_CATALOG . $module_file;
            } else {
                $lang_file = zen_get_file_directory(DIR_WS_LANGUAGES . $_SESSION['language'] . '/modules/shipping/', $include_modules[$i]['file'], 'false');
            }
            if ($languageLoader->hasLanguageFile(DIR_FS_CATALOG . DIR_WS_LANGUAGES,  $_SESSION['language'], $include_modules[$i]['file'], '/modules/shipping')) {
                $languageLoader->loadExtraLanguageFiles(DIR_FS_CATALOG . DIR_WS_LANGUAGES,  $_SESSION['language'], $include_modules[$i]['file'], '/modules/shipping');
            } else {
                if (is_object($messageStack)) {
                    if (IS_ADMIN_FLAG === false) {
                        $messageStack->add('checkout_shipping', WARNING_COULD_NOT_LOCATE_LANG_FILE . $lang_file, 'caution');
                    } else {
                        $messageStack->add_session(WARNING_COULD_NOT_LOCATE_LANG_FILE . $lang_file, 'caution');
                    }
                }
                continue;
            }
            $this->enabled = true;
            $this->notify('NOTIFY_SHIPPING_MODULE_ENABLE', $include_modules[$i]['class'], $include_modules[$i]['class']);
            if ($this->enabled) {
                include_once $module_file;
                $GLOBALS[$include_modules[$i]['class']] = new $include_modules[$i]['class'];

$enabled = $this->check_enabled($GLOBALS[$include_modules[$i]['class']]);
                if ($enabled == false ) {
                    unset($GLOBALS[$include_modules[$i]['class']]);
                }
            }
        }
    }

public function check_enabled($class)
    {
        $enabled = $class->enabled;
        if (method_exists($class, 'check_enabled_for_zone') && $class->enabled) {
            $enabled = $class->check_enabled_for_zone();
        }
        $this->notify('NOTIFY_SHIPPING_CHECK_ENABLED_FOR_ZONE', [], $class, $enabled);
        if (method_exists($class, 'check_enabled') && $enabled) {
            $enabled = $class->check_enabled();
        }
        $this->notify('NOTIFY_SHIPPING_CHECK_ENABLED', [], $class, $enabled);
        return $enabled;
    }

public function calculate_boxes_weight_and_tare()
    {
        global $total_weight, $shipping_weight, $shipping_quoted, $shipping_num_boxes;

$this->abort_legacy_calculations = false;
        $this->notify('NOTIFY_SHIPPING_MODULE_PRE_CALCULATE_BOXES_AND_TARE', [], $total_weight, $shipping_weight, $shipping_quoted, $shipping_num_boxes);
        if ($this->abort_legacy_calculations) {
            return;
        }

if (is_array($this->modules)) {
            $shipping_quoted = '';
            $shipping_num_boxes = 1;
            $shipping_weight = $total_weight;

$za_tare_array = preg_split("/[:,]/" , str_replace(' ', '', !empty(SHIPPING_BOX_WEIGHT) ? SHIPPING_BOX_WEIGHT : '0:0'));
            $zc_tare_percent= (float)$za_tare_array[0];
            $zc_tare_weight= (float)$za_tare_array[1];

$za_large_array = preg_split("/[:,]/" , str_replace(' ', '', !empty(SHIPPING_BOX_PADDING) ? SHIPPING_BOX_PADDING : '0:0'));
            $zc_large_percent= (float)$za_large_array[0];
            $zc_large_weight= (float)$za_large_array[1];

// SHIPPING_BOX_WEIGHT = tare
            // SHIPPING_BOX_PADDING = Large Box % increase
            // SHIPPING_MAX_WEIGHT = Largest package

switch (true) {
                // large box add padding
                case (SHIPPING_MAX_WEIGHT <= $shipping_weight):
                    $shipping_weight = $shipping_weight + ($shipping_weight*($zc_large_percent/100)) + $zc_large_weight;
                    break;

default:
                    // add tare weight < large
                    $shipping_weight = $shipping_weight + ($shipping_weight*($zc_tare_percent/100)) + $zc_tare_weight;
                    break;
            }

// total weight with Tare
            $_SESSION['shipping_weight'] = $shipping_weight;
            if ($shipping_weight > SHIPPING_MAX_WEIGHT) { // Split into many boxes
//        $shipping_num_boxes = ceil($shipping_weight/SHIPPING_MAX_WEIGHT);
                $zc_boxes = zen_round(($shipping_weight/SHIPPING_MAX_WEIGHT), 2);
                $shipping_num_boxes = ceil($zc_boxes);
                $shipping_weight = $shipping_weight/$shipping_num_boxes;
            }
        }
        $this->notify('NOTIFY_SHIPPING_MODULE_CALCULATE_BOXES_AND_TARE', [], $total_weight, $shipping_weight, $shipping_quoted, $shipping_num_boxes);
    }

public function quote($method = '', $module = '', $calc_boxes_weight_tare = true, $insurance_exclusions = [])
    {
        global $shipping_weight, $uninsurable_value;
        $quotes_array = [];

if ($calc_boxes_weight_tare) {
            $this->calculate_boxes_weight_and_tare();
        }

// calculate amount not to be insured on shipping
        $uninsurable_value = (method_exists($this, 'get_uninsurable_value')) ? $this->get_uninsurable_value($insurance_exclusions) : 0;

if (is_array($this->modules)) {
            $include_quotes = [];

foreach($this->modules as $value) {
                $class = substr($value, 0, strrpos($value, '.'));
                if (!empty($module)) {
                    if ($module == $class && isset($GLOBALS[$class]) && $GLOBALS[$class]->enabled) {
                        $include_quotes[] = $class;
                    }
                } elseif (isset($GLOBALS[$class]) && $GLOBALS[$class]->enabled) {
                    $include_quotes[] = $class;
                }
            }

$size = count($include_quotes);
            for ($i = 0; $i < $size; $i++) {
                if (method_exists($GLOBALS[$include_quotes[$i]], 'update_status')) {
                    $GLOBALS[$include_quotes[$i]]->update_status();
                }
                if (false === $GLOBALS[$include_quotes[$i]]->enabled) {
                    continue;
                }
                $save_shipping_weight = $shipping_weight;
                $quotes = $GLOBALS[$include_quotes[$i]]->quote($method);
                if (!isset($quotes['tax']) && !empty($quotes)) {
                    $quotes['tax'] = 0;
                }
                $shipping_weight = $save_shipping_weight;
                if (is_array($quotes)) {
                    $quotes_array[] = $quotes;
                }
            }
        }
        $this->notify('NOTIFY_SHIPPING_MODULE_GET_ALL_QUOTES', $quotes_array, $quotes_array);
        return $quotes_array;
    }

public function cheapest()
    {
        if (!is_array($this->modules)) {
            return false;
        }
        $rates = [];

foreach($this->modules as $value) {
            $class = substr($value, 0, strrpos($value, '.'));
            if (isset($GLOBALS[$class]) && is_object($GLOBALS[$class]) && $GLOBALS[$class]->enabled) {
                $quotes = isset($GLOBALS[$class]->quotes) ? $GLOBALS[$class]->quotes : null;
                if (empty($quotes['methods']) || isset($quotes['error'])) {
                    continue;
                }
                $size = count($quotes['methods']);
                for ($i = 0; $i < $size; $i++) {
                    if (isset($quotes['methods'][$i]['cost'])) {
                        $rates[] = [
                            'id' => $quotes['id'] . '_' . $quotes['methods'][$i]['id'],
                            'title' => $quotes['module'] . ' (' . $quotes['methods'][$i]['title'] . ')',
                            'cost' => $quotes['methods'][$i]['cost'],
                            'module' => $quotes['id']
                        ];
                    }
                }
            }
        }

$cheapest = false;
        $size = count($rates);
        for ($i = 0; $i < $size; $i++) {
            if ($cheapest !== false) {
                // never quote storepickup as lowest - needs to be configured in shipping module
                if ($rates[$i]['cost'] < $cheapest['cost'] && $rates[$i]['module'] !== 'storepickup') {
                    // -----
                    // Give a customized shipping module the opportunity to exclude itself from being quoted
                    // as the cheapest.  The observer must set the $exclude_from_cheapest to specifically
                    // (bool)true to be excluded.
                    //
                    $exclude_from_cheapest = false;
                    $this->notify('NOTIFY_SHIPPING_EXCLUDE_FROM_CHEAPEST', $rates[$i]['module'], $exclude_from_cheapest);
                    if ($exclude_from_cheapest === true) {
                        continue;
                    }
                    $cheapest = $rates[$i];
                }
            } elseif ($size === 1 || $rates[$i]['module'] !== 'storepickup') {
                $cheapest = $rates[$i];
            }
        }
        $this->notify('NOTIFY_SHIPPING_MODULE_CALCULATE_CHEAPEST', $cheapest, $cheapest, $rates);
        return $cheapest;
    }
}