Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.
 All Data Structures Functions Variables Pages
WorkflowMessageInQueueJob.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 workflow messages');
48  }
49 
53  public static function getType()
54  {
55  return 'WorkflowMessageInQueue';
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 (WorkflowMessageInQueue::getModelsToProcess($resolvedBatchSize) as $workflowMessageInQueue)
83  {
84  if ($processedModelsCount < $batchSize || $batchSize == null)
85  {
86  try
87  {
88  $model = $this->resolveModel($workflowMessageInQueue);
89  $this->resolveSavedWorkflowIsValid($workflowMessageInQueue);
90  $this->processWorkflowMessageInQueue($workflowMessageInQueue, $model);
91  }
92  catch (NotFoundException $e)
93  {
94  }
95  $workflowMessageInQueue->delete();
96  $processedModelsCount++;
97  }
98  else
99  {
100  Yii::app()->jobQueue->add('WorkflowMessageInQueue', 5);
101  break;
102  }
103  }
104  Yii::app()->user->userModel = $originalUser;
105  return true;
106  }
108  {
109  //skip running workflow, since no super administrators are available.
110  $this->errorMessage = Zurmo::t('WorkflowsModule', 'Could not process since no super administrators were found');
111  return false;
112  }
113  }
114 
119  protected function resolveModel(WorkflowMessageInQueue $workflowMessageInQueue)
120  {
121  $modelDerivationPathToItem = RuntimeUtil::getModelDerivationPathToItem($workflowMessageInQueue->modelClassName);
122  return $workflowMessageInQueue->modelItem->castDown(array($modelDerivationPathToItem));
123  }
124 
129  protected function resolveSavedWorkflowIsValid(WorkflowMessageInQueue $workflowMessageInQueue)
130  {
131  if ($workflowMessageInQueue->savedWorkflow->id < 0)
132  {
133  throw new NotFoundException();
134  }
135  }
136 
141  protected function processWorkflowMessageInQueue(WorkflowMessageInQueue $workflowMessageInQueue, RedBeanModel $model)
142  {
143  $workflow = SavedWorkflowToWorkflowAdapter::makeWorkflowBySavedWorkflow($workflowMessageInQueue->savedWorkflow);
144  if (!$workflow->getIsActive())
145  {
146  return;
147  }
148  $emailMessageForWorkflowForm = WorkflowEmailMessagesUtil::
149  makeEmailMessageForWorkflowFormByQueueModelAndWorkflow($workflowMessageInQueue, $workflow);
150  WorkflowEmailMessagesUtil::processOnWorkflowMessageInQueueJob($emailMessageForWorkflowForm, $model,
151  self::resolveTriggeredByUser($workflowMessageInQueue));
152  }
153 
158  protected static function resolveTriggeredByUser(WorkflowMessageInQueue $workflowMessageInQueue)
159  {
160  if ($workflowMessageInQueue->triggeredByUser->id < 0)
161  {
162  return Yii::app()->user->userModel;
163  }
164  return $workflowMessageInQueue->triggeredByUser;
165  }
166  }
167 ?>
static resolveTriggeredByUser(WorkflowMessageInQueue $workflowMessageInQueue)
resolveSavedWorkflowIsValid(WorkflowMessageInQueue $workflowMessageInQueue)
static makeWorkflowBySavedWorkflow(SavedWorkflow $savedWorkflow)
static getUserToRunAs($createIfMissing=true)
static getModelsToProcess($pageSize)
resolveModel(WorkflowMessageInQueue $workflowMessageInQueue)
static processOnWorkflowMessageInQueueJob(EmailMessageForWorkflowForm $emailMessageForWorkflowForm, RedBeanModel $model, User $triggeredByUser)
processWorkflowMessageInQueue(WorkflowMessageInQueue $workflowMessageInQueue, RedBeanModel $model)
static getModelDerivationPathToItem($modelClassName)
Definition: RuntimeUtil.php:79
castDown(array $derivedModelClassNames)
static makeEmailMessageForWorkflowFormByQueueModelAndWorkflow(WorkflowMessageInQueue $workflowMessageInQueue, Workflow $workflow)
Generated on Fri Jul 3 2020 07:10:36
Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.