From f8be9435506dd9535fe82059efd52994125e12cb Mon Sep 17 00:00:00 2001 From: Edwin Noorlander Date: Tue, 28 Jul 2026 13:59:32 +0200 Subject: [PATCH] ContentAPI voor PHP content bestanden + handleiding in admin - Nieuwe ContentAPI class beschikbaar als $api in PHP content bestanden met methodes: getAllPages, getPage, getMenu, getConfig, buildUrl, etc. - Admin handleiding pagina op /admin/guide met taalwisselaar - Zijbalk link naar handleiding in admin menu - Dubbele alert in config pagina verwijderd - Handleidingen (nl/en) uitgebreid met Content API referentie --- admin/templates/layout.php | 8 ++ admin/templates/pages/config.php | 7 -- admin/templates/pages/guide.php | 24 +++++ cms/core/class/CodePressCMS.php | 16 +++- cms/core/class/ContentAPI.php | 154 +++++++++++++++++++++++++++++++ cms/core/index.php | 3 + guide/en.codepress.md | 100 +++++++++++++++++++- guide/nl.codepress.md | 100 +++++++++++++++++++- public/admin.php | 65 ++++++++++--- 9 files changed, 452 insertions(+), 25 deletions(-) create mode 100644 admin/templates/pages/guide.php create mode 100644 cms/core/class/ContentAPI.php diff --git a/admin/templates/layout.php b/admin/templates/layout.php index b5bf098..1b52bfb 100644 --- a/admin/templates/layout.php +++ b/admin/templates/layout.php @@ -76,6 +76,11 @@ $layoutSidebarColor = $layoutThemeConfig['header_color'] ?? '#0a369d'; Gebruikers +
  • + + Handleiding + +
  • Website bekijken @@ -152,6 +157,9 @@ $layoutSidebarColor = $layoutThemeConfig['header_color'] ?? '#0a369d'; case 'users': require __DIR__ . '/pages/users.php'; break; + case 'guide': + require __DIR__ . '/pages/guide.php'; + break; } ?> diff --git a/admin/templates/pages/config.php b/admin/templates/pages/config.php index 7947b74..f16c2e9 100644 --- a/admin/templates/pages/config.php +++ b/admin/templates/pages/config.php @@ -1,12 +1,5 @@

    Configuratie

    - -
    - - -
    - -
    diff --git a/admin/templates/pages/guide.php b/admin/templates/pages/guide.php new file mode 100644 index 0000000..ce4192b --- /dev/null +++ b/admin/templates/pages/guide.php @@ -0,0 +1,24 @@ +

    Handleiding

    + +
    +
    + Nederlands + English +
    +
    + +
    +
    + +
    +
    + + \ No newline at end of file diff --git a/cms/core/class/CodePressCMS.php b/cms/core/class/CodePressCMS.php index de1eaaf..1b59429 100644 --- a/cms/core/class/CodePressCMS.php +++ b/cms/core/class/CodePressCMS.php @@ -783,7 +783,8 @@ class CodePressCMS { $title = $metadata['title'] ?? ''; ob_start(); - // Make metadata available to the included file + // Make API and metadata available to the included file + $api = new ContentAPI($this); $pageMetadata = $metadata; include $filePath; $content = ob_get_clean(); @@ -1011,7 +1012,6 @@ class CodePressCMS { $this->pluginManager->doAction('onBeforeRender'); $menu = $this->getMenu(); - $breadcrumb = $this->generateBreadcrumb(); // Get homepage title $homepageTitle = $this->getHomepageTitle(); @@ -1026,6 +1026,10 @@ class CodePressCMS { // Get layout from page metadata $layout = $page['layout'] ?? 'sidebar-content'; + // Determine if sidebar toggle should be shown + $hasSidebar = $layout !== 'content' && !empty(trim($sidebarContent)); + $breadcrumb = $this->generateBreadcrumb($hasSidebar); + // Prepare template data $templateData = [ 'site_title' => $this->config['site_title'], @@ -1154,11 +1158,15 @@ class CodePressCMS { /** * Generate breadcrumb navigation HTML * + * @param bool $hasSidebar Whether sidebar content exists and should show toggle * @return string Breadcrumb HTML */ - public function generateBreadcrumb() { + public function generateBreadcrumb($hasSidebar = true) { // Sidebar toggle button (shown before home icon in breadcrumb) - $sidebarToggle = '
    • '; + $sidebarToggle = ''; + if ($hasSidebar) { + $sidebarToggle = '
    • '; + } if (isset($_GET['search'])) { return ''; diff --git a/cms/core/class/ContentAPI.php b/cms/core/class/ContentAPI.php new file mode 100644 index 0000000..0064e8b --- /dev/null +++ b/cms/core/class/ContentAPI.php @@ -0,0 +1,154 @@ +cms = $cms; + } + + public function getAllPages(): array + { + return $this->cms->getAllPageTitles(); + } + + public function getPage(string $path): ?array + { + $contentDir = $this->cms->config['content_dir']; + $path = preg_replace('/\.(md|php|html)$/', '', $path); + $filePath = $contentDir . '/' . $path; + + $extensions = ['md', 'php', 'html']; + $actualPath = null; + foreach ($extensions as $ext) { + if (file_exists($filePath . '.' . $ext)) { + $actualPath = $filePath . '.' . $ext; + break; + } + } + + if (!$actualPath || !file_exists($actualPath)) { + return null; + } + + $content = file_get_contents($actualPath); + $extension = pathinfo($actualPath, PATHINFO_EXTENSION); + + switch ($extension) { + case 'md': + $result = $this->cms->parseMarkdown($content, $actualPath); + break; + case 'php': + $result = $this->cms->parsePHP($actualPath); + $result['content'] = $this->cms->processContent($result['content']); + break; + case 'html': + $result = $this->cms->parseHTML($content, $actualPath); + break; + default: + return null; + } + + return [ + 'title' => $result['title'] ?? '', + 'content' => $result['content'] ?? '', + 'path' => $path, + 'layout' => $result['layout'] ?? 'sidebar-content', + 'metadata' => $result['metadata'] ?? [], + ]; + } + + public function getMenu(): array + { + return $this->cms->getMenu(); + } + + public function getConfig(string $key, $default = null) + { + $keys = explode('.', $key); + $value = $this->cms->config; + + foreach ($keys as $k) { + if (!isset($value[$k])) { + return $default; + } + $value = $value[$k]; + } + + return $value; + } + + public function getCurrentLanguage(): string + { + return $this->cms->currentLanguage; + } + + public function buildUrl(string $page = 'index', ?string $lang = null, array $params = []): string + { + $lang = $lang ?? $this->getCurrentLanguage(); + $query = 'page=' . urlencode($page) . '&lang=' . urlencode($lang); + if (!empty($params)) { + $query .= '&' . http_build_query($params); + } + return '?' . $query; + } + + public function pageExists(string $path): bool + { + $contentDir = $this->cms->config['content_dir']; + $path = preg_replace('/\.(md|php|html)$/', '', $path); + $basePath = $contentDir . '/' . $path; + + return file_exists($basePath . '.md') + || file_exists($basePath . '.php') + || file_exists($basePath . '.html'); + } + + public function getCurrentPageTitle(): string + { + $page = $this->cms->getPage(); + return $page['title'] ?? ''; + } + + public function getCurrentPagePath(): string + { + return $_GET['page'] ?? $this->cms->config['default_page']; + } + + public function isHomepage(): bool + { + $defaultPage = $this->cms->config['default_page'] ?? 'index'; + $currentPage = $_GET['page'] ?? $defaultPage; + return $currentPage === $defaultPage; + } + + public function t(string $key): string + { + return $this->cms->t($key); + } + + public function getSiteTitle(): string + { + return $this->cms->config['site_title'] ?? 'CodePress'; + } + + public function getAvailableLanguages(): array + { + return $this->cms->getAvailableLanguages(); + } + + public function getSearchResults(): array + { + if (isset($_GET['search'])) { + return $this->cms->searchResults; + } + return []; + } + + public function isSearching(): bool + { + return isset($_GET['search']); + } +} diff --git a/cms/core/index.php b/cms/core/index.php index 5f4b6e0..a7a8926 100644 --- a/cms/core/index.php +++ b/cms/core/index.php @@ -42,6 +42,9 @@ require_once 'class/Logger.php'; require_once 'plugin/CMSAPI.php'; require_once 'plugin/PluginManager.php'; +// Load ContentAPI class - provides CMS data access for PHP content files +require_once 'class/ContentAPI.php'; + // Load main CMS class - handles content parsing, navigation, search, and page rendering require_once 'class/CodePressCMS.php'; diff --git a/guide/en.codepress.md b/guide/en.codepress.md index 4fab02c..b9a7468 100644 --- a/guide/en.codepress.md +++ b/guide/en.codepress.md @@ -18,7 +18,7 @@ CodePress CMS is a lightweight, file-based content management system built with ### Content Types - **Markdown (.md)** - CommonMark support via `league/commonmark` -- **PHP (.php)** - Dynamic content +- **PHP (.php)** - Dynamic content with **Content API** (`$api` variable) - **HTML (.html)** - Static HTML pages - **Directory listings** - Automatic directory overviews - **Language-specific content** - `en.` and `nl.` prefixes @@ -63,6 +63,7 @@ CodePress CMS is a lightweight, file-based content management system built with - **Plugin management** - Overview, create, edit, configure, enable/disable and delete - **Media management** - Upload and delete media files in `content/-assets/` - **User management** - Add, remove users, change passwords +- **Guide** - Built-in documentation with API reference - Session-based authentication with bcrypt hashing - CSRF protection, brute-force lockout (5 attempts, 15 min) - Default login: `admin` / `admin` (change immediately after installation) @@ -286,6 +287,7 @@ Media files (images, PDFs, video, audio) can be placed in any `content/` subdire | `media` | Media management (upload, delete) | | `media-list` | JSON list of all media (for editor modal) | | `users` | User management | +| `guide` | Guide / documentation | ### Editor Features @@ -491,6 +493,102 @@ class MyPlugin The MQTTTracker plugin stores `broker_host`, `broker_port`, `client_id`, `username` and `password` in plain text in `plugins/MQTTTracker/config.json`. This is a known open security issue - in a production environment it is recommended to externalize these credentials to environment variables or a separate credential manager. +## Content API (for PHP content files) + +PHP content files (`.php` in the `content/` directory) have access to an `$api` variable with the following methods: + +### Getting pages + +```php +// Get all pages with titles +$pages = $api->getAllPages(); +// Result: ['index' => 'Home', 'about' => 'About Us', ...] + +// Get a specific page's content +$page = $api->getPage('about'); +// $page['title'], $page['content'], $page['path'], $page['layout'], $page['metadata'] + +// Check if a page exists +if ($api->pageExists('contact')) { + // ... +} +``` + +### Navigation + +```php +// Get menu structure +$menu = $api->getMenu(); +// Nested array with 'title', 'path', 'url', 'children' +``` + +### Configuration + +```php +// Get config value (dot notation) +$title = $api->getConfig('site_title'); +$lang = $api->getConfig('language.default'); +$seoDesc = $api->getConfig('seo.description', 'Default description'); +``` + +### Current page + +```php +// Current page title +$pageTitle = $api->getCurrentPageTitle(); + +// Current page path +$pagePath = $api->getCurrentPagePath(); + +// Check if this is the homepage +if ($api->isHomepage()) { + echo 'Welcome!'; +} +``` + +### URLs and language + +```php +// Build URL for a page +$url = $api->buildUrl('about', 'en'); + +// Current language +$lang = $api->getCurrentLanguage(); + +// Available languages +$languages = $api->getAvailableLanguages(); + +// Site title +$title = $api->getSiteTitle(); +``` + +### Translations and search + +```php +// Get translation +$label = $api->t('home'); + +// Search results (if searching) +if ($api->isSearching()) { + $results = $api->getSearchResults(); +} +``` + +### Example PHP content file + +```php +--- +title: Page Overview +layout: content +--- +

    All Pages

    +
      +getAllPages() as $path => $title): ?> +
      • + +
    +``` + ## Analytics & Tracking ### MQTT Tracker diff --git a/guide/nl.codepress.md b/guide/nl.codepress.md index 199fb55..fed154f 100644 --- a/guide/nl.codepress.md +++ b/guide/nl.codepress.md @@ -18,7 +18,7 @@ CodePress CMS is een lichtgewicht, file-based content management systeem gebouwd ### Content Types - **Markdown (.md)** - CommonMark ondersteuning via `league/commonmark` -- **PHP (.php)** - Dynamische content +- **PHP (.php)** - Dynamische content met **Content API** (`$api` variabele) - **HTML (.html)** - Statische HTML pagina's - **Directory listings** - Automatische directory overzichten - **Language-specific content** - `nl.` en `en.` prefix @@ -63,6 +63,7 @@ CodePress CMS is een lichtgewicht, file-based content management systeem gebouwd - **Plugin beheer** - Overzicht, aanmaken, bewerken, configureren, in-/uitschakelen en verwijderen - **Media beheer** - Uploaden en verwijderen van mediabestanden in `content/-assets/` - **Gebruikersbeheer** - Gebruikers toevoegen, verwijderen, wachtwoorden wijzigen +- **Handleiding** - Ingebouwde documentatie met API referentie - Session-based authenticatie met bcrypt hashing - CSRF-bescherming, brute-force lockout (5 pogingen, 15 min) - Standaard login: `admin` / `admin` (wijzig direct na installatie) @@ -287,6 +288,7 @@ Media bestanden (afbeeldingen, PDFs, video, audio) kunnen in elke `content/` sub | `media` | Media beheer (uploaden, verwijderen) | | `media-list` | JSON lijst van alle media (voor editor modal) | | `users` | Gebruikersbeheer | +| `guide` | Handleiding (deze documentatie) | ### Editor Functionaliteit @@ -492,6 +494,102 @@ class MijnPlugin De MQTTTracker plugin slaat `broker_host`, `broker_port`, `client_id`, `username` en `password` op in plain text in `plugins/MQTTTracker/config.json`. Dit is een bekend openstaand security punt - bij een productieomgeving wordt aangeraden deze gegevens te externaliseren naar omgevingsvariabelen of een aparte credentials manager. +## Content API (voor PHP content bestanden) + +PHP content bestanden (`.php` in de `content/` map) hebben toegang tot een `$api` variabele met de volgende methodes: + +### Pagina's opvragen + +```php +// Alle pagina's met titels ophalen +$pages = $api->getAllPages(); +// Resultaat: ['index' => 'Home', 'over-ons' => 'Over ons', ...] + +// specifieke pagina inhoud ophalen +$page = $api->getPage('over-ons'); +// $page['title'], $page['content'], $page['path'], $page['layout'], $page['metadata'] + +// Controleren of een pagina bestaat +if ($api->pageExists('contact')) { + // ... +} +``` + +### Navigatie + +```php +// Menu structuur ophalen +$menu = $api->getMenu(); +// Bevat geneste array met 'title', 'path', 'url', 'children' +``` + +### Configuratie + +```php +// Configuratie waarde opvragen (punt-notatie) +$title = $api->getConfig('site_title'); +$lang = $api->getConfig('language.default'); +$seoDesc = $api->getConfig('seo.description', 'Standaard beschrijving'); +``` + +### Huidige pagina + +```php +// Huidige pagina titel +$pageTitle = $api->getCurrentPageTitle(); + +// Huidige pagina pad +$pagePath = $api->getCurrentPagePath(); + +// Check of dit de homepage is +if ($api->isHomepage()) { + echo 'Welkom!'; +} +``` + +### URLs en taal + +```php +// URL bouwen voor een pagina +$url = $api->buildUrl('over-ons', 'nl'); + +// Huidige taal +$lang = $api->getCurrentLanguage(); + +// Beschikbare talen +$languages = $api->getAvailableLanguages(); + +// Site titel +$title = $api->getSiteTitle(); +``` + +### Vertalingen en zoeken + +```php +// Vertaling ophalen +$label = $api->t('home'); + +// Zoekresultaten (als er gezocht wordt) +if ($api->isSearching()) { + $results = $api->getSearchResults(); +} +``` + +### Voorbeeld PHP content bestand + +```php +--- +title: Pagina Overzicht +layout: content +--- +

    Alle Pagina's

    +
      +getAllPages() as $path => $title): ?> +
      • + +
    +``` + ## Analytics & Tracking ### MQTT Tracker diff --git a/public/admin.php b/public/admin.php index e3883ec..4435b18 100644 --- a/public/admin.php +++ b/public/admin.php @@ -121,6 +121,10 @@ switch ($route) { handleMediaList($auth, $appConfig); break; + case 'guide': + handleGuide($auth, $appConfig); + break; + case 'users': handleUsers($auth, $appConfig); break; @@ -662,24 +666,28 @@ function handleConfig(AdminAuth $auth, array $config): void $configData = file_exists($configJson) ? json_decode(file_get_contents($configJson), true) : []; if (!is_array($configData)) $configData = []; - // Get available root-level pages + // Get available pages (including subdirectories) $contentDir = $config['content_dir']; $availablePages = []; $availableLangs = $configData['language']['available'] ?? ['nl', 'en']; if (is_dir($contentDir)) { $pageMap = []; - foreach (scandir($contentDir) as $file) { - if ($file[0] === '.') continue; - $filePath = $contentDir . '/' . $file; - if (is_file($filePath) && preg_match('/\.(md|php|html)$/', $file)) { - $base = $file; - $langPattern = '/^(' . implode('|', $availableLangs) . ')\.(.+)$/'; - if (preg_match($langPattern, $base, $m)) { - $base = $m[2]; - } - $pageKey = preg_replace('/\.(md|php|html)$/', '', $base); - $pageMap[$pageKey] = true; + $realContentDir = realpath($contentDir); + $iterator = new RecursiveIteratorIterator( + new RecursiveDirectoryIterator($contentDir, RecursiveDirectoryIterator::SKIP_DOTS) + ); + foreach ($iterator as $fileInfo) { + if (!$fileInfo->isFile()) continue; + $ext = $fileInfo->getExtension(); + if (!in_array($ext, ['md', 'php', 'html'])) continue; + $relative = substr($fileInfo->getRealPath(), strlen($realContentDir) + 1); + $base = $relative; + $langPattern = '/^(' . implode('|', $availableLangs) . ')\.(.+)$/'; + if (preg_match($langPattern, $base, $m)) { + $base = $m[2]; } + $pageKey = preg_replace('/\.(md|php|html)$/', '', $base); + $pageMap[$pageKey] = true; } $availablePages = array_keys($pageMap); sort($availablePages); @@ -1360,6 +1368,39 @@ function handleUsers(AdminAuth $auth, array $config): void require __DIR__ . '/../admin/templates/layout.php'; } +function handleGuide(AdminAuth $auth, array $config): void +{ + $user = $auth->getCurrentUser(); + $csrf = $auth->getCsrfToken(); + + // Determine language for guide + $lang = $_GET['lang'] ?? 'nl'; + if (!in_array($lang, ['nl', 'en'])) $lang = 'nl'; + + $guideFile = __DIR__ . '/../guide/' . $lang . '.codepress.md'; + if (!file_exists($guideFile)) { + $guideFile = __DIR__ . '/../guide/en.codepress.md'; + $lang = 'en'; + } + + $rawContent = file_get_contents($guideFile); + + // Parse markdown using CommonMark if available + $content = ''; + if (class_exists('League\CommonMark\CommonMarkConverter')) { + $converter = new League\CommonMark\CommonMarkConverter([ + 'html_input' => 'allow', + 'allow_unsafe_links' => false, + ]); + $content = $converter->convert($rawContent)->getContent(); + } else { + $content = '
    ' . htmlspecialchars($rawContent) . '
    '; + } + + $route = 'guide'; + require __DIR__ . '/../admin/templates/layout.php'; +} + // --- Frontmatter helpers --- function parseFrontmatterField(string $content, string $key, string $default = ''): string