Fakulta elektrotechnická. protokoly. Yun Ruan. Studijní program: Elektrotechnika a informatika, strukturovaný, Bakalářský. Obor: Výpočetní technika

ˇ e vysoké uˇcen´ı technické v Praze Cesk´ Fakulta elektrotechnická Katedra poˇc´ıtaˇc˚ u

Bakaláˇrská práce

Rozˇ s´ıˇ ren´ı ExtBrain Communicatoru o dalˇ s´ı komunikaˇ cn´ı protokoly Yun Ruan

Vedouc´ı práce: Ing. Tomáˇs Novotn´ y

Studijn´ı program: Elektrotechnika a informatika, strukturovan´ y, Bakaláˇrsk´ y Obor: V´ ypoˇcetn´ı technika 28. kvˇetna 2010

iv

v

Podˇ ekov´ an´ı Chtˇel bych t´ımto podˇekovat vedouc´ımu své bakaláˇrské práce Ing. Tomáˇsi Novotnému za cenné pˇripom´ınky a rady pˇri vypracováván´ı práce, své rodinˇe za podporu, Luboru Petrovi za pˇreklad a korekturu a samozˇrejmˇe také Florian Quèze, hlavn´ımu v´ yvojáˇri Instantbirdu.

vi

vii

Prohl´ aˇ sen´ı Prohlaˇsuji, ˇze jsem pr´ aci vypracoval samostatnˇe a pouˇzil jsem pouze podklady uvedené v pˇriloˇzeném seznamu. Nem´ am z´ avaˇzn´ y d˚ uvod proti uˇzit´ı tohoto ˇskoln´ıho d´ıla ve smyslu §60 Zákona ˇc. 121/2000 Sb., o pr´ avu autorském, o pr´ avech souvisej´ıc´ıch s právem autorsk´ ym a o zmˇenˇe nˇekter´ ych zákon˚ u (autorsk´ y z´ akon).

V Praze dne 28. 5. 2010

.............................................................

viii

Abstract The aim of this project is to bring protocol libpurple from Instantbird to mail client Mozilla Thunderbird 3 and demostrate the functionality that Instantbird offers.

Abstrakt C´ılem projektu je pˇrenést protokol libpurple od Instantbirdu do poˇstovn´ıho klienta Mozilla Thunderbird 3 a demonstrovat tak funkcionality, které Instantbird nab´ız´ı.

ix

x

Obsah ´ 1 Uvod 1.1 Mozilla application framework . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2 Mozilla Thunderbird . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.3 Instantbird . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1 2 3 3

2 Specifikace c´ıle, pouˇ zit´ e n´ astroje 2.1 C´ıl projektu . . . . . . . . . . . . . . . . . . 2.1.1 Porovn´ an´ı existuj´ıc´ıch implementac´ı 2.2 Pouˇzité n´ astroje . . . . . . . . . . . . . . . 2.2.1 DOM Inspector . . . . . . . . . . . . 2.2.2 SQLite Manager . . . . . . . . . . . 2.2.3 Venkman . . . . . . . . . . . . . . . 2.2.4 XPCOM Viewer . . . . . . . . . . . 2.2.5 XUL explorer . . . . . . . . . . . . . 2.2.6 Extension Developer’s Extension . . 2.2.6.1 Javascript Shell . . . . . . 2.2.6.2 XUL editor . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

5 5 5 5 5 6 6 7 7 8 8 8

3 Skriptov´ an´ı v Mozille 3.1 Popis u ´rovn´ı skriptov´ an´ı v Mozille . . . . . . . . . . . . 3.1.1 Interface JS vrstva . . . . . . . . . . . . . . . . . 3.1.2 XPConnect . . . . . . . . . . . . . . . . . . . . . 3.1.3 XPCOM . . . . . . . . . . . . . . . . . . . . . . . 3.2 JavaScript a DOM . . . . . . . . . . . . . . . . . . . . . 3.2.1 Co je DOM? . . . . . . . . . . . . . . . . . . . . 3.2.2 DOM standardy . . . . . . . . . . . . . . . . . . 3.2.3 Metody DOM . . . . . . . . . . . . . . . . . . . . 3.2.3.1 V´ ystup na STDOUT pomoc´ı DUMP() 3.2.3.2 getElementById . . . . . . . . . . . . . 3.2.3.3 getAttribute . . . . . . . . . . . . . . . 3.2.3.4 setAttribute . . . . . . . . . . . . . . . 3.3 XPConnect a skriptovatelné komponenty . . . . . . . . . 3.3.1 Co je to XPConnect? . . . . . . . . . . . . . . . 3.3.1.1 Vytvaˇren´ı XPCOM objekt˚ u ve skriptu . 3.3.1.2 Vyhledáván´ı komponenty a rozhran´ı . .

. . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . .

9 9 9 10 10 10 10 11 11 11 12 12 12 13 13 13 14

xi

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

xii

OBSAH

3.3.1.3

V´ ybˇer rozhran´ı z komponent . . . . . . . . . . . . . . . . . .

´ 4 Uvod do XPCOM ˇ sen´ı pomoc´ı XPCOM . . . . . . . 4.1 Reˇ 4.2 Komponenty XPCOM . . . . . . . . 4.3 Interface a IDL . . . . . . . . . . . . 4.3.1 Interface versus Komponenty 4.3.2 Root interface . . . . . . . . . 4.3.3 Kompil´ ator XPIDL . . . . . . 4.4 Typové knihovny . . . . . . . . . . . 4.4.1 Vytvaˇren´ı typové knihovny . 4.5 Identifik´ atory . . . . . . . . . . . . . 4.5.1 Identifik´ ator tˇr´ıd . . . . . . . 4.5.2 CID . . . . . . . . . . . . . . 4.5.3 Contract ID . . . . . . . . . . 4.5.4 Generov´ an´ı identifik´ ator˚ u . . 4.6 Typy . . . . . . . . . . . . . . . . . . 4.6.1 Typy metod 4.3 . . . . . . . . 4.6.2 Poˇc´ıt´ an´ı referenc´ı 4.4 . . . . . 4.6.3 Stavové k´ ody 4.5 . . . . . . . 4.6.4 Variabiln´ı mapov´ an´ı 4.6 . . . 4.6.5 Spoleˇcn´ a error k´ od˚ u 4.7 . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . .

15 17 18 18 18 19 20 20 20 21 21 21 21 22 22 22 22 22 23 23 23

5 Realizace 25 5.1 Celkov´ y pˇrehled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 5.2 V´ yvojové prostˇred´ı . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 5.3 Problémy pˇri implementaci . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 6 Testov´ an´ı 29 6.1 Realné nasazen´ı . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 6.2 Srovn´ av´ an´ı s existuj´ıc´ımi ˇreˇsen´ımi . . . . . . . . . . . . . . . . . . . . . . . . 31 7 Z´ avˇ er 33 7.1 Zhodnocen´ı . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Literatura

35

A Instalaˇ cn´ı a uˇ zivatelsk´ a pˇ r´ıruˇ cka 37 A.1 Instalace Mozilla Thunderbird a Instantbird . . . . . . . . . . . . . . . . . . . 37 A.1.1 Postup instalace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 A.2 Instalace projektu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 B Obsah pˇ riloˇ zen´ eho CD

41

Seznam obr´ azk˚ u 1.1

XPFE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2

2.1 2.2 2.3 2.4 2.5 2.6 2.7

DOM inspector . SQLite manager Venkman . . . . XPCOM viewer . XUL explorer . . Javascript Shell . XUL editor . . .

. . . . . . .

6 6 7 7 8 8 8

3.1 3.2

´ Urovnˇ e skriptov´ an´ı v Mozille . . . . . . . . . . . . . . . . . . . . . . . . . . . XPConnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

10 14

4.1

ˇ ast Mozilla application framework[8] . . . . . . . . . . . . . . . . . . . . . . C´

17

6.1 6.2 6.3 6.4

Program po spouˇstˇen´ı . . . . . Pˇrihl´ aˇsov´ an´ı . . . . . . . . . . . Porovn´ an´ı po proveden´ı pˇr´ıkazu Chatov´ an´ı . . . . . . . . . . . .

29 30 30 31

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

xiii

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . . . . .

. . . .

. . . .

xiv

´ U ˚ SEZNAM OBRAZK

Seznam tabulek 4.1 4.2 4.3 4.4 4.5 4.6 4.7

V´ yhody pouˇzit´ı komponent Interface nsISupports . . . . Typy metod . . . . . . . . . Poˇc´ıt´ an´ı referenc´ı . . . . . . Stavové k´ ody . . . . . . . . Variabiln´ı mapov´ an´ı . . . . Spoleˇcn´ a error k´ od˚ u . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

xv

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

. . . . . . .

18 19 23 23 23 24 24

xvi

SEZNAM TABULEK

Kapitola 1

´ Uvod V dneˇsn´ım dobˇe vˇetˇsina lid´ı vlastn´ı nˇekolik emailov´ ych u ´ˇct˚ u od r˚ uzn´ ych poskytovatel˚ u. Kv˚ uli tomu se mus´ı dennodennˇe v´ıcekrát pˇrihlaˇsovat k serveru svého poskytovatele a mus´ı pouˇz´ıvat webové emailové rozhran´ı. Pokud ˇcteme emaily jednou za ˇcas, jistˇe to nevad´ı, avˇsak pokud ˇcteme nˇekolik des´ıtek email˚ u dennˇe, brzy zjist´ıte, ˇze to nen´ı zrovna nejlepˇs´ı ˇreˇsen´ı. Proto jsou zde poˇstovn´ı tlust´ı klienti, kteˇr´ı nám slouˇz´ı k pˇr´ıj´ımán´ı a odes´ılán´ı elektronické poˇsty. Jeden z nich je Mozilla Thunderbird. Vˇetˇsina z n´ as také vlastn´ı alespoˇ n jeden IM u ´ˇcet, pˇres kter´ y komunikujeme se sv´ ymi pˇr´ ateli, kteˇr´ı jsou pr´ avˇe pˇripojeni. Lze jim pos´ılat zprávy, pˇrepos´ılaj´ı soubory atd. Nicménˇe zat´ım ˇz´ adn´ y klient nenab´ız´ı sluˇzby jako je propojen´ı emailu a IM sluˇzeb. Pokud chceme komunikovat pomoc´ı IM sluˇzeb, mus´ıme si vˇetˇsinou nainstalovat speciáln´ıho klienta. Nab´ız´ı se ot´ azka: Proˇc bychom nemohli slouˇcit sluˇzby jednotliv´ ych klient˚ u do do jednoho programu? Pˇrineslo by n´ am to komfort v tom, ˇze pˇri ˇcten´ı email˚ u bychom mohli b´ yt z´ aroveˇ n v kontaktu s pˇr´ ateli a nemus´ıme pˇrep´ınat mezi tˇemito programy.

