Jak działa Template Externalizer?

Sposób działania wtyczki Template Externalizer jest bardzo prosty: umożliwia ona eksport szablonów oraz innych danych przechowywanych w bazie do tymczasowych płków w wybranym katalogu. Dzięki temu można użyć swojego ulubionego edytora do ich modyfikacji (poprzez FTP), a pliki będą automatycznie synchronizowane z danymi w bazie.

Możliwości Template Externalizer

Wtyczka umożliwia eksport następujących elementów:

• szablony stron
• szablony wtyczek
• arkusze CSS
• globalne bliki HTML
• niektóre systemowe strony (szablon „przerwa techniczna”, metadata, standardowy szablon stron)

Konfiguracja wtyczki

Plugin posiada bardzo proste możliwości konfiguracji. Po jego instalacji w menu „Wygląd” pojawia się niewielka możliwość ustawień:

• włączenie i wyłączenie funkcjonalności
• katalog, w którym przechowywane są pliki tymczasowe (musi posiadać prawa do zapisu)
• czas działania wtyczki

Dzięki ostatniemu parametrowi możemy ustawić niejako czas trwania sesji działania wtyczki. Gdy minie, pliki tymczasowe zostaną automatycznie usunięte. Oczywiście możemy w każdej chwili sprawdzić ile czasu pozostało do zakończenia oraz go zresetować.

Możliwe problemy przy konfiguracji katalogu roboczego

Template Externalizer w wersji 2.0.6 posiada pewną niemiłą przypadłość. W przypadku pomyłki w nazwie katalogu, w którym będą przechowywane wyeksportowane pliki, CMS Made Simple przestanie działać. Zarówno strona jak i panel administracyjny będą niedostępne z powodu błędu. Wystarczy wtedy zalogować się do bazy danych i w tabeli cms_siteprefs zmodyfikować zmienną TemplateExternalizer_mapi_pref_cache_path. Określa ona wspomniany katalog.

W momencie pisania artykułu CMS Made Simple był dostępny w wersji 1.10 i i takiej dotyczą niniejsze informacje. Oczywiście problem występuje we wcześniejszych, oraz może się pojawić w późniejszych edycjach.

Na czym polega problem?

Na wirtualnych serwerach Home.pl, ale taka sytuacja może mieć miejsce na innych, dostęp do katalogu tmp jest ograniczony. Z założenia ma on służyć do zapisu różnych danych tymczasowych, takich jak np. sesje. Ze względów bezpieczeństwa jest on niedostępny z zewnątrz.

Cały problem polega na tym, że od wersji 1.8 CMS Made Simple generuje arkusze CSS do statycznych plików i umieszcza je w katalogu /tmp/cache. O ile potrafi je w tym przypadku bez problemu zapisać, to już przy dostępie z zewnątrz po HTTP otrzymujemy wspomniany wcześniej błąd 403 Forbidden, czyli brak dostępu.

Rozwiązanie problemu nr 1 – inny sposób generowania CSS

Pierwszym i najszybszym sposobem na niedogodność, jest zmiana sposobu generowania plików CSS, a konkretnie do powrócenia do starej możliwości stosowanej w CMS Made Simple. Wystarczy więc zamienić w szablonie wywołanie {cms_stylesheet} na {stylesheet}.

Możemy to zrobić w panelu administracyjnym, wchodząc w menu w Wygląd -> Szablony i wybrać odpowiedni/e szablon/y.

W ten sposób zamiast dołączenia CSS z katalogu /tmp/cache w postaci

<link rel="stylesheet" type="text/css" href="http://www.moja-strona.pl/cache/stylesheet_50_132723884.css" media="all">

w wygenerowanym pliku HTML otrzymamy:

<link rel="stylesheet" type="text/css" media="all" href="http://www.fmoja-strona.pl/stylesheet.php?cssid=50&mediatype=all" />

Rozwiązanie problemu nr 2 – zmiana w konfiguracji

