ICO wiki - User contributions [en]

Meeskond: Spooky Scary Skeletons

2016-01-30T16:09:13Z

Ssaks:

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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/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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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 ==

*'''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 ==

[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]

Meeskond: Spooky Scary Skeletons

2016-01-22T10:44:22Z

Ssaks: /* Lõpptoode */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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/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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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 ==

*'''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-21.01.2015''' - Viimane arendussprint.
*'''21.01.2015''' - Lisatud lõpptoote kirjeldus ja ülevaade tehtud tööst.

== Lisad ==

[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]

Meeskond: Spooky Scary Skeletons

2016-01-21T12:10:13Z

Ssaks: /* Projekti kirjeldus */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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/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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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 ==

*'''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-21.01.2015''' - Viimane arendussprint.
*'''21.01.2015''' - Lisatud lõpptoote kirjeldus ja ülevaade tehtud tööst.

== Lisad ==

[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.

'''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]

Meeskond: Spooky Scary Skeletons

2016-01-21T11:01:34Z

Ssaks: /* Lõpptoode */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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 ==

*'''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-21.01.2015''' - Viimane arendussprint.
*'''21.01.2015''' - Lisatud lõpptoote kirjeldus ja ülevaade tehtud tööst.

== Lisad ==

[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.

'''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]

Meeskond: Spooky Scary Skeletons

2016-01-21T10:54:29Z

Ssaks: /* Lõpptoode */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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 ==

*'''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-21.01.2015''' - Viimane arendussprint.
*'''21.01.2015''' - Lisatud lõpptoote kirjeldus ja ülevaade tehtud tööst.

== Lisad ==

[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.

'''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.

'''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]

Meeskond: Spooky Scary Skeletons

2016-01-21T10:54:05Z

Ssaks: /* Lõpptoode */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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 ==

*'''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-21.01.2015''' - Viimane arendussprint.
*'''21.01.2015''' - Lisatud lõpptoote kirjeldus ja ülevaade tehtud tööst.

== Lisad ==

[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.

'''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.

'''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]

Meeskond: Spooky Scary Skeletons

2016-01-21T10:48:52Z

Ssaks: /* Lõpptoode */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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 ==

*'''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-21.01.2015''' - Viimane arendussprint.
*'''21.01.2015''' - Lisatud lõpptoote kirjeldus ja ülevaade tehtud tööst.

== Lisad ==

[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.

'''Arenduse käigus tekkinud probleemid'''

WPF ja MVVM olid ise õppimiseks väga keerulised, kindlasti tuleks koolis praktikatundides nende õpetamisele rohkem rõhku panna. Pakuks et arenduse käigus 80% ajast kulus puhtalt WPF probleemide lahendamisele.

'''Mida oleks võinud teistmoodi teha'''

*WPF asemel kasutada Winforms või HTML5 kasutajaliidest. Oleks kiirendanud arendusprotsessi kordades, ning arvatavasti oleks lõpptulemus olnud palju täielikum.
*Antud rakenduse realiseerimiseks oleks täielikult veebirakenduse tegemine olnud parem lahendus.
*TFS asemel oleks pidanud Git-i kasutama.

'''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]

Meeskond: Spooky Scary Skeletons

2016-01-21T10:48:14Z

Ssaks: /* Lõpptoode */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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 ==

*'''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-21.01.2015''' - Viimane arendussprint.
*'''21.01.2015''' - Lisatud lõpptoote kirjeldus ja ülevaade tehtud tööst.

== Lisad ==

