TextFormat.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\utils;
 
use function mb_scrub;
use function preg_last_error;
use function preg_quote;
use function preg_replace;
use function preg_split;
use function str_repeat;
use function str_replace;
use const PREG_BACKTRACK_LIMIT_ERROR;
use const PREG_BAD_UTF8_ERROR;
use const PREG_BAD_UTF8_OFFSET_ERROR;
use const PREG_INTERNAL_ERROR;
use const PREG_JIT_STACKLIMIT_ERROR;
use const PREG_RECURSION_LIMIT_ERROR;
use const PREG_SPLIT_DELIM_CAPTURE;
use const PREG_SPLIT_NO_EMPTY;
 
abstract class TextFormat{
    public const ESCAPE = "\xc2\xa7"; //§
    public const EOL = "\n";
 
    public const BLACK = TextFormat::ESCAPE . "0";
    public const DARK_BLUE = TextFormat::ESCAPE . "1";
    public const DARK_GREEN = TextFormat::ESCAPE . "2";
    public const DARK_AQUA = TextFormat::ESCAPE . "3";
    public const DARK_RED = TextFormat::ESCAPE . "4";
    public const DARK_PURPLE = TextFormat::ESCAPE . "5";
    public const GOLD = TextFormat::ESCAPE . "6";
    public const GRAY = TextFormat::ESCAPE . "7";
    public const DARK_GRAY = TextFormat::ESCAPE . "8";
    public const BLUE = TextFormat::ESCAPE . "9";
    public const GREEN = TextFormat::ESCAPE . "a";
    public const AQUA = TextFormat::ESCAPE . "b";
    public const RED = TextFormat::ESCAPE . "c";
    public const LIGHT_PURPLE = TextFormat::ESCAPE . "d";
    public const YELLOW = TextFormat::ESCAPE . "e";
    public const WHITE = TextFormat::ESCAPE . "f";
    public const MINECOIN_GOLD = TextFormat::ESCAPE . "g";
 
    public const COLORS = [
        self::BLACK => self::BLACK,
        self::DARK_BLUE => self::DARK_BLUE,
        self::DARK_GREEN => self::DARK_GREEN,
        self::DARK_AQUA => self::DARK_AQUA,
        self::DARK_RED => self::DARK_RED,
        self::DARK_PURPLE => self::DARK_PURPLE,
        self::GOLD => self::GOLD,
        self::GRAY => self::GRAY,
        self::DARK_GRAY => self::DARK_GRAY,
        self::BLUE => self::BLUE,
        self::GREEN => self::GREEN,
        self::AQUA => self::AQUA,
        self::RED => self::RED,
        self::LIGHT_PURPLE => self::LIGHT_PURPLE,
        self::YELLOW => self::YELLOW,
        self::WHITE => self::WHITE,
        self::MINECOIN_GOLD => self::MINECOIN_GOLD,
    ];
 
    public const OBFUSCATED = TextFormat::ESCAPE . "k";
    public const BOLD = TextFormat::ESCAPE . "l";
    public const STRIKETHROUGH = TextFormat::ESCAPE . "m";
    public const UNDERLINE = TextFormat::ESCAPE . "n";
    public const ITALIC = TextFormat::ESCAPE . "o";
 
    public const FORMATS = [
        self::OBFUSCATED => self::OBFUSCATED,
        self::BOLD => self::BOLD,
        self::STRIKETHROUGH => self::STRIKETHROUGH,
        self::UNDERLINE => self::UNDERLINE,
        self::ITALIC => self::ITALIC,
    ];
 
    public const RESET = TextFormat::ESCAPE . "r";
 
    private static function makePcreError() : \InvalidArgumentException{
        $errorCode = preg_last_error();
        $message = [
            PREG_INTERNAL_ERROR => "Internal error",
            PREG_BACKTRACK_LIMIT_ERROR => "Backtrack limit reached",
            PREG_RECURSION_LIMIT_ERROR => "Recursion limit reached",
            PREG_BAD_UTF8_ERROR => "Malformed UTF-8",
            PREG_BAD_UTF8_OFFSET_ERROR => "Bad UTF-8 offset",
            PREG_JIT_STACKLIMIT_ERROR => "PCRE JIT stack limit reached"
        ][$errorCode] ?? "Unknown (code $errorCode)";
        throw new \InvalidArgumentException("PCRE error: $message");
    }
 
    private static function preg_replace(string $pattern, string $replacement, string $string) : string{
        $result = preg_replace($pattern, $replacement, $string);
        if($result === null){
            throw self::makePcreError();
        }
        return $result;
    }
 
    public static function tokenize(string $string) : array{
        $result = preg_split("/(" . TextFormat::ESCAPE . "[0-9a-gk-or])/u", $string, -1, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE);
        if($result === false) throw self::makePcreError();
        return $result;
    }
 
