package WebGUI::Form::HTMLArea; =head1 LEGAL ------------------------------------------------------------------- WebGUI is Copyright 2001-2009 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 ------------------------------------------------------------------- =cut use strict; use base 'WebGUI::Form::Textarea'; use WebGUI::Asset::File::Image; use WebGUI::Asset::RichEdit; use WebGUI::Asset::Wobject::Folder; use WebGUI::HTML; use WebGUI::International; =head1 NAME Package WebGUI::Form::HTMLArea =head1 DESCRIPTION Creates an HTML Area form control if the user's browser supports it. This basically puts a word processor in the field for them. =head1 SEE ALSO This is a subclass of WebGUI::Form::Textarea. =head1 METHODS The following methods are specifically available from this class. Check the superclass for additional methods. =cut #------------------------------------------------------------------- =head2 definition ( [ additionalTerms ] ) See the super class for additional details. =head3 additionalTerms The following additional parameters have been added via this sub class. =head4 width The width of this control in pixels. Defaults to 500 pixels. =head4 height The height of this control in pixels. Defaults to 400 pixels. =head4 style Style attributes besides width and height which should be specified using the above parameters. Be sure to escape quotes if you use any. =head4 richEditId The ID of the WebGUI::Asset::RichEdit object to load. Defaults to the richEditor setting or "PBrichedit000000000001" if that's not set. =cut sub definition { my $class = shift; my $session = shift; my $definition = shift || []; push(@{$definition}, { height=>{ defaultValue=> 400 }, width=>{ defaultValue=> 500 }, style=>{ defaultValue => undef, }, richEditId=>{ defaultValue=>$session->setting->get("richEditor") || "PBrichedit000000000001" }, }); return $class->SUPER::definition($session, $definition); } #------------------------------------------------------------------- =head2 getDatabaseFieldType ( ) Returns "LONGTEXT". =cut sub getDatabaseFieldType { return "LONGTEXT"; } #------------------------------------------------------------------- =head2 getName ( session ) Returns the human readable name of this control. =cut sub getName { my ($self, $session) = @_; return WebGUI::International->new($session, 'WebGUI')->get('477'); } #------------------------------------------------------------------- =head2 getValue ( [ value ] ) Returns the value of this form field after stipping unwanted tags like . =head3 value An optional value to process, instead of POST input. =cut sub getValue { my $self = shift; return WebGUI::HTML::cleanSegment($self->SUPER::getValue(@_)); } #------------------------------------------------------------------- =head2 getValueAsHtml ( ) Calls getValueAsHtml from WebGUI::Form::Control =cut sub getValueAsHtml { my $self = shift; return $self->WebGUI::Form::Control::getValueAsHtml(@_); } #------------------------------------------------------------------- =head2 headTags ( ) Set the head tags for this form plugin =cut sub headTags { my $self = shift; $self->session->style->setScript($self->session->url->extras('textFix.js'),{ type=>'text/javascript' }); } #------------------------------------------------------------------- =head2 isDynamicCompatible ( ) A class method that returns a boolean indicating whether this control is compatible with the DynamicField control. =cut sub isDynamicCompatible { return 1; } #------------------------------------------------------------------- =head2 toHtml ( ) Renders an HTML area field. =cut sub toHtml { my $self = shift; my $i18n = WebGUI::International->new($self->session); my $richEdit = WebGUI::Asset::RichEdit->new($self->session,$self->get("richEditId")); if (defined $richEdit) { $self->set("extras", $self->get('extras') . q{ onblur="fixChars(this.form['}.$self->get("name").q{'])" mce_editable="true" }); $self->set("resizable", 0); return $self->SUPER::toHtml.$richEdit->getRichEditor($self->get('id')); } else { $self->session->errorHandler->warn($i18n->get('rich editor load error','Form_HTMLArea')); return $self->SUPER::toHtml; } } #------------------------------------------------------------------- =head2 www_pageTree ( session ) Asset picker for the rich editor. =cut sub www_pageTree { my $session = shift; $session->http->setCacheControl("none"); $session->style->setLink($session->url->extras('/tinymce-webgui/plugins/wgpagetree/css/pagetree.css'),{ type=>'text/css', rel=>"stylesheet" }); $session->style->setRawHeadTags(<<"JS"); JS my $i18n = WebGUI::International->new($session); my $output = '

