Rozdział 2. Pluginy

Spis treści

Plugin: gg
Polecenia
Zmienne
Zmienne sesyjne
Plugin: ioctld
Polecenia
Plugin: irc
Polecenia
Zmienne sesyjne
Plugin: jabber
Polecenia
Zmienne
Zmienne sesyjne
Plugin: logs
Zmienne
Plugin: logsqlite
Wstęp
Sposób użycia
Struktura bazy danych
Polecenia
Zmienne
Plugin: ncurses
Zmienne
Plugin: python
Interfejs od strony interpretera
Obsługa poleceń i sygnałów
Przykładowy skrypt
Plugin: rc
Zmienne
Plugin: readline
Zmienne
Plugin: sim
Polecenia
Zmienne
Plugin: sms
Polecenia
Zmienne
Plugin: xosd
Polecenia
Zmienne

Plugin: gg

Polecenia

_autoaway

Parametry. 

Krótki opis.  automatycznie zmienia stan na zajęty


_autoback

Parametry. 

Krótki opis.  automatycznie zmienia stan na dostępny


_descr

Parametry.  [opis/-]

Krótki opis.  zmienia opis stanu

Jeżeli nie podano opisu to będzie szukany losowy opis.
Podanie ,,-'' zamiast powodu spowoduje wyczyszczenie opisu.

away

Parametry.  [opis/-]

Krótki opis.  zmienia stan na zajęty

Jeżeli nie podano opisu to będzie szukany losowy opis.
Podanie ,,-'' zamiast powodu spowoduje wyczyszczenie opisu.

back

Parametry.  [opis/-]

Krótki opis.  zmienia stan na dostępny

Jeżeli nie podano opisu to będzie szukany losowy opis.
Podanie ,,-'' zamiast powodu spowoduje wyczyszczenie opisu.

block

Parametry.  [numer/alias]

Krótki opis.  dodaje do listy blokowanych


change

Parametry.  <opcje>

Krótki opis.  zmienia informacje w katalogu publicznym

  -f, --first <imię>

  -l, --last <nazwisko>

  -n, --nick <pseudonim>

  -b, --born <rok urodzenia>

  -c, --city <miasto>

  -N, --familyname <nazwisko>  nazwisko panieńskie

  -C, --familycity <miasto>    miasto rodzinne

  -F, --female                 kobieta

  -M, --male                   mężczyzna


Jeśli któryś z parametrów nie zostanie podany, jego wartość zostanie 
wyczyszczona w katalogu publicznym. Podanie parametru ,,-'' 
wyczyści wszystkie pola.

chat

Parametry.  <numer/alias/@grupa> <wiadomość>

Krótki opis.  wysyła wiadomość

Polecenie jest podobne do msg, ale wysyła wiadomość w ramach rozmowy, 
a nie jako pojedynczą.

check_conn

Parametry.  [alias]

Krótki opis.  sprawdza czy podana osoba jest połączona

Sprawdza czy podana osoba jest połączona. Klient tej osoby musi 
obsługiwać obrazki. Przetestowane na GG 6.x dla Windows. W przypadku 
niektórych klientów jak np. tlen komenda nie działa prawidłowo 
(osobie którą sprawdzamy pojawia się pusta wiadomość). Dzięki tej 
funkcji można sprawdzić czy osoba, którą widzimy jako niedostępna 
jest niewidoczna. Jeżeli brak aliasu jako parametr sprawdzana jest osoba,
z którą rozmowa znajduję się w aktualnym okienku.

Od wersji 7.0 nie jest możliwe sprawdzenie w ten sposób czy ktoś jest
niewidoczny. Wszystkie obrazki, a nawet tekst, do którego dołoączony jest
obrazek nie jest pokazywany użytkownikowi.

Po 15 sekundach użytkownik uznawany jest za niepołączonego. W momencie
gdy użytkownik zostanie połączony pojawi się również komunikat
informujący o tym.

connect

Parametry. 

Krótki opis.  łączy się z serwerem


dcc

Parametry.  [opcje]

