Specifikace projektu aplikace Klient KOSu

Transkript

1 FEL ČVUT, STM Specifikace projektu aplikace Klient KOSu Semestrální práce SI2/3 Martin Tříska, Aleš Nejdr, Vladimír Klouček, Jiří Zamazal Zimní semestr 2010 Tento dokument obsahuje kompletní specifikaci projektu Klient KOSu tvořeného v rámci předmětů SI2/3 na FEL ČVUT. Specifikace je rozšířena dalšími dokumenty (Analýza rizik, ) které doplňují a zpřesňují zde zběžně popsané informace

2 Obsah Obsah Seznam obrázků Používané zkratky Úvod Smysl tohoto dokumentu Konvence dokumentu Pro koho je tento dokument určen Rozsah projektu Cíle: Benefity: Odkazy na související materiály Celkový popis Perspektiva produktu Vlastnosti produktu Role v aplikaci Operativní prostředí Omezení návrhu a implementace Uživatelská dokumentace Předpoklady a závislosti Funkce systému Napojení na KOS Popis a priorita Uživatelské akce a reakce systému Funkční požadavky Napojení na UTVS Popis a priorita

3 5.2.2 Uživatelské akce a reakce systému Funkční požadavky Hodnocení vyučujících a předmětů (FelGuide) Popis a priorita Uživatelské akce a reakce systému Funkční požadavky Požadavky na vnější rozhraní Uživatelské rozhraní Obecné Přihlášení Okno KOS Studijní výsledky Okno KOS Sylaby předmětů Okno KOS Poznámky k předmětům Okno KOS Jednorázové akce Okno KOS Zapsané předměty Okno KOS Předměty podle studijního plánu Okno KOS Všechny předměty Okno KOS Zobrazit rozvrh Okno KOS Tvorba rozvrhu Okno KOS Termín zkoušek Okno KOS Přihlášené zkoušky Okno UTVS Seznam cvičících Okno UTVS Seznam sportů Okno FEL Guide Seznam předmětů Okno FEL Guide Seznam vyučujících Okno FEL Guide Vyhledávání Hardware interface Software interface

4 6.4 Komunikační interface Ostatní (nefunkční) požadavky Požadavky na výkon Požadavky na bezpečnost Atributy kvality aplikace Seznam obrázků Obrázek 1 - Obecné schéma nasazení 7 Obrázek 2 - Obecné Přihlášení 11 Obrázek 3 - Okno KOS Studijní výsledky 11 Obrázek 4 - Okno KOS Sylaby předmětů 12 Obrázek 5 - Okno KOS Poznámky k předmětům 12 Obrázek 6 - Okno KOS Jednorázové akce 13 Obrázek 7 - Okno KOS Zapsané předměty 13 Obrázek 8 - Okno KOS Předměty podle studijního plánu 14 Obrázek 9 - Okno KOS Všechny předměty 14 Obrázek 10 - Okno KOS Zobrazit rozvrh 15 Obrázek 11 - Okno KOS Tvorba rozvrhu 15 Obrázek 12 - Okno KOS Termín zkoušek 16 Obrázek 13 - Okno KOS Přihlášené zkoušky 16 Obrázek 14 - Okno UTVS Seznam cvičících 17 Obrázek 15 - Okno UTVS Seznam sportů 17 Obrázek 16 - Okno FEL Guide Seznam předmětů 18 Obrázek 17 - Okno FEL Guide Seznam vyučujících 18 Obrázek 18 - Okno FEL Guide Vyhledávání 19 2 Používané zkratky Zkratka KOS UTVS FelGuide HTTP XML UDB API Význam Komponenta studenta Ústav tělesné výchovy a sportu Webový systém pro hodnocení vyučujících HyperText Transfer Protocol Extensible Markup Language Uživatelská databáze FEL ČVUT Rozhraní pro programování aplikací 4

