lib/CXGN/People/Forum.pm

   1 =head1 NAME
   2
   3 CXGN::People::Forum - classes to handle the SOL forum on the SGN website.
   4
   5 =head1 DESCRIPTION
   6
   7 The Forum comprises three main classes:
   8
   9 =over 5
  10
  11 =item o
  12
  13 CXGN::People::Forum
  14
  15 =item o
  16
  17 CXGN::People::Forum::Topic
  18
  19 =item o
  20
  21 CXGN::People::Forum::Post
  22
  23 =back
  24
  25 These are described in more detail below.
  26
  27 =head1 AUTHOR
  28
  29 Lukas Mueller (lam87@cornell.edu)
  30
  31 =cut
  32
  33 use strict;
  34 require CXGN::Contact;
  35 use CXGN::People::Forum::Topic;
  36 use CXGN::People::Forum::Post;
  37
  38 =head1 PACKAGE CXGN::People::Forum
  39
  40 Parent class of CXGN::People::* classes that essentially handles database access and provides utility functions used by all subclasses.
  41
  42 =cut
  43
  44 package CXGN::People::Forum;
  45
  46 #use base qw( CXGN::Class::DBI );
  47 use base qw | CXGN::DB::Object |;
  48
  49
  50 =head2 function new()
  51
  52   Synopsis:     constructor
  53   Arguments:    none
  54   Returns:      a CXGN::People::Forum object
  55   Side effects: establishes a connection to the database
  56   Description:  should not be called explicitly, but rather
  57                 by subclasses of this class.
  58
  59 =cut
  60
  61 sub new {
  62     my $class = shift;
  63     my $dbh = shift;
  64
  65     my $self = $class->SUPER::new($dbh);
  66
  67     return $self;
  68 }
  69
  70 =head2 function format_post_text()
  71
  72   Synopsis:
  73   Arguments:
  74   Returns:
  75   Side effects:
  76   Description:  formats a post or topic text for display.
  77                 Note that it converts certain embedded tags to
  78                 html links. This function does not assure security
  79                 - use the get_encoded_arguments in the CXGN::Page
  80                 object for that purpose.
  81
  82 =cut
  83
  84 sub format_post_text {
  85     my $self = shift;
  86     my $post_text = shift;
  87
  88     # support vB script url tag
  89     while ($post_text =~ /\[url\](.*?)\[\/url\]/g ) {
  90         my $link = $1;
  91         my $replace_link = $link;
  92         if ($link !~ /^http/i) {
  93             $replace_link = "http:\/\/$link";
  94         }
  95         $post_text =~ s/\[url\]$link\[\/url\]/\<a href=\"$replace_link\"\>$replace_link\<\/a\>/g;
  96     }
  97     # convert newlines to <br /> tags
  98     #
  99     $post_text =~ s/\n/\<br \/\>/g;
 100     return $post_text;
 101 }
 102
 103 1;
 104