MerginCpp API and Refactoring 🥳

.github/workflows/android.yml

@@ -24,7 +24,7 @@ jobs:
         env:
           MERGINSECRETS_DECRYPT_KEY: ${{ secrets.MERGINSECRETS_DECRYPT_KEY }}
         run: |
-          openssl aes-256-cbc -k $MERGINSECRETS_DECRYPT_KEY -in app/merginsecrets.cpp.enc -out app/merginsecrets.cpp -d -md md5
+          openssl aes-256-cbc -k $MERGINSECRETS_DECRYPT_KEY -in core/merginsecrets.cpp.enc -out core/merginsecrets.cpp -d -md md5
 
 
       - name: Extract GPS keystore

.github/workflows/autotests.yml

@@ -27,7 +27,7 @@ jobs:
         env:
           MERGINSECRETS_DECRYPT_KEY: ${{ secrets.MERGINSECRETS_DECRYPT_KEY }}
         run: |
-          cd input/app/
+          cd input/core/
           /usr/local/opt/openssl@1.1/bin/openssl \
               aes-256-cbc -d \
               -in merginsecrets.cpp.enc \

.github/workflows/ios.yml

@@ -30,7 +30,7 @@ jobs:
         env:
           MERGINSECRETS_DECRYPT_KEY: ${{ secrets.MERGINSECRETS_DECRYPT_KEY }}
         run: |
-          cd app/
+          cd core/
           /usr/local/opt/openssl@1.1/bin/openssl \
               aes-256-cbc -d \
               -in merginsecrets.cpp.enc \

.gitignore

@@ -3,7 +3,7 @@
 *.user
 *build*/
 app/config.pri
-app/merginsecrets.cpp
+core/merginsecrets.cpp
 *.idea
 test/temp_projects/
 test/temp_extra_projects/

app/input.pro

@@ -15,7 +15,11 @@ include(linux.pri)
 include(macx.pri)
 include(win32.pri)
 include(sources.pri)
+include($$PWD/../core/core.pri)
 
+INCLUDEPATH += $$PWD/../core
+
+DEFINES += INPUT_APP
 DEFINES += "QGIS_QUICK_DATA_PATH=$${QGIS_QUICK_DATA_PATH}"
 CONFIG(debug, debug|release) {
   DEFINES += "QGIS_PREFIX_PATH=$${QGIS_PREFIX_PATH}"

app/inputhelp.cpp

@@ -13,6 +13,7 @@
 #include "merginsubscriptionstatus.h"
 #include "merginapi.h"
 #include "inpututils.h"
+#include "coreutils.h"
 
 #include "qgsquickutils.h"
 
@@ -91,7 +92,7 @@ QString InputHelp::fullLog( bool isHtml )
   qint64 limit = 500000;
   QVector<QString> retLines = logHeader( isHtml );
 
-  QFile file( InputUtils::logFilename() );
+  QFile file( CoreUtils::logFilename() );
   if ( file.open( QIODevice::ReadOnly ) )
   {
     qint64 fileSize = file.size();
@@ -109,7 +110,7 @@ QString InputHelp::fullLog( bool isHtml )
   }
   else
   {
-    retLines.push_back( QString( "Unable to open log file %1" ).arg( InputUtils::logFilename() ) );
+    retLines.push_back( QString( "Unable to open log file %1" ).arg( CoreUtils::logFilename() ) );
   }
 
   QString ret;
@@ -129,7 +130,7 @@ QString InputHelp::fullLog( bool isHtml )
 QVector<QString> InputHelp::logHeader( bool isHtml )
 {
   QVector<QString> retLines;
-  retLines.push_back( QStringLiteral( "Input App: %1 - %2" ).arg( InputUtils::appVersion() ).arg( InputUtils::appPlatform() ) );
+  retLines.push_back( QStringLiteral( "Input App: %1 - %2" ).arg( CoreUtils::appVersion() ).arg( InputUtils::appPlatform() ) );
   retLines.push_back( QStringLiteral( "System: %1" ).arg( QSysInfo::prettyProductName() ) );
   retLines.push_back( QStringLiteral( "Mergin URL: %1" ).arg( mMerginApi->apiRoot() ) );
   retLines.push_back( QStringLiteral( "Mergin User: %1" ).arg( mMerginApi->userAuth()->username() ) );
@@ -157,7 +158,7 @@ void InputHelp::submitReport()
   // There is a limit of 1MB on the remote service, send less, let say half of that
   QString log = fullLog( false );
   QByteArray logArr = log.toUtf8();
-  QString app = QStringLiteral( "input-%1-%2" ).arg( InputUtils::appPlatform() ).arg( InputUtils::appVersion() );
+  QString app = QStringLiteral( "input-%1-%2" ).arg( InputUtils::appPlatform() ).arg( CoreUtils::appVersion() );
   QString username = mMerginApi->userAuth()->username().toHtmlEscaped();
   if ( username.isEmpty() )
     username = "unknown";
@@ -183,12 +184,12 @@ void InputHelp::onSubmitReportReplyFinished()
 
   if ( r->error() == QNetworkReply::NoError )
   {
-    InputUtils::log( "submit report", "Report submitted!" );
+    CoreUtils::log( "submit report", "Report submitted!" );
     emit mInputUtils->showNotification( tr( "Report submitted.%1Please contact us on%1%2" ).arg( "<br />" ).arg( helpDeskMail ) );
   }
   else
   {
-    InputUtils::log( "submit report", QStringLiteral( "FAILED - %1" ).arg( r->errorString() ) );
+    CoreUtils::log( "submit report", QStringLiteral( "FAILED - %1" ).arg( r->errorString() ) );
     emit mInputUtils->showNotification( tr( "Failed to submit report.%1Please check your internet connection." ).arg( "<br>" ) );
   }
 }

app/inputprojutils.cpp

@@ -14,6 +14,7 @@
 #include <QFileInfo>
 
 #include "inpututils.h"
+#include "coreutils.h"
 #include "proj.h"
 #include "qgsprojutils.h"
 #include "inputhelp.h"
@@ -37,7 +38,7 @@ void InputProjUtils::logUser( const QString &message, bool &variable )
 {
   if ( !variable )
   {
-    InputUtils::log( "InputPROJ", message );
+    CoreUtils::log( "InputPROJ", message );
     variable = true;
   }
 }
@@ -151,7 +152,7 @@ void InputProjUtils::setProjDir( const QString &appBundleDir )
   QFile projdb( projFilePath );
   if ( !projdb.exists() )
   {
-    InputUtils::log( QStringLiteral( "PROJ6 error" ), QStringLiteral( "The Input has failed to load PROJ6 database." ) + projFilePath );
+    CoreUtils::log( QStringLiteral( "PROJ6 error" ), QStringLiteral( "The Input has failed to load PROJ6 database." ) + projFilePath );
   }
 }
 

