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

Diff of /eclass/subversion.eclass

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

Revision 1.47 Revision 1.63
1# Copyright 1999-2008 Gentoo Foundation 1# Copyright 1999-2009 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.47 2008/02/20 17:55:27 cardoe Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/subversion.eclass,v 1.63 2009/04/26 02:18:09 arfrever Exp $
4 4
5# @ECLASS: subversion.eclass 5# @ECLASS: subversion.eclass
6# @MAINTAINER: 6# @MAINTAINER:
7# Akinori Hattori <hattya@gentoo.org> 7# Akinori Hattori <hattya@gentoo.org>
8# Bo ├śrsted Andresen <zlin@gentoo.org> 8# Bo ├śrsted Andresen <zlin@gentoo.org>
9# Arfrever Frehtes Taifersar Arahesis <arfrever@gentoo.org>
9# 10#
10# Original Author: Akinori Hattori <hattya@gentoo.org> 11# Original Author: Akinori Hattori <hattya@gentoo.org>
11# 12#
12# @BLURB: The subversion eclass is written to fetch software sources from subversion repositories 13# @BLURB: The subversion eclass is written to fetch software sources from subversion repositories
13# @DESCRIPTION: 14# @DESCRIPTION:
14# The subversion eclass provides functions to fetch, patch and bootstrap 15# The subversion eclass provides functions to fetch, patch and bootstrap
15# software sources from subversion repositories. 16# software sources from subversion repositories.
16#
17# You must define the ESVN_REPO_URI variable before inheriting this eclass.
18 17
19inherit eutils 18inherit eutils
20 19
21ESVN="${ECLASS}" 20ESVN="${ECLASS}"
22 21
23EXPORT_FUNCTIONS src_unpack 22EXPORT_FUNCTIONS src_unpack pkg_preinst
24 23
25DESCRIPTION="Based on the ${ECLASS} eclass" 24DESCRIPTION="Based on the ${ECLASS} eclass"
26 25
27DEPEND="dev-util/subversion 26DEPEND="dev-util/subversion
28 net-misc/rsync" 27 net-misc/rsync"
39 38
40# @ECLASS-VARIABLE: ESVN_UPDATE_CMD 39# @ECLASS-VARIABLE: ESVN_UPDATE_CMD
41# @DESCRIPTION: 40# @DESCRIPTION:
42# subversion update command 41# subversion update command
43ESVN_UPDATE_CMD="svn update" 42ESVN_UPDATE_CMD="svn update"
43
44# @ECLASS-VARIABLE: ESVN_SWITCH_CMD
45# @DESCRIPTION:
46# subversion switch command
47ESVN_SWITCH_CMD="svn switch"
44 48
45# @ECLASS-VARIABLE: ESVN_OPTIONS 49# @ECLASS-VARIABLE: ESVN_OPTIONS
46# @DESCRIPTION: 50# @DESCRIPTION:
47# the options passed to checkout or update. If you want a specific revision see 51# the options passed to checkout or update. If you want a specific revision see
48# ESVN_REPO_URI instead of using -rREV. 52# ESVN_REPO_URI instead of using -rREV.
71# to a specific revision 75# to a specific revision
72# 76#
73# Note: This should never be set in an ebuild! 77# Note: This should never be set in an ebuild!
74ESVN_REVISION="${ESVN_REVISION:-}" 78ESVN_REVISION="${ESVN_REVISION:-}"
75 79
80# @ECLASS-VARIABLE: ESVN_USER
81# @DESCRIPTION:
82# User name
83ESVN_USER="${ESVN_USER:-}"
84
85# @ECLASS-VARIABLE: ESVN_PASSWORD
86# @DESCRIPTION:
87# Password
88ESVN_PASSWORD="${ESVN_PASSWORD:-}"
89
76# @ECLASS-VARIABLE: ESVN_PROJECT 90# @ECLASS-VARIABLE: ESVN_PROJECT
77# @DESCRIPTION: 91# @DESCRIPTION:
78# project name of your ebuild (= name space) 92# project name of your ebuild (= name space)
79# 93#
80# subversion eclass will check out the subversion repository like: 94# subversion eclass will check out the subversion repository like:
116# this should be a space delimited list of subversion eclass features to 130# this should be a space delimited list of subversion eclass features to
117# restrict. 131# restrict.
118# export) 132# export)
119# don't export the working copy to S. 133# don't export the working copy to S.
120ESVN_RESTRICT="${ESVN_RESTRICT:-}" 134ESVN_RESTRICT="${ESVN_RESTRICT:-}"
135
136# @ECLASS-VARIABLE: ESVN_OFFLINE
137# @DESCRIPTION:
138# Set this variable to a non-empty value to disable the automatic updating of
139# an svn source tree. This is intended to be set outside the subversion source
140# tree by users.
141ESVN_OFFLINE="${ESVN_OFFLINE:-${ESCM_OFFLINE}}"
142
143# @ECLASS-VARIABLE: ESVN_UP_FREQ
144# @DESCRIPTION:
145# Set the minimum number of hours between svn up'ing in any given svn module. This is particularly
146# useful for split KDE ebuilds where we want to ensure that all submodules are compiled for the same
147# revision. It should also be kept user overrideable.
148ESVN_UP_FREQ="${ESVN_UP_FREQ:=}"
149
150# @ECLASS-VARIABLE: ESCM_LOGDIR
151# @DESCRIPTION:
152# User configuration variable. If set to a path such as e.g. /var/log/scm any
153# package inheriting from subversion.eclass will record svn revision to
154# ${CATEGORY}/${PN}.log in that path in pkg_preinst. This is not supposed to be
155# set by ebuilds/eclasses. It defaults to empty so users need to opt in.
156ESCM_LOGDIR="${ESCM_LOGDIR:=}"
121 157
122# @FUNCTION: subversion_fetch 158# @FUNCTION: subversion_fetch
123# @USAGE: [repo_uri] [destination] 159# @USAGE: [repo_uri] [destination]
124# @DESCRIPTION: 160# @DESCRIPTION:
125# Wrapper function to fetch sources from subversion via svn checkout or svn update, 161# Wrapper function to fetch sources from subversion via svn checkout or svn update,
131subversion_fetch() { 167subversion_fetch() {
132 local repo_uri="$(subversion__get_repository_uri "${1:-${ESVN_REPO_URI}}")" 168 local repo_uri="$(subversion__get_repository_uri "${1:-${ESVN_REPO_URI}}")"
133 local revision="$(subversion__get_peg_revision "${1:-${ESVN_REPO_URI}}")" 169 local revision="$(subversion__get_peg_revision "${1:-${ESVN_REPO_URI}}")"
134 local S_dest="${2}" 170 local S_dest="${2}"
135 171
172 if [[ -z ${repo_uri} ]]; then
173 die "${ESVN}: ESVN_REPO_URI (or specified URI) is empty."
174 fi
175
136 [[ -n "${ESVN_REVISION}" ]] && revision="${ESVN_REVISION}" 176 [[ -n "${ESVN_REVISION}" ]] && revision="${ESVN_REVISION}"
137 177
138 # check for the protocol 178 # check for the protocol
139 local protocol="${repo_uri%%:*}" 179 local protocol="${repo_uri%%:*}"
140 180
141 case "${protocol}" in 181 case "${protocol}" in
142 http|https) 182 http|https)
183 if ! built_with_use --missing true -o dev-util/subversion webdav-neon webdav-serf || \
143 if built_with_use dev-util/subversion nowebdav; then 184 built_with_use --missing false dev-util/subversion nowebdav; then
144 echo 185 echo
145 eerror "In order to emerge this package, you need to" 186 eerror "In order to emerge this package, you need to"
146 eerror "re-emerge subversion with USE=-nowebdav" 187 eerror "reinstall Subversion with support for WebDAV."
188 eerror "Subversion requires either Neon or Serf to support WebDAV."
147 echo 189 echo
148 die "${ESVN}: please run 'USE=-nowebdav emerge subversion'" 190 die "${ESVN}: reinstall Subversion with support for WebDAV."
149 fi 191 fi
150 ;; 192 ;;
151 svn|svn+ssh) 193 svn|svn+ssh)
152 ;; 194 ;;
153 *) 195 *)
173 if [[ "${ESVN_OPTIONS}" = *-r* ]]; then 215 if [[ "${ESVN_OPTIONS}" = *-r* ]]; then
174 ewarn "\${ESVN_OPTIONS} contains -r, this usage is unsupported. Please" 216 ewarn "\${ESVN_OPTIONS} contains -r, this usage is unsupported. Please"
175 ewarn "see \${ESVN_REPO_URI}" 217 ewarn "see \${ESVN_REPO_URI}"
176 fi 218 fi
177 219
220 if has_version ">=dev-util/subversion-1.6.0"; then
221 options="${options} --config-option=config:auth:password-stores="
222 fi
223
178 debug-print "${FUNCNAME}: wc_path = \"${wc_path}\"" 224 debug-print "${FUNCNAME}: wc_path = \"${wc_path}\""
179 debug-print "${FUNCNAME}: ESVN_OPTIONS = \"${ESVN_OPTIONS}\"" 225 debug-print "${FUNCNAME}: ESVN_OPTIONS = \"${ESVN_OPTIONS}\""
180 debug-print "${FUNCNAME}: options = \"${options}\"" 226 debug-print "${FUNCNAME}: options = \"${options}\""
181 227
182 if [[ ! -d ${wc_path}/.svn ]]; then 228 if [[ ! -d ${wc_path}/.svn ]]; then
229 if [[ -n ${ESVN_OFFLINE} ]]; then
230 ewarn "ESVN_OFFLINE cannot be used when there is no existing checkout."
231 fi
183 # first check out 232 # first check out
184 einfo "subversion check out start -->" 233 einfo "subversion check out start -->"
185 einfo " repository: ${repo_uri}${revision:+@}${revision}" 234 einfo " repository: ${repo_uri}${revision:+@}${revision}"
186 235
187 debug-print "${FUNCNAME}: ${ESVN_FETCH_CMD} ${options} ${repo_uri}" 236 debug-print "${FUNCNAME}: ${ESVN_FETCH_CMD} ${options} ${repo_uri}"
188 237
189 mkdir -p "${ESVN_PROJECT}" || die "${ESVN}: can't mkdir ${ESVN_PROJECT}." 238 mkdir -p "${ESVN_PROJECT}" || die "${ESVN}: can't mkdir ${ESVN_PROJECT}."
190 cd "${ESVN_PROJECT}" || die "${ESVN}: can't chdir to ${ESVN_PROJECT}" 239 cd "${ESVN_PROJECT}" || die "${ESVN}: can't chdir to ${ESVN_PROJECT}"
240 if [[ -n "${ESVN_USER}" ]]; then
241 ${ESVN_FETCH_CMD} ${options} --username "${ESVN_USER}" --password "${ESVN_PASSWORD}" "${repo_uri}" || die "${ESVN}: can't fetch to ${wc_path} from ${repo_uri}."
242 else
191 ${ESVN_FETCH_CMD} ${options} "${repo_uri}" || die "${ESVN}: can't fetch from ${repo_uri}." 243 ${ESVN_FETCH_CMD} ${options} "${repo_uri}" || die "${ESVN}: can't fetch to ${wc_path} from ${repo_uri}."
244 fi
192 245
246 elif [[ -n ${ESVN_OFFLINE} ]]; then
247 svn cleanup "${wc_path}"
248 subversion_wc_info "${repo_uri}" || die "${ESVN}: unknown problem occurred while accessing working copy."
249 if [[ -n ${ESVN_REVISION} && ${ESVN_REVISION} != ${ESVN_WC_REVISION} ]]; then
250 die "${ESVN}: You requested off-line updating and revision ${ESVN_REVISION} but only revision ${ESVN_WC_REVISION} is available locally."
251 fi
252 einfo "Fetching disabled: Using existing repository copy at revision ${ESVN_WC_REVISION}."
193 else 253 else
254 svn cleanup "${wc_path}"
194 subversion_wc_info "${repo_uri}" || die "${ESVN}: unknown problem occurred while accessing working copy." 255 subversion_wc_info "${repo_uri}" || die "${ESVN}: unknown problem occurred while accessing working copy."
195 256
257 local esvn_up_freq=
258 if [[ -n ${ESVN_UP_FREQ} ]]; then
259 if [[ -n ${ESVN_UP_FREQ//[[:digit:]]} ]]; then
260 die "${ESVN}: ESVN_UP_FREQ must be an integer value corresponding to the minimum number of hours between svn up."
261 elif [[ -z $(find "${wc_path}/.svn/entries" -mmin "+$((ESVN_UP_FREQ*60))") ]]; then
262 einfo "Fetching disabled since ${ESVN_UP_FREQ} hours has not passed since last update."
263 einfo "Using existing repository copy at revision ${ESVN_WC_REVISION}."
264 esvn_up_freq=no_update
265 fi
266 fi
267
268 if [[ -z ${esvn_up_freq} ]]; then
196 if [[ ${ESVN_WC_URL} != $(subversion__get_repository_uri "${repo_uri}") ]]; then 269 if [[ ${ESVN_WC_URL} != $(subversion__get_repository_uri "${repo_uri}") ]]; then
197 die "${ESVN}: ESVN_REPO_URI (or specified URI) and working copy's URL are not matched." 270 einfo "subversion switch start -->"
271 einfo " old repository: ${ESVN_WC_URL}@${ESVN_WC_REVISION}"
272 einfo " new repository: ${repo_uri}${revision:+@}${revision}"
273
274 debug-print "${FUNCNAME}: ${ESVN_SWITCH_CMD} ${options} ${repo_uri}"
275
276 cd "${wc_path}" || die "${ESVN}: can't chdir to ${wc_path}"
277 if [[ -n "${ESVN_USER}" ]]; then
278 ${ESVN_SWITCH_CMD} ${options} --username "${ESVN_USER}" --password "${ESVN_PASSWORD}" ${repo_uri} || die "${ESVN}: can't update ${wc_path} from ${repo_uri}."
279 else
280 ${ESVN_SWITCH_CMD} ${options} ${repo_uri} || die "${ESVN}: can't update ${wc_path} from ${repo_uri}."
198 fi 281 fi
199 282 else
200 # update working copy 283 # update working copy
201 einfo "subversion update start -->" 284 einfo "subversion update start -->"
202 einfo " repository: ${repo_uri}${revision:+@}${revision}" 285 einfo " repository: ${repo_uri}${revision:+@}${revision}"
203 286
204 debug-print "${FUNCNAME}: ${ESVN_UPDATE_CMD} ${options}" 287 debug-print "${FUNCNAME}: ${ESVN_UPDATE_CMD} ${options}"
205 288
206 cd "${wc_path}" || die "${ESVN}: can't chdir to ${wc_path}" 289 cd "${wc_path}" || die "${ESVN}: can't chdir to ${wc_path}"
290 if [[ -n "${ESVN_USER}" ]]; then
291 ${ESVN_UPDATE_CMD} ${options} --username "${ESVN_USER}" --password "${ESVN_PASSWORD}" || die "${ESVN}: can't update ${wc_path} from ${repo_uri}."
292 else
207 ${ESVN_UPDATE_CMD} ${options} || die "${ESVN}: can't update from ${repo_uri}." 293 ${ESVN_UPDATE_CMD} ${options} || die "${ESVN}: can't update ${wc_path} from ${repo_uri}."
208 294 fi
295 fi
296 fi
209 fi 297 fi
210 298
211 einfo " working copy: ${wc_path}" 299 einfo " working copy: ${wc_path}"
212 300
213 if ! has "export" ${ESVN_RESTRICT}; then 301 if ! has "export" ${ESVN_RESTRICT}; then
214 cd "${wc_path}" || die "${ESVN}: can't chdir to ${wc_path}" 302 cd "${wc_path}" || die "${ESVN}: can't chdir to ${wc_path}"
215 303
216 local S="${S}/${S_dest}" 304 local S="${S}/${S_dest}"
305 mkdir -p "${S}"
217 306
218 # export to the ${WORKDIR} 307 # export to the ${WORKDIR}
219 #* "svn export" has a bug. see http://bugs.gentoo.org/119236 308 #* "svn export" has a bug. see http://bugs.gentoo.org/119236
220 #* svn export . "${S}" || die "${ESVN}: can't export to ${S}." 309 #* svn export . "${S}" || die "${ESVN}: can't export to ${S}."
221 rsync -rlpgo --exclude=".svn/" . "${S}" || die "${ESVN}: can't export to ${S}." 310 rsync -rlpgo --exclude=".svn/" . "${S}" || die "${ESVN}: can't export to ${S}."
290# Get svn info for the specified repo_uri. The default repo_uri is ESVN_REPO_URI. 379# Get svn info for the specified repo_uri. The default repo_uri is ESVN_REPO_URI.
291# 380#
292# The working copy information on the specified repository URI are set to 381# The working copy information on the specified repository URI are set to
293# ESVN_WC_* variables. 382# ESVN_WC_* variables.
294subversion_wc_info() { 383subversion_wc_info() {
295 local repo_uri="$(subversion__get_repository_uri "${1}")" 384 local repo_uri="$(subversion__get_repository_uri "${1:-${ESVN_REPO_URI}}")"
296 local wc_path="$(subversion__get_wc_path "${repo_uri}")" 385 local wc_path="$(subversion__get_wc_path "${repo_uri}")"
297 386
298 debug-print "${FUNCNAME}: repo_uri = ${repo_uri}" 387 debug-print "${FUNCNAME}: repo_uri = ${repo_uri}"
299 debug-print "${FUNCNAME}: wc_path = ${wc_path}" 388 debug-print "${FUNCNAME}: wc_path = ${wc_path}"
300 389
325 414
326## -- subversion__get_repository_uri() --------------------------------------- # 415## -- subversion__get_repository_uri() --------------------------------------- #
327# 416#
328# param $1 - a repository URI. 417# param $1 - a repository URI.
329subversion__get_repository_uri() { 418subversion__get_repository_uri() {
330 local repo_uri="${1}" 419 local repo_uri="${1}"
331 420
332 debug-print "${FUNCNAME}: repo_uri = ${repo_uri}" 421 debug-print "${FUNCNAME}: repo_uri = ${repo_uri}"
333 422
334 if [[ -z ${repo_uri} ]]; then 423 if [[ -z ${repo_uri} ]]; then
335 die "${ESVN}: ESVN_REPO_URI (or specified URI) is empty." 424 die "${ESVN}: ESVN_REPO_URI (or specified URI) is empty."
366 455
367 # repo_uri has peg revision ? 456 # repo_uri has peg revision ?
368 if [[ ${repo_uri} != *@* ]]; then 457 if [[ ${repo_uri} != *@* ]]; then
369 debug-print "${FUNCNAME}: repo_uri does not have a peg revision." 458 debug-print "${FUNCNAME}: repo_uri does not have a peg revision."
370 fi 459 fi
371 460
372 local peg_rev= 461 local peg_rev=
373 [[ ${repo_uri} = *@* ]] && peg_rev="${repo_uri##*@}" 462 [[ ${repo_uri} = *@* ]] && peg_rev="${repo_uri##*@}"
374 463
375 debug-print "${FUNCNAME}: peg_rev = ${peg_rev}" 464 debug-print "${FUNCNAME}: peg_rev = ${peg_rev}"
376 465
377 echo "${peg_rev}" 466 echo "${peg_rev}"
378} 467}
468
469# @FUNCTION: subversion_pkg_preinst
470# @USAGE: [repo_uri]
471# @DESCRIPTION:
472# Log the svn revision of source code. Doing this in pkg_preinst because we
473# want the logs to stick around if packages are uninstalled without messing with
474# config protection.
475subversion_pkg_preinst() {
476 local pkgdate=$(date "+%Y%m%d %H:%M:%S")
477 subversion_wc_info "${1:-${ESVN_REPO_URI}}"
478 if [[ -n ${ESCM_LOGDIR} ]]; then
479 local dir="${ROOT}/${ESCM_LOGDIR}/${CATEGORY}"
480 if [[ ! -d ${dir} ]]; then
481 mkdir -p "${dir}" || \
482 eerror "Failed to create '${dir}' for logging svn revision to '${PORTDIR_SCM}'"
483 fi
484 local logmessage="svn: ${pkgdate} - ${PF}:${SLOT} was merged at revision ${ESVN_WC_REVISION}"
485 if [[ -d ${dir} ]]; then
486 echo "${logmessage}" >> "${dir}/${PN}.log"
487 else
488 eerror "Could not log the message '${logmessage}' to '${dir}/${PN}.log'"
489 fi
490 fi
491}

Legend:
Removed from v.1.47  
changed lines
  Added in v.1.63

  ViewVC Help
Powered by ViewVC 1.1.20