3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
33 class CRM_Utils_Migrate_Import
{
37 public function __construct() {
41 * Import custom-data from an XML file.
44 * Path to an XML file.
46 * @throws CRM_Core_Exception
48 public function run($file) {
50 $dom = new DomDocument();
51 $xmlString = file_get_contents($file);
52 $load = $dom->loadXML($xmlString);
54 throw new CRM_Core_Exception("Failed to parse XML file \"$file\"");
57 $xml = simplexml_import_dom($dom);
58 return $this->runXmlElement($xml);
62 * Import custom-data from an XML element.
64 * @param SimpleXMLElement $xml
66 public function runXmlElement($xml) {
68 'custom_group' => array(),
69 'option_group' => array(),
72 // first create option groups and values if any
73 $this->optionGroups($xml, $idMap);
74 $this->optionValues($xml, $idMap);
76 $this->relationshipTypes($xml);
77 $this->contributionTypes($xml);
79 // now create custom groups
80 $this->customGroups($xml, $idMap);
81 $this->customFields($xml, $idMap);
83 // now create profile groups
84 $this->profileGroups($xml, $idMap);
85 $this->profileFields($xml, $idMap);
86 $this->profileJoins($xml, $idMap);
88 // create DB Template String sample data
89 $this->dbTemplateString($xml, $idMap);
91 // clean up all caches etc
92 CRM_Core_Config
::clearDBCache();
96 * @param CRM_Core_DAO $dao
99 * @param null $keyName
103 public function copyData(&$dao, &$xml, $save = FALSE, $keyName = NULL) {
105 if (isset($xml->$keyName)) {
106 $dao->$keyName = (string ) $xml->$keyName;
107 if ($dao->find(TRUE)) {
108 CRM_Core_Session
::setStatus(ts("Found %1, %2, %3",
120 $fields = &$dao->fields();
121 foreach ($fields as $name => $dontCare) {
122 if (isset($xml->$name)) {
123 $value = (string ) $xml->$name;
124 $value = str_replace(CRM_Utils_Migrate_Export
::XML_VALUE_SEPARATOR
,
125 CRM_Core_DAO
::VALUE_SEPARATOR
,
128 $dao->$name = $value;
141 public function optionGroups(&$xml, &$idMap) {
142 foreach ($xml->OptionGroups
as $optionGroupsXML) {
143 foreach ($optionGroupsXML->OptionGroup
as $optionGroupXML) {
144 $optionGroup = new CRM_Core_DAO_OptionGroup();
145 $this->copyData($optionGroup, $optionGroupXML, TRUE, 'name');
146 $idMap['option_group'][$optionGroup->name
] = $optionGroup->id
;
155 public function optionValues(&$xml, &$idMap) {
156 foreach ($xml->OptionValues
as $optionValuesXML) {
157 foreach ($optionValuesXML->OptionValue
as $optionValueXML) {
158 $optionValue = new CRM_Core_DAO_OptionValue();
159 $optionValue->option_group_id
= $idMap['option_group'][(string ) $optionValueXML->option_group_name
];
160 if (empty($optionValue->option_group_id
)) {
161 //CRM-17410 check if option group already exist.
162 $optionValue->option_group_id
= CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', $optionValueXML->option_group_name
, 'id', 'name');
164 $this->copyData($optionValue, $optionValueXML, FALSE, 'label');
165 if (!isset($optionValue->value
)) {
167 SELECT MAX(ROUND(v.value)) + 1
168 FROM civicrm_option_value v
169 WHERE v.option_group_id = %1
171 $params = array(1 => array($optionValue->option_group_id
, 'Integer'));
172 $optionValue->value
= CRM_Core_DAO
::singleValueQuery($sql, $params);
174 $optionValue->save();
182 public function relationshipTypes(&$xml) {
184 foreach ($xml->RelationshipTypes
as $relationshipTypesXML) {
185 foreach ($relationshipTypesXML->RelationshipType
as $relationshipTypeXML) {
186 $relationshipType = new CRM_Contact_DAO_RelationshipType();
187 $this->copyData($relationshipType, $relationshipTypeXML, TRUE, 'name_a_b');
195 public function contributionTypes(&$xml) {
197 foreach ($xml->ContributionTypes
as $contributionTypesXML) {
198 foreach ($contributionTypesXML->ContributionType
as $contributionTypeXML) {
199 $contributionType = new CRM_Financial_DAO_FinancialType();
200 $this->copyData($contributionType, $contributionTypeXML, TRUE, 'name');
209 public function customGroups(&$xml, &$idMap) {
210 foreach ($xml->CustomGroups
as $customGroupsXML) {
211 foreach ($customGroupsXML->CustomGroup
as $customGroupXML) {
212 $customGroup = new CRM_Core_DAO_CustomGroup();
213 if (!$this->copyData($customGroup, $customGroupXML, TRUE, 'name')) {
214 $idMap['custom_group'][$customGroup->name
] = $customGroup->id
;
219 if (!isset($customGroup->table_name
) ||
220 empty($customGroup->table_name
)
223 $customGroup->table_name
= "civicrm_value_" . strtolower(CRM_Utils_String
::munge($customGroup->title
, '_', 32)) . "_{$customGroup->id}";
228 // fix extends stuff if it exists
229 if (isset($customGroupXML->extends_entity_column_value_option_group
) &&
230 isset($customGroupXML->extends_entity_column_value
)
233 $optionValues = explode(",", $customGroupXML->extends_entity_column_value
);
234 $optValues = implode("','", $optionValues);
235 if (trim($customGroup->extends) != 'Participant') {
236 if ($customGroup->extends == 'Relationship') {
237 foreach ($optionValues as $key => $value) {
238 $relTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contact_BAO_RelationshipType', $value, 'id', 'name_a_b');
239 $valueIDs[] = $relTypeId;
242 elseif (in_array($customGroup->extends, array('Individual', 'Organization', 'Household'))) {
243 $valueIDs = $optionValues;
245 elseif (in_array($customGroup->extends, array('Contribution', 'ContributionRecur'))) {
247 FROM civicrm_financial_type
248 WHERE name IN ('{$optValues}')";
249 $dao = &CRM_Core_DAO
::executeQuery($sql);
250 while ($dao->fetch()) {
251 $valueIDs[] = $dao->id
;
257 FROM civicrm_option_value v
258 INNER JOIN civicrm_option_group g ON g.id = v.option_group_id
260 AND v.name IN ('$optValues')
264 (string ) $customGroupXML->extends_entity_column_value_option_group
,
268 $dao = &CRM_Core_DAO
::executeQuery($sql, $params);
270 while ($dao->fetch()) {
271 $valueIDs[] = $dao->value
;
274 if (!empty($valueIDs)) {
275 $customGroup->extends_entity_column_value
= CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
277 ) . CRM_Core_DAO
::VALUE_SEPARATOR
;
281 // Note: No need to set extends_entity_column_id here.
287 // when custom group extends 'Participant'
290 FROM civicrm_option_value v
291 INNER JOIN civicrm_option_group g ON g.id = v.option_group_id
292 WHERE g.name = 'custom_data_type'
297 (string ) $customGroupXML->extends_entity_column_value_option_group
,
301 $valueID = (int ) CRM_Core_DAO
::singleValueQuery($sql, $params);
303 $customGroup->extends_entity_column_id
= $valueID;
306 $optionIDs = array();
310 $condition = "AND v.name IN ( '{$optValues}' )";
311 $optionIDs = CRM_Core_OptionGroup
::values('participant_role', FALSE, FALSE, FALSE, $condition, 'name');
315 // ParticipantEventName
316 $condition = "( is_template IS NULL OR is_template != 1 ) AND title IN( '{$optValues}' )";
317 $optionIDs = CRM_Event_PseudoConstant
::event(NULL, FALSE, $condition);
321 // ParticipantEventType
322 $condition = "AND v.name IN ( '{$optValues}' )";
323 $optionIDs = CRM_Core_OptionGroup
::values('event_type', FALSE, FALSE, FALSE, $condition, 'name');
327 if (is_array($optionIDs) && !empty($optionIDs)) {
328 $customGroup->extends_entity_column_value
= CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
329 array_keys($optionIDs)
330 ) . CRM_Core_DAO
::VALUE_SEPARATOR
;
338 $customGroup->save();
341 CRM_Core_BAO_CustomGroup
::createTable($customGroup);
342 $idMap['custom_group'][$customGroup->name
] = $customGroup->id
;
351 public function customFields(&$xml, &$idMap) {
352 // Re-index by group id so we can build out the custom fields one table
353 // at a time, and then rebuild the table triggers at the end, rather than
354 // rebuilding the table triggers after each field is added (which is
356 $fields_indexed_by_group_id = array();
357 foreach ($xml->CustomFields
as $customFieldsXML) {
358 $total = count($customFieldsXML->CustomField
);
359 foreach ($customFieldsXML->CustomField
as $customFieldXML) {
360 $id = $idMap['custom_group'][(string ) $customFieldXML->custom_group_name
];
361 $fields_indexed_by_group_id[$id][] = $customFieldXML;
364 foreach ($fields_indexed_by_group_id as $group_id => $fields) {
365 $total = count($fields);
367 foreach ($fields as $customFieldXML) {
369 $customField = new CRM_Core_DAO_CustomField();
370 $customField->custom_group_id
= $group_id;
372 if (!$this->copyData($customField, $customFieldXML, FALSE, 'label')) {
376 if (empty($customField->option_group_id
) &&
377 isset($customFieldXML->option_group_name
)
379 $customField->option_group_id
= $idMap['option_group'][(string ) $customFieldXML->option_group_name
];
384 $customField->save();
386 // Only rebuild the table's trigger on the last field added to avoid un-necessary
387 // and slow rebuilds when adding many fields at the same time.
388 $triggerRebuild = FALSE;
389 if ($count == $total) {
390 $triggerRebuild = TRUE;
393 CRM_Core_BAO_CustomField
::createField($customField, 'add', $indexExist, $triggerRebuild);
402 public function dbTemplateString(&$xml, &$idMap) {
403 foreach ($xml->Persistent
as $persistentXML) {
404 foreach ($persistentXML->Persistent
as $persistent) {
405 $persistentObj = new CRM_Core_DAO_Persistent();
407 if ($persistent->is_config
== 1) {
408 $persistent->data
= serialize(explode(',', $persistent->data
));
410 $this->copyData($persistentObj, $persistent, TRUE, 'context');
419 public function profileGroups(&$xml, &$idMap) {
420 foreach ($xml->ProfileGroups
as $profileGroupsXML) {
421 foreach ($profileGroupsXML->ProfileGroup
as $profileGroupXML) {
422 $profileGroup = new CRM_Core_DAO_UFGroup();
423 $this->copyData($profileGroup, $profileGroupXML, TRUE, 'title');
424 $idMap['profile_group'][$profileGroup->name
] = $profileGroup->id
;
425 $idMap['profile_group'][$profileGroup->title
] = $profileGroup->id
;
436 public function profileFields(&$xml, &$idMap) {
437 foreach ($xml->ProfileFields
as $profileFieldsXML) {
438 foreach ($profileFieldsXML->ProfileField
as $profileFieldXML) {
439 $profileField = new CRM_Core_DAO_UFField();
440 $profileField->uf_group_id
= $idMap['profile_group'][(string ) $profileFieldXML->profile_group_name
];
441 $this->copyData($profileField, $profileFieldXML, FALSE, 'field_name');
444 if (substr($profileField->field_name
, 0, 7) == 'custom.') {
445 list($dontCare, $tableName, $columnName) = explode('.', $profileField->field_name
);
448 FROM civicrm_custom_field f
449 INNER JOIN civicrm_custom_group g ON f.custom_group_id = g.id
450 WHERE g.table_name = %1
451 AND f.column_name = %2
454 1 => array($tableName, 'String'),
455 2 => array($columnName, 'String'),
457 $cfID = CRM_Core_DAO
::singleValueQuery($sql, $params);
459 CRM_Core_Error
::fatal(ts("Could not find custom field for %1, %2, %3",
461 1 => $profileField->field_name
,
467 $profileField->field_name
= "custom_{$cfID}";
469 $profileField->save();
478 public function profileJoins(&$xml, &$idMap) {
479 foreach ($xml->ProfileJoins
as $profileJoinsXML) {
480 foreach ($profileJoinsXML->ProfileJoin
as $profileJoinXML) {
481 $profileJoin = new CRM_Core_DAO_UFJoin();
482 $profileJoin->uf_group_id
= $idMap['profile_group'][(string ) $profileJoinXML->profile_group_name
];
483 $this->copyData($profileJoin, $profileJoinXML, FALSE, 'module');
484 $profileJoin->save();