]>
git.ipfire.org Git - people/pmueller/ipfire-2.x.git/blob - html/cgi-bin/captive.cgi
7a3b1cc495ee8eb5aed7bdcf2b3bac1f45643c64
2 ###############################################################################
4 # IPFire.org - A linux based firewall #
5 # Copyright (C) 2016 IPFire Team <alexander.marx@ipfire.org> #
7 # This program is free software: you can redistribute it and/or modify #
8 # it under the terms of the GNU General Public License as published by #
9 # the Free Software Foundation, either version 3 of the License, or #
10 # (at your option) any later version. #
12 # This program is distributed in the hope that it will be useful, #
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of #
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
15 # GNU General Public License for more details. #
17 # You should have received a copy of the GNU General Public License #
18 # along with this program. If not, see <http://www.gnu.org/licenses/>. #
20 ###############################################################################
26 # enable only the following on debugging purpose
28 #use CGI::Carp 'fatalsToBrowser';
30 require '/var/ipfire/general-functions.pl' ;
31 require "${General::swroot}/lang.pl" ;
32 require "${General::swroot}/header.pl" ;
36 my $coupons = "${General::swroot}/captive/coupons" ;
39 my $logo = "${General::swroot}/captive/logo.dat" ;
48 my $clients = "${General::swroot}/captive/clients" ;
50 my $settingsfile = "${General::swroot}/captive/settings" ;
51 unless (- e
$settingsfile ) { system ( "touch $settingsfile " ); }
53 & Header
:: getcgihash
( \
%cgiparams );
55 & General
:: readhash
( "${General::swroot}/main/settings" , \
%mainsettings );
56 & General
:: readhash
( "/srv/web/ipfire/html/themes/" . $mainsettings { 'THEME' }. "/include/colors.txt" , \
%color );
57 & General
:: readhash
( " $settingsfile " , \
%settings ) if (- f
$settingsfile );
58 & General
:: readhash
( "${General::swroot}/ethernet/settings" , \
%netsettings );
60 & Header
:: showhttpheaders
();
62 if ( $cgiparams { 'ACTION' } eq $Lang :: tr
{ 'save' }) {
63 my $file = $cgiparams { 'logo' };
65 # Check if the file extension is PNG/JPEG
68 my ( $name , $path , $ext ) = fileparse
( $file , qr/\.[^.]*$/ );
69 if ( $ext ne ".png" && $ext ne ".jpg" && $ext ne ".jpeg" ) {
70 $errormessage = $Lang :: tr
{ 'Captive wrong ext' };
74 $settings { 'ENABLE_GREEN' } = $cgiparams { 'ENABLE_GREEN' };
75 $settings { 'ENABLE_BLUE' } = $cgiparams { 'ENABLE_BLUE' };
76 $settings { 'AUTH' } = $cgiparams { 'AUTH' };
77 $settings { 'TITLE' } = $cgiparams { 'TITLE' };
78 $settings { 'COLOR' } = $cgiparams { 'COLOR' };
79 $settings { 'SESSION_TIME' } = $cgiparams { 'SESSION_TIME' };
82 #Check if we need to upload a new logo
85 my ( $filehandle ) = CGI
:: upload
( "logo" );
91 while (< $filehandle >) {
97 & General
:: writehash
( " $settingsfile " , \
%settings );
100 if ( $cgiparams { 'TERMS' }){
101 $cgiparams { 'TERMS' } = & Header
:: escape
( $cgiparams { 'TERMS' });
102 open ( FH
, ">:utf8" , "/var/ipfire/captive/terms.txt" ) or die ( "$!" );
103 print FH
$cgiparams { 'TERMS' };
105 $cgiparams { 'TERMS' } = "" ;
108 #execute binary to reload firewall rules
109 system ( "/usr/local/bin/captivectrl" );
111 if ( $cgiparams { 'ENABLE_BLUE' } eq 'on' ){
112 system ( "/usr/local/bin/wirelessctrl" );
117 if ( $cgiparams { 'ACTION' } eq " $Lang ::tr{'Captive generate coupon'}" ) {
119 if ( $cgiparams { 'EXP_HOUR' } + $cgiparams { 'EXP_DAY' } + $cgiparams { 'EXP_WEEK' } + $cgiparams { 'EXP_MONTH' } == 0 && $cgiparams { 'UNLIMITED' } == '' ) {
120 $errormessage = $Lang :: tr
{ 'Captive noexpiretime' };
124 if ( $cgiparams { 'REMARK' } ne '' && !& validremark
( $cgiparams { 'REMARK' })){
125 $errormessage = $Lang :: tr
{ 'fwhost err remark' };
128 if (! $errormessage ) {
129 # Remember selected values
130 foreach my $val (( "UNLIMITED" , "EXP_HOUR" , "EXP_DAY" , "EXP_WEEK" , "EXP_MONTH" )) {
131 $settings { $val } = $cgiparams { $val };
133 & General
:: writehash
( $settingsfile , \
%settings );
135 & General
:: readhasharray
( $coupons , \
%couponhash ) if (- e
$coupons );
138 # Calculate expiry time in seconds
141 if ( $settings { 'UNLIMITED' } ne 'on' ) {
142 $expires += $settings { 'EXP_HOUR' };
143 $expires += $settings { 'EXP_DAY' };
144 $expires += $settings { 'EXP_WEEK' };
145 $expires += $settings { 'EXP_MONTH' };
148 my $count = $cgiparams { 'COUNT' } || 1 ;
149 while ( $count -- > 0 ) {
150 # Generate a new code
151 my $code = & gencode
();
153 # Check if the coupon code already exists
154 foreach my $key ( keys %couponhash ) {
155 if ( $couponhash { $key }[ 1 ] eq $code ) {
156 # Code already exists, so try again
163 next if ( $code eq "" );
165 # Get a new key from hash
166 my $key = & General
:: findhasharraykey
( \
%couponhash );
168 # Initialize all fields
169 foreach my $i ( 0 .. 3 ) { $couponhash { $key }[ $i ] = "" ; }
171 $couponhash { $key }[ 0 ] = $now ;
172 $couponhash { $key }[ 1 ] = $code ;
173 $couponhash { $key }[ 2 ] = $expires ;
174 $couponhash { $key }[ 3 ] = $cgiparams { 'REMARK' };
177 # Save everything to disk
178 & General
:: writehasharray
( $coupons , \
%couponhash );
182 if ( $cgiparams { 'ACTION' } eq 'delete-coupon' ) {
183 #deletes an already generated but unused voucher
185 #read all generated vouchers
186 & General
:: readhasharray
( $coupons , \
%couponhash ) if (- e
$coupons );
187 foreach my $key ( keys %couponhash ) {
188 if ( $cgiparams { 'key' } eq $couponhash { $key }[ 0 ]){
189 #write logenty with decoded remark
190 my $rem = HTML
:: Entities
:: decode_entities
( $couponhash { $key }[ 4 ]);
191 & General
:: log ( "Captive" , "Delete unused coupon $couponhash { $key }[1] $couponhash { $key }[2] hours valid expires on $couponhash { $key }[3] remark $rem " );
192 #delete line from hash
193 delete $couponhash { $key };
198 & General
:: writehasharray
( $coupons , \
%couponhash );
201 if ( $cgiparams { 'ACTION' } eq 'delete-client' ) {
202 #delete voucher and connection in use
204 #read all active clients
205 & General
:: readhasharray
( $clients , \
%clientshash ) if (- e
$clients );
206 foreach my $key ( keys %clientshash ) {
207 if ( $cgiparams { 'key' } eq $clientshash { $key }[ 0 ]){
208 #prepare log entry with decoded remark
209 my $rem = HTML
:: Entities
:: decode_entities
( $clientshash { $key }[ 7 ]);
211 & General
:: log ( "Captive" , "Deleted client in use $clientshash { $key }[1] $clientshash { $key }[2] hours valid expires on $clientshash { $key }[3] remark $rem - Connection will be terminated" );
212 #delete line from hash
213 delete $clientshash { $key };
218 & General
:: writehasharray
( " $clients " , \
%clientshash );
219 #reload firewallrules to kill connection of client
220 system ( "/usr/local/bin/captivectrl" );
223 #open webpage, print header and open box
224 & Header
:: openpage
( $Lang :: tr
{ 'Captive menu' }, 1 , '' );
225 & Header
:: openbigbox
();
227 # If an error message exists, show a box with the error message
229 & Header
:: openbox
( '100%' , 'left' , $Lang :: tr
{ 'error messages' });
234 # Prints the config box on the website
235 & Header
:: openbox
( '100%' , 'left' , $Lang :: tr
{ 'Captive config' });
237 <form method='post' action=' $ENV {'SCRIPT_NAME'}' enctype="multipart/form-data"> \n
238 <table width='100%' border="0">
243 #check which parameters have to be enabled (from settings file)
244 $checked { 'ENABLE_GREEN' }{ 'off' } = '' ;
245 $checked { 'ENABLE_GREEN' }{ 'on' } = '' ;
246 $checked { 'ENABLE_GREEN' }{ $settings { 'ENABLE_GREEN' }} = "checked='checked'" ;
248 $checked { 'ENABLE_BLUE' }{ 'off' } = '' ;
249 $checked { 'ENABLE_BLUE' }{ 'on' } = '' ;
250 $checked { 'ENABLE_BLUE' }{ $settings { 'ENABLE_BLUE' }} = "checked='checked'" ;
252 $checked { 'UNLIMITED' }{ 'off' } = '' ;
253 $checked { 'UNLIMITED' }{ 'on' } = '' ;
254 $checked { 'UNLIMITED' }{ $settings { 'UNLIMITED' }} = "checked='checked'" ;
256 $selected { 'AUTH' } = ();
257 $selected { 'AUTH' }{ 'COUPON' } = "" ;
258 $selected { 'AUTH' }{ 'TERMS' } = "" ;
259 $selected { 'AUTH' }{ $settings { 'AUTH' }} = "selected" ;
261 if ( $netsettings { 'GREEN_DEV' }){
262 print "<td width='30%'> $Lang ::tr{'Captive active on'} <font color='$Header::colourgreen'>Green</font></td><td><input type='checkbox' name='ENABLE_GREEN' $checked{'ENABLE_GREEN'}{'on'} /></td></tr>" ;
264 if ( $netsettings { 'BLUE_DEV' }){
265 print "<td width='30%'> $Lang ::tr{'Captive active on'} <font color='$Header::colourblue'>Blue</font></td><td><input type='checkbox' name='ENABLE_BLUE' $checked{'ENABLE_BLUE'}{'on'} /></td></tr>" ;
272 $Lang ::tr{'Captive authentication'}
276 <option value="TERMS" $selected {'AUTH'}{'TERMS'} > $Lang ::tr{'Captive terms'}</option>
277 <option value="COUPON" $selected {'AUTH'}{'COUPON'}> $Lang ::tr{'Captive coupon'}</option>
284 if ( $settings { 'AUTH' } eq 'TERMS' ) {
285 $selected { 'SESSION_TIME' } = ();
286 $selected { 'SESSION_TIME' }{ '0' } = "" ;
287 $selected { 'SESSION_TIME' }{ '3600' } = "" ;
288 $selected { 'SESSION_TIME' }{ '86400' } = "" ;
289 $selected { 'SESSION_TIME' }{ '604800' } = "" ;
290 $selected { 'SESSION_TIME' }{ '18144000' } = "" ;
291 $selected { 'SESSION_TIME' }{ $settings { 'SESSION_TIME' }} = "selected" ;
293 my $terms = & getterms
();
298 <textarea cols="50" rows="10" name="TERMS"> $terms </textarea>
303 <td> $Lang ::tr{'Captive client session expiry time'}</td>
305 <select name="SESSION_TIME">
306 <option value="0" $selected {'SESSION_TIME'}{'0'}>- $Lang ::tr{'unlimited'} -</option>
307 <option value="3600" $selected {'SESSION_TIME'}{'3600'}> $Lang ::tr{'one hour'}</option>
308 <option value="86400" $selected {'SESSION_TIME'}{'86400'}> $Lang ::tr{'24 hours'}</option>
309 <option value="604800" $selected {'SESSION_TIME'}{'604800'}> $Lang ::tr{'one week'}</option>
310 <option value="18144000" $selected {'SESSION_TIME'}{'18144000'}> $Lang ::tr{'one month'}</option>
321 <strong> $Lang ::tr{'Captive branding'}</strong>
326 $Lang ::tr{'Captive title'}
329 <input type='text' name='TITLE' value=" $settings {'TITLE'}" size='40'>
333 <td> $Lang ::tr{'Captive brand color'}</td>
335 <input type="color" name="COLOR" value=" $settings {'COLOR'}">
340 $Lang ::tr{'Captive upload logo'}
343 <input type="file" name="logo">
344 <br> $Lang ::tr{'Captive upload logo recommendations'}
352 <td> $Lang ::tr{'Captive logo uploaded'}</td>
353 <td> $Lang ::tr{'yes'}</td>
362 <input type='submit' name='ACTION' value=" $Lang ::tr{'save'}"/>
370 #if settings is set to use coupons, the coupon part has to be displayed
371 if ( $settings { 'AUTH' } eq 'COUPON' ) {
375 # Show active clients
381 open ( FILE
, "<:utf8" , "/var/ipfire/captive/terms.txt" );
383 push ( @ret , HTML
:: Entities
:: decode_entities
( $_ ));
387 return join ( /\n/ , @ret );
391 #generate a random code only letters from A-Z except 'O' and 0-9
392 my @chars = ( "A" .. "N" , "P" .. "Z" , "0" .. "9" );
394 $randomstring .= $chars [ rand @chars ] for 1 . .8 ;
395 return $randomstring ;
399 & Header
:: openbox
( '100%' , 'left' , $Lang :: tr
{ 'Captive generate coupon' });
401 <form method='post' action=' $ENV {'SCRIPT_NAME'}'>
402 <table border='0' width='100%'>
405 $Lang ::tr{'Captive vouchervalid'}
408 <table class='tbl' border='0' width='100%'>
410 <th> $Lang ::tr{'hours'}</th>
411 <th> $Lang ::tr{'days'}</th>
412 <th> $Lang ::tr{'weeks'}</th>
413 <th> $Lang ::tr{'months'}</th>
418 #print hour-dropdownbox
420 print "<tr height='40px'><td><select name='EXP_HOUR' style='width:8em;'>" ;
421 print "<option value='0' " ;
422 print " selected='selected'" if ( $settings { 'EXP_HOUR' } eq '0' );
423 print ">--</option>" ;
424 for ( my $i = 1 ; $i < 25 ; $i ++){
425 my $exp_sec = $i * $hrs ;
426 print "<option value=' $exp_sec ' " ;
427 print " selected='selected'" if ( $settings { 'EXP_HOUR' } eq $exp_sec );
428 print "> $i </option>" ;
432 #print day-dropdownbox
434 print "<select name='EXP_DAY' style='width:8em;'>" ;
435 print "<option value='0' " ;
436 print " selected='selected'" if ( $settings { 'EXP_DAY' } eq '0' );
437 print ">--</option>" ;
438 for ( my $i = 1 ; $i < 8 ; $i ++){
439 my $exp_sec = $i * $days ;
440 print "<option value=' $exp_sec ' " ;
441 print " selected='selected'" if ( $settings { 'EXP_DAY' } eq $exp_sec );
442 print "> $i </option>" ;
446 #print week-dropdownbox
448 print "<select name='EXP_WEEK' style='width:8em;'>" ;
449 print "<option value='0' " ;
450 print " selected='selected'" if ( $settings { 'EXP_WEEK' } eq '0' );
451 print ">--</option>" ;
452 for ( my $i = 1 ; $i < 5 ; $i ++){
453 my $exp_sec = $i * $week ;
454 print "<option value=' $exp_sec ' " ;
455 print " selected='selected'" if ( $settings { 'EXP_WEEK' } eq $exp_sec );
456 print "> $i </option>" ;
460 #print month-dropdownbox
461 my $month = 3600 * 24 * 30 ;
462 print "<select name='EXP_MONTH' style='width:8em;'>" ;
463 print "<option value='0' " ;
464 print " selected='selected'" if ( $settings { 'EXP_MONTH' } eq '0' );
465 print ">--</option>" ;
466 for ( my $i = 1 ; $i < 13 ; $i ++){
467 my $exp_sec = $i * $month ;
468 print "<option value=' $exp_sec ' " ;
469 print " selected='selected'" if ( $settings { 'EXP_MONTH' } eq $exp_sec );
470 print "> $i </option>" ;
476 <input type='checkbox' name='UNLIMITED' $checked {'UNLIMITED'}{'on'} />
477 $Lang ::tr{'Captive nolimit'}
485 <td> $Lang ::tr{'remark'}</td>
487 <input type='text' style='width: 98%;' name='REMARK' align='left'>
493 <select name="COUNT">
494 <option value="1">1</option>
495 <option value="2">2</option>
496 <option value="3">3</option>
497 <option value="4">4</option>
498 <option value="5">5</option>
499 <option value="6">6</option>
500 <option value="7">7</option>
501 <option value="8">8</option>
502 <option value="9">9</option>
503 <option value="10">10</option>
504 <option value="20">20</option>
505 <option value="50">50</option>
506 <option value="100">100</option>
509 <input type="submit" name="ACTION" value=" $Lang ::tr{'Captive generate coupon'}">
516 # Show all coupons if exist
523 & General
:: readhasharray
( $coupons , \
%couponhash ) if (- e
$coupons );
525 #if there are already generated but unsused coupons, print a table
526 & Header
:: openbox
( '100%' , 'left' , $Lang :: tr
{ 'Captive issued coupons' });
529 <table class='tbl' border='0'>
531 <th align='center' width='15%'>
532 $Lang ::tr{'Captive coupon'}
534 <th align='center' width='15%'> $Lang ::tr{'Captive expiry time'}</th>
535 <th align='center' width='65%'> $Lang ::tr{'remark'}</th>
536 <th align='center' width='5%'> $Lang ::tr{'delete'}</th>
540 foreach my $key ( keys %couponhash ) {
541 my $expirytime = $Lang :: tr
{ 'Captive nolimit' };
542 if ( $couponhash { $key }[ 2 ] > 0 ) {
543 $expirytime = & General
:: format_time
( $couponhash { $key }[ 2 ]);
547 $col = "bgcolor=' $color {'color20'}'" ;
549 $col = "bgcolor=' $color {'color22'}'" ;
554 <td $col align="center">
555 <b> $couponhash { $key }[1]</b>
557 <td $col align="center">
560 <td $col align="center">
563 <td $col align="center">
565 <input type='image' src='/images/delete.gif' align='middle' alt=' $Lang ::tr{'delete'}' title=' $Lang ::tr{'delete'}' />
566 <input type='hidden' name='ACTION' value='delete-coupon' />
567 <input type='hidden' name='key' value=' $couponhash { $key }[0]' />
580 # if there are active clients which use coupons show table
581 return if ( - z
$clients || ! - f
$clients );
586 & Header
:: openbox
( '100%' , 'left' , $Lang :: tr
{ 'Captive clients' });
589 <table class='tbl' width='100%'>
591 <th align='center' width='15%'> $Lang ::tr{'Captive coupon'}</th>
592 <th align='center' width='15%'> $Lang ::tr{'Captive activated'}</th>
593 <th align='center' width='15%'> $Lang ::tr{'Captive expiry time'}</th>
594 <th align='center' width='10%'> $Lang ::tr{'Captive mac'}</th>
595 <th align='center' width='43%'> $Lang ::tr{'remark'}</th>
596 <th align='center' width='5%'> $Lang ::tr{'delete'}</th>
600 & General
:: readhasharray
( $clients , \
%clientshash ) if (- e
$clients );
601 foreach my $key ( keys %clientshash ) {
602 #calculate time from clientshash (starttime)
603 my $starttime = sub { sprintf ' %02d . %02d . %04d %02d : %02d ' , $_ [ 3 ], $_ [ 4 ]+ 1 , $_ [ 5 ]+ 1900 , $_ [ 2 ], $_ [ 1 ] }->( localtime ( $clientshash { $key }[ 2 ]));
605 #calculate endtime from clientshash
607 if ( $clientshash { $key }[ 3 ] eq '0' ){
608 $endtime = $Lang :: tr
{ 'Captive nolimit' };
610 $endtime = sub { sprintf ' %02d . %02d . %04d %02d : %02d ' , $_ [ 3 ], $_ [ 4 ]+ 1 , $_ [ 5 ]+ 1900 , $_ [ 2 ], $_ [ 1 ] }->( localtime ( $clientshash { $key }[ 2 ]+ $clientshash { $key }[ 3 ]));
614 $col = "bgcolor=' $color {'color20'}'" ;
616 $col = "bgcolor=' $color {'color22'}'" ;
619 my $coupon = ( $clientshash { $key }[ 4 ] eq "LICENSE" ) ?
$Lang :: tr
{ 'Captive terms short' } : $clientshash { $key }[ 4 ];
623 <td $col align="center"><b> $coupon </b></td>
624 <td $col align="center"> $starttime </td>
625 <td $col align="center"> $endtime </td>
626 <td $col align="center"> $clientshash { $key }[0]</td>
627 <td $col align="center"> $clientshash { $key }[5]</td>
628 <td $col align="center">
630 <input type='image' src='/images/delete.gif' align='middle' alt=' $Lang ::tr{'delete'}' title=' $Lang ::tr{'delete'}' />
631 <input type='hidden' name='ACTION' value='delete-client' />
632 <input type='hidden' name='key' value=' $clientshash { $key }[0]' />
646 # Checks a hostname against RFC1035
648 # Each part should be at least two characters in length
649 # but no more than 63 characters
650 if ( length ( $remark ) < 1 || length ( $remark ) > 255 ) {
652 # Only valid characters are a-z, A-Z, 0-9 and -
653 if ( $remark !~ /^[a-zäöüA-ZÖÄÜ0-9-.:;\|_()\/ \s
]*$/) {
655 # First character can only be a letter or a digit
656 if ( substr ( $remark , 0 , 1 ) !~ /^[a-zäöüA-ZÖÄÜ0-9]*$/ ) {
658 # Last character can only be a letter or a digit
659 if ( substr ( $remark , - 1 , 1 ) !~ /^[a-zöäüA-ZÖÄÜ0-9.:;_)]*$/ ) {
664 & Header
:: closebigbox
();
665 & Header
:: closepage
();