[gentoo-dev] proposal: webapp.eclass (long)

[Max Kalika]

There was a discussion a while back about where and how to install
web-related applications.  As it is now, most webapps try to do some grep
magic to see where the apache/apache2 doc root is.  Why not consolidate all
this into an eclass with the following (very rough) design spec:


--BEGIN---------------------------------------------------------
inherit webapp

# The directory to install. Defaults to "${S}"
WEBAPP_SOURCE="/path/to/source/dir"

# Override which files to install relative to ${WEBAPP_SOURCE}.
# Allows files, and directories.  Defaults to all (unset).
WEBAPP_FILES="file1.php file2.cgi dir1 dir2/file3.html"

# Files to move to /etc/webapps/${PN} and link back so they
# can be taken into account via CONFIG_PROTECT.
# Defaults to none (unset).
WEBAPP_CONFIGS="file1.php dir/config.php"

# Whether or not this webapp contains CGIs. See below.
# I can see a few packages benefiting from this: e.g. xmltv, mailman
# nut, apcupsd.  Defaults to no (unset).
WEBAPP_CGI="yes"

# Path to a file contain other directives for the generated apache 
# configuration file.  Defaults to none (unset)
WEBAPP_EXTRA="${FILESDIR}/somefile.conf"

src_unpack()   nothing changes -- unpack as normal;
src_compile()  nothing changes -- should have nothing to compile;
src_install()  by default runs webapp_src_install()
pkg_postinst() by default runs webapp_pkg_postinst()
pkg_config()   by default runs webapp_pkg_config()


webapp_src_install() is the workhorse
  - copies ${WEBAPP_SOURCE} all together or the items specified under
    ${WEBAPP_FILES} to /usr/share/webapps/${PN}. (I believe /usr/share/web
    was mentioned as a target candidate as well)
  - copies anything in ${WEBAPP_CONFIG} to /etc/webapps/${PN} and links
back 
    to /usr/share/webapps/${PN}.  (Maybe /etc/web?)
  - generates a ${PN}.conf and places it into /etc/apache2/conf/modules.d
or 
    /etc/apache/conf/addon-modules (or both, depending on what exists).
  - the conf file may look something like:

  Alias /${PN}/ /usr/share/webapps/${PN}/
  <Directory /usr/share/webapps/${PN}>
    AllowOverride Limit
    Options Indexes FollowSymLinks # ExecCGI if ${WEBAPP_CGI}
    # contents of ${WEBAPP_EXTRA} if it exists
  </Directory>

webapp_pkg_postinst()
  - prints an einfo about running /var/db/pkg/${PF}/${PF}.ebuild config

webapp_pkg_config()
  - activates the $PN.conf file created by webapp_src_install()
----END---------------------------------------------------------


Again, this is all very rough and is probably missing important features.
Here's a sample ebuild that can take advantage of this eclass (there's
absolutely zero testing done because the said eclass is not yet
implemented).


--BEGIN-[net-www/myweb-0.10.ebuild]-----------------------------
inherit webapp

IUSE=""
DESCRIPTION="PHP scripts intended to manage MythTV from a web browser."
HOMEPAGE="http://www.mythtv.org/"
SRC_URI="http://www.mythtv.org/mc/${P}.tar.bz2"

LICENSE="GPL-2"
SLOT="0"
KEYWORDS="~x86"

RDEPEND="dev-db/mysql
	dev-php/mod_php"

src_install() {

	WEBAPP_CONFIGS="settings.php"
	webapp_src_install()

	dodoc README

}
----END---------------------------------------------------------

---max kalika
--max@×××××××××.edu
-lsit systems administrator

--
gentoo-dev@g.o mailing list