| blob | 8403866fffe83541dad38ff69d526e82c10f3ee6 |
3 <script:module xmlns:script="http://openoffice.org/2000/script" script:name="SF_Platform" 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_Platform
13 ''' ===========
15 ''' Implemented as a usual Basic module
16 '''
17 ''' A collection of properties about the execution environment:
18 ''' - HW platform
19 ''' - Operating System
20 ''' - current user
21 ''' - LibreOffice version
22 '''
23 ''' Service invocation example:
24 ''' Dim platform As Variant
26 '''
27 ''' Detailed user documentation:
28 ''' https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_platform.html?DbPAR=BASIC
29 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
31 REM ================================================================== EXCEPTIONS
33 REM ============================================================ MODULE CONSTANTS
35 REM ===================================================== CONSTRUCTOR/DESTRUCTOR
37 REM -----------------------------------------------------------------------------
38 Public Function Dispose() As Variant
39 Set Dispose = Nothing
40 End Function ' ScriptForge.SF_Array Explicit destructor
42 REM ================================================================== PROPERTIES
44 REM -----------------------------------------------------------------------------
45 Property Get Architecture() As String
46 ''' Returns the actual bit architecture
47 ''' Example:
50 End Property ' ScriptForge.SF_Platform.Architecture (get)
52 REM -----------------------------------------------------------------------------
53 Property Get ComputerName() As String
55 ''' Example:
56 ''' MsgBox platform.ComputerName
58 End Property ' ScriptForge.SF_Platform.ComputerName (get)
60 REM -----------------------------------------------------------------------------
61 Property Get CPUCount() As Integer
62 ''' Returns the number of Central Processor Units
63 ''' Example:
66 End Property ' ScriptForge.SF_Platform.CPUCount (get)
68 REM -----------------------------------------------------------------------------
69 Property Get CurrentUser() As String
70 ''' Returns the name of logged in user
71 ''' Example:
72 ''' MsgBox platform.CurrentUser
74 End Property ' ScriptForge.SF_Platform.CurrentUser (get)
76 REM -----------------------------------------------------------------------------
77 Property Get Extensions() As Variant
78 ''' Returns the list of availableeExtensions as an unsorted array of unique strings
79 ''' To get the list sorted, use SF_Array.Sort()
80 ''' Example:
81 ''' myExtensionsList = platform.Extensions
83 End Property ' ScriptForge.SF_Platform.Extensions (get)
85 REM -----------------------------------------------------------------------------
86 Property Get FilterNames() As Variant
87 ''' Returns the list of available document import and export filter names as an unsorted array of unique strings
88 ''' To get the list sorted, use SF_Array.Sort()
89 ''' Example:
90 ''' myFilterNamesList = platform.FilterNames
92 End Property ' ScriptForge.SF_Platform.FilterNames (get)
94 REM -----------------------------------------------------------------------------
95 Property Get Fonts() As Variant
96 ''' Returns the list of available fonts as an unsorted array of unique strings
97 ''' To get the list sorted, use SF_Array.Sort()
98 ''' Example:
99 ''' myFontsList = platform.Fonts
101 End Property ' ScriptForge.SF_Platform.Fonts (get)
103 REM -----------------------------------------------------------------------------
104 Property Get FormatLocale() As String
105 ''' Returns the locale used for number and date formats, combining language-COUNTRY (la-CO)
106 ''' Example:
107 ''' MsgBox platform.FormatLocale
109 End Property ' ScriptForge.SF_Platform.FormatLocale (get)
111 REM -----------------------------------------------------------------------------
112 Property Get Locale() As String
113 ''' Returns the locale of the operating system, combining language-COUNTRY (la-CO)
114 ''' Example:
115 ''' MsgBox platform.Locale
117 End Property ' ScriptForge.SF_Platform.Locale (get)
119 REM -----------------------------------------------------------------------------
120 Property Get Machine() As String
122 ''' Example:
123 ''' MsgBox platform.Machine
125 End Property ' ScriptForge.SF_Platform.Machine (get)
127 REM -----------------------------------------------------------------------------
128 Property Get ObjectType As String
129 ''' Only to enable object representation
131 End Property ' ScriptForge.SF_Platform.ObjectType
133 REM -----------------------------------------------------------------------------
134 Property Get OfficeLocale() As String
135 ''' Returns the locale of the user interface, combining language-COUNTRY (la-CO)
136 ''' Example:
137 ''' MsgBox platform.OfficeLocale
139 End Property ' ScriptForge.SF_Platform.OfficeLocale (get)
141 REM -----------------------------------------------------------------------------
142 Property Get OfficeVersion() As String
143 ''' Returns the office software version in the form 'LibreOffice w.x.y.z (The Document Foundation)'
144 ''' Example:
145 ''' MsgBox platform.OfficeVersion
147 End Property ' ScriptForge.SF_Platform.OfficeVersion (get)
149 REM -----------------------------------------------------------------------------
150 Property Get OSName() As String
151 ''' Returns the name of the operating system like 'Linux' or 'Windows'
152 ''' Example:
153 ''' MsgBox platform.OSName
155 End Property ' ScriptForge.SF_Platform.OSName (get)
157 REM -----------------------------------------------------------------------------
158 Property Get OSPlatform() As String
159 ''' Returns a single string identifying the underlying platform with as much useful and human-readable information as possible
160 ''' Example:
161 ''' MsgBox platform.OSPlatform ' Linux-4.15.0-117-generic-x86_64-with-Ubuntu-18.04-bionic
163 End Property ' ScriptForge.SF_Platform.OSPlatform (get)
165 REM -----------------------------------------------------------------------------
166 Property Get OSRelease() As String
168 ''' Example:
171 End Property ' ScriptForge.SF_Platform.OSRelease (get)
173 REM -----------------------------------------------------------------------------
174 Property Get OSVersion() As String
175 ''' Returns the name of the operating system build or version
176 ''' Example:
179 End Property ' ScriptForge.SF_Platform.OSVersion (get)
181 REM -----------------------------------------------------------------------------
182 Property Get Printers() As Variant
183 ''' Returns the list of available printers type as a zero-based array
185 ''' Example:
188 End Property ' ScriptForge.SF_Platform.Printers (get)
190 REM -----------------------------------------------------------------------------
191 Property Get Processor() As String
192 ''' Returns the (real) processor name, e.g. 'amdk6'. Might return the same value as Machine
193 ''' Example:
194 ''' MsgBox platform.Processor
196 End Property ' ScriptForge.SF_Platform.Processor (get)
198 REM -----------------------------------------------------------------------------
199 Property Get PythonVersion() As String
200 ''' Returns the Python version as string 'Python major.minor.patchlevel'
201 ''' Example:
204 End Property ' ScriptForge.SF_Platform.PythonVersion (get)
206 REM -----------------------------------------------------------------------------
207 Property Get ServiceName As String
208 ''' Internal use
210 End Property ' ScriptForge.SF_Platform.ServiceName
212 REM -----------------------------------------------------------------------------
213 Property Get SystemLocale() As String
214 ''' Returns the locale of the operating system, combining language-COUNTRY (la-CO)
215 ''' Example:
216 ''' MsgBox platform.SystemLocale
218 End Property ' ScriptForge.SF_Platform.SystemLocale (get)
220 REM ===================================================================== METHODS
222 REM -----------------------------------------------------------------------------
223 Public Function GetProperty(Optional ByVal PropertyName As Variant) As Variant
224 ''' Return the actual value of the given property
225 ''' Args:
226 ''' PropertyName: the name of the property as a string
227 ''' Returns:
228 ''' The actual value of the property
229 ''' If the property does not exist, returns Null
230 ''' Exceptions:
231 ''' ARGUMENTERROR The property does not exist
234 Const cstSubArgs = ""
236 If SF_Utils._ErrorHandling() Then On Local Error GoTo Catch
237 GetProperty = Null
239 Check:
240 If SF_Utils._EnterFunction(cstThisSub, cstSubArgs) Then
241 If Not SF_Utils._Validate(PropertyName, "PropertyName", V_STRING, Properties()) Then GoTo Catch
242 End If
244 Try:
245 GetProperty = _PropertyGet(PropertyName)
247 Finally:
248 SF_Utils._ExitFunction(cstThisSub)
249 Exit Function
250 Catch:
251 GoTo Finally
252 End Function ' ScriptForge.SF_Platform.GetProperty
254 REM -----------------------------------------------------------------------------
255 Public Function Methods() As Variant
256 ''' Return the list of public methods of the Model service as an array
258 Methods = Array( _
259 )
261 End Function ' ScriptForge.SF_Platform.Methods
263 REM -----------------------------------------------------------------------------
264 Public Function Properties() As Variant
265 ''' Return the list or properties of the Platform class as an array
267 Properties = Array( _
288 )
290 End Function ' ScriptForge.SF_Platform.Properties
292 REM =========================================================== PRIVATE FUNCTIONS
294 REM -----------------------------------------------------------------------------
295 Public Function _GetPrinters() as Variant
296 ''' Returns the list of available printers.
299 Dim oPrinterServer As Object ' com.sun.star.awt.PrinterServer
300 Dim vPrinters As Variant ' Array of printer names
301 Dim sDefaultPrinter As String ' The default printer
302 Dim lDefault As Long ' Initial position of the default printer in the list
304 On Local Error GoTo Catch ' Prevent any error
305 vPrinters = Array()
307 Try:
308 ' Find printers
310 With oPrinterServer
311 vPrinters = .getPrinterNames()
312 sDefaultPrinter = .getDefaultPrinterName()
313 End With
315 ' Put the default printer on top of the list
317 lDefault = SF_Array.IndexOf(vPrinters, sDefaultPrinter, CaseSensitive := True)
319 vPrinters(lDefault) = vPrinters(0)
320 vPrinters(0) = sDefaultPrinter
321 End If
322 End If
324 Finally:
325 _GetPrinters() = vPrinters()
326 Exit Function
327 Catch:
328 GoTo Finally
329 End Function ' ScriptForge.SF_Platform._GetPrinters
331 REM -----------------------------------------------------------------------------
332 Public Function _GetProductName() as String
333 ''' Returns Office product and version numbers found in configuration registry
334 ''' Derived from the Tools library
336 Dim oProdNameAccess as Object ' configmgr.RootAccess
337 Dim sProdName as String
338 Dim sVersion as String
339 Dim sVendor As String
341 On Local Error GoTo Catch ' Prevent any error
342 _GetProductName = ""
344 Try:
347 sProdName = oProdNameAccess.ooName
348 sVersion = oProdNameAccess.ooSetupVersionAboutBox
349 sVendor = oProdNameAccess.ooVendor
351 _GetProductName = sProdName & " " & sVersion & " (" & sVendor & ")"
353 Finally:
354 Exit Function
355 Catch:
356 GoTo Finally
357 End Function ' ScriptForge.SF_Platform._GetProductName
359 REM -----------------------------------------------------------------------------
360 Private Function _PropertyGet(Optional ByVal psProperty As String) As Variant
361 ''' Return the value of the named property
362 ''' Args:
363 ''' psProperty: the name of the property
365 Dim sOSName As String ' Operating system
366 Dim oLocale As Object ' com.sun.star.lang.Locale
367 Dim oPrinterServer As Object ' com.sun.star.awt.PrinterServer
368 Dim oToolkit As Object ' com.sun.star.awt.Toolkit
369 Dim oDevice As Object ' com.sun.star.awt.XDevice
370 Dim oFilterFactory As Object ' com.sun.star.document.FilterFactory
371 Dim oFontDescriptors As Variant ' Array of com.sun.star.awt.FontDescriptor
372 Dim sFonts As String ' Comma-separated list of fonts
373 Dim sFont As String ' A single font name
374 Dim vExtensionsList As Variant ' Array of extension descriptors
375 Dim sExtensions As String ' Comma separated list of extensions
376 Dim sExtension As String ' A single extension name
377 Dim i As Long
380 Dim cstThisSub As String
381 Const cstSubArgs = ""
384 SF_Utils._EnterFunction(cstThisSub, cstSubArgs)
386 Select Case psProperty
387 Case "Architecture", "ComputerName", "CPUCount", "CurrentUser", "Machine" _
388 , "OSPlatform", "OSRelease", "OSVersion", "Processor", "PythonVersion"
389 With ScriptForge.SF_Session
390 _PropertyGet = .ExecutePythonScript(.SCRIPTISSHARED, _SF_.PythonHelper & cstPyHelper, psProperty)
391 End With
393 Set vExtensionsList = SF_Utils._GetUnoService("PackageInformationProvider").ExtensionList
394 sExtensions = ""
395 For i = 0 To UBound(vExtensionsList)
397 Next i
398 If Len(sExtensions) > 0 Then _PropertyGet = Split(Mid(sExtensions, 2), ",") Else _PropertyGet = Array()
401 _PropertyGet = oFilterFactory.getElementNames()
405 oFontDescriptors = oDevice.FontDescriptors()
407 ' Select only not yet registered fonts
408 For i = 0 To UBound(oFontDescriptors)
409 sFont = oFontDescriptors(i).Name
410 If InStr(1, sFonts, "," & sFont & ",", 0) = 0 Then sFonts = sFonts & sFont & "," ' Case-sensitive comparison
411 Next i
412 ' Remove leading and trailing commas
413 If Len(sFonts) > 1 Then _PropertyGet = Split(Mid(sFonts, 2, Len(sFonts) - 2), ",") Else _PropertyGet = Array()
421 _PropertyGet = _GetProductName()
423 ' Calc INFO function preferred to Python script to avoid ScriptForge initialization risks when Python is not installed
424 sOSName = _SF_.OSName
425 If sOSName = "" Then
427 Select Case sOSName
432 Case Else : sOSName = SF_String.Capitalize(sOSName)
433 End Select
434 EndIf
435 _PropertyGet = sOSName
437 _PropertyGet = _GetPrinters()
441 Case Else
442 _PropertyGet = Null
443 End Select
445 Finally:
446 SF_Utils._ExitFunction(cstThisSub)
447 Exit Function
448 End Function ' ScriptForge.SF_Platform._PropertyGet
450 REM ============================================ END OF SCRIPTFORGE.SF_PLATFORM
451 </script:module>