drawshield.php

<?php /* Copyright 2010-2021 Karl Wilcox, Mattias Basaglia

This file is part of the DrawShield.net heraldry image creation program

    DrawShield is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

     DrawShield 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with  DrawShield.  If not, see https://www.gnu.org/licenses/.
 */

include 'utils/general.inc';  // general utilities, duh.
set_exception_handler('display_bug');
$timings = array('start' => microtime(true));
$memory = array('start' => memory_get_usage(true));
register_shutdown_function(function(){
    global $options;
    $error = error_get_last();
    if (null !== $error && $error['type'] == "1") {
        error_log($options['blazon'] . ' causes ' . $error['type'] . ' '  . $error['message'] .
          " at " . $error['file'] . ':' . $error['line']);
    }
});

//////////////////////////////////////////////
// Stage 1a - Set default and fallback options
/////////////////////////////////////////////
$options = array();
$version = array();
$request = array();
include 'version.inc';  // sets default and fallback options

//////////////////////////////////////////////
// Stage 1b - command line arguments (if any)
/////////////////////////////////////////////
if (isset($argc)) {
    $options['requestSource'] = 'shell';
    if ($argc > 1) { // run in debug mode, probably
        // Do we have any command line arguments? If so, incorporate into options array
        $myArgs = arguments($argv);
        foreach ($myArgs['options'] as $option => $value) {
            $value = urldecode($value);
            $request[$option] = $value;
        }
        if (!array_key_exists('blazon', $request))
            $request['blazon'] = implode(' ', $myArgs['arguments']);
    } else { // otherwise, run anything in the debug script
        // This NEVER HAPPENS ON THE SERVER (as $argc is never set)
        // so it is safe (but useless) to copy debug.inc to the server
        if (file_exists('debug.inc')) include 'debug.inc';
    }
} else {
    $request = array_merge($_GET, $_POST);
}

//////////////////////////////////////////////
// Stage 1c -process any arguments from the superglobals? SERVER ONLY (probably)
/////////////////////////////////////////////
$ar = null;
$svgOutput = null;
$dom = null;
$messages = null;
$jsonData = [];

// Process superglobal settings into the options array
if (isset($request['outputformat'])) $options['outputFormat'] = strip_tags($request['outputformat']);
if (isset($request['saveformat'])) $options['saveFormat'] = strip_tags($request['saveformat']);
if (isset($request['asfile']) && $request['asfile'] != '0') $options['asFile'] = strip_tags($request['asfile']);
if (isset($request['palette'])) $options['palette'] = strip_tags($request['palette']);
if (isset($request['shape'])) $options['shape'] = strip_tags($request['shape']);
if (isset($request['stage'])) $options['stage'] = strip_tags($request['stage']);
if (isset($request['filename'])) $options['filename'] = strip_tags($request['filename']);
if (isset($request['effect'])) $options['effect'] = strip_tags($request['effect']);
if (isset($request['background'])) $options['background'] = strip_tags($request['background']);
if (isset($request['size'])) $options['size'] = intval($request['size']);
if (isset($request['margin'])) $options['margin'] = intval($request['margin']);
if (isset($request['units'])) $options['units'] = strip_tags($request['units']);
if (isset($request['ar'])) $ar = strip_tags($request['ar']);
if (isset($request['webcols'])) $options['useWebColours'] = $request['webcols'] == 'yes';
if (isset($request['tartancols'])) $options['useTartanColours'] = $request['tartancols'] == 'yes';
if (isset($request['whcols'])) $options['useWarhammerColours'] = $request['whcols'] == 'yes';
if (isset($request['customPalette']) && is_array($request['customPalette'])) $options['customPalette'] = $request['customPalette'];

//////////////////////////////////////////////
// Stage 2a - blazon preparation
/////////////////////////////////////////////

// We do support sending the blazon in an uploaded file but this is not currently implemented
// on the site anywhere, we always use POST fields
if (isset($_FILES['blazonfile']) && ($_FILES['blazonfile']['name'] != "")) {
    $fileName = $_FILES['blazonfile']['name'];
    $fileSize = $_FILES['blazonfile']['size'];
    $fileTmpName = $_FILES['blazonfile']['tmp_name'];
    // $fileType = $_FILES['blazonfile']['type']; // not currently used
    if (preg_match('/.txt$/i', $fileName) && $fileSize < 1000000) {
        $options['blazon'] = file_get_contents($fileTmpName);
        $options['requestSource'] = 'upload';
    }
} else {
    if (isset($request['blazon'])) $options['blazon'] = $request['blazon'];
}

