Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 122
0.00% covered (danger)
0.00%
0 / 13
CRAP
0.00% covered (danger)
0.00%
0 / 1
TopicSubscriptionsPager
0.00% covered (danger)
0.00%
0 / 122
0.00% covered (danger)
0.00%
0 / 13
1806
0.00% covered (danger)
0.00%
0 / 1
 __construct
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
2
 preprocessResults
0.00% covered (danger)
0.00%
0 / 10
0.00% covered (danger)
0.00%
0 / 1
12
 getFieldNames
0.00% covered (danger)
0.00%
0 / 7
0.00% covered (danger)
0.00%
0 / 1
2
 formatValue
0.00% covered (danger)
0.00%
0 / 31
0.00% covered (danger)
0.00%
0 / 1
90
 maybeFormatAsList
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 1
12
 formatValuePage
0.00% covered (danger)
0.00%
0 / 15
0.00% covered (danger)
0.00%
0 / 1
42
 formatValueTopic
0.00% covered (danger)
0.00%
0 / 24
0.00% covered (danger)
0.00%
0 / 1
132
 getCellAttrs
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
6
 getQueryInfo
0.00% covered (danger)
0.00%
0 / 18
0.00% covered (danger)
0.00%
0 / 1
2
 getDefaultSort
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 getDefaultDirections
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 getIndexField
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 isFieldSortable
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
6
1<?php
2
3namespace MediaWiki\Extension\DiscussionTools;
4
5use IContextSource;
6use InvalidArgumentException;
7use MediaWiki\Cache\LinkBatchFactory;
8use MediaWiki\Extension\DiscussionTools\ThreadItem\DatabaseThreadItem;
9use MediaWiki\Html\Html;
10use MediaWiki\Linker\Linker;
11use MediaWiki\Linker\LinkRenderer;
12use MediaWiki\Pager\TablePager;
13use MediaWiki\Title\Title;
14use OOUI;
15
16class TopicSubscriptionsPager extends TablePager {
17
18    /**
19     * Map of our field names (see ::getFieldNames()) to the column names actually used for
20     * pagination. This is needed to ensure that the values are unique, and that pagination
21     * won't get "stuck" when e.g. 50 subscriptions are all created within a second.
22     */
23    private const INDEX_FIELDS = [
24        // The auto-increment ID will almost always have the same order as sub_created
25        // and the field already has an index.
26        '_topic' => [ 'sub_id' ],
27        'sub_created' => [ 'sub_id' ],
28        // TODO Add indexes that cover these fields to enable sorting by them
29        // 'sub_state' => [ 'sub_state', 'sub_item' ],
30        // 'sub_created' => [ 'sub_created', 'sub_item' ],
31        // 'sub_notified' => [ 'sub_notified', 'sub_item' ],
32    ];
33
34    private LinkBatchFactory $linkBatchFactory;
35    private ThreadItemStore $threadItemStore;
36    private ThreadItemFormatter $threadItemFormatter;
37
38    /** @var array<string,DatabaseThreadItem[]> */
39    private array $threadItemsByName;
40
41    public function __construct(
42        IContextSource $context,
43        LinkRenderer $linkRenderer,
44        LinkBatchFactory $linkBatchFactory,
45        ThreadItemStore $threadItemStore,
46        ThreadItemFormatter $threadItemFormatter
47    ) {
48        parent::__construct( $context, $linkRenderer );
49        $this->linkBatchFactory = $linkBatchFactory;
50        $this->threadItemStore = $threadItemStore;
51        $this->threadItemFormatter = $threadItemFormatter;
52    }
53
54    /**
55     * @inheritDoc
56     */
57    public function preprocessResults( $result ) {
58        $lb = $this->linkBatchFactory->newLinkBatch();
59        $itemNames = [];
60        foreach ( $result as $row ) {
61            $lb->add( $row->sub_namespace, $row->sub_title );
62            $itemNames[] = $row->sub_item;
63        }
64        $lb->execute();
65
66        $this->threadItemsByName = [];
67        // Increased limit to allow finding and skipping over some bad permalinks
68        $threadItems = $this->threadItemStore->findNewestRevisionsByName( $itemNames, $this->mLimit * 5 );
69        foreach ( $threadItems as $threadItem ) {
70            $this->threadItemsByName[ $threadItem->getName() ][] = $threadItem;
71        }
72    }
73
74    /**
75     * @inheritDoc
76     */
77    protected function getFieldNames() {
78        return [
79            '_topic' => $this->msg( 'discussiontools-topicsubscription-pager-topic' )->text(),
80            '_page' => $this->msg( 'discussiontools-topicsubscription-pager-page' )->text(),
81            'sub_created' => $this->msg( 'discussiontools-topicsubscription-pager-created' )->text(),
82            'sub_notified' => $this->msg( 'discussiontools-topicsubscription-pager-notified' )->text(),
83            '_unsubscribe' => $this->msg( 'discussiontools-topicsubscription-pager-actions' )->text(),
84        ];
85    }
86
87    /**
88     * @inheritDoc
89     */
90    public function formatValue( $field, $value ) {
91        /** @var stdClass $row */
92        $row = $this->mCurrentRow;
93
94        switch ( $field ) {
95            case '_topic':
96                return $this->formatValueTopic( $row );
97
98            case '_page':
99                return $this->formatValuePage( $row );
100
101            case 'sub_created':
102                return htmlspecialchars( $this->getLanguage()->userTimeAndDate( $value, $this->getUser() ) );
103
104            case 'sub_notified':
105                return $value ?
106                    htmlspecialchars( $this->getLanguage()->userTimeAndDate( $value, $this->getUser() ) ) :
107                    $this->msg( 'discussiontools-topicsubscription-pager-notified-never' )->escaped();
108
109            case '_unsubscribe':
110                $title = Title::makeTitleSafe( $row->sub_namespace, $row->sub_title );
111                if ( !$title ) {
112                    // Handle invalid titles (T345648)
113                    // The title isn't checked when unsubscribing, as long as it's a valid title,
114                    // so specify something to make it possible to unsubscribe from the buggy entries.
115                    $title = Title::newMainPage();
116                }
117                return (string)new OOUI\ButtonWidget( [
118                    'label' => $this->msg( 'discussiontools-topicsubscription-pager-unsubscribe-button' )->text(),
119                    'classes' => [ 'ext-discussiontools-special-unsubscribe-button' ],
120                    'framed' => false,
121                    'flags' => [ 'destructive' ],
122                    'data' => [
123                        'item' => $row->sub_item,
124                        'title' => $title->getPrefixedText(),
125                    ],
126                    'href' => $title->getLinkURL( [
127                        'action' => 'dtunsubscribe',
128                        'commentname' => $row->sub_item,
129                    ] ),
130                    'infusable' => true,
131                ] );
132
133            default:
134                throw new InvalidArgumentException( "Unknown field '$field'" );
135        }
136    }
137
138    /**
139     * Format items as a HTML list, unless there's just one item, in which case return it unwrapped.
140     * @param string[] $list HTML
141     * @return string HTML
142     */
143    private function maybeFormatAsList( array $list ): string {
144        if ( count( $list ) === 1 ) {
145            return $list[0];
146        } else {
147            foreach ( $list as &$item ) {
148                $item = Html::rawElement( 'li', [], $item );
149            }
150            return Html::rawElement( 'ul', [], implode( '', $list ) );
151        }
152    }
153
154    private function formatValuePage( \stdClass $row ): string {
155        $linkRenderer = $this->getLinkRenderer();
156
157        if ( isset( $this->threadItemsByName[ $row->sub_item ] ) ) {
158            $items = [];
159            foreach ( $this->threadItemsByName[ $row->sub_item ] as $threadItem ) {
160                if ( $threadItem->isCanonicalPermalink() ) {
161                    $items[] = $this->threadItemFormatter->formatLine( $threadItem, $this );
162                }
163            }
164            if ( $items ) {
165                return $this->maybeFormatAsList( $items );
166            }
167
168            // Found items in the permalink database, but they're not good permalinks.
169            // TODO: We could link to the full list on Special:FindComment here
170            // (but we don't link it from the mw.notify message either, at the moment).
171        }
172
173        // Permalink not available - display a plain link to the page title at the time of subscription
174        $title = Title::makeTitleSafe( $row->sub_namespace, $row->sub_title );
175        if ( !$title ) {
176            // Handle invalid titles (T345648)
177            return Html::element( 'span', [ 'class' => 'mw-invalidtitle' ],
178                Linker::getInvalidTitleDescription(
179                    $this->getContext(), $row->sub_namespace, $row->sub_title )
180                );
181        }
182        return $linkRenderer->makeLink( $title );
183    }
184
185    private function formatValueTopic( \stdClass $row ): string {
186        $linkRenderer = $this->getLinkRenderer();
187
188        $sectionText = $row->sub_section;
189        $sectionLink = $row->sub_section;
190        // Detect truncated section titles: either intentionally truncated by SubscriptionStore,
191        // or incorrect multibyte truncation of old entries (T345648).
192        $last = mb_substr( $sectionText, -1 );
193        if ( $last !== '' && ( $last === "\x1f" || mb_ord( $last ) === false ) ) {
194            $sectionText = substr( $sectionText, 0, -strlen( $last ) ) . $this->msg( 'ellipsis' )->text();
195            $sectionLink = null;
196        }
197
198        if ( str_starts_with( $row->sub_item, 'p-topics-' ) ) {
199            return '<em>' .
200                $this->msg( 'discussiontools-topicsubscription-pager-newtopics-label' )->escaped() .
201            '</em>';
202        }
203
204        if ( isset( $this->threadItemsByName[ $row->sub_item ] ) ) {
205            $items = [];
206            foreach ( $this->threadItemsByName[ $row->sub_item ] as $threadItem ) {
207                if ( $threadItem->isCanonicalPermalink() ) {
208                    // TODO: Can we extract the current topic title out of $threadItem->getId() sometimes,
209                    // instead of always using the topic title at the time of subscription? (T295431)
210                    $items[] = $this->threadItemFormatter->makeLink( $threadItem, $sectionText );
211                }
212            }
213            if ( $items ) {
214                return $this->maybeFormatAsList( $items );
215            }
216
217            // Found items in the permalink database, but they're not good permalinks.
218            // TODO: We could link to the full list on Special:FindComment here
219            // (but we don't link it from the mw.notify message either, at the moment).
220        }
221
222        // Permalink not available - display a plain link to the section at the time of subscription
223        if ( !$sectionLink ) {
224            // We can't link to the section correctly, since the only link we have is truncated
225            return htmlspecialchars( $sectionText );
226        }
227        $titleSection = Title::makeTitleSafe( $row->sub_namespace, $row->sub_title, $sectionLink );
228        if ( !$titleSection ) {
229            // Handle invalid titles of any other kind, just in case
230            return htmlspecialchars( $sectionText );
231        }
232        return $linkRenderer->makeLink( $titleSection, $sectionText );
233    }
234
235    /**
236     * @inheritDoc
237     */
238    protected function getCellAttrs( $field, $value ) {
239        $attrs = parent::getCellAttrs( $field, $value );
240        if ( $field === '_unsubscribe' ) {
241            $attrs['style'] = 'text-align: center;';
242        }
243        return $attrs;
244    }
245
246    /**
247     * @inheritDoc
248     */
249    public function getQueryInfo() {
250        return [
251            'tables' => [
252                'discussiontools_subscription',
253            ],
254            'fields' => [
255                'sub_id',
256                'sub_item',
257                'sub_namespace',
258                'sub_title',
259                'sub_section',
260                'sub_created',
261                'sub_notified',
262            ],
263            'conds' => [
264                'sub_user' => $this->getUser()->getId(),
265                'sub_state != ' . SubscriptionStore::STATE_UNSUBSCRIBED,
266            ],
267        ];
268    }
269
270    /**
271     * @inheritDoc
272     */
273    public function getDefaultSort() {
274        return 'sub_created';
275    }
276
277    /**
278     * @inheritDoc
279     */
280    public function getDefaultDirections() {
281        return static::DIR_DESCENDING;
282    }
283
284    /**
285     * @inheritDoc
286     */
287    public function getIndexField() {
288        return [ static::INDEX_FIELDS[$this->mSort] ];
289    }
290
291    /**
292     * @inheritDoc
293     */
294    protected function isFieldSortable( $field ) {
295        // Hide the sort button for "Topic" as it is more accurately shown as "Created"
296        return isset( static::INDEX_FIELDS[$field] ) && $field !== '_topic';
297    }
298}