Changeset 477

Timestamp:

10/26/08 14:31:28 (3 years ago)

Author:

kake

Message:

Applied a modified version of tgj's patch (OpenGuides? ticket #23). Also fixed minor POD error while I was at it.

Location:

wiki-toolkit/trunk

Files:

• lib/Wiki/Toolkit/Store/Database.pm (modified) (5 diffs)
• lib/Wiki/Toolkit/Store/MySQL.pm (modified) (1 diff)
• lib/Wiki/Toolkit/Store/Pg.pm (modified) (1 diff)
• lib/Wiki/Toolkit/Store/SQLite.pm (modified) (1 diff)
• t/401_null_change.t (added)

wiki-toolkit/trunk/lib/Wiki/Toolkit/Store/Database.pm

@@ -176 +176 @@
 =item B<metadata> - a reference to a hash containing any caller-supplied
 metadata sent along the last time the node was written
+
+=back
 
 The node parameter is mandatory. The version parameter is optional and
@@ -282 +284 @@
 }
 
-# Expects a hash as returned by ->retrieve_node
+# Expects a hash as returned by ->retrieve_node - it's actually slightly lax
+# in this, in that while ->retrieve_node always wraps up the metadata values in
+# (refs to) arrays, this method will accept scalar metadata values too.
 sub _checksum {
     my ($self, %node_data) = @_;
@@ -288 +292 @@
     my %metadata = %{ $node_data{metadata} || {} };
     foreach my $key ( sort keys %metadata ) {
-        $string .= "\0\0\0" . $key . "\0\0"
-                 . join("\0", sort @{$metadata{$key}} );
+        $string .= "\0\0\0" . $key . "\0\0";
+        my $val = $metadata{$key};
+        if ( ref $val eq "ARRAY" ) {
+            $string .= join("\0", sort @$val );
+        } else {
+            $string .= $val;
+        }
     }
     return md5_hex($self->charset_encode($string));
@@ -451 +460 @@
 you (or your chosen subclass). This method shouldn't really be used
 directly as it might overwrite someone else's changes. Croaks on error
-but otherwise returns the version number of the update just made.
+but otherwise returns the version number of the update just made.  A
+return value of -1 indicates that the change was not applied.  This
+may be because the plugins voted against the change, or because the
+content and metadata in the proposed new version were identical to the
+current version (a "null" change).
 
 Supplying a ref to an array of nodes that this ones links to is
@@ -511 +524 @@
     if($write_allowed < 1) {
         # The plugins didn't want to allow this action
+        return -1;
+    }
+
+    if ( $self->_checksum( %args ) eq $args{checksum} ) {
+        # Refuse to commit as nothing has changed
         return -1;
     }

wiki-toolkit/trunk/lib/Wiki/Toolkit/Store/MySQL.pm

@@ -47 +47 @@
 C<write_node_post_locking> with all supplied arguments, unlocks the
 node. Returns the version of the updated node on successful writing, 0 if
-checksum doesn't match, croaks on error.
+checksum doesn't match, -1 if the change was not applied, croaks on error.
 
 Note:  Uses MySQL's user level locking, so any locks are released when

wiki-toolkit/trunk/lib/Wiki/Toolkit/Store/Pg.pm

@@ -47 +47 @@
 C<write_node_post_locking> with all supplied arguments, unlocks the
 node. Returns the version of the updated node on successful writing, 0 if
-checksum doesn't match, croaks on error.
+checksum doesn't match, -1 if the change was not applied, croaks on error.
 
 =cut

wiki-toolkit/trunk/lib/Wiki/Toolkit/Store/SQLite.pm

@@ -58 +58 @@
 C<write_node_post_locking> with all supplied arguments, unlocks the
 node. Returns the version of the updated node on successful writing, 0 if
-checksum doesn't match, croaks on error.
+checksum doesn't match, -1 if the change was not applied, croaks on error.
 
 =cut