1

´ KAPITOLA 1. UVOD

2

1.1

Mozilla application framework

Mozilla application framework[7] je multiplatformn´ı sada softwarov´ ych komponent pro v´ yvoj Mozilla aplikac´ı. P˚ uvodn´ı n´ azev XPFE(viz 1.1), zkratka pro Cross Platform Front End, téˇz znám´ y pod n´ azvem XPToolkit.

Obrázek 1.1: XPFE Komponenty Mozilla application framework jsou: • Gecko - renderovac´ı j´ adro, navrˇzeno pro v´ ykon a pˇrenositelnost. • XML-based User-interface Language (XUL) - základ uˇzivatelského rozhran´ı. Základem je jazyk XML1 , pomoc´ı nˇehoˇz mapujeme r˚ uzné prvky uˇzivatelského rozhran´ı jako je widget, ovl´ adac´ı prvky, ˇsablony a dalˇs´ı. Syntaxe je velice podobná HTML2 . • Necko - poskytuje rozˇsiˇritelné, platformˇe nezávislé API3 pro komunikaci na s´ıti. • eXtensible Binding Language (XBL) - dovoluje definovat vlastn´ı widget pro pouˇzit´ı v XUL. • Cross Platform Component Object Model (XPCOM) - multiplatformn´ı komponentov´ y model. Je podobn´ y Microsoft COM4 , podrobnˇe bude popsán v následuj´ıc´ıch kapitol´ ach. • XPConnect - spojuje JavaScript s XPCOM, umoˇzn ˇuje pouˇz´ıt XPCOM komponenty z javascriptového k´ odu a interakci objekt˚ u zevnitˇr komponent XPCOM. • a dalˇs´ı ... Mozilla klade velk´ y d˚ uraz na multiplatformnost. V´ ysledkem je, ˇze funguje na skoro vˇsech operaˇcn´ıch systémech: Windows, Linux, MacOS, FreeBSD, a dalˇs´ı. Jej´ı hlavn´ı v´ yvojov´ y jazyk je C++ ale i tak je vˇetˇs´ı ˇc´ ast naps´ ana v JavaScriptu. 1

