Produktrapport. Utvikling av moduler til CMS for bonefish.no. Gruppe 08-23

Transkript

1 Utvikling av moduler til CMS for bonefish.no Gruppe Produktrapport for hovedprosjektet utvikling av moduler til CMS for bonefish.no ved Høgskolen i Oslo, avdeling for Ingeniørutdanning våren 2008.

2 1. Forord Dette dokumentet er en produktrapport som er utarbeidet som en del av en bacheloroppgave i studiet anvendt datateknologi, ved Høgskolen i Oslo, i perioden høst 2007 til våren Produktrapporten er primært beregnet på de som skal vedlikeholde og videreutvikle systemet, og man bør derfor ha grunnleggende kunnskaper om emnet for at man skal få full forståelse av det som blir presentert. Det blir her gitt forklaringer på hva som er brukt for å få systemet til å virke og hvordan hver funksjon virker i forhold til hverandre. Hvis man ikke har kjennskap til emnet, eller prosjektet ellers så er det anbefalt at man leser igjennom prosessrapporten for å få ett klarere bilde på hva prosjektet går ut på. 2

3 2. Innholdsfortegnelse 1. Forord Innholdsfortegnelse Innledning Om bedriften Dagens situasjon Beskrivelse av systemet Teknologi og verktøy Teknologi Verktøy Database Systemet oppbygning Online demo Oppbygning Filstruktur Mappe: css Mappe: img Mappe: include Mappe: js Mappe: jscripts Mappe: userdir

4 3. Innledning 3.1. Om bedriften Nomedia Norge leverer flere forskjellige tjenester til privat, bedrifter og det offentlige. Nomedia er et firma sammensatt av 3 selvstendig næringsdrivende som ønsket å samarbeide for å kunne nå ut til et bredere kundeegment, samt å få et bredere produktspekter. Nomedia ble stiftet våren 2007 men eierne har vært i bransjen siden 90- tallet. Bedriften er delt opp i 2 avdelinger Hurum IT og bonefish.no, samtidig som de er deltaker i andre prosjekter. Hurum IT Leverer IT-løsninger til private, bedrifter og offentlige instanser i Hurum. De driver med salg, service, suppport, drift og rådgivning i forhold til dette. Bonefish.no er den delen av Nomedia Norge dette hovedprosjektet er knyttet til. Bonefish.no leverer websider og webløsninger primært til bedrifter. Bonefish.no har hele Norge som nedslagsfelt, og satser høyt på design og enkel funksjonalitet. Bonefish.no leverer også skreddersydde websystemer / løsninger etter kundens ønske Dagens situasjon Bonefish.no bruker i dag et egenlagd CMS som er tungvindt i bruk. Det tar lang tid å implementere nye sider inn i systemet, dette gjøres i dag manuelt. Funksjonaliteten inne i systemet er enkelt, men noe uoversiktlig. Ulempen med dagens system er at det er lite skalerbart, det passer kun til enkle websider. Dette er noe bonefish.no ønsker å endre slik at de kan tilby et bredere spekter av websider Beskrivelse av systemet Vi skal lage moduler til et system som gjør at alle brukerne kan gjøre alle oppgaver direkte i nettleseren. Systemet skal kunne tilpasses hver enkelt bruker og løsning via en konfigurasjonsmodul. For å videreutvikle systemet skal vi utføre en undersøkelse blant eksisterende kunder for å finne ut om hvilken funksjonalitet og muligheter de savner i det eksisterende systemet, samt vurdere muligheten for å implementere savnet funksjonalitet og muligheter til de nye komponentene. 4

5 Bonefish.no utvikler på LAMP (Linux, Apache, mysql, PHP) plattformen. Vi bruker samme plattform i forhold til å kunne tilpasse og muligheten for å integrere systemene. LAMP er en open-source plattform. Vi benytter oss av bonefish.no sin eksisterende serverpark for utvikling og testing av det vi lager. Fordelen med å utnytte LAMP som plattform er at det er gratis, det finnes mye informasjon, diskusjonsgrupper og inspirasjon på internett samtidig som LAMP er en kraftig og funksjonell plattform som passer perfekt til denne type system. 5

6 4. Teknologi og verktøy 4.1. Teknologi Her beskriver vi hva slags teknologi vi har brukt i systemet PHP PHP (Hypertext Preprocessor) er et programmeringsspråk som passer utmerket til utvikling av webløsninger. PHP gjør at vi kan lage dynamiske websider som kommuniserer med database for lagring av data MySQL MySQL er en kraftig og fleksibel open-source databasemotor HTML HTML (HyperText Markup Language) er et markeringsspråk for websider. Vi genererer HTML-sidene med PHP og sidene blir dermed dynamiske CSS CSS (Cascading Style Sheets) er stilark for HTML. Ved bruk av CSS man lage oversiktlig layout og styling av skrift osv Javascript Javascript blir brukt for å gjøre interaksjon mellom brukeren og systemet enklere. For eksempel er teksteditoren (TinyMCE) laget i dette språket. Javascript blir også brukt for å gi brukeren enkle tilbakemeldinger og varsel før sletting osv Debian Linux Debian Linux er operativsystemet utviklingsmiljøet kjører på. Det er også samme operativsystem som blir brukt i produksjonsmiljøet til bonefish.no. Debian er en stabil og velrenommert Linux distribusjon som ofte blir foretrukket til serverløsninger. 6