[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.

'''Arenduse käigus tekkinud probleemid'''

WPF ja MVVM olid ise õppimiseks väga keerulised, kindlasti tuleks koolis praktikatundides nende õpetamisele rohkem rõhku panna. Pakuks et arenduse käigus 80% ajast kulus puhtalt WPF probleemide lahendamisele.

'''Mida oleks võinud teistmoodi teha'''

*WPF asemel kasutada Winforms või HTML5 kasutajaliidest. Oleks kiirendanud arendusprotsessi kordades, ning arvatavasti oleks lõpptulemus olnud palju täielikum.
*Antud rakenduse realiseerimiseks oleks täielikult veebirakenduse tegemine olnud parem lahendus.
*TFS asemel oleks pidanud Git-i kasutama.

'''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]

Meeskond: Spooky Scary Skeletons

2016-01-21T10:48:01Z

Ssaks: /* Lõpptoode */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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 ==

*'''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-21.01.2015''' - Viimane arendussprint.
*'''21.01.2015''' - Lisatud lõpptoote kirjeldus ja ülevaade tehtud tööst.

== Lisad ==

[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.

'''Arenduse käigus tekkinud probleemid'''

WPF ja MVVM olid ise õppimiseks väga keerulised, kindlasti tuleks koolis praktikatundides nende õpetamisele rohkem rõhku panna. Pakuks et arenduse käigus 80% ajast kulus puhtalt WPF probleemide lahendamisele.

'''Mida oleks võinud teistmoodi teha'''

*WPF asemel kasutada Winforms või HTML5 kasutajaliidest. Oleks kiirendanud arendusprotsessi kordades, ning arvatavasti oleks lõpptulemus olnud palju täielikum.
*Antud rakenduse realiseerimiseks oleks täielikult veebirakenduse tegemine olnud parem lahendus.
*TFS asemel oleks pidanud Git-i kasutama.

'''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

*[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]

Meeskond: Spooky Scary Skeletons

2016-01-21T10:42:43Z

Ssaks: /* Lõpptoode */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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 ==

*'''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-21.01.2015''' - Viimane arendussprint.
*'''21.01.2015''' - Lisatud lõpptoote kirjeldus ja ülevaade tehtud tööst.

== Lisad ==

[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.

'''Arenduse käigus tekkinud probleemid'''

WPF ja MVVM olid ise õppimiseks väga keerulised, kindlasti tuleks koolis praktikatundides nende õpetamisele rohkem rõhku panna. Pakuks et arenduse käigus 80% ajast kulus puhtalt WPF probleemide lahendamisele.

'''Mida oleks võinud teistmoodi teha'''

*WPF asemel kasutada Winforms või HTML5 kasutajaliidest. Oleks kiirendanud arendusprotsessi kordades, ning arvatavasti oleks lõpptulemus olnud palju täielikum.
*Antud rakenduse realiseerimiseks oleks täielikult veebirakenduse tegemine olnud parem lahendus.
*TFS asemel oleks pidanud Git-i kasutama.

*[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]

Meeskond: Spooky Scary Skeletons

2016-01-21T00:05:52Z

Ssaks: /* Lõpptoode */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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 ==

*'''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-21.01.2015''' - Viimane arendussprint.
*'''21.01.2015''' - Lisatud lõpptoote kirjeldus ja ülevaade tehtud tööst.

== Lisad ==

[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 ==
*[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]

Juhend: Kodutöö aines "Programmeerimine CSharp keeles" (2015)

2016-01-21T00:04:43Z

Ssaks: /* Meeskond: Spooky Scary Skeletons */

__NOINDEX__

=Kodutöö aines "Programmeerimine C# keeles"=

==Eesmärk==
Saada praktiline arenduskogemus .NET keskkonnas ning arendada meeskonnatöö kogemust ja analüüsivõimet. Kasutada arendusprotsessis koodihoidlat.

==Reeglid==
Ühte projektimeeskonda kuulub 3-5 tudengit(Soovituslik meeskonna suurus on 3-4). Ühel teemal võib teostada projekti üks või mitu meeskonda.Töö käiku kajastatakse https://wiki.itcollege.ee keskkonnas või soovi korral võib seda teha ka ajaveebis(blogis).
Ajaveebi pidamise eesmärke on kaks: nii on võimalik kirja panna kõik mõtted ja ideed (ning nendest jääb jälg ja dokumentatsioon) ning õppejõul on hiljem võimalik saada ülevaade iga projektimeeskonna liikme panusest. Ajaveebi loob ja ajaveebi haldab projektimeeskond vabalt valitud (avalikus) keskkonnas.

'''Projekti loomine ja arendamine '''
Projekt lisatakse versioonihaldusesse, kasutades selleks [Team Foundation Service'it http://tfs.visualstudio.com/] ning õppejõule antakse ligipääs. Õppejõu live id: maitposka ät hotmail.com . Projekt peab olema alates algfaasist lisatud TFSi ning kogu tööprotsess toimub versioonihaldust kasutades

'''Tööde esitamine''' (prototüüb ja lõpptoode)
Töö esitamisel pakitakse see kokku ning lisatakse wiki leheküljele link lähtekoodile. Kui töö lähtekoodi ei soovita mingil põhjusel avalikustata, tuleb õppejõuga selle jaoks sõlmida eraldi kokkulepe. Lähtekood on vajalik, et tööd oleks võimalik hinnata nii õppejõul kui kaastudengitel selle kohta retsensiooni kirjutada.

'''Team Foundation Service kasutamine''' (tänasel päeval '' Visual Studio online'')
[http://www.visualstudio.com/get-started/sign-up-for-visual-studio-online Step-by-Step juhend]

NB! Siia tuleb õppejõu poolt lihtne screencast ka, kuid ideeliselt ei tohiks selle kasutamine olla väga keeruline.

==Tähtaegadest kinnipidamine==
Projekt jaguneb alamosadeks, millele on määratud tähtajad. Tähtaegade ületamisel võimalike punkte ei kaotata. Kui töö aga on esitatud tähtajaks, siis on võimalik selle eest teenida boonuspunkte (enamasti 0-10% võimalikust maksimumist boonust). Enne tähtaega esitatud töö ei tähenda automaatselt maksimumpunkte, kui see ei ole sooritatud korralikult.

==Hindamine==
Teostatuks loetakse projekt juhul, kui lähteülesanne on realiseeritud, lahendus on töötav, kuid esineb suuremaid vigu ning piirsituatsioonidega ei ole arvestatud.
Maksimumtulemuse saavutamiseks peab projekt olema teostatud tehniliselt veatult ning varustatud dokumentatsiooniga, milles sisaldub arendusprotsessi kirjeldus (peab selguma ka iga rühmaliikme panus projekti teostamisel), kasutajajuhend ning lahenduse kirjeldus. Tehnilisi ja vormistuslike puudujääke on võimalik korvata lisavõimaluste realiseerimisega.Üldjuhul tuleb loodud lahendust ka praktikumides või loengutes teistele tudengitele tutvustada (ca 10 min).
Nagu eelpool mainitud, koosneb projekt erinevatest osadest. Punktide arvu määramisel arvestatakse ka tähtajast kinni pidamist, mille toimimisloogika on kirjeldatud eespool.

===Meeskonna kokkupanek ja idee===
'''25.10.2015''' (2p)

Tekitatakse meeskonna wiki lehekülg. Meeskonnal peab olema nimi ning see koosneb kolmest kuni viiest liikmest. Määratakse projektijuht. Juhul kui hakatakse blogi pidama kuskil mujal keskkonnas ilmub selle kohta link. Lühidalt peaks kirjeldama idee olemust nii, et selle üldine suund oleks arusaadav. Samuti peab olema märgitud tehnoloogia, milles hakatakse rakendust looma. Meeskond on loonud TFSi konto ning on saatnud õppejõule kutse.

===Analüüs===
'''01.11.2015''' (6p)
Analüütilise osa eesmärgiks on arendada tudengite analüüsioskust, mida on vaja ka päris tarkvaraarenduse protsessi juures.'''NB! Miinimum sõnade arv 700''' Selle osa käigus peab valmima loodava rakenduse analüüs, mis sisaldab muu hulgas ka:
*Analüüs rakendusele. (Mida see endas sisaldab? Mis on selle eesmärk? Mida tavakasutaja sellega teha saaks? Milliste osade realiseerimine võib osutuda problemaatiliseks?) Kui on tööjaotus paigas, siis tuua ka see välja.
*Tuua välja nimekiri funktsionaalsusest, mida plaanitakse kindlasti teostada(''Must have'')
*Nimekiri funktsionaalsustest, mis võiks olla, aga mida ei pruugita ajapuuduse tõttu realiseerida.(''Nice to have'')

'''Retsensioon''' 8.11.2015 (3p)

===Prototüüp===
'''13.12.2015 23:58'''(10p)

Valmib projekti esmane realisatsioon. Laias laastus on peafunktsionaalsused realiseeritud(Nimekiri funktsionaalsusest, mida plaanitakse teostada). Programmis võib esineda üksikuid, kuid mitte väga suuri vigu.

'''Retsensioon''' 20.12.2015(5p)

===Lõpptoode===
'''20.01.2016'''(20p)
Selleks faasiks peab projekt maksimumpuntkide saavutamiseks olema teostatud tehniliselt veatult ning varustatud dokumentatsiooniga, milles sisaldub arendusprotsessi kirjeldus (peab selguma ka iga rühmaliikme panus projekti teostamisel), kasutajajuhend ning lahenduse kirjeldus.

'''Retsensioon''' 27.01.2016(5p)

===Esitlus/Kaitsmine===

'''Toimub loengutes/praktikumides või kokkulepitud ajal enne eksamit''' ''(4p) ''
Esitlusel kaitstakse projekti. Tutvustatakse tehnoloogiat, mida kasutati rakenduse realiseerimiseks. Lühidalt räägitakse tööjaotusest ning probleemidest, mis tekkisid projekti realiseerimisel. Näidatakse lähtekoodi ja demonstreeritakse oma rakendust teistele tudengitele, kes võivad selle kohta küsimusi küsida. Kestvus ~20min.

====Kaitsmise ajad====

Tere, iga aja taha kirjutada meeskonna nimi, kes tuleb oma tööd kaitsma. Aegu palun täita võimaluse korral järjest.

Ideaalne esitlus, sisaldab endas ka powerpointi, kus on
*väljatoodud meeskonna nimi ja liikmed
*idee
*realiseerimine
*mis oli keerukas?
*mida uut õpiti?
*mõnede keerulisemate probleemide lahendamine
*meeskonnaliikmete panus

Kaitsmise käigus vaadatakse üle ka kood.

'''Esmaspäev''' - 14.12.2015
*14:00 - [https://wiki.itcollege.ee/index.php?title=Meeskond:_LetsDoIt LetsDoIt]
*14:15 -
*14:30 -
*14:45 -
*15:00 - Incman
*15:15 -

*16:00 -
*16:15 - [[Meeskond: Travo]]
*16:30 - GlobalElite
*16:45 - [https://wiki.itcollege.ee/index.php/BIT BIT]
*17:00 -
*17:15 - KTM Development
*17:30 -

'''Neljapäev''' - 17.12.2015
*08:15 - VVA
*08:30 - mc2
*08:45 -
*09:00 - Sporto
*09:15 - MinuKV
*09:30 -

*10:00 -Kodune raamat
*10:15 -
*10:30 - MSI
*10:45 -
*11:00 - Lebokeiss OÜ
*11:15 - OKVaatame

=Teemad 2015 sügis=
Kodutööna tuleb luua:

==Nõuded rakendusele==
Loodav rakendus peab:
* Peab kasutama andmebaasi (erikokkuleppel ka XML formaadis andmeallikat)
**Andmebaasis peab olema vähemalt 6 andmebaasi tabelit
* Peab võimaldama tegevuste kohta registri pidamist (logi)
**Rakenduses tehtavad tegevused salvestatakse
* Kasutama kasutajaliidesena ühte järgmistest: Windows Presentation Foundation, Windows Phone , Windows Store App või ASP.Net
* Kood on kommenteeritud ning rakendus on varustatud dokumentatsiooniga
* Maksimumpunktide jaoks kasutatakse vastavalt valitud tehnoloogiale soovitatud arendusmustreid
* Kood on kirjutatud C# programmeerimiskeeles
**Kuna aine nimi on "Programmeerimine C# keeles" ei tohi esitada rakendust, mis on loodud Javas, PHPs vms keeles
* Rakendus on jaotatud kihtidesse
'''Loodav rakendus peab olema loodud objektorienteeritud lähenemist kasutades!''' Klassid, klassid, klassid
*Kood on kommenteeritud

Lisapunkte annab:
* Silmailu
* Kood on kirjutatud häid praktikaid järgides ja on veatu(testimine, testimine, testimine)
* Orginaalsed ideed ja hea äriidee

==Kodune raamatukogu==
Kodudes on tihti erinevaid raamatuid (filme, muud nänni) ja sõbrad tahavad neid vahel laenutada.
Loo rakendus, mis
* Võimaldaks sisestada kodused raamatud
* Võimaldaks luua laenutajate profiile
* Raamatuid välja laenutada (tähtajaliselt)
* Laseks koostada erinevaid aruandeid (kodusolevad raamatud, väljalaenutatud raamatud, tähtaja ületanud laenutused jne)

Lisavõimalused
* Kui laenutaja profiilis on e-mail, siis saada automaatselt e-kiri „kallis sõber see ja see, Sinu käes on minu raamat, kas tood tagasi ka?”
* Kuva hoiatused, kui laenutaja laenutuste ajalugu on vilets või kui mõni raamat on tagastamata.
* Lase lisada raamatutele pilt
* Loo lihtne veebiliides (et sõbrad saaksid veebist vaadata, mis raamatud kasutajal kodus veel alles on)
Või

==CRM==
Oma klientidest peab olema ülevaade.
Loo rakendus, mis võimaldab:
* Kliente ning nende kontaktisikuid sisestada, muuta ning kustutada
* Võimalda sisestada kliendikontakte
* Koostada hinnapakkumisi klientidele, kusjuures hinnapakkumine lisatakse süsteemi ka kui kliendikontakt ning saadetakse samast süsteemist kliendile.
* Kliendi andmete vaatamisel kuvatakse ka kliendikontaktid

Lisavõimalused
* Loo võimalus, kus kontaktisiku sünnipäeva saabumisel saadetakse automaatselt inimesele meil õnnesoovidega
* Õnnitlusmeilide template’sid võiks olla mitu
* Loo võimalus kliendi huvide (huvialade) kajastamiseks süsteemis

==Mäng(Unit)==
Loodav mäng peab sisaldama:
* Erinevaid tasemeid
* Punktiarvestust
* XBox puldi tuge
* Klaviatuurilt juhtimise tuge

'''Loodav mäng peab olema loodud objektorienteeritud lähenemist kasutades!''' Klassid, klassid, klassid

Lisapunkte annab:
* Silmailu
* Kood on kirjutatud häid praktikaid järgides ja on veatu(testimine, testimine, testimine)
* Orginaalsed ideed ja hea ''story''

=Meeskonnad 2015=
==Päevaõpe==

===Meeskond: MinuKV===
Liikmed:
*Martin Luik
*Ahto Elken
*Silver Ohlo

Meeskonna koduleht: [[Meeskond: MinuKV]]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale mc2 asub [https://wiki.itcollege.ee/index.php/Talk:Meeskond:_mc2#Retsensioon_mc2_meeskonna_anal.C3.BC.C3.BCsist siin].

'''Lõpptoode'''

Meeskonna MinuKV lõpptoode asub [http://enos.itcollege.ee/~sohlo/MinuKV.7z siin] ja juhend wiki meeskonna kodulehel.

===Meeskond: Travo===
Liikmed:
*Tarvo Reinpalu
Meeskonna koduleht: [[Meeskond: Travo]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Lebokeiss_OÜ Retsensioon meeskonna Lebokeiss OÜ rakenduse analüüsile]

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Lebokeiss_OÜ Retsensioon meeskonna Lebokeiss OÜ rakenduse prototüübile]

===Meeskond: Freshmen===
Liikmed:
*Siim Haas - Projektijuht
*Piret Pomerants
*Semjon Greef

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_Freshmen Freshmen]

'''Retsensioonid'''

Retsensioon Qlibrium analüüsi [https://wiki.itcollege.ee/index.php/Talk:Qlibrium kohta]

===Meeskond: mc2===
Liikmed:
*Martin Betlem
*Johannes Tamm
*Martin Mägi
*Jana Pipar

Meeskonna koduleht: [[Meeskond: mc2]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Retsensioon_MinuKV_kohta#Retsensioon_MinuKV_kohta Retsensioon MinuKV kohta]

[https://wiki.itcollege.ee/index.php/Talk:Retsensioon_ruhmaVVAprototuubikohta Retsensioon rühma VVA prototüübi kohta]

'''Prototüüp'''

Meie prototüüp asub [https://wiki.itcollege.ee/index.php/Meeskond:_mc2#Protot.C3.BC.C3.BCp SIIN]

===Meeskond: Sporto===
Liikmed ja panus projekti:
*Kelli Lukas 100%
*Vladimir Rõkovanov 100%
*Alar Ameerikas 100%
*Mikk Raudsepp 100%
Meeskonna koduleht ('''Dokumentatsioon'''): [https://wiki.itcollege.ee/index.php/Sporto Sporto]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_KTM_Development Retsensioon meeskonna KTM Development projekti analüüsile]

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_KTM_Development Retsensioon meeskonna KTM Development projekti prototüübile]

'''Prototüüp'''

[https://onedrive.live.com/redir?resid=B04DA53E21E8691B!30244&authkey=!AO2gXYl6yrrc1HM&ithint=file%2c7z Laadi alla]

'''Lõpptoode'''

[http://1drv.ms/1lSbvJz Laadi alla]

'''Juhend'''

[https://www.youtube.com/watch?v=D2_KJu4yrtk asub siin]

===Meeskond: LetsDoIt===
Liikmed:
*Liisa Suurkaev(projektijuht)
*Melissa Eenmaa
*Tanel Vähk
*Taavi Kliss
*Aleks Luik
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_LetsDoIt LetsDoIt]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale LendBook asub [https://wiki.itcollege.ee/index.php/Talk:LendBook retsensioon siin].

Prototüübi retsensioon meeskonnale mc2 asub [https://wiki.itcollege.ee/index.php/Talk:Meeskond:_mc2#Protot.C3.BC.C3.BCbi_retsensioon siin].

'''Valmis toode'''

Meeskonna LetsDoIt valmis toode asub [https://wiki.itcollege.ee/index.php/Meeskond:_LetsDoIt#Protot.C3.BC.C3.BCp siin].

===Meeskond: VVA===
Liikmed:
*Vladislav Lahtarin
*Vladislav Kovaltšuk
*Aleksandr Babõkin

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_VVA Meeskond:_VVA]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale Sporto asub [https://wiki.itcollege.ee/index.php/Meeskond:_VVA#Anal.C3.BC.C3.BCsi_retsensioon_meeskonnale_.22Sporto.22 siin]

Prototüübi retsensioon meeskonnale mc2 asub [https://wiki.itcollege.ee/index.php/Meeskond:_VVA#Protot.C3.BC.C3.BCbi_retsensioon_meeskonnale_.22mc2.22 siin]

Lõpptoote retsensioon meeskonnale "Sporto" asub [https://wiki.itcollege.ee/index.php/Meeskond:_VVA#L.C3.B5pptoote_retsensioon_meeskonnale_.22Sporto.22 siin]

'''Prototüüp'''

[http://enos.itcollege.ee/~vkovalt/Csharp/Desktop.html Mäng] ja [http://enos.itcollege.ee/~vkovalt/LaeAllaProto/ lähtekood]

'''Lõpptoode'''

[http://enos.itcollege.ee/~vkovalt/Valmis/WEB/Desktop.html Mäng] ja [http://enos.itcollege.ee/~vkovalt/Valmis/Projekt/ lähtekood]

===Meeskond: IncMan===
Liikmed:
*Sergei Fatejev
*Nele Sergejeva
*Marko Koiduste
*Kaspar Tilk
*Jaanus Türnpuu

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Incman IncMan]

'''Retsensioonid'''

*Analüüsi retsensioon meeskonnale '''LetsDoIt''' asub [https://wiki.itcollege.ee/index.php/Talk:Meeskond:_LetsDoIt siin]
*Prototüübi retsensioon meeskonnale '''GlobalLite''' asub [https://wiki.itcollege.ee/index.php/Talk:GlobalLite siin]

===Meeskond: Lebokeiss OÜ===
Liikmed:
*Joonas Jõeleht - Projektijuht
*Iris Tambaum
*Timo Lanno
*Karell Veskimeister
*Kerli Edasi

Meeskonna koduleht: [[Meeskond:_Lebokeiss_OÜ]]

'''Retsensioonid'''

[[Talk:Meeskond:_Travo | Retsensioon meeskond Travo analüüsile]]

[[Talk:Meeskond:_Travo#Retsensioon_meeskond_Travo_projekti_protot.C3.BC.C3.BCbile | Retsensioon meeskond Travo prototüübile]]

===Meeskond: MSI===
Liikmed:
*Siim Ivask
*Martin Saar
*Indrek Tamm

Meeskonna koduleht: [[Meeskond: MSI]]

===Meeskond: LendBook===
Liikmed:
*Egle Arge
*Liina Kolk

Meeskonna koduleht: [[LendBook]]

'''Retsensioonid'''

[[Talk:PenguinHorde | Retsensioon meeskonna PenguinHorde analüüsile]]

===Meeskond: BIT===
Liikmed:
*Merilyn Renser
*Marko Hartikainen
*Ants Kristjan Rooma
*Konstantin Burdakov

Meeskonna koduleht: [[BIT]]

'''Retsensioonid''' 
[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_VVA#Anal.C3.BC.C3.BCsi_retsensioon VVA analüüsi retsensioon]

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_VVA#Proto_retsensioon VVA proto retsensioon]

===Meeskond: PenguinHorde===
Liikmed:
*Laura Leon
*Marko Saluste
*Terje Sõelsepp
*Mari-Liis Oldja
Meeskonna koduleht: [[PenguinHorde]]

'''Retsensioonid'''
Retsensioon [https://wiki.itcollege.ee/index.php/Talk:BIT meeskond BIT] analüüsile.

===Meeskond: GlobalElite===
Liikmed:
*Marek Kivikink
*Indrek Nurja
*Imre Teras
*Aapo Kersalu
*Erling Tammisto
Meeskonna koduleht: [[GlobalLite]]

'''Prototüüp'''
[https://www.dropbox.com/s/i7i01x3450umarh/GlobalElite_proto.rar?dl=0 Lae alla (RAR fail)]

'''Retsensioonid'''

Analüüsi retsensioon [https://wiki.itcollege.ee/index.php/Talk:RJ meeskond RJ] kohta.

Prototüübi retsensioon [https://wiki.itcollege.ee/index.php/Talk:VVA meeskond VVA] kohta.

===Meeskond: KTM Development===
Liikmed:
*Kristian Laupa
*Tauno Otti
*Mart Abel
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_KTM_Development KTM Development]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale '''mc2''' asub [https://wiki.itcollege.ee/index.php/User_talk:Klaupa siin]

===Meeskond: Bob?===
Liige:
*Priit Aarne

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Bob Bob?]

'''Retsensioonid'''

[[Meeskonna IncMan analüüsi retsensioon]]

[[Meeskonna IncMan prototüübi retsensioon]]

'''Lõpptoode'''

[https://drive.google.com/open?id=0B1B6XMjJFSULSFJMeFdEM0tsWUE Lõpptoode]

===Meeskond: RJ===
Liige:
*Richard Jalonen
Meeskonna koduleht: [[RJ]]

===Meeskond: Qlibrium===
Liige:
*Karl Frank
Meeskonna koduleht [[Qlibrium]]

'''Retsensioon'''
[https://wiki.itcollege.ee/index.php/Talk:Retsensioon_GlobalLite_*#Meeskonna_GlobalLite_anal.C3.BC.C3.BCsi_retsensioon]

===Meeskond: Kodune Raamat===
Liikmed:
*Siim Osa
*Taavi Kivimaa
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_Kodune_Raamat Kodune Raamat]

'''Retsensioonid'''

===Meeskond: TaTa===
Liikmed:
*Talis Tammearu
Meeskonna koduleht: [[Meeskond:TaTa]]

===Meeskond: Ktreikel===
Liikmed:
*Kert Treikelder
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_ktreikel]

===Meeskond: OkVaatame===
Liikmed:
*Aleks Tatter
*Vaiko Vällik

Meeskonna koduleht: [[Meeskond:_Ok_Vaatame]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:OkVaatame_retsensioon_Qlibriumile]
[https://wiki.itcollege.ee/index.php/Talk:OkVaatame_retsensioon_KTMile]

[[Category: Programmeerimine CSharp keeles (2015) (Päevaõpe)]]

==Kaugõpe==
===Meeskond: Premium===
Liikmed:
*Tarmo Petrovits
*Karin Talumäe
*Jevgeni Gavrilov

Meeskonna koduleht: [[Meeskond: Premium]]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale '''LIB''' asub [https://wiki.itcollege.ee/index.php/Talk:Meeskond:_LIB siin]

Prototüübi retsensioon meeskonnale '''LIB''' asub [https://wiki.itcollege.ee/index.php/Talk:Meeskond:_LIB siin]

===Meeskond: Spooky Scary Skeletons===
Liikmed:
*Kärt Palm DK22
*Karina Egipt DK22 (Projektijuht)
*Erika Ehmann D32
*Silver Saks AK21

Meeskonna koduleht: [[Meeskond: Spooky Scary Skeletons]]

'''[https://pilv.mana.ee/public.php?service=files&t=0e79ef0570f39b8743f046c70f724404 Esimene Prototüüp (13.12.2015)]

'''[https://pilv.mana.ee/public.php?service=files&t=00ce781b71759d6f66017ad40dc81901 Rakenduse Server (20.01.2016) - Lõpptoode]

'''[https://pilv.mana.ee/public.php?service=files&t=dd72ab32e4900f3970d484317c94a94c Rakenduse Klient (20.01.2016) - Lõpptoode]

Lõpptoote kohta lugeda kindlasti ka meie wikist.

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Premium Retsensioon meeskonna Premium projekti HomeLibrary analüüsile]

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Fontastic#Retsensioon_protot.C3.BC.C3.BCbile Retsensioon meeskonna Fontastic projekti Fontastic prototüübile]

=== Meeskond: Nocturne No. 20 in C-sharp Minor ===
Liikmed:
*10142848 (Projektijuht)
*10090107
*10143193
*10143313

Meeskonna koduleht: [[Meeskond: Nocturne No. 20 in C-sharp Minor]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Fontastic Retsensioon meeskonna Fontastic rakenduse analüüsile]

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Fontastic Retsensioon meeskonna Fontastic rakenduse prototüübile]

===Meeskond: LIB===
Liikmed:
*Sigrid Pachel DK22 (Projektijuht)
*Diana Nikolajeva DK22
*Kristjan Adrat DK41

Meeskonna koduleht: [[Meeskond: LIB]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond_Mardo Analüüsi retsensioon Mardo meeskonnale]

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Pohjavesi Retsensioon meeskonnale Põhjavesi]

===Meeskond: Greek?Mark===
Liikmed:
*Karit Kilgi DK22 (Projektijuht)
*Sten Kaasik DK22
*Siim Veskilt DK22

Meeskonna koduleht: [[Meeskond: GreekQMark]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Spooky_Scary_Skeletons Retsensioon meeskonna Spooky Scary Skeletons rakenduse AVE 2.0 analüüsile]

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Spooky_Scary_Skeletons Retsensioon meeskonna Spooky Scary Skeletons rakenduse AVE 2.0 prototüübile]

===Meeskond: Tarraxacum===
Liikmed:
*Silja Kralik DK21 (Projektijuht)
*Liina Laumets DK21
*Ragne Auling DK22

Meeskonna koduleht: [[Meeskond: Tarraxacum]]

[[Retsensioon meeskonnale Põhjavesi]]

[[Retsensioon prototüübile]]

===Meeskond: Fontastic===
Liikmed:
*Erik Hirmo DK22 (Projektijuht)
*Piret Reinumägi DK21

Meeskonna koduleht: [[Meeskond: Fontastic]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Konsa Retsensioon meeskonna Konsa projekti Ostukorv analüüsile]

===Meeskond: TTT===
Liikmed:
*Ave Karjus DK22
*Joonatan Uusväli DK22 (Projektijuht)
*Kaidar Viikman DK21 (Wiki pidaja)
*Oliver Tiks AK21

Meeskonna koduleht: [[Meeskond: TTT (Trellid Teevad Tugevaks) | TTT (Trellid Teevad Tugevaks)]]

'''Retsensioonid'''

[[Talk:Meeskond:_GreekQMark#section=1 | Retsensioon meeskonna Greek?Mark projekti analüüsile]]

[[Talk:Meeskond:_Premium#section=2 | Retsensioon meeskonna Premium projekti prototüübile]]

===Meeskond: Codezilla===
Liikmed:
*Anna Linskaja DK21 (Projektijuht)
*Alisa Dudinova DK21
*Sergei Hristoforov DK21

Meeskonna koduleht: [[Codezilla]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Maker Retsensioon meeskonna Maker projekti analüüsile]

===Meeskond: Konsa===
Liikmed:

*Marko Konsa DK13

Meeskonna koduleht: [[Ostukorv]]

'''Retsensioonid'''
===Meeskond: Johhaidii===
Liikmed:
*Yogesh Sharma
*Juhan Trink
*Marju Niinemaa

Meeskonna koduleht: [[Johhaidii]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Retsensioon_Makerile Retsensioon meeskonna Maker analüüsile]

===Meeskond: Sildur===
Liikmed:
*Andreas Papp (Projektijuht)
*Germo Väli
*Andres Trei

Meeskonna koduleht: [[Sildur]]

'''Retsensioonid'''
===Meeskond: JT===
Liikmed:
*Tõnis Luik (Projektijuht)
*Juri Nikitin

Meeskonna koduleht: [[JT]]

'''Retsensioonid'''

===Meeskond: Maker===
Liikmed:
*Marek Öövel (Projektijuht)

Meeskonna koduleht: [[Maker]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Codezilla Retsensioon meeskonna Codezilla analüüsile]

===Meeskond: Põhjavesi===
Liikmed
*Indrek Pruul (Projektijuht)
*Jan Eerik
*Eeva Koplimets

Meeskonna koduleht: [[Pohjavesi]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Pohjavesi Retsensioon meeskonnale Spooky Scary Skeletons analüüsile]

===Meeskond: MMTL development===
Liikmed
*Martin Mänd (Projektijuht)
*Taavi Lõhmus

Meeskonna koduleht: [[Meeskond: MMTL development]]

'''Retsensioonid'''

===Meeskond: Mardo===
Liikmed:
*Mardo Halapuu
Meeskonna koduleht:[https://wiki.itcollege.ee/index.php/Meeskond_Mardo Mardo]

Meeskond: Spooky Scary Skeletons

2016-01-21T00:04:15Z

Ssaks: /* Arendusprotsess */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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 ==

*'''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-21.01.2015''' - Viimane arendussprint.
*'''21.01.2015''' - Lisatud lõpptoote kirjeldus ja ülevaade tehtud tööst.

== Lisad ==

[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 ==
*[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)]

Meeskond: Spooky Scary Skeletons

2016-01-21T00:04:02Z

Ssaks: /* Valmis Rakendus */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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 ==

*'''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-21.01.2015''' - Viimane arendussprint.
*'''21.01.2015''' - Lisatud valmis rakenduse kirjeldus ja ülevaade tehtud tööst.

== Lisad ==

[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 ==
*[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)]

Meeskond: Spooky Scary Skeletons

2016-01-21T00:03:18Z

Ssaks: /* Arendusprotsess */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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 ==

*'''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-21.01.2015''' - Viimane arendussprint.
*'''21.01.2015''' - Lisatud valmis rakenduse kirjeldus ja ülevaade tehtud tööst.

== Lisad ==

[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;

== Valmis Rakendus ==
*[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)]

Juhend: Kodutöö aines "Programmeerimine CSharp keeles" (2015)

2016-01-21T00:02:25Z

Ssaks: /* Meeskond: Spooky Scary Skeletons */

__NOINDEX__

=Kodutöö aines "Programmeerimine C# keeles"=

==Eesmärk==
Saada praktiline arenduskogemus .NET keskkonnas ning arendada meeskonnatöö kogemust ja analüüsivõimet. Kasutada arendusprotsessis koodihoidlat.

==Reeglid==
Ühte projektimeeskonda kuulub 3-5 tudengit(Soovituslik meeskonna suurus on 3-4). Ühel teemal võib teostada projekti üks või mitu meeskonda.Töö käiku kajastatakse https://wiki.itcollege.ee keskkonnas või soovi korral võib seda teha ka ajaveebis(blogis).
Ajaveebi pidamise eesmärke on kaks: nii on võimalik kirja panna kõik mõtted ja ideed (ning nendest jääb jälg ja dokumentatsioon) ning õppejõul on hiljem võimalik saada ülevaade iga projektimeeskonna liikme panusest. Ajaveebi loob ja ajaveebi haldab projektimeeskond vabalt valitud (avalikus) keskkonnas.

'''Projekti loomine ja arendamine '''
Projekt lisatakse versioonihaldusesse, kasutades selleks [Team Foundation Service'it http://tfs.visualstudio.com/] ning õppejõule antakse ligipääs. Õppejõu live id: maitposka ät hotmail.com . Projekt peab olema alates algfaasist lisatud TFSi ning kogu tööprotsess toimub versioonihaldust kasutades

'''Tööde esitamine''' (prototüüb ja lõpptoode)
Töö esitamisel pakitakse see kokku ning lisatakse wiki leheküljele link lähtekoodile. Kui töö lähtekoodi ei soovita mingil põhjusel avalikustata, tuleb õppejõuga selle jaoks sõlmida eraldi kokkulepe. Lähtekood on vajalik, et tööd oleks võimalik hinnata nii õppejõul kui kaastudengitel selle kohta retsensiooni kirjutada.

'''Team Foundation Service kasutamine''' (tänasel päeval '' Visual Studio online'')
[http://www.visualstudio.com/get-started/sign-up-for-visual-studio-online Step-by-Step juhend]

NB! Siia tuleb õppejõu poolt lihtne screencast ka, kuid ideeliselt ei tohiks selle kasutamine olla väga keeruline.

==Tähtaegadest kinnipidamine==
Projekt jaguneb alamosadeks, millele on määratud tähtajad. Tähtaegade ületamisel võimalike punkte ei kaotata. Kui töö aga on esitatud tähtajaks, siis on võimalik selle eest teenida boonuspunkte (enamasti 0-10% võimalikust maksimumist boonust). Enne tähtaega esitatud töö ei tähenda automaatselt maksimumpunkte, kui see ei ole sooritatud korralikult.

==Hindamine==
Teostatuks loetakse projekt juhul, kui lähteülesanne on realiseeritud, lahendus on töötav, kuid esineb suuremaid vigu ning piirsituatsioonidega ei ole arvestatud.
Maksimumtulemuse saavutamiseks peab projekt olema teostatud tehniliselt veatult ning varustatud dokumentatsiooniga, milles sisaldub arendusprotsessi kirjeldus (peab selguma ka iga rühmaliikme panus projekti teostamisel), kasutajajuhend ning lahenduse kirjeldus. Tehnilisi ja vormistuslike puudujääke on võimalik korvata lisavõimaluste realiseerimisega.Üldjuhul tuleb loodud lahendust ka praktikumides või loengutes teistele tudengitele tutvustada (ca 10 min).
Nagu eelpool mainitud, koosneb projekt erinevatest osadest. Punktide arvu määramisel arvestatakse ka tähtajast kinni pidamist, mille toimimisloogika on kirjeldatud eespool.

===Meeskonna kokkupanek ja idee===
'''25.10.2015''' (2p)

Tekitatakse meeskonna wiki lehekülg. Meeskonnal peab olema nimi ning see koosneb kolmest kuni viiest liikmest. Määratakse projektijuht. Juhul kui hakatakse blogi pidama kuskil mujal keskkonnas ilmub selle kohta link. Lühidalt peaks kirjeldama idee olemust nii, et selle üldine suund oleks arusaadav. Samuti peab olema märgitud tehnoloogia, milles hakatakse rakendust looma. Meeskond on loonud TFSi konto ning on saatnud õppejõule kutse.

===Analüüs===
'''01.11.2015''' (6p)
Analüütilise osa eesmärgiks on arendada tudengite analüüsioskust, mida on vaja ka päris tarkvaraarenduse protsessi juures.'''NB! Miinimum sõnade arv 700''' Selle osa käigus peab valmima loodava rakenduse analüüs, mis sisaldab muu hulgas ka:
*Analüüs rakendusele. (Mida see endas sisaldab? Mis on selle eesmärk? Mida tavakasutaja sellega teha saaks? Milliste osade realiseerimine võib osutuda problemaatiliseks?) Kui on tööjaotus paigas, siis tuua ka see välja.
*Tuua välja nimekiri funktsionaalsusest, mida plaanitakse kindlasti teostada(''Must have'')
*Nimekiri funktsionaalsustest, mis võiks olla, aga mida ei pruugita ajapuuduse tõttu realiseerida.(''Nice to have'')

'''Retsensioon''' 8.11.2015 (3p)

===Prototüüp===
'''13.12.2015 23:58'''(10p)

Valmib projekti esmane realisatsioon. Laias laastus on peafunktsionaalsused realiseeritud(Nimekiri funktsionaalsusest, mida plaanitakse teostada). Programmis võib esineda üksikuid, kuid mitte väga suuri vigu.

'''Retsensioon''' 20.12.2015(5p)

===Lõpptoode===
'''20.01.2016'''(20p)
Selleks faasiks peab projekt maksimumpuntkide saavutamiseks olema teostatud tehniliselt veatult ning varustatud dokumentatsiooniga, milles sisaldub arendusprotsessi kirjeldus (peab selguma ka iga rühmaliikme panus projekti teostamisel), kasutajajuhend ning lahenduse kirjeldus.

'''Retsensioon''' 27.01.2016(5p)

===Esitlus/Kaitsmine===

'''Toimub loengutes/praktikumides või kokkulepitud ajal enne eksamit''' ''(4p) ''
Esitlusel kaitstakse projekti. Tutvustatakse tehnoloogiat, mida kasutati rakenduse realiseerimiseks. Lühidalt räägitakse tööjaotusest ning probleemidest, mis tekkisid projekti realiseerimisel. Näidatakse lähtekoodi ja demonstreeritakse oma rakendust teistele tudengitele, kes võivad selle kohta küsimusi küsida. Kestvus ~20min.

====Kaitsmise ajad====

Tere, iga aja taha kirjutada meeskonna nimi, kes tuleb oma tööd kaitsma. Aegu palun täita võimaluse korral järjest.

Ideaalne esitlus, sisaldab endas ka powerpointi, kus on
*väljatoodud meeskonna nimi ja liikmed
*idee
*realiseerimine
*mis oli keerukas?
*mida uut õpiti?
*mõnede keerulisemate probleemide lahendamine
*meeskonnaliikmete panus

Kaitsmise käigus vaadatakse üle ka kood.

'''Esmaspäev''' - 14.12.2015
*14:00 - [https://wiki.itcollege.ee/index.php?title=Meeskond:_LetsDoIt LetsDoIt]
*14:15 -
*14:30 -
*14:45 -
*15:00 - Incman
*15:15 -

*16:00 -
*16:15 - [[Meeskond: Travo]]
*16:30 - GlobalElite
*16:45 - [https://wiki.itcollege.ee/index.php/BIT BIT]
*17:00 -
*17:15 - KTM Development
*17:30 -

'''Neljapäev''' - 17.12.2015
*08:15 - VVA
*08:30 - mc2
*08:45 -
*09:00 - Sporto
*09:15 - MinuKV
*09:30 -

*10:00 -Kodune raamat
*10:15 -
*10:30 - MSI
*10:45 -
*11:00 - Lebokeiss OÜ
*11:15 - OKVaatame

=Teemad 2015 sügis=
Kodutööna tuleb luua:

==Nõuded rakendusele==
Loodav rakendus peab:
* Peab kasutama andmebaasi (erikokkuleppel ka XML formaadis andmeallikat)
**Andmebaasis peab olema vähemalt 6 andmebaasi tabelit
* Peab võimaldama tegevuste kohta registri pidamist (logi)
**Rakenduses tehtavad tegevused salvestatakse
* Kasutama kasutajaliidesena ühte järgmistest: Windows Presentation Foundation, Windows Phone , Windows Store App või ASP.Net
* Kood on kommenteeritud ning rakendus on varustatud dokumentatsiooniga
* Maksimumpunktide jaoks kasutatakse vastavalt valitud tehnoloogiale soovitatud arendusmustreid
* Kood on kirjutatud C# programmeerimiskeeles
**Kuna aine nimi on "Programmeerimine C# keeles" ei tohi esitada rakendust, mis on loodud Javas, PHPs vms keeles
* Rakendus on jaotatud kihtidesse
'''Loodav rakendus peab olema loodud objektorienteeritud lähenemist kasutades!''' Klassid, klassid, klassid
*Kood on kommenteeritud

Lisapunkte annab:
* Silmailu
* Kood on kirjutatud häid praktikaid järgides ja on veatu(testimine, testimine, testimine)
* Orginaalsed ideed ja hea äriidee

==Kodune raamatukogu==
Kodudes on tihti erinevaid raamatuid (filme, muud nänni) ja sõbrad tahavad neid vahel laenutada.
Loo rakendus, mis
* Võimaldaks sisestada kodused raamatud
* Võimaldaks luua laenutajate profiile
* Raamatuid välja laenutada (tähtajaliselt)
* Laseks koostada erinevaid aruandeid (kodusolevad raamatud, väljalaenutatud raamatud, tähtaja ületanud laenutused jne)

Lisavõimalused
* Kui laenutaja profiilis on e-mail, siis saada automaatselt e-kiri „kallis sõber see ja see, Sinu käes on minu raamat, kas tood tagasi ka?”
* Kuva hoiatused, kui laenutaja laenutuste ajalugu on vilets või kui mõni raamat on tagastamata.
* Lase lisada raamatutele pilt
* Loo lihtne veebiliides (et sõbrad saaksid veebist vaadata, mis raamatud kasutajal kodus veel alles on)
Või

==CRM==
Oma klientidest peab olema ülevaade.
Loo rakendus, mis võimaldab:
* Kliente ning nende kontaktisikuid sisestada, muuta ning kustutada
* Võimalda sisestada kliendikontakte
* Koostada hinnapakkumisi klientidele, kusjuures hinnapakkumine lisatakse süsteemi ka kui kliendikontakt ning saadetakse samast süsteemist kliendile.
* Kliendi andmete vaatamisel kuvatakse ka kliendikontaktid

Lisavõimalused
* Loo võimalus, kus kontaktisiku sünnipäeva saabumisel saadetakse automaatselt inimesele meil õnnesoovidega
* Õnnitlusmeilide template’sid võiks olla mitu
* Loo võimalus kliendi huvide (huvialade) kajastamiseks süsteemis

==Mäng(Unit)==
Loodav mäng peab sisaldama:
* Erinevaid tasemeid
* Punktiarvestust
* XBox puldi tuge
* Klaviatuurilt juhtimise tuge

'''Loodav mäng peab olema loodud objektorienteeritud lähenemist kasutades!''' Klassid, klassid, klassid

Lisapunkte annab:
* Silmailu
* Kood on kirjutatud häid praktikaid järgides ja on veatu(testimine, testimine, testimine)
* Orginaalsed ideed ja hea ''story''

=Meeskonnad 2015=
==Päevaõpe==

===Meeskond: MinuKV===
Liikmed:
*Martin Luik
*Ahto Elken
*Silver Ohlo

Meeskonna koduleht: [[Meeskond: MinuKV]]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale mc2 asub [https://wiki.itcollege.ee/index.php/Talk:Meeskond:_mc2#Retsensioon_mc2_meeskonna_anal.C3.BC.C3.BCsist siin].

'''Lõpptoode'''

Meeskonna MinuKV lõpptoode asub [http://enos.itcollege.ee/~sohlo/MinuKV.7z siin] ja juhend wiki meeskonna kodulehel.

===Meeskond: Travo===
Liikmed:
*Tarvo Reinpalu
Meeskonna koduleht: [[Meeskond: Travo]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Lebokeiss_OÜ Retsensioon meeskonna Lebokeiss OÜ rakenduse analüüsile]

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Lebokeiss_OÜ Retsensioon meeskonna Lebokeiss OÜ rakenduse prototüübile]

===Meeskond: Freshmen===
Liikmed:
*Siim Haas - Projektijuht
*Piret Pomerants
*Semjon Greef

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_Freshmen Freshmen]

'''Retsensioonid'''

Retsensioon Qlibrium analüüsi [https://wiki.itcollege.ee/index.php/Talk:Qlibrium kohta]

===Meeskond: mc2===
Liikmed:
*Martin Betlem
*Johannes Tamm
*Martin Mägi
*Jana Pipar

Meeskonna koduleht: [[Meeskond: mc2]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Retsensioon_MinuKV_kohta#Retsensioon_MinuKV_kohta Retsensioon MinuKV kohta]

[https://wiki.itcollege.ee/index.php/Talk:Retsensioon_ruhmaVVAprototuubikohta Retsensioon rühma VVA prototüübi kohta]

'''Prototüüp'''

Meie prototüüp asub [https://wiki.itcollege.ee/index.php/Meeskond:_mc2#Protot.C3.BC.C3.BCp SIIN]

===Meeskond: Sporto===
Liikmed ja panus projekti:
*Kelli Lukas 100%
*Vladimir Rõkovanov 100%
*Alar Ameerikas 100%
*Mikk Raudsepp 100%
Meeskonna koduleht ('''Dokumentatsioon'''): [https://wiki.itcollege.ee/index.php/Sporto Sporto]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_KTM_Development Retsensioon meeskonna KTM Development projekti analüüsile]

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_KTM_Development Retsensioon meeskonna KTM Development projekti prototüübile]

'''Prototüüp'''

[https://onedrive.live.com/redir?resid=B04DA53E21E8691B!30244&authkey=!AO2gXYl6yrrc1HM&ithint=file%2c7z Laadi alla]

'''Lõpptoode'''

[http://1drv.ms/1lSbvJz Laadi alla]

'''Juhend'''

[https://www.youtube.com/watch?v=D2_KJu4yrtk asub siin]

===Meeskond: LetsDoIt===
Liikmed:
*Liisa Suurkaev(projektijuht)
*Melissa Eenmaa
*Tanel Vähk
*Taavi Kliss
*Aleks Luik
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_LetsDoIt LetsDoIt]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale LendBook asub [https://wiki.itcollege.ee/index.php/Talk:LendBook retsensioon siin].

Prototüübi retsensioon meeskonnale mc2 asub [https://wiki.itcollege.ee/index.php/Talk:Meeskond:_mc2#Protot.C3.BC.C3.BCbi_retsensioon siin].

'''Valmis toode'''

Meeskonna LetsDoIt valmis toode asub [https://wiki.itcollege.ee/index.php/Meeskond:_LetsDoIt#Protot.C3.BC.C3.BCp siin].

===Meeskond: VVA===
Liikmed:
*Vladislav Lahtarin
*Vladislav Kovaltšuk
*Aleksandr Babõkin

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_VVA Meeskond:_VVA]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale Sporto asub [https://wiki.itcollege.ee/index.php/Meeskond:_VVA#Anal.C3.BC.C3.BCsi_retsensioon_meeskonnale_.22Sporto.22 siin]

Prototüübi retsensioon meeskonnale mc2 asub [https://wiki.itcollege.ee/index.php/Meeskond:_VVA#Protot.C3.BC.C3.BCbi_retsensioon_meeskonnale_.22mc2.22 siin]

Lõpptoote retsensioon meeskonnale "Sporto" asub [https://wiki.itcollege.ee/index.php/Meeskond:_VVA#L.C3.B5pptoote_retsensioon_meeskonnale_.22Sporto.22 siin]

'''Prototüüp'''

[http://enos.itcollege.ee/~vkovalt/Csharp/Desktop.html Mäng] ja [http://enos.itcollege.ee/~vkovalt/LaeAllaProto/ lähtekood]

'''Lõpptoode'''

[http://enos.itcollege.ee/~vkovalt/Valmis/WEB/Desktop.html Mäng] ja [http://enos.itcollege.ee/~vkovalt/Valmis/Projekt/ lähtekood]

===Meeskond: IncMan===
Liikmed:
*Sergei Fatejev
*Nele Sergejeva
*Marko Koiduste
*Kaspar Tilk
*Jaanus Türnpuu

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Incman IncMan]

'''Retsensioonid'''

*Analüüsi retsensioon meeskonnale '''LetsDoIt''' asub [https://wiki.itcollege.ee/index.php/Talk:Meeskond:_LetsDoIt siin]
*Prototüübi retsensioon meeskonnale '''GlobalLite''' asub [https://wiki.itcollege.ee/index.php/Talk:GlobalLite siin]

===Meeskond: Lebokeiss OÜ===
Liikmed:
*Joonas Jõeleht - Projektijuht
*Iris Tambaum
*Timo Lanno
*Karell Veskimeister
*Kerli Edasi

Meeskonna koduleht: [[Meeskond:_Lebokeiss_OÜ]]

'''Retsensioonid'''

[[Talk:Meeskond:_Travo | Retsensioon meeskond Travo analüüsile]]

[[Talk:Meeskond:_Travo#Retsensioon_meeskond_Travo_projekti_protot.C3.BC.C3.BCbile | Retsensioon meeskond Travo prototüübile]]

===Meeskond: MSI===
Liikmed:
*Siim Ivask
*Martin Saar
*Indrek Tamm

Meeskonna koduleht: [[Meeskond: MSI]]

===Meeskond: LendBook===
Liikmed:
*Egle Arge
*Liina Kolk

Meeskonna koduleht: [[LendBook]]

'''Retsensioonid'''

[[Talk:PenguinHorde | Retsensioon meeskonna PenguinHorde analüüsile]]

===Meeskond: BIT===
Liikmed:
*Merilyn Renser
*Marko Hartikainen
*Ants Kristjan Rooma
*Konstantin Burdakov

Meeskonna koduleht: [[BIT]]

'''Retsensioonid''' 
[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_VVA#Anal.C3.BC.C3.BCsi_retsensioon VVA analüüsi retsensioon]

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_VVA#Proto_retsensioon VVA proto retsensioon]

===Meeskond: PenguinHorde===
Liikmed:
*Laura Leon
*Marko Saluste
*Terje Sõelsepp
*Mari-Liis Oldja
Meeskonna koduleht: [[PenguinHorde]]

'''Retsensioonid'''
Retsensioon [https://wiki.itcollege.ee/index.php/Talk:BIT meeskond BIT] analüüsile.

===Meeskond: GlobalElite===
Liikmed:
*Marek Kivikink
*Indrek Nurja
*Imre Teras
*Aapo Kersalu
*Erling Tammisto
Meeskonna koduleht: [[GlobalLite]]

'''Prototüüp'''
[https://www.dropbox.com/s/i7i01x3450umarh/GlobalElite_proto.rar?dl=0 Lae alla (RAR fail)]

'''Retsensioonid'''

Analüüsi retsensioon [https://wiki.itcollege.ee/index.php/Talk:RJ meeskond RJ] kohta.

Prototüübi retsensioon [https://wiki.itcollege.ee/index.php/Talk:VVA meeskond VVA] kohta.

===Meeskond: KTM Development===
Liikmed:
*Kristian Laupa
*Tauno Otti
*Mart Abel
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_KTM_Development KTM Development]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale '''mc2''' asub [https://wiki.itcollege.ee/index.php/User_talk:Klaupa siin]

===Meeskond: Bob?===
Liige:
*Priit Aarne

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Bob Bob?]

'''Retsensioonid'''

[[Meeskonna IncMan analüüsi retsensioon]]

[[Meeskonna IncMan prototüübi retsensioon]]

'''Lõpptoode'''

[https://drive.google.com/open?id=0B1B6XMjJFSULSFJMeFdEM0tsWUE Lõpptoode]

===Meeskond: RJ===
Liige:
*Richard Jalonen
Meeskonna koduleht: [[RJ]]

===Meeskond: Qlibrium===
Liige:
*Karl Frank
Meeskonna koduleht [[Qlibrium]]

'''Retsensioon'''
[https://wiki.itcollege.ee/index.php/Talk:Retsensioon_GlobalLite_*#Meeskonna_GlobalLite_anal.C3.BC.C3.BCsi_retsensioon]

===Meeskond: Kodune Raamat===
Liikmed:
*Siim Osa
*Taavi Kivimaa
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_Kodune_Raamat Kodune Raamat]

'''Retsensioonid'''

===Meeskond: TaTa===
Liikmed:
*Talis Tammearu
Meeskonna koduleht: [[Meeskond:TaTa]]

===Meeskond: Ktreikel===
Liikmed:
*Kert Treikelder
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_ktreikel]

===Meeskond: OkVaatame===
Liikmed:
*Aleks Tatter
*Vaiko Vällik

Meeskonna koduleht: [[Meeskond:_Ok_Vaatame]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:OkVaatame_retsensioon_Qlibriumile]
[https://wiki.itcollege.ee/index.php/Talk:OkVaatame_retsensioon_KTMile]

[[Category: Programmeerimine CSharp keeles (2015) (Päevaõpe)]]

==Kaugõpe==
===Meeskond: Premium===
Liikmed:
*Tarmo Petrovits
*Karin Talumäe
*Jevgeni Gavrilov

Meeskonna koduleht: [[Meeskond: Premium]]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale '''LIB''' asub [https://wiki.itcollege.ee/index.php/Talk:Meeskond:_LIB siin]

Prototüübi retsensioon meeskonnale '''LIB''' asub [https://wiki.itcollege.ee/index.php/Talk:Meeskond:_LIB siin]

===Meeskond: Spooky Scary Skeletons===
Liikmed:
*Kärt Palm DK22
*Karina Egipt DK22 (Projektijuht)
*Erika Ehmann D32
*Silver Saks AK21

Meeskonna koduleht: [[Meeskond: Spooky Scary Skeletons]]

'''[https://pilv.mana.ee/public.php?service=files&t=0e79ef0570f39b8743f046c70f724404 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)]

Valmis rakenduse kohta lugeda kindlasti ka meie wikist.

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Premium Retsensioon meeskonna Premium projekti HomeLibrary analüüsile]

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Fontastic#Retsensioon_protot.C3.BC.C3.BCbile Retsensioon meeskonna Fontastic projekti Fontastic prototüübile]

=== Meeskond: Nocturne No. 20 in C-sharp Minor ===
Liikmed:
*10142848 (Projektijuht)
*10090107
*10143193
*10143313

Meeskonna koduleht: [[Meeskond: Nocturne No. 20 in C-sharp Minor]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Fontastic Retsensioon meeskonna Fontastic rakenduse analüüsile]

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Fontastic Retsensioon meeskonna Fontastic rakenduse prototüübile]

===Meeskond: LIB===
Liikmed:
*Sigrid Pachel DK22 (Projektijuht)
*Diana Nikolajeva DK22
*Kristjan Adrat DK41

Meeskonna koduleht: [[Meeskond: LIB]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond_Mardo Analüüsi retsensioon Mardo meeskonnale]

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Pohjavesi Retsensioon meeskonnale Põhjavesi]

===Meeskond: Greek?Mark===
Liikmed:
*Karit Kilgi DK22 (Projektijuht)
*Sten Kaasik DK22
*Siim Veskilt DK22

Meeskonna koduleht: [[Meeskond: GreekQMark]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Spooky_Scary_Skeletons Retsensioon meeskonna Spooky Scary Skeletons rakenduse AVE 2.0 analüüsile]

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Spooky_Scary_Skeletons Retsensioon meeskonna Spooky Scary Skeletons rakenduse AVE 2.0 prototüübile]

===Meeskond: Tarraxacum===
Liikmed:
*Silja Kralik DK21 (Projektijuht)
*Liina Laumets DK21
*Ragne Auling DK22

Meeskonna koduleht: [[Meeskond: Tarraxacum]]

[[Retsensioon meeskonnale Põhjavesi]]

[[Retsensioon prototüübile]]

===Meeskond: Fontastic===
Liikmed:
*Erik Hirmo DK22 (Projektijuht)
*Piret Reinumägi DK21

Meeskonna koduleht: [[Meeskond: Fontastic]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Konsa Retsensioon meeskonna Konsa projekti Ostukorv analüüsile]

===Meeskond: TTT===
Liikmed:
*Ave Karjus DK22
*Joonatan Uusväli DK22 (Projektijuht)
*Kaidar Viikman DK21 (Wiki pidaja)
*Oliver Tiks AK21

Meeskonna koduleht: [[Meeskond: TTT (Trellid Teevad Tugevaks) | TTT (Trellid Teevad Tugevaks)]]

'''Retsensioonid'''

[[Talk:Meeskond:_GreekQMark#section=1 | Retsensioon meeskonna Greek?Mark projekti analüüsile]]

[[Talk:Meeskond:_Premium#section=2 | Retsensioon meeskonna Premium projekti prototüübile]]

===Meeskond: Codezilla===
Liikmed:
*Anna Linskaja DK21 (Projektijuht)
*Alisa Dudinova DK21
*Sergei Hristoforov DK21

Meeskonna koduleht: [[Codezilla]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Maker Retsensioon meeskonna Maker projekti analüüsile]

===Meeskond: Konsa===
Liikmed:

*Marko Konsa DK13

Meeskonna koduleht: [[Ostukorv]]

'''Retsensioonid'''
===Meeskond: Johhaidii===
Liikmed:
*Yogesh Sharma
*Juhan Trink
*Marju Niinemaa

Meeskonna koduleht: [[Johhaidii]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Retsensioon_Makerile Retsensioon meeskonna Maker analüüsile]

===Meeskond: Sildur===
Liikmed:
*Andreas Papp (Projektijuht)
*Germo Väli
*Andres Trei

Meeskonna koduleht: [[Sildur]]

'''Retsensioonid'''
===Meeskond: JT===
Liikmed:
*Tõnis Luik (Projektijuht)
*Juri Nikitin

Meeskonna koduleht: [[JT]]

'''Retsensioonid'''

===Meeskond: Maker===
Liikmed:
*Marek Öövel (Projektijuht)

Meeskonna koduleht: [[Maker]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Codezilla Retsensioon meeskonna Codezilla analüüsile]

===Meeskond: Põhjavesi===
Liikmed
*Indrek Pruul (Projektijuht)
*Jan Eerik
*Eeva Koplimets

Meeskonna koduleht: [[Pohjavesi]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Pohjavesi Retsensioon meeskonnale Spooky Scary Skeletons analüüsile]

===Meeskond: MMTL development===
Liikmed
*Martin Mänd (Projektijuht)
*Taavi Lõhmus

Meeskonna koduleht: [[Meeskond: MMTL development]]

'''Retsensioonid'''

===Meeskond: Mardo===
Liikmed:
*Mardo Halapuu
Meeskonna koduleht:[https://wiki.itcollege.ee/index.php/Meeskond_Mardo Mardo]

Meeskond: Spooky Scary Skeletons

2016-01-21T00:01:03Z

Ssaks:

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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 ==

*'''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
*'''21.01.2015''' - Viimane arendussprint.

== Lisad ==

[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;

== Valmis Rakendus ==
*[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)]

Meeskond: Spooky Scary Skeletons

2016-01-21T00:00:22Z

Ssaks: /* Avaldatud failid */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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 ==

*'''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
*'''21.01.2015''' - Viimane arendussprint.

== Lisad ==

[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;

Meeskond: Spooky Scary Skeletons

2016-01-20T23:58:36Z

Ssaks: /* Arendusprotsess */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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)]

== 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
*'''21.01.2015''' - Viimane arendussprint.

== Lisad ==

[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;

Meeskond: Spooky Scary Skeletons

2016-01-19T23:06:50Z

Ssaks: /* Tehnoloogiad */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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)]

== 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

== Lisad ==

[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;

Meeskond: Spooky Scary Skeletons

2015-12-29T21:33:03Z

Ssaks: /* Tehnoloogiad */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[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, parooli ja juhuslikult genereeritud stringi 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.

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 vist 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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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)]

== 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

== Lisad ==

[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;

Meeskond: Spooky Scary Skeletons

2015-12-29T21:05:15Z

Ssaks: /* Projekti kirjeldus */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[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.

'''Autentikatsioon - Server'''

Kasutaja autentikatsioon toimub stateless auth mustrit kasutades.

Kasutaja autentimiseks saadab kasutaja oma kasutajanime, parooli ja juhuslikult genereeritud stringi 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.

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 vist 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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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)]

== 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

== Lisad ==

[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;

Meeskond: Spooky Scary Skeletons

2015-12-29T20:53:50Z

Ssaks: /* Tehnoloogiad */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[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/] lehele, sisse logida oma MITTE-ITK Microsoft kontoga, kinnitada ITK maili kaudu oma õpilase staatuse, ning seejärel saab Azure portalist Virtual Machines -> WebAPP+MySQL (ClearDB otsingusse ja leiab) virtuaalmasina.

'''Autentikatsioon - Server'''

Kasutaja autentikatsioon toimub stateless auth mustrit kasutades.

Kasutaja autentimiseks saadab kasutaja oma kasutajanime, parooli ja juhuslikult genereeritud stringi 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.

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 vist 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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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)]

== 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

== Lisad ==

[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;

Juhend: Kodutöö aines "Programmeerimine CSharp keeles" (2015)

2015-12-19T23:44:26Z

Ssaks: /* Meeskond: Spooky Scary Skeletons */

__NOINDEX__

=Kodutöö aines "Programmeerimine C# keeles"=

==Eesmärk==
Saada praktiline arenduskogemus .NET keskkonnas ning arendada meeskonnatöö kogemust ja analüüsivõimet. Kasutada arendusprotsessis koodihoidlat.

==Reeglid==
Ühte projektimeeskonda kuulub 3-5 tudengit(Soovituslik meeskonna suurus on 3-4). Ühel teemal võib teostada projekti üks või mitu meeskonda.Töö käiku kajastatakse https://wiki.itcollege.ee keskkonnas või soovi korral võib seda teha ka ajaveebis(blogis).
Ajaveebi pidamise eesmärke on kaks: nii on võimalik kirja panna kõik mõtted ja ideed (ning nendest jääb jälg ja dokumentatsioon) ning õppejõul on hiljem võimalik saada ülevaade iga projektimeeskonna liikme panusest. Ajaveebi loob ja ajaveebi haldab projektimeeskond vabalt valitud (avalikus) keskkonnas.

'''Projekti loomine ja arendamine '''
Projekt lisatakse versioonihaldusesse, kasutades selleks [Team Foundation Service'it http://tfs.visualstudio.com/] ning õppejõule antakse ligipääs. Õppejõu live id: maitposka ät hotmail.com . Projekt peab olema alates algfaasist lisatud TFSi ning kogu tööprotsess toimub versioonihaldust kasutades

'''Tööde esitamine''' (prototüüb ja lõpptoode)
Töö esitamisel pakitakse see kokku ning lisatakse wiki leheküljele link lähtekoodile. Kui töö lähtekoodi ei soovita mingil põhjusel avalikustata, tuleb õppejõuga selle jaoks sõlmida eraldi kokkulepe. Lähtekood on vajalik, et tööd oleks võimalik hinnata nii õppejõul kui kaastudengitel selle kohta retsensiooni kirjutada.

'''Team Foundation Service kasutamine''' (tänasel päeval '' Visual Studio online'')
[http://www.visualstudio.com/get-started/sign-up-for-visual-studio-online Step-by-Step juhend]

NB! Siia tuleb õppejõu poolt lihtne screencast ka, kuid ideeliselt ei tohiks selle kasutamine olla väga keeruline.

==Tähtaegadest kinnipidamine==
Projekt jaguneb alamosadeks, millele on määratud tähtajad. Tähtaegade ületamisel võimalike punkte ei kaotata. Kui töö aga on esitatud tähtajaks, siis on võimalik selle eest teenida boonuspunkte (enamasti 0-10% võimalikust maksimumist boonust). Enne tähtaega esitatud töö ei tähenda automaatselt maksimumpunkte, kui see ei ole sooritatud korralikult.

==Hindamine==
Teostatuks loetakse projekt juhul, kui lähteülesanne on realiseeritud, lahendus on töötav, kuid esineb suuremaid vigu ning piirsituatsioonidega ei ole arvestatud.
Maksimumtulemuse saavutamiseks peab projekt olema teostatud tehniliselt veatult ning varustatud dokumentatsiooniga, milles sisaldub arendusprotsessi kirjeldus (peab selguma ka iga rühmaliikme panus projekti teostamisel), kasutajajuhend ning lahenduse kirjeldus. Tehnilisi ja vormistuslike puudujääke on võimalik korvata lisavõimaluste realiseerimisega.Üldjuhul tuleb loodud lahendust ka praktikumides või loengutes teistele tudengitele tutvustada (ca 10 min).
Nagu eelpool mainitud, koosneb projekt erinevatest osadest. Punktide arvu määramisel arvestatakse ka tähtajast kinni pidamist, mille toimimisloogika on kirjeldatud eespool.

===Meeskonna kokkupanek ja idee===
'''25.10.2015''' (2p)

Tekitatakse meeskonna wiki lehekülg. Meeskonnal peab olema nimi ning see koosneb kolmest kuni viiest liikmest. Määratakse projektijuht. Juhul kui hakatakse blogi pidama kuskil mujal keskkonnas ilmub selle kohta link. Lühidalt peaks kirjeldama idee olemust nii, et selle üldine suund oleks arusaadav. Samuti peab olema märgitud tehnoloogia, milles hakatakse rakendust looma. Meeskond on loonud TFSi konto ning on saatnud õppejõule kutse.

===Analüüs===
'''01.11.2015''' (6p)
Analüütilise osa eesmärgiks on arendada tudengite analüüsioskust, mida on vaja ka päris tarkvaraarenduse protsessi juures.'''NB! Miinimum sõnade arv 700''' Selle osa käigus peab valmima loodava rakenduse analüüs, mis sisaldab muu hulgas ka:
*Analüüs rakendusele. (Mida see endas sisaldab? Mis on selle eesmärk? Mida tavakasutaja sellega teha saaks? Milliste osade realiseerimine võib osutuda problemaatiliseks?) Kui on tööjaotus paigas, siis tuua ka see välja.
*Tuua välja nimekiri funktsionaalsusest, mida plaanitakse kindlasti teostada(''Must have'')
*Nimekiri funktsionaalsustest, mis võiks olla, aga mida ei pruugita ajapuuduse tõttu realiseerida.(''Nice to have'')

'''Retsensioon''' 8.11.2015 (3p)

===Prototüüp===
'''13.12.2015 23:58'''(10p)

Valmib projekti esmane realisatsioon. Laias laastus on peafunktsionaalsused realiseeritud(Nimekiri funktsionaalsusest, mida plaanitakse teostada). Programmis võib esineda üksikuid, kuid mitte väga suuri vigu.

'''Retsensioon''' 20.12.2015(5p)

===Lõpptoode===
'''20.01.2016'''(20p)
Selleks faasiks peab projekt maksimumpuntkide saavutamiseks olema teostatud tehniliselt veatult ning varustatud dokumentatsiooniga, milles sisaldub arendusprotsessi kirjeldus (peab selguma ka iga rühmaliikme panus projekti teostamisel), kasutajajuhend ning lahenduse kirjeldus.

'''Retsensioon''' 27.01.2016(5p)

===Esitlus/Kaitsmine===

'''Toimub loengutes/praktikumides või kokkulepitud ajal enne eksamit''' ''(4p) ''
Esitlusel kaitstakse projekti. Tutvustatakse tehnoloogiat, mida kasutati rakenduse realiseerimiseks. Lühidalt räägitakse tööjaotusest ning probleemidest, mis tekkisid projekti realiseerimisel. Näidatakse lähtekoodi ja demonstreeritakse oma rakendust teistele tudengitele, kes võivad selle kohta küsimusi küsida. Kestvus ~20min.

====Kaitsmise ajad====

Tere, iga aja taha kirjutada meeskonna nimi, kes tuleb oma tööd kaitsma. Aegu palun täita võimaluse korral järjest.

Ideaalne esitlus, sisaldab endas ka powerpointi, kus on
*väljatoodud meeskonna nimi ja liikmed
*idee
*realiseerimine
*mis oli keerukas?
*mida uut õpiti?
*mõnede keerulisemate probleemide lahendamine
*meeskonnaliikmete panus

Kaitsmise käigus vaadatakse üle ka kood.

'''Esmaspäev''' - 14.12.2015
*14:00 - [https://wiki.itcollege.ee/index.php?title=Meeskond:_LetsDoIt LetsDoIt]
*14:15 -
*14:30 -
*14:45 -
*15:00 - Incman
*15:15 -

*16:00 -
*16:15 - [[Meeskond: Travo]]
*16:30 - GlobalElite
*16:45 - [https://wiki.itcollege.ee/index.php/BIT BIT]
*17:00 -
*17:15 - KTM Development
*17:30 -

'''Neljapäev''' - 17.12.2015
*08:15 - VVA
*08:30 - mc2
*08:45 -
*09:00 - Sporto
*09:15 - MinuKV
*09:30 -

*10:00 -Kodune raamat
*10:15 -
*10:30 - MSI
*10:45 -
*11:00 - Lebokeiss OÜ
*11:15 - OKVaatame

=Teemad 2015 sügis=
Kodutööna tuleb luua:

==Nõuded rakendusele==
Loodav rakendus peab:
* Peab kasutama andmebaasi (erikokkuleppel ka XML formaadis andmeallikat)
**Andmebaasis peab olema vähemalt 6 andmebaasi tabelit
* Peab võimaldama tegevuste kohta registri pidamist (logi)
**Rakenduses tehtavad tegevused salvestatakse
* Kasutama kasutajaliidesena ühte järgmistest: Windows Presentation Foundation, Windows Phone , Windows Store App või ASP.Net
* Kood on kommenteeritud ning rakendus on varustatud dokumentatsiooniga
* Maksimumpunktide jaoks kasutatakse vastavalt valitud tehnoloogiale soovitatud arendusmustreid
* Kood on kirjutatud C# programmeerimiskeeles
**Kuna aine nimi on "Programmeerimine C# keeles" ei tohi esitada rakendust, mis on loodud Javas, PHPs vms keeles
* Rakendus on jaotatud kihtidesse
'''Loodav rakendus peab olema loodud objektorienteeritud lähenemist kasutades!''' Klassid, klassid, klassid
*Kood on kommenteeritud

Lisapunkte annab:
* Silmailu
* Kood on kirjutatud häid praktikaid järgides ja on veatu(testimine, testimine, testimine)
* Orginaalsed ideed ja hea äriidee

==Kodune raamatukogu==
Kodudes on tihti erinevaid raamatuid (filme, muud nänni) ja sõbrad tahavad neid vahel laenutada.
Loo rakendus, mis
* Võimaldaks sisestada kodused raamatud
* Võimaldaks luua laenutajate profiile
* Raamatuid välja laenutada (tähtajaliselt)
* Laseks koostada erinevaid aruandeid (kodusolevad raamatud, väljalaenutatud raamatud, tähtaja ületanud laenutused jne)

Lisavõimalused
* Kui laenutaja profiilis on e-mail, siis saada automaatselt e-kiri „kallis sõber see ja see, Sinu käes on minu raamat, kas tood tagasi ka?”
* Kuva hoiatused, kui laenutaja laenutuste ajalugu on vilets või kui mõni raamat on tagastamata.
* Lase lisada raamatutele pilt
* Loo lihtne veebiliides (et sõbrad saaksid veebist vaadata, mis raamatud kasutajal kodus veel alles on)
Või

==CRM==
Oma klientidest peab olema ülevaade.
Loo rakendus, mis võimaldab:
* Kliente ning nende kontaktisikuid sisestada, muuta ning kustutada
* Võimalda sisestada kliendikontakte
* Koostada hinnapakkumisi klientidele, kusjuures hinnapakkumine lisatakse süsteemi ka kui kliendikontakt ning saadetakse samast süsteemist kliendile.
* Kliendi andmete vaatamisel kuvatakse ka kliendikontaktid

Lisavõimalused
* Loo võimalus, kus kontaktisiku sünnipäeva saabumisel saadetakse automaatselt inimesele meil õnnesoovidega
* Õnnitlusmeilide template’sid võiks olla mitu
* Loo võimalus kliendi huvide (huvialade) kajastamiseks süsteemis

==Mäng(Unit)==
Loodav mäng peab sisaldama:
* Erinevaid tasemeid
* Punktiarvestust
* XBox puldi tuge
* Klaviatuurilt juhtimise tuge

'''Loodav mäng peab olema loodud objektorienteeritud lähenemist kasutades!''' Klassid, klassid, klassid

Lisapunkte annab:
* Silmailu
* Kood on kirjutatud häid praktikaid järgides ja on veatu(testimine, testimine, testimine)
* Orginaalsed ideed ja hea ''story''

=Meeskonnad 2015=
==Päevaõpe==

===Meeskond: MinuKV===
Liikmed:
*Martin Luik
*Ahto Elken
*Silver Ohlo

Meeskonna koduleht: [[Meeskond: MinuKV]]

'''Retsensioonid'''

===Meeskond: Travo===
Liikmed:
*Tarvo Reinpalu
Meeskonna koduleht: [[Meeskond: Travo]]

'''Retsensioonid'''
===Meeskond: Freshmen===
Liikmed:
*Siim Haas - Projektijuht
*Piret Pomerants
*Semjon Greef

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_Freshmen Freshmen]

'''Retsensioonid'''

Retsensioon Qlibrium analüüsi [https://wiki.itcollege.ee/index.php/Talk:Qlibrium kohta]

===Meeskond: mc2===
Liikmed:
*Martin Betlem
*Johannes Tamm
*Martin Mägi
*Jana Pipar

Meeskonna koduleht: [[Meeskond: mc2]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Retsensioon_MinuKV_kohta#Retsensioon_MinuKV_kohta Retsensioon MinuKV kohta]

'''Prototüüp'''

Meie prototüüp asub [https://wiki.itcollege.ee/index.php/Meeskond:_mc2#Protot.C3.BC.C3.BCp SIIN]

===Meeskond: Sporto===
Liikmed:
*Kelli Lukas
*Vladimir Rõkovanov
*Alar Ameerikas
*Mikk Raudsepp
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Sporto Sporto]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_KTM_Development Retsensioon meeskonna KTM Development projekti analüüsile]

'''Prototüüp'''

[https://onedrive.live.com/redir?resid=B04DA53E21E8691B!30244&authkey=!AO2gXYl6yrrc1HM&ithint=file%2c7z Laadi alla]

'''Lõpptoode'''

[http://1drv.ms/1lSbvJz Laadi alla]

===Meeskond: LetsDoIt===
Liikmed:
*Liisa Suurkaev(projektijuht)
*Melissa Eenmaa
*Tanel Vähk
*Taavi Kliss
*Aleks Luik
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_LetsDoIt LetsDoIt]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale LendBook asub [https://wiki.itcollege.ee/index.php/Talk:LendBook retsensioon siin].

===Meeskond: VVA===
Liikmed:
*Vladislav Lahtarin
*Vladislav Kovaltšuk
*Aleksandr Babõkin

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_VVA Meeskond:_VVA]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale Sporto asub [https://wiki.itcollege.ee/index.php/Meeskond:_VVA#Anal.C3.BC.C3.BCsi_retsensioon_meeskonnale_.22Sporto.22 siin]

Prototüübi retsensioon meeskonnale mc2 asub [https://wiki.itcollege.ee/index.php/Meeskond:_VVA#Protot.C3.BC.C3.BCbi_retsensioon_meeskonnale_.22mc2.22 siin]

'''Prototüüp'''

[http://enos.itcollege.ee/~vkovalt/Csharp/Desktop.html Mäng] ja [http://enos.itcollege.ee/~vkovalt/LaeAllaProto/ lähtekood]

===Meeskond: IncMan===
Liikmed:
*Sergei Fatejev
*Nele Sergejeva
*Marko Koiduste
*Kaspar Tilk
*Jaanus Türnpuu

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Incman IncMan]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale '''LetsDoIt''' asub [https://wiki.itcollege.ee/index.php/Talk:Meeskond:_LetsDoIt siin]

===Meeskond: Lebokeiss OÜ===
Liikmed:
*Joonas Jõeleht - Projektijuht
*Iris Tambaum
*Timo Lanno
*Karell Veskimeister
*Kerli Edasi

Meeskonna koduleht: [[Meeskond:_Lebokeiss_OÜ]]

'''Retsensioonid'''

[[Talk:Meeskond:_Travo | Retsensioon meeskond Travo analüüsile]]

[[Talk:Meeskond:_Travo#Retsensioon_meeskond_Travo_projekti_protot.C3.BC.C3.BCbile | Retsensioon meeskond Travo prototüübile]]

===Meeskond: MSI===
Liikmed:
*Siim Ivask
*Martin Saar
*Indrek Tamm

Meeskonna koduleht: [[Meeskond: MSI]]

===Meeskond: LendBook===
Liikmed:
*Egle Arge
*Liina Kolk

Meeskonna koduleht: [[LendBook]]

'''Retsensioonid'''

[[Talk:PenguinHorde | Retsensioon meeskonna PenguinHorde analüüsile]]

===Meeskond: BIT===
Liikmed:
*Merilyn Renser
*Marko Hartikainen
*Ants Kristjan Rooma
*Konstantin Burdakov

Meeskonna koduleht: [[BIT]]

'''Retsensioonid''' 
[[VVA analüüsi retsensioon]]

===Meeskond: PenguinHorde===
Liikmed:
*Laura Leon
*Marko Saluste
*Terje Sõelsepp
*Mari-Liis Oldja
Meeskonna koduleht: [[PenguinHorde]]

'''Retsensioonid'''
Retsensioon [https://wiki.itcollege.ee/index.php/Talk:BIT meeskond BIT] analüüsile.

===Meeskond: GlobalElite===
Liikmed:
*Marek Kivikink
*Indrek Nurja
*Imre Teras
*Aapo Kersalu
*Erling Tammisto
Meeskonna koduleht: [[GlobalLite]]

'''Prototüüp'''
[https://www.dropbox.com/s/i7i01x3450umarh/GlobalElite_proto.rar?dl=0 Lae alla (RAR fail)]

'''Retsensioonid'''

===Meeskond: KTM Development===
Liikmed:
*Kristian Laupa
*Tauno Otti
*Mart Abel
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_KTM_Development KTM Development]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale '''mc2''' asub [https://wiki.itcollege.ee/index.php/User_talk:Klaupa siin]

===Meeskond: Bob?===
Liige:
*Priit Aarne

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Bob Bob?]

'''Retsensioonid'''

[[Meeskonna IncMan analüüsi retsensioon]]

===Meeskond: RJ===
Liige:
*Richard Jalonen
Meeskonna koduleht: [[RJ]]

===Meeskond: Qlibrium===
Liige:
*Karl Frank
Meeskonna koduleht [[Qlibrium]]

'''Retsensioon'''
[https://wiki.itcollege.ee/index.php/Talk:Retsensioon_GlobalLite_*#Meeskonna_GlobalLite_anal.C3.BC.C3.BCsi_retsensioon]

===Meeskond: Kodune Raamat===
Liikmed:
*Siim Osa
*Taavi Kivimaa
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_Kodune_Raamat Kodune Raamat]

'''Retsensioonid'''

===Meeskond: TaTa===
Liikmed:
*Talis Tammearu
Meeskonna koduleht: [[Meeskond:TaTa]]

===Meeskond: Ktreikel===
Liikmed:
*Kert Treikelder
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_ktreikel]

[[Category: Programmeerimine CSharp keeles (2015) (Päevaõpe)]]

==Kaugõpe==
===Meeskond: Premium===
Liikmed:
*Tarmo Petrovits
*Karin Talumäe
*Jevgeni Gavrilov

Meeskonna koduleht: [[Meeskond: Premium]]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale '''LIB''' asub [https://wiki.itcollege.ee/index.php/Talk:Meeskond:_LIB siin]

===Meeskond: Spooky Scary Skeletons===
Liikmed:
*Kärt Palm DK22
*Karina Egipt DK22 (Projektijuht)
*Erika Ehmann D32
*Silver Saks AK21

Meeskonna koduleht: [[Meeskond: Spooky Scary Skeletons]]

'''[https://pilv.mana.ee/public.php?service=files&t=0e79ef0570f39b8743f046c70f724404 Esimene Prototüüp (13.12.2015)]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Premium Retsensioon meeskonna Premium projekti HomeLibrary analüüsile]

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Fontastic#Retsensioon_protot.C3.BC.C3.BCbile Retsensioon meeskonna Fontastic projekti Fontastic prototüübile]

=== Meeskond: Nocturne No. 20 in C-sharp Minor ===
Liikmed:
*10142848 (Projektijuht)
*10090107
*10143193
*10143313

Meeskonna koduleht: [[Meeskond: Nocturne No. 20 in C-sharp Minor]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Fontastic Retsensioon meeskonna Fontastic rakenduse analüüsile]

===Meeskond: LIB===
Liikmed:
*Sigrid Pachel DK22 (Projektijuht)
*Diana Nikolajeva DK22
*Kristjan Adrat DK41

Meeskonna koduleht: [[Meeskond: LIB]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond_Mardo Analüüsi retsensioon Mardo meeskonnale]

===Meeskond: Greek?Mark===
Liikmed:
*Karit Kilgi DK22 (Projektijuht)
*Sten Kaasik DK22
*Siim Veskilt DK22

Meeskonna koduleht: [[Meeskond: GreekQMark]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Spooky_Scary_Skeletons Retsensioon meeskonna Spooky Scary Skeletons rakenduse AVE 2.0 analüüsile]

===Meeskond: Tarraxacum===
Liikmed:
*Silja Kralik DK21 (Projektijuht)
*Liina Laumets DK21
*Ragne Auling DK22

Meeskonna koduleht: [[Meeskond: Tarraxacum]]

[[Retsensioon meeskonnale Põhjavesi]]

===Meeskond: Fontastic===
Liikmed:
*Erik Hirmo DK22 (Projektijuht)
*Piret Reinumägi DK21

Meeskonna koduleht: [[Meeskond: Fontastic]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Konsa Retsensioon meeskonna Konsa projekti Ostukorv analüüsile]

===Meeskond: TTT===
Liikmed:
*Ave Karjus DK22
*Joonatan Uusväli DK22 (Projektijuht)
*Kaidar Viikman DK21 (Wiki pidaja)
*Oliver Tiks AK21

Meeskonna koduleht: [[Meeskond: TTT (Trellid Teevad Tugevaks) | TTT (Trellid Teevad Tugevaks)]]

'''Retsensioonid'''

[[Talk:Meeskond:_GreekQMark#section=1 | Retsensioon meeskonna Greek?Mark projekti analüüsile]]

===Meeskond: Codezilla===
Liikmed:
*Anna Linskaja DK21 (Projektijuht)
*Alisa Dudinova DK21
*Sergei Hristoforov DK21

Meeskonna koduleht: [[Codezilla]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Maker Retsensioon meeskonna Maker projekti analüüsile]

===Meeskond: Konsa===
Liikmed:

*Marko Konsa DK13

Meeskonna koduleht: [[Ostukorv]]

'''Retsensioonid'''
===Meeskond: Johhaidii===
Liikmed:
*Yogesh Sharma
*Juhan Trink
*Marju Niinemaa

Meeskonna koduleht: [[Johhaidii]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Retsensioon_Makerile Retsensioon meeskonna Maker analüüsile]

===Meeskond: Sildur===
Liikmed:
*Andreas Papp (Projektijuht)
*Germo Väli
*Andres Trei

Meeskonna koduleht: [[Sildur]]

'''Retsensioonid'''
===Meeskond: JT===
Liikmed:
*Tõnis Luik (Projektijuht)
*Juri Nikitin

Meeskonna koduleht: [[JT]]

'''Retsensioonid'''

===Meeskond: Maker===
Liikmed:
*Marek Öövel (Projektijuht)

Meeskonna koduleht: [[Maker]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Codezilla Retsensioon meeskonna Codezilla analüüsile]

===Meeskond: Põhjavesi===
Liikmed
*Indrek Pruul (Projektijuht)
*Jan Eerik
*Eeva Koplimets

Meeskonna koduleht: [[Pohjavesi]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Pohjavesi Retsensioon meeskonnale Spooky Scary Skeletons analüüsile]

===Meeskond: MMTL development===
Liikmed
*Martin Mänd (Projektijuht)
*Taavi Lõhmus

Meeskonna koduleht: [[Meeskond: MMTL development]]

'''Retsensioonid'''

===Meeskond: Mardo===
Liikmed:
*Mardo Halapuu
Meeskonna koduleht:[https://wiki.itcollege.ee/index.php/Meeskond_Mardo Mardo]

Juhend: Kodutöö aines "Programmeerimine CSharp keeles" (2015)

2015-12-19T23:44:18Z

Ssaks: /* Meeskond: Spooky Scary Skeletons */

__NOINDEX__

=Kodutöö aines "Programmeerimine C# keeles"=

==Eesmärk==
Saada praktiline arenduskogemus .NET keskkonnas ning arendada meeskonnatöö kogemust ja analüüsivõimet. Kasutada arendusprotsessis koodihoidlat.

==Reeglid==
Ühte projektimeeskonda kuulub 3-5 tudengit(Soovituslik meeskonna suurus on 3-4). Ühel teemal võib teostada projekti üks või mitu meeskonda.Töö käiku kajastatakse https://wiki.itcollege.ee keskkonnas või soovi korral võib seda teha ka ajaveebis(blogis).
Ajaveebi pidamise eesmärke on kaks: nii on võimalik kirja panna kõik mõtted ja ideed (ning nendest jääb jälg ja dokumentatsioon) ning õppejõul on hiljem võimalik saada ülevaade iga projektimeeskonna liikme panusest. Ajaveebi loob ja ajaveebi haldab projektimeeskond vabalt valitud (avalikus) keskkonnas.

'''Projekti loomine ja arendamine '''
Projekt lisatakse versioonihaldusesse, kasutades selleks [Team Foundation Service'it http://tfs.visualstudio.com/] ning õppejõule antakse ligipääs. Õppejõu live id: maitposka ät hotmail.com . Projekt peab olema alates algfaasist lisatud TFSi ning kogu tööprotsess toimub versioonihaldust kasutades

'''Tööde esitamine''' (prototüüb ja lõpptoode)
Töö esitamisel pakitakse see kokku ning lisatakse wiki leheküljele link lähtekoodile. Kui töö lähtekoodi ei soovita mingil põhjusel avalikustata, tuleb õppejõuga selle jaoks sõlmida eraldi kokkulepe. Lähtekood on vajalik, et tööd oleks võimalik hinnata nii õppejõul kui kaastudengitel selle kohta retsensiooni kirjutada.

'''Team Foundation Service kasutamine''' (tänasel päeval '' Visual Studio online'')
[http://www.visualstudio.com/get-started/sign-up-for-visual-studio-online Step-by-Step juhend]

NB! Siia tuleb õppejõu poolt lihtne screencast ka, kuid ideeliselt ei tohiks selle kasutamine olla väga keeruline.

==Tähtaegadest kinnipidamine==
Projekt jaguneb alamosadeks, millele on määratud tähtajad. Tähtaegade ületamisel võimalike punkte ei kaotata. Kui töö aga on esitatud tähtajaks, siis on võimalik selle eest teenida boonuspunkte (enamasti 0-10% võimalikust maksimumist boonust). Enne tähtaega esitatud töö ei tähenda automaatselt maksimumpunkte, kui see ei ole sooritatud korralikult.

==Hindamine==
Teostatuks loetakse projekt juhul, kui lähteülesanne on realiseeritud, lahendus on töötav, kuid esineb suuremaid vigu ning piirsituatsioonidega ei ole arvestatud.
Maksimumtulemuse saavutamiseks peab projekt olema teostatud tehniliselt veatult ning varustatud dokumentatsiooniga, milles sisaldub arendusprotsessi kirjeldus (peab selguma ka iga rühmaliikme panus projekti teostamisel), kasutajajuhend ning lahenduse kirjeldus. Tehnilisi ja vormistuslike puudujääke on võimalik korvata lisavõimaluste realiseerimisega.Üldjuhul tuleb loodud lahendust ka praktikumides või loengutes teistele tudengitele tutvustada (ca 10 min).
Nagu eelpool mainitud, koosneb projekt erinevatest osadest. Punktide arvu määramisel arvestatakse ka tähtajast kinni pidamist, mille toimimisloogika on kirjeldatud eespool.

===Meeskonna kokkupanek ja idee===
'''25.10.2015''' (2p)

Tekitatakse meeskonna wiki lehekülg. Meeskonnal peab olema nimi ning see koosneb kolmest kuni viiest liikmest. Määratakse projektijuht. Juhul kui hakatakse blogi pidama kuskil mujal keskkonnas ilmub selle kohta link. Lühidalt peaks kirjeldama idee olemust nii, et selle üldine suund oleks arusaadav. Samuti peab olema märgitud tehnoloogia, milles hakatakse rakendust looma. Meeskond on loonud TFSi konto ning on saatnud õppejõule kutse.

===Analüüs===
'''01.11.2015''' (6p)
Analüütilise osa eesmärgiks on arendada tudengite analüüsioskust, mida on vaja ka päris tarkvaraarenduse protsessi juures.'''NB! Miinimum sõnade arv 700''' Selle osa käigus peab valmima loodava rakenduse analüüs, mis sisaldab muu hulgas ka:
*Analüüs rakendusele. (Mida see endas sisaldab? Mis on selle eesmärk? Mida tavakasutaja sellega teha saaks? Milliste osade realiseerimine võib osutuda problemaatiliseks?) Kui on tööjaotus paigas, siis tuua ka see välja.
*Tuua välja nimekiri funktsionaalsusest, mida plaanitakse kindlasti teostada(''Must have'')
*Nimekiri funktsionaalsustest, mis võiks olla, aga mida ei pruugita ajapuuduse tõttu realiseerida.(''Nice to have'')

'''Retsensioon''' 8.11.2015 (3p)

===Prototüüp===
'''13.12.2015 23:58'''(10p)

Valmib projekti esmane realisatsioon. Laias laastus on peafunktsionaalsused realiseeritud(Nimekiri funktsionaalsusest, mida plaanitakse teostada). Programmis võib esineda üksikuid, kuid mitte väga suuri vigu.

'''Retsensioon''' 20.12.2015(5p)

===Lõpptoode===
'''20.01.2016'''(20p)
Selleks faasiks peab projekt maksimumpuntkide saavutamiseks olema teostatud tehniliselt veatult ning varustatud dokumentatsiooniga, milles sisaldub arendusprotsessi kirjeldus (peab selguma ka iga rühmaliikme panus projekti teostamisel), kasutajajuhend ning lahenduse kirjeldus.

'''Retsensioon''' 27.01.2016(5p)

===Esitlus/Kaitsmine===

'''Toimub loengutes/praktikumides või kokkulepitud ajal enne eksamit''' ''(4p) ''
Esitlusel kaitstakse projekti. Tutvustatakse tehnoloogiat, mida kasutati rakenduse realiseerimiseks. Lühidalt räägitakse tööjaotusest ning probleemidest, mis tekkisid projekti realiseerimisel. Näidatakse lähtekoodi ja demonstreeritakse oma rakendust teistele tudengitele, kes võivad selle kohta küsimusi küsida. Kestvus ~20min.

====Kaitsmise ajad====

Tere, iga aja taha kirjutada meeskonna nimi, kes tuleb oma tööd kaitsma. Aegu palun täita võimaluse korral järjest.

Ideaalne esitlus, sisaldab endas ka powerpointi, kus on
*väljatoodud meeskonna nimi ja liikmed
*idee
*realiseerimine
*mis oli keerukas?
*mida uut õpiti?
*mõnede keerulisemate probleemide lahendamine
*meeskonnaliikmete panus

Kaitsmise käigus vaadatakse üle ka kood.

'''Esmaspäev''' - 14.12.2015
*14:00 - [https://wiki.itcollege.ee/index.php?title=Meeskond:_LetsDoIt LetsDoIt]
*14:15 -
*14:30 -
*14:45 -
*15:00 - Incman
*15:15 -

*16:00 -
*16:15 - [[Meeskond: Travo]]
*16:30 - GlobalElite
*16:45 - [https://wiki.itcollege.ee/index.php/BIT BIT]
*17:00 -
*17:15 - KTM Development
*17:30 -

'''Neljapäev''' - 17.12.2015
*08:15 - VVA
*08:30 - mc2
*08:45 -
*09:00 - Sporto
*09:15 - MinuKV
*09:30 -

*10:00 -Kodune raamat
*10:15 -
*10:30 - MSI
*10:45 -
*11:00 - Lebokeiss OÜ
*11:15 - OKVaatame

=Teemad 2015 sügis=
Kodutööna tuleb luua:

==Nõuded rakendusele==
Loodav rakendus peab:
* Peab kasutama andmebaasi (erikokkuleppel ka XML formaadis andmeallikat)
**Andmebaasis peab olema vähemalt 6 andmebaasi tabelit
* Peab võimaldama tegevuste kohta registri pidamist (logi)
**Rakenduses tehtavad tegevused salvestatakse
* Kasutama kasutajaliidesena ühte järgmistest: Windows Presentation Foundation, Windows Phone , Windows Store App või ASP.Net
* Kood on kommenteeritud ning rakendus on varustatud dokumentatsiooniga
* Maksimumpunktide jaoks kasutatakse vastavalt valitud tehnoloogiale soovitatud arendusmustreid
* Kood on kirjutatud C# programmeerimiskeeles
**Kuna aine nimi on "Programmeerimine C# keeles" ei tohi esitada rakendust, mis on loodud Javas, PHPs vms keeles
* Rakendus on jaotatud kihtidesse
'''Loodav rakendus peab olema loodud objektorienteeritud lähenemist kasutades!''' Klassid, klassid, klassid
*Kood on kommenteeritud

Lisapunkte annab:
* Silmailu
* Kood on kirjutatud häid praktikaid järgides ja on veatu(testimine, testimine, testimine)
* Orginaalsed ideed ja hea äriidee

==Kodune raamatukogu==
Kodudes on tihti erinevaid raamatuid (filme, muud nänni) ja sõbrad tahavad neid vahel laenutada.
Loo rakendus, mis
* Võimaldaks sisestada kodused raamatud
* Võimaldaks luua laenutajate profiile
* Raamatuid välja laenutada (tähtajaliselt)
* Laseks koostada erinevaid aruandeid (kodusolevad raamatud, väljalaenutatud raamatud, tähtaja ületanud laenutused jne)

Lisavõimalused
* Kui laenutaja profiilis on e-mail, siis saada automaatselt e-kiri „kallis sõber see ja see, Sinu käes on minu raamat, kas tood tagasi ka?”
* Kuva hoiatused, kui laenutaja laenutuste ajalugu on vilets või kui mõni raamat on tagastamata.
* Lase lisada raamatutele pilt
* Loo lihtne veebiliides (et sõbrad saaksid veebist vaadata, mis raamatud kasutajal kodus veel alles on)
Või

==CRM==
Oma klientidest peab olema ülevaade.
Loo rakendus, mis võimaldab:
* Kliente ning nende kontaktisikuid sisestada, muuta ning kustutada
* Võimalda sisestada kliendikontakte
* Koostada hinnapakkumisi klientidele, kusjuures hinnapakkumine lisatakse süsteemi ka kui kliendikontakt ning saadetakse samast süsteemist kliendile.
* Kliendi andmete vaatamisel kuvatakse ka kliendikontaktid

Lisavõimalused
* Loo võimalus, kus kontaktisiku sünnipäeva saabumisel saadetakse automaatselt inimesele meil õnnesoovidega
* Õnnitlusmeilide template’sid võiks olla mitu
* Loo võimalus kliendi huvide (huvialade) kajastamiseks süsteemis

==Mäng(Unit)==
Loodav mäng peab sisaldama:
* Erinevaid tasemeid
* Punktiarvestust
* XBox puldi tuge
* Klaviatuurilt juhtimise tuge

'''Loodav mäng peab olema loodud objektorienteeritud lähenemist kasutades!''' Klassid, klassid, klassid

Lisapunkte annab:
* Silmailu
* Kood on kirjutatud häid praktikaid järgides ja on veatu(testimine, testimine, testimine)
* Orginaalsed ideed ja hea ''story''

=Meeskonnad 2015=
==Päevaõpe==

===Meeskond: MinuKV===
Liikmed:
*Martin Luik
*Ahto Elken
*Silver Ohlo

Meeskonna koduleht: [[Meeskond: MinuKV]]

'''Retsensioonid'''

===Meeskond: Travo===
Liikmed:
*Tarvo Reinpalu
Meeskonna koduleht: [[Meeskond: Travo]]

'''Retsensioonid'''
===Meeskond: Freshmen===
Liikmed:
*Siim Haas - Projektijuht
*Piret Pomerants
*Semjon Greef

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_Freshmen Freshmen]

'''Retsensioonid'''

Retsensioon Qlibrium analüüsi [https://wiki.itcollege.ee/index.php/Talk:Qlibrium kohta]

===Meeskond: mc2===
Liikmed:
*Martin Betlem
*Johannes Tamm
*Martin Mägi
*Jana Pipar

Meeskonna koduleht: [[Meeskond: mc2]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Retsensioon_MinuKV_kohta#Retsensioon_MinuKV_kohta Retsensioon MinuKV kohta]

'''Prototüüp'''

Meie prototüüp asub [https://wiki.itcollege.ee/index.php/Meeskond:_mc2#Protot.C3.BC.C3.BCp SIIN]

===Meeskond: Sporto===
Liikmed:
*Kelli Lukas
*Vladimir Rõkovanov
*Alar Ameerikas
*Mikk Raudsepp
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Sporto Sporto]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_KTM_Development Retsensioon meeskonna KTM Development projekti analüüsile]

'''Prototüüp'''

[https://onedrive.live.com/redir?resid=B04DA53E21E8691B!30244&authkey=!AO2gXYl6yrrc1HM&ithint=file%2c7z Laadi alla]

'''Lõpptoode'''

[http://1drv.ms/1lSbvJz Laadi alla]

===Meeskond: LetsDoIt===
Liikmed:
*Liisa Suurkaev(projektijuht)
*Melissa Eenmaa
*Tanel Vähk
*Taavi Kliss
*Aleks Luik
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_LetsDoIt LetsDoIt]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale LendBook asub [https://wiki.itcollege.ee/index.php/Talk:LendBook retsensioon siin].

===Meeskond: VVA===
Liikmed:
*Vladislav Lahtarin
*Vladislav Kovaltšuk
*Aleksandr Babõkin

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_VVA Meeskond:_VVA]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale Sporto asub [https://wiki.itcollege.ee/index.php/Meeskond:_VVA#Anal.C3.BC.C3.BCsi_retsensioon_meeskonnale_.22Sporto.22 siin]

Prototüübi retsensioon meeskonnale mc2 asub [https://wiki.itcollege.ee/index.php/Meeskond:_VVA#Protot.C3.BC.C3.BCbi_retsensioon_meeskonnale_.22mc2.22 siin]

'''Prototüüp'''

[http://enos.itcollege.ee/~vkovalt/Csharp/Desktop.html Mäng] ja [http://enos.itcollege.ee/~vkovalt/LaeAllaProto/ lähtekood]

===Meeskond: IncMan===
Liikmed:
*Sergei Fatejev
*Nele Sergejeva
*Marko Koiduste
*Kaspar Tilk
*Jaanus Türnpuu

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Incman IncMan]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale '''LetsDoIt''' asub [https://wiki.itcollege.ee/index.php/Talk:Meeskond:_LetsDoIt siin]

===Meeskond: Lebokeiss OÜ===
Liikmed:
*Joonas Jõeleht - Projektijuht
*Iris Tambaum
*Timo Lanno
*Karell Veskimeister
*Kerli Edasi

Meeskonna koduleht: [[Meeskond:_Lebokeiss_OÜ]]

'''Retsensioonid'''

[[Talk:Meeskond:_Travo | Retsensioon meeskond Travo analüüsile]]

[[Talk:Meeskond:_Travo#Retsensioon_meeskond_Travo_projekti_protot.C3.BC.C3.BCbile | Retsensioon meeskond Travo prototüübile]]

===Meeskond: MSI===
Liikmed:
*Siim Ivask
*Martin Saar
*Indrek Tamm

Meeskonna koduleht: [[Meeskond: MSI]]

===Meeskond: LendBook===
Liikmed:
*Egle Arge
*Liina Kolk

Meeskonna koduleht: [[LendBook]]

'''Retsensioonid'''

[[Talk:PenguinHorde | Retsensioon meeskonna PenguinHorde analüüsile]]

===Meeskond: BIT===
Liikmed:
*Merilyn Renser
*Marko Hartikainen
*Ants Kristjan Rooma
*Konstantin Burdakov

Meeskonna koduleht: [[BIT]]

'''Retsensioonid''' 
[[VVA analüüsi retsensioon]]

===Meeskond: PenguinHorde===
Liikmed:
*Laura Leon
*Marko Saluste
*Terje Sõelsepp
*Mari-Liis Oldja
Meeskonna koduleht: [[PenguinHorde]]

'''Retsensioonid'''
Retsensioon [https://wiki.itcollege.ee/index.php/Talk:BIT meeskond BIT] analüüsile.

===Meeskond: GlobalElite===
Liikmed:
*Marek Kivikink
*Indrek Nurja
*Imre Teras
*Aapo Kersalu
*Erling Tammisto
Meeskonna koduleht: [[GlobalLite]]

'''Prototüüp'''
[https://www.dropbox.com/s/i7i01x3450umarh/GlobalElite_proto.rar?dl=0 Lae alla (RAR fail)]

'''Retsensioonid'''

===Meeskond: KTM Development===
Liikmed:
*Kristian Laupa
*Tauno Otti
*Mart Abel
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_KTM_Development KTM Development]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale '''mc2''' asub [https://wiki.itcollege.ee/index.php/User_talk:Klaupa siin]

===Meeskond: Bob?===
Liige:
*Priit Aarne

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Bob Bob?]

'''Retsensioonid'''

[[Meeskonna IncMan analüüsi retsensioon]]

===Meeskond: RJ===
Liige:
*Richard Jalonen
Meeskonna koduleht: [[RJ]]

===Meeskond: Qlibrium===
Liige:
*Karl Frank
Meeskonna koduleht [[Qlibrium]]

'''Retsensioon'''
[https://wiki.itcollege.ee/index.php/Talk:Retsensioon_GlobalLite_*#Meeskonna_GlobalLite_anal.C3.BC.C3.BCsi_retsensioon]

===Meeskond: Kodune Raamat===
Liikmed:
*Siim Osa
*Taavi Kivimaa
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_Kodune_Raamat Kodune Raamat]

'''Retsensioonid'''

===Meeskond: TaTa===
Liikmed:
*Talis Tammearu
Meeskonna koduleht: [[Meeskond:TaTa]]

===Meeskond: Ktreikel===
Liikmed:
*Kert Treikelder
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_ktreikel]

[[Category: Programmeerimine CSharp keeles (2015) (Päevaõpe)]]

==Kaugõpe==
===Meeskond: Premium===
Liikmed:
*Tarmo Petrovits
*Karin Talumäe
*Jevgeni Gavrilov

Meeskonna koduleht: [[Meeskond: Premium]]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale '''LIB''' asub [https://wiki.itcollege.ee/index.php/Talk:Meeskond:_LIB siin]

===Meeskond: Spooky Scary Skeletons===
Liikmed:
*Kärt Palm DK22
*Karina Egipt DK22 (Projektijuht)
*Erika Ehmann D32
*Silver Saks AK21

Meeskonna koduleht: [[Meeskond: Spooky Scary Skeletons]]

'''[https://pilv.mana.ee/public.php?service=files&t=0e79ef0570f39b8743f046c70f724404 Esimene Prototüüp (13.12.2015)]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Premium Retsensioon meeskonna Premium projekti HomeLibrary analüüsile]
[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Fontastic#Retsensioon_protot.C3.BC.C3.BCbile Retsensioon meeskonna Fontastic projekti Fontastic prototüübile]

=== Meeskond: Nocturne No. 20 in C-sharp Minor ===
Liikmed:
*10142848 (Projektijuht)
*10090107
*10143193
*10143313

Meeskonna koduleht: [[Meeskond: Nocturne No. 20 in C-sharp Minor]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Fontastic Retsensioon meeskonna Fontastic rakenduse analüüsile]

===Meeskond: LIB===
Liikmed:
*Sigrid Pachel DK22 (Projektijuht)
*Diana Nikolajeva DK22
*Kristjan Adrat DK41

Meeskonna koduleht: [[Meeskond: LIB]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond_Mardo Analüüsi retsensioon Mardo meeskonnale]

===Meeskond: Greek?Mark===
Liikmed:
*Karit Kilgi DK22 (Projektijuht)
*Sten Kaasik DK22
*Siim Veskilt DK22

Meeskonna koduleht: [[Meeskond: GreekQMark]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Spooky_Scary_Skeletons Retsensioon meeskonna Spooky Scary Skeletons rakenduse AVE 2.0 analüüsile]

===Meeskond: Tarraxacum===
Liikmed:
*Silja Kralik DK21 (Projektijuht)
*Liina Laumets DK21
*Ragne Auling DK22

Meeskonna koduleht: [[Meeskond: Tarraxacum]]

[[Retsensioon meeskonnale Põhjavesi]]

===Meeskond: Fontastic===
Liikmed:
*Erik Hirmo DK22 (Projektijuht)
*Piret Reinumägi DK21

Meeskonna koduleht: [[Meeskond: Fontastic]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Konsa Retsensioon meeskonna Konsa projekti Ostukorv analüüsile]

===Meeskond: TTT===
Liikmed:
*Ave Karjus DK22
*Joonatan Uusväli DK22 (Projektijuht)
*Kaidar Viikman DK21 (Wiki pidaja)
*Oliver Tiks AK21

Meeskonna koduleht: [[Meeskond: TTT (Trellid Teevad Tugevaks) | TTT (Trellid Teevad Tugevaks)]]

'''Retsensioonid'''

[[Talk:Meeskond:_GreekQMark#section=1 | Retsensioon meeskonna Greek?Mark projekti analüüsile]]

===Meeskond: Codezilla===
Liikmed:
*Anna Linskaja DK21 (Projektijuht)
*Alisa Dudinova DK21
*Sergei Hristoforov DK21

Meeskonna koduleht: [[Codezilla]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Maker Retsensioon meeskonna Maker projekti analüüsile]

===Meeskond: Konsa===
Liikmed:

*Marko Konsa DK13

Meeskonna koduleht: [[Ostukorv]]

'''Retsensioonid'''
===Meeskond: Johhaidii===
Liikmed:
*Yogesh Sharma
*Juhan Trink
*Marju Niinemaa

Meeskonna koduleht: [[Johhaidii]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Retsensioon_Makerile Retsensioon meeskonna Maker analüüsile]

===Meeskond: Sildur===
Liikmed:
*Andreas Papp (Projektijuht)
*Germo Väli
*Andres Trei

Meeskonna koduleht: [[Sildur]]

'''Retsensioonid'''
===Meeskond: JT===
Liikmed:
*Tõnis Luik (Projektijuht)
*Juri Nikitin

Meeskonna koduleht: [[JT]]

'''Retsensioonid'''

===Meeskond: Maker===
Liikmed:
*Marek Öövel (Projektijuht)

Meeskonna koduleht: [[Maker]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Codezilla Retsensioon meeskonna Codezilla analüüsile]

===Meeskond: Põhjavesi===
Liikmed
*Indrek Pruul (Projektijuht)
*Jan Eerik
*Eeva Koplimets

Meeskonna koduleht: [[Pohjavesi]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Pohjavesi Retsensioon meeskonnale Spooky Scary Skeletons analüüsile]

===Meeskond: MMTL development===
Liikmed
*Martin Mänd (Projektijuht)
*Taavi Lõhmus

Meeskonna koduleht: [[Meeskond: MMTL development]]

'''Retsensioonid'''

===Meeskond: Mardo===
Liikmed:
*Mardo Halapuu
Meeskonna koduleht:[https://wiki.itcollege.ee/index.php/Meeskond_Mardo Mardo]

Meeskond: Spooky Scary Skeletons

2015-12-19T23:43:10Z

Ssaks: /* Arendusprotsess */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[https://msdn.microsoft.com/en-us/library/dd203052.aspx REST]

Server kasutab klientidega suhtluseks RESTful apit ja JSON andmeformaati.

'''Autentikatsioon - Server'''

Kasutaja autentikatsioon toimub stateless auth mustrit kasutades.

Kasutaja autentimiseks saadab kasutaja oma kasutajanime, parooli ja juhuslikult genereeritud stringi 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.

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 vist 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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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)]

== 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

== Lisad ==

[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;

Talk:Meeskond: Fontastic

2015-12-19T23:42:11Z

Ssaks: /* Retsensioon prototüübile */

== Retsensioon analüüsile ==

Käesolev retsensiooni on koostatud meeskonna Fontastic analüüsile fontidest ülevaate saamiseks ja nende haldamiseks loodavale töölaua rakendusele. Analüüsi retsenseerimisel on lähtutud juhendis [https://wiki.itcollege.ee/index.php/Juhend:_Kodut%C3%B6%C3%B6_aines_%22Programmeerimine_CSharp_keeles%22_(2015) “Kodutöö aines “Programmeerimine CSharp keeles” (2015)”] projekti analüüsi kohta toodud nõuetest ning võrreldud analüüsi vastavust nendele.

Rakenduse eesmärk on analüüsis selgelt välja toodud. Leitud on aktuaalne probleem, seda on põhjalikult käsitletud erinevatest aspektidest ja esinemisvormidest lähtudes ning selle põhjal koostatud nägemus lahendusest. Siiski ei saa nõustuda väitega, et kuigi Adobe on graafikadisaini tarkvara tootmises peaaegu monopoolses seisus, oleks tema poolt pakutav Typekit justkui ainuke fontide halduse lahendus. Fontide halduse tarkvara käsitlev [https://en.wikipedia.org/wiki/Font_management_software Wikipedia lehekülg] pakub üle 30 alternatiivi, millega oleks meeskonnal ideede kogumiseks ja lihvimiseks kindlasti mõistlik tutvuda. Samuti on Google’il veebipõhine fontide halduse lahendus [https://www.google.com/fonts Google Fonts].

Analüüsis on toodud loodava rakenduse funktsioonina põhiliselt erinevad viisid fontide kuvamiseks, otsimiseks ja valimiseks. Seoses funktsionaalsusega jääb arusaamatuks, mida täpsemalt mõeldakse “''[---] Fonte kuvatakse kaartidel, mida on ühes reas näiteks 4 tükki [---]''” all. Kas mõeldud on näiteks reas olevaid pilte või hoopis tabeli rida. Üldjoontes võib öelda, et analüüsi eesmärgis toodud probleemi pakutud funktsionaalsus tõenäoliselt lahendab ehk pakub süsteemis installeeritud fontidest parema ülevaate ja võimaluse neid organiseerida.

Sellegipoolest võiks kõnealune rakendus tegeleda ka tegelikult fontide haldamisega ehk kindlasti peaks olema võimalik muuta konkreetseid fonte vastavalt vajadusele aktiivseks ja mitteaktiivseks, nt. liigutades neid operatsioonisüsteemi fontide kataloogi ja rakenduse hallatava fontide kataloogi vahel. Selline vajaduspõhine fontide lülitamine aitaks lahendada ka analüüsi eesmärgi all käsitletud n.n. 500 fondi ja pika valiku kerimise probleemi - aktiivsed oleks ainult konkreetse graafikaprojekti või dokumendi teostamiseks vajalikud fondid. Samuti oleksid fonte kasutavad rakendused kiiremad, kuna neil puuduks vajadus kõigi süsteemi fontide laadimiseks, milleks võib suure süsteemi fontide kataloogi puhul kuluda väga palju aega.

Seoses võimalike takistustega rakenduse arendamisel on meeskond toonud välja ühilduvusprobleemi erinevate Windows’i versioonidega. IT-maailmas kahtlemata väga tavapärane olukord ja probleemi ilmnemisel on tõenäoliselt mõistlik keskenduda ainult paarile viimasele Windows’i versioonile.

Lõpetuseks peatume ka formaalsetel nõuetel. Kodutöö juhendi järgi peaks andmebaasis olema vähemalt 6 andmebaasi tabelit. Meeskonna poolt koostatud analüüsi ja projekti logi põhjal võib järeldada, et plaanitakse kasutada andmebaasi, kuid kahjuks puudub otsene kirjeldus, kas üldse ja kui, siis kuidas, seal fontide nimekirja ning muid tegevustega seotud andmeid hoidma hakatakse. Ülevaatlikkuse huvides oleks võinud andmebaasi skeemi olemasolul lisada ka selle analüüsi juurde.

Kodutöö juhendis on toodud ka nõue, et analüüsi minimaalne sõnade arv peab olema 700, kuid retsenseeritavas analüüsis on ainult 597 sõna. Siiski andis analüüs lahendatavast probleemist ja loodavast rakendusest konkreetse ülevaate.

Fontastic meeskonnale rakenduse arendamisel jõudu soovides

[[Meeskond: Nocturne No. 20 in C-sharp Minor]]

== Retsensioon prototüübile ==

Esiteks märkasin kohe, et andmebaas initsialiseeritakse automaatselt selle puudumisel. See on prototüüpi avaldades kahtlemata vajalik funktsionaalsus ja palju meeldivam oli prototüüpi hinnata.
Samas, märkasin sellega seoses ka kohe bugi: süsteemi installeeritud fontide nimekiri loetakse andmebaasi loomisel andmebaasi, kuid hiljem süsteemi fonte lisades seda nimekirja andmebaasis ei uuendata. Usun et kindlasti peaks rakendus ka fontide nimekirja vähemalt taaskäivitusel vajadusel uuendama.

MVVM arendusmustrist ei ole kinni peetud, kogu kasutajaliidese kood asub MainWindow codebehindis. Kuna tegu on WPF rakendusega, siis MVVM on tugevalt soovitatav arendusmuster mida kasutada.

Üldine mulje kasutaja seisukohalt rakendusest on hea, rakendus töötab piisavalt kiiresti ning kasutajaliides on arusaadav. Rakendus võiks meeles pidada muudetud Example text-i käivituste vahel. Samuti jääb pisut selgusetuks hetkel tab-ide mõte. Kui tabid on ainult tagide grupeerimiseks, siis võiks kindlasti olla ka võimalus luua tage mis ei ole otseselt ühegi tabiga või on seotud mitme tabiga. Näiteks tagid serif/sans-serif võiks olla nähtavad igas tabis.

Aine seisukohalt tekitab muret rakenduse lihtsus. Juhul kui rakendusele mingit suuremat funktsionaalsust enam juurde ei ole planeeritud, siis usun et vähemalt MVVM mustri kasutamine oleks korralike punktide saamiseks vajalik.

Samas, juba prototüübifaasis on peaaegu kogu planeeritud funktsionaalsus saavutatud, nii et hästi tehtud.

Koostas: [[Meeskond: Spooky Scary Skeletons]]

Talk:Meeskond: Fontastic

2015-12-19T23:41:17Z

Ssaks:

Meeskond: Spooky Scary Skeletons

2015-12-14T09:58:34Z

Ssaks: /* Tehnoloogiad */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[https://msdn.microsoft.com/en-us/library/dd203052.aspx REST]

Server kasutab klientidega suhtluseks RESTful apit ja JSON andmeformaati.

'''Autentikatsioon - Server'''

Kasutaja autentikatsioon toimub stateless auth mustrit kasutades.

Kasutaja autentimiseks saadab kasutaja oma kasutajanime, parooli ja juhuslikult genereeritud stringi 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.

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 vist 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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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)]

== 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.

== Lisad ==

[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;

Meeskond: Spooky Scary Skeletons

2015-12-14T07:44:58Z

Ssaks: /* Tehnoloogiad */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]]

'''UI - Client'''
*[https://msdn.microsoft.com/en-us/library/aa970268%28v=vs.110%29.aspx WPF]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[https://msdn.microsoft.com/en-us/library/dd203052.aspx REST]

Server kasutab klientidega suhtluseks RESTful apit ja JSON andmeformaati.

'''Autentikatsioon - Server'''

Kasutaja autentikatsioon toimub stateless auth mustrit kasutades.

Kasutaja autentimiseks saadab kasutaja oma kasutajanime, parooli ja juhuslikult genereeritud stringi 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.

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 vist 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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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)]

== 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.

== Lisad ==

[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;

Juhend: Kodutöö aines "Programmeerimine CSharp keeles" (2015)

2015-12-13T21:20:02Z

Ssaks: /* Meeskond: Spooky Scary Skeletons */

__NOINDEX__

=Kodutöö aines "Programmeerimine C# keeles"=

==Eesmärk==
Saada praktiline arenduskogemus .NET keskkonnas ning arendada meeskonnatöö kogemust ja analüüsivõimet. Kasutada arendusprotsessis koodihoidlat.

==Reeglid==
Ühte projektimeeskonda kuulub 3-5 tudengit(Soovituslik meeskonna suurus on 3-4). Ühel teemal võib teostada projekti üks või mitu meeskonda.Töö käiku kajastatakse https://wiki.itcollege.ee keskkonnas või soovi korral võib seda teha ka ajaveebis(blogis).
Ajaveebi pidamise eesmärke on kaks: nii on võimalik kirja panna kõik mõtted ja ideed (ning nendest jääb jälg ja dokumentatsioon) ning õppejõul on hiljem võimalik saada ülevaade iga projektimeeskonna liikme panusest. Ajaveebi loob ja ajaveebi haldab projektimeeskond vabalt valitud (avalikus) keskkonnas.

'''Projekti loomine ja arendamine '''
Projekt lisatakse versioonihaldusesse, kasutades selleks [Team Foundation Service'it http://tfs.visualstudio.com/] ning õppejõule antakse ligipääs. Õppejõu live id: maitposka ät hotmail.com . Projekt peab olema alates algfaasist lisatud TFSi ning kogu tööprotsess toimub versioonihaldust kasutades

'''Tööde esitamine''' (prototüüb ja lõpptoode)
Töö esitamisel pakitakse see kokku ning lisatakse wiki leheküljele link lähtekoodile. Kui töö lähtekoodi ei soovita mingil põhjusel avalikustata, tuleb õppejõuga selle jaoks sõlmida eraldi kokkulepe. Lähtekood on vajalik, et tööd oleks võimalik hinnata nii õppejõul kui kaastudengitel selle kohta retsensiooni kirjutada.

'''Team Foundation Service kasutamine''' (tänasel päeval '' Visual Studio online'')
[http://www.visualstudio.com/get-started/sign-up-for-visual-studio-online Step-by-Step juhend]

NB! Siia tuleb õppejõu poolt lihtne screencast ka, kuid ideeliselt ei tohiks selle kasutamine olla väga keeruline.

==Tähtaegadest kinnipidamine==
Projekt jaguneb alamosadeks, millele on määratud tähtajad. Tähtaegade ületamisel võimalike punkte ei kaotata. Kui töö aga on esitatud tähtajaks, siis on võimalik selle eest teenida boonuspunkte (enamasti 0-10% võimalikust maksimumist boonust). Enne tähtaega esitatud töö ei tähenda automaatselt maksimumpunkte, kui see ei ole sooritatud korralikult.

==Hindamine==
Teostatuks loetakse projekt juhul, kui lähteülesanne on realiseeritud, lahendus on töötav, kuid esineb suuremaid vigu ning piirsituatsioonidega ei ole arvestatud.
Maksimumtulemuse saavutamiseks peab projekt olema teostatud tehniliselt veatult ning varustatud dokumentatsiooniga, milles sisaldub arendusprotsessi kirjeldus (peab selguma ka iga rühmaliikme panus projekti teostamisel), kasutajajuhend ning lahenduse kirjeldus. Tehnilisi ja vormistuslike puudujääke on võimalik korvata lisavõimaluste realiseerimisega.Üldjuhul tuleb loodud lahendust ka praktikumides või loengutes teistele tudengitele tutvustada (ca 10 min).
Nagu eelpool mainitud, koosneb projekt erinevatest osadest. Punktide arvu määramisel arvestatakse ka tähtajast kinni pidamist, mille toimimisloogika on kirjeldatud eespool.

===Meeskonna kokkupanek ja idee===
'''25.10.2015''' (2p)

Tekitatakse meeskonna wiki lehekülg. Meeskonnal peab olema nimi ning see koosneb kolmest kuni viiest liikmest. Määratakse projektijuht. Juhul kui hakatakse blogi pidama kuskil mujal keskkonnas ilmub selle kohta link. Lühidalt peaks kirjeldama idee olemust nii, et selle üldine suund oleks arusaadav. Samuti peab olema märgitud tehnoloogia, milles hakatakse rakendust looma. Meeskond on loonud TFSi konto ning on saatnud õppejõule kutse.

===Analüüs===
'''01.11.2015''' (6p)
Analüütilise osa eesmärgiks on arendada tudengite analüüsioskust, mida on vaja ka päris tarkvaraarenduse protsessi juures.'''NB! Miinimum sõnade arv 700''' Selle osa käigus peab valmima loodava rakenduse analüüs, mis sisaldab muu hulgas ka:
*Analüüs rakendusele. (Mida see endas sisaldab? Mis on selle eesmärk? Mida tavakasutaja sellega teha saaks? Milliste osade realiseerimine võib osutuda problemaatiliseks?) Kui on tööjaotus paigas, siis tuua ka see välja.
*Tuua välja nimekiri funktsionaalsusest, mida plaanitakse kindlasti teostada(''Must have'')
*Nimekiri funktsionaalsustest, mis võiks olla, aga mida ei pruugita ajapuuduse tõttu realiseerida.(''Nice to have'')

'''Retsensioon''' 8.11.2015 (3p)

===Prototüüp===
'''13.12.2015 23:58'''(10p)

Valmib projekti esmane realisatsioon. Laias laastus on peafunktsionaalsused realiseeritud(Nimekiri funktsionaalsusest, mida plaanitakse teostada). Programmis võib esineda üksikuid, kuid mitte väga suuri vigu.

'''Retsensioon''' 20.12.2015(5p)

===Lõpptoode===
'''20.01.2016'''(20p)
Selleks faasiks peab projekt maksimumpuntkide saavutamiseks olema teostatud tehniliselt veatult ning varustatud dokumentatsiooniga, milles sisaldub arendusprotsessi kirjeldus (peab selguma ka iga rühmaliikme panus projekti teostamisel), kasutajajuhend ning lahenduse kirjeldus.

'''Retsensioon''' 27.01.2016(5p)

===Esitlus/Kaitsmine===

'''Toimub loengutes/praktikumides või kokkulepitud ajal enne eksamit''' ''(4p) ''
Esitlusel kaitstakse projekti. Tutvustatakse tehnoloogiat, mida kasutati rakenduse realiseerimiseks. Lühidalt räägitakse tööjaotusest ning probleemidest, mis tekkisid projekti realiseerimisel. Näidatakse lähtekoodi ja demonstreeritakse oma rakendust teistele tudengitele, kes võivad selle kohta küsimusi küsida. Kestvus ~20min.

====Kaitsmise ajad====

Tere, iga aja taha kirjutada meeskonna nimi, kes tuleb oma tööd kaitsma. Aegu palun täita võimaluse korral järjest.

Ideaalne esitlus, sisaldab endas ka powerpointi, kus on
*väljatoodud meeskonna nimi ja liikmed
*idee
*realiseerimine
*mis oli keerukas?
*mida uut õpiti?
*mõnede keerulisemate probleemide lahendamine
*meeskonnaliikmete panus

Kaitsmise käigus vaadatakse üle ka kood.

'''Esmaspäev''' - 14.12.2015
*14:00 -
*14:15 -
*14:30 -
*14:45 -
*15:00 -
*15:15 -

*16:00 - [https://wiki.itcollege.ee/index.php?title=Meeskond:_LetsDoIt LetsDoIt]
*16:15 - [[Meeskond: Travo]]
*16:30 - GlobalElite
*16:45 - [https://wiki.itcollege.ee/index.php/BIT BIT]
*17:00 - Konsa
*17:15 - KTM Development
*17:30 - MinuKV

'''Neljapäev''' - 17.12.2015
*08:15 - VVA
*08:30 - mc2
*08:45 - PenguinHorde
*09:00 - Sporto
*09:15 - Incman
*09:30 - Lebokeiss OÜ

*10:00 -Kodune raamat
*10:15 -
*10:30 -
*10:45 -
*11:00 -
*11:15 -

=Teemad 2015 sügis=
Kodutööna tuleb luua:

==Nõuded rakendusele==
Loodav rakendus peab:
* Peab kasutama andmebaasi (erikokkuleppel ka XML formaadis andmeallikat)
**Andmebaasis peab olema vähemalt 6 andmebaasi tabelit
* Peab võimaldama tegevuste kohta registri pidamist (logi)
**Rakenduses tehtavad tegevused salvestatakse
* Kasutama kasutajaliidesena ühte järgmistest: Windows Presentation Foundation, Windows Phone , Windows Store App või ASP.Net
* Kood on kommenteeritud ning rakendus on varustatud dokumentatsiooniga
* Maksimumpunktide jaoks kasutatakse vastavalt valitud tehnoloogiale soovitatud arendusmustreid
* Kood on kirjutatud C# programmeerimiskeeles
**Kuna aine nimi on "Programmeerimine C# keeles" ei tohi esitada rakendust, mis on loodud Javas, PHPs vms keeles
* Rakendus on jaotatud kihtidesse
'''Loodav rakendus peab olema loodud objektorienteeritud lähenemist kasutades!''' Klassid, klassid, klassid
*Kood on kommenteeritud

Lisapunkte annab:
* Silmailu
* Kood on kirjutatud häid praktikaid järgides ja on veatu(testimine, testimine, testimine)
* Orginaalsed ideed ja hea äriidee

==Kodune raamatukogu==
Kodudes on tihti erinevaid raamatuid (filme, muud nänni) ja sõbrad tahavad neid vahel laenutada.
Loo rakendus, mis
* Võimaldaks sisestada kodused raamatud
* Võimaldaks luua laenutajate profiile
* Raamatuid välja laenutada (tähtajaliselt)
* Laseks koostada erinevaid aruandeid (kodusolevad raamatud, väljalaenutatud raamatud, tähtaja ületanud laenutused jne)

Lisavõimalused
* Kui laenutaja profiilis on e-mail, siis saada automaatselt e-kiri „kallis sõber see ja see, Sinu käes on minu raamat, kas tood tagasi ka?”
* Kuva hoiatused, kui laenutaja laenutuste ajalugu on vilets või kui mõni raamat on tagastamata.
* Lase lisada raamatutele pilt
* Loo lihtne veebiliides (et sõbrad saaksid veebist vaadata, mis raamatud kasutajal kodus veel alles on)
Või

==CRM==
Oma klientidest peab olema ülevaade.
Loo rakendus, mis võimaldab:
* Kliente ning nende kontaktisikuid sisestada, muuta ning kustutada
* Võimalda sisestada kliendikontakte
* Koostada hinnapakkumisi klientidele, kusjuures hinnapakkumine lisatakse süsteemi ka kui kliendikontakt ning saadetakse samast süsteemist kliendile.
* Kliendi andmete vaatamisel kuvatakse ka kliendikontaktid

Lisavõimalused
* Loo võimalus, kus kontaktisiku sünnipäeva saabumisel saadetakse automaatselt inimesele meil õnnesoovidega
* Õnnitlusmeilide template’sid võiks olla mitu
* Loo võimalus kliendi huvide (huvialade) kajastamiseks süsteemis

==Mäng(Unit)==
Loodav mäng peab sisaldama:
* Erinevaid tasemeid
* Punktiarvestust
* XBox puldi tuge
* Klaviatuurilt juhtimise tuge

'''Loodav mäng peab olema loodud objektorienteeritud lähenemist kasutades!''' Klassid, klassid, klassid

Lisapunkte annab:
* Silmailu
* Kood on kirjutatud häid praktikaid järgides ja on veatu(testimine, testimine, testimine)
* Orginaalsed ideed ja hea ''story''

=Meeskonnad 2015=
==Päevaõpe==

===Meeskond: MinuKV===
Liikmed:
*Vanessa Vorteil
*Martin Luik
*Ahto Elken
*Taavi Kusmin
*Silver Ohlo

Meeskonna koduleht: [[Meeskond: MinuKV]]

'''Retsensioonid'''

===Meeskond: Travo===
Liikmed:
*Tarvo Reinpalu
Meeskonna koduleht: [[Meeskond: Travo]]

'''Retsensioonid'''
===Meeskond: Freshmen===
Liikmed:
*Siim Haas - Projektijuht
*Piret Pomerants
*Semjon Greef

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_Freshmen Freshmen]

'''Retsensioonid'''

Retsensioon Qlibrium analüüsi [https://wiki.itcollege.ee/index.php/Talk:Qlibrium kohta]

===Meeskond: mc2===
Liikmed:
*Martin Betlem
*Johannes Tamm
*Martin Mägi
*Jana Pipar

Meeskonna koduleht: [[Meeskond: mc2]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Retsensioon_MinuKV_kohta#Retsensioon_MinuKV_kohta Retsensioon MinuKV kohta]

'''Prototüüp'''

Meie prototüüp asub [https://wiki.itcollege.ee/index.php/Meeskond:_mc2#Protot.C3.BC.C3.BCp SIIN]

===Meeskond: Sporto===
Liikmed:
*Kelli Lukas
*Vladimir Rõkovanov
*Alar Ameerikas
*Mikk Raudsepp
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Sporto Sporto]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_KTM_Development Retsensioon meeskonna KTM Development projekti analüüsile]

===Meeskond: LetsDoIt===
Liikmed:
*Liisa Suurkaev(projektijuht)
*Melissa Eenmaa
*Tanel Vähk
*Taavi Kliss
*Aleks Luik
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_LetsDoIt LetsDoIt]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale LendBook asub [https://wiki.itcollege.ee/index.php/Talk:LendBook retsensioon siin].

===Meeskond: VVA===
Liikmed:
*Vladislav Lahtarin
*Vladislav Kovaltšuk
*Aleksandr Babõkin

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_VVA Meeskond:_VVA]

'''Retsensioonid'''

===Meeskond: IncMan===
Liikmed:
*Sergei Fatejev
*Nele Sergejeva
*Marko Koiduste
*Kaspar Tilk
*Jaanus Türnpuu

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Incman IncMan]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale '''LetsDoIt''' asub [https://wiki.itcollege.ee/index.php/Talk:Meeskond:_LetsDoIt siin]

===Meeskond: Lebokeiss OÜ===
Liikmed:
*Joonas Jõeleht - Projektijuht
*Iris Tambaum
*Timo Lanno
*Karell Veskimeister
*Kerli Edasi

Meeskonna koduleht: [[Meeskond:_Lebokeiss_OÜ]]

'''Retsensioonid'''

[[Talk:Meeskond:_Travo | Retsensioon meeskond Travo analüüsile]]

===Meeskond: LendBook===
Liikmed:
*Egle Arge
*Liina Kolk

Meeskonna koduleht: [[LendBook]]

'''Retsensioonid'''

[[Talk:PenguinHorde | Retsensioon meeskonna PenguinHorde analüüsile]]

===Meeskond: BIT===
Liikmed:
*Merilyn Renser
*Marko Hartikainen
*Ants Kristjan Rooma
*Konstantin Burdakov

Meeskonna koduleht: [[BIT]]

'''Retsensioonid''' 
[[VVA analüüsi retsensioon]]

===Meeskond: PenguinHorde===
Liikmed:
*Laura Leon
*Marko Saluste
*Terje Sõelsepp
*Mari-Liis Oldja
Meeskonna koduleht: [[PenguinHorde]]

'''Retsensioonid'''

===Meeskond: GlobalElite===
Liikmed:
*Marek Kivikink
*Indrek Nurja
*Imre Teras
*Aapo Kersalu
*Erling Tammisto
Meeskonna koduleht: [[GlobalLite]]

'''Retsensioonid'''

===Meeskond: KTM Development===
Liikmed:
*Kristian Laupa
*Tauno Otti
*Mart Abel
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_KTM_Development KTM Development]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale '''mc2''' asub [https://wiki.itcollege.ee/index.php/User_talk:Klaupa siin]

===Meeskond: Bob?===
Liige:
*Priit Aarne

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Bob Bob?]

'''Retsensioonid'''

[[Meeskonna IncMan analüüsi retsensioon]]

===Meeskond: RJ===
Liige:
*Richard Jalonen
Meeskonna koduleht: [[RJ]]

===Meeskond: Qlibrium===
Liige:
*Karl Frank
Meeskonna koduleht [[Qlibrium]]

'''Retsensioon'''
[https://wiki.itcollege.ee/index.php/Talk:Retsensioon_GlobalLite_*#Meeskonna_GlobalLite_anal.C3.BC.C3.BCsi_retsensioon]

===Meeskond: Kodune Raamat===
Liikmed:
*Siim Osa
*Taavi Kivimaa
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_Kodune_Raamat Kodune Raamat]

'''Retsensioonid'''

===Meeskond: TaTa===
Liikmed:
*Talis Tammearu
Meeskonna koduleht: [[Meeskond:TaTa]]

===Meeskond: Ktreikel===
Liikmed:
*Kert Treikelder
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_ktreikel]

[[Category: Programmeerimine CSharp keeles (2015) (Päevaõpe)]]

==Kaugõpe==
===Meeskond: Premium===
Liikmed:
*Tarmo Petrovits
*Karin Talumäe
*Jevgeni Gavrilov

Meeskonna koduleht: [[Meeskond: Premium]]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale '''LIB''' asub [https://wiki.itcollege.ee/index.php/Talk:Meeskond:_LIB siin]

===Meeskond: Spooky Scary Skeletons===
Liikmed:
*Kärt Palm DK22
*Karina Egipt DK22 (Projektijuht)
*Erika Ehmann D32
*Silver Saks AK21

Meeskonna koduleht: [[Meeskond: Spooky Scary Skeletons]]

'''[https://pilv.mana.ee/public.php?service=files&t=0e79ef0570f39b8743f046c70f724404 Esimene Prototüüp (13.12.2015)]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Premium Retsensioon meeskonna Premium projekti HomeLibrary analüüsile]

=== Meeskond: Nocturne No. 20 in C-sharp Minor ===
Liikmed:
*10142848 (Projektijuht)
*10090107
*10143193
*10143313

Meeskonna koduleht: [[Meeskond: Nocturne No. 20 in C-sharp Minor]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Fontastic Retsensioon meeskonna Fontastic rakenduse analüüsile]

===Meeskond: LIB===
Liikmed:
*Sigrid Pachel DK22 (Projektijuht)
*Diana Nikolajeva DK22
*Kristjan Adrat DK41

Meeskonna koduleht: [[Meeskond: LIB]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond_Mardo Analüüsi retsensioon Mardo meeskonnale]

===Meeskond: Greek?Mark===
Liikmed:
*Karit Kilgi DK22 (Projektijuht)
*Sten Kaasik DK22
*Siim Veskilt DK22

Meeskonna koduleht: [[Meeskond: GreekQMark]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Spooky_Scary_Skeletons Retsensioon meeskonna Spooky Scary Skeletons rakenduse AVE 2.0 analüüsile]

===Meeskond: Tarraxacum===
Liikmed:
*Silja Kralik DK21 (Projektijuht)
*Liina Laumets DK21
*Ragne Auling DK22

Meeskonna koduleht: [[Meeskond: Tarraxacum]]

[[Retsensioon meeskonnale Põhjavesi]]

===Meeskond: Fontastic===
Liikmed:
*Erik Hirmo DK22 (Projektijuht)
*Piret Reinumägi DK21

Meeskonna koduleht: [[Meeskond: Fontastic]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Konsa Retsensioon meeskonna Konsa projekti Ostukorv analüüsile]

===Meeskond: TTT===
Liikmed:
*Ave Karjus DK22
*Joonatan Uusväli DK22 (Projektijuht)
*Kaidar Viikman DK21 (Wiki pidaja)
*Oliver Tiks AK21

Meeskonna koduleht: [[Meeskond: TTT (Trellid Teevad Tugevaks) | TTT (Trellid Teevad Tugevaks)]]

'''Retsensioonid'''

[[Talk:Meeskond:_GreekQMark#section=1 | Retsensioon meeskonna Greek?Mark projekti analüüsile]]

===Meeskond: Codezilla===
Liikmed:
*Anna Linskaja DK21 (Projektijuht)
*Alisa Dudinova DK21
*Sergei Hristoforov DK21

Meeskonna koduleht: [[Codezilla]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Maker Retsensioon meeskonna Maker projekti analüüsile]

===Meeskond: Konsa===
Liikmed:

*Marko Konsa DK13

Meeskonna koduleht: [[Ostukorv]]

'''Retsensioonid'''
===Meeskond: Johhaidii===
Liikmed:
*Yogesh Sharma
*Juhan Trink
*Marju Niinemaa

Meeskonna koduleht: [[Johhaidii]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Retsensioon_Makerile Retsensioon meeskonna Maker analüüsile]

===Meeskond: Sildur===
Liikmed:
*Andreas Papp (Projektijuht)
*Germo Väli
*Andres Trei

Meeskonna koduleht: [[Sildur]]

'''Retsensioonid'''
===Meeskond: JT===
Liikmed:
*Tõnis Luik (Projektijuht)
*Juri Nikitin

Meeskonna koduleht: [[JT]]

'''Retsensioonid'''

===Meeskond: Maker===
Liikmed:
*Marek Öövel (Projektijuht)

Meeskonna koduleht: [[Maker]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Codezilla Retsensioon meeskonna Codezilla analüüsile]

===Meeskond: Põhjavesi===
Liikmed
*Indrek Pruul (Projektijuht)
*Jan Eerik
*Eeva Koplimets

Meeskonna koduleht: [[Pohjavesi]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Pohjavesi Retsensioon meeskonnale Spooky Scary Skeletons analüüsile]

===Meeskond: MMTL development===
Liikmed
*Martin Mänd (Projektijuht)
*Taavi Lõhmus

Meeskonna koduleht: [[Meeskond: MMTL development]]

'''Retsensioonid'''

===Meeskond: Mardo===
Liikmed:
*Mardo Halapuu
Meeskonna koduleht:[https://wiki.itcollege.ee/index.php/Meeskond_Mardo Mardo]

Meeskond: Spooky Scary Skeletons

2015-12-13T21:18:45Z

Ssaks: /* Avaldatud failid */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]]

'''UI - Client'''
*[https://msdn.microsoft.com/en-us/library/aa970268%28v=vs.110%29.aspx WPF]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[https://msdn.microsoft.com/en-us/library/dd203052.aspx REST]

Server kasutab klientidega suhtluseks RESTful apit ja JSON andmeformaati.

'''Autentikatsioon - Server'''

Kasutaja autentikatsioon toimub stateless auth mustrit kasutades.

Kasutaja autentimiseks saadab kasutaja oma kasutajanime, parooli ja juhuslikult genereeritud stringi 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.

Vastuseks saadud tokeni salvestab klientprogramm endale mällu, ning lisab hiljem igale API requestile. Konkreetne meetod pole oluline, aga kasutame vist 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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[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)]

== 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.

== Lisad ==

[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;

Juhend: Kodutöö aines "Programmeerimine CSharp keeles" (2015)

2015-12-13T19:52:07Z

Ssaks: /* Meeskond: Spooky Scary Skeletons */

__NOINDEX__

=Kodutöö aines "Programmeerimine C# keeles"=

==Eesmärk==
Saada praktiline arenduskogemus .NET keskkonnas ning arendada meeskonnatöö kogemust ja analüüsivõimet. Kasutada arendusprotsessis koodihoidlat.

==Reeglid==
Ühte projektimeeskonda kuulub 3-5 tudengit(Soovituslik meeskonna suurus on 3-4). Ühel teemal võib teostada projekti üks või mitu meeskonda.Töö käiku kajastatakse https://wiki.itcollege.ee keskkonnas või soovi korral võib seda teha ka ajaveebis(blogis).
Ajaveebi pidamise eesmärke on kaks: nii on võimalik kirja panna kõik mõtted ja ideed (ning nendest jääb jälg ja dokumentatsioon) ning õppejõul on hiljem võimalik saada ülevaade iga projektimeeskonna liikme panusest. Ajaveebi loob ja ajaveebi haldab projektimeeskond vabalt valitud (avalikus) keskkonnas.

'''Projekti loomine ja arendamine '''
Projekt lisatakse versioonihaldusesse, kasutades selleks [Team Foundation Service'it http://tfs.visualstudio.com/] ning õppejõule antakse ligipääs. Õppejõu live id: maitposka ät hotmail.com . Projekt peab olema alates algfaasist lisatud TFSi ning kogu tööprotsess toimub versioonihaldust kasutades

'''Tööde esitamine''' (prototüüb ja lõpptoode)
Töö esitamisel pakitakse see kokku ning lisatakse wiki leheküljele link lähtekoodile. Kui töö lähtekoodi ei soovita mingil põhjusel avalikustata, tuleb õppejõuga selle jaoks sõlmida eraldi kokkulepe. Lähtekood on vajalik, et tööd oleks võimalik hinnata nii õppejõul kui kaastudengitel selle kohta retsensiooni kirjutada.

'''Team Foundation Service kasutamine''' (tänasel päeval '' Visual Studio online'')
[http://www.visualstudio.com/get-started/sign-up-for-visual-studio-online Step-by-Step juhend]

NB! Siia tuleb õppejõu poolt lihtne screencast ka, kuid ideeliselt ei tohiks selle kasutamine olla väga keeruline.

==Tähtaegadest kinnipidamine==
Projekt jaguneb alamosadeks, millele on määratud tähtajad. Tähtaegade ületamisel võimalike punkte ei kaotata. Kui töö aga on esitatud tähtajaks, siis on võimalik selle eest teenida boonuspunkte (enamasti 0-10% võimalikust maksimumist boonust). Enne tähtaega esitatud töö ei tähenda automaatselt maksimumpunkte, kui see ei ole sooritatud korralikult.

==Hindamine==
Teostatuks loetakse projekt juhul, kui lähteülesanne on realiseeritud, lahendus on töötav, kuid esineb suuremaid vigu ning piirsituatsioonidega ei ole arvestatud.
Maksimumtulemuse saavutamiseks peab projekt olema teostatud tehniliselt veatult ning varustatud dokumentatsiooniga, milles sisaldub arendusprotsessi kirjeldus (peab selguma ka iga rühmaliikme panus projekti teostamisel), kasutajajuhend ning lahenduse kirjeldus. Tehnilisi ja vormistuslike puudujääke on võimalik korvata lisavõimaluste realiseerimisega.Üldjuhul tuleb loodud lahendust ka praktikumides või loengutes teistele tudengitele tutvustada (ca 10 min).
Nagu eelpool mainitud, koosneb projekt erinevatest osadest. Punktide arvu määramisel arvestatakse ka tähtajast kinni pidamist, mille toimimisloogika on kirjeldatud eespool.

===Meeskonna kokkupanek ja idee===
'''25.10.2015''' (2p)

Tekitatakse meeskonna wiki lehekülg. Meeskonnal peab olema nimi ning see koosneb kolmest kuni viiest liikmest. Määratakse projektijuht. Juhul kui hakatakse blogi pidama kuskil mujal keskkonnas ilmub selle kohta link. Lühidalt peaks kirjeldama idee olemust nii, et selle üldine suund oleks arusaadav. Samuti peab olema märgitud tehnoloogia, milles hakatakse rakendust looma. Meeskond on loonud TFSi konto ning on saatnud õppejõule kutse.

===Analüüs===
'''01.11.2015''' (6p)
Analüütilise osa eesmärgiks on arendada tudengite analüüsioskust, mida on vaja ka päris tarkvaraarenduse protsessi juures.'''NB! Miinimum sõnade arv 700''' Selle osa käigus peab valmima loodava rakenduse analüüs, mis sisaldab muu hulgas ka:
*Analüüs rakendusele. (Mida see endas sisaldab? Mis on selle eesmärk? Mida tavakasutaja sellega teha saaks? Milliste osade realiseerimine võib osutuda problemaatiliseks?) Kui on tööjaotus paigas, siis tuua ka see välja.
*Tuua välja nimekiri funktsionaalsusest, mida plaanitakse kindlasti teostada(''Must have'')
*Nimekiri funktsionaalsustest, mis võiks olla, aga mida ei pruugita ajapuuduse tõttu realiseerida.(''Nice to have'')

'''Retsensioon''' 8.11.2015 (3p)

===Prototüüp===
'''13.12.2015 23:58'''(10p)

Valmib projekti esmane realisatsioon. Laias laastus on peafunktsionaalsused realiseeritud(Nimekiri funktsionaalsusest, mida plaanitakse teostada). Programmis võib esineda üksikuid, kuid mitte väga suuri vigu.

'''Retsensioon''' 20.12.2015(5p)

===Lõpptoode===
'''20.01.2016'''(20p)
Selleks faasiks peab projekt maksimumpuntkide saavutamiseks olema teostatud tehniliselt veatult ning varustatud dokumentatsiooniga, milles sisaldub arendusprotsessi kirjeldus (peab selguma ka iga rühmaliikme panus projekti teostamisel), kasutajajuhend ning lahenduse kirjeldus.

'''Retsensioon''' 27.01.2016(5p)

===Esitlus/Kaitsmine===

'''Toimub loengutes/praktikumides või kokkulepitud ajal enne eksamit''' ''(4p) ''
Esitlusel kaitstakse projekti. Tutvustatakse tehnoloogiat, mida kasutati rakenduse realiseerimiseks. Lühidalt räägitakse tööjaotusest ning probleemidest, mis tekkisid projekti realiseerimisel. Näidatakse lähtekoodi ja demonstreeritakse oma rakendust teistele tudengitele, kes võivad selle kohta küsimusi küsida. Kestvus ~20min.

====Kaitsmise ajad====

Tere, iga aja taha kirjutada meeskonna nimi, kes tuleb oma tööd kaitsma. Aegu palun täita võimaluse korral järjest.

Ideaalne esitlus, sisaldab endas ka powerpointi, kus on
*väljatoodud meeskonna nimi ja liikmed
*idee
*realiseerimine
*mis oli keerukas?
*mida uut õpiti?
*mõnede keerulisemate probleemide lahendamine
*meeskonnaliikmete panus

Kaitsmise käigus vaadatakse üle ka kood.

'''Esmaspäev''' - 14.12.2015
*14:00 -
*14:15 -
*14:30 -
*14:45 -
*15:00 -
*15:15 -

*16:00 - [https://wiki.itcollege.ee/index.php?title=Meeskond:_LetsDoIt LetsDoIt]
*16:15 - [[Meeskond: Travo]]
*16:30 - GlobalElite
*16:45 - [https://wiki.itcollege.ee/index.php/BIT BIT]
*17:00 - Konsa
*17:15 - KTM Development
*17:30 - MinuKV

'''Neljapäev''' - 17.12.2015
*08:15 - VVA
*08:30 - mc2
*08:45 - PenguinHorde
*09:00 - Sporto
*09:15 - Incman
*09:30 - Lebokeiss OÜ

*10:00 -
*10:15 -
*10:30 -
*10:45 -
*11:00 -
*11:15 -

=Teemad 2015 sügis=
Kodutööna tuleb luua:

==Nõuded rakendusele==
Loodav rakendus peab:
* Peab kasutama andmebaasi (erikokkuleppel ka XML formaadis andmeallikat)
**Andmebaasis peab olema vähemalt 6 andmebaasi tabelit
* Peab võimaldama tegevuste kohta registri pidamist (logi)
**Rakenduses tehtavad tegevused salvestatakse
* Kasutama kasutajaliidesena ühte järgmistest: Windows Presentation Foundation, Windows Phone , Windows Store App või ASP.Net
* Kood on kommenteeritud ning rakendus on varustatud dokumentatsiooniga
* Maksimumpunktide jaoks kasutatakse vastavalt valitud tehnoloogiale soovitatud arendusmustreid
* Kood on kirjutatud C# programmeerimiskeeles
**Kuna aine nimi on "Programmeerimine C# keeles" ei tohi esitada rakendust, mis on loodud Javas, PHPs vms keeles
* Rakendus on jaotatud kihtidesse
'''Loodav rakendus peab olema loodud objektorienteeritud lähenemist kasutades!''' Klassid, klassid, klassid
*Kood on kommenteeritud

Lisapunkte annab:
* Silmailu
* Kood on kirjutatud häid praktikaid järgides ja on veatu(testimine, testimine, testimine)
* Orginaalsed ideed ja hea äriidee

==Kodune raamatukogu==
Kodudes on tihti erinevaid raamatuid (filme, muud nänni) ja sõbrad tahavad neid vahel laenutada.
Loo rakendus, mis
* Võimaldaks sisestada kodused raamatud
* Võimaldaks luua laenutajate profiile
* Raamatuid välja laenutada (tähtajaliselt)
* Laseks koostada erinevaid aruandeid (kodusolevad raamatud, väljalaenutatud raamatud, tähtaja ületanud laenutused jne)

Lisavõimalused
* Kui laenutaja profiilis on e-mail, siis saada automaatselt e-kiri „kallis sõber see ja see, Sinu käes on minu raamat, kas tood tagasi ka?”
* Kuva hoiatused, kui laenutaja laenutuste ajalugu on vilets või kui mõni raamat on tagastamata.
* Lase lisada raamatutele pilt
* Loo lihtne veebiliides (et sõbrad saaksid veebist vaadata, mis raamatud kasutajal kodus veel alles on)
Või

==CRM==
Oma klientidest peab olema ülevaade.
Loo rakendus, mis võimaldab:
* Kliente ning nende kontaktisikuid sisestada, muuta ning kustutada
* Võimalda sisestada kliendikontakte
* Koostada hinnapakkumisi klientidele, kusjuures hinnapakkumine lisatakse süsteemi ka kui kliendikontakt ning saadetakse samast süsteemist kliendile.
* Kliendi andmete vaatamisel kuvatakse ka kliendikontaktid

Lisavõimalused
* Loo võimalus, kus kontaktisiku sünnipäeva saabumisel saadetakse automaatselt inimesele meil õnnesoovidega
* Õnnitlusmeilide template’sid võiks olla mitu
* Loo võimalus kliendi huvide (huvialade) kajastamiseks süsteemis

==Mäng(Unit)==
Loodav mäng peab sisaldama:
* Erinevaid tasemeid
* Punktiarvestust
* XBox puldi tuge
* Klaviatuurilt juhtimise tuge

'''Loodav mäng peab olema loodud objektorienteeritud lähenemist kasutades!''' Klassid, klassid, klassid

Lisapunkte annab:
* Silmailu
* Kood on kirjutatud häid praktikaid järgides ja on veatu(testimine, testimine, testimine)
* Orginaalsed ideed ja hea ''story''

=Meeskonnad 2015=
==Päevaõpe==

===Meeskond: MinuKV===
Liikmed:
*Vanessa Vorteil
*Martin Luik
*Ahto Elken
*Taavi Kusmin
*Silver Ohlo

Meeskonna koduleht: [[Meeskond: MinuKV]]

'''Retsensioonid'''

===Meeskond: Travo===
Liikmed:
*Tarvo Reinpalu
Meeskonna koduleht: [[Meeskond: Travo]]

'''Retsensioonid'''
===Meeskond: Freshmen===
Liikmed:
*Siim Haas - Projektijuht
*Piret Pomerants
*Semjon Greef

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_Freshmen Freshmen]

'''Retsensioonid'''

Retsensioon Qlibrium analüüsi [https://wiki.itcollege.ee/index.php/Talk:Qlibrium kohta]

===Meeskond: mc2===
Liikmed:
*Martin Betlem
*Johannes Tamm
*Martin Mägi
*Jana Pipar

Meeskonna koduleht: [[Meeskond: mc2]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Retsensioon_MinuKV_kohta#Retsensioon_MinuKV_kohta Retsensioon MinuKV kohta]

'''Prototüüp'''

Meie prototüüp asub [https://wiki.itcollege.ee/index.php/Meeskond:_mc2#Protot.C3.BC.C3.BCp SIIN]

===Meeskond: Sporto===
Liikmed:
*Kelli Lukas
*Vladimir Rõkovanov
*Alar Ameerikas
*Mikk Raudsepp
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Sporto Sporto]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_KTM_Development Retsensioon meeskonna KTM Development projekti analüüsile]

===Meeskond: LetsDoIt===
Liikmed:
*Liisa Suurkaev(projektijuht)
*Melissa Eenmaa
*Tanel Vähk
*Taavi Kliss
*Aleks Luik
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_LetsDoIt LetsDoIt]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale LendBook asub [https://wiki.itcollege.ee/index.php/Talk:LendBook retsensioon siin].

===Meeskond: VVA===
Liikmed:
*Vladislav Lahtarin
*Vladislav Kovaltšuk
*Aleksandr Babõkin

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_VVA Meeskond:_VVA]

'''Retsensioonid'''

===Meeskond: IncMan===
Liikmed:
*Sergei Fatejev
*Nele Sergejeva
*Marko Koiduste
*Kaspar Tilk
*Jaanus Türnpuu

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Incman IncMan]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale '''LetsDoIt''' asub [https://wiki.itcollege.ee/index.php/Talk:Meeskond:_LetsDoIt siin]

===Meeskond: Lebokeiss OÜ===
Liikmed:
*Joonas Jõeleht - Projektijuht
*Iris Tambaum
*Timo Lanno
*Karell Veskimeister
*Kerli Edasi

Meeskonna koduleht: [[Meeskond:_Lebokeiss_OÜ]]

'''Retsensioonid'''

[[Talk:Meeskond:_Travo | Retsensioon meeskond Travo analüüsile]]

===Meeskond: LendBook===
Liikmed:
*Egle Arge
*Liina Kolk

Meeskonna koduleht: [[LendBook]]

'''Retsensioonid'''

[[Talk:PenguinHorde | Retsensioon meeskonna PenguinHorde analüüsile]]

===Meeskond: BIT===
Liikmed:
*Merilyn Renser
*Marko Hartikainen
*Ants Kristjan Rooma
*Konstantin Burdakov

Meeskonna koduleht: [[BIT]]

'''Retsensioonid''' 
[[VVA analüüsi retsensioon]]

===Meeskond: PenguinHorde===
Liikmed:
*Laura Leon
*Marko Saluste
*Terje Sõelsepp
*Mari-Liis Oldja
Meeskonna koduleht: [[PenguinHorde]]

'''Retsensioonid'''

===Meeskond: GlobalElite===
Liikmed:
*Marek Kivikink
*Indrek Nurja
*Imre Teras
*Aapo Kersalu
*Erling Tammisto
Meeskonna koduleht: [[GlobalLite]]

'''Retsensioonid'''

===Meeskond: KTM Development===
Liikmed:
*Kristian Laupa
*Tauno Otti
*Mart Abel
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_KTM_Development KTM Development]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale '''mc2''' asub [https://wiki.itcollege.ee/index.php/User_talk:Klaupa siin]

===Meeskond: Bob?===
Liige:
*Priit Aarne

Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Bob Bob?]

'''Retsensioonid'''

[[Meeskonna IncMan analüüsi retsensioon]]

===Meeskond: RJ===
Liige:
*Richard Jalonen
Meeskonna koduleht: [[RJ]]

===Meeskond: Qlibrium===
Liige:
*Karl Frank
Meeskonna koduleht [[Qlibrium]]

'''Retsensioon'''
[https://wiki.itcollege.ee/index.php/Talk:Retsensioon_GlobalLite_*#Meeskonna_GlobalLite_anal.C3.BC.C3.BCsi_retsensioon]

===Meeskond: Kodune Raamat===
Liikmed:
*Siim Osa
*Taavi Kivimaa
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_Kodune_Raamat Kodune Raamat]

'''Retsensioonid'''

===Meeskond: TaTa===
Liikmed:
*Talis Tammearu
Meeskonna koduleht: [[Meeskond:TaTa]]

===Meeskond: Ktreikel===
Liikmed:
*Kert Treikelder
Meeskonna koduleht: [https://wiki.itcollege.ee/index.php/Meeskond:_ktreikel]

[[Category: Programmeerimine CSharp keeles (2015) (Päevaõpe)]]

==Kaugõpe==
===Meeskond: Premium===
Liikmed:
*Tarmo Petrovits
*Karin Talumäe
*Jevgeni Gavrilov

Meeskonna koduleht: [[Meeskond: Premium]]

'''Retsensioonid'''

Analüüsi retsensioon meeskonnale '''LIB''' asub [https://wiki.itcollege.ee/index.php/Talk:Meeskond:_LIB siin]

===Meeskond: Spooky Scary Skeletons===
Liikmed:
*Kärt Palm DK22
*Karina Egipt DK22 (Projektijuht)
*Erika Ehmann D32
*Silver Saks AK21

Meeskonna koduleht: [[Meeskond: Spooky Scary Skeletons]]

'''[https://pilv.mana.ee/public.php?service=files&t=578d80969704c7be250b10406877ca74&path=%2FAVE&files=AVE%20App%20Proto%2020151213.zip&download Esimene Prototüüp (13.12.2015)]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Premium Retsensioon meeskonna Premium projekti HomeLibrary analüüsile]

=== Meeskond: Nocturne No. 20 in C-sharp Minor ===
Liikmed:
*10142848 (Projektijuht)
*10090107
*10143193
*10143313

Meeskonna koduleht: [[Meeskond: Nocturne No. 20 in C-sharp Minor]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Fontastic Retsensioon meeskonna Fontastic rakenduse analüüsile]

===Meeskond: LIB===
Liikmed:
*Sigrid Pachel DK22 (Projektijuht)
*Diana Nikolajeva DK22
*Kristjan Adrat DK41

Meeskonna koduleht: [[Meeskond: LIB]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond_Mardo Analüüsi retsensioon Mardo meeskonnale]

===Meeskond: Greek?Mark===
Liikmed:
*Karit Kilgi DK22 (Projektijuht)
*Sten Kaasik DK22
*Siim Veskilt DK22

Meeskonna koduleht: [[Meeskond: GreekQMark]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Spooky_Scary_Skeletons Retsensioon meeskonna Spooky Scary Skeletons rakenduse AVE 2.0 analüüsile]

===Meeskond: Tarraxacum===
Liikmed:
*Silja Kralik DK21 (Projektijuht)
*Liina Laumets DK21
*Ragne Auling DK22

Meeskonna koduleht: [[Meeskond: Tarraxacum]]

[[Retsensioon meeskonnale Põhjavesi]]

===Meeskond: Fontastic===
Liikmed:
*Erik Hirmo DK22 (Projektijuht)
*Piret Reinumägi DK21

Meeskonna koduleht: [[Meeskond: Fontastic]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Meeskond:_Konsa Retsensioon meeskonna Konsa projekti Ostukorv analüüsile]

===Meeskond: TTT===
Liikmed:
*Ave Karjus DK22
*Joonatan Uusväli DK22 (Projektijuht)
*Kaidar Viikman DK21 (Wiki pidaja)
*Oliver Tiks AK21

Meeskonna koduleht: [[Meeskond: TTT (Trellid Teevad Tugevaks) | TTT (Trellid Teevad Tugevaks)]]

'''Retsensioonid'''

[[Talk:Meeskond:_GreekQMark#section=1 | Retsensioon meeskonna Greek?Mark projekti analüüsile]]

===Meeskond: Codezilla===
Liikmed:
*Anna Linskaja DK21 (Projektijuht)
*Alisa Dudinova DK21
*Sergei Hristoforov DK21

Meeskonna koduleht: [[Codezilla]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Maker Retsensioon meeskonna Maker projekti analüüsile]

===Meeskond: Konsa===
Liikmed:

*Marko Konsa DK13

Meeskonna koduleht: [[Ostukorv]]

'''Retsensioonid'''
===Meeskond: Johhaidii===
Liikmed:
*Yogesh Sharma
*Juhan Trink
*Marju Niinemaa

Meeskonna koduleht: [[Johhaidii]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Retsensioon_Makerile Retsensioon meeskonna Maker analüüsile]

===Meeskond: Sildur===
Liikmed:
*Andreas Papp (Projektijuht)
*Germo Väli
*Andres Trei

Meeskonna koduleht: [[Sildur]]

'''Retsensioonid'''
===Meeskond: JT===
Liikmed:
*Tõnis Luik (Projektijuht)
*Juri Nikitin

Meeskonna koduleht: [[JT]]

'''Retsensioonid'''

===Meeskond: Maker===
Liikmed:
*Marek Öövel (Projektijuht)

Meeskonna koduleht: [[Maker]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Codezilla Retsensioon meeskonna Codezilla analüüsile]

===Meeskond: Põhjavesi===
Liikmed
*Indrek Pruul (Projektijuht)
*Jan Eerik
*Eeva Koplimets

Meeskonna koduleht: [[Pohjavesi]]

'''Retsensioonid'''

[https://wiki.itcollege.ee/index.php/Talk:Pohjavesi Retsensioon meeskonnale Spooky Scary Skeletons analüüsile]

===Meeskond: MMTL development===
Liikmed
*Martin Mänd (Projektijuht)
*Taavi Lõhmus

Meeskonna koduleht: [[Meeskond: MMTL development]]

'''Retsensioonid'''

===Meeskond: Mardo===
Liikmed:
*Mardo Halapuu
Meeskonna koduleht:[https://wiki.itcollege.ee/index.php/Meeskond_Mardo Mardo]

Meeskond: Spooky Scary Skeletons

2015-12-13T19:51:13Z

Ssaks: /* Avaldatud failid */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]]

'''UI - Client'''
*[https://msdn.microsoft.com/en-us/library/aa970268%28v=vs.110%29.aspx WPF]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[https://msdn.microsoft.com/en-us/library/dd203052.aspx REST]

Server kasutab klientidega suhtluseks RESTful apit ja JSON andmeformaati.

'''Autentikatsioon - Server'''

Kasutaja autentikatsioon toimub stateless auth mustrit kasutades.

Kasutaja autentimiseks saadab kasutaja oma kasutajanime, parooli ja juhuslikult genereeritud stringi 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.

Vastuseks saadud tokeni salvestab klientprogramm endale mällu, ning lisab hiljem igale API requestile. Konkreetne meetod pole oluline, aga kasutame vist 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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
*[https://pilv.mana.ee/public.php?service=files&t=edaa0cf40fb840ba7a620d4c0252b49e Andmebaasi Skeem (DBDesigner) ]
*[https://pilv.mana.ee/public.php?service=files&t=578d80969704c7be250b10406877ca74&path=%2FAVE&files=AVE%20App%20Proto%2020151213.zip&download Rakenduse esimene prototüüp (13.12.2015)]

== 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.
*'''13.12.2015''' - Prototüübi lisamine Wiki lehele.

== Lisad ==

[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_Application_proto20151211.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, kuid nende kuvamine etteantud vormidesse veel realiseerimisel - antud funktsionaalsus ei ole prototüübi jaoks vajalik;
* Vajutades taski nimetusele tehakse päring lokaalsesse baasi ning kuvatakse taski detailandmed (andmete muutmise funktsioon .DAL tasandil veel tealiseerimata).
* 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;

Meeskond: Spooky Scary Skeletons

2015-12-13T19:50:56Z

Ssaks: /* Avaldatud failid */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]]

'''UI - Client'''
*[https://msdn.microsoft.com/en-us/library/aa970268%28v=vs.110%29.aspx WPF]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[https://msdn.microsoft.com/en-us/library/dd203052.aspx REST]

Server kasutab klientidega suhtluseks RESTful apit ja JSON andmeformaati.

'''Autentikatsioon - Server'''

Kasutaja autentikatsioon toimub stateless auth mustrit kasutades.

Kasutaja autentimiseks saadab kasutaja oma kasutajanime, parooli ja juhuslikult genereeritud stringi 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.

Vastuseks saadud tokeni salvestab klientprogramm endale mällu, ning lisab hiljem igale API requestile. Konkreetne meetod pole oluline, aga kasutame vist 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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
[https://pilv.mana.ee/public.php?service=files&t=edaa0cf40fb840ba7a620d4c0252b49e Andmebaasi Skeem (DBDesigner) ]
[https://pilv.mana.ee/public.php?service=files&t=578d80969704c7be250b10406877ca74&path=%2FAVE&files=AVE%20App%20Proto%2020151213.zip&download Rakenduse esimene prototüüp (13.12.2015)]

== 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.
*'''13.12.2015''' - Prototüübi lisamine Wiki lehele.

== Lisad ==

[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_Application_proto20151211.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, kuid nende kuvamine etteantud vormidesse veel realiseerimisel - antud funktsionaalsus ei ole prototüübi jaoks vajalik;
* Vajutades taski nimetusele tehakse päring lokaalsesse baasi ning kuvatakse taski detailandmed (andmete muutmise funktsioon .DAL tasandil veel tealiseerimata).
* 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;

Meeskond: Spooky Scary Skeletons

2015-12-13T19:49:51Z

Ssaks: /* Prototüüp */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]]

'''UI - Client'''
*[https://msdn.microsoft.com/en-us/library/aa970268%28v=vs.110%29.aspx WPF]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[https://msdn.microsoft.com/en-us/library/dd203052.aspx REST]

Server kasutab klientidega suhtluseks RESTful apit ja JSON andmeformaati.

'''Autentikatsioon - Server'''

Kasutaja autentikatsioon toimub stateless auth mustrit kasutades.

Kasutaja autentimiseks saadab kasutaja oma kasutajanime, parooli ja juhuslikult genereeritud stringi 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.

Vastuseks saadud tokeni salvestab klientprogramm endale mällu, ning lisab hiljem igale API requestile. Konkreetne meetod pole oluline, aga kasutame vist 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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
[https://pilv.mana.ee/public.php?service=files&t=edaa0cf40fb840ba7a620d4c0252b49e Andmebaasi Skeem (DBDesigner) ]

== 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.
*'''13.12.2015''' - Prototüübi lisamine Wiki lehele.

== Lisad ==

[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_Application_proto20151211.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, kuid nende kuvamine etteantud vormidesse veel realiseerimisel - antud funktsionaalsus ei ole prototüübi jaoks vajalik;
* Vajutades taski nimetusele tehakse päring lokaalsesse baasi ning kuvatakse taski detailandmed (andmete muutmise funktsioon .DAL tasandil veel tealiseerimata).
* 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;

Meeskond: Spooky Scary Skeletons

2015-12-13T13:02:05Z

Ssaks: /* Prototüüp */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]]

'''UI - Client'''
*[https://msdn.microsoft.com/en-us/library/aa970268%28v=vs.110%29.aspx WPF]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[https://msdn.microsoft.com/en-us/library/dd203052.aspx REST]

Server kasutab klientidega suhtluseks RESTful apit ja JSON andmeformaati.

'''Autentikatsioon - Server'''

Kasutaja autentikatsioon toimub stateless auth mustrit kasutades.

Kasutaja autentimiseks saadab kasutaja oma kasutajanime, parooli ja juhuslikult genereeritud stringi 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.

Vastuseks saadud tokeni salvestab klientprogramm endale mällu, ning lisab hiljem igale API requestile. Konkreetne meetod pole oluline, aga kasutame vist 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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
[https://pilv.mana.ee/public.php?service=files&t=edaa0cf40fb840ba7a620d4c0252b49e Andmebaasi Skeem (DBDesigner) ]

== 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.
*'''13.12.2015''' - Prototüübi lisamine Wiki lehele.

== Lisad ==

[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_Application_proto20151211.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, kuid nende kuvamine etteantud vormidesse veel realiseerimisel - antud funktsionaalsus ei ole prototüübi jaoks vajalik;
* Vajutades taski nimetusele tehakse päring lokaalsesse baasi ning kuvatakse taski detailandmed (andmete muutmise funktsioon .DAL tasandil veel tealiseerimata).
* 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 on realiseeritud kasutaja autentikatsioon.

'''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;

Meeskond: Spooky Scary Skeletons

2015-12-13T13:01:15Z

Ssaks: /* Arendusprotsess */

[[Category:Programmeerimine CSharp keeles (2015)]]
== 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:

[[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 ==
=== Tehnoloogiad ===
'''DAL - Client'''
*[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]]

'''UI - Client'''
*[https://msdn.microsoft.com/en-us/library/aa970268%28v=vs.110%29.aspx WPF]
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 [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://msdn.microsoft.com/en-us/library/dd537609%28v=vs.110%29.aspx Task Parallel Library]
*[http://www.postgresql.org/ PostgreSQL]
*[https://msdn.microsoft.com/en-us/library/ms731082%28v=vs.110%29.aspx WCF]
*[https://msdn.microsoft.com/en-us/library/dd203052.aspx REST]

Server kasutab klientidega suhtluseks RESTful apit ja JSON andmeformaati.

'''Autentikatsioon - Server'''

Kasutaja autentikatsioon toimub stateless auth mustrit kasutades.

Kasutaja autentimiseks saadab kasutaja oma kasutajanime, parooli ja juhuslikult genereeritud stringi 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.

Vastuseks saadud tokeni salvestab klientprogramm endale mällu, ning lisab hiljem igale API requestile. Konkreetne meetod pole oluline, aga kasutame vist 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 ===
*[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 ===
*[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 ===
*[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 ===
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 ==
[https://pilv.mana.ee/public.php?service=files&t=edaa0cf40fb840ba7a620d4c0252b49e Andmebaasi Skeem (DBDesigner) ]

== 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.
*'''13.12.2015''' - Prototüübi lisamine Wiki lehele.

== Lisad ==

[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_Application_proto20151211.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, kuid nende kuvamine etteantud vormidesse veel realiseerimisel - antud funktsionaalsus ei ole prototüübi jaoks vajalik;
* Vajutades taski nimetusele tehakse päring lokaalsesse baasi ning kuvatakse taski detailandmed (andmete muutmise funktsioon .DAL tasandil veel tealiseerimata).
* 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 on realiseeritud API, mille kirjeldus asub aadressil [http://docs.ave.apiary.io/ http://docs.ave.apiary.io/]

'''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;

Meeskond: Spooky Scary Skeletons

2015-12-04T10:00:40Z

Ssaks: /* Tehnoloogiad */

Meeskond: Spooky Scary Skeletons

2015-12-03T12:41:43Z

Ssaks: /* Versioonikontroll */

Meeskond: Spooky Scary Skeletons

2015-12-03T12:40:39Z

Ssaks: /* Versioonikontroll */

Meeskond: Spooky Scary Skeletons

2015-12-03T12:40:29Z

Ssaks: /* Versioonikontroll */

Meeskond: Spooky Scary Skeletons

2015-12-03T12:34:42Z

Ssaks: /* Tehnoloogiad */

Meeskond: Spooky Scary Skeletons

2015-12-02T20:42:18Z

Ssaks: /* Projekti kirjeldus */

File:Ave localdb.png

2015-12-02T20:41:33Z

Ssaks:

Meeskond: Spooky Scary Skeletons

2015-12-01T16:46:37Z

Ssaks: /* Tehnoloogiad */

Meeskond: Spooky Scary Skeletons

2015-12-01T15:30:19Z

Ssaks: /* Tehnoloogiad */

Meeskond: Spooky Scary Skeletons

2015-12-01T15:28:18Z

Ssaks: /* Tehnoloogiad */

Meeskond: Spooky Scary Skeletons

2015-12-01T15:27:06Z

Ssaks: /* Tehnoloogiad */

Meeskond: Spooky Scary Skeletons

2015-12-01T15:25:46Z

Ssaks: /* Tehnoloogiad */