001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 Echo Three, LLC
003//
004// Licensed under the Apache License, Version 2.0 (the "License");
005// you may not use this file except in compliance with the License.
006// You may obtain a copy of the License at
007//
008//     http://www.apache.org/licenses/LICENSE-2.0
009//
010// Unless required by applicable law or agreed to in writing, software
011// distributed under the License is distributed on an "AS IS" BASIS,
012// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013// See the License for the specific language governing permissions and
014// limitations under the License.
015// --------------------------------------------------------------------------------
016
017package com.echothree.model.control.forum.server.transfer;
018
019import com.echothree.model.control.core.server.control.MimeTypeControl;
020import com.echothree.model.control.forum.common.ForumOptions;
021import com.echothree.model.control.forum.common.transfer.ForumMessageAttachmentTransfer;
022import com.echothree.model.control.forum.server.control.ForumControl;
023import com.echothree.model.data.forum.server.entity.ForumMessageAttachment;
024import com.echothree.model.data.user.server.entity.UserVisit;
025import com.echothree.util.common.persistence.type.ByteArray;
026import com.echothree.util.server.persistence.Session;
027import javax.enterprise.context.RequestScoped;
028
029@RequestScoped
030public class ForumMessageAttachmentTransferCache
031        extends BaseForumTransferCache<ForumMessageAttachment, ForumMessageAttachmentTransfer> {
032
033    ForumControl forumControl = Session.getModelController(ForumControl.class);
034    MimeTypeControl mimeTypeControl = Session.getModelController(MimeTypeControl.class);
035
036    boolean includeBlob;
037    boolean includeClob;
038    boolean includeETag;
039    
040    /** Creates a new instance of ForumMessageAttachmentTransferCache */
041    protected ForumMessageAttachmentTransferCache() {
042        super();
043        
044        var options = session.getOptions();
045        if(options != null) {
046            includeBlob = options.contains(ForumOptions.ForumMessageAttachmentIncludeBlob);
047            includeClob = options.contains(ForumOptions.ForumMessageAttachmentIncludeClob);
048            includeETag = options.contains(ForumOptions.ForumMessageAttachmentIncludeETag);
049        }
050        
051        setIncludeEntityInstance(true);
052    }
053    
054    public ForumMessageAttachmentTransfer getForumMessageAttachmentTransfer(UserVisit userVisit, ForumMessageAttachment forumMessageAttachment) {
055        var forumMessageAttachmentTransfer = get(forumMessageAttachment);
056        
057        if(forumMessageAttachmentTransfer == null) {
058            var forumMessageAttachmentDetail = forumMessageAttachment.getLastDetail();
059            var forumMessage = forumControl.getForumMessageTransfer(userVisit, forumMessageAttachmentDetail.getForumMessage());
060            var forumMessageAttachmentSequence = forumMessageAttachmentDetail.getForumMessageAttachmentSequence();
061            var mimeType = mimeTypeControl.getMimeTypeTransfer(userVisit, forumMessageAttachmentDetail.getMimeType());
062            var description = forumControl.getBestForumMessageAttachmentDescription(forumMessageAttachment, getLanguage(userVisit));
063            ByteArray blob = null;
064            String clob = null;
065            String eTag = null;
066            long eTagEntityId = 0;
067            var eTagSize = 0;
068            
069            if(includeBlob) {
070                var forumMessageAttachmentBlob = forumControl.getForumMessageBlobAttachment(forumMessageAttachment);
071                
072                if(forumMessageAttachmentBlob != null) {
073                    blob = forumMessageAttachmentBlob.getBlob();
074                }
075            }
076            
077            if(includeClob) {
078                var forumMessageAttachmentClob = forumControl.getForumMessageClobAttachment(forumMessageAttachment);
079                
080                if(forumMessageAttachmentClob != null) {
081                    clob = forumMessageAttachmentClob.getClob();
082                }
083            }
084            
085            if(includeETag && eTagEntityId != 0) {
086                // Forum Message Attachments do not have their own EntityTime, fall back on the Item's EntityTime.
087                var entityTimeTransfer = forumMessage.getEntityInstance().getEntityTime();
088                var modifiedTime = entityTimeTransfer.getUnformattedModifiedTime();
089                long maxTime = modifiedTime == null ? entityTimeTransfer.getUnformattedCreatedTime() : modifiedTime;
090
091                // EntityId-Size-ModifiedTime
092                eTag = Long.toHexString(eTagEntityId) + '-' + Integer.toHexString(eTagSize) + '-' + Long.toHexString(maxTime);
093            }
094
095            forumMessageAttachmentTransfer = new ForumMessageAttachmentTransfer(forumMessage, forumMessageAttachmentSequence, mimeType, description, blob, clob,
096                    eTag);
097            put(userVisit, forumMessageAttachment, forumMessageAttachmentTransfer);
098        }
099        
100        return forumMessageAttachmentTransfer;
101    }
102    
103}