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

Contents of /eclass/subversion.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.62 - (show annotations) (download)
Sun Apr 26 01:57:14 2009 UTC (5 years, 4 months ago) by arfrever
Branch: MAIN
Changes since 1.61: +3 -1 lines
Run 'svn cleanup' to automatically upgrade working copies.

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

  ViewVC Help
Powered by ViewVC 1.1.20