-
Notifications
You must be signed in to change notification settings - Fork 456
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
make the path validation smarter to avoid and hopefully eliminate the…
… need for disabling validation. fixed #379
- Loading branch information
Justin Lee
committed
Oct 28, 2016
1 parent
d0e5329
commit 0e0e235
Showing
10 changed files
with
373 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
48 changes: 48 additions & 0 deletions
48
morphia/src/main/java/org/mongodb/morphia/MorphiaUtils.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| /* | ||
| * Copyright 2016 MongoDB, Inc. | ||
| * | ||
| * 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. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.mongodb.morphia; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| /** | ||
| * This class provides a set of utilities for use in Morphia. All these methods should be considered internal only and should not be | ||
| * used in application code. | ||
| * | ||
| * @since 1.3 | ||
| */ | ||
| public final class MorphiaUtils { | ||
| private MorphiaUtils() { | ||
| } | ||
|
|
||
| /** | ||
| * Joins strings with the given delimiter | ||
| * | ||
| * @param strings the strings to join | ||
| * @param delimiter the delimiter | ||
| * @return the joined string | ||
| */ | ||
| public static String join(final List<String> strings, final char delimiter) { | ||
| StringBuilder builder = new StringBuilder(); | ||
| for (String element : strings) { | ||
| if (builder.length() != 0) { | ||
| builder.append(delimiter); | ||
| } | ||
| builder.append(element); | ||
| } | ||
| return builder.toString(); | ||
| } | ||
| } |
155 changes: 155 additions & 0 deletions
155
morphia/src/main/java/org/mongodb/morphia/PathTarget.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| /* | ||
| * Copyright 2016 MongoDB, Inc. | ||
| * | ||
| * 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. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.mongodb.morphia; | ||
|
|
||
| import org.mongodb.morphia.mapping.MappedClass; | ||
| import org.mongodb.morphia.mapping.MappedField; | ||
| import org.mongodb.morphia.mapping.Mapper; | ||
| import org.mongodb.morphia.query.ValidationException; | ||
|
|
||
| import java.util.Iterator; | ||
| import java.util.List; | ||
|
|
||
| import static java.lang.String.format; | ||
| import static java.util.Arrays.asList; | ||
| import static org.mongodb.morphia.MorphiaUtils.join; | ||
|
|
||
| /** | ||
| * This is an internal class and is subject to change or removal. | ||
| * | ||
| * @since 1.3 | ||
| */ | ||
| public class PathTarget { | ||
| private final List<String> segments; | ||
| private boolean validateNames = true; | ||
| private int position; | ||
| private Mapper mapper; | ||
| private MappedClass context; | ||
| private MappedClass root; | ||
| private MappedField target; | ||
| private boolean resolved = false; | ||
|
|
||
| /** | ||
| * Creates a resolution context for the given root and path. | ||
| * | ||
| * @param mapper mapper | ||
| * @param root root | ||
| * @param path path | ||
| */ | ||
| public PathTarget(final Mapper mapper, final MappedClass root, final String path) { | ||
| this.root = root; | ||
| segments = asList(path.split("\\.")); | ||
| this.mapper = mapper; | ||
| } | ||
|
|
||
| /** | ||
| * Disables validation of path segments. | ||
| */ | ||
| public void disableValidation() { | ||
| resolved = false; | ||
| validateNames = false; | ||
| } | ||
|
|
||
| private boolean hasNext() { | ||
| return position < segments.size(); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the translated path for this context. If validation is disabled, that path could be the same as the initial value. | ||
| * | ||
| * @return the translated path | ||
| */ | ||
| public String translatedPath() { | ||
| if (!resolved) { | ||
| resolve(); | ||
| } | ||
| return join(segments, '.'); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the MappedField found at the end of a path. May be null if the path is invalid and validation is disabled. | ||
| * | ||
| * @return the field | ||
| */ | ||
| public MappedField getTarget() { | ||
| if (!resolved) { | ||
| resolve(); | ||
| } | ||
| return target; | ||
| } | ||
|
|
||
| String next() { | ||
| return segments.get(position++); | ||
| } | ||
|
|
||
| private void resolve() { | ||
| context = this.root; | ||
| position = 0; | ||
| MappedField field = null; | ||
| while (hasNext()) { | ||
| String segment = next(); | ||
|
|
||
| if (segment.equals("$") || segment.matches("[0-9]+")) { // array operator | ||
| segment = next(); | ||
| } | ||
| field = resolveField(segment); | ||
|
|
||
| if (field != null) { | ||
| if (!field.isMap()) { | ||
| translate(field.getNameToStore()); | ||
| } else { | ||
| next(); // consume the map key segment | ||
| } | ||
| } else { | ||
| if (validateNames) { | ||
| throw new ValidationException(format("Could not resolve path '%s' against '%s'.", join(segments, '.'), | ||
| root.getClazz().getName())); | ||
| } | ||
| } | ||
| } | ||
| target = field; | ||
| resolved = true; | ||
| } | ||
|
|
||
| private void translate(final String nameToStore) { | ||
| segments.set(position - 1, nameToStore); | ||
| } | ||
|
|
||
| private MappedField resolveField(final String segment) { | ||
| MappedField mf = context.getMappedField(segment); | ||
| if (mf == null) { | ||
| mf = context.getMappedFieldByJavaField(segment); | ||
| } | ||
| if (mf == null) { | ||
| Iterator<MappedClass> subTypes = mapper.getSubTypes(context).iterator(); | ||
| while (mf == null && subTypes.hasNext()) { | ||
| context = subTypes.next(); | ||
| mf = resolveField(segment); | ||
| } | ||
| } | ||
|
|
||
| if (mf != null) { | ||
| context = mapper.getMappedClass(mf.getSubClass() != null ? mf.getSubClass() : mf.getConcreteType()); | ||
| } | ||
| return mf; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return String.format("PathTarget{root=%s, segments=%s, target=%s}", root.getClazz().getSimpleName(), segments, target); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.