Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add routine for updating smartgroups, currently handling datepicker conversion #13395

Merged
merged 1 commit into from
Jan 10, 2019
Merged

Add routine for updating smartgroups, currently handling datepicker conversion #13395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CRM/Upgrade/Incremental/Base.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,20 @@ public static function updateMessageTemplates($ctx, $version) {

}

/**
* Do any relevant smart group updates.
*
* @param CRM_Queue_TaskContext $ctx
* @param string $version
*
* @return bool
*/
public function updateSmartGroups($ctx, $version) {
$groupUpdateObject = new CRM_Upgrade_Incremental_SmartGroups($version);
$groupUpdateObject->updateGroups();
return TRUE;
}

/**
* Drop a column from a table if it exist.
*
Expand Down
165 changes: 165 additions & 0 deletions CRM/Upgrade/Incremental/SmartGroups.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
<?php
/*
+--------------------------------------------------------------------+
| CiviCRM version 5 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2019 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| CiviCRM is free software; you can copy, modify, and distribute it |
| under the terms of the GNU Affero General Public License |
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
| |
| CiviCRM is distributed in the hope that it will be useful, but |
| WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
| See the GNU Affero General Public License for more details. |
| |
| You should have received a copy of the GNU Affero General Public |
| License and the CiviCRM Licensing Exception along |
| with this program; if not, contact CiviCRM LLC |
| at info[AT]civicrm[DOT]org. If you have questions about the |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/

/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2019
*
* Class to handled upgrading any saved searches with changed patterns.
*/
class CRM_Upgrade_Incremental_SmartGroups {

/**
* Version we are upgrading to.
*
* @var string
*/
protected $upgradeVersion;

/**
* @return string
*/
public function getUpgradeVersion() {
return $this->upgradeVersion;
}

/**
* @param string $upgradeVersion
*/
public function setUpgradeVersion($upgradeVersion) {
$this->upgradeVersion = $upgradeVersion;
}

/**
* CRM_Upgrade_Incremental_MessageTemplates constructor.
*
* @param string $upgradeVersion
*/
public function __construct($upgradeVersion) {
$this->setUpgradeVersion($upgradeVersion);
}

/**
* Get any conversions required for saved smart groups.
*
* @return array
*/
public function getSmartGroupConversions() {
return [
[
'version' => '5.11.alpha1',
'upgrade_descriptors' => [ts('Upgrade grant smart groups to datepicker format')],
'actions' => [
'function' => 'datepickerConversion',
'fields' => [
'grant_application_received_date',
'grant_decision_date',
'grant_money_transfer_date',
'grant_due_date'
]
]
]
];
}

/**
* Convert any
* @param array $fields
*/
public function datePickerConversion($fields) {
$fieldPossibilities = [];
foreach ($fields as $field) {
$fieldPossibilities[] = $field;
$fieldPossibilities[] = $field . '_high';
$fieldPossibilities[] = $field . '_low';
}

foreach ($fields as $field) {
$savedSearches = civicrm_api3('SavedSearch', 'get', [
'options' => ['limit' => 0],
'form_values' => ['LIKE' => "%{$field}%"],
])['values'];
foreach ($savedSearches as $savedSearch) {
$formValues = $savedSearch['form_values'];
foreach ($formValues as $index => $formValue) {
if (in_array($formValue[0], $fieldPossibilities)) {
$formValues[$index][2] = $this->getConvertedDateValue($formValue[2]);
}
}
if ($formValues !== $savedSearch['form_values']) {
civicrm_api3('SavedSearch', 'create', ['id' => $savedSearch['id'], 'form_values' => $formValues]);
}
}
}
}

/**
* Update message templates.
*/
public function updateGroups() {
$conversions = $this->getSmartGroupConversionsToApply();
foreach ($conversions as $conversion) {
$function = $conversion['function'];
$this->{$function}($conversion['fields']);
}
}

/**
* Get any required template updates.
*
* @return array
*/
public function getSmartGroupConversionsToApply() {
$conversions = $this->getSmartGroupConversions();
$return = [];
foreach ($conversions as $conversion) {
if ($conversion['version'] === $this->getUpgradeVersion()) {
$return[] = $conversion['actions'];
}
}
return $return;
}

/**
* Get converted date value.
*
* @param string $dateValue
*
* @return string
* $dateValue
*/
protected function getConvertedDateValue($dateValue) {
if (date('Y-m-d', strtotime($dateValue)) !== $dateValue
&& date('Y-m-d H:i:s', strtotime($dateValue)) !== $dateValue
) {
$dateValue = date('Y-m-d H:i:s', strtotime(CRM_Utils_Date::processDate($dateValue)));
}
return $dateValue;
}

}
25 changes: 9 additions & 16 deletions CRM/Upgrade/Incremental/php/FiveEleven.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,21 +67,14 @@ public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
* (change the x in the function name):
*/

// /**
// * Upgrade function.
// *
// * @param string $rev
// */
// public function upgrade_5_0_x($rev) {
// $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
// $this->addTask('Do the foo change', 'taskFoo', ...);
// // Additional tasks here...
// // Note: do not use ts() in the addTask description because it adds unnecessary strings to transifex.
// // The above is an exception because 'Upgrade DB to %1: SQL' is generic & reusable.
// }

// public static function taskFoo(CRM_Queue_TaskContext $ctx, ...) {
// return TRUE;
// }
/**
* Upgrade function.
*
* @param string $rev
*/
public function upgrade_5_11_alpha1($rev) {
$this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
$this->addTask('Update smart groups where jcalendar fields have been converted to datepicker', 'updateSmartGroups', $rev);
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is excellent work @eileenmcnaughton. I have one nitpick about the design. The way you've done it here, the addTask function passes a version number to updateSmartGroups which then relies on the data in getSmartGroupConversions to figure out what to do. That's a bit hard to grok and seems like it might cause trouble for future devs trying to figure out and extend what you've done. Since the addTask function can accept a variable number of arguments, I'd suggest passing in whatever's needed directly, e.g.

    $this->addTask('Update grant smart groups for datepicker', 'updateSmartGroups', $rev, [
      'function' => 'datepickerConversion',
      'fields' => [
        'grant_application_received_date',
        'grant_decision_date',
        'grant_money_transfer_date',
        'grant_due_date'
      ]
    ]);

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@colemanw yeah I guess so - I just thought it would create one array where we could kinda track what had been done when


}
19 changes: 19 additions & 0 deletions tests/phpunit/CRM/Upgrade/Incremental/BaseTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,23 @@ public function testMessageTemplateGetUpgradeMessages() {
], $messages);
}

/**
* Test converting a datepicker field.
*/
public function testSmartGroupDatePickerConversion() {
$this->callAPISuccess('SavedSearch', 'create', [
'form_values' => [
['grant_application_received_date_high', '=', '01/20/2019'],
['grant_due_date_low', '=', '01/22/2019'],
]
]);
$smartGroupConversionObject = new CRM_Upgrade_Incremental_SmartGroups('5.11.alpha1');
$smartGroupConversionObject->updateGroups();
$savedSearch = $this->callAPISuccessGetSingle('SavedSearch', []);
$this->assertEquals('grant_application_received_date_high', $savedSearch['form_values'][0][0]);
$this->assertEquals('2019-01-20 00:00:00', $savedSearch['form_values'][0][2]);
$this->assertEquals('grant_due_date_low', $savedSearch['form_values'][1][0]);
$this->assertEquals('2019-01-22 00:00:00', $savedSearch['form_values'][1][2]);
}

}