<<

NAME

pf::web::guest - module to handle guest portions of the captive portal

DESCRIPTION

pf::web::guest contains the functions necessary to generate different guest-related web pages: based on pre-defined templates: login, registration, release, error, status.

It is possible to customize the behavior of this module by redefining its subs in pf::web::custom. See pf::web::custom for details.

CONFIGURATION AND ENVIRONMENT

Read the following template files: release.html, login.html, enabler.html, error.html, status.html, register.html.

SUBROUTINES

Warning: The list of subroutine is incomplete

generate_selfregistration_page

Sub to present to a guest so that it can self-register (guest.html).

validate_selfregistration

Sub to validate self-registering guests.

validate_sponsor

Performs sponsor validation.

prepare_email_guest_activation_info

Provides basic information for the self registered guests by email template.

This is meant to be overridden in pf::web::custom.

prepare_sponsor_guest_activation_info

Provides basic information for the self registered sponsored guests template.

This is meant to be overridden in pf::web::custom.

generate_custom_login_page

Sub to present a login form. Template is provided as a parameter.

aup

Return the Acceptable User Policy (AUP) defined in the template file /usr/local/pf/html/captive-portal/templates/aup_text.html

send_template_email

ERROR STRINGS

error_code

PacketFence error codes regarding guests.

errors

An hash mapping error codes to error messages.

AUTHOR

Inverse inc. <info@inverse.ca>

COPYRIGHT

Copyright (C) 2005-2015 Inverse inc.

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

<<