xmlhttprequest.h   [plain text]

// -*- c-basic-offset: 2 -*-
/*
 *  This file is part of the KDE libraries
 *  Copyright (C) 2003, 2006 Apple Computer, Inc.
 *  Copyright (C) 2005, 2006 Alexey Proskuryakov <ap@nypop.com>
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef XMLHTTPREQUEST_H_
#define XMLHTTPREQUEST_H_

#include "KURL.h"
#include "PlatformString.h"
#include "TransferJobClient.h"
#include <wtf/Vector.h>

namespace WebCore {

  class Decoder;
  class Document;
  class EventListener;
  class String;

  typedef int ExceptionCode;
  
  // these exact numeric values are important because JS expects them
  enum XMLHttpRequestState {
    Uninitialized = 0,  // open() has not been called yet
    Loading = 1,        // send() has not been called yet
    Loaded = 2,         // send() has been called, headers and status are available
    Interactive = 3,    // Downloading, responseText holds the partial data
    Completed = 4       // Finished with all operations
  };

  class XMLHttpRequest : public Shared<XMLHttpRequest>, TransferJobClient {
  public:
    XMLHttpRequest(Document*);
    ~XMLHttpRequest();

    static void detachRequests(Document*);
    static void cancelRequests(Document*);

    String getStatusText() const;
    int getStatus() const;
    XMLHttpRequestState getReadyState() const;
    void open(const String& method, const KURL& url, bool async, const String& user, const String& password, ExceptionCode& ec);
        void send(const String& body, ExceptionCode& ec);
    void abort();
    void setRequestHeader(const String& name, const String &value, ExceptionCode& ec);
    void overrideMIMEType(const String& override);
    String getAllResponseHeaders() const;
    String getResponseHeader(const String& name) const;
    String getResponseText() const;
    Document* getResponseXML() const;

    void setOnReadyStateChangeListener(EventListener*);
    EventListener* onReadyStateChangeListener() const;
    void setOnLoadListener(EventListener*);
    EventListener* onLoadListener() const;

  private:
    bool urlMatchesDocumentDomain(const KURL&) const;

    virtual void receivedRedirect(TransferJob*, const KURL&);
    virtual void receivedData(TransferJob*, const char *data, int size);
    virtual void receivedAllData(TransferJob*);

    void processSyncLoadResults(const Vector<char>& data, const KURL& finalURL, const DeprecatedString& headers);

    bool responseIsXML() const;
    
    DeprecatedString getRequestHeader(const DeprecatedString& name) const;
    static DeprecatedString getSpecificHeader(const DeprecatedString& headers, const DeprecatedString& name);

    void changeState(XMLHttpRequestState newState);
    void callReadyStateChangeListener();

    Document* m_doc;
    RefPtr<EventListener> m_onReadyStateChangeListener;
    RefPtr<EventListener> m_onLoadListener;

    KURL m_url;
    DeprecatedString m_method;
    bool m_async;
    DeprecatedString m_requestHeaders;

    TransferJob* m_job;

    XMLHttpRequestState m_state;

    RefPtr<Decoder> m_decoder;
    String m_encoding;
    String m_responseHeaders;
    String m_mimeTypeOverride;

    DeprecatedString m_response;
    mutable bool m_createdDocument;
    mutable RefPtr<Document> m_responseXML;

    bool m_aborted;
  };

} // namespace

#endif