Package org.craftercms.studio.impl.v2.repository.blob

Class BlobAwareContentRepository

java.lang.Object

org.craftercms.studio.impl.v2.repository.blob.BlobAwareContentRepository

All Implemented Interfaces:

ContentRepository, StudioBlobAwareContentRepository, ContentRepository

public class BlobAwareContentRepository
extends Object
implements ContentRepository, StudioBlobAwareContentRepository

Implementation of ContentRepository, ContentRepository that delegates calls to a StudioBlobStore when appropriate

Since:

3.1.6

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected StudioBlobStoreResolver	blobStoreResolver
protected String	fileExtension	The extension for the blob files
protected GitContentRepository	localRepositoryV1
protected ContentRepository	localRepositoryV2
protected final com.fasterxml.jackson.databind.ObjectMapper	objectMapper

Constructor Summary

Constructors

Constructor	Description
BlobAwareContentRepository()

Method Summary

Modifier and Type	Method	Description
boolean	addRemote(String siteId, String remoteName, String remoteUrl, String authenticationType, String remoteUsername, String remotePassword, String remoteToken, String remotePrivateKey)	Add remote repository for site content repository
void	cancelPublishAll(String siteId, String publishingTarget)	Performs the cleanup after a failed publish all operation for the given site & target
void	checkContentExists(String site, String path)	Checks if a content exists at a given path and throw an exception if it does not.
void	cleanupRepositories(String siteId)	Performs a cleanup all repositories for the given site
boolean	commitIdExists(String site, String commitId)	Check if given commit id exists
boolean	commitIdExists(String site, GitRepositories repoType, String commitId)	Check if given commit id (or revision string) exists
void	completePublishAll(String siteId, String publishingTarget, RepositoryChanges changes, String comment)	Performs the actual publish of all changes for the given site & target
boolean	contentExists(String site, String path)	Determine if content exists in the repository at a given path
String	copyContent(String site, String fromPath, String toPath)	copy content from PathA to pathB
int	countUnprocessedCommits(String siteId, long marker)	Count unprocessed commits from database
String	createFolder(String site, String path, String name)	create a folder
boolean	createSiteCloneRemote(String siteId, String sandboxBranch, String remoteName, String remoteUrl, String remoteBranch, boolean singleBranch, String authenticationType, String remoteUsername, String remotePassword, String remoteToken, String remotePrivateKey, Map<String,String> params, boolean createAsOrphan, String creator)	Create new site as a clone from remote repository
boolean	createSiteFromBlueprint(String blueprintLocation, String siteId, String sandboxBranch, Map<String,String> params, String creator)	Create a new site based on a blueprint
String	createVersion(String site, String path, boolean majorVersion)	create a version
String	createVersion(String site, String path, String comment, boolean majorVersion)	create a version
String	deleteContent(String site, String path, String approver)	delete content
void	deleteGitLogForSite(String siteId)	Delete Git log for site
boolean	deleteSite(String siteId)	Deletes an existing site.
void	duplicateBlobs(String sourceSiteId, String siteId)	Extract every blob from the source site and storeit in the target site in the blob store matching its path
void	duplicateSite(String sourceSiteId, String siteId, String sourceSandboxBranch, String sandboxBranch)	Create copies of the source site's repositories.
protected Collection<String>	findCompatiblePaths(org.craftercms.commons.file.blob.BlobStore blobStore, Collection<String> paths)
protected StudioBlobStore	getBlobStore(String site, String... paths)
Map<String,String>	getChangeSetPathsFromDelta(String site, String commitIdFrom, String commitIdTo)	Get a list of paths that changed since the commit ID provided to commit ID provided
InputStream	getContent(String site, String path, boolean shallow)	Get content from the repository
Optional<org.springframework.core.io.Resource>	getContentByCommitId(String site, String path, String commitId)	return a specific version of the content
RepositoryItem[]	getContentChildren(String site, String path)	get immediate children for path
List<ItemVersion>	getContentItemHistory(String site, String path)	Get the history of a content item.
long	getContentSize(String site, String path)	get file size
VersionTO[]	getContentVersionHistory(String site, String path)	get the version history for an item
List<String>	getEditCommitIds(String site, String path, String commitIdFrom, String commitIdTo)	Get a list of commits for updates on a content
GitLog	getGitLog(String siteId, String commitId)	Get git log object from database
org.craftercms.core.service.Item	getItem(String siteId, String path, boolean flatten)
DetailedItem.Environment	getItemEnvironmentProperties(String siteId, GitRepositories repo, String environment, String path)	Get environment properties for item
String	getLastEditCommitId(String siteId, String path)
List<RepoOperation>	getOperations(String site, String commitIdFrom, String commitIdTo)	Get a list of operations since the commit ID provided (compare that commit to HEAD)
List<RepoOperation>	getOperationsFromDelta(String site, String commitIdFrom, String commitIdTo)	Get a list of operations since the commit ID provided (compare that commit to HEAD)
protected String	getOriginalPath(String path)
protected String	getPathFromPointerPath(String siteId, String pointerPath)
protected String	getPointerPath(String siteId, String path)
String	getPreviousCommitId(String siteId, String commitId)	Get the previous commit id from repository for given a site id and a commit id
List<PublishingHistoryItem>	getPublishingHistory(String siteId, String environment, String path, String publisher, ZonedDateTime fromDate, ZonedDateTime toDate, int limit)	Get publishing history
String	getRepoFirstCommitId(String site)	Get first id from repository for given site
String	getRepoLastCommitId(String site)	Get last commit id from repository for given site.
protected String	getRepoPath(String blobPath)	Gets an asset path and translate it to the actual file path in git repo.
List<String>	getSubtreeItems(String site, String path, GitRepositories repoType, String branch)	List subtree items for give site and path
List<GitLog>	getUnauditedCommits(String siteId, int batchSize)	Get unaudited commits from database
List<GitLog>	getUnprocessedCommits(String siteId, long marker)	Get unprocessed commits from database
void	initialPublish(String siteId)	Execute initial publish for given site
void	initialPublish(String site, String sandboxBranch, String environment, String author, String comment)	Initial publish to specified environment.
void	insertFullGitLog(String siteId, int processed)	Insert Full Git Log
void	insertGitLog(String siteId, String commitId, int processed)	Insert Git Log
void	insertGitLog(String siteId, String commitId, int processed, int audited)	Insert Git Log
boolean	isFolder(String siteId, String path)	Check if content at given path is folder
void	itemUnlock(String site, String path)	unlock an item
List<RemoteRepositoryInfoTO>	listRemote(String siteId, String sandboxBranch)	List remote repositories for given site
void	lockItem(String site, String path)	lock an item NOTE: site will be removed from this interface
void	lockItemForPublishing(String site, String path)	lock an item NOTE: site will be removed from this interface
protected DeploymentItemTO	mapDeploymentItem(DeploymentItemTO item)
void	markGitLogAudited(String siteId, String commitId)	Mark Git log as audited
void	markGitLogProcessedBeforeMarker(String siteId, long marker, int processed)	Mark all git logs as processed if they are inserted before marker
void	markGitLogVerifiedProcessed(String siteId, String commitId)	Mark Git log as verified
void	markGitLogVerifiedProcessedBulk(String siteId, List<String> commitIds)	Mark Git logs as verified
Map<String,String>	moveContent(String site, String fromPath, String toPath, String newName)	move content from PathA to pathB
protected String	normalize(String path)
protected boolean	pointersExist(String siteId, String... paths)
void	populateGitLog(String siteId)	Populates the full git log of the sandbox repository into the database
RepositoryChanges	preparePublishAll(String siteId, String publishingTarget)	Prepares the repository to publish all changes for the given site & target
void	publish(String site, String sandboxBranch, List<DeploymentItemTO> deploymentItems, String environment, String author, String comment)	Publish content to specified environment.
RepositoryChanges	publishAll(String siteId, String publishingTarget, String comment)	Publishes all changes for the given site & target
boolean	publishedRepositoryExists(String siteId)	Check if published repository exists for given site.
boolean	pullFromRemote(String siteId, String remoteName, String remoteBranch)	Pull from remote repository
boolean	pushToRemote(String siteId, String remoteName, String remoteBranch)	Push content to remote repository
boolean	removeRemote(String siteId, String remoteName)	Remove remote with given name for site
void	removeRemoteRepositoriesForSite(String siteId)	Remove all remotes for given site
boolean	repositoryExists(String site)	Check if repository exists for given site
void	resetStagingRepository(String siteId)	Reset staging repository to live for given site
String	revertContent(String site, String path, String version, boolean major, String comment)	revert a version (create a new version based on an old version)
void	setBlobStoreResolver(StudioBlobStoreResolver blobStoreResolver)
void	setFileExtension(String fileExtension)
void	setLocalRepositoryV1(GitContentRepository localRepositoryV1)
void	setLocalRepositoryV2(ContentRepository localRepositoryV2)
void	setServicesConfig(ServicesConfig servicesConfig)
boolean	shallowContentExists(String site, String path)	This is a faster, but less accurate, version of contentExists.
protected Collection<String>	translatePaths(Collection<String> paths)
void	unLockItem(String site, String path)	unlock an item for publishing NOTE: site will be removed from this interface
void	unLockItemForPublishing(String site, String path)	unlock an item for publishing NOTE: site will be removed from this interface
void	updateGitlog(String siteId, String lastProcessedCommitId, int batchSize)	Update gitlog table with commit ids from repository
void	upsertGitLogList(String siteId, List<String> commitIds, boolean processed, boolean audited)	Upsert git logs as processed and audited
String	writeContent(String site, String path, InputStream content)	write content

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.craftercms.studio.api.v1.repository.ContentRepository

