/*
    * Created on Apr 27, 2005, Copyright UC Regents
    */
   package org.telscenter.pas.steps;
   
   import java.awt.BorderLayout;
   import java.awt.Component;
   import java.awt.Dimension;
   import java.awt.FlowLayout;
  import java.awt.GridLayout;
  import java.awt.event.ActionEvent;
  import java.awt.event.ActionListener;
  import java.awt.event.WindowEvent;
  import java.awt.event.WindowListener;
  import java.io.IOException;
  import java.net.MalformedURLException;
  import java.net.URL;
  import java.util.logging.Logger;
  
  import javax.swing.AbstractAction;
  import javax.swing.Action;
  import javax.swing.BorderFactory;
  import javax.swing.JButton;
  import javax.swing.JComponent;
  import javax.swing.JDialog;
  import javax.swing.JPanel;
  import javax.swing.JTextField;
  
  import net.sf.sail.core.util.BinaryUtils;
  
  import org.telscenter.pas.ui.browser.BrowserEvent;
  import org.telscenter.pas.ui.browser.BrowserFactory;
  import org.telscenter.pas.ui.browser.BrowserFactoryRegistry;
  import org.telscenter.pas.ui.browser.IBrowser;
  import org.telscenter.pas.ui.browser.IBrowserListener;
  import org.telscenter.pas.ui.browser.NavigationPolicy;
  import org.telscenter.pas.ui.util.PasColors;
  
  /***
   * Abstract super implementation of the Pas step types, <i>DisplayPage</i> and
   * <i>Evidence</i>.
   * 
   * @author turadg
   */
  
  public abstract class BrowseWeb extends AbstractUrlStep {
  
  	/***
  	 * 
  	 */
  	private static final int MAX_PROGRESS = 100;
  
  	protected String content;
  	protected boolean isAuthoringHTMLPage = false;
  	
  	/***
  	 * Logger for this class
  	 */
  	private static final Logger logger = Logger.getLogger(BrowseWeb.class
  			.getName());
  
  	final static URL ERROR_URL;
  	static {
  		
  		/*
  		 * Initializes an error URL to use for when an invalid URL is set
  		 * in a step.
  		 */
  		URL tempUrl = null;
  		try {
  			tempUrl = new URL(Messages.getString("BrowseWeb.error_url")); //$NON-NLS-1$
  		} catch (Exception e) {
  			e.printStackTrace();
  		}
  		ERROR_URL = tempUrl;
  
  		
  		/*
  		 * The try blocks below each try to initialize factories for browsers
  		 * that will be used for displaying html and web pages.
  		 */
  		
  		try {
  			// FIXME: This is a hack for now so things will build again
  			// This should be configured outside of this step
  			BrowserFactory wrFactory = (BrowserFactory) Class.forName(
  					"org.telscenter.pas.ui.browser.WebRendererFactory")
  					.newInstance();
  			BrowserFactoryRegistry.registerFactory(wrFactory, 3);
  			logger.info("Registered WebRenderer browser factory");
  		} catch (Throwable t) {
  			logger
  					.warning("Failed to load and register WebRenderer Browser factory - "
  							+ t);
  		}
  
  		try {
  			// FIXME: This is a hack for now so things will build again
  			// This should be configured outside of this step
 			BrowserFactory jdicFactory = (BrowserFactory) Class.forName(
 					"org.telscenter.pas.ui.browser.jdic.JDICBrowserFactory")
 					.newInstance();
 			BrowserFactoryRegistry.registerFactory(jdicFactory, 1);
 			logger.info("Registered JDIC browser factory");
 		} catch (Throwable t) {
 			logger
 					.warning("Failed to load and register JDIC Browser factory - "
 							+ t);
 		}
 		
 		try {
 			// FIXME: This is a hack for now so things will build again
 			// This should be configured outside of this step
 			BrowserFactory mozswingFactory = (BrowserFactory) Class.forName(
 					"org.telscenter.pas.ui.browser.mozswing.MozSwingBrowserFactory")
 					.newInstance();
 			BrowserFactoryRegistry.registerFactory(mozswingFactory, 1);
 			logger.info("Registered MozSwing browser factory");
 		} catch (Throwable t) {
 			logger
 					.warning("Failed to load and register MozSwing Browser factory - "
 							+ t);
 		}
 		
 		
 	}
 	
 	private JButton saveLinkButton;
 
 	private BrowserFactory browserFactory;
 
 	protected IBrowser browser;
 
 	protected NavigationPolicy navigationPolicy;
 
 	private BrowseWebUI browseWebUI = null;
 
 	/*
 	 * Sets the content of this BrowseWeb object which may be html
 	 */
 	public void setContent(String content) {
 		if( browser != null ) {
 			browser.setContent(content);
 		}
 			
 		this.content = content;
 	}
 	
 	/*
 	 * @return the web browser component which in some cases will be used
 	 * to preview the html or web page
 	 */
 	public Component getComponent() {
 		// TODO does this UI need to be remade on every call to getComponent()?
 		browseWebUI = new BrowseWebUI(this);
 
 		return  browseWebUI;
 	}
 
 	/*
 	 * @return the panel that contains the web browser component which in some 
 	 * cases will be used to preview the html or web page
 	 */
 	public JComponent getWebBrowserComponent() {
 		beforeSessionStart(); //initializes the browser and variables
 		//initializeBeanContextResources();
 		
 		JPanel panel = new JPanel();
 		panel.setLayout(new GridLayout(1, 1));
 		Component component = browser.getComponent();
 		browser.getComponent().repaint();
 		panel.add(component);
 		panel.setSize(400, 500);
 		panel.validate();
 		return panel;
 	}
 
 	/*
 	 * @return preview action that is performed when Preview button is clicked
 	 */
 	public Action getPreviewAction(boolean hasAddressBar) {
 		return new PopupPreviewAction(hasAddressBar);
 	}
 	
 	/*
 	 * @param textField for outside link steps, this is a reference to the 
 	 * 			text field that contains the URL so that if the user changes
 	 * 			the link in the preview browser, they can click save link
 	 * 			and the link will be transferred back to the authoring
 	 * 			text field
 	 * @return preview action that is performed when Preview button is clicked
 	 */
 	public Action getPreviewAction(boolean hasAddressBar, JTextField textField) {
 		return new PopupPreviewAction(hasAddressBar, textField);
 	}
 	
 	/*
 	 * class that is used to implement the preview feature
 	 */
 	public class PopupPreviewAction extends AbstractAction {
 
 		//used as a reference to the text field for outside link
 		JTextField textField;
 		private boolean isSavingLink;
 		
 		/***
 		 * @param hasAddressBar 
 		 * 
 		 */
 		public PopupPreviewAction(boolean hasAddressBar) {
 			this.isSavingLink = false;
 		}
 		
 		/*
 		 * constructor that sets the text field for outside link
 		 */
 		public PopupPreviewAction(boolean hasAddressBar, JTextField textField) {
 			this.textField = textField;
 			this.isSavingLink = true;
 		}
 		
 		/*
 		 * This is run when the preview button is clicked
 		 */
 		public void actionPerformed(ActionEvent e) {
 			final JDialog dialog = new JDialog(); //the popup for the preview
 			
 			dialog.getContentPane().setLayout(new BorderLayout(0,0));
 			
 			//adds the browser to the middle of the popup
 			dialog.getContentPane().add(BrowseWeb.this.getComponent(),
 					BorderLayout.CENTER);
 			
 			/* sets the toolbar to be not visible because the browser already
 			   has the toolbar imbedded in it */
 			BrowseWeb.this.getBrowseWebUI().setBrowserToolbarPanelVisible(false);
 			
 			//adds the save link button to the bottom of the popup
 			dialog.getContentPane().add(createSaveLinkButtonPanel(), 
 					BorderLayout.SOUTH);
 			
 			
 			try {
 				//sets the URL of the browser to be the URL from the text field
 				if(textField != null) {
 					browser.setUrl(new URL(textField.getText()));
 				}
 			} catch (MalformedURLException mURLE) {
 				//System.out.println(mURLE);
 			}
 			
 		
 			if( isSavingLink ) {
 			//the action that is performed when the save link button is clicked
 			saveLinkButton.addActionListener(new ActionListener(){
 
 				public void actionPerformed(ActionEvent arg0) {
 					/* if this is an outside link step, the text field will not
 					   be null, and if there is a url in the preview popup
 					   browser, we will send that url back to the authoring
 					   panel and update the text field with that url*/
 					//System.out.println(browser.getUrl());
 					if(textField != null && browser.getUrl() != null) {
 						textField.setText(browser.getUrl().toString());
 						setUrl(browser.getUrl());
 					}
 					
 					/* closes the preview popup */
 					dialog.setVisible(false);
 					dialog.dispose();
 				}
 			});
 			} else {
 				saveLinkButton.setText("Close");
 				saveLinkButton.addActionListener(new ActionListener(){
 
 					public void actionPerformed(ActionEvent arg0) {
 						
 						dialog.setVisible(false);
 						dialog.dispose();
 					}
 				});
 			}
 			
 			//disposes the popup when closed
 			dialog.setDefaultCloseOperation(JDialog.DISPOSE_ON_CLOSE);
 			
 			//sets the size of the preview popup
 			dialog.setPreferredSize(new Dimension(650,500));
 			
 			/* makes sure this popup is sized correctly in relation to its sub
 			   components */
 			dialog.pack();
 			
 			/*
 			 * makes sure the popup shows up on top of all the other windows
 			 * so the user is sure not to miss it
 			 */
 			dialog.setVisible(true);
 			dialog.toFront();
 			dialog.transferFocus();
 			//dialog.setAlwaysOnTop(true);
 		}
 	}
 	
 	/*
 	 * @return a panel with the save link button
 	 */
 	protected JPanel createSaveLinkButtonPanel() {
 		
 		JPanel panel = new JPanel(new FlowLayout(FlowLayout.CENTER));
 		
 		saveLinkButton = new JButton(); //this is a global var
 		
 		/*
 		 * displays save link or save page depending on the step type
 		 */
 		if(getType().equals("Outside Link")) {
 			saveLinkButton.setText("Save Link");
 			saveLinkButton.setToolTipText("Save this Link");
 		} else if(getType().equals("Display")) {
 			saveLinkButton.setText("Save Page");
 			saveLinkButton.setToolTipText("Save this Page");
 		}
 		
 		panel.setBackground(PasColors.browseWebBackgroundColor);
 		panel.setBorder(BorderFactory.createEmptyBorder(6, 6, 0, 6));
 		panel.add(saveLinkButton);
 		panel.setOpaque(false);
 		return panel;
 	}
 	
 	
 	/***
 	 * build the native browser now because it will slow down the step access
 	 */
 	protected void beforeSessionStart() {
 		if (browserFactory == null) {
 			browserFactory = BrowserFactoryRegistry.getBestFactory();
 		}
 
 		//gets the browser from the factory
 		browser = browserFactory.getBrowser();
 		
 		//sets the content such as the html
 		if( content != null ) {
 			browser.setContent(content);
 		}
 		
 		//listener for browser actions, I don't think we use any of these
 		browser.addBrowserListener(new IBrowserListener() {
 
 			public void documentCompleted(BrowserEvent event) {
 				logger.info(".documentCompleted()");
 
 			}
 
 			public void downloadCompleted(BrowserEvent event) {
 				logger.info(".downloadCompleted()");
 
 				browseWebUI.getProgressBar().setValue(56);
 				browseWebUI.getProgressBar().setString("DOWNLOAD COMPLETED");
 				browseWebUI.getProgressBar().setIndeterminate(true);
 				browseWebUI.getProgressBar().repaint();
 				logger.info("GET "
 						+ browseWebUI.getProgressBar().getValue());
 			}
 
 			public void downloadProgress(BrowserEvent event) {
 				logger.info(".downloadProgress()");
 			}
 		});
 		
 		//makes the url safe, is this necessary?
 		URL safeUrl = makeSafe(browser, url);
 		
 		/* if we are authoring an Evidence or Display Page, we do not want to
 		   set the URL because that will cause the author's html to not load */
 		if(!isAuthoringHTMLPage() && url != null) {
 			browser.setUrl(safeUrl);
 		}
 		
 		//navigation policy determines what type of url strings are allowed
 		if (navigationPolicy != null) {
 			browser.setNavigationPolicy(navigationPolicy);
 		}
 	}
 
 	/*
 	 * sets the url of the browser
 	 */
 	public void setUrl(URL url) {
 		super.setUrl(url);
 		if (browser != null) {
 			URL safeUrl = makeSafe(browser, url);
 			browser.setUrl(safeUrl);
 		}
 	}
 
 	/***
 	 * @return the navigationPolicy
 	 */
 	public NavigationPolicy getNavigationPolicy() {
 		return navigationPolicy;
 	}
 
 	/***
 	 * @param navigationPolicy
 	 *            the navigationPolicy to set
 	 */
 	public void setNavigationPolicy(NavigationPolicy navigationPolicy) {
 		if (navigationPolicy == null)
 			throw new NullPointerException("null navigationPolicy argument");
 		Object old = this.navigationPolicy;
 		this.navigationPolicy = navigationPolicy;
 		firePropertyChange("navigationPolicy", old, navigationPolicy); //$NON-NLS-1$
 	}
 
 	/*
 	 * I don't think we need this anymore because we either display online
 	 * web pages or html pages created by the user that are retrieved from
 	 * memory and not written to a file and then accessed by their file URL
 	 */
 	public static URL makeSafe(IBrowser browser, URL location) {
 		if (location == null)
 			location = ERROR_URL;
 
 		// can't just check type of 'browser' because not all classes (JNI) can
 		// load everywhere
 
 		// if it's not understood by native component, convert it
 		try {
 			if (!isNativeSafe(location))
 				location = BinaryUtils.toFileUrl(location);
 		} catch (IOException e) {
 			// TODO Auto-generated catch block
 			logger.severe("URL -  : exception: " + e); //$NON-NLS-1$
 		}
 
 		// At least Safari and jdic with mozilla on linux
 		// need extra slashes in file urls
 		// I don't think adding extra slashes will hurt
 		// anything.
 		/*
 		 * String browserType = browser.getBrowserType(); if
 		 * (browserType.equals("safari")) //$NON-NLS-1$ location =
 		 * makeSafariSafe(location);
 		 */
 		location = addFileURLSlashes(location);
 
 		return location;
 	}
 
 	/***
 	 * Some browsers require file urls to more than one slash, this is intended
 	 * to allow relative file urls. Safari requires at least 2 slashes before a
 	 * file url is considered absolute. Firefox on linux using jdic requires 3
 	 * slashes before a file url is considered absolute.
 	 * 
 	 * @param url
 	 * @return
 	 */
 	private static URL addFileURLSlashes(URL url) {
 		if (!url.getProtocol().equals("file")) //$NON-NLS-1$
 			return url;
 
 		// now we know url starts with "file:"
 
 		String extForm = url.toExternalForm();
 		if (extForm.startsWith("file:///")) { //$NON-NLS-1$
 			// then it has the necessary triple slash
 			return url;
 		} else {
 			// has less than 3 slashes, add a minimum of 3
 			String path = url.getPath();
 			URL newUrl;
 			try {
 				// for some reason the url string needs a total of 5 slashes
 				// before
 				// its toString method returns a url with 3 slashes.
 				// there is a slash at the beginning of the path and
 				// so that plus these 4 makes 5
 				newUrl = new URL("file:////" + path); //$NON-NLS-1$
 			} catch (MalformedURLException e) {
 				// this shouldn't be possible
 				throw new Error(e);
 			}
 			return newUrl;
 		}
 	}
 
 	/***
 	 * @param location
 	 * @return
 	 * @throws IOException
 	 */
 	private static boolean isNativeSafe(URL location) throws IOException {
 		String protocol = location.getProtocol().intern();
 		// TODO ask JDIC to include an getSupportedProtocols() method in JDIC
 		// Browser API
 		return (protocol == "http" || protocol == "https" || protocol == "file"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
 	}
 
 	/***
 	 * @return the browser
 	 */
 	public IBrowser getBrowser() {
 		return browser;
 	}
 
 	/***
 	 * @return the browseWebUI
 	 */
 	public BrowseWebUI getBrowseWebUI() {
 		return browseWebUI;
 	}
 
 	public void setBrowseWebUI(BrowseWebUI browseWebUI) {
 		this.browseWebUI = browseWebUI;
 	}
 	/***
 	 * @return the content
 	 */
 	public String getContent() {
 		return content;
 	}
 
 	/***
 	 * @return the isAuthoring
 	 */
 	public boolean isAuthoringHTMLPage() {
 		return isAuthoringHTMLPage;
 	}
 
 	/***
 	 * Set whether this BrowseWeb bean is being used for authoring
 	 * so that we can determine whether to load the url or not since
 	 * we don't want to load the url if we are authoring a Display Page
 	 * or an Evidence page
 	 * @param isAuthoring the isAuthoring to set
 	 */
 	public void setIsAuthoringHTMLPage(boolean isAuthoringHTMLPage) {
 		this.isAuthoringHTMLPage = isAuthoringHTMLPage;
 	}
 
 	public Object clone() {
 		try {
 			setUrl(new URL("http://"));
 		} catch(Exception e) {
 			
 		}
 		return this;
 	}
 }