HtmGem/index.php

<?php

require_once "lib-htmgem.php";

# The url argument is always absolute compared to the document root.
$url = @$_REQUEST["url"];

/* Installation page
 *
 * Accessing directly /htmgem will make display the self-hosted documentation
 * contained in "index.gmi". If it's removed, diplay an empty page with a
 * comment
 */
if (empty($url)) {
    if (!file_exists("index.gmi")) {
        http_response_code(403);
        die("<!-- index.gmi missing -->");
    }
    $t = new \htmgem\GemTextTranslate_html(@file_get_contents("index.gmi"));
    echo $t->getFullHtml();
    exit();
}

$documentRoot = $_SERVER['DOCUMENT_ROOT'];

# Removes the headling and trailling slashes, to be sure there's not any.
$filePath = rtrim($_SERVER['DOCUMENT_ROOT'], "/")."/".ltrim($url, "/");

switch(true) {
    case !realPath($filePath):
    case !preg_match("/\.gmi$/", $url): # not finishing by .gmi
    case strpos($filePath, $documentRoot)!==0: # not in web directory
        $go404 = true;
        // Says 404 even if the file exists to not give any information.
        break;
    default:
        $go404 = false;
}

/* 404 page
 */
if ($go404) {
    error_log("HtmGem: 404 $url $filePath");
    http_response_code(404);
    $page404 = <<<EOF
# ⚠ Page non trouvée

**$url**

=> .. 🔄 🔄
EOF;
    $t = new \htmgem\GemTextTranslate_html($page404);
    echo $t->getFullHtml();
    exit();
}

# to false only if textDecoration=0 in the URL
$textDecoration = "0" != @$_REQUEST['textDecoration'];

$fileContents = @file_get_contents($filePath);
# Removes the Byte Order Mark
$fileContents = preg_replace("/\xEF\xBB\xBF/", "", $fileContents);


/* CSS and special style management
 */

$style = @$_REQUEST['style'];
if ("source" == $style) {
    $basename = basename($filePath);
    header("Cache-Control: public");
    header("Content-Disposition: attachment; filename=$basename");
    header("Content-Type: text/plain");
    header("Content-Transfer-Encoding: binary");
    header('Content-Length: ' . filesize($filePath));
    echo $fileContents;
    exit();
} elseif ("pre" == $style) {
    # Gets the page title: the first occurrence with # at the line start
    mb_ereg("#\s*([^\n]+)\n", $fileContents, $matches);
    $page_title = @$matches[1];
    $fileContents = htmlspecialchars($fileContents, ENT_HTML5|ENT_QUOTES, "UTF-8", true);
    echo <<<EOL
<!DOCTYPE html>
<html>
<head>
<title>$page_title</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<pre>
$fileContents</pre>
</body>
</html>
EOL;
    exit();
}

$t = new \htmgem\GemTextTranslate_html($fileContents, $textDecoration);
if ("none" == $style) {
    $t->addCss("");
} elseif ("/" == @$style[0]) {
    $t->addCss($style);
} elseif (empty($style)) {
    $parts = pathinfo($filePath);
    $localCss = $parts["filename"].".css";
    $localCssFilePath = $parts["dirname"]."/".$localCss;
    if (file_exists($localCssFilePath)) {
        # Warning, using htmhem.php?url=… will make $localCss not found
        # as the path is relative to htmgem.php and not / !
        $t->addCss($localCss);
    }
} else { #TODO: regex check for $style
    $t->addCss("/htmgem/css/$style.css");
}

echo $t->getFullHtml();

?>
-												Setup easy installation on shared host

											
										
										
											2021-03-09 00:48:07 +01:00
+								<?php
-												Split index.php into two files to isolate the lib

											
										
										
											2021-03-16 13:49:11 +01:00
+								require_once "lib-htmgem.php";
-												Adds 404 page

											
										
										
											2021-03-09 01:21:50 +01:00
-												Deep refactoring: parsing, translating, classes

