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

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