Application Class Reference

#include <application.h>

Inheritance diagram for Application:

Collaboration diagram for Application:

Public Member Functions
	Application (int &argc, char **argv)
	~Application () override
bool	isRunning ()
int	exec (const QStringList &params)
bool	sendParams (const QStringList &params)
QPointer< MainWindow >	mainWindow ()
const QBtCommandLineParameters &	commandLineArgs () const
bool	isFileLoggerEnabled () const
void	setFileLoggerEnabled (bool value)
QString	fileLoggerPath () const
void	setFileLoggerPath (const QString &path)
bool	isFileLoggerBackup () const
void	setFileLoggerBackup (bool value)
bool	isFileLoggerDeleteOld () const
void	setFileLoggerDeleteOld (bool value)
int	fileLoggerMaxSize () const
void	setFileLoggerMaxSize (int bytes)
int	fileLoggerAge () const
void	setFileLoggerAge (int value)
int	fileLoggerAgeType () const
void	setFileLoggerAgeType (int value)

Private Slots
void	processMessage (const QString &message)
void	torrentFinished (BitTorrent::Torrent *const torrent)
void	allTorrentsFinished ()
void	cleanup ()

Private Member Functions
void	initializeTranslation ()
void	processParams (const QStringList &params)
void	runExternalProgram (const BitTorrent::Torrent *torrent) const
void	sendNotificationEmail (const BitTorrent::Torrent *torrent)

Private Attributes
ApplicationInstanceManager *	m_instanceManager = nullptr
bool	m_running
ShutdownDialogAction	m_shutdownAct
QBtCommandLineParameters	m_commandLineArgs
QPointer< MainWindow >	m_window
WebUI *	m_webui = nullptr
QPointer< FileLogger >	m_fileLogger
QTranslator	m_qtTranslator
QTranslator	m_translator
QStringList	m_paramsQueue
SettingValue< bool >	m_storeFileLoggerEnabled
SettingValue< bool >	m_storeFileLoggerBackup
SettingValue< bool >	m_storeFileLoggerDeleteOld
SettingValue< int >	m_storeFileLoggerMaxSize
SettingValue< int >	m_storeFileLoggerAge
SettingValue< int >	m_storeFileLoggerAgeType
SettingValue< QString >	m_storeFileLoggerPath

Detailed Description

Definition at line 72 of file application.h.

Constructor & Destructor Documentation

Application()

Application::Application	(	int &	argc,
		char **	argv
	)

Definition at line 119 of file application.cpp.

    : BaseApplication(argc, argv)
    , m_running(false)
    , m_shutdownAct(ShutdownDialogAction::Exit)
    , m_commandLineArgs(parseCommandLine(this->arguments()))
    , m_storeFileLoggerEnabled(FILELOGGER_SETTINGS_KEY("Enabled"))
    , m_storeFileLoggerBackup(FILELOGGER_SETTINGS_KEY("Backup"))
    , m_storeFileLoggerDeleteOld(FILELOGGER_SETTINGS_KEY("DeleteOld"))
    , m_storeFileLoggerMaxSize(FILELOGGER_SETTINGS_KEY("MaxSizeBytes"))
    , m_storeFileLoggerAge(FILELOGGER_SETTINGS_KEY("Age"))
    , m_storeFileLoggerAgeType(FILELOGGER_SETTINGS_KEY("AgeType"))
    , m_storeFileLoggerPath(FILELOGGER_SETTINGS_KEY("Path"))
{
    qRegisterMetaType<Log::Msg>("Log::Msg");
    qRegisterMetaType<Log::Peer>("Log::Peer");
 
    setApplicationName("qBittorrent");
    setOrganizationDomain("qbittorrent.org");
#if !defined(DISABLE_GUI)
    setDesktopFileName("org.qbittorrent.qBittorrent");
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
    setAttribute(Qt::AA_UseHighDpiPixmaps, true);  // opt-in to the high DPI pixmap support
#endif
    setQuitOnLastWindowClosed(false);
    QPixmapCache::setCacheLimit(PIXMAP_CACHE_SIZE);
#endif
 
    const bool portableModeEnabled = m_commandLineArgs.profileDir.isEmpty()
            && QDir(QCoreApplication::applicationDirPath()).exists(DEFAULT_PORTABLE_MODE_PROFILE_DIR);
 
    const QString profileDir = portableModeEnabled
        ? QDir(QCoreApplication::applicationDirPath()).absoluteFilePath(DEFAULT_PORTABLE_MODE_PROFILE_DIR)
        : m_commandLineArgs.profileDir;
    Profile::initInstance(profileDir, m_commandLineArgs.configurationName,
                        (m_commandLineArgs.relativeFastresumePaths || portableModeEnabled));
 
    m_instanceManager = new ApplicationInstanceManager {Profile::instance()->location(SpecialFolder::Config), this};
 
    Logger::initInstance();
    SettingsStorage::initInstance();
    Preferences::initInstance();
 
    initializeTranslation();
 
    if (m_commandLineArgs.webUiPort > 0) // it will be -1 when user did not set any value
        Preferences::instance()->setWebUiPort(m_commandLineArgs.webUiPort);
 
    connect(this, &QCoreApplication::aboutToQuit, this, &Application::cleanup);
    connect(m_instanceManager, &ApplicationInstanceManager::messageReceived, this, &Application::processMessage);
#if defined(Q_OS_WIN) && !defined(DISABLE_GUI)
    connect(this, &QGuiApplication::commitDataRequest, this, &Application::shutdownCleanup, Qt::DirectConnection);
#endif
 
    if (isFileLoggerEnabled())
        m_fileLogger = new FileLogger(fileLoggerPath(), isFileLoggerBackup(), fileLoggerMaxSize(), isFileLoggerDeleteOld(), fileLoggerAge(), static_cast<FileLogger::FileLogAgeType>(fileLoggerAgeType()));
 
    Logger::instance()->addMessage(tr("qBittorrent %1 started", "qBittorrent v3.2.0alpha started").arg(QBT_VERSION));
    if (portableModeEnabled)
    {
        Logger::instance()->addMessage(tr("Running in portable mode. Auto detected profile folder at: %1").arg(profileDir));
        if (m_commandLineArgs.relativeFastresumePaths)
            Logger::instance()->addMessage(tr("Redundant command line flag detected: \"%1\". Portable mode implies relative fastresume.").arg("--relative-fastresume"), Log::WARNING); // to avoid translating the `--relative-fastresume` string
    }
    else
    {
        Logger::instance()->addMessage(tr("Using config directory: %1").arg(Profile::instance()->location(SpecialFolder::Config)));
    }
}

