xref: /trunk/main/scripting/source/pyprov/mailmerge.py (revision 6e1ccbb0)

# *************************************************************
#
#  Licensed to the Apache Software Foundation (ASF) under one
#  or more contributor license agreements.  See the NOTICE file
#  distributed with this work for additional information
#  regarding copyright ownership.  The ASF licenses this file
#  to you under the Apache License, Version 2.0 (the
#  "License"); you may not use this file except in compliance
#  with the License.  You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing,
#  software distributed under the License is distributed on an
#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
#  KIND, either express or implied.  See the License for the
#  specific language governing permissions and limitations
#  under the License.
#
# *************************************************************

# Caolan McNamara caolanm@redhat.com
# a simple email mailmerge component

# manual installation for hackers, not necessary for users
# cp mailmerge.py /usr/lib/openoffice.org2.0/program
# cd /usr/lib/openoffice.org2.0/program
# ./unopkg add --shared mailmerge.py
# edit ~/.openoffice.org2/user/registry/data/org/openoffice/Office/Writer.xcu
# and change EMailSupported to as follows...
#  <prop oor:name="EMailSupported" oor:type="xs:boolean">
#   <value>true</value>
#  </prop>

import unohelper
import uno
import re

#to implement com::sun::star::mail::XMailServiceProvider
#and
#to implement com.sun.star.mail.XMailMessage

from com.sun.star.mail import XMailServiceProvider
from com.sun.star.mail import XMailService
from com.sun.star.mail import XSmtpService
from com.sun.star.mail import XConnectionListener
from com.sun.star.mail import XAuthenticator
from com.sun.star.mail import XMailMessage
from com.sun.star.mail.MailServiceType import SMTP
from com.sun.star.mail.MailServiceType import POP3
from com.sun.star.mail.MailServiceType import IMAP
from com.sun.star.uno import XCurrentContext
from com.sun.star.lang import IllegalArgumentException
from com.sun.star.lang import EventObject
from com.sun.star.mail import SendMailMessageFailedException

from email.MIMEBase import MIMEBase
from email.Message import Message
from email import Encoders
from email.Header import Header
from email.MIMEMultipart import MIMEMultipart
from email.Utils import formatdate
from email.Utils import parseaddr
from socket import _GLOBAL_DEFAULT_TIMEOUT

import sys, smtplib, imaplib, poplib

dbg = False
out = sys.stderr

