bacuview 1.5

data/Rakefile

@@ -0,0 +1,94 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake, for
+# example lib/tasks/switchtower.rake, and they will automatically be
+# available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'tasks/rails'
+
+desc "Truncate log files."
+task :log_trunc do
+  sh ">log/development.log >log/test.log >log/production.log"
+end
+
+desc "Clean up junk files"
+task :clean => :log_trunc do
+  sh "rm -f tmp/sessions/ruby_sess.* svn-commit*.tmp"
+  sh "find . -name \\*~ -exec rm -f \\{\\} \\;"
+end
+
+# This voodoo generates an invisible "rake package" target.
+require 'rubygems'
+require 'rake/gempackagetask'
+Gem::manage_gems
+
+view_spec = Gem::Specification.new do |s|
+  s.platform  = Gem::Platform::RUBY
+  s.name      = "bacuview"
+  s.version   = "1.5"
+  s.author    = "John Kodis"
+  s.email     = "john@kodis.org"
+  s.summary   = "A web app for monitoring a Bacula backup system."
+  s.description = <<-EOF
+    Bacuview is a web application that provides a view into the
+    current state of a Bacula backup system.
+  EOF
+  s.files = FileList[ '[A-Z]*',
+                      'log/*.log',
+                      'app/**/*.rb',
+                      'app/**/*.rhtml',
+                      'script/**/*',
+                      'public/**/*',
+                      'config/*.rb',
+                      'config/*.template',
+                      'config/environments/*',
+                    ].to_a
+  s.executables << 'bacuview'
+end
+view_spec.add_dependency('rails')
+Rake::GemPackageTask.new(view_spec) do |pkg|
+  pkg.need_tar = true
+end
+
+watch_spec = Gem::Specification.new do |s|
+  s.platform  = Gem::Platform::RUBY
+  s.name      = "bacuwatch"
+  s.version   = "1.5"
+  s.author    = "John Kodis"
+  s.email     = "john@kodis.org"
+  s.summary   = "An app to periodically report on a Bacula backup system."
+  s.description = <<-EOF
+    Bacuwatch is an application normally run from a cron job to
+    email out reports on the status of a series of bacula jobs.
+  EOF
+  s.files = FileList[ 'bacuwatch/bacuwatch',
+                      'bacuwatch/*.template',
+                      'bacuwatch/README.bacuwatch',
+                    ].to_a
+  s.executables << 'bacuwatch'
+end
+Rake::GemPackageTask.new(watch_spec) do |pkg|
+  pkg.need_tar = true
+end
+
+desc "Prepare tar and gem files for distribution"
+task :dist => [ :log_trunc,
+                "pkg/#{view_spec.name}-#{view_spec.version}.tgz",
+                "pkg/#{view_spec.name}-#{view_spec.version}.gem",
+                "pkg/#{watch_spec.name}-#{watch_spec.version}.tgz",
+                "pkg/#{watch_spec.name}-#{watch_spec.version}.gem" ] 
+
+#desc "Prepare a distribution tar file"
+#task :dist do
+#  package_name = 'bacuview'
+#  package_version = '1.4'
+#  package = package_name + '-' + package_version
+#
+#  sh "svn checkout svn://rubyforge.org//var/svn/bacuview && " +
+#     "(echo #{package}; svn info | grep ^Revision:) >bacuview/VERSION && " +
+#     "mv bacuview #{package} && " +
+#     "find #{package} -type d -name .svn | xargs rm -rf && " +
+#     "tar czf #{package}.tar.gz #{package}"
+#end

data/app/controllers/application.rb

@@ -0,0 +1,11 @@
+# Filters added to this controller will be run for all controllers in
+# the application.  Likewise, all the methods added will be available
+# for all controllers.
+
+class ApplicationController < ActionController::Base
+  session :disabled => true
+
+  def sort_key(key_sym, key_sql)
+    params[key_sym].split(".").map{ |k| key_sql[k] }.join(",")
+  end
+end

