* Copyright (c) 2007-2010 Department of Computer Science,

Viz https://forge.kiv.zcu.cz/bugs/index.php?do=details&task_id=1057 .

!! Struktura adresářů v Subversion

TBD dopsat (trunk/tags/branches samozřejmě, v trunk/ potom module/, frontend/ a build/, pod module/ std struktura viz níže, pod build/ jsou vyexportovaná .zip hotových modulů)

** pro vývoj: na lokálním opencms může být do modulu zařazen i adresář src/ apod, ale v pravidlech exportu modulu musí být že se exportují (tj. do vybuildovaného modulu uloží) pouze relevantní adresáře dle opencms konvencí

:Podoba klíčů v resource bundles: Používat prefixy @@label@@ pro popisky, @@url@@ a @@email@@ pro adresy (např. @@label.kiv.abbr = KIV@@ nebo @@url.image.logo = ../resources/logo-kiv.png@@).

* Copyright (c) 2007-2009 Department of Computer Science,

:URL zobrazovaných stránek: Pozor na to, že na beta.kiv.zcu.cz a www.kiv.zcu.cz je díky předsazenému proxy serveru odstraněn URL prefix @@/opencms/opencms@@. Proto je třeba mít tento prefix možnost snadno odstranit v JSP a Java kódu při přenosu z lokální vývojového prostředí na provozní servery. Zejména důležité u form action handlerů.

