All Data Structures Functions Variables Pages
ByTimeWorkflowInQueueJob.php
1 <?php
2  /*********************************************************************************
3  * Zurmo is a customer relationship management program developed by
4  * Zurmo, Inc. Copyright (C) 2017 Zurmo Inc.
5  *
6  * Zurmo is free software; you can redistribute it and/or modify it under
7  * the terms of the GNU Affero General Public License version 3 as published by the
8  * Free Software Foundation with the addition of the following permission added
9  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
10  * IN WHICH THE COPYRIGHT IS OWNED BY ZURMO, ZURMO DISCLAIMS THE WARRANTY
11  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
12  *
13  * Zurmo is distributed in the hope that it will be useful, but WITHOUT
14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15  * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
16  * details.
17  *
18  * You should have received a copy of the GNU Affero General Public License along with
19  * this program; if not, see http://www.gnu.org/licenses or write to the Free
20  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21  * 02110-1301 USA.
22  *
23  * You can contact Zurmo, Inc. with a mailing address at 27 North Wacker Drive
24  * Suite 370 Chicago, IL 60606. or at email address contact@zurmo.com.
25  *
26  * The interactive user interfaces in original and modified versions
27  * of this program must display Appropriate Legal Notices, as required under
28  * Section 5 of the GNU Affero General Public License version 3.
29  *
30  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
31  * these Appropriate Legal Notices must retain the display of the Zurmo
32  * logo and Zurmo copyright notice. If the display of the logo is not reasonably
33  * feasible for technical reasons, the Appropriate Legal Notices must display the words
34  * "Copyright Zurmo Inc. 2017. All rights reserved".
35  ********************************************************************************/
36 
41  {
45  public static function getDisplayName()
46  {
47  return Zurmo::t('WorkflowsModule', 'Process by-time workflow rules');
48  }
49 
53  public static function getType()
54  {
55  return 'ByTimeWorkflowInQueue';
56  }
57 
58  public static function getRecommendedRunFrequencyContent()
59  {
60  return Zurmo::t('JobsManagerModule', 'Every 15 minutes');
61  }
62 
66  public function run()
67  {
68  try
69  {
70  $originalUser = Yii::app()->user->userModel;
71  Yii::app()->user->userModel = BaseControlUserConfigUtil::getUserToRunAs();
72  $processedModelsCount = 0;
73  $batchSize = $this->resolveBatchSize();
74  if ($batchSize != null)
75  {
76  $resolvedBatchSize = $batchSize + 1;
77  }
78  else
79  {
80  $resolvedBatchSize = null;
81  }
82  foreach (ByTimeWorkflowInQueue::getModelsToProcess($resolvedBatchSize) as $byTimeWorkflowInQueue)
83  {
84  if ($processedModelsCount < $batchSize || $batchSize == null)
85  {
86  try
87  {
88  $model = $this->resolveModel($byTimeWorkflowInQueue);
89  $this->resolveSavedWorkflowIsValid($byTimeWorkflowInQueue);
90  $this->processByTimeWorkflowInQueue($byTimeWorkflowInQueue, $model);
91  }
92  catch (NotFoundException $e)
93  {
95  'application.modules.workflows.jobs.ByTimeWorkflowInQueueJob.run');
96  }
97  $byTimeWorkflowInQueue->delete();
98  $processedModelsCount++;
99  }
100  else
101  {
102  Yii::app()->jobQueue->add('ByTimeWorkflowInQueue', 5);
103  break;
104  }
105  }
106  Yii::app()->user->userModel = $originalUser;
107  return true;
108  }
110  {
111  //skip running workflow, since no super administrators are available.
112  $this->errorMessage = Zurmo::t('WorkflowsModule', 'Could not process since no super administrators were found');
113  return false;
114  }
115  }
116 
121  protected function resolveModel(ByTimeWorkflowInQueue $byTimeWorkflowInQueue)
122  {
123  $modelDerivationPathToItem = RuntimeUtil::getModelDerivationPathToItem($byTimeWorkflowInQueue->modelClassName);
124  return $byTimeWorkflowInQueue->modelItem->castDown(array($modelDerivationPathToItem));
125  }
126 
131  protected function resolveSavedWorkflowIsValid(ByTimeWorkflowInQueue $byTimeWorkflowInQueue)
132  {
133  if ($byTimeWorkflowInQueue->savedWorkflow->id < 0)
134  {
135  throw new NotFoundException();
136  }
137  }
138 
144  protected function processByTimeWorkflowInQueue(ByTimeWorkflowInQueue $byTimeWorkflowInQueue, RedBeanModel $model)
145  {
146  $workflow = SavedWorkflowToWorkflowAdapter::makeWorkflowBySavedWorkflow($byTimeWorkflowInQueue->savedWorkflow);
147  if (!$workflow->getIsActive())
148  {
149  return;
150  }
151  $workflow->setTimeTriggerRequireChangeToProcessToFalse();
153  {
154  WorkflowActionsUtil::processOnByTimeWorkflowInQueueJob($workflow, $model, Yii::app()->user->userModel);
155  WorkflowEmailMessagesUtil::processAfterSave($workflow, $model, Yii::app()->user->userModel);
156  if ($model->isModified())
157  {
158  $saved = $model->save();
159  if (!$saved)
160  {
161  throw new FailedToSaveModelException();
162  }
163  }
164  }
165  }
166  }
167 ?>
static makeWorkflowBySavedWorkflow(SavedWorkflow $savedWorkflow)
static processAfterSave(Workflow $workflow, RedBeanModel $model, User $triggeredByUser)
static getUserToRunAs($createIfMissing=true)
resolveSavedWorkflowIsValid(ByTimeWorkflowInQueue $byTimeWorkflowInQueue)
static areTriggersTrueOnByTimeWorkflowQueueJob(Workflow $workflow, RedBeanModel $model)
resolveModel(ByTimeWorkflowInQueue $byTimeWorkflowInQueue)
processByTimeWorkflowInQueue(ByTimeWorkflowInQueue $byTimeWorkflowInQueue, RedBeanModel $model)
static getModelDerivationPathToItem($modelClassName)
Definition: RuntimeUtil.php:79
static getModelsToProcess($pageSize)
castDown(array $derivedModelClassNames)
static processOnByTimeWorkflowInQueueJob(Workflow $workflow, RedBeanModel $model, User $triggeredByUser)
save($runValidation=true, array $attributeNames=null)
static handleProcessingException(Exception $exception, $category)
Generated on Wed Feb 26 2020 07:10:42