html/cgi-bin/routing.cgi

   1 #!/usr/bin/perl
   2 ###############################################################################
   3 #                                                                             #
   4 # IPFire.org - A linux based firewall                                         #
   5 # Copyright (C) 2007-2011  IPFire Team  <info@ipfire.org>                     #
   6 #                                                                             #
   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.                                         #
  11 #                                                                             #
  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.                                #
  16 #                                                                             #
  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/>.       #
  19 #                                                                             #
  20 ###############################################################################
  21
  22 use strict;
  23
  24 # enable only the following on debugging purpose
  25 #use warnings;
  26 #use CGI::Carp 'fatalsToBrowser';
  27
  28 require '/var/ipfire/general-functions.pl';
  29 require "${General::swroot}/lang.pl";
  30 require "${General::swroot}/header.pl";
  31
  32 #workaround to suppress a warning when a variable is used only once
  33 my @dummy = ( ${Header::colouryellow} );
  34 undef (@dummy);
  35
  36 # Files used
  37 my $setting = "${General::swroot}/main/settings";
  38 our $datafile = "${General::swroot}/main/routing";              #(our: used in subroutine)
  39
  40 my %color = ();
  41 my %mainsettings = ();
  42 &General::readhash("${General::swroot}/main/settings", \%mainsettings);
  43 &General::readhash("/srv/web/ipfire/html/themes/".$mainsettings{'THEME'}."/include/colors.txt", \%color);
  44
  45 our %settings = ();
  46
  47 $settings{'EN'} = '';                   # reuse for dummy field in position zero
  48 $settings{'IP'} = '';
  49 $settings{'GATEWAY'} = '';
  50 $settings{'REMARK'} = '';
  51 my @nosaved=('EN','IP','GATEWAY','REMARK');     # List here ALL setting2 fields. Mandatory
  52
  53 $settings{'ACTION'} = '';               # add/edit/remove
  54 $settings{'KEY1'} = '';                 # point record for ACTION
  55
  56 #Define each field that can be used to sort columns
  57 my $sortstring='^IP|^GATEWAY|^REMARK';
  58 $settings{'SORT_GATEWAYLIST'} = 'GATEWAY';
  59 my $errormessage = '';
  60 my $warnmessage = '';
  61
  62 &Header::showhttpheaders();
  63
  64 #Get GUI values
  65 &Header::getcgihash(\%settings);
  66
  67 ###############
  68 # DEBUG DEBUG
  69 #&Header::openbox('100%', 'left', 'DEBUG');
  70 #my $debugCount = 0;
  71 #foreach my $line (sort keys %settings) {
  72 #print "$line = $settings{$line}<br />\n";
  73 # $debugCount++;
  74 #}
  75 #print "&nbsp;Count: $debugCount\n";
  76 #&Header::closebox();
  77 # DEBUG DEBUG
  78 ###############
  79
  80 # Load multiline data
  81 our @current = ();
  82 if (open(FILE, "$datafile")) {
  83     @current = <FILE>;
  84     close (FILE);
  85 }
  86
  87 ## Settings1 Box not used...
  88 &General::readhash("${General::swroot}/main/settings", \%settings);
  89
  90
  91 ## Now manipulate the multi-line list with Settings2
  92 # Basic actions are:
  93 #       toggle the check box
  94 #       add/update a new line
  95 #       begin editing a line
  96 #       remove a line
  97
  98
  99 # Toggle enable/disable field.  Field is in second position
 100 if ($settings{'ACTION'} eq $Lang::tr{'toggle enable disable'}) {
 101     #move out new line
 102     chomp(@current[$settings{'KEY1'}]);
 103     my @temp = split(/\,/,@current[$settings{'KEY1'}]);
 104
 105     $temp[0] = $temp[0] ne '' ? '' : 'on';              # Toggle the field
 106     @current[$settings{'KEY1'}] = join (',',@temp)."\n";
 107     $settings{'KEY1'} = '';                             # End edit mode
 108
 109     &General::log($Lang::tr{'routing config changed'});
 110
 111     #Save current
 112     open(FILE, ">$datafile") or die 'routing datafile error';
 113     print FILE @current;
 114     close(FILE);
 115
 116     # Rebuild configuration file
 117     &BuildConfiguration;
 118 }
 119
 120 if ($settings{'ACTION'} eq $Lang::tr{'add'}) {
 121         # Convert subnet masks to CIDR notation.
 122         $settings{'IP'} = &General::iporsubtocidr($settings{'IP'});
 123
 124 # Validate inputs
 125         if (( !&General::validip($settings{'IP'})) and ( !&General::validipandmask($settings{'IP'}))){
 126         $errormessage = $Lang::tr{'invalid ip'}." / ".$Lang::tr{'invalid netmask'};
 127         }
 128
 129         if ($settings{'IP'} =~ /0.0.0.0/){
 130         $errormessage = $Lang::tr{'invalid ip'}." - 0.0.0.0";
 131         }
 132
 133         if( !&General::validip($settings{'GATEWAY'}) ) {
 134         $errormessage = $Lang::tr{'invalid ip'}. " - ".$Lang::tr{'gateway ip'};
 135         }
 136
 137     unless ($errormessage) {
 138         if ($settings{'KEY1'} eq '') { #add or edit ?
 139             unshift (@current, "$settings{'EN'},$settings{'IP'},$settings{'GATEWAY'},$settings{'REMARK'}\n");
 140             &General::log($Lang::tr{'routing config added'});
 141         } else {
 142             @current[$settings{'KEY1'}] = "$settings{'EN'},$settings{'IP'},$settings{'GATEWAY'},$settings{'REMARK'}\n";
 143             $settings{'KEY1'} = '';       # End edit mode
 144             &General::log($Lang::tr{'routing config changed'});
 145         }
 146
 147         # Write changes to config file.
 148         &SortDataFile;                          # sort newly added/modified entry
 149         &BuildConfiguration;                    # then re-build routing
 150
 151         #map ($settings{$_}='' ,@nosaved);      # Clear fields
 152     }
 153 }
 154
 155 if ($settings{'ACTION'} eq $Lang::tr{'edit'}) {
 156     #move out new line
 157     my $line = @current[$settings{'KEY1'}];     # KEY1 is the index in current
 158     chomp($line);
 159     my @temp = split(/\,/, $line);
 160     $settings{'EN'}=$temp[0];                   # Prepare the screen for editing
 161     $settings{'IP'}=$temp[1];
 162     $settings{'GATEWAY'}=$temp[2];
 163     $settings{'REMARK'}=$temp[3];
 164     &BuildConfiguration;
 165 }
 166
 167 if ($settings{'ACTION'} eq $Lang::tr{'remove'}) {
 168     splice (@current,$settings{'KEY1'},1);              # Delete line
 169     open(FILE, ">$datafile") or die 'route datafile error';
 170     print FILE @current;
 171     close(FILE);
 172     $settings{'KEY1'} = '';                             # End remove mode
 173     &General::log($Lang::tr{'route config changed'});
 174
 175     &BuildConfiguration;                                # then re-build conf which use new data
 176 }
 177
 178 ##  Check if sorting is asked
 179 # If same column clicked, reverse the sort.
 180 if ($ENV{'QUERY_STRING'} =~ /$sortstring/ ) {
 181     my $newsort=$ENV{'QUERY_STRING'};
 182     my $actual=$settings{'SORT_GATEWAYLIST'};
 183     #Reverse actual sort ?
 184     if ($actual =~ $newsort) {
 185         my $Rev='';
 186         if ($actual !~ 'Rev') {
 187             $Rev='Rev';
 188         }
 189         $newsort.=$Rev;
 190     }
 191     $settings{'SORT_GATEWAYLIST'}=$newsort;
 192     map (delete ($settings{$_}) ,(@nosaved,'ACTION','KEY1'));# Must never be saved
 193     &General::writehash($setting, \%settings);
 194     &SortDataFile;
 195     $settings{'ACTION'} = 'SORT';                       # Create an 'ACTION'
 196     map ($settings{$_} = '' ,@nosaved,'KEY1');          # and reinit vars to empty
 197 }
 198
 199 if ($settings{'ACTION'} eq '' ) { # First launch from GUI
 200     # Place here default value when nothing is initialized
 201     $settings{'EN'} = 'on';
 202     $settings{'GATEWAY'} = '';
 203     $settings{'IP'} = '';
 204 }
 205
 206 &Header::openpage($Lang::tr{'routing table entries'}, 1, '');
 207 &Header::openbigbox('100%', 'left', '', $errormessage);
 208 my %checked=();     # Checkbox manipulations
 209
 210 if ($errormessage) {
 211     &Header::openbox('100%', 'left', $Lang::tr{'error messages'});
 212     print "<font class='base'>$errormessage&nbsp;</font>";
 213     &Header::closebox();
 214 }
 215
 216 #
 217
 218 $checked{'EN'}{'on'} = ($settings{'EN'} eq '' ) ? '' : "checked='checked'";
 219
 220 my $buttontext = $Lang::tr{'add'};
 221 if ($settings{'KEY1'} ne '') {
 222     $buttontext = $Lang::tr{'update'};
 223     &Header::openbox('100%', 'left', $Lang::tr{'Edit an existing route'});
 224 } else {
 225     &Header::openbox('100%', 'left', $Lang::tr{'Add a route'});
 226 }
 227
 228 #Edited line number (KEY1) passed until cleared by 'save' or 'remove' or 'new sort order'
 229 print <<END
 230 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
 231 <input type='hidden' name='KEY1' value='$settings{'KEY1'}' />
 232 <table width='100%'>
 233 <tr>
 234     <td class='base'>$Lang::tr{'host ip'} / $Lang::tr{'network'}:&nbsp;</td>
 235     <td><input type='text' name='IP' value='$settings{'IP'}' size='25'/></td>
 236 </tr><tr>
 237     <td class='base'>$Lang::tr{'gateway'}:&nbsp;</td>
 238     <td><input type='text' name='GATEWAY' value='$settings{'GATEWAY'}' size='25'/></td>
 239     <td class='base'>$Lang::tr{'enabled'}</td>
 240     <td><input type='checkbox' name='EN' $checked{'EN'}{'on'} /></td>
 241 </tr>
 242 </tr>
 243     <td class='base'>$Lang::tr{'remark'}:&nbsp;</td>
 244     <td><input type='text' name='REMARK' value='$settings{'REMARK'}' size='25'/></td>
 245 </tr>
 246 </table>
 247 <hr />
 248 <table width='100%'>
 249 <tr>
 250     <td width='50%' align='center'><input type='hidden' name='ACTION' value='$Lang::tr{'add'}' /><input type='submit' name='SUBMIT' value='$buttontext' /></td>
 251 </tr>
 252 </table>
 253 </form>
 254 END
 255 ;
 256 &Header::closebox();
 257
 258 &Header::openbox('100%', 'left', $Lang::tr{'routing table'});
 259 print <<END
 260 <hr />
 261 <table width='100%'>
 262 <tr>
 263     <td width='30%' align='center'><a href='$ENV{'SCRIPT_NAME'}?IP'><b>$Lang::tr{'host ip'} / $Lang::tr{'network'}</b></a></td>
 264     <td width='30%' align='center'><a href='$ENV{'SCRIPT_NAME'}?GATEWAY'><b>$Lang::tr{'gateway'}</b></a></td>
 265     <td width='30%' align='center'><a href='$ENV{'SCRIPT_NAME'}?REMARK'><b>$Lang::tr{'remark'}</b></a></td>
 266     <td width='10%' colspan='3' class='boldbase' align='center'><b>$Lang::tr{'action'}</b></td>
 267 </tr>
 268 END
 269 ;
 270
 271 #
 272 # Print each line of @current list
 273 #
 274
 275 my $key = 0;
 276 foreach my $line (@current) {
 277     chomp($line);                               # remove newline
 278     my @temp=split(/\,/,$line);
 279     $temp[2] ='' unless defined $temp[2]; # not always populated
 280     $temp[3] ='' unless defined $temp[2]; # not always populated
 281
 282     #Choose icon for checkbox
 283     my $gif = '';
 284     my $gdesc = '';
 285     if ($temp[0] ne '' ) {
 286         $gif = 'on.gif';
 287         $gdesc = $Lang::tr{'click to disable'};
 288     } else {
 289         $gif = 'off.gif';
 290         $gdesc = $Lang::tr{'click to enable'};
 291     }
 292
 293     #Colorize each line
 294     if ($settings{'KEY1'} eq $key) {
 295         print "<tr bgcolor='${Header::colouryellow}'>";
 296     } elsif ($key % 2) {
 297         print "<tr bgcolor='$color{'color22'}'>";
 298     } else {
 299         print "<tr bgcolor='$color{'color20'}'>";
 300     }
 301     print <<END
 302 <td align='center'>$temp[1]</td>
 303 <td align='center'>$temp[2]</td>
 304 <td align='center'>$temp[3]</td>
 305 <td align='center'>
 306 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
 307 <input type='hidden' name='ACTION' value='$Lang::tr{'toggle enable disable'}' />
 308 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$gif' alt='$gdesc' title='$gdesc' />
 309 <input type='hidden' name='KEY1' value='$key' />
 310 </form>
 311 </td>
 312
 313 <td align='center'>
 314 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
 315 <input type='hidden' name='ACTION' value='$Lang::tr{'edit'}' />
 316 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}' />
 317 <input type='hidden' name='KEY1' value='$key' />
 318 </form>
 319 </td>
 320
 321 <td align='center'>
 322 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
 323 <input type='hidden' name='ACTION' value='$Lang::tr{'remove'}' />
 324 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' alt='$Lang::tr{'remove'}' title='$Lang::tr{'remove'}' />
 325 <input type='hidden' name='KEY1' value='$key' />
 326 </form>
 327 </td>
 328 </tr>
 329 END
 330 ;
 331     $key++;
 332 }
 333 print "</table>";
 334
 335 # If table contains entries, print 'Key to action icons'
 336 if ($key) {
 337 print <<END
 338 <table>
 339 <tr>
 340     <td class='boldbase'>&nbsp;<b>$Lang::tr{'legend'}:&nbsp;</b></td>
 341     <td><img src='/images/on.gif' alt='$Lang::tr{'click to disable'}' /></td>
 342     <td class='base'>$Lang::tr{'click to disable'}</td>
 343     <td>&nbsp;&nbsp;</td>
 344     <td><img src='/images/off.gif' alt='$Lang::tr{'click to enable'}' /></td>
 345     <td class='base'>$Lang::tr{'click to enable'}</td>
 346     <td>&nbsp;&nbsp;</td>
 347     <td><img src='/images/edit.gif' alt='$Lang::tr{'edit'}' /></td>
 348     <td class='base'>$Lang::tr{'edit'}</td>
 349     <td>&nbsp;&nbsp;</td>
 350     <td><img src='/images/delete.gif' alt='$Lang::tr{'remove'}' /></td>
 351     <td class='base'>$Lang::tr{'remove'}</td>
 352 </tr>
 353 </table>
 354 END
 355 ;
 356 }
 357
 358 &Header::closebox();
 359
 360 my $output = `/sbin/ip route show table static`;
 361 $output = &Header::cleanhtml($output,"y");
 362
 363 if ( $output != "" ) {
 364         &Header::openbox('100%', 'left', $Lang::tr{'routing table entries'});
 365         print "<pre>$output</pre>\n";
 366         &Header::closebox();
 367 }
 368
 369 &Header::closebigbox();
 370 &Header::closepage();
 371
 372 ## Ouf it's the end !
 373
 374 # Sort the "current" array according to choices
 375 sub SortDataFile
 376 {
 377     our %entries = ();
 378
 379     # Sort pair of record received in $a $b special vars.
 380     # When IP is specified use numeric sort else alpha.
 381     # If sortname ends with 'Rev', do reverse sort.
 382     #
 383     sub fixedleasesort {
 384         my $qs='';             # The sort field specified minus 'Rev'
 385         if (rindex ($settings{'SORT_GATEWAYLIST'},'Rev') != -1) {
 386             $qs=substr ($settings{'SORT_GATEWAYLIST'},0,length($settings{'SORT_GATEWAYLIST'})-3);
 387             if ($qs eq 'IP') {
 388                 my @a = split(/\./,$entries{$a}->{$qs});
 389                 my @b = split(/\./,$entries{$b}->{$qs});
 390                 ($b[0]<=>$a[0]) ||
 391                 ($b[1]<=>$a[1]) ||
 392                 ($b[2]<=>$a[2]) ||
 393                 ($b[3]<=>$a[3]);
 394             } else {
 395                 $entries{$b}->{$qs} cmp $entries{$a}->{$qs};
 396             }
 397         } else { #not reverse
 398             $qs=$settings{'SORT_GATEWAYLIST'};
 399             if ($qs eq 'IP') {
 400                 my @a = split(/\./,$entries{$a}->{$qs});
 401                 my @b = split(/\./,$entries{$b}->{$qs});
 402                 ($a[0]<=>$b[0]) ||
 403                 ($a[1]<=>$b[1]) ||
 404                 ($a[2]<=>$b[2]) ||
 405                 ($a[3]<=>$b[3]);
 406             } else {
 407                 $entries{$a}->{$qs} cmp $entries{$b}->{$qs};
 408             }
 409         }
 410     }
 411
 412     #Use an associative array (%entries)
 413     my $key = 0;
 414     foreach my $line (@current) {
 415         chomp( $line); #remove newline because can be on field 5 or 6 (addition of REMARK)
 416         my @temp = ( '','','', '');
 417         @temp = split (',',$line);
 418
 419         # Build a pair 'Field Name',value for each of the data dataline.
 420         # Each SORTABLE field must have is pair.
 421         # Other data fields (non sortable) can be grouped in one
 422
 423         my @record = ('KEY',$key++,'EN',$temp[0],'IP',$temp[1],'GATEWAY',$temp[2],'REMARK',$temp[3]);
 424         my $record = {};                                # create a reference to empty hash
 425         %{$record} = @record;                           # populate that hash with @record
 426         $entries{$record->{KEY}} = $record;             # add this to a hash of hashes
 427     }
 428
 429     open(FILE, ">$datafile") or die 'routing datafile error';
 430
 431     # Each field value is printed , with the newline ! Don't forget separator and order of them.
 432     foreach my $entry (sort fixedleasesort keys %entries) {
 433         print FILE "$entries{$entry}->{EN},$entries{$entry}->{IP},$entries{$entry}->{GATEWAY},$entries{$entry}->{REMARK}\n";
 434     }
 435
 436     close(FILE);
 437     # Reload sorted  @current
 438     open (FILE, "$datafile");
 439     @current = <FILE>;
 440     close (FILE);
 441 }
 442
 443 #
 444 # Build the configuration file
 445 #
 446 sub BuildConfiguration {
 447     system '/usr/local/bin/rebuildroutes';
 448 }