    public static function clean(string $string, bool $removeFormat = true) : string{
        $string = mb_scrub($string, 'UTF-8');
        $string = self::preg_replace("/[\x{E000}-\x{F8FF}]/u", "", $string); //remove unicode private-use-area characters (they might break the console)
        if($removeFormat){
            $string = str_replace(TextFormat::ESCAPE, "", self::preg_replace("/" . TextFormat::ESCAPE . "[0-9a-gk-or]/u", "", $string));
        }
        return str_replace("\x1b", "", self::preg_replace("/\x1b[\\(\\][[0-9;\\[\\(]+[Bm]/u", "", $string));
    }
 
    public static function colorize(string $string, string $placeholder = "&") : string{
        return self::preg_replace('/' . preg_quote($placeholder, "/") . '([0-9a-gk-or])/u', TextFormat::ESCAPE . '$1', $string);
    }
 
    public static function addBase(string $baseFormat, string $string) : string{
        $baseFormatParts = self::tokenize($baseFormat);
        foreach($baseFormatParts as $part){
            if(!isset(self::FORMATS[$part]) && !isset(self::COLORS[$part])){
                throw new \InvalidArgumentException("Unexpected base format token \"$part\", expected only color and format tokens");
            }
        }
        $baseFormat = self::RESET . $baseFormat;
 
        return $baseFormat . str_replace(TextFormat::RESET, $baseFormat, $string);
    }
 
    public static function toHTML(string $string) : string{
        $newString = "";
        $tokens = 0;
        foreach(self::tokenize($string) as $token){
            switch($token){
                case TextFormat::BOLD:
                    $newString .= "<span style=font-weight:bold>";
                    ++$tokens;
                    break;
                case TextFormat::OBFUSCATED:
                    //$newString .= "<span style=text-decoration:line-through>";
                    //++$tokens;
                    break;
                case TextFormat::ITALIC:
                    $newString .= "<span style=font-style:italic>";
                    ++$tokens;
                    break;
                case TextFormat::UNDERLINE:
                    $newString .= "<span style=text-decoration:underline>";
                    ++$tokens;
                    break;
                case TextFormat::STRIKETHROUGH:
                    $newString .= "<span style=text-decoration:line-through>";
                    ++$tokens;
                    break;
                case TextFormat::RESET:
                    $newString .= str_repeat("</span>", $tokens);
                    $tokens = 0;
                    break;
 
                //Colors
                case TextFormat::BLACK:
                    $newString .= "<span style=color:#000>";
                    ++$tokens;
                    break;
                case TextFormat::DARK_BLUE:
                    $newString .= "<span style=color:#00A>";
                    ++$tokens;
                    break;
                case TextFormat::DARK_GREEN:
                    $newString .= "<span style=color:#0A0>";
                    ++$tokens;
                    break;
                case TextFormat::DARK_AQUA:
                    $newString .= "<span style=color:#0AA>";
                    ++$tokens;
                    break;
                case TextFormat::DARK_RED:
                    $newString .= "<span style=color:#A00>";
                    ++$tokens;
                    break;
                case TextFormat::DARK_PURPLE:
                    $newString .= "<span style=color:#A0A>";
                    ++$tokens;
                    break;
                case TextFormat::GOLD:
                    $newString .= "<span style=color:#FA0>";
                    ++$tokens;
                    break;
                case TextFormat::GRAY:
                    $newString .= "<span style=color:#AAA>";
                    ++$tokens;
                    break;
                case TextFormat::DARK_GRAY:
                    $newString .= "<span style=color:#555>";
                    ++$tokens;
                    break;
                case TextFormat::BLUE:
                    $newString .= "<span style=color:#55F>";
                    ++$tokens;
                    break;
                case TextFormat::GREEN:
                    $newString .= "<span style=color:#5F5>";
                    ++$tokens;
                    break;
                case TextFormat::AQUA:
                    $newString .= "<span style=color:#5FF>";
                    ++$tokens;
                    break;
                case TextFormat::RED:
                    $newString .= "<span style=color:#F55>";
                    ++$tokens;
                    break;
                case TextFormat::LIGHT_PURPLE:
                    $newString .= "<span style=color:#F5F>";
                    ++$tokens;
                    break;
                case TextFormat::YELLOW:
                    $newString .= "<span style=color:#FF5>";
                    ++$tokens;
                    break;
                case TextFormat::WHITE:
                    $newString .= "<span style=color:#FFF>";
                    ++$tokens;
                    break;
                case TextFormat::MINECOIN_GOLD:
                    $newString .= "<span style=color:#dd0>";
                    ++$tokens;
                    break;
                default:
                    $newString .= $token;
                    break;
            }
        }
 
        $newString .= str_repeat("</span>", $tokens);
 
        return $newString;
    }
}