gentoo-x86/eclass/perl-module.eclass

# Copyright 1999-2004 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/perl-module.eclass,v 1.105 2007/05/24 15:11:20 mcummings Exp $
#
# Author: Seemant Kulleen <seemant@gentoo.org>
# Maintained by the Perl herd <perl@gentoo.org>
#
# The perl-module eclass is designed to allow easier installation of perl
# modules, and their incorporation into the Gentoo Linux system.

inherit base

EXPORT_FUNCTIONS pkg_setup pkg_preinst pkg_postinst pkg_prerm pkg_postrm src_compile src_install src_test src_unpack

# 2005.04.28 mcummings
# Mounting problems with src_test functions has forced me to make the
# compilation of perl modules honor the FEATURES maketest flag rather than what
# is generally necessary. I've left a block to make sure we still need to set
# the SRC_TEST="do" flag on the suspicion that otherwise we will face 10 times
# as many bug reports as we have lately.

# 2004.05.10 rac
# block on makemaker versions earlier than that in the 5.8.2 core. in
# actuality, this should be handled in the perl ebuild, so every perl
# ebuild should block versions of MakeMaker older than the one it
# carries. in the meantime, since we have dumped support for MakeMaker
# <6.11 and the associated broken DESTDIR handling, block here to save
# people from sandbox trouble.
#
# 2004.05.25 rac
# for the same reasons, make the perl dep >=5.8.2 to get everybody
# with 5.8.0 and its 6.03 makemaker up to a version that can
# understand DESTDIR
#
# 2004.10.01 mcummings
# noticed a discrepancy in how we were sed fixing references to ${D}
#
# 2005.03.14 mcummings
# Updated eclass to include a specific function for dealing with perlocal.pods -
# this should avoid the conflicts we've been running into with the introduction
# of file collision features by giving us a single exportable function to deal
# with the pods. Modifications to the eclass provided by Yaakov S
# <yselkowitz@hotmail.com> in bug 83622
#
# <later the same day>
# The long awaited (by me) fix for automagically detecting and dealing
# with module-build dependancies. I've chosen not to make it a default dep since
# this adds overhead to people that might not otherwise need it, and instead
# modified the eclass to detect the existence of a Build.PL and behave
# accordingly. This will fix issues with g-cpan builds that needs module-build
# support, as well as get rid of the (annoying) style=builder vars. I know of
# only one module that needed to be hacked for this, Class-MethodMaker-2.05, but
# that module has a bad Build.PL to begin with. Ebuilds should continue to
# DEPEND on module-build<-version> as needed, but there should be no need for
# the style directive any more (especially since it isn't in the eclass
# anymore). Enjoy!
#
# 2005.07.18 mcummings
# Fix for proper handling of $mydoc - thanks to stkn for noticing we were
# bombing out there
#
# 2005.07.19 mcummings
# Providing an override var for the use of Module::Build. While it is being
# incorporated in more and more modules, not all module authors have working
# Build.PL's in place. The override is to allow for a fallback to the "classic"
# Makfile.PL - example is Class::MethodMaker, which provides a Build.PL that is
# severely broken.
#
# 2006.02.11 mcummings
# Per a conversation with solar, adding a change to the dep/rdep lines for
# minimal. Should fix bug 68367 and bug 83622, as well as other embedded builds
# that use perl components without providing perl
#
# 2006.06.13 mcummings
# I've reordered and extended the logic on when to invoke module-build versus
# MakeMaker. The problem that has arisen is that some modules provide a
# Makefile.PL that passes all arguments on to a Build.PL - including PREFIX,
# which causes module-build to build with a target of /usr/usr/
# (how broken is that?). Current logic is if there is a Build.PL and we aren't
# overriding, use it; otherwise use the Makefile.PL; otherwise return (maybe we
# want all the functionality of the perl-module eclass without needing to
# compile??).


SRC_PREP="no"
SRC_TEST="skip"
PREFER_BUILDPL="yes"

PERL_VERSION=""
SITE_ARCH=""
SITE_LIB=""
VENDOR_LIB=""
VENDOR_ARCH=""
ARCH_LIB=""
POD_DIR=""
BUILDER_VER=""
pm_echovar=""

