improved the behavior of get_all_threads and create_forum_xml_string

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

diff --git a/selfforum-cgi/shared/Posting/_lib.pm b/selfforum-cgi/shared/Posting/_lib.pm
index e8065abe14d9ef395407e3fdd54077e63622cc3b..83439c5210dfd5622930f1c54181d4535cdc7e43 100644 (file)
--- a/selfforum-cgi/shared/Posting/_lib.pm
+++ b/selfforum-cgi/shared/Posting/_lib.pm
@@ -1,121 +1,337 @@
-# Posting/_lib.pm
+package Posting::_lib;

 
 

-# ====================================================
-# Autor: n.d.p. / 2001-01-07
-# lm   : n.d.p. / 2001-02-25
-# ====================================================
-# Funktion:
-#    * Schnittstellen fuer den Zugriff auf Messages
-#    * Zeitdarstellung
-# ====================================================
+################################################################################
+#                                                                              #
+# File:        shared/Posting/_lib.pm                                          #
+#                                                                              #
+# Authors:     André Malo <nd@o3media.de>                                      #
+#              Frank Schönmann <fs@tower.de>                                   #
+#                                                                              #
+# Description: Message access interface, time format routines                  #
+#                                                                              #
+################################################################################

 
 use strict;
 
 use strict;

+use vars qw(
+  @EXPORT_OK
+);

 
 

-package Posting::_lib;
+use Encode::Plain; $Encode::Plain::utf8 = 1;
+
+use Time::German qw(localtime);
+use XML::DOM;
+
+################################################################################
+#
+# Version check
+#
+# last modified:
+#    $Date$ (GMT)
+# by $Author$
+#
+sub VERSION {(q$Revision$ =~ /([\d.]+)\s*$/)[0] or '0.0'}
+
+################################################################################
+#
+# Export
+#
+use constant SORT_ASCENT  => 0; # (latest postings first)
+use constant SORT_DESCENT => 1;
+use constant KEEP_DELETED => 1;
+use constant KILL_DELETED => 0;
+
+use constant FORUM_DTD => 'http://selfforum.sourceforge.net/dtd/forum.dtd';

 
 

-use vars qw(@EXPORT_OK);

 use base qw(Exporter);
 use base qw(Exporter);

+@EXPORT_OK = qw(
+  get_message_header
+  get_message_body
+  get_message_node
+  get_body_node
+  parse_single_thread
+  parse_xml_file
+  create_new_thread
+  create_message
+
+  hr_time
+  short_hr_time
+  long_hr_time
+  very_short_hr_time
+  month
+
+  get_all_threads
+  create_forum_xml_string
+
+  save_file
+
+  SORT_ASCENT
+  SORT_DESCENT
+  KEEP_DELETED
+  KILL_DELETED
+);
+
+################################################################################
+#
+# Access via XML::DOM
+#

 
 

-use Encode::Plain; $Encode::Plain::utf8 = 1;
+### sub create_message ($$) ####################################################
+#
+# create the 'Message' subtree
+#
+# Params: $xml - XML::DOM::Document object
+#         $par - hash reference
+#                (msg, ip, name, email, home, image, category, subject, time)
+#
+# Return: XML::DOM::Element object
+#
+sub create_message ($$) {
+  my ($xml,$par) = @_;

 
 

-use XML::DOM;
+  my $message = $xml -> createElement ('Message');
+  $message -> setAttribute ('id' => $par -> {msg});
+  $message -> setAttribute ('ip' => $par -> {ip});
+
+  my $header = $xml -> createElement ('Header');
+  my $author = $xml -> createElement ('Author');
+  $header  -> appendChild ($author);
+
+  my @may = (
+    ['name'     => 'Name'        => $author],
+    ['email'    => 'Email'       => $author],
+    ['home'     => 'HomepageUrl' => $author],
+    ['image'    => 'ImageUrl'    => $author],
+    ['category' => 'Category'    => $header],
+    ['subject'  => 'Subject'     => $header]
+  );# key       => element name  => superior
+
+  for (@may) {
+
+    # create element
+    my $obj = $xml -> createElement ($_->[1]);
+
+    # insert content
+    $obj -> addText (
+        defined $par -> {$_->[0]}
+      ? $par -> {$_->[0]}
+      : ''
+    );
+
+    # link to superior element
+    $_ -> [2] -> appendChild ($obj);
+  }

 
 

-# ====================================================
-# Funktionsexport
-# ====================================================
+  my $date = $xml -> createElement ('Date');
+  $date -> setAttribute ('longSec'=> $par -> {time});

 
 

-@EXPORT_OK = qw(get_message_header get_message_body get_message_node parse_single_thread
-                hr_time short_hr_time long_hr_time
-                get_all_threads
-                create_forum_xml_string
-                save_file);
+  $header  -> appendChild ($date);
+  $message -> appendChild ($header);

 
 

-# ====================================================
-# Zugriff uebers DOM
-# ====================================================
+  # return
+  #
+  $message;
+}

 
 

-###########################
-# sub get_message_header
+### sub create_new_thread ($) ##################################################

 #
 #

