Community
Participate
Working Groups
In Sirius we have several of our help entries [1] which point to local HTML files with space in their names. It's probably not a good practice, but it used to work at least until Oxygen.3. Testing with Photon (at least M6, I've not looked further), all these are now broken and display an empty page with no error message or feedback (not even a "Topic not found"). When hovering the mouse on one of these topic's link in the left panel, I see it point to a URL of this form: http://127.0.0.1:41099/help/topic/org.eclipse.sirius.doc/doc/specifier/Sirius%20Specifier%20Manual.html so with " " quoted as "%20" but "/" left as-is. Following this link it seems I end up being redirected to: http://127.0.0.1:41099/help/index.jsp?topic=%2Forg.eclipse.sirius.doc%2Fdoc%2Fspecifier%2FSirius%2520Specifier%2520Manual.html with "/" quoted as "%2F" and the "%" in the original link quoted as "%25". I've tried unquoting parts of the second URL manually in my browser, without success. On the Sirius side we'll probably rename our files to be safe, but I wanted to make sure this is reported. [1] https://git.eclipse.org/r/plugins/gitiles/sirius/org.eclipse.sirius/+/master/plugins/org.eclipse.sirius.doc/doc/toc.xml
Alex, could this be caused by newer Jetty version? Maybe a security fix?
(In reply to Dani Megert from comment #1) > Alex, could this be caused by newer Jetty version? Maybe a security fix? That was my first thought, but I'm seeing this with a product built on Photon M6 (with org.eclipse.help Version: 2.2.200.v20180124-2000 Build id: I20180124-2000), which uses Jetty 9.4.8.v20171121. The "newer Jetty version" is 9.4.10 right?
Both Oxygen.3 and Photon M6 have Jetty 9.4.8. It's interesting whether it works with RC1/2?
Did you test both scenarios on the exact same machine?
(In reply to Dani Megert from comment #4) > Did you test both scenarios on the exact same machine? Yes, under Linux (but it was first reported both other members of the Sirius team who are under Windows). On the same machine I see the problem both with a package built on Photon M6 (Jetty 9.4.8) and Photon M7 (Jetty 9.4.10). I just tested with an earlier version of our product, based on Oxygen.3 (uses Jetty 9.4.5): it still works, but I notice a difference in the URLs: In the navigator panel, the "original" link is of the same form: http://127.0.0.1:43613/help/topic/org.eclipse.sirius.doc/doc/specifier/Sirius%20Specifier%20Manual.html?cp=15_2 When pasting this in an external browser, I end up at http://127.0.0.1:43613/help/index.jsp?topic=%2Forg.eclipse.sirius.doc%2Fdoc%2Fspecifier%2FSirius+Specifier+Manual.html&cp=15_2 i.e. the spaces, quoted as "%20" in the original link, have become "+". Using my Photon M7 based product (which redirects me to the broken URL when following the navigator's links), the form of URL works!
FWIW, replacing the space characters in the toc.xml links by "+" works around the problem for direct links, i.e. - <topic href="doc/user/Sirius User Manual.html" label="Sirius User Manual"> + <topic href="doc/user/Sirius+User+Manual.html" label="Sirius User Manual"> However, this is not a complete workaround because links inside the HTML files to images with space in their paths are also broken. For example we have: <img src="images/Sirius - High-Level Architecture Overview.png"/> which shows up as-is in the source of the frame in the browser, but results in a broken image. Following the link redirects to the broken URL: http://127.0.0.1:36195/help/topic/org.eclipse.sirius.doc/doc/developer/images/Sirius%20-%20High-Level%20Architecture%20Overview.png (the version with "Sirius+-+High-Level+Architecture+Overview.png" resolves correctly).
New Gerrit change created: https://git.eclipse.org/r/123356
(In reply to Eclipse Genie from comment #7) > New Gerrit change created: https://git.eclipse.org/r/123356 Can you tell us what broke it?
(In reply to Dani Megert from comment #8) > (In reply to Eclipse Genie from comment #7) > > New Gerrit change created: https://git.eclipse.org/r/123356 > > Can you tell us what broke it? It looks to me like the problem appeared between Photon M3 and Photon M4. However, the line Lucas removed here was added to fix bug 290147 a long long time ago. Was something fixed elsewhere between M3 and M4 that made this line no longer necessary?
(In reply to Mat Booth from comment #9) > Was something fixed elsewhere between M3 and M4 that made this line no > longer necessary? Bug 497510 looks a likely candidate...
Yep, I can confirm that reverting the fix for bug 497510 (see [1]) makes this problem disappear. If I were to make a wild stab-in-the-dark guess, I would say Lucas' fix is correct -- the line he's removed was probably covering up the defect in Equinox for a long time :-) [1] http://git.eclipse.org/c/equinox/rt.equinox.bundles.git/commit/?id=ea94523fefb5b36def9cda1062495008e47b4795
NOTE: 4.8 development must go into R4_8_maintenance.
New Gerrit change created: https://git.eclipse.org/r/123426
Gerrit change https://git.eclipse.org/r/123426 was merged to [R4_8_maintenance]. Commit: http://git.eclipse.org/c/platform/eclipse.platform.ua.git/commit/?id=1fcc1268e83fe5285ef9bf24daeb5631e9e02cab
Alex, you marked it FIXED. How do you keep track of the master fix which is still open?
(In reply to Dani Megert from comment #15) > Alex, you marked it FIXED. How do you keep track of the master fix which is > still open? Gerrit is my primary bookkeeping so I won't lose it :).
Thanks for the quick fix. I mentioned earlier that we would rename our files just to be safe, but actually this would break all existing hyperlinks (for example from posts on our forum) to the version of our doc published on the web (http://www.eclipse.org/sirius/doc/). I'll keep an eye on this and check with RC3, but we'll probably not change our file names.
(In reply to Pierre-Charles David from comment #17) > Thanks for the quick fix. I mentioned earlier that we would rename our files > just to be safe, but actually this would break all existing hyperlinks (for > example from posts on our forum) to the version of our doc published on the > web (http://www.eclipse.org/sirius/doc/). I'll keep an eye on this and check > with RC3, but we'll probably not change our file names. Even if you don't do it for existing. Please keep it in mind for the future to not add such :). URIs with spaces are really bad idea.
Gerrit change https://git.eclipse.org/r/123356 was merged to [master]. Commit: http://git.eclipse.org/c/platform/eclipse.platform.ua.git/commit/?id=61d6c006d59893a7db1250aec86c3a14da5a5066
New Gerrit change created: https://git.eclipse.org/r/123788
New Gerrit change created: https://git.eclipse.org/r/123792
(In reply to Eclipse Genie from comment #21) > New Gerrit change created: https://git.eclipse.org/r/123792 https://git.eclipse.org/r/123788 Please ignore, this was due to an error.
