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

Contents of /eclass/cvs.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.57 - (show annotations) (download)
Wed Jul 6 20:23:20 2005 UTC (8 years, 9 months ago) by agriffis
Branch: MAIN
Changes since 1.56: +1 -2 lines
Remove ECLASS= and INHERITED= which haven't been necessary for a long time now

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

  ViewVC Help
Powered by ViewVC 1.1.20