userlist.h

Idź do dokumentacji tego pliku.

/* $Id$ */

/*
 *  (C) Copyright 2001-2003 Wojtek Kaniewski <wojtekka@irc.pl>
 *              Robert J. Woźny <speedy@ziew.org>
 *
 *  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 __EKG_USERLIST_H
#define __EKG_USERLIST_H

#include "ekg2-config.h"
#include "win32.h"

#include <sys/types.h>

#ifndef NO_POSIX_SYSTEM
#include <sys/socket.h>
#include <netinet/in.h>
#endif

#include <stdio.h>
#include <stdarg.h>
#include <time.h>

#include "dynstuff.h"
#include "sessions.h"
#include "plugins.h"
#include "windows.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct userlist {
    struct userlist *next;

    const char  *uid;       
    char        *nickname;  
    struct ekg_group *groups;   
    status_t    status;     
    char        *descr;     
    char        *descr1line;    
    struct ekg_resource *resources; 
    time_t      last_seen;  
    char        *foreign;   
    void        *priv;      
    unsigned int    blink   : 1;    
    unsigned int    typing  : 1;    
    status_t    last_status;    
    char        *last_descr;    
    time_t      status_time;    
    void        *priv_data; 
    private_data_t  *priv_list; /* New user private data */
} userlist_t;

typedef enum {
    EKG_XSTATE_BLINK    = 1,
    EKG_XSTATE_TYPING   = 2
} xstate_t;

typedef enum {
    EKG_USERLIST_PRIVHANDLER_FREE       = 0,    
    EKG_USERLIST_PRIVHANDLER_GET,           
    EKG_USERLIST_PRIVHANDLER_READING,       
    EKG_USERLIST_PRIVHANDLER_WRITING,       
    EKG_USERLIST_PRIVHANDLER_SETVAR_BYNAME  = 0xC0, 
} userlist_privhandler_func_t;

typedef struct ekg_resource {
    struct ekg_resource *next;

    char        *name;      
    status_t    status;     
    char        *descr;     
    int     prio;       
    void        *priv_data; 
} ekg_resource_t;

struct ekg_group {
    struct ekg_group *next;

    char *name;     
};

typedef enum {
    IGNORE_STATUS       = 0x01,
    IGNORE_STATUS_DESCR = 0x02,
    IGNORE_MSG      = 0x04,
    IGNORE_DCC      = 0x08,
    IGNORE_EVENTS       = 0x10,
    IGNORE_NOTIFY       = 0x20,
    IGNORE_XOSD     = 0x40,
    IGNORE_LOG      = 0x80,
    
    IGNORE_ALL      = 0xFF
} ignore_t;

struct ignore_label {
    ignore_t    level;
    char        *name;
};

#define IGNORE_LABELS_MAX 9
extern struct ignore_label ignore_labels[IGNORE_LABELS_MAX];

#ifndef EKG2_WIN32_NOFUNCTION

int userlist_read(session_t* session);
void userlist_write(session_t *session);
void userlist_clear_status(session_t *session, const char *uid);
userlist_t *userlist_add(session_t *session, const char *uid, const char *nickname);
userlist_t *userlist_add_u(userlist_t **userlist, const char *uid, const char *nickname);
void userlist_add_entry(session_t *session,const char *line);
int userlist_remove(session_t *session, userlist_t *u);
int userlist_remove_u(userlist_t **userlist, userlist_t *u);
int userlist_replace(session_t *session, userlist_t *u);
userlist_t *userlist_find(session_t *session, const char *uid);
userlist_t *userlist_find_u(userlist_t **userlist, const char *uid);
#define userlist_find_n(a, b) userlist_find(session_find(a), b)
void userlist_free(session_t *session);
void userlists_destroy(userlist_t **userlist);

void *userlist_private_get(plugin_t *plugin, userlist_t *u);

/* u->resource */
ekg_resource_t *userlist_resource_add(userlist_t *u, const char *name, int prio);
ekg_resource_t *userlist_resource_find(userlist_t *u, const char *name);
void userlist_resource_remove(userlist_t *u, ekg_resource_t *r);

int ignored_add(session_t *session, const char *uid, ignore_t level);
int ignored_remove(session_t *session, const char *uid);
int ignored_check(session_t *session, const char *uid);
int ignore_flags(const char *str);
const char *ignore_format(int level);

int ekg_group_add(userlist_t *u, const char *group);
int ekg_group_remove(userlist_t *u, const char *group);
int ekg_group_member(userlist_t *u, const char *group);
char *group_to_string(struct ekg_group *l, int meta, int sep);
struct ekg_group *group_init(const char *groups);

int valid_nick(const char *nick);
int valid_plugin_uid(plugin_t *plugin, const char *uid);
const char *format_user(session_t *session, const char *uid);
const char *get_uid(session_t *session, const char *text);
const char *get_uid_any(session_t *session, const char *text);
const char *get_nickname(session_t *session, const char *text);
char *get_user_name(userlist_t *u);

#endif

#define user_private_item_get_safe(user, name, result) \
    private_item_get_safe(&(user)->priv_list, name, result)
#define user_private_item_get(user, name) \
    private_item_get(&(user)->priv_list, name)
#define user_private_item_get_int_safe(user, name, result) \
    private_item_get_int_safe(&(user)->priv_list), name, int *result)
#define user_private_item_get_int(user, name) \
    private_item_get_int(&(user)->priv_list, name)
#define user_private_item_set(user, name, value) \
    private_item_set(&(user)->priv_list, name, value)
#define user_private_item_set_int(user, name, value) \
    private_item_set_int(&(user)->priv_list, name, value)

#define user_private_items_destroy(user) \
    private_items_destroy(&(user)->priv_list);

#ifdef __cplusplus
}
#endif

#endif /* __EKG_USERLIST_H */

/*
 * Local Variables:
 * mode: c
 * c-file-style: "k&r"
 * c-basic-offset: 8
 * indent-tabs-mode: t
 * End:
 */