class PyMailSMTPService(unohelper.Base, XSmtpService):
    def __init__( self, ctx ):
        self.ctx = ctx
        self.listeners = []
        self.supportedtypes = ('Insecure', 'Ssl')
        self.server = None
        self.connectioncontext = None
        self.notify = EventObject(self)
        if dbg:
            out.write("PyMailSMTPService init\n")
    def addConnectionListener(self, xListener):
        if dbg:
            out.write("PyMailSMTPService addConnectionListener\n")
        self.listeners.append(xListener)
    def removeConnectionListener(self, xListener):
        if dbg:
            out.write("PyMailSMTPService removeConnectionListener\n")
        self.listeners.remove(xListener)
    def getSupportedConnectionTypes(self):
        if dbg:
            out.write("PyMailSMTPService getSupportedConnectionTypes\n")
        return self.supportedtypes
    def connect(self, xConnectionContext, xAuthenticator):
        self.connectioncontext = xConnectionContext
        if dbg:
            out.write("PyMailSMTPService connect\n")

        server = xConnectionContext.getValueByName("ServerName")
        if dbg:
            out.write("ServerName: %s\n" % server)

        port = xConnectionContext.getValueByName("Port")
        if dbg:
            out.write("Port: %d\n" % port)

        tout = xConnectionContext.getValueByName("Timeout")
        if dbg:
            out.write("Timeout is instance of int? %s\n" % isinstance(tout,int))
        if not isinstance(tout,int):
            tout = _GLOBAL_DEFAULT_TIMEOUT
        if dbg:
            out.write("Timeout: %s\n" % str(tout))

        connectiontype = xConnectionContext.getValueByName("ConnectionType")
        if connectiontype.upper() == "SSL":
            if not hasattr(smtplib, "SMTP_SSL"):
                raise IllegalArgumentException("Connection type is not supported: " + connectiontype, self, 1)
            self.server = smtplib.SMTP_SSL(server, port, timeout=tout)
        else:
            self.server = smtplib.SMTP(server, port,timeout=tout)
        if dbg:
            self.server.set_debuglevel(1)

        if dbg:
            out.write("ConnectionType: %s\n" % str(connectiontype))

        if connectiontype.upper() == 'INSECURE':
            self.server.ehlo()
            self.server.starttls()
            self.server.ehlo()

        user = xAuthenticator.getUserName().encode('ascii')
        password = xAuthenticator.getPassword().encode('ascii')
        if user != '':
            if dbg:
                out.write('Logging in, username of %s\n' % user)
            self.server.login(user, password)

        for listener in self.listeners:
            listener.connected(self.notify)
    def disconnect(self):
        if dbg:
            out.write("PyMailSMTPService disconnect\n")
        if self.server:
            self.server.quit()
            self.server = None
        for listener in self.listeners:
            listener.disconnected(self.notify)
    def isConnected(self):
        if dbg:
            out.write("PyMailSMTPService isConnected\n")
        return self.server != None
    def getCurrentConnectionContext(self):
        if dbg:
            out.write("PyMailSMTPService getCurrentConnectionContext\n")
        return self.connectioncontext
    def sendMailMessage(self, xMailMessage):
        COMMASPACE = ', '

        if dbg:
            out.write("PyMailSMTPService sendMailMessage\n")
        recipients = xMailMessage.getRecipients()
        sendermail = xMailMessage.SenderAddress
        sendername = xMailMessage.SenderName
        subject = xMailMessage.Subject
        ccrecipients = xMailMessage.getCcRecipients()
        bccrecipients = xMailMessage.getBccRecipients()
        if dbg:
            out.write("PyMailSMTPService subject %s\n" % subject)
            out.write("PyMailSMTPService from %s\n" % sendername.encode('utf-8'))
            out.write("PyMailSMTPService from %s\n" % sendermail)
            out.write("PyMailSMTPService send to %s\n" % str(recipients))

        attachments = xMailMessage.getAttachments()

        textmsg = Message()

        content = xMailMessage.Body
        flavors = content.getTransferDataFlavors()
        if dbg:
            out.write("PyMailSMTPService flavors len %d\n" % len(flavors))

        #Use first flavor that's sane for an email body
        for flavor in flavors:
            if flavor.MimeType.find('text/html') != -1 or flavor.MimeType.find('text/plain') != -1:
                if dbg:
                    out.write("PyMailSMTPService mimetype is %s\n" % flavor.MimeType)
                textbody = content.getTransferData(flavor)
                try:
                    textbody = textbody.value
                except:
                    pass
                textbody = textbody.encode('utf-8')

                if len(textbody):
                    mimeEncoding = re.sub("charset=.*", "charset=UTF-8", flavor.MimeType)
                    if mimeEncoding.find('charset=UTF-8') == -1:
                        mimeEncoding = mimeEncoding + "; charset=UTF-8"
                    textmsg['Content-Type'] = mimeEncoding
                    textmsg['MIME-Version'] = '1.0'
                    textmsg.set_payload(textbody)

                break

        if (len(attachments)):
            msg = MIMEMultipart()
            msg.epilogue = ''
            msg.attach(textmsg)
        else:
            msg = textmsg

        hdr = Header(sendername, 'utf-8')
        hdr.append('<'+sendermail+'>','us-ascii')
        msg['Subject'] = subject
        msg['From'] = hdr
        msg['To'] = COMMASPACE.join(recipients)
        if len(ccrecipients):
            msg['Cc'] = COMMASPACE.join(ccrecipients)
        if xMailMessage.ReplyToAddress != '':
            msg['Reply-To'] = xMailMessage.ReplyToAddress

        mailerstring = "OpenOffice via Caolan's mailmerge component"
        try:
            ctx = uno.getComponentContext()
            aConfigProvider = ctx.ServiceManager.createInstance("com.sun.star.configuration.ConfigurationProvider")
            prop = uno.createUnoStruct('com.sun.star.beans.PropertyValue')
            prop.Name = "nodepath"
            prop.Value = "/org.openoffice.Setup/Product"
            aSettings = aConfigProvider.createInstanceWithArguments("com.sun.star.configuration.ConfigurationAccess",
                    (prop,))
            mailerstring = aSettings.getByName("ooName") + " " + \
                    aSettings.getByName("ooSetupVersion") + " via Caolan's mailmerge component"
        except:
            pass

        msg['X-Mailer'] = mailerstring
        msg['Date'] = formatdate(localtime=True)

        for attachment in attachments:
            content = attachment.Data
            flavors = content.getTransferDataFlavors()
            flavor = flavors[0]
            ctype = flavor.MimeType
            maintype, subtype = ctype.split('/', 1)
            msgattachment = MIMEBase(maintype, subtype)
            data = content.getTransferData(flavor)
            msgattachment.set_payload(data)
            Encoders.encode_base64(msgattachment)
            fname = attachment.ReadableName
            try:
                fname.encode('ascii')
            except:
                fname = ('utf-8','',fname.encode('utf-8'))
            msgattachment.add_header('Content-Disposition', 'attachment', \
                    filename=fname)
            msg.attach(msgattachment)

        uniquer = {}
        for key in recipients:
            uniquer[key] = True
        if len(ccrecipients):
            for key in ccrecipients:
                uniquer[key] = True
        if len(bccrecipients):
            for key in bccrecipients:
                uniquer[key] = True
        truerecipients = list(uniquer.keys())

        if dbg:
            out.write("PyMailSMTPService recipients are %s\n" % str(truerecipients))

        self.server.sendmail(sendermail, truerecipients, msg.as_string())

