Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 288
0.00% covered (danger)
0.00%
0 / 1
CRAP
0.00% covered (danger)
0.00%
0 / 1
ucp_prefs
0.00% covered (danger)
0.00%
0 / 286
0.00% covered (danger)
0.00%
0 / 1
1640
0.00% covered (danger)
0.00%
0 / 1
 main
0.00% covered (danger)
0.00%
0 / 286
0.00% covered (danger)
0.00%
0 / 1
1640
1<?php
2/**
3*
4* This file is part of the phpBB Forum Software package.
5*
6* @copyright (c) phpBB Limited <https://www.phpbb.com>
7* @license GNU General Public License, version 2 (GPL-2.0)
8*
9* For full copyright and license information, please see
10* the docs/CREDITS.txt file.
11*
12*/
13
14use phpbb\messenger\method\messenger_interface;
15
16/**
17* @ignore
18*/
19if (!defined('IN_PHPBB'))
20{
21    exit;
22}
23
24/**
25* ucp_prefs
26* Changing user preferences
27*/
28class ucp_prefs
29{
30    var $u_action;
31
32    function main($id, $mode)
33    {
34        global $config, $db, $user, $auth, $template, $phpbb_dispatcher, $request;
35
36        $submit = (isset($_POST['submit'])) ? true : false;
37        $error = $data = array();
38        $s_hidden_fields = '';
39
40        switch ($mode)
41        {
42            case 'personal':
43                add_form_key('ucp_prefs_personal');
44                $data = array(
45                    'dateformat'    => $request->variable('dateformat', $user->data['user_dateformat'], true),
46                    'lang'            => basename($request->variable('lang', $user->data['user_lang'])),
47                    'user_style'        => $request->variable('user_style', (int) $user->data['user_style']),
48                    'tz'            => $request->variable('tz', $user->data['user_timezone']),
49
50                    'viewemail'        => $request->variable('viewemail', (bool) $user->data['user_allow_viewemail']),
51                    'massemail'        => $request->variable('massemail', (bool) $user->data['user_allow_massemail']),
52                    'hideonline'    => $request->variable('hideonline', (bool) !$user->data['user_allow_viewonline']),
53                    'allowpm'        => $request->variable('allowpm', (bool) $user->data['user_allow_pm']),
54                );
55
56                /**
57                * Add UCP edit global settings data before they are assigned to the template or submitted
58                *
59                * To assign data to the template, use $template->assign_vars()
60                *
61                * @event core.ucp_prefs_personal_data
62                * @var    bool    submit        Do we display the form only
63                *                            or did the user press submit
64                * @var    array    data        Array with current ucp options data
65                * @var    array    error        Array with list of errors
66                * @since 3.1.0-a1
67                * @changed 3.1.4-RC1 Added error variable to the event
68                */
69                $vars = array('submit', 'data', 'error');
70                extract($phpbb_dispatcher->trigger_event('core.ucp_prefs_personal_data', compact($vars)));
71
72                if ($submit)
73                {
74                    if ($config['override_user_style'])
75                    {
76                        $data['user_style'] = (int) $config['default_style'];
77                    }
78                    else if (!phpbb_style_is_active($data['user_style']))
79                    {
80                        $data['user_style'] = (int) $user->data['user_style'];
81                    }
82
83                    $error = array_merge(validate_data($data, array(
84                        'dateformat'    => array('string', false, 1, 64),
85                        'lang'            => array('language_iso_name'),
86                        'tz'            => array('timezone'),
87                    )), $error);
88
89                    if (!check_form_key('ucp_prefs_personal'))
90                    {
91                        $error[] = 'FORM_INVALID';
92                    }
93
94                    if (!count($error))
95                    {
96                        $sql_ary = array(
97                            'user_allow_pm'            => $data['allowpm'],
98                            'user_allow_viewemail'    => $data['viewemail'],
99                            'user_allow_massemail'    => $data['massemail'],
100                            'user_allow_viewonline'    => ($auth->acl_get('u_hideonline')) ? !$data['hideonline'] : $user->data['user_allow_viewonline'],
101                            'user_options'            => $user->data['user_options'],
102
103                            'user_dateformat'        => $data['dateformat'],
104                            'user_lang'                => $data['lang'],
105                            'user_timezone'            => $data['tz'],
106                            'user_style'            => $data['user_style'],
107                        );
108
109                        /**
110                        * Update UCP edit global settings data on form submit
111                        *
112                        * @event core.ucp_prefs_personal_update_data
113                        * @var    array    data        Submitted display options data
114                        * @var    array    sql_ary        Display options data we update
115                        * @since 3.1.0-a1
116                        */
117                        $vars = array('data', 'sql_ary');
118                        extract($phpbb_dispatcher->trigger_event('core.ucp_prefs_personal_update_data', compact($vars)));
119
120                        $sql = 'UPDATE ' . USERS_TABLE . '
121                            SET ' . $db->sql_build_array('UPDATE', $sql_ary) . '
122                            WHERE user_id = ' . $user->data['user_id'];
123                        $db->sql_query($sql);
124
125                        meta_refresh(3, $this->u_action);
126                        $message = $user->lang['PREFERENCES_UPDATED'] . '<br /><br />' . sprintf($user->lang['RETURN_UCP'], '<a href="' . $this->u_action . '">', '</a>');
127                        trigger_error($message);
128                    }
129
130                    // Replace "error" strings with their real, localised form
131                    $error = array_map(array($user, 'lang'), $error);
132                }
133
134                $dateformat_options = '';
135
136                foreach ($user->lang['dateformats'] as $format => $null)
137                {
138                    $dateformat_options .= '<option value="' . $format . '"' . (($format == $data['dateformat']) ? ' selected="selected"' : '') . '>';
139                    $dateformat_options .= $user->format_date(time(), $format, false) . ((strpos($format, '|') !== false) ? $user->lang['VARIANT_DATE_SEPARATOR'] . $user->format_date(time(), $format, true) : '');
140                    $dateformat_options .= '</option>';
141                }
142
143                $s_custom = false;
144
145                $dateformat_options .= '<option value="custom"';
146                if (!isset($user->lang['dateformats'][$data['dateformat']]))
147                {
148                    $dateformat_options .= ' selected="selected"';
149                    $s_custom = true;
150                }
151                $dateformat_options .= '>' . $user->lang['CUSTOM_DATEFORMAT'] . '</option>';
152
153                $timezone_select = phpbb_timezone_select($user, $data['tz'], true);
154
155                // check if there are any user-selectable languages
156                $sql = 'SELECT lang_iso, lang_local_name
157                    FROM ' . LANG_TABLE . '
158                    ORDER BY lang_english_name';
159                $result = $db->sql_query($sql);
160                $lang_row = (array) $db->sql_fetchrowset($result);
161                $db->sql_freeresult($result);
162                $s_more_languages = count($lang_row) > 1;
163
164                // check if there are any user-selectable styles
165                $sql = 'SELECT style_id, style_name
166                    FROM ' . STYLES_TABLE . '
167                    WHERE style_active = 1
168                    ORDER BY style_name';
169                $result = $db->sql_query($sql);
170                $styles_row = (array) $db->sql_fetchrowset($result);
171                $db->sql_freeresult($result);
172                $s_more_styles = count($styles_row) > 1;
173
174                $lang_options = phpbb_language_select($db, $data['lang'], $lang_row);
175
176                $template->assign_vars([
177                    'ERROR'                => (count($error)) ? implode('<br />', $error) : '',
178
179                    'S_VIEW_EMAIL'        => $data['viewemail'],
180                    'S_MASS_EMAIL'        => $data['massemail'],
181                    'S_ALLOW_PM'        => $data['allowpm'],
182                    'S_HIDE_ONLINE'        => $data['hideonline'],
183
184                    'DATE_FORMAT'            => $data['dateformat'],
185                    'A_DATE_FORMAT'            => addslashes($data['dateformat']),
186                    'S_DATEFORMAT_OPTIONS'    => $dateformat_options,
187                    'S_CUSTOM_DATEFORMAT'    => $s_custom,
188                    'DEFAULT_DATEFORMAT'    => $config['default_dateformat'],
189                    'A_DEFAULT_DATEFORMAT'    => addslashes($config['default_dateformat']),
190
191                    'S_MORE_LANGUAGES'        => $s_more_languages,
192                    'S_MORE_STYLES'            => $s_more_styles,
193
194                    'LANG_OPTIONS'            => [
195                        'id'        => 'lang',
196                        'name'        => 'lang',
197                        'options'    => $lang_options,
198                    ],
199                    'S_STYLE_OPTIONS'        => ($config['override_user_style']) ? '' : [
200                        'id'        => 'user_style',
201                        'name'        => 'user_style',
202                        'options'    => style_select($data['user_style'], false, $styles_row)
203                    ],
204                    'TIMEZONE_OPTIONS'    => [
205                        'tag'        => 'select',
206                        'name'        => 'tz',
207                        'options'    => $timezone_select,
208                    ],
209                    'S_CAN_HIDE_ONLINE'    => (bool) $auth->acl_get('u_hideonline'),
210                ]);
211
212            break;
213
214            case 'view':
215
216                add_form_key('ucp_prefs_view');
217
218                $data = array(
219                    'topic_sk'        => $request->variable('topic_sk', (!empty($user->data['user_topic_sortby_type'])) ? $user->data['user_topic_sortby_type'] : 't'),
220                    'topic_sd'        => $request->variable('topic_sd', (!empty($user->data['user_topic_sortby_dir'])) ? $user->data['user_topic_sortby_dir'] : 'd'),
221                    'topic_st'        => $request->variable('topic_st', (!empty($user->data['user_topic_show_days'])) ? (int) $user->data['user_topic_show_days'] : 0),
222
223                    'post_sk'        => $request->variable('post_sk', (!empty($user->data['user_post_sortby_type'])) ? $user->data['user_post_sortby_type'] : 't'),
224                    'post_sd'        => $request->variable('post_sd', (!empty($user->data['user_post_sortby_dir'])) ? $user->data['user_post_sortby_dir'] : 'a'),
225                    'post_st'        => $request->variable('post_st', (!empty($user->data['user_post_show_days'])) ? (int) $user->data['user_post_show_days'] : 0),
226
227                    'images'        => $request->variable('images', (bool) $user->optionget('viewimg')),
228                    'smilies'        => $request->variable('smilies', (bool) $user->optionget('viewsmilies')),
229                    'sigs'            => $request->variable('sigs', (bool) $user->optionget('viewsigs')),
230                    'avatars'        => $request->variable('avatars', (bool) $user->optionget('viewavatars')),
231                    'wordcensor'    => $request->variable('wordcensor', (bool) $user->optionget('viewcensors')),
232                );
233
234                /**
235                * Add UCP edit display options data before they are assigned to the template or submitted
236                *
237                * To assign data to the template, use $template->assign_vars()
238                *
239                * @event core.ucp_prefs_view_data
240                * @var    bool    submit        Do we display the form only
241                *                            or did the user press submit
242                * @var    array    data        Array with current ucp options data
243                * @since 3.1.0-a1
244                */
245                $vars = array('submit', 'data');
246                extract($phpbb_dispatcher->trigger_event('core.ucp_prefs_view_data', compact($vars)));
247
248                if ($submit)
249                {
250                    $error = validate_data($data, array(
251                        'topic_sk'    => array(
252                            array('string', false, 1, 1),
253                            array('match', false, '#(a|r|s|t|v)#'),
254                        ),
255                        'topic_sd'    => array(
256                            array('string', false, 1, 1),
257                            array('match', false, '#(a|d)#'),
258                        ),
259                        'post_sk'    => array(
260                            array('string', false, 1, 1),
261                            array('match', false, '#(a|s|t)#'),
262                        ),
263                        'post_sd'    => array(
264                            array('string', false, 1, 1),
265                            array('match', false, '#(a|d)#'),
266                        ),
267                    ));
268
269                    if (!check_form_key('ucp_prefs_view'))
270                    {
271                        $error[] = 'FORM_INVALID';
272                    }
273
274                    if (!count($error))
275                    {
276                        $user->optionset('viewimg', $data['images']);
277                        $user->optionset('viewsmilies', $data['smilies']);
278                        $user->optionset('viewsigs', $data['sigs']);
279                        $user->optionset('viewavatars', $data['avatars']);
280
281                        if ($auth->acl_get('u_chgcensors'))
282                        {
283                            $user->optionset('viewcensors', $data['wordcensor']);
284                        }
285
286                        $sql_ary = array(
287                            'user_options'                => $user->data['user_options'],
288                            'user_topic_sortby_type'    => $data['topic_sk'],
289                            'user_post_sortby_type'        => $data['post_sk'],
290                            'user_topic_sortby_dir'        => $data['topic_sd'],
291                            'user_post_sortby_dir'        => $data['post_sd'],
292
293                            'user_topic_show_days'    => $data['topic_st'],
294                            'user_post_show_days'    => $data['post_st'],
295                        );
296
297                        /**
298                        * Update UCP edit display options data on form submit
299                        *
300                        * @event core.ucp_prefs_view_update_data
301                        * @var    array    data        Submitted display options data
302                        * @var    array    sql_ary        Display options data we update
303                        * @since 3.1.0-a1
304                        */
305                        $vars = array('data', 'sql_ary');
306                        extract($phpbb_dispatcher->trigger_event('core.ucp_prefs_view_update_data', compact($vars)));
307
308                        $sql = 'UPDATE ' . USERS_TABLE . '
309                            SET ' . $db->sql_build_array('UPDATE', $sql_ary) . '
310                            WHERE user_id = ' . $user->data['user_id'];
311                        $db->sql_query($sql);
312
313                        meta_refresh(3, $this->u_action);
314                        $message = $user->lang['PREFERENCES_UPDATED'] . '<br /><br />' . sprintf($user->lang['RETURN_UCP'], '<a href="' . $this->u_action . '">', '</a>');
315                        trigger_error($message);
316                    }
317
318                    // Replace "error" strings with their real, localised form
319                    $error = array_map(array($user, 'lang'), $error);
320                }
321
322                $sort_dir_text = array('a' => $user->lang['ASCENDING'], 'd' => $user->lang['DESCENDING']);
323
324                // Topic ordering options
325                $limit_topic_days = array(0 => $user->lang['ALL_TOPICS'], 1 => $user->lang['1_DAY'], 7 => $user->lang['7_DAYS'], 14 => $user->lang['2_WEEKS'], 30 => $user->lang['1_MONTH'], 90 => $user->lang['3_MONTHS'], 180 => $user->lang['6_MONTHS'], 365 => $user->lang['1_YEAR']);
326
327                $sort_by_topic_text = array('a' => $user->lang['AUTHOR'], 't' => $user->lang['POST_TIME'], 'r' => $user->lang['REPLIES'], 's' => $user->lang['SUBJECT'], 'v' => $user->lang['VIEWS']);
328                $sort_by_topic_sql = array('a' => 't.topic_first_poster_name', 't' => array('t.topic_last_post_time', 't.topic_last_post_id'), 'r' => 't.topic_posts_approved', 's' => 't.topic_title', 'v' => 't.topic_views');
329
330                // Post ordering options
331                $limit_post_days = array(0 => $user->lang['ALL_POSTS'], 1 => $user->lang['1_DAY'], 7 => $user->lang['7_DAYS'], 14 => $user->lang['2_WEEKS'], 30 => $user->lang['1_MONTH'], 90 => $user->lang['3_MONTHS'], 180 => $user->lang['6_MONTHS'], 365 => $user->lang['1_YEAR']);
332
333                $sort_by_post_text = array('a' => $user->lang['AUTHOR'], 't' => $user->lang['POST_TIME'], 's' => $user->lang['SUBJECT']);
334                $sort_by_post_sql = array('a' => 'u.username_clean', 't' => 'p.post_id', 's' => 'p.post_subject');
335
336                $_options = array('topic', 'post');
337                foreach ($_options as $sort_option)
338                {
339                    ${'s_limit_' . $sort_option . '_days'} = '<select name="' . $sort_option . '_st">';
340                    foreach (${'limit_' . $sort_option . '_days'} as $day => $text)
341                    {
342                        $selected = ($data[$sort_option . '_st'] == $day) ? ' selected="selected"' : '';
343                        ${'s_limit_' . $sort_option . '_days'} .= '<option value="' . $day . '"' . $selected . '>' . $text . '</option>';
344                    }
345                    ${'s_limit_' . $sort_option . '_days'} .= '</select>';
346
347                    ${'s_sort_' . $sort_option . '_key'} = '<select name="' . $sort_option . '_sk">';
348                    foreach (${'sort_by_' . $sort_option . '_text'} as $key => $text)
349                    {
350                        $selected = ($data[$sort_option . '_sk'] == $key) ? ' selected="selected"' : '';
351                        ${'s_sort_' . $sort_option . '_key'} .= '<option value="' . $key . '"' . $selected . '>' . $text . '</option>';
352                    }
353                    ${'s_sort_' . $sort_option . '_key'} .= '</select>';
354
355                    ${'s_sort_' . $sort_option . '_dir'} = '<select name="' . $sort_option . '_sd">';
356                    foreach ($sort_dir_text as $key => $value)
357                    {
358                        $selected = ($data[$sort_option . '_sd'] == $key) ? ' selected="selected"' : '';
359                        ${'s_sort_' . $sort_option . '_dir'} .= '<option value="' . $key . '"' . $selected . '>' . $value . '</option>';
360                    }
361                    ${'s_sort_' . $sort_option . '_dir'} .= '</select>';
362                }
363
364                /**
365                * Run code before view form is displayed
366                *
367                * @event core.ucp_prefs_view_after
368                * @var    bool    submit                Do we display the form only
369                *                                    or did the user press submit
370                * @var    array    data                Array with current ucp options data
371                * @var    array    sort_dir_text        Array with sort dir language strings
372                * @var    array    limit_topic_days    Topic ordering options
373                * @var    array    sort_by_topic_text    Topic ordering language strings
374                * @var    array    sort_by_topic_sql    Topic ordering sql
375                * @var    array    limit_post_days        Post ordering options
376                * @var    array    sort_by_post_text    Post ordering language strings
377                * @var    array    sort_by_post_sql    Post ordering sql
378                * @var    array    _options            Sort options
379                * @var    string    s_limit_topic_days    Sort limit topic by days select box
380                * @var    string    s_sort_topic_key    Sort topic key select box
381                * @var    string    s_sort_topic_dir    Sort topic dir select box
382                * @var    string    s_limit_post_days    Sort limit post by days select box
383                * @var    string    s_sort_post_key        Sort post key select box
384                * @var    string    s_sort_post_dir        Sort post dir select box
385                * @since 3.1.8-RC1
386                */
387                $vars = array(
388                    'submit',
389                    'data',
390                    'sort_dir_text',
391                    'limit_topic_days',
392                    'sort_by_topic_text',
393                    'sort_by_topic_sql',
394                    'limit_post_days',
395                    'sort_by_post_text',
396                    'sort_by_post_sql',
397                    '_options',
398                    's_limit_topic_days',
399                    's_sort_topic_key',
400                    's_sort_topic_dir',
401                    's_limit_post_days',
402                    's_sort_post_key',
403                    's_sort_post_dir',
404                );
405                extract($phpbb_dispatcher->trigger_event('core.ucp_prefs_view_after', compact($vars)));
406
407                $template->assign_vars(array(
408                    'ERROR'                => (count($error)) ? implode('<br />', $error) : '',
409
410                    'S_IMAGES'            => $data['images'],
411                    'S_SMILIES'            => $data['smilies'],
412                    'S_SIGS'            => $data['sigs'],
413                    'S_AVATARS'            => $data['avatars'],
414                    'S_DISABLE_CENSORS'    => $data['wordcensor'],
415
416                    'S_CHANGE_CENSORS'        => ($auth->acl_get('u_chgcensors') && $config['allow_nocensors']) ? true : false,
417
418                    'S_TOPIC_SORT_DAYS'        => $s_limit_topic_days,
419                    'S_TOPIC_SORT_KEY'        => $s_sort_topic_key,
420                    'S_TOPIC_SORT_DIR'        => $s_sort_topic_dir,
421                    'S_POST_SORT_DAYS'        => $s_limit_post_days,
422                    'S_POST_SORT_KEY'        => $s_sort_post_key,
423                    'S_POST_SORT_DIR'        => $s_sort_post_dir)
424                );
425
426            break;
427
428            case 'post':
429
430                $data = array(
431                    'bbcode'    => $request->variable('bbcode', $user->optionget('bbcode')),
432                    'smilies'    => $request->variable('smilies', $user->optionget('smilies')),
433                    'sig'        => $request->variable('sig', $user->optionget('attachsig')),
434                    'notify'    => $request->variable('notify', (bool) $user->data['user_notify']),
435                );
436                add_form_key('ucp_prefs_post');
437
438                /**
439                * Add UCP edit posting defaults data before they are assigned to the template or submitted
440                *
441                * To assign data to the template, use $template->assign_vars()
442                *
443                * @event core.ucp_prefs_post_data
444                * @var    bool    submit        Do we display the form only
445                *                            or did the user press submit
446                * @var    array    data        Array with current ucp options data
447                * @since 3.1.0-a1
448                */
449                $vars = array('submit', 'data');
450                extract($phpbb_dispatcher->trigger_event('core.ucp_prefs_post_data', compact($vars)));
451
452                if ($submit)
453                {
454                    if (check_form_key('ucp_prefs_post'))
455                    {
456                        $user->optionset('bbcode', $data['bbcode']);
457                        $user->optionset('smilies', $data['smilies']);
458                        $user->optionset('attachsig', $data['sig']);
459
460                        $sql_ary = array(
461                            'user_options'    => $user->data['user_options'],
462                            'user_notify'    => $data['notify'],
463                        );
464
465                        /**
466                        * Update UCP edit posting defaults data on form submit
467                        *
468                        * @event core.ucp_prefs_post_update_data
469                        * @var    array    data        Submitted display options data
470                        * @var    array    sql_ary        Display options data we update
471                        * @since 3.1.0-a1
472                        */
473                        $vars = array('data', 'sql_ary');
474                        extract($phpbb_dispatcher->trigger_event('core.ucp_prefs_post_update_data', compact($vars)));
475
476                        $sql = 'UPDATE ' . USERS_TABLE . '
477                            SET ' . $db->sql_build_array('UPDATE', $sql_ary) . '
478                            WHERE user_id = ' . $user->data['user_id'];
479                        $db->sql_query($sql);
480
481                        $msg = $user->lang['PREFERENCES_UPDATED'];
482                    }
483                    else
484                    {
485                        $msg = $user->lang['FORM_INVALID'];
486                    }
487                    meta_refresh(3, $this->u_action);
488                    $message = $msg . '<br /><br />' . sprintf($user->lang['RETURN_UCP'], '<a href="' . $this->u_action . '">', '</a>');
489                    trigger_error($message);
490                }
491
492                $template->assign_vars(array(
493                    'S_SIG_ALLOWED'    => $config['allow_sig'] && $auth->acl_get('u_sig'),
494
495                    'S_BBCODE'    => $data['bbcode'],
496                    'S_SMILIES'    => $data['smilies'],
497                    'S_SIG'        => $data['sig'],
498                    'S_NOTIFY'    => $data['notify'])
499                );
500            break;
501        }
502
503        /**
504        * Modify UCP preferences data before the page load
505        *
506        * @event core.ucp_prefs_modify_common
507        * @var    array    data        Array with current/submitted UCP options data
508        * @var    array    error        Errors data
509        * @var    string    mode        UCP prefs operation mode
510        * @var    string    s_hidden_fields        Hidden fields data
511        * @since 3.1.0-RC3
512        */
513        $vars = array(
514            'data',
515            'error',
516            'mode',
517            's_hidden_fields',
518        );
519        extract($phpbb_dispatcher->trigger_event('core.ucp_prefs_modify_common', compact($vars)));
520
521        $template->assign_vars(array(
522            'L_TITLE'            => $user->lang['UCP_PREFS_' . strtoupper($mode)],
523
524            'S_HIDDEN_FIELDS'    => $s_hidden_fields,
525            'S_UCP_ACTION'        => $this->u_action)
526        );
527
528        $this->tpl_name = 'ucp_prefs_' . $mode;
529        $this->page_title = 'UCP_PREFS_' . strtoupper($mode);
530    }
531}