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

Contents of /eclass/subversion.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.47 - (show annotations) (download)
Wed Feb 20 17:55:27 2008 UTC (6 years, 8 months ago) by cardoe
Branch: MAIN
Changes since 1.46: +39 -54 lines
Add ESVN_REVISION support. Remove problematic to_upper function. Provide revision data to user. Provide more working copy info via ESVN_WC_* variables. All this couldn't have been done without kojiro's help.

1 # Copyright 1999-2008 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.46 2008/02/20 17:11:34 zlin Exp $
4
5 # @ECLASS: subversion.eclass
6 # @MAINTAINER:
7 # Akinori Hattori <hattya@gentoo.org>
8 # Bo ├śrsted Andresen <zlin@gentoo.org>
9 #
10 # Original Author: Akinori Hattori <hattya@gentoo.org>
11 #
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 # You must define the ESVN_REPO_URI variable before inheriting this eclass.
18
19 inherit eutils
20
21 ESVN="${ECLASS}"
22
23 EXPORT_FUNCTIONS src_unpack
24
25 DESCRIPTION="Based on the ${ECLASS} eclass"
26
27 DEPEND="dev-util/subversion
28 net-misc/rsync"
29
30 # @ECLASS-VARIABLE: ESVN_STORE_DIR
31 # @DESCRIPTION:
32 # subversion sources store directory. Users may override this in /etc/make.conf
33 [[ -z ${ESVN_STORE_DIR} ]] && ESVN_STORE_DIR="${PORTAGE_ACTUAL_DISTDIR:-${DISTDIR}}/svn-src"
34
35 # @ECLASS-VARIABLE: ESVN_FETCH_CMD
36 # @DESCRIPTION:
37 # subversion checkout command
38 ESVN_FETCH_CMD="svn checkout"
39
40 # @ECLASS-VARIABLE: ESVN_UPDATE_CMD
41 # @DESCRIPTION:
42 # subversion update command
43 ESVN_UPDATE_CMD="svn update"
44
45 # @ECLASS-VARIABLE: ESVN_OPTIONS
46 # @DESCRIPTION:
47 # the options passed to checkout or update. If you want a specific revision see
48 # ESVN_REPO_URI instead of using -rREV.
49 ESVN_OPTIONS="${ESVN_OPTIONS:-}"
50
51 # @ECLASS-VARIABLE: ESVN_REPO_URI
52 # @DESCRIPTION:
53 # repository uri
54 #
55 # e.g. http://foo/trunk, svn://bar/trunk, svn://bar/branch/foo@1234
56 #
57 # supported protocols:
58 # http://
59 # https://
60 # svn://
61 # svn+ssh://
62 #
63 # to peg to a specific revision, append @REV to the repo's uri
64 ESVN_REPO_URI="${ESVN_REPO_URI:-}"
65
66 # @ECLASS-VARIABLE: ESVN_REVISION
67 # @DESCRIPTION:
68 # User configurable revision checkout or update to from the repository
69 #
70 # Useful for live svn or trunk svn ebuilds allowing the user to peg
71 # to a specific revision
72 #
73 # Note: This should never be set in an ebuild!
74 ESVN_REVISION="${ESVN_REVISION:-}"
75
76 # @ECLASS-VARIABLE: ESVN_PROJECT
77 # @DESCRIPTION:
78 # project name of your ebuild (= name space)
79 #
80 # subversion eclass will check out the subversion repository like:
81 #
82 # ${ESVN_STORE_DIR}/${ESVN_PROJECT}/${ESVN_REPO_URI##*/}
83 #
84 # so if you define ESVN_REPO_URI as http://svn.collab.net/repo/svn/trunk or
85 # http://svn.collab.net/repo/svn/trunk/. and PN is subversion-svn.
86 # it will check out like:
87 #
88 # ${ESVN_STORE_DIR}/subversion/trunk
89 #
90 # this is not used in order to declare the name of the upstream project.
91 # so that you can declare this like:
92 #
93 # # jakarta commons-loggin
94 # ESVN_PROJECT=commons/logging
95 #
96 # default: ${PN/-svn}.
97 ESVN_PROJECT="${ESVN_PROJECT:-${PN/-svn}}"
98
99 # @ECLASS-VARIABLE: ESVN_BOOTSTRAP
100 # @DESCRIPTION:
101 # bootstrap script or command like autogen.sh or etc..
102 ESVN_BOOTSTRAP="${ESVN_BOOTSTRAP:-}"
103
104 # @ECLASS-VARIABLE: ESVN_PATCHES
105 # @DESCRIPTION:
106 # subversion eclass can apply patches in subversion_bootstrap().
107 # you can use regexp in this variable like *.diff or *.patch or etc.
108 # NOTE: patches will be applied before ESVN_BOOTSTRAP is processed.
109 #
110 # Patches are searched both in ${PWD} and ${FILESDIR}, if not found in either
111 # location, the installation dies.
112 ESVN_PATCHES="${ESVN_PATCHES:-}"
113
114 # @ECLASS-VARIABLE: ESVN_RESTRICT
115 # @DESCRIPTION:
116 # this should be a space delimited list of subversion eclass features to
117 # restrict.
118 # export)
119 # don't export the working copy to S.
120 ESVN_RESTRICT="${ESVN_RESTRICT:-}"
121
122 # @FUNCTION: subversion_fetch
123 # @USAGE: [repo_uri] [destination]
124 # @DESCRIPTION:
125 # Wrapper function to fetch sources from subversion via svn checkout or svn update,
126 # depending on whether there is an existing working copy in ${ESVN_STORE_DIR}.
127 #
128 # Can take two optional parameters:
129 # repo_uri - a repository URI. default is ESVN_REPO_URI.
130 # destination - a check out path in S.
131 subversion_fetch() {
132 local repo_uri="$(subversion__get_repository_uri "${1:-${ESVN_REPO_URI}}")"
133 local revision="$(subversion__get_peg_revision "${1:-${ESVN_REPO_URI}}")"
134 local S_dest="${2}"
135
136 [[ -n "${ESVN_REVISION}" ]] && revision="${ESVN_REVISION}"
137
138 # check for the protocol
139 local protocol="${repo_uri%%:*}"
140
141 case "${protocol}" in
142 http|https)
143 if built_with_use dev-util/subversion nowebdav; then
144 echo
145 eerror "In order to emerge this package, you need to"
146 eerror "re-emerge subversion with USE=-nowebdav"
147 echo
148 die "${ESVN}: please run 'USE=-nowebdav emerge subversion'"
149 fi
150 ;;
151 svn|svn+ssh)
152 ;;
153 *)
154 die "${ESVN}: fetch from '${protocol}' is not yet implemented."
155 ;;
156 esac
157
158 addread "/etc/subversion"
159 addwrite "${ESVN_STORE_DIR}"
160
161 if [[ ! -d ${ESVN_STORE_DIR} ]]; then
162 debug-print "${FUNCNAME}: initial checkout. creating subversion directory"
163 mkdir -p "${ESVN_STORE_DIR}" || die "${ESVN}: can't mkdir ${ESVN_STORE_DIR}."
164 fi
165
166 cd "${ESVN_STORE_DIR}" || die "${ESVN}: can't chdir to ${ESVN_STORE_DIR}"
167
168 local wc_path="$(subversion__get_wc_path "${repo_uri}")"
169 local options="${ESVN_OPTIONS} --config-dir ${ESVN_STORE_DIR}/.subversion"
170
171 [[ -n "${revision}" ]] && options="${options} -r ${revision}"
172
173 if [[ "${ESVN_OPTIONS}" = *-r* ]]; then
174 ewarn "\${ESVN_OPTIONS} contains -r, this usage is unsupported. Please"
175 ewarn "see \${ESVN_REPO_URI}"
176 fi
177
178 debug-print "${FUNCNAME}: wc_path = \"${wc_path}\""
179 debug-print "${FUNCNAME}: ESVN_OPTIONS = \"${ESVN_OPTIONS}\""
180 debug-print "${FUNCNAME}: options = \"${options}\""
181
182 if [[ ! -d ${wc_path}/.svn ]]; then
183 # first check out
184 einfo "subversion check out start -->"
185 einfo " repository: ${repo_uri}${revision:+@}${revision}"
186
187 debug-print "${FUNCNAME}: ${ESVN_FETCH_CMD} ${options} ${repo_uri}"
188
189 mkdir -p "${ESVN_PROJECT}" || die "${ESVN}: can't mkdir ${ESVN_PROJECT}."
190 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}."
192
193 else
194 subversion_wc_info "${repo_uri}" || die "${ESVN}: unknown problem occurred while accessing working copy."
195
196 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."
198 fi
199
200 # update working copy
201 einfo "subversion update start -->"
202 einfo " repository: ${repo_uri}${revision:+@}${revision}"
203
204 debug-print "${FUNCNAME}: ${ESVN_UPDATE_CMD} ${options}"
205
206 cd "${wc_path}" || die "${ESVN}: can't chdir to ${wc_path}"
207 ${ESVN_UPDATE_CMD} ${options} || die "${ESVN}: can't update from ${repo_uri}."
208
209 fi
210
211 einfo " working copy: ${wc_path}"
212
213 if ! has "export" ${ESVN_RESTRICT}; then
214 cd "${wc_path}" || die "${ESVN}: can't chdir to ${wc_path}"
215
216 local S="${S}/${S_dest}"
217
218 # export to the ${WORKDIR}
219 #* "svn export" has a bug. see http://bugs.gentoo.org/119236
220 #* svn export . "${S}" || die "${ESVN}: can't export to ${S}."
221 rsync -rlpgo --exclude=".svn/" . "${S}" || die "${ESVN}: can't export to ${S}."
222 fi
223
224 echo
225 }
226
227 # @FUNCTION: subversion_bootstrap
228 # @DESCRIPTION:
229 # Apply patches in ${ESVN_PATCHES} and run ${ESVN_BOOTSTRAP} if specified.
230 subversion_bootstrap() {
231 if has "export" ${ESVN_RESTRICT}; then
232 return
233 fi
234
235 cd "${S}"
236
237 if [[ -n ${ESVN_PATCHES} ]]; then
238 einfo "apply patches -->"
239
240 local patch fpatch
241
242 for patch in ${ESVN_PATCHES}; do
243 if [[ -f ${patch} ]]; then
244 epatch "${patch}"
245
246 else
247 for fpatch in ${FILESDIR}/${patch}; do
248 if [[ -f ${fpatch} ]]; then
249 epatch "${fpatch}"
250
251 else
252 die "${ESVN}: ${patch} not found"
253
254 fi
255 done
256
257 fi
258 done
259
260 echo
261 fi
262
263 if [[ -n ${ESVN_BOOTSTRAP} ]]; then
264 einfo "begin bootstrap -->"
265
266 if [[ -f ${ESVN_BOOTSTRAP} && -x ${ESVN_BOOTSTRAP} ]]; then
267 einfo " bootstrap with a file: ${ESVN_BOOTSTRAP}"
268 eval "./${ESVN_BOOTSTRAP}" || die "${ESVN}: can't execute ESVN_BOOTSTRAP."
269
270 else
271 einfo " bootstrap with command: ${ESVN_BOOTSTRAP}"
272 eval "${ESVN_BOOTSTRAP}" || die "${ESVN}: can't eval ESVN_BOOTSTRAP."
273
274 fi
275 fi
276 }
277
278 # @FUNCTION: subversion_src_unpack
279 # @DESCRIPTION:
280 # default src_unpack. fetch and bootstrap.
281 subversion_src_unpack() {
282 subversion_fetch || die "${ESVN}: unknown problem occurred in subversion_fetch."
283 subversion_bootstrap || die "${ESVN}: unknown problem occurred in subversion_bootstrap."
284 }
285
286 # @FUNCTION: subversion_wc_info
287 # @USAGE: [repo_uri]
288 # @RETURN: ESVN_WC_URL, ESVN_WC_ROOT, ESVN_WC_UUID, ESVN_WC_REVISION and ESVN_WC_PATH
289 # @DESCRIPTION:
290 # Get svn info for the specified repo_uri. The default repo_uri is ESVN_REPO_URI.
291 #
292 # The working copy information on the specified repository URI are set to
293 # ESVN_WC_* variables.
294 subversion_wc_info() {
295 local repo_uri="$(subversion__get_repository_uri "${1}")"
296 local wc_path="$(subversion__get_wc_path "${repo_uri}")"
297
298 debug-print "${FUNCNAME}: repo_uri = ${repo_uri}"
299 debug-print "${FUNCNAME}: wc_path = ${wc_path}"
300
301 if [[ ! -d ${wc_path} ]]; then
302 return 1
303 fi
304
305 export ESVN_WC_URL="$(subversion__svn_info "${wc_path}" "URL")"
306 export ESVN_WC_ROOT="$(subversion__svn_info "${wc_path}" "Repository Root")"
307 export ESVN_WC_UUID="$(subversion__svn_info "${wc_path}" "Repository UUID")"
308 export ESVN_WC_REVISION="$(subversion__svn_info "${wc_path}" "Revision")"
309 export ESVN_WC_PATH="${wc_path}"
310 }
311
312 ## -- Private Functions
313
314 ## -- subversion__svn_info() ------------------------------------------------- #
315 #
316 # param $1 - a target.
317 # param $2 - a key name.
318 #
319 subversion__svn_info() {
320 local target="${1}"
321 local key="${2}"
322
323 env LC_ALL=C svn info "${target}" | grep -i "^${key}" | cut -d" " -f2-
324 }
325
326 ## -- subversion__get_repository_uri() --------------------------------------- #
327 #
328 # param $1 - a repository URI.
329 subversion__get_repository_uri() {
330 local repo_uri="${1}"
331
332 debug-print "${FUNCNAME}: repo_uri = ${repo_uri}"
333
334 if [[ -z ${repo_uri} ]]; then
335 die "${ESVN}: ESVN_REPO_URI (or specified URI) is empty."
336 fi
337
338 # delete trailing slash
339 if [[ -z ${repo_uri##*/} ]]; then
340 repo_uri="${repo_uri%/}"
341 fi
342
343 repo_uri="${repo_uri%@*}"
344
345 echo "${repo_uri}"
346 }
347
348 ## -- subversion__get_wc_path() ---------------------------------------------- #
349 #
350 # param $1 - a repository URI.
351 subversion__get_wc_path() {
352 local repo_uri="$(subversion__get_repository_uri "${1}")"
353
354 debug-print "${FUNCNAME}: repo_uri = ${repo_uri}"
355
356 echo "${ESVN_STORE_DIR}/${ESVN_PROJECT}/${repo_uri##*/}"
357 }
358
359 ## -- subversion__get_peg_revision() ----------------------------------------- #
360 #
361 # param $1 - a repository URI.
362 subversion__get_peg_revision() {
363 local repo_uri="${1}"
364
365 debug-print "${FUNCNAME}: repo_uri = ${repo_uri}"
366
367 # repo_uri has peg revision ?
368 if [[ ${repo_uri} != *@* ]]; then
369 debug-print "${FUNCNAME}: repo_uri does not have a peg revision."
370 fi
371
372 local peg_rev=
373 [[ ${repo_uri} = *@* ]] && peg_rev="${repo_uri##*@}"
374
375 debug-print "${FUNCNAME}: peg_rev = ${peg_rev}"
376
377 echo "${peg_rev}"
378 }

  ViewVC Help
Powered by ViewVC 1.1.20