source: protocols/yahoo/yahoo2_types.h @ 3650088

/*
 * libyahoo2: yahoo2_types.h
 *
 * Copyright (C) 2002-2004, Philip S Tellis <philip.tellis AT gmx.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#ifndef YAHOO2_TYPES_H
#define YAHOO2_TYPES_H

#include "yahoo_list.h"

#ifdef __cplusplus
extern "C" {
#endif

enum yahoo_status {
        YAHOO_STATUS_DISCONNECTED = -1,
        YAHOO_STATUS_AVAILABLE = 0,
        YAHOO_STATUS_BRB,
        YAHOO_STATUS_BUSY,
        YAHOO_STATUS_NOTATHOME,
        YAHOO_STATUS_NOTATDESK,
        YAHOO_STATUS_NOTINOFFICE,
        YAHOO_STATUS_ONPHONE,
        YAHOO_STATUS_ONVACATION,
        YAHOO_STATUS_OUTTOLUNCH,
        YAHOO_STATUS_STEPPEDOUT,
        YAHOO_STATUS_INVISIBLE = 12,
        YAHOO_STATUS_CUSTOM = 99,
        YAHOO_STATUS_IDLE = 999,
        YAHOO_STATUS_WEBLOGIN = 0x5a55aa55,
        YAHOO_STATUS_OFFLINE = 0x5a55aa56, /* don't ask */
        YAHOO_STATUS_NOTIFY = 0x16 /* TYPING */
};
#define YAHOO_STATUS_GAME       0x2             /* Games don't fit into the regular status model */

enum yahoo_login_status {
        YAHOO_LOGIN_OK = 0,
        YAHOO_LOGIN_LOGOFF = 2,
        YAHOO_LOGIN_UNAME = 3,
        YAHOO_LOGIN_PASSWD = 13,
        YAHOO_LOGIN_LOCK = 14,
        YAHOO_LOGIN_DUPL = 99,
        YAHOO_LOGIN_SOCK = -1,
};

enum ypacket_status {
        YPACKET_STATUS_DISCONNECTED = -1,
        YPACKET_STATUS_DEFAULT = 0,
        YPACKET_STATUS_SERVERACK = 1,
        YPACKET_STATUS_GAME     = 0x2,
        YPACKET_STATUS_AWAY     = 0x4,
        YPACKET_STATUS_CONTINUED = 0x5,
        YPACKET_STATUS_INVISIBLE = 12,
        YPACKET_STATUS_NOTIFY = 0x16, /* TYPING */
        YPACKET_STATUS_WEBLOGIN = 0x5a55aa55,
        YPACKET_STATUS_OFFLINE = 0x5a55aa56
};

enum yahoo_error {
        E_UNKNOWN = -1,
        E_CONNECTION = -2,
        E_SYSTEM = -3,
        E_CUSTOM = 0,

        /* responses from ignore buddy */
        E_IGNOREDUP = 2,
        E_IGNORENONE = 3,
        E_IGNORECONF = 12,
        
        /* conference */
        E_CONFNOTAVAIL = 20
};

enum yahoo_log_level {
        YAHOO_LOG_NONE = 0,
        YAHOO_LOG_FATAL,
        YAHOO_LOG_ERR,
        YAHOO_LOG_WARNING,
        YAHOO_LOG_NOTICE,
        YAHOO_LOG_INFO,
        YAHOO_LOG_DEBUG
};

#define YAHOO_PROTO_VER 0x0010

/* Yahoo style/color directives */
#define YAHOO_COLOR_BLACK "\033[30m"
#define YAHOO_COLOR_BLUE "\033[31m"
#define YAHOO_COLOR_LIGHTBLUE "\033[32m"
#define YAHOO_COLOR_GRAY "\033[33m"
#define YAHOO_COLOR_GREEN "\033[34m"
#define YAHOO_COLOR_PINK "\033[35m"
#define YAHOO_COLOR_PURPLE "\033[36m"
#define YAHOO_COLOR_ORANGE "\033[37m"
#define YAHOO_COLOR_RED "\033[38m"
#define YAHOO_COLOR_OLIVE "\033[39m"
#define YAHOO_COLOR_ANY "\033[#"
#define YAHOO_STYLE_ITALICON "\033[2m"
#define YAHOO_STYLE_ITALICOFF "\033[x2m"
#define YAHOO_STYLE_BOLDON "\033[1m"
#define YAHOO_STYLE_BOLDOFF "\033[x1m"
#define YAHOO_STYLE_UNDERLINEON "\033[4m"
#define YAHOO_STYLE_UNDERLINEOFF "\033[x4m"
#define YAHOO_STYLE_URLON "\033[lm"
#define YAHOO_STYLE_URLOFF "\033[xlm"

