3 # Licensed to the Apache Software Foundation (ASF) under one or more
4 # contributor license agreements. See the NOTICE file distributed with
5 # this work for additional information regarding copyright ownership.
6 # The ASF licenses this file to You under the Apache License, Version 2.0
7 # (the "License"); you may not use this file except in compliance with
8 # the License. You may obtain a copy of the License at
10 # http://www.apache.org/licenses/LICENSE-2.0
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
28 my $installbuilddir = "@exp_installbuilddir@";
29 get_config_vars("$installbuilddir/config_vars.mk",\%config_vars);
31 # read the configuration variables once
33 my $prefix = get_vars("prefix");
34 my $CFG_PREFIX = $prefix;
35 my $exec_prefix = get_vars("exec_prefix");
36 my $datadir = get_vars("datadir");
37 my $localstatedir = get_vars("localstatedir");
38 my $CFG_TARGET = get_vars("progname");
39 my $CFG_SYSCONFDIR = get_vars("sysconfdir");
40 my $CFG_CFLAGS = join ' ', map { get_vars($_) }
41 qw(SHLTCFLAGS CFLAGS NOTEST_CPPFLAGS EXTRA_CPPFLAGS EXTRA_CFLAGS);
42 my $includedir = get_vars("includedir");
43 my $CFG_INCLUDEDIR = eval qq("$includedir");
44 my $CFG_CC = get_vars("CC");
45 my $libexecdir = get_vars("libexecdir");
46 my $CFG_LIBEXECDIR = eval qq("$libexecdir");
47 my $sbindir = get_vars("sbindir");
48 my $CFG_SBINDIR = eval qq("$sbindir");
49 my $ltflags = $ENV{'LTFLAGS'};
50 $ltflags or $ltflags = "--silent";
52 my %internal_vars = map {$_ => 1}
53 qw(TARGET CC CFLAGS CFLAGS_SHLIB LD_SHLIB LDFLAGS_SHLIB LIBS_SHLIB
54 PREFIX SBINDIR INCLUDEDIR LIBEXECDIR SYSCONFDIR);
57 ## parse argument line
60 # defaults for parameters
80 # this subroutine is derived from Perl's getopts.pl with the enhancement of
81 # the "+" metacharacter at the format string to allow a list to be built by
82 # subsequent occurrences of the same option.
84 my ($argumentative, @ARGV) = @_;
88 my @args = split / */, $argumentative;
89 while (@ARGV && ($_ = $ARGV[0]) =~ /^-(.)(.*)/) {
90 my ($first, $rest) = ($1,$2);
95 my $pos = index($argumentative,$first);
97 if ($pos < $#args && $args[$pos+1] eq ':') {
101 error("Incomplete option: $first (needs an argument)");
104 $rest = shift(@ARGV);
106 eval "\$opt_$first = \$rest;";
108 elsif ($pos < $#args && $args[$pos+1] eq '+') {
112 error("Incomplete option: $first (needs an argument)");
115 $rest = shift(@ARGV);
117 eval "push(\@opt_$first, \$rest);";
120 eval "\$opt_$first = 1";
130 error("Unknown option: $first");
140 return ($errs == 0, @ARGV);
144 print STDERR "Usage: apxs -g [-S <var>=<val>] -n <modname>\n";
145 print STDERR " apxs -q [-v] [-S <var>=<val>] [<query> ...]\n";
146 print STDERR " apxs -c [-S <var>=<val>] [-o <dsofile>] [-D <name>[=<value>]]\n";
147 print STDERR " [-I <incdir>] [-L <libdir>] [-l <libname>] [-Wc,<flags>]\n";
148 print STDERR " [-Wl,<flags>] [-p] <files> ...\n";
149 print STDERR " apxs -i [-S <var>=<val>] [-a] [-A] [-n <modname>] <dsofile> ...\n";
150 print STDERR " apxs -e [-S <var>=<val>] [-a] [-A] [-n <modname>] <dsofile> ...\n";
156 ($rc, @ARGV) = &Getopts("qn:gco:I+D+L+l+W+S+eiaApv", @ARGV);
157 &usage if ($rc == 0);
158 &usage if ($#ARGV == -1 and not $opt_g and not $opt_q);
159 &usage if (not $opt_q and not ($opt_g and $opt_n) and not $opt_i and not $opt_c and not $opt_e);
163 my $name = 'unknown';
164 $name = $opt_n if ($opt_n ne '');
168 foreach $opt_S (@opt_S) {
169 if ($opt_S =~ m/^([^=]+)=(.*)$/) {
172 my $oldval = eval "\$CFG_$var";
174 unless ($var and $oldval) {
175 print STDERR "apxs:Error: no config variable $var\n";
179 eval "\$CFG_${var}=\"${val}\"";
181 print STDERR "apxs:Error: malformatted -S option\n";
188 ## Initial shared object support check
190 unless ("@MOD_SO_ENABLED@" eq "yes") {
191 error("Sorry, no shared object support for Apache");
192 error("available under your platform. Make sure");
193 error("the Apache module mod_so is compiled into");
194 error("the server binary.");
199 my ($file, $rh_config) = @_;
201 open IN, $file or die "cannot open $file: $!";
203 if (/^\s*(.*?)\s*=\s*(.*)$/){
204 $rh_config->{$1} = $2;
215 if (exists $config_vars{$arg} or exists $config_vars{lc $arg}) {
216 my $val = exists $config_vars{$arg}
218 : $config_vars{lc $arg};
220 $result .= eval "qq($val)" if defined $val;
225 if (exists $internal_vars{$arg} or exists $internal_vars{lc $arg}) {
226 my $val = exists $internal_vars{$arg} ? $arg : lc $arg;
227 $val = eval "\$CFG_$val";
228 $result .= eval "qq($val)" if defined $val;
233 error("Invalid query string `$arg'");
246 # helper function for executing a list of
247 # system command with return code checks
252 foreach $cmd (@cmds) {
256 error(sprintf "Command failed with rc=%d\n", $rc << 8);
264 ## SAMPLE MODULE SOURCE GENERATION
268 error("Directory `$name' already exists. Remove first");
272 my $data = join('', <DATA>);
273 $data =~ s|%NAME%|$name|sg;
274 $data =~ s|%TARGET%|$CFG_TARGET|sg;
275 $data =~ s|%PREFIX%|$prefix|sg;
276 $data =~ s|%INSTALLBUILDDIR%|$installbuilddir|sg;
278 my ($mkf, $mods, $src) = ($data =~ m|^(.+)-=#=-\n(.+)-=#=-\n(.+)|s);
280 notice("Creating [DIR] $name");
281 system("mkdir $name");
282 notice("Creating [FILE] $name/Makefile");
283 open(FP, ">${name}/Makefile") || die;
286 notice("Creating [FILE] $name/modules.mk");
287 open(FP, ">${name}/modules.mk") || die;
290 notice("Creating [FILE] $name/mod_$name.c");
291 open(FP, ">${name}/mod_${name}.c") || die;
294 notice("Creating [FILE] $name/.deps");
295 system("touch ${name}/.deps");
307 $result = get_vars(@args);
310 # -q without var name prints all variables and their values
312 # Additional -v pretty-prints output
314 # Variable names in alphabetic order
315 my @vars = sort {uc($a) cmp uc($b)} keys %config_vars;
317 # Make the left column as wide as the longest variable name
321 $width = $l unless ($l <= $width);
325 printf "%-${width}s = %s\n", $_, $config_vars{$_};
328 # Unprettified name=value list
329 foreach (keys %config_vars) {
330 print "$_=$config_vars{$_}\n";
336 my $apr_config = get_vars("APR_CONFIG");
338 if (! -x "$apr_config") {
339 error("$apr_config not found!");
343 my $apr_major_version = (split /\./, `$apr_config --version`)[0];
346 if ($apr_major_version < 2) {
347 $apu_config = get_vars("APU_CONFIG");
349 if (! -x "$apu_config") {
350 error("$apu_config not found!");
355 my $libtool = `$apr_config --apr-libtool`;
358 my $apr_includedir = `$apr_config --includes`;
359 chomp($apr_includedir);
360 my $apu_includedir = "";
361 if ($apr_major_version < 2) {
362 $apu_includedir = `$apu_config --includes`;
363 chomp($apu_includedir);
368 ## SHARED OBJECT COMPILATION
371 # split files into sources and objects
384 # determine output file
388 $dso_file = $srcs[0];
389 $dso_file =~ s|\.[^.]+$|.la|;
391 elsif ($#objs > -1) {
392 $dso_file = $objs[0];
393 $dso_file =~ s|\.[^.]+$|.la|;
396 $dso_file = "mod_unknown.la";
401 $dso_file =~ s|\.[^.]+$|.la|;
404 # create compilation commands
407 my ($opt_Wc, $opt_I, $opt_D);
408 foreach $opt_Wc (@opt_W) {
409 $opt .= "$1 " if ($opt_Wc =~ m|^\s*c,(.*)$|);
411 foreach $opt_I (@opt_I) {
414 foreach $opt_D (@opt_D) {
417 my $cflags = "$CFG_CFLAGS";
422 $slo =~ s|\.c$|.slo|;
429 push(@cmds, "$libtool $ltflags --mode=compile $CFG_CC $cflags -I$CFG_INCLUDEDIR $apr_includedir $apu_includedir $opt -c -o $lo $s && touch $slo");
433 # create link command
439 my ($opt_Wl, $opt_L, $opt_l);
441 foreach $opt_Wl (@opt_W) {
442 $opt .= "$1 " if ($opt_Wl =~ m|^\s*l,(.*)$|);
444 foreach $opt_L (@opt_L) {
447 foreach $opt_l (@opt_l) {
453 my $apr_libs=`$apr_config --cflags --ldflags --link-libtool --libs`;
456 if ($apr_major_version < 2) {
457 $apu_libs=`$apu_config --ldflags --link-libtool --libs`;
461 $opt .= " ".$apu_libs." ".$apr_libs;
464 my $apr_ldflags=`$apr_config --ldflags`;
466 $opt .= " -rpath $CFG_LIBEXECDIR -module -avoid-version $apr_ldflags";
469 push(@cmds, "$libtool $ltflags --mode=link $CFG_CC -o $dso_file $opt $lo");
471 # execute the commands
472 &execute_cmds(@cmds);
474 # allow one-step compilation and installation
475 if ($opt_i or $opt_e) {
476 @args = ( $dso_file );
480 if ($opt_i or $opt_e) {
482 ## SHARED OBJECT INSTALLATION
485 # determine installation commands
486 # and corresponding LoadModule directive
491 # ack all potential gcc, hp/ux, win32+os2+aix and os/x extensions
492 if ($f !~ m#(\.so$|\.la$|\.sl$|\.dll$|\.dylib$|)#) {
493 error("file $f is not a shared object");
497 $t =~ s|^.+/([^/]+)$|$1|;
498 # use .so unambigiously for installed shared library modules
499 $t =~ s|\.[^./\\]+$|\.so|;
501 push(@cmds, "$installbuilddir/instdso.sh SH_LIBTOOL='" .
502 "$libtool' $f $CFG_LIBEXECDIR");
503 push(@cmds, "chmod 755 $CFG_LIBEXECDIR/$t");
506 # determine module symbolname and filename
508 if ($name eq 'unknown') {
511 $base =~ s|\.[^.]+$||;
513 open(FP, "<$base.c");
514 my $content = join('', <FP>);
516 if ($content =~ m|.*AP_DECLARE_MODULE\s*\(\s*([a-zA-Z0-9_]+)\s*\)\s*=.*|s || $content =~ m|.*module\s+(?:AP_MODULE_DECLARE_DATA\s+)?([a-zA-Z0-9_]+)_module\s*=\s*.*|s) {
518 $filename = "$base.c";
519 $filename =~ s|^[^/]+/||;
523 if ($base =~ m|.*mod_([a-zA-Z0-9_]+)\..+|) {
526 $filename =~ s|^[^/]+/||;
530 error("Sorry, cannot determine bootstrap symbol name");
531 error("Please specify one with option `-n'");
535 if ($filename eq '') {
536 $filename = "mod_${name}.c";
538 my $dir = $CFG_LIBEXECDIR;
539 $dir =~ s|^$CFG_PREFIX/?||;
542 push(@lmd, sprintf("LoadModule %-18s %s", "${name}_module", "$dir$t"));
545 # execute the commands
546 &execute_cmds(@cmds);
548 # activate module via LoadModule/AddModule directive
549 if ($opt_a or $opt_A) {
550 if (not -f "$CFG_SYSCONFDIR/$CFG_TARGET.conf") {
551 error("Config file $CFG_SYSCONFDIR/$CFG_TARGET.conf not found");
555 open(FP, "<$CFG_SYSCONFDIR/$CFG_TARGET.conf") || die;
556 my $content = join('', <FP>);
559 if ($content !~ m|\n#?\s*LoadModule\s+|) {
560 error("Activation failed for custom $CFG_SYSCONFDIR/$CFG_TARGET.conf file.");
561 error("At least one `LoadModule' directive already has to exist.");
567 $c = '#' if ($opt_A);
568 foreach $lmd (@lmd) {
569 my $what = $opt_A ? "preparing" : "activating";
571 $lmd_re =~ s/\s+/\\s+/g;
573 if ($content !~ m|\n#?\s*$lmd_re|) {
574 # check for open <containers>, so that the new LoadModule
575 # directive always appears *outside* of an <container>.
577 my $before = ($content =~ m|^(.*\n)#?\s*LoadModule\s+[^\n]+\n|s)[0];
579 # the '()=' trick forces list context and the scalar
580 # assignment counts the number of list members (aka number
582 my $cntopen = () = ($before =~ m|^\s*<[^/].*$|mg);
583 my $cntclose = () = ($before =~ m|^\s*</.*$|mg);
585 if ($cntopen == $cntclose) {
586 # fine. Last LoadModule is contextless.
587 $content =~ s|^(.*\n#?\s*LoadModule\s+[^\n]+\n)|$1$c$lmd\n|s;
589 elsif ($cntopen < $cntclose) {
590 error('Configuration file is not valid. There are sections'
591 . ' closed before opened.');
595 # put our cmd after the section containing the last
598 $content =~ s!\A ( # string and capture start
600 ^\s* # start of conf line with a
601 (?:[^<]|<[^/]) # directive which does not
604 .*(?:$)\n # rest of the line.
605 # the '$' is in parentheses
606 # to avoid misinterpreting
610 )* # catch as much as possible
611 # of such lines. (including
614 ^\s*</.*(?:$)\n? # after the above, we
615 # expect a config line with
616 # a closing container (</)
618 ) {$cntopen} # the whole pattern (bunch
619 # of lines that end up with
620 # a closing directive) must
621 # be repeated $cntopen
629 error('Configuration file is not valid. There are '
630 . 'sections opened and not closed.');
635 # replace already existing LoadModule line
636 $content =~ s|^(.*\n)#?\s*$lmd_re[^\n]*\n|$1$c$lmd\n|s;
638 $lmd =~ m|LoadModule\s+(.+?)_module.*|;
639 notice("[$what module `$1' in $CFG_SYSCONFDIR/$CFG_TARGET.conf]");
642 if (open(FP, ">$CFG_SYSCONFDIR/$CFG_TARGET.conf.new")) {
645 system("cp $CFG_SYSCONFDIR/$CFG_TARGET.conf $CFG_SYSCONFDIR/$CFG_TARGET.conf.bak && " .
646 "cp $CFG_SYSCONFDIR/$CFG_TARGET.conf.new $CFG_SYSCONFDIR/$CFG_TARGET.conf && " .
647 "rm $CFG_SYSCONFDIR/$CFG_TARGET.conf.new");
649 notice("unable to open configuration file");
656 print STDERR "apxs:Error: $_[0].\n";
660 print STDERR "$_[0]\n";
666 ## Makefile -- Build procedure for sample %NAME% Apache module
667 ## Autogenerated via ``apxs -n %NAME% -g''.
672 top_builddir=%PREFIX%
673 include %INSTALLBUILDDIR%/special.mk
679 # additional defines, includes and libraries
680 #DEFS=-Dmy_define=my_value
681 #INCLUDES=-Imy/include/dir
682 #LIBS=-Lmy/lib/dir -lmylib
685 all: local-shared-build
687 # install the shared object file into Apache
688 install: install-modules-yes
692 -rm -f mod_%NAME%.o mod_%NAME%.lo mod_%NAME%.slo mod_%NAME%.la
696 lynx -mime_header http://localhost/%NAME%
698 # install and activate shared object by reloading Apache to
699 # force a reload of the shared object file
700 reload: install restart
702 # the general Apache start/restart/stop
712 mod_%NAME%.la: mod_%NAME%.slo
713 $(SH_LINK) -rpath $(libexecdir) -module -avoid-version mod_%NAME%.lo
714 DISTCLEAN_TARGETS = modules.mk
715 shared = mod_%NAME%.la
718 ** mod_%NAME%.c -- Apache sample %NAME% module
719 ** [Autogenerated via ``apxs -n %NAME% -g'']
721 ** To play with this sample module first compile it into a
722 ** DSO file and install it into Apache's modules directory
725 ** $ apxs -c -i mod_%NAME%.c
727 ** Then activate it in Apache's %TARGET%.conf file for instance
728 ** for the URL /%NAME% in as follows:
731 ** LoadModule %NAME%_module modules/mod_%NAME%.so
732 ** <Location /%NAME%>
736 ** Then after restarting Apache via
738 ** $ apachectl restart
740 ** you immediately can request the URL /%NAME% and watch for the
741 ** output of this module. This can be achieved for instance via:
743 ** $ lynx -mime_header http://localhost/%NAME%
745 ** The output should be similar to the following one:
748 ** Date: Tue, 31 Mar 1998 14:42:22 GMT
749 ** Server: Apache/1.3.4 (Unix)
751 ** Content-Type: text/html
753 ** The sample page from mod_%NAME%.c
757 #include "http_config.h"
758 #include "http_protocol.h"
759 #include "ap_config.h"
761 /* The sample content handler */
762 static int %NAME%_handler(request_rec *r)
764 if (strcmp(r->handler, "%NAME%")) {
767 r->content_type = "text/html";
770 ap_rputs("The sample page from mod_%NAME%.c\n", r);
774 static void %NAME%_register_hooks(apr_pool_t *p)
776 ap_hook_handler(%NAME%_handler, NULL, NULL, APR_HOOK_MIDDLE);
779 /* Dispatch list for API hooks */
780 module AP_MODULE_DECLARE_DATA %NAME%_module = {
781 STANDARD20_MODULE_STUFF,
782 NULL, /* create per-dir config structures */
783 NULL, /* merge per-dir config structures */
784 NULL, /* create per-server config structures */
785 NULL, /* merge per-server config structures */
786 NULL, /* table of config file commands */
787 %NAME%_register_hooks /* register hooks */