api/v3/MailingAB.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * APIv3 functions for registering/processing mailing ab testing events.
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_MailingAB
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * $Id$
  36  */
  37
  38 /**
  39  * Handle a create mailing ab testing.
  40  *
  41  * @param array $params
  42  *
  43  * @return array
  44  *   API Success Array
  45  */
  46 function civicrm_api3_mailing_a_b_create($params) {
  47   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  48 }
  49
  50 /**
  51  * Handle a delete event.
  52  *
  53  * @param array $params
  54  *
  55  * @return array
  56  *   API Success Array
  57  */
  58 function civicrm_api3_mailing_a_b_delete($params) {
  59   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  60 }
  61
  62 /**
  63  * Handle a get event.
  64  *
  65  * @param array $params
  66  *
  67  * @return array
  68  */
  69 function civicrm_api3_mailing_a_b_get($params) {
  70   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  71 }
  72
  73 /**
  74  * Adjust Metadata for submit action.
  75  *
  76  * The metadata is used for setting defaults, documentation & validation.
  77  *
  78  * @param array $params
  79  *   Array or parameters determined by getfields.
  80  */
  81 function _civicrm_api3_mailing_a_b_submit_spec(&$params) {
  82   $mailingFields = CRM_Mailing_DAO_Mailing::fields();
  83   $mailingAbFields = CRM_Mailing_DAO_MailingAB::fields();
  84   $spec['id'] = $mailingAbFields['id'];
  85   $spec['status'] = $mailingAbFields['status'];
  86   $spec['scheduled_date'] = $mailingFields['scheduled_date'];
  87   $spec['approval_date'] = $mailingFields['approval_date'];
  88   $spec['approval_status_id'] = $mailingFields['approval_status_id'];
  89   $spec['approval_note'] = $mailingFields['approval_note'];
  90   // Note: we'll pass through approval_* fields to the underlying mailing, but they may be ignored
  91   // if the user doesn't have suitable permission. If separate approvals are required, they must be provided
  92   // outside the A/B Test UI.
  93 }
  94
  95 /**
  96  * Send A/B mail to A/B recipients respectively.
  97  *
  98  * @param array $params
  99  *
 100  * @return array
 101  * @throws API_Exception
 102  */
 103 function civicrm_api3_mailing_a_b_submit($params) {
 104   civicrm_api3_verify_mandatory($params, 'CRM_Mailing_DAO_MailingAB', array('id', 'status'));
 105
 106   if (!isset($params['scheduled_date']) && !isset($updateParams['approval_date'])) {
 107     throw new API_Exception("Missing parameter scheduled_date and/or approval_date");
 108   }
 109
 110   $dao = new CRM_Mailing_DAO_MailingAB();
 111   $dao->id = $params['id'];
 112   if (!$dao->find(TRUE)) {
 113     throw new API_Exception("Failed to locate A/B test by ID");
 114   }
 115   if (empty($dao->mailing_id_a) || empty($dao->mailing_id_b) || empty($dao->mailing_id_c)) {
 116     throw new API_Exception("Missing mailing IDs for A/B test");
 117   }
 118
 119   $submitParams = CRM_Utils_Array::subset($params, array(
 120     'scheduled_date',
 121     'approval_date',
 122     'approval_note',
 123     'approval_status_id',
 124   ));
 125
 126   switch ($params['status']) {
 127     case 'Testing':
 128       if (!empty($dao->status) && $dao->status != 'Draft') {
 129         throw new API_Exception("Cannot transition to state 'Testing'");
 130       }
 131       civicrm_api3('Mailing', 'submit', $submitParams + array(
 132           'id' => $dao->mailing_id_a,
 133           '_skip_evil_bao_auto_recipients_' => 0,
 134         ));
 135       civicrm_api3('Mailing', 'submit', $submitParams + array(
 136           'id' => $dao->mailing_id_b,
 137           '_skip_evil_bao_auto_recipients_' => 1,
 138         ));
 139       CRM_Mailing_BAO_MailingAB::distributeRecipients($dao);
 140       break;
 141
 142     case 'Final':
 143       if ($dao->status != 'Testing') {
 144         throw new API_Exception("Cannot transition to state 'Final'");
 145       }
 146       civicrm_api3('Mailing', 'submit', $submitParams + array(
 147           'id' => $dao->mailing_id_c,
 148           '_skip_evil_bao_auto_recipients_' => 1,
 149         ));
 150       break;
 151
 152     default:
 153       throw new API_Exception("Unrecognized submission status");
 154   }
 155
 156   return civicrm_api3('MailingAB', 'create', array(
 157     'id' => $dao->id,
 158     'status' => $params['status'],
 159     'options' => array(
 160       'reload' => 1,
 161     ),
 162   ));
 163 }
 164
 165 /**
 166  * Adjust Metadata for graph_stats action.
 167  *
 168  * The metadata is used for setting defaults, documentation & validation.
 169  *
 170  * @param array $params
 171  *   Array or parameters determined by getfields.
 172  */
 173 function _civicrm_api3_mailing_a_b_graph_stats_spec(&$params) {
 174   $params['criteria']['title'] = 'Criteria';
 175   $params['criteria']['default'] = 'Open';
 176   // mailing_ab_winner_criteria
 177   $params['target_date']['title'] = 'Target Date';
 178   $params['target_date']['type'] = CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME;
 179   $params['split_count']['title'] = 'Split Count';
 180   $params['split_count']['api.default'] = 6;
 181   $params['split_count_select']['title'] = 'Split Count Select';
 182   $params['split_count_select']['api.required'] = 1;
 183   $params['target_url']['title'] = 'Target URL';
 184 }
 185
 186 /**
 187  * Send graph detail for A/B tests mail.
 188  *
 189  * @param array $params
 190  *
 191  * @return array
 192  * @throws API_Exception
 193  */
 194 function civicrm_api3_mailing_a_b_graph_stats($params) {
 195   civicrm_api3_verify_mandatory($params,
 196     'CRM_Mailing_DAO_MailingAB',
 197     array('id'),
 198     FALSE
 199   );
 200
 201   $defaults = array(
 202     'criteria' => 'Open',
 203     'target_date' => CRM_Utils_Time::getTime('YmdHis'),
 204     'split_count' => 6,
 205     'split_count_select' => 1,
 206   );
 207   $params = array_merge($defaults, $params);
 208
 209   $mailingAB = civicrm_api3('MailingAB', 'getsingle', array('id' => $params['id']));
 210   $graphStats = array();
 211   $ABFormat = array('A' => 'mailing_id_a', 'B' => 'mailing_id_b');
 212
 213   foreach ($ABFormat as $name => $column) {
 214     switch (strtolower($params['criteria'])) {
 215       case 'open':
 216         $result = CRM_Mailing_Event_BAO_Opened::getRows($mailingAB['mailing_id_a'], NULL, TRUE, 0, 1, "civicrm_mailing_event_opened.time_stamp ASC");
 217         $startDate = CRM_Utils_Date::processDate($result[0]['date']);
 218         $targetDate = CRM_Utils_Date::processDate($params['target_date']);
 219         $dateDuration = round(round(strtotime($targetDate) - strtotime($startDate)) / $params['split_count']);
 220         $toDate = strtotime($startDate) + ($dateDuration * $params['split_count_select']);
 221         $toDate = date('YmdHis', $toDate);
 222         $graphStats[$name] = array(
 223           $params['split_count_select'] => array(
 224             'count' => CRM_Mailing_Event_BAO_Opened::getTotalCount($mailingAB[$column], NULL, TRUE, $toDate),
 225             'time' => CRM_Utils_Date::customFormat($toDate),
 226           ),
 227         );
 228         break;
 229
 230       case 'total unique clicks':
 231         $result = CRM_Mailing_Event_BAO_TrackableURLOpen::getRows($mailingAB['mailing_id_a'], NULL, TRUE, 0, 1, "civicrm_mailing_event_trackable_url_open.time_stamp ASC");
 232         $startDate = CRM_Utils_Date::processDate($result[0]['date']);
 233         $targetDate = CRM_Utils_Date::processDate($params['target_date']);
 234         $dateDuration = round(abs(strtotime($targetDate) - strtotime($startDate)) / $params['split_count']);
 235         $toDate = strtotime($startDate) + ($dateDuration * $params['split_count_select']);
 236         $toDate = date('YmdHis', $toDate);
 237         $graphStats[$name] = array(
 238           $params['split_count_select'] => array(
 239             'count' => CRM_Mailing_Event_BAO_TrackableURLOpen::getTotalCount($params['mailing_id'], NULL, FALSE, NULL, $toDate),
 240             'time' => CRM_Utils_Date::customFormat($toDate),
 241           ),
 242         );
 243         break;
 244
 245       case 'total clicks on a particular link':
 246         if (empty($params['target_url'])) {
 247           throw new API_Exception("Provide url to get stats result for total clicks on a particular link");
 248         }
 249         // FIXME: doesn't make sense to get url_id mailing_id_(a|b) while getting start date in mailing_id_a
 250         $url_id = CRM_Mailing_BAO_TrackableURL::getTrackerURLId($mailingAB[$column], $params['target_url']);
 251         $result = CRM_Mailing_Event_BAO_TrackableURLOpen::getRows($mailingAB['mailing_id_a'], NULL, FALSE, $url_id, 0, 1, "civicrm_mailing_event_trackable_url_open.time_stamp ASC");
 252         $startDate = CRM_Utils_Date::processDate($result[0]['date']);
 253         $targetDate = CRM_Utils_Date::processDate($params['target_date']);
 254         $dateDuration = round(abs(strtotime($targetDate) - strtotime($startDate)) / $params['split_count']);
 255         $toDate = strtotime($startDate) + ($dateDuration * $params['split_count_select']);
 256         $toDate = CRM_Utils_Date::processDate($toDate);
 257         $graphStats[$name] = array(
 258           $params['split_count_select'] => array(
 259             'count' => CRM_Mailing_Event_BAO_TrackableURLOpen::getTotalCount($params['mailing_id'], NULL, FALSE, $url_id, $toDate),
 260             'time' => CRM_Utils_Date::customFormat($toDate),
 261           ),
 262         );
 263         break;
 264     }
 265   }
 266
 267   return civicrm_api3_create_success($graphStats);
 268 }