summaryrefslogtreecommitdiffstats
path: root/tderesources/caldav/job.h
blob: 7d312d90b6a36e6cc5c86448e3b4d519868c04c3 (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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
/*=========================================================================
| KCalDAV
|--------------------------------------------------------------------------
| (c) 2010  Timothy Pearson
| (c) 2009  Kumaran Santhanam (initial KDE4 version)
|
| This project is released under the GNU General Public License.
| Please see the file COPYING for more details.
|--------------------------------------------------------------------------
| Job class for accessing remote calendars.
 ========================================================================*/

/*=========================================================================
| INCLUDES
 ========================================================================*/

#ifndef KCALDAV_JOB_H
#define KCALDAV_JOB_H

#include <tqthread.h>
#include <tqstring.h>
#include <tqdatetime.h>
#include <tqapplication.h>

extern "C" {
    #include <caldav.h>
}

namespace KCal {

/*=========================================================================
| CLASS
 ========================================================================*/

/**
 * Calendar job.
 */
class CalDavJob : public TQThread {

public:

    /**
     * @param url URL to load.
     */
    CalDavJob(const TQString& url = TQString());

    virtual ~CalDavJob();

    /**
     * Sets a new URL to load.
     */
    virtual void setUrl(const TQString& s) {
        mUrl = s;
    }

    /**
     * Sets a new Tasks URL to load.
     */
    virtual void setTasksUrl(const TQString& s) {
        mTasksUrl = s;
    }

    /**
     * Sets a new Journals URL to load.
     */
    virtual void setJournalsUrl(const TQString& s) {
        mJournalsUrl = s;
    }

    /**
     * Sets the parent qobject.
     */
    virtual void setParent(TQObject *s) {
        mParent = s;
    }

    /**
     * Sets the type (0==read, 1==write)
     */
    virtual void setType(int s) {
        mType = s;
    }

    /**
     * @return URL to load.
     */
    virtual TQString url() const {
        return mUrl;
    }

    /**
     * @return Tasks URL to load.
     */
    virtual TQString tasksUrl() const {
        return mTasksUrl;
    }

    /**
     * @return Journals URL to load.
     */
    virtual TQString journalsUrl() const {
        return mJournalsUrl;
    }

    /**
     * @return parent object
     */
    virtual TQObject *parent() {
        return mParent;
    }

    /**
     * @return type
     */
    virtual int type() {
        return mType;
    }

    /**
     * @return true if events downloading process failed.
     */
    virtual bool error() const {
        return mError;
    }

    /**
     * @return true if tasks downloading process failed.
     */
    virtual bool tasksError() const {
        return mTasksError;
    }

    /**
     * @return true if journals downloading process failed.
     */
    virtual bool journalsError() const {
        return mJournalsError;
    }

    /**
     * @return an event error string.
     */
    virtual TQString errorString() const {
        return mErrorString;
    }

    /**
     * @return a task error string.
     */
    virtual TQString tasksErrorString() const {
        return mTasksErrorString;
    }

    /**
     * @return a journal error string.
     */
    virtual TQString journalsErrorString() const {
        return mJournalsErrorString;
    }

    /**
     * @return an event error number.
     */
    virtual long errorNumber() const {
        return mErrorNumber;
    }

    /**
     * @return a task error number.
     */
    virtual long tasksErrorNumber() const {
        return mTasksErrorNumber;
    }

    /**
     * @return a journal error number.
     */
    virtual long journalsErrorNumber() const {
        return mJournalsErrorNumber;
    }

protected:

    virtual void run();

    /**
     * Main run method for event jobs. Jobs should not override run() method.
     * Instead of this they should override this one.
     * @param caldavRuntime specific libcaldav runtime information. This pointer should not be saved for the usage
     * outside of runJob.
     * @return libcaldav response code (see CALDAV_RESPONSE)
     */
    virtual int runJob(runtime_info* caldavRuntime) = 0;

    /**
     * Main run method for task jobs. Jobs should not override run() method.
     * Instead of this they should override this one.
     * @param caldavRuntime specific libcaldav runtime information. This pointer should not be saved for the usage
     * outside of runJob.
     * @return libcaldav response code (see CALDAV_RESPONSE)
     */
    virtual int runTasksJob(runtime_info* caldavRuntime) = 0;

    /**
     * Main run method for journal jobs. Jobs should not override run() method.
     * Instead of this they should override this one.
     * @param caldavRuntime specific libcaldav runtime information. This pointer should not be saved for the usage
     * outside of runJob.
     * @return libcaldav response code (see CALDAV_RESPONSE)
     */
    virtual int runJournalsJob(runtime_info* caldavRuntime) = 0;

    /**
     * Some cleaning. Jobs may (and usually should) override this method.
     */
    virtual void cleanJob() {
        mError = false;
        mErrorString = "";
        mErrorNumber = 0;
        mTasksError = false;
        mTasksErrorString = "";
        mTasksErrorNumber = 0;
        mJournalsError = false;
        mJournalsErrorString = "";
        mJournalsErrorNumber = 0;
    }

    /**
     * Sets an event error string to @p err. Also sets an error flag.
     */
    void setErrorString(const TQString& str, const long number);

    /**
     * Sets a task error string to @p err. Also sets an error flag.
     */
    void setTasksErrorString(const TQString& str, const long number);

    /**
     * Sets a journal error string to @p err. Also sets an error flag.
     */
    void setJournalsErrorString(const TQString& str, const long number);

    /**
     * Process an event error.
     * Subclasses can overwrite this method, if some special error message handling
     * should be done. Call setErrorString() to set the error after processing is done.
     * @param err error structure.
     */
    virtual void processError(const caldav_error* err);

    /**
     * Process a task error.
     * Subclasses can overwrite this method, if some special error message handling
     * should be done. Call setErrorString() to set the error after processing is done.
     * @param err error structure.
     */
    virtual void processTasksError(const caldav_error* err);

    /**
     * Process a journal error.
     * Subclasses can overwrite this method, if some special error message handling
     * should be done. Call setErrorString() to set the error after processing is done.
     * @param err error structure.
     */
    virtual void processJournalsError(const caldav_error* err);

private:

    TQString mUrl;
    TQString mTasksUrl;
    TQString mJournalsUrl;
    bool mError;
    bool mTasksError;
    bool mJournalsError;
    TQString mErrorString;
    TQString mTasksErrorString;
    TQString mJournalsErrorString;
    long mErrorNumber;
    long mTasksErrorNumber;
    long mJournalsErrorNumber;
    TQObject *mParent;
    int mType;

    void enableCaldavDebug(runtime_info*);
};

} // namespace KCal

#endif // KCALDAV_JOB_H