mirror/tomahawk
1
0
Fork 0
mirror of https://github.com/tomahawk-player/tomahawk.git synced 2025-08-12 17:14:00 +02:00
Code Issues Releases Wiki Activity

Added required scripts loading support to QtScriptResolver.

Browse Source 
The good:
 * you can now add multiple scripts to be loaded for a single resolver before the main script, specified in metadata.json in a bundle.
The bad:
 * it adds some complexity, and it's not tested at all.
The ugly:
 * passing configuration from ResolverAccountFactory as QVariantHash, but that's not new,
 * changing ResolverFactoryFunc,
 * an added optional QStringList parameter to Pipeline::addScriptResolver,
 * the inevitable uselessness of this parameter in ScriptResolver.
This commit is contained in:
Teo Mrnjavac
2013-03-15 14:41:06 +01:00
parent caa3a35510
commit 4d2a9422a1
10 changed files with 65 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/TomahawkApp.cpp
View File

@@ -201,8 +201,8 @@ TomahawkApp::init()
m_scanManager = QPointer<ScanManager>( new ScanManager( this ) );
#ifndef ENABLE_HEADLESS
Pipeline::instance()->addExternalResolverFactory( boost::bind( &QtScriptResolver::factory, _1 ) );
Pipeline::instance()->addExternalResolverFactory( boost::bind( &ScriptResolver::factory, _1 ) );
Pipeline::instance()->addExternalResolverFactory( boost::bind( &QtScriptResolver::factory, _1, _2 ) );
Pipeline::instance()->addExternalResolverFactory( boost::bind( &ScriptResolver::factory, _1, _2 ) );
new ActionCollection( this );
connect( ActionCollection::instance()->getAction( "quit" ), SIGNAL( triggered() ), SLOT( quit() ), Qt::UniqueConnection );

4
src/libtomahawk/Pipeline.cpp
View File

