Difference between revisions of "PyUNOServer"

From Apache OpenOffice Wiki
Jump to: navigation, search
Line 1: Line 1:
 
{{Extensions}}
 
{{Extensions}}
The PyUNOServer is a script that pretends to work as a server for OpenOffice.org where it can broadcast and recieve calls using XMLRPC. This means that can get data from other apps on an architecture used for WebServices.
+
The PyUNOServer is a script that works as an XML server for OpenOffice.org Calc where it can exchange data through XML calls. This means that can get data from other apps that are XML compliant.
  
 
The zip file contains 3 files:  
 
The zip file contains 3 files:  
Line 68: Line 68:
 
"""
 
"""
  
#Creo algunas constantes de utilidad
+
#Create some useful constants
 
self.EMPTY = uno.Enum("com.sun.star.table.CellContentType", "EMPTY")
 
self.EMPTY = uno.Enum("com.sun.star.table.CellContentType", "EMPTY")
 
self.TEXT = uno.Enum("com.sun.star.table.CellContentType", "TEXT")
 
self.TEXT = uno.Enum("com.sun.star.table.CellContentType", "TEXT")
 
self.FORMULA = uno.Enum("com.sun.star.table.CellContentType", "FORMULA")
 
self.FORMULA = uno.Enum("com.sun.star.table.CellContentType", "FORMULA")
 
self.VALUE = uno.Enum("com.sun.star.table.CellContentType", "VALUE")
 
self.VALUE = uno.Enum("com.sun.star.table.CellContentType", "VALUE")
# Creo un Logger
+
 
 +
#Generate a Logger
 
self.logger = logging.getLogger('pyUnoServer')
 
self.logger = logging.getLogger('pyUnoServer')
 
hdlr = logging.FileHandler('./pyUnoServer.log')
 
hdlr = logging.FileHandler('./pyUnoServer.log')
Line 82: Line 83:
 
self.sessions = []
 
self.sessions = []
 
self.sessionSerial = 0
 
self.sessionSerial = 0
# Echo a correr el OpenOffice Calc obteniendo su PID
+
 
 +
#Launch OpenOffice.org Calc and retrieve their Process Identificator (PID)
 
self.PID = os.spawnlp(os.P_NOWAIT,"/usr/bin/oocalc","","-accept=socket,host=localhost,port=2002;urp;")
 
self.PID = os.spawnlp(os.P_NOWAIT,"/usr/bin/oocalc","","-accept=socket,host=localhost,port=2002;urp;")
  
Line 117: Line 119:
 
return currentSerial
 
return currentSerial
  
ef getSessions(self):
+
def getSessions(self):
return self.sessions
+
      return self.sessions
ef openBook(self, session, bookPath):
+
def openBook(self, session, bookPath):
 
"""
 
"""
 
This method opens a new Openoffice spreadsheet book.
 
This method opens a new Openoffice spreadsheet book.
Line 174: Line 176:
 
books = self.sessions[sessionID][1]
 
books = self.sessions[sessionID][1]
  
#esto cierra el documento. Parece Cerdo, pero segun la documentcion, asi es
+
#this closes de document. It looks dirty, but according to the documentation it works
 
books[bookID][1].dispose()
 
books[bookID][1].dispose()
 
self.sessions[sessionID][1].remove(books[bookID])
 
self.sessions[sessionID][1].remove(books[bookID])
  
 
return 1
 
return 1
ef getBookSheets(self, sessionID, bookID):
+
def getBookSheets(self, sessionID, bookID):
 
"""
 
"""
 
This method return an array with the book's worksheets.
 
This method return an array with the book's worksheets.
Line 198: Line 200:
 
 
 
return container
 
return container
ef getCellValue (self,sheet,x,y):
+
def getCellValue (self,sheet,x,y):
 
cell = sheet.getCellByPosition(x,y)
 
cell = sheet.getCellByPosition(x,y)
 
cellType  = cell.getType()
 
cellType  = cell.getType()
Line 231: Line 233:
 
return $result;
 
return $result;
 
"""
 
"""
 +
 
sheetref = self.sessions[session][1][book][1].getSheets().getByIndex(sheet)
 
