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

Jump to bottom

GP-15420: Add task scheduling. #41

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

GP-15420: Add task scheduling. #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9584567
GP-15420: Add task scheduling.
Mar 11, 2021
450a39d
GP-15420 Adjust language
pfigel Jun 22, 2021
e7f9584
Merge branch 'master' into gp-15420
awg-github Jul 1, 2021
b743cb6
GP-15420: Task scheduling handles 'last execution date'. Fix error wi…
awg-github Jul 1, 2021
ece19df
GP-15420: Handle 'null' value in 'isTaskShouldRun' method.
awg-github Jul 1, 2021
54c4778
GP-15420: Remove fixes of dates in api. Remove unexpected symbol in '…
awg-github Jul 5, 2021
43378d8
GP-15420: Remove 'last_executed' field and make 2 separate field 'las…
awg-github Jul 5, 2021
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
139 changes: 97 additions & 42 deletions CRM/Sqltasks/Task.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,24 +23,23 @@
class CRM_Sqltasks_Task {

protected static $main_attributes = [
'name' => 'String',
'description' => 'String',
'category' => 'String',
'scheduled' => 'String',
'enabled' => 'Integer',
'weight' => 'Integer',
'last_execution' => 'Date',
'last_runtime' => 'Integer',
'parallel_exec' => 'Integer',
'run_permissions' => 'String',
'archive_date' => 'String',
// REMOVED - DO NOT USE
'main_sql' => 'String',
// REMOVED - DO NOT USE
'post_sql' => 'String',
'input_required' => 'Integer',
'abort_on_error' => 'Integer',
'last_modified' => 'Date'
'name' => 'String',
'description' => 'String',
'category' => 'String',
'scheduled' => 'String',
'enabled' => 'Integer',
'weight' => 'Integer',
'last_execution' => 'Date',
'last_runtime' => 'Integer',
'parallel_exec' => 'Integer',
'run_permissions' => 'String',
'archive_date' => 'String',
'main_sql' => 'String', // REMOVED - DO NOT USE
'post_sql' => 'String', // REMOVED - DO NOT USE
'input_required' => 'Integer',
'abort_on_error' => 'Integer',
'last_modified' => 'Date',
'schedule_start_date' => 'String',
];

protected $task_id;
Expand Down Expand Up @@ -506,14 +505,25 @@ public static function getAllTasks() {
* Get a list of tasks ready for execution
*/
public static function getExecutionTaskList() {
return self::getTasks('SELECT * FROM civicrm_sqltasks WHERE enabled=1 ORDER BY weight ASC, id ASC');
return self::getTasks('
SELECT * FROM civicrm_sqltasks
WHERE enabled = 1
AND (schedule_start_date < NOW() OR schedule_start_date IS NULL)
ORDER BY weight ASC, id ASC
');
}

/**
* Get a list of tasks ready for execution
*/
public static function getParallelExecutionTaskList() {
return self::getTasks('SELECT * FROM civicrm_sqltasks WHERE enabled=1 AND parallel_exec IN (1, 2) ORDER BY weight ASC, id ASC');
return self::getTasks('
SELECT * FROM civicrm_sqltasks
WHERE enabled = 1
AND parallel_exec IN (1, 2)
AND (schedule_start_date < NOW() OR schedule_start_date IS NULL)
ORDER BY weight ASC, id ASC
');
}

/**
Expand Down Expand Up @@ -617,6 +627,7 @@ public function exportConfiguration() {
unset($config['last_execution']);
unset($config['last_runtime']);
unset($config['archive_date']);
unset($config['schedule_start_date']);
$config['config'] = $this->config;
return json_encode($config, JSON_PRETTY_PRINT);
}
Expand Down Expand Up @@ -824,6 +835,22 @@ public function shouldRun() {
return $currentFormattedDate >= $currentScheduledDate && $lastFormattedDate < $currentScheduledDate;
}

/**
* Get available frequencies
*
* @return array
*/
public static function getAvailableFrequencies() {
return $frequencies = [
'always',
'hourly',
'daily',
'weekly',
'monthly',
'yearly',
];
}

/**
* Get the option for scheduling (simple version)
*/
Expand Down Expand Up @@ -876,6 +903,32 @@ public static function getNextExecutionTime() {
return 'TODO';
}

/**
* Calculates the next execution date
* Returns date object
* When the job will be executed, on the first cron call after this date
*
* @return DateTime
* @throws Exception
*/
public function getNextExecutionDate() {
$taskSchedule = CRM_Sqltasks_TaskSchedule::getScheduleForTask($this);

return $taskSchedule->getNextExecutionDate();
}

/**
* Calculates the next execution date
* Returns formatted date
* When the job will be executed, on the first cron call after this date
*
* @return string
* @throws Exception
*/
public function getNextExecutionDateFormatted() {
return CRM_Utils_Date::customFormat($this->getNextExecutionDate()->format('Y-m-d H:i:s'));
}

/**
* Get the list of all files that have been registered by the task
*
Expand All @@ -901,26 +954,28 @@ public static function getLastFile() {
*/
public function getPreparedTask() {
$data = [
'id' => $this->getID(),
'name' => $this->getAttribute('name'),
'description' => $this->getAttribute('description'),
'short_desc' => $this->prepareShortDescription($this->getAttribute('description')),
'category' => $this->getAttribute('category'),
'schedule_label' => $this->prepareSchedule($this->getAttribute('scheduled')),
'schedule' => $this->getAttribute('scheduled'),
'scheduled' => $this->getAttribute('scheduled'),
'run_permissions'=> $this->getAttribute('run_permissions'),
'last_executed' => $this->prepareDate($this->getAttribute('last_execution')),
'last_runtime' => $this->prepareRuntime($this->getAttribute('last_runtime')),
'last_modified' => $this->getAttribute("last_modified"),
'parallel_exec' => $this->getAttribute('parallel_exec'),
'input_required' => $this->getAttribute('input_required'),
'next_execution' => 'TODO',
'enabled' => (empty($this->getAttribute('enabled'))) ? 0 : 1,
'config' => $this->getConfiguration(),
'is_archived' => (int) $this->isArchived(),
'archive_date' => (empty($this->getAttribute('archive_date'))) ? '' : $this->getAttribute('archive_date'),
'abort_on_error' => $this->getAttribute('abort_on_error'),
'id' => $this->getID(),
'name' => $this->getAttribute('name'),
'description' => $this->getAttribute('description'),
'short_desc' => $this->prepareShortDescription($this->getAttribute('description')),
'category' => $this->getAttribute('category'),
'schedule_label' => $this->prepareSchedule($this->getAttribute('scheduled')),
'schedule' => $this->getAttribute('scheduled'),
'scheduled' => $this->getAttribute('scheduled'),
'run_permissions' => $this->getAttribute('run_permissions'),
'last_execution_formatted' => $this->prepareDate($this->getAttribute('last_execution')),
'last_execution' => (empty($this->getAttribute('last_execution'))) ? '' : $this->getAttribute('last_execution'),
'last_runtime' => $this->prepareRuntime($this->getAttribute('last_runtime')),
'last_modified' => $this->getAttribute("last_modified"),
'parallel_exec' => $this->getAttribute('parallel_exec'),
'input_required' => $this->getAttribute('input_required'),
'next_execution' => 'TODO',
'enabled' => (empty($this->getAttribute('enabled'))) ? 0 : 1,
'config' => $this->getConfiguration(),
'is_archived' => (int) $this->isArchived(),
'archive_date' => (empty($this->getAttribute('archive_date'))) ? '' : $this->getAttribute('archive_date'),
'abort_on_error' => $this->getAttribute('abort_on_error'),
'schedule_start_date' => $this->getAttribute('schedule_start_date'),
];

return $data;
Expand All @@ -941,7 +996,7 @@ protected function prepareShortDescription($description) {
}

/**
* Prepares a date
* Prepares a date to show in frontend
*
* @param $string
*
Expand All @@ -951,7 +1006,7 @@ protected function prepareDate($string) {
if (empty($string)) {
return E::ts('never');
} else {
return date('Y-m-d H:i:s', strtotime($string));
return date('Y-m-d H:i:s', strtotime($string));
}
}

Expand Down
Loading