added version checks and some comments, removed Posting::_lib::create_message_xml...

[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 30a8254b96233c2715957e0aab00e9185d9e6675..4ca15145af43edb19ccbe1afdb6f593b54b2f61e 100644 (file)
--- a/selfforum-cgi/shared/Posting/_lib.pm
+++ b/selfforum-cgi/shared/Posting/_lib.pm
@@ -4,30 +4,41 @@ package Posting::_lib;
 #                                                                              #
 # File:        shared/Posting/_lib.pm                                          #
 #                                                                              #
 #                                                                              #
 # File:        shared/Posting/_lib.pm                                          #
 #                                                                              #

-# Authors:     André Malo <nd@o3media.de>, 2001-03-03                          #
-#              Frank Schoenmann <fs@tower.de>, 2001-06-02                      #
+# Authors:     André Malo <nd@o3media.de>, 2001-06-11                          #
+#              Frank Schoenmann <fs@tower.de>, 2001-06-04                      #

 #                                                                              #
 # Description: Message access interface, time format routines                  #
 #                                                                              #
 ################################################################################
 
 use strict;
 #                                                                              #
 # Description: Message access interface, time format routines                  #
 #                                                                              #
 ################################################################################
 
 use strict;

+use vars qw(
+  @EXPORT_OK
+  $VERSION
+);

 
 use Encode::Plain; $Encode::Plain::utf8 = 1;
 
 
 use Encode::Plain; $Encode::Plain::utf8 = 1;
 

+use Time::German;

 use XML::DOM;
 
 use XML::DOM;
 

-# ====================================================
-# Export
-# ====================================================
+################################################################################
+#
+# Version check
+#
+$VERSION = do { my @r =(q$Revision$ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r };

 
 

-use constant SORT_ASCENT  => 0; # (young postings first)
+################################################################################
+#
+# 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 base qw(Exporter);
 use constant SORT_DESCENT => 1;
 use constant KEEP_DELETED => 1;
 use constant KILL_DELETED => 0;
 
 use base qw(Exporter);

-@Posting::_lib::EXPORT_OK = qw(
+@EXPORT_OK = qw(

   get_message_header
   get_message_body
   get_message_node
   get_message_header
   get_message_body
   get_message_node


@@ -40,6 +51,7 @@ use base qw(Exporter);
   hr_time
   short_hr_time
   long_hr_time
   hr_time
   short_hr_time
   long_hr_time

+  very_short_hr_time

   month
 
   get_all_threads
   month
 
   get_all_threads


@@ -53,9 +65,10 @@ use base qw(Exporter);
   KILL_DELETED
 );
 
   KILL_DELETED
 );
 

-# ====================================================
+################################################################################
+#

 # Access via XML::DOM
 # Access via XML::DOM

-# ====================================================
+#

 
 ### sub create_message ($$) ####################################################
 #
 
 ### sub create_message ($$) ####################################################
 #


@@ -304,13 +317,16 @@ sub parse_xml_file ($) {
   $xml;
 }
 
   $xml;
 }
 

-###########################
-# sub parse_single_thread
+### parse_single_thread () #####################################################
+#
+# parse a thread file
+#
+# Params: $tnode - Thread element node
+#         $deleted - keep deleted (boolean)
+#         $sorted  - sorting order
+#
+# Return: arrayref

 #
 #

-# einzelne Threaddatei
-# parsen
-###########################
-

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


@@ -318,122 +334,74 @@ 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 ('invisible'),
-               archive => $_ -> getAttribute ('archive'),
-               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 ('invisible', '1') if ($msg -> {deleted});
-  $message -> setAttribute ('archive', '1') if ($msg -> {archive});
-
-  # 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});
     delete $_ -> {kids};}
 
   my @smsg = ($msg -> [0]);
   for (@smsg) {
     ++$z;
     splice @smsg,$z,0,@{$mhash{$_ -> {mid}}} if ($_ -> {answers});
     delete $_ -> {kids};}
 

+  # return

   \@smsg;
 }
 
   \@smsg;
 }
 


@@ -480,14 +448,14 @@ sub delete_messages ($) {
 #
 # Read and Parse the main file (without any XML-module, they are too slow)
 #
 #
 # 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
+# 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)
 #
 #           list context: list (\%threads, $last_thread, $last_message, $dtd, \@unids)
 #

-sub get_all_threads ($$;$)
-{
+sub get_all_threads ($$;$) {

   my ($file, $deleted, $sorted) = @_;
   my ($last_thread, $last_message, $dtd, @unids, %threads);
   local (*FILE, $/);
   my ($file, $deleted, $sorted) = @_;
   my ($last_thread, $last_message, $dtd, @unids, %threads);
   local (*FILE, $/);


@@ -496,8 +464,7 @@ sub get_all_threads ($$;$)
   my $xml = join '', <FILE>;
   close(FILE) or return;
 
   my $xml = join '', <FILE>;
   close(FILE) or return;
 

-  if (wantarray)
-  {
+  if (wantarray) {

     ($dtd)          = $xml =~ /<!DOCTYPE\s+\S+\s+SYSTEM\s+"([^"]+)">/;
     ($last_thread)  = map {/(\d+)/} $xml =~ /<Forum.+?lastThread="([^"]+)"[^>]*>/;
     ($last_message) = map {/(\d+)/} $xml =~ /<Forum.+?lastMessage="([^"]+)"[^>]*>/;
     ($dtd)          = $xml =~ /<!DOCTYPE\s+\S+\s+SYSTEM\s+"([^"]+)">/;
     ($last_thread)  = map {/(\d+)/} $xml =~ /<Forum.+?lastThread="([^"]+)"[^>]*>/;
     ($last_message) = map {/(\d+)/} $xml =~ /<Forum.+?lastMessage="([^"]+)"[^>]*>/;


@@ -607,49 +574,56 @@ sub get_all_threads ($$;$)
     : \%threads;
 }
 
     : \%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" encoding="UTF-8"?>'."\n"
+    . '<!DOCTYPE Forum SYSTEM "'.$param -> {dtd}.'">'."\n"
+    . '<Forum lastMessage="'.$param -> {lastMessage}.'" lastThread="'.$param -> {lastThread}.'">';

 
 

-  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})?' invisible="1"':'')
-                  .(($msg -> {archive})?' archive="1"':'')
-                  .'>'
-             .'<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}.'"'
+            . ' 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>';}


@@ -687,58 +661,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", qw(April Mai Juni Juli August September Oktober November Dezember));
-                                   # ^^^^^^^^ - UTF8 #
-
-  my (undef, $min, $hour, $day, $mon, $year) = localtime ($_[0]);
+  my (undef, $min, $hour, $day, $mon, $year) = germantime (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) = germantime (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", qw(April Mai 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) = germantime (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);

 }
 
 }
 

-sub month($) {
-    my @month = (qw(Januar Februar), "M\303\244rz", qw(April Mai Juni Juli August September Oktober November Dezember));
-                                     # ^^^^^^^^ - UTF8 #
+sub very_short_hr_time($) {
+  my (undef, $min, $hour, $day, $mon, $year) = germantime (shift);

 
 

-    return $month[$_[0]];
+  sprintf ('%02d. %02d. %04d', $day, $mon+1, $year+1900);

 }
 
 }
 

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

 1;
 1;

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