1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
|
/*
SPDX-FileCopyrightText: 2007 Hamish Rodda <rodda@kde.org>
SPDX-FileCopyrightText: 2009 Niko Sams <niko.sams@gmail.com>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#include "executescriptplugin.h"
#include <KConfigGroup>
#include <KLocalizedString>
#include <KPluginFactory>
#include <KShell>
#include <interfaces/icore.h>
#include <interfaces/iruncontroller.h>
#include <interfaces/ilaunchconfiguration.h>
#include "scriptappconfig.h"
#include "debug.h"
#include <project/projectmodel.h>
#include <util/kdevstringhandler.h>
using namespace KDevelop;
K_PLUGIN_FACTORY_WITH_JSON(KDevExecuteFactory, "kdevexecutescript.json", registerPlugin<ExecuteScriptPlugin>();)
ExecuteScriptPlugin::ExecuteScriptPlugin(QObject* parent, const KPluginMetaData& metaData, const QVariantList&)
: KDevelop::IPlugin(QStringLiteral("kdevexecutescript"), parent, metaData)
{
m_configType = new ScriptAppConfigType();
m_configType->addLauncher( new ScriptAppLauncher( this ) );
qCDebug(PLUGIN_EXECUTESCRIPT) << "adding script launch config";
core()->runController()->addConfigurationType( m_configType );
}
ExecuteScriptPlugin::~ExecuteScriptPlugin()
{
}
void ExecuteScriptPlugin::unload()
{
core()->runController()->removeConfigurationType( m_configType );
delete m_configType;
m_configType = nullptr;
}
QUrl ExecuteScriptPlugin::script( KDevelop::ILaunchConfiguration* cfg, QString& err_ ) const
{
QUrl script;
if( !cfg )
{
return script;
}
KConfigGroup grp = cfg->config();
script = grp.readEntry( ExecuteScriptPlugin::executableEntry, QUrl() );
if( !script.isLocalFile() || script.isEmpty() )
{
err_ = i18n("No valid executable specified");
qCWarning(PLUGIN_EXECUTESCRIPT) << "Launch Configuration:" << cfg->name() << "no valid script set";
} else
{
KShell::Errors err;
if( KShell::splitArgs( script.toLocalFile(), KShell::TildeExpand | KShell::AbortOnMeta, &err ).isEmpty() || err != KShell::NoError )
{
script = QUrl();
if( err == KShell::BadQuoting )
{
err_ = i18n("There is a quoting error in the script "
"for the launch configuration '%1'. "
"Aborting start.", cfg->name() );
} else
{
err_ = i18n("A shell meta character was included in the "
"script for the launch configuration '%1', "
"this is not supported currently. Aborting start.", cfg->name() );
}
qCWarning(PLUGIN_EXECUTESCRIPT) << "Launch Configuration:" << cfg->name() << "script has meta characters";
}
}
return script;
}
QString ExecuteScriptPlugin::remoteHost(ILaunchConfiguration* cfg, QString& err) const
{
if (!cfg) return QString();
KConfigGroup grp = cfg->config();
if(grp.readEntry(ExecuteScriptPlugin::executeOnRemoteHostEntry, false)) {
QString host = grp.readEntry(ExecuteScriptPlugin::remoteHostEntry, "");
if (host.isEmpty()) {
err = i18n("No remote host set for launch configuration '%1'. "
"Aborting start.", cfg->name() );
qCWarning(PLUGIN_EXECUTESCRIPT) << "Launch Configuration:" << cfg->name() << "no remote host set";
}
return host;
}
return QString();
}
QStringList ExecuteScriptPlugin::arguments( KDevelop::ILaunchConfiguration* cfg, QString& err_ ) const
{
if( !cfg )
{
return QStringList();
}
KShell::Errors err;
QStringList args = KShell::splitArgs( cfg->config().readEntry( ExecuteScriptPlugin::argumentsEntry, "" ), KShell::TildeExpand | KShell::AbortOnMeta, &err );
if( err != KShell::NoError )
{
if( err == KShell::BadQuoting )
{
err_ = i18n("There is a quoting error in the arguments for "
"the launch configuration '%1'. Aborting start.", cfg->name() );
} else
{
err_ = i18n("A shell meta character was included in the "
"arguments for the launch configuration '%1', "
"this is not supported currently. Aborting start.", cfg->name() );
}
args = QStringList();
qCWarning(PLUGIN_EXECUTESCRIPT) << "Launch Configuration:" << cfg->name() << "arguments have meta characters";
}
return args;
}
QString ExecuteScriptPlugin::environmentProfileName(KDevelop::ILaunchConfiguration* cfg) const
{
if( !cfg )
{
return QString();
}
return cfg->config().readEntry(ExecuteScriptPlugin::environmentProfileEntry, QString());
}
int ExecuteScriptPlugin::outputFilterModeId( KDevelop::ILaunchConfiguration* cfg ) const
{
if( !cfg )
{
return 0;
}
return cfg->config().readEntry( ExecuteScriptPlugin::outputFilteringEntry, 0 );
}
bool ExecuteScriptPlugin::runCurrentFile(ILaunchConfiguration* cfg) const
{
if( !cfg )
{
return false;
}
return cfg->config().readEntry( ExecuteScriptPlugin::runCurrentFileEntry, true );
}
QString ExecuteScriptPlugin::interpreter( KDevelop::ILaunchConfiguration* cfg, QString& err ) const
{
QString interpreter;
if( !cfg )
{
return interpreter;
}
KConfigGroup grp = cfg->config();
interpreter = grp.readEntry( ExecuteScriptPlugin::interpreterEntry, QString() );
if( interpreter.isEmpty() )
{
err = i18n("No valid interpreter specified");
qCWarning(PLUGIN_EXECUTESCRIPT) << "Launch Configuration:" << cfg->name() << "no valid interpreter set";
} else
{
KShell::Errors err_;
if( KShell::splitArgs( interpreter, KShell::TildeExpand | KShell::AbortOnMeta, &err_ ).isEmpty() || err_ != KShell::NoError )
{
interpreter.clear();
if( err_ == KShell::BadQuoting )
{
err = i18n("There is a quoting error in the interpreter "
"for the launch configuration '%1'. "
"Aborting start.", cfg->name() );
} else
{
err = i18n("A shell meta character was included in the "
"interpreter for the launch configuration '%1', "
"this is not supported currently. Aborting start.", cfg->name() );
}
qCWarning(PLUGIN_EXECUTESCRIPT) << "Launch Configuration:" << cfg->name() << "interpreter has meta characters";
}
}
return interpreter;
}
QUrl ExecuteScriptPlugin::workingDirectory( KDevelop::ILaunchConfiguration* cfg ) const
{
if( !cfg )
{
return QUrl();
}
return cfg->config().readEntry( ExecuteScriptPlugin::workingDirEntry, QUrl() );
}
QString ExecuteScriptPlugin::scriptAppConfigTypeId() const
{
return ScriptAppConfigType::sharedId();
}
#include "executescriptplugin.moc"
#include "moc_executescriptplugin.cpp"
|