/[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.59
1# Copyright 1999-2008 Gentoo Foundation 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.47 2008/02/20 17:55:27 cardoe Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/subversion.eclass,v 1.59 2008/05/15 13:27:40 zlin 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>
11# 11#
12# @BLURB: The subversion eclass is written to fetch software sources from subversion repositories 12# @BLURB: The subversion eclass is written to fetch software sources from subversion repositories
13# @DESCRIPTION: 13# @DESCRIPTION:
14# The subversion eclass provides functions to fetch, patch and bootstrap 14# The subversion eclass provides functions to fetch, patch and bootstrap
15# software sources from subversion repositories. 15# software sources from subversion repositories.
16#
17# You must define the ESVN_REPO_URI variable before inheriting this eclass.
18 16
19inherit eutils 17inherit eutils
20 18
21ESVN="${ECLASS}" 19ESVN="${ECLASS}"
22 20
23EXPORT_FUNCTIONS src_unpack 21EXPORT_FUNCTIONS src_unpack pkg_preinst
24 22
25DESCRIPTION="Based on the ${ECLASS} eclass" 23DESCRIPTION="Based on the ${ECLASS} eclass"
26 24
27DEPEND="dev-util/subversion 25DEPEND="dev-util/subversion
28 net-misc/rsync" 26 net-misc/rsync"
39 37
40# @ECLASS-VARIABLE: ESVN_UPDATE_CMD 38# @ECLASS-VARIABLE: ESVN_UPDATE_CMD
41# @DESCRIPTION: 39# @DESCRIPTION:
42# subversion update command 40# subversion update command
43ESVN_UPDATE_CMD="svn update" 41ESVN_UPDATE_CMD="svn update"
42
43# @ECLASS-VARIABLE: ESVN_SWITCH_CMD
44# @DESCRIPTION:
45# subversion switch command
46ESVN_SWITCH_CMD="svn switch"
44 47
45# @ECLASS-VARIABLE: ESVN_OPTIONS 48# @ECLASS-VARIABLE: ESVN_OPTIONS
46# @DESCRIPTION: 49# @DESCRIPTION:
47# the options passed to checkout or update. If you want a specific revision see 50# the options passed to checkout or update. If you want a specific revision see
48# ESVN_REPO_URI instead of using -rREV. 51# ESVN_REPO_URI instead of using -rREV.
116# this should be a space delimited list of subversion eclass features to 119# this should be a space delimited list of subversion eclass features to
117# restrict. 120# restrict.
118# export) 121# export)
119# don't export the working copy to S. 122# don't export the working copy to S.
120ESVN_RESTRICT="${ESVN_RESTRICT:-}" 123ESVN_RESTRICT="${ESVN_RESTRICT:-}"
124
125# @ECLASS-VARIABLE: ESVN_OFFLINE
126# @DESCRIPTION:
127# Set this variable to a non-empty value to disable the automatic updating of
128# an svn source tree. This is intended to be set outside the subversion source
129# tree by users.
130ESVN_OFFLINE="${ESVN_OFFLINE:-${ESCM_OFFLINE}}"
131
132# @ECLASS-VARIABLE: ESVN_UP_FREQ
133# @DESCRIPTION:
134# Set the minimum number of hours between svn up'ing in any given svn module. This is particularly
135# useful for split KDE ebuilds where we want to ensure that all submodules are compiled for the same
136# revision. It should also be kept user overrideable.
137ESVN_UP_FREQ="${ESVN_UP_FREQ:=}"
138
139# @ECLASS-VARIABLE: ESCM_LOGDIR
140# @DESCRIPTION:
141# User configuration variable. If set to a path such as e.g. /var/log/scm any
142# package inheriting from subversion.eclass will record svn revision to
143# ${CATEGORY}/${PN}.log in that path in pkg_preinst. This is not supposed to be
144# set by ebuilds/eclasses. It defaults to empty so users need to opt in.
145ESCM_LOGDIR="${ESCM_LOGDIR:=}"
121 146
122# @FUNCTION: subversion_fetch 147# @FUNCTION: subversion_fetch
123# @USAGE: [repo_uri] [destination] 148# @USAGE: [repo_uri] [destination]
124# @DESCRIPTION: 149# @DESCRIPTION:
125# Wrapper function to fetch sources from subversion via svn checkout or svn update, 150# Wrapper function to fetch sources from subversion via svn checkout or svn update,
131subversion_fetch() { 156subversion_fetch() {
132 local repo_uri="$(subversion__get_repository_uri "${1:-${ESVN_REPO_URI}}")" 157 local repo_uri="$(subversion__get_repository_uri "${1:-${ESVN_REPO_URI}}")"
133 local revision="$(subversion__get_peg_revision "${1:-${ESVN_REPO_URI}}")" 158 local revision="$(subversion__get_peg_revision "${1:-${ESVN_REPO_URI}}")"
134 local S_dest="${2}" 159 local S_dest="${2}"
135 160
161 if [[ -z ${repo_uri} ]]; then
162 die "${ESVN}: ESVN_REPO_URI (or specified URI) is empty."
163 fi
164
136 [[ -n "${ESVN_REVISION}" ]] && revision="${ESVN_REVISION}" 165 [[ -n "${ESVN_REVISION}" ]] && revision="${ESVN_REVISION}"
137 166
138 # check for the protocol 167 # check for the protocol
139 local protocol="${repo_uri%%:*}" 168 local protocol="${repo_uri%%:*}"
140 169
141 case "${protocol}" in 170 case "${protocol}" in
142 http|https) 171 http|https)
172 if ! built_with_use --missing true -o dev-util/subversion webdav-neon webdav-serf || \
143 if built_with_use dev-util/subversion nowebdav; then 173 built_with_use --missing false dev-util/subversion nowebdav ; then
144 echo 174 echo
145 eerror "In order to emerge this package, you need to" 175 eerror "In order to emerge this package, you need to"
146 eerror "re-emerge subversion with USE=-nowebdav" 176 eerror "reinstall Subversion with support for WebDAV."
177 eerror "Subversion requires either Neon or Serf to support WebDAV."
147 echo 178 echo
148 die "${ESVN}: please run 'USE=-nowebdav emerge subversion'" 179 die "${ESVN}: reinstall Subversion with support for WebDAV."
149 fi 180 fi
150 ;; 181 ;;
151 svn|svn+ssh) 182 svn|svn+ssh)
152 ;; 183 ;;
153 *) 184 *)
178 debug-print "${FUNCNAME}: wc_path = \"${wc_path}\"" 209 debug-print "${FUNCNAME}: wc_path = \"${wc_path}\""
179 debug-print "${FUNCNAME}: ESVN_OPTIONS = \"${ESVN_OPTIONS}\"" 210 debug-print "${FUNCNAME}: ESVN_OPTIONS = \"${ESVN_OPTIONS}\""
180 debug-print "${FUNCNAME}: options = \"${options}\"" 211 debug-print "${FUNCNAME}: options = \"${options}\""
181 212
182 if [[ ! -d ${wc_path}/.svn ]]; then 213 if [[ ! -d ${wc_path}/.svn ]]; then
214 if [[ -n ${ESVN_OFFLINE} ]]; then
215 ewarn "ESVN_OFFLINE cannot be used when the there is no existing checkout."
216 fi
183 # first check out 217 # first check out
184 einfo "subversion check out start -->" 218 einfo "subversion check out start -->"
185 einfo " repository: ${repo_uri}${revision:+@}${revision}" 219 einfo " repository: ${repo_uri}${revision:+@}${revision}"
186 220
187 debug-print "${FUNCNAME}: ${ESVN_FETCH_CMD} ${options} ${repo_uri}" 221 debug-print "${FUNCNAME}: ${ESVN_FETCH_CMD} ${options} ${repo_uri}"
188 222
189 mkdir -p "${ESVN_PROJECT}" || die "${ESVN}: can't mkdir ${ESVN_PROJECT}." 223 mkdir -p "${ESVN_PROJECT}" || die "${ESVN}: can't mkdir ${ESVN_PROJECT}."
190 cd "${ESVN_PROJECT}" || die "${ESVN}: can't chdir to ${ESVN_PROJECT}" 224 cd "${ESVN_PROJECT}" || die "${ESVN}: can't chdir to ${ESVN_PROJECT}"
191 ${ESVN_FETCH_CMD} ${options} "${repo_uri}" || die "${ESVN}: can't fetch from ${repo_uri}." 225 ${ESVN_FETCH_CMD} ${options} "${repo_uri}" || die "${ESVN}: can't fetch to ${wc_path} from ${repo_uri}."
192 226
227 elif [[ -n ${ESVN_OFFLINE} ]]; then
228 subversion_wc_info "${repo_uri}" || die "${ESVN}: unknown problem occurred while accessing working copy."
229 if [[ -n ${ESVN_REVISION} && ${ESVN_REVISION} != ${ESVN_WC_REVISION} ]]; then
230 die "${ESVN}: You requested off-line updating and revision ${ESVN_REVISION} but only revision ${ESVN_WC_REVISION} is available locally."
231 fi
232 einfo "Fetching disabled: Using existing repository copy at revision ${ESVN_WC_REVISION}."
193 else 233 else
194 subversion_wc_info "${repo_uri}" || die "${ESVN}: unknown problem occurred while accessing working copy." 234 subversion_wc_info "${repo_uri}" || die "${ESVN}: unknown problem occurred while accessing working copy."
195 235
236 local esvn_up_freq=
237 if [[ -n ${ESVN_UP_FREQ} ]]; then
238 if [[ -n ${ESVN_UP_FREQ//[[:digit:]]} ]]; then
239 die "${ESVN}: ESVN_UP_FREQ must be an integer value corresponding to the minimum number of hours between svn up."
240 elif [[ -z $(find "${wc_path}/.svn/entries" -mmin "+$((ESVN_UP_FREQ*60))") ]]; then
241 einfo "Fetching disabled since ${ESVN_UP_FREQ} hours has not passed since last update."
242 einfo "Using existing repository copy at revision ${ESVN_WC_REVISION}."
243 esvn_up_freq=no_update
244 fi
245 fi
246
247 if [[ -z ${esvn_up_freq} ]]; then
196 if [[ ${ESVN_WC_URL} != $(subversion__get_repository_uri "${repo_uri}") ]]; then 248 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." 249 einfo "subversion switch start -->"
198 fi 250 einfo " old repository: ${ESVN_WC_URL}@${ESVN_WC_REVISION}"
251 einfo " new repository: ${repo_uri}${revision:+@}${revision}"
199 252
253 debug-print "${FUNCNAME}: ${ESVN_SWITCH_CMD} ${options} ${repo_uri}"
254
255 cd "${wc_path}" || die "${ESVN}: can't chdir to ${wc_path}"
256 ${ESVN_SWITCH_CMD} ${options} ${repo_uri} || die "${ESVN}: can't update ${wc_path} from ${repo_uri}"
257 else
200 # update working copy 258 # update working copy
201 einfo "subversion update start -->" 259 einfo "subversion update start -->"
202 einfo " repository: ${repo_uri}${revision:+@}${revision}" 260 einfo " repository: ${repo_uri}${revision:+@}${revision}"
203 261
204 debug-print "${FUNCNAME}: ${ESVN_UPDATE_CMD} ${options}" 262 debug-print "${FUNCNAME}: ${ESVN_UPDATE_CMD} ${options}"
205 263
206 cd "${wc_path}" || die "${ESVN}: can't chdir to ${wc_path}" 264 cd "${wc_path}" || die "${ESVN}: can't chdir to ${wc_path}"
207 ${ESVN_UPDATE_CMD} ${options} || die "${ESVN}: can't update from ${repo_uri}." 265 ${ESVN_UPDATE_CMD} ${options} || die "${ESVN}: can't update ${wc_path} from ${repo_uri}."
208 266 fi
267 fi
209 fi 268 fi
210 269
211 einfo " working copy: ${wc_path}" 270 einfo " working copy: ${wc_path}"
212 271
213 if ! has "export" ${ESVN_RESTRICT}; then 272 if ! has "export" ${ESVN_RESTRICT}; then
290# Get svn info for the specified repo_uri. The default repo_uri is ESVN_REPO_URI. 349# Get svn info for the specified repo_uri. The default repo_uri is ESVN_REPO_URI.
291# 350#
292# The working copy information on the specified repository URI are set to 351# The working copy information on the specified repository URI are set to
293# ESVN_WC_* variables. 352# ESVN_WC_* variables.
294subversion_wc_info() { 353subversion_wc_info() {
295 local repo_uri="$(subversion__get_repository_uri "${1}")" 354 local repo_uri="$(subversion__get_repository_uri "${1:-${ESVN_REPO_URI}}")"
296 local wc_path="$(subversion__get_wc_path "${repo_uri}")" 355 local wc_path="$(subversion__get_wc_path "${repo_uri}")"
297 356
298 debug-print "${FUNCNAME}: repo_uri = ${repo_uri}" 357 debug-print "${FUNCNAME}: repo_uri = ${repo_uri}"
299 debug-print "${FUNCNAME}: wc_path = ${wc_path}" 358 debug-print "${FUNCNAME}: wc_path = ${wc_path}"
300 359
325 384
326## -- subversion__get_repository_uri() --------------------------------------- # 385## -- subversion__get_repository_uri() --------------------------------------- #
327# 386#
328# param $1 - a repository URI. 387# param $1 - a repository URI.
329subversion__get_repository_uri() { 388subversion__get_repository_uri() {
330 local repo_uri="${1}" 389 local repo_uri="${1}"
331 390
332 debug-print "${FUNCNAME}: repo_uri = ${repo_uri}" 391 debug-print "${FUNCNAME}: repo_uri = ${repo_uri}"
333 392
334 if [[ -z ${repo_uri} ]]; then 393 if [[ -z ${repo_uri} ]]; then
335 die "${ESVN}: ESVN_REPO_URI (or specified URI) is empty." 394 die "${ESVN}: ESVN_REPO_URI (or specified URI) is empty."
366 425
367 # repo_uri has peg revision ? 426 # repo_uri has peg revision ?
368 if [[ ${repo_uri} != *@* ]]; then 427 if [[ ${repo_uri} != *@* ]]; then
369 debug-print "${FUNCNAME}: repo_uri does not have a peg revision." 428 debug-print "${FUNCNAME}: repo_uri does not have a peg revision."
370 fi 429 fi
371 430
372 local peg_rev= 431 local peg_rev=
373 [[ ${repo_uri} = *@* ]] && peg_rev="${repo_uri##*@}" 432 [[ ${repo_uri} = *@* ]] && peg_rev="${repo_uri##*@}"
374 433
375 debug-print "${FUNCNAME}: peg_rev = ${peg_rev}" 434 debug-print "${FUNCNAME}: peg_rev = ${peg_rev}"
376 435
377 echo "${peg_rev}" 436 echo "${peg_rev}"
378} 437}
438
439# @FUNCTION: subversion_pkg_preinst
440# @USAGE: [repo_uri]
441# @DESCRIPTION:
442# Log the svn revision of source code. Doing this in pkg_preinst because we
443# want the logs to stick around if packages are uninstalled without messing with
444# config protection.
445subversion_pkg_preinst() {
446 local pkgdate=$(date "+%Y%m%d %H:%M:%S")
447 subversion_wc_info "${1:-${ESVN_REPO_URI}}"
448 if [[ -n ${ESCM_LOGDIR} ]]; then
449 local dir="${ROOT}/${ESCM_LOGDIR}/${CATEGORY}"
450 if [[ ! -d ${dir} ]]; then
451 mkdir -p "${dir}" || \
452 eerror "Failed to create '${dir}' for logging svn revision to '${PORTDIR_SCM}'"
453 fi
454 local logmessage="svn: ${pkgdate} - ${PF}:${SLOT} was merged at revision ${ESVN_WC_REVISION}"
455 if [[ -d ${dir} ]]; then
456 echo "${logmessage}" >> "${dir}/${PN}.log"
457 else
458 eerror "Could not log the message '${logmessage}' to '${dir}/${PN}.log'"
459 fi
460 fi
461}

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

  ViewVC Help
Powered by ViewVC 1.1.20