Dépôt officiel du code source de l'ERP OpenConcerto

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 2011 OpenConcerto, by ILM Informatique. All rights reserved.
 * 
 * The contents of this file are subject to the terms of the GNU General Public License Version 3
 * only ("GPL"). You may not use this file except in compliance with the License. You can obtain a
 * copy of the License at http://www.gnu.org/licenses/gpl-3.0.html See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each file.
 */
 
 package org.openconcerto.utils;

import org.openconcerto.utils.DesktopEnvironment.Gnome;
import org.openconcerto.utils.DesktopEnvironment.KDE;
import org.openconcerto.utils.DesktopEnvironment.Mac;
import org.openconcerto.utils.DesktopEnvironment.Windows;
import org.openconcerto.utils.DesktopEnvironment.XFCE;
import org.openconcerto.utils.OSFamily.Unix;
import org.openconcerto.utils.io.PercentEncoder;

import java.io.BufferedOutputStream;
import java.io.BufferedWriter;
import java.io.File;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.PrintStream;
import java.io.Writer;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

public abstract class EmailClient {

    public static enum EmailClientType {
        Thunderbird, AppleMail, Outlook, XDG
    }

    private static EmailClient PREFERRED = null;

    /**
     * Find the preferred email client.
     * 
     * @return the preferred email client, never <code>null</code>.
     * @throws IOException if an error occurs.
     */
    public static final EmailClient getPreferred() throws IOException {
        if (PREFERRED == null) {
            PREFERRED = findPreferred();
            // should at least return MailTo
            assert PREFERRED != null;
        }
        return PREFERRED;
    }

    /**
     * Clear the preferred client.
     */
    public static final void resetPreferred() {
        PREFERRED = null;
    }

    // XP used tabs, but not 7
    // MULTILINE since there's several lines in addition to the wanted one
    private static final Pattern registryPattern = Pattern.compile("\\s+REG_SZ\\s+(.*)$", Pattern.MULTILINE);
    private static final Pattern cmdLinePattern = Pattern.compile("(\"(.*?)\")|([^\\s\"]+)\\b");
    // any whitespace except space and tab
    private static final Pattern wsPattern = Pattern.compile("[\\s&&[^ \t]]");
    private static final Pattern dictPattern;
    private static final String AppleMailBundleID = "com.apple.mail";
    private static final String ThunderbirdBundleID = "org.mozilla.thunderbird";
    static {
        final String rolePattern = "(?:LSHandlerRoleAll\\s*=\\s*\"([\\w\\.]+)\";\\s*)?";
        dictPattern = Pattern.compile("\\{\\s*" + rolePattern + "LSHandlerURLScheme = mailto;\\s*" + rolePattern + "\\}");
    }

    private final static String createEncodedParam(final String name, final String value) {
        return name + "=" + PercentEncoder.encode(value, StringUtils.UTF8);
    }

    private final static String createASParam(final String name, final String value) {
        return name + ":" + StringUtils.doubleQuote(value);
    }

    private final static String createVBParam(final String name, final String value) {
        final String switchName = "/" + name + ":";
        if (value == null || value.length() == 0)
            return switchName;
        // we need to encode the value since when invoking cscript.exe we cannot pass "
        // since all arguments are re-parsed
        final String encoded = PercentEncoder.encodeUTF16(value);
        assert encoded.indexOf('"') < 0 : "Encoded contains a double quote, this will confuse cscript";
        return switchName + '"' + encoded + '"';
    }

