| blob | a41bffa513773d702eae10ae07627ed71449abb0 |
3 <script:module xmlns:script="http://openoffice.org/2000/script" script:name="SF_Session" script:language="StarBasic" script:moduleType="normal">REM =======================================================================================================================
4 REM === The ScriptForge library and its associated libraries are part of the LibreOffice project. ===
5 REM === Full documentation is available on https://help.libreoffice.org/ ===
6 REM =======================================================================================================================
8 Option Compatible
9 Option Explicit
11 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
12 ''' SF_Session
13 ''' ==========
15 ''' Implemented as a usual Basic module
16 '''
17 ''' Gathers diverse general-purpose properties and methods about :
18 ''' - installation/execution environment
19 ''' - UNO introspection utilities
20 ''' - clipboard management
21 ''' - invocation of external scripts or programs
22 '''
23 ''' Service invocation example:
24 ''' Dim session As Variant
26 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
28 REM ================================================================== EXCEPTIONS
37 REM ============================================================ MODULE CONSTANTS
39 ''' Script locations
40 ''' ================
41 ''' Use next constants as Scope argument when invoking next methods:
42 ''' ExecuteBasicScript()
43 ''' ExecutePythonScript()
44 ''' Example:
45 ''' session.ExecuteBasicScript(session.SCRIPTISEMBEDDED, "Standard.myLib.myFunc", etc)
47 Const cstSCRIPTISEMBEDDED = "document" ' a library of the document (BASIC + PYTHON)
50 Const cstSCRIPTISPERSOXT = "user:uno_packages" ' an extension for the current user (PYTHON)
52 Const cstSCRIPTISSHAROXT = "share:uno_packages" ' an extension for all users (PYTHON)
53 Const cstSCRIPTISOXT = "uno_packages" ' an extension but install params are unknown (PYTHON)
55 REM ===================================================== CONSTRUCTOR/DESTRUCTOR
57 REM -----------------------------------------------------------------------------
58 Public Function Dispose() As Variant
59 Set Dispose = Nothing
60 End Function ' ScriptForge.SF_Array Explicit destructor
62 REM ================================================================== PROPERTIES
64 REM -----------------------------------------------------------------------------
65 Property Get ObjectType As String
66 ''' Only to enable object representation
68 End Property ' ScriptForge.SF_Session.ObjectType
70 REM -----------------------------------------------------------------------------
71 Property Get ServiceName As String
72 ''' Internal use
74 End Property ' ScriptForge.SF_Array.ServiceName
76 REM -----------------------------------------------------------------------------
77 Property Get SCRIPTISAPPLICATION As String
78 ''' Convenient constants
79 SCRIPTISAPPLICATION = cstSCRIPTISAPPLICATION
80 End Property ' ScriptForge.SF_Session.SCRIPTISAPPLICATION
82 REM -----------------------------------------------------------------------------
83 Property Get SCRIPTISEMBEDDED As String
84 ''' Convenient constants
85 SCRIPTISEMBEDDED = cstSCRIPTISEMBEDDED
86 End Property ' ScriptForge.SF_Session.SCRIPTISEMBEDDED
88 REM -----------------------------------------------------------------------------
89 Property Get SCRIPTISOXT As String
90 ''' Convenient constants
91 SCRIPTISOXT = cstSCRIPTISOXT
92 End Property ' ScriptForge.SF_Session.SCRIPTISOXT
94 REM -----------------------------------------------------------------------------
95 Property Get SCRIPTISPERSONAL As String
96 ''' Convenient constants
97 SCRIPTISPERSONAL = cstSCRIPTISPERSONAL
98 End Property ' ScriptForge.SF_Session.SCRIPTISPERSONAL
100 REM -----------------------------------------------------------------------------
101 Property Get SCRIPTISPERSOXT As String
102 ''' Convenient constants
103 SCRIPTISPERSOXT = cstSCRIPTISPERSOXT
104 End Property ' ScriptForge.SF_Session.SCRIPTISPERSOXT
106 REM -----------------------------------------------------------------------------
107 Property Get SCRIPTISSHARED As String
108 ''' Convenient constants
109 SCRIPTISSHARED = cstSCRIPTISSHARED
110 End Property ' ScriptForge.SF_Session.SCRIPTISSHARED
112 REM -----------------------------------------------------------------------------
113 Property Get SCRIPTISSHAROXT As String
114 ''' Convenient constants
115 SCRIPTISSHAROXT = cstSCRIPTISSHAROXT
116 End Property ' ScriptForge.SF_Session.SCRIPTISSHAROXT
118 REM ============================================================== PUBLIC METHODS
120 REM -----------------------------------------------------------------------------
121 Public Function ExecuteBasicScript(Optional ByVal Scope As Variant _
122 , Optional ByVal Script As Variant _
123 , ParamArray pvArgs As Variant _
124 ) As Variant
125 ''' Execute the Basic script given as a string and return the value returned by the script
126 ''' Args:
127 ''' Scope: "Application" (default) or "Document" (NOT case-sensitive)
128 ''' (or use one of the SCRIPTIS... public constants above)
129 ''' Script: library.module.method (Case sensitive)
133 ''' Read https://wiki.openoffice.org/wiki/Documentation/DevGuide/Scripting/Scripting_Framework_URI_Specification
134 ''' pvArgs: the arguments of the called script
135 ''' Returns:
136 ''' The value returned by the call to the script
137 ''' Exceptions:
138 ''' NOSCRIPTERROR The script could not be found
139 ''' Examples:
140 ''' session.ExecuteBasicScript(, "XrayTool._Main.Xray", someuno) ' Sub: no return expected
142 Dim oScript As Object ' Script to be invoked
143 Dim vReturn As Variant ' Returned value
148 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
150 vReturn = Empty
152 Check:
153 If IsMissing(Scope) Or IsEmpty(Scope) Then Scope = SCRIPTISAPPLICATION
154 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
156 , Array(SCRIPTISAPPLICATION, SCRIPTISEMBEDDED)) Then GoTo Finally
158 End If
160 Try:
161 ' Execute script
163 On Local Error GoTo CatchExec
164 If Not IsNull(oScript) Then vReturn = oScript.Invoke(pvArgs(), Array(), Array())
166 Finally:
167 ExecuteBasicScript = vReturn
168 SF_Utils._ExitFunction(cstThisSub)
169 Exit Function
170 Catch:
171 GoTo Finally
172 CatchExec:
174 GoTo Finally
175 End Function ' ScriptForge.SF_Session.ExecuteBasicScript
177 REM -----------------------------------------------------------------------------
178 Public Function ExecuteCalcFunction(Optional ByVal CalcFunction As Variant _
179 , ParamArray pvArgs As Variant _
180 ) As Variant
181 ''' Execute a Calc function by its (english) name and based on the given arguments
182 ''' Args:
183 ''' CalcFunction: the english name of the function to execute
184 ''' pvArgs: the arguments of the called function
185 ''' Each argument must be either a string, a numeric value
186 ''' or an array of arrays combining those types
187 ''' Returns:
188 ''' The (string or numeric) value or the array of arrays returned by the call to the function
189 ''' When the arguments contain arrays, the function is executed as an array function
190 ''' Wrong arguments generate an error
191 ''' Exceptions:
193 ''' Examples:
195 ''' session.ExecuteCalcFunction("ABS", Array(Array(-1,2,3),Array(4,-5,6),Array(7,8,-9)))(2)(2) returns 9
198 Dim oCalc As Object ' Give access to the com.sun.star.sheet.FunctionAccess service
199 Dim vReturn As Variant ' Returned value
203 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
204 vReturn = Empty
206 Check:
207 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
209 End If
211 Try:
212 ' Execute function
214 On Local Error GoTo CatchCall
215 vReturn = oCalc.callFunction(UCase(CalcFunction), pvArgs())
217 Finally:
218 ExecuteCalcFunction = vReturn
219 SF_Utils._ExitFunction(cstThisSub)
220 Exit Function
221 Catch:
222 GoTo Finally
223 CatchCall:
224 SF_Exception.RaiseFatal(CALCFUNCERROR, CalcFunction)
225 GoTo Finally
226 End Function ' ScriptForge.SF_Session.ExecuteCalcFunction
228 REM -----------------------------------------------------------------------------
229 Public Function ExecutePythonScript(Optional ByVal Scope As Variant _
230 , Optional ByVal Script As Variant _
231 , ParamArray pvArgs As Variant _
232 ) As Variant
233 ''' Execute the Python script given as a string and return the value returned by the script
234 ''' Args:
235 ''' Scope: one of the SCRIPTIS... public constants above (default = "share")
236 ''' Script: (Case sensitive)
244 ''' Read https://wiki.openoffice.org/wiki/Documentation/DevGuide/Scripting/Scripting_Framework_URI_Specification
245 ''' pvArgs: the arguments of the called script
246 ''' Date arguments are converted to iso format. However dates in arrays are not converted
247 ''' Returns:
248 ''' The value(s) returned by the call to the script. If >1 values, enclosed in an array
249 ''' Exceptions:
250 ''' NOSCRIPTERROR The script could not be found
251 ''' Examples:
252 ''' session.ExecutePythonScript(session.SCRIPTISSHARED, "Capitalise.py$getNewString", "Abc") returns "abc"
254 Dim oScript As Object ' Script to be invoked
255 Dim vArg As Variant ' Individual argument
256 Dim vReturn As Variant ' Returned value
257 Dim i As Long
262 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
264 vReturn = Empty
266 Check:
267 If IsError(Scope) Or IsMissing(Scope) Then Scope = SCRIPTISSHARED
268 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
270 , Array(SCRIPTISSHARED, SCRIPTISEMBEDDED, SCRIPTISPERSONAL, SCRIPTISSHAROXT, SCRIPTISPERSOXT, SCRIPTISOXT) _
271 ) Then GoTo Finally
273 End If
275 Try:
276 ' Filter date arguments - NB: dates in arrays are not filtered
278 vArg = pvArgs(i)
279 If VarType(vArg) = V_DATE Then pvArgs(i) = SF_Utils._CDateToIso(vArg)
280 Next i
282 ' Find script
285 ' Execute script
286 If Not IsNull(oScript) Then
287 vReturn = oScript.Invoke(pvArgs(), Array(), Array())
288 ' Remove surrounding array when single returned value
289 If IsArray(vReturn) Then
291 End If
292 End If
294 Finally:
295 ExecutePythonScript = vReturn
296 SF_Utils._ExitFunction(cstThisSub)
297 Exit Function
298 Catch:
299 GoTo Finally
300 End Function ' ScriptForge.SF_Session.ExecutePythonScript
302 REM -----------------------------------------------------------------------------
303 Public Function GetProperty(Optional ByVal PropertyName As Variant) As Variant
304 ''' Return the actual value of the given property
305 ''' Args:
306 ''' PropertyName: the name of the property as a string
307 ''' Returns:
308 ''' The actual value of the property
309 ''' Exceptions
310 ''' ARGUMENTERROR The property does not exist
315 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
316 GetProperty = Null
318 Check:
319 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
320 If Not SF_Utils._Validate(PropertyName, "PropertyName", V_STRING, Properties()) Then GoTo Catch
321 End If
323 Try:
324 Select Case UCase(PropertyName)
325 Case Else
326 End Select
328 Finally:
329 SF_Utils._ExitFunction(cstThisSub)
330 Exit Function
331 Catch:
332 GoTo Finally
333 End Function ' ScriptForge.SF_Session.GetProperty
335 REM -----------------------------------------------------------------------------
336 Public Function HasUnoMethod(Optional ByRef UnoObject As Variant _
337 , Optional ByVal MethodName As Variant _
338 ) As Boolean
339 ''' Returns True if a UNO object contains the given method
340 ''' Code-snippet derived from XRAY
341 ''' Args:
342 ''' UnoObject: the object to identify
343 ''' MethodName: the name of the method as a string. The search is case-sensitive
344 ''' Returns:
345 ''' False when the method is not found or when an argument is invalid
347 Dim oIntrospect As Object ' com.sun.star.beans.Introspection
348 Dim oInspect As Object ' com.sun.star.beans.XIntrospectionAccess
349 Dim bMethod As Boolean ' Return value
353 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
355 Check:
356 bMethod = False
357 If VarType(UnoObject) <> V_OBJECT Then GoTo Finally
358 If IsNull(UnoObject) Then GoTo Finally
359 If VarType(MethodName) <> V_STRING Then GoTo Finally
360 If MethodName = Space(Len(MethodName)) Then GoTo Finally
362 Try:
363 On Local Error GoTo Catch
365 Set oInspect = oIntrospect.inspect(UnoObject)
366 bMethod = oInspect.hasMethod(MethodName, com.sun.star.beans.MethodConcept.ALL)
368 Finally:
369 HasUnoMethod = bMethod
370 SF_Utils._ExitFunction(cstThisSub)
371 Exit Function
372 Catch:
373 On Local Error GoTo 0
374 GoTo Finally
375 End Function ' ScriptForge.SF_Session.HasUnoMethod
377 REM -----------------------------------------------------------------------------
378 Public Function HasUnoProperty(Optional ByRef UnoObject As Variant _
379 , Optional ByVal PropertyName As Variant _
380 ) As Boolean
381 ''' Returns True if a UNO object contains the given property
382 ''' Code-snippet derived from XRAY
383 ''' Args:
384 ''' UnoObject: the object to identify
385 ''' PropertyName: the name of the property as a string. The search is case-sensitive
386 ''' Returns:
387 ''' False when the property is not found or when an argument is invalid
389 Dim oIntrospect As Object ' com.sun.star.beans.Introspection
390 Dim oInspect As Object ' com.sun.star.beans.XIntrospectionAccess
391 Dim bProperty As Boolean ' Return value
395 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
397 Check:
398 bProperty = False
399 If VarType(UnoObject) <> V_OBJECT Then GoTo Finally
400 If IsNull(UnoObject) Then GoTo Finally
401 If VarType(PropertyName) <> V_STRING Then GoTo Finally
402 If PropertyName = Space(Len(PropertyName)) Then GoTo Finally
404 Try:
405 On Local Error GoTo Catch
407 Set oInspect = oIntrospect.inspect(UnoObject)
408 bProperty = oInspect.hasProperty(PropertyName, com.sun.star.beans.PropertyConcept.ALL)
410 Finally:
411 HasUnoProperty = bProperty
412 SF_Utils._ExitFunction(cstThisSub)
413 Exit Function
414 Catch:
415 On Local Error GoTo 0
416 GoTo Finally
417 End Function ' ScriptForge.SF_Session.HasUnoProperty
419 REM -----------------------------------------------------------------------------
420 Public Function Methods() As Variant
421 ''' Return the list of public methods of the Session service as an array
423 Methods = Array( _
436 )
438 End Function ' ScriptForge.SF_Session.Methods
440 REM -----------------------------------------------------------------------------
441 Public Sub OpenURLInBrowser(Optional ByVal URL As Variant)
442 ''' Opens a URL in the default browser
443 ''' Args:
444 ''' URL: The URL to open in the browser
445 ''' Examples:
446 ''' session.OpenURLInBrowser("https://docs.python.org/3/library/webbrowser.html")
453 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
455 Check:
456 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
458 End If
460 Try:
461 ExecutePythonScript(SCRIPTISSHARED, _SF_.PythonHelper & cstPyHelper, URL)
463 Finally:
464 SF_Utils._ExitFunction(cstThisSub)
465 Exit Sub
466 Catch:
467 GoTo Finally
468 End Sub ' ScriptForge.SF_Session.OpenURLInBrowser
470 REM -----------------------------------------------------------------------------
471 Public Function Properties() As Variant
472 ''' Return the list or properties as an array
474 Properties = Array( _
475 )
477 End Function ' ScriptForge.SF_Session.Properties
479 REM -----------------------------------------------------------------------------
480 Public Function RunApplication(Optional ByVal Command As Variant _
481 , Optional ByVal Parameters As Variant _
482 ) As Boolean
483 ''' Executes an arbitrary system command
484 ''' Args:
485 ''' Command: The command to execute
486 ''' This may be an executable file or a document which is registered with an application
487 ''' so that the system knows what application to launch for that document
488 ''' Parameters: a list of space separated parameters as a single string
489 ''' The method does not validate the given parameters, but only passes them to the specified command
490 ''' Returns:
491 ''' True if success
492 ''' Examples:
495 ''' session.RunApplication("kate", "/home/me/install.txt") ' (Linux)
497 Dim bReturn As Boolean ' Returned value
498 Dim oShell As Object ' com.sun.star.system.SystemShellExecute
499 Dim sCommand As String ' Command as an URL
503 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
504 bReturn = False
506 Check:
507 If IsMissing(Parameters) Then Parameters = ""
508 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
511 End If
513 Try:
515 sCommand = SF_FileSystem._ConvertToUrl(Command)
516 oShell.execute(sCommand, Parameters, com.sun.star.system.SystemShellExecuteFlags.DEFAULTS)
517 bReturn = True
519 Finally:
520 RunApplication = bReturn
521 SF_Utils._ExitFunction(cstThisSub)
522 Exit Function
523 Catch:
524 GoTo Finally
525 End Function ' ScriptForge.SF_Session.RunApplication
527 REM -----------------------------------------------------------------------------
528 Public Sub SendMail(Optional ByVal Recipient As Variant _
529 , Optional ByRef Cc As Variant _
530 , Optional ByRef Bcc As Variant _
531 , Optional ByVal Subject As Variant _
532 , Optional ByRef Body As Variant _
533 , Optional ByVal FileNames As Variant _
534 , Optional ByVal EditMessage As Variant _
535 )
536 ''' Send a message (with or without attachments) to recipients from the user's mail client
537 ''' The message may be edited by the user before sending or, alternatively, be sent immediately
538 ''' Args:
539 ''' Recipient: an email addresses (To recipient)
540 ''' Cc: a comma-delimited list of email addresses (carbon copy)
541 ''' Bcc: a comma-delimited list of email addresses (blind carbon copy)
542 ''' Subject: the header of the message
543 ''' FileNames: a comma-separated list of filenames to attach to the mail. SF_FileSystem naming conventions apply
544 ''' Body: the unformatted text of the message
545 ''' EditMessage: when True (default) the message is editable before being sent
546 ''' Exceptions:
547 ''' UNKNOWNFILEERROR File does not exist
548 ''' WRONGEMAILERROR String not recognized as an email address
549 ''' SENDMAILERROR System error, probably no mail client
551 Dim sEmail As String ' An single email address
552 Dim sFile As String ' A single file name
553 Dim sArg As String ' Argument name
554 Dim vCc As Variant ' Array alias of Cc
555 Dim vBcc As Variant ' Array alias of Bcc
556 Dim vFileNames As Variant ' Array alias of FileNames
557 Dim oMailService As Object ' com.sun.star.system.SimpleCommandMail or com.sun.star.system.SimpleSystemMail
558 Dim oMail As Object ' com.sun.star.system.XSimpleMailClient
559 Dim oMessage As Object ' com.sun.star.system.XSimpleMailMessage
560 Dim lFlag As Long ' com.sun.star.system.SimpleMailClientFlags.XXX
561 Dim ARR As Object : ARR = ScriptForge.SF_Array
562 Dim i As Long
565 Const cstSubArgs = "Recipient, [Cc=""""], [Bcc=""""], [Subject=""""], [FileNames=""""], [Body=""""], [EditMessage=True]"
567 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
569 Check:
570 If IsMissing(Cc) Or IsEmpty(Cc) Then Cc = ""
571 If IsMissing(Bcc) Or IsEmpty(Bcc) Then Bcc = ""
572 If IsMissing(Subject) Or IsEmpty(Subject) Then Subject = ""
573 If IsMissing(FileNames) Or IsEmpty(FileNames) Then FileNames = ""
574 If IsMissing(Body) Or IsEmpty(Body) Then Body = ""
575 If IsMissing(EditMessage) Or IsEmpty(EditMessage) Then EditMessage = True
577 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
585 End If
587 ' Check email addresses
589 If Not SF_String.IsEmail(sEmail) Then GoTo CatchEmail
591 For Each sEmail In vCc
592 If Not SF_String.IsEmail(sEmail) Then GoTo CatchEmail
593 Next sEmail
595 For Each sEmail In vBcc
596 If Not SF_String.IsEmail(sEmail) Then GoTo CatchEmail
597 Next sEmail
599 ' Check file existence
601 vFileNames = ARR.TrimArray(Split(FileNames, cstComma))
602 For i = 0 To UBound(vFileNames)
603 sFile = vFileNames(i)
605 If Not SF_FileSystem.FileExists(sFile) Then GoTo CatchNotExists
606 vFileNames(i) = ConvertToUrl(sFile)
607 Next i
608 End If
610 Try:
611 ' Initialize the mail service
613 If IsNull(oMailService) Then GoTo CatchMail
614 Set oMail = oMailService.querySimpleMailClient()
615 If IsNull(oMail) Then GoTo CatchMail
616 Set oMessage = oMail.createSimpleMailMessage()
617 If IsNull(oMessage) Then GoTo CatchMail
619 ' Feed the new mail message
620 With oMessage
621 .setRecipient(Recipient)
622 If Subject <> "" Then .setSubject(Subject)
626 .setAttachement(vFileNames)
627 End With
628 lFlag = Iif(EditMessage, com.sun.star.system.SimpleMailClientFlags.DEFAULTS, com.sun.star.system.SimpleMailClientFlags.NO_USER_INTERFACE)
630 ' Send using the mail service
631 oMail.sendSimpleMailMessage(oMessage, lFlag)
633 Finally:
634 SF_Utils._ExitFunction(cstThisSub)
635 Exit Sub
636 Catch:
637 GoTo Finally
638 CatchEmail:
639 SF_Exception.RaiseFatal(WRONGEMAILERROR, sArg, sEmail)
640 GoTo Finally
641 CatchNotExists:
643 GoTo Finally
644 CatchMail:
645 SF_Exception.RaiseFatal(SENDMAILERROR)
646 GoTo Finally
647 End Sub ' ScriptForge.SF_Session.SendMail
649 REM -----------------------------------------------------------------------------
650 Public Function SetProperty(Optional ByVal PropertyName As Variant _
651 , Optional ByRef Value As Variant _
652 ) As Boolean
653 ''' Set a new value to the given property
654 ''' Args:
655 ''' PropertyName: the name of the property as a string
656 ''' Value: its new value
657 ''' Exceptions
658 ''' ARGUMENTERROR The property does not exist
663 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
664 SetProperty = False
666 Check:
667 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
668 If Not SF_Utils._Validate(PropertyName, "PropertyName", V_STRING, Properties()) Then GoTo Catch
669 End If
671 Try:
672 Select Case UCase(PropertyName)
673 Case Else
674 End Select
676 Finally:
677 SF_Utils._ExitFunction(cstThisSub)
678 Exit Function
679 Catch:
680 GoTo Finally
681 End Function ' ScriptForge.SF_Session.SetProperty
683 REM -----------------------------------------------------------------------------
684 Public Function UnoMethods(Optional ByRef UnoObject As Variant) As Variant
685 ''' Returns a list of the methods callable from an UNO object
686 ''' Code-snippet derived from XRAY
687 ''' Args:
688 ''' UnoObject: the object to identify
689 ''' Returns:
690 ''' A zero-based sorted array. May be empty
692 Dim oIntrospect As Object ' com.sun.star.beans.Introspection
693 Dim oInspect As Object ' com.sun.star.beans.XIntrospectionAccess
694 Dim vMethods As Variant ' Array of com.sun.star.reflection.XIdlMethod
695 Dim vMethod As Object ' com.sun.star.reflection.XIdlMethod
696 Dim lMax As Long ' UBounf of vMethods
697 Dim vMethodsList As Variant ' Return value
698 Dim i As Long
702 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
704 Check:
705 vMethodsList = Array()
706 If VarType(UnoObject) <> V_OBJECT Then GoTo Finally
707 If IsNull(UnoObject) Then GoTo Finally
709 Try:
710 On Local Error GoTo Catch
712 Set oInspect = oIntrospect.inspect(UnoObject)
713 vMethods = oInspect.getMethods(com.sun.star.beans.MethodConcept.ALL)
715 ' The names must be extracted from com.sun.star.reflection.XIdlMethod structures
716 lMax = UBound(vMethods)
718 ReDim vMethodsList(0 To lMax)
719 For i = 0 To lMax
720 vMethodsList(i) = vMethods(i).Name
721 Next i
722 vMethodsList = SF_Array.Sort(vMethodsList, CaseSensitive := True)
723 End If
725 Finally:
726 UnoMethods = vMethodsList
727 SF_Utils._ExitFunction(cstThisSub)
728 Exit Function
729 Catch:
730 On Local Error GoTo 0
731 GoTo Finally
732 End Function ' ScriptForge.SF_Session.UnoMethods
734 REM -----------------------------------------------------------------------------
735 Public Function UnoObjectType(Optional ByRef UnoObject As Variant) As String
736 ''' Identify the UNO type of an UNO object
737 ''' Code-snippet derived from XRAY
738 ''' Args:
739 ''' UnoObject: the object to identify
740 ''' Returns:
741 ''' com.sun.star. ... as a string
742 ''' a zero-length string if identification was not successful
744 Dim oService As Object ' com.sun.star.reflection.CoreReflection
745 Dim vClass as Variant ' com.sun.star.reflection.XIdlClass
746 Dim sObjectType As String ' Return value
750 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
752 Check:
753 sObjectType = ""
754 If VarType(UnoObject) <> V_OBJECT Then GoTo Finally
755 If IsNull(UnoObject) Then GoTo Finally
757 Try:
758 On Local Error Resume Next
759 ' Try usual ImplementationName method
760 sObjectType = UnoObject.getImplementationName()
761 If sObjectType = "" Then
762 ' Now try CoreReflection trick
764 vClass = oService.getType(UnoObject)
765 If vClass.TypeClass >= com.sun.star.uno.TypeClass.STRUCT Then sObjectType = vClass.Name
766 End If
768 Finally:
769 UnoObjectType = sObjectType
770 SF_Utils._ExitFunction(cstThisSub)
771 Exit Function
772 End Function ' ScriptForge.SF_Session.UnoObjectType
774 REM -----------------------------------------------------------------------------
775 Public Function UnoProperties(Optional ByRef UnoObject As Variant) As Variant
776 ''' Returns a list of the properties of an UNO object
777 ''' Code-snippet derived from XRAY
778 ''' Args:
779 ''' UnoObject: the object to identify
780 ''' Returns:
781 ''' A zero-based sorted array. May be empty
783 Dim oIntrospect As Object ' com.sun.star.beans.Introspection
784 Dim oInspect As Object ' com.sun.star.beans.XIntrospectionAccess
785 Dim vProperties As Variant ' Array of com.sun.star.beans.Property
786 Dim vProperty As Object ' com.sun.star.beans.Property
787 Dim lMax As Long ' UBounf of vProperties
788 Dim vPropertiesList As Variant ' Return value
789 Dim i As Long
793 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
795 Check:
796 vPropertiesList = Array()
797 If VarType(UnoObject) <> V_OBJECT Then GoTo Finally
798 If IsNull(UnoObject) Then GoTo Finally
800 Try:
801 On Local Error GoTo Catch
803 Set oInspect = oIntrospect.inspect(UnoObject)
804 vProperties = oInspect.getProperties(com.sun.star.beans.PropertyConcept.ALL)
806 ' The names must be extracted from com.sun.star.beans.Property structures
807 lMax = UBound(vProperties)
809 ReDim vPropertiesList(0 To lMax)
810 For i = 0 To lMax
811 vPropertiesList(i) = vProperties(i).Name
812 Next i
813 vPropertiesList = SF_Array.Sort(vPropertiesList, CaseSensitive := True)
814 End If
816 Finally:
817 UnoProperties = vPropertiesList
818 SF_Utils._ExitFunction(cstThisSub)
819 Exit Function
820 Catch:
821 On Local Error GoTo 0
822 GoTo Finally
823 End Function ' ScriptForge.SF_Session.UnoProperties
825 REM -----------------------------------------------------------------------------
826 Public Function WebService(Optional ByVal URI As Variant) As String
827 ''' Get some web content from a URI
828 ''' Args:
829 ''' URI: URI text of the web service
830 ''' Returns:
831 ''' The web page content of the URI
832 ''' Exceptions:
833 ''' CALCFUNCERROR
834 ''' Examples:
836 ''' & "hidebots=1&days=7&limit=50&action=feedrecentchanges&feedformat=rss")
838 Dim sReturn As String ' Returned value
842 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
843 sReturn = ""
845 Check:
846 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
848 End If
850 Try:
853 Finally:
854 WebService = sReturn
855 SF_Utils._ExitFunction(cstThisSub)
856 Exit Function
857 Catch:
858 GoTo Finally
859 End Function ' ScriptForge.SF_Session.WebService
861 REM =========================================================== PRIVATE FUNCTIONS
863 REM -----------------------------------------------------------------------------
864 Private Function _GetScript(ByVal psLanguage As String _
865 , ByVal psScope As String _
866 , ByVal psScript As String _
867 ) As Object
868 ''' Get the adequate script provider and from there the requested script
869 ''' Called by ExecuteBasicScript() and ExecutePythonScript()
870 ''' The execution of the script is done by the caller
871 ''' Args:
872 ''' psLanguage: Basic or Python
873 ''' psScope: one of the SCRIPTISxxx constants
875 ''' installed for one user only, or for all users
876 ''' Managed here by trial and error
877 ''' psScript: Read https://wiki.openoffice.org/wiki/Documentation/DevGuide/Scripting/Scripting_Framework_URI_Specification
878 ''' Returns:
879 ''' A com.sun.star.script.provider.XScript object
881 Dim sScript As String ' The complete script string
882 Dim oScriptProvider As Object ' Script provider singleton
883 Dim oScript As Object ' Return value
888 Try:
889 ' Build script string
890 sScript = cstScript1 & psScript & cstScript2 & psLanguage & cstScript3 & LCase(psScope)
892 ' Find script
893 Set oScript = Nothing
894 ' Python only: installation of extension is determined by user => unknown to script author
896 On Local Error GoTo ForAllUsers
897 sScript = cstScript1 & psScript & cstScript2 & psLanguage & cstScript3 & SCRIPTISPERSOXT
899 Set oScript = oScriptProvider.getScript(sScript)
900 End If
901 ForAllUsers:
902 On Local Error GoTo CatchNotFound
903 If IsNull(oScript) Then
904 If psScope = SCRIPTISOXT Then psScope = SCRIPTISSHAROXT
906 Set oScript = oScriptProvider.getScript(sScript)
907 End If
909 Finally:
910 _GetScript = oScript
911 Exit Function
912 CatchNotFound:
913 SF_Exception.RaiseFatal(NOSCRIPTERROR, psLanguage, "Scope", psScope, "Script", psScript)
914 GoTo Finally
915 End Function ' ScriptForge.SF_Session._GetScript
917 REM =============================================== END OF SCRIPTFORGE.SF_SESSION
918 </script:module>