Admin.pm: hide_posting()/recover_posting(): thread and forum XML files are now locked...

[selfforum.git] / selfforum-cgi / shared / Posting / Admin.pm

diff --git a/selfforum-cgi/shared/Posting/Admin.pm b/selfforum-cgi/shared/Posting/Admin.pm
index f3a4330141eba81cfadf07c14b722f9848288ea5..d057631054508434fa134308dfe71a2d7e578587 100644 (file)
--- a/selfforum-cgi/shared/Posting/Admin.pm
+++ b/selfforum-cgi/shared/Posting/Admin.pm
@@ -5,29 +5,56 @@ package Posting::Admin;
 # File:        shared/Posting/Admin.pm                                         #
 #              (was: ~Handle.pm)                                               #
 #                                                                              #
 # File:        shared/Posting/Admin.pm                                         #
 #              (was: ~Handle.pm)                                               #
 #                                                                              #

-# Authors:     Frank Schoenmann <fs@tower.de>, 2001-03-13                      #
-#              Andre Malo       <nd@o3media.de>, 2001-03-29                    #
+# Authors:     Frank Schönmann <fs@tower.de>                                   #
+#              André Malo <nd@o3media.de>                                      #
+#              Christian Kruse <ckruse@wwwtech.de>                             #

 #                                                                              #
 # Description: Allow administration of postings                                #
 #                                                                              #
 # Todo:        * Lock files before modification                                #
 #              * Change body in change_posting_body()                          #
 #                                                                              #
 # Description: Allow administration of postings                                #
 #                                                                              #
 # Todo:        * Lock files before modification                                #
 #              * Change body in change_posting_body()                          #

-#              * Recursively set invisibility flag in main forum xml by        #
-#                hide_posting() and recover_posting()                          #

 #                                                                              #
 ################################################################################
 
 use strict;
 #                                                                              #
 ################################################################################
 
 use strict;

+use vars qw(
+  @EXPORT
+);
+
+use Lock;
+use Posting::_lib qw(
+  parse_xml_file
+  get_message_node
+  save_file
+  get_all_threads
+  create_forum_xml_string
+);

 
 

-use base qw(Exporter);
+use XML::DOM;

 
 

-@Posting::Admin::EXPORT = qw(hide_posting recover_posting modify_posting add_user_vote level_vote);
+################################################################################
+#
+# Version check
+#
+# last modified:
+#    $Date$ (GMT)
+# by $Author$
+#
+sub VERSION {(q$Revision$ =~ /([\d.]+)\s*$/)[0] or '0.0'}

 
 

-use Lock qw(:READ);
-use Posting::_lib qw(get_message_node save_file get_all_threads
-                     create_forum_xml_string);
+################################################################################
+#
+# Export
+#
+use base qw(Exporter);

 
 

-use XML::DOM;
+@EXPORT = qw(
+  hide_posting
+  recover_posting
+  modify_posting
+  add_user_vote
+  level_vote
+);

 
 ### add_user_vote () ###########################################################
 #
 
 ### add_user_vote () ###########################################################
 #


@@ -41,24 +68,21 @@ use XML::DOM;
 # Todo:
 #  * Lock files before modification
 #
 # Todo:
 #  * Lock files before modification
 #

-sub add_user_vote()
-{
-    my ($forum, $tpath, $info) = @_;
-    my ($tid, $mid, $percent) = ($info->{'thread'},
-                                 $info->{'posting'},
-                                 $info->{'percent'});
-
-    # Thread
-    my $tfile = $tpath . '/t' . $tid . '.xml';
+sub add_user_vote ($$$) {
+  my ($forum, $tpath, $info) = @_;
+  my ($tid, $mid, $percent) = ($info->{'thread'},
+                               $info->{'posting'},
+                               $info->{'percent'});

 
 

-    my $parser = new XML::DOM::Parser;
-    my $xml = $parser->parsefile($tfile);
+  # Thread
+  my $tfile = $tpath . '/t' . $tid . '.xml';
+  my $xml   = parse_xml_file($tfile);

 
 

-    my $mnode = get_message_node($xml, $tid, $mid);
-    my $votes = $mnode->getAttribute('votingUser') + 1;
-    $mnode->setAttribute('votingUser', $votes);
+  my $mnode = get_message_node($xml, $tid, $mid);
+  my $votes = $mnode->getAttribute('votingUser') + 1;
+  $mnode->setAttribute('votingUser', $votes);

 
 

-    return save_file($tfile, \$xml->toString);
+  return save_file($tfile, \$xml->toString);

 }
 
 ### level_vote () ##############################################################
 }
 
 ### level_vote () ##############################################################


