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

Contents of /eclass/cvs.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.60 - (show annotations) (download)
Wed Sep 21 23:19:08 2005 UTC (9 years ago) by vapier
Branch: MAIN
Changes since 1.59: +3 -13 lines
use epatch #42060

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

  ViewVC Help
Powered by ViewVC 1.1.20