I tu pojawia się drobny problem. Pierwszym krokiem w zmianie jest oczywiście sprawdzenie zawartości pliku config.php. Tu niestety możemy się rozczarować – nie ma w nim odpowiedniej opcji, umożliwiającej szybką zmianę. Jedyną związaną z tym katalogiem zmienną jest ustawienie

$config['previews_path'] = '/tmp/cache';

Założenie katalogu /cache i nadanie mu praw do zapisu, a następnie zmiana powyższej zmiennej nie spowoduje poprawnego dostępu do plików CSS. Jest to bowiem związane z tym, że wykorzystywana w wielu miejscach CMSa ścieżka jest zapisana w pliku fileloc.php oraz niestety „na twardo” w innych.

UWAGA: wszelkie opisane poniżej zmiany ingerują bezpośrednio w kod CMS Made Simple. W takim wypadku tracimy możliwość oficjalnego supprotu oraz utrudniamy sobie aktualizacje. Musimy pamiętać, że po jej wykonaniu będziemy musieli ponownie wprowadzić nasze poprawki.

W linii nr 3 w pliku fileloc.php  znajduje się następująca definicja:

define("TMP_CACHE_LOCATION", dirname(__FILE__) . DIRECTORY_SEPARATOR . 'tmp' . DIRECTORY_SEPARATOR . 'cache');

Wystarczy więc wpisać tu swoją własną ścieżkę, czyli w naszym przypadku /cache:

define("TMP_CACHE_LOCATION", dirname(__FILE__) . DIRECTORY_SEPARATOR . 'cache');

Po tej zmianie pliki CSS będą zapisywane w nowej lokacji, jednak niestety CMS będzie ich nadal szukał w poprzedniej. Cóż, jest to ewidentny błąd programistów, którzy „na twardo: wpisali ścieżkę, zamiast skorzystać z odpowiedniej zmiennej konfiguracyjnej. Musimy więc zająć się plikiem /plugins/function.cms_stylesheet.php i odnaleźć odpowiedniwpis (linie 117 i 121 lub w ich pobliżu). Najlepiej w nich po prostu podać swoje ścieżki do katalogu, w którym zapisywane są obecnie pliki CSS. Poniższe linie:

$stylesheet .= '<link rel="stylesheet" type="text/css" href="' . $root_url . '/tmp/cache/' . $filename . '"/>' . "\n";

$stylesheet .= '<link rel="stylesheet" type="text/css" href="' . $root_url . '/tmp/cache/' . $filename.'" media="' . $media_type.'"/>'."\n";

należy więc zamienić na

$stylesheet .= '<link rel="stylesheet" type="text/css" href="' . $root_url . $config['previews_path'] . '/' . $filename.'" media="' . $media_type . '"/>' . "\n";

$stylesheet .= '<link rel="stylesheet" type="text/css" href="' . $root_url . $config['previews_path'] . '/' . $filename . '"/>' . "\n";

W ten sposób problem z dostępem do CSS zostanie rozwiązany i arkusze stylów będą mogły być wczytane przez naszą stronę.

Problem z pluginami, np. Captcha 0.4.5

Część dodatków pisanych do CMS Made Simple przez zewnętrznych programistów zawiera podobny do opisanego powyżej błąd. Niestety, ale ścieżki dostępu do katalogów cache zostały w nich zapisane „na twardo”, a nie z wykorzystaniem zmiennej konfiguracyjnej. Musimy być zatem czujni i gdy występuje problem z dostępem do tworzonych plików, przeglądać ich kod.

Przykładowo występuje on we wtyczce Captcha (w momencie pisania artykułu w wersji 0.4.5), z której korzysta między innymi doskonałe rozszerzenie Form Builider. Zapisuje ona wygenerowane do przepisania przez użytkownika obrazki w katalogu /tmp/cache, jednak na stronie nie jest możliwe ich poprawne wyświetlenie.

