testautomation/global/tools/includes/optional/t_filetools.inc

   1 'encoding UTF-8  Do not remove or change this line!
   2 '**************************************************************************
   3 '* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4 '*
   5 '* Copyright 2008 by Sun Microsystems, Inc.
   6 '*
   7 '* OpenOffice.org - a multi-platform office productivity suite
   8 '*
   9 '* $RCSfile: t_filetools.inc,v $
  10 '*
  11 '* $Revision: 1.4 $
  12 '*
  13 '* last change: $Author: rt $ $Date: 2008-09-04 09:17:26 $
  14 '*
  15 '* This file is part of OpenOffice.org.
  16 '*
  17 '* OpenOffice.org is free software: you can redistribute it and/or modify
  18 '* it under the terms of the GNU Lesser General Public License version 3
  19 '* only, as published by the Free Software Foundation.
  20 '*
  21 '* OpenOffice.org is distributed in the hope that it will be useful,
  22 '* but WITHOUT ANY WARRANTY; without even the implied warranty of
  23 '* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24 '* GNU Lesser General Public License version 3 for more details
  25 '* (a copy is included in the LICENSE file that accompanied this code).
  26 '*
  27 '* You should have received a copy of the GNU Lesser General Public License
  28 '* version 3 along with OpenOffice.org.  If not, see
  29 '* <http://www.openoffice.org/license.html>
  30 '* for a copy of the LGPLv3 License.
  31 '*
  32 '/************************************************************************
  33 '*
  34 '*  owner : joerg.skottke@sun.com
  35 '*
  36 '*  short description : Functions that work with files like deleting, loading...
  37 '*
  38 '\******************************************************************************
  39
  40 private const VERBOSE = false
  41
  42 function hHandleActivesOnLoad( iTries as integer , iAdd as integer ) as boolean
  43
  44     '///<h3>Handle any dialogs that might pop up when loading a file</h3>
  45     '///<i>Beware: This function gives only limited control over the dialogs closed,
  46     '///+ it just closes anything it can.</i><br>
  47     '///<i>Please refer to the inline documentation for further details</i><br>
  48     '///<u>Input</u>:
  49     '///<ol>
  50     '///+<li>Number of dialogs to be closed (integer)</li>
  51     '///<ul>
  52     '///+<li>Number of dialogs not limited though more than 3 is not useful</li>
  53     '///</ul>
  54     '///+<li>Additional dialogs (integer).</li>
  55     '///<ul>
  56     '///+<li>Number of dialogs to handle in case of unexpected behavior. If unsure set it to 2</li>
  57     '///</ul>
  58     '///</ol>
  59     '///<u>Returns</u>:
  60     '///<ol>
  61     '///+<li>Errorcondition (boolean)</li>
  62     '///<ul>
  63     '///+<li>TRUE: The expected number of dialogs were closed</li>
  64     '///+<li>FALSE: On any other condition</li>
  65     '///</ul>
  66      '///</ol>
  67     '///<u>Description</u>:
  68     '///<ul>
  69     '///+<li>OK to create a new document based on a template</li>
  70     '///+<li>YES to update links</li>
  71     '///+<li>YES to execute macros</li>
  72     '///</ul>
  73
  74     use "global/tools/includes/optional/t_stringtools.inc"
  75
  76     const CFN = "hHandleActivesOnLoad::"
  77
  78     dim iTry as integer
  79     dim iActives as integer
  80     dim cMessage as string
  81     dim bSkip as boolean
  82
  83     printlog( CFN & "Enter" )
  84
  85     ' not good but apparently required - else hDestroyDocument will handle the
  86     ' dialogs and warn about them.
  87
  88     ' think positive: preset the returnvalue with "true"
  89     hHandleActivesOnLoad() = true
  90
  91     for iTry = 1 to iTries + iAdd
  92
  93         ' handle three possible dialogs:
  94         ' 1. The warning that the user should create a new document based
  95         '    on this Sample/Template (the document is write protected)
  96         ' 2. The question to update links to the internet. Note: If you
  97         '    use proxies, they must be set correctly otherwise the result
  98         '    is undefined.
  99         ' 3. Some weird usage information dialog which is an active with just
 100         '    one OK button.
 101
 102         ' Although this works quite well, there is a flaw that we will not
 103         ' get information about an "active" dialog that cannot be closed by
 104         ' .yes() or .ok(). If this happens, we probably run into an error
 105         kontext "Active"
 106         try
 107             if ( active.exists( 1 ) ) then
 108
 109                 iActives = iActives + 1
 110                 cMessage = hRemoveLineBreaks( active.getText() )
 111                 printlog( CFN & "MSG (" & iActives & "): " & cMessage )
 112                 printlog( CFN & "Ressource type is: " & Active.getRT() )
 113                 printlog( CFN & "Buttoncount is: " & Active.getButtonCount() )
 114                 bSkip = false
 115
 116                 ' ok to create a new document
 117                 try
 118                     active.cancel()
 119                     printlog( CFN & "MSG (" & iActives & "): closed with Cancel" )
 120                     bSkip = true
 121                 catch
 122                     printlog( CFN & "Missed - this dialog has no OK button (create new document)" )
 123                     active.ok()
 124                 endcatch
 125
 126                 if ( not bSkip ) then
 127                     if ( Active.getRT() = 304 ) then
 128                         if ( Active.getButtonCount() = 1 ) then
 129                             active.ok()
 130                             printlog( CFN & "MSG (" & iActives & "): closed with OK" )
 131                             bSkip = true
 132                         else
 133                         endif
 134                     else
 135                     endif
 136                 endif
 137
 138                 if ( not bSkip ) then
 139                     ' no to update links
 140                     try
 141                         active.no()
 142                         printlog( CFN & "MSG (" & iActives & "): closed with NO" )
 143                     catch
 144                         printlog( CFN & "Missed - this dialog has no NO button (update links)" )
 145                     endcatch
 146                 endif
 147
 148             endif
 149         catch
 150             qaerrorlog( "Problem while trying to handle messageboxes" )
 151             hHandleActivesOnLoad() = false
 152         endcatch
 153
 154     next iTry
 155
 156     ' now see how many dialogs were allowed and how many have been closed
 157     ' this does not change the return value of the function
 158     if ( iActives > iTries ) then
 159         printlog( CFN & "Exit: The test closed more dialogs than expected" )
 160         hHandleActivesOnLoad() = false
 161     else
 162         printlog( CFN & "Exit" )
 163     endif
 164
 165 end function
 166
 167 '*******************************************************************************
 168
 169 function hHandleInitialDialogs() as integer
 170
 171     const CFN = "hHandleInitialDialogs::"
 172
 173     '///<h3>Handle dialogs while opening samples/templates etc.</h3>
 174     '///<i>The returnvalue is of limited use</i><br>
 175     '///<u>Input</u>:
 176     '///<ol>
 177     '///+<li>Nothing</li>
 178     '///</ol>
 179     '///<u>Returns</u>:
 180     '///<ol>
 181     '///+<li>Id of the dialog (integer)</li>
 182     '///<ul>
 183     '///+<li>0: No dialog was found</li>
 184     '///+<li>1: UseOfThisTemplate</li>
 185     '///+<li>2: StarOfficeCalendar1</li>
 186     '///+<li>3: NewsletterLayout</li>
 187     '///+<li>4: PortfolioCurrency</li>
 188     '///+<li>5: StarOfficeCalendar2</li>
 189     '///</ul>
 190     '///</ol>
 191     '///<u>Description</u>:
 192     '///<ul>
 193
 194
 195     ' NOTE: The ID of the dialog will be returned but is of limited use
 196     '       Function returns 0 if no dialogs have been encountered
 197
 198     dim incident as integer
 199         incident = 0
 200
 201     printlog( CFN & "Enter" )
 202     try
 203
 204         '///+<li>Test for UseOfThisTemplate-dialog</li>
 205         Kontext "UseOfThisTemplate"
 206         if ( UseOfThisTemplate.Exists() ) then
 207             printlog( CFN & "Closing UseOfThisTemplate-dialog" )
 208             incident = 1
 209             CancelButton.Click()
 210         endif
 211
 212         '///+<li>Test for StarOfficeCalendar1-dialog</li>
 213         Kontext "StarOfficeCalendar1"
 214         if ( StarOfficeCalendar1.Exists() ) then
 215             printlog( CFN & "Closing StarOfficeCalendar1-dialog" )
 216             incident = 2
 217             Cancel.Click()
 218         endif
 219
 220         '///+<li>Test for StarOfficeCalendar2-dialog (This should be idential to StarofficeCalendar1)</li>
 221         Kontext "StarOfficeCalendar2"
 222         if ( StarOfficeCalendar2.Exists() ) then
 223             printlog( CFN & "Closing StarOfficeCalendar2-dialog" )
 224             incident = 5
 225             Cancel.Click()
 226         endif
 227
 228         '///+<li>Test for NewsletterLayout-dialog</li>
 229         Kontext "NewsletterLayout"
 230         if ( NewsletterLayout.Exists() ) then
 231             printlog( CFN & "Closing NewsletterLayout-dialog" )
 232             incident = 3
 233             OkButton.Click()
 234         endif
 235
 236         '///+<li>Test for PortfolioCurrency-dialog</li>
 237         Kontext "PortfolioCurrency"
 238         if ( PortfolioCurrency.Exists() ) then
 239             printlog( CFN & "Closing PortfolioCurrency-dialog" )
 240             incident = 4
 241             OKButton.Click()
 242         endif
 243     catch
 244     endcatch
 245
 246     hHandleInitialDialogs() = incident
 247     printlog( CFN & "Exit" )
 248
 249     '///</ul>
 250
 251 end function
 252
 253 '*******************************************************************************
 254
 255 function hGetWorkPath() as string
 256
 257     '///<h3>Retrieve the users work directory</h3>
 258     '///<i>Uses: Call to UNO service</i><br>
 259     '///<i>Errorhandling: Fixes &quot;$(user)&quot;-type path (uses fallback)</i><br>
 260     '///<i>Errorhandling: Handles broken UNO connection (uses fallback)</i><br>
 261     '///<u>Input</u>:
 262     '///<ol>
 263     '///+<li>Nothing</li>
 264     '///</ol>
 265     '///<u>Returns</u>:
 266     '///<ol>
 267     '///+<li>Path to local workdir (string)</li>
 268     '///<ul>
 269     '///+<li>Includes trailing slash/backslash</li>
 270     '///</ul>
 271     '///</ol>
 272     '///<u>Description</u>:
 273     '///<ul>
 274
 275     dim sPath as string
 276     dim sDefaultPath as string
 277         sDefaultPath = convertpath( gOfficePath & "user/work" )
 278     dim oOfficeConnect as object
 279     dim oOfficeConfig as object
 280     dim bPathIsFromAPI as boolean
 281
 282     const CFN     = "hGetWorkPath::"
 283
 284     '///+<li>Create an UNO service and ask it for the location of &quot;Work&quot;</li>
 285     try
 286         oOfficeConnect = hGetUnoService( true )
 287         oOfficeConfig  = oOfficeConnect.createInstance( "com.sun.star.util.PathSettings" )
 288         sPath = convertFromURL( oOfficeConfig.Work )
 289         bPathIsFromAPI = true
 290     catch
 291         '///+<li>Handle broken UNO connection</li>
 292         printlog( CFN & "Could not access service, connection broken?" )
 293         sPath = ""
 294         bPathIsFromAPI = false
 295     endcatch
 296
 297     '///+<li>If the path differs from the default do a warnlog</li>
 298     if ( sPath <> sDefaultPath ) then
 299         printlog( CFN & "Default path is: " & sDefaultPath )
 300         printlog( CFN & "Workpath is not defaultpath: " & sPath )
 301         printlog( CFN & "Overriding UNO path" )
 302         sPath = convertpath( gOfficePath & "user\work" )
 303         bPathIsFromAPI = false
 304     endif
 305
 306     '///+<li>Apply fallback in case of broken connection or invalid path</li>
 307     if ( instr( sPath , "$(user)" ) > 0 ) then
 308         printlog( CFN & "sPath has $(user)-type string, using fallback" )
 309         sPath = sDefaultPath
 310         bPathIsFromAPI = false
 311     endif
 312
 313     '///+<li>Add trailing pathseparator, do convertpath</li>
 314     sPath = sPath & "/"
 315     sPath = convertpath( sPath )
 316
 317     '///+<li>Print info to the log and return the path</li>
 318     if ( bPathIsFromAPI ) then
 319         printlog( CFN & "(From API): " & sPath )
 320     else
 321         qaerrorlog( CFN & "(Junked API-Path): " & sPath )
 322     endif
 323     hGetWorkPath() = sPath
 324     '///</ul>
 325
 326 end function
 327
 328 '*******************************************************************************
 329
 330 function hGetFileSizeAsLong( cFileName as string ) as long
 331
 332     '///<h3>Get the size (long) of a file</h3>
 333     '///<u>Input</u>:
 334     '///<ol>
 335     '///+<li>Filename (string)</li>
 336     '///</ol>
 337     '///<u>Returns</u>:
 338     '///<ol>
 339     '///+<li>Size of file (long)</li>
 340     '///</ol>
 341     '///<u>Description</u>:
 342     '///<ul>
 343
 344     const CFN = "hGetFileSizeAsLong::"
 345
 346    ' This function returns the size of a specified file. If it is a directory,
 347    ' the size will default to -1 (A filesize can never be <0 - hopefully)
 348
 349    dim iAttrib as integer
 350
 351    '///+<li>Verify that the given file exists</li>
 352    if ( app.dir( cFileName ) <> "" ) then
 353
 354       try
 355           iAttrib = getattr( cFileName )
 356
 357           '///+<li>Return the size for a file or -1 for a directory</li>
 358           if ( iAttrib <> 16 and iAttrib <> 17 ) then
 359              hGetFileSizeAsLong() = filelen( cFileName )
 360           else
 361              hGetFileSizeAsLong() = -1
 362           endif
 363       catch
 364           qaerrorlog( CFN & "File was not handled correctly: " & cFileName )
 365           hGetFileSizeAsLong() = 0
 366       endcatch
 367
 368    else
 369
 370       '///+<li>Return a size of 0 if the file was not found</li>
 371       hGetFileSizeAsLong() = 0
 372       warnlog( CFN & "File does not exist: " & cFileName )
 373
 374    endif
 375
 376    '///</ul>
 377
 378 end function
 379
 380 '*******************************************************************************
 381
 382 function hGetWorkFile( cFileName as string ) as string
 383
 384     '///<h3>Returns a fully qualified filename to a workfile</h3>
 385     '///<u>Input</u>:
 386     '///<ol>
 387     '///+<li>Filename without path (string)</li>
 388     '///</ol>
 389     '///<u>Returns</u>:
 390     '///<ol>
 391     '///+<li>Filename including path to user work directory (string)</li>
 392     '///</ol>
 393     '///<u>Description</u>:
 394     '///<ul>
 395
 396     '///+<li>Concatenate workpath and filename, convertpath</li>
 397     hGetWorkFile() = convertpath( hGetWorkPath() & cFileName )
 398     '///</ul>
 399
 400 end function
 401
 402