All,

On 1/10/25 4:41 PM, Christopher Schultz wrote:
All,

Should be fixed in r1923040.

Doh. The site has updated but the search is still not working.

It's failing to fetch some zip and other files.

This works locally on my own computer with no HTTP server in between -- while the site files that HAD been in revision control did NOT work. So what I did in r1923040 got things working for me, at least locally.

I might need some insight into what's happening on the server-end when these files are requested. They appear to be in revision-control, but the server replies with 404.

There are definitely some actual broken things in the javadoc. For example, the javadoc CSS requests dejavu.css which exists nowhere in the javadoc itself. Similarly, there are references to module-search-index.js and module-search-index.zip and those files are nowhere to be seen.

I'm not sure if those issues are connected to the js building bad URLs or not. Someone with more experience with javadoc might need to take a look.

Or I can try re-generating the javadoc with the current JDK used for releases (Java 23) and see if that improves things.

Any suggestions?

-chris

On 1/10/25 12:56 PM, Mark Thomas wrote:
On 10/01/2025 15:17, Christopher Schultz wrote:
All,

On 1/10/25 10:05 AM, Christopher Schultz wrote:
All,

On 1/10/25 9:52 AM, Christopher Schultz wrote:
Maxim,

On 1/10/25 1:44 AM, Maxim Solodovnik wrote:
On Fri, 10 Jan 2025 at 13:40, Chuck Caldarale <n82...@gmail.com> wrote:


On Jan 9, 2025, at 23:09, Maxim Solodovnik <solomax...@gmail.com> wrote:

Hello All,

just have noticed Javadoc search is broken :(
my steps:
- open Javadoc main page at
https://tomcat.apache.org/tomcat-10.0-doc/api/index.html
- paste 'SSLHostConfig' into search box (at top-right)
- hit Enter key
Result: got 404 page at URL:
https://tomcat.apache.org/tomcat-10.0-doc/api/undefined/org/ apache/ tomcat/util/net/SSLHostConfig.html


As well you should. Support for 10.0 expired quite some time ago, so the doc pages were removed. You should upgrade to 10.1 or higher and use the doc for that level.

Docs for 10.0 are still accessible:
https://tomcat.apache.org/tomcat-10.0-doc/index.html ...

Search at https://tomcat.apache.org/tomcat-10.1-doc/api/index.html
works as expected :)

Yeah, I kinda agree that Javadoc search for 10.0 should be working if we're going to have it up on the website.

The presence of the word "undefined" in that URL suggests to me that something isn't quite right with the javascript powering it. A quick check shows that search.js sets window.location=pathtoroot + url so I first suspected that pathtoroot was undefined, but each page defines pathtoroot including e.g. index.html so ...

I also see two scripts that fail to load:

module-search-index.js
tag-search-index.js

All other javadoc for Tomcat [8.5, 9.0, 10.1, 11.0] have these two files, but not 10.0.

The files don't look very complicated and don't appear to contain anything specific to each of those other javadoc sets, so I simply copied them from one other directory into 10.0. It didn't work. There is obviously some other support that needs to be added in order to get it working.

Re-generating the javadoc using Java 11.0.25+9 give me a working local javadoc search.

How important is it that the javadoc on the website is built with the release version of 10.0.27? I'm guessing ... not at all.

Shall I update the website with working javadoc search?

So... looking at the search implementation, it uses jquery.

jquery has been known to contain security vulnerabilities that can be used to attack the user viewing the page.

I would guess that the old documentation has been de-fanged to prevent this kind of thing from happening.

But maybe not: I see jquery in the 10.0 directory on the site.

A quick check of NVD shows that jquery 3.5.1 (used by Tomcat's 10.0 javadoc) has no reports against it.

My proposal is to replace the public javadoc for Tomcat 10.0 with the stuff I just generated.

I've just been using viewvc to look at the 10.0 docs. It looks like there are bits from multiple versions floating around. It might be worth rm'ing the entire Javadocs dir before you upload the fixes ones.

Mark


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscr...@tomcat.apache.org
For additional commands, e-mail: users-h...@tomcat.apache.org




---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscr...@tomcat.apache.org
For additional commands, e-mail: users-h...@tomcat.apache.org

Reply via email to