Menu
▾
▴
[Sandweb-commit] CVS: sandweb/lib/SandWeb Log.pm,1.13,1.14 Security.pm,1.2,1.3 Shell.pm,1.23,1.24 UI.pm,1.38,1.39
|
From: Rob H. <for...@us...> - 2003-01-06 09:46:20
|
Update of /cvsroot/sandweb/sandweb/lib/SandWeb In directory sc8-pr-cvs1:/tmp/cvs-serv16252 Modified Files: Log.pm Security.pm Shell.pm UI.pm Log Message: catching up more PODs to the state of the API docs.. Index: Log.pm =================================================================== RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb/Log.pm,v retrieving revision 1.13 retrieving revision 1.14 diff -U2 -r1.13 -r1.14 --- Log.pm 5 Jan 2003 08:59:07 -0000 1.13 +++ Log.pm 6 Jan 2003 09:46:16 -0000 1.14 @@ -42,7 +42,30 @@ -new +METHOD + new - instantiates a new object +SYNOPSIS + + +DESCRIPTION + + +PARAMETERS + + parameter (type: string) (required) + + Default: none. + +RETURN CODES + + 1 = The operation completed successfully. + + 0 = This means that the method got an error proccessing your request. + Perhaps an invalid parameter? + + -1 = This return value means that there was not sufficient permision to + read the files specified, or they did not exist. + +-------------------------------------------------------------------------------- =cut @@ -66,7 +89,32 @@ =head1 -standard +METHOD + + standard + +SYNOPSIS + + +DESCRIPTION + + +PARAMETERS + + parameter (type: string) (required) + + Default: none. + +RETURN CODES + + 1 = The operation completed successfully. + + 0 = This means that the method got an error proccessing your request. + Perhaps an invalid parameter? + + -1 = This return value means that there was not sufficient permision to + read the files specified, or they did not exist. + +-------------------------------------------------------------------------------- - logs with "standard" severity =cut @@ -82,7 +130,31 @@ =head1 -debug +METHOD + + debug + +SYNOPSIS + + +DESCRIPTION + - logs with "debug" severity +PARAMETERS + + parameter (type: string) (required) + + Default: none. + +RETURN CODES + + 1 = The operation completed successfully. + + 0 = This means that the method got an error proccessing your request. + Perhaps an invalid parameter? + + -1 = This return value means that there was not sufficient permision to + read the files specified, or they did not exist. + +-------------------------------------------------------------------------------- =cut @@ -105,7 +177,31 @@ =head1 -error +METHOD + + error + +SYNOPSIS + + +DESCRIPTION + + +PARAMETERS + + parameter (type: string) (required) + + Default: none. - logs with "error" severity +RETURN CODES + + 1 = The operation completed successfully. + + 0 = This means that the method got an error proccessing your request. + Perhaps an invalid parameter? + + -1 = This return value means that there was not sufficient permision to + read the files specified, or they did not exist. + +-------------------------------------------------------------------------------- =cut @@ -121,7 +217,30 @@ =head1 -get_debug_msgs +METHOD + + get_debug_msgs + +SYNOPSIS + + +DESCRIPTION + + +PARAMETERS + + parameter (type: string) (required) + + Default: none. + +RETURN CODES + + 1 = The operation completed successfully. + + 0 = This means that the method got an error proccessing your request. + Perhaps an invalid parameter? + + -1 = This return value means that there was not sufficient permision to + read the files specified, or they did not exist. - returns the debug messages =cut Index: Security.pm =================================================================== RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb/Security.pm,v retrieving revision 1.2 retrieving revision 1.3 diff -U2 -r1.2 -r1.3 --- Security.pm 5 Jan 2003 08:59:07 -0000 1.2 +++ Security.pm 6 Jan 2003 09:46:16 -0000 1.3 @@ -43,8 +43,32 @@ =head1 -new +METHOD + new + +SYNOPSIS + + +DESCRIPTION instantiates a new object + +PARAMETERS + + parameter (type: string) (required) + + Default: none. + +RETURN CODES + + 1 = The operation completed successfully. + + 0 = This means that the method got an error proccessing your request. + Perhaps an invalid parameter? + + -1 = This return value means that there was not sufficient permision to + read the files specified, or they did not exist. + +-------------------------------------------------------------------------------- =cut @@ -58,8 +82,33 @@ =head1 -path +METHOD + path + +SYNOPSIS + + +DESCRIPTION looks for and corrects common security problems with Unix directories + +PARAMETERS + + parameter (type: string) (required) + + Default: none. + +RETURN CODES + + 1 = The operation completed successfully. + + 0 = This means that the method got an error proccessing your request. + Perhaps an invalid parameter? + + -1 = This return value means that there was not sufficient permision to + read the files specified, or they did not exist. + +-------------------------------------------------------------------------------- + =cut @@ -82,8 +131,33 @@ =head1 -shell +METHOD + shell + +SYNOPSIS + + +DESCRIPTION looks for and corrects common security problems with calling to the Unix shell + + +PARAMETERS + + parameter (type: string) (required) + + Default: none. + +RETURN CODES + + 1 = The operation completed successfully. + + 0 = This means that the method got an error proccessing your request. + Perhaps an invalid parameter? + + -1 = This return value means that there was not sufficient permision to + read the files specified, or they did not exist. + + =cut Index: Shell.pm =================================================================== RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb/Shell.pm,v retrieving revision 1.23 retrieving revision 1.24 diff -U2 -r1.23 -r1.24 --- Shell.pm 5 Jan 2003 08:59:07 -0000 1.23 +++ Shell.pm 6 Jan 2003 09:46:16 -0000 1.24 @@ -62,8 +62,85 @@ Methods +METHOD + new -new +SYNOPSIS - instantiates a new object + my $shell = SandWeb::Shell->new( + 'vcs_username' => "$vcs_username", + 'vcs_password' => "$vcs_password", + 'system_username' => "$system_username", + 'system_password' => "$system_password", + 'bindir' => "$bindir", + 'system' => "$system", + 'vcs' => "$vcs", + 'log_obj' => $log, + ); + +DESCRIPTION + + This method is a constructor. + +PARAMETERS + + bindir (type: string) (required) + + the full path on the local box to SandWeb's scripts, like sandweb-expect and sandweb-admin + + Default: none. + + system_username (type: string) (optional) + + the user's OS username + + Default: none. + + system_password (type: string) (optional) + + the user's OS password + + Default: none. + + vcs_username (type: string) (optional) + + the user's VCS username + + Default: none. + + vcs_password (type: string) (optional) + + the user's VCS password + + Default: none. + + system (type: boolean) (optional) + + system is true if the user wants to authenticate with the OS, false if not + + Default: none. + + vcs (type: boolean) (optional) + + system is true if the user wants to authenticate with the VCS server, false if not + + Default: none. + + log (type: SandWeb::Log) (required) + + log is a reference to an object based on the SandWeb::Log class + + Default: none. + +RETURN CODES + + 1 = The operation completed successfully. + + 0 = This means that the method got an error proccessing your request. + Perhaps an invalid parameter? + + -1 = This return value means that there was not sufficient permision to + read the files specified, or they did not exist. + +-------------------------------------------------------------------------------- =cut @@ -122,7 +199,39 @@ =head1 -execute +METHOD + execute + +SYNOPSIS + + my $output = $shell->execute( + command => $command, + ) + +DESCRIPTION + + This method carries out execution of a shell command. It decides how to use + sandweb-expect if the user wants to authenticate against the system (OS) or + a VCS server. + +PARAMETERS + + command (type: string) (required) + + the command to be executed. Returns a hash with the result in the "output" key + and the errorlevel in the "error" key. + + Default: none. - executes a given command +RETURN CODES + + 1 = The operation completed successfully. + + 0 = This means that the method got an error proccessing your request. + Perhaps an invalid parameter? + + -1 = This return value means that there was not sufficient permision to + read the files specified, or they did not exist. + +-------------------------------------------------------------------------------- =cut @@ -305,7 +414,39 @@ =head1 -pipe +METHOD + pipe + +SYNOPSIS + + my $filehandle = $shell->pipe( + command => $command, + ) + +DESCRIPTION + + This method carries out execution of a shell command, and attaches + the command to a filehandle through a pipe. + +PARAMETERS + + command (type: string) (required) + + the command to be executed. Returns a filehandle which is a reference + to a pipe to the running command. + + Default: none. + +RETURN CODES + + 1 = The operation completed successfully. + + 0 = This means that the method got an error proccessing your request. + Perhaps an invalid parameter? + + -1 = This return value means that there was not sufficient permision to + read the files specified, or they did not exist. + +-------------------------------------------------------------------------------- - opens a pipe to a file =cut Index: UI.pm =================================================================== RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb/UI.pm,v retrieving revision 1.38 retrieving revision 1.39 diff -U2 -r1.38 -r1.39 --- UI.pm 5 Jan 2003 08:59:07 -0000 1.38 +++ UI.pm 6 Jan 2003 09:46:17 -0000 1.39 @@ -52,8 +52,31 @@ Methods +METHOD + new -new +SYNOPSIS + + +DESCRIPTION + + +PARAMETERS + + parameter (type: string) (required) + + Default: none. + +RETURN CODES + + 1 = The operation completed successfully. + + 0 = This means that the method got an error proccessing your request. + Perhaps an invalid parameter? + + -1 = This return value means that there was not sufficient permision to + read the files specified, or they did not exist. + +-------------------------------------------------------------------------------- - instantiates a new object =cut @@ -76,7 +99,31 @@ =head1 -print_screen +METHOD + + print_screen + +SYNOPSIS + + +DESCRIPTION + + +PARAMETERS - prints out HTML + parameter (type: string) (required) + + Default: none. + +RETURN CODES + + 1 = The operation completed successfully. + + 0 = This means that the method got an error proccessing your request. + Perhaps an invalid parameter? + + -1 = This return value means that there was not sufficient permision to + read the files specified, or they did not exist. + +-------------------------------------------------------------------------------- =cut @@ -127,7 +174,31 @@ =head1 -print_popup +METHOD + + print_popup + +SYNOPSIS + + +DESCRIPTION - prints an HTML "pop-up" window + +PARAMETERS + + parameter (type: string) (required) + + Default: none. + +RETURN CODES + + 1 = The operation completed successfully. + + 0 = This means that the method got an error proccessing your request. + Perhaps an invalid parameter? + + -1 = This return value means that there was not sufficient permision to + read the files specified, or they did not exist. + +-------------------------------------------------------------------------------- =cut @@ -174,7 +245,31 @@ =head1 -get_menu_bar +METHOD + + get_menu_bar - gets the "menu bar" part of the HTML page +SYNOPSIS + + +DESCRIPTION + + +PARAMETERS + + parameter (type: string) (required) + + Default: none. + +RETURN CODES + + 1 = The operation completed successfully. + + 0 = This means that the method got an error proccessing your request. + Perhaps an invalid parameter? + + -1 = This return value means that there was not sufficient permision to + read the files specified, or they did not exist. + +-------------------------------------------------------------------------------- =cut @@ -200,7 +295,31 @@ =head1 -get_menu +METHOD + + get_menu + +SYNOPSIS + + +DESCRIPTION + - get the "menu" part of the HTML template +PARAMETERS + + parameter (type: string) (required) + + Default: none. + +RETURN CODES + + 1 = The operation completed successfully. + + 0 = This means that the method got an error proccessing your request. + Perhaps an invalid parameter? + + -1 = This return value means that there was not sufficient permision to + read the files specified, or they did not exist. + +-------------------------------------------------------------------------------- =cut @@ -225,7 +344,30 @@ =head1 -get_javascript +METHOD + + get_javascript + +SYNOPSIS + + +DESCRIPTION + + +PARAMETERS + + parameter (type: string) (required) + + Default: none. + +RETURN CODES + + 1 = The operation completed successfully. + + 0 = This means that the method got an error proccessing your request. + Perhaps an invalid parameter? + + -1 = This return value means that there was not sufficient permision to + read the files specified, or they did not exist. - gets javascript content for the HTML template (if any) =cut |
