aboutsummaryrefslogtreecommitdiffstats
path: root/camel/providers/pop3/camel-pop3-engine.h
blob: caf6ca1d2aa5fd9caa07d0272597afe97f3573bb (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/*
 * Copyright (C) 2001 Ximian Inc.
 *
 * Authors: Michael Zucchi <notzed@ximian.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License 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., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifndef _CAMEL_POP3_ENGINE_H
#define _CAMEL_POP3_ENGINE_H

#include <camel/camel-object.h>
#include "e-util/e-msgport.h"
#include "camel-pop3-stream.h"

#define CAMEL_POP3_ENGINE(obj)         CAMEL_CHECK_CAST (obj, camel_pop3_engine_get_type (), CamelPOP3Engine)
#define CAMEL_POP3_ENGINE_CLASS(klass) CAMEL_CHECK_CLASS_CAST (klass, camel_pop3_engine_get_type (), CamelPOP3EngineClass)
#define CAMEL_IS_POP3_ENGINE(obj)      CAMEL_CHECK_TYPE (obj, camel_pop3_engine_get_type ())

typedef struct _CamelPOP3EngineClass CamelPOP3EngineClass;
typedef struct _CamelPOP3Engine CamelPOP3Engine;
typedef struct _CamelPOP3Command CamelPOP3Command;

/* pop 3 connection states, actually since we're given a connected socket, we always start in auth state */
typedef enum {
    CAMEL_POP3_ENGINE_DISCONNECT = 0,
    CAMEL_POP3_ENGINE_AUTH,
    CAMEL_POP3_ENGINE_TRANSACTION,
    CAMEL_POP3_ENGINE_UPDATE,
} camel_pop3_engine_t;

/* state of a command */
typedef enum {
    CAMEL_POP3_COMMAND_IDLE = 0, /* command created or queued, not yet sent (e.g. non pipelined server) */
    CAMEL_POP3_COMMAND_DISPATCHED, /* command sent to server */

    /* completion codes */
    CAMEL_POP3_COMMAND_OK,  /* plain ok response */
    CAMEL_POP3_COMMAND_DATA, /* processing command response */
    CAMEL_POP3_COMMAND_ERR, /* error response */
} camel_pop3_command_t;

/* flags for command types */
enum {
    CAMEL_POP3_COMMAND_SIMPLE = 0, /* dont expect multiline response */
    CAMEL_POP3_COMMAND_MULTI = 1, /* expect multiline response */
};

/* flags for server options */
enum {
    CAMEL_POP3_CAP_APOP = 1<<0,
    CAMEL_POP3_CAP_UIDL = 1<<1,
    CAMEL_POP3_CAP_SASL = 1<<2,
    CAMEL_POP3_CAP_TOP  = 1<<3,
    CAMEL_POP3_CAP_PIPE = 1<<4,
    CAMEL_POP3_CAP_STLS = 1<<5
};

typedef void (*CamelPOP3CommandFunc)(CamelPOP3Engine *pe, CamelPOP3Stream *stream, void *data);

struct _CamelPOP3Command {
    struct _CamelPOP3Command *next;
    struct _CamelPOP3Command *prev;

    guint32 flags;
    camel_pop3_command_t state;

    CamelPOP3CommandFunc func;
    void *func_data;

    int data_size;
    char *data;
};

struct _CamelPOP3Engine {
    CamelObject parent;

    camel_pop3_engine_t state;

    GList *auth;        /* authtypes supported */

    guint32 capa;       /* capabilities */
    char *apop;     /* apop time string */

    unsigned char *line;    /* current line buffer */
    unsigned int linelen;

    struct _CamelPOP3Stream *stream;

    unsigned int sentlen;   /* data sent (so we dont overflow network buffer) */

    EDList active;      /* active commands */
    EDList queue;       /* queue of waiting commands */
    EDList done;        /* list of done commands, awaiting free */

    CamelPOP3Command *current; /* currently busy (downloading) response */
};

struct _CamelPOP3EngineClass {
    CamelObjectClass parent_class;
};

CamelType         camel_pop3_engine_get_type    (void);

CamelPOP3Engine  *camel_pop3_engine_new     (CamelStream *source);

void              camel_pop3_engine_reget_capabilities (CamelPOP3Engine *engine);

void              camel_pop3_engine_command_free(CamelPOP3Engine *pe, CamelPOP3Command *pc);

int           camel_pop3_engine_iterate (CamelPOP3Engine *pe, CamelPOP3Command *pc);

CamelPOP3Command *camel_pop3_engine_command_new (CamelPOP3Engine *pe, guint32 flags, CamelPOP3CommandFunc func, void *data, const char *fmt, ...);

#endif /* ! _CAMEL_POP3_ENGINE_H */