BookDO.kt

/////////////////////////////////////////////////////////////////////////////
//
// Project ProjectForge Community Edition
//         www.projectforge.org
//
// Copyright (C) 2001-2026 Micromata GmbH, Germany (www.micromata.com)
//
// ProjectForge is dual-licensed.
//
// This community edition is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as published
// by the Free Software Foundation; version 3 of the License.
//
// This community edition is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
// Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, see http://www.gnu.org/licenses/.
//
/////////////////////////////////////////////////////////////////////////////

package org.projectforge.business.book

import com.fasterxml.jackson.annotation.JsonIgnore
import com.fasterxml.jackson.databind.annotation.JsonSerialize
import org.apache.commons.lang3.StringUtils
import org.hibernate.annotations.Fetch
import org.hibernate.annotations.FetchMode
import org.projectforge.common.anots.PropertyInfo
import org.projectforge.framework.DisplayNameCapable
import org.projectforge.framework.jcr.AttachmentsInfo
import org.projectforge.framework.persistence.entities.DefaultBaseDO
import org.projectforge.framework.persistence.user.entities.PFUserDO
import java.time.LocalDate
import jakarta.persistence.*
import org.hibernate.search.mapper.pojo.automaticindexing.ReindexOnUpdate
import org.hibernate.search.mapper.pojo.mapping.definition.annotation.*
import org.projectforge.framework.json.IdOnlySerializer
import org.projectforge.framework.persistence.history.NoHistory

/**
 * For managing libraries including lend-out functionality.
 *
 * @author Kai Reinhard
 */
@Entity
@Indexed
@Table(name = "T_BOOK",
        uniqueConstraints = [UniqueConstraint(columnNames = ["signature"])],
        indexes = [jakarta.persistence.Index(name = "idx_fk_t_book_lend_out_by",
                columnList = "lend_out_by"), jakarta.persistence.Index(name = "t_book_pkey", columnList = "pk")])
@NamedQueries(
        NamedQuery(name = BookDO.FIND_BY_SIGNATURE, query = "from BookDO where signature=:signature"),
        NamedQuery(name = BookDO.FIND_OTHER_BY_SIGNATURE, query = "from BookDO where signature=:signature and id<>:id"))
open class BookDO : DefaultBaseDO(), DisplayNameCapable, AttachmentsInfo {
    override val displayName: String
        @Transient
        get() = "$authors: $title"

    @PropertyInfo(i18nKey = "book.title", required = true)
    @FullTextField
    @get:Column(length = 255)
    open var title: String? = null

    @PropertyInfo(i18nKey = "book.keywords")
    @FullTextField
    @get:Column(length = 1024)
    open var keywords: String? = null

    @PropertyInfo(i18nKey = "book.lendOutBy")
    @IndexedEmbedded(includeDepth = 1, includePaths = ["username", "firstname", "lastname"])
    @get:ManyToOne(fetch = FetchType.LAZY)
    @get:IndexingDependency(reindexOnUpdate = ReindexOnUpdate.SHALLOW)
    @get:Fetch(FetchMode.SELECT)
    @get:JoinColumn(name = "lend_out_by")
    @JsonSerialize(using = IdOnlySerializer::class)
    open var lendOutBy: PFUserDO? = null

    @PropertyInfo(i18nKey = "date")
    @GenericField //was @FullTextField(analyze = Analyze.NO)
    @get:Column(name = "lend_out_date")
    open var lendOutDate: LocalDate? = null

    @PropertyInfo(i18nKey = "book.lendOutNote")
    @FullTextField
    @get:Column(name = "lend_out_comment", length = 1024)
    open var lendOutComment: String? = null

    @PropertyInfo(i18nKey = "book.isbn")
    @FullTextField
    @get:Column(length = 255)
    open var isbn: String? = null