sheetref = self.sessions[session][1][book][1].getSheets().getByIndex(sheet)
 
valor = self.getCellValue(sheetref,x,y)
 
valor = self.getCellValue(sheetref,x,y)
 
return valor
 
return valor
  
ef setCell(self,session,book,sheet,x,y,value):
+
def setCell(self,session,book,sheet,x,y,value):
 
"""
 
"""
 
This method sets the content of a cell.
 
This method sets the content of a cell.
Line 258: Line 261:
 
cell.setValue(value)
 
cell.setValue(value)
 
return 1
 
return 1
en que cambiara todo? mmm...
+
# en que cambiara todo? mmm...
ef massiveSetCell(self, data):
+
def massiveSetCell(self, data):
 
for valores in data:
 
for valores in data:
 
session,sheetid,x,y,valor = valores.split("|")
 
session,sheetid,x,y,valor = valores.split("|")
Line 266: Line 269:
 
return code
 
return code
 
return 1
 
return 1
ef getSheetPreview(self,session,book,sheet):
+
def getSheetPreview(self,session,book,sheet):
sheet = self.sessions[session][1][book][1].getSheets().getByIndex(sheet)
+
      sheet = self.sessions[session][1][book][1].getSheets().getByIndex(sheet)
range = sheet.getCellRangeByPosition(0,0,8,23).getDataArray()
+
      range = sheet.getCellRangeByPosition(0,0,8,23).getDataArray()
 
return range
 
return range
  
ef trim(self, cadena):
+
def trim(self, cadena):
 
return cadena.strip()
 
return cadena.strip()
  
Line 283: Line 286:
  
 
except KeyboardInterrupt:  
 
except KeyboardInterrupt:  
erver.logger.info("Cerrando el socket...")
+
server.logger.info("Cerrando el socket...")
erver.server_close()
+
server.server_close()
 
s.kill(server.PID,1)
 
s.kill(server.PID,1)
erver.logger.info("Socket cerrado.")</code>
+
server.logger.info("Socket cerrado.")</code>
  
 
==startPyUnoServer.sh2==
 
==startPyUnoServer.sh2==

Revision as of 11:48, 17 December 2006

OOo Extensions project

Please view the wiki usage guidelines
before contributing.

Categories:

Pages:

Extensions on the main site

Extensions in other languages:
ES - FR - IT - JA - NL - OC -

The PyUNOServer is a script that works as an XML server for OpenOffice.org Calc where it can exchange data through XML calls. This means that can get data from other apps that are XML compliant.

The zip file contains 3 files:

  • PyUNOServerV2.py - The Python Script
  • PyUNOServerV2.pyc - compiled version
  • PyUNOServer.sh2 - the script to conect to the service

[python]

# -*- coding: iso-8859-1 -*-
#
# pyUnoServer - version 2.0
#
# (C) 2005 ECWeb Ingenieria y Desarrollo - http://www.ecweb.cl/
# Written by:
# - Jose Antonio Akel <jakel@NOSPAMecweb.cl>
# - Hector Vergara <hector@NOSPAMecweb.cl>
# - Luis Gonzalez Miranda <lgm@NOSPAMecweb.cl>
#
# This program is freely distributable per the following license:
#
# Permission to use, copy, modify, and distribute this software and its
# documentation for any purpose and without fee is hereby granted,
# provided that the above copyright notice appears in all copies and that
# both that copyright notice and this permission notice appear in
# supporting documentation.
#
# I DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL I
# BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
# DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
# WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
# ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
# SOFTWARE.

“"”

This program implements a XMLRPC gateway to Openoffice's Spreadsheet Calculator,
allowing external programs to exchange data with spreadsheets.

“"”

from SimpleXMLRPCServer import SimpleXMLRPCServer, SimpleXMLRPCRequestHandler
import os
import uno
import sys
import time
import logging
import urllib

class PyUNOServer(SimpleXMLRPCServer):

	def _dispatch(self, method, params):

