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