src/protocols/gg/libgg.h

/* $Id: libgg.h 2805 2001-11-26 21:22:56Z warmenhoven $ */

/*
 *  (C) Copyright 2001 Wojtek Kaniewski <wojtekka@irc.pl>,
 *                     Robert J. Woźny <speedy@atman.pl>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License Version 2 as
 *  published by the Free Software Foundation.
 *
 *  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 General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#ifndef __LIBGG_H
#define __LIBGG_H

#ifdef __cplusplus
extern "C" {
#endif

#if defined(sun) && !defined(INADDR_NONE)
#define INADDR_NONE 0xffffffff
#endif

#include <sys/types.h>

/*
 * typ zmiennej określającej numerek danej osoby.
 */
	typedef unsigned long uin_t;

/*
 * cośtam.
 */
	struct gg_session {
		int state, check;
		int fd, pid;
		int port;
		int seq, async;
		int last_pong;

		/* powinno być ,,in_addr'', ale nie chcę inkludować sieci tutaj */
		unsigned long server_ip;

		uin_t uin;
		char *password;
		int initial_status;

		char *recv_buf;
		int recv_done, recv_left;
	};

/*
 * różne stany asynchronicznej maszynki.
 */
	enum {
		GG_STATE_IDLE = 0,	/* wspólne */
		GG_STATE_RESOLVING,
		GG_STATE_CONNECTING_HTTP,

		GG_STATE_WRITING_HTTP,	/* gg_login */
		GG_STATE_CONNECTING_GG,
		GG_STATE_WAITING_FOR_KEY,
		GG_STATE_SENDING_KEY,
		GG_STATE_CONNECTED,

		GG_STATE_READING_HEADER,	/* gg_search */
		GG_STATE_READING_DATA,
		GG_STATE_PARSING,
		GG_STATE_FINISHED,
	};

/*
 * co proces klienta powinien sprawdzać w deskryptorach?
 */
	enum {
		GG_CHECK_NONE = 0,
		GG_CHECK_WRITE = 1,
		GG_CHECK_READ = 2,
	};

	struct gg_session *gg_login(uin_t uin, char *password, int async);
	void gg_free_session(struct gg_session *sess);
	void gg_logoff(struct gg_session *sess);
	int gg_change_status(struct gg_session *sess, int status);
	int gg_send_message(struct gg_session *sess, int msgclass, uin_t recipient,
			    unsigned char *message);
	int gg_ping(struct gg_session *sess);

	struct gg_notify_reply {
		uin_t uin;	/* numerek */
		unsigned long status;	/* status danej osoby */
		unsigned long remote_ip;	/* adres ip delikwenta */
		unsigned short remote_port;	/* port, na którym słucha klient */
		unsigned long dunno1;	/* == 0x0b */
		unsigned short dunno2;	/* znowu port? */
	} __attribute__ ((packed));

	struct gg_status {
		uin_t uin;	/* numerek */
		unsigned long status;	/* nowy stan */
	} __attribute__ ((packed));

	enum {
		GG_EVENT_NONE = 0,
		GG_EVENT_MSG,
		GG_EVENT_NOTIFY,
		GG_EVENT_STATUS,
		GG_EVENT_ACK,
		GG_EVENT_CONN_FAILED,
		GG_EVENT_CONN_SUCCESS,
	};

	enum {
		GG_FAILURE_RESOLVING = 1,
		GG_FAILURE_CONNECTING,
		GG_FAILURE_INVALID,
		GG_FAILURE_READING,
		GG_FAILURE_WRITING,
		GG_FAILURE_PASSWORD,
	};

	struct gg_event {
		int type;
		union {
			struct {
				uin_t sender;
				int msgclass;
				time_t time;
				unsigned char *message;
			} msg;
			struct gg_notify_reply *notify;
			struct gg_status status;
			struct {
				uin_t recipient;
				int status;
				int seq;
			} ack;
			int failure;
		} event;
	};

	struct gg_event *gg_watch_fd(struct gg_session *sess);
	void gg_free_event(struct gg_event *e);

	int gg_notify(struct gg_session *sess, uin_t * userlist, int count);
	int gg_add_notify(struct gg_session *sess, uin_t uin);
	int gg_remove_notify(struct gg_session *sess, uin_t uin);

/*
 * jakieśtam bzdurki dotyczące szukania userów.
 */

	struct gg_search_result {
		uin_t uin;
		char *first_name;
		char *last_name;
		char *nickname;
		int born;
		int gender;
		char *city;
		int active;
	};

	struct gg_search_request {
		/* czy ma szukać tylko aktywnych? */
		int active;
		/* mode 0 */
		char *nickname, *first_name, *last_name, *city;
		int gender, min_birth, max_birth;
		/* mode 1 */
		char *email;
		/* mode 2 */
		char *phone;
		/* mode 3 */
		uin_t uin;
	};

	struct gg_search {
		struct gg_search_request request;

		/* bzdurki */
		int mode, fd, async, state, check, error, pid;
		char *header_buf, *data_buf;
		int header_size, data_size;

		/* wyniki */
		int count;
		struct gg_search_result *results;
	};