-# Messageheader auslesen
-###########################
+# create a XML::DOM::Document object of a thread containing one posting
+#
+# Params: hash reference
+#         (thread, msg, body, ip, name, email, home,
+#          image, category, subject, time)
+#
+# Return: XML::DOM::Document object
+#
+sub create_new_thread ($) {
+  my $par = shift;
+
+  # new document
+  #
+  my $xml = new XML::DOM::Document;
+
+  # xml declaration
+  #
+  my $decl = new XML::DOM::XMLDecl;
+  $decl -> setVersion  ('1.0');
+  $decl -> setEncoding ('UTF-8');
+  $xml -> setXMLDecl ($decl);
+
+  # set doctype
+  #
+  my $dtd = $xml -> createDocumentType ('Forum' => FORUM_DTD);
+  $xml -> setDoctype ($dtd);
+
+  # create root element 'Forum'
+  # create element 'Thread'
+  # create 'Message' subtree
+  # create element 'ContentList'
+  # create 'MessageContent' subtree
+  #
+  my $forum    = $xml -> createElement ('Forum');
+  my $thread   = $xml -> createElement ('Thread');
+    $thread -> setAttribute ('id' => $par -> {thread});
+  my $message  = create_message ($xml,$par);
+  my $content  = $xml -> createElement ('ContentList');
+  my $mcontent = $xml -> createElement ('MessageContent');
+    $mcontent -> setAttribute ('mid' => $par -> {msg});
+    $mcontent -> appendChild (
+      $xml -> createCDATASection (${$par -> {body}})
+    );
+
+  # link all the nodes to
+  # their superior elements
+  #
+  $thread  -> appendChild ($message);
+  $forum   -> appendChild ($thread);
+  $content -> appendChild ($mcontent);
+  $forum   -> appendChild ($content);
+  $xml     -> appendChild ($forum);
+
+  # return
+  #
+  $xml;
+}

 
 

-sub get_message_header ($) {
+### get_message_header () ######################################################
+#
+# Read message header, return as a hash
+#
+# Params: $node - XML message node
+# Return: hash reference (name, category, subject, email, home, image, time)
+#
+sub get_message_header ($)
+{

   my $node = shift;
   my %conf;
 
   my $node = shift;
   my %conf;
 

-  my $header    = $node   -> getElementsByTagName ('Header', 0) -> item (0);
-    my $author  = $header -> getElementsByTagName ('Author', 0) -> item (0);
-      my $name  = $author -> getElementsByTagName ('Name', 0) -> item (0);
-      my $email = $author -> getElementsByTagName ('Email', 0) -> item (0);
+  my $header    = $node   -> getElementsByTagName ('Header'     , 0) -> item (0);
+    my $author  = $header -> getElementsByTagName ('Author'     , 0) -> item (0);
+      my $name  = $author -> getElementsByTagName ('Name'       , 0) -> item (0);
+      my $email = $author -> getElementsByTagName ('Email'      , 0) -> item (0);

       my $home  = $author -> getElementsByTagName ('HomepageUrl', 0) -> item (0);
       my $home  = $author -> getElementsByTagName ('HomepageUrl', 0) -> item (0);

-      my $image = $author -> getElementsByTagName ('ImageUrl', 0) -> item (0);
-    my $cat     = $header -> getElementsByTagName ('Category', 0) -> item (0);
-    my $subject = $header -> getElementsByTagName ('Subject', 0) -> item (0);
-    my $date    = $header -> getElementsByTagName ('Date', 0) -> item (0);
-
-    %conf = (name     => ($name    -> hasChildNodes)?$name    -> getFirstChild -> getData:undef,
-             category => ($cat     -> hasChildNodes)?$cat     -> getFirstChild -> getData:undef,
-             subject  => ($subject -> hasChildNodes)?$subject -> getFirstChild -> getData:undef,
-             email    => (defined ($email) and $email -> hasChildNodes)?$email -> getFirstChild -> getData:undef,
-             home     => (defined ($home)  and $home  -> hasChildNodes)?$home  -> getFirstChild -> getData:undef,
-             image    => (defined ($image) and $image -> hasChildNodes)?$image -> getFirstChild -> getData:undef,
-             time     => $date -> getAttribute ('longSec'));
+      my $image = $author -> getElementsByTagName ('ImageUrl'   , 0) -> item (0);
+    my $cat     = $header -> getElementsByTagName ('Category'   , 0) -> item (0);
+    my $subject = $header -> getElementsByTagName ('Subject'    , 0) -> item (0);
+    my $date    = $header -> getElementsByTagName ('Date'       , 0) -> item (0);
+
+  %conf = (
+    name     => ($name    -> hasChildNodes)?$name    -> getFirstChild -> getData:undef,
+    category => ($cat     -> hasChildNodes)?$cat     -> getFirstChild -> getData:undef,
+    subject  => ($subject -> hasChildNodes)?$subject -> getFirstChild -> getData:undef,
+    email    => (defined ($email) and $email -> hasChildNodes)?$email -> getFirstChild -> getData:undef,
+    home     => (defined ($home)  and $home  -> hasChildNodes)?$home  -> getFirstChild -> getData:undef,
+    image    => (defined ($image) and $image -> hasChildNodes)?$image -> getFirstChild -> getData:undef,
+    time     => $date -> getAttribute ('longSec')
+  );
+

   \%conf;
 }
 
   \%conf;
 }
 

-###########################
-# sub get_message_header
+### get_body_node () ########################################################
+#
+# Search a specific message body in a XML tree

 #
 #

