NAME
Apache::Roaming::LiPrefs - A roaming handler for modifying Netscape
Preferences
SYNOPSIS
# Configuration in httpd.conf or srm.conf
# Assuming DocumentRoot /home/httpd/html
PerlModule Apache::Roaming
<Location /roaming>
PerlHandler Apache::Roaming::LiPrefs->handler
PerlTypeHandler Apache::Roaming::LiPrefs->handler_type
AuthType Basic
AuthName "Roaming User"
AuthUserFile /home/httpd/.htusers
require valid-user
PerlSetVar BaseDir /home/httpd/html/roaming
PerlSetVar LiPrefsConfigFile /home/httpd/liprefs.cnf
</Location>
In theory any AuthType and require statement should be possible
as long as the $r->connection()->user() method returns something
non trivial.
DESCRIPTION
This is a subclass of Apache::Roaming that allows you to overwrite certain Netscape settings of your users, both initial and/or permanent. The idea is to overwrite the web servers GET method for parsing and modifying the users liprefs files.
Liprefs files are a collection of lines in the format
user_pref("varname", value);
In other words, they are obviously close to hash arrays. Thus the module configuration is read from two hash arrays:
- %Apache::Roaming::LiPrefs::INITIAL
-
If any of the given hash keys is missing in the liprefs file, then a corresponding line will be added to the liprefs file.
- %Apache::Roaming::LiPrefs::ALWAYS
-
Lines corresponding to one of the given hash keys will be silently replaced by the given values. If no corresponding line is found, the hash key will be treated like it where part of the INITIAL hash.
An example might help. Suggest the following arrays:
%Apache::Roaming::LiPrefs::INITIAL = {
'security.email_as_ftp_password' => 'true',
'mail.remember_password' => 'false'
};
%Apache::Roaming::LiPrefs::ALWAYS = {
'network.hosts.pop_server' => 'pop.cmo.de',
'network.hosts.smtp_server' => 'smtp.cmo.de'
}
If the users saved liprefs file is
user_pref("network.hosts.pop_server", "pop.company.com");
user_pref("mail.remember_password", true);
Then the module will change it to
user_pref("network.hosts.pop_server", "pop.cmo.de");
user_pref("network.hosts.smtp_server", "smtp.cmo.de");
user_pref("mail.remember_password", true);
user_pref("security.email_as_ftp_password", true);
INSTALLATION
Follow the instructions for installing the Apache::Roaming module. See Apache::Roaming(3). The only difference is that you use Apache::Roaming::LiPrefs rather than its superclass Apache::Roaming:
PerlModule Apache::Roaming::LiPrefs
<Location /roaming>
PerlHandler Apache::Roaming::LiPrefs->handler
PerlTypeHandler Apache::Roaming::LiPrefs->handler_type
AuthType Basic
AuthName "Roaming User"
AuthUserFile /home/httpd/.htusers
require valid-user
PerlSetVar BaseDir /home/httpd/html/roaming
</Location>
By default the arrays INITIAL and ALWAYS are read via
require Apache::Roaming::LiPrefs::Config;
This file can be generated automatically while installing the Apache::Roaming module. However, you can overwrite this by using the instruction
PerlSetVar LiPrefsConfigFile /home/httpd/liprefs.cnf
In that case the variables will be read via
require "/home/httpd/liprefs.cnf";
METHOD INTERFACE
No methods from Apache::Roaming are overwritten, there's only an additional method, GET_liprefs, that is called in favour of GET if the user requests an liprefs file.
AUTHOR AND COPYRIGHT
This module is
Copyright (C) 1998 Jochen Wiedmann
Am Eisteich 9
72555 Metzingen
Germany
Phone: +49 7123 14887
Email: joe@ispsoft.de
All rights reserved.
You may distribute this module under the terms of either the GNU General Public License or the Artistic License, as specified in the Perl README file.