UpdateChecker.php

<?php
 
/*
 *
 *  ____            _        _   __  __ _                  __  __ ____
 * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
 * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
 * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
 * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * @author PocketMine Team
 * @link http://www.pocketmine.net/
 *
 *
 */
 
declare(strict_types=1);
 
namespace pocketmine\updater;
 
use pocketmine\event\server\UpdateNotifyEvent;
use pocketmine\Server;
use pocketmine\utils\VersionString;
use pocketmine\VersionInfo;
use pocketmine\YmlServerProperties;
use function date;
use function strtolower;
use function ucfirst;
 
class UpdateChecker{
 
    protected Server $server;
    protected string $endpoint;
    protected ?UpdateInfo $updateInfo = null;
    private \Logger $logger;
 
    public function __construct(Server $server, string $endpoint){
        $this->server = $server;
        $this->logger = new \PrefixedLogger($server->getLogger(), "Update Checker");
        $this->endpoint = "http://$endpoint/api/";
 
        if($server->getConfigGroup()->getPropertyBool(YmlServerProperties::AUTO_UPDATER_ENABLED, true)){
            $this->doCheck();
        }
    }
 
    public function checkUpdateError(string $error) : void{
        $this->logger->debug("Async update check failed due to \"$error\"");
    }
 
    public function checkUpdateCallback(UpdateInfo $updateInfo) : void{
        $this->checkUpdate($updateInfo);
        if($this->hasUpdate()){
            (new UpdateNotifyEvent($this))->call();
            if($this->server->getConfigGroup()->getPropertyBool(YmlServerProperties::AUTO_UPDATER_ON_UPDATE_WARN_CONSOLE, true)){
                $this->showConsoleUpdate();
            }
        }else{
            if(!VersionInfo::IS_DEVELOPMENT_BUILD && $this->getChannel() !== "stable"){
                $this->showChannelSuggestionStable();
            }elseif(VersionInfo::IS_DEVELOPMENT_BUILD && $this->getChannel() === "stable"){
                $this->showChannelSuggestionBeta();
            }
        }
    }
 
    public function hasUpdate() : bool{
        return $this->updateInfo !== null;
    }
 
    public function showConsoleUpdate() : void{
        if($this->updateInfo === null){
            return;
        }
        $newVersion = new VersionString($this->updateInfo->base_version, $this->updateInfo->is_dev, $this->updateInfo->build);
        $messages = [
            "Your version of " . $this->server->getName() . " is out of date. Version " . $newVersion->getFullVersion(true) . " was released on " . date("D M j h:i:s Y", $this->updateInfo->date)
        ];
 
        $messages[] = "Details: " . $this->updateInfo->details_url;
        $messages[] = "Download: " . $this->updateInfo->download_url;
 
        $this->printConsoleMessage($messages, \LogLevel::WARNING);
    }
 
    protected function showChannelSuggestionStable() : void{
        $this->printConsoleMessage([
            "You're running a Stable build, but you're receiving update notifications for " . ucfirst($this->getChannel()) . " builds.",
            "To get notified about new Stable builds only, change 'preferred-channel' in your pocketmine.yml to 'stable'."
        ]);
    }
 
    protected function showChannelSuggestionBeta() : void{
        $this->printConsoleMessage([
            "You're running a Beta build, but you're receiving update notifications for Stable builds.",
            "To get notified about new Beta or Development builds, change 'preferred-channel' in your pocketmine.yml to 'beta' or 'development'."
        ]);
    }
 
    protected function printConsoleMessage(array $lines, string $logLevel = \LogLevel::INFO) : void{
        foreach($lines as $line){
            $this->logger->log($logLevel, $line);
        }
    }
 
    public function getUpdateInfo() : ?UpdateInfo{
        return $this->updateInfo;
    }
 
    public function doCheck() : void{
        $this->server->getAsyncPool()->submitTask(new UpdateCheckTask($this, $this->endpoint, $this->getChannel()));
    }
 
    protected function checkUpdate(UpdateInfo $updateInfo) : void{
        $currentVersion = VersionInfo::VERSION();
        try{
            $newVersion = new VersionString($updateInfo->base_version, $updateInfo->is_dev, $updateInfo->build);
        }catch(\InvalidArgumentException $e){
            //Invalid version returned from API, assume there's no update
            $this->logger->debug("Assuming no update because \"" . $e->getMessage() . "\"");
            return;
        }
 
        if($currentVersion->getBuild() > 0 && $currentVersion->compare($newVersion) > 0){
            $this->updateInfo = $updateInfo;
        }else{
            $this->logger->debug("API reported version is an older version or the same version (" . $newVersion->getFullVersion() . "), not showing notification");
        }
    }
 
    public function getChannel() : string{
        return strtolower($this->server->getConfigGroup()->getPropertyString(YmlServerProperties::AUTO_UPDATER_PREFERRED_CHANNEL, "stable"));
    }
 
    public function getEndpoint() : string{
        return $this->endpoint;
    }
}