-# Messagebody auslesen
-###########################
+# Params: $xml  XML::DOM::Document Object (Document Node)
+#         $mid  Message ID
+#
+# Return: MessageContent XML node (or -none-)
+#
+sub get_body_node ($$)
+{
+  my ($xml, $mid) = @_;
+
+  for ($xml -> getElementsByTagName ('ContentList', 1) -> item (0) -> getElementsByTagName ('MessageContent', 0)) {
+    return $_ if ($_ -> getAttribute ('mid') eq $mid);
+  }
+
+  return;
+}

 
 

+### get_message_body () ########################################################
+#
+# Read message body
+#
+# Params: $xml  XML::DOM::Document Object (Document Node)
+#         $mid  Message ID
+#
+# Return: Scalar reference
+#

 sub get_message_body ($$)
 {
 sub get_message_body ($$)
 {

-  my ($xml, $mid) = @_;
+  my $cnode = get_body_node ($_[0], $_[1]);

   my $body;
 
   my $body;
 

-  foreach ($xml -> getElementsByTagName ('ContentList', 1) -> item (0) -> getElementsByTagName ('MessageContent', 0))
-  {
-    if ($_ -> getAttribute ('mid') eq $mid)
-    {
-      $body = ($_ -> hasChildNodes)?$_ -> getFirstChild -> getData:'';
-      last;
-    }
-  }
+  $body = ($cnode -> hasChildNodes)?$cnode -> getFirstChild -> getData:'' if $cnode;

 
   \$body;
 }
 
 
   \$body;
 }
 

-###########################
-# sub get_message_header
+### get_message_node () ########################################################

 #
 #

-# Messagenode bestimmen
-###########################
-
-sub get_message_node ($$$) {
-  my ($xml,$tid,$mid) = @_;
-  my ($mnode,$tnode);
+# Search a specific message in a XML tree
+#
+# Params: $xml  XML::DOM::Document Object (Document Node)
+#         $tid  Thread ID
+#         $mid  Message ID
+#
+# Return: Message XML node, Thread XML node (or -none-)
+#
+sub get_message_node ($$$)
+{
+  my ($xml, $tid, $mid) = @_;
+  my ($mnode, $tnode);

 
 

-  for ( $xml -> getElementsByTagName ('Thread')) {
-    if ($_ -> getAttribute ('id') eq $tid) {
+  for ($xml->getElementsByTagName ('Thread')) {
+    if ($_->getAttribute ('id') eq $tid) {

       $tnode = $_;
       $tnode = $_;

+

       for ($tnode -> getElementsByTagName ('Message')) {
         if ($_ -> getAttribute ('id') eq $mid) {
           $mnode = $_;
       for ($tnode -> getElementsByTagName ('Message')) {
         if ($_ -> getAttribute ('id') eq $mid) {
           $mnode = $_;

-          last;}}
-      last;}}
+          last;
+        }
+      }
+      last;
+    }
+  }

 
 

-  wantarray?($mnode, $tnode):$mnode;
+  wantarray
+  ? ($mnode, $tnode)
+  : $mnode;

 }
 
 }
 

-###########################
-# sub parse_single_thread
+### sub parse_xml_file ($) #####################################################
+#
+# load the specified XML-File and create the DOM tree
+# this sub is only to avoid errors and to centralize the parse process
+#
+# Params: $file filename
+#
+# Return: XML::DOM::Document Object (Document Node) or false

 #
 #