'; my $base = WebGUI::Asset->newByUrl($session) || WebGUI::Asset->getRoot($session); my @crumb; my $ancestorIter = $base->getLineageIterator(["self","ancestors"]); while ( 1 ) { my $ancestor; eval { $ancestor = $ancestorIter->() }; if ( my $x = WebGUI::Error->caught('WebGUI::Error::ObjectNotFound') ) { $session->log->error($x->full_message); next; } last unless $ancestor; push(@crumb,''.$ancestor->get("menuTitle").''); } $output .= '

'.join(" > ", @crumb)."

\n

[' . $i18n->get("select") . '] ' . $child->get("menuTitle") . ''."

'; return $session->style->process($output, 'PBtmpl0000000000000137'); } #------------------------------------------------------------------- =head2 www_imageTree ( session ) Similar to www_pageTree, except it is limited to only display assets of class WebGUI::Asset::File::Image. Each link display a thumbnail of the image via www_viewThumbnail. =cut sub www_imageTree { my $session = shift; $session->http->setCacheControl("none"); $session->style->setLink($session->url->extras('/tinymce-webgui/plugins/wginsertimage/css/insertimage.css'),{ type=>'text/css', rel=>"stylesheet" }); $session->style->setRawHeadTags(<<"JS"); JS my $i18n = WebGUI::International->new($session, 'Operation_FormHelpers'); my $output = '

'; my $base = WebGUI::Asset->newByUrl($session) || WebGUI::Asset->getMedia($session); my @crumb; my $media; my $ancestorIter = $base->getLineageIterator(["self","ancestors"]); while ( 1 ) { my $ancestor; eval { $ancestor = $ancestorIter->() }; if ( my $x = WebGUI::Error->caught('WebGUI::Error::ObjectNotFound') ) { $session->log->error($x->full_message); next; } last unless $ancestor; push(@crumb,''.$ancestor->get("menuTitle").''); if ($ancestor->get('assetId') eq 'PBasset000000000000003') { $media = $ancestor; } } if ($media) { # if in (a subdirectory of) Media, give user the ability to create folders or upload images $output .= '

[ ' . $i18n->get('Create new folder') . ' ] [ ' . $i18n->get('Upload new image').' ]

'; } else { $media = WebGUI::Asset->getMedia($session); # if not in Media, provide a direct link to it $output .= '

[ ' . $media->get('title') . ' ]

'; } $output .= '

'.join(" > ", @crumb)."

\n

'; if ($child->isa('WebGUI::Asset::File::Image')) { $output .= '[' . $i18n->get("select", 'WebGUI') . ']'; } else { $output .= '[' . $i18n->get("select", 'WebGUI') . ']'; } $output .= ' ' . $child->get("menuTitle") . "

'; return $session->style->process($output, 'PBtmpl0000000000000137'); } #------------------------------------------------------------------- =head2 www_viewThumbnail ( session ) Displays a thumbnail of an Image Asset in the Image manager for the Rich Editor. The current URL in the session object is used to determine which Image is used. =cut sub www_viewThumbnail { my $session = shift; $session->http->setCacheControl("none"); $session->style->setLink($session->url->extras('/tinymce-webgui/plugins/wginsertimage/css/insertimage.css'),{ type=>'text/css', rel=>"stylesheet" }); my $image = WebGUI::Asset->newByUrl($session); my $i18n = WebGUI::International->new($session); my $output = '

'; if ($image->isa('WebGUI::Asset::File::Image')) { $output .= '

' . $i18n->get('preview') . '

' . $image->get("filename") . '

'; } else { $output .= '

'; } return $session->style->process($output, 'PBtmpl0000000000000137'); } #------------------------------------------------------------------- =head2 www_addFolder ( session ) Returns a form to add a folder using the rich editor. The purpose of this feature is to provide a very simple way for end-users to create a folder from within the rich editor, in stead of having to leave the rich editor and use the asset manager. A very minimal set of options is supplied, all other options should be derived from the current asset. =cut sub www_addFolder { my $session = shift; $session->http->setCacheControl("none"); my $i18n = WebGUI::International->new($session, 'Operation_FormHelpers'); my $f = WebGUI::HTMLForm->new($session); $f->hidden( name => 'op', value => 'formHelper', ); $f->hidden( name => 'class', value => 'HTMLArea', ); $f->hidden( name => 'sub', value => 'addFolderSave', ); $f->text( label => $i18n->get('Folder name'), name => 'filename', size => 15, ); $f->submit( value => $i18n->get('Create'), ); $f->button( value => $i18n->get('Cancel'), extras => 'onclick="history.go(-1);"', ); my $html = '

'.$i18n->get('Create new folder').'

