[civicrm-core.git] / CRM / Core / Payment / GoogleIPN.php

<?php

/**
 * Copyright (C) 2006 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * Response handler code.
 *
 * This will be invoked every time a notification or request is sent by the Google Server.
 *
 * To allow this code to receive responses, the url for this file
 * must be set on the seller page under Settings->Integration as the
 * "API Callback URL'
 * Order processing commands can be sent automatically by placing these
 * commands appropriately
 *
 * To use this code for merchant-calculated feedback, this url must be
 * set also as the merchant-calculations-url when the cart is posted
 * Depending on your calculations for shipping, taxes, coupons and gift
 * certificates update parts of the code as required.
 */

define('GOOGLE_DEBUG_PP', 0);

/**
 * Class CRM_Core_Payment_GoogleIPN.
 */
class CRM_Core_Payment_GoogleIPN extends CRM_Core_Payment_BaseIPN {

  /**
   * We only need one instance of this object. So we use the singleton
   * pattern and cache the instance in this variable
   *
   * @var object
   */
  static private $_singleton = NULL;

  /**
   * Mode of operation: live or test
   *
   * @var object
   */
  protected $_mode = NULL;

  /**
   * @param string $name
   * @param $type
   * @param $object
   * @param bool $abort
   *
   * @return mixed
   */
  public static function retrieve($name, $type, $object, $abort = TRUE) {
    $value = CRM_Utils_Array::value($name, $object);
    if ($abort && $value === NULL) {
      CRM_Core_Error::debug_log_message("Could not find an entry for $name");
      echo "Failure: Missing Parameter<p>";
      exit();
    }

    if ($value) {
      if (!CRM_Utils_Type::validate($value, $type)) {
        CRM_Core_Error::debug_log_message("Could not find a valid entry for $name");
        echo "Failure: Invalid Parameter<p>";
        exit();
      }
    }

    return $value;
  }

  /**
   * Constructor.
   *
   * @param string $mode
   *   The mode of operation: live or test.
   *
   * @param $paymentProcessor
   *
   * @return \CRM_Core_Payment_GoogleIPN
   */
  public function __construct($mode, &$paymentProcessor) {
    parent::__construct();

    $this->_mode = $mode;
    $this->_paymentProcessor = $paymentProcessor;
  }

