Maven Shared Components

FilteringUtils escapeWindowsPath() doesn't work on Windows

Details

  • Testcase included:
    yes
  • Patch Submitted:
    Yes
  • Number of attachments :
    2

Description

The method escapeWindowsPath() is replacing colon by backslash + colon.
I.e.
D:\temp
is escaped as
D\:
temp

But windows doesn't recognize that. If you try to open D\:
temp on explorer, will not work.
Even java.io.File is not able to handle that too. The attached test proves it.

I'm not sure why this backslash was add to colon, but commenting line 44 of org.apache.maven.shared.filtering.FilteringUtils make the test work.

  1. Text File
    filtering.patch
    17/Feb/09 11:44 AM
    0.9 kB
    Marvin Froeder
  2. Java Source File
    FilteringUtilsTest.java
    29/Oct/08 7:41 AM
    0.8 kB
    Marvin Froeder

Issue Links

is depended upon by

Bug - A problem which impairs or prevents the functions of the product. MRESOURCES-81 2.3 escapes characters when filtering properties

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.
is related to

Bug - A problem which impairs or prevents the functions of the product. MRESOURCES-42 Filtering properties that contain ${basedir} for property files doesn't escape backslashes

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Bug - A problem which impairs or prevents the functions of the product. MRESOURCES-81 2.3 escapes characters when filtering properties

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.
relates to

Bug - A problem which impairs or prevents the functions of the product. MRESOURCES-106 Plugin does not respect escapeWindowsPaths default-value

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Marvin Froeder added a comment -

At MRESOURCES-42 was suggested to escape colon too.

I have no idea why, but this doesn't work on windows.

Show
Marvin Froeder added a comment - At MRESOURCES-42 was suggested to escape colon too. I have no idea why, but this doesn't work on windows.
Hide
Permalink
Benjamin Bentmann added a comment -

I believe the motivation for this escaping was the use case of filtering properties files, where backslash and colon have special meanings.

Show
Benjamin Bentmann added a comment - I believe the motivation for this escaping was the use case of filtering properties files, where backslash and colon have special meanings.
Hide
Permalink
Marvin Froeder added a comment -

I have XML and properties on my projects and it still working.

I have no idea how important is to escape colon, but if this is truly required should be done only at .properties files.

VELO

Show
Marvin Froeder added a comment - I have XML and properties on my projects and it still working. I have no idea how important is to escape colon, but if this is truly required should be done only at .properties files. VELO
Hide
Permalink
Olivier Lamy added a comment -

So what how can we fix that ?
apply this only for files : *.properties ?
Not really sure.

Show
Olivier Lamy added a comment - So what how can we fix that ? apply this only for files : *.properties ? Not really sure.
Hide
Permalink
Paul Jackson added a comment -

IMO, Filtering should not automatically add escape characters - it takes control away from a user. Better to never add escape characters and leave it to the user to add them as necessary.

Show
Paul Jackson added a comment - IMO, Filtering should not automatically add escape characters - it takes control away from a user. Better to never add escape characters and leave it to the user to add them as necessary.
Hide
Permalink
Paul Jackson added a comment -

The addition of backslashes in front of backslashes and colons is problematic.

Show
Paul Jackson added a comment - The addition of backslashes in front of backslashes and colons is problematic.
Hide
Permalink
Olivier Lamy added a comment -

Sure this should be optionnal.
As it was introduced as a feature, IMHO this must enable by default and we must add a parameter to be able to disable this.

Show
Olivier Lamy added a comment - Sure this should be optionnal. As it was introduced as a feature, IMHO this must enable by default and we must add a parameter to be able to disable this.
Hide
Permalink
Casey Butterworth added a comment -

Unless there's a workaround that I'm not aware of, this defect is effectively rendering the 2.3 resources plugin unusable for any projects that uses resource filtering to directory locations (e.g. basedir) on windows, which I imagine is a large number of projects. MRESOURCES-81 is a good description of the problem.

I've noticed that this is targeted at maven-filtering-1.0-beta-4, but i'm wondering if it should not be in the next release instead, and also be accompanied by a maven-release-plugin release?

Show
Casey Butterworth added a comment - Unless there's a workaround that I'm not aware of, this defect is effectively rendering the 2.3 resources plugin unusable for any projects that uses resource filtering to directory locations (e.g. basedir) on windows, which I imagine is a large number of projects. MRESOURCES-81 is a good description of the problem. I've noticed that this is targeted at maven-filtering-1.0-beta-4, but i'm wondering if it should not be in the next release instead, and also be accompanied by a maven-release-plugin release?
Hide
Permalink
Jason van Zyl added a comment -

The attached patch we've been using in Nexus for 3 months. Does anyone have a problem applying this?

Show
Jason van Zyl added a comment - The attached patch we've been using in Nexus for 3 months. Does anyone have a problem applying this?
Hide
Permalink
Olivier Lamy added a comment -

fixed in rev 749459

Show
Olivier Lamy added a comment - fixed in rev 749459
Hide
Permalink
Anton Makeev added a comment -

I reckon not only the windows paths should be escaped, but all the properties filtered.

For example, if I have a property defined as <myValue>xxx\yyy:zzz<myValue> it will be read from the *.properties file incorrectly as well.

Thanks,
Anton Makeev

Show
Anton Makeev added a comment - I reckon not only the windows paths should be escaped, but all the properties filtered. For example, if I have a property defined as <myValue>xxx\yyy:zzz<myValue> it will be read from the *.properties file incorrectly as well. Thanks, Anton Makeev
Hide
Permalink
Jayesh Lalwani added a comment -

Where can I get maven-filtering-1.0-beta-4? Is there a SVN that I can checkout the code from?

Show
Jayesh Lalwani added a comment - Where can I get maven-filtering-1.0-beta-4? Is there a SVN that I can checkout the code from?
Hide
Permalink
Benjamin Bentmann added a comment -

http://svn.apache.org/repos/asf/maven/shared/trunk/maven-filtering/

Show
Benjamin Bentmann added a comment - http://svn.apache.org/repos/asf/maven/shared/trunk/maven-filtering/

People

  • Assignee:
    Olivier Lamy
    Reporter:
    Marvin Froeder
Vote (3)
Watch (4)

Dates

  • Created:
    Updated:
    Resolved: