Fix FN when empty (with a configurable option) + some i18n

[jvcard.git] / src / be / nikiroo / jvcard / launcher / Main.java

package be.nikiroo.jvcard.launcher;

import java.io.File;
import java.io.IOException;
import java.lang.reflect.Field;
import java.net.Socket;
import java.nio.charset.Charset;
import java.util.LinkedList;
import java.util.List;
import java.util.MissingResourceException;
import java.util.ResourceBundle;

import javax.imageio.ImageIO;

import be.nikiroo.jvcard.Card;
import be.nikiroo.jvcard.Contact;
import be.nikiroo.jvcard.Data;
import be.nikiroo.jvcard.TypeInfo;
import be.nikiroo.jvcard.launcher.CardResult.MergeCallback;
import be.nikiroo.jvcard.parsers.Format;
import be.nikiroo.jvcard.remote.Command;
import be.nikiroo.jvcard.remote.SimpleSocket;
import be.nikiroo.jvcard.resources.Bundles;
import be.nikiroo.jvcard.resources.StringUtils;
import be.nikiroo.jvcard.resources.Trans;
import be.nikiroo.jvcard.resources.Trans.StringId;

/**
 * This class contains the runnable Main method. It will parse the user supplied
 * parameters and take action based upon those. Most of the time, it will start
 * a MainWindow.
 * 
 * @author niki
 *
 */
public class Main {
	static public final String APPLICATION_TITLE = "jVcard";
	static public final String APPLICATION_VERSION = "1.0-beta3-dev";

	static private final int ERR_NO_FILE = 1;
	static private final int ERR_SYNTAX = 2;
	static private final int ERR_INTERNAL = 3;
	static private Trans transService;

	static private String defaultFn;
	static private boolean forceComputedFn;

	enum Mode {
		CONTACT_MANAGER, I18N, SERVER, LOAD_PHOTO, SAVE_PHOTO, ONLY_PHOTO,
	}

	/**
	 * Translate the given {@link StringId} into user text.
	 * 
	 * @param stringId
	 *            the ID to translate
	 * @param values
	 *            the values to insert instead of the place holders in the
	 *            translation
	 * 
	 * @return the translated text with the given value where required
	 */
	static public String trans(StringId id, String... values) {
		return transService.trans(id, (String[]) values);
	}

	/**
	 * Check if unicode characters should be used.
	 * 
	 * @return TRUE to allow unicode
	 */
	static public boolean isUnicode() {
		return transService.isUnicode();
	}

	/**
	 * Start the application.
	 * 
	 * <p>
	 * The returned exit codes are:
	 * <ul>
	 * <li>1: no files to open</li>
	 * <li>2: invalid syntax</li>
	 * <li>3: internal error</li>
	 * </ul>
	 * </p>
	 * 
	 * @param args
	 *            the parameters (see <tt>--help</tt> to know which are
	 *            supported)
	 */
	public static void main(String[] args) {
		Boolean textMode = null;
		boolean noMoreParams = false;
		boolean filesTried = false;

		// get the "system default" language to help translate the --help
		// message if needed
		String language = null;
		transService = new Trans(language);

		boolean unicode = transService.isUnicode();
		String dir = null;
		List<String> files = new LinkedList<String>();
		int port = -1;
		Mode mode = Mode.CONTACT_MANAGER;
		String format = null;
		for (int index = 0; index < args.length; index++) {
			String arg = args[index];
			if (!noMoreParams && arg.equals("--")) {
				noMoreParams = true;
			} else if (!noMoreParams && arg.equals("--help")) {
				System.out
						.println("TODO: implement some help text.\n"
								+ "Usable switches:\n"
								+ "\t--: stop looking for switches\n"
								+ "\t--help: this here thingy\n"
								+ "\t--lang LANGUAGE: choose the language, for instance en_GB\n"
								+ "\t--tui: force pure text mode even if swing treminal is available\n"
								+ "\t--gui: force swing terminal mode\n"
								+ "\t--noutf: force non-utf8 mode if you need it\n"
								+ "\t--config DIRECTORY: force the given directory as a CONFIG_DIR\n"
								+ "\t--server PORT: start a remoting server instead of a client\n"
								+ "\t--i18n DIR: generate the translation file for the given language (can be \"\") to/from the .properties given dir\n"
								+ "\t--save-photo DIR FORMAT: save the contacts' photos to DIR, named after FORMAT\n"
								+ "\t--load-photo DIR FORMAT: load the contacts' photos from DIR, named after FORMAT\n"
								+ "\t--only-photo DIR FORMAT: load the contacts' photos from DIR, named after FORMAT, overwrite all other photos of selected contacts\n"
								+ "everyhing else is either a file to open or a directory to open\n"
								+ "(we will only open 1st level files in given directories)\n"
								+ "('jvcard://hostname:8888/file' links -- or without 'file' -- are also ok)\n");
				return;
			} else if (!noMoreParams && arg.equals("--tui")) {
				textMode = true;
			} else if (!noMoreParams && arg.equals("--gui")) {
				textMode = false;
			} else if (!noMoreParams && arg.equals("--noutf")) {
				unicode = false;
				transService.setUnicode(unicode);
			} else if (!noMoreParams && arg.equals("--lang")) {
				index++;
				if (index >= args.length) {
					System.err.println("Syntax error: no language given");
					System.exit(ERR_SYNTAX);
					return;
				}

				language = args[index];
				transService = new Trans(language);
				transService.setUnicode(unicode);
			} else if (!noMoreParams && arg.equals("--config")) {
				index++;
				if (index >= args.length) {
					System.err
							.println("Syntax error: no config directory given");
					System.exit(ERR_SYNTAX);
					return;
				}

				Bundles.setDirectory(args[index]);
				transService = new Trans(language);
				transService.setUnicode(unicode);
			} else if (!noMoreParams && arg.equals("--server")) {
				if (mode != Mode.CONTACT_MANAGER) {
					System.err
							.println("Syntax error: you can only use one of: \n"
									+ "--server\n"
									+ "--i18n\n"
									+ "--load-photo\n"
									+ "--save-photo\n"
									+ "--only-photo\n");
					System.exit(ERR_SYNTAX);
					return;
				}
				mode = Mode.SERVER;

				index++;
				if (index >= args.length) {
					System.err.println("Syntax error: no port given");
					System.exit(ERR_SYNTAX);
					return;
				}

				try {
					port = Integer.parseInt(args[index]);
				} catch (NumberFormatException e) {
					System.err.println("Invalid port number: " + args[index]);
					System.exit(ERR_SYNTAX);
					return;
				}
			} else if (!noMoreParams && arg.equals("--i18n")) {
				if (mode != Mode.CONTACT_MANAGER) {
					System.err
							.println("Syntax error: you can only use one of: \n"
									+ "--server\n"
									+ "--i18n\n"
									+ "--load-photo\n"
									+ "--save-photo\n"
									+ "--only-photo\n");
					System.exit(ERR_SYNTAX);
					return;
				}
				mode = Mode.I18N;

				index++;
				if (index >= args.length) {
					System.err
							.println("Syntax error: no .properties directory given");
					System.exit(ERR_SYNTAX);
					return;
				}

				dir = args[index];
			} else if (!noMoreParams
					&& (arg.equals("--load-photo")
							|| arg.equals("--save-photo") || arg
								.equals("--only-photo"))) {
				if (mode != Mode.CONTACT_MANAGER) {
					System.err
							.println("Syntax error: you can only use one of: \n"
									+ "--server\n"
									+ "--i18n\n"
									+ "--load-photo\n"
									+ "--save-photo\n"
									+ "--only-photo\n");
					System.exit(ERR_SYNTAX);
					return;
				}

				if (arg.equals("--load-photo")) {
					mode = Mode.LOAD_PHOTO;
				} else if (arg.equals("--save-photo")) {
					mode = Mode.SAVE_PHOTO;
				} else {
					mode = Mode.ONLY_PHOTO;
				}

				index++;
				if (index >= args.length) {
					System.err.println("Syntax error: photo directory given");
					System.exit(ERR_SYNTAX);
					return;
				}

				dir = args[index];

				index++;
				if (index >= args.length) {
					System.err.println("Syntax error: photo format given");
					System.exit(ERR_SYNTAX);
					return;
				}

				format = args[index];
			} else {
				filesTried = true;
				files.addAll(open(arg));
			}
		}

		// Force headless mode if we run in forced-text mode
		if (mode != Mode.CONTACT_MANAGER || (textMode != null && textMode)) {
			// same as -Djava.awt.headless=true
			System.setProperty("java.awt.headless", "true");
		}

		if (unicode) {
			utf8();
		}

		// N/FN fix information:
		readNFN();

		// Error management:
		if (mode == Mode.SERVER && files.size() > 0) {
			System.err
					.println("Invalid syntax: you cannot both use --server and provide card files");
			System.exit(ERR_SYNTAX);
		} else if (mode == Mode.I18N && files.size() > 0) {
			System.err
					.println("Invalid syntax: you cannot both use --i18n and provide card files");
			System.exit(ERR_SYNTAX);
		} else if (mode == Mode.I18N && language == null) {
			System.err
					.println("Invalid syntax: you cannot use --i18n without --lang");
			System.exit(ERR_SYNTAX);
		} else if ((mode == Mode.CONTACT_MANAGER || mode == Mode.SAVE_PHOTO || mode == Mode.LOAD_PHOTO)
				&& files.size() == 0) {
			if (files.size() == 0 && !filesTried) {
				files.addAll(open("."));
			}

			if (files.size() == 0) {
				System.err.println("No files to open");
				System.exit(ERR_NO_FILE);
				return;
			}
		}
		//

		switch (mode) {
		case SERVER: {
			try {
				Optional.runServer(port);
			} catch (Exception e) {
				if (e instanceof IOException) {
					System.err
							.println("I/O Exception: Cannot start the server");
				} else {
					System.err.println("Remoting support not available");
					System.exit(ERR_INTERNAL);
				}
			}
			break;
		}
		case I18N: {
			try {
				Trans.generateTranslationFile(dir, language);
			} catch (IOException e) {
				System.err
						.println("I/O Exception: Cannot create/update a language in directory: "
								+ dir);
			}
			break;
		}
		case ONLY_PHOTO:
		case LOAD_PHOTO: {
			for (String file : files) {
				try {
					Card card = getCard(file, null).getCard();
					for (Contact contact : card) {
						String filename = contact.toString(format, "");
						File f = new File(dir, filename);

						if (f.exists()) {
							try {
								String b64 = StringUtils.fromImage(ImageIO
										.read(f));

								if (mode == Mode.ONLY_PHOTO) {
									for (Data photo = contact
											.getPreferredData("PHOTO"); photo != null; photo = contact
											.getPreferredData("PHOTO")) {
										photo.delete();
									}
								}

								List<TypeInfo> types = new LinkedList<TypeInfo>();
								types.add(new TypeInfo("ENCODING", "b"));
								types.add(new TypeInfo("TYPE", "png"));
								Data photo = new Data(types, "PHOTO", b64, null);
								contact.add(photo);
							} catch (IOException e) {
								System.err.println("Cannot read photo: "
										+ filename);
							}
						}
					}
					card.save();
				} catch (IOException e) {
					System.err.println("Card cannot be opened: " + file);
				}
			}
			break;
		}
		case SAVE_PHOTO: {
			for (String file : files) {
				try {
					Card card = getCard(file, null).getCard();
					for (Contact contact : card) {
						Data photo = contact.getPreferredData("PHOTO");
						if (photo != null) {
							String filename = contact.toString(format, "");
							File f = new File(dir, filename + ".png");
							try {
								ImageIO.write(
										StringUtils.toImage(photo.getValue()),
										"png", f);
							} catch (IOException e) {
								System.err
										.println("Cannot save photo of contact: "
												+ contact
														.getPreferredDataValue("FN"));
							}
						}
					}
				} catch (IOException e) {
					System.err.println("Card cannot be opened: " + file);
				}
			}
			break;
		}
		case CONTACT_MANAGER: {
			try {
				Optional.startTui(textMode, files);
			} catch (Exception e) {
				if (e instanceof IOException) {
					System.err
							.println("I/O Exception: Cannot start the program with the given cards");
				} else {
					System.err.println("TUI support not available");
					System.exit(ERR_INTERNAL);
				}
			}
			break;
		}
		}
	}

