Create the public/ directory, and move all the files.

- Update the includes
- Swap out docroot to use a function

Author: markrandall

.docker/dev/Dockerfile

@@ -0,0 +1,46 @@
+# Development Docker
+#
+# Provides the main runtime engine as well as tooling for running
+# during development
+#
+# NOTES:
+# - Does not copy and files in as it is expected to be handled via a mount
+
+FROM php:8.4-cli
+
+# Codebase doesn't have production flag so we negate it instead with
+# the DEVELOPMENT flag
+ENV DEVELOPMENT=1
+
+#
+# install additional development tooling
+#
+RUN apt update  \
+    && apt-get install -y --no-install-recommends git unzip \
+    && rm -rf /var/lib/apt/lists/*
+
+#
+# Composer is required for dev dependencies
+#
+RUN php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');" \
+    && php -r "if (hash_file('sha384', 'composer-setup.php') === 'c8b085408188070d5f52bcfe4ecfbee5f727afa458b2573b8eaaf77b3419b0bf2768dc67c86944da1544f06fa544fd47') { echo 'Installer verified'.PHP_EOL; } else { echo 'Installer corrupt'.PHP_EOL; unlink('composer-setup.php'); exit(1); }" \
+    && php composer-setup.php \
+    && php -r "unlink('composer-setup.php');" \
+    && mv composer.phar /usr/local/bin/composer
+
+#
+#  node.js - used for socket.dev and other front-end tooling
+#
+RUN apt-get update && apt-get install -y curl gnupg ca-certificates \
+    && mkdir -p /etc/apt/keyrings \
+    && curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg \
+    && echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_22.x nodistro main" | tee /etc/apt/sources.list.d/nodesource.list \
+    && apt-get update && apt-get install -y nodejs \
+    && rm -rf /var/lib/apt/lists/*
+
+#
+# Global dependencies and tools brought in via npm
+#
+RUN npm install -g socket
+
+WORKDIR /app/public

.docker/prod/Dockerfile

@@ -0,0 +1,13 @@
+# "Production" Docker
+#
+# Provides the main runtime for PHP when deploying to a "Production"
+# or "Testing" environment that needs a full container using
+# the inbuilt server (not recommended).
+
+FROM php:8.4-cli
+
+# All of the files from the source location are copied into
+# the /app folder
+RUN mkdir /app
+WORKDIR /app/public
+COPY . /app

include/do-download.inc

@@ -6,6 +6,8 @@
    we would like to know about (PHP binary or source).
 */
 
