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

Contents of /eclass/subversion.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.71 - (show annotations) (download)
Wed Dec 14 23:40:18 2011 UTC (3 years ago) by vapier
Branch: MAIN
Changes since 1.70: +3 -3 lines
create backing store dirs with group write perms so that people can more easily switch between user based testing (ebuild/etc...) and root/userpriv based emerging

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

  ViewVC Help
Powered by ViewVC 1.1.20