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.8 2011-02-10 01:08:44 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         'slash2underscore' => sub { $_[0] =~ s/\//_/g; return $_[0]; },
 124         'load_nms'       => sub { return $self->load_nms; },
 125         'get_serviceids'    => sub { my $nms = shift;
 126                                   my $router = shift;
 127                                   return $nms->get_router_serviceids($router);
 128                                 },
 129         'popup_link'     => sub {
 130                                    my $type = shift;
 131
 132                                    if($type eq 'nms-add_iface.html') {
 133                                        my $host = shift;
 134                                        my $iface = shift;
 135                                        my $nms = shift;
 136                                        my $serviceids = shift;
 137                                        my $svc_port = '';
 138
 139                                        $svc_port = $nms->find_svc($serviceids->{$iface})
 140                                             if($serviceids && $serviceids->{$iface});
 141
 142                                        if($svc_port) {
 143                                           my $url = $Torrus::Freeside::FSURL."/view/svc_port.cgi?".$svc_port->svcnum;
 144                                           return "<A HREF='$url'>View Service</A>";
 145                                         }
 146
 147                                         return
 148                                             $self->freesideComponent('/elements/popup_link.html',
 149                                                 'action' => "/freeside/misc/".
 150                                                         $type."?host=$host;iface=$iface",
 151                                                  'label' => 'Monitor for billing',
 152                                                  'actionlabel' => 'Monitor interface',
 153                                             );
 154                                    }
 155                                    elsif($type eq 'nms-add_router.html') {
 156                                         return
 157                                             $self->freesideComponent('/elements/popup_link.html',
 158                                                 'action' => "/freeside/misc/$type",
 159                                                  'label' => 'Add Router',
 160                                                  'actionlabel' => 'Add Router',
 161                                             );
 162                                    }
 163
 164                                    '';
 165                                 },
 166
 167     };
 168
 169
 170     # Pass the options from Torrus::Renderer::render() to Template
 171     while( my( $opt, $val ) = each( %{$self->{'options'}} ) )
 172     {
 173         $ttvars->{$opt} = $val;
 174     }
 175
 176     my $result = $self->{'tt'}->process( $tmplfile, $ttvars, $outfile );
 177
 178     undef $ttvars;
 179
 180     if( not $result )
 181     {
 182         if( $config_tree->isTset( $token ) )
 183         {
 184             Error("Error while rendering tokenset $token: " .
 185                   $self->{'tt'}->error());
 186         }
 187         else
 188         {
 189             my $path = $config_tree->path($token);
 190             Error("Error while rendering $path: " .
 191                   $self->{'tt'}->error());
 192         }
 193         return undef;
 194     }
 195
 196     return ($expires+time(), 'text/html; charset=UTF-8');
 197 }
 198
 199
 200 sub nodeName
 201 {
 202     my $self = shift;
 203     my $config_tree = shift;
 204     my $token = shift;
 205
 206     my $n = $config_tree->getNodeParam($token, 'node-display-name', 1);
 207     if( defined( $n ) and length( $n ) > 0 )
 208     {
 209         return $n;
 210     }
 211
 212     return $config_tree->nodeName($config_tree->path($token));
 213 }
 214
 215
 216 sub sortTokens
 217 {
 218     my $self = shift;
 219     my $config_tree = shift;
 220     my $tokenlist = shift;
 221
 222     my @sorted = ();
 223     if( ref($tokenlist) and scalar(@{$tokenlist}) > 0 )
 224     {
 225         @sorted = sort
 226         {
 227             my $p_a = $config_tree->getNodeParam($a, 'precedence', 1);
 228             $p_a = 0 unless defined $p_a;
 229             my $p_b = $config_tree->getNodeParam($b, 'precedence', 1);
 230             $p_b = 0 unless defined $p_b;
 231             if( $p_a == $p_b )
 232             {
 233                 my $n_a = $config_tree->path($a);
 234                 my $n_b = $config_tree->path($b);
 235                 return $n_a cmp $n_b;
 236             }
 237             else
 238             {
 239                 return $p_b <=> $p_a;
 240             }
 241         } @{$tokenlist};
 242     }
 243     else
 244     {
 245         push(@sorted, $tokenlist);
 246     }
 247     return @sorted;
 248 }
 249
 250
 251 # compose an URL for a node.
 252 # $persistent defines if the link should be persistent
 253 # Persistent link is done with nodeid if available, or with path
 254
 255 sub makeURL
 256 {
 257     my $self = shift;
 258     my $config_tree = shift;
 259     my $persistent = shift;
 260     my $token = shift;
 261     my $view = shift;
 262     my @add_vars = @_;
 263
 264     my $ret = $Torrus::Renderer::rendererURL . '/' . $config_tree->treeName();
 265
 266     if( $persistent )
 267     {
 268         my $nodeid = $config_tree->getNodeParam($token, 'nodeid', 1);
 269         if( defined( $nodeid ) )
 270         {
 271             $ret .= '?nodeid=' .
 272                 uri_escape($nodeid, $Torrus::Renderer::uriEscapeExceptions);
 273         }
 274         else
 275         {
 276             $ret .= '?path=' .
 277                 uri_escape($config_tree->path($token),
 278                            $Torrus::Renderer::uriEscapeExceptions);
 279         }
 280     }
 281     else
 282     {
 283         $ret .= '?token=' . uri_escape($token);
 284     }
 285
 286     if( $view )
 287     {
 288         $ret .= '&amp;view=' . uri_escape($view);
 289     }
 290
 291     my %vars = ();
 292     # This could be array or a reference to array
 293     my $add_vars_size = scalar( @add_vars );
 294     if( $add_vars_size == 1 and ref( $add_vars[0] ) )
 295     {
 296         %vars = @{$add_vars[0]};
 297     }
 298     elsif( $add_vars_size > 0 and ($add_vars_size % 2 == 0) )
 299     {
 300         %vars = @add_vars;
 301     }
 302
 303     if( ref( $self->{'options'}->{'variables'} ) )
 304     {
 305         foreach my $name ( sort keys %{$self->{'options'}->{'variables'}} )
 306         {
 307             my $val = $self->{'options'}->{'variables'}->{$name};
 308             if( not defined( $vars{$name} ) )
 309             {
 310                 $vars{$name} = $val;
 311             }
 312         }
 313     }
 314
 315     foreach my $name ( sort keys %vars )
 316     {
 317         if( $vars{$name} ne '' )
 318         {
 319             $ret .= '&amp;' . $name . '=' .
 320                 uri_escape( $vars{$name},
 321                             $Torrus::Renderer::uriEscapeExceptions );
 322         }
 323     }
 324
 325     return $ret;
 326 }
 327
 328 sub makeSplitURLs
 329 {
 330     my $self = shift;
 331     my $config_tree = shift;
 332     my $token = shift;
 333     my $view = shift;
 334
 335     my $ret = '';
 336     while( defined( $token ) )
 337     {
 338         my $path = $config_tree->path($token);
 339
 340         my $str = '<SPAN CLASS="PathElement">';
 341         $str .=
 342             sprintf('<A HREF="%s">%s%s</A>',
 343                     $self->makeURL($config_tree, 0, $token, $view),
 344                     $config_tree->nodeName($path),
 345                     ( $config_tree->isSubtree($token) and
 346                       $path ne '/') ? '/':'' );
 347         $str .= "</SPAN>\n";
 348
 349         $ret = $str . $ret;
 350
 351         $token = $config_tree->getParent( $token );
 352     }
 353
 354     return $ret;
 355 }
 356
 357
 358 sub rrPrint
 359 {
 360     my $self = shift;
 361     my $config_tree = shift;
 362     my $token = shift;
 363     my $view = shift;
 364
 365     my @ret = ();
 366     my($fname, $mimetype) = $self->render( $config_tree, $token, $view );
 367
 368     if( $mimetype ne 'text/plain' )
 369     {
 370         Error("View $view does not produce text/plain for token $token");
 371     }
 372     else
 373     {
 374         if( not open(IN, $fname) )
 375         {
 376             Error("Cannot open $fname for reading: $!");
 377         }
 378         else
 379         {
 380             chomp(my $values = <IN>);
 381             @ret = split(':', $values);
 382             close IN;
 383         }
 384     }
 385     return @ret;
 386 }
 387
 388 # This subroutine is taken from Dave Plonka's Flowscan
 389
 390 sub scale
 391 {
 392     my $self = shift;
 393     # This is based somewhat on Tobi Oetiker's code in rrd_graph.c:
 394     my $fmt = shift;
 395     my $value = shift;
 396     my @symbols = ("a", # 10e-18 Ato
 397                    "f", # 10e-15 Femto
 398                    "p", # 10e-12 Pico
 399                    "n", # 10e-9  Nano
 400                    "u", # 10e-6  Micro
 401                    "m", # 10e-3  Milli
 402                    " ", # Base
 403                    "k", # 10e3   Kilo
 404                    "M", # 10e6   Mega
 405                    "G", # 10e9   Giga
 406                    "T", # 10e12  Terra
 407                    "P", # 10e15  Peta
 408                    "E"); # 10e18  Exa
 409
 410     my $symbcenter = 6;
 411     my $digits = (0 == $value)? 0 : floor(log(abs($value))/log(1000));
 412     return sprintf( $fmt . " %s", $value/pow(1000, $digits),
 413                     $symbols[ $symbcenter+$digits ] );
 414 }
 415
 416 sub style
 417 {
 418     my $self = shift;
 419     my $object = shift;
 420
 421     my $media;
 422     if( not defined( $media = $self->{'options'}->{'variables'}->{'MEDIA'} ) )
 423     {
 424         $media = 'default';
 425     }
 426     return  $Torrus::Renderer::styling{$media}{$object};
 427 }
 428
 429
 430
 431 sub userAttribute
 432 {
 433     my $self = shift;
 434     my $attr = shift;
 435
 436     if( $self->{'options'}->{'uid'} and $self->{'options'}->{'acl'} )
 437     {
 438         $self->{'options'}->{'acl'}->
 439             userAttribute( $self->{'options'}->{'uid'}, $attr );
 440     }
 441     else
 442     {
 443         return '';
 444     }
 445 }
 446
 447 sub hasPrivilege
 448 {
 449     my $self = shift;
 450     my $object = shift;
 451     my $privilege = shift;
 452
 453     if( $self->{'options'}->{'uid'} and $self->{'options'}->{'acl'} )
 454     {
 455         $self->{'options'}->{'acl'}->
 456             hasPrivilege( $self->{'options'}->{'uid'}, $object, $privilege );
 457     }
 458     else
 459     {
 460         return undef;
 461     }
 462 }
 463
 464
 465 sub translateMarkup
 466 {
 467     my $self = shift;
 468     my @strings = @_;
 469
 470     my $tt = new Template( TRIM => 1 );
 471
 472     my $ttvars =
 473     {
 474         'em'      =>  sub { return '<em>' . $_[0] . '</em>'; },
 475         'strong'  =>  sub { return '<strong>' . $_[0] . '</strong>'; }
 476     };
 477
 478     my $ret = '';
 479
 480     foreach my $str ( @strings )
 481     {
 482         my $output = '';
 483         my $result = $tt->process( \$str, $ttvars, \$output );
 484
 485         if( not $result )
 486         {
 487             Error('Error translating markup: ' . $tt->error());
 488         }
 489         else
 490         {
 491             $ret .= $output;
 492         }
 493     }
 494
 495     undef $tt;
 496
 497     return $ret;
 498 }
 499
 500
 501 sub verifyDate
 502 {
 503     my $input = shift;
 504
 505     my $time = str2time( $input );
 506     # rrdtool does not understand dates prior to 1980 (315529200)
 507     if( defined( $time ) and $time > 315529200 )
 508     {
 509         # Present the time in format understood by rrdtool
 510         return time2str('%H:%M %Y%m%d', $time);
 511     }
 512     else
 513     {
 514         return '';
 515     }
 516 }
 517
 518
 519 sub may_display_reports
 520 {
 521     my $self = shift;
 522     my $config_tree = shift;
 523
 524     if( $Torrus::Renderer::displayReports )
 525     {
 526         if( not $Torrus::CGI::authorizeUsers )
 527         {
 528             return 1;
 529         }
 530
 531         my $tree = $config_tree->treeName();
 532         if( $self->hasPrivilege( $tree, 'DisplayReports' ) and
 533             -r $Torrus::Global::reportsDir . '/' . $tree .
 534             '/html/index.html' )
 535         {
 536             return 1;
 537         }
 538     }
 539     return 0;
 540 }
 541
 542
 543 sub reportsUrl
 544 {
 545     my $self = shift;
 546     my $config_tree = shift;
 547
 548     return $Torrus::Renderer::rendererURL . '/' .
 549         $config_tree->treeName() . '?htmlreport=index.html';
 550 }
 551
 552
 553 sub doSearch
 554 {
 555     my $self = shift;
 556     my $config_tree = shift;
 557     my $string = shift;
 558
 559
 560     my $tree = $config_tree->treeName();
 561
 562     my $sr = new Torrus::Search;
 563     $sr->openTree( $tree );
 564     my $result = $sr->searchPrefix( $string, $tree );
 565     $sr->closeTree( $tree );
 566
 567     my $ret = [];
 568     push( @{$ret}, sort {$a->[0] cmp $b->[0]} @{$result} );
 569
 570     return $ret;
 571 }
 572
 573
 574 1;
 575
 576
 577 # Local Variables:
 578 # mode: perl
 579 # indent-tabs-mode: nil
 580 # perl-indent-level: 4
 581 # End: