hazza/DSpace
1
0
Fork 0
mirror of https://github.com/DSpace/DSpace.git synced 2025-10-07 01:54:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

127746: Implement different failures for robots file so we can differentiate between a missing file or an invalid file

Browse Source 
(cherry picked from commit 32c0484280)
This commit is contained in:
Jens Vannerum
2025-04-01 17:54:48 +02:00
parent 31549bdace
commit 7a876999f8
1 changed files with 28 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
dspace-server-webapp/src/main/java/org/dspace/app/rest/health/SEOHealthIndicator.java
View File

@@ -31,19 +31,28 @@ public class SEOHealthIndicator extends AbstractHealthIndicator {
String baseUrl = configurationService.getProperty("dspace.ui.url");
boolean sitemapOk = checkUrl(baseUrl + "/sitemap_index.xml") || checkUrl(baseUrl + "/sitemap_index.html");
boolean robotsTxtOk = checkRobotsTxt(baseUrl + "/robots.txt");
RobotsTxtStatus robotsTxtStatus = checkRobotsTxt(baseUrl + "/robots.txt");
boolean ssrOk = checkSSR(baseUrl);
if (sitemapOk && robotsTxtOk && ssrOk) {
if (sitemapOk && robotsTxtStatus == RobotsTxtStatus.VALID && ssrOk) {
builder.up()
.withDetail("sitemap", "OK")
.withDetail("robots.txt", "OK")
.withDetail("ssr", "OK");
} else {
builder.down()
.withDetail("sitemap", sitemapOk ? "OK" : "Missing or inaccessible")
.withDetail("robots.txt", robotsTxtOk ? "OK" : "Empty or contains local URLs")
.withDetail("ssr", ssrOk ? "OK" : "Server-side rendering might be disabled");
builder.down();
builder.withDetail("sitemap", sitemapOk ? "OK" : "Missing or inaccessible");
if (robotsTxtStatus == RobotsTxtStatus.MISSING) {
builder.withDetail("robots.txt", "Missing or inaccessible. Please see the DSpace Documentation on " +
"Search Engine Optimization for how to create a robots.txt.");
} else if (robotsTxtStatus == RobotsTxtStatus.INVALID) {
builder.withDetail("robots.txt", "Invalid because it contains localhost URLs. This is often a sign " +
"that a proxy is failing to pass X-Forwarded headers to DSpace. Please see the DSpace " +
"Documentation on Search Engine Optimization for how to pass X-Forwarded headers.");
}
builder.withDetail("ssr", ssrOk ? "OK" : "Server-side rendering might be disabled");
}
}
@@ -56,12 +65,18 @@ public class SEOHealthIndicator extends AbstractHealthIndicator {
}
}
private boolean checkRobotsTxt(String url) {
private RobotsTxtStatus checkRobotsTxt(String url) {
try {
String content = restTemplate.getForObject(url, String.class);
return StringUtils.isNotBlank(content) && !content.contains("localhost");
if (StringUtils.isBlank(content)) {
return RobotsTxtStatus.MISSING;
}
if (content.contains("localhost")) {
return RobotsTxtStatus.INVALID;
}
return RobotsTxtStatus.VALID;
} catch (Exception e) {
return false;
return RobotsTxtStatus.MISSING;
}
}
@@ -73,5 +88,9 @@ public class SEOHealthIndicator extends AbstractHealthIndicator {
return false;
}
}
private enum RobotsTxtStatus {
VALID, MISSING, INVALID
}
}