SearchPluginManager Class Reference

#include <searchpluginmanager.h>

Inheritance diagram for SearchPluginManager:

Collaboration diagram for SearchPluginManager:

Signals
void	pluginEnabled (const QString &name, bool enabled)
void	pluginInstalled (const QString &name)
void	pluginInstallationFailed (const QString &name, const QString &reason)
void	pluginUninstalled (const QString &name)
void	pluginUpdated (const QString &name)
void	pluginUpdateFailed (const QString &name, const QString &reason)
void	checkForUpdatesFinished (const QHash< QString, PluginVersion > &updateInfo)
void	checkForUpdatesFailed (const QString &reason)

Public Member Functions
	SearchPluginManager ()
	~SearchPluginManager () override
QStringList	allPlugins () const
QStringList	enabledPlugins () const
QStringList	supportedCategories () const
QStringList	getPluginCategories (const QString &pluginName) const
PluginInfo *	pluginInfo (const QString &name) const
void	enablePlugin (const QString &name, bool enabled=true)
void	updatePlugin (const QString &name)
void	installPlugin (const QString &source)
bool	uninstallPlugin (const QString &name)
void	checkForUpdates ()
SearchHandler *	startSearch (const QString &pattern, const QString &category, const QStringList &usedPlugins)
SearchDownloadHandler *	downloadTorrent (const QString &siteUrl, const QString &url)
QString	pluginFullName (const QString &pluginName)

Static Public Member Functions
static SearchPluginManager *	instance ()
static void	freeInstance ()
static void	updateIconPath (PluginInfo *const plugin)
static PluginVersion	getPluginVersion (const QString &filePath)
static QString	categoryFullName (const QString &categoryName)
static QString	pluginsLocation ()
static QString	engineLocation ()

Private Member Functions
void	update ()
void	updateNova ()
void	parseVersionInfo (const QByteArray &info)
void	installPlugin_impl (const QString &name, const QString &path)
bool	isUpdateNeeded (const QString &pluginName, PluginVersion newVersion) const
void	versionInfoDownloadFinished (const Net::DownloadResult &result)
void	pluginDownloadFinished (const Net::DownloadResult &result)

Static Private Member Functions
static QString	pluginPath (const QString &name)

Private Attributes
const QString	m_updateUrl
QHash< QString, PluginInfo * >	m_plugins

Static Private Attributes
static QPointer< SearchPluginManager >	m_instance = nullptr

Detailed Description

Definition at line 60 of file searchpluginmanager.h.

Constructor & Destructor Documentation

SearchPluginManager()

SearchPluginManager::SearchPluginManager

(

)

Definition at line 86 of file searchpluginmanager.cpp.

    : m_updateUrl(QLatin1String("http://searchplugins.qbittorrent.org/nova3/engines/"))
{
    Q_ASSERT(!m_instance); // only one instance is allowed
    m_instance = this;
 
    updateNova();
    update();
}

References m_instance, update(), and updateNova().

Referenced by instance().

Here is the call graph for this function:

Here is the caller graph for this function:

~SearchPluginManager()

SearchPluginManager::~SearchPluginManager ( )

override

Definition at line 96 of file searchpluginmanager.cpp.

{
    qDeleteAll(m_plugins);
}

References m_plugins.

Member Function Documentation

allPlugins()

QStringList SearchPluginManager::allPlugins

(

)

const

Definition at line 113 of file searchpluginmanager.cpp.

{
    return m_plugins.keys();
}

References m_plugins.

Referenced by getPluginCategories(), PluginSelectDialog::loadSupportedSearchPlugins(), SearchWidget::on_searchButton_clicked(), SearchController::pluginsAction(), and SearchController::startAction().

Here is the caller graph for this function:

categoryFullName()

QString SearchPluginManager::categoryFullName ( const QString &  categoryName )

static

Definition at line 338 of file searchpluginmanager.cpp.