#define GG_GENDER_NONE 0
#define GG_GENDER_FEMALE 1
#define GG_GENDER_MALE 2

	struct gg_search *gg_search(struct gg_search_request *r, int async);
	int gg_search_watch_fd(struct gg_search *f);
	void gg_free_search(struct gg_search *f);
	void gg_search_cancel(struct gg_search *f);

/*
 * jeśli chcemy sobie podebugować, wystarczy ustawić `gg_debug_level'.
 * niestety w miarę przybywania wpisów `gg_debug(...)' nie chciało mi
 * się ustawiać odpowiednich leveli, więc większość szła do _MISC.
 */

	extern int gg_debug_level;

#define GG_DEBUG_NET 1
#define GG_DEBUG_TRAFFIC 2
#define GG_DEBUG_DUMP 4
#define GG_DEBUG_FUNCTION 8
#define GG_DEBUG_MISC 16

	void gg_debug(int level, char *format, ...);

/*
 * -------------------------------------------------------------------------
 * poniżej znajdują się wewnętrzne sprawy biblioteki. zwykły klient nie
 * powinien ich w ogóle ruszać, bo i nie ma po co. wszystko można załatwić
 * procedurami wyższego poziomu, których definicje znajdują się na początku
 * tego pliku.
 * -------------------------------------------------------------------------
 */

	int gg_resolve(int *fd, int *pid, char *hostname);
	int gg_connect(void *addr, int port, int async);
	char *gg_alloc_sprintf(char *format, ...);
	char *gg_get_line(char **ptr);
	char *gg_urlencode(char *str);

#define GG_APPMSG_HOST "appmsg.gadu-gadu.pl"
#define GG_APPMSG_PORT 80
#define GG_PUBDIR_HOST "pubdir.gadu-gadu.pl"
#define GG_PUBDIR_PORT 80
#define GG_DEFAULT_PORT 8074
#define GG_HTTPS_PORT 443
#define GG_HTTP_USERAGENT "Mozilla/4.7 [en] (Win98; I)"

	struct gg_header {
		unsigned long type;	/* typ pakietu */
		unsigned long length;	/* długość reszty pakietu */
	} __attribute__ ((packed));

#define GG_WELCOME 0x0001

	struct gg_welcome {
		unsigned long key;	/* klucz szyfrowania hasła */
	} __attribute__ ((packed));

#define GG_LOGIN 0x000c

	struct gg_login {
		uin_t uin;	/* twój numerek */
		unsigned long hash;	/* hash hasła */
		unsigned long status;	/* status na dzień dobry */
		unsigned long dunno;	/* == 0x0b */
		unsigned long local_ip;	/* mój adres ip */
		unsigned short local_port;	/* port, na którym słucham */
	} __attribute__ ((packed));

#define GG_LOGIN_OK 0x0003

#define GG_LOGIN_FAILED 0x0009

#define GG_NEW_STATUS 0x0002

#define GG_STATUS_NOT_AVAIL 0x0001	/* rozłączony */
#define GG_STATUS_AVAIL 0x0002	/* dostępny */
#define GG_STATUS_BUSY 0x0003	/* zajęty */
#define GG_STATUS_INVISIBLE 0x0014	/* niewidoczny (GG 4.6) */

#define GG_STATUS_FRIENDS_MASK 0x8000	/* tylko dla znajomych (GG 4.6) */

	struct gg_new_status {
		unsigned long status;	/* na jaki zmienić? */
	} __attribute__ ((packed));

#define GG_NOTIFY 0x0010

	struct gg_notify {
		uin_t uin;	/* numerek danej osoby */
		char dunno1;	/* == 3 */
	} __attribute__ ((packed));

#define GG_NOTIFY_REPLY 0x000c	/* tak, to samo co GG_LOGIN */

/* struct gg_notify_reply zadeklarowane wyżej */

#define GG_ADD_NOTIFY 0x000d
#define GG_REMOVE_NOTIFY 0x000e

	struct gg_add_remove {
		uin_t uin;	/* numerek */
		char dunno1;	/* == 3 */
	} __attribute__ ((packed));

#define GG_STATUS 0x0002

/* struct gg_status zadeklarowane wcześniej */

#define GG_SEND_MSG 0x000b

#define GG_CLASS_QUEUED 0x0001
#define GG_CLASS_OFFLINE GG_CLASS_QUEUED
#define GG_CLASS_MSG 0x0004
#define GG_CLASS_CHAT 0x0008

	struct gg_send_msg {
		unsigned long recipient;
		unsigned long seq;
		unsigned long msgclass;
	} __attribute__ ((packed));

#define GG_SEND_MSG_ACK 0x0005

#define GG_ACK_DELIVERED 0x0002
#define GG_ACK_QUEUED 0x0003

	struct gg_send_msg_ack {
		unsigned long status;
		unsigned long recipient;
		unsigned long seq;
	} __attribute__ ((packed));

#define GG_RECV_MSG 0x000a

	struct gg_recv_msg {
		unsigned long sender;
		unsigned long seq;
		unsigned long time;
		unsigned long msgclass;
	} __attribute__ ((packed));

#define GG_PING 0x0008

#define GG_PONG 0x0007

#ifdef __cplusplus
}
#endif
#endif