-# einzelne Threaddatei
-# parsen
-###########################
+sub parse_xml_file ($) {
+  my $file = shift;

 
 

+  my $xml = eval {
+    local $SIG{__DIE__};      # CGI::Carp works unreliable ;-(
+    new XML::DOM::Parser(KeepCDATA => 1)->parsefile ($file);
+  };
+
+  return if ($@);
+
+  $xml;
+}
+
+### parse_single_thread () #####################################################
+#
+# parse a thread file
+#
+# Params: $tnode - Thread element node
+#         $deleted - keep deleted (boolean)
+#         $sorted  - sorting order
+#
+# Return: arrayref
+#

 sub parse_single_thread ($$;$) {
   my ($tnode, $deleted, $sorted) = @_;
   my ($header, @msg, %mno);
 sub parse_single_thread ($$;$) {
   my ($tnode, $deleted, $sorted) = @_;
   my ($header, @msg, %mno);


@@ -123,179 +339,145 @@ sub parse_single_thread ($$;$) {
   for ($tnode -> getElementsByTagName ('Message')) {
     $header = get_message_header ($_);
 
   for ($tnode -> getElementsByTagName ('Message')) {
     $header = get_message_header ($_);
 

-    push @msg,{mid     => ($_ -> getAttribute ('id') =~ /(\d+)/)[0],
-               ip      => $_ -> getAttribute ('ip'),
-               kids    => [$_ -> getElementsByTagName ('Message', 0)],
-               answers => $_ -> getElementsByTagName ('Message') -> getLength,
-               deleted => ($_ -> getAttribute ('flag') eq 'deleted')?1:0,
-               name    => plain($header -> {name}),
-               cat     => plain($header -> {category} or ''),
-               subject => plain($header -> {subject}),
-               time    => plain($header -> {time})};
-    $mno{$_} = $#msg;}
-
-  # Eintraege ergaenzen und korrigieren
+    push @msg => {
+      mid     => ($_ -> getAttribute ('id') =~ /(\d+)/)[0],
+      ip      => $_ -> getAttribute ('ip'),
+      kids    => [$_ -> getElementsByTagName ('Message', 0)],
+      answers => $_ -> getElementsByTagName ('Message') -> getLength,
+      deleted => $_ -> getAttribute ('invisible'),
+      archive => $_ -> getAttribute ('archive'),
+      name    => plain($header -> {name}),
+      cat     => plain($header -> {category} or ''),
+      subject => plain($header -> {subject}),
+      time    => plain($header -> {time})
+    };
+    $mno{$_} = $#msg;
+  }
+

   my $level;
   $msg[0] -> {level} = 0;
   for (@msg) {
     $level = $_ -> {level} + 1;
   my $level;
   $msg[0] -> {level} = 0;
   for (@msg) {
     $level = $_ -> {level} + 1;

-    @{$_ -> {kids}} = map {$msg[$mno{$_}] -> {level} = $level; $mno{$_}} @{$_ -> {kids}};}
-
-  # ============
-  # Sortieren und bei Bedarf
-  # geloeschte Messages entfernen
+    @{$_ -> {kids}} = map {$msg[$mno{$_}] -> {level} = $level; $mno{$_}} @{$_ -> {kids}};
+  }

 
 

+  # sort and process deleted files
+  #

   my $smsg = sort_thread (\@msg, $sorted);
   delete_messages ($smsg) unless ($deleted);
 
   $smsg;
 }
 
   my $smsg = sort_thread (\@msg, $sorted);
   delete_messages ($smsg) unless ($deleted);
 
   $smsg;
 }
 

-###########################
-# sub create_message_xml
+################################################################################

 #
 #

-# Message-XML-String
-# erzeugen
-###########################
-
-sub create_message_xml ($$$) {
-  my ($xml, $msges, $num) = @_;
-
-  my $msg = $msges -> [$num];
-
-  my $message = $xml -> createElement ('Message');
-  $message -> setAttribute ('id', 'm'.$msg -> {mid});
-  $message -> setAttribute ('flag', 'deleted') if ($msg -> {deleted});
-
-  # Header erzeugen
-  my $header   = $xml -> createElement ('Header');
-
-  # alles inside of 'Header'
-  my $author   = $xml -> createElement ('Author');
-
-  my $name     = $xml -> createElement ('Name');
-  $name -> addText (toUTF8($msg -> {name}));
-
-  my $email    = $xml -> createElement ('Email');
-
-  my $category = $xml -> createElement ('Category');
-  $category -> addText (toUTF8($msg -> {cat}));
-
-  my $subject  = $xml -> createElement ('Subject');
-  $subject -> addText (toUTF8($msg -> {subject}));
-
-  my $date     = $xml -> createElement ('Date');
-  $date -> setAttribute ('longSec', $msg -> {time});
-
-    $author -> appendChild ($name);
-    $author -> appendChild ($email);
-    $header -> appendChild ($author);
-    $header -> appendChild ($category);
-    $header -> appendChild ($subject);
-    $header -> appendChild ($date);
-  $message -> appendChild ($header);
-
-  if ($msg -> {kids}) {
-    for (@{$msg -> {kids}}) {
-      $message -> appendChild (&create_message_xml ($xml, $msges, $_));
-    }
-  }
-
-  $message;
-}
-
-# ====================================================
-# XML-Parsen von Hand
-# ====================================================
-
-###########################
-# sub sort_thread
+# Access via regexps and native perl ;)

 #
 #

-# Messages eines
-# Threads sortieren
-###########################

 
 

+### sort_thread () #############################################################
+#
+# sort the message array
+#
+# Params: $msg    - arrayref
+#         $sorted - sorting order
+#
+# Return: sorted arrayref
+#

 sub sort_thread ($$) {
   my ($msg, $sorted) = @_;
 
   my ($z, %mhash) = (0);
 
 sub sort_thread ($$) {
   my ($msg, $sorted) = @_;
 
   my ($z, %mhash) = (0);
 

-  if ($sorted) {  # aelteste zuerst
+  if ($sorted) {  # oldest first

     for (@$msg) {
       @$msg[@{$_ -> {kids}}] = sort {$a -> {mid} <=> $b -> {mid}} @$msg[@{$_ -> {kids}}] if (@{$_ -> {kids}} > 1);
       $mhash{$_ -> {mid}} = [@$msg[@{$_ -> {kids}}]];}}
 
     for (@$msg) {
       @$msg[@{$_ -> {kids}}] = sort {$a -> {mid} <=> $b -> {mid}} @$msg[@{$_ -> {kids}}] if (@{$_ -> {kids}} > 1);
       $mhash{$_ -> {mid}} = [@$msg[@{$_ -> {kids}}]];}}
 

-  else {          # juengste zuerst
+  else {          # latest first

     for (@$msg) {
       @$msg[@{$_ -> {kids}}] = sort {$b -> {mid} <=> $a -> {mid}} @$msg[@{$_ -> {kids}}] if (@{$_ -> {kids}} > 1);
       $mhash{$_ -> {mid}} = [@$msg[@{$_ -> {kids}}]];}}
 
     for (@$msg) {
       @$msg[@{$_ -> {kids}}] = sort {$b -> {mid} <=> $a -> {mid}} @$msg[@{$_ -> {kids}}] if (@{$_ -> {kids}} > 1);
       $mhash{$_ -> {mid}} = [@$msg[@{$_ -> {kids}}]];}}
 

-  # Kinder wieder richtig einsortieren
+  # sort the children
+  #

   my @smsg = ($msg -> [0]);
   for (@smsg) {
     ++$z;
     splice @smsg,$z,0,@{$mhash{$_ -> {mid}}} if ($_ -> {answers});
   my @smsg = ($msg -> [0]);
   for (@smsg) {
     ++$z;
     splice @smsg,$z,0,@{$mhash{$_ -> {mid}}} if ($_ -> {answers});

-    delete $_ -> {kids};}
+    delete $_ -> {kids};
+  }

 
 

+  # return

   \@smsg;
 }
 
   \@smsg;
 }
 

-###########################
-# sub delete_messages
+### delete_messages () #########################################################
+#
+# Filter out deleted messages
+#
+# Params: $smsg  Reference of array of references of hashs
+# Return: -none-

 #
 #

-# geoeschte Nachrichten
-# herausfiltern
-###########################
-

 sub delete_messages ($) {
   my $smsg = shift;
 sub delete_messages ($) {
   my $smsg = shift;

-

   my ($z, $oldlevel, @path) = (0,0,0);
 
   my ($z, $oldlevel, @path) = (0,0,0);
 

-  for (@$smsg) {
-    if ($_ -> {deleted}) {
-      my $n = $_ -> {answers}+1;
-      for (@path) {$smsg -> [$_] -> {answers} -= $n;}
-      splice @$smsg,$z,$n;}
+  while ($z <= $#{$smsg}) {

 
 

+    if ($smsg -> [$z] -> {level} > $oldlevel) {
+      push @path => $z;
+      $oldlevel = $smsg -> [$z] -> {level};
+    }
+    elsif ($smsg -> [$z] -> {level} < $oldlevel) {
+      splice @path, $smsg -> [$z] -> {level};
+      push @path => $z;
+      $oldlevel = $smsg -> [$z] -> {'level'};
+    }

     else {
     else {

-      if ($_ -> {level} > $oldlevel) {
-        push @path,$z;
-        $oldlevel = $_ -> {level};}
-
-      elsif ($_ -> {level} < $oldlevel) {
-        splice @path,$_ -> {level}-$oldlevel;
-        $oldlevel = $_ -> {level};}
-
-      else { $path[-1] = $z; }
+      $path[-1] = $z;
+    }

 
 

-      $z++;}}
+    if ($smsg -> [$z] -> {deleted}) {
+      my $n = $smsg -> [$z] -> {answers} + 1;
+      $smsg -> [$_] -> {answers} -= $n for (@path);
+      splice @$smsg, $z, $n;
+    }
+    else {
+      $z++;
+    }
+  }

 
   return;
 }
 
 
   return;
 }
 

-###########################
-# sub get_all_threads
+### get_all_threads () #########################################################
+#
+# Read and Parse the main file (without any XML-module, they are too slow)
+#
+# Params: $file    - /path/to/filename of the main file
+#         $deleted - hold deleted (invisible) messages in result (1) oder not (0)
+#         $sorted  - direction of message sort: descending (0) (default) or ascending (1)
+#
+# Return: scalar context: hash reference (\%threads)
+#           list context: list (\%threads, $last_thread, $last_message, $dtd, \@unids)

 #
 #

-# Hauptdatei laden und
-# parsen
-###########################
-

 sub get_all_threads ($$;$) {
   my ($file, $deleted, $sorted) = @_;
 sub get_all_threads ($$;$) {
   my ($file, $deleted, $sorted) = @_;

-  my ($last_thread, $last_message, @unids, %threads);
-  local *FILE;
+  my ($last_thread, $last_message, $dtd, @unids, %threads);
+  local (*FILE, $/);

 
 

-  open FILE, $file or return undef;
+  open FILE,"< $file" or return;

   my $xml = join '', <FILE>;
   my $xml = join '', <FILE>;

-  close(FILE) or return undef;
+  close(FILE) or return;

 
   if (wantarray) {
 
   if (wantarray) {

+    $dtd            = FORUM_DTD;

     ($last_thread)  = map {/(\d+)/} $xml =~ /<Forum.+?lastThread="([^"]+)"[^>]*>/;
     ($last_thread)  = map {/(\d+)/} $xml =~ /<Forum.+?lastThread="([^"]+)"[^>]*>/;

-    ($last_message) = map {/(\d+)/} $xml =~ /<Forum.+?lastMessage="([^"]+)"[^>]*>/;}
+    ($last_message) = map {/(\d+)/} $xml =~ /<Forum.+?lastMessage="([^"]+)"[^>]*>/;
+  }

 
   my $reg_msg = qr~(?:</Message>
 
   my $reg_msg = qr~(?:</Message>

-                     |<Message\s+id="m(\d+)"\s+unid="([^"]*)"(?:\s+flag="([^"]*)")?[^>]*>\s*
+                     |<Message\s+id="m(\d+)"(?:\s+unid="([^"]*)")?(?:\s+invisible="([^"]*)")?(?:\s+archive="([^"]*)")?[^>]*>\s*

                       <Header>[^<]*(?:<(?!Name>)[^<]*)*
                         <Name>([^<]+)</Name>[^<]*(?:<(?!Category>)[^<]*)*
                         <Category>([^<]*)</Category>\s*
                       <Header>[^<]*(?:<(?!Name>)[^<]*)*
                         <Name>([^<]+)</Name>[^<]*(?:<(?!Category>)[^<]*)*
                         <Category>([^<]*)</Category>\s*


