staticroutes.java

Network Administration Visualized 网络管理可视化源码

package no.ntnu.nav.getDeviceData.deviceplugins.StaticRoutes;

import java.util.*;
import java.util.regex.*;

import no.ntnu.nav.logger.*;
import no.ntnu.nav.SimpleSnmp.*;
import no.ntnu.nav.ConfigParser.*;
import no.ntnu.nav.util.*;
import no.ntnu.nav.getDeviceData.Netbox;
import no.ntnu.nav.getDeviceData.deviceplugins.*;
import no.ntnu.nav.getDeviceData.dataplugins.*;
import no.ntnu.nav.getDeviceData.dataplugins.Module.*;
import no.ntnu.nav.getDeviceData.dataplugins.Gwport.*;
import no.ntnu.nav.getDeviceData.dataplugins.Swport.*;

/**
 * <p>
 * Device plugin for collecting static routes from routers.
 * </p>
 *
 * <p>
 * This plugin handles the following OID keys:
 * </p>
 *
 * <p>
 * <ui>
 *  <li>ipRouteDest</li>
 *  <li>ipRouteMask</li>
 *  <li>ipRouteNextHop</li>
 *  <li>ipRouteType</li>
 *  <li>ipRouteProto</li>
 * </ul>
 * </p>
 */

public class StaticRoutes implements DeviceHandler
{
	private static String[] canHandleOids = {
		"ipRouteDest",
		"ipRouteMask",
		"ipRouteNextHop",
		"ipRouteType",
		"ipRouteProto",
	};

	private static String[] supportedCatids = {
		"GSW",
		"GW",
	};

	private SimpleSnmp sSnmp;
	private long getNextDelay = 0;

	public int canHandleDevice(Netbox nb) {
		if (!new HashSet(Arrays.asList(supportedCatids)).contains(nb.getCat())) return NEVER_HANDLE;
		int v = nb.isSupportedAllOids(canHandleOids) ? ALWAYS_HANDLE : NEVER_HANDLE;
		Log.d("SRT_CANHANDLE", "CHECK_CAN_HANDLE", "Can handle device: " + v);
		return v;
	}

	public void handleDevice(Netbox nb, SimpleSnmp sSnmp, ConfigParser cp, DataContainers containers) throws TimeoutException
	{
		Log.setDefaultSubsystem("SRT_DEVHANDLER");
		{
			String delay = cp.get("ipRouteGetNextDelay");
			if (delay != null) {
				try {
					getNextDelay = Long.parseLong(delay);
				} catch (NumberFormatException e) {
					Log.w("PARSE_NUMBER", "ipRouteGetNextDelay in nav.conf is not a number: " + delay);
				}
			}
		}

		ModuleContainer mc;
		{
			DataContainer dc = containers.getContainer("ModuleContainer");
			if (dc == null) {
				Log.w("NO_CONTAINER", "No ModuleContainer found, plugin may not be loaded");
				return;
			}
			if (!(dc instanceof ModuleContainer)) {
				Log.w("NO_CONTAINER", "Container is not a ModuleContainer! " + dc);
				return;
			}
			mc = (ModuleContainer)dc;
		}
		
		GwportContainer gwc;
		{
			DataContainer dc = containers.getContainer("GwportContainer");
			if (dc == null) {
				Log.w("NO_CONTAINER", "No GwportContainer found, plugin may not be loaded");
				return;
			}
			if (!(dc instanceof GwportContainer)) {
				Log.w("NO_CONTAINER", "Container is not a GwportContainer! " + dc);
				return;
			}
			gwc = (GwportContainer)dc;
		}

		SwportContainer sc;
		{
			DataContainer dc = containers.getContainer("SwportContainer");
			if (dc == null) {
				Log.w("NO_CONTAINER", "No SwportContainer found, plugin may not be loaded");
				return;
			}
			if (!(dc instanceof SwportContainer)) {
				Log.w("NO_CONTAINER", "Container is not an SwportContainer! " + dc);
				return;
			}
			sc = (SwportContainer)dc;
		}
		gwc.copyTranslateFrom(mc);

		String netboxid = nb.getNetboxidS();
		String ip = nb.getIp();
		String cs_ro = nb.getCommunityRo();
		String type = nb.getType();
		String sysName = nb.getSysname();
		String cat = nb.getCat();
		this.sSnmp = sSnmp;

		boolean fetch = processCiscoGw(cp, nb, netboxid, ip, cs_ro, type, mc, gwc, sc);
			
		// Commit data
		if (fetch) {
			gwc.commit();
			gwc.commitStatic();
		}
	}

