Xamma Basic je původní větev mého PHP frameworku Xamma. Jeho vývoj začal v roce 2018 a postupně na něm vznikaly weby pro články, podcasty, galerie a další vlastní aplikace. Balík zachovává původní architekturu Xammy založenou na Carrierech, modelech, pohledech a konfiguraci v souborech INI.

Co je Xamma Basic

Xamma Basic je kompaktní PHP framework a současně hotový základ publikačního systému. Není postaven na klasických Presenterech ani na moderním routovacím souboru s jednotlivými objekty tras. Požadavek prochází přes společný vstupní soubor v adresáři www, systém načte konfiguraci a podle adresy vybere odpovídající Carrier.

Framework je rozdělen především na MainModule a MediaModule. MainModule zajišťuje běžný obsah webu, uživatele a administraci. MediaModule se stará o podcasty, epizody, přehrávání médií a galerie.

Jiná filozofie routování přes carrier.ini

Nejvýraznějším rysem Xamma Basic je routování definované v souboru config/carrier.ini. Každá sekce představuje jednu hlavní část webu. Konfigurace určuje segment adresy, povolené akce a PHP třídu Carrieru, která požadavek zpracuje.

[article]
url=article
actions=process,list,edit,show,create,rss
carrier=App\MainModule\Carriers\ArticleCarrier

První část adresy vybere sekci. Další část adresy představuje akci. Router nejprve ověří, zda je akce uvedena v seznamu actions, a potom předá řízení příslušnému Carrieru. Povolené adresy tak lze přečíst na jednom místě bez procházení všech PHP tříd.

Tato filozofie je odlišná od balíku Xamma Derived. Xamma Basic zachovává původní INI routování a původní způsob organizace projektu, zatímco Derived představuje nověji odvozenou a více přepracovanou architekturu.

Carriery, modely a pohledy

Carrier odpovídá přibližně kontroleru. Přijme požadavek, zkontroluje oprávnění, načte potřebná data a vybere pohled. Databázová práce je oddělena do modelových a logických tříd. Výstup se vytváří pomocí Latte šablon.

Rozdělení umožňuje přidat novou část webu vytvořením Carrieru, modelu a šablony a následným zaregistrováním nové sekce v carrier.ini.

Funkce frameworku

• Články: vytváření, úpravy, koncepty, kategorie, komentáře, obsahové bloky a RSS.
• Podcasty: podcastové kanály, jednotlivé epizody, popisy, obrázky, audio soubory, přehrávání a RSS kanály.
• Galerie: obrazové galerie, náhledy a režim prezentace.
• Studio: přihlášení uživatelů, profily, správa obsahu a administrátorské funkce.
• Newsletter: přihlášení a odhlášení odběratelů, seznam adres a odesílání zpráv.
• Vyhledávání: hledání v článcích a dalším publikovaném obsahu.
• Blog, kontakt a podpora: jednoduché doplňkové části veřejného webu.
• Download: samostatná sekce pro zveřejnění souborů ke stažení.
• API přihlášení: přihlášení do Studia prostřednictvím dlouhého klíče v adrese.

Balík používá PHP 8.2 nebo novější, PDO, Latte, Nette Forms a Nette Mail. Obsahuje také pomocné třídy pro práci s obrázky, soubory, daty, stránkováním, textem a českou diakritikou.

Zabezpečení

Veřejným kořenem webu je pouze adresář www. Konfigurace databáze, zdrojové soubory, logy a dočasná data zůstávají mimo veřejný prostor.

Framework nastavuje bezpečnostní HTTP hlavičky, používá ochranu formulářů proti CSRF, bezpečné cookies, omezení opakovaných neúspěšných přihlášení a zákaz spouštění PHP souborů v adresářích určených pro uploady.

API credential je uložen zašifrovaně v config/apikey.ini. Šifrování využívá nasazovací klíč security.applicationKey ze souboru config/settings.ini. Po změně applicationKey je nutné vytvořit nový API credential.

Nasazení krok za krokem

1. Rozbalte balík do samostatného adresáře projektu.
2. V Apache nebo Nginxu nastavte document root na absolutní cestu k adresáři PROJECT_ROOT/www. Kořen celého projektu nesmí být veřejný.
3. Zajistěte PHP 8.2 nebo novější a rozšíření PDO, DOM, Fileinfo, GD a Mbstring. V Apache zapněte přepisování adres pomocí mod_rewrite.
4. Zkopírujte vzorovou konfiguraci databáze do config/database.ini a doplňte hostitele, port, databázového uživatele, heslo a název databáze.
5. Vytvořte prázdnou databázi s kódováním UTF-8 a spusťte soubor database/schema.sql.
6. V souboru config/settings.ini nastavte doménu, název webu, popis, jazyk, kontaktní e-mail a případné důvěryhodné proxy servery.
7. Vygenerujte nový šedesátičtyřznakový applicationKey, například příkazem openssl rand -hex 32. Vývojový nebo ukázkový klíč nepoužívejte v produkci.
8. Adresáře temp, temp/sessions, log, emails, files a www/user musí být zapisovatelné uživatelem webového serveru.
9. Prvního uživatele vytvořte v kořeni projektu příkazem php bin/create-user.php uzivatelske-jmeno email. Skript si bezpečně vyžádá heslo, které musí mít alespoň dvanáct znaků.
10. Volitelné API přihlášení vytvořte příkazem php bin/create-api-key.php dlouhy-nahodny-klic uzivatelske-jmeno. Výstup uložte do sekce credentials v souboru config/apikey.ini.
11. Instalaci ověřte příkazem php bin/validate.php.
12. Potom otevřete adresu admin/signin a přihlaste se do Studia.

API přihlášení

Vedle běžného přihlášení jménem a heslem lze použít adresu ve tvaru admin/signin/API-KLIC. API klíč je nutné chránit stejně jako heslo, protože může zůstat v historii prohlížeče nebo v přístupových protokolech serveru.

Původní větev projektu Xamma

Xamma Basic není nově vytvořená ukázková aplikace. Jde o upravenou a vyčištěnou distribuci původního systému, na kterém pracuji od roku 2018. Zachovává jeho charakteristické INI routování, Carriery, vlastní databázovou vrstvu a modulární uspořádání.

Balík může sloužit jako základ vlastního publikačního nebo podcastového webu a také jako ukázka jiné cesty k organizaci PHP aplikace, než jakou používají běžné současné frameworky.

Poznámka: Balík Xamma Basic je ke stažení v sekci Download.