src/inc.h

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2012 Hiroyuki Yamamoto and the Claws Mail team
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  17  *
  18  */
  19
  20 #ifndef __INC_H__
  21 #define __INC_H__
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include "claws-features.h"
  25 #endif
  26
  27 #include <glib.h>
  28
  29 #include "mainwindow.h"
  30 #include "progressdialog.h"
  31 #include "prefs_account.h"
  32 #include "session.h"
  33 #include "pop.h"
  34
  35 typedef struct _IncProgressDialog       IncProgressDialog;
  36 typedef struct _IncSession              IncSession;
  37
  38 typedef enum
  39 {
  40         INC_SUCCESS,
  41         INC_CONNECT_ERROR,
  42         INC_AUTH_FAILED,
  43         INC_LOCKED,
  44         INC_ERROR,
  45         INC_NO_SPACE,
  46         INC_IO_ERROR,
  47         INC_SOCKET_ERROR,
  48         INC_EOF,
  49         INC_TIMEOUT,
  50         INC_CANCEL
  51 } IncState;
  52
  53 struct _IncProgressDialog
  54 {
  55         ProgressDialog *dialog;
  56
  57         MainWindow *mainwin;
  58
  59         gboolean show_dialog;
  60
  61 #if GLIB_CHECK_VERSION(2,61,2)
  62         GDateTime *progress_tv;
  63         GDateTime *folder_tv;
  64 #else
  65         GTimeVal progress_tv;
  66         GTimeVal folder_tv;
  67 #endif
  68
  69         GList *queue_list;      /* list of IncSession */
  70         gint cur_row;
  71 };
  72
  73 struct _IncSession
  74 {
  75         Session *session;
  76         IncState inc_state;
  77
  78         gint cur_total_bytes;
  79
  80         gpointer data;
  81 };
  82
  83 #define TIMEOUT_ITV     200
  84
  85 void inc_mail                   (MainWindow     *mainwin,
  86                                  gboolean        notify);
  87 gint inc_account_mail           (MainWindow     *mainwin,
  88                                  PrefsAccount   *account);
  89
  90 /* This function just blindly checks all accounts in the passed
  91  * account_list, and doesn't care about whether the configuration
  92  * says they should be checked or not. These checks should be done
  93  * by the caller, and account_list should look accordingly.
  94  * The caller is responsible for freeing the list afterwards. */
  95 void inc_account_list_mail      (MainWindow     *mainwin,
  96                                  GList          *list, /* linked list of PrefsAccount* pointers */
  97                                  gboolean        autocheck,
  98                                  gboolean        notify);
  99
 100 /* This function is used by the global autocheck interval (autocheck TRUE),
 101  * or check at startup (check_at_startup TRUE)
 102  * or by the manual 'Receive all' feature (autocheck FALSE). It makes
 103  * sure correct list of accounts is marked for checking, based on
 104  * global and account configuration, and calls inc_account_list_mail(). */
 105 void inc_all_account_mail       (MainWindow     *mainwin,
 106                                  gboolean        autocheck,
 107                                  gboolean        check_at_startup,
 108                                  gboolean        notify);
 109
 110 void inc_progress_update        (Pop3Session    *session);
 111
 112 void inc_pop_before_smtp        (PrefsAccount   *acc);
 113
 114 gboolean inc_is_active          (void);
 115
 116 void inc_cancel_all             (void);
 117
 118 extern guint inc_lock_count;
 119 #define inc_lock() {                                                            \
 120         inc_lock_real();                                                        \
 121         debug_print("called inc_lock (lock count %d)\n", inc_lock_count);       \
 122 }
 123
 124 #define inc_unlock() {                                                          \
 125         inc_unlock_real();                                                      \
 126         debug_print("called inc_unlock (lock count %d)\n", inc_lock_count);     \
 127 }
 128
 129 void inc_lock_real              (void);
 130 void inc_unlock_real            (void);
 131
 132 void inc_autocheck_timer_init   (MainWindow     *mainwin);
 133 void inc_autocheck_timer_set    (void);
 134 void inc_autocheck_timer_remove (void);
 135 gboolean inc_offline_should_override(gboolean force_ask, const gchar *msg);
 136
 137 void inc_account_autocheck_timer_remove(PrefsAccount *account);
 138 void inc_account_autocheck_timer_set_interval(PrefsAccount *account);
 139
 140 void inc_reset_offline_override_timers();
 141
 142 #endif /* __INC_H__ */