Utils::Misc Namespace Reference

Enumerations
enum class	SizeUnit {   Byte , KibiByte , MebiByte , GibiByte ,   TebiByte , PebiByte , ExbiByte }

Functions
QString	parseHtmlLinks (const QString &rawText)
void	shutdownComputer (const ShutdownDialogAction &action)
QString	osName ()
QString	boostVersionString ()
QString	libtorrentVersionString ()
QString	opensslVersionString ()
QString	zlibVersionString ()
QString	unitString (SizeUnit unit, bool isSpeed=false)
QString	friendlyUnit (qint64 bytes, bool isSpeed=false)
int	friendlyUnitPrecision (SizeUnit unit)
qint64	sizeInBytes (qreal size, SizeUnit unit)
bool	isPreviewable (const QString &filename)
QString	userFriendlyDuration (qlonglong seconds, qlonglong maxCap=-1)
QString	getUserIDString ()

Enumeration Type Documentation

SizeUnit

enum Utils::Misc::SizeUnit

strong

Enumerator
Byte
KibiByte
MebiByte
GibiByte
TebiByte
PebiByte
ExbiByte

Definition at line 48 of file misc.h.

    {
        Byte,       // 1024^0,
        KibiByte,   // 1024^1,
        MebiByte,   // 1024^2,
        GibiByte,   // 1024^3,
        TebiByte,   // 1024^4,
        PebiByte,   // 1024^5,
        ExbiByte    // 1024^6,
        // int64 is used for sizes and thus the next units can not be handled
        // ZebiByte,   // 1024^7,
        // YobiByte,   // 1024^8
    };

Function Documentation

boostVersionString()

QString Utils::Misc::boostVersionString

(

)

Definition at line 477 of file misc.cpp.

{
    // static initialization for usage in signal handler
    static const QString ver = QString("%1.%2.%3")
        .arg(QString::number(BOOST_VERSION / 100000)
            , QString::number((BOOST_VERSION / 100) % 1000)
            , QString::number(BOOST_VERSION % 100));
    return ver;
}

Referenced by AboutDialog::AboutDialog(), AppController::buildInfoAction(), and StacktraceDialog::setStacktraceString().

Here is the caller graph for this function:

friendlyUnit()

QString Utils::Misc::friendlyUnit	(	qint64	bytes,
		bool	isSpeed = false
	)

Definition at line 261 of file misc.cpp.

{
    const std::optional<SplitToFriendlyUnitResult> result = splitToFriendlyUnit(bytes);
    if (!result)
        return QCoreApplication::translate("misc", "Unknown", "Unknown (size)");
    return Utils::String::fromDouble(result->value, friendlyUnitPrecision(result->unit))
           + QString::fromUtf8(C_NON_BREAKING_SPACE)
           + unitString(result->unit, isSpeed);
}

References C_NON_BREAKING_SPACE, friendlyUnitPrecision(), Utils::String::fromDouble(), anonymous_namespace{misc.cpp}::splitToFriendlyUnit(), and unitString().

Referenced by SearchJobWidget::appendSearchResults(), DownloadHandlerImpl::checkDownloadSize(), TorrentContentModelItem::displayData(), TransferListModel::displayValue(), PropertiesWidget::loadDynamicData(), BitTorrent::TorrentInfo::loadFromFile(), PropertiesWidget::loadTorrentInfos(), PreviewListDelegate::paint(), MainWindow::reloadSessionStats(), WebApplication::sendFile(), Application::sendNotificationEmail(), PiecesBar::showToolTip(), StatsDialog::update(), AddNewTorrentDialog::updateDiskSpaceLabel(), PeerListWidget::updatePeer(), and StatusBar::updateSpeedLabels().

Here is the call graph for this function:

Here is the caller graph for this function:

friendlyUnitPrecision()

int Utils::Misc::friendlyUnitPrecision

(

SizeUnit

unit

)

Definition at line 271 of file misc.cpp.

{
    // friendlyUnit's number of digits after the decimal point
    switch (unit)
    {
    case SizeUnit::Byte:
        return 0;
    case SizeUnit::KibiByte:
    case SizeUnit::MebiByte:
        return 1;
    case SizeUnit::GibiByte:
        return 2;
    default:
        return 3;
    }
}

