Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 73
0.00% covered (danger)
0.00%
0 / 5
CRAP
0.00% covered (danger)
0.00%
0 / 1
PreferenceHooks
0.00% covered (danger)
0.00%
0 / 73
0.00% covered (danger)
0.00%
0 / 5
930
0.00% covered (danger)
0.00%
0 / 1
 __construct
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
2
 arrayRenameKey
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
12
 onGetPreferences
0.00% covered (danger)
0.00%
0 / 51
0.00% covered (danger)
0.00%
0 / 1
420
 onGetBetaFeaturePreferences
0.00% covered (danger)
0.00%
0 / 9
0.00% covered (danger)
0.00%
0 / 1
12
 onLocalUserCreated
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 1
12
1<?php
2/**
3 * DiscussionTools preference hooks
4 *
5 * @file
6 * @ingroup Extensions
7 * @license MIT
8 */
9
10namespace MediaWiki\Extension\DiscussionTools\Hooks;
11
12use Config;
13use ConfigFactory;
14use Html;
15use MediaWiki\Auth\Hook\LocalUserCreatedHook;
16use MediaWiki\Linker\LinkRenderer;
17use MediaWiki\MediaWikiServices;
18use MediaWiki\Preferences\Hook\GetPreferencesHook;
19use RequestContext;
20use SpecialPage;
21use User;
22
23class PreferenceHooks implements
24    LocalUserCreatedHook,
25    GetPreferencesHook
26{
27
28    private Config $config;
29    private LinkRenderer $linkRenderer;
30
31    public function __construct(
32        ConfigFactory $configFactory,
33        LinkRenderer $linkRenderer
34    ) {
35        $this->config = $configFactory->makeConfig( 'discussiontools' );
36        $this->linkRenderer = $linkRenderer;
37    }
38
39    /**
40     * Rename a key in an array while preserving the order of associative array keys.
41     *
42     * @param array $array
43     * @param string $from
44     * @param string $to
45     * @return array Modified array
46     */
47    private static function arrayRenameKey( array $array, string $from, string $to ): array {
48        $out = [];
49        foreach ( $array as $key => $value ) {
50            if ( $key === $from ) {
51                $key = $to;
52            }
53            $out[$key] = $value;
54        }
55        return $out;
56    }
57
58    /**
59     * Handler for the GetPreferences hook, to add and hide user preferences as configured
60     *
61     * @param User $user
62     * @param array &$preferences
63     */
64    public function onGetPreferences( $user, &$preferences ) {
65        if ( HookUtils::isFeatureAvailableToUser( $user ) ) {
66            $preferences['discussiontools-summary'] = [
67                'type' => 'info',
68                'default' => wfMessage( 'discussiontools-preference-summary' )->parse(),
69                'raw' => true,
70                'section' => 'editing/discussion',
71            ];
72        }
73        foreach ( HookUtils::FEATURES as $feature ) {
74            if (
75                $feature === HookUtils::VISUALENHANCEMENTS_REPLY ||
76                $feature === HookUtils::VISUALENHANCEMENTS_PAGEFRAME
77            ) {
78                // Feature is never user-configurable
79                continue;
80            }
81            if ( HookUtils::isFeatureAvailableToUser( $user, $feature ) ) {
82                $preferences["discussiontools-$feature"] = [
83                    'type' => 'toggle',
84                    'label-message' => "discussiontools-preference-$feature",
85                    'help-message' => "discussiontools-preference-$feature-help",
86                    'section' => 'editing/discussion',
87                ];
88
89                // Option to enable/disable new topic tool on pages that haven't been created
90                // (it's inside this loop to place the options in a nice order)
91                if ( $feature === HookUtils::NEWTOPICTOOL ) {
92                    $preferences["discussiontools-newtopictool-createpage"] = [
93                        'type' => 'radio',
94                        'cssclass' => 'mw-htmlform-checkradio-indent',
95                        'label-message' => 'discussiontools-preference-newtopictool-createpage',
96                        'options-messages' => [
97                            'discussiontools-preference-newtopictool-createpage-newtopictool' => 1,
98                            'discussiontools-preference-newtopictool-createpage-editor' => 0,
99                        ],
100                        'disable-if' => [ '===', 'discussiontools-' . HookUtils::NEWTOPICTOOL, '' ],
101                        'section' => 'editing/discussion',
102                    ];
103                }
104
105                // Make this option unavailable when a conflicting Convenient Discussions gadget exists
106                // (we can't use 'disable-if' or 'hide-if', because they don't let us change the labels).
107                if ( HookUtils::featureConflictsWithGadget( $user, $feature ) ) {
108                    $preferences["discussiontools-$feature"]['disabled'] = true;
109                    $preferences["discussiontools-$feature"]['help-message'] =
110                        [ 'discussiontools-preference-gadget-conflict', 'Special:Preferences#mw-prefsection-gadgets' ];
111                }
112            }
113        }
114
115        if ( isset( $preferences['discussiontools-' . HookUtils::SOURCEMODETOOLBAR] ) && (
116            isset( $preferences['discussiontools-' . HookUtils::REPLYTOOL] ) ||
117            isset( $preferences['discussiontools-' . HookUtils::NEWTOPICTOOL] )
118        ) ) {
119            // Disable this option when it would have no effect
120            // (both reply tool and new topic tool are disabled)
121            $preferences['discussiontools-' . HookUtils::SOURCEMODETOOLBAR]['disable-if'] = [ 'AND' ];
122
123            if ( isset( $preferences['discussiontools-' . HookUtils::REPLYTOOL] ) &&
124                // GlobalPreferences extension would delete disabled fields, avoid referring to it.
125                !( $preferences['discussiontools-' . HookUtils::REPLYTOOL]['disabled'] ?? false )
126            ) {
127                $preferences['discussiontools-' . HookUtils::SOURCEMODETOOLBAR]['disable-if'][] = [
128                    '===', 'discussiontools-' . HookUtils::REPLYTOOL, ''
129                ];
130            }
131            if ( isset( $preferences['discussiontools-' . HookUtils::NEWTOPICTOOL] ) ) {
132                $preferences['discussiontools-' . HookUtils::SOURCEMODETOOLBAR]['disable-if'][] = [
133                    '===', 'discussiontools-' . HookUtils::NEWTOPICTOOL, ''
134                ];
135            }
136        }
137
138        if ( isset( $preferences['discussiontools-' . HookUtils::AUTOTOPICSUB] ) &&
139            isset( $preferences['discussiontools-' . HookUtils::TOPICSUBSCRIPTION] )
140        ) {
141            // Disable automatic subscriptions when subscriptions are disabled
142            $preferences['discussiontools-' . HookUtils::AUTOTOPICSUB]['disable-if'] = [
143                '===', 'discussiontools-' . HookUtils::TOPICSUBSCRIPTION, ''
144            ];
145        }
146
147        $preferences['discussiontools-showadvanced'] = [
148            'type' => 'api',
149        ];
150        $preferences['discussiontools-newtopictool-opened'] = [
151            'type' => 'api',
152        ];
153        $preferences['discussiontools-newtopictool-hint-shown'] = [
154            'type' => 'api',
155        ];
156        $preferences['discussiontools-seenautotopicsubpopup'] = [
157            'type' => 'api',
158        ];
159
160        if (
161            !$this->config->get( 'DiscussionToolsEnable' ) ||
162            !$this->config->get( 'DiscussionToolsBeta' )
163        ) {
164            // When out of beta, preserve the user preference in case we
165            // bring back the beta feature for a new sub-feature. (T272071)
166            $preferences['discussiontools-betaenable'] = [
167                'type' => 'api'
168            ];
169        }
170
171        $preferences['discussiontools-editmode'] = [
172            'type' => 'api',
173            'validation-callback' => static function ( $value ) {
174                return in_array( $value, [ '', 'source', 'visual' ], true );
175            },
176        ];
177
178        // Add a link to Special:TopicSubscriptions to the Echo preferences matrix
179        $categoryMessage = wfMessage( 'echo-category-title-dt-subscription' )->numParams( 1 )->escaped();
180        $categoryMessageExtra = $categoryMessage .
181            Html::element( 'br' ) .
182            wfMessage( 'parentheses' )->rawParams(
183                $this->linkRenderer->makeLink(
184                    SpecialPage::getTitleFor( 'TopicSubscriptions' ),
185                    wfMessage( 'discussiontools-topicsubscription-preferences-editsubscriptions' )->text()
186                )
187            )->escaped();
188        if ( isset( $preferences['echo-subscriptions']['rows'] ) ) {
189            $preferences['echo-subscriptions']['rows'] = static::arrayRenameKey(
190                $preferences['echo-subscriptions']['rows'],
191                $categoryMessage,
192                $categoryMessageExtra
193            );
194        }
195        if ( isset( $preferences['echo-subscriptions']['tooltips'] ) ) {
196            $preferences['echo-subscriptions']['tooltips'] = static::arrayRenameKey(
197                // Phan insists that this key doesn't exist, even though we just checked with isset()
198                // @phan-suppress-next-line PhanTypeInvalidDimOffset, PhanTypeMismatchArgument
199                $preferences['echo-subscriptions']['tooltips'],
200                $categoryMessage,
201                $categoryMessageExtra
202            );
203        }
204    }
205
206    /**
207     * Handler for the GetBetaFeaturePreferences hook, to add and hide user beta preferences as configured
208     *
209     * @param User $user
210     * @param array &$preferences
211     */
212    public static function onGetBetaFeaturePreferences( User $user, array &$preferences ): void {
213        $coreConfig = RequestContext::getMain()->getConfig();
214        $iconpath = $coreConfig->get( 'ExtensionAssetsPath' ) . '/DiscussionTools/images';
215
216        $dtConfig = MediaWikiServices::getInstance()->getConfigFactory()
217            ->makeConfig( 'discussiontools' );
218
219        if (
220            $dtConfig->get( 'DiscussionToolsEnable' ) &&
221            $dtConfig->get( 'DiscussionToolsBeta' )
222        ) {
223            $preferences['discussiontools-betaenable'] = [
224                'version' => '1.0',
225                'label-message' => 'discussiontools-preference-label',
226                'desc-message' => 'discussiontools-preference-description',
227                'screenshot' => [
228                    'ltr' => "$iconpath/betafeatures-icon-DiscussionTools-ltr.svg",
229                    'rtl' => "$iconpath/betafeatures-icon-DiscussionTools-rtl.svg",
230                ],
231                'info-message' => 'discussiontools-preference-info-link',
232                'discussion-message' => 'discussiontools-preference-discussion-link',
233                'requirements' => [
234                    'javascript' => true
235                ]
236            ];
237        }
238    }
239
240    /**
241     * Handler for LocalUserCreated hook.
242     * @see https://www.mediawiki.org/wiki/Manual:Hooks/LocalUserCreated
243     * @param User $user User object for the created user
244     * @param bool $autocreated Whether this was an auto-creation
245     * @return bool|void True or no return value to continue or false to abort
246     */
247    public function onLocalUserCreated( $user, $autocreated ) {
248        if ( !$autocreated ) {
249            $userOptionsManager = MediaWikiServices::getInstance()->getUserOptionsManager();
250            // We want new users to be created with email-subscriptions to our notifications enabled
251            $userOptionsManager->setOption( $user, 'echo-subscriptions-email-dt-subscription', true );
252            // The auto topic subscription feature is disabled by default for existing users, but
253            // we enable it for new users (T294398).
254            // This can only occur when the feature is available for everyone; when it's in beta,
255            // the new user won't have the beta enabled, so it'll never be available here.
256            if ( HookUtils::isFeatureAvailableToUser( $user, HookUtils::AUTOTOPICSUB ) ) {
257                $userOptionsManager->setOption( $user, 'discussiontools-' . HookUtils::AUTOTOPICSUB, 1 );
258            }
259        }
260    }
261
262}