source: trunk/lib/OpenGuides/Build.pm @ 606

Last change on this file since 606 was 606, checked in by Dominic Hargreaves, 17 years ago

Improve wiki.conf security.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 5.7 KB
RevLine 
[35]1package OpenGuides::Build;
2
3use strict;
4use Module::Build;
[587]5use OpenGuides::Config;
[35]6use base 'Module::Build';
7
[60]8sub ACTION_install {
9    my $self = shift;
10    $self->SUPER::ACTION_install;
[85]11    $self->ACTION_install_extras;
[57]12
[60]13    eval "use Config::Tiny";
14    die "Config::Tiny is required to set up this application.\n" if $@;
[57]15
[587]16    my $config = OpenGuides::Config->new( file => "wiki.conf" );
[85]17
18    # Initialise the database if necessary.
[587]19    my $dbname = $config->dbname;
20    my $dbuser = $config->dbuser;
21    my $dbpass = $config->dbpass;
22    my $dbhost = $config->dbhost;
23    my $dbtype = $config->dbtype;
[60]24
[61]25    my %cgi_wiki_exts = ( postgres => "Pg",
[318]26                          mysql    => "MySQL",
27                          sqlite   => "SQLite" );
[61]28
29    my $cgi_wiki_module = "CGI::Wiki::Setup::" . $cgi_wiki_exts{$dbtype};
30    eval "require $cgi_wiki_module";
[318]31    die "There was a problem: $@" if $@;
[61]32
[35]33    print "Checking database schema...\n";
[61]34    {
35        no strict 'refs';
36        &{$cgi_wiki_module . "::setup"}( $dbname, $dbuser, $dbpass, $dbhost );
37    }
[35]38}
39
40sub ACTION_fakeinstall {
41    my $self = shift;
42    $self->SUPER::ACTION_fakeinstall;
[85]43    $self->ACTION_install_extras( fake => 1 );
[35]44    print "Checking database schema...\n";
45}
46
[85]47sub ACTION_install_extras {
48    my ($self, %args) = @_;
49    my $FAKE = $args{fake} || 0;
50
51    eval "use Config::Tiny";
52    die "Config::Tiny is required to set up this application.\n" if $@;
53
[587]54    my $config = OpenGuides::Config->new( file => "wiki.conf" );
[85]55
56    # Install the scripts where we were told to.
[587]57    my $install_directory    = $config->install_directory;
58    my $script_name          = $config->script_name;
59    my $template_path        = $config->template_path;
60    my $custom_template_path = $config->custom_template_path;
61    my $custom_lib_path      = $config->custom_lib_path;
[530]62    my @extra_scripts        = @{ $self->{config}{__extra_scripts} };
63    my @templates            = @{ $self->{config}{__templates} };
[85]64
65    print "Installing scripts to $install_directory:\n";
[500]66    # Allow for blank script_name - assume "index.cgi".
67        my $script_filename = $script_name || "index.cgi";
[85]68    if ( $FAKE ) {
[500]69        print "wiki.cgi -> $install_directory/$script_filename (FAKE)\n";
[85]70    } else {
[500]71        if ( $script_filename ne "wiki.cgi" ) {
72            File::Copy::copy("wiki.cgi", $script_filename)
73                or die "Can't copy('wiki.cgi', '$script_filename'): $!";
[85]74        }
[500]75        my $copy = $self->copy_if_modified(
76                                            $script_filename,
77                                            $install_directory
78                                          );
[85]79        if ( $copy ) {
80            $self->fix_shebang_line($copy);
81            $self->make_executable($copy);
[501]82            $self->add_custom_lib_path( $copy, $custom_lib_path )
83              if $custom_lib_path;
[85]84        } else {
[500]85            print "Skipping $install_directory/$script_filename (unchanged)\n";
[85]86        }
[500]87        print "(Really: wiki.cgi -> $install_directory/$script_filename)\n"
88            unless $script_filename eq "wiki.cgi";
[85]89    }
90
[606]91    if ( $FAKE ) {
92        print "Trying to ensure that wiki.conf is protected.\n";
93    } else {
94        my $mentionswikidotconf = 0;
95        print "Trying to ensure that wiki.conf is protected by .htaccess.. ";
96        if (-f "$install_directory/.htaccess") {
97            if (open HTACCESS, "$install_directory/.htaccess") {
98                while (<HTACCESS>) {
99                    if (/wiki\.conf/) {
100                        $mentionswikidotconf = 1;
101                    }
102                }
103                close HTACCESS;
104            } else {
105                warn "Could not open $install_directory/.htaccess for reading: $!";
106            }
107        }
108        if ($mentionswikidotconf == 0) {
109            if (open HTACCESS, ">>$install_directory/.htaccess") {
110                print HTACCESS "# Added by OpenGuides installer\n";
111                print HTACCESS "<Files wiki.conf>\ndeny from all\n</Files>";
112                close HTACCESS;
113                print "apparent success. You should check that this is working!\n";
114            } else {
115                warn "Could not open $install_directory/.htaccess for writing: $!";
116            }
117        } else {
118            print ".htaccess appears to already mention wiki.conf.\n";
119        }
120    }
121
[85]122    foreach my $script ( @extra_scripts ) {
123        if ( $FAKE ) {
124            print "$script -> $install_directory/$script (FAKE)\n";
125        } else {
126            my $copy = $self->copy_if_modified( $script, $install_directory );
127            if ( $copy ) {
128                $self->fix_shebang_line($copy);
[192]129                $self->make_executable($copy) unless $script eq "wiki.conf";
[501]130                $self->add_custom_lib_path( $copy, $custom_lib_path )
131                  if $custom_lib_path;
[85]132            } else {
133                print "Skipping $install_directory/$script (unchanged)\n";
134            }
135        }
136    }
137
[530]138    print "Installing templates to $template_path:\n";
[85]139    foreach my $template ( @templates ) {
140        if ( $FAKE ) {
[530]141            print "templates/$template -> $template_path/$template (FAKE)\n";
[85]142        } else {
[530]143            $self->copy_if_modified(from => "templates/$template", to_dir => $template_path, flatten => 1)
144                or print "Skipping $template_path/$template (unchanged)\n";
[85]145        }
146    }
[606]147    if ( $FAKE ) {
148        print "Making $custom_template_path.\n";
149    } else {
150        unless (-d $custom_template_path) {
151            print "Creating directory $custom_template_path.\n";
152            mkdir $custom_template_path or warn "Could not make $custom_template_path";
153        }
[538]154    }
[85]155}
156
[501]157sub add_custom_lib_path {
158    my ($self, $copy, $lib_path) = @_;
159    local $/ = undef;
160    open my $fh, $copy or die $!;
161    my $content = <$fh>;
162    close $fh or die $!;
163    $content =~ s|use strict;|use strict\;\nuse lib qw( $lib_path )\;|s;
164    open $fh, ">$copy" or die $!;
165    print $fh $content;
166    close $fh or die $!;
167    return 1;
168}
169
[35]1701;
Note: See TracBrowser for help on using the repository browser.