'.$f->print; return $session->style->process($html, 'PBtmpl0000000000000137'); } #------------------------------------------------------------------- =head2 www_addFolderSave ( session ) Creates a directory under the current asset. The filename should be specified in the form. The Edit and View rights from the current asset are used if not specified in the form. All other properties are copied from the current asset. =cut sub www_addFolderSave { my $session = shift; $session->http->setCacheControl("none"); # get base url my $base = WebGUI::Asset->newByUrl($session) || WebGUI::Asset->getRoot($session); # check if user can edit the current asset return $session->privilege->insufficient('bare') unless $base->canEdit; my $filename = $session->form->process('filename') || 'untitled'; $base->addChild({ # Asset properties title => $filename, menuTitle => $filename, url => $base->getUrl.'/'.$filename, groupIdEdit => $base->get('groupIdEdit'), groupIdView => $base->get('groupIdView'), ownerUserId => $session->user->userId, startDate => $base->get('startDate'), endDate => $base->get('endDate'), encryptPage => $base->get('encryptPage'), isHidden => 1, newWindow => 0, # Asset/Wobject properties displayTitle => 1, cacheTimeout => $base->get('cacheTimeout'), cacheTimeoutVisitor => $base->get('cacheTimeoutVisitor'), styleTemplateId => $base->get('styleTemplateId'), printableStyleTemplateId => $base->get('printableStyleTemplateId'), # Asset/Wobject/Folder properties templateId => 'PBtmpl0000000000000078', # Other properties #assetId => 'new', className => 'WebGUI::Asset::Wobject::Folder', #filename => $filename, }); WebGUI::VersionTag->autoCommitWorkingIfEnabled($session, { allowComments => 0 }); $session->http->setRedirect($base->getUrl('op=formHelper;class=HTMLArea;sub=imageTree')); return undef; } #------------------------------------------------------------------- =head2 www_addImage ( session ) Returns a form to add an image using the rich editor. The purpose of this feature is to provide a very simple way for end-users to upload new images from within the rich editor, in stead of having to leave the rich editor and use the asset manager. A very minimal set of options is supplied, all other options should be derived from the current asset. =cut sub www_addImage { my $session = shift; $session->http->setCacheControl("none"); my $i18n = WebGUI::International->new($session, 'Operation_FormHelpers'); my $f = WebGUI::HTMLForm->new($session); $f->hidden( name => 'op', value => 'formHelper', ); $f->hidden( name => 'class', value => 'HTMLArea', ); $f->hidden( name => 'sub', value => 'addImageSave', ); $f->image( label => $i18n->get('File'), name => 'filename', size => 10, ); $f->submit( value => $i18n->get('Upload'), ); $f->button( value => $i18n->get('Cancel'), extras => 'onclick="history.go(-1);"', ); my $html = '

'.$i18n->get('Upload new image').'

'.$f->print; return $session->style->process($html, 'PBtmpl0000000000000137'); } #------------------------------------------------------------------- =head2 www_addImageSave ( session ) Creates an Image asset under the current asset. The filename should be specified in the form. The Edit and View rights from the current asset are used if not specified in the form. All other properties are copied from the current asset. =cut sub www_addImageSave { my $session = shift; $session->http->setCacheControl("none"); # get base asset my $base = WebGUI::Asset->newByUrl($session) || WebGUI::Asset->getRoot($session); # check if user can edit the current asset return $session->privilege->insufficient('bare') unless $base->canEdit; my $imageForm = WebGUI::Form::Image->new($session,{name => 'filename'}); $imageForm->set('value', $imageForm->getValue); my $imageObj = $imageForm->getStorageLocation; ##This is a hack. It should use the WebGUI::Form::File API to insulate ##us from future form name changes. my $filename = $imageObj->getFiles->[0]; if ($filename) { my $child = $base->addChild({ assetId => 'new', className => 'WebGUI::Asset::File::Image', storageId => $imageObj->getId, filename => $filename, title => $filename, menuTitle => $filename, templateId => 'PBtmpl0000000000000088', groupIdEdit => $session->form->process('groupIdEdit') || $base->get('groupIdEdit'), groupIdView => $session->form->process('groupIdView') || $base->get('groupIdView'), ownerUserId => $session->user->userId, isHidden => 1, }); $child->update({url => $child->fixUrl}); $child->applyConstraints; } WebGUI::VersionTag->autoCommitWorkingIfEnabled($session, { allowComments => 0 }); $session->http->setRedirect($base->getUrl('op=formHelper;class=HTMLArea;sub=imageTree')); return undef; } 1;