bounce-provider-mailwizz.php

<?php
 /*
 *
 * bouncehandler.php | MailWizz / PowerMTA / Webhook bounce handler
 * Copyright (c) 2016-2017 Gerd Naschenweng / bidorbuy.co.za
 *
 * The MIT License (MIT)
 *
 * @author Gerd Naschenweng <gerd@naschenweng.info>
 * @link https://www.naschenweng.info/
 * @copyright 2016-2017 Gerd Naschenweng  https://github.com/magicdude4eva
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */

$log->lwrite('Bounce-provider: MailWizz, initialising');

// ------------------------------------------------------------------------------------------------------
// **** Initialise MailWizz
$MAILWIZZ_HANDLER_ENABLED = false;

if (defined('MAILWIZZ_API_PUBLIC_KEY') && MAILWIZZ_API_PUBLIC_KEY &&
    defined('MAILWIZZ_API_PRIVATE_KEY') && MAILWIZZ_API_PRIVATE_KEY &&
    defined('MAILWIZZ_ENDPOINT_URL') && MAILWIZZ_ENDPOINT_URL) {
  $log->lwrite('   Endpoint-URL=' . MAILWIZZ_ENDPOINT_URL);

  if (!BounceUtility::testEndpointURL(MAILWIZZ_ENDPOINT_URL)) {
    return;
  }

  require_once dirname(__FILE__) . '/MailWizzApi/Autoloader.php';

  MailWizzApi_Autoloader::register();

  // configuration object
  $config = new MailWizzApi_Config(array('apiUrl' => MAILWIZZ_ENDPOINT_URL, 'publicKey' => MAILWIZZ_API_PUBLIC_KEY, 'privateKey' => MAILWIZZ_API_PRIVATE_KEY,
    'components' => array('cache' => array('class'     => 'MailWizzApi_Cache_File',
    'filesPath' => dirname(__FILE__) . '/MailWizzApi/Cache/data/cache', // make sure it is writable by webserver
    ) ), ));

  // now inject the configuration and we are ready to make api calls
  MailWizzApi_Base::setConfig($config);

  // Configure subscriber-end point
  $MailWizzSubscriberEndPoint = new MailWizzApi_Endpoint_ListSubscribers();

  // Configure bounce-end pointer
  $MailWizzCampaignBounceEndPoint = new MailWizzApi_Endpoint_CampaignBounces();

  $log->lwrite('   MailWizz enabled!');

  $MAILWIZZ_HANDLER_ENABLED = true;
} else {
  $log->lwrite('   Skipped - not configured!');
}

$log->lwrite('Bounce-provider: MailWizz, complete');


