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

Contents of /eclass/cvs.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.55 - (show annotations) (download)
Thu Jan 13 04:57:35 2005 UTC (9 years, 10 months ago) by vapier
Branch: MAIN
Changes since 1.54: +2 -2 lines
fix typo #77642

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

  ViewVC Help
Powered by ViewVC 1.1.20