# $Id: svn-package.mk,v 1.14 2010/03/27 13:10:37 obache Exp $
#
# Please update cvs-package.mk as well. It is brother Makefile frags.
#
# This file provides simple access to Subversion repositories, so that packages
# can be created from Subversion instead of from released tarballs. Whenever a
# package is fetched from Subversion, an archive is created from it and saved
# in ${DISTDIR}/svn-packages, to save bandwidth.
#
# === User-settable variables ===
#
# CHECKOUT_DATE
#	Date to check out in ISO format (YYYY-MM-DD).
#
# === Package-settable variables ===
#
# A package using this file shall define the following variables:
#
# SVN_REPOSITORIES
#	A list of unique identifiers. For each of those identifiers, the
#	following variables define the details of how to access the
#	Subversion repository.
#
#	SVN_ROOT must be defined.
#
# SVN_ROOT.${id}
#	The SVNROOT for the SVN repository, including anonsvn password,
#	if applicable.
#
# SVN_MODULE.${id}
#	The SVN module to check out.
#
#	Default value: ${id}
#
# SVN_DISTBASE.${id}
#	The prefix for cached archive file name.
#
#	Default value: ${PKGBASE}-${SVN_MODULE.${repo}}
#
# It may define the following variables:
#
# SVN_CERTS
#	Files holding SSL certificates of the svn servers.
#
# SVN_TAG.${id}
#	Overridable SVN tag for a repository.
#
#	Default: ${SVN_TAG} (today at midnight)
#
# SVN_TAG
#	The default SVN tag that is checked out. May be overridden by
#	SVN_TAG.${id}.
#
#	Default value: today at midnight.
#
# === Variables defined here ===
#
# This file defines the following variables:
#
# SVN_ROOT_SOURCEFORGE
#	Common SVN repository locations for use in the SVN_ROOT
#	variables.
#
# It also provides default values for the following variables, differing
# from the system-wide defaults:
#
# DISTFILES
#	Is set to an empty list, since that is the right choice for most
#	of the Subversion packages.
#
#
# PKGREVISION
#	If PKGREVISION is not set, set it to today's date.  This is
#	useful for packages that automatically grab the latest code
#	from subversion every time they are built.
#	TODO: Reconsider this, and instead use the subversion revision
#	number in the package version somehow.
#
# Keywords: subversion
#

.if !defined(_PKG_MK_SVN_PACKAGE_MK)
_PKG_MK_SVN_PACKAGE_MK=	# defined

BUILD_DEPENDS+=		subversion-base>=1.0:../../devel/subversion-base

#
# defaults for user-visible input variables
#