	/*
	 * CiscoGw
	 *
	 */
	private boolean processCiscoGw(ConfigParser cp, Netbox nb, String netboxid, String ip, String cs_ro, String type, ModuleContainer mc, GwportContainer gwc, SwportContainer sc) throws TimeoutException {

		/*

o For hver ruter (GW/GSW)

   o Plukk ut alle ruter der
     ipRouteType = indirect(4) & ipRouteProto = local(2)

     o Av disse UNNLAT ruter der:
       - ipRouteDest = '0.0.0.0' (default ruta fra en kantruter)
       - ipRouteNextHop = 'Null0' (tror de utelates i utgangspunktet)
       - Dersom ipRouteDest/ipRouteMask (altså prefixet) finnes fra før,
         da med en nettype som er dynamisk, altså en som har
         nettype.edit='f'
         (dette kan bl.a. inntreffe ved "flytende statiske ruter", slik
          ntnu fra f.eks. sb-gsw mot erke-gw)
       - Dersom masken er veldig grov, dvs mask <=16
         (bør ikke opptre, men dersom man ikke kjører classless ruting)
       - Man kan vurdere å unnlate mask=32, altså hostruter, ta de med
         i første runde. Tror ikke de kompliserer.

     o For rutene man da har igjen:
       - plukk ut ipRouteDest, ipRouteMask, ipRouteNextHop
       - lag ny/oppdater prefix og vlan-post som beskrevet over.

   o Motsatt må du ha logikk for å slette statiske ruter som er fjernet
     fra ruteren.

		*/

		// Retain ipRouteType = indirect(4) & ipRouteProto = local(2)
		if (getNextDelay > 0) sSnmp.setGetNextDelay(getNextDelay);
		MultiMap routeProto = util.reverse(sSnmp.getAllMap(nb.getOid("ipRouteProto"), true));
		if (getNextDelay > 0) sSnmp.setGetNextDelay(0);
		if (routeProto == null) return false;
		Set routes = routeProto.get("2");
		if (routes.isEmpty()) Log.d("ROUTE_PROTO", "Did not find any of type 2");
		if (routes.isEmpty()) return false;
		//System.err.println("Routes1: " + routes);

		// Fetch directly
		String ipRouteType = nb.getOid("ipRouteType");
		if (ipRouteType == null) return false;
		for (Iterator it = routes.iterator(); it.hasNext();) {
			String s = Prefix.hexToIp((String)it.next());
			List l = sSnmp.getAll(ipRouteType+"."+s, false, false);
			//System.err.println("s: " + s + ", " + ((String[])l.get(0))[1]);
			if (l.isEmpty() || !"4".equals(((String[])l.get(0))[1])) it.remove();
		}
		//System.err.println("Routes2: " + routes);
		if (routes.isEmpty()) Log.d("ROUTE_TYPE", "Routes is now empty");
		if (routes.isEmpty()) return false;

		// Remove routeDest = 0.0.0.0 and ipRouteNextHop = Null0
		String ipRouteDest = nb.getOid("ipRouteDest");
		Map routeDest = new HashMap();
		for (Iterator it = routes.iterator(); it.hasNext();) {
			String s = Prefix.hexToIp((String)it.next());
			List l = sSnmp.getAll(ipRouteDest+"."+s, false, false);
			//System.err.println("s: " + s + ", " + Prefix.hexToIp(((String[])l.get(0))[1]));
			if (!l.isEmpty() && "0.0.0.0".equals(Prefix.hexToIp(((String[])l.get(0))[1]))) it.remove();
			else routeDest.put(s, Prefix.hexToIp(((String[])l.get(0))[1]));
		}
		//System.err.println("Routes3: " + routes);
		if (routes.isEmpty()) Log.d("ROUTE_DEST", "Routes is now empty");
		if (routes.isEmpty()) return false;

		String ipRouteNextHop = nb.getOid("ipRouteNextHop");
		Map routeNextHop = new HashMap();
		for (Iterator it = routes.iterator(); it.hasNext();) {
			String s = Prefix.hexToIp((String)it.next());
			List l = sSnmp.getAll(ipRouteNextHop+"."+s, false, false);
			if (!l.isEmpty()) routeNextHop.put(s, Prefix.hexToIp(((String[])l.get(0))[1]));
			/*
			System.err.println("s: " + s + ", " + ((String[])l.get(0))[1]);
			if (!l.isEmpty() && "Null0".equals(((String[])l.get(0))[1])) it.remove();
			else routeNextHop.put(s, l.get(0));
			*/
		}
		//System.err.println("Routes4: " + routes);
		if (routes.isEmpty()) Log.d("ROUTE_NEXTHOP", "Routes is now empty");
		if (routes.isEmpty()) return false;

		// Remove mask <= 16
		String ipRouteMask = nb.getOid("ipRouteMask");
		Map routeMask = new HashMap();
		for (Iterator it = routes.iterator(); it.hasNext();) {
			String s = Prefix.hexToIp((String)it.next());
			List l = sSnmp.getAll(ipRouteMask+"."+s, false, false);
			//System.err.println("s: " + s + ", " + Prefix.hexToIp(((String[])l.get(0))[1]));
			if (!l.isEmpty() && Prefix.masklen(((String[])l.get(0))[1]) <= 16) it.remove();
			else routeMask.put(s, Prefix.hexToIp(((String[])l.get(0))[1]));
		}
		//System.err.println("Routes4: " + routes);
		if (routes.isEmpty()) Log.d("ROUTE_MASK", "Routes is now empty");
		if (routes.isEmpty()) return false;

		// Create net map
		List gwipList = sSnmp.getAll(nb.getOid("ipAdEntIfIndex"));
		Map netmaskMap = sSnmp.getAllMap(nb.getOid("ipAdEntIfNetMask"));
		Set netmaskSet = new HashSet();
		Map netMap = new HashMap();
		for (Iterator it = gwipList.iterator(); it.hasNext();) {
			String[] s = (String[])it.next();
			String gwip = Prefix.hexToIp(s[0]);
			String ifindex = s[1];
			String mask = Prefix.hexToIp((String)netmaskMap.get(gwip));
			netmaskSet.add(mask);
			String net = Prefix.and_ip(gwip, mask);
			netMap.put(net, ifindex);
		}

		Map ifDescr = sSnmp.getAllMap(nb.getOid("ifDescr"), true);
		Map ifAlias = sSnmp.getAllMap(nb.getOid("ifAlias"), true);
		Map admStatusMap = sSnmp.getAllMap(nb.getOid("ifAdminStatus"));
		Map speedMap = sSnmp.getAllMap(nb.getOid("ifSpeed"));
		Map highSpeedMap = sSnmp.getAllMap(nb.getOid("ifHighSpeed"));

		if (admStatusMap == null) {
			Log.w("PROCESS_SRT", "Could not get ifAdminStatus map");
		}
		
		boolean addedRoute = false;
		for (Iterator it = routes.iterator(); it.hasNext();) {
			String r = Prefix.hexToIp((String)it.next());
			String alias = null;
			if (ifAlias != null) alias = (String)ifAlias.get(r);
			String dest = Prefix.hexToIp((String)routeDest.get(r));
			String nexthop = Prefix.hexToIp((String)routeNextHop.get(r));
			String mask = Prefix.hexToIp((String)routeMask.get(r));
			String ifindex = null;
			// Try to find ifindex by searching all local interfaces
			for (Iterator maskIt = netmaskSet.iterator(); maskIt.hasNext();) {
				String m = (String)maskIt.next();
				String net = Prefix.and_ip(nexthop, m);
				if (netMap.containsKey(net)) {
					ifindex = (String)netMap.get(Prefix.and_ip(nexthop, m));
					break;
				}
			}
			if (ifindex == null) {
				Log.w("PROCESS_SRT", "Cannot find ifindex for route " + r + " (nexthop: " + nexthop + " mask: " + mask + " net: " + Prefix.and_ip(nexthop, mask) + "), skipping");
				continue;
			}
			if (Prefix.masklen(mask) <= 16) {
				Log.w("PROCESS_SRT", "Mask is <=16 ("+Prefix.masklen(mask)+") for route " + r + ", ifindex " + ifindex);
				continue;
			}

			//Log.d("PROCESS_SRT", "Check static route " + dest+"/"+mask + ", " + nexthop + ", ifindex " + ifindex);
			//System.err.println("Check static route " + dest+"/"+mask + ", " + nexthop + ", ifindex " + ifindex);

			// Ignore any admDown interfaces
			String link = admStatusMap != null ? (String)admStatusMap.get(ifindex) : "";
			//System.err.println("  Link: " + link);
			if (!"1".equals(link)) {
				Log.d("ADM_DOWN", "Interface " + ifindex + " is admDown, skipping");
				continue;
			}

			String interf = (String)ifDescr.get(ifindex);
			//System.err.println("  interf: " + interf);
			if (interf == null || interf.startsWith("EOBC") || interf.equals("Vlan0")) {
				Log.d("INTERF", "Interface " + ifindex + " = " + interf + ", skipping");
				continue;
			}

			// Determine and create the module
			int module = 1;
			String modulePattern = ".*?(\\d+)/.*";
			if (interf.matches(modulePattern)) {
				Matcher m = Pattern.compile(modulePattern).matcher(interf);
				m.matches();
				module = Integer.parseInt(m.group(1));
			} else {
				boolean sup = false;
				for (Iterator modIt = mc.getModules(); modIt.hasNext();) {
					Module mod = (Module)modIt.next();
					String modDescr = mod.getDescr();
					if (modDescr != null && modDescr.toLowerCase().indexOf("supervisor") >= 0) {
						module = mod.getModule();
						sup = true;
						break;
					}
				}
				if (!sup) {
					Log.w("SRT_MATCH-MODULE", "Supervisor not found and could not match module pattern to if: " + interf);
				}
				if (mc.getModule(module) == null && mc.getModule(0) != null) {
					Log.w("SRT_MATCH-MODULE", "No module match from interf, defaulting to module 0");
					module = 0;
				}
			}
			if (mc.getModule(module) == null) {
				// Not allowed to create module
				Log.w("SRT_MATCH-MODULE", "Module " + module + " does not exist on netbox " + nb.getSysname() + ", skipping");
				//System.err.println("Module " + module + " does not exist on netbox " + nb.getSysname() + ", skipping");
				continue;
			}
			GwModule gwm = gwc.gwModuleFactory(module);
			//System.err.println("  Route ok, module: " + module);
		
			// Create Vlan
			// netident = 'sysname-til-ruteren-du-spør,ipRouteNextHop'
			String DOMAIN_SUFFIX = ((ConfigParser)cp.getObject("navCp")).get("DOMAIN_SUFFIX");
			String netident = util.remove(nb.getSysname(), DOMAIN_SUFFIX) +","+nexthop;
			Vlan vl = gwm.vlanFactory(netident);
			vl.setNettype("static");
			vl.setDescription(alias);

			// Create Gwport
			Gwport gwp = gwm.gwportFactory(ifindex, (String)ifDescr.get(ifindex));
			addedRoute = true;

			// We can now ignore this ifindex as an swport
			sc.ignoreSwport(ifindex);

			// Set speed from Mib-II
			double speed;
			// If the ifSpeed value is maxed out (a 32 bit unsigned value), get the speed value from ifHighSpeed (if available)
			if (speedMap.containsKey(ifindex) && Long.parseLong((String)speedMap.get(ifindex)) == 4294967295L && highSpeedMap != null && highSpeedMap.containsKey(ifindex)) {
				speed = Long.parseLong((String)highSpeedMap.get(ifindex));
				Log.d("PROCESS_SRT", "Set gwport speed from ifHighSpeed for ifindex " + ifindex);
			} else {
				speed = speedMap.containsKey(ifindex) ? Long.parseLong((String)speedMap.get(ifindex)) / 1000000.0 : 0.0;
			}
			gwp.setSpeed(speed);

			// Create prefix
			Prefix p = gwp.prefixFactory(dest, false, mask, vl);
			p.setNexthop(nexthop);

			Log.d("PROCESS_SRT", "Added static route " + dest+"/"+mask + ", module " + module + ", ifindex " + ifindex);

			
		}
		return addedRoute;
	}

	private static boolean isNumber(String s) {
		try {
			Integer.parseInt(s);
		} catch (NumberFormatException e) {
			return false;
		}
		return true;
	}

}