1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Pager
*/
use Wikimedia\Timestamp\TimestampException;
/**
* Efficient paging for SQL queries.
* IndexPager with a formatted navigation bar.
* @stable to extend
* @ingroup Pager
*/
abstract class ReverseChronologicalPager extends IndexPager {
/** @var bool */
public $mDefaultDirection = IndexPager::DIR_DESCENDING;
/** @var int */
public $mYear;
/** @var int */
public $mMonth;
/** @var int */
public $mDay;
/**
* @stable to override
* @return string
*/
public function getNavigationBar() {
if ( !$this->isNavigationBarShown() ) {
return '';
}
if ( isset( $this->mNavigationBar ) ) {
return $this->mNavigationBar;
}
$linkTexts = [
'prev' => $this->msg( 'pager-newer-n' )->numParams( $this->mLimit )->escaped(),
'next' => $this->msg( 'pager-older-n' )->numParams( $this->mLimit )->escaped(),
'first' => $this->msg( 'histlast' )->escaped(),
'last' => $this->msg( 'histfirst' )->escaped()
];
$pagingLinks = $this->getPagingLinks( $linkTexts );
$limitLinks = $this->getLimitLinks();
$limits = $this->getLanguage()->pipeList( $limitLinks );
$firstLastLinks = $this->msg( 'parentheses' )->rawParams( "{$pagingLinks['first']}" .
$this->msg( 'pipe-separator' )->escaped() .
"{$pagingLinks['last']}" )->escaped();
$this->mNavigationBar = $firstLastLinks . ' ' .
$this->msg( 'viewprevnext' )->rawParams(
$pagingLinks['prev'], $pagingLinks['next'], $limits )->escaped();
return $this->mNavigationBar;
}
/**
* Set and return the mOffset timestamp such that we can get all revisions with
* a timestamp up to the specified parameters.
*
* @stable to override
*
* @param int $year Year up to which we want revisions
* @param int $month Month up to which we want revisions
* @param int $day [optional] Day up to which we want revisions. Default is end of month.
* @return string|null Timestamp or null if year and month are false/invalid
*/
public function getDateCond( $year, $month, $day = -1 ) {
$year = (int)$year;
$month = (int)$month;
$day = (int)$day;
// Basic validity checks for year and month
// If year and month are invalid, don't update the mOffset
if ( $year <= 0 && ( $month <= 0 || $month >= 13 ) ) {
return null;
}
$timestamp = self::getOffsetDate( $year, $month, $day );
try {
// The timestamp used for DB queries is at midnight of the *next* day after the selected date.
$selectedDate = new DateTime( $timestamp->getTimestamp( TS_ISO_8601 ) );
$selectedDate = $selectedDate->modify( '-1 day' );
$this->mYear = (int)$selectedDate->format( 'Y' );
$this->mMonth = (int)$selectedDate->format( 'm' );
$this->mDay = (int)$selectedDate->format( 'd' );
$this->mOffset = $this->mDb->timestamp( $timestamp->getTimestamp() );
} catch ( TimestampException $e ) {
// Invalid user provided timestamp (T149257)
return null;
}
return $this->mOffset;
}
/**
* Core logic of determining the mOffset timestamp such that we can get all items with
* a timestamp up to the specified parameters. Given parameters for a day up to which to get
* items, this function finds the timestamp of the day just after the end of the range for use
* in an database strict inequality filter.
*
* This is separate from getDateCond so we can use this logic in other places, such as in
* RangeChronologicalPager, where this function is used to convert year/month/day filter options
* into a timestamp.
*
* @param int $year Year up to which we want revisions
* @param int $month Month up to which we want revisions
* @param int $day [optional] Day up to which we want revisions. Default is end of month.
* @return MWTimestamp Timestamp or null if year and month are false/invalid
*/
public static function getOffsetDate( $year, $month, $day = -1 ) {
// Given an optional year, month, and day, we need to generate a timestamp
// to use as "WHERE rev_timestamp <= result"
// Examples: year = 2006 equals < 20070101 (+000000)
// year=2005, month=1 equals < 20050201
// year=2005, month=12 equals < 20060101
// year=2005, month=12, day=5 equals < 20051206
if ( $year <= 0 ) {
// If no year given, assume the current one
$timestamp = MWTimestamp::getInstance();
$year = $timestamp->format( 'Y' );
// If this month hasn't happened yet this year, go back to last year's month
if ( $month > $timestamp->format( 'n' ) ) {
$year--;
}
}
if ( $month && $month > 0 && $month < 13 ) {
// Day validity check after we have month and year checked
$day = checkdate( $month, $day, $year ) ? $day : false;
if ( $day && $day > 0 ) {
// If we have a day, we want up to the day immediately afterward
$day++;
// Did we overflow the current month?
if ( !checkdate( $month, $day, $year ) ) {
$day = 1;
$month++;
}
} else {
// If no day, assume beginning of next month
$day = 1;
$month++;
}
// Did we overflow the current year?
if ( $month > 12 ) {
$month = 1;
$year++;
}
} else {
// No month implies we want up to the end of the year in question
$month = 1;
$day = 1;
$year++;
}
// Y2K38 bug
if ( $year > 2032 ) {
$year = 2032;
}
$ymd = (int)sprintf( "%04d%02d%02d", $year, $month, $day );
if ( $ymd > 20320101 ) {
$ymd = 20320101;
}
return MWTimestamp::getInstance( "{$ymd}000000" );
}
}
|
