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

Last change on this file since 1088 was 1088, checked in by Dominic Hargreaves, 14 years ago

Add support for installing static files (fixes #213)

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