Source code

001/*
002 *  Copyright 2013 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.web.repository.page.actions;
017
018import java.io.IOException;
019import java.util.HashMap;
020import java.util.HashSet;
021import java.util.List;
022import java.util.Map;
023import java.util.Set;
024import java.util.stream.Collectors;
025
026import org.apache.avalon.framework.parameters.Parameters;
027import org.apache.avalon.framework.service.ServiceException;
028import org.apache.avalon.framework.service.ServiceManager;
029import org.apache.cocoon.acting.ServiceableAction;
030import org.apache.cocoon.environment.ObjectModelHelper;
031import org.apache.cocoon.environment.Redirector;
032import org.apache.cocoon.environment.SourceResolver;
033import org.apache.commons.lang.StringUtils;
034
035import org.ametys.core.group.Group;
036import org.ametys.core.group.GroupIdentity;
037import org.ametys.core.group.GroupManager;
038import org.ametys.core.ui.mail.StandardMailBodyHelper;
039import org.ametys.core.user.CurrentUserProvider;
040import org.ametys.core.user.User;
041import org.ametys.core.user.UserIdentity;
042import org.ametys.core.user.UserManager;
043import org.ametys.core.util.I18nUtils;
044import org.ametys.core.util.mail.SendMailHelper;
045import org.ametys.plugins.core.user.UserHelper;
046import org.ametys.plugins.repository.AmetysObjectResolver;
047import org.ametys.runtime.config.Config;
048import org.ametys.runtime.i18n.I18nizableText;
049import org.ametys.runtime.i18n.I18nizableTextParameter;
050import org.ametys.web.repository.page.Page;
051import org.ametys.web.repository.site.Site;
052
053import jakarta.mail.MessagingException;
054
055/**
056 * This actions send a email to notify the publication of a page.
057 *
058 */
059public class SendOnlineNotificationAction extends ServiceableAction
060{
061    private UserManager _userManager;
062    private GroupManager _groupManager;
063    private AmetysObjectResolver _resolver;
064    private I18nUtils _i18nUtils;
065    private CurrentUserProvider _userProvider;
066    private UserHelper _userHelper;
067    
068    @Override
069    public void service(ServiceManager smanager) throws ServiceException
070    {
071        super.service(smanager);
072        _userManager = (UserManager) smanager.lookup(UserManager.ROLE);
073        _userProvider = (CurrentUserProvider) smanager.lookup(CurrentUserProvider.ROLE);
074        _resolver = (AmetysObjectResolver) smanager.lookup(AmetysObjectResolver.ROLE);
075        _groupManager = (GroupManager) smanager.lookup(GroupManager.ROLE);
076        _i18nUtils = (I18nUtils) smanager.lookup(I18nUtils.ROLE);
077        _userHelper = (UserHelper) smanager.lookup(UserHelper.ROLE);
078    }
079    
080    @Override
081    public Map act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters parameters) throws Exception
082    {
083        @SuppressWarnings("unchecked")
084        Map<String, Object> jsParameters = (Map<String, Object>) objectModel.get(ObjectModelHelper.PARENT_CONTEXT);
085        
086        String pageId = (String) jsParameters.get("id");
087        Page page = _resolver.resolveById(pageId);
088        
089        UserIdentity userIdentity = _userProvider.getUser();
090        User notifier = _userManager.getUser(userIdentity.getPopulationId(), userIdentity.getLogin());
091        
092        String from = _getSender(notifier, page);
093        
094        @SuppressWarnings("unchecked")
095        List<Map<String, String>> jsUsers = (List<Map<String, String>>) jsParameters.get("users");
096        List<UserIdentity> userIdentities = jsUsers.stream()
097                .map(_userHelper::json2userIdentity)
098                .collect(Collectors.toList());
099        
100        @SuppressWarnings("unchecked")
101        List<Map<String, String>> jsGroups = (List<Map<String, String>>) jsParameters.get("groups");
102        List<GroupIdentity> groupIdentities = jsGroups.stream()
103                .map(jsGroup -> new GroupIdentity(jsGroup.get("id"), jsGroup.get("groupDirectory")))
104                .collect(Collectors.toList());
105        
106        Map<String, Set<User>> distinctUsersByLanguage = _getDistinctUsersByLanguage(userIdentities, groupIdentities);
107        for (String language : distinctUsersByLanguage.keySet())
108        {
109            String lang = StringUtils.defaultIfEmpty(language, page.getSitemapName());
110            String subject = _getSubject (notifier, page, lang);
111
112            for (User user : distinctUsersByLanguage.get(language))
113            {
114                String email = user.getEmail();
115                if (StringUtils.isNotEmpty(email))
116                {
117                    try
118                    {
119                        String body = _getBody(notifier, user, page, lang);
120                        
121                        SendMailHelper.newMail()
122                                      .withSubject(subject)
123                                      .withHTMLBody(body)
124                                      .withSender(from)
125                                      .withRecipient(email)
126                                      .sendMail();
127                    }
128                    catch (MessagingException | IOException e)
129                    {
130                        getLogger().error("Unable to send mail to user " + user.getEmail(), e);
131                    }
132                }
133            }
134        }
135        
136        return EMPTY_MAP;
137    }
138    
139    /**
140     * Get the email sender
141     * @param sender The user responsible for the action
142     * @param page The published page
143     * @return The sender
144     */
145    protected String _getSender (User sender, Page page)
146    {
147        if (sender != null && sender.getEmail() != null)
148        {
149            return sender.getFullName() + " <" + sender.getEmail() + ">";
150        }
151
152        Site site = page.getSite();
153        String defaultFromValue = Config.getInstance().getValue("smtp.mail.from");
154        return site.getValue("site-mail-from", false, defaultFromValue);
155    }
156    
157    /**
158     * Get the email subject
159     * @param sender The user responsible for the notification
160     * @param page The published page
161     * @param language The language
162     * @return The email subject
163     */
164    protected String _getSubject (User sender, Page page, String language)
165    {
166        Site site = page.getSite();
167        
168        Map<String, I18nizableTextParameter> subjectI18nParameters = new HashMap<>();
169        subjectI18nParameters.put("user", new I18nizableText(sender.getFullName()));
170        subjectI18nParameters.put("siteTitle", new I18nizableText(site.getTitle()));
171        subjectI18nParameters.put("pageTitle", new I18nizableText(page.getTitle()));
172        
173        I18nizableText msg = new I18nizableText("plugin.web", "PLUGINS_WEB_PAGE_NOTIFY_ONLINE_PUBLICATION_MAIL_SUBJECT", subjectI18nParameters);
174        
175        return _i18nUtils.translate(msg, language);
176    }
177    
178    /**
179     * Get the email body
180     * @param sender The user responsible for the notification
181     * @param user The recipient of the notification
182     * @param page The published page
183     * @param language The language
184     * @return The email body
185     * @throws IOException if failed to build HTML body
186     */
187    protected String _getBody (User sender, User user, Page page, String language) throws IOException
188    {
189        Site site = page.getSite();
190        String pageUrl = site.getUrl() + "/" + page.getSitemap().getName() + "/" + page.getPathInSitemap() + ".html";
191        
192        Map<String, I18nizableTextParameter> i18nParams = new HashMap<>();
193        i18nParams.put("sender", new I18nizableText(sender.getFullName()));
194        i18nParams.put("user", new I18nizableText(user.getFullName()));
195        i18nParams.put("siteTitle", new I18nizableText(site.getTitle()));
196        i18nParams.put("siteUrl", new I18nizableText(site.getUrl()));
197        i18nParams.put("pageTitle", new I18nizableText(page.getTitle()));
198        i18nParams.put("pageUrl", new I18nizableText(pageUrl));
199        
200        return StandardMailBodyHelper.newHTMLBody()
201            .withTitle(new I18nizableText("plugin.web", "PLUGINS_WEB_PAGE_NOTIFY_ONLINE_PUBLICATION_MAIL_BODY_TITLE"))
202            .addMessage(new I18nizableText("plugin.web", "PLUGINS_WEB_PAGE_NOTIFY_ONLINE_PUBLICATION_MAIL_BODY", i18nParams))
203            .addMessage(new I18nizableText("plugin.web", "PLUGINS_WEB_PAGE_NOTIFY_ONLINE_PUBLICATION_MAIL_BODY_LINK_TEXT", i18nParams))
204            .withLink(pageUrl, new I18nizableText("plugin.web", "PLUGINS_WEB_PAGE_NOTIFY_ONLINE_PUBLICATION_MAIL_BODY_LINK_BUTTON"))
205            .withLanguage(language)
206            .build();
207    }
208    
209    private Map<String, Set<User>> _getDistinctUsersByLanguage (List<UserIdentity> userIdentities, List<GroupIdentity> groupIdentities)
210    {
211        Set<User> users = new HashSet<>();
212        
213        for (UserIdentity userIdentity : userIdentities)
214        {
215            User user = _userManager.getUser(userIdentity);
216            if (user != null)
217            {
218                users.add(user);
219            }
220        }
221        
222        for (GroupIdentity groupIdentity : groupIdentities)
223        {
224            Group group = _groupManager.getGroup(groupIdentity);
225            if (group != null)
226            {
227                Set<UserIdentity> userGroupIdentities = group.getUsers();
228                for (UserIdentity userGroupIdentity : userGroupIdentities)
229                {
230                    User user = _userManager.getUser(userGroupIdentity);
231                    if (user != null)
232                    {
233                        users.add(user);
234                    }
235                }
236            }
237        }
238        
239        return users.stream()
240                .collect(Collectors.groupingBy(
241                        user -> {
242                            // user.getLanguage() can be null and groupingBy never accept null keys
243                            return StringUtils.defaultString(user.getLanguage());
244                        },
245                        Collectors.toSet()
246                    )
247                );
248    }
249}