glCapsViewerHttp.cpp

/*
*
* OpenGL hardware capability viewer and database
*
* Server http communication class implementation
*
* Copyright (C) 2011-2015 by Sascha Willems (www.saschawillems.de)
*
* This code is free software, you can redistribute it and/or 
* modify it under the terms of the GNU Lesser General Public
* License version 3 as published by the Free Software Foundation.
*
* Please review the following information to ensure the GNU Lesser
* General Public License version 3 requirements will be met:
* http://opensource.org/licenses/lgpl-3.0.html
*
* The code is distributed WITHOUT ANY WARRANTY; without even the
* implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE.  See the GNU LGPL 3.0 for more details.
*
*/

#include "glCapsViewerHttp.h"
#include <QNetworkProxy>
#include <sstream>
#include <QMessageBox>
#include <QEventLoop>
#include <QHttpMultiPart>
#include <QXmlStreamReader>

glCapsViewerHttp::glCapsViewerHttp()
{
}


glCapsViewerHttp::~glCapsViewerHttp()
{
}

/// <summary>
/// Checks if the OpenGL hardware database can be reached
/// </summary>
/// <returns>true if request succeeded, false if not (e.g. wrong proxy, or website down</returns>
bool glCapsViewerHttp::checkServerConnection()
{
	manager = new QNetworkAccessManager(NULL);

	QUrl qurl(QString::fromStdString(getBaseUrl() + "services/gl_serverstate.php"));
	QNetworkReply* reply = manager->get(QNetworkRequest(qurl));

	QEventLoop loop;
	connect(reply, SIGNAL(finished()), &loop, SLOT(quit()));
	loop.exec(QEventLoop::ExcludeUserInputEvents);

	return (reply->error() == QNetworkReply::NoError);
}

/// <summary>
/// Execute http get request 
/// </summary>
/// <param name="url">url for the http get request</param>
/// <returns>string of the http get request or empty string in case of failure</returns>
string glCapsViewerHttp::httpGet(string url)
{
	manager = new QNetworkAccessManager(NULL);

	QUrl qurl(QString::fromStdString(url));
	QNetworkReply* reply = manager->get(QNetworkRequest(qurl));

	QEventLoop loop;
	connect(reply, SIGNAL(finished()), &loop, SLOT(quit()));
	loop.exec();

	if (reply->error() == QNetworkReply::NoError)
	{
		QByteArray bytes = reply->readAll();
		QString replyStr(bytes);
		delete(manager);
		return replyStr.toStdString();
	}
	else
	{
		QString err;
		err = reply->errorString();
		delete(manager);
		return "";
	}
}

/// <summary>
/// Execute http post
/// </summary>
/// <param name="url">url for the http post</param>
/// <param name="data">string data to post</param>
/// <returns>Server answer</returns>
string glCapsViewerHttp::httpPost(string url, string data) 
{
	manager = new QNetworkAccessManager(NULL);

	QHttpMultiPart *multiPart = new QHttpMultiPart(QHttpMultiPart::FormDataType);

	QHttpPart xmlPart;
	xmlPart.setHeader(QNetworkRequest::ContentDispositionHeader, QVariant("form-data; name=\"data\"; filename=\"glcapsviewerreport.xml\""));
	xmlPart.setBody(QString::fromStdString(data).toLatin1());
	multiPart->append(xmlPart);

	QUrl qurl(QString::fromStdString(url));
	QNetworkRequest request(qurl);
	QNetworkReply *reply = manager->post(request, multiPart);
	multiPart->setParent(reply);
	
	QEventLoop loop;
	connect(reply, SIGNAL(finished()), &loop, SLOT(quit()));
	loop.exec();

	if (reply->error() == QNetworkReply::NoError)
	{
		QByteArray bytes = reply->readAll();
		QString replyStr(bytes);
		delete(manager);
		return replyStr.toStdString();
	}
	else
	{
		QString err;
		err = reply->errorString();
		delete(manager);
		return "";
	}

}

/// <summary>
/// Encodes an url (or string) to make it comply to RFC2396 by replacing
/// illegal characters
/// Some device descriptions may include a "+" that needs to be replaced (e.g. GeForce 9800 GTX+/PCI/SSE2)
/// </summary>
/// <param name="url">Url (or string) to be encoded</param>
/// <returns></returns>
string glCapsViewerHttp::encodeUrl(string url)
{
	QString urlStr(QString::fromStdString(url));
	urlStr.replace("+", "%2B"); 
	return urlStr.toStdString();
}

