root/trunk/src/tutorials/converttowiki/convertToWiki.d

/*
    Purpose: To convert a snapshot of the dsource tutorials (http://www.dsource.org/tutorials/) 
             into wiki pages for Trac (http://trac.dsource.org/projects/tutorials/)
    Author:  J C Calvarese
    License: Public Domain
*/


import std.stdio; /* for writefln */
import std.stream;
import std.string; /* for find */

import names;

const char[] cssFile = "style.css";

const char[] begCategoriesMarker = `<h3 class="ex_disp_h3">Categories</h3><ul>`;
const char[] endCategoriesMarker = `<h3 class="ex_disp_h3">Examples</h3>`;  /* stop looking for category names */
const char[] begTopicMarker = `<li><a href="#topic`;
const char[] endCatNameMarker = " (";
const char[] endPhase2 = `<div class="app" style="margin-left: 0.5em;">`;
const char[] begTopicListMarker = `<li id="topic`;
const char[] endTopicListMarker = `</a></li></ul>`;
const char[] begExampleListMarker = `<li><a href="#ex`;
const char[] endExampleListMarker = `</a></li>`;

const char[] begExampleCategoryName = `<h3 class="ex_disp_h3">`;
const char[] endExampleCategoryName = `</h3>`;
const char[] begExampleNumber = `<h4 id="ex`;
const char[] endExampleNumber = `">`;
//const char[] begExName = ``; /* right after the > that signifies the end of the example number */
const char[] endExName = `</h4>`;

const char[] begExampleDescriptionMarker = `Description</th><td>`;
const char[] endExampleDescriptionMarker = `</td>`;
const char[] begExampleDateTimeMarker = `Date/Time</th><td>`; /* time and date will follow */
const char[] endExampleDateTimeMarker = `</td>`;
const char[] begExamplePostedByMarker = `Posted by</th><td>`;
const char[] endExamplePostedByMarker = `</td>`;
const char[] begExampleBodyMarker = `<table><tbody><tr><td colspan="2">`;
const char[] endExampleBodyMarker = `</td></tr><tr><td colspan="2">`; //`</td></tr><tr><td colspan="2"> </td></tr></tbody></table></div><hr>`;
//                                   </td></tr><tr><td colspan="2"> </td></tr></tbody></table></div><hr>


