-
-
Notifications
You must be signed in to change notification settings - Fork 814
/
Export.php
431 lines (384 loc) · 14.7 KB
/
Export.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
<?php
/*
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC. All rights reserved. |
| |
| This work is published under the GNU AGPLv3 license with some |
| permitted exceptions and without any warranty. For full license |
| and copyright information, see https://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
*
* @package CRM
* @copyright CiviCRM LLC https://civicrm.org/licensing
*/
/**
* This class contains the functions for Component export
*
*/
class CRM_Export_BAO_Export {
// increase this number a lot to avoid making too many queries
// LIMIT is not much faster than a no LIMIT query
// CRM-7675
const EXPORT_ROW_COUNT = 100000;
/**
* Returns a list of exportable entities and their associated component.
*
* Note: Some entities like Contact & Activity are not in components, so
* the export form seems to fudge things and accept the entity name instead of
* component name in those cases.
*
* TODO: Hardcoded list bad. Needs to support extension export pages.
*
* @var string[]
*/
public static function getComponents() {
return [
'Contact' => 'Contact',
'Contribution' => 'Contribute',
'Membership' => 'Member',
'Participant' => 'Event',
'Pledge' => 'Pledge',
'Case' => 'Case',
'Grant' => 'Grant',
'Activity' => 'Activity',
];
}
/**
* Get the list the export fields.
*
* @param int $selectAll
* User preference while export.
* @param array $ids
* Contact ids.
* @param array $params
* Associated array of fields.
* @param string $order
* Order by clause.
* @param array $fields
* Associated array of fields.
* @param array $moreReturnProperties
* Additional return fields.
* @param int $exportMode
* Export mode.
* @param string $componentClause
* Component clause.
* @param string $componentTable
* Component table.
* @param bool $mergeSameAddress
* Merge records if they have same address.
* @param bool $mergeSameHousehold
* Merge records if they belong to the same household.
*
* @param array $exportParams
* @param string $queryOperator
*
* @throws \CRM_Core_Exception
*/
public static function exportComponents(
$selectAll,
$ids,
$params,
$order = NULL,
$fields = NULL,
$moreReturnProperties = NULL,
$exportMode = CRM_Export_Form_Select::CONTACT_EXPORT,
$componentClause = NULL,
$componentTable = NULL,
$mergeSameAddress = FALSE,
$mergeSameHousehold = FALSE,
$exportParams = [],
$queryOperator = 'AND'
) {
$isPostalOnly = (
isset($exportParams['postal_mailing_export']['postal_mailing_export']) &&
$exportParams['postal_mailing_export']['postal_mailing_export'] == 1
);
// rectify params to what proximity search expects if there is a value for prox_distance
// CRM-7021
// @todo - move this back to the calling functions
if (!empty($params)) {
CRM_Contact_BAO_ProximityQuery::fixInputParams($params);
}
// @todo everything from this line up should go back to the calling functions.
$processor = new CRM_Export_BAO_ExportProcessor($exportMode, $fields, $queryOperator, $mergeSameHousehold, $isPostalOnly, $mergeSameAddress, $exportParams);
if ($moreReturnProperties) {
$processor->setAdditionalRequestedReturnProperties($moreReturnProperties);
}
$processor->setComponentTable($componentTable);
$processor->setComponentClause($componentClause);
$processor->setIds($ids);
[$query, $queryString] = $processor->runQuery($params, $order);
// This perhaps only needs calling when $mergeSameHousehold == 1
self::buildRelatedContactArray($selectAll, $ids, $processor, $componentTable);
$addPaymentHeader = FALSE;
[$outputColumns] = $processor->getExportStructureArrays();
if ($processor->isMergeSameAddress()) {
foreach (array_keys($processor->getAdditionalFieldsForSameAddressMerge()) as $field) {
if ($field === 'id') {
$field = 'civicrm_primary_id';
}
$processor->setColumnAsCalculationOnly($field);
}
}
$paymentDetails = [];
if ($processor->isExportPaymentFields()) {
// get payment related in for event and members
$paymentDetails = $processor->getContributionDetails();
//get all payment headers.
// If we haven't selected specific payment fields, load in all the
// payment headers.
if (!$processor->isExportSpecifiedPaymentFields()) {
if (!empty($paymentDetails)) {
$addPaymentHeader = TRUE;
foreach (array_keys($processor->getPaymentHeaders()) as $paymentField) {
$processor->addOutputSpecification($paymentField);
}
}
}
}
$componentDetails = [];
$rowCount = self::EXPORT_ROW_COUNT;
$offset = 0;
// we write to temp table often to avoid using too much memory
$tempRowCount = 100;
$count = -1;
$processor->createTempTable();
$limitReached = FALSE;
while (!$limitReached) {
$limitQuery = "{$queryString} LIMIT {$offset}, {$rowCount}";
CRM_Core_DAO::disableFullGroupByMode();
$iterationDAO = CRM_Core_DAO::executeQuery($limitQuery);
CRM_Core_DAO::reenableFullGroupByMode();
// If this is less than our limit by the end of the iteration we do not need to run the query again to
// check if some remain.
$rowsThisIteration = 0;
while ($iterationDAO->fetch()) {
$count++;
$rowsThisIteration++;
$row = $processor->buildRow($query, $iterationDAO, $outputColumns, $paymentDetails, $addPaymentHeader);
if ($row === FALSE) {
continue;
}
// add component info
// write the row to a file
$componentDetails[] = $row;
// output every $tempRowCount rows
if ($count % $tempRowCount == 0) {
self::writeDetailsToTable($processor, $componentDetails);
$componentDetails = [];
}
}
if ($rowsThisIteration < self::EXPORT_ROW_COUNT) {
$limitReached = TRUE;
}
$offset += $rowCount;
}
if ($processor->getTemporaryTable()) {
self::writeDetailsToTable($processor, $componentDetails);
// do merge same address and merge same household processing
if ($mergeSameAddress) {
$processor->mergeSameAddress();
}
$processor->writeCSVFromTable();
// delete the export temp table and component table
$sql = "DROP TABLE IF EXISTS " . $processor->getTemporaryTable();
CRM_Core_DAO::executeQuery($sql);
CRM_Core_DAO::reenableFullGroupByMode();
CRM_Utils_System::civiExit(0, ['processor' => $processor]);
}
else {
CRM_Core_DAO::reenableFullGroupByMode();
throw new CRM_Core_Exception(ts('No records to export'));
}
}
/**
* Handle import error file creation.
*/
public static function invoke() {
$type = CRM_Utils_Request::retrieve('type', 'Positive');
$parserName = CRM_Utils_Request::retrieve('parser', 'String');
if (empty($parserName) || empty($type)) {
return;
}
// clean and ensure parserName is a valid string
$parserName = CRM_Utils_String::munge($parserName);
$parserClass = explode('_', $parserName);
// make sure parserClass is in the CRM namespace and
// at least 3 levels deep
if ($parserClass[0] == 'CRM' &&
count($parserClass) >= 3
) {
// ensure the functions exists
if (method_exists($parserName, 'errorFileName') &&
method_exists($parserName, 'saveFileName')
) {
CRM_Core_Error::deprecatedWarning('unused code');
$errorFileName = $parserName::errorFileName($type);
$saveFileName = $parserName::saveFileName($type);
if (!empty($errorFileName) && !empty($saveFileName)) {
CRM_Utils_System::setHttpHeader('Cache-Control', 'must-revalidate, post-check=0, pre-check=0');
CRM_Utils_System::setHttpHeader('Content-Description', 'File Transfer');
CRM_Utils_System::setHttpHeader('Content-Type', 'text/csv');
CRM_Utils_System::setHttpHeader('Content-Length', filesize($errorFileName));
CRM_Utils_System::setHttpHeader('Content-Disposition', 'attachment; filename=' . $saveFileName);
readfile($errorFileName);
}
}
}
CRM_Utils_System::civiExit();
}
/**
* @param \CRM_Export_BAO_ExportProcessor $processor
* @param $details
*/
public static function writeDetailsToTable($processor, $details) {
$tableName = $processor->getTemporaryTable();
if (empty($details)) {
return;
}
$sql = "
SELECT max(id)
FROM $tableName
";
$id = CRM_Core_DAO::singleValueQuery($sql);
if (!$id) {
$id = 0;
}
$sqlClause = [];
foreach ($details as $row) {
$id++;
$valueString = [$id];
foreach ($row as $value) {
if (empty($value)) {
$valueString[] = "''";
}
else {
$valueString[] = "'" . CRM_Core_DAO::escapeString($value) . "'";
}
}
$sqlClause[] = '(' . implode(',', $valueString) . ')';
}
$sqlColumns = array_merge(['id' => 1], $processor->getSQLColumns());
$sqlColumnString = '(`' . implode('`, `', array_keys($sqlColumns)) . '`)';
$sqlValueString = implode(",\n", $sqlClause);
$sql = "
INSERT INTO $tableName $sqlColumnString
VALUES $sqlValueString
";
CRM_Core_DAO::executeQuery($sql);
}
/**
* Get the ids that we want to get related contact details for.
*
* @param array $ids
* @param int $exportMode
*
* @return array
*/
protected static function getIDsForRelatedContact($ids, $exportMode) {
if ($exportMode == CRM_Export_Form_Select::CONTACT_EXPORT) {
return $ids;
}
if ($exportMode == CRM_Export_Form_Select::ACTIVITY_EXPORT) {
$relIDs = [];
$sourceID = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_ActivityContact', 'record_type_id', 'Activity Source');
$dao = CRM_Core_DAO::executeQuery("
SELECT contact_id FROM civicrm_activity_contact
WHERE activity_id IN ( " . implode(',', $ids) . ") AND
record_type_id = {$sourceID}
");
while ($dao->fetch()) {
$relIDs[] = $dao->contact_id;
}
return $relIDs;
}
$componentMapping = [
CRM_Export_Form_Select::CONTRIBUTE_EXPORT => 'civicrm_contribution',
CRM_Export_Form_Select::EVENT_EXPORT => 'civicrm_participant',
CRM_Export_Form_Select::MEMBER_EXPORT => 'civicrm_membership',
CRM_Export_Form_Select::PLEDGE_EXPORT => 'civicrm_pledge',
CRM_Export_Form_Select::GRANT_EXPORT => 'civicrm_grant',
];
if ($exportMode == CRM_Export_Form_Select::CASE_EXPORT) {
return CRM_Case_BAO_Case::retrieveContactIdsByCaseId($ids);
}
else {
return CRM_Core_DAO::getContactIDsFromComponent($ids, $componentMapping[$exportMode]);
}
}
/**
* @param $selectAll
* @param $ids
* @param \CRM_Export_BAO_ExportProcessor $processor
* @param $componentTable
*/
protected static function buildRelatedContactArray($selectAll, $ids, $processor, $componentTable) {
$allRelContactArray = $relationQuery = [];
$queryMode = $processor->getQueryMode();
$exportMode = $processor->getExportMode();
foreach ($processor->getRelationshipReturnProperties() as $relationshipKey => $relationReturnProperties) {
$allRelContactArray[$relationshipKey] = [];
// build Query for each relationship
$relationQuery = new CRM_Contact_BAO_Query(NULL, $relationReturnProperties,
NULL, FALSE, FALSE, $queryMode
);
[$relationSelect, $relationFrom, $relationWhere, $relationHaving] = $relationQuery->query();
[$id, $direction] = explode('_', $relationshipKey, 2);
// identify the relationship direction
$contactA = 'contact_id_a';
$contactB = 'contact_id_b';
if ($direction == 'b_a') {
$contactA = 'contact_id_b';
$contactB = 'contact_id_a';
}
$relIDs = self::getIDsForRelatedContact($ids, $exportMode);
$relationshipJoin = $relationshipClause = '';
if (!$selectAll && $componentTable) {
$field = 'contact_id';
if ($componentTable === 'civicrm_contact') {
$field = 'id';
}
$relationshipJoin = " INNER JOIN {$componentTable} ctTable ON ctTable.$field = {$contactA}";
}
elseif (!empty($relIDs)) {
$relID = implode(',', $relIDs);
$relationshipClause = " AND crel.{$contactA} IN ( {$relID} )";
}
$relationFrom = " {$relationFrom}
INNER JOIN civicrm_relationship crel ON crel.{$contactB} = contact_a.id AND crel.relationship_type_id = {$id}
{$relationshipJoin} ";
//check for active relationship status only
$today = date('Ymd');
$relationActive = " AND (crel.is_active = 1 AND ( crel.end_date is NULL OR crel.end_date >= {$today} ) )";
$relationWhere = " WHERE contact_a.is_deleted = 0 {$relationshipClause} {$relationActive}";
CRM_Core_DAO::disableFullGroupByMode();
$relationSelect = "{$relationSelect}, {$contactA} as refContact ";
$relationQueryString = "$relationSelect $relationFrom $relationWhere $relationHaving GROUP BY crel.{$contactA}";
$allRelContactDAO = CRM_Core_DAO::executeQuery($relationQueryString);
CRM_Core_DAO::reenableFullGroupByMode();
while ($allRelContactDAO->fetch()) {
$relationQuery->convertToPseudoNames($allRelContactDAO);
$row = [];
// @todo pass processor to fetchRelationshipDetails and set fields directly within it.
$processor->fetchRelationshipDetails($allRelContactDAO, $relationReturnProperties, $relationshipKey, $row);
foreach (array_keys($relationReturnProperties) as $property) {
if ($property === 'location') {
// @todo - simplify location in fetchRelationshipDetails - remove handling here. Or just call
// $processor->setRelationshipValue from fetchRelationshipDetails
foreach ($relationReturnProperties['location'] as $locationName => $locationValues) {
foreach (array_keys($locationValues) as $locationValue) {
$key = str_replace(' ', '_', $locationName) . '-' . $locationValue;
$processor->setRelationshipValue($relationshipKey, $allRelContactDAO->refContact, $key, $row[$relationshipKey . '__' . $key]);
}
}
}
else {
$processor->setRelationshipValue($relationshipKey, $allRelContactDAO->refContact, $property, $row[$relationshipKey . '_' . $property]);
}
}
}
}
}
}