// If blazon is null assume 'argent', but skip parsing as we already know the outcome
if (!array_key_exists('blazon', $options) || $options['blazon'] == '') {
    $dom = new DOMDocument('1.0');
    $dom->loadXML($version['dummyAST']);
} else {
    if ($options['outputFormat'] == 'json') {
        // start gathering our parts here
        $jsonData['blazon'] = $options['blazon'];
        $jsonData['creationTime'] = date(DATE_RFC2822);
        $jsonData['pathInfo'] = $_SERVER['REQUEST_URI'] ?? '???';
        $jsonData['options'] = $options;
        unset($jsonData['options']['blazon']); // already have this
    }
    $options['original'] = $options['blazon'];
    $options['blazon'] = strip_tags($options['blazon']);
    $options['blazon'] = preg_replace("/&#?[a-z0-9]{2,8};/i", "", $options['blazon']); // strip all entities.
    $options['blazon'] = preg_replace('/\\\x[0-9a-f]{2}/i', "", $options['blazon']); // strip all entities.
    // log the blazon for research... (unless told not too)
    if ($version['logBlazon']) ds_error_log($options['blazon']);
}


include 'parser/utilities.inc';
include "analyser/utilities.inc";
if (is_null($dom)) {
    //////////////////////////////////////////////
    // Stage 2b - Parsing into XML AST
    /////////////////////////////////////////////
    include "parser/parser.inc";

    $p = new parser('english');
    $dom = $p->parse($options['blazon']);
    $memory['parser'] = memory_get_usage(true);
    $p = null; // destroy parser to save memory
    $timings['parser'] = microtime(true);

    //////////////////////////////////////////////
    // Stage 2c - Filtering out stuff we don't like (code not in repo)
    /////////////////////////////////////////////
    if (file_exists("../../etc/filter.inc")) {
        include "../../etc/filter.inc";
        $filter = new filter($dom);
        $dom = $filter->runFilter();
    }

    //////////////////////////////////////////////
    // Stage 2d - Additional Options may have been in blazon, tidy them up
    /////////////////////////////////////////////
    if ($options['asFile']) {
        $options['printSize'] = $options['size'];
        $options['size'] = 1000;
    }
    // Minimum sensible size
    if ($options['size'] < 100) $options['size'] = 100;
    if ($ar != null) {
        $options['aspectRatio'] = calculateAR($ar);
    }
    // Same for margin, don't pad more than 25% of width
    if ($options['margin'] > $options['size'] / 4) {
        $options['margin'] = intval($options['size'] / 4);
    }
    tidyOptions();;


    //////////////////////////////////////////////
    // Stage 2e - resolve cross references & other fixups
    /////////////////////////////////////////////
    include "analyser/fixups.inc";
    $references = new references($dom);
    $dom = $references->doFixups();
    $memory['fixups'] = memory_get_usage(true);
    $references = null; // destroy references to save memory
    $timings['fixups'] = microtime(true);
}


//////////////////////////////////////////////
// Stage 3a - preparation for drawing
/////////////////////////////////////////////
$xpath = new DOMXPath($dom);
include 'utils/messages.inc';
$messages = new messageStore($dom);
include "svg/draw.inc";
set_error_handler("report_errors_svg");


//////////////////////////////////////////////
// Stage 3b - create SVG version (all formats start as SVG)
/////////////////////////////////////////////
$svgOutput = draw();
$memory['svg draw'] = memory_get_usage(true);

// At this point we should have some valid SVG in $svgOutput, now what?
$target = $options['outputFormat'];
if ($target == 'json') {
    $target = $options['saveFormat'];
} elseif ($options['asFile'] == 'printable') {
    $target = 'svg';
} elseif ($options['asFile']) {
    $target = $options['saveFormat'];
}
// (Sorry about the above mess, needed for historic reasons and to preserve API arguments)


//////////////////////////////////////////////
// Stage 3c - Change image format if required
/////////////////////////////////////////////

if ($target == 'svg') {
    $targetImage = $svgOutput;
} else {
    include 'utils/render.inc';
    $targetImage = convertImageFormat($svgOutput, $target);
    $timings['conversion'] = microtime(true);
    $memory['conversion'] = memory_get_usage(true);
}

if ($options['outputFormat'] == 'json') { // package up things for output as needed
    $targetImage = makeJsonArray(true);
}

