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

[selfforum.git] / selfforum-cgi / shared / Template / Archive.pm

diff --git a/selfforum-cgi/shared/Template/Archive.pm b/selfforum-cgi/shared/Template/Archive.pm
index a0497a8286ceceb356e0afc15c93217635e03c72..7e97addba3e87a4a6b95350430ad3ea6abc3e0bd 100644 (file)
--- a/selfforum-cgi/shared/Template/Archive.pm
+++ b/selfforum-cgi/shared/Template/Archive.pm
@@ -4,7 +4,7 @@ package Template::Archive;
 #                                                                              #
 # File:        shared/Template/Archive.pm                                      #
 #                                                                              #
-# Authors:     Frank Schoenmann <fs@tower.de>, 2001-06-04                      #
+# Authors:     Frank Schoenmann <fs@tower.de>, 2001-06-08                      #
 #                                                                              #
 # Description: archive display                                                 #
 #                                                                              #
@@ -20,10 +20,14 @@ use Posting::_lib qw(
     get_message_header
     get_message_body
 
+    get_all_threads
     parse_single_thread
     parse_xml_file
 
+    very_short_hr_time
+    short_hr_time
     hr_time
+    month
 
     KILL_DELETED
 );
@@ -36,19 +40,133 @@ use Template::_thread;
 # Export
 #
 use base qw(Exporter);
-@Template::Archive::EXPORT = qw(print_thread_as_HTML);
+@Template::Archive::EXPORT = qw(
+    print_overview_as_HTML
+    print_year_as_HTML
+    print_month_as_HTML
+    print_thread_as_HTML
+);
+
+
+### print_overview_as_HTML () ##################################################
+#
+# archive entry
+#
+# Params: $arcdir     main archive directory
+#         $tempfile   template filename
+#         $param      hash reference
+# Return: -none-
+#
+sub print_overview_as_HTML($$$) {
+    my ($arcdir, $tempfile, $param) = @_;
+
+    my $assign = $param->{'assign'};
+
+    my $template = new Template $tempfile;
+
+    #
+    # archiveDocStart
+    #
+    print ${$template->scrap(
+        $assign->{'archiveDocStart'}
+    )};
+
+    #
+    # globbing to find year directories
+    #
+    for (<$arcdir????>) {
+        s/$arcdir//;
+        print ${$template->scrap(
+            $assign->{'archiveDocEntry'},
+            {
+                $assign->{'year'}   => $_
+            }
+
+        )};
+    }
+
+#   for (my $month = 1; $month <= 12; $month++) {
+#       if (-e $yeardir.$month.'/') {
+#           print ${$template->scrap(
+#               $assign->{'yearDocEntry'},
+#               {
+#                   $assign->{'year'}       => $param->{'year'},
+#                   $assign->{'month'}      => $month,
+#                   $assign->{'monthName'}  => month($month)
+#               }
+#           )};
+#       }
+#   }
 
+    #
+    # archiveDocEnd
+    #
+    print ${$template->scrap(
+        $assign->{'archiveDocEnd'}
+    )};
+}
 
 ### print_year_as_HTML () ######################################################
 #
 # yearly overview over months
 #
-# Params:
+# Params: $yeardir    directory, which contains month directories
 #         $tempfile   template filename
 #         $param      hash reference
 # Return: -none-
 #
+sub print_year_as_HTML($$$) {
+    my ($yeardir, $tempfile, $param) = @_;
+
+    my $assign = $param->{'assign'};
+
+    my $template = new Template $tempfile;
+
+    #
+    # check if this year's archive exist
+    #
+    unless (-e $yeardir) {
+        print ${$template->scrap(
+            $assign->{'error'},
+            {
+                $assign->{'errorText'}  => "Es existieren keine Nachrichten für dieses Jahr."
+            }
+        )};
+    }
+
+    my $tmplparam = {
+            $assign->{'year'}           => $param->{'year'},
+    };
+
+    #
+    # yearDocStart
+    #
+    print ${$template->scrap(
+        $assign->{'yearDocStart'},
+        $tmplparam
+    )};
 
+    for (my $month = 1; $month <= 12; $month++) {
+        if (-e $yeardir.$month.'/') {
+            print ${$template->scrap(
+                $assign->{'yearDocEntry'},
+                {
+                    $assign->{'year'}       => $param->{'year'},
+                    $assign->{'month'}      => $month,
+                    $assign->{'monthName'}  => month($month)
+                }
+            )};
+        }
+    }
+
+    #
+    # yearDocEnd
+    #
+    print ${$template->scrap(
+        $assign->{'yearDocEnd'},
+        $tmplparam
+    )};
+}
 
 ### print_month_as_HTML () #####################################################
 #
