com.openkm.module.common.CommonNotificationModule.java Source code

Java tutorial

Introduction

Here is the source code for com.openkm.module.common.CommonNotificationModule.java

Source

/**
 * OpenKM, Open Document Management System (http://www.openkm.com)
 * Copyright (c) 2006-2015 Paco Avila & Josep Llort
 * 
 * No bytes were intentionally harmed during the development of this application.
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

package com.openkm.module.common;

import java.io.IOException;
import java.io.Serializable;
import java.io.StringReader;
import java.io.StringWriter;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;

import javax.mail.MessagingException;

import org.apache.commons.httpclient.HttpException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import twitter4j.Twitter;
import twitter4j.TwitterException;

import com.openkm.core.AccessDeniedException;
import com.openkm.core.Config;
import com.openkm.core.DatabaseException;
import com.openkm.core.PathNotFoundException;
import com.openkm.core.RepositoryException;
import com.openkm.dao.TwitterAccountDAO;
import com.openkm.dao.bean.TwitterAccount;
import com.openkm.util.MailUtils;
import com.openkm.util.PathUtils;
import com.openkm.util.TemplateUtils;

import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateException;

public class CommonNotificationModule {
    private static Logger log = LoggerFactory.getLogger(CommonNotificationModule.class);

    /**
     * Clean preview cache for this document
     */
    public static void sendNotification(String user, String nodeUuid, String nodePath, String from, List<String> to,
            String message, boolean attachment) throws TemplateException, MessagingException, PathNotFoundException,
            AccessDeniedException, RepositoryException, DatabaseException, IOException {
        log.debug("sendNotification({}, {}, {}, {}, {}, {}, {})",
                new Object[] { user, nodeUuid, nodePath, from, to, message, attachment });
        ArrayList<CommonNotificationModule.NodeInfo> nodesInfo = new ArrayList<CommonNotificationModule.NodeInfo>();
        CommonNotificationModule.NodeInfo nodeInfo = new NodeInfo();
        nodeInfo.setUuid(nodeUuid);
        nodeInfo.setPath(nodePath);
        nodesInfo.add(nodeInfo);
        sendNotification(user, nodesInfo, from, to, message, attachment);
    }

    public static void sendNotification(String user, ArrayList<CommonNotificationModule.NodeInfo> nodesInfo,
            String from, List<String> to, String message, boolean attachment)
            throws TemplateException, MessagingException, PathNotFoundException, AccessDeniedException,
            RepositoryException, DatabaseException, IOException {
        log.debug("sendNotification({}, {}, {}, {}, {}, {})",
                new Object[] { user, nodesInfo, from, to, message, attachment });
        StringWriter swSubject = new StringWriter();
        StringWriter swBody = new StringWriter();
        Configuration cfg = TemplateUtils.getConfig();
        List<String> docsPath = new ArrayList<String>();
        Collection<Map<String, String>> col = new ArrayList<Map<String, String>>();

        for (CommonNotificationModule.NodeInfo ni : nodesInfo) {
            Map<String, String> docInfo = new HashMap<String, String>();
            docInfo.put("url", Config.APPLICATION_URL + "?uuid=" + ni.getUuid());
            docInfo.put("path", ni.getPath());
            docInfo.put("name", PathUtils.getName(ni.getPath()));
            col.add(docInfo);

            // Used to send attachments
            docsPath.add(ni.getPath());
        }

        Map<String, Object> model = new HashMap<String, Object>();
        model.put("userId", user);
        model.put("notificationMessage", message);
        model.put("documentList", col);

        if (TemplateUtils.templateExists(Config.NOTIFICATION_MESSAGE_SUBJECT)) {
            Template tpl = cfg.getTemplate(Config.NOTIFICATION_MESSAGE_SUBJECT);
            tpl.process(model, swSubject);
        } else {
            StringReader sr = new StringReader(Config.NOTIFICATION_MESSAGE_SUBJECT);
            Template tpl = new Template("NotificationMessageSubject", sr, cfg);
            tpl.process(model, swSubject);
            sr.close();
        }

        if (TemplateUtils.templateExists(Config.NOTIFICATION_MESSAGE_BODY)) {
            Template tpl = cfg.getTemplate(Config.NOTIFICATION_MESSAGE_BODY);
            tpl.process(model, swBody);
        } else {
            StringReader sr = new StringReader(Config.NOTIFICATION_MESSAGE_BODY);
            Template tpl = new Template("NotificationMessageBody", sr, cfg);
            tpl.process(model, swBody);
            sr.close();
        }

        if (attachment) {
            MailUtils.sendDocuments((String) from, to, swSubject.toString(), swBody.toString(), docsPath);
        } else {
            MailUtils.sendMessage((String) from, to, swSubject.toString(), swBody.toString());
        }
    }

    /**
     * Send mail subscription message
     */
    public static void sendMailSubscription(String user, String nodeUuid, String nodePath, String eventType,
            String comment, Set<String> mails) throws TemplateException, MessagingException, IOException {
        log.debug("sendMailSubscription({}, {}, {}, {}, {}, {})",
                new Object[] { user, nodeUuid, nodePath, eventType, comment, mails });

        if (comment == null) {
            comment = "";
        }

        StringWriter swSubject = new StringWriter();
        StringWriter swBody = new StringWriter();
        Configuration cfg = TemplateUtils.getConfig();

        Map<String, String> model = new HashMap<String, String>();
        model.put("documentUrl", Config.APPLICATION_URL + "?uuid=" + nodeUuid);
        model.put("documentPath", nodePath);
        model.put("documentName", PathUtils.getName(nodePath));
        model.put("userId", user);
        model.put("eventType", eventType);
        model.put("subscriptionComment", comment);

        if (TemplateUtils.templateExists(Config.SUBSCRIPTION_MESSAGE_SUBJECT)) {
            Template tpl = cfg.getTemplate(Config.SUBSCRIPTION_MESSAGE_SUBJECT);
            tpl.process(model, swSubject);
        } else {
            StringReader sr = new StringReader(Config.SUBSCRIPTION_MESSAGE_SUBJECT);
            Template tpl = new Template("SubscriptionMessageSubject", sr, cfg);
            tpl.process(model, swSubject);
            sr.close();
        }

        if (TemplateUtils.templateExists(Config.SUBSCRIPTION_MESSAGE_BODY)) {
            Template tpl = cfg.getTemplate(Config.SUBSCRIPTION_MESSAGE_BODY);
            tpl.process(model, swBody);
        } else {
            StringReader sr = new StringReader(Config.SUBSCRIPTION_MESSAGE_BODY);
            Template tpl = new Template("SubscriptionMessageBody", sr, cfg);
            tpl.process(model, swBody);
            sr.close();
        }

        MailUtils.sendMessage(mails, swSubject.toString(), swBody.toString());
    }

    /**
     * Send twitter subscription message
     */
    public static void sendTwitterSubscription(String user, String nodePath, String eventType, String comment,
            Set<String> users)
            throws TemplateException, TwitterException, DatabaseException, HttpException, IOException {
        log.debug("sendTwitterSubscription({}, {}, {}, {}, {})",
                new Object[] { user, nodePath, eventType, comment, users });
        Twitter twitter = new Twitter(Config.SUBSCRIPTION_TWITTER_USER, Config.SUBSCRIPTION_TWITTER_PASSWORD);
        StringWriter swStatus = new StringWriter();
        Configuration cfg = TemplateUtils.getConfig();

        Map<String, String> model = new HashMap<String, String>();
        model.put("documentUrl", MailUtils.getTinyUrl(Config.APPLICATION_URL + "?docPath=" + nodePath));
        model.put("documentPath", nodePath);
        model.put("documentName", PathUtils.getName(nodePath));
        model.put("userId", user);
        model.put("eventType", eventType);
        model.put("subscriptionComment", comment);

        if (TemplateUtils.templateExists(Config.SUBSCRIPTION_TWITTER_STATUS)) {
            Template tpl = cfg.getTemplate(Config.SUBSCRIPTION_TWITTER_STATUS);
            tpl.process(model, swStatus);
        } else {
            StringReader sr = new StringReader(Config.SUBSCRIPTION_TWITTER_STATUS);
            Template tpl = new Template("SubscriptionTwitterStatus", sr, cfg);
            tpl.process(model, swStatus);
            sr.close();
        }

        for (Iterator<String> itUsers = users.iterator(); itUsers.hasNext();) {
            String itUser = itUsers.next();
            Collection<TwitterAccount> twitterAccounts = TwitterAccountDAO.findByUser(itUser, true);

            for (Iterator<TwitterAccount> itTwitter = twitterAccounts.iterator(); itTwitter.hasNext();) {
                TwitterAccount ta = itTwitter.next();
                log.info("Twitter Notify from {} to {} ({}) - {}",
                        new Object[] { twitter.getUserId(), ta.getTwitterUser(), itUser, swStatus.toString() });
                twitter.sendDirectMessage(ta.getTwitterUser(), swStatus.toString());
            }
        }
    }

    public static final class NodeInfo implements Serializable {
        private static final long serialVersionUID = 1L;
        private String uuid;
        private String path;

        public String getUuid() {
            return uuid;
        }

        public void setUuid(String uuid) {
            this.uuid = uuid;
        }

        public String getPath() {
            return path;
        }

        public void setPath(String path) {
            this.path = path;
        }
    }
}