RSS-voo validaator

RSS-voo valideerimine ja selle tähtsus

Veebisaitide operaatorid, sisukirjutajad, arendajad ja meeskonnad, kes tegelevad voogude migreerimisega, vajavad töökindlat viisi XML-põhiste andmevoogude kontrollimiseks. RSS-voo validaator on loodud selleks, et analüüsida kleebitud RSS 2.0 või Atom 1.0 XML-sisu otse veebibrauseris. Tööriist tuvastab voo vormingu, parsib selle kirjed ning tuvastab struktuurilised vead, puuduvad kohustuslikud väljad ja vigased lingiviited.

Valideerimine aitab vältida olukordi, kus vigane märgistus või puuduvad andmed takistavad voolugejatel ja agregaatoritel sisu korrektselt kuvamast. Kuna kontroll viiakse läbi lokaalselt, on tagatud andmete privaatsus: sinu voogu kontrollitakse sinu brauseris. BroBroGo ei laadi midagi üles ega salvesta.

RSS 2.0 voogude struktuur ja nõuded

RSS 2.0 standard seab kindlad reeglid voo ülesehitusele. Iga kehtiv RSS-dokument peab sisaldama juurelementi, mille sees on täpselt üks otsene kanal. Kui see tingimus ei ole täidetud, kuvatakse veateade: "RSS peab sisaldama täpselt üht otsest elementi <channel>; leiti ‹count›."

Kanal sisaldab metaandmeid ja üksikuid sisuüksusi ehk item-elemente. Validaator kontrollib iga RSS-i item-elemendi puhul järgmisi reegleid ja välju:

• Pealkiri või kirjeldus: Kontrollitakse reeglit title-or-description. RSS-i kirjel peab olema vähemalt pealkiri või kirjeldus, et see oleks valideeritav.
• Identifikaatorid ja lingid: Parser loeb ja kontrollib elemente GUID ja link.
• Avaldamiskuupäev: Tööriist tuvastab ja analüüsib välja publication date. Kuupäev peab vastama standardsele vormingule, vastasel juhul kuvatakse hoiatus või viga: "Kasuta tegelikku kuupäeva selle voo nõutud vormingus."

Atom 1.0 voogude struktuur ja nõuded

Atom 1.0 on kaasaegsem ja rangemalt struktureeritud voovorming. Erinevalt RSS-ist on Atom-vormingus spetsiifilised nõuded autorlusele, unikaalsetele identifikaatoritele ja alternatiivsetele linkidele.

Validaator kontrollib Atom-i kirjete (entry) puhul järgmisi aspekte:

• ID olemasolu ja unikaalsus: Igal kirjel peab olema unikaalne ID. Kui ID kordub, kuvatakse teade: "See ID kordab väärtust, mida nähti esimest korda real ‹first›." Atom-i ID-d peavad olema absoluutsed IRI-d. Suhteliste viidete korral kuvatakse viga: "Kasuta välja ‹field› jaoks absoluutset IRI-t; suhtelised identifikaatorid ei ole kehtivad Atom ID-d."
• Pealkiri ja muutmisaeg: Kontrollitakse välju title ja updated.
• Autorluse pärimine: Atom nõuab autoriteabe olemasolu. Kui see puudub, rakendub reegel "Lisa voole <author> või igale kirjele otsene <author>." või "Lisa <author> sellele kirjele, selle elemendile <source> või voole."
• Alternatiivsed lingid ja sisu: Kui Atom-i kirjel puudub sisene content-element, nõuab standard alternatiivse lingi olemasolu. Selle puudumisel kuvatakse viga: "Lisa alternatiivne <link>, kui Atom-i kirjel pole sisest <content>-elementi."
• Sisuallika konfliktid: Kui element content kasutab atribuuti src, ei tohi selle sees olla teksti ega alamelemente. Vastasel juhul kuvatakse tõrge: "Kui <content> kasutab src-d, eemalda selle sisene tekst ja alamelemendid." Samuti, kui sisu on väline või seda ei saa tekstina lugeda, nõutakse kokkuvõtet: "Lisa <summary>, kui Atom-i sisu on väline või seda ei saa tekstina lugeda."

