MediaWiki REL1_33
MachineReadableRCFeedFormatter.php
Go to the documentation of this file.
1<?php
2
28
34 abstract protected function formatArray( array $packet );
35
44 public function getLine( array $feed, RecentChange $rc, $actionComment ) {
46
47 $packet = [
48 // Usually, RC ID is exposed only for patrolling purposes,
49 // but there is no real reason not to expose it in other cases,
50 // and I can see how this may be potentially useful for clients.
51 'id' => $rc->getAttribute( 'rc_id' ),
52 'type' => RecentChange::parseFromRCType( $rc->getAttribute( 'rc_type' ) ),
53 'namespace' => $rc->getTitle()->getNamespace(),
54 'title' => $rc->getTitle()->getPrefixedText(),
55 'comment' => $rc->getAttribute( 'rc_comment' ),
56 'timestamp' => (int)wfTimestamp( TS_UNIX, $rc->getAttribute( 'rc_timestamp' ) ),
57 'user' => $rc->getAttribute( 'rc_user_text' ),
58 'bot' => (bool)$rc->getAttribute( 'rc_bot' ),
59 ];
60
61 if ( isset( $feed['channel'] ) ) {
62 $packet['channel'] = $feed['channel'];
63 }
64
65 $type = $rc->getAttribute( 'rc_type' );
66 if ( $type == RC_EDIT || $type == RC_NEW ) {
68
69 $packet['minor'] = (bool)$rc->getAttribute( 'rc_minor' );
70 if ( $wgUseRCPatrol || ( $type == RC_NEW && $wgUseNPPatrol ) ) {
71 $packet['patrolled'] = (bool)$rc->getAttribute( 'rc_patrolled' );
72 }
73 }
74
75 switch ( $type ) {
76 case RC_EDIT:
77 $packet['length'] = [
78 'old' => $rc->getAttribute( 'rc_old_len' ),
79 'new' => $rc->getAttribute( 'rc_new_len' )
80 ];
81 $packet['revision'] = [
82 'old' => $rc->getAttribute( 'rc_last_oldid' ),
83 'new' => $rc->getAttribute( 'rc_this_oldid' )
84 ];
85 break;
86
87 case RC_NEW:
88 $packet['length'] = [ 'old' => null, 'new' => $rc->getAttribute( 'rc_new_len' ) ];
89 $packet['revision'] = [ 'old' => null, 'new' => $rc->getAttribute( 'rc_this_oldid' ) ];
90 break;
91
92 case RC_LOG:
93 $packet['log_id'] = $rc->getAttribute( 'rc_logid' );
94 $packet['log_type'] = $rc->getAttribute( 'rc_log_type' );
95 $packet['log_action'] = $rc->getAttribute( 'rc_log_action' );
96 if ( $rc->getAttribute( 'rc_params' ) ) {
97 $params = $rc->parseParams();
98 if (
99 // If it's an actual serialised false...
100 $rc->getAttribute( 'rc_params' ) == serialize( false ) ||
101 // Or if we did not get false back when trying to unserialise
102 $params !== false
103 ) {
104 // From ApiQueryLogEvents::addLogParams
105 $logParams = [];
106 // Keys like "4::paramname" can't be used for output so we change them to "paramname"
107 foreach ( $params as $key => $value ) {
108 if ( strpos( $key, ':' ) === false ) {
109 $logParams[$key] = $value;
110 continue;
111 }
112 $logParam = explode( ':', $key, 3 );
113 $logParams[$logParam[2]] = $value;
114 }
115 $packet['log_params'] = $logParams;
116 } else {
117 $packet['log_params'] = explode( "\n", $rc->getAttribute( 'rc_params' ) );
118 }
119 }
120 $packet['log_action_comment'] = $actionComment;
121 break;
122 }
123
124 $packet['server_url'] = $wgCanonicalServer;
125 $packet['server_name'] = $wgServerName;
126
127 $packet['server_script_path'] = $wgScriptPath ?: '/';
128 $packet['wiki'] = WikiMap::getWikiIdFromDbDomain( WikiMap::getCurrentWikiDbDomain() );
129
130 return $this->formatArray( $packet );
131 }
132}
serialize()
$wgServerName
Server name.
$wgUseRCPatrol
Use RC Patrolling to check for vandalism (from recent changes and watchlists) New pages and new files...
$wgUseNPPatrol
Use new page patrolling to check new pages on Special:Newpages.
$wgScriptPath
The path we should point to.
$wgCanonicalServer
Canonical URL of the server, to use in IRC feeds and notification e-mails.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Abstract class so there can be multiple formatters outputting the same data.
formatArray(array $packet)
Take the packet and return the formatted string.
getLine(array $feed, RecentChange $rc, $actionComment)
Generates a notification that can be easily interpreted by a machine.
Utility class for creating new RC entries.
parseParams()
Parses and returns the rc_params attribute.
getAttribute( $name)
Get an attribute value.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
const RC_NEW
Definition Defines.php:152
const RC_LOG
Definition Defines.php:153
const RC_EDIT
Definition Defines.php:151
processing should stop and the error should be shown to the user * false
Definition hooks.txt:187
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
Interface for RC feed formatters.
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
$params