@kirigami/php-prepros 1.1.0 → 1.6.0

package/src/libraries/prepros.class.php

@@ -4,8 +4,9 @@
 final class PREPROS
 {
 
-    public  static mixed  $config;    
-    private static string $root;
+    public  static mixed  $config;
+    public  static string $file  = '';
+    private static string $root  = '';
     private static array  $files = [];
     private static array  $hooks = [];
     private static array  $tags  = [];
@@ -19,6 +20,11 @@ final class PREPROS
             if (!is_file(realpath(self::$root . $path))) continue;
             else include_once(realpath(self::$root . $path));
         }
+        // Plugin-contributed PHP (kiri 'prepros:php' hook): absolute virtual
+        // paths, mounted outside the project by @kirigami/php-prepros.
+        if (!empty($config->phpIncludes)) foreach ($config->phpIncludes as $path) {
+            if (is_file($path)) include_once($path);
+        }
     }
 
 
@@ -26,8 +32,16 @@ final class PREPROS
     {
         $dir = pathinfo($file, PATHINFO_DIRNAME) . S;
         $target = $dir . ltrim(pathinfo($file, PATHINFO_FILENAME), '_') . '.html';
-        $file = realpath($file);
-        $absurl = str_replace('//', '/', str_replace('\\', '/', pathinfo(str_replace(realpath(self::$root), '', $file), PATHINFO_DIRNAME)) . '/');
+        if(!$file = realpath($file)) return false;
+        self::$file = $file;
+        
+        // absolute URL path of the page's dir, prefixed with the baseurl's
+        // subpath (if any) so it stays valid when the site is deployed under a
+        // subfolder, e.g. https://kirigami.github.io/template/
+        $basepath = rtrim((string)parse_url(self::$config->data->baseurl, PHP_URL_PATH), '/');
+        $reldir = str_replace('\\', '/', pathinfo(str_replace(realpath(self::$root), '', $file), PATHINFO_DIRNAME));
+        $absurl = preg_replace('#/+#', '/', $basepath . '/' . trim($reldir, '/') . '/');
+        
         $relroot = FS::getRelativePath($dir, self::$root);
         $page = self::processHook('page_info', [$file, FS::phpFileInfo($file)]);
 
@@ -37,8 +51,9 @@ final class PREPROS
         self::processHook('pre_render', file_get_contents($file));
 
         ob_start();
+        self::processHook('pre_before', self::$config->before);
         if (self::$config->before) include(realpath(self::$root . self::$config->before));
-        $header = ob_get_clean();
+        $header = self::processHook('post_before', ob_get_clean());
 
         if(empty($content)) {
             ob_start();
@@ -53,17 +68,25 @@ final class PREPROS
         }
 
         ob_start();
+        self::processHook('pre_after', self::$config->after);
         if (self::$config->after) include(realpath(self::$root . self::$config->after));
-        $footer = ob_get_clean();
+        $footer = self::processHook('post_after', ob_get_clean());
 
         $contents = $header . $body . $footer;
         $contents = self::processTags($contents);
         $contents = self::processHook('post_render', $contents);
 
+        if ((self::$config->head ?? true) !== false) {
+            $contents = self::injectHead($contents, $relroot);
+        }
+
         if(!empty(self::$config->format)) $contents = HTML::format($contents);
 
+        $contents = self::replaceTokens($contents);
+
         file_put_contents($target, $contents);
         self::exportFile($target);
+        self::$file = '';
         return realpath($target);
     }
 
@@ -100,11 +123,103 @@ final class PREPROS
 
         $dest = self::$root . 'sitemap.xml';
         file_put_contents($dest, $dom->saveXML());
-        self::exportFile($dest);
+        
+        $destrobots = self::$root . 'robots.txt';
+        $urlrobots = rtrim(self::$config->data->baseurl, '/') . '/sitemap.xml';
+        file_put_contents($destrobots, "User-agent: *\nAllow: /\nSitemap: {$urlrobots}");
+        
+        self::exportFile([$dest, $destrobots]);
         return realpath($dest);
     }
 
 
