WebToDate/Registrace a personalizace/Reference
Administrační rozhraní
Nabídka modulu
Nabídka modulu vypadá následovně:
Nástroje
- Registrační formulář
- Potvrzení – stránky
- Potvrzení – e-mail
- Přihlašovací formulář
- Zapomenuté heslo
Nastavení
- Globální
- Stránky
- E-maily
- Zapomenuté heslo
Administrace
- Předvolby
- Údaje
- Skupiny
Data
- Uživatelé
- Export
- Statistika
K administrační části modulu mají přístup pouze administrátoři WebToDate.
Administrace
Předvolby
Ve formuláři Předvolby se nastavuje základní chování modulu.
Nastavují se následující předvolby:
- Přihlašovací režim – explicitní přihlášení / automatické rozpoznávání. Tato volba ovlivňuje v tomto modulu pouze funkci Změna registrace – jestliže je modul v režimu automatického rozpoznávání a uživatel vyvolá Změnu registrace, zobrazí se vyplněný registrační formulář bez nutnosti přihlášení (pokud je jednoznačně identifikován pomocí cookies). V opačném případě je nejprve vyžadováno přihlášení přes přihlašovací formulář, přihlášení je platné po dobu platnosti session.
- Unikátní identifikátor – uživatelské jméno / e-mail. Tato volba říká, zda se do přihlašovací stránky zadává kromě hesla (to vždy) uživatelské jméno nebo e-mail. Při zápisu registrace se musí ověřit jednoznačnost zvoleného pole, nastavení ovlivňuje i vygenerování přihlašovacího formuláře.
- Registrační kód – volí se možnost Unikátní / Libovolný – pokud bude v registračním formuláři používáno pole pro registrační kód (např. předplatitelské číslo či jiné kódy distribuované uživatelům) a každý uživatel musí mít unikátní kód, volí se Unikátní, v opačném případě se ponechává volba Libovolný.
- Potvrzovací stránka ano/ne – vyznačí se, zda se po odeslání registračního formuláře a před jeho zapsáním do databáze má ještě zobrazit stránka s vloženými údaji, které se mají potvrdit (v režimu pouze pro čtení).
- Výchozí stav registrace – Pokud je zvolena možnost neaktivní, musí registrovaný uživatel čekat na aktivaci administrátorem modulu nebo je aktivace prováděna uživatelem prostřednictvím e-mailu (viz dále). Volba aktivní naopak znamená, že registrovaný uživatel je aktivován okamžitě ve chvíli zápisu nové registrace.
- Výchozí skupina – po registraci uživatele z veřejně přístupného registračního uživatele je uživatel zařazen do této zvolené skupiny.
- Při změně registrace – podobný význam jako Výchozí stav registrace, volba ale určuje chování po změně registrace.
- Zasílat administrátorovi – tato volba určuje, které informace o registračním procesu mají být administrátorovi zasílány. K dispozici jsou tyto volby: nové registrace / i změněné registrace / nezasílat.
- E-mail administrátora – na tuto adresu se zasílají e-maily z předchozího bodu
- Zasílat potvrzení – určuje, zda má být uživatel o úspěšné registraci (či její změně) informován e-mailem. K dispozici jsou možnosti: pouze nové registrace / i změněné registrace / nezasílat.
- Aktivace z e-mailu – zapnutí možnosti, aby uživatel aktivoval svou registraci kliknutím na určité URL v e-mailu (předpokládá Výchozí stav registrace neaktivní).
- Datum expirace automaticky – volba definuje možnost automatického vyplňování data vypršení registračního záznamu.
Možné volby pro vkládání data expirace jsou:
- Nevkládat – datum expirace se automaticky nikdy nedoplňuje
- Vložit x dnů po registraci – ve chvíli zápisu záznamu (ať už se jedná o zápis z veřejné části či z administrační části) se datum doplní jako aktuální datum + x dní zde nastavených
- Vložit x dnů po aktivaci – pokud je aktivace provedena jakýmkoliv způsobem (z veřejné části přímo registračním formulářem, z e-mailu nebo z administračního rozhraní) a datum expirace není vyplněno, doplní se podle této volby. Pokud se záznam aktivuje a datum expirace je vyplněno, již se nemění.
- Povolit vkládání avatarů – vyznačuje, zda je povoleno vkládání avatarů uživateli, v případě povolení mohou anonymní uživatelé uploadovat do souborového systému serveru obrázky
- Cesta k adresáři s avatary – udává cestu k adresáři, kam se avatary ukládají. Výchozí volba je /images/avatars/, modul pak zakládá pod zvoleným adresářem ještě adresář temp, do kterého ukládá dočasné soubory.
- Maximální rozměry avatarů – při ukládání avatarů se kontroluje šířka a výška obrázků, maximální hodnoty v obrazových bodech se zadávají zde.
- Povolené koncovky souborů – v tomto poli se uvádí seznam koncovek souborů, které je možno uploadovat jako avatar (jpg, gif apod.), koncovky se oddělují středníkem
- Maximální velikost souborů – zadává se maximální velikost souboru, který lze uploadovat jako avatar, údaj je v bytech.
Údaje
Ve formuláři Údaje se definuje, která pole se v registračních záznamech využívají.
V tabulce jsou údaje organizovány do 4 sloupců:
- Název pole (nelze změnit) – označuje interní název příslušného pole (název pak odpovídá klíčovému slovu, které lze použít v šabloně).
- Popis (předvyplněný) – obsahuje popisek pole.
- Zaškrtávací okénko Použít definuje, zda bude příslušné pole zobrazeno v registračním formuláři.
- Zaškrtávací okénko Vyžadovat určuje, zda bude vyplnění pole pro uživatele povinné.
Unikátní identifikátor je vždy zvolen a označen jako povinný.
Na základě tohoto nastavení se generuje registrační formulář (pomocí funkce Nástroje – Registrační formulář) a případně potvrzovací formulář (Nástroje – Potvrzení - stránka) a ověřuje se zadávání polí před zápisem registrace. Chování této funkce je následující:
- Popisky polí se přebírají ve chvíli generování formuláře. Následná změna popisku ve formuláři Údaje se na webové prezentaci nijak neprojeví.
- Pokud se přidá dodatečně další pole do struktury ve sloupci Použít, pole se do registračního formuláře automaticky nepřidá. Pokud se toto pole ve sloupci Použít dodatečně vypne, změna se v registračním formuláři rovněž neprojeví a obsah pole lze i nadále přes tento formulář vložit.
- Pokud změníte některou položku ve sloupci Vyžadovat, změna se ihned aplikuje. Pokud např. některé pole bylo ve formuláři, nebylo vyžadováno jeho vyplnění a v nastavení Údaje toto změníte, vyplnění pole začne být ihned ve formuláři vyžadováno.
Skupiny
Funkce Skupiny definuje seznam skupin registrovaných uživatelů.
Skupiny se přidávají a odebírají způsobem obvyklým ve WebToDate. Novou skupinu lze přidat a přejmenovat vždy, odebrat jen v případě, že v dané skupině neexistuje žádný uživatel. Počet uživatelů ve skupině se vypisuje v seznamu skupin v pravém sloupci v seznamu skupin.
Nastavení
Stránky
Ve formuláři Stránky se nastavují předlohy pro různé typy stránek používané modulem.
Jedná se o následující typy stránek:
- Předloha pro registrační stránku – šablona, která určuje vzhled stránky, ve které se zobrazuje registrační formulář pro nové registrace.
- Předloha pro potvrzovací stránku – šablona, která určuje vzhled stránky s potvrzovacím formulářem (kontrola zadaných údajů v režimu pouze pro čtení) pro nové registrace.
- Předloha pro přihlašovací stránku – ovlivňuje vzhled stránky, na které se uživatel přihlašuje.
- Předloha pro automatickou aktivaci registraci – určuje vzhled stránky, která je zobrazena v případě aktivování registrace odkazem z e-mailu.
- Předloha pro změnu registrace – šablona, která určuje vzhled stránky, ve které se zobrazuje registrační formulář pro změny v registraci.
- Předloha pro potvrzení změny registrace – šablona, která určuje vzhled stránky s potvrzovacím formulářem (kontrola zadaných údajů v režimu pouze pro čtení) pro změny v registraci.
Všechny výše zmíněné stránky je nutné zobrazovat přes odpovídající veřejně přístupný skript (např. /scripts/modules/registration/registration.php apod.). Není vhodné např. umístit registrační formulář na nějakou staticky generovanou stránku zobrazovanou přímo. Důvodem je to, aby mohl být uživatel případně vrácen do stejné stránky a zobrazeno příslušné chybové hlášení, např. v případě, že není vyplněno některé povinné pole apod.
E-maily
Ve formuláři E-maily se nastavuje chování funkcí zasílajících e-maily s potvrzením registrace.
První pole E-mail od je globální a určuje, z které adresy se budou všechny e-maily odesílat.
Další tři pole se týkají odesílání potvrzovacích e-mailů uživatelům, kteří se registrují:
- Předloha pro e-maily uživatelům – šablona pro e-maily odesílané jako potvrzení uživatelům
- Formát e-mailu uživatelům – formát těchto e-mailů (text nebo HTML)
- Předmět e-mailu uživatelům – předmět (subject těchto e-mailů)
E-maily se odesílají volitelně ve chvíli, kdy je použit registrační skript /scripts/modules/registration/registration.php. V předvolbách (volba Zasílat potvrzení) se specifikuje, zda vůbec tyto e-maily odesílat a pokud ano, zda pouze pro nové registrace nebo i pro úpravy v existujících registracích. E-maily se neodesílají, pokud je registrační záznam přidáván nebo upravován přes administrační rozhraní modulu.
Další tři pole popisují stejnou funkčnost jako v předchozím případě, ale platí pro zasílání e-mailů upozorňujících na změny v registrační databázi administrátorovi. V předvolbách modulu se specifikuje e-mail tohoto administrátora (E-mail administrátora) a stejné volby pro zasílání jako v předchozím případě (Zasílat administrátorovi).
Formulář Zapomenuté heslo definuje veškerou funkčnost týkající se možného zasílání zapomenutých hesel e-mailem, neboli fungování stránky /scripts/modules/registration/lostpassw.php.
Ve formuláři se nastavují následující volby:
- Předloha žádosti o zaslání hesla – šablona stránky, která se zobrazuje na výše uvedené adrese, obsahuje formulář se žádostí o zaslání hesla e-mailem. Ve formuláři se zadává unikátní identifikátor, tedy buď uživatelské jméno nebo e-mail.
- Předloha potvrzovací stránky – šablona stránky, která se zobrazí po odeslání žádosti o zaslání hesla. Obsahuje buď potvrzení odeslání nebo chybové hlášení (uživatel nenalezen apod.)
- Předloha e-mailu – šablona pro e-mail se zapomenutým heslem
- Formát e-mailu - formát těchto e-mailů (text nebo HTML)
- Předmět e-mailu - předmět (subject těchto e-mailů)
Nástroje
Podskupina Nástroje obsahuje funkce, které umožňují snadnou přípravu některých prvků a formulářů modulu. Jednotlivé funkce vesměs generují fragmenty WebToDate, v jejichž těle jsou funkční kódy jednotlivých formulářů a obdobných prvků používaných modulem. Funkce se využívají dle následujícího postupu:
- Nejprve se provedou potřebná nastavení. Např. pro vygenerování registračního formuláře se nejprve ve formuláři Údaje nastaví, co má být obsahem formuláře.
- Pak se použije daný nástroj, vznikne jeden WebToDate fragment.
- Tělo fragmentu se upraví dle potřeb daného designu webové prezentace. Je třeba zachovat všechny názvy polí a klíčová slova modulu do fragmentu vygenerovaná, jinak je možné měnit fragment dle potřeb.
- Fragment se vloží na stránku, která je předlohou pro danou funkci (např. pro stránku s registračním formulářem) a stránka se vygeneruje.
K dispozici jsou následující nástroje:
- Registrační formulář – generuje HTML kód registračního formuláře dle nastavení ve formuláři Údaje.
- Potvrzení – stránka – generuje HTML kód potvrzující stránky registračního formuláře dle nastavení ve formuláři Údaje.
- Potvrzení – e-mail – generuje kód pro e-mail potvrzující registraci. Opět používá nastavení v Údaje (tj. do e-mailu vloží pouze hodnoty polí zde nastavené), navíc je v těle e-mailu konstrukce pro možnou aktivaci registrace z e-mailu.
- Přihlašovací formulář – generuje HTML kód pro přihlašovací formulář. Zohledňuje nastavení unikátního identifikátoru ve formuláři Předvolby, tj. vždy vygeneruje pole pro zadání hesla a dle předvoleb pole pro uživatelské jméno nebo e-mail.
- Zapomenuté heslo – generuje formulář pro zadání unikátního identifikátoru pro funkci zasílání zapomenutých hesel, opět zohledňuje nastavení unikátního identifikátoru ve formuláři Předvolby.
Všechny nástroje mají stejný interface. Pro fragment zvolte vhodný Nadpis a zařazení a tlačítkem Přidat HTML fragment vytvořte požadovaný fragment.
Data
V sekci Data nabídky lze provádět změny v databázi registrovaných uživatelů, exportovat tuto databázi nebo její část a procházet statistiky přihlášení registrovaných uživatelů.
Uživatelé
Pomocí funkce Uživatelé se pracuje s databází registračních záznamů. V horní části se zobrazí seznam uživatelů, klepnutím na jméno uživatele se přechází ve spodní části okna do formuláře pro úpravy záznamu.
Sloupce seznamu uživatelů se zobrazují v závislosti na nastavení modulu, např. dle nastavení unikátního identifikátoru se zobrazuje buď sloupec s uživatelským jménem, nebo s e-mailem. V seznamu vpravo nahoře je odkaz Vyhledat, který zobrazuje formulář pro vyhledávání:
Všechny zadané podmínky ve vyhledávacím formuláři se spojují logickou spojkou "a zároveň".
Ve spodním formuláři lze měnit údaje uživatele.
Formulář vyžaduje povinné vyplnění polí stejně jako registrační formulář vystavený na veřejně přístupné části prezentace, jedná se tedy o nastavení ve formuláři Údaje. Jinak lze měnit a přidávat uživatele bez omezení.
Vedle pole Přezdívka je ikona, která mění stav podle toho, zda uživatel má nebo nemá přiřazen soubor s avatarem. Klepnutí na ikonu otevírá dialog pro změny avatarů.
Pokud uživatel nemá avatar, dialog se zobrazí v podobě dle následujícího otisku obrazovky. Je zde možné pouze vybrat lokální soubor a uložit jej jako avatar. Obrázek se ukládá do adresáře specifikovaného v předvolbách modulu, dochází k automatickému přejmenování souboru na unikátní název.
Pokud uživatel má avatar, dialog se zobrazí v podobě dle následujícího otisku obrazovky. Je uveden název souboru a jeho rozměry. Zároveň je aktivní tlačítko pro odstranění avataru. Pomocí výběru lokálního souboru a jeho uploadu na server lze avatar uživatele vyměnit za jiný.
Export
Pomocí funkce Export lze exportovat vybrané údaje z registrační databáze. Formulář je rozdělen na dvě záložky. První záložka exportního formuláře se nazývá Tabulka. Lze v ní specifikovat:
- Které sloupce vybrané SQL tabulky se exportují
- Které záznamy tabulky se exportují
- V jakém pořadí se exportují
V prvé řadě se ve sloupci Vybrat pomocí zaškrtávacích políček vyznačí sloupce, které se mají exportovat.
Dále lze specifikovat kritéria pro export, v podstatě vyhledávací podmínku, která vybere určitou množinu záznamů tabulky. V příslušném řádku formuláře se ve sloupci Splňující podmínku vybere operátor (tj. např. =, >, < apod.) a ve stejném řádku ve sloupci Vzhledem k se zadá příslušná hodnota. Těchto omezujících podmínek lze zadat několik, ve spodní části formuláře je radiopřepínač specifikující, zda se více zadaných podmínek spojuje logickou spojkou "a zároveň" nebo logickou spojkou "nebo". Operátor LIKE znamená, že zadaný řetězec se vyskytuje kdekoliv v textu. Pokud není zadaná žádná omezující podmínka, exportují se všechny záznamy.
Další možností je specifikovat řazení záznamů do exportovaného souboru. Lze vybrat dva sloupečky, podle kterých se řadí (ve formuláři sloupce Primárně a Sekundárně), v posledním sloupci formuláře lze pak specifikovat, zda se jedná o vzestupné nebo sestupné řazení. Není-li žádné řazení vybráno, záznamy se exportují v pořadí, v jakém se nacházejí v SQL tabulce.
Ve druhé záložce Soubor se specifikuje formát exportovaného souboru, jeho název a volba, zda soubor v případě jeho existence kompletně přepsat nebo připojit data na konec souboru.
Název výstupního souboru zadávejte včetně přípony, vytváří se soubor podle přesně zadaného jména. Pomocí tlačítka Test lze ověřit, zda soubor se zadaným jménem již existuje a export se jej pokusí přepsat nebo takový soubor neexistuje a bude se zakládat nový.
Exportovaný soubor je exportní funkcí uložen do adresáře pro export (wwwroot/data/katalogy/export/).
Zvolit lze jeden z podporovaných formátů exportovaného souboru, poznámky k jednotlivým formátům jsou v následující tabulce.
| DBF | Maximální délka názvu sloupce je 10 znaků. Pokud má v SQL databázi daný sloupec název s větší délkou, je název pole v exportovaném souboru oříznut na 10 znaků. |
| Texty jsou v exportovaném DBF souboru v takovém kódování, v jakém jsou uloženy v SQL databázi. | |
| XML | Konvence ohledně pojmenování XML elementů v exportovaném souboru je následující:
|
| Výstupní kódování je vždy utf-8. | |
| CSV
|
Lze zvolit jako oddělovač polí čárku nebo středník, záznamy jsou vždy odděleny znakem pro konec řádky. |
| Do exportovaného CSV souboru se ve výchozím nastavení negenerují názvy sloupců, ale pouze vlastní data. V exportním formuláři je ale k dispozici volba umožňující zahrnout názvy sloupců do exportovaného souboru. | |
| Texty jsou v CSV souboru v takovém kódování, v jakém jsou uloženy v SQL databázi. | |
| Data se exportují ve formátu 2005-05-04 11:41:00 (stejně jako v XML formátu). |
Statistika
Pomocí funkce Statistika lze zobrazovat údaje o přihlašování registrovaných uživatelů.
Možné volby jsou:
- Nejaktivnější uživatelé – zobrazuje seznam uživatelů, kteří mají za nastavené období největší počet přihlášení
- Sumární statistika – zobrazí přehled celkového počtu přihlášení po jednotlivých dnech
- Seznam záznamů – zobrazí výpis položek ze statistiky, tj. jméno uživatele, datum přihlášení a IP adresu, ze které se uživatel přihlásil
Veřejné skripty
Prezentační skripty
V adresáři /scripts/modules/registration/ se nacházejí veřejně přístupné prezentační skripty modulu. Jedná se o následující skripty:
| Skript | Funkce |
| registration.php | Skript zobrazující registrační formuláře (registrační formulář a potvrzovací stránku) |
| login.php | Skript zobrazující formulář pro přihlášení |
| logout.php | Skript pro odhlášení |
| lostpassw.php | Skript pro funkci zaslání zapomenutého hesla |
| activation.php | Skript pro aktivaci registrace z e-mailu |
| aremove.php | Používá se pro smazání avataru uživatelem |
Logiku fungování registračního skriptu registration.php popisuje následující diagram.
Skript nejprve použije předlohu pro registrační stránku. Pokud nejsou všechny údaje validní (nejsou vyplněny povinné údaje, unikátní identifikátor je již použit apod.), je uživatel vrácen zpět na tento formulář. V opačném případě je buď proveden zápis do registrační databáze, nebo je mezi tyto dva úkony ještě vložena stránka pro potvrzení registrace – jedná se opět v podstatě o formulář, kde jsou všechny zadané údaje v hidden polích formuláře a navíc zobrazeny ve stránce jako texty. Na závěr se zobrazí buď první stránka s formulářem (a aktivuje se událost <!--WTD_IF(REGISTERED,"…")-->) nebo je uživatel přesměrován na finální potvrzovací stránku – tato stránka musí být zadaná v hidden parametru url přímo v kódu formuláře.
Přihlašovací skript login.php se typicky nevolá přímo, tj. není třeba na něj v rámci designu vkládat do stránek odkazy. Všechny stránky, které pracují s údaji vyžadující přihlášeného registrovaného uživatele na tento skript přesměrují v případě, že je zjištěno, že uživatel není přihlášen. Skript zobrazuje přihlašovací formulář tak dlouho, dokud se uživatel úspěšně nepřihlásí. Jakmile se uživatel úspěšně přihlásí, je přesměrován zpět na volající stránku nebo na úvodní stránku v případě, že volající stránku nebylo možné identifikovat.
Podobné chování má i odhlašovací skript logout.php. Jeho vyvolání odhlašuje uživatele (tj. ruší přihlašovací údaje v session) a přesměrovává na jinou stránku – buď na volající stránku, nebo na úvodní stránku, pokud nebylo možné volající stránku identifikovat.
Skript pro zasílání zapomenutého hesla lostpassw.php nejprve zobrazí předlohu žádosti o zaslání hesla. Po odeslání formuláře v této stránce zobrazí předlohu pro potvrzovací stránku této funkce, přitom aktivuje jednu z událostí zmíněných níže, např. <!--WTD_IF(USERFOUND,"…")-->. Pokud je uživatel úspěšně nalezen a e-mail s heslem lze odeslat, odesílá okamžitě tento e-mail.
Skript pro aktivaci registrace z e-mailu activation.php nejprve vyhodnocuje údaje z URL – ID uživatele a zakryptovaný kód sloužící k další identifikaci uživatele. Pokud je registrační údaj na základě těchto parametrů nalezen a nic nebrání tomu, aby byla provedena aktivace, je účet aktivován, je zobrazena předloha (automatická aktivace) a aktivuje se v ní jedna z možných událostí, např. <!--WTD_IF(ACTIVATED,"…")-->.
Klíčová slova modulu
Následující klíčová slova reprezentují jednotlivé položky registračních záznamů.
| Klíčová slova použitelná v předlohách (registrační formulář, potvrzení zadaných údajů, potvrzující e-mail, e-mail pro zaslání ztraceného hesla) | ||
| Klíčové slovo | Význam | Poznámka |
| <!--WTD_REGISTR(USERNAME)--> | Uživatelské jméno | |
| <!--WTD_REGISTR(PASSWORD)--> | Heslo | |
| <!--WTD_REGISTR(EMAIL)--> | ||
| <!--WTD_REGISTR(MAILFORMAT)--> | Název formátu e-mailu | Za klíčové slovo se doplňuje název formátu jako řetězec (tj. "HTML" apod.) |
| <!--WTD_REGISTR(MAILFORMATVALUE)--> | Hodnota formátu e-mailu | Interně se možné formáty označují písmeny ("H"=HTML, "T"=text), toto klíčové slovo vkládá toto písmeno |
| <!--WTD_REGISTR(MAILFORMATTEXT)--> | Volba formátu text | Vkládá řetězec checked="checked" v případě, že je zvolen formát text |
| <!--WTD_REGISTR(MAILFORMATHTML)--> | Volba formátu HTML | Vkládá řetězec checked="checked" v případě, že je zvolen formát HTML |
| <!--WTD_REGISTR(FIRSTNAME)--> | Křestní jméno | |
| <!--WTD_REGISTR(LASTNAME)--> | Příjmení | |
| <!--WTD_REGISTR(NICKNAME)--> | Přezdívka | |
| <!--WTD_REGISTR(COMPANYNAME)--> | Název firmy | |
| <!--WTD_REGISTR(JOBTITLE)--> | Pracovní pozice | |
| <!--WTD_REGISTR(GSM_PREFIX)--> | GSM předvolba | |
| <!--WTD_REGISTR(GSM)--> | GSM číslo | |
| <!--WTD_REGISTR(PHONENUMBER)--> | Telefonní číslo | |
| <!--WTD_REGISTR(ADDRESS)--> | Adresa | |
| <!--WTD_REGISTR(CITY)--> | Město | |
| <!--WTD_REGISTR(COUNTRY)--> | Země | |
| <!--WTD_REGISTR(ZIP)--> | PSČ | |
| <!--WTD_REGISTR(SEX)--> | Pohlaví - označení | Vkládá interní označení pohlaví ("M" - muž, "F" - žena) |
| <!--WTD_REGISTR(SEXVALUE)--> | Pohlaví - název | Vkládá název označení pohlaví jako text |
| <!--WTD_REGISTR(SEXMALE)--> | Volba pohlaví muž | Vkládá řetězec checked="checked" v případě, že je zvoleno pohlaví muž |
| <!--WTD_REGISTR(SEXFEMALE)--> | Volba pohlaví žena | Vkládá řetězec checked="checked" v případě, že je zvoleno pohlaví žena |
| <!--WTD_REGISTR(AGE)--> | Věk | |
| <!--WTD_REGISTR(REGCODE)--> | Registrační kód | |
| <!--WTD_REGISTR(AVATARFILE)--> | Cesta k obrázku s avatarem | |
| <!--WTD_REGISTR(AVATARWIDTH)--> | Šířka obrázku s avatarem | |
| <!--WTD_REGISTR(AVATARHEIGHT)--> | Výška obrázku s avatarem | |
| <!--WTD_REGISTR(REMOVEAVATARURL)--> | URL pro odstranění avataru | Má smysl jen v předloze pro změnu registrace |
Klíčová slova uvedená v následující tabulce lze používat v předloze přihlašovací stránky (login.php).
| Klíčová slova použitelná v předloze pro přihlašovací stránku | ||
| Klíčové slovo | Význam | Poznámka |
| <!--WTD_REGISTR(USERNAME)--> | Uživatelské jméno | |
| <!--WTD_REGISTR(PASSWORD)--> | Heslo | |
| <!--WTD_REGISTR(EMAIL)--> | ||
V přihlašovací stránce se používá buď uživatelské jméno nebo e-mail (podle toho, co je označeno jako unikátní identifikátor), nikoliv oboje zároveň.
Klíčová slova uvedená v následující tabulce lze používat v předloze stránky pro zaslání zapomenutého hesla (lostpassw.php).
| Klíčová slova použitelná v předloze pro stránku zasílající zapomenuté heslo | ||
| Klíčové slovo | Význam | Poznámka |
| <!--WTD_REGISTR(USERNAME)--> | Uživatelské jméno | |
| <!--WTD_REGISTR(EMAIL)--> | ||
Ve stránce se používá buď uživatelské jméno nebo e-mail (podle toho, co je označeno jako unikátní identifikátor), nikoliv oboje zároveň.
Kromě výše uvedených klíčových slov je možné v předlohách používat konstrukce typu WTD_IF, které vkládají nějaké texty podmíněně podle toho, zda dané událost nastala. Pokud např. ve stránce pro zapomenutá hesla chceme zobrazit, že uživatel zadaný ve formuláři nebyl nalezen, použijeme kód
<!--WTD_IF(USERNOTFOUND,"Podle zadaného údaje nebyl žádný uživatel nalezen.")-->
Tyto konstrukce mají vždy tvar
<!--WTD_IF(PODMINKA,"… text ….")-->
Následující tabulka shrnuje možné podmínky a to, kde je lze použít.
| Podmínka | Možné použití | Možné hlášení (zobrazovaný text) |
| REGISTERED | Registrační formulář a potvrzovací stránka | Registrace proběhla úspěšně. |
| REQUIRED | Registrační formulář a potvrzovací stránka | Vyplňte prosím všechny povinné údaje. |
| DUPUSERNAME | Registrační formulář a potvrzovací stránka | Toto uživatelské jméno je již registrováno. Zadejte prosím jiné. |
| DUPNICKNAME | Registrační formulář a potvrzovací stránka | Tato přezdívka je již registrována. Zadejte prosím jinou. |
| DUPEMAIL | Registrační formulář a potvrzovací stránka | Tento e-mail je již registrován. Zadejte prosím jiný. |
| DUPREGCODE | Registrační formulář a potvrzovací stránka | Tento registrační kód je již použit jiným uživatelem. |
| NOAVATAR | Změna registrace, potvrzovací stránka | Uživatel nemá avatar. |
| HASAVATAR | Změna registrace, potvrzovací stránka | Uživatel má avatar. |
| BADUSERNAME | Přihlašovací formulář | Špatné přihlašovací jméno nebo heslo. Toto slovo je pouze pro použití v přihlašovacím formuláři. |
| BADEMAIL | Přihlašovací formulář | Špatný přihlašovací e-mail nebo heslo. Toto slovo je pouze pro použití v přihlašovacím formuláři. |
| ACTEMAIL | Potvrzení registrace e-mailem (předloha pro e-mail) | Vaši registraci lze aktivovat pomocí této stránky: <!--WTD_REGISTR(ACTURL)--> |
| BADCODE | Stránka pro aktivaci registrace z e-mailu | Chybné ID nebo registrační kód. |
| ACTIVATED | Stránka pro aktivaci registrace z e-mailu | Váš účet byl aktivován. |
| USERNOTFOUND | Stránka potvrzující odeslání zapomenutého hesla | Podle zadaného údaje nebyl žádný uživatel nelezen. |
| NOEMAIL | Stránka potvrzující odeslání zapomenutého hesla | Uživatel byl nalezen, ale nemá vyplněnou e-mailovou adresu. |
| USERFOUND | Stránka potvrzující odeslání zapomenutého hesla | Heslo bylo úspěšně odesláno. |
Pokud si mají uživatelé aktivovat svoje registrace v potvrzovacím e-mailu, použijte v předloze pro e-mail konstrukci
<!--WTD_IF(ACTEMAIL,"Vaši registraci lze aktivovat pomocí této stránky: <!--WTD_REGISTR(ACTURL)--> ")-->
Klíčové slovo <!--WTD_REGISTR(ACTURL)--> doplňuje URL začínající lomítkem (tedy /scripts/…). Proto je vhodné v předloze těsně před toto klíčové slovo uvést adresu serveru (http.//www.neco.cz), aby bylo možné na aktivační odkaz v e-mailu přímo klepnout.
Formulářová pole a další možné parametry prezentačních skriptů
Názvy formulářových polí a dalších možných parametrů v URL skriptů jsou v modulu ještě důležitější, než klíčová slova modulu. Klíčová slova se typicky nahrazují obsahem registračních údajů. Pokud tedy např. v přihlašovacím formuláři nejsou tato klíčová slova, nezobrazí se po chybném vyplnění a odeslání formulář vyplněný, ale prázdný, což ještě nebrání úspěšnému přihlášení. Pokud se ale název formulářového pole uveden nesprávně, není toto pole skriptem identifikováno a např. v tomto případě by nebylo možné se vůbec přihlásit. Následující tabulky udávají seznamy těchto názvů polí. Většině těchto polí odpovídá i příslušné klíčové slovo. Např. formulářové pole pro uživatelské jméno se musí jmenovat username, odpovídající klíčové slovo modulu pro uživatelské jméno je <!--WTD_REGISTR(USERNAME)-->, ve formuláři se pak zpravidla použije následující konstrukce:
<input type="text" name="username" value="<!--WTD_REGISTR(USERNAME)-->" maxlength="20" />
Následující názvy parametrů se používají v registračních formulářích.
| Formulářová pole použitelná v předlohách (registrační formulář, potvrzení zadaných údajů) | ||
| Název pole nebo parametru | Význam | Poznámka |
| username | Uživatelské jméno | |
| password | Heslo | |
| mailformat | Hodnota formátu e-mailu | Možné hodnoty"H" - HTML, "T" - text |
| firstname | Křestní jméno | |
| lastname | Příjmení | |
| nickname | Přezdívka | |
| companyname | Název firmy | |
| jobtitle | Pracovní pozice | |
| gsm_prefix | GSM předvolba | |
| gsm | GSM číslo | |
| phonenumber | Telefonní číslo | |
| address | Adresa | |
| city | Město | |
| country | Země | |
| zip | PSČ | |
| sex | Pohlaví - označení | Možné hodnoty "M" - muž, "F" - žena |
| age | Věk | |
| regcode | Registrační kód | |
| avatarfile | Soubor s avatarem | Používá se jako <input type="file" name="avatarfile"> |
| url | URL finální stránky | Stránka, na kterou je uživatel přesměrován po úspěšném uložení registrace. Pokud je prázdné, zobrazí se po uložení opět registrační stránka. |
Skript registration.php může dále z URL přijmout následující parametry
- action – uvedení parametru s hodnotou action=change znamená, že chceme upravit existující registrační záznam. Bez tohoto parametru se jedná vždy o novou registraci.
- tmplid – ID šablony, která se má použít místo standardně nastavené
- lid, locale – jazykové parametry umožňující přepnout na jiný jazyk
Skript login.php používá formulářová pole username, password a email, pro identifikaci uživatele používá pole nastavené jako unikátní identifikátor, tj. buď username nebo email, nikoliv obě zároveň.
Skript lostpassw.php používá username nebo email podle toho, které pole je nastaveno jako unikátní identifikátor.
Skript activation.php používá z URL parametry id a regcode� pro identifikaci uživatele, který má být aktivován. Parametry není třeba nějak sestavovat ručně, automaticky se doplní v předloze e-mailu za klíčové slovo <!--WTD_REGISTR(ACTURL)-->.
Plánované úlohy
Součástí modulu jsou dvě úlohy pro Plánovač úloh.
Registrace – odstranění starých dat slouží k tomu, aby se v SQL databázi nehromadily nepotřebné záznamy, které by mohly způsobit enormní nárůst objemu dat v databázi.
V prvním poli je počet dnů, po které se uchovávají data anonymních uživatelů. Jedná se o automaticky ukládané anonymní údaje, které moduly uchovávají v případě, že pracují v anonymním režimu. Tento počet dnů se stanovuje od chvíle, kdy došlo k poslední aktualizaci anonymních údajů.
Ve druhém poli je počet dnů, po které se uchovává obsah v tabulce s historií přihlášení registrovaných uživatelů (datum, IP adresa apod.).
Úloha Expirace registrovaných uživatelů slouží k tomu, aby bylo možné automaticky podle data expirace v registračních záznamech měnit stav těchto záznamů.
Je zde možné:
- Zvolit Nastavit jako neaktivní, což znamená, že nastane-li datum expirace, úloha označí registrační záznam jako neaktivní.
- Přeřadit do předvolené skupiny – úloha pak přesunuje uživatele při ukončení platnosti záznamu do nastavené skupiny,
- Zvolit obě výše uvedené možnosti najednou.
Úloha kromě běžných zápisů do protokolu WebToDate o spuštění a ukončení vytváří vlastní protokoly ve složce offlinedata/logs/registrexpiration/. Protokoly jsou ve formátu
Datum Čas ID uživatele Popis
Popis může být Uživatel deaktivován nebo Uživatel přeřazen do skupiny název_skupiny nebo obojí.
Tyto protokoly nelze prohlížet přes www rozhraní, lze je ze serveru pouze stáhnout a vyhodnotit např. pomocí aplikace MS Excel.
Rozhraní pro napojení jiných aplikací
Úvod
API pro ověřování loginu je funkcí modulu Registrace a personalizace určenou pro aplikace třetích stran, které mohou tímto sdílet seznam registrovaných uživatelů. Může být využíváno externí aplikací typu e-shop, samostatné diskuzní fórum apod.
API je realizováno pomocí skriptu, na který lze poslat přes protokol http(s) nějaký požadavek, skript zpátky vrací odpověď (uživatel je / není registrován apod.). Skript se nachází v instalaci WebToDate v podadresáři virtuálního adresáře gate, který se používá pro strojovou komunikaci s jinými moduly a je doporučeno jej zabezpečit na úrovni OS či web serveru omezením přístupu na určité IP adresy apod.
Skript podporuje následující parametry volání (názvy parametrů a hodnot jsou zde uvedeny jen jako popisky):
- Akce - jako hodnota se udává požadavek, v tuto chvíli je podporována pouze akce ověřit uživatele
- Uživatelské jméno - uživatelské jméno zadané uživatelem
- Heslo - heslo zadané uživatelem
- Detailní výpis - zda je požadována pouze informace typu je / není registrován nebo detailní informace o uživateli
Pokud je uživatel nalezen, má zadané jméno a heslo, vrací se potvrzující informace, jinak chybové hlášení. Potvrzující informace je v případě, že není žádost o detailní výpis, číselná (tj. skript vrací jen hodnotu 0), pokud je žádost o detailní informace, vrací se informace o uživateli v jednoduchém formátu XML, kde je uvedeno uživatelské jméno, jméno, e-mail a vybrané další údaje z registračního profilu.
Volající aplikace tedy podle své žádosti získá informace o tom, zda uživatel je registrován a aktivní nebo detailnější personální údaje, tyto informace už pak musí zpracovat ve svém vlastním kódu.
Vlastní API
V modulu lze v předvolbách přepnout na volbu unikátního identifikátoru - buď může jít o uživatelské jméno (výchozí volba) nebo e-mailovou adresu. Pokud je v předvolbách nastavena e-mailová adresa, všude v následujícím textu je třeba místo už. jména dosadit tuto adresu. To znamená, že parametr un (uživatelské jméno) má stejný název, ale jako hodnotu je třeba zadat e-mailovou adresu.
Komunikační skript je na adrese /gate/registration/userget.php, získávat data z něj lze pomocí http GET.
Jeho parametry uváděné za otazníkem jsou v následující tabulce.
| Parametr | Povinný | Popis |
| a | ano | Akce, jediná v současnosti podporovaná hodnota je verify. |
| un | ano | Uživatelské jméno |
| pw | ano | Heslo uživatele |
| det | ne | Žádost o detailní výpis; pokud má hodnotu yes, vrací se detailní výpis o uživateli, v opačném případě pouze potvrzení nebo chybové hlášení. |
Parametry un a pw musí být zasílány v URL-encoded tvaru, aby byla vyloučena dezinterpretace nějakých znaků. Jednoduchá žádost o zjištění, zda je uživatel registrován, vypadá tedy např. takto:
http://www.mujserver.cz/gate/registration/userget.php?a=verify&un=jarda&pw=12345
Podmínkou úspěšného ověření je, aby v databázi modulu Registrace a personalizace existoval uživatel s daným jménem a heslem a byl aktivní. Pokud tomu tak je, jsou návratové hodnoty následující:
- Číslo 0 v případě, že není požadován detailní výpis
- XML výpis registrace v případě, že je požadován detailní výpis.
Všechny ostatní případy vrací textovou chybovou hlášku. Její tvar je kód chyby - hláška, mohou nastat následující možnosti:
- E1 - Uživatel nenalezen - v databázi neexistuje uživatel s daným jménem
- E2 - Špatné heslo - uživatel s daným jménem nalezen, ale heslo nesouhlasí
- E3 - Registrace není aktivní - uživatelské jméno i heslo souhlasí, ale uživatel není aktivní
- E9 - Nastala chyba při ověřování uživatele - nastala jakákoli jiná chyba při ověřování
XML formát
Pokud je v žádosti o ověření uveden v URL parametr det=yes a uživatel je úspěšně ověřen, vrací se zpět XML kód dle následujícího vzoru.
<?xml version="1.0" encoding="UTF-8"?>
<user>
<id>123</id>
<username>jarda</username>
<password>heslo</password>
<email>jardac@macron.cz</email>
<regcode>46339806</regcode>
<firstname>Jaroslav</firstname>
<lastname>Procházka</lastname>
<nickname>jarda</nickname>
<companyname>Macron</companyname>
<gsm_prefix>602</gsm_prefix>
<gsm>123456</gsm>
<address>Dlouhá 11</address>
<city>Praha 1</city>
<country>ČR</country>
<zip>11000</zip>
<jobtitle>Programátor</jobtitle>
<phonenumber>234877444</phonenumber>
<sex>male</sex>
<age>35</age>
<avatarfile>754034578222019854.jpg</avatarfile>
<avatarwidth>60</avatarwidth>
<avatarheight>60</avatarheight>
<groups>
<group id="1">Registrovaní uživatelé</group>
</groups>
</user>
XML je generováno vždy v kódování utf-8. Jsou uvedeny vždy jen ty elementy, které mají nějaký obsah (jsou v registračním záznamu neprázdné), ostatní se při sestavování XML kódu vynechávají.
Pro element sex jsou možné hodnoty male / female. V elementu groups se uvádí seznam skupin, do kterých uživatel patří; modul v aktuální podobě podporuje pouze jednu skupinu, takže zde nyní je uvedena vždy právě jedna skupina. Význam ostatních elementů je zřejmý.