7 4.2. Verktøy Dette er en beskrivelse av verktøy og programvare vi har brukt i forbindelse med utviklingen UltraEdit Ultraedit er en enkel men kraftig teksteditor. Denne lar oss koble oss direkte mot serveren for å arbeide med filene direkte. Dette gjør at vi kan teste ut funksjoner og moduler kontinuerlig phpmyadmin phpmyadmin er et webbasert adminstrasjonsverktøy for MySQL databasen. Her kan man gjøre de endringer som er nødvendige samt administrer databasen, ta backup osv WinSCP WinSCP er en klient som gjør at vi kan overføre filer over SSH protokollen. Dette er en kryptert og sikker protokoll. WinSCP blir brukt til å overføre filer, bilder og annet som skal brukes i systemet Generelle linux verktøy Vi har brukt SSH til å gjøre enkle endringer i filstruktur og mapper på serveren. Via SSH kan man logge seg på serveren og gjøre endringer direkte i kommandolinjen. 7

8 5. Database Her er en enkel oversikt over tabeller som blir brukt i systemet. Fullstendig oversikt over databasen finnes på CD article_category Tabell som holder oversikt over brukerens artikkelkategorier. Brukes av artikkelmodulen article Inneholder artiklene som er tilknyttet kategoriene i punkt 5.1. Brukes av artikkelmodulen article_text Tekst og innhold i artiklene vi har lagt til en ekstra tabell her for å senere kunne ha flere versjoner av artiklene lagret i databasen. Brukes av artikkelmodulen entity Inneholder informasjon av brukerne. Brukes av brukermodulen og loginklassen customer Enkel oversikt over kunder (firmaoversikt). Brukes av brukermodulen og loginklassen customer_entity Knytter sammen brukere (entity) med kunder (customer) gjør at man kan koble flere brukere opp mot samme kunde. Brukes av brukermodulen og loginklassen gallery Oversikt over gallerier. Brukes av gallerimodulen gallery_images Oversikt over bildene i galleriet. Brukes av gallerimodulen images_original Oversikt over alle bilder som blir lagt inn i systemet holder orden på originalt filnavn, eier osv. Brukes av gallerimodulen. 8

9 5.10. images_resized Inneholder referanse til bilder som har blitt automatisk beskjært for å passe inn på websiden. Brukes av gallerimodulen menu Inneholder oversikt og styringsdata for menyer. Brukes av menymodulen menu_item Inneholder oversikt over elementer i menyen. Brukes av menymodulen site Inneholder data for websider. Brukes av sidemodulen Websites Oversikt over webområder. Knytter sammen modulene. 9

10 6. Systemet oppbygning 6.1. Online demo Demo av systemet med våre moduler finnes på nett. Her har vi lagt inn et enkelt webområde som oppsummerer funksjonaliteten i systemet. Webadresse: Brukernavn: demo@bonefish.no Passord: temp Oppbygning Her forklarer vi systemet grafiske oppbygning med tilhørende skjermprint fra demo. Det står forklaring under hvert bilde Logg inn 10

11 Logg inn med demo bruker for å få tilgang til demo Webområdeoversikt Her får man en oversikt over meny og tilgjenglige moduler på websiden Meny Menyen viser oppbygningen på websiden. Her kan man trykke direkte på en underside og komme til gjeldene modul. Modulen kan vises også med ikon. Se bilde over. 11

12 Moduler Sider Her får man en oversikt over hvilke sider brukeren har samt man får mulighet til å velge side eller slette den. Man kan også lage ny side direkte. 12

13 Velger man en side, får man tilgang til en editor som gjør at man kan endre innholdet på siden. 13

14 Galleri Oversikt over gallerier som er tilknyttet webområdet. Her kan man velge et galleri for å vise mer avanserte innstillinger og muligheter. 14

15 Nyheter Oversikt over artikkelkategorier som er tilknyttet webområdet. 15

16 Her kan man velge en kategori for å vise artikler som ligger i kategorien. 16

17 Man kan legge til ny nyhet eller endre eksisterende. 17

18 7. Filstruktur Alle filer er i tillegg lagt på CD som vedlegg til rapporten Mappe: css Inneholder stilark for systemet Mappe: img Bildemappe. Inneholder bilder og ikoner Mappe: include Mappe: classes Inneholder alle klassene med funksjoner som styrer systemet. Alle klassene er gjennomgått og optimalisert. Vi har valgt å la de gamle funksjonene ligge, slik at alt blir bakoverkompatibelt dette var etter ønske fra bonefish.no. Klassene inneholder kommentarer som forklarer funksjonalitet Mappe: html Her finnes header, loginform og footer i egne filer. Disse filene blir inkludert i systemet Mappe: modules En mappe for hver modul, men fast filstruktur på alle moduler Index.php fil som styrer forsiden og visningen av modulen Id.php fil som styrer modulen ned på detaljnivå Init.php fil som blir kjørt før header her skjer det meste av logikken osv. 18

19 7.4. Mappe: js Inneholder javascript filer og funksjoner Mappe: jscripts Mappe for javascript programmer TinyMCE ligger i denne mappen Mappe: userdir Her lagres data per kunde. Om for eksempel en kunde trenger en skreddersydd modul så lagres denne her. 19