qgsmaprenderertask.cpp

Go to the documentation of this file.

/***************************************************************************
                          qgsmaprenderertask.h
                          -------------------------
    begin                : Apr 2017
    copyright            : (C) 2017 by Mathieu Pellerin
    email                : nirvn dot asia 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 "qgsmaprenderertask.h"
 
#include <cpl_conv.h>
#include <gdal.h>
#include <memory>
 
#include "qgsabstractgeopdfexporter.h"
#include "qgsannotation.h"
#include "qgsannotationmanager.h"
#include "qgsfeaturerequest.h"
#include "qgslogger.h"
#include "qgsmaprendererstagedrenderjob.h"
#include "qgsmapsettingsutils.h"
#include "qgsogrutils.h"
#include "qgsrenderedfeaturehandlerinterface.h"
#include "qgsvectorlayer.h"
 
#include <QFile>
#include <QImageWriter>
#include <QPdfWriter>
#include <QString>
#include <QTextStream>
#include <QTimeZone>
 
#include "moc_qgsmaprenderertask.cpp"
 
using namespace Qt::StringLiterals;

 
class QgsMapRendererTaskGeospatialPdfExporter : public QgsAbstractGeospatialPdfExporter
{
 
  public:
 
    QgsMapRendererTaskGeospatialPdfExporter( const QgsMapSettings &ms )
    {
      // collect details upfront, while we are still in the main thread
      const QList< QgsMapLayer * > layers = ms.layers();
      for ( const QgsMapLayer *layer : layers )
      {
        VectorComponentDetail detail;
        detail.name = layer->name();
        detail.mapLayerId = layer->id();
        if ( const QgsVectorLayer *vl = qobject_cast< const QgsVectorLayer * >( layer ) )
        {
          detail.displayAttribute = vl->displayField();
        }
        mLayerDetails[ layer->id() ] = detail;
      }
    }
 
  private:
 
    QgsAbstractGeospatialPdfExporter::VectorComponentDetail componentDetailForLayerId( const QString &layerId ) override
    {
      return mLayerDetails.value( layerId );
    }
 
    QMap< QString, VectorComponentDetail > mLayerDetails;
};
 
 
class QgsMapRendererTaskRenderedFeatureHandler : public QgsRenderedFeatureHandlerInterface
{
  public:
 
    QgsMapRendererTaskRenderedFeatureHandler( QgsMapRendererTaskGeospatialPdfExporter *exporter, const QgsMapSettings &settings )
      : mExporter( exporter )
      , mMapSettings( settings )
    {
      // PDF coordinate space uses a hardcoded DPI of 72, also vertical dimension is flipped from QGIS dimension
      const double pageHeightPdfUnits = settings.outputSize().height() * 72.0 / settings.outputDpi();
      mTransform = QTransform::fromTranslate( 0, pageHeightPdfUnits ).scale( 72.0 / mMapSettings.outputDpi(), -72.0 / mMapSettings.outputDpi() );
    }
 
    void handleRenderedFeature( const QgsFeature &feature, const QgsGeometry &renderedBounds, const QgsRenderedFeatureHandlerInterface::RenderedFeatureContext &context ) override
    {
      // is it a hack retrieving the layer ID from an expression context like this? possibly... BUT
      // the alternative is adding a layer ID member to QgsRenderContext, and that's just asking for people to abuse it
      // and use it to retrieve QgsMapLayers mid-way through a render operation. Lesser of two evils it is!
      const QString layerId = context.renderContext.expressionContext().variable( u"layer_id"_s ).toString();
 
      QgsGeometry transformed = renderedBounds;
      transformed.transform( mTransform );
 
      // always convert to multitype, to make things consistent
      transformed.convertToMultiType();
 
      mExporter->pushRenderedFeature( layerId, QgsAbstractGeospatialPdfExporter::RenderedFeature( feature, transformed ) );
    }
 
    QSet<QString> usedAttributes( QgsVectorLayer *, const QgsRenderContext & ) const override
    {
      return QSet< QString >() << QgsFeatureRequest::ALL_ATTRIBUTES;
    }
 
  private:
 
    QgsMapRendererTaskGeospatialPdfExporter *mExporter = nullptr;
    QgsMapSettings mMapSettings;
    QTransform mTransform;
 
};

 
QgsMapRendererTask::QgsMapRendererTask( const QgsMapSettings &ms, const QString &fileName, const QString &fileFormat, const bool forceRaster, QgsTask::Flags flags,
                                        const bool geoPDF, const QgsAbstractGeospatialPdfExporter::ExportDetails &geospatialPdfExportDetails )
  : QgsTask( fileFormat == "PDF"_L1 ? tr( "Saving as PDF" ) : tr( "Saving as image" ), flags )
  , mMapSettings( ms )
  , mFileName( fileName )
  , mFileFormat( fileFormat )
  , mForceRaster( forceRaster )
  , mGeospatialPDF( geoPDF && mFileFormat == "PDF"_L1 && QgsAbstractGeospatialPdfExporter::geospatialPDFCreationAvailable() )
  , mGeospatialPdfExportDetails( geospatialPdfExportDetails )
{
  if ( mFileFormat == "PDF"_L1 && !qgsDoubleNear( mMapSettings.devicePixelRatio(), 1.0 ) )
  {
    mMapSettings.setOutputSize( mMapSettings.outputSize() * mMapSettings.devicePixelRatio() );
    mMapSettings.setOutputDpi( mMapSettings.outputDpi() * mMapSettings.devicePixelRatio() );
    mMapSettings.setDevicePixelRatio( 1.0 );
  }
  prepare();
}
 
QgsMapRendererTask::QgsMapRendererTask( const QgsMapSettings &ms, QPainter *p )
  : QgsTask( tr( "Rendering to painter" ) )
  , mMapSettings( ms )
  , mPainter( p )
{
  prepare();
}
 
QgsMapRendererTask::~QgsMapRendererTask() = default;
 
void QgsMapRendererTask::addAnnotations( const QList< QgsAnnotation * > &annotations )
{
  qDeleteAll( mAnnotations );
  mAnnotations.clear();
 
  const auto constAnnotations = annotations;
  for ( const QgsAnnotation *a : constAnnotations )
  {
    mAnnotations << a->clone();
  }
}
 
void QgsMapRendererTask::addDecorations( const QList< QgsMapDecoration * > &decorations )
{
  mDecorations = decorations;
}
 
 
void QgsMapRendererTask::cancel()
{
  mJobMutex.lock();
  if ( mJob )
    mJob->cancelWithoutBlocking();
  mJobMutex.unlock();
 
  QgsTask::cancel();
}
 
bool QgsMapRendererTask::run()
{
  if ( mErrored )
    return false;
 
  if ( mGeospatialPDF )
  {
    QList< QgsAbstractGeospatialPdfExporter::ComponentLayerDetail > pdfComponents;
 
    QgsMapRendererStagedRenderJob *job = static_cast< QgsMapRendererStagedRenderJob * >( mJob.get() );
    int outputLayer = 1;
    while ( !job->isFinished() )
    {
      QgsAbstractGeospatialPdfExporter::ComponentLayerDetail component;
 
      component.name = u"layer_%1"_s.arg( outputLayer );
      component.mapLayerId = job->currentLayerId();
      component.opacity = job->currentLayerOpacity();
      component.compositionMode = job->currentLayerCompositionMode();
      component.sourcePdfPath = mGeospatialPdfExporter->generateTemporaryFilepath( u"layer_%1.pdf"_s.arg( outputLayer ) );
      pdfComponents << component;
 
      QPdfWriter pdfWriter( component.sourcePdfPath );
      pdfWriter.setPageOrientation( QPageLayout::Orientation::Portrait );
      // paper size needs to be given in millimeters in order to be able to set a resolution to pass onto the map renderer
      const QSizeF outputSize = mMapSettings.outputSize();
      const QPageSize pageSize( outputSize  * 25.4 / mMapSettings.outputDpi(), QPageSize::Unit::Millimeter );
      pdfWriter.setPageSize( pageSize );
      pdfWriter.setPageMargins( QMarginsF( 0, 0, 0, 0 ) );
      pdfWriter.setResolution( static_cast<int>( mMapSettings.outputDpi() ) );
 
      QPainter p( &pdfWriter );
      job->renderCurrentPart( &p );
      p.end();
 
      outputLayer++;
      job->nextPart();
    }
    QgsAbstractGeospatialPdfExporter::ExportDetails exportDetails = mGeospatialPdfExportDetails;
    const double pageWidthMM = mMapSettings.outputSize().width() * 25.4 / mMapSettings.outputDpi();
    const double pageHeightMM = mMapSettings.outputSize().height() * 25.4 / mMapSettings.outputDpi();
    exportDetails.pageSizeMm = QSizeF( pageWidthMM, pageHeightMM );
    exportDetails.dpi = mMapSettings.outputDpi();
 
    exportDetails.layerIdToPdfLayerTreeNameMap = mLayerIdToLayerNameMap;
    exportDetails.layerOrder = mMapLayerOrder;
 
    if ( mSaveWorldFile )
    {
      // setup georeferencing
      QgsAbstractGeospatialPdfExporter::GeoReferencedSection georef;
      georef.crs = mMapSettings.destinationCrs();
      georef.pageBoundsMm = QgsRectangle( 0, 0, pageWidthMM, pageHeightMM );
      georef.controlPoints.reserve( 4 );
      georef.controlPoints << QgsAbstractGeospatialPdfExporter::ControlPoint( QgsPointXY( 0, 0 ), mMapSettings.mapToPixel().toMapCoordinates( 0, 0 ) );
      georef.controlPoints << QgsAbstractGeospatialPdfExporter::ControlPoint( QgsPointXY( pageWidthMM, 0 ), mMapSettings.mapToPixel().toMapCoordinates( mMapSettings.outputSize().width(), 0 ) );
      georef.controlPoints << QgsAbstractGeospatialPdfExporter::ControlPoint( QgsPointXY( pageWidthMM, pageHeightMM ), mMapSettings.mapToPixel().toMapCoordinates( mMapSettings.outputSize().width(), mMapSettings.outputSize().height() ) );
      georef.controlPoints << QgsAbstractGeospatialPdfExporter::ControlPoint( QgsPointXY( 0, pageHeightMM ), mMapSettings.mapToPixel().toMapCoordinates( 0, mMapSettings.outputSize().height() ) );
      exportDetails.georeferencedSections << georef;
    }
 
    const bool res = mGeospatialPdfExporter->finalize( pdfComponents, mFileName, exportDetails );
    mGeospatialPdfExporter.reset();
    mTempPainter.reset();
    mPdfWriter.reset();
    return res;
  }
  else
    static_cast< QgsMapRendererCustomPainterJob *>( mJob.get() )->renderPrepared();
 
  mJobMutex.lock();
  mJob.reset( nullptr );
  mJobMutex.unlock();
 
  if ( isCanceled() )
    return false;
 
  QgsRenderContext context = QgsRenderContext::fromMapSettings( mMapSettings );
  context.setPainter( mDestPainter );
 
  const auto constMDecorations = mDecorations;
  for ( QgsMapDecoration *decoration : constMDecorations )
  {
    decoration->render( mMapSettings, context );
  }
 
  const auto constMAnnotations = mAnnotations;
  for ( QgsAnnotation *annotation : constMAnnotations )
  {
    if ( isCanceled() )
      return false;
 
    if ( !annotation || !annotation->isVisible() )
    {
      continue;
    }
    if ( annotation->mapLayer() && !mMapSettings.layers().contains( annotation->mapLayer() ) )
    {
      continue;
    }
 
    const QgsScopedQPainterState painterState( context.painter() );
    context.setPainterFlagsUsingContext();
 
    double itemX, itemY;
    if ( annotation->hasFixedMapPosition() )
    {
      itemX = mMapSettings.outputSize().width() * ( annotation->mapPosition().x() - mMapSettings.extent().xMinimum() ) / mMapSettings.extent().width();
      itemY = mMapSettings.outputSize().height() * ( 1 - ( annotation->mapPosition().y() - mMapSettings.extent().yMinimum() ) / mMapSettings.extent().height() );
    }
    else
    {
      itemX = annotation->relativePosition().x() * mMapSettings.outputSize().width();
      itemY = annotation->relativePosition().y() * mMapSettings.outputSize().height();
    }
 
    context.painter()->translate( itemX, itemY );
 
    annotation->render( context );
  }
 
  if ( !mFileName.isEmpty() )
  {
    mDestPainter->end();
 
    if ( mFileFormat == "PDF"_L1 )
    {
      if ( mForceRaster )
      {
        QPainter pp;
        pp.begin( mPdfWriter.get() );
        const QRectF rect( 0, 0, mImage.width(), mImage.height() );
        pp.drawImage( rect, mImage, rect );
        pp.end();
      }
 
      if ( mSaveWorldFile || mExportMetadata )
      {
        CPLSetThreadLocalConfigOption( "GDAL_PDF_DPI", QString::number( mMapSettings.outputDpi() ).toLocal8Bit().constData() );
        const gdal::dataset_unique_ptr outputDS( GDALOpen( mFileName.toUtf8().constData(), GA_Update ) );
        if ( outputDS )
        {
          if ( mSaveWorldFile )
          {
            double a, b, c, d, e, f;
            QgsMapSettingsUtils::worldFileParameters( mMapSettings, a, b, c, d, e, f );
            c -= 0.5 * a;
            c -= 0.5 * b;
            f -= 0.5 * d;
            f -= 0.5 * e;
            double geoTransform[6] = { c, a, b, f, d, e };
            GDALSetGeoTransform( outputDS.get(), geoTransform );
            GDALSetProjection( outputDS.get(), mMapSettings.destinationCrs().toWkt( Qgis::CrsWktVariant::PreferredGdal ).toLocal8Bit().constData() );
          }
 
          if ( mExportMetadata )
          {
            QString creationDateString;
            const QDateTime creationDateTime = mGeospatialPdfExportDetails.creationDateTime;
#if QT_FEATURE_timezone > 0
            if ( creationDateTime.isValid() )
            {
              creationDateString = u"D:%1"_s.arg( mGeospatialPdfExportDetails.creationDateTime.toString( u"yyyyMMddHHmmss"_s ) );
              if ( creationDateTime.timeZone().isValid() )
              {
                int offsetFromUtc = creationDateTime.timeZone().offsetFromUtc( creationDateTime );
                creationDateString += ( offsetFromUtc >= 0 ) ? '+' : '-';
                offsetFromUtc = std::abs( offsetFromUtc );
                const int offsetHours = offsetFromUtc / 3600;
                const int offsetMins = ( offsetFromUtc % 3600 ) / 60;
                creationDateString += u"%1'%2'"_s.arg( offsetHours ).arg( offsetMins );
              }
            }
#else
            QgsDebugError( u"Qt is built without timezone support, skipping timezone for pdf export"_s );
#endif
            GDALSetMetadataItem( outputDS.get(), "CREATION_DATE", creationDateString.toUtf8().constData(), nullptr );
 
            GDALSetMetadataItem( outputDS.get(), "AUTHOR", mGeospatialPdfExportDetails.author.toUtf8().constData(), nullptr );
            const QString creator = u"QGIS %1"_s.arg( Qgis::version() );
            GDALSetMetadataItem( outputDS.get(), "CREATOR", creator.toUtf8().constData(), nullptr );
            GDALSetMetadataItem( outputDS.get(), "PRODUCER", creator.toUtf8().constData(), nullptr );
            GDALSetMetadataItem( outputDS.get(), "SUBJECT", mGeospatialPdfExportDetails.subject.toUtf8().constData(), nullptr );
            GDALSetMetadataItem( outputDS.get(), "TITLE", mGeospatialPdfExportDetails.title.toUtf8().constData(), nullptr );
 
            const QgsAbstractMetadataBase::KeywordMap keywords = mGeospatialPdfExportDetails.keywords;
            QStringList allKeywords;
            for ( auto it = keywords.constBegin(); it != keywords.constEnd(); ++it )
            {
              allKeywords.append( u"%1: %2"_s.arg( it.key(), it.value().join( ',' ) ) );
            }
            const QString keywordString = allKeywords.join( ';' );
            GDALSetMetadataItem( outputDS.get(), "KEYWORDS", keywordString.toUtf8().constData(), nullptr );
          }
        }
        CPLSetThreadLocalConfigOption( "GDAL_PDF_DPI", nullptr );
      }
    }
    else if ( mFileFormat != "PDF"_L1 )
    {
      QImageWriter writer( mFileName, mFileFormat.toLocal8Bit().data() );
      if ( mFileFormat.compare( "TIF"_L1, Qt::CaseInsensitive ) == 0 || mFileFormat.compare( "TIFF"_L1, Qt::CaseInsensitive ) == 0 )
      {
        // Enable LZW compression
        writer.setCompression( 1 );
      }
      const bool success = writer.write( mImage );
      if ( !success )
      {
        mError = ImageSaveFail;
        return false;
      }
 
      if ( mSaveWorldFile )
      {
        const QFileInfo info  = QFileInfo( mFileName );
 
        // build the world file name
        const QString outputSuffix = info.suffix();
        bool skipWorldFile = false;
        if ( outputSuffix.compare( "TIF"_L1, Qt::CaseInsensitive ) == 0 || outputSuffix.compare( "TIFF"_L1, Qt::CaseInsensitive ) == 0 )
        {
          const gdal::dataset_unique_ptr outputDS( GDALOpen( mFileName.toUtf8().constData(), GA_Update ) );
          if ( outputDS )
          {
            skipWorldFile = true;
            double a, b, c, d, e, f;
            QgsMapSettingsUtils::worldFileParameters( mMapSettings, a, b, c, d, e, f );
            c -= 0.5 * a;
            c -= 0.5 * b;
            f -= 0.5 * d;
            f -= 0.5 * e;
            double geoTransform[] = { c, a, b, f, d, e };
            GDALSetGeoTransform( outputDS.get(), geoTransform );
            GDALSetProjection( outputDS.get(), mMapSettings.destinationCrs().toWkt( Qgis::CrsWktVariant::PreferredGdal ).toLocal8Bit().constData() );
          }
        }
 
        if ( !skipWorldFile )
        {
          const QString worldFileName = info.absolutePath() + '/' + info.completeBaseName() + '.'
                                        + outputSuffix.at( 0 ) + outputSuffix.at( info.suffix().size() - 1 ) + 'w';
          QFile worldFile( worldFileName );
 
          if ( worldFile.open( QIODevice::WriteOnly | QIODevice::Truncate ) ) //don't use QIODevice::Text
          {
            QTextStream stream( &worldFile );
            stream << QgsMapSettingsUtils::worldFileContent( mMapSettings );
          }
        }
      }
    }
  }
 
  mTempPainter.reset();
  mPdfWriter.reset();
 
  return true;
}
 
void QgsMapRendererTask::finished( bool result )
{
  qDeleteAll( mAnnotations );
  mAnnotations.clear();
 
  if ( result )
    emit renderingComplete();
  else
    emit errorOccurred( mError );
}
 
void QgsMapRendererTask::prepare()
{
  if ( mGeospatialPDF )
  {
    mGeospatialPdfExporter = std::make_unique< QgsMapRendererTaskGeospatialPdfExporter >( mMapSettings );
    if ( mGeospatialPdfExportDetails.includeFeatures )
    {
      mRenderedFeatureHandler = std::make_unique< QgsMapRendererTaskRenderedFeatureHandler >( static_cast< QgsMapRendererTaskGeospatialPdfExporter * >( mGeospatialPdfExporter.get() ), mMapSettings );
      mMapSettings.addRenderedFeatureHandler( mRenderedFeatureHandler.get() );
    }
 
    const QList< QgsMapLayer * > layers = mMapSettings.layers();
    for ( const QgsMapLayer *layer : layers )
    {
      mLayerIdToLayerNameMap.insert( layer->id(), layer->name() );
      mMapLayerOrder << layer->id();
    }
 
    mJob = std::make_unique<QgsMapRendererStagedRenderJob>( mMapSettings, QgsMapRendererStagedRenderJob::RenderLabelsByMapLayer );
    mJob->start();
    return;
  }
 
  mDestPainter = mPainter;
 
  if ( mFileFormat == "PDF"_L1 )
  {
    mPdfWriter = std::make_unique<QPdfWriter>( mFileName );
    mPdfWriter->setPageOrientation( QPageLayout::Orientation::Portrait );
    // paper size needs to be given in millimeters in order to be able to set a resolution to pass onto the map renderer
    const QSizeF outputSize = mMapSettings.outputSize();
    const QPageSize pageSize( outputSize  * 25.4 / mMapSettings.outputDpi(), QPageSize::Unit::Millimeter );
    mPdfWriter->setPageSize( pageSize );
    mPdfWriter->setPageMargins( QMarginsF( 0, 0, 0, 0 ) );
    mPdfWriter->setResolution( static_cast<int>( mMapSettings.outputDpi() ) );
 
    if ( !mForceRaster )
    {
      mTempPainter = std::make_unique<QPainter>( mPdfWriter.get() );
      mDestPainter = mTempPainter.get();
    }
  }
 
  if ( !mDestPainter )
  {
    // save rendered map to an image file
    mImage = QImage( mMapSettings.outputSize() * mMapSettings.devicePixelRatio(), QImage::Format_ARGB32 );
    if ( mImage.isNull() )
    {
      mErrored = true;
      mError = ImageAllocationFail;
      return;
    }
 
    mImage.setDevicePixelRatio( mMapSettings.devicePixelRatio() );
    mImage.setDotsPerMeterX( 1000 * mMapSettings.outputDpi() / 25.4 );
    mImage.setDotsPerMeterY( 1000 * mMapSettings.outputDpi() / 25.4 );
 
    mTempPainter = std::make_unique<QPainter>( &mImage );
    mDestPainter = mTempPainter.get();
  }
 
  if ( !mDestPainter )
  {
    mErrored = true;
    return;
  }
 
  mJob = std::make_unique<QgsMapRendererCustomPainterJob>( mMapSettings, mDestPainter );
  static_cast< QgsMapRendererCustomPainterJob *>( mJob.get() )->prepare();
}