1 #============================================================= -*-perl-*-
3 # BackupPC::CGI::Lib package
7 # This library defines a BackupPC::Lib class and a variety of utility
8 # functions used by BackupPC.
11 # Craig Barratt <cbarratt@users.sourceforge.net>
14 # Copyright (C) 2003-2009 Craig Barratt
16 # This program is free software; you can redistribute it and/or modify
17 # it under the terms of the GNU General Public License as published by
18 # the Free Software Foundation; either version 2 of the License, or
19 # (at your option) any later version.
21 # This program is distributed in the hope that it will be useful,
22 # but WITHOUT ANY WARRANTY; without even the implied warranty of
23 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 # GNU General Public License for more details.
26 # You should have received a copy of the GNU General Public License
27 # along with this program; if not, write to the Free Software
28 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 #========================================================================
32 # Version 3.2.0, released 31 Jul 2010.
34 # See http://backuppc.sourceforge.net.
36 #========================================================================
38 package BackupPC::CGI::Lib;
45 use vars qw( @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS );
47 use vars qw($Cgi %In $MyURL $User %Conf $TopDir $LogDir $BinDir $bpc);
48 use vars qw(%Status %Info %Jobs @BgQueue @UserQueue @CmdQueue
49 %QueueLen %StatusHost);
50 use vars qw($Hosts $HostsMTime $ConfigMTime $PrivAdmin);
51 use vars qw(%UserEmailInfo $UserEmailInfoMTime %RestoreReq %ArchiveReq);
79 $Cgi %In $MyURL $User %Conf $TopDir $LogDir $BinDir $bpc
80 %Status %Info %Jobs @BgQueue @UserQueue @CmdQueue
82 $Hosts $HostsMTime $ConfigMTime $PrivAdmin
83 %UserEmailInfo $UserEmailInfoMTime %RestoreReq %ArchiveReq
88 'all' => [ @EXPORT_OK ],
96 if ( !defined($bpc) ) {
97 ErrorExit($Lang->{BackupPC__Lib__new_failed__check_apache_error_log})
98 if ( !($bpc = BackupPC::Lib->new(undef, undef, undef, 1)) );
99 $TopDir = $bpc->TopDir();
100 $LogDir = $bpc->LogDir();
101 $BinDir = $bpc->BinDir();
102 %Conf = $bpc->Conf();
103 $Lang = $bpc->Lang();
104 $ConfigMTime = $bpc->ConfigMTime();
105 umask($Conf{UmaskMode});
106 } elsif ( $bpc->ConfigMTime() != $ConfigMTime ) {
108 $TopDir = $bpc->TopDir();
109 $LogDir = $bpc->LogDir();
110 $BinDir = $bpc->BinDir();
111 %Conf = $bpc->Conf();
112 $Lang = $bpc->Lang();
113 $ConfigMTime = $bpc->ConfigMTime();
114 umask($Conf{UmaskMode});
118 # Default REMOTE_USER so in a miminal installation the user
119 # has a sensible default.
121 $ENV{REMOTE_USER} = $Conf{BackupPCUser} if ( $ENV{REMOTE_USER} eq "" );
124 # We require that Apache pass in $ENV{SCRIPT_NAME} and $ENV{REMOTE_USER}.
125 # The latter requires .ht_access style authentication. Replace this
126 # code if you are using some other type of authentication, and have
127 # a different way of getting the user name.
129 $MyURL = $ENV{SCRIPT_NAME};
130 $User = $ENV{REMOTE_USER};
133 # Handle LDAP uid=user when using mod_authz_ldap and otherwise untaint
135 $User = $1 if ( $User =~ /uid=([^,]+)/i || $User =~ /(.*)/ );
138 # Clean up %ENV for taint checking
140 delete @ENV{qw(IFS CDPATH ENV BASH_ENV)};
141 $ENV{PATH} = $Conf{MyPath};
144 # Verify we are running as the correct user
146 if ( $Conf{BackupPCUserVerify}
147 && $> != (my $uid = (getpwnam($Conf{BackupPCUser}))[2]) ) {
148 ErrorExit(eval("qq{$Lang->{Wrong_user__my_userid_is___}}"), <<EOF);
149 This script needs to run as the user specified in \$Conf{BackupPCUser},
150 which is set to $Conf{BackupPCUser}.
152 This is an installation problem. If you are using mod_perl then
153 it appears that Apache is not running as user $Conf{BackupPCUser}.
154 If you are not using mod_perl, then most like setuid is not working
155 properly on BackupPC_Admin. Check the permissions on
156 $Conf{CgiDir}/BackupPC_Admin and look at the documentation.
160 if ( !defined($Hosts) || $bpc->HostsMTime() != $HostsMTime ) {
161 $HostsMTime = $bpc->HostsMTime();
162 $Hosts = $bpc->HostInfoRead();
164 # turn moreUsers list into a hash for quick lookups
165 foreach my $host (keys %$Hosts) {
166 $Hosts->{$host}{moreUsers} =
167 {map {$_, 1} split(",", $Hosts->{$host}{moreUsers}) }
172 # Untaint the host name
174 if ( $In{host} =~ /^([\w.\s-]+)$/ ) {
183 my($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst)
184 = localtime($_[0] == 0 ? time : $_[0] );
186 if ( $Conf{CgiDateFormatMMDD} == 2 ) {
188 return sprintf("%04d-%02d-%02d %02d:%02d", $year, $mon, $mday, $hour, $min);
189 } elsif ( $Conf{CgiDateFormatMMDD} ) {
190 return sprintf("$mon/$mday %02d:%02d", $hour, $min);
192 return sprintf("$mday/$mon %02d:%02d", $hour, $min);
200 if ( defined($Hosts->{$host}) || defined($Status{$host}) ) {
201 $s = "<a href=\"$MyURL?host=${EscURI($host)}\">$host</a>";
213 return \$user if ( $user eq ""
214 || $Conf{CgiUserUrlCreate} eq "" );
215 if ( $Conf{CgiUserHomePageCheck} eq ""
216 || -f sprintf($Conf{CgiUserHomePageCheck}, $user, $user, $user) ) {
218 . sprintf($Conf{CgiUserUrlCreate}, $user, $user, $user)
233 ### $s =~ s{([^[:print:]])}{sprintf("&\#x%02X;", ord($1));}eg;
240 $s =~ s{([^\w.\/-])}{sprintf("%%%02X", ord($1));}eg;
247 my($head) = shift(@mesg);
248 my($mesg) = join("</p>\n<p>", @mesg);
250 if ( !defined($ENV{REMOTE_USER}) ) {
253 Note: \$ENV{REMOTE_USER} is not set, which could mean there is an
254 installation problem. BackupPC_Admin expects Apache to authenticate
255 the user and pass their user name into this script as the REMOTE_USER
256 environment variable. See the documentation.
260 $bpc->ServerMesg("log User $User (host=$In{host}) got CGI error: $head")
261 if ( defined($bpc) );
262 if ( !defined($Lang->{Error}) ) {
263 $mesg = <<EOF if ( !defined($mesg) );
264 There is some problem with the BackupPC installation.
265 Please check the permissions on BackupPC_Admin.
268 ${h1("Error: Unable to read config.pl or language strings!!")}
271 Header("BackupPC: Error", $content);
274 my $content = eval("qq{$Lang->{Error____head}}");
275 Header(eval("qq{$Lang->{Error}}"), $content);
284 # Verify that the server connection is ok
286 return if ( $bpc->ServerOK() );
287 $bpc->ServerDisconnect();
288 if ( my $err = $bpc->ServerConnect($Conf{ServerHost}, $Conf{ServerPort}) ) {
289 if ( CheckPermission()
290 && -f $Conf{ServerInitdPath}
291 && $Conf{ServerInitdStartCmd} ne "" ) {
292 my $content = eval("qq{$Lang->{Admin_Start_Server}}");
293 Header(eval("qq{$Lang->{Unable_to_connect_to_BackupPC_server}}"), $content);
297 ErrorExit(eval("qq{$Lang->{Unable_to_connect_to_BackupPC_server}}"),
298 eval("qq{$Lang->{Unable_to_connect_to_BackupPC_server_error_message}}"));
307 %Status = () if ( $status =~ /\bhosts\b/ );
308 %StatusHost = () if ( $status =~ /\bhost\(/ );
309 my $reply = $bpc->ServerMesg("status $status");
310 $reply = $1 if ( $reply =~ /(.*)/s );
312 # ignore status related to admin and trashClean jobs
313 if ( $status =~ /\bhosts\b/ ) {
314 foreach my $host ( grep(/admin/, keys(%Status)) ) {
315 delete($Status{$host}) if ( $bpc->isAdminJob($host) );
317 delete($Status{$bpc->trashJob});
321 sub ReadUserEmailInfo
323 if ( (stat("$LogDir/UserEmailInfo.pl"))[9] != $UserEmailInfoMTime ) {
324 do "$LogDir/UserEmailInfo.pl";
325 $UserEmailInfoMTime = (stat("$LogDir/UserEmailInfo.pl"))[9];
330 # Check if the user is privileged. A privileged user can access
331 # any information (backup files, logs, status pages etc).
333 # A user is privileged if they belong to the group
334 # $Conf{CgiAdminUserGroup}, or they are in $Conf{CgiAdminUsers}
335 # or they are the user assigned to a host in the host file.
342 return 0 if ( $User eq "" && $Conf{CgiAdminUsers} ne "*"
343 || $host ne "" && !defined($Hosts->{$host}) );
344 if ( $Conf{CgiAdminUserGroup} ne "" ) {
345 my($n,$p,$gid,$mem) = getgrnam($Conf{CgiAdminUserGroup});
346 $Privileged ||= ($mem =~ /\b\Q$User\E\b/);
348 if ( $Conf{CgiAdminUsers} ne "" ) {
349 $Privileged ||= ($Conf{CgiAdminUsers} =~ /\b\Q$User\E\b/);
350 $Privileged ||= $Conf{CgiAdminUsers} eq "*";
352 $PrivAdmin = $Privileged;
353 return $Privileged if ( !defined($host) );
355 $Privileged ||= $User eq $Hosts->{$host}{user};
356 $Privileged ||= defined($Hosts->{$host}{moreUsers}{$User});
358 # XXX check against REMOTE_NTGROUP from mod_ntlm
359 $Privileged ||= $Conf{CgiAdminUserGroup} eq $ENV{REMOTE_NTGROUP};
365 # Returns the list of hosts that should appear in the navigation bar
366 # for this user. If $getAll is set, the admin gets all the hosts.
367 # Otherwise, regular users get hosts for which they are the user or
368 # are listed in the moreUsers column in the hosts file.
375 if ( $getAll && CheckPermission() ) {
376 @hosts = sort keys %$Hosts;
378 @hosts = sort grep { $Hosts->{$_}{user} eq $User ||
379 defined($Hosts->{$_}{moreUsers}{$User}) } keys(%$Hosts);
385 # Given a host name tries to find the IP address. For non-dhcp hosts
386 # we just return the host name. For dhcp hosts we check the address
387 # the user is using ($ENV{REMOTE_ADDR}) and also the last-known IP
388 # address for $host. (Later we should replace this with a broadcast
396 if ( defined($Hosts->{$host}) && $Hosts->{$host}{dhcp}
397 && $ENV{REMOTE_ADDR} =~ /^(\d+[\.\d]*)$/ ) {
399 my($netBiosHost, $netBiosUser) = $bpc->NetBiosInfoGet($ipAddr);
400 if ( $netBiosHost ne $host ) {
402 GetStatusInfo("host(${EscURI($host)})");
403 if ( defined($StatusHost{dhcpHostIP})
404 && $StatusHost{dhcpHostIP} ne $ipAddr ) {
405 $tryIP = eval("qq{$Lang->{tryIP}}");
406 ($netBiosHost, $netBiosUser)
407 = $bpc->NetBiosInfoGet($StatusHost{dhcpHostIP});
409 if ( $netBiosHost ne $host ) {
410 ErrorExit(eval("qq{$Lang->{Can_t_find_IP_address_for}}"),
411 eval("qq{$Lang->{host_is_a_DHCP_host}}"));
413 $ipAddr = $StatusHost{dhcpHostIP};
419 ###########################################################################
420 # HTML layout subroutines
421 ###########################################################################
425 my($title, $content, $noBrowse, $contentSub, $contentPost) = @_;
427 { link => "", name => $Lang->{Status}},
428 { link => "?action=summary", name => $Lang->{PC_Summary}},
429 { link => "?action=editConfig", name => $Lang->{CfgEdit_Edit_Config},
431 { link => "?action=editConfig&newMenu=hosts",
432 name => $Lang->{CfgEdit_Edit_Hosts},
434 { link => "?action=adminOpts", name => $Lang->{Admin_Options},
436 { link => "?action=view&type=LOG", name => $Lang->{LOG_file},
438 { link => "?action=LOGlist", name => $Lang->{Old_LOGs},
440 { link => "?action=emailSummary", name => $Lang->{Email_summary},
442 { link => "?action=queue", name => $Lang->{Current_queues},
444 # XXX additional search extensions
445 { link => "?action=search", name => $Lang->{Search_archive},
447 { link => "?action=burn", name => $Lang->{Burn_media},
449 @{$Conf{CgiNavBarLinks} || []},
451 my $host = $In{host};
453 binmode(STDOUT, ":utf8");
454 print $Cgi->header(-charset => "utf-8");
456 <!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN">
458 <title>$title</title>
459 <link rel=stylesheet type="text/css" href="$Conf{CgiImageDirURL}/$Conf{CgiCSSFile}" title="CSSFile">
460 <link rel=icon href="$Conf{CgiImageDirURL}/favicon.ico" type="image/x-icon">
462 <script src="$Conf{CgiImageDirURL}/sorttable.js"></script>
463 </head><body onLoad="document.getElementById('NavMenu').style.height=document.body.scrollHeight">
464 <a href="http://backuppc.sourceforge.net"><img src="$Conf{CgiImageDirURL}/logo.gif" hspace="5" vspace="7" border="0"></a><br>
467 if ( defined($Hosts) && defined($host) && defined($Hosts->{$host}) ) {
468 print "<div class=\"NavMenu\">";
469 NavSectionTitle("${EscHTML($host)}");
472 <div class="NavMenu">
474 NavLink("?host=${EscURI($host)}",
475 "$host $Lang->{Home}", " class=\"navbar\"");
476 NavLink("?action=browse&host=${EscURI($host)}",
477 $Lang->{Browse}, " class=\"navbar\"") if ( !$noBrowse );
478 NavLink("?action=view&type=LOG&host=${EscURI($host)}",
479 $Lang->{LOG_file}, " class=\"navbar\"");
480 NavLink("?action=LOGlist&host=${EscURI($host)}",
481 $Lang->{LOG_files}, " class=\"navbar\"");
482 if ( -f "$TopDir/pc/$host/SmbLOG.bad"
483 || -f "$TopDir/pc/$host/SmbLOG.bad.z"
484 || -f "$TopDir/pc/$host/XferLOG.bad"
485 || -f "$TopDir/pc/$host/XferLOG.bad.z" ) {
486 NavLink("?action=view&type=XferLOGbad&host=${EscURI($host)}",
487 $Lang->{Last_bad_XferLOG}, " class=\"navbar\"");
488 NavLink("?action=view&type=XferErrbad&host=${EscURI($host)}",
489 $Lang->{Last_bad_XferLOG_errors_only},
490 " class=\"navbar\"");
492 if ( $Conf{CgiUserConfigEditEnable} || $PrivAdmin ) {
493 NavLink("?action=editConfig&host=${EscURI($host)}",
494 $Lang->{CfgEdit_Edit_Config}, " class=\"navbar\"");
495 } elsif ( -f "$TopDir/pc/$host/config.pl"
496 || ($host ne "config" && -f "$TopDir/conf/$host.pl") ) {
497 NavLink("?action=view&type=config&host=${EscURI($host)}",
498 $Lang->{Config_file}, " class=\"navbar\"");
502 print("<div id=\"Content\">\n$content\n");
503 if ( defined($contentSub) && ref($contentSub) eq "CODE" ) {
504 while ( (my $s = &$contentSub()) ne "" ) {
508 print($contentPost) if ( defined($contentPost) );
512 <div class="NavMenu" id="NavMenu" style="height:100%">
514 my $hostSelectbox = "<option value=\"#\">$Lang->{Select_a_host}</option>";
515 my @hosts = GetUserHosts($Conf{CgiNavBarAdminAllHosts});
516 NavSectionTitle($Lang->{Hosts});
517 if ( defined($Hosts) && %$Hosts > 0 && @hosts ) {
518 foreach my $host ( @hosts ) {
519 NavLink("?host=${EscURI($host)}", $host)
520 if ( @hosts < $Conf{CgiNavBarAdminAllHosts} );
521 my $sel = " selected" if ( $host eq $In{host} );
522 $hostSelectbox .= "<option value=\"?host=${EscURI($host)}\"$sel>"
526 if ( @hosts >= $Conf{CgiNavBarAdminAllHosts} ) {
529 <select onChange="document.location=this.value">
535 if ( $Conf{CgiSearchBoxEnable} ) {
537 <form action="$MyURL" method="get">
538 <input type="text" name="host" size="14" maxlength="64">
539 <input type="hidden" name="action" value="hostInfo"><input type="submit" value="$Lang->{Go}" name="ignore">
543 NavSectionTitle($Lang->{NavSectionTitle_});
544 foreach my $l ( @adminLinks ) {
545 if ( $PrivAdmin || !$l->{priv} ) {
546 my $txt = $l->{lname} ne "" ? $Lang->{$l->{lname}} : $l->{name};
547 NavLink($l->{link}, $txt);
569 <div class="NavTitle">$head</div>
583 my($link, $text) = @_;
584 if ( defined($link) ) {
586 $class = " class=\"NavCurrent\""
587 if ( length($link) && $ENV{REQUEST_URI} =~ /\Q$link\E$/
588 || $link eq "" && $ENV{REQUEST_URI} !~ /\?/ );
589 $link = "$MyURL$link" if ( $link eq "" || $link =~ /^\?/ );
591 <a href="$link"$class>$text</a>
604 <div class="h1">$str</div>
612 <div class="h2">$str</div>