getContent, moveContent

Methods inherited from interface org.craftercms.studio.api.v2.repository.ContentRepository

getItemPaths, getSubtreeItems

Field Details

fileExtension

protected String fileExtension

The extension for the blob files

localRepositoryV1

protected GitContentRepository localRepositoryV1

localRepositoryV2

protected ContentRepository localRepositoryV2

blobStoreResolver

protected StudioBlobStoreResolver blobStoreResolver

objectMapper

protected final com.fasterxml.jackson.databind.ObjectMapper objectMapper

Constructor Details

BlobAwareContentRepository

public BlobAwareContentRepository()

Method Details

setServicesConfig

public void setServicesConfig(ServicesConfig servicesConfig)

setFileExtension

public void setFileExtension(String fileExtension)

setLocalRepositoryV1

public void setLocalRepositoryV1(GitContentRepository localRepositoryV1)

setLocalRepositoryV2

public void setLocalRepositoryV2(ContentRepository localRepositoryV2)

setBlobStoreResolver

public void setBlobStoreResolver(StudioBlobStoreResolver blobStoreResolver)

getOriginalPath

protected String getOriginalPath(String path)

getPointerPath

protected String getPointerPath(String siteId,
 String path)

getPathFromPointerPath

protected String getPathFromPointerPath(String siteId,
 String pointerPath)

