001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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 javax.inject.Inject;
020import com.echothree.model.control.forum.common.ForumOptions;
021import com.echothree.model.control.forum.common.transfer.ForumMessagePartTransfer;
022import com.echothree.model.control.forum.common.transfer.ForumMessageTransfer;
023import com.echothree.model.control.forum.server.control.ForumControl;
024import com.echothree.model.control.icon.server.control.IconControl;
025import com.echothree.model.data.forum.server.entity.ForumMessage;
026import com.echothree.model.data.user.server.entity.UserVisit;
027import com.echothree.util.common.transfer.ListWrapper;
028import com.echothree.util.common.transfer.MapWrapper;
029import javax.enterprise.context.RequestScoped;
030
031@RequestScoped
032public class ForumMessageTransferCache
033        extends BaseForumTransferCache<ForumMessage, ForumMessageTransfer> {
034
035    @Inject
036    ForumControl forumControl;
037
038    @Inject
039    IconControl iconControl;
040
041    boolean includeForumMessageRoles;
042    boolean includeForumMessageParts;
043    boolean includeForumMessageAttachments;
044
045    /** Creates a new instance of ForumMessageTransferCache */
046    protected ForumMessageTransferCache() {
047        super();
048
049        var options = session.getOptions();
050        if(options != null) {
051            setIncludeUuid(options.contains(ForumOptions.ForumMessageIncludeUuid));
052            includeForumMessageRoles = options.contains(ForumOptions.ForumMessageIncludeForumMessageRoles);
053            includeForumMessageParts = options.contains(ForumOptions.ForumMessageIncludeForumMessageParts);
054            includeForumMessageAttachments = options.contains(ForumOptions.ForumMessageIncludeForumMessageAttachments);
055            setIncludeEntityAttributeGroups(options.contains(ForumOptions.ForumMessageIncludeEntityAttributeGroups));
056            setIncludeTagScopes(options.contains(ForumOptions.ForumMessageIncludeTagScopes));
057        }
058        
059        setIncludeEntityInstance(true);
060    }
061
062    public ForumMessageTransfer getForumMessageTransfer(UserVisit userVisit, ForumMessage forumMessage) {
063        var forumMessageTransfer = get(forumMessage);
064
065        if(forumMessageTransfer == null) {
066            var forumMessageDetail = forumMessage.getLastDetail();
067            var forumMessageName = forumMessageDetail.getForumMessageName();
068            var forumThreadTransfer = forumControl.getForumThreadTransfer(userVisit, forumMessageDetail.getForumThread());
069            var forumMessageTypeTransfer = forumControl.getForumMessageTypeTransfer(userVisit, forumMessageDetail.getForumMessageType());
070            var parentForumMessage = forumMessageDetail.getParentForumMessage();
071            var parentForumMessageTransfer = parentForumMessage == null ? null : forumControl.getForumMessageTransfer(userVisit, parentForumMessage);
072            var icon = forumMessageDetail.getIcon();
073            var iconTransfer = icon == null ? null : iconControl.getIconTransfer(userVisit, icon);
074            var unformattedPostedTime = forumMessageDetail.getPostedTime();
075            var postedTime = formatTypicalDateTime(userVisit, unformattedPostedTime);
076
077            forumMessageTransfer = new ForumMessageTransfer(forumMessageName, forumThreadTransfer, forumMessageTypeTransfer, parentForumMessageTransfer, iconTransfer, unformattedPostedTime, postedTime);
078            put(userVisit, forumMessage, forumMessageTransfer);
079
080            if(includeForumMessageRoles) {
081                forumMessageTransfer.setForumMessageRoles(new ListWrapper<>(forumControl.getForumMessageRoleTransfersByForumMessage(userVisit, forumMessage)));
082            }
083
084            if(includeForumMessageParts) {
085                var forumMessagePartTransfers = forumControl.getForumMessagePartTransfersByForumMessageAndLanguage(userVisit, forumMessage, getLanguage(userVisit));
086                var forumMessageParts = new MapWrapper<ForumMessagePartTransfer>(forumMessagePartTransfers.size());
087
088                forumMessagePartTransfers.forEach((forumMessagePartTransfer) -> {
089                    forumMessageParts.put(forumMessagePartTransfer.getForumMessagePartType().getForumMessagePartTypeName(), forumMessagePartTransfer);
090                });
091
092                forumMessageTransfer.setForumMessageParts(forumMessageParts);
093            }
094
095            if(includeForumMessageAttachments) {
096                forumMessageTransfer.setForumMessageAttachments(new ListWrapper<>(forumControl.getForumMessageAttachmentTransfersByForumMessage(userVisit, forumMessage)));
097            }
098        }
099
100        return forumMessageTransfer;
101    }
102}