WebEngine Widgets WebUI Example


  /****************************************************************************
  **
  ** Copyright (C) 2018 The Qt Company Ltd.
  ** Contact: https://www.qt.io/licensing/
  **
  ** This file is part of the examples of the Qt Toolkit.
  **
  ** $QT_BEGIN_LICENSE:BSD$
  ** Commercial License Usage
  ** Licensees holding valid commercial Qt licenses may use this file in
  ** accordance with the commercial license agreement provided with the
  ** Software or, alternatively, in accordance with the terms contained in
  ** a written agreement between you and The Qt Company. For licensing terms
  ** and conditions see https://www.qt.io/terms-conditions. For further
  ** information use the contact form at https://www.qt.io/contact-us.
  **
  ** BSD License Usage
  ** Alternatively, you may use this file under the terms of the BSD license
  ** as follows:
  **
  ** "Redistribution and use in source and binary forms, with or without
  ** modification, are permitted provided that the following conditions are
  ** met:
  **   * Redistributions of source code must retain the above copyright
  **     notice, this list of conditions and the following disclaimer.
  **   * Redistributions in binary form must reproduce the above copyright
  **     notice, this list of conditions and the following disclaimer in
  **     the documentation and/or other materials provided with the
  **     distribution.
  **   * Neither the name of The Qt Company Ltd nor the names of its
  **     contributors may be used to endorse or promote products derived
  **     from this software without specific prior written permission.
  **
  **
  ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
  **
  ** $QT_END_LICENSE$
  **
  ****************************************************************************/

  #include "webuihandler.h"

  #include <QApplication>
  #include <QFile>
  #include <QWebEngineUrlRequestJob>
  #include <QWebEngineUrlScheme>

  #define SCHEMENAME "webui"

  const QByteArray WebUiHandler::schemeName = QByteArrayLiteral(SCHEMENAME);
  const QUrl WebUiHandler::aboutUrl = QUrl(QStringLiteral(SCHEMENAME ":about"));

  WebUiHandler::WebUiHandler(QObject *parent)
      : QWebEngineUrlSchemeHandler(parent)
  {
  }

  void WebUiHandler::requestStarted(QWebEngineUrlRequestJob *job)
  {
      static const QUrl webUiOrigin(QStringLiteral(SCHEMENAME ":"));
      static const QByteArray GET(QByteArrayLiteral("GET"));
      static const QByteArray POST(QByteArrayLiteral("POST"));

      QByteArray method = job->requestMethod();
      QUrl url = job->requestUrl();
      QUrl initiator = job->initiator();

      if (method == GET && url == aboutUrl) {
          QFile *file = new QFile(QStringLiteral(":/about.html"), job);
          file->open(QIODevice::ReadOnly);
          job->reply(QByteArrayLiteral("text/html"), file);
      } else if (method == POST && url == aboutUrl && initiator == webUiOrigin) {
          job->fail(QWebEngineUrlRequestJob::RequestAborted);
          QApplication::exit();
      } else {
          job->fail(QWebEngineUrlRequestJob::UrlNotFound);
      }
  }

  // static
  void WebUiHandler::registerUrlScheme()
  {
      QWebEngineUrlScheme webUiScheme(schemeName);
      webUiScheme.setFlags(QWebEngineUrlScheme::SecureScheme |
                           QWebEngineUrlScheme::LocalScheme |
                           QWebEngineUrlScheme::LocalAccessAllowed);
      QWebEngineUrlScheme::registerScheme(webUiScheme);
  }