References Logger::addMessage(), cleanup(), Config, QBtCommandLineParameters::configurationName, anonymous_namespace{application.cpp}::DEFAULT_PORTABLE_MODE_PROFILE_DIR, Exit, fileLoggerAge(), fileLoggerAgeType(), fileLoggerMaxSize(), fileLoggerPath(), initializeTranslation(), Logger::initInstance(), Preferences::initInstance(), SettingsStorage::initInstance(), Profile::initInstance(), Logger::instance(), Preferences::instance(), Profile::instance(), isFileLoggerBackup(), isFileLoggerDeleteOld(), isFileLoggerEnabled(), Profile::location(), m_commandLineArgs, m_fileLogger, m_instanceManager, ApplicationInstanceManager::messageReceived(), anonymous_namespace{application.cpp}::PIXMAP_CACHE_SIZE, processMessage(), QBtCommandLineParameters::profileDir, QBtCommandLineParameters::relativeFastresumePaths, Preferences::setWebUiPort(), Log::WARNING, and QBtCommandLineParameters::webUiPort.

Here is the call graph for this function:

~Application()

Application::~Application ( )

override

Definition at line 188 of file application.cpp.

{
    // we still need to call cleanup()
    // in case the App failed to start
    cleanup();
}

References cleanup().

Here is the call graph for this function:

Member Function Documentation

allTorrentsFinished

void Application::allTorrentsFinished ( )

privateslot

Definition at line 472 of file application.cpp.

{
    Preferences *const pref = Preferences::instance();
    bool isExit = pref->shutdownqBTWhenDownloadsComplete();
    bool isShutdown = pref->shutdownWhenDownloadsComplete();
    bool isSuspend = pref->suspendWhenDownloadsComplete();
    bool isHibernate = pref->hibernateWhenDownloadsComplete();
 
    bool haveAction = isExit || isShutdown || isSuspend || isHibernate;
    if (!haveAction) return;
 
    ShutdownDialogAction action = ShutdownDialogAction::Exit;
    if (isSuspend)
        action = ShutdownDialogAction::Suspend;
    else if (isHibernate)
        action = ShutdownDialogAction::Hibernate;
    else if (isShutdown)
        action = ShutdownDialogAction::Shutdown;
 
#ifndef DISABLE_GUI
    // ask confirm
    if ((action == ShutdownDialogAction::Exit) && (pref->dontConfirmAutoExit()))
    {
        // do nothing & skip confirm
    }
    else
    {
        if (!ShutdownConfirmDialog::askForConfirmation(m_window, action)) return;
    }
#endif // DISABLE_GUI
 
    // Actually shut down
    if (action != ShutdownDialogAction::Exit)
    {
        qDebug("Preparing for auto-shutdown because all downloads are complete!");
        // Disabling it for next time
        pref->setShutdownWhenDownloadsComplete(false);
        pref->setSuspendWhenDownloadsComplete(false);
        pref->setHibernateWhenDownloadsComplete(false);
        // Make sure preferences are synced before exiting
        m_shutdownAct = action;
    }
 
    qDebug("Exiting the application");
    exit();
}

References tstool::action, ShutdownConfirmDialog::askForConfirmation(), Preferences::dontConfirmAutoExit(), Exit, Hibernate, Preferences::hibernateWhenDownloadsComplete(), Preferences::instance(), m_shutdownAct, m_window, Preferences::setHibernateWhenDownloadsComplete(), Preferences::setShutdownWhenDownloadsComplete(), Preferences::setSuspendWhenDownloadsComplete(), Shutdown, Preferences::shutdownqBTWhenDownloadsComplete(), Preferences::shutdownWhenDownloadsComplete(), Suspend, and Preferences::suspendWhenDownloadsComplete().

Referenced by exec().

Here is the call graph for this function:

Here is the caller graph for this function:

cleanup

void Application::cleanup ( )

privateslot

Definition at line 774 of file application.cpp.

