Net::Gadu - Interfejs do biblioteki libgadu.so dla protokołu komunikatora Gadu-Gadu

Net-Gadu documentation Contained in the Net-Gadu distribution.

Index

Code Index:

NAME

Top

Net::Gadu - Interfejs do biblioteki libgadu.so dla protokołu komunikatora Gadu-Gadu

DESCRIPTION

Top

Wykorzystuje bibliotekę libgadu.so która jest częścią projektu EKG. Szczegółowe informacje na temat instalacji biblioteki Libgadu znajdziesz na stronie projektu EKG - http://ekg.chmurka.net/ .Do zbudowania pakietu Net::Gadu potrzebna jest zainstalowana w systemie biblioteka Libgadu.

     Jeżeli biblioteka Libgadu została zainstalowana w niestandardowym miejscu w systemie należy wyedytowac plik Makefile.PL podając właściwą lokalizację.

DOWNLOAD

Top

http://www.cpan.org/modules/by-module/Net/Net-Gadu-1.9.tar.gz

SUBVERSION

Top

$ svn co http://svn.hakore.com/netgadu/

METHODS

Top

Dostepne metody :

$gg = new Net::Gadu()
    opcjonalny parametr :
    async => 1 lub 0   (komunikacja asynchroniczna lub nie)
    server => "91.197.13.211"  (alternatywne IP serwera Gadu-Gadu. Nie ustawiaj jezeli nie wiesz co to oznacza)
$gg->login($uin, $password, $initial_status);

Polaczenie z serwerem oraz logowanie do serwera. Pamietaj aby zaraz po polaczeniu wykonac $gg->notify();

    parametry:
    $uin = numer Gadu-Gadu
    $password = haslo
    $initial_status = status ustawiany po polaczeniu (opcjonalny)
$gg->logoff();

Wylogowanie z serwera i zakończenie sesji.

$gg->send_message($receiver_uin, $message);

Wysyła wiadomość pod wskazany numer UIN.

$gg->send_message_chat($receiver_uin, $message);

Wysyła wiadomość pod wskazany numer UIN.

$gg->set_available();

Ustawia status na dostepny. Podobne funkcje : set_busy(), set_invisible(), set_not_available(), change_status().

$gg->add_notify($uin)
    parametry:
    $uin = numer Gadu-Gady który chcemy obserwować.

Możesz użyć tej funkcji w celu poinformowania serwera, że chcesz znać status danej osoby i otrzymywać zdarzenia zwiazane ze zmianą statusu. Od tego momentu zaczynają nadchodzić z serwera zdarzenia EVENT_NOTIFY, EVENT_NOTIFY60 zawsze gdy ktoś się pojawi oraz EVENT_STATUS,EVENT_STATUS60 gdy ktoś zmieni status (patrz opis get_event())

$gg->remove_notify($uin)

Możesz użyć tej funkcji w celu poinformowania serwera, że nie chcesz otrzymywać zdarzeń związanych ze zmianą statusu od tej osoby.

    parametry:
    $uin = numer Gadu-Gadu
$gg->change_status($status);

Zmiana statusu możliwa jest na jeden z:

    $Net::Gadu::STATUS_NOT_AVAIL
    $Net::Gadu::STATUS_AVAIL
    $Net::Gadu::STATUS_BUSY
    $Net::Gadu::STATUS_INVISIBLE
$gg->change_status_descr($status, $descr);
    parametry:
    $status = nowy status
    $descr  = tekst opisu

Zmiana statusu z opisem możliwa na jeden z:

    $Net::Gadu::STATUS_NOT_AVAIL_DESCR
    $Net::Gadu::STATUS_AVAIL_DESCR
    $Net::Gadu::STATUS_BUSY_DESCR
    $Net::Gadu::STATUS_INVISIBLE_DESCR
$gg->search($uin,$nickname,$first_name,$last_name,$city,$gender,$active)

Wyszukiwanie, jesli parametr ma wartość "", czyli pustą wtedy to pole nie jest brane pod uwagę podczas wyszukiwania. Zwracana jest tablica ze szczegołowymi informacjami.

Odpowiedź należy odebrać po otrzymaniu zdarzenia $Net::Gadu::EVENT_SEARCH_REPLY. Przykładowe użycie oraz wynik znajdują się w przykładowym programie "ex/ex1" dostarczanym wraz ze źródłami.

    Uwaga:
    $gender = "male" lub "female" lub "none")
    $active = 1 lub 0
$gg->check_event()
    Sprawdza czy zaszlo jakies zdarzenie (szczegolnie istotne przydatne przy polaczeniu asynchronicznym)
