esc2html.php

<?php
/**
 * Utility to convert binary ESC/POS data to HTML
 */
require_once __DIR__ . '/vendor/autoload.php';

use ReceiptPrintHq\EscposTools\Parser\Context\Code2DStateStorage;
use ReceiptPrintHq\EscposTools\Parser\Parser;
use ReceiptPrintHq\EscposTools\Parser\Context\InlineFormatting;

$debugMode = true;
$targetFilename = "";

error_log("esc2html starting", 0);
// Usage
if ($argc < 2) {
    print("Usage: php " . $argv[0] . " [--debug] filename \n"."zéro args");
    exit(1);
}
else {
    if ($argv[1]=='--debug'){ 
        $debugMode = true;
        if (!isset($argv[2])) {
            print("Usage: php " . $argv[0] . " [--debug] filename ". $argc-1 . " arguments received\n");
            exit(1);
        }
        else $targetFilename = $argv[2];
        error_log("\nDebug mode enabled\n", 0);
    }
    else {  //First argument is not '--debug'
        if(isset($argv[2])) { // But there is at least 2 args
            print("Usage: php " . $argv[0] . " [--debug] filename \n". $argc-1 . " arguments received\n");
            exit(1);
        }
        else $targetFilename = $argv[1]; //The only argument is the filename.
    }
}
error_log("Target filename: " . $targetFilename . "", 0);

if(!$debugMode) {
    error_reporting(E_ERROR | E_PARSE);  //Deprecation warnings are unwanted except for debugging
}

// Load in a file
$fp = fopen($targetFilename, 'rb');
if ( !$fp ) {
    error_log("File ". $targetFilename . "not found.");
    exit(1);
}  

$parser = new Parser();
$parser -> addFile($fp);

// Extract text
$commands = $parser -> getCommands();
$formatting = InlineFormatting::getDefault();
$outp = array();
$lineHtml = "";
$bufferedImg = null;
$imgNo = 0;
$skipLineBreak = false;
$code2dStorage = new Code2DStateStorage();

foreach ($commands as $cmd) {
    if ($debugMode) error_log("". get_class($cmd) ."", 0); //Output the command class in the debug console

    if ($cmd -> isAvailableAs('InitializeCmd')) {
        $formatting = InlineFormatting::getDefault();
    }
    if ($cmd -> isAvailableAs('InlineFormattingCmd')) {
        $cmd -> applyToInlineFormatting($formatting);
    }
    if($cmd -> isAvailableAs('SelectCharCodeCmd')){
        //Let's set the character code table
        $formatting -> setCharCodeTable($cmd->getCodePage());
    }
    if ($cmd -> isAvailableAs('TextContainer')) {
        // Add text to line
        if ($debugMode) error_log("Text or unidentified command: '". $cmd->getText() ."' ", 0);
        $spanContentText = $cmd -> getText($formatting);
        $lineHtml .= span($formatting, $spanContentText);
    }
    if ($cmd -> isAvailableAs('LineBreak') && $skipLineBreak) {
        $skipLineBreak = false;
    } else if ($cmd -> isAvailableAs('LineBreak')) {
        // Write fresh block element out to HTML
        if ($lineHtml === "") {
            $lineHtml = span($formatting);
        }
        // Block-level formatting such as text justification
        $classes = getBlockClasses($formatting);
        $classesStr = implode(" ", $classes);
        $outp[] = wrapInline("<div class=\"$classesStr\">", "</div>", $lineHtml);
        $lineHtml = "";
    }
    if ($cmd -> isAvailableAs('GraphicsDataCmd') || $cmd -> isAvailableAs('GraphicsLargeDataCmd')) {
        $sub = $cmd -> subCommand();
        if ($sub -> isAvailableAs('StoreRasterFmtDataToPrintBufferGraphicsSubCmd')) {
            $bufferedImg = $sub;
        } else if ($sub -> isAvailableAs('PrintBufferredDataGraphicsSubCmd') && $bufferedImg !== null) {
            // Append and flush buffer
            $classes = getBlockClasses($formatting);
            $classesStr = implode(" ", $classes);
            $outp[] = wrapInline("<div class=\"$classesStr\">", "</div>", imgAsDataUrl($bufferedImg));
            $lineHtml = "";
        }
    } else if ($cmd -> isAvailableAs('ImageContainer')) {
        // Append and flush buffer
        $classes = getBlockClasses($formatting);
        $classesStr = implode(" ", $classes);
        $outp[] = wrapInline("<div class=\"$classesStr\">", "</div>", imgAsDataUrl($cmd));
        $lineHtml = "";
        // Should load into print buffer and print next line break, but we print immediately, so need to skip the next line break.
        $skipLineBreak = true;
    }
    if ($cmd -> isAvailableAs('Code2DDataCmd')){
        $sub = $cmd -> subCommand();
        if ($debugMode)  {
            error_log("Subcommand ". get_class($sub) ."", 0); //Output the subcommand class in the debug console
            error_log("Function " . $sub->get_fn() ."",0);
            error_log("Data size:". $sub->getDataSize() ."",0);
            error_log("Data: " . $sub->get_data() ."",0);
        }
        if($sub->isAvailableAs('QRCodeSubCommand')){ 
            switch ($sub->get_fn()) {
                case 65:  //set model
                    $code2dStorage->setQRModel($sub->get_data());
                    break;
                case 67: //set module size
                    $code2dStorage->setModuleSize($sub->get_data());
                    break;
                case 69: //select error correction level
                    $code2dStorage->setErrorCorrectLevel($sub->get_data());
                    break;
                case 80:  //Store QR data
                    $code2dStorage->fillSymbolStorage($sub->get_data());
                    break;
                case 81:  //Print the QR code
                    $qrcodeURI = $code2dStorage->getQRCodeBase64URI();

                    if ($qrcodeURI == Code2DStatestorage::NO_DATA_ERROR){
                        error_log("Warning:  QR code print ordered before contents stored.",0);
                        $imagefile = file_get_contents(__DIR__.'/NoQR.JPG');
                        if ($imagefile === false) {
                            #To make the netprinter work, provide a full path to the image file
                            error_log("ERROR:  NoQR.JPG image not found in ".__DIR__, 0);
                            $imageData = '';
                            $imgSrc = '';
                        }
                        else {
                            $imageData = base64_encode($imagefile);
                            $imgSrc = 'data:image/jpeg;base64,' . $imageData;
                        }
                        $qrcodeData = Code2dStatestorage::NO_DATA_ERROR;
                        $outp[] = "<div class=\"esc-line esc-justify-center\"><img class=\"esc-bitimage\" src=\"$imgSrc\" alt=\"$qrcodeData\" /></div>";
                    }
                    else {
                        $qrcodeData = $code2dStorage->getQRCodeData();
                        $outp[] = "<div class=\"esc-line esc-justify-center\"><img class=\"esc-bitimage\" src=\"$qrcodeURI\" alt=\"$qrcodeData\" /></div>";
                    }
                    
                    break;
                case 82:  //Transmit size information of symbol storage data.
                    # TODO: maybe implement by printing the info?
                    break;
            }
        }
    }
}