data/app/controllers/client_controller.rb

@@ -0,0 +1,27 @@
+class ClientController < ApplicationController
+  layout "bacuview-layout"
+
+  def key_sql
+    { "name"    => "name",          "name-"    => "name desc",
+      "prune"   => "autoprune",     "prune-"   => "autoprune desc",
+      "fretain" => "fileretention", "fretain-" => "fileretention desc",
+      "jretain" => "jobretention",  "jretain-" => "jobretention desc",
+      "uname"   => "uname",         "uname-"   => "uname desc" }
+  end
+
+  def index
+    @page_title = "Clients"
+    @clients = Client.find(:all, :order => sort_key(:csort, key_sql))
+  end
+
+  def show
+    cid = params[:cid]
+    @client = Client.find(cid)
+    @page_title = "Client " + @client.name
+    params[:action] = params[:cid] = nil
+  end
+
+  def check
+    render(:layout => false)
+  end
+end

data/app/controllers/job_controller.rb

@@ -0,0 +1,100 @@
+class JobController < ApplicationController
+  layout "bacuview-layout"
+
+  def spec_to_params
+    if params["commit"]
+      params.delete("commit")
+      if params["spec"]
+        params["name"] = params["spec"]["name"] if params["spec"]["name"]
+        params["days"] = params["spec"]["days"] if params["spec"]["days"]
+        params.delete("spec")
+      end
+    end
+  end
+
+  def key_sql
+    { "id"     => "jobid",     "id-"   => "jobid desc", 
+      "name"   => "name",      "name-"   => "name desc", 
+      "type"   => "type",      "type-"   => "type desc",
+      "level"  => "level",     "level-"  => "level desc",
+      "status" => "jobstatus", "status-" => "jobstatus desc",
+      "bytes"  => "jobbytes",  "bytes-"  => "jobbytes desc",
+      "rate"   => "rate",      "rate-"   => "rate desc",
+      "time"   => "time",      "time-"   => "time desc",
+      "sched"  => "schedtime", "sched-"  => "schedtime desc",
+      "start"  => "starttime", "start-"  => "starttime desc",
+      "finish" => "endtime",   "finish-" => "endtime desc", }
+  end
+
+  def index
+    @page_title = "Jobs"
+    where = []
+    wargs = []
+    if params[:days].to_i != 0
+      today = Time::parse(TODAY || "now")
+      where << "schedtime > ?"
+      wargs << params[:days].to_i.day.ago(today).midnight.tomorrow
+    end
+    if params[:name] != '0'
+      where << "name = ?"
+      wargs << params[:name]
+    end
+    if params[:err].to_i == 1
+      where << "jobstatus != 'T'"
+    end
+
+    fargs = {}
+    fargs[:select] = "*, " +
+      "case when (endtime > starttime) then " +
+      ( MYSQL ?
+          "jobbytes / (endtime - starttime) " :
+          "jobbytes / extract(epoch from endtime - starttime) " ) +
+      "else null end as rate, " +
+      "cast(endtime-starttime as time) as time"
+    fargs[:order] = sort_key(:jsort, key_sql)
+    if where.size != 0
+      fargs[:conditions] = [ where.join(' and '), wargs ].flatten!
+    end
+    @jobs = Job.find(:all, fargs)
+  end
+
+  def show
+    jid = params[:jid]
+    @page_title = "Job " + jid
+    params[:action] = params[:jid] = nil
+    @job = Job.find(jid)
+    @jobmedia = Jobmedia.find_by_sql(
+      'select mediaid,volumename from Media where mediaid in ' +
+      '  (select distinct mediaid from JobMedia where jobid = ' + jid + 
+      '  ) order by mediaid' )
+  end
+
+  def gen_client_lists
+    @client_list = []
+    @platform_list = []
+    Client.find(:all, :select => 'name, uname').each { |client|
+      @client_list << client[:name]
+      platform = client[:uname].split(',')[1]
+      platform and platform.capitalize!
+      @platform_list.include?(platform) or @platform_list << platform
+    }
+  end
+
+  def last_job(name, level)
+    Job.find(:first,
+      :select => "StartTime, JobFiles, JobBytes",
+      :order => "starttime desc",
+      :conditions =>
+        [ "type='B' and jobstatus='T' and level=? and name=? ",
+          level, name ] )
+  end
+
+  def last
+    name = params[:name]
+    @page_title = name
+    @full = last_job(name, "F")
+    @diff = last_job(name, "D")
+    @incr = last_job(name, "I")
+  end
+
+end

