2011-03-30 15:53:11 +00:00
|
|
|
/* ========================================================================
|
|
|
|
* PlantUML : a free UML diagram generator
|
|
|
|
* ========================================================================
|
|
|
|
*
|
|
|
|
* Project Info: http://plantuml.sourceforge.net
|
2014-02-06 17:28:06 +00:00
|
|
|
*
|
2011-03-30 15:53:11 +00:00
|
|
|
* This file is part of PlantUML.
|
|
|
|
*
|
|
|
|
* PlantUML is free software; you can redistribute it and/or modify it
|
|
|
|
* under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* PlantUML distributed in the hope that it will be useful, but
|
|
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
|
|
|
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
|
|
|
|
* License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public
|
|
|
|
* License along with this library; if not, write to the Free Software
|
|
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
|
|
|
|
* USA.
|
|
|
|
*/
|
2011-03-29 16:15:53 +00:00
|
|
|
package net.sourceforge.plantuml.servlet;
|
|
|
|
|
|
|
|
import java.io.IOException;
|
2013-09-13 17:55:07 +00:00
|
|
|
import java.io.PrintWriter;
|
2011-03-29 16:15:53 +00:00
|
|
|
import java.util.Collections;
|
|
|
|
import java.util.HashMap;
|
|
|
|
import java.util.Map;
|
|
|
|
|
|
|
|
import javax.servlet.http.HttpServletResponse;
|
2017-04-05 19:57:35 +00:00
|
|
|
import javax.servlet.http.HttpServletRequest;
|
2011-03-29 16:15:53 +00:00
|
|
|
|
2017-04-05 19:57:35 +00:00
|
|
|
import net.sourceforge.plantuml.BlockUml;
|
2011-03-29 16:15:53 +00:00
|
|
|
import net.sourceforge.plantuml.FileFormat;
|
|
|
|
import net.sourceforge.plantuml.FileFormatOption;
|
|
|
|
import net.sourceforge.plantuml.SourceStringReader;
|
|
|
|
import net.sourceforge.plantuml.StringUtils;
|
2014-02-06 23:08:25 +00:00
|
|
|
import net.sourceforge.plantuml.core.DiagramDescription;
|
2017-04-05 19:57:35 +00:00
|
|
|
import net.sourceforge.plantuml.core.Diagram;
|
2013-08-19 14:07:38 +00:00
|
|
|
import net.sourceforge.plantuml.servlet.utility.NullOutputStream;
|
2017-04-05 19:57:35 +00:00
|
|
|
import net.sourceforge.plantuml.version.Version;
|
|
|
|
import net.sourceforge.plantuml.PSystemError;
|
|
|
|
import net.sourceforge.plantuml.ErrorUml;
|
|
|
|
|
2011-03-29 16:15:53 +00:00
|
|
|
|
2013-07-10 15:07:24 +00:00
|
|
|
/**
|
|
|
|
* Delegates the diagram generation from the UML source and the filling of the HTTP response with the diagram in the
|
|
|
|
* right format. Its own responsibility is to produce the right HTTP headers.
|
2011-03-30 15:53:11 +00:00
|
|
|
*/
|
2011-03-29 16:15:53 +00:00
|
|
|
class DiagramResponse {
|
2017-04-05 19:57:35 +00:00
|
|
|
|
|
|
|
private static final String POWERED_BY = "PlantUML Version " + Version.versionString();
|
|
|
|
|
2011-03-29 16:15:53 +00:00
|
|
|
private HttpServletResponse response;
|
|
|
|
private FileFormat format;
|
2017-04-05 19:57:35 +00:00
|
|
|
private HttpServletRequest request;
|
2014-02-15 18:04:30 +00:00
|
|
|
private static final Map<FileFormat, String> CONTENT_TYPE;
|
2011-03-29 16:15:53 +00:00
|
|
|
static {
|
|
|
|
Map<FileFormat, String> map = new HashMap<FileFormat, String>();
|
|
|
|
map.put(FileFormat.PNG, "image/png");
|
|
|
|
map.put(FileFormat.SVG, "image/svg+xml");
|
2013-09-13 17:55:07 +00:00
|
|
|
map.put(FileFormat.UTXT, "text/plain;charset=UTF-8");
|
2014-02-15 18:04:30 +00:00
|
|
|
CONTENT_TYPE = Collections.unmodifiableMap(map);
|
2011-03-29 16:15:53 +00:00
|
|
|
}
|
|
|
|
|
2017-04-05 19:57:35 +00:00
|
|
|
DiagramResponse(HttpServletResponse r, FileFormat f, HttpServletRequest rq) {
|
2011-03-29 16:15:53 +00:00
|
|
|
response = r;
|
|
|
|
format = f;
|
2017-04-05 19:57:35 +00:00
|
|
|
request = rq;
|
2011-03-29 16:15:53 +00:00
|
|
|
}
|
2013-07-10 15:07:24 +00:00
|
|
|
|
2017-04-05 19:57:35 +00:00
|
|
|
void sendDiagram(String uml, int idx) throws IOException {
|
2013-07-10 15:07:24 +00:00
|
|
|
response.setContentType(getContentType());
|
|
|
|
SourceStringReader reader = new SourceStringReader(uml);
|
2017-04-05 19:57:35 +00:00
|
|
|
final BlockUml blockUml = reader.getBlocks().get(0);
|
|
|
|
if (notModified(blockUml)) {
|
|
|
|
addHeaderForCache(blockUml);
|
|
|
|
response.sendError(HttpServletResponse.SC_NOT_MODIFIED);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
if (StringUtils.isDiagramCacheable(uml)) {
|
|
|
|
addHeaderForCache(blockUml);
|
|
|
|
}
|
2017-04-19 19:41:42 +00:00
|
|
|
reader.outputImage(response.getOutputStream(), new FileFormatOption(format, false));
|
2011-03-29 16:15:53 +00:00
|
|
|
}
|
2014-02-06 17:28:06 +00:00
|
|
|
|
2017-04-05 19:57:35 +00:00
|
|
|
private boolean notModified(BlockUml blockUml) {
|
|
|
|
final String ifNoneMatch = request.getHeader("If-None-Match");
|
|
|
|
final long ifModifiedSince = request.getDateHeader("If-Modified-Since");
|
|
|
|
if (ifModifiedSince != -1 && ifModifiedSince != blockUml.lastModified()) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
final String etag = blockUml.etag();
|
|
|
|
if (ifNoneMatch == null) {
|
|
|
|
return false;
|
2013-08-19 14:07:38 +00:00
|
|
|
}
|
2017-04-05 19:57:35 +00:00
|
|
|
return ifNoneMatch.contains(etag);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
void sendMap(String uml) throws IOException {
|
2013-08-19 14:07:38 +00:00
|
|
|
response.setContentType(getContentType());
|
|
|
|
SourceStringReader reader = new SourceStringReader(uml);
|
2017-04-05 19:57:35 +00:00
|
|
|
final BlockUml blockUml = reader.getBlocks().get(0);
|
|
|
|
if (StringUtils.isDiagramCacheable(uml)) {
|
|
|
|
addHeaderForCache(blockUml);
|
|
|
|
}
|
2017-04-19 19:41:42 +00:00
|
|
|
String map = reader.outputImage(new NullOutputStream(),
|
2017-04-05 19:57:35 +00:00
|
|
|
new FileFormatOption(FileFormat.PNG, false)).getDescription();
|
2013-08-14 07:44:19 +00:00
|
|
|
String[] mapLines = map.split("[\\r\\n]");
|
2013-09-13 17:55:07 +00:00
|
|
|
PrintWriter httpOut = response.getWriter();
|
2014-02-06 17:28:06 +00:00
|
|
|
for (int i = 2; (i + 1) < mapLines.length; i++) {
|
2013-08-19 14:07:38 +00:00
|
|
|
httpOut.print(mapLines[i]);
|
|
|
|
}
|
2013-08-14 07:44:19 +00:00
|
|
|
}
|
2014-02-06 17:28:06 +00:00
|
|
|
|
2014-02-06 23:08:25 +00:00
|
|
|
void sendCheck(String uml) throws IOException {
|
|
|
|
response.setContentType(getContentType());
|
|
|
|
SourceStringReader reader = new SourceStringReader(uml);
|
2017-04-19 19:41:42 +00:00
|
|
|
DiagramDescription desc = reader.outputImage(
|
2014-02-06 23:08:25 +00:00
|
|
|
new NullOutputStream(), new FileFormatOption(FileFormat.PNG, false));
|
|
|
|
PrintWriter httpOut = response.getWriter();
|
|
|
|
httpOut.print(desc.getDescription());
|
|
|
|
}
|
2017-04-05 19:57:35 +00:00
|
|
|
private void addHeaderForCache(BlockUml blockUml) {
|
2013-08-14 07:44:19 +00:00
|
|
|
long today = System.currentTimeMillis();
|
|
|
|
// Add http headers to force the browser to cache the image
|
2017-04-05 19:57:35 +00:00
|
|
|
final int maxAge = 3600 * 24 * 5;
|
|
|
|
response.addDateHeader("Expires", today + 1000L * maxAge);
|
|
|
|
response.addDateHeader("Date", today);
|
|
|
|
|
|
|
|
response.addDateHeader("Last-Modified", blockUml.lastModified());
|
|
|
|
response.addHeader("Cache-Control", "public, max-age=" + maxAge);
|
|
|
|
// response.addHeader("Cache-Control", "max-age=864000");
|
|
|
|
response.addHeader("Etag", "\"" + blockUml.etag() + "\"");
|
|
|
|
final Diagram diagram = blockUml.getDiagram();
|
|
|
|
response.addHeader("X-PlantUML-Diagram-Description", diagram.getDescription().getDescription());
|
|
|
|
if (diagram instanceof PSystemError) {
|
|
|
|
final PSystemError error = (PSystemError) diagram;
|
|
|
|
for (ErrorUml err : error.getErrorsUml()) {
|
|
|
|
response.addHeader("X-PlantUML-Diagram-Error", err.getError());
|
|
|
|
response.addHeader("X-PlantUML-Diagram-Error-Line", "" + err.getPosition());
|
|
|
|
}
|
|
|
|
}
|
|
|
|
addHeaders(response);
|
2013-08-14 07:44:19 +00:00
|
|
|
}
|
2014-02-06 17:28:06 +00:00
|
|
|
|
2017-04-05 19:57:35 +00:00
|
|
|
public static void addHeaders(HttpServletResponse response) {
|
|
|
|
response.addHeader("X-Powered-By", POWERED_BY);
|
|
|
|
response.addHeader("X-Patreon", "Support us on http://plantuml.com/patreon");
|
|
|
|
response.addHeader("X-Donate", "http://plantuml.com/paypal");
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2011-03-29 16:15:53 +00:00
|
|
|
private String getContentType() {
|
2014-02-15 18:04:30 +00:00
|
|
|
return CONTENT_TYPE.get(format);
|
2011-03-29 16:15:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
}
|