napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[libcalamares] Use new expander in CommandList

Browse Source 
- This switches @@ROOT@@ for ${ROOT} and uses standard macro-
  expansion mechanisms for the commands; undefined variables
  will be logged as well.
This commit is contained in:
Adriaan de Groot 2022-04-12 16:06:42 +02:00
parent 334b7fc219
commit d76dd2f8e0
1 changed files with 35 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
src/libcalamares/utils/CommandList.cpp
View File

@ -16,6 +16,7 @@
// #include "utils/CalamaresUtils.h" // #include "utils/CalamaresUtils.h"
#include "utils/CalamaresUtilsSystem.h" #include "utils/CalamaresUtilsSystem.h"
#include "utils/Logger.h" #include "utils/Logger.h"
#include "utils/StringExpander.h"
#include "utils/Variant.h" #include "utils/Variant.h"
#include <QCoreApplication> #include <QCoreApplication>
@ -109,59 +110,57 @@ CommandList::CommandList::CommandList( const QVariant& v, bool doChroot, std::ch
CommandList::~CommandList() {} CommandList::~CommandList() {}
static inline bool
findInCommands( const CommandList& l, const QString& needle )
{
for ( CommandList::const_iterator i = l.cbegin(); i != l.cend(); ++i )
if ( i->command().contains( needle ) )
{
return true;
}
return false;
}
Calamares::JobResult Calamares::JobResult
CommandList::run() CommandList::run()
{ {
QLatin1String rootMagic( "@@ROOT@@" );
QLatin1String userMagic( "@@USER@@" );
System::RunLocation location = m_doChroot ? System::RunLocation::RunInTarget : System::RunLocation::RunInHost; System::RunLocation location = m_doChroot ? System::RunLocation::RunInTarget : System::RunLocation::RunInHost;
/* Figure out the replacement for @@ROOT@@ */
QString root = QStringLiteral( "/" );
Calamares::GlobalStorage* gs = Calamares::JobQueue::instance()->globalStorage(); Calamares::GlobalStorage* gs = Calamares::JobQueue::instance()->globalStorage();
bool needsRootSubstitution = findInCommands( *this, rootMagic ); Calamares::String::DictionaryExpander expander;
if ( needsRootSubstitution && ( location == System::RunLocation::RunInHost ) )
// Figure out the replacement for ${ROOT}
if ( location == System::RunLocation::RunInTarget )
{ {
if ( !gs || !gs->contains( "rootMountPoint" ) ) expander.insert( QStringLiteral( "ROOT" ), QStringLiteral( "/" ) );
{ }
cError() << "No rootMountPoint defined."; else if ( gs && gs->contains( "rootMountPoint" ) )
return Calamares::JobResult::error( {
QCoreApplication::translate( "CommandList", "Could not run command." ), expander.insert( QStringLiteral( "ROOT" ), gs->value( "rootMountPoint" ).toString() );
QCoreApplication::translate( "CommandList",
"The command runs in the host environment and needs to know the root "
"path, but no rootMountPoint is defined." ) );
}
root = gs->value( "rootMountPoint" ).toString();
} }
bool needsUserSubstitution = findInCommands( *this, userMagic ); // Replacement for ${USER}
if ( needsUserSubstitution && ( !gs || !gs->contains( "username" ) ) ) if ( gs && gs->contains( "username" ) )
{ {
cError() << "No username defined."; expander.insert( QStringLiteral( "USER" ), gs->value( "username" ).toString() );
}
// Copy and expand the list, collecting missing variables (so don't call expand())
CommandList_t expandedList;
std::transform( cbegin(),
cend(),
std::back_inserter( expandedList ),
[ &expander ]( CommandLine c )
{
expander.expandMacros( c.first );
return c;
} );
if ( expander.hasErrors() )
{
const auto missing = expander.errorNames();
cError() << "Missing variables:" << missing;
return Calamares::JobResult::error( return Calamares::JobResult::error(
QCoreApplication::translate( "CommandList", "Could not run command." ), QCoreApplication::translate( "CommandList", "Could not run command." ),
QCoreApplication::translate( "CommandList", QCoreApplication::translate( "CommandList",
"The command needs to know the user's name, but no username is defined." ) ); "The commands use variables that are not defined. "
"Missing variables are: %1." )
.arg( missing.join( ',' ) ) );
} }
QString user = gs->value( "username" ).toString(); // may be blank if unset
for ( CommandList::const_iterator i = cbegin(); i != cend(); ++i )
for ( CommandList::const_iterator i = expandedList.cbegin(); i != expandedList.cend(); ++i )
{ {
QString processed_cmd = i->command(); QString processed_cmd = i->command();
processed_cmd.replace( rootMagic, root ).replace( userMagic, user );
bool suppress_result = false; bool suppress_result = false;
if ( processed_cmd.startsWith( '-' ) ) if ( processed_cmd.startsWith( '-' ) )
{ {