[welcomeq] Start new ViewStep for QML-based welcome

src/modules/welcomeq/CMakeLists.txt

@@ -0,0 +1,41 @@
+set( _welcome ${CMAKE_CURRENT_SOURCE_DIR}/../welcome )
+
+include_directories( ${PROJECT_BINARY_DIR}/src/libcalamaresui ${_welcome} )
+
+# DUPLICATED WITH WELCOME MODULE
+find_package( Qt5 ${QT_VERSION} CONFIG REQUIRED DBus Network )
+
+find_package( LIBPARTED )
+if ( LIBPARTED_FOUND )
+    set( PARTMAN_SRC ${_welcome}/checker/partman_devices.c )
+    set( CHECKER_LINK_LIBRARIES ${LIBPARTED_LIBRARY} )
+else()
+    set( PARTMAN_SRC )
+    set( CHECKER_LINK_LIBRARIES )
+    add_definitions( -DWITHOUT_LIBPARTED )
+endif()
+
+set( CHECKER_SOURCES
+    ${_welcome}/checker/CheckerContainer.cpp
+    ${_welcome}/checker/GeneralRequirements.cpp
+    ${_welcome}/checker/ResultWidget.cpp
+    ${_welcome}/checker/ResultsListWidget.cpp
+    ${PARTMAN_SRC}
+)
+
+calamares_add_plugin( welcomeq
+    TYPE viewmodule
+    EXPORT_MACRO PLUGINDLLEXPORT_PRO
+    SOURCES
+        ${CHECKER_SOURCES}
+        WelcomeQmlViewStep.cpp
+        Config.cpp
+    RESOURCES
+        welcomeq.qrc
+    LINK_PRIVATE_LIBRARIES
+        calamaresui
+        ${CHECKER_LINK_LIBRARIES}
+        Qt5::DBus
+        Qt5::Network
+    SHARED_LIB
+)

src/modules/welcomeq/Config.cpp