Suhtelised lingid ja xml:base roll

Veebivoogudes on soovitatav kasutada absoluutseid aadresse. Atom 1.0 standard lubab siiski kasutada suhtelisi viiteid, kui voos on määratletud atribuut xml:base.

Validaator parsib lingiväljad ja lahendab suhtelised viited, kasutades määratud xml:base väärtust. Kui suhtelist linki ei suudeta lahendada puuduva või vigase baasaadressi tõttu, kuvatakse veateade: "Kasuta välja ‹field› jaoks absoluutset aadressi; suhtelised võivad olla ainult toimiva xml:base väärtusega Atom-viited." Kõik muud lingid, mida ei suudeta korrektselt parsida, tähistatakse veaga: "Paranda ‹field›; seda linki ei saa parsida URL- või URI-viitena."

Struktuurse ja sisulise valideerimise erinevused

Kasutajatel on oluline mõista selle tööriista ulatust ja piiranguid. Validaator teostab rangelt struktuurset ja vormingupõhist kontrolli.

Tööriista piirangud ja veatuvastus

Validaator suudab korraga töödelda kuni 500 000 märgi suurust XML-sisendit. Kui sisestatud andmed ületavad seda piiri, kuvatakse teade: "See tööriist võtab ühe kontrolli kohta vastu kuni ‹max› märki."

Muud võimalikud vead ja piirangud analüüsil:

• Ajalõpp: Kui andmete töötlemine võtab liiga kaua aega, kuvatakse teade: "Valideerimine võttis liiga kaua aega. Proovi väiksemat voogu."
• Töötlemise tõrge: Kui analüüsi ei suudeta lõpule viia, kuvatakse teade: "Valideerimist ei saanud lõpetada."
• DOCTYPE deklaratsioonid: Turvalisuse ja ühilduvuse huvides tuleb XML-ist eemaldada DOCTYPE deklaratsioonid. Vastasel juhul kuvatakse viga: "Eemalda enne voo kontrollimist deklaratsioon DOCTYPE."
• Vigane XML: Kui XML-struktuur on katki, kuvatakse teade: "Paranda vigane XML ja valideeri uuesti."
• Kuvamise piirangud: Suurte voogude puhul kuvatakse aruandes maksimaalselt 200 probleemi ja 100 kirjet. Kui limiit ületatakse, teavitatakse kasutajat märkega: "Kuvatakse esimesed ‹shown› probleemi kokku ‹total›-st." või "Kuvatakse esimesed ‹shown› kirjet kokku ‹total›-st."

Korduma kippuvad küsimused

Milliseid voovorminguid see validaator toetab?

See valideerib praeguseid RSS 2.0 ja Atom 1.0 dokumente. Vanemad RSS-, RDF/RSS 1.0 ja Atom 0.3 vood tuvastatakse, kuid neid ei kontrollita valede reeglite järgi.

Kas see avab või testib voo linke?

See parsib linke sisaldavad väljad ja lahendab Atom-i suhtelised viited xml:base abil. URL-e ei avata kunagi, seega ei testita kättesaadavust, ümbersuunamisi, sertifikaate ega sihtkoha sisu.

Milliseid kirjete välju kontrollitakse?

RSS item-i puhul kontrollitakse pealkirja või kirjelduse olemasolu ning loetakse GUID, link ja avaldamiskuupäev. Atom entry puhul kontrollitakse ID-d, pealkirja, updated-välja, author-i pärimist, alternatiivseid linke ning content- või summary-reegleid.

Mida tähendab viga "Kasuta välja ‹field› jaoks absoluutset IRI-t"?

See viga ilmneb Atom 1.0 voogudes, kui kirje unikaalne identifikaator (ID) on esitatud suhtelise teena. Atom-i standard nõuab, et ID-d oleksid alati absoluutsed unikaalsed ressursiidentifikaatorid (IRI), mis ei muutu ajas ega sõltu voo asukohast.