MediaWiki  master
Pingback.php
Go to the documentation of this file.
1 <?php
26 
32 class Pingback {
33 
39  const SCHEMA_REV = 15781718;
40 
42  protected $logger;
43 
45  protected $config;
46 
48  protected $key;
49 
51  protected $id;
52 
57  public function __construct( Config $config = null, LoggerInterface $logger = null ) {
58  $this->config = $config ?: RequestContext::getMain()->getConfig();
59  $this->logger = $logger ?: LoggerFactory::getInstance( __CLASS__ );
60  $this->key = 'Pingback-' . $this->config->get( 'Version' );
61  }
62 
67  private function shouldSend() {
68  return $this->config->get( 'Pingback' ) && !$this->checkIfSent();
69  }
70 
75  private function checkIfSent() {
76  $dbr = wfGetDB( DB_REPLICA );
77  $timestamp = $dbr->selectField(
78  'updatelog',
79  'ul_value',
80  [ 'ul_key' => $this->key ],
81  __METHOD__
82  );
83  if ( $timestamp === false ) {
84  return false;
85  }
86  // send heartbeat ping if last ping was over a month ago
87  if ( time() - (int)$timestamp > 60 * 60 * 24 * 30 ) {
88  return false;
89  }
90  return true;
91  }
92 
97  private function markSent() {
98  $dbw = wfGetDB( DB_MASTER );
99  $timestamp = time();
100  return $dbw->upsert(
101  'updatelog',
102  [ 'ul_key' => $this->key, 'ul_value' => $timestamp ],
103  [ 'ul_key' ],
104  [ 'ul_value' => $timestamp ],
105  __METHOD__
106  );
107  }
108 
117  private function acquireLock() {
119  if ( !$cache->add( $this->key, 1, 60 * 60 ) ) {
120  return false; // throttled
121  }
122 
123  $dbw = wfGetDB( DB_MASTER );
124  if ( !$dbw->lock( $this->key, __METHOD__, 0 ) ) {
125  return false; // already in progress
126  }
127 
128  return true;
129  }
130 
143  public function getSystemInfo() {
144  $event = [
145  'database' => $this->config->get( 'DBtype' ),
146  'MediaWiki' => $this->config->get( 'Version' ),
147  'PHP' => PHP_VERSION,
148  'OS' => PHP_OS . ' ' . php_uname( 'r' ),
149  'arch' => PHP_INT_SIZE === 8 ? 64 : 32,
150  'machine' => php_uname( 'm' ),
151  ];
152 
153  if ( isset( $_SERVER['SERVER_SOFTWARE'] ) ) {
154  $event['serverSoftware'] = $_SERVER['SERVER_SOFTWARE'];
155  }
156 
157  $limit = ini_get( 'memory_limit' );
158  if ( $limit && $limit != -1 ) {
159  $event['memoryLimit'] = $limit;
160  }
161 
162  return $event;
163  }
164 
170  private function getData() {
171  return [
172  'schema' => 'MediaWikiPingback',
173  'revision' => self::SCHEMA_REV,
174  'wiki' => $this->getOrCreatePingbackId(),
175  'event' => $this->getSystemInfo(),
176  ];
177  }
178 
187  private function getOrCreatePingbackId() {
188  if ( !$this->id ) {
189  $id = wfGetDB( DB_REPLICA )->selectField(
190  'updatelog', 'ul_value', [ 'ul_key' => 'PingBack' ] );
191 
192  if ( $id == false ) {
194  $dbw = wfGetDB( DB_MASTER );
195  $dbw->insert(
196  'updatelog',
197  [ 'ul_key' => 'PingBack', 'ul_value' => $id ],
198  __METHOD__,
199  [ 'IGNORE' ]
200  );
201 
202  if ( !$dbw->affectedRows() ) {
203  $id = $dbw->selectField(
204  'updatelog', 'ul_value', [ 'ul_key' => 'PingBack' ] );
205  }
206  }
207 
208  $this->id = $id;
209  }
210 
211  return $this->id;
212  }
213 
229  private function postPingback( array $data ) {
230  $json = FormatJson::encode( $data );
231  $queryString = rawurlencode( str_replace( ' ', '\u0020', $json ) ) . ';';
232  $url = 'https://www.mediawiki.org/beacon/event?' . $queryString;
233  return MediaWikiServices::getInstance()->getHttpRequestFactory()->post( $url ) !== null;
234  }
235 
251  public function sendPingback() {
252  if ( !$this->acquireLock() ) {
253  $this->logger->debug( __METHOD__ . ": couldn't acquire lock" );
254  return false;
255  }
256 
257  $data = $this->getData();
258  if ( !$this->postPingback( $data ) ) {
259  $this->logger->warning( __METHOD__ . ": failed to send pingback; check 'http' log" );
260  return false;
261  }
262 
263  $this->markSent();
264  $this->logger->debug( __METHOD__ . ": pingback sent OK ({$this->key})" );
265  return true;
266  }
267 
272  public static function schedulePingback() {
274  $instance = new Pingback;
275  if ( $instance->shouldSend() ) {
276  $instance->sendPingback();
277  }
278  } );
279  }
280 }
getSystemInfo()
Collect basic data about this MediaWiki installation and return it as an associative array conforming...
Definition: Pingback.php:143
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
acquireLock()
Acquire lock for sending a pingback.
Definition: Pingback.php:117
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message key
Definition: hooks.txt:2145
static getLocalClusterInstance()
Get the main cluster-local cache object.
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 MediaWikiServices
Definition: injection.txt:23
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:115
checkIfSent()
Has a pingback been sent in the last month for this MediaWiki version?
Definition: Pingback.php:75
const DB_MASTER
Definition: defines.php:26
string $id
Randomly-generated identifier for this wiki.
Definition: Pingback.php:51
static addCallableUpdate( $callable, $stage=self::POSTSEND, $dbw=null)
Add a callable update.
static getMain()
Get the RequestContext object associated with the main request.
Interface for configuration instances.
Definition: Config.php:28
sendPingback()
Send information about this MediaWiki instance to MediaWiki.org.
Definition: Pingback.php:251
Config $config
Definition: Pingback.php:45
$cache
Definition: mcc.php:33
string $key
updatelog key (also used as cache/db lock key)
Definition: Pingback.php:48
static generateHex( $chars)
Generate a run of cryptographically random data and return it in hexadecimal string format...
Definition: MWCryptRand.php:36
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:773
static schedulePingback()
Schedule a deferred callable that will check if a pingback should be sent and (if so) proceed to send...
Definition: Pingback.php:272
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:35
__construct(Config $config=null, LoggerInterface $logger=null)
Definition: Pingback.php:57
getData()
Get the EventLogging packet to be sent to the server.
Definition: Pingback.php:170
postPingback(array $data)
Serialize pingback data and send it to MediaWiki.org via a POST to its event beacon endpoint...
Definition: Pingback.php:229
MediaWiki Logger LoggerFactory implements a PSR [0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Definition: logger.txt:5
getOrCreatePingbackId()
Get a unique, stable identifier for this wiki.
Definition: Pingback.php:187
shouldSend()
Should a pingback be sent?
Definition: Pingback.php:67
const DB_REPLICA
Definition: defines.php:25
markSent()
Record the fact that we have sent a pingback for this MediaWiki version, to ensure we don&#39;t submit da...
Definition: Pingback.php:97
LoggerInterface $logger
Definition: Pingback.php:34
Send information about this MediaWiki instance to MediaWiki.org.
Definition: Pingback.php:32