data/app/controllers/jobmedia_controller.rb

@@ -0,0 +1,2 @@
+class JobmediaController < ApplicationController
+end

data/app/controllers/media_controller.rb

@@ -0,0 +1,44 @@
+class MediaController < ApplicationController
+  layout "bacuview-layout"
+
+# FIXTHIS: sorting on pool.volretention sorts by media.volretention,
+# and vise versa.  This is way wrong, but easy to work around.
+#    @media = Media.find_by_sql(
+#      'SELECT * FROM media ' +
+#      'JOIN pool ON pool.poolid=media.poolid ' +
+#      'ORDER BY pool.volretention')
+
+  def key_sql
+    { "name"   => "volumename",        "name-"   => "volumename desc", 
+      "slot"   => "inchanger,storageid,slot",
+      "slot-"  => "inchanger desc,storageid desc,slot desc",
+      "stat"   => "volstatus",         "stat-"   => "volstatus desc", 
+      "jobs"   => "voljobs",           "jobs-"   => "voljobs desc",
+      "files"  => "volfiles",          "files-"  => "volfiles desc", 
+      "bytes"  => "volbytes",          "bytes-"  => "volbytes desc",
+      "expire" => "expire",            "expire-" => "expire desc",
+      "retain" => "Pool.volretention", "retain-" => "Pool.volretention desc",
+      "pool"   => "name",              "pool-"   => "name desc",
+      "ptype"  => "pooltype",          "ptype-"  => "pooltype desc",
+      "mtype"  => "mediatype",         "mtype-"  => "mediatype desc" }
+  end
+
+  def index
+    @page_title = "Media"
+    @media = Media.find(:all,
+      :order => sort_key(:msort, key_sql),
+      :joins => 'join Pool on Pool.PoolId=Media.PoolId',
+      :select => "*, " +
+        ( MYSQL ?
+          "from_unixtime(unix_timestamp(lastwritten) + Media.volretention) " :
+          "lastwritten + media.volretention * interval '1 second'" ) +
+        " as expire")
+  end
+
+  def show
+    @media = Media.find(params[:mid])
+    @page_title = "Media " + @media.volumename
+    params[:action] = params[:mid] = nil
+  end
+
+end

data/app/controllers/misc_controller.rb

@@ -0,0 +1,14 @@
+class MiscController < ApplicationController
+  layout "bacuview-layout"
+
+  def about
+    @page_title = "About"
+    params['action'] = nil
+  end
+
+  def help
+    @page_title = "Help"
+    params['action'] = nil
+  end
+
+end

data/app/controllers/pool_controller.rb

