calamares/src/modules/partition/jobs/FillGlobalStorageJob.cpp
Adriaan de Groot 5a4e2b73ab [libcalamares][partition] Give RedactedName a convert-to-QString
- use hex-trailer
- while here, convert DebugRow to use a copy rather than a reference,
  to avoid dangling references when applied to temporaries
- convert *partition* module to use the RedactedNames
2021-11-16 15:22:04 +01:00

387 lines
13 KiB
C++

/* === This file is part of Calamares - <https://calamares.io> ===
*
* SPDX-FileCopyrightText: 2014 Aurélien Gâteau <agateau@kde.org>
* SPDX-FileCopyrightText: 2015-2016 Teo Mrnjavac <teo@kde.org>
* SPDX-FileCopyrightText: 2017 2019-2020, Adriaan de Groot <groot@kde.org>
* SPDX-License-Identifier: GPL-3.0-or-later
*
* Calamares is Free Software: see the License-Identifier above.
*
*/
#include "FillGlobalStorageJob.h"
#include "core/KPMHelpers.h"
#include "core/PartitionInfo.h"
#include "Branding.h"
#include "GlobalStorage.h"
#include "JobQueue.h"
#include "partition/FileSystem.h"
#include "partition/Global.h"
#include "partition/PartitionIterator.h"
#include "utils/Logger.h"
#include <kpmcore/core/device.h>
#include <kpmcore/core/partition.h>
#include <kpmcore/fs/filesystem.h>
#include <kpmcore/fs/luks.h>
#include <QDebug>
#include <QDir>
#include <QFileInfo>
#include <QProcess>
using CalamaresUtils::Partition::PartitionIterator;
using CalamaresUtils::Partition::untranslatedFS;
using CalamaresUtils::Partition::userVisibleFS;
typedef QHash< QString, QString > UuidForPartitionHash;
static UuidForPartitionHash
findPartitionUuids( QList< Device* > devices )
{
UuidForPartitionHash hash;
foreach ( Device* device, devices )
{
for ( auto it = PartitionIterator::begin( device ); it != PartitionIterator::end( device ); ++it )
{
Partition* p = *it;
QString path = p->partitionPath();
QString uuid = p->fileSystem().readUUID( p->partitionPath() );
hash.insert( path, uuid );
}
}
if ( hash.isEmpty() )
{
cDebug() << "No UUIDs found for existing partitions.";
}
return hash;
}
static QString
getLuksUuid( const QString& path )
{
QProcess process;
process.setProgram( "cryptsetup" );
process.setArguments( { "luksUUID", path } );
process.start();
process.waitForFinished();
if ( process.exitStatus() != QProcess::NormalExit || process.exitCode() )
{
return QString();
}
QString uuid = QString::fromLocal8Bit( process.readAllStandardOutput() ).trimmed();
return uuid;
}
static QVariant
mapForPartition( Partition* partition, const QString& uuid )
{
QVariantMap map;
map[ "device" ] = partition->partitionPath();
map[ "partlabel" ] = partition->label();
map[ "partuuid" ] = partition->uuid();
map[ "mountPoint" ] = PartitionInfo::mountPoint( partition );
map[ "fsName" ] = userVisibleFS( partition->fileSystem() );
map[ "fs" ] = untranslatedFS( partition->fileSystem() );
#ifdef WITH_KPMCORE42API
map[ "parttype" ] = partition->type();
map[ "partattrs" ] = partition->attributes();
map[ "features" ] = partition->fileSystem().features();
#endif
if ( partition->fileSystem().type() == FileSystem::Luks
&& dynamic_cast< FS::luks& >( partition->fileSystem() ).innerFS() )
{
map[ "fs" ] = untranslatedFS( dynamic_cast< FS::luks& >( partition->fileSystem() ).innerFS() );
}
map[ "uuid" ] = uuid;
map[ "claimed" ] = PartitionInfo::format( partition ); // If we formatted it, it's ours
// Debugging for inside the loop in createPartitionList(),
// so indent a bit
Logger::CDebug deb;
using TR = Logger::DebugRow< const char* const, const QString >;
// clang-format off
deb << Logger::SubEntry << "mapping for" << partition->partitionPath() << partition->deviceNode()
<< TR( "partlabel", map[ "partlabel" ].toString() )
<< TR( "partition-uuid (partuuid)", Logger::RedactedName( "PartUUID", map[ "partuuid" ].toString() ) )
<< TR( "parttype", map[ "parttype" ].toString() )
<< TR( "partattrs", map[ "partattrs" ].toString() )
<< TR( "mountPoint:", PartitionInfo::mountPoint( partition ) )
<< TR( "fs:", map[ "fs" ].toString() )
<< TR( "fsName", map[ "fsName" ].toString() )
<< TR( "filesystem-uuid (uuid)", Logger::RedactedName( "FSUUID", uuid ) )
<< TR( "claimed", map[ "claimed" ].toString() );
// clang-format on
if ( partition->roles().has( PartitionRole::Luks ) )
{
const FileSystem& fsRef = partition->fileSystem();
const FS::luks* luksFs = dynamic_cast< const FS::luks* >( &fsRef );
if ( luksFs )
{
map[ "luksMapperName" ] = luksFs->mapperName().split( "/" ).last();
map[ "luksUuid" ] = getLuksUuid( partition->partitionPath() );
map[ "luksPassphrase" ] = luksFs->passphrase();
deb << TR( "luksMapperName:", map[ "luksMapperName" ].toString() );
}
}
return map;
}
static QString
prettyFileSystemFeatures( const QVariantMap& features )
{
QStringList list;
for ( const auto& key : features.keys() )
{
const auto& value = features.value( key );
if ( value.type() == QVariant::Bool )
{
if ( value.toBool() )
{
list += key;
}
else
{
list += QString( "not " ) + key;
}
}
else
{
list += key + QString( "=" ) + value.toString();
}
}
return list.join( QStringLiteral( ", " ) );
}
FillGlobalStorageJob::FillGlobalStorageJob( const Config*, QList< Device* > devices, const QString& bootLoaderPath )
: m_devices( devices )
, m_bootLoaderPath( bootLoaderPath )
{
}
QString
FillGlobalStorageJob::prettyName() const
{
return tr( "Set partition information" );
}
QString
FillGlobalStorageJob::prettyDescription() const
{
QStringList lines;
const auto partitionList = createPartitionList();
for ( const QVariant& partitionItem : partitionList )
{
if ( partitionItem.type() == QVariant::Map )
{
QVariantMap partitionMap = partitionItem.toMap();
QString path = partitionMap.value( "device" ).toString();
QString mountPoint = partitionMap.value( "mountPoint" ).toString();
QString fsType = partitionMap.value( "fs" ).toString();
QString features = prettyFileSystemFeatures( partitionMap.value( "features" ).toMap() );
if ( mountPoint.isEmpty() || fsType.isEmpty() || fsType == QString( "unformatted" ) )
{
continue;
}
if ( path.isEmpty() )
{
if ( mountPoint == "/" )
{
if ( !features.isEmpty() )
{
lines.append( tr( "Install %1 on <strong>new</strong> %2 system partition "
"with features <em>%3</em>" )
.arg( Calamares::Branding::instance()->shortProductName() )
.arg( fsType )
.arg( features ) );
}
else
{
lines.append( tr( "Install %1 on <strong>new</strong> %2 system partition." )
.arg( Calamares::Branding::instance()->shortProductName() )
.arg( fsType ) );
}
}
else
{
if ( !features.isEmpty() )
{
lines.append( tr( "Set up <strong>new</strong> %2 partition with mount point "
"<strong>%1</strong> and features <em>%3</em>." )
.arg( mountPoint )
.arg( fsType )
.arg( features ) );
}
else
{
lines.append( tr( "Set up <strong>new</strong> %2 partition with mount point "
"<strong>%1</strong>%3." )
.arg( mountPoint )
.arg( fsType )
.arg( features ) );
}
}
}
else
{
if ( mountPoint == "/" )
{
if ( !features.isEmpty() )
{
lines.append( tr( "Install %2 on %3 system partition <strong>%1</strong>"
" with features <em>%4</em>." )
.arg( path )
.arg( Calamares::Branding::instance()->shortProductName() )
.arg( fsType )
.arg( features ) );
}
else
{
lines.append( tr( "Install %2 on %3 system partition <strong>%1</strong>." )
.arg( path )
.arg( Calamares::Branding::instance()->shortProductName() )
.arg( fsType ) );
}
}
else
{
if ( !features.isEmpty() )
{
lines.append( tr( "Set up %3 partition <strong>%1</strong> with mount point "
"<strong>%2</strong> and features <em>%4</em>." )
.arg( path )
.arg( mountPoint )
.arg( fsType )
.arg( features ) );
}
else
{
lines.append( tr( "Set up %3 partition <strong>%1</strong> with mount point "
"<strong>%2</strong>%4." )
.arg( path )
.arg( mountPoint )
.arg( fsType )
.arg( QString() ) );
}
}
}
}
}
QVariant bootloaderMap = createBootLoaderMap();
if ( !m_bootLoaderPath.isEmpty() )
{
lines.append( tr( "Install boot loader on <strong>%1</strong>." ).arg( m_bootLoaderPath ) );
}
return lines.join( "<br/>" );
}
QString
FillGlobalStorageJob::prettyStatusMessage() const
{
return tr( "Setting up mount points." );
}
/** @brief note which FS'ses are in use in GS
*
* .. mark as "1" if it's on the system, somewhere
* .. mark as "2" if it's one of the claimed / in-use FSses
*
* Stores a GS key called "filesystem_use" with this mapping.
* @see CalamaresUtils::Partition::useFilesystemGS()
*/
static void
storeFSUse( Calamares::GlobalStorage* storage, const QVariantList& partitions )
{
if ( storage )
{
CalamaresUtils::Partition::clearFilesystemGS( storage );
for ( const auto& p : partitions )
{
const auto pmap = p.toMap();
QString fs = pmap.value( "fs" ).toString();
if ( fs.isEmpty() )
{
continue;
}
CalamaresUtils::Partition::useFilesystemGS( storage, fs, true );
}
}
}
Calamares::JobResult
FillGlobalStorageJob::exec()
{
Calamares::GlobalStorage* storage = Calamares::JobQueue::instance()->globalStorage();
const auto partitions = createPartitionList();
cDebug() << "Saving partition information map to GlobalStorage[\"partitions\"]";
storage->insert( "partitions", partitions );
storeFSUse( storage, partitions );
if ( !m_bootLoaderPath.isEmpty() )
{
QVariant var = createBootLoaderMap();
if ( !var.isValid() )
{
cDebug() << "Failed to find path for boot loader";
}
cDebug() << "FillGlobalStorageJob writing bootLoader path:" << var;
storage->insert( "bootLoader", var );
}
else
{
cDebug() << "FillGlobalStorageJob writing empty bootLoader value";
storage->insert( "bootLoader", QVariant() );
}
return Calamares::JobResult::ok();
}
QVariantList
FillGlobalStorageJob::createPartitionList() const
{
UuidForPartitionHash hash = findPartitionUuids( m_devices );
QVariantList lst;
cDebug() << "Building partition information map";
for ( auto device : m_devices )
{
cDebug() << Logger::SubEntry << "partitions on" << device->deviceNode();
for ( auto it = PartitionIterator::begin( device ); it != PartitionIterator::end( device ); ++it )
{
// Debug-logging is done when creating the map
lst << mapForPartition( *it, hash.value( ( *it )->partitionPath() ) );
}
}
return lst;
}
QVariant
FillGlobalStorageJob::createBootLoaderMap() const
{
QVariantMap map;
QString path = m_bootLoaderPath;
if ( !path.startsWith( "/dev/" ) )
{
Partition* partition = KPMHelpers::findPartitionByMountPoint( m_devices, path );
if ( !partition )
{
return QVariant();
}
path = partition->partitionPath();
}
map[ "installPath" ] = path;
return map;
}