    /**
     * Create a mailto URI.
     * 
     * @param to the recipient, can be <code>null</code>.
     * @param subject the subject, can be <code>null</code>.
     * @param body the body of the email, can be <code>null</code>.
     * @param attachments files to attach, for security reason this parameter is ignored by at least
     *        Outlook 2007, Apple Mail and Thunderbird.
     * @return the mailto URI.
     * @throws IOException if an encoding error happens.
     * @see <a href="http://tools.ietf.org/html/rfc2368">RFC 2368</a>
     * @see <a href="https://bugzilla.mozilla.org/show_bug.cgi?id=67254">Don&apos;t allow attachment
     *      of local file from non-local link</a>
     */
    public final static URI getMailToURI(final String to, final String subject, final String body, final File... attachments) throws IOException {
        // mailto:p.dupond@example.com?subject=Sujet%20du%20courrier&cc=pierre@example.org&bcc=jacques@example.net&body=Bonjour

        // Outlook doesn't support the to header as mandated by 2. of the RFC
        final String encodedTo = to == null ? "" : PercentEncoder.encode(to, StringUtils.UTF8);
        final List<String> l = new ArrayList<String>(4);
        if (subject != null)
            l.add(createEncodedParam("subject", subject));
        if (body != null)
            l.add(createEncodedParam("body", body));
        for (final File attachment : attachments)
            l.add(createEncodedParam("attachment", attachment.getAbsolutePath()));
        final String query = CollectionUtils.join(l, "&");
        try {
            return new URI("mailto:" + encodedTo + "?" + query);
        } catch (URISyntaxException e) {
            throw new IOException("Couldn't create mailto URI", e);
        }
    }

    // see http://kb.mozillazine.org/Command_line_arguments_(Thunderbird)
    // The escape mechanism isn't specified, it turns out we can pass percent encoded strings
    private final static String getTBParam(final String to, final String subject, final String body, final File... attachments) {
        /**
         * <pre>
          "to='john@example.com,kathy@example.com',cc='britney@example.com',subject='dinner',body='How about dinner tonight?',attachment='file:///C:/cygwin/Cygwin.bat,file:///C:/cygwin/Cygwin.ico'";
         * </pre>
         */

        final List<String> l = new ArrayList<String>(4);
        if (to != null)
            l.add(createEncodedParam("to", to));
        if (subject != null)
            l.add(createEncodedParam("subject", subject));
        if (body != null)
            l.add(createEncodedParam("body", body));
        final List<String> urls = new ArrayList<String>(attachments.length);
        for (final File attachment : attachments) {
            // Thunderbird doesn't parse java URI file:/C:/
            final String rawPath = attachment.toURI().getRawPath();
            // handle UNC paths
            final String tbURL = (rawPath.startsWith("//") ? "file:///" : "file://") + rawPath;
            urls.add(tbURL);
        }
        l.add(createEncodedParam("attachment", CollectionUtils.join(urls, ",")));

        return DesktopEnvironment.getDE().quoteParamForExec(CollectionUtils.join(l, ","));
    }

    private final static String getAppleMailParam(final String subject, final String body) {
        final List<String> l = new ArrayList<String>(3);
        l.add("visible:true");
        if (subject != null)
            l.add(createASParam("subject", subject));
        if (body != null)
            l.add(createASParam("content", body));

        return CollectionUtils.join(l, ", ");
    }

    // @param cmdLine "C:\Program Files\Mozilla Thunderbird\thunderbird.exe" -osint -compose "%1"
    // @param toReplace "%1"
    private static String[] tbCommand(final String cmdLine, final String toReplace, final String to, final String subject, final String body, final File... attachments) {
        final String composeArg = getTBParam(to, subject, body, attachments);

        final List<String> arguments = new ArrayList<String>();
        final Matcher cmdMatcher = cmdLinePattern.matcher(cmdLine);
        while (cmdMatcher.find()) {
            final String quoted = cmdMatcher.group(2);
            final String unquoted = cmdMatcher.group(3);
            assert quoted == null ^ unquoted == null : "Both quoted and unquoted, or neither quoted nor quoted: " + quoted + " and " + unquoted;
            final String arg = quoted != null ? quoted : unquoted;

            final boolean replace = arg.equals(toReplace);
            // e.g. on Linux
            if (replace && !arguments.contains("-compose"))
                arguments.add("-compose");
            arguments.add(replace ? composeArg : arg);
        }

        return arguments.toArray(new String[arguments.size()]);
    }

