diff --git a/src/gpgoladdin.cpp b/src/gpgoladdin.cpp
index 6f4c4a4..93a0f7a 100644
--- a/src/gpgoladdin.cpp
+++ b/src/gpgoladdin.cpp
@@ -1,972 +1,968 @@
/* gpgoladdin.cpp - Connect GpgOL to Outlook as an addin
* Copyright (C) 2013 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 .
*/
#ifdef HAVE_CONFIG_H
#include
#endif
#include
#include
#include
#include "util.h"
#include "gpgoladdin.h"
#include "mymapi.h"
#include "mymapitags.h"
#include "myexchext.h"
#include "common.h"
#include "display.h"
#include "msgcache.h"
#include "engine.h"
#include "engine-assuan.h"
#include "mapihelp.h"
#include "oomhelp.h"
#include "olflange.h"
#include "gpgol-ids.h"
#include "ribbon-callbacks.h"
#include "eventsinks.h"
#include "eventsink.h"
#include "windowmessages.h"
#include "mail.h"
#define ICON_SIZE_LARGE 32
#define ICON_SIZE_NORMAL 16
/* We use UTF-8 internally. */
#undef _
#define _(a) utf8_gettext (a)
ULONG addinLocks = 0;
/* This is the main entry point for the addin
Outlook uses this function to query for an Object implementing
the IClassFactory interface.
*/
STDAPI DllGetClassObject (REFCLSID rclsid, REFIID riid, LPVOID* ppvObj)
{
if (!ppvObj)
return E_POINTER;
*ppvObj = NULL;
if (rclsid != CLSID_GPGOL)
return CLASS_E_CLASSNOTAVAILABLE;
/* Let the factory give the requested interface. */
GpgolAddinFactory* factory = new GpgolAddinFactory();
if (!factory)
return E_OUTOFMEMORY;
HRESULT hr = factory->QueryInterface (riid, ppvObj);
if(FAILED(hr))
{
*ppvObj = NULL;
delete factory;
}
return hr;
}
STDAPI DllCanUnloadNow()
{
return addinLocks == 0 ? S_OK : S_FALSE;
}
/* Class factory */
STDMETHODIMP GpgolAddinFactory::QueryInterface (REFIID riid, LPVOID* ppvObj)
{
HRESULT hr = S_OK;
*ppvObj = NULL;
if ((IID_IUnknown == riid) || (IID_IClassFactory == riid))
*ppvObj = static_cast(this);
else
{
hr = E_NOINTERFACE;
LPOLESTR sRiid = NULL;
StringFromIID (riid, &sRiid);
/* Should not happen */
log_debug ("GpgolAddinFactory queried for unknown interface: %S \n", sRiid);
}
if (*ppvObj)
((LPUNKNOWN)*ppvObj)->AddRef();
return hr;
}
/* This actually creates the instance of our COM object */
STDMETHODIMP GpgolAddinFactory::CreateInstance (LPUNKNOWN punk, REFIID riid,
LPVOID* ppvObj)
{
(void)punk;
*ppvObj = NULL;
GpgolAddin* obj = new GpgolAddin();
if (NULL == obj)
return E_OUTOFMEMORY;
HRESULT hr = obj->QueryInterface (riid, ppvObj);
if (FAILED(hr))
{
LPOLESTR sRiid = NULL;
StringFromIID (riid, &sRiid);
fprintf(stderr, "failed to create instance for: %S", sRiid);
}
return hr;
}
/* GpgolAddin definition */
/* Constructor of GpgolAddin
Initializes members and creates the interface objects for the new
context. Does the DLL initialization if it has not been done
before.
The ref count is set by the factory after creation.
*/
GpgolAddin::GpgolAddin (void) : m_lRef(0), m_application(0),
m_addin(0), m_applicationEventSink(0), m_disabled(false)
{
read_options ();
/* RibbonExtender is it's own object to avoid the pitfalls of
multiple inheritance
*/
m_ribbonExtender = new GpgolRibbonExtender();
}
GpgolAddin::~GpgolAddin (void)
{
- log_debug ("%s:%s: Releasing Extender;",
- SRCNAME, __func__);
- m_ribbonExtender->Release ();
-
log_debug ("%s:%s: Releasing Application Event Sink;",
SRCNAME, __func__);
m_applicationEventSink->Release();
if (!m_disabled)
{
engine_deinit ();
write_options ();
}
log_debug ("%s:%s: Object deleted\n", SRCNAME, __func__);
}
STDMETHODIMP
GpgolAddin::QueryInterface (REFIID riid, LPVOID* ppvObj)
{
HRESULT hr = S_OK;
*ppvObj = NULL;
if (m_disabled)
return E_NOINTERFACE;
if ((riid == IID_IUnknown) || (riid == IID_IDTExtensibility2) ||
(riid == IID_IDispatch))
{
*ppvObj = (LPUNKNOWN) this;
}
else if (riid == IID_IRibbonExtensibility)
{
return m_ribbonExtender->QueryInterface (riid, ppvObj);
}
else
{
hr = E_NOINTERFACE;
#if 0
LPOLESTR sRiid = NULL;
StringFromIID(riid, &sRiid);
log_debug ("%s:%s: queried for unimplmented interface: %S",
SRCNAME, __func__, sRiid);
#endif
}
if (*ppvObj)
((LPUNKNOWN)*ppvObj)->AddRef();
return hr;
}
STDMETHODIMP
GpgolAddin::OnConnection (LPDISPATCH Application, ext_ConnectMode ConnectMode,
LPDISPATCH AddInInst, SAFEARRAY ** custom)
{
(void)custom;
char* version;
log_debug ("%s:%s: this is GpgOL %s\n",
SRCNAME, __func__, PACKAGE_VERSION);
log_debug ("%s:%s: in Outlook %s\n",
SRCNAME, __func__, gpgme_check_version (NULL));
m_application = Application;
m_application->AddRef();
m_addin = AddInInst;
version = get_oom_string (Application, "Version");
log_debug ("%s:%s: using GPGME %s\n",
SRCNAME, __func__, version);
g_ol_version_major = atoi (version);
if (!version || !strlen (version) ||
(strncmp (version, "14", 2) &&
strncmp (version, "15", 2) &&
strncmp (version, "16", 2)))
{
m_disabled = true;
log_debug ("%s:%s: Disabled addin for unsupported version.",
SRCNAME, __func__);
xfree (version);
return S_OK;
}
engine_init ();
if (ConnectMode != ext_cm_Startup)
{
OnStartupComplete (custom);
}
return S_OK;
}
STDMETHODIMP
GpgolAddin::OnDisconnection (ext_DisconnectMode RemoveMode,
SAFEARRAY** custom)
{
(void)custom;
(void)RemoveMode;
log_debug ("%s:%s: cleaning up GpgolAddin object;",
SRCNAME, __func__);
/* Doing the wipe in the dtor is too late. Outlook
does not allow us any OOM calls then and only returns
"Unexpected error" in that case. Weird. */
if (Mail::wipe_all_mails ())
{
MessageBox (NULL,
_("Failed to remove plaintext from at least one message.\n\n"
"Until GpgOL is activated again it is possible that the "
"plaintext of messages decrypted in this Session is saved "
"or transfered back to your mailserver."),
_("GpgOL"),
MB_ICONINFORMATION|MB_OK);
}
write_options();
return S_OK;
}
STDMETHODIMP
GpgolAddin::OnAddInsUpdate (SAFEARRAY** custom)
{
(void)custom;
return S_OK;
}
STDMETHODIMP
GpgolAddin::OnStartupComplete (SAFEARRAY** custom)
{
(void)custom;
TRACEPOINT;
install_forms ();
if (!create_responder_window())
{
log_error ("%s:%s: Failed to create the responder window;",
SRCNAME, __func__);
}
if (m_application)
{
m_applicationEventSink = install_ApplicationEvents_sink(m_application);
return S_OK;
}
/* Should not happen as OnConnection should be called before */
log_error ("%s:%s: no application set;",
SRCNAME, __func__);
return E_NOINTERFACE;
}
STDMETHODIMP
GpgolAddin::OnBeginShutdown (SAFEARRAY * * custom)
{
(void)custom;
TRACEPOINT;
return S_OK;
}
STDMETHODIMP
GpgolAddin::GetTypeInfoCount (UINT *r_count)
{
*r_count = 0;
TRACEPOINT; /* Should not happen */
return S_OK;
}
STDMETHODIMP
GpgolAddin::GetTypeInfo (UINT iTypeInfo, LCID lcid,
LPTYPEINFO *r_typeinfo)
{
(void)iTypeInfo;
(void)lcid;
(void)r_typeinfo;
TRACEPOINT; /* Should not happen */
return S_OK;
}
STDMETHODIMP
GpgolAddin::GetIDsOfNames (REFIID riid, LPOLESTR *rgszNames,
UINT cNames, LCID lcid,
DISPID *rgDispId)
{
(void)riid;
(void)rgszNames;
(void)cNames;
(void)lcid;
(void)rgDispId;
TRACEPOINT; /* Should not happen */
return E_NOINTERFACE;
}
STDMETHODIMP
GpgolAddin::Invoke (DISPID dispid, REFIID riid, LCID lcid,
WORD flags, DISPPARAMS *parms, VARIANT *result,
EXCEPINFO *exepinfo, UINT *argerr)
{
USE_INVOKE_ARGS
TRACEPOINT; /* Should not happen */
return DISP_E_MEMBERNOTFOUND;
}
/* Definition of GpgolRibbonExtender */
GpgolRibbonExtender::GpgolRibbonExtender (void) : m_lRef(0)
{
}
GpgolRibbonExtender::~GpgolRibbonExtender (void)
{
log_debug ("%s:%s: cleaning up GpgolRibbonExtender object;",
SRCNAME, __func__);
log_debug ("%s:%s: Object deleted\n", SRCNAME, __func__);
}
STDMETHODIMP
GpgolRibbonExtender::QueryInterface(REFIID riid, LPVOID* ppvObj)
{
HRESULT hr = S_OK;
*ppvObj = NULL;
if ((riid == IID_IUnknown) || (riid == IID_IRibbonExtensibility) ||
(riid == IID_IDispatch))
{
*ppvObj = (LPUNKNOWN) this;
}
else
{
LPOLESTR sRiid = NULL;
StringFromIID (riid, &sRiid);
log_debug ("%s:%s: queried for unknown interface: %S",
SRCNAME, __func__, sRiid);
}
if (*ppvObj)
((LPUNKNOWN)*ppvObj)->AddRef();
return hr;
}
STDMETHODIMP
GpgolRibbonExtender::GetTypeInfoCount (UINT *r_count)
{
*r_count = 0;
TRACEPOINT; /* Should not happen */
return S_OK;
}
STDMETHODIMP
GpgolRibbonExtender::GetTypeInfo (UINT iTypeInfo, LCID lcid,
LPTYPEINFO *r_typeinfo)
{
(void)iTypeInfo;
(void)lcid;
(void)r_typeinfo;
TRACEPOINT; /* Should not happen */
return S_OK;
}
/* Good documentation of what this function is supposed to do can
be found at: http://msdn.microsoft.com/en-us/library/cc237568.aspx
There is also a very good blog explaining how Ribbon Extensibility
is supposed to work.
http://blogs.msdn.com/b/andreww/archive/2007/03/09/
why-is-it-so-hard-to-shim-iribbonextensibility.aspx
*/
#define ID_MAPPER(name,id) \
if (!wcscmp (rgszNames[i], name)) \
{ \
found = true; \
rgDispId[i] = id; \
break; \
} \
STDMETHODIMP
GpgolRibbonExtender::GetIDsOfNames (REFIID riid, LPOLESTR *rgszNames,
UINT cNames, LCID lcid,
DISPID *rgDispId)
{
(void)riid;
(void)lcid;
bool found = false;
if (!rgszNames || !cNames || !rgDispId)
{
return E_POINTER;
}
for (unsigned int i = 0; i < cNames; i++)
{
log_debug ("%s:%s: GetIDsOfNames for: %S",
SRCNAME, __func__, rgszNames[i]);
/* How this is supposed to work with cNames > 1 is unknown,
but we can just say that we won't support callbacks with
different parameters and just match the name (the first element)
and we give it one of our own dispIds's that are later handled in
the invoke part */
ID_MAPPER (L"attachmentDecryptCallback", ID_CMD_DECRYPT)
ID_MAPPER (L"encryptSelection", ID_CMD_ENCRYPT_SELECTION)
ID_MAPPER (L"decryptSelection", ID_CMD_DECRYPT_SELECTION)
ID_MAPPER (L"startCertManager", ID_CMD_CERT_MANAGER)
ID_MAPPER (L"btnCertManager", ID_BTN_CERTMANAGER)
ID_MAPPER (L"btnDecrypt", ID_BTN_DECRYPT)
ID_MAPPER (L"btnDecryptLarge", ID_BTN_DECRYPT_LARGE)
ID_MAPPER (L"btnEncrypt", ID_BTN_ENCRYPT)
ID_MAPPER (L"btnEncryptLarge", ID_BTN_ENCRYPT_LARGE)
ID_MAPPER (L"btnEncryptFileLarge", ID_BTN_ENCSIGN_LARGE)
ID_MAPPER (L"btnSignLarge", ID_BTN_SIGN_LARGE)
ID_MAPPER (L"btnVerifyLarge", ID_BTN_VERIFY_LARGE)
ID_MAPPER (L"encryptBody", ID_CMD_ENCRYPT_BODY)
ID_MAPPER (L"decryptBody", ID_CMD_DECRYPT_BODY)
ID_MAPPER (L"addEncSignedAttachment", ID_CMD_ATT_ENCSIGN_FILE)
ID_MAPPER (L"addEncAttachment", ID_CMD_ATT_ENC_FILE)
ID_MAPPER (L"signBody", ID_CMD_SIGN_BODY)
ID_MAPPER (L"verifyBody", ID_CMD_VERIFY_BODY)
/* MIME support: */
ID_MAPPER (L"encryptMime", ID_CMD_MIME_ENCRYPT)
ID_MAPPER (L"signMime", ID_CMD_MIME_SIGN)
}
if (cNames > 1)
{
log_debug ("More then one name provided. Should not happen");
}
return found ? S_OK : E_NOINTERFACE;
}
STDMETHODIMP
GpgolRibbonExtender::Invoke (DISPID dispid, REFIID riid, LCID lcid,
WORD flags, DISPPARAMS *parms, VARIANT *result,
EXCEPINFO *exepinfo, UINT *argerr)
{
USE_INVOKE_ARGS
log_debug ("%s:%s: enter with dispid: %x",
SRCNAME, __func__, (int)dispid);
if (!(flags & DISPATCH_METHOD))
{
log_debug ("%s:%s: not called in method mode. Bailing out.",
SRCNAME, __func__);
return DISP_E_MEMBERNOTFOUND;
}
switch (dispid)
{
case ID_CMD_DECRYPT:
/* We can assume that this points to an implementation of
IRibbonControl as we know the callback dispid. */
return decryptAttachments (parms->rgvarg[0].pdispVal);
case ID_CMD_ENCRYPT_SELECTION:
return encryptSelection (parms->rgvarg[0].pdispVal);
case ID_CMD_DECRYPT_SELECTION:
return decryptSelection (parms->rgvarg[0].pdispVal);
case ID_CMD_CERT_MANAGER:
return startCertManager (parms->rgvarg[0].pdispVal);
case ID_CMD_ENCRYPT_BODY:
return encryptBody (parms->rgvarg[0].pdispVal);
case ID_CMD_DECRYPT_BODY:
return decryptBody (parms->rgvarg[0].pdispVal);
case ID_CMD_ATT_ENCSIGN_FILE:
return addEncSignedAttachment (parms->rgvarg[0].pdispVal);
case ID_CMD_ATT_ENC_FILE:
return addEncAttachment (parms->rgvarg[0].pdispVal);
case ID_CMD_SIGN_BODY:
return signBody (parms->rgvarg[0].pdispVal);
case ID_CMD_VERIFY_BODY:
return verifyBody (parms->rgvarg[0].pdispVal);
case ID_CMD_MIME_SIGN:
return mime_sign (parms->rgvarg[1].pdispVal);
case ID_CMD_MIME_ENCRYPT:
return mime_encrypt (parms->rgvarg[1].pdispVal);
case ID_BTN_CERTMANAGER:
case ID_BTN_ENCRYPT:
case ID_BTN_DECRYPT:
case ID_BTN_DECRYPT_LARGE:
case ID_BTN_ENCRYPT_LARGE:
case ID_BTN_ENCSIGN_LARGE:
case ID_BTN_SIGN_LARGE:
case ID_BTN_VERIFY_LARGE:
return getIcon (dispid, result);
}
log_debug ("%s:%s: leave", SRCNAME, __func__);
return DISP_E_MEMBERNOTFOUND;
}
#ifdef MIME_SEND
/* Returns the XML markup for the various RibbonID's
The custom ui syntax is documented at:
http://msdn.microsoft.com/en-us/library/dd926139%28v=office.12%29.aspx
The outlook specific elements are documented at:
http://msdn.microsoft.com/en-us/library/office/ee692172%28v=office.14%29.aspx
*/
STDMETHODIMP
GpgolRibbonExtender::GetCustomUI (BSTR RibbonID, BSTR * RibbonXml)
{
char * buffer = NULL;
const char *certManagerTTip =
_("Start the Certificate Management Software");
const char *certManagerSTip =
_("Open GPA or Kleopatra to manage your certificates. "
"You can use this you to generate your "
"own certificates. ");
const char *encryptTTip =
_("Encrypt the message.");
const char *encryptSTip =
_("Encrypts the message and all attachments before sending.");
const char *signTTip =
_("Sign the message.");
const char *signSTip =
_("Sign the message and all attchments before sending.");
log_debug ("%s:%s: GetCustomUI for id: %ls", SRCNAME, __func__, RibbonID);
if (!RibbonXml || !RibbonID)
return E_POINTER;
if (!wcscmp (RibbonID, L"Microsoft.Outlook.Mail.Compose"))
{
asprintf (&buffer,
""
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
"", _("GpgOL"), _("General"),
_("Start Certificate Manager"), certManagerTTip, certManagerSTip,
_("GnuPG"),
_("Encrypt"), encryptTTip, encryptSTip,
_("Sign"), signTTip, signSTip
);
}
if (buffer)
{
wchar_t *wbuf = utf8_to_wchar2 (buffer, strlen(buffer));
xfree (buffer);
*RibbonXml = SysAllocString (wbuf);
xfree (wbuf);
}
else
*RibbonXml = NULL;
return S_OK;
}
#else /* MIME_SEND */
/* This is the old pre-mime adding UI code. It will be removed once we have a
stable version that can also send mime messages.
*/
STDMETHODIMP
GpgolRibbonExtender::GetCustomUI (BSTR RibbonID, BSTR * RibbonXml)
{
TRACEPOINT
char *buffer = NULL;
const char *certManagerTTip =
_("Start the Certificate Management Software");
const char *certManagerSTip =
_("Open GPA or Kleopatra to manage your certificates. "
"You can use this you to generate your "
"own certificates. ");
const char *encryptTextTTip =
_("Encrypt the text of the message");
const char *encryptTextSTip =
_("Choose the certificates for which the message "
"should be encrypted and replace the text "
"with the encrypted message.");
const char *encryptFileTTip =
_("Add a file as an encrypted attachment");
const char *encryptFileSTip =
_("Encrypts a file and adds it as an attachment to the "
"message. ");
const char *encryptSignFileTTip =
_("Add a file as an encrypted attachment with a signature");
const char *encryptSignFileSTip =
_("Encrypts a file, signs it and adds both the encrypted file "
"and the signature as attachments to the message. ");
const char *decryptTextTTip=
_("Decrypt the message");
const char *decryptTextSTip =
_("Look for PGP or S/MIME encrypted data in the message text "
"and decrypt it.");
const char *signTextTTip =
_("Add a signature of the message");
const char *signTextSTip =
_("Appends a signed copy of the message text in an opaque signature. "
"An opaque signature ensures that the signed text is not modified by "
"embedding it in the signature itself. "
"The combination of the signed message text and your signature is "
"added below the plain text. "
"The message will not be encrypted!");
TRACEPOINT
log_debug ("%s:%s: GetCustomUI for id: %ls", SRCNAME, __func__, RibbonID);
if (!RibbonXml)
return E_POINTER;
TRACEPOINT
if (!wcscmp (RibbonID, L"Microsoft.Outlook.Mail.Compose"))
{
TRACEPOINT
asprintf (&buffer,
""
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
""
"", _("GpgOL"), _("General"),
_("Start Certificate Manager"), certManagerTTip, certManagerSTip,
_("Textbody"),
_("Encrypt"), encryptTextTTip, encryptTextSTip,
_("Decrypt"), decryptTextTTip, decryptTextSTip,
_("Sign"), signTextTTip, signTextSTip,
_("Verify"),
_("Attachments"),
_("Encrypted file"), encryptFileTTip, encryptFileSTip,
_("Encrypted file and Signature"), encryptSignFileTTip, encryptSignFileSTip,
_("Encrypt"), _("Decrypt")
);
}
else if (!wcscmp (RibbonID, L"Microsoft.Outlook.Mail.Read"))
{
TRACEPOINT
asprintf (&buffer,
""
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
""
""
" "
" "
" "
""
"",
_("GpgOL"), _("General"),
_("Start Certificate Manager"), certManagerTTip, certManagerSTip,
_("Textbody"),
_("Decrypt"), decryptTextTTip, decryptTextSTip,
_("Verify"),
_("GpgOL"), _("Save and decrypt"),
_("Decrypt"),
_("Decrypt"));
}
else if (!wcscmp (RibbonID, L"Microsoft.Outlook.Explorer"))
{
TRACEPOINT
asprintf (&buffer,
""
" "
" "
" "
" "
" "
/* This would be totally nice but Outlook
saves the decrypted text aftewards automatically.
Yay,..
" "
" "
*/
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
" "
/*
There appears to be no way to access the word editor
/ get the selected text from that Context.
" "
" "
*/
" "
" "
" "
"",
_("GpgOL"), _("General"),
_("Start Certificate Manager"), certManagerTTip, certManagerSTip,
/*_("Mail Body"), _("Decrypt"),*/
_("GpgOL"), _("Save and decrypt"),/*_("Decrypt"), */
_("Save and decrypt"));
}
TRACEPOINT
if (buffer)
{
TRACEPOINT
wchar_t *wbuf = utf8_to_wchar2 (buffer, strlen(buffer));
xfree (buffer);
TRACEPOINT
*RibbonXml = SysAllocString (wbuf);
TRACEPOINT
xfree (wbuf);
TRACEPOINT
}
else
*RibbonXml = NULL;
TRACEPOINT
return S_OK;
}
#endif /* MIME_SEND */