class.ilMultipleImagesInputGUI.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */
 
require_once 'Services/Form/classes/class.ilIdentifiedMultiValuesInputGUI.php';
require_once 'Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php';
 
abstract class ilMultipleImagesInputGUI extends ilIdentifiedMultiValuesInputGUI
{
        const RENDERING_TEMPLATE = 'tpl.prop_multi_image_inp.html';
        
        const ITERATOR_SUBFIELD_NAME = 'iteratorfield';
        const STORED_IMAGE_SUBFIELD_NAME = 'storedimage';
        const IMAGE_UPLOAD_SUBFIELD_NAME = 'imageupload';
        
        const FILE_DATA_INDEX_DODGING_FILE = 'dodging_file';
        protected $editElementOccuranceEnabled = false;
        
        protected $editElementOrderEnabled = false;
        
        protected $suffixes = array();
        
        protected $imageRemovalCommand = 'removeImage';
        
        protected $imageUploadCommand = 'uploadImage';
        
        function __construct($a_title = "", $a_postvar = "")
        {
                parent::__construct($a_title, $a_postvar);
                
                $this->setSuffixes(array("jpg", "jpeg", "png", "gif"));
                $this->setSize('25');
                $this->validationRegexp = "";
 
                require_once 'Services/Form/classes/class.ilMultipleImagesAdditionalIndexLevelRemover.php';
                $manipulator = new ilMultipleImagesAdditionalIndexLevelRemover();
                $manipulator->setPostVar($this->getPostVar());
                $this->addFormValuesManipulator($manipulator);
 
                require_once 'Services/Form/classes/class.ilMultipleImagesFileSubmissionDataCompletion.php';
                $manipulator = new ilMultipleImagesFileSubmissionDataCompletion();
                $manipulator->setPostVar($this->getPostVar());
                $this->addFormValuesManipulator($manipulator);
                
                require_once 'Services/Form/classes/class.ilIdentifiedMultiFilesJsPositionIndexRemover.php';
                $manipulator = new ilIdentifiedMultiFilesJsPositionIndexRemover();
                $manipulator->setPostVar($this->getPostVar());
                $this->addFormValuesManipulator($manipulator);
                
                require_once 'Services/Form/classes/class.ilMultiFilesSubmitRecursiveSlashesStripper.php';
                $manipulator = new ilMultiFilesSubmitRecursiveSlashesStripper();
                $manipulator->setPostVar($this->getPostVar());
                $this->addFormValuesManipulator($manipulator);
        }
        
        function setSuffixes($a_suffixes)
        {
                $this->suffixes = $a_suffixes;
        }
        
        function getSuffixes()
        {
                return $this->suffixes;
        }
        
        public function getImageRemovalCommand()
        {
                return $this->imageRemovalCommand;
        }
        
        public function setImageRemovalCommand($imageRemovalCommand)
        {
                $this->imageRemovalCommand = $imageRemovalCommand;
        }
        
        public function getImageUploadCommand()
        {
                return $this->imageUploadCommand;
        }
        
        public function setImageUploadCommand($imageUploadCommand)
        {
                $this->imageUploadCommand = $imageUploadCommand;
        }
        
        public function isEditElementOccuranceEnabled()
        {
                return $this->editElementOccuranceEnabled;
        }
        
        public function setEditElementOccuranceEnabled($editElementOccuranceEnabled)
        {
                $this->editElementOccuranceEnabled = $editElementOccuranceEnabled;
        }
        
        public function isEditElementOrderEnabled()
        {
                return $this->editElementOrderEnabled;
        }
        
        public function setEditElementOrderEnabled($editElementOrderEnabled)
        {
                $this->editElementOrderEnabled = $editElementOrderEnabled;
        }
        
        abstract protected function isValidFilenameInput($filenameInput);
        