    @PropertyInfo(i18nKey = "book.signature")
    @FullTextField // Tokenisierte Version für Full-Text-Suche
    @KeywordField(name = "signature_exact") // Unveränderte Version für exakte Suchen
    @get:Column(length = 255)
    open var signature: String? = null

    @PropertyInfo(i18nKey = "book.publisher")
    @FullTextField
    @get:Column(length = 255)
    open var publisher: String? = null

    @PropertyInfo(i18nKey = "book.editor")
    @FullTextField
    @get:Column(length = 255)
    open var editor: String? = null

    @PropertyInfo(i18nKey = "book.yearOfPublishing")
    @GenericField(name = "year")// was: @FullTextField(index = Index.YES, store = Store.NO, name = "year")
    @get:Column(name = "year_of_publishing", length = 4)
    open var yearOfPublishing: String? = null

    @PropertyInfo(i18nKey = "book.authors")
    @FullTextField
    @get:Column(length = 1000)
    open var authors: String? = null

    @PropertyInfo(i18nKey = "book.abstract")
    @GenericField(name = "abstract") // was: @FullTextField(index = Index.YES, store = Store.NO, name = "abstract")
    @get:Column(name = "abstract_text", length = 4000)
    open var abstractText: String? = null

    @PropertyInfo(i18nKey = "comment")
    @FullTextField
    @get:Column(length = 1000)
    open var comment: String? = null

    @PropertyInfo(i18nKey = "status")
    @GenericField // was: @FullTextField(index = Index.YES, analyze = Analyze.NO, store = Store.NO)
    @get:Enumerated(EnumType.STRING)
    @get:Column(length = 20, nullable = false)
    open var status: BookStatus? = null

    @PropertyInfo(i18nKey = "book.type")
    @GenericField // was: @FullTextField(index = Index.YES, analyze = Analyze.NO, store = Store.NO)
    @get:Enumerated(EnumType.STRING)
    @get:Column(name = "book_type", length = 20, nullable = true)
    open var type: BookType? = null

    /**
     * Converts numbers in signature for alphanumeric sorting in 5-digit form. For example: "WT-145a" -&gt; "WT-00145a".
     */
    val signature4Sort: String?
        @Transient
        get() {
            if (this.signature == null) {
                return null
            }
            val buf = StringBuilder()
            var no: StringBuilder? = null
            for (i in 0 until this.signature!!.length) {
                val ch = this.signature!![i]
                if (!Character.isDigit(ch)) {
                    if (no != null && no.isNotEmpty()) {
                        buf.append(StringUtils.leftPad(no.toString(), 5, '0'))
                        no = null
                    }
                    buf.append(ch)
                } else {
                    if (no == null) {
                        no = StringBuilder()
                    }
                    no.append(ch)
                }
            }
            if (no != null && no.isNotEmpty()) {
                buf.append(StringUtils.leftPad(no.toString(), 5, '0'))
            }
            return buf.toString()
        }

    @JsonIgnore
    @FullTextField
    @NoHistory
    @get:Column(length = 10000, name = "attachments_names")
    override var attachmentsNames: String? = null

    @JsonIgnore
    @FullTextField
    @NoHistory
    @get:Column(length = 10000, name = "attachments_ids")
    override var attachmentsIds: String? = null

    @JsonIgnore
    @NoHistory
    @get:Column(length = 10000, name = "attachments_counter")
    override var attachmentsCounter: Int? = null

    @JsonIgnore
    @NoHistory
    @get:Column(length = 10000, name = "attachments_size")
    override var attachmentsSize: Long? = null

    @PropertyInfo(i18nKey = "attachment")
    @JsonIgnore
    @get:Column(length = 10000, name = "attachments_last_user_action")
    override var attachmentsLastUserAction: String? = null

    companion object {
        internal const val FIND_BY_SIGNATURE = "BookDO_FindBySignature"

        internal const val FIND_OTHER_BY_SIGNATURE = "BookDO_FindOtherBySignature"
    }
}