displaytable.pm
上传用户:wxp200602
上传日期:2007-10-30
资源大小:4028k
文件大小:17k
源码类别:

SNMP编程

开发平台:

Unix_Linux

  1. # displaytable(TABLENAME, CONFIG...):
  2. #
  3. #   stolen from sqltohtml in the ucd-snmp package
  4. #
  5. package NetSNMP::manager::displaytable;
  6. use POSIX (isprint);
  7. BEGIN {
  8.     use Exporter ();
  9.     use vars qw(@ISA @EXPORT_OK $tableparms $headerparms);
  10.     @ISA = qw(Exporter);
  11.     @EXPORT=qw(&displaytable &displaygraph);
  12.     require DBI;
  13.     require CGI;
  14.     use GD::Graph();
  15.     use GD::Graph::lines();
  16.     use GD::Graph::bars();
  17.     use GD::Graph::points();
  18.     use GD::Graph::linespoints();
  19.     use GD::Graph::area();
  20.     use GD::Graph::pie();
  21. };
  22. $tableparms="border=1 bgcolor="#c0c0e0"";
  23. $headerparms="border=1 bgcolor="#b0e0b0"";
  24. sub displaygraph {
  25.     my $dbh = shift;
  26.     my $tablename = shift;
  27.     my %config = @_;
  28.     my $type = $config{'-type'} || "lines";
  29.     my $x = $config{'-x'} || "640";
  30.     my $y = $config{'-y'} || "480";
  31.     my $bgcolor = $config{'-bgcolor'} || "white";
  32.     my $datecol = $config{'-xcol'} || "updated";
  33.     my $xtickevery = $config{'-xtickevery'} || 50;
  34.     my ($thetable);
  35. #    print STDERR join(",",@_),"n";
  36.     return -1 if (!defined($dbh) || !defined($tablename) || 
  37.   !defined ($config{'-columns'}) || 
  38.   ref($config{'-columns'}) ne "ARRAY" ||
  39.   !defined ($config{'-indexes'}) || 
  40.   ref($config{'-indexes'}) ne "ARRAY");
  41.     my $cmd = "SELECT " . 
  42. join(",",@{$config{'-columns'}},
  43.      @{$config{'-indexes'}}, $datecol) .
  44.  " FROM $tablename $config{'-clauses'}";
  45.     ( $thetable = $dbh->prepare($cmd))
  46. or return -1;
  47.     ( $thetable->execute )
  48. or return -1;
  49.     my %data;
  50.     my $count = 0;
  51.     while( $row = $thetable->fetchrow_hashref() ) {
  52. # XXX: multiple indexe columns -> unique name
  53. # save all the row's data based on the index column(s)
  54. foreach my $j (@{$config{'-columns'}}) {
  55.     if ($config{'-difference'} || $config{'-rate'}) {
  56. if (defined($lastval{$row->{$config{'-indexes'}[0]}}{$j}{'value'})) {
  57.     $data{$row->{$config{'-indexes'}[0]}}{$row->{$datecol}}{$j}=
  58. $row->{$j} - 
  59.     $lastval{$row->{$config{'-indexes'}[0]}}{$j}{'value'};
  60.     #
  61.     # convert to a rate if desired.
  62.     #
  63.     if ($config{'-rate'}) {
  64. if (($row->{$datecol} - $lastval{$row->{$config{'-indexes'}[0]}}{$j}{'index'})) {
  65.     $data{$row->{$config{'-indexes'}[0]}}{$row->{$datecol}}{$j} = $data{$row->{$config{'-indexes'}[0]}}{$row->{$datecol}}{$j}*$config{'-rate'}/($row->{$datecol} - $lastval{$row->{$config{'-indexes'}[0]}}{$j}{'index'});
  66. } else {
  67.     $data{$row->{$config{'-indexes'}[0]}}{$row->{$datecol}}{$j} = -1;
  68. }
  69.     }
  70. }
  71. $lastval{$row->{$config{'-indexes'}[0]}}{$j}{'value'} = $row->{$j};
  72. $lastval{$row->{$config{'-indexes'}[0]}}{$j}{'index'} = $row->{$datecol};
  73.     } else {
  74. $data{$row->{$config{'-indexes'}[0]}}{$row->{$datecol}}{$j} = $row->{$j};
  75.     }
  76.     #
  77.     # limit the data to a vertical range.
  78.     #
  79.     if (defined($config{'-max'}) && 
  80. $data{$row->{$config{'-indexes'}[0]}}{$row->{$datecol}}{$j} > 
  81. $config{'-max'}) {
  82. # set to max value
  83. $data{$row->{$config{'-indexes'}[0]}}{$row->{$datecol}}{$j} = 
  84.     $config{'-max'};
  85.     }
  86.     
  87.     if (defined($config{'-min'}) && 
  88. $data{$row->{$config{'-indexes'}[0]}}{$row->{$datecol}}{$j} < 
  89. $config{'-min'}) {
  90. # set to min value
  91. $data{$row->{$config{'-indexes'}[0]}}{$row->{$datecol}}{$j} = 
  92.     $config{'-min'};
  93.     }
  94. }
  95. push @xdata,$row->{$datecol};
  96.     }
  97.     my @pngdata;
  98.     if (defined($config{'-createdata'})) {
  99. &{$config{'-createdata'}}(@pngdata, @xdata, %data);
  100.     } else {
  101. push @pngdata, @xdata;
  102. my @datakeys = keys(%data);
  103. #    open(O,">/tmp/data");
  104. foreach my $i (@datakeys) {
  105.     foreach my $j (@{$config{'-columns'}}) {
  106. my @newrow;
  107. foreach my $k (@xdata) {
  108. # print O "i=$i k=$k j=$j :: $data{$i}{$k}{$j}n";
  109.     push @newrow, ($data{$i}{$k}{$j} || 0);
  110. }
  111. push @pngdata,@newrow;
  112.     }
  113. }
  114.     }
  115. #    close O;
  116.     if ($#pngdata > 0) {
  117.     # create the graph itself
  118. my $graph = new GD::Graph::lines($x, $y);
  119. $graph->set('bgclr' => $bgcolor);
  120. # print STDERR "columns: ", join(",",@{$config{'-columns'}}), "n";
  121.   if (defined($config{'-legend'})) {
  122. #      print STDERR "legend: ", join(",",@{$config{'-legend'}}), "n";
  123.       $graph->set_legend(@{$config{'-legend'}});
  124.   } else {
  125.       my @legend;
  126.       foreach my $xxx (@{$config{'-columns'}}) {
  127.   push @legend, "$xxx = $config{'-indexes'}[0]";
  128.       }
  129.       $graph->set_legend(@legend);
  130.   }
  131. foreach my $i (qw(title x_label_skip x_labels_vertical x_tick_number x_number_format y_number_format x_min_value x_max_value y_min_value y_max_value)) {
  132. #     print STDERR "setting $i from -$i = " . $config{"-$i"} . "n";
  133.     $graph->set("$i" => $config{"-$i"}) if ($config{"-$i"});
  134. }
  135. if ($config{'-pngparms'}) {
  136.     $graph->set(@{$config{'-pngparms'}});
  137. }
  138. print $graph->plot(@pngdata);
  139. return $#{$pngdata[0]};
  140.     }
  141.     return -1;
  142. }
  143. sub displaytable {
  144.     my $dbh = shift;
  145.     my $tablename = shift;
  146.     my %config = @_;
  147.     my $clauses = $config{'-clauses'};
  148.     my $dolink = $config{'-dolink'};
  149.     my $datalink = $config{'-datalink'};
  150.     my $beginhook = $config{'-beginhook'};
  151.     my $modifiedhook = $config{'-modifiedhook'};
  152.     my $endhook = $config{'-endhook'};
  153.     my $selectwhat = $config{'-select'};
  154. #    my $printonly = $config{'-printonly'};
  155.     $selectwhat = "*" if (!defined($selectwhat));
  156.     my $tableparms = $config{'-tableparms'} || $displaytable::tableparms;
  157.     my $headerparms = $config{'-headerparms'} || $displaytable::headerparms;
  158.     my ($thetable, $data, $ref, $prefs, $xlattable);
  159.     if ($config{'-dontdisplaycol'}) {
  160. ($prefs = $dbh->prepare($config{'-dontdisplaycol'}) )
  161.     or die "nnot ok: $DBI::errstrn";
  162.     }
  163.     # get a list of data from the table we want to display
  164.     ( $thetable = $dbh->prepare("SELECT $selectwhat FROM $tablename $clauses"))
  165. or return -1;
  166.     ( $thetable->execute )
  167. or return -1;
  168.     # get a list of data from the table we want to display
  169.     if ($config{'-xlat'}) {
  170. ( $xlattable = 
  171.  $dbh->prepare("SELECT newname FROM $config{'-xlat'} where oldname = ?"))
  172.     or die "nnot ok: $DBI::errstrn";
  173.     }
  174.     
  175.     # editable/markable setup
  176.     my $edited = 0;
  177.     my $editable = 0;
  178.     my $markable = 0;
  179.     my (@indexkeys, @valuekeys, $uph, %indexhash, $q);
  180.     if (defined($config{'-editable'})) {
  181. $editable = 1;
  182.     }
  183.     if (defined($config{'-mark'}) || defined($config{'-onmarked'})) {
  184. $markable = 1;
  185.     }
  186.     if (defined($config{'-CGI'}) && ref($config{'-CGI'}) eq "CGI") {
  187. $q = $config{'-CGI'};
  188.     }
  189.     if (($editable || $markable)) {
  190. if (ref($config{'-indexes'}) eq ARRAY && defined($q)) {
  191.     @indexkeys = @{$config{'-indexes'}};
  192.     foreach my $kk (@indexkeys) {
  193. $indexhash{$kk} = 1;
  194.     }
  195. } else {
  196.     $editable = $markable = 0;
  197.     print STDERR "displaytable error: no -indexes option specified or -CGI not specifiedn";
  198. }
  199.     }
  200.     if (($editable || $markable) && 
  201. $q->param('edited_' . toalpha($tablename))) {
  202. $edited = 1;
  203.     }
  204.     # table header
  205.     my $doheader = 1;
  206.     my @keys;
  207.     my $rowcount = 0;
  208.     $thetable->execute();
  209.     if ($editable || $markable) {
  210. print "<input type=hidden name="edited_" . toalpha($tablename) . "" value=1>n";
  211.     }
  212.     while( $data = $thetable->fetchrow_hashref() ) {
  213. $rowcount++;
  214. if ($edited && $editable && !defined($uph)) {
  215.     foreach my $kk (keys(%$data)) {
  216. push (@valuekeys, maybe_from_hex($kk)) if (!defined($indexhash{$kk}));
  217.     }
  218.     my $cmd = "update $tablename set " . 
  219. join(" = ?, ",@valuekeys) . 
  220.     " = ? where " . 
  221. join(" = ? and ",@indexkeys) .
  222.     " = ?";
  223.     $uph = $dbh->prepare($cmd);
  224. #     print STDERR "setting up: $cmd<br>n";
  225. }
  226. if ($doheader) {
  227.     if ($config{'-selectorder'} && 
  228.      ref($config{'-selectorder'}) eq "ARRAY") {
  229. @keys = @{$config{'-selectorder'}};
  230.     } elsif ($config{'-selectorder'}) {
  231. $_ = $selectwhat;
  232. @keys = split(/, */);
  233.     } else {
  234. @keys = (sort keys(%$data));
  235.     }
  236.     if (defined($config{'-title'})) {
  237. print "<br><b>$config{'-title'}</b>n";
  238.     } elsif (!defined($config{'-notitle'})) {
  239. print "<br><b>";
  240. print "<a href="$ref">" if (defined($dolink) && 
  241.       defined($ref = &$dolink($tablename)));
  242. if ($config{'-xlat'}) {
  243.     my $toval = $xlattable->execute($tablename);
  244.     if ($toval > 0) {
  245. print $xlattable->fetchrow_array;
  246.     } else {
  247. print "$tablename";
  248.     }
  249. } else {
  250.     print "$tablename";
  251. }
  252. print "</a>" if (defined($ref));
  253. print "</b>n";
  254.     }
  255.     print "<br>n";
  256.     print "<table $tableparms>n";
  257.     if (!$config{'-noheaders'}) {
  258. print "<tr $headerparms>";
  259.     }
  260.     if (defined($beginhook)) {
  261. &$beginhook($dbh, $tablename);
  262.     }
  263.     if (!$config{'-noheaders'}) {
  264. if ($markable) {
  265.     my $ukey = to_unique_key($key, $data, @indexkeys);
  266.     print "<td>Mark</td>n";
  267. }
  268. foreach $l (@keys) {
  269.     if (!defined($prefs) || 
  270. $prefs->execute($tablename, $l) eq "0E0") {
  271. print "<th>";
  272. print "<a href="$ref">" if (defined($dolink) && 
  273.       defined($ref = &$dolink($l)));
  274. if ($config{'-xlat'}) {
  275.     my $toval = $xlattable->execute($l);
  276.     if ($toval > 0) {
  277. print $xlattable->fetchrow_array;
  278.     } else {
  279. print "$l";
  280.     }
  281. } else {
  282.     print "$l";
  283. }
  284. print "</a>" if (defined($ref));
  285. print "</th>";
  286.     }
  287. }
  288.     }
  289.     if (defined($endhook)) {
  290. &$endhook($dbh, $tablename);
  291.     }
  292.     if (!$config{'-noheaders'}) {
  293. print "</tr>n";
  294.     }
  295.     $doheader = 0;
  296. }
  297. print "<tr>";
  298. if (defined($beginhook)) {
  299.     &$beginhook($dbh, $tablename, $data);
  300. }
  301. if ($edited && $editable) {
  302.     my @indexvalues = getvalues($data, @indexkeys);
  303.     if ($modifiedhook) {
  304. foreach my $valkey (@valuekeys) {
  305.     my ($value) = getquery($q, $data, @indexkeys, $valkey);
  306.     if ($value ne $data->{$valkey}) {
  307. &$modifiedhook($dbh, $tablename, $valkey, 
  308.        $data, @indexvalues);
  309.     }
  310. }
  311.     }
  312.     
  313.     my $ret = $uph->execute(getquery($q, $data, @indexkeys, @valuekeys), 
  314.     @indexvalues);
  315.     foreach my $x (@indexkeys) {
  316. next if (defined($indexhash{$x}));
  317. $data->{$x} = $q->param(to_unique_key($x, $data, @indexkeys));
  318.     }
  319. #     print "ret: $ret, $DBI::errstr<br>n";
  320. }
  321. if ($markable) {
  322.     my $ukey = to_unique_key("mark", $data, @indexkeys);
  323.     print "<td><input type=checkbox value=Y name="$ukey"" .
  324. (($q->param($ukey) eq "Y") ? " checked" : "") . "></td>n";
  325.     if ($q->param($ukey) eq "Y" && $config{'-onmarked'}) {
  326. &{$config{'-onmarked'}}($dbh, $tablename, $data);
  327.     }
  328. }
  329.     
  330. foreach $key (@keys) {
  331.     if (!defined($prefs) || 
  332. $prefs->execute($tablename, $key) eq "0E0") {
  333. print "<td>";
  334. print "<a href="$ref">" if (defined($datalink) && 
  335.       defined($ref = &$datalink($key, $data->{$key})));
  336. if ($editable && !defined($indexhash{$key})) {
  337.     my $ukey = to_unique_key($key, $data, @indexkeys);
  338.     my $sz;
  339.     if ($config{'-sizehash'}) {
  340. $sz = "size=" . $config{'-sizehash'}{$key};
  341.     }
  342.     if (!$sz && $config{'-inputsize'}) {
  343. $sz = "size=" . $config{'-inputsize'};
  344.     }
  345.     print STDERR "size $key: $sz from $config{'-sizehash'}{$key} / $config{'-inputsize'}n";
  346.     print "<input type=text name="$ukey" value="" . 
  347. maybe_to_hex($data->{$key}) . "" $sz>";
  348. } else {
  349.     if ($config{'-printer'}) {
  350. &{$config{'-printer'}}($key, $data->{$key}, $data);
  351.     } elsif ($data->{$key} ne "") {
  352. print $data->{$key};
  353.     } else {
  354. print "&nbsp";
  355.     }
  356. }
  357. print "</a>" if (defined($ref));
  358. print "</td>";
  359.     }
  360. }
  361. if (defined($endhook)) {
  362.     &$endhook($dbh, $tablename, $data);
  363. }
  364. print "</tr>n";
  365. last if (defined($config{'-maxrows'}) && 
  366.  $rowcount >= $config{'-maxrows'});
  367.     }
  368.     if ($rowcount > 0) {
  369. print "</table>n";
  370.     }
  371.     return $rowcount;
  372. }
  373. sub to_unique_key {
  374.     my $ret = shift;
  375.     $ret .= "_";
  376.     my $data = shift;
  377.     if (!defined($data)) {
  378. $ret .= join("_",@_);
  379.     } else {
  380. foreach my $i (@_) {
  381.     $ret .= "_" . $data->{$i};
  382. }
  383.     }
  384.     return toalpha($ret);
  385. }
  386. sub toalpha {
  387.     my $ret = join("",@_);
  388.     $ret =~ s/([^A-Za-z0-9_])/ord($1)/eg;
  389.     return $ret;
  390. }
  391. sub getvalues {
  392.     my $hash = shift;
  393.     my @ret;
  394.     foreach my $i (@_) {
  395. push @ret, maybe_from_hex($hash->{$i});
  396.     }
  397.     return @ret;
  398. }
  399. sub getquery {
  400.     my $q = shift;
  401.     my $data = shift;
  402.     my $keys = shift;
  403.     my @ret;
  404.     foreach my $i (@_) {
  405. push @ret, maybe_from_hex($q->param(to_unique_key($i, $data, @$keys)));
  406.     }
  407.     return @ret;
  408. }
  409. sub maybe_to_hex {
  410.     my $str = shift;
  411.     if (!isprint($str)) {
  412. $str = "0x" . (unpack("H*", $str))[0];
  413.     }
  414.     $str =~ s/"/&quot;/g;
  415.     return $str;
  416. }
  417. sub maybe_from_hex {
  418.     my $str = shift;
  419.     if (substr($str,0,2) eq "0x") {
  420. ($str) = pack("H*", substr($str,2));
  421.     }
  422.     return $str;
  423. }
  424. 1;
  425. __END__
  426. =head1 NAME
  427. SNMP - The Perl5 'SNMP' Extension Module v3.1.0 for the UCD SNMPv3 Library
  428. =head1 SYNOPSIS
  429.  use DBI;
  430.  use displaytable;
  431.  $dbh = DBI->connect(...);
  432.  $numshown = displaytable($dbh, 'tablename', [options]);
  433. =head1 DESCRIPTION
  434. The displaytable and displaygraph functions format the output of a DBI
  435. database query into an html or graph output.
  436. =head1 DISPLAYTABLE OPTIONS
  437. =over 4
  438. =item -select => VALUE
  439. Selects a set of columns, or functions to be displayed in the resulting table.
  440. Example: -select => 'column1, column2'
  441. Default: *
  442. =item -title => VALUE
  443. Use VALUE as the title of the table.
  444. =item -notitle => 1
  445. Don't print a title for the table.
  446. =item -noheaders => 1
  447. Don't print a header row at the top of the table.
  448. =item -selectorder => 1
  449. =item -selectorder => [qw(column1 column2)]
  450. Defines the order of the columns.  A value of 1 will use the order of
  451. the -select statement by textually parsing it's comma seperated list.
  452. If an array is passed containing the column names, that order will be
  453. used.
  454. Example: 
  455.   -select => distinct(column1) as foo, -selectorder => [qw(foo)]
  456. =item -maxrows => NUM
  457. Limits the number of display lines to NUM.
  458. =item -tableparms => PARAMS
  459. =item -headerparms => PARAMS
  460. The parameters to be used for formating the table contents and the
  461. header contents.
  462. Defaults:
  463.   -tableparms  => "border=1 bgcolor='#c0c0e0'"
  464.   -headerparms => "border=1 bgcolor='#b0e0b0'"
  465. =item -dolink => &FUNC
  466. If passed, FUNC(name) will be called on the tablename or header.  The
  467. function should return a web url that the header/table name should be
  468. linked to.
  469. =item -datalink => &FUNC
  470. Identical to -dolink, but called for the data portion of the table.
  471. Arguments are the column name and the data element for that column.
  472. =item -printer => &FUNC
  473. Calls FUNC(COLUMNNAME, COLUMNDATA, DATA) to print the data from each
  474. column.  COLUMNDATA is the data itself, and DATA is a reference to the
  475. hash for the entire row (IE, COLUMNDATA = $DATA->{$COLUMNNAME}).
  476. =item -beginhook => &FUNC
  477. =item -endhook => &FUNC
  478. displaytable will call these functions at the beginning and end of the
  479. printing of a row.  Useful for inserting new columns at the beginning
  480. or end of the table.  When the headers to the table are being printed,
  481. they will be called like FUNC($dbh, TABLENAME).  When the data is
  482. being printed, they will be called like FUNC($dbh, TABLENAME, DATA),
  483. which DATA is a reference to the hash containing the row data.
  484. Example: 
  485.   -endhook => sub { 
  486.       my ($d, $t, $data) = @_; 
  487.       if (defined($data)) { 
  488.   print "<td>",(100 * $data->{'column1'} / $data->{'column2'}),"</td>";
  489.       } else { 
  490.   print "<td>Percentage</td>"; 
  491.       } 
  492.   }
  493. =item -clauses => sql_clauses
  494. Adds clauses to the sql expression.
  495. Example: -clauses => "where column1 = 'value' limit 10 order by column2"
  496. =item -xlat => xlattable
  497. Translates column headers and the table name by looking in a table for
  498. the appropriate translation.  Essentially uses:
  499.   SELECT newname FROM xlattable where oldname = ?
  500. to translate everything.
  501. =item -editable => 1
  502. =item -indexes   => [qw(INDEX_COLUMNS)]
  503. =item -CGI      => CGI_REFERENCE
  504. If both of these are passed as arguments, the table is printed in
  505. editable format.  The INDEX_COLUMNS should be a list of columns that
  506. can be used to uniquely identify a row.  They will be the non-editable
  507. columns shown in the table.  Everything else will be editable.  The
  508. form and the submit button written by the rest of the script must loop
  509. back to the same displaytable clause for the edits to be committed to
  510. the database.  CGI_REFERENCE should be a reference to the CGI object
  511. used to query web parameters from ($CGI_REFERENCE = new CGI);
  512. =item -mark     => 1
  513. =item -indexes  => [qw(INDEX_COLUMNS)]
  514. =item -CGI      => CGI_REFERENCE
  515. =item -onmarked => &FUNC
  516. When the first three of these are specified, the left hand most column
  517. will be a check box that allows users to mark the row for future work.
  518. FUNC($dbh, TABLENAME, DATA) will be called for each marked entry when
  519. a submission data has been processed.  $DATA is a hash reference to
  520. the rows dataset.  See -editable above for more information.
  521. -onmarked => &FUNC implies -mark => 1.
  522. =back
  523. =head1 Author
  524. wjhardaker@ucdavis.edu
  525. =cut