Rozwiązanie jest proste, czyli poprawienie odpowiedniej linijki w pliku wtyczki modules/Captcha/lib/classes/class.captchalib.php w liniach 81 oraz 82 (lub pobliskich). W następującym kodzie:

$this->setImagePath(cms_join_path($this->cmsconfig['root_path'],'tmp','cache'));
$this->setImageUrl($this->cmsconfig['root_url'] . '/tmp/cache');

musimy podać swój katalog, czyli /cache:

$this->setImagePath(cms_join_path($this->cmsconfig['root_path'],'cache'));
$this->setImageUrl($this->cmsconfig['root_url'] . '/cache');

Podstawowe mankamenty CMS Made Simple związane z SEO to brak możliwości samodzielnego definiowania dla poszczególnych stron znaczników TITLE i META DESCRIPTION, oraz KEYWORDS (ten ostatni jest z oczywistych względów najmniej ważny). Dodatkowym problemem jest to, że podstrony z aktualnościami, galerią, terminarzem itp. mają ten sam TITLE i opis.

Zaletą przedstawionego w dalszej części artykułu rozwiązania jest to, że nie dokonujemy żadnych zmian w kodzie samego CMSa. Wszelkie modyfikacje zostaną wprowadzone w szablonach oraz konfiguracji. Gdy nasza strona korzysta z więcej niż jednego szablonu, opisane zmiany musimy wykonać w każdym z nich.

W przypadku, gdy nasza witryna posiada treść umieszczoną tylko na stronach (bez aktualności, galerii i innych modułów) wystarczą nam trzy niewielkie modyfikacje:

1. Na początku szablonu naszej strony umieszczamy kod (po {process_pagedata} jeśli występuje):

{capture}{content block="META Title" oneline="true" assign="meta_title"}
{/capture}
{capture}{content block="META Description" oneline="true" 
assign="meta_description"}{/capture}
{capture}{content block="META Keywords" oneline="true" 
assign="meta_keywords"}{/capture}

Dzięki niemu w edycji strony pojawią się dodatkowe pola do uzupełnienia, umożliwiające wprowadzenie treści do znacznika TITLE, META DESCRIPTION oraz META KEYWORDS.

2. Poniższy kod umieszczamy w sekcji HEAD szablonu strony, lub gdy korzystamy ze znacznika {meta}, w odpowiednich opcjach konfiguracyjnych (Administracja serwisu -> Ustawienia globalne, pole „Globalne Metadane”)

<meta name="description" content="{$meta_description}" />
<meta name="keywords" content="{$meta_keywords}" />

Dzięki temu w kodzie HTML naszej strony pojawią się dane, wpisane w zdefiniowane wcześniej pola.

3. W szablonie podmieniamy kod w miejscu wyświetlania znacznika TITLE

<title>{if isset($meta_title) && !empty($meta_title)}{sitename} - {$meta_title}
{else}{sitename} - {title}{/if}</title>

Spowoduje to, że na stronie pojawi się tytuł wpisany w nowym polu zdefiniowanym w punkcie 1.

Zasada działania powyższych modyfikacji będzie następująca: jeśli podczas tworzenia lub edycji strony uzupełnimy nowe pola, ich zawartość pojawi się na naszej witrynie. Jeśli pole “META Title” pozostawimy puste, automatycznie wstawiona zostanie wartość z pola “Tytuł”.

Gdy na naszej stronie korzystamy z aktualności, galerii, terminarza lub innych modułów, trzeba dokonać kilku dodatkowych modyfikacji. Dzięki nim w odpowiednie pola zostaną wstawione automatycznie właściwe dane. Przykładowo, w przypadku aktualności, w znacznik TITLE trafi tytuł newsa, a w META DESCRIPTION automatycznie umieszczony zostanie wstęp. Aby to osiągnąć, musimy dokonać kolejnych zmian:

4. Należy upewnić się, że w pliku config.php CMS Made Simple została wyłączona odpowiednia zmienna (jest to domyślne ustawienie):