@@ -0,0 +1,28 @@
+/* === This file is part of Calamares - <https://github.com/calamares> ===
+ *
+ *   Copyright 2019, Adriaan de Groot <groot@kde.org>
+ *
+ *   Calamares is free software: you can redistribute it and/or modify
+ *   it under the terms of the GNU General Public License as published by
+ *   the Free Software Foundation, either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   Calamares 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 General Public License for more details.
+ *
+ *   You should have received a copy of the GNU General Public License
+ *   along with Calamares. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "Config.h"
+
+Config::Config()
+    : m_helpUrl( "https://www.kde.org/" )
+{
+}
+
+Config::~Config()
+{
+}

src/modules/welcomeq/Config.h

@@ -0,0 +1,40 @@
+/* === This file is part of Calamares - <https://github.com/calamares> ===
+ *
+ *   Copyright 2019, Adriaan de Groot <groot@kde.org>
+ *
+ *   Calamares is free software: you can redistribute it and/or modify
+ *   it under the terms of the GNU General Public License as published by
+ *   the Free Software Foundation, either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   Calamares 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 General Public License for more details.
+ *
+ *   You should have received a copy of the GNU General Public License
+ *   along with Calamares. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef WELCOME_CONFIG_H
+#define WELCOME_CONFIG_H
+
+#include <QObject>
+#include <QUrl>
+
+class Config : public QObject
+{
+    Q_OBJECT
+    Q_PROPERTY( QUrl helpUrl READ helpUrl WRITE setHelpUrl CONSTANT )
+public:
+    Config();
+    virtual ~Config();
+
+    QUrl helpUrl() const { return m_helpUrl; }
+    void setHelpUrl( const QUrl& url ) { m_helpUrl = url; }
+
+private:
+    QUrl m_helpUrl;
+};
+
+#endif

src/modules/welcomeq/WelcomeQmlViewStep.cpp

@@ -0,0 +1,243 @@
+/* === This file is part of Calamares - <https://github.com/calamares> ===
+ *
+ *   Copyright 2014-2015, Teo Mrnjavac <teo@kde.org>
+ *   Copyright 2018, Adriaan de Groot <groot@kde.org>
+ *
+ *   Calamares is free software: you can redistribute it and/or modify
+ *   it under the terms of the GNU General Public License as published by
+ *   the Free Software Foundation, either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   Calamares 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 General Public License for more details.
+ *
+ *   You should have received a copy of the GNU General Public License
+ *   along with Calamares. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "WelcomeQmlViewStep.h"
+
+#include "checker/GeneralRequirements.h"
+
+#include "geoip/Handler.h"
+#include "locale/LabelModel.h"
+#include "locale/Lookup.h"
+#include "utils/Logger.h"
+#include "utils/Variant.h"
+
+#include "Branding.h"
+#include "modulesystem/ModuleManager.h"
+
+#include <QFutureWatcher>
+#include <QPixmap>
+#include <QVariant>
+
+CALAMARES_PLUGIN_FACTORY_DEFINITION( WelcomeQmlViewStepFactory, registerPlugin< WelcomeQmlViewStep >(); )
+
+WelcomeQmlViewStep::WelcomeQmlViewStep( QObject* parent )
+    : Calamares::ViewStep( parent )
+    , m_requirementsChecker( new GeneralRequirements( this ) )
+{
+    connect( Calamares::ModuleManager::instance(),
+             &Calamares::ModuleManager::requirementsComplete,
+             this,
+             &WelcomeQmlViewStep::nextStatusChanged );
+}
+
+
+WelcomeQmlViewStep::~WelcomeQmlViewStep()
+{
+}
+
+
+QString
+WelcomeQmlViewStep::prettyName() const
+{
+    return tr( "Welcome" );
+}
+
+
+QWidget*
+WelcomeQmlViewStep::widget()
+{
+    return nullptr;
+}
+
+
+bool
+WelcomeQmlViewStep::isNextEnabled() const
+{
+    // TODO: should return true
+    return false;
+}
+
+
+bool
+WelcomeQmlViewStep::isBackEnabled() const
+{
+    // TODO: should return true (it's weird that you are not allowed to have welcome *after* anything
+    return false;
+}
+
+
+bool
+WelcomeQmlViewStep::isAtBeginning() const
+{
+    // TODO: adjust to "pages" in the QML
+    return true;
+}
+
+
+bool
+WelcomeQmlViewStep::isAtEnd() const
+{
+    // TODO: adjust to "pages" in the QML
+    return true;
+}
+
+
+Calamares::JobList
+WelcomeQmlViewStep::jobs() const
+{
+    return Calamares::JobList();
+}
+
+
+/** @brief Look up a URL for a button
+ *
+ * Looks up @p key in @p map; if it is a *boolean* value, then
+ * assume an old-style configuration, and fetch the string from
+ * the branding settings @p e. If it is a string, not a boolean,
+ * use it as-is. If not found, or a weird type, returns empty.
+ *
+ * This allows switching the showKnownIssuesUrl and similar settings
+ * in welcome.conf from a boolean (deferring to branding) to an
+ * actual string for immediate use. Empty strings, as well as
+ * "false" as a setting, will hide the buttons as before.
+ */
+static QString
+jobOrBrandingSetting( Calamares::Branding::StringEntry e, const QVariantMap& map, const QString& key )
+{
+    if ( !map.contains( key ) )
+    {
+        return QString();
+    }
+    auto v = map.value( key );
+    if ( v.type() == QVariant::Bool )
+    {
+        return v.toBool() ? ( *e ) : QString();
+    }
+    if ( v.type() == QVariant::String )
+    {
+        return v.toString();
+    }
+
+    return QString();
+}
+
+void
+WelcomeQmlViewStep::setConfigurationMap( const QVariantMap& configurationMap )
+{
+    using Calamares::Branding;
+
+    m_config.setHelpUrl( jobOrBrandingSetting( Branding::SupportUrl, configurationMap, "showSupportUrl" ) );
+    // TODO: expand Config class and set the remaining fields
+
+    // TODO: figure out how the requirements (held by ModuleManager) should be accessible
+    //          to QML as a odel.
+    if ( configurationMap.contains( "requirements" )
+         && configurationMap.value( "requirements" ).type() == QVariant::Map )
+    {
+        m_requirementsChecker->setConfigurationMap( configurationMap.value( "requirements" ).toMap() );
+    }
+    else
+        cWarning() << "no valid requirements map found in welcome "
+                      "module configuration.";
+
+    bool ok = false;
+    QVariantMap geoip = CalamaresUtils::getSubMap( configurationMap, "geoip", ok );
+    if ( ok )
+    {
+        using FWString = QFutureWatcher< QString >;
+
+        auto* handler = new CalamaresUtils::GeoIP::Handler( CalamaresUtils::getString( geoip, "style" ),
+                                                            CalamaresUtils::getString( geoip, "url" ),
+                                                            CalamaresUtils::getString( geoip, "selector" ) );
+        if ( handler->type() != CalamaresUtils::GeoIP::Handler::Type::None )
+        {
+            auto* future = new FWString();
+            connect( future, &FWString::finished, [view = this, f = future, h = handler]() {
+                QString countryResult = f->future().result();
+                cDebug() << "GeoIP result for welcome=" << countryResult;
+                view->setCountry( countryResult, h );
+                f->deleteLater();
+                delete h;
+            } );
+            future->setFuture( handler->queryRaw() );
+        }
+        else
+        {
+            // Would not produce useful country code anyway.
+            delete handler;
+        }
+    }
+
+    QString language = CalamaresUtils::getString( configurationMap, "languageIcon" );
+    if ( !language.isEmpty() )
+    {
+        auto icon = Calamares::Branding::instance()->image( language, QSize( 48, 48 ) );
+        if ( !icon.isNull() )
+        {
+            // TODO: figure out where to set this: Config?
+        }
+    }
+}
+
+Calamares::RequirementsList
+WelcomeQmlViewStep::checkRequirements()
+{
+    return m_requirementsChecker->checkRequirements();
+}
+
+static inline void
+logGeoIPHandler( CalamaresUtils::GeoIP::Handler* handler )
+{
+    if ( handler )
+    {
+        cDebug() << Logger::SubEntry << "Obtained from" << handler->url() << " ("
+                 << static_cast< int >( handler->type() ) << handler->selector() << ')';
+    }
+}
+
+void
+WelcomeQmlViewStep::setCountry( const QString& countryCode, CalamaresUtils::GeoIP::Handler* handler )
+{
+    if ( countryCode.length() != 2 )
+    {
+        cDebug() << "Unusable country code" << countryCode;
+        logGeoIPHandler( handler );
+        return;
+    }
+
+    auto c_l = CalamaresUtils::Locale::countryData( countryCode );
+    if ( c_l.first == QLocale::Country::AnyCountry )
+    {
+        cDebug() << "Unusable country code" << countryCode;
+        logGeoIPHandler( handler );
+        return;
+    }
+    else
+    {
+        int r = CalamaresUtils::Locale::availableTranslations()->find( countryCode );
+        if ( r < 0 )
+        {
+            cDebug() << "Unusable country code" << countryCode << "(no suitable translation)";
+        }
+        if ( ( r >= 0 ) )
+        {
+            // TODO: update Config to point to selected language
+        }
+    }
+}

