com.itextpdf.commons.actions.producer.ProducerBuilder Maven / Gradle / Ivy
/*
This file is part of the iText (R) project.
Copyright (c) 1998-2024 Apryse Group NV
Authors: Apryse Software.
This program is offered under a commercial and under the AGPL license.
For commercial licensing, contact us at https://itextpdf.com/sales. For AGPL licensing, see below.
AGPL licensing:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see ${ and ended with } without } character inside.
* These substrings are interpreted as placeholders and the first group is the content of the
* placeholder.
* Note: The escape on '}' is necessary for regex dialect compatibility reasons.
*/
private static final String PATTERN_STRING = "\\$\\{([^}]*)\\}";
private static final Pattern PATTERN = Pattern.compile(PATTERN_STRING);
private static final Map PLACEHOLDER_POPULATORS;
static {
final Map populators = new HashMap<>();
populators.put(CURRENT_DATE, new CurrentDatePlaceholderPopulator());
populators.put(USED_PRODUCTS, new UsedProductsPlaceholderPopulator());
populators.put(COPYRIGHT_SINCE, new CopyrightSincePlaceholderPopulator());
populators.put(COPYRIGHT_TO, new CopyrightToPlaceholderPopulator());
PLACEHOLDER_POPULATORS = Collections.unmodifiableMap(populators);
}
private ProducerBuilder() { }
/**
* Modifies an old producer line according to events registered for the document.
* Events can be either wrapped with {@link ConfirmedEventWrapper} or not.
* Format of the new producer line will be defined by the first event in the list.
* Placeholder will be replaced and merged all together.
*
* @param events list of events registered for the document
* @param oldProducer old producer line. If null or empty, will be replaced
* with a new one. Otherwise new line will be attached with
* modified using prefix. If old producer line already contains
* modified using itext substring with the current version of itext at the end,
* no changes will be made
* @return modified producer line
*/
public static String modifyProducer(List events, String oldProducer) {
List confirmedEvents = new ArrayList<>();
if (events != null) {
for (AbstractProductProcessITextEvent event : events) {
if (event instanceof ConfirmedEventWrapper) {
confirmedEvents.add((ConfirmedEventWrapper) event);
} else {
ITextProductEventProcessor processor = INSTANCE.getActiveProcessor(event.getProductName());
confirmedEvents.add(new ConfirmedEventWrapper(event, processor.getUsageType(), processor.getProducer()));
}
}
}
final String newProducer = buildProducer(confirmedEvents);
if (oldProducer == null || oldProducer.isEmpty()) {
return newProducer;
} else {
//if the last time document was modified or created with the itext of the same version,
//then no changes occur.
if (oldProducer.equals(newProducer)
|| oldProducer.endsWith(MODIFIED_USING + newProducer)) {
return oldProducer;
} else {
return oldProducer + MODIFIED_USING + newProducer;
}
}
}
/**
* Configuration events for util internal purposes are not expected to be sent.
*
* @throws IllegalStateException on every method call
*/
@Override
protected void doAction() {
throw new IllegalStateException("Configuration events for util internal purposes are not expected to be sent");
}
private static String buildProducer(List events) {
if (events == null || events.isEmpty()) {
throw new IllegalArgumentException(
CommonsExceptionMessageConstant.NO_EVENTS_WERE_REGISTERED_FOR_THE_DOCUMENT);
}
// we expects here that the first event was thrown by
// the addon which may be considered as entry point of
// document processing
final String producer = events.get(0).getProducerLine();
return populatePlaceholders(producer, events);
}
private static String populatePlaceholders(String producerLine, List events) {
int lastIndex = 0;
Matcher matcher = PATTERN.matcher(producerLine);
final StringBuilder builder = new StringBuilder();
while (matcher.find()) {
builder.append(producerLine.substring(lastIndex, matcher.start()));
lastIndex = matcher.end();
final String placeholder = matcher.group(1);
final int delimiterPosition = placeholder.indexOf(FORMAT_DELIMITER);
String placeholderName;
String parameter = null;
if (placeholder.indexOf(FORMAT_DELIMITER) == -1) {
placeholderName = placeholder;
} else {
placeholderName = placeholder.substring(0, delimiterPosition);
parameter = placeholder.substring(delimiterPosition + 1);
}
final IPlaceholderPopulator populator = PLACEHOLDER_POPULATORS.get(placeholderName);
if (populator == null) {
LOGGER.info(MessageFormatUtil.format(
CommonsLogMessageConstant.UNKNOWN_PLACEHOLDER_WAS_IGNORED, placeholderName));
} else {
builder.append(populator.populate(events, parameter));
}
}
builder.append(producerLine.substring(lastIndex));
return builder.toString();
}
}