com.github.stephenc.javaisotools.joliet.impl.JolietNamingConventions Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2010. Stephen Connolly.
 * Copyright (C) 2007. Jens Hatlak 
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

package com.github.stephenc.javaisotools.joliet.impl;

import java.util.Vector;

import com.github.stephenc.javaisotools.iso9660.ISO9660Directory;
import com.github.stephenc.javaisotools.iso9660.ISO9660File;
import com.github.stephenc.javaisotools.iso9660.NamingConventions;
import com.github.stephenc.javaisotools.sabre.HandlerException;

public class JolietNamingConventions extends NamingConventions {
    private final int jolietMaxChars;

    /**
     * Whether to fail if a file name will be truncated
     */
	private boolean failOnTruncation;
    
	public static boolean FORCE_DOT_DELIMITER = true;

	/**
	 * @param maxChars
	 *            Maximum number of characters permitted in the filename: (64
	 *            for the specification; 103 from mkisofs; 110 from Microsoft.)
	 * 
	 * @see link
	 */
    public JolietNamingConventions(int maxChars, boolean failOnTruncation) {
        super("Joliet");
        jolietMaxChars = maxChars;
        this.failOnTruncation = failOnTruncation;
    }

    public void apply(ISO9660Directory dir) throws HandlerException {
        // Joliet directory name restrictions:
        // name <= 128 bytes (64 characters)
        // name may contain extension
        // name non-empty

        String filename = normalize(dir.getName());

        if (filename.length() > 64) {
            filename = filename.substring(0, 64);
        }

        if (filename.length() == 0) {
            throw new HandlerException(getID() + ": Empty directory name encountered.");
        }

        setFilename(dir, filename);
    }

    public void apply(ISO9660File file) throws HandlerException {
        // Joliet file name restrictions:
        // filename + extension <= 128 bytes (64 characters)
        // either filename or extension non-empty

        String filename = normalize(file.getFilename());
        String extension = normalize(file.getExtension());
        file.enforceDotDelimiter(FORCE_DOT_DELIMITER);

        if (filename.length() == 0 && extension.length() == 0) {
            throw new HandlerException(getID() + ": Empty file name encountered.");
        }

        if (file.enforces8plus3()) {
            if (filename.length() > 8) {
                filename = filename.substring(0, 8);
            }
            if (extension.length() > 3) {
                String mapping = getExtensionMapping(extension);
                if (mapping != null && mapping.length() <= 3) {
                    extension = normalize(mapping);
                } else {
                    extension = extension.substring(0, 3);
                }
            }
        }

        // If the complete file name is too long (name + extension + version + . and ;)
        int fullLength = filename.length() + extension.length() + (file.getVersion() + "").length() + 2;
		if (fullLength > jolietMaxChars) {
			if (failOnTruncation) {
				throw new HandlerException("File " + file.getFullName() + " is longer than the maximum Joliet name of " + jolietMaxChars + " characters");
			}
            if (filename.length() >= extension.length()) {
                // Shorten filename
                filename = filename.substring(0, filename.length() - (fullLength - jolietMaxChars));
            } else {
                // Shorten extension
                extension = extension.substring(0, extension.length() - (fullLength - jolietMaxChars));
            }
        }

        setFilename(file, filename, extension);
    }

    private String normalize(String name) {
        // Note: Backslash escaped for both the RegEx and Java itself
        return name.replaceAll("[*/:;?\\\\]", "_");
    }

    public void addDuplicate(Vector duplicates, String name, int version) {
        String[] data = {name.toUpperCase(), version + ""};
        duplicates.add(data);
    }

    public boolean checkFilenameEquality(String name1, String name2) {
        return name1.equalsIgnoreCase(name2);
    }

    public void checkPathLength(String isoPath) {
        // "Remainder of ISO 9660 section 6.8.2.1": 240 Byte (120 characters)
        if (isoPath.length() > 120) {
            System.out.println(getID() + ": Path length exceeds limit: " + isoPath);
        }
    }
}