class.ilWorkflowEngineDefinitionsGUI.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2016 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilWorkflowEngineDefinitionsGUI
{
        protected $parent_gui;

        public function __construct(ilObjWorkflowEngineGUI $parent_gui)
        {
                $this->parent_gui = $parent_gui;
        }

        public function handle($command)
        {
                switch(strtolower($command))
                {
                        case 'uploadform':
                                return $this->showUploadForm();
                                break;

                        case 'upload':
                                return $this->handleUploadSubmit();
                                break;

                        case 'applyfilter':
                                return $this->applyFilter();
                                break;

                        case 'resetfilter':
                                return $this->resetFilter();
                                break;

                        case 'start':
                                return $this->startProcess();
                                break;

                        case 'delete':
                                return $this->deleteDefinition();
                                break;

                        case 'startlistening':
                                return $this->startListening();
                                break;

                        case'stoplistening':
                                return $this->stopListening();
                                break;

                        case 'view':
                        default:
                                return $this->showDefinitionsTable();
                }
        }

        public function showDefinitionsTable()
        {
                $this->initToolbar();
                require_once './Services/WorkflowEngine/classes/administration/class.ilWorkflowEngineDefinitionsTableGUI.php';
                $table_gui = new ilWorkflowEngineDefinitionsTableGUI($this->parent_gui, 'definitions.view');
                $table_gui->setFilterCommand("definitions.applyfilter");
                $table_gui->setResetCommand("definitions.resetFilter");
                $table_gui->setDisableFilterHiding(false);

                return $table_gui->getHTML();
        }

        public function applyFilter()
        {
                require_once './Services/WorkflowEngine/classes/administration/class.ilWorkflowEngineDefinitionsTableGUI.php';
                $table_gui = new ilWorkflowEngineDefinitionsTableGUI($this->parent_gui, 'definitions.view');
                $table_gui->writeFilterToSession();
                $table_gui->resetOffset();

                return $this->showDefinitionsTable();
        }

        public function resetFilter()
        {
                require_once './Services/WorkflowEngine/classes/administration/class.ilWorkflowEngineDefinitionsTableGUI.php';
                $table_gui = new ilWorkflowEngineDefinitionsTableGUI($this->parent_gui, 'definitions.view');
                $table_gui->resetOffset();
                $table_gui->resetFilter();

                return $this->showDefinitionsTable();
        }

        public function showUploadForm()
        {
                require_once './Services/WorkflowEngine/classes/administration/class.ilUploadDefinitionForm.php';
                $form_definition = new ilUploadDefinitionForm();
                $form = $form_definition->getForm(
                                $this->parent_gui->ilCtrl->getLinkTarget($this->parent_gui,'definitions.upload')
                );

                return $form->getHTML();
        }

        public function handleUploadSubmit()
        {

                $this->processUploadFormCancellation();

                require_once './Services/WorkflowEngine/classes/administration/class.ilUploadDefinitionForm.php';
                $form_definition = new ilUploadDefinitionForm();
                $form = $form_definition->getForm(
                                $this->parent_gui->ilCtrl->getLinkTarget($this->parent_gui,'definitions.upload')
                );

                if(!$form->checkInput())
                {
                        $form->setValuesByPost();
                        return $form->getHTML();
                }

                $repo_dir_name = ilObjWorkflowEngine::getRepositoryDir() . '/';
                if(!is_dir($repo_dir_name))
                {
                        \ilUtil::makeDirParents($repo_dir_name);
                }

                $temp_dir_name =  ilObjWorkflowEngine::getTempDir();
                if(!is_dir($temp_dir_name))
                {
                        \ilUtil::makeDirParents($temp_dir_name);
                }

                $file_name = $_FILES['process_file']['name'];
                $temp_name = $_FILES['process_file']['tmp_name'];
                \ilUtil::moveUploadedFile(
                        $temp_name,
                        $file_name,
                        $temp_dir_name . $file_name
                );

                $repo_base_name = 'il'.substr($file_name,0,strpos($file_name,'.'));
                $wf_base_name = 'wfd.'.$repo_base_name.'_v';
                $version = 0;
                if ($handle = opendir($repo_dir_name))
                {
                        while (false !== ($file = readdir($handle)))
                        {
                                if(substr(strtolower($file), 0, strlen($wf_base_name)) == strtolower($wf_base_name)
                                        && substr($file, -4) == '.php')
                                {
                                        $number = substr($file, strlen($wf_base_name), -4);
                                        if($number > $version)
                                        {
                                                $version = $number;
                                        }
                                }
                        }
                        closedir($handle);
                }
                $version++;

                $repo_name = $repo_base_name.'_v'.$version.'.php';

                // Parse
                require_once './Services/WorkflowEngine/classes/parser/class.ilBPMN2Parser.php';
                $parser = new ilBPMN2Parser();
                $bpmn = file_get_contents($temp_dir_name.$file_name);
                $code = $parser->parseBPMN2XML($bpmn,$repo_name);

                file_put_contents($repo_dir_name.'wfd.'.$repo_name,$code);
                file_put_contents($repo_dir_name.'wfd.'.$repo_base_name.'_v'.$version.'.bpmn2', $bpmn);
                unlink($temp_dir_name.$file_name);

                ilUtil::sendSuccess($this->parent_gui->lng->txt('upload_parse_success'), true);
                ilUtil::redirect(
                                html_entity_decode($this->parent_gui->ilCtrl->getLinkTarget($this->parent_gui, 'definitions.view'))
                );
        }

