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