Krótki opis.  obsługa bezpośrednich połączeń

  [r]send <numer/alias> <ścieżka>  wysyła podany plik

  get [numer/alias/#id]            akceptuje przysyłany plik

  resume [numer/alias/#id]         wznawia pobieranie pliku

  [r]voice <numer/alias/#id>       rozpoczyna rozmowę głosową

  close <numer/alias/#id>          zamyka połączenie

  list                             wyświetla listę połączeń


Połączenia bezpośrednie wymagają włączonej opcji dcc. 
Komendy rsend%n i %Trvoice wysyłają żądanie połączenia się 
drugiego klienta z naszym i są przydatne, gdy nie jesteśmy w stanie
się z nim sami połączyć.

disconnect

Parametry.  [powód/-]

Krótki opis.  rozłącza się od serwera

Jeśli włączona jest opcja auto_reconnect, po wywołaniu 
tej komendy, program nadal będzie próbował się automatycznie 
łączyć po określonym czasie.

find

Parametry.  [numer|opcje]

Krótki opis.  przeszukiwanie katalogu publicznego

  -u, --uin <numerek>

  -f, --first <imię>

  -l, --last <nazwisko>

  -n, --nick <pseudonim>

  -c, --city <miasto>

  -b, --born <min:max>    zakres roku urodzenia

  -a, --active            tylko dostępni

  -F, --female            kobiety

  -M, --male              mężczyźni

  -s, --start <n>         wyświetla od n-tego numeru

  -A, --all               wyświetla wszystkich

  -S, --stop              zatrzymuje wszystkie poszukiwania

image

Parametry.  <alias> <obrazek>

Krótki opis.  wysyła obrazek do podanej osoby

Obrazek zostanie wysłany jako osobna wiadomość. Klient adresata 
musi obsługiwać	obrazki.

invisible

Parametry.  [opis/-]

Krótki opis.  zmienia stan na niewidoczny

Jeżeli nie podano opisu to będzie szukany losowy opis.
Podanie ,,-'' zamiast powodu spowoduje wyczyszczenie opisu.

modify

Parametry.  <alias> <opcje>

Krótki opis.  zmienia wpisy w liście kontaktów

Opcje mogą być następujące:

  -f, --first <imię>

  -l, --last <nazwisko>

  -n, --nick <pseudonim>     pseudonim (nie jest używany)

  -d, --display <nazwa>      wyświetlana nazwa

  -u, --uin <numerek>

  -g, --group [+/-]<@grupa>  dodaje lub usuwa z grupy

                             można podać więcej grup po przecinku

  -p, --phone <numer>        numer telefonu komórkowego

  -o, --offline              bądź niedostępny dla danej osoby

  -O, --online               bądź widoczny dla danej osoby


Dwie ostatnie opcje działają tylko, gdy włączony jest tryb ,,tylko dla znajomych''.

msg

Parametry.  <numer/alias/@grupa/*> <wiadomość>

Krótki opis.  wysyła wiadomość

Można podać większą ilość odbiorców oddzielając ich numery lub pseudonimy 
przecinkiem (ale bez odstępów). Jeśli zamiast odbiorcy podany zostanie znak 
,,*'', to wiadomość będzie wysłana do wszystkich aktualnych rozmówców.

passwd

Parametry.  <hasło>

Krótki opis.  zmienia hasło użytkownika

Zmiana hasła nie wymaga już ustawienia zmiennej email.

reconnect

Parametry. 

Krótki opis.  rozłącza i łączy się ponownie


register

Parametry.  <email> <hasło> <token>

Krótki opis.  rejestruje nowe konto

Przed rejestracją należy pobrać token komendą token.

remind

Parametry.  [numer]

Krótki opis.  wysyła hasło na skrzynkę pocztową


token

Parametry. 

Krótki opis.  pobiera z serwera token

Komenda ta jest niezbędna do rejestracji i zmiany hasła. Ma na celu 
zapewnienie serwera, że operację przeprowadza użytkownik, a nie automat. 
Jeśli system zawiera odpowiednie biblioteki, token zostanie wyświetlony 
na ekranie. W przeciwnym wypadku zostanie podana ścieżka, pod którą 
zapisano plik graficzny zawierający token.

unblock

Parametry.  <numer/alias>|*

Krótki opis.  usuwa z listy blokowanych


unregister

Parametry.  <uin/alias> <hasło> <token>

Krótki opis.  usuwa konto z serwera

Podanie numeru i hasła jest niezbędne ze względów bezpieczeństwa. Nikt 
nie chciałby chyba usunąć konta przypadkowo, bez żadnego potwierdzenia. 
Przed rejestracją należy pobrać token komendą token.

userlist

Parametry.  [opcje]

Krótki opis.  lista kontaktów na serwerze

Lista kontaktów na serwerze "list [-p|-g|-c]":

  -c, --clear  usuwa listę z serwera

  -g, --get    pobiera listę z serwera

  -p, --put    umieszcza listę na serwerze

$Id: commands.txt,v 1.11 2005/12/04 12:35:01 adamm Exp $

Zmienne

dcc

Typ.  bool

Domyślna wartość.  0

włącza lub wyłącza bezpośrednie połączenia między klientami. zmiana
tej opcji wymaga ponownego połączenia z serwerem, by przesłać nowy
adres IP lub jego brak.

dcc_ip

Typ.  tekst

Domyślna wartość.  brak

określa adres IP, który jest wysyłany serwerowi. jeśli przypisze
się tej zmiennej wartość ,,auto'', adres będzie ustalany 
automatycznie. jeśli chcemy bezproblemowo łączyć się z klientami
z tej samej sieci LAN, dobrze jest podać adres IP sieci LAN zamiast
zewnętrznego.

dcc_dir

Typ.  tekst

Domyślna wartość.  brak

określa katalog, do którego będą zapisywane pobierane pliki.

dcc_limit

Typ.  tekst

Domyślna wartość.  30/30

określa limit bezpośrednich połączeń w danym przedziale czasu.
liczba przed ukośnikiem określa maksymalną ilość połączeń, a liczba
po ukośniku ilość sekund. po przekroczeniu tego progu bezpośrednie
połączenia zostają wyłączone, by zapobiec atakom polegającym na
wyczerpaniu zasobów klienta. zwykle po ponownym włączeniu
bezpośrednich połączeń należy połączyć się ponownie z serwerem.

dcc_port

Typ.  liczba

Domyślna wartość.  1550

port, na którym ekg będzie oczekiwać na połączenia bezpośrednie.

display_token

Typ.  bool

Domyślna wartość.  1

zmienna dostępna tylko gdy w systemie jest biblioteka pozwalająca
dekodować pliki JPEG. wyłączenie jej spowoduje działanie ekg tak,
jakby biblioteki nie było, tj. zapisywanie tokenów do pliku.

get_images

Typ.  bool

Domyślna wartość.  0

przy ustawionej wartości 1 jeśli w wiadomościach będą się znajdowały
obrazki to będą one ściągane i zapisywane do katalogu określonego 
przez images_dir

images_dir

Typ.  tekst

Domyślna wartość.  brak

zmienna określa katalog, do którego mają być zapisywane obrazki 
przy ustawionej zmiennej get_images

split_messages

Typ.  bool

Domyślna wartość.  0

zmienna określa co robić gdy wiadomość przekracza maksymalną długość
wiadomości. jeżeli 1 to wiadomość dzielona jest na części, jeśli 0
to wiadomość jest wysyłana niekompletna

$Id: vars.txt,v 1.6 2005/09/20 19:41:04 leafnode Exp $

Zmienne sesyjne

auto_away

Typ.  liczba

Domyślna wartość.  600

wartość określająca, po jakim czasie stan użytkownika zostanie
zmieniony na ,,zajęty''. podaje się w sekundach. jeśli równa 0,
nie będzie automatycznej zmiany.

auto_back

Typ.  liczba

Domyślna wartość.  0

wartość określająca, czy stan ma być automatycznie zmieniany na
dostępny, jeśli obecny stan ,,zajęty'' został ustawiony automatycznie.
jeśli równa 1, stan jest zmieniany na dostępny przy wysłaniu
jakiejkolwiek wiadomości. jeśli równa 2, przy wciśnięciu klawisza.

auto_connect

Typ.  bool

Domyślna wartość.  0

wartość określająca, czy dana sesja ma się łączyć wraz z uruchomieniem
programu

auto_find

Typ.  bool

Domyślna wartość.  0

określa, czy osoby, których nie mamy na liście kontaktów, a wysłały
do nas wiadomość, mają być automatycznie wyszukane w katalogu.

auto_reconnect

Typ.  liczba

Domyślna wartość.  10

w przypadku nieudanego połączenia, określa po ilu sekundach program
ma ponowić próbę. jeśli równa 0, nie próbuje więcej.

connection_save

Typ.  liczba

Domyślna wartość.  0

określa czy adres serwera ma być zapisywany

default

Typ.  bool

Domyślna wartość.  0

określa czy dana sesja ma być sesją domyślną (ustawianą jako pierwsza
podczas uruchomienia programu)

display_notify

Typ.  liczba

Domyślna wartość.  -1

wartość -1 powoduje korzystanie z globalnej zmiennej. 
wartość 0 powoduje ignorowanie zmian stanu znajomych, wartość
1 powoduje wyświetlanie wszystkich zmian, wartość 2 wyświetla
tylko zmiany z niedostępnego na dostępny i na odwrót. większy 
priorytet ma zmienna ,,contacts'', która przy wartości 2 
ukrywa zmiany stanu.

local_ip

Typ.  tekst

Domyślna wartość.  brak

określa adres IP, z którego następują wszelkiego rodzaju połączenia,
na przykład z serwerem GG. w przypadku błędnie wpisanej wartości, 
zostanie ona usunięta.

log_formats

Typ.  tekst

Domyślna wartość.  xml,simple

TODO

password

Typ.  tekst

Domyślna wartość.  brak

hasło użytkownika. niezbędne do połączenia z serwerem. automatycznie
ustawiane po udanej rejestracji, gdy wcześniej było puste.

port

Typ.  liczba

Domyślna wartość.  8074

port jakiego mamy używać przy łączeniu

proxy

Typ.  tekst

Domyślna wartość.  brak

zmienna dostępna tylko gdy w systemie jest biblioteka pozwalająca
dekodować pliki JPEG. wyłączenie jej spowoduje działanie ekg tak,
jakby biblioteki nie było, tj. zapisywanie tokenów do pliku.

proxy_forwarding

Typ.  tekst

Domyślna wartość.  brak

adres i port (oddzielone dwukropkiem) serwera pośredniczącego
(routera, proxy lub czegoś innego) przekierowany na port 1550
naszego komputera.

private

Typ.  bool

Domyślna wartość.  0

tryb tylko dla znajomych.

scroll_long_desc

Typ.  liczba

Domyślna wartość.  0

Określa co ile sekund ma nastąpić automagiczne scrollowanie
zbyt długich statusów. Zero - brak scrollowania.
OSTRZEŻENIE: używanie scrolla w statusach może doprowadzić
             do usunięcia konta użytkownika gg
UWAGA: gdy status jest scrollowany w informacji wyświetlany
       jest tylko 'obcięty' status. infromacje o zmianach
	   statusu na skutek scrollowania NIE są wyświetlane

scroll_mode

Typ.  tekst [bounce|simple]

Domyślna wartość.  bounce

określa rodzaj scrollowania
bounce - odbijanie od 'końców'
simple - przewija w lewo, aż widać do samego końca, po osiągnięciu
     końca wraca na początek

server

Typ.  tekst

Domyślna wartość.  brak

adresy IP serwerów, z którym klient powinien próbować się połączyć,
pomijając właściwą procedurę łączenia się. przydane podczas awarii
głównego serwera. adresy należy oddzielać przecinkami, średnikami
lub spacjami. po dwukropku można podać port serwera. jeśli adres i
port serwera zostaną poprzedzone tekstem ,,tls:'', klient spróbuje
wynegocjować bezpieczne połączenie TLS z serwerem. jeśli zmiennej
przypisze się wartość ,,tls'', spyta główny serwer o adres serwera
obsługującego połączenia TLS i spróbuje się z nim połączyć.