##
## RSS roomaja kasutusjuhend
## kuupäev: 18.03.2012
## koostas: Oliver Soop
##

Nõuded tarkvarale:
	Rakendusserveri olemasolu (Soovitatavalt Apache server)
	PHP (Vähemalt versioon 5.0, sisselülitatud cURL moodul)
	Andmebaas (Soovitatavalt MySQL)
Nõuded riistvarale:
	Vajalik internetiühendus ning vastava tarkvara käivitamiseks sobilik riistvara


RSS roomaja on programm, mis võimaldab leida sisend url-i/ide põhjal RSS voogusid ning teises
töövoos nendes RSS voogudes kuvatavat informatsiooni andmebaasi salvestada.

Programmi käitamiseks on tarvis paigutada see rakendus mõnele serverile ning käivitada andmebaasi
skriptid vastavalt kasutatavas andmebaas:
		 	crawler/database/ekktt.sql
			crawler/database/crawler.sql
			
Määrata on tarvis ka andmebaasiga ühendumiseks vajalikud kasutajatunnused järgnevates failides:
			database/Database.php real 45
			datbase/URLDatabase.php real 36
	

Rakendusel töö käivitamiseks on olemas kasutajaliides, mis asub /ui/UserInterface.php, 
seal on võimalik käivitada nelja erinevat töövoogu:
	a) RSS voogude leidmine
		1. Sisendina antakse sisend url, mida mööda hakatakse leidma RSS voogusid
		2. Sisendiks antakse .csv fail, mis sisaldab url-e ja kus hakatakse leidma RSS voogusid
		
		*Lisaks on võimalik kaasa anda ka järgmised parameetrid:
			1. Aja limiit, mille jooksul ühte sisend url-i töödeldakse(vaikimisi 600 sekundit)
			2. Maksimaalne RSS voogude arv, mida otsitakse(vaikimisi 20)
			Piirangute panemine on tingitud asjaolust, et igal PHP skriptil on seatud automaatselt maksimaalne
			käivitamisaeg, et rakendus saaks ilma takistusteta oma tööd jätkata võib panna voogude arvu piirangu
			või panna selle ajalise piirangu võimalikuks suureks, et ei tekiks töö katkemisohtu.
			
	b) RSS voogudest sisu alla laadimine
		1. Andmebaasis olevate RSS-voogude nimekirjas olevatest RSS-idest sisu andmebaasi salvestamine
		(Sisaldab eelnevalt leitud RSS-voogusid)
		2. Sisendiks antava RSS-voo sisu andmebaasi salvestamine(NB! Kui pole tegemist RSS-vooga, siis sisu andmebaasi
		ei salvestata)

Samuti on võimalik rakenduse tööd käivitada vastavate shell skriptidega
Kaustas scripts asuvad kaks faili startRSSCrawling.sh ja startUrlCrawling.sh.

	startRSSCrawling.sh - käivitab RSS-voogude sisu roomamise, käivitamisel antakse ette üks parameeter
						  käivitatavate PHP interpretaatorite arv, andmebaasis olevad RSS-voo URL-id
						  jagatakse interpretaatorite vahel võrdselt
	
	startUrlCrawling.sh - käivitab RSS voogude leidmise, käivitamisel antakse ette üks parameeter
						  käivitatavate PHP interpretaatorite arv, andmebaasis olevad sisend URL-id
						  jagatakse interpretaatorite vahel võrdselt
		