src/modules/welcomeq/WelcomeQmlViewStep.h

@@ -0,0 +1,85 @@
+/* === This file is part of Calamares - <https://github.com/calamares> ===
+ *
+ *   Copyright 20195, Adriaan de Groot <groot@kde.org>
+ *
+ *   Calamares is free software: you can redistribute it and/or modify
+ *   it under the terms of the GNU General Public License as published by
+ *   the Free Software Foundation, either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   Calamares 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 General Public License for more details.
+ *
+ *   You should have received a copy of the GNU General Public License
+ *   along with Calamares. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef WELCOME_QMLVIEWSTEP_H
+#define WELCOME_QMLVIEWSTEP_H
+
+#include "Config.h"
+
+#include "modulesystem/Requirement.h"
+#include "utils/PluginFactory.h"
+#include "viewpages/ViewStep.h"
+
+#include <PluginDllMacro.h>
+
+#include <QObject>
+#include <QVariantMap>
+
+namespace CalamaresUtils
+{
+namespace GeoIP
+{
+class Handler;
+}
+}  // namespace CalamaresUtils
+
+class GeneralRequirements;
+
+// TODO: Needs a generic Calamares::QmlViewStep as base class
+// TODO: refactor and move what makes sense to base class
+class PLUGINDLLEXPORT WelcomeQmlViewStep : public Calamares::ViewStep
+{
+    Q_OBJECT
+
+public:
+    explicit WelcomeQmlViewStep( QObject* parent = nullptr );
+    virtual ~WelcomeQmlViewStep() override;
+
+    QString prettyName() const override;
+
+    QWidget* widget() override;
+
+    bool isNextEnabled() const override;
+    bool isBackEnabled() const override;
+
+    bool isAtBeginning() const override;
+    bool isAtEnd() const override;
+
+    Calamares::JobList jobs() const override;
+
+    void setConfigurationMap( const QVariantMap& configurationMap ) override;
+
+    /** @brief Sets the country that Calamares is running in.
+     *
+     * This (ideally) sets up language and locale settings that are right for
+     * the given 2-letter country code. Uses the handler's information (if
+     * given) for error reporting.
+     */
+    void setCountry( const QString&, CalamaresUtils::GeoIP::Handler* handler );
+
+    Calamares::RequirementsList checkRequirements() override;
+
+private:
+    // TODO: a generic QML viewstep should return a config object from a method
+    Config m_config;
+    GeneralRequirements* m_requirementsChecker;
+};
+
+CALAMARES_PLUGIN_FACTORY_DECLARATION( WelcomeQmlViewStepFactory )
+
+#endif  // WELCOME_QMLVIEWSTEP_H