// ========================================================================================================
// MAILWIZZ FUNCTIONS
// Handle MailWizz unsubscribe
function MailWizz_unsubscribeRecipient($recipient,$Mailwizz_bounceRecord) {
  global $log, $reportingInterface, $MailWizzSubscriberEndPoint, $MailWizzCampaignBounceEndPoint, $MAILWIZZ_HANDLER_ENABLED;

  if ($MAILWIZZ_HANDLER_ENABLED == false) {
    return array(false, "MailWizz not enabled! Check logs!");
  }

  $unsubscribeSuccess = false;  $unsubMessage = "";

  // Check if subscriber exists
  $response = $MailWizzSubscriberEndPoint->emailSearchAllLists($recipient, $pageNumber = 1, $perPage = 30);

  if ($response->body['status'] == "success" && $response->body['data']['count'] > 0) {
    // Check if we have a bounce-record so that we can get details
    // The campaignUID is within the jobId in the format "mailwizz-XXXXXX"
    $Mailwizz_CampaignUID  = null;
    $Mailwizz_bounceType   = $Mailwizz_bounceRecord[0];
    $Mailwizz_bounceReason = $Mailwizz_bounceRecord[2];

    if (!is_null($Mailwizz_bounceRecord) && !empty($Mailwizz_bounceRecord) && sizeof($Mailwizz_bounceRecord) == 3) {
      preg_match('/^mailwizz-(.*)/', $Mailwizz_bounceRecord[1], $regs);

      if (!is_null($regs) && !empty($regs) && sizeof($regs) == 2) {
        $Mailwizz_CampaignUID = $regs[1];
      }
    }

    $unsubCounter = 0;
    $log->lwrite('   MailWizz: unsubscribe for ' . $recipient . ':');
    foreach ($response->body['data']['records'] as $subscription) {
      if ($subscription['status'] != "unsubscribed") {
        $unsubscriberesponse = $MailWizzSubscriberEndPoint->unsubscribe($subscription['list']['list_uid'], $subscription['subscriber_uid']);
        $unsubMessage .= $unsubscriberesponse->body['status'] . "=" . $subscription['list']['name'] . " ";
        $log->lwrite('   - ' . $unsubscriberesponse->body['status'] . ': ' . $subscription['list']['name']);
        $unsubscribeSuccess = true;++$unsubCounter;
      } else {
        $log->lwrite('   - skipped: ' . $subscription['list']['name']);
        $unsubMessage .= "skipped=" . $subscription['list']['name'] . " ";
        $unsubscribeSuccess = true;
      }

      if (!is_null($Mailwizz_CampaignUID) && !empty($Mailwizz_CampaignUID)) {
        // Call the campaign-bounce endpoint
        $bounceresponse = $MailWizzCampaignBounceEndPoint->create($Mailwizz_CampaignUID, array(
          'message'        => $Mailwizz_bounceReason,         // max 250 chars
          'bounce_type'    => $Mailwizz_bounceType,           // hard, soft or internal
          'subscriber_uid' => $subscription['subscriber_uid'] // 13 chars unique subscriber identifier
        ));

        if ($bounceresponse->body['status'] == "success") {
          $log->lwrite('   - Bounce-update for campaign=' . $Mailwizz_CampaignUID . ', subscriberUID=' . $subscription['subscriber_uid'] .
            ', bouncetype=' . $Mailwizz_bounceType . ', bouncereason=' . $Mailwizz_bounceReason . ' successful=' . $bounceresponse->body['status']);
        } else if ($bounceresponse->body['status'] != "success") {
          $log->lwrite('   - Bounce-update for campaign=' . $Mailwizz_CampaignUID . ', subscriberUID=' . $subscription['subscriber_uid'] .
            ', bouncetype=' . $Mailwizz_bounceType . ', bouncereason=' . $Mailwizz_bounceReason . ' failed with error=' . $bounceresponse->body['error']);
        }
      }

    }

    // Log the unsubscribe count into RRD
    if ((defined('RRD_FILE') && RRD_FILE) && $unsubCounter > 0) {
      $reportingInterface->logReportRecord("bounce_mailwizz", $unsubCounter);
    }
  } else {
    if ($response->body['status'] != "success") {
      $log->lwrite('   MailWizz: Failed looking up record ' . $recipient . ' with status=' . $response->body['status']);
      $unsubscriberesponse = "Lookup failed with status=" . $response->body['status'];
    } else if ($response->body['data']['count'] == 0) {
      $log->lwrite('   MailWizz: Skipping ' . $recipient . ', already unsubscribed!');
      $unsubscriberesponse = "Already unsubscribed!";
    }
  }

  return array($unsubscribeSuccess, $unsubMessage);

}