:Celková bezpečnost: Viz [[typy útoků na webové aplikace a jak jim předcházet -> http://zdrojak.root.cz/clanky/prehled-utoku-na-webove-aplikace/]]

Pravidla pro psaní zdrojových textů v projektu RedSys:

:Properties soubory (resource bundles): Ukládány do adresáře @@classes@@ modulu. Používat názvy @@module.properties@@ pro základní nastavení, @@l10n.properties@@ pro L10N hlášky, atd dle stejného mustru (@@xyz.properties@@ pro oblast nastavení XYZ).

:Výkonný kód (scriptlety):*CO NEJMÉNĚ,* používat JSTL a POJO. Zejména nezpracovávát výjimky - to musí udělat aplikační objekty, a nastavit request atribut který řekne "byly chyby" a který JSP otestuje a chyby zobrazí.

:V JSP stránkách: *CO NEJMÉNĚ,* snažit se využít POJO a JSTL pro JSP stránky. Vlastní značky (taglib) vytvářet jen v odůvodněných případech a po schválení vedením projektu.

Používá se standardní přístup s resource bundles (viz [[Java Internationalization: An Overview -> http://java.sun.com/developer/technicalArticles/Intl/IntlIntro/]] a [[Localization with ResourceBundles -> http://java.sun.com/developer/technicalArticles/Intl/ResourceBundles/]]).

Příklad použití v JSP stránce:

[@
<% request.setAttribute("locale", request.getLocale()); %>
<fmt:setLocale value="${locale}" />
<fmt:bundle basename="cz/zcu/kiv/produkty/produkty">
<h1><fmt:message key="produkty.seznam" /></h1>@]

:Properties soubory: Ukládány do adresáře @@classes@@ modulu. Používat názvy @@module.properties@@ pro základní nastavení, @@l10n.properties@@ pro L10N hlášky.

:Properties soubory: Používat názvy @@module.properties@@ pro základní nastavení, @@l10n.properties@@ pro L10N hlášky.

:Zachytávání výjimek: Ve všech XyzFormHandler mít @@catch (Exception e)@@ na konci try-catch bloku, aby nevyhřezlo klientovi 500 Service unavailable při obecné (např. SQL) výjimce.

:Název: Buďto (preferovaná varianta) @@.../adresar/seznam.jsp@@ resp. @@.../detail.jsp@@ resp. @@.../edit.jsp@@ (např. @@.../osoby/seznam.jsp@@, nebo případně (nouzová varianta když je víc editačních apod. v jednom adresáři) @@.../adresar/funkce-edit.jsp@@ (např. @@.../osoby/kategorie-edit.jsp@@) -- tedy nikoli @@funkceEdit.jsp@@ nebo @@editFunkce.jsp@@ nebo @@funkce_edit.jsp@@ a podobně.

:Kam L10N řetězce: (1) Využívat možností OpenCms (properties VFS objektu, jazykové mutace XML strukturovaných dat), (2) používat standardní konvence. Pro JSP použít @@<c:if>@@ nebo @@<c:switch>@@ -- pokud je v JSP málo textů závislých na jazyce -- nebo @@.properties@@ lokalizační bundly v modulu, primárně pokud jsou to texty které jdou do template.

:JSP stránky: V adresáři @@pages@@ (ne v templates, aby se nevypisovaly v seznamu šablon při zakládání libovolné HTML stránky)

!! [[#moduly]] Moduly a aplikace v OpenCms

!!! Struktura modulu

:JSP stránky: V adresáři @@pages@@.

!!! Aplikační JSP stránky

:Název: Buďto (preferovaná varianta) @@.../adresar/seznam.jsp@@ resp. @@.../detail.jsp@@ resp. @@.../edit.jsp@@ (např. @@.../osoby/seznam.jsp@@, nebo případně @@.../adresar/funkce-edit.jsp@@ (např. @@.../osoby/kategorie-edit.jsp@@) -- tedy nikoli @@funkceEdit.jsp@@ nebo @@editFunkce.jsp@@ nebo @@funkce_edit.jsp@@ a podobně.
:Vazba na modul: Přes @@<cms:include>@@ příslušné modulové JSP stránky

* dodržovat obecně platné [[konvence psaní kódu v Javě -> http://java.sun.com/docs/codeconv/]], pouze rozhraní stylem @@IMojeRozhrani@@

Pravidla pro psaní zdrojových textů:

!! [[#moduly]] Moduly v OpenCms

!!! Struktura

:Držet se OpenCms konvencí: Podadresáře @@resources@@, @@pages@@, @@lib@@, @@classes@@ atd. (viz třeba @@org.opencms.frontend.photoalbum@@ nebo @@org.opencms.frontend.layoutpage@@).
:Název: Musí mít ve VFS předponu @@cz.zcu.kiv@@ následovanou inteligentním jménem modulu.

!!! Výkonný kód

:V JSP stránkách: Snažit se využít POJO a JSTL pro JSP stránky. Vlastní značky (taglib) vytvářet jen v odůvodněných případech a po schválení vedením projektu.
:Zdrojové Java třídy: Musí být dobře pojmenovaném v balíku (dle názvu modulu do kterého patří) umístěném pod @@cz.zcu.kiv.opencms@@.
:Přístup do DB: Používat Spring JDBC, třídy v balíku pod @@cz.zcu.kiv.db@@, podle ArchitekturaDaoVrstvy.

!!! Lokalizace (L10N)

:Kam L10N řetězce: Využívat možností OpenCms (properties VFS objektu, jazykové mutace XML strukturovaných dat). Pro JSP použít @@<c:if>@@ nebo @@<c:switch>@@ -- předpoklad je že v JSP bude málo textů závislých na jazyce, proto nebudou používány @@.properties@@ lokalizační bundly.
:Editační JSP stránky: Pro vlastní KIV aplikace budou vždy pouze v CZ (prezentační stránky jsou česky a/nebo anglicky).
:Jak se zjistí aktuální locale: TBD

!!! Zabezpečení, autentikace a autorizace

:Autentikace: (ověření jména/hesla) Zatím (3/2008) přes OpenCms, v budoucnu přes Kerberos (viz ZabezpecenePrihlaseni).
:Autorizace: (kdo kam může) Řešit prostředky OpenCms (Permissions na VFS objektu) nikoli v aplikační logice.
:Zjištění aktuálně přihlášeného uživatele: Pro potřeby JSP aplikačních stránek - TBD.

* používat _@author_ na třídách které přidávají či editují

* používat @author na třídách které přidávají či editují
* tabulátory konvertovat na mezery, odsazování o dvě mezery
* dodržovat obecně platné [[konvence psaní kódu v Javě -> http://java.sun.com/docs/codeconv/]]
* standardní hlavička zdrojových souborů, viz níže

[@
/**
* Web KIV modul NNNN.
*
* Copyright (c) 2007-2008 Department of Computer Science,
* University of West Bohemia, Pilsen, CZ
*
* This software and this file is available under the Creative Commons
* Attribution-Noncommercial-Share Alike license. You may obtain a copy
* of the License at http://creativecommons.org/licenses/ .
*
* This software is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License
* for the specific language governing permissions and limitations.
*/
@]

----
Zpět na PravidlaProVyvojare