/**
*
* Copyright
* 2009-2015 Jayway Products AB
* 2016-2017 Föreningen Sambruk
*
* Licensed under AGPL, Version 3.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.gnu.org/licenses/agpl.txt
*
* 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 se.streamsource.streamflow.infrastructure.configuration;
import org.qi4j.api.injection.scope.Structure;
import org.qi4j.api.injection.scope.This;
import org.qi4j.api.injection.scope.Uses;
import org.qi4j.api.mixin.Mixins;
import org.qi4j.api.property.Property;
import org.qi4j.api.service.Activatable;
import org.qi4j.api.service.ServiceComposite;
import org.qi4j.api.structure.Application;
import org.qi4j.spi.service.ServiceDescriptor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.File;
import java.text.MessageFormat;
import java.util.Locale;
import java.util.ResourceBundle;
/**
* Service for accessing application-specific directories. These will default to
* the platform settings, but can be overridden manually, either one-by-one or as a whole.
* <p/>
* Services will most likely want to create their own subdirectories in the directories accessed
* from here.
*/
@Mixins(FileConfiguration.Mixin.class)
public interface FileConfiguration
extends ServiceComposite, Activatable
{
public enum OS
{
windows, unix, mac
}
OS os();
File user();
File configurationDirectory();
File dataDirectory();
File temporaryDirectory();
File cacheDirectory();
File logDirectory();
interface Data
{
Property<OS> os();
Property<String> application();
Property<File> user();
Property<File> configuration();
Property<File> data();
Property<File> temporary();
Property<File> cache();
Property<File> log();
}
abstract class Mixin
implements FileConfiguration, Activatable
{
final Logger logger = LoggerFactory.getLogger( getClass().getName() );
@This
Data data;
@Uses
ServiceDescriptor descriptor;
@Structure
Application app;
public void activate() throws Exception
{
OS os = detectOS();
data.os().set( os );
logger.info( "Operating system:" + os.name() );
// Get user directory
String user = System.getenv( "USERPROFILE" ); // On Windows we use this instead of user.home
if (user == null)
user = System.getProperty( "user.home" );
data.user().set(new File(user));
// Get bundle with application name and configured directories
ResourceBundle bundle = ResourceBundle.getBundle( FileConfiguration.class.getName(), new Locale( os.name() ) );
// Set application name. This is taken from the Qi4j application but can be overriden by a system property
String application = System.getProperty( "application", app.name() );
if (!app.mode().equals(Application.Mode.production))
application += "-"+app.mode().name();
data.application().set( application );
// Temp dir
String temp = System.getProperty( "java.io.tmpdir" );
// Arguments available to use in directory specifications
String[] args = new String[]{application, user, os.name(), temp};
data.configuration().set( new File( MessageFormat.format( bundle.getString( "configuration" ), args ) ) );
data.data().set( new File( MessageFormat.format( bundle.getString( "data" ), args ) ) );
data.temporary().set( new File( MessageFormat.format( bundle.getString( "temporary" ), args ) ) );
data.cache().set( new File( MessageFormat.format( bundle.getString( "cache" ), args ) ) );
data.log().set( new File( MessageFormat.format( bundle.getString( "log" ), args ) ) );
autoCreateDirectories();
testCleanup();
}
public void passivate() throws Exception
{
testCleanup();
}
public OS os()
{
return data.os().get();
}
public File user()
{
return data.user().get();
}
public File configurationDirectory()
{
return data.configuration().get();
}
public File dataDirectory()
{
return data.data().get();
}
public File temporaryDirectory()
{
return data.temporary().get();
}
public File cacheDirectory()
{
return data.cache().get();
}
public File logDirectory()
{
return data.log().get();
}
private void testCleanup()
{
if (app.mode().equals( Application.Mode.test ) || app.mode().equals(Application.Mode.development))
{
// Delete test data
delete( configurationDirectory() );
delete( dataDirectory() );
delete( temporaryDirectory() );
delete( cacheDirectory() );
delete( logDirectory() );
}
}
private boolean delete( File file )
{
if (!file.exists())
return true;
if (file.isFile())
{
return file.delete();
} else
{
for (File childFile : file.listFiles())
{
if (!delete( childFile ))
return false;
}
return file.delete();
}
}
private OS detectOS()
{
String osName = System.getProperty( "os.name" ).toLowerCase();
OS os;
if (osName.indexOf( "win" ) != -1)
os = OS.windows;
else if (osName.indexOf( "mac" ) != -1)
os = OS.mac;
else
os = OS.unix;
return os;
}
private void autoCreateDirectories()
{
// Create directories
if (!configurationDirectory().exists() && !configurationDirectory().mkdirs())
throw new IllegalStateException( "Could not create configuration directory(" + configurationDirectory() + ")" );
if (!dataDirectory().exists() && !dataDirectory().mkdirs())
throw new IllegalStateException( "Could not create data directory(" + dataDirectory() + ")" );
if (!temporaryDirectory().exists() && !temporaryDirectory().mkdirs())
throw new IllegalStateException( "Could not create temporary directory(" + temporaryDirectory() + ")" );
if (!cacheDirectory().exists() && !cacheDirectory().mkdirs())
throw new IllegalStateException( "Could not create cache directory(" + cacheDirectory() + ")" );
if (!logDirectory().exists() && !logDirectory().mkdirs())
throw new IllegalStateException( "Could not create log directory(" + logDirectory() + ")" );
}
}
}