KNEWS Messaging system

Transcript

1 KNEWS Messaging system 1. Indice 1. Indice 1 2. Introduzione 2 3. Descrizione generale 2 4. Struttura generale Admin Client Conf Images Profiles Sh Wap 9 5. Descrizione database 5.1 Adv_appelli Adv_corsi Adv_lauree Corsi Lauree News Users Installazione Copyright 13 1

2 2. Introduzione Il sistema knews permette la creazione e l'utilizzo di un sistema di messaggistica webbased. Oltre ad inviare notifiche via il sistema permette di consultare online gli avvisi inseriti, sia con browser tradizionale che terminale wap. L'applicativo e' stato sviluppato e testato utilizzando Apache v1.3, PHP4 e mysql v Descrizione generale Il sistema e' diviso idealmente in due sezioni : amministratore e utente. Nel lato utente uno studente ha la possibilita' di registrarsi, creare e modificare il proprio profilo personale. All'interno del profilo oltre ai propri dati e' possibile specificare nel dettaglio a quali avvisi si e' interessati in modo da ricevere una notifica via alla pubblicazione di news di tale tipologia. Tale sezione e' accessibile sia via browser tradizionale che da terminale wap. Nel lato amministratore,invece, si hanno la gestione e l'inserimento degli avvisi, categorie (nel nostro caso corsi di laurea e di insegnamento) e utenti. 4. Struttura generale La struttura del filesystem del progetto e' la seguente : 4.1. DocumentRoot del progetto, contentente solo i files error.php, utilizzato per la visualizzazione dei messaggi d'errore ed index.php. In index.php viene effettuato il riconoscimento del device che richiede la pagina, facendo di conseguenza il redirect alle pagine per browser tradizionale o terminale wap. Il controllo viene effettuato analizzando l'header della richiesta http nel modo seguente : $stracceptheader = $_SERVER['HTTP_ACCEPT']; if( strpos($stracceptheader, "vnd.wap.wml") == false ) { header("location:./client/site.php?page=readnews"); } else { header("location:./wap/readnews.php"); } 4.2 admin Questa directory contiente l'intera sezione per l'amministrazione-redazione del progetto. Per accedere alle varie funzionalita' e necessario effettuare prima un'operazione di login che permetta di riconoscere l'utente e determinare il suo livello di permessi : 2

3 Tali livelli sono : Livello 0 Livello 1 Livello 2 Livello 3 - ROOT : gestione news, categorie e utenti - NEWSADMIN : gestione news, per ogni corso/laurea - DOCENTE : gestione news solo per il proprio corso - UTENTE : nessuna operazione consentita Tra le funzionalita' offerte nella sezione amministrativa: Gestione news (livelli 0, 1, 2) : agli admin di livello 0 e 1 e' consentito di inserire qualsiasi tipologia di news, per qualsiasi corso d'insegnamento o laurea. Per il livello 2, ovvero il docente, e' possibile solamente gestire avvisi relativi al proprio corso. Oltre all'inserimento sono previste le operazioni di modifica e cancellazione delle news stesse. E' inoltre possibile formattare il testo ed inserire link a siti web o indirizzi nel corpo dell'avviso. 3

4 Gestione lauree (livello 0) : inserimento, modifica e cancellazione dei vari corsi di laurea per cui e' possibile inserire avvisi Gestione corsi (livello 0) : inserimento, modifica e cancellazione dei vari corsi d'insegnamento per cui e' possibile inserire avviso. Per i corsi d'insegnamento inoltre e' possibile assegnare il docente. Gestione utenti (livello 0) : inserimento, modifica e cancellazione degli utenti. Con l'operazione di modifica e' possibile modificare i dati dell'utente oltre al suo livello di permessi. Ogni modifica oltre che sul db ha effetto sul profilo xml dell'utente interessato. Modifica del profilo personale (livelli 0, 1, 2) In questa directory e' infine presente kcode.js, al cui interno si trovano i vari javascript utilizzati per la formattazione in html del testo delle news e tutti i controlli per la validazione lato client dei dati da inserire. 4

