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

Contents of /eclass/cvs.eclass

Parent Directory Parent Directory | Revision Log Revision Log


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

  ViewVC Help
Powered by ViewVC 1.1.20