Page MenuHome GnuPG
Files F31766682

mailitem-events.cpp
No OneTemporary
Actions

mailitem-events.cpp
View Options

/* mailitem-events.h - Event handling for mails.
* Copyright (C) 2015 Intevation GmbH
*
* This file is part of GpgOL.
*
* GpgOL 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 2.1 of the License, or (at your option) any later version.
*
* GpgOL 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/>.
*/
#include "config.h"
#include "common.h"
#include "eventsink.h"
#include "eventsinks.h"
#include "mymapi.h"
#include "oomhelp.h"
#include "ocidl.h"
#include "windowmessages.h"
#include "mail.h"
#include "mapihelp.h"
const wchar_t * save_props[] = {
L"Categories",
L"FlagRequest",
L"TaskCompletedDate",
L"FlagStatus",
NULL };
typedef enum
{
AfterWrite = 0xFC8D,
AttachmentAdd = 0xF00B,
AttachmentRead = 0xF00C,
AttachmentRemove = 0xFBAE,
BeforeAttachmentAdd = 0xFBB0,
BeforeAttachmentPreview = 0xFBAF,
BeforeAttachmentRead = 0xFBAB,
BeforeAttachmentSave = 0xF00D,
BeforeAttachmentWriteToTempFile = 0xFBB2,
BeforeAutoSave = 0xFC02,
BeforeCheckNames = 0xF00A,
BeforeDelete = 0xFA75,
BeforeRead = 0xFC8C,
Close = 0xF004,
CustomAction = 0xF006,
CustomPropertyChange = 0xF008,
Forward = 0xF468,
Open = 0xF003,
PropertyChange = 0xF009,
Read = 0xF001,
ReadComplete = 0xFC8F,
Reply = 0xFC8F,
ReplyAll = 0xF467,
Send = 0xF005,
Unload = 0xFBAD,
Write = 0xF002
} MailEvent;
/* Mail Item Events */
BEGIN_EVENT_SINK(MailItemEvents, IDispatch)
/* We are still in the class declaration */
private:
Mail * m_mail; /* The mail object related to this mailitem */
bool m_send_seen; /* The message is about to be submitted */
bool m_decrypt_after_write;
};
MailItemEvents::MailItemEvents() :
m_object(NULL),
m_pCP(NULL),
m_cookie(0),
m_ref(1),
m_mail(NULL),
m_send_seen (false),
m_decrypt_after_write(false)
{
}
MailItemEvents::~MailItemEvents()
{
if (m_pCP)
m_pCP->Unadvise(m_cookie);
if (m_object)
gpgol_release (m_object);
}
/*
static DWORD WINAPI
request_send (LPVOID arg)
{
log_debug ("%s:%s: requesting send for: %p",
SRCNAME, __func__, arg);
if (do_in_ui_thread (REQUEST_SEND_MAIL, arg))
{
MessageBox (NULL,
"Error while requesting send of message.\n"
"Please press the send button again.",
_("GpgOL"),
MB_ICONINFORMATION|MB_OK);
}
return 0;
}
*/
static DWORD WINAPI
request_decrypt (LPVOID arg)
{
log_debug ("%s:%s: requesting decrypt again for: %p",
SRCNAME, __func__, arg);
if (do_in_ui_thread (REQUEST_DECRYPT, arg))
{
log_debug ("%s:%s: second decrypt failed for: %p",
SRCNAME, __func__, arg);
}
return 0;
}
/* The main Invoke function. The return value of this
function does not appear to have any effect on outlook
although I have read in an example somewhere that you
should return S_OK so that outlook continues to handle
the event I have not yet seen any effect by returning
error values here and no MSDN documentation about the
return values.
*/
EVENT_SINK_INVOKE(MailItemEvents)
{
USE_INVOKE_ARGS
if (!m_mail)
{
m_mail = Mail::get_mail_for_item (m_object);
if (!m_mail)
{
log_error ("%s:%s: mail event without mail object known. Bug.",
SRCNAME, __func__);
return S_OK;
}
}
switch(dispid)
{
case Open:
{
LPMESSAGE message;
int draft_flags = 0;
if (!opt.encrypt_default && !opt.sign_default)
{
return S_OK;
}
message = get_oom_base_message (m_object);
if (!message)
{
log_error ("%s:%s: Failed to get message.",
SRCNAME, __func__);
break;
}
if (opt.encrypt_default)
{
draft_flags = 1;
}
if (opt.sign_default)
{
draft_flags += 2;
}
set_gpgol_draft_info_flags (message, draft_flags);
gpgol_release (message);
}
case BeforeRead:
{
if (m_mail->pre_process_message ())
{
log_error ("%s:%s: Pre process message failed.",
SRCNAME, __func__);
}
break;
}
case Read:
{
if (m_mail->decrypt_verify ())
{
log_error ("%s:%s: Decrypt message failed.",
SRCNAME, __func__);
}
if (!opt.enable_smime && m_mail->is_smime ())
{
/* We want to save the mail when it's an smime mail and smime
is disabled to revert it. */
m_mail->set_needs_save (true);
}
break;
}
#if 0
case PropertyChange:
{
wchar_t *prop_name;
const wchar_t **cur;
if (!m_mail->is_crypto_mail ())
{
break;
}
if (!parms || parms->cArgs != 1 ||
parms->rgvarg[0].vt != VT_BSTR ||
!parms->rgvarg[0].bstrVal)
{
log_error ("%s:%s: Unexpected params.",
SRCNAME, __func__);
break;
}
prop_name = parms->rgvarg[0].bstrVal;
for (cur = save_props; *cur; cur++)
{
if (!wcscmp (prop_name, *cur))
{
m_mail->set_needs_save (true);
break;
}
}
log_oom ("%s:%s: Message %p propchange: %ls.",
SRCNAME, __func__, m_object, prop_name);
return S_OK;
}
#endif
case Send:
{
/* This is the only event where we can cancel the send of an
mailitem. But it is too early for us to encrypt as the MAPI
structures are not yet filled (and we don't seem to have a way
to trigger this and it is likely to be impossible)
So the first send event is canceled but we save that we have
seen it in m_send_seen. We then trigger a Save of that item.
The Save causes the Item to be written and we have a chance
to Encrypt it in the AfterWrite event.
If this encryption is successful and we see a send again
we let it pass as then the encrypted data is sent.
The value of m_send_seen is set to false in this case as
we consumed the original send that we canceled. */
if (parms->cArgs != 1 || parms->rgvarg[0].vt != (VT_BOOL | VT_BYREF))
{
log_debug ("%s:%s: Uncancellable send event.",
SRCNAME, __func__);
break;
}
m_mail->update_sender ();
m_mail->encrypt_sign ();
if (m_mail->crypto_successful ())
{
log_debug ("%s:%s: Passing send event for message %p.",
SRCNAME, __func__, m_object);
break;
}
log_debug ("%s:%s: Message %p cancelling send because crypto failed.",
SRCNAME, __func__, m_object);
*(parms->rgvarg[0].pboolVal) = VARIANT_TRUE;
//invoke_oom_method (m_object, "Save", NULL);
return S_OK;
}
case Write:
{
/* This is a bit strange. We sometimes get multiple write events
without a read in between. When we access the message in
the second event it fails and if we cancel the event outlook
crashes. So we have keep the m_needs_wipe state variable
to keep track of that. */
if (parms->cArgs != 1 || parms->rgvarg[0].vt != (VT_BOOL | VT_BYREF))
{
/* This happens in the weird case */
log_debug ("%s:%s: Uncancellable write event.",
SRCNAME, __func__);
break;
}
if (m_mail->is_crypto_mail () && !m_mail->needs_save ())
{
/* We cancel the write event to stop outlook from excessively
syncing our changes.
if smime support is disabled and we still have an smime
mail we also don't want to cancel the write event
to enable reverting this mails.
*/
*(parms->rgvarg[0].pboolVal) = VARIANT_TRUE;
log_oom ("%s:%s: Canceling write event.",
SRCNAME, __func__);
return S_OK;
}
if (m_mail->revert ())
{
/* An error cleaning the mail should not happen normally.
But just in case there is an error we cancel the
write here. */
log_debug ("%s:%s: Failed to remove plaintext.",
SRCNAME, __func__);
*(parms->rgvarg[0].pboolVal) = VARIANT_TRUE;
}
m_mail->set_needs_save (false);
break;
}
case AfterWrite:
{
if (m_decrypt_after_write)
{
char *uuid = strdup (m_mail->get_uuid ().c_str());
HANDLE thread = CreateThread (NULL, 0, request_decrypt,
(LPVOID) uuid, 0, NULL);
log_debug ("Requesting decrypt again for uuid: %s", uuid);
CloseHandle (thread);
}
break;
}
case Close:
{
if (m_mail->is_crypto_mail ())
{
/* Close. This happens when an Opened mail is closed.
To prevent the question of wether or not to save the changes
(Which would save the decrypted data without an event to
prevent it) we save proactively. This happens by set_needs_save
and calling save. Which will revert a mail because we never want
to save unreverted mails.
But as a side effect the mail, if opened in the explorer still will
be reverted, too. So shown as empty. This is bad. To prevent that
we request a decrypt in the AfterWrite event.
Evil Hack: Outlook sends an Unload event after the message is closed
This is not true our Internal Object is kept alive if it is opened
in the explorer. So we ignore the unload event and then check in
the window message handler that checks for decrypt again if the
mail is currently open in the active explorer. If not we delete our
Mail object so that the message is released.
*/
m_mail->set_needs_save (true);
m_decrypt_after_write = true;
invoke_oom_method (m_object, "Save", NULL);
}
}
case Unload:
{
if (!m_decrypt_after_write)
{
log_debug ("%s:%s: Removing Mail for message: %p.",
SRCNAME, __func__, m_object);
delete m_mail;
}
else
{
/* See explanation in Close why this is not broken. */
log_debug ("%s:%s: Ignoring unload for message: %p.",
SRCNAME, __func__, m_object);
m_decrypt_after_write = false;
}
return S_OK;
}
default:
log_oom_extra ("%s:%s: Message:%p Unhandled Event: %lx \n",
SRCNAME, __func__, m_object, dispid);
}
return S_OK;
}
END_EVENT_SINK(MailItemEvents, IID_MailItemEvents)

File Metadata

Mime Type
text/x-c++
Expires
Thu, Nov 6, 3:16 PM (4 h, 1 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
ab/33/391575cf3e6f45ac0da472bce1cb

Event Timeline