$gg->get_event()
    Zwraca informacje o zdarzeniu ktore mialo miejsce, zwracany jest hasz np :
	$e = $gg_event();

    $e->{type} zawiera kod ostatniego zdarzenia

	$Net::Gadu::EVENT_MSG
	        $e->{message}  # tresc wiadomosci
		$e->{sender}   # uin wysylajacego
		$e->{msgclass}    # typ wiadomosci

	$Net::Gadu::EVENT_ACK	    # potwierdzenie wyslania wiadomosci
	        $e->{recipient}
		$e->{status}
		$e->{seq}

	$Net::Gadu::EVENT_STATUS    # zmiana statusu (wersja klienta Gadu-Gadu < 6.0)
	        $e->{uin}
		$e->{status}
		$e->{descr}

	$Net::Gadu::EVENT_STATUS60    # zmiana statusu (wersja klienta Gadu-Gadu >= 6.0)
	        $e->{uin}
		$e->{status}
		$e->{descr}

	$Net::Gadu::EVENT_NOTIFY    # informacja o pojawieniu sie kogos (wersja klienta Gadu-Gadu < 6.0)
	        $e->{uin}
		$e->{status}

	$Net::Gadu::EVENT_NOTIFY_DESCR    # informajca o pojawieniu sie kogos, z opisem (wersja klienta Gadu-Gadu < 6.0)
	        $e->{uin}
		$e->{status}
		$e->{descr}

	$Net::Gadu::EVENT_NOTIFY60    # informacja o pojawieniu sie kogos (wersja klienta Gadu-Gadu >= 6.0)
	        $e->{uin}
		$e->{status}
		$e->{descr}

	$Net::Gadu::EVENT_SEARCH_REPLY
		$e->{results}

    Dostepne kody zdarzen :

    $Net::Gadu::EVENT_NONE
    $Net::Gadu::EVENT_MSG
    $Net::Gadu::EVENT_NOTIFY
    $Net::Gadu::EVENT_NOTIFY_DESCR
    $Net::Gadu::EVENT_NOTIFY60
    $Net::Gadu::EVENT_STATUS
    $Net::Gadu::EVENT_STATUS60
    $Net::Gadu::EVENT_ACK
    $Net::Gadu::EVENT_PONG
    $Net::Gadu::EVENT_CONN_FAILED
    $Net::Gadu::EVENT_CONN_SUCCESS 
    $Net::Gadu::EVENT_DISCONNECT
    $Net::Gadu::EVENT_SEARCH_REPLY
    $Net::Gadu::$EVENT_XML_EVENT
    $Net::Gadu::$EVENT_WELCOME

EXAMPLES

Top

    #!/usr/bin/perl

    use Net::Gadu; 
    use Data::Dumper;

    my $gg = new Net::Gadu(async => 1);

    $gg->login("1234567", "password", $Net::Gadu::STATUS_BUSY) or die "Login error\n";

    #main loop. In this example, after successful login change status, send message and logout
    while (1) {

	while ($gg->check_event() == 1) {

	    my $e = $gg->get_event();
	    my $type = $e->{type};

    	    if ($type == $Net::Gadu::EVENT_CONN_FAILED) {
		die "Connection failed";
	    }

	    if ($type == $Net::Gadu::EVENT_NOTIFY60) {
		print "EVENT_NOTIFY60 from ".$e->{uin}."\n" ;
	    }

	    if ($type == $Net::Gadu::EVENT_STATUS60) {
		print "EVENT_STATUS60 from ".$e->{uin}.", status ".$e->{status}."\n" ;
	    }

	    if ($type == $Net::Gadu::EVENT_DISCONNECT) {
		die "disconnect";
	    }

	    if ($type == $Net::Gadu::EVENT_CONN_SUCCESS) {
		print "CONNECTED\n";

		#it have to be sent after connect success
		$gg->notify();

		# notify server that you want to receive status notifications
		$gg->add_notify("42112");

		# Send THANKS to author
		$gg->send_message_chat("42112","dziekuje za Net::Gadu");

		# SEARCH INIT
		$gg->search("","krzak","","","","male",0);
	    }

	    if ($type == $Net::Gadu::EVENT_MSG) {
		print $e->{message}." ".$e->{sender}."\n";
	    }

	    if ($type == $Net::Gadu::EVENT_SEARCH_REPLY) {
		# SEARCH RESULT
		print Dumper($e->{results});
		#$gg->logoff();
		#exit(1);
	    }

	    if ($type == $Net::Gadu::EVENT_ACK) {
		print "EVENT_ACK\n";
	    }
    }
}

AUTHOR

Top

Marcin Krzyżanowski, http://www.hakore.com/

LICENCE

Top

Lesser General Public License v. 2

SEE ALSO

Top

    http://www.gadu-gadu.pl/
    http://ekg.chmurka.net/
    http://www.gnugadu.org/
    http://www.hakore.com/
Net-Gadu documentation Contained in the Net-Gadu distribution. 
#
# Net::Gadu 
# 
# Copyright (C) 2002-2008 Marcin Krzyżanowski
# http://www.hakore.com
# 
# This program is free software; you can redistribute it and/or modify 
# it under the terms of the GNU Lesser General Public License as published by 
# the Free Software Foundation; either version 2 of the License 
# 
# This program is distributed in the hope that it will be useful, 
# but WITHOUT ANY WARRANTY; without even the implied warranty of 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
# GNU General Public License for more details. 
# 
# You should have received a copy of the GNU Lesser General Public License 
# along with this program; if not, write to the Free Software 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 

package Net::Gadu;

