Re: [Htmlunit-user] Executing JavaScript 3

[<Gou...@ne...>]

Following was in attachment for 'Re: [Htmlunit-user] Executing JavaScript 3' but was eaten by mailing list. This is a modified Window object that enables accessing frames by name.


 
/*
 * Copyright (c) 2002, 2003 Gargoyle Software Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. The end-user documentation included with the redistribution, if any, must
 *    include the following acknowledgment:
 *
 *       "This product includes software developed by Gargoyle Software Inc.
 *        (http://www.GargoyleSoftware.com/)."
 *
 *    Alternately, this acknowledgment may appear in the software itself, if
 *    and wherever such third-party acknowledgments normally appear.
 * 4. The name "Gargoyle Software" must not be used to endorse or promote
 *    products derived from this software without prior written permission.
 *    For written permission, please contact in...@Ga....
 * 5. Products derived from this software may not be called "HtmlUnit", nor may
 *    "HtmlUnit" appear in their name, without prior written permission of
 *    Gargoyle Software Inc.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARGOYLE
 * SOFTWARE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.gargoylesoftware.htmlunit.javascript.host;

import com.gargoylesoftware.htmlunit.AlertHandler;
import com.gargoylesoftware.htmlunit.ConfirmHandler;
import com.gargoylesoftware.htmlunit.Page;
import com.gargoylesoftware.htmlunit.PromptHandler;
import com.gargoylesoftware.htmlunit.SubmitMethod;
import com.gargoylesoftware.htmlunit.TopLevelWindow;
import com.gargoylesoftware.htmlunit.WebWindow;
import com.gargoylesoftware.htmlunit.html.HtmlElement;
import com.gargoylesoftware.htmlunit.html.HtmlFrame;
import com.gargoylesoftware.htmlunit.html.HtmlInlineFrame;
import com.gargoylesoftware.htmlunit.html.HtmlPage;
import com.gargoylesoftware.htmlunit.javascript.SimpleScriptable;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Collections;
import java.util.List;
import org.mozilla.javascript.Context;
import org.mozilla.javascript.Function;
import org.mozilla.javascript.Scriptable;

//> HACK!!!
import java.util.Hashtable;
//< HACK!!!

/**
 * A javascript window class
 *
 * @version  $Revision: 1.22 $
 * @author  <a href="mailto:mb...@Ga...">Mike Bowler</a>
 * @author  <a href="mailto:gou...@ne...">Alexei Goussev</a>
 */
public final class Window extends SimpleScriptable {

    private Document document_;
    private Navigator navigator_;
    private WebWindow webWindow_;
    private Screen screen_;
    private History history_;
    private Location location_;

    //> HACK!!!
    private Hashtable frames_ = new Hashtable();
    //< HACK!!!
    
    /**
     * Create an instance.  The rhino engine requires all host objects
     * to have a default constructor.
     */
    public Window() {
    }


    /**
     * Javascript constructor.  This must be declared in every javascript file because
     * the rhino engine won't walk up the hierarchy looking for constructors.
     */
    public final void jsConstructor() {
    }


    /**
     * The javascript function "alert()"
     * @param message The message
     */
    public void jsFunction_alert( final String message ) {
        final AlertHandler handler = getJavaScriptEngine().getWebClient().getAlertHandler();
        if( handler == null ) {
            getLog().warn("window.alert(\""+message+"\") no alert handler installed");
        }
        else {
            handler.handleAlert(document_.getHtmlPage(), message);
        }
    }


    /**
     * The javascript function "confirm()"
     * @param message The message
     * @return true if ok was pressed, false if cancel was pressed
     */
    public boolean jsFunction_confirm( final String message ) {
        final ConfirmHandler handler = getJavaScriptEngine().getWebClient().getConfirmHandler();
        if( handler == null ) {
            getLog().warn("window.confirm(\""+message+"\") no confirm handler installed");
            return false;
        }
        else {
            return handler.handleConfirm(document_.getHtmlPage(), message);
        }
    }


    /**
     * The javascript function "prompt()"
     * @param message The message
     * @return true if ok was pressed, false if cancel was pressed
     */
    public String jsFunction_prompt( final String message ) {
        final PromptHandler handler = getJavaScriptEngine().getWebClient().getPromptHandler();
        if( handler == null ) {
            getLog().warn("window.prompt(\""+message+"\") no prompt handler installed");
            return null;
        }
        else {
            return handler.handlePrompt(document_.getHtmlPage(), message);
        }
    }


    /**
     * Return the javascript property "document"
     * @return The document
     */
    public Document jsGet_document() {
        return document_;
    }


