#include "mythmiscutil.h"
#include <array>
#include <cerrno>
#include <cstdlib>
#include <ctime>
#include <iostream>
#include <unistd.h>
#include <fcntl.h>
#include <sched.h>
#include "compat.h"
#include <QReadWriteLock>
#include <QNetworkProxy>
#include <QStringList>
#include <QDataStream>
#include <QUdpSocket>
#include <QFileInfo>
#include <QFile>
#include <QDir>
#include <QUrl>
#include <QHostAddress>
#include <QRegularExpression>
#include <QRegularExpressionMatchIterator>
#include "mythcorecontext.h"
#include "exitcodes.h"
#include "mythlogging.h"
#include "mythsocket.h"
#include "mythcoreutil.h"
#include "mythsystemlegacy.h"
#include "mythconfig.h"

Include dependency graph for mythmiscutil.cpp:

Enumerations
enum	states { START, INTEXT, INSQUOTE, INDQUOTE, ESCTEXT, ESCSQUOTE, ESCDQUOTE }

Functions
bool	getUptime (time_t &uptime)
	Returns uptime statistics. More...

bool	getMemStats (int &totalMB, int &freeMB, int &totalVM, int &freeVM)
	Returns memory statistics in megabytes. More...

loadArray	getLoadAvgs (void)
	Returns the system load averages. More...

bool	hasUtf8 (const char *str)
	Guess whether a string is UTF-8. More...

bool	ping (const QString &host, int timeout)
	Can we ping host within timeout seconds? More...

bool	telnet (const QString &host, int port)
	Can we talk to port on host? More...

long long	copy (QFile &dst, QFile &src, uint block_size)
	Copies src file to dst file. More...

QString	createTempFile (QString name_template, bool dir)

bool	makeFileAccessible (const QString &filename)

QString	getResponse (const QString &query, const QString &def)
	In an interactive shell, prompt the user to input a string. More...

int	intResponse (const QString &query, int def)
	In an interactive shell, prompt the user to input a number. More...

QString	getSymlinkTarget (const QString &start_file, QStringList *intermediaries, unsigned maxLinks)

bool	IsMACAddress (const QString &MAC)

QString	FileHash (const QString &filename)

bool	WakeOnLAN (const QString &MAC)

bool	MythWakeup (const QString &wakeUpCommand, uint flags, uint timeout)

bool	IsPulseAudioRunning (void)
	Is A/V Sync destruction daemon is running on this host? More...

bool	myth_nice (int val)

void	myth_yield (void)

bool	myth_ioprio (int)
	Allows setting the I/O priority of the current process/thread. More...

bool	MythRemoveDirectory (QDir &aDir)

void	setHttpProxy (void)
	Get network proxy settings from OS, and use for [Q]Http[Comms]. More...

void	wrapList (QStringList &list, int width)

QString	xml_indent (uint level)

int	naturalCompare (const QString &_a, const QString &_b, Qt::CaseSensitivity caseSensitivity)

QString	MythFormatTimeMs (int msecs, const QString &fmt)
	Format a milliseconds time value. More...

QString	MythFormatTime (int secs, const QString &fmt)
	Format a seconds time value. More...

QStringList	MythSplitCommandString (const QString &line)

Enumeration Type Documentation

◆ states

enum states

Enumerator
START
INTEXT
INSQUOTE
INDQUOTE
ESCTEXT
ESCSQUOTE
ESCDQUOTE

Definition at line 1242 of file mythmiscutil.cpp.

Function Documentation

◆ getUptime()

getUptime ( time_t & uptime )

Returns uptime statistics.

Returns: true if successful, false otherwise.

Definition at line 64 of file mythmiscutil.cpp.

Referenced by StatusBox::doMachineStatus(), MainServer::HandleQueryUptime(), BaseRequestHandler::HandleQueryUptime(), and NetworkControl::processQuery().

◆ getMemStats()

getMemStats	(	int &	totalMB,
		int &	freeMB,
		int &	totalVM,
		int &	freeVM
	)

Returns memory statistics in megabytes.

Todo:: Memory Statistics are not supported (by MythTV) on NT or DOS.

Returns: true if it succeeds, false otherwise.

Definition at line 107 of file mythmiscutil.cpp.

Referenced by StatusBox::doMachineStatus(), MainServer::HandleQueryMemStats(), BaseRequestHandler::HandleQueryMemStats(), and NetworkControl::processQuery().

