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

Diff of /eclass/cvs.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.5 Revision 1.45
1# Copyright 1999-2000 Gentoo Technologies, Inc. 1# Copyright 1999-2003 Gentoo Technologies, Inc.
2# Distributed under the terms of the GNU General Public License, v2 or later 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/cvs.eclass,v 1.45 2003/07/20 05:23:17 vapier Exp $
4#
3# Author Dan Armak <danarmak@gentoo.org> 5# Author Dan Armak <danarmak@gentoo.org>
4# $Header: /var/cvsroot/gentoo-x86/eclass/cvs.eclass,v 1.5 2002/07/19 09:54:05 danarmak Exp $ 6#
5# This eclass provides the generic cvs fetching functions. 7# This eclass provides the generic cvs fetching functions.
8# to use from an ebuild, set the 'ebuild-configurable settings' below in your ebuild before inheriting.
9# then either leave the default src_unpack or extend over cvs_src_unpack.
10# if you find that you need to call the cvs_* functions directly, i'd be interested to hear about it.
6 11
7ECLASS=cvs 12ECLASS=cvs
8INHERITED="$INHERITED $ECLASS" 13INHERITED="$INHERITED $ECLASS"
9 14
10# You shouldn't change these settings yourself! The ebuild/eclass inheriting this eclass 15# You shouldn't change these settings yourself! The ebuild/eclass inheriting this eclass
16# cvs command to run. you can set fex. "cvs -t" for extensive debug information 21# cvs command to run. you can set fex. "cvs -t" for extensive debug information
17# on the cvs onnection. the default of "cvs -q -f -z4" means to be quiet, to disregard 22# on the cvs onnection. the default of "cvs -q -f -z4" means to be quiet, to disregard
18# the ~/.cvsrc config file and to use maximum compression. 23# the ~/.cvsrc config file and to use maximum compression.
19[ -z "$ECVS_CVS_COMMAND" ] && ECVS_CVS_COMMAND="cvs -q -f -z4" 24[ -z "$ECVS_CVS_COMMAND" ] && ECVS_CVS_COMMAND="cvs -q -f -z4"
20 25
26# cvs options given after the cvs command (update or checkout)
27# don't remove -dP from update or things won't work
28[ -z "$ECVS_UP_OPTS" ] && ECVS_UP_OPTS="-dP"
29[ -z "$ECVS_CO_OPTS" ] && ECVS_CO_OPTS=""
30
31# set this to some value for the module/subdir to be fetched non-recursively: ECVS_LOCAL
32
33# local name of module. useful if the module on the server is called
34# something common like 'driver' or is nested deep in a tree, and you don't
35# like useless empty directories.
36# WARNING: to be set only from within ebuilds! if set in your shell or some such,
37# things wil break because the ebuild won't expect it and have e.g. a wrong $S setting.
38# ECVS_LOCALNAME
39
21# Where the cvs modules are stored/accessed 40# Where the cvs modules are stored/accessed
22[ -z "$ECVS_TOP_DIR" ] && ECVS_TOP_DIR="/usr/src" 41[ -z "$ECVS_TOP_DIR" ] && ECVS_TOP_DIR="${DISTDIR}/cvs-src"
23 42
24# Name of cvs server, set to "" to disable fetching 43# Name of cvs server, set to "offline" to disable fetching
25# (i.e. to assume module is checked out already and don't update it). 44# (i.e. to assume module is checked out already and don't update it).
26# Format is server:/dir e.g. "anoncvs.kde.org:/home/kde". remove the other 45# Format is server:/dir e.g. "anoncvs.kde.org:/home/kde". remove the other
27# parts of the full CVSROOT (which looks like 46# parts of the full CVSROOT (which looks like
28# ":pserver:anonymous@anoncvs.kde.org:/home/kde"); these are added from 47# ":pserver:anonymous@anoncvs.kde.org:/home/kde"); these are added from
29# other settings 48# other settings
49# the special value 'offline' disables fetching, assumes sources are alread in ECVS_TOP_DIR
30[ -z "$ECVS_SERVER" ] && ECVS_SERVER="" 50[ -z "$ECVS_SERVER" ] && ECVS_SERVER="offline"
31 51
32# Username to use 52# Authentication method to use - possible values are "pserver" and "ext"
53# WARNING ext is NOT supported! (never was, despite what earlier version of this file said)
54[ -z "$ECVS_AUTH" ] && ECVS_AUTH="pserver"
55[ "$ECVS_AUTH" == ext ] && die "ERROR: ext auth not supported. If you want it, please contact danarmak@gentoo.org."
56
57# Use su to run cvs as user
58# Currently b0rked and wouldn't work with portage userpriv anyway without special magic
59# [ -z "$ECVS_RUNAS" ] && ECVS_RUNAS="`whoami`"
60
61# Username to give to the server
33[ -z "$ECVS_USER" ] && ECVS_USER="anonymous" 62[ -z "$ECVS_USER" ] && ECVS_USER="anonymous"
34 63
35# Password to use (NOT (YET) SUPPORTED, because cvs doesn't store passwords in plaintext in .cvspass) 64# Password to use
36[ -z "$ECVS_PASS" ] && ECVS_PASS="" 65[ -z "$ECVS_PASS" ] && ECVS_PASS=""
37 66
38# Module to be fetched, must be set explicitly - 67# Module to be fetched, must be set when kde_src_unpack is called
39# I don't like the former ="$NP" default setting 68# can include several directory levels, ie foo/bar/baz
40[ -z "$ECVS_MODULE" ] && die "$ECLASS: error: ECVS_MODULE not set, cannot continue" 69#[ -z "$ECVS_MODULE" ] && die "$ECLASS: error: ECVS_MODULE not set, cannot continue"
41 70
42# Subdirectory in module to be fetched, default is root "/" = whole module (NOT YET IMPLEMENTED) 71# Branch/tag to use, default is HEAD
43[ -z "$ECVS_MODULE_SUBDIR" ] && ECVS_MODULE_SUBDIR="/" 72# the following default _will_ reset your branch checkout to head if used
73#[ -z "$ECVS_BRANCH" ] && ECVS_BRANCH="HEAD"
74
75# deprecated - do not use
76[ -n "$ECVS_SUBDIR" ] && die "ERROR: deprecated ECVS_SUBDIR defined. Please fix this ebuild."
44 77
45# --- end ebuild-configurable settings --- 78# --- end ebuild-configurable settings ---
46 79
47debug-print "$ECLASS: init: ECVS_CVS_COMMAND=$ECVS_CVS_COMMAND 80# add cvs to deps
81# ssh is used for ext auth
82# sudo is used to run as a specified user
83DEPEND="$DEPEND dev-util/cvs app-admin/sudo"
84#[ "$ECVS_AUTH" == "ext" ] && DEPEND="$DEPEND net-misc/openssh"
85
86# calls cvs_contorl, is called from cvs_src_unpack
87cvs_fetch() {
88
89 # fix for sourceforge which doesnt want -z>3 anymore.
90
91 (echo $ECVS_SERVER | grep sourceforge) && [ "$ECVS_CVS_COMMAND" == "cvs -q -f -z4" ] && ECVS_CVS_COMMAND="cvs -q -f -z3"
92
93 debug-print-function $FUNCNAME $*
94
95 # parameters modifying other parameters that should be effective every time cvs_fetch is called,
96 # and not just every time cvs.eclas is inherited
97 # 1. parameter for local (non-recursive) fetching
98 if [ -n "$ECVS_LOCAL" ]; then
99 ECVS_UP_OPTS="$ECVS_UP_OPTS -l"
100 ECVS_CO_OPTS="$ECVS_CO_OPTS -l"
101 fi
102 # 2. cvs auto-switches branches, we just have to pass the correct -rBRANCH option to it when updating.
103 # doing it this way we get multiple -rX options - harmless afaik
104 if [ -n "$ECVS_BRANCH" ]; then
105 ECVS_UP_OPTS="$ECVS_UP_OPTS -r$ECVS_BRANCH"
106 ECVS_CO_OPTS="$ECVS_CO_OPTS -r$ECVS_BRANCH"
107 fi
108
109 if [ "$ECVS_LOCALNAME" != "$ECVS_MODULE" ]; then
110 # the option to cvs on which this is based. note this isn't the same as the
111 # global -d option to cvs, which specifies the cvs server. ugh @ cvs syntax.
112 ECVS_CO_OPTS="$ECVS_CO_OPTS -d $ECVS_LOCALNAME"
113 fi
114
115 # it's easiest to always be in "run-as mode", logic-wise
116 # or would be if sudo didn't ask for a password even when sudo'ing to `whoami`
117 if [ -z "$ECVS_RUNAS" ]; then
118 run=""
119 else
120 run="sudo -u $ECVS_RUNAS"
121 fi
122
123 # create the top dir if needed
124 if [ ! -d "$ECVS_TOP_DIR" ]; then
125 # note that the addwrite statements in this block are only there to allow creating ECVS_TOP_DIR;
126 # we've already allowed writing inside it
127 # this is because it's simpler than trying to find out the parent path of the directory, which
128 # would need to be the real path and not a symlink for things to work (so we can't just remove
129 # the last path element in the string)
130 debug-print "$FUNCNAME: checkout mode. creating cvs directory"
131 addwrite /foobar
132 addwrite /
133 $run mkdir -p "/$ECVS_TOP_DIR"
134 export SANDBOX_WRITE="${SANDBOX_WRITE//:\/foobar:\/}"
135 fi
136
137 # in case ECVS_TOP_DIR is a symlink to a dir, get the real dir's path,
138 # otherwise addwrite() doesn't work.
139 cd -P "$ECVS_TOP_DIR" > /dev/null
140 ECVS_TOP_DIR="`/bin/pwd`"
141
142 # determine checkout or update mode
143 if [ ! -d "$ECVS_TOP_DIR/$ECVS_LOCALNAME/CVS" ]; then
144 mode=checkout
145 else
146 mode=update
147 fi
148
149 # disable the sandbox for this dir
150 addwrite "$ECVS_TOP_DIR"
151
152 # chowning the directory and all contents
153 if [ -n "$ECVS_RUNAS" ]; then
154 $run chown -R "$ECVS_RUNAS" "/$ECVS_TOP_DIR"
155 fi
156
157 # our server string (aka CVSROOT), without the password so it can be put in Root
158 server=":${ECVS_AUTH}:${ECVS_USER}@${ECVS_SERVER}"
159
160 # switch servers automagically if needed
161 if [ "$mode" == "update" ]; then
162 cd /$ECVS_TOP_DIR/$ECVS_LOCALNAME
163 oldserver="`$run cat CVS/Root`"
164 if [ "$server" != "$oldserver" ]; then
165
166 einfo "Changing CVS server from $oldserver to $server:"
167 debug-print "$FUNCNAME: Changing CVS server from $oldserver to $server:"
168
169 einfo "Searching for CVS dirs..."
170 cvsdirs="`$run find . -iname CVS -print`"
171 debug-print "$FUNCNAME: CVS dirs found:"
172 debug-print "$cvsdirs"
173
174 einfo "Modifying CVS dirs..."
175 for x in $cvsdirs; do
176 debug-print "In $x"
177 $run echo "$server" > "$x/Root"
178 done
179
180 fi
181 fi
182
183 # prepare a cvspass file just for this session, we don't want to mess with ~/.cvspass
184 touch "${T}/cvspass"
185 export CVS_PASSFILE="${T}/cvspass"
186 if [ -n "$ECVS_RUNAS" ]; then
187 chown "$ECVS_RUNAS" "${T}/cvspass"
188 fi
189
190 # the server string with the password in it, for login
191 cvsroot_pass=":${ECVS_AUTH}:${ECVS_USER}:${ECVS_PASS}@${ECVS_SERVER}"
192 # ditto without the password, for checkout/update after login, so that
193 # the CVS/Root files don't contain the password in plaintext
194 cvsroot_nopass=":${ECVS_AUTH}:${ECVS_USER}@${ECVS_SERVER}"
195
196 # commands to run
197 cmdlogin="${run} ${ECVS_CVS_COMMAND} -d \"${cvsroot_pass}\" login"
198 cmdupdate="${run} ${ECVS_CVS_COMMAND} -d \"${cvsroot_nopass}\" update ${ECVS_UP_OPTS} ${ECVS_LOCALNAME}"
199 cmdcheckout="${run} ${ECVS_CVS_COMMAND} -d \"${cvsroot_nopass}\" checkout ${ECVS_CO_OPTS} ${ECVS_MODULE}"
200
201 cd "${ECVS_TOP_DIR}"
202 if [ "${ECVS_AUTH}" == "pserver" ]; then
203 einfo "Running $cmdlogin"
204 eval $cmdlogin || die "cvs login command failed"
205 if [ "${mode}" == "update" ]; then
206 einfo "Running $cmdupdate"
207 eval $cmdupdate || die "cvs update command failed"
208 elif [ "${mode}" == "checkout" ]; then
209 einfo "Running $cmdcheckout"
210 eval $cmdcheckout|| die "cvs checkout command failed"
211 fi
212# elif [ "${ECVS_AUTH}" == "ext" ]; then
213# # for ext there's also a possible ssh prompt, code not yet written
214# echo "${ECVS_DELAY} continue connecting&yes" >> "$instruct"
215# echo "${ECVS_DELAY} CVS password:&${ECVS_PASS}" >> "$instruct"
216# if [ "$mode" == "update" ]; then
217# expect "$cvsout" "$instruct" | $cmdupdate > "$cvsout"
218# elif [ "$mode" == "checkout" ]; then
219# expect "$cvsout" "$instruct" | $cmdcheckout > "$cvsout"
220# fi
221 fi
222
223 # restore ownership. not sure why this is needed, but someone added it in the orig ECVS_RUNAS stuff.
224 if [ -n "$ECVS_RUNAS" ]; then
225 chown `whoami` "${T}/cvspass"
226 fi
227
228}
229
230
231cvs_src_unpack() {
232
233 debug-print-function $FUNCNAME $*
234
235 debug-print "$FUNCNAME: init:
236ECVS_CVS_COMMAND=$ECVS_CVS_COMMAND
237ECVS_UP_OPTS=$ECVS_UP_OPTS
238ECVS_CO_OPTS=$ECVS_CO_OPTS
48ECVS_TOP_DIR=$ECVS_TOP_DIR 239ECVS_TOP_DIR=$ECVS_TOP_DIR
49ECVS_SERVER=$ECVS_SERVER 240ECVS_SERVER=$ECVS_SERVER
50ECVS_USER=$ECVS_USER 241ECVS_USER=$ECVS_USER
51ECVS_PASS=$ECVS_PASS 242ECVS_PASS=$ECVS_PASS
52ECS_MODULE=$ECVS_MODULE 243ECVS_MODULE=$ECVS_MODULE
53ECVS_MODULE_SUBDIR=$ECVS_MODULE_SUBDIR" 244ECVS_LOCAL=$ECVS_LOCAL
245ECVS_RUNAS=$ECVS_RUNAS
246ECVS_LOCALNAME=$ECVS_LOCALNAME"
54 247
55# since we now longer have src_fetch as a redefinable ebuild function, 248 [ -z "$ECVS_MODULE" ] && die "ERROR: CVS module not set, cannot continue."
56# we are forced to call this function from cvs_src_unpack
57cvs_fetch() {
58 249
59 debug-print-function $FUNCNAME $* 250 # merely setting this default value makes things fail when cvs_src_unpack is called
60 251 # more than once per ebuild (eg kdenonbeta submodules); so if we set a default value,
61 # disable the sandbox for this dir 252 # we disable it again at the function's end.
62 if [ ! -d "$ECVS_TOP_DIR" ]; then 253 # of course, we could instead always reference it with the bash syntax for 'take default
63 addwrite $ECVS_TOP_DIR/.. 254 # value from this other variable if undefined', but i'm lazy.
64 mkdir -p $ECVS_TOP_DIR
65 adddeny $ECVS_TOP_DIR/..
66 fi
67 addread ${ECVS_TOP_DIR}
68 addwrite ${ECVS_TOP_DIR}
69
70 # prepare a cvspass file just for this session so that cvs thinks we're logged
71 # in at the cvs server. we don't want to mess with ~/.cvspass.
72 echo ":pserver:${ECVS_SERVER} A" > ${T}/cvspass
73 export CVS_PASSFILE="${T}/cvspass"
74
75 cd $ECVS_TOP_DIR
76
77 if [ -z "$ECVS_SERVER" ]; then 255 if [ -z "$ECVS_LOCALNAME" ]; then
256 ECVS_LOCALNAME="$ECVS_MODULE"
257 ECVS_LOCALNAME_SETDEFAULT=true
258 fi
259
260
261 if [ "$ECVS_SERVER" == "offline" ]; then
78 # we're not required to fetch anything, the module already exists and shouldn't be updated 262 # we're not required to fetch anything, the module already exists and shouldn't be updated
79 if [ -d "$ECVS_MODULE" ]; then 263 if [ -d "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}" ]; then
80 debug-print "$FUNCNAME: offline mode, exiting" 264 debug-print "$FUNCNAME: offline mode"
81 return 0 265 else
82 else
83 einfo "ERROR: Offline mode specified, but module not found. Aborting."
84 debug-print "$FUNCNAME: offline mode specified but module not found, exiting with error" 266 debug-print "$FUNCNAME: offline mode specified but directory ${ECVS_TOP_DIR}/${ECVS_LOCALNAME} not found, exiting with error"
85 return 1 267 die "ERROR: Offline mode specified, but dir ${ECVS_TOP_DIR}/${ECVS_LOCALNAME} not found. Aborting."
86 fi
87 fi
88
89 if [ -d "${ECVS_MODULE}" ]; then
90 #update existing module
91
92 cd ${ECVS_MODULE}
93
94 # Switch servers if needed
95 # cvs keeps the server info in th CVS/Root file in every checked-out dir;
96 # we can fix those files to point to the new server
97 newserver=":pserver:anonymous@${ECVS_SERVER}"
98 oldserver="`cat CVS/Root`"
99 if [ "$newserver" != "$oldserver" ]; then
100
101 einfo "Changing CVS server from $oldserver to $newserver:"
102 debug-print "$FUNCNAME: Changing CVS server from $oldserver to $newserver:"
103
104 einfo "Searching for CVS dirs..."
105 cvsdirs="`find . -iname CVS -print`"
106 debug-print "$FUNCNAME: CVS dirs found:"
107 debug-print "$cvsdirs"
108
109 einfo "Modifying CVS dirs..."
110 for x in $cvsdirs; do
111 debug-print "In $x"
112 echo $newserver > $x/Root
113 done
114
115 fi 268 fi
269 elif [ -n "$ECVS_SERVER" ]; then # ECVS_SERVER!=offline --> real fetching mode
270 einfo "Fetching cvs module $ECVS_MODULE into $ECVS_TOP_DIR..."
271 cvs_fetch
272 else # ECVS_SERVER not set
273 die "ERROR: CVS server not set, cannot continue."
274 fi
116 275
117 debug-print "$FUNCNAME: running $ECVS_CVS_COMMAND update with $ECVS_SERVER for module $ECVS_MODULE" 276 einfo "Copying $ECVS_MODULE from $ECVS_TOP_DIR..."
118 einfo "Running $ECVS_CVS_COMMAND update with $ECVS_SERVER for module $ECVS_MODULE..." 277 debug-print "Copying module $ECVS_MODULE local_mode=$ECVS_LOCAL from $ECVS_TOP_DIR..."
119 $ECVS_CVS_COMMAND update -dP || die "died running cvs update"
120 278
279 # probably redundant, but best to make sure
280 mkdir -p "$WORKDIR/$ECVS_LOCALNAME"
281
282 if [ -n "$ECVS_LOCAL" ]; then
283 cp -f "$ECVS_TOP_DIR/$ECVS_LOCALNAME"/* "$WORKDIR/$ECVS_LOCALNAME"
121 else 284 else
122 # checkout module 285 cp -Rf "$ECVS_TOP_DIR/$ECVS_LOCALNAME" "$WORKDIR/$ECVS_LOCALNAME/.."
123
124 export CVSROOT=:pserver:${ECVS_USER}@${ECVS_SERVER}
125 debug-print "$FUNCNAME: running $ECVS_CVS_COMMAND checkout -P $ECVS_MODULE with $CVSROOT..."
126 einfo "Running $ECVS_CVS_COMMAND checkout -P $ECVS_MODULE with $CVSROOT..."
127 $ECVS_CVS_COMMAND checkout -P $ECVS_MODULE || die "died running cvs checkout"
128
129 fi 286 fi
130 287
288 # if the directory is empty, remove it; empty directories cannot exist in cvs.
289 # this happens when fex. kde-source requests module/doc/subdir which doesn't exist.
290 # still create the empty directory in workdir though.
291 if [ "`ls -A \"${ECVS_TOP_DIR}/${ECVS_LOCALNAME}\"`" == "CVS" ]; then
292 debug-print "$FUNCNAME: removing cvs-empty directory $ECVS_LOCALNAME"
293 rm -rf "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}"
294 fi
295
296 # implement some of base_src_unpack's functionality;
297 # note however that base.eclass may not have been inherited!
298 if [ -n "$PATCHES" ]; then
299 debug-print "$FUNCNAME: PATCHES=$PATCHES, S=$S, autopatching"
300 cd "$S"
301 for x in $PATCHES; do
302 debug-print "patching from $x"
303 patch -p0 < "$x"
304 done
305 # make sure we don't try to apply patches more than once, since
306 # cvs_src_unpack is usually called several times from e.g. kde-source_src_unpack
307 export PATCHES=""
308 fi
309
310 if [ -n "$ECVS_LOCALNAME_SETDEFAULT" ]; then
311 unset ECVS_LOCALNAME
312 unset ECVS_LOCALNAME_SETDEFAULT
313 fi
314
315 einfo "Source now in ${WORKDIR}"
131} 316}
132 317
133cvs_src_unpack() {
134
135 debug-print-function $FUNCNAME $*
136 cvs_fetch || die "died running cvs_fetch"
137
138 einfo "Copying module $ECVS_MODULE from $ECVS_TOP_DIR..."
139 debug-print "Copying module $ECVS_MODULE from $ECVS_TOP_DIR..."
140 # the reason this lives here and not in kde-source_src_unpack
141 # is that in the future after copying the sources we might need to
142 # delete them, so this has to be self-contained
143 cp -Rf ${ECVS_TOP_DIR}/${ECVS_MODULE} $WORKDIR
144
145 # implement some of base_src_unpack's functionality;
146 # note however that base.eclass may not have been inherited!
147 if [ -n "$PATCHES" ]; then
148 debug-print "$FUNCNAME: PATCHES=$PATCHES, S=$S, autopatching"
149 cd $S
150 for x in $PATCHES; do
151 debug-print "patching from $x"
152 patch -p0 < $x
153 done
154 fi
155
156}
157
158EXPORT_FUNCTIONS src_unpack 318EXPORT_FUNCTIONS src_unpack
159
160

Legend:
Removed from v.1.5  
changed lines
  Added in v.1.45

  ViewVC Help
Powered by ViewVC 1.1.20