Dokumentacja dla deweloperów

Nie jesteś deweloperem?
Przejdź na http://www.instantbird.pl/

Więcej aktualnych informacji można znaleźć na Instantbird wiki. Większość informacji z tej strony została lub zostanie tam przeniesiona.

Jak stworzyć rozszerzenie?

Interfejs użytkownika Instantbirda został napisany w XUL. Możesz zatem pisać rozszerzenia do Instantbirda w taki sam sposób, jakbyś to robił dla innych aplikacji XUL (Firefox, Thunderbird itp.). Wiele przydatnych informacji znajdziesz na stronach Mozilla Developer Center. Naukę warto rozpocząć od tego tutorialu.

Aby napisać rozszerzenie, będziesz potrzebował appid Instanbirda, którym jest {33cb9019-c295-46dd-be21-8c4936574bee}.

Mamy nadzieję, że będziesz się dobrze bawił tworząc dodatki do Instantbirda. Daj nam znać o swoich projektach. Jeśli masz jakiekolwiek pytania dotyczące ograniczeń Instantbirda, skontaktuj się z twórcami aplikacji.

Tłumaczenie

Instanbird nie jest jeszcze przygotowany do tłumaczenia. Więcej informacji...

Pobierz źródło

Kod źródłowy najnowszej wersji możesz pobrać stąd.

Budowanie

Wersja 0.1.2 (i późniejsze)

Proces budowania został maksymalnie uproszczony: otrzymujesz kod źródłowy i budujesz w taki sam sposób, jakbyś zrobił to z Firefoxem lub Thunderbirdem.

tar -xzf instantbird-0.1.2-src.tgz
cd mozilla
make -f client.mk build

Powstałą w ten sposób aplikację możesz uruchomić z katalogu ../obj-instantbird/dist/bin.

Wersje 0.1 oraz 0.1.1

Proces budowania sprowadza się do następujących kroków:

pobierz źródło,
zbuduj xulrunnera,
zbuduj libpurple,
zbuduj instantbirda,
enjoy :-)

Możesz zbudować Instantbirda 0.1.1 kopiując poniższy skrypt:

#!/bin/sh

# najpierw pobieramy kod źródłowy instantbirda, następnie budujemy zależności (xulrunner i libpurple), a na końcu budujemy dopiero instantbirda
wget http://download.instantbird.com/0.1.1/instantbird-0.1.1-src.tar.gz
tar -xzf instantbird-0.1.1-src.tar.gz
mv instantbird-0.1.1-src instantbird

# pobierz i rozpakuj kod źródłowy xulrunnera
wget http://download.instantbird.com/0.1.1/xulrunner1.9b2-src-for-instantbird-0.1.1.tar.bz2
tar -xjf xulrunner1.9b2-src-for-instantbird-0.1.1.tar.bz2
cd mozilla

# zbuduj xulrunnera. Jest to dosyć długi proces (trwa pomiędzy 20 min a ponad godziną w zależności od sprzętu)
make -f client.mk build

cd ..

# pobierz tarballa z kodem źródłowym pidgina 2.2.1 i go rozpakuj
wget http://downloads.sourceforge.net/pidgin/pidgin-2.2.1.tar.bz2
tar -xjf pidgin-2.2.1.tar.bz2
cd pidgin-2.2.1
patch -p0 < ../instantbird/utils/patch-libpurple.diff

# skonfiguruj go tak, aby został zbudowany bez żadnego UI: potrzebujemy jedynie libpurple
# ponadto używamy flagi --prefix, abyśmy mogli wywołać make install bez uprawnień roota
./configure --disable-gtkui --disable-consoleui --prefix=$(pwd)/_inst
make && make install

cd ../instantbird/xpcom/

# skonfiguruj komponenty xpcom instantbirda, aby wykorzystywały one właśnie stworzone buildy uzupełnień
./configure --with-pidgin-src=../../pidgin-2.2.1 --with-libpurple=../../pidgin-2.2.1/_inst/lib --with-gecko=../../mozilla/obj-instantbird/dist
# zbuduj całość i zainstaluj w folderze 'testapp'
make install

# przejdź do folderu testapp zawierającego świeżo zbudowanego instantbirda
cd ../testapp
# utwórz odnośnik do xulrunnera
ln -s ../../mozilla/obj-instantbird/dist/bin xulrunner

# możesz teraz spróbować zbudować własnego instantbirda  za pomocą skryptu instantbird.sh

Jeśli chcesz zbudować Instantbirda na Ubuntu, będziesz potrzebował poniższych pakietów:


sudo apt-get install gcc g++ libgtk2.0-dev libidl-dev libxt-dev libcurl3-dev patch
sudo apt-get install gnutls-dev libxml2-dev gettext

