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
|
/*
Copyright (C) 2009 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.net
Copyright (c) 2009 Andras Mantia <andras@kdab.net>
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.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef __MIMETREEPARSER_NODEHELPER_H__
#define __MIMETREEPARSER_NODEHELPER_H__
#include "partmetadata.h"
#include "enums.h"
#include <KMime/Message>
#include <QList>
#include <QMap>
#include <QSet>
class QUrl;
class QTextCodec;
namespace MimeTreeParser
{
class AttachmentTemporaryFilesDirs;
namespace Interface
{
}
}
namespace MimeTreeParser
{
/**
* @author Andras Mantia <andras@kdab.net>
*/
class NodeHelper: public QObject
{
Q_OBJECT
public:
NodeHelper();
~NodeHelper();
void setNodeProcessed(KMime::Content *node, bool recurse);
void setNodeUnprocessed(KMime::Content *node, bool recurse);
bool nodeProcessed(KMime::Content *node) const;
void clear();
void forceCleanTempFiles();
void setPartMetaData(KMime::Content *node, const PartMetaData &metaData);
PartMetaData partMetaData(KMime::Content *node);
/**
* Set the 'Content-Type' by mime-magic from the contents of the body.
* If autoDecode is true the decoded body will be used for mime type
* determination (this does not change the body itself).
*/
void magicSetType(KMime::Content *node, bool autoDecode = true);
/** Attach an extra node to an existing node */
void attachExtraContent(KMime::Content *topLevelNode, KMime::Content *content);
/** Get the extra nodes attached to the @param topLevelNode and all sub-nodes of @param topLevelNode */
QList<KMime::Content *> extraContents(KMime::Content *topLevelNode) const;
/** Return a modified message (node tree) starting from @param topLevelNode that has the original nodes and the extra nodes.
The caller has the responsibility to delete the new message.
*/
KMime::Message *messageWithExtraContent(KMime::Content *topLevelNode);
/** Get a QTextCodec suitable for this message part */
const QTextCodec *codec(KMime::Content *node);
/** Set the charset the user selected for the message to display */
void setOverrideCodec(KMime::Content *node, const QTextCodec *codec);
/**
* Cleanup the attachment temp files
*/
void removeTempFiles();
/**
* Add a file to the list of managed temporary files
*/
void addTempFile(const QString &file);
// Get a href in the form attachment:<nodeId>?place=<place>, used by ObjectTreeParser and
// UrlHandlerManager.
QString asHREF(const KMime::Content *node, const QString &place) const;
KMime::Content *fromHREF(const KMime::Message::Ptr &mMessage, const QUrl &href) const;
/**
* @return true if this node is a child or an encapsulated message
*/
static bool isInEncapsulatedMessage(KMime::Content *node);
/**
* Returns the charset for the given node. If no charset is specified
* for the node, the defaultCharset() is returned.
*/
static QByteArray charset(KMime::Content *node);
/**
* Return a QTextCodec for the specified charset.
* This function is a bit more tolerant, than QTextCodec::codecForName
*/
static const QTextCodec *codecForName(const QByteArray &_str);
/**
* Returns a usable filename for a node, that can be the filename from the
* content disposition header, or if that one is empty, the name from the
* content type header.
*/
static QString fileName(const KMime::Content *node);
/**
* Fixes an encoding received by a KDE function and returns the proper,
* MIME-compilant encoding name instead.
* @see encodingForName
*/
static QString fixEncoding(const QString &encoding); //TODO(Andras) move to a utility class?
/**
* Drop-in replacement for KCharsets::encodingForName(). The problem with
* the KCharsets function is that it returns "human-readable" encoding names
* like "ISO 8859-15" instead of valid encoding names like "ISO-8859-15".
* This function fixes this by replacing whitespace with a hyphen.
*/
static QString encodingForName(const QString &descriptiveName); //TODO(Andras) move to a utility class?
/**
* Return a list of the supported encodings
* @param usAscii if true, US-Ascii encoding will be prepended to the list.
*/
static QStringList supportedEncodings(bool usAscii); //TODO(Andras) move to a utility class?
QString fromAsString(KMime::Content *node) const;
/**
* Returns a list of attachments of attached extra content nodes.
* This is mainly useful is order to get attachments of encrypted messages.
* Note that this does not include attachments from the primary node tree.
* @see KMime::Content::attachments().
*/
QVector<KMime::Content *> attachmentsOfExtraContents() const;
Q_SIGNALS:
void update(MimeTreeParser::UpdateMode);
private:
Q_DISABLE_COPY(NodeHelper)
bool unencryptedMessage_helper(KMime::Content *node, QByteArray &resultingData, bool addHeaders,
int recursionLevel = 1);
void mergeExtraNodes(KMime::Content *node);
void cleanFromExtraNodes(KMime::Content *node);
/** Creates a persistent index string that bridges the gap between the
permanent nodes and the temporary ones.
Used internally for robust indexing.
**/
QString persistentIndex(const KMime::Content *node) const;
/** Translates the persistentIndex into a node back
node: any node of the actually message to what the persistentIndex is interpreded
**/
KMime::Content *contentFromIndex(KMime::Content *node, const QString &persistentIndex) const;
private:
QList<KMime::Content *> mProcessedNodes;
QList<KMime::Content *> mNodesUnderProcess;
QSet<KMime::Content *> mDisplayEmbeddedNodes;
QSet<KMime::Content *> mDisplayHiddenNodes;
QTextCodec *mLocalCodec;
QMap<KMime::Content *, const QTextCodec *> mOverrideCodecs;
QMap<KMime::Content *, PartMetaData> mPartMetaDatas;
QMap<KMime::Message::Content *, QList<KMime::Content *> > mExtraContents;
AttachmentTemporaryFilesDirs *mAttachmentFilesDir;
friend class NodeHelperTest;
};
}
#endif
|
