001/*
002 *  Copyright 2019 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.project.notification;
017
018import java.io.ByteArrayOutputStream;
019import java.io.IOException;
020import java.io.InputStream;
021import java.util.List;
022import java.util.Map;
023
024import org.apache.avalon.framework.context.Context;
025import org.apache.avalon.framework.context.ContextException;
026import org.apache.avalon.framework.context.Contextualizable;
027import org.apache.avalon.framework.service.ServiceException;
028import org.apache.avalon.framework.service.ServiceManager;
029import org.apache.avalon.framework.service.Serviceable;
030import org.apache.cocoon.components.ContextHelper;
031import org.apache.cocoon.environment.Request;
032import org.apache.commons.lang3.StringUtils;
033import org.apache.excalibur.source.Source;
034import org.apache.excalibur.source.SourceResolver;
035import org.apache.excalibur.source.SourceUtil;
036
037import org.ametys.core.group.GroupManager;
038import org.ametys.core.observation.AsyncObserver;
039import org.ametys.core.observation.Event;
040import org.ametys.core.user.UserManager;
041import org.ametys.core.util.I18nUtils;
042import org.ametys.core.util.language.UserLanguagesManager;
043import org.ametys.core.util.mail.SendMailHelper;
044import org.ametys.plugins.repository.AmetysObjectResolver;
045import org.ametys.plugins.workspaces.ObservationConstants;
046import org.ametys.plugins.workspaces.WorkspacesHelper;
047import org.ametys.plugins.workspaces.members.ProjectMemberManager;
048import org.ametys.plugins.workspaces.project.ProjectManager;
049import org.ametys.plugins.workspaces.project.objects.Project;
050import org.ametys.runtime.i18n.I18nizableText;
051import org.ametys.runtime.plugin.component.AbstractLogEnabled;
052import org.ametys.runtime.plugin.component.PluginAware;
053import org.ametys.web.WebConstants;
054import org.ametys.web.population.PopulationContextHelper;
055import org.ametys.web.renderingcontext.RenderingContext;
056import org.ametys.web.renderingcontext.RenderingContextHandler;
057import org.ametys.web.repository.site.Site;
058import org.ametys.web.repository.site.SiteManager;
059
060import jakarta.mail.MessagingException;
061
062/**
063 * Abstract observer for sending mail to members
064 */
065public abstract class AbstractMemberMailNotifierObserver  extends AbstractLogEnabled implements AsyncObserver, PluginAware, Serviceable, Contextualizable
066{
067    /** The avalon context */
068    protected Context _context;
069    /** The name of current plugin */
070    protected String _pluginName;
071    /** The Ametys Object resolver */
072    protected AmetysObjectResolver _resolver;
073    /** The i18n utils */
074    protected I18nUtils _i18nUtils;
075    /** The project member manager */
076    protected ProjectMemberManager _projectMemberManager;
077    /** Project manager */
078    protected ProjectManager _projectManager;
079    /** Site manager */
080    protected SiteManager _siteManager;
081    /** Population context helper */
082    protected PopulationContextHelper _populationContextHelper;
083    /** Source Resolver */
084    protected SourceResolver _srcResolver;
085    /** User manager */
086    protected UserManager _userManager;
087    /** Group manager */
088    protected GroupManager _groupManager;
089    /** The rendering context */
090    protected RenderingContextHandler _renderingContextHandler;
091    /** The user languages manager */
092    protected UserLanguagesManager _userLanguagesManager;
093    /** The workspaces helper */
094    protected WorkspacesHelper _workspacesHelper;
095    
096    
097    @Override
098    public void setPluginInfo(String pluginName, String featureName, String id)
099    {
100        _pluginName = pluginName;
101    }
102    
103    @Override
104    public void contextualize(Context context) throws ContextException
105    {
106        _context = context;
107    }
108    
109    public void service(ServiceManager manager) throws ServiceException
110    {
111        _resolver = (AmetysObjectResolver) manager.lookup(AmetysObjectResolver.ROLE);
112        _i18nUtils = (I18nUtils) manager.lookup(I18nUtils.ROLE);
113        _projectMemberManager = (ProjectMemberManager) manager.lookup(ProjectMemberManager.ROLE);
114        _projectManager = (ProjectManager) manager.lookup(ProjectManager.ROLE);
115        _siteManager = (SiteManager) manager.lookup(SiteManager.ROLE);
116        _populationContextHelper = (PopulationContextHelper) manager.lookup(org.ametys.core.user.population.PopulationContextHelper.ROLE);
117        _srcResolver = (SourceResolver) manager.lookup(SourceResolver.ROLE);
118        _userManager = (UserManager) manager.lookup(UserManager.ROLE);
119        _groupManager = (GroupManager) manager.lookup(GroupManager.ROLE);
120        _renderingContextHandler = (RenderingContextHandler) manager.lookup(RenderingContextHandler.ROLE);
121        _userLanguagesManager = (UserLanguagesManager) manager.lookup(UserLanguagesManager.ROLE);
122        _workspacesHelper = (WorkspacesHelper) manager.lookup(WorkspacesHelper.ROLE);
123    }
124    
125    @Override
126    public int getPriority()
127    {
128        return MIN_PRIORITY;
129    }
130    
131    @Override
132    public void observe(Event event, Map<String, Object> transientVars) throws Exception
133    {
134        Map<String, Object> args = event.getArguments();
135        
136        String projectId = (String) args.get(ObservationConstants.ARGS_PROJECT_ID);
137        Project project = _resolver.resolveById(projectId);
138        Site site = project.getSite();
139        String lang = _workspacesHelper.getLang(project, _userLanguagesManager.getDefaultLanguage());
140        // Compute subject and body
141        I18nizableText i18nSubject = getI18nSubject(event, project);
142        
143        // Send mail to removed members
144        Map<String, List<String>> recipientsByLanguage = getUserToNotifyByLanguage(event, project);
145        
146        for (String language : recipientsByLanguage.keySet())
147        {
148            String userLanguage = StringUtils.defaultIfBlank(language, lang);
149            
150            String subject = _i18nUtils.translate(i18nSubject, userLanguage);
151            
152            String mailBody = null;
153            Source source = null;
154            RenderingContext currentContext = _renderingContextHandler.getRenderingContext();
155            try
156            {
157                // Force rendering context.FRONT to resolve URI
158                _renderingContextHandler.setRenderingContext(RenderingContext.FRONT);
159                Request request = ContextHelper.getRequest(_context);
160                request.setAttribute("forceAbsoluteUrl", true);
161                request.setAttribute("lang", userLanguage);
162                request.setAttribute(WebConstants.REQUEST_ATTR_SITE, site);
163                request.setAttribute(WebConstants.REQUEST_ATTR_SITE_NAME, site.getName());
164                request.setAttribute(WebConstants.REQUEST_ATTR_SKIN_ID, site.getSkinId());
165                source = _srcResolver.resolveURI(getMailBodyURI(event, project), null, Map.of("event", event, "project", project));
166                try (InputStream is = source.getInputStream())
167                {
168                    ByteArrayOutputStream bos = new ByteArrayOutputStream();
169                    SourceUtil.copy(is, bos);
170                    
171                    mailBody = bos.toString("UTF-8");
172                }
173            }
174            catch (IOException e)
175            {
176                throw new RuntimeException("Failed to create mail body", e);
177            }
178            finally
179            {
180                _renderingContextHandler.setRenderingContext(currentContext);
181                
182                if (source != null)
183                {
184                    _srcResolver.release(source);
185                }
186            }
187            
188            try
189            {
190                SendMailHelper.newMail()
191                    .withSubject(subject)
192                    .withHTMLBody(mailBody)
193                    .withRecipients(recipientsByLanguage.get(language))
194                    .withAsync(true)
195                    .withInlineCSS(false)
196                    .sendMail();
197            }
198            catch (MessagingException | IOException e)
199            {
200                getLogger().warn("Could not send a notification e-mail to " + recipientsByLanguage + " following his removal from the project " + project.getTitle(), e);
201            }
202        }
203    }
204    
205    /**
206     * Get recipients' emails sorted by language
207     * @param event the event
208     * @param project the project
209     * @return the recipients' emails sorted by language
210     */
211    protected abstract Map<String, List<String>> getUserToNotifyByLanguage(Event event, Project project);
212    
213    /**
214     * Returns the URI for HTML mail body
215     * @param event the event
216     * @param project the project
217     * @return The URI for HTML mail body
218     */
219    protected String getMailBodyURI(Event event, Project project)
220    {
221        return "cocoon://_plugins/workspaces/notification-mail-member";
222    }
223    
224    /**
225     * Get the {@link I18nizableText} for mail subject
226     * @param event the event
227     * @param project the project
228     * @return the {@link I18nizableText} for subject
229     */
230    protected abstract I18nizableText getI18nSubject(Event event, Project project);
231}