app/inpututils.cpp

@@ -17,8 +17,8 @@
 
 #include "qgsquickutils.h"
 #include "qgsquickmaptransform.h"
-#include "inpututils.h"
 #include "inputexpressionfunctions.h"
+#include "coreutils.h"
 
 #include <Qt>
 #include <QDir>
@@ -29,7 +29,6 @@
 #include <limits>
 #include <math.h>
 
-QString InputUtils::sLogFile = QStringLiteral();
 static const QString DATE_TIME_FORMAT = QStringLiteral( "yyMMdd-hhmmss" );
 
 InputUtils::InputUtils( QObject *parent ): QObject( parent )
@@ -306,26 +305,6 @@ QVector<double> InputUtils::extractGeometryCoordinates( const QgsQuickFeatureLay
   return data;
 }
 
-void InputUtils::setLogFilename( const QString &value )
-{
-  sLogFile = value;
-}
-
-QString InputUtils::logFilename()
-{
-  return sLogFile;
-}
-
-bool InputUtils::createEmptyFile( const QString &filePath )
-{
-  QFile newFile( filePath );
-  if ( !newFile.open( QIODevice::WriteOnly ) )
-    return false;
-
-  newFile.close();
-  return true;
-}
-
 QString InputUtils::filesToString( QList<MerginFile> files )
 {
   QStringList resultList;
@@ -336,12 +315,6 @@ QString InputUtils::filesToString( QList<MerginFile> files )
   return resultList.join( ", " );
 }
 
-QString InputUtils::appInfo()
-{
-  return QString( "%1/%2 (%3/%4)" ).arg( QCoreApplication::applicationName() ).arg( QCoreApplication::applicationVersion() )
-         .arg( QSysInfo::productType() ).arg( QSysInfo::productVersion() );
-}
-
 QString InputUtils::bytesToHumanSize( double bytes )
 {
   const int precision = 1;
@@ -399,43 +372,6 @@ void InputUtils::quitApp()
   QCoreApplication::quit();
 }
 
-QString InputUtils::uuidWithoutBraces( const QUuid &uuid )
-{
-#if QT_VERSION >= QT_VERSION_CHECK( 5, 11, 0 )
-  return uuid.toString( QUuid::WithoutBraces );
-#else
-  QString str = uuid.toString();
-  str = str.mid( 1, str.length() - 2 );  // remove braces
-  return str;
-#endif
-}
-
-QString InputUtils::localizedDateFromUTFString( QString timestamp )
-{
-  if ( timestamp.isEmpty() )
-    return QString();
-
-  QDateTime dateTime = QDateTime::fromString( timestamp, Qt::ISODate );
-  if ( dateTime.isValid() )
-  {
-    return dateTime.date().toString( Qt::DefaultLocaleShortDate );
-  }
-  else
-  {
-    qDebug() << "Unable to convert UTF " << timestamp << " to QDateTime";
-    return QString();
-  }
-}
-
-QString InputUtils::appVersion()
-{
-  QString version;
-#ifdef INPUT_VERSION
-  version = STR( INPUT_VERSION );
-#endif
-  return version;
-}
-
 QString InputUtils::appPlatform()
 {
 #if defined( ANDROID )
@@ -454,40 +390,6 @@ QString InputUtils::appPlatform()
   return platform;
 }
 
