WebGoat/webgoat/main/project/org/owasp/webgoat/lessons/LessonAdapter.java

package org.owasp.webgoat.lessons;

import java.io.BufferedReader;
import java.io.FileReader;
import java.util.ArrayList;
import java.util.List;

import org.apache.ecs.Element;
import org.apache.ecs.ElementContainer;
import org.apache.ecs.HtmlColor;
import org.apache.ecs.StringElement;
import org.apache.ecs.html.Center;
import org.apache.ecs.html.H3;
import org.apache.ecs.html.IMG;
import org.apache.ecs.html.P;
import org.apache.ecs.html.PRE;
import org.apache.ecs.html.TD;
import org.apache.ecs.html.TR;
import org.apache.ecs.html.Table;

import org.owasp.webgoat.session.WebSession;

/**
 *  Copyright (c) 2002 Free Software Foundation developed under the custody of the Open Web
 *  Application Security Project (http://www.owasp.org) This software package org.owasp.webgoat.is published by OWASP
 *  under the GPL. You should read and accept the LICENSE before you use, modify and/or redistribute
 *  this software.
 *
 * @author     Jeff Williams <a href="http://www.aspectsecurity.com">Aspect Security</a>
 * @created    October 28, 2003
 */
public abstract class LessonAdapter extends AbstractLesson
{
    final static IMG ASPECT_LOGO = new IMG( "images/logos/aspect.jpg" ).setAlt( "Aspect Security" ).setBorder( 0 ).setHspace( 0 ).setVspace( 0 );
	/**
	 *  Description of the Method
	 *
	 * @param  s  Description of the Parameter
	 * @return    Description of the Return Value
	 */
	protected Element createContent( WebSession s )
	{
		// Mark this lesson as completed.  
		makeSuccess( s );
		
		ElementContainer ec = new ElementContainer();

		ec.addElement( new Center().addElement( new H3().addElement( new StringElement( "This lesson needs a creator." ) ) ) );
		ec.addElement( new P() );
		ec.addElement( new StringElement( "Lesson are simple to create and very little coding is required. &nbsp;&nbsp;" +
				"In fact, most lessons can be created by following the easy to use instructions in the " +
				"<A HREF=http://prdownloads.sourceforge.net/owasp/WebGoatVersion2UserGuide.pdf?download>WebGoat User Guide.</A>&nbsp;&nbsp;" +
				"If you would prefer, send your lesson ideas to " + s.getFeedbackAddress() ) );
		
		String fileName = s.getContext().getRealPath( "doc/New Lesson Instructions.txt");
		if ( fileName != null ) 
		{
			try 
			{
				PRE pre = new PRE();
				BufferedReader in = new BufferedReader( new FileReader( fileName ));
				String line = null;
				while ( (line = in.readLine()) != null )
				{
					pre.addElement( line + "\n");
				}
				ec.addElement( pre );
			} 
			catch ( Exception e ){}
		}
		return ( ec );
	}


	protected Element createStagedContent( WebSession s )
	{
		try
		{
			int stage = getLessonTracker(s).getStage();
			//int stage = Integer.parseInt( getLessonTracker(s).getLessonProperties().getProperty(WebSession.STAGE,"1"));

			switch ( stage )
			{
					case 1:
						return ( doStage1( s ) );
					case 2:
						return ( doStage2( s ) );
					case 3:
						return ( doStage3( s ) );
					case 4:
						return ( doStage4( s ) );
					case 5:
						return ( doStage5( s ) );
					case 6:
						return ( doStage6( s ) );
					default:
						throw new Exception( "Invalid stage" );
			}
		}
		catch ( Exception e )
		{
			s.setMessage( "Error generating " + this.getClass().getName() );
			System.out.println( e );
			e.printStackTrace();
		}

		return ( new StringElement( "" ) );
	}
	
	
	protected Element doStage1( WebSession s ) throws Exception
	{
		ElementContainer ec =  new ElementContainer();
		ec.addElement("Stage 1 Stub");
		return ec;
	}
	
	
	protected Element doStage2( WebSession s ) throws Exception 
	{
		ElementContainer ec =  new ElementContainer();
		ec.addElement("Stage 2 Stub");
		return ec;
	}
	
	
	protected Element doStage3( WebSession s )  throws Exception
	{
		ElementContainer ec =  new ElementContainer();
		ec.addElement("Stage 3 Stub");
		return ec;
	}
	
	
	protected Element doStage4( WebSession s )  throws Exception
	{
		ElementContainer ec =  new ElementContainer();
		ec.addElement("Stage 4 Stub");
		return ec;
	}
	
	
	protected Element doStage5( WebSession s )  throws Exception
	{
		ElementContainer ec =  new ElementContainer();
		ec.addElement("Stage 5 Stub");
		return ec;
	}
	
	
	protected Element doStage6( WebSession s )  throws Exception
	{
		ElementContainer ec =  new ElementContainer();
		ec.addElement("Stage 6 Stub");
		return ec;
	}
	