{
    // cleanup() can be called multiple times during shutdown. We only need it once.
    static QAtomicInt alreadyDone;
    if (!alreadyDone.testAndSetAcquire(0, 1))
        return;
 
#ifndef DISABLE_GUI
    if (m_window)
    {
        // Hide the window and don't leave it on screen as
        // unresponsive. Also for Windows take the WinId
        // after it's hidden, because hide() may cause a
        // WinId change.
        m_window->hide();
 
#ifdef Q_OS_WIN
        ::ShutdownBlockReasonCreate(reinterpret_cast<HWND>(m_window->effectiveWinId())
            , tr("Saving torrent progress...").toStdWString().c_str());
#endif // Q_OS_WIN
 
        // Do manual cleanup in MainWindow to force widgets
        // to save their Preferences, stop all timers and
        // delete as many widgets as possible to leave only
        // a 'shell' MainWindow.
        // We need a valid window handle for Windows Vista+
        // otherwise the system shutdown will continue even
        // though we created a ShutdownBlockReason
        m_window->cleanup();
    }
#endif // DISABLE_GUI
 
#ifndef DISABLE_WEBUI
    delete m_webui;
#endif
 
    delete RSS::AutoDownloader::instance();
    delete RSS::Session::instance();
 
    TorrentFilesWatcher::freeInstance();
    BitTorrent::Session::freeInstance();
    Net::GeoIPManager::freeInstance();
    Net::DownloadManager::freeInstance();
    Net::ProxyConfigurationManager::freeInstance();
    Preferences::freeInstance();
    SettingsStorage::freeInstance();
    delete m_fileLogger;
    Logger::freeInstance();
    IconProvider::freeInstance();
    SearchPluginManager::freeInstance();
    Utils::Fs::removeDirRecursive(Utils::Fs::tempPath());
 
#ifndef DISABLE_GUI
    if (m_window)
    {
#ifdef Q_OS_WIN
        ::ShutdownBlockReasonDestroy(reinterpret_cast<HWND>(m_window->effectiveWinId()));
#endif // Q_OS_WIN
        delete m_window;
        UIThemeManager::freeInstance();
    }
#endif // DISABLE_GUI
 
    Profile::freeInstance();
 
    if (m_shutdownAct != ShutdownDialogAction::Exit)
    {
        qDebug() << "Sending computer shutdown/suspend/hibernate signal...";
        Utils::Misc::shutdownComputer(m_shutdownAct);
    }
}

References Exit, BitTorrent::Session::freeInstance(), IconProvider::freeInstance(), Logger::freeInstance(), Net::DownloadManager::freeInstance(), Net::GeoIPManager::freeInstance(), Net::ProxyConfigurationManager::freeInstance(), Preferences::freeInstance(), Profile::freeInstance(), SearchPluginManager::freeInstance(), SettingsStorage::freeInstance(), TorrentFilesWatcher::freeInstance(), UIThemeManager::freeInstance(), RSS::AutoDownloader::instance(), RSS::Session::instance(), m_fileLogger, m_shutdownAct, m_webui, m_window, Utils::Fs::removeDirRecursive(), Utils::Misc::shutdownComputer(), and Utils::Fs::tempPath().

Referenced by Application(), and ~Application().

Here is the call graph for this function:

Here is the caller graph for this function:

commandLineArgs()

const QBtCommandLineParameters & Application::commandLineArgs

(

)

const

Definition at line 202 of file application.cpp.

{
    return m_commandLineArgs;
}

References m_commandLineArgs.

exec()

int Application::exec

(

const QStringList &

params

)

Definition at line 603 of file application.cpp.

{
    Net::ProxyConfigurationManager::initInstance();
    Net::DownloadManager::initInstance();
    IconProvider::initInstance();
 
    try
    {
        BitTorrent::Session::initInstance();
        connect(BitTorrent::Session::instance(), &BitTorrent::Session::torrentFinished, this, &Application::torrentFinished);
        connect(BitTorrent::Session::instance(), &BitTorrent::Session::allTorrentsFinished, this, &Application::allTorrentsFinished, Qt::QueuedConnection);
 
        Net::GeoIPManager::initInstance();
        TorrentFilesWatcher::initInstance();
 
#ifndef DISABLE_WEBUI
        m_webui = new WebUI;
#ifdef DISABLE_GUI
        if (m_webui->isErrored())
            return 1;
        connect(m_webui, &WebUI::fatalError, this, []() { QCoreApplication::exit(1); });
#endif // DISABLE_GUI
#endif // DISABLE_WEBUI
 
        new RSS::Session; // create RSS::Session singleton
        new RSS::AutoDownloader; // create RSS::AutoDownloader singleton
    }
    catch (const RuntimeError &err)
    {
#ifdef DISABLE_GUI
        fprintf(stderr, "%s", qPrintable(err.message()));
#else
        QMessageBox msgBox;
        msgBox.setIcon(QMessageBox::Critical);
        msgBox.setText(tr("Application failed to start."));
        msgBox.setInformativeText(err.message());
        msgBox.show(); // Need to be shown or to moveToCenter does not work
        msgBox.move(Utils::Gui::screenCenter(&msgBox));
        msgBox.exec();
#endif
        return 1;
    }
 
#ifdef DISABLE_GUI
#ifndef DISABLE_WEBUI
    const Preferences *pref = Preferences::instance();
 
    const auto scheme = QString::fromLatin1(pref->isWebUiHttpsEnabled() ? "https" : "http");
    const auto url = QString::fromLatin1("%1://localhost:%2\n").arg(scheme, QString::number(pref->getWebUiPort()));
    const QString mesg = QString::fromLatin1("\n******** %1 ********\n").arg(tr("Information"))
        + tr("To control qBittorrent, access the WebUI at: %1").arg(url);
    printf("%s\n", qUtf8Printable(mesg));
 
    if (pref->getWebUIPassword() == "ARQ77eY1NUZaQsuDHbIMCA==:0WMRkYTUWVT9wVvdDtHAjU9b3b7uB8NR1Gur2hmQCvCDpm39Q+PsJRJPaCU51dEiz+dTzh8qbPsL8WkFljQYFQ==")
    {
        const QString warning = tr("The Web UI administrator username is: %1").arg(pref->getWebUiUsername()) + '\n'
            + tr("The Web UI administrator password has not been changed from the default: %1").arg("adminadmin") + '\n'
            + tr("This is a security risk, please change your password in program preferences.") + '\n';
        printf("%s", qUtf8Printable(warning));
    }
#endif // DISABLE_WEBUI
#else
    UIThemeManager::initInstance();
    m_window = new MainWindow;
#endif // DISABLE_GUI
 
    m_running = true;
 
    // Now UI is ready to process signals from Session
    BitTorrent::Session::instance()->startUpTorrents();
 
    m_paramsQueue = params + m_paramsQueue;
    if (!m_paramsQueue.isEmpty())
    {
        processParams(m_paramsQueue);
        m_paramsQueue.clear();
    }
    return BaseApplication::exec();
}

