Module: Gen_switch_graph

Defined in:
generators/gen_switch_graph.rb

Overview

Encapsulates methods to generate dot and HTML from the switch records.

Class Method Summary (collapse)

Class Method Details

+ (Object) gen_dot(switches, html_base_directory = "/tmp/", web_directory = '.', remove_the_dot_file = false)

Generate a dot file from the Switch records, and from that, a png and map file for serving from the web server.

Parameters:

  • switches (Hash) —

    Hash of Switch records

  • html_base_directory (String) (defaults to: "/tmp/") —

    Root directory of the System's web server.

  • web_directory (String) (defaults to: '.') —

    Directory within the web directory, that we want to store the png and map files

  • remove_the_dot_file (Boolean) (defaults to: false) —

    Set to true for debugging dot grophing issues.



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'generators/gen_switch_graph.rb', line 11

def self.gen_dot(switches, html_base_directory="/tmp/", web_directory='.', remove_the_dot_file=false)
  arp = Arp.new
  switches.each do |n,s| #for each switch
    safe_name = s.name.gsub(/[- ]/,'_')
    filename = "#{html_base_directory}/#{web_directory}/#{safe_name}"
    File.open("#{filename}.dot", "w") do |fd|
      fd.print <<-EOF2
graph #{safe_name} {
graph [ fontname = "Times", fontsize=12, dpi=72  ];
overlap=scale;
layout=neato
node [shape=ellipse, fontname = "Lucida", fontsize=12]; 
  "#{safe_name}" [color="green", URL=\"/#{web_directory}/#{safe_name}_t.html\" ];
node [shape=ellipse, color=black, fontname = "Lucida", fontsize=12];    
EOF2

      s.ports.each do |k,p| #for each port on the switch
        if p.bridge_port == false
          # create node entries 
          p.port_arp.each { |a|  fd.puts("  \"#{arp.host(a)}\" [ color=\"green\" ];" ) } 
        end
      end
      fd.print "\n"

      s.ports.each do |k,p| #for each port on the switch
        if p.bridge_port == false
          # create edge entries
          p.port_arp.each { |a|  fd.puts("\"#{safe_name}\" -- \"#{arp.host(a)}\" [headlabel=\"#{p.port_number}\", color=\"green\" , len=1.50 ];" ) } 
        end
      end
      fd.print "}\n"
    end
    system("/usr/bin/dot -Tpng -o #{filename}.png -Tcmapx -o #{filename}_map.html #{filename}.dot")
    File.unlink("#{filename}.dot") if remove_the_dot_file
  end
end

+ (Object) gen_html_table(switches, html_base_directory = "/tmp/", web_directory = '.')

Generate a .html file, per switch, showing the port status and which nodes can be seen using this port.

Parameters:

  • switches (Hash) —

    Hash of Switch records

  • html_base_directory (String) (defaults to: "/tmp/") —

    Root directory of the System's web server.

  • web_directory (String) (defaults to: '.') —

    Directory within the web directory, that we want to store the html files for each switch



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'generators/gen_switch_graph.rb', line 52

def self.gen_html_table(switches, html_base_directory="/tmp/", web_directory='.')
  arp = Arp.new
  switches.each do |n,s| #for each switch
    safe_name = s.name.gsub(/[- ]/,'_')
    filename = "#{html_base_directory}/#{web_directory}/#{safe_name}"
    File.open("#{filename}_t.html", "w") do |fd|
      fd.puts <<-EOF
      <html>
      <head>
      <title>Switch #{s.name}</title>
      <META HTTP-EQUIV="Refresh" CONTENT="30;URL=/#{web_directory}/#{safe_name}_t.html">
      </head>
      <body>
      <h2><a href="/#{web_directory}/#{safe_name}.dot">#{s.name}</a></h2>
      <table border="1">
      EOF

      ports = s.ports.to_a #Change from a hash to an array, so we can use numeric indexes.
      (0...((ports.length+23)/24)).each do |l24| #lots of 24. (1..11) then (2..12), then (13..23) and (14..24)
        (0..1).each do |r| #two rows 
          fd.puts "<tr>"
          (0..1).each do |l12| #left lot of 12 , then right lot of 12
            base = l24*24 + l12*12 + r  #Groups of 24, in pairs of 12 
            (base...(base+12)).step(2) do |i| 
              if(ports[i] != nil)
                fd.puts "<th width=\"4%\" #{ ports[i][1].up == true ? 'bgcolor="#00FF00"' : '' }>#{ports[i][1].port_name}</th>"
              else #Blank cell requires &nbsp; to render correctly
                fd.puts "<th>&nbsp;</th>"
              end
            end
            fd.puts "<th width=\"1%\">&nbsp;</th>" if l12 == 0
          end
          fd.puts "</tr>\n<tr>"
          
          (0..1).each do |l12| #left lot of 12 , then right lot of 12
            base = l24*24 + l12*12 + r  #Groups of 24, in pairs of 12 
            (base...(base+12)).step(2) do |i|
              if ports[i] != nil
                if ports[i][1].bridge_port
                  fd.puts "<td>Switch<br><a href=\"#{ports[i][1].remote_switch_name.gsub(/[- ]/,'_')}_t.html\">#{ports[i][1].remote_switch_name}/#{ports[i][1].remote_port_name}</a></td>"
                elsif ports[i][1].port_arp.length > 0
                  fd.puts "<td>"
                  ports[i][1].port_arp.each do |mac|
                    fd.puts "#{arp.host(mac)}<br>"
                  end
                  fd.puts "</td>"
                else #Blank cell requires &nbsp; to render correctly
                  fd.puts "<td>&nbsp;</td>"
                end
              else #Blank cell requires &nbsp; to render correctly
                fd.puts "<td>&nbsp;</td>"
              end
            end
            fd.puts "<td>&nbsp;</td>" if l12 == 0
          end
          fd.puts "</tr>"
        end
        fd.puts "<tr><td colspan=\"25\">&nbsp;</td></tr>"
      end  
      fd.puts "</table>\n</body>\n</html>"
    end
  end
end

+ (Object) gen_shtml(switches, html_base_directory = "/tmp/", web_directory = '.')

Generate .shtml files for each switch, if they don't already exist.

Assumes the directories already exist.

Parameters:

  • switches (Hash) —

    Hash of Switch records

  • html_base_directory (String) (defaults to: "/tmp/") —

    Root directory of the System's web server.

  • web_directory (String) (defaults to: '.') —

    Directory within the web directory, that we want to store the .shtml files for each switch



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'generators/gen_switch_graph.rb', line 121

def self.gen_shtml(switches, html_base_directory="/tmp/", web_directory='.')
  switches.each do |k,s|
    safe_name = s.name.gsub(/[- ]/,'_')
    filename = "#{html_base_directory}/#{web_directory}/#{safe_name}.html"
    if File.exists?(filename) == false
      File.open(filename, "w", 0755) do |fd|
        fd.puts <<-EOF
<html><head>
<title>#{safe_name} Switch</title>
<META HTTP-EQUIV="Refresh" CONTENT="30;URL=/#{web_directory}/#{safe_name}.html">
</head>
<body>
<!--#include virtual="/#{web_directory}/#{safe_name}_map.html" -->
<img src="/#{web_directory}/#{safe_name}.png" BORDER=0 usemap="#{safe_name}" >
</body>
</html>
EOF
      end
    end
  end
end