mirror of https://github.com/cutefishos/calamares
Merge branch 'issue-1287' into calamares
Major update to the 'tracking' module with improved wording, functionality, QML-preparation, and a working kuserfeedback mode. FIXES #1287main
Adriaan de Groot
5 years ago
commit
0305476f8a
@ -0,0 +1,256 @@
|
||||
/* === This file is part of Calamares - <https://github.com/calamares> ===
|
||||
*
|
||||
* Copyright 2020, 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"
|
||||
|
||||
#include "TrackingType.h"
|
||||
|
||||
#include "utils/Logger.h"
|
||||
#include "utils/Variant.h"
|
||||
|
||||
#include <QUrl>
|
||||
|
||||
const NamedEnumTable< TrackingType >&
|
||||
trackingNames()
|
||||
{
|
||||
// *INDENT-OFF*
|
||||
// clang-format off
|
||||
static const NamedEnumTable< TrackingType > names {
|
||||
{ QStringLiteral( "none" ), TrackingType::NoTracking },
|
||||
{ QStringLiteral( "install" ), TrackingType::InstallTracking },
|
||||
{ QStringLiteral( "machine" ), TrackingType::MachineTracking },
|
||||
{ QStringLiteral( "user" ), TrackingType::UserTracking }
|
||||
};
|
||||
// clang-format on
|
||||
// *INDENT-ON*
|
||||
|
||||
return names;
|
||||
}
|
||||
|
||||
TrackingStyleConfig::TrackingStyleConfig( QObject* parent )
|
||||
: QObject( parent )
|
||||
{
|
||||
}
|
||||
|
||||
TrackingStyleConfig::~TrackingStyleConfig() {}
|
||||
|
||||
void
|
||||
TrackingStyleConfig::setTracking( bool enabled )
|
||||
{
|
||||
setTracking( enabled ? EnabledByUser : DisabledByUser );
|
||||
}
|
||||
|
||||
void
|
||||
TrackingStyleConfig::setTracking( TrackingStyleConfig::TrackingState state )
|
||||
{
|
||||
if ( m_state != TrackingState::DisabledByConfig )
|
||||
{
|
||||
m_state = state;
|
||||
}
|
||||
emit trackingChanged();
|
||||
}
|
||||
|
||||
void
|
||||
TrackingStyleConfig::validate( QString& s, std::function< bool( const QString& ) >&& pred )
|
||||
{
|
||||
if ( !pred( s ) )
|
||||
{
|
||||
if ( m_state != DisabledByConfig )
|
||||
{
|
||||
cError() << "Configuration string" << s << "is not valid; disabling this tracking type.";
|
||||
m_state = DisabledByConfig;
|
||||
emit trackingChanged();
|
||||
}
|
||||
s = QString();
|
||||
}
|
||||
}
|
||||
|
||||
void
|
||||
TrackingStyleConfig::validateUrl( QString& urlString )
|
||||
{
|
||||
if ( !QUrl( urlString ).isValid() )
|
||||
{
|
||||
if ( m_state != DisabledByConfig )
|
||||
{
|
||||
cError() << "URL" << urlString << "is not valid; disabling tracking type" << objectName();
|
||||
m_state = DisabledByConfig;
|
||||
emit trackingChanged();
|
||||
}
|
||||
urlString = QString();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void
|
||||
TrackingStyleConfig::setConfigurationMap( const QVariantMap& config )
|
||||
{
|
||||
m_state = CalamaresUtils::getBool( config, "enabled", false ) ? DisabledByUser : DisabledByConfig;
|
||||
m_policy = CalamaresUtils::getString( config, "policy" );
|
||||
validateUrl( m_policy );
|
||||
emit policyChanged( m_policy );
|
||||
emit trackingChanged();
|
||||
}
|
||||
|
||||
InstallTrackingConfig::InstallTrackingConfig( QObject* parent )
|
||||
: TrackingStyleConfig( parent )
|
||||
{
|
||||
setObjectName( "InstallTrackingConfig" );
|
||||
}
|
||||
|
||||
void
|
||||
InstallTrackingConfig::setConfigurationMap( const QVariantMap& configurationMap )
|
||||
{
|
||||
TrackingStyleConfig::setConfigurationMap( configurationMap );
|
||||
|
||||
m_installTrackingUrl = CalamaresUtils::getString( configurationMap, "url" );
|
||||
validateUrl( m_installTrackingUrl );
|
||||
}
|
||||
|
||||
MachineTrackingConfig::MachineTrackingConfig( QObject* parent )
|
||||
: TrackingStyleConfig( parent )
|
||||
{
|
||||
setObjectName( "MachineTrackingConfig" );
|
||||
}
|
||||
|
||||
/** @brief Is @p s a valid machine-tracking style. */
|
||||
static bool
|
||||
isValidMachineTrackingStyle( const QString& s )
|
||||
{
|
||||
static QStringList knownStyles { "updatemanager" };
|
||||
return knownStyles.contains( s );
|
||||
}
|
||||
|
||||
void
|
||||
MachineTrackingConfig::setConfigurationMap( const QVariantMap& configurationMap )
|
||||
{
|
||||
TrackingStyleConfig::setConfigurationMap( configurationMap );
|
||||
|
||||
m_machineTrackingStyle = CalamaresUtils::getString( configurationMap, "style" );
|
||||
validate( m_machineTrackingStyle, isValidMachineTrackingStyle );
|
||||
}
|
||||
|
||||
|
||||
UserTrackingConfig::UserTrackingConfig( QObject* parent )
|
||||
: TrackingStyleConfig( parent )
|
||||
{
|
||||
setObjectName( "UserTrackingConfig" );
|
||||
}
|
||||
|
||||
static bool
|
||||
isValidUserTrackingStyle( const QString& s )
|
||||
{
|
||||
static QStringList knownStyles { "kuserfeedback" };
|
||||
return knownStyles.contains( s );
|
||||
}
|
||||
|
||||
void
|
||||
UserTrackingConfig::setConfigurationMap( const QVariantMap& configurationMap )
|
||||
{
|
||||
TrackingStyleConfig::setConfigurationMap( configurationMap );
|
||||
|
||||
m_userTrackingStyle = CalamaresUtils::getString( configurationMap, "style" );
|
||||
validate( m_userTrackingStyle, isValidUserTrackingStyle );
|
||||
|
||||
m_userTrackingAreas = CalamaresUtils::getStringList( configurationMap, "areas" );
|
||||
}
|
||||
|
||||
|
||||
Config::Config( QObject* parent )
|
||||
: QObject( parent )
|
||||
, m_installTracking( new InstallTrackingConfig( this ) )
|
||||
, m_machineTracking( new MachineTrackingConfig( this ) )
|
||||
, m_userTracking( new UserTrackingConfig( this ) )
|
||||
{
|
||||
}
|
||||
|
||||
static void
|
||||
enableLevelsBelow( Config* config, TrackingType level )
|
||||
{
|
||||
switch ( level )
|
||||
{
|
||||
case TrackingType::UserTracking:
|
||||
config->userTracking()->setTracking( TrackingStyleConfig::TrackingState::EnabledByUser );
|
||||
FALLTHRU;
|
||||
case TrackingType::MachineTracking:
|
||||
config->machineTracking()->setTracking( TrackingStyleConfig::TrackingState::EnabledByUser );
|
||||
FALLTHRU;
|
||||
case TrackingType::InstallTracking:
|
||||
config->installTracking()->setTracking( TrackingStyleConfig::TrackingState::EnabledByUser );
|
||||
break;
|
||||
case TrackingType::NoTracking:
|
||||
config->noTracking( true );
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
void
|
||||
Config::setConfigurationMap( const QVariantMap& configurationMap )
|
||||
{
|
||||
m_generalPolicy = CalamaresUtils::getString( configurationMap, "policy" );
|
||||
|
||||
if ( !QUrl( m_generalPolicy ).isValid() )
|
||||
{
|
||||
m_generalPolicy = QString();
|
||||
}
|
||||
emit generalPolicyChanged( m_generalPolicy );
|
||||
|
||||
bool success = false;
|
||||
auto subconfig = CalamaresUtils::getSubMap( configurationMap, "install", success );
|
||||
if ( success )
|
||||
{
|
||||
m_installTracking->setConfigurationMap( subconfig );
|
||||
}
|
||||
|
||||
subconfig = CalamaresUtils::getSubMap( configurationMap, "machine", success );
|
||||
if ( success )
|
||||
{
|
||||
m_machineTracking->setConfigurationMap( subconfig );
|
||||
}
|
||||
|
||||
subconfig = CalamaresUtils::getSubMap( configurationMap, "user", success );
|
||||
if ( success )
|
||||
{
|
||||
m_userTracking->setConfigurationMap( subconfig );
|
||||
}
|
||||
|
||||
auto level = trackingNames().find( CalamaresUtils::getString( configurationMap, "default" ), success );
|
||||
if ( !success )
|
||||
{
|
||||
cWarning() << "Default tracking level unknown:" << CalamaresUtils::getString( configurationMap, "default" );
|
||||
level = TrackingType::NoTracking;
|
||||
}
|
||||
enableLevelsBelow( this, level );
|
||||
}
|
||||
|
||||
QString
|
||||
Config::generalPolicy() const
|
||||
{
|
||||
return m_generalPolicy;
|
||||
}
|
||||
|
||||
void
|
||||
Config::noTracking( bool switchOffAllTracking )
|
||||
{
|
||||
if ( !switchOffAllTracking )
|
||||
{
|
||||
return;
|
||||
}
|
||||
m_installTracking->setTracking( TrackingStyleConfig::TrackingState::DisabledByUser );
|
||||
m_machineTracking->setTracking( TrackingStyleConfig::TrackingState::DisabledByUser );
|
||||
m_userTracking->setTracking( TrackingStyleConfig::TrackingState::DisabledByUser );
|
||||
}
|
||||
@ -0,0 +1,192 @@
|
||||
/* === This file is part of Calamares - <https://github.com/calamares> ===
|
||||
*
|
||||
* Copyright 2020, 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 TRACKING_CONFIG_H
|
||||
#define TRACKING_CONFIG_H
|
||||
|
||||
#include <QObject>
|
||||
#include <QString>
|
||||
#include <QVariantMap>
|
||||
|
||||
/** @brief Base class for configuring a specific kind of tracking.
|
||||
*
|
||||
* All tracking types have a policy URL, which is used to explain what
|
||||
* kind of tracking is involved, what data is sent, etc. The content
|
||||
* of that URL is the responsibility of the distro.
|
||||
*
|
||||
* A tracking type is disabled by default: if it isn't specifically
|
||||
* enabled (for configuration) in the config file, it will always be disabled.
|
||||
* If it is enabled (for configuration) in the config file, it still
|
||||
* defaults to disabled, but the user can choose to enable it.
|
||||
*/
|
||||
class TrackingStyleConfig : public QObject
|
||||
{
|
||||
Q_OBJECT
|
||||
|
||||
Q_PROPERTY( TrackingState trackingStatus READ tracking WRITE setTracking NOTIFY trackingChanged FINAL )
|
||||
Q_PROPERTY( bool isEnabled READ isEnabled NOTIFY trackingChanged FINAL )
|
||||
Q_PROPERTY( bool isConfigurable READ isConfigurable NOTIFY trackingChanged FINAL )
|
||||
Q_PROPERTY( QString policy READ policy NOTIFY policyChanged FINAL )
|
||||
|
||||
public:
|
||||
TrackingStyleConfig( QObject* parent );
|
||||
virtual ~TrackingStyleConfig();
|
||||
|
||||
void setConfigurationMap( const QVariantMap& );
|
||||
|
||||
enum TrackingState
|
||||
{
|
||||
DisabledByConfig,
|
||||
DisabledByUser,
|
||||
EnabledByUser
|
||||
};
|
||||
Q_ENUM( TrackingState );
|
||||
|
||||
public Q_SLOTS:
|
||||
TrackingState tracking() const { return m_state; }
|
||||
/// @brief Has the user specifically enabled this kind of tracking?
|
||||
bool isEnabled() const { return m_state == EnabledByUser; }
|
||||
/// @brief Is this tracking enabled for configuration?
|
||||
bool isConfigurable() const { return m_state != DisabledByConfig; }
|
||||
/** @brief Sets the tracking state
|
||||
*
|
||||
* Unless the tracking is enabled for configuration, it always
|
||||
* remains disabled.
|
||||
*/
|
||||
void setTracking( TrackingState );
|
||||
/** @brief Sets the tracking state
|
||||
*
|
||||
* Use @c true for @c EnabledByUser, @c false for DisabledByUser,
|
||||
* but keep in mind that if the tracking is not enabled for
|
||||
* configuration, it will always remain disabled.
|
||||
*/
|
||||
void setTracking( bool );
|
||||
|
||||
/// @brief URL for the policy explaining this tracking
|
||||
QString policy() const { return m_policy; }
|
||||
|
||||
signals:
|
||||
void trackingChanged();
|
||||
void policyChanged( QString );
|
||||
|
||||
protected:
|
||||
/// @brief Validates the @p urlString, disables tracking if invalid
|
||||
void validateUrl( QString& urlString );
|
||||
/// @brief Validates the @p string, disables tracking if invalid
|
||||
void validate( QString& s, std::function< bool( const QString& s ) >&& pred );
|
||||
|
||||
private:
|
||||
TrackingState m_state = DisabledByConfig;
|
||||
QString m_policy; // URL
|
||||
};
|
||||
|
||||
/** @brief Install tracking pings a URL at the end of installation
|
||||
*
|
||||
* Install tracking will do a single GET on the given URL at
|
||||
* the end of installation. The information included in the GET
|
||||
* request depends on the URL configuration, see also the tracking
|
||||
* jobs.
|
||||
*/
|
||||
class InstallTrackingConfig : public TrackingStyleConfig
|
||||
{
|
||||
public:
|
||||
InstallTrackingConfig( QObject* parent );
|
||||
void setConfigurationMap( const QVariantMap& configurationMap );
|
||||
|
||||
QString installTrackingUrl() { return m_installTrackingUrl; }
|
||||
|
||||
private:
|
||||
QString m_installTrackingUrl;
|
||||
};
|
||||
|
||||
/** @brief Machine tracking reports from the installed system
|
||||
*
|
||||
* When machine tracking is on, the installed system will report
|
||||
* back ("call home") at some point. This can mean Debian pop-con,
|
||||
* or updatemanager maching tracking, or something else. The kind
|
||||
* of configuration depends on the style of tracking that is enabled.
|
||||
*/
|
||||
class MachineTrackingConfig : public TrackingStyleConfig
|
||||
{
|
||||
public:
|
||||
MachineTrackingConfig( QObject* parent );
|
||||
void setConfigurationMap( const QVariantMap& configurationMap );
|
||||
|
||||
QString machineTrackingStyle() { return m_machineTrackingStyle; }
|
||||
|
||||
private:
|
||||
QString m_machineTrackingStyle;
|
||||
};
|
||||
|
||||
/** @brief User tracking reports user actions
|
||||
*
|
||||
* When user tracking is on, it is enabled for the user configured
|
||||
* in Calamares -- not for users created afterwards in the target
|
||||
* system, unless the target system defaults to tracking them.
|
||||
* The kind of user tracking depends on the target system and
|
||||
* environment; KDE user tracking is one example, which can be
|
||||
* configured in a fine-grained way and defaults to off.
|
||||
*/
|
||||
class UserTrackingConfig : public TrackingStyleConfig
|
||||
{
|
||||
public:
|
||||
UserTrackingConfig( QObject* parent );
|
||||
void setConfigurationMap( const QVariantMap& configurationMap );
|
||||
|
||||
QString userTrackingStyle() { return m_userTrackingStyle; }
|
||||
QStringList userTrackingAreas() const { return m_userTrackingAreas; }
|
||||
|
||||
private:
|
||||
QString m_userTrackingStyle;
|
||||
QStringList m_userTrackingAreas; // fine-grained areas
|
||||
};
|
||||
|
||||
class Config : public QObject
|
||||
{
|
||||
Q_OBJECT
|
||||
Q_PROPERTY( QString generalPolicy READ generalPolicy NOTIFY generalPolicyChanged FINAL )
|
||||
Q_PROPERTY( TrackingStyleConfig* installTracking READ installTracking FINAL )
|
||||
Q_PROPERTY( TrackingStyleConfig* machineTracking READ machineTracking FINAL )
|
||||
Q_PROPERTY( TrackingStyleConfig* userTracking READ userTracking FINAL )
|
||||
|
||||
public:
|
||||
Config( QObject* parent = nullptr );
|
||||
void setConfigurationMap( const QVariantMap& );
|
||||
|
||||
public Q_SLOTS:
|
||||
QString generalPolicy() const;
|
||||
|
||||
InstallTrackingConfig* installTracking() const { return m_installTracking; }
|
||||
MachineTrackingConfig* machineTracking() const { return m_machineTracking; }
|
||||
UserTrackingConfig* userTracking() const { return m_userTracking; }
|
||||
|
||||
/// @brief Call with @c true to turn off all the trackings
|
||||
void noTracking( bool );
|
||||
|
||||
signals:
|
||||
void generalPolicyChanged( QString );
|
||||
|
||||
private:
|
||||
QString m_generalPolicy;
|
||||
|
||||
InstallTrackingConfig* m_installTracking;
|
||||
MachineTrackingConfig* m_machineTracking;
|
||||
UserTrackingConfig* m_userTracking;
|
||||
};
|
||||
|
||||
#endif
|
||||
Loading…
Reference in New Issue