Sanitize URLs in file fields to handle invalid pipe characters ('|') #12156
Conversation
…loses #11876. - Introduced URLUtil.createUri() and URLUtil.create() to handle URL sanitization. - Replaced direct calls to URI.create() and URI.create().toURL() with the new utility methods. - URLs containing the pipe character ('|') are now properly encoded as '%7C' to prevent parsing errors. - Added test cases to URLUtilTest to verify correct sanitization and URL creation.
|
Am I on the right track to resolve this Issue? |
|
|
||
| public static URI createUri(String url) { | ||
| try { | ||
| String urlFormat = url.replace("|", "%7C"); |
There was a problem hiding this comment.
Please add a comment explaining why we are doing this and the relevant references.
| try { | ||
| String urlFormat = url.replace("|", "%7C"); | ||
| return new URI(urlFormat); | ||
| } catch (URISyntaxException e) { |
|
@hitalo-siriano Are you still on it? The steps to finish it seem to be small. |
|
@koppor Yes, I'm still working on the changes |
…loses #11876. - Introduced URLUtil.createUri() and URLUtil.create() to handle URL sanitization. - Replaced direct calls to URI.create() and URI.create().toURL() with the new utility methods. - URLs containing the pipe character ('|') are now properly encoded as '%7C' to prevent parsing errors. - Added test cases to URLUtilTest to verify correct sanitization and URL creation. - Added @archtest to ensure that the URI.create() method is not directly called in the codebase.
| * @param url the URL string to be converted into a {@link URL}. | ||
| * @return the {@link URL} object created from the string URL. | ||
| * @throws MalformedURLException if the URL is malformed and cannot be converted to a {@link URL}. | ||
| */ | ||
|
|
There was a problem hiding this comment.
no empty line between JavaDoc and method
add an empty line above JavaDoc
| } catch ( | ||
| MalformedURLException e) { |
There was a problem hiding this comment.
Remove empty line (we know that the IntelliJ autoformatter creates this - but no one invested significant time to fix this)
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Your code currently does not meet JabRef's code guidelines.
We use Checkstyle to identify issues.
Please carefully follow the setup guide for the codestyle.
Afterwards, please run checkstyle locally and fix the issues.
…loses #11876. - Introduced URLUtil.createUri() and URLUtil.create() to handle URL sanitization. - Replaced direct calls to URI.create() and URI.create().toURL() with the new utility methods. - URLs containing the pipe character ('|') are now properly encoded as '%7C' to prevent parsing errors. - Added test cases to URLUtilTest to verify correct sanitization and URL creation. - Added @archtest to ensure that the URI.create() method is not directly called in the codebase.
…loses #11876. - Introduced URLUtil.createUri() and URLUtil.create() to handle URL sanitization. - Replaced direct calls to URI.create() and URI.create().toURL() with the new utility methods. - URLs containing the pipe character ('|') are now properly encoded as '%7C' to prevent parsing errors. - Added test cases to URLUtilTest to verify correct sanitization and URL creation. - Added @archtest to ensure that the URI.create() method is not directly called in the codebase.
There was a problem hiding this comment.
Your code currently does not meet JabRef's code guidelines.
We use Checkstyle to identify issues.
Please carefully follow the setup guide for the codestyle.
Afterwards, please run checkstyle locally and fix the issues.
|
@koppor I made the requested changes, is there anything else that needs to be done? |
ghost
marked this pull request as ready for review
|
@hitalo-siriano please see the automated output that your code misses matching our style rules. Fix that first. That reduces load on our side. |
There was a problem hiding this comment.
Your code currently does not meet JabRef's code guidelines.
We use OpenRewrite to ensure "modern" Java coding practices.
The issues found can be automatically fixed.
Please execute the gradle task rewriteRun, check the results, commit, and push.
You can check the detailed error output by navigating to your pull request, selecting the tab "Checks", section "Tests" (on the left), subsection "OpenRewrite".
There was a problem hiding this comment.
Your code currently does not meet JabRef's code guidelines.
We use Checkstyle to identify issues.
Please carefully follow the setup guide for the codestyle.
Afterwards, please run checkstyle locally and fix the issues.
Closes #11876.