Referenced by anonymous_namespace{speedplotview.cpp}::formatLabel(), and friendlyUnit().

Here is the caller graph for this function:

getUserIDString()

QString Utils::Misc::getUserIDString

(

)

Definition at line 389 of file misc.cpp.

{
    QString uid = "0";
#ifdef Q_OS_WIN
    const int UNLEN = 256;
    WCHAR buffer[UNLEN + 1] = {0};
    DWORD buffer_len = sizeof(buffer) / sizeof(*buffer);
    if (GetUserNameW(buffer, &buffer_len))
        uid = QString::fromWCharArray(buffer);
#else
    uid = QString::number(getuid());
#endif
    return uid;
}

isPreviewable()

bool Utils::Misc::isPreviewable

(

const QString &

filename

)

Definition at line 295 of file misc.cpp.

{
    const QString mime = QMimeDatabase().mimeTypeForFile(filename, QMimeDatabase::MatchExtension).name();
 
    if (mime.startsWith(QLatin1String("audio"), Qt::CaseInsensitive)
        || mime.startsWith(QLatin1String("video"), Qt::CaseInsensitive))
    {
        return true;
    }
 
    const QSet<QString> multimediaExtensions =
    {
        "3GP",
        "AAC",
        "AC3",
        "AIF",
        "AIFC",
        "AIFF",
        "ASF",
        "AU",
        "AVI",
        "FLAC",
        "FLV",
        "M3U",
        "M4A",
        "M4P",
        "M4V",
        "MID",
        "MKV",
        "MOV",
        "MP2",
        "MP3",
        "MP4",
        "MPC",
        "MPE",
        "MPEG",
        "MPG",
        "MPP",
        "OGG",
        "OGM",
        "OGV",
        "QT",
        "RA",
        "RAM",
        "RM",
        "RMV",
        "RMVB",
        "SWA",
        "SWF",
        "TS",
        "VOB",
        "WAV",
        "WMA",
        "WMV"
    };
    return multimediaExtensions.contains(Utils::Fs::fileExtension(filename).toUpper());
}

References Utils::Fs::fileExtension().

Referenced by PreviewSelectDialog::PreviewSelectDialog(), and anonymous_namespace{transferlistwidget.cpp}::torrentContainsPreviewableFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

libtorrentVersionString()

QString Utils::Misc::libtorrentVersionString

(

)

Definition at line 487 of file misc.cpp.

{
    // static initialization for usage in signal handler
    static const auto version {QString::fromLatin1(lt::version())};
    return version;
}

Referenced by AboutDialog::AboutDialog(), AppController::buildInfoAction(), and StacktraceDialog::setStacktraceString().

Here is the caller graph for this function:

opensslVersionString()

QString Utils::Misc::opensslVersionString

(

)

Definition at line 494 of file misc.cpp.

{
#if (OPENSSL_VERSION_NUMBER >= 0x1010000f)
    static const auto version {QString::fromLatin1(OpenSSL_version(OPENSSL_VERSION))};
#else
    static const auto version {QString::fromLatin1(SSLeay_version(SSLEAY_VERSION))};
#endif
    return QStringView(version).split(u' ', Qt::SkipEmptyParts).at(1).toString();
}

Referenced by AboutDialog::AboutDialog(), AppController::buildInfoAction(), and StacktraceDialog::setStacktraceString().

Here is the caller graph for this function:

osName()

QString Utils::Misc::osName

(

)

Definition at line 466 of file misc.cpp.

{
    // static initialization for usage in signal handler
    static const QString name =
        QString("%1 %2 %3")
        .arg(QSysInfo::prettyProductName()
            , QSysInfo::kernelVersion()
            , QSysInfo::currentCpuArchitecture());
    return name;
}

Referenced by StacktraceDialog::setStacktraceString().

Here is the caller graph for this function:

parseHtmlLinks()

QString Utils::Misc::parseHtmlLinks

(

const QString &

rawText

)