5 3 Úvod 3.1 Smysl tohoto dokumentu Cílem našeho projektu je vytvořit desktopovou multiplatformní aplikaci, která bude sloužit jako klient pro školní systém Komponenta studenta (dále pouze KOS). Dosavadní řešení (webová aplikace na adrese ) je nedostačující a nepohodlné pro studenty i vyučující. Webová aplikace je v obdobích s vyšší zátěží nestabilní, nedostupná či minimálně přetížená. Chceme tedy zjednodušit správu uživatelských (studentských) účtů v této aplikaci pomocí oddělení klienta od webového rozhraní do našeho GUI, které bude navrženo s co nejvyšším důrazem na uživatelskou přívětivost a funkčnost. Bude tedy umožňovat nejdůležitější funkce, které obsahuje webový KOS a navíc i nějaké nové (viz níže). Vedlejším produktem bude také ulehčení webové aplikaci, jelikož veškerá komunikace se serverem bude probíhat pomocí HTTPS pomocí XML requestů (tedy nebude nutné vykreslovat web pro každého uživatele). Tento dokument detailně popisuje specifikaci našeho projektu od návrhu až po požadavky. 3.2 Konvence dokumentu Důležité výrazy jsou uvedeny tučně. Citace z jiných prací uvedeme kurzívou. Odkazy na internetové stránky budou vkládány do textu ve tvaru http.// 3.3 Pro koho je tento dokument určen Tento dokument je určen každému, kdo se chce dozvědět více o projektu aplikace KOS gui. Následující stránky obsahují obecnou specifikaci projektu. 3.4 Rozsah projektu Projekt není vyvíjen jako komerční produkt. Jde o projekt v rámci předmětu Softwarové inženýrství 2 a 3 na Českém vysokém učení technickém v Praze Cíle: Benefity: o Usnadnit uživatelům (studentům) práci s KOSem o Zjednoušit práci se školními systémy (UDB, UTVS,KOS) o Poskytnout multiplatformí desktopovou alternativu pro KOS o Novými funkcemi zpříjmenit používání KOSu o Splnit požadavky Softwarového inženýrství 2 a 3 o Open-source (možnost rozšíření, modifikací) o Rychlejší práce s aplikací o Pohodlné ovládání o Graficky i uživatelsky přívětivé prostředí o Sjednocení školních systémů na jednom místě (UDB, UTVS, KOS) o Možnost hodnotit předměty i vyučující, sdílet tyto informace Není cílem naší aplikace plně nahradit ovládání webové aplikace KOS pomocí webového prohlížeče, pouze poskytnout alternativu těm, kteří nejsou se stávajícím stavem spokojeni a stojí o změnu. 3.5 Odkazy na související materiály Diplomová práce Specializovaný aplikační server pro WWW funkce KOS IS 5

