Meeskond: Spooky Scary Skeletons: Difference between revisions

From ICO wiki
Jump to navigationJump to search
← Older edit
Ssaks (talk | contribs)
152 edits
Ssaks (talk | contribs)
152 edits
No edit summary
 
(104 intermediate revisions by 3 users not shown)
Line 10: Line 10:


== Analüüs ==
== Analüüs ==
=== Andmebaas ===
AVE 2.0 on kodutööde planeerimise rakendus, kuhu iga kasutaja saab lisada õppeaines antud kodutöid, lisada neile esitamise tähtaegu ja muud lisainformatsiooni.
=== Infovahetus ===
=== Kasutajaliides ===
=== Kasutajakontode haldus ===
=== Võimalikud probleemid ===
==== Spam ====
'''Probleemi kirjeldus'''


'''Lahendus'''
=== Mõisted ===
==== Privaatsus ====
*'''Task''' - ülesanne, test, eksam, mille kasutaja kannab kalendrisse ja määrab vähemalt kohustuslikud atribuudid. Task'il saab olla vaid üks tähtaeg;
'''Probleemi kirjeldus'''
*'''Alamtask'''  - task, mis on osa suuremast tööst (kuulub mingi taski alla) ning millele saab määrata omaette atribuute;
*'''Atribuut''' - task'i omadused (näiteks: tähtaeg, kirjeldus, kommentaarid, viited jne);
*'''Õppeaine''' - Taske grupeeriv atribuut;
*'''Grupp''' - Taske grupeeriv atribuut, mis on ülem õppeainest (ehk kui grupp on määratud, siis pakutakse antud taski ainult selle grupi liikmetele). Grupp võib eksisteerida ka ilma õppeaineta;
*'''Subscribe''' - õppeainega, grupiga või task'iga liitumine, mille tulemusena ilmub vastava aine/grupi task'id kasutaja kalendrisse;


'''Lahendus'''
=== Rakenduse kirjeldus ===
Rakenduse eesmärgiks on hõlbustada kodutööde planeerimist ja tähtaegade järgimist. Rakendusse saab lisada kodutööde, testide ja eksamite tähtaegu. Sisestatud töid nimetame taskideks. Taskid võivad omakorda sisaldada muud antud ülesandega seotud infot (alamtähtajad, kommentaarid jne).
 
Rakendus on põhiliselt mõeldud IT Kolledži õppeainete tähtaegade märkimiseks. Sellel eesmärgil on tähtaja juurde võimalik märkida õppeaine Info õppeainete kohta tuleb importida kooli õppeinfosüsteemidest.
 
Rakenduse kasutamiseks on kohustuslik serveris konto loomine. Anonüümset offline kasutust ei ole.
 
Kasutaja saab ära märkida oma kooli(d) ja deklareeritud õppeained. Õppeainetele subscribe'ides saab kasutaja märkida ka oma õppegrupi või õppevormi (näiteks päevaõpe, kaugõpe, õhtuõpe - neid nimetame koondnimetusena “õppeaine versiooniks”). Kasutaja saab luua ka eraldiseisvaid õppetööga seotud või mitteseotud gruppe.
 
Rakendus pakub kasutajale ka teiste antud aine deklareerinud kasutajate poolt märgitud tähtaegu ja lisainfot nende kohta. Kasutajale pakutakse automaatselt see versioon taskist, mis hetkel on  kasutajate hulgas kõige populaarsem. Kasutaja võib selle tagasi lükata, kui task teda ei huvita, või võtta vastu mõne muu versiooni taskist. Kasutaja võib teiste lisatud taskile ka ise atribuute lisada, mis juhul neid muudatusi pakutakse ka teistele kasutajatele.
 
Rakendus koosneb kahest põhilisest osast: klient ja server.
 
==== Klient ====
Klientprogramm võimaldab kasutajal lisada taske, hallata oma kasutajaprofiili ja vaadata ning lisada endale teiste poolt lisatud taske ja nende atribuute.
 
Klient suhtleb serveriga üle REST API.
 
Klient hoiab lokaalselt andmeid SQLite andmebaasis, sinna replikeeritakse ka teiste kasutajate poolt lisatud muutused juhul kui kasutaja need aktsepteerib.
 
Klient peab oskama API kaudu küsida serverist teda huvitavaid värskendusi ehk klient peab pidama arvet selle üle milline osa infost tal on kohalikus andmebaasis olemas.
 
Rakendust käivitades küsitakse kasutajalt kasutajanime ja parooli, seejärel rakendus käivitub, kuvab antud kasutaja töölaua, ning üritab autentida ja sünkroniseerida serveriga.
 
Task'i lisamisel kalendrisse saab sellele lisada erinevat lisainfot sisaldavaid atribuute (vahetähtajad, töö detailsed nõuded, progress jmt). Rakendus hoiatab kasutajat, kui task'i täitmise tähtaeg on lähenemas.
 
'''Kliendi must-have funktsionaalsus:'''
 
* Peab olema võimalik kasutajaks registreerida (kasutajakonto olemsolu on kohustuslik programmi kasutamiseks);
*  Kasutaja peab saama sisse logida kasutajanime ja parooliga;
* Kasutaja peab saama registreerida ennast gruppidesse ja/või erinevate õppeainetele/kursustele;
* Kasutaja peab saama sisestada taski kirjeldust (taski) koos esitamise tähtajaga oma kalendrisse;
* Kasutaja peab saama taski kirjeldusena märkida:
** Task'i täitmise tähtaega;
** Task'i liiki : ainetöö, essee, kursusetöö, lõputöö, referaat, praktika aruanne, eksam, test, muu;
** Taskiga seotud õppeaine ettantud nimekirjast;
** Taskiga seotud grupi. Kui grupp on valitud, siis edastatakse task vaid grupi liikmetele
** soovi korral kommentaariväljale lisainfot, viidet õppematerjalidele jne;
** aja, millal rakendus teavitab kasutajat tähtaja lähenemisest (vabatahtlik, vaikimisi 3 päeva enne);
** kas task on alustamata, pooleli või lõpetatud (st taski staatust)
* Rakendus peab töötama nii online kui offline režiimis. Vaikimisi režiimiks on online, offline saab olla eelkõige ainult siis, kui arvuti ei ole internetiga ühendatud. Kui rakendus on offline, siis kajastub kasutajaliideses vastav teade;
* Kasutaja peab saama muuta kalendrisse lisatud task’e. Muudatused peavadilmuma teavitusena kõikide kasutajate privaatkalendritesse, kes on ennast sellele ainele/gruppi registreerinud, ning igal kasutajal on siis võimalus teavitust aktsepteerida või tagasi lükata. Teavituse aktsepteerimisel viiakse task’i muudatused kasutaja kalendrisse;
 
'''Kliendi nice-to-have funktsionaalsus:'''
* Statistika tehtud ülesannete kohta.
* Kasutajakonto loomisel CAPTCHA kasutamine
* Lokaalse andmebaasi krüpteerimine kasutaja parooli baasil
 
