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

Contents of /eclass/cvs.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.48 - (show annotations) (download)
Sun Sep 28 17:19:43 2003 UTC (10 years, 11 months ago) by coredumb
Branch: MAIN
Changes since 1.47: +7 -1 lines
Implemented ECVS_CLEAN - for fetching a clean copy of the repository when updating it.

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

  ViewVC Help
Powered by ViewVC 1.1.20