void main(char[][] args)
{
    char[] inputFile;
    char[] outputPath;

    char[] inStr; /* used to store the entire contents of the input file (at the beginning) */

    char[][] wikiCategories;
    char[][] wikiExampleNames;

    char[] oldCategoryName;
    char[] wikiCategory;
    char[] wikiExample;
    char[] postedBy;
    char[] datePosted;
    char[] oldExampleName;
    char[] exampleDescription;
    char[] exampleBody;
    char[] oldDsourceExampleLink;

    int begPos;
    int midPos;
    int endPos;

    int topicBegPos;
    int topicEndPos;

//  bit done;


    if(args.length > 2)
    {
        inputFile = args[1];
        outputPath = args[2] ~ `\`;
    }
    else
        writefln("Please specify the input file and output path at the commandline.");


    /* *** Read Entire Input File *** */

    File inFile = new File(inputFile);
    while (!inFile.eof())
        inStr ~= inFile.readLine() ~ \r\n;    
    inFile.close();    


    /* *** Create Index File *** */

    begPos = find(inStr, begCategoriesMarker );
    if(begPos < 0) 
    {
        writefln("Error: beginning of Categories section not found!");
        assert(0);
    }
    inStr = inStr[begPos..$];

    begPos = find(inStr, begTopicMarker);
    
    /* find `<li><a href="#topic` skip the number 
       and the text after ">" and before the "</a></li>" is the name */

    while(begPos >= 0) /* for each category: */
    {
        inStr = inStr[begPos + begTopicMarker.length .. $];
        //endPos = find(inStr, endCategoriesMarker);

        begPos = find(inStr, `>`);
        if(begPos < 0) 
        {
            writefln("Error: Category name not found!");
            assert(0);
        }
        inStr = inStr[begPos + 1 .. $];
        endPos = find(inStr, endCategoriesMarker);
        midPos = find(inStr, endCatNameMarker);     
        if(midPos < 0) 
        {
            writefln("Error: End of Category name not found!");
            assert(0);
        }
        oldCategoryName = inStr[0..midPos]; 

        wikiCategory = wikiCategoryName(oldCategoryName);
        wikiCategories ~= wikiCategory;

        debug writefln("Found category: " ~ wikiCategory);
    
        //mkdir(outputPath ~ `\` ~ wikiCategory);//    Make directory pathname[]. 
    

        begPos = find(inStr, begTopicMarker);
        endPos = find(inStr, endCategoriesMarker);

        debug writefln("begPos: %s, endPos: %s", begPos, endPos);

        if(endPos < begPos) begPos = -1;
    }

    File outFile = new File(outputPath ~ "index.html", FileMode.OutNew); 

    outFile.writeLine("<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"\n\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">");
    outFile.writeLine("<html><head><title>Index</title>");
    outFile.writeLine(`<link rel="stylesheet" href="` ~ cssFile ~ `"\>`);
    outFile.writeLine("</head>");
    outFile.writeLine("<body><pre>= Tutorial Categories =<br/>");

    
    /* use wikiCategories to list items for main page... */
    foreach(char[] wc; wikiCategories)
      outFile.writeLine(`  * <a href="` ~ wc ~ `.html">` ~ wc ~ `</a>`);

    outFile.writeLine("</pre></body></html>");
    outFile.close();



    /* *** Create Category Files *** */
    
    debug writefln("\n***Create Category Files ***");

    while(topicBegPos >= 0) /* loop for each category */
    {
        wikiExampleNames.length = 0;
        
        topicBegPos = find(inStr, begTopicListMarker);
        if(topicBegPos < 0) 
        {
            writefln("Error: Example name not found!");
            assert(0);
        }
        inStr = inStr[topicBegPos + 1 .. $];

        begPos = find(inStr, `>`);
        if(begPos < 0) 
        {
            writefln("Error: Category name not found!");
            assert(0);
        }
        inStr = inStr[begPos + 1 .. $];

        midPos = find(inStr, `</li>`);
        oldCategoryName = inStr[0..midPos];
        debug writefln("Found old category name: " ~ oldCategoryName);
        wikiCategory = wikiCategoryName(oldCategoryName);
        debug writefln("Found new category: " ~ wikiCategory);
        topicEndPos = find(inStr, endPhase2); //endTopicListMarker);


        begPos = find(inStr, begExampleListMarker);

        while(begPos >= 0) /* loop through the examples */
        {
            if(begPos < 0) 
            {
                writefln("Error: Example name not found!");
                assert(0);
            }
            inStr = inStr[begPos + begExampleListMarker.length .. $];

            begPos = find(inStr, `>`);
            if(begPos < 0) 
            {
                writefln("Error: Example name not found!");
                assert(0);
            }
            inStr = inStr[begPos + 1 .. $];
            endPos = find(inStr, endExampleListMarker );
            if(endPos < 0) 
            {
                writefln("Error: Example name ending not found!");
                assert(0);
            }
            oldExampleName = inStr[0..endPos]; 
    
            wikiExample = wikiExampleName(oldCategoryName, oldExampleName);
            wikiExampleNames ~= wikiExample;
    
            begPos = find(inStr, begExampleListMarker);
            endPos = find(inStr, endTopicListMarker); //endExampleListMarker);

            if(endPos < begPos) begPos = -1;
        }   

        File outFile = new File(outputPath ~ wikiCategory ~ ".html", FileMode.OutNew); 

        outFile.writeLine("<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"\n\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">");
        outFile.writeLine("<html><head><title>" ~ wikiCategory ~ "</title>");
        outFile.writeLine(`<link rel="stylesheet" href="` ~ cssFile ~ `"/>`);
        outFile.writeLine("</head>");

        outFile.writeLine(`<body><pre>= ` ~ oldCategoryName ~ ` =<br/>`);

        //outFile.writeLine(`<hr id="` ~ wikiCategory ~ `" />= ` ~ oldCategoryName ~ " =<br/>");
        foreach(char[] we; wikiExampleNames)
          outFile.writeLine(`  * <a href="` ~ we ~ `.html">` ~ we ~ `</a>`);
    
        outFile.writeLine("</pre></body></html>");
        outFile.close();

        topicBegPos = find(inStr, begTopicListMarker);
        topicEndPos = find(inStr, endPhase2); //endTopicListMarker);
    
        if(topicEndPos < topicBegPos) topicBegPos = -1;
    }



    debug writefln("\n***Create Example Files ***");

    /* *** Create Example Files *** */

    wikiCategory = "";

    begPos = 0;
    while(begPos != -1) //stillMoreExamples) /* for each example: */
    {

        /* check to see if there's a new category name before the next example */

        begPos = find(inStr, begExampleCategoryName);
        midPos = find(inStr, begExampleNumber);
        
        if((begPos < midPos && begPos != -1) || wikiCategory == "")
        {
            /* The next example is in a new category. */

            inStr = inStr[begPos + begExampleCategoryName.length .. $];
            endPos = find(inStr, endExampleCategoryName);
            if(endPos < 0)
            {
                writefln("Error: Category name end not found!");
                assert(0);
            }       

            oldCategoryName = inStr[0 .. endPos];
            wikiCategory = wikiCategoryName(oldCategoryName);
            inStr = inStr[endPos .. $];

            begPos = find(inStr, begExampleCategoryName);
            midPos = find(inStr, begExampleNumber);
            if((begPos < midPos && begPos != -1) || wikiCategory == "")
            {
                /* The last category didn't actually contain any examples. */
    
                inStr = inStr[begPos + begExampleCategoryName.length .. $];
                endPos = find(inStr, endExampleCategoryName);
                if(endPos < 0)
                {
                    writefln("Error: Category name end not found!");
                    assert(0);
                }       
                oldCategoryName = inStr[0 .. endPos];
                wikiCategory = wikiCategoryName(oldCategoryName);               
            }
            debug writefln("New category: %s", wikiCategory);
        }
        begPos = find(inStr, begExampleNumber);
        if(begPos < 0) 
        {
            writefln("Error: Example number not found!");
            assert(0);
        }       
        



        /* get wikiExample, exampleBody, postedDate, postedBy, etc. */


        /* ex # should be the number in the example link (should test it to make sure) */


        begPos = find(inStr, begExampleNumber);
        if(begPos < 0) 
        {
            writefln("Error: Example name not found!");
            assert(0);
        }       
        inStr = inStr[begPos + begExampleNumber.length .. $];

        endPos = find(inStr, endExampleNumber);
        if(endPos < 0) 
        {
            writefln("Error: Example number not found!");
            assert(0);
        }       
        oldDsourceExampleLink = "http://www.dsource.org/tutorials/index.php?show_example=" ~ inStr[0..endPos];

        inStr = inStr[endPos + endExampleNumber.length .. $];

        endPos = find(inStr, endExName);
        if(endPos < 0) 
        {
            writefln("Error: Example name end not found!");
            assert(0);
        }       
        oldExampleName = inStr[0..endPos];
        wikiExample = wikiExampleName(oldCategoryName, oldExampleName);
        inStr = inStr[endPos + endExName.length .. $];



        begPos = find(inStr, begExampleDescriptionMarker);
        if(begPos < 0) 
        {
            writefln("Error: Example description not found!");
            assert(0);
        }       
        endPos = find(inStr, endExampleDescriptionMarker);
        if(endPos < 0) 
        {
            writefln("Error: Example description end not found!");
            assert(0);
        }       
        exampleDescription = inStr[begPos + begExampleDescriptionMarker.length .. endPos];
        inStr = inStr[endPos + endExampleDescriptionMarker.length .. $];



        begPos = find(inStr, begExampleDateTimeMarker);
        if(begPos < 0) 
        {
            writefln("Error: Example date/time not found!");
            assert(0);
        }       
        endPos = find(inStr, endExampleDateTimeMarker);
        if(endPos < 0) 
        {
            writefln("Error: Example date/time end not found!");
            assert(0);
        }       
        datePosted = inStr[begPos + begExampleDateTimeMarker.length .. endPos];
        inStr = inStr[endPos + endExampleDateTimeMarker.length .. $];



        begPos = find(inStr, begExamplePostedByMarker);
        if(begPos < 0) 
        {
            writefln("Error: Example description not found!");
            assert(0);
        }       
        endPos = find(inStr, endExamplePostedByMarker);
        if(endPos < 0) 
        {
            writefln("Error: Example description end not found!");
            assert(0);
        }       
        postedBy = inStr[begPos + begExamplePostedByMarker.length .. endPos];
        inStr = inStr[endPos + endExamplePostedByMarker.length .. $];







        begPos = find(inStr, begExampleBodyMarker);
        if(begPos < 0) 
        {
            writefln("Error: Example body not found!");
            assert(0);
        }       
        endPos = find(inStr, endExampleBodyMarker);
        if(endPos < 0) 
        {
            writefln("Error: Example body end not found!");
            assert(0);
        }       
        exampleBody = inStr[begPos + begExampleBodyMarker.length .. endPos];
        inStr = inStr[endPos + endExampleBodyMarker.length .. $];



        debug writefln("Writing example file: %s", wikiExample);

        File outFile = new File(outputPath ~ wikiExample ~ ".html", FileMode.OutNew); 

        outFile.writeLine("<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"\n\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">");
        outFile.writeLine("<html><head><title>" ~ wikiExample ~ "</title>");
        outFile.writeLine(`<link rel="stylesheet" href="` ~ cssFile ~ `"/>`);
        outFile.writeLine("</head>");

        outFile.writeLine(`<body><pre>= ` ~ oldExampleName ~ ` =<br/>`);

        //outFile.writeLine(`<hr id="` ~ wikiExample ~ `"/>= ` ~ oldExampleName ~ " =<br/>");
        outFile.writeLine("''Part of'' " ~ wikiCategory ~ "<br/>");

        outFile.writeLine("== Description ==<br/>");
        outFile.writeLine(exampleDescription ~ `<br/>`);

        outFile.writeLine("== Example ==<br/>");
        outFile.writeLine("{{{");
        outFile.writeLine("#!d</pre>");

        /* output example body (might need some manual adjustments in "rawhtml" was used */

        outFile.writeLine(exampleBody);

        outFile.writeLine("}}}");


        outFile.writeLine("<pre>== Source ==<br/>");            
        outFile.writeLine("|| Link || " ~ oldDsourceExampleLink ~ " ||");
        outFile.writeLine("|| Posted by || " ~ postedBy ~ " ||");
        outFile.writeLine("|| Date/Time || " ~ datePosted ~ " ||");



        outFile.writeLine("</pre></body></html>");
        outFile.close();

        begPos = find(inStr, begExampleNumber);
        
        //if(begPos == 0 && begPos > endPos) done = true;
    }
    
}