use 5.006;
use warnings;
use Socket;
use strict;

require Exporter;
require DynaLoader;
use AutoLoader qw(AUTOLOAD);

our @ISA = qw(Exporter DynaLoader);
our %EXPORT_TAGS = ( 'all' => [ qw() ] );

our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );

our @EXPORT = qw(
	
);

our $VERSION = '1.9';


our $EVENT_NONE = 0;
our $EVENT_MSG = 1;
our $EVENT_NOTIFY = 2;
our $EVENT_NOTIFY_DESCR = 3;
our $EVENT_STATUS = 4;
our $EVENT_ACK = 5;
our $EVENT_PONG = 6; 
our $EVENT_CONN_FAILED = 7;
our $EVENT_CONN_SUCCESS = 8;
our $EVENT_DISCONNECT = 9;
our $EVENT_SEARCH_REPLY = 19;
our $EVENT_STATUS60 = 22;
our $EVENT_NOTIFY60 = 23;
our $EVENT_USERLIST = 24;
our $EVENT_XML_EVENT = 35;
our $EVENT_WELCOME = 0x0001;

our $STATUS_NOT_AVAIL = 0x0001;	
our $STATUS_NOT_AVAIL_DESCR = 0x0015;
our $STATUS_AVAIL = 0x0002;
our $STATUS_AVAIL_DESCR = 0x0004;
our $STATUS_BUSY = 0x0003;
our $STATUS_BUSY_DESCR = 0x0005;
our $STATUS_INVISIBLE = 0x0014;
our $STATUS_INVISIBLE_DESCR = 0x0016;
our $STATUS_BLOCKED = 0x0006;

our $STATUS_FRIENDS_MASK = 0x8000;

bootstrap Net::Gadu $VERSION;


sub new {
    my ($c, %args) = @_;
    my $class = ref($c) || $c;
    if (!exists($args{async})) { 
	$args{async} = 1; 
    }
    if (!exists($args{server})) { 
	$args{server} = "0.0.0.0"; #appmsg.gadu-gadu.pl
    }
    bless \%args, $class;
}

sub set_server {
    my ($cl,$server) = @_;
    $cl->{server} = $server;
}

sub search {
    my ($cl,$uin,$nickname,$first_name,$last_name,$city,$gender,$active) = @_;
    my %gd = ("male" => 2, "female" => 1, "none" => 0);
    return Net::Gadu::gg_search($cl->{session},$uin,$nickname,$first_name,$last_name,$city,$gd{$gender},$active);
}

sub login {
    my ($cl,$uin,$password,$initial_status) = @_;
    $cl->{uin} = $uin;
    $cl->{password} = $password;
    $cl->{session} = Net::Gadu::gg_login($cl->{uin},$cl->{password},$cl->{async}, $cl->{server}, $initial_status ? $initial_status : $STATUS_AVAIL);
    return $cl->{session};
}

sub get_event {
    my $cl = shift;
    return Net::Gadu::gg_get_event($cl->{session});
}

sub check_event {
    my $cl = shift;
    return Net::Gadu::gg_check_event($cl->{session});
}

sub ping {
    my $cl = shift;
    return Net::Gadu::gg_ping($cl->{session});
}

sub logoff {
    my $cl = shift;
    Net::Gadu::gg_logoff($cl->{session}) if ($cl->{session});
    Net::Gadu::gg_free_session($cl->{session}) if ($cl->{session});
}

sub send_message {
    my ($cl,$receiver,$message) = @_;
    return Net::Gadu::gg_send_message($cl->{session},0x0004,$receiver,$message);
}

sub send_message_chat {
    my ($cl,$receiver,$message) = @_;
    return Net::Gadu::gg_send_message($cl->{session},0x0008,$receiver,$message);
}

sub change_status {
    my ($cl,$status) = @_;
    return Net::Gadu::gg_change_status($cl->{session},$status);
}

sub change_status_descr {
    my ($cl,$status,$descr) = @_;
    return Net::Gadu::gg_change_status_descr($cl->{session},$status,$descr);
}

sub set_available {
    my ($cl) = @_;
    $cl->change_status($Net::Gadu::STATUS_AVAIL); # GG_STATUS_AVAIL
}

sub set_busy {
    my ($cl) = @_;
    $cl->change_status($Net::Gadu::STATUS_BUSY); # GG_STATUS_BUSY
}

sub set_not_available {
    my ($cl) = @_;
    $cl->change_status($Net::Gadu::STATUS_NOT_AVAIL); # GG_STATUS_NOT_AVAIL
}

sub set_invisible {
    my ($cl,$status) = @_;
    $cl->change_status($Net::Gadu::STATUS_INVISIBLE); # GG_STATUS_INVISIBLE
}

sub notify {
    my ($cl) = @_;
    return Net::Gadu::gg_notify($cl->{session});
}

sub add_notify {
    my ($cl,$uin) = @_;
    return Net::Gadu::gg_add_notify($cl->{session},$uin);
}

sub remove_notify {
    my ($cl,$uin) = @_;
    return Net::Gadu::gg_remove_notify($cl->{session},$uin);
}

1;

######################################################

__END__