	/**
	 * Return the {@link Card} corresponding to the given resource name -- a
	 * file or a remote jvcard URL.
	 * 
	 * <p>
	 * Will also fix the FN if required (see display.properties).
	 * </p>
	 * 
	 * @param input
	 *            a filename or a remote jvcard url with named resource (e.g.:
	 *            <tt>jvcard://localhost:4444/coworkers.vcf</tt>)
	 * @param callback
	 *            the {@link MergeCallback} to call in case of conflict, or NULL
	 *            to disallow conflict management (the {@link Card} will not be
	 *            allowed to synchronise in case of conflicts)
	 * 
	 * @return the {@link Card}
	 * 
	 * @throws IOException
	 *             in case of IO error or remoting not available
	 */
	static public CardResult getCard(String input, MergeCallback callback)
			throws IOException {
		boolean remote = false;
		Format format = Format.Abook;
		String ext = input;
		if (ext.contains(".")) {
			String tab[] = ext.split("\\.");
			if (tab.length > 1 && tab[tab.length - 1].equalsIgnoreCase("vcf")) {
				format = Format.VCard21;
			}
		}

		if (input.contains("://")) {
			format = Format.VCard21;
			remote = true;
		}

		CardResult card = null;
		try {
			if (remote) {
				card = Optional.syncCard(input, callback);
			} else {
				card = new CardResult(new Card(new File(input), format), false,
						false, false);
			}
		} catch (IOException ioe) {
			throw ioe;
		} catch (Exception e) {
			throw new IOException("Remoting support not available", e);
		}

		// Fix the FN value
		if (defaultFn != null) {
			try {
				for (Contact contact : card.getCard()) {
					Data name = contact.getPreferredData("FN");
					if (name == null || name.getValue().length() == 0
							|| forceComputedFn) {
						name.setValue(contact.toString(defaultFn, ""));
					}
				}
			} catch (Exception e) {
				// sync failed -> getCard() throws.
				// do not update.
			}
		}

		return card;
	}

