USPSRateBase.php in Ubercart 8.4

Namespace

Drupal\uc_usps\Plugin\Ubercart\ShippingQuote

File

shipping/uc_usps/src/Plugin/Ubercart/ShippingQuote/USPSRateBase.php

<?php

namespace Drupal\uc_usps\Plugin\Ubercart\ShippingQuote;

use Drupal\Core\Form\FormStateInterface;
use Drupal\field\Entity\FieldConfig;
use Drupal\uc_order\OrderInterface;
use Drupal\uc_quote\ShippingQuotePluginBase;
use Drupal\node\Entity\Node;

/**
 * Common functionality for USPS shipping quotes plugins.
 */
abstract class USPSRateBase extends ShippingQuotePluginBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'base_rate' => 0,
      'product_rate' => 0,
      'field' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $fields = [
      '' => $this
        ->t('- None -'),
    ];
    $result = \Drupal::entityQuery('field_config')
      ->condition('field_type', 'number')
      ->execute();
    foreach (FieldConfig::loadMultiple($result) as $field) {
      $fields[$field
        ->getName()] = $field
        ->label();
    }
    $form['base_rate'] = [
      '#type' => 'uc_price',
      '#title' => $this
        ->t('Base price'),
      '#description' => $this
        ->t('The starting price for shipping costs.'),
      '#default_value' => $this->configuration['base_rate'],
      '#required' => TRUE,
    ];
    $form['product_rate'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Default product shipping rate'),
      '#min' => 0,
      '#step' => 'any',
      '#description' => $this
        ->t('The percentage of the item price to add to the shipping cost for an item.'),
      '#default_value' => $this->configuration['product_rate'],
      '#field_suffix' => $this
        ->t('% (percent)'),
      '#required' => TRUE,
    ];
    $form['field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Product shipping rate override field'),
      '#description' => $this
        ->t('Overrides the default shipping rate per product for this percentage rate shipping method, when the field is attached to a product content type and has a value.'),
      '#options' => $fields,
      '#default_value' => $this->configuration['field'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this->configuration['base_rate'] = $form_state
      ->getValue('base_rate');
    $this->configuration['product_rate'] = $form_state
      ->getValue('product_rate');
    $this->configuration['field'] = $form_state
      ->getValue('field');
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this
      ->t('USPS Web Tools® rate');
  }

  /**
   * {@inheritdoc}
   */
  public function getDisplayLabel($label) {

    // USPS logo.
    $build['image'] = [
      '#theme' => 'image',
      '#uri' => drupal_get_path('module', 'uc_usps') . '/images/uc_usps_logo.jpg',
      '#alt' => $this
        ->t('U.S.P.S. logo'),
      '#attributes' => [
        'class' => [
          'usps-logo',
        ],
      ],
    ];

    // Add USPS service name, removing any 'U.S.P.S.' prefix.
    $build['label'] = [
      '#plain_text' => preg_replace('/^U\\.S\\.P\\.S\\./', '', $label),
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function getQuotes(OrderInterface $order) {
    $rate = $this->configuration['base_rate'];
    $field = $this->configuration['field'];
    foreach ($order->products as $product) {
      if (isset($product->nid->entity->{$field}->value)) {
        $product_rate = $product->nid->entity->{$field}->value * $product->qty->value;
      }
      else {
        $product_rate = $this->configuration['product_rate'] * $product->qty->value;
      }
      $rate += $product->price->value * floatval($product_rate) / 100;
    }
    return [
      $rate,
    ];
  }

  /**
   * Organizes products into packages for shipment.
   *
   * @param OrderProduct[] $products
   *   An array of product objects as they are represented in the cart or order.
   * @param Address[] $addresses
   *   Reference to an array of addresses which are the pickup locations of each
   *   package. They are determined from the shipping addresses of their
   *   component products.
   *
   * @return array
   *   Array of packaged products. Packages are separated by shipping address,
   *   weight or quantity limits imposed by the shipping method or the products.
   */
  protected function packageProducts(array $products, array $addresses) {
    $last_key = 0;
    $packages = [];
    $usps_config = \Drupal::config('uc_usps.settings');
    if ($usps_config
      ->get('all_in_one') && count($products) > 1) {

      // "All in one" packaging strategy.
      // Only need to do this if more than one product line item in order.
      $packages[$last_key] = [
        0 => $this
          ->newPackage(),
      ];
      foreach ($products as $product) {
        if ($product->nid->value) {

          // Packages are grouped by the address from which they will be
          // shipped. We will keep track of the different addresses in an array
          // and use their keys for the array of packages.
          $key = NULL;
          $address = uc_quote_get_default_shipping_address($product->nid->value);
          foreach ($addresses as $index => $value) {
            if ($address
              ->isSamePhysicalLocation($value)) {

              // This is an existing address.
              $key = $index;
              break;
            }
          }
          if (!isset($key)) {

            // This is a new address. Increment the address counter $last_key
            // instead of using [] so that it can be used in $packages and
            // $addresses.
            $addresses[++$last_key] = $address;
            $key = $last_key;
            $packages[$key] = [
              0 => $this
                ->newPackage(),
            ];
          }
        }

        // Grab some product properties directly from the (cached) product
        // data. They are not normally available here because the $product
        // object is being read out of the $order object rather than from
        // the database, and the $order object only carries around a limited
        // number of product properties.
        $temp = Node::load($product->nid->value);
        $product->length = $temp->length->value;
        $product->width = $temp->width->value;
        $product->height = $temp->height->value;
        $product->length_units = $temp->length_units;
        $product->usps['container'] = isset($temp->usps['container']) ? $temp->usps['container'] : 'VARIABLE';
        $packages[$key][0]->price += $product->price * $product->qty;
        $packages[$key][0]->weight += $product->weight * $product->qty * uc_weight_conversion($product->weight_units, 'lb');
      }
      foreach ($packages as $key => $package) {
        $packages[$key][0]->pounds = floor($package[0]->weight);
        $packages[$key][0]->ounces = LB_TO_OZ * ($package[0]->weight - $packages[$key][0]->pounds);
        $packages[$key][0]->container = 'VARIABLE';
        $packages[$key][0]->size = 'REGULAR';

        // Packages are "machinable" if heavier than 6oz. and less than 35lbs.
        $packages[$key][0]->machinable = ($packages[$key][0]->pounds == 0 ? $packages[$key][0]->ounces >= 6 : TRUE) && $packages[$key][0]->pounds <= 35 && ($packages[$key][0]->pounds == 35 ? $packages[$key][0]->ounces == 0 : TRUE);
        $packages[$key][0]->qty = 1;
      }
    }
    else {

      // !$usps_config->get('all_in_one') || count($products) = 1
      // "Each in own" packaging strategy, or only one product line item in order.
      foreach ($products as $product) {
        if ($product->nid) {
          $address = uc_quote_get_default_shipping_address($product->nid);
          if (in_array($address, $addresses)) {

            // This is an existing address.
            foreach ($addresses as $index => $value) {
              if ($address == $value) {
                $key = $index;
                break;
              }
            }
          }
          else {

            // This is a new address.
            $addresses[++$last_key] = $address;
            $key = $last_key;
          }
        }
        if (!isset($product->pkg_qty) || !$product->pkg_qty) {
          $product->pkg_qty = 1;
        }
        $num_of_pkgs = (int) ($product->qty / $product->pkg_qty);
        if ($num_of_pkgs) {
          $package = clone $product;
          $package->description = $product->model;
          $weight = $product->weight * $product->pkg_qty;
          switch ($product->weight_units) {
            case 'g':

              // Convert to kg and fall through.
              $weight = $weight * G_TO_KG;
            case 'kg':

              // Convert to lb and fall through.
              $weight = $weight * KG_TO_LB;
            case 'lb':
              $package->pounds = floor($weight);
              $package->ounces = LB_TO_OZ * ($weight - $package->pounds);
              break;
            case 'oz':
              $package->pounds = floor($weight * OZ_TO_LB);
              $package->ounces = $weight - $package->pounds * LB_TO_OZ;
              break;
          }

          // Grab some product properties directly from the (cached) product
          // data. They are not normally available here because the $product
          // object is being read out of the $order object rather than from
          // the database, and the $order object only carries around a limited
          // number of product properties.
          $temp = Node::load($product->nid);
          $product->length = $temp->length;
          $product->width = $temp->width;
          $product->height = $temp->height;
          $product->length_units = $temp->length_units;
          $product->usps['container'] = isset($temp->usps['container']) ? $temp->usps['container'] : 'VARIABLE';
          $package->container = $product->usps['container'];
          $length_conversion = uc_length_conversion($product->length_units, 'in');
          $package->length = max($product->length, $product->width) * $length_conversion;
          $package->width = min($product->length, $product->width) * $length_conversion;
          $package->height = $product->height * $length_conversion;
          if ($package->length < $package->height) {
            list($package->length, $package->height) = [
              $package->height,
              $package->length,
            ];
          }
          $package->girth = 2 * $package->width + 2 * $package->height;
          $package->size = $package->length <= 12 ? 'REGULAR' : 'LARGE';
          $package->machinable = $package->length >= 6 && $package->length <= 34 && $package->width >= 0.25 && $package->width <= 17 && $package->height >= 3.5 && $package->height <= 17 && ($package->pounds == 0 ? $package->ounces >= 6 : TRUE) && $package->pounds <= 35 && ($package->pounds == 35 ? $package->ounces == 0 : TRUE);
          $package->price = $product->price * $product->pkg_qty;
          $package->qty = $num_of_pkgs;
          $packages[$key][] = $package;
        }
        $remaining_qty = $product->qty % $product->pkg_qty;
        if ($remaining_qty) {
          $package = clone $product;
          $package->description = $product->model;
          $weight = $product->weight * $remaining_qty;
          switch ($product->weight_units) {
            case 'g':

              // Convert to kg and fall through.
              $weight = $weight * G_TO_KG;
            case 'kg':

              // Convert to lb and fall through.
              $weight = $weight * KG_TO_LB;
            case 'lb':
              $package->pounds = floor($weight);
              $package->ounces = LB_TO_OZ * ($weight - $package->pounds);
              break;
            case 'oz':
              $package->pounds = floor($weight * OZ_TO_LB);
              $package->ounces = $weight - $package->pounds * LB_TO_OZ;
              break;
          }
          $package->container = $product->usps['container'];
          $length_conversion = uc_length_conversion($product->length_units, 'in');
          $package->length = max($product->length, $product->width) * $length_conversion;
          $package->width = min($product->length, $product->width) * $length_conversion;
          $package->height = $product->height * $length_conversion;
          if ($package->length < $package->height) {
            list($package->length, $package->height) = [
              $package->height,
              $package->length,
            ];
          }
          $package->girth = 2 * $package->width + 2 * $package->height;
          $package->size = $package->length <= 12 ? 'REGULAR' : 'LARGE';
          $package->machinable = $package->length >= 6 && $package->length <= 34 && $package->width >= 0.25 && $package->width <= 17 && $package->height >= 3.5 && $package->height <= 17 && ($package->pounds == 0 ? $package->ounces >= 6 : TRUE) && $package->pounds <= 35 && ($package->pounds == 35 ? $package->ounces == 0 : TRUE);
          $package->price = $product->price * $remaining_qty;
          $package->qty = 1;
          $packages[$key][] = $package;
        }
      }
    }
    return $packages;
  }

  /**
   * Pseudo-constructor to set default values of a package.
   */
  protected function newPackage() {
    $package = new \stdClass();
    $package->price = 0;
    $package->qty = 1;
    $package->pounds = 0;
    $package->ounces = 0;
    $package->container = 0;
    $package->size = 0;
    $package->machinable = TRUE;
    $package->length = 0;
    $package->width = 0;
    $package->height = 0;
    $package->girth = 0;

    //  $package->length_units = 'in';
    //  $package->weight_units = 'lb';
    return $package;
  }

  /**
   * Modifies the rate received from USPS before displaying to the customer.
   *
   * @param $rate
   *   Shipping rate without any rate markup.
   *
   * @return
   *   Shipping rate after markup.
   */
  protected function rateMarkup($rate) {
    $usps_config = \Drupal::config('uc_usps.settings');
    $markup = trim($usps_config
      ->get('rate_markup'));
    $type = $usps_config
      ->get('rate_markup_type');
    if (is_numeric($markup)) {
      switch ($type) {
        case 'percentage':
          return $rate + $rate * floatval($markup) / 100;
        case 'multiplier':
          return $rate * floatval($markup);
        case 'currency':
          return $rate + floatval($markup);
      }
    }
    else {
      return $rate;
    }
  }

  /**
   * Modifies the weight of shipment before sending to USPS for a quote.
   *
   * @param $weight
   *   Shipping weight without any weight markup.
   *
   * @return
   *   Shipping weight after markup.
   */
  protected function weightMarkup($weight) {
    $usps_config = \Drupal::config('uc_usps.settings');
    $markup = trim($usps_config
      ->get('weight_markup'));
    $type = $usps_config
      ->get('weight_markup_type');
    if (is_numeric($markup)) {
      switch ($type) {
        case 'percentage':
          return $weight + $weight * floatval($markup) / 100;
        case 'multiplier':
          return $weight * floatval($markup);
        case 'mass':
          return $weight + floatval($markup);
      }
    }
    else {
      return $weight;
    }
  }

  /**
   * Callback for retrieving USPS shipping quote.
   *
   * @param $products
   *   Array of cart contents.
   * @param $details
   *   Order details other than product information.
   * @param $method
   *   The shipping method to create the quote.
   *
   * @return
   *   JSON object containing rate, error, and debugging information.
   */
  public function quote($products, $details, $method) {

    // Use public function getQuotes(OrderInterface $order) in D8 plugin.
    $usps_config = \Drupal::config('uc_usps.settings');
    $quote_config = \Drupal::config('uc_quote.settings');

    // The uc_quote AJAX query can fire before the customer has completely
    // filled out the destination address, so check to see whether the address
    // has all needed fields. If not, abort.
    $destination = (object) $details;

    // Country code is always needed.
    if (empty($destination->country)) {

      // Skip this shipping method.
      return [];
    }

    // Shipments to the US also need zone and postal_code.
    if ($destination->country == 'US' && (empty($destination->zone) || empty($destination->postal_code))) {

      // Skip this shipping method.
      return [];
    }

    // USPS Production server.
    $connection_url = 'http://production.shippingapis.com/ShippingAPI.dll';

    // Initialize $debug_data to prevent PHP notices here and in uc_quote.
    $debug_data = [
      'debug' => NULL,
      'error' => [],
    ];
    $services = [];
    $addresses = [
      $quote_config
        ->get('store_default_address'),
    ];
    $packages = $this
      ->packageProducts($products, $addresses);
    if (!count($packages)) {
      return [];
    }
    foreach ($packages as $key => $ship_packages) {
      $orig = $addresses[$key];
      $orig->email = uc_store_email();
      if (strpos($method['id'], 'intl') && $destination->country != 'US') {

        // Build XML for international rate request.
        $request = $this
          ->intlRateRequest($ship_packages, $orig, $destination);
      }
      elseif ($destination->country == 'US') {

        // Build XML for domestic rate request.
        $request = $this
          ->rateRequest($ship_packages, $orig, $destination);
      }
      $account = \Drupal::currentUser();
      if ($account
        ->hasPermission('configure quotes') && $quote_config
        ->get('display_debug')) {
        $debug_data['debug'] .= htmlentities(urldecode($request)) . "<br />\n";
      }

      // Send request
      $result = \Drupal::httpClient()
        ->post($connection_url, NULL, $request)
        ->send();
      if ($account
        ->hasPermission('configure quotes') && $quote_config
        ->get('display_debug')) {
        $debug_data['debug'] .= htmlentities($result
          ->getBody(TRUE)) . "<br />\n";
      }
      $rate_type = $usps_config
        ->get('online_rates');
      $response = new \SimpleXMLElement($result
        ->getBody(TRUE));

      // Map double-encoded HTML markup in service names to Unicode characters.
      $service_markup = [
        '&lt;sup&gt;&amp;reg;&lt;/sup&gt;' => '®',
        '&lt;sup&gt;&amp;trade;&lt;/sup&gt;' => '™',
        '&lt;sup&gt;&#174;&lt;/sup&gt;' => '®',
        '&lt;sup&gt;&#8482;&lt;/sup&gt;' => '™',
        '**' => '',
      ];

      // Use this map to fix USPS service names.
      if (strpos($method['id'], 'intl')) {

        // Find and replace markup in International service names.
        foreach ($response
          ->xpath('//Service') as $service) {
          $service->SvcDescription = str_replace(array_keys($service_markup), $service_markup, $service->SvcDescription);
        }
      }
      else {

        // Find and replace markup in Domestic service names.
        foreach ($response
          ->xpath('//Postage') as $postage) {
          $postage->MailService = str_replace(array_keys($service_markup), $service_markup, $postage->MailService);
        }
      }
      if (isset($response->Package)) {
        foreach ($response->Package as $package) {
          if (isset($package->Error)) {
            $debug_data['error'][] = (string) $package->Error[0]->Description . '<br />';
          }
          else {
            if (strpos($method['id'], 'intl')) {
              foreach ($package->Service as $service) {
                $id = (string) $service['ID'];
                $services[$id]['label'] = t('U.S.P.S. @service', [
                  '@service' => (string) $service->SvcDescription,
                ]);

                // Markup rate before customer sees it.
                if (!isset($services[$id]['rate'])) {
                  $services[$id]['rate'] = 0;
                }
                $services[$id]['rate'] += $this
                  ->rateMarkup((string) $service->Postage);
              }
            }
            else {
              foreach ($package->Postage as $postage) {
                $classid = (string) $postage['CLASSID'];
                if ($classid === '0') {
                  if ((string) $postage->MailService == "First-Class Mail® Parcel") {
                    $classid = 'zeroParcel';
                  }
                  elseif ((string) $postage->MailService == "First-Class Mail® Letter") {
                    $classid = 'zeroFlat';
                  }
                  else {
                    $classid = 'zero';
                  }
                }
                if (!isset($services[$classid]['rate'])) {
                  $services[$classid]['rate'] = 0;
                }
                $services[$classid]['label'] = t('U.S.P.S. @service', [
                  '@service' => (string) $postage->MailService,
                ]);

                // Markup rate before customer sees it.
                // Rates are stored differently if ONLINE $rate_type requested.
                // First Class doesn't have online rates, so if CommercialRate
                // is missing use Rate instead.
                if ($rate_type && !empty($postage->CommercialRate)) {
                  $services[$classid]['rate'] += $this
                    ->rateMarkup((string) $postage->CommercialRate);
                }
                else {
                  $services[$classid]['rate'] += $this
                    ->rateMarkup((string) $postage->Rate);
                }
              }
            }
          }
        }
      }
    }

    // Strip leading 'usps_'
    $method_services = substr($method['id'] . '_services', 5);

    //$method_services is the name of the callback function

    //  array_keys($method['quote']['accessorials'])
    $usps_services = array_filter($usps_config
      ->get($method_services));
    foreach ($services as $service => $quote) {
      if (!in_array($service, $usps_services)) {
        unset($services[$service]);
      }
    }
    foreach ($services as $key => $quote) {
      if (isset($quote['rate'])) {
        $services[$key]['rate'] = $quote['rate'];
        $services[$key]['option_label'] = $this
          ->getDisplayLabel($quote['label']);

        // @todo add $packages info, like in the old theme_option_label() function.
      }
    }
    uasort($services, 'uc_quote_price_sort');

    // Merge debug data into $services. This is necessary because
    // $debug_data is not sortable by a 'rate' key, so it has to be
    // kept separate from the $services data until this point.
    if (isset($debug_data['debug']) || isset($debug_data['error']) && count($debug_data['error'])) {
      $services['data'] = $debug_data;
    }
    return $services;
  }

}

Classes

Name	Description
USPSRateBase	Common functionality for USPS shipping quotes plugins.