normalize

protected String normalize(String path)

getBlobStore

protected StudioBlobStore getBlobStore(String site,
 String... paths)
                                throws ServiceLayerException

Throws:

ServiceLayerException

pointersExist

protected boolean pointersExist(String siteId,
 String... paths)

contentExists

public boolean contentExists(String site,
 String path)

Description copied from interface: ContentRepository

Determine if content exists in the repository at a given path

Specified by:

contentExists in interface ContentRepository

Specified by:

contentExists in interface ContentRepository

Parameters:

site - site id where the operation will be executed

path - path to check if content exists

Returns:

true if site has content object at path

checkContentExists

public void checkContentExists(String site,
 String path)
                        throws ServiceLayerException

Description copied from interface: ContentRepository

Checks if a content exists at a given path and throw an exception if it does not.

Specified by:

checkContentExists in interface ContentRepository

Parameters:

site - id of the site

path - the content path

Throws:

ServiceLayerException - if no content is found at the given path

shallowContentExists

public boolean shallowContentExists(String site,
 String path)

Description copied from interface: ContentRepository

This is a faster, but less accurate, version of contentExists. This prioritizes performance over checking the actual underlying repository if the content is actually in the store or we simply hold a reference to the object in the actual store.

Specified by:

shallowContentExists in interface ContentRepository

Specified by:

shallowContentExists in interface ContentRepository

Returns:

true if site has content object at path

getContent

public InputStream getContent(String site,
 String path,
 boolean shallow)

Description copied from interface: ContentRepository

Get content from the repository

Specified by:

getContent in interface ContentRepository

Parameters:

site - the site id

path - the path of the content

shallow - if true, it will load the file from disk directly, instead of retrieving it from git repository

Returns:

InputStream to read the content

getContentSize

public long getContentSize(String site,
 String path)

Description copied from interface: ContentRepository

get file size

Specified by:

getContentSize in interface ContentRepository

Parameters:

site - site id where the operation will be executed

path - path to content

Returns:

Size in bytes

writeContent

public String writeContent(String site,
 String path,
 InputStream content)
                    throws ServiceLayerException

Description copied from interface: ContentRepository

write content

Specified by:

writeContent in interface ContentRepository

Parameters:

site - site id where the operation will be executed

path - path to content

content - stream of content to write

Returns:

Commit Id if successful, null otherwise

Throws:

ServiceLayerException - if error happens during write

createFolder

public String createFolder(String site,
 String path,
 String name)

Description copied from interface: ContentRepository

create a folder

Specified by:

createFolder in interface ContentRepository

Parameters:

site - site id where the operation will be executed

path - path to create a folder in

name - a folder name to create

Returns:

Commit Id if successful, null otherwise

deleteContent

public String deleteContent(String site,
 String path,
 String approver)
                     throws ServiceLayerException

Description copied from interface: ContentRepository

delete content

Specified by:

deleteContent in interface ContentRepository

Parameters:

site - site id where the operation will be executed

path - path to content

approver - user that approves delete content

Returns:

Commit ID if successful, null otherwise

Throws:

ServiceLayerException

moveContent

public Map<String,String> moveContent(String site,
 String fromPath,
 String toPath,
 String newName)

Description copied from interface: ContentRepository

move content from PathA to pathB

Specified by:

moveContent in interface ContentRepository

Parameters:

site - site id where the operation will be executed

fromPath - source content

toPath - target path

newName - new file name for rename

Returns:

Commit ID if successful, empty string otherwise

copyContent

public String copyContent(String site,
 String fromPath,
 String toPath)

Description copied from interface: ContentRepository

copy content from PathA to pathB

Specified by:

copyContent in interface ContentRepository

Parameters:

site - site id where the operation will be executed

