External storage: status is now private with a setter

qgis · Jan 24, 2023 · 779e4b2 · 779e4b2
1 parent 3433d18
commit 779e4b2
Show file tree

Hide file tree

Showing 7 changed files with 46 additions and 25 deletions.
diff --git a/python/core/auto_generated/externalstorage/qgsexternalstorage.sip.in b/python/core/auto_generated/externalstorage/qgsexternalstorage.sip.in
@@ -143,6 +143,13 @@ Update content according to given ``errorMsg`` error message
 Inherited classes should call this method whenever they meet an error.
 %End
 
+    void setStatus( Qgis::ContentStatus status );
+%Docstring
+Sets the external storage status
+%End
+
+
+
 };
 
 class QgsExternalStorageFetchedContent : QgsExternalStorageContent

diff --git a/src/core/externalstorage/qgsexternalstorage.cpp b/src/core/externalstorage/qgsexternalstorage.cpp
@@ -17,11 +17,16 @@
 
 void QgsExternalStorageContent::reportError( const QString &errorMsg )
 {
-  mStatus = Qgis::ContentStatus::Failed;
+  setStatus( Qgis::ContentStatus::Failed );
   mErrorString = errorMsg;
   emit errorOccurred( mErrorString );
 }
 
+void QgsExternalStorageContent::setStatus( Qgis::ContentStatus status )
+{
+  mStatus = status;
+}
+
 Qgis::ContentStatus QgsExternalStorageContent::status() const
 {
   return mStatus;

diff --git a/src/core/externalstorage/qgsexternalstorage.h b/src/core/externalstorage/qgsexternalstorage.h
@@ -157,8 +157,17 @@ class CORE_EXPORT QgsExternalStorageContent : public QObject
      */
     void reportError( const QString &errorMsg );
 
-    Qgis::ContentStatus mStatus = Qgis::ContentStatus::NotStarted;
+    /**
+     * Sets the external storage status
+     */
+    void setStatus( Qgis::ContentStatus status );
+
     QString mErrorString;
+
+
+  private:
+
+    Qgis::ContentStatus mStatus = Qgis::ContentStatus::NotStarted;
 };
 
 /**

diff --git a/src/core/externalstorage/qgssimplecopyexternalstorage.cpp b/src/core/externalstorage/qgssimplecopyexternalstorage.cpp
@@ -31,7 +31,7 @@ QgsSimpleCopyExternalStorageStoredContent::QgsSimpleCopyExternalStorageStoredCon
   connect( mCopyTask, &QgsTask::taskCompleted, this, [ = ]
   {
     mUrl = mCopyTask->destination();
-    mStatus = Qgis::ContentStatus::Finished;
+    setStatus( Qgis::ContentStatus::Finished );
     emit stored();
   } );
 
@@ -48,7 +48,7 @@ QgsSimpleCopyExternalStorageStoredContent::QgsSimpleCopyExternalStorageStoredCon
 
 void QgsSimpleCopyExternalStorageStoredContent::store()
 {
-  mStatus = Qgis::ContentStatus::Running;
+  setStatus( Qgis::ContentStatus::Running );
   QgsApplication::taskManager()->addTask( mCopyTask );
 }
 
@@ -60,7 +60,7 @@ void QgsSimpleCopyExternalStorageStoredContent::cancel()
   disconnect( mCopyTask, &QgsTask::taskTerminated, this, nullptr );
   connect( mCopyTask, &QgsTask::taskTerminated, this, [ = ]
   {
-    mStatus = Qgis::ContentStatus::Canceled;
+    setStatus( Qgis::ContentStatus::Canceled );
     emit canceled();
   } );
 
@@ -86,7 +86,7 @@ void QgsSimpleCopyExternalStorageFetchedContent::fetch()
   }
   else
   {
-    mStatus = Qgis::ContentStatus::Finished;
+    setStatus( Qgis::ContentStatus::Finished );
     mResultFilePath = mFilePath;
     emit fetched();
   }

diff --git a/src/core/externalstorage/qgswebdavexternalstorage.cpp b/src/core/externalstorage/qgswebdavexternalstorage.cpp
@@ -88,7 +88,7 @@ QgsWebDAVExternalStorageStoredContent::QgsWebDAVExternalStorageStoredContent( co
   connect( mUploadTask, &QgsTask::taskCompleted, this, [ = ]
   {
     mUrl = storageUrl;
-    mStatus = Qgis::ContentStatus::Finished;
+    setStatus( Qgis::ContentStatus::Finished );
     emit stored();
   } );
 
@@ -105,7 +105,7 @@ QgsWebDAVExternalStorageStoredContent::QgsWebDAVExternalStorageStoredContent( co
 
 void QgsWebDAVExternalStorageStoredContent::store()
 {
-  mStatus = Qgis::ContentStatus::Running;
+  setStatus( Qgis::ContentStatus::Running );
   QgsApplication::taskManager()->addTask( mUploadTask );
 }
 
@@ -118,7 +118,7 @@ void QgsWebDAVExternalStorageStoredContent::cancel()
   disconnect( mUploadTask, &QgsTask::taskTerminated, this, nullptr );
   connect( mUploadTask, &QgsTask::taskTerminated, this, [ = ]
   {
-    mStatus = Qgis::ContentStatus::Canceled;
+    setStatus( Qgis::ContentStatus::Canceled );
     emit canceled();
   } );
 
@@ -147,13 +147,13 @@ void QgsWebDAVExternalStorageFetchedContent::fetch()
   if ( !mFetchedContent )
     return;
 
-  mStatus = Qgis::ContentStatus::Running;
+  setStatus( Qgis::ContentStatus::Running );
   mFetchedContent->download();
 
   // could be already fetched/cached
   if ( mFetchedContent->status() == QgsFetchedContent::Finished )
   {
-    mStatus = Qgis::ContentStatus::Finished;
+    setStatus( Qgis::ContentStatus::Finished );
     emit fetched();
   }
 }
@@ -170,7 +170,7 @@ void QgsWebDAVExternalStorageFetchedContent::onFetched()
 
   if ( mFetchedContent->status() == QgsFetchedContent::Finished )
   {
-    mStatus = Qgis::ContentStatus::Finished;
+    setStatus( Qgis::ContentStatus::Finished );
     emit fetched();
   }
 }

diff --git a/tests/src/gui/testqgsexternalresourcewidgetwrapper.cpp b/tests/src/gui/testqgsexternalresourcewidgetwrapper.cpp
@@ -94,11 +94,11 @@ class QgsTestExternalStorageFetchedContent
     {
       if ( mCached )
       {
-        mStatus = Qgis::ContentStatus::Finished;
+        setStatus( Qgis::ContentStatus::Finished );
         emit fetched();
       }
       else
-        mStatus = Qgis::ContentStatus::Running;
+        setStatus( Qgis::ContentStatus::Running );
     }
 
 
@@ -109,20 +109,20 @@ class QgsTestExternalStorageFetchedContent
 
     void emitFetched()
     {
-      mStatus = Qgis::ContentStatus::Finished;
+      setStatus( Qgis::ContentStatus::Finished );
       emit fetched();
     }
 
     void emitErrorOccurred()
     {
-      mStatus = Qgis::ContentStatus::Failed;
+      setStatus( Qgis::ContentStatus::Failed );
       mErrorString = QStringLiteral( "an error" );
       emit errorOccurred( mErrorString );
     }
 
     void cancel() override
     {
-      mStatus = Qgis::ContentStatus::Canceled;
+      setStatus( Qgis::ContentStatus::Canceled );
       emit canceled();
     }
 
@@ -147,25 +147,25 @@ class QgsTestExternalStorageStoredContent
 
     void store() override
     {
-      mStatus = Qgis::ContentStatus::Running;
+      setStatus( Qgis::ContentStatus::Running );
     }
 
     void emitStored()
     {
-      mStatus = Qgis::ContentStatus::Finished;
+      setStatus( Qgis::ContentStatus::Finished );
       emit stored();
     }
 
     void emitErrorOccurred()
     {
-      mStatus = Qgis::ContentStatus::Failed;
+      setStatus( Qgis::ContentStatus::Failed );
       mErrorString = "an error";
       emit errorOccurred( mErrorString );
     }
 
     void cancel() override
     {
-      mStatus = Qgis::ContentStatus::Canceled;
+      setStatus( Qgis::ContentStatus::Canceled );
       emit canceled();
     };
 

diff --git a/tests/src/gui/testqgsexternalstoragefilewidget.cpp b/tests/src/gui/testqgsexternalstoragefilewidget.cpp
@@ -71,18 +71,18 @@ class QgsTestExternalStorageStoredContent : public QgsExternalStorageStoredConte
 
     void store() override
     {
-      mStatus = Qgis::ContentStatus::Running;
+      setStatus( Qgis::ContentStatus::Running );
     }
 
     void cancel() override
     {
-      mStatus = Qgis::ContentStatus::Canceled;
+      setStatus( Qgis::ContentStatus::Canceled );
       emit canceled();
     };
 
     void error()
     {
-      mStatus = Qgis::ContentStatus::Failed;
+      setStatus( Qgis::ContentStatus::Failed );
       mErrorString = QStringLiteral( "error" );
       emit errorOccurred( mErrorString );
     }
@@ -94,7 +94,7 @@ class QgsTestExternalStorageStoredContent : public QgsExternalStorageStoredConte
 
     void finish()
     {
-      mStatus = Qgis::ContentStatus::Finished;
+      setStatus( Qgis::ContentStatus::Finished );
       emit stored();
     }