ContentsEntry.java

/*
 * ContentsEntry.java
 *
 * Version: $Revision: 3984 $
 *
 * Date: $Date: 2009-06-29 22:33:25 -0400 (Mon, 29 Jun 2009) $
 *
 * Copyright (c) 2002-2009, The DSpace Foundation.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * - Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * - Neither the name of the DSpace Foundation nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 */
package org.dspace.app.itemupdate;

import java.text.ParseException;
import java.util.regex.*;

import org.dspace.core.Constants;

/**
 *   Holds the elements of a line in the Contents Entry file
 * 
 *   Based on private methods in ItemImport
 *   
 *   Lacking a spec or full documentation for the file format, 
 *   it looks from the source code that the ordering or elements is not fixed
 * 
 *   e.g.:    
 *      48217870-MIT.pdf\tbundle: bundlename\tpermissions: -r 'MIT Users'\tdescription: Full printable version (MIT only)
 *      permissions: -[r|w] ['group name']
 *      description: <the description of the file>
 * 
 *
 */
public class ContentsEntry 
{
	public static final String HDR_BUNDLE = "bundle:";
	public static final String HDR_PERMISSIONS = "permissions:";
	public static final String HDR_DESCRIPTION = "description:";
		
	public static final Pattern permissionsPattern = Pattern.compile("-([rw])\\s*'?([^']+)'?");
	
	final String filename;
	final String bundlename;
	final String permissionsGroupName;
	final int permissionsActionId;
	final String description;
	
	private ContentsEntry(String filename, 
			             String bundlename,
			             int permissionsActionId,
			             String permissionsGroupName,
			             String description)
	{
		this.filename = filename;
		this.bundlename = bundlename;
		this.permissionsActionId = permissionsActionId;
		this.permissionsGroupName = permissionsGroupName;
		this.description = description;
	}
	
	/**
	 *   Factory method parses a line from the Contents Entry file
	 *   
	 * @param line
	 * @return the parsed ContentsEntry object 
	 * @throws ParseException
	 */
	public static ContentsEntry parse(String line)
	throws ParseException
	{
		String[] ar = line.split("\t");
		ItemUpdate.pr("ce line split: " + ar.length);
		
		String[] arp = new String[4];
		arp[0] = ar[0];   //bitstream name doesn't have header and is always first
		
		String groupName = null;
		int actionId = -1;

		if (ar.length > 1)
		{
			for (int i=1; i < ar.length; i++)
			{
				ItemUpdate.pr("ce " + i + " : " + ar[i]);
				if (ar[i].startsWith(HDR_BUNDLE))
				{
					arp[1] = ar[i].substring(HDR_BUNDLE.length()).trim();
					
				}
				else if (ar[i].startsWith(HDR_PERMISSIONS))
				{
					arp[2] = ar[i].substring(HDR_PERMISSIONS.length()).trim();
					
					// parse into actionId and group name
					
					Matcher m = permissionsPattern.matcher(arp[2]);
					if (m.matches())
					{
						String action = m.group(1); //
						if (action.equals("r"))
						{
							 actionId = Constants.READ;
						}
						else if (action.equals("w"))
						{
							 actionId = Constants.WRITE;
						}
						
						groupName = m.group(2).trim();
					}
					
				}
				else if (ar[i].startsWith(HDR_DESCRIPTION))
				{
					arp[3] = ar[i].substring(HDR_DESCRIPTION.length()).trim();
					
				}
				else
				{
					throw new ParseException("Unknown text in contents file: " + ar[i], 0);				
				}			
			}
		}
		return new ContentsEntry(arp[0], arp[1], actionId, groupName, arp[3]);
	}
	
	public String toString()
	{
		StringBuilder sb = new StringBuilder(filename);
		if (bundlename != null)
		{
			sb.append(HDR_BUNDLE).append(" ").append(bundlename);
		}
		
		if (permissionsGroupName != null)
		{
			sb.append(HDR_PERMISSIONS);
			if (permissionsActionId == Constants.READ)
			{
				sb.append(" -r ");
			}
			else if (permissionsActionId == Constants.WRITE)
			{
				sb.append(" -w ");
			}
			sb.append(permissionsGroupName);
		}
		
		if (description != null)
		{
			sb.append(HDR_DESCRIPTION).append(" ").append(description);
		}		
		
		return sb.toString();
	}
	
}