EN · DE · RU · FR · ES

#1135: UserXmlPreferencesMigrationDao.kt

projectforge-business/src/main/kotlin/org/projectforge/business/user/UserXmlPreferencesMigrationDao.kt Tipo: Kotlin · Rol: Objeto de Acceso a Datos · Fuente: projectforge-business/src/main/kotlin/org/projectforge/business/user/UserXmlPreferencesMigrationDao.kt 149 líneas · 89 código · 47 comentarios · 13 en blanco
Objeto de Acceso a Datos para entidades UserXmlPreferencesMigration. Extiende BaseDao para proporcionar operaciones CRUD, consultas de Hibernate Search y acceso a datos a nivel de lógica de negocio.

Estructura del Código

Anotaciones: param, micromata, Service, author, Autowired

Clases: UserXmlPreferencesMigrationDao

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

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

Importaciones: 8 paquetes

Paquete: org.projectforge.business.user

Código Fuente (resumido)

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

/**
 * Almacena todos los objetos persistentes del usuario, como configuraciones de filtro, configuraciones personales y los persiste en la base de datos.
 *
 * @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()
    }

    /**
     * Aquí puede insertar sentencias de actualización o eliminación para todas las entradas de preferencias xml de usuario (por ejemplo, eliminar todas las entradas con una clave no utilizada).
     *
     * @param version Número de versión de la entrada más antigua.
     */
    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();
        }
    }

    /**
     * Las claves no soportadas o no utilizadas deben eliminarse. Este método elimina todas las entradas con la clave dada.
     *
     * @param key Clave de las entradas a eliminar.
     */
    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' entradas eliminadas.")
    }

    protected fun migrateUserPrefs(userPrefs: UserXmlPreferencesDO): String {
        val userId = userPrefs.user?.id ?: return ""
        val buf = StringBuilder()
        buf.append("Verificando preferencias de usuario para el usuario '")
        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("versión ").append(userPrefs.version).append(" (actualizada)\n")
            return buf.toString()
        }
        migrate(userPrefs)
        val data = userXmlPreferencesDao.deserialize(userPrefs)
        buf.append("versión ")
        buf.append(userPrefs.version)
        if (data != null || "<null/>" == userPrefs.serializedValue) {
            buf.append(" OK ")
        } else {
            buf.append(" ***no reutilizable*** ")
        }
        buf.append("\n")
        if (data == null) {
            return buf.toString()
        }
        return buf.toString()
    }

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

        /**
         * Corrige versiones incompatibles de las preferencias de usuario antes de la deserialización.
         *
         * @param userPrefs
         */
// ... (truncado, total 127 líneas)

Historial de Git

868d6abb7 2025 -> 2026
63081666f Encabezados de archivos fuente: 2024 -> 2025.
4d58829cc UserPrefCache y UserXmlPreferencesCache refactorizados.
85b4e1175 PfPersistenceService y PfPersistenceContext: query renombrado a executeQuery.
108ecf629 !!!!! Gran cambio en el manejo de transacciones: Reutiliza PfPersistenceContext tanto como sea posible (aún no terminado). Las pruebas aún no se ejecutan. Transacciones de solo lectura en PfPersistenceService eliminadas, operaciones de escritura de PfPersistenceService eliminadas.