/*      
        ********************************************************************
			           CJ's Servlet Graphics Package
        ********************************************************************

        February 20, 2000. CJ's Servlet Graphics Package. This 
        servlet was created February 20, 2000 by Erica Andrews. 
        The servlet makes images on the fly using the Acme GifEncoder 
        class library, lists all of the fonts available on the server, 
        and even has a draw-mode/preview feature for creating images. 
        CJ's Servlet Graphics Package Copyright 2000 by Erica Andrews 
        (cylikon@hotmail.com). All rights reserved. This servlet may NOT 
        be used for any sort of profit either directly or indirectly 
        without the express, written consent of the author of this servlet. 
        This servlet may NOT under any conditions, be used in any commercial 
        web sites.  This servlet is free for private, non-commercial use, but 
        may NOT be modified in anyway.  Doing so would constitute copyright 
        infringements.  In particular, the comments must remain in-tact and be left 
        as-is. 

        For more great Java stuff visit: 
            ./ButchWhipAppeal
            ./IcedPinky/

IMPORTANT:  This servlet REQUIRES the Acme GIFEncoder class libraries for creating 
            servlet images on the fly.  AWT alone will not do.  It is assumed that 
            you either already have these libraries or can find them on your own. 
            (Do a search on Altavista for "acme AND gifencoder".  It should come up.)


HELP/USAGE:  
  This servlet contains 3 useful utilities built into one class: 
    1.  A method for creating images on the fly (can be used as an image server).
    2.  A Draw-mode utility for creating and preview images to be created by this servlet.
    3.  A system Font Listing utility, which lists all the fonts available on the server on 
        which this servlet is running. 

Proper installation of the servlet is your responsibility and depends on your particular 
Java server. For this "help" file, we will call the servlet "graphics". 

** Using the FONT LISTING Utility: If you were to name this servlet "graphics" you could get 
   a list of all the fonts available on your server/computer by typing the following into any 
   web browser:    http://www.yourhost.com/graphics?list=yes
   The Font List utility also has a link back to Draw Mode, which will open in a new window.

** Using the DRAW MODE Utility:  If you were to name this servlet "graphics" you could enter
   Draw-Mode by typing the following into any web browser:       
   http://www.yourhost.com/graphics?drawmode=yes
 
   Draw Mode is perhaps the most useful utility.  Draw Mode displays an HTML form which will 
   allow you to create and preview image "buttons".  You can adjust fonts, colors, image sizes, 
   etc. The HTML form then places the <IMG SRC> code for that particular image in a 
   textarea on your left-hand side.  To use that image in one of your pages, just copy and 
   paste that code wherever you need it.  The people using your page will only see the image you
   created, not any of the other utilities, such as Draw Mode or the Font Lister. It's THAT 
   simple.    Draw Mode also has a handy link to the Font List utility, which will open 
   in a new window, to help make image creation faster.

** Creating Images On The Fly:  Simply copy and paste the <IMG SRC> tag created in the 
   textarea of the Draw Mode utility into your HTML pages.  Visit your page. You'll see 
   that the servlet is now acting as an image server.  Alternately, you can fool around 
   with the parameters in the URL string; however, this is doing things the hard way.

** IMPORTANT TIPS:  This servlet uses an init() method to load the fonts on your computer/server. 
   So, the best thing to do is this:  If your Java server allows you to load all servlets 
   or one particular servlet when the server starts, you should make sure that THIS servlet
   is one of the servlets loaded at start-up.  (It's your responsibility to find out 
   how to do this on your particular Java server.) When your Java server starts, you will 
   see it stall for a minute while it loads this servlet.  This is because the java 
   GrapicsEnvironment is slow loading the list of fonts.  However, this Font list 
   only needs to be loaded ONCE.  So, it's best to load the list when the server starts, rather 
   than having a visitor to your site have to wait while the font list loads, as this 
   would definitely slow down image loading in their browser, making them impatient.  
   (A visitor would only experience this stall if they are the *first* visitor to your 
   servlet since it was loaded by your server.)
   If you do not load this servlet when your java server starts, your first visit to this 
   servlet will always be very slow.  The Font List loaded at startup is good for the 
   entire life of the servlet, so if you happen to add new fonts while this servlet is loaded 
   and running, you will NOT see them in the list until you reload this servlet.  For some 
   people, this may require a complete restart of their Java server.

** OTHER INFO:  This servlet uses the SingleThreadModel, which means it is thread-safe because 
   it does not use more than one thread at a time.  This means that the servlet may be slow 
   handling multiple simultaneous requests for images.  For sites with many visitors, this 
   could create a performance issue.  However, this servlet was created for my personal use 
   on a private server.  One thread was enough for me, so that's what I created.  
   A future release *may* support multi-threading, whenever I get around to it.  

** COPYRIGHT:   Free for private, non-commercial use provided NO 
                modifications to this servlet are made and these comments are left as-is. 
                This servlet may not be used for any sort of profit, either directly or 
                indirectly, and may not be used in any commercial websites or intranets.
                Any other use of this servlet constitutes copyright infringements and 
                fraudulent misuse of this software, punishable in a court of law. 
                Copyright February 2000 by Li'L CJ aka Erica Andrews (cylikon@hotmail.com). 
                All rights reserved.  

*/