//////////////////////////////////////////////
// Stage 4 - output image as per option request
/////////////////////////////////////////////
if ($options['asFile'] == 'printable') {
    //////////////////////////////////////////////
    // Stage 4 option 1 - a printable HTML page
    /////////////////////////////////////////////
    $xpath = new DOMXPath($dom); // re-build xpath with new messages
    header('Content-Type: text/html; charset=utf-8');
    echo "<!doctype html>\n\n<html lang=\"en\">\n<head>\n<title>Shield</title>\n";
    echo "<style>\nsvg { margin-left:auto; margin-right:auto; display:block;}</style>\n</head>\n<body>\n";
    echo "<div>\n$targetImage</div>\n";
    echo "<h2>Blazon</h2>\n";
    echo "<pre class=\"blazon\">{$options['original']}</pre>\n";
    echo "<h2>Image Credits</h2>\n";
    echo "<p>This work is licensed under a <em>Creative Commons Attribution-ShareAlike 4.0 International License</em>.";
    echo " It is a derivative work based on the following source images:</p>";
    echo $messages->getCredits();
    echo "</body>\n</html>\n";
    //////////////////////////////////////////////
    // Stage 4 option 2 - file saved locally in file system
    /////////////////////////////////////////////
} elseif ($options['asFile'] && $options['requestSource'] == 'shell') {
    // We always just write the file locally.
    $name = $options['filename'];
    if ($name == '') $name = 'shield';
    $fileContent = '';
    switch ($options['saveFormat']) {
        case 'json':
            if (substr($name, -5) != '.json') $name .= '.json';
            break;
        case 'svg':
            if (substr($name, -4) != '.svg') $name .= '.svg';
            break;
        case 'pdfLtr':
        case 'pdfA4':
        case 'pdfltr':
        case 'pdfa4':
            if (substr($name, -4) != '.pdf') $name .= '.pdf';
            break;
        case 'jpg':
        case 'jpeg':
            if (substr($name, -4) != '.jpg') $name .= '.jpg';
            break;
        case 'png':
            if (substr($name, -4) != '.png') $name .= '.png';
        default:
            break;
    }
    file_put_contents($name, $targetImage);
    //////////////////////////////////////////////
    // Stage 4 option 3 - An image file downloaded over HTTP
    /////////////////////////////////////////////
} elseif ($options['asFile']) {
    if ($options['outputFormat'] == 'json') { // override saveFormat
        $options['saveFormat'] = 'json';
    }
    $name = $options['filename'];
    if ($name == '') $name = 'shield';
    switch ($options['saveFormat']) {
        case 'json':
            if (substr($name, -5) != '.json') $name .= '.json';
            header("Content-type: application/force-download");
            header("Content-Transfer-Encoding: text");
            header('Content-Disposition: attachment; filename="' . $name .'"');
            header('Content-Type: application/json');
            break;
        case 'svg':
            if (substr($name, -4) != '.svg') $name .= '.svg';
            header("Content-type: application/force-download");
            header("Content-Transfer-Encoding: text");
            header('Content-Disposition: attachment; filename="' . $name .'"');
            header('Content-Type: image/svg+xml');
            break;
        case 'pdfLtr':
        case 'pdfA4':
            if (substr($name, -4) != '.pdf') $name .= '.pdf';
            header("Content-type: application/force-download");
            header("Content-Transfer-Encoding: 8bit");
            header('Content-Disposition: attachment; filename="' . $name .'"');
            header('Content-Type: application/pdf');
            break;
        case 'jpg':
        case 'jpeg':
            if (substr($name, -4) != '.jpg') $name .= '.jpg';
            header("Content-type: application/force-download");
            header("Content-Transfer-Encoding: binary");
            header('Content-Disposition: attachment; filename="' . $name .'"');
            header('Content-Type: image/jpg');
            break;
        case 'png':
            if (substr($name, -4) != '.png') $name .= '.png';
            header("Content-type: application/force-download");
            header("Content-Transfer-Encoding: binary");
            header('Content-Disposition: attachment; filename="' . $name .'"');
            header('Content-Type: image/png');
            break;
        case 'webp':
            if (substr($name, -4) != '.webp') $name .= '.webp';
            header("Content-type: application/force-download");
            header("Content-Transfer-Encoding: binary");
            header('Content-Disposition: attachment; filename="' . $name .'"');
            header('Content-Type: image/webp');
            break;
    }
    echo $targetImage;
    //////////////////////////////////////////////
    // Stage 4 option 4 - image returned over HTTP
    /////////////////////////////////////////////
} else {
    switch ($options['outputFormat']) {
        case 'jpg':
        case 'jpeg':
            header('Content-Type: image/jpg');
            break;
        case 'json': // A PNG image + other data all wrapped up in JSON
            header('Content-Type: application/json');
            break;
        case 'webp':
            header('Content-Type: image/webp');
            break;
        case 'png':
            header('Content-Type: image/png');
            break;
        default:
        case 'svg':
            header('Content-Type: text/xml; charset=utf-8');
            break;
    }
    echo $targetImage;
}