net.anotheria.anosite.content.variables.VariablesUtility Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ano-site Show documentation
There is a newer version: 4.1.2
 package net.anotheria.anosite.content.variables;

 import net.anotheria.util.StringUtils;
import net.anotheria.util.content.element.ContentElement;
import net.anotheria.util.content.element.DynamicElement;
import net.anotheria.util.content.element.StaticElement;

import jakarta.servlet.http.HttpServletRequest;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import static net.anotheria.util.content.TextReplaceConstants.*;

 /**
 * Utility for replacement of expressions with variables in texts. An expression consists of three parts:
 * {prefix:name:defaultValue}. The prefix tells the variable utility which processor to use, the name and default value are submitted to the processor in question.
 * @author lrosenberg
 */
public class VariablesUtility {
	/**
	 * Map with preconfigured processors.
	 */
	private static final Map defaultProcessors = new HashMap();
	 /**
	  * Map with configured localization bundle variable processors.
	  */
	private static final Map lbProcessors = new HashMap<>();
	
	static{
		defaultProcessors.put(DefinitionPrefixes.PREFIX_CALENDAR, new CalendarProcessor());
		defaultProcessors.put(DefinitionPrefixes.PREFIX_CONSTANT, new ConstantsProcessor());
		defaultProcessors.put(DefinitionPrefixes.PREFIX_PARAMETER, new ParameterProcessor());
		VariablesProcessor p = new AttributeProcessor();
		defaultProcessors.put(DefinitionPrefixes.PREFIX_REQUEST_ATTRIBUTE, p);
		defaultProcessors.put(DefinitionPrefixes.PREFIX_SESSION_ATTRIBUTE, p);
		defaultProcessors.put(DefinitionPrefixes.PREFIX_CONTEXT_ATTRIBUTE, p);
		defaultProcessors.put(DefinitionPrefixes.PREFIX_API_CALL_CONTEXT_ATTRIBUTE, p);
		defaultProcessors.put(DefinitionPrefixes.PREFIX_API_SESSION_ATTRIBUTE, p);
		defaultProcessors.put(DefinitionPrefixes.PREFIX_BOX_ATTRIBUTE, p);
		defaultProcessors.put(DefinitionPrefixes.PREFIX_PAGE_ATTRIBUTE, p);
		defaultProcessors.put(DefinitionPrefixes.PREFIX_BRAND_ATTRIBUTE, p);
		defaultProcessors.put(DefinitionPrefixes.PREFIX_LOCALIZATION_MESSAGE, new LocalizationProcessor());
		
		defaultProcessors.put(DefinitionPrefixes.PREFIX_IMAGE_LINK, new ImageLinkProcessor());
		defaultProcessors.put(DefinitionPrefixes.PREFIX_FILE_LINK, new FileLinkProcessor());
		defaultProcessors.put(DefinitionPrefixes.PREFIX_IMAGE, new ImageProcessor());
		
		p = new ConditionProcessor();
		defaultProcessors.put(DefinitionPrefixes.PREFIX_IF, p);
		defaultProcessors.put(DefinitionPrefixes.PREFIX_IF_NOT, p);
		defaultProcessors.put(DefinitionPrefixes.PREFIX_PRESENT, p);
		defaultProcessors.put(DefinitionPrefixes.PREFIX_NOT_PRESENT, p);
		defaultProcessors.put(DefinitionPrefixes.PREFIX_EQUALS, p);
		defaultProcessors.put(DefinitionPrefixes.PREFIX_NOT_EQUALS, p);
		defaultProcessors.put(DefinitionPrefixes.PREFIX_IN_RANGE, p);
        //ANO_SITE3
        defaultProcessors.put(DefinitionPrefixes.PREFIX_GREATERTHEN,p);
        defaultProcessors.put(DefinitionPrefixes.PREFIX_GREATEREQUAL,p);
        defaultProcessors.put(DefinitionPrefixes.PREFIX_LESSTHAN,p);
        defaultProcessors.put(DefinitionPrefixes.PREFIX_LESSEQUAL,p);


        //adding TextResourceProcessor
        defaultProcessors.put(TextResourceProcessor.PREFIX, new TextResourceProcessor());

		//adding static resource server processor
		defaultProcessors.put(StaticResourceServerNameProcessor.PREFIX, new StaticResourceServerNameProcessor());

	}
	

	/**
	 * Adds a processor to this variable utility.
	 * @param prefix prefix for processor mapping.
	 * @param processor processor.
	 */
	public static void addProcessor(String prefix, VariablesProcessor processor){
		defaultProcessors.put(prefix, processor);
	}

