html/cgi-bin/logs.cgi/ovpnclients.dat

   1 #!/usr/bin/perl
   2 ###############################################################################
   3 #                                                                             #
   4 # IPFire.org - A linux based firewall                                         #
   5 # Copyright (C) 2020 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 use POSIX();
  24 use DBI;
  25
  26 # enable only the following on debugging purpose
  27 #use warnings;
  28 #use CGI::Carp 'fatalsToBrowser';
  29
  30 require '/var/ipfire/general-functions.pl';
  31 require "${General::swroot}/lang.pl";
  32 require "${General::swroot}/header.pl";
  33
  34 my %color = ();
  35 my %mainsettings = ();
  36 &General::readhash("${General::swroot}/main/settings", \%mainsettings);
  37 &General::readhash("/srv/web/ipfire/html/themes/".$mainsettings{'THEME'}."/include/colors.txt", \%color);
  38
  39 # Path and file of the OVPN connections database.
  40 my $database = "/var/ipfire/ovpn/clients.db";
  41
  42 my %cgiparams=();
  43 my %logsettings=();
  44 my %ovpnsettings=();
  45
  46 my $errormessage='';
  47
  48 # Hash wich contains the month numbers and the translated names for easy access.
  49 my %monthhash = (
  50         "1" => "$Lang::tr{'january'}",
  51         "2" => "$Lang::tr{'february'}",
  52         "3" => "$Lang::tr{'march'}",
  53         "4" => "$Lang::tr{'april'}",
  54         "5" => "$Lang::tr{'may'}",
  55         "6" => "$Lang::tr{'june'}",
  56         "7" => "$Lang::tr{'july'}",
  57         "8" => "$Lang::tr{'august'}",
  58         "9" => "$Lang::tr{'september'}",
  59         "10" => "$Lang::tr{'october'}",
  60         "11" => "$Lang::tr{'november'}",
  61         "12" => "$Lang::tr{'december'}"
  62 );
  63
  64 # Get current time.
  65 my ($sec,$min,$hour,$mday,$month,$year,$wday,$yday,$isdst) = localtime(time);
  66
  67 # Adjust month, because Jan starts as month "0".
  68 $month = $month+1;
  69
  70 # Adjust year number.
  71 $year = $year+1900;
  72
  73 # Assign default vaules.
  74 $cgiparams{'FROM_DAY'} = $mday;
  75 $cgiparams{'FROM_MONTH'} = $month;
  76 $cgiparams{'FROM_YEAR'} = $year;
  77 $cgiparams{'TO_DAY'} = $mday;
  78 $cgiparams{'TO_MONTH'} = $month;
  79 $cgiparams{'TO_YEAR'} = $year;
  80
  81 &Header::getcgihash(\%cgiparams);
  82
  83 # Read-in OpenVPN settings and connections.
  84 &General::readhasharray("${General::swroot}/ovpn/ovpnconfig", \%ovpnsettings);
  85
  86 # Init DB Module and connect to the database.
  87 my $database_handle = DBI->connect("DBI:SQLite:dbname=$database", "", "", { RaiseError => 1 });
  88
  89 # Generate datestrings for SQL queries.
  90 my $from_datestring = sprintf '%04d-%02d-%02d', ($cgiparams{"FROM_YEAR"}, $cgiparams{"FROM_MONTH"}, $cgiparams{"FROM_DAY"});
  91 my $to_datestring = sprintf '%04d-%02d-%02d', ($cgiparams{"TO_YEAR"}, $cgiparams{"TO_MONTH"}, $cgiparams{"TO_DAY"});
  92
  93 # Check if the to datestring is later than the from datestring.
  94 unless ($to_datestring ge $from_datestring) {
  95         $errormessage = "$Lang::tr{'error the to date has to be later than the from date'}";
  96 }
  97
  98 my $database_query = qq(
  99         SELECT
 100         common_name, SUM(
 101                 STRFTIME('%s', (
 102                         CASE
 103                                 WHEN DATETIME(COALESCE(disconnected_at, CURRENT_TIMESTAMP), 'localtime') < DATETIME('$to_datestring', 'localtime', 'start of day', '+86399 seconds')
 104                                         THEN DATETIME(COALESCE(disconnected_at, CURRENT_TIMESTAMP), 'localtime')
 105                                         ELSE DATETIME('$to_datestring', 'localtime', 'start of day', '+86399 seconds')
 106                         END
 107                 ), 'utc') -
 108                 STRFTIME('%s', (
 109                         CASE
 110                                 WHEN DATETIME(connected_at, 'localtime') > DATETIME('$from_datestring', 'localtime', 'start of day')
 111                                         THEN DATETIME(connected_at, 'localtime')
 112                                         ELSE DATETIME('$from_datestring', 'localtime', 'start of day')
 113                         END
 114                 ), 'utc')
 115         ) AS duration
 116         FROM sessions
 117         WHERE
 118                 (
 119                         disconnected_at IS NULL
 120                         OR
 121                         DATETIME(disconnected_at, 'localtime') > DATETIME('$from_datestring', 'localtime', 'start of day')
 122                 )
 123                 AND
 124                 DATETIME(connected_at, 'localtime') < DATETIME('$to_datestring', 'localtime', 'start of day', '+86399 seconds')
 125         GROUP BY common_name
 126         ORDER BY common_name, duration DESC;
 127 );
 128
 129 if ($cgiparams{'CONNECTION_NAME'}) {
 130         $database_query = qq(
 131                 SELECT common_name, DATETIME(connected_at, 'localtime'), DATETIME(disconnected_at, 'localtime'), bytes_received, bytes_sent FROM sessions
 132                 WHERE
 133                         common_name = '$cgiparams{"CONNECTION_NAME"}'
 134                         AND (
 135                                 DATETIME(disconnected_at, 'localtime') > DATETIME('$from_datestring', 'localtime', 'start of day')
 136                                 AND
 137                                 DATETIME(connected_at, 'localtime') < DATETIME('$to_datestring', 'localtime', 'start of day', '+86399 seconds')
 138                         )
 139                 ORDER BY connected_at;
 140         );
 141 }
 142
 143 # Prepare SQL statement.
 144 my $statement_handle = $database_handle->prepare($database_query);
 145
 146 # Execute SQL statement and get retun value if any error happened.
 147 my $database_return_value = $statement_handle->execute();
 148
 149 # If an error has been returned, assign it to the errorstring value for displaying.
 150 if($database_return_value < 0) {
 151    $errormessage = "$DBI::errstr";
 152 }
 153
 154 &Header::showhttpheaders();
 155
 156 &Header::openpage($Lang::tr{'ovpn rw connection log'}, 1, '');
 157
 158 &Header::openbigbox('100%', 'left', '', $errormessage);
 159
 160 if ($errormessage) {
 161         &Header::openbox('100%', 'left', $Lang::tr{'error messages'});
 162         print "<font class='base'>$errormessage&nbsp;</font>\n";
 163         &Header::closebox();
 164 }
 165
 166 &Header::openbox('100%', 'left', "$Lang::tr{'settings'}:");
 167
 168 print "<form method='post' action=\"$ENV{'SCRIPT_NAME'}\">\n";
 169 print "<table width='100%'>\n";
 170         print "<tr>\n";
 171                 print "<td class='base' colspan='2'><b>$Lang::tr{'from'}:</b></td>\n";
 172         print "</tr>\n";
 173
 174         print "<tr>\n";
 175                 print "<td class='base'>$Lang::tr{'day'}:&nbsp\;\n";
 176                         &generate_select("FROM_DAY", "days");
 177                 print "</td>\n";
 178
 179                 print "<td class='base'>$Lang::tr{'month'}:&nbsp\;\n";
 180                         &generate_select("FROM_MONTH", "months");
 181                 print "</td>\n";
 182
 183                 print "<td class='base'>$Lang::tr{'year'}:&nbsp\;\n";
 184                         &generate_select("FROM_YEAR", "years");
 185                 print "</td>\n";
 186         print "</tr>\n";
 187
 188         print "<tr><td><br></td></tr>\n";
 189
 190         print "<tr>\n";
 191                 print "<td class='base' colspan='2'><b>$Lang::tr{'to'}:</b></td>\n";
 192         print "</tr>\n";
 193
 194         print "<tr>\n";
 195                 print "<td class='base'>$Lang::tr{'day'}:&nbsp\;\n";
 196                         &generate_select("TO_DAY", "days");
 197                 print "</td>\n";
 198
 199                 print "<td class='base'>$Lang::tr{'month'}:&nbsp\;\n";
 200                         &generate_select("TO_MONTH", "months");
 201                 print "</td>\n";
 202
 203                 print "<td class='base'>$Lang::tr{'year'}:&nbsp\;\n";
 204                         &generate_select("TO_YEAR", "years");
 205                 print "</td>\n";
 206         print "</tr>\n";
 207
 208         print "<tr><td><br></td></tr>\n";
 209
 210         print "<tr>\n";
 211                 print "<td class='base'>$Lang::tr{'ovpn connection name'}:</td>\n";
 212                 print "<td class='base' colspan='2'>\n";
 213
 214                         print "<select name='CONNECTION_NAME' size='1'>\n";
 215                                 print "<option value=''>$Lang::tr{'all'}</option>\n";
 216
 217                                 # Loop through all configured OpenVPN connections and sort them by name.
 218                                 foreach my $key (sort { $ovpnsettings{$a}[2] cmp $ovpnsettings{$b}[2] } keys %ovpnsettings) {
 219                                         my $connection_name = $ovpnsettings{$key}[2];
 220                                         my $selected;
 221
 222                                         # Skip all non roadwarrior connections.
 223                                         next unless ($ovpnsettings{"$key"}[3] eq "host");
 224
 225                                         # Check and mark the selected one.
 226                                         if ($connection_name eq "$cgiparams{'CONNECTION_NAME'}") {
 227                                                 $selected = "selected";
 228                                         }
 229
 230                                         print "<option value='$connection_name' $selected>$connection_name</option>\n";
 231                                 }
 232
 233                         print "</select>\n";
 234                 print "</td>\n";
 235         print "</tr>\n";
 236
 237         print "<tr>\n";
 238                 print "<td width='100%' align='right' colspan='3'><input type='submit' name='ACTION' value='$Lang::tr{'update'}'></td>\n";
 239         print "</tr>\n";
 240 print "</table>\n";
 241 print "</form>\n";
 242
 243 &Header::closebox();
 244
 245 &Header::openbox('100%', 'left', $Lang::tr{'log'});
 246
 247 my $lines = 0;
 248
 249 print "<table width='100%' class='tbl'>";
 250
 251 my $col = "bgcolor='$color{'color20'}'";
 252
 253         print "<tr>\n";
 254                 print "<td width='40%' $col><b>$Lang::tr{'ovpn connection name'}</b></td>\n";
 255
 256         if ($cgiparams{'CONNECTION_NAME'}) {
 257                 print "<td width='20%' $col><b>$Lang::tr{'connected'}</b></td>\n";
 258                 print "<td width='20%' $col><b>$Lang::tr{'disconnected'}</b></td>\n";
 259                 print "<td width='10%' $col><b>$Lang::tr{'recieved'}</b></td>\n";
 260                 print "<td width='10%' $col><b>$Lang::tr{'sent'}</b></td>\n";
 261         } else {
 262                 print "<td $col><b>$Lang::tr{'total connection time'}</b>\n";
 263         }
 264
 265         print "</tr>\n";
 266
 267 while(my @row = $statement_handle->fetchrow_array()) {
 268         # Assign some nice to read variable names for the DB fields.
 269         my $connection_name = $row[0];
 270         my $connection_open_time = $row[1];
 271         my $connection_close_time = $row[2];
 272         my $connection_bytes_recieved = &General::formatBytes($row[3]);
 273         my $connection_bytes_sent = &General::formatBytes($row[4]);
 274
 275         # Colorize columns.
 276         if ($lines % 2) {
 277                 $col="bgcolor='$color{'color20'}'";
 278         } else {
 279                 $col="bgcolor='$color{'color22'}'";
 280         }
 281
 282         print "<tr>\n";
 283                 print "<td width='40%' $col>$connection_name</td>\n";
 284
 285         if ($cgiparams{'CONNECTION_NAME'}) {
 286                 print "<td width='20%' $col>$connection_open_time</td>\n";
 287                 print "<td width='20%' $col>$connection_close_time</td>\n";
 288                 print "<td width='10%' $col>$connection_bytes_recieved</td>\n";
 289                 print "<td width='10%' $col>$connection_bytes_sent</td>\n";
 290         } else {
 291                 # Convert total connection time into human-readable format.
 292                 my $total_time = &General::format_time($row[1]);
 293
 294                 print "<td $col>$total_time</td>\n";
 295         }
 296
 297         print "</tr>\n";
 298
 299         # Increase lines count.
 300         $lines++;
 301 }
 302
 303 # If nothing has been fetched, the amount of lines is still zero.
 304 # In this case display a hint about no data.
 305 unless ($lines) {
 306         print "<tr><td bgcolor='$color{'color22'}' colspan='5' align='center'>$Lang::tr{'no entries'}</td></tr>\n";
 307 }
 308
 309 print "</table><br>\n";
 310
 311 &Header::closebox();
 312
 313 # Close database connection.
 314 $database_handle->disconnect();
 315
 316 &Header::closebigbox();
 317
 318 &Header::closepage();
 319
 320 #
 321 ## Function for easy select generation.
 322 #
 323 sub generate_select($$) {
 324         my ($name, $type) = @_;
 325
 326         my $start = 1;
 327         my $stop;
 328
 329         # Adjust start and stop by the given type.
 330         if ($type eq "days") {
 331                 $stop = 31;
 332         } elsif ($type eq "months") {
 333                 $stop = 12;
 334         } elsif ($type = "years") {
 335                 $stop = $year;
 336                 $start = $stop - 10;
 337         }
 338
 339         # Print select HTML tag.
 340         print "<select name='$name' size='1'>\n";
 341
 342         # Loop through the range.
 343         for ( my $i = $start; $i <= $stop; $i++) {
 344                 print "\t<option ";
 345
 346                 # Check and select the current processed item.
 347                 if ($i == $cgiparams{$name}) {
 348                         print 'selected="selected" ';
 349                 }
 350
 351                 # Check if months are processed and display the corresponding names.
 352                 if ($type eq "months") {
 353                         print "value='$i'>$monthhash{$i}</option>\n";
 354                 } else {
 355                         print "value='$i'>$i</option>\n";
 356                 }
 357         }
 358
 359         # Close select HTML tag.
 360         print "</select>\n\n";
 361 }