  /**
   * The function gets called when a new order takes place.
   *
   * @param xml $dataRoot
   *   Response send by google in xml format.
   * @param array $privateData
   *   Contains the name value pair of <merchant-private-data>.
   *
   * @param string $component
   *
   * @return bool
   */
  public function newOrderNotify($dataRoot, $privateData, $component) {
    $ids = $input = $params = array();

    $input['component'] = strtolower($component);

    $ids['contact'] = self::retrieve('contactID', 'Integer', $privateData, TRUE);
    $ids['contribution'] = self::retrieve('contributionID', 'Integer', $privateData, TRUE);

    $ids['contributionRecur'] = $ids['contributionPage'] = NULL;
    if ($input['component'] == "event") {
      $ids['event'] = self::retrieve('eventID', 'Integer', $privateData, TRUE);
      $ids['participant'] = self::retrieve('participantID', 'Integer', $privateData, TRUE);
      $ids['membership'] = NULL;
    }
    else {
      $ids['membership'] = self::retrieve('membershipID', 'Integer', $privateData, FALSE);
      $ids['related_contact'] = self::retrieve('relatedContactID', 'Integer', $privateData, FALSE);
      $ids['onbehalf_dupe_alert'] = self::retrieve('onBehalfDupeAlert', 'Integer', $privateData, FALSE);
      $ids['contributionRecur'] = self::retrieve('contributionRecurID', 'Integer', $privateData, FALSE);
    }

    $paymentProcessorID = CRM_Core_DAO::getFieldValue(
      'CRM_Financial_DAO_PaymentProcessorType',
      'Google_Checkout',
      'id',
      'payment_processor_type'
    );

    if (!$this->validateData($input, $ids, $objects, TRUE, $paymentProcessorID)) {
      return FALSE;
    }

    $input['invoice'] = $privateData['invoiceID'];
    $input['newInvoice'] = $dataRoot['google-order-number']['VALUE'];

    if ($ids['contributionRecur']) {
      if ($objects['contributionRecur']->invoice_id == $dataRoot['serial-number']) {
        CRM_Core_Error::debug_log_message("The new order notification already handled: {$dataRoot['serial-number']}.");
        return FALSE;
      }
      else {
        $transaction = new CRM_Core_Transaction();

        CRM_Core_Error::debug_log_message("New order for an installment received.");
        $recur = &$objects['contributionRecur'];

        // fix dates that already exist
        $dates = array('create', 'start', 'end', 'cancel', 'modified');
        foreach ($dates as $date) {
          $name = "{$date}_date";
          if ($recur->$name) {
            $recur->$name = CRM_Utils_Date::isoToMysql($recur->$name);
          }
        }
        $recur->invoice_id = $dataRoot['serial-number'];
        $recur->processor_id = $input['newInvoice'];
        $recur->save();

        if ($objects['contribution']->contribution_status_id == 1) {
          // create a contribution and then get it processed
          $contribution = new CRM_Contribute_DAO_Contribution();
          $contribution->contact_id = $ids['contact'];
          $contribution->financial_type_id = $objects['contributionType']->id;
          $contribution->contribution_page_id = $objects['contribution']->contribution_page_id;
          $contribution->contribution_recur_id = $ids['contributionRecur'];
          $contribution->receive_date = date('YmdHis');
          $contribution->currency = $objects['contribution']->currency;
          $contribution->payment_instrument_id = $objects['contribution']->payment_instrument_id;
          $contribution->amount_level = $objects['contribution']->amount_level;
          $contribution->address_id = $objects['contribution']->address_id;
          $contribution->invoice_id = $input['invoice'];
          $contribution->total_amount = $dataRoot['order-total']['VALUE'];
          $contribution->contribution_status_id = 2;
          $contribution->campaign_id = $objects['contribution']->campaign_id;

          $objects['contribution'] = $contribution;
        }
        $transaction->commit();
      }
    }

    // make sure the invoice is valid and matches what we have in the contribution record
    $contribution = &$objects['contribution'];

    if ($contribution->invoice_id != $input['invoice']) {
      CRM_Core_Error::debug_log_message("Invoice values don't match between database and IPN request");
      return FALSE;
    }

    // lets replace invoice-id with google-order-number because thats what is common and unique
    // in subsequent calls or notifications sent by google.
    $contribution->invoice_id = $input['newInvoice'];

    $input['amount'] = $dataRoot['order-total']['VALUE'];

    if ($contribution->total_amount != $input['amount']) {
      CRM_Core_Error::debug_log_message("Amount values dont match between database and IPN request");
      return FALSE;
    }

    if (!$this->getInput($input, $ids, $dataRoot)) {
      return FALSE;
    }

    $transaction = new CRM_Core_Transaction();

    // check if contribution is already completed, if so we ignore this ipn
    if ($contribution->contribution_status_id == 1) {
      CRM_Core_Error::debug_log_message("returning since contribution has already been handled");
      return FALSE;
    }
    else {
      /* Since trxn_id hasn't got any use here,
       * lets make use of it by passing the eventID/membershipTypeID to next level.
       * And change trxn_id to google-order-number before finishing db update */

      if (!empty($ids['event'])) {
        $contribution->trxn_id = $ids['event'] . CRM_Core_DAO::VALUE_SEPARATOR . $ids['participant'];
      }
      elseif (!empty($ids['membership'])) {
        $contribution->trxn_id = $ids['membership'][0] . CRM_Core_DAO::VALUE_SEPARATOR . $ids['related_contact'] . CRM_Core_DAO::VALUE_SEPARATOR . $ids['onbehalf_dupe_alert'];
      }
    }

    $contribution->save();
    $transaction->commit();

    return TRUE;
  }