fromPath - paths to content

toPath - target path

Returns:

Commit ID if successful, empty string otherwise

getContentChildren

public RepositoryItem[] getContentChildren(String site,
 String path)

Description copied from interface: ContentRepository

get immediate children for path

Specified by:

getContentChildren in interface ContentRepository

Parameters:

site - site id where the operation will be executed

path - path to content

Returns:

a list of children

getContentVersionHistory

public VersionTO[] getContentVersionHistory(String site,
 String path)

Description copied from interface: ContentRepository

get the version history for an item

Specified by:

getContentVersionHistory in interface ContentRepository

Parameters:

site - - the project ID

path - - the path of the item

Returns:

a list of versions

getContentItemHistory

public List<ItemVersion> getContentItemHistory(String site,
 String path)

Description copied from interface: ContentRepository

Get the history of a content item.
Note: the results of this method are not guaranteed when the path does not currently exist in the repository.

Specified by:

getContentItemHistory in interface ContentRepository

Parameters:

site - site id

path - path of the content item

Returns:

list of item versions

duplicateSite

public void duplicateSite(String sourceSiteId,
 String siteId,
 String sourceSandboxBranch,
 String sandboxBranch)
                   throws IOException,
ServiceLayerException

Description copied from interface: ContentRepository

Create copies of the source site's repositories. This method will copy sandbox and published (if exists) repositories under a new directory with the new site id. For sandbox repository, a new branch will be created (from the currently checked-out branch) with the given sandbox branch name if it does not exist.

Specified by:

duplicateSite in interface ContentRepository

Parameters:

sourceSiteId - source site id

siteId - new site id

sandboxBranch - sandbox branch name

Throws:

IOException - if there is any error while copying the directories

ServiceLayerException

duplicateBlobs

public void duplicateBlobs(String sourceSiteId,
 String siteId)
                    throws ServiceLayerException

Description copied from interface: StudioBlobAwareContentRepository

Extract every blob from the source site and storeit in the target site in the blob store matching its path

Specified by:

duplicateBlobs in interface StudioBlobAwareContentRepository

Parameters:

sourceSiteId - the source site

siteId - the target site

Throws:

ServiceLayerException - if an error occurs during the operation

createVersion

public String createVersion(String site,
 String path,
 boolean majorVersion)

Description copied from interface: ContentRepository

create a version

Specified by:

createVersion in interface ContentRepository

Parameters:

site - site id where the operation will be executed

path - location of content

majorVersion - true if major

Returns:

the created version ID or null on failure

createVersion

public String createVersion(String site,
 String path,
 String comment,
 boolean majorVersion)

Description copied from interface: ContentRepository

create a version

Specified by:

createVersion in interface ContentRepository

Parameters:

site - site id where the operation will be executed

path - location of content

comment - version history comment

majorVersion - true if major

Returns:

the created version ID or null on failure

revertContent

public String revertContent(String site,
 String path,
 String version,
 boolean major,
 String comment)

Description copied from interface: ContentRepository

revert a version (create a new version based on an old version)

Specified by:

revertContent in interface ContentRepository

Parameters:

site - site id where the operation will be executed

path - - the path of the item to "revert"

version - - old version ID to base to version on

major - flag if it is major version

comment - add comment when committing content

Returns:

Commit ID if successful, empty string otherwise

getContentByCommitId

public Optional<org.springframework.core.io.Resource> getContentByCommitId(String site,
 String path,
 String commitId)

Description copied from interface: ContentRepository

return a specific version of the content

Specified by:

getContentByCommitId in interface ContentRepository

Parameters:

site - site id where the operation will be executed

path - path of the content

commitId - version to return

Returns:

the resource if available

lockItem

public void lockItem(String site,
 String path)

Description copied from interface: ContentRepository

lock an item NOTE: site will be removed from this interface

Specified by:

lockItem in interface ContentRepository

Parameters:

site - site id where the operation will be executed

path - path of the item

lockItemForPublishing

public void lockItemForPublishing(String site,
 String path)

Description copied from interface: ContentRepository

lock an item NOTE: site will be removed from this interface

Specified by:

lockItemForPublishing in interface ContentRepository

Parameters:

site - site id where the operation will be executed

path - path of the item

unLockItem

public void unLockItem(String site,
 String path)

Description copied from interface: ContentRepository

unlock an item for publishing NOTE: site will be removed from this interface

Specified by:

unLockItem in interface ContentRepository

Parameters:

site - site id where the operation will be executed

path - path of the item

unLockItemForPublishing

public void unLockItemForPublishing(String site,
 String path)

Description copied from interface: ContentRepository

unlock an item for publishing NOTE: site will be removed from this interface

Specified by:

unLockItemForPublishing in interface ContentRepository

Parameters:

site - site id where the operation will be executed

path - path of the item

isFolder

public boolean isFolder(String siteId,
 String path)

Description copied from interface: ContentRepository

Check if content at given path is folder

Specified by:

isFolder in interface ContentRepository

