HTTP Requests

An HTTP request is in Qt typically done using QNetworkRequest and QNetworkReply from the c++ site and then the response would be pushed using the Qt/C++ integration into the QML space. So we try to push the envelope here a little bit to use the current tools Qt Quick gives us to communicate with a network endpoint. For this, we use a helper object to make an HTTP request, response cycle. It comes in the form of the javascript XMLHttpRequest object.

The XMLHttpRequest object allows the user to register a response handler function and a URL. A request can be sent using one of the HTTP verbs (get, post, put, delete, …) to make the request. When the response arrives the handler function is called. The handler function is called several times. Every-time the request state has changed (for example headers have arrived or request is done).

Here a short example:

  1. function request() {
  2.     var xhr = new XMLHttpRequest();
  3.     xhr.onreadystatechange = function() {
  4.         if (xhr.readyState === XMLHttpRequest.HEADERS_RECEIVED) {
  5.             print('HEADERS_RECEIVED');
  6.         } else if(xhr.readyState === XMLHttpRequest.DONE) {
  7.             print('DONE');
  8.         }
  9.     }
  10.     xhr.open("GET", "http://example.com");
  11.     xhr.send();
  12. }

For a response, you can get the XML format or just the raw text. It is possible to iterate over the resulting XML but more commonly used is the raw text nowadays for a JSON formatted response. The JSON document will be used to convert text to a JS object using JSON.parse(text).

  1. ...
  2. } else if(xhr.readyState === XMLHttpRequest.DONE) {
  3.     var object = JSON.parse(xhr.responseText.toString());
  4.     print(JSON.stringify(object, null, 2));
  5. }

In the response handler, we access the raw response text and convert it into a javascript object. This JSON object is now a valid JS object (in javascript an object can be an object or an array).

TIP

It seems the toString() conversion first makes the code more stable. Without the explicit conversion, I had several times parser errors. Not sure what the cause it.

Flickr Calls

Let us have a look on a more real-world example. A typical example is to use the Flickr service to retrieve a public feed of the newly uploaded pictures. For this, we can use the http://api.flickr.com/services/feeds/photos_public.gne URL. Unfortunately, it returns by default an XML stream, which could be easily parsed by the XmlListModel in qml. For the sake of the example, we would like to concentrate on JSON data. To become a clean JSON response we need to attach some parameters to the request: http://api.flickr.com/services/feeds/photos_public.gne?format=json&nojsoncallback=1. This will return a JSON response without the JSON callback.

TIP

A JSON callback wraps the JSON response into a function call. This is a shortcut used on HTML programming where a script tag is used to make a JSON request. The response will trigger a local function defined by the callback. There is no mechanism which works with JSON callbacks in QML.

Let us first examine the response by using curl:

  1. curl "http://api.flickr.com/services/feeds/photos_public.gne?format=json&nojsoncallback=1&tags=munich"

The response will be something like this:

  1. {
  2.     "title": "Recent Uploads tagged munich",
  3.     ...
  4.     "items": [
  5.         {
  6.         "title": "Candle lit dinner in Munich",
  7.         "media": {"m":"http://farm8.staticflickr.com/7313/11444882743_2f5f87169f_m.jpg"},
  8.         ...
  9.         },{
  10.         "title": "Munich after sunset: a train full of \"must haves\" =",
  11.         "media": {"m":"http://farm8.staticflickr.com/7394/11443414206_a462c80e83_m.jpg"},
  12.         ...
  13.         }
  14.     ]
  15.     ...
  16. }

The returned JSON document has a defined structure. An object which has a title and an items property. Where the title is a string and items is an array of objects. When converting this text into a JSON document you can access the individual entries, as it is a valid JS object/array structure.

  1. // JS code
  2. obj = JSON.parse(response);
  3. print(obj.title) // => "Recent Uploads tagged munich"
  4. for(var i=0; i<obj.items.length; i++) {
  5.     // iterate of the items array entries
  6.     print(obj.items[i].title) // title of picture
  7.     print(obj.items[i].media.m) // url of thumbnail
  8. }

As a valid JS array, we can use the obj.items array also as a model for a list view. We will try to accomplish this now. First, we need to retrieve the response and convert it into a valid JS object. And then we can just set the response.items property as a model to a list view.

  1. function request() {
  2.     var xhr = new XMLHttpRequest();
  3.     xhr.onreadystatechange = function() {
  4.         if(...) {
  5.             ...
  6.         } else if(xhr.readyState === XMLHttpRequest.DONE) {
  7.             var response = JSON.parse(xhr.responseText.toString());
  8.             // set JS object as model for listview
  9.             view.model = response.items;
  10.         }
  11.     }
  12.     xhr.open("GET", "http://api.flickr.com/services/feeds/photos_public.gne?format=json&nojsoncallback=1&tags=munich");
  13.     xhr.send();
  14. }

Here is the full source code, where we create the request when the component is loaded. The request response is then used as the model for our simple list view.

  1. import QtQuick
  3. Rectangle {
  4.     width: 320
  5.     height: 480
  6.     ListView {
  7.         id: view
  8.         anchors.fill: parent
  9.         delegate: Thumbnail {
  10.             width: view.width
  11.             text: modelData.title
  12.             iconSource: modelData.media.m
  13.         }
  14.     }
  16.     function request() {
  17.         var xhr = new XMLHttpRequest();
  18.         xhr.onreadystatechange = function() {
  19.             if (xhr.readyState === XMLHttpRequest.HEADERS_RECEIVED) {
  20.                 print('HEADERS_RECEIVED')
  21.             } else if(xhr.readyState === XMLHttpRequest.DONE) {
  22.                 print('DONE')
  23.                 var json = JSON.parse(xhr.responseText.toString())
  24.                 view.model = json.items
  25.             }
  26.         }
  27.         xhr.open("GET", "http://api.flickr.com/services/feeds/photos_public.gne?format=json&nojsoncallback=1&tags=munich");
  28.         xhr.send();
  29.     }
  31.     Component.onCompleted: {
  32.         request()
  33.     }
  34. }

When the document is fully loaded ( Component.onCompleted ) we request the latest feed content from Flickr. On arrival, we parse the JSON response and set the items array as the model for our view. The list view has a delegate, which displays the thumbnail icon and the title text in a row.

The other option would be to have a placeholder ListModel and append each item onto the list model. To support larger models it is required to support pagination (e.g page 1 of 10) and lazy content retrieval.