References allTorrentsFinished(), BitTorrent::Session::allTorrentsFinished(), WebUI::fatalError(), Preferences::getWebUIPassword(), Preferences::getWebUiPort(), Preferences::getWebUiUsername(), BitTorrent::Session::initInstance(), IconProvider::initInstance(), Net::DownloadManager::initInstance(), Net::GeoIPManager::initInstance(), Net::ProxyConfigurationManager::initInstance(), TorrentFilesWatcher::initInstance(), UIThemeManager::initInstance(), BitTorrent::Session::instance(), Preferences::instance(), WebUI::isErrored(), Preferences::isWebUiHttpsEnabled(), m_paramsQueue, m_running, m_webui, m_window, Exception::message(), processParams(), Utils::Gui::screenCenter(), BitTorrent::Session::startUpTorrents(), torrentFinished(), and BitTorrent::Session::torrentFinished().

Here is the call graph for this function:

fileLoggerAge()

int Application::fileLoggerAge

(

)

const

Definition at line 271 of file application.cpp.

{
    const int val = m_storeFileLoggerAge.get(1);
    return std::min(std::max(val, 1), 365);
}

References SettingValue< T >::get(), and m_storeFileLoggerAge.

Referenced by Application(), OptionsDialog::loadOptions(), setFileLoggerDeleteOld(), and setFileLoggerEnabled().

Here is the call graph for this function:

Here is the caller graph for this function:

fileLoggerAgeType()

int Application::fileLoggerAgeType

(

)

const

Definition at line 282 of file application.cpp.

{
    const int val = m_storeFileLoggerAgeType.get(1);
    return ((val < 0) || (val > 2)) ? 1 : val;
}

References SettingValue< T >::get(), and m_storeFileLoggerAgeType.

Referenced by Application(), OptionsDialog::loadOptions(), setFileLoggerDeleteOld(), and setFileLoggerEnabled().

Here is the call graph for this function:

Here is the caller graph for this function:

fileLoggerMaxSize()

int Application::fileLoggerMaxSize

(

)

const

Definition at line 257 of file application.cpp.

{
    const int val = m_storeFileLoggerMaxSize.get(DEFAULT_FILELOG_SIZE);
    return std::min(std::max(val, MIN_FILELOG_SIZE), MAX_FILELOG_SIZE);
}

References anonymous_namespace{application.cpp}::DEFAULT_FILELOG_SIZE, SettingValue< T >::get(), m_storeFileLoggerMaxSize, anonymous_namespace{application.cpp}::MAX_FILELOG_SIZE, and anonymous_namespace{application.cpp}::MIN_FILELOG_SIZE.

Referenced by Application(), OptionsDialog::loadOptions(), and setFileLoggerEnabled().

Here is the call graph for this function:

Here is the caller graph for this function:

fileLoggerPath()

QString Application::fileLoggerPath

(

)

const

Definition at line 221 of file application.cpp.

{
    return m_storeFileLoggerPath.get(QDir(specialFolderLocation(SpecialFolder::Data)).absoluteFilePath(LOG_FOLDER));
}

References Data, SettingValue< T >::get(), anonymous_namespace{application.cpp}::LOG_FOLDER, m_storeFileLoggerPath, and specialFolderLocation().

Referenced by Application(), OptionsDialog::loadOptions(), and setFileLoggerEnabled().

Here is the call graph for this function:

Here is the caller graph for this function:

initializeTranslation()

void Application::initializeTranslation ( )

private

Definition at line 713 of file application.cpp.