-
-QString InputUtils::findUniquePath( const QString &path, bool isPathDir )
-{
-  QFileInfo pathInfo( path );
-  if ( pathInfo.exists() )
-  {
-    int i = 0;
-    QFileInfo info( path + QString::number( i ) );
-    while ( info.exists() && ( info.isDir() || !isPathDir ) )
-    {
-      ++i;
-      info.setFile( path + QString::number( i ) );
-    }
-    return path + QString::number( i );
-  }
-  else
-  {
-    return path;
-  }
-}
-
-
-QString InputUtils::createUniqueProjectDirectory( const QString &baseDataDir, const QString &projectName )
-{
-  QString projectDirPath = findUniquePath( baseDataDir + "/" + projectName );
-  QDir projectDir( projectDirPath );
-  if ( !projectDir.exists() )
-  {
-    QDir dir( "" );
-    dir.mkdir( projectDirPath );
-  }
-  return projectDirPath;
-}
-
 void InputUtils::onQgsLogMessageReceived( const QString &message, const QString &tag, Qgis::MessageLevel level )
 {
   QString levelStr;
@@ -503,7 +405,7 @@ void InputUtils::onQgsLogMessageReceived( const QString &message, const QString
       break;
   }
 
-  log( "QGIS " + tag, levelStr + ": " + message );
+  CoreUtils::log( "QGIS " + tag, levelStr + ": " + message );
 }
 
 bool InputUtils::cpDir( const QString &srcPath, const QString &dstPath, bool onlyDiffable )
@@ -512,7 +414,7 @@ bool InputUtils::cpDir( const QString &srcPath, const QString &dstPath, bool onl
   QDir parentDstDir( QFileInfo( dstPath ).path() );
   if ( !parentDstDir.mkpath( dstPath ) )
   {
-    log( "cpDir", QString( "Cannot make path %1" ).arg( dstPath ) );
+    CoreUtils::log( "cpDir", QString( "Cannot make path %1" ).arg( dstPath ) );
     return false;
   }
 
@@ -526,7 +428,7 @@ bool InputUtils::cpDir( const QString &srcPath, const QString &dstPath, bool onl
     {
       if ( !cpDir( srcItemPath, dstItemPath ) )
       {
-        log( "cpDir", QString( "Cannot copy a dir from %1 to %2" ).arg( srcItemPath ).arg( dstItemPath ) );
+        CoreUtils::log( "cpDir", QString( "Cannot copy a dir from %1 to %2" ).arg( srcItemPath ).arg( dstItemPath ) );
         result = false;
       }
     }
@@ -539,20 +441,20 @@ bool InputUtils::cpDir( const QString &srcPath, const QString &dstPath, bool onl
       {
         if ( !QFile::remove( dstItemPath ) )
         {
-          log( "cpDir", QString( "Cannot remove a file from %1" ).arg( dstItemPath ) );
+          CoreUtils::log( "cpDir", QString( "Cannot remove a file from %1" ).arg( dstItemPath ) );
           result =  false;
         }
         if ( !QFile::copy( srcItemPath, dstItemPath ) )
         {
-          log( "cpDir", QString( "Cannot overwrite a file %1 with %2" ).arg( dstItemPath ).arg( dstItemPath ) );
+          CoreUtils::log( "cpDir", QString( "Cannot overwrite a file %1 with %2" ).arg( dstItemPath ).arg( dstItemPath ) );
           result =  false;
         }
       }
       QFile::setPermissions( dstItemPath, QFile::ReadUser | QFile::WriteUser | QFile::ReadOwner | QFile::WriteOwner );
     }
     else
     {
-      log( "cpDir", QString( "Unhandled item %1 in cpDir" ).arg( info.filePath() ) );
+      CoreUtils::log( "cpDir", QString( "Unhandled item %1 in cpDir" ).arg( info.filePath() ) );
     }
   }
   return result;
@@ -573,11 +475,6 @@ QString InputUtils::renameWithDateTime( const QString &srcPath, const QDateTime
   return QString();
 }
 
-QString InputUtils::downloadInProgressFilePath( const QString &projectDir )
-{
-  return projectDir + "/.mergin/.project.downloading";
-}
-
 void InputUtils::showNotification( const QString &message )
 {
   emit showNotificationRequested( message );
@@ -594,28 +491,6 @@ qreal InputUtils::groundSpeedFromSource( QgsQuickPositionKit *positionKit )
   return 0;
 }
 
-void InputUtils::log( const QString &topic, const QString &info )
-{
-  QString logFilePath;
-  QByteArray data;
-  data.append( QString( "%1 %2: %3\n" ).arg( QDateTime().currentDateTimeUtc().toString( Qt::ISODateWithMs ) ).arg( topic ).arg( info ) );
-
-  qDebug() << data;
-  appendLog( data, sLogFile );
-}
-
-void InputUtils::appendLog( const QByteArray &data, const QString &path )
-{
-  QFile file( path );
-  if ( !file.open( QIODevice::Append ) )
-  {
-    return;
-  }
-
-  file.write( data );
-  file.close();
-}
-
 double InputUtils::ratherZeroThanNaN( double d )
 {
   return ( isnan( d ) ) ? 0.0 : d;