-
Notifications
You must be signed in to change notification settings - Fork 0
/
UpdateServer.php
542 lines (480 loc) · 15.2 KB
/
UpdateServer.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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
<?php
class Wpup_UpdateServer {
const FILE_PER_DAY = 'Y-m-d';
const FILE_PER_MONTH = 'Y-m';
protected $packageDirectory;
protected $bannerDirectory;
protected $logDirectory;
protected $logRotationEnabled = false;
protected $logDateSuffix = null;
protected $logBackupCount = 0;
protected $cache;
protected $serverUrl;
protected $startTime = 0;
protected $packageFileLoader = array('Wpup_Package', 'fromArchive');
public function __construct($serverUrl = null, $serverDirectory = null) {
if ( $serverDirectory === null ) {
$serverDirectory = realpath(__DIR__ . '/../..');
}
if ( $serverUrl === null ) {
$serverUrl = self::guessServerUrl();
}
$this->serverUrl = $serverUrl;
$this->packageDirectory = $serverDirectory . '/packages';
$this->logDirectory = $serverDirectory . '/logs';
$this->bannerDirectory = $serverDirectory . '/banners';
$this->cache = new Wpup_FileCache($serverDirectory . '/cache');
}
/**
* Guess the Server Url based on the current request.
*
* Defaults to the current URL minus the query and "index.php".
*
* @static
*
* @return string Url
*/
public static function guessServerUrl() {
$serverUrl = ( self::isSsl() ? 'https' : 'http' );
$serverUrl .= '://' . $_SERVER['HTTP_HOST'];
$path = $_SERVER['SCRIPT_NAME'];
if ( basename($path) === 'index.php' ) {
$path = dirname($path);
if ( DIRECTORY_SEPARATOR === '/' ) {
//Normalize Windows paths.
$path = str_replace('\\', '/', $path);
}
//Make sure there's a trailing slash.
if ( substr($path, -1) !== '/' ) {
$path .= '/';
}
}
$serverUrl .= $path;
return $serverUrl;
}
/**
* Determine if ssl is used.
*
* @see WP core - wp-includes/functions.php
*
* @return bool True if SSL, false if not used.
*/
public static function isSsl() {
if ( isset($_SERVER['HTTPS']) ) {
if ( $_SERVER['HTTPS'] == '1' || strtolower($_SERVER['HTTPS']) === 'on' ) {
return true;
}
} elseif ( isset($_SERVER['SERVER_PORT']) && ( '443' == $_SERVER['SERVER_PORT'] ) ) {
return true;
}
return false;
}
/**
* Process an update API request.
*
* @param array|null $query Query parameters. Defaults to the current GET request parameters.
* @param array|null $headers HTTP headers. Defaults to the headers received for the current request.
*/
public function handleRequest($query = null, $headers = null) {
$this->startTime = microtime(true);
$request = $this->initRequest($query, $headers);
$this->logRequest($request);
$this->loadPackageFor($request);
$this->validateRequest($request);
$this->checkAuthorization($request);
$this->dispatch($request);
exit;
}
/**
* Set up a request instance.
*
* @param array $query
* @param array $headers
* @return Wpup_Request
*/
protected function initRequest($query = null, $headers = null) {
if ( $query === null ) {
$query = $_GET;
}
if ( $headers === null ) {
$headers = Wpup_Headers::parseCurrent();
}
$clientIp = isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : '0.0.0.0';
$httpMethod = isset($_SERVER['REQUEST_METHOD']) ? $_SERVER['REQUEST_METHOD'] : 'GET';
return new Wpup_Request($query, $headers, $clientIp, $httpMethod);
}
/**
* Load the requested package into the request instance.
*
* @param Wpup_Request $request
*/
protected function loadPackageFor($request) {
if ( empty($request->slug) ) {
return;
}
try {
$request->package = $this->findPackage($request->slug);
} catch (Wpup_InvalidPackageException $ex) {
$this->exitWithError(sprintf(
'Package "%s" exists, but it is not a valid plugin or theme. ' .
'Make sure it has the right format (Zip) and directory structure.',
htmlentities($request->slug)
));
exit;
}
}
/**
* Basic request validation. Every request must specify an action and a valid package slug.
*
* @param Wpup_Request $request
*/
protected function validateRequest($request) {
if ( $request->action === '' ) {
$this->exitWithError('You must specify an action.', 400);
}
if ( $request->slug === '' ) {
$this->exitWithError('You must specify a package slug.', 400);
}
if ( $request->package === null ) {
$this->exitWithError(sprintf('Package "%s" not found', htmlentities($request->slug)), 404);
}
}
/**
* Run the requested action.
*
* @param Wpup_Request $request
*/
protected function dispatch($request) {
if ( $request->action === 'get_metadata' ) {
$this->actionGetMetadata($request);
} else if ( $request->action === 'download' ) {
$this->actionDownload($request);
} else {
$this->exitWithError(sprintf('Invalid action "%s".', htmlentities($request->action)), 400);
}
}
/**
* Retrieve package metadata as JSON. This is the primary function of the custom update API.
*
* @param Wpup_Request $request
*/
protected function actionGetMetadata(Wpup_Request $request) {
$meta = $request->package->getMetadata();
$meta['download_url'] = $this->generateDownloadUrl($request->package);
$meta['banners'] = $this->getBanners($request->package);
$meta = $this->filterMetadata($meta, $request);
//For debugging. The update checker ignores unknown fields, so this is safe.
$meta['request_time_elapsed'] = sprintf('%.3f', microtime(true) - $this->startTime);
$this->outputAsJson($meta);
exit;
}
/**
* Filter plugin metadata before output.
*
* Override this method to customize update API responses. For example, you could use it
* to conditionally exclude the download_url based on query parameters.
*
* @param array $meta
* @param Wpup_Request $request
* @return array Filtered metadata.
*/
protected function filterMetadata($meta, /** @noinspection PhpUnusedParameterInspection */ $request) {
//By convention, un-set properties are omitted.
$meta = array_filter($meta, function ($value) {
return $value !== null;
});
return $meta;
}
/**
* Process a download request.
*
* Typically this occurs when a user attempts to install a plugin/theme update
* from the WordPress dashboard, but technically they could also download and
* install it manually.
*
* @param Wpup_Request $request
*/
protected function actionDownload(Wpup_Request $request) {
//Required for IE, otherwise Content-Disposition may be ignored.
if(ini_get('zlib.output_compression')) {
@ini_set('zlib.output_compression', 'Off');
}
$package = $request->package;
header('Content-Type: application/zip');
header('Content-Disposition: attachment; filename="' . $package->slug . '.zip"');
header('Content-Transfer-Encoding: binary');
header('Content-Length: ' . $package->getFileSize());
readfile($package->getFilename());
}
/**
* Find a plugin or theme by slug.
*
* @param string $slug
* @return Wpup_Package A package object or NULL if the plugin/theme was not found.
*/
protected function findPackage($slug) {
//Check if there's a slug.zip file in the package directory.
$safeSlug = preg_replace('@[^a-z0-9\-_\.,+!]@i', '', $slug);
$filename = $this->packageDirectory . '/' . $safeSlug . '.zip';
if ( !is_file($filename) || !is_readable($filename) ) {
return null;
}
return call_user_func($this->packageFileLoader, $filename, $slug, $this->cache);
}
/**
* Stub. You can override this in a subclass to show update info only to
* users with a valid license key (for example).
*
* @param $request
*/
protected function checkAuthorization($request) {
//Stub.
}
/**
* Create a download URL for a plugin.
*
* @param Wpup_Package $package
* @return string URL
*/
protected function generateDownloadUrl(Wpup_Package $package) {
$query = array(
'action' => 'download',
'slug' => $package->slug,
);
return self::addQueryArg($query, $this->serverUrl);
}
/**
* Find plugin banners.
*
* See WordPress repository docs for more information on banners:
* https://wordpress.org/plugins/about/faq/#banners
*
* @param Wpup_Package $package
* @return array|null
*/
protected function getBanners(Wpup_Package $package) {
//Find the normal banner first. The file name should be slug-772x250.ext.
$basePath = $this->bannerDirectory . '/' . $package->slug;
$extensionPattern = '{png,jpg,jpeg}';
$smallBanners = glob($basePath . '-772x250.' . $extensionPattern, GLOB_BRACE | GLOB_NOESCAPE);
if ( !empty($smallBanners) ) {
$banners = array('low' => $this->generateBannerUrl(basename(reset($smallBanners))));
//Then find the high-DPI banner.
$bigBanners = glob($basePath . '-1544x500.' . $extensionPattern, GLOB_BRACE | GLOB_NOESCAPE);
if ( !empty($bigBanners) ) {
$banners['high'] = $this->generateBannerUrl(basename(reset($bigBanners)));
}
return $banners;
}
return null;
}
/**
* Get a publicly accessible URL for a plugin banner.
*
* @param string $relativeFileName Banner file name relative to the "banners" subdirectory.
* @return string
*/
protected function generateBannerUrl($relativeFileName) {
//The current implementation is trivially simple, but you could override this method
//to (for example) create URLs that don't rely on the banner directory being public.
return $this->serverUrl . 'banners/' . $relativeFileName;
}
/**
* Log an API request.
*
* @param Wpup_Request $request
*/
protected function logRequest($request) {
$logFile = $this->getLogFileName();
//If the log file is new, we should rotate old logs.
$mustRotate = $this->logRotationEnabled && !file_exists($logFile);
$handle = fopen($logFile, 'a');
if ( $handle && flock($handle, LOCK_EX) ) {
$columns = array(
str_pad($request->clientIp, 15, ' '),
str_pad($request->httpMethod, 4, ' '),
$request->param('action', '-'),
$request->param('slug', '-'),
$request->param('installed_version', '-'),
isset($request->wpVersion) ? $request->wpVersion : '-',
isset($request->wpSiteUrl) ? $request->wpSiteUrl : '-',
http_build_query($request->query, '', '&')
);
$columns = $this->filterLogInfo($columns);
//Set the time zone to whatever the default is to avoid PHP notices.
//Will default to UTC if it's not set properly in php.ini.
date_default_timezone_set(@date_default_timezone_get());
$line = date('[Y-m-d H:i:s O]') . ' ' . implode("\t", $columns) . "\n";
fwrite($handle, $line);
if ( $mustRotate ) {
$this->rotateLogs();
}
flock($handle, LOCK_UN);
}
if ( $handle ) {
fclose($handle);
}
}
/**
* @return string
*/
protected function getLogFileName() {
$path = $this->logDirectory . '/request';
if ( $this->logRotationEnabled ) {
$path .= '-' . date($this->logDateSuffix);
}
return $path . '.log';
}
/**
* Adjust information that will be logged.
* Intended to be overridden in child classes.
*
* @param array $columns List of columns in the log entry.
* @return array
*/
protected function filterLogInfo($columns) {
return $columns;
}
/**
* Enable basic log rotation.
* Defaults to monthly rotation.
*
* @param string|null $rotationPeriod Either Wpup_UpdateServer::FILE_PER_DAY or Wpup_UpdateServer::FILE_PER_MONTH.
* @param int $filesToKeep The max number of log files to keep. Zero = unlimited.
*/
public function enableLogRotation($rotationPeriod = null, $filesToKeep = 10) {
if ( !isset($rotationPeriod) ) {
$rotationPeriod = self::FILE_PER_MONTH;
}
$this->logDateSuffix = $rotationPeriod;
$this->logBackupCount = $filesToKeep;
$this->logRotationEnabled = true;
}
/**
* Delete old log files.
*/
protected function rotateLogs() {
//Skip GC of old files if the backup count is unlimited.
if ( $this->logBackupCount === 0 ) {
return;
}
//Find log files.
$logFiles = glob($this->logDirectory . '/request*.log', GLOB_NOESCAPE);
if ( count($logFiles) <= $this->logBackupCount ) {
return;
}
//Sort the files by name. Due to the date suffix format, this also sorts them by date.
usort($logFiles, 'strcmp');
//Put them in descending order.
$logFiles = array_reverse($logFiles);
//Keep the most recent $logBackupCount files, delete the rest.
foreach(array_slice($logFiles, $this->logBackupCount) as $fileName) {
@unlink($fileName);
}
}
/**
* Output something as JSON.
*
* @param mixed $response
*/
protected function outputAsJson($response) {
header('Content-Type: application/json; charset=utf-8');
if ( defined('JSON_PRETTY_PRINT') ) {
$output = json_encode($response, JSON_PRETTY_PRINT);
} elseif ( function_exists('wsh_pretty_json') ) {
$output = wsh_pretty_json(json_encode($response));
} else {
$output = json_encode($response);
}
echo $output;
}
/**
* Stop script execution with an error message.
*
* @param string $message Error message.
* @param int $httpStatus Optional HTTP status code. Defaults to 500 (Internal Server Error).
*/
protected function exitWithError($message = '', $httpStatus = 500) {
$statusMessages = array(
// This is not a full list of HTTP status messages. We only need the errors.
// [Client Error 4xx]
400 => '400 Bad Request',
401 => '401 Unauthorized',
402 => '402 Payment Required',
403 => '403 Forbidden',
404 => '404 Not Found',
405 => '405 Method Not Allowed',
406 => '406 Not Acceptable',
407 => '407 Proxy Authentication Required',
408 => '408 Request Timeout',
409 => '409 Conflict',
410 => '410 Gone',
411 => '411 Length Required',
412 => '412 Precondition Failed',
413 => '413 Request Entity Too Large',
414 => '414 Request-URI Too Long',
415 => '415 Unsupported Media Type',
416 => '416 Requested Range Not Satisfiable',
417 => '417 Expectation Failed',
// [Server Error 5xx]
500 => '500 Internal Server Error',
501 => '501 Not Implemented',
502 => '502 Bad Gateway',
503 => '503 Service Unavailable',
504 => '504 Gateway Timeout',
505 => '505 HTTP Version Not Supported'
);
if ( !isset($_SERVER['SERVER_PROTOCOL']) || $_SERVER['SERVER_PROTOCOL'] === '' ) {
$protocol = 'HTTP/1.1';
} else {
$protocol = $_SERVER['SERVER_PROTOCOL'];
}
//Output a HTTP status header.
if ( isset($statusMessages[$httpStatus]) ) {
header($protocol . ' ' . $statusMessages[$httpStatus]);
$title = $statusMessages[$httpStatus];
} else {
header('X-Ws-Update-Server-Error: ' . $httpStatus, true, $httpStatus);
$title = 'HTTP ' . $httpStatus;
}
if ( $message === '' ) {
$message = $title;
}
//And a basic HTML error message.
printf(
'<html>
<head> <title>%1$s</title> </head>
<body> <h1>%1$s</h1> <p>%2$s</p> </body>
</html>',
$title, $message
);
exit;
}
/**
* Add one or more query arguments to a URL.
* You can also set an argument to NULL to remove it.
*
* @param array $args An associative array of query arguments.
* @param string $url The old URL. Optional, defaults to the request url without query arguments.
* @return string New URL.
*/
protected static function addQueryArg($args, $url = null ) {
if ( !isset($url) ) {
$url = self::guessServerUrl();
}
if ( strpos($url, '?') !== false ) {
$parts = explode('?', $url, 2);
$base = $parts[0] . '?';
parse_str($parts[1], $query);
} else {
$base = $url . '?';
$query = array();
}
$query = array_merge($query, $args);
//Remove null/false arguments.
$query = array_filter($query, function($value) {
return ($value !== null) && ($value !== false);
});
return $base . http_build_query($query, '', '&');
}
}