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.ForumGroupTransfer;
022import com.echothree.model.control.forum.server.control.ForumControl;
023import com.echothree.model.control.icon.server.control.IconControl;
024import com.echothree.model.data.forum.server.entity.Forum;
025import com.echothree.model.data.forum.server.entity.ForumGroup;
026import com.echothree.model.data.user.server.entity.UserVisit;
027import com.echothree.util.common.transfer.ListWrapper;
028import java.util.ArrayList;
029import java.util.List;
030import javax.enterprise.context.RequestScoped;
031
032@RequestScoped
033public class ForumGroupTransferCache
034        extends BaseForumTransferCache<ForumGroup, ForumGroupTransfer> {
035
036    @Inject
037    ForumControl forumControl;
038
039    @Inject
040    IconControl iconControl;
041
042    boolean includeForums;
043    
044    /** Creates a new instance of ForumGroupTransferCache */
045    protected ForumGroupTransferCache() {
046        super();
047        
048        var options = session.getOptions();
049        if(options != null) {
050            includeForums = options.contains(ForumOptions.ForumGroupIncludeForums);
051            setIncludeEntityAttributeGroups(options.contains(ForumOptions.ForumGroupIncludeEntityAttributeGroups));
052            setIncludeTagScopes(options.contains(ForumOptions.ForumGroupIncludeTagScopes));
053        }
054        
055        setIncludeEntityInstance(true);
056    }
057    
058    public ForumGroupTransfer getForumGroupTransfer(UserVisit userVisit, ForumGroup forumGroup) {
059        var forumGroupTransfer = get(forumGroup);
060        
061        if(forumGroupTransfer == null) {
062            var forumGroupDetail = forumGroup.getLastDetail();
063            var forumGroupName = forumGroupDetail.getForumGroupName();
064            var icon = forumGroupDetail.getIcon();
065            var iconTransfer = icon == null? null: iconControl.getIconTransfer(userVisit, icon);
066            var sortOrder = forumGroupDetail.getSortOrder();
067            var description = forumControl.getBestForumGroupDescription(forumGroup, getLanguage(userVisit));
068            
069            forumGroupTransfer = new ForumGroupTransfer(forumGroupName, iconTransfer, sortOrder, description);
070            put(userVisit, forumGroup, forumGroupTransfer);
071            
072            if(includeForums) {
073                var forumGroupForums = forumControl.getForumGroupForumsByForumGroup(forumGroup);
074                List<Forum> forums = new ArrayList<>(forumGroupForums.size());
075                
076                forumGroupForums.forEach((forumGroupForum) -> {
077                    forums.add(forumGroupForum.getForum());
078                });
079                
080                forumGroupTransfer.setForums(new ListWrapper<>(forumControl.getForumTransfers(userVisit, forums)));
081            }
082        }
083        
084        return forumGroupTransfer;
085    }
086    
087}