use of org.thymeleaf.engine.TemplateData in project thymeleaf by thymeleaf.
the class StandardMessageResolver method resolveMessage.
public final String resolveMessage(final ITemplateContext context, final Class<?> origin, final String key, final Object[] messageParameters, final boolean performTemplateBasedResolution, final boolean performOriginBasedResolution, final boolean performDefaultBasedResolution) {
Validate.notNull(context, "Context cannot be null");
Validate.notNull(context.getLocale(), "Locale in context cannot be null");
Validate.notNull(key, "Message key cannot be null");
final Locale locale = context.getLocale();
/*
* FIRST STEP: Look for the message using template-based resolution
*
* Note that resolution is top-down, this is, starts at the first-level template (the one being executed)
* and only if a key is not found will try resolving for nested templates in the order they have been nested.
*
* This allows container templates to override the messages defined in fragments, which will act as defaults.
*/
if (performTemplateBasedResolution) {
for (final TemplateData templateData : context.getTemplateStack()) {
final String template = templateData.getTemplate();
final ITemplateResource templateResource = templateData.getTemplateResource();
final boolean templateCacheable = templateData.getValidity().isCacheable();
Map<String, String> messagesForLocaleForTemplate;
// We will ONLY cache messages for cacheable templates. This should adequately control cache growth
if (templateCacheable) {
ConcurrentHashMap<Locale, Map<String, String>> messagesByLocaleForTemplate = this.messagesByLocaleByTemplate.get(template);
if (messagesByLocaleForTemplate == null) {
this.messagesByLocaleByTemplate.putIfAbsent(template, new ConcurrentHashMap<Locale, Map<String, String>>(4));
messagesByLocaleForTemplate = this.messagesByLocaleByTemplate.get(template);
}
messagesForLocaleForTemplate = messagesByLocaleForTemplate.get(locale);
if (messagesForLocaleForTemplate == null) {
messagesForLocaleForTemplate = resolveMessagesForTemplate(template, templateResource, locale);
if (messagesForLocaleForTemplate == null) {
messagesForLocaleForTemplate = Collections.emptyMap();
}
messagesByLocaleForTemplate.putIfAbsent(locale, messagesForLocaleForTemplate);
// We retrieve it again in order to be sure its the stored map (because of the 'putIfAbsent')
messagesForLocaleForTemplate = messagesByLocaleForTemplate.get(locale);
}
} else {
messagesForLocaleForTemplate = resolveMessagesForTemplate(template, templateResource, locale);
if (messagesForLocaleForTemplate == null) {
messagesForLocaleForTemplate = Collections.emptyMap();
}
}
// Once the messages map has been retrieved, just use it
final String message = messagesForLocaleForTemplate.get(key);
if (message != null) {
return formatMessage(locale, message, messageParameters);
}
// Will try the next resolver (if any)
}
}
/*
* SECOND STEP: Look for the message using origin-based resolution
*/
if (performOriginBasedResolution && origin != null) {
ConcurrentHashMap<Locale, Map<String, String>> messagesByLocaleForOrigin = this.messagesByLocaleByOrigin.get(origin);
if (messagesByLocaleForOrigin == null) {
this.messagesByLocaleByOrigin.putIfAbsent(origin, new ConcurrentHashMap<Locale, Map<String, String>>(4));
messagesByLocaleForOrigin = this.messagesByLocaleByOrigin.get(origin);
}
Map<String, String> messagesForLocaleForOrigin = messagesByLocaleForOrigin.get(locale);
if (messagesForLocaleForOrigin == null) {
messagesForLocaleForOrigin = resolveMessagesForOrigin(origin, locale);
if (messagesForLocaleForOrigin == null) {
messagesForLocaleForOrigin = Collections.emptyMap();
}
messagesByLocaleForOrigin.putIfAbsent(locale, messagesForLocaleForOrigin);
// We retrieve it again in order to be sure its the stored map (because of the 'putIfAbsent')
messagesForLocaleForOrigin = messagesByLocaleForOrigin.get(locale);
}
// Once the messages map has been retrieved, just use it
final String message = messagesForLocaleForOrigin.get(key);
if (message != null) {
return formatMessage(locale, message, messageParameters);
}
}
/*
* THIRD STEP: Try default messages.
*/
if (performDefaultBasedResolution && this.defaultMessages != null) {
final String message = this.defaultMessages.getProperty(key);
if (message != null) {
return formatMessage(locale, message, messageParameters);
}
}
/*
* NOT FOUND, return null
*/
return null;
}
use of org.thymeleaf.engine.TemplateData in project thymeleaf by thymeleaf.
the class ExecutionInfo method getTemplateNames.
/**
* <p>
* Returns the names of all the stack of templates appliable to the current point
* of execution. This will depend on which templates are inserted inside wich.
* </p>
* <p>
* The first-level template will appear first, and the most specific template will appear last.
* </p>
*
* @return the stack of template names
*/
public List<String> getTemplateNames() {
final List<TemplateData> templateStack = this.context.getTemplateStack();
final List<String> templateNameStack = new ArrayList<String>(templateStack.size());
for (final TemplateData templateData : templateStack) {
templateNameStack.add(templateData.getTemplate());
}
return templateNameStack;
}
use of org.thymeleaf.engine.TemplateData in project thymeleaf by thymeleaf.
the class ExecutionInfo method getTemplateModes.
/**
* <p>
* Returns the {@link TemplateMode}s of all the stack of templates appliable to the current point
* of execution. This will depend on which templates are inserted inside wich.
* </p>
* <p>
* The first-level template will appear first, and the most specific template will appear last.
* </p>
*
* @return the stack of template modes
*/
public List<TemplateMode> getTemplateModes() {
final List<TemplateData> templateStack = this.context.getTemplateStack();
final List<TemplateMode> templateModeStack = new ArrayList<TemplateMode>(templateStack.size());
for (final TemplateData templateData : templateStack) {
templateModeStack.add(templateData.getTemplateMode());
}
return templateModeStack;
}
use of org.thymeleaf.engine.TemplateData in project thymeleaf by thymeleaf.
the class AbstractStandardFragmentInsertionTagProcessor method doProcess.
@Override
protected void doProcess(final ITemplateContext context, final IProcessableElementTag tag, final AttributeName attributeName, final String attributeValue, final IElementTagStructureHandler structureHandler) {
if (StringUtils.isEmptyOrWhitespace(attributeValue)) {
throw new TemplateProcessingException("Fragment specifications cannot be empty");
}
final IEngineConfiguration configuration = context.getConfiguration();
/*
* PARSE AND PROCESS THE FRAGMENT
*/
final Object fragmentObj = computeFragment(context, attributeValue);
if (fragmentObj == null) {
throw new TemplateInputException("Error resolving fragment: \"" + attributeValue + "\": " + "template or fragment could not be resolved");
} else if (fragmentObj == NoOpToken.VALUE) {
// If the Fragment result is NO-OP, we will just do nothing (apart from deleting the th:* attribute)
return;
} else if (fragmentObj == Fragment.EMPTY_FRAGMENT) {
// tag (th:insert) or remove it completely, tag included (th:replace)
if (this.replaceHost) {
structureHandler.removeElement();
} else {
structureHandler.removeBody();
}
return;
}
final Fragment fragment = (Fragment) fragmentObj;
final TemplateModel fragmentModel = fragment.getTemplateModel();
Map<String, Object> fragmentParameters = fragment.getParameters();
/*
* ONCE WE HAVE THE FRAGMENT MODEL (its events, in fact), CHECK THE FRAGMENT SIGNATURE
* Fragment signature is important because it might affect the way we apply the parameters to the fragment.
*
* Note this works whatever the template mode of the inserted fragment, given we are looking for an
* element containing a "th:fragment/data-th-fragment" in a generic, non-template-dependent way.
*/
// We will check types first instead of events in order to (many times) avoid creating an immutably-wrapped
// event object when calling "model.get(pos)"
boolean signatureApplied = false;
final ITemplateEvent firstEvent = (fragmentModel.size() > 2 ? fragmentModel.get(1) : null);
if (firstEvent != null && IProcessableElementTag.class.isAssignableFrom(firstEvent.getClass())) {
final String dialectPrefix = attributeName.getPrefix();
final IProcessableElementTag fragmentHolderEvent = (IProcessableElementTag) firstEvent;
if (fragmentHolderEvent.hasAttribute(dialectPrefix, FRAGMENT_ATTR_NAME)) {
// The selected fragment actually has a "th:fragment" attribute, so we should process its signature
final String fragmentSignatureSpec = EscapedAttributeUtils.unescapeAttribute(fragmentModel.getTemplateMode(), fragmentHolderEvent.getAttributeValue(dialectPrefix, FRAGMENT_ATTR_NAME));
if (!StringUtils.isEmptyOrWhitespace(fragmentSignatureSpec)) {
final FragmentSignature fragmentSignature = FragmentSignatureUtils.parseFragmentSignature(configuration, fragmentSignatureSpec);
if (fragmentSignature != null) {
// Reshape the fragment parameters into the ones that we will actually use, according to the signature
fragmentParameters = FragmentSignatureUtils.processParameters(fragmentSignature, fragmentParameters, fragment.hasSyntheticParameters());
signatureApplied = true;
}
}
}
}
// not being applied, maybe not realising there was no signature assignation involved.
if (!signatureApplied && fragment.hasSyntheticParameters()) {
throw new TemplateProcessingException("Fragment '" + attributeValue + "' specifies synthetic (unnamed) parameters, but the resolved fragment " + "does not match a fragment signature (th:fragment,data-th-fragment) which could apply names to " + "the specified parameters.");
}
/*
* CHECK WHETHER THIS IS A CROSS-TEMPLATE-MODE INSERTION. Only TemplateModels for the same template mode
* can be safely inserted into the template being executed and processed just like any other sequences of
* events. If the inserted template has a different template mode, we will need to process it aside and
* obtain a String result for it, then insert such String as mere text.
*
* Note inserting large templates with a different template mode could therefore have a negative effect
* on performance and memory usage, as their result needs to be completely stored in memory at some point
* before being handled to the following phases of template processing. It is therefore recommended that
* cross-template-mode fragment insertion is done only for small fragments, in which case it will work
* almost the same as inlining (with the exception that the content to be inlined will be retrieved from
* somewhere else by means of template resolution).
*/
if (context.getTemplateMode() != fragmentModel.getTemplateMode()) {
// Check if this is a th:include. If so, just don't allow
if (this.insertOnlyContents) {
throw new TemplateProcessingException("Template being processed uses template mode " + context.getTemplateMode() + ", " + "inserted fragment \"" + attributeValue + "\" uses template mode " + fragmentModel.getTemplateMode() + ". Cross-template-mode fragment insertion is not " + "allowed using the " + attributeName + " attribute, which is no longer recommended for use as " + "of Thymeleaf 3.0. Use {th:insert,data-th-insert} or {th:replace,data-th-replace} " + "instead, which do not remove the container element from the fragment being inserted.");
}
// doing it through the structure handler (we are going to perform a nested template processing operation)
if (fragmentParameters != null && fragmentParameters.size() > 0) {
if (!(context instanceof IEngineContext)) {
throw new TemplateProcessingException("Parameterized fragment insertion is not supported because local variable support is DISABLED. This is due to " + "the use of an implementation of the " + ITemplateContext.class.getName() + " interface that does " + "not provide local-variable support. In order to have local-variable support, the variables map " + "implementation should also implement the " + IEngineContext.class.getName() + " interface");
}
// NOTE this IEngineContext interface is internal and should not be used in users' code
((IEngineContext) context).setVariables(fragmentParameters);
}
// Once parameters are in order, just process the template in a nested template engine execution
final Writer stringWriter = new FastStringWriter(200);
configuration.getTemplateManager().process(fragmentModel, context, stringWriter);
// We will insert the result as NON-PROCESSABLE text (it's already been processed!)
if (this.replaceHost) {
structureHandler.replaceWith(stringWriter.toString(), false);
} else {
structureHandler.setBody(stringWriter.toString(), false);
}
return;
}
/*
* APPLY THE FRAGMENT'S TEMPLATE RESOLUTION so that all code inside the fragment is executed with its own
* template resolution info (working as if it were a local variable)
*/
final TemplateData fragmentTemplateData = fragmentModel.getTemplateData();
structureHandler.setTemplateData(fragmentTemplateData);
/*
* APPLY THE FRAGMENT PARAMETERS AS LOCAL VARIABLES, perhaps after reshaping it according to the fragment signature
*/
if (fragmentParameters != null && fragmentParameters.size() > 0) {
for (final Map.Entry<String, Object> fragmentParameterEntry : fragmentParameters.entrySet()) {
structureHandler.setLocalVariable(fragmentParameterEntry.getKey(), fragmentParameterEntry.getValue());
}
}
/*
* IF WE ARE ASKING ONLY FOR CONTENTS (th:include), THEN REMOVE THE CONTAINER BLOCK
*/
if (this.insertOnlyContents && fragmentTemplateData.hasTemplateSelectors()) {
/*
* In the case of th:include, things get a bit complicated because we need to remove the "element envelopes"
* that contain what we really want to include (these envelopes' contents). So we will need to traverse
* the entire returned model detecting those envelopes (open+close tags at model level == 0) and remove
* them, along with anything else that is also at that level 0.
*/
final IModel model = fragmentModel.cloneModel();
int modelLevel = 0;
int n = model.size();
while (n-- != 0) {
// We traverse backwards so that we can modify at the same time
final ITemplateEvent event = model.get(n);
if (event instanceof ICloseElementTag) {
if (((ICloseElementTag) event).isUnmatched()) {
// This is an unmatched close tag (no corresponding open), therefore should not affect our count
continue;
}
if (modelLevel <= 0) {
model.remove(n);
}
modelLevel++;
continue;
}
if (event instanceof IOpenElementTag) {
modelLevel--;
if (modelLevel <= 0) {
model.remove(n);
}
continue;
}
if (modelLevel <= 0) {
model.remove(n);
}
}
if (this.replaceHost) {
structureHandler.replaceWith(model, true);
} else {
structureHandler.setBody(model, true);
}
return;
}
if (this.replaceHost) {
structureHandler.replaceWith(fragmentModel, true);
} else {
structureHandler.setBody(fragmentModel, true);
}
}
Aggregations