{
    Preferences *const pref = Preferences::instance();
    // Load translation
    const QString localeStr = pref->getLocale();
 
    if (m_qtTranslator.load(QLatin1String("qtbase_") + localeStr, QLibraryInfo::location(QLibraryInfo::TranslationsPath)) ||
        m_qtTranslator.load(QLatin1String("qt_") + localeStr, QLibraryInfo::location(QLibraryInfo::TranslationsPath)))
            qDebug("Qt %s locale recognized, using translation.", qUtf8Printable(localeStr));
    else
        qDebug("Qt %s locale unrecognized, using default (en).", qUtf8Printable(localeStr));
 
    installTranslator(&m_qtTranslator);
 
    if (m_translator.load(QLatin1String(":/lang/qbittorrent_") + localeStr))
        qDebug("%s locale recognized, using translation.", qUtf8Printable(localeStr));
    else
        qDebug("%s locale unrecognized, using default (en).", qUtf8Printable(localeStr));
    installTranslator(&m_translator);
 
#ifndef DISABLE_GUI
    if (localeStr.startsWith("ar") || localeStr.startsWith("he"))
    {
        qDebug("Right to Left mode");
        setLayoutDirection(Qt::RightToLeft);
    }
    else
    {
        setLayoutDirection(Qt::LeftToRight);
    }
#endif
}

References Preferences::getLocale(), Preferences::instance(), m_qtTranslator, and m_translator.

Referenced by Application().

Here is the call graph for this function:

Here is the caller graph for this function:

isFileLoggerBackup()

bool Application::isFileLoggerBackup

(

)

const

Definition at line 233 of file application.cpp.

{
    return m_storeFileLoggerBackup.get(true);
}

References SettingValue< T >::get(), and m_storeFileLoggerBackup.

Referenced by Application(), OptionsDialog::loadOptions(), and setFileLoggerEnabled().

Here is the call graph for this function:

Here is the caller graph for this function:

isFileLoggerDeleteOld()

bool Application::isFileLoggerDeleteOld

(

)

const

Definition at line 245 of file application.cpp.

{
    return m_storeFileLoggerDeleteOld.get(true);
}

References SettingValue< T >::get(), and m_storeFileLoggerDeleteOld.

Referenced by Application(), OptionsDialog::loadOptions(), and setFileLoggerEnabled().

Here is the call graph for this function:

Here is the caller graph for this function:

isFileLoggerEnabled()

bool Application::isFileLoggerEnabled

(

)

const

Definition at line 207 of file application.cpp.

{
    return m_storeFileLoggerEnabled.get(true);
}

References SettingValue< T >::get(), and m_storeFileLoggerEnabled.

Referenced by Application(), and OptionsDialog::loadOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

isRunning()

bool Application::isRunning

(

)

Definition at line 683 of file application.cpp.

{
    return !m_instanceManager->isFirstInstance();
}

References ApplicationInstanceManager::isFirstInstance(), and m_instanceManager.

Here is the call graph for this function:

mainWindow()

QPointer< MainWindow > Application::mainWindow

(

)

Definition at line 196 of file application.cpp.

{
    return m_window;
}

References m_window.

processMessage

void Application::processMessage ( const QString &  message )

privateslot

Definition at line 293 of file application.cpp.

{
    const QStringList params = message.split(PARAMS_SEPARATOR, Qt::SkipEmptyParts);
    // If Application is not running (i.e., other
    // components are not ready) store params
    if (m_running)
        processParams(params);
    else
        m_paramsQueue.append(params);
}

References m_paramsQueue, m_running, anonymous_namespace{application.cpp}::PARAMS_SEPARATOR, and processParams().

Referenced by Application().

Here is the call graph for this function:

Here is the caller graph for this function:

processParams()

void Application::processParams ( const QStringList &  params )

private

Definition at line 528 of file application.cpp.

{
#ifndef DISABLE_GUI
    if (params.isEmpty())
    {
        m_window->activate(); // show UI
        return;
    }
#endif
    BitTorrent::AddTorrentParams torrentParams;
    std::optional<bool> skipTorrentDialog;
 
    for (QString param : params)
    {
        param = param.trimmed();
 
        // Process strings indicating options specified by the user.
 
        if (param.startsWith(QLatin1String("@savePath=")))
        {
            torrentParams.savePath = param.mid(10);
            continue;
        }
 
        if (param.startsWith(QLatin1String("@addPaused=")))
        {
            torrentParams.addPaused = (QStringView(param).mid(11).toInt() != 0);
            continue;
        }
 
        if (param == QLatin1String("@skipChecking"))
        {
            torrentParams.skipChecking = true;
            continue;
        }
 
        if (param.startsWith(QLatin1String("@category=")))
        {
            torrentParams.category = param.mid(10);
            continue;
        }
 
        if (param == QLatin1String("@sequential"))
        {
            torrentParams.sequential = true;
            continue;
        }
 
        if (param == QLatin1String("@firstLastPiecePriority"))
        {
            torrentParams.firstLastPiecePriority = true;
            continue;
        }
 
        if (param.startsWith(QLatin1String("@skipDialog=")))
        {
            skipTorrentDialog = (QStringView(param).mid(12).toInt() != 0);
            continue;
        }
 
#ifndef DISABLE_GUI
        // There are two circumstances in which we want to show the torrent
        // dialog. One is when the application settings specify that it should
        // be shown and skipTorrentDialog is undefined. The other is when
        // skipTorrentDialog is false, meaning that the application setting
        // should be overridden.
        const bool showDialogForThisTorrent = !skipTorrentDialog.value_or(!AddNewTorrentDialog::isEnabled());
        if (showDialogForThisTorrent)
            AddNewTorrentDialog::show(param, torrentParams, m_window);
        else
#endif
            BitTorrent::Session::instance()->addTorrent(param, torrentParams);
    }
}

