/**
    * Copyright 2010-2012 The Kuali Foundation
    *
    * Licensed under the Educational Community License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    * http://www.opensource.org/licenses/ecl2.php
    *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.codehaus.mojo.license;
  
  /* 
   * Codehaus License Maven Plugin
   *     
   * This program is free software: you can redistribute it and/or modify
   * it under the terms of the GNU Lesser General Public License as published by
   * the Free Software Foundation, either version 3 of the License, or
   * (at your option) any later version.
   *
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU Lesser General Public License for more details.
   *
   * You should have received a copy of the GNU Lesser General Public License
   * along with this program.  If not, see <http://www.gnu.org/licenses/lgpl-3.0.html>.
   */
  
  import org.apache.maven.model.License;
  import org.codehaus.mojo.license.model.ProjectLicenseInfo;
  import org.w3c.dom.Document;
  import org.w3c.dom.Node;
  
  import javax.xml.parsers.DocumentBuilder;
  import javax.xml.parsers.DocumentBuilderFactory;
  import javax.xml.parsers.ParserConfigurationException;
  import javax.xml.transform.*;
  import javax.xml.transform.dom.DOMSource;
  import javax.xml.transform.stream.StreamResult;
  import java.io.File;
  import java.util.List;
  
  /**
   * A LicenseSummaryWriter.
   *
   * @author Paul Gier
   * @version $Revision: 13519 $
   * @since 1.0
   */
  public class LicenseSummaryWriter
  {
      public static void writeLicenseSummary( List<ProjectLicenseInfo> dependencies, File outputFile )
          throws ParserConfigurationException, TransformerException
      {
          DocumentBuilderFactory fact = DocumentBuilderFactory.newInstance();
          DocumentBuilder parser = fact.newDocumentBuilder();
          Document doc = parser.newDocument();
  
          Node root = doc.createElement( "licenseSummary" );
          doc.appendChild( root );
          Node dependenciesNode = doc.createElement( "dependencies" );
          root.appendChild( dependenciesNode );
  
          for ( ProjectLicenseInfo dep : dependencies )
          {
              dependenciesNode.appendChild( createDependencyNode( doc, dep ) );
          }
  
          // Prepare the output file File
          Result result = new StreamResult( outputFile.toURI().getPath() );
  
          // Write the DOM document to the file
          Transformer xformer = TransformerFactory.newInstance().newTransformer();
          xformer.setOutputProperty( OutputKeys.INDENT, "yes" );
          xformer.setOutputProperty( "{http://xml.apache.org/xslt}indent-amount", "2" );
          xformer.transform( new DOMSource( doc ), result );
      }
  
      public static Node createDependencyNode( Document doc, ProjectLicenseInfo dep )
      {
          Node depNode = doc.createElement( "dependency" );
  
          Node groupIdNode = doc.createElement( "groupId" );
          groupIdNode.appendChild( doc.createTextNode( dep.getGroupId() ) );
          depNode.appendChild( groupIdNode );
  
          Node artifactIdNode = doc.createElement( "artifactId" );
          artifactIdNode.appendChild( doc.createTextNode( dep.getArtifactId() ) );
          depNode.appendChild( artifactIdNode );
  
          Node versionNode = doc.createElement( "version" );
          versionNode.appendChild( doc.createTextNode( dep.getVersion() ) );
          depNode.appendChild( versionNode );
 
         Node licensesNode = doc.createElement( "licenses" );
         if ( dep.getLicenses() == null || dep.getLicenses().size() == 0 )
         {
             licensesNode.appendChild( doc.createComment( "No license information available. " ) );
         }
         else
         {
             for ( License lic : dep.getLicenses() )
             {
                 licensesNode.appendChild( createLicenseNode( doc, lic ) );
             }
         }
         depNode.appendChild( licensesNode );
         return depNode;
 
     }
 
     public static Node createLicenseNode( Document doc, License lic )
     {
         Node licenseNode = doc.createElement( "license" );
 
         if ( lic.getName() != null )
         {
             Node licNameNode = doc.createElement( "name" );
             licNameNode.appendChild( doc.createTextNode( lic.getName() ) );
             licenseNode.appendChild( licNameNode );
         }
 
         if ( lic.getUrl() != null )
         {
             Node licUrlNode = doc.createElement( "url" );
             licUrlNode.appendChild( doc.createTextNode( lic.getUrl() ) );
             licenseNode.appendChild( licUrlNode );
         }
 
         if ( lic.getDistribution() != null )
         {
             Node licDistNode = doc.createElement( "distribution" );
             licDistNode.appendChild( doc.createTextNode( lic.getDistribution() ) );
             licenseNode.appendChild( licDistNode );
         }
 
         if ( lic.getComments() != null )
         {
             Node licCommentsNode = doc.createElement( "comments" );
             licCommentsNode.appendChild( doc.createTextNode( lic.getComments() ) );
             licenseNode.appendChild( licCommentsNode );
         }
 
         return licenseNode;
     }
 
 }