added lazy loading support for <f:dropdownListBlock>

This commit is contained in:
Kohsuke Kawaguchi committed 2011-04-21 13:39:45 -07:00
1 parent 4c83441302
commit 83d754b2e1
6 files changed
+71 -12

No files matched your search

-1
View File
@@ -70,7 +70,6 @@ import hudson.scm.SCMDescriptor;
import hudson.util.Secret;
import hudson.views.MyViewsTabBar;
import hudson.views.ViewsTabBar;
import hudson.widgets.HeteroListConfigPageRenderer;
import hudson.widgets.RenderOnDemandClosure;
import org.acegisecurity.providers.anonymous.AnonymousAuthenticationToken;
import org.apache.commons.jelly.JellyContext;
@@ -305,6 +305,11 @@ public abstract class Descriptor<T extends Describable<T>> implements Saveable {
*/
public static String getCurrentDescriptorByNameUrl() {
StaplerRequest req = Stapler.getCurrentRequest();
// this override allows RenderOnDemandClosure to preserve the proper value
Object url = req.getAttribute("currentDescriptorByNameUrl");
if (url!=null) return url.toString();
Ancestor a = req.findAncestor(DescriptorByNameOwner.class);
return a.getUrl();
}
@@ -24,12 +24,15 @@
package hudson.widgets;
import hudson.Util;
import hudson.model.DescriptorByNameOwner;
import hudson.util.IOException2;
import hudson.util.PackedMap;
import org.apache.commons.jelly.JellyContext;
import org.apache.commons.jelly.JellyTagException;
import org.apache.commons.jelly.Script;
import org.kohsuke.stapler.Ancestor;
import org.kohsuke.stapler.HttpResponse;
import org.kohsuke.stapler.Stapler;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
import org.kohsuke.stapler.bind.JavaScriptMethod;
@@ -37,8 +40,12 @@ import org.kohsuke.stapler.jelly.DefaultScriptInvoker;
import javax.servlet.ServletException;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* Captured Jelly {@link Script} that can be rendered later on demand from JavaScript.
@@ -46,15 +53,32 @@ import java.util.Map;
* @author Kohsuke Kawaguchi
*/
public class RenderOnDemandClosure {
private final Script body;
/**
* Captures the recursive taglib call stack.
*/
private final Script[] bodyStack;
private final Map<String,Object> variables;
private final String currentDescriptorByNameUrl;
public RenderOnDemandClosure(JellyContext context, String attributesToCapture) {
body = (Script) context.getVariable("org.apache.commons.jelly.body");
List<Script> bodyStack = new ArrayList<Script>();
for (JellyContext c = context; c!=null; c=c.getParent()) {
Script script = (Script) c.getVariables().get("org.apache.commons.jelly.body");
if(script!=null) bodyStack.add(script);
}
this.bodyStack = bodyStack.toArray(new Script[bodyStack.size()]);
assert !bodyStack.isEmpty(); // there must be at least one, which is the direct child of <l:renderOnDemand>
Map<String,Object> variables = new HashMap<String, Object>();
for (String v : Util.fixNull(attributesToCapture).split(","))
variables.put(v,context.getVariable(v));
// capture the current base of context for descriptors
StaplerRequest req = Stapler.getCurrentRequest();
Ancestor a = req.findAncestor(DescriptorByNameOwner.class);
currentDescriptorByNameUrl = a.getUrl();
this.variables = PackedMap.of(variables);
}
@@ -67,16 +91,30 @@ public class RenderOnDemandClosure {
public void generateResponse(StaplerRequest req, StaplerResponse rsp, Object node) throws IOException, ServletException {
try {
new DefaultScriptInvoker() {
@Override
protected JellyContext createContext(StaplerRequest req, StaplerResponse rsp, Script script, Object it) {
JellyContext context = super.createContext(req, rsp, script, it);
for (int i=bodyStack.length-1; i>0; i--) {// exclude bodyStack[0]
context = new JellyContext(context);
context.setVariable("org.apache.commons.jelly.body",bodyStack[i]);
}
return context;
}
@Override
protected void exportVariables(StaplerRequest req, StaplerResponse rsp, Script script, Object it, JellyContext context) {
super.exportVariables(req, rsp, script, it, context);
context.setVariables(variables);
req.setAttribute("currentDescriptorByNameUrl",currentDescriptorByNameUrl);
}
}.invokeScript(req,rsp,body,null);
}.invokeScript(req,rsp,bodyStack[0],null);
} catch (JellyTagException e) {
LOGGER.log(Level.WARNING, "Failed to evaluate the template closure", e);
throw new IOException2("Failed to evaluate the template closure",e);
}
}
};
}
private static final Logger LOGGER = Logger.getLogger(RenderOnDemandClosure.class.getName());
}
@@ -38,6 +38,10 @@ THE SOFTWARE.
provide hint for stapler data binding.
typically set to ${descriptor.clazz.name} if dropdownList is for a list of descriptors.
</st:attribute>
<st:attribute name="lazy">
If specified, the content of the dropdownListBlock will be rendered lazily when it first becomes visible.
The attribute value must be the variables to be captured. See the @capture of &lt;renderOnDemand> tag.
</st:attribute>
</st:documentation>
<j:choose>
<j:when test="${dropdownListMode=='createSelectField'}">
@@ -50,7 +54,16 @@ THE SOFTWARE.
<td><input type="hidden" name="stapler-class" value="${attrs.staplerClass}"/></td>
</j:if>
</tr>
<d:invokeBody />
<j:choose>
<j:when test="${attrs.lazy!=null and !attrs.selected}">
<l:renderOnDemand capture="${attrs.lazy}" tag="tr">
<d:invokeBody />
</l:renderOnDemand>
</j:when>
<j:otherwise>
<d:invokeBody />
</j:otherwise>
</j:choose>
<tr class="dropdownList-end" style="display:none" />
</j:when>
</j:choose>
@@ -32,11 +32,14 @@ THE SOFTWARE.
<f:dropdownListBlock value="auto" title="(${%Auto})" />
<j:set var="currentBrowser" value="${scm.browser}"/>
<j:forEach var="descriptor" items="${scmd.browserDescriptors}" varStatus="loop">
<j:set var="browser" value="${currentBrowser.descriptor==descriptor ? currentBrowser : null}"/><!-- for compatibility -->
<f:dropdownListBlock value="${loop.index}" title="${descriptor.displayName}"
selected="${currentBrowser.descriptor==descriptor}" staplerClass="${descriptor.clazz.name}">
<j:set var="browser" value="${currentBrowser.descriptor==descriptor ? currentBrowser : null}"/><!-- for compatibility -->
<j:set var="instance" value="${browser}" />
<st:include from="${descriptor}" page="${descriptor.configPage}"/>
selected="${currentBrowser.descriptor==descriptor}" staplerClass="${descriptor.clazz.name}"
lazy="browser,descriptor,it">
<l:ajax>
<j:set var="instance" value="${browser}" />
<st:include from="${descriptor}" page="${descriptor.configPage}"/>
</l:ajax>
</f:dropdownListBlock>
</j:forEach>
</f:dropdownList>
@@ -430,7 +430,7 @@ function isInsideRemovable(e) {
* if specified, skip the application of behaviour rule.
*/
function renderOnDemand(e,callback,noBehaviour) {
if (!e) return;
if (!e || !Element.hasClassName(e,"render-on-demand")) return;
var proxy = eval(e.getAttribute("proxy"));
proxy.render(function (t) {
Element.replace(e, t.responseText);
@@ -1347,9 +1347,10 @@ function updateDropDownList(sel) {
var tr = f.start;
while (true) {
tr.style.display = (show ? "" : "none");
if(show)
if(show) {
tr.removeAttribute("field-disabled");
else // buildFormData uses this attribute and ignores the contents
renderOnDemand(tr);
} else // buildFormData uses this attribute and ignores the contents
tr.setAttribute("field-disabled","true");
if (tr == f.end) break;
tr = tr.nextSibling;