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 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
|
/*
* ConfigCommandLinePlugin.cpp - implementation of ConfigCommandLinePlugin class
*
* Copyright (c) 2017-2019 Tobias Junghans <tobydox@veyon.io>
*
* This file is part of Veyon - http://veyon.io
*
* This program 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 2 of the License, or (at your option) any later version.
*
* This program 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 this program (see COPYING); if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*
*/
#include <QDir>
#include <QFile>
#include <QFileInfo>
#include <QJsonDocument>
#include "CommandLineIO.h"
#include "Configuration/JsonStore.h"
#include "ConfigCommandLinePlugin.h"
#include "ConfigurationManager.h"
#include "CryptoCore.h"
ConfigCommandLinePlugin::ConfigCommandLinePlugin( QObject* parent ) :
QObject( parent ),
m_commands( {
{ "clear", tr( "Clear system-wide Veyon configuration" ) },
{ "list", tr( "List all configuration keys and values" ) },
{ "import", tr( "Import configuration from given file" ) },
{ "export", tr( "Export configuration to given file" ) },
{ "get", tr( "Read and output configuration value for given key" ) },
{ "set", tr( "Write given value to given configuration key" ) },
{ "unset", tr( "Unset (remove) given configuration key" ) },
{ "upgrade", tr( "Upgrade and save configuration of program and plugins" ) },
} )
{
}
ConfigCommandLinePlugin::~ConfigCommandLinePlugin()
{
}
QStringList ConfigCommandLinePlugin::commands() const
{
return m_commands.keys();
}
QString ConfigCommandLinePlugin::commandHelp( const QString& command ) const
{
return m_commands.value( command );
}
CommandLinePluginInterface::RunResult ConfigCommandLinePlugin::handle_clear( const QStringList& arguments )
{
Q_UNUSED(arguments);
if( ConfigurationManager().clearConfiguration() )
{
return Successful;
}
return Failed;
}
CommandLinePluginInterface::RunResult ConfigCommandLinePlugin::handle_list( const QStringList& arguments )
{
Q_UNUSED(arguments);
// clear global configuration
listConfiguration( VeyonCore::config().data(), QString() );
return NoResult;
}
CommandLinePluginInterface::RunResult ConfigCommandLinePlugin::handle_import( const QStringList& arguments )
{
QString fileName = arguments.value( 0 );
if( fileName.isEmpty() || QFile( fileName ).exists() == false )
{
return operationError( tr( "Please specify an existing configuration file to import." ) );
}
if( QFileInfo( fileName ).isReadable() == false )
{
return operationError( tr( "Configuration file is not readable!" ) );
}
Configuration::JsonStore xs( Configuration::JsonStore::System, fileName );
// merge configuration
VeyonCore::config() += VeyonConfiguration( &xs );
return applyConfiguration();
}
CommandLinePluginInterface::RunResult ConfigCommandLinePlugin::handle_export( const QStringList& arguments )
{
QString fileName = arguments.value( 0 );
if( fileName.isEmpty() )
{
return operationError( tr( "Please specify a valid filename for the configuration export." ) );
}
QFileInfo fileInfo( fileName );
if( fileInfo.exists() && fileInfo.isWritable() == false )
{
return operationError( tr( "Output file is not writable!" ) );
}
if( fileInfo.exists() == false && QFileInfo( fileInfo.dir().path() ).isWritable() == false )
{
return operationError( tr( "Output directory is not writable!" ) );
}
// write current configuration to output file
Configuration::JsonStore( Configuration::JsonStore::System, fileName ).flush( &VeyonCore::config() );
return Successful;
}
CommandLinePluginInterface::RunResult ConfigCommandLinePlugin::handle_get( const QStringList& arguments )
{
QString key = arguments.value( 0 );
if( key.isEmpty() )
{
return operationError( tr( "Please specify a valid key." ) );
}
QStringList keyParts = key.split( '/' );
key = keyParts.last();
QString parentKey;
if( keyParts.size() > 1 )
{
parentKey = keyParts.mid( 0, keyParts.size()-1).join( '/' );
}
if( VeyonCore::config().hasValue( key, parentKey ) == false )
{
return operationError( tr( "Specified key does not exist in current configuration!" ) );
}
CommandLineIO::print( printableConfigurationValue( VeyonCore::config().value( key, parentKey ) ) );
return NoResult;
}
CommandLinePluginInterface::RunResult ConfigCommandLinePlugin::handle_set( const QStringList& arguments )
{
auto key = arguments.value( 0 );
auto value = arguments.value( 1 );
auto type = arguments.value( 2 );
if( key.isEmpty() )
{
return operationError( tr( "Please specify a valid key." ) );
}
if( value.isEmpty() )
{
return operationError( tr( "Please specify a valid value." ) );
}
const auto keyParts = key.split( '/' );
key = keyParts.last();
QString parentKey;
if( keyParts.size() > 1 )
{
parentKey = keyParts.mid( 0, keyParts.size()-1).join( '/' );
}
QVariant configValue = value;
if( type == QStringLiteral("json") ||
VeyonCore::config().value( key, parentKey ).userType() == QMetaType::type( "QJsonArray" ) )
{
configValue = QJsonDocument::fromJson( value.toUtf8() ).array();
}
else if( key.contains( QStringLiteral("password"), Qt::CaseInsensitive ) ||
type == QStringLiteral("password") )
{
configValue = VeyonCore::cryptoCore().encryptPassword( value );
}
VeyonCore::config().setValue( key, configValue, parentKey );
return applyConfiguration();
}
CommandLinePluginInterface::RunResult ConfigCommandLinePlugin::handle_unset( const QStringList& arguments )
{
QString key = arguments.value( 0 );
if( key.isEmpty() )
{
return operationError( tr( "Please specify a valid key." ) );
}
QStringList keyParts = key.split( '/' );
key = keyParts.last();
QString parentKey;
if( keyParts.size() > 1 )
{
parentKey = keyParts.mid( 0, keyParts.size()-1).join( '/' );
}
VeyonCore::config().removeValue( key, parentKey );
return applyConfiguration();
}
CommandLinePluginInterface::RunResult ConfigCommandLinePlugin::handle_upgrade( const QStringList& arguments )
{
Q_UNUSED(arguments);
// upgrade already happened while loading plugins so only save upgraded configuration
return applyConfiguration();
}
void ConfigCommandLinePlugin::listConfiguration( const VeyonConfiguration::DataMap &map,
const QString &parentKey )
{
for( auto it = map.begin(); it != map.end(); ++it )
{
QString curParentKey = parentKey.isEmpty() ? it.key() : parentKey + "/" + it.key();
if( it.value().type() == QVariant::Map )
{
listConfiguration( it.value().toMap(), curParentKey );
}
else
{
QString value = printableConfigurationValue( it.value() );
if( value.isNull() )
{
qWarning() << "Key" << it.key() << "has unknown value type:" << it.value();
}
else
{
QTextStream( stdout ) << curParentKey << "=" << value << endl;
}
}
}
}
CommandLinePluginInterface::RunResult ConfigCommandLinePlugin::applyConfiguration()
{
ConfigurationManager configurationManager;
if( configurationManager.saveConfiguration() == false ||
configurationManager.applyConfiguration() == false )
{
return operationError( configurationManager.errorString() );
}
return Successful;
}
QString ConfigCommandLinePlugin::printableConfigurationValue( const QVariant& value )
{
if( value.type() == QVariant::String ||
value.type() == QVariant::Uuid ||
value.type() == QVariant::UInt ||
value.type() == QVariant::Bool )
{
return value.toString();
}
else if( value.type() == QVariant::StringList )
{
QStringList list = value.toStringList();
for( auto& str : list )
{
str = "\"" + str + "\"";
}
return "(" + list.join( ',' ) + ")";
}
else if( value.userType() == QMetaType::type( "QJsonArray" ) )
{
return QString::fromUtf8( QJsonDocument( value.toJsonArray() ).toJson( QJsonDocument::Compact ) );
}
return QString();
}
CommandLinePluginInterface::RunResult ConfigCommandLinePlugin::operationError( const QString& message )
{
CommandLineIO::error( message );
return Failed;
}
|