	/**
	 * Open the given path and add all its files if it is a directory or just
	 * this one if not to the returned list.
	 * 
	 * @param path
	 *            the path to open
	 * 
	 * @return the list of opened files
	 */
	static private List<String> open(String path) {
		List<String> files = new LinkedList<String>();

		if (path != null && path.startsWith("jvcard://")) {
			if (path.endsWith("/")) {
				files.addAll(list(path));
			} else {
				files.add(path);
			}
		} else {
			File file = new File(path);
			if (file.exists()) {
				if (file.isDirectory()) {
					for (File subfile : file.listFiles()) {
						if (!subfile.isDirectory())
							files.add(subfile.getAbsolutePath());
					}
				} else {
					files.add(file.getAbsolutePath());
				}
			} else {
				System.err.println("File or directory not found: \"" + path
						+ "\"");
			}
		}

		return files;
	}

	/**
	 * List all the available {@link Card}s on the given network location (which
	 * is expected to be a jVCard remote server, obviously).
	 * 
	 * @param path
	 *            the jVCard remote server path (e.g.:
	 *            <tt>jvcard://localhost:4444/</tt>)
	 * 
	 * @return the list of {@link Card}s
	 */
	static private List<String> list(String path) {
		List<String> files = new LinkedList<String>();

		try {
			String host = path.split("\\:")[1].substring(2);
			int port = Integer.parseInt(path.split("\\:")[2].replaceAll("/$",
					""));
			SimpleSocket s = new SimpleSocket(new Socket(host, port),
					"sync client");
			s.open(true);

			s.sendCommand(Command.LIST_CARD);
			for (String p : s.receiveBlock()) {
				files.add(path
						+ p.substring(StringUtils.fromTime(0).length() + 1));
			}
			s.close();
		} catch (Exception e) {
			e.printStackTrace();
		}

		return files;
	}

	/**
	 * Really, really ask for UTF-8 encoding.
	 */
	static private void utf8() {
		try {
			System.setProperty("file.encoding", "UTF-8");
			Field charset = Charset.class.getDeclaredField("defaultCharset");
			charset.setAccessible(true);
			charset.set(null, null);
		} catch (SecurityException e) {
		} catch (NoSuchFieldException e) {
		} catch (IllegalArgumentException e) {
		} catch (IllegalAccessException e) {
		}
	}

	/**
	 * Read display.properties to know if we should fix the FN field when empty,
	 * or always, or never.
	 */
	static private void readNFN() {
		ResourceBundle map = Bundles.getBundle("display");
		try {
			defaultFn = map.getString("CONTACT_DETAILS_DEFAULT_FN");
			if (defaultFn.trim().length() == 0)
				defaultFn = null;
		} catch (MissingResourceException e) {
			e.printStackTrace();
		}

		try {
			String forceComputedFnStr = map
					.getString("CONTACT_DETAILS_SHOW_COMPUTED_FN");
			if (forceComputedFnStr.length() > 0
					&& forceComputedFnStr.equalsIgnoreCase("true"))
				forceComputedFn = true;
		} catch (MissingResourceException e) {
			e.printStackTrace();
		}
	}
}