{
    const QHash<QString, QString> categoryTable
    {
        {"all", tr("All categories")},
        {"movies", tr("Movies")},
        {"tv", tr("TV shows")},
        {"music", tr("Music")},
        {"games", tr("Games")},
        {"anime", tr("Anime")},
        {"software", tr("Software")},
        {"pictures", tr("Pictures")},
        {"books", tr("Books")}
    };
    return categoryTable.value(categoryName);
}

Referenced by SearchWidget::fillCatCombobox(), and anonymous_namespace{searchcontroller.cpp}::getPluginCategories().

Here is the caller graph for this function:

checkForUpdates()

void SearchPluginManager::checkForUpdates

(

)

Definition at line 317 of file searchpluginmanager.cpp.

{
    // Download version file from update server
    using namespace Net;
    DownloadManager::instance()->download({m_updateUrl + "versions.txt"}
                                          , this, &SearchPluginManager::versionInfoDownloadFinished);
}

References m_updateUrl, and versionInfoDownloadFinished().

Referenced by PluginSelectDialog::on_updateButton_clicked(), and SearchController::updatePluginsAction().

Here is the call graph for this function:

Here is the caller graph for this function:

checkForUpdatesFailed

void SearchPluginManager::checkForUpdatesFailed ( const QString &  reason )

signal

Referenced by parseVersionInfo(), PluginSelectDialog::PluginSelectDialog(), SearchController::updatePluginsAction(), and versionInfoDownloadFinished().

Here is the caller graph for this function:

checkForUpdatesFinished

void SearchPluginManager::checkForUpdatesFinished ( const QHash< QString, PluginVersion > &  updateInfo )

signal

Referenced by parseVersionInfo(), PluginSelectDialog::PluginSelectDialog(), and SearchController::updatePluginsAction().

Here is the caller graph for this function:

downloadTorrent()

SearchDownloadHandler * SearchPluginManager::downloadTorrent	(	const QString &	siteUrl,
		const QString &	url
	)

Definition at line 325 of file searchpluginmanager.cpp.

{
    return new SearchDownloadHandler {siteUrl, url, this};
}

Referenced by SearchJobWidget::downloadTorrent().

Here is the caller graph for this function:

enabledPlugins()

QStringList SearchPluginManager::enabledPlugins

(

)

const

Definition at line 118 of file searchpluginmanager.cpp.

{
    QStringList plugins;
    for (const PluginInfo *plugin : asConst(m_plugins))
    {
        if (plugin->enabled)
            plugins << plugin->name;
    }
 
    return plugins;
}

References asConst(), and m_plugins.

Referenced by getPluginCategories(), SearchWidget::on_searchButton_clicked(), and SearchController::startAction().

Here is the call graph for this function:

Here is the caller graph for this function:

enablePlugin()

void SearchPluginManager::enablePlugin	(	const QString &	name,
		bool	enabled = true
	)

Definition at line 175 of file searchpluginmanager.cpp.

{
    PluginInfo *plugin = m_plugins.value(name, nullptr);
    if (plugin)
    {
        plugin->enabled = enabled;
        // Save to Hard disk
        Preferences *const pref = Preferences::instance();
        QStringList disabledPlugins = pref->getSearchEngDisabled();
        if (enabled)
            disabledPlugins.removeAll(name);
        else if (!disabledPlugins.contains(name))
            disabledPlugins.append(name);
        pref->setSearchEngDisabled(disabledPlugins);
 
        emit pluginEnabled(name, enabled);
    }
}

References PluginInfo::enabled, Preferences::getSearchEngDisabled(), Preferences::instance(), m_plugins, pluginEnabled(), and Preferences::setSearchEngDisabled().

Referenced by SearchController::enablePluginAction(), PluginSelectDialog::enableSelection(), PluginSelectDialog::on_actionUninstall_triggered(), and PluginSelectDialog::togglePluginState().

Here is the call graph for this function:

Here is the caller graph for this function:

engineLocation()

QString SearchPluginManager::engineLocation ( )

static

Definition at line 365 of file searchpluginmanager.cpp.

{
    static QString location;
    if (location.isEmpty())
    {
        location = Utils::Fs::expandPathAbs(specialFolderLocation(SpecialFolder::Data) + "/nova3");
 
        const QDir locationDir(location);
        locationDir.mkpath(locationDir.absolutePath());
    }
 
    return location;
}