@@ -303,133 +485,151 @@ sub get_all_threads ($$;$) {
                         <Date\s+longSec="(\d+)"[^>]*>\s*
                       </Header>\s*(?:(<)/Message>|(?=(<)Message\s*)))~sx;
 
                         <Date\s+longSec="(\d+)"[^>]*>\s*
                       </Header>\s*(?:(<)/Message>|(?=(<)Message\s*)))~sx;
 

-  while ($xml =~ /<Thread id="t(\d+)">([^<]*(?:<(?!\/Thread>)[^<]*)*)<\/Thread>/g) {
-
+  while ($xml =~ /<Thread id="t(\d+)">([^<]*(?:<(?!\/Thread>)[^<]*)*)<\/Thread>/g)
+  {

     my ($tid, $thread) = ($1, $2);
     my ($level, $cmno, @msg, @stack) = (0);
 
     my ($tid, $thread) = ($1, $2);
     my ($level, $cmno, @msg, @stack) = (0);
 

-    while ($thread =~ m;$reg_msg;g) {
-
-      if (defined($9)) {
+    while ($thread =~ m;$reg_msg;g)
+    {
+      if (defined($10))
+      {

         push @stack,$cmno if (defined $cmno);
         push @stack,$cmno if (defined $cmno);

-        push @msg, {};
-
-        if (defined $cmno) {
+        push @msg, {
+          mid     => $1,
+          unid    => (defined $2) ? $2 : '',
+          deleted => $3 || 0,
+          archive => $4 || 0,
+          name    => $5,
+          cat     => $6,
+          subject => $7,
+          time    => $8,
+          level   => $level++,
+          unids   => [],
+          kids    => [],
+          answers => 0
+        };
+
+        if (defined $cmno)
+        {

           push @{$msg[$cmno] -> {kids}}  => $#msg;
           push @{$msg[$cmno] -> {kids}}  => $#msg;

-          push @{$msg[$cmno] -> {unids}} => $2;}
-        else {
-          push @unids => $2;}
+          push @{$msg[$cmno] -> {unids}} => (defined $2) ? $2 : '#';
+        }
+        else
+        {
+          push @unids => (defined $2) ? $2 : '';
+        }

 
 

-        for (@stack) {$msg[$_] -> {answers}++}
+        $msg[$_] -> {answers}++ for (@stack);

 
         $cmno=$#msg;
 
 
         $cmno=$#msg;
 

-       ($msg[-1] -> {mid},
-        $msg[-1] -> {unid},
-        $msg[-1] -> {name},
-        $msg[-1] -> {cat},
-        $msg[-1] -> {subject},
-        $msg[-1] -> {time})     = ($1, $2, $4, $5, $6, $7);
-
-        $msg[-1] -> {deleted} = ($3 eq 'deleted')?1:undef;
-
-        $msg[-1] -> {name} =~ s/&amp;/&/g;
-        $msg[-1] -> {cat} =~ s/&amp;/&/g;
+        $msg[-1] -> {name}    =~ s/&amp;/&/g;
+        $msg[-1] -> {cat}     =~ s/&amp;/&/g;

         $msg[-1] -> {subject} =~ s/&amp;/&/g;
 
         $msg[-1] -> {subject} =~ s/&amp;/&/g;
 

-        $msg[-1] -> {unids} = [];
-        $msg[-1] -> {kids} = [];
-        $msg[-1] -> {answers} = 0;
-        $msg[-1] -> {level} = $level++;}
-
-      elsif (defined ($8)) {
-        push @msg, {};
-
-        if (defined $cmno) {
+      }
+      elsif (defined ($9))
+      {
+        push @msg, {
+          mid     => $1,
+          unid    => (defined $2) ? $2 : '',
+          deleted => $3 || 0,
+          archive => $4 || 0,
+          name    => $5,
+          cat     => $6,
+          subject => $7,
+          time    => $8,
+          level   => $level,
+          unids   => [],
+          kids    => [],
+          answers => 0
+        };
+
+        if (defined $cmno)
+        {

           push @{$msg[$cmno] -> {kids}}  => $#msg;
           push @{$msg[$cmno] -> {kids}}  => $#msg;

-          push @{$msg[$cmno] -> {unids}} => $2;
-          $msg[$cmno] -> {answers}++;}
-        else {
-          push @unids => $2;}
-
-        for (@stack) {$msg[$_] -> {answers}++}
-
-       ($msg[-1] -> {mid},
-        $msg[-1] -> {unid},
-        $msg[-1] -> {name},
-        $msg[-1] -> {cat},
-        $msg[-1] -> {subject},
-        $msg[-1] -> {time})     = ($1, $2, $4, $5, $6, $7);
-
-        $msg[-1] -> {deleted} = ($3 eq 'deleted')?1:undef;
-
-        $msg[-1] -> {name} =~ s/&amp;/&/g;
-        $msg[-1] -> {cat} =~ s/&amp;/&/g;
+          push @{$msg[$cmno] -> {unids}} => (defined $2) ? $2 : '';
+          $msg[$cmno] -> {answers}++;
+        }
+        else
+        {
+          push @unids => (defined $2) ? $2 : '';
+        }
+
+        $msg[$_] -> {answers}++ for (@stack);
+
+        $msg[-1] -> {name}    =~ s/&amp;/&/g;
+        $msg[-1] -> {cat}     =~ s/&amp;/&/g;

         $msg[-1] -> {subject} =~ s/&amp;/&/g;
         $msg[-1] -> {subject} =~ s/&amp;/&/g;

+      }
+      else
+      {
+        $cmno = pop @stack; $level--;
+      }
+    }

 
 

-        $msg[-1] -> {level} = $level;
-        $msg[-1] -> {unids} = [];
-        $msg[-1] -> {kids} = [];
-        $msg[-1] -> {answers} = 0;}
-
-      else {
-        $cmno = pop @stack; $level--;}}
-
-  # ============
-  # Sortieren und bei Bedarf
-  # geloeschte Messages entfernen
-
-    my $smsg = sort_thread (\@msg, $sorted);
-    delete_messages ($smsg) unless ($deleted);
+    my $smsg = sort_thread (\@msg, $sorted);    # sort messages
+    delete_messages ($smsg) unless ($deleted);  # remove invisible messages

 
     $threads{$tid} = $smsg if (@$smsg);
   }
 
 
     $threads{$tid} = $smsg if (@$smsg);
   }
 

