3 * @copyright Copyright (C) 2010-2023, the Friendica project
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\Module\Settings;
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;
42 * Module to update user settings
44 class Display extends BaseSettings
46 /** @var IManageConfigValues */
48 /** @var IManagePersonalConfigValues */
52 /** @var SystemMessages */
53 private $systemMessages;
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 = [])
57 parent::__construct($session, $page, $l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
59 $this->config = $config;
60 $this->pConfig = $pConfig;
62 $this->systemMessages = $systemMessages;
65 protected function post(array $request = [])
67 $uid = $this->session->getLocalUserId();
69 throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
72 self::checkFormSecurityTokenRedirectOnError('/settings/display', 'settings_display');
74 $user = User::getById($uid);
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 $enable_smart_threading = !empty($request['enable_smart_threading']) ? intval($request['enable_smart_threading']) : 0;
83 $enable_dislike = !empty($request['enable_dislike']) ? intval($request['enable_dislike']) : 0;
84 $display_resharer = !empty($request['display_resharer']) ? intval($request['display_resharer']) : 0;
85 $stay_local = !empty($request['stay_local']) ? intval($request['stay_local']) : 0;
86 $preview_mode = !empty($request['preview_mode']) ? intval($request['preview_mode']) : 0;
87 $browser_update = !empty($request['browser_update']) ? intval($request['browser_update']) : 0;
88 if ($browser_update != -1) {
89 $browser_update = $browser_update * 1000;
90 if ($browser_update < 10000) {
91 $browser_update = 10000;
95 $itemspage_network = !empty($request['itemspage_network']) ?
96 intval($request['itemspage_network']) :
97 $this->config->get('system', 'itemspage_network');
98 if ($itemspage_network > 100) {
99 $itemspage_network = 100;
101 $itemspage_mobile_network = !empty($request['itemspage_mobile_network']) ?
102 intval($request['itemspage_mobile_network']) :
103 $this->config->get('system', 'itemspage_network_mobile');
104 if ($itemspage_mobile_network > 100) {
105 $itemspage_mobile_network = 100;
108 if ($mobile_theme !== '') {
109 $this->pConfig->set($uid, 'system', 'mobile_theme', $mobile_theme);
112 $this->pConfig->set($uid, 'system', 'itemspage_network' , $itemspage_network);
113 $this->pConfig->set($uid, 'system', 'itemspage_mobile_network', $itemspage_mobile_network);
114 $this->pConfig->set($uid, 'system', 'update_interval' , $browser_update);
115 $this->pConfig->set($uid, 'system', 'no_smilies' , !$enable_smile);
116 $this->pConfig->set($uid, 'system', 'infinite_scroll' , $infinite_scroll);
117 $this->pConfig->set($uid, 'system', 'no_smart_threading' , !$enable_smart_threading);
118 $this->pConfig->set($uid, 'system', 'hide_dislike' , !$enable_dislike);
119 $this->pConfig->set($uid, 'system', 'display_resharer' , $display_resharer);
120 $this->pConfig->set($uid, 'system', 'stay_local' , $stay_local);
121 $this->pConfig->set($uid, 'system', 'preview_mode' , $preview_mode);
123 $this->pConfig->set($uid, 'calendar', 'first_day_of_week' , $first_day_of_week);
124 $this->pConfig->set($uid, 'calendar', 'default_view' , $calendar_default_view);
126 if (in_array($theme, Theme::getAllowedList())) {
127 if ($theme == $user['theme']) {
128 // call theme_post only if theme has not been changed
129 if ($themeconfigfile = Theme::getConfigFile($theme)) {
130 require_once $themeconfigfile;
131 theme_post($this->app);
134 User::update(['theme' => $theme], $uid);
137 $this->systemMessages->addNotice($this->t('The theme you chose isn\'t available.'));
140 Hook::callAll('display_settings_post', $request);
142 $this->baseUrl->redirect('settings/display');
145 protected function content(array $request = []): string
149 $uid = $this->session->getLocalUserId();
151 throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
154 $default_theme = $this->config->get('system', 'theme');
155 if (!$default_theme) {
156 $default_theme = 'default';
159 $default_mobile_theme = $this->config->get('system', 'mobile-theme');
160 if (!$default_mobile_theme) {
161 $default_mobile_theme = 'none';
164 $user = User::getById($uid);
166 $allowed_themes = Theme::getAllowedList();
169 $mobile_themes = ['---' => $this->t('No special theme for mobile devices')];
170 foreach ($allowed_themes as $theme) {
171 $is_experimental = file_exists('view/theme/' . $theme . '/experimental');
172 $is_unsupported = file_exists('view/theme/' . $theme . '/unsupported');
173 $is_mobile = file_exists('view/theme/' . $theme . '/mobile');
174 if (!$is_experimental || $this->config->get('experimental', 'exp_themes')) {
175 $theme_name = ucfirst($theme);
176 if ($is_unsupported) {
177 $theme_name = $this->t('%s - (Unsupported)', $theme_name);
178 } elseif ($is_experimental) {
179 $theme_name = $this->t('%s - (Experimental)', $theme_name);
183 $mobile_themes[$theme] = $theme_name;
185 $themes[$theme] = $theme_name;
190 $theme_selected = $user['theme'] ?: $default_theme;
191 $mobile_theme_selected = $this->session->get('mobile-theme', $default_mobile_theme);
193 $itemspage_network = intval($this->pConfig->get($uid, 'system', 'itemspage_network'));
194 $itemspage_network = (($itemspage_network > 0 && $itemspage_network < 101) ? $itemspage_network : $this->config->get('system', 'itemspage_network'));
195 $itemspage_mobile_network = intval($this->pConfig->get($uid, 'system', 'itemspage_mobile_network'));
196 $itemspage_mobile_network = (($itemspage_mobile_network > 0 && $itemspage_mobile_network < 101) ? $itemspage_mobile_network : $this->config->get('system', 'itemspage_network_mobile'));
198 $browser_update = intval($this->pConfig->get($uid, 'system', 'update_interval'));
199 if ($browser_update != -1) {
200 $browser_update = (($browser_update == 0) ? 40 : $browser_update / 1000); // default if not set: 40 seconds
203 $enable_smile = !$this->pConfig->get($uid, 'system', 'no_smilies', 0);
204 $infinite_scroll = $this->pConfig->get($uid, 'system', 'infinite_scroll', 0);
205 $enable_smart_threading = !$this->pConfig->get($uid, 'system', 'no_smart_threading', 0);
206 $enable_dislike = !$this->pConfig->get($uid, 'system', 'hide_dislike', 0);
207 $display_resharer = $this->pConfig->get($uid, 'system', 'display_resharer', 0);
208 $stay_local = $this->pConfig->get($uid, 'system', 'stay_local', 0);
210 $preview_mode = $this->pConfig->get($uid, 'system', 'preview_mode', BBCode::PREVIEW_LARGE);
212 BBCode::PREVIEW_NONE => $this->t('No preview'),
213 BBCode::PREVIEW_NO_IMAGE => $this->t('No image'),
214 BBCode::PREVIEW_SMALL => $this->t('Small Image'),
215 BBCode::PREVIEW_LARGE => $this->t('Large Image'),
219 $first_day_of_week = $this->pConfig->get($uid, 'calendar', 'first_day_of_week', 0);
221 0 => $this->t('Sunday'),
222 1 => $this->t('Monday'),
223 2 => $this->t('Tuesday'),
224 3 => $this->t('Wednesday'),
225 4 => $this->t('Thursday'),
226 5 => $this->t('Friday'),
227 6 => $this->t('Saturday')
230 $calendar_default_view = $this->pConfig->get($uid, 'calendar', 'default_view', 'month');
232 'month' => $this->t('month'),
233 'agendaWeek' => $this->t('week'),
234 'agendaDay' => $this->t('day'),
235 'listMonth' => $this->t('list')
239 if ($themeconfigfile = Theme::getConfigFile($theme_selected)) {
240 require_once $themeconfigfile;
241 $theme_config = theme_content($this->app);
244 $tpl = Renderer::getMarkupTemplate('settings/display.tpl');
245 return Renderer::replaceMacros($tpl, [
246 '$ptitle' => $this->t('Display Settings'),
247 '$submit' => $this->t('Save Settings'),
248 '$d_tset' => $this->t('General Theme Settings'),
249 '$d_ctset' => $this->t('Custom Theme Settings'),
250 '$d_cset' => $this->t('Content Settings'),
251 '$stitle' => $this->t('Theme settings'),
252 '$calendar_title' => $this->t('Calendar'),
254 '$form_security_token' => self::getFormSecurityToken('settings_display'),
257 '$theme' => ['theme', $this->t('Display Theme:'), $theme_selected, '', $themes, true],
258 '$mobile_theme' => ['mobile_theme', $this->t('Mobile Theme:'), $mobile_theme_selected, '', $mobile_themes, false],
259 '$theme_config' => $theme_config,
261 '$itemspage_network' => ['itemspage_network' , $this->t('Number of items to display per page:'), $itemspage_network, $this->t('Maximum of 100 items')],
262 '$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')],
263 '$ajaxint' => ['browser_update' , $this->t('Update browser every xx seconds'), $browser_update, $this->t('Minimum of 10 seconds. Enter -1 to disable it.')],
264 '$enable_smile' => ['enable_smile' , $this->t('Display emoticons'), $enable_smile, $this->t('When enabled, emoticons are replaced with matching symbols.')],
265 '$infinite_scroll' => ['infinite_scroll' , $this->t('Infinite scroll'), $infinite_scroll, $this->t('Automatic fetch new items when reaching the page end.')],
266 '$enable_smart_threading' => ['enable_smart_threading' , $this->t('Enable Smart Threading'), $enable_smart_threading, $this->t('Enable the automatic suppression of extraneous thread indentation.')],
267 '$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.')],
268 '$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.')],
269 '$stay_local' => ['stay_local' , $this->t('Stay local'), $stay_local, $this->t("Don't go to a remote system when following a contact link.")],
270 '$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],
272 '$first_day_of_week' => ['first_day_of_week' , $this->t('Beginning of week:') , $first_day_of_week , '', $weekdays , false],
273 '$calendar_default_view' => ['calendar_default_view', $this->t('Default calendar view:'), $calendar_default_view, '', $calendarViews, false],