References Data, Utils::Fs::expandPathAbs(), and specialFolderLocation().

Referenced by installPlugin(), pluginsLocation(), SearchDownloadHandler::SearchDownloadHandler(), SearchHandler::SearchHandler(), uninstallPlugin(), update(), and updateNova().

Here is the call graph for this function:

Here is the caller graph for this function:

freeInstance()

void SearchPluginManager::freeInstance ( )

static

Definition at line 108 of file searchpluginmanager.cpp.

{
    delete m_instance;
}

References m_instance.

Referenced by Application::cleanup().

Here is the caller graph for this function:

getPluginCategories()

QStringList SearchPluginManager::getPluginCategories

(

const QString &

pluginName

)

const

Definition at line 148 of file searchpluginmanager.cpp.

{
    QStringList plugins;
    if (pluginName == "all")
        plugins = allPlugins();
    else if ((pluginName == "enabled") || (pluginName == "multi"))
        plugins = enabledPlugins();
    else
        plugins << pluginName.trimmed();
 
    QSet<QString> categories;
    for (const QString &name : asConst(plugins))
    {
        const PluginInfo *plugin = pluginInfo(name);
        if (!plugin) continue; // plugin wasn't found
        for (const QString &category : plugin->supportedCategories)
            categories << category;
    }
 
    return categories.values();
}

References allPlugins(), asConst(), enabledPlugins(), pluginInfo(), and PluginInfo::supportedCategories.

Here is the call graph for this function:

getPluginVersion()

PluginVersion SearchPluginManager::getPluginVersion ( const QString &  filePath )

static

Definition at line 567 of file searchpluginmanager.cpp.

{
    QFile pluginFile(filePath);
    if (!pluginFile.open(QIODevice::ReadOnly | QIODevice::Text))
        return {};
 
    while (!pluginFile.atEnd())
    {
        const QString line = QString(pluginFile.readLine()).remove(' ');
        if (!line.startsWith("#VERSION:", Qt::CaseInsensitive)) continue;
 
        const QString versionStr = line.mid(9);
        const PluginVersion version = PluginVersion::tryParse(versionStr, {});
        if (version.isValid())
            return version;
 
        LogMsg(tr("Search plugin '%1' contains invalid version string ('%2')")
            .arg(Utils::Fs::fileName(filePath), versionStr), Log::MsgType::WARNING);
        break;
    }
 
    return {};
}

References Utils::Fs::fileName(), Utils::Version< T, N, Mandatory >::isValid(), LogMsg(), Utils::Version< unsigned short, 2 >::tryParse(), and Log::WARNING.

Referenced by installPlugin_impl(), update(), and updateNova().

Here is the call graph for this function:

Here is the caller graph for this function:

installPlugin()

void SearchPluginManager::installPlugin

(

const QString &

source

)

Definition at line 201 of file searchpluginmanager.cpp.

{
    clearPythonCache(engineLocation());
 
    if (Net::DownloadManager::hasSupportedScheme(source))
    {
        using namespace Net;
        DownloadManager::instance()->download(DownloadRequest(source).saveToFile(true)
                                              , this, &SearchPluginManager::pluginDownloadFinished);
    }
    else
    {
        QString path = source;
        if (path.startsWith("file:", Qt::CaseInsensitive))
            path = QUrl(path).toLocalFile();
 
        QString pluginName = Utils::Fs::fileName(path);
        pluginName.chop(pluginName.size() - pluginName.lastIndexOf('.'));
 
        if (!path.endsWith(".py", Qt::CaseInsensitive))
            emit pluginInstallationFailed(pluginName, tr("Unknown search engine plugin file format."));
        else
            installPlugin_impl(pluginName, path);
    }
}

References anonymous_namespace{searchpluginmanager.cpp}::clearPythonCache(), engineLocation(), Utils::Fs::fileName(), Net::DownloadManager::hasSupportedScheme(), installPlugin_impl(), pluginDownloadFinished(), pluginInstallationFailed(), Utils::IO::saveToFile(), and anonymous_namespace{misc.cpp}::source.

