dbxContentPageCache.class.php

Go to the documentation of this file.

<?php
namespace dbx\dbxContent;
 
require_once __DIR__ . '/dbxContentLng.class.php';
 
class dbxContentPageCache {
 
   public static function isConfigEnabled(): bool {
      $configFile = dirname(__DIR__, 2) . '/dbx/cfg/config.php';
      if (is_file($configFile) && is_readable($configFile)) {
         $readConfig = static function(string $path): array {
            $config = array();
            include $path;
            return is_array($config) ? $config : array();
         };
         $fileConfig = $readConfig($configFile);
         if (array_key_exists('cache_content', $fileConfig)) {
            return (int)$fileConfig['cache_content'] === 1;
         }
      }
 
      $enabled = dbx()->get_config('dbx', 'cache_content');
      if ($enabled === 'undef' || $enabled === '' || $enabled === null) {
         return true;
      }
 
      return (int) $enabled === 1;
   }
 
   public static function setConfigEnabled(bool $enabled): bool {
      $config = dbx()->get_config('dbx');
      if (!is_array($config)) {
         $config = array();
      }
 
      $config['cache_content'] = $enabled ? 1 : 0;
      return (int) dbx()->set_config('dbx', $config) > 0;
   }
 
   public static function isEnabled(): bool {
      $method = strtoupper(trim((string)($_SERVER['REQUEST_METHOD'] ?? 'GET')));
      if ($method !== 'GET' && $method !== 'HEAD') {
         return false;
      }
 
      if ((int) dbx()->get_request_var('dbx_sync', 1, 'int') !== 1) {
         return false;
      }
 
      if ((int) dbx()->get_system_var('dbx_edit', 0, 'int') > 0) {
         return false;
      }
 
      if ((int) dbx()->get_system_var('dbx_ajax', 0, 'int')) {
         return false;
      }
 
      if ((int) dbx()->get_system_var('dbx_window', 0, 'int')) {
         return false;
      }
 
      return self::isConfigEnabled();
   }
 
   public static function isContentRoute(): bool {
      if (dbx()->get_system_var('dbx_modul') !== 'dbxContent') {
         return false;
      }
 
      $action = (string) dbx()->get_system_var('dbx_run1', '');
      return $action === 'show';
   }
 
   public static function isPermalinkPageRequest(): bool {
      if (!self::isEnabled()) {
         return false;
      }
 
      if ((int) dbx()->get_system_var('dbx_content_permalink_request', 0, 'int') !== 1) {
         return false;
      }
 
      return (int) dbx()->get_system_var('dbx_content_route_cid', 0, 'int') > 0;
   }
 
   public static function baseDir(): string {
      $dir = rtrim(dbx()->get_file_dir(), '/\\') . '/cache/';
      return dbx()->os_path($dir);
   }
 
   public static function menuVariantFlat(int $flat = 1): string {
      return 'flat-' . ((int) $flat === 0 ? 0 : 1);
   }
 
   public static function menuVariantLoad(int $deep = 9, string $mode = '', string $label = ''): string {
      $deep = max(1, (int) $deep);
      $mode = strtolower(trim($mode));
      if ($mode === '') {
         $mode = 'default';
      }
      $mode = self::safeToken($mode, 'default');
      $label = trim((string) $label);
      $labelKey = $label !== '' ? substr(sha1($label), 0, 8) : 'menu';
 
      return 'load-' . $deep . '-' . $mode . '-' . $labelKey;
   }
 
   public static function currentLng(): string {
      $lng = trim((string) dbx()->get_system_var('dbx_lng', 'de'));
      return $lng !== '' ? $lng : 'de';
   }
 
   public static function ensureDirs(): void {
      foreach (array('content', 'meta') as $sub) {
         $dir = self::baseDir() . $sub;
         if (!is_dir($dir)) {
            @mkdir($dir, 0755, true);
         }
      }
 
      self::purgeLegacyMenuCache();
      self::purgeLegacyPageCache();
   }

   private static function purgeLegacyPageCache(): void {
      foreach (array(
         self::baseDir() . 'meta/pages/*.json',
         self::baseDir() . 'meta/permalinks_*.json',
         self::baseDir() . 'meta/home_*.json',
      ) as $pattern) {
         foreach (glob($pattern) ?: array() as $file) {
            @unlink($file);
         }
      }
 
      $contentDir = self::baseDir() . 'content/';
      foreach (array_merge(glob($contentDir . '*.htm') ?: array(), glob($contentDir . '*.html') ?: array()) as $file) {
         if (preg_match('/^cid-\d+\.[a-z]{2,3}\.htm$/i', basename($file))) {
            continue;
         }
         @unlink($file);
      }
   }