Definition at line 404 of file misc.cpp.

{
    QString result = rawText;
    static const QRegularExpression reURL(
        "(\\s|^)"                                             // start with whitespace or beginning of line
        "("
        "("                                              // case 1 -- URL with scheme
        "(http(s?))\\://"                            // start with scheme
        "([a-zA-Z0-9_-]+\\.)+"                       //  domainpart.  at least one of these must exist
        "([a-zA-Z0-9\\?%=&/_\\.:#;-]+)"              //  everything to 1st non-URI char, must be at least one char after the previous dot (cannot use ".*" because it can be too greedy)
        ")"
        "|"
        "("                                             // case 2a -- no scheme, contains common TLD  example.com
        "([a-zA-Z0-9_-]+\\.)+"                      //  domainpart.  at least one of these must exist
        "(?="                                       //  must be followed by TLD
        "AERO|aero|"                          // N.B. assertions are non-capturing
        "ARPA|arpa|"
        "ASIA|asia|"
        "BIZ|biz|"
        "CAT|cat|"
        "COM|com|"
        "COOP|coop|"
        "EDU|edu|"
        "GOV|gov|"
        "INFO|info|"
        "INT|int|"
        "JOBS|jobs|"
        "MIL|mil|"
        "MOBI|mobi|"
        "MUSEUM|museum|"
        "NAME|name|"
        "NET|net|"
        "ORG|org|"
        "PRO|pro|"
        "RO|ro|"
        "RU|ru|"
        "TEL|tel|"
        "TRAVEL|travel"
        ")"
        "([a-zA-Z0-9\\?%=&/_\\.:#;-]+)"             //  everything to 1st non-URI char, must be at least one char after the previous dot (cannot use ".*" because it can be too greedy)
        ")"
        "|"
        "("                                             // case 2b no scheme, no TLD, must have at least 2 alphanum strings plus uncommon TLD string  --> del.icio.us
        "([a-zA-Z0-9_-]+\\.) {2,}"                   // 2 or more domainpart.   --> del.icio.
        "[a-zA-Z]{2,}"                              // one ab  (2 char or longer) --> us
        "([a-zA-Z0-9\\?%=&/_\\.:#;-]*)"             // everything to 1st non-URI char, maybe nothing  in case of del.icio.us/path
        ")"
        ")"
        );
 
    // Capture links
    result.replace(reURL, "\\1<a href=\"\\2\">\\2</a>");
 
    // Capture links without scheme
    static const QRegularExpression reNoScheme("<a\\s+href=\"(?!https?)([a-zA-Z0-9\\?%=&/_\\.-:#]+)\\s*\">");
    result.replace(reNoScheme, "<a href=\"http://\\1\">");
 
    // to preserve plain text formatting
    result = "<p style=\"white-space: pre-wrap;\">" + result + "</p>";
    return result;
}

Referenced by PropertiesWidget::loadTorrentInfos(), and AddNewTorrentDialog::setupTreeview().

Here is the caller graph for this function:

shutdownComputer()

void Utils::Misc::shutdownComputer

(

const ShutdownDialogAction &

action

)

Definition at line 110 of file misc.cpp.

