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

Contents of /eclass/cvs.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.46 - (show annotations) (download)
Thu Aug 7 02:58:18 2003 UTC (11 years ago) by vapier
Branch: MAIN
Changes since 1.45: +24 -23 lines
aesthetics updates #25218

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.45 2003/07/20 05:23:17 vapier Exp $
4 #
5 # Author Dan Armak <danarmak@gentoo.org>
6 #
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.
11
12 ECLASS=cvs
13 INHERITED="$INHERITED $ECLASS"
14
15 # You shouldn't change these settings yourself! The ebuild/eclass inheriting this eclass
16 # will take care of that. If you want to set the global KDE cvs ebuilds' settings,
17 # see the comments in kde-source.eclass.
18
19 # --- begin ebuild-configurable settings
20
21 # cvs command to run. you can set fex. "cvs -t" for extensive debug information
22 # on the cvs onnection. the default of "cvs -q -f -z4" means to be quiet, to disregard
23 # the ~/.cvsrc config file and to use maximum compression.
24 [ -z "$ECVS_CVS_COMMAND" ] && ECVS_CVS_COMMAND="cvs -q -f -z4"
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
40 # Where the cvs modules are stored/accessed
41 [ -z "$ECVS_TOP_DIR" ] && ECVS_TOP_DIR="${DISTDIR}/cvs-src"
42
43 # Name of cvs server, set to "offline" to disable fetching
44 # (i.e. to assume module is checked out already and don't update it).
45 # Format is server:/dir e.g. "anoncvs.kde.org:/home/kde". remove the other
46 # parts of the full CVSROOT (which looks like
47 # ":pserver:anonymous@anoncvs.kde.org:/home/kde"); these are added from
48 # other settings
49 # the special value 'offline' disables fetching, assumes sources are alread in ECVS_TOP_DIR
50 [ -z "$ECVS_SERVER" ] && ECVS_SERVER="offline"
51
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
62 [ -z "$ECVS_USER" ] && ECVS_USER="anonymous"
63
64 # Password to use
65 [ -z "$ECVS_PASS" ] && ECVS_PASS=""
66
67 # Module to be fetched, must be set when kde_src_unpack is called
68 # can include several directory levels, ie foo/bar/baz
69 #[ -z "$ECVS_MODULE" ] && die "$ECLASS: error: ECVS_MODULE not set, cannot continue"
70
71 # Branch/tag to use, default is HEAD
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."
77
78 # --- end ebuild-configurable settings ---
79
80 # add cvs to deps
81 # ssh is used for ext auth
82 # sudo is used to run as a specified user
83 DEPEND="$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
87 cvs_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 einfo "Changing CVS server from $oldserver to $server:"
166 debug-print "$FUNCNAME: Changing CVS server from $oldserver to $server:"
167
168 einfo "Searching for CVS dirs ..."
169 cvsdirs="`$run find . -iname CVS -print`"
170 debug-print "$FUNCNAME: CVS dirs found:"
171 debug-print "$cvsdirs"
172
173 einfo "Modifying CVS dirs ..."
174 for x in $cvsdirs; do
175 debug-print "In $x"
176 $run echo "$server" > "$x/Root"
177 done
178 fi
179 fi
180
181 # prepare a cvspass file just for this session, we don't want to mess with ~/.cvspass
182 touch "${T}/cvspass"
183 export CVS_PASSFILE="${T}/cvspass"
184 if [ -n "$ECVS_RUNAS" ]; then
185 chown "$ECVS_RUNAS" "${T}/cvspass"
186 fi
187
188 # the server string with the password in it, for login
189 cvsroot_pass=":${ECVS_AUTH}:${ECVS_USER}:${ECVS_PASS}@${ECVS_SERVER}"
190 # ditto without the password, for checkout/update after login, so that
191 # the CVS/Root files don't contain the password in plaintext
192 cvsroot_nopass=":${ECVS_AUTH}:${ECVS_USER}@${ECVS_SERVER}"
193
194 # commands to run
195 cmdlogin="${run} ${ECVS_CVS_COMMAND} -d \"${cvsroot_pass}\""
196 cmdlogin_opts="login"
197 cmdupdate="${run} ${ECVS_CVS_COMMAND} -d \"${cvsroot_nopass}\""
198 cmdupdate_opts="update ${ECVS_UP_OPTS} ${ECVS_LOCALNAME}"
199 cmdcheckout="${run} ${ECVS_CVS_COMMAND} -d \"${cvsroot_nopass}\""
200 cmdcheckout_opts="checkout ${ECVS_CO_OPTS} ${ECVS_MODULE}"
201
202 cd "${ECVS_TOP_DIR}"
203 if [ "${ECVS_AUTH}" == "pserver" ]; then
204 debug-print "$FUNCNAME: logging into cvs ${cmdlogin} ${cmdlogin_opts}"
205 einfo "Logging in: ${cmdlogin}"
206 eval ${cmdlogin} ${cmdlogin_opts} >/dev/null || die "cvs login command failed"
207 if [ "${mode}" == "update" ]; then
208 debug-print "$FUNCNAME: updating cvs tree ${cmdupdate} ${cmdupdate_opts}"
209 einfo "Updating existing source tree: ${cmdupdate_opts}"
210 eval ${cmdupdate} ${cmdupdate_opts} || die "cvs update command failed"
211 elif [ "${mode}" == "checkout" ]; then
212 debug-print "$FUNCNAME: checking out from cvs tree ${cmdcheckout} ${cmdcheckout_opts}"
213 einfo "Checking out source tree (${cmdcheckout_opts})"
214 eval ${cmdcheckout} ${cmdcheckout_opts} || die "cvs checkout command failed"
215 fi
216 # elif [ "${ECVS_AUTH}" == "ext" ]; then
217 # # for ext there's also a possible ssh prompt, code not yet written
218 # echo "${ECVS_DELAY} continue connecting&yes" >> "$instruct"
219 # echo "${ECVS_DELAY} CVS password:&${ECVS_PASS}" >> "$instruct"
220 # if [ "$mode" == "update" ]; then
221 # expect "$cvsout" "$instruct" | $cmdupdate > "$cvsout"
222 # elif [ "$mode" == "checkout" ]; then
223 # expect "$cvsout" "$instruct" | $cmdcheckout > "$cvsout"
224 # fi
225 fi
226
227 # restore ownership. not sure why this is needed, but someone added it in the orig ECVS_RUNAS stuff.
228 if [ -n "$ECVS_RUNAS" ]; then
229 chown `whoami` "${T}/cvspass"
230 fi
231 }
232
233
234 cvs_src_unpack() {
235 debug-print-function $FUNCNAME $*
236
237 debug-print "$FUNCNAME: init:
238 ECVS_CVS_COMMAND=$ECVS_CVS_COMMAND
239 ECVS_UP_OPTS=$ECVS_UP_OPTS
240 ECVS_CO_OPTS=$ECVS_CO_OPTS
241 ECVS_TOP_DIR=$ECVS_TOP_DIR
242 ECVS_SERVER=$ECVS_SERVER
243 ECVS_USER=$ECVS_USER
244 ECVS_PASS=$ECVS_PASS
245 ECVS_MODULE=$ECVS_MODULE
246 ECVS_LOCAL=$ECVS_LOCAL
247 ECVS_RUNAS=$ECVS_RUNAS
248 ECVS_LOCALNAME=$ECVS_LOCALNAME"
249
250 [ -z "$ECVS_MODULE" ] && die "ERROR: CVS module not set, cannot continue."
251
252 # merely setting this default value makes things fail when cvs_src_unpack is called
253 # more than once per ebuild (eg kdenonbeta submodules); so if we set a default value,
254 # we disable it again at the function's end.
255 # of course, we could instead always reference it with the bash syntax for 'take default
256 # value from this other variable if undefined', but i'm lazy.
257 if [ -z "$ECVS_LOCALNAME" ]; then
258 ECVS_LOCALNAME="$ECVS_MODULE"
259 ECVS_LOCALNAME_SETDEFAULT=true
260 fi
261
262 if [ "$ECVS_SERVER" == "offline" ]; then
263 # we're not required to fetch anything, the module already exists and shouldn't be updated
264 if [ -d "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}" ]; then
265 debug-print "$FUNCNAME: offline mode"
266 else
267 debug-print "$FUNCNAME: offline mode specified but directory ${ECVS_TOP_DIR}/${ECVS_LOCALNAME} not found, exiting with error"
268 die "ERROR: Offline mode specified, but dir ${ECVS_TOP_DIR}/${ECVS_LOCALNAME} not found. Aborting."
269 fi
270 elif [ -n "$ECVS_SERVER" ]; then # ECVS_SERVER!=offline --> real fetching mode
271 einfo "Fetching module '$ECVS_MODULE' and saving in $ECVS_TOP_DIR ..."
272 cvs_fetch
273 else # ECVS_SERVER not set
274 die "ERROR: CVS server not set, cannot continue."
275 fi
276
277 einfo "Copying $ECVS_MODULE from $ECVS_TOP_DIR ..."
278 debug-print "Copying module $ECVS_MODULE local_mode=$ECVS_LOCAL from $ECVS_TOP_DIR ..."
279
280 # probably redundant, but best to make sure
281 mkdir -p "$WORKDIR/$ECVS_LOCALNAME"
282
283 if [ -n "$ECVS_LOCAL" ]; then
284 cp -f "$ECVS_TOP_DIR/$ECVS_LOCALNAME"/* "$WORKDIR/$ECVS_LOCALNAME"
285 else
286 cp -Rf "$ECVS_TOP_DIR/$ECVS_LOCALNAME" "$WORKDIR/$ECVS_LOCALNAME/.."
287 fi
288
289 # if the directory is empty, remove it; empty directories cannot exist in cvs.
290 # this happens when fex. kde-source requests module/doc/subdir which doesn't exist.
291 # still create the empty directory in workdir though.
292 if [ "`ls -A \"${ECVS_TOP_DIR}/${ECVS_LOCALNAME}\"`" == "CVS" ]; then
293 debug-print "$FUNCNAME: removing cvs-empty directory $ECVS_LOCALNAME"
294 rm -rf "${ECVS_TOP_DIR}/${ECVS_LOCALNAME}"
295 fi
296
297 # implement some of base_src_unpack's functionality;
298 # note however that base.eclass may not have been inherited!
299 if [ -n "$PATCHES" ]; then
300 debug-print "$FUNCNAME: PATCHES=$PATCHES, S=$S, autopatching"
301 cd "$S"
302 for x in $PATCHES; do
303 debug-print "patching from $x"
304 patch -p0 < "$x"
305 done
306 # make sure we don't try to apply patches more than once, since
307 # cvs_src_unpack is usually called several times from e.g. kde-source_src_unpack
308 export PATCHES=""
309 fi
310
311 if [ -n "$ECVS_LOCALNAME_SETDEFAULT" ]; then
312 unset ECVS_LOCALNAME
313 unset ECVS_LOCALNAME_SETDEFAULT
314 fi
315
316 einfo "Module $ECVS_MODULE is now in ${WORKDIR}"
317 }
318
319 EXPORT_FUNCTIONS src_unpack

  ViewVC Help
Powered by ViewVC 1.1.20