testautomation/global/tools/includes/optional/t_server_info.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_server_info.inc,v $
  10 '*
  11 '* $Revision: 1.1 $
  12 '*
  13 '* last change: $Author: jsi $ $Date: 2008-06-13 10:27:08 $
  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 : Tools to retrieve information about available servers
  37 '*
  38 '*******************************************************************************
  39 '**
  40 ' #1 hGetServerInfo ' Retrieve names and services of some servers
  41 ' #0 hPrintServerInstructions ' print instructions to the log
  42 '**
  43 '\******************************************************************************
  44
  45 function hGetServerInfo( sType as string, sItem as string ) as string
  46
  47
  48     '///<h3>Retrieve names and services of some servers</h3>
  49     '///<i>This function retrieves some information about available
  50     '///+ servers within the LAN. These services can be anything like
  51     '///+ http-server, ftp etc.<br>
  52     '///+ Please make sure you read the comments in the configuration
  53     '///+ file to fully understand what this thing does.</i><br><br>
  54
  55     '///<u>Input values:</u><br>
  56     '///<ol>
  57
  58     '///+<li>Type (string). Valid options:</li>
  59     '///<ul>
  60     '///+<li>&quot;http_internal&quot;</li>
  61     '///+<li>&quot;http_external&quot;</li>
  62     '///+<li>&quot;ftp_internal&quot;</li>
  63     '///+<li>&quot;ftp_external&quot;</li>
  64     '///</ul>
  65
  66     '///+<li>Item (string). Valid options:</li>
  67     '///<ul>
  68     '///+<li>&quot;Name&quot; to get a name for the server</li>
  69     '///+<li>&quot;Port&quot; to get the server's port</li>
  70     '///+<li>&quot;Protocol&quot; to get the supported protocol</li>
  71     '///+<li>&quot;URL&quot; to get the url (e.g. www.heise.de)</li>
  72     '///+<li>&quot;UseProxy&quot; to find out whether proxies are needed or not</li>
  73     '///+<li>&quot;User&quot; to get a loginname</li>
  74     '///+<li>&quot;Pass&quot; to get a password</li>
  75     '///</ul>
  76
  77     '///</ol>
  78
  79
  80     '///<u>Return Value:</u><br>
  81     '///<ol>
  82     '///+<li>Name, port or other info of an item (string)</li>
  83     '///<ul>
  84     '///+<li>Empty String on error</li>
  85     '///+<li>Unique name for a server (can be NIS name)</li>
  86     '///+<li>Port (optional, e.g. 80 for http, 21 for ftp ...)</li>
  87     '///+<li>Protocol (e.g. &quot;http://&quot; or &quot;ftp://&quot;</li>
  88     '///+<li>URL like www.mydomain.de</li>
  89     '///+<li>UseProxy (&quot;yes&quot;/&quot;no&quot;)</li>
  90     '///+<li>User (some username)</li>
  91     '///+<li>Password (some password, plain text!)
  92     '///</ul>
  93     '///</ol>
  94
  95     const CFN = "hGetServerInfo::"
  96
  97     dim irc as integer ' some integer returnvalue
  98     dim crc as string  ' some string returnvalue
  99
 100     ' This is the workfile. Make sure it exists and contains valid data
 101     dim cFile as string
 102         cFile = gTesttoolPath & "sun_global\input\servers.txt"
 103         ' cFile = gTesttoolPath & "global\input\servers.txt"
 104         cFile = convertpath ( cFile )
 105
 106     ' this is a temporary list that holds the workfile
 107     dim acList( 50 ) as string
 108
 109     '///<u>Description:</u>
 110     '///<ul>
 111     '///+<li>Open the file, read the section, abort on error</li>
 112     irc = hGetDataFileSection( cFile, acList(), sType , "" , "" )
 113     if ( irc = 0 ) then
 114         qaerrorlog( CFN & "File or section not found" )
 115         hGetServerInfo() = ""
 116         hPrintServerInstructions()
 117         exit function
 118     endif
 119
 120     '///+<li>Isolate the key</li>
 121     crc = hGetValueForKeyAsString( acList(), sItem )
 122     if ( instr( crc , "Error:" ) > 0 ) then
 123         qaerrorlog( CFN & "The requested item could not be found" )
 124         hGetServerInfo() = ""
 125         hPrintServerInstructions()
 126         exit function
 127     endif
 128
 129     '///+<li>Return the requested item</li>
 130
 131     '///</ul>
 132
 133     hGetServerInfo() = crc
 134
 135 end function
 136
 137 '*******************************************************************************
 138
 139 function hPrintServerInstructions()
 140
 141     printlog( "" )
 142     printlog( "How to configure server settings for your local network" )
 143     printlog( "" )
 144     printlog( "1. Edit the sample configuration file" )
 145     printlog( "   Location: global/input/servers.txt" )
 146     printlog( "   Replace servernames, ports etc. with valid entries" )
 147     printlog( "" )
 148     printlog( "2. Edit the function hGetServerInfo" )
 149     printlog( "   Make the first line with cFile = ... a comment"
 150     printlog( "   Make the second line with cFile = ... active"
 151     printlog( "   Save the file" )
 152     printlog( "" )
 153
 154 end function