* Removes "^" to disable text decoration line-wise.
* Split HTML generation in two: parsing and translating.
* Create class to handle gemtext parsing.
* Create class to translate to HTML.
* Create class to generate back gemtext (for future test cases).
* Uses generators to parse then translate.
* Fix: 404 doesn't occur for an empty file.
* Page 404 fully generated by HtmGem itself.
* CSS is no longer incorporated in the HTML page.
* Handle CSS inclusion by addCss() calls.

											
										
										
											2021-03-16 20:54:10 +01:00
+								# The url argument is always absolute compared to the document root.
-												Manages the styles. WIP.

											
										
										
											2021-03-09 11:26:31 +01:00
+								$url = @$_REQUEST["url"];
-												Deep refactoring: parsing, translating, classes

* Removes "^" to disable text decoration line-wise.
* Split HTML generation in two: parsing and translating.
* Create class to handle gemtext parsing.
* Create class to translate to HTML.
* Create class to generate back gemtext (for future test cases).
* Uses generators to parse then translate.
* Fix: 404 doesn't occur for an empty file.
* Page 404 fully generated by HtmGem itself.
* CSS is no longer incorporated in the HTML page.
* Handle CSS inclusion by addCss() calls.

											
										
										
											2021-03-16 20:54:10 +01:00
+								/* Installation page
 								 *
 								 * Accessing directly /htmgem will make display the self-hosted documentation
 								 * contained in "index.gmi". If it's removed, diplay an empty page with a
 								 * comment
 								 */
-												Setup easy installation on shared host

											
										
										
											2021-03-09 00:48:07 +01:00
+								if (empty($url)) {
-												Shows nothing if index.gmi is not present

											
										
										
											2021-03-09 02:03:24 +01:00
+								    if (!file_exists("index.gmi")) {
 								        http_response_code(403);
 								        die("<!-- index.gmi missing -->");
 								    }
-												Deep refactoring: parsing, translating, classes

* Removes "^" to disable text decoration line-wise.
* Split HTML generation in two: parsing and translating.
* Create class to handle gemtext parsing.
* Create class to translate to HTML.
* Create class to generate back gemtext (for future test cases).
* Uses generators to parse then translate.
* Fix: 404 doesn't occur for an empty file.
* Page 404 fully generated by HtmGem itself.
* CSS is no longer incorporated in the HTML page.
* Handle CSS inclusion by addCss() calls.

											
										
										
											2021-03-16 20:54:10 +01:00
+								    $t = new \htmgem\GemTextTranslate_html(@file_get_contents("index.gmi"));
 								    echo $t->getFullHtml();
 								    exit();
-												Setup easy installation on shared host

											
										
										
											2021-03-09 00:48:07 +01:00
+								}
-												Enable security on what gmi file the client asks.

* checks realPath() against no-existent files,
* checks the file suffix '.gmi'
* checks the directory belongs to that of the site.

											
										
										
											2021-03-18 21:18:49 +01:00
+								$documentRoot = $_SERVER['DOCUMENT_ROOT'];
-												Setup easy installation on shared host

											
										
										
											2021-03-09 00:48:07 +01:00
-												Deep refactoring: parsing, translating, classes

* Removes "^" to disable text decoration line-wise.
* Split HTML generation in two: parsing and translating.
* Create class to handle gemtext parsing.
* Create class to translate to HTML.
* Create class to generate back gemtext (for future test cases).
* Uses generators to parse then translate.
* Fix: 404 doesn't occur for an empty file.
* Page 404 fully generated by HtmGem itself.
* CSS is no longer incorporated in the HTML page.
* Handle CSS inclusion by addCss() calls.

											
										
										
											2021-03-16 20:54:10 +01:00
+								# Removes the headling and trailling slashes, to be sure there's not any.
 								$filePath = rtrim($_SERVER['DOCUMENT_ROOT'], "/")."/".ltrim($url, "/");
-												Setup easy installation on shared host

											
										
										
											2021-03-09 00:48:07 +01:00
-												Enable security on what gmi file the client asks.

