1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20 package org.apache.myfaces.tobago.util;
21
22 import org.slf4j.Logger;
23 import org.slf4j.LoggerFactory;
24
25 import javax.faces.application.FacesMessage;
26 import javax.faces.application.ProjectStage;
27 import javax.faces.context.ExternalContext;
28 import javax.faces.context.FacesContext;
29 import javax.faces.event.PhaseEvent;
30 import javax.faces.event.PhaseId;
31 import javax.faces.event.PhaseListener;
32 import javax.servlet.http.HttpServletRequest;
33 import javax.servlet.http.HttpServletResponse;
34 import java.lang.invoke.MethodHandles;
35 import java.text.MessageFormat;
36 import java.util.Iterator;
37 import java.util.Map;
38
39 public class DebugPhaseListener implements PhaseListener {
40
41 private static final Logger LOG = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
42
43 private static final String KEY = DebugPhaseListener.class.getName() + "_ID_";
44
45 @Override
46 public void afterPhase(final PhaseEvent phaseEvent) {
47 final FacesContext facesContext = phaseEvent.getFacesContext();
48 final boolean productionMode = facesContext.isProjectStage(ProjectStage.Production);
49 if (facesContext.getResponseComplete() || productionMode) {
50 return;
51 }
52
53 if (LOG.isInfoEnabled()) {
54 final Long end = System.currentTimeMillis();
55 final Map<String, Object> map = facesContext.getExternalContext().getRequestMap();
56 map.put(KEY + phaseEvent.getPhaseId().getOrdinal() + "E", end);
57
58 if (LOG.isTraceEnabled()) {
59 LOG.trace("After Phase :" + phaseEvent.getPhaseId() + " Time=" + end);
60 }
61
62 if (LOG.isDebugEnabled()) {
63 final Long start = (Long) map.get(KEY + phaseEvent.getPhaseId().getOrdinal() + "S");
64 LOG.debug("Phase " + phaseEvent.getPhaseId() + " needs " + (end - start + " milliseconds"));
65 }
66
67 if (phaseEvent.getPhaseId().getOrdinal() == 6) {
68 if (LOG.isTraceEnabled()) {
69 final HttpServletResponse response = (HttpServletResponse) facesContext.getExternalContext().getResponse();
70 LOG.trace(" response Locale = '" + response.getLocale() + "'");
71 LOG.trace(" response ContentType = '" + response.getContentType() + "'");
72 LOG.trace(" response CharacterEncoding = '{" + response.getCharacterEncoding() + "}'");
73 }
74
75 final Long start = (Long) map.get(KEY + "1S");
76 if (start != null) {
77 LOG.info("Total response time : " + (end - start + " milliseconds"));
78 }
79 }
80 for (final Iterator iterator = facesContext.getClientIdsWithMessages(); iterator.hasNext();) {
81 final String clientId = (String) iterator.next();
82
83 for (final Iterator messageIterator = facesContext.getMessages(clientId); messageIterator.hasNext();) {
84 final FacesMessage msg = (FacesMessage) messageIterator.next();
85 LOG.info(MessageFormat.format("Faces message found."
86 + "\n Component: {0} \n Severity : {1}"
87 + "\n Summary : {2} \n Detail : {3}",
88 clientId, msg.getSeverity(), msg.getSummary(), msg.getDetail()));
89 }
90 }
91 }
92 }
93
94 @Override
95 public void beforePhase(final PhaseEvent phaseEvent) {
96 final FacesContext facesContext = phaseEvent.getFacesContext();
97 final boolean productionMode = facesContext.isProjectStage(ProjectStage.Production);
98 if (facesContext.getResponseComplete()) {
99 LOG.info("Response is completed.");
100 return;
101 }
102 if (productionMode) {
103 LOG.warn("DebugPhaseListener disabled, because the project stage is 'production'.");
104 return;
105 }
106
107 if (LOG.isInfoEnabled()) {
108 final PhaseId phaseId = phaseEvent.getPhaseId();
109 if (LOG.isDebugEnabled() || phaseId.getOrdinal() == 1) {
110
111 final ExternalContext externalContext = facesContext.getExternalContext();
112
113 if (LOG.isTraceEnabled() && PhaseId.RESTORE_VIEW == phaseId) {
114
115
116 final Object request = externalContext.getRequest();
117 if (request instanceof HttpServletRequest) {
118 final HttpServletRequest servletRequest = (HttpServletRequest) request;
119 LOG.trace("RequestURI = " + servletRequest.getRequestURI());
120 }
121 final Map headerMap = externalContext.getRequestHeaderMap();
122 for (final Object key : headerMap.keySet()) {
123 LOG.trace("Header : '" + key + "' = '" + headerMap.get(key) + "'");
124 }
125 final Map parameterMap = externalContext.getRequestParameterMap();
126 for (final Object key : parameterMap.keySet()) {
127 LOG.trace("Param : '" + key + "' = '" + parameterMap.get(key) + "'");
128 }
129 }
130
131 final Long start = System.currentTimeMillis();
132 final Map<String, Object> map = externalContext.getRequestMap();
133 map.put(KEY + phaseId.getOrdinal() + "S", start);
134
135 if (LOG.isDebugEnabled()) {
136 Long end = null;
137 int ordinal = phaseId.getOrdinal();
138 while (end == null && ordinal > 0) {
139 end = (Long) map.get(KEY + --ordinal + "E");
140 }
141 if (end != null) {
142 LOG.debug("Time between phases " + ordinal + " and " + phaseId.getOrdinal() + ": "
143 + (start - end) + " milliseconds");
144 }
145 }
146 if (LOG.isTraceEnabled()) {
147 LOG.trace("Before Phase :" + phaseId + " Time=" + start);
148 }
149 }
150 }
151 }
152
153 @Override
154 public PhaseId getPhaseId() {
155 return PhaseId.ANY_PHASE;
156 }
157 }