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
|
<?php
/**
* Utility class that formats a notification in the format specified
*/
class EchoDataOutputFormatter {
/**
* Format a notification for a user in the format specified
*
* @param string|bool specifify output format, false to not format any notifications
* @param User|null the target user viewing the notification
* @return array
*/
public static function formatOutput( EchoNotification $notification, $format = false, User $user = null ) {
$event = $notification->getEvent();
$timestamp = $notification->getTimestamp();
$utcTimestampUnix = wfTimestamp( TS_UNIX, $timestamp );
// Default to notification user if user is not specified
if ( !$user ) {
$user = $notification->getUser();
}
if ( $notification->getBundleBase() && $notification->getBundleDisplayHash() ) {
$event->setBundleHash( $notification->getBundleDisplayHash() );
}
$timestampMw = self::getUserLocalTime( $user, $timestamp );
// Start creating date section header
$now = wfTimestamp();
$dateFormat = substr( $timestampMw, 0, 8 );
$timeDiff = $now - $utcTimestampUnix;
// Most notifications would be more than two days ago, check this
// first instead of checking 'today' then 'yesterday'
if ( $timeDiff > 172800 ) {
$date = self::getDateHeader( $user, $timestampMw );
// 'Today'
} elseif ( substr( self::getUserLocalTime( $user, $now ), 0, 8 ) === $dateFormat ) {
$date = wfMessage( 'echo-date-today' )->escaped();
// 'Yesterday'
} elseif ( substr( self::getUserLocalTime( $user, $now - 86400 ), 0, 8 ) === $dateFormat ) {
$date = wfMessage( 'echo-date-yesterday' )->escaped();
} else {
$date = self::getDateHeader( $user, $timestampMw );
}
// End creating date section header
$output = array(
'id' => $event->getId(),
'type' => $event->getType(),
'category' => $event->getCategory(),
'timestamp' => array(
// UTC timestamp in UNIX format used for loading more notification
'utcunix' => $utcTimestampUnix,
'unix' => self::getUserLocalTime( $user, $timestamp, TS_UNIX ),
'mw' => $timestampMw,
'date' => $date
),
);
if ( $event->getVariant() ) {
$output['variant'] = $event->getVariant();
}
$title = $event->getTitle();
if ( $title ) {
$output['title'] = array(
'full' => $title->getPrefixedText(),
'namespace' => $title->getNSText(),
'namespace-key' =>$title->getNamespace(),
'text' => $title->getText(),
);
}
$agent = $event->getAgent();
if ( $agent ) {
if ( $event->userCan( Revision::DELETED_USER, $user ) ) {
$output['agent'] = array(
'id' => $agent->getId(),
'name' => $agent->getName(),
);
} else {
$output['agent'] = array( 'userhidden' => '' );
}
}
if ( $notification->getReadTimestamp() ) {
$output['read'] = $notification->getReadTimestamp();
}
// This is only meant for unread notifications, if a notification has a target
// page, then it shouldn't be auto marked as read unless the user visits
// the target page or a user marks it as read manully ( coming soon )
$output['targetpages'] = array();
if ( $notification->getTargetPages() ) {
foreach ( $notification->getTargetPages() as $targetPage ) {
$output['targetpages'][] = $targetPage->getPageId();
}
}
if ( $format ) {
$output['*'] = EchoNotificationController::formatNotification( $event, $user, $format );
}
return $output;
}
/**
* Get the date header in user's format, 'May 10' or '10 May', depending
* on user's date format preference
* @param User $user
* @param string $timestampMw
* @return string
*/
protected static function getDateHeader( User $user, $timestampMw ) {
$lang = RequestContext::getMain()->getLanguage();
$dateFormat = $lang->getDateFormatString( 'pretty', $user->getDatePreference() ?: 'default' );
return $lang->sprintfDate( $dateFormat, $timestampMw );
}
/**
* Helper function for converting UTC timezone to a user's timezone
*
* @param User
* @param string
* @param int output format
*
* @return string
*/
public static function getUserLocalTime( User $user, $ts, $format = TS_MW ) {
$timestamp = new MWTimestamp( $ts );
$timestamp->offsetForUser( $user );
return $timestamp->getTimestamp( $format );
}
}
|
GitWeb