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