@@ -0,0 +1,38 @@
+class PoolController < ApplicationController
+  layout "bacuview-layout"
+
+  def key_sql
+    { "name"   => "name",         "name-"   => "name desc", 
+      "type"   => "pooltype",     "type-"   => "pooltype desc",
+      "retain" => "volretention", "retain-" => "volretention desc",
+      "vols"   => "numvols",      "vols-"   => "numvols desc" }
+  end
+
+  def index
+    @page_title = "Pools"
+    @pool = Pool.find(:all, :order => sort_key(:psort, key_sql))
+    volume_counts = @pool.map{ |pool| pool.numvols }
+    @max_vols = volume_counts.max
+    @total_vols = volume_counts.inject(0) {|sum, i| sum + i}
+  end
+
+  def show
+    @pool = Pool.find(params[:pid])
+    @page_title = "Pool " + @pool.name
+    params[:action] = params[:pid] = nil
+  end
+
+  def dist
+    return unless BACUVIEW['have_gruff']
+    g = Gruff::Pie.new(500)
+    g.theme_37signals
+    g.title = "Media Distribution"
+    @pool = Pool.find(:all, 
+      :select => "name, numvols", :order => sort_key(:psort, key_sql))
+    for pool in @pool do
+      g.data pool.name, [ pool.numvols ]
+    end
+    send_data(g.to_blob, :disposition => 'inline', :type => 'image/png')
+  end
+
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,88 @@
+module ApplicationHelper
+
+  def column_header(controller, param_key, title, sort_key)
+    s = params[param_key].scan(/([a-z]+)(-?)\.?/)
+    header = sort_key
+    if s[0][0] == sort_key
+      header += ((s[0][1] == "") ? "-" : "")
+      if s[1] then header += ("." + s[1][0] + s[1][1]); end
+    else
+      header += ("." + s[0][0] + s[0][1])
+    end
+    content_tag('td',
+      link_to(title, :controller => controller, param_key => header),
+      (s[0][0] == sort_key) ? { :class => 'skey' } : nil)
+  end
+
+  def client_header(title, sort_key)
+    column_header("client", :csort, title, sort_key)
+  end
+
+  def media_header(title, sort_key)
+    column_header("media", :msort, title, sort_key)
+  end
+
+  def pool_header(title, sort_key)
+    column_header("pool", :psort, title, sort_key)
+  end
+
+  def job_header(title, sort_key)
+    column_header("job", :jsort, title, sort_key)
+  end
+
+  def pretty_key(key)
+    key = key.downcase
+    oops = {
+      'uname' => 'Unix Name',
+      'numvols' => 'Number of Volumes',
+      'volumename' => 'Volume Name',
+      'voluseduration' => 'Volume Use Duration',
+    }
+    return oops[key] if oops[key]
+
+    s = key.dup
+    s.gsub!(/^vol/, 'Volume ')
+    s.gsub!(/poolid/, ' Pool Id')
+    s.gsub!(/maxvol/, 'Maximum Volume')
+    s.gsub!(/^(media|storage|label|job|migration|pool|client|use|accept|first|end)/, '\1 ')
+    s.gsub!(/(time|base|id|retention|files?|bytes?|jobs?|written|changer|volume)$/, ' \1')
+    s.split(' ').map{|s| s.capitalize}.join(' ')
+  end
+
+  def pretty_val(key, val)
+    case key.downcase
+    when 'jobtdate', 'volsessiontime'
+      val == 0 ? 'None' : Time.at(val)
+    when 'type'
+      type_name(val).capitalize
+    when 'level'
+      level_name(val).capitalize
+    when 'jobstatus'
+      status_name(val).capitalize
+    when /retention/
+      (val / 86400).to_s + ' days'
+    when /bytes/
+      number_to_human_size(val)
+    else
+      val.is_a?(Fixnum) ? number_with_delimiter(val) : val
+    end
+  end
+
+  def day_names
+    [ [ "day", "1" ], [ "week", "7" ], [ "month", "35"], [ "year", "372"],
+      [ "All dates", "0" ] ]
+  end
+
+  def job_names
+    jn = Job.find(:all, :order=>'name', :select=>'distinct Name,Type')
+    jn.delete_if { |job| job.type != 'B' }
+    jn.map { |job| [ job.name, job.name ] }.unshift([ "All jobs", "0" ])
+  end
+
+  def selection(hash, key, choices, selected=nil)
+    content_tag("select", 
+      options_for_select(choices, selected),
+      :id=>"#{hash}_#{key}", :name=>"#{hash}[#{key}]")
+  end
+
+end

