torrus/perllib/Torrus/Renderer/HTML.pm

   1 #  Copyright (C) 2002  Stanislav Sinyagin
   2 #
   3 #  This program is free software; you can redistribute it and/or modify
   4 #  it under the terms of the GNU General Public License as published by
   5 #  the Free Software Foundation; either version 2 of the License, or
   6 #  (at your option) any later version.
   7 #
   8 #  This program is distributed in the hope that it will be useful,
   9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 #  GNU General Public License for more details.
  12 #
  13 #  You should have received a copy of the GNU General Public License
  14 #  along with this program; if not, write to the Free Software
  15 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  16
  17 # $Id: HTML.pm,v 1.7 2011-02-07 05:20:41 levinse Exp $
  18 # Stanislav Sinyagin <ssinyagin@yahoo.com>
  19
  20 package Torrus::Renderer::HTML;
  21
  22 use strict;
  23
  24 use Torrus::ConfigTree;
  25 use Torrus::Search;
  26 use Torrus::Log;
  27
  28 use URI::Escape;
  29 use Template;
  30 use POSIX qw(abs log floor pow);
  31 use Date::Parse;
  32 use Date::Format;
  33
  34 Torrus::SiteConfig::loadStyling();
  35
  36 # All our methods are imported by Torrus::Renderer;
  37
  38 sub render_html
  39 {
  40     my $self = shift;
  41     my $config_tree = shift;
  42     my $token = shift;
  43     my $view = shift;
  44     my $outfile = shift;
  45
  46     my $tmplfile = $config_tree->getParam($view, 'html-template');
  47
  48     my $expires = $config_tree->getParam($view, 'expires');
  49
  50     # Create the Template Toolkit processor once, and reuse
  51     # it in subsequent render() calls
  52
  53     if( not defined( $self->{'tt'} ) )
  54     {
  55         $self->{'tt'} =
  56             new Template(INCLUDE_PATH => $Torrus::Global::templateDirs,
  57                          TRIM => 1);
  58     }
  59     my $ttvars =
  60     {
  61         'treeName'   => $config_tree->treeName(),
  62         'token'      => $token,
  63         'view'       => $view,
  64         'expires'    => $expires,
  65         'path'       => sub { return $config_tree->path($_[0]); },
  66         'pathToken'  => sub { return $config_tree->token($_[0]); },
  67         'nodeExists' => sub { return $config_tree->nodeExists($_[0]); },
  68         'children'   => sub { return $config_tree->getChildren($_[0]); },
  69         'isLeaf'     => sub { return $config_tree->isLeaf($_[0]); },
  70         'isAlias'    => sub { return $config_tree->isAlias($_[0]); },
  71         'sortTokens' => sub { return $self->sortTokens($config_tree,
  72                                                        $_[0]); },
  73         'nodeName'   => sub { return $self->nodeName($config_tree, $_[0]); },
  74         'parent'     => sub { return $config_tree->getParent($_[0]); },
  75         'nodeParam'  => sub { return $config_tree->getNodeParam(@_); },
  76         'param'      => sub { return $config_tree->getParam(@_); },
  77         'url'        => sub { return $self->makeURL($config_tree, 0, @_); },
  78         'persistentUrl' => sub { return $self->makeURL($config_tree, 1, @_); },
  79         'clearVar'   => sub { delete $self->{'options'}{'variables'}{$_[0]};
  80                               return undef;},
  81         'plainURL'   => $Torrus::Renderer::plainURL,
  82         'splitUrls'  => sub { return $self->makeSplitURLs($config_tree,
  83                                                           $_[0], $_[1]); },
  84         'topURL'     => ($Torrus::Renderer::rendererURL ne '' ?
  85                          $Torrus::Renderer::rendererURL : '/'),
  86         'rrprint'    => sub { return $self->rrPrint($config_tree,
  87                                                     $_[0], $_[1]); },
  88         'scale'      => sub { return $self->scale($_[0], $_[1]); },
  89         'tsetMembers' => sub { $config_tree->tsetMembers($_[0]); },
  90         'tsetList'   => sub { $config_tree->getTsets(); },
  91         'style'      => sub { return $self->style($_[0]); },
  92         'companyName'=> $Torrus::Renderer::companyName,
  93         'companyLogo'=> $Torrus::Renderer::companyLogo,
  94         'companyURL' => $Torrus::Renderer::companyURL,
  95         'siteInfo'   => $Torrus::Renderer::siteInfo,
  96         'treeInfo'   => sub { return $Torrus::Global::treeConfig{
  97             $config_tree->treeName()}{'info'}; },
  98         'version'    => $Torrus::Global::version,
  99         'xmlnorm'    => \&Torrus::Renderer::xmlnormalize,
 100         'userAuth'   => $Torrus::CGI::authorizeUsers,
 101         'uid'        => $self->{'options'}->{'uid'},
 102         'userAttr'   => sub { return $self->userAttribute( $_[0] ) },
 103         'mayDisplayAdmInfo' => sub {
 104             return $self->may_display_adminfo( $config_tree, $_[0] ) },
 105         'adminfo' => $self->{'adminfo'},
 106         'mayDisplayReports' => sub {
 107             return $self->may_display_reports($config_tree) },
 108         'reportsUrl' => sub {
 109             return $self->reportsUrl($config_tree); },
 110         'timestamp'  => sub { return time2str($Torrus::Renderer::timeFormat,
 111                                               time()); },
 112         'verifyDate'  => sub { return verifyDate($_[0]); },
 113         'markup'     => sub{ return $self->translateMarkup( @_ ); },
 114         'searchEnabled' => $Torrus::Renderer::searchEnabled,
 115         'searchResults' => sub { return $self->doSearch($config_tree, $_[0]); },
 116
 117         #Freeside
 118         'freesideHeader' => sub { return $self->freesideHeader(@_); },
 119         'freesideFooter' => sub { return $self->freesideFooter(); },
 120         'freesideComponent' => sub { return $self->freesideComponent(@_); },
 121         'uri_escape'        => sub { return uri_escape(@_); },
 122         'matches'        => sub { return $_[0] =~ $_[1]; },
 123         'load_nms'       => sub { return $self->load_nms; },
 124         'get_serviceids'    => sub { my $nms = shift;
 125                                   my $router = shift;
 126                                   return $nms->get_router_serviceids($router);
 127                                 },
 128         'popup_link'     => sub {
 129                                    my $type = shift;
 130
 131                                    if($type eq 'nms-add_iface.html') {
 132                                        my $host = shift;
 133                                        my $iface = shift;
 134                                        my $nms = shift;
 135                                        my $serviceids = shift;
 136                                        my $svc_port = '';
 137
 138                                        $svc_port = $nms->find_svc($serviceids->{$iface})
 139                                             if($serviceids && $serviceids->{$iface});
 140
 141                                        if($svc_port) {
 142                                           my $url = $Torrus::Freeside::FSURL."/view/svc_port.cgi?".$svc_port->svcnum;
 143                                           return "<A HREF='$url'>View Service</A>";
 144                                         }
 145
 146                                         return
 147                                             $self->freesideComponent('/elements/popup_link.html',
 148                                                 'action' => "/freeside/misc/".
 149                                                         $type."?host=$host;iface=$iface",
 150                                                  'label' => 'Monitor for billing',
 151                                                  'actionlabel' => 'Monitor interface',
 152                                             );
 153                                    }
 154                                    elsif($type eq 'nms-add_router.html') {
 155                                         return
 156                                             $self->freesideComponent('/elements/popup_link.html',
 157                                                 'action' => "/freeside/misc/$type",
 158                                                  'label' => 'Add Router',
 159                                                  'actionlabel' => 'Add Router',
 160                                             );
 161                                    }
 162
 163                                    '';
 164                                 },
 165
 166     };
 167
 168
 169     # Pass the options from Torrus::Renderer::render() to Template
 170     while( my( $opt, $val ) = each( %{$self->{'options'}} ) )
 171     {
 172         $ttvars->{$opt} = $val;
 173     }
 174
 175     my $result = $self->{'tt'}->process( $tmplfile, $ttvars, $outfile );
 176
 177     undef $ttvars;
 178
 179     if( not $result )
 180     {
 181         if( $config_tree->isTset( $token ) )
 182         {
 183             Error("Error while rendering tokenset $token: " .
 184                   $self->{'tt'}->error());
 185         }
 186         else
 187         {
 188             my $path = $config_tree->path($token);
 189             Error("Error while rendering $path: " .
 190                   $self->{'tt'}->error());
 191         }
 192         return undef;
 193     }
 194
 195     return ($expires+time(), 'text/html; charset=UTF-8');
 196 }
 197
 198
 199 sub nodeName
 200 {
 201     my $self = shift;
 202     my $config_tree = shift;
 203     my $token = shift;
 204
 205     my $n = $config_tree->getNodeParam($token, 'node-display-name', 1);
 206     if( defined( $n ) and length( $n ) > 0 )
 207     {
 208         return $n;
 209     }
 210
 211     return $config_tree->nodeName($config_tree->path($token));
 212 }
 213
 214
 215 sub sortTokens
 216 {
 217     my $self = shift;
 218     my $config_tree = shift;
 219     my $tokenlist = shift;
 220
 221     my @sorted = ();
 222     if( ref($tokenlist) and scalar(@{$tokenlist}) > 0 )
 223     {
 224         @sorted = sort
 225         {
 226             my $p_a = $config_tree->getNodeParam($a, 'precedence', 1);
 227             $p_a = 0 unless defined $p_a;
 228             my $p_b = $config_tree->getNodeParam($b, 'precedence', 1);
 229             $p_b = 0 unless defined $p_b;
 230             if( $p_a == $p_b )
 231             {
 232                 my $n_a = $config_tree->path($a);
 233                 my $n_b = $config_tree->path($b);
 234                 return $n_a cmp $n_b;
 235             }
 236             else
 237             {
 238                 return $p_b <=> $p_a;
 239             }
 240         } @{$tokenlist};
 241     }
 242     else
 243     {
 244         push(@sorted, $tokenlist);
 245     }
 246     return @sorted;
 247 }
 248
 249
 250 # compose an URL for a node.
 251 # $persistent defines if the link should be persistent
 252 # Persistent link is done with nodeid if available, or with path
 253
 254 sub makeURL
 255 {
 256     my $self = shift;
 257     my $config_tree = shift;
 258     my $persistent = shift;
 259     my $token = shift;
 260     my $view = shift;
 261     my @add_vars = @_;
 262
 263     my $ret = $Torrus::Renderer::rendererURL . '/' . $config_tree->treeName();
 264
 265     if( $persistent )
 266     {
 267         my $nodeid = $config_tree->getNodeParam($token, 'nodeid', 1);
 268         if( defined( $nodeid ) )
 269         {
 270             $ret .= '?nodeid=' .
 271                 uri_escape($nodeid, $Torrus::Renderer::uriEscapeExceptions);
 272         }
 273         else
 274         {
 275             $ret .= '?path=' .
 276                 uri_escape($config_tree->path($token),
 277                            $Torrus::Renderer::uriEscapeExceptions);
 278         }
 279     }
 280     else
 281     {
 282         $ret .= '?token=' . uri_escape($token);
 283     }
 284
 285     if( $view )
 286     {
 287         $ret .= '&amp;view=' . uri_escape($view);
 288     }
 289
 290     my %vars = ();
 291     # This could be array or a reference to array
 292     my $add_vars_size = scalar( @add_vars );
 293     if( $add_vars_size == 1 and ref( $add_vars[0] ) )
 294     {
 295         %vars = @{$add_vars[0]};
 296     }
 297     elsif( $add_vars_size > 0 and ($add_vars_size % 2 == 0) )
 298     {
 299         %vars = @add_vars;
 300     }
 301
 302     if( ref( $self->{'options'}->{'variables'} ) )
 303     {
 304         foreach my $name ( sort keys %{$self->{'options'}->{'variables'}} )
 305         {
 306             my $val = $self->{'options'}->{'variables'}->{$name};
 307             if( not defined( $vars{$name} ) )
 308             {
 309                 $vars{$name} = $val;
 310             }
 311         }
 312     }
 313
 314     foreach my $name ( sort keys %vars )
 315     {
 316         if( $vars{$name} ne '' )
 317         {
 318             $ret .= '&amp;' . $name . '=' .
 319                 uri_escape( $vars{$name},
 320                             $Torrus::Renderer::uriEscapeExceptions );
 321         }
 322     }
 323
 324     return $ret;
 325 }
 326
 327 sub makeSplitURLs
 328 {
 329     my $self = shift;
 330     my $config_tree = shift;
 331     my $token = shift;
 332     my $view = shift;
 333
 334     my $ret = '';
 335     while( defined( $token ) )
 336     {
 337         my $path = $config_tree->path($token);
 338
 339         my $str = '<SPAN CLASS="PathElement">';
 340         $str .=
 341             sprintf('<A HREF="%s">%s%s</A>',
 342                     $self->makeURL($config_tree, 0, $token, $view),
 343                     $config_tree->nodeName($path),
 344                     ( $config_tree->isSubtree($token) and
 345                       $path ne '/') ? '/':'' );
 346         $str .= "</SPAN>\n";
 347
 348         $ret = $str . $ret;
 349
 350         $token = $config_tree->getParent( $token );
 351     }
 352
 353     return $ret;
 354 }
 355
 356
 357 sub rrPrint
 358 {
 359     my $self = shift;
 360     my $config_tree = shift;
 361     my $token = shift;
 362     my $view = shift;
 363
 364     my @ret = ();
 365     my($fname, $mimetype) = $self->render( $config_tree, $token, $view );
 366
 367     if( $mimetype ne 'text/plain' )
 368     {
 369         Error("View $view does not produce text/plain for token $token");
 370     }
 371     else
 372     {
 373         if( not open(IN, $fname) )
 374         {
 375             Error("Cannot open $fname for reading: $!");
 376         }
 377         else
 378         {
 379             chomp(my $values = <IN>);
 380             @ret = split(':', $values);
 381             close IN;
 382         }
 383     }
 384     return @ret;
 385 }
 386
 387 # This subroutine is taken from Dave Plonka's Flowscan
 388
 389 sub scale
 390 {
 391     my $self = shift;
 392     # This is based somewhat on Tobi Oetiker's code in rrd_graph.c:
 393     my $fmt = shift;
 394     my $value = shift;
 395     my @symbols = ("a", # 10e-18 Ato
 396                    "f", # 10e-15 Femto
 397                    "p", # 10e-12 Pico
 398                    "n", # 10e-9  Nano
 399                    "u", # 10e-6  Micro
 400                    "m", # 10e-3  Milli
 401                    " ", # Base
 402                    "k", # 10e3   Kilo
 403                    "M", # 10e6   Mega
 404                    "G", # 10e9   Giga
 405                    "T", # 10e12  Terra
 406                    "P", # 10e15  Peta
 407                    "E"); # 10e18  Exa
 408
 409     my $symbcenter = 6;
 410     my $digits = (0 == $value)? 0 : floor(log(abs($value))/log(1000));
 411     return sprintf( $fmt . " %s", $value/pow(1000, $digits),
 412                     $symbols[ $symbcenter+$digits ] );
 413 }
 414
 415 sub style
 416 {
 417     my $self = shift;
 418     my $object = shift;
 419
 420     my $media;
 421     if( not defined( $media = $self->{'options'}->{'variables'}->{'MEDIA'} ) )
 422     {
 423         $media = 'default';
 424     }
 425     return  $Torrus::Renderer::styling{$media}{$object};
 426 }
 427
 428
 429
 430 sub userAttribute
 431 {
 432     my $self = shift;
 433     my $attr = shift;
 434
 435     if( $self->{'options'}->{'uid'} and $self->{'options'}->{'acl'} )
 436     {
 437         $self->{'options'}->{'acl'}->
 438             userAttribute( $self->{'options'}->{'uid'}, $attr );
 439     }
 440     else
 441     {
 442         return '';
 443     }
 444 }
 445
 446 sub hasPrivilege
 447 {
 448     my $self = shift;
 449     my $object = shift;
 450     my $privilege = shift;
 451
 452     if( $self->{'options'}->{'uid'} and $self->{'options'}->{'acl'} )
 453     {
 454         $self->{'options'}->{'acl'}->
 455             hasPrivilege( $self->{'options'}->{'uid'}, $object, $privilege );
 456     }
 457     else
 458     {
 459         return undef;
 460     }
 461 }
 462
 463
 464 sub translateMarkup
 465 {
 466     my $self = shift;
 467     my @strings = @_;
 468
 469     my $tt = new Template( TRIM => 1 );
 470
 471     my $ttvars =
 472     {
 473         'em'      =>  sub { return '<em>' . $_[0] . '</em>'; },
 474         'strong'  =>  sub { return '<strong>' . $_[0] . '</strong>'; }
 475     };
 476
 477     my $ret = '';
 478
 479     foreach my $str ( @strings )
 480     {
 481         my $output = '';
 482         my $result = $tt->process( \$str, $ttvars, \$output );
 483
 484         if( not $result )
 485         {
 486             Error('Error translating markup: ' . $tt->error());
 487         }
 488         else
 489         {
 490             $ret .= $output;
 491         }
 492     }
 493
 494     undef $tt;
 495
 496     return $ret;
 497 }
 498
 499
 500 sub verifyDate
 501 {
 502     my $input = shift;
 503
 504     my $time = str2time( $input );
 505     # rrdtool does not understand dates prior to 1980 (315529200)
 506     if( defined( $time ) and $time > 315529200 )
 507     {
 508         # Present the time in format understood by rrdtool
 509         return time2str('%H:%M %Y%m%d', $time);
 510     }
 511     else
 512     {
 513         return '';
 514     }
 515 }
 516
 517
 518 sub may_display_reports
 519 {
 520     my $self = shift;
 521     my $config_tree = shift;
 522
 523     if( $Torrus::Renderer::displayReports )
 524     {
 525         if( not $Torrus::CGI::authorizeUsers )
 526         {
 527             return 1;
 528         }
 529
 530         my $tree = $config_tree->treeName();
 531         if( $self->hasPrivilege( $tree, 'DisplayReports' ) and
 532             -r $Torrus::Global::reportsDir . '/' . $tree .
 533             '/html/index.html' )
 534         {
 535             return 1;
 536         }
 537     }
 538     return 0;
 539 }
 540
 541
 542 sub reportsUrl
 543 {
 544     my $self = shift;
 545     my $config_tree = shift;
 546
 547     return $Torrus::Renderer::rendererURL . '/' .
 548         $config_tree->treeName() . '?htmlreport=index.html';
 549 }
 550
 551
 552 sub doSearch
 553 {
 554     my $self = shift;
 555     my $config_tree = shift;
 556     my $string = shift;
 557
 558
 559     my $tree = $config_tree->treeName();
 560
 561     my $sr = new Torrus::Search;
 562     $sr->openTree( $tree );
 563     my $result = $sr->searchPrefix( $string, $tree );
 564     $sr->closeTree( $tree );
 565
 566     my $ret = [];
 567     push( @{$ret}, sort {$a->[0] cmp $b->[0]} @{$result} );
 568
 569     return $ret;
 570 }
 571
 572
 573 1;
 574
 575
 576 # Local Variables:
 577 # mode: perl
 578 # indent-tabs-mode: nil
 579 # perl-indent-level: 4
 580 # End: