diff --git a/core/src/main/java/hudson/diagnosis/TooManyJobsButNoView.java b/core/src/main/java/hudson/diagnosis/TooManyJobsButNoView.java new file mode 100644 index 0000000000..868f646235 --- /dev/null +++ b/core/src/main/java/hudson/diagnosis/TooManyJobsButNoView.java @@ -0,0 +1,62 @@ +/* + * The MIT License + * + * Copyright (c) 2004-2009, Sun Microsystems, Inc. + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ +package hudson.diagnosis; + +import hudson.model.AdministrativeMonitor; +import hudson.model.Hudson; +import hudson.Extension; +import org.kohsuke.stapler.StaplerRequest; +import org.kohsuke.stapler.StaplerResponse; + +import java.io.IOException; + +/** + * If Hudson is run with a lot of jobs but no views, suggest the user that they can create views. + * + *

+ * I noticed at an user visit that some users didn't notice the '+' icon in the tab bar. + * + * @author Kohsuke Kawaguchi + */ +@Extension +public class TooManyJobsButNoView extends AdministrativeMonitor { + public boolean isActivated() { + Hudson h = Hudson.getInstance(); + return h.getViews().size()==1 && h.getItemMap().size()> THRESHOLD; + } + + /** + * Depending on whether the user said "yes" or "no", send him to the right place. + */ + public void doAct(StaplerRequest req, StaplerResponse rsp) throws IOException { + if(req.hasParameter("no")) { + disable(true); + rsp.sendRedirect(req.getContextPath()+"/manage"); + } else { + rsp.sendRedirect(req.getContextPath()+"/newView"); + } + } + + public static final int THRESHOLD = 16; +} diff --git a/core/src/main/java/hudson/model/Hudson.java b/core/src/main/java/hudson/model/Hudson.java index 7eec775d12..8425681a82 100644 --- a/core/src/main/java/hudson/model/Hudson.java +++ b/core/src/main/java/hudson/model/Hudson.java @@ -991,6 +991,17 @@ public final class Hudson extends Node implements ItemGroup, Stapl return new ArrayList(items.values()); } + /** + * Returns the read-only view of all the {@link TopLevelItem}s keyed by their names. + *

+ * This method is efficient, as it doesn't involve any copying. + * + * @since 1.296 + */ + public Map getItemMap() { + return Collections.unmodifiableMap(items); + } + /** * Gets just the immediate children of {@link Hudson} but of the given type. */ @@ -1074,6 +1085,11 @@ public final class Hudson extends Node implements ItemGroup, Stapl return copy; } + public void addView(View v) throws IOException { + views.add(v); + save(); + } + public synchronized void deleteView(View view) throws IOException { if(views.size()<=1) throw new IllegalStateException(); @@ -2348,8 +2364,7 @@ public final class Hudson extends Node implements ItemGroup, Stapl public synchronized void doCreateView( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException { try { checkPermission(View.CREATE); - views.add(View.create(req,rsp, this)); - save(); + addView(View.create(req,rsp, this)); } catch (ParseException e) { sendError(e,req,rsp); } catch (FormException e) { diff --git a/core/src/main/resources/hudson/diagnosis/TooManyJobsButNoView/message.jelly b/core/src/main/resources/hudson/diagnosis/TooManyJobsButNoView/message.jelly new file mode 100644 index 0000000000..d0dc36cbd1 --- /dev/null +++ b/core/src/main/resources/hudson/diagnosis/TooManyJobsButNoView/message.jelly @@ -0,0 +1,35 @@ + + + +

+
+
+ + +
+ ${%blurb} +
+
+ \ No newline at end of file diff --git a/core/src/main/resources/hudson/diagnosis/TooManyJobsButNoView/message.properties b/core/src/main/resources/hudson/diagnosis/TooManyJobsButNoView/message.properties new file mode 100644 index 0000000000..5416b7015e --- /dev/null +++ b/core/src/main/resources/hudson/diagnosis/TooManyJobsButNoView/message.properties @@ -0,0 +1,2 @@ +blurb=There appears to be a large number of jobs. Did you know that you can organize your jobs to different views? \ + You can click '+' in the top page to create a new view any time. \ No newline at end of file diff --git a/test/src/test/java/hudson/diagnosis/TooManyJobsButNoViewTest.java b/test/src/test/java/hudson/diagnosis/TooManyJobsButNoViewTest.java new file mode 100644 index 0000000000..7618e33174 --- /dev/null +++ b/test/src/test/java/hudson/diagnosis/TooManyJobsButNoViewTest.java @@ -0,0 +1,67 @@ +package hudson.diagnosis; + +import org.jvnet.hudson.test.HudsonTestCase; +import org.xml.sax.SAXException; +import com.gargoylesoftware.htmlunit.html.HtmlPage; +import com.gargoylesoftware.htmlunit.html.HtmlForm; +import com.gargoylesoftware.htmlunit.ElementNotFoundException; +import hudson.model.AdministrativeMonitor; +import hudson.model.ListView; + +import java.net.URL; +import java.io.IOException; + +/** + * @author Kohsuke Kawaguchi + */ +public class TooManyJobsButNoViewTest extends HudsonTestCase { + private TooManyJobsButNoView mon; + + @Override + protected void setUp() throws Exception { + super.setUp(); + mon = AdministrativeMonitor.all().get(TooManyJobsButNoView.class); + } + + /** + * Shouldn't be active at the beginning + */ + public void testInitialState() throws Exception { + verifyNoForm(); + } + + private void verifyNoForm() throws IOException, SAXException { + HtmlPage p = new WebClient().goTo("manage"); + try { + p.getFormByName(mon.id); + fail(); + } catch (ElementNotFoundException e) { + // shouldn't find it + } + } + + /** + * Once we have enough jobs, it should kick in + */ + public void testActivated() throws Exception { + for( int i=0; i<=TooManyJobsButNoView.THRESHOLD; i++ ) + createFreeStyleProject(); + + HtmlPage p = new WebClient().goTo("manage"); + HtmlForm f = p.getFormByName(mon.id); + assertNotNull(f); + + // this should take us to the new view page + URL url = submit(f,"yes").getWebResponse().getUrl(); + assertTrue(url.toExternalForm(),url.toExternalForm().endsWith("/newView")); + + // since we didn't create a view, if we go back, we should see the warning again + p = new WebClient().goTo("manage"); + assertNotNull(p.getFormByName(mon.id)); + + // once we create a view, the message should disappear + hudson.addView(new ListView("test")); + + verifyNoForm(); + } +}