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