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\Conversation\Collection\Timelines;
26 use Friendica\Content\Text\BBCode;
27 use Friendica\Content\Conversation\Factory\Channel as ChannelFactory;
28 use Friendica\Content\Conversation\Factory\Community as CommunityFactory;
29 use Friendica\Content\Conversation\Factory\Network as NetworkFactory;
30 use Friendica\Content\Conversation\Factory\Timeline as TimelineFactory;
31 use Friendica\Content\Conversation\Repository;
32 use Friendica\Core\Config\Capability\IManageConfigValues;
33 use Friendica\Core\Hook;
34 use Friendica\Core\L10n;
35 use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues;
36 use Friendica\Core\Renderer;
37 use Friendica\Core\Session\Capability\IHandleUserSessions;
38 use Friendica\Core\Theme;
39 use Friendica\Model\User;
40 use Friendica\Module\BaseSettings;
41 use Friendica\Module\Response;
42 use Friendica\Navigation\SystemMessages;
43 use Friendica\Network\HTTPException;
44 use Friendica\Util\Profiler;
45 use Psr\Log\LoggerInterface;
48 * Module to update user settings
50 class Display extends BaseSettings
52 /** @var IManageConfigValues */
54 /** @var IManagePersonalConfigValues */
58 /** @var SystemMessages */
59 private $systemMessages;
60 /** @var ChannelFactory */
62 /** @var Repository\UserDefinedChannel */
63 protected $userDefinedChannel;
64 /** @var CommunityFactory */
66 /** @var NetworkFactory */
68 /** @var TimelineFactory */
71 public function __construct(Repository\UserDefinedChannel $userDefinedChannel, NetworkFactory $network, CommunityFactory $community, ChannelFactory $channel, TimelineFactory $timeline, 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 = [])
73 parent::__construct($session, $page, $l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
75 $this->config = $config;
76 $this->pConfig = $pConfig;
78 $this->systemMessages = $systemMessages;
79 $this->timeline = $timeline;
80 $this->channel = $channel;
81 $this->community = $community;
82 $this->network = $network;
83 $this->userDefinedChannel = $userDefinedChannel;
86 protected function post(array $request = [])
88 $uid = $this->session->getLocalUserId();
90 throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
93 self::checkFormSecurityTokenRedirectOnError('/settings/display', 'settings_display');
95 $user = User::getById($uid);
97 $theme = !empty($request['theme']) ? trim($request['theme']) : $user['theme'];
98 $mobile_theme = !empty($request['mobile_theme']) ? trim($request['mobile_theme']) : '';
99 $enable_smile = !empty($request['enable_smile']) ? intval($request['enable_smile']) : 0;
100 $enable = !empty($request['enable']) ? $request['enable'] : [];
101 $bookmark = !empty($request['bookmark']) ? $request['bookmark'] : [];
102 $channel_languages = !empty($request['channel_languages']) ? $request['channel_languages'] : [];
103 $first_day_of_week = !empty($request['first_day_of_week']) ? intval($request['first_day_of_week']) : 0;
104 $calendar_default_view = !empty($request['calendar_default_view']) ? trim($request['calendar_default_view']) : 'month';
105 $infinite_scroll = !empty($request['infinite_scroll']) ? intval($request['infinite_scroll']) : 0;
106 $enable_smart_threading = !empty($request['enable_smart_threading']) ? intval($request['enable_smart_threading']) : 0;
107 $enable_dislike = !empty($request['enable_dislike']) ? intval($request['enable_dislike']) : 0;
108 $display_resharer = !empty($request['display_resharer']) ? intval($request['display_resharer']) : 0;
109 $stay_local = !empty($request['stay_local']) ? intval($request['stay_local']) : 0;
110 $preview_mode = !empty($request['preview_mode']) ? intval($request['preview_mode']) : 0;
111 $browser_update = !empty($request['browser_update']) ? intval($request['browser_update']) : 0;
112 if ($browser_update != -1) {
113 $browser_update = $browser_update * 1000;
114 if ($browser_update < 10000) {
115 $browser_update = 10000;
119 $enabled_timelines = [];
120 foreach ($enable as $code => $enabled) {
122 $enabled_timelines[] = $code;
126 $network_timelines = [];
127 foreach ($bookmark as $code => $bookmarked) {
129 $network_timelines[] = $code;
133 $itemspage_network = !empty($request['itemspage_network']) ?
134 intval($request['itemspage_network']) :
135 $this->config->get('system', 'itemspage_network');
136 if ($itemspage_network > 100) {
137 $itemspage_network = 100;
139 $itemspage_mobile_network = !empty($request['itemspage_mobile_network']) ?
140 intval($request['itemspage_mobile_network']) :
141 $this->config->get('system', 'itemspage_network_mobile');
142 if ($itemspage_mobile_network > 100) {
143 $itemspage_mobile_network = 100;
146 if ($mobile_theme !== '') {
147 $this->pConfig->set($uid, 'system', 'mobile_theme', $mobile_theme);
150 $this->pConfig->set($uid, 'system', 'itemspage_network' , $itemspage_network);
151 $this->pConfig->set($uid, 'system', 'itemspage_mobile_network', $itemspage_mobile_network);
152 $this->pConfig->set($uid, 'system', 'update_interval' , $browser_update);
153 $this->pConfig->set($uid, 'system', 'no_smilies' , !$enable_smile);
154 $this->pConfig->set($uid, 'system', 'infinite_scroll' , $infinite_scroll);
155 $this->pConfig->set($uid, 'system', 'no_smart_threading' , !$enable_smart_threading);
156 $this->pConfig->set($uid, 'system', 'hide_dislike' , !$enable_dislike);
157 $this->pConfig->set($uid, 'system', 'display_resharer' , $display_resharer);
158 $this->pConfig->set($uid, 'system', 'stay_local' , $stay_local);
159 $this->pConfig->set($uid, 'system', 'preview_mode' , $preview_mode);
161 $this->pConfig->set($uid, 'system', 'network_timelines' , $network_timelines);
162 $this->pConfig->set($uid, 'system', 'enabled_timelines' , $enabled_timelines);
163 $this->pConfig->set($uid, 'channel', 'languages' , $channel_languages);
165 $this->pConfig->set($uid, 'calendar', 'first_day_of_week' , $first_day_of_week);
166 $this->pConfig->set($uid, 'calendar', 'default_view' , $calendar_default_view);
168 if (in_array($theme, Theme::getAllowedList())) {
169 if ($theme == $user['theme']) {
170 // call theme_post only if theme has not been changed
171 if ($themeconfigfile = Theme::getConfigFile($theme)) {
172 require_once $themeconfigfile;
173 theme_post($this->app);
176 User::update(['theme' => $theme], $uid);
179 $this->systemMessages->addNotice($this->t('The theme you chose isn\'t available.'));
182 Hook::callAll('display_settings_post', $request);
184 $this->baseUrl->redirect('settings/display');
187 protected function content(array $request = []): string
191 $uid = $this->session->getLocalUserId();
193 throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
196 $default_theme = $this->config->get('system', 'theme');
197 if (!$default_theme) {
198 $default_theme = 'default';
201 $default_mobile_theme = $this->config->get('system', 'mobile-theme');
202 if (!$default_mobile_theme) {
203 $default_mobile_theme = 'none';
206 $user = User::getById($uid);
208 $allowed_themes = Theme::getAllowedList();
211 $mobile_themes = ['---' => $this->t('No special theme for mobile devices')];
212 foreach ($allowed_themes as $theme) {
213 $is_experimental = file_exists('view/theme/' . $theme . '/experimental');
214 $is_unsupported = file_exists('view/theme/' . $theme . '/unsupported');
215 $is_mobile = file_exists('view/theme/' . $theme . '/mobile');
216 if (!$is_experimental || $this->config->get('experimental', 'exp_themes')) {
217 $theme_name = ucfirst($theme);
218 if ($is_unsupported) {
219 $theme_name = $this->t('%s - (Unsupported)', $theme_name);
220 } elseif ($is_experimental) {
221 $theme_name = $this->t('%s - (Experimental)', $theme_name);
225 $mobile_themes[$theme] = $theme_name;
227 $themes[$theme] = $theme_name;
232 $theme_selected = $user['theme'] ?: $default_theme;
233 $mobile_theme_selected = $this->session->get('mobile-theme', $default_mobile_theme);
235 $itemspage_network = intval($this->pConfig->get($uid, 'system', 'itemspage_network'));
236 $itemspage_network = (($itemspage_network > 0 && $itemspage_network < 101) ? $itemspage_network : $this->config->get('system', 'itemspage_network'));
237 $itemspage_mobile_network = intval($this->pConfig->get($uid, 'system', 'itemspage_mobile_network'));
238 $itemspage_mobile_network = (($itemspage_mobile_network > 0 && $itemspage_mobile_network < 101) ? $itemspage_mobile_network : $this->config->get('system', 'itemspage_network_mobile'));
240 $browser_update = intval($this->pConfig->get($uid, 'system', 'update_interval'));
241 if ($browser_update != -1) {
242 $browser_update = (($browser_update == 0) ? 40 : $browser_update / 1000); // default if not set: 40 seconds
245 $enable_smile = !$this->pConfig->get($uid, 'system', 'no_smilies', 0);
246 $infinite_scroll = $this->pConfig->get($uid, 'system', 'infinite_scroll', 0);
247 $enable_smart_threading = !$this->pConfig->get($uid, 'system', 'no_smart_threading', 0);
248 $enable_dislike = !$this->pConfig->get($uid, 'system', 'hide_dislike', 0);
249 $display_resharer = $this->pConfig->get($uid, 'system', 'display_resharer', 0);
250 $stay_local = $this->pConfig->get($uid, 'system', 'stay_local', 0);
252 $preview_mode = $this->pConfig->get($uid, 'system', 'preview_mode', BBCode::PREVIEW_LARGE);
254 BBCode::PREVIEW_NONE => $this->t('No preview'),
255 BBCode::PREVIEW_NO_IMAGE => $this->t('No image'),
256 BBCode::PREVIEW_SMALL => $this->t('Small Image'),
257 BBCode::PREVIEW_LARGE => $this->t('Large Image'),
260 $bookmarked_timelines = $this->pConfig->get($uid, 'system', 'network_timelines', $this->getAvailableTimelines($uid, true)->column('code'));
261 $enabled_timelines = $this->pConfig->get($uid, 'system', 'enabled_timelines', $this->getAvailableTimelines($uid, false)->column('code'));
262 $channel_languages = $this->pConfig->get($uid, 'channel', 'languages', [User::getLanguageCode($uid)]);
263 $languages = $this->l10n->getAvailableLanguages(true);
266 foreach ($this->getAvailableTimelines($uid) as $timeline) {
268 'label' => $timeline->label,
269 'description' => $timeline->description,
270 'enable' => ["enable[{$timeline->code}]", '', in_array($timeline->code, $enabled_timelines)],
271 'bookmark' => ["bookmark[{$timeline->code}]", '', in_array($timeline->code, $bookmarked_timelines)],
275 $first_day_of_week = $this->pConfig->get($uid, 'calendar', 'first_day_of_week', 0);
277 0 => $this->t('Sunday'),
278 1 => $this->t('Monday'),
279 2 => $this->t('Tuesday'),
280 3 => $this->t('Wednesday'),
281 4 => $this->t('Thursday'),
282 5 => $this->t('Friday'),
283 6 => $this->t('Saturday')
286 $calendar_default_view = $this->pConfig->get($uid, 'calendar', 'default_view', 'month');
288 'month' => $this->t('month'),
289 'agendaWeek' => $this->t('week'),
290 'agendaDay' => $this->t('day'),
291 'listMonth' => $this->t('list')
295 if ($themeconfigfile = Theme::getConfigFile($theme_selected)) {
296 require_once $themeconfigfile;
297 $theme_config = theme_content($this->app);
300 $tpl = Renderer::getMarkupTemplate('settings/display.tpl');
301 return Renderer::replaceMacros($tpl, [
302 '$ptitle' => $this->t('Display Settings'),
303 '$submit' => $this->t('Save Settings'),
304 '$d_tset' => $this->t('General Theme Settings'),
305 '$d_ctset' => $this->t('Custom Theme Settings'),
306 '$d_cset' => $this->t('Content Settings'),
307 '$stitle' => $this->t('Theme settings'),
308 '$timeline_title' => $this->t('Timelines'),
309 '$channel_title' => $this->t('Channels'),
310 '$calendar_title' => $this->t('Calendar'),
312 '$form_security_token' => self::getFormSecurityToken('settings_display'),
315 '$theme' => ['theme', $this->t('Display Theme:'), $theme_selected, '', $themes, true],
316 '$mobile_theme' => ['mobile_theme', $this->t('Mobile Theme:'), $mobile_theme_selected, '', $mobile_themes, false],
317 '$theme_config' => $theme_config,
319 '$itemspage_network' => ['itemspage_network' , $this->t('Number of items to display per page:'), $itemspage_network, $this->t('Maximum of 100 items')],
320 '$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')],
321 '$ajaxint' => ['browser_update' , $this->t('Update browser every xx seconds'), $browser_update, $this->t('Minimum of 10 seconds. Enter -1 to disable it.')],
322 '$enable_smile' => ['enable_smile' , $this->t('Display emoticons'), $enable_smile, $this->t('When enabled, emoticons are replaced with matching symbols.')],
323 '$infinite_scroll' => ['infinite_scroll' , $this->t('Infinite scroll'), $infinite_scroll, $this->t('Automatic fetch new items when reaching the page end.')],
324 '$enable_smart_threading' => ['enable_smart_threading' , $this->t('Enable Smart Threading'), $enable_smart_threading, $this->t('Enable the automatic suppression of extraneous thread indentation.')],
325 '$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.')],
326 '$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.')],
327 '$stay_local' => ['stay_local' , $this->t('Stay local'), $stay_local, $this->t("Don't go to a remote system when following a contact link.")],
328 '$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],
330 '$timeline_label' => $this->t('Label'),
331 '$timeline_descriptiom' => $this->t('Description'),
332 '$timeline_enable' => $this->t('Enable'),
333 '$timeline_bookmark' => $this->t('Bookmark'),
334 '$timelines' => $timelines,
335 '$timeline_explanation' => $this->t('Enable timelines that you want to see in the channels widget. Bookmark timelines that you want to see in the top menu.'),
337 '$channel_languages' => ['channel_languages[]', $this->t('Channel languages:'), $channel_languages, $this->t('Select all languages that you want to see in your channels.'), $languages, 'multiple'],
339 '$first_day_of_week' => ['first_day_of_week' , $this->t('Beginning of week:') , $first_day_of_week , '', $weekdays , false],
340 '$calendar_default_view' => ['calendar_default_view', $this->t('Default calendar view:'), $calendar_default_view, '', $calendarViews, false],
344 private function getAvailableTimelines(int $uid, bool $only_network = false): Timelines
348 foreach ($this->network->getTimelines('') as $channel) {
349 $timelines[] = $channel;
353 return new Timelines($timelines);
356 foreach ($this->channel->getTimelines($uid) as $channel) {
357 $timelines[] = $channel;
360 foreach ($this->userDefinedChannel->selectByUid($uid) as $channel) {
361 $timelines[] = $channel;
364 foreach ($this->community->getTimelines(true) as $community) {
365 $timelines[] = $community;
368 return new Timelines($timelines);