Changeset 1240

Timestamp:

10/20/08 00:24:51 (23 months ago)

Author:

dom

Message:

Add the ability to whitelist hosts who can change moderated nodes
without explicit moderation - thanks Oliver (fixes #203)

Location:

trunk

Files:

• Build.PL (modified) (1 diff)
• Changes (modified) (1 diff)
• MANIFEST (modified) (1 diff)
• lib/OpenGuides.pm (modified) (2 diffs)
• lib/OpenGuides/Config.pm (modified) (4 diffs)
• lib/OpenGuides/Test.pm (modified) (1 diff)
• lib/OpenGuides/Utils.pm (modified) (2 diffs)
• t/81_node_moderate_whitelist.t (added)

trunk/Build.PL

@@ -312 +312 @@
         'XML::RSS'                            => 0,
         'Data::Validate::URI'                 => 0,
+        'Net::Netmask'                        => 0,
+        'List::Utils'                         => 0,
         },
     build_requires => {

trunk/Changes

@@ -17 +17 @@
         Add an admin navbar, to be displayed if the user requests (#261)
         Move the node image outside the metadata div, to aid styling (#222)
+        Add the ability to whitelist hosts who can change moderated nodes
+          without explicit moderation (#203)
 
 0.63    16 August 2008

trunk/MANIFEST

@@ -146 +146 @@
 t/78_about.t
 t/79_host_blacklist.t
+t/81_node_moderate_whitelist.t
 t/85_universal_edit_link.t
 t/templates/15_test.tt

trunk/lib/OpenGuides.pm

@@ -1557 +1557 @@
     #  they've been moderated
     my $needs_moderation = $wiki->node_required_moderation($node);
-    unless( $needs_moderation ) {
+    my $in_moderate_whitelist
+        = OpenGuides::Utils->in_moderate_whitelist($self->config, $new_metadata{host});
+
+    if ( $in_moderate_whitelist or not $needs_moderation ) {
         $self->_autoCreateCategoryLocale(
                                           id       => $node,
@@ -1568 +1571 @@
 
     if ($written) {
-        if ( $needs_moderation and $config->send_moderation_notifications ) {
-            my $body = "The node '$node' in the OpenGuides installation\n" .
-                "'" . $config->site_name . "' requires moderation. ".
-                "Please visit\n" .
-                $config->script_url . $config->script_name .
-                "?action=show_needing_moderation\nat your convenience.\n";
-            eval {
-                OpenGuides::Utils->send_email(
-                    config        => $config,
-                    subject       => "Node requires moderation",
-                    body          => $body,
-                    admin         => 1,
-                    return_output => $return_output
+        if ( $needs_moderation ) {
+            if ( $in_moderate_whitelist ) {
+                $self->wiki->moderate_node(
+                                            name    => $node,
+                                            version => $written
                 );
-            };
-            warn $@ if $@;
+            }
+            elsif ( $config->send_moderation_notifications ) {
+                my $body = "The node '$node' in the OpenGuides installation\n" .
+                    "'" . $config->site_name . "' requires moderation. ".
+                    "Please visit\n" .
+                    $config->script_url . $config->script_name .
+                    "?action=show_needing_moderation\nat your convenience.\n";
+                eval {
+                    OpenGuides::Utils->send_email(
+                        config        => $config,
+                        subject       => "Node requires moderation",
+                        body          => $body,
+                        admin         => 1,
+                        return_output => $return_output
+                    );
+                };
+                warn $@ if $@;
+            }
         }
 

trunk/lib/OpenGuides/Config.pm

@@ -23 +23 @@
    show_gmap_in_node_display google_analytics_key
    centre_lat default_gmaps_zoom default_gmaps_search_zoom force_wgs84
-   licence_name licence_url licence_info_url moderation_requires_password
+   licence_name licence_url licence_info_url
+   moderation_requires_password moderate_whitelist
    enable_node_image enable_common_categories enable_common_locales
    spam_detector_module host_checker_module static_path static_url
@@ -81 +82 @@
                      enable_page_deletion => 0,
                      moderation_requires_password => 1,
+                     moderate_whitelist => "",
                      admin_pass => "Change This!",
                      enable_node_image => 1,
@@ -203 +205 @@
         send_moderation_notifications => "Should we send email notifications when a moderated node is edited?",
         website_link_max_chars => "How many characters of the URL of node websites should be displayed?",
+        moderate_whitelist => "Enter a comma-separated list of IP addresses able to make changes to moderated nodes and have them show up immediately",
     );
 
@@ -337 +340 @@
 =item * send_moderation_notifications
 
+=item * moderate_whitelist
+
 =item * website_link_max_chars (default: C<20>)
 

trunk/lib/OpenGuides/Test.pm

@@ -67 +67 @@
                      force_wgs84          => 1,
                      contact_email        => 'admins@example.org',
+                     moderate_whitelist   => "",
                    }
     );

trunk/lib/OpenGuides/Utils.pm

@@ -11 +11 @@
 use URI::Escape;
 use MIME::Lite;
+use Net::Netmask;
+use List::Util qw( first );
 use Data::Validate::URI qw( is_web_uri );
 
@@ -498 +500 @@
 }
 
+=item B<in_moderate_whitelist>
+
+ if (OpenGuides::Utils->in_moderate_whitelist( '127.0.0.1' )) {
+     # skip moderation and apply new verson to published site
+ }
+
+Admins can supply a comma separated list of IP addresses or CIDR-notation
+subnets indicating the hosts which can bypass enforced moderation. Any
+values which cannot be parsed by C<NetAddr::IP> will be ignored.
+
+=cut
+
+sub in_moderate_whitelist {
+    my ($self, $config, $ip) = @_;
+    return undef if not defined $ip;
+
+    # create NetAddr::IP object of the test IP
+    my $addr = Net::Netmask->new2($ip) or return undef;
+
+    # load the configured whitelist
+    my @whitelist
+        = split ',', $config->moderate_whitelist;
+
+    # test each entry in the whitelist
+    return eval{
+        first { Net::Netmask->new2($_)->match($addr->base) } @whitelist
+    };
+}
+
 =back