summaryrefslogtreecommitdiff
path: root/migrationutility/sourceserver.h
blob: f3ab8974980342770bf1e7331f5ba20590f64d5f (plain)
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
/*
 * Copyright (C) 2012  Christian Mollekopf <mollekopf@kolabsys.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef SOURCESERVER_H
#define SOURCESERVER_H

#include <kimap/session.h>
#include <kimap/loginjob.h>
#include <qsharedpointer.h>
#include <QStringList>
#include "sourceaccount.h"

/**
 * Job interface to retrieve users from a server.
 */
class UserListJob: public KJob
{
    Q_OBJECT
public:
    explicit UserListJob(QObject* parent = 0);
    virtual QStringList getUserList() const = 0;
};

class FixedUserListJob: public UserListJob
{
    Q_OBJECT
public:
    explicit FixedUserListJob(const QStringList &userList, QObject* parent = 0);
    virtual void start();
    virtual QStringList getUserList() const;
   
private slots:
    void doEmitResult();

private:
    QStringList mUserList;
};



/**
 * The source server represents a server with user accounts that need to be migrated.
 *
 * The server can support multiple access protocols per user, that are each represented by a source account.
 */
class SourceServer: public QObject
{
    Q_OBJECT
public:
    explicit SourceServer(QObject* parent = 0);
    QList<SourceAccount*> getSourceAccounts(const QString &user);
    UserListJob *listUsers();
    void setSingleUser(const QString &);
    void setStatefile(const QString &);

    /**
     * Specify a list of regex to ignore source folders.
     */
    void setIgnoredFolders(const QStringList &);
    QStringList ignoredFolders() const;
protected:
    virtual QList<SourceAccount*> getSourceAccountsImpl(const QString &user) = 0;
    /**
     * Reeimplement to retrieve a user list from the server.
     * Note that the retrieved username is used to login to the users account on the source server.
     */
    virtual UserListJob *retrieveUserList();
    QStringList mExplicitUsers;
    QString mStatefile;
private:
    QStringList mIgnoredFolders;
};


class TestServer: public SourceServer
{
    Q_OBJECT
public:
    explicit TestServer(QObject* parent = 0);
    
    QStringList mUsers;
protected:
    virtual UserListJob *retrieveUserList();
    virtual QList< SourceAccount* > getSourceAccountsImpl(const QString& user);
};

class IMAPConnectionSettings {
public:
    IMAPConnectionSettings(const QString &username, const QString &pw, KIMAP::LoginJob::EncryptionMode encryptionMode, KIMAP::LoginJob::AuthenticationMode authenticationMode)
    : mUsername(username), mPassword(pw), mEncryptionMode(encryptionMode), mAuthenticationMode(authenticationMode)
    {}
    QString username() const { return mUsername; }
    QString password() const { return mPassword; }
    KIMAP::LoginJob::EncryptionMode encryptionMode() const { return mEncryptionMode; }
    KIMAP::LoginJob::AuthenticationMode authenticationMode() const { return mAuthenticationMode; }
private:
    const QString mUsername;
    const QString mPassword;
    const KIMAP::LoginJob::EncryptionMode mEncryptionMode;
    const KIMAP::LoginJob::AuthenticationMode mAuthenticationMode;
};

class IMAPUserListJob: public UserListJob
{
    Q_OBJECT
public:
    explicit IMAPUserListJob(const QString &host, qint16 port, const IMAPConnectionSettings &settings, QObject* parent = 0);
    virtual ~IMAPUserListJob();
    virtual void start();
    virtual QStringList getUserList() const;

private slots:
    void onLoginDone(KJob*);
    void onUserListJobDone(KJob*);
    void onLogoutDone(KJob*);

private:
    KIMAP::Session *mSession;
    const IMAPConnectionSettings mConnectionSettings;
    QStringList mUserList;
};

class IMAPSourceServer: public SourceServer
{
    Q_OBJECT
public:
    explicit IMAPSourceServer(QObject* parent = 0);

    void setHost(const QString &host, qint16 port);
    void setAdminCredentials(const QString &username, const QString &pw);
    void setEncryption(KIMAP::LoginJob::EncryptionMode);
    void setAuthentication(KIMAP::LoginJob::AuthenticationMode);
protected:
    virtual QList< SourceAccount* > getSourceAccountsImpl(const QString& user);
    virtual UserListJob *retrieveUserList();
    KIMAP::Session *mSession;
    QString mHost;
    int mPort;
    QString mUsername;
    QString mPw;
    KIMAP::LoginJob::EncryptionMode mEncryptionMode;
    KIMAP::LoginJob::AuthenticationMode mAuthenticationMode;
};

class KolabSourceServer: public IMAPSourceServer
{
    Q_OBJECT
public:
    explicit KolabSourceServer(QObject* parent = 0);
    
protected:
    virtual QList< SourceAccount* > getSourceAccountsImpl(const QString& user);
};

class ExchangeIMAPSourceServer: public IMAPSourceServer
{
    Q_OBJECT
public:
    explicit ExchangeIMAPSourceServer(QObject* parent = 0);
    
protected:
    virtual QList< SourceAccount* > getSourceAccountsImpl(const QString& user);
};

#endif // SOURCESERVER_H