  /**
   * The function gets called when the state(CHARGED, CANCELLED..) changes for an order
   *
   * @param string $status
   *   Status of the transaction send by google.
   * @param $dataRoot
   * @param array $privateData
   *   Contains the name value pair of <merchant-private-data>.
   *
   * @param string $component
   *
   * @return bool
   */
  public function orderStateChange($status, $dataRoot, $privateData, $component) {
    $input = $objects = $ids = array();
    $input['component'] = strtolower($component);

    $ids['contributionRecur'] = self::retrieve('contributionRecurID', 'Integer', $privateData, FALSE);
    $serial = $dataRoot['serial-number'];
    $orderNo = $dataRoot['google-order-number']['VALUE'];

    $contribution = new CRM_Contribute_BAO_Contribution();
    $contribution->invoice_id = $orderNo;

    if (!$contribution->find(TRUE)) {
      CRM_Core_Error::debug_log_message("orderStateChange: Could not find contribution record with invoice id: $serial");
      return FALSE;
    }

    // Google sends the charged notification twice.
    // So to make sure, code is not executed again.
    if ($contribution->contribution_status_id == 1) {
      CRM_Core_Error::debug_log_message("Contribution already handled (ContributionID = {$contribution->id}).");
      return FALSE;
    }

    // make sure invoice is set to serial no for recurring payments, to avoid violating uniqueness
    $contribution->invoice_id = $ids['contributionRecur'] ? $serial : $orderNo;

    $objects['contribution'] = &$contribution;
    $ids['contribution'] = $contribution->id;
    $ids['contact'] = $contribution->contact_id;

    $ids['event'] = $ids['participant'] = $ids['membership'] = NULL;
    $ids['contributionPage'] = NULL;

    if ($input['component'] == "event") {
      list($ids['event'], $ids['participant']) = explode(CRM_Core_DAO::VALUE_SEPARATOR,
        $contribution->trxn_id
      );
    }
    else {
      $ids['related_contact'] = NULL;
      $ids['onbehalf_dupe_alert'] = NULL;
      if ($contribution->trxn_id) {
        list($ids['membership'], $ids['related_contact'], $ids['onbehalf_dupe_alert']) = explode(CRM_Core_DAO::VALUE_SEPARATOR,
          $contribution->trxn_id
        );
      }
      foreach (array(
                 'membership',
                 'related_contact',
                 'onbehalf_dupe_alert',
               ) as $fld) {
        if (!is_numeric($ids[$fld])) {
          unset($ids[$fld]);
        }
      }
    }

    $paymentProcessorID = CRM_Core_DAO::getFieldValue(
      'CRM_Financial_DAO_PaymentProcessorType',
      'Google_Checkout',
      'id',
      'payment_processor_type'
    );

    $this->loadObjects($input, $ids, $objects, TRUE, $paymentProcessorID);

    $transaction = new CRM_Core_Transaction();

    if ($status == 'PAYMENT_DECLINED' ||
      $status == 'CANCELLED_BY_GOOGLE' ||
      $status == 'CANCELLED'
    ) {
      return $this->failed($objects, $transaction);
    }

    $input['amount'] = $contribution->total_amount;
    $input['fee_amount'] = NULL;
    $input['net_amount'] = NULL;
    $input['trxn_id'] = $ids['contributionRecur'] ? $serial : $dataRoot['google-order-number']['VALUE'];
    $input['is_test'] = $contribution->is_test;

    $recur = NULL;
    if ($ids['contributionRecur']) {
      $recur = $objects['contributionRecur'];
    }
    $this->completeTransaction($input, $ids, $objects, $transaction, $recur);

    $this->completeRecur($input, $ids, $objects);
  }

