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