   public static function purgeLegacyMenuCache(): int {
      $dir = self::baseDir() . 'menu/';
      if (!is_dir($dir)) {
         return 0;
      }
 
      $removed = 0;
      foreach (glob($dir . '*.html') ?: array() as $path) {
         if (@unlink($path)) {
            $removed++;
         }
      }
 
      return $removed;
   }
 
   public static function contentPath(int $cid, string $lng): string {
      $cid = (int) $cid;
      $lng = self::safeToken($lng, 'de');
      return self::baseDir() . 'content/cid-' . $cid . '.' . $lng . '.htm';
   }
 
   public static function permalinkContentPath(string $permalink, string $lng): string {
      $permalink = self::permalinkFileToken($permalink);
      $lng = self::safeToken($lng, 'de');
 
      return self::baseDir() . 'content/' . $permalink . '.' . $lng . '.htm';
   }
 
   public static function menuPath(int $root, string $lng, string $variant = 'flat-1'): string {
      $root = (int) $root;
      $lng = self::safeToken($lng, 'de');
      $variant = self::safeToken($variant, 'flat-1');
 
      return self::baseDir() . 'menu/' . $root . '_' . $lng . '_' . $variant . '.html';
   }
 
   public static function pageMetaPath(int $cid): string {
      return self::baseDir() . 'meta/pages/' . (int) $cid . '.json';
   }
 
   public static function readContent(int $cid, string $lng = ''): ?string {
      if (!self::isPermalinkPageRequest()) {
         return null;
      }
 
      if ($lng === '') {
         $lng = self::currentLng();
      }
 
      $path = self::contentPath($cid, $lng);
      if (!is_file($path) || !is_readable($path)) {
         return null;
      }
 
      $html = file_get_contents($path);
      if (!is_string($html)) {
         return null;
      }
 
      require_once __DIR__ . '/dbxContentRenderer.class.php';
      (new dbxContentRenderer())->applySeoMeta($cid);
      return $html;
   }
 
   public static function readPermalinkContent(string $permalink, string $lng = ''): ?string {
      // Ein separater Permalink-Cache existiert nicht mehr.
      return null;
   }
 
   public static function writeContent(int $cid, string $html, array $meta = array(), string $lng = ''): bool {
      if (!self::isPermalinkPageRequest()) {
         return false;
      }
 
      $cid = (int) $cid;
      if ($cid <= 0 || trim($html) === '') {
         return false;
      }
 
      if ($lng === '') {
         $lng = self::currentLng();
      }
 
      self::ensureDirs();
      $path = self::contentPath($cid, $lng);
      return (bool) @file_put_contents($path, $html, LOCK_EX);
   }
 
   public static function readMenu(int $root, string $variant = 'flat-1', string $lng = ''): ?string {
      return null;
   }
 
   public static function writeMenu(string $html, int $root, string $variant = 'flat-1', string $lng = ''): bool {
      return false;
   }
 
   public static function readPageMeta(int $cid): ?array {
      $meta = self::buildContentMeta($cid, self::currentLng());
      return count($meta) ? $meta : null;
   }
 
   private static function readPageMetaFile(int $cid): ?array {
      $path = self::pageMetaPath($cid);
      if (!is_file($path) || !is_readable($path)) {
         return null;
      }
 
      $json = file_get_contents($path);
      if (!is_string($json) || $json === '') {
         return null;
      }
 
      $data = json_decode($json, true);
      return is_array($data) ? $data : null;
   }
 
   public static function writePageMeta(int $cid, array $meta): bool {
      // Seiten-Metadaten werden live aus dbxContent gelesen und nicht gecacht.
      return true;
   }
 