XML (Extensible Markup Language - obecn´ y znaˇckovac´ı jazyk, kter´ y byl vyvinut a standardizov´ an konsorciem W3C(World Wide Web Consortium). 2 HTML (HyperText Markup Language) - dalˇs´ı znaˇckovac´ı jazyk pouˇz´ıvan´ y pˇredevˇs´ım v internetov´ ych aplikac´ıch 3 API (Application Programming Interface) - rozhran´ı pro programov´ an´ı aplikac´ı. 4 COM (Component Object Model) - technologie programov´ ych komponent od firmy Microsoft.

1.2. MOZILLA THUNDERBIRD

1.2

3

Mozilla Thunderbird

Mozilla Thunderbird[12] je svobodn´ y, open source, multiplatformn´ı poˇstovn´ı klient, distribuovan´ y pod licenc´ı MPL/GPL/LGPL5 . P˚ uvodnˇe byl vyv´ıjen spoleˇcnost´ı Mozilla, nyn´ı jeho v´ yvoj pˇrevzala dceˇrin´ a spoleˇcnost Mozilla Messaging. Program je k dispozici hned v nˇekolika jazyc´ıch s jednoduch´ ym ovládán´ım i nastaven´ım. Nav´ıc m˚ uˇzeme doinstalovat r˚ uzné rozˇs´ıˇren´ı dle potˇreby, které jsou dostupné na ofici´ aln´ıch stránk´ ach[11]. Thunderbird nab´ız´ı tyto standardn´ı funkcionality: • Message management - správa v´ıce e-mail, news feed atd. • Junk filtering - obsahuje bayesovsk´ y antispamov´ y filtr. • Extensions - umoˇzn ˇuje pˇridáván´ı funkc´ı pomoc´ı instalace modul˚ u XPInstall. • Themes - podporuje skinovatelnost uˇzivatelského rozhran´ı. • Standards support - standardnˇe podporuje komunikaˇcn´ı protokoly POP6 a IMAP7

1.3

Instantbird

Instantbird[5] je IM8 klient vyuˇz´ıvaj´ıc´ı knihovnu libpurple9 , podporuj´ıc´ı velik´ y poˇcet komunikaˇcn´ıch protokol˚ u jako ICQ, AIM, Jabber a dalˇs´ı. Je to svobodn´ y a open source software a ˇs´ıˇren´ y pod licenc´ı MPL/GPL/LGPL jako Mozilla Thunderbird.

5

MPL (Mozilla Public License), GPL (GNU General Public License), LGPL (GNU Lesser General Public License) - jsou to licence pro svobodn´ y software. 6 POP (Post Office Protocol) - internetov´ y protokol, kter´ y se pouˇz´ıv´ a pro stahov´ an´ı emailov´ ych zpr´ av ze vzd´ aleného serveru na klienta. 7 IMAP (Internet Message Access Protocol) - internetov´ y protokol pro vzd´ alen´ y pˇr´ıstup k e-mailové schr´ ance. 8 IM (Instant messaging) - internetov´ a komunikace v re´ alném ˇcase. 9 libpurple - Knihovna, kter´ a je pouˇzivan´ a jako j´ adro IM program˚ u, napˇr. Pidgin, Adium, Instantbird.

4

´ KAPITOLA 1. UVOD

Kapitola 2

Specifikace c´ıle, pouˇ zit´ e n´ astroje 2.1

C´ıl projektu

C´ılem tohoto projektu je rozˇs´ıˇrit projekt ExtBrain communicator o dalˇs´ı komunikaˇcn´ı protokoly, které podporuje knihovna libpurple. Nejznámˇejˇs´ı z nich jsou napˇr´ıklad: MSN, Jabber a ICQ. Bˇehem zkoum´ an´ı fungov´ an´ı intern´ıch modul˚ u Instantbirdu, jsem zjistil, ˇze pro m˚ uj projekt je v´ yhodné pouˇz´ıt framework xpcompurple. Ten v sobˇe zapouzdˇruje knihovnu libpurple pomoc´ı frameworku XPCOM. Xpcompurple vychaz´ı z Pidgin libpurple a je pˇripraven k pouˇzit´ı v Mozilla aplikac´ı.

2.1.1

Porovn´ an´ı existuj´ıc´ıch implementac´ı

Existuj´ıc´ı ˇreˇsen´ı jsem prozat´ım na stránkách Thunderbird add-ons[11] nenaˇsel. Nem˚ uˇzu tedy porovnat moj´ı verzi aplikace s existuj´ıc´ımi ˇreˇsen´ımi.

2.2 2.2.1

Pouˇ zit´ e n´ astroje DOM Inspector

DOM inspector[1] je n´ astroj, kter´ y m˚ uˇze b´ yt pouˇzit ke kontrole a u ´pravˇe DOM1 v XUL nebo v jin´ ych webov´ ych dokumentech. V DOM inspektoru je moˇzné zobrazit stromovou strukturu jednotliv´ ych XML element˚ u. Oznaˇcen´ım konkrétn´ıho uzlu m˚ uˇzeme zobrazit obsah daného elementu. Zobrazen´ı element˚ u ve stromové struktuˇre je velice praktické pˇri ladˇen´ı sloˇzitˇejˇs´ıch stránek, screenshot programu 2.1. 1

DOM (Document Object Model) - je objektovˇe orientovan´ a reprezentace XML nebo HTML dokumentu.

5

ˇ E ´ NASTROJE ´ KAPITOLA 2. SPECIFIKACE CÍLE, POUZIT

6

Obr´ azek 2.1: DOM inspector

2.2.2

SQLite Manager

SQLite Manager[10] je jednoduch´ y a uˇziteˇcn´ y nástroj pro správu SQLite2 databáz´ı, umoˇzn ˇuj´ıc´ı procházen´ı a editaci datab´ az´ı, spouˇstˇen´ı SQL3 pˇr´ıkaz˚ u a intuitivn´ı zobrazován´ı databázov´ ych objekt˚ u ve stromové hierarchii, screenshot programu 2.2.

Obr´ azek 2.2: SQLite manager

2.2.3

Venkman

Venkman[13], zn´ am´ y téˇz jako JavaScriptov´ y debbuger pro Mozilla aplikace, je uˇziteˇcn´ y nástroj, kter´ y umoˇzn ˇuje krokov´ an´ı, nastavován´ı watches a dalˇs´ı funkce nezbytné pro komfortn´ı ladˇen´ı vlastn´ıho k´ odu v JavaScriptu. Vekman je navrˇzen pro Thunderbird, Firefox a dalˇs´ı Mozilla aplikace, screenshot programu 2.3. 2

SQLite - relaˇcn´ı datab´ azov´ y systém obsaˇzen´ y v relativnˇe malé knihovnˇe napsané v C. SQL (Structured Query Language) - standardizovan´ y dotazovac´ı jazyk pouˇz´ıvan´ y pro pr´ aci s daty v relaˇcn´ıch datab´ az´ıch. 3

ˇ E ´ NASTROJE ´ 2.2. POUZIT

7

Obrázek 2.3: Venkman

2.2.4

XPCOM Viewer

XPCOM viewer[17] je n´ astroj pro zkoumán´ı XPCOM komponent. Nab´ız´ı snadné a rychlé vyhled´ av´ an´ı XPCOM tˇr´ıd, rozhran´ı a aplikaˇcn´ıch log˚ u, které jsou souˇcást´ı dané Mozilla aplikace. Dalˇs´ımi nab´ızen´ ymi funkcemi je napˇr. vyhledávac´ı filtr, procházen´ı vytvoˇren´ ych objekt˚ u s moˇznost´ı zobrazen´ı jejich atribut˚ u, export zobrazen´ ych dat do HTML, XML nebo textu, screenshot programu 2.4.

Obrázek 2.4: XPCOM viewer

2.2.5

XUL explorer

XUL explorer[19] poskytuje snadn´ y zp˚ usob, jak experimentovat s XUL. Je to jednoduch´ y editor, kter´ ym lze zobrazovat XUL jak inline tak v samostatném oknˇe. Pro zrychlen´ı pr´ ace v sobˇe obsahuje panel se seznamem Code snippets4 , které mohou b´ yt rychle vloˇzeny do editoru. Programátor tak nemus´ı psát velmi ˇcasto se opakuj´ıc´ı ˇcásti k´ odu a pouh´ ym poklik´ an´ım vloˇz´ı do rozepsané ˇcásti hotov´ y fragment XUL kódu. XUL explorer v sobˇe obsahuje nástroje jako XUL validator, DOM inspector, Error console, JavaScript debugger, které jsou k dispozici pro ladˇen´ı chyb. Kromˇe toho také nab´ız´ı pˇr´ıstup k XUL informac´ım na Mozilla Developer Center, screenshot programu 2.5. 4

Code snippets - malé fragmenty XUL nebo JavaScript

ˇ E ´ NASTROJE ´ KAPITOLA 2. SPECIFIKACE CÍLE, POUZIT

8

Obr´ azek 2.5: XUL explorer

2.2.6

Extension Developer’s Extension

Extension Developer’s Extension[2] je nástroj, kter´ y usnadˇ nuje v´ yvojáˇri psan´ı rozˇs´ıˇren´ı pro Mozilla Firefox, Thunderbid atd. Nab´ız´ı mnoho funkc´ı, zde pop´ıˇsi jen ty, které jsem pˇri v´ yvoji pouˇzil. 2.2.6.1

Javascript Shell

Javascript Shell 2.6 umoˇzn ˇuje spouˇstˇet JavaScript interaktivnˇe, experimentovat s XPCOM v shellu. M˚ uˇzeme spouˇstˇet JavaScript, jako by byl um´ıstˇen pˇr´ımo v daném dokumentu.

Obr´ azek 2.6: Javascript Shell

2.2.6.2

XUL editor

XUL editor n´ am opˇet umoˇzn ˇuje editovat XUL a zobrazovat v´ ysledn´ y vzhled dokumentu v reálném ˇcase. XUL editor je zjednoduˇsená varianta XUL exploreru, nenab´ız´ı tedy takové mnoˇzstv´ı funkcionalit jako XUL explorer, screenshot programu 2.7.

Obr´ azek 2.7: XUL editor

Kapitola 3

Skriptov´ an´ı v Mozille Pokud programujeme aplikace zaloˇzené na Mozille je tˇreba se seznámit s XPFE[9]. Tento framework poskytuje ˇradu jiˇz implementovan´ ych funkcionalit jako napˇr´ıklad autentizaci, volán´ı XPCOM objekt˚ u, vol´ an´ı obsluhy událost´ı, atd. Usnadˇ nuje tak programátorovi integraci nov´ ych funkcionalit do Mozilly. Pro skriptov´ an´ı pod frameworkem XPFE je pouˇz´ıván JavaScript. Má bohuˇzel nálepku nesofistikovaného programovac´ıho jazyka, kter´ y je pˇredevˇs´ım urˇcen pro nasazen´ı na webov´ ych stránk´ ach. Tento jazyk m´ a vˇsak mnohem ˇsirˇs´ı pouˇzit´ı. Disponuje mnoha vlastnostmi podobn´ ymi vyˇsˇs´ım programovac´ım jazyk˚ um jako je napˇr´ıklad: modularita, odchytáván´ı v´ yjimek a ud´ alost´ı, podpora regul´ arn´ıch v´ yraz˚ u.

3.1

Popis u ´ rovn´ı skriptov´ an´ı v Mozille

´ Urovnˇ e skriptov´ an´ı v Mozille[9] m˚ uˇzeme rozdˇelit do tˇr´ı vrstev. Prvn´ı vrstva (Interface JS) se star´ a o manipulaci s objekty pomoc´ı DOM. Druhá vrstva (XPConnect) obsluhuje vol´ an´ı sluˇzeb poskytovan´ ych XPCOMem a posledn´ı tˇret´ı vrstva (XPCOM) se stará o vytv´ aˇren´ı XPCOM component. Hierarchii jednotliv´ ych vrstev popisuje obrázek 4.1. Nyn´ı detailnˇe pop´ıˇseme jednotlivé u ´rovnˇe skriptován´ı.

3.1.1

Interface JS vrstva

Nejvyˇsˇs´ı u ´rovn´ı skriptov´ an´ı je Interface JS. S jeho pomoc´ı m˚ uˇzeme rozˇsiˇrovat chován´ı jednotliv´ ych ˇc´ ast´ı aplikace, vytv´ aˇret nové widgety, které m˚ uˇzeme navzájem propojovat do jednotného celku. Referenci na atributy jednotliv´ ych komponent z´ıskáváme pomoc´ı vol´ an´ı metod zaloˇzen´ ych na DOM. Pokud napˇr´ıklad chceme pomoc´ı tlaˇc´ıtka editovat vlastnosti textboxu, pˇrid´ ame do obsluhy události tlaˇc´ıtka volán´ı funkce getElementByID() a následnˇe vybranému objektu mohu zmˇenit poˇzadované vlastnosti.

9

´ Í V MOZILLE KAPITOLA 3. SKRIPTOVAN

10

´ Obr´ azek 3.1: Urovnˇ e skriptován´ı v Mozille

3.1.2

XPConnect

XPConnect (kapitola 3.3) leˇz´ı v hierarchii na druhé u ´rovni, spojuje uˇzivatelské rozhran´ı s XPCOMem, to znamen´ a ˇze komponenty zabalené ve frameworku XPCOM jsou zpˇr´ıstupnˇeny pro programov´ an´ı v JavaScriptu. Pokud JavaScript zavol´ a nˇejakou metodu a následnˇe dostane nˇejaká data od komponenty niˇzˇs´ı vrstvy, vol´ an´ı a n´ asledné vr´ acen´ı v´ ysledku je vˇzdy provádˇeno pˇres tuto vrstvu.

3.1.3

XPCOM

Jak jiˇz bylo nˇekolikr´ at zm´ınˇeno, na tˇret´ı vrstvˇe v hierarchii leˇz´ı framework XPCOM. Jsou v nˇem zapouzdˇreny vˇsechny hlavn´ı tˇr´ıdy a funkce slouˇz´ıc´ı pro bezproblémov´ y chod vytváˇrené aplikace. Jin´ ymi slovy m˚ uˇzeme ˇr´ıci, ˇze se jedná o jádro Mozilla aplikac´ı. Podrobnˇe se budu XPCOMu vˇenovat v n´ asleduj´ıc´ıch kapitolách (kapitola 4).

3.2

JavaScript a DOM

Na aplikaˇcn´ı u ´rovni je mal´ y rozd´ıl mezi internetovou stránkou a bˇeˇzn´ ym grafick´ ym uˇzivatelsk´ ym rozhran´ım. HTML DOM a XUL DOM jsou si velice podobné. V obou pˇr´ıpadech jsou zmˇeny stav˚ u a události propagov´ any pˇres vol´ an´ı DOM[6].

3.2.1

Co je DOM?

DOM je API pouˇz´ıvané k pˇr´ıstupu k HTML a XML dokument˚ um. Pro v´ yvojáˇre internetov´ ych aplikac´ı nab´ız´ı dvˇe hlavn´ı funkcionality. Poskytuje strukturovanou reprezentaci

3.2. JAVASCRIPT A DOM

11

daného dokumentu a definuje jak´ ym zp˚ usobem m˚ uˇze b´ yt k této struktuˇre pˇristupov´ ano z JavaScriptu. Tyto funkcionality dovoluj´ı programátorovi manipulovat s uˇzivatelsk´ ym rozhran´ım jako se stromem komponent. Dovoluje vytváˇren´ı nového rozhran´ı ˇci z jiˇz hotového rozhran´ı odeb´ırat nebo pˇrid´ avat dalˇs´ı elementy. DOM vˇsak nen´ı urˇcen jen pro pˇr´ıstup k HTML, XML nebo XUL dokument˚ um ale m˚ uˇzeme ho pouˇz´ıt i pro MathML1 , SVG2 nebo pro jiné XML dokument˚ um podobné formáty. Pokud JavaScriptem vytv´ aˇr´ıme nov´ y HTML element nebo mˇen´ıme atribut nˇejakého XUL objektu, m´ ame k tˇemto novˇe vytvoˇren´ ym prvk˚ um vˇzdy pˇr´ıstup pˇres objektov´ y model DOMu, kter´ y tyto struktury zapouzdˇruje.

3.2.2

DOM standardy

Dodrˇzov´ an´ı specifikace DOM je v Mozilla aplikac´ıch rozdˇeláváno do tˇr´ı u ´rovn´ı podle stupnˇe jej´ıho dodrˇzov´ an´ı. Kaˇzd´ a z u ´rovn´ı poskytuje vlastn´ı mnoˇzinu funkcionalit, nˇekteré z nich vˇsak nejsou dosud Mozillou podporovány.

3.2.3

Metody DOM

Metody v DOMu dovoluj´ı programátorovi manipulovat s prvky, které jsou obsaˇzeny v uˇzivatelském rozhran´ı nebo ve webov´ ych str´ ankách. Umoˇzn ˇuj´ı nastaven´ı atribut˚ u, vytváˇren´ı prvk˚ u, skr´ yv´ an´ı prvk˚ u a dalˇs´ı. DOM zprostˇredkovává veˇskerou interakci mezi skripty a rozhran´ım, napˇr. chceme-li zmˇenit obr´ azek, kdyˇz uˇzivatel stiskne tlaˇc´ıtko, DOM zaregistruje událost, vyvolanou stisknut´ım tlaˇc´ıtka a nastav´ı poˇzadováné atributy. Nyn´ı si uk´ aˇzeme nˇekteré metody v DOMu. 3.2.3.1

V´ ystup na STDOUT pomoc´ı DUMP()

Metoda dump() se pouˇz´ıv´ a pro tisk dat na STDOUT3 . Tato metoda je pouˇz´ıvána hlavnˇe pˇri ladˇen´ı k´ odu. Uk´ azka pouˇ zit´ ı dump(): var assoc = { "val" : "New", "number" : 8 }; alert(dump(assoc));

V´ ystup: ’val’ => "New" ’number’ => "8"

1 MathML (Mathematical Markup Language) - matematick´ y znaˇckovac´ı jazyk, souˇca ´st´ı dokument˚ u konsorcia W3C (World Wide Web Consortium) jako podmnoˇzina jazyka XML pro z´ apis matematick´ ych a pˇr´ıbuzn´ ych vzorc˚ u. 2 SVG (Scalable Vector Graphics) - znaˇckovac´ı jazyk a form´ at souboru, kter´ y popisuje dvojrozmˇernou vektorovou grafiku pomoc´ı XML. 3 STDOUT (Standard output) - ˇcesky: Standardn´ı v´ ystup, je to virtu´ aln´ı zaˇr´ızen´ı, na které program zapisuje v´ ystupn´ı data.


12

3.2.3.2

getElementById

getElementById(aId) je snad nejˇcastˇeji pouˇz´ıvanou DOM metodu. Je to nejpohodlnˇejˇs´ı zp˚ usob, jak z´ıskat referenci na konkrétn´ı prvek s pouˇzit´ım jeho ID jako parametr funkce, kde ID je jedineˇcn´ y identifik´ ator tohoto elementu. Uk´ azka pouˇ zit´ ı getElementById(aID): var boxEl = document.getElementById(’my-id’); dump("boxEl="+boxEl+"\n"); V´ ystup: boxEl=[object XULElement] Hodnota, kterou getElementById vrac´ı, je reference na specifikovan´ y objekt typu XULElement. Jakmile je boxEl k dispozici, je moˇzné pomoc´ı jiné DOM metody jako getAttribute a setAttribute zmˇenit pozici a dalˇs´ı vlastnosti. 3.2.3.3

getAttribute

Atributy jsou vlastnosti, definované pˇr´ımo v elementech. XUL prvky maj´ı napˇr´ıklad atributy: disable, height, style, orient, label a dalˇs´ı. ˇ ezce “my-id”, “hello 1” a “hello V´ yˇse uveden´ y k´ od ukazuje element s r˚ uzn´ ymi parametry. Retˇ 2” jsou hodnoty jednotliv´ ych atribut˚ u. Pokud objekt disponuje nˇejak´ ymi atributy, jejich hodnotu snadno z´ısk´ ame pomoc´ı metody getAttribute. Jej´ım vstupn´ım parametrem je název hledaného atributu. N´ asleduj´ıc´ı pˇr´ıklad ukazuje jej´ı pouˇzit´ı. <script> var boxEl = document.getElementById(’my-id’); var foo = boxEl.getAttribute(’foo’); dump(foo+’\n’); Metoda dump vyp´ıˇse ˇretˇezec “this is the foo attribute”, coˇz je hodnota uloˇzené ve foo. 3.2.3.4

setAttribute

Jako posledn´ı si uk´ aˇzeme metodu setAttribute. Je urˇcena ke zmˇenˇe hodnoty atribut˚ u. Jako napˇr. size, visibility, position, style atd., má dva parametry: název atributu a jeho nová hodnota.

´ KOMPONENTY 3.3. XPCONNECT A SKRIPTOVATELNE

13

<script> boxEl=document.getElementById(’my-id’); boxEl.setAttribute(’foo’, ’this is the foo attribute changed’); var foo = boxEl.getAttribute(’foo’); dump(foo+’\n’); V´ yˇse uveden´ y skript zmˇen´ı hodnotu foo na “this is the foo attribute changed” a vyp´ıˇse pomoc´ı dump(). Metoda setAttribute lze pouˇz´ıt i k vytváˇren´ı nov´ ych atribut˚ u. <script> boxEl=document.getElementById(’my-id’); boxEl.setAttribute(’bar’, ’this is the new attribute bar’); v´ ysledek:

3.3

XPConnect a skriptovateln´ e komponenty

XPConnect[18] propojuje JavaScript a uˇzivatelské rozhran´ı s jádrem aplikac´ı. Zde si uk´ aˇzeme, jak naj´ıt komponenty, které jsou k dispozici programátorovi pˇres XPConnect, vytv´ aˇren´ı JavaScriptov´ y objekt˚ u a jejich pouˇzit´ı v naˇsich aplikac´ıch.

3.3.1

Co je to XPConnect?

Zat´ım jsme si vystaˇcili se psan´ım skript˚ u vyuˇz´ıvaj´ıc´ı DOM pro manipulaci s prvky v uˇzivatelském rozhran´ı. To je vˇsak jen zaˇc´ atek. Skriptován´ı v Mozille nab´ız´ı mnohem v´ıc. Pravdou je, ˇze funkcionality aplikace jsou pro vˇetˇsinu uˇzivatel˚ u d˚ uleˇzitˇejˇs´ı neˇz vzhled visuáln´ıho rozhran´ı. Kv˚ uli tomu je tady XPConnect a XPCOM. Funkce jako je prohl´ıˇzen´ı internetov´ ych stránek, ˇcten´ı email˚ u jsou sluˇzby implementované na aplikaˇcn´ım vrstvˇe. Jsou tedy souˇc´ ast´ı niˇzˇs´ı u ´rovnˇe. Jsou obvykle napsány v jazyce C++ a uspoˇrádány do modul˚ u, znám´ ych jako XPCOM komponenty. Vztah komponent a sluˇzeb popisuje obrázek 3.2. XPConnect propojuje JavaScript a XPCOM komponenty a pˇribaluje k nim objekty JavaScriptu. Pomoc´ı JavaScriptu a XPConnectu lze vytváˇret instance komponent a pouˇz´ıvat jejich metody a vlastnosti jako kdyˇz pracujeme s objektem z JavaScriptu. 3.3.1.1

Vytvaˇ ren´ı XPCOM objekt˚ u ve skriptu

Následuj´ıc´ı k´ od demonstruje tvorbu a pouˇzit´ı XPCOM komponent v JavaScriptu. Skript vytvoˇr´ı objekt filepicker a pouˇz´ıvá ho k zobrazován´ı souboru v dialogu filepicker.

14


Obr´ azek 3.2: XPConnect

Na prvn´ıch dvou ˇr´ adc´ıch je vidˇet jak se dialog fp filepicker vytváˇr´ı. Nejdˇr´ıve se vytvoˇr´ı instance nsIFilepicker a n´ aslednˇe se zavolá metoda createInstance(), kde nsIFilepicker urˇcuje, která komponenta se m´ a vytvoˇrit.

// chooseApp: Open file picker and prompt user for application. chooseApp: function( ) { var nsIFilePicker = Components.interfaces.nsIFilePicker; var fp = Components.classes["@mozilla.org/filepicker;1"]. createInstance( nsIFilePicker ); fp.init( this.mDialog, this.getString( "chooseAppFilePickerTitle" ), nsIFilePicker.modeOpen ); fp.appendFilters( nsIFilePicker.filterAll ); if ( fp.show( ) == nsIFilePicker.returnOK && fp.file ) { this.choseApp = true; this.chosenApp = fp.file; // Update dialog. this.updateApplicationName(this.chosenApp.unicodePath); }

3.3.1.2

Vyhled´ av´ an´ı komponenty a rozhran´ı

Hledán´ı komponent a rozhran´ı, pochopen´ı jejich funkce je velice uˇziteˇcné pro psán´ı Mozilla aplikac´ı. Pro zjednoduˇsen´ı pr´ ace existuje webová stránka Cross-References(http://mxr.mozilla.org/), slouˇz´ıc´ı k zobrazen´ı dokumentace a zdrojov´ ych kódu Mozilly.

´ KOMPONENTY 3.3. XPCONNECT A SKRIPTOVATELNE

3.3.1.3

15

V´ ybˇ er rozhran´ı z komponent

Ve skriptech m˚ uˇzeme z´ısk´ avat objekty pomoc´ı speciáln´ıho objektu classes a metody createInstance(). N´ aslednˇe m˚ uˇzeme pouˇz´ıvat metody, které nab´ız´ı. var connection = Components.classes ["@mozilla.org/network/ldap-connection;1"]. createInstance(Components.interfaces.nsILDAPConnection); connection.init(queryURL.host, queryURL.port, null, generateGetTargetsBoundCallback( )); Nejdˇr´ıv si vezme komponentu, která má CID4 ldap-connection;1 a rozhran´ı nsILDAPConnection. T´ım vytvoˇr´ıme nov´ y objekt a m˚ uˇzeme volat jeho metody.

4

CID (Contract ID) - jeden z XPCOM identifik´ ator˚ u, bude vysvˇetlen v n´ asleduj´ıc´ıch kapitol´ ach.

16


Kapitola 4

´ Uvod do XPCOM XPCOM[15, 16] je zkratka pro Cross-platform component object model. Tento framework je podobn´ y technologii COM od spoleˇcnosti Microsoft. Podporuje mnoho jazyk˚ u, jako napˇr.: JavaScript, Python, Java. Rozhran´ı XPCOM jsou definována v dialektu IDL1 naz´ yvané XPIDL2 . XPCOM poskytuje sadu základn´ıch komponent a tˇr´ıd. Vˇetˇsina propracovanˇejˇs´ıch komponent v nˇem vˇsak nen´ı zahrnuta. Proto mus´ıme vyuˇz´ıt sluˇzeb nˇekter´ ych jin´ ych knihoven (napˇr. Gecko, Necko, jiné aplikace, rozˇs´ıˇren´ı).

ˇ ast Mozilla application framework[8] Obr´ azek 4.1: C´

1 IDL (Interface definition language) - speci´ aln´ı jazyk pouˇz´ıvan´ y k popisov´ an´ı rozhran´ı softwarov´ ych komponent. 2 XPIDL (Cross Platform Interface Description Language) - speci´ aln´ı IDL pro XPCOM rozhran´ı.

17

´ KAPITOLA 4. UVOD DO XPCOM

18

4.1

ˇ sen´ı pomoc´ı XPCOM Reˇ

XPCOM je framework, kter´ y umoˇzn ˇuje v´ yvojáˇr˚ um rozdˇelit softwarové projekty na menˇs´ı modulárn´ı kousky. Tyto kousky jsou známé jako komponenty, které jsou pak smontované dohromady za bˇehu programu. C´ılem XPCOM je, aby tyto komponenty mohli b´ yt vyv´ıjeny nezávislé na sobˇe. XPCOM oddˇeluje implementaci komponent od rozhran´ı. Pomoc´ı XPCOM v´ yvojáˇri mohou vytváˇret komponenty, které mohou b´ yt opakovanˇe pouˇzity v r˚ uzn´ ych aplikac´ıch nebo nahrazovat funkcionality existuj´ıc´ıch aplikac´ı. XPCOM nejen podporuje v´ yvoj softwaru, ale také poskytuje ˇradu pokroˇcil´ ych funkc´ı, jako napˇr´ıklad: spravov´ an´ı pamˇeti, spr´ avu komponent, abstrakci soubor˚ u atd.

4.2

Komponenty XPCOM

Jak jiˇz bylo ˇreˇceno, XPCOM umoˇzn ˇuje v´ yvojáˇr˚ um rozdˇelit softwarové projekty na menˇs´ı kousky. Tyto kousky jsou obvykle malé, opˇetovnˇe pouˇzitelné binárn´ı knihovny (DLL3 ve Windowsu, SO4 v Linuxu). Mohou obsahovat jednu ˇci v´ıce komponent. Kdyˇz je v knihovnˇe jedena nebo v´ıce souvisej´ıc´ıch komponent, stává se z knihovny modul. Rozdˇelen´ı software do r˚ uzn´ ych komponent ulehˇcuje jeho v´ yvoj a u ´drˇzbu. V´ yhody rozdˇelov´ an´ı SW do komponent 4.1: Benefit Reuse Updates Performance Maintenance

Popis K´ od je znovupouˇziteln´ y v dalˇs´ıch aplikac´ıch. Aktualizace komponent bez nutnosti rekompilace celé aplikace Moduly, které nejsou nezbytné, mohou b´ yt “lazy loaded5 ”, nebo nemus´ı b´ yt v˚ ubec naˇcteny, coˇz zvyˇsuje v´ ykon aplikace. Usnadˇ nuje hled´ an´ı a u ´drˇzbu ˇcást´ı aplikace. Tabulka 4.1: V´ yhody pouˇzit´ı komponent

4.3

Interface a IDL

Vˇsechna XPCOM rozhran´ı jsou definována pomoc´ı IDL. K popisován´ı veˇrejn´ ych metod a vlastnost´ı komponent pomoc´ı IDL nen´ı definován konkretn´ı jazyk. Mozilla ve skuteˇcnosti pouˇz´ıvá modifikovanou verze IDL, kter´ y se jmenuje XPIDL. 3

DLL (Dynamic-link library) - Programové moduly, které mohou b´ yt sd´ıleny v´ıce programy, pouˇz´ıv´ ano v Microsoft Windows. 4 SO (Shared object) - Linuxov´ a varianta DLL. 5 Lazy loaded - je postup, kdy k´ od nebo modul nenahr´ av´ ame ihned, ale aˇz kdyˇz jsou potˇreba.

4.3. INTERFACE A IDL

19

Kl´ıˇcov´ ym rozd´ılem mezi COM programován´ım je, ˇze XPCOM oddˇeluje rozhran´ı a implementaci. Pokud je API oddˇeleno od implementaˇcn´ıho jazyka, má uˇzivatel API garanci toho, ˇze rozhran´ı bude nemˇenné. COM byl v podstatˇe vytvoˇren tak, aby udrˇzoval kompatibilitu na binárn´ı u ´rovni. IDL interface jsou zkompilované do tzv. Type libraries (Typové knihovny).

4.3.1

Interface versus Komponenty

Vˇetˇsina XPCOM komponent implementuje alespoˇ n dvˇe rozhran´ı. Kaˇzdá komponenta potˇrebuje funkce QueryInterface, AddRef a Release, aby se stala platn´ ym XPCOM objektem. Tyto metody jsou zdˇedˇené od z´ akladn´ıho rozhran´ı nsISupports 4.2. N´ azev

Typ

AddRef

NS IMETHOD (nsrefcnt) AddRef(void)

QueryInterface

Release

Popis

NS IMETHOD QueryInterface (REFNSIID aIID, void** aInstancePtr)

NS IMETHOD (nsrefcnt) Release(void) = 0;

Parametry/ N´ avratova hodnota Zvyˇsuje ˇc´ıtaˇc referenc´ı vrac´ı: rozhran´ı, pˇriˇrazená poˇcet instance nebude referenc´ı smazána, dokud poˇcet referenc´ı nen´ı 0. Parametry: aIID[in], kter´ y je poˇzadované interface IID. aInstancePtr [out], ukazatel na ukazatel rozhran´ı, Mechanismus pro kter´ y obdrˇz´ı zjiˇstˇen´ı rozhran´ı v´ ysledek. Vrac´ı: NS OK pokud je rozhran´ı podporován a NS NO INTERFACE kdyˇz nen´ı. NS ERROR INVALID POINTER - aInstancePtr je null. sniˇzuje ˇc´ıtaˇc referenc´ı, vrac´ı: pokud je roven 0, poˇcet tak smaˇze instance referenc´ı

Tabulka 4.2: Interface nsISupports


20

4.3.2

Root interface

QueryInterface, AddRef a Release jsou implementovány ve vˇsech komponentách. Pokaˇzdé definovat tyto tˇri metody nen´ı zrovna moc efektivn´ı. Proto jsou definovány v nsISupports a ostatn´ı rozhran´ı od nˇeho dˇed´ı. XPIDL podporuje preprocesor jazyka C, pouˇz´ıvá direktivu #include k vloˇzen´ı jiného IDL souboru, ne jako u Microsoft COM, kter´ y pouˇz´ıvá import. U vˇsech IDL soubor˚ u je nutné v horn´ı ˇcásti uvést nsISupports: #include "nsISupports.idl" interface nsISimple : nsISupports { readonly attribute string value; };

4.3.3

Kompil´ ator XPIDL

IDL kompilátor je n´ astroj, kter´ y vytvoˇr´ı binárn´ı distribuˇcn´ı soubor s názvem typové knihovny ze zdrojového souboru. XPIDL kompil´ ator generuje informace o XPCOM rozhran´ı, hlaviˇcky XPCOM objekt˚ u a typové knihovny XPT, z nichˇz mohou objekty pˇristupovat pˇres XPConnect dynamicky. Je schopen vygenerovat i HTML soubor pro dokumentaci, testovac´ı Java class kód a testovac´ı C++ k´ od. XPIDL kompil´ ator je um´ıstˇen na: mozilla/xpcom/typelib/xpidl/, lze stáhnout pomoc´ı Mer5 curial nebo na str´ ankach Mozilla.org. Jeho pouˇzit´ı je velmi jednoduché. Pouˇzit´ı syntaxe a jiné informace o kompilátoru: $ ./xpidl --help Usage: xpidl [-m mode] [-w] [-v] [-I path] [-o basename] filename.idl -a emit annotations to typelib -w turn on warnings (recommended) -v verbose mode (NYI) -I add entry to start of include path for ‘‘#include "nsIThing.idl"’’ -o use basename (e.g. ‘‘/tmp/nsIThing’’) for output -m specify output mode: header Generate C++ header (.h) typelib Generate XPConnect typelib (.xpt) doc Generate HTML documentation (.html) java Generate Java interface (.java)

4.4

Typov´ e knihovny

Základ komponentové architektury XPCOMu je, ˇze jsou soubory nezávislé na jazyku a programovác´ım prostˇred´ı. Tyto soubory jsou zkompilovány do .xpt pomoc´ı XPIDL kompilátoru. 5

Mercurial - multiplatformn´ı, distribuovan´ y systém pro spr´ avu verz´ı.

´ 4.5. IDENTIFIKATORY

4.4.1

21

Vytvaˇ ren´ı typov´ e knihovny

K vytvoˇren´ı .xpt(typelib soubor) se pouˇz´ıvá pˇr´ıznak flag -m typelib se zapnut´ ym warning (-W) a verbose (-v). Aby se soubor pˇreloˇzil korektnˇe, je nutné uvést kde nsISupports leˇz´ı. # include path to nsISupports.idl $ $XPIDL_INC = /usr/src/mozilla/xpcom/base #compile nsISimple.idl $ xpidl -m typelib -w -v -I $XPIDL_INC \ > -o nsISimple nsISimple.idl

4.5

Identifik´ atory

XPCOM pouˇz´ıv´ a dva velmi d˚ uleˇzité identifikátory pro rozeznáván´ı komponent a tˇr´ıd.

4.5.1

Identifik´ ator tˇ r´ıd

Tˇr´ıda nsIID je vlastnˇe typedef pro nsID tˇr´ıdu. nsIID poskytuje metody jako Equals pro porovn´ an´ı identifik´ ator˚ u v k´ od˚ u.

4.5.2

CID

CID je 128-bitové ˇc´ıslo, které jednoznaˇcnˇe identifikuje tˇr´ıdu nebo komponentu stejn´ ym zp˚ usobem jako IID identifikuje rozhran´ı. CID pro nsISupports vypadá takto: 00000000-0000-0000-c000-000000000046 Zápis a délka CID m˚ uˇze b´ yt nepˇrehledná a neˇsikovná s ohledem na kód, proto je velmi ˇcasto definov´ an n´ asledovnˇe: #define SAMPLE_CID \ { 0x777f7150, 0x4a2b, 0x4301, \ { 0xad, 0x10, 0x5e, 0xab, 0x25, 0xb3, 0x22, 0xaa}} Je také moˇzné pouˇz´ıvat NS DEFINE CID. Jednoduché makro pro deklaraci konstant s hodnotou CID: static NS_DEFINE_CID(kWebShellCID, NS_WEB_SHELL_CID); CID je nˇekdy oznaˇcov´ an jako identifikátor tˇr´ıdy. Pokud tˇr´ıda, na které CID odkazuje, implementuje v´ıce neˇz jeden interface, tak CID garantuje, ˇze tˇr´ıda implementuje celou mnoˇzinu interfac˚ u, kdyˇz bude Published nebo Frozen.


22

4.5.3

Contract ID

Contract ID je ˇretˇezec pouˇz´ıvan´ y k pˇr´ıstupu ke komponentám. Je ˇciteln´ y a snadno zapamatovateln´ y. CID nebo Contract ID m˚ uˇze b´ yt pouˇzito k z´ıskan´ı komponenty od Správce komponent. Takhle napˇr´ıklad vypad´ a Contract ID pro LDAP operation component: "@mozilla.org/network/ldap-operation;1" Formát Contract ID je: doména komponent, modul, název komponenty, ˇc´ıslo verze oddˇelené lom´ıtky. Stejnˇe jako CID, Contract ID odkazuje na implementaci neˇz na rozhran´ı, ne jako IID (interface ID). Ale Contract ID nen´ı omezen ˇzádnou specifickou implementac´ı, jako CID, je tedy obecnˇejˇs´ı. Contract ID specifikuje pouze danou mnoˇzinu interfac˚ u, kterou chce implementovat a ˇc´ıslo jiné CID mohou b´ yt doplnˇená. To je rozd´ıl mezi Contract ID a CID, umoˇzn ˇuje pˇrekryt´ı komponent.

4.5.4

Generov´ an´ı identifik´ ator˚ u

V Unixu/Linuxu, m˚ uˇzete pouˇz´ıt program uuidgen, spustiteln´ y z console, k vygenerován´ı UUID6 : $ uuidgen ce32e3ff-36f8-425f-94be-d85b26e634ee Pro Microsoft Windows existuje program guidgen.exe. M˚ uˇzeme také pouˇz´ıt speciáln´ıho robota na IRC7 v irc.mozilla.org pomoc´ı pˇr´ıkazu /msg mozbot uuid.

4.6

Typy

V XPCOMu existuje mnoho deklaraˇcn´ıch typ˚ u. Vˇetˇsina z tˇechto typ˚ u má jednoduché mapován´ı. Popiˇsme zde ty nejbˇeˇznˇejˇs´ıch.

4.6.1

Typy metod 4.3

Zajiˇst’uj´ı spr´ avnost konvence a n´ avratové typy.

4.6.2

Poˇ c´ıt´ an´ı referenc´ı 4.4

Tyto makra spr´ avuje poˇc´ıt´ an´ı referenc´ı. 6 UUID (Universally Unique Identifier) - obecnˇe unik´ atn´ı identifik´ ator, kter´ ym mohou b´ yt jednoznaˇcnˇe oznaˇcov´ any libovolné objekty. 7 IRC (Internet Relay Chat) - jedna z prvn´ıch moˇznost´ı komunikace v re´ alném ˇcase po internetu.

4.6. TYPY

23

NS IMETHOD NS IMETHODIMP NS IMETHODIMP (type) NS IMPORT NS EXPORT

Deklarace návratového typy. Implementace návratového typu. Speciáln´ı pˇr´ıpad implementace návratového typu. Metoda je vyˇreˇsena extern´ı knihovnou. Metoda je ˇreˇsena za pomoci extern´ı knihovny. Tabulka 4.3: Typy metod

NS ADDREF NS IF ADDREF NS RELEASE NS IF RELEASE

Volá AddRef na nsISupports objekt. Stejnˇe jako NS ADDREF s t´ım, ˇze zkontroluje null pˇred volán´ım AddRef. Speciáln´ı pˇr´ıpad implementace návratového typu. Metoda je vyˇreˇsena extern´ı knihovnou. Tabulka 4.4: Poˇc´ıtán´ı referenc´ı

4.6.3

Stavov´ e k´ ody 4.5 NS FAILED NS SUCCEEDED

Vrac´ı true, kdyˇz byl stavov´ y kód failure. Vrac´ı true, kdyˇz byl stavov´ y kód success.

Tabulka 4.5: Stavové kódy

4.6.4

Variabiln´ı mapov´ an´ı 4.6

4.6.5

Spoleˇ cn´ a error k´ od˚ u 4.7


24

nsrefcnt nsresult nsnull

V´ ychoz´ı typ pro referenˇcn´ı poˇcet, 32-bitov´ y integer. V´ ychoz´ı typ pro chyby, 32-bitov´ y integer. V´ ychoz´ı hodnota null. Tabulka 4.6: Variabiln´ı mapován´ı

NS ERROR NOT INITIALIZED NS ERROR ALREADY INITIALIZED NS ERROR NOT IMPLEMENTED NS ERROR NO INTERFACE NS ERROR NULL POINTER NS ERROR FAILURE NS ERROR UNEXPECTED NS ERROR OUT OF MEMORY NS ERROR FACTORY NOT REGISTERED

Instance nen´ı inicializována. Instance je uˇz inicializována. Metoda nen´ı implementována. Rozhran´ı nen´ı podporováno. Platn´ y ukazatel je nsnull. Metoda selˇze, generická chyba. Neoˇcekávaná chyba. Chyba pˇri alokaci pamˇeti. Poˇzadováná tˇr´ıda nen´ı zaregistrována.

Tabulka 4.7: Spoleˇcná error kód˚ u

Kapitola 5

Realizace V této kapitole se budu vˇenovat popisu realizace projektu a problém˚ um pˇri jeho realizaci.

5.1

Celkov´ y pˇ rehled

Tento program by mˇel b´ yt multiplatformn´ı, to znamená, ˇze by mˇel fungovat pod operaˇcn´ımi systémy Microsoft Windows, Linux a Mac OS. Protoˇze vˇsak nevlastn´ım MacBook a nesehnal jsem ˇclovˇeka, kter´ y by byl ochoten mi s t´ım pomoci, byl program testován jen pod Microsoft Windows a Debian GNU/Linux. Grafické rozhran´ı je definov´ ano v souboru main.xul a funkce jsou v souboru main.js. O pˇrid´ av´ an´ı poloˇzky ”ICQ test” do popup menu se stará soubor thunderbidOverlay.xul a v souboru overlay.js je zase funkce, které zobraz´ı uˇzivatelské rozhran´ı programu pomoc´ı window.open("chrome://icqtest/content/main.xul", "Blist","chrome,resizable=yes");.

5.2

V´ yvojov´ e prostˇ red´ı

Pˇri v´ yvoji aplikace jsem pouˇz´ıval textov´ y editor GEdit, kter´ y je souˇcást´ı Debian GNU/Linux, podporuje zv´ yrazˇ nov´ an´ı syntaxe, dále jsem pouˇz´ıval open-source nástroj Netbeans IDE, kter´ y v sobˇe obsahuje n´ astroje, jako je Subversion, Git, Mercurial. Pomoc´ı tˇechto nástroj˚ u m˚ uˇzeme z´ alohovat a obnovovat zdrojové soubory projektu.

5.3

Probl´ emy pˇ ri implementaci

Práce navazuje na pˇredchoz´ı projekt ExtBrain communicator, kter´ y funguje pouze pro Jabber. Po dohodˇe s vedouc´ım pr´ ace mi bylo doporuˇceno pouˇz´ıt xpcompurple od Instantbirdu, kter´ y je uˇz pˇripraven k pouˇzit´ı v aplikaci Mozilla.

25

26

KAPITOLA 5. REALIZACE

Nejdˇr´ıve jsem zaˇcal s t´ım, ˇze jsem si st´ ahl zdrojové kódy Instantbirdu[4] verze 0.1.3.1 z jeho internetov´ ych str´ anek. Ty jsem zkompiloval podle návodu na Instantbird wiki[3]. Návod na kompilaci je pops´ an v pˇr´ıloze A. Protoˇze jsem nevˇedˇel, které ze zkompilovan´ ych soubor˚ u budu potˇrebovat, konzultoval jsem to radˇeji na IRC kan´ alu, kde m´ a t´ ym v´ yvojáˇr˚ u m´ıstnost s názvem #instantbird. Bylo mi sdˇeleno, ˇze budu potˇrebovat libpurple.so, libpurplexpcom.so a vˇsechny soubory konˇc´ıc´ı na .xpt z adres´ aˇre obj-instantbird-dbg/purple/purplexpcom/public/ xpidlgen. Vytvoˇril jsem vlastn´ı projekt s n´ azvem “ICQ test” pomoc´ı Firefox/Thunderbird Extension Wizard1 [14]. Staˇc´ı jednoduˇse zadat n´ azev, ID, verzi projektu, nastavit moˇznosti, c´ılové aplikace a popˇr´ıpadˇe jednu ze tˇr´ı nab´ızen´ ych licenc´ı. Poté jsem zkop´ıroval knihovny a soubory (libpurple.so, libpurplexpcom.so a vˇsechny .xpt soubory) do sloˇzky “components”. Nainstaloval je do Mozilla Thunderbirdu 2. Pomoc´ı programu XPCOM viewer jsem chtˇel zjistit, zda jsou vˇsechny tˇr´ıdy a rozhran´ı naˇcteny. Ovˇsem nebylo tomu tak. V XPCOM vieweru bylo zobrazeno jen rozhran´ı purpleIAccount atd., tˇr´ıdy jako @instantbird.org/purple/core;1 nebyly nalezeny. Následnˇe jsem zkompiloval a vyzkouˇsel ostatn´ı verze, které má Instantbird uloˇzeny v Merˇ adn´ curialu. Z´ a z nich neˇsla pouˇz´ıt. Vˇzdy to dopadlo tak, ˇze v XPCOM vieweru nebyly vidˇet tˇr´ıdy od Instantbirdu. Po dalˇs´ı diskuzi s v´ yvoj´ aˇri jsme dospˇeli k závˇeru, ˇze se jedná o chybu, konkrétnˇe problém s nsSocketTransportService. Problém je v tom, ˇze spojen´ı pomoc´ı soket˚ u nen´ı v XPCOM moˇzné pouˇz´ıt, podrobnosti najdete na https://bugzilla.mozilla.org/show_bug.cgi? id=418535. Bylo mi ˇreˇceno, ˇze je tento problém opraven v xulrunner od verze 1.9b4, zat´ımco Mozilla Thunderbird 2 bˇeˇz´ı na 1.8.*. Z tohoto d˚ uvodu je mnou vyv´ıjen´ y modul pouˇziteln´ y aˇz pro Mozilla Thunderbird 3, kter´ y bˇeˇz´ı jiˇz na xulrunner 1.9.*. Problémem je to, ˇze projekt ExtBrain communicator jeˇstˇe nefunguje pod Thunderbirdem 3. Po konzultaci s vedouc´ım jsme se rozhodli, ˇze zprovozn´ım Instantbird na Mozille Thunderbidr 3 a pˇredvedu jeho funkcionality. Stáhl jsem si zdrojové k´ ody Comm-central z Mercurial, zkompiloval program a nainstaloval jsem bal´ıˇcek (n´ avod na jeho instalaci je popsán v pˇr´ıloze A). Poté se v seznamu objevily XPCOM tˇr´ıdy, které jsem potˇreboval. Kdyˇz byl tento problém vyˇreˇsen, zaˇcal zkouˇset základn´ı pˇr´ıkazy, které jsou pouˇz´ıvány pro testován´ı. Napˇr.: pˇripojov´ an´ı k u ´ˇctu, vypsán´ı protokol˚ u atd. var pcs = Components.classes["@instantbird.org/purple/core;1"] .getService(Ci.purpleICoreService); pcs.init(); var proto = pcs.getProtocolById(aProto); if (!proto) throw "Couldn’t get protocol " + aProto; var acc = pcs.createAccount(aName, proto); ... 1

Firefox/Thunderbird Extension Wizard - n´ astroj pro jednoduché a rychlé vytv´ aˇren´ı .xpi bal´ıˇck˚ u.

´ ˇ IMPLEMENTACI 5.3. PROBLEMY PRI

27

Kdyˇz jsem postupnˇe napsal v´ yˇse uveden´ y kód do JavaScript shellu, tak byl objekt pcs vytvoˇren bez problému. Kdyˇz jsem vˇsak chtˇel pcs zinicializovat cel´ y Thunderbird zamrzl. Nic neˇslo udˇelat, jedinˇe ho vypnout pomoc´ı pˇr´ıkazu kill pˇres konzoli. Snaˇzil jsem se tedy dop´ atrat proˇc se tak dˇeje. Postupnˇe jsem proˇsel konfiguraˇcn´ı soubory, zdrojové k´ ody, ovˇeˇril jsem funkce init(). Ze zprávy v konzoli jsem zjistil, ˇze v adresáˇri Thunderbirdu chyb´ı soubor libpurple.so, tak jsem pro jistotu do tohoto adresáˇre nahrál jak libpurple.so, tak i libpurplexpcom.so, ale problém se mi t´ım vyˇreˇsit nepodaˇrilo. Nechal jsem si ˇ sen´ı bylo pomˇernˇe jednoduché, staˇcilo si stáhnout soubor a udˇelat patch2 , tedy poradit. Reˇ aby knihovny od Instantbirdu mohly fungovat pro xulrunner 1.9.1, jsou totiˇz zkompilované pomoc´ı xulrunner 1.9.2 a je potˇreba udˇelat patch. Ukázka k´ odu z patch souboru: diff --git a/instantbird/content/addbuddy.js b/instantbird/content/addbuddy.js --- a/instantbird/content/addbuddy.js +++ b/instantbird/content/addbuddy.js @@ -58,17 +58,17 @@ var addBuddy = { ... let tags = this.pcs.getTags(); + let tags = this.pcs.getTags({}); ... Po této u ´pravˇe je inicializace hotová a Thunderbird nadále bˇeˇz´ı. Coˇz byla dobrá zpráva do té doby, neˇz se objevil dalˇs´ı problém. Tentokrát to byla ˇspatná inicializace. Snaˇzil jsem se naj´ıt ˇreˇsen´ı pomoc´ı programu strace3 ale ne´ uspˇeˇsnˇe. Na internetovém fóru jsem se dozvˇedˇel, ˇze mám zkop´ırovat dva soubory all-instantbird.js a purple-prefs.js do svého projektu a zakomentovat prvn´ı dva ˇr´ adky v souboru all-instantbird.js. Pˇri vytv´ aˇren´ı projektu jsem narazil na dalˇs´ı problém. Funkce getIter(), která má vracet seznamy protokol˚ u, u ´ˇct˚ u atd., pˇri zavolán´ı skonˇcila chybov´ ym hláˇsen´ım, ˇze chyb´ı ;(konec pˇr´ıkazu). Bylo to zp˚ usobeno t´ım, ˇze kl´ıˇcové slovo yield je novˇe pˇridané do JavaScriptu 1.7 a v dˇr´ıvˇejˇs´ıch verz´ıch nebylo. Aktualizoval jsem si tedy JavaScript na verzi 1.7. function getIter(aEnumerator) { while (aEnumerator.hasMoreElements()) yield aEnumerator.getNext(); } Pˇri programov´ an´ı jsem narazil jeˇstˇe na dalˇs´ı problém, kter´ y zp˚ usobil tento ˇrádek Components.utils.import("resource://app/modules/imWindows.jsm"); 2

patch - n´ astroj, kter´ ym m˚ uˇze b´ yt soupis zmˇen aplikov´ an na staré soubory tak, ˇze z´ısk´ ame nové. strace - je n´ astroj, kter´ y sleduje a zaznamen´ av´ a systémové vol´ an´ı. Je uˇziteˇcn´ y pro stopov´ an´ı a urˇcov´ an´ı pˇresné pˇr´ıˇciny systémov´ ych chyb, nebo podezˇrelého chov´ an´ı aplikac´ı. 3

28

KAPITOLA 5. REALIZACE

Neˇslo soubor imWindows.jsm naimportovat, je to zp˚ usobeno t´ım, ˇze alias app se odkazuje na soubory Firefoxu, neodkazuje se vˇsak tam, kde leˇz´ı rozˇs´ıˇren´ı. Je proto potˇreba nadefinovat vlastn´ı alias a uvést to v souboru chrome.manifest. To m˚ uˇze vypadat napˇr´ıklad následovnˇe: resource privatiser modules/ #definice vlastn´ ıho alias #ted’ se tam odkazujeme pomoc´ ı definovan´ eho alias Components.utils.import("resource://privatiser/imWindows.jsm"); Soubor imWindows.jsm nebyl nijak d˚ uleˇzit´ y, neovlivˇ nuje chod programu, ale chyba v consoli nevypad´ a dobˇre. Program byl nakonec dokonˇcen, ale pˇri jeho implementaci do nov´ ych verz´ı ExtBrain communicatoru je zapotˇreb´ı vylepˇsit napˇr´ıklad grafické uˇzivatelské rozhran´ı, zp˚ usob zobrazen´ı atd.

Kapitola 6

Testov´ an´ı V této kapitole se budu vˇenovat popisu testován´ı funkˇcnosti tohoto projektu.

6.1

Realn´ e nasazen´ı

Funkˇcnost tohoto programu jsem testoval na Debian GNU/Linuxu. V programu je moˇzné se pˇrih´ asit na nˇekolik u ´ˇct˚ u najednou. Vyzkouˇsel jsem pouze práci s Jabber a ICQ, protoˇze mám jen tyto dva u ´ˇcty. Pro spouˇstˇen´ı programu staˇc´ı provést následuj´ıc´ı kroky: Tools → ICQ test. Poté se otevˇre nové okno s pˇrehledem aktu´ alnˇe pˇrihláˇsen´ ych u ´ˇct˚ u. Po pˇrihláˇsen´ı na jin´ yu ´ˇcet je zapotˇreb´ı tento seznam ruˇcnˇe aktualizovat kliknut´ım na combobox. Status lze zmˇenit kliknut´ım na tlaˇc´ıtko “S” a vybrat jednu ze tˇr´ı moˇznost´ı nebo napsat vlastn´ı zprávu.

Obrázek 6.1: Program po spouˇstˇen´ı

29

´ Í KAPITOLA 6. TESTOVAN

30

Pˇripojen´ı a odpojen´ı u ´ˇctu prob´ıh´ a bez problém˚ u. Je vˇsak nutné ˇc´ıslo u ´ˇctu a heslo zadávat pˇri kaˇzdém pˇripojen´ı. U protokol˚ u jako je Jabber, MSN atd., je potˇreba zadat i název serveru. Po spuˇstˇen´ı se program automaticky pˇripoj´ı na server.

Obr´ azek 6.2: Pˇrihláˇsován´ı

Seznam pˇrátel a skupiny je moˇzné zobrazit po kliknut´ı na tlaˇc´ıtko ”Output all buddies”. Pˇri dvojkliku na vybranou poloˇzku v seznamu se v textboxu “Buddy account” zobraz´ı alias nebo ICQ id daného u ´ˇctu. Funkce pro vytv´ aˇren´ı a maz´ an´ı u ´ˇctu jsem vyzkouˇsel tak, ˇze jsem vytvoˇril nˇekolik u ´ˇct˚ u a postupnˇe jsem vˇsechny smazal, v´ ysledky jsem si ovˇeˇril pomoc´ı SQLite manager. //tento ˇ r´ adek vytvoˇ r´ ı ´ uˇ cet a uloˇ z´ ı do datab´ aze. var cre_acc = pcs.createAccount(username, userproto.value).password=userpass; //tento zase smaˇ ze ´ uˇ cet podle ID v datab´ azi. pcs.deleteAccount(account.id); V´ ysledek podle SQLite manager ukazuje obrázek 6.3:

Obr´ azek 6.3: Porovnán´ı po proveden´ı pˇr´ıkazu

Pro pˇridán´ı nového kontaktu do seznamu je potˇreba nejdˇr´ıv vybrat jeden z aktuálnˇe pˇrihláˇsen´ ych u ´ˇct˚ u, zadat jméno, email nebo ICQ id a vybrat si skupinu, poté potvrdit tlaˇc´ıtkem ”Create”. Pro vytváˇren´ı nové konverzace je potˇreba si nejdˇr´ıv vybrat z online seznamu jeden u ´ˇcet, poté ze seznamu pˇr´ atel c´ılov´ y u ´ˇcet. Dvojkliknut´ım na jméno c´ılového u ´ˇctu se objev´ı v ”Buddy account”, následnˇe po stisknut´ı tlaˇc´ıtka ”Start chat” m˚ uˇzete uˇz komunikovat. Tato funkcionalita vˇsak nen´ı zcela dokonˇcena. M˚ uˇzete komunikovat jenom s jedn´ım ˇclovˇekem a pokud

´ AN ´ Í S EXISTUJÍCÍMI RE ˇ SEN ˇ ÍMI 6.2. SROVNAV

31

Obrázek 6.4: Chatován´ı

chcete mluvit s jin´ ym, mus´ıte nejdˇr´ıv zavˇr´ıt program a znovu ho spustit. Coˇz je to potˇreba vylepˇsit v dalˇs´ıch verz´ıch. Domn´ıv´ am se, ˇze toto dostateˇcnˇe demonstruje funkˇcnost xpcompurple pod Mozilla Thunderbird 3.

6.2

Srovn´ av´ an´ı s existuj´ıc´ımi ˇ reˇ sen´ımi

Protoˇze v Mozilla Thunderbirdu zat´ım neexistuje podobn´ y program, tak nen´ı moˇzné porovn´ an´ı.

32

´ Í KAPITOLA 6. TESTOVAN

Kapitola 7

Z´ avˇ er 7.1

Zhodnocen´ı

D´ıky této pr´ aci jsem se nauˇcil jak se programuj´ı rozˇs´ıˇren´ı do Mozilla aplikac´ı, jak funguje technologie XPCOM, XPConnect a XUL. Poznal jsem v´ yhody a nev´ yhody program˚ u tohoto typu. Mysl´ım si, ˇze se zkuˇsenostmi, které jsem nabyl pˇri realizaci tohoto projektu, bych mohl pouˇz´ıt i jinde, nejen pˇri programován´ı aplikac´ı tohoto typu. Pˇri vypracován´ı tohoto projektu jsem také narazil na mnoho problém˚ u, které jsem ovˇsem vˇsechny zdárnˇe vyˇreˇsil. Moˇznost´ı dalˇs´ıho pokraˇcov´ an´ı této práce je spousta, protoˇze xpcompurple nen´ı sám o sobˇe dokonˇcen´ y. Tento projekt se stále vylepˇsuje a zdokonaluje. Hlavn´ım c´ılem je m´ıt hotov´ y projekt ExtBrain communicator, kter´ y bude fungovat pod Mozilla Thunderbirdem 3 a implementovat do nˇej xpcompurple. Poté se zamˇeˇrit na jiné detaily, jako je grafické rozhran´ı atd. Závˇerem bych se chtˇel omluvit za mou ˇceˇstinu a gramatiku. Doufám, ˇze jsem neudˇelal mnoho chyb.

33

34

´ ER ˇ KAPITOLA 7. ZAV

Literatura [1] DOM Inspector [online]. https://addons.mozilla.org/cs/thunderbird/addon/1806, stav ze 16. 4. 2010. [2] Extension Developer [online]. https://addons.mozilla.org/cs/thunderbird/addon/7434, stav ze 16. 4. 2010. [3] Instantbird kompilace [online]. https://wiki.instantbird.org/Instantbird:Compiling, stav ze 25. 5. 2010. [4] Instantbird download [online]. http://instantbird.com/download.html, stav ze 25. 5. 2010. [5] Instantbird [online]. http://instantbird.com/, stav ze 16. 4. 2010. [6] JavaScript and the DOM [online]. http://www.csie.ntu.edu.tw/~piaip/docs/CreateMozApp/ mozilla-chp-5-sect-2.html, stav ze 16. 5. 2010. [7] Mozilla application framework [online]. https://developer.mozilla.org/en/Mozilla_Application_Framework_in_ Detail, stav ze 16. 4. 2010. [8] Rapid Application Development with Mozilla [online]. http://mb.eschew.org/1, stav ze 16. 5. 2010. [9] Scripting Mozilla [online]. http://www.csie.ntu.edu.tw/~piaip/docs/CreateMozApp/mozilla-chp-5.html, stav ze 16. 5. 2010. [10] SQLite Manager [online]. https://addons.mozilla.org/cs/thunderbird/addon/5817, stav ze 16. 4. 2010. [11] Add-on pro Thunderbird [online]. https://addons.mozilla.org/en-US/thunderbird/, stav ze 16. 4. 2010. [12] Thunderbird [online]. http://www.mozillamessaging.com/thunderbird/, stav ze 16. 4. 2010.

35

36

LITERATURA

[13] Venkman [online]. https://addons.mozilla.org/cs/thunderbird/addon/216, stav ze 16. 4. 2010. [14] Firefox/Thunderbird Extension Wizard [online]. http://ted.mielczarek.org/code/mozilla/extensionwiz/, stav ze 25. 5. 2010. [15] XPCOM [online]. https://developer.mozilla.org/en/Creating_XPCOM_Components/An_Overview_ of_XPCOM, stav ze 16. 5. 2010. [16] XPCOM [online]. http://www.csie.ntu.edu.tw/~piaip/docs/CreateMozApp/mozilla-chp-8.html, stav ze 16. 5. 2010. [17] XPCOM Viewer [online]. https://addons.mozilla.org/cs/thunderbird/addon/7979, stav ze 16. 4. 2010. [18] XPConnect and Scriptable Components [online]. http://www.csie.ntu.edu.tw/~piaip/docs/CreateMozApp/ mozilla-chp-5-sect-4.html, stav ze 16. 5. 2010. [19] XUL Explorer [online]. https://developer.mozilla.org/en/XUL_Explorer, stav ze 16. 4. 2010.

Dodatek A

Instalaˇ cn´ı a uˇ zivatelsk´ a pˇ r´ıruˇ cka A.1

Instalace Mozilla Thunderbird a Instantbird

Mozilla Thunderbird je k dispozici na webov´ ych stránkach Mozilla messaging (http://www. mozillamessaging.com/), aktuáln´ı verze je: 3.0.4. Pokud chcete Mozilla Thunderbird zkompilovat na svém poˇc´ıtaˇci, m˚ uˇzete si zdrojové k´ ody stáhnout pˇres CVS, Mercurial nebo FTP/HTTP. Postup je následuj´ıc´ı (Detailn´ı postup je uveden na webu1 a je také popsán v A.1.1): Zaprvé mus´ıte m´ıt nainstalované poˇzadované nástroje bud’ pro Microsoft Windows2 nebo pro Linux3 , podle toho jak´ y operaˇcn´ı systém ’ pouˇz´ıv´ ate. Zadruhé je potˇreba stáhnout zdrojové kódy bud z Mercurial nebo pˇres FTP/HTTP. Poté nakonfigurovat4 (napˇr. debug mód) a nakonec to zkompilovat pomoc´ı pˇr´ıkazu make5 .

A.1.1

Postup instalace

V Linuxu je nutné nainstalovat nˇekteré knihovny a nástroje. Zde uvedu potˇrebné propriety pro Debian GNU/Linux: $ apt-get build-dep thunderbird $ apt-get install mercurial libasound2-dev libcurl4-openssl-dev libnotify-dev \ libxt-dev libiw-dev mesa-common-dev autoconf2.13 Pro Microsoft Windows je potˇreba stáhnout: Microsoft Visual C++ Tools - obvykle je to Visual Studio, Microsoft Windows SDK(s)6 , MozillaBuild7 . Podle toho jakou verzi 1

Postup instalace je na https://developer.mozilla.org/en/Simple_Thunderbird_build Prerekvizity pro Microsoft Windows: https://developer.mozilla.org/En/Developer_Guide/Build_ Instructions/Windows_Prerequisites 3 Prerekvizity pro Linux: https://developer.mozilla.org/En/Developer_Guide/Build_Instructions/ Linux_Prerequisites 4 Konfigurace: https://developer.mozilla.org/en/Configuring_Build_Options 5 Kompilace: https://developer.mozilla.org/en/Build_and_Install 6 Windows SDK je ke staˇzen´ı na https://developer.mozilla.org/En/Windows_SDK_versions 7 MozillaBuild je ke staˇzen´ı na http://ftp.mozilla.org/pub/mozilla.org/mozilla/libraries/win32/ MozillaBuildSetup-Latest.exe 2

37

38

ˇ Í A UZIVATELSK ˇ ´ PR ˇ ÍRUCKA ˇ DODATEK A. INSTALACN A

Windows pouˇz´ıv´ ate. Jakmile máte tyto n´ astroje a knihovny nainstalované, m˚ uˇzete stáhnout zdrojové kódy z Mercurialu. V Linuxu staˇc´ı pˇr´ıkaz: $ hg clone http://hg.mozilla.org/comm-central/ #pro Mozilla thunderbird $ hg clone http://hg.instantbird.org/instantbird/ #pro Instantbird Ve Windows je zapotˇreb´ı nejdˇr´ıve spustit dávkov´ y soubor z MozillaBuild ve Windows commanderu podle toho, jakou verzi Visual studia máte nainstalovanou, a teprve potom zadat pˇr´ıkazy uvedené v´ yˇse. C:/MozillaBuild/start-msvc9.bat # pro Visual studio 2008 Po staˇzen´ı k´ od˚ u je potˇreba otevˇr´ıt adresáˇr, kde jsou kódy uloˇzeny a provést aktualizace: $ cd comm-central $ python client.py checkout $ cd instantbird $ python client.py checkout poté vytvoˇrit soubor mozconfig pro Thunderbird i pro Instantbird, ve kterém budou napˇr´ıklad tyto hodnoty: # Setup a basic mozconfig file #let’s build Thunderbird echo ’ac_add_options --enable-application=mail’ > mozconfig #in this directory echo ’mk_add_options MOZ_OBJDIR=@TOPSRCDIR@/objdir-tb-debug’ >> mozconfig #quickly echo ’mk_add_options MOZ_MAKE_FLAGS="-j4"’ >> mozconfig #debug mode echo ’ac_add_options --enable-debug’ >> mozconfig #no optimize echo ’ac_add_options --disable-optimize’ >> mozconfig Pro Instantbird je to podobné, ale m´ısto --enable-application=mail a MOZ OBJDIR= @TOPSRCDIR@/objdir-tb-debug bude --enable-application=instantbird a MOZ OBJDIR= @TOPSRCDIR@/objdir-instantbird-debug. To zmámená, ˇze název této aplikace bude inyt aplikace stantbird, zat´ımco Thunderbird pouˇz´ıvá mail. MOZ OBJDIR je m´ısto, kde má b´ nainstalována. Samotná kompilace se na konec provede pomoc´ı pˇr´ıkazu #v adresaˇ r´ ı instantbird a comm-central $ make -f client.mk build

A.2. INSTALACE PROJEKTU

39

Program po kompilaci najdete v adresáˇri MOZ OBJDIR/mozilla/dir/dist/bin/. Pro pozdˇejˇs´ı aktualizace k´ odu staˇc´ı provést: $ cd instantbird $ python client.py checkout $ make -f client.mk build $ cd comm-central $ python client.py checkout $ make -f client.mk build Pˇred kompilac´ı Instantbirdu je potˇreba nainstalovat záplatu. Je velice d˚ uleˇzitá, protoˇze jinak zkompilované knihovny pod Thunderbirdem 3 nebudou fungovat. Záplata s n´ azvem instantbird.patch je uloˇzena spolu se zdrojov´ ym kódem v adresáˇri instantbird. Záplatu nainstalujete n´ aslednˇe: $ cd instantbird $ patch -p1 instantbird.patch

A.2

Instalace projektu

Postup instalace programu je v podstatˇe stejn´ y jako instalace jiného rozˇs´ıˇren´ı aplikac´ı do Mozilla. V Thunderbirdu si vyberete menu Tools → Add–ons → Extensions → Install, pak si najdete soubor icqtest.xpi a kliknut´ım na tlaˇc´ıtko OK zapoˇcne instalace. Nakonec je nutné jeˇstˇe zkop´ırovat knihovnu libpurple.so (purple.dll pod Windows) do adresáˇre Thunderbirdu. Po instalaci se objev´ı nov´ a poloˇzka pod menu Tools s názvem “ICQ test”, kliknut´ım na poloˇzku program spust´ıte.

40

ˇ Í A UZIVATELSK ˇ ´ PR ˇ ÍRUCKA ˇ DODATEK A. INSTALACN A

Dodatek B

Obsah pˇ riloˇ zen´ eho CD • Mozilla Thunderbird zkompilovan´ y ze zdrojov´ ych kód˚ u. Verze pro Microsoft Windows 7 a pro Debian GNU/linux 5.0 lenny. • Instantbird zkompilovan´ y ze zdrojov´ ych kód˚ u. Verze pro Microsoft Windows 7 a pro Debian GNU/linux 5.0 lenny. • Profil Mozilla Thunderbird, kter´ y obsahuje veˇskeré nástroje a nastaven´ı. • Projekt ”ICQ test”. – Dokumentace – Zdrojové k´ ody – Navod - N´ avod ke spuˇstˇen´ı programu po instalaci. – build.sh - Bash soubor pro vytváˇren´ı .xpi bal´ıˇck˚ u, po spuˇstˇen´ı vytvoˇr´ı icqtest.xpi, kter´ y m˚ uˇzete nainstalovat do Mozilla Thunderbirdu, pˇredt´ım je jeˇstˇe potˇreba provést copy lib.sh. – config build.sh - Konfiguraˇcn´ı soubor, jsou zde potˇrebné odkazy pro build.sh. – soft install.sh - Pˇr´ıkazy pro staˇzen´ı Instantbird z repositáˇre a následné instalace. – soft install1.sh - Pˇr´ıkazy pro staˇzen´ı Mozilla thunderbird 3 z repositáˇre a následnou instalaci. – copy lib.sh - Zkop´ıruje knihovnu libpurple.so do Mozilla Thunderbirdu. – aktualizace.sh - provede aktualizaci a reinstalaci Instantbirdu nebo Mozilla Thunderbirdu.

41

Fakulta elektrotechnická. protokoly. Yun Ruan. Studijní program: Elektrotechnika a informatika, strukturovaný, Bakalářský. Obor: Výpočetní technika

Recommend Documents