+use phpweb\ProjectGlobals;
+
 function get_actual_download_file($file)
 {
     // Could be a normal download or a manual download file
@@ -14,7 +16,7 @@ function get_actual_download_file($file)
     // Find out what is the exact file requested
     $found = false;
     foreach ($possible_files as $name => $log) {
-        if (@file_exists($_SERVER['DOCUMENT_ROOT'] . '/distributions/' . $name)) {
+        if (@file_exists(ProjectGlobals::getPublicRoot() . '/distributions/' . $name)) {
             $found = $name;
             break;
         }

include/errors.inc

@@ -6,6 +6,7 @@
 */
 
 use phpweb\I18n\Languages;
+use phpweb\ProjectGlobals;
 
 // A 'good looking' 404 error message page
 function error_404(): void
@@ -578,7 +579,7 @@ function is_known_snippet(string $term): ?string {
  */
 function get_legacy_manual_urls(string $uri): array
 {
-    $filename = $_SERVER["DOCUMENT_ROOT"] . "/manual/legacyurls.json";
+    $filename = ProjectGlobals::getPublicRoot() . "/manual/legacyurls.json";
     $pages_ids = json_decode(file_get_contents($filename), true);
     $page_id = preg_replace_callback('/^manual\/[a-z_A-Z]+\/(.*?)(\.php)?$/', function (array $matches): string {
         if (count($matches) < 2) {

include/get-download.inc

@@ -1,5 +1,7 @@
 <?php
 // Try to make this page non-cached
+use phpweb\ProjectGlobals;
+
 header_nocache();
 
 // No file to download
@@ -18,7 +20,7 @@ $site_config = [
 // Find out what is the exact file requested
 $file = false;
 foreach ($possible_files as $name) {
-    if (@file_exists($_SERVER['DOCUMENT_ROOT'] . '/distributions/' . $name)) {
+    if (@file_exists(ProjectGlobals::getPublicRoot() . '/distributions/' . $name)) {
         $file = $name;
         break;
     }
@@ -41,7 +43,7 @@ if ($file === false) {
 EOT;
 } else {
     // Set local file name
-    $local_file = $_SERVER['DOCUMENT_ROOT'] . '/distributions/' . $file;
+    $local_file = ProjectGlobals::getPublicRoot() . '/distributions/' . $file;
     // Try to get filesize to display
     $size = @filesize($local_file);
 }

include/header.inc

@@ -1,4 +1,7 @@
 <?php
+
+use phpweb\ProjectGlobals;
+
 $css_files = [
     '/fonts/Fira/fira.css',
     '/fonts/Font-Awesome/css/fontello.css',
@@ -39,7 +42,7 @@ if ($config["cache"]) {
     if (is_numeric($config["cache"])) {
         $timestamp = $config["cache"];
     } else {
-        $timestamp = filemtime($_SERVER["DOCUMENT_ROOT"] . "/" . $_SERVER["BASE_PAGE"]);
+        $timestamp = filemtime(ProjectGlobals::getPublicRoot() . "/" . $_SERVER["BASE_PAGE"]);
     }
     $tsstring = gmdate("D, d M Y H:i:s ", $timestamp) . "GMT";
 

include/layout.inc

@@ -3,6 +3,7 @@
 use phpweb\I18n\Languages;
 use phpweb\Navigation\NavItem;
 use phpweb\News\NewsHandler;
+use phpweb\ProjectGlobals;
 
 $_SERVER['STATIC_ROOT'] = $MYSITE;
 $_SERVER['MYSITE'] = $MYSITE;
@@ -95,7 +96,7 @@ function make_image($file, $alt = false, $align = false, $extras = false,
     $webdir = $_SERVER['MYSITE'] . ($dir[0] == '/' ? '' : '/') . $dir;
 
     // Get width and height values if possible
-    if ($addsize && ($size = @getimagesize($_SERVER['DOCUMENT_ROOT'] . "$dir/$file"))) {
+    if ($addsize && ($size = @getimagesize(ProjectGlobals::getPublicRoot() . "$dir/$file"))) {
         $sizeparams = ' ' . trim($size[3]);
     } else {
         $sizeparams = '';
@@ -565,12 +566,12 @@ function get_news_changes()
 }
 
 function doc_toc($lang): void {
-    $file = __DIR__ . "/../manual/$lang/toc/index.inc";
+    $file = ProjectGlobals::getPublicRoot() . "/manual/$lang/toc/index.inc";
     if (!file_exists($file)) {
         $lang = "en"; // Fallback on English if the translation doesn't exist
-        $file = __DIR__ . "/../manual/en/toc/index.inc";
+        $file = ProjectGlobals::getPublicRoot() . "/manual/en/toc/index.inc";
     }
-    require __DIR__ . "/../manual/$lang/toc/index.inc";
+    require ProjectGlobals::getPublicRoot() . "/manual/$lang/toc/index.inc";
 
     echo "<dl>\n";
     doc_toc_list($lang, $TOC, "getting-started");
@@ -612,7 +613,7 @@ function doc_toc($lang): void {
 
 }
 function doc_toc_list($lang, $index, $file): void {
-    include __DIR__ . "/../manual/$lang/toc/$file.inc";
+    include ProjectGlobals::getPublicRoot() . "/manual/$lang/toc/$file.inc";
 
     doc_toc_title($lang, $index, $file);
     foreach ($TOC as $entry) {

include/manual-lookup.inc

@@ -1,6 +1,8 @@
 <?php
 
 // We need this for error reporting
+use phpweb\ProjectGlobals;
+
 include_once __DIR__ . '/errors.inc';
 
 // Try to find some variations of keyword with $prefix in the $lang manual
@@ -14,35 +16,35 @@ function tryprefix($lang, $keyword, $prefix)
 
     // Try the keyword with the prefix
     $try = "/manual/{$lang}/{$prefix}{$keyword}.php";
-    if (@file_exists($_SERVER['DOCUMENT_ROOT'] . $try)) { return $try; }
+    if (@file_exists(ProjectGlobals::getPublicRoot() . $try)) { return $try; }
 
     // Drop out spaces, and try that keyword (if different)
     $nosp = str_replace(" ", "", $keyword);
     if ($nosp != $keyword) {
         $try = "/manual/{$lang}/{$prefix}{$nosp}.php";
-        if (@file_exists($_SERVER['DOCUMENT_ROOT'] . $try)) { return $try; }
+        if (@file_exists(ProjectGlobals::getPublicRoot() . $try)) { return $try; }
     }
 
     // Replace spaces with hyphens, and try that (if different)
     $dasp = str_replace(" ", "-", $keyword);
     if ($dasp != $keyword) {
         $try = "/manual/{$lang}/{$prefix}{$dasp}.php";
-        if (@file_exists($_SERVER['DOCUMENT_ROOT'] . $try)) { return $try; }
+        if (@file_exists(ProjectGlobals::getPublicRoot() . $try)) { return $try; }
     }
 
     // Remove hyphens (and underscores), and try that (if different)
     $noul = str_replace("-", "", $keyword);
     if ($noul != $keyword) {
         $try = "/manual/{$lang}/{$prefix}{$noul}.php";
-        if (@file_exists($_SERVER['DOCUMENT_ROOT'] . $try)) { return $try; }
+        if (@file_exists(ProjectGlobals::getPublicRoot() . $try)) { return $try; }
     }
 
     // urldecode() (%5C == \) Replace namespace sperators, and try that (if different)
     $keyword = urldecode($keyword);
     $noul = str_replace("\\", "-", $keyword);
     if ($noul != $keyword) {
         $try = "/manual/{$lang}/{$prefix}{$noul}.php";
-        if (@file_exists($_SERVER['DOCUMENT_ROOT'] . $try)) { return $try; }
+        if (@file_exists(ProjectGlobals::getPublicRoot() . $try)) { return $try; }
     }
 
     // Replace first - with a dot and try that (for mysqli_ type entries)
@@ -53,7 +55,7 @@ function tryprefix($lang, $keyword, $prefix)
             $keyword[$pos] = '.';
 
             $try = "/manual/{$lang}/{$prefix}{$keyword}.php";
-            if (@file_exists($_SERVER['DOCUMENT_ROOT'] . $try)) { return $try; }
+            if (@file_exists(ProjectGlobals::getPublicRoot() . $try)) { return $try; }
         }
     }
 
@@ -108,9 +110,9 @@ function find_manual_page($lang, $keyword)
     $dbh = false;
     if (class_exists('PDO')) {
         if (in_array('sqlite', PDO::getAvailableDrivers(), true)) {
-            if (file_exists($_SERVER['DOCUMENT_ROOT'] . '/backend/manual-lookup.sqlite')) {
+            if (file_exists(ProjectGlobals::getPublicRoot() . '/backend/manual-lookup.sqlite')) {
                 try {
-                    $dbh = new PDO( 'sqlite:' . $_SERVER['DOCUMENT_ROOT'] . '/backend/manual-lookup.sqlite', '', '', [PDO::ATTR_PERSISTENT => true, PDO::ATTR_EMULATE_PREPARES => true] );
+                    $dbh = new PDO( 'sqlite:' . ProjectGlobals::getPublicRoot() . '/backend/manual-lookup.sqlite', '', '', [PDO::ATTR_PERSISTENT => true, PDO::ATTR_EMULATE_PREPARES => true] );
                 } catch (PDOException $e) {
                     return find_manual_page_slow($lang, $keyword);
                 }
@@ -204,7 +206,7 @@ function find_manual_page($lang, $keyword)
                 // But does the file really exist?
                 // @todo consider redirecting here, instead of including content within the 404
                 // @todo considering the file path is generated from the manual build, we can probably remove this file_exists() check
-                if (file_exists($_SERVER["DOCUMENT_ROOT"] . $r[0])) {
+                if (file_exists(ProjectGlobals::getPublicRoot() . $r[0])) {
                     return $r[0];
                 }
             }

include/shared-manual.inc

@@ -23,6 +23,7 @@ $PGI = []; $SIDEBAR_DATA = '';
 // =============================================================================
 
 use phpweb\I18n\Languages;
+use phpweb\ProjectGlobals;
 use phpweb\UserNotes\Sorter;
 use phpweb\UserNotes\UserNote;
 
@@ -35,7 +36,7 @@ function manual_notes($notes):void {
     global $LANG;
 
     // Get needed values
-    list($filename) = $GLOBALS['PGI']['this'];
+    [$filename] = $GLOBALS['PGI']['this'];
 
     // Drop file extension from the name
     if (substr($filename, -4) == '.php') {
@@ -96,7 +97,7 @@ END_USERNOTE_HEADER;
 function manual_notes_load(string $id): array
 {
     $hash = substr(md5($id), 0, 16);
-    $notes_file = $_SERVER['DOCUMENT_ROOT'] . "/backend/notes/" .
+    $notes_file = ProjectGlobals::getPublicRoot() . "/backend/notes/" .
                   substr($hash, 0, 2) . "/$hash";
 
     // Open the note file for reading and get the data (12KB)
@@ -140,7 +141,7 @@ function manual_note_display(UserNote $note, $voteOption = true): void
 
     // Vote User Notes Div
     if ($voteOption) {
-        list($redir_filename) = $GLOBALS['PGI']['this'];
+        [$redir_filename] = $GLOBALS['PGI']['this'];
         if (substr($redir_filename, -4) == '.php') {
             $redir_filename = substr($redir_filename, 0, -4);
         }
@@ -286,9 +287,9 @@ function manual_setup($setup): void {
     $_SERVER['BASE_HREF'] = $MYSITE . $_SERVER['BASE_PAGE'];
 
     $timestamps = [
-        filemtime($_SERVER["DOCUMENT_ROOT"] . "/" . $_SERVER["BASE_PAGE"]),
-        filemtime($_SERVER["DOCUMENT_ROOT"] . "/include/prepend.inc"),
-        filemtime($_SERVER["DOCUMENT_ROOT"] . "/styles/theme-base.css"),
+        filemtime(ProjectGlobals::getPublicRoot() . "/" . $_SERVER["BASE_PAGE"]),
+        filemtime(ProjectGlobals::getProjectRoot() . "/include/prepend.inc"),
+        filemtime(ProjectGlobals::getPublicRoot() . "/styles/theme-base.css"),
     ];
 
     // Load user note for this page