Wytyczne kodowania

Zostaną wkrótce opisane. Głównym zamysłem jest to, że jeśli edytujesz plik, aby zamieścić w nim łatkę, powinieneś zachować styl kodowania pliku. Podążamy głównie za wytycznymi Mozilli.

Planowane zmiany

Ważne

Pamiętaj, że poniższe informacje opisują jedynie zmiany, które planujemy wdrożyć. Które z nich zaimplementujemy oraz w jakiej kolejności może się różnić od prezentowanej poniżej listy. Zostałeś ostrzeżony!

Plan generalny

0.1: podstawowa funkcjonalność Instantbirda. Planowane wydanie pod koniec września 2007.
0.1.x: naprawa zgłoszonych bugów. Poprawa jakości.
0.2: wszystko co chcieliśmy dodać w 0.1, ale zabrakło czasu.
0.3: implementacja wszystkiego, co jest absolutną koniecznością w nowoczesnym komunikatorze.
0.4 i kolejne: zobaczymy w przyszłości, będziemy bazować na opiniach użytkowników.
...
1.0: Pełna zgodność możliwości z Pidginem.

0.1.1

Wygląda to bardziej jak lista bugów ;-)

Zabić purpleInit.cpp
Podzielić purpleCoreService na tyle obiektów, ile to konieczne. Powinno to być zrozumiałe, żadnego bałaganu!
Funkcje document/fix/optimize (--> rationalize) używające mozStorage.
Dobrze wykorzystać wskaźniki ui_data oraz new_node :-)
Zabawa z nsIClassInfo
Podczas usuwania konta należy zaprowadzić porządek w mozStorage
Usuwanie znajomych
Naprawa nazw

0.1.5 (???)

Proxy
Podzielić nazwy użytkowników dla jabbera i irca w małe, zrozumiałe części (nick, serwer, lokalizacja)

0.2

Obsługa statusów
- Wyświetlić więcej informacji o statusie znajomych na liście
- Powiadomienie o aktywności
- Powiadomić libpurple o braku aktywności, żeby mógł się przełączyć w tryb z/w
- Ustawianie statusu i powiadomień
Kontakty
- Obsługa kontaktów (pogrupować kontakty należące do tej samej fizycznej osoby)
- System tagów
- Usuwanie kontaktów
Rozszerzenia
- Lokalizacje językowe (w tym polska)
- Powinno się umożliwić załadowanie protokołu purple jako rozszerzenia!
- Obsługa emotikonów
- Obsługa własnych dźwięków
GUI

Usprawnić karty (prawdopodobnie sprowadzić je do systemu znanego z Firefoksa 2+)
Dodać ikonę powiadomień
Obsługa haseł za pomocą menedżera haseł Mozilli. Hasła nie powinny być już zapisywane jako czysty tekst.

0.3

Pełne formatowanie tekstu w wiadomościach wychodzących (wysyłanie wiadomości w HTML)
Ustawienie formatowania domyślnego
Obsługa czatów (kanały irc itp.)
Ikony znajomych
Transfer plików
Okno właściwości
Dźwięki: zaawansowany wybór i ustawienia
Brzęczyk
Obsługa listy ignorowanych

0.4

Archiwum rozmów
Notatki
...

1.0

Pełna zgodność możliwości z Pidginem

Po 1.0

Wideo/dźwięk

Zgłoś błąd

Jeśli znalazłeś błąd w Instantbirdzie, postępuj według poniższego schematu:

Najpierw przeszukaj naszą bazę bugów, aby się upewnić, że nikt go wcześniej nie zgłosił.

Jeżeli nie jesteś w stanie znaleźć znalezionego błędu w bazie, zgłoś go jako nowy bug. Podczas zgłaszania błędu pamiętaj, że celem jest jego naprawa. Aby wysłać raport, który pomoże w naprawie błędu, opisz wszelkie informacje, które wydają Ci się znaczące (wersja używanego Instantbirda, system operacyjny, używane protokoły itp.). Zdajemy sobie sprawę, że zgłoszony przez Ciebie błąd może być dla Ciebie znaczącym problemem. Nie możemy jednak obiecać Ci kiedy zostanie on naprawiony oraz czy w ogóle zostanie on poprawiony. Nie irytuj się więc, wytłumacz jak wywołałeś błąd i nie marnuj ani swojego, ani naszego czasu opisując, jak straszny jest ten błąd oraz jak bardzo wymaga on naszej uwagi.

Jeśli chcesz zgłosić zawieszenie się aplikacji, w większości przypadków Twój raport będzie bezużyteczny bez zapisu z logów.