References BitTorrent::AddTorrentParams::addPaused, BitTorrent::Session::addTorrent(), BitTorrent::AddTorrentParams::category, BitTorrent::AddTorrentParams::firstLastPiecePriority, BitTorrent::Session::instance(), AddNewTorrentDialog::isEnabled(), m_window, BitTorrent::AddTorrentParams::savePath, BitTorrent::AddTorrentParams::sequential, AddNewTorrentDialog::show(), and BitTorrent::AddTorrentParams::skipChecking.

Referenced by exec(), and processMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

runExternalProgram()

void Application::runExternalProgram ( const BitTorrent::Torrent *  torrent ) const

private

Definition at line 304 of file application.cpp.

{
#if defined(Q_OS_WIN)
    const auto chopPathSep = [](const QString &str) -> QString
    {
        if (str.endsWith('\\'))
            return str.mid(0, (str.length() -1));
        return str;
    };
#endif
 
    QString program = Preferences::instance()->getAutoRunProgram().trimmed();
 
    for (int i = (program.length() - 2); i >= 0; --i)
    {
        if (program[i] != QLatin1Char('%'))
            continue;
 
        const ushort specifier = program[i + 1].unicode();
        switch (specifier)
        {
        case u'C':
            program.replace(i, 2, QString::number(torrent->filesCount()));
            break;
        case u'D':
#if defined(Q_OS_WIN)
            program.replace(i, 2, chopPathSep(Utils::Fs::toNativePath(torrent->savePath())));
#else
            program.replace(i, 2, Utils::Fs::toNativePath(torrent->savePath()));
#endif
            break;
        case u'F':
#if defined(Q_OS_WIN)
            program.replace(i, 2, chopPathSep(Utils::Fs::toNativePath(torrent->contentPath())));
#else
            program.replace(i, 2, Utils::Fs::toNativePath(torrent->contentPath()));
#endif
            break;
        case u'G':
            program.replace(i, 2, torrent->tags().join(QLatin1String(",")));
            break;
        case u'I':
            program.replace(i, 2, (torrent->infoHash().v1().isValid() ? torrent->infoHash().v1().toString() : QLatin1String("-")));
            break;
        case u'J':
            program.replace(i, 2, (torrent->infoHash().v2().isValid() ? torrent->infoHash().v2().toString() : QLatin1String("-")));
            break;
        case u'K':
            program.replace(i, 2, torrent->id().toString());
            break;
        case u'L':
            program.replace(i, 2, torrent->category());
            break;
        case u'N':
            program.replace(i, 2, torrent->name());
            break;
        case u'R':
#if defined(Q_OS_WIN)
            program.replace(i, 2, chopPathSep(Utils::Fs::toNativePath(torrent->rootPath())));
#else
            program.replace(i, 2, Utils::Fs::toNativePath(torrent->rootPath()));
#endif
            break;
        case u'T':
            program.replace(i, 2, torrent->currentTracker());
            break;
        case u'Z':
            program.replace(i, 2, QString::number(torrent->totalSize()));
            break;
        default:
            // do nothing
            break;
        }
 
        // decrement `i` to avoid unwanted replacement, example pattern: "%%N"
        --i;
    }
 
    LogMsg(tr("Torrent: %1, running external program, command: %2").arg(torrent->name(), program));
 
#if defined(Q_OS_WIN)
    auto programWchar = std::make_unique<wchar_t[]>(program.length() + 1);
    program.toWCharArray(programWchar.get());
 
    // Need to split arguments manually because QProcess::startDetached(QString)
    // will strip off empty parameters.
    // E.g. `python.exe "1" "" "3"` will become `python.exe "1" "3"`
    int argCount = 0;
    std::unique_ptr<LPWSTR[], decltype(&::LocalFree)> args {::CommandLineToArgvW(programWchar.get(), &argCount), ::LocalFree};
 
    QStringList argList;
    for (int i = 1; i < argCount; ++i)
        argList += QString::fromWCharArray(args[i]);
 
    QProcess proc;
    proc.setProgram(QString::fromWCharArray(args[0]));
    proc.setArguments(argList);
    proc.setCreateProcessArgumentsModifier([](QProcess::CreateProcessArguments *args)
    {
        if (Preferences::instance()->isAutoRunConsoleEnabled())
        {
            args->flags |= CREATE_NEW_CONSOLE;
            args->flags &= ~(CREATE_NO_WINDOW | DETACHED_PROCESS);
        }
        else
        {
            args->flags |= CREATE_NO_WINDOW;
            args->flags &= ~(CREATE_NEW_CONSOLE | DETACHED_PROCESS);
        }
        args->inheritHandles = false;
        args->startupInfo->dwFlags &= ~STARTF_USESTDHANDLES;
        ::CloseHandle(args->startupInfo->hStdInput);
        ::CloseHandle(args->startupInfo->hStdOutput);
        ::CloseHandle(args->startupInfo->hStdError);
        args->startupInfo->hStdInput = nullptr;
        args->startupInfo->hStdOutput = nullptr;
        args->startupInfo->hStdError = nullptr;
    });
    proc.startDetached();
#else // Q_OS_WIN
    // Cannot give users shell environment by default, as doing so could
    // enable command injection via torrent name and other arguments
    // (especially when some automated download mechanism has been setup).
    // See: https://github.com/qbittorrent/qBittorrent/issues/10925
    QStringList args = QProcess::splitCommand(program);
    if (args.isEmpty())
        return;
 
    const QString command = args.takeFirst();
    QProcess::startDetached(command, args);
#endif
}

