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