org.eclipse.mylyn.reviews.r4e.core/src/org/eclipse/mylyn/reviews/r4e/core/model/serial/impl/R4EWriter.java

/*******************************************************************************
 * Copyright (c) 2010, 2012 Ericsson AB and others.
 * 
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *   Ericsson AB - Intial Implementation
 *******************************************************************************/

package org.eclipse.mylyn.reviews.r4e.core.model.serial.impl;

import java.io.File;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.ecore.resource.ResourceSet;
import org.eclipse.emf.ecore.xmi.XMLResource;
import org.eclipse.mylyn.reviews.r4e.core.model.serial.IModelWriter;
import org.eclipse.mylyn.reviews.r4e.core.model.serial.IRWUserBasedRes;
import org.eclipse.mylyn.reviews.r4e.core.model.serial.IRWUserBasedRes.ResourceType;
import org.eclipse.mylyn.reviews.r4e.core.model.serial.Persistence;
import org.eclipse.mylyn.reviews.r4e.core.model.serial.RWCommon;
import org.eclipse.mylyn.reviews.r4e.core.utils.ResourceUtils;
import org.eclipse.mylyn.reviews.r4e.core.utils.filePermission.FileSupportCommandFactory;
import org.eclipse.mylyn.reviews.r4e.core.utils.filePermission.IFileSupportCommand;

/**
 * @author Alvaro Sanchez-Leon
 */
public class R4EWriter extends RWCommon implements IModelWriter {

	// ------------------------------------------------------------------------
	// Constants
	// ------------------------------------------------------------------------
	protected final Map<ResourceType, String>	fresTypeToTag	= new HashMap<ResourceType, String>();
	private final Persistence.IResSerializationState	fResState;

	// ------------------------------------------------------------------------
	// Constructors
	// ------------------------------------------------------------------------
	public R4EWriter(Persistence.IResSerializationState aResState) {
		// Save the resource state lookup interface
		fResState = aResState;

		// Build a lookup table to facilitate the selection of the proper resource tag
		fresTypeToTag.put(ResourceType.USER_COMMENT, IRWUserBasedRes.REVIEW_UCOMMENT_TAG);
		fresTypeToTag.put(ResourceType.USER_ITEM, IRWUserBasedRes.REVIEW_UITEM_TAG);
		fresTypeToTag.put(ResourceType.REVIEW, IRWUserBasedRes.REVIEW_RES_TAG);
		fresTypeToTag.put(ResourceType.USER_GROUP, IRWUserBasedRes.GROUP_UREVIEW_TAG);
		fresTypeToTag.put(ResourceType.GROUP, IRWUserBasedRes.GROUP_ROOT_TAG);
		fresTypeToTag.put(ResourceType.DRULE_SET, IRWUserBasedRes.DRULE_SET_TAG);
		
		//Save options
		if (fOptions == null) {
			fOptions = new HashMap<String, Object>();
		}
		fOptions.put(XMLResource.OPTION_ENCODING, "UTF-8");
	}

	/* (non-Javadoc)
	 * @see org.eclipse.mylyn.reviews.r4e.core.model.serial.impl.IModelWriter#saveResources(org.eclipse.emf.ecore.resource.ResourceSet)
	 */
	public void saveResources(ResourceSet resourceSet) throws ResourceHandlingException {
		// Indicate to save the schema location within the resource files
		// options = new HashMap<String, Boolean>();
		// options.put(XMLResource.OPTION_SCHEMA_LOCATION, Boolean.TRUE);

		EList<Resource> resources = resourceSet.getResources();
		if (resources != null) {
			for (Resource resource : resources) {
				saveResource(resource);
			}
		}
	}

	/* (non-Javadoc)
	 * @see org.eclipse.mylyn.reviews.r4e.core.model.serial.impl.IModelWriter#saveResource(org.eclipse.emf.ecore.resource.Resource)
	 */
	public void saveResource(Resource resource) throws ResourceHandlingException {
		// If serialization for this resource is marked inactive, nothing to do.
		if (fResState.isSerializationInactive(resource)) {
			return;
		}

		// Indicate to save the schema location within the resource files
		// options = new HashMap<String, Boolean>();
		// options.put(XMLResource.OPTION_SCHEMA_LOCATION, Boolean.TRUE);
		StringBuilder message = new StringBuilder();
		URI resUri = resource.getURI();
		if (resUri == null) {
			message.append("Not possible to save a Resource with URI= null");
			throw new ResourceHandlingException(message.toString());
		}
		
		// Mark new folder creation
		URI folderUri = ResourceUtils.getFolderPath(resUri);
		File folder = new File(URI.decode(folderUri.devicePath()));
		boolean newFolder = !folder.exists();
		
		// Mark new file creation
		File file = new File(URI.decode(resUri.devicePath()));
		boolean newFile = !file.exists();

		// When change tracking is implemented, restrict save to resources marked as modified
		try {
			resource.save(fOptions);
		} catch (IOException e) {
			message.setLength(0);
			message.append("IOException while saving resource with URI: " + resource.getURI().toString());
			throw new ResourceHandlingException(message.toString(), e);
		}

		IFileSupportCommand permitionsUpdater = FileSupportCommandFactory.getInstance();
		// Change folder permissions for new resources
		if (newFolder && folder.exists()) {
			String absFolderStr = folder.getAbsolutePath();
			try {
				permitionsUpdater.grantWritePermission(absFolderStr);
			} catch (IOException e) {
				message.setLength(0);
				message.append("IOException while changing permissions to : " + absFolderStr);
				throw new ResourceHandlingException(message.toString(), e);
			}
		}

		// Change file permissions, if successfully created
		if (newFile && file.exists()) {
			String absFileStr = file.getAbsolutePath();
			try {
				permitionsUpdater.grantWritePermission(absFileStr);
			} catch (IOException e) {
				message.setLength(0);
				message.append("IOException while changing permissions to : " + absFileStr);
				throw new ResourceHandlingException(message.toString(), e);
			}
		}
	}

	/* (non-Javadoc)
	 * @see org.eclipse.mylyn.reviews.r4e.core.model.serial.impl.IModelWriter#createResourceURI(java.lang.String, org.eclipse.emf.common.util.URI, org.eclipse.mylyn.reviews.r4e.core.model.serial.impl.IRWUserBasedRes.ResourceType)
	 */
	public URI createResourceURI(String name, URI containerPath, ResourceType resourceType) {
		URI resURI = null;
		String reviewFolderSegment = null;
		String fileName = null;
		if (name != null) {
			reviewFolderSegment = toValidFileName(name);
			// convert name to a valid file name
			fileName = reviewFolderSegment + fresTypeToTag.get(resourceType);
			if (resourceType == ResourceType.REVIEW) {
				resURI = containerPath.appendSegment(reviewFolderSegment).appendSegment(fileName);
			} else {
				resURI = containerPath.appendSegment(fileName);
			}
			resURI = resURI.appendFileExtension(IRWUserBasedRes.EXTENSION);
		}

		return resURI;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.mylyn.reviews.r4e.core.model.serial.impl.IModelWriter#toValidFileName(java.lang.String)
	 */
	public String toValidFileName(String stValue) {
		String result = null;
		StringBuilder sb = new StringBuilder();

		if (stValue != null) {
			int size = stValue.length();
			for (int i = 0; i < size; i++) {
				char c = stValue.charAt(i);
				if (!Character.isLetterOrDigit(c) && c != '-' && c != '_') {
					sb.append('_');
				} else {
					sb.append(c);
				}
			}
			result = sb.toString();
		}

		return result;
	}
}