class PyMailIMAPService(unohelper.Base, XMailService):
    def __init__( self, ctx ):
        self.ctx = ctx
        self.listeners = []
        self.supportedtypes = ('Insecure', 'Ssl')
        self.server = None
        self.connectioncontext = None
        self.notify = EventObject(self)
        if dbg:
            out.write("PyMailIMAPService init\n")
    def addConnectionListener(self, xListener):
        if dbg:
            out.write("PyMailIMAPService addConnectionListener\n")
        self.listeners.append(xListener)
    def removeConnectionListener(self, xListener):
        if dbg:
            out.write("PyMailIMAPService removeConnectionListener\n")
        self.listeners.remove(xListener)
    def getSupportedConnectionTypes(self):
        if dbg:
            out.write("PyMailIMAPService getSupportedConnectionTypes\n")
        return self.supportedtypes
    def connect(self, xConnectionContext, xAuthenticator):
        if dbg:
            out.write("PyMailIMAPService connect\n")

        self.connectioncontext = xConnectionContext
        server = xConnectionContext.getValueByName("ServerName")
        if dbg:
            out.write("Server: %s\n" % server)
        port = xConnectionContext.getValueByName("Port")
        if dbg:
            out.write("Port: %d\n" % port)
        connectiontype = xConnectionContext.getValueByName("ConnectionType")
        if dbg:
            out.write("Connection type: %s\n" % connectiontype)
        out.write("BEFORE\n")
        if connectiontype.upper() == 'SSL':
            self.server = imaplib.IMAP4_SSL(server, port)
        else:
            self.server = imaplib.IMAP4(server, port)
        out.write("AFTER\n")

        user = xAuthenticator.getUserName().encode('ascii')
        password = xAuthenticator.getPassword().encode('ascii')
        if user != '':
            if dbg:
                out.write('Logging in, username of %s\n' % user)
            self.server.login(user, password)

        for listener in self.listeners:
            listener.connected(self.notify)
    def disconnect(self):
        if dbg:
            out.write("PyMailIMAPService disconnect\n")
        if self.server:
            self.server.logout()
            self.server = None
        for listener in self.listeners:
            listener.disconnected(self.notify)
    def isConnected(self):
        if dbg:
            out.write("PyMailIMAPService isConnected\n")
        return self.server != None
    def getCurrentConnectionContext(self):
        if dbg:
            out.write("PyMailIMAPService getCurrentConnectionContext\n")
        return self.connectioncontext

class PyMailPOP3Service(unohelper.Base, XMailService):
    def __init__( self, ctx ):
        self.ctx = ctx
        self.listeners = []
        self.supportedtypes = ('Insecure', 'Ssl')
        self.server = None
        self.connectioncontext = None
        self.notify = EventObject(self)
        if dbg:
            out.write("PyMailPOP3Service init\n")
    def addConnectionListener(self, xListener):
        if dbg:
            out.write("PyMailPOP3Service addConnectionListener\n")
        self.listeners.append(xListener)
    def removeConnectionListener(self, xListener):
        if dbg:
            out.write("PyMailPOP3Service removeConnectionListener\n")
        self.listeners.remove(xListener)
    def getSupportedConnectionTypes(self):
        if dbg:
            out.write("PyMailPOP3Service getSupportedConnectionTypes\n")
        return self.supportedtypes
    def connect(self, xConnectionContext, xAuthenticator):
        if dbg:
            out.write("PyMailPOP3Service connect\n")

        self.connectioncontext = xConnectionContext
        server = xConnectionContext.getValueByName("ServerName")
        if dbg:
            out.write("Server: %s\n" % server)
        port = xConnectionContext.getValueByName("Port")
        if dbg:
            out.write("Port: %s\n" % port)
        connectiontype = xConnectionContext.getValueByName("ConnectionType")
        if dbg:
            out.write("Connection type: %s\n" % str(connectiontype))
        out.write("BEFORE\n")
        if connectiontype.upper() == 'SSL':
            self.server = poplib.POP3_SSL(server, port)
        else:
            tout = xConnectionContext.getValueByName("Timeout")
            if dbg:
                out.write("Timeout is instance of int? %s\n" % isinstance(tout,int))
            if not isinstance(tout,int):
                tout = _GLOBAL_DEFAULT_TIMEOUT
            if dbg:
                out.write("Timeout: %s\n" % str(tout))
            self.server = poplib.POP3(server, port, timeout=tout)
        out.write("AFTER\n")

        user = xAuthenticator.getUserName().encode('ascii')
        password = xAuthenticator.getPassword().encode('ascii')
        if dbg:
            out.write('Logging in, username of %s\n' % user)
        self.server.user(user)
        self.server.pass_(password)

        for listener in self.listeners:
            listener.connected(self.notify)
    def disconnect(self):
        if dbg:
            out.write("PyMailPOP3Service disconnect\n")
        if self.server:
            self.server.quit()
            self.server = None
        for listener in self.listeners:
            listener.disconnected(self.notify)
    def isConnected(self):
        if dbg:
            out.write("PyMailPOP3Service isConnected\n")
        return self.server != None
    def getCurrentConnectionContext(self):
        if dbg:
            out.write("PyMailPOP3Service getCurrentConnectionContext\n")
        return self.connectioncontext