Parameters:

siteId - site identifier

path - content path

Returns:

true if path is folder, otherwise false

deleteSite

public boolean deleteSite(String siteId)

Description copied from interface: ContentRepository

Deletes an existing site.

Specified by:

deleteSite in interface ContentRepository

Parameters:

siteId - site to delete

Returns:

true if successful, false otherwise

initialPublish

public void initialPublish(String site,
 String sandboxBranch,
 String environment,
 String author,
 String comment)
                    throws DeploymentException

Description copied from interface: ContentRepository

Initial publish to specified environment.

Specified by:

initialPublish in interface ContentRepository

Parameters:

site - site identifier

sandboxBranch - sandbox branch name

environment - environment to publish

author - author

comment - comment

Throws:

DeploymentException - deployment error

mapDeploymentItem

protected DeploymentItemTO mapDeploymentItem(DeploymentItemTO item)

getRepoLastCommitId

public String getRepoLastCommitId(String site)

Description copied from interface: ContentRepository

Get last commit id from repository for given site.

Specified by:

getRepoLastCommitId in interface ContentRepository

Specified by:

getRepoLastCommitId in interface ContentRepository

Parameters:

site - site id

Returns:

last commit id (current HEAD)

getRepoFirstCommitId

public String getRepoFirstCommitId(String site)

Description copied from interface: ContentRepository

Get first id from repository for given site

Specified by:

getRepoFirstCommitId in interface ContentRepository

Specified by:

getRepoFirstCommitId in interface ContentRepository

Parameters:

site - site id

Returns:

first commit id

getEditCommitIds

public List<String> getEditCommitIds(String site,
 String path,
 String commitIdFrom,
 String commitIdTo)

Description copied from interface: ContentRepository

Get a list of commits for updates on a content

Specified by:

getEditCommitIds in interface ContentRepository

Parameters:

site - site id

path - path

commitIdFrom - range from commit id (inclusive)

commitIdTo - range to commit id (inclusive)

Returns:

list of edit commit ids

insertFullGitLog

public void insertFullGitLog(String siteId,
 int processed)

Description copied from interface: ContentRepository

Insert Full Git Log

Specified by:

insertFullGitLog in interface ContentRepository

Parameters:

siteId - site

processed - processed

deleteGitLogForSite

public void deleteGitLogForSite(String siteId)

Description copied from interface: ContentRepository

Delete Git log for site

Specified by:

deleteGitLogForSite in interface ContentRepository

Parameters:

siteId - site identifier

addRemote

public boolean addRemote(String siteId,
 String remoteName,
 String remoteUrl,
 String authenticationType,
 String remoteUsername,
 String remotePassword,
 String remoteToken,
 String remotePrivateKey)
                  throws InvalidRemoteUrlException,
ServiceLayerException

Description copied from interface: ContentRepository

Add remote repository for site content repository

Specified by:

addRemote in interface ContentRepository

Parameters:

siteId - site identifier

remoteName - remote name

remoteUrl - remote url

authenticationType - authentication type

remoteUsername - remote username

remotePassword - remote password

remoteToken - remote token

remotePrivateKey - remote private key

Returns:

true if operation was successful

Throws:

InvalidRemoteUrlException - invalid url for remote repository

ServiceLayerException - general service error

removeRemoteRepositoriesForSite

public void removeRemoteRepositoriesForSite(String siteId)

Description copied from interface: ContentRepository

Remove all remotes for given site

Specified by:

removeRemoteRepositoriesForSite in interface ContentRepository

Parameters:

siteId - site identifier

listRemote

public List<RemoteRepositoryInfoTO> listRemote(String siteId,
 String sandboxBranch)
                                        throws ServiceLayerException

Description copied from interface: ContentRepository

List remote repositories for given site

Specified by:

listRemote in interface ContentRepository

Parameters:

siteId - site identifier

sandboxBranch - sandbox branch name

Returns:

list of names of remote repositories

Throws:

ServiceLayerException - general service error

pushToRemote

public boolean pushToRemote(String siteId,
 String remoteName,
 String remoteBranch)
                     throws ServiceLayerException,
InvalidRemoteUrlException

Description copied from interface: ContentRepository

Push content to remote repository

Specified by:

pushToRemote in interface ContentRepository

Parameters:

siteId - site identifier

remoteName - remote name

remoteBranch - remote branch

Returns:

true if operation was successful

Throws:

ServiceLayerException - general service error

InvalidRemoteUrlException - invalid url for remote repository

pullFromRemote

public boolean pullFromRemote(String siteId,
 String remoteName,
 String remoteBranch)
                       throws ServiceLayerException,
InvalidRemoteUrlException

Description copied from interface: ContentRepository

Pull from remote repository

Specified by:

pullFromRemote in interface ContentRepository

Parameters:

siteId - site identifier

remoteName - remote name

remoteBranch - remote branch

Returns:

true if operation was successful

Throws:

ServiceLayerException - general service error