Referenced by PluginSelectDialog::askForLocalPlugin(), PluginSelectDialog::askForPluginUrl(), PluginSelectDialog::dropEvent(), SearchController::installPluginAction(), and updatePlugin().

Here is the call graph for this function:

Here is the caller graph for this function:

installPlugin_impl()

void SearchPluginManager::installPlugin_impl ( const QString &  name, const QString &  path  )

private

Definition at line 227 of file searchpluginmanager.cpp.

{
    const PluginVersion newVersion = getPluginVersion(path);
    const PluginInfo *plugin = pluginInfo(name);
    if (plugin && !(plugin->version < newVersion))
    {
        LogMsg(tr("Plugin already at version %1, which is greater than %2").arg(plugin->version, newVersion), Log::INFO);
        emit pluginUpdateFailed(name, tr("A more recent version of this plugin is already installed."));
        return;
    }
 
    // Process with install
    const QString destPath = pluginPath(name);
    bool updated = false;
    if (QFile::exists(destPath))
    {
        // Backup in case install fails
        QFile::copy(destPath, destPath + ".bak");
        Utils::Fs::forceRemove(destPath);
        updated = true;
    }
    // Copy the plugin
    QFile::copy(path, destPath);
    // Update supported plugins
    update();
    // Check if this was correctly installed
    if (!m_plugins.contains(name))
    {
        // Remove broken file
        Utils::Fs::forceRemove(destPath);
        LogMsg(tr("Plugin %1 is not supported.").arg(name), Log::INFO);
        if (updated)
        {
            // restore backup
            QFile::copy(destPath + ".bak", destPath);
            Utils::Fs::forceRemove(destPath + ".bak");
            // Update supported plugins
            update();
            emit pluginUpdateFailed(name, tr("Plugin is not supported."));
        }
        else
        {
            emit pluginInstallationFailed(name, tr("Plugin is not supported."));
        }
    }
    else
    {
        // Install was successful, remove backup
        if (updated)
        {
            LogMsg(tr("Plugin %1 has been successfully updated.").arg(name), Log::INFO);
            Utils::Fs::forceRemove(destPath + ".bak");
        }
    }
}

References copy, Utils::Fs::forceRemove(), getPluginVersion(), Log::INFO, LogMsg(), m_plugins, pluginInfo(), pluginInstallationFailed(), pluginPath(), pluginUpdateFailed(), update(), and PluginInfo::version.

Referenced by installPlugin(), and pluginDownloadFinished().

Here is the call graph for this function:

Here is the caller graph for this function:

instance()

SearchPluginManager * SearchPluginManager::instance ( )

static

Definition at line 101 of file searchpluginmanager.cpp.

{
    if (!m_instance)
        m_instance = new SearchPluginManager;
    return m_instance;
}

References m_instance, and SearchPluginManager().

Referenced by SearchController::checkForUpdatesFinished(), SearchController::enablePluginAction(), SearchWidget::fillCatCombobox(), SearchWidget::fillPluginComboBox(), SearchController::getPluginsInfo(), SearchController::installPluginAction(), SearchWidget::on_pluginsButton_clicked(), SearchWidget::on_searchButton_clicked(), SearchController::pluginsAction(), SearchWidget::SearchWidget(), SearchWidget::selectActivePage(), SearchController::startAction(), SearchController::uninstallPluginAction(), and SearchController::updatePluginsAction().

Here is the call graph for this function:

Here is the caller graph for this function:

isUpdateNeeded()

bool SearchPluginManager::isUpdateNeeded ( const QString &  pluginName, PluginVersion  newVersion  ) const

private

Definition at line 553 of file searchpluginmanager.cpp.

{
    const PluginInfo *plugin = pluginInfo(pluginName);
    if (!plugin) return true;
 
    PluginVersion oldVersion = plugin->version;
    return (newVersion > oldVersion);
}

References pluginInfo(), and PluginInfo::version.

Referenced by parseVersionInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

