Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmsavelog.cpp
       3                 :            :                          ---------------------
       4                 :            :     begin                : March 2020
       5                 :            :     copyright            : (C) 2020 by Nyall Dawson
       6                 :            :     email                : nyall dot dawson at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #include "qgsalgorithmsavelog.h"
      19                 :            : #include <QTextStream>
      20                 :            : 
      21                 :            : ///@cond PRIVATE
      22                 :            : 
      23                 :          0 : QString QgsSaveLogToFileAlgorithm::name() const
      24                 :            : {
      25                 :          0 :   return QStringLiteral( "savelog" );
      26                 :            : }
      27                 :            : 
      28                 :          0 : QgsProcessingAlgorithm::Flags QgsSaveLogToFileAlgorithm::flags() const
      29                 :            : {
      30                 :          0 :   return QgsProcessingAlgorithm::flags() | FlagHideFromToolbox | FlagSkipGenericModelLogging;
      31                 :            : }
      32                 :            : 
      33                 :          0 : QString QgsSaveLogToFileAlgorithm::displayName() const
      34                 :            : {
      35                 :          0 :   return QObject::tr( "Save log to file" );
      36                 :            : }
      37                 :            : 
      38                 :          0 : QStringList QgsSaveLogToFileAlgorithm::tags() const
      39                 :            : {
      40                 :          0 :   return QObject::tr( "record,messages,logged" ).split( ',' );
      41                 :          0 : }
      42                 :            : 
      43                 :          0 : QString QgsSaveLogToFileAlgorithm::group() const
      44                 :            : {
      45                 :          0 :   return QObject::tr( "Modeler tools" );
      46                 :            : }
      47                 :            : 
      48                 :          0 : QString QgsSaveLogToFileAlgorithm::groupId() const
      49                 :            : {
      50                 :          0 :   return QStringLiteral( "modelertools" );
      51                 :            : }
      52                 :            : 
      53                 :          0 : QString QgsSaveLogToFileAlgorithm::shortHelpString() const
      54                 :            : {
      55                 :          0 :   return QObject::tr( "This algorithm saves the model's execution log to a file.\n"
      56                 :            :                       "Optionally, the log can be saved in a HTML formatted version." );
      57                 :            : }
      58                 :            : 
      59                 :          0 : QString QgsSaveLogToFileAlgorithm::shortDescription() const
      60                 :            : {
      61                 :          0 :   return QObject::tr( "Saves the model's log contents to a file." );
      62                 :            : }
      63                 :            : 
      64                 :          0 : QgsSaveLogToFileAlgorithm *QgsSaveLogToFileAlgorithm::createInstance() const
      65                 :            : {
      66                 :          0 :   return new QgsSaveLogToFileAlgorithm();
      67                 :            : }
      68                 :            : 
      69                 :          0 : void QgsSaveLogToFileAlgorithm::initAlgorithm( const QVariantMap & )
      70                 :            : {
      71                 :          0 :   addParameter( new QgsProcessingParameterFileDestination( QStringLiteral( "OUTPUT" ), QObject::tr( "Log file" ), QObject::tr( "Text files (*.txt);;HTML files (*.html *.HTML)" ) ) );
      72                 :          0 :   addParameter( new QgsProcessingParameterBoolean( QStringLiteral( "USE_HTML" ), QObject::tr( "Use HTML formatting" ), false ) );
      73                 :          0 : }
      74                 :            : 
      75                 :          0 : QVariantMap QgsSaveLogToFileAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
      76                 :            : {
      77                 :          0 :   const QString file = parameterAsFile( parameters, QStringLiteral( "OUTPUT" ), context );
      78                 :          0 :   const bool useHtml = parameterAsBool( parameters, QStringLiteral( "USE_HTML" ), context );
      79                 :          0 :   if ( !file.isEmpty() )
      80                 :            :   {
      81                 :          0 :     QFile exportFile( file );
      82                 :          0 :     if ( !exportFile.open( QIODevice::WriteOnly | QIODevice::Truncate ) )
      83                 :            :     {
      84                 :          0 :       throw QgsProcessingException( QObject::tr( "Could not save log to file %1" ).arg( file ) );
      85                 :            :     }
      86                 :          0 :     QTextStream fout( &exportFile );
      87                 :          0 :     fout << ( useHtml ? feedback->htmlLog() : feedback->textLog() );
      88                 :          0 :   }
      89                 :          0 :   QVariantMap res;
      90                 :          0 :   res.insert( QStringLiteral( "OUTPUT" ), file );
      91                 :          0 :   return res;
      92                 :          0 : }
      93                 :            : 
      94                 :            : ///@endcond