try: func = getattr(self, + method) except: self.logger.error("El Metodo '"+method+"' no esta soportado!") raise Exception('method "%s" is not supported' % method) else: try: ret = func(*params) self.logger.info("Llamada: "+str(method)+str(params)+" | Retorno: "+str(ret)) return ret except: self.logger.info("Llamada: "+str(method)+str(params)) self.logger.error("Error: "+str(sys.exc_type)+":"+str(sys.exc_value)) ef init(self): """ This method starts an Openoffice session and initializes the XMLRPC server """

  1. Create some useful constants

self.EMPTY = uno.Enum("com.sun.star.table.CellContentType", "EMPTY") self.TEXT = uno.Enum("com.sun.star.table.CellContentType", "TEXT") self.FORMULA = uno.Enum("com.sun.star.table.CellContentType", "FORMULA") self.VALUE = uno.Enum("com.sun.star.table.CellContentType", "VALUE")

  1. Generate a Logger

self.logger = logging.getLogger('pyUnoServer') hdlr = logging.FileHandler('./pyUnoServer.log') formatter = logging.Formatter('%(asctime)s %(levelname)s -- %(message)s') hdlr.setFormatter(formatter) self.logger.addHandler(hdlr) self.logger.setLevel(logging.INFO) self.sessions = [] self.sessionSerial = 0

  1. Launch OpenOffice.org Calc and retrieve their Process Identificator (PID)

self.PID = os.spawnlp(os.P_NOWAIT,"/usr/bin/oocalc","","-accept=socket,host=localhost,port=2002;urp;")

self.logger.info("OOCalc Iniciado con el PID "+str(self.PID)) while 1: try: localContext = uno.getComponentContext() resolver = localContext.ServiceManager.createInstanceWithContext("com.sun.star.bridge.UnoUrlResolver", localContext ) smgr = resolver.resolve( "uno:socket,host=localhost,port=2002;urp;StarOffice.ServiceManager" ) remoteContext = smgr.getPropertyValue( "DefaultContext" ) self.desktop = smgr.createInstanceWithContext( "com.sun.star.frame.Desktop",remoteContext) self.logger.info("Sistema conectado al socket de UNO") break except: time.sleep(0.5) ef openSession(self, session): """ This method opens a new session. Sample usage from PHP:

- $sessionString is your a session ID provided by your program):

$openSession = array( new XML_RPC_VALUE($sessionString, "string")); $sessionID = queryXMLRPC($client, "openSession", $openSession); return $sessionID; """ currentSerial = -1 for i in range(0,len(self.sessions)): if self.sessions[i][0] == session: currentSerial = i break

if currentSerial == -1: self.sessions.append([session,[]]) currentSerial = len(self.sessions)-1 return currentSerial

def getSessions(self):

     return self.sessions

def openBook(self, session, bookPath): """ This method opens a new Openoffice spreadsheet book. Sample usage from PHP:

- $sessionID is the session's ID returned by openSession()
- $path is the path to the book in the server's filesystem

$openBookQuery = array( new XML_RPC_VALUE($sessionID, "int"), new XML_RPC_VALUE($path,"string") ); $bookID = queryXMLRPC($client, "openBook", $openBookQuery); return $bookID; """ currentSerial = session bookPath = bookPath.strip() print bookPath exists = os.path.exists(bookPath) if exists == False: raise Exception('El libro %s no existe', bookPath) else: self.logger.info("se ha encontrado el libro!")

currentBook = -1

for i in range(0, len(self.sessions[currentSerial][1])): try: book = self.sessions[currentSerial][1][i]

bookname = book[0] bookhandler = book[1] bookmodtime = book[2]

if bookname == bookPath: modtime = os.path.getmtime(bookPath) if (modtime > bookmodtime): book[1].dispose() self.sessions[currentSerial][1].remove(book) else: currentBook = i break except: self.logger.error("El libro "+currentBook+" no existe!")

if (currentBook < 0 ): handler = self.desktop.loadComponentFromURL( "file://" + bookPath ,"_blank",0,()) if(handler == None): raise Exception('El libro no existe o tiene caracteres extraños...') modtime = os.path.getmtime(bookPath)

estruct = [bookPath,handler,modtime] self.sessions[currentSerial][1].append(estruct) currentBook = len(self.sessions[currentSerial][1])-1