class PyMailServiceProvider(unohelper.Base, XMailServiceProvider):
    def __init__( self, ctx ):
        if dbg:
            out.write("PyMailServiceProvider init\n")
        self.ctx = ctx
    def create(self, aType):
        if dbg:
            out.write("PyMailServiceProvider create with %s\n" % aType)
        if aType == SMTP:
            return PyMailSMTPService(self.ctx);
        elif aType == POP3:
            return PyMailPOP3Service(self.ctx);
        elif aType == IMAP:
            return PyMailIMAPService(self.ctx);
        else:
            out.write("PyMailServiceProvider, unknown TYPE %s\n" % aType)

class PyMailMessage(unohelper.Base, XMailMessage):
    def __init__( self, ctx, sTo='', sFrom='', Subject='', Body=None, aMailAttachment=None ):
        if dbg:
            out.write("PyMailMessage init\n")
        self.ctx = ctx

        self.recipients = [sTo]
        self.ccrecipients = []
        self.bccrecipients = []
        self.aMailAttachments = []
        if aMailAttachment != None:
            self.aMailAttachments.append(aMailAttachment)

        self.SenderName, self.SenderAddress = parseaddr(sFrom)
        self.ReplyToAddress = sFrom
        self.Subject = Subject
        self.Body = Body
        if dbg:
            out.write("post PyMailMessage init\n")
    def addRecipient( self, recipient ):
        if dbg:
            out.write("PyMailMessage.addRecipient%s\n" % recipient)
        self.recipients.append(recipient)
    def addCcRecipient( self, ccrecipient ):
        if dbg:
            out.write("PyMailMessage.addCcRecipient%s\n" % ccrecipient)
        self.ccrecipients.append(ccrecipient)
    def addBccRecipient( self, bccrecipient ):
        if dbg:
            out.write("PyMailMessage.addBccRecipient%s\n" % bccrecipient)
        self.bccrecipients.append(bccrecipient)
    def getRecipients( self ):
        if dbg:
            out.write("PyMailMessage.getRecipients%s\n" % self.recipients)
        return tuple(self.recipients)
    def getCcRecipients( self ):
        if dbg:
            out.write("PyMailMessage.getCcRecipients%s\n" % self.ccrecipients)
        return tuple(self.ccrecipients)
    def getBccRecipients( self ):
        if dbg:
            out.write("PyMailMessage.getBccRecipients%s\n" % self.bccrecipients)
        return tuple(self.bccrecipients)
    def addAttachment( self, aMailAttachment ):
        if dbg:
            out.write("PyMailMessage.addAttachment\n")
        self.aMailAttachments.append(aMailAttachment)
    def getAttachments( self ):
        if dbg:
            out.write("PyMailMessage.getAttachments\n")
        return tuple(self.aMailAttachments)


# pythonloader looks for a static g_ImplementationHelper variable
g_ImplementationHelper = unohelper.ImplementationHelper()
g_ImplementationHelper.addImplementation( \
        PyMailServiceProvider, "org.openoffice.pyuno.MailServiceProvider",
                ("com.sun.star.mail.MailServiceProvider",),)
g_ImplementationHelper.addImplementation( \
        PyMailMessage, "org.openoffice.pyuno.MailMessage",
                ("com.sun.star.mail.MailMessage",),)