parseVersionInfo()

void SearchPluginManager::parseVersionInfo ( const QByteArray &  info )

private

Definition at line 514 of file searchpluginmanager.cpp.

{
    QHash<QString, PluginVersion> updateInfo;
    int numCorrectData = 0;
 
    const QVector<QByteArray> lines = Utils::ByteArray::splitToViews(info, "\n", Qt::SkipEmptyParts);
    for (QByteArray line : lines)
    {
        line = line.trimmed();
        if (line.isEmpty()) continue;
        if (line.startsWith('#')) continue;
 
        const QVector<QByteArray> list = Utils::ByteArray::splitToViews(line, ":", Qt::SkipEmptyParts);
        if (list.size() != 2) continue;
 
        const QString pluginName = list.first().trimmed();
        const PluginVersion version = PluginVersion::tryParse(list.last().trimmed(), {});
 
        if (!version.isValid()) continue;
 
        ++numCorrectData;
        if (isUpdateNeeded(pluginName, version))
        {
            LogMsg(tr("Plugin \"%1\" is outdated, updating to version %2").arg(pluginName, version), Log::INFO);
            updateInfo[pluginName] = version;
        }
    }
 
    if (numCorrectData < lines.size())
    {
        emit checkForUpdatesFailed(tr("Incorrect update info received for %1 out of %2 plugins.")
            .arg(QString::number(lines.size() - numCorrectData), QString::number(lines.size())));
    }
    else
    {
        emit checkForUpdatesFinished(updateInfo);
    }
}

References checkForUpdatesFailed(), checkForUpdatesFinished(), Log::INFO, isUpdateNeeded(), Utils::Version< T, N, Mandatory >::isValid(), LogMsg(), Utils::ByteArray::splitToViews(), and Utils::Version< unsigned short, 2 >::tryParse().

Referenced by versionInfoDownloadFinished().

Here is the call graph for this function:

Here is the caller graph for this function:

pluginDownloadFinished()

void SearchPluginManager::pluginDownloadFinished ( const Net::DownloadResult &  result )

private

Definition at line 387 of file searchpluginmanager.cpp.

{
    if (result.status == Net::DownloadStatus::Success)
    {
        const QString filePath = Utils::Fs::toUniformPath(result.filePath);
 
        QString pluginName = Utils::Fs::fileName(result.url);
        pluginName.chop(pluginName.size() - pluginName.lastIndexOf('.')); // Remove extension
        installPlugin_impl(pluginName, filePath);
        Utils::Fs::forceRemove(filePath);
    }
    else
    {
        const QString url = result.url;
        QString pluginName = url.mid(url.lastIndexOf('/') + 1);
        pluginName.replace(".py", "", Qt::CaseInsensitive);
 
        if (pluginInfo(pluginName))
            emit pluginUpdateFailed(pluginName, tr("Failed to download the plugin file. %1").arg(result.errorString));
        else
            emit pluginInstallationFailed(pluginName, tr("Failed to download the plugin file. %1").arg(result.errorString));
    }
}

References Net::DownloadResult::errorString, Utils::Fs::fileName(), Net::DownloadResult::filePath, Utils::Fs::forceRemove(), installPlugin_impl(), pluginInfo(), pluginInstallationFailed(), pluginUpdateFailed(), Net::DownloadResult::status, Net::Success, Utils::Fs::toUniformPath(), and Net::DownloadResult::url.

Referenced by installPlugin().

Here is the call graph for this function:

Here is the caller graph for this function:

pluginEnabled

void SearchPluginManager::pluginEnabled ( const QString &  name, bool  enabled  )

signal

Referenced by enablePlugin(), and SearchWidget::SearchWidget().

Here is the caller graph for this function:

pluginFullName()

QString SearchPluginManager::pluginFullName

(

const QString &

pluginName

)

Definition at line 355 of file searchpluginmanager.cpp.

{
    return pluginInfo(pluginName) ? pluginInfo(pluginName)->fullName : QString();
}

References PluginInfo::fullName, and pluginInfo().

Here is the call graph for this function:

pluginInfo()

