source: sandbox/workflow/branches/609/inc/class.run_activity.inc.php @ 2311

Revision 2311, 34.6 KB checked in by pedroerp, 14 years ago (diff)

Ticket #609 - Migrando instanciação das classes da engine para a factory.
  • 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                /* CELEPAR */
171                /**
172                 * @var object $smarty holds a Smarty instance
173                 * @access public
174                 */
175                var $smarty;               
176                /**
177                 * @var array $wf holds a global environment vector
178                 * @access public
179                 */
180                var $wf;                   
181                /**
182                 * @var $download_mode activates download mode
183                 * @access public
184                 */
185                var $download_mode;       
186                /**
187                 * @var string $_template_name holds the template's file name
188                 * @access public
189                 */
190                var $_template_name = null;
191                /**
192                 * @var bool Indicates wether the current instance is a child instance or not
193         * @access public
194         */
195                var $isChildInstance = false;
196
197                private $workflowSmarty = null;
198                /* CELEPAR */
199                /**
200                 * Constructor
201                 *
202                 * @access public
203                 */
204                function run_activity()
205                {
206                        parent::WorkflowUtils();
207                        $this->runtime          = Factory::getInstance('workflow_wfruntime');
208                        $this->runtime->setDebug(_DEBUG);
209                        //$this->base_activity  = Factory::getInstance('workflow_baseactivity');
210                        //$this->process                = Factory::getInstance('workflow_process');
211                        $this->GUI              = Factory::getInstance('workflow_gui');
212                        $this->categories       = Factory::getInstance('categories');
213
214                        $this->workflowSmarty = Factory::getInstance('workflow_smarty', false);
215                        // TODO: open a new connection to the database under a different username to allow privilege handling on tables
216                        /* CELEPAR */
217                        unset($this->db);
218                }
219
220                /**
221                  * This function is used to run all activities for specified instances. it could be interactive activities
222                  * or automatic activities. this second case is the reason why we return some values
223                  * @param int $activityId is the activity_id it run
224                  * @param int $iid is the instance id it run for
225                  * @param $auto is true by default
226                  * @return mixed AN ARRAY, or at least true or false. This array can contain :
227                  * a key 'failure' with an error string the engine will retrieve in instance error messages in case of
228                  *     failure (this will mark your execution as Bad),
229                  * a key 'debug' with a debug string the engine will retrieve in instance error messages,
230                  */
231                function go($activity_id=0, $iid=0, $auto=0)
232                {
233                        $result=Array();
234
235                        if ($iid)
236                        {
237                                $_REQUEST['iid'] = $iid;
238                        }
239                        $iid = $_REQUEST['iid'];
240
241                        //$activity_id is set when we are in auto mode. In interactive mode we get if from POST or GET
242                        if (!$activity_id)
243                        {
244                                $activity_id    = (int)get_var('activity_id', array('GET','POST'), 0);
245                        }
246
247                        // load activity and instance
248                        if (!$activity_id)
249                        {
250                                $result['failure'] =  $this->runtime->fail(lang('Cannot run unknown activity'), true, _DEBUG, $auto);
251                                return $result;
252                        }
253
254                        //initalising activity and instance objects inside the WfRuntime object
255                        if (!($this->runtime->loadRuntime($activity_id,$iid)))
256                        {
257                                $result['failure'] = $this->runtime->fail(lang('Cannot run the activity'), true, _DEBUG, $auto);
258                                return $result;
259                        }
260
261                        $activity =& $this->runtime->getActivity($activity_id, true, true);
262                        $this->activity =& $activity;
263                        // the instance is avaible with $instance or $this->instance
264                        // note that for standalone activities this instance can be an empty instance object, but false is a bad value
265                        //$this->instance =& $this->runtime->loadInstance($iid);
266
267                        // HERE IS A BIG POINT: we map the instance to a runtime object
268                        // user code will manipulate a stance, thinking it's an instance, but it is
269                        // in fact a WfRuntime object, mapping all instance functions
270                        $this->instance =& $this->runtime;
271                        $instance =& $this->instance;
272                        $GLOBALS['workflow']['wf_runtime'] =& $this->runtime;
273                        if (!($instance))
274                        {
275                                $result['failure'] = $this->runtime->fail(lang('Cannot run the activity without instance'), true, _DEBUG, $auto);
276                                return $result;
277                        }
278                        $this->instance_id = $instance->getInstanceId();
279
280                        // load process
281                        $this->process =& $this->runtime->getProcess();
282                        if (!($this->process))
283                        {
284                                $result['failure'] = $this->runtime->fail(lang('Cannot run the activity without her process').$instance, true, _DEBUG, $auto);
285                                return $result;
286                        }
287
288                        //set some global variables needed
289                        $GLOBALS['workflow']['__leave_activity']=false;
290                        $GLOBALS['user'] = $GLOBALS['phpgw_info']['user']['account_id'];
291
292                        //load role names, just an information
293                        $this->act_role_names = $activity->getActivityRoleNames();
294
295                        //set some other usefull vars
296                        $this->activity_type    = $activity->getType();
297                        $this->process_id       = $activity->getProcessId();
298                        $this->activity_id      = $activity_id;
299                        $this->process_name     = $this->process->getName();
300                        $this->process_version  = $this->process->getVersion();
301                        $this->activity_name    = $activity->getName();
302                        $this->user_name                = $GLOBALS['phpgw']->accounts->id2name($GLOBALS['user']);
303                        $this->view_activity    = $this->GUI->gui_get_process_view_activity($this->process_id);
304
305                        //we set them in $GLOBALS['workflow'] as well
306                        $GLOBALS['workflow']['wf_activity_type']                        =& $this->activity_type;
307                        $GLOBALS['workflow']['wf_process_id']                           =& $this->process_id;
308                        $GLOBALS['workflow']['wf_activity_id']                          =& $this->activity_id;
309                        $GLOBALS['workflow']['wf_process_name']                         =& $this->process_name;
310                        $GLOBALS['workflow']['wf_normalized_name']                      =  $this->process->getNormalizedName();
311                        $GLOBALS['workflow']['wf_process_version']                      =& $this->process_version;
312                        $GLOBALS['workflow']['wf_activity_name']                        =& $this->activity_name;
313                        $GLOBALS['workflow']['wf_user_name']                            =& $this->user_name;
314                        $GLOBALS['workflow']['wf_user_id']                                      =& $GLOBALS['user'];
315                        $GLOBALS['workflow']['wf_view_activity']                        =& $this->view_activity;
316                        $GLOBALS['workflow']['wf_webserver_url']                        = $GLOBALS['phpgw_info']['server']['webserver_url'];
317                        $GLOBALS['workflow']['wf_workflow_path']                        = $GLOBALS['phpgw_info']['server']['webserver_url'].SEP.'workflow';
318                        $GLOBALS['workflow']['wf_resources_path']                       = $GLOBALS['phpgw_info']['server']['webserver_url'] . SEP . 'workflow/redirect.php?pid=' . $this->process_id . '&file=';
319                        $GLOBALS['workflow']['wf_default_resources_path']       = Factory::getInstance('TemplateServer')->generateLink('processes');
320                        $GLOBALS['workflow']['wf_workflow_resources_path']      = Factory::getInstance('TemplateServer')->generateLink('');
321                        $GLOBALS['workflow']['wf_activity_url']                         = $GLOBALS['phpgw_info']['server']['webserver_url'].SEP.'index.php?menuaction=workflow.'.get_class($this).'.go&activity_id='.$activity_id;
322                        $GLOBALS['workflow']['wf_user_cnname']                          = Factory::getInstance('WorkflowLDAP')->getName($GLOBALS['user']);
323                        $GLOBALS['workflow']['wf_back_link']                            = $GLOBALS['phpgw_info']['server']['webserver_url'].SEP.'workflow'.SEP.'index.php?start_tab=1';
324                        $GLOBALS['workflow']['wf_js_path']                                      = $GLOBALS['phpgw_info']['server']['webserver_url'].SEP.'workflow'.SEP.'js'.SEP.'jscode';
325                        $GLOBALS['workflow']['wf_user_activities']                      = $this->GUI->gui_list_user_activities($GLOBALS['user'], '0', '-1', 'ga.wf_name__ASC', '', '', false, true, true, true, '');
326                        if ($iid)
327                                $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;
328                        else
329                                unset($GLOBALS['workflow']['wf_instance_url']);
330                        $wf =& $GLOBALS['workflow'];
331
332                        /* CELEPAR */
333                        /* path to the local functions developed by Celepar */
334                        $functions = PHPGW_SERVER_ROOT . SEP . 'workflow' . SEP . 'inc' . SEP . 'local' . SEP . 'functions' . SEP . 'local.functions.php';
335
336                        /* activate local functions */
337                        require_once($functions);
338                        /* CELEPAR */
339
340                        //get configuration options with default values if no init was done before
341                        $myconf = array(
342                                'execute_activities_in_debug_mode'      => 0,
343                                'execute_activities_using_secure_connection' => 0
344                        );
345                        //this will give use asked options and som others used by WfRuntime
346                        $this->conf =& $this->runtime->getConfigValues($myconf);
347                        if ($this->conf['execute_activities_using_secure_connection'])
348                        {
349                                if (($GLOBALS['phpgw_info']['server']['use_https'] > 0) && ($_SERVER['HTTPS'] != 'on') && (!isset($GLOBALS['workflow']['job']['processID'])))
350                                {
351                                        header("Location: https://{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}");
352                                        exit;
353                                }
354                        }
355
356                        if ($auto && (!$this->isChildInstance) && $activity->isInteractive())
357                        {
358                                $actualUser = $GLOBALS['user'];
359                                $actualUserGroups = $_SESSION['phpgw_info']['workflow']['user_groups'];
360                                foreach ($instance->instance->activities as $actTmp)
361                                {
362                                        if ($actTmp['wf_activity_id'] == $activity_id)
363                                        {
364                                                $newUser = $actTmp['wf_user'];
365                                                break;
366                                        }
367                                }
368
369                                /* pretend to be the user */
370                                $_SESSION['phpgw_info']['workflow']['user_groups'] = galaxia_retrieve_user_groups($newUser);
371                                $_SESSION['phpgw_info']['workflow']['account_id'] = $newUser;
372                                $GLOBALS['phpgw_info']['user']['account_id'] = $newUser;
373                                $GLOBALS['workflow']['wf_user_id'] = $newUser;
374                                $GLOBALS['user'] = $newUser;
375
376                                /* check some permissions */
377                                if (($newUser == '*') || (!$this->runtime->checkUserRun($newUser)) || (Factory::getInstance('WorkflowLDAP')->getName($newUser) === false))
378                                {
379                                        $_SESSION['phpgw_info']['workflow']['user_groups'] = $actualUserGroups;
380                                        $_SESSION['phpgw_info']['workflow']['account_id'] = $actualUser;
381                                        $GLOBALS['phpgw_info']['user']['account_id'] = $actualUser;
382                                        $GLOBALS['workflow']['wf_user_id'] = $actualUser;
383                                        $GLOBALS['user'] = $actualUser;
384
385                                        return false;
386                                }
387                                $smarty = Factory::getInstance('process_smarty');
388                        }
389
390                        // run the activity
391                        //interactive section
392                        if (!$auto && $activity->isInteractive())
393                        {
394
395                                $this->print_mode = get_var('print_mode', array('POST','GET'), false);
396                                $this->download_mode = get_var('download_mode', array('POST','GET'), false);
397
398                                /* #celepar# smarty code*/
399
400                                $smarty = Factory::getInstance('process_smarty');
401
402                                $smarty->template_dir  = GALAXIA_PROCESSES.SEP.$this->process->getNormalizedName().SEP.'code'.SEP.'templates';
403                                $smarty->compile_dir   = GALAXIA_PROCESSES.SEP.$this->process->getNormalizedName().SEP.'smarty'.SEP.'compiled';
404                                $smarty->config_dir    = GALAXIA_PROCESSES.SEP.$this->process->getNormalizedName().SEP.'code'.SEP.'templates';
405                                $smarty->cache_dir     = GALAXIA_PROCESSES.SEP.$this->process->getNormalizedName().SEP.'smarty'.SEP.'cache';
406                                $smarty->plugins_dir[] = PHPGW_SERVER_ROOT.SEP.'workflow'.SEP.'inc'.SEP.'smarty'.SEP.'wf_plugins';
407
408                                $GLOBALS['phpgw']->template =& $smarty;
409                                $this->wf_template =& $smarty;
410                                $_template_name = null;
411
412                                //set resource path to use in templates
413                                $smarty->assign('wf_resources_path',$GLOBALS['workflow']['wf_resources_path']);
414                                $smarty->assign('wf_default_resources_path', $GLOBALS['workflow']['wf_default_resources_path']);
415                                $smarty->assign('wf_workflow_resources_path', $GLOBALS['workflow']['wf_workflow_resources_path']);
416                                $smarty->assign('wf_workflow_path',$GLOBALS['workflow']['wf_workflow_path']);
417                                $smarty->assign('wf_js_path',$GLOBALS['workflow']['wf_js_path']);
418                                $smarty->assign('wf_back_link',$GLOBALS['workflow']['wf_back_link']);
419                                $smarty->assign('wf_activity_url',$GLOBALS['workflow']['wf_activity_url']);
420                               
421                                /* register the prefilter smarty plugin wf_default_template */
422                                $smarty->load_filter('pre', 'wf_default_template');
423                        }
424
425                        if ($this->conf['execute_activities_in_debug_mode'])
426                        {
427                                ini_set('display_errors',true);
428                                error_reporting(E_ALL & ~E_NOTICE);
429                        }
430
431                        /* BEGIN WORKFLOW MVC SETTINGS */
432                        $env = array( );                                           //create settings vector
433                        $env['view']          =& $smarty;                          //view layer instance
434                        $env['template_file'] =& $_template_name;                  //template file to be shown
435                        $env['dao']           =& wf_create_object('wf_db');        //data access object instance
436                        $env['workflow']      =& $GLOBALS['workflow'];             //workflow environment information
437                        $env['instance']      =& $instance;                        //process manager instance
438                        $env['activity']      =& $activity;                        //activity manager instance
439                        $security             =& Factory::newInstance('SecurityUtils');              //input sanitizer class
440                        $env['request']       =& $security->process($_REQUEST);    //sanitizes input data from client
441                        //$env['factory']       =& new ProcessFactory();             //instantiation controller class
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                        //echo "<br><br><br><br><br>Including $source <br>In request: <pre>";print_r($_REQUEST);echo "</pre>";
448                        //[__leave_activity] is setted if needed in the xxx_pre code or by the user in his code
449                        // HERE the user code is 'executed'. Note that we do not use include_once or require_once because
450                        //it could the same code several times with automatic activities looping in the graph and it still
451                        //need to be executed
452                        $_engineProcessCodeDirectory = GALAXIA_PROCESSES . SEP . $this->process->getNormalizedName(). SEP . 'code';
453                        $_engineCompilerDirectory = GALAXIA_LIBRARY . SEP . 'compiler';
454                        $_engineFiles = array();
455
456                        /* generate the list of needed files */
457                        $_engineFiles[] = "{$_engineProcessCodeDirectory}/shared.php";
458                        $_engineFiles[] = "{$_engineCompilerDirectory}/_shared_pre.php";
459                        $_engineFiles[] = "{$_engineCompilerDirectory}/{$activity->getType()}_pre.php";
460                        if ($activity->getAgents() !== false)
461                                $_engineFiles[] = "{$_engineCompilerDirectory}/agents_pre.php";
462                        $_engineFiles[] = "{$_engineProcessCodeDirectory}/activities/{$activity->getNormalizedName()}.php";
463                        $_engineFiles[] = "{$_engineCompilerDirectory}/{$activity->getType()}_pos.php";
464                        if ($activity->getAgents() !== false)
465                                $_engineFiles[] = "{$_engineCompilerDirectory}/agents_pos.php";
466                        $_engineFiles[] = "{$_engineCompilerDirectory}/_shared_pos.php";
467
468                        /* check if the required files exists */
469                        foreach ($_engineFiles as $_engineFile)
470                                if (!file_exists($_engineFile))
471                                        return array('failure' => $this->runtime->fail(lang('the following file could not be found: %1', $_engineFile), true, _DEBUG));
472
473                        /* activate the security policy */
474                        Factory::getInstance('WorkflowSecurity')->enableSecurityPolicy();
475
476                        /**
477                         * XXX
478                         * here we are going to use our new Security static class.
479                         * From now, the factory frontend (static) will forward
480                         * the messages for the process factory instead of Workflow
481                         * factory.
482                         * XXX
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                        /* CELEPAR */
686                        /* activate local functions */
687                        require_once(PHPGW_SERVER_ROOT . SEP . 'workflow' . SEP . 'inc' . SEP . 'local' . SEP . 'functions' . SEP . 'local.functions.php');
688                        /* CELEPAR */
689
690                        //get configuration options with default values if no init was done before
691                        $myconf = array(
692                                'execute_activities_in_debug_mode'      => 0,
693                                'execute_activities_using_secure_connection' => 0
694                        );
695                        //this will give use asked options and som others used by WfRuntime
696                        $this->conf =& $this->runtime->getConfigValues($myconf);
697
698                        // run the activity
699                        if ($this->conf['execute_activities_in_debug_mode'])
700                        {
701                                ini_set('display_errors',true);
702                                error_reporting(E_ALL & ~E_NOTICE);
703                        }
704
705                        /* BEGIN WORKFLOW MVC SETTINGS */
706                        $env = array( );                                           //create settings vector
707                        $env['dao']           =& wf_create_object('wf_db');        //data access object instance
708                        $env['workflow']      =& $GLOBALS['workflow'];             //workflow environment information
709                        $env['instance']      =& $instance;                        //process manager instance
710                        $env['activity']      =& $activity;                        //activity manager instance
711                        $security             =& Factory::newInstance('SecurityUtils'); //input sanitizer class
712                        $env['request']       =& $security->process($_REQUEST); //sanitizes input data from client
713                        //$env['factory']       =& new ProcessFactory();                           //instantiation controller class
714                        $env['factory']       =& Factory::newInstance('ProcessWrapperFactory');  //instantiation controller class
715                        $env['natural']           =& wf_create_object('wf_natural');   //data access object instance for mainframe
716                        /* END WORKFLOW MVC SETTINGS */
717
718                        require_once(dirname(__FILE__) . SEP . 'nano' . SEP . 'JSON.php');
719                        require_once(dirname(__FILE__) . SEP . 'nano' . SEP . 'NanoUtil.class.php');
720                        require_once(dirname(__FILE__) . SEP . 'nano' . SEP . 'NanoJsonConverter.class.php');
721                        require_once(dirname(__FILE__) . SEP . 'nano' . SEP . 'NanoRequest.class.php');
722                        require_once(dirname(__FILE__) . SEP . 'nano' . SEP . 'NanoController.class.php');
723
724                        /* activate the security policy */
725                        Factory::getInstance('WorkflowSecurity')->enableSecurityPolicy();
726
727                        /**
728                         * XXX
729                         * here we are going to use our new Security static class.
730                         * From now, the factory frontend (static) will forward
731                         * the messages for the process factory instead of Workflow
732                         * factory. Note that this is the same comment as the previous
733                         * function... boooring.. =}
734                         * XXX
735                        */
736                        Security::enable();
737
738                        $GLOBALS['workflow_env'] = &$env;
739                        $nc = &Factory::newInstance('NanoController');
740                        $nc->setClassPath(GALAXIA_PROCESSES . SEP . $this->process->getNormalizedName(). SEP . 'code');
741                        $nc->iterateOverVirtualRequests();
742                        $nc->outputResultData();
743                        unset($GLOBALS['workflow_env']);
744
745                        if (!is_null($iid))
746                                $instance->instance->sync();
747                }
748
749                /**
750                 * Create a child instance
751                 *
752                 * @param int $activityID
753                 * @param mixed $properties
754                 * @param string $user
755                 * @param bool $parentLock
756                 * @return int The instance ID of the just created instance
757                 * @access public
758                 */
759                function goChildInstance($activityID, $properties, $user, $parentLock)
760                {
761                        $this->isChildInstance = true;
762                        $this->runtime->instance->isChildInstance = true;
763                        $this->runtime->instance->activityID = $activityID;
764                        $this->runtime->instance->parentLock = $parentLock;
765                        $this->runtime->instance->setProperties($properties);
766                        if ($user != '*')
767                                $this->runtime->setNextUser($user);
768
769                        /* run the selected activity */
770                        ob_start();
771                        $this->go($activityID, 0, true);
772                        ob_end_clean();
773
774                        /* return the just created child instance */
775                        return $this->runtime->instance_id;
776                }
777
778                /**
779                 * Show the page avaible when completing an activity
780                 * @return void
781                 * @access public
782                 */
783                function showCompletedPage()
784                {
785                        $this->workflowSmarty->assign('activityEvent', 'completed');
786                        $this->showAfterRunningPage();
787                }
788
789                /**
790                 * Show the page avaible when leaving an activity
791                 * @return void
792                 * @access public
793                 */
794                function showCancelledPage()
795                {
796                        $this->workflowSmarty->assign('activityEvent', 'cancelled');
797                        $this->showAfterRunningPage();
798                }
799
800                /**
801                 * Common code of pages showed after activity pages
802                 * @return void
803                 * @access public
804                 */
805                function showAfterRunningPage()
806                {
807                        /* get the header/footer */
808                        $this->assignHeader();
809
810                        /* generate the activity list */
811                        $processActivities = array_filter($GLOBALS['workflow']['wf_user_activities']['data'], create_function('$a', 'return ($a["wf_p_id"] == ' . $GLOBALS['workflow']['wf_process_id'] . ');'));
812                        $activityList = array(0 => '-- Selecione uma atividade --');
813                        foreach ($processActivities as $processActivity)
814                                $activityList[$processActivity['wf_activity_id']] = $processActivity['wf_name'];
815
816                        /* assign some variables */
817                        $this->workflowSmarty->assign('processName', $this->process_name);
818                        $this->workflowSmarty->assign('processVersion', $this->process_version);
819                        $this->workflowSmarty->assign('activityName', $this->activity_name);
820                        $this->workflowSmarty->assign('activityCompleteMessage', $this->activityCompleteMessage);
821                        $this->workflowSmarty->assign('activityBaseURL', $GLOBALS['phpgw_info']['server']['webserver_url']);
822                        $this->workflowSmarty->assign('activityList', $activityList);
823
824                        /* display the template */
825                        $this->workflowSmarty->display('after_running.tpl');
826                }
827
828                /**
829                 * Assign common information of interactive forms (e.g., error messages)
830                 * @return void
831                 * @access public
832                 */
833                function assignCommonVariables()
834                {
835                        $this->message[] = $this->GUI->get_error(false, _DEBUG);
836                        $this->message[] = $this->runtime->get_error(false, _DEBUG);
837                        $activityErrors = array_filter(array_merge(explode('<br />', $this->message[0]), explode('<br />', $this->message[1])));
838                        $this->workflowSmarty->assign('activityErrors', $activityErrors);
839                }
840
841                /**
842                 * Show the activity page (workflow template and activity template)
843                 * @return void
844                 * @access public
845                 */
846                function showForm()
847                {
848                        /* define the header */
849                        $this->assignHeader();
850
851                        /* define the variables */
852                        $activityOutput = $this->wf_template->fetch($this->_template_name);
853                        $actionURL = isset($GLOBALS['workflow']['wf_instance_url']) ? $GLOBALS['workflow']['wf_instance_url'] : $GLOBALS['workflow']['wf_activity_url'];
854                        $CSSLink = $this->get_css_link('run_activity', $this->print_mode);
855                        $CSSMedia = $this->print_mode ? 'print' : 'all';
856
857                        /* assign the variables to smarty */
858                        $this->workflowSmarty->assign('activityOutput', $activityOutput);
859                        $this->workflowSmarty->assign('actionURL', $actionURL);
860                        $this->workflowSmarty->assign('CSSLink', $CSSLink);
861                        $this->workflowSmarty->assign('CSSMedia', $CSSMedia);
862
863                        $this->workflowSmarty->display('run_activity.tpl');
864                        unset($smarty);
865                }
866
867                /**
868                 * Define if the header, footer and navigation bar will be shown
869                 * @return void
870                 * @access public
871                 */
872                function assignHeader()
873                {
874                        $headerConfig = 0;
875                        if (!$this->download_mode and !$this->print_mode)
876                        {
877                                $headerConfig |= workflow_smarty::SHOW_HEADER | workflow_smarty::SHOW_FOOTER;
878                                if ($this->runtime->activity->child_name != 'View')
879                                        $headerConfig |= workflow_smarty::SHOW_NAVIGATION_BAR;
880                        }
881
882                        $this->workflowSmarty->setHeader($headerConfig);
883                        $this->workflowSmarty->assign('header', $this->workflowSmarty->expressoHeader);
884                        $this->workflowSmarty->assign('footer', $this->workflowSmarty->expressoFooter);
885                }
886        }
887?>
Note: See TracBrowser for help on using the repository browser.