| 1 |
# Copyright 1999-2008 Gentoo Foundation |
| 2 |
# Distributed under the terms of the GNU General Public License v2 |
| 3 |
# $Header: /var/cvsroot/gentoo-x86/eclass/subversion.eclass,v 1.47 2008/02/20 17:55:27 cardoe Exp $ |
| 4 |
|
| 5 |
# @ECLASS: subversion.eclass |
| 6 |
# @MAINTAINER: |
| 7 |
# Akinori Hattori <hattya@gentoo.org> |
| 8 |
# Bo Ørsted Andresen <zlin@gentoo.org> |
| 9 |
# |
| 10 |
# Original Author: Akinori Hattori <hattya@gentoo.org> |
| 11 |
# |
| 12 |
# @BLURB: The subversion eclass is written to fetch software sources from subversion repositories |
| 13 |
# @DESCRIPTION: |
| 14 |
# The subversion eclass provides functions to fetch, patch and bootstrap |
| 15 |
# software sources from subversion repositories. |
| 16 |
# |
| 17 |
# You must define the ESVN_REPO_URI variable before inheriting this eclass. |
| 18 |
|
| 19 |
inherit eutils |
| 20 |
|
| 21 |
ESVN="${ECLASS}" |
| 22 |
|
| 23 |
EXPORT_FUNCTIONS src_unpack |
| 24 |
|
| 25 |
DESCRIPTION="Based on the ${ECLASS} eclass" |
| 26 |
|
| 27 |
DEPEND="dev-util/subversion |
| 28 |
net-misc/rsync" |
| 29 |
|
| 30 |
# @ECLASS-VARIABLE: ESVN_STORE_DIR |
| 31 |
# @DESCRIPTION: |
| 32 |
# subversion sources store directory. Users may override this in /etc/make.conf |
| 33 |
[[ -z ${ESVN_STORE_DIR} ]] && ESVN_STORE_DIR="${PORTAGE_ACTUAL_DISTDIR:-${DISTDIR}}/svn-src" |
| 34 |
|
| 35 |
# @ECLASS-VARIABLE: ESVN_FETCH_CMD |
| 36 |
# @DESCRIPTION: |
| 37 |
# subversion checkout command |
| 38 |
ESVN_FETCH_CMD="svn checkout" |
| 39 |
|
| 40 |
# @ECLASS-VARIABLE: ESVN_UPDATE_CMD |
| 41 |
# @DESCRIPTION: |
| 42 |
# subversion update command |
| 43 |
ESVN_UPDATE_CMD="svn update" |
| 44 |
|
| 45 |
# @ECLASS-VARIABLE: ESVN_SWITCH_CMD |
| 46 |
# @DESCRIPTION: |
| 47 |
# subversion switch command |
| 48 |
ESVN_SWITCH_CMD="svn switch" |
| 49 |
|
| 50 |
# @ECLASS-VARIABLE: ESVN_OPTIONS |
| 51 |
# @DESCRIPTION: |
| 52 |
# the options passed to checkout or update. If you want a specific revision see |
| 53 |
# ESVN_REPO_URI instead of using -rREV. |
| 54 |
ESVN_OPTIONS="${ESVN_OPTIONS:-}" |
| 55 |
|
| 56 |
# @ECLASS-VARIABLE: ESVN_REPO_URI |
| 57 |
# @DESCRIPTION: |
| 58 |
# repository uri |
| 59 |
# |
| 60 |
# e.g. http://foo/trunk, svn://bar/trunk, svn://bar/branch/foo@1234 |
| 61 |
# |
| 62 |
# supported protocols: |
| 63 |
# http:// |
| 64 |
# https:// |
| 65 |
# svn:// |
| 66 |
# svn+ssh:// |
| 67 |
# |
| 68 |
# to peg to a specific revision, append @REV to the repo's uri |
| 69 |
ESVN_REPO_URI="${ESVN_REPO_URI:-}" |
| 70 |
|
| 71 |
# @ECLASS-VARIABLE: ESVN_REVISION |
| 72 |
# @DESCRIPTION: |
| 73 |
# User configurable revision checkout or update to from the repository |
| 74 |
# |
| 75 |
# Useful for live svn or trunk svn ebuilds allowing the user to peg |
| 76 |
# to a specific revision |
| 77 |
# |
| 78 |
# Note: This should never be set in an ebuild! |
| 79 |
ESVN_REVISION="${ESVN_REVISION:-}" |
| 80 |
|
| 81 |
# @ECLASS-VARIABLE: ESVN_PROJECT |
| 82 |
# @DESCRIPTION: |
| 83 |
# project name of your ebuild (= name space) |
| 84 |
# |
| 85 |
# subversion eclass will check out the subversion repository like: |
| 86 |
# |
| 87 |
# ${ESVN_STORE_DIR}/${ESVN_PROJECT}/${ESVN_REPO_URI##*/} |
| 88 |
# |
| 89 |
# so if you define ESVN_REPO_URI as http://svn.collab.net/repo/svn/trunk or |
| 90 |
# http://svn.collab.net/repo/svn/trunk/. and PN is subversion-svn. |
| 91 |
# it will check out like: |
| 92 |
# |
| 93 |
# ${ESVN_STORE_DIR}/subversion/trunk |
| 94 |
# |
| 95 |
# this is not used in order to declare the name of the upstream project. |
| 96 |
# so that you can declare this like: |
| 97 |
# |
| 98 |
# # jakarta commons-loggin |
| 99 |
# ESVN_PROJECT=commons/logging |
| 100 |
# |
| 101 |
# default: ${PN/-svn}. |
| 102 |
ESVN_PROJECT="${ESVN_PROJECT:-${PN/-svn}}" |
| 103 |
|
| 104 |
# @ECLASS-VARIABLE: ESVN_BOOTSTRAP |
| 105 |
# @DESCRIPTION: |
| 106 |
# bootstrap script or command like autogen.sh or etc.. |
| 107 |
ESVN_BOOTSTRAP="${ESVN_BOOTSTRAP:-}" |
| 108 |
|
| 109 |
# @ECLASS-VARIABLE: ESVN_PATCHES |
| 110 |
# @DESCRIPTION: |
| 111 |
# subversion eclass can apply patches in subversion_bootstrap(). |
| 112 |
# you can use regexp in this variable like *.diff or *.patch or etc. |
| 113 |
# NOTE: patches will be applied before ESVN_BOOTSTRAP is processed. |
| 114 |
# |
| 115 |
# Patches are searched both in ${PWD} and ${FILESDIR}, if not found in either |
| 116 |
# location, the installation dies. |
| 117 |
ESVN_PATCHES="${ESVN_PATCHES:-}" |
| 118 |
|
| 119 |
# @ECLASS-VARIABLE: ESVN_RESTRICT |
| 120 |
# @DESCRIPTION: |
| 121 |
# this should be a space delimited list of subversion eclass features to |
| 122 |
# restrict. |
| 123 |
# export) |
| 124 |
# don't export the working copy to S. |
| 125 |
ESVN_RESTRICT="${ESVN_RESTRICT:-}" |
| 126 |
|
| 127 |
# @FUNCTION: subversion_fetch |
| 128 |
# @USAGE: [repo_uri] [destination] |
| 129 |
# @DESCRIPTION: |
| 130 |
# Wrapper function to fetch sources from subversion via svn checkout or svn update, |
| 131 |
# depending on whether there is an existing working copy in ${ESVN_STORE_DIR}. |
| 132 |
# |
| 133 |
# Can take two optional parameters: |
| 134 |
# repo_uri - a repository URI. default is ESVN_REPO_URI. |
| 135 |
# destination - a check out path in S. |
| 136 |
subversion_fetch() { |
| 137 |
local repo_uri="$(subversion__get_repository_uri "${1:-${ESVN_REPO_URI}}")" |
| 138 |
local revision="$(subversion__get_peg_revision "${1:-${ESVN_REPO_URI}}")" |
| 139 |
local S_dest="${2}" |
| 140 |
|
| 141 |
[[ -n "${ESVN_REVISION}" ]] && revision="${ESVN_REVISION}" |
| 142 |
|
| 143 |
# check for the protocol |
| 144 |
local protocol="${repo_uri%%:*}" |
| 145 |
|
| 146 |
case "${protocol}" in |
| 147 |
http|https) |
| 148 |
if built_with_use dev-util/subversion nowebdav; then |
| 149 |
echo |
| 150 |
eerror "In order to emerge this package, you need to" |
| 151 |
eerror "re-emerge subversion with USE=-nowebdav" |
| 152 |
echo |
| 153 |
die "${ESVN}: please run 'USE=-nowebdav emerge subversion'" |
| 154 |
fi |
| 155 |
;; |
| 156 |
svn|svn+ssh) |
| 157 |
;; |
| 158 |
*) |
| 159 |
die "${ESVN}: fetch from '${protocol}' is not yet implemented." |
| 160 |
;; |
| 161 |
esac |
| 162 |
|
| 163 |
addread "/etc/subversion" |
| 164 |
addwrite "${ESVN_STORE_DIR}" |
| 165 |
|
| 166 |
if [[ ! -d ${ESVN_STORE_DIR} ]]; then |
| 167 |
debug-print "${FUNCNAME}: initial checkout. creating subversion directory" |
| 168 |
mkdir -p "${ESVN_STORE_DIR}" || die "${ESVN}: can't mkdir ${ESVN_STORE_DIR}." |
| 169 |
fi |
| 170 |
|
| 171 |
cd "${ESVN_STORE_DIR}" || die "${ESVN}: can't chdir to ${ESVN_STORE_DIR}" |
| 172 |
|
| 173 |
local wc_path="$(subversion__get_wc_path "${repo_uri}")" |
| 174 |
local options="${ESVN_OPTIONS} --config-dir ${ESVN_STORE_DIR}/.subversion" |
| 175 |
|
| 176 |
[[ -n "${revision}" ]] && options="${options} -r ${revision}" |
| 177 |
|
| 178 |
if [[ "${ESVN_OPTIONS}" = *-r* ]]; then |
| 179 |
ewarn "\${ESVN_OPTIONS} contains -r, this usage is unsupported. Please" |
| 180 |
ewarn "see \${ESVN_REPO_URI}" |
| 181 |
fi |
| 182 |
|
| 183 |
debug-print "${FUNCNAME}: wc_path = \"${wc_path}\"" |
| 184 |
debug-print "${FUNCNAME}: ESVN_OPTIONS = \"${ESVN_OPTIONS}\"" |
| 185 |
debug-print "${FUNCNAME}: options = \"${options}\"" |
| 186 |
|
| 187 |
if [[ ! -d ${wc_path}/.svn ]]; then |
| 188 |
# first check out |
| 189 |
einfo "subversion check out start -->" |
| 190 |
einfo " repository: ${repo_uri}${revision:+@}${revision}" |
| 191 |
|
| 192 |
debug-print "${FUNCNAME}: ${ESVN_FETCH_CMD} ${options} ${repo_uri}" |
| 193 |
|
| 194 |
mkdir -p "${ESVN_PROJECT}" || die "${ESVN}: can't mkdir ${ESVN_PROJECT}." |
| 195 |
cd "${ESVN_PROJECT}" || die "${ESVN}: can't chdir to ${ESVN_PROJECT}" |
| 196 |
${ESVN_FETCH_CMD} ${options} "${repo_uri}" || die "${ESVN}: can't fetch from ${repo_uri}." |
| 197 |
|
| 198 |
else |
| 199 |
subversion_wc_info "${repo_uri}" || die "${ESVN}: unknown problem occurred while accessing working copy." |
| 200 |
|
| 201 |
if [[ ${ESVN_WC_URL} != $(subversion__get_repository_uri "${repo_uri}") ]]; then |
| 202 |
einfo "suversion switch start -->" |
| 203 |
einfo " old repository: ${ESVN_WC_URL}@${ESVN_WC_REVISION}" |
| 204 |
einfo " new repository: ${repo_uri}${revision:+@}${revision}" |
| 205 |
|
| 206 |
debug-print "${FUNCNAME}: ${ESVN_SWITCH_CMD} ${options} ${repo_uri}" |
| 207 |
|
| 208 |
cd "${wc_path}" || die "${ESVN}: can't chdir to ${wc_path}" |
| 209 |
${ESVN_SWITCH_CMD} ${options} ${repo_uri} || die "${ESVN}: can't update from ${repo_uri}" |
| 210 |
else |
| 211 |
# update working copy |
| 212 |
einfo "subversion update start -->" |
| 213 |
einfo " repository: ${repo_uri}${revision:+@}${revision}" |
| 214 |
|
| 215 |
debug-print "${FUNCNAME}: ${ESVN_UPDATE_CMD} ${options}" |
| 216 |
|
| 217 |
cd "${wc_path}" || die "${ESVN}: can't chdir to ${wc_path}" |
| 218 |
${ESVN_UPDATE_CMD} ${options} || die "${ESVN}: can't update from ${repo_uri}." |
| 219 |
fi |
| 220 |
|
| 221 |
fi |
| 222 |
|
| 223 |
einfo " working copy: ${wc_path}" |
| 224 |
|
| 225 |
if ! has "export" ${ESVN_RESTRICT}; then |
| 226 |
cd "${wc_path}" || die "${ESVN}: can't chdir to ${wc_path}" |
| 227 |
|
| 228 |
local S="${S}/${S_dest}" |
| 229 |
|
| 230 |
# export to the ${WORKDIR} |
| 231 |
#* "svn export" has a bug. see http://bugs.gentoo.org/119236 |
| 232 |
#* svn export . "${S}" || die "${ESVN}: can't export to ${S}." |
| 233 |
rsync -rlpgo --exclude=".svn/" . "${S}" || die "${ESVN}: can't export to ${S}." |
| 234 |
fi |
| 235 |
|
| 236 |
echo |
| 237 |
} |
| 238 |
|
| 239 |
# @FUNCTION: subversion_bootstrap |
| 240 |
# @DESCRIPTION: |
| 241 |
# Apply patches in ${ESVN_PATCHES} and run ${ESVN_BOOTSTRAP} if specified. |
| 242 |
subversion_bootstrap() { |
| 243 |
if has "export" ${ESVN_RESTRICT}; then |
| 244 |
return |
| 245 |
fi |
| 246 |
|
| 247 |
cd "${S}" |
| 248 |
|
| 249 |
if [[ -n ${ESVN_PATCHES} ]]; then |
| 250 |
einfo "apply patches -->" |
| 251 |
|
| 252 |
local patch fpatch |
| 253 |
|
| 254 |
for patch in ${ESVN_PATCHES}; do |
| 255 |
if [[ -f ${patch} ]]; then |
| 256 |
epatch "${patch}" |
| 257 |
|
| 258 |
else |
| 259 |
for fpatch in ${FILESDIR}/${patch}; do |
| 260 |
if [[ -f ${fpatch} ]]; then |
| 261 |
epatch "${fpatch}" |
| 262 |
|
| 263 |
else |
| 264 |
die "${ESVN}: ${patch} not found" |
| 265 |
|
| 266 |
fi |
| 267 |
done |
| 268 |
|
| 269 |
fi |
| 270 |
done |
| 271 |
|
| 272 |
echo |
| 273 |
fi |
| 274 |
|
| 275 |
if [[ -n ${ESVN_BOOTSTRAP} ]]; then |
| 276 |
einfo "begin bootstrap -->" |
| 277 |
|
| 278 |
if [[ -f ${ESVN_BOOTSTRAP} && -x ${ESVN_BOOTSTRAP} ]]; then |
| 279 |
einfo " bootstrap with a file: ${ESVN_BOOTSTRAP}" |
| 280 |
eval "./${ESVN_BOOTSTRAP}" || die "${ESVN}: can't execute ESVN_BOOTSTRAP." |
| 281 |
|
| 282 |
else |
| 283 |
einfo " bootstrap with command: ${ESVN_BOOTSTRAP}" |
| 284 |
eval "${ESVN_BOOTSTRAP}" || die "${ESVN}: can't eval ESVN_BOOTSTRAP." |
| 285 |
|
| 286 |
fi |
| 287 |
fi |
| 288 |
} |
| 289 |
|
| 290 |
# @FUNCTION: subversion_src_unpack |
| 291 |
# @DESCRIPTION: |
| 292 |
# default src_unpack. fetch and bootstrap. |
| 293 |
subversion_src_unpack() { |
| 294 |
subversion_fetch || die "${ESVN}: unknown problem occurred in subversion_fetch." |
| 295 |
subversion_bootstrap || die "${ESVN}: unknown problem occurred in subversion_bootstrap." |
| 296 |
} |
| 297 |
|
| 298 |
# @FUNCTION: subversion_wc_info |
| 299 |
# @USAGE: [repo_uri] |
| 300 |
# @RETURN: ESVN_WC_URL, ESVN_WC_ROOT, ESVN_WC_UUID, ESVN_WC_REVISION and ESVN_WC_PATH |
| 301 |
# @DESCRIPTION: |
| 302 |
# Get svn info for the specified repo_uri. The default repo_uri is ESVN_REPO_URI. |
| 303 |
# |
| 304 |
# The working copy information on the specified repository URI are set to |
| 305 |
# ESVN_WC_* variables. |
| 306 |
subversion_wc_info() { |
| 307 |
local repo_uri="$(subversion__get_repository_uri "${1}")" |
| 308 |
local wc_path="$(subversion__get_wc_path "${repo_uri}")" |
| 309 |
|
| 310 |
debug-print "${FUNCNAME}: repo_uri = ${repo_uri}" |
| 311 |
debug-print "${FUNCNAME}: wc_path = ${wc_path}" |
| 312 |
|
| 313 |
if [[ ! -d ${wc_path} ]]; then |
| 314 |
return 1 |
| 315 |
fi |
| 316 |
|
| 317 |
export ESVN_WC_URL="$(subversion__svn_info "${wc_path}" "URL")" |
| 318 |
export ESVN_WC_ROOT="$(subversion__svn_info "${wc_path}" "Repository Root")" |
| 319 |
export ESVN_WC_UUID="$(subversion__svn_info "${wc_path}" "Repository UUID")" |
| 320 |
export ESVN_WC_REVISION="$(subversion__svn_info "${wc_path}" "Revision")" |
| 321 |
export ESVN_WC_PATH="${wc_path}" |
| 322 |
} |
| 323 |
|
| 324 |
## -- Private Functions |
| 325 |
|
| 326 |
## -- subversion__svn_info() ------------------------------------------------- # |
| 327 |
# |
| 328 |
# param $1 - a target. |
| 329 |
# param $2 - a key name. |
| 330 |
# |
| 331 |
subversion__svn_info() { |
| 332 |
local target="${1}" |
| 333 |
local key="${2}" |
| 334 |
|
| 335 |
env LC_ALL=C svn info "${target}" | grep -i "^${key}" | cut -d" " -f2- |
| 336 |
} |
| 337 |
|
| 338 |
## -- subversion__get_repository_uri() --------------------------------------- # |
| 339 |
# |
| 340 |
# param $1 - a repository URI. |
| 341 |
subversion__get_repository_uri() { |
| 342 |
local repo_uri="${1}" |
| 343 |
|
| 344 |
debug-print "${FUNCNAME}: repo_uri = ${repo_uri}" |
| 345 |
|
| 346 |
if [[ -z ${repo_uri} ]]; then |
| 347 |
die "${ESVN}: ESVN_REPO_URI (or specified URI) is empty." |
| 348 |
fi |
| 349 |
|
| 350 |
# delete trailing slash |
| 351 |
if [[ -z ${repo_uri##*/} ]]; then |
| 352 |
repo_uri="${repo_uri%/}" |
| 353 |
fi |
| 354 |
|
| 355 |
repo_uri="${repo_uri%@*}" |
| 356 |
|
| 357 |
echo "${repo_uri}" |
| 358 |
} |
| 359 |
|
| 360 |
## -- subversion__get_wc_path() ---------------------------------------------- # |
| 361 |
# |
| 362 |
# param $1 - a repository URI. |
| 363 |
subversion__get_wc_path() { |
| 364 |
local repo_uri="$(subversion__get_repository_uri "${1}")" |
| 365 |
|
| 366 |
debug-print "${FUNCNAME}: repo_uri = ${repo_uri}" |
| 367 |
|
| 368 |
echo "${ESVN_STORE_DIR}/${ESVN_PROJECT}/${repo_uri##*/}" |
| 369 |
} |
| 370 |
|
| 371 |
## -- subversion__get_peg_revision() ----------------------------------------- # |
| 372 |
# |
| 373 |
# param $1 - a repository URI. |
| 374 |
subversion__get_peg_revision() { |
| 375 |
local repo_uri="${1}" |
| 376 |
|
| 377 |
debug-print "${FUNCNAME}: repo_uri = ${repo_uri}" |
| 378 |
|
| 379 |
# repo_uri has peg revision ? |
| 380 |
if [[ ${repo_uri} != *@* ]]; then |
| 381 |
debug-print "${FUNCNAME}: repo_uri does not have a peg revision." |
| 382 |
fi |
| 383 |
|
| 384 |
local peg_rev= |
| 385 |
[[ ${repo_uri} = *@* ]] && peg_rev="${repo_uri##*@}" |
| 386 |
|
| 387 |
debug-print "${FUNCNAME}: peg_rev = ${peg_rev}" |
| 388 |
|
| 389 |
echo "${peg_rev}" |
| 390 |
} |