import java.io.*; 
import java.awt.*; 
import javax.servlet.*; 
import javax.servlet.http.*; 
import Acme.JPM.Encoders.GifEncoder; 
import java.awt.Font; 
import java.awt.FontMetrics; 
import java.lang.Integer; 
import java.util.Vector; 

public class GraphicsFactory extends HttpServlet implements SingleThreadModel                { 

protected String allfonts[]; 
public Frame frame = null; 
public Graphics g = null; 
public ServletOutputStream out; 
protected GraphicsEnvironment GE; 
private String FontList; 
public Vector v = new Vector(); 
Image realimage; 
Image image; 
Graphics g2; 
Image ErrorImage; 
Graphics g3; 

public void init(ServletConfig config) throws ServletException {  

  super.init(config); 
  // --- loading the whole list of available fonts during server start-up rather than runtime

  GE = GraphicsEnvironment.getLocalGraphicsEnvironment(); 
  allfonts = GE.getAvailableFontFamilyNames(); 
  this.GE = GE; 
  this.allfonts = allfonts; 
  // storing the font list into a vector than a string to be returned with the "list" command
  FontList = " "; 
  String newline = "<br>"; 
           for (int n=0; n<allfonts.length; n++)     { 
           v.addElement(allfonts[n]); 
           v.addElement(newline); 
                                                     }  

  FontList = v.toString(); 
  this.FontList = FontList; 
                                                               } //end of init method

public void doGet(HttpServletRequest request, HttpServletResponse res) 
                                    throws ServletException, IOException {
    
     // creating a way to write the image and text to the client
    out = res.getOutputStream(); 
 try { 
String list = "no";    // turn font list utility on-off
String yes = "yes"; 
int i1 = 0; 
int i2 = 200; 
int i3 =200; 
int t1 = 0; 
int t2 = 255; 
int t3 = 255; 
int s1 = 0; 
int s2 = 0; 
int s3 = 0; 
int size = 45; 
String font = "Shatter"; 
boolean raised = true;    // controls whether the Fill3DRect will be raised or not
String drawmode = "no";    // turn drawmode utility on-off 
String QueryString = "";   // a copy of the query string provided in the doGet method
String text = "CJs Servlet Graphics Package";  // default text to display on the image

/* ********* image testing to find image size through FontMetrics  ******   */ 
   // creating a null image, graphics and frame - a prototype so to speak
// Creating an unshown frame 
frame = new Frame(); 
frame.addNotify(); 

 // --- the image and graphics are currently null, will be defined later
 // --- creating a small "test" image - this image called "image" is NOT what will be displayed
 // -- it is only created for the purpose of using the getGraphics() and then the 
 // -- FontMetrics to determine the size of this particular font style/size combo - the 
 // --- pixel measurements found through this FontMetrics will be used for the image that 
 // --- is really displayed - called "realimage"

image = frame.createImage(2,2); // the real image size will be set later in "realimage" 
this.image = image; 
g = image.getGraphics();  
this.g = g; 

  if (request.getParameter("size") != null) { size = Integer.valueOf(request.getParameter("size").trim()).intValue(); } else {size = 45; }  

  if (request.getParameter("font") != null) { font = request.getParameter("font").trim(); } else {  font = "Shatter"; }   

Font f = new Font(font,Font.PLAIN,size); 
g.setFont(f); 

   // --- determining how big the image should be before we create it

        // --- getting the FontMetrics we need to determine the image size

FontMetrics fm = g.getFontMetrics(f); 

  if (request.getParameter("text") != null) { text = request.getParameter("text").trim();  } else {  text = "CJs Servlet Graphics Package";  }  

char ImageChars[] = text.toCharArray(); 
int CharWidth = ImageChars.length; 

   // ----- the real width of the string with this particular font and font size
int StringWidth = fm.charsWidth(ImageChars,0,CharWidth); 
int StringHeight = fm.getHeight(); 
  // below are the final dimensions to be used for creating the image
int width = StringWidth+4; //option to override the suggested width found through FontMetrics
int height = StringHeight; //option to override the suggested height found through FontMetrics


 /* ** First checking to see which parameters were provided in the query string.  If 
    ** the parameter is not null, the new value will be used.  Otherwise, the default 
    ** values listed above will be used instead.  */ 

  if (request.getQueryString() != null) { QueryString = request.getQueryString(); } else { 
     QueryString = "";  }   

  if (request.getParameter("raised") != null) { raised = Boolean.valueOf(request.getParameter("raised").trim()).booleanValue(); } else { raised = true;   }   

  if (request.getParameter("drawmode") != null) { drawmode = request.getParameter("drawmode").trim();  } else {  drawmode = "no";  }   

  if (request.getParameter("height") !=null) { 
      if (! request.getParameter("height").equals(""))  { height = Integer.valueOf(request.getParameter("height").trim()).intValue();  } else { height = StringHeight;  } }

  if (request.getParameter("width") != null) { 
      if (! request.getParameter("width").equals(""))  { width = Integer.valueOf(request.getParameter("width").trim()).intValue(); } else { width = StringWidth+4;  } }
 

  if (request.getParameter("list") != null) { list = request.getParameter("list").trim(); } else {  list = "no";  }  

  if (request.getParameter("i1") != null) { i1 = Integer.valueOf(request.getParameter("i1").trim()).intValue(); } else { i1 = 0; }   

  if (request.getParameter("i2") != null) { i2 = Integer.valueOf(request.getParameter("i2").trim()).intValue(); } else { i2 = 200; }    

  if (request.getParameter("i3") != null) { i3 = Integer.valueOf(request.getParameter("i3").trim()).intValue(); } else {  i3 = 200; }    

  if (request.getParameter("t1") != null) { t1 = Integer.valueOf(request.getParameter("t1").trim()).intValue(); } else { t1 = 0;}  

  if (request.getParameter("t2") != null) { t2 = Integer.valueOf(request.getParameter("t2").trim()).intValue(); } else { t2 = 255;  }   

  if (request.getParameter("t3") != null) { t3 = Integer.valueOf(request.getParameter("t3").trim()).intValue(); } else {  t3 = 255;  }  

  if (request.getParameter("s1") != null) { s1 = Integer.valueOf(request.getParameter("s1").trim()).intValue(); } else { s1 = 0; }  

  if (request.getParameter("s2") != null) { s2 = Integer.valueOf(request.getParameter("s2").trim()).intValue();} else { s2 = 0; }   

  if (request.getParameter("s3") != null) { s3 = Integer.valueOf(request.getParameter("s3").trim()).intValue(); } else {  s3 = 0; }   

  

 

// **************************
// Beginning of Font List utility
/* This is a small utility I built into the servlet that will allow me to display a list 
   of all my system fonts that were loaded when the server started with the init() method 
   using the getAvailableFontFamilyNames() method.  I can view the list of fonts by 
   typing in "list=yes" into parameters of this servlet's query string.  Otherwise, this 
   font list remains completely invisible to the end user and just serves as a means of creating    images on the fly.   */ 

 // now checking to see if the "list" parameter said yes - in which case, the list 
 // of fonts available on the system will be listed.  Otherwise, just the image will be shown 

     if (list.equals(yes))  { 
// The font list "FontList" is being returned by a toString() of a vector "v" - so the 
// string will contain they array delimiters ( [,]) which I want to remove from the 
// string, so that the list looks clean. The unwanted characters are replaced with empty
// characters.

String b1 = "]"; // getting rid of the brackets in the vector
String b2 = "["; 
String comma = ","; // getting rid of the commas in the vector
String emptystring = "  "; 
int fontl1 = FontList.indexOf(b1); 
if (fontl1 != -1) { // make sure we haven't already cleaned out the Vector 
                   // if this character has already be removed, the indexOf will = -1
FontList = FontList.replace(FontList.charAt(fontl1),emptystring.charAt(1)); }
this.FontList = FontList; 
int fontl2 = FontList.indexOf(b2); 
if (fontl2 != -1) { 
FontList = FontList.replace(FontList.charAt(fontl2),emptystring.charAt(1)); }
this.FontList = FontList; 
int fontl3 = FontList.indexOf(comma); 
if (fontl3 != -1) { 
FontList = FontList.replace(FontList.charAt(fontl3),emptystring.charAt(1)); }
this.FontList = FontList; // The final FontList String we want to use
                         // THIS cleaned Vector.toString() FontList is the FontList 
                        // which will be used for the life of the servlet
         drawmode = "no"; // disabling draw-mode while listing fonts
         res.setContentType("text/html");  
         out.print("<b>Total fonts:</b> "+allfonts.length+"  &nbsp;&nbsp; <a href='/graphics?drawmode=yes' target='AnewWinDow'>Go Into Draw-Mode</a> <br><br>"); 
         out.flush(); // send this portion to the client now
         out.print(FontList); 
         out.flush(); 
         // credits 
         out.print("<br><hr width='30%'><table border=3 bgcolor='#00dddd' width='%30'><tr><td><font size=-1>"); 
         out.print("<b>CJ's Servlet Graphics Package</b><br>Copyright 2000 by Erica Andrews (<a href='mailto:cylikon@hotmail.com'>cylikon@hotmail.com</a>). All rights reserved. This servlet may NOT be used for any sort of profit either directly or indirectly without the express, written consent of the author of this servlet.  For more cool Java stuff, visit:  <a href='./ButchWhipAppeal/'>./ButchWhipAppeal/</a> and  <a href='./IcedPinky/'>./IcedPinky/</a>."); 
       out.print("</td></tr></table>"); 

                        }   
// *************************
// Beginning of Draw-Mode utility
/*  This is another small utility that allows the servlet user to preview images to be used 
    in pages by adjust the colors, font, font size, and image size through forms.  The 
    utility is good for helping you choose the right image and color scheme. I can enter         draw-mode by typing "drawmode=yes" into parameters of this servlet's query string.          Otherwise, this feature remains completely invisible to the end user and just serves as a        means of creating images on the fly. If the user asks to go into draw-mode, a form 
    will be printed out, allowing them to edit the query string parameters that create 
    the image. */

       else if (drawmode.equals(yes))                                                   { 

// in order to show the image, we need to remove the "drawmode=yes" out of the query 
// string that will be used to re-call the servlet and show the image. We can just
// remove the drawmode=yes substring.
int yesfind = QueryString.indexOf("drawmode=yes"); 
StringBuffer sb = new StringBuffer(QueryString); 
String querysub = sb.delete(yesfind,yesfind+12).toString(); 
String query = ""; 
if (!QueryString.equals("")) { query = querysub; } else {query=""; }

          res.setContentType("text/html"); 
          out.print("<center><font size=5 color='#0000ff'>CJ's Draw-Mode Utility</font><br>"); 
          out.flush(); // start sending data to client while we wait
   //a copy of the updated image
          out.print("<img src='/graphics?"+query+"'></center><center>Dimensions: "); 
          out.print(width+" X "+height); 
          out.flush(); // start sending data to client while we wait
          out.print("</center><center>Font Face: "+f.getFontName()+", Font Family: "+f.getFamily());
          out.print("<form action='/graphics' method='get'>"); 
           // showing the query-string/URL needed for this image (for copy-paste purposes) 
          out.print("<table border=0><tr><td>"); 
          out.print("<font size=2 color='#0000bb'><br><b>Code for this image:</b><br>"); 
          out.print("<pre><textarea rows=8 cols=13 wrap=soft>"); 
          out.print("&lt;img src='/graphics?"+query+"'></textarea></pre></td><td>"); 
          out.flush(); // start sending data to client while we wait
          out.print("<font size=2 color='#0000bb'>Font:</font> <input type=text name=font value='"+font+"'> <font size=2>"); 
          out.print("<a href='/graphics?list=yes' target='newwindow'><br>Show Available Fonts</a><br></font><font size=2 color='#0000bb'>"); 
          out.print("Font Size: <input type=text name=size size=3 maxlength=3 value='"+size+"'><br>"); 
          out.flush(); // start sending data to client while we wait
          out.print("Text: <input type=text name=text value='"+text+"'><br>"); 
          out.print("Image Color: <input type=text name=i1 size=3 maxlength=3 value='"+i1+"'><input type=text name=i2 size=3 maxlength=3 value='"+i2+"'><input type=text name=i3 size=3 maxlength=3 value='"+i3+"'> (Red|Green|Blue, 0-255)<br>"); 
          out.print("Text Color: <input type=text name=t1 size=3 maxlength=3 value='"+t1+"'><input type=text name=t2 size=3 maxlength=3 value='"+t2+"'><input type=text name=t3 size=3 maxlength=3 value='"+t3+"'> (Red|Green|Blue, 0-255)</td><td>"); 
          out.flush(); // start sending data to client while we wait
          out.print("<font size=2 color='#0000bb'>Text Shading: <input type=text name=s1 size=3 maxlength=3 value='"+s1+"'><input type=text name=s2 size=3 maxlength=3 value='"+s2+"'><input type=text name=s3 size=3 maxlength=3 value='"+s3+"'> (Red|Green|Blue, 0-255)<br>"); 
         out.print("Image Raised?: <input type=text name=raised size=5 maxlength=5 value='"+raised+"'> (true|false, case-sensitive)<br>"); 
          out.flush(); // start sending data to client while we wait
         out.print("Image Height: <input type=text name=height size=3 maxlength=3> (Optional - number of pixels)<br>"); 
         out.print("Image Width: <input type=text name=width size=3 maxlength=3><i>(Optional - number of pixels)</i></td></tr></table>"); 
          out.flush(); // start sending data to client while we wait
        // --creating a hiddne parameter to keep us in draw-mode
         out.print("</center><center><input type='submit' value='Image Preview!'><input type=hidden name=drawmode value='yes'></form>"); 

         // --credits 
         out.print("<table border=3 bgcolor='#00dddd' width='600'><tr><td><font size=-1>"); 
          out.flush(); // start sending data to client while we wait
         out.print("<b>CJ's Servlet Graphics Package</b><br>Copyright 2000 by Erica Andrews (<a href='mailto:cylikon@hotmail.com'>cylikon@hotmail.com</a>). All rights reserved. This servlet may NOT be used for any sort of profit either directly or indirectly without the express, written consent of the author of this servlet.  For more cool Java stuff, visit:  <a href='./ButchWhipAppeal/'>./ButchWhipAppeal/</a> and  <a href='./IcedPinky/'>./IcedPinky/</a>."); 
       out.print("</td></tr></table>"); 


       											}

// ***********************
// Beginning of basic image-on-the-fly creation
  /* If the user did not ask to see a list of fonts and did not ask to go into draw-mode, 
     then the servlet will simply return an image   */

       else {     


try { 

  // ---- now, creating the actual image "realimage"
realimage = frame.createImage(width,height); 
this.realimage = realimage; 
g2 = realimage.getGraphics(); 
this.g2 = g2; 
g2.setFont(f); 
g2.setColor(new Color(i1,i2,i3));   // base image color
g2.fill3DRect(0,0,width,height,raised); 
g2.setColor(new Color(s1,s2,s3));   // text shading color

int y1 = height-fm.getDescent()-2; 
int y2 = height-fm.getDescent()-1; 
     // --- drawing TWO copies of the string at slightly 
     // --- different positions to create a shading effect
g2.drawString(text, 4, y2);   // drawing text shading
g2.setColor(new Color(t1,t2,t3));   // actual text colors
g2.drawString(text, 2, y1);    // drawing text

// Encode the off screen image into a GIF and send it to the client res.setContentType("image/gif");
GifEncoder encoder = new GifEncoder(realimage, out); encoder.encode(); 

// Error Handling 
     /*  Handles instances where people choose an RGB color index outside of the 
      *  range of 0-255   */

         } catch (IllegalArgumentException iae) { 
            // showing a default error image
               res.setContentType("image/gif"); 
               ErrorImage = frame.createImage(350,20);  
               g3 = frame.getGraphics();    
               g3.setFont(new Font("Serif",Font.PLAIN,8)); 
               g3.setColor(new Color(255,0,0));   // base image color
               g3.fill3DRect(0,0,350,20,false); 
               g3.setColor(new Color(255,255,255)); 
               g3.drawString("ERROR: The RGB color index you entered was not between 0-255", 18, 18);  
               this.ErrorImage = ErrorImage; 
               this.g3 = g3;
               GifEncoder errorim = new GifEncoder(ErrorImage,out); 
               errorim.encode(); 
                     } finally { 

// Clean up resources 

if (g != null) 
   g.dispose(); 
if (frame != null) 
  frame.removeNotify();  
if (g2 != null) 
  g2.dispose(); 
if (image != null) 
   image.flush(); 
if (realimage != null) 
   realimage.flush();  
// if there was an error image, let's get rid of that too
if (g3 != null) 
  g3.dispose(); 
if (ErrorImage != null) 
  ErrorImage.flush();         } // end of try-finally 

               } // end If-Else**

// Error handling 
      /* Handles instances where people insert non-numeric characters into the query 
       * string where numbers are needed (i.e. "abc" instead of 255); */

          }catch (NumberFormatException nfe) { out.print("<br><center><hr><font color=#ff0000><h1>ERROR CREATING IMAGE!:</h1><br></font><font size=4 color=#0000bb> You entered non-numeric characters where numbers were required!<br><hr>");   

   } // end BIG try-catch

                                                                       } // end of doGet method

// --- Servlet Info method

    public String getServletInfo()                                    {
        return "CJ's Servlet Graphics Package. This servlet was created February 20, 2000 by Erica Andrews. The servlet makes images on the fly using the Acme GifEncoder class library, lists all of the fonts available on the server, and even has a draw-mode/preview feature for creating images. CJ's Servlet Graphics Package Copyright 2000 by Erica Andrews (cylikon@hotmail.com). All rights reserved. This servlet may NOT be used for any sort of profit either directly or indirectly without the express, written consent of the author of this servlet.";  } 


                								  } // end Class