{
#if defined(Q_OS_WIN)
    HANDLE hToken;            // handle to process token
    TOKEN_PRIVILEGES tkp;     // pointer to token structure
    if (!OpenProcessToken(GetCurrentProcess(), TOKEN_ADJUST_PRIVILEGES | TOKEN_QUERY, &hToken))
        return;
    // Get the LUID for shutdown privilege.
    LookupPrivilegeValue(NULL, SE_SHUTDOWN_NAME,
                         &tkp.Privileges[0].Luid);
 
    tkp.PrivilegeCount = 1; // one privilege to set
    tkp.Privileges[0].Attributes = SE_PRIVILEGE_ENABLED;
 
    // Get shutdown privilege for this process.
 
    AdjustTokenPrivileges(hToken, FALSE, &tkp, 0,
                          (PTOKEN_PRIVILEGES) NULL, 0);
 
    // Cannot test the return value of AdjustTokenPrivileges.
 
    if (GetLastError() != ERROR_SUCCESS)
        return;
 
    if (action == ShutdownDialogAction::Suspend)
    {
        ::SetSuspendState(FALSE, FALSE, FALSE);
    }
    else if (action == ShutdownDialogAction::Hibernate)
    {
        ::SetSuspendState(TRUE, FALSE, FALSE);
    }
    else
    {
        const QString msg = QCoreApplication::translate("misc", "qBittorrent will shutdown the computer now because all downloads are complete.");
        auto msgWchar = std::make_unique<wchar_t[]>(msg.length() + 1);
        msg.toWCharArray(msgWchar.get());
        ::InitiateSystemShutdownW(nullptr, msgWchar.get(), 10, TRUE, FALSE);
    }
 
    // Disable shutdown privilege.
    tkp.Privileges[0].Attributes = 0;
    AdjustTokenPrivileges(hToken, FALSE, &tkp, 0, (PTOKEN_PRIVILEGES) NULL, 0);
 
#elif defined(Q_OS_MACOS)
    AEEventID EventToSend;
    if (action != ShutdownDialogAction::Shutdown)
        EventToSend = kAESleep;
    else
        EventToSend = kAEShutDown;
    AEAddressDesc targetDesc;
    const ProcessSerialNumber kPSNOfSystemProcess = {0, kSystemProcess};
    AppleEvent eventReply = {typeNull, NULL};
    AppleEvent appleEventToSend = {typeNull, NULL};
 
    OSStatus error = AECreateDesc(typeProcessSerialNumber, &kPSNOfSystemProcess,
                                  sizeof(kPSNOfSystemProcess), &targetDesc);
 
    if (error != noErr)
        return;
 
    error = AECreateAppleEvent(kCoreEventClass, EventToSend, &targetDesc,
                               kAutoGenerateReturnID, kAnyTransactionID, &appleEventToSend);
 
    AEDisposeDesc(&targetDesc);
    if (error != noErr)
        return;
 
    error = AESend(&appleEventToSend, &eventReply, kAENoReply,
                   kAENormalPriority, kAEDefaultTimeout, NULL, NULL);
 
    AEDisposeDesc(&appleEventToSend);
    if (error != noErr)
        return;
 
    AEDisposeDesc(&eventReply);
 
#elif (defined(Q_OS_UNIX) && defined(QT_DBUS_LIB))
    // Use dbus to power off / suspend the system
    if (action != ShutdownDialogAction::Shutdown)
    {
        // Some recent systems use systemd's logind
        QDBusInterface login1Iface("org.freedesktop.login1", "/org/freedesktop/login1",
                                   "org.freedesktop.login1.Manager", QDBusConnection::systemBus());
        if (login1Iface.isValid())
        {
            if (action == ShutdownDialogAction::Suspend)
                login1Iface.call("Suspend", false);
            else
                login1Iface.call("Hibernate", false);
            return;
        }
        // Else, other recent systems use UPower
        QDBusInterface upowerIface("org.freedesktop.UPower", "/org/freedesktop/UPower",
                                   "org.freedesktop.UPower", QDBusConnection::systemBus());
        if (upowerIface.isValid())
        {
            if (action == ShutdownDialogAction::Suspend)
                upowerIface.call("Suspend");
            else
                upowerIface.call("Hibernate");
            return;
        }
        // HAL (older systems)
        QDBusInterface halIface("org.freedesktop.Hal", "/org/freedesktop/Hal/devices/computer",
                                "org.freedesktop.Hal.Device.SystemPowerManagement",
                                QDBusConnection::systemBus());
        if (action == ShutdownDialogAction::Suspend)
            halIface.call("Suspend", 5);
        else
            halIface.call("Hibernate");
    }
    else
    {
        // Some recent systems use systemd's logind
        QDBusInterface login1Iface("org.freedesktop.login1", "/org/freedesktop/login1",
                                   "org.freedesktop.login1.Manager", QDBusConnection::systemBus());
        if (login1Iface.isValid())
        {
            login1Iface.call("PowerOff", false);
            return;
        }
        // Else, other recent systems use ConsoleKit
        QDBusInterface consolekitIface("org.freedesktop.ConsoleKit", "/org/freedesktop/ConsoleKit/Manager",
                                       "org.freedesktop.ConsoleKit.Manager", QDBusConnection::systemBus());
        if (consolekitIface.isValid())
        {
            consolekitIface.call("Stop");
            return;
        }
        // HAL (older systems)
        QDBusInterface halIface("org.freedesktop.Hal", "/org/freedesktop/Hal/devices/computer",
                                "org.freedesktop.Hal.Device.SystemPowerManagement",
                                QDBusConnection::systemBus());
        halIface.call("Shutdown");
    }
 
#else
    Q_UNUSED(action);
#endif
}

