typo3/sysext/em/classes/settings/class.tx_em_settings.php

   1 <?php
   2 /***************************************************************
   3  *  Copyright notice
   4  *
   5  *  (c) 2010 Steffen Kamper (info@sk-typo3.de)
   6  *  All rights reserved
   7  *
   8  *  This script is part of the TYPO3 project. The TYPO3 project is
   9  *  free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License as published by
  11  *  the Free Software Foundation; either version 2 of the License, or
  12  *  (at your option) any later version.
  13  *
  14  *  The GNU General Public License can be found at
  15  *  http://www.gnu.org/copyleft/gpl.html.
  16  *  A copy is found in the textfile GPL.txt and important notices to the license
  17  *  from the author is found in LICENSE.txt distributed with these scripts.
  18  *
  19  *
  20  *  This script is distributed in the hope that it will be useful,
  21  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  *  GNU General Public License for more details.
  24  *
  25  *  This copyright notice MUST APPEAR in all copies of the script!
  26  ***************************************************************/
  27 /**
  28  * Module: Extension manager, developer module
  29  *
  30  * @author      Steffen Kamper <info@sk-typo3.de>
  31  */
  32
  33
  34 $GLOBALS['LANG']->includeLLFile(t3lib_extMgm::extPath('em', 'language/locallang.xml'));
  35
  36
  37 class tx_em_Settings implements t3lib_Singleton {
  38
  39         public $MOD_MENU = array(); // Module menu items
  40
  41
  42         /**
  43          * Settings array
  44          *
  45          * @var array
  46          */
  47         protected $settings;
  48
  49
  50         /**
  51          * Constructor
  52          *
  53          */
  54         public function __construct() {
  55                 $this->readSettings();
  56         }
  57
  58         /**
  59          * Get settings
  60          */
  61         public function getSettings() {
  62                 return $this->settings;
  63         }
  64
  65         /**
  66          * Get user Settings
  67          */
  68         public function getUserSettings() {
  69                 $userSettings = t3lib_beFunc::getModTSconfig(0, 'mod.tools_em');
  70                 return $userSettings['properties'];
  71         }
  72
  73         /**
  74          * Save user settings
  75          *
  76          * @param array $settings
  77          */
  78         public function saveSettings($settings) {
  79                 $this->settings = t3lib_BEfunc::getModuleData($this->MOD_MENU, $settings, 'tools_em');
  80                 return $this->settings;
  81         }
  82
  83         /**
  84          * Save single value in session settings
  85          *
  86          * @param string $name
  87          * @param string $value
  88          */
  89         public function saveSetting($name, $value) {
  90                 t3lib_BEfunc::getModuleData($this->MOD_MENU, array($name => $value), 'tools_em');
  91         }
  92
  93         /**
  94          * Initial settings for extension manager module data
  95          *
  96          * @return void
  97          */
  98         protected function readSettings() {
  99                 $globalSettings = unserialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf']['em']);
 100                 if (!is_array($globalSettings)) {
 101                         $globalSettings = array(
 102                                 'displayMyExtensions' => 0,
 103                                 'selectedLanguages' => array(),
 104                                 'inlineToWindow' => 1,
 105                         );
 106                 }
 107                 $this->MOD_MENU = array(
 108                         'function' => array(
 109                                 'loaded_list' => $GLOBALS['LANG']->getLL('menu_loaded_extensions'),
 110                                 'installed_list' => $GLOBALS['LANG']->getLL('menu_install_extensions'),
 111                                 'import' => $GLOBALS['LANG']->getLL('menu_import_extensions'),
 112                                 'translations' => $GLOBALS['LANG']->getLL('menu_translation_handling'),
 113                                 'settings' => $GLOBALS['LANG']->getLL('menu_settings'),
 114                                 'extensionmanager' => $GLOBALS['LANG']->getLL('header'),
 115                                 'updates' => $GLOBALS['LANG']->getLL('menu_extension_updates'),
 116                         ),
 117                         'listOrder' => array(
 118                                 'cat' => $GLOBALS['LANG']->getLL('list_order_category'),
 119                                 'author_company' => $GLOBALS['LANG']->getLL('list_order_author'),
 120                                 'state' => $GLOBALS['LANG']->getLL('list_order_state'),
 121                                 'type' => $GLOBALS['LANG']->getLL('list_order_type'),
 122                         ),
 123                         'display_details' => array(
 124                                 1 => $GLOBALS['LANG']->getLL('show_details'),
 125                                 0 => $GLOBALS['LANG']->getLL('show_description'),
 126                                 2 => $GLOBALS['LANG']->getLL('show_more_details'),
 127
 128                                 3 => $GLOBALS['LANG']->getLL('show_technical'),
 129                                 4 => $GLOBALS['LANG']->getLL('show_validating'),
 130                                 5 => $GLOBALS['LANG']->getLL('show_changed'),
 131                         ),
 132                         'display_shy' => '',
 133                         'display_own' => '',
 134                         'display_obsolete' => '',
 135                         'display_installed' => '',
 136                         'display_updatable' => '',
 137                         'display_files' => '',
 138                         'hide_shy' => 0,
 139                         'hide_obsolete' => 0,
 140
 141
 142                         'singleDetails' => array(
 143                                 'info' => $GLOBALS['LANG']->getLL('details_info'),
 144                                 'edit' => $GLOBALS['LANG']->getLL('details_edit'),
 145                                 'backup' => $GLOBALS['LANG']->getLL('details_backup_delete'),
 146                                 'dump' => $GLOBALS['LANG']->getLL('details_dump_db'),
 147                                 'upload' => $GLOBALS['LANG']->getLL('details_upload'),
 148                                 'updateModule' => $GLOBALS['LANG']->getLL('details_update'),
 149                         ),
 150                         'fe_u' => '',
 151                         'fe_p' => '',
 152
 153                         'mirrorListURL' => '',
 154                         'rep_url' => '',
 155                         'extMirrors' => '',
 156
 157                         // returns uid of currently selected repository
 158                         // default and hardcoded: 1 = TYPO3.org
 159                         'selectedRepository' => '1',
 160                         'selectedMirror' => '0',
 161
 162                         'selectedLanguages' => '',
 163
 164                         'mainTab' => '0',
 165                 );
 166                 $this->settings = t3lib_BEfunc::getModuleData($this->MOD_MENU, t3lib_div::_GP('SET'), 'tools_em');
 167                 $this->settings = array_merge($this->settings, $globalSettings);
 168         }
 169
 170         /**
 171          * Gets url for mirror
 172          *
 173          * @return string
 174          */
 175         public function getMirrorURL() {
 176                 if (strlen($this->settings['rep_url'])) {
 177                         return $this->settings['rep_url'];
 178                 }
 179
 180                 $mirrors = unserialize($this->settings['extMirrors']);
 181
 182                 if(!is_array($mirrors)) {
 183                         if ($this->settings['selectedRepository'] < 1) {
 184                                 $this->settings['selectedRepository'] = 1;
 185                         }
 186                 }
 187                 /** @var $repository tx_em_Repository */
 188                 $repository = t3lib_div::makeInstance('tx_em_Repository', $this->settings['selectedRepository']);
 189                 if ($repository->getMirrorListUrl()) {
 190                         /** @var $objRepositoryUtility tx_em_Repository_Utility */
 191                         $objRepositoryUtility = t3lib_div::makeInstance('tx_em_Repository_Utility', $repository);
 192                         $mirrors = $objRepositoryUtility->getMirrors(TRUE)->getMirrors();
 193                         if(!is_array($mirrors)) {
 194                                 return FALSE;
 195                         } else {
 196                                 $this->settings['extMirrors'] = serialize($mirrors);
 197                                 $this->saveSetting('extMirrors', $this->settings['extMirrors']);
 198                         }
 199                 }
 200                 if (!$this->settings['selectedMirror']) {
 201                         $rand = array_rand($mirrors);
 202                         $url = 'http://' . $mirrors[$rand]['host'] . $mirrors[$rand]['path'];
 203                 }
 204                 else {
 205                         $selectedMirror = NULL;
 206                         foreach ($mirrors as $mirror) {
 207                                 if ($mirror['host'] === $this->settings['selectedMirror']) {
 208                                         $selectedMirror = $mirror;
 209                                         break;
 210                                 }
 211                         }
 212                         $url = 'http://' . $selectedMirror['host'] . $selectedMirror['path'];
 213                 }
 214
 215                 return $url;
 216         }
 217
 218         /**
 219          * Method returns registered extension repositories.
 220          *
 221          * Registered repositories are global (per installation) settings.
 222          *
 223          * @access  public
 224          * @return  array of {@link em_repository em_repository} instances
 225          * @see  registerDefaultRepository(), setRegisteredRepositories()
 226          */
 227         public function getRegisteredRepositories() {
 228                 $registry = t3lib_div::makeInstance('t3lib_Registry');
 229                 $regRepos = $registry->get('core', 'em.repositories.registered');
 230
 231                 // create default entry if there wasn't one
 232                 if (empty($regRepos)) {
 233                         $this->registerDefaultRepository();
 234                         $regRepos = $registry->get('core', 'em.repositories.registered');
 235                 }
 236
 237                 return $regRepos;
 238         }
 239
 240         /**
 241          * Method creates default registered repositories entry.
 242          *
 243          * @access  protected
 244          * @return  void
 245          * @see  getRegisteredRepository(), setRegisteredRepositories()
 246          */
 247         protected function registerDefaultRepository() {
 248                 $registry = t3lib_div::makeInstance('t3lib_Registry');
 249                 $defaultRepo = t3lib_div::makeInstance('tx_em_Repository');
 250                 $registry->set('core', 'em.repositories.registered', array($defaultRepo));
 251         }
 252
 253         /**
 254          * Method sets (persists) registered repositories.
 255          *
 256          * Registered repositories are global (per installation) settings.
 257          *
 258          * @access  public
 259          * @param   array  $repositories  array of {@link em_repository em_repository} instances
 260          * @see  registerDefaultRepository(), setRegisteredRepositories()
 261          * @throws  InvalidArgumentException in case argument contains no instances of {@link em_repository em_repository}
 262          */
 263         public function setRegisteredRepositories(array $repositories) {
 264                 // removing mirror instances
 265                 foreach ($repositories as $repository) {
 266                         if ($repository instanceof em_repository) {
 267                                 $repository->removeMirrors();
 268                         } else {
 269                                 throw new InvalidArgumentException(get_class($this) . ': ' . 'No valid instances of em_repository given.');
 270                         }
 271                 }
 272                 if (count($repositories)) {
 273                         $registry = t3lib_div::makeInstance('t3lib_Registry');
 274                         $registry->set('core', 'em.repositories.registered', $repositories);
 275                 }
 276         }
 277
 278         /**
 279          * Method returns currently selected repository
 280          *
 281          * Selected repository is local (per user) settings.
 282          *
 283          * @access  public
 284          * @return  em_repository  repository instance that is currently selected by a BE user
 285          * @see  setSelectedRepository()
 286          */
 287         public function getSelectedRepository() {
 288                 return t3lib_div::makeInstance('tx_em_Repository', $this->settings['selectedRepository']);
 289         }
 290
 291         /**
 292          * Method sets currently selected repository.
 293          *
 294          * Selected repository is local (per user) settings.
 295          *
 296          * @todo        STUB, implementation missing
 297          * @access  public
 298          * @param   em_repository  $repository  repository instance that is currently selected by a BE user
 299          * @see  getSelectedRepository()
 300          */
 301         public function setSelectedRepository(em_repository $repository) {
 302                 // this method would set sth. like "REPOSITORY_TITLE:INT" in a setting field
 303                 // REPOSITORY_TITLE = example: main
 304                 // INT = 0 means randomly selected mirror, >0 selects specific mirror
 305         }
 306
 307 }
 308
 309 if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['typo3/sysext/em/classes/settings/class.tx_em_settings.php'])) {
 310         include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['typo3/sysext/em/classes/repository/class.tx_em_settings.php']);
 311 }
 312
 313 ?>