khtml Library API Documentation

xmlhttprequest.cpp

00001 // -*- c-basic-offset: 2 -*-
00002 /*
00003  *  This file is part of the KDE libraries
00004  *  Copyright (C) 2003 Apple Computer, Inc.
00005  *
00006  *  This library is free software; you can redistribute it and/or
00007  *  modify it under the terms of the GNU Lesser General Public
00008  *  License as published by the Free Software Foundation; either
00009  *  version 2 of the License, or (at your option) any later version.
00010  *
00011  *  This library is distributed in the hope that it will be useful,
00012  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00014  *  Lesser General Public License for more details.
00015  *
00016  *  You should have received a copy of the GNU Lesser General Public
00017  *  License along with this library; if not, write to the Free Software
00018  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00019  */
00020 
00021 #include "xmlhttprequest.h"
00022 #include "xmlhttprequest.lut.h"
00023 #include "kjs_window.h"
00024 #include "kjs_events.h"
00025 
00026 #include "dom/dom_doc.h"
00027 #include "dom/dom_exception.h"
00028 #include "dom/dom_string.h"
00029 #include "misc/loader.h"
00030 #include "html/html_documentimpl.h"
00031 #include "xml/dom2_eventsimpl.h"
00032 
00033 #include "khtml_part.h"
00034 #include "khtmlview.h"
00035 
00036 #include <kio/scheduler.h>
00037 #include <kio/job.h>
00038 #include <qobject.h>
00039 #include <kdebug.h>
00040 
00041 #ifdef APPLE_CHANGES
00042 #include "KWQLoader.h"
00043 #else
00044 #include <kio/netaccess.h>
00045 using KIO::NetAccess;
00046 #endif
00047 
00048 using namespace KJS;
00049 using khtml::Decoder;
00050 
00052 
00053 /* Source for XMLHttpRequestProtoTable.
00054 @begin XMLHttpRequestProtoTable 7
00055   abort         XMLHttpRequest::Abort           DontDelete|Function 0
00056   getAllResponseHeaders XMLHttpRequest::GetAllResponseHeaders   DontDelete|Function 0
00057   getResponseHeader XMLHttpRequest::GetResponseHeader   DontDelete|Function 1
00058   open          XMLHttpRequest::Open            DontDelete|Function 5
00059   send          XMLHttpRequest::Send            DontDelete|Function 1
00060   setRequestHeader  XMLHttpRequest::SetRequestHeader    DontDelete|Function 2
00061 @end
00062 */
00063 DEFINE_PROTOTYPE("XMLHttpRequest",XMLHttpRequestProto)
00064 IMPLEMENT_PROTOFUNC_DOM(XMLHttpRequestProtoFunc)
00065 IMPLEMENT_PROTOTYPE(XMLHttpRequestProto,XMLHttpRequestProtoFunc)
00066 
00067 namespace KJS {
00068 
00069 XMLHttpRequestQObject::XMLHttpRequestQObject(XMLHttpRequest *_jsObject)
00070 {
00071   jsObject = _jsObject;
00072 }
00073 
00074 #ifdef APPLE_CHANGES
00075 void XMLHttpRequestQObject::slotData( KIO::Job* job, const char *data, int size )
00076 {
00077   jsObject->slotData(job, data, size);
00078 }
00079 #else
00080 void XMLHttpRequestQObject::slotData( KIO::Job* job, const QByteArray &data )
00081 {
00082   jsObject->slotData(job, data);
00083 }
00084 #endif
00085 
00086 void XMLHttpRequestQObject::slotFinished( KIO::Job* job )
00087 {
00088   jsObject->slotFinished(job);
00089 }
00090 
00091 void XMLHttpRequestQObject::slotRedirection( KIO::Job* job, const KURL& url)
00092 {
00093   jsObject->slotRedirection( job, url );
00094 }
00095 
00096 XMLHttpRequestConstructorImp::XMLHttpRequestConstructorImp(ExecState *, const DOM::Document &d)
00097     : ObjectImp(), doc(d)
00098 {
00099 }
00100 
00101 bool XMLHttpRequestConstructorImp::implementsConstruct() const
00102 {
00103   return true;
00104 }
00105 
00106 Object XMLHttpRequestConstructorImp::construct(ExecState *exec, const List &)
00107 {
00108   return Object(new XMLHttpRequest(exec, doc));
00109 }
00110 
00111 const ClassInfo XMLHttpRequest::info = { "XMLHttpRequest", 0, &XMLHttpRequestTable, 0 };
00112 
00113 /* Source for XMLHttpRequestTable.
00114 @begin XMLHttpRequestTable 7
00115   readyState        XMLHttpRequest::ReadyState      DontDelete|ReadOnly
00116   responseText      XMLHttpRequest::ResponseText        DontDelete|ReadOnly
00117   responseXML       XMLHttpRequest::ResponseXML     DontDelete|ReadOnly
00118   status        XMLHttpRequest::Status          DontDelete|ReadOnly
00119   statusText        XMLHttpRequest::StatusText      DontDelete|ReadOnly
00120   onreadystatechange    XMLHttpRequest::Onreadystatechange  DontDelete
00121   onload        XMLHttpRequest::Onload          DontDelete
00122 @end
00123 */
00124 
00125 Value XMLHttpRequest::tryGet(ExecState *exec, const Identifier &propertyName) const
00126 {
00127   return DOMObjectLookupGetValue<XMLHttpRequest,DOMObject>(exec, propertyName, &XMLHttpRequestTable, this);
00128 }
00129 
00130 Value XMLHttpRequest::getValueProperty(ExecState *exec, int token) const
00131 {
00132   switch (token) {
00133   case ReadyState:
00134     return Number(state);
00135   case ResponseText:
00136     return getString(DOM::DOMString(response));
00137   case ResponseXML:
00138     if (state != Completed) {
00139       return Undefined();
00140     }
00141     if (!createdDocument) {
00142       QString mimeType = "text/xml";
00143 
00144       Value header = getResponseHeader("Content-Type");
00145       if (header.type() != UndefinedType) {
00146     mimeType = QStringList::split(";", header.toString(exec).qstring())[0].stripWhiteSpace();
00147       }
00148 
00149       if (mimeType == "text/xml" || mimeType == "application/xml" || mimeType == "application/xhtml+xml") {
00150     responseXML = DOM::Document(doc->implementation()->createDocument());
00151 
00152     DOM::DocumentImpl *docImpl = static_cast<DOM::DocumentImpl *>(responseXML.handle());
00153 
00154     docImpl->open();
00155     docImpl->write(response);
00156     docImpl->finishParsing();
00157     docImpl->close();
00158 
00159     typeIsXML = true;
00160       } else {
00161     typeIsXML = false;
00162       }
00163       createdDocument = true;
00164     }
00165 
00166     if (!typeIsXML) {
00167       return Undefined();
00168     }
00169 
00170     return getDOMNode(exec,responseXML);
00171   case Status:
00172     return getStatus();
00173   case StatusText:
00174     return getStatusText();
00175   case Onreadystatechange:
00176    if (onReadyStateChangeListener && onReadyStateChangeListener->listenerObjImp()) {
00177      return onReadyStateChangeListener->listenerObj();
00178    } else {
00179      return Null();
00180    }
00181   case Onload:
00182    if (onLoadListener && onLoadListener->listenerObjImp()) {
00183      return onLoadListener->listenerObj();
00184    } else {
00185     return Null();
00186    }
00187   default:
00188     kdWarning() << "XMLHttpRequest::getValueProperty unhandled token " << token << endl;
00189     return Value();
00190   }
00191 }
00192 
00193 void XMLHttpRequest::tryPut(ExecState *exec, const Identifier &propertyName, const Value& value, int attr)
00194 {
00195   DOMObjectLookupPut<XMLHttpRequest,DOMObject>(exec, propertyName, value, attr, &XMLHttpRequestTable, this );
00196 }
00197 
00198 void XMLHttpRequest::putValueProperty(ExecState *exec, int token, const Value& value, int /*attr*/)
00199 {
00200   switch(token) {
00201   case Onreadystatechange:
00202     onReadyStateChangeListener = Window::retrieveActive(exec)->getJSEventListener(value, true);
00203     if (onReadyStateChangeListener) onReadyStateChangeListener->ref();
00204     break;
00205   case Onload:
00206     onLoadListener = Window::retrieveActive(exec)->getJSEventListener(value, true);
00207     if (onLoadListener) onLoadListener->ref();
00208     break;
00209   default:
00210     kdWarning() << "XMLHttpRequest::putValue unhandled token " << token << endl;
00211   }
00212 }
00213 
00214 XMLHttpRequest::XMLHttpRequest(ExecState *exec, const DOM::Document &d)
00215   : DOMObject(XMLHttpRequestProto::self(exec)),
00216     qObject(new XMLHttpRequestQObject(this)),
00217     doc(static_cast<DOM::DocumentImpl*>(d.handle())),
00218     async(true),
00219     job(0),
00220     state(Uninitialized),
00221     onReadyStateChangeListener(0),
00222     onLoadListener(0),
00223     decoder(0),
00224     createdDocument(false),
00225     aborted(false)
00226 {
00227 }
00228 
00229 XMLHttpRequest::~XMLHttpRequest()
00230 {
00231   delete qObject;
00232   qObject = 0;
00233   delete decoder;
00234   decoder = 0;
00235 }
00236 
00237 void XMLHttpRequest::changeState(XMLHttpRequestState newState)
00238 {
00239   if (state != newState) {
00240     state = newState;
00241 
00242     if (onReadyStateChangeListener != 0 && doc->view() && doc->view()->part()) {
00243       DOM::Event ev = doc->view()->part()->document().createEvent("HTMLEvents");
00244       ev.initEvent("readystatechange", true, true);
00245       onReadyStateChangeListener->handleEvent(ev);
00246     }
00247 
00248     if (state == Completed && onLoadListener != 0 && doc->view() && doc->view()->part()) {
00249       DOM::Event ev = doc->view()->part()->document().createEvent("HTMLEvents");
00250       ev.initEvent("load", true, true);
00251       onLoadListener->handleEvent(ev);
00252     }
00253   }
00254 }
00255 
00256 bool XMLHttpRequest::urlMatchesDocumentDomain(const KURL& _url) const
00257 {
00258   KURL documentURL(doc->URL());
00259 
00260   // a local file can load anything
00261   if (documentURL.protocol().lower() == "file") {
00262     return true;
00263   }
00264 
00265   // but a remote document can only load from the same port on the server
00266   if (documentURL.protocol().lower() == _url.protocol().lower() &&
00267       documentURL.host().lower() == _url.host().lower() &&
00268       documentURL.port() == _url.port()) {
00269     return true;
00270   }
00271 
00272   return false;
00273 }
00274 
00275 void XMLHttpRequest::open(const QString& _method, const KURL& _url, bool _async)
00276 {
00277   abort();
00278   aborted = false;
00279 
00280   // clear stuff from possible previous load
00281   requestHeaders = QString();
00282   responseHeaders = QString();
00283   response = QString();
00284   createdDocument = false;
00285   responseXML = DOM::Document();
00286 
00287   changeState(Uninitialized);
00288 
00289   if (aborted) {
00290     return;
00291   }
00292 
00293   if (!urlMatchesDocumentDomain(_url)) {
00294     return;
00295   }
00296 
00297 
00298   method = _method;
00299   url = _url;
00300   async = _async;
00301 
00302   changeState(Loading);
00303 }
00304 
00305 void XMLHttpRequest::send(const QString& _body)
00306 {
00307   aborted = false;
00308   if (method.lower() == "post" && (url.protocol().lower() == "http" || url.protocol().lower() == "https") ) {
00309       // FIXME: determine post encoding correctly by looking in headers for charset
00310       job = KIO::http_post( url, QCString(_body.utf8()), false );
00311   }
00312   else
00313   {
00314      job = KIO::get( url, false, false );
00315   }
00316   if (requestHeaders.length() > 0) {
00317     job->addMetaData("customHTTPHeader", requestHeaders);
00318   }
00319   job->addMetaData( "PropagateHttpHeader", "true" );
00320 
00321   if (!async) {
00322     QByteArray data;
00323     KURL finalURL;
00324     QString headers;
00325 
00326 #ifdef APPLE_CHANGES
00327     data = KWQServeSynchronousRequest(khtml::Cache::loader(), doc->docLoader(), job, finalURL, headers);
00328 #else
00329     QMap<QString, QString> metaData;
00330     if ( NetAccess::synchronousRun( job, 0, &data, &finalURL, &metaData ) ) {
00331       headers = metaData[ "HTTP-Headers" ];
00332     }
00333 #endif
00334     job = 0;
00335     processSyncLoadResults(data, finalURL, headers);
00336     return;
00337   }
00338 
00339   qObject->connect( job, SIGNAL( result( KIO::Job* ) ),
00340             SLOT( slotFinished( KIO::Job* ) ) );
00341 #ifdef APPLE_CHANGES
00342   qObject->connect( job, SIGNAL( data( KIO::Job*, const char*, int ) ),
00343             SLOT( slotData( KIO::Job*, const char*, int ) ) );
00344 #else
00345   qObject->connect( job, SIGNAL( data( KIO::Job*, const QByteArray& ) ),
00346             SLOT( slotData( KIO::Job*, const QByteArray& ) ) );
00347 #endif
00348   qObject->connect( job, SIGNAL(redirection(KIO::Job*, const KURL& ) ),
00349             SLOT( slotRedirection(KIO::Job*, const KURL&) ) );
00350 
00351 #ifdef APPLE_CHANGES
00352   KWQServeRequest(khtml::Cache::loader(), doc->docLoader(), job);
00353 #else
00354   KIO::Scheduler::scheduleJob( job );
00355 #endif
00356 }
00357 
00358 void XMLHttpRequest::abort()
00359 {
00360   if (job) {
00361     job->kill();
00362     job = 0;
00363   }
00364   delete decoder;
00365   decoder = 0;
00366   aborted = true;
00367 }
00368 
00369 void XMLHttpRequest::setRequestHeader(const QString& name, const QString &value)
00370 {
00371   if (requestHeaders.length() > 0) {
00372     requestHeaders += "\r\n";
00373   }
00374   requestHeaders += name;
00375   requestHeaders += ": ";
00376   requestHeaders += value;
00377 }
00378 
00379 Value XMLHttpRequest::getAllResponseHeaders() const
00380 {
00381   if (responseHeaders.isEmpty()) {
00382     return Undefined();
00383   }
00384 
00385   int endOfLine = responseHeaders.find("\n");
00386 
00387   if (endOfLine == -1) {
00388     return Undefined();
00389   }
00390 
00391   return String(responseHeaders.mid(endOfLine + 1) + "\n");
00392 }
00393 
00394 Value XMLHttpRequest::getResponseHeader(const QString& name) const
00395 {
00396   if (responseHeaders.isEmpty()) {
00397     return Undefined();
00398   }
00399 
00400   QRegExp headerLinePattern(name + ":", false);
00401 
00402   int matchLength;
00403   int headerLinePos = headerLinePattern.search(responseHeaders, 0);
00404   matchLength = headerLinePattern.matchedLength();
00405   while (headerLinePos != -1) {
00406     if (headerLinePos == 0 || responseHeaders[headerLinePos-1] == '\n') {
00407       break;
00408     }
00409 
00410     headerLinePos = headerLinePattern.search(responseHeaders, headerLinePos + 1);
00411     matchLength = headerLinePattern.matchedLength();
00412   }
00413 
00414 
00415   if (headerLinePos == -1) {
00416     return Undefined();
00417   }
00418 
00419   int endOfLine = responseHeaders.find("\n", headerLinePos + matchLength);
00420 
00421   return String(responseHeaders.mid(headerLinePos + matchLength, endOfLine - (headerLinePos + matchLength)).stripWhiteSpace());
00422 }
00423 
00424 Value XMLHttpRequest::getStatus() const
00425 {
00426   if (responseHeaders.isEmpty()) {
00427     return Undefined();
00428   }
00429 
00430   int endOfLine = responseHeaders.find("\n");
00431   QString firstLine = endOfLine == -1 ? responseHeaders : responseHeaders.left(endOfLine);
00432   int codeStart = firstLine.find(" ");
00433   int codeEnd = firstLine.find(" ", codeStart + 1);
00434 
00435   if (codeStart == -1 || codeEnd == -1) {
00436     return Undefined();
00437   }
00438 
00439   QString number = firstLine.mid(codeStart + 1, codeEnd - (codeStart + 1));
00440 
00441   bool ok = false;
00442   int code = number.toInt(&ok);
00443   if (!ok) {
00444     return Undefined();
00445   }
00446 
00447   return Number(code);
00448 }
00449 
00450 Value XMLHttpRequest::getStatusText() const
00451 {
00452   if (responseHeaders.isEmpty()) {
00453     return Undefined();
00454   }
00455 
00456   int endOfLine = responseHeaders.find("\n");
00457   QString firstLine = endOfLine == -1 ? responseHeaders : responseHeaders.left(endOfLine);
00458   int codeStart = firstLine.find(" ");
00459   int codeEnd = firstLine.find(" ", codeStart + 1);
00460 
00461   if (codeStart == -1 || codeEnd == -1) {
00462     return Undefined();
00463   }
00464 
00465   QString statusText = firstLine.mid(codeEnd + 1, endOfLine - (codeEnd + 1)).stripWhiteSpace();
00466 
00467   return String(statusText);
00468 }
00469 
00470 void XMLHttpRequest::processSyncLoadResults(const QByteArray &data, const KURL &finalURL, const QString &headers)
00471 {
00472   if (!urlMatchesDocumentDomain(finalURL)) {
00473     abort();
00474     return;
00475   }
00476 
00477   responseHeaders = headers;
00478   changeState(Loaded);
00479   if (aborted) {
00480     return;
00481   }
00482 
00483 #ifdef APPLE_CHANGES
00484   const char *bytes = (const char *)data.data();
00485   int len = (int)data.size();
00486 
00487   slotData(0, bytes, len);
00488 #else
00489   slotData(0, data);
00490 #endif
00491 
00492   if (aborted) {
00493     return;
00494   }
00495 
00496   slotFinished(0);
00497 }
00498 
00499 void XMLHttpRequest::slotFinished(KIO::Job *)
00500 {
00501   if (decoder) {
00502     response += decoder->flush();
00503   }
00504 
00505   // make sure to forget about the job before emitting completed,
00506   // since changeState triggers JS code, which might e.g. call abort.
00507   job = 0;
00508   changeState(Completed);
00509 
00510   delete decoder;
00511   decoder = 0;
00512 }
00513 
00514 void XMLHttpRequest::slotRedirection(KIO::Job*, const KURL& url)
00515 {
00516   if (!urlMatchesDocumentDomain(url)) {
00517     abort();
00518   }
00519 }
00520 
00521 #ifdef APPLE_CHANGES
00522 void XMLHttpRequest::slotData( KIO::Job*, const char *data, int len )
00523 #else
00524 void XMLHttpRequest::slotData(KIO::Job*, const QByteArray &_data)
00525 #endif
00526 {
00527   if (state < Loaded ) {
00528     responseHeaders = job->queryMetaData("HTTP-Headers");
00529     changeState(Loaded);
00530   }
00531 
00532 #ifndef APPLE_CHANGES
00533   const char *data = (const char *)_data.data();
00534   int len = (int)_data.size();
00535 #endif
00536 
00537   if ( decoder == NULL ) {
00538     decoder = new Decoder;
00539     if (!encoding.isNull())
00540       decoder->setEncoding(encoding.latin1());
00541     else {
00542       // FIXME: Inherit the default encoding from the parent document?
00543     }
00544   }
00545   if (len == 0)
00546     return;
00547 
00548   if (len == -1)
00549     len = strlen(data);
00550 
00551   QString decoded = decoder->decode(data, len);
00552 
00553   response += decoded;
00554 
00555   if (!aborted) {
00556     changeState(Interactive);
00557   }
00558 }
00559 
00560 Value XMLHttpRequestProtoFunc::tryCall(ExecState *exec, Object &thisObj, const List &args)
00561 {
00562   if (!thisObj.inherits(&XMLHttpRequest::info)) {
00563     Object err = Error::create(exec,TypeError);
00564     exec->setException(err);
00565     return err;
00566   }
00567 
00568   XMLHttpRequest *request = static_cast<XMLHttpRequest *>(thisObj.imp());
00569   switch (id) {
00570   case XMLHttpRequest::Abort:
00571     request->abort();
00572     return Undefined();
00573   case XMLHttpRequest::GetAllResponseHeaders:
00574     if (args.size() != 0) {
00575     return Undefined();
00576     }
00577 
00578     return request->getAllResponseHeaders();
00579   case XMLHttpRequest::GetResponseHeader:
00580     if (args.size() != 1) {
00581     return Undefined();
00582     }
00583 
00584     return request->getResponseHeader(args[0].toString(exec).qstring());
00585   case XMLHttpRequest::Open:
00586     {
00587       if (args.size() < 2 || args.size() > 5) {
00588         return Undefined();
00589       }
00590 
00591       QString method = args[0].toString(exec).qstring();
00592       KHTMLPart *part = ::qt_cast<KHTMLPart *>(Window::retrieveActive(exec)->part());
00593       if (!part)
00594         return Undefined();
00595       KURL url = KURL(part->document().completeURL(args[1].toString(exec).qstring()).string());
00596 
00597       bool async = true;
00598       if (args.size() >= 3) {
00599     async = args[2].toBoolean(exec);
00600       }
00601 
00602       if (args.size() >= 4) {
00603     url.setUser(args[3].toString(exec).qstring());
00604       }
00605 
00606       if (args.size() >= 5) {
00607     url.setPass(args[4].toString(exec).qstring());
00608       }
00609 
00610       request->open(method, url, async);
00611 
00612       return Undefined();
00613     }
00614   case XMLHttpRequest::Send:
00615     {
00616       if (args.size() > 1) {
00617         return Undefined();
00618       }
00619 
00620       if (request->state != Loading) {
00621     return Undefined();
00622       }
00623 
00624       QString body;
00625 
00626       if (args.size() >= 1) {
00627     Object obj = Object::dynamicCast(args[0]);
00628     if (!obj.isNull() && obj.inherits(&DOMDocument::info)) {
00629       DOM::Node docNode = static_cast<KJS::DOMDocument *>(obj.imp())->toNode();
00630       DOM::DocumentImpl *doc = static_cast<DOM::DocumentImpl *>(docNode.handle());
00631 
00632       try {
00633         body = doc->toString().string();
00634         // FIXME: also need to set content type, including encoding!
00635 
00636       } catch(DOM::DOMException& e) {
00637          Object err = Error::create(exec, GeneralError, "Exception serializing document");
00638          exec->setException(err);
00639       }
00640     } else {
00641       body = args[0].toString(exec).qstring();
00642     }
00643       }
00644 
00645       request->send(body);
00646 
00647       return Undefined();
00648     }
00649   case XMLHttpRequest::SetRequestHeader:
00650     if (args.size() != 2) {
00651       return Undefined();
00652     }
00653 
00654     request->setRequestHeader(args[0].toString(exec).qstring(), args[1].toString(exec).qstring());
00655 
00656     return Undefined();
00657   }
00658 
00659   return Undefined();
00660 }
00661 
00662 } // end namespace
00663 
00664 #include "xmlhttprequest.moc"
KDE Logo
This file is part of the documentation for khtml Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Fri Jul 22 10:18:37 2005 by doxygen 1.3.6 written by Dimitri van Heesch, © 1997-2003