LibreOffice Writer fájlformátum problémák és megoldásuk

Szabad Szoftver Konferencia (http://konf.fsf.hu/cgis/ossc/2013/speakers#spea24), Budapest
Article: https://github.com/vmiklos/presentations/tree/master/libreoffice-fsfhu-bp-2k13

Transcript

1. LibreOffice Writer fájlformátum problémák és megoldásuk Nem halat adunk, halászni tanítunk. Vajna Miklós 2013 június 8
2. 2 Egy jó és egy rossz hír • Jó hír: a fájlformátum problémák könnyen tesztelhetők automatikusan a legtöbb esetben ‒ Összehasonlítva a megjelenítéssel vagy felhasználói felülettel ‒ Tehát nem egy végtelen küzdelem – egy adott problémát tekintve • Rossz hír: a legtöbb esetben a forráskód módosítása szükséges ‒ A bemeneti fájl tartalmának módosítása ritkán segít
3. 3 Mi az a fájlformátum probléma? • Az a helyzet, amikor a problémát egy import vagy export szűrő okozza • Jó példák: ‒ Egy vonal vastagsága túl nagy, ha egy csoportos alakzat részét képezi, DOCX megnyitása esetén ‒ Ez a dokumentum egy oldalas kéne legyen, nem kettő • Rossz példák: ‒ A betöltött dokumentum megjelenítése fagyást (hang) okoz ‒ A Writer nem támogat egy adott funkciót, amit a fájlformátum viszont támogatna
4. 4 Még több terminológia • Valójában mindig importálunk vagy exportálunk • “Megnyitás” a felhasználói felületen: import egy üres dokumentumba, majd visszavonás-lista ürítése • “Kivágás és másolás” a felhasználói felületen: részleges export, majd import egy létező dokumentumba • “Mentés” a felhasználói felületen: export egy létező fájl útvonalra • Ez a magyarázata annak, hogy: ‒ Egyetlen karakter leütése + mentés teljesen átírja a fájlt ‒ Miért nem lehet csak a „konverziós gépezetet” kiemelni a kódból (de: van headless mód)
5. 5 Hogyan vizsgálhatjuk meg a dokumentum modelljét? • Építőkocka: paragrafusok • XML dump: ‒ SW_DEBUG=1 ./soffice.bin --writer ‒ Shift-F12 hatására egy nodes.xml készül • GDB: ‒ print pDoc->GetNodes() • UNO: ‒ Iteráció a ThisCompoment objektumon → paragrafusok ‒ Iteráció egy paragrafuson → futások (runs)
6. Writer fájlformátumok: ODF, Word formátumok és a többiek
7. 7 ODF szűrő • Az egyetlen „saját” szűrő, mind az import/export veszteségmentes • Az ODF szemantikája nagyon közel áll a Writer modelljéhez: ‒ Példa paragrafustokra: UNO tulajdonságok ↔ XML attribútumok • Az implementáció nagy része az UNO API-t használja ‒ Jó példaként szolgál más szűrők fejlesztésekor • Forráskód: xmloff/ és sw/source/filter/xml/ alatt • ODF ellenőrző: ‒ http://odf-validator2.rhcloud.com/odf-validator2/
8. 8 RTF szűrő • A formátumról ‒ Motiváció: egyszerűen olvasható, mint a HTML, de támogat minden szövegszerkesztő funkciót (oldalméret, hasábok, stb.) ‒ A gyakorlatban sokszor nehezen olvasható • Export ‒ LibreOffice 3.3-ban jelent meg a jelenlegi implementáció ‒ Belső szűrő, kód megosztás a DOC/DOCX szűrőkkel • Import ‒ LibreOffice 3.5-ban jelent meg a mostani megvalósítás ‒ UNO szűrő, a domain mapper közös a DOCX importerrel • Nagyrészt én követtem el
9. 9 DOC szűrő • Valószínűleg a legrégebbi Writer szűrő ‒ Ha nem számoljuk a binfiltert • Mind az import és az export belső szűrő • A specifikációja [MS-DOC] néven elérhető • A tokenizáló és a domain mapper nincs elkülönítve • Az mso-dumper DOC támogatása segíthet: ‒ http://cgit.freedesktop.org/libreoffice/contrib/mso-dumper/ • Az import/export kód részben megosztott
10. 10 DOCX szűrő • Két variáció: ECMA és Microsoft ‒ Példa: left/right vagy start/end a paragrafusok margóinak leírására • Az import régebbi ‒ Túlbonyolított, a writerfilter/ alatt ‒ A tokenizer kódját egy XSLT generálja, nehéz benne hibát keresni ‒ OpenOffice.org-ból örökölt, UNO alapú ‒ A domain mapper közös az RTF szűrővel • Az export csak a LibreOffice része ‒ Belső ‒ Kód megosztás a DOC/RTF szűrőkkel
11. Tesztek: belső, modell és megjelenítési tesztek
12. 12 Unit tesztek • Csak azzal foglalkozunk, hogy a szűrő megbirkózik- e a fájllal ‒ CVE tesztek ‒ Ha a szűrő a megfelelő visszatérési értéket adja, készen vagyunk • Belső tesztek ‒ Hozzáférés a privát Writer szimbólumokhoz ‒ Praktikus itt tesztelni azokat a metódusokat amiket a UI használ ‒ A szűrőket tipikusan nem itt teszteljük
13. 13 Modell tesztek • Ezt használjuk legtöbbször • Import ‒ Töltsük be a fájlt, majd értékeljünk ki kifejezéseket az UNO modellen • Export ‒ Import → export → import ‒ Így azonos API használható mindkét esetben, és az importot is teszteljük ‒ Alternatíva: kódból felépíteni a dokumentumot, majd valahogy megvizsgálni az eredményt (XPath az XML-alapú formátumokhoz, de mit kezdjünk a többivel?) ‒ Hátrány: az import is jó kell legyen ‒ Egyébként sem baj
14. 14 Megjelenítési tesztek • A megjelenítés tesztelése: ‒ Nem: az alapértelmezett oldalstílus fejlécének tartalma ‒ Hanem: a harmadik oldalon lévő fejléc szövege • Néha hasznos, de óvatosnak kell lenni ‒ A Writer megjelenítése részben a háttérben fut, a tesztek erre nem várnak ‒ A megjelenítés különbsége nem biztos, hogy baj ‒ Például hiányzó betűtípus
15. Köszönöm a figyelmet! 15 Diák: http://vmiklos.hu/odp/ All text and image content in this document, unless otherwise specified, is licensed under the Creative Commons Attribution-Share Alike 3.0 License . This does not include the LibreOffice name, logo, or icon. All SUSE marks referenced in this presentation are trademarks or registered trademarks of Novell, Inc. in the United States.