auth/auth-batch/src/main/java/org/onap/aaf/auth/batch/Batch.java

   1 /**
   2  * ============LICENSE_START====================================================
   3  * org.onap.aaf
   4  * ===========================================================================
   5  * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
   6  * ===========================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END====================================================
  19  *
  20  */
  21
  22 package org.onap.aaf.auth.batch;
  23
  24 import java.io.File;
  25 import java.io.FileInputStream;
  26 import java.io.FileOutputStream;
  27 import java.io.IOException;
  28 import java.io.InputStream;
  29 import java.io.PrintStream;
  30 import java.lang.reflect.Constructor;
  31 import java.net.InetAddress;
  32 import java.net.URL;
  33 import java.net.UnknownHostException;
  34 import java.nio.ByteBuffer;
  35 import java.text.SimpleDateFormat;
  36 import java.util.ArrayList;
  37 import java.util.Date;
  38 import java.util.GregorianCalendar;
  39 import java.util.HashSet;
  40 import java.util.List;
  41 import java.util.Set;
  42 import java.util.TimeZone;
  43
  44 import org.apache.log4j.Logger;
  45 import org.onap.aaf.auth.common.Define;
  46 import org.onap.aaf.auth.dao.CassAccess;
  47 import org.onap.aaf.auth.env.AuthzEnv;
  48 import org.onap.aaf.auth.env.AuthzTrans;
  49 import org.onap.aaf.auth.log4j.Log4JAccessAppender;
  50 import org.onap.aaf.auth.org.Organization;
  51 import org.onap.aaf.auth.org.OrganizationException;
  52 import org.onap.aaf.auth.org.OrganizationFactory;
  53 import org.onap.aaf.cadi.Access.Level;
  54 import org.onap.aaf.cadi.PropAccess;
  55 import org.onap.aaf.cadi.config.Config;
  56 import org.onap.aaf.misc.env.APIException;
  57 import org.onap.aaf.misc.env.Env;
  58 import org.onap.aaf.misc.env.StaticSlot;
  59 import org.onap.aaf.misc.env.TimeTaken;
  60 import org.onap.aaf.misc.env.util.Chrono;
  61 import org.onap.aaf.misc.env.util.Split;
  62 import org.onap.aaf.misc.env.util.StringBuilderOutputStream;
  63
  64 import com.datastax.driver.core.Cluster;
  65 import com.datastax.driver.core.ResultSet;
  66 import com.datastax.driver.core.Row;
  67 import com.datastax.driver.core.Session;
  68 import com.datastax.driver.core.Statement;
  69
  70 public abstract class Batch {
  71
  72     private static StaticSlot ssargs;
  73
  74     protected static final String STARS = "*****";
  75
  76     protected final Cluster cluster;
  77     protected static AuthzEnv env;
  78     protected static Session session;
  79     protected static Set<String> specialNames;
  80     protected static List<String> specialDomains;
  81     protected static boolean dryRun;
  82     protected static String batchEnv;
  83
  84         private static File logdir;
  85
  86     public static final String CASS_ENV = "CASS_ENV";
  87     public static final String LOG_DIR = "LOG_DIR";
  88     protected static final String MAX_EMAILS="MAX_EMAILS";
  89     protected static final String VERSION="VERSION";
  90     public static final String GUI_URL="GUI_URL";
  91
  92     protected final Organization org;
  93         protected String version;
  94
  95     protected Batch(AuthzEnv env) throws APIException, IOException, OrganizationException {
  96         if (batchEnv != null) {
  97             env.info().log("Redirecting to ",batchEnv,"environment");
  98             String str;
  99             for (String key : new String[]{
 100                     CassAccess.CASSANDRA_CLUSTERS,
 101                     CassAccess.CASSANDRA_CLUSTERS_PORT,
 102                     CassAccess.CASSANDRA_CLUSTERS_USER_NAME,
 103                     CassAccess.CASSANDRA_CLUSTERS_PASSWORD,
 104                     VERSION,GUI_URL,MAX_EMAILS,
 105                     LOG_DIR,
 106                     "SPECIAL_NAMES"
 107                     }) {
 108                 if ((str = env.getProperty(batchEnv+'.'+key))!=null) {
 109                     env.setProperty(key, str);
 110                 }
 111             }
 112         }
 113
 114         // Setup for Dry Run
 115         cluster = CassAccess.cluster(env,batchEnv);
 116         env.info().log("cluster name - ",cluster.getClusterName());
 117         String dryRunStr = env.getProperty( "DRY_RUN" );
 118         if ( dryRunStr == null || "false".equals(dryRunStr.trim()) ) {
 119             dryRun = false;
 120         } else {
 121             dryRun = true;
 122             env.info().log("dryRun set to TRUE");
 123         }
 124
 125         org = OrganizationFactory.init(env);
 126         if(org==null) {
 127                 throw new OrganizationException("Organization MUST be defined for Batch");
 128         }
 129         org.setTestMode(dryRun);
 130
 131         // Special names to allow behaviors beyond normal rules
 132         specialNames = new HashSet<>();
 133         specialDomains = new ArrayList<>();
 134         String names = env.getProperty( "SPECIAL_NAMES" );
 135         if ( names != null )
 136         {
 137             env.info().log("Loading SPECIAL_NAMES");
 138             for (String s :names.split(",") ) {
 139                 env.info().log("\tspecial: " + s );
 140                 if(s.indexOf('@')>0) {
 141                         specialNames.add( s.trim() );
 142                 } else {
 143                         specialDomains.add(s.trim());
 144                 }
 145             }
 146         }
 147
 148         version = env.getProperty(VERSION,Config.AAF_DEFAULT_API_VERSION);
 149     }
 150
 151     protected abstract void run(AuthzTrans trans);
 152     protected abstract void _close(AuthzTrans trans);
 153
 154     public String[] args() {
 155         return env.get(ssargs);
 156     }
 157
 158     public boolean isDryRun()
 159     {
 160         return dryRun;
 161     }
 162
 163     public boolean isSpecial(String user) {
 164         if(user==null) {
 165                 return false;
 166         }
 167         if (specialNames != null && specialNames.contains(user)) {
 168             env.info().log("specialName: " + user);
 169             return (true);
 170         } else {
 171                 if(specialDomains!=null) {
 172                         for(String sd : specialDomains) {
 173                                 if(user.endsWith(sd)) {
 174                                         env.info().log("specialDomain: " + user + " matches " + sd);
 175                                         return (true);
 176                                 }
 177                         }
 178                 }
 179         }
 180         return (false);
 181     }
 182
 183
 184     protected PrintStream fallout(PrintStream inFallout, String logType)
 185             throws IOException {
 186         PrintStream fallout = inFallout;
 187         if (fallout == null) {
 188             File dir = new File("logs");
 189             if (!dir.exists()) {
 190                 dir.mkdirs();
 191             }
 192
 193             File f = null;
 194             long uniq = System.currentTimeMillis();
 195
 196             f = new File(dir, getClass().getSimpleName() + "_" + logType + "_"
 197                     + uniq + ".log");
 198
 199             fallout = new PrintStream(new FileOutputStream(f, true));
 200         }
 201         return fallout;
 202     }
 203
 204     public Organization getOrgFromID(AuthzTrans trans, String user) {
 205         Organization organization;
 206         try {
 207             organization = OrganizationFactory.obtain(trans.env(),user.toLowerCase());
 208         } catch (OrganizationException e1) {
 209             trans.error().log(e1);
 210             organization=null;
 211         }
 212
 213         if (organization == null) {
 214             PrintStream fallout = null;
 215
 216             try {
 217                 fallout = fallout(fallout, "Fallout");
 218                 fallout.print("INVALID_ID,");
 219                 fallout.println(user);
 220             } catch (Exception e) {
 221                 env.error().log("Could not write to Fallout File", e);
 222             }
 223             return (null);
 224         }
 225
 226         return (organization);
 227     }
 228
 229     public static Row executeDeleteQuery(Statement stmt) {
 230         Row row = null;
 231         if (!dryRun) {
 232             row = session.execute(stmt).one();
 233         }
 234
 235         return (row);
 236
 237     }
 238
 239     public static int acquireRunLock(String className) {
 240         Boolean testEnv = true;
 241         String envStr = env.getProperty("AFT_ENVIRONMENT");
 242
 243         if (envStr != null) {
 244             if ("AFTPRD".equals(envStr)) {
 245                 testEnv = false;
 246             }
 247         } else {
 248             env.fatal()
 249                     .log("AFT_ENVIRONMENT property is required and was not found. Exiting.");
 250             System.exit(1);
 251         }
 252
 253         if (testEnv) {
 254             env.info().log("TESTMODE: skipping RunLock");
 255             return (1);
 256         }
 257
 258         String hostname = null;
 259         try {
 260             hostname = InetAddress.getLocalHost().getHostName();
 261         } catch (UnknownHostException e) {
 262             e.printStackTrace();
 263             env.warn().log("Unable to get hostname");
 264             return (0);
 265         }
 266
 267         ResultSet existing = session.execute(String.format(
 268                 "select * from authz.run_lock where class = '%s'", className));
 269
 270         for (Row row : existing) {
 271             long curr = System.currentTimeMillis();
 272             ByteBuffer lastRun = row.getBytesUnsafe(2); // Can I get this field
 273                                                         // by name?
 274
 275             long interval = (1 * 60 * 1000); // @@ Create a value in props file
 276                                                 // for this
 277             long prev = lastRun.getLong();
 278
 279             if ((curr - prev) <= interval) {
 280                 env.warn().log(
 281                         String.format("Too soon! Last run was %d minutes ago.",
 282                                 ((curr - prev) / 1000) / 60));
 283                 env.warn().log(
 284                         String.format("Min time between runs is %d minutes ",
 285                                 (interval / 1000) / 60));
 286                 env.warn().log(
 287                         String.format("Last ran on machine: %s at %s",
 288                                 row.getString("host"), row.getDate("start")));
 289                 return (0);
 290             } else {
 291                 env.info().log("Delete old lock");
 292                 deleteLock(className);
 293             }
 294         }
 295
 296         GregorianCalendar current = new GregorianCalendar();
 297
 298         // We want our time in UTC, hence "+0000"
 299         SimpleDateFormat fmt = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss+0000");
 300         fmt.setTimeZone(TimeZone.getTimeZone("UTC"));
 301
 302         String cql = String
 303                 .format("INSERT INTO authz.run_lock (class,host,start) VALUES ('%s','%s','%s') IF NOT EXISTS",
 304                         className, hostname, fmt.format(current.getTime()));
 305
 306         env.info().log(cql);
 307
 308         Row row = session.execute(cql).one();
 309         if (!row.getBool("[applied]")) {
 310             env.warn().log("Lightweight Transaction failed to write lock.");
 311             env.warn().log(
 312                     String.format("host with lock: %s, running at %s",
 313                             row.getString("host"), row.getDate("start")));
 314             return (0);
 315         }
 316         return (1);
 317     }
 318
 319     private static void deleteLock( String className) {
 320         Row row = session.execute( String.format( "DELETE FROM authz.run_lock WHERE class = '%s' IF EXISTS", className ) ).one();
 321         if (! row.getBool("[applied]")) {
 322             env.info().log( "delete failed" );
 323         }
 324     }
 325
 326     private static void transferVMProps(AuthzEnv env, String ... props) {
 327         String value;
 328         for (String key : props) {
 329             if ((value = System.getProperty(key))!=null) {
 330                 env.setProperty(key, value);
 331             }
 332         }
 333     }
 334
 335     protected static File logDir() {
 336         if(logdir == null) {
 337                 String ld = env.getProperty(LOG_DIR);
 338                 if (ld==null) {
 339                     if (batchEnv==null) { // Deployed Batch doesn't use different ENVs, and a common logdir
 340                         ld = "logs/";
 341                     } else {
 342                         ld = "logs/"+batchEnv;
 343                     }
 344                 }
 345                 logdir = new File(ld);
 346                 if(!logdir.exists()) {
 347                         logdir.mkdirs();
 348                 }
 349         }
 350         return logdir;
 351     }
 352     protected int count(String str, char c) {
 353         if (str==null || str.isEmpty()) {
 354             return 0;
 355         } else {
 356             int count=1;
 357             for (int i=str.indexOf(c);i>=0;i=str.indexOf(c,i+1)) {
 358                 ++count;
 359             }
 360             return count;
 361         }
 362     }
 363
 364     public final void close(AuthzTrans trans) {
 365         _close(trans);
 366         cluster.close();
 367     }
 368
 369     public static void main(String[] args) {
 370         // Use a StringBuilder to save off logs until a File can be setup
 371         StringBuilderOutputStream sbos = new StringBuilderOutputStream();
 372         PropAccess access = new PropAccess(new PrintStream(sbos),args);
 373         access.log(Level.INIT, "------- Starting Batch ------\n  Args: ");
 374         for(String s: args) {
 375                 sbos.getBuffer().append(s);
 376                 sbos.getBuffer().append(' ');
 377         }
 378
 379         InputStream is = null;
 380         String filename;
 381         String propLoc;
 382         try {
 383             Define.set(access);
 384
 385             if(access.getProperty(Config.CADI_PROP_FILES)==null) {
 386                     File f = new File("authBatch.props");
 387                     try {
 388                         if (f.exists()) {
 389                             filename = f.getAbsolutePath();
 390                             is = new FileInputStream(f);
 391                             propLoc = f.getPath();
 392                         } else {
 393                             URL rsrc = ClassLoader.getSystemResource("authBatch.props");
 394                             filename = rsrc.toString();
 395                             is = rsrc.openStream();
 396                             propLoc = rsrc.getPath();
 397                         }
 398                         access.load(is);
 399                     } finally {
 400                         if (is == null) {
 401                             System.err.println("authBatch.props must exist in current dir, or in Classpath");
 402                             System.exit(1);
 403                         }
 404                         is.close();
 405                     }
 406                     if (filename != null) {
 407                         access.log(Level.INFO,"Instantiated properties from", filename);
 408                     }
 409
 410                     // Log where Config found
 411                     access.log(Level.INFO,"Configuring from", propLoc);
 412
 413             }
 414
 415             env = new AuthzEnv(access);
 416
 417             transferVMProps(env, CASS_ENV, "DRY_RUN", "NS", "Organization");
 418
 419             // Be able to change Environments
 420             // load extra properties, i.e.
 421             // PERF.cassandra.clusters=....
 422             batchEnv = env.getProperty(CASS_ENV);
 423             if(batchEnv!=null) {
 424                 batchEnv = batchEnv.trim();
 425             }
 426
 427             File logFile = new File(logDir() + "/batch" + Chrono.dateOnlyStamp(new Date()) + ".log" );
 428             PrintStream batchLog = new PrintStream(new FileOutputStream(logFile,true));
 429             try {
 430                     access.setStreamLogIt(batchLog);
 431                     sbos.flush();
 432                     batchLog.print(sbos.getBuffer());
 433                     sbos = null;
 434                     Logger.getRootLogger().addAppender(new Log4JAccessAppender(access));
 435
 436                     Batch batch = null;
 437                     AuthzTrans trans = env.newTrans();
 438
 439                     TimeTaken tt = trans.start("Total Run", Env.SUB);
 440                     try {
 441                         int len = args.length;
 442                         if (len > 0) {
 443                             String toolName = args[0];
 444                             len -= 1;
 445                             if (len < 0)
 446                                 len = 0;
 447                             String nargs[] = new String[len];
 448                             if (len > 0) {
 449                                 System.arraycopy(args, 1, nargs, 0, len);
 450                             }
 451
 452                             env.put(ssargs = env.staticSlot("ARGS"), nargs);
 453
 454                             /*
 455                              * Add New Batch Programs (inherit from Batch) here
 456                              */
 457
 458                             // Might be a Report, Update or Temp Batch
 459                             Class<?> cls = null;
 460                             String classifier = "";
 461
 462                             String[] pkgs = new String[] {
 463                                         "org.onap.aaf.auth.batch.update",
 464                                         "org.onap.aaf.auth.batch.reports",
 465                                         "org.onap.aaf.auth.batch.temp"
 466                                         };
 467
 468                             String ebp = env.getProperty("EXTRA_BATCH_PKGS");
 469                             if(ebp!=null) {
 470                                 String[] ebps = Split.splitTrim(':', ebp);
 471                                 String[] temp = new String[ebps.length + pkgs.length];
 472                                 System.arraycopy(pkgs,0, temp, 0, pkgs.length);
 473                                 System.arraycopy(ebps,0,temp,pkgs.length,ebps.length);
 474                                 pkgs = temp;
 475                             }
 476
 477                             for(String p : pkgs) {
 478                                     try {
 479                                         cls = ClassLoader.getSystemClassLoader().loadClass(p + '.' + toolName);
 480                                         int lastDot = p.lastIndexOf('.');
 481                                         if(p.length()>0 || p.length()!=lastDot) {
 482                                                 StringBuilder sb = new StringBuilder();
 483                                                 sb.append(Character.toUpperCase(p.charAt(++lastDot)));
 484                                                 while(++lastDot<p.length()) {
 485                                                         sb.append(p.charAt(lastDot));
 486                                                 }
 487                                                 sb.append(':');
 488                                                 classifier = sb.toString();
 489                                                 break;
 490                                         }
 491                                     } catch (ClassNotFoundException e) {
 492                                         cls = null;
 493                                     }
 494                             }
 495                             if (cls != null) {
 496                                 Constructor<?> cnst = cls.getConstructor(AuthzTrans.class);
 497                                 batch = (Batch) cnst.newInstance(trans);
 498                                 env.info().log("Begin", classifier, toolName);
 499                             }
 500
 501
 502                             if (batch == null) {
 503                                 trans.error().log("No Batch named", toolName, "found");
 504                             }
 505                             /*
 506                              * End New Batch Programs (inherit from Batch) here
 507                              */
 508
 509                         }
 510                         if (batch != null) {
 511                             batch.run(trans);
 512                         }
 513                     } finally {
 514                         tt.done();
 515                         if (batch != null) {
 516                             batch.close(trans);
 517                         }
 518                         StringBuilder sb = new StringBuilder("Task Times\n");
 519                         trans.auditTrail(4, sb, AuthzTrans.SUB, AuthzTrans.REMOTE);
 520                         trans.info().log(sb);
 521                     }
 522             } finally {
 523                 batchLog.close();
 524             }
 525
 526         } catch (Exception e) {
 527             e.printStackTrace(System.err);
 528             // Exceptions thrown by DB aren't stopping the whole process.
 529             System.exit(1);
 530         }
 531     }
 532
 533 }
 534