setup automator
[ikiwiki.git] / IkiWiki / Setup / Standard.pm
1 #!/usr/bin/perl
2 # Standard ikiwiki setup module.
3 # Parameters to import should be all the standard ikiwiki config stuff,
4 # plus an array of wrappers to set up.
5
6 package IkiWiki::Setup::Standard;
7
8 use warnings;
9 use strict;
10 use IkiWiki;
11
12 sub import { #{{{
13         $IkiWiki::Setup::raw_setup=$_[1];
14 } #}}}
15
16 sub dumpline ($$$$) { #{{{
17         my $key=shift;
18         my $value=shift;
19         my $type=shift;
20         my $prefix=shift;
21         
22         eval q{use Data::Dumper};
23         error($@) if $@;
24         local $Data::Dumper::Terse=1;
25         local $Data::Dumper::Indent=1;
26         local $Data::Dumper::Pad="\t";
27         local $Data::Dumper::Sortkeys=1;
28         local $Data::Dumper::Quotekeys=0;
29         
30         my $dumpedvalue;
31         if ($type eq 'boolean' || $type eq 'integer') {
32                 # avoid quotes
33                 $dumpedvalue=$value;
34         }
35         elsif ($type eq 'string' && ref $value eq 'ARRAY' && @$value &&
36             ! grep { /[^-A-Za-z0-9_]/ } @$value) {
37                 # dump simple array as qw{}
38                 $dumpedvalue="[qw{ ".join(" ", @$value)." }]";
39         }
40         else {
41                 $dumpedvalue=Dumper($value);
42                 chomp $dumpedvalue;
43                 if (length $prefix) {
44                         # add to second and subsequent lines
45                         my @lines=split(/\n/, $dumpedvalue);
46                         $dumpedvalue="";
47                         for (my $x=0; $x <= $#lines; $x++) {
48                                 $lines[$x] =~ s/^\t//;
49                                 $dumpedvalue.="\t".($x ? $prefix : "").$lines[$x]."\n";
50                         }
51                 }
52                 $dumpedvalue=~s/^\t//;
53                 chomp $dumpedvalue;
54         }
55         
56         return "\t$prefix$key => $dumpedvalue,";
57 } #}}}
58
59 sub dumpvalues ($@) { #{{{
60         my $setup=shift;
61         my @ret;
62         while (@_) {
63                 my $key=shift;
64                 my %info=%{shift()};
65
66                 next if $info{type} eq "internal";
67                 
68                 push @ret, "\t# ".$info{description} if exists $info{description};
69                 
70                 if (exists $setup->{$key} && defined $setup->{$key}) {
71                         push @ret, dumpline($key, $setup->{$key}, $info{type}, "");
72                         delete $setup->{$key};
73                 }
74                 elsif (exists $info{example}) {
75                         push @ret, dumpline($key, $info{example}, $info{type}, "#");
76                 }
77         }
78         return @ret;
79 } #}}}
80
81 sub gendump ($) { #{{{
82         my $description=shift;
83         my %setup=(%config);
84         my @ret;
85         
86         # disable logging to syslog while dumping
87         $config{syslog}=0;
88
89         push @ret, "\t# basic setup";
90         push @ret, dumpvalues(\%setup, IkiWiki::getsetup());
91
92         # Load all plugins, so that all setup options are available.
93         # (But skip a few problematic external demo plugins.)
94         my @plugins=grep { ! /^(externaldemo|pythondemo|\Q$config{rcs}\E)$/ }
95                 sort(IkiWiki::listplugins());
96         unshift @plugins, $config{rcs} if $config{rcs}; # rcs plugin 1st
97         foreach my $plugin (@plugins) {
98                 eval { IkiWiki::loadplugin($plugin) };
99                 if (exists $IkiWiki::hooks{checkconfig}{$plugin}{call}) {
100                         my @s=eval { $IkiWiki::hooks{checkconfig}{$plugin}{call}->() };
101                 }
102         }
103
104         foreach my $id (@plugins) {
105                 if (exists $IkiWiki::hooks{getsetup}{$id}{call}) {
106                         # use an array rather than a hash, to preserve order
107                         my @s=eval { $IkiWiki::hooks{getsetup}{$id}{call}->() };
108                         next unless @s;
109                         push @ret, "", "\t# $id plugin";
110                         push @ret, dumpvalues(\%setup, @s);
111                 }
112         }
113         
114         unshift @ret,
115                 "#!/usr/bin/perl",
116                 "# $description",
117                 "#",
118                 "# Passing this to ikiwiki --setup will make ikiwiki generate",
119                 "# wrappers and build the wiki.",
120                 "#",
121                 "# Remember to re-run ikiwiki --setup any time you edit this file.",
122                 "use IkiWiki::Setup::Standard {";
123         push @ret, "}";
124
125         return @ret;
126 } #}}}
127
128 1