References tstool::args, BitTorrent::Torrent::category(), BitTorrent::Torrent::contentPath(), BitTorrent::Torrent::currentTracker(), BitTorrent::AbstractFileStorage::filesCount(), Preferences::getAutoRunProgram(), BitTorrent::Torrent::id(), BitTorrent::Torrent::infoHash(), Preferences::instance(), Digest32< N >::isValid(), OrderedSet< T, Compare >::join(), LogMsg(), BitTorrent::Torrent::name(), BitTorrent::Torrent::rootPath(), BitTorrent::Torrent::savePath(), BitTorrent::Torrent::tags(), Utils::Fs::toNativePath(), Digest32< N >::toString(), BitTorrent::Torrent::totalSize(), BitTorrent::InfoHash::v1(), and BitTorrent::InfoHash::v2().

Referenced by torrentFinished().

Here is the call graph for this function:

Here is the caller graph for this function:

sendNotificationEmail()

void Application::sendNotificationEmail ( const BitTorrent::Torrent *  torrent )

private

Definition at line 437 of file application.cpp.

{
    // Prepare mail content
    const QString content = tr("Torrent name: %1").arg(torrent->name()) + '\n'
        + tr("Torrent size: %1").arg(Utils::Misc::friendlyUnit(torrent->wantedSize())) + '\n'
        + tr("Save path: %1").arg(torrent->savePath()) + "\n\n"
        + tr("The torrent was downloaded in %1.", "The torrent was downloaded in 1 hour and 20 seconds")
            .arg(Utils::Misc::userFriendlyDuration(torrent->activeTime())) + "\n\n\n"
        + tr("Thank you for using qBittorrent.") + '\n';
 
    // Send the notification email
    const Preferences *pref = Preferences::instance();
    auto *smtp = new Net::Smtp(this);
    smtp->sendMail(pref->getMailNotificationSender(),
                     pref->getMailNotificationEmail(),
                     tr("[qBittorrent] '%1' has finished downloading").arg(torrent->name()),
                     content);
}

References BitTorrent::Torrent::activeTime(), Utils::Misc::friendlyUnit(), Preferences::getMailNotificationEmail(), Preferences::getMailNotificationSender(), Preferences::instance(), BitTorrent::Torrent::name(), BitTorrent::Torrent::savePath(), Utils::Misc::userFriendlyDuration(), and BitTorrent::Torrent::wantedSize().

Referenced by torrentFinished().

Here is the call graph for this function:

Here is the caller graph for this function:

sendParams()

bool Application::sendParams

(

const QStringList &

params

)

Definition at line 519 of file application.cpp.

{
    return m_instanceManager->sendMessage(params.join(PARAMS_SEPARATOR));
}

References m_instanceManager, anonymous_namespace{application.cpp}::PARAMS_SEPARATOR, and ApplicationInstanceManager::sendMessage().

Here is the call graph for this function:

setFileLoggerAge()

void Application::setFileLoggerAge

(

int

value

)

Definition at line 277 of file application.cpp.

{
    m_storeFileLoggerAge = std::min(std::max(value, 1), 365);
}

References m_storeFileLoggerAge, and anonymous_namespace{preferences.cpp}::value().

Here is the call graph for this function:

setFileLoggerAgeType()

void Application::setFileLoggerAgeType

(

int

value

)

Definition at line 288 of file application.cpp.

{
    m_storeFileLoggerAgeType = ((value < 0) || (value > 2)) ? 1 : value;
}

References m_storeFileLoggerAgeType, and anonymous_namespace{preferences.cpp}::value().

Here is the call graph for this function:

setFileLoggerBackup()

void Application::setFileLoggerBackup

(

bool

value

)

Definition at line 238 of file application.cpp.

{
    if (m_fileLogger)
        m_fileLogger->setBackup(value);
    m_storeFileLoggerBackup = value;
}

References m_fileLogger, m_storeFileLoggerBackup, and anonymous_namespace{preferences.cpp}::value().

Here is the call graph for this function:

setFileLoggerDeleteOld()

void Application::setFileLoggerDeleteOld

(

bool

value

)

Definition at line 250 of file application.cpp.

{
    if (value && m_fileLogger)
        m_fileLogger->deleteOld(fileLoggerAge(), static_cast<FileLogger::FileLogAgeType>(fileLoggerAgeType()));
    m_storeFileLoggerDeleteOld = value;
}

References fileLoggerAge(), fileLoggerAgeType(), m_fileLogger, m_storeFileLoggerDeleteOld, and anonymous_namespace{preferences.cpp}::value().

Here is the call graph for this function:

setFileLoggerEnabled()

void Application::setFileLoggerEnabled

(

bool

value

)

Definition at line 212 of file application.cpp.

{
    if (value && !m_fileLogger)
        m_fileLogger = new FileLogger(fileLoggerPath(), isFileLoggerBackup(), fileLoggerMaxSize(), isFileLoggerDeleteOld(), fileLoggerAge(), static_cast<FileLogger::FileLogAgeType>(fileLoggerAgeType()));
    else if (!value)
        delete m_fileLogger;
    m_storeFileLoggerEnabled = value;
}

References fileLoggerAge(), fileLoggerAgeType(), fileLoggerMaxSize(), fileLoggerPath(), isFileLoggerBackup(), isFileLoggerDeleteOld(), m_fileLogger, m_storeFileLoggerEnabled, and anonymous_namespace{preferences.cpp}::value().