InvalidRemoteUrlException - invalid url for remote repository

resetStagingRepository

public void resetStagingRepository(String siteId)
                            throws ServiceLayerException

Description copied from interface: ContentRepository

Reset staging repository to live for given site

Specified by:

resetStagingRepository in interface ContentRepository

Parameters:

siteId - site identifier to use for resetting

Throws:

ServiceLayerException - general service error

cleanupRepositories

public void cleanupRepositories(String siteId)

Description copied from interface: ContentRepository

Performs a cleanup all repositories for the given site

Specified by:

cleanupRepositories in interface ContentRepository

Parameters:

siteId - site identifier

createSiteFromBlueprint

public boolean createSiteFromBlueprint(String blueprintLocation,
 String siteId,
 String sandboxBranch,
 Map<String,String> params,
 String creator)

Description copied from interface: ContentRepository

Create a new site based on a blueprint

Specified by:

createSiteFromBlueprint in interface ContentRepository

Parameters:

blueprintLocation - blueprint location

siteId - site identifier

sandboxBranch - sandbox branch name

params - site parameters

creator - site creator

Returns:

true if successful, false otherwise

publish

public void publish(String site,
 String sandboxBranch,
 List<DeploymentItemTO> deploymentItems,
 String environment,
 String author,
 String comment)
             throws DeploymentException

Description copied from interface: ContentRepository

Publish content to specified environment.

Specified by:

publish in interface ContentRepository

Parameters:

site - site identifier

sandboxBranch - sandbox branch name

deploymentItems - items to be published

environment - environment to publish to

author - author

comment - submission comment

Throws:

DeploymentException - deployment error

commitIdExists

public boolean commitIdExists(String site,
 String commitId)

Description copied from interface: ContentRepository

Check if given commit id exists

Specified by:

commitIdExists in interface ContentRepository

Parameters:

site - site id

commitId - commit id to check

Returns:

true if it exists in site repository, otherwise false

commitIdExists

public boolean commitIdExists(String site,
 GitRepositories repoType,
 String commitId)

Description copied from interface: ContentRepository

Check if given commit id (or revision string) exists

Specified by:

commitIdExists in interface ContentRepository

Parameters:

site - site id

repoType - repository type

commitId - commit id or revision to check

Returns:

true if it exists in site repository, otherwise false

createSiteCloneRemote

public boolean createSiteCloneRemote(String siteId,
 String sandboxBranch,
 String remoteName,
 String remoteUrl,
 String remoteBranch,
 boolean singleBranch,
 String authenticationType,
 String remoteUsername,
 String remotePassword,
 String remoteToken,
 String remotePrivateKey,
 Map<String,String> params,
 boolean createAsOrphan,
 String creator)
                              throws InvalidRemoteRepositoryException,
InvalidRemoteRepositoryCredentialsException,
RemoteRepositoryNotFoundException,
ServiceLayerException

Description copied from interface: ContentRepository

Create new site as a clone from remote repository

Specified by:

createSiteCloneRemote in interface ContentRepository

Parameters:

siteId - site identifier

sandboxBranch - sandbox branch name

remoteName - remote name

remoteUrl - remote repository url

remoteBranch - remote branch name

singleBranch - flag to signal if clone single branch or full repository

authenticationType - type of authentication to use to connect remote repository

remoteUsername - remote username

remotePassword - remote password

remoteToken - remote token

remotePrivateKey - remote private key

params - site parameters

createAsOrphan - create as orphan

creator - site creator

Returns:

true if success

Throws:

InvalidRemoteRepositoryException - invalid remote repository

InvalidRemoteRepositoryCredentialsException - invalid credentials for remote repository

RemoteRepositoryNotFoundException - remote repository not found

ServiceLayerException - general service error

removeRemote

public boolean removeRemote(String siteId,
 String remoteName)

Description copied from interface: ContentRepository

Remove remote with given name for site

Specified by:

removeRemote in interface ContentRepository

Parameters:

siteId - site identifier

remoteName - remote name

Returns:

true if operation was successful

repositoryExists

public boolean repositoryExists(String site)

Description copied from interface: ContentRepository

Check if repository exists for given site

Specified by:

repositoryExists in interface ContentRepository

Parameters:

site - site id

Returns:

true if repository exists, otherwise false

getGitLog

public GitLog getGitLog(String siteId,
 String commitId)

Description copied from interface: ContentRepository

Get git log object from database

Specified by:

getGitLog in interface ContentRepository

Parameters:

siteId - site id

commitId - commit ID

Returns:

git log object

markGitLogVerifiedProcessed

public void markGitLogVerifiedProcessed(String siteId,
 String commitId)

Description copied from interface: ContentRepository

Mark Git log as verified

Specified by:

markGitLogVerifiedProcessed in interface ContentRepository

Parameters:

siteId - site identifier

commitId - commit id

insertGitLog

public void insertGitLog(String siteId,
 String commitId,
 int processed)

Description copied from interface: ContentRepository

