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