◆ getLoadAvgs()

getLoadAvgs ( void )

Returns the system load averages.

Returns: A std::array<double,3> containing the system load averages. If the system call fails or is unsupported, returns array containing all -1.

Definition at line 174 of file mythmiscutil.cpp.

Referenced by StatusBox::doMachineStatus(), HttpStatus::FillStatusXML(), MainServer::HandleQueryLoad(), BaseRequestHandler::HandleQueryLoad(), and NetworkControl::processQuery().

◆ hasUtf8()

bool hasUtf8 ( const char * str )

Guess whether a string is UTF-8.

Note: This does not attempt to validate the whole string. It just checks if it has any UTF-8 sequences in it.

Definition at line 191 of file mythmiscutil.cpp.

◆ ping()

bool ping	(	const QString &	host,
		int	timeout
	)

Can we ping host within timeout seconds?

Different operating systems use different parameters to specify a timeout to the ping command. FreeBSD and derivatives use '-t'; Linux and derivatives use '-w'. Using the right parameter also eliminates the need for the old behavior of falling back to pinging the localhost with and without a timeout, in order to characterize whether the right parameter was used in the first place.

Note: If ping fails to timeout on another supported platform, determine what parameter that platform's ping requires to specify the timeout and add another case to the #ifdef statement.

Definition at line 243 of file mythmiscutil.cpp.

Referenced by CardUtil::IsVBoxPresent(), and setHttpProxy().

◆ telnet()

bool telnet	(	const QString &	host,
		int	port
	)

Can we talk to port on host?

Definition at line 274 of file mythmiscutil.cpp.

Referenced by setHttpProxy().

◆ copy()

copy	(	QFile &	dst,
		QFile &	src,
		uint	block_size
	)

Copies src file to dst file.

If the dst file is open, it must be open for writing. If the src file is open, if must be open for reading.

The files will be in the same open or close state after this function runs as they were prior to this function being called.

This function does not care if the files are actual files. For compatibility with pipes and socket streams the file location will not be reset to 0 at the end of this function. If the function is successful the file pointers will be at the end of the copied data.

Parameters

dst	Destination QFile
src	Source QFile
block_size	Optional block size in bytes, must be at least 1024, otherwise the default of 16 KB will be used.

Returns: bytes copied on success, -1 on failure.

Definition at line 305 of file mythmiscutil.cpp.

Referenced by MythNVDECInterop::Acquire(), TeletextReader::AddPageHeader(), TeletextReader::AddTeletextData(), RTjpeg::bcomp(), GalleryThumbView::Copy(), ImportMusicDialog::copyFile(), mythburn::copyRemote(), ProgramAssociationTable::CreateBlank(), ProgramMapTable::CreateBlank(), MythRAOPConnection::decodeAudioPacket(), mythburn::doProcessFile(), mythburn::doProcessFileProjectX(), MythRenderOpenGL::DrawBitmap(), dvb_decode_text(), NuppelVideoRecorder::FormatTT(), Jitterometer::GetCPUStat(), mythburn::getFileInformation(), ProgramInfoCache::GetOrdered(), MythVTBSurfaceInterop::GetReferenceFrames(), nv_python_libs.common.common_api.Common::getUrlData(), HLSStream::HLSStream(), TSPacket::InitPayload(), ImportRecorder::Open(), PList::ParseBinaryDate(), PList::ParseBinaryReal(), mythburn::preProcessFile(), ChannelImporter::Process(), MythRAOPConnection::ProcessRequest(), AudioOutputNULL::readOutputData(), MythDVDBuffer::SafeRead(), DiSEqCDevTree::SendCommand(), nv_python_libs.xsltfunctions.traileraddicts_api.xpathFunctions::traileraddictsLinkGenerationMovie(), ThumbFinder::updateThumb(), and NuppelVideoRecorder::WriteFileHeader().

◆ createTempFile()

QString createTempFile	(	QString	name_template,
		bool	dir
	)

Definition at line 365 of file mythmiscutil.cpp.

Referenced by DBUtil::CreateTemporaryDBConf(), and FillData::GrabData().

◆ makeFileAccessible()

bool makeFileAccessible ( const QString & filename )

Definition at line 437 of file mythmiscutil.cpp.

Referenced by Content::GetPreviewImage(), and PreviewGenerator::SavePreview().

◆ getResponse()

QString getResponse	(	const QString &	query,
		const QString &	def
	)