    /**
     * Open a composing window in the default email client.
     * 
     * @param to the recipient, can be <code>null</code>.
     * @param subject the subject, can be <code>null</code>.
     * @param body the body of the email, can be <code>null</code>.
     * @param attachments files to attach, ATTN can be ignored if mailto: is used
     *        {@link #getMailToURI(String, String, String, File...)}.
     * @throws IOException if a program cannot be executed.
     * @throws InterruptedException if the thread is interrupted while waiting for a native program.
     */
    public void compose(final String to, String subject, final String body, final File... attachments) throws IOException, InterruptedException {
        // check now as letting the native commands do is a lot less reliable
        for (File attachment : attachments) {
            if (!attachment.exists())
                throw new IOException("Attachment doesn't exist: '" + attachment.getAbsolutePath() + "'");
        }

        // a subject should only be one line (Thunderbird strips newlines anyway and Outlook sends a
        // malformed email)
        subject = wsPattern.matcher(subject).replaceAll(" ");
        final boolean handled;
        // was only trying native if necessary, but mailto url has length limitations and can have
        // encoding issues
        handled = composeNative(to, subject, body, attachments);

        if (!handled) {
            final URI mailto = getMailToURI(to, subject, body, attachments);
            java.awt.Desktop.getDesktop().mail(mailto);
        }
    }

    static private String cmdSubstitution(String... args) throws IOException {
        return DesktopEnvironment.cmdSubstitution(Runtime.getRuntime().exec(args));
    }

    private static EmailClient findPreferred() throws IOException {
        final DesktopEnvironment de = DesktopEnvironment.getDE();
        if (de instanceof Windows) {
            // Tested on XP and 7
            // <SANS NOM> REG_SZ "C:\Program Files\Mozilla
            // Thunderbird\thunderbird.exe" -osint -compose "%1"
            final String out = cmdSubstitution("reg", "query", "HKEY_CLASSES_ROOT\\mailto\\shell\\open\\command");

            final Matcher registryMatcher = registryPattern.matcher(out);
            if (registryMatcher.find()) {
                final String cmdLine = registryMatcher.group(1);
                if (cmdLine.contains("thunderbird")) {
                    return new ThunderbirdCommandLine(cmdLine, "%1");
                } else if (cmdLine.toLowerCase().contains("outlook")) {
                    return Outlook;
                }
            }
        } else if (de instanceof Mac) {
            // (
            // {
            // LSHandlerRoleAll = "com.apple.mail";
            // LSHandlerURLScheme = mailto;
            // }
            // )
            final String bundleID;
            final String dict = cmdSubstitution("defaults", "read", "com.apple.LaunchServices", "LSHandlers");
            final Matcher dictMatcher = dictPattern.matcher(dict);
            if (dictMatcher.find()) {
                // LSHandlerRoleAll can be before or after LSHandlerURLScheme
                final String before = dictMatcher.group(1);
                final String after = dictMatcher.group(2);
                assert before == null ^ after == null : "Both before and after, or neither before nor after: " + before + " and " + after;
                bundleID = before != null ? before : after;
            } else
                // the default
                bundleID = AppleMailBundleID;

            if (bundleID.equals(AppleMailBundleID)) {
                return AppleMail;
            } else if (bundleID.equals(ThunderbirdBundleID)) {
                // doesn't work if Thunderbird is already open:
                // https://bugzilla.mozilla.org/show_bug.cgi?id=424155
                // https://bugzilla.mozilla.org/show_bug.cgi?id=472891
                // MAYBE find out if launched and let handled=false

                final File appDir = ((Mac) de).getAppDir(bundleID);
                final File exe = new File(appDir, "Contents/MacOS/thunderbird-bin");

                return new ThunderbirdPath(exe);
            }
        } else if (de instanceof Gnome) {
            if (de.getVersion().startsWith("2.")) {
                // evolution %s
                final String cmdLine = cmdSubstitution("gconftool", "-g", "/desktop/gnome/url-handlers/mailto/command");
                if (cmdLine.contains("thunderbird")) {
                    return new ThunderbirdCommandLine(cmdLine, "%s");
                }
            }
            return XDG;
        } else if (de instanceof KDE) {
            // TODO look for EmailClient=/usr/bin/thunderbird in
            // ~/.kde/share/config/emaildefaults or /etc/kde (ou /usr/share/config qui est un
            // lien symbolique vers /etc/kde)
            return XDG;
        } else if (de instanceof XFCE) {
            // .config/xfce4/helpers.rc contains "MailReader=desktopName"
            // A custom one can be created in .local/share/xfce4/helpers/custom-MailReader.desktop
            return XDG;
        } else if (OSFamily.getInstance() instanceof Unix) {
            return XDG;
        }

        return MailTo;
    }