5 4.3 client In questa directory si trovano tutte le pagine php accessibili agli utenti comuni, registrati o meno. Le funzionalita' disponibili sono : Lettura avvisi : gli avvisi sono accessibili da un'elenco paginato. Per ogni avviso vengono visualizzati titolo, data di inserimento, autore, tipologia ed i primi 300 caratteri della notizia : Dettaglio avviso : il testo dell'avviso per intero in una popup ( in caso sia piu' lunga di 300 caratteri), o in una nuova finestra in versione printer-friendly. avviso : e' possibile inviare il link alla pagina del dettaglio dell'avviso ad un indirizzo specificato in una popup come la seguente : Registrazione : form che consente di registrarsi al servizio, indicando i propri dati anagarficie e di accesso. E' inoltre possibile indicare a quali tipologie di news si e' interessati e in dettaglio a quali corsi di laurea e di insegnamento. In base alle proprie preferenze il sistema una volta al giorno provvedera' ad inviare presso l' con cui ci si e' registrati delle notifiche per le news che riguardano la tipologia o i corsi scelti. I profili vengono memorizzati sia all'interno di una tabella nel database che in un file.xml per ogni utente. 5

6 Profilo personale : modifica dei propri dati personali, della password di accesso e delle preferenze per quanto riguarda le notifiche degli avvisi. NOTA : dati anziche' dal database per questa operazione vengono letti e interpretati con il parser xml di php dal profilo.xml dell'utente. 6

7 4.4 conf Directory contentente i file comuni a tutto il progetto: Common_db.php : al suo interno sono definite le funzioni di connessione al database e tutti i dati e le variabili globali utilizzate. Puo' essere considerato il file principale per la configurazione : //server (url dove e' installato knews ) $serveraddr=" //nome del database $db_name="tecweb"; // hostname della macchina con mysql $dbhost='localhost'; // username per mysql $dbusername='andrea'; // password $dbpassword='winter_is_coming'; Setup.php : script php per la creazione del database e delle tabelle utilizzate. Stile.css : foglio di stile usato in tutte le pagine del progetto Xml.php : script dove sono definite le funzioni e callback utilizzate nella scrittura e nel parsing dei profili utente. 4.5 images Directory contentente le immagini utilizzate nelle varie pagine 4.6 profiles Directory contentente i profili xml di utenti e amministratori. Un esempio di profilo utente e' il seguente : <USER> <NOME>Andrea</NOME> <COGNOME>Beretta</COGNOME> <CELL>347*******</CELL> < >kai@stargazer.localdomain</ > <USERID>andrea</USERID> <PASSWORD>mBSXeAEgqnpPw</PASSWORD> <COD_USER>5</COD_USER> <CLASS>3</CLASS> <DATAREG> </DATAREG> <SEM_ADV>1</SEM_ADV> <LAUREA_ADV> <LAUREA_COD>info222</LAUREA_COD> </LAUREA_ADV> <CORSO_ADV> <CORSO_COD>Metodi33</CORSO_COD> <CORSO_COD>Tecweb44</CORSO_COD> </CORSO_ADV> <APPELLO_ADV> <APPELLO_COD>sweng33</APPELLO_COD> </APPELLO_ADV> </USER> 7

8 4.7 sh Directory contentente gli shellscript per la cancellazione delle vecchie news e l'invio giornaliero delle mail di notifica agli utenti registrati. Per l'eliminazione delle news viene avviato il client mysql per eseguire le seguenti istruzioni : use tecweb; DELETE FROM news WHERE ( now() > data_scad) ; Per l'invio delle mail di notifica invece non potendo richiamare php dalla linea di comando, viene richiamato lo script che svolge l'operazione all'interno di uno shellscript, utilizzando wget : wget -q -O /dev/null 8