Here is the call graph for this function:

setFileLoggerMaxSize()

void Application::setFileLoggerMaxSize

(

int

bytes

)

Definition at line 263 of file application.cpp.

{
    const int clampedValue = std::min(std::max(bytes, MIN_FILELOG_SIZE), MAX_FILELOG_SIZE);
    if (m_fileLogger)
        m_fileLogger->setMaxSize(clampedValue);
    m_storeFileLoggerMaxSize = clampedValue;
}

References m_fileLogger, m_storeFileLoggerMaxSize, anonymous_namespace{application.cpp}::MAX_FILELOG_SIZE, and anonymous_namespace{application.cpp}::MIN_FILELOG_SIZE.

setFileLoggerPath()

void Application::setFileLoggerPath

(

const QString &

path

)

Definition at line 226 of file application.cpp.

{
    if (m_fileLogger)
        m_fileLogger->changePath(path);
    m_storeFileLoggerPath = path;
}

References m_fileLogger, and m_storeFileLoggerPath.

Referenced by OptionsDialog::saveOptions().

Here is the caller graph for this function:

torrentFinished

void Application::torrentFinished ( BitTorrent::Torrent *const  torrent )

privateslot

Definition at line 456 of file application.cpp.

{
    Preferences *const pref = Preferences::instance();
 
    // AutoRun program
    if (pref->isAutoRunEnabled())
        runExternalProgram(torrent);
 
    // Mail notification
    if (pref->isMailNotificationEnabled())
    {
        Logger::instance()->addMessage(tr("Torrent: %1, sending mail notification").arg(torrent->name()));
        sendNotificationEmail(torrent);
    }
}

References Logger::addMessage(), Logger::instance(), Preferences::instance(), Preferences::isAutoRunEnabled(), Preferences::isMailNotificationEnabled(), BitTorrent::Torrent::name(), runExternalProgram(), and sendNotificationEmail().

Referenced by exec().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_commandLineArgs

QBtCommandLineParameters Application::m_commandLineArgs

private

Definition at line 132 of file application.h.

Referenced by Application(), and commandLineArgs().

m_fileLogger

QPointer<FileLogger> Application::m_fileLogger

private

Definition at line 143 of file application.h.

Referenced by Application(), cleanup(), setFileLoggerBackup(), setFileLoggerDeleteOld(), setFileLoggerEnabled(), setFileLoggerMaxSize(), and setFileLoggerPath().

m_instanceManager

ApplicationInstanceManager* Application::m_instanceManager = nullptr

private

Definition at line 129 of file application.h.

Referenced by Application(), isRunning(), and sendParams().

m_paramsQueue

QStringList Application::m_paramsQueue

private

Definition at line 147 of file application.h.

Referenced by exec(), and processMessage().

m_qtTranslator

QTranslator Application::m_qtTranslator

private

Definition at line 145 of file application.h.

Referenced by initializeTranslation().

m_running

bool Application::m_running

private

Definition at line 130 of file application.h.

Referenced by exec(), and processMessage().

m_shutdownAct

ShutdownDialogAction Application::m_shutdownAct

private

Definition at line 131 of file application.h.

Referenced by allTorrentsFinished(), and cleanup().

m_storeFileLoggerAge

SettingValue<int> Application::m_storeFileLoggerAge

private

Definition at line 153 of file application.h.

Referenced by fileLoggerAge(), and setFileLoggerAge().

m_storeFileLoggerAgeType

SettingValue<int> Application::m_storeFileLoggerAgeType

private

Definition at line 154 of file application.h.

Referenced by fileLoggerAgeType(), and setFileLoggerAgeType().

m_storeFileLoggerBackup

SettingValue<bool> Application::m_storeFileLoggerBackup

private

Definition at line 150 of file application.h.

Referenced by isFileLoggerBackup(), and setFileLoggerBackup().

m_storeFileLoggerDeleteOld

SettingValue<bool> Application::m_storeFileLoggerDeleteOld

private

Definition at line 151 of file application.h.

Referenced by isFileLoggerDeleteOld(), and setFileLoggerDeleteOld().

m_storeFileLoggerEnabled

SettingValue<bool> Application::m_storeFileLoggerEnabled

private

Definition at line 149 of file application.h.

Referenced by isFileLoggerEnabled(), and setFileLoggerEnabled().

m_storeFileLoggerMaxSize

SettingValue<int> Application::m_storeFileLoggerMaxSize

private

Definition at line 152 of file application.h.

Referenced by fileLoggerMaxSize(), and setFileLoggerMaxSize().

m_storeFileLoggerPath

SettingValue<QString> Application::m_storeFileLoggerPath

private

Definition at line 155 of file application.h.

Referenced by fileLoggerPath(), and setFileLoggerPath().

m_translator

QTranslator Application::m_translator

private

Definition at line 146 of file application.h.

Referenced by initializeTranslation().

m_webui

WebUI* Application::m_webui = nullptr

private

Definition at line 139 of file application.h.

Referenced by cleanup(), and exec().

m_window

QPointer<MainWindow> Application::m_window

private

Definition at line 135 of file application.h.

Referenced by allTorrentsFinished(), cleanup(), exec(), mainWindow(), and processParams().

---

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

• src/app/application.h
• src/app/application.cpp