/******************************************************************************\
* Copyright (c) 2004-2026
*
* Author(s):
* Volker Fischer
*
* As of Jamulus 3.12.1dev (commit eb172d47): All new source code contributions must be licensed
* under AGPL 3.0 or any later version.
*
* Existing code: Code contributed before 3.12.1dev (commit eb172d47) was licensed under GPL 2.0+.
* This code will be licensed under GPL 3.0 (or any later version) from
* 3.12.1dev (commit eb172d47). When distributed as part of Jamulus, the AGPL 3.0 terms govern
* the combined work, including network use provisions.
*
******************************************************************************
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see .
*
* ---------------------------------------------------------------------------
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*
\******************************************************************************/
#include "connectdlg.h"
#include
#if QT_VERSION >= QT_VERSION_CHECK( 6, 8, 0 )
# include
# include
#endif
/* Implementation *************************************************************/
// Subclass of QTreeWidgetItem that allows LVC_VERSION to sort by the UserRole data value
CMappedTreeWidgetItem::CMappedTreeWidgetItem ( QTreeWidget* owner ) : QTreeWidgetItem ( owner ), owner ( owner ) {}
bool CMappedTreeWidgetItem::operator<( const QTreeWidgetItem& other ) const
{
if ( !owner )
return QTreeWidgetItem::operator<( other );
int column = owner->sortColumn();
// we only need this override for comparing server versions
if ( column != CConnectDlg::LVC_VERSION )
return QTreeWidgetItem::operator<( other );
QVariant lhs = data ( column, Qt::UserRole );
QVariant rhs = other.data ( column, Qt::UserRole );
if ( !lhs.isValid() || !rhs.isValid() )
return QTreeWidgetItem::operator<( other );
return lhs.toString() < rhs.toString();
}
CConnectDlg::CConnectDlg ( CClient* pNCliP, CClientSettings* pNSetP, const bool bNewShowCompleteRegList, QWidget* parent ) :
CBaseDlg ( parent, Qt::Dialog ),
savedServer ( nullptr ),
pClient ( pNCliP ),
pSettings ( pNSetP ),
strSelectedAddress ( "" ),
strSelectedServerName ( "" ),
bShowCompleteRegList ( bNewShowCompleteRegList ),
bServerListReceived ( false ),
bReducedServerListReceived ( false ),
bServerListItemWasChosen ( false ),
bListFilterWasActive ( false ),
bShowAllMusicians ( true ),
iResolverSeq ( 0 )
{
setupUi ( this );
// Add help text to controls -----------------------------------------------
// directory
QString strDirectoryWT = "" + tr ( "Directory" ) + ": " +
tr ( "Shows the servers listed by the selected directory. "
"You can add custom directories in Advanced Settings." );
QString strDirectoryAN = tr ( "Directory combo box" );
lblList->setWhatsThis ( strDirectoryWT );
lblList->setAccessibleName ( strDirectoryAN );
cbxDirectory->setWhatsThis ( strDirectoryWT );
cbxDirectory->setAccessibleName ( strDirectoryAN );
// filter
QString strFilterWT = "" + tr ( "Filter" ) + ": " +
tr ( "Filters the server list by the given text. Note that the filter is case insensitive. "
"A single # character will filter for those servers with at least one person connected." );
QString strFilterAN = tr ( "Filter edit box" );
lblFilter->setWhatsThis ( strFilterWT );
edtFilter->setWhatsThis ( strFilterWT );
lblFilter->setAccessibleName ( strFilterAN );
edtFilter->setAccessibleName ( strFilterAN );
// show all mucisians
chbExpandAll->setWhatsThis ( "" + tr ( "Show All Musicians" ) + ": " +
tr ( "Uncheck to collapse the server list to show just the server details. "
"Check to show everyone on the servers." ) );
chbExpandAll->setAccessibleName ( tr ( "Show all musicians check box" ) );
// server list view
lvwServers->setWhatsThis ( "" + tr ( "Server List" ) + ": " +
tr ( "The Connection Setup window lists the available servers registered with "
"the selected directory. Use the Directory dropdown to change the directory, "
"find the server you want to join in the server list, click on it, and "
"then click the Connect button to connect. Alternatively, double click on "
"the server name to connect." ) +
"
" + tr ( "Permanent servers (those that have been listed for longer than 48 hours) are shown in bold." ) +
"
" + tr ( "You can add custom directories in Advanced Settings." ) );
lvwServers->setAccessibleName ( tr ( "Server list view" ) );
// server address
QString strServAddrH = "" + tr ( "Server Address" ) + ": " +
tr ( "If you know the server address, you can connect to it "
"using the Server name/Address field. An optional port number can be added after the server "
"address using a colon as a separator, e.g. %1. "
"The field will also show a list of the most recently used server addresses." )
.arg ( QString ( "example.org:%1" ).arg ( DEFAULT_PORT_NUMBER ) );
lblServerAddr->setWhatsThis ( strServAddrH );
cbxServerAddr->setWhatsThis ( strServAddrH );
cbxServerAddr->setAccessibleName ( tr ( "Server address edit box" ) );
cbxServerAddr->setAccessibleDescription ( tr ( "Holds the current server address. It also stores old addresses in the combo box list." ) );
tbtDeleteServerAddr->setAccessibleName ( tr ( "Delete server address button" ) );
tbtDeleteServerAddr->setWhatsThis ( "" + tr ( "Delete Server Address" ) + ": " +
tr ( "Click the button to clear the currently selected server address "
"and delete it from the list of stored servers." ) );
tbtDeleteServerAddr->setText ( u8"\u232B" );
UpdateDirectoryComboBox();
// init server address combo box (max MAX_NUM_SERVER_ADDR_ITEMS entries)
cbxServerAddr->setMaxCount ( MAX_NUM_SERVER_ADDR_ITEMS );
cbxServerAddr->setInsertPolicy ( QComboBox::NoInsert );
// install event filter to catch FocusIn
cbxServerAddr->installEventFilter ( this );
lvwServers->installEventFilter ( this );
// set up list view for connected clients (note that the last column size
// must not be specified since this column takes all the remaining space)
#ifdef ANDROID
// for Android we need larger numbers because of the default font size
lvwServers->setColumnWidth ( LVC_NAME, 200 );
lvwServers->setColumnWidth ( LVC_PING, 130 );
lvwServers->setColumnWidth ( LVC_CLIENTS, 100 );
lvwServers->setColumnWidth ( LVC_VERSION, 150 );
#else
lvwServers->setColumnWidth ( LVC_NAME, 180 );
lvwServers->setColumnWidth ( LVC_PING, 75 );
lvwServers->setColumnWidth ( LVC_CLIENTS, 70 );
lvwServers->setColumnWidth ( LVC_LOCATION, 220 );
lvwServers->setColumnWidth ( LVC_VERSION, 135 );
#endif
lvwServers->clear();
// make sure we do not get a too long horizontal scroll bar
lvwServers->header()->setStretchLastSection ( false );
// add invisible columns which are used for sorting the list and storing
// the current/maximum number of clients
// 0: server name
// 1: ping time
// 2: number of musicians (including additional strings like " (full)")
// 3: location
// 4: server version
// 5: minimum ping time (invisible)
// 6: maximum number of clients (invisible)
// (see EConnectListViewColumns in connectdlg.h, which must match the above)
lvwServers->setColumnCount ( LVC_COLUMNS );
lvwServers->hideColumn ( LVC_PING_MIN_HIDDEN );
lvwServers->hideColumn ( LVC_CLIENTS_MAX_HIDDEN );
// per default the root shall not be decorated (to save space)
lvwServers->setRootIsDecorated ( false );
// make sure the connect button has the focus
butConnect->setFocus();
// for "show all servers" mode make sort by click on header possible
if ( bShowCompleteRegList )
{
lvwServers->setSortingEnabled ( true );
lvwServers->sortItems ( LVC_NAME, Qt::AscendingOrder );
}
// set a placeholder text to explain how to filter occupied servers (#397)
edtFilter->setPlaceholderText ( tr ( "Filter text, or # for occupied servers" ) );
// setup timers
TimerInitialSort.setSingleShot ( true ); // only once after list request
#if defined( ANDROID ) || defined( Q_OS_IOS )
// for the Android and iOS version maximize the window
setWindowState ( Qt::WindowMaximized );
#endif
// Connections -------------------------------------------------------------
// list view
QObject::connect ( lvwServers, &QTreeWidget::itemDoubleClicked, this, &CConnectDlg::OnServerListItemDoubleClicked );
// to get default return key behaviour working
QObject::connect ( lvwServers, &QTreeWidget::activated, this, &CConnectDlg::OnConnectClicked );
QObject::connect ( lvwServers, &QTreeWidget::currentItemChanged, this, &CConnectDlg::OnCurrentServerItemChanged );
// line edit
QObject::connect ( edtFilter, &QLineEdit::textEdited, this, &CConnectDlg::OnFilterTextEdited );
// combo boxes
QObject::connect ( cbxDirectory, static_cast ( &QComboBox::activated ), this, &CConnectDlg::OnDirectoryChanged );
// connect when pressing Enter in the Server Address box
QObject::connect ( cbxServerAddr->lineEdit(), &QLineEdit::returnPressed, this, &CConnectDlg::OnConnectClicked );
// check boxes
QObject::connect ( chbExpandAll, &QCheckBox::stateChanged, this, &CConnectDlg::OnExpandAllStateChanged );
// buttons
QObject::connect ( butCancel, &QPushButton::clicked, this, &CConnectDlg::close );
QObject::connect ( butConnect, &QPushButton::clicked, this, &CConnectDlg::OnConnectClicked );
// tool buttons
QObject::connect ( tbtDeleteServerAddr, &QToolButton::clicked, this, &CConnectDlg::OnDeleteServerAddrClicked );
// timers
QObject::connect ( &TimerPing, &QTimer::timeout, this, &CConnectDlg::OnTimerPing );
QObject::connect ( &TimerReRequestServList, &QTimer::timeout, this, &CConnectDlg::OnTimerReRequestServList );
}
void CConnectDlg::showEvent ( QShowEvent* )
{
// load stored IP addresses in combo box
cbxServerAddr->clear();
cbxServerAddr->clearEditText();
for ( int iLEIdx = 0; iLEIdx < MAX_NUM_SERVER_ADDR_ITEMS; iLEIdx++ )
{
if ( !pSettings->vstrIPAddress[iLEIdx].isEmpty() )
{
cbxServerAddr->addItem ( pSettings->vstrIPAddress[iLEIdx] );
}
}
// on opening the connect dialg, we always want to request a
// new updated server list per definition
RequestServerList();
}
void CConnectDlg::RequestServerList()
{
// ensure ping timer is stopped
TimerPing.stop();
// reset flags
bServerListReceived = false;
bReducedServerListReceived = false;
bServerListItemWasChosen = false;
bListFilterWasActive = false;
// clear current address and name
strSelectedAddress = "";
strSelectedServerName = "";
// clear server list view
savedServer = nullptr;
lvwServers->clear();
// update list combo box (disable events to avoid a signal)
cbxDirectory->blockSignals ( true );
if ( pSettings->eDirectoryType == AT_CUSTOM )
{
// iCustomDirectoryIndex is non-zero only if eDirectoryType == AT_CUSTOM
// find the combobox item that corresponds to vstrDirectoryAddress[iCustomDirectoryIndex]
// (the current selected custom directory)
cbxDirectory->setCurrentIndex ( cbxDirectory->findData ( QVariant ( pSettings->iCustomDirectoryIndex ) ) );
}
else
{
cbxDirectory->setCurrentIndex ( static_cast ( pSettings->eDirectoryType ) );
}
cbxDirectory->blockSignals ( false );
// Get the IP address of the directory server (using the async ResolveAddress
// function) when the connect dialog is opened, this seems to be the correct
// time to do it. Note that in case of custom directories we
// use iCustomDirectoryIndex as an index into the vector.
// Currently allow only IPv4 for communicating with Directories
const QString strDirectoryAddress =
NetworkUtil::GetDirectoryAddress ( pSettings->eDirectoryType, pSettings->vstrDirectoryAddress[pSettings->iCustomDirectoryIndex] );
// get a new sequence number for matching the resolved callback
const int seq = ++iResolverSeq;
if ( !NetworkUtil::ResolveAddress (
strDirectoryAddress,
false, // IPv4 only at present
this,
[this, seq] ( const QHostInfo& info, quint16 port ) {
// check that the request has not been superseded
if ( seq == iResolverSeq )
{
OnHostResolved ( info, port ); // handle result
}
},
true, // allow hostname resolution
true ) ) // allow SVR resolution
{
qWarning() << "Cannot start directory fetch from" << strDirectoryAddress;
}
}
void CConnectDlg::OnHostResolved ( const QHostInfo& info, quint16 port )
{
if ( info.error() != QHostInfo::NoError )
{
qWarning() << "Directory lookup failed:" << info.errorString();
return;
}
for ( const QHostAddress& HostAddr : info.addresses() )
{
// qInfo() << "Resolved network address to" << HostAddr << "for proto" << HostAddr.protocol();
if ( HostAddr.protocol() == QAbstractSocket::IPv4Protocol /* ||
( HostAddr.protocol() == QAbstractSocket::IPv6Protocol && pClient->IsIPv6Available() ) */ )
{
haDirectoryAddress = CHostAddress ( HostAddr, port );
// send the request for the server list
emit ReqServerListQuery ( haDirectoryAddress );
// start timer, if this message did not get any respond to retransmit
// the server list request message
TimerReRequestServList.start ( SERV_LIST_REQ_UPDATE_TIME_MS );
TimerInitialSort.start ( SERV_LIST_REQ_UPDATE_TIME_MS ); // reuse the time value
return;
}
}
}
void CConnectDlg::hideEvent ( QHideEvent* )
{
// if window is closed, stop timers
TimerPing.stop();
TimerReRequestServList.stop();
}
void CConnectDlg::OnDirectoryChanged ( int iTypeIdx )
{
// store the new directory type and request new list
// if iTypeIdx == AT_CUSTOM, then iCustomDirectoryIndex is the index into the vector holding the user's custom directory servers
// if iTypeIdx != AT_CUSTOM, then iCustomDirectoryIndex MUST be 0;
if ( iTypeIdx >= AT_CUSTOM )
{
// the value for the index into the vector vstrDirectoryAddress is in the user data of the combobox item
pSettings->iCustomDirectoryIndex = cbxDirectory->itemData ( iTypeIdx ).toInt();
iTypeIdx = AT_CUSTOM;
}
else
{
pSettings->iCustomDirectoryIndex = 0;
}
pSettings->eDirectoryType = static_cast ( iTypeIdx );
RequestServerList();
}
void CConnectDlg::OnTimerReRequestServList()
{
// if the server list is not yet received, retransmit the request for the
// server list
if ( !bServerListReceived )
{
// note that this is a connection less message which may get lost
// and therefore it makes sense to re-transmit it
emit ReqServerListQuery ( haDirectoryAddress );
}
}
void CConnectDlg::SetServerList ( const CHostAddress& InetAddr, const CVector& vecServerInfo, const bool bIsReducedServerList )
{
// If the normal list was received, we do not accept any further list
// updates (to avoid the reduced list overwrites the normal list (#657)). Also,
// we only accept a server list from the server address we have sent the
// request for this to (note that we cannot use the port number since the
// receive port and send port might be different at the directory server).
if ( bServerListReceived || ( InetAddr.InetAddr != haDirectoryAddress.InetAddr ) )
{
return;
}
// special treatment if a reduced server list was received
if ( bIsReducedServerList )
{
// make sure we only apply the reduced version list once
if ( bReducedServerListReceived )
{
// do nothing
return;
}
else
{
bReducedServerListReceived = true;
}
}
else
{
// set flag and disable timer for resend server list request if full list
// was received (i.e. not the reduced list)
bServerListReceived = true;
TimerReRequestServList.stop();
}
// first clear list
savedServer = nullptr;
lvwServers->clear();
// add list item for each server in the server list
const int iServerInfoLen = vecServerInfo.Size();
for ( int iIdx = 0; iIdx < iServerInfoLen; iIdx++ )
{
// get the host address, note that for the very first entry which is
// the directory server, we have to use the receive host address
// instead
CHostAddress CurHostAddress;
if ( iIdx > 0 )
{
CurHostAddress = vecServerInfo[iIdx].HostAddr;
}
else
{
// substitute the receive host address for directory server
CurHostAddress = InetAddr;
}
// create new list view item
CMappedTreeWidgetItem* pNewListViewItem = new CMappedTreeWidgetItem ( lvwServers );
// make the entry invisible (will be set to visible on successful ping
// result) if the complete list of registered servers shall not be shown
if ( !bShowCompleteRegList )
{
pNewListViewItem->setHidden ( true );
}
// server name (if empty, show host address instead)
if ( !vecServerInfo[iIdx].strName.isEmpty() )
{
pNewListViewItem->setText ( LVC_NAME, vecServerInfo[iIdx].strName );
}
else
{
// IP address and port (use IP number without last byte)
// Definition: If the port number is the default port number, we do
// not show it.
if ( vecServerInfo[iIdx].HostAddr.iPort == DEFAULT_PORT_NUMBER )
{
// only show IP number, no port number
pNewListViewItem->setText ( LVC_NAME, CurHostAddress.toString ( CHostAddress::SM_IP_NO_LAST_BYTE ) );
}
else
{
// show IP number and port
pNewListViewItem->setText ( LVC_NAME, CurHostAddress.toString ( CHostAddress::SM_IP_NO_LAST_BYTE_PORT ) );
}
}
// in case of all servers shown, add the registration number at the beginning
if ( bShowCompleteRegList )
{
pNewListViewItem->setText ( LVC_NAME, QString ( "%1: " ).arg ( 1 + iIdx, 3 ) + pNewListViewItem->text ( LVC_NAME ) );
}
// show server name in bold font if it is a permanent server
QFont CurServerNameFont = pNewListViewItem->font ( LVC_NAME );
CurServerNameFont.setBold ( vecServerInfo[iIdx].bPermanentOnline );
pNewListViewItem->setFont ( LVC_NAME, CurServerNameFont );
// the ping time shall be shown in bold font
QFont CurPingTimeFont = pNewListViewItem->font ( LVC_PING );
CurPingTimeFont.setBold ( true );
pNewListViewItem->setFont ( LVC_PING, CurPingTimeFont );
// server location (city and country)
QString strLocation = vecServerInfo[iIdx].strCity;
if ( ( !strLocation.isEmpty() ) && ( vecServerInfo[iIdx].eCountry != QLocale::AnyCountry ) )
{
strLocation += ", ";
}
if ( vecServerInfo[iIdx].eCountry != QLocale::AnyCountry )
{
QString strCountryToString = QLocale::countryToString ( vecServerInfo[iIdx].eCountry );
// Qt countryToString does not use spaces in between country name
// parts but they use upper case letters which we can detect and
// insert spaces as a post processing
#if QT_VERSION >= QT_VERSION_CHECK( 5, 0, 0 )
if ( !strCountryToString.contains ( " " ) )
{
QRegularExpressionMatchIterator reMatchIt = QRegularExpression ( "[A-Z][^A-Z]*" ).globalMatch ( strCountryToString );
QStringList slNames;
while ( reMatchIt.hasNext() )
{
slNames << reMatchIt.next().capturedTexts();
}
strCountryToString = slNames.join ( " " );
}
#endif
strLocation += strCountryToString;
}
pNewListViewItem->setText ( LVC_LOCATION, strLocation );
// init the minimum ping time with a large number (note that this number
// must fit in an integer type)
pNewListViewItem->setText ( LVC_PING_MIN_HIDDEN, "99999999" );
// store the maximum number of clients
pNewListViewItem->setText ( LVC_CLIENTS_MAX_HIDDEN, QString().setNum ( vecServerInfo[iIdx].iMaxNumClients ) );
// store host address
pNewListViewItem->setData ( LVC_NAME, Qt::UserRole, CurHostAddress.toString() );
// per default expand the list item (if not "show all servers")
if ( bShowAllMusicians )
{
lvwServers->expandItem ( pNewListViewItem );
}
}
// only if the ping timer is not already running (avoids double ping):
// immediately issue the ping measurements and start the ping timer since
// the server list is filled now
if ( !TimerPing.isActive() )
{
OnTimerPing();
TimerPing.start ( PING_UPDATE_TIME_SERVER_LIST_MS );
}
}
void CConnectDlg::SetConnClientsList ( const CHostAddress& InetAddr, const CVector& vecChanInfo )
{
// find the server with the correct address
CMappedTreeWidgetItem* pCurListViewItem = FindListViewItem ( InetAddr );
if ( pCurListViewItem )
{
// first remove any existing children
DeleteAllListViewItemChildren ( pCurListViewItem );
// get number of connected clients
const int iNumConnectedClients = vecChanInfo.Size();
for ( int i = 0; i < iNumConnectedClients; i++ )
{
// create new list view item
QTreeWidgetItem* pNewChildListViewItem = new QTreeWidgetItem ( static_cast ( pCurListViewItem ) );
// child items shall use only one column
pNewChildListViewItem->setFirstColumnSpanned ( true );
// set the clients name
QString sClientText = vecChanInfo[i].strName;
// set the icon: country flag has priority over instrument
bool bCountryFlagIsUsed = false;
if ( vecChanInfo[i].eCountry != QLocale::AnyCountry )
{
pNewChildListViewItem->setData ( LVC_NAME, Qt::UserRole, QLocale::countryToString ( vecChanInfo[i].eCountry ) );
// try to load the country flag icon
QPixmap CountryFlagPixmap ( CLocale::GetCountryFlagIconsResourceReference ( vecChanInfo[i].eCountry ) );
// first check if resource reference was valid
if ( !CountryFlagPixmap.isNull() )
{
// set correct picture
pNewChildListViewItem->setIcon ( LVC_NAME, QIcon ( CountryFlagPixmap ) );
bCountryFlagIsUsed = true;
}
}
if ( !bCountryFlagIsUsed )
{
// get the resource reference string for this instrument
const QString strCurResourceRef = CInstPictures::GetResourceReference ( vecChanInfo[i].iInstrument );
// first check if instrument picture is used or not and if it is valid
if ( !( CInstPictures::IsNotUsedInstrument ( vecChanInfo[i].iInstrument ) || strCurResourceRef.isEmpty() ) )
{
// set correct picture
pNewChildListViewItem->setIcon ( LVC_NAME, QIcon ( QPixmap ( strCurResourceRef ) ) );
}
}
// add the instrument information as text
if ( !CInstPictures::IsNotUsedInstrument ( vecChanInfo[i].iInstrument ) )
{
sClientText.append ( " (" + CInstPictures::GetName ( vecChanInfo[i].iInstrument ) + ")" );
}
// apply the client text to the list view item
pNewChildListViewItem->setText ( LVC_NAME, sClientText );
// add the new child to the corresponding server item
pCurListViewItem->addChild ( pNewChildListViewItem );
// at least one server has children now, show decoration to be able
// to show the children
lvwServers->setRootIsDecorated ( true );
}
// the clients list may have changed, update the filter selection
UpdateListFilter();
}
}
void CConnectDlg::OnServerListItemDoubleClicked ( QTreeWidgetItem* Item, int )
{
// if a server list item was double clicked, it is the same as if the
// connect button was clicked
if ( Item != nullptr )
{
OnConnectClicked();
}
}
void CConnectDlg::OnCustomDirectoriesChanged()
{
QString strPreviousSelection = cbxDirectory->currentText();
UpdateDirectoryComboBox();
// after updating the combobox, we must re-select the previous directory selection
if ( pSettings->eDirectoryType == AT_CUSTOM )
{
// check if the currently select custom directory still exists in the now potentially re-ordered vector,
// if so, then change to its new index. (addresses Issue #1899)
int iNewIndex = cbxDirectory->findText ( strPreviousSelection, Qt::MatchExactly );
if ( iNewIndex == INVALID_INDEX )
{
// previously selected custom directory has been deleted. change to default directory
pSettings->eDirectoryType = static_cast ( AT_DEFAULT );
pSettings->iCustomDirectoryIndex = 0;
RequestServerList();
}
else
{
// find previously selected custom directory in the now potentially re-ordered vector
pSettings->eDirectoryType = static_cast ( AT_CUSTOM );
pSettings->iCustomDirectoryIndex = cbxDirectory->itemData ( iNewIndex ).toInt();
cbxDirectory->blockSignals ( true );
cbxDirectory->setCurrentIndex ( cbxDirectory->findData ( QVariant ( pSettings->iCustomDirectoryIndex ) ) );
cbxDirectory->blockSignals ( false );
}
}
else
{
// selected directory was not a custom directory
cbxDirectory->blockSignals ( true );
cbxDirectory->setCurrentIndex ( static_cast ( pSettings->eDirectoryType ) );
cbxDirectory->blockSignals ( false );
}
}
void CConnectDlg::ShowAllMusicians ( const bool bState )
{
bShowAllMusicians = bState;
// update list
if ( bState )
{
lvwServers->expandAll();
}
else
{
lvwServers->collapseAll();
}
// update check box if necessary
if ( ( chbExpandAll->checkState() == Qt::Checked && !bShowAllMusicians ) || ( chbExpandAll->checkState() == Qt::Unchecked && bShowAllMusicians ) )
{
chbExpandAll->setCheckState ( bState ? Qt::Checked : Qt::Unchecked );
}
}
void CConnectDlg::UpdateListFilter()
{
const QString sFilterText = edtFilter->text();
if ( !sFilterText.isEmpty() )
{
bListFilterWasActive = true;
const int iServerListLen = lvwServers->topLevelItemCount();
for ( int iIdx = 0; iIdx < iServerListLen; iIdx++ )
{
CMappedTreeWidgetItem* pCurListViewItem = static_cast ( lvwServers->topLevelItem ( iIdx ) );
bool bFilterFound = false;
// DEFINITION: if "#" is set at the beginning of the filter text, we show
// occupied servers (#397)
if ( ( sFilterText.indexOf ( "#" ) == 0 ) && ( sFilterText.length() == 1 ) )
{
// special case: filter for occupied servers
if ( pCurListViewItem->childCount() > 0 )
{
bFilterFound = true;
}
}
else
{
// search server name
if ( pCurListViewItem->text ( LVC_NAME ).indexOf ( sFilterText, 0, Qt::CaseInsensitive ) >= 0 )
{
bFilterFound = true;
}
// search location
if ( pCurListViewItem->text ( LVC_LOCATION ).indexOf ( sFilterText, 0, Qt::CaseInsensitive ) >= 0 )
{
bFilterFound = true;
}
// search version
if ( pCurListViewItem->text ( LVC_VERSION ).indexOf ( sFilterText, 0, Qt::CaseInsensitive ) >= 0 )
{
bFilterFound = true;
}
// search children
for ( int iCCnt = 0; iCCnt < pCurListViewItem->childCount(); iCCnt++ )
{
if ( pCurListViewItem->child ( iCCnt )->text ( LVC_NAME ).indexOf ( sFilterText, 0, Qt::CaseInsensitive ) >= 0 )
{
bFilterFound = true;
}
}
}
// only update Hide state if ping time was received
if ( !pCurListViewItem->text ( LVC_PING ).isEmpty() || bShowCompleteRegList )
{
// only update hide and expand status if the hide state has to be changed to
// preserve if user clicked on expand icon manually
if ( ( pCurListViewItem->isHidden() && bFilterFound ) || ( !pCurListViewItem->isHidden() && !bFilterFound ) )
{
pCurListViewItem->setHidden ( !bFilterFound );
pCurListViewItem->setExpanded ( bShowAllMusicians );
}
}
}
}
else
{
// if the filter was active but is now disabled, we have to update all list
// view items for the "ping received" hide state
if ( bListFilterWasActive )
{
const int iServerListLen = lvwServers->topLevelItemCount();
for ( int iIdx = 0; iIdx < iServerListLen; iIdx++ )
{
CMappedTreeWidgetItem* pCurListViewItem = static_cast ( lvwServers->topLevelItem ( iIdx ) );
// if ping time is empty, hide item (if not already hidden)
if ( pCurListViewItem->text ( LVC_PING ).isEmpty() && !bShowCompleteRegList )
{
pCurListViewItem->setHidden ( true );
}
else
{
// in case it was hidden, show it and take care of expand
if ( pCurListViewItem->isHidden() )
{
pCurListViewItem->setHidden ( false );
pCurListViewItem->setExpanded ( bShowAllMusicians );
}
}
}
bListFilterWasActive = false;
}
}
}
void CConnectDlg::OnConnectClicked()
{
// get the IP address to be used according to the following definitions:
// - if the list has focus and a line is selected, use this line
// - if the list has no focus, use the current combo box text
QList CurSelListItemList = lvwServers->selectedItems();
if ( CurSelListItemList.count() > 0 )
{
// get the parent list view item
CMappedTreeWidgetItem* pCurSelTopListItem = GetParentListViewItem ( CurSelListItemList[0] );
// get host address from selected list view item as a string
strSelectedAddress = pCurSelTopListItem->data ( LVC_NAME, Qt::UserRole ).toString();
// store selected server name
strSelectedServerName = pCurSelTopListItem->text ( LVC_NAME );
// set flag that a server list item was chosen to connect
bServerListItemWasChosen = true;
}
else
{
strSelectedAddress = NetworkUtil::FixAddress ( cbxServerAddr->currentText() );
}
// tell the parent window that the connection shall be initiated
done ( QDialog::Accepted );
}
void CConnectDlg::OnDeleteServerAddrClicked()
{
if ( cbxServerAddr->currentText().isEmpty() )
{
return;
}
// move later items down one
for ( int iLEIdx = 0; iLEIdx < MAX_NUM_SERVER_ADDR_ITEMS - 1; iLEIdx++ )
{
while ( pSettings->vstrIPAddress[iLEIdx].compare ( cbxServerAddr->currentText() ) == 0 )
{
for ( int jLEIdx = iLEIdx + 1; jLEIdx < MAX_NUM_SERVER_ADDR_ITEMS; jLEIdx++ )
{
pSettings->vstrIPAddress[jLEIdx - 1] = pSettings->vstrIPAddress[jLEIdx];
}
}
}
// empty last entry
pSettings->vstrIPAddress[MAX_NUM_SERVER_ADDR_ITEMS - 1] = QString();
// redisplay to pick up updated list
showEvent ( nullptr );
}
void CConnectDlg::OnTimerPing()
{
// send ping messages to the servers in the list
const int iServerListLen = lvwServers->topLevelItemCount();
for ( int iIdx = 0; iIdx < iServerListLen; iIdx++ )
{
QTreeWidgetItem* pCurListViewItem = lvwServers->topLevelItem ( iIdx );
// we need to ask for the server version only if we have not received it
const bool bNeedVersion = pCurListViewItem->text ( LVC_VERSION ).isEmpty();
CHostAddress haServerAddress;
// try to parse host address string which is stored as user data
// in the server list item GUI control element
// the data to be parsed is just IP:port, so no hostname lookup is needed
if ( NetworkUtil::ParseAddressLiteral ( pCurListViewItem->data ( LVC_NAME, Qt::UserRole ).toString(),
pClient->IsIPv6Available(),
haServerAddress ) )
{
// if address is valid, send ping message using a new thread
#if QT_VERSION >= QT_VERSION_CHECK( 6, 0, 0 )
QFuture f = QtConcurrent::run ( &CConnectDlg::EmitCLServerListPingMes, this, haServerAddress, bNeedVersion );
Q_UNUSED ( f );
#else
QtConcurrent::run ( this, &CConnectDlg::EmitCLServerListPingMes, haServerAddress, bNeedVersion );
#endif
}
}
}
void CConnectDlg::EmitCLServerListPingMes ( const CHostAddress& haServerAddress, const bool bNeedVersion )
{
// The ping time messages for all servers should not be sent all in a very
// short time since it showed that this leads to errors in the ping time
// measurement (#49). We therefore introduce a short delay for each server
// (since we are doing this in a separate thread for each server, we do not
// block the GUI).
QThread::msleep ( 11 );
// first request the server version if we have not already received it
if ( bNeedVersion )
{
emit CreateCLServerListReqVerAndOSMes ( haServerAddress );
}
emit CreateCLServerListPingMes ( haServerAddress );
}
void CConnectDlg::SetPingTimeAndNumClientsResult ( const CHostAddress& InetAddr, const int iPingTime, const int iNumClients )
{
// apply the received ping time to the correct server list entry
CMappedTreeWidgetItem* pCurListViewItem = FindListViewItem ( InetAddr );
if ( pCurListViewItem )
{
// check if this is the first time a ping time is set
const bool bIsFirstPing = pCurListViewItem->text ( LVC_PING ).isEmpty();
bool bDoSorting = false;
// update minimum ping time column (invisible, used for sorting) if
// the new value is smaller than the old value
int iMinPingTime = pCurListViewItem->text ( LVC_PING_MIN_HIDDEN ).toInt();
if ( iMinPingTime > iPingTime )
{
// update the minimum ping time with the new lowest value
iMinPingTime = iPingTime;
// we pad to a total of 8 characters with zeros to make sure the
// sorting is done correctly
pCurListViewItem->setText ( LVC_PING_MIN_HIDDEN, QString ( "%1" ).arg ( iPingTime, 8, 10, QLatin1Char ( '0' ) ) );
// update the sorting (lowest number on top)
bDoSorting = true;
}
// for debugging it is good to see the current ping time in the list
// and not the minimum ping time -> overwrite the value for debugging
if ( bShowCompleteRegList )
{
iMinPingTime = iPingTime;
}
// Only show minimum ping time in the list since this is the important
// value. Temporary bad ping measurements are of no interest.
// Color definition: <= 25 ms green, <= 50 ms yellow, otherwise red
if ( iMinPingTime <= 25 )
{
pCurListViewItem->setForeground ( LVC_PING, Qt::darkGreen );
}
else
{
if ( iMinPingTime <= 50 )
{
pCurListViewItem->setForeground ( LVC_PING, Qt::darkYellow );
}
else
{
pCurListViewItem->setForeground ( LVC_PING, Qt::red );
}
}
// update ping text, take special care if ping time exceeds a
// certain value
if ( iMinPingTime > 500 )
{
pCurListViewItem->setText ( LVC_PING, ">500 ms" );
}
else
{
// prepend spaces so that we can sort correctly (fieldWidth of
// 4 is sufficient since the maximum width is ">500") (#201)
pCurListViewItem->setText ( LVC_PING, QString ( "%1 ms" ).arg ( iMinPingTime, 4, 10, QLatin1Char ( ' ' ) ) );
}
// update number of clients text
if ( pCurListViewItem->text ( LVC_CLIENTS_MAX_HIDDEN ).toInt() == 0 )
{
// special case: reduced server list
pCurListViewItem->setText ( LVC_CLIENTS, QString().setNum ( iNumClients ) );
}
else if ( iNumClients >= pCurListViewItem->text ( LVC_CLIENTS_MAX_HIDDEN ).toInt() )
{
pCurListViewItem->setText ( LVC_CLIENTS, QString().setNum ( iNumClients ) + " (full)" );
}
else
{
pCurListViewItem->setText ( LVC_CLIENTS, QString().setNum ( iNumClients ) + "/" + pCurListViewItem->text ( LVC_CLIENTS_MAX_HIDDEN ) );
}
// check if the number of child list items matches the number of
// connected clients, if not then request the client names
if ( iNumClients != pCurListViewItem->childCount() )
{
emit CreateCLServerListReqConnClientsListMes ( InetAddr );
}
// this is the first time a ping time was received, set item to visible
if ( bIsFirstPing )
{
pCurListViewItem->setHidden ( false );
if ( pCurListViewItem == lvwServers->currentItem() )
{
OnCurrentServerItemChanged ( pCurListViewItem, nullptr );
}
}
// Update sorting. Note that the sorting must be the last action for the
// current item since the topLevelItem(iIdx) is then no longer valid.
// To avoid that the list is sorted shortly before a double click (which
// could lead to connecting an incorrect server) the sorting is disabled
// as long as the mouse is over the list (but it is not disabled for the
// initial timer of about 2s, see TimerInitialSort) (#293).
if ( bDoSorting && !bShowCompleteRegList &&
( TimerInitialSort.isActive() || !lvwServers->underMouse() ) ) // do not sort if "show all servers"
{
lvwServers->sortByColumn ( LVC_PING_MIN_HIDDEN, Qt::AscendingOrder );
}
}
// if no server item has children, do not show decoration
bool bAnyListItemHasChildren = false;
const int iServerListLen = lvwServers->topLevelItemCount();
for ( int iIdx = 0; iIdx < iServerListLen; iIdx++ )
{
// check if the current list item has children
if ( lvwServers->topLevelItem ( iIdx )->childCount() > 0 )
{
bAnyListItemHasChildren = true;
}
}
if ( !bAnyListItemHasChildren )
{
lvwServers->setRootIsDecorated ( false );
}
// we may have changed the Hidden state for some items, if a filter was active, we now
// have to update it to void lines appear which do not satisfy the filter criteria
UpdateListFilter();
}
void CConnectDlg::SetServerVersionResult ( const CHostAddress& InetAddr, const QString& strVersion )
{
// apply the received server version to the correct server list entry
CMappedTreeWidgetItem* pCurListViewItem = FindListViewItem ( InetAddr );
if ( pCurListViewItem )
{
pCurListViewItem->setText ( LVC_VERSION, GetDisplayVersion ( strVersion ) );
// and store sortable mapped version number
pCurListViewItem->setData ( LVC_VERSION, Qt::UserRole, MapVersionStrForCompare ( strVersion ) );
if ( pCurListViewItem == lvwServers->currentItem() )
{
OnCurrentServerItemChanged ( pCurListViewItem, nullptr );
}
}
}
CMappedTreeWidgetItem* CConnectDlg::FindListViewItem ( const CHostAddress& InetAddr )
{
const int iServerListLen = lvwServers->topLevelItemCount();
for ( int iIdx = 0; iIdx < iServerListLen; iIdx++ )
{
// compare the received address with the user data string of the
// host address by a string compare
if ( !lvwServers->topLevelItem ( iIdx )->data ( LVC_NAME, Qt::UserRole ).toString().compare ( InetAddr.toString() ) )
{
return static_cast ( lvwServers->topLevelItem ( iIdx ) );
}
}
return nullptr;
}
CMappedTreeWidgetItem* CConnectDlg::GetParentListViewItem ( QTreeWidgetItem* pItem )
{
// check if the current item is already the top item, i.e. the parent
// query fails and returns null
if ( pItem->parent() )
{
// we only have maximum one level, i.e. if we call the parent function
// we are at the top item
return static_cast ( pItem->parent() );
}
else
{
// this item is already the top item
return static_cast ( pItem );
}
}
void CConnectDlg::DeleteAllListViewItemChildren ( QTreeWidgetItem* pItem )
{
// loop over all children
while ( pItem->childCount() > 0 )
{
// get the first child in the list
QTreeWidgetItem* pCurChild = pItem->child ( 0 );
// remove it from the item (note that the object is not deleted)
pItem->removeChild ( pCurChild );
// delete the object to avoid a memory leak
delete pCurChild;
}
}
void CConnectDlg::UpdateDirectoryComboBox()
{
// directory type combo box
cbxDirectory->clear();
cbxDirectory->addItem ( DirectoryTypeToString ( AT_DEFAULT ) );
cbxDirectory->addItem ( DirectoryTypeToString ( AT_ANY_GENRE2 ) );
cbxDirectory->addItem ( DirectoryTypeToString ( AT_ANY_GENRE_ASIA ) );
cbxDirectory->addItem ( DirectoryTypeToString ( AT_GENRE_ROCK ) );
cbxDirectory->addItem ( DirectoryTypeToString ( AT_GENRE_JAZZ ) );
cbxDirectory->addItem ( DirectoryTypeToString ( AT_GENRE_CLASSICAL_FOLK ) );
cbxDirectory->addItem ( DirectoryTypeToString ( AT_GENRE_CHORAL ) );
// because custom directories are always added to the top of the vector, add the vector
// contents to the combobox in reverse order
for ( int i = MAX_NUM_SERVER_ADDR_ITEMS - 1; i >= 0; i-- )
{
if ( pSettings->vstrDirectoryAddress[i] != "" )
{
// add vector index (i) to the combobox as user data
cbxDirectory->addItem ( pSettings->vstrDirectoryAddress[i], i );
}
}
}
void CConnectDlg::OnCurrentServerItemChanged ( QTreeWidgetItem* current, QTreeWidgetItem* )
{
Q_UNUSED ( current );
// Announce the currently selected server or client to screen readers.
#if QT_VERSION >= QT_VERSION_CHECK( 6, 8, 0 )
if ( !current )
return;
if ( !current->parent() && current->text ( LVC_PING ).isEmpty() )
{
return;
}
QString announcement;
if ( current->parent() )
{
// It's a client
announcement = current->text ( LVC_NAME );
QVariant countryData = current->data ( LVC_NAME, Qt::UserRole );
if ( countryData.isValid() )
{
announcement += ", " + countryData.toString();
}
}
else
{
// It's a server
announcement = current->text ( LVC_NAME ) + ", " + tr ( "Ping" ) + " " + current->text ( LVC_PING ) + ", " + current->text ( LVC_CLIENTS ) +
", " + current->text ( LVC_LOCATION ) + ", " + current->text ( LVC_VERSION );
}
QAccessible::updateAccessibility ( new QAccessibleAnnouncementEvent ( lvwServers, announcement ) );
#endif
}
bool CConnectDlg::eventFilter ( QObject* obj, QEvent* event )
{
if ( obj == cbxServerAddr && event->type() == QEvent::FocusIn )
{
// check for a selected server before clearing the selection in the list
QList CurSelListItemList = lvwServers->selectedItems();
if ( CurSelListItemList.count() > 0 )
{
// there was a selected item - save it before deselecting
savedServer = GetParentListViewItem ( CurSelListItemList[0] );
}
// remove selection in the server list (if any)
lvwServers->clearSelection();
}
if ( obj == lvwServers && event->type() == QEvent::FocusIn )
{
if ( savedServer )
{
// re-select any previously-selected server on regaining focus
lvwServers->setCurrentItem ( savedServer );
savedServer = nullptr;
}
else if ( static_cast ( event )->reason() != Qt::MouseFocusReason && !lvwServers->currentItem() &&
lvwServers->topLevelItemCount() > 0 )
{
// no saved server and no current item: select first item in list for keyboard navigation
lvwServers->setCurrentItem ( lvwServers->topLevelItem ( 0 ) );
}
}
return QDialog::eventFilter ( obj, event );
}