data/app/helpers/client_finder.rb

@@ -0,0 +1,112 @@
+def get_token(fd)
+  if (r = fd.gets)
+    r.strip!
+    doc = r.sub!(/\s*(#.*)/, '') ? $1 : nil        
+    case r
+    when /\s*(\w+)\s*\{/
+      return [ '{', $1, doc ]
+    when /\s*(\w+(\s+\w+)?)\s*=\s*(.+)/
+      return [ $1.downcase.tr(' ', ''), $3, doc ]
+    when /\s*\}/
+      return [ '}', nil, doc ]
+    when /^\s*@(.*)/
+      return [ '@', $1, doc ]
+    when /^$/
+      return [ nil, nil, doc ]
+    else
+      p [ :ELSE, r ]
+      return []
+    end
+  end
+end
+
+def get_element(fd)
+  t = get_token(fd)
+  if !t or t[0] != '{'
+    return t
+  else
+    element = [ t ]
+    begin
+      element << ( t = get_element(fd) )
+    end until t[0] == '}'
+    return element
+  end
+end
+
+def config_file_ingest(path)
+  files = 0
+  cfg = []
+  Dir.glob(path).each { |fn|
+    begin
+      fd = File.open(fn)
+      while (e = get_element(fd))
+        cfg << e
+      end
+    rescue
+      print "Error processing config file ", fn, "\n"
+    end
+    files = files + 1
+  }
+  print "Read ", files, " configuration files from ", path, "\n"
+  return cfg
+end
+
+def build_client_map(path, glob)
+  path = path || '/etc/bacula'
+  glob = glob || '*.conf'
+  conf = config_file_ingest(File.join(path, glob))
+  map = {}
+  begin
+    for e in conf
+      if e[0] and e[0][1] == 'client'
+        name = e.assoc('name')
+        addr = e.assoc('address')
+        port = e.assoc('port')
+        if name and addr
+          map[name[1]] = addr[1] + (port ? (':' + port[1]) : '')
+        end
+      end
+    end
+  rescue
+    printf "Error extracting client name/host address pairs\n"
+    return {}
+  end
+  return map
+end
+
+# def put_token(t, i)
+#   if t[0]
+#     print '   ' * i
+#     case t[0]
+#     when '{'
+#       print t[1], ' {'
+#     when '}'
+#       print '}'
+#     when '@'
+#       print '@', t[1]
+#     else
+#       print t[0], ' = ', t[1]
+#     end
+#     print '  '
+#   end
+#   puts t[2] ? t[2] : ''
+# end
+# 
+# def put_element(e, i)
+#   if ! e[0].is_a?(Array)
+#     put_token(e, i)
+#   else
+#     put_token(e.shift, i)
+#     last = e.pop
+#     for t in e
+#       put_element(t, i+1)
+#     end
+#     put_token(last, i)
+#   end
+# end
+# 
+# require 'pp'
+# pp c
+# for e in c
+#   put_element(e, 0)
+# end

data/app/helpers/client_helper.rb

@@ -0,0 +1,45 @@
+module ClientHelper
+  require 'socket'
+
+  def host_for_client(client)
+    host = CLIENT_MAP[client] or client.gsub(/-fd$/, '')
+  end
+
+  def check_interminably(host, port)
+    begin
+      s = TCPSocket.new(host, port)
+      s.close
+      s ? "okay.png" : "error.png"
+    rescue SocketError
+      "dunno.png"
+    rescue 
+      "error.png"
+    end
+  end
+
+  def client_check(host, port = 9102)
+    t = Thread.new { check_interminably(host, port) }
+    t.join(5) ? t.value : "error.png"
+  end
+
+  def client_image
+    @client = Client.find(params[:id])
+    host = host_for_client(@client.name)
+    @image = client_check(host)
+  end
+
+  def check_tag(cid)
+    if cid == 0
+      content_tag('td',
+        content_tag('a', "OK?",
+          :href => "#", :onclick => "return check_through(#{@clients.size})"))
+    else
+      content_tag('td',
+        content_tag('a',
+          content_tag('div', image_tag('dunno.png', :class => "em1"),
+            :class => "center", :id => "client-#{cid}"),
+          :href => "#", :onclick => "return check(#{cid})"))
+    end
+  end
+
+end

data/app/helpers/job_helper.rb

@@ -0,0 +1,56 @@
+module JobHelper
+
+  def when_full(s)
+    !s ? '-' : s.strftime('%a %b %d %H:%M')
+  end
+
+  def when_tiny(s)
+    !s ? '-' : s.strftime('%H:%M %a')
+  end
+
+  def human_size_if_nz(val)
+    val <= 0 ? '-' : number_to_human_size(val)
+  end
+
+  def secs_to_hms(sec)
+    return '-' if sec <= 0
+    s = sec.divmod(60)
+    m = s[0].divmod(60)
+    sprintf '%d:%02d:%02d', m[0], m[1], s[1]
+  end
+
+  def type_name(c)
+    name = {
+      'B' => 'Backup', 'D' => 'Admin', 'V' => 'Verify', 'R' => 'Restore',
+    }
+    name[c] || c
+  end
+
+  def level_name(c)
+    name = {
+      'F' => 'Full', 'I' => 'Incr', 'D' => 'Diff', 'O' => 'Catalog',
+    }
+    name[c] || c
+  end
+
+  def status_name(c)
+    name = {
+      'A' => 'Cancel', 'B' => 'Blocked', 'C' => 'Created',
+      'D' => 'Diffs', 'R' => 'Running', 'T' => 'Okay',
+      'E' => 'Error', 'e' => 'Non-fatal', 'f' => 'Fatal',
+      'F' => 'FD Wait', 'M' => 'Mount Wait', 'S' => 'SD Wait',
+      'c' => 'FR Wait', 'd' => 'Jmax Wait', 'j' => 'JR Wait',
+      'm' => 'Media Wait', 'p' => 'Prio Wait', 's' => 'SR Wait', 
+      't' => 'Start Wait',
+    }
+    name[c] || c
+  end
+
+  def status_style(s)
+    stat = {
+      'T' => 'normal', 'R' => 'okay', 'C' => 'pending',
+      'A' => 'cancel', 'E' => 'error', 'f' => 'error', }
+    content_tag('td', status_name(s), 'class' => stat[s] || 'oops')
+  end
+
+end

data/app/helpers/jobmedia_helper.rb

@@ -0,0 +1,2 @@
+module JobmediaHelper
+end

data/app/helpers/media_helper.rb

@@ -0,0 +1,14 @@
+module MediaHelper
+  def status_style(s)
+    stat = {
+      'Append' => 'normal', 'Purged' => 'normal', 'Recycle' => 'normal',
+      'Error' => 'error', 'Full' => 'okay', }
+    content_tag('td', s, 'class' => stat[s] || 'oops')
+  end
+
+  def slot_display(in_changer, storage_id, slot_number)
+    return "-" if in_changer == 0
+    return slot_number.to_s if CHANGERS <= 1
+    return storage_id.to_s + ":" + slot_number.to_s
+  end
+end

data/app/helpers/misc_helper.rb

@@ -0,0 +1,15 @@
+module MiscHelper
+
+  def help_slogan
+    slogans =
+      [
+       "Help?  We don't NEED no steenkin' help!",
+       "Help serves only to coddle the weak!",
+       "Help is only for the weak and timid.",
+       "You want HELP?  You can't handle the HELP!",
+       "Move along now.  This is not the help that you are searching for.",
+      ]
+    slogans[rand(slogans.size)]
+  end
+
+end

data/app/helpers/pool_helper.rb

@@ -0,0 +1,2 @@
+module PoolHelper
+end