source: sandbox/workflow/trunk/inc/class.run_activity.inc.php @ 2466

Revision 2466, 34.2 KB checked in by pedroerp, 14 years ago (diff)

Ticket #609 - Merged 2356:2442 /sandbox/workflow/branches/609 em /sandbox/workflow/trunk.
  • Property svn:executable set to *
Line 
1<?php
2        /**************************************************************************\
3        * eGroupWare                                                               *
4        * http://www.egroupware.org                                                *
5        * --------------------------------------------                             *
6        *  This program is free software; you can redistribute it and/or modify it *
7        *  under the terms of the GNU General Public License as published by the   *
8        *  Free Software Foundation; either version 2 of the License, or (at your  *
9        *  option) any later version.                                              *
10        \**************************************************************************/
11
12        require_once(dirname(__FILE__) . SEP . 'common.inc.php');                                /* including common deifinitions */
13        require_once(dirname(__FILE__) . SEP . 'class.WorkflowUtils.inc.php'  ); /* superclass source code       */
14        require_once(dirname(__FILE__) . SEP . 'class.basecontroller.inc.php' ); /* module controller            */
15        require_once(dirname(__FILE__) . SEP . 'class.basemodel.inc.php'      ); /* module logic                 */
16
17        /**
18         * @package Workflow
19         * @author Mauricio Luiz Viani - viani@celepar.pr.gov.br
20         * @author Sidnei Augusto Drovetto Jr. - drovetto@gmail.com
21         * @author Carlos Eduardo Nogueira Goncalves - cadu.br@gmail.com
22         * @license GPL
23         * @license http://www.gnu.org/copyleft/gpl.html GPL
24     */
25        class run_activity extends WorkflowUtils
26        {       
27                /**
28                 * @var array  $public_functions func
29                 * @access public
30                 */
31                var $public_functions = array(
32                        'go'    => true,
33                        'goAjax'  => true
34                );
35                /**
36                 * @var object $runtime Runtime Object from the workflow engine
37                 * @access public
38                 */
39                var $runtime;
40                // This is the object we'll be running to obtain the rigth activity
41                //var $base_activity;
42                //This is the right activity object
43                /**
44                 * @var object $activity Activity engine object.
45                 * @access public
46                 */
47                var $activity;
48                /**
49                 * @var object $process Process engine object. Used to retrieve at least paths and configuration values
50                 * @access public
51                 */
52                var $process;   
53                /**
54                 * @var object $GUI  GUI engine object. Act carefully with it.
55                 * @access public
56                 */
57                var $GUI;
58                /**
59                 * @var array $message a message array
60                 * @access public
61                 */
62                var $message = Array();
63                /**
64                 * @var object $categories categorie object for categories
65                 * @access public
66                 */
67                var $categories;
68                /**
69                 * @var array $conf
70                 * @access public
71                 */
72                var $conf = array();   
73                /**
74                 * @var $wf_template local activity template
75                 * @access public
76                 */
77                var $wf_template;
78                /**
79                 * @var object $instance
80                 * @access public
81                 */
82                var $instance;
83                /**
84                 * @var object $activity_type The type of activity
85                 * @access public
86                 */
87                var $activity_type;
88                // then we retain all usefull vars as members, to make them avaible in user's source code
89                // theses are data which can be set before the user code and which are not likely to change because of the user code
90                /**
91                 * @var int $process_id The process id
92                 * @access public
93                 */
94                var $process_id;
95                /**
96                 * @var int $activity_id The activity id
97                 * @access public
98                 */
99                var $activity_id;
100                /**
101                 * @var int $process_name The process name
102                 * @access public
103                 */
104                var $process_name;
105                /**
106                 * @var int $process_version The process_version
107                 * @access public
108                 */
109                var $process_version;
110                /**
111                 * @var int $activity_name The process id
112                 * @access public
113                 */
114                var $activity_name;
115                /**
116                 * @var int $user_name The user name
117                 * @access public
118                 */
119                var $user_name;
120                /**
121                 * @var int $view_activity activity id of the view activity avaible for this process
122                 * @access public
123                 */
124                var $view_activity;
125                // theses 4 vars aren't avaible for the user code, they're set only after this user code was executed           
126                /**
127                 * @var int $instance_id Instance id
128                 * @access public
129                 */
130                var $instance_id=0;
131                /**
132                 * @var string $instance_name Instance name
133                 * @access public
134                 */
135                var $instance_name='';
136                /**
137                 * @var int $instance_owner Instance owner id
138                 * @access public
139                 */
140                var $instance_owner=0;
141                /**
142                 * @var string $owner_name Owner name
143                 * @access public
144                 */
145                var $owner_name='';
146               
147                /**
148                 * @var bool $print_mode print mode
149                 * @access public
150                 */
151                var $print_mode = false;
152                /**
153                 * @var bool $enable_print_mode print mode
154                 * @access public
155                 */
156                var $enable_print_mode = false;
157               
158                /**
159                 * @var array $act_role_names of roles associated with the activity, usefull for lists of users associated with theses roles
160                 * @access public       
161                 */
162                var $act_role_names= Array();
163               
164                /**
165                 * @var array $agents Array of ui_agent objects
166                 * @access public
167                 */
168                var $agents = Array();
169
170                /**
171                 * @var object $smarty holds a Smarty instance
172                 * @access public
173                 */
174                var $smarty;               
175                /**
176                 * @var array $wf holds a global environment vector
177                 * @access public
178                 */
179                var $wf;                   
180                /**
181                 * @var $download_mode activates download mode
182                 * @access public
183                 */
184                var $download_mode;       
185                /**
186                 * @var string $_template_name holds the template's file name
187                 * @access public
188                 */
189                var $_template_name = null;
190                /**
191                 * @var bool Indicates wether the current instance is a child instance or not
192         * @access public
193         */
194                var $isChildInstance = false;
195                /**
196                 * @var object Stores a 'workflow_smarty' object
197         * @access private
198         */
199                private $workflowSmarty = null;
200
201                /**
202                 * Constructor
203                 *
204                 * @access public
205                 */
206                function run_activity()
207                {
208                        parent::WorkflowUtils();
209
210                        /**
211                         * We should always use newInstance to instantiate
212                         * 'workflow_wfruntime'
213                         */
214                        $this->runtime                  = &Factory::newInstance('workflow_wfruntime');
215                        $this->runtime->setDebug(_DEBUG);
216                        $this->GUI                              = &Factory::getInstance('workflow_gui');
217                        $this->categories               = &Factory::getInstance('categories');
218
219                        $this->workflowSmarty   = &Factory::getInstance('workflow_smarty', false);
220
221                        // TODO: open a new connection to the database under a different username to allow privilege handling on tables
222                        unset($this->db);
223                }
224
225                /**
226                  * This function is used to run all activities for specified instances. it could be interactive activities
227                  * or automatic activities. this second case is the reason why we return some values
228                  * @param int $activityId is the activity_id it run
229                  * @param int $iid is the instance id it run for
230                  * @param $auto is true by default
231                  * @return mixed AN ARRAY, or at least true or false. This array can contain :
232                  * a key 'failure' with an error string the engine will retrieve in instance error messages in case of
233                  *     failure (this will mark your execution as Bad),
234                  * a key 'debug' with a debug string the engine will retrieve in instance error messages,
235                  */
236                function go($activity_id=0, $iid=0, $auto=0)
237                {
238                        $result=Array();
239
240                        if ($iid)
241                        {
242                                $_REQUEST['iid'] = $iid;
243                        }
244                        $iid = $_REQUEST['iid'];
245
246                        //$activity_id is set when we are in auto mode. In interactive mode we get if from POST or GET
247                        if (!$activity_id)
248                        {
249                                $activity_id    = (int)get_var('activity_id', array('GET','POST'), 0);
250                        }
251
252                        // load activity and instance
253                        if (!$activity_id)
254                        {
255                                $result['failure'] =  $this->runtime->fail(lang('Cannot run unknown activity'), true, _DEBUG, $auto);
256                                return $result;
257                        }
258
259                        //initalising activity and instance objects inside the WfRuntime object
260                        if (!($this->runtime->loadRuntime($activity_id,$iid)))
261                        {
262                                $result['failure'] = $this->runtime->fail(lang('Cannot run the activity'), true, _DEBUG, $auto);
263                                return $result;
264                        }
265
266                        $activity =& $this->runtime->getActivity($activity_id, true, true);
267                        $this->activity =& $activity;
268                        // the instance is avaible with $instance or $this->instance
269                        // note that for standalone activities this instance can be an empty instance object, but false is a bad value
270                        //$this->instance =& $this->runtime->loadInstance($iid);
271
272                        // HERE IS A BIG POINT: we map the instance to a runtime object
273                        // user code will manipulate a stance, thinking it's an instance, but it is
274                        // in fact a WfRuntime object, mapping all instance functions
275                        $this->instance =& $this->runtime;
276                        $instance =& $this->instance;
277                        $GLOBALS['workflow']['wf_runtime'] =& $this->runtime;
278                        if (!($instance))
279                        {
280                                $result['failure'] = $this->runtime->fail(lang('Cannot run the activity without instance'), true, _DEBUG, $auto);
281                                return $result;
282                        }
283                        $this->instance_id = $instance->getInstanceId();
284
285                        // load process
286                        $this->process =& $this->runtime->getProcess();
287                        if (!($this->process))
288                        {
289                                $result['failure'] = $this->runtime->fail(lang('Cannot run the activity without her process').$instance, true, _DEBUG, $auto);
290                                return $result;
291                        }
292
293                        //set some global variables needed
294                        $GLOBALS['workflow']['__leave_activity']=false;
295                        $GLOBALS['user'] = $GLOBALS['phpgw_info']['user']['account_id'];
296
297                        //load role names, just an information
298                        $this->act_role_names = $activity->getActivityRoleNames();
299
300                        //set some other usefull vars
301                        $this->activity_type    = $activity->getType();
302                        $this->process_id       = $activity->getProcessId();
303                        $this->activity_id      = $activity_id;
304                        $this->process_name     = $this->process->getName();
305                        $this->process_version  = $this->process->getVersion();
306                        $this->activity_name    = $activity->getName();
307                        $this->user_name                = $GLOBALS['phpgw']->accounts->id2name($GLOBALS['user']);
308                        $this->view_activity    = $this->GUI->gui_get_process_view_activity($this->process_id);
309
310                        //we set them in $GLOBALS['workflow'] as well
311                        $GLOBALS['workflow']['wf_activity_type']                        =& $this->activity_type;
312                        $GLOBALS['workflow']['wf_process_id']                           =& $this->process_id;
313                        $GLOBALS['workflow']['wf_activity_id']                          =& $this->activity_id;
314                        $GLOBALS['workflow']['wf_process_name']                         =& $this->process_name;
315                        $GLOBALS['workflow']['wf_normalized_name']                      =  $this->process->getNormalizedName();
316                        $GLOBALS['workflow']['wf_process_version']                      =& $this->process_version;
317                        $GLOBALS['workflow']['wf_activity_name']                        =& $this->activity_name;
318                        $GLOBALS['workflow']['wf_user_name']                            =& $this->user_name;
319                        $GLOBALS['workflow']['wf_user_id']                                      =& $GLOBALS['user'];
320                        $GLOBALS['workflow']['wf_view_activity']                        =& $this->view_activity;
321                        $GLOBALS['workflow']['wf_webserver_url']                        = $GLOBALS['phpgw_info']['server']['webserver_url'];
322                        $GLOBALS['workflow']['wf_workflow_path']                        = $GLOBALS['phpgw_info']['server']['webserver_url'].SEP.'workflow';
323                        $GLOBALS['workflow']['wf_resources_path']                       = $GLOBALS['phpgw_info']['server']['webserver_url'] . SEP . 'workflow/redirect.php?pid=' . $this->process_id . '&file=';
324                        $GLOBALS['workflow']['wf_default_resources_path']       = Factory::getInstance('TemplateServer')->generateLink('processes');
325                        $GLOBALS['workflow']['wf_workflow_resources_path']      = Factory::getInstance('TemplateServer')->generateLink('');
326                        $GLOBALS['workflow']['wf_activity_url']                         = $GLOBALS['phpgw_info']['server']['webserver_url'].SEP.'index.php?menuaction=workflow.'.get_class($this).'.go&activity_id='.$activity_id;
327                        $GLOBALS['workflow']['wf_user_cnname']                          = Factory::getInstance('WorkflowLDAP')->getName($GLOBALS['user']);
328                        $GLOBALS['workflow']['wf_back_link']                            = $GLOBALS['phpgw_info']['server']['webserver_url'].SEP.'workflow'.SEP.'index.php?start_tab=1';
329                        $GLOBALS['workflow']['wf_js_path']                                      = $GLOBALS['phpgw_info']['server']['webserver_url'].SEP.'workflow'.SEP.'js'.SEP.'jscode';
330                        $GLOBALS['workflow']['wf_user_activities']                      = $this->GUI->gui_list_user_activities($GLOBALS['user'], '0', '-1', 'ga.wf_name__ASC', '', '', false, true, true, true, '');
331                        if ($iid)
332                                $GLOBALS['workflow']['wf_instance_url'] = $GLOBALS['phpgw_info']['server']['webserver_url'].SEP.'index.php?menuaction=workflow.'.get_class($this).'.go&activity_id='.$activity_id."&iid=".$iid;
333                        else
334                                unset($GLOBALS['workflow']['wf_instance_url']);
335                        $wf =& $GLOBALS['workflow'];
336
337                        /* path to the local functions developed by Celepar */
338                        $functions = PHPGW_SERVER_ROOT . SEP . 'workflow' . SEP . 'inc' . SEP . 'local' . SEP . 'functions' . SEP . 'local.functions.php';
339
340                        /* activate local functions */
341                        require_once($functions);
342
343                        //get configuration options with default values if no init was done before
344                        $myconf = array(
345                                'execute_activities_in_debug_mode'      => 0,
346                                'execute_activities_using_secure_connection' => 0
347                        );
348                        //this will give use asked options and som others used by WfRuntime
349                        $this->conf =& $this->runtime->getConfigValues($myconf);
350                        if ($this->conf['execute_activities_using_secure_connection'])
351                        {
352                                if (($GLOBALS['phpgw_info']['server']['use_https'] > 0) && ($_SERVER['HTTPS'] != 'on') && (!isset($GLOBALS['workflow']['job']['processID'])))
353                                {
354                                        header("Location: https://{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}");
355                                        exit;
356                                }
357                        }
358
359                        if ($auto && (!$this->isChildInstance) && $activity->isInteractive())
360                        {
361                                $actualUser = $GLOBALS['user'];
362                                $actualUserGroups = $_SESSION['phpgw_info']['workflow']['user_groups'];
363                                foreach ($instance->instance->activities as $actTmp)
364                                {
365                                        if ($actTmp['wf_activity_id'] == $activity_id)
366                                        {
367                                                $newUser = $actTmp['wf_user'];
368                                                break;
369                                        }
370                                }
371
372                                /* pretend to be the user */
373                                $_SESSION['phpgw_info']['workflow']['user_groups'] = galaxia_retrieve_user_groups($newUser);
374                                $_SESSION['phpgw_info']['workflow']['account_id'] = $newUser;
375                                $GLOBALS['phpgw_info']['user']['account_id'] = $newUser;
376                                $GLOBALS['workflow']['wf_user_id'] = $newUser;
377                                $GLOBALS['user'] = $newUser;
378
379                                /* check some permissions */
380                                if (($newUser == '*') || (!$this->runtime->checkUserRun($newUser)) || (Factory::getInstance('WorkflowLDAP')->getName($newUser) === false))
381                                {
382                                        $_SESSION['phpgw_info']['workflow']['user_groups'] = $actualUserGroups;
383                                        $_SESSION['phpgw_info']['workflow']['account_id'] = $actualUser;
384                                        $GLOBALS['phpgw_info']['user']['account_id'] = $actualUser;
385                                        $GLOBALS['workflow']['wf_user_id'] = $actualUser;
386                                        $GLOBALS['user'] = $actualUser;
387
388                                        return false;
389                                }
390                                $smarty = Factory::getInstance('process_smarty');
391                        }
392
393                        // run the activity
394                        //interactive section
395                        if (!$auto && $activity->isInteractive())
396                        {
397
398                                $this->print_mode = get_var('print_mode', array('POST','GET'), false);
399                                $this->download_mode = get_var('download_mode', array('POST','GET'), false);
400
401                                $smarty = Factory::getInstance('process_smarty');
402
403                                $smarty->template_dir  = GALAXIA_PROCESSES.SEP.$this->process->getNormalizedName().SEP.'code'.SEP.'templates';
404                                $smarty->compile_dir   = GALAXIA_PROCESSES.SEP.$this->process->getNormalizedName().SEP.'smarty'.SEP.'compiled';
405                                $smarty->config_dir    = GALAXIA_PROCESSES.SEP.$this->process->getNormalizedName().SEP.'code'.SEP.'templates';
406                                $smarty->cache_dir     = GALAXIA_PROCESSES.SEP.$this->process->getNormalizedName().SEP.'smarty'.SEP.'cache';
407                                $smarty->plugins_dir[] = PHPGW_SERVER_ROOT.SEP.'workflow'.SEP.'inc'.SEP.'smarty'.SEP.'wf_plugins';
408
409                                $GLOBALS['phpgw']->template =& $smarty;
410                                $this->wf_template =& $smarty;
411                                $_template_name = null;
412
413                                //set resource path to use in templates
414                                $smarty->assign('wf_resources_path',$GLOBALS['workflow']['wf_resources_path']);
415                                $smarty->assign('wf_default_resources_path', $GLOBALS['workflow']['wf_default_resources_path']);
416                                $smarty->assign('wf_workflow_resources_path', $GLOBALS['workflow']['wf_workflow_resources_path']);
417                                $smarty->assign('wf_workflow_path',$GLOBALS['workflow']['wf_workflow_path']);
418                                $smarty->assign('wf_js_path',$GLOBALS['workflow']['wf_js_path']);
419                                $smarty->assign('wf_back_link',$GLOBALS['workflow']['wf_back_link']);
420                                $smarty->assign('wf_activity_url',$GLOBALS['workflow']['wf_activity_url']);
421
422                                /* register the prefilter smarty plugin wf_default_template */
423                                $smarty->load_filter('pre', 'wf_default_template');
424                        }
425
426                        if ($this->conf['execute_activities_in_debug_mode'])
427                        {
428                                ini_set('display_errors',true);
429                                error_reporting(E_ALL & ~E_NOTICE);
430                        }
431
432                        /* BEGIN WORKFLOW MVC SETTINGS */
433                        $env = array( );                                           //create settings vector
434                        $env['view']          =& $smarty;                          //view layer instance
435                        $env['template_file'] =& $_template_name;                  //template file to be shown
436                        $env['dao']           =& wf_create_object('wf_db');        //data access object instance
437                        $env['workflow']      =& $GLOBALS['workflow'];             //workflow environment information
438                        $env['instance']      =& $instance;                        //process manager instance
439                        $env['activity']      =& $activity;                        //activity manager instance
440                        $security             =& Factory::newInstance('SecurityUtils');              //input sanitizer class
441                        $env['request']       =& $security->process($_REQUEST);    //sanitizes input data from client
442                        $env['factory']       =& Factory::getInstance('ProcessWrapperFactory');  //instantiation controller class
443                        $env['natural']           =& wf_create_object('wf_natural');   //data access object instance for mainframe
444                        /* END WORKFLOW MVC SETTINGS */
445
446                        $GLOBALS['workflow_env'] = &$env;
447
448                        /**
449                         * [__leave_activity] is setted if needed in the xxx_pre code or by the user in his code
450                         * HERE the user code is 'executed'. Note that we do not use include_once or require_once because
451                         * it could the same code several times with automatic activities looping in the graph and it still
452                         * need to be executed
453                         */
454                        $_engineProcessCodeDirectory = GALAXIA_PROCESSES . SEP . $this->process->getNormalizedName(). SEP . 'code';
455                        $_engineCompilerDirectory = GALAXIA_LIBRARY . SEP . 'compiler';
456                        $_engineFiles = array();
457
458                        /* generate the list of needed files */
459                        $_engineFiles[] = "{$_engineProcessCodeDirectory}/shared.php";
460                        $_engineFiles[] = "{$_engineCompilerDirectory}/_shared_pre.php";
461                        $_engineFiles[] = "{$_engineCompilerDirectory}/{$activity->getType()}_pre.php";
462                        if ($activity->getAgents() !== false)
463                                $_engineFiles[] = "{$_engineCompilerDirectory}/agents_pre.php";
464                        $_engineFiles[] = "{$_engineProcessCodeDirectory}/activities/{$activity->getNormalizedName()}.php";
465                        $_engineFiles[] = "{$_engineCompilerDirectory}/{$activity->getType()}_pos.php";
466                        if ($activity->getAgents() !== false)
467                                $_engineFiles[] = "{$_engineCompilerDirectory}/agents_pos.php";
468                        $_engineFiles[] = "{$_engineCompilerDirectory}/_shared_pos.php";
469
470                        /* check if the required files exists */
471                        foreach ($_engineFiles as $_engineFile)
472                                if (!file_exists($_engineFile))
473                                        return array('failure' => $this->runtime->fail(lang('the following file could not be found: %1', $_engineFile), true, _DEBUG));
474
475                        /* activate the security policy */
476                        Factory::getInstance('WorkflowSecurity')->enableSecurityPolicy();
477
478                        /**
479                         * Here we are going to use our new Security static class.
480                         * From now, the factory frontend (static) will forward
481                         * the messages for the process factory instead of Workflow
482                         * factory.
483                        */
484                        Security::enable();
485
486                        /* include the files */
487                        foreach ($_engineFiles as $_engineFile)
488                                require $_engineFile;
489
490                        unset($GLOBALS['workflow_env']);
491
492                        /* check if the developer wants to user the download mode */
493                        if (isset($GLOBALS['workflow']['downloadMode']) && ($GLOBALS['workflow']['downloadMode'] == true))
494                                $this->download_mode = true;
495
496                        if ($auto && (!$this->isChildInstance) && $activity->isInteractive() && (!empty($actualUser)))
497                        {
498                                $_SESSION['phpgw_info']['workflow']['user_groups'] = $actualUserGroups;
499                                $_SESSION['phpgw_info']['workflow']['account_id'] = $actualUser;
500                                $GLOBALS['phpgw_info']['user']['account_id'] = $actualUser;
501                                $GLOBALS['workflow']['wf_user_id'] = $actualUser;
502                                $GLOBALS['user'] = $actualUser;
503                        }
504
505                        //Now that the instance is ready and that user code has maybe change some things
506                        // we can catch some others usefull vars
507                        $this->instance_id      = $instance->getInstanceId();
508                        $this->instance_name    = $instance->getName();
509                        $this->instance_owner   = $instance->getOwner();
510                        $this->owner_name       = $GLOBALS['phpgw']->accounts->id2name($this->instance_owner);
511                        if ($this->owner_name == '')
512                        {
513                                $this->owner_name = lang('Nobody');
514                        }
515                        $GLOBALS['workflow']['wf_instance_id']  =& $this->instance_id;
516                        $GLOBALS['workflow']['wf_instance_name']=& $this->instance_name;
517                        $GLOBALS['workflow']['wf_instance_owner']=& $this->instance_owner;
518                        $GLOBALS['workflow']['wf_owner_name']=& $this->owner_name;
519
520                        //was template changed?
521                        if ($_template_name)
522                        {
523                                $this->_template_name = $_template_name;
524                        }
525                        else
526                        {
527                                $this->_template_name = $this->activity->getNormalizedName().'.tpl';
528                        }
529
530                        // TODO: process instance comments
531
532                        $instructions = $this->runtime->handle_postUserCode(_DEBUG);
533                        switch($instructions['action'])
534                        {
535                                //interactive activity completed
536                                case 'completed':
537                                        // re-retrieve instance data which could have been modified by an automatic activity
538                                        $this->instance_id                = $instance->getInstanceId();
539                                        $this->instance_name              = $instance->getName();
540                                        $this->activityCompleteMessage    = $instance->getActivityCompleteMessage();
541
542                                        if (!$auto)
543                                        {
544                                                $this->assignCommonVariables();
545                                                // and display completed template
546                                                if ($GLOBALS['phpgw_info']['user']['preferences']['workflow']['show_activity_complete_page'] === '0')
547                                                        header('Location: workflow/index.php');
548                                                else
549                                                        $this->showCompletedPage();
550                                        }
551                                        break;
552                                //interactive activity still in interactive mode
553                                case 'loop':
554                                        if (!$auto)
555                                        {
556                                                $this->assignCommonVariables();
557                                                $this->showForm();
558                                        }
559                                        break;
560                                //nothing more
561                                case 'leaving':
562                                        if (!$auto)
563                                        {
564                                                $this->assignCommonVariables();
565                                                $this->showCancelledPage();
566                                        }
567                                        break;
568                                //non-interactive activities, auto-mode
569                                case 'return':
570                                        $result=Array();
571                                        $this->message[] = $this->GUI->get_error(false, _DEBUG);
572                                        $this->message[] = $this->runtime->get_error(false, _DEBUG);
573                                        //$this->message[] = $this->process->get_error(false, _DEBUG);
574                                        $result =& $instructions['engine_info'];
575                                        $this->message[] = $result['debug'];
576                                        $result['debug'] = implode('<br />',array_filter($this->message));
577                                        return $result;
578                                        break;
579                                default:
580                                        return $this->runtime->fail(lang('unknown instruction from the workflow engine: %1', $instructions['action']), true, _DEBUG);
581                                        break;
582                        }
583                }
584
585                /**
586                 * goajax
587                 *
588                 * @param int $activity_id
589                 * @param int $iid
590                 * @param bool $auto
591                 * @return array
592                 */
593                function goAjax($activity_id=0, $iid=0, $auto=0)
594                {
595                        $result=Array();
596
597                        if ($iid)
598                                $_REQUEST['iid'] = $iid;
599                        $iid = $_REQUEST['iid'];
600
601                        //$activity_id is set when we are in auto mode. In interactive mode we get if from POST or GET
602                        if (!$activity_id)
603                                $activity_id    = (int)get_var('activity_id', array('GET','POST'), 0);
604
605                        // load activity and instance
606                        if (!$activity_id)
607                        {
608                                $result['failure'] =  $this->runtime->fail(lang('Cannot run unknown activity'), true, _DEBUG, $auto);
609                                return $result;
610                        }
611
612                        //initalising activity and instance objects inside the WfRuntime object
613                        if (!($this->runtime->loadRuntime($activity_id,$iid)))
614                        {
615                                $result['failure'] = $this->runtime->fail(lang('Cannot run the activity'), true, _DEBUG, $auto);
616                                return $result;
617                        }
618
619                        $activity =& $this->runtime->getActivity($activity_id, true, true);
620                        $this->activity =& $activity;
621                        // the instance is avaible with $instance or $this->instance
622                        // note that for standalone activities this instance can be an empty instance object, but false is a bad value
623                        // HERE IS A BIG POINT: we map the instance to a runtime object
624                        // user code will manipulate a stance, thinking it's an instance, but it is
625                        // in fact a WfRuntime object, mapping all instance functions
626                        $this->instance =& $this->runtime;
627                        $instance =& $this->instance;
628                        $GLOBALS['workflow']['wf_runtime'] =& $this->runtime;
629                        if (!($instance))
630                        {
631                                $result['failure'] = $this->runtime->fail(lang('Cannot run the activity without instance'), true, _DEBUG, $auto);
632                                return $result;
633                        }
634                        $this->instance_id = $instance->getInstanceId();
635
636                        // load process
637                        $this->process =& $this->runtime->getProcess();
638                        if (!($this->process))
639                        {
640                                $result['failure'] = $this->runtime->fail(lang('Cannot run the activity without her process').$instance, true, _DEBUG, $auto);
641                                return $result;
642                        }
643
644                        //set some global variables needed
645                        $GLOBALS['user'] = $GLOBALS['phpgw_info']['user']['account_id'];
646
647                        //load role names, just an information
648                        $this->act_role_names = $activity->getActivityRoleNames();
649
650                        //set some other usefull vars
651                        $this->activity_type    = $activity->getType();
652                        $this->process_id       = $activity->getProcessId();
653                        $this->activity_id      = $activity_id;
654                        $this->process_name     = $this->process->getName();
655                        $this->process_version  = $this->process->getVersion();
656                        $this->activity_name    = $activity->getName();
657                        $this->user_name        = $GLOBALS['phpgw']->accounts->id2name($GLOBALS['user']);
658                        $this->view_activity    = $this->GUI->gui_get_process_view_activity($this->process_id);
659
660                        //we set them in $GLOBALS['workflow'] as well
661                        $GLOBALS['workflow']['wf_activity_type']                        =& $this->activity_type;
662                        $GLOBALS['workflow']['wf_process_id']                           =& $this->process_id;
663                        $GLOBALS['workflow']['wf_activity_id']                          =& $this->activity_id;
664                        $GLOBALS['workflow']['wf_process_name']                         =& $this->process_name;
665                        $GLOBALS['workflow']['wf_normalized_name']                      =  $this->process->getNormalizedName();
666                        $GLOBALS['workflow']['wf_process_version']                      =& $this->process_version;
667                        $GLOBALS['workflow']['wf_activity_name']                        =& $this->activity_name;
668                        $GLOBALS['workflow']['wf_user_name']                            =& $this->user_name;
669                        $GLOBALS['workflow']['wf_user_id']                                      =& $GLOBALS['user'];
670                        $GLOBALS['workflow']['wf_view_activity']                        =& $this->view_activity;
671                        $GLOBALS['workflow']['wf_workflow_path']                        = $GLOBALS['phpgw_info']['server']['webserver_url'].SEP.'workflow';
672                        $GLOBALS['workflow']['wf_resources_path']                       = $GLOBALS['phpgw_info']['server']['webserver_url'] . SEP . 'workflow/redirect.php?pid=' . $this->process_id . '&file=';
673                        $GLOBALS['workflow']['wf_default_resources_path']       = Factory::getInstance('TemplateServer')->generateLink('processes');
674                        $GLOBALS['workflow']['wf_workflow_resources_path']      = Factory::getInstance('TemplateServer')->generateLink('');
675                        $GLOBALS['workflow']['wf_activity_url']                         = $GLOBALS['phpgw_info']['server']['webserver_url'].SEP.'index.php?menuaction=workflow.'.get_class($this).'.go&activity_id='.$activity_id;
676                        $GLOBALS['workflow']['wf_user_cnname']                          = Factory::getInstance('WorkflowLDAP')->getName($GLOBALS['user']);
677                        $GLOBALS['workflow']['wf_back_link']                            = $GLOBALS['phpgw_info']['server']['webserver_url'].SEP.'workflow'.SEP.'index.php?start_tab=1';
678                        $GLOBALS['workflow']['wf_js_path']                                      = $GLOBALS['phpgw_info']['server']['webserver_url'].SEP.'workflow'.SEP.'js'.SEP.'jscode';
679                        $GLOBALS['workflow']['wf_user_activities']                      = $this->GUI->gui_list_user_activities($GLOBALS['user'], '0', '-1', 'ga.wf_name__ASC', '', '', false, true, true, true, '');
680                        if ($iid)
681                                $GLOBALS['workflow']['wf_instance_url'] = $GLOBALS['phpgw_info']['server']['webserver_url'].SEP.'index.php?menuaction=workflow.'.get_class($this).'.go&activity_id='.$activity_id."&iid=".$iid;
682                        else
683                                unset($GLOBALS['workflow']['wf_instance_url']);
684
685                        /* activate local functions */
686                        require_once(PHPGW_SERVER_ROOT . SEP . 'workflow' . SEP . 'inc' . SEP . 'local' . SEP . 'functions' . SEP . 'local.functions.php');
687
688                        //get configuration options with default values if no init was done before
689                        $myconf = array(
690                                'execute_activities_in_debug_mode'      => 0,
691                                'execute_activities_using_secure_connection' => 0
692                        );
693                        //this will give use asked options and som others used by WfRuntime
694                        $this->conf =& $this->runtime->getConfigValues($myconf);
695
696                        // run the activity
697                        if ($this->conf['execute_activities_in_debug_mode'])
698                        {
699                                ini_set('display_errors',true);
700                                error_reporting(E_ALL & ~E_NOTICE);
701                        }
702
703                        /* BEGIN WORKFLOW MVC SETTINGS */
704                        $env = array( );                                           //create settings vector
705                        $env['dao']           =& wf_create_object('wf_db');        //data access object instance
706                        $env['workflow']      =& $GLOBALS['workflow'];             //workflow environment information
707                        $env['instance']      =& $instance;                        //process manager instance
708                        $env['activity']      =& $activity;                        //activity manager instance
709                        $security             =& Factory::newInstance('SecurityUtils'); //input sanitizer class
710                        $env['request']       =& $security->process($_REQUEST); //sanitizes input data from client
711                        $env['factory']       =& Factory::newInstance('ProcessWrapperFactory');  //instantiation controller class
712                        $env['natural']           =& wf_create_object('wf_natural');   //data access object instance for mainframe
713                        /* END WORKFLOW MVC SETTINGS */
714
715                        require_once(dirname(__FILE__) . SEP . 'nano' . SEP . 'JSON.php');
716                        require_once(dirname(__FILE__) . SEP . 'nano' . SEP . 'NanoUtil.class.php');
717                        require_once(dirname(__FILE__) . SEP . 'nano' . SEP . 'NanoJsonConverter.class.php');
718                        require_once(dirname(__FILE__) . SEP . 'nano' . SEP . 'NanoRequest.class.php');
719                        require_once(dirname(__FILE__) . SEP . 'nano' . SEP . 'NanoController.class.php');
720
721                        /* activate the security policy */
722                        Factory::getInstance('WorkflowSecurity')->enableSecurityPolicy();
723
724                        /**
725                         * here we are going to use our new Security static class.
726                         * From now, the factory frontend (static) will forward
727                         * the messages for the process factory instead of Workflow
728                         * factory. Note that this is the same comment as the previous
729                         * function... boooring.. =}
730                         */
731                        Security::enable();
732
733                        $GLOBALS['workflow_env'] = &$env;
734                        $nc = &Factory::newInstance('NanoController');
735                        $nc->setClassPath(GALAXIA_PROCESSES . SEP . $this->process->getNormalizedName(). SEP . 'code');
736                        $nc->iterateOverVirtualRequests();
737                        $nc->outputResultData();
738                        unset($GLOBALS['workflow_env']);
739
740                        if (!is_null($iid))
741                                $instance->instance->sync();
742                }
743
744                /**
745                 * Create a child instance
746                 *
747                 * @param int $activityID
748                 * @param mixed $properties
749                 * @param string $user
750                 * @param bool $parentLock
751                 * @return int The instance ID of the just created instance
752                 * @access public
753                 */
754                function goChildInstance($activityID, $properties, $user, $parentLock)
755                {
756                        $this->isChildInstance = true;
757                        $this->runtime->instance->isChildInstance = true;
758                        $this->runtime->instance->activityID = $activityID;
759                        $this->runtime->instance->parentLock = $parentLock;
760                        $this->runtime->instance->setProperties($properties);
761                        if ($user != '*')
762                                $this->runtime->setNextUser($user);
763
764                        /* run the selected activity */
765                        ob_start();
766                        $this->go($activityID, 0, true);
767                        ob_end_clean();
768
769                        /* return the just created child instance */
770                        return $this->runtime->instance_id;
771                }
772
773                /**
774                 * Show the page avaible when completing an activity
775                 * @return void
776                 * @access public
777                 */
778                function showCompletedPage()
779                {
780                        $this->workflowSmarty->assign('activityEvent', 'completed');
781                        $this->showAfterRunningPage();
782                }
783
784                /**
785                 * Show the page avaible when leaving an activity
786                 * @return void
787                 * @access public
788                 */
789                function showCancelledPage()
790                {
791                        $this->workflowSmarty->assign('activityEvent', 'cancelled');
792                        $this->showAfterRunningPage();
793                }
794
795                /**
796                 * Common code of pages showed after activity pages
797                 * @return void
798                 * @access public
799                 */
800                function showAfterRunningPage()
801                {
802                        /* get the header/footer */
803                        $this->assignHeader();
804
805                        /* generate the activity list */
806                        $processActivities = array_filter($GLOBALS['workflow']['wf_user_activities']['data'], create_function('$a', 'return ($a["wf_p_id"] == ' . $GLOBALS['workflow']['wf_process_id'] . ');'));
807                        $activityList = array(0 => '-- Selecione uma atividade --');
808                        foreach ($processActivities as $processActivity)
809                                $activityList[$processActivity['wf_activity_id']] = $processActivity['wf_name'];
810
811                        /* assign some variables */
812                        $this->workflowSmarty->assign('processName', $this->process_name);
813                        $this->workflowSmarty->assign('processVersion', $this->process_version);
814                        $this->workflowSmarty->assign('activityName', $this->activity_name);
815                        $this->workflowSmarty->assign('activityCompleteMessage', $this->activityCompleteMessage);
816                        $this->workflowSmarty->assign('activityBaseURL', $GLOBALS['phpgw_info']['server']['webserver_url']);
817                        $this->workflowSmarty->assign('activityList', $activityList);
818
819                        /* display the template */
820                        $this->workflowSmarty->display('after_running.tpl');
821                }
822
823                /**
824                 * Assign common information of interactive forms (e.g., error messages)
825                 * @return void
826                 * @access public
827                 */
828                function assignCommonVariables()
829                {
830                        $this->message[] = $this->GUI->get_error(false, _DEBUG);
831                        $this->message[] = $this->runtime->get_error(false, _DEBUG);
832                        $activityErrors = array_filter(array_merge(explode('<br />', $this->message[0]), explode('<br />', $this->message[1])));
833                        $this->workflowSmarty->assign('activityErrors', $activityErrors);
834                }
835
836                /**
837                 * Show the activity page (workflow template and activity template)
838                 * @return void
839                 * @access public
840                 */
841                function showForm()
842                {
843                        /* define the header */
844                        $this->assignHeader();
845
846                        /* define the variables */
847                        $activityOutput = $this->wf_template->fetch($this->_template_name);
848                        $actionURL = isset($GLOBALS['workflow']['wf_instance_url']) ? $GLOBALS['workflow']['wf_instance_url'] : $GLOBALS['workflow']['wf_activity_url'];
849                        $CSSLink = $this->get_css_link('run_activity', $this->print_mode);
850                        $CSSMedia = $this->print_mode ? 'print' : 'all';
851
852                        /* assign the variables to smarty */
853                        $this->workflowSmarty->assign('activityOutput', $activityOutput);
854                        $this->workflowSmarty->assign('actionURL', $actionURL);
855                        $this->workflowSmarty->assign('CSSLink', $CSSLink);
856                        $this->workflowSmarty->assign('CSSMedia', $CSSMedia);
857
858                        $this->workflowSmarty->display('run_activity.tpl');
859                        unset($smarty);
860                }
861
862                /**
863                 * Define if the header, footer and navigation bar will be shown
864                 * @return void
865                 * @access public
866                 */
867                function assignHeader()
868                {
869                        $headerConfig = 0;
870                        if (!$this->download_mode and !$this->print_mode)
871                        {
872                                $headerConfig |= workflow_smarty::SHOW_HEADER | workflow_smarty::SHOW_FOOTER;
873                                if ($this->runtime->activity->child_name != 'View')
874                                        $headerConfig |= workflow_smarty::SHOW_NAVIGATION_BAR;
875                        }
876
877                        $this->workflowSmarty->setHeader($headerConfig);
878                        $this->workflowSmarty->assign('header', $this->workflowSmarty->expressoHeader);
879                        $this->workflowSmarty->assign('footer', $this->workflowSmarty->expressoFooter);
880                }
881        }
882?>
Note: See TracBrowser for help on using the repository browser.