PluginInfo * SearchPluginManager::pluginInfo

(

const QString &

name

)

const

Definition at line 170 of file searchpluginmanager.cpp.

{
    return m_plugins.value(name);
}

References m_plugins.

Referenced by PluginSelectDialog::addNewPlugin(), PluginSelectDialog::displayContextMenu(), getPluginCategories(), SearchController::getPluginsInfo(), PluginSelectDialog::iconDownloadFinished(), installPlugin_impl(), isUpdateNeeded(), pluginDownloadFinished(), pluginFullName(), PluginSelectDialog::pluginUpdated(), and PluginSelectDialog::togglePluginState().

Here is the caller graph for this function:

pluginInstallationFailed

void SearchPluginManager::pluginInstallationFailed ( const QString &  name, const QString &  reason  )

signal

Referenced by installPlugin(), installPlugin_impl(), pluginDownloadFinished(), and PluginSelectDialog::PluginSelectDialog().

Here is the caller graph for this function:

pluginInstalled

void SearchPluginManager::pluginInstalled ( const QString &  name )

signal

Referenced by PluginSelectDialog::PluginSelectDialog(), SearchWidget::SearchWidget(), and update().

Here is the caller graph for this function:

pluginPath()

QString SearchPluginManager::pluginPath ( const QString &  name )

staticprivate

Definition at line 562 of file searchpluginmanager.cpp.

{
    return QString::fromLatin1("%1/%2.py").arg(pluginsLocation(), name);
}

References pluginsLocation().