// Unsubscribe UID from List
function MailWizz_unsubscribeSubscriberUIDFromListUID($subscriberUID, $listUID, $campaignUID) {
  global $log, $reportingInterface, $MailWizzSubscriberEndPoint, $MailWizzCampaignBounceEndPoint, $MAILWIZZ_HANDLER_ENABLED;

  if ($MAILWIZZ_HANDLER_ENABLED == false) {
    return array(false, "MailWizz not enabled! Check logs!");
  }

  $unsubscribeSuccess = false;  $unsubMessage = "";

  $unsubscriberesponse = $MailWizzSubscriberEndPoint->unsubscribe($listUID, $subscriberUID);

  if ($unsubscriberesponse->body['status'] == "success") {
    $unsubMessage = $unsubscriberesponse->body['status'] . " for listUID=" . $listUID;
    $reportingInterface->logReportRecord("bounce_mailwizz", 1);
    $log->lwrite('   - ' . $unsubMessage);
    $unsubscribeSuccess = true;

    // Call the campaign-bounce endpoint
    if (!is_null($campaignUID) && !empty($campaignUID)) {
      $bounceresponse = $MailWizzCampaignBounceEndPoint->create($campaignUID, array(
        'message'        => 'Port25 List-Unsubscribe', // max 250 chars
        'bounce_type'    => 'soft',                    // hard, soft or internal
        'subscriber_uid' => $subscriberUID             // 13 chars unique subscriber identifier
      ));

      if ($bounceresponse->body['status'] == "success") {
        $log->lwrite('   - Bounce-update for campaign=' . $campaignUID . ' and subscriberUID=' . $subscriberUID . ' successful=' . $bounceresponse->body['status']);
      } else if ($bounceresponse->body['status'] != "success") {
        $log->lwrite('   - Bounce-update for campaign=' . $campaignUID . ' and subscriberUID=' . $subscriberUID . ' failed with error=' . $bounceresponse->body['error']);
      }
    }

  } else if ($unsubscriberesponse->body['status'] != "success") {
    $log->lwrite('   - Failed with status=' . $unsubscriberesponse->body['error']);
    $unsubMessage = "Failed with status=" . $unsubscriberesponse->body['error'];
  }

  return array($unsubscribeSuccess, $unsubMessage);

}

// Lookup recipient via MailWizz X-Mw-Subscriber-Uid and List-Id
function MailWizz_getSubscriber($listID, $subscriberUID) {
  global $log, $MailWizzSubscriberEndPoint, $MAILWIZZ_HANDLER_ENABLED;

  if ($MAILWIZZ_HANDLER_ENABLED == false) {
    return array(false, null);
  }

  // Extract the list-id - sometimes we get "listid <some name>"
  $mwListId = explode(" <", $listID, 2);

  $response = $MailWizzSubscriberEndPoint->getSubscriber($mwListId[0], $subscriberUID);

  if ($response->body['status'] == "success" && array_key_exists('EMAIL', $response->body['data']['record']) &&  !is_null($response->body['data']['record']['EMAIL']) && !empty($response->body['data']['record']['EMAIL'])) {
    return array(true, $response->body['data']['record']['EMAIL']);
  } else {
    return array(false, null);
  }

  return array(false, null);
}

// Lookup recipient via MailWizz X-Mw-Subscriber-Uid and List-Id
function MailWizz_getCampaignListId($campaignUID) {
  global $log, $MailWizzSubscriberEndPoint, $MAILWIZZ_HANDLER_ENABLED;

  if ($MAILWIZZ_HANDLER_ENABLED == false) {
    return array(false, null);
  }

  $MailWizzCampaignPoint = new MailWizzApi_Endpoint_Campaigns();

  $response = $MailWizzCampaignPoint->getCampaign($campaignUID);

  if ($response->body['status'] == "success" && !is_null($response->body['data']['record']['list']) && !empty($response->body['data']['record']['list']['list_uid'])) {
    return array(true, $response->body['data']['record']['list']['list_uid'],
      $response->body['data']['record']['list']['name'],
      $response->body['data']['record']['list']['subscribers_count'],
      $response->body['data']['record']['name'],
      $response->body['data']['record']['subject'],
      $response->body['data']['record']['send_at']
      );
  } else {
    return array(false, null);
  }

  return array(false, null);
}