001
014
015 package com.liferay.portal.layoutconfiguration.util;
016
017 import com.liferay.portal.kernel.executor.PortalExecutorManagerUtil;
018 import com.liferay.portal.kernel.io.unsync.UnsyncStringWriter;
019 import com.liferay.portal.kernel.log.Log;
020 import com.liferay.portal.kernel.log.LogFactoryUtil;
021 import com.liferay.portal.kernel.security.pacl.DoPrivileged;
022 import com.liferay.portal.kernel.servlet.PipingServletResponse;
023 import com.liferay.portal.kernel.servlet.PluginContextListener;
024 import com.liferay.portal.kernel.servlet.ServletContextPool;
025 import com.liferay.portal.kernel.template.Template;
026 import com.liferay.portal.kernel.template.TemplateConstants;
027 import com.liferay.portal.kernel.template.TemplateManagerUtil;
028 import com.liferay.portal.kernel.template.TemplateResource;
029 import com.liferay.portal.kernel.util.GetterUtil;
030 import com.liferay.portal.kernel.util.JavaConstants;
031 import com.liferay.portal.kernel.util.ObjectValuePair;
032 import com.liferay.portal.kernel.util.StringBundler;
033 import com.liferay.portal.kernel.util.StringPool;
034 import com.liferay.portal.kernel.util.StringUtil;
035 import com.liferay.portal.kernel.util.Validator;
036 import com.liferay.portal.layoutconfiguration.util.velocity.CustomizationSettingsProcessor;
037 import com.liferay.portal.layoutconfiguration.util.velocity.TemplateProcessor;
038 import com.liferay.portal.layoutconfiguration.util.xml.ActionURLLogic;
039 import com.liferay.portal.layoutconfiguration.util.xml.PortletLogic;
040 import com.liferay.portal.layoutconfiguration.util.xml.RenderURLLogic;
041 import com.liferay.portal.layoutconfiguration.util.xml.RuntimeLogic;
042 import com.liferay.portal.model.LayoutTemplate;
043 import com.liferay.portal.model.LayoutTemplateConstants;
044 import com.liferay.portal.model.Portlet;
045 import com.liferay.portal.model.PortletConstants;
046 import com.liferay.portal.service.LayoutTemplateLocalServiceUtil;
047 import com.liferay.portal.servlet.ThreadLocalFacadeServletRequestWrapperUtil;
048 import com.liferay.portal.util.ClassLoaderUtil;
049 import com.liferay.portal.util.PropsValues;
050 import com.liferay.portal.util.WebKeys;
051 import com.liferay.taglib.util.DummyVelocityTaglib;
052 import com.liferay.taglib.util.VelocityTaglib;
053 import com.liferay.taglib.util.VelocityTaglibImpl;
054
055 import java.io.Closeable;
056
057 import java.util.HashMap;
058 import java.util.List;
059 import java.util.Map;
060 import java.util.concurrent.Callable;
061 import java.util.concurrent.CancellationException;
062 import java.util.concurrent.ExecutionException;
063 import java.util.concurrent.ExecutorService;
064 import java.util.concurrent.Future;
065 import java.util.concurrent.FutureTask;
066 import java.util.concurrent.RejectedExecutionException;
067 import java.util.concurrent.TimeUnit;
068 import java.util.concurrent.TimeoutException;
069 import java.util.concurrent.locks.Lock;
070 import java.util.concurrent.locks.ReentrantLock;
071
072 import javax.portlet.PortletResponse;
073 import javax.portlet.RenderResponse;
074
075 import javax.servlet.ServletContext;
076 import javax.servlet.http.HttpServletRequest;
077 import javax.servlet.http.HttpServletResponse;
078 import javax.servlet.jsp.PageContext;
079
080 import org.apache.commons.lang.time.StopWatch;
081
082
087 @DoPrivileged
088 public class RuntimePageImpl implements RuntimePage {
089
090 @Override
091 public StringBundler getProcessedTemplate(
092 PageContext pageContext, String portletId,
093 TemplateResource templateResource)
094 throws Exception {
095
096 return doDispatch(pageContext, portletId, templateResource, true);
097 }
098
099 @Override
100 public void processCustomizationSettings(
101 PageContext pageContext, TemplateResource templateResource)
102 throws Exception {
103
104 doDispatch(pageContext, null, templateResource, false);
105 }
106
107 @Override
108 public void processTemplate(
109 PageContext pageContext, String portletId,
110 TemplateResource templateResource)
111 throws Exception {
112
113 StringBundler sb = doDispatch(
114 pageContext, portletId, templateResource, true);
115
116 sb.writeTo(pageContext.getOut());
117 }
118
119 @Override
120 public void processTemplate(
121 PageContext pageContext, TemplateResource templateResource)
122 throws Exception {
123
124 processTemplate(pageContext, null, templateResource);
125 }
126
127 @Override
128 public String processXML(
129 HttpServletRequest request, HttpServletResponse response,
130 String content)
131 throws Exception {
132
133 PortletResponse portletResponse = (PortletResponse)request.getAttribute(
134 JavaConstants.JAVAX_PORTLET_RESPONSE);
135
136 if ((portletResponse != null) &&
137 !(portletResponse instanceof RenderResponse)) {
138
139 throw new IllegalArgumentException(
140 "processXML can only be invoked in the render phase");
141 }
142
143 RuntimeLogic portletLogic = new PortletLogic(request, response);
144
145 content = processXML(request, content, portletLogic);
146
147 if (portletResponse == null) {
148 return content;
149 }
150
151 RenderResponse renderResponse = (RenderResponse)portletResponse;
152
153 RuntimeLogic actionURLLogic = new ActionURLLogic(renderResponse);
154 RuntimeLogic renderURLLogic = new RenderURLLogic(renderResponse);
155
156 content = processXML(request, content, actionURLLogic);
157 content = processXML(request, content, renderURLLogic);
158
159 return content;
160 }
161
162 @Override
163 public String processXML(
164 HttpServletRequest request, String content,
165 RuntimeLogic runtimeLogic)
166 throws Exception {
167
168 if (Validator.isNull(content)) {
169 return StringPool.BLANK;
170 }
171
172 int index = content.indexOf(runtimeLogic.getOpenTag());
173
174 if (index == -1) {
175 return content;
176 }
177
178 Portlet renderPortlet = (Portlet)request.getAttribute(
179 WebKeys.RENDER_PORTLET);
180
181 Boolean renderPortletResource = (Boolean)request.getAttribute(
182 WebKeys.RENDER_PORTLET_RESOURCE);
183
184 String outerPortletId = (String)request.getAttribute(
185 WebKeys.OUTER_PORTLET_ID);
186
187 if (outerPortletId == null) {
188 request.setAttribute(
189 WebKeys.OUTER_PORTLET_ID, renderPortlet.getPortletId());
190 }
191
192 try {
193 request.setAttribute(WebKeys.RENDER_PORTLET_RESOURCE, Boolean.TRUE);
194
195 StringBundler sb = new StringBundler();
196
197 int x = 0;
198 int y = index;
199
200 while (y != -1) {
201 sb.append(content.substring(x, y));
202
203 int close1 = content.indexOf(runtimeLogic.getClose1Tag(), y);
204 int close2 = content.indexOf(runtimeLogic.getClose2Tag(), y);
205
206 if ((close2 == -1) || ((close1 != -1) && (close1 < close2))) {
207 x = close1 + runtimeLogic.getClose1Tag().length();
208 }
209 else {
210 x = close2 + runtimeLogic.getClose2Tag().length();
211 }
212
213 String runtimePortletTag = content.substring(y, x);
214
215 if ((renderPortlet != null) &&
216 runtimePortletTag.contains(renderPortlet.getPortletId())) {
217
218 return StringPool.BLANK;
219 }
220
221 sb.append(runtimeLogic.processXML(runtimePortletTag));
222
223 y = content.indexOf(runtimeLogic.getOpenTag(), x);
224 }
225
226 if (y == -1) {
227 sb.append(content.substring(x));
228 }
229
230 return sb.toString();
231 }
232 finally {
233 if (outerPortletId == null) {
234 request.removeAttribute(WebKeys.OUTER_PORTLET_ID);
235 }
236
237 request.setAttribute(WebKeys.RENDER_PORTLET, renderPortlet);
238
239 if (renderPortletResource == null) {
240 request.removeAttribute(WebKeys.RENDER_PORTLET_RESOURCE);
241 }
242 else {
243 request.setAttribute(
244 WebKeys.RENDER_PORTLET_RESOURCE, renderPortletResource);
245 }
246 }
247 }
248
249 protected StringBundler doDispatch(
250 PageContext pageContext, String portletId,
251 TemplateResource templateResource, boolean processTemplate)
252 throws Exception {
253
254 ClassLoader pluginClassLoader = null;
255
256 LayoutTemplate layoutTemplate = getLayoutTemplate(
257 templateResource.getTemplateId());
258
259 if (layoutTemplate != null) {
260 String pluginServletContextName = GetterUtil.getString(
261 layoutTemplate.getServletContextName());
262
263 ServletContext pluginServletContext = ServletContextPool.get(
264 pluginServletContextName);
265
266 if (pluginServletContext != null) {
267 pluginClassLoader =
268 (ClassLoader)pluginServletContext.getAttribute(
269 PluginContextListener.PLUGIN_CLASS_LOADER);
270 }
271 }
272
273 ClassLoader contextClassLoader =
274 ClassLoaderUtil.getContextClassLoader();
275
276 try {
277 if ((pluginClassLoader != null) &&
278 (pluginClassLoader != contextClassLoader)) {
279
280 ClassLoaderUtil.setContextClassLoader(pluginClassLoader);
281 }
282
283 if (processTemplate) {
284 return doProcessTemplate(
285 pageContext, portletId, templateResource, false);
286 }
287 else {
288 doProcessCustomizationSettings(
289 pageContext, templateResource, false);
290
291 return null;
292 }
293 }
294 finally {
295 if ((pluginClassLoader != null) &&
296 (pluginClassLoader != contextClassLoader)) {
297
298 ClassLoaderUtil.setContextClassLoader(contextClassLoader);
299 }
300 }
301 }
302
303 protected void doProcessCustomizationSettings(
304 PageContext pageContext, TemplateResource templateResource,
305 boolean restricted)
306 throws Exception {
307
308 HttpServletRequest request =
309 (HttpServletRequest)pageContext.getRequest();
310
311 CustomizationSettingsProcessor processor =
312 new CustomizationSettingsProcessor(pageContext);
313
314 Template template = TemplateManagerUtil.getTemplate(
315 TemplateConstants.LANG_TYPE_VM, templateResource, restricted);
316
317 template.put("processor", processor);
318
319
320
321 template.prepare(request);
322
323
324
325 VelocityTaglib velocityTaglib = new DummyVelocityTaglib();
326
327 template.put("taglibLiferay", velocityTaglib);
328 template.put("theme", velocityTaglib);
329
330 try {
331 template.processTemplate(pageContext.getOut());
332 }
333 catch (Exception e) {
334 _log.error(e, e);
335
336 throw e;
337 }
338 }
339
340 protected StringBundler doProcessTemplate(
341 PageContext pageContext, String portletId,
342 TemplateResource templateResource, boolean restricted)
343 throws Exception {
344
345 HttpServletRequest request =
346 (HttpServletRequest)pageContext.getRequest();
347 HttpServletResponse response =
348 (HttpServletResponse)pageContext.getResponse();
349
350 TemplateProcessor processor = new TemplateProcessor(
351 request, response, portletId);
352
353 Template template = TemplateManagerUtil.getTemplate(
354 TemplateConstants.LANG_TYPE_VM, templateResource, restricted);
355
356 template.put("processor", processor);
357
358
359
360 template.prepare(request);
361
362
363
364 UnsyncStringWriter unsyncStringWriter = new UnsyncStringWriter();
365
366 VelocityTaglib velocityTaglib = new VelocityTaglibImpl(
367 pageContext.getServletContext(), request,
368 new PipingServletResponse(response, unsyncStringWriter),
369 pageContext, template);
370
371 template.put("taglibLiferay", velocityTaglib);
372 template.put("theme", velocityTaglib);
373
374 try {
375 template.processTemplate(unsyncStringWriter);
376 }
377 catch (Exception e) {
378 _log.error(e, e);
379
380 throw e;
381 }
382
383 boolean portletParallelRender = GetterUtil.getBoolean(
384 request.getAttribute(WebKeys.PORTLET_PARALLEL_RENDER));
385
386 Lock lock = null;
387
388 Map<String, StringBundler> contentsMap =
389 new HashMap<String, StringBundler>();
390
391 Map<Integer, List<PortletRenderer>> portletRenderersMap =
392 processor.getPortletRenderers();
393
394 for (Map.Entry<Integer, List<PortletRenderer>> entry :
395 portletRenderersMap.entrySet()) {
396
397 if (_log.isDebugEnabled()) {
398 _log.debug(
399 "Processing portlets with render weight " + entry.getKey());
400 }
401
402 List<PortletRenderer> portletRenderers = entry.getValue();
403
404 StopWatch stopWatch = new StopWatch();
405
406 stopWatch.start();
407
408 if (portletParallelRender && (portletRenderers.size() > 1)) {
409 if (_log.isDebugEnabled()) {
410 _log.debug("Start parallel rendering");
411 }
412
413 if (lock == null) {
414 lock = new ReentrantLock();
415 }
416
417 request.setAttribute(
418 WebKeys.PARALLEL_RENDERING_MERGE_LOCK, lock);
419
420 ObjectValuePair<HttpServletRequest, Closeable> objectValuePair =
421 ThreadLocalFacadeServletRequestWrapperUtil.inject(request);
422
423 try {
424 parallelyRenderPortlets(
425 objectValuePair.getKey(), response, processor,
426 contentsMap, portletRenderers);
427 }
428 finally {
429 Closeable closeable = objectValuePair.getValue();
430
431 closeable.close();
432 }
433
434 request.removeAttribute(WebKeys.PARALLEL_RENDERING_MERGE_LOCK);
435
436 if (_log.isDebugEnabled()) {
437 _log.debug(
438 "Finished parallel rendering in " +
439 stopWatch.getTime() + " ms");
440 }
441 }
442 else {
443 if (_log.isDebugEnabled()) {
444 _log.debug("Start serial rendering");
445 }
446
447 for (PortletRenderer portletRenderer : portletRenderers) {
448 Portlet portlet = portletRenderer.getPortlet();
449
450 contentsMap.put(
451 portlet.getPortletId(),
452 portletRenderer.render(request, response));
453
454 if (_log.isDebugEnabled()) {
455 _log.debug(
456 "Serially rendered portlet " +
457 portlet.getPortletId() + " in " +
458 stopWatch.getTime() + " ms");
459 }
460 }
461
462 if (_log.isDebugEnabled()) {
463 _log.debug(
464 "Finished serial rendering in " + stopWatch.getTime() +
465 " ms");
466 }
467 }
468 }
469
470 if (portletParallelRender && (_waitTime == Integer.MAX_VALUE)) {
471 _waitTime = PropsValues.LAYOUT_PARALLEL_RENDER_TIMEOUT;
472 }
473
474 StringBundler sb = StringUtil.replaceWithStringBundler(
475 unsyncStringWriter.toString(), "[$TEMPLATE_PORTLET_", "$]",
476 contentsMap);
477
478 return sb;
479 }
480
481 protected LayoutTemplate getLayoutTemplate(String velocityTemplateId) {
482 String separator = LayoutTemplateConstants.CUSTOM_SEPARATOR;
483 boolean standard = false;
484
485 if (velocityTemplateId.contains(
486 LayoutTemplateConstants.STANDARD_SEPARATOR)) {
487
488 separator = LayoutTemplateConstants.STANDARD_SEPARATOR;
489 standard = true;
490 }
491
492 String layoutTemplateId = null;
493
494 String themeId = null;
495
496 int pos = velocityTemplateId.indexOf(separator);
497
498 if (pos != -1) {
499 layoutTemplateId = velocityTemplateId.substring(
500 pos + separator.length());
501
502 themeId = velocityTemplateId.substring(0, pos);
503 }
504
505 pos = layoutTemplateId.indexOf(PortletConstants.INSTANCE_SEPARATOR);
506
507 if (pos != -1) {
508 layoutTemplateId = layoutTemplateId.substring(
509 pos + PortletConstants.INSTANCE_SEPARATOR.length() + 1);
510
511 pos = layoutTemplateId.indexOf(StringPool.UNDERLINE);
512
513 layoutTemplateId = layoutTemplateId.substring(pos + 1);
514 }
515
516 return LayoutTemplateLocalServiceUtil.getLayoutTemplate(
517 layoutTemplateId, standard, themeId);
518 }
519
520 protected void parallelyRenderPortlets(
521 HttpServletRequest request, HttpServletResponse response,
522 TemplateProcessor processor, Map<String, StringBundler> contentsMap,
523 List<PortletRenderer> portletRenderers)
524 throws Exception {
525
526 ExecutorService executorService =
527 PortalExecutorManagerUtil.getPortalExecutor(
528 RuntimePageImpl.class.getName());
529
530 Map<Future<StringBundler>, PortletRenderer> futures =
531 new HashMap<Future<StringBundler>, PortletRenderer>(
532 portletRenderers.size());
533
534 for (PortletRenderer portletRenderer : portletRenderers) {
535 if (_log.isDebugEnabled()) {
536 Portlet portlet = portletRenderer.getPortlet();
537
538 _log.debug(
539 "Submit portlet " + portlet.getPortletId() +
540 " for parallel rendering");
541 }
542
543 Callable<StringBundler> renderCallable =
544 portletRenderer.getCallable(request, response);
545
546 Future<StringBundler> future = null;
547
548 try {
549 future = executorService.submit(renderCallable);
550 }
551 catch (RejectedExecutionException ree) {
552
553
554
555
556
557
558
559
560 future = new FutureTask<StringBundler>(renderCallable);
561
562
563
564 future.cancel(true);
565 }
566
567 futures.put(future, portletRenderer);
568 }
569
570 long waitTime = _waitTime;
571
572 for (Map.Entry<Future<StringBundler>, PortletRenderer> entry :
573 futures.entrySet()) {
574
575 Future<StringBundler> future = entry.getKey();
576 PortletRenderer portletRenderer = entry.getValue();
577
578 Portlet portlet = portletRenderer.getPortlet();
579
580 if (future.isCancelled()) {
581 if (_log.isDebugEnabled()) {
582 _log.debug(
583 "Reject portlet " + portlet.getPortletId() +
584 " for parallel rendering");
585 }
586 }
587 else if ((waitTime > 0) || future.isDone()) {
588 try {
589 long startTime = System.currentTimeMillis();
590
591 StringBundler sb = future.get(
592 waitTime, TimeUnit.MILLISECONDS);
593
594 long duration = System.currentTimeMillis() - startTime;
595
596 waitTime -= duration;
597
598 contentsMap.put(portlet.getPortletId(), sb);
599
600 portletRenderer.finishParallelRender();
601
602 if (_log.isDebugEnabled()) {
603 _log.debug(
604 "Parallely rendered portlet " +
605 portlet.getPortletId() + " in " + duration +
606 " ms");
607 }
608
609 continue;
610 }
611 catch (ExecutionException ee) {
612 throw ee;
613 }
614 catch (InterruptedException ie) {
615
616
617
618
619 waitTime = -1;
620 }
621 catch (TimeoutException te) {
622
623
624
625
626 waitTime = -1;
627 }
628 catch (CancellationException ce) {
629
630
631
632
633 if (_log.isDebugEnabled()) {
634 _log.debug(
635 "Asynchronized cancellation detected that should " +
636 "only be caused by a concurrent shutdown of " +
637 "the thread pool",
638 ce);
639 }
640
641 return;
642 }
643
644
645
646 future.cancel(true);
647 }
648
649 StringBundler sb = null;
650
651 if (processor.isPortletAjaxRender() && portlet.isAjaxable()) {
652 if (_log.isDebugEnabled()) {
653 _log.debug(
654 "Fall back to ajax rendering of portlet " +
655 portlet.getPortletId());
656 }
657
658 sb = portletRenderer.renderAjax(request, response);
659 }
660 else {
661 if (_log.isDebugEnabled()) {
662 if (processor.isPortletAjaxRender()) {
663 _log.debug(
664 "Fall back to an error message for portlet " +
665 portlet.getPortletId() +
666 " since it is not ajaxable");
667 }
668 else {
669 _log.debug(
670 "Fall back to an error message for portlet " +
671 portlet.getPortletId() +
672 " since ajax rendering is disabled");
673 }
674 }
675
676 sb = portletRenderer.renderError(request, response);
677 }
678
679 contentsMap.put(portlet.getPortletId(), sb);
680
681 portletRenderer.finishParallelRender();
682 }
683 }
684
685 private static Log _log = LogFactoryUtil.getLog(RuntimePageImpl.class);
686
687 private int _waitTime = Integer.MAX_VALUE;
688
689 }