datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/utils/DRRouteCLI.java

   1 /*******************************************************************************\r
   2  * ============LICENSE_START==================================================\r
   3  * * org.onap.dmaap\r
   4  * * ===========================================================================\r
   5  * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * * ===========================================================================\r
   7  * * Licensed under the Apache License, Version 2.0 (the "License");\r
   8  * * you may not use this file except in compliance with the License.\r
   9  * * You may obtain a copy of the License at\r
  10  * *\r
  11  *  *      http://www.apache.org/licenses/LICENSE-2.0\r
  12  * *\r
  13  *  * Unless required by applicable law or agreed to in writing, software\r
  14  * * distributed under the License is distributed on an "AS IS" BASIS,\r
  15  * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  * * See the License for the specific language governing permissions and\r
  17  * * limitations under the License.\r
  18  * * ============LICENSE_END====================================================\r
  19  * *\r
  20  * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
  21  * *\r
  22  ******************************************************************************/\r
  23 \r
  24 \r
  25 package org.onap.dmaap.datarouter.provisioning.utils;\r
  26 \r
  27 import java.io.File;\r
  28 import java.io.FileInputStream;\r
  29 import java.io.IOException;\r
  30 import java.io.InputStream;\r
  31 import java.io.InputStreamReader;\r
  32 import java.io.LineNumberReader;\r
  33 import java.security.KeyStore;\r
  34 import java.util.Arrays;\r
  35 import java.util.Properties;\r
  36 \r
  37 import javax.servlet.http.HttpServletResponse;\r
  38 \r
  39 import org.apache.http.HttpEntity;\r
  40 import org.apache.http.HttpResponse;\r
  41 import org.apache.http.StatusLine;\r
  42 import org.apache.http.client.methods.HttpDelete;\r
  43 import org.apache.http.client.methods.HttpGet;\r
  44 import org.apache.http.client.methods.HttpPost;\r
  45 import org.apache.http.conn.scheme.Scheme;\r
  46 import org.apache.http.conn.ssl.SSLSocketFactory;\r
  47 import org.apache.http.impl.client.AbstractHttpClient;\r
  48 import org.apache.http.impl.client.DefaultHttpClient;\r
  49 import org.apache.http.util.EntityUtils;\r
  50 import org.json.JSONArray;\r
  51 import org.json.JSONObject;\r
  52 import org.json.JSONTokener;\r
  53 \r
  54 /**\r
  55  * This class provides a Command Line Interface for the routing tables in the DR Release 2.0 DB.\r
  56  * A full description of this command is <a href="http://wiki.proto.research.att.com/doku.php?id=datarouter-route-cli">here</a>.\r
  57  *\r
  58  * @author Robert Eby\r
  59  * @version $Id: DRRouteCLI.java,v 1.2 2013/11/05 15:54:16 eby Exp $\r
  60  */\r
  61 public class DRRouteCLI {\r
  62     /**\r
  63      * Invoke the CLI.  The CLI can be run with a single command (given as command line arguments),\r
  64      * or in an interactive mode where the user types a sequence of commands to the program.  The CLI is invoked via:\r
  65      * <pre>\r
  66      * java org.onap.dmaap.datarouter.provisioning.utils.DRRouteCLI [ -s <i>server</i> ] [ <i>command</i> ]\r
  67      * </pre>\r
  68      * A full description of the arguments to this command are\r
  69      * <a href="http://wiki.proto.research.att.com/doku.php?id=datarouter-route-cli">here</a>.\r
  70      *\r
  71      * @param args command line arguments\r
  72      * @throws Exception for any unrecoverable problem\r
  73      */\r
  74     public static void main(String[] args) throws Exception {\r
  75         String server = System.getenv(ENV_VAR);\r
  76         if (args.length >= 2 && args[0].equals("-s")) {\r
  77             server = args[1];\r
  78             String[] t = new String[args.length - 2];\r
  79             if (t.length > 0)\r
  80                 System.arraycopy(args, 2, t, 0, t.length);\r
  81             args = t;\r
  82         }\r
  83         if (server == null || server.equals("")) {\r
  84             System.err.println("dr-route: you need to specify a server, either via $PROVSRVR or the '-s' option.");\r
  85             System.exit(1);\r
  86         }\r
  87         DRRouteCLI cli = new DRRouteCLI(server);\r
  88         if (args.length > 0) {\r
  89             boolean b = cli.runCommand(args);\r
  90             System.exit(b ? 0 : 1);\r
  91         } else {\r
  92             cli.interactive();\r
  93             System.exit(0);\r
  94         }\r
  95     }\r
  96 \r
  97     public static final String ENV_VAR = "PROVSRVR";\r
  98     public static final String PROMPT = "dr-route> ";\r
  99     public static final String DEFAULT_TRUSTSTORE_PATH = /* $JAVA_HOME + */ "/jre/lib/security/cacerts";\r
 100 \r
 101     private final String server;\r
 102     private int width = 120;        // screen width (for list)\r
 103     private AbstractHttpClient httpclient;\r
 104 \r
 105     /**\r
 106      * Create a DRRouteCLI object connecting to the specified server.\r
 107      *\r
 108      * @param server the server to send command to\r
 109      * @throws Exception\r
 110      */\r
 111     public DRRouteCLI(String server) throws Exception {\r
 112         this.server = server;\r
 113         this.width = 120;\r
 114         this.httpclient = new DefaultHttpClient();\r
 115 \r
 116         Properties p = (new DB()).getProperties();\r
 117         String truststore_file = p.getProperty("org.onap.dmaap.datarouter.provserver.truststore.path");\r
 118         String truststore_pw = p.getProperty("org.onap.dmaap.datarouter.provserver.truststore.password");\r
 119 \r
 120         KeyStore trustStore = KeyStore.getInstance(KeyStore.getDefaultType());\r
 121         if (truststore_file == null || truststore_file.equals("")) {\r
 122             String jhome = System.getenv("JAVA_HOME");\r
 123             if (jhome == null || jhome.equals(""))\r
 124                 jhome = "/opt/java/jdk/jdk180";\r
 125             truststore_file = jhome + DEFAULT_TRUSTSTORE_PATH;\r
 126         }\r
 127         File f = new File(truststore_file);\r
 128         if (f.exists()) {\r
 129             FileInputStream instream = new FileInputStream(f);\r
 130             try {\r
 131                 trustStore.load(instream, truststore_pw.toCharArray());\r
 132             } catch (Exception x) {\r
 133                 System.err.println("Problem reading truststore: " + x);\r
 134                 throw x;\r
 135             } finally {\r
 136                 try {\r
 137                     instream.close();\r
 138                 } catch (Exception ignore) {\r
 139                 }\r
 140             }\r
 141         }\r
 142 \r
 143         SSLSocketFactory socketFactory = new SSLSocketFactory(trustStore);\r
 144         Scheme sch = new Scheme("https", 443, socketFactory);\r
 145         httpclient.getConnectionManager().getSchemeRegistry().register(sch);\r
 146     }\r
 147 \r
 148     private void interactive() throws IOException {\r
 149         LineNumberReader in = new LineNumberReader(new InputStreamReader(System.in));\r
 150         while (true) {\r
 151             System.out.print(PROMPT);\r
 152             String line = in.readLine();\r
 153             if (line == null)\r
 154                 return;\r
 155             line = line.trim();\r
 156             if (line.equalsIgnoreCase("exit"))    // "exit" may only be used in interactive mode\r
 157                 return;\r
 158             if (line.equalsIgnoreCase("quit"))    // "quit" may only be used in interactive mode\r
 159                 return;\r
 160             String[] args = line.split("[ \t]+");\r
 161             if (args.length > 0)\r
 162                 runCommand(args);\r
 163         }\r
 164     }\r
 165 \r
 166     /**\r
 167      * Run the command specified by the arguments.\r
 168      *\r
 169      * @param args The command line arguments.\r
 170      * @return true if the command was valid and succeeded\r
 171      */\r
 172     public boolean runCommand(String[] args) {\r
 173         String cmd = args[0].trim().toLowerCase();\r
 174         if (cmd.equals("add")) {\r
 175             if (args.length > 2) {\r
 176                 if (args[1].startsWith("in") && args.length >= 6) {\r
 177                     return addIngress(args);\r
 178                 }\r
 179                 if (args[1].startsWith("eg") && args.length == 4) {\r
 180                     return addEgress(args);\r
 181                 }\r
 182                 if (args[1].startsWith("ne") && args.length == 5) {\r
 183                     return addRoute(args);\r
 184                 }\r
 185             }\r
 186             System.err.println("Add command should be one of:");\r
 187             System.err.println("  add in[gress] feedid user subnet nodepatt [ seq ]");\r
 188             System.err.println("  add eg[ress]  subid node");\r
 189             System.err.println("  add ne[twork] fromnode tonode vianode");\r
 190         } else if (cmd.startsWith("del")) {\r
 191             if (args.length > 2) {\r
 192                 if (args[1].startsWith("in") && args.length == 5) {\r
 193                     return delIngress(args);\r
 194                 }\r
 195                 if (args[1].startsWith("in") && args.length == 3) {\r
 196                     return delIngress(args);\r
 197                 }\r
 198                 if (args[1].startsWith("eg") && args.length == 3) {\r
 199                     return delEgress(args);\r
 200                 }\r
 201                 if (args[1].startsWith("ne") && args.length == 4) {\r
 202                     return delRoute(args);\r
 203                 }\r
 204             }\r
 205             System.err.println("Delete command should be one of:");\r
 206             System.err.println("  del in[gress] feedid user subnet");\r
 207             System.err.println("  del in[gress] seq");\r
 208             System.err.println("  del eg[ress]  subid");\r
 209             System.err.println("  del ne[twork] fromnode tonode");\r
 210         } else if (cmd.startsWith("lis")) {\r
 211             return list(args);\r
 212         } else if (cmd.startsWith("wid") && args.length > 1) {\r
 213             width = Integer.parseInt(args[1]);\r
 214             return true;\r
 215         } else if (cmd.startsWith("?") || cmd.startsWith("hel") || cmd.startsWith("usa")) {\r
 216             usage();\r
 217         } else if (cmd.startsWith("#")) {\r
 218             // comment -- ignore\r
 219         } else {\r
 220             System.err.println("Command should be one of add, del, list, exit, quit");\r
 221         }\r
 222         return false;\r
 223     }\r
 224 \r
 225     private void usage() {\r
 226         System.out.println("Enter one of the following commands:");\r
 227         System.out.println("  add in[gress] feedid user subnet nodepatt [ seq ]");\r
 228         System.out.println("  add eg[ress]  subid node");\r
 229         System.out.println("  add ne[twork] fromnode tonode vianode");\r
 230         System.out.println("  del in[gress] feedid user subnet");\r
 231         System.out.println("  del in[gress] seq");\r
 232         System.out.println("  del eg[ress]  subid");\r
 233         System.out.println("  del ne[twork] fromnode tonode");\r
 234         System.out.println("  list [ all | ingress | egress | network ]");\r
 235         System.out.println("  exit");\r
 236         System.out.println("  quit");\r
 237     }\r
 238 \r
 239     private boolean addIngress(String[] args) {\r
 240         String url = String.format("https://%s/internal/route/ingress/?feed=%s&user=%s&subnet=%s&nodepatt=%s", server, args[2], args[3], args[4], args[5]);\r
 241         if (args.length > 6)\r
 242             url += "&seq=" + args[6];\r
 243         return doPost(url);\r
 244     }\r
 245 \r
 246     private boolean addEgress(String[] args) {\r
 247         String url = String.format("https://%s/internal/route/egress/?sub=%s&node=%s", server, args[2], args[3]);\r
 248         return doPost(url);\r
 249     }\r
 250 \r
 251     private boolean addRoute(String[] args) {\r
 252         String url = String.format("https://%s/internal/route/network/?from=%s&to=%s&via=%s", server, args[2], args[3], args[4]);\r
 253         return doPost(url);\r
 254     }\r
 255 \r
 256     private boolean delIngress(String[] args) {\r
 257         String url;\r
 258         if (args.length == 5) {\r
 259             String subnet = args[4].replaceAll("/", "!");    // replace the / with a !\r
 260             url = String.format("https://%s/internal/route/ingress/%s/%s/%s", server, args[2], args[3], subnet);\r
 261         } else {\r
 262             url = String.format("https://%s/internal/route/ingress/%s", server, args[2]);\r
 263         }\r
 264         return doDelete(url);\r
 265     }\r
 266 \r
 267     private boolean delEgress(String[] args) {\r
 268         String url = String.format("https://%s/internal/route/egress/%s", server, args[2]);\r
 269         return doDelete(url);\r
 270     }\r
 271 \r
 272     private boolean delRoute(String[] args) {\r
 273         String url = String.format("https://%s/internal/route/network/%s/%s", server, args[2], args[3]);\r
 274         return doDelete(url);\r
 275     }\r
 276 \r
 277     private boolean list(String[] args) {\r
 278         String tbl = (args.length == 1) ? "all" : args[1].toLowerCase();\r
 279         JSONObject jo = doGet("https://" + server + "/internal/route/");    // Returns all 3 tables\r
 280         StringBuilder sb = new StringBuilder();\r
 281         if (tbl.startsWith("al") || tbl.startsWith("in")) {\r
 282             // Display the IRT\r
 283             JSONArray irt = jo.optJSONArray("ingress");\r
 284             int cw1 = 6, cw2 = 6, cw3 = 6, cw4 = 6;        // determine column widths for first 4 cols\r
 285             for (int i = 0; irt != null && i < irt.length(); i++) {\r
 286                 JSONObject e = irt.getJSONObject(i);\r
 287                 cw1 = Math.max(cw1, ("" + e.getInt("seq")).length());\r
 288                 cw2 = Math.max(cw2, ("" + e.getInt("feedid")).length());\r
 289                 String t = e.optString("user");\r
 290                 cw3 = Math.max(cw3, (t == null) ? 1 : t.length());\r
 291                 t = e.optString("subnet");\r
 292                 cw4 = Math.max(cw4, (t == null) ? 1 : t.length());\r
 293             }\r
 294 \r
 295             int nblank = cw1 + cw2 + cw3 + cw4 + 8;\r
 296             sb.append("Ingress Routing Table\n");\r
 297             sb.append(String.format("%s  %s  %s  %s  Nodes\n", ext("Seq", cw1), ext("FeedID", cw2), ext("User", cw3), ext("Subnet", cw4)));\r
 298             for (int i = 0; irt != null && i < irt.length(); i++) {\r
 299                 JSONObject e = irt.getJSONObject(i);\r
 300                 String seq = "" + e.getInt("seq");\r
 301                 String feedid = "" + e.getInt("feedid");\r
 302                 String user = e.optString("user");\r
 303                 String subnet = e.optString("subnet");\r
 304                 if (user.equals("")) user = "-";\r
 305                 if (subnet.equals("")) subnet = "-";\r
 306                 JSONArray nodes = e.getJSONArray("node");\r
 307                 int sol = sb.length();\r
 308                 sb.append(String.format("%s  %s  %s  %s  ", ext(seq, cw1), ext(feedid, cw2), ext(user, cw3), ext(subnet, cw4)));\r
 309                 for (int j = 0; j < nodes.length(); j++) {\r
 310                     String nd = nodes.getString(j);\r
 311                     int cursor = sb.length() - sol;\r
 312                     if (j > 0 && (cursor + nd.length() > width)) {\r
 313                         sb.append("\n");\r
 314                         sol = sb.length();\r
 315                         sb.append(ext(" ", nblank));\r
 316                     }\r
 317                     sb.append(nd);\r
 318                     if ((j + 1) < nodes.length()) {\r
 319                         sb.append(", ");\r
 320                     }\r
 321                 }\r
 322                 sb.append("\n");\r
 323             }\r
 324         }\r
 325         if (tbl.startsWith("al") || tbl.startsWith("eg")) {\r
 326             // Display the ERT\r
 327             JSONObject ert = jo.optJSONObject("egress");\r
 328             String[] subs = (ert == null) ? new String[0] : JSONObject.getNames(ert);\r
 329             if (subs == null)\r
 330                 subs = new String[0];\r
 331             Arrays.sort(subs);\r
 332             int cw1 = 5;\r
 333             for (int i = 0; i < subs.length; i++) {\r
 334                 cw1 = Math.max(cw1, subs[i].length());\r
 335             }\r
 336 \r
 337             if (sb.length() > 0)\r
 338                 sb.append("\n");\r
 339             sb.append("Egress Routing Table\n");\r
 340             sb.append(String.format("%s  Node\n", ext("SubID", cw1)));\r
 341             for (int i = 0; i < subs.length; i++) {\r
 342                 if(ert!=null&&ert.length()!=0) {\r
 343                     String node = ert.getString(subs[i]);\r
 344                     sb.append(String.format("%s  %s\n", ext(subs[i], cw1), node));\r
 345                 }\r
 346 \r
 347             }\r
 348         }\r
 349         if (tbl.startsWith("al") || tbl.startsWith("ne")) {\r
 350             // Display the NRT\r
 351             JSONArray nrt = jo.optJSONArray("routing");\r
 352             int cw1 = 4, cw2 = 4;\r
 353             for (int i = 0; nrt != null && i < nrt.length(); i++) {\r
 354                 JSONObject e = nrt.getJSONObject(i);\r
 355                 String from = e.getString("from");\r
 356                 String to = e.getString("to");\r
 357                 cw1 = Math.max(cw1, from.length());\r
 358                 cw2 = Math.max(cw2, to.length());\r
 359             }\r
 360 \r
 361             if (sb.length() > 0)\r
 362                 sb.append("\n");\r
 363             sb.append("Network Routing Table\n");\r
 364             sb.append(String.format("%s  %s  Via\n", ext("From", cw1), ext("To", cw2)));\r
 365             for (int i = 0; nrt != null && i < nrt.length(); i++) {\r
 366                 JSONObject e = nrt.getJSONObject(i);\r
 367                 String from = e.getString("from");\r
 368                 String to = e.getString("to");\r
 369                 String via = e.getString("via");\r
 370                 sb.append(String.format("%s  %s  %s\n", ext(from, cw1), ext(to, cw2), via));\r
 371             }\r
 372         }\r
 373         System.out.print(sb.toString());\r
 374         return true;\r
 375     }\r
 376 \r
 377     private String ext(String s, int n) {\r
 378         if (s == null)\r
 379             s = "-";\r
 380         while (s.length() < n)\r
 381             s += " ";\r
 382         return s;\r
 383     }\r
 384 \r
 385     private boolean doDelete(String url) {\r
 386         boolean rv = false;\r
 387         HttpDelete meth = new HttpDelete(url);\r
 388         try {\r
 389             HttpResponse response = httpclient.execute(meth);\r
 390             HttpEntity entity = response.getEntity();\r
 391             StatusLine sl = response.getStatusLine();\r
 392             rv = (sl.getStatusCode() == HttpServletResponse.SC_OK);\r
 393             if (rv) {\r
 394                 System.out.println("Routing entry deleted.");\r
 395                 EntityUtils.consume(entity);\r
 396             } else {\r
 397                 printErrorText(entity);\r
 398             }\r
 399         } catch (Exception e) {\r
 400         } finally {\r
 401             meth.releaseConnection();\r
 402         }\r
 403         return rv;\r
 404     }\r
 405 \r
 406     private JSONObject doGet(String url) {\r
 407         JSONObject rv = new JSONObject();\r
 408         HttpGet meth = new HttpGet(url);\r
 409         try {\r
 410             HttpResponse response = httpclient.execute(meth);\r
 411             HttpEntity entity = response.getEntity();\r
 412             StatusLine sl = response.getStatusLine();\r
 413             if (sl.getStatusCode() == HttpServletResponse.SC_OK) {\r
 414                 rv = new JSONObject(new JSONTokener(entity.getContent()));\r
 415             } else {\r
 416                 printErrorText(entity);\r
 417             }\r
 418         } catch (Exception e) {\r
 419             System.err.println(e);\r
 420         } finally {\r
 421             meth.releaseConnection();\r
 422         }\r
 423         return rv;\r
 424     }\r
 425 \r
 426     private boolean doPost(String url) {\r
 427         boolean rv = false;\r
 428         HttpPost meth = new HttpPost(url);\r
 429         try {\r
 430             HttpResponse response = httpclient.execute(meth);\r
 431             HttpEntity entity = response.getEntity();\r
 432             StatusLine sl = response.getStatusLine();\r
 433             rv = (sl.getStatusCode() == HttpServletResponse.SC_OK);\r
 434             if (rv) {\r
 435                 System.out.println("Routing entry added.");\r
 436                 EntityUtils.consume(entity);\r
 437             } else {\r
 438                 printErrorText(entity);\r
 439             }\r
 440         } catch (Exception e) {\r
 441         } finally {\r
 442             meth.releaseConnection();\r
 443         }\r
 444         return rv;\r
 445     }\r
 446 \r
 447     private void printErrorText(HttpEntity entity) throws IllegalStateException, IOException {\r
 448         // Look for and print only the part of the output between <pre>...</pre>\r
 449         InputStream is = entity.getContent();\r
 450         StringBuilder sb = new StringBuilder();\r
 451         byte[] b = new byte[512];\r
 452         int n = 0;\r
 453         while ((n = is.read(b)) > 0) {\r
 454             sb.append(new String(b, 0, n));\r
 455         }\r
 456         is.close();\r
 457         int ix = sb.indexOf("<pre>");\r
 458         if (ix > 0)\r
 459             sb.delete(0, ix + 5);\r
 460         ix = sb.indexOf("</pre>");\r
 461         if (ix > 0)\r
 462             sb.delete(ix, sb.length());\r
 463         System.err.println(sb.toString());\r
 464     }\r
 465 }\r