In an interactive shell, prompt the user to input a string.

Definition at line 452 of file mythmiscutil.cpp.

Referenced by intResponse(), ChannelData::promptForChannelUpdates(), and MythContextPrivate::PromptForDatabaseParams().

◆ intResponse()

int intResponse	(	const QString &	query,
		int	def
	)

In an interactive shell, prompt the user to input a number.

Definition at line 482 of file mythmiscutil.cpp.

Referenced by MythContextPrivate::PromptForDatabaseParams().

◆ getSymlinkTarget()

QString getSymlinkTarget	(	const QString &	start_file,
		QStringList *	intermediaries,
		unsigned	maxLinks
	)

Definition at line 493 of file mythmiscutil.cpp.

Referenced by CompleteJob(), MainServer::DeleteFile(), ProgramInfo::DiscoverRecordingDirectory(), MythMediaDevice::findMountPath(), MediaMonitor::MediaMonitor(), MythMediaDevice::MythMediaDevice(), and DeleteThread::ProcessNew().

◆ IsMACAddress()

bool IsMACAddress ( const QString & MAC )

Definition at line 545 of file mythmiscutil.cpp.

Referenced by MythWakeup(), and Scheduler::WakeUpSlave().

◆ FileHash()

QString FileHash ( const QString & filename )

Definition at line 590 of file mythmiscutil.cpp.

Referenced by Video::AddVideo(), RemoteFile::GetFileHash(), Content::GetHash(), MainServer::HandleQueryFileHash(), FileServerHandler::HandleQueryFileHash(), UpdateHashes(), and VideoMetadata::VideoFileHash().

◆ WakeOnLAN()

bool WakeOnLAN ( const QString & MAC )

Definition at line 631 of file mythmiscutil.cpp.

Referenced by MythWakeup(), and Scheduler::WakeUpSlave().

◆ MythWakeup()

bool MythWakeup	(	const QString &	wakeUpCommand,
		uint	flags,
		uint	timeout
	)

Definition at line 672 of file mythmiscutil.cpp.

Referenced by MythCoreContext::ConnectCommandSocket(), MSqlDatabase::OpenDatabase(), and MythContextPrivate::TestDBconnection().

◆ IsPulseAudioRunning()

bool IsPulseAudioRunning ( void )

Is A/V Sync destruction daemon is running on this host?

Definition at line 680 of file mythmiscutil.cpp.

Referenced by AudioOutput::OpenAudio(), and PulseHandler::Suspend().

◆ myth_nice()

bool myth_nice ( int val )

Definition at line 698 of file mythmiscutil.cpp.

Referenced by JobQueue::DoTranscodeThread(), JobQueue::DoUserJobThread(), MythSystemLegacyUnix::Fork(), MythPlayer::InitFrameInterval(), main(), and NuppelVideoRecorder::run().

◆ myth_yield()

void myth_yield ( void )

Definition at line 712 of file mythmiscutil.cpp.

◆ myth_ioprio()

bool myth_ioprio ( int )

Allows setting the I/O priority of the current process/thread.

range -1..8, smaller is higher priority

As of November 14th, 2010 this only works on Linux when using the CFQ I/O Scheduler. The range is -1 to 8, with -1 being real-time priority 0 through 7 being standard best-time priorities and 8 being the idle priority. The deadline and noop I/O Schedulers will ignore this but are much less likely to starve video playback to feed the transcoder or flagger. (noop is only recommended for SSDs.)

Since a process needs to have elevated priviledges to use either the real-time or idle priority this will try priorities 0 or 7 respectively if -1 or 8 do not work. It will not report an error on these conditions as they will be the common case.

Only Linux on i386, ppc, x86_64 and ia64 are currently supported. This is a no-op on all other architectures and platforms.

Definition at line 800 of file mythmiscutil.cpp.

Referenced by JobQueue::DoTranscodeThread(), JobQueue::DoUserJobThread(), MythSystemLegacyUnix::Fork(), and main().

◆ MythRemoveDirectory()

bool MythRemoveDirectory ( QDir & aDir )

Definition at line 804 of file mythmiscutil.cpp.

Referenced by NativeArchive::doNativeArchive(), MythBurn::MythBurn(), and MythRemoveDirectory().

◆ setHttpProxy()

void setHttpProxy ( void )

Get network proxy settings from OS, and use for [Q]Http[Comms].

