3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
35 * A PHP cron script to format all the addresses in the database. Currently
36 * it only does geocoding if the geocode values are not set. At a later
37 * stage we will also handle USPS address cleanup and other formatting
40 class CRM_Utils_Address_BatchUpdate
{
48 var $returnMessages = array();
54 * @param array $params
56 public function __construct($params) {
58 foreach ($params as $name => $value) {
59 $this->$name = $value;
62 // fixme: more params verification
70 public function run() {
72 // do check for geocoding.
73 $processGeocode = FALSE;
74 if (!CRM_Utils_GeocodeProvider
::getUsableClassName()) {
75 if (CRM_Utils_String
::strtobool($this->geocoding
) === TRUE) {
76 $this->returnMessages
[] = ts('Error: You need to set a mapping provider under Administer > System Settings > Mapping and Geocoding');
77 $this->returnError
= 1;
78 $this->returnResult();
82 $processGeocode = TRUE;
83 // user might want to over-ride.
84 if (CRM_Utils_String
::strtobool($this->geocoding
) === FALSE) {
85 $processGeocode = FALSE;
89 // do check for parse street address.
90 $parseAddress = FALSE;
91 $parseAddress = CRM_Utils_Array
::value('street_address_parsing',
92 CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
97 $parseStreetAddress = FALSE;
99 if (CRM_Utils_String
::strtobool($this->parse
) === TRUE) {
100 $this->returnMessages
[] = ts('Error: You need to enable Street Address Parsing under Administer > Localization > Address Settings.');
101 $this->returnError
= 1;
102 return $this->returnResult();
106 $parseStreetAddress = TRUE;
107 // user might want to over-ride.
108 if (CRM_Utils_String
::strtobool($this->parse
) === FALSE) {
109 $parseStreetAddress = FALSE;
114 if (!$parseStreetAddress && !$processGeocode) {
115 $this->returnMessages
[] = ts('Error: Both Geocode mapping as well as Street Address Parsing are disabled. You must configure one or both options to use this script.');
116 $this->returnError
= 1;
117 return $this->returnResult();
120 // do check for parse street address.
121 return $this->processContacts($processGeocode, $parseStreetAddress);
127 * @param bool $processGeocode
128 * @param bool $parseStreetAddress
133 public function processContacts($processGeocode, $parseStreetAddress) {
134 // build where clause.
135 $clause = array('( c.id = a.contact_id )');
138 $clause[] = "( c.id >= %1 )";
139 $params[1] = array($this->start
, 'Integer');
143 $clause[] = "( c.id <= %2 )";
144 $params[2] = array($this->end
, 'Integer');
147 if ($processGeocode) {
148 $clause[] = '( a.geo_code_1 is null OR a.geo_code_1 = 0 )';
149 $clause[] = '( a.geo_code_2 is null OR a.geo_code_2 = 0 )';
150 $clause[] = '( a.country_id is not null )';
153 $whereClause = implode(' AND ', $clause);
164 FROM civicrm_contact c
165 INNER JOIN civicrm_address a ON a.contact_id = c.id
166 LEFT JOIN civicrm_country o ON a.country_id = o.id
167 LEFT JOIN civicrm_state_province s ON a.state_province_id = s.id
172 $totalGeocoded = $totalAddresses = $totalAddressParsed = 0;
174 $dao = CRM_Core_DAO
::executeQuery($query, $params);
176 $unparseableContactAddress = array();
177 while ($dao->fetch()) {
180 'street_address' => $dao->street_address
,
181 'postal_code' => $dao->postal_code
,
182 'city' => $dao->city
,
183 'state_province' => $dao->state
,
184 'country' => $dao->country
,
185 'country_id' => $dao->country_id
,
188 $addressParams = array();
191 if ($processGeocode) {
192 // loop through the address removing more information
193 // so we can get some geocode for a partial address
194 // i.e. city -> state -> country
198 if ($this->throttle
) {
202 CRM_Core_BAO_Address
::addGeocoderData($params);
204 // see if we got a geocode error, in this case we'll trigger a fatal
207 isset($params['geo_code_error']) &&
208 $params['geo_code_error'] == 'OVER_QUERY_LIMIT'
210 throw new CRM_Core_Exception('Aborting batch geocoding. Hit the over query limit on geocoder.');
213 array_shift($params);
216 (!isset($params['geo_code_1']) ||
$params['geo_code_1'] == 'null') &&
220 if (isset($params['geo_code_1']) && $params['geo_code_1'] != 'null') {
222 $addressParams = $params;
226 // parse street address
227 if ($parseStreetAddress) {
228 $parsedFields = CRM_Core_BAO_Address
::parseStreetAddress($dao->street_address
);
230 // consider address is automatically parseable,
231 // when we should found street_number and street_name
232 if (empty($parsedFields['street_name']) ||
empty($parsedFields['street_number'])) {
236 // do check for all elements.
238 $totalAddressParsed++
;
240 elseif ($dao->street_address
) {
241 //build contact edit url,
242 //so that user can manually fill the street address fields if the street address is not parsed, CRM-5886
243 $url = CRM_Utils_System
::url('civicrm/contact/add', "reset=1&action=update&cid={$dao->id}");
244 $unparseableContactAddress[] = " Contact ID: " . $dao->id
. " <a href =\"$url\"> " . $dao->street_address
. " </a> ";
245 // reset element values.
246 $parsedFields = array_fill_keys(array_keys($parsedFields), '');
248 $addressParams = array_merge($addressParams, $parsedFields);
251 // finally update address object.
252 if (!empty($addressParams)) {
253 $address = new CRM_Core_DAO_Address();
254 $address->id
= $dao->address_id
;
255 $address->copyValues($addressParams);
261 $this->returnMessages
[] = ts("Addresses Evaluated: %1", array(
262 1 => $totalAddresses,
264 if ($processGeocode) {
265 $this->returnMessages
[] = ts("Addresses Geocoded: %1", array(
269 if ($parseStreetAddress) {
270 $this->returnMessages
[] = ts("Street Addresses Parsed: %1", array(
271 1 => $totalAddressParsed,
273 if ($unparseableContactAddress) {
274 $this->returnMessages
[] = "<br />\n" . ts("Following is the list of contacts whose address is not parsed:") . "<br />\n";
275 foreach ($unparseableContactAddress as $contactLink) {
276 $this->returnMessages
[] = $contactLink . "<br />\n";
281 return $this->returnResult();
289 public function returnResult() {
291 $result['is_error'] = $this->returnError
;
292 $result['messages'] = implode("", $this->returnMessages
);