lib/server-core/src/main/java/org/apache/olingo/server/core/debug/DebugResponseHelperImpl.java - olingo-odata4 - Git at Google

 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements. See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership. The ASF licenses this file
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License. You may obtain a copy of the License at
  *
  * http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  * KIND, either express or implied. See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */
 package org.apache.olingo.server.core.debug;

 import java.io.ByteArrayInputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.io.StringWriter;
 import java.io.Writer;
 import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;

 import org.apache.olingo.commons.api.ex.ODataRuntimeException;
 import org.apache.olingo.commons.api.format.ContentType;
 import org.apache.olingo.commons.api.http.HttpHeader;
 import org.apache.olingo.commons.api.http.HttpStatusCode;
 import org.apache.olingo.server.api.ODataResponse;
 import org.apache.olingo.server.api.debug.DebugInformation;
 import org.apache.olingo.server.api.debug.DebugResponseHelper;
 import org.apache.olingo.server.api.debug.DebugSupport;
 import org.apache.olingo.server.api.debug.RuntimeMeasurement;
 import org.apache.olingo.server.core.serializer.utils.CircleStreamBuffer;

 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.databind.ObjectMapper;

 public class DebugResponseHelperImpl implements DebugResponseHelper {

   private enum DebugFormat {
     JSON, HTML, DOWNLOAD
   }

   private final DebugFormat requestedFormat;

   public DebugResponseHelperImpl(final String debugFormat) {
     if (DebugSupport.ODATA_DEBUG_HTML.equals(debugFormat)) {
       requestedFormat = DebugFormat.HTML;
     } else if (DebugSupport.ODATA_DEBUG_DOWNLOAD.equals(debugFormat)) {
       requestedFormat = DebugFormat.DOWNLOAD;
     } else {
       requestedFormat = DebugFormat.JSON;
     }
   }

   @Override
   public ODataResponse createDebugResponse(final DebugInformation debugInfo) {
     try {
       final List<DebugTab> parts = createParts(debugInfo);

       ODataResponse response = new ODataResponse();
       final String contentTypeString;
       final InputStream body;
       if (requestedFormat == DebugFormat.DOWNLOAD || requestedFormat == DebugFormat.HTML) {
         String title = debugInfo.getRequest() == null ?
             "V4 Service" : "V4 Service: " + debugInfo.getRequest().getRawODataPath();
         body = wrapInHtml(parts, title);
         contentTypeString = ContentType.TEXT_HTML.toContentTypeString();
       } else {
         // for JSON and also default response handling
         body = wrapInJson(parts);
         contentTypeString = ContentType.APPLICATION_JSON.toContentTypeString();
       }
       // for download add additional Content-Disposition header
       if (requestedFormat == DebugFormat.DOWNLOAD) {
         response.setHeader("Content-Disposition", "attachment; filename=OData-Response."
             + new Date().toString().replace(' ', '_').replace(':', '.') + ".html");
       }
       response.setStatusCode(HttpStatusCode.OK.getStatusCode());
       response.setHeader(HttpHeader.CONTENT_TYPE, contentTypeString);
       response.setContent(body);

       return response;
     } catch (IOException e) {
       // Should not happen. In case it does the library will deliver a default response. So no handling here.
       throw new ODataRuntimeException(e);
     }
   }

   private List<DebugTab> createParts(final DebugInformation debugInfo) {
     List<DebugTab> parts = new ArrayList<>();

     // request
     parts.add(new DebugTabRequest(debugInfo.getRequest()));

     // response
     parts.add(new DebugTabResponse(debugInfo.getApplicationResponse()));

     // server
     Map<String, String> serverEnvironmentVariables = debugInfo.getServerEnvironmentVariables();
     if (serverEnvironmentVariables != null && !serverEnvironmentVariables.isEmpty()) {
       parts.add(new DebugTabServer(serverEnvironmentVariables));
     }

     // URI
     if (debugInfo.getUriInfo() != null) {
       parts.add(new DebugTabUri(debugInfo.getUriInfo()));
     }

     // runtime measurements
     List<RuntimeMeasurement> runtimeInformation = debugInfo.getRuntimeInformation();
     if (runtimeInformation != null && !runtimeInformation.isEmpty()) {
       parts.add(new DebugTabRuntime(runtimeInformation));
     }

     // exceptions
     if (debugInfo.getException() != null) {
       parts.add(new DebugTabStacktrace(debugInfo.getException()));
     }

     return parts;
   }

   private InputStream wrapInJson(final List<DebugTab> parts) throws IOException {
     OutputStream outputStream = null;
     CircleStreamBuffer csb = new CircleStreamBuffer();
     outputStream = csb.getOutputStream();
     // Create JSON generator (the object mapper is necessary to write expression trees).
     try (JsonGenerator gen = new ObjectMapper().getFactory().createGenerator(outputStream)) {
       gen.writeStartObject();
       DebugTab requestInfo = parts.get(0);
       gen.writeFieldName(requestInfo.getName().toLowerCase(Locale.ROOT));
       requestInfo.appendJson(gen);

       DebugTab responseInfo = parts.get(1);
       gen.writeFieldName(responseInfo.getName().toLowerCase(Locale.ROOT));
       responseInfo.appendJson(gen);

       gen.writeFieldName("server");
       gen.writeStartObject();
       gen.writeStringField("version", getVersion());
       for (DebugTab part : parts.subList(2, parts.size())) {
         gen.writeFieldName(part.getName().toLowerCase(Locale.ROOT));
         part.appendJson(gen);
       }
       gen.writeEndObject();

       gen.writeEndObject();
       gen.close();
       return csb.getInputStream();
     } finally {
       if (outputStream != null) {
         outputStream.close();
       }
     }
   }

   /**
    * Gets version field information for response. Result is never null.
    * @return version field information
    */
   protected static String getVersion() {
     final Package pack = DebugResponseHelperImpl.class.getPackage();
     final String name = pack.getImplementationTitle();
     final String version = pack.getImplementationVersion();
     return (name == null ? "Olingo" : name)
         + (version == null ? "" : " Version " + version);
   }

   private InputStream wrapInHtml(final List<DebugTab> parts, final String title) throws IOException {
     StringWriter writer = new StringWriter();

     writer.append("<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1//EN\"\n")
         .append("  \"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd\">\n")
         .append("<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\">\n")
         .append("<head>\n")
         .append("<meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\" />\n")
         .append("<title>")
         .append(escapeHtml(title))
         .append("</title>\n")
         .append("<style type=\"text/css\">\n")
         .append("body { font-family: Arial, sans-serif; font-size: 13px;\n")
         .append("       line-height: 16px; margin: 0;\n")
         .append("       background-color: #eeeeee; color: #333333; }\n")
         .append(".header { float: left; }\n")
         .append(".header a { line-height: 22px; padding: 10px 18px;\n")
         .append("            text-decoration: none; color: #333333; }\n")
         .append(":target, .header:nth-last-child(2) { background-color: #cccccc; }\n")
         .append(":target ~ .header:nth-last-child(2) { background-color: inherit; }\n")
         .append(".header:focus, .header:hover,\n")
         .append("  .header:nth-last-child(2):focus, .header:nth-last-child(2):hover\n")
         .append("    { background-color: #999999; }\n")
         .append(".section { position: absolute; top: 42px; min-width: 100%;\n")
         .append("           padding-top: 18px; border-top: 1px solid #dddddd; }\n")
         .append(".section > * { margin-left: 18px; }\n")
         .append(":target + .section, .section:last-child { display: block; }\n")
         .append(".section, :target + .section ~ .section { display: none; }\n")
         .append("h1 { font-size: 18px; font-weight: normal; margin: 10px 0; }\n")
         .append("h2 { font-size: 15px; }\n")
         .append("h2:not(:first-child) { margin-top: 2em; }\n")
         .append("table { border-collapse: collapse; border-spacing: 0;\n")
         .append("        margin-top: 1.5em; }\n")
         .append("table, thead { border-width: 1px 0; border-style: solid;\n")
         .append("               border-color: #dddddd; text-align: left; }\n")
         .append("th.name, td.name { padding: 1ex 2em 1ex 0; }\n")
         .append("tbody > tr:hover { background-color: #cccccc; }\n")
         .append(".code { font-family: \"Courier New\", monospace; }\n")
         .append(".code, .tree li { line-height: 15px; }\n")
         .append("ul, .tree { padding-left: 0; list-style-type: none; }\n")
         .append(".null, .numeric { padding-left: 1.5em; }\n")
         .append(".json { white-space: pre-wrap; }\n")
         .append("</style>\n")
         .append("</head>\n")
         .append("<body>\n");
     char count = '0';
     for (final DebugTab part : parts) {
       writer.append("<div class=\"header\" id=\"sec").append(++count).append("\">\n")
           .append("<h1><a href=\"#sec").append(count).append("\">")
           .append(part.getName())
           .append("</a></h1>\n")
           .append("</div>\n")
           .append("<div class=\"section\">\n");
       part.appendHtml(writer);
       writer.append("</div>\n");
     }
     writer.append("</body>\n")
         .append("</html>\n")
         .close();
     byte[] bytes = writer.toString().getBytes("UTF-8");
     return new ByteArrayInputStream(bytes);
   }

   protected static String escapeHtml(final String value) {
     return value == null ? null : value.replace("&", "&amp;").replace("<", "&lt;").replace(">", "&gt;");
   }

   protected static void appendJsonTable(final JsonGenerator gen, final Map<String, String> entries)
       throws IOException {
     if (entries == null || entries.isEmpty()) {
       gen.writeNull();
     } else {
       gen.writeStartObject();
       for (final Map.Entry<String, String> entry : entries.entrySet()) {
         gen.writeFieldName(entry.getKey());
         if (entry.getValue() == null) {
           gen.writeNull();
         } else {
           gen.writeString(entry.getValue());
         }
       }
       gen.writeEndObject();
     }
   }

   protected static void appendHtmlTable(final Writer writer, final Map<String, String> entries) throws IOException {
     writer.append("<table>\n<thead>\n")
         .append("<tr><th class=\"name\">Name</th><th class=\"value\">Value</th></tr>\n")
         .append("</thead>\n<tbody>\n");
     if (entries != null && !entries.isEmpty()) {
       for (final Map.Entry<String, String> entry : entries.entrySet()) {
         writer.append("<tr><td class=\"name\">").append(entry.getKey()).append("</td>")
             .append("<td class=\"value\">")
             .append(escapeHtml(entry.getValue()))
             .append("</td></tr>\n");
       }
     }
     writer.append("</tbody>\n</table>\n");
   }
 }
	/*
	* Licensed to the Apache Software Foundation (ASF) under one
	* or more contributor license agreements. See the NOTICE file
	* distributed with this work for additional information
	* regarding copyright ownership. The ASF licenses this file
	* to you under the Apache License, Version 2.0 (the
	* "License"); you may not use this file except in compliance
	* with the License. You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing,
	* software distributed under the License is distributed on an
	* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	* KIND, either express or implied. See the License for the
	* specific language governing permissions and limitations
	* under the License.
	*/
	package org.apache.olingo.server.core.debug;

	import java.io.ByteArrayInputStream;
	import java.io.IOException;
	import java.io.InputStream;
	import java.io.OutputStream;
	import java.io.StringWriter;
	import java.io.Writer;
	import java.util.ArrayList;
	import java.util.Date;
	import java.util.List;
	import java.util.Locale;
	import java.util.Map;

	import org.apache.olingo.commons.api.ex.ODataRuntimeException;
	import org.apache.olingo.commons.api.format.ContentType;
	import org.apache.olingo.commons.api.http.HttpHeader;
	import org.apache.olingo.commons.api.http.HttpStatusCode;
	import org.apache.olingo.server.api.ODataResponse;
	import org.apache.olingo.server.api.debug.DebugInformation;
	import org.apache.olingo.server.api.debug.DebugResponseHelper;
	import org.apache.olingo.server.api.debug.DebugSupport;
	import org.apache.olingo.server.api.debug.RuntimeMeasurement;
	import org.apache.olingo.server.core.serializer.utils.CircleStreamBuffer;

	import com.fasterxml.jackson.core.JsonGenerator;
	import com.fasterxml.jackson.databind.ObjectMapper;

	public class DebugResponseHelperImpl implements DebugResponseHelper {

	private enum DebugFormat {
	JSON, HTML, DOWNLOAD
	}

	private final DebugFormat requestedFormat;

	public DebugResponseHelperImpl(final String debugFormat) {
	if (DebugSupport.ODATA_DEBUG_HTML.equals(debugFormat)) {
	requestedFormat = DebugFormat.HTML;
	} else if (DebugSupport.ODATA_DEBUG_DOWNLOAD.equals(debugFormat)) {
	requestedFormat = DebugFormat.DOWNLOAD;
	} else {
	requestedFormat = DebugFormat.JSON;
	}
	}

	@Override
	public ODataResponse createDebugResponse(final DebugInformation debugInfo) {
	try {
	final List<DebugTab> parts = createParts(debugInfo);

	ODataResponse response = new ODataResponse();
	final String contentTypeString;
	final InputStream body;
	if (requestedFormat == DebugFormat.DOWNLOAD \|\| requestedFormat == DebugFormat.HTML) {
	String title = debugInfo.getRequest() == null ?
	"V4 Service" : "V4 Service: " + debugInfo.getRequest().getRawODataPath();
	body = wrapInHtml(parts, title);
	contentTypeString = ContentType.TEXT_HTML.toContentTypeString();
	} else {
	// for JSON and also default response handling
	body = wrapInJson(parts);
	contentTypeString = ContentType.APPLICATION_JSON.toContentTypeString();
	}
	// for download add additional Content-Disposition header
	if (requestedFormat == DebugFormat.DOWNLOAD) {
	response.setHeader("Content-Disposition", "attachment; filename=OData-Response."
	+ new Date().toString().replace(' ', '_').replace(':', '.') + ".html");
	}
	response.setStatusCode(HttpStatusCode.OK.getStatusCode());
	response.setHeader(HttpHeader.CONTENT_TYPE, contentTypeString);
	response.setContent(body);

	return response;
	} catch (IOException e) {
	// Should not happen. In case it does the library will deliver a default response. So no handling here.
	throw new ODataRuntimeException(e);
	}
	}

	private List<DebugTab> createParts(final DebugInformation debugInfo) {
	List<DebugTab> parts = new ArrayList<>();

	// request
	parts.add(new DebugTabRequest(debugInfo.getRequest()));

	// response
	parts.add(new DebugTabResponse(debugInfo.getApplicationResponse()));

	// server
	Map<String, String> serverEnvironmentVariables = debugInfo.getServerEnvironmentVariables();
	if (serverEnvironmentVariables != null && !serverEnvironmentVariables.isEmpty()) {
	parts.add(new DebugTabServer(serverEnvironmentVariables));
	}

	// URI
	if (debugInfo.getUriInfo() != null) {
	parts.add(new DebugTabUri(debugInfo.getUriInfo()));
	}

	// runtime measurements
	List<RuntimeMeasurement> runtimeInformation = debugInfo.getRuntimeInformation();
	if (runtimeInformation != null && !runtimeInformation.isEmpty()) {
	parts.add(new DebugTabRuntime(runtimeInformation));
	}

	// exceptions
	if (debugInfo.getException() != null) {
	parts.add(new DebugTabStacktrace(debugInfo.getException()));
	}

	return parts;
	}

	private InputStream wrapInJson(final List<DebugTab> parts) throws IOException {
	OutputStream outputStream = null;
	CircleStreamBuffer csb = new CircleStreamBuffer();
	outputStream = csb.getOutputStream();
	// Create JSON generator (the object mapper is necessary to write expression trees).
	try (JsonGenerator gen = new ObjectMapper().getFactory().createGenerator(outputStream)) {
	gen.writeStartObject();
	DebugTab requestInfo = parts.get(0);
	gen.writeFieldName(requestInfo.getName().toLowerCase(Locale.ROOT));
	requestInfo.appendJson(gen);

	DebugTab responseInfo = parts.get(1);
	gen.writeFieldName(responseInfo.getName().toLowerCase(Locale.ROOT));
	responseInfo.appendJson(gen);

	gen.writeFieldName("server");
	gen.writeStartObject();
	gen.writeStringField("version", getVersion());
	for (DebugTab part : parts.subList(2, parts.size())) {
	gen.writeFieldName(part.getName().toLowerCase(Locale.ROOT));
	part.appendJson(gen);
	}
	gen.writeEndObject();

	gen.writeEndObject();
	gen.close();
	return csb.getInputStream();
	} finally {
	if (outputStream != null) {
	outputStream.close();
	}
	}
	}

	/**
	* Gets version field information for response. Result is never null.
	* @return version field information
	*/
	protected static String getVersion() {
	final Package pack = DebugResponseHelperImpl.class.getPackage();
	final String name = pack.getImplementationTitle();
	final String version = pack.getImplementationVersion();
	return (name == null ? "Olingo" : name)
	+ (version == null ? "" : " Version " + version);
	}

	private InputStream wrapInHtml(final List<DebugTab> parts, final String title) throws IOException {
	StringWriter writer = new StringWriter();

	writer.append("<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1//EN\"\n")
	.append(" \"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd\">\n")
	.append("<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\">\n")
	.append("<head>\n")
	.append("<meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\" />\n")
	.append("<title>")
	.append(escapeHtml(title))
	.append("</title>\n")
	.append("<style type=\"text/css\">\n")
	.append("body { font-family: Arial, sans-serif; font-size: 13px;\n")
	.append(" line-height: 16px; margin: 0;\n")
	.append(" background-color: #eeeeee; color: #333333; }\n")
	.append(".header { float: left; }\n")
	.append(".header a { line-height: 22px; padding: 10px 18px;\n")
	.append(" text-decoration: none; color: #333333; }\n")
	.append(":target, .header:nth-last-child(2) { background-color: #cccccc; }\n")
	.append(":target ~ .header:nth-last-child(2) { background-color: inherit; }\n")
	.append(".header:focus, .header:hover,\n")
	.append(" .header:nth-last-child(2):focus, .header:nth-last-child(2):hover\n")
	.append(" { background-color: #999999; }\n")
	.append(".section { position: absolute; top: 42px; min-width: 100%;\n")
	.append(" padding-top: 18px; border-top: 1px solid #dddddd; }\n")
	.append(".section > * { margin-left: 18px; }\n")
	.append(":target + .section, .section:last-child { display: block; }\n")
	.append(".section, :target + .section ~ .section { display: none; }\n")
	.append("h1 { font-size: 18px; font-weight: normal; margin: 10px 0; }\n")
	.append("h2 { font-size: 15px; }\n")
	.append("h2:not(:first-child) { margin-top: 2em; }\n")
	.append("table { border-collapse: collapse; border-spacing: 0;\n")
	.append(" margin-top: 1.5em; }\n")
	.append("table, thead { border-width: 1px 0; border-style: solid;\n")
	.append(" border-color: #dddddd; text-align: left; }\n")
	.append("th.name, td.name { padding: 1ex 2em 1ex 0; }\n")
	.append("tbody > tr:hover { background-color: #cccccc; }\n")
	.append(".code { font-family: \"Courier New\", monospace; }\n")
	.append(".code, .tree li { line-height: 15px; }\n")
	.append("ul, .tree { padding-left: 0; list-style-type: none; }\n")
	.append(".null, .numeric { padding-left: 1.5em; }\n")
	.append(".json { white-space: pre-wrap; }\n")
	.append("</style>\n")
	.append("</head>\n")
	.append("<body>\n");
	char count = '0';
	for (final DebugTab part : parts) {
	writer.append("<div class=\"header\" id=\"sec").append(++count).append("\">\n")
	.append("<h1><a href=\"#sec").append(count).append("\">")
	.append(part.getName())
	.append("</a></h1>\n")
	.append("</div>\n")
	.append("<div class=\"section\">\n");
	part.appendHtml(writer);
	writer.append("</div>\n");
	}
	writer.append("</body>\n")
	.append("</html>\n")
	.close();
	byte[] bytes = writer.toString().getBytes("UTF-8");
	return new ByteArrayInputStream(bytes);
	}

	protected static String escapeHtml(final String value) {
	return value == null ? null : value.replace("&", "&").replace("<", "<").replace(">", ">");
	}

	protected static void appendJsonTable(final JsonGenerator gen, final Map<String, String> entries)
	throws IOException {
	if (entries == null \|\| entries.isEmpty()) {
	gen.writeNull();
	} else {
	gen.writeStartObject();
	for (final Map.Entry<String, String> entry : entries.entrySet()) {
	gen.writeFieldName(entry.getKey());
	if (entry.getValue() == null) {
	gen.writeNull();
	} else {
	gen.writeString(entry.getValue());
	}
	}
	gen.writeEndObject();
	}
	}

	protected static void appendHtmlTable(final Writer writer, final Map<String, String> entries) throws IOException {
	writer.append("<table>\n<thead>\n")
	.append("<tr><th class=\"name\">Name</th><th class=\"value\">Value</th></tr>\n")
	.append("</thead>\n<tbody>\n");
	if (entries != null && !entries.isEmpty()) {
	for (final Map.Entry<String, String> entry : entries.entrySet()) {
	writer.append("<tr><td class=\"name\">").append(entry.getKey()).append("</td>")
	.append("<td class=\"value\">")
	.append(escapeHtml(entry.getValue()))
	.append("</td></tr>\n");
	}
	}
	writer.append("</tbody>\n</table>\n");
	}
	}