9 4.8 wap Directory contentente le pagine.php accessibili dai terminali wap, con l'output formattato in wml. Per indicare che si tratta di una pagina per terminali wap all'inizio di ognuna di esse e' stato necessario specificare il mime type inserendo le seguenti righe : <? header("content-type: text/vnd.wap.wml"); echo "<?xml version=\"1.0\"?>";?> <!DOCTYPE wml PUBLIC "-//WAPFORUM//DTD WML 1.1//EN" " Le funzionalita' disponibili sono le stesse delle pagine della sezione client. Ovviamente l'output delle pagine e' stato poi formattato in wml e lo schema di navigazione modificato per adeguarsi allo schermo di un telefono cellulare. NOTA : per testare le pagine accessibili da terminali wap e' stato usato Deck-It WML previewer ver

10 5. Descrizione database Il database utilizzato dal sistema e' costituito dalle seguenti tabelle : 5.1 Adv_appelli cod_user : codice utente cod_corso : codice corso d'insegnamento 5.2 Adv_corsi cod_user : codice utente cod_corso : codice corso d'insegnamento 5.3 Adv_lauree cod_user : codice untente cod_laurea : codice corso di laurea 5.4 Corsi cod_corso : codice del corso d'insegnamento id_corso : nome del corso cod_docente : codice docente titolare del corso cod_adm : codice dell'amministratore che ha inserito il corso 10

11 5.5 Lauree cod_laurea : codice del corso di laurea id_laurea : nome del corso di laurea cod_adm : codice dell'amministratore che ha inserito il corso 5.6 News cod_avviso : codice numerico dell'avviso data_ins : data inserimento dell'avviso data_scad : data di scadenza dell'avviso cod_adm : codice dell'admin o docente che ha inserito l'avviso cod_corso : codice del corso a cui l'avviso si riferisce cod_laurea : codice della laurea a cui l'avviso si riferisce type : tipologia di avviso subject : titolo dell'avviso body : testo dell'avviso flag_sent : flag per indicare se l'avviso e' gia' stato notificato via 11

12 5.7 Users cod_user : codice utente cognome : cognome dell'utente nome : nome dell'utente cell : numero di cellulare mail : indirizzo userid : username scelto dall'utente password : password scelta dall'utente class : classe dell'utente ( 0 3 ) sms_flag : flag per indicare che l'utente vuole ricevere le notifica via sms ( TODO ) mail_flag : flag per indicare che l'utente vuole ricevere le notifiche via regdate : data di registrazione adv_seminari : flag per indicare che l'utente vuole essere notificato per gli avvisi di seminario. 12

13 6. Installazione Per installare il sistema e' necessario svolgere le seguenti operazioni : 1)Scaricare il file knews0.3.tar.gz da 2) Decomprimere il file ( tar -zxvf ) in una directory accessibile al webserver, ad esempio in /var/www/tecweb. 3) Assicurarsi di avere installato e configurato correttamente un MTA, per esempio postfix, per l'invio delle mail di notifica. 4) Editare il file common_db.php contenuto nella directory conf : //server (url dove e' installato knews ) $serveraddr=" //nome del database $db_name="tecweb"; // hostname della macchina con mysql $dbhost='localhost'; // username per mysql $dbusername='andrea'; // password $dbpassword='winter_is_coming'; 5) Inserire come cronjob gli shellscript clean_db.sh e mail.sh contenuti nella directory sh 6) Aprire con un browser la pagina per creare le varie tabelle del database, supposto knews sia accessibile all'url 7) Per la gestione andare all'url usando root come username e password come password. 7. Copyright Knews e' un progetto realizzato per l'esame di Tecnologie web presso il Polo di didattica e ricerca di Crema, sviluppato da Beretta Andrea. Il progetto e' completamente opensource e distribuito secondo i termini della GNU General Public License. Per informazioni: oppure beretta[dot]andrea[at]libero[dot]it 13