	/**
	 *  Gets the category attribute of the LessonAdapter object. The default category is "General" Only
	 *  override this method if you wish to create a new category or if you wish this lesson to reside
	 *  within a category other the "General"
	 *
	 * @return    The category value
	 */
	protected Category getDefaultCategory()
	{
		return GENERAL;
	}

	protected boolean getDefaultHidden()
	{
		return false;
	}
	
	private final static Integer DEFAULT_RANKING = new Integer(1000);

	protected Integer getDefaultRanking()
	{
		return DEFAULT_RANKING;
	}

	/**
	 *  Gets the hintCount attribute of the LessonAdapter object
	 *
	 * @return    The hintCount value
	 */
	public int getHintCount()
	{
		return getHints().size();
	}


	/**
	 *  Fill in a minor hint that will help people who basically get it, but are stuck on somthing
	 *  silly. Hints will be returned to the user in the order they appear below. The user must click
	 *  on the "next hint" button before the hint will be displayed.
	 *
	 * @return    The hint1 value
	 */
	protected List getHints()
	{
		List hints = new ArrayList();
		hints.add( "There are no hints defined." );

		return hints;
	}

	public String getHint(int hintNumber)
	{
		return (String) getHints().get(hintNumber);
	}

	/**
	 *  Gets the credits attribute of the AbstractLesson object
	 *
	 * @return    The credits value
	 */
	public Element getCredits()
	{
		return getCustomCredits("Sponsored by&nbsp;", ASPECT_LOGO);
	}

	/**
	 *  Gets the instructions attribute of the LessonAdapter object. Instructions will rendered as html
	 *  and will appear below the control area and above the actual lesson area. Instructions should
	 *  provide the user with the general setup and goal of the lesson.
	 *
	 * @return    The instructions value
	 */
	public String getInstructions(WebSession s)
	{
        StringBuffer buff = new StringBuffer();
        try 
        {
            String fileName = s.getWebResource(getLessonPlanFileName()); 
            if ( fileName != null ) 
            {
				BufferedReader in = new BufferedReader( new FileReader( fileName ));
				String line = null;
				boolean startAppending = false;
				while ( (line = in.readLine()) != null )
				{
					if ( line.indexOf( "<!-- Start Instructions -->") != -1 )
					{
						startAppending = true;
						continue;
					}
					if ( line.indexOf( "<!-- Stop Instructions -->") != -1 )
					{
						startAppending = false;
						continue;
					}
					if ( startAppending ) 
					{
						buff.append( line + "\n");
					}
				}
            }
        } 
        catch ( Exception e ){}
		
        return buff.toString();

	}


	/**
	 *  Fill in a descriptive title for this lesson. The title of the lesson. This will appear above
	 *  the control area at the top of the page. This field will be rendered as html.
	 *
	 * @return    The title value
	 */
	public String getTitle()
	{
		return "Untitled Lesson " + getScreenId();
	}

	public String getCurrentAction(WebSession s)
	{
		return s.getLessonSession(this).getCurrentLessonScreen();
	}
	
	public void setCurrentAction(WebSession s, String lessonScreen)
	{
		s.getLessonSession(this).setCurrentLessonScreen(lessonScreen);
	}
	
	public Object getSessionAttribute(WebSession s, String key) {
		return s.getRequest().getSession().getAttribute(key);
	}
	
	public void setSessionAttribute(WebSession s, String key, Object value) {
		s.getRequest().getSession().setAttribute(key, value);
	}
	
	/**
	 *  Description of the Method
	 *
	 * @param  s  Description of the Parameter
	 * @return    Description of the Return Value
	 */
	protected Element makeSuccess(WebSession s) 
	{	    
	    getLessonTracker( s ).setCompleted( true );
	    
	    s.setMessage("Congratulations. You have successfully completed this lesson.");
	    
	    return ( null );
	}


	/**
	 *  Gets the credits attribute of the AbstractLesson object
	 *
	 * @return    The credits value
	 */
	protected Element getCustomCredits(String text, IMG logo) 
	{
		ElementContainer ec = new  ElementContainer();
	
		Table t = new Table().setCellSpacing( 0 ).setCellPadding( 0 ).setBorder( 0 ).setWidth("90%").setAlign("RIGHT");
	    TR tr = new TR();
		tr.addElement( new TD(text).setVAlign("MIDDLE").setAlign("RIGHT").setWidth("100%"));
		tr.addElement( new TD(logo).setVAlign("MIDDLE").setAlign("RIGHT"));
		t.addElement(tr);

		return t;
	}
}