@@ -73,32 +97,26 @@ sub add_user_vote()
 # Todo:
 #  * Lock files before modification
 #
 # Todo:
 #  * Lock files before modification
 #

-sub level_vote
-{
-    my ($forum, $tpath, $info´) = @_;
-    my ($tid, $mid, $level, $value) = ($info->{'thread'},
-                                       $info->{'posting'},
-                                       $info->{'level'},
-                                       $info->{'value'});
-
-    # Thread
-    my $tfile = $tpath . '/t' . $tid . '.xml';
-
-    my $parser = new XML::DOM::Parser;
-    my $xml = $parser->parsefile($tfile);
-
-    my $mnode = get_message_node($xml, $tid, $mid);
-
-    if ($value == undef)
-    {
-        removeAttribute($level);
-    }
-    else
-    {
-        $mnode->setAttribute($level, $value);
-    }
-
-    return save_file($tfile, \$xml->toString);
+sub level_vote {
+  my ($forum, $tpath, $info) = @_;
+  my ($tid, $mid, $level, $value) = ($info->{'thread'},
+                                     $info->{'posting'},
+                                     $info->{'level'},
+                                     $info->{'value'});
+
+  # Thread
+  my $tfile = $tpath . '/t' . $tid . '.xml';
+  my $xml = parse_xml_file($tfile);
+  my $mnode = get_message_node($xml, $tid, $mid);
+
+  unless (defined $value) {
+    removeAttribute($level);
+  }
+  else {
+    $mnode->setAttribute($level, $value);
+  }
+
+  return save_file($tfile, \$xml->toString);

 }
 
 ### hide_posting () ############################################################
 }
 
 ### hide_posting () ############################################################


@@ -107,42 +125,66 @@ sub level_vote
 #
 # Params: $forum  Path and filename of forum
 #         $tpath  Path to thread files
 #
 # Params: $forum  Path and filename of forum
 #         $tpath  Path to thread files

-#         \%info  Hash reference: 'thread', 'posting', 'indexFile'
+#         \%info  Hash reference: 'thread', 'posting'

 # Return: -none-
 #
 # Return: -none-
 #

-# Todo:
-#  * set flags recursively in forum xml
-#  * lock files before modification
-#
-sub hide_posting($$$)
-{
-    my ($forum, $tpath, $info) = @_;
-    my ($tid, $mid, $indexFile) = ($info->{'thread'},
-                                   $info->{'posting'},
-                                   $info->{'indexFile'});
-
-    # Thread
-    my $tfile = $tpath . '/t' . $tid . '.xml';
-    change_posting_visibility($tfile, 't'.$tid, 'm'.$mid, 1);
-
-    # Forum
-    my ($f, $lthread, $lmsg, $dtd, $zlev) = get_all_threads($forum, 0, 0);  # filter deleted, descending
-
-    for (@{$f->{$tid}})
-    {
-        if ($_->{'mid'} == $mid)
-        {
-            $_->{'deleted'} = 1;
-        }
+sub hide_posting($$$) {
+  my ($forum, $tpath, $info) = @_;
+  my ($tid, $mid) = ($info->{'thread'},
+                     $info->{'posting'});
+
+  # Thread
+  my $tfile = $tpath . '/t' . $tid . '.xml';
+
+  # lock files
+  my $main  = new Lock $forum;
+  my $tlock = new Lock $tfile;
+
+  return unless $tlock->lock(LH_EXCL); # lock failed
+  unless ($main->lock(LH_EXCL)) { # lock failed
+    $tlock->unlock;
+    return;
+  }
+
+  #
+  # Change invisibility in the thread file.
+  #
+  unless (change_posting_visibility($tfile, 't'.$tid, 'm'.$mid, 1)) { # saving failed
+    $tlock->unlock;
+    $main->unlock;
+    return;
+  }
+
+  # get all Forum threads
+  my ($f, $lthread, $lmsg,$dtd) = get_all_threads($forum, 1);
+  unless ($f) {
+    $tlock->unlock;
+    $main->unlock;
+  }
+
+  #
+  # Change invisibility in the main forum index.
+  #
+  for my $i (0 .. $#{$f->{$tid}}) {
+    if ($f->{$tid}->[$i]->{'mid'} == $mid) {
+      $f->{$tid}->[$_]->{'deleted'} = 1 for ($i .. $i+$f->{$tid}->[$i]->{'answers'});
+      last;

     }
     }

+  }
+
+  my $success = save_file($forum,
+                          create_forum_xml_string($f,
+                                                  {
+                                                    'dtd'         => $dtd,
+                                                    'lastMessage' => $lmsg,
+                                                    'lastThread'  => $lthread
+                                                  })
+                         );
+
+  $tlock->unlock;
+  $main->unlock;

 
 

-    my %cfxs = (
-        'dtd'         => $dtd,
-        'lastMessage' => $lmsg,
-        'lastThread'  => $lthread
-    );
-    my $xmlstring = create_forum_xml_string($f, \%cfxs);
-    save_file($forum, $$xmlstring);
+  return $success;

 }
 
 ### recover_posting() ##########################################################
 }
 
 ### recover_posting() ##########################################################


