/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*/
package org.apache.directory.studio.schemaeditor.model.io;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import org.apache.directory.studio.schemaeditor.PluginUtils;
import org.apache.directory.studio.schemaeditor.model.Project;
import org.apache.directory.studio.schemaeditor.model.ProjectType;
import org.apache.directory.studio.schemaeditor.model.Schema;
import org.dom4j.Attribute;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;
import org.eclipse.osgi.util.NLS;
/**
* This class is used to import a Project file.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class ProjectsImporter
{
// The tags
private static final String PROJECT_TAG = "project"; //$NON-NLS-1$
private static final String PROJECTS_TAG = "projects"; //$NON-NLS-1$
private static final String NAME_TAG = "name"; //$NON-NLS-1$
private static final String SCHEMAS_TAG = "schemas"; //$NON-NLS-1$
private static final String TYPE_TAG = "type"; //$NON-NLS-1$
private static final String CONNECTION_TAG = "connection"; //$NON-NLS-1$
private static final String SCHEMA_CONNECTOR_TAG = "schemaConnector"; //$NON-NLS-1$
private static final String SCHEMA_BACKUP_TAG = "schemaBackup"; //$NON-NLS-1$
/**
* Extract the project from the given path
*
* @param inputStream
* the {@link InputStream} of the file
* @param path
* the path of the file
* @return
* the corresponding project
* @throws ProjectsImportException
* if an error occurs when importing the project
*/
public static Project getProject( InputStream inputStream, String path ) throws ProjectsImportException
{
Project project = new Project();
SAXReader reader = new SAXReader();
Document document = null;
try
{
document = reader.read( inputStream );
}
catch ( DocumentException e )
{
throw new ProjectsImportException( NLS.bind( Messages.getString( "ProjectsImporter.NotReadCorrectly" ), //$NON-NLS-1$
new String[]
{ path } ) );
}
Element rootElement = document.getRootElement();
if ( !rootElement.getName().equals( PROJECT_TAG ) )
{
throw new ProjectsImportException( NLS.bind( Messages.getString( "ProjectsImporter.NotValidProject" ), //$NON-NLS-1$
new String[]
{ path } ) );
}
readProject( rootElement, project, path );
return project;
}
/**
* Extract the projects from the given input stream
*
* @param inputStream
* the {@link InputStream} of the file
* @param path
* the path of the file
* @return
* the corresponding projects
* @throws ProjectsImportException
* if an error occurs when importing the project
*/
public static Project[] getProjects( InputStream inputStream, String path ) throws ProjectsImportException
{
List<Project> projects = new ArrayList<Project>();
SAXReader reader = new SAXReader();
Document document = null;
try
{
document = reader.read( inputStream );
}
catch ( DocumentException e )
{
PluginUtils.logError( NLS.bind( Messages.getString( "ProjectsImporter.NotReadCorrectly" ), new String[] //$NON-NLS-1$
{ path } ), e );
throw new ProjectsImportException( NLS.bind( Messages.getString( "ProjectsImporter.NotReadCorrectly" ), //$NON-NLS-1$
new String[]
{ path } ) );
}
Element rootElement = document.getRootElement();
if ( !rootElement.getName().equals( PROJECTS_TAG ) )
{
throw new ProjectsImportException( NLS.bind( Messages.getString( "ProjectsImporter.NotValidProject" ), //$NON-NLS-1$
new String[]
{ path } ) );
}
for ( Iterator<?> i = rootElement.elementIterator( PROJECT_TAG ); i.hasNext(); )
{
Element projectElement = ( Element ) i.next();
Project project = new Project();
readProject( projectElement, project, path );
projects.add( project );
}
return projects.toArray( new Project[0] );
}
/**
* Reads a project.
*
* @param element
* the element
* @param project
* the project
* @param path
* the path
* @throws ProjectsImportException
* if an error occurs when importing the project
*/
private static void readProject( Element element, Project project, String path ) throws ProjectsImportException
{
// Name
Attribute nameAttribute = element.attribute( NAME_TAG );
if ( ( nameAttribute != null ) && ( !nameAttribute.getValue().equals( "" ) ) ) //$NON-NLS-1$
{
project.setName( nameAttribute.getValue() );
}
// Type
Attribute typeAttribute = element.attribute( TYPE_TAG );
if ( ( typeAttribute != null ) && ( !typeAttribute.getValue().equals( "" ) ) ) //$NON-NLS-1$
{
try
{
project.setType( ProjectType.valueOf( typeAttribute.getValue() ) );
}
catch ( IllegalArgumentException e )
{
throw new ProjectsImportException( Messages.getString( "ProjectsImporter.NotConvertableValue" ) ); //$NON-NLS-1$
}
}
// If project is an Online Schema Project
if ( project.getType().equals( ProjectType.ONLINE ) )
{
// Connection
Attribute connectionAttribute = element.attribute( CONNECTION_TAG );
if ( ( connectionAttribute != null ) && ( !connectionAttribute.getValue().equals( "" ) ) ) //$NON-NLS-1$
{
project.setConnection( PluginUtils.getConnection( connectionAttribute.getValue() ) );
}
// Schema Connector
Attribute schemaConnectorAttribute = element.attribute( SCHEMA_CONNECTOR_TAG );
if ( ( schemaConnectorAttribute != null ) && ( !schemaConnectorAttribute.getValue().equals( "" ) ) ) //$NON-NLS-1$
{
String schemaConnectorId = schemaConnectorAttribute.getValue();
SchemaConnector schemaConnector = null;
List<SchemaConnector> schemaConnectors = PluginUtils.getSchemaConnectors();
for ( SchemaConnector sc : schemaConnectors )
{
if ( sc.getId().equalsIgnoreCase( schemaConnectorId ) )
{
schemaConnector = sc;
}
}
if ( schemaConnector == null )
{
throw new ProjectsImportException( NLS.bind( Messages
.getString( "ProjectsImporter.NoSchemaConnectorIDFound" ), new String[] //$NON-NLS-1$
{ schemaConnectorId } ) ); //$NON-NLS-1$
}
project.setSchemaConnector( schemaConnector );
}
// SchemaBackup
Element schemaBackupElement = element.element( SCHEMA_BACKUP_TAG );
if ( schemaBackupElement != null )
{
Element schemasElement = schemaBackupElement.element( SCHEMAS_TAG );
if ( schemasElement != null )
{
Schema[] schemas = null;
try
{
schemas = XMLSchemaFileImporter.readSchemas( schemasElement, path );
for ( Schema schema : schemas )
{
schema.setProject( project );
}
}
catch ( XMLSchemaFileImportException e )
{
throw new ProjectsImportException( Messages.getString( "ProjectsImporter.NotConvertableSchema" ) ); //$NON-NLS-1$
}
project.setInitialSchema( Arrays.asList( schemas ) );
}
}
}
// Schemas
Element schemasElement = element.element( SCHEMAS_TAG );
if ( schemasElement != null )
{
Schema[] schemas = null;
try
{
schemas = XMLSchemaFileImporter.readSchemas( schemasElement, path );
}
catch ( XMLSchemaFileImportException e )
{
throw new ProjectsImportException( Messages.getString( "ProjectsImporter.NotConvertableSchema" ) ); //$NON-NLS-1$
}
for ( Schema schema : schemas )
{
schema.setProject( project );
project.getSchemaHandler().addSchema( schema );
}
}
}
/**
* This enum represents the different types of project files.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public enum ProjectFileType
{
SINGLE, MULTIPLE
}
/**
* Gets the type of file.
*
* @param inputStream
* the {@link InputStream} of the file
* @param path
* the path of the file
* @return
* the type of the file
* @throws ProjectsImportException
*/
public static ProjectFileType getProjectFileType( InputStream inputStream, String path )
throws ProjectsImportException
{
SAXReader reader = new SAXReader();
Document document = null;
try
{
document = reader.read( inputStream );
}
catch ( DocumentException e )
{
throw new ProjectsImportException( NLS.bind( Messages.getString( "ProjectsImporter.NotReadCorrectly" ), //$NON-NLS-1$
new String[]
{ path } ) );
}
Element rootElement = document.getRootElement();
if ( rootElement.getName().equals( PROJECT_TAG ) )
{
return ProjectFileType.SINGLE;
}
else if ( rootElement.getName().equals( PROJECTS_TAG ) )
{
return ProjectFileType.MULTIPLE;
}
else
{
throw new ProjectsImportException( NLS.bind( Messages.getString( "ProjectsImporter.NotValidProject" ), //$NON-NLS-1$
new String[]
{ path } ) );
}
}
}