@@ -62,9 +180,77 @@ use base qw(Exporter);
 sub print_month_as_HTML($$$) {
     my ($mainfile, $tempfile, $param) = @_;
 
+    my $assign = $param->{'assign'};
+
     my $template = new Template $tempfile;
 
+    #
+    # check if XML file exists
+    #
+    unless (-e $mainfile) {
+        print ${$template->scrap(
+            $assign->{'error'},
+            {
+                $assign->{'errorText'}  => "Es existieren keine Nachrichten für diesen Monat."
+            }
+        )};
+        return;
+    }
+
+    #
+    # try locking and read/parse threads
+    #
+    my ($threads, $locked);
+    unless ($locked = lock_file($mainfile) and $threads = get_all_threads($mainfile, KILL_DELETED)) {
+        print ${$template->scrap(
+            $assign->{'error'},
+            {
+                $assign->{'errorText'}  => "Fehler beim Locking."
+            }
+        )};
+        return;
+    }
+    unlock_file($mainfile);
+
+    my $tmplparam = {
+            $assign->{'year'}           => $param->{'year'},
+            $assign->{'month'}          => $param->{'month'},
+            $assign->{'monthName'}      => month($param->{'month'})
+    };
+
+    #
+    # monthDocStart
+    #
+    print ${$template->scrap(
+        $assign->{'monthDocStart'},
+        $tmplparam
+    )};
 
+    #
+    # thread overview
+    #
+    for (sort keys %$threads) {
+        print ${$template->scrap(
+            $assign->{'monthThreadEntry'},
+            {
+                $assign->{'threadID'}       => $_,
+                $assign->{'threadCategory'} => $threads->{$_}->[0]->{'cat'},
+                $assign->{'threadTitle'}    => $threads->{$_}->[0]->{'subject'},
+                $assign->{'threadTime'}     => short_hr_time($threads->{$_}->[0]->{'time'}),
+                $assign->{'threadDate'}     => very_short_hr_time($threads->{$_}->[0]->{'time'}),
+                $assign->{'year'}           => $param->{'year'},
+                $assign->{'month'}          => $param->{'month'}
+            }
+        )};
+    }
+
+    #
+    # monthDocEnd
+    #
+    print ${$template->scrap(
+        $assign->{'monthDocEnd'},
+        $tmplparam
+    )};
 }
 
 ### print_thread_as_HTML () ####################################################
@@ -85,6 +271,19 @@ sub print_thread_as_HTML($$$) {
 
     my $template = new Template $tempfile;
 
+    #
+    # check if XML file exists
+    #
+    unless (-e $mainfile) {
+        print ${$template->scrap(
+            $assign->{'error'},
+            {
+                $assign->{'errorText'}  => "Der gewünschte Thread existiert nicht."
+            }
+        )};
+        return;
+    }
+
     my $view = get_view_params ({
         'adminDefault'  => $param->{'adminDefault'}
     });
@@ -97,6 +296,9 @@ sub print_thread_as_HTML($$$) {
         $tree->{'month'}  => $param->{'month'}
     };
 
+    #
+    # used to print the thread view
+    #
     my $tpar = {
         'thread'    => $param->{'thread'},
         'template'  => $param->{'tree'},
@@ -105,25 +307,33 @@ sub print_thread_as_HTML($$$) {
         'addParam'  => $addparam
     };
 
+    #
+    # threadDocStart
+    #
     my $tmplparam = {
             $assign->{'threadCategory'} => $thread->[0]->{'cat'},
             $assign->{'threadTitle'}    => $thread->[0]->{'subject'},
-            $assign->{'threadYear'}     => $param->{'year'},
-            $assign->{'threadMonth'}    => $param->{'month'},
+            $assign->{'year'}           => $param->{'year'},
+            $assign->{'month'}          => $param->{'month'},
+            $assign->{'monthName'}      => month($param->{'month'}),
             $param->{'tree'}->{'main'}  => html_thread($thread, $template, $tpar)
     };
 
     print ${$template->scrap(
         $assign->{'threadDocStart'},
-        $tmplparam
+        $tmplparam,
+        1
     )};
 
+    #
+    # print thread msgs
+    #
     for (@$thread) {
         my $mnode = get_message_node($xml, 't'.$tid, 'm'.$_->{'mid'});
         my $header = get_message_header($mnode);
         my $body = get_message_body($xml, 'm'.$_->{'mid'});
 
-        my $text = message_field (
+        my $text = message_field(
             $body,
             {
                 'quoteChars'    => plain($view->{'quoteChars'}),
@@ -145,13 +355,18 @@ sub print_thread_as_HTML($$$) {
                 $assign->{'msgCategory'}    => plain($header->{'category'}),
                 $assign->{'msgSubject'}     => plain($header->{'subject'}),
                 $assign->{'msgBody'}        => $text
-            }
+            },
+            1
         )};
     }
 
+    #
+    # threadDocEnd
+    #
     print ${$template->scrap(
         $assign->{'threadDocEnd'},
-        $tmplparam
+        $tmplparam,
+        1
     )};
 }