perl-module_src_unpack() {
        if [[ -n ${PATCHES} ]]; then
                base_src_unpack unpack
                base_src_unpack autopatch
        else
                base_src_unpack unpack
        fi
}

perl-module_src_prep() {

        perlinfo

        export PERL_MM_USE_DEFAULT=1
        # Disable ExtUtils::AutoInstall from prompting
        export PERL_EXTUTILS_AUTOINSTALL="--skipdeps"


        SRC_PREP="yes"
        find ${S} -type d -name "\.svn" -exec /bin/rm -rf {} \; 2>/dev/null
        if [ "${PREFER_BUILDPL}" == "yes" ] && ( [ -f Build.PL ] || [ ${PN} == "module-build" ] ); then
                einfo "Using Module::Build"
                echo "$pm_echovar" | perl Build.PL --installdirs=vendor --destdir=${D} --libdoc= || die "Unable to build! (are you using USE=\"build\"?)"
        elif [ -f Makefile.PL ] && [ ! ${PN} == "module-build" ]; then
                einfo "Using ExtUtils::MakeMaker"
                echo "$pm_echovar" | perl Makefile.PL ${myconf} INSTALLMAN3DIR='none'\
                PREFIX=/usr INSTALLDIRS=vendor DESTDIR=${D} || die "Unable to build! (are you using USE=\"build\"?)"
        fi
        if [ ! -f Build.PL ] && [ ! -f Makefile.PL ]; then
                einfo "No Make or Build file detected..."
                return
        fi
}

perl-module_src_compile() {

        perlinfo
        [ "${SRC_PREP}" != "yes" ] && perl-module_src_prep
        if [ -f Makefile ]; then
                make ${mymake} || die "compilation failed"
        elif [ -f Build ]; then
                perl Build build || die "compilation failed"
        fi
        fixlocalpod

}

perl-module_src_test() {
        if [ "${SRC_TEST}" == "do" ]; then
                perlinfo
                if [ -f Makefile ]; then
                        make test || die "test failed"
                elif [ -f Build ]; then
                        perl Build  test || die "test failed"
                fi
        fi
}

perl-module_src_install() {

        perlinfo

        test -z ${mytargets} && mytargets="install"

        if [ -f Makefile ]; then
                make ${myinst} ${mytargets} || die
        elif [ -f Build ]; then
                perl ${S}/Build install
        fi


        einfo "Cleaning out stray man files"
        for FILE in `find ${D} -type f -name "*.3pm*"`; do
                rm -rf ${FILE}
        done
        find ${D}/usr/share/man -depth -type d 2>/dev/null | xargs -r rmdir 2>/dev/null

        fixlocalpod

        for FILE in `find ${D} -type f |grep -v '.so'`; do
                STAT=`file $FILE| grep -i " text"`
                if [ "${STAT}x" != "x" ]; then
                        sed -i -e "s:${D}:/:g" ${FILE}
                fi
        done

        for doc in Change* MANIFEST* README* ${mydoc}; do
                [ -s "$doc" ] && dodoc $doc
        done
}


perl-module_pkg_setup() {

        perlinfo
}


perl-module_pkg_preinst() {

        perlinfo
}

perl-module_pkg_postinst() {

        einfo "Man pages are not installed for most modules now."
        einfo "Please use perldoc instead."
        updatepod
}

perl-module_pkg_prerm() {

        updatepod
}

perl-module_pkg_postrm() {

        updatepod
}

perlinfo() {

        local version
        eval `perl '-V:version'`
        PERL_VERSION=${version}

        local installsitearch
        eval `perl '-V:installsitearch'`
        SITE_ARCH=${installsitearch}

        local installsitelib
        eval `perl '-V:installsitelib'`
        SITE_LIB=${installsitelib}

        local installarchlib
        eval `perl '-V:installarchlib'`
        ARCH_LIB=${installarchlib}

        local installvendorlib
        eval `perl '-V:installvendorlib'`
        VENDOR_LIB=${installvendorlib}

        local installvendorarch
        eval `perl '-V:installvendorarch'`
        VENDOR_ARCH=${installvendorarch}

        if [ "${PREFER_BUILDPL}" == "yes" ]; then
                if [ ! -f ${S}/Makefile.PL ] || [ ${PN} == "module-build" ]; then
                        if [ -f ${S}/Build.PL ]; then
                                if [ ${PN} == "module-build" ]; then
                                        BUILDER_VER="1" # A bootstrapping if you will
                                else
                                        BUILDER_VER=`perl -MModule::Build -e 'print "$Module::Build::VERSION;"' `
                                fi
                        fi
                fi
        fi

        if [ -f /usr/bin/perl ]
        then
                POD_DIR="/usr/share/perl/gentoo-pods/${version}"
        fi
}