enum yahoo_connection_type {
        YAHOO_CONNECTION_PAGER=0,
        YAHOO_CONNECTION_FT,
        YAHOO_CONNECTION_YAB,
        YAHOO_CONNECTION_WEBCAM_MASTER,
        YAHOO_CONNECTION_WEBCAM,
        YAHOO_CONNECTION_CHATCAT,
        YAHOO_CONNECTION_SEARCH,
        YAHOO_CONNECTION_AUTH,
};

enum yahoo_webcam_direction_type {
        YAHOO_WEBCAM_DOWNLOAD=0,
        YAHOO_WEBCAM_UPLOAD
};

enum yahoo_stealth_visibility_type {
        YAHOO_STEALTH_DEFAULT = 0,
        YAHOO_STEALTH_ONLINE,
        YAHOO_STEALTH_PERM_OFFLINE
};

/* chat member attribs */
#define YAHOO_CHAT_MALE 0x8000
#define YAHOO_CHAT_FEMALE 0x10000
#define YAHOO_CHAT_DUNNO 0x400
#define YAHOO_CHAT_WEBCAM 0x10

enum yahoo_webcam_conn_type { Y_WCM_DIALUP, Y_WCM_DSL, Y_WCM_T1 };

struct yahoo_webcam {
        int direction;     /* Uploading or downloading */
        int conn_type;     /* 0=Dialup, 1=DSL/Cable, 2=T1/Lan */

        char *user;        /* user we are viewing */
        char *server;      /* webcam server to connect to */
        int   port;        /* webcam port to connect on */
        char *key;         /* key to connect to the server with */
        char *description; /* webcam description */
        char *my_ip;       /* own ip number */
};

struct yahoo_webcam_data {
        unsigned int data_size;
        unsigned int to_read;
        unsigned int timestamp;
        unsigned char packet_type;
};

struct yahoo_data {
        char  *user;
        char  *password;

        char  *cookie_y;
        char  *cookie_t;
        char  *cookie_c;
        char  *login_cookie;

        YList *buddies;
        YList *ignore;
        YList *identities;
        char  *login_id;

        int   current_status;
        int   initial_status;
        int   logged_in;

        int   session_id;

        int   client_id;

        char  *rawbuddylist;
        char  *ignorelist;

        void  *server_settings;
};

struct yab {
        char *id;
        char *fname;
        char *lname;
        char *nname;
        char *email;
        char *hphone;
        char *wphone;
        char *mphone;
        int  dbid;
};

struct yahoo_buddy {
        char *group;
        char *id;
        char *real_name;
        struct yab *yab_entry;
};

enum yahoo_search_type {
        YAHOO_SEARCH_KEYWORD = 0,
        YAHOO_SEARCH_YID,
        YAHOO_SEARCH_NAME
};

enum yahoo_search_gender {
        YAHOO_GENDER_NONE = 0,
        YAHOO_GENDER_MALE,
        YAHOO_GENDER_FEMALE
};

enum yahoo_search_agerange {
        YAHOO_AGERANGE_NONE = 0
};

struct yahoo_found_contact {
        char *id;
        char *gender;
        char *location;
        int age;
        int online;
};

/*
 * Function pointer to be passed to http get/post and send file
 */
typedef void (*yahoo_get_fd_callback)(int id, int fd, int error, void *data);

/*
 * Function pointer to be passed to yahoo_get_url_handle
 */
typedef void (*yahoo_get_url_handle_callback)(int id, int fd, int error,
                const char *filename, unsigned long size, void *data);


struct yahoo_chat_member {
        char *id;
        int  age;
        int  attribs;
        char *alias;
        char *location;
};

#ifdef __cplusplus
}
#endif

#endif