ModuleSettings.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Backend;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use TYPO3\CMS\Backend\Module\BaseScriptClass;
use TYPO3\CMS\Core\Utility\GeneralUtility;

class ModuleSettings
{
    public $type = 'perm';

    public $prefix = '';

    public $storeList = [];

    public $storedSettings = [];

    public $msg = '';

    public $formName = 'storeControl';

    public $writeDevLog = false;

    /********************************
     *
     * Init / setup
     *
     ********************************/

    public function __construct()
    {
        GeneralUtility::deprecationLog('Class ModuleSettings is deprecated since TYPO3 CMS 7 and will be removed with TYPO3 CMS 8');
    }

    public function init($prefix = '', $storeList = '')
    {
        $this->prefix = $prefix;
        $this->setStoreList($storeList);
        $this->type = 'perm';
        // Enable dev logging if set
        if (!empty($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_modSettings.php']['writeDevLog'])) {
            $this->writeDevLog = true;
        }
        if (TYPO3_DLOG) {
            $this->writeDevLog = true;
        }
    }

    public function setSessionType($type = 'ses')
    {
        $this->type = $type;
    }

    /********************************
     *
     * Store list - which values should be stored
     *
     ********************************/
    public function setStoreList($storeList)
    {
        $this->storeList = [];
        $this->addToStoreList($storeList);
    }

    public function addToStoreList($storeList)
    {
        $storeList = is_array($storeList) ? $storeList : GeneralUtility::trimExplode(',', $storeList, true);
        $this->storeList = array_merge($this->storeList, $storeList);
        if ($this->writeDevLog) {
            GeneralUtility::devLog('Store list:' . implode(',', $this->storeList), __CLASS__, 0);
        }
    }

    public function addToStoreListFromPrefix($prefix = '')
    {
        $prefix = $prefix ?: $this->prefix;
        $prefix = preg_quote($prefix, '/');
        foreach ($this->getModule()->MOD_SETTINGS as $key => $value) {
            if (preg_match('/^' . $prefix . '/', $key)) {
                $this->storeList[$key] = $key;
            }
        }
        unset($this->storeList[$this->prefix . '_storedSettings']);
        if ($this->writeDevLog) {
            GeneralUtility::devLog('Store list:' . implode(',', $this->storeList), __CLASS__, 0);
        }
    }

    /********************************
     *
     * Process storage array
     *
     ********************************/
    public function initStorage()
    {
        $storedSettings = unserialize($this->getModule()->MOD_SETTINGS[$this->prefix . '_storedSettings']);
        $this->storedSettings = $this->cleanupStorageArray($storedSettings);
    }

    public function cleanupStorageArray($storedSettings)
    {
        $storedSettings = is_array($storedSettings) ? $storedSettings : [];
        // Clean up the array
        foreach ($storedSettings as $id => $sdArr) {
            if (!is_array($sdArr)) {
                unset($storedSettings[$id]);
            } elseif (!is_array($sdArr['data'])) {
                unset($storedSettings[$id]);
            } elseif (!trim($sdArr['title'])) {
                $storedSettings[$id]['title'] = '[no title]';
            }
        }
        return $storedSettings;
    }

    public function compileEntry($data)
    {
        $storageData = [];
        foreach ($this->storeList as $MS_key) {
            $storageData[$MS_key] = $this->getModule()->MOD_SETTINGS[$MS_key];
        }
        $storageArr = [
            'title' => $data['title'],
            'desc' => (string)$data['desc'],
            'data' => $storageData,
            'user' => null,
            'tstamp' => $GLOBALS['EXEC_TIME']
        ];
        $storageArr = $this->processEntry($storageArr);
        return $storageArr;
    }

    public function getStoredData($storeIndex, $writeArray = [])
    {
        if ($this->storedSettings[$storeIndex]) {
            foreach ($this->storeList as $k) {
                $writeArray[$k] = $this->storedSettings[$storeIndex]['data'][$k];
            }
        }
        return $writeArray;
    }

    public function processStoreControl($mconfName = '')
    {
        $this->initStorage();
        $storeControl = GeneralUtility::_GP('storeControl');
        $storeIndex = $storeControl['STORE'];
        $msg = '';
        $saveSettings = false;
        $writeArray = [];
        if (is_array($storeControl)) {
            if ($this->writeDevLog) {
                GeneralUtility::devLog('Store command: ' . GeneralUtility::arrayToLogString($storeControl), __CLASS__, 0);
            }
            // Processing LOAD
            if ($storeControl['LOAD'] && $storeIndex) {
                $writeArray = $this->getStoredData($storeIndex, $writeArray);
                $saveSettings = true;
                $msg = '\'' . $this->storedSettings[$storeIndex]['title'] . '\' preset loaded!';
            } elseif ($storeControl['SAVE']) {
                if (trim($storeControl['title'])) {
                    // Get the data to store
                    $newEntry = $this->compileEntry($storeControl);
                    // Create an index for the storage array
                    if (!$storeIndex) {
                        $storeIndex = GeneralUtility::shortMD5($newEntry['title']);
                    }
                    // Add data to the storage array
                    $this->storedSettings[$storeIndex] = $newEntry;
                    $saveSettings = true;
                    $msg = '\'' . $newEntry['title'] . '\' preset saved!';
                } else {
                    $msg = 'Please enter a name for the preset!';
                }
            } elseif ($storeControl['REMOVE'] and $storeIndex) {
                // Removing entry
                $msg = '\'' . $this->storedSettings[$storeIndex]['title'] . '\' preset entry removed!';
                unset($this->storedSettings[$storeIndex]);
                $saveSettings = true;
            }
            $this->msg = $msg;
            if ($saveSettings) {
                $this->writeStoredSetting($writeArray, $mconfName);
            }
        }
        return $this->msg;
    }

    public function writeStoredSetting($writeArray = [], $mconfName = '')
    {
        // Making sure, index 0 is not set
        unset($this->storedSettings[0]);
        $this->storedSettings = $this->cleanupStorageArray($this->storedSettings);
        $writeArray[$this->prefix . '_storedSettings'] = serialize($this->storedSettings);
        $this->getModule()->MOD_SETTINGS = Utility\BackendUtility::getModuleData(
            $this->getModule()->MOD_MENU,
            $writeArray,
            $mconfName ?: $this->getModule()->MCONF['name'],
            $this->type
        );
        if ($this->writeDevLog) {
            GeneralUtility::devLog('Settings stored:' . $this->msg, __CLASS__, 0);
        }
    }

    /********************************
     *
     * GUI
     *
     ********************************/
    public function getStoreControl($showElements = 'load,remove,save', $useOwnForm = true)
    {
        $showElements = GeneralUtility::trimExplode(',', $showElements, true);
        $this->initStorage();
        // Preset selector
        $opt = [];
        $opt[] = '<option value="0">   </option>';
        foreach ($this->storedSettings as $id => $v) {
            $opt[] = '<option value="' . $id . '">' . htmlspecialchars($v['title']) . '</option>';
        }
        $storedEntries = count($opt) > 1;
        $codeTD = [];
        $code = '';
        // LOAD, REMOVE, but also show selector so you can overwrite an entry with SAVE
        if ($storedEntries && !empty($showElements)) {
            // Selector box
            $onChange = 'document.forms[' . GeneralUtility::quoteJSvalue($this->formName) . '][\'storeControl[title]\'].value= this.options[this.selectedIndex].value!=0 ? this.options[this.selectedIndex].text : \'\';';
            $code = '
                    <select name="storeControl[STORE]" onChange="' . htmlspecialchars($onChange) . '">
                    ' . implode('
                        ', $opt) . '
                    </select>';
            // Load button
            if (in_array('load', $showElements)) {
                $code .= '
                    <input class="btn btn-default" type="submit" name="storeControl[LOAD]" value="Load" /> ';
            }
            // Remove button
            if (in_array('remove', $showElements)) {
                $code .= '
                    <input class="btn btn-default" type="submit" name="storeControl[REMOVE]" value="Remove" /> ';
            }
            $codeTD[] = '<td width="1%">Preset:</td>';
            $codeTD[] = '<td nowrap="nowrap">' . $code . '&nbsp;&nbsp;</td>';
        }
        // SAVE
        if (in_array('save', $showElements)) {
            $onClick = !$storedEntries ? '' : 'if (document.forms[' . GeneralUtility::quoteJSvalue($this->formName) . '][\'storeControl[STORE]\'].options[document.forms[' . GeneralUtility::quoteJSvalue($this->formName) . '][\'storeControl[STORE]\'].selectedIndex].value<0) return confirm(\'Are you sure you want to overwrite the existing entry?\');';
            $code = '<input name="storeControl[title]" value="" type="text" max="80" width="25"> ';
            $code .= '<input class="btn btn-default" type="submit" name="storeControl[SAVE]" value="Save" onClick="' . htmlspecialchars($onClick) . '" />';
            $codeTD[] = '<td nowrap="nowrap">' . $code . '</td>';
        }
        $codeTD = implode('
            ', $codeTD);
        if (trim($code)) {
            $code = '
            <!--
                Store control
            -->
            <table border="0" cellpadding="3" cellspacing="0" width="100%">
                <tr class="bgColor4">
                ' . $codeTD . '
                </tr>
            </table>
            ';
        }
        if ($this->msg) {
            $code .= '
            <div><strong>' . htmlspecialchars($this->msg) . '</strong></div>';
        }
        if ($useOwnForm && trim($code)) {
            $code = '
        <form action="' . GeneralUtility::getIndpEnv('SCRIPT_NAME') . '" method="post" name="' . $this->formName . '" enctype="multipart/form-data">' . $code . '</form>';
        }
        return $code;
    }

    /********************************
     *
     * Misc
     *
     ********************************/
    public function processEntry($storageArr)
    {
        return $storageArr;
    }

    protected function getModule()
    {
        return $GLOBALS['SOBE'];
    }
}