// Stuff we need in the HTML header
const CSS_FILE = __DIR__ . "/src/resources/esc2html.css";
$metaInfo = array_merge(
    array(
        "<meta charset=\"iso-8859-15\">",
        "<style>"
    ),
    explode("\n", trim(file_get_contents(CSS_FILE))),
    array(
        "</style>"
    )
);

// Final document assembly
$receipt = wrapBlock("<div class=\"esc-receipt\">", "</div>", $outp);
$head = wrapBlock("<head>", "</head>", $metaInfo);
$body = wrapBlock("<body>", "</body>", $receipt);
$html = wrapBlock("<html>", "</html>", array_merge($head, $body), false);
echo "<!DOCTYPE html>\n" . implode("\n", $html) . "\n";
error_log("'". $targetFilename . "' converted to HTML",0);


function imgAsDataUrl($bufferedImg)
{
    $imgAlt = "Image " . $bufferedImg -> getWidth() . 'x' . $bufferedImg -> getHeight();
    $imgSrc = "data:image/png;base64," . base64_encode($bufferedImg -> asPng());
    $imgWidth = $bufferedImg -> getWidth() / 2; // scaling, images are quite high res and dwarf the text
    $bufferedImg = null;
    return "<img class=\"esc-bitimage\" src=\"$imgSrc\" alt=\"$imgAlt\" width=\"{$imgWidth}px\" />";
}

function wrapInline($tag, $closeTag, $content)
{
    return $tag . $content . $closeTag;
}

function wrapBlock($tag, $closeTag, array $content, $indent = true)
{
    $ret = array();
    $ret[] = $tag;
    foreach ($content as $line) {
        $ret[] = ($indent ? '  ' : '') . $line;
    }
    $ret[] = $closeTag;
    return $ret;
}

function span(InlineFormatting $formatting, $spanContentText = false)
{
    // Gut some features-
    if ($formatting -> widthMultiple > 8) {
        // Widths > 2 are not implemented. Cap the width at 2 to avoid formatting issues.
        $formatting -> widthMultiple = 8;
    }
    if ($formatting -> heightMultiple > 8) {
        // Widths > 8 are not implemented either
        $formatting -> heightMultiple = 8;
    }

    // Determine formatting classes to use
    $classes = array();

    if ($formatting -> bold) {
        $classes[] = "esc-emphasis";
    }
    if ($formatting -> underline > 0) {
        $classes[] = $formatting -> underline > 1 ? "esc-underline-double" : "esc-underline";
    }
    if ($formatting -> invert) {
        $classes[] = "esc-invert";
    }
    if ($formatting -> upsideDown) {
        $classes[] = "esc-upside-down";
    }
    if ($formatting -> font == 1) {
        $classes[] = "esc-font-b";
    }
    if ($formatting -> widthMultiple > 1 || $formatting -> heightMultiple > 1) {
        $classes[] = "esc-text-scaled";
        // Add a single class representing height and width scaling
        $widthClass = $formatting -> widthMultiple > 1 ? "-width-" . $formatting -> widthMultiple : "";
        $heightClass = $formatting -> heightMultiple > 1 ? "-height-" . $formatting -> heightMultiple : "";
        $classes[] = "esc" . $widthClass . $heightClass;
    }

    // Provide span content as HTML
    if ($spanContentText === false) {
        $spanContentHtml = "&nbsp;";
    } else {
        $spanContentHtml = htmlentities($spanContentText);
    }

    // Output span with any non-default classes
    if (count($classes) == 0) {
        return $spanContentHtml;
    }
    return "<span class=\"". implode(" ", $classes) . "\">" . $spanContentHtml . "</span>";
}

function getBlockClasses($formatting)
{
    $classes = ["esc-line"];
    if ($formatting -> justification === InlineFormatting::JUSTIFY_CENTER) {
        $classes[] = "esc-justify-center";
    } else if ($formatting -> justification === InlineFormatting::JUSTIFY_RIGHT) {
        $classes[] = "esc-justify-right";
    }
    return $classes;
}