Insert Git Log

Specified by:

insertGitLog in interface ContentRepository

Parameters:

siteId - site

commitId - commit ID

processed - processed

insertGitLog

public void insertGitLog(String siteId,
 String commitId,
 int processed,
 int audited)

Description copied from interface: ContentRepository

Insert Git Log

Specified by:

insertGitLog in interface ContentRepository

Parameters:

siteId - site

commitId - commit ID

processed - processed

audited - audited

getSubtreeItems

public List<String> getSubtreeItems(String site,
 String path,
 GitRepositories repoType,
 String branch)

Description copied from interface: ContentRepository

List subtree items for give site and path

Specified by:

getSubtreeItems in interface ContentRepository

Parameters:

site - site identifier

path - path for subtree root

repoType - repository type

branch - A git object references expression (e.g.: HEAD, branch name, commit id)

Returns:

list of item paths contained in the subtree

getOperations

public List<RepoOperation> getOperations(String site,
 String commitIdFrom,
 String commitIdTo)

Description copied from interface: ContentRepository

Get a list of operations since the commit ID provided (compare that commit to HEAD)

Specified by:

getOperations in interface ContentRepository

Parameters:

site - site to use

commitIdFrom - commit ID to start at

commitIdTo - commit ID to end at

Returns:

commit ID of current HEAD, updated operationsSinceCommit

getOperationsFromDelta

public List<RepoOperation> getOperationsFromDelta(String site,
 String commitIdFrom,
 String commitIdTo)

Description copied from interface: ContentRepository

Get a list of operations since the commit ID provided (compare that commit to HEAD)

Specified by:

getOperationsFromDelta in interface ContentRepository

Parameters:

site - site to use

commitIdFrom - commit ID to start at

commitIdTo - commit ID to end at

Returns:

commit ID of current HEAD, updated operationsSinceCommit

getPublishingHistory

public List<PublishingHistoryItem> getPublishingHistory(String siteId,
 String environment,
 String path,
 String publisher,
 ZonedDateTime fromDate,
 ZonedDateTime toDate,
 int limit)

Description copied from interface: ContentRepository

Get publishing history

Specified by:

getPublishingHistory in interface ContentRepository

Parameters:

siteId - site identifier

environment - environment

path - path regular expression to use as filter

publisher - user to filter by

fromDate - lower boundary for published date

toDate - upper boundary for published date

limit - number of records to return

Returns:

publishing history

getItem

public org.craftercms.core.service.Item getItem(String siteId,
 String path,
 boolean flatten)

Specified by:

getItem in interface ContentRepository

getLastEditCommitId

public String getLastEditCommitId(String siteId,
 String path)

Specified by:

getLastEditCommitId in interface ContentRepository

getChangeSetPathsFromDelta

public Map<String,String> getChangeSetPathsFromDelta(String site,
 String commitIdFrom,
 String commitIdTo)

Description copied from interface: ContentRepository

Get a list of paths that changed since the commit ID provided to commit ID provided

Specified by:

getChangeSetPathsFromDelta in interface ContentRepository

Parameters:

site - site to use

commitIdFrom - commit ID to start at

commitIdTo - commit ID to end at

Returns:

list of paths of files that changed between two commits

markGitLogAudited

public void markGitLogAudited(String siteId,
 String commitId)

Description copied from interface: ContentRepository

Mark Git log as audited

Specified by:

markGitLogAudited in interface ContentRepository

Parameters:

siteId - site identifier

commitId - commit id

updateGitlog

public void updateGitlog(String siteId,
 String lastProcessedCommitId,
 int batchSize)

Description copied from interface: ContentRepository

Update gitlog table with commit ids from repository

Specified by:

updateGitlog in interface ContentRepository

Parameters:

siteId - site identifier

lastProcessedCommitId - last processed commit id

batchSize - size of a batch to update

getUnauditedCommits

public List<GitLog> getUnauditedCommits(String siteId,
 int batchSize)

Description copied from interface: ContentRepository

Get unaudited commits from database

Specified by:

getUnauditedCommits in interface ContentRepository

Parameters:

siteId - site identifier

batchSize - size of a batch to retrieve

Returns:

list of gitlog records

getUnprocessedCommits

public List<GitLog> getUnprocessedCommits(String siteId,
 long marker)

Description copied from interface: ContentRepository

Get unprocessed commits from database

Specified by:

getUnprocessedCommits in interface ContentRepository

Parameters:

siteId - site identifier

marker - id of last verified commit Id

Returns:

list of gitlog records

getItemEnvironmentProperties

public DetailedItem.Environment getItemEnvironmentProperties(String siteId,
 GitRepositories repo,
 String environment,
 String path)

Description copied from interface: ContentRepository

Get environment properties for item

Specified by:

getItemEnvironmentProperties in interface ContentRepository

Parameters:

siteId - site identifier

repo - repository type

environment - branch

path - path of the item

Returns:

environment properties

countUnprocessedCommits