        public function initToolbar()
        {
                require_once './Services/UIComponent/Button/classes/class.ilLinkButton.php';
                $upload_wizard_button = ilLinkButton::getInstance();
                $upload_wizard_button->setCaption($this->parent_gui->lng->txt('upload_process'), false);
                $upload_wizard_button->setUrl(
                                $this->parent_gui->ilCtrl->getLinkTarget($this->parent_gui, 'definitions.uploadform')
                );
                $this->parent_gui->ilToolbar->addButtonInstance($upload_wizard_button);
        }

        protected function processUploadFormCancellation()
        {
                if (isset($_POST['cmd']['cancel'])) {
                        ilUtil::sendInfo($this->parent_gui->lng->txt('action_aborted'), true);
                        ilUtil::redirect(
                                        html_entity_decode(
                                                        $this->parent_gui->ilCtrl->getLinkTarget($this->parent_gui, 'definitions.view')
                                        )
                        );
                }
        }

        public function startListening()
        {
                $identifier = basename($_GET['process_id']);

                require_once ilObjWorkflowEngine::getRepositoryDir() . $identifier . '.php';
                $class = substr($identifier,4);
                $workflow_instance = new $class;

                $workflow_instance->setWorkflowClass('wfd.'.$class.'.php');
                $workflow_instance->setWorkflowLocation(ilObjWorkflowEngine::getRepositoryDir());

                $show_armer_form = true;
                switch(true)
                {
                        case isset($_POST['process_id']):
                        case isset($_POST['se_type']):
                        case isset($_POST['se_content']):
                        case isset($_POST['se_subject_type']):
                        case isset($_POST['se_context_type']):
                                $show_armer_form = false;
                                break;
                        default:
                                $show_armer_form = true;
                }

                // Check for Event definitions
                require_once './Services/WorkflowEngine/classes/administration/class.ilWorkflowArmerGUI.php';
                $this->parent_gui->ilCtrl->saveParameter($this->parent_gui, 'process_id', $identifier);
                $action = $this->parent_gui->ilCtrl->getLinkTarget($this->parent_gui, 'definitions.start');
                $armer = new ilWorkflowArmerGUI($action, $identifier);

                $form = $armer->getForm($workflow_instance->getInputVars(), $workflow_instance->getStartEventInfo());

                if($show_armer_form)
                {
                        return $form->getHTML();
                }

                $event_data = array(
                        'type'                  => stripslashes($_POST['se_type']),
                        'content'               => stripslashes($_POST['se_content']),
                        'subject_type'  => stripslashes($_POST['se_subject_type']),
                        'subject_id'    => (int)$_POST['se_subject_id'],
                        'context_type'  => stripslashes($_POST['se_context_type']),
                        'context_id'    => (int)$_POST['se_context_id']
                );
                $process_id = stripslashes($_POST['process_id']);

                require_once './Services/WorkflowEngine/classes/utils/class.ilWorkflowDbHelper.php';
                $event_id = ilWorkflowDbHelper::writeStartEventData($event_data, $process_id);

                foreach($workflow_instance->getInputVars() as $input_var)
                {
                        ilWorkflowDbHelper::writeStaticInput($input_var['name'], stripslashes($_POST[$input_var['name']]), $event_id);
                }

                ilUtil::sendSuccess($this->parent_gui->lng->txt('started_listening'), true);
                ilUtil::redirect(
                        html_entity_decode(
                                $this->parent_gui->ilCtrl->getLinkTarget($this->parent_gui, 'definitions.view')
                        )
                );
        }

