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

Contents of /eclass/subversion.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.69 - (show annotations) (download)
Sun Dec 19 14:51:46 2010 UTC (4 years, 7 months ago) by jlec
Branch: MAIN
Changes since 1.68: +4 -2 lines
Leaving ESVN_STORE_DIR after the subversion_src_unpack, so that subsequent commands act in  not in ESVN_STORE_DIR

1 # Copyright 1999-2009 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.68 2010/06/22 18:34:29 arfrever Exp $
4
5 # @ECLASS: subversion.eclass
6 # @MAINTAINER:
7 # Akinori Hattori <hattya@gentoo.org>
8 # Bo ├śrsted Andresen <zlin@gentoo.org>
9 # Arfrever Frehtes Taifersar Arahesis <arfrever@gentoo.org>
10 #
11 # Original Author: Akinori Hattori <hattya@gentoo.org>
12 #
13 # @BLURB: The subversion eclass is written to fetch software sources from subversion repositories
14 # @DESCRIPTION:
15 # The subversion eclass provides functions to fetch, patch and bootstrap
16 # software sources from subversion repositories.
17
18 inherit eutils
19
20 ESVN="${ECLASS}"
21
22 case "${EAPI:-0}" in
23 0|1)
24 EXPORT_FUNCTIONS src_unpack pkg_preinst
25 ;;
26 *)
27 EXPORT_FUNCTIONS src_unpack src_prepare pkg_preinst
28 ;;
29 esac
30
31 DESCRIPTION="Based on the ${ECLASS} eclass"
32
33 SUBVERSION_DEPEND="dev-vcs/subversion
34 net-misc/rsync"
35
36 if [[ -z "${ESVN_DISABLE_DEPENDENCIES}" ]]; then
37 DEPEND="${SUBVERSION_DEPEND}"
38 fi
39
40 # @ECLASS-VARIABLE: ESVN_STORE_DIR
41 # @DESCRIPTION:
42 # subversion sources store directory. Users may override this in /etc/make.conf
43 [[ -z ${ESVN_STORE_DIR} ]] && ESVN_STORE_DIR="${PORTAGE_ACTUAL_DISTDIR:-${DISTDIR}}/svn-src"
44
45 # @ECLASS-VARIABLE: ESVN_FETCH_CMD
46 # @DESCRIPTION:
47 # subversion checkout command
48 ESVN_FETCH_CMD="svn checkout"
49
50 # @ECLASS-VARIABLE: ESVN_UPDATE_CMD
51 # @DESCRIPTION:
52 # subversion update command
53 ESVN_UPDATE_CMD="svn update"
54
55 # @ECLASS-VARIABLE: ESVN_SWITCH_CMD
56 # @DESCRIPTION:
57 # subversion switch command
58 ESVN_SWITCH_CMD="svn switch"
59
60 # @ECLASS-VARIABLE: ESVN_OPTIONS
61 # @DESCRIPTION:
62 # the options passed to checkout or update. If you want a specific revision see
63 # ESVN_REPO_URI instead of using -rREV.
64 ESVN_OPTIONS="${ESVN_OPTIONS:-}"
65
66 # @ECLASS-VARIABLE: ESVN_REPO_URI
67 # @DESCRIPTION:
68 # repository uri
69 #
70 # e.g. http://foo/trunk, svn://bar/trunk, svn://bar/branch/foo@1234
71 #
72 # supported protocols:
73 # http://
74 # https://
75 # svn://
76 # svn+ssh://
77 #
78 # to peg to a specific revision, append @REV to the repo's uri
79 ESVN_REPO_URI="${ESVN_REPO_URI:-}"
80
81 # @ECLASS-VARIABLE: ESVN_REVISION
82 # @DESCRIPTION:
83 # User configurable revision checkout or update to from the repository
84 #
85 # Useful for live svn or trunk svn ebuilds allowing the user to peg
86 # to a specific revision
87 #
88 # Note: This should never be set in an ebuild!
89 ESVN_REVISION="${ESVN_REVISION:-}"
90
91 # @ECLASS-VARIABLE: ESVN_USER
92 # @DESCRIPTION:
93 # User name
94 ESVN_USER="${ESVN_USER:-}"
95
96 # @ECLASS-VARIABLE: ESVN_PASSWORD
97 # @DESCRIPTION:
98 # Password
99 ESVN_PASSWORD="${ESVN_PASSWORD:-}"
100
101 # @ECLASS-VARIABLE: ESVN_PROJECT
102 # @DESCRIPTION:
103 # project name of your ebuild (= name space)
104 #
105 # subversion eclass will check out the subversion repository like:
106 #
107 # ${ESVN_STORE_DIR}/${ESVN_PROJECT}/${ESVN_REPO_URI##*/}
108 #
109 # so if you define ESVN_REPO_URI as http://svn.collab.net/repo/svn/trunk or
110 # http://svn.collab.net/repo/svn/trunk/. and PN is subversion-svn.
111 # it will check out like:
112 #
113 # ${ESVN_STORE_DIR}/subversion/trunk
114 #
115 # this is not used in order to declare the name of the upstream project.
116 # so that you can declare this like:
117 #
118 # # jakarta commons-loggin
119 # ESVN_PROJECT=commons/logging
120 #
121 # default: ${PN/-svn}.
122 ESVN_PROJECT="${ESVN_PROJECT:-${PN/-svn}}"
123
124 # @ECLASS-VARIABLE: ESVN_BOOTSTRAP
125 # @DESCRIPTION:
126 # bootstrap script or command like autogen.sh or etc..
127 ESVN_BOOTSTRAP="${ESVN_BOOTSTRAP:-}"
128
129 # @ECLASS-VARIABLE: ESVN_PATCHES
130 # @DESCRIPTION:
131 # subversion eclass can apply patches in subversion_bootstrap().
132 # you can use regexp in this variable like *.diff or *.patch or etc.
133 # NOTE: patches will be applied before ESVN_BOOTSTRAP is processed.
134 #
135 # Patches are searched both in ${PWD} and ${FILESDIR}, if not found in either
136 # location, the installation dies.
137 ESVN_PATCHES="${ESVN_PATCHES:-}"
138
139 # @ECLASS-VARIABLE: ESVN_RESTRICT
140 # @DESCRIPTION:
141 # this should be a space delimited list of subversion eclass features to
142 # restrict.
143 # export)
144 # don't export the working copy to S.
145 ESVN_RESTRICT="${ESVN_RESTRICT:-}"
146
147 # @ECLASS-VARIABLE: ESVN_DISABLE_DEPENDENCIES
148 # @DESCRIPTION:
149 # Set this variable to a non-empty value to disable the automatic inclusion of
150 # Subversion in dependencies.
151 ESVN_DISABLE_DEPENDENCIES="${ESVN_DISABLE_DEPENDENCIES:-}"
152
153 # @ECLASS-VARIABLE: ESVN_OFFLINE
154 # @DESCRIPTION:
155 # Set this variable to a non-empty value to disable the automatic updating of
156 # an svn source tree. This is intended to be set outside the subversion source
157 # tree by users.
158 ESVN_OFFLINE="${ESVN_OFFLINE:-${ESCM_OFFLINE}}"
159
160 # @ECLASS-VARIABLE: ESVN_UP_FREQ
161 # @DESCRIPTION:
162 # Set the minimum number of hours between svn up'ing in any given svn module. This is particularly
163 # useful for split KDE ebuilds where we want to ensure that all submodules are compiled for the same
164 # revision. It should also be kept user overrideable.
165 ESVN_UP_FREQ="${ESVN_UP_FREQ:=}"
166
167 # @ECLASS-VARIABLE: ESCM_LOGDIR
168 # @DESCRIPTION:
169 # User configuration variable. If set to a path such as e.g. /var/log/scm any
170 # package inheriting from subversion.eclass will record svn revision to
171 # ${CATEGORY}/${PN}.log in that path in pkg_preinst. This is not supposed to be
172 # set by ebuilds/eclasses. It defaults to empty so users need to opt in.
173 ESCM_LOGDIR="${ESCM_LOGDIR:=}"
174
175 # @FUNCTION: subversion_fetch
176 # @USAGE: [repo_uri] [destination]
177 # @DESCRIPTION:
178 # Wrapper function to fetch sources from subversion via svn checkout or svn update,
179 # depending on whether there is an existing working copy in ${ESVN_STORE_DIR}.
180 #
181 # Can take two optional parameters:
182 # repo_uri - a repository URI. default is ESVN_REPO_URI.
183 # destination - a check out path in S.
184 subversion_fetch() {
185 local repo_uri="$(subversion__get_repository_uri "${1:-${ESVN_REPO_URI}}")"
186 local revision="$(subversion__get_peg_revision "${1:-${ESVN_REPO_URI}}")"
187 local S_dest="${2}"
188
189 if [[ -z ${repo_uri} ]]; then
190 die "${ESVN}: ESVN_REPO_URI (or specified URI) is empty."
191 fi
192
193 [[ -n "${ESVN_REVISION}" ]] && revision="${ESVN_REVISION}"
194
195 # check for the protocol
196 local protocol="${repo_uri%%:*}"
197
198 case "${protocol}" in
199 http|https)
200 if ! built_with_use -o dev-vcs/subversion webdav-neon webdav-serf; then
201 echo
202 eerror "In order to emerge this package, you need to"
203 eerror "reinstall Subversion with support for WebDAV."
204 eerror "Subversion requires either Neon or Serf to support WebDAV."
205 echo
206 die "${ESVN}: reinstall Subversion with support for WebDAV."
207 fi
208 ;;
209 svn|svn+ssh)
210 ;;
211 *)
212 die "${ESVN}: fetch from '${protocol}' is not yet implemented."
213 ;;
214 esac
215
216 addread "/etc/subversion"
217 addwrite "${ESVN_STORE_DIR}"
218
219 if [[ ! -d ${ESVN_STORE_DIR} ]]; then
220 debug-print "${FUNCNAME}: initial checkout. creating subversion directory"
221 mkdir -p "${ESVN_STORE_DIR}" || die "${ESVN}: can't mkdir ${ESVN_STORE_DIR}."
222 fi
223
224 pushd "${ESVN_STORE_DIR}" > /dev/null || die "${ESVN}: can't chdir to ${ESVN_STORE_DIR}"
225
226 local wc_path="$(subversion__get_wc_path "${repo_uri}")"
227 local options="${ESVN_OPTIONS} --config-dir ${ESVN_STORE_DIR}/.subversion"
228
229 [[ -n "${revision}" ]] && options="${options} -r ${revision}"
230
231 if [[ "${ESVN_OPTIONS}" = *-r* ]]; then
232 ewarn "\${ESVN_OPTIONS} contains -r, this usage is unsupported. Please"
233 ewarn "see \${ESVN_REPO_URI}"
234 fi
235
236 if has_version ">=dev-vcs/subversion-1.6.0"; then
237 options="${options} --config-option=config:auth:password-stores="
238 fi
239
240 debug-print "${FUNCNAME}: wc_path = \"${wc_path}\""
241 debug-print "${FUNCNAME}: ESVN_OPTIONS = \"${ESVN_OPTIONS}\""
242 debug-print "${FUNCNAME}: options = \"${options}\""
243
244 if [[ ! -d ${wc_path}/.svn ]]; then
245 if [[ -n ${ESVN_OFFLINE} ]]; then
246 ewarn "ESVN_OFFLINE cannot be used when there is no existing checkout."
247 fi
248 # first check out
249 einfo "subversion check out start -->"
250 einfo " repository: ${repo_uri}${revision:+@}${revision}"
251
252 debug-print "${FUNCNAME}: ${ESVN_FETCH_CMD} ${options} ${repo_uri}"
253
254 mkdir -p "${ESVN_PROJECT}" || die "${ESVN}: can't mkdir ${ESVN_PROJECT}."
255 cd "${ESVN_PROJECT}" || die "${ESVN}: can't chdir to ${ESVN_PROJECT}"
256 if [[ -n "${ESVN_USER}" ]]; then
257 ${ESVN_FETCH_CMD} ${options} --username "${ESVN_USER}" --password "${ESVN_PASSWORD}" "${repo_uri}" || die "${ESVN}: can't fetch to ${wc_path} from ${repo_uri}."
258 else
259 ${ESVN_FETCH_CMD} ${options} "${repo_uri}" || die "${ESVN}: can't fetch to ${wc_path} from ${repo_uri}."
260 fi
261
262 elif [[ -n ${ESVN_OFFLINE} ]]; then
263 svn upgrade "${wc_path}" &>/dev/null
264 svn cleanup "${wc_path}" &>/dev/null
265 subversion_wc_info "${repo_uri}" || die "${ESVN}: unknown problem occurred while accessing working copy."
266 if [[ -n ${ESVN_REVISION} && ${ESVN_REVISION} != ${ESVN_WC_REVISION} ]]; then
267 die "${ESVN}: You requested off-line updating and revision ${ESVN_REVISION} but only revision ${ESVN_WC_REVISION} is available locally."
268 fi
269 einfo "Fetching disabled: Using existing repository copy at revision ${ESVN_WC_REVISION}."
270 else
271 svn upgrade "${wc_path}" &>/dev/null
272 svn cleanup "${wc_path}" &>/dev/null
273 subversion_wc_info "${repo_uri}" || die "${ESVN}: unknown problem occurred while accessing working copy."
274
275 local esvn_up_freq=
276 if [[ -n ${ESVN_UP_FREQ} ]]; then
277 if [[ -n ${ESVN_UP_FREQ//[[:digit:]]} ]]; then
278 die "${ESVN}: ESVN_UP_FREQ must be an integer value corresponding to the minimum number of hours between svn up."
279 elif [[ -z $(find "${wc_path}/.svn/entries" -mmin "+$((ESVN_UP_FREQ*60))") ]]; then
280 einfo "Fetching disabled since ${ESVN_UP_FREQ} hours has not passed since last update."
281 einfo "Using existing repository copy at revision ${ESVN_WC_REVISION}."
282 esvn_up_freq=no_update
283 fi
284 fi
285
286 if [[ -z ${esvn_up_freq} ]]; then
287 if [[ ${ESVN_WC_URL} != $(subversion__get_repository_uri "${repo_uri}") ]]; then
288 einfo "subversion switch start -->"
289 einfo " old repository: ${ESVN_WC_URL}@${ESVN_WC_REVISION}"
290 einfo " new repository: ${repo_uri}${revision:+@}${revision}"
291
292 debug-print "${FUNCNAME}: ${ESVN_SWITCH_CMD} ${options} ${repo_uri}"
293
294 cd "${wc_path}" || die "${ESVN}: can't chdir to ${wc_path}"
295 if [[ -n "${ESVN_USER}" ]]; then
296 ${ESVN_SWITCH_CMD} ${options} --username "${ESVN_USER}" --password "${ESVN_PASSWORD}" ${repo_uri} || die "${ESVN}: can't update ${wc_path} from ${repo_uri}."
297 else
298 ${ESVN_SWITCH_CMD} ${options} ${repo_uri} || die "${ESVN}: can't update ${wc_path} from ${repo_uri}."
299 fi
300 else
301 # update working copy
302 einfo "subversion update start -->"
303 einfo " repository: ${repo_uri}${revision:+@}${revision}"
304
305 debug-print "${FUNCNAME}: ${ESVN_UPDATE_CMD} ${options}"
306
307 cd "${wc_path}" || die "${ESVN}: can't chdir to ${wc_path}"
308 if [[ -n "${ESVN_USER}" ]]; then
309 ${ESVN_UPDATE_CMD} ${options} --username "${ESVN_USER}" --password "${ESVN_PASSWORD}" || die "${ESVN}: can't update ${wc_path} from ${repo_uri}."
310 else
311 ${ESVN_UPDATE_CMD} ${options} || die "${ESVN}: can't update ${wc_path} from ${repo_uri}."
312 fi
313 fi
314 fi
315 fi
316
317 einfo " working copy: ${wc_path}"
318
319 if ! has "export" ${ESVN_RESTRICT}; then
320 cd "${wc_path}" || die "${ESVN}: can't chdir to ${wc_path}"
321
322 local S="${S}/${S_dest}"
323 mkdir -p "${S}"
324
325 # export to the ${WORKDIR}
326 #* "svn export" has a bug. see http://bugs.gentoo.org/119236
327 #* svn export . "${S}" || die "${ESVN}: can't export to ${S}."
328 rsync -rlpgo --exclude=".svn/" . "${S}" || die "${ESVN}: can't export to ${S}."
329 fi
330
331 popd > /dev/null
332
333 echo
334 }
335
336 # @FUNCTION: subversion_bootstrap
337 # @DESCRIPTION:
338 # Apply patches in ${ESVN_PATCHES} and run ${ESVN_BOOTSTRAP} if specified.
339 subversion_bootstrap() {
340 if has "export" ${ESVN_RESTRICT}; then
341 return
342 fi
343
344 cd "${S}"
345
346 if [[ -n ${ESVN_PATCHES} ]]; then
347 einfo "apply patches -->"
348
349 local patch fpatch
350
351 for patch in ${ESVN_PATCHES}; do
352 if [[ -f ${patch} ]]; then
353 epatch "${patch}"
354
355 else
356 for fpatch in ${FILESDIR}/${patch}; do
357 if [[ -f ${fpatch} ]]; then
358 epatch "${fpatch}"
359
360 else
361 die "${ESVN}: ${patch} not found"
362
363 fi
364 done
365
366 fi
367 done
368
369 echo
370 fi
371
372 if [[ -n ${ESVN_BOOTSTRAP} ]]; then
373 einfo "begin bootstrap -->"
374
375 if [[ -f ${ESVN_BOOTSTRAP} && -x ${ESVN_BOOTSTRAP} ]]; then
376 einfo " bootstrap with a file: ${ESVN_BOOTSTRAP}"
377 eval "./${ESVN_BOOTSTRAP}" || die "${ESVN}: can't execute ESVN_BOOTSTRAP."
378
379 else
380 einfo " bootstrap with command: ${ESVN_BOOTSTRAP}"
381 eval "${ESVN_BOOTSTRAP}" || die "${ESVN}: can't eval ESVN_BOOTSTRAP."
382
383 fi
384 fi
385 }
386
387 # @FUNCTION: subversion_src_unpack
388 # @DESCRIPTION:
389 # Default src_unpack. Fetch and, in older EAPIs, bootstrap.
390 subversion_src_unpack() {
391 subversion_fetch || die "${ESVN}: unknown problem occurred in subversion_fetch."
392 if has "${EAPI:-0}" 0 1; then
393 subversion_bootstrap || die "${ESVN}: unknown problem occurred in subversion_bootstrap."
394 fi
395 }
396
397 # @FUNCTION: subversion_src_prepare
398 # @DESCRIPTION:
399 # Default src_prepare. Bootstrap.
400 subversion_src_prepare() {
401 subversion_bootstrap || die "${ESVN}: unknown problem occurred in subversion_bootstrap."
402 }
403
404 # @FUNCTION: subversion_wc_info
405 # @USAGE: [repo_uri]
406 # @RETURN: ESVN_WC_URL, ESVN_WC_ROOT, ESVN_WC_UUID, ESVN_WC_REVISION and ESVN_WC_PATH
407 # @DESCRIPTION:
408 # Get svn info for the specified repo_uri. The default repo_uri is ESVN_REPO_URI.
409 #
410 # The working copy information on the specified repository URI are set to
411 # ESVN_WC_* variables.
412 subversion_wc_info() {
413 local repo_uri="$(subversion__get_repository_uri "${1:-${ESVN_REPO_URI}}")"
414 local wc_path="$(subversion__get_wc_path "${repo_uri}")"
415
416 debug-print "${FUNCNAME}: repo_uri = ${repo_uri}"
417 debug-print "${FUNCNAME}: wc_path = ${wc_path}"
418
419 if [[ ! -d ${wc_path} ]]; then
420 return 1
421 fi
422
423 export ESVN_WC_URL="$(subversion__svn_info "${wc_path}" "URL")"
424 export ESVN_WC_ROOT="$(subversion__svn_info "${wc_path}" "Repository Root")"
425 export ESVN_WC_UUID="$(subversion__svn_info "${wc_path}" "Repository UUID")"
426 export ESVN_WC_REVISION="$(subversion__svn_info "${wc_path}" "Revision")"
427 export ESVN_WC_PATH="${wc_path}"
428 }
429
430 ## -- Private Functions
431
432 ## -- subversion__svn_info() ------------------------------------------------- #
433 #
434 # param $1 - a target.
435 # param $2 - a key name.
436 #
437 subversion__svn_info() {
438 local target="${1}"
439 local key="${2}"
440
441 env LC_ALL=C svn info "${target}" | grep -i "^${key}" | cut -d" " -f2-
442 }
443
444 ## -- subversion__get_repository_uri() --------------------------------------- #
445 #
446 # param $1 - a repository URI.
447 subversion__get_repository_uri() {
448 local repo_uri="${1}"
449
450 debug-print "${FUNCNAME}: repo_uri = ${repo_uri}"
451
452 if [[ -z ${repo_uri} ]]; then
453 die "${ESVN}: ESVN_REPO_URI (or specified URI) is empty."
454 fi
455
456 # delete trailing slash
457 if [[ -z ${repo_uri##*/} ]]; then
458 repo_uri="${repo_uri%/}"
459 fi
460
461 repo_uri="${repo_uri%@*}"
462
463 echo "${repo_uri}"
464 }
465
466 ## -- subversion__get_wc_path() ---------------------------------------------- #
467 #
468 # param $1 - a repository URI.
469 subversion__get_wc_path() {
470 local repo_uri="$(subversion__get_repository_uri "${1}")"
471
472 debug-print "${FUNCNAME}: repo_uri = ${repo_uri}"
473
474 echo "${ESVN_STORE_DIR}/${ESVN_PROJECT}/${repo_uri##*/}"
475 }
476
477 ## -- subversion__get_peg_revision() ----------------------------------------- #
478 #
479 # param $1 - a repository URI.
480 subversion__get_peg_revision() {
481 local repo_uri="${1}"
482
483 debug-print "${FUNCNAME}: repo_uri = ${repo_uri}"
484
485 # repo_uri has peg revision ?
486 if [[ ${repo_uri} != *@* ]]; then
487 debug-print "${FUNCNAME}: repo_uri does not have a peg revision."
488 fi
489
490 local peg_rev=
491 [[ ${repo_uri} = *@* ]] && peg_rev="${repo_uri##*@}"
492
493 debug-print "${FUNCNAME}: peg_rev = ${peg_rev}"
494
495 echo "${peg_rev}"
496 }
497
498 # @FUNCTION: subversion_pkg_preinst
499 # @USAGE: [repo_uri]
500 # @DESCRIPTION:
501 # Log the svn revision of source code. Doing this in pkg_preinst because we
502 # want the logs to stick around if packages are uninstalled without messing with
503 # config protection.
504 subversion_pkg_preinst() {
505 local pkgdate=$(date "+%Y%m%d %H:%M:%S")
506 subversion_wc_info "${1:-${ESVN_REPO_URI}}"
507 if [[ -n ${ESCM_LOGDIR} ]]; then
508 local dir="${ROOT}/${ESCM_LOGDIR}/${CATEGORY}"
509 if [[ ! -d ${dir} ]]; then
510 mkdir -p "${dir}" || \
511 eerror "Failed to create '${dir}' for logging svn revision to '${PORTDIR_SCM}'"
512 fi
513 local logmessage="svn: ${pkgdate} - ${PF}:${SLOT} was merged at revision ${ESVN_WC_REVISION}"
514 if [[ -d ${dir} ]]; then
515 echo "${logmessage}" >> "${dir}/${PN}.log"
516 else
517 eerror "Could not log the message '${logmessage}' to '${dir}/${PN}.log'"
518 fi
519 fi
520 }

  ViewVC Help
Powered by ViewVC 1.1.20