You can subscribe to this list here.
2001 |
Jan
|
Feb
|
Mar
|
Apr
|
May
|
Jun
|
Jul
|
Aug
|
Sep
|
Oct
(28) |
Nov
(58) |
Dec
(85) |
---|---|---|---|---|---|---|---|---|---|---|---|---|
2002 |
Jan
(125) |
Feb
(222) |
Mar
(274) |
Apr
(51) |
May
(22) |
Jun
(50) |
Jul
(15) |
Aug
(33) |
Sep
(11) |
Oct
(29) |
Nov
(17) |
Dec
(1) |
2003 |
Jan
(100) |
Feb
(21) |
Mar
(7) |
Apr
(45) |
May
|
Jun
(43) |
Jul
(27) |
Aug
(24) |
Sep
|
Oct
|
Nov
|
Dec
|
2004 |
Jan
(1) |
Feb
|
Mar
(13) |
Apr
|
May
(1) |
Jun
|
Jul
|
Aug
(7) |
Sep
|
Oct
|
Nov
|
Dec
(4) |
2005 |
Jan
|
Feb
|
Mar
|
Apr
|
May
|
Jun
|
Jul
|
Aug
|
Sep
|
Oct
|
Nov
|
Dec
(1) |
From: Rob H. <for...@us...> - 2002-11-06 05:34:45
|
Update of /cvsroot/sandweb/sandweb/templates In directory usw-pr-cvs1:/tmp/cvs-serv4402/templates Modified Files: vcs.html Log Message: the "ask every time for repo password" functionality is implemented. not as hard as I thought it was going to be :) Index: vcs.html =================================================================== RCS file: /cvsroot/sandweb/sandweb/templates/vcs.html,v retrieving revision 1.3 retrieving revision 1.4 diff -U2 -r1.3 -r1.4 --- vcs.html 5 Nov 2002 21:12:05 -0000 1.3 +++ vcs.html 6 Nov 2002 05:34:42 -0000 1.4 @@ -2,10 +2,10 @@ <tr> <center> - <form submit="<TMPL_VAR NAME=PROGNAME>"> + <form submit="<TMPL_VAR NAME=PROGNAME>" type="POST"> <input type="hidden" name="action" value="vcs"> <input type="hidden" name="main_window_url" value="<TMPL_VAR NAME=MAIN_WINDOW_URL>"> Please enter VCS password : <br> - <input type="text" name="filename" name="vcs_password"> + <input type="password" name="filename" name="repo_password"> <TMPL_LOOP NAME="FILENAME_LOOP"> <input type="hidden" name="filename" value="<TMPL_VAR NAME=FILENAME>"> |
From: Rob H. <for...@us...> - 2002-11-06 05:34:45
|
Update of /cvsroot/sandweb/sandweb/bin In directory usw-pr-cvs1:/tmp/cvs-serv4402/bin Modified Files: sandweb.cgi Log Message: the "ask every time for repo password" functionality is implemented. not as hard as I thought it was going to be :) Index: sandweb.cgi =================================================================== RCS file: /cvsroot/sandweb/sandweb/bin/sandweb.cgi,v retrieving revision 1.329 retrieving revision 1.330 diff -U2 -r1.329 -r1.330 --- sandweb.cgi 6 Nov 2002 05:18:10 -0000 1.329 +++ sandweb.cgi 6 Nov 2002 05:34:42 -0000 1.330 @@ -308,4 +308,5 @@ module_name => $module_name, repo_name => $repo_name, + repo_password => $repo_password, filename => \@filename, location => $location, @@ -318,4 +319,5 @@ module_name => $module_name, repo_name => $repo_name, + repo_password => $repo_password, filename => \@filename, location => $location, @@ -1716,4 +1718,5 @@ my $module_name = $args{'module_name'}; my $repo_name = $args{'repo_name'}; + my $repo_password = $args{'repo_password'}; my $vcs_command = $args{'vcs_command'}; my $vcs_message = $args{'message'}; @@ -1771,4 +1774,5 @@ module_name => $module_name, repo_name => $repo_name, + repo_password => $repo_password, filename => \@filename, location => $location, @@ -2345,5 +2349,11 @@ my $repo_server = $user->get_repo_server(repo => $repo_name); my $repo_username = $user->get_repo_username(repo => $repo_name); - my $repo_password = $user->get_repo_password(repo => $repo_name); + + # + # if there isn't a repo_password stored in the config file, see if there + # is one being submitted + # + + my $repo_password = $user->get_repo_password(repo => $repo_name) || $args{'repo_password'}; my $remember_repo_password = $user->get_repo_password(repo => $repo_name); my $repo_type = $user->get_repo_type(repo => $repo_name); |
From: Rob H. <for...@us...> - 2002-11-06 05:18:13
|
Update of /cvsroot/sandweb/sandweb/bin In directory usw-pr-cvs1:/tmp/cvs-serv505/bin Modified Files: sandweb.cgi Log Message: passwords are now remembered on a per-repository basis. Index: sandweb.cgi =================================================================== RCS file: /cvsroot/sandweb/sandweb/bin/sandweb.cgi,v retrieving revision 1.328 retrieving revision 1.329 diff -U2 -r1.328 -r1.329 --- sandweb.cgi 5 Nov 2002 21:12:03 -0000 1.328 +++ sandweb.cgi 6 Nov 2002 05:18:10 -0000 1.329 @@ -942,5 +942,4 @@ my $repo_username = $args{'repo_username'}; my $repo_password = $args{'repo_password'}; - my $remember_repo_password = $args{'remember_repo_password'}; my $repo_type = $args{'repo_type'}; my $repo_connection = $args{'repo_connection'}; @@ -953,4 +952,6 @@ $log->debug("<pre>" . Dumper(\%args) . "</pre>"); + my $remember_repo_password; + my $new_string = 'Add a new repository'; my $username = $auth->get_username(); @@ -1073,5 +1074,5 @@ } - if ($cgi->param('remember_repo_password') eq "on") { + if ($remember_repo_password) { $remember_repo_password = 'checked="on"'; } else { @@ -1721,6 +1722,5 @@ my $count = 0; - my $confirm_password = 1; -# $config->{'repo'}->{"$repo_name"}->{'module'}->{"$module_name"}->{'confirm_password'}; + my $remember_repo_password = $user->get_remember_repo_password(repo => $repo_name); while ( $args{'filename'}->[$count] ) { @@ -1764,5 +1764,5 @@ } - unless ($confirm_password) { + if ($remember_repo_password) { vcs_commit( @@ -2820,5 +2820,5 @@ username => $repo_username, password => $repo_password, - remember_password => $remember_repo_password, + remember_repo_password => $remember_repo_password, connection => $repo_connection, type => $repo_type, @@ -2832,4 +2832,5 @@ username => $repo_username, password => $repo_password, + remember_repo_password => $remember_repo_password, connection => $repo_connection, type => $repo_type, |
From: Rob H. <for...@us...> - 2002-11-06 05:17:26
|
Update of /cvsroot/sandweb/sandweb/lib/SandWeb In directory usw-pr-cvs1:/tmp/cvs-serv32663/lib/SandWeb Modified Files: Config.pm Log Message: we should allow null values, some attributes don't need to exist if they are not being used ( like remember_repo_password ) Index: Config.pm =================================================================== RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb/Config.pm,v retrieving revision 1.31 retrieving revision 1.32 diff -U2 -r1.31 -r1.32 --- Config.pm 7 Oct 2002 18:35:52 -0000 1.31 +++ Config.pm 6 Nov 2002 05:17:22 -0000 1.32 @@ -182,4 +182,5 @@ my $server = $args{'server'} || ''; my $username = $args{'username'} || ''; + my $remember_repo_password = $args{'remember_repo_password'} || ''; my $password = $args{'password'} || ''; my $connection = $args{'connection'} || ''; @@ -194,4 +195,5 @@ $self->{'repo'}->{$name}->{'server'} = $server; $self->{'repo'}->{$name}->{'username'} = $username; + $self->{'repo'}->{$name}->{'remember_repo_password'} = $remember_repo_password; $self->{'repo'}->{$name}->{'password'} = $password; $self->{'repo'}->{$name}->{'connection'} = $connection; @@ -209,5 +211,5 @@ my $username = $args{'username'} || ''; my $password = $args{'password'} || ''; - my $remember_password = $args{'remember_password'} || ''; + my $remember_repo_password = $args{'remember_repo_password'} || ''; my $connection = $args{'connection'} || ''; my $type = $args{'type'} || ''; @@ -216,11 +218,11 @@ if ($self->repository_exists(repo => $name)) { $self->{'repo'}->{$name}->{'name'} = $name; - $self->{'repo'}->{$name}->{'server'} = $server if ($server); - $self->{'repo'}->{$name}->{'username'} = $username if ($username); - $self->{'repo'}->{$name}->{'password'} = $password if ($password); - $self->{'repo'}->{$name}->{'remember_password'} = $remember_password if ($remember_password); - $self->{'repo'}->{$name}->{'connection'} = $connection if ($connection); - $self->{'repo'}->{$name}->{'type'} = $type if ($type); - $self->{'repo'}->{$name}->{'root'} = $root if ($root); + $self->{'repo'}->{$name}->{'server'} = $server; + $self->{'repo'}->{$name}->{'username'} = $username; + $self->{'repo'}->{$name}->{'password'} = $password; + $self->{'repo'}->{$name}->{'remember_repo_password'} = $remember_repo_password; + $self->{'repo'}->{$name}->{'connection'} = $connection; + $self->{'repo'}->{$name}->{'type'} = $type; + $self->{'repo'}->{$name}->{'root'} = $root; } else { return 0; @@ -311,5 +313,5 @@ my $repo_name = $args{'repo'}; if ($self->repository_exists(repo => $repo_name)) { - return $self->{'repo'}->{$repo_name}->{'remember_password'} || '' + return $self->{'repo'}->{$repo_name}->{'remember_repo_password'} || '' } else { return ''; @@ -322,5 +324,5 @@ my $repo_server = $args{'value'}; if ($self->repository_exists(repo => $repo_name)) { - $self->{'repo'}->{$repo_name}->{'remember_password'} = $value || ''; + $self->{'repo'}->{$repo_name}->{'remember_repo_password'} = $value || ''; return 1; } else { |
From: Rob H. <for...@us...> - 2002-11-05 21:12:09
|
Update of /cvsroot/sandweb/sandweb/templates In directory usw-pr-cvs1:/tmp/cvs-serv27037/templates Modified Files: vcs.html Log Message: oh yeah, that's how you pass an array through a template, using a template loop. when $cgi->param() finds multiple keys in an incoming url ( or HTTP POST ), it puts then together into an array. Index: vcs.html =================================================================== RCS file: /cvsroot/sandweb/sandweb/templates/vcs.html,v retrieving revision 1.2 retrieving revision 1.3 diff -U2 -r1.2 -r1.3 --- vcs.html 5 Nov 2002 08:45:31 -0000 1.2 +++ vcs.html 5 Nov 2002 21:12:05 -0000 1.3 @@ -8,5 +8,7 @@ <br> <input type="text" name="filename" name="vcs_password"> - + <TMPL_LOOP NAME="FILENAME_LOOP"> + <input type="hidden" name="filename" value="<TMPL_VAR NAME=FILENAME>"> + </TMPL_LOOP> <input type="hidden" name="location" value="<TMPL_VAR NAME=LOCATION>"> <input type="hidden" name="filename" value="<TMPL_VAR NAME=FILENAME>"> |
From: Rob H. <for...@us...> - 2002-11-05 21:12:09
|
Update of /cvsroot/sandweb/sandweb/bin In directory usw-pr-cvs1:/tmp/cvs-serv27037/bin Modified Files: sandweb.cgi Log Message: oh yeah, that's how you pass an array through a template, using a template loop. when $cgi->param() finds multiple keys in an incoming url ( or HTTP POST ), it puts then together into an array. Index: sandweb.cgi =================================================================== RCS file: /cvsroot/sandweb/sandweb/bin/sandweb.cgi,v retrieving revision 1.327 retrieving revision 1.328 diff -U2 -r1.327 -r1.328 --- sandweb.cgi 5 Nov 2002 08:45:31 -0000 1.327 +++ sandweb.cgi 5 Nov 2002 21:12:03 -0000 1.328 @@ -1782,5 +1782,5 @@ PROGNAME => $progname, LOCATION => $location, - FILENAME => @filename, + FILENAME_LOOP => \@filename_loop, VCS_COMMAND => $vcs_command, VCS_MESSAGE => $vcs_message, |
From: Rob H. <for...@us...> - 2002-11-05 08:45:34
|
Update of /cvsroot/sandweb/sandweb/bin In directory usw-pr-cvs1:/tmp/cvs-serv7988/bin Modified Files: sandweb.cgi Log Message: hmm.. i had broken the passing of the file array, so every cvs command was invoked on every file. i fixed that, but now i can only do either single files or everything :/ passing arrays through templates as hidden <input> variables is a pain in the ass, but we don't really have a better way yet :) i'll fix it up later, all the password stuff isn't actually hooked up yet anyway so i need to work on that still. Index: sandweb.cgi =================================================================== RCS file: /cvsroot/sandweb/sandweb/bin/sandweb.cgi,v retrieving revision 1.326 retrieving revision 1.327 diff -U2 -r1.326 -r1.327 --- sandweb.cgi 5 Nov 2002 08:37:05 -0000 1.326 +++ sandweb.cgi 5 Nov 2002 08:45:31 -0000 1.327 @@ -1782,4 +1782,5 @@ PROGNAME => $progname, LOCATION => $location, + FILENAME => @filename, VCS_COMMAND => $vcs_command, VCS_MESSAGE => $vcs_message, |
From: Rob H. <for...@us...> - 2002-11-05 08:45:34
|
Update of /cvsroot/sandweb/sandweb/templates In directory usw-pr-cvs1:/tmp/cvs-serv7988/templates Modified Files: vcs.html Log Message: hmm.. i had broken the passing of the file array, so every cvs command was invoked on every file. i fixed that, but now i can only do either single files or everything :/ passing arrays through templates as hidden <input> variables is a pain in the ass, but we don't really have a better way yet :) i'll fix it up later, all the password stuff isn't actually hooked up yet anyway so i need to work on that still. Index: vcs.html =================================================================== RCS file: /cvsroot/sandweb/sandweb/templates/vcs.html,v retrieving revision 1.1 retrieving revision 1.2 diff -U2 -r1.1 -r1.2 --- vcs.html 5 Nov 2002 08:37:05 -0000 1.1 +++ vcs.html 5 Nov 2002 08:45:31 -0000 1.2 @@ -10,4 +10,5 @@ <input type="hidden" name="location" value="<TMPL_VAR NAME=LOCATION>"> + <input type="hidden" name="filename" value="<TMPL_VAR NAME=FILENAME>"> <input type="hidden" name="module_name" value="<TMPL_VAR NAME=MODULE_NAME>"> <input type="hidden" name="repo_name" value="<TMPL_VAR NAME=REPO_NAME>"> |
From: Rob H. <for...@us...> - 2002-11-05 08:37:11
|
Update of /cvsroot/sandweb/sandweb/templates In directory usw-pr-cvs1:/tmp/cvs-serv4327/templates Added Files: vcs.html Log Message: partially implemented password confirmation for vcs, this actually is easier than do some kind of master password scheme ( at least the same amount of work ). --- NEW FILE --- <table width="100%" border="1" align="center" cellspacing="0" cellpadding="0"> <tr> <center> <form submit="<TMPL_VAR NAME=PROGNAME>"> <input type="hidden" name="action" value="vcs"> <input type="hidden" name="main_window_url" value="<TMPL_VAR NAME=MAIN_WINDOW_URL>"> Please enter VCS password : <br> <input type="text" name="filename" name="vcs_password"> <input type="hidden" name="location" value="<TMPL_VAR NAME=LOCATION>"> <input type="hidden" name="module_name" value="<TMPL_VAR NAME=MODULE_NAME>"> <input type="hidden" name="repo_name" value="<TMPL_VAR NAME=REPO_NAME>"> <input type="hidden" name="vcs_command" value="<TMPL_VAR NAME=VCS_COMMAND>"> <input type="hidden" name="vcs_message" value="<TMPL_VAR NAME=VCS_MESSAGE>"> <input name="Submit" value="1" type="submit" value="Ok"> </form> </center> </tr> </table> |
From: Rob H. <for...@us...> - 2002-11-05 08:37:11
|
Update of /cvsroot/sandweb/sandweb/bin In directory usw-pr-cvs1:/tmp/cvs-serv4327/bin Modified Files: sandweb.cgi Log Message: partially implemented password confirmation for vcs, this actually is easier than do some kind of master password scheme ( at least the same amount of work ). Index: sandweb.cgi =================================================================== RCS file: /cvsroot/sandweb/sandweb/bin/sandweb.cgi,v retrieving revision 1.325 retrieving revision 1.326 diff -U2 -r1.325 -r1.326 --- sandweb.cgi 17 Oct 2002 06:31:36 -0000 1.325 +++ sandweb.cgi 5 Nov 2002 08:37:05 -0000 1.326 @@ -302,12 +302,24 @@ } - vcs_commit( - ck_auth => $ck_auth, - vcs_command => $vcs_command, - module_name => $module_name, - repo_name => $repo_name, - filename => \@filename, - location => $location, - ); + if ($submit) { + vcs_commit( + ck_auth => $ck_auth, + vcs_command => $vcs_command, + module_name => $module_name, + repo_name => $repo_name, + filename => \@filename, + location => $location, + main_window_url => $main_window_url, + ); + } else { + vcs_menu( + ck_auth => $ck_auth, + vcs_command => $vcs_command, + module_name => $module_name, + repo_name => $repo_name, + filename => \@filename, + location => $location, + ); + } exit; } @@ -1680,4 +1692,112 @@ ############################################################################### +# vcs menu +# +# asks user for VCS password +# +# args: +# +# ck_auth - the sessions cookie +# vcs_command - name of the Repository object method to be invoked +# filename - name of the file(s) that the vcs_command should +# be used with. NOTE: this is an array +# location - system path to the file(s) specified by filename +# repo_name - name of the current repository. +# module_name - name of the current module. +# message - message to the VCS system. +############################################################################### + +sub vcs_menu { + my %args = @_; + + my $ck_auth = $args{'ck_auth'}; + my $location = $args{'location'}; + my $module_name = $args{'module_name'}; + my $repo_name = $args{'repo_name'}; + my $vcs_command = $args{'vcs_command'}; + my $vcs_message = $args{'message'}; + my $main_window_url = "$ENV{'HTTP_REFERER'}"; + my @filename_loop = (); + my $count = 0; + + my $confirm_password = 1; +# $config->{'repo'}->{"$repo_name"}->{'module'}->{"$module_name"}->{'confirm_password'}; + + while ( $args{'filename'}->[$count] ) { + # build loop to pass filenames through template + # + my %entry; + $entry{'FILENAME'} = $args{'filename'}->[$count]; + push (@filename_loop, \%entry); + $count++; + } + + my @filename = (); + $count = 0; + + while ( $args{'filename'}->[$count] ) { + push (@filename, $args{'filename'}->[$count]); + $count++; + } + + unless ( @filename || @filename eq '.' ) { + $log->debug("no file was selected for vcs action"); + my $content = $ui->get_menu( + MENU => 'output', + LOCATION => $location, + FILENAME => '', + PROGNAME => $progname, + OUTPUT => "Please select file(s) or folder(s) to perform vcs action on", + ERROR => "No file(s) or folder(s) selected", + ); + print $cgi->header( -cookie => $ck_auth ); + $ui->print_popup( + TITLE => 'SandWeb : vcs', + MENU_TITLE => 'SandWeb', + SUBMENU_TITLE => 'vcs', + FOOTER => '', + CONTENT => $content, + MESSAGE => $message, + ); + + exit; + } + + unless ($confirm_password) { + + vcs_commit( + ck_auth => $ck_auth, + vcs_command => $vcs_command, + module_name => $module_name, + repo_name => $repo_name, + filename => \@filename, + location => $location, + ); + + exit; + } + + my $content = $ui->get_menu( + MENU => 'vcs', + PROGNAME => $progname, + LOCATION => $location, + VCS_COMMAND => $vcs_command, + VCS_MESSAGE => $vcs_message, + MODULE_NAME => $module_name, + REPO_NAME => $repo_name, + MAIN_WINDOW_URL => $main_window_url, + ); + print $cgi->header( -cookie => $ck_auth ); + $ui->print_popup( + TITLE => 'SandWeb : vcs', + MENU_TITLE => 'SandWeb', + SUBMENU_TITLE => 'vcs', + FOOTER => '', + CONTENT => $content, + MESSAGE => $message, + ); +} + +############################################################################### # tag menu # @@ -2215,6 +2335,5 @@ my $users_dir = $config->{'paths'}->{'users_dir'}; my $repo_name = $args{'repo_name'}; - my $prev_url = "$ENV{'HTTP_REFERER'}"; - $log->debug("prev_url $prev_url"); + my $main_window_url = $args{'main_window_url'}; my %return; @@ -2364,5 +2483,5 @@ MENU_TITLE => 'SandWeb', SUBMENU_TITLE => "VCS $vcs_command", - PREVIOUS_URL => $prev_url, + PREVIOUS_URL => $main_window_url, FOOTER => '', CONTENT => $content, @@ -2385,5 +2504,5 @@ MENU_TITLE => 'SandWeb', SUBMENU_TITLE => "VCS $vcs_command", - PREVIOUS_URL => $prev_url, + PREVIOUS_URL => $main_window_url, FOOTER => '', CONTENT => $content, @@ -2419,5 +2538,5 @@ MENU_TITLE => 'SandWeb', SUBMENU_TITLE => "VCS $vcs_command", - PREVIOUS_URL => $prev_url, + PREVIOUS_URL => $main_window_url, FOOTER => '', CONTENT => $content, |
From: Rob H. <for...@us...> - 2002-10-19 05:20:32
|
Update of /cvsroot/sandweb/sandweb/doc In directory usw-pr-cvs1:/tmp/cvs-serv5800 Removed Files: auth-spec.txt Log Message: hmm.. this doesn't really need to be here --- auth-spec.txt DELETED --- |
From: Rob H. <for...@us...> - 2002-10-19 05:19:41
|
Update of /cvsroot/sandweb/sandweb/doc In directory usw-pr-cvs1:/tmp/cvs-serv5526 Removed Files: features.list Log Message: i think we've beat all these ideas to death on the mailing list; they are either implemented or we won't implement them, for the most part. --- features.list DELETED --- |
From: Rob H. <for...@us...> - 2002-10-19 05:13:51
|
Update of /cvsroot/sandweb/sandweb/doc/API/Auth In directory usw-pr-cvs1:/tmp/cvs-serv4481/Auth Modified Files: FlatFile.txt Log Message: done Index: FlatFile.txt =================================================================== RCS file: /cvsroot/sandweb/sandweb/doc/API/Auth/FlatFile.txt,v retrieving revision 1.1 retrieving revision 1.2 diff -U2 -r1.1 -r1.2 --- FlatFile.txt 17 Oct 2002 07:30:47 -0000 1.1 +++ FlatFile.txt 19 Oct 2002 05:13:48 -0000 1.2 @@ -12,67 +12,73 @@ SYNOPSIS + my $flatfile = SandWeb::Auth::FlatFile::->new( + 'log_obj' => $log, + ); DESCRIPTION + This method is a constructor. PARAMETERS - parameter (type: string) (required) - + log_obj (type: string) (required) + + A reference to an instantiated log object. + Default: none. RETURN CODES - 1 = The operation completed successfully. - + Returns a reference to a FlatFile object. + 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. -verify_password -------------------------------------------------------------------------------- METHOD - methodname -SYNOPSIS + verify_password +SYNOPSIS + my $user_is_authentic = $flatfile->verify_password( + username => $username, + password => $password, + user_dir => $user_dir, + salt => $salt, + }; + DESCRIPTION + This method verifies if a user is authentic or not by querying SandWeb's flat-file + database. + PARAMETERS - parameter (type: string) (required) + username (type: string) (required) + + The current user's full username. 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. - -_logobj --------------------------------------------------------------------------------- - -METHOD - methodname + password (type: string) (required) -SYNOPSIS + The encrypted password to verify. + + Default: none. + user_dir (type: string) (required) -DESCRIPTION + The root of where homedirs are stored. + FIXME - why does verify_password need to know this? + + Default: none. -PARAMETERS + salt (type: string) (required) - parameter (type: string) (required) + The salt used for the encrypted password. Default: none. @@ -84,6 +90,2 @@ 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. - |
From: Rob H. <for...@us...> - 2002-10-19 05:05:14
|
Update of /cvsroot/sandweb/sandweb/doc/API/File In directory usw-pr-cvs1:/tmp/cvs-serv2708 Modified Files: Unix.txt Log Message: Copied File over File/Unix, it's basically the same thing. I need to bring them both up to date anyway though, there are a couple differences. Index: Unix.txt =================================================================== RCS file: /cvsroot/sandweb/sandweb/doc/API/File/Unix.txt,v retrieving revision 1.1 retrieving revision 1.2 diff -U2 -r1.1 -r1.2 --- Unix.txt 17 Oct 2002 07:30:47 -0000 1.1 +++ Unix.txt 19 Oct 2002 05:05:11 -0000 1.2 @@ -4,47 +4,35 @@ # It is only intended to be called by the File class. -------------------------------------------------------------------------------- - METHOD - new + new SYNOPSIS + my $file = SandWeb::File->new( + location => $location; + filename => $filename; + ); + DESCRIPTION + This method is a constructor. It needs to know the location of the + file as well as the name of the file. PARAMETERS - parameter (type: string) (required) + location (type: string) (required) - Default: none. + This contains the full ( absolute or relative ) path + to the file, as far as the file system is concerned. -RETURN CODES + Default: none. - 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. - -get_owner --------------------------------------------------------------------------------- - -METHOD - methodname - -SYNOPSIS + filename (type: string) (required) + + This contains the full name of the file, as far as the + file system is concerned. - -DESCRIPTION - - -PARAMETERS - - parameter (type: string) (required) - - Default: none. + Default: none. RETURN CODES @@ -58,21 +46,20 @@ read the files specified, or they did not exist. -get_group -------------------------------------------------------------------------------- METHOD - methodname + get_owner SYNOPSIS + my $owner = $file->get_owner(); DESCRIPTION + Returns the UID of the owner of the file. PARAMETERS - parameter (type: string) (required) - - Default: none. + None. RETURN CODES @@ -86,21 +73,20 @@ read the files specified, or they did not exist. -get_filename -------------------------------------------------------------------------------- METHOD - methodname + get_group SYNOPSIS + my $group = $file->get_group(); DESCRIPTION + Returns the GID of the group membership of the file. PARAMETERS - parameter (type: string) (required) - - Default: none. + None. RETURN CODES @@ -114,21 +100,20 @@ read the files specified, or they did not exist. -get_location -------------------------------------------------------------------------------- METHOD - methodname + get_filename SYNOPSIS + my $filename = $file->get_filename(); DESCRIPTION + Returns the full name of the file. PARAMETERS - parameter (type: string) (required) - - Default: none. + None. RETURN CODES @@ -142,21 +127,21 @@ read the files specified, or they did not exist. -get_permissions -------------------------------------------------------------------------------- METHOD - methodname + get_location SYNOPSIS + my $location = $file->get_location(); DESCRIPTION + Returns the full ( absolute or relative ) path + to the file. PARAMETERS - parameter (type: string) (required) - - Default: none. + None. RETURN CODES @@ -170,21 +155,21 @@ read the files specified, or they did not exist. -get_file_type -------------------------------------------------------------------------------- METHOD - methodname + get_permissions SYNOPSIS + my $permissions = $file->get_permissions(); DESCRIPTION + Returns the current file system permissions, + as an octal value. PARAMETERS - parameter (type: string) (required) - - Default: none. + None. RETURN CODES @@ -198,21 +183,22 @@ read the files specified, or they did not exist. -get_size -------------------------------------------------------------------------------- METHOD - methodname + get_file_type SYNOPSIS + my $file_type = $file->get_file_type(); DESCRIPTION + Returns Perl's guess as to what type of file + this is. Type returned one of : Binary, Text, + Directory or Unknown. PARAMETERS - parameter (type: string) (required) - - Default: none. + None. RETURN CODES @@ -226,21 +212,20 @@ read the files specified, or they did not exist. -get_age -------------------------------------------------------------------------------- METHOD - methodname + get_size SYNOPSIS + my $file_size = $file->get_size(); DESCRIPTION + Returns the size of the file, in bytes. PARAMETERS - parameter (type: string) (required) - - Default: none. + None. RETURN CODES @@ -254,21 +239,21 @@ read the files specified, or they did not exist. -upload -------------------------------------------------------------------------------- METHOD - methodname + get_age SYNOPSIS + my $age = $file->get_age(); DESCRIPTION + Returns the date of the last modification to this + file, in local time ( day month date time year ). PARAMETERS - parameter (type: string) (required) - - Default: none. + None. RETURN CODES @@ -282,21 +267,20 @@ read the files specified, or they did not exist. -download -------------------------------------------------------------------------------- METHOD - methodname + create_file SYNOPSIS + my $return = $file->create_file(); DESCRIPTION + Creates a file, using the filename passed to the constructor. PARAMETERS - parameter (type: string) (required) - - Default: none. + None. RETURN CODES @@ -310,21 +294,21 @@ read the files specified, or they did not exist. -exists -------------------------------------------------------------------------------- METHOD - methodname + create_folder SYNOPSIS + my $return = $file->create_folder(); DESCRIPTION + Creates a folder ( also known as a directory ) using the + filename passed to the constructor. PARAMETERS - parameter (type: string) (required) - - Default: none. + None. RETURN CODES @@ -338,21 +322,21 @@ read the files specified, or they did not exist. -create_file -------------------------------------------------------------------------------- METHOD - methodname + copy SYNOPSIS + my $return = $file->copy( tofile => "alternate_name.c" ); DESCRIPTION + Creates an exact copy of the file. PARAMETERS - parameter (type: string) (required) - - Default: none. + tocopy (type: string) (required) + Contains the full path and filename of the copy. RETURN CODES @@ -366,21 +350,22 @@ read the files specified, or they did not exist. -create_folder -------------------------------------------------------------------------------- METHOD - methodname + rename SYNOPSIS + my $return = $file->rename( tofile => "alternate_name.c" ); DESCRIPTION + Renames an existing file. This is the same thing as a move, + as far as the file system and operating system are concerned. PARAMETERS - parameter (type: string) (required) - - Default: none. + tocopy (type: string) (required) + Contains the full path and filename of the new file. RETURN CODES @@ -394,21 +379,20 @@ read the files specified, or they did not exist. -delete -------------------------------------------------------------------------------- METHOD - methodname + remove_file SYNOPSIS + my $return = $file->remove_file(); DESCRIPTION + Removes the file specified in the constructor. PARAMETERS - parameter (type: string) (required) - - Default: none. + none. RETURN CODES @@ -422,21 +406,20 @@ read the files specified, or they did not exist. -delete_folder -------------------------------------------------------------------------------- METHOD - methodname + remove_folder SYNOPSIS + my $return = $file->remove_folder(); DESCRIPTION + Removes the folder specified in the constructor. PARAMETERS - parameter (type: string) (required) - - Default: none. + none. RETURN CODES @@ -449,227 +432,2 @@ -1 = This return value means that there was not sufficient permision to read the files specified, or they did not exist. - -copy --------------------------------------------------------------------------------- - -METHOD - methodname - -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. - -rename --------------------------------------------------------------------------------- - -METHOD - methodname - -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. - -file_read --------------------------------------------------------------------------------- - -METHOD - methodname - -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. - -file_write --------------------------------------------------------------------------------- - -METHOD - methodname - -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. - -get_file_commands --------------------------------------------------------------------------------- - -METHOD - methodname - -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. - -_do_file_write --------------------------------------------------------------------------------- - -METHOD - methodname - -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. - -_do_file_read --------------------------------------------------------------------------------- - -METHOD - methodname - -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. - -_shell --------------------------------------------------------------------------------- - -METHOD - methodname - -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. - |
From: Rob H. <for...@us...> - 2002-10-19 05:04:18
|
Update of /cvsroot/sandweb/sandweb/doc/API In directory usw-pr-cvs1:/tmp/cvs-serv2625 Modified Files: UI.txt Log Message: cleanup, removed private methods Index: UI.txt =================================================================== RCS file: /cvsroot/sandweb/sandweb/doc/API/UI.txt,v retrieving revision 1.1 retrieving revision 1.2 diff -U2 -r1.1 -r1.2 --- UI.txt 17 Oct 2002 07:30:47 -0000 1.1 +++ UI.txt 19 Oct 2002 05:04:15 -0000 1.2 @@ -29,37 +29,9 @@ read the files specified, or they did not exist. -print_screen -------------------------------------------------------------------------------- METHOD - methodname -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. - -print_popup --------------------------------------------------------------------------------- - -METHOD - methodname + print_screen SYNOPSIS @@ -85,37 +57,9 @@ read the files specified, or they did not exist. -get_menu_bar -------------------------------------------------------------------------------- METHOD - methodname - -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. - -get_menu --------------------------------------------------------------------------------- - -METHOD - methodname + print_popup SYNOPSIS @@ -141,37 +85,9 @@ read the files specified, or they did not exist. -get_javascript -------------------------------------------------------------------------------- METHOD - methodname - -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. - -_get_cgi_exec --------------------------------------------------------------------------------- -METHOD - methodname + get_menu_bar SYNOPSIS @@ -197,37 +113,9 @@ read the files specified, or they did not exist. -_get_cgi_path -------------------------------------------------------------------------------- METHOD - methodname - -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. - -_get_template_dir --------------------------------------------------------------------------------- - -METHOD - methodname + get_menu SYNOPSIS @@ -253,37 +141,9 @@ read the files specified, or they did not exist. -_logobj -------------------------------------------------------------------------------- METHOD - methodname - -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. - -_get_version --------------------------------------------------------------------------------- - -METHOD - methodname + get_javascript SYNOPSIS @@ -308,3 +168,2 @@ -1 = This return value means that there was not sufficient permision to read the files specified, or they did not exist. - |
From: Rob H. <for...@us...> - 2002-10-19 05:03:15
|
Update of /cvsroot/sandweb/sandweb/doc/API In directory usw-pr-cvs1:/tmp/cvs-serv2445 Modified Files: Log.txt Log Message: cleaned up formatting Index: Log.txt =================================================================== RCS file: /cvsroot/sandweb/sandweb/doc/API/Log.txt,v retrieving revision 1.1 retrieving revision 1.2 diff -U2 -r1.1 -r1.2 --- Log.txt 17 Oct 2002 07:30:47 -0000 1.1 +++ Log.txt 19 Oct 2002 05:03:11 -0000 1.2 @@ -29,37 +29,9 @@ read the files specified, or they did not exist. -standard -------------------------------------------------------------------------------- METHOD - methodname -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. - -debug --------------------------------------------------------------------------------- - -METHOD - methodname + standard SYNOPSIS @@ -85,37 +57,9 @@ read the files specified, or they did not exist. -error -------------------------------------------------------------------------------- METHOD - methodname - -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. - -get_debug_msgs --------------------------------------------------------------------------------- - -METHOD - methodname + debug SYNOPSIS @@ -141,37 +85,9 @@ read the files specified, or they did not exist. -_write_to_log -------------------------------------------------------------------------------- METHOD - methodname - -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. - -_stack_debug --------------------------------------------------------------------------------- - -METHOD - methodname + error SYNOPSIS @@ -197,93 +113,9 @@ read the files specified, or they did not exist. -_get_log_toggle -------------------------------------------------------------------------------- METHOD - methodname - -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. - -get_debug_toggle --------------------------------------------------------------------------------- - -METHOD - methodname - -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. - -_get_log_dir --------------------------------------------------------------------------------- - -METHOD - methodname - -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. - -_get_log_file --------------------------------------------------------------------------------- - -METHOD - methodname + get_debug_msgs SYNOPSIS @@ -308,3 +140,2 @@ -1 = This return value means that there was not sufficient permision to read the files specified, or they did not exist. - |
From: Rob H. <for...@us...> - 2002-10-19 05:01:47
|
Update of /cvsroot/sandweb/sandweb/doc/API In directory usw-pr-cvs1:/tmp/cvs-serv2046 Modified Files: Config.txt Log Message: cleaned up formatting, needs to be done though Index: Config.txt =================================================================== RCS file: /cvsroot/sandweb/sandweb/doc/API/Config.txt,v retrieving revision 1.1 retrieving revision 1.2 diff -U2 -r1.1 -r1.2 --- Config.txt 17 Oct 2002 07:30:47 -0000 1.1 +++ Config.txt 19 Oct 2002 05:01:45 -0000 1.2 @@ -30,9 +30,8 @@ read the files specified, or they did not exist. -_read_config -------------------------------------------------------------------------------- METHOD - methodname + manage_data_structure SYNOPSIS @@ -58,37 +57,9 @@ read the files specified, or they did not exist. -manage_data_structure -------------------------------------------------------------------------------- METHOD - methodname -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. - -get_full_name --------------------------------------------------------------------------------- - -METHOD - methodname + get_full_name SYNOPSIS @@ -114,9 +85,9 @@ read the files specified, or they did not exist. -get_confirm_delete -------------------------------------------------------------------------------- METHOD - methodname + + get_confirm_delete SYNOPSIS @@ -142,9 +113,9 @@ read the files specified, or they did not exist. -write_preferences_config -------------------------------------------------------------------------------- METHOD - methodname + + write_preferences_config SYNOPSIS @@ -170,9 +141,9 @@ read the files specified, or they did not exist. -get_repo_list -------------------------------------------------------------------------------- METHOD - methodname + + get_repo_list SYNOPSIS @@ -198,9 +169,9 @@ read the files specified, or they did not exist. -repository_exists -------------------------------------------------------------------------------- METHOD - methodname + + repository_exists SYNOPSIS @@ -226,9 +197,9 @@ read the files specified, or they did not exist. -create_repo -------------------------------------------------------------------------------- METHOD - methodname + + create_repo SYNOPSIS @@ -254,9 +225,9 @@ read the files specified, or they did not exist. -update_repo -------------------------------------------------------------------------------- METHOD - methodname + + update_repo SYNOPSIS @@ -282,9 +253,9 @@ read the files specified, or they did not exist. -delete_repo -------------------------------------------------------------------------------- METHOD - methodname + + delete_repo SYNOPSIS @@ -310,9 +281,9 @@ read the files specified, or they did not exist. -get_repo_server -------------------------------------------------------------------------------- METHOD - methodname + + get_repo_server SYNOPSIS @@ -338,9 +309,9 @@ read the files specified, or they did not exist. -set_repo_server -------------------------------------------------------------------------------- METHOD - methodname + + set_repo_server SYNOPSIS @@ -366,9 +337,9 @@ read the files specified, or they did not exist. -get_repo_username -------------------------------------------------------------------------------- METHOD - methodname + + get_repo_username SYNOPSIS @@ -394,9 +365,9 @@ read the files specified, or they did not exist. -set_repo_username -------------------------------------------------------------------------------- METHOD - methodname + + set_repo_username SYNOPSIS @@ -422,9 +393,9 @@ read the files specified, or they did not exist. -get_repo_password -------------------------------------------------------------------------------- METHOD - methodname + + get_repo_password SYNOPSIS @@ -450,9 +421,9 @@ read the files specified, or they did not exist. -set_repo_password -------------------------------------------------------------------------------- METHOD - methodname + + set_repo_password SYNOPSIS @@ -478,9 +449,9 @@ read the files specified, or they did not exist. -get_repo_connection -------------------------------------------------------------------------------- METHOD - methodname + + get_repo_connection SYNOPSIS @@ -506,9 +477,9 @@ read the files specified, or they did not exist. -set_repo_connection -------------------------------------------------------------------------------- METHOD - methodname + + set_repo_connection SYNOPSIS @@ -534,9 +505,9 @@ read the files specified, or they did not exist. -get_repo_type -------------------------------------------------------------------------------- METHOD - methodname + + get_repo_type SYNOPSIS @@ -562,9 +533,9 @@ read the files specified, or they did not exist. -set_repo_type -------------------------------------------------------------------------------- METHOD - methodname + + set_repo_type SYNOPSIS @@ -590,9 +561,9 @@ read the files specified, or they did not exist. -get_repo_root -------------------------------------------------------------------------------- METHOD - methodname + + get_repo_root SYNOPSIS @@ -618,9 +589,9 @@ read the files specified, or they did not exist. -set_repo_root -------------------------------------------------------------------------------- METHOD - methodname + + set_repo_root SYNOPSIS @@ -646,9 +617,9 @@ read the files specified, or they did not exist. -get_module_list -------------------------------------------------------------------------------- METHOD - methodname + + get_module_list SYNOPSIS @@ -674,9 +645,9 @@ read the files specified, or they did not exist. -module_exists -------------------------------------------------------------------------------- METHOD - methodname + + module_exists SYNOPSIS @@ -702,9 +673,9 @@ read the files specified, or they did not exist. -add_module -------------------------------------------------------------------------------- METHOD - methodname + + add_module SYNOPSIS @@ -730,9 +701,9 @@ read the files specified, or they did not exist. -update_module -------------------------------------------------------------------------------- METHOD - methodname + + update_module SYNOPSIS @@ -758,9 +729,9 @@ read the files specified, or they did not exist. -delete_module -------------------------------------------------------------------------------- METHOD - methodname + + delete_module SYNOPSIS @@ -786,9 +757,9 @@ read the files specified, or they did not exist. -get_module_description -------------------------------------------------------------------------------- METHOD - methodname + + get_module_description SYNOPSIS |
From: Rob H. <for...@us...> - 2002-10-19 04:59:09
|
Update of /cvsroot/sandweb/sandweb/doc/API In directory usw-pr-cvs1:/tmp/cvs-serv1034 Modified Files: Browse.txt Log Message: documented all public methods. put a couple FIXMEs in there, needs more encapsulation in one method and to eliminate redundant commands between the constructor and one of the methods. Index: Browse.txt =================================================================== RCS file: /cvsroot/sandweb/sandweb/doc/API/Browse.txt,v retrieving revision 1.1 retrieving revision 1.2 diff -U2 -r1.1 -r1.2 --- Browse.txt 17 Oct 2002 07:30:47 -0000 1.1 +++ Browse.txt 19 Oct 2002 04:59:07 -0000 1.2 @@ -17,151 +17,64 @@ SYNOPSIS + my $browse = SandWeb::Browse->new( + 'username' => $username, + 'module_name' => $module_name, + 'repo_name' => $repo_name, + 'vcs_commands' => \@vcs_commands, + 'sort' => $sort, + 'users_dir' => $users_dir, + 'log_obj' => $log, + ); DESCRIPTION + This method is a constructor. PARAMETERS - parameter (type: string) (required) + username (type: string) (required) + + The current user's full username. 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. - -get_browser --------------------------------------------------------------------------------- - -METHOD - methodname - -SYNOPSIS - - -DESCRIPTION - - -PARAMETERS + module_name (type: string) (required) - parameter (type: string) (required) + The name of the VCS module that the user is wants to browse. 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. - -get_tool_bar --------------------------------------------------------------------------------- + repo_name (type: string) (required) -METHOD - methodname - -SYNOPSIS - - -DESCRIPTION - - -PARAMETERS - - parameter (type: string) (required) + The name of the repository that contains the module that the + user wants to browse. 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. - -get_current_location --------------------------------------------------------------------------------- + vcs_commands (type: array) (required) -METHOD - methodname - -SYNOPSIS - - -DESCRIPTION - - -PARAMETERS - - parameter (type: string) (required) + Contains all valid VCS commands for the current module ( for use + by the tool bar ). 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. - -_get_username --------------------------------------------------------------------------------- - -METHOD - methodname - -SYNOPSIS + sort (type: string) (required) + The sorting order for the files. -DESCRIPTION - - -PARAMETERS - - parameter (type: string) (required) + FIXME - this should only be for the get_browse method, not the + constructor. 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. - -_get_users_dir --------------------------------------------------------------------------------- + users_dir (type: string) (required) -METHOD - methodname - -SYNOPSIS - - -DESCRIPTION + The path to the user's home directory. + + Default: none. + log_obj (type: string) (required) -PARAMETERS - - parameter (type: string) (required) + Contains a reference to an instantiated log object. Default: none. @@ -174,50 +87,57 @@ 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. - -_get_repo_name -------------------------------------------------------------------------------- METHOD - methodname + + get_browser SYNOPSIS + my %browser = $browse->get_browser( + 'location' => $location, + 'progname' => $progname, + 'repo_type' => $repo_type, + 'repo_name' => $repo_name, + 'sort' => $sort, + ); DESCRIPTION + This returns HTML depicting the directories and files that + the user wishes to browse, with traverse deeper into the + heirarchy. PARAMETERS - parameter (type: string) (required) + location (type: string) (required) + + The location that the user wants to start browsing from, relative + to the homedir/reponame/module. 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. - -_get_module_name --------------------------------------------------------------------------------- + progname (type: string) (required) -METHOD - methodname + The name of the CGI ( sandweb.cgi for example ). + + Default: none. -SYNOPSIS + repo_type (type: string) (required) + The type of repository ( e.g. CVS, RCS, SVN, etc. ). + + Default: none. -DESCRIPTION + repo_name (type: string) (required) + The name of the current repository. + + Default: none. -PARAMETERS + sort (type: string) (required) - parameter (type: string) (required) + This is the sort order for files/directories ( alphabetically or + reverse alphabetically ). Default: none. @@ -230,50 +150,38 @@ 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. - -_get_template_dir -------------------------------------------------------------------------------- METHOD - methodname + + get_tool_bar SYNOPSIS + my %toolbar = $browse->get_tool_bar( + 'location' => $location, + 'progname' => $progname, + ); DESCRIPTION + Returns an HTML template depicting the Browse toolbar, + which allows you to create/remove files/directories and + run VCS commands. + + FIXME - the calling application shouldn't have to run + this template object through a loop and insert the VCS + commands, this should happen inside the Browse object. PARAMETERS - parameter (type: string) (required) + location (type: string) (required) + + The current browsing location. Default: none. -RETURN CODES + progname (type: string) (required) - 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. - -_get_vcs_commands --------------------------------------------------------------------------------- - -METHOD - methodname - -SYNOPSIS - - -DESCRIPTION - - -PARAMETERS - - parameter (type: string) (required) + The name of the CGI ( e.g. sandweb.cgi ) Default: none. @@ -281,38 +189,32 @@ RETURN CODES - 1 = The operation completed successfully. + Returns a hash reference to an HTML::Template object. 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. - -_get_log_obj -------------------------------------------------------------------------------- METHOD - methodname + + get_current_location SYNOPSIS + my $current_location = $browse->get_current_location(); + DESCRIPTION + Returns the current location of the browse object. PARAMETERS - parameter (type: string) (required) - - Default: none. + None. RETURN CODES - 1 = The operation completed successfully. + Returns the current location of the browse object as a string. 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. - |
From: Rob H. <for...@us...> - 2002-10-19 04:40:44
|
Update of /cvsroot/sandweb/sandweb/doc/API In directory usw-pr-cvs1:/tmp/cvs-serv30051 Modified Files: Auth.txt Log Message: filled in info for all public methods in Auth Index: Auth.txt =================================================================== RCS file: /cvsroot/sandweb/sandweb/doc/API/Auth.txt,v retrieving revision 1.1 retrieving revision 1.2 diff -U2 -r1.1 -r1.2 --- Auth.txt 17 Oct 2002 07:30:47 -0000 1.1 +++ Auth.txt 19 Oct 2002 04:40:40 -0000 1.2 @@ -16,149 +16,30 @@ DESCRIPTION + This method is a constructor. PARAMETERS - parameter (type: string) (required) + log_obj (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. - -login --------------------------------------------------------------------------------- - -METHOD - methodname - -SYNOPSIS - + This contains a reference to an instantiated log object. -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. - -load_user --------------------------------------------------------------------------------- - -METHOD - methodname - -SYNOPSIS + data_dir (type: string) (required) + This is the path to SandWeb's data directory. -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. - -logout --------------------------------------------------------------------------------- - -METHOD - methodname - -SYNOPSIS - - -DESCRIPTION - + cookie_path (type: string) (required) -PARAMETERS + This is the path on the server side where cookie data is stored. - 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. - -get_username --------------------------------------------------------------------------------- - -METHOD - methodname - -SYNOPSIS - - -DESCRIPTION - - -PARAMETERS - - parameter (type: string) (required) - Default: none. + cookie_domain (type: string) (required) -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. - -set_auth_cookie --------------------------------------------------------------------------------- - -METHOD - methodname - -SYNOPSIS - - -DESCRIPTION + This is the domain that we tell the browser this cookie belongs to. - -PARAMETERS - - parameter (type: string) (required) - Default: none. @@ -173,159 +54,41 @@ read the files specified, or they did not exist. -_store_cookie_info -------------------------------------------------------------------------------- METHOD - methodname - -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. - -_search_cookiedata --------------------------------------------------------------------------------- - -METHOD - methodname + login 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. - -_write_cookiedata --------------------------------------------------------------------------------- - -METHOD - methodname - -SYNOPSIS + my $status = $auth->login( + username => $username, + password => $password, + salt => $salt, + ); DESCRIPTION + This method checks the username, password and salt + sent to it for validity. 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. - -_remove_cookiedata --------------------------------------------------------------------------------- - -METHOD - methodname - -SYNOPSIS - + username (type: string) (required) -DESCRIPTION - - -PARAMETERS - - parameter (type: string) (required) - + Contains a username to check for authenticity. + 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. - -_set_user_info_username --------------------------------------------------------------------------------- + username (type: string) (required) -METHOD - methodname + Contains an encrypted password to check for authenticity. -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. - -_set_user_info_cookie --------------------------------------------------------------------------------- - -METHOD - methodname - -SYNOPSIS - - -DESCRIPTION - + username (type: string) (required) -PARAMETERS - - parameter (type: string) (required) + Contains the salt for the encrypted password. Default: none. @@ -333,57 +96,51 @@ RETURN CODES - 1 = The operation completed successfully. + 1 = The user is authentic. - 0 = This means that the method got an error proccessing your request. - Perhaps an invalid parameter? + 0 = The user is not authentic. - -1 = This return value means that there was not sufficient permision to - read the files specified, or they did not exist. - -_set_user_info_password -------------------------------------------------------------------------------- METHOD - methodname + load_user SYNOPSIS + my $status = $auth->load_user( + $cookie, + ); DESCRIPTION + Attempts to validate user's auth cookie, and load the user's + settings into the global hashes. PARAMETERS - parameter (type: string) (required) + Takes value of the user's cookie as an argument. - Default: none. - RETURN CODES - 1 = The operation completed successfully. + 1 = The cookie is valid, and the load completed successfully. - 0 = This means that the method got an error proccessing your request. - Perhaps an invalid parameter? + 0 = The cookie is not valid, the user info was not loaded. - -1 = This return value means that there was not sufficient permision to - read the files specified, or they did not exist. -_get_data_dir -------------------------------------------------------------------------------- METHOD - methodname + logout SYNOPSIS + my $stat = $auth->logout(); DESCRIPTION + Logs a user out of SandWeb by removing their cookie. PARAMETERS - parameter (type: string) (required) - - Default: none. + None. RETURN CODES @@ -392,91 +149,50 @@ 0 = This means that the method got an error proccessing your request. - Perhaps an invalid parameter? + Maybe the cookie file could not be written to? - -1 = This return value means that there was not sufficient permision to - read the files specified, or they did not exist. - -_logobj -------------------------------------------------------------------------------- METHOD - methodname + get_username SYNOPSIS + my $username = $auth->get_username() DESCRIPTION + Returns the current user's full username. PARAMETERS - parameter (type: string) (required) - - Default: none. + None. RETURN CODES - 1 = The operation completed successfully. + Returns a string. 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. - -_get_cookie_path -------------------------------------------------------------------------------- METHOD - methodname + set_auth_cookie SYNOPSIS + my $cookie = $auth->set_auth_cookie(); DESCRIPTION + Generates random auth cookie. PARAMETERS - parameter (type: string) (required) - - Default: none. + 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. - -_get_cookie_domain --------------------------------------------------------------------------------- - -METHOD - methodname - -SYNOPSIS - -DESCRIPTION - - -PARAMETERS - - parameter (type: string) (required) - - Default: none. - -RETURN CODES - - 1 = The operation completed successfully. + Returns a randomly generated string. 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. - |
From: Rob H. <for...@us...> - 2002-10-17 07:30:51
|
Update of /cvsroot/sandweb/sandweb/doc/API/File In directory usw-pr-cvs1:/tmp/cvs-serv27191/File Added Files: Unix.txt Log Message: started API docs, these all need to be filled out but they now have the basic structure --- NEW FILE --- # lib/SandWeb/File/Unix.pm # # This class handles all file viewing and operations on Unix systems. # It is only intended to be called by the File class. -------------------------------------------------------------------------------- METHOD 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. get_owner -------------------------------------------------------------------------------- METHOD methodname 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. get_group -------------------------------------------------------------------------------- METHOD methodname 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. get_filename -------------------------------------------------------------------------------- METHOD methodname 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. get_location -------------------------------------------------------------------------------- METHOD methodname 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. get_permissions -------------------------------------------------------------------------------- METHOD methodname 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. get_file_type -------------------------------------------------------------------------------- METHOD methodname 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. get_size -------------------------------------------------------------------------------- METHOD methodname 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. get_age -------------------------------------------------------------------------------- METHOD methodname 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. upload -------------------------------------------------------------------------------- METHOD methodname 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. download -------------------------------------------------------------------------------- METHOD methodname 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. exists -------------------------------------------------------------------------------- METHOD methodname 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. create_file -------------------------------------------------------------------------------- METHOD methodname 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. create_folder -------------------------------------------------------------------------------- METHOD methodname 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. delete -------------------------------------------------------------------------------- METHOD methodname 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. delete_folder -------------------------------------------------------------------------------- METHOD methodname 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. copy -------------------------------------------------------------------------------- METHOD methodname 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. rename -------------------------------------------------------------------------------- METHOD methodname 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. file_read -------------------------------------------------------------------------------- METHOD methodname 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. file_write -------------------------------------------------------------------------------- METHOD methodname 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. get_file_commands -------------------------------------------------------------------------------- METHOD methodname 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. _do_file_write -------------------------------------------------------------------------------- METHOD methodname 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. _do_file_read -------------------------------------------------------------------------------- METHOD methodname 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. _shell -------------------------------------------------------------------------------- METHOD methodname 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. |
From: Rob H. <for...@us...> - 2002-10-17 07:30:50
|
Update of /cvsroot/sandweb/sandweb/doc/API/Auth In directory usw-pr-cvs1:/tmp/cvs-serv27191/Auth Added Files: FlatFile.txt Log Message: started API docs, these all need to be filled out but they now have the basic structure --- NEW FILE --- # SandWeb FlatFile authentication module # # lib/SandWeb/Auth/FlatFile.pm # # This class verifies MD5 passwords for a given username, and returns # true if the user if authentic, false if not. -------------------------------------------------------------------------------- METHOD 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. verify_password -------------------------------------------------------------------------------- METHOD methodname 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. _logobj -------------------------------------------------------------------------------- METHOD methodname 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. |
From: Rob H. <for...@us...> - 2002-10-17 07:15:51
|
Update of /cvsroot/sandweb/sandweb/lib/SandWeb In directory usw-pr-cvs1:/tmp/cvs-serv20557/lib/SandWeb Removed Files: ErrHndlr.pm Log Message: we've implemented this in the CGI, not sure it's needed. --- ErrHndlr.pm DELETED --- |
From: Rob H. <for...@us...> - 2002-10-17 07:01:37
|
Update of /cvsroot/sandweb/sandweb/lib/SandWeb/Repository In directory usw-pr-cvs1:/tmp/cvs-serv14340/lib/SandWeb/Repository Modified Files: cvs.pm Log Message: typo - should be "SandWeb::Security", not "SandWeb::Secure" :) Index: cvs.pm =================================================================== RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb/Repository/cvs.pm,v retrieving revision 1.32 retrieving revision 1.33 diff -U2 -r1.32 -r1.33 --- cvs.pm 26 Aug 2002 06:59:47 -0000 1.32 +++ cvs.pm 17 Oct 2002 07:01:32 -0000 1.33 @@ -567,5 +567,5 @@ # Security check - my $secure = SandWeb::Secure->new(); + my $secure = SandWeb::Security->new(); my $name = $secure->shell( |
From: Rob H. <for...@us...> - 2002-10-17 06:31:40
|
Update of /cvsroot/sandweb/sandweb/bin In directory usw-pr-cvs1:/tmp/cvs-serv4054/bin Modified Files: sandweb.cgi Log Message: when done with configuration_commit, go back to configuration_menu instead of sandbox_menu Index: sandweb.cgi =================================================================== RCS file: /cvsroot/sandweb/sandweb/bin/sandweb.cgi,v retrieving revision 1.324 retrieving revision 1.325 diff -U2 -r1.324 -r1.325 --- sandweb.cgi 7 Oct 2002 06:53:42 -0000 1.324 +++ sandweb.cgi 17 Oct 2002 06:31:36 -0000 1.325 @@ -2625,12 +2625,13 @@ my $return = write_config(); - if (! $return) { + + if (! $return) { # uh oh, problem occured configuration_menu( ck_auth => $ck_auth ); } - # when finished go to sandbox menu. (this should be dynamic probably, - # so it returns to whichever menu they wanted to go to in the first - # place). - sandbox_menu( ck_auth => $ck_auth ); + + # when finished go back to configuration menu. + + configuration_menu( ck_auth => $ck_auth ); } |
From: Rob H. <for...@us...> - 2002-10-07 18:35:56
|
Update of /cvsroot/sandweb/sandweb/lib/SandWeb In directory usw-pr-cvs1:/tmp/cvs-serv28632/lib/SandWeb Modified Files: Config.pm Log Message: needed for remember_repo_password feature Index: Config.pm =================================================================== RCS file: /cvsroot/sandweb/sandweb/lib/SandWeb/Config.pm,v retrieving revision 1.30 retrieving revision 1.31 diff -U2 -r1.30 -r1.31 --- Config.pm 16 Sep 2002 05:30:14 -0000 1.30 +++ Config.pm 7 Oct 2002 18:35:52 -0000 1.31 @@ -209,4 +209,5 @@ my $username = $args{'username'} || ''; my $password = $args{'password'} || ''; + my $remember_password = $args{'remember_password'} || ''; my $connection = $args{'connection'} || ''; my $type = $args{'type'} || ''; @@ -218,4 +219,5 @@ $self->{'repo'}->{$name}->{'username'} = $username if ($username); $self->{'repo'}->{$name}->{'password'} = $password if ($password); + $self->{'repo'}->{$name}->{'remember_password'} = $remember_password if ($remember_password); $self->{'repo'}->{$name}->{'connection'} = $connection if ($connection); $self->{'repo'}->{$name}->{'type'} = $type if ($type); @@ -298,4 +300,27 @@ if ($self->repository_exists(repo => $repo_name)) { $self->{'repo'}->{$repo_name}->{'password'} = $value || ''; + return 1; + } else { + return 0; + } +} +# get/set whether we should remember repo password +sub get_remember_repo_password { + my $self = shift; + my %args = @_; + my $repo_name = $args{'repo'}; + if ($self->repository_exists(repo => $repo_name)) { + return $self->{'repo'}->{$repo_name}->{'remember_password'} || '' + } else { + return ''; + } +} +sub set_remember_repo_password { + my $self = shift; + my %args = @_; + my $repo_name = $args{'repo'}; + my $repo_server = $args{'value'}; + if ($self->repository_exists(repo => $repo_name)) { + $self->{'repo'}->{$repo_name}->{'remember_password'} = $value || ''; return 1; } else { |