| /******************************************************************************* |
| * Copyright (c) 2000, 2017 IBM Corporation and others. |
| * |
| * This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License 2.0 |
| * which accompanies this distribution, and is available at |
| * https://www.eclipse.org/legal/epl-2.0/ |
| * |
| * SPDX-License-Identifier: EPL-2.0 |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.help.internal.webapp.servlet; |
| |
| import java.io.IOException; |
| |
| import javax.servlet.ServletException; |
| import javax.servlet.http.HttpServlet; |
| import javax.servlet.http.HttpServletRequest; |
| import javax.servlet.http.HttpServletResponse; |
| |
| import org.eclipse.help.IContext; |
| import org.eclipse.help.IContext2; |
| import org.eclipse.help.IHelpResource; |
| import org.eclipse.help.internal.HelpPlugin; |
| import org.eclipse.help.internal.Topic; |
| import org.eclipse.help.internal.base.BaseHelpSystem; |
| import org.eclipse.help.internal.context.Context; |
| import org.eclipse.help.internal.webapp.data.UrlUtil; |
| |
| /* |
| * Returns a context help entry with the id specified in the id parameter. |
| * |
| * This is called on infocenters by client workbenches configured for remote |
| * help in order to retrieve context help stored on the remote help server. |
| */ |
| public class ContextServlet extends HttpServlet { |
| |
| private static final long serialVersionUID = 1L; |
| private static final String PARAMETER_ID = "id"; //$NON-NLS-1$ |
| |
| @Override |
| protected void doGet(HttpServletRequest req, HttpServletResponse resp) |
| throws ServletException, IOException { |
| String response = processRequest(req, resp); |
| if ("400".equals(response)) //$NON-NLS-1$ |
| resp.sendError(400); // bad request; missing parameter |
| else if ("404".equals(response)) //$NON-NLS-1$ |
| resp.sendError(404); // Wrong context id; not found |
| else |
| resp.getWriter().write(response); |
| } |
| |
| protected String processRequest(HttpServletRequest req, HttpServletResponse resp) |
| throws ServletException, IOException { |
| BaseHelpSystem.checkMode(); |
| String locale = UrlUtil.getLocale(req, resp); |
| req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$ |
| resp.setContentType("application/xml; charset=UTF-8"); //$NON-NLS-1$ |
| String id = req.getParameter(PARAMETER_ID); |
| if (id != null) { |
| IContext context = getContext(locale, id); |
| if (context != null) { |
| return serialize(context); |
| } |
| // Wrong context id; not found |
| return "404"; //$NON-NLS-1$ |
| } |
| // bad request; missing parameter |
| return "400"; //$NON-NLS-1$ |
| } |
| |
| protected IContext getContext(String locale, String id) { |
| IContext context = HelpPlugin.getContextManager().getContext(id, locale); |
| return context; |
| } |
| |
| private String serialize(IContext context) throws IOException { |
| StringBuilder buff = new StringBuilder(); |
| buff.append("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"); //$NON-NLS-1$ |
| buff.append('<' + Context.NAME ); |
| if (context instanceof IContext2) { |
| String title = ((IContext2)context).getTitle(); |
| if (title != null && title.length() > 0) { |
| buff.append(" title=\"" + title + "\""); //$NON-NLS-1$ //$NON-NLS-2$ |
| } |
| } |
| buff.append(">\n"); //$NON-NLS-1$ |
| String description = context.getText(); |
| if (description != null) { |
| buff.append(" <description>" + UrlUtil.htmlEncode(description) + "</description>\n"); //$NON-NLS-1$ //$NON-NLS-2$ |
| } |
| |
| IHelpResource[] topics = context.getRelatedTopics(); |
| for (IHelpResource topic : topics) { |
| buff.append(" <" + Topic.NAME); //$NON-NLS-1$ |
| if (topic.getLabel() != null) { |
| buff.append("\n " + Topic.ATTRIBUTE_LABEL + "=\"" + topic.getLabel() + '"'); //$NON-NLS-1$ //$NON-NLS-2$ |
| } |
| if (topic.getHref() != null) { |
| buff.append("\n " + Topic.ATTRIBUTE_HREF + "=\"" + topic.getHref() + '"'); //$NON-NLS-1$ //$NON-NLS-2$ |
| } |
| buff.append("> </" + Topic.NAME + ">\n"); //$NON-NLS-1$ //$NON-NLS-2$ |
| } |
| buff.append("</" + Context.NAME + ">\n"); //$NON-NLS-1$ //$NON-NLS-2$ |
| return buff.toString(); |
| } |
| } |