Lehekülje Võrgurakendused 2012 prax 1 lähteteksti vaatamine

Sisuliselt sama ülesanne väikeste nüansivahedega on olemas [[Vorgurakendused 2 prax 1|2010 ja 2011 aasta arhiivis]]. 

Ülesandeks on ehitada chatirakendus, mis leiab teisi kasutajaid ise tehtud P2P mehhanismi abil. 
Fookus ongi teiste kasutajate leidmisel, mitte niivõrd mugava chati tegemisel.
 
== Üldkirjeldus ja nõuded ==

Rakendus peab eeskätt suutma leida üles teise kasutaja (nime järgi, näiteks "jaanus") masina
ja võtma ühendust selles masinas oleva chatirakendusega. Selleks on vaja nime järgi teada saada ip ja port.
Kui ühendus on saadud, peab töötama chat: mingeid kellasid ja vilesid chati jaoks (näod, värvid vms vms) ei ole praksi jaoks vaja teha.

Nimede seost ip ja pordiga hoitakse iga rakenduse masinas eraldi failis, mingit keskset serverit ei ole. Rakendused jagavad neid faile omavahel ja täiendavad oma faili teistelt saadud infoga.

Vaata ka [[võrgurakendused 2 prax 1 näide | väikest näitestsenaariumi]].

Esimese kasutamise korral tuleb oma nimi registreerida ja rakendus peab kontrollima, et see nimi
ei oleks kellegi poolt juba kasutusel.

Rakendus peab ühenduma teiste rakendustega hariliku http protokolli kaudu, allpool on toodud detailid.

Programmeerimiskeele ja muu tehnoloogia valik on vaba, kuid rakendus peab vastama neile tingimustele:
* Kogu programm peab töötama kas AK klassi arvutis või teie oma läptopis, mis AK klassis kaasas. Mingit kaugel asuvat serverit põhirakenduse jaoks kasutada ei tohi.
* Http protokolli jms realisatsioon peab olema teie oma programmi osa, mingit "suurt" http serverit a la apache kasutada ei või.

== Praksi kaks osa ==

Väga soovitav on teha praks kahes osas ja esitada kaks korda ülevaatamiseks:

* Teha http protokolli järgida suutev esmane rakendus.
* Lisada sinna kogu vajalik funktsionaalsus.

Http protokolli järgimise võimet kontrollitakse praksi eduka läbimise tingimusena.

== Soovitusi ja ideid ==

Chatiprogramm peab päris kindlasti sisaldama või kasutama http serverit, 
muidu ei ole temaga võimalik väljast ühendust võtta. NB! See ei tähenda mingit nö suurt veebiserverit a la apache, vaid pigem ise kirjutatud väikest minimaalset serverit, mis pealegi ei pea veebilehti serveerima ja cgi-sid käivitama, vaid ainult teatud käskudele/parameetritele reageerima.

Server tuleb realiseerida ise, kasutades võrgust leitavaid näiteid mikro-http-serveri jaoks (tüüpiliselt paar lehekülge koodi). Selliseid näitekoode võib täiesti otse kasutada.

