#1135: UserXmlPreferencesMigrationDao.kt

Codestruktur

Annotationen: param, micromata, Service, author, Autowired

Klassen: UserXmlPreferencesMigrationDao

Funktionen (5): migrateAllUserPrefs, migrate, deleteOldKeys, migrateUserPrefs, migrate

Eigenschaften (11): accessChecker, userGroupCache, userXmlPreferencesDao, userXmlPreferencesCache, persistenceService, list, versionNumber, numberOfUpdatedEntries, userId, user, data

Importe: 8 Pakete

Paket: org.projectforge.business.user

Quellcode (gekürzt)

package org.projectforge.business.user

import org.apache.commons.lang3.Validate
import org.projectforge.business.user.UserXmlPreferencesDO.Companion.getCurrentVersion
import org.projectforge.framework.access.AccessChecker
import org.projectforge.framework.persistence.jpa.PfPersistenceService
import org.slf4j.Logger
import org.slf4j.LoggerFactory
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.stereotype.Service

/**
 * Speichert alle persistenten Benutzerobjekte wie Filtereinstellungen, persönliche Einstellungen und persistiert sie in der Datenbank.
 *
 * @author Kai Reinhard (k.reinhard@micromata.de)
 */
@Service
open class UserXmlPreferencesMigrationDao {
    @Autowired
    private lateinit var accessChecker: AccessChecker

    @Autowired
    private lateinit var userGroupCache: UserGroupCache

    @Autowired
    private lateinit var userXmlPreferencesDao: UserXmlPreferencesDao

    @Autowired
    private lateinit var userXmlPreferencesCache: UserXmlPreferencesCache

    @Autowired
    private lateinit var persistenceService: PfPersistenceService

    open fun migrateAllUserPrefs(): String {
        accessChecker.checkIsLoggedInUserMemberOfAdminGroup()
        val buf = StringBuilder()
        val list = persistenceService.executeQuery(
            "from ${UserXmlPreferencesDO::class.java.simpleName} t order by user.id, key",
            UserXmlPreferencesDO::class.java,
        )
        var versionNumber = Int.MAX_VALUE
        for (userPrefs in list) {
            buf.append(migrateUserPrefs(userPrefs))
            if (userPrefs.version < versionNumber) {
                versionNumber = userPrefs.version
            }
        }
        migrate(versionNumber)
        userXmlPreferencesCache.refresh()
        return buf.toString()
    }

    /**
     * Hier können Sie Update- oder Delete-Anweisungen für alle Benutzer-XML-Pref-Einträge einfügen (z. B. alle Einträge mit einem
     * ungenutzten Schlüssel löschen).
     *
     * @param version Versionsnummer des ältesten Eintrags.
     */
    protected fun migrate(version: Int) {
        if (version < 4) {
            // deleteOldKeys("org.projectforge.web.humanresources.HRViewForm:Filter");
            // deleteOldKeys("org.projectforge.web.fibu.AuftragListAction:Filter");
            // deleteOldKeys("OLD-VERSION-1.1");
            // hibernateTemplate.flush();
        }
    }

    /**
     * Nicht unterstützte oder ungenutzte Schlüssel sollten gelöscht werden. Diese Methode löscht alle Einträge mit dem angegebenen Schlüssel.
     *
     * @param key Schlüssel der zu löschenden Einträge.
     */
    protected fun deleteOldKeys(key: String) {
        val numberOfUpdatedEntries = persistenceService.runInTransaction { context ->
            context.executeUpdate("delete from ${UserXmlPreferencesDO::class.java.simpleName} where key = '$key'")
        }
        log.info("$numberOfUpdatedEntries '$key' Einträge gelöscht.")
    }

    protected fun migrateUserPrefs(userPrefs: UserXmlPreferencesDO): String {
        val userId = userPrefs.user?.id ?: return ""
        val buf = StringBuilder()
        buf.append("Prüfe Benutzereinstellungen für Benutzer '")
        val user = userGroupCache.getUser(userId)
        if (user != null) {
            buf.append(user.username)
        } else {
            buf.append(userId)
        }
        buf.append("': ").append(userPrefs.identifier).append(" ... ")
        if (userPrefs.version >= getCurrentVersion()) {
            buf.append("Version ").append(userPrefs.version).append(" (aktuell)\n")
            return buf.toString()
        }
        migrate(userPrefs)
        val data = userXmlPreferencesDao.deserialize(userPrefs)
        buf.append("Version ")
        buf.append(userPrefs.version)
        if (data != null || "<null/>" == userPrefs.serializedValue) {
            buf.append(" OK ")
        } else {
            buf.append(" ***nicht wiederverwendbar*** ")
        }
        buf.append("\n")
        if (data == null) {
            return buf.toString()
        }
        return buf.toString()
    }

    companion object {
        private val log: Logger = LoggerFactory
            .getLogger(UserXmlPreferencesMigrationDao::class.java)

        /**
         * Behebt inkompatible Versionen von Benutzereinstellungen vor der Deserialisierung.
         *
         * @param userPrefs
         */
// ... (gekürzt, insgesamt 127 Zeilen)

Git-Verlauf

868d6abb7 2025 -> 2026
63081666f Quellcode-Dateiköpfe: 2024 -> 2025.
4d58829cc UserPrefCache und UserXmlPreferencesCache umgestaltet.
85b4e1175 PfPersistenceService und PfPersistenceContext: query umbenannt in executeQuery.
108ecf629 !!!!! Große Änderung der Transaktionsverwaltung: Verwendet PfPersistenceContext so weit wie möglich wieder (noch nicht abgeschlossen). Tests laufen noch nicht. read-only-Transaktionen in PfPersistenceService entfernt, Schreiboperationen von PfPersistenceService entfernt.