@@ -137,13 +137,13 @@ Pipeline::addExternalResolverFactory( ResolverFactoryFunc resolverFactory )
Tomahawk::ExternalResolver*
Pipeline::addScriptResolver( const QString& path )
Pipeline::addScriptResolver( const QString& path, const QStringList& additionalScriptPaths )
{
ExternalResolver* res = 0;
foreach ( ResolverFactoryFunc factory, m_resolverFactories )
{
res = factory( path );
res = factory( path, additionalScriptPaths );
if ( !res )
continue;

4
src/libtomahawk/Pipeline.h
View File

@@ -36,7 +36,7 @@ namespace Tomahawk
{
class Resolver;
class ExternalResolver;
typedef boost::function<Tomahawk::ExternalResolver*(QString)> ResolverFactoryFunc;
typedef boost::function<Tomahawk::ExternalResolver*( QString, QStringList )> ResolverFactoryFunc;
class DLLEXPORT Pipeline : public QObject
{
@@ -58,7 +58,7 @@ public:
void reportArtists( QID qid, const QList< artist_ptr >& artists );
void addExternalResolverFactory( ResolverFactoryFunc resolverFactory );
Tomahawk::ExternalResolver* addScriptResolver( const QString& scriptPath );
Tomahawk::ExternalResolver* addScriptResolver( const QString& scriptPath, const QStringList& additionalScriptPaths = QStringList() );
void stopScriptResolver( const QString& scriptPath );
void removeScriptResolver( const QString& scriptPath );
QList< QPointer< ExternalResolver > > scriptResolvers() const { return m_scriptResolvers; }

2
src/libtomahawk/Typedefs.h
View File

@@ -89,7 +89,7 @@ namespace Tomahawk
};
class ExternalResolver;
typedef boost::function<Tomahawk::ExternalResolver*(QString)> ResolverFactoryFunc;
typedef boost::function<Tomahawk::ExternalResolver*( QString, QStringList )> ResolverFactoryFunc;
namespace PlaylistModes {
enum RepeatMode { NoRepeat, RepeatOne, RepeatAll };

37
src/libtomahawk/accounts/ResolverAccount.cpp
View File

@@ -63,15 +63,23 @@ Account*
ResolverAccountFactory::createFromPath( const QString& path, const QString& factory, bool isAttica )
{
qDebug() << "Creating ResolverAccount from path:" << path << "is attica" << isAttica;
const QFileInfo pathInfo( path );
if ( isAttica )
{
QFileInfo info( path );
return new AtticaResolverAccount( generateId( factory ), path, info.baseName() );
QVariantHash configuration;
QDir dir = pathInfo.absoluteDir();//assume we are in the code directory of a bundle
if ( dir.cdUp() && dir.cdUp() ) //go up twice to the content dir, if any
{
QString metadataFilePath = dir.absoluteFilePath( "metadata.json" );
configuration = metadataFromJsonFile( metadataFilePath );
}
return new AtticaResolverAccount( generateId( factory ), path, pathInfo.baseName(), configuration );
}
else //on filesystem, but it could be a bundle or a legacy resolver file
{
QString realPath( path );
const QFileInfo pathInfo( path );
QVariantHash configuration;
@@ -135,6 +143,16 @@ ResolverAccountFactory::metadataFromJsonFile( const QString& path )
QFileInfo fi( path );
result[ "path" ] = fi.absoluteDir().absoluteFilePath( manifest[ "main" ].toString() ); //this is our path to the JS
}
if ( !manifest[ "scripts" ].isNull() )
{
QStringList scripts;
foreach ( QString s, manifest[ "scripts" ].toStringList() )
{
QFileInfo fi( path );
scripts << fi.absoluteDir().absoluteFilePath( s );
}
result[ "scripts" ] = scripts;
}
}
}
//TODO: correct baseName and rename directory maybe?
@@ -161,6 +179,7 @@ ResolverAccount::ResolverAccount( const QString& accountId, const QString& path,
{
QVariantHash configuration( initialConfiguration );
configuration[ "path" ] = path;
setConfiguration( configuration );
init( path );
@@ -200,7 +219,13 @@ ResolverAccount::hookupResolver()
{
tDebug() << "Hooking up resolver:" << configuration().value( "path" ).toString() << enabled();
m_resolver = QPointer< ExternalResolverGui >( qobject_cast< ExternalResolverGui* >( Pipeline::instance()->addScriptResolver( configuration().value( "path" ).toString() ) ) );
QString mainScriptPath = configuration().value( "path" ).toString();
QStringList additionalPaths;
if ( configuration().contains( "scripts" ) )
additionalPaths = configuration().value( "scripts" ).toStringList();
Tomahawk::ExternalResolver* er = Pipeline::instance()->addScriptResolver( mainScriptPath, additionalPaths );
m_resolver = QPointer< ExternalResolverGui >( qobject_cast< ExternalResolverGui* >( er ) );
connect( m_resolver.data(), SIGNAL( changed() ), this, SLOT( resolverChanged() ) );
// What resolver do we have here? Should only be types that are 'real' resolvers
@@ -341,8 +366,8 @@ AtticaResolverAccount::AtticaResolverAccount( const QString& accountId )
}
AtticaResolverAccount::AtticaResolverAccount( const QString& accountId, const QString& path, const QString& atticaId )
: ResolverAccount( accountId, path )
AtticaResolverAccount::AtticaResolverAccount( const QString& accountId, const QString& path, const QString& atticaId, const QVariantHash& initialConfiguration )
: ResolverAccount( accountId, path, initialConfiguration )
, m_atticaId( atticaId )
{
QVariantHash conf = configuration();

2
src/libtomahawk/accounts/ResolverAccount.h
View File

@@ -133,7 +133,7 @@ private slots:
void loadIcon();
private:
// Created by factory, when user installs a new resolver
AtticaResolverAccount( const QString& accountId, const QString& path, const QString& atticaId );
AtticaResolverAccount( const QString& accountId, const QString& path, const QString& atticaId, const QVariantHash& initialConfiguration = QVariantHash() );
void init();

22
src/libtomahawk/resolvers/QtScriptResolver.cpp
View File

@@ -343,12 +343,13 @@ ScriptEngine::javaScriptConsoleMessage( const QString& message, int lineNumber,
}
QtScriptResolver::QtScriptResolver( const QString& scriptPath )
QtScriptResolver::QtScriptResolver( const QString& scriptPath, const QStringList& additionalScriptPaths )
: Tomahawk::ExternalResolverGui( scriptPath )
, m_ready( false )
, m_stopped( true )
, m_error( Tomahawk::ExternalResolver::NoError )
, m_resolverHelper( new QtScriptResolverHelper( scriptPath, this ) )
, m_requiredScriptPaths( additionalScriptPaths )
{
tLog() << Q_FUNC_INFO << "Loading JS resolver:" << scriptPath;
@@ -379,14 +380,14 @@ QtScriptResolver::~QtScriptResolver()
}
Tomahawk::ExternalResolver* QtScriptResolver::factory( const QString& scriptPath )
Tomahawk::ExternalResolver* QtScriptResolver::factory( const QString& scriptPath, const QStringList& additionalScriptPaths )
{
ExternalResolver* res = 0;
const QFileInfo fi( scriptPath );
if ( fi.suffix() == "js" || fi.suffix() == "script" )
{
res = new QtScriptResolver( scriptPath );
res = new QtScriptResolver( scriptPath, additionalScriptPaths );
tLog() << Q_FUNC_INFO << scriptPath << "Loaded.";
}
@@ -438,6 +439,21 @@ QtScriptResolver::init()
m_engine->mainFrame()->evaluateJavaScript( jslib.readAll() );
jslib.close();
// add resolver dependencies, if any
foreach ( QString s, m_requiredScriptPaths )
{
QFile reqFile( s );
if( !reqFile.open( QIODevice::ReadOnly ) )
{
qWarning() << "Failed to read contents of file:" << s << reqFile.errorString();
return;
}
const QByteArray reqContents = reqFile.readAll();
m_engine->setScriptPath( s );
m_engine->mainFrame()->evaluateJavaScript( reqContents );
}
// add resolver
m_engine->setScriptPath( filePath() );
m_engine->mainFrame()->evaluateJavaScript( scriptContents );

5
src/libtomahawk/resolvers/QtScriptResolver.h
View File

@@ -148,9 +148,9 @@ Q_OBJECT
friend class ::QtScriptResolverHelper;
public:
explicit QtScriptResolver( const QString& scriptPath );
explicit QtScriptResolver( const QString& scriptPath, const QStringList& additionalScriptPaths = QStringList() );
virtual ~QtScriptResolver();
static ExternalResolver* factory( const QString& scriptPath );
static ExternalResolver* factory( const QString& scriptPath, const QStringList& additionalScriptPaths = QStringList() );
virtual Capabilities capabilities() const { return m_capabilities; }
@@ -219,6 +219,7 @@ private:
QtScriptResolverHelper* m_resolverHelper;
QPointer< AccountConfigWidget > m_configWidget;
QList< QVariant > m_dataWidgets;
QStringList m_requiredScriptPaths;
};
#endif // QTSCRIPTRESOLVER_H

4
src/libtomahawk/resolvers/ScriptResolver.cpp
View File

@@ -96,8 +96,10 @@ ScriptResolver::~ScriptResolver()
Tomahawk::ExternalResolver*
ScriptResolver::factory( const QString& exe )
ScriptResolver::factory( const QString& exe, const QStringList& unused )
{
Q_UNUSED( unused )
ExternalResolver* res = 0;
const QFileInfo fi( exe );

2
src/libtomahawk/resolvers/ScriptResolver.h
View File

@@ -40,7 +40,7 @@ Q_OBJECT
public:
explicit ScriptResolver( const QString& exe );
virtual ~ScriptResolver();
static ExternalResolver* factory( const QString& exe );
static ExternalResolver* factory( const QString& exe, const QStringList& );
virtual QString name() const { return m_name; }
virtual QPixmap icon() const { return m_icon; }