Changeset 156

Timestamp:

05/14/03 22:29:51 (6 years ago)

Author:

kake

Message:

0.12 14 May 2003

Added OpenGuides::CGI to manage cookies and things, used this to
do more code tidying. Added edit box position option to preferences.

Location:

trunk

Files:

• Build.PL (modified) (1 diff)
• Changes (modified) (1 diff)
• INSTALL (modified) (1 diff)
• MANIFEST (modified) (2 diffs)
• lib/OpenGuides.pm (modified) (1 diff)
• lib/OpenGuides/CGI.pm (added)
• lib/OpenGuides/Template.pm (modified) (3 diffs)
• preferences.cgi (modified) (2 diffs)
• t/13_cookies.t (added)
• t/15_template.t (modified) (2 diffs)
• templates/edit_form.tt (modified) (3 diffs)
• templates/preferences.tt (modified) (3 diffs)
• wiki.cgi (modified) (4 diffs)

trunk/Build.PL

@@ -49 +49 @@
   variable => "stylesheet_url"
 },
-{ question => "what's the wiki called?",
+{ question => "what's the wiki called? (should be unique)",
   variable => "site_name",
   default  => "OpenGuides Wiki"

trunk/Changes

@@ -1 @@
-0.11    
+0.12    14 May 2003
+        Added OpenGuides::CGI to manage cookies and things, used this to
+        do more code tidying.  Added edit box position option to preferences.
+
+0.11    14 May 2003
         Added newpage.cgi for an easy way to create new pages.
 

trunk/INSTALL

@@ -95 +95 @@
   "What's the wiki called?"
 
-This is a title which will appear at the top of every page.
+This is a title which will appear at the top of every page.  If you have
+more than one OpenGuides installation at the same site then each should
+have a unique name, since this name is used to manage user preferences.
 
 

trunk/MANIFEST

@@ -8 +8 @@
 TROUBLESHOOTING
 lib/OpenGuides/Build.pm
+lib/OpenGuides/CGI.pm
 lib/OpenGuides/Diff.pm
 lib/OpenGuides/RDF.pm
@@ -42 +43 @@
 t/01_add_test_data.t
 t/11_utils.t
+t/13_cookies.t
 t/15_template.t
 t/21_rdf.t

trunk/lib/OpenGuides.pm

@@ -4 +4 @@
 use vars qw( $VERSION );
 
-$VERSION = '0.11';
+$VERSION = '0.12';
 
 =head1 NAME

trunk/lib/OpenGuides/Template.pm

@@ -3 +3 @@
 use strict;
 use vars qw( $VERSION );
-$VERSION = '0.02';
+$VERSION = '0.03';
 
 use Carp qw( croak );
@@ -48 +48 @@
                                       template     => "node.tt",
                                       content_type => "text/html",
+                                      cookies      => $cookie,
                                       vars         => { foo => "bar" }
   );
@@ -85 +86 @@
     my $header = "";
     unless ( defined $args{content_type} and $args{content_type} eq "" ) {
-        $header = "Content-Type: text/html\n\n";
+        $header = CGI::header( -cookie => $args{cookies} );
     }
     my $output;

trunk/preferences.cgi

@@ -3 +3 @@
 use strict;
 use CGI;
-use CGI::Cookie;
 use Config::Tiny;
-use Template;
+use OpenGuides::CGI;
+use OpenGuides::Utils;
+use OpenGuides::Template;
 
+my $config = Config::Tiny->read("wiki.conf");
+my $wiki = OpenGuides::Utils->make_wiki_object( config => $config );
 my $cgi = CGI->new();
 my $action = $cgi->param('action') || '';
@@ -19 +22 @@
 
 sub set_preferences {
-    my $username = $cgi->param("username") || "";
-    my $gc_link  = $cgi->param('include_geocache_link') || 0,
-    my @cookies;
-    push @cookies, CGI::Cookie->new( -name    => 'username',
-                                     -value   => $username,
-                                     -expires => '+12M',
+    my $username  = $cgi->param("username") || "";
+    my $gc_link   = $cgi->param('include_geocache_link') || 0;
+    my $pre_above = $cgi->param('preview_above_edit_box') || 0;
+    my $cookie = OpenGuides::CGI->make_prefs_cookie(
+        config => $config,
+        username => $username,
+        include_geocache_link => $gc_link,
+        preview_above_edit_box => $pre_above
     );
-
-    push @cookies, CGI::Cookie->new( -name    => 'include_geocache_link',
-                                     -value   => $gc_link,
-                                     -expires => '+12M',
+    print OpenGuides::Template->output(
+        wiki     => $wiki,
+        config   => $config,
+        template => "preferences.tt",
+        cookies  => $cookie,
+        vars     => { not_editable           => 1,
+                      username               => $username,
+                      include_geocache_link  => $gc_link,
+                      preview_above_edit_box => $pre_above
+                    }
     );
-    print $cgi->header( -cookie => \@cookies );
-
-    process_prefs_template( username              => $username,
-                            include_geocache_link => $gc_link );
 }
-
 
 sub show_form {
     # Get defaults for form fields from cookies.
-    my %cookies = CGI::Cookie->fetch;
-    my $username = $cookies{"username"} ? $cookies{"username"}->value : "";
-    my $gc_link  = $cookies{"include_geocache_link"} ? $cookies{"include_geocache_link"}->value : 0;
+    my %prefs = OpenGuides::CGI->get_prefs_from_cookie( config => $config );
 
-    print $cgi->header;
-    process_prefs_template( show_form             => 1,
-                            username              => $username,
-                            include_geocache_link => $gc_link );
+    print OpenGuides::Template->output(
+        wiki     => $wiki,
+        config   => $config,
+        template => "preferences.tt",
+        vars     => { %prefs,
+                      not_editable => 1,
+                      show_form    => 1
+                    }
+    );
 }
-
-
-sub process_prefs_template {
-    # Some TT params are passed in to the sub.
-    my %tt_vars = @_;
-
-    # Others are global and we get them from the config file.
-    my $config = Config::Tiny->read("wiki.conf");
-    foreach my $param ( qw( site_name stylesheet_url script_name home_name
-                            ) ) {
-        $tt_vars{$param} = $config->{_}->{$param};
-    }
-
-    # This isn't a page you can edit.
-    $tt_vars{not_editable} = 1;
-
-    my %tt_conf = ( INCLUDE_PATH => $config->{_}->{template_path},
-    );
-
-    my $tt = Template->new( \%tt_conf );
-    $tt->process( "preferences.tt", \%tt_vars ) or warn $tt->error;
-}
- 

trunk/t/15_template.t

@@ -1 +1 @@
 use strict;
-use Test::More tests => 16;
+use Test::More tests => 17;
 use Config::Tiny;
 use Cwd;
+use CGI::Cookie;
 use CGI::Wiki::Formatter::UseMod;
 use Test::MockObject;
@@ -80 +81 @@
 like( $output, qr/NODE PARAM: Test_Node/, "node_param var set" );
 
+# Test that cookies go in.
+my $cookie = CGI::Cookie->new( -name => "x", -value => "y" );
+$output = OpenGuides::Template->output(
+    config   => $config,
+    template => "15_test.tt",
+    cookies  => $cookie
+);
+like( $output, qr/Set-Cookie: $cookie/, "cookie in header" );

trunk/templates/edit_form.tt

@@ -3 +3 @@
 <h1 align="center">Edit "[% node_name %]"</h1>
 
+[% IF preview_html AND preview_above_edit_box %]
+  <h2>Preview</h2>
+  [% INCLUDE display_metadata.tt %]
+
+  [% preview_html %]
+
+  <br clear="all" />
+
+  [% INCLUDE display_categories.tt %]
+
+[% END %]
+
 <form action="[% cgi_url %]" method="POST" enctype="application/x-www-form-urlencoded">
 <table>
+        <tr>
+                <td align="center"><input type="submit" name="preview" value="Preview changes" /></td>
+                <td align="center"><input type="submit" name="Save" value="Save changes" /></td>
+        </tr>
+        <tr>
+                <td colspan="2" align="center"><a href="[% cgi_url %]?[% node_param %]">(cancel edit)</a></td>
+        </tr>
         <tr>
                 <td colspan="2">
@@ -94 +113 @@
 </form>
 
-[% IF preview_html %]
+[% IF preview_html AND NOT preview_above_edit_box %]
   <h2>Preview</h2>
   [% INCLUDE display_metadata.tt %]
@@ -105 +124 @@
 
 [% END %]
+
 [% INCLUDE footer.tt %]

trunk/templates/preferences.tt

@@ -20 +20 @@
 
     <h1>Preferences</h1>
+
+    <p>Check this to put the preview above the edit area when previewing
+    a page edit:</p>
+    [% IF preview_above_edit_box %]
+      <input type="checkbox" name="preview_above_edit_box" value="1" checked />
+    [% ELSE %]
+      <input type="checkbox" name="preview_above_edit_box" value="1" />
+    [% END %]
+    <br />
+
     <p>Check this to include &#8220;Look for nearby geocaches&#8221; link in navbar:</p>
     [% IF include_geocache_link %]
@@ -26 +36 @@
       <input type="checkbox" name="include_geocache_link" value="1" />
     [% END %]
+    <br />
 
-    <br />
     <input type="submit" value="Set it">
     <input type="hidden" name="action" value="set_preferences">
@@ -38 +48 @@
   <p>Username set to &#8220;[% username %]&#8221;</p>
 
+  <p>Preview area shown
+    [% IF preview_above_edit_box %]
+      above
+    [% ELSE %]
+      below
+    [% END %]
+  edit box.</p>
+
   <p>&#8220;Look for nearby geocaches&#8221; link
     [% UNLESS include_geocache_link %] not [% END %]
   included in navbar</p>
 
-  <p><a href="[% script_name %]">Return to the wiki</a></p>
+  <p><a href="[% cgi_url %]">Return to the wiki</a></p>
 
 [% END %]

trunk/wiki.cgi

@@ -5 +5 @@
 
 use vars qw( $VERSION );
-$VERSION = '0.11';
+$VERSION = '0.12';
 
 use CGI qw/:standard/;
 use CGI::Carp qw(croak);
-use CGI::Cookie;
 use CGI::Wiki;
 use CGI::Wiki::Search::SII;
@@ -18 +17 @@
 use Geography::NationalGrid;
 use Geography::NationalGrid::GB;
+use OpenGuides::CGI;
 use OpenGuides::RDF;
 use OpenGuides::Utils;
@@ -352 +352 @@
 
     if ($wiki->verify_checksum($node, $checksum)) {
-        my %tt_vars = ( content      => $q->escapeHTML($content),
-                        %tt_metadata_vars,
-                        preview_html => $wiki->format($content),
-                        checksum     => $q->escapeHTML($checksum) );
-
+        my %tt_vars = (
+            %tt_metadata_vars,
+            content                => $q->escapeHTML($content),
+            preview_html           => $wiki->format($content),
+            preview_above_edit_box => get_cookie( "preview_above_edit_box" ),
+            checksum               => $q->escapeHTML($checksum)
+        );
         process_template("edit_form.tt", $node, \%tt_vars);
     } else {
@@ -399 +401 @@
 
 sub get_cookie {
-    my $cookie_name = shift or return "";
-    my %defaults = ( username              => "Anonymous",
-                     include_geocache_link => 0 );
-    my %cookies = fetch CGI::Cookie;
-    if ($cookies{$cookie_name}) {
-        return $cookies{$cookie_name}->value;
-    }
-    else {
-        return $defaults{$cookie_name};
-    }
+    my $pref_name = shift or return "";
+warn "[$pref_name]";
+    my %cookie_data = OpenGuides::CGI->get_prefs_from_cookie(config=>$config);
+warn "[$cookie_data{$pref_name}]";
+    return $cookie_data{$pref_name};
 }