* checks realPath() against no-existent files,
* checks the file suffix '.gmi'
* checks the directory belongs to that of the site.

											
										
										
											2021-03-18 21:18:49 +01:00
+								switch(true) {
 								    case !realPath($filePath):
 								    case !preg_match("/\.gmi$/", $url): # not finishing by .gmi
 								    case strpos($filePath, $documentRoot)!==0: # not in web directory
 								        $go404 = true;
 								        // Says 404 even if the file exists to not give any information.
 								        break;
 								    default:
 								        $go404 = false;
 								}
-												Deep refactoring: parsing, translating, classes

* Removes "^" to disable text decoration line-wise.
* Split HTML generation in two: parsing and translating.
* Create class to handle gemtext parsing.
* Create class to translate to HTML.
* Create class to generate back gemtext (for future test cases).
* Uses generators to parse then translate.
* Fix: 404 doesn't occur for an empty file.
* Page 404 fully generated by HtmGem itself.
* CSS is no longer incorporated in the HTML page.
* Handle CSS inclusion by addCss() calls.

											
										
										
											2021-03-16 20:54:10 +01:00
+								/* 404 page
 								 */
-												Enable security on what gmi file the client asks.

* checks realPath() against no-existent files,
* checks the file suffix '.gmi'
* checks the directory belongs to that of the site.

											
										
										
											2021-03-18 21:18:49 +01:00
+								if ($go404) {
-												Manages the styles. WIP.

											
										
										
											2021-03-09 11:26:31 +01:00
+								    error_log("HtmGem: 404 $url $filePath");
-												Deep refactoring: parsing, translating, classes

* Removes "^" to disable text decoration line-wise.
* Split HTML generation in two: parsing and translating.
* Create class to handle gemtext parsing.
* Create class to translate to HTML.
* Create class to generate back gemtext (for future test cases).
* Uses generators to parse then translate.
* Fix: 404 doesn't occur for an empty file.
* Page 404 fully generated by HtmGem itself.
* CSS is no longer incorporated in the HTML page.
* Handle CSS inclusion by addCss() calls.

											
										
										
											2021-03-16 20:54:10 +01:00
+								    http_response_code(404);
 								    $page404 = <<<EOF
-												Manages the styles. WIP.

											
										
										
											2021-03-09 11:26:31 +01:00
+								# ⚠ Page non trouvée
-												Adds 404 page

											
										
										
											2021-03-09 01:21:50 +01:00
-												Fixes 404 page text decoration, adds reload message

											
										
										
											2021-03-13 11:45:54 +01:00
+								**$url**
-												Adds 404 page

											
										
										
											2021-03-09 01:21:50 +01:00
-												Adds icons in the 404 page

											
										
										
											2021-03-18 21:16:30 +01:00
+								=> .. 🔄 🔄
-												Adds 404 page

											
										
										
											2021-03-09 01:21:50 +01:00
+								EOF;
-												Deep refactoring: parsing, translating, classes

* Removes "^" to disable text decoration line-wise.
* Split HTML generation in two: parsing and translating.
* Create class to handle gemtext parsing.
* Create class to translate to HTML.
* Create class to generate back gemtext (for future test cases).
* Uses generators to parse then translate.
* Fix: 404 doesn't occur for an empty file.
* Page 404 fully generated by HtmGem itself.
* CSS is no longer incorporated in the HTML page.
* Handle CSS inclusion by addCss() calls.

											
										
										
											2021-03-16 20:54:10 +01:00
+								    $t = new \htmgem\GemTextTranslate_html($page404);
 								    echo $t->getFullHtml();
 								    exit();
-												Setup easy installation on shared host

											
										
										
											2021-03-09 00:48:07 +01:00
+								}
-												Enable security on what gmi file the client asks.

* checks realPath() against no-existent files,
* checks the file suffix '.gmi'
* checks the directory belongs to that of the site.

											
										
										
											2021-03-18 21:18:49 +01:00
+								# to false only if textDecoration=0 in the URL
 								$textDecoration = "0" != @$_REQUEST['textDecoration'];
