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

Contents of /eclass/subversion.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.46 - (show annotations) (download)
Wed Feb 20 17:11:34 2008 UTC (6 years, 5 months ago) by zlin
Branch: MAIN
Changes since 1.45: +104 -142 lines
Document subversion.eclass for use with eclass-manpages. Add myself to maintainers.

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.45 2008/02/17 07:59:06 hattya 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_PROJECT
67 # @DESCRIPTION:
68 # project name of your ebuild (= name space)
69 #
70 # subversion eclass will check out the subversion repository like:
71 #
72 # ${ESVN_STORE_DIR}/${ESVN_PROJECT}/${ESVN_REPO_URI##*/}
73 #
74 # so if you define ESVN_REPO_URI as http://svn.collab.net/repo/svn/trunk or
75 # http://svn.collab.net/repo/svn/trunk/. and PN is subversion-svn.
76 # it will check out like:
77 #
78 # ${ESVN_STORE_DIR}/subversion/trunk
79 #
80 # this is not used in order to declare the name of the upstream project.
81 # so that you can declare this like:
82 #
83 # # jakarta commons-loggin
84 # ESVN_PROJECT=commons/logging
85 #
86 # default: ${PN/-svn}.
87 ESVN_PROJECT="${ESVN_PROJECT:-${PN/-svn}}"
88
89 # @ECLASS-VARIABLE: ESVN_BOOTSTRAP
90 # @DESCRIPTION:
91 # bootstrap script or command like autogen.sh or etc..
92 ESVN_BOOTSTRAP="${ESVN_BOOTSTRAP:-}"
93
94 # @ECLASS-VARIABLE: ESVN_PATCHES
95 # @DESCRIPTION:
96 # subversion eclass can apply patches in subversion_bootstrap().
97 # you can use regexp in this variable like *.diff or *.patch or etc.
98 # NOTE: patches will be applied before ESVN_BOOTSTRAP is processed.
99 #
100 # Patches are searched both in ${PWD} and ${FILESDIR}, if not found in either
101 # location, the installation dies.
102 ESVN_PATCHES="${ESVN_PATCHES:-}"
103
104 # @ECLASS-VARIABLE: ESVN_RESTRICT
105 # @DESCRIPTION:
106 # this should be a space delimited list of subversion eclass features to
107 # restrict.
108 # export)
109 # don't export the working copy to S.
110 ESVN_RESTRICT="${ESVN_RESTRICT:-}"
111
112 # @FUNCTION: subversion_fetch
113 # @USAGE: [repo_uri] [destination]
114 # @DESCRIPTION:
115 # Wrapper function to fetch sources from subversion via svn checkout or svn update,
116 # depending on whether there is an existing working copy in ${ESVN_STORE_DIR}.
117 #
118 # Can take two optional parameters:
119 # repo_uri - a repository URI. default is ESVN_REPO_URI.
120 # destination - a check out path in S.
121 subversion_fetch() {
122 local repo_uri="$(subversion__get_repository_uri "${1}")"
123 local S_dest="${2}"
124
125 # check for the protocol
126 local protocol="${repo_uri%%:*}"
127
128 case "${protocol}" in
129 http|https)
130 if built_with_use dev-util/subversion nowebdav; then
131 echo
132 eerror "In order to emerge this package, you need to"
133 eerror "re-emerge subversion with USE=-nowebdav"
134 echo
135 die "${ESVN}: please run 'USE=-nowebdav emerge subversion'"
136 fi
137 ;;
138 svn|svn+ssh)
139 ;;
140 *)
141 die "${ESVN}: fetch from '${protocol}' is not yet implemented."
142 ;;
143 esac
144
145 addread "/etc/subversion"
146 addwrite "${ESVN_STORE_DIR}"
147
148 if [[ ! -d ${ESVN_STORE_DIR} ]]; then
149 debug-print "${FUNCNAME}: initial checkout. creating subversion directory"
150 mkdir -p "${ESVN_STORE_DIR}" || die "${ESVN}: can't mkdir ${ESVN_STORE_DIR}."
151 fi
152
153 cd "${ESVN_STORE_DIR}" || die "${ESVN}: can't chdir to ${ESVN_STORE_DIR}"
154
155 local wc_path="$(subversion__get_wc_path "${repo_uri}")"
156 local options="${ESVN_OPTIONS} --config-dir ${ESVN_STORE_DIR}/.subversion"
157
158 debug-print "${FUNCNAME}: wc_path = \"${wc_path}\""
159 debug-print "${FUNCNAME}: ESVN_OPTIONS = \"${ESVN_OPTIONS}\""
160 debug-print "${FUNCNAME}: options = \"${options}\""
161
162 if [[ ! -d ${wc_path}/.svn ]]; then
163 # first check out
164 einfo "subversion check out start -->"
165 einfo " repository: ${repo_uri}"
166
167 debug-print "${FUNCNAME}: ${ESVN_FETCH_CMD} ${options} ${repo_uri}"
168
169 mkdir -p "${ESVN_PROJECT}" || die "${ESVN}: can't mkdir ${ESVN_PROJECT}."
170 cd "${ESVN_PROJECT}" || die "${ESVN}: can't chdir to ${ESVN_PROJECT}"
171 ${ESVN_FETCH_CMD} ${options} "${repo_uri}" || die "${ESVN}: can't fetch from ${repo_uri}."
172
173 else
174 subversion_wc_info "${repo_uri}" || die "${ESVN}: unknown problem occurred while accessing working copy."
175
176 if [[ ${ESVN_WC_URL} != $(subversion__get_repository_uri "${repo_uri}" 1) ]]; then
177 die "${ESVN}: ESVN_REPO_URI (or specified URI) and working copy's URL are not matched."
178 fi
179
180 # update working copy
181 einfo "subversion update start -->"
182 einfo " repository: ${repo_uri}"
183
184 debug-print "${FUNCNAME}: ${ESVN_UPDATE_CMD} ${options}"
185
186 cd "${wc_path}" || die "${ESVN}: can't chdir to ${wc_path}"
187 ${ESVN_UPDATE_CMD} ${options} || die "${ESVN}: can't update from ${repo_uri}."
188
189 fi
190
191 einfo " working copy: ${wc_path}"
192
193 if ! has "export" ${ESVN_RESTRICT}; then
194 cd "${wc_path}" || die "${ESVN}: can't chdir to ${wc_path}"
195
196 local S="${S}/${S_dest}"
197
198 # export to the ${WORKDIR}
199 #* "svn export" has a bug. see http://bugs.gentoo.org/119236
200 #* svn export . "${S}" || die "${ESVN}: can't export to ${S}."
201 rsync -rlpgo --exclude=".svn/" . "${S}" || die "${ESVN}: can't export to ${S}."
202 fi
203
204 echo
205 }
206
207 # @FUNCTION: subversion_bootstrap
208 # @DESCRIPTION:
209 # Apply patches in ${ESVN_PATCHES} and run ${ESVN_BOOTSTRAP} if specified.
210 subversion_bootstrap() {
211 if has "export" ${ESVN_RESTRICT}; then
212 return
213 fi
214
215 cd "${S}"
216
217 if [[ -n ${ESVN_PATCHES} ]]; then
218 einfo "apply patches -->"
219
220 local patch fpatch
221
222 for patch in ${ESVN_PATCHES}; do
223 if [[ -f ${patch} ]]; then
224 epatch "${patch}"
225
226 else
227 for fpatch in ${FILESDIR}/${patch}; do
228 if [[ -f ${fpatch} ]]; then
229 epatch "${fpatch}"
230
231 else
232 die "${ESVN}: ${patch} not found"
233
234 fi
235 done
236
237 fi
238 done
239
240 echo
241 fi
242
243 if [[ -n ${ESVN_BOOTSTRAP} ]]; then
244 einfo "begin bootstrap -->"
245
246 if [[ -f ${ESVN_BOOTSTRAP} && -x ${ESVN_BOOTSTRAP} ]]; then
247 einfo " bootstrap with a file: ${ESVN_BOOTSTRAP}"
248 eval "./${ESVN_BOOTSTRAP}" || die "${ESVN}: can't execute ESVN_BOOTSTRAP."
249
250 else
251 einfo " bootstrap with command: ${ESVN_BOOTSTRAP}"
252 eval "${ESVN_BOOTSTRAP}" || die "${ESVN}: can't eval ESVN_BOOTSTRAP."
253
254 fi
255 fi
256 }
257
258 # @FUNCTION: subversion_src_unpack
259 # @DESCRIPTION:
260 # default src_unpack. fetch and bootstrap.
261 subversion_src_unpack() {
262 subversion_fetch || die "${ESVN}: unknown problem occurred in subversion_fetch."
263 subversion_bootstrap || die "${ESVN}: unknown problem occurred in subversion_bootstrap."
264 }
265
266 # @FUNCTION: subversion_wc_info
267 # @USAGE: [repo_uri]
268 # @RETURN: ESVN_WC_URL, ESVN_WC_REVISION and ESVN_WC_PATH
269 # @DESCRIPTION:
270 # Get svn info for the specified repo_uri. The default repo_uri is ESVN_REPO_URI.
271 #
272 # The working copy information on the specified repository URI are set to
273 # ESVN_WC_* variables.
274 subversion_wc_info() {
275 local repo_uri="$(subversion__get_repository_uri "${1}")"
276 local wc_path="$(subversion__get_wc_path "${repo_uri}")"
277
278 debug-print "${FUNCNAME}: repo_uri = ${repo_uri}"
279 debug-print "${FUNCNAME}: wc_path = ${wc_path}"
280
281 if [[ ! -d ${wc_path} ]]; then
282 return 1
283 fi
284
285 local k
286
287 for k in url revision; do
288 export ESVN_WC_$(subversion__to_upper_case "${k}")="$(subversion__svn_info "${wc_path}" "${k}")"
289 done
290
291 export ESVN_WC_PATH="${wc_path}"
292 }
293
294 ## -- Private Functions
295
296 ## -- subversion__svn_info() ------------------------------------------------- #
297 #
298 # param $1 - a target.
299 # param $2 - a key name.
300 #
301 subversion__svn_info() {
302 local target="${1}"
303 local key="${2}"
304
305 env LC_ALL=C svn info "${target}" | grep -i "^${key}" | cut -d" " -f2-
306 }
307
308 ## -- subversion__get_repository_uri() --------------------------------------- #
309 #
310 # param $1 - a repository URI.
311 # param $2 - a peg revision is deleted from a return value if this is
312 # specified.
313 subversion__get_repository_uri() {
314 local repo_uri="${1:-${ESVN_REPO_URI}}"
315 local remove_peg_revision="${2}"
316
317 debug-print "${FUNCNAME}: repo_uri = ${repo_uri}"
318 debug-print "${FUNCNAME}: remove_peg_revision = ${remove_peg_revision}"
319
320 if [[ -z ${repo_uri} ]]; then
321 die "${ESVN}: ESVN_REPO_URI (or specified URI) is empty."
322 fi
323
324 # delete trailing slash
325 if [[ -z ${repo_uri##*/} ]]; then
326 repo_uri="${repo_uri%/}"
327 fi
328
329 if [[ -n ${remove_peg_revision} ]]; then
330 if subversion__has_peg_revision "${repo_uri}"; then
331 repo_uri="${repo_uri%@*}"
332
333 debug-print "${FUNCNAME}: repo_uri has a peg revision"
334 debug-print "${FUNCNAME}: repo_uri = ${repo_uri}"
335 fi
336 fi
337
338 echo "${repo_uri}"
339 }
340
341 ## -- subversion__get_wc_path() ---------------------------------------------- #
342 #
343 # param $1 - a repository URI.
344 subversion__get_wc_path() {
345 local repo_uri="$(subversion__get_repository_uri "${1}" 1)"
346
347 debug-print "${FUNCNAME}: repo_uri = ${repo_uri}"
348
349 echo "${ESVN_STORE_DIR}/${ESVN_PROJECT}/${repo_uri##*/}"
350 }
351
352 ## -- subversion__has_peg_revision() ----------------------------------------- #
353 #
354 # param $1 - a repository URI.
355 subversion__has_peg_revision() {
356 local repo_uri="${1}"
357
358 debug-print "${FUNCNAME}: repo_uri = ${repo_uri}"
359
360 # repo_uri has peg revision ?
361 if [[ ${repo_uri} != *@* ]]; then
362 debug-print "${FUNCNAME}: repo_uri does not have a peg revision."
363 return 1
364 fi
365
366 local peg_rev="${repo_uri##*@}"
367
368 case "$(subversion__to_upper_case "${peg_rev}")" in
369 [[:digit:]]*)
370 # NUMBER
371 ;;
372 HEAD|BASE|COMMITED|PREV)
373 ;;
374 {[^}]*})
375 # DATE
376 ;;
377 *)
378 debug-print "${FUNCNAME}: repo_uri does not have a peg revision."
379 return 1
380 ;;
381 esac
382
383 debug-print "${FUNCNAME}: peg_rev = ${peg_rev}"
384
385 return 0
386 }
387
388 ## -- subversion__to_upper_case() ----------------------------------------- #
389 #
390 # param $@ - the strings to upper case.
391 subversion__to_upper_case() {
392 echo "${@}" | tr "[:lower:]" "[:upper:]"
393 }

  ViewVC Help
Powered by ViewVC 1.1.20