    /**
     * Open a new window
     *
     * @param context The javascript Context
     * @param scriptable The object that the function was called on.
     * @param args The arguments passed to the function.
     * @param function The function object that was invoked.
     * @return The newly opened window
     */
    public static Object jsFunction_open(
        final Context context, final Scriptable scriptable, final Object[] args,  final Function function ) {

        final String url = getStringArg(0, args, null);
        final String windowName = getStringArg(1, args, "");
        final String features = getStringArg(2, args, null);
        final boolean replaceCurrentEntryInBrowsingHistory = getBooleanArg(3, args, false);
        final Window thisWindow = (Window)scriptable;

        if( features != null
                || replaceCurrentEntryInBrowsingHistory == true ) {

            thisWindow.getLog().debug(
                "Window.open: features and replaceCurrentEntryInBrowsingHistory "
                + "not implemented: url=["+url
                + "] windowName=["+windowName
                + "] features=["+features
                + "] replaceCurrentEntry=["+replaceCurrentEntryInBrowsingHistory
                + "]");
        }

        final URL newUrl = thisWindow.makeUrlForOpenWindow(url);
        final WebWindow newWebWindow=  thisWindow.webWindow_.getWebClient().openWindow(
            newUrl, windowName, thisWindow.webWindow_ );
        return (Window)newWebWindow.getScriptObject();
    }


    private URL makeUrlForOpenWindow( final String urlString ) {
        if( urlString.length() == 0 ) {
            return null;
        }

        try {
            final Page page = webWindow_.getEnclosedPage();
            if( page != null && page instanceof HtmlPage ) {
                return ((HtmlPage)page).getFullyQualifiedUrl(urlString);
            }
            else {
                return new URL(urlString);
            }
        }
        catch( final MalformedURLException e ) {
            getLog().error("Unable to create url for openWindow: relativeUrl=["+urlString+"]", e);
            return null;
        }
    }


    /**
     * Set a chunk of javascript to be invoked at some specified time later.
     *
     * @param context The javascript Context
     * @param scriptable The object that the function was called on.
     * @param args The arguments passed to the function.
     * @param function The function object that was invoked.
     * @return The newly opened window
     */
    public static Object jsFunction_setTimeout(
        final Context context, final Scriptable scriptable, final Object[] args,  final Function function ) {
        final String script = getStringArg(0, args, null);
        final int timeout = getIntArg(1, args, 0);

        final Runnable runnable = new Runnable() {
            public void run() {
                final Window window = (Window)scriptable;
                try {
                    Thread.sleep(timeout);

                    // Register this thread with the rhino engine
                    Context.enter();
                    final HtmlPage htmlPage = window.document_.getHtmlPage();
                    htmlPage.executeJavaScriptIfPossible(
                        script, "Window.setTimeout()", true, htmlPage);
                }
                catch( final Exception e ) {
                    window.getLog().error("Caught exception in Window.setTimeout()", e);
                }
                finally {
                    // Deregister this thread with the rhino engine
                    Context.exit();
                }
            }
        };
        new Thread(runnable).start();
        return null;
    }


    /**
     * Return the javascript property "navigator"
     * @return The document
     */
    public Navigator jsGet_navigator() {
        return navigator_;
    }


    /**
     * Return the window property.  This is a synonym for "self"
     * @return A reference to this
     */
    public Window jsGet_window() {
        return this;
    }


    /**
     * Return the "self" property
     * @return this
     */
    public Window jsGet_self() {
        return this;
    }


    /**
     * Return the location property
     * @return The location property
     */
    public Location jsGet_location() {
        return location_;
    }


    /**
     * Set the location property.  This will cause a reload of the window.
     * @param newLocation The url of the new content.
     */
    public void jsSet_location( final String newLocation ) {
        try {
            final HtmlPage page = (HtmlPage)webWindow_.getEnclosedPage();
            final URL url = page.getFullyQualifiedUrl(newLocation);

            webWindow_.getWebClient().getPage(
                webWindow_, url, SubmitMethod.GET, Collections.EMPTY_LIST );
        }
        catch( final MalformedURLException e ) {
            getLog().error("jsSet_location(\""+newLocation+"\") Got MalformedURLException", e);
        }
        catch( final IOException e ) {
            getLog().error("jsSet_location(\""+newLocation+"\") Got IOException", e);
        }
    }


    /**
     * Return the "screen" property
     * @return the screen property
     */
    public Screen jsGet_screen() {
        return screen_;
    }


    /**
     * Return the "history" property
     * @return the "history" property
     */
    public History jsGet_history() {
        return history_;
    }


