source.dussan.org Git - archiva.git/blob

   1 package org.apache.archiva.web.tags;
   2
   3 /*
   4  * Licensed to the Apache Software Foundation (ASF) under one
   5  * or more contributor license agreements.  See the NOTICE file
   6  * distributed with this work for additional information
   7  * regarding copyright ownership.  The ASF licenses this file
   8  * to you under the Apache License, Version 2.0 (the
   9  * "License"); you may not use this file except in compliance
  10  * with the License.  You may obtain a copy of the License at
  11  *
  12  *  http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  17  * KIND, either express or implied.  See the License for the
  18  * specific language governing permissions and limitations
  19  * under the License.
  20  */
  21
  22 import org.apache.commons.collections.CollectionUtils;
  23 import org.apache.commons.collections.IteratorUtils;
  24 import org.apache.commons.lang.StringUtils;
  25 import org.apache.archiva.common.ArchivaException;
  26 import org.apache.archiva.web.tags.DependencyTree.TreeEntry;
  27 import org.apache.struts2.views.annotations.StrutsTag;
  28 import org.apache.struts2.views.annotations.StrutsTagAttribute;
  29 import org.springframework.beans.BeansException;
  30 import org.springframework.web.context.WebApplicationContext;
  31 import org.springframework.web.context.support.WebApplicationContextUtils;
  32
  33 import java.io.IOException;
  34 import java.io.PrintWriter;
  35 import java.util.Iterator;
  36 import java.util.List;
  37
  38 import javax.servlet.jsp.JspException;
  39 import javax.servlet.jsp.PageContext;
  40 import javax.servlet.jsp.tagext.IterationTag;
  41 import javax.servlet.jsp.tagext.TagSupport;
  42 import javax.servlet.jsp.tagext.TryCatchFinally;
  43
  44 /**
  45  * DependencyTreeTag - just here to output the dependency tree to the browser.
  46  * It was easier to do it this way, vs accessing the dependency graph via a JSP.
  47  *
  48  * <pre>
  49  *   <archiva:dependency-tree groupId="org.apache.archiva"
  50  *                            artifactId="archiva-common"
  51  *                            version="1.3.5"
  52  *                            nodevar="node">
  53  *     <b>${node.groupId}</b>:<b>${node.artifactId}</b>:<b>${node.version}</b> (${node.scope})
  54  *   </archiva:dependency-tree>
  55  * </pre>
  56  *
  57  *
  58  */
  59 @StrutsTag(name = "dependency-tree", tldBodyContent = "JSP", tldTagClass = "org.apache.archiva.web.tags.DependencyTreeTag", description = "Render a dependency tree for the provided project.")
  60 public class DependencyTreeTag
  61     extends TagSupport
  62     implements IterationTag, TryCatchFinally
  63 {
  64     private String groupId;
  65
  66     private String artifactId;
  67
  68     @SuppressWarnings("unused")
  69     private String version;
  70
  71     private String nodevar;
  72
  73     private Iterator<TreeEntry> treeIterator;
  74
  75     private List<TreeEntry> tree;
  76
  77     private TreeEntry currentTreeEntry;
  78
  79     private String modelVersion;
  80
  81     public int doAfterBody()
  82         throws JspException
  83     {
  84         if ( currentTreeEntry != null )
  85         {
  86             out( currentTreeEntry.getPost() );
  87         }
  88
  89         if ( treeIterator.hasNext() )
  90         {
  91             currentTreeEntry = treeIterator.next();
  92             out( currentTreeEntry.getPre() );
  93             exposeVariables();
  94             return EVAL_BODY_AGAIN;
  95         }
  96
  97         out( "\n</div><!-- end of dependency-graph -->" );
  98
  99         return SKIP_BODY;
 100     }
 101
 102     public void doCatch( Throwable t )
 103         throws Throwable
 104     {
 105         throw t;
 106     }
 107
 108     public void doFinally()
 109     {
 110         unExposeVariables();
 111     }
 112
 113     @SuppressWarnings("unchecked")
 114     public int doStartTag()
 115         throws JspException
 116     {
 117         DependencyTree deptree;
 118         try
 119         {
 120             WebApplicationContext webApplicationContext =
 121                 WebApplicationContextUtils.getRequiredWebApplicationContext( pageContext.getServletContext() );
 122
 123             deptree = webApplicationContext.getBean( "dependencyTree", DependencyTree.class );
 124         }
 125         catch ( BeansException e )
 126         {
 127             throw new JspException( "Unable to lookup DependencyTree: " + e.getMessage(), e );
 128         }
 129
 130         if ( deptree == null )
 131         {
 132             throw new JspException( "Unable to process dependency tree.  Component not found." );
 133         }
 134
 135         if ( StringUtils.isBlank( nodevar ) )
 136         {
 137             nodevar = "node";
 138         }
 139
 140         out( "<div class=\"dependency-graph\">" );
 141         try
 142         {
 143             this.tree = deptree.gatherTreeList( groupId, artifactId, modelVersion );
 144
 145             if ( CollectionUtils.isEmpty( this.tree ) )
 146             {
 147                 return SKIP_BODY;
 148             }
 149
 150             treeIterator = tree.iterator();
 151
 152             currentTreeEntry = treeIterator.next();
 153             out( currentTreeEntry.getPre() );
 154             exposeVariables();
 155         }
 156         catch ( ArchivaException e )
 157         {
 158             treeIterator = IteratorUtils.EMPTY_LIST_ITERATOR;
 159
 160             out("<pre>");
 161             e.printStackTrace( new PrintWriter( pageContext.getOut() ) );
 162             out("</pre>");
 163         }
 164
 165         return EVAL_BODY_INCLUDE;
 166     }
 167
 168     public void release()
 169     {
 170         groupId = "";
 171         artifactId = "";
 172         version = "";
 173         nodevar = "";
 174         tree = null;
 175         treeIterator = null;
 176         super.release();
 177     }
 178
 179     @StrutsTagAttribute(description = "The artifactId", type = "String", defaultValue = "", required = true, rtexprvalue = true)
 180     public void setArtifactId( String artifactId )
 181     {
 182         this.artifactId = artifactId;
 183     }
 184
 185     @StrutsTagAttribute(description = "The groupId", type = "String", defaultValue = "", required = true, rtexprvalue = true)
 186     public void setGroupId( String groupId )
 187     {
 188         this.groupId = groupId;
 189     }
 190
 191     @StrutsTagAttribute(description = "The variable name for the node.", type = "String", defaultValue = "", required = false, rtexprvalue = true)
 192     public void setNodevar( String nodevar )
 193     {
 194         this.nodevar = nodevar;
 195     }
 196
 197     @StrutsTagAttribute(description = "The version", type = "String", defaultValue = "", required = true, rtexprvalue = true)
 198     public void setVersion( String version )
 199     {
 200         this.version = version;
 201     }
 202
 203     @StrutsTagAttribute(description = "The version of the project model. Used to verify the dependency graph for generic snapshots not yet in the repo.", type = "String", defaultValue = "", required = false, rtexprvalue = true)
 204     public void setModelVersion( String modelVersion )
 205     {
 206         this.modelVersion = modelVersion;
 207     }
 208
 209     private void exposeVariables()
 210         throws JspException
 211     {
 212         if ( currentTreeEntry == null )
 213         {
 214             pageContext.removeAttribute( nodevar, PageContext.PAGE_SCOPE );
 215         }
 216         else
 217         {
 218             pageContext.setAttribute( nodevar, currentTreeEntry.getArtifact() );
 219         }
 220     }
 221
 222     private void out( String msg )
 223         throws JspException
 224     {
 225         try
 226         {
 227             pageContext.getOut().print( msg );
 228         }
 229         catch ( IOException e )
 230         {
 231             throw new JspException( "Unable to output to jsp page context." );
 232         }
 233     }
 234
 235     private void unExposeVariables()
 236     {
 237         pageContext.removeAttribute( nodevar, PageContext.PAGE_SCOPE );
 238     }
 239 }