package WebGUI::Asset::RichEdit; =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 WebGUI::Form; use WebGUI::International; use JSON; use Tie::IxHash; use Moose; use WebGUI::Definition::Asset; extends 'WebGUI::Asset'; define assetName => ['assetName', 'Asset_RichEdit']; define icon => 'richEdit.gif'; define tableName => 'RichEdit'; property disableRichEditor => ( fieldType => 'yesNo', default => 0, label => ['disable rich edit', 'Asset_RichEdit'], hoverHelp => ['disable rich edit description', 'Asset_RichEdit'], ); property askAboutRichEdit => ( fieldType => 'yesNo', default => 0, label => ['using rich edit', 'Asset_RichEdit'], hoverHelp => ['using rich edit description', 'Asset_RichEdit'], ); property validElements => ( fieldType => 'textarea', default => 'a[name|href|target|title|onclick],img[class|src|border=0|alt|title|hspace|vspace|width|height|align|onmouseover|onmouseout|name],hr[class|width|size|noshade],font[face|size|color|style],span[class|align|style]', label => ['elements', 'Asset_RichEdit'], hoverHelp => ['elements description', 'Asset_RichEdit'], subtext => ['elements subtext', 'Asset_RichEdit'], uiLevel => 9, ); property preformatted => ( fieldType => 'yesNo', default => 0, label => ['preformatted', 'Asset_RichEdit'], hoverHelp => ['preformatted description', 'Asset_RichEdit'], uiLevel => 9, ); property editorWidth => ( fieldType => 'integer', default => 0, label => ['editor width', 'Asset_RichEdit'], hoverHelp => ['editor width description', 'Asset_RichEdit'], uiLevel => 9, ); property editorHeight => ( fieldType => 'integer', default => 0, label => ['editor height', 'Asset_RichEdit'], hoverHelp => ['editor height description', 'Asset_RichEdit'], uiLevel => 9, ); property sourceEditorWidth => ( fieldType => 'integer', default => 0, label => ['source editor height', 'Asset_RichEdit'], hoverHelp => ['source editor height description', 'Asset_RichEdit'], ); property sourceEditorHeight => ( fieldType => 'integer', default => 0, label => ['source editor height', 'Asset_RichEdit'], hoverHelp => ['source editor height description', 'Asset_RichEdit'], ); property useBr => ( fieldType => 'yesNo', default => 0, label => ['use br', 'Asset_RichEdit'], hoverHelp => ['use br description', 'Asset_RichEdit'], uiLevel => 9, ); property removeLineBreaks => ( fieldType => 'yesNo', default => 0, label => ['remove line breaks', 'Asset_RichEdit'], hoverHelp => ['remove line breaks description', 'Asset_RichEdit'], uiLevel => 9, ); property nowrap => ( fieldType => 'yesNo', default => 0, label => ['no wrap', 'Asset_RichEdit'], hoverHelp => ['no wrap description', 'Asset_RichEdit'], uiLevel => 9, ); property directionality => ( fieldType => 'selectBox', default => 'ltr', label => ['directionality', 'Asset_RichEdit'], hoverHelp => ['directionality description', 'Asset_RichEdit'], options => \&_directionality_options, ); sub _directionality_options { my $session = shift->session; my $i18n = WebGUI::International->new($session, 'Asset_RichEdit'); return { ltr=>$i18n->get('left to right'), rtl=>$i18n->get('right to left'), }; } property toolbarLocation => ( fieldType => 'selectBox', default => 'bottom', label => ['toolbar location', 'Asset_RichEdit'], hoverHelp => ['toolbar location description', 'Asset_RichEdit'], options => \&_toolbarLocation_options, ); sub _toolbarLocation_options { my $session = shift->session; my $i18n = WebGUI::International->new($session, 'Asset_RichEdit'); return { top => $i18n->get('top'), bottom => $i18n->get('bottom'), }; } property cssFile => ( fieldType => 'text', default => undef, label => ['css file', 'Asset_RichEdit'], hoverHelp => ['css file description', 'Asset_RichEdit'], ); property toolbarRow1 => ( fieldType => 'checkList', default => undef, label => '', ); property toolbarRow2 => ( fieldType => 'checkList', default => undef, label => '', ); property toolbarRow3 => ( fieldType => 'checkList', default => undef, label => '', ); property enableContextMenu => ( fieldType => "yesNo", default => 0, label => ['enable context menu', 'Asset_RichEdit'], hoverHelp => ['enable context menu description', 'Asset_RichEdit'], ); property inlinePopups => ( fieldType => "yesNo", default => 0, label => ['inline popups', 'Asset_RichEdit'], hoverHelp => ['inline popups description', 'Asset_RichEdit'], ); property allowMedia => ( fieldType => "yesNo", default => 0, label => ['editForm allowMedia label', 'Asset_RichEdit'], hoverHelp => ['editForm allowMedia description', 'Asset_RichEdit'], ); has '+uiLevel' => ( default => 5, ); =head1 NAME Package WebGUI::Asset::RichEdit =head1 DESCRIPTION A configuration for rich editor. =head1 SYNOPSIS use WebGUI::Asset::RichEdit; =head1 METHODS These methods are available from this class: =cut #------------------------------------------------------------------- =head2 getEditForm ( ) Returns the TabForm object that will be used in generating the edit page for this asset. =cut override getEditForm => sub { my $self = shift; my $f = super(); my $i18n = WebGUI::International->new($self->session,'Asset_RichEdit'); my %buttons; tie %buttons, "Tie::IxHash"; %buttons = ( 'formatselect' => $i18n->get('formatselect'), 'styleselect' => $i18n->get('styleselect'), 'fontselect' => $i18n->get('fontselect'), 'fontsizeselect' => $i18n->get('fontsizeselect'), 'bold' => $i18n->get('bold'), 'italic' => $i18n->get('italic'), 'underline' => $i18n->get('underline'), 'strikethrough' => $i18n->get('strikethrough'), 'sub' => $i18n->get('sub'), 'sup' => $i18n->get('sup'), 'justifyleft' => $i18n->get('justifyleft'), 'justifycenter' => $i18n->get('justifycenter'), 'justifyright' => $i18n->get('justifyright'), 'numlist' => $i18n->get('numlist'), 'outdent' => $i18n->get('outdent'), 'indent' => $i18n->get('indent'), 'forecolor' => $i18n->get('forecolor'), 'backcolor' => $i18n->get('backcolor'), 'link' => $i18n->get('link'), 'unlink' => $i18n->get('unlink'), 'wgpagetree' => $i18n->get('pagetree'), 'image' => $i18n->get('image'), 'wginsertimage' => $i18n->get('insertImage'), 'media' => $i18n->get('media'), 'emotions' => $i18n->get('emotions'), 'wgmacro' => $i18n->get('collateral'), 'hr' => $i18n->get('hr'), 'advhr' => $i18n->get('advhr'), 'inserttime' => $i18n->get('inserttime'), 'insertdate' => $i18n->get('insertdate'), 'anchor' => $i18n->get('anchor'), 'tablecontrols' => $i18n->get('tablecontrols'), 'visualaid' => $i18n->get('visualaid'), 'charmap' => $i18n->get('charmap'), 'search' => $i18n->get('search'), 'replace' => $i18n->get('replace'), 'cut' => $i18n->get('cut'), 'copy' => $i18n->get('Copy'), 'paste' => $i18n->get('paste'), 'undo' => $i18n->get('undo'), 'redo' => $i18n->get('redo'), 'pastetext' => $i18n->get('pastetext'), 'pasteword' => $i18n->get('pasteword'), 'removeformat' => $i18n->get('removeformat'), 'cleanup' => $i18n->get('cleanup'), 'iespell' => $i18n->get('iespell'), 'save' => $i18n->get('save'), 'preview' => $i18n->get('preview'), 'print' => $i18n->get('print'), 'spellchecker' => $i18n->get('Server Side Spell Checker'), 'code' => $i18n->get('code'), 'fullscreen' => $i18n->get('fullscreen'), 'help' => $i18n->get('help'), # 'advlink' => "Advanced Link", # 'spacer' => "Toolbar Spacer", # 'separator' => "Toolbar Separator", # 'rowseparator' => "Toolbar Row Separator", # 'advimage' => "Advanced Image", ); my $buttonGrid = sprintf qq!!, $i18n->get('button'), $i18n->get('row 1'), $i18n->get('row 2'), $i18n->get('row 3'); my @toolbarRow1 = split("\n",$self->toolbarRow1); my @toolbarRow2 = split("\n",$self->toolbarRow2); my @toolbarRow3 = split("\n",$self->toolbarRow3); my $evenOddToggle = 0; foreach my $key (keys %buttons) { $evenOddToggle = $evenOddToggle ? 0 : 1; my $checked1 = $key ~~ @toolbarRow1; my $checked2 = $key ~~ @toolbarRow2; my $checked3 = $key ~~ @toolbarRow3; $buttonGrid .= ' '; } $buttonGrid .= "
%s %s %s %s
'.$buttons{$key}.' '.WebGUI::Form::checkbox($self->session, { value=>$key, name=>"toolbarRow1", checked=>$checked1 }).' '.WebGUI::Form::checkbox($self->session, { value=>$key, name=>"toolbarRow2", checked=>$checked2 }).' '.WebGUI::Form::checkbox($self->session, { value=>$key, name=>"toolbarRow3", checked=>$checked3 }).''; if ($key eq 'spellchecker' && !($self->session->config->get('availableDictionaries'))) { $buttonGrid .= $i18n->get('no dictionaries'); } $buttonGrid .= '
"; my $tab = $f->addTab(name => "buttons", label => $i18n->get("buttons") ); $tab->addField( "ReadOnly", label => $i18n->get('toolbar buttons'), hoverHelp => $i18n->get('toolbar buttons description'), value => $buttonGrid, ); return $f; }; #------------------------------------------------------------------- =head2 getList ( ) Returns a list of all available richEditors, considering revisionDate and asset status NOTE: This is a class method. =cut sub getList { my $class = shift; my $session = shift; my $sql = "select asset.assetId, assetData.revisionDate from RichEdit left join asset on asset.assetId=RichEdit.assetId left join assetData on assetData.revisionDate=RichEdit.revisionDate and assetData.assetId=RichEdit.assetId where asset.state='published' and assetData.revisionDate=(SELECT max(revisionDate) from assetData where assetData.assetId=asset.assetId and (assetData.status='approved' or assetData.tagId=?)) order by assetData.title"; my $sth = $session->db->read($sql, [ $session->scratch->get('versionTag') ] ); my %richEditors; tie %richEditors, 'Tie::IxHash'; while (my ($id, $version) = $sth->array) { $richEditors{$id} = WebGUI::Asset::RichEdit->newById($session, $id, $version)->getTitle; } $sth->finish; return \%richEditors; } #------------------------------------------------------------------- =head2 getToolbar ( ) Returns a toolbar with a set of icons that hyperlink to functions that delete, edit, promote, demote, cut, and copy. =cut override getToolbar => sub { my $self = shift; return undef if ($self->getToolbarState); return super(); }; #------------------------------------------------------------------- =head2 getRichEditor ( $nameId ) Return the javascript needed to make the Rich Editor. =head3 $nameId The id for the rich editor, should be unique enough to be used as the id parameter for a HTML tag. =cut sub getRichEditor { my $self = shift; return '' if ($self->disableRichEditor); my $nameId = shift; my @plugins; my %loadPlugins; push @plugins, "safari"; push @plugins, "contextmenu" if $self->enableContextMenu; push @plugins, "inlinepopups" if $self->inlinePopups; push @plugins, "media" if $self->allowMedia; my @toolbarRows = map{[split "\n", $self->get("toolbarRow$_")]} (1..3); my @toolbarButtons = map{ @{$_} } @toolbarRows; my $i18n = WebGUI::International->new($self->session, 'Asset_RichEdit'); my $ask = $self->askAboutRichEdit; my %config = ( mode => $ask ? "none" : "exact", elements => $nameId, theme => "advanced", relative_urls => JSON::false(), remove_script_host => JSON::true(), auto_reset_designmode => JSON::true(), cleanup_callback => "tinyMCE_WebGUI_Cleanup", urlconverter_callback => "tinyMCE_WebGUI_URLConvertor", theme_advanced_resizing => JSON::true(), (map { "theme_advanced_buttons".($_+1) => (join ',', @{$toolbarRows[$_]}) } (0..$#toolbarRows)), #ask => $self->getValue("askAboutRichEdit") ? JSON::true() : JSON::false(), ask => JSON::false(), preformatted => $self->preformatted ? JSON::true() : JSON::false(), force_br_newlines => $self->useBr ? JSON::true() : JSON::false(), force_p_newlines => $self->useBr ? JSON::false() : JSON::true(), $self->useBr ? ( forced_root_block => JSON::false() ) : (), remove_linebreaks => $self->removeLineBreaks ? JSON::true() : JSON::false(), nowrap => $self->nowrap ? JSON::true() : JSON::false(), directionality => $self->directionality, theme_advanced_toolbar_location => $self->toolbarLocation, theme_advanced_statusbar_location => "bottom", valid_elements => $self->validElements, wg_userIsVisitor => $self->session->user->isVisitor ? JSON::true() : JSON::false(), ); # if ($ask) { # $config{oninit} = 'turnOffTinyMCE_'.$nameId; # } foreach my $button (@toolbarButtons) { if ($button eq "spellchecker" && $self->session->config->get('availableDictionaries')) { push(@plugins,"-wgspellchecker"); $loadPlugins{wgspellchecker} = $self->session->url->extras("tinymce-webgui/plugins/wgspellchecker/editor_plugin.js"); $config{spellchecker_rpc_url} = $self->session->url->gateway('', "op=spellCheck"); $config{spellchecker_languages} = join(',', map { ($_->{default} ? '+' : '').$_->{name}.'='.$_->{id} } @{$self->session->config->get('availableDictionaries')}); } push(@plugins,"table") if ($button eq "tablecontrols"); push(@plugins,"save") if ($button eq "save"); push(@plugins,"advhr") if ($button eq "advhr"); push(@plugins,"fullscreen") if ($button eq "fullscreen"); if ($button eq "advimage") { push(@plugins,"advimage"); $config{external_link_list_url} = ""; } if ($button eq "advlink") { $config{external_image_list_url} = ""; $config{file_browser_callback} = "mcFileManager.filebrowserCallBack"; push(@plugins,"advlink"); } push(@plugins,"emotions") if ($button eq "emotions"); push(@plugins,"iespell") if ($button eq "iespell"); $config{gecko_spellcheck} = 'true' if ($button eq "iespell"); if ($button eq "paste" || $button eq "pastetext" || $button eq "pasteword") { push(@plugins,"paste"); } if ($button eq "insertdate" || $button eq "inserttime" || $button eq "insertdatetime") { $config{plugin_insertdate_dateFormat} = "%Y-%m-%d"; $config{plugin_insertdate_timeFormat} = "%H:%M:%S"; push(@plugins,"insertdatetime"); } push(@plugins,"preview") if ($button eq "preview"); if ($button eq "media") { push(@plugins,"media"); } push(@plugins,"searchreplace") if ($button eq "search" || $button eq "replace" || $button eq "searchreplace"); push(@plugins,"print") if ($button eq "print"); if ($button eq "wginsertimage") { push @plugins, "-wginsertimage"; $loadPlugins{wginsertimage} = $self->session->url->extras("tinymce-webgui/plugins/wginsertimage/editor_plugin.js"); } if ($button eq "wgpagetree") { push @plugins, "-wgpagetree"; $loadPlugins{wgpagetree} = $self->session->url->extras("tinymce-webgui/plugins/wgpagetree/editor_plugin.js"); } if ($button eq "wgmacro") { push @plugins, "-wgmacro"; $loadPlugins{wgmacro} = $self->session->url->extras("tinymce-webgui/plugins/wgmacro/editor_plugin.js"); } if ($button eq "code") { $config{theme_advanced_source_editor_width} = $self->sourceEditorWidth if ($self->sourceEditorWidth > 0); $config{theme_advanced_source_editor_height} = $self->sourceEditorHeight if ($self->sourceEditorHeight > 0); } } my $language = $i18n->getLanguage('' ,"languageAbbreviation"); unless ($language) { $language = $i18n->getLanguage("English","languageAbbreviation"); } $config{language} = $language; $config{content_css} = $self->cssFile || $self->session->url->extras('tinymce-webgui/defaultcontent.css'); $config{width} = $self->editorWidth || "100%"; $config{height} = $self->editorHeight || "100%"; $config{plugins} = join(",",@plugins); $self->session->style->setScript($self->session->url->extras('yui/build/yahoo/yahoo-min.js')); $self->session->style->setScript($self->session->url->extras('yui/build/event/event-min.js')); $self->session->style->setScript($self->session->url->extras('tinymce/jscripts/tiny_mce/tiny_mce_src.js')); $self->session->style->setScript($self->session->url->extras("tinymce-webgui/callbacks.js")); my $out = ''; if ($ask) { $out = q||.$i18n->get('Toggle editor').q||; } $out .= qq|"; } #------------------------------------------------------------------- =head2 indexContent ( ) Making private. See WebGUI::Asset::indexContent() for additonal details. =cut around indexContent => sub { my $orig = shift; my $self = shift; my $indexer = $self->$orig(@_); $indexer->setIsPublic(0); }; #------------------------------------------------------------------- =head2 www_edit ( ) Override the method from Asset.pm to change the title of the screen. =cut sub www_edit { my $self = shift; return $self->session->privilege->insufficient() unless $self->canEdit; return $self->session->privilege->locked() unless $self->canEditIfLocked; my $i18n = WebGUI::International->new($self->session,"Asset_RichEdit"); return $self->getAdminConsole->render($self->getEditForm->print,$i18n->get("rich edit edit config")); } __PACKAGE__->meta->make_immutable; 1;