Convenience function which returns a url for a GET request to this
application.
-I<$params> is a hashref specifying the parameters and the PATH_INFO.
+I<$params> is a hashref specifying the parameters and the PATH_INFO
+(not including any parameters related to CGI::Auth::Flexible).
The keys are the parameter names, and the values are array refs with
the parameter value(s) (as strings, as yet unquoted). (They are array
refs because it is possible to pass multiple values for the same
cookie in the forms generated by C<check_ok>. You may also set it
yourself (and indeed you must do so if you use C<check_divert>).
+item C<< $authreq->_chain_params() >>
+
+Returns a hash of the "relevant" parameters to this request, in a form
+suitable for C<url_with_query_params>. This is all of the query
+parameters which are not related to CGI::Auth::Flexible. The
+PATH_INFO from the request is returned as the parameter C<< '' >>.
+
=back
=head1 OTHER FUNCTIONS AND METHODS
=item C<CookieSecret>
-The secret cookie which should be set along with whatever response is
-sent to the client. The value in the hash is the actual secret value
+The login cookie which should be set along with whatever response is
+sent to the client. The value in the hash is the actual value
of the cookie as a string. C<undef> means no cookie setting header
should be sent; C<''> means the cookie should be cleared.
Must be an absolute filename.
-=item C<assocdb_dbh>
+=item C<db_dbh>
CGI::Auth::Flexible needs a database for recording users' login
session. This database needs to be shared across all instances of the
changes made by CAF and your own application.)
By default, CAF uses a sqlite3 database stored on local disk in the
-file named by C<assocdb_path>. This will be suitable for all
+file named by C<db_path>. This will be suitable for all
applications which run on a single host.
This value, if supplied, should be a DBI handle for the database.
-=item C<assocdb_dsn>
+=item C<db_dsn>
This is the DSN to pass to C<< DBI->connect >>. Used only if
-C<assocdb_dbh> is not supplied.
+C<db_dbh> is not supplied.
-=item C<assocdb_path>
+=item C<db_path>
Path to the sqlite3 database used for CAF's session storage. The
default is C<caf.db>.
-Used only if neither C<assocdb_dbh> or C<assocdb_dsn> are supplied.
+Used only if neither C<db_dbh> or C<db_dsn> are supplied.
If this is a relative path, it is in C<dir>.
If you use a different database, or just prefer to do things
differently, you can set up the tables yourself and/or disable or
-modify the default setup statements, via the C<assocdb_setup_stmts>
+modify the default setup statements, via the C<db_setup_stmts>
setting.
The tables needed are:
xxx remaining settings
- assocdb_password
+ db_password
username_password_error
login_ok
get_cookie_domain
xxx bugs keys not shared should be in db
xxx rename caf_assocsecret default cookie name
xxx mention relationship between login_timeout and cookies
-xxx rename assocdb settings to db