content: /**
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements.  See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to You under the Apache License, Version 2.0
   * (the "License"); you may not use this file except in compliance with
   * the License.  You may obtain a copy of the License at
   *
   *     http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  package org.apache.solr.update.processor;
  
  import java.io.IOException;
  import java.util.ArrayList;
  import java.util.List;
  
  import org.apache.solr.common.params.SolrParams;
  import org.apache.solr.common.util.NamedList;
  import org.apache.solr.common.util.SimpleOrderedMap;
  import org.apache.solr.request.SolrQueryRequest;
  import org.apache.solr.response.SolrQueryResponse;
  import org.apache.solr.update.AddUpdateCommand;
  import org.apache.solr.update.CommitUpdateCommand;
  import org.apache.solr.update.DeleteUpdateCommand;
  import org.apache.solr.update.MergeIndexesCommand;
  import org.apache.solr.update.RollbackUpdateCommand;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * A logging processor.  This keeps track of all commands that have passed through
   * the chain and prints them on finish().  At the Debug (FINE) level, a message
   * will be logged for each command prior to the next stage in the chain.
   * 
   * If the Log level is not >= INFO the processor will not be created or added to the chain.
   * 
   * @since solr 1.3
   */
  public class LogUpdateProcessorFactory extends UpdateRequestProcessorFactory {
    
    int maxNumToLog = 8;
    
    @Override
    public void init( final NamedList args ) {
      if( args != null ) {
        SolrParams params = SolrParams.toSolrParams( args );
        maxNumToLog = params.getInt( "maxNumToLog", maxNumToLog );
      }
    }
  
    @Override
    public UpdateRequestProcessor getInstance(SolrQueryRequest req, SolrQueryResponse rsp, UpdateRequestProcessor next) {
      final Logger logger = LoggerFactory.getLogger(LogUpdateProcessor.class);
      boolean doLog = logger.isInfoEnabled();
      // LogUpdateProcessor.log.error("Will Log=" + doLog);
      if( doLog ) {
        // only create the log processor if we will use it
        final LogUpdateProcessor processor = new LogUpdateProcessor(req, rsp, this, next);
        assert processor.log == logger;
        return processor;
      }
      return null;
    }
  }
  
  class LogUpdateProcessor extends UpdateRequestProcessor {
    private final SolrQueryRequest req;
    private final SolrQueryResponse rsp;
    private final NamedList<Object> toLog;
  
    int numAdds;
    int numDeletes;
  
    // hold on to the added list for logging and the response
    private List<String> adds;
    private List<String> deletes;
  
    private final int maxNumToLog;
  
    private final boolean logDebug = log.isDebugEnabled();//cache to avoid volatile-read
  
    public LogUpdateProcessor(SolrQueryRequest req, SolrQueryResponse rsp, LogUpdateProcessorFactory factory, UpdateRequestProcessor next) {
      super( next );
      this.req = req;
      this.rsp = rsp;
      maxNumToLog = factory.maxNumToLog;  // TODO: make configurable
      // TODO: make log level configurable as well, or is that overkill?
      // (ryan) maybe?  I added it mostly to show that it *can* be configurable
  
      this.toLog = new SimpleOrderedMap<Object>();
    }
    
    @Override
    public void processAdd(AddUpdateCommand cmd) throws IOException {
      // Add a list of added id's to the response
      if (adds == null) {
        adds = new ArrayList<String>();
        toLog.add("add",adds);
      }
  
      if (adds.size() < maxNumToLog) {
        adds.add(cmd.getPrintableId(req.getSchema()));
      }
  //    if (logDebug) { log.debug("add {}", cmd.getPrintableId(req.getSchema())); }
  
      numAdds++;
  
      if (next != null) next.processAdd(cmd);
    }
  
    @Override
    public void processDelete( DeleteUpdateCommand cmd ) throws IOException {
      if (cmd.id != null) {
        if (deletes == null) {
          deletes = new ArrayList<String>();
          toLog.add("delete",deletes);
        }
        if (deletes.size() < maxNumToLog) {
          deletes.add(cmd.id);
        }
        if (logDebug) { log.debug("delete {}", cmd.id); }
      } else {
        if (toLog.size() < maxNumToLog) {
          toLog.add("deleteByQuery", cmd.query);
        }
        if (logDebug) { log.debug("deleteByQuery {}", cmd.query); }
      }
      numDeletes++;
  
      if (next != null) next.processDelete(cmd);
    }
  
    @Override
    public void processMergeIndexes(MergeIndexesCommand cmd) throws IOException {
      toLog.add("mergeIndexes", cmd.toString());
      if (logDebug) { log.debug("mergeIndexes {}",cmd.toString()); }
  
      if (next != null) next.processMergeIndexes(cmd);
    }
  
    @Override
    public void processCommit( CommitUpdateCommand cmd ) throws IOException {
      final String msg = cmd.optimize ? "optimize" : "commit";
      toLog.add(msg, "");
      if (logDebug) { log.debug(msg); }
  
      if (next != null) next.processCommit(cmd);
    }
  
    /**
     * @since Solr 1.4
     */
    @Override
    public void processRollback( RollbackUpdateCommand cmd ) throws IOException {
      toLog.add("rollback", "");
      if (logDebug) { log.debug("rollback"); }
  
      if (next != null) next.processRollback(cmd);
    }
  
  
    @Override
    public void finish() throws IOException {
      if (next != null) next.finish();
  
      // LOG A SUMMARY WHEN ALL DONE (INFO LEVEL)
      
      // TODO: right now, update requests are logged twice...
      // this will slow down things compared to Solr 1.2
      // we should have extra log info on the SolrQueryResponse, to
      // be logged by SolrCore
      
      // if id lists were truncated, show how many more there were
      if (adds != null && numAdds > maxNumToLog) {
        adds.add("... (" + numAdds + " adds)");
      }
      if (deletes != null && numDeletes > maxNumToLog) {
        deletes.add("... (" + numDeletes + " deletes)");
      }
      long elapsed = rsp.getEndTime() - req.getStartTime();
      log.info( ""+toLog + " 0 " + (elapsed) );
    }
  }
  
  
  
  