openoffice/officehelper.py

   1 # -*- mode: python ; coding: utf-8 -*-
   2 #
   3 # Copyright (c) 2008 by Hartmut Goebel <h.goebel@goebel-consult.de>
   4 # Licenced under the GNU General Public License v3 (GPLv3)
   5 # see file LICENSE-gpl-3.0.txt
   6 #
   7 # Originally based on officehelper.py 1.2 comming with OOo
   8 #
   9
  10 __author__ = "Hartmut Goebel <h.goebel@goebel-consult.de>"
  11 __copyright__ = "Copyright (c) 2008 by Hartmut Goebel <h.goebel@goebel-consult.de>"
  12 __licence__ = "GPLv3 - GNU General Public License v3"
  13
  14 import os
  15 import random
  16 import sys
  17 from time import sleep
  18
  19 import uno
  20 from com.sun.star.connection import NoConnectException
  21
  22 class BootstrapException(Exception): pass
  23
  24 __soffice_executable = None
  25
  26 def _build_connect_string(pipename=None, host=None, port=None):
  27     """
  28     Returns a connection description string to be used to connect to
  29     this process via UnoUrlResolver().resolve().
  30
  31     Pass either a pipename for a named pipe or host and port for a
  32     socket connection.
  33
  34     Note: You should use the naemd pipe whenever possible, since
  35     socket are unsecure: Everybody can connect to a socket and access
  36     your documents without any access control.
  37     """
  38     if pipename:
  39         connectString = "pipe,name=%s" % pipename
  40     else:
  41         connectString = 'socket'
  42         if host: connectString += ',host='+str(host)
  43         if port: connectString += ',port='+str(port)
  44     return connectString
  45
  46
  47 def _build_cmd_args(connectString, unaccept=False):
  48     """
  49     Returns command arguments (including executable and options)
  50     suitable for staring an background OOo instance listening on named
  51     pipe or socket descripted in parameter 'connectString'.
  52
  53     If unaccept is true, the parmeter '-accept=...' will become
  54     '-unaccept=...' for making the instance unlisten.
  55     """
  56
  57     def find_executable():
  58         """
  59         Find 'soffice' executable.
  60
  61         Normaly soffice should be in the same directory as uno.py, but eg.
  62         Debian does not obaj to this convention. Thus we need to search
  63         the executable.
  64         """
  65         global __soffice_executable
  66         if __soffice_executable:
  67             return __soffice_executable
  68         for p in [os.path.dirname(uno.__file__),
  69                   '/usr/lib/openoffice/program',
  70                   '/usr/bin',
  71                   '/usr/local/bin',
  72                   ]:
  73             office = os.path.join(p, "soffice")
  74             if os.path.exists(office):
  75                 break
  76         else:
  77             pathes = glob.glob('/usr/lib/ooo-[234].*/program/soffice')
  78             if not pathes:
  79                 raise BootstrapExceptions('soffice executable not found')
  80             pathes.sort(reverse=True)
  81             office = pathes[0]
  82         __soffice_executable = office
  83         return office
  84
  85     # soffice script used on *ix, Mac; soffice.exe used on Windoof
  86     office = find_executable()
  87     if sys.platform.startswith("win"):
  88         office += ".exe"
  89
  90     # -headless includes -invisible (which includes -nologo -nodefault)
  91     accept = unaccept and '-unaccept' or '-accept'
  92     cmdArray = (office,
  93                 "-headless", "-norestore", "%s=%s;urp;" %
  94                 (accept, connectString))
  95     return cmdArray
  96
  97
  98 def _start_OOo(connectString):
  99     """Start an OOo process listening on named pipe or socket
 100     descripted in parameter 'connectString'.
 101     """
 102     cmdArray = _build_cmd_args(connectString)
 103     # Start the office proces, don't check for exit status since
 104     # an exception is caught anyway if the office terminates
 105     # unexpectedly.
 106     return os.spawnv(os.P_NOWAIT, cmdArray[0], cmdArray)
 107
 108
 109 def connect(connectString):
 110     """
 111     Connect to an OOo instance listening on named pipe or socket
 112     descripted in parameter 'connectString'.
 113     """
 114     localContext = uno.getComponentContext()
 115     resolver = localContext.ServiceManager.createInstanceWithContext(
 116         "com.sun.star.bridge.UnoUrlResolver", localContext)
 117     connect = "uno:" + connectString + ";urp;StarOffice.ComponentContext"
 118
 119     # Wait until an office is started, but loop only 20 times (10 seconds)
 120     for i in range(20):
 121         try:
 122             context = resolver.resolve(connect)
 123             break
 124         except NoConnectException:
 125             sleep(0.5)  # Sleep 1/2 second.
 126     else:
 127         # for-loop completed without 'break' (this is: no connection found)
 128         raise BootstrapException("Cannot connect to soffice server.")
 129
 130     return context
 131
 132
 133 def bootstrap(pipename=None, host=None, port=None):
 134     """Bootstrap OOo and PyUNO Runtime.
 135
 136     If either pipename, host or port are given, connect to the OOo
 137     instance listening on this pipe or hosst/port. (This is mainly for
 138     convenience, so programms do not need to distinguish these cases.)
 139
 140     If non of these parameters are give, the soffice process is
 141     started opening a named pipe of random name, then the local
 142     context is used to access the pipe.
 143
 144     This function directly returns the remote component context, from
 145     whereon you can get the ServiceManager by calling
 146     getServiceManager() on the returned object.
 147     """
 148     if pipename or host or port:
 149         connectString = _build_connect_string(pipename=pipename,
 150                                               host=host, port=port)
 151     else:
 152         # Generate a random pipe name.
 153         pipename = "uno" + str(random.random())[2:]
 154         connectString = _build_connect_string(pipename=pipename)
 155         # start OOo listening on this named pipe
 156         _start_OOo(connectString)
 157     # get component context and return it
 158     context = connect(connectString)
 159     return context