1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
/*******************************************************************************
* Copyright (c) 2007, 2011 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.help.internal.webapp.servlet;
import java.io.OutputStream;
import javax.servlet.http.HttpServletRequest;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Platform;
import org.eclipse.help.ITopic;
import org.eclipse.help.internal.HelpPlugin;
import org.eclipse.help.internal.base.HelpBasePlugin;
import org.eclipse.help.internal.base.IHelpBaseConstants;
import org.eclipse.help.internal.webapp.HelpWebappPlugin;
import org.eclipse.help.internal.webapp.data.TocData;
import org.eclipse.help.internal.webapp.data.UrlUtil;
import org.eclipse.help.webapp.IFilter;
/**
* Injects breadcrumbs at the top of help documents, e.g.
* "Workbench User Guide > Concepts > Workbench".
*/
public class BreadcrumbsFilter implements IFilter {
private static final String HEAD_CONTENT1 = "\n<link rel=\"stylesheet\" href=\""; //$NON-NLS-1$
private static final String HEAD_CONTENT2 = "/content/" + HelpWebappPlugin.PLUGIN_ID + "/advanced/breadcrumbs.css\" charset=\"ISO-8859-1\" type=\"text/css\"></link>" //$NON-NLS-1$ //$NON-NLS-2$
+ "\n<script type=\"text/javascript\" src=\""; //$NON-NLS-1$
private static final String HEAD_CONTENT3 = "/content/" + HelpPlugin.PLUGIN_ID + "/livehelp.js\"> </script>"; //$NON-NLS-1$ //$NON-NLS-2$
/* (non-Javadoc)
* @see org.eclipse.help.internal.webapp.servlet.IFilter#filter(javax.servlet.http.HttpServletRequest, java.io.OutputStream)
*/
@Override
public OutputStream filter(HttpServletRequest req, OutputStream out) {
String uri = req.getRequestURI();
if (uri == null || !uri.endsWith("html") && !uri.endsWith("htm") && !UrlUtil.isNavPath(uri)) { //$NON-NLS-1$ //$NON-NLS-2$
return out;
}
if ("/rtopic".equals(req.getServletPath()) || "/nftopic".equals(req.getServletPath())) { //$NON-NLS-1$ //$NON-NLS-2$
return out;
}
if (UrlUtil.isBot(req)) {
return out;
}
if ("true".equals(req.getParameter("noframes"))) { //$NON-NLS-1$//$NON-NLS-2$
return out;
}
String pathInfo = req.getPathInfo();
String servletPath = req.getServletPath();
if (pathInfo == null || servletPath == null) {
return out;
}
boolean showBreadcrumbs = Platform.getPreferencesService().getBoolean(HelpBasePlugin.PLUGIN_ID, IHelpBaseConstants.P_SHOW_BREADCRUMBS, false, null);
if (!showBreadcrumbs) {
return out;
}
// Use pathInfo to get the topic path because the uri could have escaped spaces
// or other characters, Bug 75360
String locale = UrlUtil.getLocale(req, null);
String pathParam = req.getParameter(TocData.COMPLETE_PATH_PARAM);
String breadcrumbPath;
if (pathParam != null && pathParam.length() > 0) {
breadcrumbPath = "/nav/" + pathParam; //$NON-NLS-1$
} else {
breadcrumbPath= servletPath + pathInfo;
}
int[] path = UrlUtil.getTopicPath(breadcrumbPath, locale );
if (path != null && path.length > 1) {
try {
boolean isNarrow = "/ntopic".equals(req.getServletPath()); //$NON-NLS-1$
String backpath = getBackpath(pathInfo);
String bodyContent = getBodyContent(path,
backpath, isNarrow, locale);
String headContent = HEAD_CONTENT1 + backpath + HEAD_CONTENT2 + backpath +
HEAD_CONTENT3;
return new FilterHTMLHeadAndBodyOutputStream(out, headContent
.getBytes("ASCII"), bodyContent); //$NON-NLS-1$
}
catch (Exception e) {
return out;
}
}
return out;
}
private String getBackpath(String path) {
int num = new Path(path).segmentCount();
StringBuffer buf = new StringBuffer();
for (int i=0;i<num;++i) {
if (i > 0) {
buf.append('/');
}
buf.append(".."); //$NON-NLS-1$
}
return buf.toString();
}
private String getBodyContent(int[] path, String backPath, boolean isNarrow, String locale) {
StringBuffer buf = new StringBuffer();
StringBuffer pathBuf = new StringBuffer();
ITopic topic = HelpPlugin.getTocManager().getTocs(locale)[path[0]].getTopic(null);
pathBuf.append(path[0]);
boolean isMirrored = org.eclipse.help.internal.util.ProductPreferences.isRTL();
if(isMirrored)
buf.append("\u202B"); //$NON-NLS-1$ //append RLE marker at the beginning
buf.append("<div class=\"help_breadcrumbs\">"); //$NON-NLS-1$
for (int i=0;i<path.length-1;++i) {
// add the link
buf.append("<a href=\""); //$NON-NLS-1$
String href = topic.getHref();
if (href != null) {
href = backPath + (isNarrow ? "/ntopic" : "/topic") + href; //$NON-NLS-1$ //$NON-NLS-2$
}
else {
if (isNarrow) {
href = "javascript:liveAction('org.eclipse.help.ui', 'org.eclipse.help.ui.internal.ShowInTocAction', '" + pathBuf.toString() + "')"; //$NON-NLS-1$ //$NON-NLS-2$
}
else {
href = backPath + "/nav/" + pathBuf.toString(); //$NON-NLS-1$
}
}
buf.append(href);
buf.append("\">"); //$NON-NLS-1$
buf.append(UrlUtil.htmlEncode(topic.getLabel()));
buf.append("</a>"); //$NON-NLS-1$
// add separator
if (i < path.length - 2 || path.length == 2) {
// always add if there's only one link
if(isMirrored)
buf.append(" \u200F> "); //$NON-NLS-1$ //append RLM marker before >
else
buf.append(" > "); //$NON-NLS-1$
}
// move to the next topic in the path
topic = topic.getSubtopics()[path[i + 1]];
pathBuf.append('_');
pathBuf.append(path[i + 1]);
}
buf.append("</div>"); //$NON-NLS-1$
if(isMirrored)
buf.append("\u202C"); //$NON-NLS-1$ //append PDF marker at the end
return buf.toString();
}
}
|
