summaryrefslogtreecommitdiff
path: root/ikiwiki
blob: 361c75c07c0547bb3f01de7f143b4861caa17f21 (plain)
  1. #!/usr/bin/perl -T
  2. $ENV{PATH}="/usr/local/bin:/usr/bin:/bin";
  3. use warnings;
  4. use strict;
  5. use Memoize;
  6. use File::Spec;
  7. use HTML::Template;
  8. use Getopt::Long;
  9. my (%links, %oldlinks, %oldpagemtime, %renderedfiles, %pagesources);
  10. my %config=( #{{{
  11. wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.html?$)},
  12. wiki_link_regexp => qr/\[\[([^\s]+)\]\]/,
  13. wiki_file_regexp => qr/(^[-A-Za-z0-9_.:\/+]+$)/,
  14. verbose => 0,
  15. wikiname => "wiki",
  16. default_pageext => ".mdwn",
  17. cgi => 0,
  18. url => "",
  19. cgiurl => "",
  20. historyurl => "",
  21. svn => 1,
  22. anonok => 0,
  23. rebuild => 0,
  24. wrapper => 0,
  25. srcdir => undef,
  26. destdir => undef,
  27. templatedir => undef,
  28. ); #}}}
  29. GetOptions( #{{{
  30. "wikiname=s" => \$config{wikiname},
  31. "verbose|v!" => \$config{verbose},
  32. "rebuild!" => \$config{rebuild},
  33. "wrapper!" => \$config{wrapper},
  34. "svn!" => \$config{svn},
  35. "anonok!" => \$config{anonok},
  36. "cgi!" => \$config{cgi},
  37. "url=s" => \$config{url},
  38. "cgiurl=s" => \$config{cgiurl},
  39. "historyurl=s" => \$config{historyurl},
  40. "exclude=s@" => sub {
  41. $config{wiki_file_prune_regexp}=qr/$config{wiki_file_prune_regexp}|$_[1]/;
  42. },
  43. ) || usage();
  44. usage() unless @ARGV == 3;
  45. $config{srcdir} = possibly_foolish_untaint(shift);
  46. $config{templatedir} = possibly_foolish_untaint(shift);
  47. $config{destdir} = possibly_foolish_untaint(shift);
  48. if ($config{cgi} && ! length $config{url}) {
  49. error("Must specify url to wiki with --url when using --cgi");
  50. } #}}}
  51. sub usage { #{{{
  52. die "usage: ikiwiki [options] source templates dest\n";
  53. } #}}}
  54. sub error { #{{{
  55. if ($config{cgi}) {
  56. print "Content-type: text/html\n\n";
  57. print misctemplate("Error", "<p>Error: @_</p>");
  58. exit 1;
  59. }
  60. else {
  61. die @_;
  62. }
  63. } #}}}
  64. sub debug ($) { #{{{
  65. return unless $config{verbose};
  66. if (! $config{cgi}) {
  67. print "@_\n";
  68. }
  69. else {
  70. print STDERR "@_\n";
  71. }
  72. } #}}}
  73. sub mtime ($) { #{{{
  74. my $page=shift;
  75. return (stat($page))[9];
  76. } #}}}
  77. sub possibly_foolish_untaint { #{{{
  78. my $tainted=shift;
  79. my ($untainted)=$tainted=~/(.*)/;
  80. return $untainted;
  81. } #}}}
  82. sub basename ($) { #{{{
  83. my $file=shift;
  84. $file=~s!.*/!!;
  85. return $file;
  86. } #}}}
  87. sub dirname ($) { #{{{
  88. my $file=shift;
  89. $file=~s!/?[^/]+$!!;
  90. return $file;
  91. } #}}}
  92. sub pagetype ($) { #{{{
  93. my $page=shift;
  94. if ($page =~ /\.mdwn$/) {
  95. return ".mdwn";
  96. }
  97. else {
  98. return "unknown";
  99. }
  100. } #}}}
  101. sub pagename ($) { #{{{
  102. my $file=shift;
  103. my $type=pagetype($file);
  104. my $page=$file;
  105. $page=~s/\Q$type\E*$// unless $type eq 'unknown';
  106. return $page;
  107. } #}}}
  108. sub htmlpage ($) { #{{{
  109. my $page=shift;
  110. return $page.".html";
  111. } #}}}
  112. sub readfile ($) { #{{{
  113. my $file=shift;
  114. local $/=undef;
  115. open (IN, "$file") || error("failed to read $file: $!");
  116. my $ret=<IN>;
  117. close IN;
  118. return $ret;
  119. } #}}}
  120. sub writefile ($$) { #{{{
  121. my $file=shift;
  122. my $content=shift;
  123. my $dir=dirname($file);
  124. if (! -d $dir) {
  125. my $d="";
  126. foreach my $s (split(m!/+!, $dir)) {
  127. $d.="$s/";
  128. if (! -d $d) {
  129. mkdir($d) || error("failed to create directory $d: $!");
  130. }
  131. }
  132. }
  133. open (OUT, ">$file") || error("failed to write $file: $!");
  134. print OUT $content;
  135. close OUT;
  136. } #}}}
  137. sub findlinks ($) { #{{{
  138. my $content=shift;
  139. my @links;
  140. while ($content =~ /$config{wiki_link_regexp}/g) {
  141. push @links, lc($1);
  142. }
  143. return @links;
  144. } #}}}
  145. sub bestlink ($$) { #{{{
  146. # Given a page and the text of a link on the page, determine which
  147. # existing page that link best points to. Prefers pages under a
  148. # subdirectory with the same name as the source page, failing that
  149. # goes down the directory tree to the base looking for matching
  150. # pages.
  151. my $page=shift;
  152. my $link=lc(shift);
  153. my $cwd=$page;
  154. do {
  155. my $l=$cwd;
  156. $l.="/" if length $l;
  157. $l.=$link;
  158. if (exists $links{$l}) {
  159. #debug("for $page, \"$link\", use $l");
  160. return $l;
  161. }
  162. } while $cwd=~s!/?[^/]+$!!;
  163. #print STDERR "warning: page $page, broken link: $link\n";
  164. return "";
  165. } #}}}
  166. sub isinlinableimage ($) { #{{{
  167. my $file=shift;
  168. $file=~/\.(png|gif|jpg|jpeg)$/;
  169. } #}}}
  170. sub htmllink { #{{{
  171. my $page=shift;
  172. my $link=shift;
  173. my $noimageinline=shift; # don't turn links into inline html images
  174. my $createsubpage=shift; # force creation of a subpage if page DNE
  175. my $bestlink=bestlink($page, $link);
  176. return $link if length $bestlink && $page eq $bestlink;
  177. # TODO BUG: %renderedfiles may not have it, if the linked to page
  178. # was also added and isn't yet rendered! Note that this bug is
  179. # masked by the bug mentioned below that makes all new files
  180. # be rendered twice.
  181. if (! grep { $_ eq $bestlink } values %renderedfiles) {
  182. $bestlink=htmlpage($bestlink);
  183. }
  184. if (! grep { $_ eq $bestlink } values %renderedfiles) {
  185. if (! $createsubpage) {
  186. return "<a href=\"$config{cgiurl}?do=create&page=$link&from=$page\">?</a>$link"
  187. }
  188. else {
  189. return "<a href=\"$config{cgiurl}?do=create&page=$page/$link\">?</a>$link"
  190. }
  191. }
  192. $bestlink=File::Spec->abs2rel($bestlink, dirname($page));
  193. if (! $noimageinline && isinlinableimage($bestlink)) {
  194. return "<img src=\"$bestlink\">";
  195. }
  196. return "<a href=\"$bestlink\">$link</a>";
  197. } #}}}
  198. sub linkify ($$) { #{{{
  199. my $content=shift;
  200. my $file=shift;
  201. $content =~ s/$config{wiki_link_regexp}/htmllink(pagename($file), $1)/eg;
  202. return $content;
  203. } #}}}
  204. sub htmlize ($$) { #{{{
  205. my $type=shift;
  206. my $content=shift;
  207. if (! $INC{"/usr/bin/markdown"}) {
  208. no warnings 'once';
  209. $blosxom::version="is a proper perl module too much to ask?";
  210. use warnings 'all';
  211. do "/usr/bin/markdown";
  212. }
  213. if ($type eq '.mdwn') {
  214. return Markdown::Markdown($content);
  215. }
  216. else {
  217. error("htmlization of $type not supported");
  218. }
  219. } #}}}
  220. sub backlinks ($) { #{{{
  221. my $page=shift;
  222. my @links;
  223. foreach my $p (keys %links) {
  224. next if bestlink($page, $p) eq $page;
  225. if (grep { length $_ && bestlink($p, $_) eq $page } @{$links{$p}}) {
  226. my $href=File::Spec->abs2rel(htmlpage($p), dirname($page));
  227. # Trim common dir prefixes from both pages.
  228. my $p_trimmed=$p;
  229. my $page_trimmed=$page;
  230. my $dir;
  231. 1 while (($dir)=$page_trimmed=~m!^([^/]+/)!) &&
  232. defined $dir &&
  233. $p_trimmed=~s/^\Q$dir\E// &&
  234. $page_trimmed=~s/^\Q$dir\E//;
  235. push @links, { url => $href, page => $p_trimmed };
  236. }
  237. }
  238. return sort { $a->{page} cmp $b->{page} } @links;
  239. } #}}}
  240. sub parentlinks ($) { #{{{
  241. my $page=shift;
  242. my @ret;
  243. my $pagelink="";
  244. my $path="";
  245. my $skip=1;
  246. foreach my $dir (reverse split("/", $page)) {
  247. if (! $skip) {
  248. unshift @ret, { url => "$path$dir.html", page => $dir };
  249. }
  250. else {
  251. $skip=0;
  252. }
  253. $path.="../";
  254. }
  255. unshift @ret, { url => $path , page => $config{wikiname} };
  256. return @ret;
  257. } #}}}
  258. sub indexlink () { #{{{
  259. return "<a href=\"$config{url}\">$config{wikiname}</a>";
  260. } #}}}
  261. sub finalize ($$) { #{{{
  262. my $content=shift;
  263. my $page=shift;
  264. my $title=basename($page);
  265. $title=~s/_/ /g;
  266. my $template=HTML::Template->new(blind_cache => 1,
  267. filename => "$config{templatedir}/page.tmpl");
  268. if (length $config{cgiurl}) {
  269. $template->param(editurl => "$config{cgiurl}?do=edit&page=$page");
  270. if ($config{svn}) {
  271. $template->param(recentchangesurl => "$config{cgiurl}?do=recentchanges");
  272. }
  273. }
  274. if (length $config{historyurl}) {
  275. my $u=$config{historyurl};
  276. $u=~s/\[\[\]\]/$pagesources{$page}/g;
  277. $template->param(historyurl => $u);
  278. }
  279. $template->param(
  280. title => $title,
  281. wikiname => $config{wikiname},
  282. parentlinks => [parentlinks($page)],
  283. content => $content,
  284. backlinks => [backlinks($page)],
  285. discussionlink => htmllink($page, "Discussion", 1, 1),
  286. );
  287. return $template->output;
  288. } #}}}
  289. sub check_overwrite ($$) { #{{{
  290. # Important security check. Make sure to call this before saving
  291. # any files to the source directory.
  292. my $dest=shift;
  293. my $src=shift;
  294. if (! exists $renderedfiles{$src} && -e $dest && ! $config{rebuild}) {
  295. error("$dest exists and was rendered from ".
  296. join(" ",(grep { $renderedfiles{$_} eq $dest } keys
  297. %renderedfiles)).
  298. ", not from $src before not overwriting");
  299. }
  300. } #}}}
  301. sub render ($) { #{{{
  302. my $file=shift;
  303. my $type=pagetype($file);
  304. my $content=readfile("$config{srcdir}/$file");
  305. if ($type ne 'unknown') {
  306. my $page=pagename($file);
  307. $links{$page}=[findlinks($content)];
  308. $content=linkify($content, $file);
  309. $content=htmlize($type, $content);
  310. $content=finalize($content, $page);
  311. check_overwrite("$config{destdir}/".htmlpage($page), $page);
  312. writefile("$config{destdir}/".htmlpage($page), $content);
  313. $oldpagemtime{$page}=time;
  314. $renderedfiles{$page}=htmlpage($page);
  315. }
  316. else {
  317. $links{$file}=[];
  318. check_overwrite("$config{destdir}/$file", $file);
  319. writefile("$config{destdir}/$file", $content);
  320. $oldpagemtime{$file}=time;
  321. $renderedfiles{$file}=$file;
  322. }
  323. } #}}}
  324. sub loadindex () { #{{{
  325. open (IN, "$config{srcdir}/.ikiwiki/index") || return;
  326. while (<IN>) {
  327. $_=possibly_foolish_untaint($_);
  328. chomp;
  329. my ($mtime, $file, $rendered, @links)=split(' ', $_);
  330. my $page=pagename($file);
  331. $pagesources{$page}=$file;
  332. $oldpagemtime{$page}=$mtime;
  333. $oldlinks{$page}=[@links];
  334. $links{$page}=[@links];
  335. $renderedfiles{$page}=$rendered;
  336. }
  337. close IN;
  338. } #}}}
  339. sub saveindex () { #{{{
  340. if (! -d "$config{srcdir}/.ikiwiki") {
  341. mkdir("$config{srcdir}/.ikiwiki");
  342. }
  343. open (OUT, ">$config{srcdir}/.ikiwiki/index") || error("cannot write to index: $!");
  344. foreach my $page (keys %oldpagemtime) {
  345. print OUT "$oldpagemtime{$page} $pagesources{$page} $renderedfiles{$page} ".
  346. join(" ", @{$links{$page}})."\n"
  347. if $oldpagemtime{$page};
  348. }
  349. close OUT;
  350. } #}}}
  351. sub rcs_update () { #{{{
  352. if (-d "$config{srcdir}/.svn") {
  353. if (system("svn", "update", "--quiet", $config{srcdir}) != 0) {
  354. warn("svn update failed\n");
  355. }
  356. }
  357. } #}}}
  358. sub rcs_commit ($) { #{{{
  359. my $message=shift;
  360. if (-d "$config{srcdir}/.svn") {
  361. if (system("svn", "commit", "--quiet", "-m",
  362. possibly_foolish_untaint($message),
  363. $config{srcdir}) != 0) {
  364. warn("svn commit failed\n");
  365. }
  366. }
  367. } #}}}
  368. sub rcs_add ($) { #{{{
  369. my $file=shift;
  370. if (-d "$config{srcdir}/.svn") {
  371. my $parent=dirname($file);
  372. while (! -d "$config{srcdir}/$parent/.svn") {
  373. $file=$parent;
  374. $parent=dirname($file);
  375. }
  376. if (system("svn", "add", "--quiet", "$config{srcdir}/$file") != 0) {
  377. warn("svn add failed\n");
  378. }
  379. }
  380. } #}}}
  381. sub rcs_recentchanges ($) { #{{{
  382. my $num=shift;
  383. my @ret;
  384. eval q{use Date::Parse};
  385. eval q{use Time::Duration};
  386. if (-d "$config{srcdir}/.svn") {
  387. my $info=`LANG=C svn info $config{srcdir}`;
  388. my ($svn_url)=$info=~/^URL: (.*)$/m;
  389. # FIXME: currently assumes that the wiki is somewhere
  390. # under trunk in svn, doesn't support other layouts.
  391. my ($svn_base)=$svn_url=~m!(/trunk(?:/.*)?)$!;
  392. my $div=qr/^--------------------+$/;
  393. my $infoline=qr/^r(\d+)\s+\|\s+([^\s]+)\s+\|\s+(\d+-\d+-\d+\s+\d+:\d+:\d+\s+[-+]?\d+).*/;
  394. my $state='start';
  395. my ($rev, $user, $when, @pages, @message);
  396. foreach (`LANG=C svn log -v '$svn_url'`) {
  397. chomp;
  398. if ($state eq 'start' && /$div/) {
  399. $state='header';
  400. }
  401. elsif ($state eq 'header' && /$infoline/) {
  402. $rev=$1;
  403. $user=$2;
  404. $when=concise(ago(time - str2time($3)));
  405. }
  406. elsif ($state eq 'header' && /^\s+[A-Z]\s+\Q$svn_base\E\/(.+)$/) {
  407. push @pages, { link => htmllink("", pagename($1), 1) }
  408. if length $1;
  409. }
  410. elsif ($state eq 'header' && /^$/) {
  411. $state='body';
  412. }
  413. elsif ($state eq 'body' && /$div/) {
  414. my $committype="web";
  415. if (defined $message[0] &&
  416. $message[0]->{line}=~/^web commit by (\w+):?(.*)/) {
  417. $user="$1";
  418. $message[0]->{line}=$2;
  419. }
  420. else {
  421. $committype="svn";
  422. }
  423. push @ret, { rev => $rev,
  424. user => htmllink("", $user, 1),
  425. committype => $committype,
  426. when => $when, message => [@message],
  427. pages => [@pages] } if @pages;
  428. return @ret if @ret >= $num;
  429. $state='header';
  430. $rev=$user=$when=undef;
  431. @pages=@message=();
  432. }
  433. elsif ($state eq 'body') {
  434. push @message, {line => $_},
  435. }
  436. }
  437. }
  438. return @ret;
  439. } #}}}
  440. sub prune ($) { #{{{
  441. my $file=shift;
  442. unlink($file);
  443. my $dir=dirname($file);
  444. while (rmdir($dir)) {
  445. $dir=dirname($dir);
  446. }
  447. } #}}}
  448. sub refresh () { #{{{
  449. # Find existing pages.
  450. my %exists;
  451. my @files;
  452. eval q{use File::Find};
  453. find({
  454. no_chdir => 1,
  455. wanted => sub {
  456. if (/$config{wiki_file_prune_regexp}/) {
  457. no warnings 'once';
  458. $File::Find::prune=1;
  459. use warnings "all";
  460. }
  461. elsif (! -d $_) {
  462. my ($f)=/$config{wiki_file_regexp}/; # untaint
  463. if (! defined $f) {
  464. warn("skipping bad filename $_\n");
  465. }
  466. else {
  467. $f=~s/^\Q$config{srcdir}\E\/?//;
  468. push @files, $f;
  469. $exists{pagename($f)}=1;
  470. }
  471. }
  472. },
  473. }, $config{srcdir});
  474. my %rendered;
  475. # check for added or removed pages
  476. my @add;
  477. foreach my $file (@files) {
  478. my $page=pagename($file);
  479. if (! $oldpagemtime{$page}) {
  480. debug("new page $page");
  481. push @add, $file;
  482. $links{$page}=[];
  483. $pagesources{$page}=$file;
  484. }
  485. }
  486. my @del;
  487. foreach my $page (keys %oldpagemtime) {
  488. if (! $exists{$page}) {
  489. debug("removing old page $page");
  490. push @del, $renderedfiles{$page};
  491. prune($config{destdir}."/".$renderedfiles{$page});
  492. delete $renderedfiles{$page};
  493. $oldpagemtime{$page}=0;
  494. delete $pagesources{$page};
  495. }
  496. }
  497. # render any updated files
  498. foreach my $file (@files) {
  499. my $page=pagename($file);
  500. if (! exists $oldpagemtime{$page} ||
  501. mtime("$config{srcdir}/$file") > $oldpagemtime{$page}) {
  502. debug("rendering changed file $file");
  503. render($file);
  504. $rendered{$file}=1;
  505. }
  506. }
  507. # if any files were added or removed, check to see if each page
  508. # needs an update due to linking to them
  509. # TODO: inefficient; pages may get rendered above and again here;
  510. # problem is the bestlink may have changed and we won't know until
  511. # now
  512. if (@add || @del) {
  513. FILE: foreach my $file (@files) {
  514. my $page=pagename($file);
  515. foreach my $f (@add, @del) {
  516. my $p=pagename($f);
  517. foreach my $link (@{$links{$page}}) {
  518. if (bestlink($page, $link) eq $p) {
  519. debug("rendering $file, which links to $p");
  520. render($file);
  521. $rendered{$file}=1;
  522. next FILE;
  523. }
  524. }
  525. }
  526. }
  527. }
  528. # handle backlinks; if a page has added/removed links, update the
  529. # pages it links to
  530. # TODO: inefficient; pages may get rendered above and again here;
  531. # problem is the backlinks could be wrong in the first pass render
  532. # above
  533. if (%rendered) {
  534. my %linkchanged;
  535. foreach my $file (keys %rendered, @del) {
  536. my $page=pagename($file);
  537. if (exists $links{$page}) {
  538. foreach my $link (@{$links{$page}}) {
  539. $link=bestlink($page, $link);
  540. if (length $link &&
  541. ! exists $oldlinks{$page} ||
  542. ! grep { $_ eq $link } @{$oldlinks{$page}}) {
  543. $linkchanged{$link}=1;
  544. }
  545. }
  546. }
  547. if (exists $oldlinks{$page}) {
  548. foreach my $link (@{$oldlinks{$page}}) {
  549. $link=bestlink($page, $link);
  550. if (length $link &&
  551. ! exists $links{$page} ||
  552. ! grep { $_ eq $link } @{$links{$page}}) {
  553. $linkchanged{$link}=1;
  554. }
  555. }
  556. }
  557. }
  558. foreach my $link (keys %linkchanged) {
  559. my $linkfile=$pagesources{$link};
  560. if (defined $linkfile) {
  561. debug("rendering $linkfile, to update its backlinks");
  562. render($linkfile);
  563. }
  564. }
  565. }
  566. } #}}}
  567. sub gen_wrapper () { #{{{
  568. eval q{use Cwd 'abs_path'};
  569. $config{srcdir}=abs_path($config{srcdir});
  570. $config{destdir}=abs_path($config{destdir});
  571. my $this=abs_path($0);
  572. if (! -x $this) {
  573. error("$this doesn't seem to be executable");
  574. }
  575. my @params=($config{srcdir}, $config{templatedir}, $config{destdir},
  576. "--wikiname=$config{wikiname}");
  577. push @params, "--verbose" if $config{verbose};
  578. push @params, "--rebuild" if $config{rebuild};
  579. push @params, "--nosvn" if !$config{svn};
  580. push @params, "--cgi" if $config{cgi};
  581. push @params, "--url=$config{url}" if length $config{url};
  582. push @params, "--cgiurl=$config{cgiurl}" if length $config{cgiurl};
  583. push @params, "--historyurl=$config{historyurl}" if length $config{historyurl};
  584. push @params, "--anonok" if $config{anonok};
  585. my $params=join(" ", map { "\'$_\'" } @params);
  586. my $call='';
  587. foreach my $p ($this, $this, @params) {
  588. $call.=qq{"$p", };
  589. }
  590. $call.="NULL";
  591. my @envsave;
  592. push @envsave, qw{REMOTE_ADDR QUERY_STRING REQUEST_METHOD REQUEST_URI
  593. CONTENT_TYPE CONTENT_LENGTH GATEWAY_INTERFACE
  594. HTTP_COOKIE} if $config{cgi};
  595. my $envsave="";
  596. foreach my $var (@envsave) {
  597. $envsave.=<<"EOF"
  598. if ((s=getenv("$var")))
  599. asprintf(&newenviron[i++], "%s=%s", "$var", s);
  600. EOF
  601. }
  602. open(OUT, ">ikiwiki-wrap.c") || error("failed to write ikiwiki-wrap.c: $!");;
  603. print OUT <<"EOF";
  604. /* A wrapper for ikiwiki, can be safely made suid. */
  605. #define _GNU_SOURCE
  606. #include <stdio.h>
  607. #include <unistd.h>
  608. #include <stdlib.h>
  609. #include <string.h>
  610. extern char **environ;
  611. int main (int argc, char **argv) {
  612. /* Sanitize environment. */
  613. char *s;
  614. char *newenviron[$#envsave+3];
  615. int i=0;
  616. $envsave
  617. newenviron[i++]="HOME=$ENV{HOME}";
  618. newenviron[i]=NULL;
  619. environ=newenviron;
  620. if (argc == 2 && strcmp(argv[1], "--params") == 0) {
  621. printf("$params\\n");
  622. exit(0);
  623. }
  624. execl($call);
  625. perror("failed to run $this");
  626. exit(1);
  627. }
  628. EOF
  629. close OUT;
  630. if (system("gcc", "ikiwiki-wrap.c", "-o", "ikiwiki-wrap") != 0) {
  631. error("failed to compile ikiwiki-wrap.c");
  632. }
  633. unlink("ikiwiki-wrap.c");
  634. print "successfully generated ikiwiki-wrap\n";
  635. exit 0;
  636. } #}}}
  637. sub misctemplate ($$) { #{{{
  638. my $title=shift;
  639. my $pagebody=shift;
  640. my $template=HTML::Template->new(
  641. filename => "$config{templatedir}/misc.tmpl"
  642. );
  643. $template->param(
  644. title => $title,
  645. indexlink => indexlink(),
  646. wikiname => $config{wikiname},
  647. pagebody => $pagebody,
  648. );
  649. return $template->output;
  650. }#}}}
  651. sub cgi_recentchanges ($) { #{{{
  652. my $q=shift;
  653. my $template=HTML::Template->new(
  654. filename => "$config{templatedir}/recentchanges.tmpl"
  655. );
  656. $template->param(
  657. title => "RecentChanges",
  658. indexlink => indexlink(),
  659. wikiname => $config{wikiname},
  660. changelog => [rcs_recentchanges(100)],
  661. );
  662. print $q->header, $template->output;
  663. } #}}}
  664. sub userinfo_get ($$) { #{{{
  665. my $user=shift;
  666. my $field=shift;
  667. eval q{use Storable};
  668. my $userdata=eval{ Storable::lock_retrieve("$config{srcdir}/.ikiwiki/userdb") };
  669. if (! defined $userdata || ! ref $userdata ||
  670. ! exists $userdata->{$user} || ! ref $userdata->{$user}) {
  671. return "";
  672. }
  673. return $userdata->{$user}->{$field};
  674. } #}}}
  675. sub userinfo_set ($$) { #{{{
  676. my $user=shift;
  677. my $info=shift;
  678. eval q{use Storable};
  679. my $userdata=eval{ Storable::lock_retrieve("$config{srcdir}/.ikiwiki/userdb") };
  680. if (! defined $userdata || ! ref $userdata) {
  681. $userdata={};
  682. }
  683. $userdata->{$user}=$info;
  684. my $oldmask=umask(077);
  685. my $ret=Storable::lock_store($userdata, "$config{srcdir}/.ikiwiki/userdb");
  686. umask($oldmask);
  687. return $ret;
  688. } #}}}
  689. sub cgi_signin ($$) { #{{{
  690. my $q=shift;
  691. my $session=shift;
  692. eval q{use CGI::FormBuilder};
  693. my $form = CGI::FormBuilder->new(
  694. title => "$config{wikiname} signin",
  695. fields => [qw(do page from name password confirm_password email)],
  696. header => 1,
  697. method => 'POST',
  698. validate => {
  699. confirm_password => {
  700. perl => q{eq $form->field("password")},
  701. },
  702. email => 'EMAIL',
  703. },
  704. required => 'NONE',
  705. javascript => 0,
  706. params => $q,
  707. action => $q->request_uri,
  708. header => 0,
  709. template => (-e "$config{templatedir}/signin.tmpl" ?
  710. "$config{templatedir}/signin.tmpl" : "")
  711. );
  712. $form->field(name => "name", required => 0);
  713. $form->field(name => "do", type => "hidden");
  714. $form->field(name => "page", type => "hidden");
  715. $form->field(name => "from", type => "hidden");
  716. $form->field(name => "password", type => "password", required => 0);
  717. $form->field(name => "confirm_password", type => "password", required => 0);
  718. $form->field(name => "email", required => 0);
  719. if ($q->param("do") ne "signin") {
  720. $form->text("You need to log in before you can edit pages.");
  721. }
  722. if ($form->submitted) {
  723. # Set required fields based on how form was submitted.
  724. my %required=(
  725. "Login" => [qw(name password)],
  726. "Register" => [qw(name password confirm_password email)],
  727. "Mail Password" => [qw(name)],
  728. );
  729. foreach my $opt (@{$required{$form->submitted}}) {
  730. $form->field(name => $opt, required => 1);
  731. }
  732. # Validate password differently depending on how
  733. # form was submitted.
  734. if ($form->submitted eq 'Login') {
  735. $form->field(
  736. name => "password",
  737. validate => sub {
  738. length $form->field("name") &&
  739. shift eq userinfo_get($form->field("name"), 'password');
  740. },
  741. );
  742. $form->field(name => "name", validate => '/^\w+$/');
  743. }
  744. else {
  745. $form->field(name => "password", validate => 'VALUE');
  746. }
  747. # And make sure the entered name exists when logging
  748. # in or sending email, and does not when registering.
  749. if ($form->submitted eq 'Register') {
  750. $form->field(
  751. name => "name",
  752. validate => sub {
  753. my $name=shift;
  754. length $name &&
  755. ! userinfo_get($name, "regdate");
  756. },
  757. );
  758. }
  759. else {
  760. $form->field(
  761. name => "name",
  762. validate => sub {
  763. my $name=shift;
  764. length $name &&
  765. userinfo_get($name, "regdate");
  766. },
  767. );
  768. }
  769. }
  770. else {
  771. # First time settings.
  772. $form->field(name => "name", comment => "use FirstnameLastName");
  773. $form->field(name => "confirm_password", comment => "(only needed");
  774. $form->field(name => "email", comment => "for registration)");
  775. if ($session->param("name")) {
  776. $form->field(name => "name", value => $session->param("name"));
  777. }
  778. }
  779. if ($form->submitted && $form->validate) {
  780. if ($form->submitted eq 'Login') {
  781. $session->param("name", $form->field("name"));
  782. if (defined $form->field("do") &&
  783. $form->field("do") ne 'signin') {
  784. print $q->redirect(
  785. "$config{cgiurl}?do=".$form->field("do").
  786. "&page=".$form->field("page").
  787. "&from=".$form->field("from"));;
  788. }
  789. else {
  790. print $q->redirect($config{url});
  791. }
  792. }
  793. elsif ($form->submitted eq 'Register') {
  794. my $user_name=$form->field('name');
  795. if (userinfo_set($user_name, {
  796. 'email' => $form->field('email'),
  797. 'password' => $form->field('password'),
  798. 'regdate' => time
  799. })) {
  800. $form->field(name => "confirm_password", type => "hidden");
  801. $form->field(name => "email", type => "hidden");
  802. $form->text("Registration successful. Now you can Login.");
  803. print $session->header();
  804. print misctemplate($form->title, $form->render(submit => ["Login"]));
  805. }
  806. else {
  807. error("Error saving registration.");
  808. }
  809. }
  810. elsif ($form->submitted eq 'Mail Password') {
  811. my $user_name=$form->field("name");
  812. my $template=HTML::Template->new(
  813. filename => "$config{templatedir}/passwordmail.tmpl"
  814. );
  815. $template->param(
  816. user_name => $user_name,
  817. user_password => userinfo_get($user_name, "password"),
  818. wikiurl => $config{url},
  819. wikiname => $config{wikiname},
  820. REMOTE_ADDR => $ENV{REMOTE_ADDR},
  821. );
  822. eval q{use Mail::Sendmail};
  823. my ($fromhost) = $config{cgiurl} =~ m!/([^/]+)!;
  824. sendmail(
  825. To => userinfo_get($user_name, "email"),
  826. From => "$config{wikiname} admin <".(getpwuid($>))[0]."@".$fromhost.">",
  827. Subject => "$config{wikiname} information",
  828. Message => $template->output,
  829. ) or error("Failed to send mail");
  830. $form->text("Your password has been emailed to you.");
  831. $form->field(name => "name", required => 0);
  832. print $session->header();
  833. print misctemplate($form->title, $form->render(submit => ["Login", "Register", "Mail Password"]));
  834. }
  835. }
  836. else {
  837. print $session->header();
  838. print misctemplate($form->title, $form->render(submit => ["Login", "Register", "Mail Password"]));
  839. }
  840. } #}}}
  841. sub cgi_editpage ($$) { #{{{
  842. my $q=shift;
  843. my $session=shift;
  844. eval q{use CGI::FormBuilder};
  845. my $form = CGI::FormBuilder->new(
  846. fields => [qw(do from page content comments)],
  847. header => 1,
  848. method => 'POST',
  849. validate => {
  850. content => '/.+/',
  851. },
  852. required => [qw{content}],
  853. javascript => 0,
  854. params => $q,
  855. action => $q->request_uri,
  856. table => 0,
  857. template => "$config{templatedir}/editpage.tmpl"
  858. );
  859. my ($page)=$form->param('page')=~/$config{wiki_file_regexp}/;
  860. if (! defined $page || ! length $page || $page ne $q->param('page') ||
  861. $page=~/$config{wiki_file_prune_regexp}/ || $page=~/^\//) {
  862. error("bad page name");
  863. }
  864. $page=lc($page);
  865. $form->field(name => "do", type => 'hidden');
  866. $form->field(name => "from", type => 'hidden');
  867. $form->field(name => "page", value => "$page", force => 1);
  868. $form->field(name => "comments", type => "text", size => 80);
  869. $form->field(name => "content", type => "textarea", rows => 20,
  870. cols => 80);
  871. if ($form->submitted eq "Cancel") {
  872. print $q->redirect("$config{url}/".htmlpage($page));
  873. return;
  874. }
  875. if (! $form->submitted || ! $form->validate) {
  876. if ($form->field("do") eq "create") {
  877. if (exists $pagesources{lc($page)}) {
  878. # hmm, someone else made the page in the
  879. # meantime?
  880. print $q->redirect("$config{url}/".htmlpage($page));
  881. return;
  882. }
  883. my @page_locs;
  884. my ($from)=$form->param('from')=~/$config{wiki_file_regexp}/;
  885. if (! defined $from || ! length $from ||
  886. $from ne $form->param('from') ||
  887. $from=~/$config{wiki_file_prune_regexp}/ || $from=~/^\//) {
  888. @page_locs=$page;
  889. }
  890. else {
  891. my $dir=$from."/";
  892. $dir=~s![^/]+/$!!;
  893. push @page_locs, $dir.$page;
  894. push @page_locs, "$from/$page";
  895. while (length $dir) {
  896. $dir=~s![^/]+/$!!;
  897. push @page_locs, $dir.$page;
  898. }
  899. }
  900. $form->tmpl_param("page_select", 1);
  901. $form->field(name => "page", type => 'select',
  902. options => \@page_locs);
  903. $form->title("creating $page");
  904. }
  905. elsif ($form->field("do") eq "edit") {
  906. my $content="";
  907. if (exists $pagesources{lc($page)}) {
  908. $content=readfile("$config{srcdir}/$pagesources{lc($page)}");
  909. $content=~s/\n/\r\n/g;
  910. }
  911. $form->tmpl_param("page_select", 0);
  912. $form->field(name => "content", value => $content,
  913. force => 1);
  914. $form->field(name => "page", type => 'hidden');
  915. $form->title("editing $page");
  916. }
  917. $form->tmpl_param("can_commit", $config{svn});
  918. $form->tmpl_param("indexlink", indexlink());
  919. print $form->render(submit => ["Save Page", "Cancel"]);
  920. }
  921. else {
  922. # save page
  923. my $file=$page.$config{default_pageext};
  924. my $newfile=1;
  925. if (exists $pagesources{lc($page)}) {
  926. $file=$pagesources{lc($page)};
  927. $newfile=0;
  928. }
  929. my $content=$form->field('content');
  930. $content=~s/\r\n/\n/g;
  931. $content=~s/\r/\n/g;
  932. writefile("$config{srcdir}/$file", $content);
  933. my $message="web commit ";
  934. if ($session->param("name")) {
  935. $message.="by ".$session->param("name");
  936. }
  937. else {
  938. $message.="from $ENV{REMOTE_ADDR}";
  939. }
  940. if (defined $form->field('comments') &&
  941. length $form->field('comments')) {
  942. $message.=": ".$form->field('comments');
  943. }
  944. if ($config{svn}) {
  945. if ($newfile) {
  946. rcs_add($file);
  947. }
  948. # presumably the commit will trigger an update
  949. # of the wiki
  950. rcs_commit($message);
  951. }
  952. else {
  953. refresh();
  954. }
  955. # The trailing question mark tries to avoid broken
  956. # caches and get the most recent version of the page.
  957. print $q->redirect("$config{url}/".htmlpage($page)."?updated");
  958. }
  959. } #}}}
  960. sub cgi () { #{{{
  961. eval q{use CGI};
  962. eval q{use CGI::Session};
  963. my $q=CGI->new;
  964. my $do=$q->param('do');
  965. if (! defined $do || ! length $do) {
  966. error("\"do\" parameter missing");
  967. }
  968. # This does not need a session.
  969. if ($do eq 'recentchanges') {
  970. cgi_recentchanges($q);
  971. return;
  972. }
  973. CGI::Session->name("ikiwiki_session");
  974. my $oldmask=umask(077);
  975. my $session = CGI::Session->new("driver:db_file", $q,
  976. { FileName => "$config{srcdir}/.ikiwiki/sessions.db" });
  977. umask($oldmask);
  978. # Everything below this point needs the user to be signed in.
  979. if ((! $config{anonok} && ! defined $session->param("name") ||
  980. ! userinfo_get($session->param("name"), "regdate")) || $do eq 'signin') {
  981. cgi_signin($q, $session);
  982. # Force session flush with safe umask.
  983. my $oldmask=umask(077);
  984. $session->flush;
  985. umask($oldmask);
  986. return;
  987. }
  988. if ($do eq 'create' || $do eq 'edit') {
  989. cgi_editpage($q, $session);
  990. }
  991. else {
  992. error("unknown do parameter");
  993. }
  994. } #}}}
  995. # main {{{
  996. gen_wrapper() if $config{wrapper};
  997. memoize('pagename');
  998. memoize('bestlink');
  999. loadindex() unless $config{rebuild};
  1000. if ($config{cgi}) {
  1001. cgi();
  1002. }
  1003. else {
  1004. rcs_update() if $config{svn};
  1005. refresh();
  1006. saveindex();
  1007. }
  1008. #}}}