public int countUnprocessedCommits(String siteId,
 long marker)

Description copied from interface: ContentRepository

Count unprocessed commits from database

Specified by:

countUnprocessedCommits in interface ContentRepository

Parameters:

siteId - site identifier

marker - id of last verified commit Id

Returns:

number of unprocessed gitlog records

markGitLogProcessedBeforeMarker

public void markGitLogProcessedBeforeMarker(String siteId,
 long marker,
 int processed)

Description copied from interface: ContentRepository

Mark all git logs as processed if they are inserted before marker

Specified by:

markGitLogProcessedBeforeMarker in interface ContentRepository

Parameters:

siteId - site identifier

marker - marker git commit

processed - value for processed

getPreviousCommitId

public String getPreviousCommitId(String siteId,
 String commitId)

Description copied from interface: ContentRepository

Get the previous commit id from repository for given a site id and a commit id

Specified by:

getPreviousCommitId in interface ContentRepository

Parameters:

siteId - site identifier

commitId - commit Id

Returns:

itemUnlock

public void itemUnlock(String site,
 String path)

Description copied from interface: ContentRepository

unlock an item

Specified by:

itemUnlock in interface ContentRepository

Parameters:

site - site id where the operation will be executed

path - path of the item

markGitLogVerifiedProcessedBulk

public void markGitLogVerifiedProcessedBulk(String siteId,
 List<String> commitIds)

Description copied from interface: ContentRepository

Mark Git logs as verified

Specified by:

markGitLogVerifiedProcessedBulk in interface ContentRepository

Parameters:

siteId - site identifier

commitIds - list of commit ids

upsertGitLogList

public void upsertGitLogList(String siteId,
 List<String> commitIds,
 boolean processed,
 boolean audited)

Description copied from interface: ContentRepository

Upsert git logs as processed and audited

Specified by:

upsertGitLogList in interface ContentRepository

Parameters:

siteId - site identifier

commitIds - commit ids

processed - true if already processed

audited - true if already audited

publishedRepositoryExists

public boolean publishedRepositoryExists(String siteId)

Description copied from interface: ContentRepository

Check if published repository exists for given site.

Specified by:

publishedRepositoryExists in interface ContentRepository

Parameters:

siteId - site identifier

Returns:

true if PUBLISHED repository exists, otherwise false

initialPublish

public void initialPublish(String siteId)
                    throws SiteNotFoundException

Description copied from interface: ContentRepository

Execute initial publish for given site

Specified by:

initialPublish in interface ContentRepository

Parameters:

siteId - site identifier

Throws:

SiteNotFoundException

publishAll

public RepositoryChanges publishAll(String siteId,
 String publishingTarget,
 String comment)
                             throws ServiceLayerException

Description copied from interface: ContentRepository

Publishes all changes for the given site & target

Specified by:

publishAll in interface ContentRepository

Parameters:

siteId - the id of the site

publishingTarget - the publishing target

comment - submission comment

Throws:

ServiceLayerException

getRepoPath

protected String getRepoPath(String blobPath)

Gets an asset path and translate it to the actual file path in git repo. e.g.: /static-assets/test/my-image.png to static-assets/test/my-image.png.blob

Parameters:

blobPath - the asset path

Returns:

the git repo path

translatePaths

protected Collection<String> translatePaths(Collection<String> paths)

findCompatiblePaths

protected Collection<String> findCompatiblePaths(org.craftercms.commons.file.blob.BlobStore blobStore,
 Collection<String> paths)

preparePublishAll

public RepositoryChanges preparePublishAll(String siteId,
 String publishingTarget)

Description copied from interface: ContentRepository

Prepares the repository to publish all changes for the given site & target

Specified by:

preparePublishAll in interface ContentRepository

Parameters:

siteId - the id of the site

publishingTarget - the publishing target

Returns:

the set of changed files

completePublishAll

public void completePublishAll(String siteId,
 String publishingTarget,
 RepositoryChanges changes,
 String comment)

Description copied from interface: ContentRepository

Performs the actual publish of all changes for the given site & target

Specified by:

completePublishAll in interface ContentRepository

Parameters:

siteId - the id of the site

publishingTarget - the publishing target

changes - the set of changed files

comment - submission comment

cancelPublishAll

public void cancelPublishAll(String siteId,
 String publishingTarget)

Description copied from interface: ContentRepository

Performs the cleanup after a failed publish all operation for the given site & target

Specified by:

cancelPublishAll in interface ContentRepository

Parameters:

siteId - the id of the site

publishingTarget - the publishing target

populateGitLog

public void populateGitLog(String siteId)
                    throws org.eclipse.jgit.api.errors.GitAPIException,
IOException

Description copied from interface: ContentRepository

Populates the full git log of the sandbox repository into the database

Specified by:

populateGitLog in interface ContentRepository

Parameters:

siteId - the id of the site

Throws:

org.eclipse.jgit.api.errors.GitAPIException - if there is any error reading the git log

IOException - if there is any error executing the db script