    /**
     * Initialize the object.
     * @param htmlPage The html page containing the javascript.
     * @exception Exception If an error occurs.
     */
    public void initialize( final HtmlPage htmlPage ) throws Exception {

        webWindow_ = htmlPage.getEnclosingWindow();
        webWindow_.setScriptObject(this);
        if( webWindow_ instanceof HtmlElement ) {
            setHtmlElement((HtmlElement)webWindow_);
        }

        document_ = (Document)makeJavaScriptObject("Document");
        document_.setHtmlElement(htmlPage);
        final PropertyChangeListener listener = new PropertyChangeListener() {
            public void propertyChange( final PropertyChangeEvent event ) {
                if( event.getPropertyName().equals(htmlPage.PROPERTY_ELEMENT) ) {
                    document_.initialize();
                    htmlPage.removePropertyChangeListener(this);
                }
            }
        };
        htmlPage.addPropertyChangeListener(listener);

        navigator_ = (Navigator)makeJavaScriptObject("Navigator");
        screen_ = (Screen)makeJavaScriptObject("Screen");
        history_ = (History)makeJavaScriptObject("History");

        location_ = (Location)makeJavaScriptObject("Location");
        location_.initialize(this);
        
        //> HACK!!!
        if (htmlPage != null) {
            try {
                //here might happen some exception if there is something wrong with the frames.
                //preferred way is not to get in trouble with that exception here - it is better when it happens during frame is accessed by name.
                List frames = htmlPage.getFrames();
                if (frames != null) {
                    int i = 0;
                    HtmlFrame frame = null;
                    String frameName = null;
                    for (i = 0; i < frames.size(); i++) {
                        try {
                            frame = (HtmlFrame)(frames.get(i));
                            frameName = frame.getName();
                            put(frameName, this, frame);//this should work, but does not cause
                                                        //windows that contain frames never have HtmlElement!
                                                        //This causes causes redirect to a superclass in
                                                        //SimpleScriptable even if the property is set.
                            frames_.put(frameName, frame);//this is a workaround for that seek behaviour
                        }
                        catch (Exception e) {
                            //do nothing
                        }
                    }
                }
            } catch (Exception e) {
                //do nothing
            }
        }
        //< HACK!!!
    }

    //> HACK!!!
    public HtmlFrame getFrame(String frameName) {
        HtmlFrame toreturn = null;
        try {
            toreturn = (HtmlFrame)(frames_.get(frameName));
        } catch (Exception e) {
            toreturn = null;
        }
        return toreturn;
    }
    //< HACK!!!
    
    //> HACK!!!
    /**
     * Return the specified property or NOT_FOUND if it could not be found.
     * @param name The name of the property
     * @param start The scriptable object that was originally queried for this property
     * @return The property.
     */
    public Object get( final String name, final Scriptable start ) {
        boolean debug = false;
        
        //> DEBUG
        if (debug) System.out.println(/*TEMPORARY*/"Window.get called: " + name + "; " + start);
        if (debug) System.out.println(/*TEMPORARY*/"Window.get called on object " + this);
        //< DEBUG
        
        //> DEBUG
        if (debug) {
            if (start instanceof Window) {
                Window w = (Window)start;
                Object[] oa = w.getPropertyIds(this);
                System.out.println(/*TEMPORARY*/"Window.get (Window): property Ids length: " + oa.length);
                int i = 0;
                for (i = 0; i < oa.length; i++) {
                    System.out.println(/*TEMPORARY*/"Window.get (Window): property Id: " + i + ": " + oa[i]);
                }
            }
        }
        //< DEBUG
        
        if (start instanceof com.gargoylesoftware.htmlunit.javascript.host.Window) {
            try {
                //> DEBUG
                if (debug) System.out.println(/*TEMPORARY*/"Window.get (HACK!!!) accessed");
                //< DEBUG
                final com.gargoylesoftware.htmlunit.javascript.host.Window w = (com.gargoylesoftware.htmlunit.javascript.host.Window)start;
                //final Object result = w.getFrame(name);
                final com.gargoylesoftware.htmlunit.html.HtmlFrame frame = w.getFrame(name);
                if (frame != null) {
                    final Object result = frame.getScriptObject();
                    if (result != null) {
                        //> DEBUG
                        if (debug) System.out.println(/*TEMPORARY*/"Window.get (HACK!!!): returns: " + result);
                        //< DEBUG
                        return result;
                    }
                } else {
                    //> DEBUG
                    if (debug) System.out.println(/*TEMPORARY*/"Window.get (HACK!!!) skipped");
                    //< DEBUG
                }
            } catch (Exception e) {
                //> DEBUG
                if (debug) System.out.println(/*TEMPORARY*/"Window.get (HACK!!!) exception");
                //< DEBUG
            }
        }
         
        return super.get(name, start);
    }
    //< HACK!!!
    
