nntpgrab_plugin_schedular.h

Go to the documentation of this file.

/*
 Copyright (C) 2005-2009 Erik van Pienbroek

 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 _NNTPGRAB_PLUGIN_SCHEDULAR_H_
#define _NNTPGRAB_PLUGIN_SCHEDULAR_H_

#include "nntpgrab_plugin_base.h"
#include "collections.h"

// These are all the functions that the plugin can call to communicate with the NNTPGrab core
typedef struct _plugin_schedular_imported_funcs {
    int version;

    void (*task_added) (const NNTPCollection *collection, const NNTPFile *file);
    void (*task_removed) (const char *collection_name, const char *subject, guint64 total_size, guint64 total_size_remaining);
    void (*task_state_changed) (const char *collection_name, const char *subject, const char *real_filename, TaskState old_state, TaskState new_state);
    void (*collection_added) (const char *collection_name, const char *poster);
    void (*collection_removed) (const char *collection_name);
    void (*collection_modified) (const char *collection_name, const char *poster);

    void (*notify_schedular_state_changed) (SchedularState new_state, const char *reason);

    GList * (*config_get_avail_servers) (void);
    ConfigServer * (*config_get_server_info) (const char *servername);
    ConfigOpts (*config_get_opts) (void);

    gpointer (*nntp_connection_initialize) (const char *servername, NNTPGrabErrCode *err);
    void (*nntp_connection_destroy) (gpointer obj);
    NNTPGrabErrCode (*nntp_connection_get_part) (gpointer obj, const char *collection_name, const NNTPFile *file, const NNTPPart *part, char **reason);

    NNTPGrabDecoderRes (*decode_file) (const char *collection_name, NNTPFile *file, int *saved_errno, char **errmsg);

    void (*emit_fatal_error) (const char *errmsg);
    void (*emit_part_download_complete) (const char *servername, gpointer connection, const char *collection_name, const char *subject, int partnum, int size);
    void (*emit_part_download_failed) (const char *servername, gpointer connection, const char *collection_name, const char *subject, int partnum, int size, gboolean all_servers_tried);
    void (*emit_task_moved) (const char *orig_collection_name, const char *subject, const char *new_collection_name, int old_position, int new_position);
    void (*emit_collection_moved) (const char *collection_name, int old_position, int new_position);
    void (*emit_file_download_state_update) (const char *collection_name, const char *subject, int num_parts_total, int num_parts_done, int num_parts_failed, guint64 file_size, guint64 file_size_remaining, guint64 total_file_size, guint64 total_file_size_remaining);

    void (*perform_par2_repair) (const char *collection_name, const char *par2filename);

    void (*perform_unpack) (const char *collection_name, const char *filename);

    void (*emit_all_downloads_completed) (void);

    NNTPCollection *(*collection_new) (void);
    void (*collection_ref) (NNTPCollection *collection);
    void (*collection_unref) (NNTPCollection *collection);
    NNTPFile *(*file_new) (void);
    void (*file_ref) (NNTPFile *file);
    void (*file_unref) (NNTPFile *file);

    NGRegex *(*regex_compile) (const char *regex);
    const char **(*regex_match) (NGRegex *re, const char *text);
    void (*regex_matches_free) (const char **matches);
} PluginSchedularImportedFuncs;

// The plugin needs to exported these methods :

gboolean     nntpgrab_plugin_schedular_initialize(PluginSchedularImportedFuncs funcs, char **errmsg);

void         nntpgrab_plugin_schedular_destroy(void);

int          nntpgrab_plugin_schedular_get_version(void);

gboolean     nntpgrab_plugin_schedular_start(void);

gboolean    nntpgrab_plugin_schedular_stop(const char *reason);

SchedularState   nntpgrab_plugin_schedular_get_state(void);

gboolean     nntpgrab_plugin_schedular_add_task_to_queue(const char *collection_name, NNTPFile *file, char **errmsg);

gboolean     nntpgrab_plugin_schedular_del_task_from_queue(const char *collection_name, const char *subject, char **errmsg);

gboolean     nntpgrab_plugin_schedular_restart_task(const char *collection_name, const char *subject, char **errmsg);

gboolean     nntpgrab_plugin_schedular_save_queue(char **errmsg);

void         nntpgrab_plugin_schedular_foreach_task(GFunc foreach_func, gpointer data);

gboolean
nntpgrab_plugin_schedular_move_task(const char *collection_name_src, const char *subject_src, const char *collection_name_dest, int position_dest);

gboolean
nntpgrab_plugin_schedular_move_collection(const char *collection_name, int new_position);

#endif /* _NNTPGRAB_PLUGIN_SCHEDULAR_H_ */

---