src/Module/Settings/Display.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Module\Settings;
  23
  24 use Friendica\App;
  25 use Friendica\Content\Text\BBCode;
  26 use Friendica\Core\Config\Capability\IManageConfigValues;
  27 use Friendica\Core\Hook;
  28 use Friendica\Core\L10n;
  29 use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues;
  30 use Friendica\Core\Renderer;
  31 use Friendica\Core\Session\Capability\IHandleUserSessions;
  32 use Friendica\Core\Theme;
  33 use Friendica\Model\User;
  34 use Friendica\Module\BaseSettings;
  35 use Friendica\Module\Response;
  36 use Friendica\Navigation\SystemMessages;
  37 use Friendica\Network\HTTPException;
  38 use Friendica\Util\Profiler;
  39 use Psr\Log\LoggerInterface;
  40
  41 /**
  42  * Module to update user settings
  43  */
  44 class Display extends BaseSettings
  45 {
  46         /** @var IManageConfigValues */
  47         private $config;
  48         /** @var IManagePersonalConfigValues */
  49         private $pConfig;
  50         /** @var App */
  51         private $app;
  52         /** @var SystemMessages */
  53         private $systemMessages;
  54
  55         public function __construct(SystemMessages $systemMessages, App $app, IManagePersonalConfigValues $pConfig, IManageConfigValues $config, IHandleUserSessions $session, App\Page $page, L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, Response $response, array $server, array $parameters = [])
  56         {
  57                 parent::__construct($session, $page, $l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
  58
  59                 $this->config         = $config;
  60                 $this->pConfig        = $pConfig;
  61                 $this->app            = $app;
  62                 $this->systemMessages = $systemMessages;
  63         }
  64
  65         protected function post(array $request = [])
  66         {
  67                 $uid = $this->session->getLocalUserId();
  68                 if (!$uid) {
  69                         throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
  70                 }
  71
  72                 self::checkFormSecurityTokenRedirectOnError('/settings/display', 'settings_display');
  73
  74                 $user = User::getById($uid);
  75
  76                 $theme                  = !empty($request['theme'])                  ? trim($request['theme'])                    : $user['theme'];
  77                 $mobile_theme           = !empty($request['mobile_theme'])           ? trim($request['mobile_theme'])             : '';
  78                 $enable_smile           = !empty($request['enable_smile'])           ? intval($request['enable_smile'])           : 0;
  79                 $first_day_of_week      = !empty($request['first_day_of_week'])      ? intval($request['first_day_of_week'])      : 0;
  80                 $calendar_default_view  = !empty($request['calendar_default_view'])  ? trim($request['calendar_default_view'])    : 'month';
  81                 $infinite_scroll        = !empty($request['infinite_scroll'])        ? intval($request['infinite_scroll'])        : 0;
  82                 $no_auto_update         = !empty($request['no_auto_update'])         ? intval($request['no_auto_update'])         : 0;
  83                 $enable_smart_threading = !empty($request['enable_smart_threading']) ? intval($request['enable_smart_threading']) : 0;
  84                 $enable_dislike         = !empty($request['enable_dislike'])         ? intval($request['enable_dislike'])         : 0;
  85                 $display_resharer       = !empty($request['display_resharer'])       ? intval($request['display_resharer'])       : 0;
  86                 $stay_local             = !empty($request['stay_local'])             ? intval($request['stay_local'])             : 0;
  87                 $preview_mode           = !empty($request['preview_mode'])           ? intval($request['preview_mode'])           : 0;
  88                 $browser_update         = !empty($request['browser_update'])         ? intval($request['browser_update'])         : 0;
  89                 if ($browser_update != -1) {
  90                         $browser_update = $browser_update * 1000;
  91                         if ($browser_update < 10000) {
  92                                 $browser_update = 10000;
  93                         }
  94                 }
  95
  96                 $itemspage_network = !empty($request['itemspage_network']) ?
  97                         intval($request['itemspage_network']) :
  98                         $this->config->get('system', 'itemspage_network');
  99                 if ($itemspage_network > 100) {
 100                         $itemspage_network = 100;
 101                 }
 102                 $itemspage_mobile_network = !empty($request['itemspage_mobile_network']) ?
 103                         intval($request['itemspage_mobile_network']) :
 104                         $this->config->get('system', 'itemspage_network_mobile');
 105                 if ($itemspage_mobile_network > 100) {
 106                         $itemspage_mobile_network = 100;
 107                 }
 108
 109                 if ($mobile_theme !== '') {
 110                         $this->pConfig->set($uid, 'system', 'mobile_theme', $mobile_theme);
 111                 }
 112
 113                 $this->pConfig->set($uid, 'system', 'itemspage_network'       , $itemspage_network);
 114                 $this->pConfig->set($uid, 'system', 'itemspage_mobile_network', $itemspage_mobile_network);
 115                 $this->pConfig->set($uid, 'system', 'update_interval'         , $browser_update);
 116                 $this->pConfig->set($uid, 'system', 'no_auto_update'          , $no_auto_update);
 117                 $this->pConfig->set($uid, 'system', 'no_smilies'              , !$enable_smile);
 118                 $this->pConfig->set($uid, 'system', 'infinite_scroll'         , $infinite_scroll);
 119                 $this->pConfig->set($uid, 'system', 'no_smart_threading'      , !$enable_smart_threading);
 120                 $this->pConfig->set($uid, 'system', 'hide_dislike'            , !$enable_dislike);
 121                 $this->pConfig->set($uid, 'system', 'display_resharer'        , $display_resharer);
 122                 $this->pConfig->set($uid, 'system', 'stay_local'              , $stay_local);
 123                 $this->pConfig->set($uid, 'system', 'preview_mode'            , $preview_mode);
 124
 125                 $this->pConfig->set($uid, 'calendar', 'first_day_of_week'     , $first_day_of_week);
 126                 $this->pConfig->set($uid, 'calendar', 'default_view'           , $calendar_default_view);
 127
 128                 if (in_array($theme, Theme::getAllowedList())) {
 129                         if ($theme == $user['theme']) {
 130                                 // call theme_post only if theme has not been changed
 131                                 if ($themeconfigfile = Theme::getConfigFile($theme)) {
 132                                         require_once $themeconfigfile;
 133                                         theme_post($this->app);
 134                                 }
 135                         } else {
 136                                 User::update(['theme' => $theme], $uid);
 137                         }
 138                 } else {
 139                         $this->systemMessages->addNotice($this->t('The theme you chose isn\'t available.'));
 140                 }
 141
 142                 Hook::callAll('display_settings_post', $request);
 143
 144                 $this->baseUrl->redirect('settings/display');
 145         }
 146
 147         protected function content(array $request = []): string
 148         {
 149                 parent::content();
 150
 151                 $uid = $this->session->getLocalUserId();
 152                 if (!$uid) {
 153                         throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
 154                 }
 155
 156                 $default_theme = $this->config->get('system', 'theme');
 157                 if (!$default_theme) {
 158                         $default_theme = 'default';
 159                 }
 160
 161                 $default_mobile_theme = $this->config->get('system', 'mobile-theme');
 162                 if (!$default_mobile_theme) {
 163                         $default_mobile_theme = 'none';
 164                 }
 165
 166                 $user = User::getById($uid);
 167
 168                 $allowed_themes = Theme::getAllowedList();
 169
 170                 $themes = [];
 171                 $mobile_themes = ['---' => $this->t('No special theme for mobile devices')];
 172                 foreach ($allowed_themes as $theme) {
 173                         $is_experimental = file_exists('view/theme/' . $theme . '/experimental');
 174                         $is_unsupported  = file_exists('view/theme/' . $theme . '/unsupported');
 175                         $is_mobile       = file_exists('view/theme/' . $theme . '/mobile');
 176                         if (!$is_experimental || $this->config->get('experimental', 'exp_themes')) {
 177                                 $theme_name = ucfirst($theme);
 178                                 if ($is_unsupported) {
 179                                         $theme_name = $this->t('%s - (Unsupported)', $theme_name);
 180                                 } elseif ($is_experimental) {
 181                                         $theme_name = $this->t('%s - (Experimental)', $theme_name);
 182                                 }
 183
 184                                 if ($is_mobile) {
 185                                         $mobile_themes[$theme] = $theme_name;
 186                                 } else {
 187                                         $themes[$theme] = $theme_name;
 188                                 }
 189                         }
 190                 }
 191
 192                 $theme_selected        = $user['theme'] ?: $default_theme;
 193                 $mobile_theme_selected = $this->session->get('mobile-theme', $default_mobile_theme);
 194
 195                 $itemspage_network = intval($this->pConfig->get($uid, 'system', 'itemspage_network'));
 196                 $itemspage_network = (($itemspage_network > 0 && $itemspage_network < 101) ? $itemspage_network : $this->config->get('system', 'itemspage_network'));
 197                 $itemspage_mobile_network = intval($this->pConfig->get($uid, 'system', 'itemspage_mobile_network'));
 198                 $itemspage_mobile_network = (($itemspage_mobile_network > 0 && $itemspage_mobile_network < 101) ? $itemspage_mobile_network : $this->config->get('system', 'itemspage_network_mobile'));
 199
 200                 $browser_update = intval($this->pConfig->get($uid, 'system', 'update_interval'));
 201                 if ($browser_update != -1) {
 202                         $browser_update = (($browser_update == 0) ? 40 : $browser_update / 1000); // default if not set: 40 seconds
 203                 }
 204
 205                 $no_auto_update         =  $this->pConfig->get($uid, 'system', 'no_auto_update', 0);
 206                 $enable_smile           = !$this->pConfig->get($uid, 'system', 'no_smilies', 0);
 207                 $infinite_scroll        =  $this->pConfig->get($uid, 'system', 'infinite_scroll', 0);
 208                 $enable_smart_threading = !$this->pConfig->get($uid, 'system', 'no_smart_threading', 0);
 209                 $enable_dislike         = !$this->pConfig->get($uid, 'system', 'hide_dislike', 0);
 210                 $display_resharer       =  $this->pConfig->get($uid, 'system', 'display_resharer', 0);
 211                 $stay_local             =  $this->pConfig->get($uid, 'system', 'stay_local', 0);
 212
 213                 $preview_mode  =  $this->pConfig->get($uid, 'system', 'preview_mode', BBCode::PREVIEW_LARGE);
 214                 $preview_modes = [
 215                         BBCode::PREVIEW_NONE     => $this->t('No preview'),
 216                         BBCode::PREVIEW_NO_IMAGE => $this->t('No image'),
 217                         BBCode::PREVIEW_SMALL    => $this->t('Small Image'),
 218                         BBCode::PREVIEW_LARGE    => $this->t('Large Image'),
 219                 ];
 220
 221
 222                 $first_day_of_week = $this->pConfig->get($uid, 'calendar', 'first_day_of_week', 0);
 223                 $weekdays          = [
 224                         0 => $this->t('Sunday'),
 225                         1 => $this->t('Monday'),
 226                         2 => $this->t('Tuesday'),
 227                         3 => $this->t('Wednesday'),
 228                         4 => $this->t('Thursday'),
 229                         5 => $this->t('Friday'),
 230                         6 => $this->t('Saturday')
 231                 ];
 232
 233                 $calendar_default_view = $this->pConfig->get($uid, 'calendar', 'default_view', 'month');
 234                 $calendarViews         = [
 235                         'month'      => $this->t('month'),
 236                         'agendaWeek' => $this->t('week'),
 237                         'agendaDay'  => $this->t('day'),
 238                         'listMonth'  => $this->t('list')
 239                 ];
 240
 241                 $theme_config = '';
 242                 if ($themeconfigfile = Theme::getConfigFile($theme_selected)) {
 243                         require_once $themeconfigfile;
 244                         $theme_config = theme_content($this->app);
 245                 }
 246
 247                 $tpl = Renderer::getMarkupTemplate('settings/display.tpl');
 248                 return Renderer::replaceMacros($tpl, [
 249                         '$ptitle'         => $this->t('Display Settings'),
 250                         '$submit'         => $this->t('Save Settings'),
 251                         '$d_tset'         => $this->t('General Theme Settings'),
 252                         '$d_ctset'        => $this->t('Custom Theme Settings'),
 253                         '$d_cset'         => $this->t('Content Settings'),
 254                         '$stitle'         => $this->t('Theme settings'),
 255                         '$calendar_title' => $this->t('Calendar'),
 256
 257                         '$form_security_token' => self::getFormSecurityToken('settings_display'),
 258                         '$baseurl'             => $this->baseUrl->get(true),
 259                         '$uid'                 => $uid,
 260
 261                         '$theme'            => ['theme', $this->t('Display Theme:'), $theme_selected, '', $themes, true],
 262                         '$mobile_theme' => ['mobile_theme', $this->t('Mobile Theme:'), $mobile_theme_selected, '', $mobile_themes, false],
 263                         '$theme_config' => $theme_config,
 264
 265                         '$itemspage_network'        => ['itemspage_network'       , $this->t('Number of items to display per page:'), $itemspage_network, $this->t('Maximum of 100 items')],
 266                         '$itemspage_mobile_network' => ['itemspage_mobile_network', $this->t('Number of items to display per page when viewed from mobile device:'), $itemspage_mobile_network, $this->t('Maximum of 100 items')],
 267                         '$ajaxint'                  => ['browser_update'          , $this->t('Update browser every xx seconds'), $browser_update, $this->t('Minimum of 10 seconds. Enter -1 to disable it.')],
 268                         '$no_auto_update'           => ['no_auto_update'          , $this->t('Automatic updates only at the top of the post stream pages'), $no_auto_update, $this->t('Auto update may add new posts at the top of the post stream pages, which can affect the scroll position and perturb normal reading if it happens anywhere else the top of the page.')],
 269                         '$enable_smile'             => ['enable_smile'            , $this->t('Display emoticons'), $enable_smile, $this->t('When enabled, emoticons are replaced with matching symbols.')],
 270                         '$infinite_scroll'          => ['infinite_scroll'         , $this->t('Infinite scroll'), $infinite_scroll, $this->t('Automatic fetch new items when reaching the page end.')],
 271                         '$enable_smart_threading'   => ['enable_smart_threading'  , $this->t('Enable Smart Threading'), $enable_smart_threading, $this->t('Enable the automatic suppression of extraneous thread indentation.')],
 272                         '$enable_dislike'           => ['enable_dislike'          , $this->t('Display the Dislike feature'), $enable_dislike, $this->t('Display the Dislike button and dislike reactions on posts and comments.')],
 273                         '$display_resharer'         => ['display_resharer'        , $this->t('Display the resharer'), $display_resharer, $this->t('Display the first resharer as icon and text on a reshared item.')],
 274                         '$stay_local'               => ['stay_local'              , $this->t('Stay local'), $stay_local, $this->t("Don't go to a remote system when following a contact link.")],
 275                         '$preview_mode'             => ['preview_mode'            , $this->t('Link preview mode'), $preview_mode, $this->t('Appearance of the link preview that is added to each post with a link.'), $preview_modes, false],
 276
 277                         '$first_day_of_week'     => ['first_day_of_week'    , $this->t('Beginning of week:')    , $first_day_of_week    , '', $weekdays     , false],
 278                         '$calendar_default_view' => ['calendar_default_view', $this->t('Default calendar view:'), $calendar_default_view, '', $calendarViews, false],
 279                 ]);
 280         }
 281 }