git.oblomov.eu Git - ikiwiki/blob - 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         push @ret, "\t# basic setup";
  87         push @ret, dumpvalues(\%setup, IkiWiki::getsetup());
  88
  89         # Load all plugins, so that all setup options are available.
  90         my @plugins=grep { ! /externaldemo|pythondemo/ } sort(IkiWiki::listplugins());
  91         foreach my $plugin (@plugins) {
  92                 eval { IkiWiki::loadplugin($plugin) };
  93                 if (exists $IkiWiki::hooks{checkconfig}{$plugin}{call}) {
  94                         my @s=eval { $IkiWiki::hooks{checkconfig}{$plugin}{call}->() };
  95                 }
  96         }
  97         unshift @plugins, $config{rcs} if $config{rcs};
  98
  99         foreach my $id (@plugins) {
 100                 my $title="\t# $id".($id ne $config{rcs} ? " plugin" : "");
 101                 if (exists $IkiWiki::hooks{getsetup}{$id}{call}) {
 102                         # use an array rather than a hash, to preserve order
 103                         my @s=eval { $IkiWiki::hooks{getsetup}{$id}{call}->() };
 104                         next unless @s;
 105                         push @ret, "", $title;
 106                         push @ret, dumpvalues(\%setup, @s);
 107                 }
 108         }
 109
 110         unshift @ret,
 111                 "#!/usr/bin/perl",
 112                 "# $description",
 113                 "#",
 114                 "# Passing this to ikiwiki --setup will make ikiwiki generate",
 115                 "# wrappers and build the wiki.",
 116                 "#",
 117                 "# Remember to re-run ikiwiki --setup any time you edit this file.",
 118                 "use IkiWiki::Setup::Standard {";
 119         push @ret, "}";
 120
 121         return @ret;
 122 } #}}}
 123
 124 1