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