	 /**
	  * Add a processor for localization bundles.
	  *
	  * @param variable		prefix for processor mapping
	  * @param processor	{@link LocalizationBundleVariableProcessor} processor
	  */
	public static void addLocalizationBundleProcessor(String variable, LocalizationBundleVariableProcessor processor) {
		lbProcessors.put(variable, processor);
	}

	public static String replaceLocalizationBundleVariables(String source) {
		if (StringUtils.isEmpty(source))
			return source;

		for (String key: lbProcessors.keySet()) {
			if (source.contains(key)) {
				source = source.replace(key, lbProcessors.get(key).replace(key));
			}
		}
		return source;
	}

	public static Map getDefaultProcessors(){
		 HashMap ret = new HashMap();
		 ret.putAll(defaultProcessors);
		 return ret;
	}
	
	/**
	 * Replaces variable expressions in the given string src with help of default processors.
	 * @param req  TODO dummy comment for javadoc.
	 * @param src  TODO dummy comment for javadoc.
	 */
	public static String replaceVariables(HttpServletRequest req, String src){
		return replaceVariables(req, src, defaultProcessors);
	}
	
	/**
	 * Replaces variable expressions in the given string src with the help of submitted processors. Useful for variable customization.
	 * @param req request
	 * @param src source string
	 * @param processors processors
	 * @return returns a string with variables replaced.
	 */
	public static String replaceVariables(HttpServletRequest req, String src, Map processors){
		if(src == null || src.length() == 0)
			return src;
		List index = indexSource(src);
		return replaceVariables(req, index, processors);
	}
	
	public static String replaceVariables(HttpServletRequest req, List index, Map processors){
		StringBuilder ret = new StringBuilder();
		for(ContentElement el: index)
			ret.append(replaceContentElement(req, el, processors));
		return ret.toString();
	}

	public static List indexSource(String src){
		String myS = StringUtils.removeChar(src, '\r');
		List stringIndex = StringUtils.indexSuperTags(myS, TAG_START, TAG_END);
		List ret = new ArrayList(stringIndex.size());
		for(String s: stringIndex)
			ret.add(createContentElementInDynamic(s, TAG_START, TAG_END));
		return ret;
	}

	
	private static ContentElement createContentElementInDynamic(String elementText, char dynamicTagStart, char dynamicTagEnd){
		if(elementText.charAt(0) != dynamicTagStart)
			return new StaticElement(elementText);
		String varName = StringUtils.strip(elementText, 1, 1);
		char c = varName.charAt(0);
		if (c=='\t' || c==' ' || c=='\n' || c=='\r')
			return new StaticElement(elementText);
		
		if (varName!=null){
			if (varName.startsWith(QUOTE) && varName.endsWith(QUOTE))
				return new StaticElement(StringUtils.strip(varName, 1, 1));
		}
		
		List tokens = StringUtils.tokenize(varName, '{', '}', ':');
		if (tokens.size() < 2)
			return new StaticElement("Wrong format \""+varName+"\" expected: {prefix:varname[:default value]}");
		String prefix = tokens.get(0);
		String var = tokens.get(1);
		String defaultValue = tokens.size()>2? tokens.get(2):"";
//		System.out.println("Var:" + var);
		List varIndex = indexSource(var);
//		System.out.println("VarIndex size:" + varIndex.size());
//		System.out.println("DefValue:" + defaultValue);
		List defValueIndex = indexSource(defaultValue);
//		System.out.println("DefValueIndex size:" + defValueIndex.size());
		return new DynamicElement(elementText, prefix, varIndex, defValueIndex);
	}
	
	private static String replaceContentElement(HttpServletRequest req, ContentElement contentElement, Map processors){
		
//		System.out.println("Replace element[dinamic:"+contentElement.isDynamic()+"]: " + contentElement.getElementText());
		if(!contentElement.isDynamic())
			return contentElement.getElementText();
			
		DynamicElement dynIndex = (DynamicElement) contentElement;
		
		String prefix = dynIndex.getPrefix();
//		System.out.println("Prefix: " + prefix);
		String var = replaceVariables(req,dynIndex.getVariableIndex(),processors);
//		System.out.println("Var: " + var);
		String defaultValue = replaceVariables(req,dynIndex.getDefValueIndex(),processors);
//		System.out.println("DefValue: " + defaultValue);
		VariablesProcessor processor = processors.get(prefix);
		if (processor==null)
			return dynIndex.getElementText();
		return processor.replace(prefix, var, defaultValue, req);
	}
}