DISTFILES?=		# empty
PKGNAME?=		${DISTNAME:C,-[0-9].*,,}-svn-${_SVN_PKGVERSION}
# Enforce PKGREVISION unless SVN_TAG is set
.if empty(SVN_TAG)
. if defined(CHECKOUT_DATE)
PKGREVISION?=		$(CHECKOUT_DATE:S/-//g)
. else
PKGREVISION?=		$(_SVN_PKGVERSION:S/.//g)
. endif
.endif

#
# definition of user-visible output variables
#

# commonly used repositories
SVN_ROOT_SOURCEFORGE=	https://svn.sourceforge.net/svnroot

#
# End of the interface part. Start of the implementation part.
#

#
# Input validation
#

.if !defined(SVN_REPOSITORIES)
PKG_FAIL_REASON+=	"[svn-package.mk] SVN_REPOSITORIES must be set."
SVN_REPOSITORIES?=	# none
.endif

.for repo in ${SVN_REPOSITORIES}
.  if !defined(SVN_ROOT.${repo})
PKG_FAIL_REASON+=	"[svn-package.mk] SVN_ROOT."${repo:Q}" must be set."
.  endif
.endfor

#
# Internal variables
#

USE_TOOLS+=		date pax

_SVN_RSH=		ssh
_SVN_CMD=		svn
_SVN_ENV=		# empty
_SVN_ENV+=		SVN_RSH=${_SVN_RSH:Q}
_SVN_FLAGS=		
_SVN_CHECKOUT_FLAGS=	--config-dir=${_SVN_CONFIG_DIR} --non-interactive
_SVN_CONFIG_DIR=	${WRKDIR}/.subversion
_SVN_TODAY_CMD=		${DATE} -u +'%Y-%m-%d'
_SVN_TODAY=		${_SVN_TODAY_CMD:sh}
_SVN_PKGVERSION_CMD=	${DATE} -u +'%Y.%m.%d'
_SVN_PKGVERSION=	${_SVN_PKGVERSION_CMD:sh}
_SVN_DISTDIR=		${DISTDIR}/svn-packages

# Generation of repository-specific variables
#

# determine appropriate checkout date or tag
.for repo in ${SVN_REPOSITORIES}
SVN_MODULE.${repo}?=	${repo}
.  if defined(SVN_TAG.${repo})
_SVN_TAG_FLAG.${repo}=	-r${SVN_TAG.${repo}}
_SVN_TAG.${repo}=	${SVN_TAG.${repo}}
.  elif defined(SVN_TAG)
_SVN_TAG_FLAG.${repo}=	-r${SVN_TAG}
_SVN_TAG.${repo}=	${SVN_TAG}
.  elif defined(CHECKOUT_DATE)
_SVN_TAG_FLAG.${repo}=	-r{${CHECKOUT_DATE}}
_SVN_TAG.${repo}=	{${CHECKOUT_DATE}}
.  else
_SVN_TAG_FLAG.${repo}=	-r{${_SVN_TODAY} 00:00 +0000}
_SVN_TAG.${repo}=	${_SVN_TODAY}
.  endif

_SVN_TMP_RESULT.${repo}=	'/tmp/svn-${SVN_MODULE.${repo}}-update'

# Cache support:
.  if !defined(NO_SVN_CACHE.${repo}) \
   || defined(NO_SVN_CACHE.${repo}) && empty(NO_SVN_CACHE.${repo}:M[Yy][Ee][Ss])
#   cache file name
.  if !defined(SVN_DISTBASE.${repo})
SVN_DISTBASE.${repo}=	${SVN_MODULE.${repo}}
.  endif
_SVN_DISTFILE.${repo}=	${SVN_DISTBASE.${repo}}-${_SVN_TAG.${repo}}.tar.gz

#   command to extract cache file
_SVN_EXTRACT_CACHED.${repo}=	\
	p="$$(ls -td ${_SVN_DISTDIR}/${SVN_DISTBASE.${repo}}-*.tar.gz | head -n 1)";	\
	if [ -n "$$p" ]; then						\
	  ${STEP_MSG} "(1) Extracting cached SVN archive \"""$$p\".";	\
	  pax -r -z -f "$$p";				\
	else								\
	  ${STEP_MSG} "(1a) No cache file found.";			\
	fi

_SVN_CHECK_UPDATE.${repo}=     \
	"$$(grep ^[ADMU] ${_SVN_TMP_RESULT.${repo}} | head -n 1)"

#   create cache archive
_SVN_CREATE_CACHE.${repo}=	\
	${STEP_MSG} "(5) Creating cached Subversion archive "${_SVN_DISTFILE.${repo}:Q}"."; \
	${MKDIR} ${_SVN_DISTDIR:Q};							\
	pax -w -z -f ${_SVN_DISTDIR}/${_SVN_DISTFILE.${repo}:Q} ${SVN_MODULE.${repo}:Q}
.  else
# I have to set them to noop:
_SVN_DISTFILE.${repo}=		:
_SVN_EXTRACT_CACHED.${repo}=	:
_SVN_CREATE_CACHE.${repo}=	:
.  endif
.endfor

pre-extract: do-svn-extract

do-svn-extract: .PHONY
.if defined(SVN_CERTS) && !empty(SVN_CERTS)
	${RUN}${MKDIR} -p ${_SVN_CONFIG_DIR}/auth/svn.ssl.server
	${RUN}${CP} ${SVN_CERTS} ${_SVN_CONFIG_DIR}/auth/svn.ssl.server
.endif
.for repo in ${SVN_REPOSITORIES}
	${RUN} cd ${WRKDIR};						\
	if [ ! -d ${_SVN_DISTDIR} ]; then mkdir -p ${_SVN_DISTDIR:Q}; fi;	\
	${_SVN_EXTRACT_CACHED.${repo}};					\
	${STEP_MSG} "(2) Downloading "${SVN_MODULE.${repo}:Q}" from "${SVN_ROOT.${repo}:Q}"."; \
	${SETENV} ${_SVN_ENV}						\
		${_SVN_CMD}						\
			checkout ${_SVN_CHECKOUT_FLAGS}			\
			${_SVN_TAG_FLAG.${repo}:Q}			\
			${_SVN_FLAGS}					\
			${SVN_ROOT.${repo}:Q}				\
			${SVN_MODULE.${repo}:Q} > ${_SVN_TMP_RESULT.${repo}};	\
	if [	!  "$$p" = 0	];then					\
	  if [	  ! -z ${_SVN_TMP_RESULT.${repo}} ];then		\
	    if [    -n ${_SVN_CHECK_UPDATE.${repo}} ]; then		\
	${_SVN_CREATE_CACHE.${repo}};					\
	    else							\
	${STEP_MSG} "(6a) Skip creating cache file for no update.";	\
	    fi;								\
	  else								\
	${STEP_MSG} "(6b) Skip creating cache file.";			\
	  fi;								\
	else								\
	${STEP_MSG} "(6c) Skip creating cache file for no update.";	\
	fi;
.endfor

.endif

# test is four way
#   no any cache file yet		->     write cache
#   cache file exist and no update	-> no  write cache
#   cache file exist, file added/delete	->     write cache
#   cache file exist and update there	->     write cache