+    /**
+     * Auto-wires each page: a theme/FOUC guard as the first child of <head>, a
+     * <link> for every `sass` task output, a <script> (no `defer`, before
+     * </body>) for every `esbuild` task output, and — when `format` is on — a
+     * tiny de-indent script that flattens the leading whitespace HTML::format()
+     * adds inside `<pre><code>`. Paths use $relroot so they work at any depth.
+     *
+     * Runs unless `prepros.head` is `false`. A single task opts out with
+     * `head: false`. A file already referenced in the page is left alone.
+     * `###TIMESTAMP###` is expanded by replaceTokens() right after.
+     */
+    private static function injectHead(string $contents, string $relroot): string
+    {
+        $inject = [];
+
+        // Theme guard — skip if the page already carries one.
+        if (!str_contains($contents, 'kirigami-theme')) {
+            $inject[] = '<script>(function(){var e=document.documentElement;'
+                . 'e.classList.add("js");try{var t=localStorage.getItem("kirigami-theme");'
+                . 'if(t==="dark"||t==="light")e.setAttribute("data-theme",t)}catch(x){}})();</script>';
+        }
+
+        $links   = [];
+        $scripts = [];
+
+        // Undo the <pre><code> indentation HTML::format() added, at parse time
+        // (before first paint), for blocks a build-time highlighter didn't
+        // already flatten (those carry child <span>s).
+        if (!empty(self::$config->format)) {
+            $scripts[] = '<script>document.querySelectorAll("pre>code").forEach(function(c){'
+                . 'if(c.children.length)return;'
+                . 'var L=c.textContent.replace(/^\n+/,"").replace(/\s+$/,"").split("\n"),n=1/0;'
+                . 'L.forEach(function(l){if(l.trim())n=Math.min(n,l.match(/^\s*/)[0].length)});'
+                . 'if(n&&n<1/0)c.textContent=L.map(function(l){return l.slice(n)}).join("\n")});</script>';
+        }
+        foreach ((array) (self::$config->tasks ?? []) as $task) {
+            $task = (array) $task;
+            if (($task['head'] ?? true) === false) continue;
+            $entry = (string) ($task['entry'] ?? '');
+            if ($entry === '') continue;
+
+            if (($task['type'] ?? '') === 'sass') {
+                $out = preg_replace('/\.s?css$/', '.min.css', $entry);
+                if ($out !== $entry && !str_contains($contents, $out)) {
+                    $links[] = '<link rel="stylesheet" href="' . $relroot . $out . '?###TIMESTAMP###">';
+                }
+            } elseif (($task['type'] ?? '') === 'esbuild') {
+                $out = preg_replace('/\.[jt]s$/', '.min.js', $entry);
+                if ($out !== $entry && !str_contains($contents, $out)) {
+                    $scripts[] = '<script src="' . $relroot . $out . '?###TIMESTAMP###"></script>';
+                }
+            }
+        }
+
+        $head = implode("\n    ", array_merge($inject, $links));
+        if ($head !== '') {
+            // Slot it right after <meta charset> when there is one (keep the
+            // charset first), otherwise right after <head>.
+            if (preg_match('/<meta\s+charset=[^>]*>/i', $contents)) {
+                $contents = preg_replace('/(<meta\s+charset=[^>]*>)/i', "$1\n    " . $head, $contents, 1);
+            } elseif (preg_match('/<head\b[^>]*>/i', $contents)) {
+                $contents = preg_replace('/(<head\b[^>]*>)/i', "$1\n    " . $head, $contents, 1);
+            }
+        }
+        if ($scripts && preg_match('/<\/body>/i', $contents)) {
+            $contents = preg_replace('/(<\/body>)/i', "    " . implode("\n    ", $scripts) . "\n$1", $contents, 1);
+        }
+
+        return $contents;
+    }
+
+
+    /**
+     * Expands the build-time text tokens in a generated file. Runs at render
+     * time (so `kiri build` / `kiri watch` previews show real values, not the
+     * literal `###YEAR###`), and again — harmlessly — on export.
+     */
+    private static function replaceTokens(string $contents): string
+    {
+        return strtr($contents, [
+            '###YEAR###'      => date('Y'),
+            '###TIMESTAMP###' => (string) time(),
+            '###TODAY###'     => date('Y-m-d'),
+        ]);
+    }
+
+
     public static function exportFile(string|array $file): void
     {
         if(is_string($file)) $file = [$file];
@@ -118,7 +233,7 @@ final class PREPROS
     public static function getExportedFiles(): array
     {
         $files = array_unique(self::$files);
-        sort($files);
+        // sort($files);
         return $files;
     }
 
@@ -132,19 +247,43 @@ final class PREPROS
     }
 
 
