Fixed: missing import of `glob`
[openoffice-python:openoffice-python.git] / 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             import glob
78             pathes = glob.glob('/usr/lib/ooo-[234].*/program/soffice')
79             if not pathes:
80                 raise BootstrapExceptions('soffice executable not found')
81             pathes.sort(reverse=True)
82             office = pathes[0]
83         __soffice_executable = office
84         return office
85
86     # soffice script used on *ix, Mac; soffice.exe used on Windoof
87     office = find_executable()
88     if sys.platform.startswith("win"):
89         office += ".exe"
90
91     # -headless includes -invisible (which includes -nologo -nodefault)
92     accept = unaccept and '-unaccept' or '-accept'
93     cmdArray = (office,
94                 "-headless", "-norestore", "%s=%s;urp;" %
95                 (accept, connectString))
96     return cmdArray
97
98
99 def _start_OOo(connectString):
100     """Start an OOo process listening on named pipe or socket
101     descripted in parameter 'connectString'.
102     """
103     cmdArray = _build_cmd_args(connectString)
104     # Start the office proces, don't check for exit status since
105     # an exception is caught anyway if the office terminates
106     # unexpectedly.
107     return os.spawnv(os.P_NOWAIT, cmdArray[0], cmdArray)
108
109
110 def connect(connectString):
111     """
112     Connect to an OOo instance listening on named pipe or socket
113     descripted in parameter 'connectString'.
114     """
115     localContext = uno.getComponentContext()
116     resolver = localContext.ServiceManager.createInstanceWithContext(
117         "com.sun.star.bridge.UnoUrlResolver", localContext)
118     connect = "uno:" + connectString + ";urp;StarOffice.ComponentContext"
119
120     # Wait until an office is started, but loop only 20 times (10 seconds)
121     for i in range(20):
122         try:
123             context = resolver.resolve(connect)
124             break
125         except NoConnectException:
126             sleep(0.5)  # Sleep 1/2 second.
127     else:
128         # for-loop completed without 'break' (this is: no connection found)
129         raise BootstrapException("Cannot connect to soffice server.")
130
131     return context
132
133
134 def bootstrap(pipename=None, host=None, port=None):
135     """Bootstrap OOo and PyUNO Runtime.
136
137     If either pipename, host or port are given, connect to the OOo
138     instance listening on this pipe or hosst/port. (This is mainly for
139     convenience, so programms do not need to distinguish these cases.)
140
141     If non of these parameters are give, the soffice process is
142     started opening a named pipe of random name, then the local
143     context is used to access the pipe.
144
145     This function directly returns the remote component context, from
146     whereon you can get the ServiceManager by calling
147     getServiceManager() on the returned object.
148     """
149     if pipename or host or port:
150         connectString = _build_connect_string(pipename=pipename,
151                                               host=host, port=port)
152     else:
153         # Generate a random pipe name.
154         pipename = "uno" + str(random.random())[2:]
155         connectString = _build_connect_string(pipename=pipename)
156         # start OOo listening on this named pipe
157         _start_OOo(connectString)
158     # get component context and return it
159     context = connect(connectString)
160     return context