YOURLS - izrada vlastitog servisa za skraćivanje URL-ova

Napomena: Ovaj članak izvorno je objavljen na portalu Sistemac dana 26. lipnja 2011.

U jednom od prošlih članaka prikazali smo tipične online servise za skraćivanje URL-ova, dok smo u prošlom članku o URL-ovima pokazali kako možemo ostvariti preusmjeravanje i skraćivanje URL-ova. Kao što smo i najavili, pokazat ćemo kako je moguće napraviti vlastiti servis za skraćivanje URL-ova pomoću aplikacije YOURLS.

Sustav koji će biti opisan u ovom članku ima izuzetno jednostavno riješeno upravljanje korisnicima — ne postoji mogućnost samostalnog stvaranja korisničkih računa, a podaci o korisničkim računima pohranjeni su unutar jedne datoteke na datotečnom sustavu. Prikazat ćemo kako se sustav baziran na YOURLS može iskoristiti unutar intraneta.

Instalacija

Bitno je napomenuti da YOURLS zahtjeva vlastitu .htaccess datoteku. Ovo treba imati na umu prilikom odabira mape u koju će se YOURLS instalirati, budući da postoji mogućnost konflikta s postojećim pravilima koja su definirana u nekoj drugoj .htaccess datoteci. Nakon što se odrade potrebna podešavanja na razini poslužitelja (stvaranje direktorija, eventualno podešavanje poddomene i sl.) potrebno je otpakirati instalacijsku arhivu u željenu mapu.

Konfiguracija

Na osnovu datoteke includes/config-sample.php koja dolazi uz instalaciju moguće je izraditi vlastitu konfiguracijsku datoteku config.php. Datoteku config.php moguće je smjestiti ili u direktorij includes ili user. Smještanje konfiguracijske datoteke u mapu user olakšava nadogradnju na novije verzije (YOURLS Install).

Konfiguracijska datoteka sastoji se od četiri cjeline:

1. Postavke za bazu podataka

YOURLS za pohranu koristi MySQL bazu podataka. Potrebno je dati podatke nužne za spajanje na bazu: korisničko ime, lozinka, ime baze, ime poslužitelja i prefiks za tablice unutar baze.

2. Postavke za site

Ovdje je potrebno podesiti parametre koji se odnose na kompletnu instalaciju:

• YOURLS_SITE — URL siteа, bez znaka / na kraju
• YOURLS_HOURS_OFFSET — vremenska zona u odnosu na Greenwich Mean Time (GMT)
• YOURLS_PRIVATE — ako je true, pristup aplikaciji bit će moguć samo uz korisničko ime i lozinku (privatna instalacija); ako je false, aplikacija će biti dostupna svima (javna instalacija)
• YOURLS_UNIQUE_URLS — ako je true, svaki URL moguće je skratiti samo jednom; ako je false, svaki URL moguće je skratiti više puta. Postavljanje na false može spriječiti nepotrebno generiranje skraćenih URL-ova, ali može i ograničiti funkcionalnost (npr. praćenje više različitih statistika za isti URL)
• YOURLS_COOKIEKEY — hash vrijednost koja se koristi za enkripciju kolačića (cookie). Moguće je upisati proizvoljnu hash vrijednost — poželjno što dulju. Ukoliko nemate ideju, možete se poslužiti online generatorom na adresi http://yourls.org/cookie
• yourls_user_passwords — polje unutar kojeg se definiraju parovi korisničkih imena i lozinki. Problem je što su lozinke pohranjene u obliku čistog teksta, što sa sigurnosnog gledišta nije poželjno

3. Postavke za skraćivanje URL-ova

• YOURLS_URL_CONVERT — moguće su dvije vrijednosti: 36 ili 62, što označava Base 36 ili Base 62 način kodiranja URL-ova (YOURLS FAQ). Nakon što je jednom definirana, ova se vrijednost ne smije mijenjati — promjena bi učinila sve dotad generirane kratke URL-ove nevaljalima
• yourls_reserved_URL — unutar ove varijable moguće je definirati popis riječi koje se neće moći pojaviti unutar skraćenog URL-a

4. Dodatne postavke

• YOURLS_PRIVATE_INFOS — ako je true, statistika za pojedini URL bit će javno dostupna
• YOURLS_PRIVATE_API — ako je true, API će biti javno dostupan
• YOURLS_NOSTATS — postavljanjem na true onemogućuje se bilježenje podataka o preusmjeravanjima

Administratorsko sučelje

Ako smo podesili instalaciju da bude privatna, sučelju za administraciju pristupamo dodavanjem /admin u URL, npr. http://s.srce.hr/admin.

Unutar administratorskog sučelja URL je moguće skratiti na dva načina: automatskim generiranjem skraćenog URL-a ili stvaranjem proizvoljnog skraćenog URL-a s nekom željenom ključnom riječi. Za već skraćene URL-ove moguće je:

• pregledati statistiku
• dijeliti skraćeni URL na društvenim mrežama
• uređivati skraćeni URL
• brisati skraćeni URL

Kod prikaza statistike moguće je vidjeti broj klikova u određenom vremenskom periodu, geografsku lokaciju od kuda dolaze posjetitelji i sl.

Proširenja (plugins)

Ukoliko vam navedene mogućnosti nisu dovoljne već želite proširiti mogućnosti YOURLS-a, pogledajte postojeće dodatke za proširenja (plugins) navedene u sklopu dokumentacije.

API

Za scenarij javne dostupnosti usluge moguće je posegnuti za API-jem koji dolazi uz YOURLS. Uz samu instalaciju dolaze i tri datoteke koje mogu poslužiti kao predlošci za izradu vlastite usluge:

• sample-public-api.php.txt
• sample-public-front-page.php.txt
• sample-remote-api-call.php.txt

Postoje dva moguća scenarija — jedan vezan uz tzv. javnu instalaciju, a drugi uz tzv. privatnu instalaciju.