Recipe 18.12 Program: MkIndex | Java Cookbook, Second Edition

This little program has saved me a great deal of time over the years. It reads a directory containing a large number of files, harking back from a time when I kept all my demonstration Java programs in a fairly flat directory structure. MkIndex, shown in Example 18-9, produces a better-formatted listing than the default directory that web servers generate. For one thing, it includes an alphabet navigator that lets you jump directly to the section of files whose names begin with a certain letter, saving a lot of scrolling time or iterations with the browser's find menu. This program uses a File object (see Recipe 11.1) to list the files and another to decide which are files and which are directories. It also uses Collections.sort (see Recipe 7.8) to sort the names alphabetically before generating the output. It writes its output to the file index.html in the current directory, even if an alternate directory argument is given. This is the default filename for most standard web servers; if your web server uses something different, of course, you can rename the file.

Example 18-9. MkIndex.java

import java.io.*; import java.util.*; import com.darwinsys.io.FileIO; /** MkIndex -- make a static index.html for a Java Source directory  * <p>  * Started life as an awk script that used "ls" to get  * the list of files, grep out .class and javadoc output files, |sort.  * Now it's all in Java (including the ls-ing and the sorting).  *  * @author    Ian F. Darwin, http://www.darwinsys.com/  * @Version $Id: ch18.xml,v 1.5 2004/05/04 20:13:14 ian Exp $  */ public class MkIndex {     class NameMap implements Comparable {         String name, nameLC;         String path;         public NameMap(String nm, String p) {             name = nm;             nameLC = name.toLowerCase( );             path = p;         }         public int compareTo(Object other) {             return nameLC.compareTo(((NameMap)other).nameLC);         }     }     /** The output file that we create */     public static final String OUTPUTFILE = "index-byname.html";     /** The string for TITLE and H1 */     public static final String TITLE =         "Ian Darwin's Java Cookbook: Source Code: By Name";     /** The main output stream */     PrintWriter out;     /** The background color for the page */     public static final String BGCOLOR="#33ee33";     /** The File object, for directory listing. */     File dirFile;     /** Make an index */     public static void main(String[] args) throws IOException {         MkIndex mi = new MkIndex( );         String inDir = args.length > 0 ? args[0] : ".";         mi.open(inDir, OUTPUTFILE);        // open files         mi.begin( );        // print HTML header         System.out.println("** Start Pass One **");         for (int i=0; i<args.length; i++)             mi.process(new File(args[i]));    // "We do ALL the work..."         mi.writeNav( );    // Write navigator         mi.writeList( );    // Write huge list of files         mi.end( );        // print trailer.         mi.close( );        // close files     }     void open(String dir, String outFile) {         dirFile = new File(dir);         try {             out = new PrintWriter(new FileWriter(outFile));         } catch (IOException e) {             System.err.println(e);         }     }     /** Write the HTML headers */     void begin( ) throws IOException {         println("<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN'");         println("    'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'");         println(">");         println( );         println("<html>");         println("<head>");         println("    <meta name='Generator' content='Java MkIndex'/>");         println("    <title>" + TITLE + "</title>");         println("</head>");         println( );         println("<body bgcolor=\"" + BGCOLOR + "\">");         println("<h1>" + TITLE + "</h1>");         if (new File("about.html").exists( )) {             FileIO.copyFile("about.html", out, false);         } else {             println("<p>The following files are online.");             println("Some of these files are still experimental!</p>");             println("<p>Most of these files are Java source code.");             println("If you load an HTML file from here, the applets will not run!");             println("The HTML files must be saved to disk and the applets compiled,");             println("before you can run them!</p>");         }         println("<p>All files are Copyright (c): All rights reserved.");         println("See the accompanying <a href=\"legal-notice.txt\">Legal Notice</a>.");         println("May be used by readers of my Java Cookbook for educational purposes,");         println("</p>");         println("<hr />");     }     /** Array of letters that exist. Should      * fold case here so don't get f and F as distinct entries!      * This only works for ASCII characters (8-bit chars).      */     boolean[] exists = new boolean[255];     /** List for temporary storage, and sorting */     ArrayList list = new ArrayList( );     /** Do the bulk of the work */     void process(File file) throws IOException {         String name = file.getName( );         if (name.startsWith("index") ||             name.endsWith(".class") ||             name.endsWith(".bak")) {             System.err.println("Ignoring " + file.getPath( ));             return;         } else if (name.equals("CVS")) {        // Ignore CVS subdirectories             return;                        // don't mention it         } else if (name.charAt(0) == '.') {    // UNIX dot-file             return;         }         if (file.isDirectory( )) {             File[] files = file.listFiles( );             for (int i=0; i<files.length; i++) {                 String fn = files[i].getName( );                 process(new File(file, fn));             }         } else {             // file to be processed.             list.add(new NameMap(name, file.getPath( )));             exists[name.charAt(0)] = true;         }     }     void writeNav( ) throws IOException {         System.out.println("Writing the Alphabet Navigator...");         for (char c = 'A'; c<='Z'; c++)             if (exists[c])                 print("<a href=\"#" + c + "\">" + c + "</a> ");     }     void writeList( ) throws IOException {         // ... the beginning of the HTML Unordered List...         println("<ul>");         System.out.println("Sorting the list...");         Collections.sort(list);         System.out.println("Start PASS TWO -- from List to " +             OUTPUTFILE + "...");         Iterator it = list.iterator( );         while (it.hasNext( )) {             NameMap map = (NameMap)it.next( );             String fn = map.name;             String path = map.path;             // Need to make a link into this directory.             // IF there is a descr.txt file, use it for the text             // of the link, otherwise, use the directory name.             // But, if there is an index.html or index.html file,             // make the link to that file, else to the directory itself.             if (fn.endsWith("/")) {    // directory                 String descr = null;                 if (new File(fn + "descr.txt").exists( )) {                     descr = FileIO.readLine(fn + "descr.txt");                 };                 if (new File(fn + "index.html").exists( ))                     mkDirLink(fn+"index.html", descr!=null?descr:fn);                 else if (new File(fn + "index.htm").exists( ))                         mkDirLink(fn+"index.htm", descr!=null?descr:fn);                 else                     mkLink(fn, descr!=null?descr:fn + " -- Directory");             } else // file                 mkLink(fn, path);         }         System.out.println("*** process - ALL DONE***");     }     /** Keep track of each letter for #links */     boolean done[] = new boolean[255];     void mkLink(String name, String path) {         print("<li>");         char c = name.charAt(0);         if (!done[c]) {             print("<a name=\"" + c + "\"/>");             done[c] = true;         }         println("<a href=\"" + path + "\">" + name + "</a>");     }     void mkDirLink(String index, String dir) {         // TODO  Open the index and look for TITLE lines!         println("<a href='" + index + "'>" + dir + "</a>");     }     /** Write the trailers and a signature */     void end( ) {         System.out.println("Finishing the HTML");         println("</ul>");         flush( );         println("<p>This file generated by ");         print("<a href=\"MkIndex.java\">MkIndex</a>, a Java program, at ");         println(Calendar.getInstance( ).getTime( ).toString( ));         println("</p>");         println("</body>");         println("</html>");     }     /** Close open files */     void close( ) {         System.out.println("Closing output files...");         if (out != null)             out.close( );     }     /** Convenience routine for out.print */     void print(String s) {         out.print(s);     }     /** Convenience routine for out.println */     void println(String s) {         out.println(s);     }     /** Convenience routine for out.println */     void println( ) {         out.println( );     }     /** Convenience for out.flush( ); */     void flush( ) {         out.flush( );     } }