log.h

Go to the documentation of this file.

 
/* purple
 *
 * Purple is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 */
#ifndef _PURPLE_LOG_H_
#define _PURPLE_LOG_H_
 
#include <stdio.h>
 
 
/********************************************************
 * DATA STRUCTURES **************************************
 ********************************************************/
 
typedef struct _PurpleLog PurpleLog;
typedef struct _PurpleLogLogger PurpleLogLogger;
typedef struct _PurpleLogCommonLoggerData PurpleLogCommonLoggerData;
typedef struct _PurpleLogSet PurpleLogSet;
 
typedef enum {
    PURPLE_LOG_IM,
    PURPLE_LOG_CHAT,
    PURPLE_LOG_SYSTEM
} PurpleLogType;
 
typedef enum {
    PURPLE_LOG_READ_NO_NEWLINE = 1
} PurpleLogReadFlags;
 
#include "account.h"
#include "conversation.h"
 
typedef void (*PurpleLogSetCallback) (GHashTable *sets, PurpleLogSet *set);
 
struct _PurpleLogLogger {
    char *name;               
    char *id;                 
    void (*create)(PurpleLog *log);
 
    gsize (*write)(PurpleLog *log,
             PurpleMessageFlags type,
             const char *from,
             time_t time,
             const char *message);
 
    void (*finalize)(PurpleLog *log);
 
    GList *(*list)(PurpleLogType type, const char *name, PurpleAccount *account);
 
    char *(*read)(PurpleLog *log, PurpleLogReadFlags *flags);
 
    int (*size)(PurpleLog *log);
 
    int (*total_size)(PurpleLogType type, const char *name, PurpleAccount *account);
 
    GList *(*list_syslog)(PurpleAccount *account);
 
    void (*get_log_sets)(PurpleLogSetCallback cb, GHashTable *sets);
 
    /* Attempts to delete the specified log, indicating success or failure */
    gboolean (*remove)(PurpleLog *log);
 
    /* Tests whether a log is deletable */
    gboolean (*is_deletable)(PurpleLog *log);
 
    void (*_purple_reserved1)(void);
    void (*_purple_reserved2)(void);
    void (*_purple_reserved3)(void);
    void (*_purple_reserved4)(void);
};
 
struct _PurpleLog {
    PurpleLogType type;                     
    char *name;                           
    PurpleAccount *account;                 
    PurpleConversation *conv;               
    time_t time;                          
    PurpleLogLogger *logger;                
    void *logger_data;                    
    struct tm *tm;                        
    /* IMPORTANT: Some code in log.c allocates these without zeroing them.
     * IMPORTANT: Update that code if you add members here. */
};
 
struct _PurpleLogCommonLoggerData {
    char *path;
    FILE *file;
    void *extra_data;
};
 
struct _PurpleLogSet {
    PurpleLogType type;                     
    char *name;                           
    PurpleAccount *account;                 
    gboolean buddy;                       
    char *normalized_name;                
    /* IMPORTANT: Some code in log.c allocates these without zeroing them.
     * IMPORTANT: Update that code if you add members here. */
};
 
#ifdef __cplusplus
extern "C" {
#endif
 
/***************************************/
/***************************************/
PurpleLog *purple_log_new(PurpleLogType type, const char *name, PurpleAccount *account,
                      PurpleConversation *conv, time_t time, const struct tm *tm);
 
void purple_log_free(PurpleLog *log);
 
void purple_log_write(PurpleLog *log,
            PurpleMessageFlags type,
            const char *from,
            time_t time,
            const char *message);
 
char *purple_log_read(PurpleLog *log, PurpleLogReadFlags *flags);
 
GList *purple_log_get_logs(PurpleLogType type, const char *name, PurpleAccount *account);
 
GHashTable *purple_log_get_log_sets(void);
 
GList *purple_log_get_system_logs(PurpleAccount *account);
 
int purple_log_get_size(PurpleLog *log);
 
int purple_log_get_total_size(PurpleLogType type, const char *name, PurpleAccount *account);
 
int purple_log_get_activity_score(PurpleLogType type, const char *name, PurpleAccount *account);
 
gboolean purple_log_is_deletable(PurpleLog *log);
 
gboolean purple_log_delete(PurpleLog *log);
 
char *purple_log_get_log_dir(PurpleLogType type, const char *name, PurpleAccount *account);
 
gint purple_log_compare(gconstpointer y, gconstpointer z);
 
gint purple_log_set_compare(gconstpointer y, gconstpointer z);
 
void purple_log_set_free(PurpleLogSet *set);
 
/******************************************/
/******************************************/
void purple_log_common_writer(PurpleLog *log, const char *ext);
 
GList *purple_log_common_lister(PurpleLogType type, const char *name,
                              PurpleAccount *account, const char *ext,
                              PurpleLogLogger *logger);
 
int purple_log_common_total_sizer(PurpleLogType type, const char *name,
                                PurpleAccount *account, const char *ext);
 
int purple_log_common_sizer(PurpleLog *log);
 
gboolean purple_log_common_deleter(PurpleLog *log);
 
gboolean purple_log_common_is_deletable(PurpleLog *log);
 
/******************************************/
/******************************************/
PurpleLogLogger *purple_log_logger_new(const char *id, const char *name, int functions, ...);
 
void purple_log_logger_free(PurpleLogLogger *logger);
 
void purple_log_logger_add (PurpleLogLogger *logger);
 
void purple_log_logger_remove (PurpleLogLogger *logger);
 
void purple_log_logger_set (PurpleLogLogger *logger);
 
PurpleLogLogger *purple_log_logger_get (void);
 
GList *purple_log_logger_get_options(void);
 
/**************************************************************************/
/**************************************************************************/
void purple_log_init(void);
 
void *purple_log_get_handle(void);
 
void purple_log_uninit(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _PURPLE_LOG_H_ */