    public static final EmailClient MailTo = new EmailClient(null) {
        @Override
        public boolean composeNative(String to, String subject, String body, File... attachments) {
            return false;
        }
    };

    public static final EmailClient XDG = new EmailClient(EmailClientType.XDG) {
        @Override
        public boolean composeNative(String to, String subject, String body, File... attachments) throws IOException, InterruptedException {
            final ProcessBuilder pb = new ProcessBuilder("xdg-email");
            if (subject != null) {
                pb.command().add("--subject");
                pb.command().add(subject);
            }
            if (body != null) {
                pb.command().add("--body");
                pb.command().add(body);
            }
            for (File attachment : attachments) {
                pb.command().add("--attach");
                pb.command().add(attachment.getAbsolutePath());
            }
            pb.command().add(to);
            pb.inheritIO();
            final Process process = pb.start();
            process.getOutputStream().close();
            final int returnCode = process.waitFor();
            if (returnCode != 0)
                throw new IllegalStateException("Non zero return code: " + returnCode);
            return true;
        }
    };

    public static final EmailClient Outlook = new EmailClient(EmailClientType.Outlook) {
        @Override
        protected boolean composeNative(String to, String subject, String body, File... attachments) throws IOException, InterruptedException {
            final DesktopEnvironment de = DesktopEnvironment.getDE();
            final File vbs = FileUtils.getFile(EmailClient.class.getResource("OutlookEmail.vbs"));
            final List<String> l = new ArrayList<String>(6);
            l.add("cscript");
            l.add(de.quoteParamForExec(vbs.getAbsolutePath()));
            if (to != null)
                l.add(createVBParam("to", to));
            if (subject != null)
                l.add(createVBParam("subject", subject));
            // at least set a parameter otherwise the usage get displayed
            l.add(createVBParam("unicodeStdIn", "1"));
            for (File attachment : attachments) {
                l.add(de.quoteParamForExec(attachment.getAbsolutePath()));
            }

            final Process process = new ProcessBuilder(l).start();
            // VBScript only knows ASCII and UTF-16
            final Writer writer = new BufferedWriter(new OutputStreamWriter(process.getOutputStream(), StringUtils.UTF16));
            writer.write(body);
            writer.close();
            final int returnCode = process.waitFor();
            if (returnCode != 0)
                throw new IllegalStateException("Non zero return code: " + returnCode);
            return true;
        }
    };

    public static final EmailClient AppleMail = new EmailClient(EmailClientType.AppleMail) {
        @Override
        protected boolean composeNative(String to, String subject, String body, File... attachments) throws IOException, InterruptedException {
            final Process process = Runtime.getRuntime().exec(new String[] { "osascript" });
            final PrintStream w = new PrintStream(new BufferedOutputStream(process.getOutputStream()));
            // use ID to handle application renaming (always a slight delay after a rename for
            // this to work, though)
            w.println("tell application id \"" + AppleMailBundleID + "\"");
            w.println(" set theMessage to make new outgoing message with properties {" + getAppleMailParam(subject, body) + "}");
            if (to != null)
                w.println(" tell theMessage to make new to recipient with properties {address:" + StringUtils.doubleQuote(to) + "}");
            for (File attachment : attachments) {
                w.println(" tell content of theMessage to make new attachment with properties {file name:" + StringUtils.doubleQuote(attachment.getAbsolutePath()) + "} at after last paragraph");
            }
            w.println("end tell");
            w.close();
            if (w.checkError())
                throw new IOException();

            final int returnCode = process.waitFor();
            if (returnCode != 0)
                throw new IllegalStateException("Non zero return code: " + returnCode);
            return true;
        }
    };

    public static abstract class Thunderbird extends EmailClient {

        public static Thunderbird createFromExe(final File exe) {
            if (exe == null)
                throw new NullPointerException();
            if (!exe.isFile())
                return null;
            return new ThunderbirdPath(exe);
        }

        public static Thunderbird createFromCommandLine(final String cmdLine, final String toReplace) {
            return new ThunderbirdCommandLine(cmdLine, toReplace);
        }

        protected Thunderbird() {
            super(EmailClientType.Thunderbird);
        }