        function onCheckInput()
        {
                $lng = $GLOBALS['DIC'] ? $GLOBALS['DIC']['lng'] : $GLOBALS['lng'];
                $F = $_FILES[$this->getPostVar()];
                
                if( $this->getRequired() && !is_array($F['error']) )
                {
                        $this->setAlert($lng->txt("form_msg_file_no_upload"));
                        return false;
                }
                else foreach( $F['error'] as $index => $error )
                {
                        // error handling
                        if ($error > 0)
                        {
                                switch ($error)
                                {
                                        case UPLOAD_ERR_INI_SIZE:
                                                $this->setAlert($lng->txt("form_msg_file_size_exceeds"));
                                                return false;
                                                break;
                                        
                                        case UPLOAD_ERR_FORM_SIZE:
                                                $this->setAlert($lng->txt("form_msg_file_size_exceeds"));
                                                return false;
                                                break;
                                        
                                        case UPLOAD_ERR_PARTIAL:
                                                $this->setAlert($lng->txt("form_msg_file_partially_uploaded"));
                                                return false;
                                                break;
                                        
                                        case UPLOAD_ERR_NO_FILE:
                                                if( !$this->getRequired() )
                                                {
                                                        break;
                                                }
                                                elseif( strlen($F[self::FILE_DATA_INDEX_DODGING_FILE][$index]) )
                                                {
                                                        break;
                                                }
                                                $this->setAlert($lng->txt("form_msg_file_no_upload"));
                                                return false;
                                                break;
                                        
                                        case UPLOAD_ERR_NO_TMP_DIR:
                                                $this->setAlert($lng->txt("form_msg_file_missing_tmp_dir"));
                                                return false;
                                                break;
                                        
                                        case UPLOAD_ERR_CANT_WRITE:
                                                $this->setAlert($lng->txt("form_msg_file_cannot_write_to_disk"));
                                                return false;
                                                break;
                                        
                                        case UPLOAD_ERR_EXTENSION:
                                                $this->setAlert($lng->txt("form_msg_file_upload_stopped_ext"));
                                                return false;
                                                break;
                                }
                        }
                }
                
                if (is_array($F['tmp_name']))
                {
                        foreach ($F['tmp_name'] as $index => $tmpname)
                        {
                                $filename = $F['name'][$index];
                                $filename_arr = pathinfo($filename);
                                $suffix = $filename_arr["extension"];
                                $mimetype = $F['type'][$index];
                                $size_bytes = $F['size'][$index];
                                // check suffixes
                                if (strlen($tmpname) && is_array($this->getSuffixes()))
                                {
                                        if (!in_array(strtolower($suffix), $this->getSuffixes()))
                                        {
                                                $this->setAlert($lng->txt("form_msg_file_wrong_file_type"));
                                                return false;
                                        }
                                }
                        }
                }
                
                foreach ($F['tmp_name'] as $index => $tmpname)
                {
                        $filename = $F['name'][$index];
                        $filename_arr = pathinfo($filename);
                        $suffix = $filename_arr["extension"];
                        $mimetype = $F['type'][$index];
                        $size_bytes = $F['size'][$index];
                        // virus handling
                        if (strlen($tmpname))
                        {
                                $vir = ilUtil::virusHandling($tmpname, $filename);
                                if ($vir[0] == false)
                                {
                                        $this->setAlert($lng->txt("form_msg_file_virus_found")."<br />".$vir[1]);
                                        return false;
                                }
                        }
                }
                
                return $this->checkSubItemsInput();
        }
        
