CRM/Contact/Form/Task/Map.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  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class provides the functionality to map
  38  * the address for group of
  39  * contacts.
  40  */
  41 class CRM_Contact_Form_Task_Map extends CRM_Contact_Form_Task {
  42
  43   /**
  44    * Are we operating in "single mode", i.e. mapping address to one
  45    * specific contact?
  46    *
  47    * @var boolean
  48    */
  49   protected $_single = FALSE;
  50
  51   /**
  52    * Build all the data structures needed to build the form
  53    *
  54    * @return void
  55    */
  56   public function preProcess() {
  57     $cid = CRM_Utils_Request::retrieve('cid', 'Positive',
  58       $this, FALSE
  59     );
  60     $lid = CRM_Utils_Request::retrieve('lid', 'Positive',
  61       $this, FALSE
  62     );
  63     $eid = CRM_Utils_Request::retrieve('eid', 'Positive',
  64       $this, FALSE
  65     );
  66     $profileGID = CRM_Utils_Request::retrieve('profileGID', 'Integer',
  67       $this, FALSE
  68     );
  69     $this->assign('profileGID', $profileGID);
  70     $context = CRM_Utils_Request::retrieve('context', 'String', $this);
  71
  72     $type = 'Contact';
  73     if ($cid) {
  74       $ids = array($cid);
  75       $this->_single = TRUE;
  76       if ($profileGID) {
  77         // this does a check and ensures that the user has permission on this profile
  78         // CRM-11766
  79         $profileIDs = CRM_Profile_Page_Listings::getProfileContact($profileGID);
  80         if (!in_array($cid, $profileIDs)) {
  81           CRM_Core_Error::fatal();
  82         }
  83       }
  84       elseif ($context) {
  85         $qfKey = CRM_Utils_Request::retrieve('key', 'String', $this);
  86         $urlParams = 'force=1';
  87         if (CRM_Utils_Rule::qfKey($qfKey)) {
  88           $urlParams .= "&qfKey=$qfKey";
  89         }
  90         $session = CRM_Core_Session::singleton();
  91         $urlString = "civicrm/contact/search/$context";
  92         if ($context == 'search') {
  93           $urlString = 'civicrm/contact/search';
  94         }
  95         $url = CRM_Utils_System::url($urlString, $urlParams);
  96         $session->replaceUserContext($url);
  97       }
  98     }
  99     elseif ($eid) {
 100       $ids = $eid;
 101       $type = 'Event';
 102     }
 103     else {
 104       if ($profileGID) {
 105         $ids = CRM_Profile_Page_Listings::getProfileContact($profileGID);
 106       }
 107       else {
 108         parent::preProcess();
 109         $ids = $this->_contactIds;
 110       }
 111     }
 112     self::createMapXML($ids, $lid, $this, TRUE, $type);
 113     $this->assign('single', $this->_single);
 114   }
 115
 116   /**
 117    * Build the form object
 118    *
 119    *
 120    * @return void
 121    */
 122   public function buildQuickForm() {
 123     $this->addButtons(array(
 124         array(
 125           'type' => 'done',
 126           'name' => ts('Done'),
 127           'isDefault' => TRUE,
 128         ),
 129       )
 130     );
 131   }
 132
 133   /**
 134    * Process the form after the input has been submitted and validated
 135    *
 136    *
 137    * @return void
 138    */
 139   public function postProcess() {}
 140
 141   /**
 142    * Assign smarty variables to the template that will be used by google api to plot the contacts
 143    *
 144    * @param $ids
 145    * @param int $locationId location_id
 146    * @param $page
 147    * @param $addBreadCrumb
 148    * @param string $type
 149    *
 150    * @return string           the location of the file we have created
 151    */
 152   public static function createMapXML($ids, $locationId, &$page, $addBreadCrumb, $type = 'Contact') {
 153     $config = CRM_Core_Config::singleton();
 154
 155     CRM_Utils_System::setTitle(ts('Map Location(s)'));
 156     $page->assign('query', 'CiviCRM Search Query');
 157     $page->assign('mapProvider', $config->mapProvider);
 158     $page->assign('mapKey', urlencode($config->mapAPIKey));
 159     if ($type == 'Contact') {
 160       $imageUrlOnly = FALSE;
 161
 162       // google needs image url, CRM-6564
 163       if ($config->mapProvider == 'Google' || $config->mapProvider == 'OpenStreetMaps') {
 164         $imageUrlOnly = TRUE;
 165       }
 166       $locations = CRM_Contact_BAO_Contact_Location::getMapInfo($ids, $locationId, $imageUrlOnly);
 167     }
 168     else {
 169       $locations = CRM_Event_BAO_Event::getMapInfo($ids);
 170     }
 171
 172     if (empty($locations)) {
 173       CRM_Core_Error::statusBounce(ts('This address does not contain latitude/longitude information and cannot be mapped.'));
 174     }
 175
 176     if ($addBreadCrumb) {
 177       $session = CRM_Core_Session::singleton();
 178       $redirect = $session->readUserContext();
 179       if ($type == 'Contact') {
 180         $bcTitle = ts('Contact');
 181       }
 182       else {
 183         $bcTitle = ts('Event Info');
 184         $action = CRM_Utils_Request::retrieve('action', 'String',
 185           $page, FALSE
 186         );
 187         if ($action) {
 188           $args = 'reset=1&action=preview&id=';
 189         }
 190         else {
 191           $args = 'reset=1&id=';
 192         }
 193         $session->pushUserContext(CRM_Utils_System::url('civicrm/event/info', "{$args}{$ids}"));
 194       }
 195       CRM_Utils_System::appendBreadCrumb($bcTitle, $redirect);
 196     }
 197
 198     $page->assign_by_ref('locations', $locations);
 199
 200     // only issue a javascript warning if we know we will not
 201     // mess the poor user with too many warnings
 202     if (count($locations) <= 3) {
 203       $page->assign('geoCodeWarn', TRUE);
 204     }
 205     else {
 206       $page->assign('geoCodeWarn', FALSE);
 207     }
 208
 209     $sumLat = $sumLng = 0;
 210     $maxLat = $maxLng = -400;
 211     $minLat = $minLng = + 400;
 212     foreach ($locations as $location) {
 213       $sumLat += $location['lat'];
 214       $sumLng += $location['lng'];
 215
 216       if ($location['lat'] > $maxLat) {
 217         $maxLat = $location['lat'];
 218       }
 219       if ($location['lat'] < $minLat) {
 220         $minLat = $location['lat'];
 221       }
 222
 223       if ($location['lng'] > $maxLng) {
 224         $maxLng = $location['lng'];
 225       }
 226       if ($location['lng'] < $minLng) {
 227         $minLng = $location['lng'];
 228       }
 229     }
 230
 231     $center = array(
 232       'lat' => (float ) $sumLat / count($locations),
 233       'lng' => (float ) $sumLng / count($locations),
 234     );
 235     $span = array(
 236       'lat' => (float )($maxLat - $minLat),
 237       'lng' => (float )($maxLng - $minLng),
 238     );
 239     $page->assign_by_ref('center', $center);
 240     $page->assign_by_ref('span', $span);
 241   }
 242 }