CRM/Mailing/Page/Report.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  */
  33
  34 /**
  35  * Page to display / edit the header / footer of a mailing.
  36  */
  37 class CRM_Mailing_Page_Report extends CRM_Core_Page_Basic {
  38   public $_mailing_id;
  39
  40   /**
  41    * Get BAO Name.
  42    *
  43    * @return string
  44    *   Classname of BAO
  45    */
  46   public function getBAOName() {
  47     return 'CRM_Mailing_BAO_Mailing';
  48   }
  49
  50   /**
  51    * An array of action links.
  52    *
  53    * @return null
  54    */
  55   public function &links() {
  56     return CRM_Core_DAO::$_nullObject;
  57   }
  58
  59   /**
  60    * @return null
  61    */
  62   public function editForm() {
  63     return NULL;
  64   }
  65
  66   /**
  67    * @return string
  68    */
  69   public function editName() {
  70     return 'CiviMail Report';
  71   }
  72
  73   /**
  74    * Get user context.
  75    *
  76    * @param null $mode
  77    *
  78    * @return string
  79    *   user context.
  80    */
  81   public function userContext($mode = NULL) {
  82     return 'civicrm/mailing/report';
  83   }
  84
  85   /**
  86    * @param null $mode
  87    *
  88    * @return string
  89    */
  90   public function userContextParams($mode = NULL) {
  91     return 'reset=1&mid=' . $this->_mailing_id;
  92   }
  93
  94   /**
  95    * @return string
  96    */
  97   public function run() {
  98     $this->_mailing_id = CRM_Utils_Request::retrieve('mid', 'Positive', $this);
  99     //CRM-15979 - check if abtest exist for mailing then redirect accordingly
 100     $abtest = CRM_Mailing_BAO_MailingAB::getABTest($this->_mailing_id);
 101     if (!empty($abtest) && !empty($abtest->id)) {
 102       CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/a/', NULL, TRUE, '/abtest/' . $abtest->id));
 103     }
 104     // check that the user has permission to access mailing id
 105     CRM_Mailing_BAO_Mailing::checkPermission($this->_mailing_id);
 106
 107     $report = CRM_Mailing_BAO_Mailing::report($this->_mailing_id);
 108
 109     // get contents of mailing
 110     CRM_Mailing_BAO_Mailing::getMailingContent($report, $this);
 111
 112     // assign backurl
 113     $context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this);
 114     $cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
 115
 116     if ($context == 'activitySelector') {
 117       $backUrl = CRM_Utils_System::url('civicrm/contact/view', "reset=1&cid={$cid}&selectedChild=activity");
 118       $backUrlTitle = ts('Back to Activities');
 119     }
 120     elseif ($context == 'activity') {
 121       $atype = CRM_Utils_Request::retrieve('atype', 'Positive', $this);
 122       $aid = CRM_Utils_Request::retrieve('aid', 'Positive', $this);
 123
 124       $backUrl = CRM_Utils_System::url('civicrm/activity/view',
 125         "atype={$atype}&action=view&reset=1&id={$aid}&cid={$cid}&context=activity"
 126       );
 127       $backUrlTitle = ts('Back to Activity');
 128     }
 129     elseif ($context == 'mailing') {
 130       $backUrl = CRM_Utils_System::url('civicrm/contact/view', "reset=1&cid={$cid}&selectedChild=mailing");
 131       $backUrlTitle = ts('Back to Mailing');
 132     }
 133     else {
 134       $backUrl = CRM_Utils_System::url('civicrm/mailing', 'reset=1');
 135       $backUrlTitle = ts('Back to CiviMail');
 136     }
 137     $this->assign('backUrl', $backUrl);
 138     $this->assign('backUrlTitle', $backUrlTitle);
 139
 140     $this->assign('report', $report);
 141     CRM_Utils_System::setTitle(ts('CiviMail Report: %1',
 142       [1 => $report['mailing']['name']]
 143     ));
 144     $this->assign('public_url', CRM_Mailing_BAO_Mailing::getPublicViewUrl($this->_mailing_id));
 145
 146     return CRM_Core_Page::run();
 147   }
 148
 149 }