  /**
   * @param $input
   * @param $ids
   * @param $objects
   */
  public function completeRecur($input, $ids, $objects) {
    if ($ids['contributionRecur']) {
      $recur = &$objects['contributionRecur'];
      $contributionCount = CRM_Core_DAO::singleValueQuery("
SELECT count(*)
FROM   civicrm_contribution
WHERE  contribution_recur_id = {$ids['contributionRecur']}
");
      $autoRenewMembership = FALSE;
      if ($recur->id &&
        isset($ids['membership']) &&
        $ids['membership']
      ) {
        $autoRenewMembership = TRUE;
      }
      if ($recur->installments && ($contributionCount >= $recur->installments)) {
        $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');

        $recur->create_date = CRM_Utils_Date::isoToMysql($recur->create_date);
        $recur->start_date = CRM_Utils_Date::isoToMysql($recur->start_date);
        $recur->cancel_date = CRM_Utils_Date::isoToMysql($recur->cancel_date);
        $recur->end_date = date('YmdHis');
        $recur->modified_date = date('YmdHis');
        $recur->contribution_status_id = array_search('Completed', $contributionStatus);
        $recur->trnx_id = $dataRoot['google-order-number']['VALUE'];
        $recur->save();

        //send recurring Notification email for user
        CRM_Contribute_BAO_ContributionPage::recurringNotify(
          CRM_Core_Payment::RECURRING_PAYMENT_END,
          $ids['contact'],
          $ids['contributionPage'],
          $recur,
          $autoRenewMembership
        );
      }
      elseif ($contributionCount == 1) {
        CRM_Contribute_BAO_ContributionPage::recurringNotify(
          CRM_Core_Payment::RECURRING_PAYMENT_START,
          $ids['contact'],
          $ids['contributionPage'],
          $recur,
          $autoRenewMembership
        );
      }
    }
  }

  /**
   * @deprecated
   * Payment processor singletons removed - this is an IPN so left but probably can go
   * Singleton function used to manage this object
   *
   * @param string $mode
   *   The mode of operation: live or test.
   *
   * @param $component
   * @param $paymentProcessor
   *
   * @return object
   */
  public static function &singleton($mode, $component, &$paymentProcessor) {
    if (self::$_singleton === NULL) {
      self::$_singleton = new CRM_Core_Payment_GoogleIPN($mode, $paymentProcessor);
    }
    return self::$_singleton;
  }

  /**
   * The function retrieves the amount the contribution is for, based on the order-no google sends
   *
   * @param int $orderNo
   *   <order-total> send by google.
   *
   * @return amount
   */
  public function getAmount($orderNo) {
    $contribution = new CRM_Contribute_DAO_Contribution();
    $contribution->invoice_id = $orderNo;
    if (!$contribution->find(TRUE)) {
      CRM_Core_Error::debug_log_message("getAmount: Could not find contribution record with invoice id: $orderNo");
      echo "Failure: Could not find contribution record with invoice id: $orderNo <p>";
      exit();
    }
    return $contribution->total_amount;
  }

  /**
   * The function returns the component(Event/Contribute..), given the google-order-no and merchant-private-data
   *
   * @param array $privateData
   *   Contains the name value pair of <merchant-private-data>.
   * @param int $orderNo
   *   <order-total> send by google.
   * @param string $root
   *   Root of xml-response.
   *
   * @param $response
   * @param $serial
   * @internal param \xml $xml_response response send by google in xml format
   * @return array
   *   context of this call (test, module, payment processor id)
   */
  public function getContext($privateData, $orderNo, $root, $response, $serial) {
    $contributionID = CRM_Utils_Array::value('contributionID', $privateData);
    $contribution = new CRM_Contribute_DAO_Contribution();
    if ($root == 'new-order-notification') {
      $contribution->id = $contributionID;
    }
    else {
      $contribution->invoice_id = $orderNo;
    }
    if (!$contribution->find(TRUE)) {
      CRM_Core_Error::debug_log_message("getContext: Could not find contribution record with invoice id: $orderNo");
      $response->SendAck($serial);
    }

    $module = 'Contribute';
    if (stristr($contribution->source, ts('Online Contribution'))) {
      $module = 'Contribute';
    }
    elseif (stristr($contribution->source, ts('Online Event Registration'))) {
      $module = 'Event';
    }
    $isTest = $contribution->is_test;

    $ids = $input = $objects = array();
    $objects['contribution'] = &$contribution;
    $ids['contributionRecur'] = self::retrieve('contributionRecurID', 'Integer', $privateData, FALSE);
    $input['component'] = strtolower($module);

    if (!$ids['contributionRecur'] && $contribution->contribution_status_id == 1) {
      CRM_Core_Error::debug_log_message("Contribution already handled (ContributionID = {$contribution->id}).");
      // There is no point in going further. Return ack so we don't receive the same ipn.
      $response->SendAck($serial);
    }

    if ($input['component'] == 'event') {
      if ($root == 'new-order-notification') {
        $ids['event'] = $privateData['eventID'];
      }
      else {
        list($ids['event'], $ids['participant']) = explode(CRM_Core_DAO::VALUE_SEPARATOR, $contribution->trxn_id);
      }
    }

    $paymentProcessorID = CRM_Core_DAO::getFieldValue(
      'CRM_Financial_DAO_PaymentProcessor',
      'Google_Checkout',
      'id',
      'payment_processor_type'
    );

    $this->loadObjects($input, $ids, $objects, FALSE, $paymentProcessorID);

    if (!$ids['paymentProcessor']) {
      CRM_Core_Error::debug_log_message("Payment processor could not be retrieved.");
      // There is no point in going further. Return ack so we don't receive the same ipn.
      $response->SendAck($serial);
    }

    return array($isTest, $input['component'], $ids['paymentProcessor']);
  }

  /**
   * This method is handles the response that will be invoked (from extern/googleNotify) every time
   * a notification or request is sent by the Google Server.
   *
   * @param string $xml_response
   */
  public static function main($xml_response) {
    require_once 'Google/library/googleresponse.php';
    require_once 'Google/library/googlerequest.php';
    require_once 'Google/library/googlemerchantcalculations.php';
    require_once 'Google/library/googleresult.php';
    require_once 'Google/library/xml-processing/gc_xmlparser.php';

    $config = CRM_Core_Config::singleton();

    // Retrieve the XML sent in the HTTP POST request to the ResponseHandler
    if (get_magic_quotes_gpc()) {
      $xml_response = stripslashes($xml_response);
    }

    $headers = CRM_Utils_System::getAllHeaders();

    if (GOOGLE_DEBUG_PP) {
      CRM_Core_Error::debug_var('RESPONSE', $xml_response, TRUE, TRUE, 'Google');
    }

    // Retrieve the root and data from the xml response
    $response = new GoogleResponse();
    list($root, $data) = $response->GetParsedXML($xml_response);
    // lets retrieve the private-data & order-no
    $privateData = NULL;
    if (array_key_exists('shopping-cart', $data[$root])) {
      $privateData = $data[$root]['shopping-cart']['merchant-private-data']['VALUE'];
    }
    if (empty($privateData) && array_key_exists('order-summary', $data[$root])
      && array_key_exists('shopping-cart', $data[$root]['order-summary'])
    ) {
      $privateData = $data[$root]['order-summary']['shopping-cart']['merchant-private-data']['VALUE'];
    }
    $privateData = $privateData ? self::stringToArray($privateData) : '';
    $orderNo = $data[$root]['google-order-number']['VALUE'];
    $serial = $data[$root]['serial-number'];

    // a dummy object to call get context and a parent function inside it.
    $ipn = new CRM_Core_Payment_GoogleIPN('live', $dummyProcessor);
    list($mode, $module, $paymentProcessorID) = $ipn->getContext($privateData, $orderNo, $root, $response, $serial);
    $mode = $mode ? 'test' : 'live';

    $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($paymentProcessorID, $mode);
    $merchant_id = $paymentProcessor['user_name'];
    $merchant_key = $paymentProcessor['password'];
    $response->SetMerchantAuthentication($merchant_id, $merchant_key);

    $server_type = ($mode == 'test') ? 'sandbox' : 'production';
    $request = new GoogleRequest($merchant_id, $merchant_key, $server_type);

    $ipn = self::singleton($mode, $module, $paymentProcessor);

    if (GOOGLE_DEBUG_PP) {
      CRM_Core_Error::debug_var('RESPONSE-ROOT', $response->root, TRUE, TRUE, 'Google');
    }

    //Check status and take appropriate action
    $status = $response->HttpAuthentication($headers);

    switch ($root) {
      case "request-received":
      case "error":
      case "diagnosis":
      case "checkout-redirect":
      case "merchant-calculation-callback":
        break;

      case "new-order-notification":
        $response->SendAck($serial, FALSE);
        $ipn->newOrderNotify($data[$root], $privateData, $module);
        break;

      case "order-state-change-notification":
        $response->SendAck($serial, FALSE);
        $new_financial_state = $data[$root]['new-financial-order-state']['VALUE'];
        $new_fulfillment_order = $data[$root]['new-fulfillment-order-state']['VALUE'];

        switch ($new_financial_state) {
          case 'CHARGEABLE':
            break;

          case 'CHARGED':
          case 'PAYMENT_DECLINED':
          case 'CANCELLED':
          case 'CANCELLED_BY_GOOGLE':
            $ipn->orderStateChange($new_financial_state, $data[$root], $privateData, $module);
            break;

          case 'REVIEWING':
          case 'CHARGING':
            break;

          default:
            break;
        }
        break;

      case "authorization-amount-notification":
        $response->SendAck($serial, FALSE);
        $new_financial_state = $data[$root]['order-summary']['financial-order-state']['VALUE'];
        $new_fulfillment_order = $data[$root]['order-summary']['fulfillment-order-state']['VALUE'];

        switch ($new_financial_state) {
          case 'CHARGEABLE':
            // For google-handled subscriptions chargeorder needn't be initiated,
            // assuming auto-charging is turned on.
            //$request->SendProcessOrder($data[$root]['google-order-number']['VALUE']);
            //$request->SendChargeOrder($data[$root]['google-order-number']['VALUE'],'');
            break;

          case 'CHARGED':
          case 'PAYMENT_DECLINED':
          case 'CANCELLED':
            break;

          case 'REVIEWING':
          case 'CHARGING':
          case 'CANCELLED_BY_GOOGLE':
            break;

          default:
            break;
        }
        break;

      case "charge-amount-notification":
      case "chargeback-amount-notification":
      case "refund-amount-notification":
      case "risk-information-notification":
        $response->SendAck($serial);
        break;

      default:
        break;
    }
  }

  /**
   * @param $input
   * @param $ids
   * @param $dataRoot
   *
   * @return bool
   */
  public function getInput(&$input, &$ids, $dataRoot) {
    if (!$this->getBillingID($ids)) {
      return FALSE;
    }

    $billingID = $ids['billing'];
    $lookup = array(
      "first_name" => 'contact-name',
      // "last-name" not available with google (every thing in contact-name)
      "last_name" => 'last_name',
      "street_address-{$billingID}" => 'address1',
      "city-{$billingID}" => 'city',
      "state-{$billingID}" => 'region',
      "postal_code-{$billingID}" => 'postal-code',
      "country-{$billingID}" => 'country-code',
    );

    foreach ($lookup as $name => $googleName) {
      if (array_key_exists($googleName, $dataRoot['buyer-billing-address'])) {
        $value = $dataRoot['buyer-billing-address'][$googleName]['VALUE'];
      }
      $input[$name] = $value ? $value : NULL;
    }
    return TRUE;
  }

  /**
   * Converts the comma separated name-value pairs in <merchant-private-data>
   * to an array of name-value pairs.
   *
   * @param string $str
   *
   * @return array
   */
  public static function stringToArray($str) {
    $vars = $labels = array();
    $labels = explode(',', $str);
    foreach ($labels as $label) {
      $terms = explode('=', $label);
      $vars[$terms[0]] = $terms[1];
    }
    return $vars;
  }

}