   public static function invalidateContent(int $cid): void {
      $cid = (int) $cid;
      if ($cid <= 0) {
         return;
      }
 
      $permalinks = array();
      $meta = self::readPageMetaFile($cid);
      if (is_array($meta)) {
         $permalink = trim((string) ($meta['permalink'] ?? ''));
         $lng = trim((string) ($meta['lng'] ?? ''));
         if ($permalink !== '') {
            $permalinks[] = array('permalink' => $permalink, 'lng' => $lng);
         }
      }
 
      foreach (glob(self::baseDir() . 'meta/permalinks_*.json') ?: array() as $indexFile) {
         $json = file_get_contents($indexFile);
         if (!is_string($json) || $json === '') {
            continue;
         }
         $index = json_decode($json, true);
         if (!is_array($index)) {
            continue;
         }
         $lng = '';
         if (preg_match('/^permalinks_([a-z]{2,3})\.json$/i', basename($indexFile), $match)) {
            $lng = strtolower($match[1]);
         }
         foreach ($index as $permalink => $row) {
            if (is_array($row) && (int) ($row['cid'] ?? 0) === $cid) {
               $permalinks[] = array('permalink' => (string) $permalink, 'lng' => $lng);
            }
         }
      }
 
      $seen = array();
      foreach ($permalinks as $item) {
         $permalink = trim((string) ($item['permalink'] ?? ''));
         if ($permalink === '') {
            continue;
         }
         $lng = trim((string) ($item['lng'] ?? ''));
         $token = self::permalinkFileToken($permalink);
         $key = $token . '|' . $lng;
         if (isset($seen[$key])) {
            continue;
         }
         $seen[$key] = 1;
         $legacyToken = self::legacyPermalinkFileToken($permalink);
         $pattern = $lng !== ''
            ? self::baseDir() . 'content/' . $token . '.' . self::safeToken($lng, 'de') . '.htm'
            : self::baseDir() . 'content/' . $token . '.*.htm';
         foreach (glob($pattern) ?: array() as $file) {
            @unlink($file);
         }
         foreach (array(
            self::baseDir() . 'content/' . $legacyToken . '.*.htm',
            self::baseDir() . 'content/' . $legacyToken . '__*.html',
         ) as $legacyPattern) {
            foreach (glob($legacyPattern) ?: array() as $file) {
               @unlink($file);
            }
         }
      }
 
      foreach (glob(self::baseDir() . 'content/cid-' . $cid . '.*.htm') ?: array() as $file) {
         @unlink($file);
      }
      foreach (glob(self::baseDir() . 'content/' . $cid . '_*.html') ?: array() as $file) {
         @unlink($file);
      }
 
      @unlink(self::pageMetaPath($cid));
      if (class_exists(__NAMESPACE__ . '\\dbxContentSitemap')) {
         dbxContentSitemap::invalidate();
      }
   }
 
   public static function invalidateMenu(int $root): void {
      $root = (int) $root;
      $pattern = self::baseDir() . 'menu/' . $root . '_*.html';
      foreach (glob($pattern) ?: array() as $file) {
         @unlink($file);
      }
   }
 
   public static function invalidateAllMenus(): void {
      foreach (glob(self::baseDir() . 'menu/*.html') ?: array() as $file) {
         @unlink($file);
      }
      self::invalidateSitemap();
   }
 
   public static function invalidateSitemap(): void {
      if (class_exists(__NAMESPACE__ . '\\dbxContentSitemap')) {
         dbxContentSitemap::invalidate();
         return;
      }
 
      @unlink(self::baseDir() . 'meta/sitemap.xml');
   }
 
   public static function invalidateAll(): array {
      $stats = array(
         'content' => 0,
         'menu' => 0,
         'meta' => 0,
      );
 
      foreach (array('*.htm', '*.html') as $pattern) {
         foreach (glob(self::baseDir() . 'content/' . $pattern) ?: array() as $file) {
            if (@unlink($file)) {
               $stats['content']++;
            }
         }
      }
 
      foreach (glob(self::baseDir() . 'menu/*.html') ?: array() as $file) {
         if (@unlink($file)) {
            $stats['menu']++;
         }
      }
 
      foreach (glob(self::baseDir() . 'meta/pages/*.json') ?: array() as $file) {
         if (@unlink($file)) {
            $stats['meta']++;
         }
      }
 
      foreach (glob(self::baseDir() . 'meta/permalinks_*.json') ?: array() as $file) {
         if (@unlink($file)) {
            $stats['meta']++;
         }
      }
 
      foreach (glob(self::baseDir() . 'meta/home_*.json') ?: array() as $file) {
         if (@unlink($file)) {
            $stats['meta']++;
         }
      }
 
      return $stats;
   }
 
   public static function cacheStats(): array {
      self::ensureDirs();
      $content = array_values(array_filter(
         glob(self::baseDir() . 'content/cid-*.*.htm') ?: array(),
         static fn(string $path): bool => (bool) preg_match('/^cid-\d+\.[a-z]{2,3}\.htm$/i', basename($path))
      ));
      $sitemapPath = self::baseDir() . 'meta/sitemap.xml';
 
      return array(
         'content' => count($content),
         'menu' => 0,
         'meta' => 0,
         'permalinks' => 0,
         'home' => 0,
         'sitemap' => is_file($sitemapPath) ? 1 : 0,
         'base_dir' => self::baseDir(),
      );
   }
 
