GraphExecutable.java

/* 
 *
 * SchemaCrawler
 * http://sourceforge.net/projects/schemacrawler
 * Copyright (c) 2000-2009, Sualeh Fatehi.
 *
 * This library 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 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 */

package schemacrawler.tools.integration.graph;


import java.io.BufferedWriter;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.Writer;
import java.util.logging.Level;
import java.util.logging.Logger;

import javax.sql.DataSource;

import schemacrawler.Version;
import schemacrawler.schema.Catalog;
import schemacrawler.schema.Column;
import schemacrawler.schema.DatabaseInfo;
import schemacrawler.schema.ForeignKey;
import schemacrawler.schema.ForeignKeyColumnMap;
import schemacrawler.schema.JdbcDriverInfo;
import schemacrawler.schema.Schema;
import schemacrawler.schema.Table;
import schemacrawler.schema.View;
import schemacrawler.schema.WeakAssociations;
import schemacrawler.tools.OutputOptions;
import schemacrawler.tools.integration.SchemaExecutable;
import schemacrawler.tools.util.HtmlFormattingHelper;
import sf.util.Utilities;

/**
 * Main executor for the graphing integration.
 * 
 * @author Sualeh Fatehi
 */
public final class GraphExecutable
  extends SchemaExecutable
{

  private static final Logger LOGGER = Logger.getLogger(GraphExecutable.class
    .getName());
  public static final String NEWLINE = System.getProperty("line.separator");

  private static String dotError()
  {
    final byte[] text = Utilities.readFully(HtmlFormattingHelper.class
      .getResourceAsStream("/dot.error.txt"));
    return new String(text);
  }

  private static void dotHeader(final Catalog catalog, final Writer writer)
    throws IOException
  {
    final byte[] text = Utilities.readFully(HtmlFormattingHelper.class
      .getResourceAsStream("/dot.header.txt"));
    final String dotHeader = new String(text);

    final String catalogName = catalog.getName() == null? "": catalog.getName();
    final StringBuilder buffer = new StringBuilder();
    buffer
      .append("      <table border=\"1\" cellborder=\"0\" cellspacing=\"0\">")
      .append(NEWLINE);

    buffer.append("        <tr>").append(NEWLINE);
    buffer.append("          <td align=\"right\">Catalog:</td>")
      .append(NEWLINE);
    buffer.append("          <td align=\"left\">" + catalogName + "</td>")
      .append(NEWLINE);
    buffer.append("        </tr>").append(NEWLINE);

    final DatabaseInfo databaseInfo = catalog.getDatabaseInfo();
    if (databaseInfo != null)
    {
      buffer.append("        <tr>").append(NEWLINE);
      buffer.append("          <td align=\"right\">Database:</td>")
        .append(NEWLINE);
      buffer.append("          <td align=\"left\">"
                    + databaseInfo.getProductName() + "  "
                    + databaseInfo.getProductVersion() + "</td>")
        .append(NEWLINE);
      buffer.append("        </tr>").append(NEWLINE);
    }

    final JdbcDriverInfo jdbcDriverInfo = catalog.getJdbcDriverInfo();
    if (jdbcDriverInfo != null)
    {
      buffer.append("        <tr>").append(NEWLINE);
      buffer.append("          <td align=\"right\">JDBC Driver:</td>")
        .append(NEWLINE);
      buffer.append("          <td align=\"left\">"
                    + jdbcDriverInfo.getDriverName() + "  "
                    + jdbcDriverInfo.getDriverVersion() + "</td>")
        .append(NEWLINE);
      buffer.append("        </tr>").append(NEWLINE);
    }

    buffer.append("        <tr>").append(NEWLINE);
    buffer.append("          <td colspan=\"2\" align=\"left\">Generated by "
                  + Version.getProductName() + " " + Version.getVersion()
                  + "</td>").append(NEWLINE);
    buffer.append("        </tr>").append(NEWLINE);

    buffer.append("      </table>");

    writer.write(String.format(dotHeader, catalogName, buffer.toString()));
  }

  /**
   * Get connection parameters, and creates a connection, and crawls the
   * schema.
   * 
   * @param args
   *        Arguments passed into the program from the command line.
   * @throws Exception
   *         On an exception
   */
  public void main(final String[] args)
    throws Exception
  {
    executeOnSchema(args, "/schemacrawler-dot-readme.txt");
  }

  @Override
  protected void doExecute(final DataSource dataSource)
    throws Exception
  {
    final Catalog catalog = getCatalog(dataSource);
    final OutputOptions outputOptions = toolOptions.getOutputOptions();
    final File outputFile = outputOptions.getOutputFile();

    try
    {
      final String outputFormat = outputOptions.getOutputFormatValue();
      if (outputFormat.equalsIgnoreCase("dot"))
      {
        writeDotFile(catalog, Utilities.changeFileExtension(outputFile, ".dot"));
      }
      else
      {
        final File dotFile = File.createTempFile("schemacrawler_"
                                                     + catalog.getName() + "_",
                                                 ".dot");
        dotFile.deleteOnExit();

        final GraphGenerator dot = new GraphGenerator();
        writeDotFile(catalog, dotFile);
        dot.generateDiagram(dotFile, outputFormat, outputFile);
      }
    }
    catch (final Exception e)
    {
      LOGGER.log(Level.WARNING, "Could not write diagram", e);
      writeDotFile(catalog, Utilities.changeFileExtension(outputFile, ".dot"));
      System.out.println(dotError());
    }
  }

  private String printColumnAssociation(final String associationName,
                                        final Column primaryKeyColumn,
                                        final Column foreignKeyColumn)
  {
    final String arrowhead;
    if (foreignKeyColumn.isNullable())
    {
      arrowhead = "odottee";
    }
    else
    {
      arrowhead = "teetee";
    }
    final String arrowtail;
    if (foreignKeyColumn.isPartOfUniqueIndex())
    {
      arrowtail = "teeodot";
    }
    else
    {
      arrowtail = "crowodot";
    }
    final String style;
    if (associationName == null || associationName.equals(""))
    {
      style = "dashed";
    }
    else
    {
      style = "solid";
    }

    return String
      .format("  \"%s\":\"%s.start\":w -> \"%s\":\"%s.end\":e [label=\"%s\" style=\"%s\" arrowhead=\"%s\" arrowtail=\"%s\"];%n",
              primaryKeyColumn.getParent().getFullName(),
              primaryKeyColumn.getName(),
              foreignKeyColumn.getParent().getFullName(),
              foreignKeyColumn.getName(),
              associationName,
              style,
              arrowhead,
              arrowtail);
  }

  private void writeDotFile(final Catalog catalog, final File dotFile)
    throws IOException
  {
    final Writer writer = new BufferedWriter(new FileWriter(dotFile));

    dotHeader(catalog, writer);
    for (final Schema schema: catalog.getSchemas())
    {
      final PastelColor bgcolor = new PastelColor();
      for (final Table table: schema.getTables())
      {
        final PastelColor tableBgColor = bgcolor.shade();
        final StringBuilder buffer = new StringBuilder();
        final String tableName = table.getFullName();
        buffer.append("  \"" + tableName + "\" [").append(NEWLINE)
          .append("    label=<").append(NEWLINE);
        buffer
          .append("      <table border=\"1\" cellborder=\"0\" cellspacing=\"0\">")
          .append(NEWLINE);
        buffer.append("        <tr>").append(NEWLINE);

        buffer.append("          <td colspan=\"2\" bgcolor=\"" + tableBgColor
                      + "\" align=\"left\">" + tableName + "</td>")
          .append(NEWLINE);
        buffer.append("          <td bgcolor=\"" + tableBgColor
                      + "\" align=\"right\">"
                      + (table instanceof View? "[view]": "[table]") + "</td>")
          .append(NEWLINE);
        buffer.append("        </tr>").append(NEWLINE);
        for (final Column column: table.getColumns())
        {
          final String columnName = column.getName();
          final PastelColor columnBgcolor;
          if (column.isPartOfPrimaryKey())
          {
            columnBgcolor = bgcolor;
          }
          else
          {
            columnBgcolor = bgcolor.tint();
          }
          buffer.append("        <tr>").append(NEWLINE);
          buffer.append("          <td port=\"" + columnName
                        + ".start\" bgcolor=\"" + columnBgcolor
                        + "\" align=\"left\">" + columnName + "</td>")
            .append(NEWLINE);
          buffer.append("          <td bgcolor=\"" + columnBgcolor
                        + "\"> </td>").append(NEWLINE);
          buffer.append("          <td port=\"" + columnName
                        + ".end\" align=\"right\" bgcolor=\"" + columnBgcolor
                        + "\">"
                        + column.getType().getDatabaseSpecificTypeName()
                        + column.getWidth() + "</td>").append(NEWLINE);
          buffer.append("        </tr>").append(NEWLINE);
        }
        buffer.append("      </table>").append(NEWLINE);
        buffer.append("    >").append(NEWLINE).append("  ];").append(NEWLINE);

        for (final ForeignKey foreignKey: table.getForeignKeys())
        {
          for (final ForeignKeyColumnMap foreignKeyColumnMap: foreignKey
            .getColumnPairs())
          {
            final Column primaryKeyColumn = foreignKeyColumnMap
              .getPrimaryKeyColumn();
            final Column foreignKeyColumn = foreignKeyColumnMap
              .getForeignKeyColumn();
            if (primaryKeyColumn.getParent().equals(table))
            {
              buffer.append(printColumnAssociation(foreignKey.getName(),
                                                   primaryKeyColumn,
                                                   foreignKeyColumn));
            }
          }
        }

        buffer.append(NEWLINE).append(NEWLINE);
        writer.write(buffer.toString());
      }
    }

    final WeakAssociations weakAssociations = catalog.getWeakAssociations();
    if (weakAssociations != null)
    {
      for (final ForeignKeyColumnMap foreignKeyColumnMap: weakAssociations
        .getColumnPairs())
      {
        final Column primaryKeyColumn = foreignKeyColumnMap
          .getPrimaryKeyColumn();
        final Column foreignKeyColumn = foreignKeyColumnMap
          .getForeignKeyColumn();
        writer.write(printColumnAssociation("",
                                            primaryKeyColumn,
                                            foreignKeyColumn));
      }
    }

    writer.write("}\n");
    writer.flush();
    writer.close();
    LOGGER.log(Level.INFO, "Wrote DOT file, " + dotFile.getAbsolutePath());
  }

}