src/main/java/org/apache/log4j/chainsaw/color/RuleColorizer.java - logging-chainsaw - Git at Google

 /*
  * 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.log4j.chainsaw.color;

 import org.apache.log4j.chainsaw.ChainsawConstants;
 import org.apache.log4j.chainsaw.prefs.SettingsManager;
 import org.apache.log4j.rule.ColorRule;
 import org.apache.log4j.rule.ExpressionRule;
 import org.apache.log4j.rule.Rule;

 import java.awt.*;
 import java.beans.PropertyChangeListener;
 import java.beans.PropertyChangeSupport;
 import java.io.*;
 import java.net.URLEncoder;
 import java.util.*;
 import java.util.List;
 import org.apache.commons.configuration2.AbstractConfiguration;
 import org.apache.commons.configuration2.DataConfiguration;
 import org.apache.log4j.chainsaw.logevents.ChainsawLoggingEvent;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;


 /**
  * A colorizer supporting an ordered collection of ColorRules, including support for notification of
  * color rule changes via a propertyChangeListener and the 'colorrule' property.
  *
  * @author Scott Deboy &lt;sdeboy@apache.org&gt;
  */
 public class RuleColorizer implements Colorizer {
     private static final Logger logger = LogManager.getLogger();

     private List<ColorRule> rules;
     private final PropertyChangeSupport colorChangeSupport =
         new PropertyChangeSupport(this);
     private List<ColorRule> defaultRules = new ArrayList<>();
     private Rule findRule;
     private Rule loggerRule;
     private AbstractConfiguration m_configuration;
     private boolean m_isGlobal;

     private static final String COLORS_EXTENSION = ".colors";

     private static final Color WARN_DEFAULT_COLOR = new Color(255, 255, 153);
     private static final Color FATAL_OR_ERROR_DEFAULT_COLOR = new Color(255, 153, 153);
     private static final Color MARKER_DEFAULT_COLOR = new Color(153, 255, 153);

     private static final String DEFAULT_WARN_EXPRESSION = "level == WARN";
     private static final String DEFAULT_FATAL_ERROR_EXCEPTION_EXPRESSION = "level == FATAL || level == ERROR || exception exists";
     private static final String DEFAULT_MARKER_EXPRESSION = "prop.marker exists";

     public static List<ColorRule> defaultRules(){
         List<ColorRule> rulesList = new ArrayList<>();

         String expression = DEFAULT_FATAL_ERROR_EXCEPTION_EXPRESSION;
         rulesList.add(
             new ColorRule(
                 expression, ExpressionRule.getRule(expression), FATAL_OR_ERROR_DEFAULT_COLOR,
                 Color.black));
         expression = DEFAULT_WARN_EXPRESSION;
         rulesList.add(
             new ColorRule(
                 expression, ExpressionRule.getRule(expression), WARN_DEFAULT_COLOR,
                 Color.black));

         expression = DEFAULT_MARKER_EXPRESSION;
         rulesList.add(
             new ColorRule(
                 expression, ExpressionRule.getRule(expression), MARKER_DEFAULT_COLOR,
                 Color.black));

         return rulesList;
     }

     public RuleColorizer() {
         this.rules = defaultRules();
         m_isGlobal = false;
     }

     public RuleColorizer(boolean isGlobal){
         this.rules = defaultRules();
         m_isGlobal = isGlobal;
     }

     public void setLoggerRule(Rule loggerRule) {
         this.loggerRule = loggerRule;
         colorChangeSupport.firePropertyChange("colorrule", false, true);
     }

     public void setFindRule(Rule findRule) {
         this.findRule = findRule;
         colorChangeSupport.firePropertyChange("colorrule", false, true);
     }

     public Rule getFindRule() {
         return findRule;
     }

     public Rule getLoggerRule() {
         return loggerRule;
     }

     public void setRules(List<ColorRule> rules) {
         this.rules.clear();
         this.rules.addAll(rules);
         colorChangeSupport.firePropertyChange("colorrule", false, true);

         saveColorSettings();
     }

     public List<ColorRule> getRules() {
         return rules;
     }

     public void addRules(List<ColorRule> newRules) {
         rules.addAll( newRules );

         colorChangeSupport.firePropertyChange("colorrule", false, true);

         saveColorSettings();
     }

     public void addRule(ColorRule rule) {
         rules.add(rule);

         colorChangeSupport.firePropertyChange("colorrule", false, true);

         saveColorSettings();
     }

     public void removeRule(String expression) {
         rules.removeIf( x -> x.getExpression().equals( expression ) );
     }

     public Color getBackgroundColor(ChainsawLoggingEvent event) {
         for (ColorRule rule : rules) {

             if ((rule.getBackgroundColor() != null) && (rule.evaluate(event, null))) {
                 return rule.getBackgroundColor();
             }
         }

         return null;
     }

     public Color getForegroundColor(ChainsawLoggingEvent event) {
         for (ColorRule rule : rules) {

             if ((rule.getForegroundColor() != null) && (rule.evaluate(event, null))) {
                 return rule.getForegroundColor();
             }
         }

         return null;
     }

     public void addPropertyChangeListener(PropertyChangeListener listener) {
         colorChangeSupport.addPropertyChangeListener(listener);
     }

     public void removePropertyChangeListener(PropertyChangeListener listener) {
         colorChangeSupport.removePropertyChangeListener(listener);
     }

     /**
      * @param propertyName
      * @param listener
      */
     public void addPropertyChangeListener(
         String propertyName, PropertyChangeListener listener) {
         colorChangeSupport.addPropertyChangeListener(propertyName, listener);
     }

     public void setConfiguration(AbstractConfiguration configuration){
         m_configuration = configuration;
     }

     public void setUseDefaultSettings(boolean useDefaultSettings){
         if( m_configuration == SettingsManager.getInstance().getGlobalConfiguration() ){
             return;
         }

         m_configuration.setProperty( "color.rules.default", useDefaultSettings );
     }

     public static String colorToRGBString( Color c ){
         return String.format( "#%02x%02x%02x",
                 c.getRed(),
                 c.getGreen(),
                 c.getBlue());
     }

     private void saveColorSettings(){
         if( m_configuration == null ){
             return;
         }

         DataConfiguration data = new DataConfiguration(m_configuration);

         if( !m_isGlobal && m_configuration.getBoolean( "color.rules.default", true ) ){
             // No need to save, using the default rules
             return;
         }

         for( int x = 0; x < 32; x++ ){
             String baseConfigKey = "color.rules(" + x + ")";

             if( rules.size() <= x ){
                 break;
             }

             ColorRule rule = rules.get(x);

             logger.debug( "Saving rule {}.  Expression: {}", x, rule.getExpression() );

             m_configuration.setProperty( baseConfigKey + ".expression", rule.getExpression() );
             String bgColorString = colorToRGBString(rule.getBackgroundColor());
             String fgColorString = colorToRGBString(rule.getForegroundColor());
             data.setProperty( baseConfigKey + ".backgroundColor", bgColorString );
             data.setProperty( baseConfigKey + ".foregroundColor", fgColorString );
         }

         logger.debug( "all keys for {}:", m_configuration );
         java.util.Iterator<String> s = m_configuration.getKeys();
         while( s.hasNext() ){
             logger.debug( "found key: {}", s.next() );
         }
     }

     public void loadColorSettings() {
         // When we save/load the rule, we really need to load a map of rules
         // There's no real good way to do this, so we will do this the somewhat
         // dumb way and just load up to 32 color rules, since that seems like
         // a good number
         List<ColorRule> newRules = new ArrayList<>();
         AbstractConfiguration configuration = m_configuration;

         DataConfiguration data = new DataConfiguration(configuration);

         for( int x = 0; x < 32; x++ ){
             String baseConfigKey = "color.rules(" + x + ")";
             String expression;
             Color backgroundColor;
             Color foregroundColor;

             expression = configuration.getString( baseConfigKey + ".expression" );
             backgroundColor = data.getColor( baseConfigKey + ".backgroundColor" );
             foregroundColor = data.getColor( baseConfigKey + ".foregroundColor" );

             if( expression == null ||
                     backgroundColor == null ||
                     foregroundColor == null ){
                 continue;
             }

             Rule simpleRule = ExpressionRule.getRule(expression);
             ColorRule rule = new ColorRule( expression, simpleRule, backgroundColor, foregroundColor );
             newRules.add( rule );
         }

         setRules(newRules);
     }

     private boolean doLoadColorSettings(String name) {
         //first attempt to load encoded file
         File f = new File(SettingsManager.getInstance().getSettingsDirectory(), URLEncoder.encode(name) + COLORS_EXTENSION);

         if (f.exists()) {
             ObjectInputStream s = null;

             try {
                 s = new ObjectInputStream(
                     new BufferedInputStream(new FileInputStream(f)));

                 Map map = (Map) s.readObject();
 //                setRules(map);
             } catch (EOFException eof) { //end of file - ignore..
             } catch (IOException ioe) {
                 ioe.printStackTrace();
                 //unable to load file - delete it
                 f.delete();
             } catch (ClassNotFoundException cnfe) {
                 cnfe.printStackTrace();
             } finally {
                 if (s != null) {
                     try {
                         s.close();
                     } catch (IOException ioe) {
                         ioe.printStackTrace();
                     }
                 }
             }
         }
         return f.exists();
     }

     public static List<Color> getDefaultColors() {
         List<Color> vec = new ArrayList<>();

         vec.add(Color.white);
         vec.add(Color.black);
         //add default alternating color & search backgrounds (both foreground are black)
         vec.add(ChainsawConstants.COLOR_ODD_ROW_BACKGROUND);
         vec.add(ChainsawConstants.FIND_LOGGER_BACKGROUND);

         vec.add(new Color(255, 255, 225));
         vec.add(new Color(255, 225, 255));
         vec.add(new Color(225, 255, 255));
         vec.add(new Color(255, 225, 225));
         vec.add(new Color(225, 255, 225));
         vec.add(new Color(225, 225, 255));
         vec.add(new Color(225, 225, 183));
         vec.add(new Color(225, 183, 225));
         vec.add(new Color(183, 225, 225));
         vec.add(new Color(183, 225, 183));
         vec.add(new Color(183, 183, 225));
         vec.add(new Color(232, 201, 169));
         vec.add(new Color(255, 255, 153));
         vec.add(new Color(255, 153, 153));
         vec.add(new Color(189, 156, 89));
         vec.add(new Color(255, 102, 102));
         vec.add(new Color(255, 177, 61));
         vec.add(new Color(61, 255, 61));
         vec.add(new Color(153, 153, 255));
         vec.add(new Color(255, 153, 255));

         return vec;
     }

 }
	/*
	* 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.log4j.chainsaw.color;

	import org.apache.log4j.chainsaw.ChainsawConstants;
	import org.apache.log4j.chainsaw.prefs.SettingsManager;
	import org.apache.log4j.rule.ColorRule;
	import org.apache.log4j.rule.ExpressionRule;
	import org.apache.log4j.rule.Rule;

	import java.awt.*;
	import java.beans.PropertyChangeListener;
	import java.beans.PropertyChangeSupport;
	import java.io.*;
	import java.net.URLEncoder;
	import java.util.*;
	import java.util.List;
	import org.apache.commons.configuration2.AbstractConfiguration;
	import org.apache.commons.configuration2.DataConfiguration;
	import org.apache.log4j.chainsaw.logevents.ChainsawLoggingEvent;
	import org.apache.logging.log4j.LogManager;
	import org.apache.logging.log4j.Logger;


	/**
	* A colorizer supporting an ordered collection of ColorRules, including support for notification of
	* color rule changes via a propertyChangeListener and the 'colorrule' property.
	*
	* @author Scott Deboy <sdeboy@apache.org>
	*/
	public class RuleColorizer implements Colorizer {
	private static final Logger logger = LogManager.getLogger();

	private List<ColorRule> rules;
	private final PropertyChangeSupport colorChangeSupport =
	new PropertyChangeSupport(this);
	private List<ColorRule> defaultRules = new ArrayList<>();
	private Rule findRule;
	private Rule loggerRule;
	private AbstractConfiguration m_configuration;
	private boolean m_isGlobal;

	private static final String COLORS_EXTENSION = ".colors";

	private static final Color WARN_DEFAULT_COLOR = new Color(255, 255, 153);
	private static final Color FATAL_OR_ERROR_DEFAULT_COLOR = new Color(255, 153, 153);
	private static final Color MARKER_DEFAULT_COLOR = new Color(153, 255, 153);

	private static final String DEFAULT_WARN_EXPRESSION = "level == WARN";
	private static final String DEFAULT_FATAL_ERROR_EXCEPTION_EXPRESSION = "level == FATAL \|\| level == ERROR \|\| exception exists";
	private static final String DEFAULT_MARKER_EXPRESSION = "prop.marker exists";

	public static List<ColorRule> defaultRules(){
	List<ColorRule> rulesList = new ArrayList<>();

	String expression = DEFAULT_FATAL_ERROR_EXCEPTION_EXPRESSION;
	rulesList.add(
	new ColorRule(
	expression, ExpressionRule.getRule(expression), FATAL_OR_ERROR_DEFAULT_COLOR,
	Color.black));
	expression = DEFAULT_WARN_EXPRESSION;
	rulesList.add(
	new ColorRule(
	expression, ExpressionRule.getRule(expression), WARN_DEFAULT_COLOR,
	Color.black));

	expression = DEFAULT_MARKER_EXPRESSION;
	rulesList.add(
	new ColorRule(
	expression, ExpressionRule.getRule(expression), MARKER_DEFAULT_COLOR,
	Color.black));

	return rulesList;
	}

	public RuleColorizer() {
	this.rules = defaultRules();
	m_isGlobal = false;
	}

	public RuleColorizer(boolean isGlobal){
	this.rules = defaultRules();
	m_isGlobal = isGlobal;
	}

	public void setLoggerRule(Rule loggerRule) {
	this.loggerRule = loggerRule;
	colorChangeSupport.firePropertyChange("colorrule", false, true);
	}

	public void setFindRule(Rule findRule) {
	this.findRule = findRule;
	colorChangeSupport.firePropertyChange("colorrule", false, true);
	}

	public Rule getFindRule() {
	return findRule;
	}

	public Rule getLoggerRule() {
	return loggerRule;
	}

	public void setRules(List<ColorRule> rules) {
	this.rules.clear();
	this.rules.addAll(rules);
	colorChangeSupport.firePropertyChange("colorrule", false, true);

	saveColorSettings();
	}

	public List<ColorRule> getRules() {
	return rules;
	}

	public void addRules(List<ColorRule> newRules) {
	rules.addAll( newRules );

	colorChangeSupport.firePropertyChange("colorrule", false, true);

	saveColorSettings();
	}

	public void addRule(ColorRule rule) {
	rules.add(rule);

	colorChangeSupport.firePropertyChange("colorrule", false, true);

	saveColorSettings();
	}

	public void removeRule(String expression) {
	rules.removeIf( x -> x.getExpression().equals( expression ) );
	}

	public Color getBackgroundColor(ChainsawLoggingEvent event) {
	for (ColorRule rule : rules) {

	if ((rule.getBackgroundColor() != null) && (rule.evaluate(event, null))) {
	return rule.getBackgroundColor();
	}
	}

	return null;
	}

	public Color getForegroundColor(ChainsawLoggingEvent event) {
	for (ColorRule rule : rules) {

	if ((rule.getForegroundColor() != null) && (rule.evaluate(event, null))) {
	return rule.getForegroundColor();
	}
	}

	return null;
	}

	public void addPropertyChangeListener(PropertyChangeListener listener) {
	colorChangeSupport.addPropertyChangeListener(listener);
	}

	public void removePropertyChangeListener(PropertyChangeListener listener) {
	colorChangeSupport.removePropertyChangeListener(listener);
	}

	/**
	* @param propertyName
	* @param listener
	*/
	public void addPropertyChangeListener(
	String propertyName, PropertyChangeListener listener) {
	colorChangeSupport.addPropertyChangeListener(propertyName, listener);
	}

	public void setConfiguration(AbstractConfiguration configuration){
	m_configuration = configuration;
	}

	public void setUseDefaultSettings(boolean useDefaultSettings){
	if( m_configuration == SettingsManager.getInstance().getGlobalConfiguration() ){
	return;
	}

	m_configuration.setProperty( "color.rules.default", useDefaultSettings );
	}

	public static String colorToRGBString( Color c ){
	return String.format( "#%02x%02x%02x",
	c.getRed(),
	c.getGreen(),
	c.getBlue());
	}

	private void saveColorSettings(){
	if( m_configuration == null ){
	return;
	}

	DataConfiguration data = new DataConfiguration(m_configuration);

	if( !m_isGlobal && m_configuration.getBoolean( "color.rules.default", true ) ){
	// No need to save, using the default rules
	return;
	}

	for( int x = 0; x < 32; x++ ){
	String baseConfigKey = "color.rules(" + x + ")";

	if( rules.size() <= x ){
	break;
	}

	ColorRule rule = rules.get(x);

	logger.debug( "Saving rule {}. Expression: {}", x, rule.getExpression() );

	m_configuration.setProperty( baseConfigKey + ".expression", rule.getExpression() );
	String bgColorString = colorToRGBString(rule.getBackgroundColor());
	String fgColorString = colorToRGBString(rule.getForegroundColor());
	data.setProperty( baseConfigKey + ".backgroundColor", bgColorString );
	data.setProperty( baseConfigKey + ".foregroundColor", fgColorString );
	}

	logger.debug( "all keys for {}:", m_configuration );
	java.util.Iterator<String> s = m_configuration.getKeys();
	while( s.hasNext() ){
	logger.debug( "found key: {}", s.next() );
	}
	}

	public void loadColorSettings() {
	// When we save/load the rule, we really need to load a map of rules
	// There's no real good way to do this, so we will do this the somewhat
	// dumb way and just load up to 32 color rules, since that seems like
	// a good number
	List<ColorRule> newRules = new ArrayList<>();
	AbstractConfiguration configuration = m_configuration;

	DataConfiguration data = new DataConfiguration(configuration);

	for( int x = 0; x < 32; x++ ){
	String baseConfigKey = "color.rules(" + x + ")";
	String expression;
	Color backgroundColor;
	Color foregroundColor;

	expression = configuration.getString( baseConfigKey + ".expression" );
	backgroundColor = data.getColor( baseConfigKey + ".backgroundColor" );
	foregroundColor = data.getColor( baseConfigKey + ".foregroundColor" );

	if( expression == null \|\|
	backgroundColor == null \|\|
	foregroundColor == null ){
	continue;
	}

	Rule simpleRule = ExpressionRule.getRule(expression);
	ColorRule rule = new ColorRule( expression, simpleRule, backgroundColor, foregroundColor );
	newRules.add( rule );
	}

	setRules(newRules);
	}

	private boolean doLoadColorSettings(String name) {
	//first attempt to load encoded file
	File f = new File(SettingsManager.getInstance().getSettingsDirectory(), URLEncoder.encode(name) + COLORS_EXTENSION);

	if (f.exists()) {
	ObjectInputStream s = null;

	try {
	s = new ObjectInputStream(
	new BufferedInputStream(new FileInputStream(f)));

	Map map = (Map) s.readObject();
	// setRules(map);
	} catch (EOFException eof) { //end of file - ignore..
	} catch (IOException ioe) {
	ioe.printStackTrace();
	//unable to load file - delete it
	f.delete();
	} catch (ClassNotFoundException cnfe) {
	cnfe.printStackTrace();
	} finally {
	if (s != null) {
	try {
	s.close();
	} catch (IOException ioe) {
	ioe.printStackTrace();
	}
	}
	}
	}
	return f.exists();
	}

	public static List<Color> getDefaultColors() {
	List<Color> vec = new ArrayList<>();

	vec.add(Color.white);
	vec.add(Color.black);
	//add default alternating color & search backgrounds (both foreground are black)
	vec.add(ChainsawConstants.COLOR_ODD_ROW_BACKGROUND);
	vec.add(ChainsawConstants.FIND_LOGGER_BACKGROUND);

	vec.add(new Color(255, 255, 225));
	vec.add(new Color(255, 225, 255));
	vec.add(new Color(225, 255, 255));
	vec.add(new Color(255, 225, 225));
	vec.add(new Color(225, 255, 225));
	vec.add(new Color(225, 225, 255));
	vec.add(new Color(225, 225, 183));
	vec.add(new Color(225, 183, 225));
	vec.add(new Color(183, 225, 225));
	vec.add(new Color(183, 225, 183));
	vec.add(new Color(183, 183, 225));
	vec.add(new Color(232, 201, 169));
	vec.add(new Color(255, 255, 153));
	vec.add(new Color(255, 153, 153));
	vec.add(new Color(189, 156, 89));
	vec.add(new Color(255, 102, 102));
	vec.add(new Color(255, 177, 61));
	vec.add(new Color(61, 255, 61));
	vec.add(new Color(153, 153, 255));
	vec.add(new Color(255, 153, 255));

	return vec;
	}

	}