@@ -151,42 +193,69 @@ sub hide_posting($$$)
 #
 # Params: $forum  Path and filename of forum
 #         $tpath  Path to thread files
 #
 # Params: $forum  Path and filename of forum
 #         $tpath  Path to thread files

-#         \%info  Hash reference: 'thread', 'posting', 'indexFile'
-# Return: -none-
+#         \%info  Hash reference: 'thread', 'posting'
+# Return: success or unsuccess

 #
 #

-# Todo:
-#  * set flags recursive in forum xml
-#  * lock files before modification
-#
-sub recover_posting($$$)
-{
-    my ($forum, $tpath, $info) = @_;
-    my ($tid, $mid, $indexFile) = ($info->{'thread'},
-                                   $info->{'posting'},
-                                   $info->{'indexFile'});
-
-    # Thread
-    my $tfile = $tpath . '/t' . $tid . '.xml';
-    change_posting_visibility($tfile, 't'.$tid, 'm'.$mid, 0);
-
-    # Forum
-    my ($f, $lthread, $lmsg, $dtd, $zlev) = get_all_threads($forum, 1, 0);  # do not filter deleted, descending
-
-    for (@{$f->{$tid}})
-    {
-        if ($_->{'mid'} == $mid)
-        {
-            $_->{'deleted'} = 0;
-        }
+sub recover_posting ($$$) {
+  my ($forum, $tpath, $info) = @_;
+  my ($tid, $mid) = ($info->{'thread'},
+                     $info->{'posting'});
+
+  # Thread
+  my $tfile = $tpath . '/t' . $tid . '.xml';
+
+  # lock files
+  my $main  = new Lock $forum;
+  my $tlock = new Lock $tfile;
+
+  return unless $tlock->lock(LH_EXCL); # lock failed
+  unless ($main->lock(LH_EXCL)) { # lock failed
+    $tlock->unlock;
+    return;
+  }
+
+  #
+  # Change invisibility in the thread file.
+  #
+  unless (change_posting_visibility($tfile, 't'.$tid, 'm'.$mid, 0)) { # saving failed
+    $main->unlock;
+    $tlock->unlock;
+    return;
+  }
+
+  # get all Forum threads
+  my ($f, $lthread, $lmsg,$dtd) = get_all_threads($forum,1);
+
+  unless ($f) {
+    $main->unlock;
+    $tlock->unlock;
+
+    return;
+  }
+
+  #
+  # Change invisibility in the main forum index.
+  #
+  for my $i (0 .. $#{$f->{$tid}}) {
+    if ($f->{$tid}->[$i]->{'mid'} == $mid) {
+      $f->{$tid}->[$_]->{'deleted'} = 0 for ($i .. $i+$f->{$tid}->[$i]->{'answers'});
+      last;

     }
     }

+  }

 
 

-    my %cfxs = (
-        'dtd'         => $dtd,
-        'lastMessage' => $lmsg,
-        'lastThread'  => $lthread
-    );
-    my $xmlstring = create_forum_xml_string($f, \%cfxs);
-    save_file($forum, $$xmlstring);
+  my $success = save_file($forum,
+                          create_forum_xml_string($f,
+                                                  {
+                                                    'dtd'         => $dtd,
+                                                    'lastMessage' => $lmsg,
+                                                    'lastThread'  => $lthread
+                                                  })
+                         );
+
+  $tlock->unlock;
+  $main->unlock;
+
+  return $success;

 }
 
 ### change_posting_visibility () ###############################################
 }
 
 ### change_posting_visibility () ###############################################


