#228: MerlinPlugin.kt

Code Structure

Annotations: author, micromata

Classes: MerlinPlugin

Objects: etc

Supertype(s): AbstractPlugin

Functions (3): initialize, ensureUserLogSubscription, createUserLogSubscriptionMenuItem

Properties (7): merlinTemplateDao, menuCreator, attachmentsService, attachmentsServicesRest, ID, RESOURCE_BUNDLE_NAME, username

Imports: 18 packages

Package: org.projectforge.plugins.merlin

Source Code (abridged)

package org.projectforge.plugins.merlin

import org.projectforge.Constants
import org.projectforge.common.logging.LogEventLoggerNameMatcher
import org.projectforge.common.logging.LogSubscription
import org.projectforge.framework.jcr.AttachmentsService
import org.projectforge.framework.persistence.user.api.ThreadLocalUserContext
import org.projectforge.menu.MenuItem
import org.projectforge.menu.MenuItemTargetType
import org.projectforge.menu.builder.MenuCreator
import org.projectforge.menu.builder.MenuItemDef
import org.projectforge.menu.builder.MenuItemDefId
import org.projectforge.plugins.core.AbstractPlugin
import org.projectforge.plugins.core.PluginAdminService
import org.projectforge.plugins.merlin.rest.MerlinAttachmentsActionListener
import org.projectforge.rest.AttachmentsServicesRest
import org.projectforge.rest.admin.LogViewerPageRest
import org.projectforge.rest.config.JacksonConfiguration
import org.projectforge.rest.core.PagesResolver
import org.projectforge.web.WicketSupport

/**
 * Your plugin initialization. Register all your components such as i18n files, data-access object etc.
 *
 * @author Kai Reinhard (k.reinhard@micromata.de)
 */
class MerlinPlugin :
    AbstractPlugin(
        ID,
        "Merlin-Word®-Templates",
        "Plugin for Microsoft Word® templating (with variables, dependant variables as well as serial execution). Useful for contracts, serial documents etc."
    ) {

    override fun initialize() {
        val merlinTemplateDao = WicketSupport.get(MerlinTemplateDao::class.java)
        val menuCreator = WicketSupport.get(MenuCreator::class.java)
        val attachmentsService = WicketSupport.get(AttachmentsService::class.java)
        val attachmentsServicesRest = WicketSupport.get(AttachmentsServicesRest::class.java)
        // Register it:
        register(MerlinTemplateDao::class.java, merlinTemplateDao, "plugins.merlin")

        // Will only delivered to client but has to be ignored on sending back from client:
        JacksonConfiguration.registerAllowedUnknownProperties(
            MerlinVariable::class.java,
            "allowedValuesFormatted",
            "mappingMasterValues",
        )

        menuCreator.register(
            MenuItemDefId.MISC,
            MenuItemDef(info.id, "plugins.merlin.menu", "${Constants.REACT_APP_PATH}merlin")
        )

        // All the i18n stuff:
        addResourceBundle(RESOURCE_BUNDLE_NAME)

        attachmentsServicesRest.register(
            ID,
            MerlinAttachmentsActionListener(attachmentsService, merlinTemplateDao)
        )
    }

    companion object {
        const val ID = PluginAdminService.PLUGIN_MERLIN_ID
        const val RESOURCE_BUNDLE_NAME = "MerlinI18nResources"

        fun ensureUserLogSubscription(): LogSubscription {
            val username = ThreadLocalUserContext.loggedInUser!!.username ?: throw InternalError("User not given")
            return LogSubscription.ensureSubscription(
                title = "Merlin",
                user = username,
                create = { title, user ->
                    LogSubscription(
                        title,
                        user,
                        LogEventLoggerNameMatcher("de.micromata.merlin", "org.projectforge.plugins.merlin"),
                        maxSize = 10000,
                    )
                })
        }

        /**
         * Calls also [ensureUserLogSubscription].
         */
        fun createUserLogSubscriptionMenuItem(): MenuItem {
            return MenuItem(
                "logViewer",
                i18nKey = "plugins.merlin.viewLogs",
                url = PagesResolver.getDynamicPageUrl(
                    LogViewerPageRest::class.java,
                    id = ensureUserLogSubscription().id
                ),
                type = MenuItemTargetType.REDIRECT,
            )
        }
    }
}

Git History

868d6abb7 2025 -> 2026
63081666f Source file headers: 2024-> 2025.
3785f8347 Migration stuff in progress...
67805f2fc ThreadLocalUserContext.user -> ThreadLocalUserContext.loggedInUser (renamed for avoiding mis-understandings in code).
b6092df09 Copyright 2023 -> 2024