373 lines
14 KiB
Perl
373 lines
14 KiB
Perl
|
#
|
||
|
|
# Menu navigation logic
|
||
|
|
#
|
||
|
|
# Authors:
|
||
|
|
# Janine Smith <janine@netrophic.com>
|
||
|
|
# Sophie Hamilton <dw-bugzilla@theblob.org>
|
||
|
|
#
|
||
|
|
# Copyright (c) 2009-2013 by Dreamwidth Studios, LLC.
|
||
|
|
#
|
||
|
|
# This program is free software; you may redistribute it and/or modify it under
|
||
|
|
# the same terms as Perl itself. For a copy of the license, please reference
|
||
|
|
# 'perldoc perlartistic' or 'perldoc perlgpl'.
|
||
|
|
#
|
||
|
|
|
||
|
|
package DW::Logic::MenuNav;
|
||
|
|
|
||
|
|
use strict;
|
||
|
|
use LJ::Lang;
|
||
|
|
|
||
|
|
# name: get_menu_navigation
|
||
|
|
#
|
||
|
|
# des: Returns the menu navigation structure for the site.
|
||
|
|
#
|
||
|
|
# args: (optional) An LJ::User object for which the 'display' fields should be
|
||
|
|
# calculated. Defaults to the remote user.
|
||
|
|
#
|
||
|
|
# returns: an arrayref of top-level menu items, each represented as a hashref
|
||
|
|
# describing the menu as follows:
|
||
|
|
# - name: the short (URL-friendly) name for this menu.
|
||
|
|
# - items: an arrayref of menu items, containing hashrefs
|
||
|
|
# giving the details for each one as follows:
|
||
|
|
# - url: the URL that the link should lead to
|
||
|
|
# - text: the ML name of the string to use for the
|
||
|
|
# anchor
|
||
|
|
# - display: if true, this menu item is applicable
|
||
|
|
# to the given LJ::User object (or
|
||
|
|
# remote if not given), and should be
|
||
|
|
# shown.
|
||
|
|
sub get_menu_navigation {
|
||
|
|
my ( $class, $u ) = @_;
|
||
|
|
|
||
|
|
$u ||= LJ::get_remote();
|
||
|
|
|
||
|
|
my ( $userpic_count, $userpic_max, $inbox_count ) = ( 0, 0, 0 );
|
||
|
|
if ($u) {
|
||
|
|
$userpic_count = $u->get_userpic_count;
|
||
|
|
$userpic_max = $u->userpic_quota;
|
||
|
|
|
||
|
|
my $inbox = $u->notification_inbox;
|
||
|
|
$inbox_count = $inbox->unread_count;
|
||
|
|
}
|
||
|
|
|
||
|
|
# constants for display key
|
||
|
|
my $loggedin = ( defined($u) && $u ) ? 1 : 0;
|
||
|
|
my $loggedin_hasjournal = ( $loggedin && !$u->is_identity ) ? 1 : 0;
|
||
|
|
my $loggedin_canjoincomms =
|
||
|
|
( $loggedin && $u->is_person ) ? 1 : 0; # note the semantic difference
|
||
|
|
my $loggedin_hasnetwork = ( $loggedin && $u->can_use_network_page ) ? 1 : 0;
|
||
|
|
my $loggedin_ispaid = ( $loggedin && $u->is_paid ) ? 1 : 0;
|
||
|
|
my $loggedin_popsubscriptions = ( $loggedin && $u->can_use_popsubscriptions );
|
||
|
|
my $loggedin_person = ( $loggedin && $u->is_person ) ? 1 : 0;
|
||
|
|
my $loggedout = $loggedin ? 0 : 1;
|
||
|
|
my $always = 1;
|
||
|
|
my $never = 0;
|
||
|
|
|
||
|
|
my @nav = (
|
||
|
|
{
|
||
|
|
name => 'create',
|
||
|
|
items => [
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/create",
|
||
|
|
text => "menunav.create.createaccount",
|
||
|
|
display => $loggedout,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/manage/settings/?cat=display",
|
||
|
|
text => "menunav.create.displayprefs",
|
||
|
|
display => $loggedout,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/update",
|
||
|
|
text => "menunav.create.updatejournal",
|
||
|
|
display => $loggedin_hasjournal,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/editjournal",
|
||
|
|
text => "menunav.create.editjournal",
|
||
|
|
display => $loggedin_hasjournal,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/manage/profile/",
|
||
|
|
text => "menunav.create.editprofile",
|
||
|
|
display => $loggedin,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/manage/icons",
|
||
|
|
text => "menunav.create.uploaduserpics",
|
||
|
|
text_opts => { num => $userpic_count, max => $userpic_max },
|
||
|
|
display => $loggedin,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/file/new",
|
||
|
|
text => "menunav.create.uploadimages",
|
||
|
|
display => $loggedin_hasjournal,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/communities/new",
|
||
|
|
text => "menunav.create.createcommunity",
|
||
|
|
display => $loggedin_canjoincomms,
|
||
|
|
},
|
||
|
|
],
|
||
|
|
},
|
||
|
|
{
|
||
|
|
name => 'organize',
|
||
|
|
items => [
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/manage/settings/",
|
||
|
|
text => "menunav.organize.acctsettings",
|
||
|
|
display => $loggedin,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/manage/circle/edit",
|
||
|
|
text => "menunav.organize.managerelationships",
|
||
|
|
display => $loggedin,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/manage/subscriptions/filters",
|
||
|
|
text => "menunav.organize.managefilters",
|
||
|
|
display => $loggedin,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/manage/tags",
|
||
|
|
text => "menunav.organize.managetags",
|
||
|
|
display => $loggedin_hasjournal,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/communities/list",
|
||
|
|
text => "menunav.organize.managecommunities",
|
||
|
|
display => $loggedin_canjoincomms,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/file/edit",
|
||
|
|
text => "menunav.organize.manageimages",
|
||
|
|
display => $loggedin_hasjournal,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/tools/importer",
|
||
|
|
text => "menunav.organize.importcontent",
|
||
|
|
display => $loggedin_hasjournal,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/customize/",
|
||
|
|
text => "menunav.organize.selectjournalstyle",
|
||
|
|
display => $loggedin,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/customize/options",
|
||
|
|
text => "menunav.organize.customizejournalstyle",
|
||
|
|
display => $loggedin,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/beta",
|
||
|
|
text => "menunav.organize.beta",
|
||
|
|
display => $loggedin,
|
||
|
|
},
|
||
|
|
],
|
||
|
|
},
|
||
|
|
{
|
||
|
|
name => 'read',
|
||
|
|
items => [
|
||
|
|
{
|
||
|
|
url => $u ? $u->journal_base . "/read" : "",
|
||
|
|
text => "menunav.read.readinglist",
|
||
|
|
display => $loggedin,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => $u ? $u->profile_url : "",
|
||
|
|
text => "menunav.read.profile",
|
||
|
|
display => $loggedin,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/feeds/",
|
||
|
|
text => "menunav.read.syndicatedfeeds",
|
||
|
|
display => $loggedin,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => $u ? $u->journal_base . "/tag" : "",
|
||
|
|
text => "menunav.read.tags",
|
||
|
|
display => $loggedin_hasjournal,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => $u ? $u->journal_base . "/network" : "",
|
||
|
|
text => "menunav.read.network",
|
||
|
|
display => $loggedin_hasnetwork,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => $u ? $u->journal_base . "/archive" : "",
|
||
|
|
text => "menunav.read.archive",
|
||
|
|
display => $loggedin_hasjournal,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/comments/recent",
|
||
|
|
text => "menunav.read.recentcomments",
|
||
|
|
display => $loggedin,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/inbox/",
|
||
|
|
text => $inbox_count
|
||
|
|
? "menunav.read.inbox.unread2"
|
||
|
|
: "menunav.read.inbox.nounread",
|
||
|
|
text_opts =>
|
||
|
|
{ num => "<span id='Inbox_Unread_Count_Menu'> ($inbox_count)</span>" },
|
||
|
|
display => $loggedin,
|
||
|
|
},
|
||
|
|
],
|
||
|
|
},
|
||
|
|
{
|
||
|
|
name => 'explore',
|
||
|
|
items => [
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/interests",
|
||
|
|
text => "menunav.explore.interests",
|
||
|
|
display => $always,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/directorysearch",
|
||
|
|
text => "menunav.explore.directorysearch",
|
||
|
|
display => $always,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/search",
|
||
|
|
text => "menunav.explore.sitesearch",
|
||
|
|
display => @LJ::SPHINX_SEARCHD ? 1 : 0,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/latest",
|
||
|
|
text => "menunav.explore.latestthings",
|
||
|
|
display => $always,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/random",
|
||
|
|
text => "menunav.explore.randomjournal",
|
||
|
|
display => $always,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/community/random",
|
||
|
|
text => "menunav.explore.randomcommunity",
|
||
|
|
display => $always,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/manage/circle/popsubscriptions",
|
||
|
|
text => "menunav.explore.popsubscriptions",
|
||
|
|
display => $loggedin_popsubscriptions,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SITEROOT/support/faq",
|
||
|
|
text => "menunav.explore.faq",
|
||
|
|
display => $always,
|
||
|
|
},
|
||
|
|
],
|
||
|
|
},
|
||
|
|
{
|
||
|
|
name => 'shop',
|
||
|
|
items => [
|
||
|
|
{
|
||
|
|
url => "$LJ::SHOPROOT",
|
||
|
|
text => "menunav.shop.paidtime2",
|
||
|
|
text_opts => { sitenameshort => $LJ::SITENAMESHORT },
|
||
|
|
display => LJ::is_enabled('payments') ? 1 : 0,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SHOPROOT/history",
|
||
|
|
text => "menunav.shop.history",
|
||
|
|
display => LJ::is_enabled('payments') && $loggedin ? 1 : 0,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SHOPROOT/gifts",
|
||
|
|
text => "menunav.shop.gifts",
|
||
|
|
display => LJ::is_enabled('payments') && $loggedin ? 1 : 0,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SHOPROOT/randomgift",
|
||
|
|
text => "menunav.shop.sponsor",
|
||
|
|
display => LJ::is_enabled('payments') ? 1 : 0,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => "$LJ::SHOPROOT/transferpoints",
|
||
|
|
text => "menunav.shop.transferpoints",
|
||
|
|
display => LJ::is_enabled('payments') && $loggedin_person ? 1 : 0,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
url => $LJ::MERCH_URL,
|
||
|
|
text => "menunav.shop.merchandise",
|
||
|
|
text_opts => { siteabbrev => $LJ::SITENAMEABBREV },
|
||
|
|
display => $LJ::MERCH_URL ? 1 : 0,
|
||
|
|
},
|
||
|
|
],
|
||
|
|
},
|
||
|
|
);
|
||
|
|
|
||
|
|
return \@nav;
|
||
|
|
}
|
||
|
|
|
||
|
|
# name: get_menu_display
|
||
|
|
#
|
||
|
|
# des: Returns the menu navigation structure for the site, but processed for display.
|
||
|
|
#
|
||
|
|
# args: (optional)
|
||
|
|
# $cat A string with a menu category name or array ref of multiple category names,
|
||
|
|
# which will make this function only return menus in the wanted categories.
|
||
|
|
# $u An LJ::User object for which the 'display' fields should be
|
||
|
|
# calculated. Defaults to the remote user.
|
||
|
|
#
|
||
|
|
# returns: an arrayref of top-level menu items, each represented as a hashref
|
||
|
|
# describing the menu as follows:
|
||
|
|
# - name: the short (URL-friendly) name for this menu.
|
||
|
|
# - title: the translated title for this menu
|
||
|
|
# - items: an arrayref of menu items, containing hashrefs
|
||
|
|
# giving the details for each one as follows:
|
||
|
|
# - url: the URL that the link should lead to
|
||
|
|
# - text: the translated text for the link
|
||
|
|
# if there are no menus with items, returns undef
|
||
|
|
sub get_menu_display {
|
||
|
|
my ( $class, $cat, $u ) = @_;
|
||
|
|
|
||
|
|
$u ||= LJ::get_remote();
|
||
|
|
my $menu_nav = DW::Logic::MenuNav->get_menu_navigation($u);
|
||
|
|
|
||
|
|
foreach my $menu (@$menu_nav) {
|
||
|
|
|
||
|
|
# remove menu items not displayed
|
||
|
|
my @display = grep { $_->{display} } @{ $menu->{items} };
|
||
|
|
|
||
|
|
# will use this to filter out empty menus or unrequested menus
|
||
|
|
$menu->{display} = scalar(@display);
|
||
|
|
|
||
|
|
# if we have a cat, only display requested menu(s)
|
||
|
|
if ($cat) {
|
||
|
|
if ( ref($cat) eq 'ARRAY' ) {
|
||
|
|
$menu->{display} = 0 unless ( grep { $_ eq $menu->{name} } @$cat );
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$menu->{display} = 0 unless $menu->{name} eq $cat;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
# only translate and process menus that will be displayed
|
||
|
|
if ( $menu->{display} ) {
|
||
|
|
|
||
|
|
# translate all menu item labels that will be displayed
|
||
|
|
map { $_->{text} = LJ::Lang::ml( $_->{text}, $_->{text_opts} ) } @display;
|
||
|
|
|
||
|
|
# only include the text and url attributes
|
||
|
|
@display = map { { text => $_->{text}, url => $_->{url} } } @display;
|
||
|
|
|
||
|
|
# replace unprocessed menu items with processed ones
|
||
|
|
$menu->{items} = \@display;
|
||
|
|
}
|
||
|
|
|
||
|
|
# translate menu title -- keep the name for people's reference
|
||
|
|
$menu->{title} = LJ::Lang::ml( "menunav." . $menu->{name} );
|
||
|
|
}
|
||
|
|
|
||
|
|
# remove empty menus and only include title, name and item information
|
||
|
|
my @menus = map { { title => $_->{title}, name => $_->{name}, items => $_->{items} } }
|
||
|
|
grep { $_->{display} } @$menu_nav;
|
||
|
|
|
||
|
|
# Return undefined if we don't have any menus to return
|
||
|
|
return scalar(@menus) ? \@menus : undef;
|
||
|
|
}
|
||
|
|
|
||
|
|
1;
|