   public static function invalidateFolderTree($db, int $folderId): void {
      if (!is_object($db)) {
         return;
      }
 
      $folderId = (int) $folderId;
      self::invalidateMenu($folderId);
      self::invalidateMenu(0);
 
      $folderIds = self::collectFolderIds($db, $folderId);
      foreach ($folderIds as $id) {
         self::invalidateMenu((int) $id);
      }
 
      $pages = $db->select(dbxContentLng::ddContent(), 'folder IN (' . implode(',', array_map('intval', $folderIds)) . ')', 'id', 'id', 'ASC', '', 0, 0, 0);
      if (is_array($pages)) {
         foreach ($pages as $page) {
            self::invalidateContent((int) ($page['id'] ?? 0));
         }
      }
   }
 
   private static function collectFolderIds($db, int $folderId): array {
      $folderId = (int) $folderId;
      $ids = array($folderId);
      $queue = array($folderId);
 
      while (count($queue)) {
         $current = (int) array_shift($queue);
         $rows = $db->select(dbxContentLng::ddFolder(), 'parent_id = ' . $current, 'id', 'id', 'ASC', '', 0, 0, 0);
         if (!is_array($rows)) {
            continue;
         }
         foreach ($rows as $row) {
            $id = (int) ($row['id'] ?? 0);
            if ($id > 0 && !in_array($id, $ids, true)) {
               $ids[] = $id;
               $queue[] = $id;
            }
         }
      }
 
      return $ids;
   }
 
   private static function buildContentMeta(int $cid, string $lng = ''): array {
      $cid = (int) $cid;
      if ($cid <= 0) {
         return array();
      }
 
      $prevLng = null;
      if ($lng !== '') {
         $currentLng = (string) dbx()->get_system_var('dbx_lng', 'de');
         if ($lng !== $currentLng) {
            $prevLng = $currentLng;
            dbx()->set_system_var('dbx_lng', $lng);
         }
      }
 
      require_once __DIR__ . '/dbxContentRenderer.class.php';
      $db = dbx()->get_system_obj('dbxDB');
      if (!is_object($db)) {
         if ($prevLng !== null) {
            dbx()->set_system_var('dbx_lng', $prevLng);
         }
         return array();
      }
 
      $rec = $db->select1(dbxContentLng::ddContent(), $cid, 'permalink,activ,folder,title,seo_title,description,keywords,meta_robots,seo_image_id,update_date,lng_uid', 0);
      if (!is_array($rec)) {
         if ($prevLng !== null) {
            dbx()->set_system_var('dbx_lng', $prevLng);
         }
         return array();
      }
 
      $renderer = new dbxContentRenderer();
      $rights = $renderer->getPublicFolderRights((int)($rec['folder'] ?? 0));
      $meta = array(
         'cid' => $cid,
         'permalink' => (string)($rec['permalink'] ?? ''),
         'rights' => $rights,
         'activ' => (int)($rec['activ'] ?? 1),
         'seo' => dbxContentRenderer::seoMetaFromRecord($rec),
      );
      if ($prevLng !== null) {
         dbx()->set_system_var('dbx_lng', $prevLng);
      }
      return $meta;
   }
 
   private static function safeToken(string $value, string $fallback): string {
      $value = strtolower(trim($value));
      if ($value === '' || !preg_match('/^[a-z0-9_-]+$/', $value)) {
         return $fallback;
      }
      return $value;
   }
 
   private static function permalinkFileToken(string $permalink): string {
      $permalink = strtolower(trim(str_replace('\\', '/', $permalink), '/'));
      if ($permalink === '') {
         return 'home';
      }
 
      $token = preg_replace('/[^a-z0-9_-]+/i', '-', $permalink);
      $token = trim((string) $token, '-_');
      if ($token === '') {
         $token = 'page';
      }
 
      if (strlen($token) > 160) {
         $token = substr($token, 0, 160);
      }
 
      return strtolower($token);
   }
 
   private static function legacyPermalinkFileToken(string $permalink): string {
      $permalink = strtolower(trim(str_replace('\\', '/', $permalink), '/'));
      if ($permalink === '') {
         return 'home';
      }
 
      $token = preg_replace('/[^a-z0-9_-]+/i', '-', $permalink);
      $token = trim((string) $token, '-_');
      if ($token === '') {
         $token = 'page';
      }
 
      $hash = substr(sha1($permalink), 0, 8);
      if (strlen($token) > 80) {
         $token = substr($token, 0, 80);
      }
 
      return strtolower($token . '-' . $hash);
   }
}