    /**
     * Return the value of the top property
     * @return The value of "top"
     */
    public SimpleScriptable jsGet_top() {
        WebWindow window = webWindow_;
        while( window != null ) {
            if( window instanceof TopLevelWindow ) {
                return (SimpleScriptable)window.getScriptObject();
            }

            window = ((HtmlElement)window).getPage().getEnclosingWindow();
        }
        throw new IllegalStateException("Couldn't find a TopLevelWindow!");
    }


    /**
     * Return the value of the parent property
     * @return the value of window.parent
     */
    public SimpleScriptable jsGet_parent() {
        final SimpleScriptable parent;
        if( webWindow_ instanceof TopLevelWindow ) {
            parent = this;
        }
        else {
            final WebWindow parentWebWindow
                = ((HtmlElement)webWindow_).getPage().getEnclosingWindow();
            parent = (SimpleScriptable)parentWebWindow.getScriptObject();
        }

        return parent;
    }


    /**
     * Return the value of the opener property.
     * @return the value of window.opener
     */
    public Object jsGet_opener() {
        if( webWindow_ instanceof TopLevelWindow ) {
            final WebWindow opener = ((TopLevelWindow)webWindow_).getOpener();
            if( opener != null ) {
                return (Window)opener.getScriptObject();
            }
        }

        return NOT_FOUND;
    }


    /**
     * Return the value of the frames property.  Currently not implemented
     * @return The value of window.frames
     */
    public SimpleScriptable[] jsGet_frames() {
        final Page page = webWindow_.getEnclosedPage();
        if( page == null || page instanceof HtmlPage == false ) {
            return new SimpleScriptable[0];
        }

        final HtmlPage htmlPage = (HtmlPage)page;
        final List frames = htmlPage.getFrames();
        final int frameCount = frames.size();
        final SimpleScriptable[] jsFrames = new SimpleScriptable[frameCount];

        for( int i=0; i<frameCount; i++ ) {
            jsFrames[i] = (SimpleScriptable)((WebWindow)frames.get(i)).getScriptObject();
        }

        return jsFrames;
    }


    /**
     * Return the WebWindow associated with this Window
     * @return The WebWindow
     */
    public WebWindow getWebWindow() {
        return webWindow_;
    }


    /**
     * Set the focus to this element.
     */
    public void jsFunction_focus() {
        getLog().debug( "Window.focus() not implemented" );
    }


    /**
     * Remove focus from this element
     */
    public void jsFunction_blur() {
        getLog().debug( "Window.blur() not implemented" );
    }


    /**
     * Close this window
     */
    public void jsFunction_close() {
        getLog().debug( "Window.close() not implemented" );
    }


    /**
     * Return the value of the src attribute
     * @return the value of the src attribute.
     */
    public String jsGet_src() {
        final WebWindow webWindow = getWebWindow();
        if( webWindow instanceof HtmlInlineFrame ) {
            return ((HtmlInlineFrame)webWindow).getSrcAttribute();
        }

        return "";
    }


    /**
     * Set the value of the src attribute.  In the case of an iframe, this will cause a reload of the page
     * @param newValue The new value
     */
    public void jsSet_src( final String newValue ) {
        final WebWindow webWindow = getWebWindow();
        if( webWindow instanceof HtmlInlineFrame ) {
            ((HtmlInlineFrame)webWindow).setSrcAttribute(newValue);
        }
    }


    /**
     * Set the value of the onload property.
     * @param newValue The new value
     */
    public void jsSet_onload( final Object newValue ) {
        if( webWindow_.getEnclosedPage() instanceof HtmlPage ) {
            final HtmlPage page = (HtmlPage)webWindow_.getEnclosedPage();
            if ( newValue instanceof Function ) {
                page.setOnLoadAttribute( newValue );
            } 
            else {
                getLog().error( "Invalid value set to window.onload.  Value class: " + newValue.getClass () );
            }
        }
    }


    /**
     * Return the value of the onload property.
     * @return the value of window.onload
     */
    public Object jsGet_onload() {
        if( webWindow_.getEnclosedPage() instanceof HtmlPage ) {
            final HtmlPage page = (HtmlPage)webWindow_.getEnclosedPage();
            return page.getOnLoadAttribute();
        }

        return "";
    }
    
    public String jsGet_name() {
        return webWindow_.getName();
    }
}

__________________________________________________________________
McAfee VirusScan Online from the Netscape Network.
Comprehensive protection for your entire computer. Get your free trial today!
http://channels.netscape.com/ns/computing/mcafee/index.jsp?promo=393397

Get AOL Instant Messenger 5.1 free of charge.  Download Now!
http://aim.aol.com/aimnew/Aim/register.adp?promo=380455