==== Server ====
Serveris toimub kasutajate haldus ja kõikide kasutajate poolt sisestatud info talletamine. Serveri põhiline ülesanne on vastavalt API käskudele andmebaasist andmete esitamine.
 
Serveris asub tsentraalne andmebaas kogu rakenduse infoga(kõik task'id, nende atribuudid, jne). Kasutame PostgreSQL andmebaasi.
 
Suhtlus kliendi ja serveri vahel toimub üle REST api.
 
Andmebaasi skeem:
 
[[File:Database AVE.png|900px]]
 
'''Serveri must-have funktsionaalsus:'''
 
* Peab võimaldama suhtlust kliendi ja andmebaasi vahel
* Registreerumisel saadetakse kasutajale e-mail registreerumist kinnitava lingiga.
* Peab kliendi päringu peale suutma saata kõik kasutajat huvitavad andmed mida kasutaja klientprogrammi kohalikus andmebaasis veel ei ole.
* Kasutaja peab saama muuta kalendrisse lisatud task’e. Muudatused peavadilmuma teavitusena kõikide kasutajate privaatkalendritesse, kes on ennast sellele ainele/gruppi registreerinud, ning igal kasutajal on siis võimalus teavitust aktsepteerida või tagasi lükata. Teavituse aktsepteerimisel viiakse task’i muudatused kasutaja kalendrisse;
* Õppeainega/grupiga seotud taski lisamisel kalendrisse peab see ilmuma teavitusena kõikide kasutajate privaatkalendritesse, kes on ennast sellele ainele/gruppi registreerinud, ning igal kasutajal on siis võimalus teavitust aktsepteerida või tagasi lükata. Teavituse aktsepteerimisel lisatakse task’i kasutaja kalendrisse;
* Server peab logisid kõigi tehtud toimingute kohta. Administraator saab määrata logimistaseme.
* API on kättesaadav ainult üle turvalise ühenduse
* Paroolid salvestatakse kasutades juhuslikult genereeritud salt-i ning PBKDF2 algorithmi (SHA256, 100 000 iteratsiooni)
 
'''Serveri nice-to-have funktsionaalsus:'''
 
* API rate limiting
* Bayesian spam filter
* Iga kasutaja kohta iCal faili automaatne koostamine.
* Push notifications


== Projekti kirjeldus ==
== Projekti kirjeldus ==
=== Tehnoloogiad  ===
=== Tehnoloogiad  ===
*[https://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
'''DAL - Client'''
*[https://msdn.microsoft.com/en-us/library/bb397926.aspx LINQ]
*[https://www.sqlite.org/ SQLite]
*[https://github.com/StackExchange/dapper-dot-net Dapper]
 
Kliendi DAL sai otsustatud ehitada Dapperi baasil, Entity frameworki asemel. Entity framework 6-l puudub täielik SQLite tugi(näiteks tabeleid ei saa luua). Ühtlasi häirib õppimise seisukohalt EF üleliigne abstraktsioonitase - äärmiselt keeruline on aru saada, mida su programm tegelikult teeb.
 
Alguses sai Dapperi jaoks koostatud SQL päringuid, kuid kuna väga suur osa päringutest olid äärmiselt sarnased, siis sai kasutusele võetud Dapper.SimpleCRUD. Keerulisemad päringud saab vajadusel käsitsi juurde teha, kuid lokaalse andmebaasi puhul ei tohiks selleks vajadust olla.
 
By default asub sqlite andmebaas failissüsteemis %appdata%\AVE\db.sqlite3 . Seda asukohta on võimalik programmi konfiguratsioonist muuta, kuid %AppData% kasutamine võimaldab 1) Iga Windowsi kasutaja jaoks oma personaalse andmebaasi loomist. 2) Teistel kasutajatel pole ligipääsu andmebaasifailile.
 
[[File:Ave localdb.png]]
 
Kliendi kohalik sqlite andmebaas on mõeldud kasutamiseks ainult serveri andmebaasi cachena. See tähendab, et kliendi ja serveri vahelise suhtlusega on paar keerulist probleemi tarvis lahendada:
* Server peab omama vaadet tsentraalsele andmebaasile iga kasutaja perspektiivist
* Klient peab oskama küsida serverilt ainult neid uuendusi mida tal cachetud ei ole
* Klient peab suutma kontrollida oma cache vastavust serveri andembaasile
* Kui klient saadab API päringu serverisse, peab kasutajamugavuse nimel koheselt kirjutama muudatused cache-i, ning hiljem asünkroonselt serverilt negatiivse vastuse korral peab olema võimalik tehtud transaktsioon tagasi võtta, et cache ja server sünkroonist välja ei läheks.
* Mida teha juhul kui klient ei saa üldse serveriga ühendust?
 
Hetkel on meie strateegia võetud järgmine: andmebaaside vastavust kontrollitakse checksumi abil. Klient hoiab andmeid mälus, ning otse cache ei kirjutata kliendi muudatusi, cache kirjutatakse ainult serveri poolt tulevad muudatused. Serveriga ühenduse puudumisel on rakendus read-only reziimis.
 
 
'''UI - Client'''
*[https://msdn.microsoft.com/en-us/library/aa970268%28v=vs.110%29.aspx WPF]
*[https://msdn.microsoft.com/en-us/library/aa970268%28v=vs.110%29.aspx WPF]
*[https://www.sqlite.org/ SQLite]
AVE e View sisaldab vaid kujunduselemente ning nendevahelisi seoses. Kogu view'de vahetamise ja muu UI jaoks vajalik loogika on ehitaud ViewModel'isse.
*[http://www.postgresql.org/ PostgreSQL]
 
'''Autentikatsioon - Client'''
 
Kliendi kohalik autentikatsioon on mõeldud serveriga suhtlemise toetamiseks. Kohalikku andmebaasi salvestatakse kas kasutaja krüpteeritud parool või parooli räsi. Juhul kui salvestatud on parool, tähendab see, et kasutaja on valinud linnukese "jäta mind meelde", ning rakendusse sisselogimine toimub automaatselt. Vastasel juhul küsitakse kasutaja käest rakendust avades parooli, ning kohaliku räsi vastu võrreldakse seda juhul kui serveriga ühendust ei saa(rakendus on offline). Parooli hoidmise turvalisuse tõstmiseks kasutame [https://msdn.microsoft.com/en-us/library/system.security.cryptography.protecteddata%28v=vs.110%29.aspx Windows Data Protection API-t], mis kaitseb kohalikult säilitatavat parooli Windowsi kasutajahalduse vahenditega.
 
'''Server'''
*[https://azure.microsoft.com/en-us/services/app-service/web/ Azure Web App]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[https://azure.microsoft.com/en-us/ Azure]
*[https://msdn.microsoft.com/en-us/library/dd203052.aspx REST]
*[https://msdn.microsoft.com/en-us/library/dd203052.aspx REST]
Server kasutab klientidega suhtluseks RESTful apit ja JSON andmeformaati.
Algne plaan oli kasutada PostgreSQL andmebaasi, kuna see omab mitmeid eeliseid MySQL-ga võrreldes, kuid uurides hostinguvõimalusi selgus, et Microsoft pakub Dreamsparki kaudu tasuta WebAPP+MySQL hostingut õpilastele.
Selle aktiveerimiseks minna [https://azure.microsoft.com/en-us/pricing/member-offers/dreamspark-students/ https://azure.microsoft.com/en-us/pricing/member-offers/dreamspark-students/] lehele. Sisse logida oma MITTE-ITK Microsoft kontoga. Kinnitada ITK maili kaudu oma õpilase staatus, ning seejärel sisse logida Azure portaali sama kontoga. Portaalist valida Virtual Machines -> WebAPP+MySQL (ClearDB otsingusse, et leida), ning peale pisut ootamist ongi VM olemas.
Kahjuks ei toeta Dreamsparki kaudu Azure ei SSL sertifikaate, ega ka custom domeene, et oleks võimalik SSL proxy luua.
'''Autentikatsioon - Server'''
Kasutaja autentikatsioon toimub stateless auth mustrit kasutades.
Kasutaja autentimiseks saadab kasutaja oma kasutajanime ja parooli POST meetodit kasutades https://<server>/login ressursile. Server kontrollib kasutaja parooli andmebaasi salvestatud hashi vastu, ning positiivse vastuse puhul lisab expiration timestampi ning keyed HMAC_SHA256 autentikatsioonikoodi, kasutades ainult serverile teadaolevat võtit. Transpordi käigus andmete turvalisuse eest hoolitseb TLS. TLS sertifikaadi kinnitamiseks kasutame kas StartCom või Let's Encrypt tasuta teenust (tasuta Azure ei luba...welcome to 2016, Microsoft).
Arenduse käigus selgus, et C# sisseehitatud System.Security.Cryptography teek toetab PBKDF2 algoritmi (rfc2898derivebytes meetod) puhul ainult SHA-1 räsifunktsiooni, mis on vananenud. Samuti ei tundu seal olevat timing attackide kindlat baidivektorite võrdlusmeetodit. Hetkel kuna turvanõuded rakendusele on suhteliselt madalad, on tegu aktsepteeritava riskiga, kuid mingi tegeliku programmi loomisel tuleks kindlasti kasutada alternatiive, näiteks libsodium-net.
Vastuseks saadud tokeni salvestab klientprogramm endale mällu, ning lisab hiljem igale API requestile. Konkreetne meetod pole oluline, aga kasutame X-Authentication headerit ja serialiseerime JSON objekti Base64 kodeeringuga.
Antud skeemi eelis on, et server ei pea arvet pidama aktiivsete sessioonide üle, vaid kontrollib lihtsalt HMAC vastavust ning kasutab tokenis olevat infot. Kriitiline on serveri võtit turvaliselt säilitada. Ideaalne oleks serveri võtme salvestamiseks kasutada TPM moodulit, kuid kasutades odavaid hostinguteenuseid ei ole see võimalik - võtit tuleb hoida failisüsteemis, ning võtmefailile peavad olema minimaalsed ligipääsuõigused.
Skeem on sarnane JSON Web Token skeemile ([https://tools.ietf.org/html/rfc7519 RFC 7519])
Kasutaja loomisel saadab server kasutaja sisestatud mailiaadressile kinnituskirja, kus kasutaja peab klikkima lingil, et oma kasutaja kinnitada. Antud lingi jaoks kasutatakse samuti stateless auth mustrit, serialiseeritud ja serveri poolt allkirjastatud andmed on URL-i parameeter.
E-kirja saatmiseks kasutab server Mailgun teenust, kuna ise oma serverist kirju saates on äärmiselt suur tõenäosus, et need jäävad spämmifiltritesse kinni(SenderScore, jne).


=== Arendusmustrid  ===
=== Arendusmustrid  ===
*[https://msdn.microsoft.com/en-us/library/hh848246.aspx MVVM]
*[http://social.technet.microsoft.com/wiki/contents/articles/13536.easy-mvvm-examples-in-extreme-detail.aspx MVVM][https://msdn.microsoft.com/en-us/library/gg405484(v=pandp.40).aspx]


=== Versioonikontroll ===
=== Versioonikontroll ===
*[https://msdn.microsoft.com/en-us/library/ms181237.aspx Team Foundation]
*[https://msdn.microsoft.com/en-us/library/ms181237.aspx Team Foundation]
Versioonikontrolli kasutuse käigus ilmnes Visual Studio viga/tegemata töö: NuGet packageid solutionisse lisades pidid teised kasutajad pakettide tööle saamiseks endal kohalikult (solution)\packages\ kataloogi enne buildi ära kustutama. Selle vea paranduseks on tarvis lisada solutioni kataloogi .tfignore fail sisuga
\packages
ja .nuget\NuGet.config fail sisuga:
<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <solution>
    <add key="disableSourceControlIntegration" value="true" />
  </solution>
</configuration>
Seejärel Source code explorer aknast serveri versioon packages kataloogist ära kustutada. Edaspidi ei laeta packages kataloogi versioonikontrolli, ning NuGet automatic restore saab automaatselt vajalikud paketid buildides taastatud.
=== API kirjeldus ja dokumentatsioon ===
*[https://apiblueprint.org/ Api Blueprint]
*[https://apiary.io/ Apiary]
*[https://github.com/apiaryio/dredd/ Dredd]
Api kirjeldus asub aadressil [http://docs.ave.apiary.io/ http://docs.ave.apiary.io/]
WCF genereerib ilusti ka ise koodi põhjal API dokumentatsiooni. See on plaanis kasutusele võtta hiljem, kui serveri kood on valmis, ning server on avalikult online.


=== Koodi stiilireeglid ===
=== Koodi stiilireeglid ===
*[https://visualstudiogallery.msdn.microsoft.com/cac2a05b-6eb6-4fa2-95b9-1f8d011e6cae StyleCop]
*[https://visualstudiogallery.msdn.microsoft.com/cac2a05b-6eb6-4fa2-95b9-1f8d011e6cae StyleCop]
Otsustasime, et kogu programmi kood, muutujanimed ja koodi kommentaarid on ingliskeelsed.
Muutujanimedel kasutame järgmiseid reegleid:
* Klassi privaatmuutujad algavad _ prefiksiga;
* Klassi avalikud meetodid ja muutujad algavad suurtähega;
* Kõik muud muutujad algavad väiketähega;
Kõik muutujanimed peavad sisaldama ainult US-ASCII tähti või numbreid ( ^[a-zA-Z0-9]+$ ). Liigendamiseks on suurtähed.
Muutujad peavad võimalikult täpselt kirjeldama oma sisu abstraktsel tasemel. Erandiks on meetodi- ja funktsioonisisesed muutujad millede sisu on kontekstist lihtsalt tuletatav. Näiteks "i" tsükliloendurina jne.
Muutujanimed ei tohi sisaldada tüübiviidet.
"Maagilised" muutujad peavad olema deklareeritud konstantidena, ning omama kommentaari. Kõiki selliseid muutujaid peab olema võimalik programmi konfiguratsioonifailist muuta.


=== Litsents ===
=== Litsents ===
Kogu rakendus avaldatakse GNU General Public License v3.0 all. [http://www.gnu.org/licenses/gpl-3.0.en.html (GPL)]
Rakenduse dokumentatsioon avaldatakse ITK Wikis, järgides ITK Wiki litsentsitingimusi.


== Avaldatud failid ==
== Avaldatud failid ==
*[https://pilv.mana.ee/public.php?service=files&t=edaa0cf40fb840ba7a620d4c0252b49e Andmebaasi Skeem (DBDesigner) ]
*[https://pilv.mana.ee/public.php?service=files&t=0e79ef0570f39b8743f046c70f724404 Rakenduse esimene prototüüp (13.12.2015)]
*[https://pilv.mana.ee/public.php?service=files&t=00ce781b71759d6f66017ad40dc81901 Rakenduse Server (20.01.2016)]
*[https://pilv.mana.ee/public.php?service=files&t=dd72ab32e4900f3970d484317c94a94c Rakenduse Klient (20.01.2016)]


== Arendusprotsess ==
== Arendusprotsess ==


*'''8.10.2015''' - Loodud wiki leht ja lepitud kokku esimene kohtumine idee leidmiseks ja algseks analüüsiks.
*'''08.10.2015'''   - Loodud wiki leht ja lepitud kokku esimene kohtumine idee leidmiseks ja algseks analüüsiks.
*'''19.10.2015''' - Esimene kohtumine. Leitud idee rakenduse loomiseks, määratud rollid esimeseks analüüsietapiks.
*'''19.10.2015'''   - Esimene kohtumine. Leitud idee rakenduse loomiseks, määratud rollid esimeseks analüüsietapiks.
*'''01.11.2015'''    - Teine kohtumine. Valmis analüüs.
*'''06.11.2015'''    - Lisatud retsensioon meeskonnale Premium.
*'''11.11.2015'''    - Esimene tõmmis kasutajaliidesest TFS-is
*'''12.11.2015'''    - Loodud esialgne API kirjeldus, vajab veel täiendamist arenduse käigus
*'''15.11.2015'''    - Loodud kliendi kohaliku andmebaasi skeem
*'''17.11.2015'''    - Kolmas kohtumine, lepitud kokku ajad mil koos koodi kirjutada. Ühtlasi loodud rakenduse kihtide skeem.
*'''21.11.2015'''    - Koos koodi kirjutatud pisut. Kasutajaliides hakkas asju tegema, API server vastab käskudele.
*'''28.11.2015'''    - Algselt MSSQL+EF kliendi DAL migreeritud SQLite+Dapper lahendusele.
*'''30.11.2015'''    - Rakendust esitletud C# praktikumis.
*'''31.11.2015'''    - Neljas kohtumine, lepitud kokku ülesannete jaotus ja arenduskava järgmiseks nädalaks.
*'''04.12.2015'''    - Konsultatsioon õppejõuga.
*'''10-13.12.2015''' - Viies kohtumine ja rakenduse arendamine.
*'''11.12.2015'''    - Prototüübi esimese versiooni lisamine Wiki lehele.
*'''13.12.2015'''    - Prototüübi teise versiooni lisamine Wiki lehele.
*'''20.12.2015'''    - Lisatud prototüübi retsensioon meeskonnale Fontastic
*'''19-20.01.2016'''    - Viimane arendussprint.
*'''20.01.2016'''    - Lisatud lõpptoote kirjeldus ja ülevaade tehtud tööst.


== Lisad ==
== Lisad ==


[https://www.youtube.com/watch?v=XTgFtxHhCQ0]
[https://www.youtube.com/watch?v=XTgFtxHhCQ0]
== Prototüüp ==
Prototüüp peab võimaldama kasutajal sisestada taski, siduda see ainega ja vajadusel grupiga ning lisada lubatud atribuudid. Lisatud taske kuvatakse detailvaates (selleks tuleb vajutada taski nimetusele).
Aplikatsiooni prototüüp .zip faili saab alla laadida siit[https://pilv.mana.ee/public.php?service=files&t=578d80969704c7be250b10406877ca74&path=%2FAVE&files=AVE_proto20151213.zip&download]
'''Kliendi prototüübi funktsionaalsus:'''
* Kasutaja saab sisestada taski kirjeldust (taski) koos esitamise tähtajaga oma kalendrisse;
* Kasutaja saab taski kirjeldusena märkida:
** Task'i täitmise tähtaja;
** Taskiga seotud õppeaine ettantud nimekirjast;
** Taskiga seotud grupi;
** soovi korral kommentaariväljale lisainfot, viidet õppematerjalidele jne.
* Kalendrivaates kuvatakse kuupäeva järgi sorteeritud taskid. Taskile vajutades avaneb taski detailvaade;
* Vajutades taski nimetusele tehakse päring lokaalsesse baasi ning kuvatakse taski detailandmed koos võimalusega taski muuta või kustutada;
*Kasutaja saab sisestatud taski andmeid muuta ja taski kustutada;
* Rakendus töötab offline režiimis.
'''Andmebaas'''
- by default asub sqlite andmebaas failissüsteemis %appdata%\AVE\db.sqlite3 . Seda asukohta on võimalik programmi konfiguratsioonist muuta, kuid %AppData% kasutamine võimaldab 1) Iga Windowsi kasutaja jaoks oma personaalse andmebaasi loomist. 2) Teistel kasutajatel pole ligipääsu andmebaasifailile.
'''Serveri''' poolelt ei ole hetkel veel midagi tehtud(töötab API Hello World tasemel). Prototüüp on hetkel ainult kohaliku kasutusega.
'''Senine tööjaotus'''
* Kärt Palm - BLL (BO ja Service) ja praeguseks oluliselt muudetud DAL (esialgu realiseeritud DAL Entity frameworki'l sai muudetud, et tagada SQlite tugi);
* Karina Egipt - View, ViewModel;
* Silver Saks - Lokaalne andmebaas, Server;
== Lõpptoode ==
'''Kommentaarid'''
Arenduse käigus selgus, et olime endale seadnud pisut liiga ambitsioonika eesmärgi. Lõpptoode täidab umbes pooled meie seatud funktsionaalsetest nõuetest, kuid kindlasti ei ole tegu sellise rakendusega nagu me oma analüüsi tulemusena ette kujutasime. Leiame, et tegu on aine seisukohalt õnnestunud tööga, kuna kasutasime kõiki aine omandamiseks vajalikke tehnoloogiad ning arendusmustreid. Töö tulemusena õppisime kõik väga palju nii C#, OOP programmeerimise, kui ka meeskonnatööna valmivate programmeerimisprojektide kohta.
'''Lõpptoote kirjeldus'''
Juhul kui soovitakse rakenduse serverit testida Visual Studios, siis täieliku funktsionaalsuse saavutamiseks tuleb web.config failis asendada andmebaasi connectionstring mingi muuga. Kasutusel on MySQL andmebaas, kuid ka muud andmebaasid peaks töötama, selleks tuleb ainult vahetada SimpleCRUD.Dialect väärtus koodis. Connectionstringi kustutasin, kuna server on publishitud ja töötab Azure pilveteenuses, ning connectionstringis olid minu isiklikud paroolid.
Klient peaks töötama kohalikus arvutis täielikult ja automaatselt. Esimese sammuna tuleb endale kasutaja luua, ning seejärel loodud kasutajaga sisse logida. Passwordi kastides ei saa kasutada backspace ega delete nuppe, kuna need on lahendatud aja puuduse tõttu pisut ebakorrektselt. Ainus info mis hetkel serverist tuleb on õppeainete nimekiri. Programmi kasutamist on kirjeldatud ka kasutusjuhendis.
'''NB! Serveriga suhtlus registreerimisel/sisse logimisel võib aeglane olla, kuna Azure teeb automaatse shutdowni tasuta virtuaalmasinatele kui x aega pole kasutatud.'''
'''Arenduse käigus tekkinud probleemid'''
WPF ja MVVM olid ise õppimiseks väga keerulised, kindlasti tuleks koolis praktikatundides nende õpetamisele rohkem rõhku panna.
'''Mida oleks võinud teistmoodi teha'''
*Antud rakenduse realiseerimiseks oleks täielikult veebirakenduse tegemine olnud parem lahendus.
*WPF rakendamiseks oleks võinud kasutada mingit valmis raamistikku, näiteks [http://caliburnmicro.com/ Caliburn Micro] või [http://www.mvvmlight.net/ MVVM Light Toolkit]
'''Tööjaotus'''
* Kärt Palm - Rakenduse kliendi äriloogika
* Karina Egipt - Rakenduse kliendi kasutajaliides
* Silver Saks - Andmebaasidega suhtlus, server ja serveriga ühenduvus
* Erika Ehmann - Rakenduse kliendi kasutajaliides sisselogimiseks ja registreerimiseks, ning ainete otsing
'''Failid'''
*[https://pilv.mana.ee/public.php?service=files&t=00ce781b71759d6f66017ad40dc81901 Rakenduse Server (20.01.2016)]
*[https://pilv.mana.ee/public.php?service=files&t=dd72ab32e4900f3970d484317c94a94c Rakenduse Klient (20.01.2016)]
*[https://pilv.mana.ee/public.php?service=files&t=a4d3d913c6a56037e71688be767d8800 Rakenduse Kasutusjuhend]

Latest revision as of 18:09, 30 January 2016

Meeskond ja rollid

  • Kärt Palm
  • Karina Egipt - Projektijuht
  • Erika Ehmann
  • Silver Saks - Wiki pidaja

Idee

TODO list kooli õppeainete tarvis. Võimaldab märkida kalendrisse tähtaegu, mis on seotud õppeainega ja lisada nende kohta vajalikku infot(eeldatav ajakulu, ülesande maht, õppematerjalid, jne). Offline funktsionaalsus kohaliku andmebaasiga, mis replikeeritakse serverisse(kasutaja soovil). Online funktsionaalsus mis võimaldab "subscribeda" kas teatud õppeainesse, või gruppi. Sellisel juhul ilmuvad kalendrisse ka teiste antud grupis olevate kasutajate lisatud ülesanded, ning info nende kohta.

Analüüs

AVE 2.0 on kodutööde planeerimise rakendus, kuhu iga kasutaja saab lisada õppeaines antud kodutöid, lisada neile esitamise tähtaegu ja muud lisainformatsiooni.

Mõisted

  • Task - ülesanne, test, eksam, mille kasutaja kannab kalendrisse ja määrab vähemalt kohustuslikud atribuudid. Task'il saab olla vaid üks tähtaeg;
  • Alamtask - task, mis on osa suuremast tööst (kuulub mingi taski alla) ning millele saab määrata omaette atribuute;
  • Atribuut - task'i omadused (näiteks: tähtaeg, kirjeldus, kommentaarid, viited jne);
  • Õppeaine - Taske grupeeriv atribuut;
  • Grupp - Taske grupeeriv atribuut, mis on ülem õppeainest (ehk kui grupp on määratud, siis pakutakse antud taski ainult selle grupi liikmetele). Grupp võib eksisteerida ka ilma õppeaineta;
  • Subscribe - õppeainega, grupiga või task'iga liitumine, mille tulemusena ilmub vastava aine/grupi task'id kasutaja kalendrisse;

Rakenduse kirjeldus

Rakenduse eesmärgiks on hõlbustada kodutööde planeerimist ja tähtaegade järgimist. Rakendusse saab lisada kodutööde, testide ja eksamite tähtaegu. Sisestatud töid nimetame taskideks. Taskid võivad omakorda sisaldada muud antud ülesandega seotud infot (alamtähtajad, kommentaarid jne).

Rakendus on põhiliselt mõeldud IT Kolledži õppeainete tähtaegade märkimiseks. Sellel eesmärgil on tähtaja juurde võimalik märkida õppeaine Info õppeainete kohta tuleb importida kooli õppeinfosüsteemidest.

Rakenduse kasutamiseks on kohustuslik serveris konto loomine. Anonüümset offline kasutust ei ole.

Kasutaja saab ära märkida oma kooli(d) ja deklareeritud õppeained. Õppeainetele subscribe'ides saab kasutaja märkida ka oma õppegrupi või õppevormi (näiteks päevaõpe, kaugõpe, õhtuõpe - neid nimetame koondnimetusena “õppeaine versiooniks”). Kasutaja saab luua ka eraldiseisvaid õppetööga seotud või mitteseotud gruppe.

Rakendus pakub kasutajale ka teiste antud aine deklareerinud kasutajate poolt märgitud tähtaegu ja lisainfot nende kohta. Kasutajale pakutakse automaatselt see versioon taskist, mis hetkel on kasutajate hulgas kõige populaarsem. Kasutaja võib selle tagasi lükata, kui task teda ei huvita, või võtta vastu mõne muu versiooni taskist. Kasutaja võib teiste lisatud taskile ka ise atribuute lisada, mis juhul neid muudatusi pakutakse ka teistele kasutajatele.

Rakendus koosneb kahest põhilisest osast: klient ja server.

Klient

Klientprogramm võimaldab kasutajal lisada taske, hallata oma kasutajaprofiili ja vaadata ning lisada endale teiste poolt lisatud taske ja nende atribuute.

Klient suhtleb serveriga üle REST API.

Klient hoiab lokaalselt andmeid SQLite andmebaasis, sinna replikeeritakse ka teiste kasutajate poolt lisatud muutused juhul kui kasutaja need aktsepteerib.

Klient peab oskama API kaudu küsida serverist teda huvitavaid värskendusi ehk klient peab pidama arvet selle üle milline osa infost tal on kohalikus andmebaasis olemas.

Rakendust käivitades küsitakse kasutajalt kasutajanime ja parooli, seejärel rakendus käivitub, kuvab antud kasutaja töölaua, ning üritab autentida ja sünkroniseerida serveriga.

Task'i lisamisel kalendrisse saab sellele lisada erinevat lisainfot sisaldavaid atribuute (vahetähtajad, töö detailsed nõuded, progress jmt). Rakendus hoiatab kasutajat, kui task'i täitmise tähtaeg on lähenemas.

Kliendi must-have funktsionaalsus:

  • Peab olema võimalik kasutajaks registreerida (kasutajakonto olemsolu on kohustuslik programmi kasutamiseks);
  • Kasutaja peab saama sisse logida kasutajanime ja parooliga;
  • Kasutaja peab saama registreerida ennast gruppidesse ja/või erinevate õppeainetele/kursustele;
  • Kasutaja peab saama sisestada taski kirjeldust (taski) koos esitamise tähtajaga oma kalendrisse;
  • Kasutaja peab saama taski kirjeldusena märkida:
    • Task'i täitmise tähtaega;
    • Task'i liiki : ainetöö, essee, kursusetöö, lõputöö, referaat, praktika aruanne, eksam, test, muu;
    • Taskiga seotud õppeaine ettantud nimekirjast;
    • Taskiga seotud grupi. Kui grupp on valitud, siis edastatakse task vaid grupi liikmetele
    • soovi korral kommentaariväljale lisainfot, viidet õppematerjalidele jne;
    • aja, millal rakendus teavitab kasutajat tähtaja lähenemisest (vabatahtlik, vaikimisi 3 päeva enne);
    • kas task on alustamata, pooleli või lõpetatud (st taski staatust)
  • Rakendus peab töötama nii online kui offline režiimis. Vaikimisi režiimiks on online, offline saab olla eelkõige ainult siis, kui arvuti ei ole internetiga ühendatud. Kui rakendus on offline, siis kajastub kasutajaliideses vastav teade;
  • Kasutaja peab saama muuta kalendrisse lisatud task’e. Muudatused peavadilmuma teavitusena kõikide kasutajate privaatkalendritesse, kes on ennast sellele ainele/gruppi registreerinud, ning igal kasutajal on siis võimalus teavitust aktsepteerida või tagasi lükata. Teavituse aktsepteerimisel viiakse task’i muudatused kasutaja kalendrisse;

Kliendi nice-to-have funktsionaalsus:

  • Statistika tehtud ülesannete kohta.
  • Kasutajakonto loomisel CAPTCHA kasutamine
  • Lokaalse andmebaasi krüpteerimine kasutaja parooli baasil

Server

Serveris toimub kasutajate haldus ja kõikide kasutajate poolt sisestatud info talletamine. Serveri põhiline ülesanne on vastavalt API käskudele andmebaasist andmete esitamine.

Serveris asub tsentraalne andmebaas kogu rakenduse infoga(kõik task'id, nende atribuudid, jne). Kasutame PostgreSQL andmebaasi.

Suhtlus kliendi ja serveri vahel toimub üle REST api.

Andmebaasi skeem:

Serveri must-have funktsionaalsus:

  • Peab võimaldama suhtlust kliendi ja andmebaasi vahel
  • Registreerumisel saadetakse kasutajale e-mail registreerumist kinnitava lingiga.
  • Peab kliendi päringu peale suutma saata kõik kasutajat huvitavad andmed mida kasutaja klientprogrammi kohalikus andmebaasis veel ei ole.
  • Kasutaja peab saama muuta kalendrisse lisatud task’e. Muudatused peavadilmuma teavitusena kõikide kasutajate privaatkalendritesse, kes on ennast sellele ainele/gruppi registreerinud, ning igal kasutajal on siis võimalus teavitust aktsepteerida või tagasi lükata. Teavituse aktsepteerimisel viiakse task’i muudatused kasutaja kalendrisse;
  • Õppeainega/grupiga seotud taski lisamisel kalendrisse peab see ilmuma teavitusena kõikide kasutajate privaatkalendritesse, kes on ennast sellele ainele/gruppi registreerinud, ning igal kasutajal on siis võimalus teavitust aktsepteerida või tagasi lükata. Teavituse aktsepteerimisel lisatakse task’i kasutaja kalendrisse;
  • Server peab logisid kõigi tehtud toimingute kohta. Administraator saab määrata logimistaseme.
  • API on kättesaadav ainult üle turvalise ühenduse
  • Paroolid salvestatakse kasutades juhuslikult genereeritud salt-i ning PBKDF2 algorithmi (SHA256, 100 000 iteratsiooni)

Serveri nice-to-have funktsionaalsus:

  • API rate limiting
  • Bayesian spam filter
  • Iga kasutaja kohta iCal faili automaatne koostamine.
  • Push notifications

Projekti kirjeldus

Tehnoloogiad

DAL - Client

Kliendi DAL sai otsustatud ehitada Dapperi baasil, Entity frameworki asemel. Entity framework 6-l puudub täielik SQLite tugi(näiteks tabeleid ei saa luua). Ühtlasi häirib õppimise seisukohalt EF üleliigne abstraktsioonitase - äärmiselt keeruline on aru saada, mida su programm tegelikult teeb.

Alguses sai Dapperi jaoks koostatud SQL päringuid, kuid kuna väga suur osa päringutest olid äärmiselt sarnased, siis sai kasutusele võetud Dapper.SimpleCRUD. Keerulisemad päringud saab vajadusel käsitsi juurde teha, kuid lokaalse andmebaasi puhul ei tohiks selleks vajadust olla.

By default asub sqlite andmebaas failissüsteemis %appdata%\AVE\db.sqlite3 . Seda asukohta on võimalik programmi konfiguratsioonist muuta, kuid %AppData% kasutamine võimaldab 1) Iga Windowsi kasutaja jaoks oma personaalse andmebaasi loomist. 2) Teistel kasutajatel pole ligipääsu andmebaasifailile.

Kliendi kohalik sqlite andmebaas on mõeldud kasutamiseks ainult serveri andmebaasi cachena. See tähendab, et kliendi ja serveri vahelise suhtlusega on paar keerulist probleemi tarvis lahendada:

  • Server peab omama vaadet tsentraalsele andmebaasile iga kasutaja perspektiivist
  • Klient peab oskama küsida serverilt ainult neid uuendusi mida tal cachetud ei ole
  • Klient peab suutma kontrollida oma cache vastavust serveri andembaasile
  • Kui klient saadab API päringu serverisse, peab kasutajamugavuse nimel koheselt kirjutama muudatused cache-i, ning hiljem asünkroonselt serverilt negatiivse vastuse korral peab olema võimalik tehtud transaktsioon tagasi võtta, et cache ja server sünkroonist välja ei läheks.
  • Mida teha juhul kui klient ei saa üldse serveriga ühendust?

Hetkel on meie strateegia võetud järgmine: andmebaaside vastavust kontrollitakse checksumi abil. Klient hoiab andmeid mälus, ning otse cache ei kirjutata kliendi muudatusi, cache kirjutatakse ainult serveri poolt tulevad muudatused. Serveriga ühenduse puudumisel on rakendus read-only reziimis.


UI - Client

AVE e View sisaldab vaid kujunduselemente ning nendevahelisi seoses. Kogu view'de vahetamise ja muu UI jaoks vajalik loogika on ehitaud ViewModel'isse.

Autentikatsioon - Client

Kliendi kohalik autentikatsioon on mõeldud serveriga suhtlemise toetamiseks. Kohalikku andmebaasi salvestatakse kas kasutaja krüpteeritud parool või parooli räsi. Juhul kui salvestatud on parool, tähendab see, et kasutaja on valinud linnukese "jäta mind meelde", ning rakendusse sisselogimine toimub automaatselt. Vastasel juhul küsitakse kasutaja käest rakendust avades parooli, ning kohaliku räsi vastu võrreldakse seda juhul kui serveriga ühendust ei saa(rakendus on offline). Parooli hoidmise turvalisuse tõstmiseks kasutame Windows Data Protection API-t, mis kaitseb kohalikult säilitatavat parooli Windowsi kasutajahalduse vahenditega.

Server

Server kasutab klientidega suhtluseks RESTful apit ja JSON andmeformaati.

Algne plaan oli kasutada PostgreSQL andmebaasi, kuna see omab mitmeid eeliseid MySQL-ga võrreldes, kuid uurides hostinguvõimalusi selgus, et Microsoft pakub Dreamsparki kaudu tasuta WebAPP+MySQL hostingut õpilastele.

Selle aktiveerimiseks minna https://azure.microsoft.com/en-us/pricing/member-offers/dreamspark-students/ lehele. Sisse logida oma MITTE-ITK Microsoft kontoga. Kinnitada ITK maili kaudu oma õpilase staatus, ning seejärel sisse logida Azure portaali sama kontoga. Portaalist valida Virtual Machines -> WebAPP+MySQL (ClearDB otsingusse, et leida), ning peale pisut ootamist ongi VM olemas.

Kahjuks ei toeta Dreamsparki kaudu Azure ei SSL sertifikaate, ega ka custom domeene, et oleks võimalik SSL proxy luua.

Autentikatsioon - Server

Kasutaja autentikatsioon toimub stateless auth mustrit kasutades.

Kasutaja autentimiseks saadab kasutaja oma kasutajanime ja parooli POST meetodit kasutades https://<server>/login ressursile. Server kontrollib kasutaja parooli andmebaasi salvestatud hashi vastu, ning positiivse vastuse puhul lisab expiration timestampi ning keyed HMAC_SHA256 autentikatsioonikoodi, kasutades ainult serverile teadaolevat võtit. Transpordi käigus andmete turvalisuse eest hoolitseb TLS. TLS sertifikaadi kinnitamiseks kasutame kas StartCom või Let's Encrypt tasuta teenust (tasuta Azure ei luba...welcome to 2016, Microsoft).

Arenduse käigus selgus, et C# sisseehitatud System.Security.Cryptography teek toetab PBKDF2 algoritmi (rfc2898derivebytes meetod) puhul ainult SHA-1 räsifunktsiooni, mis on vananenud. Samuti ei tundu seal olevat timing attackide kindlat baidivektorite võrdlusmeetodit. Hetkel kuna turvanõuded rakendusele on suhteliselt madalad, on tegu aktsepteeritava riskiga, kuid mingi tegeliku programmi loomisel tuleks kindlasti kasutada alternatiive, näiteks libsodium-net.

Vastuseks saadud tokeni salvestab klientprogramm endale mällu, ning lisab hiljem igale API requestile. Konkreetne meetod pole oluline, aga kasutame X-Authentication headerit ja serialiseerime JSON objekti Base64 kodeeringuga.

Antud skeemi eelis on, et server ei pea arvet pidama aktiivsete sessioonide üle, vaid kontrollib lihtsalt HMAC vastavust ning kasutab tokenis olevat infot. Kriitiline on serveri võtit turvaliselt säilitada. Ideaalne oleks serveri võtme salvestamiseks kasutada TPM moodulit, kuid kasutades odavaid hostinguteenuseid ei ole see võimalik - võtit tuleb hoida failisüsteemis, ning võtmefailile peavad olema minimaalsed ligipääsuõigused.

Skeem on sarnane JSON Web Token skeemile (RFC 7519)

Kasutaja loomisel saadab server kasutaja sisestatud mailiaadressile kinnituskirja, kus kasutaja peab klikkima lingil, et oma kasutaja kinnitada. Antud lingi jaoks kasutatakse samuti stateless auth mustrit, serialiseeritud ja serveri poolt allkirjastatud andmed on URL-i parameeter.

E-kirja saatmiseks kasutab server Mailgun teenust, kuna ise oma serverist kirju saates on äärmiselt suur tõenäosus, et need jäävad spämmifiltritesse kinni(SenderScore, jne).

Arendusmustrid

Versioonikontroll

Versioonikontrolli kasutuse käigus ilmnes Visual Studio viga/tegemata töö: NuGet packageid solutionisse lisades pidid teised kasutajad pakettide tööle saamiseks endal kohalikult (solution)\packages\ kataloogi enne buildi ära kustutama. Selle vea paranduseks on tarvis lisada solutioni kataloogi .tfignore fail sisuga 

\packages

ja .nuget\NuGet.config fail sisuga: 

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <solution>
    <add key="disableSourceControlIntegration" value="true" />
  </solution>
</configuration>

Seejärel Source code explorer aknast serveri versioon packages kataloogist ära kustutada. Edaspidi ei laeta packages kataloogi versioonikontrolli, ning NuGet automatic restore saab automaatselt vajalikud paketid buildides taastatud.

API kirjeldus ja dokumentatsioon

Api kirjeldus asub aadressil http://docs.ave.apiary.io/ WCF genereerib ilusti ka ise koodi põhjal API dokumentatsiooni. See on plaanis kasutusele võtta hiljem, kui serveri kood on valmis, ning server on avalikult online.

Koodi stiilireeglid

Otsustasime, et kogu programmi kood, muutujanimed ja koodi kommentaarid on ingliskeelsed. Muutujanimedel kasutame järgmiseid reegleid:

  • Klassi privaatmuutujad algavad _ prefiksiga;
  • Klassi avalikud meetodid ja muutujad algavad suurtähega;
  • Kõik muud muutujad algavad väiketähega;

Kõik muutujanimed peavad sisaldama ainult US-ASCII tähti või numbreid ( ^[a-zA-Z0-9]+$ ). Liigendamiseks on suurtähed.

Muutujad peavad võimalikult täpselt kirjeldama oma sisu abstraktsel tasemel. Erandiks on meetodi- ja funktsioonisisesed muutujad millede sisu on kontekstist lihtsalt tuletatav. Näiteks "i" tsükliloendurina jne.

Muutujanimed ei tohi sisaldada tüübiviidet.

"Maagilised" muutujad peavad olema deklareeritud konstantidena, ning omama kommentaari. Kõiki selliseid muutujaid peab olema võimalik programmi konfiguratsioonifailist muuta.

Litsents

Kogu rakendus avaldatakse GNU General Public License v3.0 all. (GPL) Rakenduse dokumentatsioon avaldatakse ITK Wikis, järgides ITK Wiki litsentsitingimusi.

Avaldatud failid

Arendusprotsess

  • 08.10.2015 - Loodud wiki leht ja lepitud kokku esimene kohtumine idee leidmiseks ja algseks analüüsiks.
  • 19.10.2015 - Esimene kohtumine. Leitud idee rakenduse loomiseks, määratud rollid esimeseks analüüsietapiks.
  • 01.11.2015 - Teine kohtumine. Valmis analüüs.
  • 06.11.2015 - Lisatud retsensioon meeskonnale Premium.
  • 11.11.2015 - Esimene tõmmis kasutajaliidesest TFS-is
  • 12.11.2015 - Loodud esialgne API kirjeldus, vajab veel täiendamist arenduse käigus
  • 15.11.2015 - Loodud kliendi kohaliku andmebaasi skeem
  • 17.11.2015 - Kolmas kohtumine, lepitud kokku ajad mil koos koodi kirjutada. Ühtlasi loodud rakenduse kihtide skeem.
  • 21.11.2015 - Koos koodi kirjutatud pisut. Kasutajaliides hakkas asju tegema, API server vastab käskudele.
  • 28.11.2015 - Algselt MSSQL+EF kliendi DAL migreeritud SQLite+Dapper lahendusele.
  • 30.11.2015 - Rakendust esitletud C# praktikumis.
  • 31.11.2015 - Neljas kohtumine, lepitud kokku ülesannete jaotus ja arenduskava järgmiseks nädalaks.
  • 04.12.2015 - Konsultatsioon õppejõuga.
  • 10-13.12.2015 - Viies kohtumine ja rakenduse arendamine.
  • 11.12.2015 - Prototüübi esimese versiooni lisamine Wiki lehele.
  • 13.12.2015 - Prototüübi teise versiooni lisamine Wiki lehele.
  • 20.12.2015 - Lisatud prototüübi retsensioon meeskonnale Fontastic
  • 19-20.01.2016 - Viimane arendussprint.
  • 20.01.2016 - Lisatud lõpptoote kirjeldus ja ülevaade tehtud tööst.

Lisad

[2]

Prototüüp

Prototüüp peab võimaldama kasutajal sisestada taski, siduda see ainega ja vajadusel grupiga ning lisada lubatud atribuudid. Lisatud taske kuvatakse detailvaates (selleks tuleb vajutada taski nimetusele). Aplikatsiooni prototüüp .zip faili saab alla laadida siit[3]

Kliendi prototüübi funktsionaalsus:

  • Kasutaja saab sisestada taski kirjeldust (taski) koos esitamise tähtajaga oma kalendrisse;
  • Kasutaja saab taski kirjeldusena märkida:
    • Task'i täitmise tähtaja;
    • Taskiga seotud õppeaine ettantud nimekirjast;
    • Taskiga seotud grupi;
    • soovi korral kommentaariväljale lisainfot, viidet õppematerjalidele jne.
  • Kalendrivaates kuvatakse kuupäeva järgi sorteeritud taskid. Taskile vajutades avaneb taski detailvaade;
  • Vajutades taski nimetusele tehakse päring lokaalsesse baasi ning kuvatakse taski detailandmed koos võimalusega taski muuta või kustutada;
  • Kasutaja saab sisestatud taski andmeid muuta ja taski kustutada;
  • Rakendus töötab offline režiimis.

Andmebaas - by default asub sqlite andmebaas failissüsteemis %appdata%\AVE\db.sqlite3 . Seda asukohta on võimalik programmi konfiguratsioonist muuta, kuid %AppData% kasutamine võimaldab 1) Iga Windowsi kasutaja jaoks oma personaalse andmebaasi loomist. 2) Teistel kasutajatel pole ligipääsu andmebaasifailile.

Serveri poolelt ei ole hetkel veel midagi tehtud(töötab API Hello World tasemel). Prototüüp on hetkel ainult kohaliku kasutusega.

Senine tööjaotus

  • Kärt Palm - BLL (BO ja Service) ja praeguseks oluliselt muudetud DAL (esialgu realiseeritud DAL Entity frameworki'l sai muudetud, et tagada SQlite tugi);
  • Karina Egipt - View, ViewModel;
  • Silver Saks - Lokaalne andmebaas, Server;

Lõpptoode

Kommentaarid

Arenduse käigus selgus, et olime endale seadnud pisut liiga ambitsioonika eesmärgi. Lõpptoode täidab umbes pooled meie seatud funktsionaalsetest nõuetest, kuid kindlasti ei ole tegu sellise rakendusega nagu me oma analüüsi tulemusena ette kujutasime. Leiame, et tegu on aine seisukohalt õnnestunud tööga, kuna kasutasime kõiki aine omandamiseks vajalikke tehnoloogiad ning arendusmustreid. Töö tulemusena õppisime kõik väga palju nii C#, OOP programmeerimise, kui ka meeskonnatööna valmivate programmeerimisprojektide kohta.

Lõpptoote kirjeldus

Juhul kui soovitakse rakenduse serverit testida Visual Studios, siis täieliku funktsionaalsuse saavutamiseks tuleb web.config failis asendada andmebaasi connectionstring mingi muuga. Kasutusel on MySQL andmebaas, kuid ka muud andmebaasid peaks töötama, selleks tuleb ainult vahetada SimpleCRUD.Dialect väärtus koodis. Connectionstringi kustutasin, kuna server on publishitud ja töötab Azure pilveteenuses, ning connectionstringis olid minu isiklikud paroolid.

Klient peaks töötama kohalikus arvutis täielikult ja automaatselt. Esimese sammuna tuleb endale kasutaja luua, ning seejärel loodud kasutajaga sisse logida. Passwordi kastides ei saa kasutada backspace ega delete nuppe, kuna need on lahendatud aja puuduse tõttu pisut ebakorrektselt. Ainus info mis hetkel serverist tuleb on õppeainete nimekiri. Programmi kasutamist on kirjeldatud ka kasutusjuhendis.

NB! Serveriga suhtlus registreerimisel/sisse logimisel võib aeglane olla, kuna Azure teeb automaatse shutdowni tasuta virtuaalmasinatele kui x aega pole kasutatud.

Arenduse käigus tekkinud probleemid

WPF ja MVVM olid ise õppimiseks väga keerulised, kindlasti tuleks koolis praktikatundides nende õpetamisele rohkem rõhku panna.

Mida oleks võinud teistmoodi teha

  • Antud rakenduse realiseerimiseks oleks täielikult veebirakenduse tegemine olnud parem lahendus.
  • WPF rakendamiseks oleks võinud kasutada mingit valmis raamistikku, näiteks Caliburn Micro või MVVM Light Toolkit

Tööjaotus

  • Kärt Palm - Rakenduse kliendi äriloogika
  • Karina Egipt - Rakenduse kliendi kasutajaliides
  • Silver Saks - Andmebaasidega suhtlus, server ja serveriga ühenduvus
  • Erika Ehmann - Rakenduse kliendi kasutajaliides sisselogimiseks ja registreerimiseks, ning ainete otsing

Failid

Retrieved from "https://wiki.itcollege.ee/index.php?title=Meeskond:_Spooky_Scary_Skeletons&oldid=101117"