        public function stopListening()
        {
                $process_id = ilUtil::stripSlashes($_GET['process_id']);

                require_once './Services/WorkflowEngine/classes/utils/class.ilWorkflowDbHelper.php';
                ilWorkflowDbHelper::deleteStartEventData($process_id);

                ilUtil::sendSuccess($this->parent_gui->lng->txt('wfe_stopped_listening'), true);
                ilUtil::redirect(
                        html_entity_decode(
                                $this->parent_gui->ilCtrl->getLinkTarget($this->parent_gui, 'definitions.view')
                        )
                );
        }

        public function startProcess()
        {
                if(isset($_POST['cmd']['cancel']))
                {
                        ilUtil::sendInfo($this->parent_gui->lng->txt('action_aborted'), true);
                        ilUtil::redirect(
                                        html_entity_decode(
                                                        $this->parent_gui->ilCtrl->getLinkTarget($this->parent_gui, 'definitions.view')
                                        )
                        );
                }

                $identifier = basename($_GET['process_id']);

                require_once ilObjWorkflowEngine::getRepositoryDir() . $identifier . '.php';
                $class = substr($identifier,4);
                $workflow_instance = new $class;

                $workflow_instance->setWorkflowClass('wfd.'.$class.'.php');
                $workflow_instance->setWorkflowLocation(ilObjWorkflowEngine::getRepositoryDir());

                if(count($workflow_instance->getInputVars()))
                {
                        $show_launcher_form = false;
                        foreach($workflow_instance->getInputVars() as $input_var)
                        {
                                if(!isset($_POST[$input_var['name']]))
                                {
                                        $show_launcher_form = true;
                                } else {
                                        $workflow_instance->setInstanceVarById($input_var['name'], $_POST[$input_var['name']]);
                                }
                        }

                        require_once './Services/WorkflowEngine/classes/administration/class.ilWorkflowLauncherGUI.php';
                        $this->parent_gui->ilCtrl->saveParameter($this->parent_gui, 'process_id', $identifier);
                        $action = $this->parent_gui->ilCtrl->getLinkTarget($this->parent_gui, 'definitions.start');
                        $launcher = new ilWorkflowLauncherGUI($action, $identifier);
                        $form = $launcher->getForm($workflow_instance->getInputVars());

                        if($show_launcher_form || $form->checkInput() == false)
                        {
                                $form->setValuesByPost();
                                return $form->getHTML();
                        }
                }

                require_once './Services/WorkflowEngine/classes/utils/class.ilWorkflowDbHelper.php';
                ilWorkflowDbHelper::writeWorkflow( $workflow_instance );

                $workflow_instance->startWorkflow();
                $workflow_instance->handleEvent(
                                array(
                                                'time_passed',
                                                'time_passed',
                                                'none',
                                                0,
                                                'none',
                                                0
                                )
                );

                ilWorkflowDbHelper::writeWorkflow( $workflow_instance );

                ilUtil::sendSuccess($this->parent_gui->lng->txt('process_started'), true);
                ilUtil::redirect(
                                html_entity_decode(
                                                $this->parent_gui->ilCtrl->getLinkTarget($this->parent_gui, 'definitions.view')
                                )
                );
        }

        public function deleteDefinition()
        {
                unlink(ilObjWorkflowEngine::getRepositoryDir() . '/' . stripslashes($_GET['process_id']).'.php');
                unlink(ilObjWorkflowEngine::getRepositoryDir() . '/' . stripslashes($_GET['process_id']).'.bpmn2');

                ilUtil::sendSuccess($this->parent_gui->lng->txt('definition_deleted'), true);
                ilUtil::redirect(
                        html_entity_decode(
                                $this->parent_gui->ilCtrl->getLinkTarget($this->parent_gui, 'definitions.view')
                        )
                );
        }
}