-
Notifications
You must be signed in to change notification settings - Fork 0
/
MwApi.php
216 lines (198 loc) · 6.61 KB
/
MwApi.php
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
<?php
/*
* Copyright (C) 2015 Gregory Scott Rundlett
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program in the LICENSE file.
* If not, see <http://www.gnu.org/licenses/>.
*/
namespace eqt\wikireport;
/**
* Description of mwApi
*
* @author greg
*/
class MwApi {
/**
* The API endpoint to communicate with
* @var string
*/
var $endpoint;
// versions before 1.10.0 will not support siprop |statistics
var $apiQuery = '?action=query&meta=siteinfo&format=json&siprop=general';
/**
* the decoded (array) data returned from, or sent to the api
* json is only used over the wire
* @var array $data
*/
var $data;
/**
* Instead of a string like "MediaWiki 1.26.wmf"
* We'll use just the "1.26.wmf" as a version "number" to compare with
* @var string
*/
var $versionString;
var $articlepath;
var $base;
var $case;
var $dbtype;
var $dbversion;
var $externalimages;
var $fallback;
var $fallback8bitEncoding;
var $favicon;
var $generator;
var $git_branch; // problematic due to hyphen?
var $git_hash;
var $imagelimits;
var $lang;
var $langconversion;
var $legaltitlechars;
var $linkprefix;
var $linkprefixcharset;
var $linktrail;
var $logo;
var $mainpage;
var $maxuploadsize;
var $phpsapi;
var $phpversion;
var $script;
var $scriptpath;
var $server;
var $servername;
var $sitename;
var $thumblimits;
var $time;
var $timeoffset;
var $timezone;
var $titleconversion;
var $variantarticlepath;
var $wikiid;
var $writeapi;
public static $reference_version = NULL; // current version on Wikipedia
public static $reference_url = NULL; // en.wikipedia.org
public static $reference_date = NULL; // DATE_ATOM formatted string of now()
public static $reference_data = NULL; // array general siprop
/**
*
* @param string $endpoint the API Url for a given wiki
*/
public function __construct($endpoint) {
if (is_null($endpoint) || empty($endpoint) ) {
die( __METHOD__ . " died because \$endpoint is null or empty");
}
if ( !isset(self::$reference_version) ||
!isset(self::$reference_url) ||
!isset(self::$reference_date) ) {
self::loadReferences();
}
$this->endpoint = $endpoint;
$this->makeQuery();
//populate all our variables, not using magic methods
foreach (get_object_vars($this) as $prop => $val) {
if (array_key_exists($prop, $this->data['query']['general'])) {
$this->$prop = $this->data['query']['general'][$prop];
}
}
$this->versionString = trim(str_ireplace("MediaWiki", '', $this->generator));
}
/**
* Static function that we can run to get basic info about the MediaWiki
* currently running wikipedia.org
*
*/
public static function loadReferences() {
if ( !isset(self::$reference_version) ||
!isset(self::$reference_url) ||
!isset(self::$reference_date) ) {
self::$reference_url = 'https://en.wikipedia.org/';
self::$reference_date = date( DATE_ATOM );
$data = file_get_contents("https://en.wikipedia.org/w/api.php?action=query&meta=siteinfo&format=json&siprop=general");
$data = json_decode($data, true);
self::$reference_data = $data['query']['general'];
self::$reference_version = trim(str_ireplace("MediaWiki", '', self::$reference_data['generator']));
}
}
/**
* We could redo this function so that it returns the query response
* instead of populating a neverending series of parameters.
* @param type $query
*/
function makeQuery($query='') {
if ($query == '') {
$query = $this->apiQuery;
}
$data = file_get_contents($this->endpoint . $query);
/*
if (strstr($data, '\\/')) { // if we see http:\/\/foo.example.com
$data = stripslashes($data);
}
*
*/
UrlWiki::removeBOM($data);
$data = json_decode($data, true);
$this->data = $data;
return $data;
}
function getStats () {
$query = '?action=query&meta=siteinfo&format=json&siprop=statistics';
$data = file_get_contents($this->endpoint . $query);
UrlWiki::removeBOM($data);
$data = json_decode($data, true);
return $data;
}
function getGeneral () {
$query = '?action=query&meta=siteinfo&format=json&siprop=general';
$data = file_get_contents($this->endpoint . $query);
UrlWiki::removeBOM($data);
$data = json_decode($data, true);
return $data;
}
function getExtensions () {
$query = '?action=query&meta=siteinfo&format=json&siprop=extensions';
$data = file_get_contents($this->endpoint . $query);
UrlWiki::removeBOM($data);
$data = json_decode($data, true);
$this->data['query']['extensions'] = $data['query']['extensions'];
return $data;
}
/**
* Find out how recent this wiki is compared to MediaWiki releases
*
* The freshness values correspond to class names in Bootstrap
* so we can re-use in UI for messaging
*/
function getFreshness ($v = null) {
$fresh='danger';
if ( is_null($v) ) {
$v = $this->versionString;
}
switch ($v) {
case ( version_compare($v, '1.26.0') >= 0 ) :
$fresh='success';
break;
case ( version_compare($v, '1.25.0') >= 0 ) :
$fresh='info';
break;
case ( version_compare($v, '1.24.0') >= 0 ) :
$fresh='warning';
break;
case ( version_compare($v, '1.23.0') >= 0 ) :
$fresh='danger';
break;
default:
$fresh='danger';
}
return $fresh;
}
}