package WebGUI::Asset::Post;
#-------------------------------------------------------------------
# WebGUI is Copyright 2001-2005 Plain Black Corporation.
#-------------------------------------------------------------------
# Please read the legal notices (docs/legal.txt) and the license
# (docs/license.txt) that came with this distribution before using
# this software.
#-------------------------------------------------------------------
# http://www.plainblack.com info@plainblack.com
#-------------------------------------------------------------------
use strict;
use Tie::CPHash;
use WebGUI::Asset;
use WebGUI::Asset::Template;
use WebGUI::Asset::Post::Thread;
use WebGUI::DateTime;
use WebGUI::Grouping;
use WebGUI::HTML;
use WebGUI::HTMLForm;
use WebGUI::HTTP;
use WebGUI::Icon;
use WebGUI::Id;
use WebGUI::International;
use WebGUI::MessageLog;
use WebGUI::Operation;
use WebGUI::Paginator;
use WebGUI::Privilege;
use WebGUI::Session;
use WebGUI::SQL;
use WebGUI::Storage::Image;
use WebGUI::URL;
use WebGUI::User;
use WebGUI::Utility;
our @ISA = qw(WebGUI::Asset);
#-------------------------------------------------------------------
sub canEdit {
my $self = shift;
return ($session{form}{func} eq "add" && $self->getThread->getParent->canPost) ||
($self->isPoster && $self->getThread->getParent->get("editTimeout") > (WebGUI::DateTime::time() - $self->get("dateUpdated"))) ||
$self->getThread->getParent->canModerate;
}
#-------------------------------------------------------------------
=head2 canView ( )
Returns a boolean indicating whether the user can view the current post.
=cut
sub canView {
my $self = shift;
if ($self->get("status") eq "approved" || $self->get("status") eq "archived") {
return 1;
} elsif ($self->get("status") eq "denied" && $self->canEdit) {
return 1;
} else {
return $self->SUPER::canView;
}
}
#-------------------------------------------------------------------
=head2 chopSubject ( )
Cuts a subject string off at 30 characters.
=cut
sub chopSubject {
my $self = shift;
return substr($self->get("title"),0,30);
}
#-------------------------------------------------------------------
sub definition {
my $class = shift;
my $definition = shift;
push(@{$definition}, {
tableName=>'Post',
className=>'WebGUI::Asset::Post',
properties=>{
storageId => {
fieldType=>"hidden",
defaultValue=>undef
},
threadId => {
fieldType=>"hidden",
defaultValue=>undef
},
dateSubmitted => {
fieldType=>"hidden",
defaultValue=>undef
},
dateUpdated => {
fieldType=>"hidden",
defaultValue=>time()
},
username => {
fieldType=>"hidden",
defaultValue=>$session{user}{alias} || $session{user}{username}
},
status => {
fieldType=>"hidden",
defaultValue=>undef
},
rating => {
fieldType=>"hidden",
defaultValue=>undef
},
views => {
fieldType=>"hidden",
defaultValue=>undef
},
contentType => {
fieldType=>"contentType",
defaultValue=>"mixed"
},
userDefined1 => {
fieldType=>"HTMLArea",
defaultValue=>undef
},
userDefined2 => {
fieldType=>"HTMLArea",
defaultValue=>undef
},
userDefined3 => {
fieldType=>"HTMLArea",
defaultValue=>undef
},
userDefined4 => {
fieldType=>"HTMLArea",
defaultValue=>undef
},
userDefined5 => {
fieldType=>"HTMLArea",
defaultValue=>undef
},
content => {
fieldType=>"HTMLArea",
defaultValue=>undef
}
},
});
return $class->SUPER::definition($definition);
}
#-------------------------------------------------------------------
sub DESTROY {
my $self = shift;
$self->{_thread}->DESTROY if (exists $self->{_thread});
$self->{_storageLocation}->DESTROY if (exists $self->{_storageLocation});
$self->SUPER::DESTROY;
}
#-------------------------------------------------------------------
=head2 formatContent ( [ content, contentType ])
Formats post content for display.
=head3 content
The content to format. Defaults to the content in this post.
=head3 contentType
The content type to use for formatting. Defaults to the content type specified in this post.
=cut
sub formatContent {
my $self = shift;
my $content = shift || $self->get("content");
my $contentType = shift || $self->get("contentType");
my $msg = WebGUI::HTML::filter($content,$self->getThread->getParent->get("filterCode"));
$msg = WebGUI::HTML::format($msg, $contentType);
if ($self->getThread->getParent->get("useContentFilter")) {
$msg = WebGUI::HTML::processReplacements($msg);
}
return $msg;
}
#-------------------------------------------------------------------
=head2 getApproveUrl ( )
Formats the URL to approve a post.
=cut
sub getApproveUrl {
my $self = shift;
return $self->getUrl("func=approve&mlog=".$session{form}{mlog});
}
#-------------------------------------------------------------------
=head2 getDeleteUrl ( )
Formats the url to delete a post.
=cut
sub getDeleteUrl {
my $self = shift;
return $self->getUrl("func=delete");
}
#-------------------------------------------------------------------
=head2 getDenyUrl ( )
Formats the url to deny a post.
=cut
sub getDenyUrl {
my $self = shift;
return $self->getUrl("func=deny&mlog=".$session{form}{mlog});
}
#-------------------------------------------------------------------
=head2 getEditUrl ( )
Formats the url to edit a post.
=cut
sub getEditUrl {
my $self = shift;
return $self->getUrl("func=edit");
}
#-------------------------------------------------------------------
sub getIcon {
my $self = shift;
my $small = shift;
return $session{config}{extrasURL}.'/assets/small/post.gif' if ($small);
return $session{config}{extrasURL}.'/assets/post.gif';
}
#-------------------------------------------------------------------
sub getImageUrl {
my $self = shift;
return undef if ($self->get("storageId") eq "");
my $storage = $self->getStorageLocation;
my $url;
foreach my $filename (@{$storage->getFiles}) {
if ($storage->isImage($filename)) {
$url = $storage->getUrl($filename);
last;
}
}
return $url;
}
#-------------------------------------------------------------------
sub getName {
return "Post";
}
#-------------------------------------------------------------------
=head2 getPosterProfileUrl ( )
Formats the url to view a users profile.
=cut
sub getPosterProfileUrl {
my $self = shift;
return $self->getUrl("op=viewProfile&uid=".$self->get("ownerUserId"));
}
#-------------------------------------------------------------------
=head2 getRateUrl ( rating )
Formats the url to rate a post.
=head3 rating
An integer between 1 and 5 (5 = best).
=cut
sub getRateUrl {
my $self = shift;
my $rating = shift;
return $self->getUrl("func=rate&rating=".$rating."#".$self->getId);
}
#-------------------------------------------------------------------
=head2 getReplyUrl ( [ withQuote ] )
Formats the url to reply to a post.
=head3 withQuote
If specified the reply with automatically quote the parent post.
=cut
sub getReplyUrl {
my $self = shift;
my $withQuote = shift || 0;
return $self->getUrl("func=add&class=WebGUI::Asset::Post&withQuote=".$withQuote);
}
#-------------------------------------------------------------------
sub getStatus {
my $self = shift;
my $status = $self->get("status");
if ($status eq "approved") {
return "Approved";
} elsif ($status eq "denied") {
return "Denied";
} elsif ($status eq "pending") {
return "Pending";
}
}
#-------------------------------------------------------------------
sub getStorageLocation {
my $self = shift;
unless (exists $self->{_storageLocation}) {
if ($self->get("storageId") eq "") {
$self->{_storageLocation} = WebGUI::Storage::Image->create;
$self->update({storageId=>$self->{_storageLocation}->getId});
} else {
$self->{_storageLocation} = WebGUI::Storage::Image->get($self->get("storageId"));
}
}
return $self->{_storageLocation};
}
#-------------------------------------------------------------------
sub getSynopsisAndContentFromFormPost {
my $self = shift;
my $synopsis = $session{form}{synopsis};
my $body = $session{form}{content};
unless ($synopsis) {
$body =~ s/\n/\^\-\;/ unless ($body =~ m/\^\-\;/);
my @content = split(/\^\-\;/,$body);
$synopsis = WebGUI::HTML::filter($content[0],"none");
}
$body =~ s/\^\-\;/\n/;
return ($synopsis,$body);
}
#-------------------------------------------------------------------
sub getTemplateVars {
my $self = shift;
my %var = (%{$self->get});
$var{"userId"} = $self->get("ownerUserId");
$var{"user.isPoster"} = $self->isPoster;
$var{"dateSubmitted.human"} = epochToHuman($self->get("dateSubmitted"));
$var{"dateUpdated.human"} = epochToHuman($self->get("dateUpdated"));
$var{content} = $self->formatContent if ($self->getThread);
$var{canEdit} = $self->canEdit if ($self->getThread);
$var{"delete.url"} = $self->getDeleteUrl;
$var{"edit.url"} = $self->getEditUrl;
$var{"status"} = $self->getStatus;
$var{"approve.url"} = $self->getApproveUrl;
$var{"deny.url"} = $self->getDenyUrl;
$var{"reply.url"} = $self->getReplyUrl;
$var{'reply.withquote.url'} = $self->getReplyUrl(1);
$var{'url'} = WebGUI::URL::getSiteURL().$self->getUrl;
$var{'rating.value'} = $self->get("rating")+0;
$var{'rate.url.1'} = $self->getRateUrl(1);
$var{'rate.url.2'} = $self->getRateUrl(2);
$var{'rate.url.3'} = $self->getRateUrl(3);
$var{'rate.url.4'} = $self->getRateUrl(4);
$var{'rate.url.5'} = $self->getRateUrl(5);
$var{'hasRated'} = $self->hasRated;
my $gotImage;
my $gotAttachment;
unless ($self->get("storageId") eq "") {
my $storage = $self->getStorageLocation;
foreach my $filename (@{$storage->getFiles}) {
if (!$gotImage && $storage->isImage($filename)) {
$var{"image.url"} = $storage->getUrl($filename);
$var{"image.thumbnail"} = $storage->getThumbnailUrl($filename);
$gotImage = 1;
}
if (!$gotAttachment && !$storage->isImage($filename)) {
$var{"attachment.url"} = $storage->getUrl($filename);
$var{"attachment.icon"} = $storage->getFileIconUrl($filename);
$var{"attachment.name"} = $filename;
}
push(@{$var{"attachment_loop"}}, {
url=>$storage->getUrl($filename),
icon=>$storage->getFileIconUrl($filename),
filename=>$filename,
thumbnail=>$storage->getThumbnailUrl($filename),
isImage=>$storage->isImage($filename)
});
}
}
return \%var;
}
#-------------------------------------------------------------------
sub getThread {
my $self = shift;
unless (exists $self->{_thread}) {
$self->{_thread} = WebGUI::Asset::Post::Thread->new($self->get("threadId"));
}
return $self->{_thread};
}
#-------------------------------------------------------------------
sub getThumbnailUrl {
my $self = shift;
return undef if ($self->get("storageId") eq "");
my $storage = $self->getStorageLocation;
my $url;
foreach my $filename (@{$storage->getFiles}) {
if ($storage->isImage($filename)) {
$url = $storage->getThumbnailUrl($filename);
last;
}
}
return $url;
}
#-------------------------------------------------------------------
sub getUploadControl {
my $self = shift;
my $uploadControl;
if ($self->get("storageId")) {
my $i;
foreach my $filename (@{$self->getStorageLocation->getFiles}) {
$uploadControl .= ''.$filename.'
';
$i++;
}
return $uploadControl unless ($i < $self->getThread->getParent->get("attachmentsPerPost"));
}
WebGUI::Style::setScript($session{config}{extrasURL}.'/FileUploadControl.js',{type=>"text/javascript"});
$uploadControl .= '
\n\n --- (Edited on ".WebGUI::DateTime::epochToHuman()." by ".$session{user}{alias}.") --- \n
"; } $self->update(\%data); $self->getThread->subscribe if ($session{form}{subscribe}); if ($self->getThread->getParent->get("moderatePosts")) { $self->setStatusPending; } else { $self->setStatusApproved; } my $storage = $self->getStorageLocation; my $filename = $storage->addFileFromFormPost("file"); if (defined $filename) { $self->setSize($storage->getFileSize($filename)); $storage->setPrivileges($self->get("ownerUserId"), $self->get("groupIdView"), $self->get("groupIdEdit")); $storage->generateThumbnail($filename); } $session{form}{proceed} = "redirectToParent"; } #------------------------------------------------------------------- =head2 rate ( rating ) Stores a rating against this post. =head3 rating An integer between 1 and 5 (5 being best) to rate this post with. =cut sub rate { my $self = shift; my $rating = shift; unless ($self->hasRated) { WebGUI::SQL->write("insert into Post_rating (assetId,userId,ipAddress,dateOfRating,rating) values (" .quote($self->getId).", ".quote($session{user}{userId}).", ".quote($session{env}{REMOTE_ADDR}).", ".WebGUI::DateTime::time().", $rating)"); my ($count) = WebGUI::SQL->quickArray("select count(*) from Post_rating where postId=".quote($self->getId)); $count = $count || 1; my ($sum) = WebGUI::SQL->quickArray("select sum(rating) from Post_rating where postId=".quote($self->getId)); my $average = round($sum/$count); $self->update({rating=>$average}); $self->getThread->rate; } } #------------------------------------------------------------------- =head2 setStatusApproved ( ) Sets the post to approved and sends any necessary notifications. =cut sub setStatusApproved { my $self = shift; $self->update({status=>'approved'}); $self->getThread->incrementReplies($self->get("dateUpdated"),$self->getId) if $self->isReply; unless ($self->isPoster) { WebGUI::MessageLog::addInternationalizedEntry($self->get("ownerUserId"),'',$self->getUrl,579); } $self->notifySubscribers; } #------------------------------------------------------------------- =head2 setStatusArchived ( ) Sets the status of this post to archived. =cut sub setStatusArchived { my ($self) = @_; $self->update({status=>'archived'}); } #------------------------------------------------------------------- =head2 setStatusDenied ( ) Sets the status of this post to denied. =cut sub setStatusDenied { my ($self) = @_; $self->update({status=>'denied'}); WebGUI::MessageLog::addInternationalizedEntry($self->get("ownerUserId"),'',$self->getUrl,580); } #------------------------------------------------------------------- =head2 setStatusPending ( ) Sets the status of this post to pending. =cut sub setStatusPending { my ($self) = @_; $self->update({status=>'pending'}); WebGUI::MessageLog::addInternationalizedEntry('',$self->getThread->getParent->get("moderateGroupId"), $self->getUrl,578,'WebGUI','pending'); } #------------------------------------------------------------------- =head2 unmarkRead ( ) Negates the markRead method. =cut sub unmarkRead { my $self = shift; WebGUI::SQL->write("delete from forumRead where userId=".quote($session{user}{userId})." and postId=".quote($self->getId)); } #------------------------------------------------------------------- sub view { my $self = shift; $self->markRead; $self->incrementViews; return $self->getThread->view; } #------------------------------------------------------------------- =head2 www_approve ( ) The web method to approve a post. =cut sub www_approve { my $self = shift; $self->setStatusApproved if $self->getThread->getParent->canModerate; return $self->www_view; } #------------------------------------------------------------------- =head2 www_deny ( ) The web method to deny a post. =cut sub www_deny { my $self = shift; $self->setStatusDenied if $self->getThread->getParent->canModerate; return $self->www_view; } #------------------------------------------------------------------- sub www_edit { my $self = shift; my %var = %{$self->getTemplateVars}; $var{'form.header'} = WebGUI::Form::formHeader({action=>$self->getParent->getUrl}) .WebGUI::Form::hidden({ name=>"func", value=>"add" }); my $content; my $title; if ($session{form}{func} eq "add") { # new post $var{'isNewPost'} = 1; $var{'form.header'} .= WebGUI::Form::hidden({ name=>"assetId", value=>"new" }).WebGUI::Form::hidden({ name=>"class", value=>$session{form}{class} }); if ($session{form}{class} eq "WebGUI::Asset::Post") { # new reply $self->{_thread} = $self->getParent->getThread; return $self->getThread->getParent->processStyle(WebGUI::Privilege::insufficient()) unless ($self->getThread->canReply); $var{isReply} = 1; if ($session{form}{content} || $session{form}{title}) { $content = $session{form}{content}; $title = $session{form}{title}; } else { $content = "[quote]".$self->getParent->get("content")."[/quote]" if ($session{form}{withQuote}); $title = $self->getParent->get("title"); $title = "Re: ".$title unless ($title =~ /^Re:/); } $var{'subscribe.form'} = WebGUI::Form::yesNo({ name=>"subscribe", value=>$session{form}{subscribe} }); } elsif ($session{form}{class} eq "WebGUI::Asset::Post::Thread") { # new thread return $self->getThread->getParent->processStyle(WebGUI::Privilege::insufficient()) unless ($self->getThread->getParent->canPost); $var{isNewThread} = 1; if ($self->getThread->getParent->canModerate) { $var{'sticky.form'} = WebGUI::Form::yesNo({ name=>'stick', value=>$session{form}{stick} }); $var{'lock.form'} = WebGUI::Form::yesNo({ name=>'lock', value=>$session{form}{'lock'} }); } $var{'subscribe.form'} = WebGUI::Form::yesNo({ name=>"subscribe", value=>$session{form}{subscribe} || 1 }); } $content .= "\n\n".$session{user}{signature} if ($session{user}{signature}); } else { # edit return $self->getThread->getParent->processStyle(WebGUI::Privilege::insufficient()) unless ($self->canEdit); $var{isEdit} = 1; $content = $self->getValue("content"); $title = $self->getValue("title"); } if ($session{form}{title} || $session{form}{content} || $session{form}{synopsis}) { $var{'preview.title'} = WebGUI::HTML::filter($session{form}{title},"none"); ($var{'preview.synopsis'}, $var{'preview.content'}) = $self->getSynopsisAndContentFromFormPost; $var{'preview.content'} = $self->formatContent($var{'preview.content'},$session{form}{contentType}); } $var{'form.preview'} = WebGUI::Form::submit({value=>"Preview"}); $var{'form.submit'} = WebGUI::Form::button({ value=>"Save", extras=>"onclick=\"this.value='Please wait...'; this.form.func.value='editSave'; this.form.submit();\"" }); $var{'form.footer'} = WebGUI::Form::formFooter(); $var{usePreview} = $self->getThread->getParent->get("usePreview"); $var{'user.isVisitor'} = ($session{user}{userId} eq '1'); $var{'visitorName.form'} = WebGUI::Form::text({ name=>"visitorName", value=>$self->getValue("visitorName") }); for my $x (1..5) { $var{'userDefined'.$x.'.form'} = WebGUI::Form::text({ name=>"userDefined".$x, value=>$self->getValue("userDefined".$x) }); $var{'userDefined'.$x.'.form.yesNo'} = WebGUI::Form::yesNo({ name=>"userDefined".$x, value=>$self->getValue("userDefined".$x) }); $var{'userDefined'.$x.'.form.textarea'} = WebGUI::Form::textarea({ name=>"userDefined".$x, value=>$self->getValue("userDefined".$x) }); $var{'userDefined'.$x.'.form.textarea'} = WebGUI::Form::HTMLArea({ name=>"userDefined".$x, value=>$self->getValue("userDefined".$x) }); } $var{'title.form'} = WebGUI::Form::text({ name=>"title", value=>$title }); $var{'title.form.textarea'} = WebGUI::Form::textarea({ name=>"title", value=>$title }); if ($self->getThread->getParent->get("allowRichEdit")) { $var{'content.form'} = WebGUI::Form::HTMLArea({ name=>"content", value=>$content }); } else { $var{'content.form'} = WebGUI::Form::textarea({ name=>"content", value=>$content }); } $var{'attachment.form'} = $self->getUploadControl; $var{'contentType.form'} = WebGUI::Form::contentType({ name=>'contentType', value=>$self->getValue("contentType") || "mixed" }); $var{'startDate.form'} = WebGUI::Form::dateTime({ name => 'startDate', value => $self->getValue("startDate") }); $var{'endDate.form'} = WebGUI::Form::dateTime({ name => 'endDate', value => $self->getValue("startDate") }); $self->getThread->getParent->appendTemplateLabels(\%var); return $self->getThread->getParent->processStyle($self->processTemplate(\%var,$self->getThread->getParent->get("postFormTemplateId"))); } #------------------------------------------------------------------- =head2 www_ratePost ( ) The web method to rate a post. =cut sub www_rate { my $self = shift; $self->rate($session{form}{rating}) if ($self->canView && !$self->hasRated); $self->www_view; } #------------------------------------------------------------------- =head2 www_redirectToParent ( ) This is here to stop people from duplicating posts by hitting refresh in their browser. =cut sub www_redirectToParent { my $self = shift; WebGUI::HTTP::setRedirect($self->getThread->getParent->getUrl); } #------------------------------------------------------------------- sub www_view { my $self = shift; $self->markRead; $self->incrementViews; return $self->getThread->www_view; } 1;