$config['process_whole_template'] = false;

5. W szablonie strony po {process_pagedata} wstawić:

{content assign="capturedcontent"}

Spowoduje to, że treść naszej strony zostanie wcześniej wygenerowana i przypisana do zmiennej. Dzięki temu możliwe będzie późniejsze przekazywanie zmiennych z modułu aktualności, galerii itd.

6. W szablonie głównym, w miejsce {content} wstawić:

{$capturedcontent}

Spowoduje to wyświetlenie wygenerowanej treści, którą w poprzednim punkcie przypisaliśmy do zmiennej.

7. W szablonie szczegółów aktualności, galerii itd. wstawić:

{assign var="pagetitle" value=$entry->title|escape}

Dzięki temu pod zmienną “pagetitle” wstawiony zostanie tytuł aktualności lub zdjęcia. Podobny zabieg możemy zastosować dla innych modułów, zmieniając w razie potrzeby źródło danych ($entry->title).

Dodatkowo w przypadku aktualności należy wstawić w ich szablonie szczegółów następujący kod (dokładne umiejscowienie nie jest ważne, może być na początku lub na końcu):

{if $entry->summary}
{assign var="meta_description_auto" value=$entry->summary|truncate:150:""}
{else}
{assign var="meta_description_auto" value=$entry->content|truncate:150:""}
{/if}

Dzięki temu w pole description będzie wstawiany wstęp newsa, lub w przypadku jego braku początek treści. Obie wartości zostały przycięte do maksymalnie 150 znaków.

Natomiast w szablonie szczegółów galerii (wtyczka Gallery) należy wstawić:

{assign var="meta_description_auto" value=$gallerycomment|truncate:150:""}

W ten sposób w tag meta description zostanie wstawiony opis galerii (maksymalnie 150 znaków).

W innym modułach postępujemy analogicznie, wstawiając w meta_description_auto odpowiednią zmienną, która zostanie użyta później automatycznie w tagu META DESCRIPTION.

8. W szablonie  głównym strony zmieniamy kod w miejscu wyświetlania znacznika TITLE na troszkę bardziej skomplikowany:

<title>{if isset($pagetitle) && !empty($pagetitle)}{sitename} - {$pagetitle}
{elseif isset($meta_title) && !empty($meta_title)}{sitename} - {$meta_title}
{else}{sitename} - {title}{/if}</title>

Przy takiej definicji w znacznik TITLE zostanie wstawiony jeśli istnieje kolejno: tytuł aktualności/galerii/itp., tytuł zdefiniowany przez nas w nowym polu META TITLE lub w przypadku ich braku po prostu wartość z pola “Tytuł” strony.

9. W szablonie głównym lub w ustawieniach {meta} modyfikujemy definicję tagu META DESCRIPTION, dodając nowe zmienne (szczegóły – patrz punkt 2).

<meta name="description" content="{if $meta_description_auto}
{$meta_description_auto}{else}{$meta_description}{/if}" />

Oznacza to, że wstawiona ma być zmienna $meta_description_auto (wstęp aktualności, opis galerii, itp.), lub jeśli nie istnieje, wartość z pola “META description” strony.

10. W szablonie strony zmieniamy sposób wyświetlania nagłówka naszej strony (może być umieszczony w innym znaczniku niż h1)

<h1>{if isset($pagetitle)}{$pagetitle}{else}{title}{/if}</h1>

Dzięki temu wstawiony zostanie tytuł aktualności, galerii, itp. lub po porostu “Tytuł” strony.

I to juz koniec wymaganych modyfikacji CMS Made Simple. Dokonując tych zmian, możliwa będzie odpowiednia optymalizacja naszej strony pod kątem wyszukiwarek internetowych. Tytuły, opisy oraz słowa kluczowe będą się właściwie pojawiały, dzięki czemu nasze działania SEO będą mogły przynieść oczekiwane rezultaty.