        public function render($a_mode = "")
        {
                global $lng;
                
                $tpl = $this->getTemplate();
                $i = 0;
                foreach ($this->getIdentifiedMultiValues() as $identifier => $value)
                {
                        if( $this->valueHasContentImageSource($value) )
                        {
                                $tpl->setCurrentBlock('image');
                                
                                $tpl->setVariable('STORED_IMAGE_SRC', $this->fetchContentImageSourceFromValue($value));
                                $tpl->setVariable('STORED_IMAGE_ALT', ilUtil::prepareFormOutput($this->fetchContentImageTitleFromValue($value)));
                                $tpl->setVariable('STORED_IMAGE_FILENAME', $this->fetchContentImageTitleFromValue($value));
                                $tpl->setVariable("STORED_IMAGE_POST_VAR", $this->getMultiValuePostVarSubFieldPosIndexed($identifier, self::STORED_IMAGE_SUBFIELD_NAME, $i));
                                
                                $tpl->setVariable("TXT_DELETE_EXISTING", $lng->txt("delete_existing_file"));
                                $tpl->setVariable("IMAGE_CMD_REMOVE", $this->buildMultiValueSubmitVar($identifier, $i, $this->getImageRemovalCommand()));
                                
                                $tpl->parseCurrentBlock();
                        }
                        
                        $tpl->setCurrentBlock('addimage');
                        
                        $tpl->setVariable("IMAGE_BROWSE", $lng->txt('select_file'));
                        $tpl->setVariable("IMAGE_ID", $this->getMultiValuePosIndexedSubFieldId($identifier, self::IMAGE_UPLOAD_SUBFIELD_NAME, $i));
                        $tpl->setVariable("TXT_IMAGE_SUBMIT", $lng->txt("upload"));
                        $tpl->setVariable("IMAGE_CMD_UPLOAD", $this->buildMultiValueSubmitVar($identifier, $i, $this->getImageUploadCommand()));
                        $tpl->setVariable("UPLOAD_IMAGE_POST_VAR", $this->getMultiValuePostVarSubFieldPosIndexed($identifier, self::IMAGE_UPLOAD_SUBFIELD_NAME, $i));
                        $tpl->setVariable("COUNT_POST_VAR", $this->getMultiValuePostVarSubFieldPosIndexed($identifier, self::ITERATOR_SUBFIELD_NAME, $i));
                        
                        $tpl->parseCurrentBlock();
                        
                        if( $this->isEditElementOrderEnabled() )
                        {
                                $tpl->setCurrentBlock("move");
                                $tpl->setVariable("ID_UP", $this->getMultiValuePosIndexedSubFieldId($identifier, 'up', $i));
                                $tpl->setVariable("ID_DOWN", $this->getMultiValuePosIndexedSubFieldId($identifier, 'down', $i));
                                $tpl->setVariable("CMD_UP", $this->buildMultiValueSubmitVar($identifier, $i, 'up'));
                                $tpl->setVariable("CMD_DOWN", $this->buildMultiValueSubmitVar($identifier, $i, 'down'));
                                $tpl->setVariable("UP_BUTTON", ilGlyphGUI::get(ilGlyphGUI::UP));
                                $tpl->setVariable("DOWN_BUTTON", ilGlyphGUI::get(ilGlyphGUI::DOWN));
                                $tpl->parseCurrentBlock();
                        }
                        
                        if( $this->isEditElementOccuranceEnabled() )
                        {
                                $tpl->setCurrentBlock("row");
                                $tpl->setVariable("ID_ADD", $this->getMultiValuePosIndexedSubFieldId($identifier, 'add', $i));
                                $tpl->setVariable("ID_REMOVE", $this->getMultiValuePosIndexedSubFieldId($identifier, 'remove', $i));
                                $tpl->setVariable("CMD_ADD", $this->buildMultiValueSubmitVar($identifier, $i, 'add'));
                                $tpl->setVariable("CMD_REMOVE", $this->buildMultiValueSubmitVar($identifier, $i, 'remove'));
                                $tpl->setVariable("ADD_BUTTON", ilGlyphGUI::get(ilGlyphGUI::ADD));
                                $tpl->setVariable("REMOVE_BUTTON", ilGlyphGUI::get(ilGlyphGUI::REMOVE));
                                $tpl->parseCurrentBlock();
                        }
                        
                        $i++;
                }
                
                if (is_array($this->getSuffixes()))
                {
                        $suff_str = $delim = "";
                        foreach($this->getSuffixes() as $suffix)
                        {
                                $suff_str.= $delim.".".$suffix;
                                $delim = ", ";
                        }
                        $tpl->setCurrentBlock('allowed_image_suffixes');
                        $tpl->setVariable("TXT_ALLOWED_SUFFIXES", $lng->txt("file_allowed_suffixes")." ".$suff_str);
                        $tpl->parseCurrentBlock();
                }
                /*
                $tpl->setCurrentBlock("image_heading");
                $tpl->setVariable("ANSWER_IMAGE", $lng->txt('answer_image'));
                $tpl->parseCurrentBlock();
                */
                
                $tpl->setVariable("TXT_MAX_SIZE", ilUtil::getFileSizeInfo());
                $tpl->setVariable("ELEMENT_ID", $this->getPostVar());
                $tpl->setVariable("TEXT_YES", $lng->txt('yes'));
                $tpl->setVariable("TEXT_NO", $lng->txt('no'));
                $tpl->setVariable("DELETE_IMAGE_HEADER", $lng->txt('delete_image_header'));
                $tpl->setVariable("DELETE_IMAGE_QUESTION", $lng->txt('delete_image_question'));
                $tpl->setVariable("ANSWER_TEXT", $lng->txt('answer_text'));
                $tpl->setVariable("COMMANDS_TEXT", $lng->txt('actions'));
                
                if (!$this->getDisabled())
                {
                        $tpl->setCurrentBlock('js_engine_initialisation');
                        $tpl->setVariable('UPLOAD_CMD', $this->getImageUploadCommand());
                        $tpl->setVariable('REMOVE_CMD', $this->getImageRemovalCommand());
                        $tpl->setVariable('ITERATOR', self::ITERATOR_SUBFIELD_NAME);
                        $tpl->setVariable('STORED_IMAGE_POSTVAR', self::STORED_IMAGE_SUBFIELD_NAME);
                        $tpl->setVariable('UPLOAD_IMAGE_POSTVAR', self::IMAGE_UPLOAD_SUBFIELD_NAME);
                        $tpl->parseCurrentBlock();
 
                        $globalTpl = $GLOBALS['DIC'] ? $GLOBALS['DIC']['tpl'] : $GLOBALS['tpl'];
                        $globalTpl->addJavascript("./Services/Form/js/ServiceFormWizardInput.js");
                        $globalTpl->addJavascript("./Services/Form/js/ServiceFormIdentifiedWizardInputExtend.js");
                        //$globalTpl->addJavascript("./Services/Form/js/ServiceFormIdentifiedImageWizardInputConcrete.js");
                }
                
                return $tpl->get();
        }
        
        protected function valueHasContentImageSource($value)
        {
                return isset($value['src']) && strlen($value['src']);
        }
        
        protected function fetchContentImageSourceFromValue($value)
        {
                if( $this->valueHasContentImageSource($value) )
                {
                        return $value['src'];
                }
                
                return null;
        }
        
        protected function valueHasContentImageTitle($value)
        {
                return isset($value['title']) && strlen($value['title']);
        }
        
        protected function fetchContentImageTitleFromValue($value)
        {
                if( $this->valueHasContentImageTitle($value) )
                {
                        return $value['title'];
                }
                
                return $this->fetchContentImageSourceFromValue($value);
        }
        
        protected function getTemplate()
        {
                return new ilTemplate(self::RENDERING_TEMPLATE, true, true, "Services/Form");
        }
}