diff --git a/docs/changelog/6.x.x.txt b/docs/changelog/6.x.x.txt index 96e0f388c..f12ea36ec 100644 --- a/docs/changelog/6.x.x.txt +++ b/docs/changelog/6.x.x.txt @@ -34,6 +34,7 @@ - Added an end point to limit ancestors in navigation. - Added missing international entries for Navigation. - fix [1177858] lib/WebGUI/i18n/English/Macros.pm can not translated + - Added the notion of utility assets and moved the Template asset into it. diff --git a/etc/WebGUI.conf.original b/etc/WebGUI.conf.original index ea3325700..374afb87f 100644 --- a/etc/WebGUI.conf.original +++ b/etc/WebGUI.conf.original @@ -106,7 +106,6 @@ paymentPlugins = ITransact assets = WebGUI::Asset::File::Image, \ WebGUI::Asset::File, \ WebGUI::Asset::Snippet, \ - WebGUI::Asset::Template, \ WebGUI::Asset::Redirect, \ WebGUI::Asset::FilePile, \ WebGUI::Asset::Wobject::Article, \ @@ -132,6 +131,18 @@ assets = WebGUI::Asset::File::Image, \ assetContainers = WebGUI::Asset::Wobject::Layout, \ WebGUI::Asset::Wobject::Folder +# Specify the list assets that are used for utility purposes only +# and are not typically used as a normal part of content +# management. + +utilityAssets => WebGUI::Asset::Template + +# Optionally specify a group id for assets to tell WebGUI what +# group a user needs to be part of in order to add that type of +# asset. + +#assetAddPrivilege = WebGUI::Asset::Wobject::SQLReport => 3, \ +# WebGUI:::Asset::Template => 4 # If exportPath is defined, an "Export" toolbar icon will appear # which allows you to export assets to static html. This folder diff --git a/lib/WebGUI/Asset.pm b/lib/WebGUI/Asset.pm index 157bac9f4..85a1b50d4 100644 --- a/lib/WebGUI/Asset.pm +++ b/lib/WebGUI/Asset.pm @@ -65,9 +65,9 @@ A lineage is a concatenated series of sequence numbers, each six digits long, th $html= WebGUI::Asset->exportAsHtml(\%params); $string= WebGUI::Asset->fixUrl("Title of Page"); $string= WebGUI::Asset->formatRank(1); - $hashref= WebGUI::Asset->get("title"); + $hashref= WebGUI::Asset->get(); $AdminConsoleObject= WebGUI::Asset->getAdminConsole(); - $arrayRef= WebGUI::Asset->getAssetAdderLinks($string, $boolean); + $arrayRef= WebGUI::Asset->getAssetAdderLinks($string); $JavaScript= WebGUI::Asset->getAssetManagerControl(\%hashref, $string, $bool); $arrayRef= WebGUI::Asset->getAssetsInClipboard($boolean, $string); $arrayRef= WebGUI::Asset->getAssetsInTrash($boolean, $string); @@ -187,6 +187,32 @@ sub addChild { return $newAsset; } + +#------------------------------------------------------------------- + +=head2 canAdd ( [userId, groupId] ) + +Verifies that the user has the privileges necessary to add this type of asset. Return a boolean. + +=head3 userId + +Unique hash identifier for a user. If not supplied, current user. + +=head3 groupId + +Only developers extending this method should use this parameter. By default WebGUI will check groups in this order, whichever is defined: Group id assigned in the config file for each asset. Group assigned by the developer in the asset itself if s/he extended this method to do so. The "turn admin on" group which is group id 12. + +=cut + +sub canAdd { + my $self = shift; + my $userId = shift || $session{user}{userId}; + my $className = $self->definition->[0]->{className}; + my $groupId = $session{config}{assetAddPrivilege}{$className} || shift || '12'; + return WebGUI::Grouping::isInGroup($groupId,$userId); +} + + #------------------------------------------------------------------- =head2 canEdit ( [userId] ) @@ -207,6 +233,8 @@ sub canEdit { } return WebGUI::Grouping::isInGroup($self->get("groupIdEdit"),$userId); } + + #------------------------------------------------------------------- =head2 canView ( [userId] ) @@ -671,7 +699,7 @@ sub getAdminConsole { #------------------------------------------------------------------- -=head2 getAssetAdderLinks ( [addToUrl, getContainerLinks] ) +=head2 getAssetAdderLinks ( [addToUrl, type] ) Returns an arrayref that contains a label (name of the class of Asset) and url (url link to function to add the class). @@ -679,18 +707,16 @@ Returns an arrayref that contains a label (name of the class of Asset) and url ( Any text to append to the getAssetAdderLinks URL. Usually name/variable pairs to pass in the url. If addToURL is specified, the character "&" and the text in addToUrl is appended to the returned url. -=head3 getContainerLinks +=head3 type -A boolean indicating whether to return asset container links or regular asset links. +A string indicating which type of adders to return. Defaults to "assets". Choose from "assets", "assetContainers", or "utilityAssets". =cut sub getAssetAdderLinks { my $self = shift; my $addToUrl = shift; - my $getContainerLinks = shift; - my $type = "assets"; - $type = "assetContainers" if ($getContainerLinks); + my $type = shift || "assets"; my %links; foreach my $class (@{$session{config}{$type}}) { my $load = "use ".$class; @@ -727,11 +753,11 @@ sub getAssetAdderLinks { my $asset = WebGUI::Asset->newByDynamicClass($id,$class); my $url = $self->getUrl("func=add&class=".$class."&prototype=".$id); $url = WebGUI::URL::append($url,$addToUrl) if ($addToUrl); - $links{$asset->get("title")}{url} = $url; - $links{$asset->get("title")}{icon} = $asset->getIcon; - $links{$asset->get("title")}{'icon.small'} = $asset->getIcon(1); - $links{$asset->get("title")}{'isPrototype'} = 1; - $links{$asset->get("title")}{'asset'} = $asset; + $links{$asset->getTitle}{url} = $url; + $links{$asset->getTitle}{icon} = $asset->getIcon; + $links{$asset->getTitle}{'icon.small'} = $asset->getIcon(1); + $links{$asset->getTitle}{'isPrototype'} = 1; + $links{$asset->getTitle}{'asset'} = $asset; } my @sortedLinks; foreach my $label (sort keys %links) { @@ -794,7 +820,7 @@ sub getAssetManagerControl { my $ancestors = $self->getLineage(["self","ancestors"],{returnQuickReadObjects=>1}); my @dataArray; foreach my $ancestor (@{$ancestors}) { - my $title = $ancestor->get("title"); + my $title = $ancestor->getTitle; $title =~ s/\'/\\\'/g; push(@dataArray,"['".$ancestor->getId."','".$ancestor->getUrl."','".$title."']\n"); } @@ -804,7 +830,7 @@ sub getAssetManagerControl { $output .= "/*rank, title, type, lastUpdate, size, url, assetId, icon */\nvar assets = [\n"; @dataArray = (); foreach my $child (@{$children}) { - my $title = $child->get("title"); + my $title = $child->getTitle; $title =~ s/\'/\\\'/g; push(@dataArray, '['.$child->getRank.",'".$title."','".$child->getName."','".WebGUI::DateTime::epochToHuman($child->get("lastUpdated"))."','".formatBytes($child->get("assetSize"))."','".$child->getUrl."','".$child->getId."','".$child->getIcon(1)."']\n"); #my $hasChildren = "false"; @@ -1407,6 +1433,24 @@ sub getLineageLength { return length($self->get("lineage"))/6; } + +#------------------------------------------------------------------- + +=head2 getMenuTitle ( ) + +Returns the menu title of this asset. If it's not specified or it's "Untitled" then the asset's name will be returned instead. + +=cut + +sub getMenuTitle { + my $self = shift; + if ($self->get("menuTitle") eq "" || lc($self->get("menuTitle")) eq "untitled") { + return $self->getName; + } + return $self->get("menuTitle"); +} + + #------------------------------------------------------------------- =head2 getMetaDataFields ( [fieldId] ) @@ -1573,6 +1617,23 @@ sub getRoot { } +#------------------------------------------------------------------- + +=head2 getTitle ( ) + +Returns the title of this asset. If it's not specified or it's "Untitled" then the asset's name will be returned instead. + +=cut + +sub getTitle { + my $self = shift; + if ($self->get("title") eq "" || lc($self->get("title")) eq "untitled") { + return $self->getName; + } + return $self->get("title"); +} + + #------------------------------------------------------------------- =head2 getToolbar ( ) @@ -1589,8 +1650,6 @@ sub getToolbar { .moveDownIcon('func=demote',$self->get("url")) .cutIcon('func=cut',$self->get("url")) .copyIcon('func=copy',$self->get("url")); - # .moveTopIcon('func=moveTop&wid='.${$wobject}{wobjectId}) - # .moveBottomIcon('func=moveBottom&wid='.${$wobject}{wobjectId}) $toolbar .= shortcutIcon('func=createShortcut',$self->get("url")) unless ($self->get("className") =~ /Shortcut/); return ''.$self->getName.''.$toolbar; } @@ -2338,6 +2397,7 @@ Adds a new Asset based upon the class of the current form. Returns the Asset cal sub www_add { my $self = shift; + return WebGUI::Privilege::insufficient() unless ($self->canAdd); my %prototypeProperties; if ($session{form}{'prototype'}) { my $prototype = WebGUI::Asset->newByDynamicClass($session{form}{'prototype'},$session{form}{class}); @@ -2380,7 +2440,7 @@ sub www_copy { my $self = shift; return WebGUI::Privilege::insufficient() unless $self->canEdit; my $newAsset = $self->duplicate; - $newAsset->update({ title=>$newAsset->get("title").' (copy)'}); + $newAsset->update({ title=>$newAsset->getTitle.' (copy)'}); $newAsset->cut; return $self->getContainer->www_view; } @@ -2400,7 +2460,7 @@ sub www_copyList { my $asset = WebGUI::Asset->newByDynamicClass($assetId); if ($asset->canEdit) { my $newAsset = $asset->duplicate; - $newAsset->update({ title=>$newAsset->get("title").' (copy)'}); + $newAsset->update({ title=>$newAsset->getTitle.' (copy)'}); $newAsset->cut; } } @@ -2418,8 +2478,8 @@ sub www_createShortcut () { my $child = $self->addChild({ className=>'WebGUI::Asset::Shortcut', shortcutToAssetId=>$self->getId, - title=>$self->get("title"), - menuTitle=>$self->get("menuTitle"), + title=>$self->getTitle, + menuTitle=>$self->getMenuTitle, isHidden=>$self->get("isHidden"), newWindow=>$self->get("newWindow"), startDate=>$self->get("startDate"), @@ -3112,19 +3172,26 @@ sub www_manageAssets {  
'.WebGUI::International::get(1083,"Asset").''; - foreach my $link (@{$self->getAssetAdderLinks("proceed=manageAssets",1)}) { + foreach my $link (@{$self->getAssetAdderLinks("proceed=manageAssets","assetContainers")}) { $output .= ''.$link->{label}.' '.$link->{label}.' '; $output .= editIcon("func=edit&proceed=manageAssets",$link->{asset}->get("url")) if ($link->{isPrototype}); $output .= '
'; } - $output .= '
'; + $output .= '
'; foreach my $link (@{$self->getAssetAdderLinks("proceed=manageAssets")}) { $output .= ''.$link->{label}.' '.$link->{label}.' '; $output .= editIcon("func=edit&proceed=manageAssets",$link->{asset}->get("url")) if ($link->{isPrototype}); $output .= '
'; } + $output .= '
'; + foreach my $link (@{$self->getAssetAdderLinks("proceed=manageAssets","utilityAssets")}) { + $output .= ''.$link->{label}.' + '.$link->{label}.' '; + $output .= editIcon("func=edit&proceed=manageAssets",$link->{asset}->get("url")) if ($link->{isPrototype}); + $output .= '
'; + } $output .= '
'; my %options; tie %options, 'Tie::IxHash'; diff --git a/lib/WebGUI/Asset/Wobject/Navigation.pm b/lib/WebGUI/Asset/Wobject/Navigation.pm index fa7dc47a7..670551e8e 100644 --- a/lib/WebGUI/Asset/Wobject/Navigation.pm +++ b/lib/WebGUI/Asset/Wobject/Navigation.pm @@ -328,10 +328,12 @@ sub view { $rules{ancestorLimit} = $self->get("ancestorEndPoint"); my $assets = $start->getLineage(\@includedRelationships,\%rules); my $var = {'page_loop' => []}; - my @interestingProperties = ('assetId', 'parentId', 'title', 'ownerUserId', 'synopsis', 'newWindow', 'menuTitle'); + my @interestingProperties = ('assetId', 'parentId', 'ownerUserId', 'synopsis', 'newWindow'); foreach my $property (@interestingProperties) { $var->{'currentPage.'.$property} = $current->get($property); } + $var->{'currentPage.menuTitle'} = $current->getMenuTitle; + $var->{'currentPage.title'} = $current->getTitle; $var->{'currentPage.isHome'} = ($current->getId eq $session{setting}{defaultPage}); $var->{'currentPage.url'} = $current->getUrl; $var->{'currentPage.hasChild'} = $current->hasChildren; @@ -358,6 +360,8 @@ sub view { foreach my $property (@interestingProperties) { $pageData->{"page.".$property} = $asset->get($property); } + $pageData->{'page.menuTitle'} = $asset->getMenuTitle; + $pageData->{'page.title'} = $asset->getTitle; # build nav variables $pageData->{"page.rank"} = $asset->getRank; $pageData->{"page.absDepth"} = $asset->getLineageLength; @@ -412,6 +416,8 @@ sub view { foreach my $property (@interestingProperties) { $pageData->{"page.parent.".$property} = $parent->get($property); } + $pageData->{'page.parent.menuTitle'} = $parent->getMenuTitle; + $pageData->{'page.parent.title'} = $parent->getTitle; $pageData->{"page.parent.url"} = $parent->getUrl; # these next two variables can be very inefficient, consider getting rid of them my $parentsFirstChild = $parent->getFirstChild; diff --git a/lib/WebGUI/Config.pm b/lib/WebGUI/Config.pm index f461d3071..caf1af364 100644 --- a/lib/WebGUI/Config.pm +++ b/lib/WebGUI/Config.pm @@ -150,6 +150,9 @@ sub readConfig { foreach my $key ($config->directives) { $data{$key} = $config->get($key); } + if (ref $data{assetAddPrivilege} ne "ARRAY") { + $data{assetAddPrivilege} = [$data{assetAddPrivilege}]; + } if (ref $data{authMethods} ne "ARRAY") { $data{authMethods} = [$data{authMethods}]; } diff --git a/lib/WebGUI/Macro/AdminBar.pm b/lib/WebGUI/Macro/AdminBar.pm index cf383e09c..34ad2af59 100644 --- a/lib/WebGUI/Macro/AdminBar.pm +++ b/lib/WebGUI/Macro/AdminBar.pm @@ -51,7 +51,7 @@ sub process { }); } $var{contentTypes_loop} = $session{asset}->getAssetAdderLinks; - $var{container_loop} = $session{asset}->getAssetAdderLinks(undef,1); + $var{container_loop} = $session{asset}->getAssetAdderLinks(undef,"assetContainers"); foreach my $item (@{$session{asset}->getAssetsInClipboard(1)}) { my $title = $item->{title}; $title =~ s/'//g; # stops it from breaking the javascript menus