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
|
/*
* kmail: KDE mail client
* This file: Copyright (C) 2006 Dmitry Morozhnikov <[email protected]>
*
* 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 __KMAIL_TEMPLATEPARSER_H__
#define __KMAIL_TEMPLATEPARSER_H__
#include <tqobject.h>
class KMMessage;
class TQString;
class KMFolder;
class TQObject;
class TDEProcess;
/**
* The TemplateParser transforms a message with a given template.
*
* A template contains text and commands, such as %QUOTE or %ODATE, which will be
* replaced with the real values in process().
*
* The message given in the constructor is the message that is being transformed.
* The message text will be replaced by the processed text of the template, but other
* properties, such as the attachments or the subject, are preserved.
*
* There are two different kind of commands: Those that work on the message that is
* to be transformed and those that work on an 'original message'.
* Those that work on the message that is to be transformed have no special prefix, e.g.
* '%DATE'. Those that work on the original message have an 'O' prefix, for example
* '%ODATE'.
* This means that the %DATE command will take the date of the message passed in the
* constructor, the message which is to be transformed, whereas the %ODATE command will
* take the date of the message that is being passed in process(), the original message.
*
* TODO: What is the usecase of the commands that work on the message to be transformed?
* In general you only use the commands that work on the original message...
*/
class TemplateParser : public TQObject
{
TQ_OBJECT
public:
enum Mode {
NewMessage,
Reply,
ReplyAll,
Forward
};
static const int PipeTimeout = 15;
public:
TemplateParser( KMMessage *amsg, const Mode amode );
~TemplateParser();
/**
* Sets the selection. If this is set, only the selection will be added to commands such
* as %QUOTE. Otherwise, the whole message is quoted.
* If this is not called at all, the whole message is quoted as well.
* Call this before calling process().
*/
void setSelection( const TQString &selection );
/**
* Sets whether the template parser is allowed to decrypt the original message when needing
* its message text, for example for the %QUOTE command.
* If true, it will tell the ObjectTreeParser it uses internally to decrypt the message,
* and that will possibly show a password request dialog to the user.
*
* The default is false.
*/
void setAllowDecryption( const bool allowDecryption );
virtual void process( KMMessage *aorig_msg, KMFolder *afolder = 0, bool append = false );
virtual void process( const TQString &tmplName, KMMessage *aorig_msg,
KMFolder *afolder = 0, bool append = false );
virtual void processWithTemplate( const TQString &tmpl );
/// This finds the template to use. Either the one from the folder, identity or
/// finally the global template.
/// This also reads the To and CC address of the template
/// @return the contents of the template
virtual TQString findTemplate();
/// Finds the template with the given name.
/// This also reads the To and CC address of the template
/// @return the contents of the template
virtual TQString findCustomTemplate( const TQString &tmpl );
virtual TQString pipe( const TQString &cmd, const TQString &buf );
virtual TQString getFName( const TQString &str );
virtual TQString getLName( const TQString &str );
protected:
Mode mMode;
KMFolder *mFolder;
uint mIdentity;
KMMessage *mMsg;
KMMessage *mOrigMsg;
TQString mSelection;
bool mAllowDecryption;
int mPipeRc;
TQString mPipeOut;
TQString mPipeErr;
bool mDebug;
TQString mQuoteString;
bool mAppend;
TQString mTo, mCC;
partNode *mOrigRoot;
/**
* If there was a text selection set in the constructor, that will be returned.
* Otherwise, returns the plain text of the original message, as in KMMessage::asPlainText().
* The only difference is that this uses the cached object tree from parsedObjectTree()
*
* @param allowSelectionOnly if false, it will always return the complete mail text
*/
TQString messageText( bool allowSelectionOnly );
/**
* Returns the parsed object tree of the original message.
* The result is cached in mOrigRoot, therefore calling this multiple times will only parse
* the tree once.
*/
partNode* parsedObjectTree();
/**
* Called by processWithTemplate(). This adds the completely processed body to
* the message.
*
* In append mode, this will simply append the text to the body.
*
* Otherwise, the content of the old message is deleted and replaced with @p body.
* Attachments of the original message are also added back to the new message.
*/
void addProcessedBodyToMessage( const TQString &body );
/**
* Determines whether the signature should be stripped when getting the text of the original
* message, e.g. for commands such as %QUOTE
*/
bool shouldStripSignature() const;
int parseQuotes( const TQString &prefix, const TQString &str,
TQString "e ) const;
protected slots:
void onProcessExited( TDEProcess *proc );
void onReceivedStdout( TDEProcess *proc, char *buffer, int buflen );
void onReceivedStderr( TDEProcess *proc, char *buffer, int buflen );
void onWroteStdin( TDEProcess *proc );
};
#endif // __KMAIL_TEMPLATEPARSER_H__
|