fixlocalpod() {
        perlinfo

        if [ -f ${D}${ARCH_LIB}/perllocal.pod ];
        then
                rm -f ${D}/${ARCH_LIB}/perllocal.pod
        fi

        if [ -f ${D}${SITE_LIB}/perllocal.pod ];
        then
                rm -f ${D}/${SITE_LIB}/perllocal.pod
        fi

        if [ -f ${D}${VENDOR_LIB}/perllocal.pod ];
        then
                rm -f ${D}/${VENDOR_LIB}/perllocal.pod
        fi
}

updatepod() {
        perlinfo

        if [ -d "${POD_DIR}" ]
        then
                for FILE in `find ${POD_DIR} -type f -name "*.pod.arch"`; do
                        cat ${FILE} >> ${ARCH_LIB}/perllocal.pod
                        rm -f ${FILE}
                done
                for FILE in `find ${POD_DIR} -type f -name "*.pod.site"`; do
                        cat ${FILE} >> ${SITE_LIB}/perllocal.pod
                        rm -f ${FILE}
                done
                for FILE in `find ${POD_DIR} -type f -name "*.pod.vendor"`; do
                        cat ${FILE} >> ${VENDOR_LIB}/perllocal.pod
                        rm -f ${FILE}
                done
        fi
}
1	vapier	1.63	# Copyright 1999-2004 Gentoo Foundation
2	vapier	1.30	# Distributed under the terms of the GNU General Public License v2
3	swegener	1.106	# $Header: /var/cvsroot/gentoo-x86/eclass/perl-module.eclass,v 1.105 2007/05/24 15:11:20 mcummings Exp $
4	vapier	1.33	#
5	seemant	1.1	# Author: Seemant Kulleen <seemant@gentoo.org>
6	mcummings	1.57	# Maintained by the Perl herd <perl@gentoo.org>
7	vapier	1.33	#
8	seemant	1.1	# The perl-module eclass is designed to allow easier installation of perl
9			# modules, and their incorporation into the Gentoo Linux system.
10	seemant	1.3
11	mcummings	1.102	inherit base
12	danarmak	1.13
13	mcummings	1.102	EXPORT_FUNCTIONS pkg_setup pkg_preinst pkg_postinst pkg_prerm pkg_postrm src_compile src_install src_test src_unpack
14	seemant	1.1
15	mcummings	1.68	# 2005.04.28 mcummings
16			# Mounting problems with src_test functions has forced me to make the
17			# compilation of perl modules honor the FEATURES maketest flag rather than what
18			# is generally necessary. I've left a block to make sure we still need to set
19			# the SRC_TEST="do" flag on the suspicion that otherwise we will face 10 times
20			# as many bug reports as we have lately.
21
22	rac	1.61	# 2004.05.10 rac
23			# block on makemaker versions earlier than that in the 5.8.2 core. in
24			# actuality, this should be handled in the perl ebuild, so every perl
25			# ebuild should block versions of MakeMaker older than the one it
26			# carries. in the meantime, since we have dumped support for MakeMaker
27			# <6.11 and the associated broken DESTDIR handling, block here to save
28			# people from sandbox trouble.
29	rac	1.62	#
30			# 2004.05.25 rac
31			# for the same reasons, make the perl dep >=5.8.2 to get everybody
32			# with 5.8.0 and its 6.03 makemaker up to a version that can
33			# understand DESTDIR
34	mcummings	1.65	#
35			# 2004.10.01 mcummings
36			# noticed a discrepancy in how we were sed fixing references to ${D}
37	mcummings	1.66	#
38			# 2005.03.14 mcummings
39			# Updated eclass to include a specific function for dealing with perlocal.pods -
40			# this should avoid the conflicts we've been running into with the introduction
41			# of file collision features by giving us a single exportable function to deal
42			# with the pods. Modifications to the eclass provided by Yaakov S
43			# <yselkowitz@hotmail.com> in bug 83622
44	swegener	1.76	#
45	mcummings	1.67	# <later the same day>
46			# The long awaited (by me) fix for automagically detecting and dealing
47			# with module-build dependancies. I've chosen not to make it a default dep since
48			# this adds overhead to people that might not otherwise need it, and instead
49			# modified the eclass to detect the existence of a Build.PL and behave
50			# accordingly. This will fix issues with g-cpan builds that needs module-build
51			# support, as well as get rid of the (annoying) style=builder vars. I know of
52			# only one module that needed to be hacked for this, Class-MethodMaker-2.05, but
53			# that module has a bad Build.PL to begin with. Ebuilds should continue to
54			# DEPEND on module-build<-version> as needed, but there should be no need for
55			# the style directive any more (especially since it isn't in the eclass
56			# anymore). Enjoy!
57	mcummings	1.78	#
58			# 2005.07.18 mcummings
59			# Fix for proper handling of $mydoc - thanks to stkn for noticing we were
60			# bombing out there
61			#
62			# 2005.07.19 mcummings
63			# Providing an override var for the use of Module::Build. While it is being
64	mcummings	1.97	# incorporated in more and more modules, not all module authors have working
65	mcummings	1.78	# Build.PL's in place. The override is to allow for a fallback to the "classic"
66			# Makfile.PL - example is Class::MethodMaker, which provides a Build.PL that is
67			# severely broken.
68	mcummings	1.82	#
69			# 2006.02.11 mcummings
70			# Per a conversation with solar, adding a change to the dep/rdep lines for
71			# minimal. Should fix bug 68367 and bug 83622, as well as other embedded builds
72			# that use perl components without providing perl
73	mcummings	1.97	#
74			# 2006.06.13 mcummings
75			# I've reordered and extended the logic on when to invoke module-build versus
76			# MakeMaker. The problem that has arisen is that some modules provide a
77			# Makefile.PL that passes all arguments on to a Build.PL - including PREFIX,
78			# which causes module-build to build with a target of /usr/usr/
79			# (how broken is that?). Current logic is if there is a Build.PL and we aren't
80			# overriding, use it; otherwise use the Makefile.PL; otherwise return (maybe we
81			# want all the functionality of the perl-module eclass without needing to
82			# compile??).
83	mcummings	1.67
84	mcummings	1.66
85	azarah	1.11	SRC_PREP="no"
86	rac	1.55	SRC_TEST="skip"
87	mcummings	1.97	PREFER_BUILDPL="yes"
88	azarah	1.11
89	mcummings	1.57	PERL_VERSION=""
90			SITE_ARCH=""
91	seemant	1.35	SITE_LIB=""
92	mcummings	1.65	VENDOR_LIB=""
93			VENDOR_ARCH=""
94	seemant	1.35	ARCH_LIB=""
95			POD_DIR=""
96	mcummings	1.67	BUILDER_VER=""
97	mcummings	1.101	pm_echovar=""
98	seemant	1.35
99	mcummings	1.102	perl-module_src_unpack() {
100			if [[ -n ${PATCHES} ]]; then
101			base_src_unpack unpack
102			base_src_unpack autopatch
103			else
104			base_src_unpack unpack
105			fi
106			}
107
108	aliz	1.15	perl-module_src_prep() {
109	rac	1.60
110			perlinfo
111
112	rac	1.64	export PERL_MM_USE_DEFAULT=1
113	mcummings	1.90	# Disable ExtUtils::AutoInstall from prompting
114			export PERL_EXTUTILS_AUTOINSTALL="--skipdeps"
115	rac	1.64
116	mcummings	1.67
117	azarah	1.11	SRC_PREP="yes"
118	swegener	1.106	find ${S} -type d -name "\.svn" -exec /bin/rm -rf {} \; 2>/dev/null
119	mcummings	1.97	if [ "${PREFER_BUILDPL}" == "yes" ] && ( [ -f Build.PL ] \|\| [ ${PN} == "module-build" ] ); then
120			einfo "Using Module::Build"
121	mcummings	1.101	echo "$pm_echovar" \| perl Build.PL --installdirs=vendor --destdir=${D} --libdoc= \|\| die "Unable to build! (are you using USE=\"build\"?)"
122	mcummings	1.97	elif [ -f Makefile.PL ] && [ ! ${PN} == "module-build" ]; then
123	mcummings	1.85	einfo "Using ExtUtils::MakeMaker"
124	mcummings	1.101	echo "$pm_echovar" \| perl Makefile.PL ${myconf} INSTALLMAN3DIR='none'\
125	mcummings	1.93	PREFIX=/usr INSTALLDIRS=vendor DESTDIR=${D} \|\| die "Unable to build! (are you using USE=\"build\"?)"
126	mcummings	1.88	fi
127			if [ ! -f Build.PL ] && [ ! -f Makefile.PL ]; then
128			einfo "No Make or Build file detected..."
129	mcummings	1.85	return
130	mcummings	1.43	fi
131	azarah	1.11	}
132
133	aliz	1.15	perl-module_src_compile() {
134	seemant	1.6
135	mcummings	1.67	perlinfo
136	aliz	1.15	[ "${SRC_PREP}" != "yes" ] && perl-module_src_prep
137	mcummings	1.88	if [ -f Makefile ]; then
138	mcummings	1.43	make ${mymake} \|\| die "compilation failed"
139	mcummings	1.88	elif [ -f Build ]; then
140	mcummings	1.94	perl Build build \|\| die "compilation failed"
141	mcummings	1.43	fi
142	mcummings	1.104	fixlocalpod
143	mcummings	1.43
144	seemant	1.8	}
145
146	aliz	1.15	perl-module_src_test() {
147	mcummings	1.68	if [ "${SRC_TEST}" == "do" ]; then
148			perlinfo
149	mcummings	1.88	if [ -f Makefile ]; then
150	mcummings	1.68	make test \|\| die "test failed"
151	mcummings	1.88	elif [ -f Build ]; then
152			perl Build test \|\| die "test failed"
153	mcummings	1.68	fi
154	mcummings	1.43	fi
155	seemant	1.1	}
156
157	aliz	1.15	perl-module_src_install() {
158	swegener	1.76
159	seemant	1.35	perlinfo
160	swegener	1.76
161	seemant	1.9	test -z ${mytargets} && mytargets="install"
162	swegener	1.76
163	mcummings	1.88	if [ -f Makefile ]; then
164	mcummings	1.67	make ${myinst} ${mytargets} \|\| die
165	mcummings	1.88	elif [ -f Build ]; then
166	mcummings	1.43	perl ${S}/Build install
167			fi
168	mcummings	1.20
169	mcummings	1.98
170			einfo "Cleaning out stray man files"
171			for FILE in `find ${D} -type f -name ".3pm"`; do
172			rm -rf ${FILE}
173			done
174			find ${D}/usr/share/man -depth -type d 2>/dev/null \| xargs -r rmdir 2>/dev/null
175	swegener	1.103
176	mcummings	1.66	fixlocalpod
177	mcummings	1.65
178			for FILE in `find ${D} -type f \|grep -v '.so'`; do
179			STAT=`file $FILE\| grep -i " text"`
180			if [ "${STAT}x" != "x" ]; then
181			sed -i -e "s:${D}:/:g" ${FILE}
182			fi
183	mcummings	1.38	done
184	seemant	1.1
185	mcummings	1.77	for doc in Change* MANIFEST* README* ${mydoc}; do
186	lanius	1.53	[ -s "$doc" ] && dodoc $doc
187			done
188	seemant	1.35	}
189
190
191			perl-module_pkg_setup() {
192
193			perlinfo
194			}
195
196
197			perl-module_pkg_preinst() {
198	swegener	1.76
199	seemant	1.35	perlinfo
200			}
201
202			perl-module_pkg_postinst() {
203
204	mcummings	1.85	einfo "Man pages are not installed for most modules now."
205	mcummings	1.87	einfo "Please use perldoc instead."
206	seemant	1.35	updatepod
207			}
208
209			perl-module_pkg_prerm() {
210	swegener	1.76
211	seemant	1.35	updatepod
212			}
213
214			perl-module_pkg_postrm() {
215
216			updatepod
217			}
218
219			perlinfo() {
220
221	mcummings	1.79	local version
222	mcummings	1.58	eval `perl '-V:version'`
223			PERL_VERSION=${version}
224	swegener	1.76
225	mcummings	1.79	local installsitearch
226	mcummings	1.58	eval `perl '-V:installsitearch'`
227			SITE_ARCH=${installsitearch}
228	swegener	1.76
229	mcummings	1.79	local installsitelib
230			eval `perl '-V:installsitelib'`
231			SITE_LIB=${installsitelib}
232	swegener	1.76
233	mcummings	1.79	local installarchlib
234	mcummings	1.58	eval `perl '-V:installarchlib'`
235			ARCH_LIB=${installarchlib}
236	swegener	1.76
237	mcummings	1.79	local installvendorlib
238	mcummings	1.65	eval `perl '-V:installvendorlib'`
239			VENDOR_LIB=${installvendorlib}
240
241	mcummings	1.79	local installvendorarch
242	mcummings	1.65	eval `perl '-V:installvendorarch'`
243			VENDOR_ARCH=${installvendorarch}
244	swegener	1.76
245	mcummings	1.97	if [ "${PREFER_BUILDPL}" == "yes" ]; then
246	swegener	1.103	if [ ! -f ${S}/Makefile.PL ] \|\| [ ${PN} == "module-build" ]; then
247			if [ -f ${S}/Build.PL ]; then
248			if [ ${PN} == "module-build" ]; then
249			BUILDER_VER="1" # A bootstrapping if you will
250			else
251			BUILDER_VER=`perl -MModule::Build -e 'print "$Module::Build::VERSION;"' `
252			fi
253	mcummings	1.78	fi
254	mcummings	1.67	fi
255			fi
256
257	mcummings	1.65	if [ -f /usr/bin/perl ]
258	swegener	1.76	then
259	mcummings	1.65	POD_DIR="/usr/share/perl/gentoo-pods/${version}"
260			fi
261	seemant	1.35	}
262
263	mcummings	1.66	fixlocalpod() {
264			perlinfo
265
266			if [ -f ${D}${ARCH_LIB}/perllocal.pod ];
267			then
268			rm -f ${D}/${ARCH_LIB}/perllocal.pod
269			fi
270	swegener	1.76
271	mcummings	1.66	if [ -f ${D}${SITE_LIB}/perllocal.pod ];
272	swegener	1.76	then
273	mcummings	1.66	rm -f ${D}/${SITE_LIB}/perllocal.pod
274			fi
275
276			if [ -f ${D}${VENDOR_LIB}/perllocal.pod ];
277	swegener	1.76	then
278	mcummings	1.66	rm -f ${D}/${VENDOR_LIB}/perllocal.pod
279			fi
280			}
281
282	seemant	1.35	updatepod() {
283			perlinfo
284
285			if [ -d "${POD_DIR}" ]
286			then
287			for FILE in `find ${POD_DIR} -type f -name "*.pod.arch"`; do
288	swegener	1.103	cat ${FILE} >> ${ARCH_LIB}/perllocal.pod
289			rm -f ${FILE}
290	seemant	1.35	done
291			for FILE in `find ${POD_DIR} -type f -name "*.pod.site"`; do
292	swegener	1.103	cat ${FILE} >> ${SITE_LIB}/perllocal.pod
293			rm -f ${FILE}
294	seemant	1.35	done
295	mcummings	1.65	for FILE in `find ${POD_DIR} -type f -name "*.pod.vendor"`; do
296	swegener	1.103	cat ${FILE} >> ${VENDOR_LIB}/perllocal.pod
297			rm -f ${FILE}
298	mcummings	1.65	done
299	seemant	1.35	fi
300	seemant	1.1	}