        @Override
        public String toString() {
            return this.getClass().getSimpleName();
        }
    }

    private static final class ThunderbirdCommandLine extends Thunderbird {

        private final String cmdLine;
        private final String toReplace;

        private ThunderbirdCommandLine(final String cmdLine, final String toReplace) {
            this.cmdLine = cmdLine;
            this.toReplace = toReplace;
        }

        @Override
        protected boolean composeNative(String to, String subject, String body, File... attachments) throws IOException {
            Runtime.getRuntime().exec(tbCommand(this.cmdLine, this.toReplace, to, subject, body, attachments));
            // don't wait for Thunderbird to quit if it wasn't launched
            // (BTW return code of 1 means the program was already launched)
            return true;
        }

        @Override
        public String toString() {
            return super.toString() + " " + this.cmdLine;
        }
    }

    private static final class ThunderbirdPath extends Thunderbird {

        private final File exe;

        private ThunderbirdPath(File exe) {
            this.exe = exe;
        }

        @Override
        protected boolean composeNative(String to, String subject, String body, File... attachments) throws IOException {
            final String composeArg = getTBParam(to, subject, body, attachments);
            Runtime.getRuntime().exec(new String[] { this.exe.getPath(), "-compose", composeArg });
            return true;
        }

        @Override
        public String toString() {
            return super.toString() + " " + this.exe;
        }
    }

    private final EmailClientType type;

    public EmailClient(EmailClientType type) {
        this.type = type;
    }

    public final EmailClientType getType() {
        return this.type;
    }

    protected abstract boolean composeNative(final String to, final String subject, final String body, final File... attachments) throws IOException, InterruptedException;

    @Override
    public String toString() {
        final EmailClientType t = this.getType();
        return t == null ? "mailto" : t.toString();
    }

    public final static void main(String[] args) throws Exception {
        if (args.length == 1 && "--help".equals(args[0])) {
            System.out.println("Usage: java [-Dparam=value] " + EmailClient.class.getName() + " [EmailClientType args]");
            System.out.println("\tEmailClientType: mailto or " + Arrays.asList(EmailClientType.values()));
            System.out.println("\tparam: to, subject, body, files (seprated by ',' double it to escape)");
            return;
        }

        final EmailClient client = createFromString(args);
        System.out.println("Using " + (args.length == 0 ? "preferred" : "passed") + " client : " + client);
        final String to = System.getProperty("to", "Pierre Dupond <p.dupond@example.com>, p.dupont@server.com");
        // ',to=' to test escaping of Thunderbird (passing subject='foo'bar' works)
        final String subject = System.getProperty("subject", "Sujé € du courrier ',to='&;\\<> \"autre'\n2nd line");
        final String body = System.getProperty("body", "Bonjour,\n\tsingle ' double \" backslash(arrière) \\ slash /");
        final String filesPath = System.getProperty("files");
        final String[] paths = filesPath == null || filesPath.length() == 0 ? new String[0] : filesPath.split("(?<!,),(?!,)");
        final File[] f = new File[paths.length];
        for (int i = 0; i < f.length; i++) {
            f[i] = new File(paths[i].replace(",,", ","));
        }
        client.compose(to, subject, body, f);
    }

    private static final EmailClient createFromString(final String... args) throws IOException {
        // switch doesn't support null
        if (args.length == 0)
            return getPreferred();
        else if ("mailto".equals(args[0]))
            return MailTo;

        final EmailClientType t = EmailClientType.valueOf(args[0]);
        switch (t) {
        case XDG:
            return XDG;
        case Outlook:
            return Outlook;
        case AppleMail:
            return AppleMail;
        case Thunderbird:
            EmailClient res = null;
            if (args.length == 2) {
                final File exe = new File(args[1]);
                res = Thunderbird.createFromExe(exe);
                if (res == null)
                    throw new IOException("Invalid exe : " + exe);
            } else if (args.length == 3) {
                res = Thunderbird.createFromCommandLine(args[1], args[2]);
            } else {
                throw new IllegalArgumentException(t + " needs 1 or 2 arguments");
            }
            return res;
        default:
            throw new IllegalStateException("Unknown type " + t);
        }
    }
}