References tstool::action, Hibernate, Shutdown, and Suspend.

Referenced by Application::cleanup().

Here is the caller graph for this function:

sizeInBytes()

qlonglong Utils::Misc::sizeInBytes	(	qreal	size,
		SizeUnit	unit
	)

Definition at line 288 of file misc.cpp.

{
    for (int i = 0; i < static_cast<int>(unit); ++i)
        size *= 1024;
    return size;
}

Referenced by anonymous_namespace{speedplotview.cpp}::SplittedValue::sizeInBytes(), and SearchJobWidget::updateFilter().

Here is the caller graph for this function:

unitString()

QString Utils::Misc::unitString	(	SizeUnit	unit,
		bool	isSpeed = false
	)

Definition at line 252 of file misc.cpp.

{
    const auto &unitString = units[static_cast<int>(unit)];
    QString ret = QCoreApplication::translate("misc", unitString.source, unitString.comment);
    if (isSpeed)
        ret += QCoreApplication::translate("misc", "/s", "per second");
    return ret;
}

References anonymous_namespace{misc.cpp}::units.

Referenced by TransferListModel::displayValue(), SearchJobWidget::fillFilterComboBoxes(), anonymous_namespace{speedplotview.cpp}::formatLabel(), and friendlyUnit().

Here is the caller graph for this function:

userFriendlyDuration()

QString Utils::Misc::userFriendlyDuration	(	qlonglong	seconds,
		qlonglong	maxCap = -1
	)

Definition at line 353 of file misc.cpp.

{
    if (seconds < 0)
        return QString::fromUtf8(C_INFINITY);
    if ((maxCap >= 0) && (seconds >= maxCap))
        return QString::fromUtf8(C_INFINITY);
 
    if (seconds == 0)
        return "0";
 
    if (seconds < 60)
        return QCoreApplication::translate("misc", "< 1m", "< 1 minute");
 
    qlonglong minutes = (seconds / 60);
    if (minutes < 60)
        return QCoreApplication::translate("misc", "%1m", "e.g: 10minutes").arg(QString::number(minutes));
 
    qlonglong hours = (minutes / 60);
    if (hours < 24)
    {
        minutes -= (hours * 60);
        return QCoreApplication::translate("misc", "%1h %2m", "e.g: 3hours 5minutes").arg(QString::number(hours), QString::number(minutes));
    }
 
    qlonglong days = (hours / 24);
    if (days < 365)
    {
        hours -= (days * 24);
        return QCoreApplication::translate("misc", "%1d %2h", "e.g: 2days 10hours").arg(QString::number(days), QString::number(hours));
    }
 
    qlonglong years = (days / 365);
    days -= (years * 365);
    return QCoreApplication::translate("misc", "%1y %2d", "e.g: 2years 10days").arg(QString::number(years), QString::number(days));
}

References C_INFINITY.

Referenced by TransferListModel::displayValue(), PropertiesWidget::loadDynamicData(), and Application::sendNotificationEmail().

Here is the caller graph for this function:

zlibVersionString()

QString Utils::Misc::zlibVersionString

(

)

Definition at line 504 of file misc.cpp.

{
    // static initialization for usage in signal handler
    static const auto version {QString::fromLatin1(zlibVersion())};
    return version;
}

Referenced by AboutDialog::AboutDialog(), AppController::buildInfoAction(), and StacktraceDialog::setStacktraceString().

Here is the caller graph for this function: