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.util.HashMap;
019import java.util.HashSet;
020import java.util.List;
021import java.util.Map;
022import java.util.Set;
023import java.util.stream.Collectors;
024
025import javax.mail.MessagingException;
026
027import org.apache.avalon.framework.parameters.Parameters;
028import org.apache.avalon.framework.service.ServiceException;
029import org.apache.avalon.framework.service.ServiceManager;
030import org.apache.cocoon.acting.ServiceableAction;
031import org.apache.cocoon.environment.ObjectModelHelper;
032import org.apache.cocoon.environment.Redirector;
033import org.apache.cocoon.environment.SourceResolver;
034
035import org.ametys.core.group.Group;
036import org.ametys.core.group.GroupIdentity;
037import org.ametys.core.group.GroupManager;
038import org.ametys.core.user.CurrentUserProvider;
039import org.ametys.core.user.User;
040import org.ametys.core.user.UserIdentity;
041import org.ametys.core.user.UserManager;
042import org.ametys.core.util.I18nUtils;
043import org.ametys.core.util.mail.SendMailHelper;
044import org.ametys.plugins.core.user.UserHelper;
045import org.ametys.plugins.repository.AmetysObjectResolver;
046import org.ametys.runtime.config.Config;
047import org.ametys.runtime.i18n.I18nizableTextParameter;
048import org.ametys.runtime.i18n.I18nizableText;
049import org.ametys.web.repository.page.Page;
050import org.ametys.web.repository.site.Site;
051
052/**
053 * This actions send a email to notify the publication of a page.
054 *
055 */
056public class SendOnlineNotificationAction extends ServiceableAction
057{
058    private UserManager _userManager;
059    private GroupManager _groupManager;
060    private AmetysObjectResolver _resolver;
061    private I18nUtils _i18nUtils;
062    private CurrentUserProvider _userProvider;
063    private UserHelper _userHelper;
064    
065    
066    @Override
067    public void service(ServiceManager smanager) throws ServiceException
068    {
069        super.service(smanager);
070        _userManager = (UserManager) smanager.lookup(UserManager.ROLE);
071        _userProvider = (CurrentUserProvider) smanager.lookup(CurrentUserProvider.ROLE);
072        _resolver = (AmetysObjectResolver) smanager.lookup(AmetysObjectResolver.ROLE);
073        _groupManager = (GroupManager) smanager.lookup(GroupManager.ROLE);
074        _i18nUtils = (I18nUtils) smanager.lookup(I18nUtils.ROLE);
075        _userHelper = (UserHelper) smanager.lookup(UserHelper.ROLE);
076    }
077    
078    
079    @Override
080    public Map act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters parameters) throws Exception
081    {
082        @SuppressWarnings("unchecked")
083        Map<String, Object> jsParameters = (Map<String, Object>) objectModel.get(ObjectModelHelper.PARENT_CONTEXT);
084        
085        String pageId = (String) jsParameters.get("id");
086        Page page = _resolver.resolveById(pageId);
087        
088        UserIdentity userIdentity = _userProvider.getUser();
089        User notifier = _userManager.getUser(userIdentity.getPopulationId(), userIdentity.getLogin());
090        
091        String from = _getSender(notifier, page);
092        String subject = _getSubject (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        Set<User> users = _getDistinctUsers(userIdentities, groupIdentities);
107        for (User user : users)
108        {
109            if (user.getEmail() != null)
110            {
111                try
112                {
113                    String body = _getBody(notifier, user, page);
114                    SendMailHelper.sendMail(subject, null, body, user.getEmail(), from);
115                }
116                catch (MessagingException e) 
117                {
118                    getLogger().error("Unable to send mail to user " + user.getEmail(), e);
119                }
120            }
121        }
122        
123        return EMPTY_MAP;
124    }
125    
126    /**
127     * Get the email sender
128     * @param sender The user responsible for the action
129     * @param page The published page
130     * @return The sender
131     */
132    protected String _getSender (User sender, Page page)
133    {
134        if (sender != null && sender.getEmail() != null)
135        {
136            return sender.getFullName() + " <" + sender.getEmail() + ">";
137        }
138
139        Site site = page.getSite();
140        String defaultFromValue = Config.getInstance().getValue("smtp.mail.from");
141        return site.getValue("site-mail-from", false, defaultFromValue);
142    }
143    
144    /**
145     * Get the email subject
146     * @param sender The user responsible for the notification
147     * @param page The published page
148     * @return The email subject
149     */
150    protected String _getSubject (User sender, Page page)
151    {
152        Site site = page.getSite();
153        
154        Map<String, I18nizableTextParameter> subjectI18nParameters = new HashMap<>();
155        subjectI18nParameters.put("user", new I18nizableText(sender.getFullName()));
156        subjectI18nParameters.put("siteTitle", new I18nizableText(site.getTitle()));
157        subjectI18nParameters.put("pageTitle", new I18nizableText(page.getTitle()));
158        
159        I18nizableText msg = new I18nizableText("plugin.web", "PLUGINS_WEB_PAGE_NOTIFY_ONLINE_PUBLICATION_MAIL_SUBJECT", subjectI18nParameters);
160        
161        return _i18nUtils.translate(msg, page.getSitemapName());
162    }
163    
164    /**
165     * Get the email body
166     * @param sender The user responsible for the notification
167     * @param user The recipient of the notification
168     * @param page The published page
169     * @return The email body
170     */
171    protected String _getBody (User sender, User user, Page page)
172    {
173        Site site = page.getSite();
174        
175        Map<String, I18nizableTextParameter> bodyI18nParameters = new HashMap<>();
176        bodyI18nParameters.put("sender", new I18nizableText(sender.getFullName()));
177        bodyI18nParameters.put("user", new I18nizableText(user.getFullName()));
178        bodyI18nParameters.put("siteTitle", new I18nizableText(site.getTitle()));
179        bodyI18nParameters.put("siteUrl", new I18nizableText(site.getUrl()));
180        bodyI18nParameters.put("pageTitle", new I18nizableText(page.getTitle()));
181        bodyI18nParameters.put("pageUrl", new I18nizableText(site.getUrl() + "/" + page.getSitemap().getName() + "/" + page.getPathInSitemap() + ".html"));
182        
183        I18nizableText msg = new I18nizableText("plugin.web", "PLUGINS_WEB_PAGE_NOTIFY_ONLINE_PUBLICATION_MAIL_BODY", bodyI18nParameters);
184        
185        return _i18nUtils.translate(msg, page.getSitemapName());
186    }
187    
188    private Set<User> _getDistinctUsers (List<UserIdentity> userIdentities, List<GroupIdentity> groupIdentities)
189    {
190        Set<User> users = new HashSet<>();
191        
192        for (UserIdentity userIdentity : userIdentities)
193        {
194            User user = _userManager.getUser(userIdentity);
195            if (user != null)
196            {
197                users.add(user);
198            }
199        }
200        
201        for (GroupIdentity groupIdentity : groupIdentities)
202        {
203            Group group = _groupManager.getGroup(groupIdentity);
204            if (group != null)
205            {
206                Set<UserIdentity> userGroupIdentities = group.getUsers();
207                for (UserIdentity userGroupIdentity : userGroupIdentities)
208                {
209                    User user = _userManager.getUser(userGroupIdentity);
210                    if (user != null)
211                    {
212                        users.add(user);
213                    }
214                }
215            }
216        }
217        
218        return users;
219    }
220}