-												Deep refactoring: parsing, translating, classes

* Removes "^" to disable text decoration line-wise.
* Split HTML generation in two: parsing and translating.
* Create class to handle gemtext parsing.
* Create class to translate to HTML.
* Create class to generate back gemtext (for future test cases).
* Uses generators to parse then translate.
* Fix: 404 doesn't occur for an empty file.
* Page 404 fully generated by HtmGem itself.
* CSS is no longer incorporated in the HTML page.
* Handle CSS inclusion by addCss() calls.

											
										
										
											2021-03-16 20:54:10 +01:00
 								$fileContents = @file_get_contents($filePath);
-												Setup easy installation on shared host

											
										
										
											2021-03-09 00:48:07 +01:00
+								# Removes the Byte Order Mark
 								$fileContents = preg_replace("/\xEF\xBB\xBF/", "", $fileContents);
-												Deep refactoring: parsing, translating, classes

* Removes "^" to disable text decoration line-wise.
* Split HTML generation in two: parsing and translating.
* Create class to handle gemtext parsing.
* Create class to translate to HTML.
* Create class to generate back gemtext (for future test cases).
* Uses generators to parse then translate.
* Fix: 404 doesn't occur for an empty file.
* Page 404 fully generated by HtmGem itself.
* CSS is no longer incorporated in the HTML page.
* Handle CSS inclusion by addCss() calls.

											
										
										
											2021-03-16 20:54:10 +01:00
+								/* CSS and special style management
 								 */
-												Manages the styles. WIP.

											
										
										
											2021-03-09 11:26:31 +01:00
-												Deep refactoring: parsing, translating, classes

* Removes "^" to disable text decoration line-wise.
* Split HTML generation in two: parsing and translating.
* Create class to handle gemtext parsing.
* Create class to translate to HTML.
* Create class to generate back gemtext (for future test cases).
* Uses generators to parse then translate.
* Fix: 404 doesn't occur for an empty file.
* Page 404 fully generated by HtmGem itself.
* CSS is no longer incorporated in the HTML page.
* Handle CSS inclusion by addCss() calls.

											
										
										
											2021-03-16 20:54:10 +01:00
+								$style = @$_REQUEST['style'];
-												Manages the styles. WIP.

											
										
										
											2021-03-09 11:26:31 +01:00