-  wantarray?(\%threads, $last_thread, $last_message, \@unids): \%threads;
+  wantarray
+    ? (\%threads, $last_thread, $last_message, $dtd, \@unids)
+    : \%threads;

 }
 
 }
 

-###########################
-# sub create_forum_xml_string
+### create_forum_xml_string () #################################################
+#
+# compose main file xml string
+#
+# Params: $threads - parsed threads (see also 'get_all_threads')
+#         $params  - hashref (see doc for details)
+#
+# Return: scalarref of the xml string

 #
 #

-# Forumshauptdatei erzeugen
-###########################
-

 sub create_forum_xml_string ($$) {
   my ($threads, $param) = @_;
   my ($level, $thread, $msg);
 
 sub create_forum_xml_string ($$) {
   my ($threads, $param) = @_;
   my ($level, $thread, $msg);
 

-  my $xml = '<?xml version="1.0" encoding="UTF-8"?>'."\n"
-           .'<!DOCTYPE Forum SYSTEM "'.$param -> {dtd}.'">'."\n"
-           .'<Forum lastMessage="'.$param -> {lastMessage}.'" lastThread="'.$param -> {lastThread}.'">';
+  my $xml =
+      '<?xml version="1.0"?>'."\n"
+    . '<!DOCTYPE Forum SYSTEM "'.FORUM_DTD.'">'."\n"
+    . '<Forum lastMessage="m'.($param->{lastMessage} =~ /(\d+)/)[0].'" lastThread="t'.($param->{lastThread} =~ /(\d+)/)[0].'">';

 
 

-  foreach $thread (sort {$b <=> $a} keys %$threads) {
+  for $thread (sort {$b <=> $a} keys %$threads) {

     $xml .= '<Thread id="t'.$thread.'">';
     $level = -1;
 
     $xml .= '<Thread id="t'.$thread.'">';
     $level = -1;
 

-    foreach $msg (@{$threads -> {$thread}}) {
-      $xml .= '</Message>' x ($level - $msg -> {level} + 1) if ($msg -> {level} <= $level);
+    for $msg (@{$threads -> {$thread}}) {
+      $xml  .= '</Message>' x ($level - $msg -> {level} + 1) if ($msg -> {level} <= $level);
+

       $level = $msg -> {level};
       $level = $msg -> {level};

-      $xml .= '<Message id="m'.$msg -> {mid}.'"'
-                  .' unid="'.$msg -> {unid}.'"'
-                  .(($msg -> {deleted})?' flag="deleted"':'')
-                  .'>'
-             .'<Header>'
-             .'<Author>'
-             .'<Name>'
-                  .plain($msg -> {name})
-                  .'</Name>'
-             .'<Email></Email>'
-             .'</Author>'
-             .'<Category>'
-                  .((length $msg -> {cat})?plain($msg -> {cat}):'')
-                  .'</Category>'
-             .'<Subject>'
-                  .plain($msg -> {subject})
-                  .'</Subject>'
-             .'<Date longSec="'
-                  .$msg -> {time}
-                  .'"/>'
-             .'</Header>';}
+      $xml  .=
+          '<Message id="m'.$msg -> {mid}.'"'
+            . (($msg -> {unid})   ?' unid="'.$msg -> {unid}.'"':'')
+            . (($msg -> {deleted})?' invisible="1"':'')
+            . (($msg -> {archive})?' archive="1"':'')
+            . '>'
+        . '<Header>'
+        . '<Author>'
+        . '<Name>'
+            . plain($msg -> {name})
+        . '</Name>'
+        . '<Email />'
+        . '</Author>'
+        . '<Category>'
+            . ((length $msg -> {cat})?plain($msg -> {cat}):'')
+        . '</Category>'
+        . '<Subject>'
+            . plain($msg -> {subject})
+        . '</Subject>'
+        . '<Date longSec="'
+            . $msg -> {time}
+            . '"/>'
+        . '</Header>';
+    }

 
     $xml .= '</Message>' x ($level + 1);
     $xml .= '</Thread>';}
 
     $xml .= '</Message>' x ($level + 1);
     $xml .= '</Thread>';}


@@ -439,21 +639,26 @@ sub create_forum_xml_string ($$) {
   \$xml;
 }
 
   \$xml;
 }
 

-###########################
-# sub save_file
+### save_file () ###############################################################

 #
 #

-# Datei speichern
-###########################
-
-sub save_file ($$) {
-  my ($filename,$content) = @_;
+# Save a file
+#
+# Params: $filename  Filename
+#         $content   File content as scalar reference
+# Return: Status (1 - ok, 0 - error)
+#
+sub save_file ($$)
+{
+  my ($filename, $content) = @_;

   local *FILE;
 
   local *FILE;
 

-  open FILE,">$filename.temp" or return;
+  open FILE, ">$filename.temp" or return;

 
 

-  unless (print FILE $$content) {
+  unless (print FILE $$content)
+  {

     close FILE;
     close FILE;

-    return;};
+    return;
+  }

 
   close FILE or return;
 
 
   close FILE or return;
 


@@ -462,55 +667,55 @@ sub save_file ($$) {
   1;
 }
 
   1;
 }
 

-# ====================================================
-# Zeitdarstellung
-# ====================================================
-
-###########################
-# sub hr_time
+################################################################################
+#
+# several time formatting routines
+#
+# hr_time

 #     02. Januar 2001, 12:02 Uhr
 #
 #     02. Januar 2001, 12:02 Uhr
 #

-# sub short_hr_time
+# short_hr_time

 #     02. 01. 2001, 12:02 Uhr
 #
 #     02. 01. 2001, 12:02 Uhr
 #

-# sub long_hr_time
+# long_hr_time

 #     Dienstag, 02. Januar 2001, 12:02:01 Uhr
 #
 #     Dienstag, 02. Januar 2001, 12:02:01 Uhr
 #

-# formatierte Zeitangabe
-###########################
+# very_short_hr_time
+#     02. 01. 2001
+#
+sub month($) {
+  (qw(Januar Februar), "M\303\244rz", qw(April Mai Juni Juli August September Oktober November Dezember))[shift (@_) - 1];
+                       # ^^^^^^^^ - UTF8 #
+}

 
 sub hr_time ($) {
 
 sub hr_time ($) {

-  my @month = qw(Januar Februar M\303\244rz April Mail Juni Juli August September Oktober November Dezember);
-                               # ^^^^^^^^ - UTF8 #
-
-  my (undef, $min, $hour, $day, $mon, $year) = localtime ($_[0]);
+  my (undef, $min, $hour, $day, $mon, $year) = localtime (shift);

 
 

-  sprintf ('%02d. %s %04d, %02d:%02d Uhr', $day, $month[$mon], $year+1900, $hour, $min);
+  sprintf ('%02d. %s %04d, %02d:%02d Uhr', $day, month($mon+1), $year+1900, $hour, $min);

 }
 
 sub short_hr_time ($) {
 }
 
 sub short_hr_time ($) {

-  my (undef, $min, $hour, $day, $mon, $year) = localtime ($_[0]);
+  my (undef, $min, $hour, $day, $mon, $year) = localtime (shift);

 
   sprintf ('%02d. %02d. %04d, %02d:%02d Uhr', $day, $mon+1, $year+1900, $hour, $min);
 }
 
 sub long_hr_time ($) {
 
   sprintf ('%02d. %02d. %04d, %02d:%02d Uhr', $day, $mon+1, $year+1900, $hour, $min);
 }
 
 sub long_hr_time ($) {

-  my @month = qw(Januar Februar M\303\244rz April Mail Juni Juli August September Oktober November Dezember);
-                               # ^^^^^^^^ - UTF8 #
-

   my @wday  = qw(Sonntag Montag Dienstag Mittwoch Donnerstag Freitag Samstag);
   my @wday  = qw(Sonntag Montag Dienstag Mittwoch Donnerstag Freitag Samstag);

-  my ($sek, $min, $hour, $day, $mon, $year, $wday) = localtime ($_[0]);
+  my ($sek, $min, $hour, $day, $mon, $year, $wday) = localtime (shift);

 
 

-  sprintf ('%s, %02d. %s %04d, %02d:%02d:%02d Uhr', $wday[$wday], $day, $month[$mon], $year+1900, $hour, $min, $sek);
+  sprintf ('%s, %02d. %s %04d, %02d:%02d:%02d Uhr', $wday[$wday], $day, month($mon+1), $year+1900, $hour, $min, $sek);

 }
 
 }
 

-# ====================================================
-# Modulinitialisierung
-# ====================================================
+sub very_short_hr_time($) {
+  my (undef, $min, $hour, $day, $mon, $year) = localtime (shift);
+
+  sprintf ('%02d. %02d. %04d', $day, $mon+1, $year+1900);
+}

 
 

-# making require happy
+# keep 'require' happy

 1;
 
 1;
 

-# ====================================================
-# end of Posting::_lib
-# ====================================================
+#
+#
+### end of Posting::_lib #######################################################
\ No newline at end of file