@@ -199,24 +268,20 @@ sub recover_posting($$$)
 #         $invisible  1 - invisible, 0 - visible
 # Return: Status code
 #
 #         $invisible  1 - invisible, 0 - visible
 # Return: Status code
 #

-sub change_posting_visibility($$$$)
-{
-    my ($fname, $tid, $mid, $invisible) = @_;
+sub change_posting_visibility($$$$) {
+  my ($fname, $tid, $mid, $invisible) = @_;

 
 

-    my $parser = new XML::DOM::Parser;
-    my $xml = $parser->parsefile($fname);
+  my $xml = parse_xml_file($fname);
+  return unless $xml; # parser failed

 
 

-    # Set flag in given msg
-    my $mnode = get_message_node($xml, $tid, $mid);
-    $mnode->setAttribute('invisible', $invisible);
+  # Set flag in given msg
+  my $mnode = get_message_node($xml, $tid, $mid);
+  $mnode->setAttribute('invisible', $invisible);

 
 

-    # Set flag in sub nodes
-    for ($mnode->getElementsByTagName('Message'))
-    {
-        $_->setAttribute('invisible', $invisible);
-    }
+  # Set flag in sub nodes
+  $_->setAttribute('invisible', $invisible) foreach $mnode->getElementsByTagName('Message');

 
 

-    return save_file($fname, \$xml->toString);
+  return save_file($fname, \$xml->toString);

 }
 
 ### modify_posting () ##########################################################
 }
 
 ### modify_posting () ##########################################################


@@ -229,47 +294,50 @@ sub change_posting_visibility($$$$)
 #                 (data = \%hashref: 'subject', 'category', 'body')
 # Return: -none-
 #
 #                 (data = \%hashref: 'subject', 'category', 'body')
 # Return: -none-
 #

