lib/CXGN/People/PageComment.pm

   1
   2 =head1 NAME
   3
   4 CXGN::People::PageComment - a package for adding user comments to database detail pages.
   5
   6 =head1 SYNOPSYS
   7
   8 my $page_comment_obj = CXGN::People::PageComment->new($dbh, "map", $map_id, $referer);
   9
  10 print $page_comment_obj->get_html();
  11
  12 =head1 DESCRIPTION
  13
  14 Handles the addition and deletion of user comments to SGN pages. Users have to be logged in using SGN's login system to post/delete messages.
  15
  16 =head1 DEPENDENCIES
  17
  18 The current implementation depends on CXGN::People::Forum.
  19
  20 =head1 USAGE ON DETAIL PAGES
  21
  22 On detail pages, the page comment feature should be added using a mason module, /page/comments.mas.
  23
  24 =head1 FUNCTIONS
  25
  26 This class implements the following methods:
  27
  28 =cut
  29
  30 use strict;
  31
  32 package CXGN::People::PageComment;
  33
  34 use CXGN::Login;
  35 use CXGN::People;
  36 use CXGN::People::Forum;
  37
  38 use base qw | CXGN::DB::Object |;
  39
  40 =head2 constructor new()
  41
  42 Synopsis: my $pc = CXGN::People::PageComment -> new($dbh, "map", 9, $referer);
  43 Arguments:
  44     (1) A database handle
  45     (2) A type, one of "BAC", "EST", "unigene", "marker", "map", "bac_end"
  46     (3) the object\'s ID (an integer value that specifies the page).
  47     (4) the refering page, including the page arguments
  48 Returns: a handle to a Page_comment object
  49 Side effects: Accesses the sgn_people database through the Forum.pm interface to search for comments for the specified type/ID and caches them.
  50 Description:
  51
  52 =cut
  53
  54 sub new {
  55     my $class = shift;
  56     my $dbh = shift;
  57     my $type = shift;
  58     my $id = shift;
  59     my $referer = shift;
  60
  61     my $args = {};
  62     my $self = $class->SUPER::new($dbh);
  63
  64     $self->set_type($type);
  65     $self->set_id($id);
  66
  67     # get a page object to decide if a user is logged in.
  68 #    my $page= CXGN::Page->new("", "Lukas");
  69     $self->set_user_id(CXGN::Login->new($self->get_dbh())->has_session());
  70     $self->set_refering_page($referer);
  71     #print STDERR "Referer: ".($self->get_refering_page())."\n";
  72
  73     @{$self->{posts}}= ();
  74     $self->fetch_page_comments();
  75
  76     return $self;
  77 }
  78
  79 =head2 function fetch_page_comments()
  80
  81  Usage:        $pcobj -> fetch_page_comments();
  82  Desc:         populates the page comment object from the
  83                database. Called by the constructor.
  84  Side Effects:
  85  Example:
  86
  87 =cut
  88
  89 sub fetch_page_comments {
  90     #
  91     # fetch the page comments using a function in the Topic class
  92     #
  93     my $self = shift;
  94     #print STDERR "TYPE: ".$self->get_type.", ID: ".$self->get_id()."\n";
  95     my $topic = CXGN::People::Forum::Topic->new_page_comment($self->get_dbh(), $self->get_type(), $self->get_id());
  96     #print STDERR "TOPIC ID: ".$topic->get_forum_topic_id()."\n";
  97
  98     $self->set_topic($topic);
  99     if ($self->get_topic()->get_forum_topic_id()) {
 100         #print STDERR "Topic_id: ".$self->get_topic()->get_forum_topic_id()."\n";
 101         my @posts = $self->get_topic()->get_all_posts();
 102 #       foreach my $p (@posts) { print STDERR "POSTS: ".($p->get_subject())."\n"; }
 103         $self->set_posts(@posts);
 104
 105     }
 106     else {
 107         #print STDERR "No topic could be found corresponding to type=".$self->get_type()." and id=".$self->get_id()."\n";
 108     }
 109
 110 }
 111
 112 =head2 accessors set_refering_page(), get_refering_page()
 113
 114  Usage:        $pc->set_refering_page('/detail?object_id=$id');
 115  Property:     the url of the page that the post is stored
 116                for.
 117  Side Effects: the url will be embedded in links to get back to
 118                the relevant detail page.
 119  Example:
 120
 121 =cut
 122
 123 sub set_refering_page {
 124     my $self = shift;
 125     $self->{refering_page} = shift;
 126 }
 127
 128 sub get_refering_page {
 129     my $self = shift;
 130     return $self->{refering_page};
 131 }
 132
 133 =head2 accessors set_topic(), get_topic()
 134
 135  Usage:        $pc->set_topic($topic_id)
 136  Property:     each post has an associated topic_id
 137  Side Effects:
 138  Example:
 139
 140 =cut
 141
 142 sub set_topic {
 143     my $self = shift;
 144     $self->{topic}=shift;
 145 }
 146
 147 sub get_topic {
 148     my $self = shift;
 149     return $self->{topic};
 150 }
 151
 152 =head2 accessors set_posts(), get_posts()
 153
 154  Usage:        $pc->set_posts(@posts)
 155  Property:     The posts for this type and id combination
 156  Side Effects:
 157  Example:
 158
 159 =cut
 160
 161 sub set_posts {
 162     my $self = shift;
 163     @{$self->{posts}} = @_;
 164 }
 165
 166 sub get_posts {
 167     my $self = shift;
 168     return @{$self->{posts}};
 169 }
 170
 171 =head2 accessors set_type(), get_type()
 172
 173  Usage:        $pc->set_type('marker');
 174  Property:     the type of page this page comment
 175                is stored for. Supported are things like
 176                bac, marker, pub, locus, etc.
 177  Side Effects:
 178  Example:
 179
 180 =cut
 181
 182 sub set_type {
 183     my $self = shift;
 184     $self->{type}=shift;
 185 }
 186
 187 sub get_type {
 188     my $self = shift;
 189     return $self->{type};
 190 }
 191
 192 =head2 accessors set_id(), get_id()
 193
 194  Usage:        $pc->set_id($id)
 195  Property:     the id of this post
 196  Side Effects:
 197  Example:
 198
 199 =cut
 200
 201 sub set_id {
 202     my $self = shift;
 203     $self->{id}=shift;
 204 }
 205
 206 sub get_id  {
 207     my $self = shift;
 208     return $self->{id};
 209 }
 210
 211 =head2 accessors set_user_id(), get_user_id()
 212
 213  Usage:        $pc->set_user_id($sp_person_id)
 214  Property:     the id of the user owning the post
 215  Side Effects:
 216  Example:
 217
 218 =cut
 219
 220 sub set_user_id {
 221     my $self = shift;
 222     $self->{user_id}=shift;
 223 }
 224
 225 sub get_user_id {
 226     my $self = shift;
 227     return $self->{user_id};
 228 }
 229
 230 =head2 function get_html()
 231
 232   THIS FUNCTION IS DEPRECATED. USE /page/comments.mas IN NEW CODE.
 233   Synopsis:     print $cp -> get_html();
 234   Arguments:    none
 235   Returns:      a string containing html code containing the user
 236                 comments
 237   Side effects:
 238   Description:
 239
 240
 241 =cut
 242
 243 sub get_html {
 244
 245   my ($self, $passed_referer) = @_;
 246
 247   my @posts = $self->get_posts();
 248
 249   # We want to eventually return the user to the page they came from
 250   #my $encoded_url = url_encode($self->get_refering_page());
 251
 252   # ...but if a referer is provided, we'll use that instead (helpful
 253   # with ajax)
 254   my $encoded_url = url_encode($self->get_refering_page()) || url_encode($passed_referer);
 255 #  warn "UNENCODED URL IS $passed_referer";
 256 #  warn "ENCODED URL IS $encoded_url";
 257
 258   my $s;
 259   my $subtitle;
 260   if (!@posts) {
 261     #$subtitle ="<span class=\"ghosted\">No user comments.</span>";
 262   }
 263   else
 264     {
 265       $s .= "<div class=\"indentedcontent\"><table width=\"700\" summary=\"\" cellpadding=\"3\" cellspacing=\"0\" border=\"0\" >";
 266       foreach my $p (@posts) {
 267         my $subject = $p->get_subject();
 268         my $person_id = $p -> get_person_id();
 269         my $person = CXGN::People::Person -> new($self->get_dbh(), $person_id);
 270         my $sp_person_id = $person -> get_sp_person_id();
 271         my $name = $person->get_first_name()." ".$person->get_last_name();
 272
 273         my $user_type = $person->get_user_type();
 274
 275         my $remove_link = "&nbsp;";
 276         if ($sp_person_id && ($self->get_user_id() == $sp_person_id || $user_type eq 'curator' )) {
 277           $remove_link = "<a href=\"/forum/forum_post_delete.pl?post_id=".($p->get_forum_post_id())."&amp;refering_page=$encoded_url\">Delete</a>\n";
 278         }
 279
 280         if($user_type and $user_type ne 'user'){
 281           $user_type=" ($user_type)";
 282         } else {
 283           $user_type='';
 284         }
 285
 286         my $text = $p -> get_post_text();
 287         my $date = $p -> get_formatted_post_time();
 288
 289         my $poster_html = $sp_person_id
 290             ? "<a href=\"/solpeople/personal-info.pl?action=view&amp;sp_person_id=$sp_person_id\">$name</a>$user_type"
 291             : "anonymous";
 292
 293         $s .= "<tr><td><div class=\"boxbgcolor2\">
 294
 295                    <table summary=\"\" cellspacing=\"0\" cellpadding=\"0\" border=\"0\" width=\"100%\"><tr><td>Posted by <b>$poster_html</b> on $date  </td><td class=\"right\">$remove_link&nbsp;</td></tr></table>
 296
 297 </div>";
 298         $s .= "<div class=\"boxbgcolor5\"><div class=\"indentedcontent\">$text</div></div></td></tr>";
 299       }
 300       $s .= "</table></div>";
 301     }
 302
 303   $subtitle .= "<a href=\"/forum/add_post.pl?page_type=".$self->get_type()."&amp;page_object_id=".$self->get_id()."&amp;refering_page=$encoded_url\">[Add comment]</a>";
 304
 305
 306   return CXGN::Page::FormattingHelpers::info_section_html(title   => 'User comments',
 307                                                           collapsible => 1,
 308                                                           subtitle=>$subtitle,
 309                                                           contents =>$s  ,
 310                                                          );
 311 }
 312
 313 sub url_encode {
 314     my $theURL = $_[0];
 315    $theURL =~ s/([\W])/"%" . uc(sprintf("%2.2x",ord($1)))/eg;
 316    return $theURL;
 317 }
 318
 319
 320 1;