michael@0: /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
michael@0:  *
michael@0:  * This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "nsISupports.idl"
michael@0: 
michael@0: interface nsIWebProgress;
michael@0: interface nsIRequest;
michael@0: interface nsIURI;
michael@0: 
michael@0: /**
michael@0:  * The nsIWebProgressListener interface is implemented by clients wishing to
michael@0:  * listen in on the progress associated with the loading of asynchronous
michael@0:  * requests in the context of a nsIWebProgress instance as well as any child
michael@0:  * nsIWebProgress instances.  nsIWebProgress.idl describes the parent-child
michael@0:  * relationship of nsIWebProgress instances.
michael@0:  */
michael@0: [scriptable, uuid(a0cda7e4-c6ca-11e0-b6a5-001320257da5)]
michael@0: interface nsIWebProgressListener : nsISupports
michael@0: {
michael@0:   /**
michael@0:    * State Transition Flags
michael@0:    *
michael@0:    * These flags indicate the various states that requests may transition
michael@0:    * through as they are being loaded.  These flags are mutually exclusive.
michael@0:    *
michael@0:    * For any given request, onStateChange is called once with the STATE_START
michael@0:    * flag, zero or more times with the STATE_TRANSFERRING flag or once with the
michael@0:    * STATE_REDIRECTING flag, and then finally once with the STATE_STOP flag.
michael@0:    * NOTE: For document requests, a second STATE_STOP is generated (see the
michael@0:    * description of STATE_IS_WINDOW for more details).
michael@0:    *
michael@0:    * STATE_START
michael@0:    *   This flag indicates the start of a request.  This flag is set when a
michael@0:    *   request is initiated.  The request is complete when onStateChange is
michael@0:    *   called for the same request with the STATE_STOP flag set.
michael@0:    *
michael@0:    * STATE_REDIRECTING
michael@0:    *   This flag indicates that a request is being redirected.  The request
michael@0:    *   passed to onStateChange is the request that is being redirected.  When a
michael@0:    *   redirect occurs, a new request is generated automatically to process the
michael@0:    *   new request.  Expect a corresponding STATE_START event for the new
michael@0:    *   request, and a STATE_STOP for the redirected request.
michael@0:    *
michael@0:    * STATE_TRANSFERRING
michael@0:    *   This flag indicates that data for a request is being transferred to an
michael@0:    *   end consumer.  This flag indicates that the request has been targeted,
michael@0:    *   and that the user may start seeing content corresponding to the request.
michael@0:    *
michael@0:    * STATE_NEGOTIATING
michael@0:    *   This flag is not used.
michael@0:    *
michael@0:    * STATE_STOP
michael@0:    *   This flag indicates the completion of a request.  The aStatus parameter
michael@0:    *   to onStateChange indicates the final status of the request.
michael@0:    */
michael@0:   const unsigned long STATE_START          = 0x00000001;
michael@0:   const unsigned long STATE_REDIRECTING    = 0x00000002;
michael@0:   const unsigned long STATE_TRANSFERRING   = 0x00000004;
michael@0:   const unsigned long STATE_NEGOTIATING    = 0x00000008;
michael@0:   const unsigned long STATE_STOP           = 0x00000010;
michael@0: 
michael@0: 
michael@0:   /**
michael@0:    * State Type Flags
michael@0:    *
michael@0:    * These flags further describe the entity for which the state transition is
michael@0:    * occuring.  These flags are NOT mutually exclusive (i.e., an onStateChange
michael@0:    * event may indicate some combination of these flags).
michael@0:    *
michael@0:    * STATE_IS_REQUEST
michael@0:    *   This flag indicates that the state transition is for a request, which
michael@0:    *   includes but is not limited to document requests.  (See below for a
michael@0:    *   description of document requests.)  Other types of requests, such as
michael@0:    *   requests for inline content (e.g., images and stylesheets) are
michael@0:    *   considered normal requests.
michael@0:    *
michael@0:    * STATE_IS_DOCUMENT
michael@0:    *   This flag indicates that the state transition is for a document request.
michael@0:    *   This flag is set in addition to STATE_IS_REQUEST.  A document request
michael@0:    *   supports the nsIChannel interface and its loadFlags attribute includes
michael@0:    *   the nsIChannel::LOAD_DOCUMENT_URI flag.
michael@0:    * 
michael@0:    *   A document request does not complete until all requests associated with
michael@0:    *   the loading of its corresponding document have completed.  This includes
michael@0:    *   other document requests (e.g., corresponding to HTML <iframe> elements).
michael@0:    *   The document corresponding to a document request is available via the
michael@0:    *   DOMWindow attribute of onStateChange's aWebProgress parameter.
michael@0:    *
michael@0:    * STATE_IS_NETWORK
michael@0:    *   This flag indicates that the state transition corresponds to the start
michael@0:    *   or stop of activity in the indicated nsIWebProgress instance.  This flag
michael@0:    *   is accompanied by either STATE_START or STATE_STOP, and it may be
michael@0:    *   combined with other State Type Flags.
michael@0:    *
michael@0:    *   Unlike STATE_IS_WINDOW, this flag is only set when activity within the
michael@0:    *   nsIWebProgress instance being observed starts or stops.  If activity
michael@0:    *   only occurs in a child nsIWebProgress instance, then this flag will be
michael@0:    *   set to indicate the start and stop of that activity.
michael@0:    *
michael@0:    *   For example, in the case of navigation within a single frame of a HTML
michael@0:    *   frameset, a nsIWebProgressListener instance attached to the
michael@0:    *   nsIWebProgress of the frameset window will receive onStateChange calls
michael@0:    *   with the STATE_IS_NETWORK flag set to indicate the start and stop of
michael@0:    *   said navigation.  In other words, an observer of an outer window can
michael@0:    *   determine when activity, that may be constrained to a child window or
michael@0:    *   set of child windows, starts and stops.
michael@0:    *
michael@0:    * STATE_IS_WINDOW
michael@0:    *   This flag indicates that the state transition corresponds to the start
michael@0:    *   or stop of activity in the indicated nsIWebProgress instance.  This flag
michael@0:    *   is accompanied by either STATE_START or STATE_STOP, and it may be
michael@0:    *   combined with other State Type Flags.
michael@0:    *
michael@0:    *   This flag is similar to STATE_IS_DOCUMENT.  However, when a document
michael@0:    *   request completes, two onStateChange calls with STATE_STOP are
michael@0:    *   generated.  The document request is passed as aRequest to both calls.
michael@0:    *   The first has STATE_IS_REQUEST and STATE_IS_DOCUMENT set, and the second
michael@0:    *   has the STATE_IS_WINDOW flag set (and possibly the STATE_IS_NETWORK flag
michael@0:    *   set as well -- see above for a description of when the STATE_IS_NETWORK
michael@0:    *   flag may be set).  This second STATE_STOP event may be useful as a way
michael@0:    *   to partition the work that occurs when a document request completes.
michael@0:    */
michael@0:   const unsigned long STATE_IS_REQUEST     = 0x00010000;
michael@0:   const unsigned long STATE_IS_DOCUMENT    = 0x00020000;
michael@0:   const unsigned long STATE_IS_NETWORK     = 0x00040000;
michael@0:   const unsigned long STATE_IS_WINDOW      = 0x00080000;
michael@0: 
michael@0: 
michael@0:   /**
michael@0:    * State Modifier Flags
michael@0:    *
michael@0:    * These flags further describe the transition which is occuring.  These
michael@0:    * flags are NOT mutually exclusive (i.e., an onStateChange event may
michael@0:    * indicate some combination of these flags).
michael@0:    *
michael@0:    * STATE_RESTORING
michael@0:    *   This flag indicates that the state transition corresponds to the start
michael@0:    *   or stop of activity for restoring a previously-rendered presentation.
michael@0:    *   As such, there is no actual network activity associated with this
michael@0:    *   request, and any modifications made to the document or presentation
michael@0:    *   when it was originally loaded will still be present.
michael@0:    */
michael@0:   const unsigned long STATE_RESTORING      = 0x01000000;
michael@0: 
michael@0:   /**
michael@0:    * State Security Flags
michael@0:    *
michael@0:    * These flags describe the security state reported by a call to the
michael@0:    * onSecurityChange method.  These flags are mutually exclusive.
michael@0:    *
michael@0:    * STATE_IS_INSECURE
michael@0:    *   This flag indicates that the data corresponding to the request
michael@0:    *   was received over an insecure channel.
michael@0:    *
michael@0:    * STATE_IS_BROKEN
michael@0:    *   This flag indicates an unknown security state.  This may mean that the
michael@0:    *   request is being loaded as part of a page in which some content was
michael@0:    *   received over an insecure channel.
michael@0:    *
michael@0:    * STATE_IS_SECURE
michael@0:    *   This flag indicates that the data corresponding to the request was
michael@0:    *   received over a secure channel.  The degree of security is expressed by
michael@0:    *   STATE_SECURE_HIGH, STATE_SECURE_MED, or STATE_SECURE_LOW.
michael@0:    */
michael@0:   const unsigned long STATE_IS_INSECURE     = 0x00000004;
michael@0:   const unsigned long STATE_IS_BROKEN       = 0x00000001;
michael@0:   const unsigned long STATE_IS_SECURE       = 0x00000002;
michael@0: 
michael@0:   /**
michael@0:    * Mixed active content flags
michael@0:    *
michael@0:    * May be set in addition to the State Security Flags, to indicate that
michael@0:    * mixed active content has been encountered.
michael@0:    *
michael@0:    * STATE_BLOCKED_MIXED_ACTIVE_CONTENT
michael@0:    *   Mixed active content has been blocked from loading.
michael@0:    *
michael@0:    * STATE_LOADED_MIXED_ACTIVE_CONTENT
michael@0:    *   Mixed active content has been loaded. State should be STATE_IS_BROKEN.
michael@0:    */
michael@0:   const unsigned long STATE_BLOCKED_MIXED_ACTIVE_CONTENT  = 0x00000010;
michael@0:   const unsigned long STATE_LOADED_MIXED_ACTIVE_CONTENT   = 0x00000020;
michael@0: 
michael@0:   /**
michael@0:    * Mixed display content flags
michael@0:    *
michael@0:    * May be set in addition to the State Security Flags, to indicate that
michael@0:    * mixed display content has been encountered.
michael@0:    *
michael@0:    * STATE_BLOCKED_MIXED_DISPLAY_CONTENT
michael@0:    *   Mixed display content has been blocked from loading.
michael@0:    *
michael@0:    * STATE_LOADED_MIXED_DISPLAY_CONTENT
michael@0:    *   Mixed display content has been loaded. State should be STATE_IS_BROKEN.
michael@0:    */
michael@0:   const unsigned long STATE_BLOCKED_MIXED_DISPLAY_CONTENT = 0x00000100;
michael@0:   const unsigned long STATE_LOADED_MIXED_DISPLAY_CONTENT  = 0x00000200;
michael@0: 
michael@0:   /**
michael@0:    * Security Strength Flags
michael@0:    *
michael@0:    * These flags describe the security strength and accompany STATE_IS_SECURE
michael@0:    * in a call to the onSecurityChange method.  These flags are mutually
michael@0:    * exclusive.
michael@0:    *
michael@0:    * These flags are not meant to provide a precise description of data
michael@0:    * transfer security.  These are instead intended as a rough indicator that
michael@0:    * may be used to, for example, color code a security indicator or otherwise
michael@0:    * provide basic data transfer security feedback to the user.
michael@0:    *
michael@0:    * STATE_SECURE_HIGH
michael@0:    *   This flag indicates a high degree of security.
michael@0:    *
michael@0:    * STATE_SECURE_MED
michael@0:    *   This flag indicates a medium degree of security.
michael@0:    *
michael@0:    * STATE_SECURE_LOW
michael@0:    *   This flag indicates a low degree of security.
michael@0:    */
michael@0:   const unsigned long STATE_SECURE_HIGH     = 0x00040000;
michael@0:   const unsigned long STATE_SECURE_MED      = 0x00010000;
michael@0:   const unsigned long STATE_SECURE_LOW      = 0x00020000;
michael@0: 
michael@0:   /**
michael@0:     * State bits for EV == Extended Validation == High Assurance
michael@0:     *
michael@0:     * These flags describe the level of identity verification
michael@0:     * in a call to the onSecurityChange method. 
michael@0:     *
michael@0:     * STATE_IDENTITY_EV_TOPLEVEL
michael@0:     *   The topmost document uses an EV cert.
michael@0:     *   NOTE: Available since Gecko 1.9
michael@0:     */
michael@0: 
michael@0:   const unsigned long STATE_IDENTITY_EV_TOPLEVEL    = 0x00100000;
michael@0: 
michael@0:   /**
michael@0:    * Notification indicating the state has changed for one of the requests
michael@0:    * associated with aWebProgress.
michael@0:    *
michael@0:    * @param aWebProgress
michael@0:    *        The nsIWebProgress instance that fired the notification
michael@0:    * @param aRequest
michael@0:    *        The nsIRequest that has changed state.
michael@0:    * @param aStateFlags
michael@0:    *        Flags indicating the new state.  This value is a combination of one
michael@0:    *        of the State Transition Flags and one or more of the State Type
michael@0:    *        Flags defined above.  Any undefined bits are reserved for future
michael@0:    *        use.
michael@0:    * @param aStatus
michael@0:    *        Error status code associated with the state change.  This parameter
michael@0:    *        should be ignored unless aStateFlags includes the STATE_STOP bit.
michael@0:    *        The status code indicates success or failure of the request
michael@0:    *        associated with the state change.  NOTE: aStatus may be a success
michael@0:    *        code even for server generated errors, such as the HTTP 404 error.
michael@0:    *        In such cases, the request itself should be queried for extended
michael@0:    *        error information (e.g., for HTTP requests see nsIHttpChannel).
michael@0:    */
michael@0:   void onStateChange(in nsIWebProgress aWebProgress,
michael@0:                      in nsIRequest aRequest,
michael@0:                      in unsigned long aStateFlags,
michael@0:                      in nsresult aStatus);
michael@0: 
michael@0:   /**
michael@0:    * Notification that the progress has changed for one of the requests
michael@0:    * associated with aWebProgress.  Progress totals are reset to zero when all
michael@0:    * requests in aWebProgress complete (corresponding to onStateChange being
michael@0:    * called with aStateFlags including the STATE_STOP and STATE_IS_WINDOW
michael@0:    * flags).
michael@0:    *
michael@0:    * @param aWebProgress
michael@0:    *        The nsIWebProgress instance that fired the notification.
michael@0:    * @param aRequest
michael@0:    *        The nsIRequest that has new progress.
michael@0:    * @param aCurSelfProgress
michael@0:    *        The current progress for aRequest.
michael@0:    * @param aMaxSelfProgress
michael@0:    *        The maximum progress for aRequest.
michael@0:    * @param aCurTotalProgress
michael@0:    *        The current progress for all requests associated with aWebProgress.
michael@0:    * @param aMaxTotalProgress
michael@0:    *        The total progress for all requests associated with aWebProgress.
michael@0:    *
michael@0:    * NOTE: If any progress value is unknown, or if its value would exceed the
michael@0:    * maximum value of type long, then its value is replaced with -1.
michael@0:    *
michael@0:    * NOTE: If the object also implements nsIWebProgressListener2 and the caller
michael@0:    * knows about that interface, this function will not be called. Instead,
michael@0:    * nsIWebProgressListener2::onProgressChange64 will be called.
michael@0:    */
michael@0:   void onProgressChange(in nsIWebProgress aWebProgress,
michael@0:                         in nsIRequest aRequest,
michael@0:                         in long aCurSelfProgress,
michael@0:                         in long aMaxSelfProgress,
michael@0:                         in long aCurTotalProgress,
michael@0:                         in long aMaxTotalProgress);
michael@0: 
michael@0:   /**
michael@0:    * Flags for onLocationChange
michael@0:    *
michael@0:    * LOCATION_CHANGE_SAME_DOCUMENT
michael@0:    *   This flag is on when |aWebProgress| did not load a new document. 
michael@0:    *   For example, the location change is due to an anchor scroll or a
michael@0:    *   pushState/popState/replaceState.
michael@0:    *
michael@0:    * LOCATION_CHANGE_ERROR_PAGE
michael@0:    *   This flag is on when |aWebProgress| redirected from the requested
michael@0:    *   contents to an internal page to show error status, such as
michael@0:    *   <about:neterror>, <about:certerror> and so on.
michael@0:    *
michael@0:    *   Generally speaking, |aURI| and |aRequest| are the original data. DOM
michael@0:    *   |window.location.href| is also the original location, while
michael@0:    *   |document.documentURI| is the redirected location. Sometimes |aURI| is
michael@0:    *   <about:blank> and |aRequest| is null when the original data does not
michael@0:    +   remain.
michael@0:    *
michael@0:    *   |aWebProgress| does NOT set this flag when it did not try to load a new
michael@0:    *   document. In this case, it should set LOCATION_CHANGE_SAME_DOCUMENT.
michael@0:    */
michael@0:   const unsigned long LOCATION_CHANGE_SAME_DOCUMENT   = 0x00000001;
michael@0:   const unsigned long LOCATION_CHANGE_ERROR_PAGE      = 0x00000002;
michael@0: 
michael@0:   /**
michael@0:    * Called when the location of the window being watched changes.  This is not
michael@0:    * when a load is requested, but rather once it is verified that the load is
michael@0:    * going to occur in the given window.  For instance, a load that starts in a
michael@0:    * window might send progress and status messages for the new site, but it
michael@0:    * will not send the onLocationChange until we are sure that we are loading
michael@0:    * this new page here.
michael@0:    *
michael@0:    * @param aWebProgress
michael@0:    *        The nsIWebProgress instance that fired the notification.
michael@0:    * @param aRequest
michael@0:    *        The associated nsIRequest.  This may be null in some cases.
michael@0:    * @param aLocation
michael@0:    *        The URI of the location that is being loaded.
michael@0:    * @param aFlags
michael@0:    *        This is a value which explains the situation or the reason why
michael@0:    *        the location has changed.
michael@0:    */
michael@0:   void onLocationChange(in nsIWebProgress aWebProgress,
michael@0:                         in nsIRequest aRequest,
michael@0:                         in nsIURI aLocation,
michael@0:                         [optional] in unsigned long aFlags);
michael@0: 
michael@0:   /**
michael@0:    * Notification that the status of a request has changed.  The status message
michael@0:    * is intended to be displayed to the user (e.g., in the status bar of the
michael@0:    * browser).
michael@0:    *
michael@0:    * @param aWebProgress
michael@0:    *        The nsIWebProgress instance that fired the notification.
michael@0:    * @param aRequest
michael@0:    *        The nsIRequest that has new status.
michael@0:    * @param aStatus
michael@0:    *        This value is not an error code.  Instead, it is a numeric value
michael@0:    *        that indicates the current status of the request.  This interface
michael@0:    *        does not define the set of possible status codes.  NOTE: Some
michael@0:    *        status values are defined by nsITransport and nsISocketTransport.
michael@0:    * @param aMessage
michael@0:    *        Localized text corresponding to aStatus.
michael@0:    */
michael@0:   void onStatusChange(in nsIWebProgress aWebProgress,
michael@0:                       in nsIRequest aRequest,
michael@0:                       in nsresult aStatus,
michael@0:                       in wstring aMessage);
michael@0: 
michael@0:   /**
michael@0:    * Notification called for security progress.  This method will be called on
michael@0:    * security transitions (eg HTTP -> HTTPS, HTTPS -> HTTP, FOO -> HTTPS) and
michael@0:    * after document load completion.  It might also be called if an error
michael@0:    * occurs during network loading.
michael@0:    *
michael@0:    * @param aWebProgress
michael@0:    *        The nsIWebProgress instance that fired the notification.
michael@0:    * @param aRequest
michael@0:    *        The nsIRequest that has new security state.
michael@0:    * @param aState
michael@0:    *        A value composed of the Security State Flags and the Security
michael@0:    *        Strength Flags listed above.  Any undefined bits are reserved for
michael@0:    *        future use.
michael@0:    *
michael@0:    * NOTE: These notifications will only occur if a security package is
michael@0:    * installed.
michael@0:    */
michael@0:   void onSecurityChange(in nsIWebProgress aWebProgress,
michael@0:                         in nsIRequest aRequest,
michael@0:                         in unsigned long aState);
michael@0: };