C jaoks on sobiv mikroserver näiteks [http://www.lambda.ee/images/8/89/Itsissejuhatus_tiny.zip tiny], java jaoks 
on [http://www.java2s.com/Code/Java/Tiny-Application/HttpServer.htm see server] väga hea väike näide, aga selgitava tekstita,
ning selgitavate tekstidega servereid leiad mh [http://onjava.com/pub/a/onjava/2003/04/23/java_webserver.html siit] ja
[http://fragments.turtlemeat.com/javawebserver.php siit].Loe java socketitest põhjalikumalt [http://download.oracle.com/javase/tutorial/networking/sockets/ siit]. Pythoni serverinäite [http://muharem.wordpress.com/2007/05/29/roll-your-own-server-in-50-lines-of-code/ saad siit]. Http kohta võib lugeda [http://www.jmarshall.com/easy/http/ näiteks siit].

Kasutajaliides võib olla tehtud aknaga nagu chat enamasti on, aga see ei ole kohustuslik: võib teha ka puhtalt käsurea rakenduse, mille kutsud välja oma ja otsitava nimega (või uue nime tegemise käsuga) ja mis küsib siis käsurealt järjest sinu teksti ja trükib teise tekste välja. Selline rakendus peab siis ikkagi suutma järjest lugeda sinu kirjutatut ja järjest trükkima saadud tekste, st interaktiivsus on kindlasti vajalik.

Rakendus on mõistlik teha nii, et annad käivitamisel ette pordi, millel ta räägib ja oma nime: selliselt saad ühte masinasse kergesti käima panna erinevaid chatte ja siis ühe masin piires debugida. Arusaadavalt peaks siis andmefail olema ka iga chati jaoks erinev: kas fail sisaldab pordi nime või antakse tema nimi samuti ette. Muidugi oleks kena teha nii, et kui neid parameetreid käivitamisel ette ei anna, siis kasutab ta vaikeväärtusi.

Häid selgeid näiteid ja õpetusi socketite ja serveri tegemise kohta leiad veel siit:

* [http://www.prasannatech.net/2008/07/socket-programming-tutorial.html socketite kasutamise õpetus ja source C-s, javas ja pythonis]
* [http://www.jbox.dk/sanos/webserver.htm lihtne veebiserver C-s (eksootilise sanosi all)]
* [http://www.ibm.com/developerworks/systems/library/es-nweb/index.html lihtne veebiserver/klient C-s (ibm-i tutorial ja source)] 
* [http://www.lambda.ee/images/8/89/Itsissejuhatus_tiny.zip tiny webserver C-s]
* [http://download.oracle.com/javase/tutorial/networking/sockets/ java socketid: klassikaline tutorial]
* [http://www.tud.ttu.ee/material/kallik/JOOP/Jutukas/ Kaarel Alliku kursuse näite-jutukas (java)]
* [http://www.rgagnon.com/javadetails/java-have-a-simple-http-server.html java http teegi kasutamine, mis kasutab socketeid sisemiselt]
* [http://tomayko.com/writings/unicorn-is-unix ruby]
* [http://jacobian.org/writing/python-is-unix/ python]
* [http://docs.python.org/library/socketserver.html pythoni üks serversocketi-teek]
* [http://beej.us/guide/bgnet/ Väga põhjalik socketite/võrguprogrammeerimise õpetus]
<!-- * [http://heather.cs.ucdavis.edu/~matloff/Python/PyNet.pdf Pythoni socketiprogrammeerimise õpetus] -->

== Firewall ja NAT ==

Firewallist läbi murdmise ja kinniste portidega ühendamise probleemiga ei pea selles praksis tegelema. Samas tähendab see, et ei ole kuigi lihtne teise masinaga tegelikult ühendust saada (ühes masinas debugimise võimaldamine ongi seepärast kriitiline).

Kes chati käima saab, võib mõelda välja ja realiseerida probleemi lahendamiseks sobiva vaheserveri: selle eest saab ekstrapunkte. 

Võrgust infot otsides leiad kahte liiki teemasid, meie jaoks oluline on siit listist teine:
* Tunneldamise artiklid, loe näiteks [http://en.wikipedia.org/wiki/HTTP_tunnel http tunnel] artiklit wikipediast ja [http://sebsauvage.net/punching/ seda artiklit] firewallist läbipääsemisest.
* UDP/TCP hole punching ja NAT traversal: arusaadava sissejuhatusena loe [http://www.h-online.com/security/features/How-Skype-Co-get-round-firewalls-747197.html Skype jms süsteemide meetoditest], sellele [http://www.portugal-a-programar.org/forum/index.php?topic=7852.0 väike täiendus]. Vaata ka [http://en.wikipedia.org/wiki/Session_Traversal_Utilities_for_NAT wikipedia utiliitide artiklit ja viiteid].   Detailsemalt/lisaks [http://www.brynosaurus.com/pub/net/p2pnat/ siit] ja [http://nutss.gforge.cis.cornell.edu/pub/imc05-tcpnat/ siit] ja [http://www.jdrosen.net/midcom_turn.html siit] ja [http://www.ietf.org/rfc/rfc3489.txt siit], keerulise vahendi leiab [http://natblaster.sourceforge.net/ siit]

NB! Seda kõike ei ole väga lihtne teha ja sinu chatiklient (ja ka selle inimese chatiklient, kellega suhtled) peab ka oskama seda vaheserverit kasutada. Ära hakka seda ehitama, kui nö lihtne chat veel ei tööta!

Ekstra-lisapunktide saamise variant: realiseeri ja pane kõigile kasutatavaks firewalliprobleemi lahendamiseks sobiv vaheserver. Kirjuta kasutamise juhend ja näited, mida teised saaks soovi korral oma chatiproge jaoks tarvitada (st panna nad sinu vaheserverit kasutama, nii et seda saaks ka arvutiklassist kasutada). Esimesed kaks gruppi, kes sellega hakkama saavad, saavad lisaks pooled praksipunktid!

== Punktiarvestusest ==

Kui kõik eelnimetatu töötab vastu mõne teise grupi chatiprogrammi ja 
koodi suudetakse seletada, saab täispunktid.

Kui teiste chatiprogrammidega eriti ei suuda suhelda, aga iseenda koopiatega siiski, saab miinuspunkte.

Oma lisa-asjade ehitamise ja töötamise demo korral (mitme kasutaja chat vms) saab täispunktidele lisaks 
lisapunkte.

== Detailid: mis info peab rakendusel olema ja kuidas tegutseb ==

* mul omal on fail nimi/ip_pluss_port paaridega järgmise json süntaksiga (palun realiseerida täpselt nii, st eraldi klambri-read alguses ja lõpus ja ei mingeid tühikuid väljapool isikunime ja eeldusega, et nimes pole jutumärke: siis saab seda faili kergesti parsida ja muuta ka ilma spetsiaalselt json-parserit kasutamata).

<pre>    
  [
  ["Tanel Tammet","22.33.44.55:6666"],
  ["Peeter Laud","22.33.44.11:6666"]
  ]
</pre>
  

* pean saama registreerida oma nime (ühekordne): minu masin saadab minu nime ja ip igalepoole ja need saadavad edasi ja need saadavad jälle edasi ja kui keegi leiab et on, siis saadab mulle teate, et juba hõivatud
** login sisse, annan oma nime
** minu rakendus saadab kõigile/osale teada ip-dele minu nime ja pika id ip ja nemad updatevad oma tabeli    

* pean leidma kasutaja, kellega tahan suhelda, ip ja pordi.  Tulemus oleks (vähemalt) tema ip teadasaamine.
** kirjutan nime.
** omal on mul fail nimi/ip paaridega. Kui sealt leian, ok.
** kui ei, küsin teiste masinatest nende faile, kasutades minu failis olevaid ip-sid. Nemad lihtsalt saadavad oma faili.
** kui ma leian tabelist nime, korras, katkestan
** kui ma lõpuks ei leia, siis kaks varianti: 
***  otsin ise uuelt ringilt ip-delt, mis sain (see peab töötama)
***  saadan kõigile oma faili ip-dele info, et nemad otsiks mulle (kui see realiseerida ja katsetada, saab veidi lisapunkte) 

* pean saama leitud id ja pordiga chatiprogrammile oma teksti saata ja tema teksti kuvada

== Detailid: millist protokolli ja eeldusi rakendus kasutab ==


Algul vaikimisi port on 6666, kuid see peab olema suhteliselt kergelt muudetav (ümberkompileerimine on ok, aga soovitav on käivitada chat koos käsurealt antava pordiga).

Ip esitatakse alati koos pordiga.

Time to live (TTL) on number, mida päringu edasisaatmise juures tuleks vähendada ja null TTL-ga päringut ignoreerida, kui tegu info edasisaatmisega. Enamuse päringute juurs võib seda ignoreerida, ta on protokollis juhuks, kui soovida realiseerida lisaks edasisaatmist.
  
* Nime olemasolu küsimine on asünkroonne: esitad päringu ja kunagi hiljem saadetakse sulle vastus tagasi.

     http://11.22.33.44:PORT/chat/findname?name=NIMI&myip=22.22.33.44:6666&ttl=TIMETOLIVE

Vastust ignoreeritakse! Päringu saaja peaks nime leidmise korral (mitte muidu!) omakorda saatma vastuspäringu (seda siis arvestatakse):

  
* Vastuse saatmine nime küsimisele:

     http://11.22.33.44:PORT/chat/sendname?name=NIMI&ip=22.22.33.44:6666&ttl=TIMETOLIVE

Sisu ignoreeritakse! Saadud päring tähistab lihtsalt, et nimi on leitud selle ip-ga.

* Minu nime/ip teatamine on sama kui eelmine päring, näiteks

     http://11.22.33.44:PORT/chat/sendname?name=NIMI&ip=22.22.33.44:6666&ttl=TIMETOLIVE
  
* Nimed/ip_pluss_port faili küsimine on sünkroonne, st vastus tuleb otse päringuvastusena: 

     http://11.22.33.44:PORT/chat/asknames?ttl=TIMETOLIVE

Vastuseks antakse fail ise, json formaadis: 
  
<pre>    
  [
  ["Tanel Tammet","22.33.44.55:6666"],
  ["Peeter Laud","22.33.44.11:6666"]
  ]
</pre>

* Chatisõnumi saatmine

    http://11.22.33.44:PORT/chat/sendmessage?myname=tanel&myip=22.33.44.55:6666&message=asasas&ttl=TIMETOLIVE