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  * @return array
  67  */
  68 function civicrm_api3_mailing_a_b_get($params) {
  69   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  70 }
  71
  72 /**
  73  * Adjust Metadata for submit action
  74  *
  75  * The metadata is used for setting defaults, documentation & validation.
  76  *
  77  * @param array $params
  78  *   Array or parameters determined by getfields.
  79  */
  80 function _civicrm_api3_mailing_a_b_submit_spec(&$params) {
  81   $mailingFields = CRM_Mailing_DAO_Mailing::fields();
  82   $mailingAbFields = CRM_Mailing_DAO_MailingAB::fields();
  83   $spec['id'] = $mailingAbFields['id'];
  84   $spec['status'] = $mailingAbFields['status'];
  85   $spec['scheduled_date'] = $mailingFields['scheduled_date'];
  86   $spec['approval_date'] = $mailingFields['approval_date'];
  87   $spec['approval_status_id'] = $mailingFields['approval_status_id'];
  88   $spec['approval_note'] = $mailingFields['approval_note'];
  89   // Note: we'll pass through approval_* fields to the underlying mailing, but they may be ignored
  90   // if the user doesn't have suitable permission. If separate approvals are required, they must be provided
  91   // outside the A/B Test UI.
  92 }
  93
  94 /**
  95  * Send A/B mail to A/B recipients respectively
  96  *
  97  * @param array $params
  98  * @return array
  99  * @throws API_Exception
 100  */
 101 function civicrm_api3_mailing_a_b_submit($params) {
 102   civicrm_api3_verify_mandatory($params, 'CRM_Mailing_DAO_MailingAB', array('id', 'status'));
 103
 104   if (!isset($params['scheduled_date']) && !isset($updateParams['approval_date'])) {
 105     throw new API_Exception("Missing parameter scheduled_date and/or approval_date");
 106   }
 107
 108   $dao = new CRM_Mailing_DAO_MailingAB();
 109   $dao->id = $params['id'];
 110   if (!$dao->find(TRUE)) {
 111     throw new API_Exception("Failed to locate A/B test by ID");
 112   }
 113   if (empty($dao->mailing_id_a) || empty($dao->mailing_id_b) || empty($dao->mailing_id_c)) {
 114     throw new API_Exception("Missing mailing IDs for A/B test");
 115   }
 116
 117   $submitParams = CRM_Utils_Array::subset($params, array(
 118     'scheduled_date',
 119     'approval_date',
 120     'approval_note',
 121     'approval_status_id',
 122   ));
 123
 124   switch ($params['status']) {
 125     case 'Testing':
 126       if (!empty($dao->status) && $dao->status != 'Draft') {
 127         throw new API_Exception("Cannot transition to state 'Testing'");
 128       }
 129       civicrm_api3('Mailing', 'submit', $submitParams + array(
 130           'id' => $dao->mailing_id_a,
 131           '_skip_evil_bao_auto_recipients_' => 0,
 132         ));
 133       civicrm_api3('Mailing', 'submit', $submitParams + array(
 134           'id' => $dao->mailing_id_b,
 135           '_skip_evil_bao_auto_recipients_' => 1,
 136         ));
 137       CRM_Mailing_BAO_MailingAB::distributeRecipients($dao);
 138       break;
 139
 140     case 'Final':
 141       if ($dao->status != 'Testing') {
 142         throw new API_Exception("Cannot transition to state 'Final'");
 143       }
 144       civicrm_api3('Mailing', 'submit', $submitParams + array(
 145           'id' => $dao->mailing_id_c,
 146           '_skip_evil_bao_auto_recipients_' => 1,
 147         ));
 148       break;
 149
 150     default:
 151       throw new API_Exception("Unrecognized submission status");
 152   }
 153
 154   return civicrm_api3('MailingAB', 'create', array(
 155     'id' => $dao->id,
 156     'status' => $params['status'],
 157     'options' => array(
 158       'reload' => 1,
 159     ),
 160   ));
 161 }
 162
 163 /**
 164  * Adjust Metadata for graph_stats action
 165  *
 166  * The metadata is used for setting defaults, documentation & validation.
 167  *
 168  * @param array $params
 169  *   Array or parameters determined by getfields.
 170  */
 171 function _civicrm_api3_mailing_a_b_graph_stats_spec(&$params) {
 172   $params['criteria']['title'] = 'Criteria';
 173   $params['criteria']['default'] = 'Open';
 174   // mailing_ab_winner_criteria
 175   $params['target_date']['title'] = 'Target Date';
 176   $params['target_date']['type'] = CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME;
 177   $params['split_count']['title'] = 'Split Count';
 178   $params['split_count']['api.default'] = 6;
 179   $params['split_count_select']['title'] = 'Split Count Select';
 180   $params['split_count_select']['api.required'] = 1;
 181   $params['target_url']['title'] = 'Target URL';
 182 }
 183
 184 /**
 185  * Send graph detail for A/B tests mail
 186  *
 187  * @param array $params
 188  * @return array
 189  * @throws API_Exception
 190  */
 191 function civicrm_api3_mailing_a_b_graph_stats($params) {
 192   civicrm_api3_verify_mandatory($params,
 193     'CRM_Mailing_DAO_MailingAB',
 194     array('id'),
 195     FALSE
 196   );
 197
 198   $defaults = array(
 199     'criteria' => 'Open',
 200     'target_date' => CRM_Utils_Time::getTime('YmdHis'),
 201     'split_count' => 6,
 202     'split_count_select' => 1,
 203   );
 204   $params = array_merge($defaults, $params);
 205
 206   $mailingAB = civicrm_api3('MailingAB', 'getsingle', array('id' => $params['id']));
 207   $graphStats = array();
 208   $ABFormat = array('A' => 'mailing_id_a', 'B' => 'mailing_id_b');
 209
 210   foreach ($ABFormat as $name => $column) {
 211     switch (strtolower($params['criteria'])) {
 212       case 'open':
 213         $result = CRM_Mailing_Event_BAO_Opened::getRows($mailingAB['mailing_id_a'], NULL, TRUE, 0, 1, "civicrm_mailing_event_opened.time_stamp ASC");
 214         $startDate = CRM_Utils_Date::processDate($result[0]['date']);
 215         $targetDate = CRM_Utils_Date::processDate($params['target_date']);
 216         $dateDuration = round(round(strtotime($targetDate) - strtotime($startDate)) / $params['split_count']);
 217         $toDate = strtotime($startDate) + ($dateDuration * $params['split_count_select']);
 218         $toDate = date('YmdHis', $toDate);
 219         $graphStats[$name] = array(
 220           $params['split_count_select'] => array(
 221             'count' => CRM_Mailing_Event_BAO_Opened::getTotalCount($mailingAB[$column], NULL, TRUE, $toDate),
 222             'time' => CRM_Utils_Date::customFormat($toDate),
 223           ),
 224         );
 225         break;
 226
 227       case 'total unique clicks':
 228         $result = CRM_Mailing_Event_BAO_TrackableURLOpen::getRows($mailingAB['mailing_id_a'], NULL, TRUE, 0, 1, "civicrm_mailing_event_trackable_url_open.time_stamp ASC");
 229         $startDate = CRM_Utils_Date::processDate($result[0]['date']);
 230         $targetDate = CRM_Utils_Date::processDate($params['target_date']);
 231         $dateDuration = round(abs(strtotime($targetDate) - strtotime($startDate)) / $params['split_count']);
 232         $toDate = strtotime($startDate) + ($dateDuration * $params['split_count_select']);
 233         $toDate = date('YmdHis', $toDate);
 234         $graphStats[$name] = array(
 235           $params['split_count_select'] => array(
 236             'count' => CRM_Mailing_Event_BAO_TrackableURLOpen::getTotalCount($params['mailing_id'], NULL, FALSE, NULL, $toDate),
 237             'time' => CRM_Utils_Date::customFormat($toDate),
 238           ),
 239         );
 240         break;
 241
 242       case 'total clicks on a particular link':
 243         if (empty($params['target_url'])) {
 244           throw new API_Exception("Provide url to get stats result for total clicks on a particular link");
 245         }
 246         // FIXME: doesn't make sense to get url_id mailing_id_(a|b) while getting start date in mailing_id_a
 247         $url_id = CRM_Mailing_BAO_TrackableURL::getTrackerURLId($mailingAB[$column], $params['target_url']);
 248         $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");
 249         $startDate = CRM_Utils_Date::processDate($result[0]['date']);
 250         $targetDate = CRM_Utils_Date::processDate($params['target_date']);
 251         $dateDuration = round(abs(strtotime($targetDate) - strtotime($startDate)) / $params['split_count']);
 252         $toDate = strtotime($startDate) + ($dateDuration * $params['split_count_select']);
 253         $toDate = CRM_Utils_Date::processDate($toDate);
 254         $graphStats[$name] = array(
 255           $params['split_count_select'] => array(
 256             'count' => CRM_Mailing_Event_BAO_TrackableURLOpen::getTotalCount($params['mailing_id'], NULL, FALSE, $url_id, $toDate),
 257             'time' => CRM_Utils_Date::customFormat($toDate),
 258           ),
 259         );
 260         break;
 261     }
 262   }
 263
 264   return civicrm_api3_create_success($graphStats);
 265 }