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

Contents of /eclass/cvs.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.65 - (show annotations) (download)
Sat Oct 14 20:27:21 2006 UTC (7 years, 10 months ago) by swegener
Branch: MAIN
Changes since 1.64: +3 -3 lines
Apply whitespace checks from repoman to eclasses.

1 # Copyright 1999-2006 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/cvs.eclass,v 1.64 2006/06/15 14:45:59 vapier Exp $
4 #
5 # Maintainer: vapier@gentoo.org (and anyone who wants to help)
6
7 inherit eutils
8
9 # This eclass provides the generic cvs fetching functions. To use
10 # this from an ebuild, set the `ebuild-configurable settings' as
11 # specified below in your ebuild before inheriting. Then either leave
12 # the default src_unpack or extend over cvs_src_unpack. If you find
13 # that you need to call the cvs_* functions directly, I'd be
14 # interested to hear about it.
15
16 # TODO:
17
18 # Implement more auth types (gserver?, kserver?)
19
20 # Support additional remote shells with `ext' authentication (does
21 # anyone actually need to use it with anything other than SSH?)
22
23
24
25 # Users shouldn't change these settings! The ebuild/eclass inheriting
26 # this eclass will take care of that. If you want to set the global
27 # KDE cvs ebuilds' settings, see the comments in kde-source.eclass.
28
29 # --- begin ebuild-configurable settings
30
31 # ECVS_CVS_COMMAND -- CVS command to run
32 #
33 # You can set, for example, "cvs -t" for extensive debug information
34 # on the cvs connection. The default of "cvs -q -f -z4" means to be
35 # quiet, to disregard the ~/.cvsrc config file and to use maximum
36 # compression.
37
38 [ -z "$ECVS_CVS_COMMAND" ] && ECVS_CVS_COMMAND="cvs -q -f -z4"
39
40
41 # ECVS_UP_OPTS, ECVS_CO_OPTS -- CVS options given after the cvs
42 # command (update or checkout).
43 #
44 # Don't remove -dP from update or things won't work.
45
46 [ -z "$ECVS_UP_OPTS" ] && ECVS_UP_OPTS="-dP"
47 [ -z "$ECVS_CO_OPTS" ] && ECVS_CO_OPTS=""
48
49
50 # ECVS_LOCAL -- If this is set, the CVS module will be fetched
51 # non-recursively. Refer to the information in the CVS man page
52 # regarding the -l command option (not the -l global option).
53
54
55 # ECVS_LOCALNAME -- local name of checkout directory
56 #
57 # This is useful if the module on the server is called something
58 # common like 'driver' or is nested deep in a tree, and you don't like
59 # useless empty directories.
60 #
61 # WARNING: Set this only from within ebuilds! If set in your shell or
62 # some such, things will break because the ebuild won't expect it and
63 # have e.g. a wrong $S setting.
64
65
66 # ECVS_TOP_DIR -- The directory under which CVS modules are checked
67 # out.
68
69 [ -z "$ECVS_TOP_DIR" ] && ECVS_TOP_DIR="${PORTAGE_ACTUAL_DISTDIR-${DISTDIR}}/cvs-src"
70
71 # ECVS_SERVER -- CVS path
72 #
73 # The format is "server:/dir", e.g. "anoncvs.kde.org:/home/kde".
74 # Remove the other parts of the full CVSROOT, which might look like
75 # ":pserver:anonymous@anoncvs.kde.org:/home/kde"; this is generated
76 # using other settings also.
77 #
78 # Set this to "offline" to disable fetching (i.e. to assume the module
79 # is already checked out in ECVS_TOP_DIR).
80
81 [ -z "$ECVS_SERVER" ] && ECVS_SERVER="offline"
82
83
84 # ECVS_MODULE -- the name of the CVS module to be fetched
85 #
86 # This must be set when cvs_src_unpack is called. This can include
87 # several directory levels, i.e. "foo/bar/baz"
88
89 #[ -z "$ECVS_MODULE" ] && die "$ECLASS: error: ECVS_MODULE not set, cannot continue"
90
91
92 # ECVS_BRANCH -- the name of the branch/tag to use
93
94 # The default is "HEAD". The following default _will_ reset your
95 # branch checkout to head if used.
96
97 #[ -z "$ECVS_BRANCH" ] && ECVS_BRANCH="HEAD"
98
99
100 # ECVS_AUTH -- authentication method to use
101 #
102 # Possible values are "pserver" and "ext". If `ext' authentication is
103 # used, the remote shell to use can be specified in CVS_RSH (SSH is
104 # used by default). Currently, the only supported remote shell for
105 # `ext' authentication is SSH.
106 #
107 # Armando Di Cianno <fafhrd@gentoo.org> 2004/09/27
108 # - Added "no" as a server type, which uses no AUTH method, nor
109 # does it login
110 # e.g.
111 # "cvs -danoncvs@savannah.gnu.org:/cvsroot/backbone co System"
112 # ( from gnustep-apps/textedit )
113 [ -z "$ECVS_AUTH" ] && ECVS_AUTH="pserver"
114
115 # ECVS_USER -- Username to use for authentication on the remote server
116 [ -z "$ECVS_USER" ] && ECVS_USER="anonymous"
117
118
119 # ECVS_PASS -- Password to use for authentication on the remote server
120 [ -z "$ECVS_PASS" ] && ECVS_PASS=""
121
122
123 # ECVS_SSH_HOST_KEY
124 #
125 # If SSH is used for `ext' authentication, use this variable to
126 # specify the host key of the remote server. The format of the value
127 # should be the same format that is used for the SSH known hosts file.
128 #
129 # WARNING: If a SSH host key is not specified using this variable, the
130 # remote host key will not be verified.
131
132
133 # ECVS_CLEAN -- Set this to get a clean copy when updating (passes the
134 # -C option to cvs update)
135
136
137 # ECVS_RUNAS
138 #
139 # Specifies an alternate (non-root) user to use to run cvs. Currently
140 # b0rked and wouldn't work with portage userpriv anyway without
141 # special magic.
142
143 # [ -z "$ECVS_RUNAS" ] && ECVS_RUNAS="`whoami`"
144
145
146 # ECVS_SUBDIR -- deprecated, do not use
147 [ -n "$ECVS_SUBDIR" ] && die "ERROR: deprecated ECVS_SUBDIR defined. Please fix this ebuild."
148
149
150 # --- end ebuild-configurable settings ---
151
152 # add cvs to deps
153 # ssh is used for ext auth
154 # sudo is used to run as a specified user
155 DEPEND="dev-util/cvs"
156
157 [ -n "$ECVS_RUNAS" ] && DEPEND="$DEPEND app-admin/sudo"
158
159 if [ "$ECVS_AUTH" == "ext" ]; then
160 #default to ssh
161 [ -z "$CVS_RSH" ] && export CVS_RSH="ssh"
162 if [ "$CVS_RSH" != "ssh" ]; then
163 die "Support for ext auth with clients other than ssh has not been implemented yet"
164 fi
165 DEPEND="${DEPEND} net-misc/openssh"
166 fi
167
168 # called from cvs_src_unpack
169 cvs_fetch() {
170
171 # Make these options local variables so that the global values are
172 # not affected by modifications in this function.
173
174 local ECVS_COMMAND="${ECVS_COMMAND}"
175 local ECVS_UP_OPTS="${ECVS_UP_OPTS}"
176 local ECVS_CO_OPTS="${ECVS_CO_OPTS}"
177
178 # Fix for sourceforge which doesnt want -z>3 anymore.
179
180 (echo $ECVS_SERVER | grep -q sourceforge) \
181 && [ "$ECVS_CVS_COMMAND" == "cvs -q -f -z4" ] \
182 && ECVS_CVS_COMMAND="cvs -q -f -z3"
183
184 debug-print-function $FUNCNAME $*
185
186 # Update variables that are modified by ebuild parameters, which
187 # should be effective every time cvs_fetch is called, and not just
188 # every time cvs.eclass is inherited
189
190 # Handle parameter for local (non-recursive) fetching
191
192 if [ -n "$ECVS_LOCAL" ]; then
193 ECVS_UP_OPTS="$ECVS_UP_OPTS -l"
194 ECVS_CO_OPTS="$ECVS_CO_OPTS -l"
195 fi
196
197 # Handle ECVS_BRANCH option
198 #
199 # Because CVS auto-switches branches, we just have to pass the
200 # correct -rBRANCH option when updating.
201
202 if [ -n "$ECVS_BRANCH" ]; then
203 ECVS_UP_OPTS="$ECVS_UP_OPTS -r$ECVS_BRANCH"
204 ECVS_CO_OPTS="$ECVS_CO_OPTS -r$ECVS_BRANCH"
205 fi
206
207 # Handle ECVS_LOCALNAME, which specifies the local directory name
208 # to use. Note that the -d command option is not equivalent to
209 # the global -d option.
210
211 if [ "$ECVS_LOCALNAME" != "$ECVS_MODULE" ]; then
212 ECVS_CO_OPTS="$ECVS_CO_OPTS -d $ECVS_LOCALNAME"
213 fi
214
215
216 if [ -n "$ECVS_CLEAN" ]; then
217 ECVS_UP_OPTS="$ECVS_UP_OPTS -C"
218 fi
219
220
221 # It would be easiest to always be in "run-as mode", logic-wise,
222 # if sudo didn't ask for a password even when sudo'ing to `whoami`.
223
224 if [ -z "$ECVS_RUNAS" ]; then
225 run=""
226 else
227 run="sudo -u $ECVS_RUNAS"
228 fi
229
230 # Create the top dir if needed
231
232 if [ ! -d "$ECVS_TOP_DIR" ]; then
233
234 # Note that the addwrite statements in this block are only
235 # there to allow creating ECVS_TOP_DIR; we allow writing
236 # inside it separately.
237
238 # This is because it's simpler than trying to find out the
239 # parent path of the directory, which would need to be the
240 # real path and not a symlink for things to work (so we can't
241 # just remove the last path element in the string)
242
243 debug-print "$FUNCNAME: checkout mode. creating cvs directory"
244 addwrite /foobar
245 addwrite /
246 $run mkdir -p "/$ECVS_TOP_DIR"
247 export SANDBOX_WRITE="${SANDBOX_WRITE//:\/foobar:\/}"
248 fi
249
250 # In case ECVS_TOP_DIR is a symlink to a dir, get the real path,
251 # otherwise addwrite() doesn't work.
252
253 cd -P "$ECVS_TOP_DIR" > /dev/null
254 ECVS_TOP_DIR="`/bin/pwd`"
255
256 # Disable the sandbox for this dir
257 addwrite "$ECVS_TOP_DIR"
258
259 # Chown the directory and all of its contents
260 if [ -n "$ECVS_RUNAS" ]; then
261 $run chown -R "$ECVS_RUNAS" "/$ECVS_TOP_DIR"
262 fi
263
264 # Determine the CVS command mode (checkout or update)
265 if [ ! -d "$ECVS_TOP_DIR/$ECVS_LOCALNAME/CVS" ]; then
266 mode=checkout
267 else
268 mode=update
269 fi
270
271
272 # Our server string (i.e. CVSROOT) without the password so it can
273 # be put in Root
274 if [ "$ECVS_AUTH" == "no" ]
275 then
276 local server="${ECVS_USER}@${ECVS_SERVER}"
277 else
278 local server=":${ECVS_AUTH}:${ECVS_USER}@${ECVS_SERVER}"
279 fi
280
281 # Switch servers automagically if needed
282 if [ "$mode" == "update" ]; then
283 cd /$ECVS_TOP_DIR/$ECVS_LOCALNAME
284 local oldserver="`$run cat CVS/Root`"
285 if [ "$server" != "$oldserver" ]; then
286
287 einfo "Changing the CVS server from $oldserver to $server:"
288 debug-print "$FUNCNAME: Changing the CVS server from $oldserver to $server:"
289
290 einfo "Searching for CVS directories ..."
291 local cvsdirs="`$run find . -iname CVS -print`"
292 debug-print "$FUNCNAME: CVS directories found:"
293 debug-print "$cvsdirs"
294
295 einfo "Modifying CVS directories ..."
296 for x in $cvsdirs; do
297 debug-print "In $x"
298 $run echo "$server" > "$x/Root"
299 done
300
301 fi
302 fi
303
304 # Prepare a cvspass file just for this session, we don't want to
305 # mess with ~/.cvspass
306 touch "${T}/cvspass"
307 export CVS_PASSFILE="${T}/cvspass"
308 if [ -n "$ECVS_RUNAS" ]; then
309 chown "$ECVS_RUNAS" "${T}/cvspass"
310 fi
311
312 # The server string with the password in it, for login
313 cvsroot_pass=":${ECVS_AUTH}:${ECVS_USER}:${ECVS_PASS}@${ECVS_SERVER}"
314
315 # Ditto without the password, for checkout/update after login, so
316 # that the CVS/Root files don't contain the password in plaintext
317 if [ "$ECVS_AUTH" == "no" ]
318 then
319 cvsroot_nopass="${ECVS_USER}@${ECVS_SERVER}"
320 else
321 cvsroot_nopass=":${ECVS_AUTH}:${ECVS_USER}@${ECVS_SERVER}"
322 fi
323
324 # Commands to run
325 cmdlogin="${run} ${ECVS_CVS_COMMAND} -d \"${cvsroot_pass}\" login"
326 cmdupdate="${run} ${ECVS_CVS_COMMAND} -d \"${cvsroot_nopass}\" update ${ECVS_UP_OPTS} ${ECVS_LOCALNAME}"
327 cmdcheckout="${run} ${ECVS_CVS_COMMAND} -d \"${cvsroot_nopass}\" checkout ${ECVS_CO_OPTS} ${ECVS_MODULE}"
328
329 # Execute commands
330
331 cd "${ECVS_TOP_DIR}"
332 if [ "${ECVS_AUTH}" == "pserver" ]; then
333 einfo "Running $cmdlogin"
334 eval $cmdlogin || die "cvs login command failed"
335 if [ "${mode}" == "update" ]; then
336 einfo "Running $cmdupdate"
337 eval $cmdupdate || die "cvs update command failed"
338 elif [ "${mode}" == "checkout" ]; then
339 einfo "Running $cmdcheckout"
340 eval $cmdcheckout|| die "cvs checkout command failed"
341 fi
342 elif [ "${ECVS_AUTH}" == "ext" ] || [ "${ECVS_AUTH}" == "no" ]; then
343
344 # Hack to support SSH password authentication
345
346 # Backup environment variable values
347 local CVS_ECLASS_ORIG_CVS_RSH="${CVS_RSH}"
348
349 if [ "${SSH_ASKPASS+set}" == "set" ]; then
350 local CVS_ECLASS_ORIG_SSH_ASKPASS="${SSH_ASKPASS}"
351 else
352 unset CVS_ECLASS_ORIG_SSH_ASKPASS
353 fi
354
355 if [ "${DISPLAY+set}" == "set" ]; then
356 local CVS_ECLASS_ORIG_DISPLAY="${DISPLAY}"
357 else
358 unset CVS_ECLASS_ORIG_DISPLAY
359 fi
360
361 if [ "${CVS_RSH}" == "ssh" ]; then
362
363 # Force SSH to use SSH_ASKPASS by creating python wrapper
364
365 export CVS_RSH="${T}/cvs_sshwrapper"
366 cat > "${CVS_RSH}"<<EOF
367 #!/usr/bin/python
368 import fcntl
369 import os
370 import sys
371 try:
372 fd = os.open('/dev/tty', 2)
373 TIOCNOTTY=0x5422
374 try:
375 fcntl.ioctl(fd, TIOCNOTTY)
376 except:
377 pass
378 os.close(fd)
379 except:
380 pass
381 newarglist = sys.argv[:]
382 EOF
383
384 # disable X11 forwarding which causes .xauth access violations
385 # - 20041205 Armando Di Cianno <fafhrd@gentoo.org>
386 echo "newarglist.insert(1, '-oClearAllForwardings=yes')" \
387 >> "${CVS_RSH}"
388 echo "newarglist.insert(1, '-oForwardX11=no')" \
389 >> "${CVS_RSH}"
390
391 # Handle SSH host key checking
392
393 local CVS_ECLASS_KNOWN_HOSTS="${T}/cvs_ssh_known_hosts"
394 echo "newarglist.insert(1, '-oUserKnownHostsFile=${CVS_ECLASS_KNOWN_HOSTS}')" \
395 >> "${CVS_RSH}"
396
397 if [ -z "${ECVS_SSH_HOST_KEY}" ]; then
398 ewarn "Warning: The SSH host key of the remote server will not be verified."
399 einfo "A temporary known hosts list will be used."
400 local CVS_ECLASS_STRICT_HOST_CHECKING="no"
401 touch "${CVS_ECLASS_KNOWN_HOSTS}"
402 else
403 local CVS_ECLASS_STRICT_HOST_CHECKING="yes"
404 echo "${ECVS_SSH_HOST_KEY}" > "${CVS_ECLASS_KNOWN_HOSTS}"
405 fi
406
407 echo -n "newarglist.insert(1, '-oStrictHostKeyChecking=" \
408 >> "${CVS_RSH}"
409 echo "${CVS_ECLASS_STRICT_HOST_CHECKING}')" \
410 >> "${CVS_RSH}"
411 echo "os.execv('/usr/bin/ssh', newarglist)" \
412 >> "${CVS_RSH}"
413
414 chmod a+x "${CVS_RSH}"
415
416 # Make sure DISPLAY is set (SSH will not use SSH_ASKPASS
417 # if DISPLAY is not set)
418
419 [ -z "${DISPLAY}" ] && DISPLAY="DISPLAY"
420 export DISPLAY
421
422 # Create a dummy executable to echo $ECVS_PASS
423
424 export SSH_ASKPASS="${T}/cvs_sshechopass"
425 if [ "${ECVS_AUTH}" != "no" ]; then
426 echo -en "#!/bin/bash\necho \"$ECVS_PASS\"\n" \
427 > "${SSH_ASKPASS}"
428 else
429 echo -en "#!/bin/bash\nreturn\n" \
430 > "${SSH_ASKPASS}"
431
432 fi
433 chmod a+x "${SSH_ASKPASS}"
434 fi
435
436 if [ "${mode}" == "update" ]; then
437 einfo "Running $cmdupdate"
438 eval $cmdupdate || die "cvs update command failed"
439 elif [ "${mode}" == "checkout" ]; then
440 einfo "Running $cmdcheckout"
441 eval $cmdcheckout|| die "cvs checkout command failed"
442 fi
443
444 # Restore environment variable values
445 export CVS_RSH="${CVS_ECLASS_ORIG_CVS_RSH}"
446 if [ "${CVS_ECLASS_ORIG_SSH_ASKPASS+set}" == "set" ]; then
447 export SSH_ASKPASS="${CVS_ECLASS_ORIG_SSH_ASKPASS}"
448 else
449 unset SSH_ASKPASS
450 fi
451
452 if [ "${CVS_ECLASS_ORIG_DISPLAY+set}" == "set" ]; then
453 export DISPLAY="${CVS_ECLASS_ORIG_DISPLAY}"
454 else
455 unset DISPLAY
456 fi
457 fi
458
459 # Restore ownership. Not sure why this is needed, but someone
460 # added it in the orig ECVS_RUNAS stuff.
461 if [ -n "$ECVS_RUNAS" ]; then
462 chown `whoami` "${T}/cvspass"
463 fi
464
465 }
466
467
468 cvs_src_unpack() {
469
470 debug-print-function $FUNCNAME $*
471
472 debug-print "$FUNCNAME: init:
473 ECVS_CVS_COMMAND=$ECVS_CVS_COMMAND
474 ECVS_UP_OPTS=$ECVS_UP_OPTS
475 ECVS_CO_OPTS=$ECVS_CO_OPTS
476 ECVS_TOP_DIR=$ECVS_TOP_DIR
477 ECVS_SERVER=$ECVS_SERVER
478 ECVS_USER=$ECVS_USER
479 ECVS_PASS=$ECVS_PASS
480 ECVS_MODULE=$ECVS_MODULE
481 ECVS_LOCAL=$ECVS_LOCAL
482 ECVS_RUNAS=$ECVS_RUNAS
483 ECVS_LOCALNAME=$ECVS_LOCALNAME"
484
485 [ -z "$ECVS_MODULE" ] && die "ERROR: CVS module not set, cannot continue."
486
487 local ECVS_LOCALNAME="${ECVS_LOCALNAME}"
488
489 if [ -z "$ECVS_LOCALNAME" ]; then
490 ECVS_LOCALNAME="$ECVS_MODULE"
491 fi
492
493 local offline_pkg_var="ECVS_OFFLINE_${PN}"
494 if [ "${!offline_pkg_var}" == "1" -o "$ECVS_OFFLINE" == "1" -o "$ECVS_SERVER" == "offline" ]; then
495 # We're not required to fetch anything; the module already
496 # exists and shouldn't be updated.
497 if [ -d "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}" ]; then
498 debug-print "$FUNCNAME: offline mode"
499 else
500 debug-print "$FUNCNAME: Offline mode specified but directory ${ECVS_TOP_DIR}/${ECVS_LOCALNAME} not found, exiting with error"
501 die "ERROR: Offline mode specified, but directory ${ECVS_TOP_DIR}/${ECVS_LOCALNAME} not found. Aborting."
502 fi
503 elif [ -n "$ECVS_SERVER" ]; then # ECVS_SERVER!=offline --> real fetching mode
504 einfo "Fetching CVS module $ECVS_MODULE into $ECVS_TOP_DIR ..."
505 cvs_fetch
506 else # ECVS_SERVER not set
507 die "ERROR: CVS server not specified, cannot continue."
508 fi
509
510 einfo "Copying $ECVS_MODULE from $ECVS_TOP_DIR ..."
511 debug-print "Copying module $ECVS_MODULE local_mode=$ECVS_LOCAL from $ECVS_TOP_DIR ..."
512
513 # This is probably redundant, but best to make sure.
514 mkdir -p "$WORKDIR/$ECVS_LOCALNAME"
515
516 if [ -n "$ECVS_LOCAL" ]; then
517 cp -f "$ECVS_TOP_DIR/$ECVS_LOCALNAME"/* "$WORKDIR/$ECVS_LOCALNAME"
518 else
519 cp -Rf "$ECVS_TOP_DIR/$ECVS_LOCALNAME" "$WORKDIR/$ECVS_LOCALNAME/.."
520 fi
521
522 # If the directory is empty, remove it; empty directories cannot
523 # exist in cvs. This happens when, for example, kde-source
524 # requests module/doc/subdir which doesn't exist. Still create
525 # the empty directory in workdir though.
526 if [ "`ls -A \"${ECVS_TOP_DIR}/${ECVS_LOCALNAME}\"`" == "CVS" ]; then
527 debug-print "$FUNCNAME: removing empty CVS directory $ECVS_LOCALNAME"
528 rm -rf "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}"
529 fi
530
531 # Implement some of base_src_unpack's functionality; note however
532 # that base.eclass may not have been inherited!
533 if [ -n "$PATCHES" ]; then
534 debug-print "$FUNCNAME: PATCHES=$PATCHES, S=$S, autopatching"
535 cd "$S"
536 epatch ${PATCHES}
537 # Make sure we don't try to apply patches more than once,
538 # since cvs_src_unpack is usually called several times from
539 # e.g. kde-source_src_unpack
540 export PATCHES=""
541 fi
542
543 einfo "CVS module ${ECVS_MODULE} is now in ${WORKDIR}"
544 }
545
546 EXPORT_FUNCTIONS src_unpack

  ViewVC Help
Powered by ViewVC 1.1.20