/*
* Copyright 2000-2013 Enonic AS
* http://www.enonic.com/license
*/
package com.enonic.cms.itest.util;
import java.util.Date;
import org.jdom.Document;
import org.joda.time.DateTime;
import org.springframework.beans.factory.annotation.Autowired;
import com.enonic.cms.api.client.model.user.UserInfo;
import com.enonic.cms.api.plugin.ext.userstore.UserFieldType;
import com.enonic.cms.api.plugin.ext.userstore.UserStoreConfigField;
import com.enonic.cms.core.content.ContentEntity;
import com.enonic.cms.core.content.ContentKey;
import com.enonic.cms.core.content.ContentStatus;
import com.enonic.cms.core.content.ContentVersionEntity;
import com.enonic.cms.core.content.access.ContentAccessEntity;
import com.enonic.cms.core.content.access.ContentAccessType;
import com.enonic.cms.core.content.binary.BinaryDataAndBinary;
import com.enonic.cms.core.content.binary.BinaryDataEntity;
import com.enonic.cms.core.content.binary.ContentBinaryDataEntity;
import com.enonic.cms.core.content.binary.ContentBinaryDataKey;
import com.enonic.cms.core.content.category.CategoryAccessControl;
import com.enonic.cms.core.content.category.CategoryAccessEntity;
import com.enonic.cms.core.content.category.CategoryAccessKey;
import com.enonic.cms.core.content.category.CategoryAccessType;
import com.enonic.cms.core.content.category.CategoryEntity;
import com.enonic.cms.core.content.category.CategoryKey;
import com.enonic.cms.core.content.category.UnitEntity;
import com.enonic.cms.core.content.category.UnitKey;
import com.enonic.cms.core.content.contenttype.ContentHandlerEntity;
import com.enonic.cms.core.content.contenttype.ContentHandlerKey;
import com.enonic.cms.core.content.contenttype.ContentHandlerName;
import com.enonic.cms.core.content.contenttype.ContentTypeEntity;
import com.enonic.cms.core.language.LanguageEntity;
import com.enonic.cms.core.language.LanguageKey;
import com.enonic.cms.core.resource.ResourceKey;
import com.enonic.cms.core.security.group.GroupEntity;
import com.enonic.cms.core.security.group.GroupKey;
import com.enonic.cms.core.security.group.GroupType;
import com.enonic.cms.core.security.user.UserEntity;
import com.enonic.cms.core.security.user.UserType;
import com.enonic.cms.core.security.userstore.UserStoreEntity;
import com.enonic.cms.core.security.userstore.UserStoreKey;
import com.enonic.cms.core.structure.RunAsType;
import com.enonic.cms.core.structure.SiteEntity;
import com.enonic.cms.core.structure.menuitem.ContentHomeEntity;
import com.enonic.cms.core.structure.menuitem.ContentHomeKey;
import com.enonic.cms.core.structure.menuitem.MenuItemAccessEntity;
import com.enonic.cms.core.structure.menuitem.MenuItemAccessKey;
import com.enonic.cms.core.structure.menuitem.MenuItemAccessType;
import com.enonic.cms.core.structure.menuitem.MenuItemEntity;
import com.enonic.cms.core.structure.menuitem.MenuItemKey;
import com.enonic.cms.core.structure.menuitem.MenuItemType;
import com.enonic.cms.core.structure.page.template.PageTemplateEntity;
import com.enonic.cms.core.structure.page.template.PageTemplateType;
import com.enonic.cms.core.user.field.UserInfoTransformer;
/**
* Nov 26, 2009
*/
public class DomainFactory
{
private MockKeyService mockKeyService = new MockKeyService();
@Autowired
private DomainFixture fixture;
DomainFactory( DomainFixture fixture )
{
this.fixture = fixture;
fixture.setFactory( this );
}
public LanguageEntity createLanguage( String code )
{
LanguageEntity language = new LanguageEntity();
language.setKey( new LanguageKey( mockKeyService.generateNextKeySafe( "TLANGUAGE" ) ) );
language.setCode( code );
language.setTimestamp( new Date() );
return language;
}
public UserStoreEntity createUserStore( String name )
{
UserStoreEntity userStore = new UserStoreEntity();
userStore.setKey( new UserStoreKey( mockKeyService.generateNextKeySafe( "TDOMAIN" ) ) );
userStore.setName( name );
userStore.setDeleted( false );
return userStore;
}
public UserStoreEntity createUserStore( String name, String connectorName, boolean isDefault )
{
UserStoreEntity userStore = new UserStoreEntity();
userStore.setKey( new UserStoreKey( mockKeyService.generateNextKeySafe( "TDOMAIN" ) ) );
userStore.setName( name );
userStore.setDeleted( false );
userStore.setConnectorName( connectorName );
userStore.setDefaultStore( isDefault );
return userStore;
}
public UserEntity createUser( String uid, String displayName, UserType type, String userStoreName )
{
return createUser( uid, displayName, type, userStoreName, null );
}
public UserEntity createUserWithAllValues( String uid, String displayName, UserType type, String userStoreName, UserInfo userInfo )
{
UserEntity user = new UserEntity();
user.setName( uid );
user.setDisplayName( displayName );
user.setSyncValue( uid );
user.setTimestamp( new DateTime() );
user.setType( type );
user.setDeleted( 0 );
if ( userStoreName != null )
{
user.setUserStore( fixture.findUserStoreByName( userStoreName ) );
}
user.setUserGroup( null );
user.setUserFields( new UserInfoTransformer().toUserFields( userInfo ) );
return user;
}
public UserEntity createNormalUserInUserstore( String uid, String displayName, String userstoreName )
{
return createUser( uid, displayName, UserType.NORMAL, userstoreName, null );
}
public UserEntity createUser( String uid, String displayName, UserType type, String userStoreName, GroupEntity group )
{
UserEntity user = new UserEntity();
user.setName( uid );
user.setDisplayName( displayName );
user.setSyncValue( uid );
user.setTimestamp( new DateTime() );
user.setType( type );
user.setDeleted( 0 );
if ( userStoreName != null )
{
user.setUserStore( fixture.findUserStoreByName( userStoreName ) );
}
if ( group != null )
{
user.setUserGroup( group );
}
return user;
}
public UserStoreConfigField createUserStoreUserFieldConfig( UserFieldType type, String properties )
{
UserStoreConfigField config = new UserStoreConfigField( type );
config.setRemote( properties.contains( "remote" ) );
config.setRequired( properties.contains( "required" ) );
config.setReadOnly( properties.contains( "read-only" ) );
return config;
}
public GroupEntity createGlobalGroup( String name )
{
GroupEntity group = createGroup( name, GroupType.GLOBAL_GROUP, true );
return group;
}
public GroupEntity createGroup( String name, GroupType groupType, final boolean restriced )
{
GroupEntity group = new GroupEntity();
group.setName( name );
group.setSyncValue( "sync_" + name );
group.setDeleted( 0 );
group.setRestricted( restriced );
group.setType( groupType );
return group;
}
public GroupEntity createGroupInUserstore( String name, GroupType groupType, String userstoreName )
{
GroupEntity group = new GroupEntity();
group.setKey( new GroupKey( Integer.toString( mockKeyService.generateNextKeySafe( "TGROUP" ) ) ) );
group.setName( name );
group.setSyncValue( "sync_" + name );
group.setDeleted( 0 );
group.setRestricted( 1 );
group.setType( groupType );
group.setUserStore( fixture.findUserStoreByName( userstoreName ) );
return group;
}
public ContentHandlerEntity createContentHandler( String name, String handlerClassName )
{
ContentHandlerName contentHandlerName = ContentHandlerName.parse( handlerClassName );
ContentHandlerEntity contentHandler = new ContentHandlerEntity();
contentHandler.setKey( new ContentHandlerKey( mockKeyService.generateNextKeySafe( "TCONTENTHANDLER" ) ) );
contentHandler.setName( name );
contentHandler.setClassName( contentHandlerName.getHandlerClassShortName() );
contentHandler.setTimestamp( new Date() );
return contentHandler;
}
public ContentTypeEntity createContentType( String name, String contentHandlerClassName )
{
return createContentType( name, contentHandlerClassName, null );
}
public ContentTypeEntity createContentType( String name, String contentHandlerClassName, Document data )
{
ContentTypeEntity contenType = new ContentTypeEntity();
contenType.setKey( mockKeyService.generateNextKeySafe( "TCONTENTTYPE" ) );
contenType.setName( name );
contenType.setContentHandler( fixture.findContentHandlerByClassName( contentHandlerClassName ) );
contenType.setTimestamp( new Date() );
contenType.setData( data );
return contenType;
}
public ContentTypeEntity createContentType( Integer key, String name, String contentHandlerClassName, Document data )
{
ContentTypeEntity contenType = new ContentTypeEntity();
contenType.setKey( key );
contenType.setName( name );
contenType.setContentHandler( fixture.findContentHandlerByClassName( contentHandlerClassName ) );
contenType.setTimestamp( new Date() );
contenType.setData( data );
return contenType;
}
public UnitEntity createUnit( String name )
{
return createUnit( name, "en" );
}
public UnitEntity createUnit( String name, String languageCode )
{
UnitEntity unit = new UnitEntity();
unit.setKey( new UnitKey( mockKeyService.generateNextKeySafe( "TUNIT" ) ) );
unit.setName( name );
unit.setLanguage( fixture.findLanguageByCode( languageCode ) );
unit.setDeleted( false );
return unit;
}
public CategoryEntity createCategory( String name, String parentCategoryName, String contentTypeName, String unitName, String ownerUid,
String modifierUid )
{
return createCategory( name, parentCategoryName, contentTypeName, unitName, ownerUid, modifierUid, false );
}
public CategoryEntity createCategory( String name, String parentCategoryName, String contentTypeName, String unitName, String ownerUid,
String modifierUid, boolean autoApprove )
{
CategoryEntity category = new CategoryEntity();
category.setKey( new CategoryKey( mockKeyService.generateNextKeySafe( "TCATEGORY" ) ) );
category.setName( name );
if ( contentTypeName != null )
{
category.setContentType( fixture.findContentTypeByName( contentTypeName ) );
}
category.setUnit( fixture.findUnitByName( unitName ) );
category.setCreated( new Date() );
category.setTimestamp( new Date() );
category.setOwner( fixture.findUserByName( ownerUid ) );
category.setModifier( fixture.findUserByName( modifierUid ) );
category.setAutoMakeAvailable( autoApprove );
category.setDeleted( false );
if ( parentCategoryName != null )
{
CategoryEntity parentCategory = fixture.findCategoryByName( parentCategoryName );
category.setParent( parentCategory );
}
return category;
}
public ContentEntity createContent( String categoryName, String languageCode, String ownerQualifiedName, String priority, Date created )
{
return createContent( "testcontent_" + categoryName, categoryName, languageCode, ownerQualifiedName, priority, created );
}
public ContentEntity createContent( String contentName, String categoryName, String languageCode, String ownerQualifiedName,
String priority, Date created )
{
ContentEntity content = new ContentEntity();
content.setLanguage( fixture.findLanguageByCode( languageCode ) );
content.setCategory( fixture.findCategoryByName( categoryName ) );
content.setOwner( fixture.findUserByName( ownerQualifiedName ) );
content.setPriority( Integer.valueOf( priority ) );
content.setCreatedAt( created ); // Not-null field in database.
content.setDeleted( false ); // Not-null field in database.
content.setName( contentName );
return content;
}
public ContentVersionEntity createContentVersion( String status, String modiferQualifiedName )
{
ContentVersionEntity version = new ContentVersionEntity();
version.setStatus( ContentStatus.get( Integer.valueOf( status ) ) );
version.setModifiedBy( fixture.findUserByName( modiferQualifiedName ) );
return version;
}
public BinaryDataAndBinary createBinaryDataAndBinary( String name, byte[] data )
{
BinaryDataEntity binaryData = createBinaryData( name, data.length );
return new BinaryDataAndBinary( binaryData, data );
}
public BinaryDataEntity createBinaryData( String name, int size )
{
BinaryDataEntity binaryData = new BinaryDataEntity();
binaryData.setName( name );
binaryData.setCreatedAt( new Date() );
binaryData.setSize( size );
return binaryData;
}
public CategoryAccessControl createCategoryAccessControl( GroupEntity group, String accesses )
{
CategoryAccessControl access = new CategoryAccessControl();
access.setGroupKey( group.getGroupKey() );
access.setReadAccess( accesses.contains( CategoryAccessType.READ.toString().toLowerCase() ) );
access.setAdminAccess( accesses.contains( CategoryAccessType.ADMINISTRATE.toString().toLowerCase() ) );
access.setCreateAccess( accesses.contains( CategoryAccessType.CREATE.toString().toLowerCase() ) );
access.setPublishAccess( accesses.contains( CategoryAccessType.APPROVE.toString().toLowerCase() ) );
access.setAdminBrowseAccess( accesses.contains( CategoryAccessType.ADMIN_BROWSE.toString().toLowerCase() ) );
return access;
}
public CategoryAccessEntity createCategoryAccess( String categoryName, GroupEntity group, String accesses )
{
CategoryEntity category = fixture.findCategoryByName( categoryName );
CategoryAccessEntity access = new CategoryAccessEntity();
access.setKey( new CategoryAccessKey( category.getKey(), group.getGroupKey() ) );
access.setGroup( group );
access.setReadAccess( accesses.contains( CategoryAccessType.READ.toString().toLowerCase() ) );
access.setAdminAccess( accesses.contains( CategoryAccessType.ADMINISTRATE.toString().toLowerCase() ) );
access.setCreateAccess( accesses.contains( CategoryAccessType.CREATE.toString().toLowerCase() ) );
access.setPublishAccess( accesses.contains( CategoryAccessType.APPROVE.toString().toLowerCase() ) );
access.setAdminBrowseAccess( accesses.contains( CategoryAccessType.ADMIN_BROWSE.toString().toLowerCase() ) );
return access;
}
public MenuItemAccessEntity createMenuItemAccess( MenuItemEntity menuItem, UserEntity user, String accesses )
{
return createMenuItemAccess( menuItem, user.getUserGroup(), accesses );
}
public MenuItemAccessEntity createMenuItemAccess( String menuItemName, int menuItemOrder, GroupEntity group, String accesses )
{
MenuItemEntity menuItem = fixture.findMenuItemByName( menuItemName );
return createMenuItemAccess( menuItem, group, accesses );
}
public MenuItemAccessEntity createMenuItemAccess( MenuItemEntity menuItem, GroupEntity group, String accesses )
{
MenuItemAccessEntity access = new MenuItemAccessEntity();
access.setKey( new MenuItemAccessKey( menuItem.getKey(), group.getGroupKey() ) );
access.setAddAccess( accesses.contains( MenuItemAccessType.ADD.toString().toLowerCase() ) );
access.setAdminAccess( accesses.contains( MenuItemAccessType.ADMINISTRATE.toString().toLowerCase() ) );
access.setCreateAccess( accesses.contains( MenuItemAccessType.CREATE.toString().toLowerCase() ) );
access.setDeleteAccess( accesses.contains( MenuItemAccessType.DELETE.toString().toLowerCase() ) );
access.setPublishAccess( accesses.contains( MenuItemAccessType.PUBLISH.toString().toLowerCase() ) );
access.setReadAccess( accesses.contains( MenuItemAccessType.READ.toString().toLowerCase() ) );
access.setUpdateAccess( accesses.contains( MenuItemAccessType.UPDATE.toString().toLowerCase() ) );
return access;
}
public CategoryAccessEntity createCategoryAccess( String categoryName, UserEntity user, String accesses )
{
return createCategoryAccess( categoryName, user.getUserGroup(), accesses );
}
public CategoryAccessEntity createCategoryAccessForUser( String categoryName, String userName, String accesses )
{
UserEntity user = fixture.findUserByName( userName );
return createCategoryAccess( categoryName, user.getUserGroup(), accesses );
}
public CategoryAccessEntity createCategoryAccessForGroup( String categoryName, String groupName, String accesses )
{
GroupEntity group = fixture.findGroupByName( groupName );
return createCategoryAccess( categoryName, group, accesses );
}
public ContentAccessEntity createContentAccess( String accesses, GroupEntity group, ContentEntity content )
{
ContentAccessEntity access = new ContentAccessEntity();
access.setContent( content );
access.setGroup( group );
access.setReadAccess( accesses.contains( ContentAccessType.READ.toString().toLowerCase() ) );
access.setUpdateAccess( accesses.contains( ContentAccessType.UPDATE.toString().toLowerCase() ) );
access.setDeleteAccess( accesses.contains( ContentAccessType.DELETE.toString().toLowerCase() ) );
return access;
}
public ContentAccessEntity createContentAccess( ContentKey contentKey, GroupEntity group, String accesses )
{
ContentEntity content = fixture.findContentByKey( contentKey );
ContentAccessEntity access = new ContentAccessEntity();
access.setContent( content );
access.setGroup( group );
access.setReadAccess( accesses.contains( ContentAccessType.READ.toString().toLowerCase() ) );
access.setUpdateAccess( accesses.contains( ContentAccessType.UPDATE.toString().toLowerCase() ) );
access.setDeleteAccess( accesses.contains( ContentAccessType.DELETE.toString().toLowerCase() ) );
return access;
}
public ContentAccessEntity createContentAccess( ContentKey contentKey, UserEntity user, String accesses )
{
return createContentAccess( contentKey, user.getUserGroup(), accesses );
}
public SiteEntity createSite( String name, Date timestamp, Document xmlData, String language )
{
SiteEntity site = new SiteEntity();
site.setKey( mockKeyService.generateNextKeySafe( "TMENU" ) );
site.setName( name );
site.setTimestamp( timestamp );
site.setXmlData( xmlData );
site.setLanguage( fixture.findLanguageByCode( language ) );
return site;
}
public MenuItemEntity createSectionMenuItem( String name, Integer order, String menuName, String displayName, String site, String owner,
String modifier, String language, String parentName, Integer parentOrder,
boolean isOrderedSection, Date timestamp, boolean isHidden, Document xmlData )
{
MenuItemEntity menuItem = new MenuItemEntity();
menuItem.setKey( new MenuItemKey( mockKeyService.generateNextKeySafe( "TMENUITEM" ) ) );
menuItem.setName( name );
menuItem.setMenuName( menuName );
menuItem.setDisplayName( displayName );
menuItem.setSite( fixture.findSiteByName( site ) );
menuItem.setOrder( order );
menuItem.setOwner( fixture.findUserByName( owner ) );
menuItem.setModifier( fixture.findUserByName( modifier ) );
menuItem.setType( MenuItemType.SECTION );
menuItem.setSection( true );
menuItem.setOrderedSection( isOrderedSection );
menuItem.setLanguage( fixture.findLanguageByCode( language ) );
if ( parentName != null )
{
menuItem.setParent( fixture.findMenuItemByName( parentName ) );
}
menuItem.setTimestamp( timestamp == null ? new Date() : timestamp );
menuItem.setHidden( isHidden );
menuItem.setXmlData( xmlData );
return menuItem;
}
public MenuItemEntity createPageMenuItem( String name, Integer order, String menuName, String displayName, String site, String owner,
String modifier, boolean hasSection, Boolean isOrderedSection, String language,
String parentName, Integer parentOrder, Date timestamp, boolean isHidden, Document xmlData )
{
MenuItemEntity menuItem = new MenuItemEntity();
menuItem.setKey( new MenuItemKey( mockKeyService.generateNextKeySafe( "TMENUITEM" ) ) );
menuItem.setName( name );
menuItem.setOrder( order );
menuItem.setMenuName( menuName );
menuItem.setDisplayName( displayName );
menuItem.setSite( fixture.findSiteByName( site ) );
menuItem.setOwner( fixture.findUserByName( owner ) );
menuItem.setModifier( fixture.findUserByName( modifier ) );
menuItem.setType( MenuItemType.PAGE );
menuItem.setSection( hasSection );
menuItem.setOrderedSection( isOrderedSection );
menuItem.setLanguage( fixture.findLanguageByCode( language ) );
if ( parentName != null )
{
menuItem.setParent( fixture.findMenuItemByName( parentName ) );
}
menuItem.setTimestamp( timestamp == null ? new Date() : timestamp );
menuItem.setHidden( isHidden );
menuItem.setXmlData( xmlData );
return menuItem;
}
public ContentHomeEntity createContentHome( ContentEntity content, MenuItemEntity menuItem, PageTemplateEntity pageTemplate )
{
ContentHomeEntity contentHome = new ContentHomeEntity();
contentHome.setKey( new ContentHomeKey( menuItem.getSite().getKey(), content.getKey() ) );
contentHome.setContent( content );
contentHome.setMenuItem( menuItem );
contentHome.setSite( menuItem.getSite() );
contentHome.setPageTemplate( pageTemplate );
return contentHome;
}
public ContentBinaryDataEntity createContentBinaryData( String label, BinaryDataEntity binaryData, ContentVersionEntity contentVersion )
{
ContentBinaryDataEntity contentBinaryData = new ContentBinaryDataEntity();
contentBinaryData.setKey( new ContentBinaryDataKey( mockKeyService.generateNextKeySafe( "TCONTENTBINARYDATA" ) ) );
contentBinaryData.setLabel( label );
contentBinaryData.setContentVersion( contentVersion );
contentBinaryData.setBinaryData( binaryData );
return contentBinaryData;
}
public PageTemplateEntity createPageTemplate( String name, PageTemplateType type, String siteName, ResourceKey stylekey )
{
PageTemplateEntity pageTemplate = new PageTemplateEntity();
pageTemplate.setKey( mockKeyService.generateNextKeySafe( "TPAGETEMPLATE" ) );
pageTemplate.setName( name );
pageTemplate.setTimestamp( new Date() );
pageTemplate.setType( type );
pageTemplate.setSite( fixture.findSiteByName( siteName ) );
pageTemplate.setRunAs( RunAsType.DEFAULT_USER );
pageTemplate.setStyleKey( stylekey );
return pageTemplate;
}
int generateNextKeySafe( String tableName )
{
return mockKeyService.generateNextKeySafe( tableName );
}
}