The HTTP_PROXY environment var. is parsed for values like; "proxy-host", "proxy-host:8080", "http://host:8080" and "http"//user:password@host:1080", and that is used for any Qt-based Http fetches. We also test connectivity here with ping and telnet, and warn if it fails.

If there is was no env. var, we use Qt to get proxy settings from the OS, and search through them for a proxy server we can connect to.

Definition at line 848 of file mythmiscutil.cpp.

Referenced by main().

◆ wrapList()

void wrapList	(	QStringList &	list,
		int	width
	)

Definition at line 957 of file mythmiscutil.cpp.

Referenced by CommandLineArg::GetHelpString(), and CommandLineArg::GetLongHelpString().

◆ xml_indent()

QString xml_indent ( uint level )

Definition at line 1003 of file mythmiscutil.cpp.

◆ naturalCompare()

int naturalCompare	(	const QString &	_a,
		const QString &	_b,
		Qt::CaseSensitivity	caseSensitivity
	)

Definition at line 1029 of file mythmiscutil.cpp.

Referenced by comp_sorttitle_lt(), comp_sorttitle_lt_rev(), lt_callsign(), lt_smart(), VideoFilterSettings::meta_less_than(), plTitleSort::operator()(), plPrevTitleSort::operator()(), TitleSort::operator()(), ProgramCountSort::operator()(), ProgramRecCountSort::operator()(), ProgramLastRecordSort::operator()(), ProgramAvgDelaySort::operator()(), SingleValueImp::sort(), metadata_path_sort::sort(), VideoMetadataImp::sortBefore(), Bookmark::sortByName(), and NewsSite::sortByName().

◆ MythFormatTimeMs()

QString MythFormatTimeMs	(	int	msecs,
		const QString &	fmt
	)

Format a milliseconds time value.

Convert a millisecond time value into a textual representation of the value.

Parameters

msecs	The time value in milliseconds.
fmt	A formatting string specifying how to output the time. See QTime::toString for the a definition fo valid formatting characters.

Definition at line 1229 of file mythmiscutil.cpp.

Referenced by DeleteMap::CreateTimeString(), LyricsLine::formatTime(), commDetector2::frameToTimestamp(), commDetector2::frameToTimestampms(), AvFormatDecoder::OpenFile(), MusicMetadata::toMap(), and MythBDBuffer::UpdateTitleInfo().

◆ MythFormatTime()

QString MythFormatTime	(	int	secs,
		const QString &	fmt
	)

Format a seconds time value.

Convert a second time value into a textual representation of the value.

Parameters

secs	The time value in seconds.
mft	A formatting string specifying how to output the time. See QTime::toString for the a definition fo valid formatting characters.

Definition at line 1234 of file mythmiscutil.cpp.

Referenced by CommBreakMap::AutoCommercialSkip(), CommBreakMap::DoSkipCommercials(), ThumbFinder::frameToTime(), MusicCommon::getTimeString(), MythBDPlayer::GetTitleName(), TV::MenuItemDisplayPlayback(), TV::ShowLCDDVDInfo(), MythPlayerOverlayUI::UpdateSliderInfo(), and uptimeStr().

◆ MythSplitCommandString()

QStringList MythSplitCommandString ( const QString & line )

Definition at line 1256 of file mythmiscutil.cpp.

Referenced by MythExternRecApp::Cleanup(), MythExternRecApp::DataStarted(), MythExternRecApp::LoadChannels(), MythExternRecApp::NewEpisodeStarting(), MythExternRecApp::StartStreaming(), and MythExternRecApp::TuneChannel().

Enumerations

Functions

Enumeration Type Documentation

◆ states

Function Documentation

◆ getUptime()

◆ getMemStats()

◆ getLoadAvgs()

◆ hasUtf8()

◆ ping()

◆ telnet()

◆ copy()

◆ createTempFile()

◆ makeFileAccessible()

◆ getResponse()

◆ intResponse()

◆ getSymlinkTarget()

◆ IsMACAddress()

◆ FileHash()

◆ WakeOnLAN()

◆ MythWakeup()

◆ IsPulseAudioRunning()

◆ myth_nice()

◆ myth_yield()

◆ myth_ioprio()

◆ MythRemoveDirectory()

◆ setHttpProxy()

◆ wrapList()

◆ xml_indent()

◆ naturalCompare()

◆ MythFormatTimeMs()

◆ MythFormatTime()

◆ MythSplitCommandString()