d567aa6991a6aa466c29e4f19a350f4684a64f67
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. |
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 along with this program; if not, contact CiviCRM LLC |
21 | at info[AT]civicrm[DOT]org. If you have questions about the |
22 | GNU Affero General Public License or the licensing of CiviCRM, |
23 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
24 +--------------------------------------------------------------------+
28 * Create a xml file for a set of contact ID's in a format digestible
32 require_once '../../../civicrm.settings.php';
33 require_once 'CRM/Core/Config.php';
35 define('CHUNK_SIZE', 128);
38 * Split a large array of contactIDs into more manageable smaller chunks
42 function &splitContactIDs(&$contactIDs) {
43 // contactIDs could be a real large array, so we split it up into
44 // smaller chunks and then general xml for each chunk
47 $chunks[$current] = [];
50 foreach ($contactIDs as $cid) {
51 $chunks[$current][] = $cid;
54 if ($count == CHUNK_SIZE
) {
56 $chunks[$current] = [];
61 if (empty($chunks[$current])) {
62 unset($chunks[$current]);
69 * Given an array of values, generate the JSON in the Solr format
73 function &generateSolrJSON($values) {
75 foreach ($values as $cid => $tokens) {
80 $result .= "\n {\n \"contact_id\" : \"$cid\",";
82 foreach ($tokens as $n => $v) {
86 $el = escapeJsonString($el);
89 $string = implode(",", $str);
90 $result .= "\n \"{$n}\" : [$string],";
93 $v = escapeJsonString($v);
94 $result .= "\n \"{$n}\" : \"{$v}\",";
98 // remove the last comma
99 $result = rtrim($result, ",");
103 // remove the last comma
104 $result = rtrim($result, ",");
117 function escapeJsonString($value) {
118 $escapers = ["\\", "/", "\"", "\n", "\r", "\t", "\x08", "\x0c"];
119 $replacements = ["\\\\", "\\/", "\\\"", "\\n", "\\r", "\\t", "\\f", "\\b"];
120 return str_replace($escapers, $replacements, $value);
124 * Given a set of contact IDs get the values
129 function getValues(&$contactIDs, &$values) {
132 foreach ($contactIDs as $cid) {
136 getContactInfo($contactIDs, $values);
137 getAddressInfo($contactIDs, $values);
138 getPhoneInfo($contactIDs, $values);
139 getEmailInfo($contactIDs, $values);
140 getNoteInfo($contactIDs, $values);
151 * @param null $additionalWhereCond
153 function getTableInfo(&$contactIDs, &$values, $tableName, &$fields, $whereField, $additionalWhereCond = NULL) {
154 $selectString = implode(',', array_keys($fields));
155 $idString = implode(',', $contactIDs);
158 SELECT $selectString, $whereField as contact_id
160 WHERE $whereField IN ( $idString )
163 if ($additionalWhereCond) {
164 $sql .= " AND $additionalWhereCond";
167 $dao = &CRM_Core_DAO
::executeQuery($sql);
168 while ($dao->fetch()) {
169 foreach ($fields as $fld => $name) {
170 $name = $name ?
$name : $fld;
171 appendValue($values, $dao->contact_id
, $name, $dao->$fld);
180 function getContactInfo(&$contactIDs, &$values) {
183 'display_name' => NULL,
184 'contact_type' => NULL,
185 'legal_identifier' => NULL,
186 'external_identifier' => NULL,
187 'first_name' => NULL,
189 'middle_name' => NULL,
190 'household_name' => NULL,
191 'organization_name' => NULL,
192 'legal_name' => NULL,
195 getTableInfo($contactIDs, $values, 'civicrm_contact', $fields, 'id');
202 function getNoteInfo(&$contactIDs, &$values) {
203 $ids = implode(',', $contactIDs);
207 entity_id as contact_id,
208 note as note, subject as subject
210 WHERE entity_id IN ( $ids )
211 AND entity_table = 'civicrm_contact'
214 $dao = &CRM_Core_DAO
::executeQuery($sql);
215 while ($dao->fetch()) {
216 $note = empty($dao->subject
) ?
'' : "{$dao->subject}: ";
217 $note .= empty($dao->note
) ?
'' : $dao->note
;
219 appendValue($values, $dao->contact_id
, 'note', $note);
227 function getPhoneInfo(&$contactIDs, &$values) {
228 $ids = implode(',', $contactIDs);
233 l.name as location_type,
235 v.label as phone_type
236 FROM civicrm_contact c
237 INNER JOIN civicrm_phone p ON p.contact_id = c.id
238 LEFT JOIN civicrm_location_type l ON p.location_type_id = l.id
239 LEFT JOIN civicrm_option_group g ON g.name = 'phone_type'
240 LEFT JOIN civicrm_option_value v ON v.option_group_id = g.id AND p.phone_type_id = v.value
241 WHERE c.id IN ( $ids )
242 AND p.phone IS NOT NULL
245 $dao = &CRM_Core_DAO
::executeQuery($sql);
246 while ($dao->fetch()) {
249 if (!empty($dao->location_type
)) {
250 $phone = "{$dao->location_type}: ";
253 $phone .= $dao->phone
;
255 if (!empty($dao->phone_type
)) {
256 $phone .= " ({$dao->phone_type})";
259 appendValue($values, $dao->contact_id
, 'phone', $phone);
267 function getEmailInfo(&$contactIDs, &$values) {
268 $ids = implode(',', $contactIDs);
273 l.name as location_type,
275 FROM civicrm_contact c
276 INNER JOIN civicrm_email e ON e.contact_id = c.id
277 LEFT JOIN civicrm_location_type l ON e.location_type_id = l.id
278 WHERE c.id IN ( $ids )
279 AND e.email IS NOT NULL
282 $dao = &CRM_Core_DAO
::executeQuery($sql);
283 while ($dao->fetch()) {
286 if (!empty($dao->location_type
)) {
287 $email = "{$dao->location_type}: ";
290 $email .= $dao->email
;
291 appendValue($values, $dao->contact_id
, 'email', $email);
299 function getAddressInfo(&$contactIDs, &$values) {
300 $ids = implode(',', $contactIDs);
303 SELECT c.id as contact_id, l.name as location_type,
304 a.street_address, a.supplemental_address_1, a.supplemental_address_2,
305 a.supplemental_address_3,
306 a.city, a.postal_code,
307 s.name as state, co.name as country
308 FROM civicrm_contact c
309 INNER JOIN civicrm_address a ON a.contact_id = c.id
310 LEFT JOIN civicrm_location_type l ON a.location_type_id = l.id
311 LEFT JOIN civicrm_state_province s ON a.state_province_id = s.id
312 LEFT JOIN civicrm_country co ON a.country_id = co.id
313 WHERE c.id IN ( $ids )
319 'supplemental_address_1',
320 'supplemental_address_2',
321 'supplemental_address_3',
327 $dao = &CRM_Core_DAO
::executeQuery($sql);
328 while ($dao->fetch()) {
330 foreach ($fields as $fld) {
331 if (empty($dao->$fld)) {
335 $address .= ($fld == 'location_type') ?
"{$dao->$fld}: " : " {$dao->$fld},";
336 appendValue($values, $dao->contact_id
, $fld, $dao->$fld);
339 if (!empty($address)) {
340 $address = rtrim($address, ",");
341 appendValue($values, $dao->contact_id
, 'address', $address);
352 function appendValue(&$values, $contactID, $name, $value) {
357 if (!isset($values[$contactID][$name])) {
358 $values[$contactID][$name] = $value;
361 if (!is_array($values[$contactID][$name])) {
362 $save = $values[$contactID][$name];
363 $values[$contactID][$name] = [];
364 $values[$contactID][$name][] = $save;
366 $values[$contactID][$name][] = $value;
373 function run(&$contactIDs) {
374 $chunks = &splitContactIDs($contactIDs);
376 foreach ($chunks as $chunk) {
378 getValues($chunk, $values);
379 $xml = &generateSolrJSON($values);
384 $config = CRM_Core_Config
::singleton();
385 $config->userFramework
= 'Soap';
386 $config->userFrameworkClass
= 'CRM_Utils_System_Soap';
387 $config->userHookClass
= 'CRM_Utils_Hook_Soap';
393 $dao = &CRM_Core_DAO
::executeQuery($sql);
397 while ($dao->fetch()) {
398 $contactIDs[] = $dao->id
;