return currentBook ef closeBook(self, sessionID, bookID):

books = self.sessions[sessionID][1]

  1. this closes de document. It looks dirty, but according to the documentation it works

books[bookID][1].dispose() self.sessions[sessionID][1].remove(books[bookID])

return 1 def getBookSheets(self, sessionID, bookID): """ This method return an array with the book's worksheets. Sample usage from PHP:

- $sessionID is the session's ID returned by openSession()
- $bookID is the book's ID returned by openBook()

$sheetsQuery = array( new XML_RPC_VALUE($sessionID, "int"), new XML_RPC_VALUE($bookID, "int") ); $sheets = queryXMLRPC($client, "getBookSheets" , $sheetsQuery); return $sheets; """

sheets = self.sessions[sessionID][1][bookID][1].getSheets().createEnumeration()

container = [] while(sheets.hasMoreElements()): currentSheet = sheets.nextElement() container.append(currentSheet.getName().encode("UTF-8"))

return container def getCellValue (self,sheet,x,y): cell = sheet.getCellByPosition(x,y) cellType = cell.getType() if cellType == self.TEXT : data = cell.getString().encode("UTF-8") if data == None: return "" return data.encode("UTF-8")

if cellType == self.FORMULA or cellType == self.VALUE : data = cell.getValue() if data == None: return 0 return cell.getValue() if cellType == self.EMPTY : return "" ef getCell(self, session, book, sheet, x, y): """ This method returns the content of a cell. Sample usage from PHP:

- $sessionID is the session's ID returned by openSession()
- $bookID is the book's ID returned by openBook()
- $sheet is the sheet's ID as returned by getBookSheets()

$query = array( new XML_RPC_Value($sessionID, "int"), new XML_RPC_VALUE($bookID, "int"), new XML_RPC_VALUE($sheet, "int"), new XML_RPC_Value($x, "int"), new XML_RPC_Value($y, "string") ); $result = queryXMLRPC($client, "getCell", $query); return $result; """

sheetref = self.sessions[session][1][book][1].getSheets().getByIndex(sheet) valor = self.getCellValue(sheetref,x,y) return valor

def setCell(self,session,book,sheet,x,y,value): """ This method sets the content of a cell. Sample usage from PHP:

- $sessionID is the session's ID returned by openSession()
- $bookID is the book's ID returned by openBook()
- $sheet is the sheet's ID as returned by getBookSheets()

$query = array( new XML_RPC_Value($sessionID, "int"), new XML_RPC_VALUE($bookID, "int"), new XML_RPC_VALUE($sheet, "int"), new XML_RPC_Value($x, "int"), new XML_RPC_Value($y, "int"), new XML_RPC_Value($value, "string") ); $result = queryXMLRPC($client, "setCell", $query); return $result; """

bookObject = self.sessions[session][1][book][1] cell = bookObject.getSheets().getByIndex(sheet).getCellByPosition(x,y) cell.setValue(value) return 1

  1. en que cambiara todo? mmm...

def massiveSetCell(self, data): for valores in data: session,sheetid,x,y,valor = valores.split("|") code = self.setCell(self.trim(session),self.trim(sheetid),self.trim(x),self.trim(y),valor) if code < 0: return code return 1 def getSheetPreview(self,session,book,sheet):

     sheet = self.sessions[session][1][book][1].getSheets().getByIndex(sheet)
     range = sheet.getCellRangeByPosition(0,0,8,23).getDataArray()

return range

def trim(self, cadena): return cadena.strip()


server = PyUNOServer2)

server.init() server.logger.info(“Servicio Inicializado…”)

try: erver.serve_forever()

except KeyboardInterrupt: server.logger.info("Cerrando el socket...") server.server_close() s.kill(server.PID,1) server.logger.info("Socket cerrado.")

startPyUnoServer.sh2

[bash]

  1. !/bin/bash

export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/lib/openoffice/program/ export PYTHONPATH=$PYTHONPATH:/usr/lib/openoffice/program export DISPLAY=localhost:1 echo "Logging en pyUnoServer.log" python pyUnoServerV2.py echo "CHAO!"

Personal tools