+								if ("source" == $style) {
-												Forces download when using "source" as a style

											
										
										
											2021-03-13 00:30:49 +01:00
+								    $basename = basename($filePath);
 								    header("Cache-Control: public");
 								    header("Content-Disposition: attachment; filename=$basename");
 								    header("Content-Type: text/plain");
 								    header("Content-Transfer-Encoding: binary");
 								    header('Content-Length: ' . filesize($filePath));
-												Deep refactoring: parsing, translating, classes

* Removes "^" to disable text decoration line-wise.
* Split HTML generation in two: parsing and translating.
* Create class to handle gemtext parsing.
* Create class to translate to HTML.
* Create class to generate back gemtext (for future test cases).
* Uses generators to parse then translate.
* Fix: 404 doesn't occur for an empty file.
* Page 404 fully generated by HtmGem itself.
* CSS is no longer incorporated in the HTML page.
* Handle CSS inclusion by addCss() calls.

											
										
										
											2021-03-16 20:54:10 +01:00
+								    echo $fileContents;
-												Forces download when using "source" as a style

											
										
										
											2021-03-13 00:30:49 +01:00
+								    exit();
-												Adds the style "pre"

											
										
										
											2021-03-09 12:02:04 +01:00
+								} elseif ("pre" == $style) {
-												Deep refactoring: parsing, translating, classes

* Removes "^" to disable text decoration line-wise.
* Split HTML generation in two: parsing and translating.
* Create class to handle gemtext parsing.
* Create class to translate to HTML.
* Create class to generate back gemtext (for future test cases).
* Uses generators to parse then translate.
* Fix: 404 doesn't occur for an empty file.
* Page 404 fully generated by HtmGem itself.
* CSS is no longer incorporated in the HTML page.
* Handle CSS inclusion by addCss() calls.

											
										
										
											2021-03-16 20:54:10 +01:00
+								    # Gets the page title: the first occurrence with # at the line start
 								    mb_ereg("#\s*([^\n]+)\n", $fileContents, $matches);
 								    $page_title = @$matches[1];
-												Escapes the quotes and enable double encode

											
										
										
											2021-03-20 15:00:24 +01:00
+								    $fileContents = htmlspecialchars($fileContents, ENT_HTML5|ENT_QUOTES, "UTF-8", true);
-												Adds the style "pre"

											
										
										
											2021-03-09 12:02:04 +01:00
+								    echo <<<EOL
 								<!DOCTYPE html>
 								<html>
 								<head>
 								<title>$page_title</title>
 								<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 								</head>
-												Deep refactoring: parsing, translating, classes

* Removes "^" to disable text decoration line-wise.
* Split HTML generation in two: parsing and translating.
* Create class to handle gemtext parsing.
* Create class to translate to HTML.
* Create class to generate back gemtext (for future test cases).
* Uses generators to parse then translate.
* Fix: 404 doesn't occur for an empty file.
* Page 404 fully generated by HtmGem itself.
* CSS is no longer incorporated in the HTML page.
* Handle CSS inclusion by addCss() calls.

											
										
										
											2021-03-16 20:54:10 +01:00
+								<pre>
 								$fileContents</pre>
-												Adds the style "pre"

											
										
										
											2021-03-09 12:02:04 +01:00
+								</body>
 								</html>
 								EOL;
-												Deep refactoring: parsing, translating, classes

* Removes "^" to disable text decoration line-wise.
* Split HTML generation in two: parsing and translating.
* Create class to handle gemtext parsing.
* Create class to translate to HTML.
* Create class to generate back gemtext (for future test cases).
* Uses generators to parse then translate.
* Fix: 404 doesn't occur for an empty file.
* Page 404 fully generated by HtmGem itself.
* CSS is no longer incorporated in the HTML page.
* Handle CSS inclusion by addCss() calls.

											
										
										
											2021-03-16 20:54:10 +01:00
+								    exit();
-												WIP

											
										
										
											2021-03-18 14:43:02 +01:00
+								}
 								$t = new \htmgem\GemTextTranslate_html($fileContents, $textDecoration);
 								if ("none" == $style) {
 								    $t->addCss("");
 								} elseif ("/" == @$style[0]) {
 								    $t->addCss($style);
 								} elseif (empty($style)) {
 								    $parts = pathinfo($filePath);
 								    $localCss = $parts["filename"].".css";
 								    $localCssFilePath = $parts["dirname"]."/".$localCss;
 								    if (file_exists($localCssFilePath)) {
 								        # Warning, using htmhem.php?url=… will make $localCss not found
 								        # as the path is relative to htmgem.php and not / !
 								        $t->addCss($localCss);
-												Manages the styles. WIP.

											
										
										
											2021-03-09 11:26:31 +01:00
+								    }
-												WIP

											
										
										
											2021-03-18 14:43:02 +01:00
+								} else { #TODO: regex check for $style
 								    $t->addCss("/htmgem/css/$style.css");
-												Manages the styles. WIP.

											
										
										
											2021-03-09 11:26:31 +01:00
+								}
-												Deep refactoring: parsing, translating, classes

* Removes "^" to disable text decoration line-wise.
* Split HTML generation in two: parsing and translating.
* Create class to handle gemtext parsing.
* Create class to translate to HTML.
* Create class to generate back gemtext (for future test cases).
* Uses generators to parse then translate.
* Fix: 404 doesn't occur for an empty file.
* Page 404 fully generated by HtmGem itself.
* CSS is no longer incorporated in the HTML page.
* Handle CSS inclusion by addCss() calls.

											
										
										
											2021-03-16 20:54:10 +01:00
+								echo $t->getFullHtml();
-												Setup easy installation on shared host

											
										
										
											2021-03-09 00:48:07 +01:00
 								?>