/[gentoo-x86]/eclass/subversion.eclass
Gentoo

Diff of /eclass/subversion.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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