/// <summary>
/// Gets the Id of a report from the online database
/// </summary>
/// <param name="description">Description of the report to get the Id for</param>
/// <returns></returns>
int glCapsViewerHttp::getReportId(string description)
{
	string httpReply;
	stringstream urlss;
	urlss << getBaseUrl() << "gl_checkreport.php?description=" << description;
	string url = encodeUrl(urlss.str());
	httpReply = httpGet(url);
	return (!httpReply.empty()) ? atoi(httpReply.c_str()) : -1;
}

/// <summary>
/// Checks if the report is present in the online database
/// </summary>
/// <param name="description">Description of the report to get the Id for</param>
/// <returns></returns>
bool glCapsViewerHttp::checkReportPresent(string description)
{
	int reportID = getReportId(description);
	return (reportID > -1) ? true : false;
}

/// <summary>
/// Fechtes the OpenGL capability xml list from the web server
/// </summary>
/// <returns>xml string</returns>
string glCapsViewerHttp::fetchCapsList()
{
	string capsXml;
	stringstream urlss;
	capsXml = httpGet(getBaseUrl() + "/files/capslist.xml");
	return capsXml;
}

/// <summary>
/// Fechtes an xml with all report data from the online database
/// </summary>
/// <param name="reportId">id of the report to get the report xml for</param>
/// <returns>xml string</returns>
string glCapsViewerHttp::fetchReport(int reportId)
{
	string reportXml;
	stringstream urlss;
	urlss << getBaseUrl() << "services/gl_getreport.php?reportId=" << reportId;
	reportXml = httpGet(urlss.str());
	return reportXml;
}

/// <summary>
/// Posts the given xml for a report to the database	
/// </summary>
/// <returns>todo</returns>
string glCapsViewerHttp::postReport(string xml)
{
	string httpReply;
	stringstream urlss;
	urlss << getBaseUrl() << "services/gl_convertreport.php";
	httpReply = httpPost(urlss.str(), xml);
	return httpReply;
}

/// <summary>
/// Posts the given url to the db report update script 
/// </summary>
/// <returns>Coma separated list of updated caps</returns>
string glCapsViewerHttp::postReportForUpdate(string xml)
{
	string httpReply;
	stringstream urlss;
	urlss << getBaseUrl() << "services/gl_updatereport.php";
	httpReply = httpPost(urlss.str(), xml);
	return httpReply;
}

/// <summary>
/// Fetches all available devices from the online database and lists them in the ui
/// </summary>
/// <returns>List of reports as vector</returns>
vector<string> glCapsViewerHttp::fetchDevices() 
{
	vector<string> deviceList;
	string httpReply;
	stringstream urlss;
	urlss << getBaseUrl() << "services/gl_getdevices.php";
	httpReply = httpGet(urlss.str());

	if (!httpReply.empty()) {
		QXmlStreamReader xmlReader(&httpReply[0]);
		while (!xmlReader.atEnd())  {

			if ((xmlReader.name() == "device") && (xmlReader.isStartElement())) {
				deviceList.push_back(xmlReader.readElementText().toStdString());
			}

			xmlReader.readNext();
		}
	}

	return deviceList;
}

/// <summary>
/// Fetches all available reports for the given device
/// </summary>
/// <param name="device">Name of the device to select reports for (GL_RENDERER) </param>
/// <returns></returns>
vector<reportInfo> glCapsViewerHttp::fetchDeviceReports(string device)
{
	vector<reportInfo> reportList;
	string httpReply;
	stringstream urlss;
	urlss << getBaseUrl() << "services/gl_getdevicereports.php?glrenderer=" << device;
	string url;
	url = encodeUrl(urlss.str());
	httpReply = httpGet(url);

	if (!httpReply.empty())
	{
		QXmlStreamReader xmlReader(&httpReply[0]);

		while (!xmlReader.atEnd()) {

			if ((xmlReader.name() == "report") && (xmlReader.isStartElement())) {
				reportInfo report;
				report.device = device;
				QXmlStreamAttributes xmlAttribs = xmlReader.attributes();
				report.operatingSystem = xmlAttribs.value("os").toString().toStdString();
				report.reportId = xmlAttribs.value("id").toInt();
				report.version = xmlReader.readElementText().toStdString();
				reportList.push_back(report);
			}

			xmlReader.readNext();
		}

	};

	return reportList;
}

/// <summary>
/// Returns the base url of the OpenGL hardware database
/// </summary>
string glCapsViewerHttp::getBaseUrl()
{
#ifdef DEVDATABASE
	return "http://www.delphigl.de/opengldatabase_dev/";
#else
	return "http://opengl.gpuinfo.org/";
#endif
}