Merge "Bug #25: Installing/removing flows with ".""
[controller.git] / opendaylight / web / flows / src / main / java / org / opendaylight / controller / flows / web / Flows.java
index d75d14c623da8bb8c4d1331415f6988a2d8c35af..be7560985a56fdeb3df3ae1d28020f8f87cd56a7 100644 (file)
@@ -1,4 +1,3 @@
-
 /*
  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
  *
@@ -15,8 +14,11 @@ import java.util.List;
 import java.util.Map;
 import java.util.Set;
 
+import javax.servlet.http.HttpServletRequest;
+
 import org.opendaylight.controller.forwardingrulesmanager.FlowConfig;
 import org.opendaylight.controller.forwardingrulesmanager.IForwardingRulesManager;
+import org.opendaylight.controller.sal.authorization.Privilege;
 import org.opendaylight.controller.sal.authorization.UserLevel;
 import org.opendaylight.controller.sal.core.Name;
 import org.opendaylight.controller.sal.core.Node;
@@ -28,9 +30,8 @@ import org.opendaylight.controller.sal.utils.StatusCode;
 import org.opendaylight.controller.switchmanager.ISwitchManager;
 import org.opendaylight.controller.switchmanager.Switch;
 import org.opendaylight.controller.switchmanager.SwitchConfig;
-import org.opendaylight.controller.usermanager.IUserManager;
-import org.opendaylight.controller.web.IOneWeb;
-import org.springframework.security.core.context.SecurityContextHolder;
+import org.opendaylight.controller.web.DaylightWebUtil;
+import org.opendaylight.controller.web.IDaylightWeb;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -42,15 +43,14 @@ import com.google.gson.Gson;
 
 @Controller
 @RequestMapping("/")
-public class Flows implements IOneWeb {
-       private static final UserLevel AUTH_LEVEL = UserLevel.CONTAINERUSER;
+public class Flows implements IDaylightWeb {
+    private static final UserLevel AUTH_LEVEL = UserLevel.CONTAINERUSER;
     private static final String WEB_NAME = "Flows";
     private static final String WEB_ID = "flows";
     private static final short WEB_ORDER = 2;
-    private final String containerName = GlobalConstants.DEFAULT.toString();
 
     public Flows() {
-        ServiceHelper.registerGlobalService(IOneWeb.class, this, null);
+        ServiceHelper.registerGlobalService(IDaylightWeb.class, this, null);
     }
 
     @Override
@@ -68,50 +68,74 @@ public class Flows implements IOneWeb {
         return WEB_ORDER;
     }
 
-       @Override
-       public boolean isAuthorized(UserLevel userLevel) {
-               return userLevel.ordinal() <= AUTH_LEVEL.ordinal();
-       }
-       
+    @Override
+    public boolean isAuthorized(UserLevel userLevel) {
+        return userLevel.ordinal() <= AUTH_LEVEL.ordinal();
+    }
+
     @RequestMapping(value = "/main")
     @ResponseBody
-    public Set<Map<String, Object>> getFlows() {
+    public Map<String, Object> getFlows(HttpServletRequest request, @RequestParam(required = false) String container) {
+        String containerName = (container == null) ? GlobalConstants.DEFAULT.toString() : container;
+
+        // Derive the privilege this user has on the current container
+        String userName = request.getUserPrincipal().getName();
+        Privilege privilege = DaylightWebUtil.getContainerPrivilege(userName, containerName, this);
+        if (privilege  == Privilege.NONE) {
+            return null;
+        }
+
         // fetch frm
         IForwardingRulesManager frm = (IForwardingRulesManager) ServiceHelper
                 .getInstance(IForwardingRulesManager.class, containerName, this);
-        if (frm == null) { return null; }
+        if (frm == null) {
+            return null;
+        }
 
         // fetch sm
         ISwitchManager switchManager = (ISwitchManager) ServiceHelper
                 .getInstance(ISwitchManager.class, containerName, this);
-        if (switchManager == null) { return null; }
-        
+        if (switchManager == null) {
+            return null;
+        }
+
         // get static flow list
         List<FlowConfig> staticFlowList = frm.getStaticFlows();
-        Set<Map<String, Object>> output = new HashSet<Map<String, Object>>();
+        Set<Map<String, Object>> flowSet = new HashSet<Map<String, Object>>();
         for (FlowConfig flowConfig : staticFlowList) {
-               Map<String, Object> entry = new HashMap<String, Object>();
-               entry.put("flow", flowConfig);
-               entry.put("name", flowConfig.getName());
-               Node node = flowConfig.getNode();
-               String description = switchManager.getNodeDescription(node);
-               entry.put("node", 
-                               (description.isEmpty() || 
-                                               description.equalsIgnoreCase("none"))? 
-                                                               node.toString() : description);
-               entry.put("nodeId", node.toString());
-               output.add(entry);
-        }
-        
+            Map<String, Object> entry = new HashMap<String, Object>();
+            entry.put("flow", flowConfig);
+            entry.put("name", flowConfig.getName());
+            Node node = flowConfig.getNode();
+            String description = switchManager.getNodeDescription(node);
+            entry.put("node", (description.isEmpty() || description
+                    .equalsIgnoreCase("none")) ? node.toString() : description);
+            entry.put("nodeId", node.toString());
+            flowSet.add(entry);
+        }
+
+        Map <String, Object> output = new HashMap<String, Object>(2);
+        output.put("flows", flowSet);
+        output.put("privilege", privilege);
         return output;
     }
 
     @RequestMapping(value = "/node-ports")
     @ResponseBody
-    public Map<String, Object> getNodePorts() {
+    public Map<String, Object> getNodePorts(HttpServletRequest request, @RequestParam(required = false) String container) {
+        String containerName = (container == null) ? GlobalConstants.DEFAULT.toString() : container;
+
+        // Derive the privilege this user has on the current container
+        String userName = request.getUserPrincipal().getName();
+        if (DaylightWebUtil.getContainerPrivilege(userName, containerName, this) == Privilege.NONE) {
+            return null;
+        }
+
         ISwitchManager switchManager = (ISwitchManager) ServiceHelper
                 .getInstance(ISwitchManager.class, containerName, this);
-        if (switchManager == null) { return null; }
+        if (switchManager == null) {
+            return null;
+        }
 
         Map<String, Object> nodes = new HashMap<String, Object>();
         Map<Short, String> port;
@@ -125,53 +149,66 @@ public class Flows implements IOneWeb {
                     String nodeConnectorName = ((Name) switchManager
                             .getNodeConnectorProp(nodeConnector,
                                     Name.NamePropName)).getValue();
-                    port.put((Short) nodeConnector.getID(),
-                             nodeConnectorName + "("
-                             + nodeConnector.getNodeConnectorIDString() + ")");
+                    port.put((Short) nodeConnector.getID(), nodeConnectorName
+                            + "(" + nodeConnector.getNodeConnectorIDString()
+                            + ")");
                 }
             }
-            
+
             // add ports
             Map<String, Object> entry = new HashMap<String, Object>();
             entry.put("ports", port);
-            
+
             // add name
-            String description = switchManager
-                       .getNodeDescription(node.getNode());
-            entry.put("name", (description.isEmpty() || 
-                       description.equalsIgnoreCase("none"))? 
-                       node.getNode().toString() : description);
-            
+            String description = switchManager.getNodeDescription(node
+                    .getNode());
+            entry.put("name", (description.isEmpty() || description
+                    .equalsIgnoreCase("none")) ? node.getNode().toString()
+                    : description);
+
             // add to the node
             nodes.put(node.getNode().toString(), entry);
         }
 
         return nodes;
     }
-    
+
     @RequestMapping(value = "/node-flows")
     @ResponseBody
-    public Map<String, Object> getNodeFlows() {
+    public Map<String, Object> getNodeFlows(HttpServletRequest request, @RequestParam(required = false) String container) {
+        String containerName = (container == null) ? GlobalConstants.DEFAULT.toString() : container;
+
+        // Derive the privilege this user has on the current container
+        String userName = request.getUserPrincipal().getName();
+        if (DaylightWebUtil.getContainerPrivilege(userName, containerName, this) == Privilege.NONE) {
+            return null;
+        }
+
         ISwitchManager switchManager = (ISwitchManager) ServiceHelper
                 .getInstance(ISwitchManager.class, containerName, this);
-        if (switchManager == null) { return null; }
+        if (switchManager == null) {
+            return null;
+        }
         IForwardingRulesManager frm = (IForwardingRulesManager) ServiceHelper
-                .getInstance(IForwardingRulesManager.class, "default", this);
-        if (frm == null) { return null; }
+                .getInstance(IForwardingRulesManager.class, containerName, this);
+        if (frm == null) {
+            return null;
+        }
 
         Map<String, Object> nodes = new HashMap<String, Object>();
 
         for (Switch sw : switchManager.getNetworkDevices()) {
             Node node = sw.getNode();
-            
+
             List<FlowConfig> flows = frm.getStaticFlows(node);
-            
+
             String nodeDesc = node.toString();
-            SwitchConfig config = switchManager.getSwitchConfig(node.getNodeIDString());
+            SwitchConfig config = switchManager.getSwitchConfig(node
+                    .toString());
             if (config != null) {
-               nodeDesc = config.getNodeDescription();
+                nodeDesc = config.getNodeDescription();
             }
-            
+
             nodes.put(nodeDesc, flows.size());
         }
 
@@ -181,14 +218,22 @@ public class Flows implements IOneWeb {
     @RequestMapping(value = "/flow", method = RequestMethod.POST)
     @ResponseBody
     public String actionFlow(@RequestParam(required = true) String action,
-            @RequestParam(required = false) String body, @RequestParam(required = true) String nodeId) {
-       if (!isUserAuthorized(UserLevel.NETWORKADMIN)) {
-               return "Operation not authorized";
-       }
-       
+            @RequestParam(required = false) String body,
+            @RequestParam(required = true) String nodeId,
+            HttpServletRequest request, @RequestParam(required = false) String container) {
+        String containerName = (container == null) ? GlobalConstants.DEFAULT.toString() : container;
+
+        // Authorization check
+        String userName = request.getUserPrincipal().getName();
+        if (DaylightWebUtil.getContainerPrivilege(userName, containerName, this) != Privilege.WRITE) {
+            return "Operation not authorized";
+        }
+
         IForwardingRulesManager frm = (IForwardingRulesManager) ServiceHelper
                 .getInstance(IForwardingRulesManager.class, containerName, this);
-        if (frm == null) { return null; }
+        if (frm == null) {
+            return null;
+        }
 
         Gson gson = new Gson();
         FlowConfig flow = gson.fromJson(body, FlowConfig.class);
@@ -199,47 +244,44 @@ public class Flows implements IOneWeb {
             result = frm.addStaticFlow(flow, false);
         }
 
-        return (result.isSuccess())? StatusCode.SUCCESS.toString(): result.getDescription();
+        return (result.isSuccess()) ? StatusCode.SUCCESS.toString() : result
+                .getDescription();
     }
-    
-    @RequestMapping(value = "/flow/{nodeId}/{name}", method = RequestMethod.POST)
+
+    @RequestMapping(value = "/flow/{nodeId}/{name:.*}", method = RequestMethod.POST)
     @ResponseBody
-    public String removeFlow(@PathVariable("nodeId") String nodeId, @PathVariable("name") String name,
-               @RequestParam(required = true) String action) {
-       if (!isUserAuthorized(UserLevel.NETWORKADMIN)) { return "Operation not authorized"; }
-       
-       IForwardingRulesManager frm = (IForwardingRulesManager) ServiceHelper
+    public String removeFlow(@PathVariable("nodeId") String nodeId,
+            @PathVariable("name") String name,
+            @RequestParam(required = true) String action,
+            HttpServletRequest request, @RequestParam(required = false) String container) {
+        String containerName = (container == null) ? GlobalConstants.DEFAULT.toString() : container;
+
+        // Authorization check
+        String userName = request.getUserPrincipal().getName();
+        if (DaylightWebUtil.getContainerPrivilege(userName, containerName, this) != Privilege.WRITE) {
+            return "Operation not authorized";
+        }
+
+        IForwardingRulesManager frm = (IForwardingRulesManager) ServiceHelper
                 .getInstance(IForwardingRulesManager.class, containerName, this);
-        if (frm == null) { return null; }
-        
+        if (frm == null) {
+            return null;
+        }
+
         Status result = null;
         Node node = Node.fromString(nodeId);
-        if (node == null) { return null; }
+        if (node == null) {
+            return null;
+        }
         if (action.equals("remove")) {
-               result = frm.removeStaticFlow(name, node);
+            result = frm.removeStaticFlow(name, node);
         } else if (action.equals("toggle")) {
-               result = frm.toggleStaticFlowStatus(name, node);
+            result = frm.toggleStaticFlowStatus(name, node);
         } else {
-               result = new Status(StatusCode.BADREQUEST, "Unknown action");
+            result = new Status(StatusCode.BADREQUEST, "Unknown action");
         }
-        
-        return (result.isSuccess())? StatusCode.SUCCESS.toString(): result.getDescription();
-    }
-    
-    /**
-     * Returns whether the current user's level is same or above
-     * the required authorization level. 
-     * 
-     * @param requiredLevel the authorization level required
-     */
-    private boolean isUserAuthorized(UserLevel requiredLevel) {
-       IUserManager userManager = (IUserManager) ServiceHelper
-                .getGlobalInstance(IUserManager.class, this);
-        if (userManager == null) { return false; }
-        
-        String username = SecurityContextHolder.getContext().getAuthentication().getName();
-        UserLevel userLevel = userManager.getUserLevel(username);
-        return (userLevel.ordinal() <= requiredLevel.ordinal());
-    }
 
+        return (result.isSuccess()) ? StatusCode.SUCCESS.toString() : result
+                .getDescription();
+    }
 }