first pass
[ikiwiki.git] / doc / patchqueue / move_page.mdwn
1 This is my first cut at a feature like that requested in [[todo/Moving_Pages]]. In case it gets mangled you can find it on [my site](http://www.betacantrips.com//attic/move.patch).
2
3 A bunch of obvious shortcomings exist: 
4
5 * I'm not sure all the untaints are safe.
6 * No precautions whatsoever are made to protect against race conditions or failures
7   in the rcs\_move function.
8 * movepage.tmpl doesn't exist yet.
9 * Some code is duplicated between cgi\_movepage and cgi\_editpage, as well
10   as rcs\_commit and rcs\_move.
11 * The user interface is pretty lame -- there's no handy select list full 
12   of possible places to move it or anything.
13 * I don't think I implemented cancelling.
14 * from is redundant with page.
15 * I don't think I called the right hook functions.
16 * No redirect pages like those mentioned on [[todo/Moving_Pages]] exist yet, 
17   so none are created.
18 * It's not possible to get there through the actions listed on the wiki page.
19   Instead you can select "Edit" and then change "edit" to "move" in the 
20   location bar.
21
22 Anyhow, here's the patch, for whatever good it does.
23
24 > Looks like a good start, although I agree about many of the points above,
25 > and also feel that something needs to be done about rcses that don't
26 > implement a move operation -- falling back to an add and delete.
27 > --[[Joey]]
28
29
30     diff -urx .svn ikiwiki/IkiWiki/CGI.pm ikiwiki-new/IkiWiki/CGI.pm
31     --- ikiwiki/IkiWiki/CGI.pm  2007-01-04 03:52:47.000000000 -0800
32     +++ ikiwiki-new/IkiWiki/CGI.pm      2007-01-11 18:49:37.000000000 -0800
33     @@ -523,6 +523,97 @@
34         }
35      } #}}}
36      
37     +sub cgi_movepage($$) {
38     +   my $q = shift;
39     +   my $session = shift;
40     +   eval q{use CGI::FormBuilder};
41     +   error($@) if $@;
42     +   my @fields=qw(do from rcsinfo subpage page newname message); # subpage ignored so far
43     +   my @buttons=("Rename Page", "Cancel");
44     +
45     +   my $form = CGI::FormBuilder->new(
46     +           fields => \@fields,
47     +                header => 1,
48     +                charset => "utf-8",
49     +                method => 'POST',
50     +           action => $config{cgiurl},
51     +                template => (-e "$config{templatedir}/movepage.tmpl" ?
52     +                        {template_params("movepage.tpml")} : ""),
53     +   );
54     +   run_hooks(formbuilder_setup => sub {
55     +           shift->(form => $form, cgi => $q, session => $session);
56     +   });
57     +
58     +   decode_form_utf8($form);
59     +   
60     +   # This untaint is safe because if the page doesn't exist, bail.
61     +   my $page = $form->field('page');
62     +   $page = possibly_foolish_untaint($page);
63     +   if (! exists $pagesources{$page}) {
64     +           error("page does not exist");
65     +   }
66     +   my $file=$pagesources{$page};
67     +   my $type=pagetype($file);
68     +
69     +   my $from;
70     +   if (defined $form->field('from')) {
71     +           ($from)=$form->field('from')=~/$config{wiki_file_regexp}/;
72     +   }
73     +   
74     +   $form->field(name => "do", type => 'hidden');
75     +   $form->field(name => "from", type => 'hidden');
76     +   $form->field(name => "rcsinfo", type => 'hidden');
77     +   $form->field(name => "subpage", type => 'hidden');
78     +   $form->field(name => "page", value => $page, force => 1);
79     +   $form->field(name => "newname", type => "text", size => 80);
80     +   $form->field(name => "message", type => "text", size => 80);
81     +
82     +   if (! $form->submitted) {
83     +           $form->field(name => "rcsinfo", value => rcs_prepedit($file),
84     +                        force => 1);
85     +   }
86     +
87     +   if ($form->submitted eq "Cancel") {
88     +           redirect($q, "$config{url}/".htmlpage($from));
89     +           return;
90     +   }
91     +           
92     +   if (! $form->submitted || $form->submitted eq "Preview" || 
93     +       ! $form->validate) {
94     +           if ($form->field("do") eq "move"){
95     +                   page_locked($page, $session);
96     +                   $form->tmpl_param("page_select", 0);
97     +                   $form->field(name => "page", type => 'hidden');
98     +                   $form->field(name => "type", type => 'hidden');
99     +                   $form->title(sprintf(gettext("moving %s"), pagetitle($page)));
100     +                   if (! defined $form->field('newname') ||
101     +                       ! length $form->field('newname')) {
102     +                           $form->field(name => "newname", 
103     +                                        value => pagetitle($page), force => 1);
104     +                   }
105     +
106     +           }
107     +           print $form->render(submit => \@buttons);
108     +   }
109     +   else{
110     +           # This untaint is safe because titlepage removes any problematic
111     +           # characters.
112     +           my ($newname)=$form->field('newname');
113     +           $newname=titlepage(possibly_foolish_untaint($newname));
114     +           if (! defined $newname || ! length $newname || file_pruned($newname, $config{srcdir}) || $newname=~/^\//) {
115     +                   error("bad page name");
116     +           }
117     +           page_locked($page, $session);
118     +
119     +           my $newfile = $newname . ".$type";
120     +           my $message = $form->field('message');
121     +           unlockwiki();
122     +           rcs_move($file, $newfile, $message, $form->field("rcsinfo"), 
123     +                    $session->param("name"), $ENV{REMOTE_ADDR});
124     +           redirect($q, "$config{url}/".htmlpage($newname));
125     +   }
126     +}
127     +
128      sub cgi_getsession ($) { #{{{
129         my $q=shift;
130      
131     @@ -631,6 +722,9 @@
132         if ($do eq 'create' || $do eq 'edit') {
133                 cgi_editpage($q, $session);
134         }
135     +   elsif ($do eq 'move') {
136     +           cgi_movepage($q, $session);
137     +   }
138         elsif ($do eq 'prefs') {
139                 cgi_prefs($q, $session);
140         }
141     diff -urx .svn ikiwiki/IkiWiki/Rcs/svn.pm ikiwiki-new/IkiWiki/Rcs/svn.pm
142     --- ikiwiki/IkiWiki/Rcs/svn.pm      2006-12-28 17:50:46.000000000 -0800
143     +++ ikiwiki-new/IkiWiki/Rcs/svn.pm  2007-01-11 18:14:30.000000000 -0800
144     @@ -60,6 +60,34 @@
145         }
146      } #}}}
147      
148     +sub rcs_move ($$$$;$$) {
149     +   my $file=shift;
150     +   my $newname=shift;
151     +   my $message=shift;
152     +   my $rcstoken=shift;
153     +   my $user=shift;
154     +   my $ipaddr=shift;
155     +   if (defined $user) {
156     +           $message="web commit by $user".(length $message ? ": $message" : "");
157     +   }
158     +   elsif (defined $ipaddr) {
159     +           $message="web commit from $ipaddr".(length $message ? ": $message" : "");
160     +   }
161     +
162     +   chdir($config{srcdir}); # svn merge wants to be here
163     +
164     +   if (system("svn", "move", "--quiet", 
165     +              "$file", "$newname") != 0) {
166     +           return 1;
167     +   }
168     +   if (system("svn", "commit", "--quiet", 
169     +              "--encoding", "UTF-8", "-m",
170     +              possibly_foolish_untaint($message)) != 0) {
171     +           return 1;
172     +   }
173     +   return undef # success
174     +}
175     +
176      sub rcs_commit ($$$;$$) { #{{{
177         # Tries to commit the page; returns undef on _success_ and
178         # a version of the page with the rcs's conflict markers on failure.