source: sandbox/workflow/branches/993/inc/class.run_activity.inc.php @ 2533

Revision 2533, 33.6 KB checked in by pedroerp, 14 years ago (diff)

Ticket #993 - Merged 2377:2466 /sandbox/workflow/trunk/ em /sandbox/workflow/branches/993
  • 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'] = Settings::get('expresso', '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']                        = EGW_BASE_URL;
322                        $GLOBALS['workflow']['wf_workflow_path']                        = WF_BASE_URL;
323                        $GLOBALS['workflow']['wf_resources_path']                       = WF_BASE_URL . SEP . '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']                         = EGW_BASE_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']                            = WF_BASE_URL . SEP . 'index.php?start_tab=1';
329                        $GLOBALS['workflow']['wf_js_path']                                      = WF_BASE_URL . 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'] = EGW_BASE_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
376                                Settings::set('expresso', 'user', 'account_id', $newUser);
377
378                                $GLOBALS['workflow']['wf_user_id'] = $newUser;
379                                $GLOBALS['user'] = $newUser;
380
381                                /* check some permissions */
382                                if (($newUser == '*') || (!$this->runtime->checkUserRun($newUser)) || (Factory::getInstance('WorkflowLDAP')->getName($newUser) === false))
383                                {
384                                        $_SESSION['phpgw_info']['workflow']['user_groups'] = $actualUserGroups;
385                                        $_SESSION['phpgw_info']['workflow']['account_id'] = $actualUser;
386
387                                        Settings::set('expresso', 'user', 'account_id', $actualUser);
388
389                                        $GLOBALS['workflow']['wf_user_id'] = $actualUser;
390                                        $GLOBALS['user'] = $actualUser;
391
392                                        return false;
393                                }
394                                $smarty = Factory::getInstance('process_smarty');
395                        }
396
397                        // run the activity
398                        //interactive section
399                        if (!$auto && $activity->isInteractive())
400                        {
401
402                                $this->print_mode = get_var('print_mode', array('POST','GET'), false);
403                                $this->download_mode = get_var('download_mode', array('POST','GET'), false);
404
405                                $smarty = Factory::getInstance('process_smarty');
406
407                                $smarty->template_dir  = GALAXIA_PROCESSES.SEP.$this->process->getNormalizedName().SEP.'code'.SEP.'templates';
408                                $smarty->compile_dir   = GALAXIA_PROCESSES.SEP.$this->process->getNormalizedName().SEP.'smarty'.SEP.'compiled';
409                                $smarty->config_dir    = GALAXIA_PROCESSES.SEP.$this->process->getNormalizedName().SEP.'code'.SEP.'templates';
410                                $smarty->cache_dir     = GALAXIA_PROCESSES.SEP.$this->process->getNormalizedName().SEP.'smarty'.SEP.'cache';
411                                $smarty->plugins_dir[] = PHPGW_SERVER_ROOT.SEP.'workflow'.SEP.'inc'.SEP.'smarty'.SEP.'wf_plugins';
412
413                                $GLOBALS['phpgw']->template =& $smarty;
414                                $this->wf_template =& $smarty;
415                                $_template_name = null;
416
417                                //set resource path to use in templates
418                                $smarty->assign('wf_resources_path',$GLOBALS['workflow']['wf_resources_path']);
419                                $smarty->assign('wf_default_resources_path', $GLOBALS['workflow']['wf_default_resources_path']);
420                                $smarty->assign('wf_workflow_resources_path', $GLOBALS['workflow']['wf_workflow_resources_path']);
421                                $smarty->assign('wf_workflow_path',$GLOBALS['workflow']['wf_workflow_path']);
422                                $smarty->assign('wf_js_path',$GLOBALS['workflow']['wf_js_path']);
423                                $smarty->assign('wf_back_link',$GLOBALS['workflow']['wf_back_link']);
424                                $smarty->assign('wf_activity_url',$GLOBALS['workflow']['wf_activity_url']);
425
426                                /* register the prefilter smarty plugin wf_default_template */
427                                $smarty->load_filter('pre', 'wf_default_template');
428                        }
429
430                        if ($this->conf['execute_activities_in_debug_mode'])
431                        {
432                                ini_set('display_errors',true);
433                                error_reporting(E_ALL & ~E_NOTICE);
434                        }
435
436                        /* BEGIN WORKFLOW MVC SETTINGS */
437                        $env = array( );                                           //create settings vector
438                        $env['view']          =& $smarty;                          //view layer instance
439                        $env['template_file'] =& $_template_name;                  //template file to be shown
440                        $env['dao']           =& wf_create_object('wf_db');        //data access object instance
441                        $env['workflow']      =& $GLOBALS['workflow'];             //workflow environment information
442                        $env['instance']      =& $instance;                        //process manager instance
443                        $env['activity']      =& $activity;                        //activity manager instance
444                        $security             =& Factory::newInstance('SecurityUtils');              //input sanitizer class
445                        $env['request']       =& $security->process($_REQUEST);    //sanitizes input data from client
446                        $env['factory']       =& Factory::getInstance('ProcessWrapperFactory');  //instantiation controller class
447                        $env['natural']           =& wf_create_object('wf_natural');   //data access object instance for mainframe
448                        /* END WORKFLOW MVC SETTINGS */
449
450                        $GLOBALS['workflow_env'] = &$env;
451
452                        /**
453                         * [__leave_activity] is setted if needed in the xxx_pre code or by the user in his code
454                         * HERE the user code is 'executed'. Note that we do not use include_once or require_once because
455                         * it could the same code several times with automatic activities looping in the graph and it still
456                         * need to be executed
457                         */
458                        $_engineProcessCodeDirectory = GALAXIA_PROCESSES . SEP . $this->process->getNormalizedName(). SEP . 'code';
459                        $_engineCompilerDirectory = GALAXIA_LIBRARY . SEP . 'compiler';
460                        $_engineFiles = array();
461
462                        /* generate the list of needed files */
463                        $_engineFiles[] = "{$_engineProcessCodeDirectory}/shared.php";
464                        $_engineFiles[] = "{$_engineCompilerDirectory}/_shared_pre.php";
465                        $_engineFiles[] = "{$_engineCompilerDirectory}/{$activity->getType()}_pre.php";
466                        if ($activity->getAgents() !== false)
467                                $_engineFiles[] = "{$_engineCompilerDirectory}/agents_pre.php";
468                        $_engineFiles[] = "{$_engineProcessCodeDirectory}/activities/{$activity->getNormalizedName()}.php";
469                        $_engineFiles[] = "{$_engineCompilerDirectory}/{$activity->getType()}_pos.php";
470                        if ($activity->getAgents() !== false)
471                                $_engineFiles[] = "{$_engineCompilerDirectory}/agents_pos.php";
472                        $_engineFiles[] = "{$_engineCompilerDirectory}/_shared_pos.php";
473
474                        /* check if the required files exists */
475                        foreach ($_engineFiles as $_engineFile)
476                                if (!file_exists($_engineFile))
477                                        return array('failure' => $this->runtime->fail(lang('the following file could not be found: %1', $_engineFile), true, _DEBUG));
478
479                        /* activate the security policy */
480                        Factory::getInstance('WorkflowSecurity')->enableSecurityPolicy();
481
482                        /**
483                         * Here we are going to use our new Security static class.
484                         * From now, the factory frontend (static) will forward
485                         * the messages for the process factory instead of Workflow
486                         * factory.
487                        */
488                        Security::enable();
489
490                        /* include the files */
491                        foreach ($_engineFiles as $_engineFile)
492                                require $_engineFile;
493
494                        unset($GLOBALS['workflow_env']);
495
496                        /* check if the developer wants to user the download mode */
497                        if (isset($GLOBALS['workflow']['downloadMode']) && ($GLOBALS['workflow']['downloadMode'] == true))
498                                $this->download_mode = true;
499
500                        if ($auto && (!$this->isChildInstance) && $activity->isInteractive() && (!empty($actualUser)))
501                        {
502                                $_SESSION['phpgw_info']['workflow']['user_groups'] = $actualUserGroups;
503                                $_SESSION['phpgw_info']['workflow']['account_id'] = $actualUser;
504                                Settings::set('expresso', 'user', 'account_id', $actualUser);
505                                $GLOBALS['workflow']['wf_user_id'] = $actualUser;
506                                $GLOBALS['user'] = $actualUser;
507                        }
508
509                        //Now that the instance is ready and that user code has maybe change some things
510                        // we can catch some others usefull vars
511                        $this->instance_id      = $instance->getInstanceId();
512                        $this->instance_name    = $instance->getName();
513                        $this->instance_owner   = $instance->getOwner();
514                        $this->owner_name       = $GLOBALS['phpgw']->accounts->id2name($this->instance_owner);
515                        if ($this->owner_name == '')
516                        {
517                                $this->owner_name = lang('Nobody');
518                        }
519                        $GLOBALS['workflow']['wf_instance_id']  =& $this->instance_id;
520                        $GLOBALS['workflow']['wf_instance_name']=& $this->instance_name;
521                        $GLOBALS['workflow']['wf_instance_owner']=& $this->instance_owner;
522                        $GLOBALS['workflow']['wf_owner_name']=& $this->owner_name;
523
524                        //was template changed?
525                        if ($_template_name)
526                        {
527                                $this->_template_name = $_template_name;
528                        }
529                        else
530                        {
531                                $this->_template_name = $this->activity->getNormalizedName().'.tpl';
532                        }
533
534                        // TODO: process instance comments
535
536                        $instructions = $this->runtime->handle_postUserCode(_DEBUG);
537                        switch($instructions['action'])
538                        {
539                                //interactive activity completed
540                                case 'completed':
541                                        // re-retrieve instance data which could have been modified by an automatic activity
542                                        $this->instance_id                = $instance->getInstanceId();
543                                        $this->instance_name              = $instance->getName();
544                                        $this->activityCompleteMessage    = $instance->getActivityCompleteMessage();
545
546                                        if (!$auto)
547                                        {
548                                                $this->assignCommonVariables();
549                                                // and display completed template
550                                                if (Settings::get('workflow', 'preferences', 'show_activity_complete_page') === '0')
551                                                        header('Location: workflow/index.php');
552                                                else
553                                                        $this->showCompletedPage();
554                                        }
555                                        break;
556                                //interactive activity still in interactive mode
557                                case 'loop':
558                                        if (!$auto)
559                                        {
560                                                $this->assignCommonVariables();
561                                                $this->showForm();
562                                        }
563                                        break;
564                                //nothing more
565                                case 'leaving':
566                                        if (!$auto)
567                                        {
568                                                $this->assignCommonVariables();
569                                                $this->showCancelledPage();
570                                        }
571                                        break;
572                                //non-interactive activities, auto-mode
573                                case 'return':
574                                        $result=Array();
575                                        $this->message[] = $this->GUI->get_error(false, _DEBUG);
576                                        $this->message[] = $this->runtime->get_error(false, _DEBUG);
577                                        //$this->message[] = $this->process->get_error(false, _DEBUG);
578                                        $result =& $instructions['engine_info'];
579                                        $this->message[] = $result['debug'];
580                                        $result['debug'] = implode('<br />',array_filter($this->message));
581                                        return $result;
582                                        break;
583                                default:
584                                        return $this->runtime->fail(lang('unknown instruction from the workflow engine: %1', $instructions['action']), true, _DEBUG);
585                                        break;
586                        }
587                }
588
589                /**
590                 * goajax
591                 *
592                 * @param int $activity_id
593                 * @param int $iid
594                 * @param bool $auto
595                 * @return array
596                 */
597                function goAjax($activity_id=0, $iid=0, $auto=0)
598                {
599                        $result=Array();
600
601                        if ($iid)
602                                $_REQUEST['iid'] = $iid;
603                        $iid = $_REQUEST['iid'];
604
605                        //$activity_id is set when we are in auto mode. In interactive mode we get if from POST or GET
606                        if (!$activity_id)
607                                $activity_id    = (int)get_var('activity_id', array('GET','POST'), 0);
608
609                        // load activity and instance
610                        if (!$activity_id)
611                        {
612                                $result['failure'] =  $this->runtime->fail(lang('Cannot run unknown activity'), true, _DEBUG, $auto);
613                                return $result;
614                        }
615
616                        //initalising activity and instance objects inside the WfRuntime object
617                        if (!($this->runtime->loadRuntime($activity_id,$iid)))
618                        {
619                                $result['failure'] = $this->runtime->fail(lang('Cannot run the activity'), true, _DEBUG, $auto);
620                                return $result;
621                        }
622
623                        $activity =& $this->runtime->getActivity($activity_id, true, true);
624                        $this->activity =& $activity;
625                        // the instance is avaible with $instance or $this->instance
626                        // note that for standalone activities this instance can be an empty instance object, but false is a bad value
627                        // HERE IS A BIG POINT: we map the instance to a runtime object
628                        // user code will manipulate a stance, thinking it's an instance, but it is
629                        // in fact a WfRuntime object, mapping all instance functions
630                        $this->instance =& $this->runtime;
631                        $instance =& $this->instance;
632                        $GLOBALS['workflow']['wf_runtime'] =& $this->runtime;
633                        if (!($instance))
634                        {
635                                $result['failure'] = $this->runtime->fail(lang('Cannot run the activity without instance'), true, _DEBUG, $auto);
636                                return $result;
637                        }
638                        $this->instance_id = $instance->getInstanceId();
639
640                        // load process
641                        $this->process =& $this->runtime->getProcess();
642                        if (!($this->process))
643                        {
644                                $result['failure'] = $this->runtime->fail(lang('Cannot run the activity without her process').$instance, true, _DEBUG, $auto);
645                                return $result;
646                        }
647
648                        //set some global variables needed
649                        $GLOBALS['user'] = Settings::get('expresso', 'user', 'account_id');
650
651                        //load role names, just an information
652                        $this->act_role_names = $activity->getActivityRoleNames();
653
654                        //set some other usefull vars
655                        $this->activity_type    = $activity->getType();
656                        $this->process_id       = $activity->getProcessId();
657                        $this->activity_id      = $activity_id;
658                        $this->process_name     = $this->process->getName();
659                        $this->process_version  = $this->process->getVersion();
660                        $this->activity_name    = $activity->getName();
661                        $this->user_name        = $GLOBALS['phpgw']->accounts->id2name($GLOBALS['user']);
662                        $this->view_activity    = $this->GUI->gui_get_process_view_activity($this->process_id);
663
664                        //we set them in $GLOBALS['workflow'] as well
665                        $GLOBALS['workflow']['wf_activity_type']                        =& $this->activity_type;
666                        $GLOBALS['workflow']['wf_process_id']                           =& $this->process_id;
667                        $GLOBALS['workflow']['wf_activity_id']                          =& $this->activity_id;
668                        $GLOBALS['workflow']['wf_process_name']                         =& $this->process_name;
669                        $GLOBALS['workflow']['wf_normalized_name']                      =  $this->process->getNormalizedName();
670                        $GLOBALS['workflow']['wf_process_version']                      =& $this->process_version;
671                        $GLOBALS['workflow']['wf_activity_name']                        =& $this->activity_name;
672                        $GLOBALS['workflow']['wf_user_name']                            =& $this->user_name;
673                        $GLOBALS['workflow']['wf_user_id']                                      =& $GLOBALS['user'];
674                        $GLOBALS['workflow']['wf_view_activity']                        =& $this->view_activity;
675                        $GLOBALS['workflow']['wf_workflow_path']                        = WF_BASE_URL;
676                        $GLOBALS['workflow']['wf_resources_path']                       = WF_BASE_URL . SEP . 'redirect.php?pid=' . $this->process_id . '&file=';
677                        $GLOBALS['workflow']['wf_default_resources_path']       = Factory::getInstance('TemplateServer')->generateLink('processes');
678                        $GLOBALS['workflow']['wf_workflow_resources_path']      = Factory::getInstance('TemplateServer')->generateLink('');
679                        $GLOBALS['workflow']['wf_activity_url']                         = EGW_BASE_URL . SEP . 'index.php?menuaction=workflow.'.get_class($this).'.go&activity_id='.$activity_id;
680                        $GLOBALS['workflow']['wf_user_cnname']                          = Factory::getInstance('WorkflowLDAP')->getName($GLOBALS['user']);
681                        $GLOBALS['workflow']['wf_back_link']                            = WF_BASE_URL . SEP . 'index.php?start_tab=1';
682                        $GLOBALS['workflow']['wf_js_path']                                      = WF_BASE_URL . SEP . 'js' . SEP . 'jscode';
683                        $GLOBALS['workflow']['wf_user_activities']                      = $this->GUI->gui_list_user_activities($GLOBALS['user'], '0', '-1', 'ga.wf_name__ASC', '', '', false, true, true, true, '');
684                        if ($iid)
685                                $GLOBALS['workflow']['wf_instance_url'] = EGW_BASE_URL . SEP . 'index.php?menuaction=workflow.'.get_class($this).'.go&activity_id='.$activity_id."&iid=".$iid;
686                        else
687                                unset($GLOBALS['workflow']['wf_instance_url']);
688
689                        /* activate local functions */
690                        require_once(PHPGW_SERVER_ROOT . SEP . 'workflow' . SEP . 'inc' . SEP . 'local' . SEP . 'functions' . SEP . 'local.functions.php');
691
692                        //get configuration options with default values if no init was done before
693                        $myconf = array(
694                                'execute_activities_in_debug_mode'      => 0,
695                                'execute_activities_using_secure_connection' => 0
696                        );
697                        //this will give use asked options and som others used by WfRuntime
698                        $this->conf =& $this->runtime->getConfigValues($myconf);
699
700                        // run the activity
701                        if ($this->conf['execute_activities_in_debug_mode'])
702                        {
703                                ini_set('display_errors',true);
704                                error_reporting(E_ALL & ~E_NOTICE);
705                        }
706
707                        /* BEGIN WORKFLOW MVC SETTINGS */
708                        $env = array( );                                           //create settings vector
709                        $env['dao']           =& wf_create_object('wf_db');        //data access object instance
710                        $env['workflow']      =& $GLOBALS['workflow'];             //workflow environment information
711                        $env['instance']      =& $instance;                        //process manager instance
712                        $env['activity']      =& $activity;                        //activity manager instance
713                        $security             =& Factory::newInstance('SecurityUtils'); //input sanitizer class
714                        $env['request']       =& $security->process($_REQUEST); //sanitizes input data from client
715                        $env['factory']       =& Factory::newInstance('ProcessWrapperFactory');  //instantiation controller class
716                        $env['natural']           =& wf_create_object('wf_natural');   //data access object instance for mainframe
717                        /* END WORKFLOW MVC SETTINGS */
718
719                        require_once(dirname(__FILE__) . SEP . 'nano' . SEP . 'JSON.php');
720                        require_once(dirname(__FILE__) . SEP . 'nano' . SEP . 'NanoUtil.class.php');
721                        require_once(dirname(__FILE__) . SEP . 'nano' . SEP . 'NanoJsonConverter.class.php');
722                        require_once(dirname(__FILE__) . SEP . 'nano' . SEP . 'NanoRequest.class.php');
723                        require_once(dirname(__FILE__) . SEP . 'nano' . SEP . 'NanoController.class.php');
724
725                        /* activate the security policy */
726                        Factory::getInstance('WorkflowSecurity')->enableSecurityPolicy();
727
728                        /**
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                         */
735                        Security::enable();
736
737                        $GLOBALS['workflow_env'] = &$env;
738                        $nc = &Factory::newInstance('NanoController');
739                        $nc->setClassPath(GALAXIA_PROCESSES . SEP . $this->process->getNormalizedName(). SEP . 'code');
740                        $nc->iterateOverVirtualRequests();
741                        $nc->outputResultData();
742                        unset($GLOBALS['workflow_env']);
743
744                        if (!is_null($iid))
745                                $instance->instance->sync();
746                }
747
748                /**
749                 * Create a child instance
750                 *
751                 * @param int $activityID
752                 * @param mixed $properties
753                 * @param string $user
754                 * @param bool $parentLock
755                 * @return int The instance ID of the just created instance
756                 * @access public
757                 */
758                function goChildInstance($activityID, $properties, $user, $parentLock)
759                {
760                        $this->isChildInstance = true;
761                        $this->runtime->instance->isChildInstance = true;
762                        $this->runtime->instance->activityID = $activityID;
763                        $this->runtime->instance->parentLock = $parentLock;
764                        $this->runtime->instance->setProperties($properties);
765                        if ($user != '*')
766                                $this->runtime->setNextUser($user);
767
768                        /* run the selected activity */
769                        ob_start();
770                        $this->go($activityID, 0, true);
771                        ob_end_clean();
772
773                        /* return the just created child instance */
774                        return $this->runtime->instance_id;
775                }
776
777                /**
778                 * Show the page avaible when completing an activity
779                 * @return void
780                 * @access public
781                 */
782                function showCompletedPage()
783                {
784                        $this->workflowSmarty->assign('activityEvent', 'completed');
785                        $this->showAfterRunningPage();
786                }
787
788                /**
789                 * Show the page avaible when leaving an activity
790                 * @return void
791                 * @access public
792                 */
793                function showCancelledPage()
794                {
795                        $this->workflowSmarty->assign('activityEvent', 'cancelled');
796                        $this->showAfterRunningPage();
797                }
798
799                /**
800                 * Common code of pages showed after activity pages
801                 * @return void
802                 * @access public
803                 */
804                function showAfterRunningPage()
805                {
806                        /* get the header/footer */
807                        $this->assignHeader();
808
809                        /* generate the activity list */
810                        $processActivities = array_filter($GLOBALS['workflow']['wf_user_activities']['data'], create_function('$a', 'return ($a["wf_p_id"] == ' . $GLOBALS['workflow']['wf_process_id'] . ');'));
811                        $activityList = array(0 => '-- Selecione uma atividade --');
812                        foreach ($processActivities as $processActivity)
813                                $activityList[$processActivity['wf_activity_id']] = $processActivity['wf_name'];
814
815                        /* assign some variables */
816                        $this->workflowSmarty->assign('processName', $this->process_name);
817                        $this->workflowSmarty->assign('processVersion', $this->process_version);
818                        $this->workflowSmarty->assign('activityName', $this->activity_name);
819                        $this->workflowSmarty->assign('activityCompleteMessage', $this->activityCompleteMessage);
820                        $this->workflowSmarty->assign('activityBaseURL', EGW_BASE_URL);
821                        $this->workflowSmarty->assign('activityList', $activityList);
822
823                        /* display the template */
824                        $this->workflowSmarty->display('after_running.tpl');
825                }
826
827                /**
828                 * Assign common information of interactive forms (e.g., error messages)
829                 * @return void
830                 * @access public
831                 */
832                function assignCommonVariables()
833                {
834                        $this->message[] = $this->GUI->get_error(false, _DEBUG);
835                        $this->message[] = $this->runtime->get_error(false, _DEBUG);
836                        $activityErrors = array_filter(array_merge(explode('<br />', $this->message[0]), explode('<br />', $this->message[1])));
837                        $this->workflowSmarty->assign('activityErrors', $activityErrors);
838                }
839
840                /**
841                 * Show the activity page (workflow template and activity template)
842                 * @return void
843                 * @access public
844                 */
845                function showForm()
846                {
847                        /* define the header */
848                        $this->assignHeader();
849
850                        /* define the variables */
851                        $activityOutput = $this->wf_template->fetch($this->_template_name);
852                        $actionURL = isset($GLOBALS['workflow']['wf_instance_url']) ? $GLOBALS['workflow']['wf_instance_url'] : $GLOBALS['workflow']['wf_activity_url'];
853                        $CSSLink = $this->get_css_link('run_activity', $this->print_mode);
854                        $CSSMedia = $this->print_mode ? 'print' : 'all';
855
856                        /* assign the variables to smarty */
857                        $this->workflowSmarty->assign('activityOutput', $activityOutput);
858                        $this->workflowSmarty->assign('actionURL', $actionURL);
859                        $this->workflowSmarty->assign('CSSLink', $CSSLink);
860                        $this->workflowSmarty->assign('CSSMedia', $CSSMedia);
861
862                        $this->workflowSmarty->display('run_activity.tpl');
863                        unset($smarty);
864                }
865
866                /**
867                 * Define if the header, footer and navigation bar will be shown
868                 * @return void
869                 * @access public
870                 */
871                function assignHeader()
872                {
873                        $headerConfig = 0;
874                        if (!$this->download_mode and !$this->print_mode)
875                        {
876                                $headerConfig |= workflow_smarty::SHOW_HEADER | workflow_smarty::SHOW_FOOTER;
877                                if ($this->runtime->activity->child_name != 'View')
878                                        $headerConfig |= workflow_smarty::SHOW_NAVIGATION_BAR;
879                        }
880
881                        $this->workflowSmarty->setHeader($headerConfig);
882                        $this->workflowSmarty->assign('header', $this->workflowSmarty->expressoHeader);
883                        $this->workflowSmarty->assign('footer', $this->workflowSmarty->expressoFooter);
884                }
885        }
886?>
Note: See TracBrowser for help on using the repository browser.