6 o Oleg Smirskyy, ČVUT FEL. o dipl Diplomová práce Uživatelské rozhraní KOS pomocí Shockwave Flash o Jan Kořínek, ČVUT FEL o dipl Gantt diagram s plánem projektu o Dokument Specifikace požadavků o Dokument UseCase o Dokument Analýza rizik o alyza_rizik.pdf Dokument Návrh akceptačních testů o Dokument plán testů o DXzH7XCFnPvVMw&hl=en Dokument plán řízení jakosti o Diagram nasazení o ploymentmodel.png Domovská stránka projektu (všechny informace) o 4 Celkový popis 4.1 Perspektiva produktu Důvodem pro vznik tohoto projektu je dlouhodobá nespokojenost studentů ČVUT (zároveň členů vývojového týmu) se systémem aplikace KOS. Jak již bylo zmíněno v první části tohoto dokumentu, současná webová aplikace ( je zastaralá, nestabilní a uživatelsky nepřívětivá. Navíc se zdá, že stále se množící připomínky nikdo neřeší a celý systém tak postupně upadá. Jelikož jsme nuceni s KOSem pracovat - zapisovat si rozvrhy, přihlašovat se na zkoušky, atd... - je proto naší motivací uzpůsobit si tuto nutnou práci co nejvíce podle našich potřeb. Webová aplikace nám žádné možnosti úprav neumožňuje a proto jsme se rozhodli vyvinout v rámci školního projektu desktopovou aplikaci, která by nám naši práci usnadnila a co nejvíce zpříjemnila a zrychlila. Aplikace tedy je určená studentům ČVUT a hlavně pak studentům fakult FEL a FIT. Naše aplikace tedy navazuje na již existující systém KOSu, který je ovšem pro externí uživatele naprosto nepřístupný. Toto není způsobeno neochotou odpovědných lidí či byrokratickými překážkami, ale pouze a jenom jeho složitostí. Systém se vyvíjí již více než 18 let a zdá se, že nikdy neměl žádný koncept. Nové funkcionality byly přidávány bez jakékoli integrační myšlenky tak, aby fungovali a způsobily co možná nejméně chyb, což se ale samozřejmě časem vymklo kontrole. Na naši 6

7 žádost o zpřístupnění dokumentace KOSu, případně pouze jeho externího rozhraní jsme dostali jednoduchou odpověď, že taková dokumentace neexistuje, a lidé, kteří znají alespoň jednotlivé části KOSu mají příliš mnoho práce, než aby se nám mohli věnovat. Pro fungování naší aplikace je ovšem důležité přistupovat k datům uživatelů, jejich rozvrhům či osobním údajům a proto je nutné vytvořit si vlastní FALEŠNÝ server, který bude simulovat databázi KOSu. Projekt navazuje na diplomovou práci Specializovaný aplikační server pro WWW funkce KOS IS (Oleg Smirsky, ČVUT FEL, odkaz). V této práci autor vytvořit aplikační server, který poskytoval API pro přístup k datům uživatelů KOS. Díky tomuto API další student Jan Kořínek vytvořil klienta pomocí technologie Flash, který uměl pracovat s KOSem (Uživatelské rozhraní KOS pomocí Shockwave Flash, ČVUT FEL, odkaz). Aplikační server RECVLITE od Olega Smirskyyho, který byl dříve nasazen na fakultním serveru felk.cvut.cz a sloužil k testování klientů, již není bohužel dostupný, a tak si bohužel musíme vytvořit vlastní testovací server. Avšak v naší práci dodržíme RECVLITE API (DTD XML a komunikace na HTTPS), aby šlo v budoucnu tyto dvě aplikace propojit a funkčně nasadit. Obrázek 1 - Obecné schéma nasazení 4.2 Vlastnosti produktu Po přihlášení uživatel do svého profilu mu aplikace umožní spravovat svůj školní účet. Cílem je zachovat současné funkce aplikace KOS a přidat nové, případně připravit aplikaci tak, aby přidání těchto nových funkcionalit bylo co nejjednodušší. Stávající funkce KOSu Zápis a kontrola zapsaných předmětů Správa osobních údajů uživatele Přehled studijních výsledků Zobrazení rozvrhů a možnost jejich tvorby Přihlašování na jednorázové akce Nové funkce naší aplikace Integrace UTVS (aplikace ústavu tělesné výchovy) Integrace UDB (databáze uživatelů) Hodnocení učitelů Uživatelsky přívětivé GUI 4.3 Role v aplikaci V naší aplikaci bude vystupovat pouze jeden typ uživatele a to bude student. Je to dáno hlavně tím, že role studenta je jediná, ke které máme jako studenti přístup a kterou můžeme otestovat. 7

8 Nebylo možné domluvit přístup do KOSu v roli administrátora, případně vyučujícícho a tak se musíme spokojit pouze s touto rolí. Protože je však aplikace určena studentům, tato role bude postačovat. 4.4 Operativní prostředí Aplikace bude pracovat jako desktopová aplikace na osobních počítačích jednotlivých uživatelů. Na HW těchto strojů nejsou kladeny vysoké nároky, neboť naše aplikace není složitá na výpočetní výkon. Aplikace je vyvíjena multiplatformně a proto ji lze spustit na operačních systémech Windows I Linux (jiné systémy nebudou testovány). Cílový operační systém musí mít grafické rozhraní, aplikace nepracuje v řežimu řádkového klienta. Je očekávána přítomnost internetového připojení bez ohledu na jeho rychlost. 4.5 Omezení návrhu a implementace Existuje několik limitujících faktorů, které v tomto projektu nastanou. Jedním z těch nejkritičtějších je jednoznačně nedostatek času. Podle hrubých odhadů bude pracnost tohoto projektu cca h, což při 4 členech v našem týmu znamená zhruba 150h na každého člena, což je velká časová zátěž vzhledem k našim dalším aktivitám. Dalším limitujícím faktorem je také přístup správců KOSu a obecně KOS jako takový. Nezdokumentovaný kolos jako je právě KOS by se mohl stát kamenem úrazu. Proto jsme se rozhodli pro falešný server a imitaci funkčnosti KOSu pouze pro naše účely. Možným omezujícím prvkem by také mohla být neochota osob odpovědných za UTVS a UDB, jelikož budeme potřebovat jejich spolupráci a poskytnutí přístupů do jejich systémů. 4.6 Uživatelská dokumentace Ke zdrojovému kódu aplikace bude napsána dokumentace a celý zdrojový kód bude řádně okomentovaný. V průběhu projektu bude napsán také tutoriál pro uživatele, kteří nevědí, jak aplikaci využívat. Myslíme si, že tyto dva dokumenty, společně s dokumenty souvisejícími s projektem (jako například tento), poskytnou dostatečnou informační základnu všem uživatelům, neboť náš projekt není rozsáhlý a i bez této dokumentace je snadno pochopitelný. 4.7 Předpoklady a závislosti Jedním z bodů, kterých chceme dosáhnout, je integrace UDB a UTVS aplikací do našeho projektu, což se ale také může ukázat jako problém. Pokud nám vedení těchto jednotlivých institucí nevyjde vstříc a neposkytne nám ke svým aplikacím potřebné dokumenty, budeme si muset nasimulovat i tyto systémy, případně jejich využití obejít (a například parsovat HTML). 5 Funkce systému 5.1 Napojení na KOS Popis a priorita Aplikace se bude umět připojit a přihlásit na server KOS (v našem případě fiktivní testovací server) a komunikovat s ním. Tato funkčnost má nejvyšší prioritu a je z celé aplikace nejdůležitější Uživatelské akce a reakce systému Aplikace bude s uživatelem komunikovat pomocí GUI. Uživatel bude program ovládat pomocí formulářů a dialogových oken, aplikace tyto požadavky uživatele zpracuje a odešle je na KOS server. Když KOS server odpoví, aplikace přijatá data ze serveru přehledně zobrazí v GUI. 8

9 5.1.3 Funkční požadavky Uživatel bude vždy informován o stavu výsledku operace. Pokud se tedy operace nezdaří (např. předmět nepůjde zapsat), uživatel o tom bude informován. Stejně tak, pokud se operace zdaří (např. zapsání paralelky se zdařilo), uživatel je o tom informován. REQ-KOS-1: Odebrání poznámky z rozvrhu REQ-KOS-2: Odhlášení z "jednorázových akcí" REQ-KOS-3: Odhlášení ze zkoušky REQ-KOS-4: Přidání poznámky do rozvrhu REQ-KOS-5: Tisk rozvrhu REQ-KOS-6: Uživatel se může odhlásit ze systému KOS REQ-KOS-7: Uživatel se může připojit do systému KOS REQ-KOS-8: Zapsání na "jednorázové akce" REQ-KOS-9: Zobrazení "jednorázových akcí" REQ-KOS-10: Zobrazení detailních informací k předmětu REQ-KOS-11: Zobrazení možnosti přístupu do rozvrhu REQ-KOS-12: Zobrazení přehledu studijních výsledků REQ-KOS-13: Zobrazení rozvrhu REQ-KOS-14: Zobrazení studijního plánu REQ-KOS-15: Zobrazení termínů zkoušek REQ-KOS-16: Zobrazení zapsaných předmětů REQ-KOS-17: Zrušení zapsaného předmětu REQ-KOS-18: Zrušní zapsané paralelky cvičení, přednášky REQ-KOS-19: Zápis na zkoušku REQ-KOS-20: Zápis paralelky cvičení, přednášky REQ-KOS-21: Zápis předmětu 5.2 Napojení na UTVS Popis a priorita Aplikace bude umožňovat zobrazení dostupných tělocviků ze systému UTVS a jejich filtrování na základě určitých údajů, například typu sportu, času cvičení apod. To by mělo uživateli usnadnit vybírání tělocviků na základě svých priorit a školního rozvrhu. Systém UTVS slouží k zapisování tělesné výchovy a letních/zimních kurzů. Priorita této funkčnosti je střední Uživatelské akce a reakce systému Aplikace bude s uživatelem komunikovat pomocí GUI. Uživatel bude program ovládat pomocí formulářů a dialogových oken, aplikace tyto požadavky uživatele zpracuje a odešle je na UTVS server. Když UTVS server odpoví, aplikace přijatá data ze serveru přehledně zobrazí v GUI Funkční požadavky REQ-UTVS-1: Vyhledávání paralelky podle parametrů REQ-UTVS-2: Zobrazení paralelek sportu REQ-UTVS-3: Zobrazení seznamu sportů REQ-UTVS-4: Zrušení zápisu cvičení (paralelky) REQ-UTVS-5: Zápis cvičení (paralelky) 9

10 5.3 Hodnocení vyučujících a předmětů (FelGuide) Popis a priorita Aplikace bude umožňovat hodnotit vyučující a předměty, stejně jako prohlížet hodnocení jiných studentů. V současné době je tato funkcionalita pokryta pouze webovou stránku (odtud název FelGuide), která je ovšem neaktualizovaná a obsahově zastaralá. Naše aplikace se přesto bude napojovat na tento server a vyparsuje z něj všechny komentáře a hodnocení, která na něm již jsou. Priorita této funkčnosti je střední Uživatelské akce a reakce systému Aplikace bude s uživatelem komunikovat pomocí GUI. Uživatel bude program ovládat pomocí formulářů a dialogových oken. V případě potřeby se aplikace připojí na server, na který uloží nové hodnocení, případně stáhne požadované hodnocení. Všechny tyto aktivity budou reflektovány přímo v aplikaci notifikací pro uživatele Funkční požadavky REQ-FELGUIDE-1: Přidáno hodnocení REQ-FELGUIDE-2: Vyhledávání v seznamu vyučujících REQ-FELGUIDE-3: Zobrazení hodnocení osoby REQ-FELGUIDE-4: Zobrazení seznamu předmětů REQ-FELGUIDE-5: Zobrazení seznamu vyučujících 6 Požadavky na vnější rozhraní 6.1 Uživatelské rozhraní Grafické rozhraní aplikace je vytvořeno pomocí grafických knihoven Pythonu. Místo textového popisu přikládáme přímo screenshoty. 10

11 6.1.1 Obecné Přihlášení Obrázek 2 - Obecné Přihlášení Okno KOS Studijní výsledky Obrázek 3 - Okno KOS Studijní výsledky 11

12 6.1.3 Okno KOS Sylaby předmětů Obrázek 4 - Okno KOS Sylaby předmětů Okno KOS Poznámky k předmětům Obrázek 5 - Okno KOS Poznámky k předmětům 12

13 6.1.5 Okno KOS Jednorázové akce Obrázek 6 - Okno KOS Jednorázové akce Okno KOS Zapsané předměty Obrázek 7 - Okno KOS Zapsané předměty 13

14 6.1.7 Okno KOS Předměty podle studijního plánu Obrázek 8 - Okno KOS Předměty podle studijního plánu Okno KOS Všechny předměty Obrázek 9 - Okno KOS Všechny předměty 14

15 6.1.9 Okno KOS Zobrazit rozvrh Obrázek 10 - Okno KOS Zobrazit rozvrh Okno KOS Tvorba rozvrhu Obrázek 11 - Okno KOS Tvorba rozvrhu 15

16 Okno KOS Termín zkoušek Obrázek 12 - Okno KOS Termín zkoušek Okno KOS Přihlášené zkoušky Obrázek 13 - Okno KOS Přihlášené zkoušky 16

17 Okno UTVS Seznam cvičících Obrázek 14 - Okno UTVS Seznam cvičících Okno UTVS Seznam sportů Obrázek 15 - Okno UTVS Seznam sportů 17

18 Okno FEL Guide Seznam předmětů Obrázek 16 - Okno FEL Guide Seznam předmětů Okno FEL Guide Seznam vyučujících Obrázek 17 - Okno FEL Guide Seznam vyučujících 18

19 Okno FEL Guide Vyhledávání Obrázek 18 - Okno FEL Guide Vyhledávání 6.2 Hardware interface Aplikace nevyžaduje speciální hardware pro svůj běh, stačí průměrný počítač. Aplikace bude pouze potřebovat připojení k internetu a tiskárnu pro případný tisk rozvrhů. O samotnou komunikaci s hardwarem se bude starat pouze operační systém. Minimální požadavky: procesor 800MHz, paměť 128MB RAM, cca 50MB volného místa na disku. 6.3 Software interface Aplikace bude multiplatformní, takže nebude omezena jen na jeden systém. Aplikace bude potřebovat Python verze 2.7, knihovnu PyQt verze 4.7.7, aplikaci OpenSSL a knihovnu PyOpenSSL. Důležitou komponentou, na kterou budeme naši aplikaci integrovat je systém KOSu, UTVS a FelGuide. Jak již ale bylo v této specifikaci zmíněno, tyto systémy jsou pro externí uživatele prakticky uzavřené (hlavně tedy aplikace KOSu). Bylo proto nutné si vytvořit na základě diplomové práce Olega Smirskeho vlastní falešný server se stejným rozhraním jako má zmíněná diplomová práce. Mezi tímto serverem a aplikací bude probíhat veškeré komunikace týkající se KOSu pomocí XML. Na tento server se bude uživatel autentizovat a z něho získávat všechna data (seznamy zkoušek, předmětů, studijní výsledky). Tyto hodnoty budou samozřejmě falešné, ale aplikace bude napsána tak, aby bylo možné její nasazení na reálný server. Tímto problémem se ale náš projekt nezabývá Dále se aplikace bude připojovat k serveru UTVS. Po konzultaci s administrátorem serveru UTVS jsme přistoupili k tomu, že vytvoříme DTD pro XML export dat z UTVS a s ním budeme v aplikaci pracovat. Jelikož se plánuje vytvoření aplikace pro XML export dat z UTVS na příští rok, neměl by pak být s připojením na server problém. Samozřejmě za předpokladu, že naše DTD nepozmění. 19

20 6.4 Komunikační interface Aplikace bude komunikovat se servery pomocí TCP/IP protokolu. Se serverem KOS pak HTTPS, se serverem FEL guide a se serverem UTVS po normálním HTTP. Bude využívat formátu XML pro přenášení dat z a do KOS serveru, z UTVS serveru a parsování HTML z FEL guide serveru. 7 Ostatní (nefunkční) požadavky 7.1 Požadavky na výkon Aplikace by měla být rychlá i na starších počítačích a její výkonnost by neměla záviset na konkrétním hardwaru, pokud se nejedná o velmi starý stroj. Vzhledem k použitým technologiím, které jsou rychlé a nenáročné, a vzhledem k tomu, že projekt není až tak velký, aby měl signifikantní podíl na vytíženosti počítače, očekáváme rychlý chod programu a tedy bezproblémové užívání. 7.2 Požadavky na bezpečnost Nejdůležitějším požadavkem na bezpečnost bude, aby aplikace sama nezměnila studentovi údaje bez jeho vědomí. Také se nesmí poškodit informace uložené na disku počítače uživatele ani počítač (software) samotný. Aplikace by měla hlídat každý uživatelův krok a ve vážnějších rozhodnutích vyžadovat potvrzení, například při zrušení předmětu. Jelikož studentský uživatelský účet v KOSu obsahuje osobní informace o studentech a v podstatě na něm závisí jejich studium, je potřeba zajistit bezpečný přístup do uživatelského účtu na serveru. Komunikace se serverem tedy bude probíhat pomocí protokolu https, který nám zajistí, že se do komunikace mezi server a klientskou aplikaci nedostane někdo cizí. Dále je potřeba zajistit, že se data ze samotné aplikace nedostanou do cizích rukou, což bude vyřešeno tak, že dokud se student nepřihlásí přes https na server, nebude mu aplikace zpřístupněna. 7.3 Atributy kvality aplikace Důležité je navrhnout aplikaci tak, aby se dala v budoucnosti jednoduše rozšiřovat o další funkce. Samozřejmostí je také uživatelská přívětivost a správnost chodu. Aplikace by měla být stabilní. Aplikace by měla způsobovat menší zátěž serveru a menší datový traffic než stávající webová aplikace KOS. 20