Datasets:

JetBrains-Research

/

lca-bug-localization

like 1

Follow

JetBrains Research 47

adobe-consulting-services/acs-aem-commons/379/378

adobe-consulting-services

acs-aem-commons

https://github.com/Adobe-Consulting-Services/acs-aem-commons/issues/378

https://github.com/Adobe-Consulting-Services/acs-aem-commons/pull/379

https://github.com/Adobe-Consulting-Services/acs-aem-commons/pull/379

fix

Component,Page Error Handler - Not rendering html snippets in edit, preview mode when component throws error

Component error handler is not working as expected in AEM 6.0+service pack 1 and in some scenerios mentioned below impacting error handler as well. We are using latest released ACS commons package at https://github.com/Adobe-Consulting-Services/acs-aem-commons/releases/tag/acs-aem-commons-1.9.2 Publisher Instance: Seems to render the html snippet and works fine. Author instance (both classic and touch ui) If there is a scripting or any exception thrown by the component. Check for the scenerios - Not rending the respective html snippets configured in the edit, preview mode if the page has component throwing exception. - Working for publish view using http://localhost:4502/content/geometrixx/en.html?wcmmode=disabled - Rending the respective html snippets configured in the edit, preview mode of the component error handler configuration if the page accessed doesn't not exits (404) and ACS commons error page handler is configured. - Above is working for publish view using http://localhost:4502/content/geometrixx/en.html?wcmmode=disabled - In touch UI, if we access 404 page, it takes to http://localhost:4502/sites.html/content rather than custom 404 page i.e. http://localhost:4502/editor.html/content/geometrixx/en.html -> in edit or preview mode takes to http://localhost:4502/sites.html/content

47d896f64a9ccb9a18c9c294bb909541ab22146d

7a079170b9698a3691c1945ac51c870ce6b2c724

https://github.com/adobe-consulting-services/acs-aem-commons/compare/47d896f64a9ccb9a18c9c294bb909541ab22146d...7a079170b9698a3691c1945ac51c870ce6b2c724

diff --git a/bundle/src/main/java/com/adobe/acs/commons/wcm/impl/ComponentErrorHandlerImpl.java b/bundle/src/main/java/com/adobe/acs/commons/wcm/impl/ComponentErrorHandlerImpl.java index 4bd9c43fa..192b07ede 100644 --- a/bundle/src/main/java/com/adobe/acs/commons/wcm/impl/ComponentErrorHandlerImpl.java +++ b/bundle/src/main/java/com/adobe/acs/commons/wcm/impl/ComponentErrorHandlerImpl.java @@ -50,6 +50,7 @@ import javax.servlet.ServletException; import javax.servlet.ServletRequest; import javax.servlet.ServletResponse; import java.io.IOException; +import java.util.Arrays; import java.util.Map; @Component( @@ -75,12 +76,15 @@ import java.util.Map; public class ComponentErrorHandlerImpl implements ComponentErrorHandler, Filter { private static final Logger log = LoggerFactory.getLogger(ComponentErrorHandlerImpl.class.getName()); - // Magic number pushes filter lower in the chain so it executes after the - // OOTB WCM Debug Filter - static final int FILTER_ORDER = 1001; + // Magic number pushes filter lower in the chain so it executes after the OOTB WCM Debug Filter + // In AEM6 this must execute after WCM Developer Mode Filter which requires overriding the service.ranking via a + // sling:OsgiConfig node + static final int FILTER_ORDER = 1000000; static final String BLANK_HTML = "/dev/null"; - static final String REQ_ATTR_PREVIOUSLY_PROCESSED = ComponentErrorHandlerImpl.class.getName() + "_previouslyProcessed"; + + static final String REQ_ATTR_PREVIOUSLY_PROCESSED = + ComponentErrorHandlerImpl.class.getName() + "_previouslyProcessed"; @Reference private ResourceResolverFactory resourceResolverFactory; @@ -316,7 +320,7 @@ public class ComponentErrorHandlerImpl implements ComponentErrorHandler, Filter } private boolean isFirstInChain(final SlingHttpServletRequest request) { - if(request.getAttribute(REQ_ATTR_PREVIOUSLY_PROCESSED) != null) { + if (request.getAttribute(REQ_ATTR_PREVIOUSLY_PROCESSED) != null) { return false; } else { request.setAttribute(REQ_ATTR_PREVIOUSLY_PROCESSED, true); @@ -376,10 +380,7 @@ public class ComponentErrorHandlerImpl implements ComponentErrorHandler, Filter suppressedResourceTypes = PropertiesUtil.toStringArray(config.get(PROP_SUPPRESSED_RESOURCE_TYPES), DEFAULT_SUPPRESSED_RESOURCE_TYPES); - log.info("Suppressed Resource Types:"); - for (final String tmp : suppressedResourceTypes) { - log.info(" > {}", tmp); - } + log.info("Suppressed Resource Types: {}", Arrays.toString(suppressedResourceTypes)); } @Override

['bundle/src/main/java/com/adobe/acs/commons/wcm/impl/ComponentErrorHandlerImpl.java']

{'.java': 1}

Java

{'Java': 6698660, 'JavaScript': 326616, 'HTML': 122754, 'Less': 30283, 'CSS': 19369, 'Groovy': 3717, 'Shell': 960, 'Rich Text Format': 363}

Apache License 2.0

adobe-consulting-services/acs-aem-commons/376/375

adobe-consulting-services

acs-aem-commons

https://github.com/Adobe-Consulting-Services/acs-aem-commons/issues/375

https://github.com/Adobe-Consulting-Services/acs-aem-commons/pull/376

https://github.com/Adobe-Consulting-Services/acs-aem-commons/pull/376

fixes

Dispatcher Flush Rules Multi-Path Flush uses comma as delimiter

1.9.0 introduced a new feature that allows chaining of flush paths using commas. This makes it hard to parse Flush Rules from the provided sling:OsgiConfigs.. `prop.rules.hierarchical="[regex=/abs-path&/foo&/bar,regex2=abs-path2]"` Change to use `&` as the path delimiter `prop.rules.hierarchical="[regex=/abs-path&/foo&/bar,regex2=abs-path2]"`

8c0b40de91a22f955fc62b6d2e5cd2f6f275743c

3178346120fe113fce426d0f1d29bad4bf05f429

https://github.com/adobe-consulting-services/acs-aem-commons/compare/8c0b40de91a22f955fc62b6d2e5cd2f6f275743c...3178346120fe113fce426d0f1d29bad4bf05f429

diff --git a/bundle/src/main/java/com/adobe/acs/commons/replication/dispatcher/impl/DispatcherFlushRulesImpl.java b/bundle/src/main/java/com/adobe/acs/commons/replication/dispatcher/impl/DispatcherFlushRulesImpl.java index 7d6b0b2d8..36a140d5f 100644 --- a/bundle/src/main/java/com/adobe/acs/commons/replication/dispatcher/impl/DispatcherFlushRulesImpl.java +++ b/bundle/src/main/java/com/adobe/acs/commons/replication/dispatcher/impl/DispatcherFlushRulesImpl.java @@ -265,7 +265,7 @@ public class DispatcherFlushRulesImpl implements Preprocessor { for (final Map.Entry<String, String> entry : configuredRules.entrySet()) { final Pattern pattern = Pattern.compile(entry.getKey()); - rules.put(pattern, entry.getValue().split(",")); + rules.put(pattern, entry.getValue().split("&")); } return rules; diff --git a/bundle/src/test/java/com/adobe/acs/commons/replication/dispatcher/impl/DispatcherFlushRulesImplTest.java b/bundle/src/test/java/com/adobe/acs/commons/replication/dispatcher/impl/DispatcherFlushRulesImplTest.java index 87543457a..ebf085a99 100644 --- a/bundle/src/test/java/com/adobe/acs/commons/replication/dispatcher/impl/DispatcherFlushRulesImplTest.java +++ b/bundle/src/test/java/com/adobe/acs/commons/replication/dispatcher/impl/DispatcherFlushRulesImplTest.java @@ -116,7 +116,7 @@ public class DispatcherFlushRulesImplTest { validFlushRules.put("/a/.*", "/b"); validFlushRules.put("/b/.*", "/c"); validFlushRules.put("/c/d/.*", "/e/f"); - validFlushRules.put("/c/a/.*", "/e/f,/g/h"); + validFlushRules.put("/c/a/.*", "/e/f&/g/h"); final Map<Pattern, String[]> expected = new LinkedHashMap<Pattern, String[]>(); expected.put(Pattern.compile("/a/.*"), new String[] { "/b" }); @@ -431,5 +431,4 @@ public class DispatcherFlushRulesImplTest { verifyNoMoreInteractions(dispatcherFlusher); } - }

['bundle/src/main/java/com/adobe/acs/commons/replication/dispatcher/impl/DispatcherFlushRulesImpl.java', 'bundle/src/test/java/com/adobe/acs/commons/replication/dispatcher/impl/DispatcherFlushRulesImplTest.java']

{'.java': 2}

Java

{'Java': 6698660, 'JavaScript': 326616, 'HTML': 122754, 'Less': 30283, 'CSS': 19369, 'Groovy': 3717, 'Shell': 960, 'Rich Text Format': 363}

Apache License 2.0

adobe-consulting-services/acs-aem-commons/340/339

adobe-consulting-services

acs-aem-commons

https://github.com/Adobe-Consulting-Services/acs-aem-commons/issues/339

https://github.com/Adobe-Consulting-Services/acs-aem-commons/pull/340

https://github.com/Adobe-Consulting-Services/acs-aem-commons/pull/340

fixes

AEM Environment Indicator displays twice on /cf#

AEM Env indicator renders twice for /cf loaded pages since both the /cf and the page are candidates for indicator injection. This does not look bad when it is just a bar since they overlap one another and you cant tell, but the custom tab example displays 2 tabs. Tenatively going to reject add any requests refers whose path is /cf

a5c9bb132074de299b1f65cb9798c15d99906d64

bb80c275198e840001d4b8ecdbc53acea79a36b3

https://github.com/adobe-consulting-services/acs-aem-commons/compare/a5c9bb132074de299b1f65cb9798c15d99906d64...bb80c275198e840001d4b8ecdbc53acea79a36b3

diff --git a/bundle/src/main/java/com/adobe/acs/commons/wcm/impl/AemEnvironmentIndicatorFilter.java b/bundle/src/main/java/com/adobe/acs/commons/wcm/impl/AemEnvironmentIndicatorFilter.java index 01daa3ab6..7abd9166a 100644 --- a/bundle/src/main/java/com/adobe/acs/commons/wcm/impl/AemEnvironmentIndicatorFilter.java +++ b/bundle/src/main/java/com/adobe/acs/commons/wcm/impl/AemEnvironmentIndicatorFilter.java @@ -192,8 +192,10 @@ public class AemEnvironmentIndicatorFilter implements Filter { } else if (StringUtils.endsWith(request.getHeader("Referer"), "/editor.html" + request.getRequestURI())) { // Do not apply to pages loaded in the TouchUI editor.html return false; + } else if (StringUtils.endsWith(request.getHeader("Referer"), "/cf")) { + // Do not apply to pages loaded in the Classic Content Finder + return false; } - return true; }

['bundle/src/main/java/com/adobe/acs/commons/wcm/impl/AemEnvironmentIndicatorFilter.java']

{'.java': 1}

Java

{'Java': 6698660, 'JavaScript': 326616, 'HTML': 122754, 'Less': 30283, 'CSS': 19369, 'Groovy': 3717, 'Shell': 960, 'Rich Text Format': 363}

Apache License 2.0

adobe-consulting-services/acs-aem-commons/222/221

adobe-consulting-services

acs-aem-commons

https://github.com/Adobe-Consulting-Services/acs-aem-commons/issues/221

https://github.com/Adobe-Consulting-Services/acs-aem-commons/pull/222

https://github.com/Adobe-Consulting-Services/acs-aem-commons/pull/222

fixes

bug/Dispatcher Flush Rules - Regex replace not implemented for ResourceOnly flushing

/content/geometrixx/([^/]+)/([^/]+)=/content/$1/geometrixx/$2 Does not work for ResourceOnly flushing (was not implemented)

4b89cd27f6c366ca346bfa2275230b8b956af141

fd7d31f99f8b96825c5faeccb5cee5e567db318c

https://github.com/adobe-consulting-services/acs-aem-commons/compare/4b89cd27f6c366ca346bfa2275230b8b956af141...fd7d31f99f8b96825c5faeccb5cee5e567db318c

diff --git a/bundle/src/main/java/com/adobe/acs/commons/replication/dispatcher/impl/DispatcherFlushRulesImpl.java b/bundle/src/main/java/com/adobe/acs/commons/replication/dispatcher/impl/DispatcherFlushRulesImpl.java index dd6bb44fa..b8e0efd8c 100644 --- a/bundle/src/main/java/com/adobe/acs/commons/replication/dispatcher/impl/DispatcherFlushRulesImpl.java +++ b/bundle/src/main/java/com/adobe/acs/commons/replication/dispatcher/impl/DispatcherFlushRulesImpl.java @@ -74,8 +74,10 @@ public class DispatcherFlushRulesImpl implements Preprocessor { private static final String OPTION_DELETE = "DELETE"; - private static final DispatcherFlushFilter HIERARCHICAL_FILTER = new DispatcherFlushRulesFilter(FlushType.Hierarchical); - private static final DispatcherFlushFilter RESOURCE_ONLY_FILTER = new DispatcherFlushRulesFilter(FlushType.ResourceOnly); + private static final DispatcherFlushFilter HIERARCHICAL_FILTER = + new DispatcherFlushRulesFilter(FlushType.Hierarchical); + private static final DispatcherFlushFilter RESOURCE_ONLY_FILTER = + new DispatcherFlushRulesFilter(FlushType.ResourceOnly); /* Replication Action Type Property */ @@ -154,7 +156,8 @@ public class DispatcherFlushRulesImpl implements Preprocessor { final Matcher m = pattern.matcher(path); if (m.matches()) { - final String flushPath = m.replaceAll(entry.getValue()); + final String flushPath = m.replaceAll(entry.getValue()); + log.debug("Requesting hierarchical flush of associated path: {} ~> {}", path, flushPath); dispatcherFlusher.flush(resourceResolver, flushActionType, false, @@ -169,10 +172,12 @@ public class DispatcherFlushRulesImpl implements Preprocessor { final Matcher m = pattern.matcher(path); if (m.matches()) { + final String flushPath = m.replaceAll(entry.getValue()); + log.debug("Requesting ResourceOnly flush of associated path: {} ~> {}", path, entry.getValue()); dispatcherFlusher.flush(resourceResolver, flushActionType, false, RESOURCE_ONLY_FILTER, - entry.getValue()); + flushPath); } } diff --git a/bundle/src/test/java/com/adobe/acs/commons/replication/dispatcher/impl/DispatcherFlushRulesImplTest.java b/bundle/src/test/java/com/adobe/acs/commons/replication/dispatcher/impl/DispatcherFlushRulesImplTest.java index f1a0a06ec..4e6ec06b5 100644 --- a/bundle/src/test/java/com/adobe/acs/commons/replication/dispatcher/impl/DispatcherFlushRulesImplTest.java +++ b/bundle/src/test/java/com/adobe/acs/commons/replication/dispatcher/impl/DispatcherFlushRulesImplTest.java @@ -391,4 +391,33 @@ public class DispatcherFlushRulesImplTest { verifyNoMoreInteractions(dispatcherFlusher); } + + @Test + public void testPreprocess_success_resourceonly_translation2() throws Exception { + resourceOnlyFlushRules.put(Pattern.compile("/content/acs-aem-commons/(.*)/(.*)"), "/content/target/$1/acs-aem-commons/$2"); + + final ReplicationAction replicationAction = mock(ReplicationAction.class); + when(replicationAction.getPath()).thenReturn("/content/acs-aem-commons/en/page"); + when(replicationAction.getType()).thenReturn(ReplicationActionType.ACTIVATE); + + final ReplicationOptions replicationOptions = new ReplicationOptions(); + replicationOptions.setSynchronous(false); + + final ArgumentCaptor<DispatcherFlushFilter> agentFilterCaptor = ArgumentCaptor.forClass(DispatcherFlushFilter + .class); + + dispatcherFlushRules.preprocess(replicationAction, replicationOptions); + + verify(dispatcherFlusher, times(1)).flush(any(ResourceResolver.class), eq(ReplicationActionType.ACTIVATE), + eq(false), + agentFilterCaptor.capture(), + eq("/content/target/en/acs-aem-commons/page")); + + assertEquals(DispatcherFlushFilter.FlushType.ResourceOnly, agentFilterCaptor.getValue().getFlushType()); + // Private impl class; no access to test for instanceof + assertEquals("DispatcherFlushRulesFilter", agentFilterCaptor.getValue().getClass().getSimpleName()); + + verifyNoMoreInteractions(dispatcherFlusher); + } + }

['bundle/src/main/java/com/adobe/acs/commons/replication/dispatcher/impl/DispatcherFlushRulesImpl.java', 'bundle/src/test/java/com/adobe/acs/commons/replication/dispatcher/impl/DispatcherFlushRulesImplTest.java']

{'.java': 2}

Java

{'Java': 6698660, 'JavaScript': 326616, 'HTML': 122754, 'Less': 30283, 'CSS': 19369, 'Groovy': 3717, 'Shell': 960, 'Rich Text Format': 363}

Apache License 2.0

openhft/chronicle-wire/650/649

openhft

chronicle-wire

https://github.com/OpenHFT/Chronicle-Wire/issues/649

https://github.com/OpenHFT/Chronicle-Wire/pull/650

https://github.com/OpenHFT/Chronicle-Wire/pull/650

fixes

There's no way to encode a "zero" value in the SymbolsLongConverters

We take numeric zero to mean empty string which means strings that consist entirely of the "zero" character can't be round-tripped. e.g. the following both fail `assertEquals(Base85LongConverter.INSTANCE.asText(Base85LongConverter.INSTANCE.parse("0")), "0");` `assertEquals(Base85LongConverter.INSTANCE.asText(Base85LongConverter.INSTANCE.parse("00000")), "00000");` a similar problem exists for values with leading "zero" values e.g. `assertEquals(Base85LongConverter.INSTANCE.asText(Base85LongConverter.INSTANCE.parse("00012")), "00012");` Not sure if this is a bug, or just a limitation to be aware of when using them to encode strings. Perhaps it's something we need to be explicit about in our docs?

38c8a6abd9b09fd2d3ad77329224648bb4542e7c

7218ab25eb32deb95655770a75cc1ed42690f6a6

https://github.com/openhft/chronicle-wire/compare/38c8a6abd9b09fd2d3ad77329224648bb4542e7c...7218ab25eb32deb95655770a75cc1ed42690f6a6

diff --git a/src/main/java/net/openhft/chronicle/wire/converter/SymbolsLongConverter.java b/src/main/java/net/openhft/chronicle/wire/converter/SymbolsLongConverter.java index 747abebb..e0750a12 100644 --- a/src/main/java/net/openhft/chronicle/wire/converter/SymbolsLongConverter.java +++ b/src/main/java/net/openhft/chronicle/wire/converter/SymbolsLongConverter.java @@ -63,6 +63,11 @@ public class SymbolsLongConverter implements LongConverter { @Override public void append(StringBuilder text, long value) { + if (value == 0) { + text.append(decode[0]); + return; + } + final int start = text.length(); if (value < 0) { int v = (int) Long.remainderUnsigned(value, factor); diff --git a/src/test/java/net/openhft/chronicle/wire/Base85LongConverterTest.java b/src/test/java/net/openhft/chronicle/wire/Base85LongConverterTest.java index aaf0fbd2..1c0cd5f3 100644 --- a/src/test/java/net/openhft/chronicle/wire/Base85LongConverterTest.java +++ b/src/test/java/net/openhft/chronicle/wire/Base85LongConverterTest.java @@ -34,7 +34,7 @@ public class Base85LongConverterTest extends WireTestCommon { public void parse() { LongConverter c = Base85LongConverter.INSTANCE; // System.out.println(c.asString(-1L)); - for (String s : ",a,ab,abc,abcd,ab.de,123=56,1234567,12345678,zzzzzzzzz,+ko2&)z.0".split(",")) { + for (String s : "a,ab,abc,abcd,ab.de,123=56,1234567,12345678,zzzzzzzzz,+ko2&)z.0".split(",")) { long v = c.parse(s); StringBuilder sb = new StringBuilder(); c.append(sb, v); @@ -91,6 +91,20 @@ public class Base85LongConverterTest extends WireTestCommon { allSafeChars(wire); } + @Test + public void willParseEmptyStringAsZero() { + assertEquals(0, Base85LongConverter.INSTANCE.converter.parse("")); + } + + @Test + public void testEncodeAndDecodeZero() { + assertEquals(0, Base85LongConverter.INSTANCE.converter.parse("0")); + assertEquals("0", Base85LongConverter.INSTANCE.converter.asText(0).toString()); + StringBuilder b = new StringBuilder(); + Base85LongConverter.INSTANCE.append(b, 0); + assertEquals("0", b.toString()); + } + private void allSafeChars(Wire wire) { final Base85LongConverter converter = Base85LongConverter.INSTANCE; for (long i = 0; i <= 85 * 85; i++) {

['src/main/java/net/openhft/chronicle/wire/converter/SymbolsLongConverter.java', 'src/test/java/net/openhft/chronicle/wire/Base85LongConverterTest.java']

{'.java': 2}

Java

{'Java': 3464093, 'Shell': 771}

Apache License 2.0

scalar-labs/scalardb/71/66

scalar-labs

scalardb

https://github.com/scalar-labs/scalardb/issues/66

https://github.com/scalar-labs/scalardb/pull/71

https://github.com/scalar-labs/scalardb/pull/71

fix

Non-serializable execution (lost update) when a recode is deleted

### Environment - Version 2.0.0 - with SERIALIZABLE ### How to reproduce ``` CREATE TRANSACTION TABLE foo.foo ( id TEXT PARTITIONKEY, value TEXT ); ``` - Initial state: id | value | tx_version (tx metadata) -- | ------ | --- foo | 2 | 1 - Steps - T1: start - T1: Read a record that has id = foo and put the value into A. If the record does not exist, put 0. - (id, value, tx_version) = ("foo", 2, 1) - T2: start - T2: Delete a record that has id = foo - T2: commit - T3: start - T3: Read a record that has id = foo and put the value into B. If the record does not exist, put 0. - T3: Add 1 to B and put - (id, value, tx_version) = ("foo", 1, 1) - T3: commit - T1: Add 1 to A and put - (id, value, tx_version) = ("foo", 3, 2) - T1: commit - Actual states : id | value | tx_version -- | ------ | ------ foo | 3 | 2 The above state can NOT be produced by T1, T2 and T3 in some serial order, which means the execution is not serializable. - T1->T3->T2 and T3->T1->T2 no record - T2->T1->T3 and T2->T3->T1 id | value | tx_version -- | ------ | ------ foo | 2 | 2 - T1->T2->T3 and T3->T2->T1 id | value | tx_version -- | ------ | ------ foo | 1 | 1

65df3f9531d3afb7a42a79dc96610f174429ea74

fd2b484c03910e462c41676760dc3a85eb8f5a1c

https://github.com/scalar-labs/scalardb/compare/65df3f9531d3afb7a42a79dc96610f174429ea74...fd2b484c03910e462c41676760dc3a85eb8f5a1c

diff --git a/src/integration-test/java/com/scalar/db/transaction/consensuscommit/ConsensusCommitIntegrationTest.java b/src/integration-test/java/com/scalar/db/transaction/consensuscommit/ConsensusCommitIntegrationTest.java index 40a9f278..c6dac7ff 100644 --- a/src/integration-test/java/com/scalar/db/transaction/consensuscommit/ConsensusCommitIntegrationTest.java +++ b/src/integration-test/java/com/scalar/db/transaction/consensuscommit/ConsensusCommitIntegrationTest.java @@ -21,6 +21,7 @@ import com.scalar.db.api.Scan; import com.scalar.db.api.Selection; import com.scalar.db.api.TransactionState; import com.scalar.db.exception.storage.ExecutionException; +import com.scalar.db.exception.storage.NoMutationException; import com.scalar.db.exception.transaction.CommitConflictException; import com.scalar.db.exception.transaction.CommitException; import com.scalar.db.exception.transaction.CoordinatorException; @@ -1371,6 +1372,93 @@ public class ConsensusCommitIntegrationTest { assertThat(thrown2).isInstanceOf(CommitException.class); } + public void putAndCommit_DeleteGivenInBetweenTransactions_ShouldProduceSerializableResults() + throws CrudException, CommitException, UnknownTransactionStatusException { + // Arrange + DistributedTransaction transaction = manager.start(); + transaction.put(preparePut(0, 0, NAMESPACE, TABLE_1).withValue(new IntValue(BALANCE, 2))); + transaction.commit(); + + // Act + DistributedTransaction transaction1 = manager.start(); + Optional<Result> result1 = transaction1.get(prepareGet(0, 0, NAMESPACE, TABLE_1)); + int balance1 = 0; + if (result1.isPresent()) { + balance1 = ((IntValue) result1.get().getValue(BALANCE).get()).get(); + } + transaction1.put( + preparePut(0, 0, NAMESPACE, TABLE_1).withValue(new IntValue(BALANCE, balance1 + 1))); + + DistributedTransaction transaction2 = manager.start(); + transaction2.get(prepareGet(0, 0, NAMESPACE, TABLE_1)); + transaction2.delete(prepareDelete(0, 0, NAMESPACE, TABLE_1)); + transaction2.commit(); + + // the same transaction processing as transaction1 + DistributedTransaction transaction3 = manager.start(); + Optional<Result> result3 = transaction3.get(prepareGet(0, 0, NAMESPACE, TABLE_1)); + int balance3 = 0; + if (result3.isPresent()) { + balance3 = ((IntValue) result3.get().getValue(BALANCE).get()).get(); + } + transaction3.put( + preparePut(0, 0, NAMESPACE, TABLE_1).withValue(new IntValue(BALANCE, balance3 + 1))); + transaction3.commit(); + + Throwable thrown = catchThrowable(() -> transaction1.commit()); + + // Assert + assertThat(thrown) + .isInstanceOf(CommitConflictException.class) + .hasCauseInstanceOf(NoMutationException.class); + transaction = manager.start(); + Optional<Result> result = transaction.get(prepareGet(0, 0, NAMESPACE, TABLE_1)); + assertThat(((IntValue) result.get().getValue(BALANCE).get()).get()).isEqualTo(1); + } + + public void deleteAndCommit_DeleteGivenInBetweenTransactions_ShouldProduceSerializableResults() + throws CrudException, CommitException, UnknownTransactionStatusException { + // Arrange + DistributedTransaction transaction = manager.start(); + transaction.put(preparePut(0, 0, NAMESPACE, TABLE_1).withValue(new IntValue(BALANCE, 2))); + transaction.commit(); + + // Act + DistributedTransaction transaction1 = manager.start(); + Optional<Result> result1 = transaction1.get(prepareGet(0, 0, NAMESPACE, TABLE_1)); + int balance1 = 0; + if (result1.isPresent()) { + balance1 = ((IntValue) result1.get().getValue(BALANCE).get()).get(); + } + transaction1.delete(prepareDelete(0, 0, NAMESPACE, TABLE_1)); + + DistributedTransaction transaction2 = manager.start(); + transaction2.get(prepareGet(0, 0, NAMESPACE, TABLE_1)); + transaction2.delete(prepareDelete(0, 0, NAMESPACE, TABLE_1)); + transaction2.commit(); + + // the same transaction processing as transaction1 + DistributedTransaction transaction3 = manager.start(); + Optional<Result> result3 = transaction3.get(prepareGet(0, 0, NAMESPACE, TABLE_1)); + int balance3 = 0; + if (result3.isPresent()) { + balance3 = ((IntValue) result3.get().getValue(BALANCE).get()).get(); + } + transaction3.put( + preparePut(0, 0, NAMESPACE, TABLE_1).withValue(new IntValue(BALANCE, balance3 + 1))); + transaction3.commit(); + + Throwable thrown = catchThrowable(() -> transaction1.commit()); + + // Assert + assertThat(thrown) + .isInstanceOf(CommitConflictException.class) + .hasCauseInstanceOf(NoMutationException.class); + transaction = manager.start(); + Optional<Result> result = transaction.get(prepareGet(0, 0, NAMESPACE, TABLE_1)); + assertThat(((IntValue) result.get().getValue(BALANCE).get()).get()).isEqualTo(1); + } + private ConsensusCommit prepareTransfer(int fromId, int toId, int amount) throws CrudException { ConsensusCommit transaction = manager.start(); List<Get> gets = prepareGets(NAMESPACE, TABLE_1); diff --git a/src/integration-test/java/com/scalar/db/transaction/consensuscommit/ConsensusCommitWithCassandraIntegrationTest.java b/src/integration-test/java/com/scalar/db/transaction/consensuscommit/ConsensusCommitWithCassandraIntegrationTest.java index db18b2d3..59c2ce77 100644 --- a/src/integration-test/java/com/scalar/db/transaction/consensuscommit/ConsensusCommitWithCassandraIntegrationTest.java +++ b/src/integration-test/java/com/scalar/db/transaction/consensuscommit/ConsensusCommitWithCassandraIntegrationTest.java @@ -359,6 +359,18 @@ public class ConsensusCommitWithCassandraIntegrationTest { test.commit_WriteSkewWithScanOnNonExistingRecordsWithSerializable_ShouldThrowCommitException(); } + @Test + public void putAndCommit_DeleteGivenInBetweenTransactions_ShouldProduceSerializableResults() + throws Exception { + test.putAndCommit_DeleteGivenInBetweenTransactions_ShouldProduceSerializableResults(); + } + + @Test + public void deleteAndCommit_DeleteGivenInBetweenTransactions_ShouldProduceSerializableResults() + throws Exception { + test.deleteAndCommit_DeleteGivenInBetweenTransactions_ShouldProduceSerializableResults(); + } + @BeforeClass public static void setUpBeforeClass() throws IOException, InterruptedException { executeStatement(createNamespaceStatement(ConsensusCommitIntegrationTest.NAMESPACE)); diff --git a/src/main/java/com/scalar/db/transaction/consensuscommit/PrepareMutationComposer.java b/src/main/java/com/scalar/db/transaction/consensuscommit/PrepareMutationComposer.java index 247880de..979b66d6 100644 --- a/src/main/java/com/scalar/db/transaction/consensuscommit/PrepareMutationComposer.java +++ b/src/main/java/com/scalar/db/transaction/consensuscommit/PrepareMutationComposer.java @@ -1,7 +1,10 @@ package com.scalar.db.transaction.consensuscommit; import static com.scalar.db.api.ConditionalExpression.Operator; -import static com.scalar.db.transaction.consensuscommit.Attribute.*; +import static com.scalar.db.transaction.consensuscommit.Attribute.ID; +import static com.scalar.db.transaction.consensuscommit.Attribute.VERSION; +import static com.scalar.db.transaction.consensuscommit.Attribute.toIdValue; +import static com.scalar.db.transaction.consensuscommit.Attribute.toVersionValue; import com.google.common.annotations.VisibleForTesting; import com.scalar.db.api.ConditionalExpression; @@ -64,7 +67,9 @@ public class PrepareMutationComposer extends AbstractMutationComposer { // check if the record is not interrupted by other conflicting transactions put.withCondition( - new PutIf(new ConditionalExpression(VERSION, toVersionValue(version), Operator.EQ))); + new PutIf( + new ConditionalExpression(VERSION, toVersionValue(version), Operator.EQ), + new ConditionalExpression(ID, toIdValue(result.getId()), Operator.EQ))); } else { // initial record values.add(Attribute.toVersionValue(1)); @@ -98,7 +103,9 @@ public class PrepareMutationComposer extends AbstractMutationComposer { // check if the record is not interrupted by other conflicting transactions put.withCondition( - new PutIf(new ConditionalExpression(VERSION, toVersionValue(version), Operator.EQ))); + new PutIf( + new ConditionalExpression(VERSION, toVersionValue(version), Operator.EQ), + new ConditionalExpression(ID, toIdValue(result.getId()), Operator.EQ))); put.withValues(values); mutations.add(put); diff --git a/src/test/java/com/scalar/db/transaction/consensuscommit/PrepareMutationComposerTest.java b/src/test/java/com/scalar/db/transaction/consensuscommit/PrepareMutationComposerTest.java index 0096a06b..0e2f59d5 100644 --- a/src/test/java/com/scalar/db/transaction/consensuscommit/PrepareMutationComposerTest.java +++ b/src/test/java/com/scalar/db/transaction/consensuscommit/PrepareMutationComposerTest.java @@ -1,7 +1,10 @@ package com.scalar.db.transaction.consensuscommit; import static com.scalar.db.api.ConditionalExpression.Operator; -import static com.scalar.db.transaction.consensuscommit.Attribute.*; +import static com.scalar.db.transaction.consensuscommit.Attribute.ID; +import static com.scalar.db.transaction.consensuscommit.Attribute.VERSION; +import static com.scalar.db.transaction.consensuscommit.Attribute.toIdValue; +import static com.scalar.db.transaction.consensuscommit.Attribute.toVersionValue; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatThrownBy; import static org.mockito.Mockito.mock; @@ -120,7 +123,9 @@ public class PrepareMutationComposerTest { Put actual = (Put) mutations.get(0); put.withConsistency(Consistency.LINEARIZABLE); put.withCondition( - new PutIf(new ConditionalExpression(VERSION, toVersionValue(2), Operator.EQ))); + new PutIf( + new ConditionalExpression(VERSION, toVersionValue(2), Operator.EQ), + new ConditionalExpression(ID, toIdValue(ANY_ID_2), Operator.EQ))); put.withValue(Attribute.toPreparedAtValue(ANY_TIME_5)); put.withValue(Attribute.toIdValue(ANY_ID_3)); put.withValue(Attribute.toStateValue(TransactionState.PREPARED)); @@ -170,7 +175,9 @@ public class PrepareMutationComposerTest { .forTable(delete.forTable().get()); expected.withConsistency(Consistency.LINEARIZABLE); expected.withCondition( - new PutIf(new ConditionalExpression(VERSION, toVersionValue(2), Operator.EQ))); + new PutIf( + new ConditionalExpression(VERSION, toVersionValue(2), Operator.EQ), + new ConditionalExpression(ID, toIdValue(ANY_ID_2), Operator.EQ))); expected.withValue(Attribute.toPreparedAtValue(ANY_TIME_5)); expected.withValue(Attribute.toIdValue(ANY_ID_3)); expected.withValue(Attribute.toStateValue(TransactionState.DELETED));

['src/main/java/com/scalar/db/transaction/consensuscommit/PrepareMutationComposer.java', 'src/integration-test/java/com/scalar/db/transaction/consensuscommit/ConsensusCommitWithCassandraIntegrationTest.java', 'src/integration-test/java/com/scalar/db/transaction/consensuscommit/ConsensusCommitIntegrationTest.java', 'src/test/java/com/scalar/db/transaction/consensuscommit/PrepareMutationComposerTest.java']

{'.java': 4}

Java

{'Java': 5071062, 'TLA': 16905, 'Shell': 4976, 'JavaScript': 3576, 'Ruby': 2936, 'Dockerfile': 1459}

Apache License 2.0

gwtmaterialdesign/gwt-material/242/233

gwtmaterialdesign

gwt-material

https://github.com/GwtMaterialDesign/gwt-material/issues/233

https://github.com/GwtMaterialDesign/gwt-material/pull/242

https://github.com/GwtMaterialDesign/gwt-material/pull/242#issuecomment-196896448

close

HasFlexBox: Error setting the display attribute on UiBinder

The HasFlexBox interface defines two methods with the same name: ``` java void setDisplay(Style.Display display); void setDisplay(Display display); ``` And that causes a problem when you define a `display` attribute on UiBinder on any MaterialWidget: ``` xml <m:MaterialPanel display="NONE" /> ``` The error is: ``` [ERROR] Ambiguous setter requested: MaterialPanel.display ```

512fdf1886300daa5abb37fda5472e91d0dca234

f8712e893c1cb825cc86ec6139f508826dfdd7e7

https://github.com/gwtmaterialdesign/gwt-material/compare/512fdf1886300daa5abb37fda5472e91d0dca234...f8712e893c1cb825cc86ec6139f508826dfdd7e7

diff --git a/gwt-material/src/main/java/gwt/material/design/client/base/AbstractTextWidget.java b/gwt-material/src/main/java/gwt/material/design/client/base/AbstractTextWidget.java index 5e5b8440..b14ad95a 100644 --- a/gwt-material/src/main/java/gwt/material/design/client/base/AbstractTextWidget.java +++ b/gwt-material/src/main/java/gwt/material/design/client/base/AbstractTextWidget.java @@ -20,6 +20,10 @@ package gwt.material.design.client.base; * #L% */ +import gwt.material.design.client.base.mixin.FontSizeMixin; +import gwt.material.design.client.base.mixin.IdMixin; +import gwt.material.design.client.constants.Display; + import com.google.gwt.dom.client.Element; import com.google.gwt.dom.client.Style; import com.google.gwt.editor.client.IsEditor; @@ -27,8 +31,6 @@ import com.google.gwt.editor.client.LeafValueEditor; import com.google.gwt.editor.ui.client.adapters.HasTextEditor; import com.google.gwt.user.client.ui.HasHTML; import com.google.gwt.user.client.ui.Widget; -import gwt.material.design.client.base.mixin.FontSizeMixin; -import gwt.material.design.client.base.mixin.IdMixin; /** * @author Ben Dol @@ -171,8 +173,8 @@ public abstract class AbstractTextWidget extends Widget implements HasId, HasHTM } @Override - public void setDisplay(Style.Display display) { - getElement().getStyle().setDisplay(display); + public void setDisplay(Display display) { + getElement().getStyle().setProperty("display", display.getCssName()); } @Override diff --git a/gwt-material/src/main/java/gwt/material/design/client/base/HasFlexbox.java b/gwt-material/src/main/java/gwt/material/design/client/base/HasFlexbox.java index 0fd4f856..f4b32503 100644 --- a/gwt-material/src/main/java/gwt/material/design/client/base/HasFlexbox.java +++ b/gwt-material/src/main/java/gwt/material/design/client/base/HasFlexbox.java @@ -32,7 +32,7 @@ import gwt.material.design.client.constants.*; * @see MaterialWidget */ public interface HasFlexbox { - void setDisplay(Style.Display display); + void setGwtDisplay(Style.Display display); void setDisplay(Display display); diff --git a/gwt-material/src/main/java/gwt/material/design/client/base/HasInlineStyle.java b/gwt-material/src/main/java/gwt/material/design/client/base/HasInlineStyle.java index 6af390c5..ae1be415 100644 --- a/gwt-material/src/main/java/gwt/material/design/client/base/HasInlineStyle.java +++ b/gwt-material/src/main/java/gwt/material/design/client/base/HasInlineStyle.java @@ -21,7 +21,7 @@ package gwt.material.design.client.base; */ -import com.google.gwt.dom.client.Style; +import gwt.material.design.client.constants.Display; /** * @author Ben Dol @@ -47,5 +47,5 @@ public interface HasInlineStyle extends HasColors, HasOpacity, HasFontSize { void setPaddingBottom(double padding); - void setDisplay(Style.Display display); + void setDisplay(Display display); } \\ No newline at end of file diff --git a/gwt-material/src/main/java/gwt/material/design/client/base/MaterialWidget.java b/gwt-material/src/main/java/gwt/material/design/client/base/MaterialWidget.java index 4904d77c..83804ff9 100644 --- a/gwt-material/src/main/java/gwt/material/design/client/base/MaterialWidget.java +++ b/gwt-material/src/main/java/gwt/material/design/client/base/MaterialWidget.java @@ -20,12 +20,39 @@ package gwt.material.design.client.base; * #L% */ +import gwt.material.design.client.base.helper.StyleHelper; +import gwt.material.design.client.base.mixin.ColorsMixin; +import gwt.material.design.client.base.mixin.CssNameMixin; +import gwt.material.design.client.base.mixin.EnabledMixin; +import gwt.material.design.client.base.mixin.FlexboxMixin; +import gwt.material.design.client.base.mixin.FocusableMixin; +import gwt.material.design.client.base.mixin.FontSizeMixin; +import gwt.material.design.client.base.mixin.GridMixin; +import gwt.material.design.client.base.mixin.IdMixin; +import gwt.material.design.client.base.mixin.ScrollspyMixin; +import gwt.material.design.client.base.mixin.SeparatorMixin; +import gwt.material.design.client.base.mixin.ShadowMixin; +import gwt.material.design.client.base.mixin.ToggleStyleMixin; +import gwt.material.design.client.base.mixin.TooltipMixin; +import gwt.material.design.client.base.mixin.WavesMixin; +import gwt.material.design.client.constants.CenterOn; +import gwt.material.design.client.constants.Display; +import gwt.material.design.client.constants.Flex; +import gwt.material.design.client.constants.FlexAlignContent; +import gwt.material.design.client.constants.FlexAlignItems; +import gwt.material.design.client.constants.FlexAlignSelf; +import gwt.material.design.client.constants.FlexDirection; +import gwt.material.design.client.constants.FlexJustifyContent; +import gwt.material.design.client.constants.FlexWrap; +import gwt.material.design.client.constants.HideOn; +import gwt.material.design.client.constants.Position; +import gwt.material.design.client.constants.ShowOn; +import gwt.material.design.client.constants.TextAlign; +import gwt.material.design.client.constants.WavesType; + import com.google.gwt.dom.client.Element; import com.google.gwt.dom.client.Style; import com.google.gwt.user.client.ui.*; -import gwt.material.design.client.base.helper.StyleHelper; -import gwt.material.design.client.base.mixin.*; -import gwt.material.design.client.constants.*; import java.util.Iterator; public class MaterialWidget extends ComplexPanel implements HasId, HasEnabled, HasTextAlign, HasColors, HasGrid, @@ -322,8 +349,8 @@ public class MaterialWidget extends ComplexPanel implements HasId, HasEnabled, H } @Override - public void setDisplay(Style.Display display) { - getFlexboxMixin().setDisplay(display); + public void setGwtDisplay(Style.Display display) { + getFlexboxMixin().setGwtDisplay(display); } @Override diff --git a/gwt-material/src/main/java/gwt/material/design/client/base/mixin/FlexboxMixin.java b/gwt-material/src/main/java/gwt/material/design/client/base/mixin/FlexboxMixin.java index 024daef0..fa0f60d2 100644 --- a/gwt-material/src/main/java/gwt/material/design/client/base/mixin/FlexboxMixin.java +++ b/gwt-material/src/main/java/gwt/material/design/client/base/mixin/FlexboxMixin.java @@ -46,10 +46,12 @@ public class FlexboxMixin<T extends Widget & HasFlexbox> extends AbstractMixin<T private Display displayValueBeforeHidden; - public void setDisplay(Style.Display display) { + @Override + public void setGwtDisplay(Style.Display display) { setDisplay(Display.parse(display)); } + @Override public void setDisplay(Display display) { if (display == null) { displayValueBeforeHidden = null; @@ -76,6 +78,7 @@ public class FlexboxMixin<T extends Widget & HasFlexbox> extends AbstractMixin<T } } + @Override public void setVisible(boolean visible) { uiObject.setVisible(visible); @@ -86,6 +89,7 @@ public class FlexboxMixin<T extends Widget & HasFlexbox> extends AbstractMixin<T } } + @Override public void setFlexDirection(FlexDirection flexDirection) { boolean isCurrentlyVisible = uiObject.isVisible(); @@ -101,6 +105,7 @@ public class FlexboxMixin<T extends Widget & HasFlexbox> extends AbstractMixin<T } } + @Override public void setFlex(Flex flex) { if (flex == null) { setFlexGrow(null); @@ -114,38 +119,47 @@ public class FlexboxMixin<T extends Widget & HasFlexbox> extends AbstractMixin<T setFlexBasis(flex.getBasis()); } + @Override public void setFlexGrow(Integer flexGrow) { BrowserPrefixHelper.updateStyleProperties(uiObject.getElement(), new String[]{"MsFlexGrow", "WebkitFlexGrow", "MozFlexGrow", "flexGrow"}, flexGrow != null ? flexGrow.toString() : null); } + @Override public void setFlexShrink(Integer flexShrink) { BrowserPrefixHelper.updateStyleProperties(uiObject.getElement(), new String[]{"MsFlexShrink", "WebkitFlexShrink", "MozFlexShrink", "flexShrink"}, flexShrink != null ? flexShrink.toString() : null); } + @Override public void setFlexBasis(String flexBasis) { BrowserPrefixHelper.updateStyleProperties(uiObject.getElement(), new String[]{"MsFlexBasis", "WebkitFlexBasis", "MozFlexBasis", "flexBasis"}, flexBasis); } + @Override public void setFlexOrder(Integer flexOrder) { BrowserPrefixHelper.updateStyleProperties(uiObject.getElement(), new String[]{"MsFlexOrder", "WebkitOrder", "MozFlexOrder", "order"}, flexOrder != null ? flexOrder.toString() : null); } + @Override public void setFlexWrap(FlexWrap flexWrap) { BrowserPrefixHelper.updateStyleProperties(uiObject.getElement(), new String[]{"MsFlexWrap", "WebkitFlexWrap", "MozFlexWrap", "flexWrap"}, flexWrap != null ? flexWrap.getValue() : null); } + @Override public void setFlexAlignContent(FlexAlignContent flexAlignContent) { BrowserPrefixHelper.updateStyleProperties(uiObject.getElement(), "MsFlexLinePack", new String[]{"WebkitAlignContent", "MozFlexAlignContent", "alignContent"}, flexAlignContent); } + @Override public void setFlexAlignSelf(FlexAlignSelf flexAlignSelf) { BrowserPrefixHelper.updateStyleProperties(uiObject.getElement(), "MsFlexItemAlign", new String[]{"WebkitAlignSelf", "MozFlexItemAlign", "alignSelf"}, flexAlignSelf); } + @Override public void setFlexAlignItems(FlexAlignItems flexAlignItems) { BrowserPrefixHelper.updateStyleProperties(uiObject.getElement(), "MsFlexAlign", new String[]{"WebkitAlignItems", "MozFlexAlign", "alignItems"}, flexAlignItems); } + @Override public void setFlexJustifyContent(FlexJustifyContent flexJustifyContent) { BrowserPrefixHelper.updateStyleProperties(uiObject.getElement(), "MsFlexPack", new String[]{"WebkitJustifyContent", "MozJustifyContent", "justifyContent"}, flexJustifyContent); } diff --git a/gwt-material/src/main/java/gwt/material/design/client/base/mixin/ProgressMixin.java b/gwt-material/src/main/java/gwt/material/design/client/base/mixin/ProgressMixin.java index 7c7c39c0..8776a719 100644 --- a/gwt-material/src/main/java/gwt/material/design/client/base/mixin/ProgressMixin.java +++ b/gwt-material/src/main/java/gwt/material/design/client/base/mixin/ProgressMixin.java @@ -20,15 +20,16 @@ package gwt.material.design.client.base.mixin; * #L% */ -import com.google.gwt.dom.client.Style; -import com.google.gwt.user.client.ui.UIObject; import gwt.material.design.client.base.HasProgress; +import gwt.material.design.client.constants.Display; import gwt.material.design.client.constants.ProgressType; import gwt.material.design.client.ui.MaterialCollapsibleBody; import gwt.material.design.client.ui.MaterialCollapsibleItem; import gwt.material.design.client.ui.MaterialNavBar; import gwt.material.design.client.ui.MaterialProgress; +import com.google.gwt.user.client.ui.UIObject; + /** * @author kevzlou7979 */ @@ -73,10 +74,10 @@ public class ProgressMixin<T extends UIObject & HasProgress> return; }else { if (isShow) { - body.setDisplay(Style.Display.NONE); + body.setDisplay(Display.NONE); item.add(progress); } else { - body.setDisplay(Style.Display.BLOCK); + body.setDisplay(Display.BLOCK); progress.removeFromParent(); } } diff --git a/gwt-material/src/main/java/gwt/material/design/client/constants/Display.java b/gwt-material/src/main/java/gwt/material/design/client/constants/Display.java index 7d4ed035..1483165e 100644 --- a/gwt-material/src/main/java/gwt/material/design/client/constants/Display.java +++ b/gwt-material/src/main/java/gwt/material/design/client/constants/Display.java @@ -21,12 +21,13 @@ package gwt.material.design.client.constants; */ import com.google.gwt.dom.client.Style; +import com.google.gwt.dom.client.Style.HasCssName; /** * @author chriswjones */ -public enum Display { - FLEX(null), +public enum Display implements HasCssName { + FLEX("flex"), NONE(Style.Display.NONE), BLOCK(Style.Display.BLOCK), INLINE(Style.Display.INLINE), @@ -45,26 +46,35 @@ public enum Display { TABLE_ROW(Style.Display.TABLE_ROW), INITIAL(Style.Display.INITIAL); - private final Style.Display gwtDisplay; + private final String cssName; - Display(Style.Display gwtDisplay) { - this.gwtDisplay = gwtDisplay; + Display(HasCssName gwtDisplay) { + this.cssName = gwtDisplay.getCssName(); + } + + Display(String cssName) { + this.cssName = cssName; } public Style.Display getGwtDisplay() { - return gwtDisplay; + return Style.Display.valueOf(this.name()); } - - public static Display parse(Style.Display gwtDisplay) { - if (gwtDisplay == null) { - return null; - } - + + public static Display parse(String display) { for (Display d : Display.values()) { - if (d.getGwtDisplay() != null && d.getGwtDisplay().equals(gwtDisplay)) { + if (d.getCssName().equals(display)){ return d; } } return null; } + + public static Display parse(HasCssName display) { + return parse(display.getCssName()); + } + + @Override + public String getCssName() { + return cssName; + } } diff --git a/gwt-material/src/main/java/gwt/material/design/client/ui/MaterialCollapsibleItem.java b/gwt-material/src/main/java/gwt/material/design/client/ui/MaterialCollapsibleItem.java index fda9e7fa..f8c0c18e 100644 --- a/gwt-material/src/main/java/gwt/material/design/client/ui/MaterialCollapsibleItem.java +++ b/gwt-material/src/main/java/gwt/material/design/client/ui/MaterialCollapsibleItem.java @@ -1,17 +1,18 @@ package gwt.material.design.client.ui; -import com.google.gwt.dom.client.Document; -import com.google.gwt.dom.client.Element; -import com.google.gwt.dom.client.Style.Display; -import com.google.gwt.user.client.ui.HasWidgets; -import com.google.gwt.user.client.ui.Widget; import gwt.material.design.client.base.AbstractButton; import gwt.material.design.client.base.HasProgress; import gwt.material.design.client.base.mixin.ProgressMixin; +import gwt.material.design.client.constants.Display; import gwt.material.design.client.constants.ProgressType; import gwt.material.design.client.constants.WavesType; import gwt.material.design.client.ui.MaterialCollapsible.HasCollapsibleParent; +import com.google.gwt.dom.client.Document; +import com.google.gwt.dom.client.Element; +import com.google.gwt.user.client.ui.HasWidgets; +import com.google.gwt.user.client.ui.Widget; + /* * #%L * GwtMaterial diff --git a/gwt-material/src/main/java/gwt/material/design/client/ui/MaterialSplashScreen.java b/gwt-material/src/main/java/gwt/material/design/client/ui/MaterialSplashScreen.java index 5a8b0b6d..cd9b9f21 100644 --- a/gwt-material/src/main/java/gwt/material/design/client/ui/MaterialSplashScreen.java +++ b/gwt-material/src/main/java/gwt/material/design/client/ui/MaterialSplashScreen.java @@ -19,13 +19,14 @@ */ package gwt.material.design.client.ui; +import gwt.material.design.client.base.MaterialWidget; +import gwt.material.design.client.constants.Display; +import gwt.material.design.client.ui.html.Div; + import com.google.gwt.dom.client.Document; import com.google.gwt.dom.client.Style; -import com.google.gwt.dom.client.Style.Display; import com.google.gwt.user.client.ui.HasVisibility; import com.google.gwt.user.client.ui.Widget; -import gwt.material.design.client.base.MaterialWidget; -import gwt.material.design.client.ui.html.Div; //@formatter:off /** @@ -83,11 +84,11 @@ public class MaterialSplashScreen extends MaterialWidget implements HasVisibilit } public void show(){ - getElement().getStyle().setDisplay(Display.BLOCK); + getElement().getStyle().setDisplay(Display.BLOCK.getGwtDisplay()); } public void hide(){ - getElement().getStyle().setDisplay(Display.NONE); + getElement().getStyle().setDisplay(Display.NONE.getGwtDisplay()); } }

['gwt-material/src/main/java/gwt/material/design/client/base/mixin/ProgressMixin.java', 'gwt-material/src/main/java/gwt/material/design/client/base/AbstractTextWidget.java', 'gwt-material/src/main/java/gwt/material/design/client/base/HasInlineStyle.java', 'gwt-material/src/main/java/gwt/material/design/client/constants/Display.java', 'gwt-material/src/main/java/gwt/material/design/client/base/HasFlexbox.java', 'gwt-material/src/main/java/gwt/material/design/client/ui/MaterialSplashScreen.java', 'gwt-material/src/main/java/gwt/material/design/client/base/MaterialWidget.java', 'gwt-material/src/main/java/gwt/material/design/client/ui/MaterialCollapsibleItem.java', 'gwt-material/src/main/java/gwt/material/design/client/base/mixin/FlexboxMixin.java']

{'.java': 9}

Java

{'Java': 1902077, 'JavaScript': 396598, 'CSS': 97198, 'Batchfile': 674, 'Shell': 384}

Apache License 2.0

citrusframework/citrus/598/588

citrusframework

citrus

https://github.com/citrusframework/citrus/issues/588

https://github.com/citrusframework/citrus/pull/598

https://github.com/citrusframework/citrus/pull/598

fixes

BooleanExpressionParser parses expression groups containing boolean strings inconsistently

**Citrus Version** 2.7.8 **Expected behavior** As a user I would expect Citrus to consistently parse valid boolean expression like `(i = 5) and (${conditional} = true)` in e.g. iteration containers. **Actual behavior** Expression groups containing strings, like `(${conditional} = true)`, are handled inconsistently by `BooleanExpressionParser`. Due to its implementation, these groups require additional spaces between expression and parentheses, otherwise parsing will fail. `com.consol.citrus.exceptions.CitrusRuntimeException: Unknown operator 'false)'` Source: [stackoverflow](https://stackoverflow.com/questions/53928625/cannot-use-test-on-variable-to-exit-in-citrus-repeat-until-statement) **Test case sample** > Please, share the test case (as small as possible) which shows the issue ``` public class ExpressionParserTest extends TestNGCitrusTestRunner { /** * Test fails b/c '(${conditional} = true)' is not parsed correctly * @param runner Citrus TestRunner */ @Test @Parameters("runner") @CitrusTest public void failingTest(@Optional @CitrusResource TestRunner runner) { runner.createVariable("conditional", String.valueOf(true)); runner.repeat().until("(i = 5) and (${conditional} = true)").index("i").actions( runner.sleep(1000), new AbstractTestAction() { @Override public void doExecute(TestContext testContext) { System.out.println(testContext.getVariable("i")); } } ); } /** * Test succeeds due to spaces in expression * @param runner Citrus TestRunner */ @Test @Parameters("runner") @CitrusTest public void successfulTest(@Optional @CitrusResource TestRunner runner) { runner.createVariable("conditional", String.valueOf(true)); runner.repeat().until("(j = 5) and ( ${conditional} = true )").index("j").actions( runner.sleep(1000), new AbstractTestAction() { @Override public void doExecute(TestContext testContext) { System.out.println(testContext.getVariable("j")); } } ); } } ```

dded6e61012d64a98d70e3a4be95c84eb0c52904

98575325fe8037e995c91b2d9cc8667938a0a67b

https://github.com/citrusframework/citrus/compare/dded6e61012d64a98d70e3a4be95c84eb0c52904...98575325fe8037e995c91b2d9cc8667938a0a67b

diff --git a/modules/citrus-core/src/main/java/com/consol/citrus/util/BooleanExpressionParser.java b/modules/citrus-core/src/main/java/com/consol/citrus/util/BooleanExpressionParser.java index 0b89a1796..8ea578945 100644 --- a/modules/citrus-core/src/main/java/com/consol/citrus/util/BooleanExpressionParser.java +++ b/modules/citrus-core/src/main/java/com/consol/citrus/util/BooleanExpressionParser.java @@ -1,5 +1,5 @@ /* - * Copyright 2006-2010 the original author or authors. + * Copyright 2006-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -19,164 +19,319 @@ package com.consol.citrus.util; import com.consol.citrus.exceptions.CitrusRuntimeException; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -import org.springframework.util.CollectionUtils; -import java.util.*; +import java.util.ArrayDeque; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Deque; +import java.util.List; +import java.util.NoSuchElementException; + +import static java.lang.Boolean.FALSE; +import static java.lang.Boolean.TRUE; /** * Parses boolean expression strings and evaluates to boolean result. - * - * @author Christoph Deppisch */ -@SuppressWarnings("unchecked") public final class BooleanExpressionParser { - - /** List of known operators */ - private static final List<String> OPERATORS = new ArrayList<String>( - CollectionUtils.arrayToList(new String[]{"(", "=", "and", "or", "lt", "lt=", "gt", "gt=", ")"})); - /** List of known boolean values */ - private static final List<String> BOOLEAN_VALUES = new ArrayList<String>( - CollectionUtils.arrayToList(new String[]{"true", "false"})); - + /** + * List of known non-boolean operators + */ + private static final List<String> OPERATORS = new ArrayList<>(Arrays.asList("lt", "lt=", "gt", "gt=")); + + /** + * List of known boolean operators + */ + private static final List<String> BOOLEAN_OPERATORS = new ArrayList<>(Arrays.asList("=", "and", "or")); + + /** + * List of known boolean values + */ + private static final List<String> BOOLEAN_VALUES = new ArrayList<>( + Arrays.asList(TRUE.toString(), FALSE.toString())); + + /** + * SeparatorToken is an explicit type to identify different kinds of separators. + */ + private enum SeparatorToken { + SPACE(' '), + OPEN_PARENTHESIS('('), + CLOSE_PARENTHESIS(')'); + + private final Character value; + + SeparatorToken(final Character value) { + this.value = value; + } + + @Override + public String toString(){ + return value.toString(); + } + } + /** * Logger */ - private static Logger log = LoggerFactory.getLogger(BooleanExpressionParser.class); + private static final Logger log = LoggerFactory.getLogger(BooleanExpressionParser.class); /** * Prevent instantiation. */ private BooleanExpressionParser() { } - + /** * Perform evaluation of boolean expression string. - * @param expression - * @throws CitrusRuntimeException - * @return + * + * @param expression The expression to evaluate + * @return boolean result + * @throws CitrusRuntimeException When unable to parse expression */ - public static boolean evaluate(String expression) { - Stack<String> operators = new Stack<String>(); - Stack<String> values = new Stack<String>(); - boolean result = true; + public static boolean evaluate(final String expression) { + final Deque<String> operators = new ArrayDeque<>(); + final Deque<String> values = new ArrayDeque<>(); + final boolean result; - char actChar; + char currentCharacter; + int currentCharacterIndex = 0; try { - for (int i = 0; i < expression.length(); i++) { - actChar = expression.charAt(i); - - if (actChar == '(') { - operators.push("("); - } else if (actChar == ' ') { - continue; //ignore - } else if (actChar == ')') { - String operator = operators.pop(); - while (!(operator).equals("(")) { - values.push(getBooleanResultAsString(operator, values.pop(), values.pop())); - operator = operators.pop(); - } - } else if (!Character.isDigit(actChar)) { - StringBuffer operatorBuffer = new StringBuffer(); - - int m = i; - do { - operatorBuffer.append(actChar); - m++; - - if (m < expression.length()) { - actChar = expression.charAt(m); - } - } while (m < expression.length() && !Character.isDigit(actChar) && !(actChar == ' ') && !(actChar == '(')); - - i = m - 1; - - if (BOOLEAN_VALUES.contains(operatorBuffer.toString())) { - values.push(Boolean.valueOf(operatorBuffer.toString()) ? "1" : "0"); + while (currentCharacterIndex < expression.length()) { + currentCharacter = expression.charAt(currentCharacterIndex); + + if (SeparatorToken.OPEN_PARENTHESIS.value == currentCharacter) { + operators.push(SeparatorToken.OPEN_PARENTHESIS.toString()); + currentCharacterIndex += moveCursor(SeparatorToken.OPEN_PARENTHESIS.toString()); + } else if (SeparatorToken.SPACE.value == currentCharacter) { + currentCharacterIndex += moveCursor(SeparatorToken.SPACE.toString()); + } else if (SeparatorToken.CLOSE_PARENTHESIS.value == currentCharacter) { + evaluateSubexpression(operators, values); + currentCharacterIndex += moveCursor(SeparatorToken.CLOSE_PARENTHESIS.toString()); + } else if (!Character.isDigit(currentCharacter)) { + final String parsedNonDigit = parseNonDigits(expression, currentCharacterIndex); + if (isBoolean(parsedNonDigit)) { + values.push(replaceBooleanStringByIntegerRepresentation(parsedNonDigit)); } else { - operators.push(validateOperator(operatorBuffer.toString())); + operators.push(validateOperator(parsedNonDigit)); } - } else if (Character.isDigit(actChar)) { - StringBuffer digitBuffer = new StringBuffer(); - - int m = i; - do { - digitBuffer.append(actChar); - m++; - - if (m < expression.length()) { - actChar = expression.charAt(m); - } - } while (m < expression.length() && Character.isDigit(actChar)); - - i = m - 1; - - values.push(digitBuffer.toString()); + currentCharacterIndex += moveCursor(parsedNonDigit); + } else if (Character.isDigit(currentCharacter)) { + final String parsedDigits = parseDigits(expression, currentCharacterIndex); + values.push(parsedDigits); + currentCharacterIndex += moveCursor(parsedDigits); } } - - while (!operators.isEmpty()) { - values.push(getBooleanResultAsString(operators.pop(), values.pop(), values.pop())); - } - - String value = values.pop(); - if (value.equals("0")) { - value = "false"; - } else if (value.equals("1")) { - value = "true"; - } + result = Boolean.valueOf(evaluateExpressionStack(operators, values)); - result = Boolean.valueOf(value).booleanValue(); - if (log.isDebugEnabled()) { - log.debug("Boolean expression " + expression + " evaluates to " + result); + log.debug("Boolean expression {} evaluates to {}", expression, result); } - } catch(EmptyStackException e) { + } catch (final NoSuchElementException e) { throw new CitrusRuntimeException("Unable to parse boolean expression '" + expression + "'. Maybe expression is incomplete!", e); } return result; } - + + /** + * This method takes stacks of operators and values and evaluates possible expressions + * This is done by popping one operator and two values, applying the operator to the values and pushing the result back onto the value stack + * + * @param operators Operators to apply + * @param values Values + * @return The final result popped of the values stack + */ + private static String evaluateExpressionStack(final Deque<String> operators, final Deque<String> values) { + while (!operators.isEmpty()) { + values.push(getBooleanResultAsString(operators.pop(), values.pop(), values.pop())); + } + return replaceIntegerStringByBooleanRepresentation(values.pop()); + } + + /** + * Evaluates a sub expression within a pair of parentheses and pushes its result onto the stack of values + * + * @param operators Stack of operators + * @param values Stack of values + */ + private static void evaluateSubexpression(final Deque<String> operators, final Deque<String> values) { + String operator = operators.pop(); + while (!(operator).equals(SeparatorToken.OPEN_PARENTHESIS.toString())) { + values.push(getBooleanResultAsString(operator, + values.pop(), + values.pop())); + operator = operators.pop(); + } + } + + /** + * This method reads digit characters from a given string, starting at a given index. + * It will read till the end of the string or up until it encounters a non-digit character + * + * @param expression The string to parse + * @param startIndex The start index from where to parse + * @return The parsed substring + */ + private static String parseDigits(final String expression, final int startIndex) { + final StringBuilder digitBuffer = new StringBuilder(); + + char currentCharacter = expression.charAt(startIndex); + int subExpressionIndex = startIndex; + + do { + digitBuffer.append(currentCharacter); + ++subExpressionIndex; + + if (subExpressionIndex < expression.length()) { + currentCharacter = expression.charAt(subExpressionIndex); + } + } while (subExpressionIndex < expression.length() && Character.isDigit(currentCharacter)); + + return digitBuffer.toString(); + } + + /** + * This method reads non-digit characters from a given string, starting at a given index. + * It will read till the end of the string or up until it encounters + * <p> + * - a digit + * - a separator token + * + * @param expression The string to parse + * @param startIndex The start index from where to parse + * @return The parsed substring + */ + private static String parseNonDigits(final String expression, final int startIndex) { + final StringBuilder operatorBuffer = new StringBuilder(); + + char currentCharacter = expression.charAt(startIndex); + int subExpressionIndex = startIndex; + do { + operatorBuffer.append(currentCharacter); + subExpressionIndex++; + + if (subExpressionIndex < expression.length()) { + currentCharacter = expression.charAt(subExpressionIndex); + } + } while (subExpressionIndex < expression.length() && !Character.isDigit(currentCharacter) && !isSeparatorToken(currentCharacter)); + + return operatorBuffer.toString(); + } + + /** + * Checks whether a string can be interpreted as a boolean value. + * + * @param possibleBoolean The possible boolean value as string + * @return Either true or false + */ + private static Boolean isBoolean(final String possibleBoolean) { + return BOOLEAN_VALUES.contains(possibleBoolean); + } + + /** + * Checks whether a String is a Boolean value and replaces it with its Integer representation + * "true" -> "1" + * "false" -> "0" + * + * @param possibleBooleanString "true" or "false" + * @return "1" or "0" + */ + private static String replaceBooleanStringByIntegerRepresentation(final String possibleBooleanString) { + if (possibleBooleanString.equals(TRUE.toString())) { + return "1"; + } else if (possibleBooleanString.equals(FALSE.toString())) { + return "0"; + } + return possibleBooleanString; + } + + /** + * Counterpart of {@link #replaceBooleanStringByIntegerRepresentation} + * Checks whether a String is the Integer representation of a Boolean value and replaces it with its Boolean representation + * "1" -> "true" + * "0" -> "false" + * otherwise -> value + * + * @param value "1", "0" or other string + * @return "true", "false" or the input value + */ + private static String replaceIntegerStringByBooleanRepresentation(final String value) { + if (value.equals("0")) { + return FALSE.toString(); + } else if (value.equals("1")) { + return TRUE.toString(); + } + return value; + } + + /** + * Checks whether a given character is a known separator token or no + * + * @param possibleSeparatorChar The character to check + * @return True in case its a separator, false otherwise + */ + private static boolean isSeparatorToken(final char possibleSeparatorChar) { + for (final SeparatorToken token : SeparatorToken.values()) { + if (token.value == possibleSeparatorChar) { + return true; + } + } + return false; + } + /** * Check if operator is known to this class. + * * @param operator to validate * @return the operator itself. - * @throws CitrusRuntimeException + * @throws CitrusRuntimeException When encountering an unknown operator */ - private static String validateOperator(String operator) { - if (!OPERATORS.contains(operator)) { + private static String validateOperator(final String operator) { + if (!OPERATORS.contains(operator) && !BOOLEAN_OPERATORS.contains(operator)) { throw new CitrusRuntimeException("Unknown operator '" + operator + "'"); } return operator; } + /** + * Returns the amount of characters to move the cursor after parsing a token + * + * @param lastToken Last parsed token + * @return Amount of characters to move forward + */ + private static int moveCursor(final String lastToken) { + return lastToken.length(); + } + /** * Evaluates a boolean expression to a String representation (true/false). - * @param operator - * @param value1 - * @param value2 + * + * @param operator The operator to apply on operands + * @param rightOperand The right hand side of the expression + * @param leftOperand The left hand side of the expression * @return true/false as String */ - private static String getBooleanResultAsString(String operator, String value1, String value2) { - if (operator.equals("lt")) { - return Boolean.valueOf(Integer.valueOf(value2).intValue() < Integer.valueOf(value1).intValue()).toString(); - } else if (operator.equals("lt=")) { - return Boolean.valueOf(Integer.valueOf(value2).intValue() <= Integer.valueOf(value1).intValue()).toString(); - } else if (operator.equals("gt")) { - return Boolean.valueOf(Integer.valueOf(value2).intValue() > Integer.valueOf(value1).intValue()).toString(); - } else if (operator.equals("gt=")) { - return Boolean.valueOf(Integer.valueOf(value2).intValue() >= Integer.valueOf(value1).intValue()).toString(); - } else if (operator.equals("=")) { - return Boolean.valueOf(Integer.valueOf(value2).intValue() == Integer.valueOf(value1).intValue()).toString(); - } else if (operator.equals("and")) { - return Boolean.valueOf(Boolean.valueOf(value2).booleanValue() && Boolean.valueOf(value1).booleanValue()).toString(); - } else if (operator.equals("or")) { - return Boolean.valueOf(Boolean.valueOf(value2).booleanValue() || Boolean.valueOf(value1).booleanValue()).toString(); - } else { - throw new CitrusRuntimeException("Unknown operator '" + operator + "'"); + private static String getBooleanResultAsString(final String operator, final String rightOperand, final String leftOperand) { + switch (operator) { + case "lt": + return Boolean.toString(Integer.valueOf(leftOperand) < Integer.valueOf(rightOperand)); + case "lt=": + return Boolean.toString(Integer.valueOf(leftOperand) <= Integer.valueOf(rightOperand)); + case "gt": + return Boolean.toString(Integer.valueOf(leftOperand) > Integer.valueOf(rightOperand)); + case "gt=": + return Boolean.toString(Integer.valueOf(leftOperand) >= Integer.valueOf(rightOperand)); + case "=": + return Boolean.toString(Integer.parseInt(leftOperand) == Integer.parseInt(rightOperand)); + case "and": + return Boolean.toString(Boolean.valueOf(leftOperand) && Boolean.valueOf(rightOperand)); + case "or": + return Boolean.toString(Boolean.valueOf(leftOperand) || Boolean.valueOf(rightOperand)); + default: + throw new CitrusRuntimeException("Unknown operator '" + operator + "'"); } } } diff --git a/modules/citrus-core/src/test/java/com/consol/citrus/util/BooleanExpressionParserTest.java b/modules/citrus-core/src/test/java/com/consol/citrus/util/BooleanExpressionParserTest.java index 40aff4ac5..28d319b31 100644 --- a/modules/citrus-core/src/test/java/com/consol/citrus/util/BooleanExpressionParserTest.java +++ b/modules/citrus-core/src/test/java/com/consol/citrus/util/BooleanExpressionParserTest.java @@ -1,5 +1,5 @@ /* - * Copyright 2006-2010 the original author or authors. + * Copyright 2006-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -48,6 +48,10 @@ public class BooleanExpressionParserTest { Assert.assertFalse(BooleanExpressionParser.evaluate("(1 lt 1) and (2 gt 2)")); Assert.assertFalse(BooleanExpressionParser.evaluate("(1 gt 2) or (2 = 3)")); Assert.assertFalse(BooleanExpressionParser.evaluate("((1 = 5) and (2 = 6)) or (2 lt 1)")); + } + + @Test + public void testExpressionParserWithStringValues() { Assert.assertTrue(BooleanExpressionParser.evaluate("true")); Assert.assertTrue(BooleanExpressionParser.evaluate("true = true")); Assert.assertTrue(BooleanExpressionParser.evaluate("false = false")); @@ -56,13 +60,21 @@ public class BooleanExpressionParserTest { Assert.assertFalse(BooleanExpressionParser.evaluate("false = true")); Assert.assertTrue(BooleanExpressionParser.evaluate("( false = false ) and ( true = true )")); Assert.assertFalse(BooleanExpressionParser.evaluate("( false = false ) and ( true = false )")); + Assert.assertTrue(BooleanExpressionParser.evaluate("(false = false) and (true = true)")); + Assert.assertFalse(BooleanExpressionParser.evaluate("(false = false) and (true = false)")); + Assert.assertTrue(BooleanExpressionParser.evaluate("( false = false) and (true = true )")); + Assert.assertFalse(BooleanExpressionParser.evaluate("(false = false ) and ( true = false)")); + Assert.assertTrue(BooleanExpressionParser.evaluate("( true = false ) or ( false = false )")); + Assert.assertTrue(BooleanExpressionParser.evaluate("(false = false) or (true = true)")); + Assert.assertTrue(BooleanExpressionParser.evaluate("(false = false) or (true = false)")); + Assert.assertTrue(BooleanExpressionParser.evaluate("(false = false ) or ( true = false)")); } @Test public void testExpressionParserWithUnknownOperator() { try { BooleanExpressionParser.evaluate("wahr"); - } catch(CitrusRuntimeException e) { + } catch(final CitrusRuntimeException e) { Assert.assertEquals(e.getLocalizedMessage(), "Unknown operator 'wahr'"); return; } @@ -74,7 +86,7 @@ public class BooleanExpressionParserTest { public void testExpressionParserWithBrokenExpression() { try { BooleanExpressionParser.evaluate("1 = "); - } catch(CitrusRuntimeException e) { + } catch(final CitrusRuntimeException e) { Assert.assertEquals(e.getLocalizedMessage(), "Unable to parse boolean expression '1 = '. Maybe expression is incomplete!"); return; }

['modules/citrus-core/src/test/java/com/consol/citrus/util/BooleanExpressionParserTest.java', 'modules/citrus-core/src/main/java/com/consol/citrus/util/BooleanExpressionParser.java']

{'.java': 2}

Java

{'Java': 12001798, 'Groovy': 120014, 'XSLT': 39429, 'Shell': 34409, 'HTML': 12074, 'Makefile': 1941, 'Gherkin': 798, 'Dockerfile': 107}

Apache License 2.0

gluufederation/oxauth/741/739

gluufederation

oxauth

https://github.com/GluuFederation/oxAuth/issues/739

https://github.com/GluuFederation/oxAuth/pull/741

https://github.com/GluuFederation/oxAuth/pull/741

fix

Fix the list of scopes in the authorization page

A dynamically registered client only gets the `openid` scope. Yet oxAuth is prompting for release of scopes like `profile` and `email` based on client request. Although data is not being leaked, it oxAuth is presenting the wrong authorization message to the user. We should also add a _**negative test**_ to reflect the above case.

be362879d6b8009d918d87a4b6ba98ced398aee7

72eb2370d62ee84c49e3b55ca3bf37bc57e3176c

https://github.com/gluufederation/oxauth/compare/be362879d6b8009d918d87a4b6ba98ced398aee7...72eb2370d62ee84c49e3b55ca3bf37bc57e3176c

diff --git a/Server/src/main/java/org/xdi/oxauth/model/authorize/ScopeChecker.java b/Server/src/main/java/org/xdi/oxauth/model/authorize/ScopeChecker.java index 8e847f619..b504f159b 100644 --- a/Server/src/main/java/org/xdi/oxauth/model/authorize/ScopeChecker.java +++ b/Server/src/main/java/org/xdi/oxauth/model/authorize/ScopeChecker.java @@ -6,24 +6,24 @@ package org.xdi.oxauth.model.authorize; -import java.util.HashSet; -import java.util.Set; - -import javax.ejb.Stateless; -import javax.inject.Inject; -import javax.inject.Named; - import org.apache.commons.lang.StringUtils; import org.slf4j.Logger; import org.xdi.oxauth.model.registration.Client; import org.xdi.oxauth.service.ScopeService; +import javax.ejb.Stateless; +import javax.inject.Inject; +import javax.inject.Named; +import java.util.HashSet; +import java.util.Set; + /** * Validates the scopes received for the authorize web service. * * @author Yuriy Zabrovarnyy * @author Yuriy Movchan - * @version June 3, 2015 + * @author Javier Rojas Blum + * @version January 30, 2018 */ @Stateless @Named("scopeChecker") @@ -39,6 +39,10 @@ public class ScopeChecker { log.debug("Checking scopes policy for: " + scope); Set<String> grantedScopes = new HashSet<String>(); + if (scope == null || client == null) { + return grantedScopes; + } + final String[] scopesRequested = scope.split(" "); final String[] scopesAllowed = client.getScopes();

['Server/src/main/java/org/xdi/oxauth/model/authorize/ScopeChecker.java']

{'.java': 1}

Java

{'Java': 8006952, 'JavaScript': 1475711, 'Python': 1042483, 'HTML': 696561, 'CSS': 91820, 'Mustache': 2244, 'Shell': 302, 'Batchfile': 78}

MIT License

gluufederation/oxauth/1821/1820

gluufederation

oxauth

https://github.com/GluuFederation/oxAuth/issues/1820

https://github.com/GluuFederation/oxAuth/pull/1821

https://github.com/GluuFederation/oxAuth/pull/1821

fix

bug(oxauth): apply `clientWhiteList` when session is valid (`allowPostLogoutRedirectWithoutValidation=true` )

## Describe the issue When session is valid and `allowPostLogoutRedirectWithoutValidation=true` call to `/end_session` does not run check against `clientWhiteList` for `post_logout_redirect_uri`.

cf82315ba562d575786ecb3856a31e80182fbd8f

1eb990a5e5b4dbc26c9bbe4955c497178cfe5772

https://github.com/gluufederation/oxauth/compare/cf82315ba562d575786ecb3856a31e80182fbd8f...1eb990a5e5b4dbc26c9bbe4955c497178cfe5772

diff --git a/Server/src/main/java/org/gluu/oxauth/session/ws/rs/EndSessionRestWebServiceImpl.java b/Server/src/main/java/org/gluu/oxauth/session/ws/rs/EndSessionRestWebServiceImpl.java index 237d64cd2..94bcffa60 100644 --- a/Server/src/main/java/org/gluu/oxauth/session/ws/rs/EndSessionRestWebServiceImpl.java +++ b/Server/src/main/java/org/gluu/oxauth/session/ws/rs/EndSessionRestWebServiceImpl.java @@ -8,7 +8,6 @@ package org.gluu.oxauth.session.ws.rs; import com.google.common.collect.Maps; import com.google.common.collect.Sets; -import org.apache.commons.lang.BooleanUtils; import org.apache.commons.lang.StringUtils; import org.gluu.model.security.Identity; import org.gluu.oxauth.audit.ApplicationAuditLogger; @@ -57,6 +56,8 @@ import java.util.Set; import java.util.concurrent.ExecutorService; import java.util.concurrent.TimeUnit; +import static org.apache.commons.lang.BooleanUtils.isTrue; + /** * @author Javier Rojas Blum * @author Yuriy Movchan @@ -262,7 +263,13 @@ public class EndSessionRestWebServiceImpl implements EndSessionRestWebService { final Boolean allowPostLogoutRedirectWithoutValidation = appConfiguration.getAllowPostLogoutRedirectWithoutValidation(); return allowPostLogoutRedirectWithoutValidation != null && allowPostLogoutRedirectWithoutValidation && - new URLPatternList(appConfiguration.getClientWhiteList()).isUrlListed(postLogoutRedirectUri); + isUrlWhiteListed(postLogoutRedirectUri); + } + + public boolean isUrlWhiteListed(String url) { + final boolean result = new URLPatternList(appConfiguration.getClientWhiteList()).isUrlListed(url); + log.trace("White listed result: {}, url: {}", result, url); + return result; } private SessionId validateSidRequestParameter(String sid, String postLogoutRedirectUri) { @@ -280,7 +287,7 @@ public class EndSessionRestWebServiceImpl implements EndSessionRestWebService { } public Jwt validateIdTokenHint(String idTokenHint, SessionId sidSession, String postLogoutRedirectUri) { - final boolean isIdTokenHintRequired = BooleanUtils.isTrue(appConfiguration.getForceIdTokenHintPrecense()); + final boolean isIdTokenHintRequired = isTrue(appConfiguration.getForceIdTokenHintPrecense()); if (isIdTokenHintRequired && StringUtils.isBlank(idTokenHint)) { // must be present for logout tests #1279 final String reason = "id_token_hint is not set"; @@ -336,7 +343,7 @@ public class EndSessionRestWebServiceImpl implements EndSessionRestWebService { throw new WebApplicationException(createErrorResponse(postLogoutRedirectUri, EndSessionErrorResponseType.INVALID_GRANT_AND_SESSION, "id_token signature verification failed.")); } - if (BooleanUtils.isTrue(appConfiguration.getAllowEndSessionWithUnmatchedSid())) { + if (isTrue(appConfiguration.getAllowEndSessionWithUnmatchedSid())) { return; } final String sidClaim = jwt.getClaims().getClaimAsString("sid"); @@ -375,8 +382,8 @@ public class EndSessionRestWebServiceImpl implements EndSessionRestWebService { if (StringUtils.isBlank(postLogoutRedirectUri)) { return ""; } - if (appConfiguration.getAllowPostLogoutRedirectWithoutValidation()) { - log.trace("Skipped post_logout_redirect_uri validation (because allowPostLogoutRedirectWithoutValidation=true)"); + if (isTrue(appConfiguration.getAllowPostLogoutRedirectWithoutValidation()) && isUrlWhiteListed(postLogoutRedirectUri)) { + log.trace("Skipped post_logout_redirect_uri validation (because allowPostLogoutRedirectWithoutValidation=true and white listed)"); return postLogoutRedirectUri; }

['Server/src/main/java/org/gluu/oxauth/session/ws/rs/EndSessionRestWebServiceImpl.java']

{'.java': 1}

Java

{'Java': 8006952, 'JavaScript': 1475711, 'Python': 1042483, 'HTML': 696561, 'CSS': 91820, 'Mustache': 2244, 'Shell': 302, 'Batchfile': 78}

MIT License

gluufederation/oxauth/1726/1725

gluufederation

oxauth

https://github.com/GluuFederation/oxAuth/issues/1725

https://github.com/GluuFederation/oxAuth/pull/1726

https://github.com/GluuFederation/oxAuth/pull/1726

fix

test(oxauth): SpontaneousScopeHttpTest fails during build

## Describe the issue ``` at org.testng.Assert.fail(Assert.java:96) at org.testng.Assert.failNotEquals(Assert.java:776) at org.testng.Assert.assertTrue(Assert.java:44) at org.testng.Assert.assertTrue(Assert.java:54) at org.gluu.oxauth.ws.rs.SpontaneousScopeHttpTest.spontaneousScope(SpontaneousScopeHttpTest.java:54) ``` ## Steps To Reproduce Run build with tests ## Expected behavior Test must pass. ## Actual behavior Fails.

980e29440ffdc0f6722516852337380470923fa1

efd7e1ef0ad4f1dd4a37c3e35515d53bfd8e9eb7

https://github.com/gluufederation/oxauth/compare/980e29440ffdc0f6722516852337380470923fa1...efd7e1ef0ad4f1dd4a37c3e35515d53bfd8e9eb7

diff --git a/Model/src/main/java/org/gluu/oxauth/model/configuration/AppConfiguration.java b/Model/src/main/java/org/gluu/oxauth/model/configuration/AppConfiguration.java index 76fd97c4e..82498084b 100644 --- a/Model/src/main/java/org/gluu/oxauth/model/configuration/AppConfiguration.java +++ b/Model/src/main/java/org/gluu/oxauth/model/configuration/AppConfiguration.java @@ -70,7 +70,7 @@ public class AppConfiguration implements Configuration { private int statTimerIntervalInSeconds; private int statWebServiceIntervalLimitInSeconds; - private Boolean allowSpontaneousScopes; + private Boolean allowSpontaneousScopes = true; private int spontaneousScopeLifetime; private String openidSubAttribute; private Set<Set<ResponseType>> responseTypesSupported; @@ -1215,7 +1215,7 @@ public class AppConfiguration implements Configuration { } public Boolean getAllowSpontaneousScopes() { - if (allowSpontaneousScopes == null) allowSpontaneousScopes = false; + if (allowSpontaneousScopes == null) allowSpontaneousScopes = true; return allowSpontaneousScopes; }

['Model/src/main/java/org/gluu/oxauth/model/configuration/AppConfiguration.java']

{'.java': 1}

Java

{'Java': 8006952, 'JavaScript': 1475711, 'Python': 1042483, 'HTML': 696561, 'CSS': 91820, 'Mustache': 2244, 'Shell': 302, 'Batchfile': 78}

MIT License

gluufederation/oxauth/1724/1723

gluufederation

oxauth

https://github.com/GluuFederation/oxAuth/issues/1723

https://github.com/GluuFederation/oxAuth/pull/1724

https://github.com/GluuFederation/oxAuth/pull/1724

fix

bug(oxauth): fix NPE in JwtAuthorizationRequest

## Describe the issue ``` java.lang.NullPointerException: null at org.gluu.oxauth.model.authorize.JwtAuthorizationRequest.createJwtRequest(JwtAuthorizationRequest.java:466) ~[classes/:?] at org.gluu.oxauth.bcauthorize.ws.rs.BackchannelAuthorizeRestWebServiceImpl.requestBackchannelAuthorizationPost(BackchannelAuthorizeRestWebServiceImpl.java:167) ~[classes/:?] at org.gluu.oxauth.bcauthorize.ws.rs.BackchannelAuthorizeRestWebServiceImpl$Proxy$_$$_WeldClientProxy.requestBackchannelAuthorizationPost(Unknown Source) ~[classes/:?] at jdk.internal.reflect.GeneratedMethodAccessor660.invoke(Unknown Source) ~[?:?] at jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) ~[?:?] ``` ## Expected behavior There must not be NPE. ## Actual behavior NPE if redirect response is null.

3fe6db5e932216dc53ae5c1ec66bf466cb706219

8d9d6c4d6afba46f880bfda54f8e7b50f97b95bd

https://github.com/gluufederation/oxauth/compare/3fe6db5e932216dc53ae5c1ec66bf466cb706219...8d9d6c4d6afba46f880bfda54f8e7b50f97b95bd

diff --git a/Server/src/main/java/org/gluu/oxauth/model/authorize/JwtAuthorizationRequest.java b/Server/src/main/java/org/gluu/oxauth/model/authorize/JwtAuthorizationRequest.java index 72773d939..2e1dfb565 100644 --- a/Server/src/main/java/org/gluu/oxauth/model/authorize/JwtAuthorizationRequest.java +++ b/Server/src/main/java/org/gluu/oxauth/model/authorize/JwtAuthorizationRequest.java @@ -463,7 +463,7 @@ public class JwtAuthorizationRequest { } public static JwtAuthorizationRequest createJwtRequest(String request, String requestUri, Client client, RedirectUriResponse redirectUriResponse, AbstractCryptoProvider cryptoProvider, AppConfiguration appConfiguration) { - validateRequestUri(requestUri, client, appConfiguration, redirectUriResponse.getState()); + validateRequestUri(requestUri, client, appConfiguration, redirectUriResponse != null ? redirectUriResponse.getState() : null); final String requestFromClient = queryRequest(requestUri, redirectUriResponse, appConfiguration); if (StringUtils.isNotBlank(requestFromClient)) { request = requestFromClient;

['Server/src/main/java/org/gluu/oxauth/model/authorize/JwtAuthorizationRequest.java']

{'.java': 1}

Java

{'Java': 8006952, 'JavaScript': 1475711, 'Python': 1042483, 'HTML': 696561, 'CSS': 91820, 'Mustache': 2244, 'Shell': 302, 'Batchfile': 78}

MIT License

gluufederation/oxauth/740/739

gluufederation

oxauth

https://github.com/GluuFederation/oxAuth/issues/739

https://github.com/GluuFederation/oxAuth/pull/740

https://github.com/GluuFederation/oxAuth/pull/740

fix

Fix the list of scopes in the authorization page

A dynamically registered client only gets the `openid` scope. Yet oxAuth is prompting for release of scopes like `profile` and `email` based on client request. Although data is not being leaked, it oxAuth is presenting the wrong authorization message to the user. We should also add a _**negative test**_ to reflect the above case.

227f79d8aba8e5a7c15151eb4083243e583aa308

113f114a86a1549c031066620d51d161c607bfcc

https://github.com/gluufederation/oxauth/compare/227f79d8aba8e5a7c15151eb4083243e583aa308...113f114a86a1549c031066620d51d161c607bfcc

diff --git a/Client/src/test/java/org/xdi/oxauth/ws/rs/AuthorizationCodeFlowHttpTest.java b/Client/src/test/java/org/xdi/oxauth/ws/rs/AuthorizationCodeFlowHttpTest.java index 1142aa1b4..48ed59c99 100644 --- a/Client/src/test/java/org/xdi/oxauth/ws/rs/AuthorizationCodeFlowHttpTest.java +++ b/Client/src/test/java/org/xdi/oxauth/ws/rs/AuthorizationCodeFlowHttpTest.java @@ -34,7 +34,7 @@ import static org.xdi.oxauth.model.register.RegisterRequestParam.*; * Test cases for the authorization code flow (HTTP) * * @author Javier Rojas Blum - * @version November 29, 2017 + * @version January 30, 2018 */ public class AuthorizationCodeFlowHttpTest extends BaseTest { @@ -153,6 +153,132 @@ public class AuthorizationCodeFlowHttpTest extends BaseTest { assertNull(userInfoResponse.getClaim("work_phone")); } + /** + * Test for the complete Authorization Code Flow. + * Register just the openid scope. + * Request authorization with scopes openid, profile, address, email, phone, user_name. + * Expected result is just prompt the user to authorize openid scope. + */ + @Parameters({"userId", "userSecret", "redirectUris", "redirectUri", "sectorIdentifierUri"}) + @Test + public void authorizationCodeFlowNegativeTest( + final String userId, final String userSecret, final String redirectUris, final String redirectUri, + final String sectorIdentifierUri) throws Exception { + showTitle("authorizationCodeFlow"); + + List<ResponseType> responseTypes = Arrays.asList( + ResponseType.CODE, + ResponseType.ID_TOKEN); + List<String> registerScopes = Arrays.asList("openid"); + + // 1. Register client + RegisterResponse registerResponse = registerClient(redirectUris, responseTypes, registerScopes, sectorIdentifierUri); + + assertTrue(registerResponse.getClaims().containsKey(SCOPE.toString())); + assertNotNull(registerResponse.getClaims().get(SCOPE.toString())); + assertEquals(registerResponse.getClaims().get(SCOPE.toString()), "openid"); + + String clientId = registerResponse.getClientId(); + String clientSecret = registerResponse.getClientSecret(); + + // 2. Request authorization and receive the authorization code. + String nonce = UUID.randomUUID().toString(); + List<String> scopes = Arrays.asList("openid", "profile", "address", "email", "phone", "user_name"); + AuthorizationResponse authorizationResponse = requestAuthorization(userId, userSecret, redirectUri, responseTypes, scopes, clientId, nonce); + + assertEquals(authorizationResponse.getScope(), "openid"); + + String scope = authorizationResponse.getScope(); + String authorizationCode = authorizationResponse.getCode(); + String idToken = authorizationResponse.getIdToken(); + + // 3. Request access token using the authorization code. + TokenRequest tokenRequest = new TokenRequest(GrantType.AUTHORIZATION_CODE); + tokenRequest.setCode(authorizationCode); + tokenRequest.setRedirectUri(redirectUri); + tokenRequest.setAuthUsername(clientId); + tokenRequest.setAuthPassword(clientSecret); + tokenRequest.setAuthenticationMethod(AuthenticationMethod.CLIENT_SECRET_BASIC); + + TokenClient tokenClient1 = new TokenClient(tokenEndpoint); + tokenClient1.setRequest(tokenRequest); + TokenResponse tokenResponse1 = tokenClient1.exec(); + + showClient(tokenClient1); + assertEquals(tokenResponse1.getStatus(), 200, "Unexpected response code: " + tokenResponse1.getStatus()); + assertNotNull(tokenResponse1.getEntity(), "The entity is null"); + assertNotNull(tokenResponse1.getAccessToken(), "The access token is null"); + assertNotNull(tokenResponse1.getExpiresIn(), "The expires in value is null"); + assertNotNull(tokenResponse1.getTokenType(), "The token type is null"); + assertNotNull(tokenResponse1.getRefreshToken(), "The refresh token is null"); + + String refreshToken = tokenResponse1.getRefreshToken(); + + // 4. Validate id_token + Jwt jwt = Jwt.parse(idToken); + assertNotNull(jwt.getHeader().getClaimAsString(JwtHeaderName.TYPE)); + assertNotNull(jwt.getHeader().getClaimAsString(JwtHeaderName.ALGORITHM)); + assertNotNull(jwt.getClaims().getClaimAsString(JwtClaimName.ISSUER)); + assertNotNull(jwt.getClaims().getClaimAsString(JwtClaimName.AUDIENCE)); + assertNotNull(jwt.getClaims().getClaimAsString(JwtClaimName.EXPIRATION_TIME)); + assertNotNull(jwt.getClaims().getClaimAsString(JwtClaimName.ISSUED_AT)); + assertNotNull(jwt.getClaims().getClaimAsString(JwtClaimName.SUBJECT_IDENTIFIER)); + assertNotNull(jwt.getClaims().getClaimAsString(JwtClaimName.CODE_HASH)); + assertNotNull(jwt.getClaims().getClaimAsString(JwtClaimName.AUTHENTICATION_TIME)); + assertNotNull(jwt.getClaims().getClaimAsString(JwtClaimName.OX_OPENID_CONNECT_VERSION)); + + RSAPublicKey publicKey = JwkClient.getRSAPublicKey( + jwksUri, + jwt.getHeader().getClaimAsString(JwtHeaderName.KEY_ID)); + RSASigner rsaSigner = new RSASigner(SignatureAlgorithm.RS256, publicKey); + + assertTrue(rsaSigner.validate(jwt)); + + // 5. Request new access token using the refresh token. + TokenClient tokenClient2 = new TokenClient(tokenEndpoint); + TokenResponse tokenResponse2 = tokenClient2.execRefreshToken(scope, refreshToken, clientId, clientSecret); + + showClient(tokenClient2); + assertEquals(tokenResponse2.getStatus(), 200, "Unexpected response code: " + tokenResponse2.getStatus()); + assertNotNull(tokenResponse2.getEntity(), "The entity is null"); + assertNotNull(tokenResponse2.getAccessToken(), "The access token is null"); + assertNotNull(tokenResponse2.getTokenType(), "The token type is null"); + assertNotNull(tokenResponse2.getRefreshToken(), "The refresh token is null"); + assertNotNull(tokenResponse2.getScope(), "The scope is null"); + assertEquals(tokenResponse2.getScope(), "openid"); + + String accessToken = tokenResponse2.getAccessToken(); + + // 6. Request user info + UserInfoClient userInfoClient = new UserInfoClient(userInfoEndpoint); + UserInfoResponse userInfoResponse = userInfoClient.execUserInfo(accessToken); + + showClient(userInfoClient); + assertEquals(userInfoResponse.getStatus(), 200, "Unexpected response code: " + userInfoResponse.getStatus()); + assertNotNull(userInfoResponse.getClaim(JwtClaimName.SUBJECT_IDENTIFIER)); + assertNull(userInfoResponse.getClaim(JwtClaimName.NAME)); + assertNull(userInfoResponse.getClaim(JwtClaimName.BIRTHDATE)); + assertNull(userInfoResponse.getClaim(JwtClaimName.FAMILY_NAME)); + assertNull(userInfoResponse.getClaim(JwtClaimName.GENDER)); + assertNull(userInfoResponse.getClaim(JwtClaimName.GIVEN_NAME)); + assertNull(userInfoResponse.getClaim(JwtClaimName.MIDDLE_NAME)); + assertNull(userInfoResponse.getClaim(JwtClaimName.NICKNAME)); + assertNull(userInfoResponse.getClaim(JwtClaimName.PICTURE)); + assertNull(userInfoResponse.getClaim(JwtClaimName.PREFERRED_USERNAME)); + assertNull(userInfoResponse.getClaim(JwtClaimName.PROFILE)); + assertNull(userInfoResponse.getClaim(JwtClaimName.WEBSITE)); + assertNull(userInfoResponse.getClaim(JwtClaimName.EMAIL)); + assertNull(userInfoResponse.getClaim(JwtClaimName.EMAIL_VERIFIED)); + assertNull(userInfoResponse.getClaim(JwtClaimName.PHONE_NUMBER)); + assertNull(userInfoResponse.getClaim(JwtClaimName.PHONE_NUMBER_VERIFIED)); + assertNull(userInfoResponse.getClaim(JwtClaimName.ADDRESS)); + assertNull(userInfoResponse.getClaim(JwtClaimName.LOCALE)); + assertNull(userInfoResponse.getClaim(JwtClaimName.ZONEINFO)); + assertNull(userInfoResponse.getClaim(JwtClaimName.USER_NAME)); + assertNull(userInfoResponse.getClaim("org_name")); + assertNull(userInfoResponse.getClaim("work_phone")); + } + @Parameters({"userId", "userSecret", "redirectUris", "redirectUri", "sectorIdentifierUri"}) @Test public void authorizationCodeWithNotAllowedScopeFlow( diff --git a/Server/src/main/java/org/xdi/oxauth/authorize/ws/rs/AuthorizeAction.java b/Server/src/main/java/org/xdi/oxauth/authorize/ws/rs/AuthorizeAction.java index 38b3d92d8..7e3ed7c95 100644 --- a/Server/src/main/java/org/xdi/oxauth/authorize/ws/rs/AuthorizeAction.java +++ b/Server/src/main/java/org/xdi/oxauth/authorize/ws/rs/AuthorizeAction.java @@ -18,6 +18,7 @@ import org.xdi.oxauth.model.auth.AuthenticationMode; import org.xdi.oxauth.model.authorize.AuthorizeErrorResponseType; import org.xdi.oxauth.model.authorize.AuthorizeParamsValidator; import org.xdi.oxauth.model.authorize.AuthorizeRequestParam; +import org.xdi.oxauth.model.authorize.ScopeChecker; import org.xdi.oxauth.model.common.Prompt; import org.xdi.oxauth.model.common.SessionId; import org.xdi.oxauth.model.common.SessionIdState; @@ -51,7 +52,7 @@ import java.util.*; /** * @author Javier Rojas Blum * @author Yuriy Movchan - * @version January 17, 2018 + * @version January 30, 2018 */ @RequestScoped @Named @@ -117,6 +118,9 @@ public class AuthorizeAction { @Inject private RequestParameterService requestParameterService; + @Inject + private ScopeChecker scopeChecker; + // OAuth 2.0 request parameters private String scope; private String responseType; @@ -144,6 +148,8 @@ public class AuthorizeAction { // custom oxAuth parameters private String sessionId; + private String allowedScope; + public void checkUiLocales() { List<String> uiLocalesList = null; if (StringUtils.isNotBlank(uiLocales)) { @@ -187,6 +193,10 @@ public class AuthorizeAction { return; } + // Fix the list of scopes in the authorization page. oxAuth #739 + Set<String> grantedScopes = scopeChecker.checkScopesPolicy(client, scope); + allowedScope = org.xdi.oxauth.model.util.StringUtils.implode(grantedScopes, " "); + SessionId session = getSession(); List<Prompt> prompts = Prompt.fromString(prompt, " "); @@ -343,7 +353,7 @@ public class AuthorizeAction { } public List<org.xdi.oxauth.model.common.Scope> getScopes() { - return authorizeService.getScopes(scope); + return authorizeService.getScopes(allowedScope); } /**

['Client/src/test/java/org/xdi/oxauth/ws/rs/AuthorizationCodeFlowHttpTest.java', 'Server/src/main/java/org/xdi/oxauth/authorize/ws/rs/AuthorizeAction.java']

{'.java': 2}

Java

{'Java': 8006952, 'JavaScript': 1475711, 'Python': 1042483, 'HTML': 696561, 'CSS': 91820, 'Mustache': 2244, 'Shell': 302, 'Batchfile': 78}

MIT License

artipie/artipie/396/395

artipie

artipie

https://github.com/artipie/artipie/issues/395

https://github.com/artipie/artipie/pull/396

https://github.com/artipie/artipie/pull/396

fixes

GitHub API quota is drained too fast when authenticating via personal tokens

When using personal GitHub access tokens, the quota is drained very fast, it seems caching is not working.

60a5e03ce6ad47988068b33cbd91eccd745db43f

800f6d290fa4fe37582b8d7e9d8a0c9d134a7f18

https://github.com/artipie/artipie/compare/60a5e03ce6ad47988068b33cbd91eccd745db43f...800f6d290fa4fe37582b8d7e9d8a0c9d134a7f18

diff --git a/src/main/java/com/artipie/YamlSettings.java b/src/main/java/com/artipie/YamlSettings.java index e3cbaeb09..fb1b249af 100644 --- a/src/main/java/com/artipie/YamlSettings.java +++ b/src/main/java/com/artipie/YamlSettings.java @@ -29,6 +29,7 @@ import com.artipie.asto.Remaining; import com.artipie.asto.Storage; import com.artipie.auth.AuthFromEnv; import com.artipie.auth.AuthFromYaml; +import com.artipie.auth.CachedAuth; import com.artipie.auth.ChainedAuth; import com.artipie.auth.GithubAuth; import com.artipie.http.auth.Authentication; @@ -120,7 +121,7 @@ public final class YamlSettings implements Settings { return auth; } ).thenApply( - auth -> new ChainedAuth(new GithubAuth(), auth) + auth -> new ChainedAuth(new CachedAuth(new GithubAuth()), auth) ); } else if (YamlSettings.hasTypeFile(cred)) { res = CompletableFuture.failedFuture( diff --git a/src/main/java/com/artipie/auth/AuthFromEnv.java b/src/main/java/com/artipie/auth/AuthFromEnv.java index c6a8c8c0c..26f42418f 100644 --- a/src/main/java/com/artipie/auth/AuthFromEnv.java +++ b/src/main/java/com/artipie/auth/AuthFromEnv.java @@ -77,4 +77,9 @@ public final class AuthFromEnv implements Authentication { } return result; } + + @Override + public String toString() { + return String.format("%s()", this.getClass().getSimpleName()); + } } diff --git a/src/main/java/com/artipie/auth/AuthFromYaml.java b/src/main/java/com/artipie/auth/AuthFromYaml.java index b5a68c23b..c4f265709 100644 --- a/src/main/java/com/artipie/auth/AuthFromYaml.java +++ b/src/main/java/com/artipie/auth/AuthFromYaml.java @@ -87,6 +87,11 @@ public final class AuthFromYaml implements Authentication { return res; } + @Override + public String toString() { + return String.format("%s()", this.getClass().getSimpleName()); + } + /** * Checks stored password against the given one with type. * @param stored Password from settings diff --git a/src/main/java/com/artipie/auth/CachedAuth.java b/src/main/java/com/artipie/auth/CachedAuth.java index 5397bd5af..159baee15 100644 --- a/src/main/java/com/artipie/auth/CachedAuth.java +++ b/src/main/java/com/artipie/auth/CachedAuth.java @@ -81,4 +81,12 @@ public final class CachedAuth implements Authentication { public Optional<String> user(final String username, final String password) { return this.cache.computeIfAbsent(username, key -> this.origin.user(key, password)); } + + @Override + public String toString() { + return String.format( + "%s(origin=%s, size=%d)", + this.getClass().getSimpleName(), this.origin, this.cache.size() + ); + } } diff --git a/src/main/java/com/artipie/auth/ChainedAuth.java b/src/main/java/com/artipie/auth/ChainedAuth.java index 4ca9a9838..40c3733a5 100644 --- a/src/main/java/com/artipie/auth/ChainedAuth.java +++ b/src/main/java/com/artipie/auth/ChainedAuth.java @@ -28,6 +28,7 @@ import java.util.Arrays; import java.util.Collections; import java.util.List; import java.util.Optional; +import java.util.stream.Collectors; /** * Chained authentication provider, composed by multiple @@ -79,4 +80,13 @@ public final class ChainedAuth implements Authentication { } return result; } + + @Override + public String toString() { + return String.format( + "%s([%s])", + this.getClass().getSimpleName(), + this.list.stream().map(Object::toString).collect(Collectors.joining(",")) + ); + } } diff --git a/src/main/java/com/artipie/auth/GithubAuth.java b/src/main/java/com/artipie/auth/GithubAuth.java index 1bd721f81..c6868aace 100644 --- a/src/main/java/com/artipie/auth/GithubAuth.java +++ b/src/main/java/com/artipie/auth/GithubAuth.java @@ -92,4 +92,9 @@ public final class GithubAuth implements Authentication { } return result; } + + @Override + public String toString() { + return String.format("%s()", this.getClass().getSimpleName()); + } } diff --git a/src/main/java/com/artipie/auth/LoggingAuth.java b/src/main/java/com/artipie/auth/LoggingAuth.java index 6454fef29..a253ec359 100644 --- a/src/main/java/com/artipie/auth/LoggingAuth.java +++ b/src/main/java/com/artipie/auth/LoggingAuth.java @@ -67,9 +67,17 @@ public final class LoggingAuth implements Authentication { public Optional<String> user(final String username, final String password) { final Optional<String> res = this.origin.user(username, password); if (res.isEmpty()) { - Logger.log(this.level, this.origin, "Failed to authenticate '%s' user", username); + Logger.log( + this.level, this.origin, + "Failed to authenticate '%s' user via %s", + username, this.origin + ); } else { - Logger.log(this.level, this.origin, "Successfully authenticated '%s' user", username); + Logger.log( + this.level, this.origin, + "Successfully authenticated '%s' user via %s", + username, this.origin + ); } return res; }

['src/main/java/com/artipie/auth/GithubAuth.java', 'src/main/java/com/artipie/auth/LoggingAuth.java', 'src/main/java/com/artipie/auth/AuthFromEnv.java', 'src/main/java/com/artipie/auth/ChainedAuth.java', 'src/main/java/com/artipie/auth/AuthFromYaml.java', 'src/main/java/com/artipie/auth/CachedAuth.java', 'src/main/java/com/artipie/YamlSettings.java']

{'.java': 7}

Java

{'Java': 819427, 'HTML': 3447, 'Python': 1338, 'Elixir': 1094, 'Dockerfile': 901, 'JavaScript': 827, 'CSS': 202}

MIT License

hibernate/hibernate-reactive/978/976

hibernate

hibernate-reactive

https://github.com/hibernate/hibernate-reactive/issues/976

https://github.com/hibernate/hibernate-reactive/pull/978

https://github.com/hibernate/hibernate-reactive/pull/978

fixes

ReactiveSessionImpl#reactiveClose()

The implementation of `reactiveClose()` is first closing the connection, and then invoking close() on super. I believe it needs to happen in the opposite order, for two reasons: 1. we need to flag the Session as closed ASAP to produce an error on illegal use 2. the super.close() method might need the connection to finalize pending operations

c5f48c06ad07e45dd2784ee258bad953d471b17c

f2310c0583d52d125674b224c059a8f1abc89441

https://github.com/hibernate/hibernate-reactive/compare/c5f48c06ad07e45dd2784ee258bad953d471b17c...f2310c0583d52d125674b224c059a8f1abc89441

diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/session/impl/ReactiveSessionImpl.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/session/impl/ReactiveSessionImpl.java index a3e18857..0d4dca69 100644 --- a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/session/impl/ReactiveSessionImpl.java +++ b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/session/impl/ReactiveSessionImpl.java @@ -1485,10 +1485,10 @@ public void close() throws HibernateException { @Override public CompletionStage<Void> reactiveClose() { - CompletionStage<Void> closeStage = reactiveConnection != null + super.close(); + return reactiveConnection != null ? reactiveConnection.close() : voidFuture(); - return closeStage.thenAccept( v -> super.close() ); } @Override @SuppressWarnings("unchecked")

['hibernate-reactive-core/src/main/java/org/hibernate/reactive/session/impl/ReactiveSessionImpl.java']

{'.java': 1}

Java

{'Java': 3376271, 'Shell': 1406}

Apache License 2.0

hibernate/hibernate-reactive/360/359

hibernate

hibernate-reactive

https://github.com/hibernate/hibernate-reactive/issues/359

https://github.com/hibernate/hibernate-reactive/pull/360

https://github.com/hibernate/hibernate-reactive/pull/360

fixes

session.remove && session.getReference

Hello, as i understand, following jpa, there is only one way to remove detached entity: ``` factory.withTransaction((session, transaction) -> session.merge(sampleEntity).invokeUni(session::remove) ).await().indefinitely(); ``` Everything is fine, but if it's about performance, merge operation takes large amount of time and can cause real performance troubles. For instance, according to my inaccurate time measurements, removing 5000 entities takes ~4s, in hibernate-orm it takes 50ms. I've just read about a new method called ```session.getReference``` which returns the persistent instance of given entity. Is it possible to allow its use for ```session.remove```?

d265e520441230171f021bc0cc2f27bd9a2fa248

c5c39f5c0f521536b2afa71f0678d0b111e884b9

https://github.com/hibernate/hibernate-reactive/compare/d265e520441230171f021bc0cc2f27bd9a2fa248...c5c39f5c0f521536b2afa71f0678d0b111e884b9

diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/event/impl/DefaultReactiveDeleteEventListener.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/event/impl/DefaultReactiveDeleteEventListener.java index ced3306e..ae6b299d 100644 --- a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/event/impl/DefaultReactiveDeleteEventListener.java +++ b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/event/impl/DefaultReactiveDeleteEventListener.java @@ -105,18 +105,26 @@ public CompletionStage<Void> reactiveOnDelete(DeleteEvent event) throws Hibernat */ public CompletionStage<Void> reactiveOnDelete(DeleteEvent event, IdentitySet transientEntities) throws HibernateException { - final EventSource source = event.getSession(); + EventSource source = event.getSession(); boolean detached = event.getEntityName() != null ? !source.contains( event.getEntityName(), event.getObject() ) : !source.contains( event.getObject() ); if ( detached ) { - // Hibernate Reactive doesn't support detached instances in refresh() - throw new IllegalArgumentException("unmanaged instance passed to refresh()"); + // Hibernate Reactive doesn't support detached instances in remove() + throw new IllegalArgumentException("unmanaged instance passed to remove()"); } - final PersistenceContext persistenceContext = source.getPersistenceContextInternal(); - Object entity = persistenceContext.unproxyAndReassociate( event.getObject() ); + //Object entity = persistenceContext.unproxyAndReassociate( event.getObject() ); + + return ( (ReactiveSession) source ).reactiveFetch( event.getObject(), true ) + .thenCompose( entity -> reactiveOnDelete( event, transientEntities, entity ) ); + } + + private CompletionStage<Void> reactiveOnDelete(DeleteEvent event, IdentitySet transientEntities, Object entity) { + + EventSource source = event.getSession(); + PersistenceContext persistenceContext = source.getPersistenceContextInternal(); EntityEntry entityEntry = persistenceContext.getEntry( entity ); @@ -129,11 +137,17 @@ public CompletionStage<Void> reactiveOnDelete(DeleteEvent event, IdentitySet tra .thenCompose( trans -> { if ( trans ) { // EARLY EXIT!!! - return deleteTransientEntity( source, entity, event.isCascadeDeleteEnabled(), persister, transientEntities ); + return deleteTransientEntity( + source, + entity, + event.isCascadeDeleteEnabled(), + persister, + transientEntities + ); } - performDetachedEntityDeletionCheck( event ); + performDetachedEntityDeletionCheck(event); - final Serializable id = persister.getIdentifier( entity, source ); + final Serializable id = persister.getIdentifier( entity, source); if ( id == null ) { throw new TransientObjectException( @@ -145,7 +159,7 @@ public CompletionStage<Void> reactiveOnDelete(DeleteEvent event, IdentitySet tra persistenceContext.checkUniqueness( key, entity ); - new OnUpdateVisitor( source, id, entity ).process( entity, persister ); + new OnUpdateVisitor(source, id, entity ).process( entity, persister ); final Object version = persister.getVersion( entity ); @@ -160,7 +174,7 @@ public CompletionStage<Void> reactiveOnDelete(DeleteEvent event, IdentitySet tra persister, false ); - persister.afterReassociate( entity, source ); + persister.afterReassociate( entity, source); callbackRegistry.preRemove( entity ); @@ -175,7 +189,7 @@ public CompletionStage<Void> reactiveOnDelete(DeleteEvent event, IdentitySet tra ) .thenAccept( v -> { if ( source.getFactory().getSessionFactoryOptions().isIdentifierRollbackEnabled() ) { - persister.resetIdentifier( entity, id, version, source ); + persister.resetIdentifier( entity, id, version, source); } } ); } ); @@ -204,7 +218,7 @@ public CompletionStage<Void> reactiveOnDelete(DeleteEvent event, IdentitySet tra ) .thenAccept( v -> { if ( source.getFactory().getSessionFactoryOptions().isIdentifierRollbackEnabled() ) { - persister.resetIdentifier( entity, id, version, source ); + persister.resetIdentifier( entity, id, version, source); } } ); } diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/event/impl/DefaultReactiveLockEventListener.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/event/impl/DefaultReactiveLockEventListener.java index b6afb5cb..46a3cef5 100644 --- a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/event/impl/DefaultReactiveLockEventListener.java +++ b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/event/impl/DefaultReactiveLockEventListener.java @@ -61,7 +61,8 @@ public CompletionStage<Void> reactiveOnLock(LockEvent event) throws HibernateExc log.explicitSkipLockedLockCombo(); } - SessionImplementor source = event.getSession(); + EventSource source = event.getSession(); + boolean detached = event.getEntityName() != null ? !source.contains( event.getEntityName(), event.getObject() ) : !source.contains( event.getObject() ); @@ -70,17 +71,26 @@ public CompletionStage<Void> reactiveOnLock(LockEvent event) throws HibernateExc throw new IllegalArgumentException("unmanaged instance passed to refresh()"); } - final PersistenceContext persistenceContext = source.getPersistenceContextInternal(); - Object entity = persistenceContext.unproxyAndReassociate( event.getObject() ); + +// Object entity = persistenceContext.unproxyAndReassociate( event.getObject() ); //TODO: if object was an uninitialized proxy, this is inefficient, // resulting in two SQL selects + return ( (ReactiveSession) source ).reactiveFetch( event.getObject(), true ) + .thenCompose( entity -> reactiveOnLock( event, entity ) ); + } + + private CompletionStage<Void> reactiveOnLock(LockEvent event, Object entity) { + + SessionImplementor source = event.getSession(); + PersistenceContext persistenceContext = source.getPersistenceContextInternal(); + EntityEntry entry = persistenceContext.getEntry(entity); CompletionStage<EntityEntry> stage; if (entry==null) { - final EntityPersister persister = source.getEntityPersister( event.getEntityName(), entity ); - final Serializable id = persister.getIdentifier( entity, source ); - stage = ForeignKeys.isNotTransient( event.getEntityName(), entity, Boolean.FALSE, source ) + final EntityPersister persister = source.getEntityPersister( event.getEntityName(), entity); + final Serializable id = persister.getIdentifier(entity, source); + stage = ForeignKeys.isNotTransient( event.getEntityName(), entity, Boolean.FALSE, source) .thenApply( trans -> { if (!trans) { @@ -100,7 +110,7 @@ public CompletionStage<Void> reactiveOnLock(LockEvent event) throws HibernateExc stage = CompletionStages.completedFuture(entry); } - return stage.thenCompose( e -> upgradeLock( entity, e, event.getLockOptions(), event.getSession() ) ); + return stage.thenCompose( e -> upgradeLock(entity, e, event.getLockOptions(), event.getSession() ) ); } private void cascadeOnLock(LockEvent event, EntityPersister persister, Object entity) { diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/event/impl/DefaultReactiveRefreshEventListener.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/event/impl/DefaultReactiveRefreshEventListener.java index c3fb8402..239a05ab 100644 --- a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/event/impl/DefaultReactiveRefreshEventListener.java +++ b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/event/impl/DefaultReactiveRefreshEventListener.java @@ -26,6 +26,7 @@ import org.hibernate.reactive.engine.impl.CascadingActions; import org.hibernate.reactive.event.ReactiveRefreshEventListener; import org.hibernate.reactive.persister.entity.impl.ReactiveAbstractEntityPersister; +import org.hibernate.reactive.session.ReactiveSession; import org.hibernate.reactive.util.impl.CompletionStages; import org.hibernate.type.CollectionType; import org.hibernate.type.CompositeType; @@ -64,7 +65,8 @@ public void onRefresh(RefreshEvent event, Map refreshedAlready) throws Hibernate */ public CompletionStage<Void> reactiveOnRefresh(RefreshEvent event, IdentitySet refreshedAlready) { - final EventSource source = event.getSession(); + EventSource source = event.getSession(); + boolean detached = event.getEntityName() != null ? !source.contains( event.getEntityName(), event.getObject() ) : !source.contains( event.getObject() ); @@ -73,38 +75,42 @@ public CompletionStage<Void> reactiveOnRefresh(RefreshEvent event, IdentitySet r throw new IllegalArgumentException("unmanaged instance passed to refresh()"); } - final PersistenceContext persistenceContext = source.getPersistenceContextInternal(); - if ( persistenceContext.reassociateIfUninitializedProxy( event.getObject() ) ) { - if ( detached ) { - source.setReadOnly( event.getObject(), source.isDefaultReadOnly() ); - } - return CompletionStages.voidFuture(); - } +// if ( persistenceContext.reassociateIfUninitializedProxy( event.getObject() ) ) { +// if (detached) { +// source.setReadOnly( event.getObject(), source.isDefaultReadOnly() ); +// } +// return CompletionStages.voidFuture(); +// } +// +// final Object entity = persistenceContext.unproxyAndReassociate( event.getObject() ); + + return ( (ReactiveSession) source ).reactiveFetch( event.getObject(), true ) + .thenCompose( entity -> reactiveOnRefresh( event, refreshedAlready, entity ) ); + } - final Object object = persistenceContext.unproxyAndReassociate( event.getObject() ); + private CompletionStage<Void> reactiveOnRefresh(RefreshEvent event, IdentitySet refreshedAlready, Object entity) { + EventSource source = event.getSession(); + PersistenceContext persistenceContext = source.getPersistenceContextInternal(); - if ( refreshedAlready.contains( object ) ) { + if ( refreshedAlready.contains( entity ) ) { LOG.trace( "Already refreshed" ); return CompletionStages.voidFuture(); } - final EntityEntry e = persistenceContext.getEntry( object ); + final EntityEntry e = persistenceContext.getEntry( entity ); final EntityPersister persister; final Serializable id; if ( e == null ) { persister = source.getEntityPersister( event.getEntityName(), - object + entity ); //refresh() does not pass an entityName - id = persister.getIdentifier( object, event.getSession() ); + id = persister.getIdentifier( entity, event.getSession() ); if ( LOG.isTraceEnabled() ) { LOG.tracev( - "Refreshing transient {0}", MessageHelper.infoString( - persister, - id, - source.getFactory() - ) + "Refreshing transient {0}", + MessageHelper.infoString( persister, id, source.getFactory() ) ); } final EntityKey key = source.generateEntityKey( id, persister ); @@ -137,16 +143,16 @@ public CompletionStage<Void> reactiveOnRefresh(RefreshEvent event, IdentitySet r } // cascade the refresh prior to refreshing this entity - refreshedAlready.add( object ); + refreshedAlready.add( entity ); - return cascadeRefresh( source, persister, object, refreshedAlready ) + return cascadeRefresh(source, persister, entity, refreshedAlready) .thenCompose(v -> { if ( e != null ) { final EntityKey key = source.generateEntityKey( id, persister ); persistenceContext.removeEntity( key ); if ( persister.hasCollections() ) { - new EvictVisitor( source, object ).process( object, persister ); + new EvictVisitor(source, entity ).process( entity, persister ); } } @@ -156,7 +162,7 @@ public CompletionStage<Void> reactiveOnRefresh(RefreshEvent event, IdentitySet r // we need to grab the version value from the entity, otherwise // we have issues with generated-version entities that may have // multiple actions queued during the same flush - previousVersion = persister.getVersion( object ); + previousVersion = persister.getVersion( entity ); } final EntityDataAccess cache = persister.getCacheAccessStrategy(); final Object ck = cache.generateCacheKey( @@ -165,12 +171,12 @@ public CompletionStage<Void> reactiveOnRefresh(RefreshEvent event, IdentitySet r source.getFactory(), source.getTenantIdentifier() ); - final SoftLock lock = cache.lockItem( source, ck, previousVersion ); - cache.remove( source, ck ); + final SoftLock lock = cache.lockItem(source, ck, previousVersion ); + cache.remove(source, ck ); source.getActionQueue().registerProcess( (success, session) -> cache.unlockItem( session, ck, lock ) ); } - evictCachedCollections( persister, id, source ); + evictCachedCollections( persister, id, source); String previousFetchProfile = source.getLoadQueryInfluencers().getInternalFetchProfile(); source.getLoadQueryInfluencers().setInternalFetchProfile( "refresh" ); @@ -217,7 +223,7 @@ public CompletionStage<Void> reactiveOnRefresh(RefreshEvent event, IdentitySet r postRefreshLockMode = null; } - return ( (ReactiveAbstractEntityPersister) persister ).reactiveLoad( id, object, lockOptionsToUse, source ) + return ( (ReactiveAbstractEntityPersister) persister ).reactiveLoad( id, entity, lockOptionsToUse, source) .thenAccept(result -> { if ( result!=null ) { diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/session/impl/ReactiveSessionImpl.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/session/impl/ReactiveSessionImpl.java index 83376a12..33525e5e 100644 --- a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/session/impl/ReactiveSessionImpl.java +++ b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/session/impl/ReactiveSessionImpl.java @@ -100,6 +100,8 @@ import java.util.function.Function; import java.util.function.Supplier; +import static org.hibernate.reactive.util.impl.CompletionStages.completedFuture; + /** * An {@link ReactiveSession} implemented by extension of * the {@link SessionImpl} in Hibernate core. Extension was @@ -148,33 +150,43 @@ public Object immediateLoad(String entityName, Serializable id) throws Hibernate + " - use Session.fetch() (entity '" + entityName + "' with id '" + id + "' was not loaded)"); } - @Override + @Override @SuppressWarnings("unchecked") public <T> CompletionStage<T> reactiveFetch(T association, boolean unproxy) { checkOpen(); if ( association instanceof HibernateProxy ) { LazyInitializer initializer = ((HibernateProxy) association).getHibernateLazyInitializer(); - //TODO: is this correct? - // SessionImpl doesn't use IdentifierLoadAccessImpl for initializing proxies - String entityName = initializer.getEntityName(); - Serializable identifier = initializer.getIdentifier(); - return new ReactiveIdentifierLoadAccessImpl<T>( entityName ) - .fetch( identifier ) - .thenApply( SessionUtil.checkEntityFound( this, entityName, identifier ) ) - .thenApply( entity -> { - initializer.setSession( this ); - initializer.setImplementation( entity ); - return unproxy ? entity : association; - } ); + if ( !initializer.isUninitialized() ) { + return completedFuture( unproxy ? (T) initializer.getImplementation() : association ); + } + else { + //TODO: is this correct? + // SessionImpl doesn't use IdentifierLoadAccessImpl for initializing proxies + String entityName = initializer.getEntityName(); + Serializable identifier = initializer.getIdentifier(); + return new ReactiveIdentifierLoadAccessImpl<T>( entityName ) + .fetch( identifier ) + .thenApply( SessionUtil.checkEntityFound( this, entityName, identifier ) ) + .thenApply( entity -> { + initializer.setSession( this ); + initializer.setImplementation( entity ); + return unproxy ? entity : association; + } ); + } } else if ( association instanceof PersistentCollection ) { PersistentCollection persistentCollection = (PersistentCollection) association; - return reactiveInitializeCollection( persistentCollection, false ) - // don't reassociate the collection instance, because - // its owner isn't associated with this session - .thenApply( pc -> association ); + if ( persistentCollection.wasInitialized() ) { + return completedFuture( association ); + } + else { + return reactiveInitializeCollection( persistentCollection, false ) + // don't reassociate the collection instance, because + // its owner isn't associated with this session + .thenApply( pc -> association ); + } } else { - return CompletionStages.completedFuture( association ); + return completedFuture( association ); } } diff --git a/hibernate-reactive-core/src/test/java/org/hibernate/reactive/ReferenceTest.java b/hibernate-reactive-core/src/test/java/org/hibernate/reactive/ReferenceTest.java index 63c4e84e..d54fa94f 100644 --- a/hibernate-reactive-core/src/test/java/org/hibernate/reactive/ReferenceTest.java +++ b/hibernate-reactive-core/src/test/java/org/hibernate/reactive/ReferenceTest.java @@ -7,6 +7,7 @@ import io.vertx.ext.unit.TestContext; import org.hibernate.Hibernate; +import org.hibernate.LockMode; import org.hibernate.cfg.Configuration; import org.hibernate.reactive.stage.Stage; import org.junit.Test; @@ -108,12 +109,90 @@ public void testDetachedProxyReference(TestContext context) { ); } + @Test + public void testRemoveDetachedProxy(TestContext context) { + final Book goodOmens = new Book("Good Omens: The Nice and Accurate Prophecies of Agnes Nutter, Witch"); + + test( + context, + completedFuture( openSession() ) + .thenCompose( s -> s.persist(goodOmens).thenCompose( v -> s.flush() ) ) + .thenApply( v -> openSession() ) + .thenCompose( sess -> { + Book reference = sess.getReference(goodOmens); + context.assertFalse( Hibernate.isInitialized(reference) ); + sess.close(); + return completedFuture( openSession() ) + .thenCompose( s -> s.remove( s.getReference(reference) ) + .thenCompose( v -> s.flush() ) ); + } ) + .thenApply( v -> openSession() ) + .thenCompose( sess -> sess.find( Book.class, goodOmens.getId() ) ) + .thenAccept( book -> context.assertNull(book) ) + ); + } + + @Test + public void testLockDetachedProxy(TestContext context) { + final Book goodOmens = new Book("Good Omens: The Nice and Accurate Prophecies of Agnes Nutter, Witch"); + + test( + context, + completedFuture( openSession() ) + .thenCompose( s -> s.persist(goodOmens).thenCompose( v -> s.flush() ) ) + .thenApply( v -> openSession() ) + .thenCompose( sess -> { + Book reference = sess.getReference(goodOmens); + context.assertFalse( Hibernate.isInitialized(reference) ); + sess.close(); + return completedFuture( openSession() ) + .thenCompose( s -> s.lock( s.getReference(reference), LockMode.PESSIMISTIC_FORCE_INCREMENT ) + .thenCompose( v -> s.flush() ) ); + } ) + .thenApply( v -> openSession() ) + .thenCompose( sess -> sess.find( Book.class, goodOmens.getId() ) ) + .thenAccept( book -> { + context.assertNotNull(book); + context.assertEquals( 2, book.version ); + } ) + ); + } + + @Test + public void testRefreshDetachedProxy(TestContext context) { + final Book goodOmens = new Book("Good Omens: The Nice and Accurate Prophecies of Agnes Nutter, Witch"); + + test( + context, + completedFuture( openSession() ) + .thenCompose( s -> s.persist(goodOmens).thenCompose( v -> s.flush() ) ) + .thenApply( v -> openSession() ) + .thenCompose( sess -> { + Book reference = sess.getReference(goodOmens); + context.assertFalse( Hibernate.isInitialized(reference) ); + sess.close(); + return completedFuture( openSession() ) + .thenCompose( s -> s.refresh( s.getReference(reference) ) + .thenAccept( v -> context.assertTrue( Hibernate.isInitialized( s.getReference(reference) ) ) ) + .thenCompose( v -> s.flush() ) ); + } ) + .thenApply( v -> openSession() ) + .thenCompose( sess -> sess.find( Book.class, goodOmens.getId() ) ) + .thenAccept( book -> { + context.assertNotNull(book); + context.assertEquals( 1, book.version ); + } ) + ); + } + @Entity(name = "Tome") @Table(name = "Book") public static class Book { @Id @GeneratedValue private Integer id; + @Version + private Integer version = 1; private String title; @OneToMany(fetch = FetchType.LAZY, mappedBy="book")

['hibernate-reactive-core/src/test/java/org/hibernate/reactive/ReferenceTest.java', 'hibernate-reactive-core/src/main/java/org/hibernate/reactive/event/impl/DefaultReactiveLockEventListener.java', 'hibernate-reactive-core/src/main/java/org/hibernate/reactive/session/impl/ReactiveSessionImpl.java', 'hibernate-reactive-core/src/main/java/org/hibernate/reactive/event/impl/DefaultReactiveDeleteEventListener.java', 'hibernate-reactive-core/src/main/java/org/hibernate/reactive/event/impl/DefaultReactiveRefreshEventListener.java']

{'.java': 5}

Java

{'Java': 3376271, 'Shell': 1406}

Apache License 2.0

spongepowered/sponge/3765/3727

spongepowered

sponge

https://github.com/SpongePowered/Sponge/issues/3727

https://github.com/SpongePowered/Sponge/pull/3765

https://github.com/SpongePowered/Sponge/pull/3765

fixes

Cancelling a `InteractBlockEvent.Secondary` doesn't refresh count in inventory

### Affected Product(s) SpongeForge, SpongeVanilla ### Version 1.16.5-36.2.5-8.1.0-RC1164 ### Operating System Windows ### Java Version OpenJDK Runtime Environment (AdoptOpenJDK)(build 1.8.0_282-b08) ### Plugins/Mods ```shell None other than this plugin ``` ### Describe the bug ``` @Listener public void test(InteractBlockEvent.Secondary event, @First ServerPlayer p) { event.setCancelled(true); } ``` When a user tries to place some a block such as dirt with this listener active, the dirt will be prevented from placing, but the quantity of the item stack will drop by 1 as-if the place went through. The count can be updated by moving the stack from one slot or another, or simply collecting another block of dirt. ### Link to logs _No response_

6e443ec04ded4385d12c2e609360e81a770fbfcb

d40af3cf30ee0b36a3b598cd9b785876da16f21d

https://github.com/spongepowered/sponge/compare/6e443ec04ded4385d12c2e609360e81a770fbfcb...d40af3cf30ee0b36a3b598cd9b785876da16f21d

diff --git a/src/mixins/java/org/spongepowered/common/mixin/tracker/server/level/ServerPlayerGameModeMixin_Tracker.java b/src/mixins/java/org/spongepowered/common/mixin/tracker/server/level/ServerPlayerGameModeMixin_Tracker.java index fe8b20b4f..b94a1d308 100644 --- a/src/mixins/java/org/spongepowered/common/mixin/tracker/server/level/ServerPlayerGameModeMixin_Tracker.java +++ b/src/mixins/java/org/spongepowered/common/mixin/tracker/server/level/ServerPlayerGameModeMixin_Tracker.java @@ -53,6 +53,7 @@ import org.spongepowered.asm.mixin.injection.At; import org.spongepowered.asm.mixin.injection.Inject; import org.spongepowered.asm.mixin.injection.callback.CallbackInfoReturnable; +import org.spongepowered.common.bridge.server.level.ServerPlayerGameModeBridge; import org.spongepowered.common.bridge.world.inventory.container.ContainerBridge; import org.spongepowered.common.event.SpongeCommonEventFactory; import org.spongepowered.common.event.inventory.InventoryEventFactory; @@ -100,11 +101,12 @@ public InteractionResult useItemOn(final ServerPlayer playerIn, final Level worl final Vector3d hitVec = Vector3d.from(blockRaytraceResultIn.getBlockPos().getX(), blockRaytraceResultIn.getBlockPos().getY(), blockRaytraceResultIn.getBlockPos().getZ()); final org.spongepowered.api.util.Direction direction = DirectionFacingProvider.INSTANCE.getKey(blockRaytraceResultIn.getDirection()).get(); final InteractBlockEvent.Secondary event = SpongeCommonEventFactory.callInteractBlockEventSecondary(playerIn, stackIn, hitVec, snapshot, direction, handIn); + final Tristate useItem = event.useItemResult(); + final Tristate useBlock = event.useBlockResult(); + ((ServerPlayerGameModeBridge) this).bridge$setInteractBlockRightClickCancelled(event.isCancelled()); if (event.isCancelled()) { return InteractionResult.FAIL; } - final Tristate useItem = event.useItemResult(); - final Tristate useBlock = event.useBlockResult(); // Sponge end if (this.gameModeForPlayer == GameType.SPECTATOR) { final MenuProvider inamedcontainerprovider = blockstate.getMenuProvider(worldIn, blockpos); @@ -152,6 +154,7 @@ public InteractionResult useItemOn(final ServerPlayer playerIn, final Level worl if (!stackIn.isEmpty() && !playerIn.getCooldowns().isOnCooldown(stackIn.getItem())) { // Sponge start if (useItem == Tristate.FALSE) { + ((ServerPlayerGameModeBridge) this).bridge$setInteractBlockRightClickCancelled(true); return InteractionResult.PASS; } // Sponge end @@ -177,6 +180,12 @@ public InteractionResult useItemOn(final ServerPlayer playerIn, final Level worl return result; } else { + // Sponge start + if(useBlock == Tristate.FALSE && !flag1) { + ((ServerPlayerGameModeBridge) this).bridge$setInteractBlockRightClickCancelled(true); + } + // Sponge end + return InteractionResult.PASS; } } diff --git a/src/mixins/java/org/spongepowered/common/mixin/tracker/server/network/ServerGamePacketListenerImplMixin_Tracker.java b/src/mixins/java/org/spongepowered/common/mixin/tracker/server/network/ServerGamePacketListenerImplMixin_Tracker.java index 25bc612a1..c2863fb86 100644 --- a/src/mixins/java/org/spongepowered/common/mixin/tracker/server/network/ServerGamePacketListenerImplMixin_Tracker.java +++ b/src/mixins/java/org/spongepowered/common/mixin/tracker/server/network/ServerGamePacketListenerImplMixin_Tracker.java @@ -39,11 +39,9 @@ import org.spongepowered.asm.mixin.injection.Inject; import org.spongepowered.asm.mixin.injection.Redirect; import org.spongepowered.asm.mixin.injection.callback.CallbackInfo; -import org.spongepowered.common.SpongeCommon; import org.spongepowered.common.bridge.world.entity.PlatformEntityBridge; import org.spongepowered.common.bridge.server.level.ServerPlayerGameModeBridge; import org.spongepowered.common.bridge.world.level.LevelBridge; -import org.spongepowered.common.event.SpongeCommonEventFactory; import org.spongepowered.common.event.tracking.PhaseTracker; import org.spongepowered.common.event.tracking.phase.packet.PacketContext; import org.spongepowered.common.event.tracking.phase.packet.PacketPhaseUtil; @@ -80,21 +78,17 @@ public abstract class ServerGamePacketListenerImplMixin_Tracker { if (PhaseTracker.getInstance().getPhaseContext().isEmpty()) { return actionResult; } - final PacketContext<?> context = ((PacketContext<?>) PhaseTracker.getInstance().getPhaseContext()); - // If a plugin or mod has changed the item, avoid restoring - if (!context.getInteractItemChanged()) { - final ItemStack itemStack = ItemStackUtil.toNative(context.getItemUsed()); + final PacketContext<?> context = ((PacketContext<?>) PhaseTracker.getInstance().getPhaseContext()); + final ItemStack itemStack = ItemStackUtil.toNative(context.getItemUsed()); - // Only do a restore if something actually changed. The client does an identity check ('==') - // to determine if it should continue using an itemstack. If we always resend the itemstack, we end up - // cancelling item usage (e.g. eating food) that occurs while targeting a block - final boolean isInteractionCancelled = ((ServerPlayerGameModeBridge) this.player.gameMode).bridge$isInteractBlockRightClickCancelled(); - if (!ItemStack.matches(itemStack, this.player.getItemInHand(hand)) && isInteractionCancelled) { - PacketPhaseUtil.handlePlayerSlotRestore(this.player, itemStack, hand); - } + // Only do a restore if the items should stay the same. The client does an identity check ('==') + // to determine if it should continue using an itemstack. + final boolean isInteractionCancelled = ((ServerPlayerGameModeBridge) this.player.gameMode).bridge$isInteractBlockRightClickCancelled(); + if (ItemStack.matches(itemStack, this.player.getItemInHand(hand)) && isInteractionCancelled) { + PacketPhaseUtil.handlePlayerSlotRestore(this.player, itemStack, hand); } - context.interactItemChanged(false); + ((ServerPlayerGameModeBridge) this.player.gameMode).bridge$setInteractBlockRightClickCancelled(false); return actionResult; }

['src/mixins/java/org/spongepowered/common/mixin/tracker/server/level/ServerPlayerGameModeMixin_Tracker.java', 'src/mixins/java/org/spongepowered/common/mixin/tracker/server/network/ServerGamePacketListenerImplMixin_Tracker.java']

{'.java': 2}

Java

{'Java': 12523507, 'Kotlin': 74371, 'Shell': 70}

MIT License

spongepowered/sponge/2462/3035

spongepowered

sponge

https://github.com/SpongePowered/Sponge/issues/3035

https://github.com/SpongePowered/Sponge/pull/2462

https://github.com/SpongePowered/Sponge/pull/2462

fixes

ChangeBlockEvent cause does not contain who activated TNT

**I am currently running** - SpongeVanilla version: spongevanilla-1.12.2-7.2.3-RC373 **Issue Description** This is my test code: https://gist.github.com/XakepSDK/a0f874facd1349e27a2484968a1897a9 This is results i obtain doing different things with TNT in-game: I placed 1 TNT, 1 redstone dust and 1 pressure plate, then stand on the plate to activate TNT. I got this output: https://gist.github.com/XakepSDK/96beb111deac789d4f7861fa2e18c0cc I activated TNT using flint and steel https://gist.github.com/XakepSDK/0f769a93a4bafd05f59f33303b29d85a Is it intended that when TNT explodes, cause does not contain player who activated that TNT? I thought it would contain TNT explosion as root cause and a Player who activated it.

78b0883e022aae3c3f22c1c6da36f83d26f39f81

85f1a678271c803448517d4b31a1348e72df0d76

https://github.com/spongepowered/sponge/compare/78b0883e022aae3c3f22c1c6da36f83d26f39f81...85f1a678271c803448517d4b31a1348e72df0d76

diff --git a/src/main/java/org/spongepowered/common/mixin/core/world/chunk/ChunkMixin.java b/src/main/java/org/spongepowered/common/mixin/core/world/chunk/ChunkMixin.java index 140ad1f37..62099c0b3 100644 --- a/src/main/java/org/spongepowered/common/mixin/core/world/chunk/ChunkMixin.java +++ b/src/main/java/org/spongepowered/common/mixin/core/world/chunk/ChunkMixin.java @@ -545,8 +545,10 @@ public IBlockState setBlockState(final BlockPos pos, final IBlockState state) { // Sponge End TileEntity tileentity = this.getTileEntity(pos, net.minecraft.world.chunk.Chunk.EnumCreateEntityType.CHECK); - if (tileentity == null) { - // Sponge Start - use SpongeImplHooks for forge compatibility + // Sponge Start - Additional check for the tile entity being queued for removal. + // if (tileentity == null) { // Sponge + if (tileentity == null || (transaction != null && transaction.queuedRemoval != null)) { + // Use SpongeImplHooks for forge compatibility // tileentity = ((ITileEntityProvider)block).createNewTileEntity(this.worldObj, block.getMetaFromState(state)); // Sponge tileentity = SpongeImplHooks.createTileEntity(newBlock, this.world, newState);

['src/main/java/org/spongepowered/common/mixin/core/world/chunk/ChunkMixin.java']

{'.java': 1}

Java

{'Java': 12523507, 'Kotlin': 74371, 'Shell': 70}

MIT License

spongepowered/sponge/3764/3691

spongepowered

sponge

https://github.com/SpongePowered/Sponge/issues/3691

https://github.com/SpongePowered/Sponge/pull/3764

https://github.com/SpongePowered/Sponge/pull/3764

fixes

setBiome uses incorrect math

### Affected Product(s) SpongeForge, SpongeVanilla ### Version spongevanilla-1.16.5-8.1.0-RC1134 ### Operating System Linux ### Java Version 17.0.3 ### Plugins/Mods ```shell WorldEdit ``` ### Describe the bug setBiome uses incorrect math, specifically in `VolumeStreamUtils#setBiomeOnNativeChunk` it takes block positions but does not shift them `>> 2` to convert them to "quad" positions, as e.g. `BiomeManager#getNoiseBiomeAtPosition` does. ### Link to logs _No response_

6e443ec04ded4385d12c2e609360e81a770fbfcb

a944e33aa9d02d242e3b9a5867e9416dbc8b4696

https://github.com/spongepowered/sponge/compare/6e443ec04ded4385d12c2e609360e81a770fbfcb...a944e33aa9d02d242e3b9a5867e9416dbc8b4696

diff --git a/src/main/java/org/spongepowered/common/world/volume/VolumeStreamUtils.java b/src/main/java/org/spongepowered/common/world/volume/VolumeStreamUtils.java index abf748d92..1f49ee52e 100644 --- a/src/main/java/org/spongepowered/common/world/volume/VolumeStreamUtils.java +++ b/src/main/java/org/spongepowered/common/world/volume/VolumeStreamUtils.java @@ -160,17 +160,17 @@ public static Function<ChunkAccess, Stream<Map.Entry<BlockPos, BlockState>>> get return VolumeStreamUtils.getElementByPosition(VolumeStreamUtils.chunkSectionBlockStateGetter(), min, max); } - public static boolean setBiomeOnNativeChunk(final int x, final int y, final int z, final - org.spongepowered.api.world.biome.Biome biome, final Supplier<@Nullable ChunkBiomeContainerAccessor> accessor, + public static boolean setBiomeOnNativeChunk(final int x, final int y, final int z, + final org.spongepowered.api.world.biome.Biome biome, final Supplier<@Nullable ChunkBiomeContainerAccessor> accessor, final Runnable finalizer - ) { + ) { @Nullable final ChunkBiomeContainerAccessor chunkBiomeContainerAccessor = accessor.get(); if (chunkBiomeContainerAccessor == null) { return false; } - final int maskedX = x & ChunkBiomeContainer.HORIZONTAL_MASK; - final int maskedY = Mth.clamp(y, 0, ChunkBiomeContainer.VERTICAL_MASK); - final int maskedZ = z & ChunkBiomeContainer.HORIZONTAL_MASK; + final int maskedX = (x >> 2) & ChunkBiomeContainer.HORIZONTAL_MASK; + final int maskedY = Mth.clamp((y >> 2), 0, ChunkBiomeContainer.VERTICAL_MASK); + final int maskedZ = (z >> 2) & ChunkBiomeContainer.HORIZONTAL_MASK; final int WIDTH_BITS = ChunkBiomeContainerAccessor.accessor$WIDTH_BITS(); final int posKey = maskedY << WIDTH_BITS + WIDTH_BITS | maskedZ << WIDTH_BITS | maskedX; final Biome[] biomes = chunkBiomeContainerAccessor.accessor$biomes(); diff --git a/src/mixins/java/org/spongepowered/common/mixin/api/minecraft/world/level/LevelMixin_API.java b/src/mixins/java/org/spongepowered/common/mixin/api/minecraft/world/level/LevelMixin_API.java index 4a834f244..e7d0f19b6 100644 --- a/src/mixins/java/org/spongepowered/common/mixin/api/minecraft/world/level/LevelMixin_API.java +++ b/src/mixins/java/org/spongepowered/common/mixin/api/minecraft/world/level/LevelMixin_API.java @@ -453,7 +453,7 @@ public VolumeStream<W, Entity> entityStream(final Vector3i min, final Vector3i m @SuppressWarnings("rawtypes") @Override public boolean setBiome(final int x, final int y, final int z, final Biome biome) { - if (!((Level) (Object) this).hasChunk(x << 4, z << 4)) { + if (!((Level) (Object) this).hasChunk(x >> 4, z >> 4)) { return false; } final LevelChunk levelChunk = this.shadow$getChunkAt(new BlockPos(x, y, z));

['src/mixins/java/org/spongepowered/common/mixin/api/minecraft/world/level/LevelMixin_API.java', 'src/main/java/org/spongepowered/common/world/volume/VolumeStreamUtils.java']

{'.java': 2}

Java

{'Java': 12523507, 'Kotlin': 74371, 'Shell': 70}

MIT License

spongepowered/sponge/3634/3631

spongepowered

sponge

https://github.com/SpongePowered/Sponge/issues/3631

https://github.com/SpongePowered/Sponge/pull/3634

https://github.com/SpongePowered/Sponge/pull/3634

fixes

Mekanism Crash On Launch

### Affected Product(s) SpongeForge ### Version spongeforge-1.16.5-36.2.5-8.0.0-RC1073-universal.jar ### Operating System Windows ### Java Version Adopt OpenJDK Hotspot 1.8.0_322 ### Plugins/Mods ```shell SpongeForge Mekanism-1.16.5-10.1.1.456.jar (Latest) ``` ### Describe the bug When both Mekanism and SpongeForge are installed, Minecraft crashes on launch [latest.log](https://github.com/mekanism/Mekanism/files/8066821/latest.log) [debug.log](https://github.com/mekanism/Mekanism/files/8066822/debug.log) [crash-2022-02-15_18.35.43-fml.txt](https://github.com/mekanism/Mekanism/files/8066824/crash-2022-02-15_18.35.43-fml.txt) ### Link to logs _No response_

0ea18fb9665e3a89df7a1bb50bbea40bb56afdbf

5f7b4c58adf9103e17ae9b70a1774adeee9988b0

https://github.com/spongepowered/sponge/compare/0ea18fb9665e3a89df7a1bb50bbea40bb56afdbf...5f7b4c58adf9103e17ae9b70a1774adeee9988b0

diff --git a/forge/src/mixins/java/org/spongepowered/forge/mixin/core/world/entity/item/ItemEntityMixin_Forge.java b/forge/src/mixins/java/org/spongepowered/forge/mixin/core/world/entity/item/ItemEntityMixin_Forge.java index fb2b502d4..1ad9b4ed9 100644 --- a/forge/src/mixins/java/org/spongepowered/forge/mixin/core/world/entity/item/ItemEntityMixin_Forge.java +++ b/forge/src/mixins/java/org/spongepowered/forge/mixin/core/world/entity/item/ItemEntityMixin_Forge.java @@ -42,8 +42,11 @@ public abstract class ItemEntityMixin_Forge { // @formatter:on @Inject(method = "<init>(Lnet/minecraft/world/entity/EntityType;Lnet/minecraft/world/level/Level;)V", at = @At("RETURN")) - private void forge$setLifespanFromConfig(EntityType<? extends ItemEntity> type, Level level, CallbackInfo ci) { - if (!level.isClientSide) { + private void forge$setLifespanFromConfig(final EntityType<? extends ItemEntity> type, final Level level, + final CallbackInfo ci + ) { + // Check the level is not null to avoid an NPE + if (level != null && !level.isClientSide) { this.lifespan = SpongeGameConfigs.getForWorld(level).get().entity.item.despawnRate; } }

['forge/src/mixins/java/org/spongepowered/forge/mixin/core/world/entity/item/ItemEntityMixin_Forge.java']

{'.java': 1}

Java

{'Java': 12523507, 'Kotlin': 74371, 'Shell': 70}

MIT License

ls1intum/artemis/7058/7056

ls1intum

artemis

https://github.com/ls1intum/Artemis/issues/7056

https://github.com/ls1intum/Artemis/pull/7058

https://github.com/ls1intum/Artemis/pull/7058

closes

`Programming exercises`: Missing build plan when importing programming exercises

### Describe the bug After importing a programming exercise, the build plan is missing. No inputs can be made, and the wheel in the top bar keeps on spinning. The re-create build plan option also doesn't work. ### To Reproduce 1. Import a programming exercise from instance (meaning from another course, for example) 2. Click on 'Edit Build Plan' 3. The editor is empty and no inputs can be made ### Expected behavior I expect the import to also include the build plan. ### Screenshots  ### Which version of Artemis are you seeing the problem on? 6.3.8 ### What browsers are you seeing the problem on? Chrome ### Additional context _No response_ ### Relevant log output _No response_

e0bd92657cffcb1a92bcbfe52cf5a02522bbb1f4

f57220274d7b74f7ff3cc9bec52c3af82a449cda

https://github.com/ls1intum/artemis/compare/e0bd92657cffcb1a92bcbfe52cf5a02522bbb1f4...f57220274d7b74f7ff3cc9bec52c3af82a449cda

diff --git a/src/main/java/de/tum/in/www1/artemis/repository/BuildPlanRepository.java b/src/main/java/de/tum/in/www1/artemis/repository/BuildPlanRepository.java index 9d6113fb08..ad98dcf17f 100644 --- a/src/main/java/de/tum/in/www1/artemis/repository/BuildPlanRepository.java +++ b/src/main/java/de/tum/in/www1/artemis/repository/BuildPlanRepository.java @@ -44,4 +44,9 @@ public interface BuildPlanRepository extends JpaRepository<BuildPlan, Long> { buildPlanWrapper.addProgrammingExercise(exercise); return save(buildPlanWrapper); } + + default void copyBetweenExercises(ProgrammingExercise sourceExercise, ProgrammingExercise targetExercise) { + BuildPlan buildPlan = findByProgrammingExercises_IdWithProgrammingExercisesElseThrow(sourceExercise.getId()); + setBuildPlanForExercise(buildPlan.getBuildPlan(), targetExercise); + } } diff --git a/src/main/java/de/tum/in/www1/artemis/service/ParticipationService.java b/src/main/java/de/tum/in/www1/artemis/service/ParticipationService.java index 90cb01efe3..4e60f3f109 100644 --- a/src/main/java/de/tum/in/www1/artemis/service/ParticipationService.java +++ b/src/main/java/de/tum/in/www1/artemis/service/ParticipationService.java @@ -449,14 +449,14 @@ public class ParticipationService { private ProgrammingExerciseStudentParticipation copyBuildPlan(ProgrammingExerciseStudentParticipation participation) { // only execute this step if it has not yet been completed yet or if the build plan id is missing for some reason if (!participation.getInitializationState().hasCompletedState(InitializationState.BUILD_PLAN_COPIED) || participation.getBuildPlanId() == null) { - final var projectKey = participation.getProgrammingExercise().getProjectKey(); + final var exercise = participation.getProgrammingExercise(); final var planName = BuildPlanType.TEMPLATE.getName(); final var username = participation.getParticipantIdentifier(); final var buildProjectName = participation.getExercise().getCourseViaExerciseGroupOrCourseMember().getShortName().toUpperCase() + " " + participation.getExercise().getTitle(); final var targetPlanName = participation.addPracticePrefixIfTestRun(username.toUpperCase()); // the next action includes recovery, which means if the build plan has already been copied, we simply retrieve the build plan id and do not copy it again - final var buildPlanId = continuousIntegrationService.orElseThrow().copyBuildPlan(projectKey, planName, projectKey, buildProjectName, targetPlanName, true); + final var buildPlanId = continuousIntegrationService.orElseThrow().copyBuildPlan(exercise, planName, exercise, buildProjectName, targetPlanName, true); participation.setBuildPlanId(buildPlanId); participation.setInitializationState(InitializationState.BUILD_PLAN_COPIED); return programmingExerciseStudentParticipationRepository.saveAndFlush(participation); diff --git a/src/main/java/de/tum/in/www1/artemis/service/connectors/bamboo/BambooService.java b/src/main/java/de/tum/in/www1/artemis/service/connectors/bamboo/BambooService.java index f5c5628d28..24386d0334 100644 --- a/src/main/java/de/tum/in/www1/artemis/service/connectors/bamboo/BambooService.java +++ b/src/main/java/de/tum/in/www1/artemis/service/connectors/bamboo/BambooService.java @@ -352,8 +352,11 @@ public class BambooService extends AbstractContinuousIntegrationService { } @Override - public String copyBuildPlan(String sourceProjectKey, String sourcePlanName, String targetProjectKey, String targetProjectName, String targetPlanName, + public String copyBuildPlan(ProgrammingExercise sourceExercise, String sourcePlanName, ProgrammingExercise targetExercise, String targetProjectName, String targetPlanName, boolean targetProjectExists) { + String sourceProjectKey = sourceExercise.getProjectKey(); + String targetProjectKey = targetExercise.getProjectKey(); + final var cleanPlanName = getCleanPlanName(targetPlanName); final var sourcePlanKey = sourceProjectKey + "-" + sourcePlanName; final var targetPlanKey = targetProjectKey + "-" + cleanPlanName; diff --git a/src/main/java/de/tum/in/www1/artemis/service/connectors/ci/ContinuousIntegrationService.java b/src/main/java/de/tum/in/www1/artemis/service/connectors/ci/ContinuousIntegrationService.java index d87948fb51..21d0b82ed6 100644 --- a/src/main/java/de/tum/in/www1/artemis/service/connectors/ci/ContinuousIntegrationService.java +++ b/src/main/java/de/tum/in/www1/artemis/service/connectors/ci/ContinuousIntegrationService.java @@ -53,15 +53,16 @@ public interface ContinuousIntegrationService { /** * Clones an existing build plan. Illegal characters in the plan key, or name will be replaced. * - * @param sourceProjectKey The key of the source project, normally the key of the exercise -> courseShortName + exerciseShortName. + * @param sourceExercise The exercise from which the build plan should be copied * @param sourcePlanName The name of the source plan - * @param targetProjectKey The key of the project the plan should get copied to + * @param targetExercise The exercise to which the build plan is copied to * @param targetProjectName The wanted name of the new project * @param targetPlanName The wanted name of the new plan after copying it * @param targetProjectExists whether the target project already exists or not * @return The key of the new build plan */ - String copyBuildPlan(String sourceProjectKey, String sourcePlanName, String targetProjectKey, String targetProjectName, String targetPlanName, boolean targetProjectExists); + String copyBuildPlan(ProgrammingExercise sourceExercise, String sourcePlanName, ProgrammingExercise targetExercise, String targetProjectName, String targetPlanName, + boolean targetProjectExists); /** * Configure the build plan with the given participation on the CI system. Common configurations: - update the repository in the build plan - set appropriate user permissions - diff --git a/src/main/java/de/tum/in/www1/artemis/service/connectors/gitlabci/GitLabCIService.java b/src/main/java/de/tum/in/www1/artemis/service/connectors/gitlabci/GitLabCIService.java index 13170b8628..536f49092b 100644 --- a/src/main/java/de/tum/in/www1/artemis/service/connectors/gitlabci/GitLabCIService.java +++ b/src/main/java/de/tum/in/www1/artemis/service/connectors/gitlabci/GitLabCIService.java @@ -193,14 +193,14 @@ public class GitLabCIService extends AbstractContinuousIntegrationService { } @Override - public String copyBuildPlan(String sourceProjectKey, String sourcePlanName, String targetProjectKey, String targetProjectName, String targetPlanName, + public String copyBuildPlan(ProgrammingExercise sourceExercise, String sourcePlanName, ProgrammingExercise targetExercise, String targetProjectName, String targetPlanName, boolean targetProjectExists) { // In GitLab CI we don't have to copy the build plan. // Instead, we configure a CI config path leading to the API when enabling the CI. // When sending the build results back, the build plan key is used to identify the participation. // Therefore, we return the key here even though GitLab CI does not need it. - return targetProjectKey + "-" + targetPlanName.toUpperCase().replaceAll("[^A-Z0-9]", ""); + return targetExercise.getProjectKey() + "-" + targetPlanName.toUpperCase().replaceAll("[^A-Z0-9]", ""); } @Override diff --git a/src/main/java/de/tum/in/www1/artemis/service/connectors/jenkins/JenkinsService.java b/src/main/java/de/tum/in/www1/artemis/service/connectors/jenkins/JenkinsService.java index 7a23093332..243e19c584 100644 --- a/src/main/java/de/tum/in/www1/artemis/service/connectors/jenkins/JenkinsService.java +++ b/src/main/java/de/tum/in/www1/artemis/service/connectors/jenkins/JenkinsService.java @@ -98,9 +98,9 @@ public class JenkinsService extends AbstractContinuousIntegrationService { } @Override - public String copyBuildPlan(String sourceProjectKey, String sourcePlanName, String targetProjectKey, String targetProjectName, String targetPlanName, + public String copyBuildPlan(ProgrammingExercise sourceExercise, String sourcePlanName, ProgrammingExercise targetExercise, String targetProjectName, String targetPlanName, boolean targetProjectExists) { - return jenkinsBuildPlanService.copyBuildPlan(sourceProjectKey, sourcePlanName, targetProjectKey, targetPlanName); + return jenkinsBuildPlanService.copyBuildPlan(sourceExercise, sourcePlanName, targetExercise, targetPlanName); } @Override diff --git a/src/main/java/de/tum/in/www1/artemis/service/connectors/jenkins/build_plan/JenkinsBuildPlanService.java b/src/main/java/de/tum/in/www1/artemis/service/connectors/jenkins/build_plan/JenkinsBuildPlanService.java index 0a94f3a2ab..f756160991 100644 --- a/src/main/java/de/tum/in/www1/artemis/service/connectors/jenkins/build_plan/JenkinsBuildPlanService.java +++ b/src/main/java/de/tum/in/www1/artemis/service/connectors/jenkins/build_plan/JenkinsBuildPlanService.java @@ -37,6 +37,7 @@ import de.tum.in.www1.artemis.domain.enumeration.ProjectType; import de.tum.in.www1.artemis.domain.enumeration.RepositoryType; import de.tum.in.www1.artemis.domain.participation.ProgrammingExerciseParticipation; import de.tum.in.www1.artemis.exception.JenkinsException; +import de.tum.in.www1.artemis.repository.BuildPlanRepository; import de.tum.in.www1.artemis.repository.ProgrammingExerciseRepository; import de.tum.in.www1.artemis.repository.UserRepository; import de.tum.in.www1.artemis.service.connectors.ci.ContinuousIntegrationService; @@ -78,9 +79,12 @@ public class JenkinsBuildPlanService { private final ProgrammingExerciseRepository programmingExerciseRepository; + private final BuildPlanRepository buildPlanRepository; + public JenkinsBuildPlanService(@Qualifier("jenkinsRestTemplate") RestTemplate restTemplate, JenkinsServer jenkinsServer, JenkinsBuildPlanCreator jenkinsBuildPlanCreator, JenkinsJobService jenkinsJobService, JenkinsJobPermissionsService jenkinsJobPermissionsService, JenkinsInternalUrlService jenkinsInternalUrlService, - UserRepository userRepository, ProgrammingExerciseRepository programmingExerciseRepository, JenkinsPipelineScriptCreator jenkinsPipelineScriptCreator) { + UserRepository userRepository, ProgrammingExerciseRepository programmingExerciseRepository, JenkinsPipelineScriptCreator jenkinsPipelineScriptCreator, + BuildPlanRepository buildPlanRepository) { this.restTemplate = restTemplate; this.jenkinsServer = jenkinsServer; this.jenkinsBuildPlanCreator = jenkinsBuildPlanCreator; @@ -90,6 +94,7 @@ public class JenkinsBuildPlanService { this.programmingExerciseRepository = programmingExerciseRepository; this.jenkinsInternalUrlService = jenkinsInternalUrlService; this.jenkinsPipelineScriptCreator = jenkinsPipelineScriptCreator; + this.buildPlanRepository = buildPlanRepository; } /** @@ -233,13 +238,20 @@ public class JenkinsBuildPlanService { /** * Copies a build plan to another and replaces the old reference to the master and main branch with a reference to the default branch * - * @param sourceProjectKey the source project key - * @param sourcePlanName the source plan name - * @param targetProjectKey the target project key - * @param targetPlanName the target plan name + * @param sourceExercise the source exercise + * @param sourcePlanName the source plan name + * @param targetExercise the target exercise + * @param targetPlanName the target plan name * @return the key of the created build plan */ - public String copyBuildPlan(String sourceProjectKey, String sourcePlanName, String targetProjectKey, String targetPlanName) { + public String copyBuildPlan(ProgrammingExercise sourceExercise, String sourcePlanName, ProgrammingExercise targetExercise, String targetPlanName) { + buildPlanRepository.copyBetweenExercises(sourceExercise, targetExercise); + targetExercise.generateAndSetBuildPlanAccessSecret(); + targetExercise = programmingExerciseRepository.save(targetExercise); + + String sourceProjectKey = sourceExercise.getProjectKey(); + String targetProjectKey = targetExercise.getProjectKey(); + final var cleanTargetName = getCleanPlanName(targetPlanName); final var sourcePlanKey = sourceProjectKey + "-" + sourcePlanName; final var targetPlanKey = targetProjectKey + "-" + cleanTargetName; @@ -362,7 +374,7 @@ public class JenkinsBuildPlanService { /** * Assigns access permissions to instructors and TAs for the specified build plan. * This is done by getting all users that belong to the instructor and TA groups of - * the exercise' course and adding permissions to the Jenkins job. + * the exercises' course and adding permissions to the Jenkins job. * * @param programmingExercise the programming exercise * @param planName the name of the build plan diff --git a/src/main/java/de/tum/in/www1/artemis/service/connectors/localci/LocalCIService.java b/src/main/java/de/tum/in/www1/artemis/service/connectors/localci/LocalCIService.java index ed969ec8f0..23579184d3 100644 --- a/src/main/java/de/tum/in/www1/artemis/service/connectors/localci/LocalCIService.java +++ b/src/main/java/de/tum/in/www1/artemis/service/connectors/localci/LocalCIService.java @@ -110,11 +110,11 @@ public class LocalCIService extends AbstractContinuousIntegrationService { } @Override - public String copyBuildPlan(String sourceProjectKey, String sourcePlanName, String targetProjectKey, String targetProjectName, String targetPlanName, + public String copyBuildPlan(ProgrammingExercise sourceExercise, String sourcePlanName, ProgrammingExercise targetExercise, String targetProjectName, String targetPlanName, boolean targetProjectExists) { // No build plans exist for local CI. Only return a plan name. final String cleanPlanName = getCleanPlanName(targetPlanName); - return targetProjectKey + "-" + cleanPlanName; + return targetExercise.getProjectKey() + "-" + cleanPlanName; } @Override diff --git a/src/main/java/de/tum/in/www1/artemis/service/programming/ProgrammingExerciseImportService.java b/src/main/java/de/tum/in/www1/artemis/service/programming/ProgrammingExerciseImportService.java index 317e591956..c9c0eafc4d 100644 --- a/src/main/java/de/tum/in/www1/artemis/service/programming/ProgrammingExerciseImportService.java +++ b/src/main/java/de/tum/in/www1/artemis/service/programming/ProgrammingExerciseImportService.java @@ -200,8 +200,8 @@ public class ProgrammingExerciseImportService { final var targetKey = newExercise.getProjectKey(); final var targetName = newExercise.getCourseViaExerciseGroupOrCourseMember().getShortName().toUpperCase() + " " + newExercise.getTitle(); continuousIntegrationService.orElseThrow().createProjectForExercise(newExercise); - continuousIntegrationService.get().copyBuildPlan(templateKey, templatePlanName, targetKey, targetName, templatePlanName, false); - continuousIntegrationService.get().copyBuildPlan(templateKey, solutionPlanName, targetKey, targetName, solutionPlanName, true); + continuousIntegrationService.get().copyBuildPlan(templateExercise, templatePlanName, newExercise, targetName, templatePlanName, false); + continuousIntegrationService.get().copyBuildPlan(templateExercise, solutionPlanName, newExercise, targetName, solutionPlanName, true); continuousIntegrationService.get().givePlanPermissions(newExercise, templatePlanName); continuousIntegrationService.get().givePlanPermissions(newExercise, solutionPlanName); programmingExerciseService.giveCIProjectPermissions(newExercise); diff --git a/src/test/java/de/tum/in/www1/artemis/service/GitlabCIServiceTest.java b/src/test/java/de/tum/in/www1/artemis/service/GitlabCIServiceTest.java index e9360f48a2..228ae25390 100644 --- a/src/test/java/de/tum/in/www1/artemis/service/GitlabCIServiceTest.java +++ b/src/test/java/de/tum/in/www1/artemis/service/GitlabCIServiceTest.java @@ -22,6 +22,7 @@ import org.springframework.security.test.context.support.WithMockUser; import de.tum.in.www1.artemis.AbstractSpringIntegrationGitlabCIGitlabSamlTest; import de.tum.in.www1.artemis.domain.BuildLogEntry; +import de.tum.in.www1.artemis.domain.Course; import de.tum.in.www1.artemis.domain.ProgrammingExercise; import de.tum.in.www1.artemis.domain.enumeration.ProgrammingLanguage; import de.tum.in.www1.artemis.domain.enumeration.ProjectType; @@ -241,15 +242,20 @@ class GitlabCIServiceTest extends AbstractSpringIntegrationGitlabCIGitlabSamlTes @Test @WithMockUser(username = TEST_PREFIX + "instructor1", roles = "INSTRUCTOR") void testCopyBuildPlan() { - final String targetProjectKey = "TARGETPROJECTKEY"; + final Course course = new Course(); + final ProgrammingExercise targetExercise = new ProgrammingExercise(); + course.addExercises(targetExercise); + targetExercise.generateAndSetProjectKey(); + + final String targetProjectKey = targetExercise.getProjectKey(); final String targetPlanName1 = "TARGETPLANNAME1"; final String targetPlanName2 = "target-plan-name-#2"; - final String expectedBuildPlanKey1 = "TARGETPROJECTKEY-TARGETPLANNAME1"; - final String expectedBuildPlanKey2 = "TARGETPROJECTKEY-TARGETPLANNAME2"; + final String expectedBuildPlanKey1 = targetProjectKey + "-TARGETPLANNAME1"; + final String expectedBuildPlanKey2 = targetProjectKey + "-TARGETPLANNAME2"; - assertThat(continuousIntegrationService.copyBuildPlan(null, null, targetProjectKey, null, targetPlanName1, false)).isEqualTo(expectedBuildPlanKey1); - assertThat(continuousIntegrationService.copyBuildPlan(null, null, targetProjectKey, null, targetPlanName2, false)).isEqualTo(expectedBuildPlanKey2); + assertThat(continuousIntegrationService.copyBuildPlan(null, null, targetExercise, null, targetPlanName1, false)).isEqualTo(expectedBuildPlanKey1); + assertThat(continuousIntegrationService.copyBuildPlan(null, null, targetExercise, null, targetPlanName2, false)).isEqualTo(expectedBuildPlanKey2); } @Test diff --git a/src/test/java/de/tum/in/www1/artemis/service/JenkinsServiceTest.java b/src/test/java/de/tum/in/www1/artemis/service/JenkinsServiceTest.java index 7501e70093..ba35d12081 100644 --- a/src/test/java/de/tum/in/www1/artemis/service/JenkinsServiceTest.java +++ b/src/test/java/de/tum/in/www1/artemis/service/JenkinsServiceTest.java @@ -25,11 +25,15 @@ import org.springframework.util.StreamUtils; import com.offbytwo.jenkins.model.JobWithDetails; import de.tum.in.www1.artemis.AbstractSpringIntegrationJenkinsGitlabTest; +import de.tum.in.www1.artemis.course.CourseUtilService; +import de.tum.in.www1.artemis.domain.BuildPlan; +import de.tum.in.www1.artemis.domain.ProgrammingExercise; import de.tum.in.www1.artemis.domain.enumeration.ProgrammingLanguage; import de.tum.in.www1.artemis.exception.JenkinsException; import de.tum.in.www1.artemis.exercise.programmingexercise.ContinuousIntegrationTestService; import de.tum.in.www1.artemis.exercise.programmingexercise.ProgrammingExerciseUtilService; import de.tum.in.www1.artemis.participation.ParticipationUtilService; +import de.tum.in.www1.artemis.repository.BuildPlanRepository; import de.tum.in.www1.artemis.repository.ProgrammingExerciseRepository; import de.tum.in.www1.artemis.service.programming.ProgrammingExerciseImportService; @@ -52,6 +56,12 @@ class JenkinsServiceTest extends AbstractSpringIntegrationJenkinsGitlabTest { @Autowired private ParticipationUtilService participationUtilService; + @Autowired + private CourseUtilService courseUtilService; + + @Autowired + private BuildPlanRepository buildPlanRepository; + /** * This method initializes the test case by setting up a local repo */ @@ -256,4 +266,29 @@ class JenkinsServiceTest extends AbstractSpringIntegrationJenkinsGitlabTest { List.of()); }).withMessageStartingWith("Error trying to configure build plan in Jenkins"); } + + @Test + @WithMockUser(roles = "INSTRUCTOR", username = TEST_PREFIX + "instructor1") + void testCopyBuildPlan() throws IOException { + var course = courseUtilService.addEmptyCourse(); + + ProgrammingExercise sourceExercise = new ProgrammingExercise(); + course.addExercises(sourceExercise); + sourceExercise.generateAndSetProjectKey(); + sourceExercise = programmingExerciseRepository.save(sourceExercise); + String buildPlanContent = "this is just to test if the build plan is copied correctly"; + buildPlanRepository.setBuildPlanForExercise(buildPlanContent, sourceExercise); + + ProgrammingExercise targetExercise = new ProgrammingExercise(); + course.addExercises(targetExercise); + targetExercise.generateAndSetProjectKey(); + targetExercise = programmingExerciseRepository.save(targetExercise); + + jenkinsRequestMockProvider.mockCopyBuildPlan(sourceExercise.getProjectKey(), targetExercise.getProjectKey()); + + continuousIntegrationService.copyBuildPlan(sourceExercise, "", targetExercise, "", "", true); + BuildPlan sourceBuildPlan = buildPlanRepository.findByProgrammingExercises_IdWithProgrammingExercisesElseThrow(sourceExercise.getId()); + BuildPlan targetBuildPlan = buildPlanRepository.findByProgrammingExercises_IdWithProgrammingExercisesElseThrow(targetExercise.getId()); + assertThat(sourceBuildPlan).isEqualTo(targetBuildPlan); + } }

['src/main/java/de/tum/in/www1/artemis/service/programming/ProgrammingExerciseImportService.java', 'src/main/java/de/tum/in/www1/artemis/service/connectors/jenkins/JenkinsService.java', 'src/main/java/de/tum/in/www1/artemis/service/connectors/gitlabci/GitLabCIService.java', 'src/main/java/de/tum/in/www1/artemis/service/connectors/ci/ContinuousIntegrationService.java', 'src/test/java/de/tum/in/www1/artemis/service/GitlabCIServiceTest.java', 'src/main/java/de/tum/in/www1/artemis/service/connectors/jenkins/build_plan/JenkinsBuildPlanService.java', 'src/main/java/de/tum/in/www1/artemis/service/ParticipationService.java', 'src/test/java/de/tum/in/www1/artemis/service/JenkinsServiceTest.java', 'src/main/java/de/tum/in/www1/artemis/service/connectors/localci/LocalCIService.java', 'src/main/java/de/tum/in/www1/artemis/service/connectors/bamboo/BambooService.java', 'src/main/java/de/tum/in/www1/artemis/repository/BuildPlanRepository.java']

{'.java': 11}

Java

{'Java': 13557695, 'TypeScript': 11937642, 'HTML': 2646433, 'SCSS': 351993, 'Scala': 203267, 'JavaScript': 145109, 'Shell': 96776, 'Python': 65037, 'Swift': 47826, 'PHP': 30694, 'OCaml': 30536, 'Groovy': 23787, 'CSS': 14104, 'Assembly': 12789, 'Kotlin': 8996, 'Dockerfile': 6710, 'Haskell': 4691, 'C': 4480, 'VHDL': 4142}

MIT License

ls1intum/artemis/6842/6691

ls1intum

artemis

https://github.com/ls1intum/Artemis/issues/6691

https://github.com/ls1intum/Artemis/pull/6842

https://github.com/ls1intum/Artemis/pull/6842

fix

Outdated activation links shouldn't cause a full stracktrace in server logs

### Describe the bug Clicking outdated activation links lead to an internal server error with full stacktrace in the server logs and make me, as a server admin, think that something really bad has happened (i.e., sth that needs further investigation). ### To Reproduce 1. Go to `/account/activate?key=foo`. 2. Check the server logs and see an *Internal Server Error* in from `o.z.problem.spring.common.AdviceTraits`. ### Expected behavior There should be only an `INFO` log line mentioning that the activation key XYZ was not found or is otherwise invalid. ### Screenshots _No response_ ### Which version of Artemis are you seeing the problem on? 6.2.1 ### What browsers are you seeing the problem on? Firefox ### Additional context _No response_ ### Relevant log output ```shell 2023-06-08 12:14:16.223 ERROR 264042 --- [.1-8080-exec-68] o.z.problem.spring.common.AdviceTraits : Internal Server Error de.tum.in.www1.artemis.web.rest.errors.InternalServerErrorException: No user was found for this activation key at de.tum.in.www1.artemis.web.rest.AccountResource.activateAccount(AccountResource.java:116) at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77) at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) at java.base/java.lang.reflect.Method.invoke(Method.java:568) at org.springframework.web.method.support.InvocableHandlerMethod.doInvoke(InvocableHandlerMethod.java:205) at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:150) at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:117) at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:895) at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:808) at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87) at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1072) at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:965) at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1006) at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:898) at javax.servlet.http.HttpServlet.service(HttpServlet.java:497) at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:883) at javax.servlet.http.HttpServlet.service(HttpServlet.java:584) at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:209) at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:153) at org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:51) at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:178) at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:153) at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:111) at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:178) at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:153) at de.tum.in.www1.artemis.config.ApiVersionFilter.doFilter(ApiVersionFilter.java:51) at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:178) at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:153) at io.sentry.spring.SentryUserFilter.doFilterInternal(SentryUserFilter.java:56) at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117) at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:178) at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:153) at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:337) at org.springframework.security.web.access.intercept.FilterSecurityInterceptor.invoke(FilterSecurityInterceptor.java:115) at org.springframework.security.web.access.intercept.FilterSecurityInterceptor.doFilter(FilterSecurityInterceptor.java:81) at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:346) at org.springframework.security.web.access.ExceptionTranslationFilter.doFilter(ExceptionTranslationFilter.java:122) at org.springframework.security.web.access.ExceptionTranslationFilter.doFilter(ExceptionTranslationFilter.java:116) at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:346) at org.springframework.security.web.session.SessionManagementFilter.doFilter(SessionManagementFilter.java:126) at org.springframework.security.web.session.SessionManagementFilter.doFilter(SessionManagementFilter.java:81) at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:346) at org.springframework.security.web.authentication.AnonymousAuthenticationFilter.doFilter(AnonymousAuthenticationFilter.java:109) at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:346) at org.springframework.security.web.servletapi.SecurityContextHolderAwareRequestFilter.doFilter(SecurityContextHolderAwareRequestFilter.java:149) at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:346) at org.springframework.security.web.savedrequest.RequestCacheAwareFilter.doFilter(RequestCacheAwareFilter.java:63) at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:346) at de.tum.in.www1.artemis.security.jwt.JWTFilter.doFilter(JWTFilter.java:36) at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:346) at org.springframework.web.filter.CorsFilter.doFilterInternal(CorsFilter.java:91) at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117) at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:346) at de.tum.in.www1.artemis.security.lti.Lti13LaunchFilter.doFilterInternal(Lti13LaunchFilter.java:51) at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117) at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:346) at uk.ac.ox.ctl.lti13.security.oauth2.client.lti.web.OAuth2AuthorizationRequestRedirectFilter.doFilterInternal(OAuth2AuthorizationRequestRedirectFilter.java:147) at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117) at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:346) at org.springframework.security.web.authentication.logout.LogoutFilter.doFilter(LogoutFilter.java:103) at org.springframework.security.web.authentication.logout.LogoutFilter.doFilter(LogoutFilter.java:89) at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:346) at org.springframework.security.web.header.HeaderWriterFilter.doHeadersAfter(HeaderWriterFilter.java:90) at org.springframework.security.web.header.HeaderWriterFilter.doFilterInternal(HeaderWriterFilter.java:75) at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117) at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:346) at org.springframework.security.web.context.SecurityContextPersistenceFilter.doFilter(SecurityContextPersistenceFilter.java:112) at org.springframework.security.web.context.SecurityContextPersistenceFilter.doFilter(SecurityContextPersistenceFilter.java:82) at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:346) at org.springframework.security.web.context.request.async.WebAsyncManagerIntegrationFilter.doFilterInternal(WebAsyncManagerIntegrationFilter.java:55) at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117) at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:346) at org.springframework.security.web.session.DisableEncodeUrlFilter.doFilterInternal(DisableEncodeUrlFilter.java:42) at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117) ... ```

83ae671d4b0123c59fa86f658c50d800091ef78e

8993f16e21a55773c0c30f5c0016da5b92822781

https://github.com/ls1intum/artemis/compare/83ae671d4b0123c59fa86f658c50d800091ef78e...8993f16e21a55773c0c30f5c0016da5b92822781

diff --git a/src/main/java/de/tum/in/www1/artemis/web/rest/open/PublicAccountResource.java b/src/main/java/de/tum/in/www1/artemis/web/rest/open/PublicAccountResource.java index 75fa9cd1af..0db3d9347f 100644 --- a/src/main/java/de/tum/in/www1/artemis/web/rest/open/PublicAccountResource.java +++ b/src/main/java/de/tum/in/www1/artemis/web/rest/open/PublicAccountResource.java @@ -34,7 +34,6 @@ import de.tum.in.www1.artemis.web.rest.errors.AccessForbiddenException; import de.tum.in.www1.artemis.web.rest.errors.BadRequestAlertException; import de.tum.in.www1.artemis.web.rest.errors.EmailAlreadyUsedException; import de.tum.in.www1.artemis.web.rest.errors.EntityNotFoundException; -import de.tum.in.www1.artemis.web.rest.errors.InternalServerErrorException; import de.tum.in.www1.artemis.web.rest.errors.LoginAlreadyUsedException; import de.tum.in.www1.artemis.web.rest.errors.PasswordViolatesRequirementsException; import de.tum.in.www1.artemis.web.rest.vm.KeyAndPasswordVM; @@ -104,7 +103,8 @@ public class PublicAccountResource { * {@code GET /activate} : activate the registered user. * * @param key the activation key. - * @throws RuntimeException {@code 500 (Internal Server Error)} if the user couldn't be activated. + * @throws AccessForbiddenException {@code 403 (Forbidden)} if the user registration is disabled + * @throws EntityNotFoundException {@code 404 (Not Found)} if the user provided an invalid activation key */ @GetMapping("activate") @EnforceNothing @@ -114,7 +114,7 @@ public class PublicAccountResource { } Optional<User> user = userService.activateRegistration(key); if (user.isEmpty()) { - throw new InternalServerErrorException("No user was found for this activation key"); + throw new EntityNotFoundException("Activation key", key); } } diff --git a/src/test/java/de/tum/in/www1/artemis/user/AccountResourceIntegrationTest.java b/src/test/java/de/tum/in/www1/artemis/user/AccountResourceIntegrationTest.java index 3196f743ef..3ab808db34 100644 --- a/src/test/java/de/tum/in/www1/artemis/user/AccountResourceIntegrationTest.java +++ b/src/test/java/de/tum/in/www1/artemis/user/AccountResourceIntegrationTest.java @@ -224,7 +224,7 @@ class AccountResourceIntegrationTest extends AbstractSpringIntegrationBambooBitb void activateAccountNoUser() throws Exception { LinkedMultiValueMap<String, String> params = new LinkedMultiValueMap<>(); params.add("key", ""); - request.get("/api/public/activate", HttpStatus.INTERNAL_SERVER_ERROR, String.class, params); + request.get("/api/public/activate", HttpStatus.NOT_FOUND, String.class, params); } @Test diff --git a/src/test/java/de/tum/in/www1/artemis/user/AccountResourceWithGitLabIntegrationTest.java b/src/test/java/de/tum/in/www1/artemis/user/AccountResourceWithGitLabIntegrationTest.java index d6408dd9f0..638b475273 100644 --- a/src/test/java/de/tum/in/www1/artemis/user/AccountResourceWithGitLabIntegrationTest.java +++ b/src/test/java/de/tum/in/www1/artemis/user/AccountResourceWithGitLabIntegrationTest.java @@ -247,7 +247,7 @@ class AccountResourceWithGitLabIntegrationTest extends AbstractSpringIntegration // Activate the user gitlabRequestMockProvider.mockActivateUser(user.getLogin(), true); String activationKey = registeredUser.get().getActivationKey(); - request.get("/api/public/activate?key=" + activationKey, HttpStatus.INTERNAL_SERVER_ERROR, Void.class); + request.get("/api/public/activate?key=" + activationKey, HttpStatus.NOT_FOUND, Void.class); verify(gitlabRequestMockProvider.getMockedUserApi()).unblockUser(anyLong()); assertThat(registeredUser.get().getActivationKey()).isNotNull();

['src/test/java/de/tum/in/www1/artemis/user/AccountResourceWithGitLabIntegrationTest.java', 'src/main/java/de/tum/in/www1/artemis/web/rest/open/PublicAccountResource.java', 'src/test/java/de/tum/in/www1/artemis/user/AccountResourceIntegrationTest.java']

{'.java': 3}

Java

{'Java': 13557695, 'TypeScript': 11937642, 'HTML': 2646433, 'SCSS': 351993, 'Scala': 203267, 'JavaScript': 145109, 'Shell': 96776, 'Python': 65037, 'Swift': 47826, 'PHP': 30694, 'OCaml': 30536, 'Groovy': 23787, 'CSS': 14104, 'Assembly': 12789, 'Kotlin': 8996, 'Dockerfile': 6710, 'Haskell': 4691, 'C': 4480, 'VHDL': 4142}

MIT License

dita-ot/dita-ot/3925/3917

dita-ot

dita-ot

https://github.com/dita-ot/dita-ot/issues/3917

https://github.com/dita-ot/dita-ot/pull/3925

https://github.com/dita-ot/dita-ot/pull/3925

fixes

if parallel=true, some files are not rendered

## Expected Behavior all files are rendered ## Actual Behavior some files are skipped with error "folder could not be created". seemingly randomly in documents, but consistently between builds ## Steps to Reproduce render a document with a lot of topics in the same subfolder (?) ## Copy of the error message, log file or stack trace [xslt] Failed to transform document: Failed to transform document: Failed to create directory ## Environment * DITA-OT version: 3.7.1, 3.6.1 * Operating system and version: Linux, Windows * How did you run DITA-OT? `dita` command * Transformation type: HTML5

d7e92f038accc942c386ee1935aaffdb619f9514

8798c69e8876d309cec447a916321cd15112d3ec

https://github.com/dita-ot/dita-ot/compare/d7e92f038accc942c386ee1935aaffdb619f9514...8798c69e8876d309cec447a916321cd15112d3ec

diff --git a/src/main/java/org/dita/dost/ant/DITAOTCopy.java b/src/main/java/org/dita/dost/ant/DITAOTCopy.java index 391df9948..144498391 100644 --- a/src/main/java/org/dita/dost/ant/DITAOTCopy.java +++ b/src/main/java/org/dita/dost/ant/DITAOTCopy.java @@ -13,6 +13,8 @@ import java.io.BufferedReader; import java.io.File; import java.io.FileReader; import java.io.IOException; +import java.nio.file.FileAlreadyExistsException; +import java.nio.file.Files; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; @@ -89,9 +91,16 @@ public final class DITAOTCopy extends Task { if (destDir == null) { throw new BuildException("Destination directory not defined"); } - if (!destDir.exists() && !destDir.mkdirs()) { - throw new BuildException(new IOException("Destination directory " + destDir + " cannot be created")); + if (!destDir.exists()) { + try { + Files.createDirectories(destDir.toPath()); + } catch (FileAlreadyExistsException e) { + // Ignore + } catch (IOException e) { + throw new BuildException(e); + } } + try { final FileUtils fileUtils = FileUtils.newFileUtils(); final List<String> incs = getIncludes(); diff --git a/src/main/java/org/dita/dost/module/TopicMergeModule.java b/src/main/java/org/dita/dost/module/TopicMergeModule.java index cc3e72089..bd814e547 100644 --- a/src/main/java/org/dita/dost/module/TopicMergeModule.java +++ b/src/main/java/org/dita/dost/module/TopicMergeModule.java @@ -22,6 +22,8 @@ import org.dita.dost.util.Job.FileInfo; import javax.xml.transform.stream.StreamSource; import java.io.*; import java.nio.charset.StandardCharsets; +import java.nio.file.FileAlreadyExistsException; +import java.nio.file.Files; import static javax.xml.XMLConstants.XMLNS_ATTRIBUTE; import static org.dita.dost.util.Constants.*; @@ -84,8 +86,14 @@ final class TopicMergeModule extends AbstractPipelineModuleImpl { } final File outputDir = out.getParentFile(); - if (!outputDir.exists() && !outputDir.mkdirs()) { - logger.error("Failed to create directory " + outputDir.getAbsolutePath()); + if (!outputDir.exists()) { + try { + Files.createDirectories(outputDir.toPath()); + } catch (FileAlreadyExistsException e) { + // Ignore + } catch (IOException e) { + logger.error("Failed to create directory " + outputDir.getAbsolutePath()); + } } try (final OutputStream output = new BufferedOutputStream(job.getStore().getOutputStream(out.toURI()))) { if (style != null) { diff --git a/src/main/java/org/dita/dost/module/filter/TopicBranchFilterModule.java b/src/main/java/org/dita/dost/module/filter/TopicBranchFilterModule.java index f8ea99b66..485b26714 100644 --- a/src/main/java/org/dita/dost/module/filter/TopicBranchFilterModule.java +++ b/src/main/java/org/dita/dost/module/filter/TopicBranchFilterModule.java @@ -21,6 +21,8 @@ import org.xml.sax.XMLFilter; import java.io.File; import java.io.IOException; import java.net.URI; +import java.nio.file.FileAlreadyExistsException; +import java.nio.file.Files; import java.util.Collections; import java.util.HashSet; import java.util.List; @@ -128,8 +130,14 @@ public final class TopicBranchFilterModule extends AbstractBranchFilterModule { final List<XMLFilter> pipe = singletonList(writer); final File dstDirUri = new File(dstAbsUri.resolve(".")); - if (!dstDirUri.exists() && !dstDirUri.mkdirs()) { - logger.error("Failed to create directory " + dstDirUri); + if (!dstDirUri.exists()) { + try { + Files.createDirectories(dstDirUri.toPath()); + } catch (FileAlreadyExistsException e) { + // Ignore + } catch (IOException e) { + logger.error("Failed to create directory " + dstDirUri); + } } try { job.getStore().transform(srcAbsUri, dstAbsUri, pipe); diff --git a/src/main/java/org/dita/dost/module/reader/AbstractReaderModule.java b/src/main/java/org/dita/dost/module/reader/AbstractReaderModule.java index f90100b7f..b55d8ca83 100644 --- a/src/main/java/org/dita/dost/module/reader/AbstractReaderModule.java +++ b/src/main/java/org/dita/dost/module/reader/AbstractReaderModule.java @@ -29,6 +29,8 @@ import org.xml.sax.helpers.DefaultHandler; import javax.xml.namespace.QName; import java.io.*; import java.net.URI; +import java.nio.file.FileAlreadyExistsException; +import java.nio.file.Files; import java.util.*; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentLinkedQueue; @@ -336,9 +338,15 @@ public abstract class AbstractReaderModule extends AbstractPipelineModuleImpl { final URI rel = tempFileNameScheme.generateTempFileName(currentFile); outputFile = new File(job.tempDirURI.resolve(rel)); final File outputDir = outputFile.getParentFile(); - if (!outputDir.exists() && !outputDir.mkdirs()) { - logger.error("Failed to create output directory " + outputDir.getAbsolutePath()); - return; + if (!outputDir.exists()) { + try { + Files.createDirectories(outputDir.toPath()); + } catch (FileAlreadyExistsException e) { + // Ignore + } catch (IOException e) { + logger.error("Failed to create output directory " + outputDir.getAbsolutePath()); + return; + } } validateMap = Collections.emptyMap(); defaultValueMap = Collections.emptyMap(); diff --git a/src/main/java/org/dita/dost/store/StreamStore.java b/src/main/java/org/dita/dost/store/StreamStore.java index 2a36e1a7b..862f81ba3 100644 --- a/src/main/java/org/dita/dost/store/StreamStore.java +++ b/src/main/java/org/dita/dost/store/StreamStore.java @@ -28,6 +28,7 @@ import javax.xml.transform.TransformerException; import javax.xml.transform.stream.StreamSource; import java.io.*; import java.net.URI; +import java.nio.file.FileAlreadyExistsException; import java.nio.file.Files; import java.nio.file.Paths; import java.util.List; @@ -164,11 +165,6 @@ public class StreamStore extends AbstractStore implements Store { @Override void transformURI(final URI input, final URI output, final List<XMLFilter> filters) throws DITAOTException { - final File outputFile = new File(output); - if (!outputFile.getParentFile().exists() && !outputFile.getParentFile().mkdirs()) { - throw new DITAOTException("Failed to create output directory " + outputFile.getParentFile().getAbsolutePath()); - } - try { XMLReader reader = xmlUtils.getXMLReader(); for (final XMLFilter filter : filters) { @@ -238,8 +234,12 @@ public class StreamStore extends AbstractStore implements Store { Serializer getSerializer(final URI dst) throws IOException { final File outputFile = new File(dst); final File dir = outputFile.getParentFile(); - if (!dir.exists() && !dir.mkdirs()) { - throw new IOException("Failed to create directory " + dir.getAbsolutePath()); + if (!dir.exists()) { + try { + Files.createDirectories(dir.toPath()); + } catch (FileAlreadyExistsException e) { + // Ignore + } } return xmlUtils.getProcessor().newSerializer(outputFile); } diff --git a/src/main/java/org/dita/dost/util/XMLUtils.java b/src/main/java/org/dita/dost/util/XMLUtils.java index 58e6f800e..75062c71b 100644 --- a/src/main/java/org/dita/dost/util/XMLUtils.java +++ b/src/main/java/org/dita/dost/util/XMLUtils.java @@ -32,6 +32,8 @@ import javax.xml.transform.stream.StreamResult; import javax.xml.transform.stream.StreamSource; import java.io.*; import java.net.URI; +import java.nio.file.FileAlreadyExistsException; +import java.nio.file.Files; import java.util.*; import java.util.stream.Collectors; import java.util.stream.Stream; @@ -650,8 +652,14 @@ public final class XMLUtils { */ @Deprecated private void transformFile(final File inputFile, final File outputFile, final List<XMLFilter> filters) throws DITAOTException { - if (!outputFile.getParentFile().exists() && !outputFile.getParentFile().mkdirs()) { - throw new DITAOTException("Failed to create output directory " + outputFile.getParentFile().getAbsolutePath()); + if (!outputFile.getParentFile().exists()) { + try { + Files.createDirectories(outputFile.getParentFile().toPath()); + } catch (FileAlreadyExistsException e) { + // Ignore + } catch (IOException e) { + throw new DITAOTException(e); + } } try (final InputStream in = new BufferedInputStream(new FileInputStream(inputFile)); @@ -703,8 +711,14 @@ public final class XMLUtils { @Deprecated private void transformURI(final URI input, final URI output, final List<XMLFilter> filters) throws DITAOTException { final File outputFile = new File(output); - if (!outputFile.getParentFile().exists() && !outputFile.getParentFile().mkdirs()) { - throw new DITAOTException("Failed to create output directory " + outputFile.getParentFile().getAbsolutePath()); + if (!outputFile.getParentFile().exists()) { + try { + Files.createDirectories(outputFile.getParentFile().toPath()); + } catch (FileAlreadyExistsException e) { + // Ignore + } catch (IOException e) { + throw new DITAOTException(e); + } } try {

['src/main/java/org/dita/dost/module/reader/AbstractReaderModule.java', 'src/main/java/org/dita/dost/ant/DITAOTCopy.java', 'src/main/java/org/dita/dost/util/XMLUtils.java', 'src/main/java/org/dita/dost/module/TopicMergeModule.java', 'src/main/java/org/dita/dost/store/StreamStore.java', 'src/main/java/org/dita/dost/module/filter/TopicBranchFilterModule.java']

{'.java': 6}

Java

{'Java': 2476766, 'XSLT': 2016428, 'HTML': 1407059, 'SCSS': 34437, 'CSS': 27432, 'Shell': 15542, 'Batchfile': 11111, 'C': 4336, 'JavaScript': 2246, 'Dockerfile': 1771}

Apache License 2.0

dita-ot/dita-ot/3943/3934

dita-ot

dita-ot

https://github.com/dita-ot/dita-ot/issues/3934

https://github.com/dita-ot/dita-ot/pull/3943

https://github.com/dita-ot/dita-ot/pull/3943

fixes

DITA-OT 3.6 or above can't handle Input file of non-ASCII path.

## Expected Behavior <!-- If you're describing a bug, tell us what should happen. --> Input file of non-ASCII path should be processed properly. ## Actual Behavior <!-- Tell us what happens instead of the expected behavior. --> When the full path of input file contains non-ASCII characters, a fatal error occurs. This behavior depends on DITA-OT version. - 3.7.2 -> Failed - 3.6.1 -> Failed - 3.5.4 -> Success ## Possible Solution <!-- Optional suggestions on how to fix the issue, or implement the changes. --> <!-- If you know how to fix the issue, please create a pull request instead. --> Probably the direct cause of this error is the encoding of .job.xml file created in Temp directory. The encoding of .job.xml file is Shift-JIS which is the default encoding of Japanese environment. ## Steps to Reproduce <!-- Test case, Gist, set of files or steps required to reproduce the issue. --> 1. Unzip the following sample to some directory. 2. run dita command `dita.bat -i .\\サンプル\\hierarchy.ditamap -f pdf` [DITA-OT_non-ASCII_path_sample.zip](https://github.com/dita-ot/dita-ot/files/8849315/DITA-OT_non-ASCII_path_sample.zip) <!-- Create a Gist via <https://gist.github.com/> to upload your test files. --> <!-- Link to the Gist from the issue or attach a .zip archive of your files. --> ## Copy of the error message, log file or stack trace <!-- Long logs should be attached or in linked Gists, not in the issue body. --> ``` C:\\Temp\\DITA-OT_issue> C:\\apl\\dita-ot-3.7.2\\bin\\dita.bat -i .\\サンプル\\hierarchy.ditamap -f pdf [pipeline] Error reported by XML parser: Invalid byte 1 of 1-byte UTF-8 sequence. [pipeline] Failed to transform document: Failed to transform document: org.xml.sax.SAXParseException; systemId: file:/C:/Users/lis74h/AppData/Local/Temp/temp20220607095738941/.job.xml; lineNumber: 1; columnNumber: 90; Invalid byte 1 of 1-byte UTF-8 sequence. [i18n-preprocess] [Fatal Error] stage2.fo:86:159: XML document structures must start and end within the same entity. Error: The following error occurred while executing this line: C:\\apl\\dita-ot-3.7.2\\plugins\\org.dita.pdf2\\build.xml:337: java.io.IOException: Failed to read document: XML document structures must start and end within the same entity. ``` .job.xml file in Temp directory: [job_xml.zip](https://github.com/dita-ot/dita-ot/files/8849398/job_xml.zip) ## Environment <!-- Include relevant details about the environment you experienced this in. --> * DITA-OT version: 3.7.2 * Operating system and version: Windows 10 21H2 * How did you run DITA-OT? dita command * Transformation type: PDF <!-- Before submitting, check the Preview tab above to verify the XML markup appears correctly and remember you can edit the description later to add information. -->

a9c3ae5dcedb48148983acac752053656bdc3df7

432a61104f85196755100c44062e8ab2b905dd32

https://github.com/dita-ot/dita-ot/compare/a9c3ae5dcedb48148983acac752053656bdc3df7...432a61104f85196755100c44062e8ab2b905dd32

diff --git a/src/main/java/org/dita/dost/util/Job.java b/src/main/java/org/dita/dost/util/Job.java index 0b930f263..dc961eb94 100644 --- a/src/main/java/org/dita/dost/util/Job.java +++ b/src/main/java/org/dita/dost/util/Job.java @@ -27,6 +27,8 @@ import javax.xml.transform.dom.DOMResult; import java.io.*; import java.lang.reflect.Field; import java.net.URI; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; import java.nio.file.Files; import java.nio.file.StandardOpenOption; import java.util.*; @@ -310,7 +312,7 @@ public final class Job { * @throws IOException if writing configuration files failed */ public void write() throws IOException { - try (Writer outStream = new BufferedWriter(new OutputStreamWriter(getStore().getOutputStream(jobFile.toURI())))) { + try (Writer outStream = new BufferedWriter(new OutputStreamWriter(getStore().getOutputStream(jobFile.toURI()), StandardCharsets.UTF_8))) { XMLStreamWriter out = null; try { out = XMLOutputFactory.newInstance().createXMLStreamWriter(outStream); diff --git a/src/test/java/org/dita/dost/util/JobTest.java b/src/test/java/org/dita/dost/util/JobTest.java index 7930e5b6e..1cbda8ebc 100644 --- a/src/test/java/org/dita/dost/util/JobTest.java +++ b/src/test/java/org/dita/dost/util/JobTest.java @@ -12,9 +12,13 @@ import static org.dita.dost.util.Constants.*; import static org.dita.dost.util.URLUtils.*; import java.io.File; +import java.io.FileInputStream; import java.io.IOException; +import java.io.InputStreamReader; +import java.lang.reflect.Field; import java.net.URI; import java.net.URISyntaxException; +import java.nio.charset.StandardCharsets; import java.util.HashMap; import java.util.Map; @@ -23,7 +27,7 @@ import org.junit.AfterClass; import org.junit.BeforeClass; import org.junit.Ignore; import org.junit.Test; - +import org.apache.commons.io.FileUtils; import org.dita.dost.TestUtils; public final class JobTest { @@ -91,6 +95,31 @@ public final class JobTest { final long end = System.currentTimeMillis(); System.out.println(((end - start)) + " ms"); } + + @Test + public void writeUTF8() throws Exception { + //Reset default encoding field in order to re-compute it after setting the file.encoding system property. + Field defaultCSField = Class.forName("java.nio.charset.Charset").getDeclaredField("defaultCharset"); + defaultCSField.setAccessible(true); + defaultCSField.set(null, null); + String initialEncoding = System.getProperty("file.encoding"); + try { + System.getProperties().setProperty("file.encoding", "ASCII"); + job.add(Job.FileInfo.builder() + .src(new File(tempDir, "\\u633F.dita").toURI()) + .uri(new File("\\u633F.dita").toURI()) + .result(new File(tempDir, "\\u633F.html").toURI()) + .format("dita") + .hasKeyref(true) + .hasLink(true) + .build()); + job.write(); + File jobFile = new File(tempDir, ".job.xml"); + assertTrue(FileUtils.readFileToString(jobFile, StandardCharsets.UTF_8).contains("\\u633F.dita")); + } finally { + System.getProperties().setProperty("file.encoding", initialEncoding); + } + } @AfterClass public static void tearDown() throws IOException {

['src/main/java/org/dita/dost/util/Job.java', 'src/test/java/org/dita/dost/util/JobTest.java']

{'.java': 2}

Java

{'Java': 2476766, 'XSLT': 2016428, 'HTML': 1407059, 'SCSS': 34437, 'CSS': 27432, 'Shell': 15542, 'Batchfile': 11111, 'C': 4336, 'JavaScript': 2246, 'Dockerfile': 1771}

Apache License 2.0

dita-ot/dita-ot/3960/3959

dita-ot

dita-ot

https://github.com/dita-ot/dita-ot/issues/3959

https://github.com/dita-ot/dita-ot/pull/3960

https://github.com/dita-ot/dita-ot/pull/3960

fixes

Guard against possible NPE in XMLUtils.toErrorReporter(DITAOTLogger)

Using an invalid plugin I got this NPE in the XMLUtils.toErrorReporter method: .... java.lang.NullPointerException: Cannot invoke "net.sf.saxon.s9api.Location.getSystemId()" because the return value of "net.sf.saxon.s9api.XmlProcessingError.getLocation()" is null at org.dita.dost.util.XMLUtils.lambda$0(XMLUtils.java:202) at net.sf.saxon.style.Compilation.compileSingletonPackage(Compilation.java:117) at net.sf.saxon.s9api.XsltCompiler.compile(XsltCompiler.java:838) at org.dita.dost.module.XsltModule.execute(XsltModule.java:112) at org.dita.dost.ant.ExtensibleAntInvoker.execute(ExtensibleAntInvoker.java:189) the NPE is caused by a FileNotFoundException thrown somewhere because an XSLT stylesheet is missing in my plugin: .../plugins/com.oxygenxml.webhelp.responsive/xsl/indexterms/extractIndexterms.xsl (No such file or directory) [pipeline] at java.base/java.io.FileInputStream.open0(Native Method) [pipeline] at java.base/java.io.FileInputStream.open(FileInputStream.java:216) [pipeline] at java.base/java.io.FileInputStream.<init>(FileInputStream.java:157) [pipeline] at java.base/java.io.FileInputStream.<init>(FileInputStream.java:111) [pipeline] at java.base/sun.net.www.protocol.file.FileURLConnection.connect(FileURLConnection.java:86) [pipeline] at java.base/sun.net.www.protocol.file.FileURLConnection.getInputStream(FileURLConnection.java:189) [pipeline] at org.apache.xerces.impl.XMLEntityManager.setupCurrentEntity(XMLEntityManager.java:1114) [pipeline] at org.apache.xerces.impl.XMLVersionDetector.determineDocVersion(Unknown Source) [pipeline] at org.apache.xerces.parsers.XML11Configuration.parse(Unknown Source) [pipeline] at org.ditang.relaxng.defaults.RelaxDefaultsParserConfiguration.parse(RelaxDefaultsParserConfiguration.java:119) [pipeline] at org.apache.xerces.parsers.XML11Configuration.parse(Unknown Source) [pipeline] at org.apache.xerces.parsers.XMLParser.parse(Unknown Source) [pipeline] at org.apache.xerces.parsers.AbstractSAXParser.parse(Unknown Source) [pipeline] at org.apache.xerces.jaxp.SAXParserImpl$JAXPSAXParser.parse(Unknown Source) [pipeline] at net.sf.saxon.event.Sender.sendSAXSource(Sender.java:439) [pipeline] at net.sf.saxon.event.Sender.send(Sender.java:168) [pipeline] at net.sf.saxon.style.StylesheetModule.sendStylesheetSource(StylesheetModule.java:157) [pipeline] at net.sf.saxon.style.StylesheetModule.loadStylesheet(StylesheetModule.java:229) [pipeline] at net.sf.saxon.style.Compilation.compileSingletonPackage(Compilation.java:113) [pipeline] at net.sf.saxon.s9api.XsltCompiler.compile(XsltCompiler.java:838) [pipeline] at org.dita.dost.module.XsltModule.execute(XsltModule.java:112) [pipeline] at org.dita.dost.ant.ExtensibleAntInvoker.execute(ExtensibleAntInvoker.java:1

888e376cd2026856aec20ba57ece1a7e07c247de

e18233db00511fa64a21ffd394fa1159cefcc0c7

https://github.com/dita-ot/dita-ot/compare/888e376cd2026856aec20ba57ece1a7e07c247de...e18233db00511fa64a21ffd394fa1159cefcc0c7

diff --git a/src/main/java/org/dita/dost/util/XMLUtils.java b/src/main/java/org/dita/dost/util/XMLUtils.java index e57172dfa..a4c81e88b 100644 --- a/src/main/java/org/dita/dost/util/XMLUtils.java +++ b/src/main/java/org/dita/dost/util/XMLUtils.java @@ -9,11 +9,11 @@ package org.dita.dost.util; import com.google.common.annotations.VisibleForTesting; import net.sf.saxon.expr.instruct.TerminationException; -import net.sf.saxon.lib.*; +import net.sf.saxon.lib.CollationURIResolver; +import net.sf.saxon.lib.ErrorReporter; +import net.sf.saxon.lib.ExtensionFunctionDefinition; import net.sf.saxon.s9api.*; -import net.sf.saxon.s9api.streams.Predicates; import net.sf.saxon.s9api.streams.Step; -import net.sf.saxon.s9api.streams.XdmStream; import org.apache.xml.resolver.tools.CatalogResolver; import org.dita.dost.exception.DITAOTException; import org.dita.dost.log.DITAOTLogger; @@ -197,15 +197,18 @@ public final class XMLUtils { logger.warn(error.getMessage()); } else { if (error.getCause() instanceof FileNotFoundException) { - error.asWarning(); - final StringBuilder buf = new StringBuilder() - .append(error.getLocation().getSystemId()) - .append(":") - .append(error.getLocation().getLineNumber()) - .append(":") - .append(error.getLocation().getColumnNumber()) - .append(": ") - .append(error.getMessage()); + error = error.asWarning(); + final StringBuilder buf = new StringBuilder(); + final Location location = error.getLocation(); + if (location != null) { + buf.append(location.getSystemId()) + .append(":") + .append(location.getLineNumber()) + .append(":") + .append(location.getColumnNumber()) + .append(": "); + } + buf.append(error.getMessage()); logger.warn(buf.toString()); } else { logger.error(error.getMessage());

['src/main/java/org/dita/dost/util/XMLUtils.java']

{'.java': 1}

Java

{'Java': 2476766, 'XSLT': 2016428, 'HTML': 1407059, 'SCSS': 34437, 'CSS': 27432, 'Shell': 15542, 'Batchfile': 11111, 'C': 4336, 'JavaScript': 2246, 'Dockerfile': 1771}

Apache License 2.0

dita-ot/dita-ot/3977/3366

dita-ot

dita-ot

https://github.com/dita-ot/dita-ot/issues/3366

https://github.com/dita-ot/dita-ot/pull/3977

https://github.com/dita-ot/dita-ot/pull/3977

fix

NullPointerException in FileUtils.getRelativePath

The stack trace: https://www.oxygenxml.com/forum/viewtopic.php?f=20&t=20682 D:\\Oxygen XML Author 21\\frameworks\\dita\\DITA-OT3.x\\plugins\\org.dita.base\\build_preprocess.xml:87: java.lang.NullPointerException at org.dita.dost.util.FileUtils.getRelativePath(FileUtils.java:169) at org.dita.dost.module.DebugAndFilterModule.getRelativePathFromOut(DebugAndFilterModule.java:532) at org.dita.dost.module.DebugAndFilterModule.getPathtoProject(DebugAndFilterModule.java:514) at org.dita.dost.writer.DitaWriterFilter.startDocument(DitaWriterFilter.java:95) at org.xml.sax.helpers.XMLFilterImpl.startDocument(Unknown Source) at org.dita.dost.writer.TopicFragmentFilter.startDocument(TopicFragmentFil It looks like a side effect of a condition added by @robander in: https://github.com/dita-ot/dita-ot/pull/2797

b2da4f863823a8cb2547dc01737f4e0165375107

edc7c857d4b1aa6c36446bb939b1c8b1bf1995ba

https://github.com/dita-ot/dita-ot/compare/b2da4f863823a8cb2547dc01737f4e0165375107...edc7c857d4b1aa6c36446bb939b1c8b1bf1995ba

diff --git a/src/main/java/org/dita/dost/util/FileUtils.java b/src/main/java/org/dita/dost/util/FileUtils.java index efd70ad3c..e0544f85d 100644 --- a/src/main/java/org/dita/dost/util/FileUtils.java +++ b/src/main/java/org/dita/dost/util/FileUtils.java @@ -166,7 +166,7 @@ public final class FileUtils { * @return relative path, or refPath if different root means no relative path is possible */ public static File getRelativePath(final File basePath, final File refPath) { - if (!basePath.toPath().getRoot().equals(refPath.toPath().getRoot())) { + if (basePath.toPath().getRoot() == null || !basePath.toPath().getRoot().equals(refPath.toPath().getRoot())) { return refPath; } return basePath.toPath().getParent().relativize(refPath.toPath()).toFile(); diff --git a/src/test/java/org/dita/dost/util/TestFileUtils.java b/src/test/java/org/dita/dost/util/TestFileUtils.java index 666547bea..3110579ef 100644 --- a/src/test/java/org/dita/dost/util/TestFileUtils.java +++ b/src/test/java/org/dita/dost/util/TestFileUtils.java @@ -77,11 +77,13 @@ public class TestFileUtils { assertEquals(new File("d:\\\\a.dita"), FileUtils.getRelativePath(new File("c:\\\\map.ditamap"), new File("d:\\\\a.dita"))); assertEquals(new File("a.dita"), FileUtils.getRelativePath(new File("c:\\\\map1\\\\map2\\\\map.ditamap"), new File("c:\\\\map1\\\\map2\\\\a.dita"))); assertEquals(new File("../topic/a.dita"), FileUtils.getRelativePath(new File("c:\\\\map1\\\\map.ditamap"), new File("c:\\\\topic\\\\a.dita"))); + assertEquals(new File("D:\\\\top_level_error\\\\out\\\\pdf-OPENME2\\\\index.html"), FileUtils.getRelativePath(new File("B1\\\\B2\\\\B3\\\\B4\\\\topic.dita"), new File("D:\\\\top_level_error\\\\out\\\\pdf-OPENME2\\\\index.html"))); } else { assertEquals(new File("../a.dita"), FileUtils.getRelativePath(new File("/map/map.ditamap"), new File("/a.dita"))); assertEquals(new File("a.dita"), FileUtils.getRelativePath(new File("/map.ditamap"), new File("/a.dita"))); assertEquals(new File("a.dita"), FileUtils.getRelativePath(new File("/map1/map2/map.ditamap"), new File("/map1/map2/a.dita"))); assertEquals(new File("../topic/a.dita"), FileUtils.getRelativePath(new File("/map1/map.ditamap"), new File("/topic/a.dita"))); + assertEquals(new File("/top_level_error/out/pdf-OPENME2/index.html"), FileUtils.getRelativePath(new File("B1/B2/B3/B4/topic.dita"), new File("/top_level_error/out/pdf-OPENME2/index.html"))); } }

['src/main/java/org/dita/dost/util/FileUtils.java', 'src/test/java/org/dita/dost/util/TestFileUtils.java']

{'.java': 2}

Java

{'Java': 2476766, 'XSLT': 2016428, 'HTML': 1407059, 'SCSS': 34437, 'CSS': 27432, 'Shell': 15542, 'Batchfile': 11111, 'C': 4336, 'JavaScript': 2246, 'Dockerfile': 1771}

Apache License 2.0

dita-ot/dita-ot/3978/3969

dita-ot

dita-ot

https://github.com/dita-ot/dita-ot/issues/3969

https://github.com/dita-ot/dita-ot/pull/3978

https://github.com/dita-ot/dita-ot/pull/3978

fixes

`<xsl:message>` of an XML element also recursively prints its descendants

## Expected Behavior When I use `<xsl:message>` to print an element: ``` <xsl:template match="*[contains-token(@class, 'topic/p')]"> <xsl:message>***BEGIN***</xsl:message> <xsl:message><xsl:sequence select="."/></xsl:message> <xsl:message>***END***</xsl:message> <xsl:next-match/> </xsl:template> ``` and the element being printed has descendant elements in it: ``` <p>1 <ph>2 <ph>3 <ph>4</ph> 5</ph> 6</ph> 7</p> ``` then I expect the element to be printed, serialized as it exists in the document: ``` [xslt] ***BEGIN*** [xslt] <p xmlns:dita-ot="http://dita-ot.sourceforge.net/ns/201007/dita-ot" xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" class="- topic/p ">1 [xslt] <ph class="- topic/ph ">2 [xslt] <ph class="- topic/ph ">3 [xslt] <ph class="- topic/ph ">4</ph> [xslt] 5</ph> [xslt] 6</ph> [xslt] 7</p> [xslt] ***END*** ``` ## Actual Behavior Somehow the element is printed once normally, then the contents of its descendants are also recursively printed: ``` [xslt] ***BEGIN*** [xslt] <p xmlns:dita-ot="http://dita-ot.sourceforge.net/ns/201007/dita-ot" [xslt] xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" [xslt] class="- topic/p ">1 [xslt] <ph class="- topic/ph ">2 [xslt] <ph class="- topic/ph ">3 [xslt] <ph class="- topic/ph ">4</ph> [xslt] 5</ph> [xslt] 6</ph> [xslt] 7</p>1 [xslt] <ph xmlns:dita-ot="http://dita-ot.sourceforge.net/ns/201007/dita-ot" [xslt] xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" [xslt] class="- topic/ph ">2 [xslt] <ph class="- topic/ph ">3 [xslt] <ph class="- topic/ph ">4</ph> [xslt] 5</ph> [xslt] 6</ph>2 [xslt] <ph xmlns:dita-ot="http://dita-ot.sourceforge.net/ns/201007/dita-ot" [xslt] xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" [xslt] class="- topic/ph ">3 [xslt] <ph class="- topic/ph ">4</ph> [xslt] 5</ph>3 [xslt] <ph xmlns:dita-ot="http://dita-ot.sourceforge.net/ns/201007/dita-ot" [xslt] xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" [xslt] class="- topic/ph ">4</ph>4 [xslt] 5 [xslt] 6 [xslt] 7 [xslt] ***END*** ``` ## Possible Solution I think this is related to the fix for #3662. Note that the "expected behavior" above comes from DITA-OT 3.5.4, before the original bug was introduced. ## Steps to Reproduce 1. Extract the following testcase: [ditaot_message_nested_elements.zip](https://github.com/dita-ot/dita-ot/files/9154617/ditaot_message_nested_elements.zip) 2. Install the plugin: `dita install com.debug.message.zip` 4. Run the following command: `dita -i topic.dita -f html5 -o out -Dgenerate-debug-attributes=no --verbose` 5. Uninstall the plugin: `dita uninstall com.debug.message` ## Environment * DITA-OT version: 3.7.2 * Operating system and version: Linux (Ubuntu 20.04 LTS) * How did you run DITA-OT? `dita` command * Transformation type: any

b2da4f863823a8cb2547dc01737f4e0165375107

e8cacb7ce210633ff75d4a1d2bf5d1a30e2b7d8f

https://github.com/dita-ot/dita-ot/compare/b2da4f863823a8cb2547dc01737f4e0165375107...e8cacb7ce210633ff75d4a1d2bf5d1a30e2b7d8f

diff --git a/src/main/java/org/dita/dost/util/XMLUtils.java b/src/main/java/org/dita/dost/util/XMLUtils.java index 088a553c8..e57172dfa 100644 --- a/src/main/java/org/dita/dost/util/XMLUtils.java +++ b/src/main/java/org/dita/dost/util/XMLUtils.java @@ -160,7 +160,7 @@ public final class XMLUtils { .map(XdmItem::getStringValue) .orElse("INFO"); final String msg = content - .select(descendant( + .select(child( hasLocalName("level").or(hasLocalName("error-code")) .and(hasType(ItemType.PROCESSING_INSTRUCTION_NODE)) .negate())) diff --git a/src/test/java/org/dita/dost/util/XMLUtilsTest.java b/src/test/java/org/dita/dost/util/XMLUtilsTest.java index a9d1687b3..ae1e12c27 100644 --- a/src/test/java/org/dita/dost/util/XMLUtilsTest.java +++ b/src/test/java/org/dita/dost/util/XMLUtilsTest.java @@ -364,6 +364,26 @@ public class XMLUtilsTest { assertEquals(1, act.size()); assertEquals(new Message(Message.Level.ERROR, "message <debug/>", null), act.get(0)); } + + @Test + public void toMessageListenerProperElemsSerialization() throws SaxonApiException { + final CachingLogger logger = new CachingLogger(); + final MessageListener2 listener = XMLUtils.toMessageListener(logger); + + final XdmNode msg = Saplings.doc().withChild( + Saplings.text("abc "), + Saplings.elem("def").withChild(Saplings.elem("hij")) + ) + .toXdmNode(new XMLUtils().getProcessor()); + + listener.message(msg, null, false, null); + + final List<Message> act = logger.getMessages(); + assertEquals(1, act.size()); + assertEquals("abc <def>\\n" + + " <hij/>\\n" + + "</def>", act.get(0).message); + } // @Test // public void transform() throws Exception {

['src/test/java/org/dita/dost/util/XMLUtilsTest.java', 'src/main/java/org/dita/dost/util/XMLUtils.java']

{'.java': 2}

Java

{'Java': 2476766, 'XSLT': 2016428, 'HTML': 1407059, 'SCSS': 34437, 'CSS': 27432, 'Shell': 15542, 'Batchfile': 11111, 'C': 4336, 'JavaScript': 2246, 'Dockerfile': 1771}

Apache License 2.0

dita-ot/dita-ot/4053/4043

dita-ot

dita-ot

https://github.com/dita-ot/dita-ot/issues/4043

https://github.com/dita-ot/dita-ot/pull/4053

https://github.com/dita-ot/dita-ot/pull/4053

fixes

Flagging does not work with specialized attribute

## Expected Behavior When multiple flags apply to a single element, multiple flags should be rendered, typically in the order that they are encountered. https://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/archSpec/base/flagging.html#flagging ## Actual Behavior When multiple flags apply to a single element, some flags are ignored if the attribute is speicalized. In the test case attahced, flagging does not work as expected for last paragraph. Here `newAtt` is specialized from `props`. ``` <p class="- topic/p " platform="windows">1. platform="windows"</p> <p class="- topic/p " audience="novice">2. audience="novice"</p> <p class="- topic/p " newAtt="aaa">3. newAtt="(aaa)"</p> <p class="- topic/p " platform="windows" audience="novice">4. platform="windows" and audience="novice"</p> <p class="- topic/p " platform="windows" newAtt="aaa">5. platform="windows" and newAtt="aaa"</p> ``` ## Possible Solution N/A ## Steps to Reproduce Test case and the project file is attached. [test.zip](https://github.com/dita-ot/dita-ot/files/9977643/test.zip) `dita --project=project.xml` ## Copy of the error message, log file or stack trace N/A ## Environment * DITA-OT version: 3.4.1 * Operating system and version: Windows * How did you run DITA-OT? 'dita' command * Transformation type: PDF

5bee85fcebc6adfe928354c0fe8ddbbc27358c20

37bb69871cbfeddc3743e78fdc54cc7e07c72ec2

https://github.com/dita-ot/dita-ot/compare/5bee85fcebc6adfe928354c0fe8ddbbc27358c20...37bb69871cbfeddc3743e78fdc54cc7e07c72ec2

diff --git a/src/main/java/org/dita/dost/util/FilterUtils.java b/src/main/java/org/dita/dost/util/FilterUtils.java index 8c1f0be93..ce05de7c0 100644 --- a/src/main/java/org/dita/dost/util/FilterUtils.java +++ b/src/main/java/org/dita/dost/util/FilterUtils.java @@ -182,21 +182,19 @@ public final class FilterUtils { } } } - if (res.isEmpty()) { - if (extProps != null && extProps.length != 0) { - for (final QName[] propList : extProps) { - int propListIndex = propList.length - 1; - final QName propName = propList[propListIndex]; - String propValue = atts.getValue(propName.getNamespaceURI(), propName.getLocalPart()); - - while ((propValue == null || propValue.trim().isEmpty()) && propListIndex > 0) { - propListIndex--; - final QName current = propList[propListIndex]; - propValue = getLabelValue(propName, atts.getValue(current.getNamespaceURI(), current.getLocalPart())); - } - if (propValue != null) { - res.addAll(extCheckFlag(propList, Arrays.asList(propValue.split("\\\\s+")))); - } + if (extProps != null && extProps.length != 0) { + for (final QName[] propList : extProps) { + int propListIndex = propList.length - 1; + final QName propName = propList[propListIndex]; + String propValue = atts.getValue(propName.getNamespaceURI(), propName.getLocalPart()); + + while ((propValue == null || propValue.trim().isEmpty()) && propListIndex > 0) { + propListIndex--; + final QName current = propList[propListIndex]; + propValue = getLabelValue(propName, atts.getValue(current.getNamespaceURI(), current.getLocalPart())); + } + if (propValue != null) { + res.addAll(extCheckFlag(propList, Arrays.asList(propValue.split("\\\\s+")))); } } } diff --git a/src/test/java/org/dita/dost/util/FilterUtilsTest.java b/src/test/java/org/dita/dost/util/FilterUtilsTest.java index a55d07cbc..55d10c522 100644 --- a/src/test/java/org/dita/dost/util/FilterUtilsTest.java +++ b/src/test/java/org/dita/dost/util/FilterUtilsTest.java @@ -7,31 +7,28 @@ */ package org.dita.dost.util; -import static java.util.Arrays.asList; -import static java.util.Collections.*; -import static javax.xml.XMLConstants.XML_NS_PREFIX; -import static javax.xml.XMLConstants.XML_NS_URI; -import static org.dita.dost.util.Constants.*; -import static org.junit.Assert.*; - -import java.util.*; -import java.util.stream.Stream; - import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableSet; import org.dita.dost.TestUtils; import org.dita.dost.util.FilterUtils.Action; import org.dita.dost.util.FilterUtils.FilterKey; - import org.dita.dost.util.FilterUtils.Flag; import org.dita.dost.util.XMLUtils.AttributesBuilder; +import org.junit.Test; import org.xml.sax.Attributes; import org.xml.sax.helpers.AttributesImpl; -import org.junit.Test; - -import javax.xml.XMLConstants; import javax.xml.namespace.QName; +import java.util.*; + +import static java.util.Arrays.asList; +import static java.util.Collections.emptySet; +import static java.util.Collections.singleton; +import static javax.xml.XMLConstants.XML_NS_PREFIX; +import static javax.xml.XMLConstants.XML_NS_URI; +import static org.dita.dost.util.Constants.ATTRIBUTE_NAME_PLATFORM; +import static org.dita.dost.util.Constants.ATTRIBUTE_NAME_REV; +import static org.junit.Assert.*; public class FilterUtilsTest { @@ -246,6 +243,23 @@ public class FilterUtilsTest { f.getFlags(attr(PLATFORM, "windows"), new QName[0][0])); } + @Test + public void testGetFlagsForSpecialization() { + final Flag flagBase = new Flag("prop", "red", null, null, null, null, null, null); + final Flag flagSpecialization = new Flag("prop", "blue", null, null, null, null, null, null); + final FilterUtils f = new FilterUtils(false, + ImmutableMap.<FilterKey, Action>builder() + .put(new FilterKey(PLATFORM, "unix"), flagBase) + .put(new FilterKey(OS, "amiga"), flagSpecialization) + .build(), null, null); + f.setLogger(new TestUtils.TestLogger()); + + assertEquals( + Set.of(flagBase, flagSpecialization), + f.getFlags(new AttributesBuilder().add(OS, "amiga").add(PLATFORM, "unix").build(), + new QName[][] {{PROPS, OS}})); + } + // DITA 1.3 @Test

['src/test/java/org/dita/dost/util/FilterUtilsTest.java', 'src/main/java/org/dita/dost/util/FilterUtils.java']

{'.java': 2}

Java

{'Java': 2476766, 'XSLT': 2016428, 'HTML': 1407059, 'SCSS': 34437, 'CSS': 27432, 'Shell': 15542, 'Batchfile': 11111, 'C': 4336, 'JavaScript': 2246, 'Dockerfile': 1771}

Apache License 2.0

dita-ot/dita-ot/4080/4071

dita-ot

dita-ot

https://github.com/dita-ot/dita-ot/issues/4071

https://github.com/dita-ot/dita-ot/pull/4080

https://github.com/dita-ot/dita-ot/pull/4080

fixes

Keyref on longdescref element inside image is not resolved to an href

Started from: https://www.oxygenxml.com/forum/viewtopic.php?p=68639#p68639 Let's say I have an image element with a longdescref inside it having a keyref: <image href="image.jpg"> <longdescref keyref="targetKey"/> </image> I publish the DITA Map to HTML5, look in the temporary files folder at the temp DITA topic and it does not contain an @href on the &lt;longdescref> element. As a possible suggested fix in this field org.dita.dost.writer.KeyrefPaser.keyrefInfos probably an extra definition needs to be added: ki.add(new KeyrefInfo(TOPIC_LONGDESCREF, ATTRIBUTE_NAME_HREF, false, false));

193f0e549420374612339cfd4f5fe3f998bc1a0a

f106bb379459469d937aba6768efc4b4835a9522

https://github.com/dita-ot/dita-ot/compare/193f0e549420374612339cfd4f5fe3f998bc1a0a...f106bb379459469d937aba6768efc4b4835a9522

diff --git a/src/main/java/org/dita/dost/writer/KeyrefPaser.java b/src/main/java/org/dita/dost/writer/KeyrefPaser.java index 92c55a32d..93eecf211 100644 --- a/src/main/java/org/dita/dost/writer/KeyrefPaser.java +++ b/src/main/java/org/dita/dost/writer/KeyrefPaser.java @@ -103,6 +103,7 @@ public final class KeyrefPaser extends AbstractXMLFilter { ki.add(new KeyrefInfo(TOPIC_INDEX_BASE, ATTRIBUTE_NAME_HREF, false, false)); ki.add(new KeyrefInfo(TOPIC_INDEXTERMREF, ATTRIBUTE_NAME_HREF, false, false)); ki.add(new KeyrefInfo(TOPIC_LONGQUOTEREF, ATTRIBUTE_NAME_HREF, false, false)); + ki.add(new KeyrefInfo(TOPIC_LONGDESCREF, ATTRIBUTE_NAME_HREF, false, false)); final Map<String, String> objectAttrs = new HashMap<>(); objectAttrs.put(ATTRIBUTE_NAME_ARCHIVEKEYREFS, ATTRIBUTE_NAME_ARCHIVE); objectAttrs.put(ATTRIBUTE_NAME_CLASSIDKEYREF, ATTRIBUTE_NAME_CLASSID);

['src/main/java/org/dita/dost/writer/KeyrefPaser.java']

{'.java': 1}

Java

{'Java': 2476766, 'XSLT': 2016428, 'HTML': 1407059, 'SCSS': 34437, 'CSS': 27432, 'Shell': 15542, 'Batchfile': 11111, 'C': 4336, 'JavaScript': 2246, 'Dockerfile': 1771}

Apache License 2.0

dita-ot/dita-ot/4152/3903

dita-ot

dita-ot

https://github.com/dita-ot/dita-ot/issues/3903

https://github.com/dita-ot/dita-ot/pull/4152

https://github.com/dita-ot/dita-ot/pull/4152

fixes

Branch filtering processes nested-topic topic files multiple times

## Expected Behavior When branch filtering is applied to a topic with nested subtopics: ``` <map> <title>Test Map</title> <ditavalref href="filter-A.ditaval"/> <topicref href="topic.dita"> <topicref href="topic.dita#id_1"> <topicref href="topic.dita#id_1_1"/> <topicref href="topic.dita#id_1_2"/> </topicref> <topicref href="topic.dita#id_2"> <topicref href="topic.dita#id_2_1"/> <topicref href="topic.dita#id_2_2"/> </topicref> </topicref> </map> ``` the `branch-filter` step should process each topic file a single time: ``` [branch-filter] Filtering file:/tmp/temp20220319114445274/topic.dita ``` ## Actual Behavior The `branch-filter` step processes each topic file multiple times: ``` [branch-filter] Filtering file:/tmp/temp20220319114445274/topic.dita [branch-filter] Filtering file:/tmp/temp20220319114445274/topic.dita#id_1 [branch-filter] Filtering file:/tmp/temp20220319114445274/topic.dita#id_1_1 [branch-filter] Filtering file:/tmp/temp20220319114445274/topic.dita#id_1_2 [branch-filter] Filtering file:/tmp/temp20220319114445274/topic.dita#id_2 [branch-filter] Filtering file:/tmp/temp20220319114445274/topic.dita#id_2_1 [branch-filter] Filtering file:/tmp/temp20220319114445274/topic.dita#id_2_2 ``` I confirmed that the first branch filtering operation processes the entire file; thus, the subsequent operations perform unnecessary read-modify-write operations. On small testcases, the effect on runtime is negligible. But on a production online help map with many nested topics, branch filtering takes 66% of the `html5` transformation runtime (1050 seconds for branch filtering, out of 1590 seconds total). #3875 is likely related - see the bottom of [this comment](https://github.com/dita-ot/dita-ot/issues/3875#issuecomment-1044208535). ## Possible Solution `BranchFilterModule.java` should be updated to process each file a single time. The solution should handle both omitted root topic `@id` values: ``` <topicref href="topic.dita"> <!-- root topic @id omitted --> <topicref href="topic.dita#id_1"/> <topicref href="topic.dita#id_2"/> </topicref> ``` as well as explicit root topic `@id` values: ``` <topicref href="topic.dita#root_topic_id"> <!-- @id explicitly included --> <topicref href="topic.dita#id_1"/> <topicref href="topic.dita#id_2"/> </topicref> ``` ## Steps to Reproduce You must use a DITA-OT that includes the fix for #3875 (3.7.1 when released, or a development branch before then). 1. Download and extract the following testcase: [3903.zip](https://github.com/dita-ot/dita-ot/files/11067818/3903.zip) 2. Run the following command: `dita -i map.ditamap -f html5 -verbose` A Perl script is included to generate a nested map/topic structure. For example, to try various combinations of 1000 nested topics, ``` make_nested_topic_testcase.pl 1000 dita -i map.ditamap -f html5 -verbose make_nested_topic_testcase.pl 20 50 dita -i map.ditamap -f html5 -verbose make_nested_topic_testcase.pl 10 10 10 dita -i map.ditamap -f html5 -verbose ``` The included testcase was generated with `make_nested_topic_testcase.pl 2 2 2`. ## Environment * DITA-OT version: 3.7.1 * Operating system and version: Linux (Ubuntu 20.04) * How did you run DITA-OT? `dita` command * Transformation type: `html5`

c02de0fb4fabb52d7f55f6fd2a94fea1fb9a7d6e

6100f8b7c456cfae745e54f28d54c2be2afe9bd3

https://github.com/dita-ot/dita-ot/compare/c02de0fb4fabb52d7f55f6fd2a94fea1fb9a7d6e...6100f8b7c456cfae745e54f28d54c2be2afe9bd3

diff --git a/src/main/java/org/dita/dost/module/BranchFilterModule.java b/src/main/java/org/dita/dost/module/BranchFilterModule.java index 5c45a5289..f21f7bda2 100644 --- a/src/main/java/org/dita/dost/module/BranchFilterModule.java +++ b/src/main/java/org/dita/dost/module/BranchFilterModule.java @@ -11,11 +11,9 @@ import static java.util.Collections.singletonList; import static org.dita.dost.util.Constants.*; import static org.dita.dost.util.StringUtils.getExtProps; import static org.dita.dost.util.StringUtils.getExtPropsFromSpecializations; -import static org.dita.dost.util.URLUtils.stripFragment; -import static org.dita.dost.util.URLUtils.toURI; +import static org.dita.dost.util.URLUtils.*; import static org.dita.dost.util.XMLUtils.*; -import java.io.File; import java.io.IOException; import java.net.URI; import java.util.*; @@ -419,7 +417,7 @@ public class BranchFilterModule extends AbstractPipelineModuleImpl { final String href = topicref.getAttribute(ATTRIBUTE_NAME_HREF); final Attr skipFilter = topicref.getAttributeNode(SKIP_FILTER); - final URI srcAbsUri = job.tempDirURI.resolve(map.resolve(href)); + final URI srcAbsUri = setFragment(job.tempDirURI.resolve(map.resolve(href)), null); if ( !fs.isEmpty() && skipFilter == null &&

['src/main/java/org/dita/dost/module/BranchFilterModule.java']

{'.java': 1}

Java

{'Java': 2476766, 'XSLT': 2016428, 'HTML': 1407059, 'SCSS': 34437, 'CSS': 27432, 'Shell': 15542, 'Batchfile': 11111, 'C': 4336, 'JavaScript': 2246, 'Dockerfile': 1771}

Apache License 2.0

dita-ot/dita-ot/3964/3724

dita-ot

dita-ot

https://github.com/dita-ot/dita-ot/issues/3724

https://github.com/dita-ot/dita-ot/pull/3964

https://github.com/dita-ot/dita-ot/pull/3964

fixes

Error in mapref stage when passing dita map as resource

I'm attaching a sample DITA project [chemistry_crash_single_topic.zip](https://github.com/dita-ot/dita-ot/files/6242590/chemistry_crash_single_topic.zip) on Windows I'm running this command line: ```batch dita -i C:\\Users\\radu_coravu\\Downloads\\chemistry_crash_single_topic\\iugux\\installation_preparation\\overview_of_installation_process.dita ^ --resource=C:\\Users\\radu_coravu\\Downloads\\chemistry_crash_single_topic\\iugux.ditamap ^ -f html5 ^ --temp=tmp ^ --clean.temp=no ^ -v ``` then I get an error reported in the "mapref" stage: [mapref] I/O error reported by XML parser processing [mapref] file:/C:/Users/radu_coravu/Desktop/dita-ot-3.6/bin/tmp/C:/Users/radu_coravu/Downloads/chemistry_crash_single_topic/iugux.ditamap: C:\\Users\\radu_coravu\\Desktop\\dita-ot-3.6\\bin\\tmp\\C:\\Users\\radu_coravu\\Downloads\\chemistry_crash_single_topic\\iugux.ditamap (The filename, directory name, or volume label syntax is incorrect) As you can see the absolute path to the dita map gets concatenated to the absolute path to the temporary files folder, producing an invalid file path on Windows. Looking in the .job.xml at the entry for the DITA Map: ```xml <file src="file:/C:/Users/radu_coravu/Downloads/chemistry_crash_single_topic/iugux.ditamap" uri="file:/C:/Users/radu_coravu/Downloads/chemistry_crash_single_topic/iugux.ditamap" path="C:\\Users\\radu_coravu\\Downloads\\chemistry_crash_single_topic\\iugux.ditamap" result="file:/C:/Users/radu_coravu/Downloads/chemistry_crash_single_topic/iugux.ditamap" format="ditamap" resource-only="true"/> ``` it is the only entry with an absolute `@path` attribute. When the method "org.dita.dost.module.MaprefModule.processMap(FileInfo)" gets called, the input file gets computed by appending two absolute file paths one to another: ```java File inputFile = new File(job.tempDir, input.file.getPath()); ``` which is invalid on Windows. The same thing works on Mac because the file path does not contain a drive name and "new File(job.tempDir, input.file.getPath())" manages to produce a valid file path.

6ad3b8f20c1997b506d39816e637b5f1deafbefa

129eb95b93024b20d566bd6666a9ef2fb1ba5ae4

https://github.com/dita-ot/dita-ot/compare/6ad3b8f20c1997b506d39816e637b5f1deafbefa...129eb95b93024b20d566bd6666a9ef2fb1ba5ae4

diff --git a/src/main/java/org/dita/dost/ant/types/JobSourceSet.java b/src/main/java/org/dita/dost/ant/types/JobSourceSet.java index bfa79b2f6..935db7257 100644 --- a/src/main/java/org/dita/dost/ant/types/JobSourceSet.java +++ b/src/main/java/org/dita/dost/ant/types/JobSourceSet.java @@ -7,10 +7,6 @@ */ package org.dita.dost.ant.types; -import static org.dita.dost.util.Constants.*; -import static org.dita.dost.util.FileUtils.supportedImageExtensions; -import static org.dita.dost.util.URLUtils.*; - import com.google.common.annotations.VisibleForTesting; import com.google.common.collect.ImmutableSet; import org.apache.tools.ant.Project; @@ -32,6 +28,11 @@ import java.net.MalformedURLException; import java.net.URL; import java.util.*; +import static org.dita.dost.util.Constants.ATTR_FORMAT_VALUE_DITA; +import static org.dita.dost.util.Constants.ATTR_FORMAT_VALUE_IMAGE; +import static org.dita.dost.util.FileUtils.supportedImageExtensions; +import static org.dita.dost.util.URLUtils.toFile; + /** * Resource collection that finds matching resources from job configuration. */ @@ -59,7 +60,7 @@ public class JobSourceSet extends AbstractFileSet implements ResourceCollection res = new ArrayList<>(); for (final FileInfo f : job.getFileInfo(this::filter)) { log("Scanning for " + f.file.getPath(), Project.MSG_VERBOSE); - final File tempFile = new File(job.tempDir, f.file.getPath()); + final File tempFile = new File(job.tempDirURI.resolve(f.uri)); if (job.getStore().exists(tempFile.toURI())) { log("Found temporary directory file " + tempFile, Project.MSG_VERBOSE); res.add(new StoreResource(job, job.tempDirURI.relativize(f.uri))); diff --git a/src/main/java/org/dita/dost/module/ChunkModule.java b/src/main/java/org/dita/dost/module/ChunkModule.java index 4515662d0..dfc8a4db1 100644 --- a/src/main/java/org/dita/dost/module/ChunkModule.java +++ b/src/main/java/org/dita/dost/module/ChunkModule.java @@ -73,7 +73,7 @@ final public class ChunkModule extends AbstractPipelineModuleImpl { if (transtype.equals(INDEX_TYPE_ECLIPSEHELP) && isEclipseMap(mapFile.toURI())) { for (final FileInfo f : job.getFileInfo()) { if (ATTR_FORMAT_VALUE_DITAMAP.equals(f.format)) { - mapReader.read(new File(job.tempDir, f.file.getPath()).getAbsoluteFile()); + mapReader.read(new File(job.tempDirURI.resolve(f.uri)).getAbsoluteFile()); } } } else { diff --git a/src/main/java/org/dita/dost/module/ConrefPushModule.java b/src/main/java/org/dita/dost/module/ConrefPushModule.java index cbf8310af..a4ba2ccd4 100644 --- a/src/main/java/org/dita/dost/module/ConrefPushModule.java +++ b/src/main/java/org/dita/dost/module/ConrefPushModule.java @@ -8,12 +8,6 @@ */ package org.dita.dost.module; -import java.io.File; -import java.util.Collection; -import java.util.Hashtable; -import java.util.Map; -import java.util.stream.Collectors; - import org.dita.dost.exception.DITAOTException; import org.dita.dost.pipeline.AbstractPipelineInput; import org.dita.dost.pipeline.AbstractPipelineOutput; @@ -23,6 +17,12 @@ import org.dita.dost.util.Job.FileInfo; import org.dita.dost.writer.ConrefPushParser; import org.w3c.dom.DocumentFragment; +import java.io.File; +import java.util.Collection; +import java.util.Hashtable; +import java.util.Map; +import java.util.stream.Collectors; + /** * Conref push module. */ @@ -38,7 +38,7 @@ final class ConrefPushModule extends AbstractPipelineModuleImpl { reader.setLogger(logger); reader.setJob(job); for (final FileInfo f: fis) { - final File file = new File(job.tempDir, f.file.getPath()); + final File file = new File(job.tempDirURI.resolve(f.uri)); logger.info("Reading " + file.toURI()); //FIXME: this reader calculate parent directory reader.read(file.getAbsoluteFile()); diff --git a/src/main/java/org/dita/dost/module/DebugAndFilterModule.java b/src/main/java/org/dita/dost/module/DebugAndFilterModule.java index f063f3c1e..0819699b9 100644 --- a/src/main/java/org/dita/dost/module/DebugAndFilterModule.java +++ b/src/main/java/org/dita/dost/module/DebugAndFilterModule.java @@ -119,7 +119,7 @@ public final class DebugAndFilterModule extends SourceReaderModule { logger.warn("Ignoring a copy-to file " + f.result); return; } - outputFile = new File(job.tempDir, f.file.getPath()); + outputFile = new File(job.tempDirURI.resolve(f.uri)); logger.info("Processing " + f.src + " to " + outputFile.toURI()); final Set<URI> schemaSet = dic.get(f.uri); diff --git a/src/main/java/org/dita/dost/module/GenMapAndTopicListModule.java b/src/main/java/org/dita/dost/module/GenMapAndTopicListModule.java index f9fd0f90b..2dfa77c28 100644 --- a/src/main/java/org/dita/dost/module/GenMapAndTopicListModule.java +++ b/src/main/java/org/dita/dost/module/GenMapAndTopicListModule.java @@ -1035,7 +1035,7 @@ public final class GenMapAndTopicListModule extends SourceReaderModule { // write list attribute to file final String fileKey = REL_FLAGIMAGE_LIST.substring(0, REL_FLAGIMAGE_LIST.lastIndexOf("list")) + "file"; prop.setProperty(fileKey, REL_FLAGIMAGE_LIST.substring(0, REL_FLAGIMAGE_LIST.lastIndexOf("list")) + ".list"); - final File list = new File(job.tempDir, prop.getProperty(fileKey)); + final File list = job.tempDir.toPath().resolve(prop.getProperty(fileKey)).toFile(); try (Writer bufferedWriter = new BufferedWriter(new OutputStreamWriter(job.getStore().getOutputStream(list.toURI())))) { final Iterator<URI> it = newSet.iterator(); while (it.hasNext()) { diff --git a/src/main/java/org/dita/dost/module/ImageMetadataModule.java b/src/main/java/org/dita/dost/module/ImageMetadataModule.java index f317b6414..05090974f 100644 --- a/src/main/java/org/dita/dost/module/ImageMetadataModule.java +++ b/src/main/java/org/dita/dost/module/ImageMetadataModule.java @@ -7,7 +7,13 @@ */ package org.dita.dost.module; -import static org.dita.dost.util.Constants.*; +import org.dita.dost.exception.DITAOTException; +import org.dita.dost.pipeline.AbstractPipelineInput; +import org.dita.dost.pipeline.AbstractPipelineOutput; +import org.dita.dost.util.Job.FileInfo; +import org.dita.dost.util.Pool; +import org.dita.dost.writer.ImageMetadataFilter; +import org.xml.sax.Attributes; import java.io.File; import java.io.IOException; @@ -16,15 +22,8 @@ import java.util.Collection; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import java.util.function.Predicate; -import java.util.stream.Stream; -import org.dita.dost.exception.DITAOTException; -import org.dita.dost.pipeline.AbstractPipelineInput; -import org.dita.dost.pipeline.AbstractPipelineOutput; -import org.dita.dost.util.Job.FileInfo; -import org.dita.dost.util.Pool; -import org.dita.dost.writer.ImageMetadataFilter; -import org.xml.sax.Attributes; +import static org.dita.dost.util.Constants.*; /** * Image metadata module. @@ -68,7 +67,7 @@ final class ImageMetadataModule extends AbstractPipelineModuleImpl { }); job.getFileInfo(filter).stream() .parallel() - .map(f -> new File(job.tempDir, f.file.getPath()).getAbsoluteFile()) + .map(f -> new File(job.tempDirURI.resolve(f.uri)).getAbsoluteFile()) .forEach(filename -> { final ImageMetadataFilter writer = pool.borrowObject(); try { @@ -82,7 +81,7 @@ final class ImageMetadataModule extends AbstractPipelineModuleImpl { writer.setLogger(logger); writer.setJob(job); for (final FileInfo f : job.getFileInfo(filter)) { - writer.write(new File(job.tempDir, f.file.getPath()).getAbsoluteFile()); + writer.write(new File(job.tempDirURI.resolve(f.uri)).getAbsoluteFile()); } } diff --git a/src/main/java/org/dita/dost/module/KeyrefModule.java b/src/main/java/org/dita/dost/module/KeyrefModule.java index b3a8270fc..edb939e25 100644 --- a/src/main/java/org/dita/dost/module/KeyrefModule.java +++ b/src/main/java/org/dita/dost/module/KeyrefModule.java @@ -32,7 +32,6 @@ import org.dita.dost.writer.KeyrefPaser; import org.dita.dost.writer.TopicFragmentFilter; import org.xml.sax.XMLFilter; -import java.io.File; import java.io.IOException; import java.net.URI; import java.util.*; @@ -499,12 +498,12 @@ final class KeyrefModule extends AbstractPipelineModuleImpl { if (r.out != null) { logger.info("Processing " + job.tempDirURI.resolve(r.in.uri) + " to " + job.tempDirURI.resolve(r.out.uri)); - job.getStore().transform(new File(job.tempDir, r.in.file.getPath()).toURI(), - new File(job.tempDir, r.out.file.getPath()).toURI(), + job.getStore().transform(job.tempDirURI.resolve(r.in.uri), + job.tempDirURI.resolve(r.out.uri), filters); } else { logger.info("Processing " + job.tempDirURI.resolve(r.in.uri)); - job.getStore().transform(new File(job.tempDir, r.in.file.getPath()).toURI(), + job.getStore().transform(job.tempDirURI.resolve(r.in.uri), filters); } // validate resource-only list diff --git a/src/main/java/org/dita/dost/module/MaprefModule.java b/src/main/java/org/dita/dost/module/MaprefModule.java index fd624f997..c6359c124 100644 --- a/src/main/java/org/dita/dost/module/MaprefModule.java +++ b/src/main/java/org/dita/dost/module/MaprefModule.java @@ -87,7 +87,7 @@ final class MaprefModule extends AbstractPipelineModuleImpl { } private void processMap(final FileInfo input) throws DITAOTException { - final File inputFile = new File(job.tempDir, input.file.getPath()); + final File inputFile = new File(job.tempDirURI.resolve(input.uri)); final File outputFile = new File(inputFile.getAbsolutePath() + FILE_EXTENSION_TEMP); logger.info("Processing " + inputFile.toURI()); @@ -160,8 +160,8 @@ final class MaprefModule extends AbstractPipelineModuleImpl { } private void replace(final FileInfo input) throws DITAOTException { - final File inputFile = new File(job.tempDir, input.file.getPath() + FILE_EXTENSION_TEMP); - final File outputFile = new File(job.tempDir, input.file.getPath()); + final File inputFile = new File(job.tempDirURI.resolve(input.uri + FILE_EXTENSION_TEMP)); + final File outputFile = new File(job.tempDirURI.resolve(input.uri)); try { job.getStore().move(inputFile.toURI(), outputFile.toURI()); } catch (final IOException e) { diff --git a/src/main/java/org/dita/dost/module/MoveMetaModule.java b/src/main/java/org/dita/dost/module/MoveMetaModule.java index c24634ce0..3275f2866 100644 --- a/src/main/java/org/dita/dost/module/MoveMetaModule.java +++ b/src/main/java/org/dita/dost/module/MoveMetaModule.java @@ -80,7 +80,7 @@ final class MoveMetaModule extends AbstractPipelineModuleImpl { } for (final FileInfo f : fis) { - final File inputFile = new File(job.tempDir, f.file.getPath()); + final File inputFile = new File(job.tempDirURI.resolve(f.uri)); final File tmp = new File(inputFile.getAbsolutePath() + ".tmp" + Long.toString(System.currentTimeMillis())); logger.info("Processing " + inputFile.toURI()); logger.debug("Processing " + inputFile.toURI() + " to " + tmp.toURI()); @@ -133,7 +133,7 @@ final class MoveMetaModule extends AbstractPipelineModuleImpl { final URI key = stripFragment(entry.getKey()); final FileInfo fi = job.getFileInfo(key); if (fi == null) { - logger.error("File " + new File(job.tempDir, key.getPath()) + " was not found."); + logger.error("File " + job.tempDirURI.resolve(key) + " was not found."); continue; } final URI targetFileName = job.tempDirURI.resolve(fi.uri); @@ -159,7 +159,7 @@ final class MoveMetaModule extends AbstractPipelineModuleImpl { final URI key = stripFragment(entry.getKey()); final FileInfo fi = job.getFileInfo(key); if (fi == null) { - logger.error("File " + new File(job.tempDir, key.getPath()) + " was not found."); + logger.error("File " + job.tempDirURI.resolve(key) + " was not found."); continue; } final URI targetFileName = job.tempDirURI.resolve(fi.uri); @@ -186,7 +186,7 @@ final class MoveMetaModule extends AbstractPipelineModuleImpl { metaReader.setLogger(logger); metaReader.setJob(job); for (final FileInfo f : fis) { - final File mapFile = new File(job.tempDir, f.file.getPath()); + final File mapFile = job.tempDir.toPath().resolve(f.file.toPath()).toFile(); //FIXME: this reader gets the parent path of input file try { metaReader.read(mapFile); diff --git a/src/main/java/org/dita/dost/module/XsltModule.java b/src/main/java/org/dita/dost/module/XsltModule.java index e034a4f11..22c8214ba 100644 --- a/src/main/java/org/dita/dost/module/XsltModule.java +++ b/src/main/java/org/dita/dost/module/XsltModule.java @@ -114,7 +114,7 @@ public final class XsltModule extends AbstractPipelineModuleImpl { final List<Entry<File, File>> tmps = includes.stream().parallel() .map(include -> { try { - final File in = new File(baseDir, include.getPath()); + final File in = baseDir.toPath().resolve(include.toPath()).toFile(); final File out = getOutput(include.getPath()); if (out == null) { return null; @@ -159,7 +159,7 @@ public final class XsltModule extends AbstractPipelineModuleImpl { } private File getOutput(final String path) { - File out = new File(destDir, path); + File out = destDir.toPath().resolve(path).toFile(); if (mapper != null) { final String[] outs = mapper.mapFileName(path); if (outs == null) { @@ -168,7 +168,7 @@ public final class XsltModule extends AbstractPipelineModuleImpl { if (outs.length > 1) { throw new RuntimeException("XSLT module only support one to one output mapping"); } - out = new File(destDir, outs[0]); + out = destDir.toPath().resolve(outs[0]).toFile(); } else if (extension != null) { out = new File(replaceExtension(out.getAbsolutePath(), extension)); } diff --git a/src/main/java/org/dita/dost/module/filter/AbstractBranchFilterModule.java b/src/main/java/org/dita/dost/module/filter/AbstractBranchFilterModule.java index dd5d44c66..f0a7aa88c 100644 --- a/src/main/java/org/dita/dost/module/filter/AbstractBranchFilterModule.java +++ b/src/main/java/org/dita/dost/module/filter/AbstractBranchFilterModule.java @@ -154,7 +154,7 @@ public abstract class AbstractBranchFilterModule extends AbstractPipelineModuleI // write list attribute to file final String fileKey = REL_FLAGIMAGE_LIST.substring(0, REL_FLAGIMAGE_LIST.lastIndexOf("list")) + "file"; prop.setProperty(fileKey, REL_FLAGIMAGE_LIST.substring(0, REL_FLAGIMAGE_LIST.lastIndexOf("list")) + ".list"); - final File list = new File(job.tempDir, prop.getProperty(fileKey)); + final File list = job.tempDir.toPath().resolve(prop.getProperty(fileKey)).toFile(); try (Writer bufferedWriter = new BufferedWriter(new OutputStreamWriter(job.getStore().getOutputStream(list.toURI())))) { for (URI aNewSet : newSet) { bufferedWriter.write(aNewSet.getPath()); diff --git a/src/main/java/org/dita/dost/module/reader/AbstractReaderModule.java b/src/main/java/org/dita/dost/module/reader/AbstractReaderModule.java index b55d8ca83..2e7eec0d7 100644 --- a/src/main/java/org/dita/dost/module/reader/AbstractReaderModule.java +++ b/src/main/java/org/dita/dost/module/reader/AbstractReaderModule.java @@ -33,7 +33,6 @@ import java.nio.file.FileAlreadyExistsException; import java.nio.file.Files; import java.util.*; import java.util.concurrent.ConcurrentHashMap; -import java.util.concurrent.ConcurrentLinkedQueue; import java.util.concurrent.ConcurrentSkipListMap; import java.util.function.Consumer; import java.util.function.Predicate; @@ -915,7 +914,7 @@ public abstract class AbstractReaderModule extends AbstractPipelineModuleImpl { // write list attribute to file final String fileKey = REL_FLAGIMAGE_LIST.substring(0, REL_FLAGIMAGE_LIST.lastIndexOf("list")) + "file"; prop.setProperty(fileKey, REL_FLAGIMAGE_LIST.substring(0, REL_FLAGIMAGE_LIST.lastIndexOf("list")) + ".list"); - final File list = new File(job.tempDir, prop.getProperty(fileKey)); + final File list = job.tempDir.toPath().resolve(prop.getProperty(fileKey)).toFile(); try (Writer bufferedWriter = new BufferedWriter(new OutputStreamWriter(job.getStore().getOutputStream(list.toURI())))) { for (URI aNewSet : newSet) { bufferedWriter.write(aNewSet.getPath()); diff --git a/src/main/java/org/dita/dost/reader/MergeMapParser.java b/src/main/java/org/dita/dost/reader/MergeMapParser.java index aae040e70..e484d81ed 100644 --- a/src/main/java/org/dita/dost/reader/MergeMapParser.java +++ b/src/main/java/org/dita/dost/reader/MergeMapParser.java @@ -8,36 +8,29 @@ */ package org.dita.dost.reader; -import static javax.xml.transform.OutputKeys.*; -import static org.dita.dost.chunk.ChunkModule.isLocalScope; -import static org.dita.dost.util.Constants.*; -import static org.dita.dost.util.URLUtils.*; +import org.dita.dost.log.DITAOTLogger; +import org.dita.dost.log.MessageUtils; +import org.dita.dost.util.*; +import org.dita.dost.util.Job.FileInfo; +import org.xml.sax.Attributes; +import org.xml.sax.SAXException; +import org.xml.sax.helpers.AttributesImpl; +import org.xml.sax.helpers.XMLFilterImpl; +import javax.xml.transform.TransformerFactory; +import javax.xml.transform.sax.SAXTransformerFactory; +import javax.xml.transform.sax.TransformerHandler; +import javax.xml.transform.stream.StreamResult; import java.io.ByteArrayOutputStream; import java.io.File; import java.io.OutputStream; import java.net.URI; import java.util.Stack; -import javax.xml.transform.TransformerFactory; -import javax.xml.transform.sax.SAXTransformerFactory; -import javax.xml.transform.sax.TransformerHandler; -import javax.xml.transform.stream.StreamResult; - -import org.xml.sax.helpers.XMLFilterImpl; -import org.xml.sax.helpers.AttributesImpl; - -import org.dita.dost.log.DITAOTLogger; -import org.dita.dost.log.MessageUtils; -import org.dita.dost.util.FileUtils; -import org.dita.dost.util.Job; -import org.dita.dost.util.Job.FileInfo; -import org.dita.dost.util.MergeUtils; -import org.dita.dost.util.URLUtils; -import org.dita.dost.util.XMLUtils; - -import org.xml.sax.Attributes; -import org.xml.sax.SAXException; +import static javax.xml.transform.OutputKeys.OMIT_XML_DECLARATION; +import static org.dita.dost.chunk.ChunkModule.isLocalScope; +import static org.dita.dost.util.Constants.*; +import static org.dita.dost.util.URLUtils.*; /** * MergeMapParser reads the ditamap file after preprocessing and merges @@ -250,14 +243,14 @@ public final class MergeMapParser extends XMLFilterImpl { String element = f.file.getPath(); if (!dirPath.equals(tempdir)) { element = FileUtils.getRelativeUnixPath(new File(dirPath,"a.ditamap").getAbsolutePath(), - new File(tempdir, element).getAbsolutePath()); + tempdir.toPath().resolve(element).toAbsolutePath().toString()); } final URI abs = job.tempDirURI.resolve(f.uri); if (!util.isVisited(abs)) { util.visit(abs); if (!f.isResourceOnly) { //ensure the file exists - final File file = new File(dirPath, element); + final File file = dirPath.toPath().resolve(element).toFile(); if (job.getStore().exists(file.toURI())) { topicParser.parse(element, dirPath); } else { diff --git a/src/main/java/org/dita/dost/reader/MergeTopicParser.java b/src/main/java/org/dita/dost/reader/MergeTopicParser.java index 8ce4a4191..010715af4 100644 --- a/src/main/java/org/dita/dost/reader/MergeTopicParser.java +++ b/src/main/java/org/dita/dost/reader/MergeTopicParser.java @@ -8,17 +8,6 @@ */ package org.dita.dost.reader; -import static javax.xml.XMLConstants.*; -import static org.dita.dost.chunk.ChunkModule.isLocalScope; -import static org.dita.dost.reader.MergeMapParser.*; -import static org.dita.dost.util.Constants.*; -import static org.dita.dost.util.FileUtils.*; -import static org.dita.dost.util.URLUtils.*; -import static org.dita.dost.util.URLUtils.setFragment; - -import java.io.File; -import java.net.URI; - import org.dita.dost.log.DITAOTLogger; import org.dita.dost.util.Job; import org.dita.dost.util.MergeUtils; @@ -29,6 +18,17 @@ import org.xml.sax.SAXException; import org.xml.sax.helpers.AttributesImpl; import org.xml.sax.helpers.XMLFilterImpl; +import java.io.File; +import java.net.URI; + +import static javax.xml.XMLConstants.XML_NS_URI; +import static org.dita.dost.chunk.ChunkModule.isLocalScope; +import static org.dita.dost.reader.MergeMapParser.ATTRIBUTE_NAME_OHREF; +import static org.dita.dost.reader.MergeMapParser.ATTRIBUTE_NAME_OID; +import static org.dita.dost.util.Constants.*; +import static org.dita.dost.util.FileUtils.stripFragment; +import static org.dita.dost.util.URLUtils.*; + /** * MergeTopicParser reads topic file and transform the references to other dita * files into internal references. The parse result of MergeTopicParser will be @@ -174,7 +174,7 @@ public final class MergeTopicParser extends XMLFilterImpl { filePath = stripFragment(filename); dirPath = dir; try { - final URI f = new File(dir, filePath).getAbsoluteFile().toURI(); + final URI f = dir.toPath().resolve(filePath).toAbsolutePath().toFile().toURI(); logger.info("Processing " + f); job.getStore().transform(f, this); } catch (final RuntimeException e) { @@ -251,7 +251,7 @@ public final class MergeTopicParser extends XMLFilterImpl { * @return rewritten href value */ private URI handleLocalHref(final URI attValue) { - final URI current = new File(dirPath, filePath).toURI().normalize(); + final URI current = dirPath.toPath().resolve(filePath).toUri().normalize(); final URI reference = current.resolve(attValue); final URI merge = output.toURI(); return getRelativePath(merge, reference); diff --git a/src/main/java/org/dita/dost/util/FileUtils.java b/src/main/java/org/dita/dost/util/FileUtils.java index e0544f85d..1bd6ee369 100644 --- a/src/main/java/org/dita/dost/util/FileUtils.java +++ b/src/main/java/org/dita/dost/util/FileUtils.java @@ -8,13 +8,13 @@ */ package org.dita.dost.util; -import static org.apache.commons.io.FilenameUtils.*; -import static org.dita.dost.util.Constants.*; - import java.io.File; import java.net.URI; import java.util.*; +import static org.apache.commons.io.FilenameUtils.normalize; +import static org.dita.dost.util.Constants.*; + /** * Static file utilities. * diff --git a/src/test/java/org/dita/dost/util/TestFileUtils.java b/src/test/java/org/dita/dost/util/TestFileUtils.java index 3110579ef..85a06d56a 100644 --- a/src/test/java/org/dita/dost/util/TestFileUtils.java +++ b/src/test/java/org/dita/dost/util/TestFileUtils.java @@ -7,16 +7,15 @@ */ package org.dita.dost.util; -import static org.junit.Assert.*; -import static org.junit.Assert.assertEquals; - -import java.io.*; - +import org.dita.dost.TestUtils; import org.junit.AfterClass; import org.junit.BeforeClass; import org.junit.Test; -import org.dita.dost.TestUtils; +import java.io.File; +import java.io.IOException; + +import static org.junit.Assert.*; public class TestFileUtils {

['src/main/java/org/dita/dost/module/MoveMetaModule.java', 'src/main/java/org/dita/dost/module/ImageMetadataModule.java', 'src/main/java/org/dita/dost/module/reader/AbstractReaderModule.java', 'src/main/java/org/dita/dost/ant/types/JobSourceSet.java', 'src/main/java/org/dita/dost/module/MaprefModule.java', 'src/main/java/org/dita/dost/module/DebugAndFilterModule.java', 'src/main/java/org/dita/dost/reader/MergeTopicParser.java', 'src/main/java/org/dita/dost/util/FileUtils.java', 'src/main/java/org/dita/dost/module/filter/AbstractBranchFilterModule.java', 'src/main/java/org/dita/dost/module/ConrefPushModule.java', 'src/main/java/org/dita/dost/module/KeyrefModule.java', 'src/main/java/org/dita/dost/module/GenMapAndTopicListModule.java', 'src/main/java/org/dita/dost/reader/MergeMapParser.java', 'src/main/java/org/dita/dost/module/ChunkModule.java', 'src/main/java/org/dita/dost/module/XsltModule.java', 'src/test/java/org/dita/dost/util/TestFileUtils.java']

{'.java': 16}

Java

{'Java': 2476766, 'XSLT': 2016428, 'HTML': 1407059, 'SCSS': 34437, 'CSS': 27432, 'Shell': 15542, 'Batchfile': 11111, 'C': 4336, 'JavaScript': 2246, 'Dockerfile': 1771}

Apache License 2.0

dita-ot/dita-ot/3825/2641

dita-ot

dita-ot

https://github.com/dita-ot/dita-ot/issues/2641

https://github.com/dita-ot/dita-ot/pull/3825

https://github.com/dita-ot/dita-ot/pull/3825

fixes

Integrator should fail more often

In my plugin.xml has something like this inside: <feature extension="dita.conductor.target.relative" file="integrator.xml"/> but there is no "integrator.xml" in the plugin folder, the integrator complains: [integrate] D:\\DITA-OT2.x\\plugins\\my.plugin\\integrator.xml (The system cannot find the file specified) but it is still successful.

3fcfd890fefb0854d8906111614c716321981410

c7de05d00214a669cf6c9c3fb7a717c190918e18

https://github.com/dita-ot/dita-ot/compare/3fcfd890fefb0854d8906111614c716321981410...c7de05d00214a669cf6c9c3fb7a717c190918e18

diff --git a/src/main/java/org/dita/dost/platform/FileGenerator.java b/src/main/java/org/dita/dost/platform/FileGenerator.java index f33897e91..33128074b 100644 --- a/src/main/java/org/dita/dost/platform/FileGenerator.java +++ b/src/main/java/org/dita/dost/platform/FileGenerator.java @@ -170,9 +170,10 @@ final class FileGenerator extends XMLFilterImpl { } getContentHandler().startElement(uri, localName, qName, atts.build()); } + } catch (SAXException | RuntimeException e) { + throw e; } catch (final Exception e) { - e.printStackTrace(); - logger.error(e.getMessage(), e) ; + throw new RuntimeException(e); } } diff --git a/src/main/java/org/dita/dost/platform/InsertAction.java b/src/main/java/org/dita/dost/platform/InsertAction.java index c1acfa2ba..7f99b56f6 100644 --- a/src/main/java/org/dita/dost/platform/InsertAction.java +++ b/src/main/java/org/dita/dost/platform/InsertAction.java @@ -8,6 +8,9 @@ */ package org.dita.dost.platform; +import java.io.FileNotFoundException; +import java.io.IOException; +import java.io.UncheckedIOException; import java.util.Hashtable; import java.util.LinkedHashSet; import java.util.List; @@ -72,12 +75,16 @@ class InsertAction extends XMLFilterImpl implements IAction { public void getResult(final ContentHandler retBuf) throws SAXException { setContentHandler(retBuf); try { - for (final Value fileName: fileNameSet) { + for (final Value fileName : fileNameSet) { currentFile = fileName.value; reader.parse(currentFile); } - } catch (final Exception e) { - logger.error(e.getMessage(), e) ; + } catch (SAXException | RuntimeException e) { + throw e; + } catch (IOException e) { + throw new UncheckedIOException(e); + } catch (Exception e) { + throw new RuntimeException(e); } } diff --git a/src/test/java/org/dita/dost/platform/IntegratorTest.java b/src/test/java/org/dita/dost/platform/IntegratorTest.java index 7e56b4304..85df8b5ad 100644 --- a/src/test/java/org/dita/dost/platform/IntegratorTest.java +++ b/src/test/java/org/dita/dost/platform/IntegratorTest.java @@ -11,10 +11,9 @@ import static org.dita.dost.TestUtils.assertXMLEqual; import static org.dita.dost.util.Constants.CONF_SUPPORTED_IMAGE_EXTENSIONS; import static org.junit.Assert.*; -import java.io.File; -import java.io.FileInputStream; -import java.io.IOException; -import java.io.InputStream; +import java.io.*; +import java.nio.file.Files; +import java.nio.file.Paths; import java.util.Arrays; import java.util.HashSet; import java.util.Properties; @@ -110,7 +109,25 @@ public class IntegratorTest { new InputSource(new File(tempDir, "xsl" + File.separator + "shell.xsl").toURI().toString())); assertXMLEqual(new InputSource(new File(expDir, "plugins" + File.separator + "dummy" + File.separator + "xsl" + File.separator + "shell.xsl").toURI().toString()), new InputSource(new File(tempDir, "plugins" + File.separator + "dummy" + File.separator + "xsl" + File.separator + "shell.xsl").toURI().toString())); + } + + @Test(expected = UncheckedIOException.class) + public void testExecute_missingFile() throws Exception { + Files.delete(tempDir.toPath().resolve(Paths.get("plugins", "dummy", "build.xml"))); + + final File libDir = new File(tempDir, "lib"); + if (!libDir.exists() && !libDir.mkdirs()) { + throw new IOException("Failed to create directory " + libDir); + } + final File resourcesDir = new File(tempDir, "resources"); + if (!resourcesDir.exists() && !resourcesDir.mkdirs()) { + throw new IOException("Failed to create directory " + resourcesDir); + } + final Integrator i = new Integrator(tempDir); + i.setProperties(new File(tempDir, "integrator.properties")); + i.setLogger(new TestUtils.TestLogger(false)); + i.execute(); } private Properties getProperties(final File f) throws IOException {

['src/main/java/org/dita/dost/platform/FileGenerator.java', 'src/main/java/org/dita/dost/platform/InsertAction.java', 'src/test/java/org/dita/dost/platform/IntegratorTest.java']

{'.java': 3}

Java

{'Java': 2476766, 'XSLT': 2016428, 'HTML': 1407059, 'SCSS': 34437, 'CSS': 27432, 'Shell': 15542, 'Batchfile': 11111, 'C': 4336, 'JavaScript': 2246, 'Dockerfile': 1771}

Apache License 2.0

dita-ot/dita-ot/3871/3858

dita-ot

dita-ot

https://github.com/dita-ot/dita-ot/issues/3858

https://github.com/dita-ot/dita-ot/pull/3871

https://github.com/dita-ot/dita-ot/pull/3871

fixes

Strict mode doesn't cause failure when images are missing, though it reports that as an ERROR

## Expected Behavior When processing-mode=strict, builds fail when any missing file is reported (error [DOTX008E][ERROR]) ## Actual Behavior When using strict, I get build failures when a file referenced by a topicref in a ditamap isn't found. But I don't get failures for missing images, although strict mode is supposed to fail on any error. ## Copy of the error message, log file or stack trace [dita-ot] [topic-reader] [DOTX008E][ERROR] File 'file:/C:/workgit/dt-pipeline/dita-test/content/images/NONEXISTENTnote.png' does not exist or cannot be loaded. ## Environment <!-- Include relevant details about the environment you experienced this in. --> * DITA-OT version: 3.6.1 * Operating system and version: Windows 10, LInux * How did you run DITA-OT? command line * Transformation type: HTML and PDF

a21e75f7fed5879f8fc97c94a1f78b2119024a05

3f94d608635bf92a02632b28c5270e18c4f7bb11

https://github.com/dita-ot/dita-ot/compare/a21e75f7fed5879f8fc97c94a1f78b2119024a05...3f94d608635bf92a02632b28c5270e18c4f7bb11

diff --git a/src/main/java/org/dita/dost/module/reader/TopicReaderModule.java b/src/main/java/org/dita/dost/module/reader/TopicReaderModule.java index 01542c227..3176209e3 100644 --- a/src/main/java/org/dita/dost/module/reader/TopicReaderModule.java +++ b/src/main/java/org/dita/dost/module/reader/TopicReaderModule.java @@ -12,12 +12,14 @@ import net.sf.saxon.s9api.QName; import net.sf.saxon.s9api.XdmNode; import org.dita.dost.exception.DITAOTException; import org.dita.dost.exception.DITAOTXMLErrorHandler; +import org.dita.dost.exception.UncheckedDITAOTException; import org.dita.dost.log.MessageUtils; import org.dita.dost.module.filter.SubjectScheme; import org.dita.dost.pipeline.AbstractPipelineInput; import org.dita.dost.pipeline.AbstractPipelineOutput; import org.dita.dost.reader.GenListModuleReader.Reference; import org.dita.dost.reader.SubjectSchemeReader; +import org.dita.dost.util.Configuration; import org.dita.dost.util.Job.FileInfo; import org.dita.dost.writer.DebugFilter; import org.dita.dost.writer.NormalizeFilter; @@ -296,7 +298,11 @@ public final class TopicReaderModule extends AbstractReaderModule { } else if (ATTR_FORMAT_VALUE_IMAGE.equals(file.format)) { formatSet.add(file); if (!exists(file.filename)) { - logger.warn(MessageUtils.getMessage("DOTX008E", file.filename.toString()).toString()); + if (processingMode == Configuration.Mode.STRICT) { + throw new UncheckedDITAOTException(MessageUtils.getMessage("DOTX008E", file.filename.toString()).toException()); + } else { + logger.warn(MessageUtils.getMessage("DOTX008E", file.filename.toString()).toString()); + } } } else { htmlSet.put(file.format, file.filename);

['src/main/java/org/dita/dost/module/reader/TopicReaderModule.java']

{'.java': 1}

Java

{'Java': 2476766, 'XSLT': 2016428, 'HTML': 1407059, 'SCSS': 34437, 'CSS': 27432, 'Shell': 15542, 'Batchfile': 11111, 'C': 4336, 'JavaScript': 2246, 'Dockerfile': 1771}

Apache License 2.0

dita-ot/dita-ot/3884/3877

dita-ot

dita-ot

https://github.com/dita-ot/dita-ot/issues/3877

https://github.com/dita-ot/dita-ot/pull/3884

https://github.com/dita-ot/dita-ot/pull/3884

fixes

Build log should provide the name of the file where the issue was found

## Expected Behavior When DITA OT encounters a `keyref ERROR [DOTJ046E]` and a `filter WARNING [DOTJ049W]`, it should provide the name of the file where the issue was found. ## Actual Behavior The build log shows only the following messages, without providing the name of the file where the issue was found: ``` [keyref] [DOTJ046E][ERROR] Conkeyref="cloud/cloudPlatformFull" can not be resolved because it does not contain a key or the key is not defined. The build will use the conref attribute for fallback, if one exists. ``` ``` [filter] [DOTJ049W][WARN] The attribute value chunk="to-content" on element "chapter" does not comply with the specified subject scheme. According to the subject scheme map, the following values are valid for the chunk attribute: select-branch to-content by-content ``` ## Possible Solution Extend the build log to provide clear information on where the issue was found ## Copy of the error message, log file or stack trace ``` 13:26:40 [keyref] [DOTJ046E][ERROR] Conkeyref="cloud/csBookTitle" can not be resolved because it does not contain a key or the key is not defined. The build will use the conref attribute for fallback, if one exists. 13:27:00    [keyref] [DOTJ046E][ERROR] Conkeyref="cloud/productNameSuffix" can not be resolved because it does not contain a key or the key is not defined. The build will use the conref attribute for fallback, if one exists. 13:27:00    [keyref] [DOTJ046E][ERROR] Conkeyref="cloud/productNameSuffix" can not be resolved because it does not contain a key or the key is not defined. The build will use the conref attribute for fallback, if one exists. 13:27:07    [keyref] [DOTJ046E][ERROR] Conkeyref="cloud/productNameSuffix" can not be resolved because it does not contain a key or the key is not defined. The build will use the conref attribute for fallback, if one exists. 13:27:07    [keyref] [DOTJ046E][ERROR] Conkeyref="cloud/productNameSuffix" can not be resolved because it does not contain a key or the key is not defined. The build will use the conref attribute for fallback, if one exists. ``` ``` 12:31:27    [filter] [DOTJ049W][WARN] The attribute value chunk="to-content" on element "chapter" does not comply with the specified subject scheme. According to the subject scheme map, the following values are valid for the chunk attribute: select-branch to-content by-content 12:31:27    [filter] [DOTJ049W][WARN] The attribute value chunk="to-content" on element "chapter" does not comply with the specified subject scheme. According to the subject scheme map, the following values are valid for the chunk attribute: select-branch to-content by-content 12:31:27    [filter] [DOTJ049W][WARN] The attribute value chunk="to-content" on element "chapter" does not comply with the specified subject scheme. According to the subject scheme map, the following values are valid for the chunk attribute: select-branch to-content by-content 12:31:27    [filter] [DOTJ049W][WARN] The attribute value chunk="to-content" on element "chapter" does not comply with the specified subject scheme. According to the subject scheme map, the following values are valid for the chunk attribute: select-branch to-content by-content 12:31:27    [filter] [DOTJ049W][WARN] The attribute value chunk="to-content" on element "chapter" does not comply with the specified subject scheme. According to the subject scheme map, the following values are valid for the chunk attribute: select-branch to-content by-content 12:31:27    [filter] [DOTJ049W][WARN] The attribute value chunk="to-content" on element "chapter" does not comply with the specified subject scheme. According to the subject scheme map, the following values are valid for the chunk attribute: select-branch to-content by-content 12:31:27    [filter] [DOTJ049W][WARN] The attribute value chunk="to-content" on element "chapter" does not comply with the specified subject scheme. According to the subject scheme map, the following values are valid for the chunk attribute: select-branch to-content by-content 12:31:27    [filter] [DOTJ049W][WARN] The attribute value chunk="to-content" on element "chapter" does not comply with the specified subject scheme. According to the subject scheme map, the following values are valid for the chunk attribute: select-branch to-content by-content 12:31:27    [filter] [DOTJ049W][WARN] The attribute value chunk="to-content" on element "chapter" does not comply with the specified subject scheme. According to the subject scheme map, the following 12:33:11    [filter] [DOTJ049W][WARN] The attribute value audience="release" on element "topichead" does not comply with the specified subject scheme. According to the subject scheme map, the following values are valid for the audience attribute: internal,external,earlyaccess,reviewer ``` ## Environment * DITA-OT version: 3.4.1 * Operating system and version: Docker image created from the `adoptopenjdk:11-jdk-hotspot` image * How did you run DITA-OT? `dita` command * Transformation type: Customized Oxygen Webhelp responsive

a21e75f7fed5879f8fc97c94a1f78b2119024a05

56cad0a328a4015f868b0731ac2afbd9278bb833

https://github.com/dita-ot/dita-ot/compare/a21e75f7fed5879f8fc97c94a1f78b2119024a05...56cad0a328a4015f868b0731ac2afbd9278bb833

diff --git a/src/main/java/org/dita/dost/reader/ConrefPushReader.java b/src/main/java/org/dita/dost/reader/ConrefPushReader.java index 12f37f7a7..ea19ba687 100644 --- a/src/main/java/org/dita/dost/reader/ConrefPushReader.java +++ b/src/main/java/org/dita/dost/reader/ConrefPushReader.java @@ -269,7 +269,7 @@ public final class ConrefPushReader extends AbstractXMLReader { final String fragment = target.getFragment(); if (fragment == null) { //if there is no '#' in target string, report error - logger.error(MessageUtils.getMessage("DOTJ041E", target.toString()).toString()); + logger.error(MessageUtils.getMessage("DOTJ041E", target.toString()).setLocation(atts).toString()); } else { String id; //has element id diff --git a/src/main/java/org/dita/dost/reader/CopyToReader.java b/src/main/java/org/dita/dost/reader/CopyToReader.java index 1d4176775..752e5ee6b 100644 --- a/src/main/java/org/dita/dost/reader/CopyToReader.java +++ b/src/main/java/org/dita/dost/reader/CopyToReader.java @@ -162,7 +162,8 @@ public final class CopyToReader extends AbstractXMLFilter { final URI copyToSourceAbs = copyToMap.get(targetAbs); if (copyToSourceAbs != null) { if (!sourceAbs.equals(copyToSourceAbs)) { - logger.warn(MessageUtils.getMessage("DOTX065W", source.toString(), targetAbs.toString()).toString()); + logger.warn(MessageUtils.getMessage("DOTX065W", source.toString(), targetAbs.toString()) + .setLocation(atts).toString()); } } else if (atts.getValue(ATTRIBUTE_NAME_CHUNK) != null && atts.getValue(ATTRIBUTE_NAME_CHUNK).contains(CHUNK_TO_CONTENT)) { diff --git a/src/main/java/org/dita/dost/reader/DitaValReader.java b/src/main/java/org/dita/dost/reader/DitaValReader.java index f05ec2776..21d810971 100644 --- a/src/main/java/org/dita/dost/reader/DitaValReader.java +++ b/src/main/java/org/dita/dost/reader/DitaValReader.java @@ -179,7 +179,7 @@ public final class DitaValReader implements AbstractReader { action = readFlag(elem); break; default: - throw new IllegalArgumentException(MessageUtils.getMessage("DOTJ077F", attAction).toString()); + throw new IllegalArgumentException(MessageUtils.getMessage("DOTJ077F", attAction).setLocation(elem).toString()); } if (action != null) { final QName attName; @@ -205,7 +205,7 @@ public final class DitaValReader implements AbstractReader { } if (attName != null && attName.equals(REV) && !filterAttributes.isEmpty() && !filterAttributes.contains(REV)) { - logger.warn(MessageUtils.getMessage("DOTJ074W").toString()); + logger.warn(MessageUtils.getMessage("DOTJ074W").setLocation((elem)).toString()); return; } } diff --git a/src/main/java/org/dita/dost/reader/KeydefFilter.java b/src/main/java/org/dita/dost/reader/KeydefFilter.java index be8727746..eff88d0cc 100644 --- a/src/main/java/org/dita/dost/reader/KeydefFilter.java +++ b/src/main/java/org/dita/dost/reader/KeydefFilter.java @@ -144,7 +144,7 @@ public final class KeydefFilter extends AbstractXMLFilter { keysDefMap.put(key, new KeyDef(key, null, null, null, null, null)); } } else { - logger.info(MessageUtils.getMessage("DOTJ045I", key).toString()); + logger.info(MessageUtils.getMessage("DOTJ045I", key).setLocation(atts).toString()); } } } diff --git a/src/main/java/org/dita/dost/reader/MergeMapParser.java b/src/main/java/org/dita/dost/reader/MergeMapParser.java index 3c9b0553d..aae040e70 100644 --- a/src/main/java/org/dita/dost/reader/MergeMapParser.java +++ b/src/main/java/org/dita/dost/reader/MergeMapParser.java @@ -227,7 +227,9 @@ public final class MergeMapParser extends XMLFilterImpl { XMLUtils.addOrSetAttribute(atts, ATTRIBUTE_NAME_FIRST_TOPIC_ID, firstTopicId.toString()); } else { final URI fileName = URLUtils.toDirURI(dirPath).resolve(attValue); - logger.error(MessageUtils.getMessage("DOTX008E", fileName.toString()).toString()); + logger.error(MessageUtils.getMessage("DOTX008E", fileName.toString()) + .setLocation(attributes) + .toString()); } } } diff --git a/src/main/java/org/dita/dost/writer/ConkeyrefFilter.java b/src/main/java/org/dita/dost/writer/ConkeyrefFilter.java index ffe86137c..0d67b5696 100644 --- a/src/main/java/org/dita/dost/writer/ConkeyrefFilter.java +++ b/src/main/java/org/dita/dost/writer/ConkeyrefFilter.java @@ -75,10 +75,10 @@ public final class ConkeyrefFilter extends AbstractXMLFilter { } XMLUtils.addOrSetAttribute(resAtts, ATTRIBUTE_NAME_CONREF, target.toString()); } else { - logger.warn(MessageUtils.getMessage("DOTJ060W", key, conkeyref).toString()); + logger.warn(MessageUtils.getMessage("DOTJ060W", key, conkeyref).setLocation(atts).toString()); } } else { - logger.error(MessageUtils.getMessage("DOTJ046E", conkeyref).toString()); + logger.error(MessageUtils.getMessage("DOTJ046E", conkeyref).setLocation(atts).toString()); } } getContentHandler().startElement(uri, localName, name, resAtts != null ? resAtts : atts); diff --git a/src/main/java/org/dita/dost/writer/ValidationFilter.java b/src/main/java/org/dita/dost/writer/ValidationFilter.java index 617f54905..cb3f06f9c 100644 --- a/src/main/java/org/dita/dost/writer/ValidationFilter.java +++ b/src/main/java/org/dita/dost/writer/ValidationFilter.java @@ -304,7 +304,9 @@ public final class ValidationFilter extends AbstractXMLFilter { for (final String s : keylist) { if (!StringUtils.isEmptyString(s) && !valueSet.contains(s)) { logger.warn(MessageUtils.getMessage("DOTJ049W", - attrName.toString(), qName, attrValue, StringUtils.join(valueSet, COMMA)).toString()); + attrName.toString(), qName, attrValue, StringUtils.join(valueSet, COMMA)) + .setLocation(atts) + .toString()); } } } diff --git a/src/main/java/org/dita/dost/writer/include/IncludeText.java b/src/main/java/org/dita/dost/writer/include/IncludeText.java index 79690145b..e4cff074d 100644 --- a/src/main/java/org/dita/dost/writer/include/IncludeText.java +++ b/src/main/java/org/dita/dost/writer/include/IncludeText.java @@ -42,7 +42,7 @@ final class IncludeText { boolean include(final Attributes atts) { final URI hrefValue = toURI(atts.getValue(ATTRIBUTE_NAME_HREF)); - final Charset charset = getCharset(atts.getValue(ATTRIBUTE_NAME_FORMAT), atts.getValue(ATTRIBUTE_NAME_ENCODING)); + final Charset charset = getCharset(atts); final Range range = getRange(hrefValue); final File codeFile = getFile(hrefValue); if (codeFile != null) { @@ -125,11 +125,12 @@ final class IncludeText { /** * Get code file charset. * - * @param format format attribute value, may be {@code null} - * @param encoding encoding attribute balue, may be {@code null} * @return charset if set, otherwise default charset */ - private Charset getCharset(final String format, final String encoding) { + + private Charset getCharset(Attributes atts) { + final String format = atts.getValue(ATTRIBUTE_NAME_FORMAT); + final String encoding = atts.getValue(ATTRIBUTE_NAME_ENCODING); Charset c = null; try { if (encoding != null) { @@ -141,7 +142,7 @@ final class IncludeText { } } } catch (final RuntimeException e) { - logger.error(MessageUtils.getMessage("DOTJ052E", encoding).toString()); + logger.error(MessageUtils.getMessage("DOTJ052E", encoding).setLocation(atts).toString()); } if (c == null) { final String defaultCharset = Configuration.configuration.get("default.coderef-charset");

['src/main/java/org/dita/dost/writer/ValidationFilter.java', 'src/main/java/org/dita/dost/reader/ConrefPushReader.java', 'src/main/java/org/dita/dost/writer/include/IncludeText.java', 'src/main/java/org/dita/dost/writer/ConkeyrefFilter.java', 'src/main/java/org/dita/dost/reader/KeydefFilter.java', 'src/main/java/org/dita/dost/reader/DitaValReader.java', 'src/main/java/org/dita/dost/reader/MergeMapParser.java', 'src/main/java/org/dita/dost/reader/CopyToReader.java']

{'.java': 8}

Java

{'Java': 2476766, 'XSLT': 2016428, 'HTML': 1407059, 'SCSS': 34437, 'CSS': 27432, 'Shell': 15542, 'Batchfile': 11111, 'C': 4336, 'JavaScript': 2246, 'Dockerfile': 1771}

Apache License 2.0

dita-ot/dita-ot/3893/3662

dita-ot

dita-ot

https://github.com/dita-ot/dita-ot/issues/3662

https://github.com/dita-ot/dita-ot/pull/3893

https://github.com/dita-ot/dita-ot/pull/3893

fixes

<xsl:message> (in plugin XSLT files) no longer shows element structure

## Expected Behavior When I add the following XSLT template via a DITA-OT plugin: ``` <xsl:template match="*" priority="1000"> <xsl:message>BEGIN--<xsl:copy-of select="."/>--END</xsl:message> <xsl:next-match/> </xsl:template> ``` I expect to see XML copies of the elements matched by that template. ## Actual Behavior In 3.5.4 and earlier releases, I see the XML structure: ``` [mapref] BEGIN--<keywords xmlns:dita-ot="http://dita-ot.sourceforge.net/ns/201007/dita-ot" xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" class="- topic/keywords " xtrc="keywords:1;7:17" xtrf="file:/home/chrispy/BUG/map.ditamap"> [mapref] <keyword class="- topic/keyword " xtrc="keyword:1;8:18" xtrf="file:/home/chrispy/BUG/map.ditamap">ProductA</keyword> [mapref] </keywords>--END [mapref] BEGIN--<keyword xmlns:dita-ot="http://dita-ot.sourceforge.net/ns/201007/dita-ot" xmlns:ditaarch="http://dita.oasis-open.org/architecture/2005/" class="- topic/keyword " xtrc="keyword:1;8:18" xtrf="file:/home/chrispy/BUG/map.ditamap">ProductA</keyword>--END ``` Starting with 3.6, I see only text node contents: ``` [mapref] BEGIN-- [mapref] ProductA [mapref] --END [mapref] BEGIN--ProductA--END [mapref] BEGIN----END ``` ## Steps to Reproduce 1. Unarchive the attached testcase. 2. Run the `do.sh` script (bash script, for linux environment) 3. In `do.out`, examine the `mapref` messages from 3.5.4 and 3.6. [BUG.zip](https://github.com/dita-ot/dita-ot/files/5757487/BUG.zip) ## Environment * DITA-OT version: 3.6 * Operating system and version: Windows 10, running Ubuntu 18.04 LTS via WSL * Ran via: `dita` command line * Transformation type: `dita`

dc1b631a2a4d4978617300ef582321fa90bfd9f7

1400618952ed28b91f5e70535c356eb1b61011a0

https://github.com/dita-ot/dita-ot/compare/dc1b631a2a4d4978617300ef582321fa90bfd9f7...1400618952ed28b91f5e70535c356eb1b61011a0

diff --git a/src/main/java/org/dita/dost/util/XMLUtils.java b/src/main/java/org/dita/dost/util/XMLUtils.java index 8cf929206..58e6f800e 100644 --- a/src/main/java/org/dita/dost/util/XMLUtils.java +++ b/src/main/java/org/dita/dost/util/XMLUtils.java @@ -11,7 +11,9 @@ import com.google.common.annotations.VisibleForTesting; import net.sf.saxon.expr.instruct.TerminationException; import net.sf.saxon.lib.*; import net.sf.saxon.s9api.*; +import net.sf.saxon.s9api.streams.Predicates; import net.sf.saxon.s9api.streams.Step; +import net.sf.saxon.s9api.streams.XdmStream; import org.apache.xml.resolver.tools.CatalogResolver; import org.dita.dost.exception.DITAOTException; import org.dita.dost.log.DITAOTLogger; @@ -31,6 +33,7 @@ import javax.xml.transform.stream.StreamSource; import java.io.*; import java.net.URI; import java.util.*; +import java.util.stream.Collectors; import java.util.stream.Stream; import static javax.xml.XMLConstants.DEFAULT_NS_PREFIX; @@ -154,7 +157,13 @@ public final class XMLUtils { .findAny() .map(XdmItem::getStringValue) .orElse("INFO"); - final String msg = content.getStringValue(); + final String msg = content + .select(descendant( + hasLocalName("level").or(hasLocalName("error-code")) + .and(hasType(ItemType.PROCESSING_INSTRUCTION_NODE)) + .negate())) + .map(n -> n.toString()) + .collect(Collectors.joining()); switch (level) { case "FATAL": final TerminationException err = new TerminationException(msg); diff --git a/src/test/java/org/dita/dost/util/XMLUtilsTest.java b/src/test/java/org/dita/dost/util/XMLUtilsTest.java index 1f1a5ec9d..a9d1687b3 100644 --- a/src/test/java/org/dita/dost/util/XMLUtilsTest.java +++ b/src/test/java/org/dita/dost/util/XMLUtilsTest.java @@ -8,8 +8,14 @@ package org.dita.dost.util; import net.sf.saxon.Configuration; +import net.sf.saxon.expr.instruct.TerminationException; import net.sf.saxon.lib.CollationURIResolver; import net.sf.saxon.om.StructuredQName; +import net.sf.saxon.s9api.MessageListener2; +import net.sf.saxon.s9api.SaxonApiException; +import net.sf.saxon.s9api.SaxonApiUncheckedException; +import net.sf.saxon.s9api.XdmNode; +import net.sf.saxon.sapling.Saplings; import net.sf.saxon.trans.SymbolicName; import org.dita.dost.TestUtils; import org.dita.dost.TestUtils.CachingLogger; @@ -27,18 +33,11 @@ import org.xml.sax.helpers.AttributesImpl; import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.parsers.ParserConfigurationException; -import javax.xml.transform.Transformer; -import javax.xml.transform.TransformerException; -import javax.xml.transform.TransformerFactory; -import javax.xml.transform.stream.StreamResult; -import javax.xml.transform.stream.StreamSource; -import java.io.ByteArrayOutputStream; import java.io.File; import java.io.IOException; -import java.io.StringReader; -import java.util.Arrays; import java.util.Deque; import java.util.LinkedList; +import java.util.List; import static javax.xml.XMLConstants.NULL_NS_URI; import static javax.xml.XMLConstants.XML_NS_URI; @@ -267,6 +266,105 @@ public class XMLUtilsTest { assertTrue(XMLUtils.nonDitaContext(classes)); } + @Test + public void toMessageListener() throws SaxonApiException { + final CachingLogger logger = new CachingLogger(); + final MessageListener2 listener = XMLUtils.toMessageListener(logger); + + final XdmNode msg = Saplings.doc().withChild( + Saplings.text("message "), + Saplings.elem("debug") + ) + .toXdmNode(new XMLUtils().getProcessor()); + + listener.message(msg, null, false, null); + + final List<Message> act = logger.getMessages(); + assertEquals(1, act.size()); + assertEquals(new Message(Message.Level.INFO, "message <debug/>", null), act.get(0)); + } + + @Test + public void toMessageListener_withLevelAndErrorCode() throws SaxonApiException { + final CachingLogger logger = new CachingLogger(); + final MessageListener2 listener = XMLUtils.toMessageListener(logger); + + final XdmNode msg = Saplings.doc().withChild( + Saplings.pi("error-code", "DOTX037W"), + Saplings.pi("level", "WARN"), + Saplings.text("message "), + Saplings.elem("debug") + ) + .toXdmNode(new XMLUtils().getProcessor()); + + listener.message(msg, null, false, null); + + final List<Message> act = logger.getMessages(); + assertEquals(1, act.size()); + assertEquals(new Message(Message.Level.WARN, "message <debug/>", null), act.get(0)); + } + + @Test + public void toMessageListener_withErrorCode() throws SaxonApiException { + final CachingLogger logger = new CachingLogger(); + final MessageListener2 listener = XMLUtils.toMessageListener(logger); + + final XdmNode msg = Saplings.doc().withChild( + Saplings.pi("error-code", "DOTX037W"), + Saplings.text("message "), + Saplings.elem("debug") + ) + .toXdmNode(new XMLUtils().getProcessor()); + + listener.message(msg, null, false, null); + + final List<Message> act = logger.getMessages(); + assertEquals(1, act.size()); + assertEquals(new Message(Message.Level.INFO, "message <debug/>", null), act.get(0)); + } + + @Test + public void toMessageListener_withFatalErrorCode() throws SaxonApiException { + final CachingLogger logger = new CachingLogger(); + final MessageListener2 listener = XMLUtils.toMessageListener(logger); + + final XdmNode msg = Saplings.doc().withChild( + Saplings.pi("error-code", "DOTX037W"), + Saplings.pi("level", "WARN"), + Saplings.text("message "), + Saplings.elem("debug") + ) + .toXdmNode(new XMLUtils().getProcessor()); + + try { + listener.message(msg, null, true, null); + fail(); + } catch (SaxonApiUncheckedException e) { + final TerminationException cause = (TerminationException) e.getCause(); + assertEquals("DOTX037W", cause.getErrorCodeLocalPart()); + assertEquals("message <debug/>", cause.getMessage()); + } + } + + @Test + public void toMessageListener_withLevel() throws SaxonApiException { + final CachingLogger logger = new CachingLogger(); + final MessageListener2 listener = XMLUtils.toMessageListener(logger); + + final XdmNode msg = Saplings.doc().withChild( + Saplings.pi("level", "ERROR"), + Saplings.text("message "), + Saplings.elem("debug") + ) + .toXdmNode(new XMLUtils().getProcessor()); + + listener.message(msg, null, false, null); + + final List<Message> act = logger.getMessages(); + assertEquals(1, act.size()); + assertEquals(new Message(Message.Level.ERROR, "message <debug/>", null), act.get(0)); + } + // @Test // public void transform() throws Exception { // copyFile(new File(srcDir, "test.dita"), new File(tempDir, "test.dita"));

['src/test/java/org/dita/dost/util/XMLUtilsTest.java', 'src/main/java/org/dita/dost/util/XMLUtils.java']

{'.java': 2}

Java

{'Java': 2476766, 'XSLT': 2016428, 'HTML': 1407059, 'SCSS': 34437, 'CSS': 27432, 'Shell': 15542, 'Batchfile': 11111, 'C': 4336, 'JavaScript': 2246, 'Dockerfile': 1771}

Apache License 2.0

dita-ot/dita-ot/3880/2844

dita-ot

dita-ot

https://github.com/dita-ot/dita-ot/issues/2844

https://github.com/dita-ot/dita-ot/pull/3880

https://github.com/dita-ot/dita-ot/issues/2844#issuecomment-1041136435

fixed

Error in HTML publishing if any topic has apostrophe in its name

Create a topic with apostrophe in its name e.g. i'm_topic.dita. Put it in ditamap and publish. PDF works fine but xhtml and html5 give NullPointerException.

1c488e86830c66f3d3787f29677ea56fcbee4379

41efb7e19ce5ec0707e63c0b8bf52d828823a77d

https://github.com/dita-ot/dita-ot/compare/1c488e86830c66f3d3787f29677ea56fcbee4379...41efb7e19ce5ec0707e63c0b8bf52d828823a77d

diff --git a/src/main/java/org/dita/dost/util/URLUtils.java b/src/main/java/org/dita/dost/util/URLUtils.java index 3915bb3ca..1e5e7e0a7 100644 --- a/src/main/java/org/dita/dost/util/URLUtils.java +++ b/src/main/java/org/dita/dost/util/URLUtils.java @@ -313,7 +313,10 @@ public final class URLUtils { //'%', '"', '{', '}', //'?', - '|', '\\\\', '^', '~', '[', ']', '`', '\\'', + '|', '\\\\', '^', + //'~', + '[', ']', '`', + //'\\'', //'&' }; char ch; diff --git a/src/test/java/org/dita/dost/util/URLUtilsTest.java b/src/test/java/org/dita/dost/util/URLUtilsTest.java index fa1b43f4d..b89e5d03f 100644 --- a/src/test/java/org/dita/dost/util/URLUtilsTest.java +++ b/src/test/java/org/dita/dost/util/URLUtilsTest.java @@ -140,6 +140,7 @@ public class URLUtilsTest { assertEquals(new URI("foo%20bar.txt"), URLUtils.toURI("foo bar.txt")); assertEquals(new URI("foo/bar.txt"), URLUtils.toURI("foo" + Constants.WINDOWS_SEPARATOR + "bar.txt")); assertEquals(new URI("foo%20bar.txt"), URLUtils.toURI(" foo bar.txt ")); + assertEquals(new URI("user's%20manual.txt"), URLUtils.toURI("user's manual.txt")); assertEquals(new URI("http://www.example.com/"), URLUtils.toURI(" http://www.example.com/ ")); }

['src/test/java/org/dita/dost/util/URLUtilsTest.java', 'src/main/java/org/dita/dost/util/URLUtils.java']

{'.java': 2}

Java

{'Java': 2476766, 'XSLT': 2016428, 'HTML': 1407059, 'SCSS': 34437, 'CSS': 27432, 'Shell': 15542, 'Batchfile': 11111, 'C': 4336, 'JavaScript': 2246, 'Dockerfile': 1771}

Apache License 2.0

dita-ot/dita-ot/3912/3730

dita-ot

dita-ot

https://github.com/dita-ot/dita-ot/issues/3730

https://github.com/dita-ot/dita-ot/pull/3912

https://github.com/dita-ot/dita-ot/pull/3912

fixes

ValidationFilter stage breaks with unexpected error for invalid URL

I have this link in a DITA topic: <xref href="http://www,oxygenxml.com" format="html" scope="external"/> notice there is a comma in the href attribute value instead of a dot. I publish to HTML5, the publishing breaks with: D:\\projects\\DITA-OT3.x\\plugins\\org.dita.base\\build_preprocess.xml:96: java.lang.RuntimeException: Expected scheme-specific part at index 5: http: at org.dita.dost.util.URLUtils.setFragment(URLUtils.java:559) at org.dita.dost.util.URLUtils.stripFragment(URLUtils.java:541) at org.dita.dost.writer.ValidationFilter.validateReference(ValidationFilter.java:199) at org.dita.dost.writer.ValidationFilter.startElement(ValidationFilter.java:96) at org.dita.dost.writer.ProfilingFilter.startElement(ProfilingFilter.java:121) at org.xml.sax.helpers.XMLFilterImpl.startElement(Unknown Source) at org.dita.dost.writer.DebugFilter.startElement(DebugFilter.java:78) at org.apache.xerces.parsers.AbstractSAXParser.startElement(Unknown Source) at org.apache.xerces.parsers.AbstractXMLDocumentParser.emptyElement(Unknown Source) The URL is not really invalid according to the URI standard, so you can create an URI over it: new URI("http://www,oxygenxml.com")

3ad51f08724488a53651b8d88ec0f619bc9b2568

e952f5e2bd892d3423c917d40f9979cd98283565

https://github.com/dita-ot/dita-ot/compare/3ad51f08724488a53651b8d88ec0f619bc9b2568...e952f5e2bd892d3423c917d40f9979cd98283565

diff --git a/src/main/java/org/dita/dost/util/URLUtils.java b/src/main/java/org/dita/dost/util/URLUtils.java index 94f40fd20..8eb0b87f0 100644 --- a/src/main/java/org/dita/dost/util/URLUtils.java +++ b/src/main/java/org/dita/dost/util/URLUtils.java @@ -572,7 +572,11 @@ public final class URLUtils { */ public static URI setQuery(final URI path, final String query) { try { - return new URI(path.getScheme(), path.getUserInfo(), path.getHost(), path.getPort(), path.getPath(), query, path.getFragment()); + if (path.getPath() != null) { + return new URI(path.getScheme(), path.getUserInfo(), path.getHost(), path.getPort(), path.getPath(), query, path.getFragment()); + } else { + return new URI(path.getScheme(), path.getSchemeSpecificPart(), path.getFragment()); + } } catch (final URISyntaxException e) { throw new RuntimeException(e.getMessage(), e); } diff --git a/src/main/java/org/dita/dost/writer/ValidationFilter.java b/src/main/java/org/dita/dost/writer/ValidationFilter.java index 585fbdc36..0c4cc91b8 100644 --- a/src/main/java/org/dita/dost/writer/ValidationFilter.java +++ b/src/main/java/org/dita/dost/writer/ValidationFilter.java @@ -197,9 +197,9 @@ public final class ValidationFilter extends AbstractXMLFilter { if (href != null) { try { final URI uri = new URI(href); - final URI abs = URLUtils.setQuery(URLUtils.stripFragment(currentFile.resolve(uri)).normalize(), null); - if (abs.getScheme() != null && abs.getScheme().equals("file")) { - final File p = new File(abs); + final URI abs = currentFile.resolve(uri).normalize(); + if (Objects.equals(abs.getScheme(), "file")) { + final File p = new File(URLUtils.setQuery(URLUtils.stripFragment(abs), null)); try { final File canFile = p.getCanonicalFile(); final String absPath = p.getAbsolutePath(); diff --git a/src/test/java/org/dita/dost/util/URLUtilsTest.java b/src/test/java/org/dita/dost/util/URLUtilsTest.java index f82d36fdf..a24d71cb9 100644 --- a/src/test/java/org/dita/dost/util/URLUtilsTest.java +++ b/src/test/java/org/dita/dost/util/URLUtilsTest.java @@ -188,6 +188,11 @@ public class URLUtilsTest { assertEquals(new URI("urn:foo:bar"), URLUtils.setFragment(new URI("urn:foo:bar"), null)); } + @Test + public void setFragment_mailto() { + assertEquals(URI.create("mailto:email@example.com?subject=Email"), URLUtils.setFragment(URI.create("mailto:email@example.com?subject=Email"), null)); + } + @Test public void testRemoveFragment() throws URISyntaxException { assertEquals(new URI("foo"), URLUtils.removeFragment(new URI("foo#bar"))); @@ -291,4 +296,9 @@ public class URLUtilsTest { assertEquals(URI.create("foo"), URLUtils.setQuery(URI.create("foo?bar"), null)); assertEquals(URI.create("foo?baz"), URLUtils.setQuery(URI.create("foo?bar"), "baz")); } + + @Test + public void setQuery_mailto() { + assertEquals(URI.create("mailto:email@example.com?subject=Email"), URLUtils.setQuery(URI.create("mailto:email@example.com?subject=Email"), null)); + } }

['src/main/java/org/dita/dost/writer/ValidationFilter.java', 'src/test/java/org/dita/dost/util/URLUtilsTest.java', 'src/main/java/org/dita/dost/util/URLUtils.java']

{'.java': 3}

Java

{'Java': 2476766, 'XSLT': 2016428, 'HTML': 1407059, 'SCSS': 34437, 'CSS': 27432, 'Shell': 15542, 'Batchfile': 11111, 'C': 4336, 'JavaScript': 2246, 'Dockerfile': 1771}

Apache License 2.0

dita-ot/dita-ot/4257/4064

dita-ot

dita-ot

https://github.com/dita-ot/dita-ot/issues/4064

https://github.com/dita-ot/dita-ot/pull/4257

https://github.com/dita-ot/dita-ot/pull/4257

fixes

Chunk to content on DITA Map fails when the DITA Map has spaces in file name

I have a DITA Map with spaces in its file name "flowers by season_map.ditamap" which has chunk=to-content set on the root element. Publishing it to HTML5 fails with: /.../plugins/org.dita.base/build_preprocess.xml:260: java.lang.IllegalArgumentException: Illegal character in path at index 7: flowers by season_map.dita at java.base/java.net.URI.create(URI.java:906) at java.base/java.net.URI.resolve(URI.java:1089) at org.dita.dost.reader.ChunkMapReader.chunkMap(ChunkMapReader.java:209) at org.dita.dost.reader.ChunkMapReader.process(ChunkMapReader.java:136) at org.dita.dost.writer.AbstractDomFilter.read(AbstractDomFilter.java:41) [flowers22.zip](https://github.com/dita-ot/dita-ot/files/10089903/flowers22.zip)

4485c1d50d4c1a966f4fe691af6c0fd4c65c3acc

bdee5383a62675b2a37283b3d6a4d3f42fa17e44

https://github.com/dita-ot/dita-ot/compare/4485c1d50d4c1a966f4fe691af6c0fd4c65c3acc...bdee5383a62675b2a37283b3d6a4d3f42fa17e44

diff --git a/src/main/java/org/dita/dost/reader/ChunkMapReader.java b/src/main/java/org/dita/dost/reader/ChunkMapReader.java index c28621c16..584e596e2 100644 --- a/src/main/java/org/dita/dost/reader/ChunkMapReader.java +++ b/src/main/java/org/dita/dost/reader/ChunkMapReader.java @@ -35,6 +35,7 @@ import org.dita.dost.module.reader.TempFileNameScheme; import org.dita.dost.util.DitaClass; import org.dita.dost.util.Job; import org.dita.dost.util.Job.FileInfo; +import org.dita.dost.util.URLUtils; import org.dita.dost.util.XMLSerializer; import org.dita.dost.writer.AbstractDomFilter; import org.dita.dost.writer.ChunkTopicParser; @@ -208,11 +209,11 @@ public final class ChunkMapReader extends AbstractDomFilter { */ private void chunkMap(final Element root) { // create the reference to the new file on root element. - String newFilename = replaceExtension(new File(currentFile).getName(), FILE_EXTENSION_DITA); + URI newFilename = URLUtils.toURI(replaceExtension(new File(currentFile).getName(), FILE_EXTENSION_DITA)); URI newFile = currentFile.resolve(newFilename); if (job.getStore().exists(newFile)) { final URI oldFile = newFile; - newFilename = chunkFilenameGenerator.generateFilename(CHUNK_PREFIX, FILE_EXTENSION_DITA); + newFilename = URLUtils.toURI(chunkFilenameGenerator.generateFilename(CHUNK_PREFIX, FILE_EXTENSION_DITA)); newFile = currentFile.resolve(newFilename); // Mark up the possible name changing, in case that references might be updated. conflictTable.put(newFile, oldFile.normalize()); @@ -222,7 +223,7 @@ public final class ChunkMapReader extends AbstractDomFilter { // change the class attribute to "topicref" final String origCls = root.getAttribute(ATTRIBUTE_NAME_CLASS); root.setAttribute(ATTRIBUTE_NAME_CLASS, origCls + MAP_TOPICREF.matcher); - root.setAttribute(ATTRIBUTE_NAME_HREF, toURI(newFilename).toString()); + root.setAttribute(ATTRIBUTE_NAME_HREF, newFilename.toString()); createTopicStump(newFile);

['src/main/java/org/dita/dost/reader/ChunkMapReader.java']

{'.java': 1}

Java

{'Java': 2476766, 'XSLT': 2016428, 'HTML': 1407059, 'SCSS': 34437, 'CSS': 27432, 'Shell': 15542, 'Batchfile': 11111, 'C': 4336, 'JavaScript': 2246, 'Dockerfile': 1771}

Apache License 2.0

dita-ot/dita-ot/4248/4240

dita-ot

dita-ot

https://github.com/dita-ot/dita-ot/issues/4240

https://github.com/dita-ot/dita-ot/pull/4248

https://github.com/dita-ot/dita-ot/pull/4248

fixes

DITAOTXMLErrorHandler no longer shows line/column number for error messages

On the callback method "org.dita.dost.exception.DITAOTXMLErrorHandler.error(SAXParseException)" if the processing is not strict, line column information is no longer logged in the console. So for example if there are validator errors in the XML document, their message is shown in the console but not their system id, line and column information. I suggest we replace: public void error(final SAXParseException saxException) throws SAXException { if (mode == Configuration.Mode.STRICT) { throw new SAXExceptionWrapper(filePath, saxException); } else { logger.error(new SAXExceptionWrapper(filePath, saxException).getMessage(), saxException); } } with: public void error(final SAXParseException saxException) throws SAXException { SAXExceptionWrapper ex = new SAXExceptionWrapper(filePath, saxException); if (mode == Configuration.Mode.STRICT) { throw ex; } else { logger.error(ex.getMessage(), saxException); } }

7ab347e8862da8c6ede87966b236739386b372e7

80639433c6e78650ef27fe35951f07d5f3b40b8b

https://github.com/dita-ot/dita-ot/compare/7ab347e8862da8c6ede87966b236739386b372e7...80639433c6e78650ef27fe35951f07d5f3b40b8b

diff --git a/src/main/java/org/dita/dost/exception/DITAOTXMLErrorHandler.java b/src/main/java/org/dita/dost/exception/DITAOTXMLErrorHandler.java index 09bc39c7b..e913b2d30 100644 --- a/src/main/java/org/dita/dost/exception/DITAOTXMLErrorHandler.java +++ b/src/main/java/org/dita/dost/exception/DITAOTXMLErrorHandler.java @@ -45,10 +45,11 @@ public final class DITAOTXMLErrorHandler implements ErrorHandler { */ @Override public void error(final SAXParseException saxException) throws SAXException { + final SAXExceptionWrapper ex = new SAXExceptionWrapper(filePath, saxException); if (mode == Configuration.Mode.STRICT) { - throw new SAXExceptionWrapper(filePath, saxException); + throw ex; } else { - logger.error(saxException.getMessage(), saxException); + logger.error(ex.getMessage(), ex); } }

['src/main/java/org/dita/dost/exception/DITAOTXMLErrorHandler.java']

{'.java': 1}

Java

{'Java': 2476766, 'XSLT': 2016428, 'HTML': 1407059, 'SCSS': 34437, 'CSS': 27432, 'Shell': 15542, 'Batchfile': 11111, 'C': 4336, 'JavaScript': 2246, 'Dockerfile': 1771}

Apache License 2.0

dita-ot/dita-ot/4255/3718

dita-ot

dita-ot

https://github.com/dita-ot/dita-ot/issues/3718

https://github.com/dita-ot/dita-ot/pull/4255

https://github.com/dita-ot/dita-ot/pull/4255

fixes

PDF2 build breakes due to an invalid xref's URI

Not sure if this is to be treated as a bug, an improvment or not at all, but in dita-3.3.3 one could generate a pdf2 document which contained an xref with an invalid URI, e.g. `<xref format="pdf" href="file://ccm/temp/diff.pdf" scope="external">file</xref>` The URI misses a 3 slash so that the authority component would be empty, instead it is //ccm/ which was not intended. It should have beed file:///ccm/temp/diff.pdf. However, dita-3.6.1. aborts the build with an exception: ``` BUILD FAILED C:\\bin\\dita-ot-3.6.1\\plugins\\org.dita.base\\build.xml:29: The following error occurred while executing this line: C:\\bin\\dita-ot-3.6.1\\plugins\\org.dita.base\\build_preprocess2.xml:171: java.lang.IllegalArgumentException: URI has an authority component at java.io.File.<init>(File.java:423) at org.dita.dost.writer.ValidationFilter.validateReference(ValidationFilter.java:201) at org.dita.dost.writer.ValidationFilter.startElement(ValidationFilter.java:96) at org.dita.dost.writer.ProfilingFilter.startElement(ProfilingFilter.java:121) at org.apache.xerces.parsers.AbstractSAXParser.startElement(Unknown Source) ``` ## Expected Behavior Depending on the processing-mode, e.g. lax, a PDF2 document is generated ## Actual Behavior Build aborts with an exception ## Steps to Reproduce Build the attached document ## Copy of the error message, log file or stack trace ``` BUILD FAILED C:\\bin\\dita-ot-3.6.1\\plugins\\org.dita.base\\build.xml:29: The following error occurred while executing this line: C:\\bin\\dita-ot-3.6.1\\plugins\\org.dita.base\\build_preprocess2.xml:171: java.lang.IllegalArgumentException: URI has an authority component at java.io.File.<init>(File.java:423) at org.dita.dost.writer.ValidationFilter.validateReference(ValidationFilter.java:201) at org.dita.dost.writer.ValidationFilter.startElement(ValidationFilter.java:96) at org.dita.dost.writer.ProfilingFilter.startElement(ProfilingFilter.java:121) at org.apache.xerces.parsers.AbstractSAXParser.startElement(Unknown Source) ``` ## Environment <!-- Include relevant details about the environment you experienced this in. --> * DITA-OT version: 3.6.1 * Operating system and version: Windows * How did you run DITA-OT? ant-launcher * Transformation type: PDF [authoring.zip](https://github.com/dita-ot/dita-ot/files/6181752/authoring.zip)

5edd854d18d15c90678e6ceff4de1013b2ada62d

ad030478c946bb1a15e5f93a8c7c13971e0c6fd5

https://github.com/dita-ot/dita-ot/compare/5edd854d18d15c90678e6ceff4de1013b2ada62d...ad030478c946bb1a15e5f93a8c7c13971e0c6fd5

diff --git a/src/main/java/org/dita/dost/writer/ValidationFilter.java b/src/main/java/org/dita/dost/writer/ValidationFilter.java index 371066c37..e887303e7 100644 --- a/src/main/java/org/dita/dost/writer/ValidationFilter.java +++ b/src/main/java/org/dita/dost/writer/ValidationFilter.java @@ -198,7 +198,7 @@ public final class ValidationFilter extends AbstractXMLFilter { try { final URI uri = new URI(href); final URI abs = currentFile.resolve(uri).normalize(); - if (Objects.equals(abs.getScheme(), "file")) { + if (Objects.equals(abs.getScheme(), "file") && (abs.getAuthority() == null || abs.getAuthority().isEmpty())) { final File p = new File(URLUtils.setQuery(URLUtils.stripFragment(abs), null)); try { final File canFile = p.getCanonicalFile(); diff --git a/src/test/java/org/dita/dost/writer/ValidationFilterTest.java b/src/test/java/org/dita/dost/writer/ValidationFilterTest.java index c279e853a..c16837233 100644 --- a/src/test/java/org/dita/dost/writer/ValidationFilterTest.java +++ b/src/test/java/org/dita/dost/writer/ValidationFilterTest.java @@ -63,7 +63,7 @@ public class ValidationFilterTest { } @Test - public void testHref() throws SAXException, URISyntaxException { + public void testHref() throws SAXException { final List<String> res = new ArrayList<>(); f.setContentHandler( new DefaultHandler() { @@ -103,7 +103,35 @@ public class ValidationFilterTest { } @Test - public void testConref() throws SAXException, URISyntaxException { + public void testHref_networkFile() throws SAXException { + final List<String> res = new ArrayList<>(); + f.setContentHandler( + new DefaultHandler() { + @Override + public void startElement(final String uri, final String localName, final String qName, final Attributes atts) { + res.add(atts.getValue(ATTRIBUTE_NAME_HREF)); + } + } + ); + final TestUtils.CachingLogger l = new TestUtils.CachingLogger(); + f.setLogger(l); + + f.startElement( + NULL_NS_URI, + TOPIC_XREF.localName, + TOPIC_XREF.localName, + new AttributesBuilder() + .add(ATTRIBUTE_NAME_HREF, "file://example.com/foo") + .add(ATTRIBUTE_NAME_SCOPE, ATTR_SCOPE_VALUE_EXTERNAL) + .build() + ); + + assertTrue(l.getMessages().isEmpty()); + assertEquals("file://example.com/foo", res.get(0)); + } + + @Test + public void testConref() throws SAXException { final List<String> res = new ArrayList<>(); f.setContentHandler( new DefaultHandler() { @@ -137,7 +165,7 @@ public class ValidationFilterTest { } @Test - public void testScope() throws SAXException, URISyntaxException { + public void testScope() throws SAXException { final List<String> res = new ArrayList<>(); f.setContentHandler( new DefaultHandler() { @@ -173,7 +201,7 @@ public class ValidationFilterTest { } @Test - public void testId() throws SAXException, URISyntaxException { + public void testId() throws SAXException { f.setContentHandler(new DefaultHandler()); final TestUtils.CachingLogger l = new TestUtils.CachingLogger(); f.setLogger(l); @@ -221,7 +249,7 @@ public class ValidationFilterTest { } @Test - public void testKeys() throws SAXException, URISyntaxException { + public void testKeys() throws SAXException { f.setContentHandler(new DefaultHandler()); final TestUtils.CachingLogger l = new TestUtils.CachingLogger(); f.setLogger(l); @@ -268,7 +296,7 @@ public class ValidationFilterTest { } @Test - public void testKeyscope() throws SAXException, URISyntaxException { + public void testKeyscope() throws SAXException { f.setContentHandler(new DefaultHandler()); final TestUtils.CachingLogger l = new TestUtils.CachingLogger(); f.setLogger(l);

['src/main/java/org/dita/dost/writer/ValidationFilter.java', 'src/test/java/org/dita/dost/writer/ValidationFilterTest.java']

{'.java': 2}

Java

{'Java': 2476766, 'XSLT': 2016428, 'HTML': 1407059, 'SCSS': 34437, 'CSS': 27432, 'Shell': 15542, 'Batchfile': 11111, 'C': 4336, 'JavaScript': 2246, 'Dockerfile': 1771}

Apache License 2.0

wikidata/wikidata-toolkit/241/240

wikidata

wikidata-toolkit

https://github.com/Wikidata/Wikidata-Toolkit/issues/240

https://github.com/Wikidata/Wikidata-Toolkit/pull/241

https://github.com/Wikidata/Wikidata-Toolkit/pull/241

closes

Deserialization failure on dumps with redirects

The Wikidata daily XML dumps contains serialization for redirects. Wikidata Toolkit 0.7 fails when deserializing them: ``` java GRAVE: Failed to map JSON for item Q26790101: Unexpected token (END_OBJECT), expected FIELD_NAME: missing property 'type' that is to contain type id (for class org.wikidata.wdtk.datamodel.json.jackson.JacksonItemDocument) at [Source: {"entity":"Q26790101","redirect":"Q21863925"}; line: 1, column: 45] com.fasterxml.jackson.databind.JsonMappingException: Unexpected token (END_OBJECT), expected FIELD_NAME: missing property 'type' that is to contain type id (for class org.wikidata.wdtk.datamodel.json.jackson.JacksonItemDocument) at [Source: {"entity":"Q26790101","redirect":"Q21863925"}; line: 1, column: 45] at com.fasterxml.jackson.databind.JsonMappingException.from(JsonMappingException.java:148) at com.fasterxml.jackson.databind.DeserializationContext.wrongTokenException(DeserializationContext.java:927) at com.fasterxml.jackson.databind.jsontype.impl.AsPropertyTypeDeserializer._deserializeTypedUsingDefaultImpl(AsPropertyTypeDeserializer.java:151) at com.fasterxml.jackson.databind.jsontype.impl.AsPropertyTypeDeserializer.deserializeTypedFromObject(AsPropertyTypeDeserializer.java:103) at com.fasterxml.jackson.databind.deser.BeanDeserializerBase.deserializeWithType(BeanDeserializerBase.java:966) at com.fasterxml.jackson.databind.deser.impl.TypeWrappedDeserializer.deserialize(TypeWrappedDeserializer.java:42) at com.fasterxml.jackson.databind.ObjectReader._bindAndClose(ObjectReader.java:1443) at com.fasterxml.jackson.databind.ObjectReader.readValue(ObjectReader.java:1081) at org.wikidata.wdtk.dumpfiles.WikibaseRevisionProcessor.readValue(WikibaseRevisionProcessor.java:160) at org.wikidata.wdtk.dumpfiles.WikibaseRevisionProcessor.processItemRevision(WikibaseRevisionProcessor.java:97) at org.wikidata.wdtk.dumpfiles.WikibaseRevisionProcessor.processRevision(WikibaseRevisionProcessor.java:88) at org.wikidata.wdtk.dumpfiles.MwRevisionProcessorBroker.notifyMwRevisionProcessors(MwRevisionProcessorBroker.java:183) at org.wikidata.wdtk.dumpfiles.MwRevisionProcessorBroker.processRevision(MwRevisionProcessorBroker.java:147) at org.wikidata.wdtk.dumpfiles.MwRevisionDumpFileProcessor.processXmlRevision(MwRevisionDumpFileProcessor.java:427) at org.wikidata.wdtk.dumpfiles.MwRevisionDumpFileProcessor.processXmlPage(MwRevisionDumpFileProcessor.java:345) at org.wikidata.wdtk.dumpfiles.MwRevisionDumpFileProcessor.tryProcessXmlPage(MwRevisionDumpFileProcessor.java:282) at org.wikidata.wdtk.dumpfiles.MwRevisionDumpFileProcessor.processXmlMediawiki(MwRevisionDumpFileProcessor.java:202) at org.wikidata.wdtk.dumpfiles.MwRevisionDumpFileProcessor.processDumpFileContents(MwRevisionDumpFileProcessor.java:155) at org.wikidata.wdtk.dumpfiles.DumpProcessingController.processDumpFile(DumpProcessingController.java:546) at org.wikidata.wdtk.dumpfiles.DumpProcessingController.processAllRecentRevisionDumps(DumpProcessingController.java:389) ```

297160438fecb86e7b86ae05cee3c46eae44797d

8ad18ae7759374b0658a1427b80ab1964a97f833

https://github.com/wikidata/wikidata-toolkit/compare/297160438fecb86e7b86ae05cee3c46eae44797d...8ad18ae7759374b0658a1427b80ab1964a97f833

diff --git a/wdtk-dumpfiles/src/main/java/org/wikidata/wdtk/dumpfiles/WikibaseRevisionProcessor.java b/wdtk-dumpfiles/src/main/java/org/wikidata/wdtk/dumpfiles/WikibaseRevisionProcessor.java index e8d77387..a9c79d3d 100644 --- a/wdtk-dumpfiles/src/main/java/org/wikidata/wdtk/dumpfiles/WikibaseRevisionProcessor.java +++ b/wdtk-dumpfiles/src/main/java/org/wikidata/wdtk/dumpfiles/WikibaseRevisionProcessor.java @@ -22,6 +22,7 @@ package org.wikidata.wdtk.dumpfiles; import java.io.IOException; import java.util.Map; +import java.util.regex.Pattern; import com.fasterxml.jackson.databind.DeserializationFeature; import org.slf4j.Logger; @@ -93,6 +94,10 @@ public class WikibaseRevisionProcessor implements MwRevisionProcessor { } public void processItemRevision(MwRevision mwRevision) { + if(isWikibaseRedirection(mwRevision)) { + return; + } + try { JacksonItemDocument document = readValue(mwRevision.getText(), JacksonItemDocument.class); document.setSiteIri(this.siteIri); @@ -123,6 +128,10 @@ public class WikibaseRevisionProcessor implements MwRevisionProcessor { } public void processPropertyRevision(MwRevision mwRevision) { + if(isWikibaseRedirection(mwRevision)) { + return; + } + try { JacksonPropertyDocument document = readValue(mwRevision.getText(), JacksonPropertyDocument.class); document.setSiteIri(this.siteIri); @@ -154,6 +163,10 @@ public class WikibaseRevisionProcessor implements MwRevisionProcessor { } + private boolean isWikibaseRedirection(MwRevision mwRevision) { + return mwRevision.getText().contains("\\"redirect\\":"); //Hacky but fast + } + public <T> T readValue(String content, Class<T> valueType) throws IOException { return mapper.reader(valueType) .with(DeserializationFeature.ACCEPT_EMPTY_ARRAY_AS_NULL_OBJECT)

['wdtk-dumpfiles/src/main/java/org/wikidata/wdtk/dumpfiles/WikibaseRevisionProcessor.java']

{'.java': 1}

Java

{'Java': 2468830, 'HTML': 40410}

Apache License 2.0

wikidata/wikidata-toolkit/418/417

wikidata

wikidata-toolkit

https://github.com/Wikidata/Wikidata-Toolkit/issues/417

https://github.com/Wikidata/Wikidata-Toolkit/pull/418

https://github.com/Wikidata/Wikidata-Toolkit/pull/418

closes

Regression: serialization of Statements

We have a problem with Statement serialization: statement values should only be serialized as part of the mainsnak, but they are also serialized at the Statement root: Our tests currently specify this serialization: ```json { "rank": "preferred", "value": { "value": { "id": "Q42", "numeric-id": 42, "entity-type": "item" }, "type": "wikibase-entityid" }, "id": "MyId", "mainsnak": { "property": "P42", "datatype": "wikibase-item", "datavalue": { "value": { "id": "Q42", "numeric-id": 42, "entity-type": "item" }, "type": "wikibase-entityid" }, "snaktype": "value" }, "type": "statement" } ``` The correct serialization should be: ```json { "rank": "preferred", "id": "MyId", "mainsnak": { "property": "P42", "datatype": "wikibase-item", "datavalue": { "value": { "id": "Q42", "numeric-id": 42, "entity-type": "item" }, "type": "wikibase-entityid" }, "snaktype": "value" }, "type": "statement" } ``` This was introduced by the addition of Claim methods to the Statement class, #330, where a `@JsonIgnore` was forgotten. The faulty test was introduced in 5d34b3a0c.

45b58c9841c601db9fb217f0f9a1c18d1c764518

856c4fbb7056b649fe6efd08bddb7b21ba194b1a

https://github.com/wikidata/wikidata-toolkit/compare/45b58c9841c601db9fb217f0f9a1c18d1c764518...856c4fbb7056b649fe6efd08bddb7b21ba194b1a

diff --git a/wdtk-datamodel/src/main/java/org/wikidata/wdtk/datamodel/implementation/StatementImpl.java b/wdtk-datamodel/src/main/java/org/wikidata/wdtk/datamodel/implementation/StatementImpl.java index fef0bfcc..fbb9c267 100644 --- a/wdtk-datamodel/src/main/java/org/wikidata/wdtk/datamodel/implementation/StatementImpl.java +++ b/wdtk-datamodel/src/main/java/org/wikidata/wdtk/datamodel/implementation/StatementImpl.java @@ -222,6 +222,7 @@ public class StatementImpl implements Statement { } @Override + @JsonProperty("references") public List<Reference> getReferences() { return references; } @@ -233,6 +234,7 @@ public class StatementImpl implements Statement { } @Override + @JsonIgnore public Value getValue() { return mainSnak.getValue(); } diff --git a/wdtk-datamodel/src/test/java/org/wikidata/wdtk/datamodel/implementation/StatementImplTest.java b/wdtk-datamodel/src/test/java/org/wikidata/wdtk/datamodel/implementation/StatementImplTest.java index 3777c680..bd2350f4 100644 --- a/wdtk-datamodel/src/test/java/org/wikidata/wdtk/datamodel/implementation/StatementImplTest.java +++ b/wdtk-datamodel/src/test/java/org/wikidata/wdtk/datamodel/implementation/StatementImplTest.java @@ -48,11 +48,11 @@ public class StatementImplTest { qualifiers, references, subjet); private final Statement s2 = new StatementImpl("MyId", StatementRank.PREFERRED, mainSnak, qualifiers, references, subjet); - private final String JSON_STATEMENT = "{\\"rank\\":\\"preferred\\",\\"references\\":[{\\"snaks\\":{\\"P42\\":[{\\"property\\":\\"P42\\",\\"datatype\\":\\"wikibase-item\\",\\"datavalue\\":{\\"value\\":{\\"id\\":\\"Q42\\",\\"numeric-id\\":42,\\"entity-type\\":\\"item\\"},\\"type\\":\\"wikibase-entityid\\"},\\"snaktype\\":\\"value\\"}]},\\"snaks-order\\":[\\"P42\\"]}],\\"value\\":{\\"value\\":{\\"id\\":\\"Q42\\",\\"numeric-id\\":42,\\"entity-type\\":\\"item\\"},\\"type\\":\\"wikibase-entityid\\"},\\"id\\":\\"MyId\\",\\"mainsnak\\":{\\"property\\":\\"P42\\",\\"datatype\\":\\"wikibase-item\\",\\"datavalue\\":{\\"value\\":{\\"id\\":\\"Q42\\",\\"numeric-id\\":42,\\"entity-type\\":\\"item\\"},\\"type\\":\\"wikibase-entityid\\"},\\"snaktype\\":\\"value\\"},\\"qualifiers-order\\":[\\"P42\\"],\\"type\\":\\"statement\\",\\"qualifiers\\":{\\"P42\\":[{\\"property\\":\\"P42\\",\\"datatype\\":\\"wikibase-item\\",\\"datavalue\\":{\\"value\\":{\\"id\\":\\"Q42\\",\\"numeric-id\\":42,\\"entity-type\\":\\"item\\"},\\"type\\":\\"wikibase-entityid\\"},\\"snaktype\\":\\"value\\"}]}}"; + private final String JSON_STATEMENT = "{\\"rank\\":\\"preferred\\",\\"references\\":[{\\"snaks\\":{\\"P42\\":[{\\"property\\":\\"P42\\",\\"datatype\\":\\"wikibase-item\\",\\"datavalue\\":{\\"value\\":{\\"id\\":\\"Q42\\",\\"numeric-id\\":42,\\"entity-type\\":\\"item\\"},\\"type\\":\\"wikibase-entityid\\"},\\"snaktype\\":\\"value\\"}]},\\"snaks-order\\":[\\"P42\\"]}],\\"id\\":\\"MyId\\",\\"mainsnak\\":{\\"property\\":\\"P42\\",\\"datatype\\":\\"wikibase-item\\",\\"datavalue\\":{\\"value\\":{\\"id\\":\\"Q42\\",\\"numeric-id\\":42,\\"entity-type\\":\\"item\\"},\\"type\\":\\"wikibase-entityid\\"},\\"snaktype\\":\\"value\\"},\\"qualifiers-order\\":[\\"P42\\"],\\"type\\":\\"statement\\",\\"qualifiers\\":{\\"P42\\":[{\\"property\\":\\"P42\\",\\"datatype\\":\\"wikibase-item\\",\\"datavalue\\":{\\"value\\":{\\"id\\":\\"Q42\\",\\"numeric-id\\":42,\\"entity-type\\":\\"item\\"},\\"type\\":\\"wikibase-entityid\\"},\\"snaktype\\":\\"value\\"}]}}"; private final Statement smallStatement = new StatementImpl("MyId", StatementRank.PREFERRED, mainSnak, Collections.emptyList(), Collections.emptyList(), subjet); - private final String JSON_SMALL_STATEMENT = "{\\"rank\\":\\"preferred\\",\\"value\\":{\\"value\\":{\\"id\\":\\"Q42\\",\\"numeric-id\\":42,\\"entity-type\\":\\"item\\"},\\"type\\":\\"wikibase-entityid\\"},\\"id\\":\\"MyId\\",\\"mainsnak\\":{\\"property\\":\\"P42\\",\\"datatype\\":\\"wikibase-item\\",\\"datavalue\\":{\\"value\\":{\\"id\\":\\"Q42\\",\\"numeric-id\\":42,\\"entity-type\\":\\"item\\"},\\"type\\":\\"wikibase-entityid\\"},\\"snaktype\\":\\"value\\"},\\"type\\":\\"statement\\"}"; + private final String JSON_SMALL_STATEMENT = "{\\"rank\\":\\"preferred\\",\\"id\\":\\"MyId\\",\\"mainsnak\\":{\\"property\\":\\"P42\\",\\"datatype\\":\\"wikibase-item\\",\\"datavalue\\":{\\"value\\":{\\"id\\":\\"Q42\\",\\"numeric-id\\":42,\\"entity-type\\":\\"item\\"},\\"type\\":\\"wikibase-entityid\\"},\\"snaktype\\":\\"value\\"},\\"type\\":\\"statement\\"}"; @Test public void gettersWorking() {

['wdtk-datamodel/src/test/java/org/wikidata/wdtk/datamodel/implementation/StatementImplTest.java', 'wdtk-datamodel/src/main/java/org/wikidata/wdtk/datamodel/implementation/StatementImpl.java']

{'.java': 2}

Java

{'Java': 2468830, 'HTML': 40410}

Apache License 2.0

wikidata/wikidata-toolkit/102/101

wikidata

wikidata-toolkit

https://github.com/Wikidata/Wikidata-Toolkit/issues/101

https://github.com/Wikidata/Wikidata-Toolkit/pull/102

https://github.com/Wikidata/Wikidata-Toolkit/pull/102

fixes

EntityDocumentProcessors called twice when using JSON dumps

Entity processors can be registered for specific content models. However, since JSON dumps do not provide content models, they just call all registered entity document processors on each document. The broker component that manages this does not check for duplicates, and as a result, a processor that is registered individually for item and property content will be called twice. This is a critical bug that causes unnecessary work and leads to inflated outputs, in particular in the RDF dumps. As a workaround, users should register their processors for one content model only (or simply for null) when using the JSON dumps.

ca795bae5af21856ab15574e74a1a0db2165bb0d

49ad771f5014e77e5835f5b9b6d4fd8116306395

https://github.com/wikidata/wikidata-toolkit/compare/ca795bae5af21856ab15574e74a1a0db2165bb0d...49ad771f5014e77e5835f5b9b6d4fd8116306395

diff --git a/wdtk-datamodel/src/main/java/org/wikidata/wdtk/datamodel/interfaces/EntityDocumentProcessorBroker.java b/wdtk-datamodel/src/main/java/org/wikidata/wdtk/datamodel/interfaces/EntityDocumentProcessorBroker.java index 9afdff19..3522b65f 100644 --- a/wdtk-datamodel/src/main/java/org/wikidata/wdtk/datamodel/interfaces/EntityDocumentProcessorBroker.java +++ b/wdtk-datamodel/src/main/java/org/wikidata/wdtk/datamodel/interfaces/EntityDocumentProcessorBroker.java @@ -9,9 +9,9 @@ package org.wikidata.wdtk.datamodel.interfaces; * Licensed 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. @@ -21,6 +21,7 @@ package org.wikidata.wdtk.datamodel.interfaces; */ import java.util.ArrayList; +import java.util.HashSet; import java.util.List; /** @@ -33,17 +34,23 @@ import java.util.List; public class EntityDocumentProcessorBroker implements EntityDocumentProcessor { final List<EntityDocumentProcessor> entityDocumentProcessors = new ArrayList<EntityDocumentProcessor>(); + final HashSet<EntityDocumentProcessor> entityDocumentProcessorRegistry = new HashSet<>(); /** * Registers a listener which will be called for all entity documents that - * are processed. + * are processed. The method avoids duplicates in the sense that the exact + * same object cannot be registered twice. * * @param entityDocumentProcessor * the listener to register */ public void registerEntityDocumentProcessor( EntityDocumentProcessor entityDocumentProcessor) { - this.entityDocumentProcessors.add(entityDocumentProcessor); + if (!this.entityDocumentProcessorRegistry + .contains(entityDocumentProcessor)) { + this.entityDocumentProcessors.add(entityDocumentProcessor); + this.entityDocumentProcessorRegistry.add(entityDocumentProcessor); + } } @Override diff --git a/wdtk-dumpfiles/src/main/java/org/wikidata/wdtk/dumpfiles/DumpProcessingController.java b/wdtk-dumpfiles/src/main/java/org/wikidata/wdtk/dumpfiles/DumpProcessingController.java index 19072f0e..0a4545a7 100644 --- a/wdtk-dumpfiles/src/main/java/org/wikidata/wdtk/dumpfiles/DumpProcessingController.java +++ b/wdtk-dumpfiles/src/main/java/org/wikidata/wdtk/dumpfiles/DumpProcessingController.java @@ -9,9 +9,9 @@ package org.wikidata.wdtk.dumpfiles; * Licensed 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. @@ -153,7 +153,7 @@ public class DumpProcessingController { /** * Broker object to distribute entity documents to several listeners. This * will be the main object that distributes revisions on any document-based - * processing run. + * processing run (in particular for JSON dumps). */ EntityDocumentProcessorBroker entityDocumentProcessorBroker = new EntityDocumentProcessorBroker(); @@ -238,8 +238,11 @@ public class DumpProcessingController { * Registers an MwRevisionProcessor, which will henceforth be notified of * all revisions that are encountered in the dump. * <p> + * This only is used when processing dumps that contain revisions. In + * particular, plain JSON dumps contain no revision information. + * <p> * Importantly, the {@link MwRevision} that the registered processors will - * receive is is valid only during the execution of + * receive is valid only during the execution of * {@link MwRevisionProcessor#processRevision(MwRevision)}, but it will not * be permanent. If the data is to be retained permanently, the revision * processor needs to make its own copy. @@ -266,6 +269,12 @@ public class DumpProcessingController { /** * Registers an EntityDocumentProcessor, which will henceforth be notified * of all entity documents that are encountered in the dump. + * <p> + * It is possible to register processors for specific content types and to + * use either all revisions or only the most current ones. This + * functionality is only available when processing dumps that contain this + * information. In particular, plain JSON dumps do not specify content + * models at all and have only one (current) revision of each entity. * * @param entityDocumentProcessor * the entity document processor to register

['wdtk-datamodel/src/main/java/org/wikidata/wdtk/datamodel/interfaces/EntityDocumentProcessorBroker.java', 'wdtk-dumpfiles/src/main/java/org/wikidata/wdtk/dumpfiles/DumpProcessingController.java']

{'.java': 2}

Java

{'Java': 2468830, 'HTML': 40410}

Apache License 2.0

spring-projects/spring-ldap/609/489

spring-projects

spring-ldap

https://github.com/spring-projects/spring-ldap/issues/489

https://github.com/spring-projects/spring-ldap/pull/609

https://github.com/spring-projects/spring-ldap/pull/609

fixes

LDAP connection not closed due to DefaultDirContextValidator

`DefaultDirContextValidator` class doesn't close `NamingEnumeration` searchResults. As a consequence, the LDAP connection associated with the `DirContext `can't be closed when requested by the pool. It's conform to the documentation : [https://docs.oracle.com/javase/tutorial/jndi/ldap/close.html](https://docs.oracle.com/javase/tutorial/jndi/ldap/close.html) _"If the Context instance is sharing a connection with other Context and unterminated NamingEnumeration instances, the connection will not be closed until close() has been invoked on all such Context and NamingEnumeration instances"_ `DefaultDirContextValidator` should close the `NamingEnumeration` searchResults in a finally block : ``` NamingEnumeration<SearchResult> = null; ... try { searchResults = dirContext.search(this.base, this.filter, this.searchControls); ... } finally { if (searchResults != null) { try { searchResults.close(); } catch (Exception e) { } } } ```

06d01e51161456200420e786ef96feb4c899c3a1

366c7c9d60522528737d2f9ebaca577d66bfff90

https://github.com/spring-projects/spring-ldap/compare/06d01e51161456200420e786ef96feb4c899c3a1...366c7c9d60522528737d2f9ebaca577d66bfff90

diff --git a/core/src/main/java/org/springframework/ldap/pool/validation/DefaultDirContextValidator.java b/core/src/main/java/org/springframework/ldap/pool/validation/DefaultDirContextValidator.java index 22f31f99..53db23ed 100644 --- a/core/src/main/java/org/springframework/ldap/pool/validation/DefaultDirContextValidator.java +++ b/core/src/main/java/org/springframework/ldap/pool/validation/DefaultDirContextValidator.java @@ -22,6 +22,7 @@ import org.springframework.ldap.pool.DirContextType; import org.springframework.util.Assert; import javax.naming.NamingEnumeration; +import javax.naming.NamingException; import javax.naming.directory.DirContext; import javax.naming.directory.SearchControls; import javax.naming.directory.SearchResult; @@ -165,9 +166,10 @@ public class DefaultDirContextValidator implements DirContextValidator { public boolean validateDirContext(DirContextType contextType, DirContext dirContext) { Assert.notNull(contextType, "contextType may not be null"); Assert.notNull(dirContext, "dirContext may not be null"); - + + NamingEnumeration<SearchResult> searchResults = null; try { - final NamingEnumeration<SearchResult> searchResults = dirContext.search(this.base, this.filter, this.searchControls); + searchResults = dirContext.search(this.base, this.filter, this.searchControls); if (searchResults.hasMore()) { this.logger.debug("DirContext '{}' passed validation.", dirContext); @@ -179,6 +181,14 @@ public class DefaultDirContextValidator implements DirContextValidator { this.logger.debug("DirContext '{}' failed validation with an exception.", dirContext, e); return false; } + finally { + if (searchResults != null) { + try { + searchResults.close(); + } catch (NamingException namingException) { + } + } + } this.logger.debug("DirContext '{}' failed validation.", dirContext); return false; diff --git a/core/src/main/java/org/springframework/ldap/pool2/validation/DefaultDirContextValidator.java b/core/src/main/java/org/springframework/ldap/pool2/validation/DefaultDirContextValidator.java index 716fb97e..8fb655c8 100644 --- a/core/src/main/java/org/springframework/ldap/pool2/validation/DefaultDirContextValidator.java +++ b/core/src/main/java/org/springframework/ldap/pool2/validation/DefaultDirContextValidator.java @@ -22,6 +22,7 @@ import org.springframework.ldap.pool2.DirContextType; import org.springframework.util.Assert; import javax.naming.NamingEnumeration; +import javax.naming.NamingException; import javax.naming.directory.DirContext; import javax.naming.directory.SearchControls; import javax.naming.directory.SearchResult; @@ -166,12 +167,13 @@ public class DefaultDirContextValidator implements DirContextValidator { Assert.notNull(contextType, "contextType may not be null"); Assert.notNull(dirContext, "dirContext may not be null"); + NamingEnumeration<SearchResult> searchResults = null; try { - final NamingEnumeration<SearchResult> searchResults = dirContext.search(this.base, this.filter, this.searchControls); + searchResults = dirContext.search(this.base, this.filter, this.searchControls); if (searchResults.hasMore()) { this.logger.debug("DirContext '{}' passed validation.", dirContext); - + return true; } } @@ -179,6 +181,14 @@ public class DefaultDirContextValidator implements DirContextValidator { this.logger.debug("DirContext '{}' failed validation with an exception.", dirContext, e); return false; } + finally { + if (searchResults != null) { + try { + searchResults.close(); + } catch (NamingException namingException) { + } + } + } this.logger.debug("DirContext '{}' failed validation.", dirContext); return false;

['core/src/main/java/org/springframework/ldap/pool/validation/DefaultDirContextValidator.java', 'core/src/main/java/org/springframework/ldap/pool2/validation/DefaultDirContextValidator.java']

{'.java': 2}