MenuBuilder.java

/////////////////////////////////////////////////////////////////////////////
//
// Project ProjectForge Community Edition
//         www.projectforge.org
//
// Copyright (C) 2001-2014 Kai Reinhard (k.reinhard@micromata.de)
//
// ProjectForge is dual-licensed.
//
// This community edition is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as published
// by the Free Software Foundation; version 3 of the License.
//
// This community edition is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
// Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, see http://www.gnu.org/licenses/.
//
/////////////////////////////////////////////////////////////////////////////

package org.projectforge.web;

import java.io.Serializable;

import org.apache.wicket.spring.injection.annot.SpringBean;
import org.projectforge.access.AccessChecker;
import org.projectforge.user.PFUserDO;

/**
 * Build of the user's personal menu (depending on the access rights of the user).
 * @author Kai Reinhard (k.reinhard@micromata.de)
 *
 */
public class MenuBuilder implements Serializable
{
  private static final long serialVersionUID = -924049082728488113L;

  @SpringBean(name = "accessChecker")
  private AccessChecker accessChecker;

  public void setAccessChecker(final AccessChecker accessChecker)
  {
    this.accessChecker = accessChecker;
  }

  private final MenuCache menuCache = new MenuCache();

  public void expireMenu(final Integer userId)
  {
    menuCache.removeMenu(userId);
  }

  public void refreshAllMenus()
  {
    menuCache.setExpired();
  }

  private void buildMenuTree(final Menu menu, final PFUserDO user, final boolean mobileMenu)
  {
    if (user == null) {
      return;
    }
    final MenuBuilderContext context = new MenuBuilderContext(menu, user, mobileMenu);
    final MenuItemRegistry registry = MenuItemRegistry.instance();
    for (final MenuItemDef menuItemDef : registry.getMenuItemList()) {
      if (menuItemDef.isVisible(context) == false) {
        // Menu entry isn't visible for the user:
        continue;
      }
      final MenuEntry menuEntry = menuItemDef.createMenuEntry(menu, context);
      if (menuEntry == null) {
        continue;
      }
      // Nothing needed to be done.
    }
  }

  public Menu getMenu(final PFUserDO user)
  {
    return getMenu(user, false);
  }

  public Menu getMobileMenu(final PFUserDO user)
  {
    return getMenu(user, true);
  }

  private Menu getMenu(final PFUserDO user, final boolean mobileMenu)
  {
    Menu menu = null;
    if (user != null) {
      if (mobileMenu == true) {
        menu = menuCache.getMobileMenu(user.getId());
      } else {
        menu = menuCache.getMenu(user.getId());
      }
      if (menu != null) {
        return menu;
      }
    }
    menu = new Menu();
    buildMenuTree(menu, user, mobileMenu);
    if (user != null) {
      if (mobileMenu == true) {
        menuCache.putMobileMenu(user.getId(), menu);
      } else {
        menuCache.putMenu(user.getId(), menu);
      }
    }
    return menu;
  }
}