-    public static function mount(string|array $patterns) {
+    public static function mount(string|array $patterns)
+    {
         $results = self::callJS('mount', ['patterns' => $patterns]);
-        if(!$results->success) return false;
+        if (!$results->success) return false;
         return $results->results;
     }
 
 
+    public static function fstat(string $path)
+    {
+        if (!$results = self::callJS('fstat', ['path' => $path])) return false;
+        if (!$results->success) return false;
+        if (!$results->results->exists) return false;
+        return $results->results;
+    }
+
+
+    public static function backtraceFile()
+    {
+        $debug = debug_backtrace();
+        if(!isset($debug[1])) return false;
+        else return $debug[1]['file'];
+    }
+
+
     public static function registerHook(string $hook, callable $clb)
     {
         self::$hooks[$hook][] = $clb;
     }
 
 
+    public static function runHook(string $hook, $data = null)
+    {
+        return self::processHook($hook, $data);
+    }
+
+
     private static function processHook(string $hook, $data = null)
     {
         if (!empty(self::$hooks[$hook])) {

package/src/libraries/prepros.plugins.php

@@ -7,22 +7,72 @@ PREPROS::registerTag('markdown', function ($tag, $attrs, $body) {
 });
 
 
+PREPROS::registerTag('img', function ($tag, $attrs, $body) {
+    if(empty($attrs['asset'])) return $tag;
+	$width = 0;
+	$height = 0;
+	$cover = false;
+	if(isset($attrs['width'])) {
+		$width = $attrs['width'] ?? 0;
+		unset($attrs['width']);
+	}
+	if(isset($attrs['height'])) {
+		$height = $attrs['height'] ?? 0;
+		unset($attrs['height']);
+	}
+	if(isset($attrs['cover'])) {
+		$cover = true;
+		unset($attrs['cover']);
+	}
+	$attrs['src'] = IMG::asset($attrs['asset'], $width, $height, $cover, PREPROS::$file);
+	unset($attrs['asset']);
+	foreach($attrs as $k => $v) $props[] = $k.'="'.$v.'"';
+    return '<img'.(!empty($props) ? ' '.join(' ', $props): '').'>';
+});
+
+
 PREPROS::registerHook('page_info', function($info) {
-	list($file, $page) = $info;
+	// The hook fires with [$file, $pageInfo]; every callback then returns just
+	// the (possibly modified) $pageInfo, so a callback registered after this
+	// one receives the bare object. Accept either shape.
+	if (is_array($info)) {
+		[$file, $page] = $info;
+	} else {
+		$page = $info;
+		$file = PREPROS::$file;
+	}
 	foreach($page as $k => $v) {
 		$ext = strtolower(pathinfo($v, PATHINFO_EXTENSION));
 		if(in_array($ext, ['yaml', 'yml', 'json', 'md']) ) {
-			if(preg_match('#^https?:#i', $v)) $filename = $v;
+			$isUrl = STR::is_url($v);
+			if($isUrl) $filename = $v;
 			else $filename = pathinfo(realpath($file), PATHINFO_DIRNAME) . '/' . $v;
-			if(is_file($filename) || preg_match('#^https?:#i', $v)) {
+			if($isUrl || is_file($filename)) {
+				// Remote URLs always go through CURL::getContents — never
+				// file_get_contents, which this PHP build can't use for http(s).
+				$raw = $isUrl ? CURL::getContents($filename) : file_get_contents($filename);
+				if($raw === false) continue;
 				$page->{$k} = match ($ext) {
-					'yml', 'yaml' => YAML::parseFile($filename),
-					'json'        => json_decode(file_get_contents($filename)),
-					'md'          => MD::toHtml(file_get_contents($filename)),
+					'yml', 'yaml' => YAML::parse($raw),
+					'json'        => json_decode($raw),
+					'md'          => MD::toHtml($raw),
 					default       => $filename,
 				};
 			}
 		}
 	}
 	return $page;
+});
+
+
+// LD — capture the page under render, then inject the automatic
+// schema.org JSON-LD `<script>` into its `<head>` once the HTML is assembled.
+// Registered after the data-loading hook above so `$page` arrives resolved.
+PREPROS::registerHook('page_info', function($page) {
+	LD::capture($page);
+	return $page;
+});
+
+PREPROS::registerHook('post_render', function($html) {
+	return LD::inject($html);
 });