.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Plack::Builder::Conditionals 3pm"
.TH Plack::Builder::Conditionals 3pm "2022-06-16" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Plack::Builder::Conditionals \- Plack::Builder extension
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&  use Plack::Builder;
\&  use Plack::Builder::Conditionals;
\&  # exports "match_if, addr, path, method, header, browser, any, all"
\&
\&  builder {
\&      enable match_if addr([\*(Aq192.168.0.0/24\*(Aq,\*(Aq127.0.0.1\*(Aq]),
\&          "Plack::Middleware::ReverseProxy";
\&
\&      enable match_if all( path(qr!^/private!), addr( \*(Aq!\*(Aq, [qw!127.0.0.1 ::1!] ) ),
\&          "Plack::Middleware::Auth::Basic", authenticator => \e&authen_cb;
\&
\&      enable match_if sub { my $env = shift; $env\->{HTTP_X_ENABLE_FRAMEWORK} },
\&          "Plack::Middleware::XFramework", framework => \*(AqTest\*(Aq;
\&
\&      $app;
\&  };
\&
\&  use Plack::Builder::Conditionals \-prefx => \*(Aqc\*(Aq;
\&  # exports "c_match_if, c_addr, c_path, c_method, c_header, c_any, c_all"
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Plack::Builder::Conditionals is..
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.IP "match_if" 4
.IX Item "match_if"
.Vb 2
\&  enable match_if addr(\*(Aq127.0.0.1\*(Aq), "Plack::Middleware::ReverseProxy";
\&  enable match_if sub { $_[0]\->{REMOTE_ADDR} eq \*(Aq127.0.0.1\*(Aq }, "Plack::Middleware::ReverseProxy";
.Ve
.Sp
As like Plack::Builder's enable_if enable middleware if given conditions return true
.IP "addr" 4
.IX Item "addr"
.Vb 3
\&  addr(\*(Aq127.0.0.1\*(Aq);
\&  addr([qw!192.168.0.0/24 127.0.0.1 ::1!]);
\&  addr(\*(Aq!\*(Aq,\*(Aq127.0.0.1\*(Aq);
.Ve
.Sp
return true if \s-1REMOTE_ADDR\s0 is found in the \s-1CIDR\s0 range. If first argument is '!', return the opposite result.
This function supports IPv6 addresses
.IP "path" 4
.IX Item "path"
.Vb 3
\&  path(\*(Aq/\*(Aq)
\&  path(qr!^/(\ew+)/!)
\&  path(\*(Aq!\*(Aq, qr!^/private!)
.Ve
.Sp
matching \s-1PATH_INFO\s0
.IP "method" 4
.IX Item "method"
.Vb 6
\&  method(\*(AqGET\*(Aq)
\&  method(qr/^(get|head)$/i)
\&  method(qw(GET HEAD))
\&  method(\*(Aq!\*(Aq,\*(AqGET\*(Aq)
\&  method(\*(Aq!\*(Aq, qr/^(post|put)$/i)
\&  method(\*(Aq!\*(Aq, qw(POST PUT))
.Ve
.IP "header" 4
.IX Item "header"
.Vb 3
\&  header(\*(AqUser\-Agent\*(Aq,qr/iphone/)
\&  header(\*(AqIf\-Modified\-Since\*(Aq) #exists check
\&  header(\*(Aq!\*(Aq, \*(AqUser\-Agent\*(Aq,qr/MSIE/)
.Ve
.IP "browser" 4
.IX Item "browser"
.Vb 2
\&  browser(qr/\ebMSIE (7|8)/)
\&  browser(\*(Aq!\*(Aq,qr!^Mozilla/4!);
.Ve
.Sp
Shortcut for header('User\-Agent')
.IP "all" 4
.IX Item "all"
.Vb 1
\&  all( method(\*(AqGET\*(Aq), path(qr!^/static!) )
.Ve
.Sp
return true if all conditions are return true
.IP "any" 4
.IX Item "any"
.Vb 1
\&  any( path(qr!^/static!), path(\*(Aq/favicon.ico\*(Aq) )
.Ve
.Sp
return true if any condition return true
.SH "EXPORT"
.IX Header "EXPORT"
.Vb 2
\&  use Plack::Builder::Conditionals \-prefx => \*(Aqc\*(Aq;
\&  # exports "c_match_if, c_addr, c_path, c_method, c_header, c_any, c_all"
.Ve
.PP
you can add selected prefix to export functions
.SH "AUTHOR"
.IX Header "AUTHOR"
Masahiro Nagano <kazeburo {at} gmail.com>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Plack::Builder
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.