summaryrefslogtreecommitdiff
path: root/IkiWiki/CGI.pm
blob: 7c12bee5bdef4b091ab360d465a908acf01d39be (plain)
  1. #!/usr/bin/perl
  2. use warnings;
  3. use strict;
  4. package IkiWiki;
  5. sub page_locked ($$;$) { #{{{
  6. my $page=shift;
  7. my $session=shift;
  8. my $nonfatal=shift;
  9. my $user=$session->param("name");
  10. return if length $user && is_admin($user);
  11. foreach my $admin (@{$config{adminuser}}) {
  12. my $locked_pages=userinfo_get($admin, "locked_pages");
  13. if (globlist_match($page, userinfo_get($admin, "locked_pages"))) {
  14. return 1 if $nonfatal;
  15. error(htmllink("", $page, 1)." is locked by ".
  16. htmllink("", $admin, 1)." and cannot be edited.");
  17. }
  18. }
  19. return 0;
  20. } #}}}
  21. sub cgi_recentchanges ($) { #{{{
  22. my $q=shift;
  23. unlockwiki();
  24. my $template=HTML::Template->new(
  25. filename => "$config{templatedir}/recentchanges.tmpl"
  26. );
  27. $template->param(
  28. title => "RecentChanges",
  29. indexlink => indexlink(),
  30. wikiname => $config{wikiname},
  31. changelog => [rcs_recentchanges(100)],
  32. );
  33. print $q->header, $template->output;
  34. } #}}}
  35. sub cgi_signin ($$) { #{{{
  36. my $q=shift;
  37. my $session=shift;
  38. eval q{use CGI::FormBuilder};
  39. my $form = CGI::FormBuilder->new(
  40. title => "signin",
  41. fields => [qw(do title page subpage from name password confirm_password email)],
  42. header => 1,
  43. method => 'POST',
  44. validate => {
  45. confirm_password => {
  46. perl => q{eq $form->field("password")},
  47. },
  48. email => 'EMAIL',
  49. },
  50. required => 'NONE',
  51. javascript => 0,
  52. params => $q,
  53. action => $q->request_uri,
  54. header => 0,
  55. template => (-e "$config{templatedir}/signin.tmpl" ?
  56. "$config{templatedir}/signin.tmpl" : "")
  57. );
  58. $form->field(name => "name", required => 0);
  59. $form->field(name => "do", type => "hidden");
  60. $form->field(name => "page", type => "hidden");
  61. $form->field(name => "title", type => "hidden");
  62. $form->field(name => "from", type => "hidden");
  63. $form->field(name => "subpage", type => "hidden");
  64. $form->field(name => "password", type => "password", required => 0);
  65. $form->field(name => "confirm_password", type => "password", required => 0);
  66. $form->field(name => "email", required => 0);
  67. if ($q->param("do") ne "signin") {
  68. $form->text("You need to log in first.");
  69. }
  70. if ($form->submitted) {
  71. # Set required fields based on how form was submitted.
  72. my %required=(
  73. "Login" => [qw(name password)],
  74. "Register" => [qw(name password confirm_password email)],
  75. "Mail Password" => [qw(name)],
  76. );
  77. foreach my $opt (@{$required{$form->submitted}}) {
  78. $form->field(name => $opt, required => 1);
  79. }
  80. # Validate password differently depending on how
  81. # form was submitted.
  82. if ($form->submitted eq 'Login') {
  83. $form->field(
  84. name => "password",
  85. validate => sub {
  86. length $form->field("name") &&
  87. shift eq userinfo_get($form->field("name"), 'password');
  88. },
  89. );
  90. $form->field(name => "name", validate => '/^\w+$/');
  91. }
  92. else {
  93. $form->field(name => "password", validate => 'VALUE');
  94. }
  95. # And make sure the entered name exists when logging
  96. # in or sending email, and does not when registering.
  97. if ($form->submitted eq 'Register') {
  98. $form->field(
  99. name => "name",
  100. validate => sub {
  101. my $name=shift;
  102. length $name &&
  103. ! userinfo_get($name, "regdate");
  104. },
  105. );
  106. }
  107. else {
  108. $form->field(
  109. name => "name",
  110. validate => sub {
  111. my $name=shift;
  112. length $name &&
  113. userinfo_get($name, "regdate");
  114. },
  115. );
  116. }
  117. }
  118. else {
  119. # First time settings.
  120. $form->field(name => "name", comment => "use FirstnameLastName");
  121. $form->field(name => "confirm_password", comment => "(only needed");
  122. $form->field(name => "email", comment => "for registration)");
  123. if ($session->param("name")) {
  124. $form->field(name => "name", value => $session->param("name"));
  125. }
  126. }
  127. if ($form->submitted && $form->validate) {
  128. if ($form->submitted eq 'Login') {
  129. $session->param("name", $form->field("name"));
  130. if (defined $form->field("do") &&
  131. $form->field("do") ne 'signin') {
  132. print $q->redirect(
  133. "$config{cgiurl}?do=".$form->field("do").
  134. "&page=".$form->field("page").
  135. "&title=".$form->field("title").
  136. "&subpage=".$form->field("subpage").
  137. "&from=".$form->field("from"));;
  138. }
  139. else {
  140. print $q->redirect($config{url});
  141. }
  142. }
  143. elsif ($form->submitted eq 'Register') {
  144. my $user_name=$form->field('name');
  145. if (userinfo_setall($user_name, {
  146. 'email' => $form->field('email'),
  147. 'password' => $form->field('password'),
  148. 'regdate' => time
  149. })) {
  150. $form->field(name => "confirm_password", type => "hidden");
  151. $form->field(name => "email", type => "hidden");
  152. $form->text("Registration successful. Now you can Login.");
  153. print $session->header();
  154. print misctemplate($form->title, $form->render(submit => ["Login"]));
  155. }
  156. else {
  157. error("Error saving registration.");
  158. }
  159. }
  160. elsif ($form->submitted eq 'Mail Password') {
  161. my $user_name=$form->field("name");
  162. my $template=HTML::Template->new(
  163. filename => "$config{templatedir}/passwordmail.tmpl"
  164. );
  165. $template->param(
  166. user_name => $user_name,
  167. user_password => userinfo_get($user_name, "password"),
  168. wikiurl => $config{url},
  169. wikiname => $config{wikiname},
  170. REMOTE_ADDR => $ENV{REMOTE_ADDR},
  171. );
  172. eval q{use Mail::Sendmail};
  173. my ($fromhost) = $config{cgiurl} =~ m!/([^/]+)!;
  174. sendmail(
  175. To => userinfo_get($user_name, "email"),
  176. From => "$config{wikiname} admin <".(getpwuid($>))[0]."@".$fromhost.">",
  177. Subject => "$config{wikiname} information",
  178. Message => $template->output,
  179. ) or error("Failed to send mail");
  180. $form->text("Your password has been emailed to you.");
  181. $form->field(name => "name", required => 0);
  182. print $session->header();
  183. print misctemplate($form->title, $form->render(submit => ["Login", "Register", "Mail Password"]));
  184. }
  185. }
  186. else {
  187. print $session->header();
  188. print misctemplate($form->title, $form->render(submit => ["Login", "Register", "Mail Password"]));
  189. }
  190. } #}}}
  191. sub cgi_prefs ($$) { #{{{
  192. my $q=shift;
  193. my $session=shift;
  194. eval q{use CGI::FormBuilder};
  195. my $form = CGI::FormBuilder->new(
  196. title => "preferences",
  197. fields => [qw(do name password confirm_password email locked_pages)],
  198. header => 0,
  199. method => 'POST',
  200. validate => {
  201. confirm_password => {
  202. perl => q{eq $form->field("password")},
  203. },
  204. email => 'EMAIL',
  205. },
  206. required => 'NONE',
  207. javascript => 0,
  208. params => $q,
  209. action => $q->request_uri,
  210. template => (-e "$config{templatedir}/prefs.tmpl" ?
  211. "$config{templatedir}/prefs.tmpl" : "")
  212. );
  213. my @buttons=("Save Preferences", "Logout", "Cancel");
  214. my $user_name=$session->param("name");
  215. $form->field(name => "do", type => "hidden");
  216. $form->field(name => "name", disabled => 1,
  217. value => $user_name, force => 1);
  218. $form->field(name => "password", type => "password");
  219. $form->field(name => "confirm_password", type => "password");
  220. $form->field(name => "locked_pages", size => 50,
  221. comment => "(".htmllink("", "GlobList", 1).")");
  222. if (! is_admin($user_name)) {
  223. $form->field(name => "locked_pages", type => "hidden");
  224. }
  225. if (! $form->submitted) {
  226. $form->field(name => "email", force => 1,
  227. value => userinfo_get($user_name, "email"));
  228. $form->field(name => "locked_pages", force => 1,
  229. value => userinfo_get($user_name, "locked_pages"));
  230. }
  231. if ($form->submitted eq 'Logout') {
  232. $session->delete();
  233. print $q->redirect($config{url});
  234. return;
  235. }
  236. elsif ($form->submitted eq 'Cancel') {
  237. print $q->redirect($config{url});
  238. return;
  239. }
  240. elsif ($form->submitted eq "Save Preferences" && $form->validate) {
  241. foreach my $field (qw(password email locked_pages)) {
  242. if (length $form->field($field)) {
  243. userinfo_set($user_name, $field, $form->field($field)) || error("failed to set $field");
  244. }
  245. }
  246. $form->text("Preferences saved.");
  247. }
  248. print $session->header();
  249. print misctemplate($form->title, $form->render(submit => \@buttons));
  250. } #}}}
  251. sub cgi_editpage ($$) { #{{{
  252. my $q=shift;
  253. my $session=shift;
  254. eval q{use CGI::FormBuilder};
  255. my $form = CGI::FormBuilder->new(
  256. fields => [qw(do rcsinfo subpage from page content comments)],
  257. header => 1,
  258. method => 'POST',
  259. validate => {
  260. content => '/.+/',
  261. },
  262. required => [qw{content}],
  263. javascript => 0,
  264. params => $q,
  265. action => $q->request_uri,
  266. table => 0,
  267. template => "$config{templatedir}/editpage.tmpl"
  268. );
  269. my @buttons=("Save Page", "Preview", "Cancel");
  270. # This untaint is safe because titlepage removes any problimatic
  271. # characters.
  272. my ($page)=titlepage(possibly_foolish_untaint(lc($form->param('page'))));
  273. if (! defined $page || ! length $page ||
  274. $page=~/$config{wiki_file_prune_regexp}/ || $page=~/^\//) {
  275. error("bad page name");
  276. }
  277. $page=lc($page);
  278. my $file=$page.$config{default_pageext};
  279. my $newfile=1;
  280. if (exists $pagesources{lc($page)}) {
  281. $file=$pagesources{lc($page)};
  282. $newfile=0;
  283. }
  284. $form->field(name => "do", type => 'hidden');
  285. $form->field(name => "from", type => 'hidden');
  286. $form->field(name => "rcsinfo", type => 'hidden');
  287. $form->field(name => "subpage", type => 'hidden');
  288. $form->field(name => "page", value => "$page", force => 1);
  289. $form->field(name => "comments", type => "text", size => 80);
  290. $form->field(name => "content", type => "textarea", rows => 20,
  291. cols => 80);
  292. $form->tmpl_param("can_commit", $config{rcs});
  293. $form->tmpl_param("indexlink", indexlink());
  294. $form->tmpl_param("helponformattinglink",
  295. htmllink("", "HelpOnFormatting", 1));
  296. if (! $form->submitted) {
  297. $form->field(name => "rcsinfo", value => rcs_prepedit($file),
  298. force => 1);
  299. }
  300. if ($form->submitted eq "Cancel") {
  301. print $q->redirect("$config{url}/".htmlpage($page));
  302. return;
  303. }
  304. elsif ($form->submitted eq "Preview") {
  305. require IkiWiki::Render;
  306. $form->tmpl_param("page_preview",
  307. htmlize($config{default_pageext},
  308. linkify($form->field('content'), $page)));
  309. }
  310. else {
  311. $form->tmpl_param("page_preview", "");
  312. }
  313. $form->tmpl_param("page_conflict", "");
  314. if (! $form->submitted || $form->submitted eq "Preview" ||
  315. ! $form->validate) {
  316. if ($form->field("do") eq "create") {
  317. if (exists $pagesources{lc($page)}) {
  318. # hmm, someone else made the page in the
  319. # meantime?
  320. print $q->redirect("$config{url}/".htmlpage($page));
  321. return;
  322. }
  323. my @page_locs;
  324. my $best_loc;
  325. my ($from)=$form->param('from')=~/$config{wiki_file_regexp}/;
  326. if (! defined $from || ! length $from ||
  327. $from ne $form->param('from') ||
  328. $from=~/$config{wiki_file_prune_regexp}/ ||
  329. $from=~/^\// ||
  330. $form->submitted eq "Preview") {
  331. @page_locs=$best_loc=$page;
  332. }
  333. else {
  334. my $dir=$from."/";
  335. $dir=~s![^/]+/$!!;
  336. if ((defined $form->param('subpage') && length $form->param('subpage')) ||
  337. $page eq 'discussion') {
  338. $best_loc="$from/$page";
  339. }
  340. else {
  341. $best_loc=$dir.$page;
  342. }
  343. push @page_locs, $dir.$page;
  344. push @page_locs, "$from/$page";
  345. while (length $dir) {
  346. $dir=~s![^/]+/$!!;
  347. push @page_locs, $dir.$page;
  348. }
  349. @page_locs = grep {
  350. ! exists $pagesources{lc($_)} &&
  351. ! page_locked($_, $session, 1)
  352. } @page_locs;
  353. }
  354. $form->tmpl_param("page_select", 1);
  355. $form->field(name => "page", type => 'select',
  356. options => \@page_locs, value => $best_loc);
  357. $form->title("creating ".pagetitle($page));
  358. }
  359. elsif ($form->field("do") eq "edit") {
  360. page_locked($page, $session);
  361. if (! defined $form->field('content') ||
  362. ! length $form->field('content')) {
  363. my $content="";
  364. if (exists $pagesources{lc($page)}) {
  365. $content=readfile("$config{srcdir}/$pagesources{lc($page)}");
  366. $content=~s/\n/\r\n/g;
  367. }
  368. $form->field(name => "content", value => $content,
  369. force => 1);
  370. }
  371. $form->tmpl_param("page_select", 0);
  372. $form->field(name => "page", type => 'hidden');
  373. $form->title("editing ".pagetitle($page));
  374. }
  375. print $form->render(submit => \@buttons);
  376. }
  377. else {
  378. # save page
  379. page_locked($page, $session);
  380. my $content=$form->field('content');
  381. $content=~s/\r\n/\n/g;
  382. $content=~s/\r/\n/g;
  383. writefile("$config{srcdir}/$file", $content);
  384. my $message="web commit ";
  385. if (length $session->param("name")) {
  386. $message.="by ".$session->param("name");
  387. }
  388. else {
  389. $message.="from $ENV{REMOTE_ADDR}";
  390. }
  391. if (defined $form->field('comments') &&
  392. length $form->field('comments')) {
  393. $message.=": ".$form->field('comments');
  394. }
  395. if ($config{rcs}) {
  396. if ($newfile) {
  397. rcs_add($file);
  398. }
  399. # prevent deadlock with post-commit hook
  400. unlockwiki();
  401. # presumably the commit will trigger an update
  402. # of the wiki
  403. my $conflict=rcs_commit($file, $message,
  404. $form->field("rcsinfo"));
  405. if (defined $conflict) {
  406. $form->field(name => "rcsinfo", value => rcs_prepedit($file),
  407. force => 1);
  408. $form->tmpl_param("page_conflict", 1);
  409. $form->field("content", value => $conflict, force => 1);
  410. $form->field("do", "edit)");
  411. $form->tmpl_param("page_select", 0);
  412. $form->field(name => "page", type => 'hidden');
  413. $form->title("editing $page");
  414. print $form->render(submit => \@buttons);
  415. return;
  416. }
  417. }
  418. else {
  419. require IkiWiki::Render;
  420. refresh();
  421. saveindex();
  422. }
  423. # The trailing question mark tries to avoid broken
  424. # caches and get the most recent version of the page.
  425. print $q->redirect("$config{url}/".htmlpage($page)."?updated");
  426. }
  427. } #}}}
  428. sub cgi () { #{{{
  429. eval q{use CGI};
  430. eval q{use CGI::Session};
  431. my $q=CGI->new;
  432. my $do=$q->param('do');
  433. if (! defined $do || ! length $do) {
  434. error("\"do\" parameter missing");
  435. }
  436. # Things that do not need a session.
  437. if ($do eq 'recentchanges') {
  438. cgi_recentchanges($q);
  439. return;
  440. }
  441. CGI::Session->name("ikiwiki_session_$config{wikiname}");
  442. my $oldmask=umask(077);
  443. my $session = CGI::Session->new("driver:db_file", $q,
  444. { FileName => "$config{wikistatedir}/sessions.db" });
  445. umask($oldmask);
  446. # Everything below this point needs the user to be signed in.
  447. if ((! $config{anonok} && ! defined $session->param("name") ||
  448. ! defined $session->param("name") ||
  449. ! userinfo_get($session->param("name"), "regdate")) || $do eq 'signin') {
  450. cgi_signin($q, $session);
  451. # Force session flush with safe umask.
  452. my $oldmask=umask(077);
  453. $session->flush;
  454. umask($oldmask);
  455. return;
  456. }
  457. if ($do eq 'create' || $do eq 'edit') {
  458. cgi_editpage($q, $session);
  459. }
  460. elsif ($do eq 'prefs') {
  461. cgi_prefs($q, $session);
  462. }
  463. elsif ($do eq 'blog') {
  464. my $page=titlepage(lc($q->param('title')));
  465. # if the page already exists, munge it to be unique
  466. my $from=$q->param('from');
  467. my $add="";
  468. while (exists $oldpagemtime{"$from/$page$add"}) {
  469. $add=1 unless length $add;
  470. $add++;
  471. }
  472. $q->param('page', $page.$add);
  473. # now run same as create
  474. $q->param('do', 'create');
  475. cgi_editpage($q, $session);
  476. }
  477. else {
  478. error("unknown do parameter");
  479. }
  480. } #}}}
  481. 1