001/*
002 *  Copyright 2024 Anyware Services
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 */
016package org.ametys.plugins.workspaces.comments;
017
018import java.util.List;
019import java.util.Map;
020
021import org.apache.avalon.framework.context.Context;
022import org.apache.avalon.framework.context.ContextException;
023import org.apache.avalon.framework.service.ServiceException;
024import org.apache.avalon.framework.service.ServiceManager;
025import org.apache.cocoon.components.ContextHelper;
026import org.apache.cocoon.environment.Request;
027
028import org.ametys.cms.repository.comment.RichTextComment;
029import org.ametys.core.observation.Event;
030import org.ametys.core.user.User;
031import org.ametys.core.user.UserIdentity;
032import org.ametys.plugins.workspaces.ObservationConstants;
033import org.ametys.plugins.workspaces.forum.ForumWorkspaceModule;
034import org.ametys.plugins.workspaces.forum.Thread;
035import org.ametys.plugins.workspaces.forum.json.ThreadJSONHelper;
036import org.ametys.plugins.workspaces.project.modules.WorkspaceModuleExtensionPoint;
037import org.ametys.plugins.workspaces.project.objects.Project;
038import org.ametys.runtime.i18n.I18nizableText;
039import org.ametys.web.WebHelper;
040
041/**
042 * Observer to send mails to mentioned users in contributor comments of {@link Thread}
043 */
044public class NotifyThreadCommentMentionsObserver extends AbstractNotifyWorkspacesCommentMentionsObserver<Thread>
045{
046    
047    /** The forum module */
048    protected ForumWorkspaceModule _forumModule;
049    
050    /** The project tags DAO */
051    protected ThreadJSONHelper _threadJSONHelper;
052    
053    @Override
054    public void service(ServiceManager manager) throws ServiceException
055    {
056        super.service(manager);
057        WorkspaceModuleExtensionPoint moduleManagerEP = (WorkspaceModuleExtensionPoint) manager.lookup(WorkspaceModuleExtensionPoint.ROLE);
058        _forumModule = moduleManagerEP.getModule(ForumWorkspaceModule.FORUM_MODULE_ID);
059        _threadJSONHelper = (ThreadJSONHelper) manager.lookup(ThreadJSONHelper.ROLE);
060    }
061
062    @Override
063    public void contextualize(Context context) throws ContextException
064    {
065        _context = context;
066    }
067    
068    public boolean supports(Event event)
069    {
070        return event.getId().equals(ObservationConstants.EVENT_THREAD_COMMENTED);
071    }
072    
073    @Override
074    protected String _getAmetysObjectTitle(Thread thread)
075    {
076        return thread.getTitle();
077    }
078
079    @Override
080    protected I18nizableText _getMailMessage(MentionableObject mentionableObject)
081    {
082        Thread thread = (Thread) mentionableObject.ametysObject();
083        Project project = _projectManager.getParentProject(thread);
084        User author = mentionableObject.author();
085        List<String> i18nParams = List.of(author.getFullName(), _getAmetysObjectTitle(thread), project.getTitle());
086        return new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_THREAD_COMMENT_MENTION_MAIL_MESSAGE", i18nParams);
087    }
088    
089    private String _getContent(RichTextComment comment, Project project) throws Exception
090    {
091        Request request = ContextHelper.getRequest(_context);
092        String siteName = WebHelper.getSiteName(request);
093        if (siteName == null)
094        {
095            request.setAttribute("site", project.getSite().getName());
096        }
097        return _threadJSONHelper.richTextToRendering(comment.getRichTextContent());
098    }
099    
100    @Override
101    protected String _transformSyntaxTextToReadableTextWithColors(String content, UserIdentity recipient)
102    {
103        return _mentionUtils.transformRichTextToReadableText(content, recipient);
104    }
105
106    @Override
107    protected MentionableObject _getMentionableObjectFromArguments(Map<String, Object> arguments) throws Exception
108    {
109        Thread thread = _getAmetysObjectFromArguments(arguments);
110        RichTextComment comment = (RichTextComment) arguments.get(ObservationConstants.ARGS_THREAD_COMMENT);
111        comment = thread.getComment(comment.getId());
112        Project project = _projectManager.getParentProject(thread);
113        String url = _getAbsoluteUrl(thread, project);
114        String content = _getContent(comment, project);
115
116        return new MentionableObject(
117            _userManager.getUser(comment.getAuthor()),
118            content,
119            _mentionUtils.extractMentionedUsersFromRichText(content),
120            comment.getCreationDate(),
121            thread,
122            new LinkToAmetysObject(url, new I18nizableText("plugin.workspaces", "PROJECT_MAIL_NOTIFICATION_BODY_FORUMTHREAD_BUTTON_TEXT")),
123            _getLanguage(project)
124        );
125    }
126
127    @Override
128    protected I18nizableText _getMailMessageType()
129    {
130        return new I18nizableText("plugin.workspaces", "PLUGINS_WORKSPACES_THREAD_MENTION_MAIL_THREAD_COMMENT_TITLE");
131    }
132    
133    @Override
134    protected String _getModuleId()
135    {
136        return ForumWorkspaceModule.FORUM_MODULE_ID;
137    }
138
139    @Override
140    protected String getUrl(Thread thread, Project project)
141    {
142        return _forumModule.getThreadUri(project, thread.getId());
143    }
144}