/ 
Plack-App-Login-Password-0.02
River stage zero No dependents
/ Plack::App::Login::Password

NAME

Plack::App::Login::Password - Plack login/password application.

SYNOPSIS

use Plack::App::Login::Password;

my $obj = Plack::App::Login::Password->new(%parameters);
my $psgi_ar = $obj->call($env);
my $app = $obj->to_app;

METHODS

new

my $obj = Plack::App::Login::Password->new(%parameters);

Constructor.

Returns instance of object.

  • author

    Author string to HTML head.

    Default value is undef.

  • content_type

    Content type for output.

    Default value is 'text/html; charset=__ENCODING__'.

  • css

    Instance of CSS::Struct::Output object.

    Default value is CSS::Struct::Output::Raw instance.

  • css_init

    Reference to array with CSS::Struct structure.

    Default value is CSS initialization from Tags::HTML::Page::Begin like

     * {
	box-sizing: border-box;
	margin: 0;
	padding: 0;
 }

  • encoding

    Set encoding for output.

    Default value is 'utf-8'.

  • favicon

    Link to favicon.

    Default value is undef.

  • flag_begin

    Flag that means begin of html writing via Tags::HTML::Page::Begin.

    Default value is 1.

  • flag_end

    Flag that means end of html writing via Tags::HTML::Page::End. Default value is 1.

  • generator

    HTML generator string.

    Default value is 'Plack::App::Login; Version: __VERSION__'.

  • login_cb

    Callback for main login. Arguments for callback are: $env, username and $password. Returns 0/1 for (un)successful login.

    Default value is undef.

  • logo_image_url

    URL to logo image.

    Default value is undef.

  • message_cb

    Callback to process message from application. Arguments for callback are: $env, $message_type and $message. Returns undef.

    Default value is undef.

  • psgi_app

    PSGI application to run instead of normal process. Intent of this is change application in _process_actions method.

    Default value is undef.

  • redirect_login

    Redirect URL after successful login.

    Default value is undef.

  • redirect_error

    Redirect URL after error in login.

    Default value is undef.

  • register_link

    URL to registering page.

    Default value is undef.

  • script_js

    Reference to array with Javascript code strings.

    Default value is [].

  • script_js_src

    Reference to array with Javascript URLs.

    Default value is [].

  • status_code

    HTTP status code.

    Default value is 200.

  • tags

    Instance of Tags::Output object.

    Default value is

    Tags::Output::Raw->new(
        'xml' => 1,
        'no_simple' => ['script', 'textarea'],
        'preserved' => ['pre', 'style'],
);

  • title

    Page title.

    Default value is 'Login page'.

call

my $psgi_ar = $obj->call($env);

Implementation of login page.

Returns reference to array (PSGI structure).

to_app

my $app = $obj->to_app;

Creates Plack application.

Returns Plack::Component object.

EXAMPLE

use strict;
use warnings;

use CSS::Struct::Output::Indent;
use Plack::App::Login::Password;
use Plack::Runner;
use Tags::Output::Indent;

# Run application.
my $app = Plack::App::Login::Password->new(
        'css' => CSS::Struct::Output::Indent->new,
        'generator' => 'Plack::App::Login::Password',
        'tags' => Tags::Output::Indent->new(
                'preserved' => ['style'],
                'xml' => 1,
        ),
)->to_app;
Plack::Runner->new->run($app);

# Output:
# HTTP::Server::PSGI: Accepting connections at http://0:5000/

# > curl http://localhost:5000/
# <!DOCTYPE html>
# <html lang="en">
#   <head>
#     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
#     <meta name="generator" content="Plack::App::Login::Password"
#       />
#     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
#     <title>
#       Login page
#     </title>
#     <style type="text/css">
# * {
# 	box-sizing: border-box;
# 	margin: 0;
# 	padding: 0;
# }
# .container {
# 	display: flex;
# 	align-items: center;
# 	justify-content: center;
# 	height: 100vh;
# }
# .form-login {
# 	width: 300px;
# 	background-color: #f2f2f2;
# 	padding: 20px;
# 	border-radius: 5px;
# 	box-shadow: 0 0 10px rgba(0, 0, 0, 0.2);
# }
# .form-login fieldset {
# 	border: none;
# 	padding: 0;
# 	margin-bottom: 20px;
# }
# .form-login legend {
# 	font-weight: bold;
# 	margin-bottom: 10px;
# }
# .form-login p {
# 	margin: 0;
# 	padding: 10px 0;
# }
# .form-login label {
# 	display: block;
# 	font-weight: bold;
# 	margin-bottom: 5px;
# }
# .form-login input[type="text"], .form-login input[type="password"] {
# 	width: 100%;
# 	padding: 8px;
# 	border: 1px solid #ccc;
# 	border-radius: 3px;
# }
# .form-login button[type="submit"] {
# 	width: 100%;
# 	padding: 10px;
# 	background-color: #4CAF50;
# 	color: #fff;
# 	border: none;
# 	border-radius: 3px;
# 	cursor: pointer;
# }
# .form-login button[type="submit"]:hover {
# 	background-color: #45a049;
# }
# </style>
#   </head>
#   <body>
#     <div class="container">
#       <div class="inner">
#         <form class="form-login" method="post">
#           <fieldset>
#             <legend>
#               Login
#             </legend>
#             <p>
#               <label for="username" />
#               User name
#               <input type="text" name="username" id="username" />
#             </p>
#             <p>
#               <label for="password">
#                 Password
#               </label>
#               <input type="password" name="password" id="password" />
#             </p>
#             <p>
#               <button type="submit" name="login" value="login">
#                 Login
#               </button>
#             </p>
#           </fieldset>
#         </form>
#       </div>
#     </div>
#   </body>
# </html>

DEPENDENCIES

Plack::Component::Tags::HTML, Plack::Request, Plack::Response, Plack::Session, Plack::Util::Accessor, Tags::HTML::Container, Tags::HTML::Login::Password.

SEE ALSO

Plack::App::Login

Plack login application.

REPOSITORY

https://github.com/michal-josef-spacek/Plack-App-Login-Password

AUTHOR

Michal Josef Špaček mailto:skim@cpan.org

http://skim.cz

LICENSE AND COPYRIGHT

© 2023 Michal Josef Špaček

BSD 2-Clause License

VERSION

0.02