-sub modify_posting($$$)
-{
-    my ($forum, $tpath, $info) = @_;
-    my ($tid, $mid, $indexFile, $data) = ($info->{'thread'},
-                                          $info->{'posting'},
-                                          $info->{'indexFile'},
-                                          $info->{'data'});
-    my ($subject, $category, $body) = ($data->{'subject'}, $data->{'category'}, $data->{'body'});
-
-    my %msgdata;
-
-    # These values may be changed by change_posting_value()
-    $subject && $msgdata{'Subject'} = $subject;
-    $category && $msgdata{'Category'} = $category;
-
-    # Thread
-    my $tfile = $tpath . '/t' . $tid . '.xml';
-    change_posting_value($tfile, 't'.$tid, 'm'.$mid, \$msgdata);
-    $body && change_posting_body($tfile, 't'.$tid, 'm'.$mid, $body);
-
-    # Forum (does not contain msg bodies)
-    if ($subject or $category)
-    {
-        my ($f, $lthread, $lmsg, $dtd, $zlev) = get_all_threads($forum, 1, 0);
-
-        for (@{$f->{$tid}})
-        {
-            if ($_->{'mid'} == $mid)
-            {
-                $subject && $_->{'subject'} = $subject;
-                $category && $_->{'cat'} = $category;
-            }
-        }
-
-        my %cfxs = (
-            'dtd'         => $dtd,
-            'lastMessage' => $lmsg,
-            'lastThread'  => $lthread
-        );
-        my $xmlstring = create_forum_xml_string($f, \%cfxs);
-        save_file($forum, $$xmlstring);
+# Todo:
+#   * Lock files!
+#   * save return values
+#
+sub modify_posting($$$) {
+  my ($forum, $tpath, $info) = @_;
+  my ($tid, $mid, $indexFile, $data) = (
+    $info->{'thread'},
+    $info->{'posting'},
+    $info->{'indexFile'},
+    $info->{'data'}
+  );
+
+  my ($subject, $category, $body) = (
+    $data->{'subject'},
+    $data->{'category'},
+    $data->{'body'}
+  );
+
+  my %msgdata;
+
+  # These values may be changed by change_posting_value()
+  $msgdata{'Subject'} = $subject if $subject;
+  $msgdata{'Category'} = $category if $category;
+
+  # Thread
+  my $tfile = $tpath . '/t' . $tid . '.xml';
+  change_posting_value($tfile, 't'.$tid, 'm'.$mid, \%msgdata);
+  change_posting_body($tfile, 't'.$tid, 'm'.$mid, $body) if $body;
+
+  # Forum (does not contain msg bodies)
+  if ($subject or $category) {
+    my ($f, $lthread, $lmsg, $dtd, $zlev) = get_all_threads($forum, 1, 0);
+
+    for (@{$f->{$tid}}) {
+      if ($_->{'mid'} == $mid) {
+        $_->{'subject'} = $subject if $subject;
+        $_->{'cat'} = $category if $category;
+      }
+    }
+
+   save_file($forum, create_forum_xml_string($f,{dtd=>$dtd,lastMessage=>$lmsg,lastThread$lthread}));
+  }
+

 }
 
 ### change_posting_value () ####################################################
 }
 
 ### change_posting_value () ####################################################


@@ -282,24 +350,20 @@ sub modify_posting($$$)
 #         \%values  New values
 # Return: Status code
 #
 #         \%values  New values
 # Return: Status code
 #

-sub change_posting_value($$$$)
-{
-    my ($fname, $tid, $mid, $values) = @_;
+sub change_posting_value($$$$) {
+  my ($fname, $tid, $mid, $values) = @_;

 
 

-    my $parser = new XML::DOM::Parser;
-    my $xml = $parser->parsefile($fname);
+  my $xml   = parse_xml_file($fname);
+  my $mnode = get_message_node($xml, $tid, $mid);

 
 

-    my $mnode = get_message_node($xml, $tid, $mid);
-
-    for (keys %$values)
-    {
-        # Find first direct child node with name $_
-        my $nodes = $mnode->getElementsByTagName($_, 0);
-        my $node = $nodes->item(0);
-        $node->setValue($values->{$_});
-    }
+  for (keys %$values) {
+    # Find first direct child node with name $_
+    my $nodes = $mnode->getElementsByTagName($_, 0);
+    my $node = $nodes->item(0);
+    $node->setValue($values->{$_});
+  }

 
 

-    return save_file($fname, \$xml->toString);
+  return save_file($fname, \$xml->toString);

 }
 
 ### change_posting_body () #####################################################
 }
 
 ### change_posting_body () #####################################################


@@ -315,20 +379,21 @@ sub change_posting_value($$$$)
 # Todo:
 #  * Change body
 #
 # Todo:
 #  * Change body
 #

-sub change_posting_body($$$$)
-{
-    my ($fname, $tid, $mid, $body) = @_;
+sub change_posting_body ($$$$) {
+  my ($fname, $tid, $mid, $body) = @_;

 
 

-    my $parser = new XML::DOM::Parser;
-    my $xml = $parser->parsefile($fname);
-
-    my $mbnody = get_message_body($xml, $mid);
+  my $xml    = parse_xml_file($fname);
+  my $mbnody = get_message_body($xml, $mid);

 
     # todo: change body
 
 
     # todo: change body
 

-    return save_file($fname, \$xml->toString);
+  return save_file($fname, \$xml->toString);

 }
 
 
 # Let it be true
 }
 
 
 # Let it be true

-1;
\ No newline at end of file
+1;
+
+#
+#
+### end of Posting::Admin ######################################################