This problem is caused by the class grails.plugin.rendering.document.RenderEnvironment of the plugin that attaches a mocked version of the original request for rendering. When RenderEnvironment copies the attributes of the original request, it omits to copy the contextPath variable, which it is used by some tags like r:layoutResources to build the path of the referenced resource (e.g CSS or Images).
There are two options to fix the bug: create a new grails.plugin.rendering.document.RenderEnvironment class in the src/groovy folder which will override the plugin class. The second option it to modify the init method in RenderEnvironment through metaClass. I chose to implement it with the metaClass option, so I created a groovy class defined as follows:
class RenderEnvironmentFix {
static void doFixWithMetaclass(){
grails.plugin.rendering.document.RenderEnvironment.metaClass.init {
originalRequestAttributes = RequestContextHolder.getRequestAttributes()
def renderRequest = new MockHttpServletRequest(applicationContext.getServletContext())
renderRequest.contextPath = originalRequestAttributes.contextPath
renderRequestAttributes = GrailsWebUtil.bindMockWebRequest(
applicationContext,
renderRequest,
new MockHttpServletResponse())
if (originalRequestAttributes) {
renderRequestAttributes.controllerName = originalRequestAttributes.controllerName
}
def renderLocale
if (locale) {
renderLocale = locale
} else if (originalRequestAttributes) {
renderLocale = RequestContextUtils.getLocale(originalRequestAttributes.request)
}
renderLocale = locale
} else if (originalRequestAttributes) {
renderLocale = RequestContextUtils.getLocale(originalRequestAttributes.request)
}
renderRequestAttributes.request.setAttribute(
DispatcherServlet.LOCALE_RESOLVER_ATTRIBUTE,
new FixedLocaleResolver(defaultLocale: renderLocale))
renderRequestAttributes.setOut(out)
WrappedResponseHolder.wrappedResponse = renderRequestAttributes.currentResponse
}
}
It is a clone of the code in RenderEnvironment, but it also copies the contextPath to the mocked request.
To apply the patch invoke RenderEnvironmentFix.doFixWithMetaclass() from the Bootstrap.groovy file.
As a example consider an application named book and a BookController with actions:
def index() {
render(template: "hello")
}
def pdf(){
renderPdf(template: "hello")
}
and template _hello.gsp:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<r:require module="style" />
<r:layoutResources />
</head>
<body>
<h1 class="title">Title should be blue</h1>
</body>
</html>
where module "style" includes resource "/css/style.css" and it is defined:
h1.title{
color: blue;
}
Without the patch the generated html for rendering the PDF looks like:
...
<link href="/static/css/style.css" type="text/css" rel="stylesheet" media="screen, projection, print" />
...
clearly the path for the style.css file is wrong which will cause the PDF file to be rendered without applying the styles.
After applying the patch the generated html for rendering looks like:
...
<link href="/book/static/css/style.css" type="text/css" rel="stylesheet" media="screen, projection, print" />
...
PS: Do not forget to define grails.serverURL because the rendering plugin uses it.
WrappedResponseHolder.wrappedResponse = renderRequestAttributes.currentResponse
}
}
It is a clone of the code in RenderEnvironment, but it also copies the contextPath to the mocked request.
To apply the patch invoke RenderEnvironmentFix.doFixWithMetaclass() from the Bootstrap.groovy file.
As a example consider an application named book and a BookController with actions:
def index() {
render(template: "hello")
}
def pdf(){
renderPdf(template: "hello")
}
and template _hello.gsp:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<r:require module="style" />
<r:layoutResources />
</head>
<body>
<h1 class="title">Title should be blue</h1>
</body>
</html>
where module "style" includes resource "/css/style.css" and it is defined:
h1.title{
color: blue;
}
Without the patch the generated html for rendering the PDF looks like:
...
<link href="/static/css/style.css" type="text/css" rel="stylesheet" media="screen, projection, print" />
...
clearly the path for the style.css file is wrong which will cause the PDF file to be rendered without applying the styles.
After applying the patch the generated html for rendering looks like:
...
<link href="/book/static/css/style.css" type="text/css" rel="stylesheet" media="screen, projection, print" />
...
PS: Do not forget to define grails.serverURL because the rendering plugin uses it.
This comment has been removed by the author.
ReplyDeleteHi
ReplyDeleteI read your post. Its a good explanation that how to use resources.I need to include my own font into pdf using rendering plugin. I am using it like this.
@media print{
@font-face {
src: url(${grailsApplication.config.grails.serverURL}/images/templateImages/template10/Philosopher-Regular.ttf);
-fs-pdf-font-embed: embed;
-fs-pdf-font-encoding: cp1252;
font-family: "philosopher";
}
body {
font-family: "philosopher";
}
}
when I open my gsp page in browser it show with my font,but when I try to generate pdf , pdf show its own font not my included font. I am confused how to import external font in pdf.
Hi
ReplyDeleteI haven't really tried this, but as the underlying implementation of the rendering plugin is flying saucer you could try something like this https://code.google.com/p/flying-saucer/wiki/FAQPDF#Embedding_fonts_using_CSS_@font-face in your css file.
I´ve tried it but it doesn´t work with grails 2.3.1.
ReplyDeleteCould it be the grails version?
I have this patch applied in an application running grails 2.3.2 and rendering plugin 0.4.4 and it works. Did you called the method RenderEnvironmentFix.doFixWithMetaclass() from Bootstrap.groovy?
DeleteThis comment has been removed by the author.
ReplyDeleteThe
ReplyDeleter:require module="style"
r:layoutResources
tags on gsp layout throw an error on my app, withough it, the plugin runs as i spected.
Thanks