Skip to content
Permalink
Browse files

Fork QgsNewHttpConnection to a dedicated dialog for ArcGIS rest servi…

…ces,

and add option to set Portal content and community endpoints
  • Loading branch information
nyalldawson committed Dec 21, 2020
1 parent d878460 commit 95b596a781652cc122ff759a2c4c7807ed99c1b2
@@ -50,6 +50,7 @@ if (WITH_GUI)
qgsafsdataitemguiprovider.cpp
qgsafssourceselect.cpp
qgsarcgisservicesourceselect.cpp
qgsnewarcgisrestconnection.cpp
)
endif()

@@ -94,6 +95,7 @@ if (WITH_GUI)
qgsamsdataitemguiprovider.cpp
qgsamssourceselect.cpp
qgsarcgisservicesourceselect.cpp
qgsnewarcgisrestconnection.cpp
)
endif()

@@ -17,7 +17,7 @@
#include "qgsafsdataitems.h"
#include "qgsafssourceselect.h"
#include "qgsmanageconnectionsdialog.h"
#include "qgsnewhttpconnection.h"
#include "qgsnewarcgisrestconnection.h"
#include "qgsowsconnection.h"

#include <QDesktopServices>
@@ -105,7 +105,7 @@ void QgsAfsDataItemGuiProvider::populateContextMenu( QgsDataItem *item, QMenu *m

void QgsAfsDataItemGuiProvider::newConnection( QgsDataItem *item )
{
QgsNewHttpConnection nc( nullptr, QgsNewHttpConnection::ConnectionOther, QStringLiteral( "qgis/connections-arcgisfeatureserver/" ), QString(), QgsNewHttpConnection::FlagShowHttpSettings );
QgsNewArcGisRestConnectionDialog nc( nullptr, QStringLiteral( "qgis/connections-arcgisfeatureserver/" ), QString() );
nc.setWindowTitle( tr( "Create a New ArcGIS Feature Service Connection" ) );

if ( nc.exec() )
@@ -116,7 +116,7 @@ void QgsAfsDataItemGuiProvider::newConnection( QgsDataItem *item )

void QgsAfsDataItemGuiProvider::editConnection( QgsDataItem *item )
{
QgsNewHttpConnection nc( nullptr, QgsNewHttpConnection::ConnectionOther, QStringLiteral( "qgis/connections-arcgisfeatureserver/" ), item->name(), QgsNewHttpConnection::FlagShowHttpSettings );
QgsNewArcGisRestConnectionDialog nc( nullptr, QStringLiteral( "qgis/connections-arcgisfeatureserver/" ), item->name() );
nc.setWindowTitle( tr( "Modify ArcGIS Feature Service Connection" ) );

if ( nc.exec() )
@@ -16,7 +16,7 @@
#include "qgsamsdataitemguiprovider.h"
#include "qgsamsdataitems.h"
#include "qgsmanageconnectionsdialog.h"
#include "qgsnewhttpconnection.h"
#include "qgsnewarcgisrestconnection.h"
#include "qgsowsconnection.h"

#include <QDesktopServices>
@@ -95,7 +95,7 @@ void QgsAmsDataItemGuiProvider::populateContextMenu( QgsDataItem *item, QMenu *m

void QgsAmsDataItemGuiProvider::newConnection( QgsDataItem *item )
{
QgsNewHttpConnection nc( nullptr, QgsNewHttpConnection::ConnectionOther, QStringLiteral( "qgis/connections-arcgismapserver/" ), QString(), QgsNewHttpConnection::FlagShowHttpSettings );
QgsNewArcGisRestConnectionDialog nc( nullptr, QStringLiteral( "qgis/connections-arcgismapserver/" ), QString() );
nc.setWindowTitle( tr( "Create a New ArcGIS Map Service Connection" ) );

if ( nc.exec() )
@@ -106,7 +106,7 @@ void QgsAmsDataItemGuiProvider::newConnection( QgsDataItem *item )

void QgsAmsDataItemGuiProvider::editConnection( QgsDataItem *item )
{
QgsNewHttpConnection nc( nullptr, QgsNewHttpConnection::ConnectionOther, QStringLiteral( "qgis/connections-arcgismapserver/" ), item->name(), QgsNewHttpConnection::FlagShowHttpSettings );
QgsNewArcGisRestConnectionDialog nc( nullptr, QStringLiteral( "qgis/connections-arcgismapserver/" ), item->name() );
nc.setWindowTitle( tr( "Modify ArcGIS Map Service Connection" ) );

if ( nc.exec() )
@@ -0,0 +1,280 @@
/***************************************************************************
qgsnewarcgisrestconnection.cpp
-------------------
begin : December 2020
copyright : (C) 2020 by Nyall Dawson
email : nyall dot dawson at gmail dot com
***************************************************************************/

/***************************************************************************
* *
* 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 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#include "qgsnewarcgisrestconnection.h"
#include "qgsauthsettingswidget.h"
#include "qgssettings.h"
#include "qgshelp.h"
#include "qgsgui.h"

#include <QMessageBox>
#include <QUrl>
#include <QPushButton>
#include <QRegExp>
#include <QRegExpValidator>

QgsNewArcGisRestConnectionDialog::QgsNewArcGisRestConnectionDialog( QWidget *parent, const QString &baseKey, const QString &connectionName, Qt::WindowFlags fl )
: QDialog( parent, fl )
, mBaseKey( baseKey )
, mOriginalConnName( connectionName )
{
setupUi( this );

QgsGui::enableAutoGeometryRestore( this );

connect( buttonBox, &QDialogButtonBox::helpRequested, this, &QgsNewArcGisRestConnectionDialog::showHelp );

QRegExp rx( "/connections-([^/]+)/" );
if ( rx.indexIn( baseKey ) != -1 )
{
QString connectionType( rx.cap( 1 ).toUpper() );
setWindowTitle( tr( "Create a New %1 Connection" ).arg( connectionType ) );
}

mCredentialsBaseKey = mBaseKey.split( '-' ).last().toUpper();

txtName->setValidator( new QRegExpValidator( QRegExp( "[^\\/]+" ), txtName ) );

if ( !connectionName.isEmpty() )
{
// populate the dialog with the information stored for the connection
// populate the fields with the stored setting parameters

QgsSettings settings;

QString key = mBaseKey + connectionName;
QString credentialsKey = "qgis/" + mCredentialsBaseKey + '/' + connectionName;
txtName->setText( connectionName );
txtUrl->setText( settings.value( key + "/url" ).toString() );
mRefererLineEdit->setText( settings.value( key + "/referer" ).toString() );

// portal
mContentEndPointLineEdit->setText( settings.value( key + "/content_endpoint" ).toString() );
mCommunityEndPointLineEdit->setText( settings.value( key + "/community_endpoint" ).toString() );

// Authentication
mAuthSettings->setUsername( settings.value( credentialsKey + "/username" ).toString() );
mAuthSettings->setPassword( settings.value( credentialsKey + "/password" ).toString() );
mAuthSettings->setConfigId( settings.value( credentialsKey + "/authcfg" ).toString() );
}

// Adjust height
int w = width();
adjustSize();
resize( w, height() );

connect( txtName, &QLineEdit::textChanged, this, &QgsNewArcGisRestConnectionDialog::nameChanged );
connect( txtUrl, &QLineEdit::textChanged, this, &QgsNewArcGisRestConnectionDialog::urlChanged );

buttonBox->button( QDialogButtonBox::Ok )->setDisabled( true );
connect( txtName, &QLineEdit::textChanged, this, &QgsNewArcGisRestConnectionDialog::updateOkButtonState );
connect( txtUrl, &QLineEdit::textChanged, this, &QgsNewArcGisRestConnectionDialog::updateOkButtonState );

nameChanged( connectionName );
}

QString QgsNewArcGisRestConnectionDialog::name() const
{
return txtName->text();
}

QString QgsNewArcGisRestConnectionDialog::url() const
{
return txtUrl->text();
}

void QgsNewArcGisRestConnectionDialog::nameChanged( const QString &text )
{
Q_UNUSED( text )
buttonBox->button( QDialogButtonBox::Ok )->setDisabled( txtName->text().isEmpty() || txtUrl->text().isEmpty() );
}

void QgsNewArcGisRestConnectionDialog::urlChanged( const QString &text )
{
Q_UNUSED( text )
buttonBox->button( QDialogButtonBox::Ok )->setDisabled( txtName->text().isEmpty() || txtUrl->text().isEmpty() );
}

void QgsNewArcGisRestConnectionDialog::updateOkButtonState()
{
bool enabled = !txtName->text().isEmpty() && !txtUrl->text().isEmpty();
buttonBox->button( QDialogButtonBox::Ok )->setEnabled( enabled );
}

bool QgsNewArcGisRestConnectionDialog::validate()
{
QgsSettings settings;
QString key = mBaseKey + txtName->text();

// warn if entry was renamed to an existing connection
if ( ( mOriginalConnName.isNull() || mOriginalConnName.compare( txtName->text(), Qt::CaseInsensitive ) != 0 ) &&
settings.contains( key + "/url" ) &&
QMessageBox::question( this,
tr( "Save Connection" ),
tr( "Should the existing connection %1 be overwritten?" ).arg( txtName->text() ),
QMessageBox::Ok | QMessageBox::Cancel ) == QMessageBox::Cancel )
{
return false;
}

if ( ! mAuthSettings->password().isEmpty() &&
QMessageBox::question( this,
tr( "Saving Passwords" ),
tr( "WARNING: You have entered a password. It will be stored in unsecured plain text in your project files and your home directory (Unix-like OS) or user profile (Windows). If you want to avoid this, press Cancel and either:\n\na) Don't provide a password in the connection settings — it will be requested interactively when needed;\nb) Use the Configuration tab to add your credentials in an HTTP Basic Authentication method and store them in an encrypted database." ),
QMessageBox::Ok | QMessageBox::Cancel ) == QMessageBox::Cancel )
{
return false;
}

return true;
}

// Mega ewwww. all this is taken from Qt's QUrl::setEncodedPath compatibility helper.
// (I can't see any way to port the below code to NOT require this).

inline char toHexUpper( uint value ) noexcept
{
return "0123456789ABCDEF"[value & 0xF];
}

static inline ushort encodeNibble( ushort c )
{
return ushort( toHexUpper( c ) );
}

bool qt_is_ascii( const char *&ptr, const char *end ) noexcept
{
while ( ptr + 4 <= end )
{
quint32 data = qFromUnaligned<quint32>( ptr );
if ( data &= 0x80808080U )
{
#if Q_BYTE_ORDER == Q_BIG_ENDIAN
uint idx = qCountLeadingZeroBits( data );
#else
uint idx = qCountTrailingZeroBits( data );
#endif
ptr += idx / 8;
return false;
}
ptr += 4;
}
while ( ptr != end )
{
if ( quint8( *ptr ) & 0x80 )
return false;
++ptr;
}
return true;
}

QString fromEncodedComponent_helper( const QByteArray &ba )
{
if ( ba.isNull() )
return QString();
// scan ba for anything above or equal to 0x80
// control points below 0x20 are fine in QString
const char *in = ba.constData();
const char *const end = ba.constEnd();
if ( qt_is_ascii( in, end ) )
{
// no non-ASCII found, we're safe to convert to QString
return QString::fromLatin1( ba, ba.size() );
}
// we found something that we need to encode
QByteArray intermediate = ba;
intermediate.resize( ba.size() * 3 - ( in - ba.constData() ) );
uchar *out = reinterpret_cast<uchar *>( intermediate.data() + ( in - ba.constData() ) );
for ( ; in < end; ++in )
{
if ( *in & 0x80 )
{
// encode
*out++ = '%';
*out++ = encodeNibble( uchar( *in ) >> 4 );
*out++ = encodeNibble( uchar( *in ) & 0xf );
}
else
{
// keep
*out++ = uchar( *in );
}
}
// now it's safe to call fromLatin1
return QString::fromLatin1( intermediate, out - reinterpret_cast<uchar *>( intermediate.data() ) );
}


QUrl QgsNewArcGisRestConnectionDialog::urlTrimmed() const
{
QUrl url( txtUrl->text().trimmed() );
QUrlQuery query( url );
const QList<QPair<QString, QString> > items = query.queryItems( QUrl::FullyEncoded );
QHash< QString, QPair<QString, QString> > params;
for ( const QPair<QString, QString> &it : items )
{
params.insert( it.first.toUpper(), it );
}

url.setQuery( query );

if ( url.path( QUrl::FullyEncoded ).isEmpty() )
{
url.setPath( fromEncodedComponent_helper( "/" ) );
}
return url;
}

void QgsNewArcGisRestConnectionDialog::accept()
{
QgsSettings settings;
QString key = mBaseKey + txtName->text();
QString credentialsKey = "qgis/" + mCredentialsBaseKey + '/' + txtName->text();

if ( !validate() )
return;

// on rename delete original entry first
if ( !mOriginalConnName.isNull() && mOriginalConnName != key )
{
settings.remove( mBaseKey + mOriginalConnName );
settings.remove( "qgis/" + mCredentialsBaseKey + '/' + mOriginalConnName );
settings.sync();
}

QUrl url( urlTrimmed() );
settings.setValue( key + "/url", url.toString() );

settings.setValue( credentialsKey + "/username", mAuthSettings->username() );
settings.setValue( credentialsKey + "/password", mAuthSettings->password() );

settings.setValue( key + "/content_endpoint", mContentEndPointLineEdit->text() );
settings.setValue( key + "/community_endpoint", mCommunityEndPointLineEdit->text() );

settings.setValue( credentialsKey + "/authcfg", mAuthSettings->configId() );

if ( mHttpGroupBox->isVisible() )
settings.setValue( key + "/referer", mRefererLineEdit->text() );

settings.setValue( mBaseKey + "/selected", txtName->text() );

QDialog::accept();
}

void QgsNewArcGisRestConnectionDialog::showHelp()
{
QgsHelp::openHelp( QStringLiteral( "working_with_ogc/index.html" ) );
}

0 comments on commit 95b596a

Please sign in to comment.
You can’t perform that action at this time.