Referenced by installPlugin_impl(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

pluginsLocation()

QString SearchPluginManager::pluginsLocation ( )

static

Definition at line 360 of file searchpluginmanager.cpp.

{
    return QString::fromLatin1("%1/engines").arg(engineLocation());
}

References engineLocation().

Referenced by PluginSelectDialog::iconDownloadFinished(), pluginPath(), uninstallPlugin(), and updateIconPath().

Here is the call graph for this function:

Here is the caller graph for this function:

pluginUninstalled

void SearchPluginManager::pluginUninstalled ( const QString &  name )

signal

Referenced by SearchWidget::SearchWidget(), and uninstallPlugin().

Here is the caller graph for this function:

pluginUpdated

void SearchPluginManager::pluginUpdated ( const QString &  name )

signal

Referenced by PluginSelectDialog::PluginSelectDialog(), SearchWidget::SearchWidget(), and update().

Here is the caller graph for this function:

pluginUpdateFailed

void SearchPluginManager::pluginUpdateFailed ( const QString &  name, const QString &  reason  )

signal

Referenced by installPlugin_impl(), pluginDownloadFinished(), and PluginSelectDialog::PluginSelectDialog().

Here is the caller graph for this function:

startSearch()

SearchHandler * SearchPluginManager::startSearch	(	const QString &	pattern,
		const QString &	category,
		const QStringList &	usedPlugins
	)

Definition at line 330 of file searchpluginmanager.cpp.

{
    // No search pattern entered
    Q_ASSERT(!pattern.isEmpty());
 
    return new SearchHandler {pattern, category, usedPlugins, this};
}

Referenced by SearchWidget::on_searchButton_clicked(), and SearchController::startAction().

Here is the caller graph for this function:

supportedCategories()

QStringList SearchPluginManager::supportedCategories

(

)

const

Definition at line 130 of file searchpluginmanager.cpp.

{
    QStringList result;
    for (const PluginInfo *plugin : asConst(m_plugins))
    {
        if (plugin->enabled)
        {
            for (const QString &cat : plugin->supportedCategories)
            {
                if (!result.contains(cat))
                    result << cat;
            }
        }
    }
 
    return result;
}

References asConst(), and m_plugins.

Here is the call graph for this function:

uninstallPlugin()

bool SearchPluginManager::uninstallPlugin

(

const QString &

name

)

Definition at line 283 of file searchpluginmanager.cpp.

{
    clearPythonCache(engineLocation());
 
    // remove it from hard drive
    const QDir pluginsFolder(pluginsLocation());
    QStringList filters;
    filters << name + ".*";
    const QStringList files = pluginsFolder.entryList(filters, QDir::Files, QDir::Unsorted);
    for (const QString &file : files)
        Utils::Fs::forceRemove(pluginsFolder.absoluteFilePath(file));
    // Remove it from supported engines
    delete m_plugins.take(name);
 
    emit pluginUninstalled(name);
    return true;
}

References anonymous_namespace{searchpluginmanager.cpp}::clearPythonCache(), engineLocation(), file(), files(), Utils::Fs::forceRemove(), m_plugins, pluginsLocation(), and pluginUninstalled().

Referenced by PluginSelectDialog::on_actionUninstall_triggered(), and SearchController::uninstallPluginAction().

Here is the call graph for this function:

Here is the caller graph for this function:

update()

void SearchPluginManager::update ( )

private

Definition at line 448 of file searchpluginmanager.cpp.

{
    QProcess nova;
    nova.setProcessEnvironment(QProcessEnvironment::systemEnvironment());
 
    const QStringList params {Utils::Fs::toNativePath(engineLocation() + "/nova2.py"), "--capabilities"};
    nova.start(Utils::ForeignApps::pythonInfo().executableName, params, QIODevice::ReadOnly);
    nova.waitForFinished();
 
    const QString capabilities = nova.readAll();
    QDomDocument xmlDoc;
    if (!xmlDoc.setContent(capabilities))
    {
        qWarning() << "Could not parse Nova search engine capabilities, msg: " << capabilities.toLocal8Bit().data();
        qWarning() << "Error: " << nova.readAllStandardError().constData();
        return;
    }
 
    const QDomElement root = xmlDoc.documentElement();
    if (root.tagName() != "capabilities")
    {
        qWarning() << "Invalid XML file for Nova search engine capabilities, msg: " << capabilities.toLocal8Bit().data();
        return;
    }
 
    for (QDomNode engineNode = root.firstChild(); !engineNode.isNull(); engineNode = engineNode.nextSibling())
    {
        const QDomElement engineElem = engineNode.toElement();
        if (!engineElem.isNull())
        {
            const QString pluginName = engineElem.tagName();
 
            auto plugin = std::make_unique<PluginInfo>();
            plugin->name = pluginName;
            plugin->version = getPluginVersion(pluginPath(pluginName));
            plugin->fullName = engineElem.elementsByTagName("name").at(0).toElement().text();
            plugin->url = engineElem.elementsByTagName("url").at(0).toElement().text();
 
            const QStringList categories = engineElem.elementsByTagName("categories").at(0).toElement().text().split(' ');
            for (QString cat : categories)
            {
                cat = cat.trimmed();
                if (!cat.isEmpty())
                    plugin->supportedCategories << cat;
            }
 
            const QStringList disabledEngines = Preferences::instance()->getSearchEngDisabled();
            plugin->enabled = !disabledEngines.contains(pluginName);
 
            updateIconPath(plugin.get());
 
            if (!m_plugins.contains(pluginName))
            {
                m_plugins[pluginName] = plugin.release();
                emit pluginInstalled(pluginName);
            }
            else if (m_plugins[pluginName]->version != plugin->version)
            {
                delete m_plugins.take(pluginName);
                m_plugins[pluginName] = plugin.release();
                emit pluginUpdated(pluginName);
            }
        }
    }
}

References engineLocation(), getPluginVersion(), Preferences::getSearchEngDisabled(), Preferences::instance(), m_plugins, pluginInstalled(), pluginPath(), pluginUpdated(), Utils::ForeignApps::pythonInfo(), Utils::Fs::toNativePath(), and updateIconPath().

Referenced by installPlugin_impl(), and SearchPluginManager().

Here is the call graph for this function:

Here is the caller graph for this function:

updateIconPath()

void SearchPluginManager::updateIconPath ( PluginInfo *const  plugin )

static

Definition at line 301 of file searchpluginmanager.cpp.

{
    if (!plugin) return;
    QString iconPath = QString::fromLatin1("%1/%2.png").arg(pluginsLocation(), plugin->name);
    if (QFile::exists(iconPath))
    {
        plugin->iconPath = iconPath;
    }
    else
    {
        iconPath = QString::fromLatin1("%1/%2.ico").arg(pluginsLocation(), plugin->name);
        if (QFile::exists(iconPath))
            plugin->iconPath = iconPath;
    }
}

References PluginInfo::iconPath, PluginInfo::name, and pluginsLocation().

Referenced by PluginSelectDialog::iconDownloadFinished(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

updateNova()

void SearchPluginManager::updateNova ( )

private

Definition at line 412 of file searchpluginmanager.cpp.

{
    // create nova directory if necessary
    const QDir searchDir(engineLocation());
 
    QFile packageFile(searchDir.absoluteFilePath("__init__.py"));
    packageFile.open(QIODevice::WriteOnly);
    packageFile.close();
 
    searchDir.mkdir("engines");
 
    QFile packageFile2(searchDir.absolutePath() + "/engines/__init__.py");
    packageFile2.open(QIODevice::WriteOnly);
    packageFile2.close();
 
    // Copy search plugin files (if necessary)
    const auto updateFile = [](const QString &filename, const bool compareVersion)
    {
        const QString filePathBundled = ":/searchengine/nova3/" + filename;
        const QString filePathDisk = QDir(engineLocation()).absoluteFilePath(filename);
 
        if (compareVersion && (getPluginVersion(filePathBundled) <= getPluginVersion(filePathDisk)))
            return;
 
        Utils::Fs::forceRemove(filePathDisk);
        QFile::copy(filePathBundled, filePathDisk);
    };
 
    updateFile("helpers.py", true);
    updateFile("nova2.py", true);
    updateFile("nova2dl.py", true);
    updateFile("novaprinter.py", true);
    updateFile("sgmllib3.py", false);
    updateFile("socks.py", false);
}

References copy, engineLocation(), Utils::Fs::forceRemove(), and getPluginVersion().

Referenced by SearchPluginManager().

Here is the call graph for this function:

Here is the caller graph for this function:

updatePlugin()

void SearchPluginManager::updatePlugin

(

const QString &

name

)

Definition at line 195 of file searchpluginmanager.cpp.

{
    installPlugin(QString::fromLatin1("%1%2.py").arg(m_updateUrl, name));
}

References installPlugin(), and m_updateUrl.

Referenced by PluginSelectDialog::checkForUpdatesFinished(), and SearchController::checkForUpdatesFinished().

Here is the call graph for this function:

Here is the caller graph for this function:

versionInfoDownloadFinished()

void SearchPluginManager::versionInfoDownloadFinished ( const Net::DownloadResult &  result )

private

Definition at line 379 of file searchpluginmanager.cpp.

{
    if (result.status == Net::DownloadStatus::Success)
        parseVersionInfo(result.data);
    else
        emit checkForUpdatesFailed(tr("Update server is temporarily unavailable. %1").arg(result.errorString));
}

References checkForUpdatesFailed(), Net::DownloadResult::data, Net::DownloadResult::errorString, parseVersionInfo(), Net::DownloadResult::status, and Net::Success.

Referenced by checkForUpdates().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_instance

QPointer< SearchPluginManager > SearchPluginManager::m_instance = nullptr

staticprivate

Definition at line 117 of file searchpluginmanager.h.

Referenced by freeInstance(), instance(), and SearchPluginManager().

m_plugins

QHash<QString, PluginInfo*> SearchPluginManager::m_plugins

private

Definition at line 121 of file searchpluginmanager.h.

Referenced by allPlugins(), enabledPlugins(), enablePlugin(), installPlugin_impl(), pluginInfo(), supportedCategories(), uninstallPlugin(), update(), and ~SearchPluginManager().

m_updateUrl

const QString SearchPluginManager::m_updateUrl

private

Definition at line 119 of file searchpluginmanager.h.

Referenced by checkForUpdates(), and updatePlugin().

---

The documentation for this class was generated from the following files:

• src/base/search/searchpluginmanager.h
• src/base/search/searchpluginmanager.cpp