commit 9e0f13b2c4d31537162434b5b932b265c62349e0
author Justin Luth <jluth@mail.com> Thu Jul 20 16:29:41 2023 -0400
committer Justin Luth <jluth@mail.com> Mon Aug 07 17:40:06 2023 +0200
tree 1809997a52179ecf7d7e8615eb1bfe46374b8e81
parent c9e863801509fb37b125a8fb07358fb1b235496d

tdf#57414 autorecovery: don't always add every file to RecoveryList

There is no need to recover documents that are not modified,
and certainly not if there is no storeToRecoveryFile.
This specifically is nice for read-only files, new files,
or e-mailed files that have just been opened for viewing.

registerDocument: A just opened file has nothing to recover,
so wait until it has storeToRecoveryFile'd.
  - Emergency and Session pre-register all documents
    via implts_persistAllActiveViewNames, so no problem here.

resetHandleStates: shouldn't add, just update the existing states

saveOneDoc: shouldn't add before storeToRecoveryFile, only after.

Change-Id: I4a935ee325af6469b25c5bf3d2860c4065d9130d
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/154490
Tested-by: Jenkins
Reviewed-by: Justin Luth <jluth@mail.com>

framework/source/services/autorecovery.cxx

diff --git a/framework/source/services/autorecovery.cxx b/framework/source/services/autorecovery.cxx
index 1bef7e6..f0affa0 100644
--- a/framework/source/services/autorecovery.cxx
+++ b/framework/source/services/autorecovery.cxx
@@ -575,8 +575,8 @@ private:
    void implts_readAutoSaveConfig();

    // TODO document me
    void implts_flushConfigItem(const AutoRecovery::TDocumentInfo& rInfo                ,
                                      bool                     bRemoveIt = false);
    void implts_flushConfigItem(const AutoRecovery::TDocumentInfo& rInfo, bool bRemoveIt = false,
                                bool bAllowAdd = true);

    // TODO document me
    void implts_startListening();
@@ -1981,7 +1981,8 @@ void AutoRecovery::implts_persistAllActiveViewNames()
    }
}

void AutoRecovery::implts_flushConfigItem(const AutoRecovery::TDocumentInfo& rInfo, bool bRemoveIt)
void AutoRecovery::implts_flushConfigItem(const AutoRecovery::TDocumentInfo& rInfo, bool bRemoveIt,
                                          bool bAllowAdd)
{
    std::shared_ptr<comphelper::ConfigurationChanges> batch(
            comphelper::ConfigurationChanges::create());
@@ -2019,7 +2020,12 @@ void AutoRecovery::implts_flushConfigItem(const AutoRecovery::TDocumentInfo& rIn
            css::uno::Reference< css::beans::XPropertySet > xSet;
            bool                                        bNew = !xCheck->hasByName(sID);
            if (bNew)
            {
                if (!bAllowAdd)
                    return; // no change made, just exit

                xSet.set(xCreate->createInstance(), css::uno::UNO_QUERY_THROW);
            }
            else
                xCheck->getByName(sID) >>= xSet;

@@ -2485,7 +2491,8 @@ void AutoRecovery::implts_registerDocument(const css::uno::Reference< css::frame

    } /* SAFE */

    implts_flushConfigItem(aInfo);
    // Even if the document is modified, we don't know if we have anything to recover, so don't add.
    implts_flushConfigItem(aInfo, /*bRemoveIt=*/false, /*bAllowAdd=*/false);
    implts_startModifyListeningOnDoc(aInfo);

    aCacheLock.unlock();
@@ -3053,10 +3060,11 @@ void AutoRecovery::implts_saveOneDoc(const OUString&                            
    // Because the last temp file is too old and does not include all changes.
    Reference< XDocumentRecovery > xDocRecover(rInfo.Document, css::uno::UNO_QUERY_THROW);

    // safe the state about "trying to save"
    // save the state about "trying to save"
    // ... we need it for recovery if e.g. a crash occurs inside next line!
    rInfo.DocumentState |= DocState::TrySave;
    implts_flushConfigItem(rInfo);
    // just update existing info: don't add any recovery record until recovery file created.
    implts_flushConfigItem(rInfo, /*bRemoveIt=*/false, /*bAllowAdd=*/false);

    // If userautosave is enabled, first try to save the original file.
    // Note that we must do it *before* calling storeToRecoveryFile, so in case of failure here
@@ -3667,7 +3675,8 @@ void AutoRecovery::implts_resetHandleStates()

        // } /* SAFE */
        g.clear();
        implts_flushConfigItem(info);
        // just update existing records.
        implts_flushConfigItem(info, /*bRemoveIt=*/false, /*bAllowAdd=*/false);
        g.reset();
        // /* SAFE */ {
    }