/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* For further information about Alkacon Software GmbH, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.workplace.tools.cache;
import org.opencms.file.CmsObject;
import org.opencms.flex.CmsFlexCache;
import org.opencms.flex.CmsFlexController;
import org.opencms.jsp.CmsJspActionElement;
import org.opencms.main.CmsRuntimeException;
import org.opencms.workplace.list.A_CmsListDialog;
import org.opencms.workplace.list.CmsListColumnAlignEnum;
import org.opencms.workplace.list.CmsListColumnDefinition;
import org.opencms.workplace.list.CmsListDirectAction;
import org.opencms.workplace.list.CmsListItem;
import org.opencms.workplace.list.CmsListItemDetails;
import org.opencms.workplace.list.CmsListItemDetailsFormatter;
import org.opencms.workplace.list.CmsListMetadata;
import org.opencms.workplace.list.CmsListOrderEnum;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.jsp.PageContext;
/**
* Flex Cache content view.<p>
*
* @since 7.0.5
*/
public class CmsFlexCacheList extends A_CmsListDialog {
/** list action id constant. */
public static final String LIST_ACTION_ICON = "ai";
/** list column id constant. */
public static final String LIST_COLUMN_ICON = "ci";
/** list column id constant. */
public static final String LIST_COLUMN_KEY = "ck";
/** list column id constant. */
public static final String LIST_COLUMN_PROJECT = "cp";
/** list column id constant. */
public static final String LIST_COLUMN_RESOURCE = "cr";
/** list item detail id constant. */
public static final String LIST_DETAIL_VARIATIONS = "dv";
/** list id constant. */
public static final String LIST_ID = "lfc";
/**
* Public constructor.<p>
*
* @param jsp an initialized JSP action element
*/
public CmsFlexCacheList(CmsJspActionElement jsp) {
super(
jsp,
LIST_ID,
Messages.get().container(Messages.GUI_FLEXCACHE_LIST_NAME_0),
LIST_COLUMN_RESOURCE,
CmsListOrderEnum.ORDER_ASCENDING,
LIST_COLUMN_RESOURCE);
}
/**
* Public constructor with JSP variables.<p>
*
* @param context the JSP page context
* @param req the JSP request
* @param res the JSP response
*/
public CmsFlexCacheList(PageContext context, HttpServletRequest req, HttpServletResponse res) {
this(new CmsJspActionElement(context, req, res));
}
/**
* @see org.opencms.workplace.list.A_CmsListDialog#defaultActionHtmlStart()
*/
public String defaultActionHtmlStart() {
return getList().listJs() + dialogContentStart(getParamTitle());
}
/**
* @see org.opencms.workplace.list.A_CmsListDialog#executeListMultiActions()
*/
public void executeListMultiActions() throws CmsRuntimeException {
throwListUnsupportedActionException();
}
/**
* @see org.opencms.workplace.list.A_CmsListDialog#executeListSingleActions()
*/
public void executeListSingleActions() {
throwListUnsupportedActionException();
}
/**
* @see org.opencms.workplace.list.A_CmsListDialog#fillDetails(java.lang.String)
*/
protected void fillDetails(String detailId) {
CmsObject cms = getCms();
CmsFlexController controller = (CmsFlexController)getJsp().getRequest().getAttribute(
CmsFlexController.ATTRIBUTE_NAME);
CmsFlexCache cache = controller.getCmsCache();
// get content
List entries = getList().getAllContent();
Iterator itEntries = entries.iterator();
while (itEntries.hasNext()) {
CmsListItem item = (CmsListItem)itEntries.next();
String resName = item.getId();
StringBuffer html = new StringBuffer(512);
try {
if (detailId.equals(LIST_DETAIL_VARIATIONS)) {
// variations
List variations = new ArrayList(cache.getCachedVariations(resName, cms));
Collections.sort(variations);
Iterator itVariations = variations.iterator();
while (itVariations.hasNext()) {
String var = (String)itVariations.next();
html.append(var);
if (itVariations.hasNext()) {
html.append("<br>");
}
html.append("\n");
}
} else {
continue;
}
} catch (Exception e) {
// ignore
}
item.set(detailId, html.toString());
}
}
/**
* @see org.opencms.workplace.list.A_CmsListDialog#getListItems()
*/
protected List getListItems() {
List ret = new ArrayList();
CmsFlexController controller = (CmsFlexController)getJsp().getRequest().getAttribute(
CmsFlexController.ATTRIBUTE_NAME);
CmsFlexCache cache = controller.getCmsCache();
// get content
Iterator itResources = new ArrayList(cache.getCachedResources(getCms())).iterator();
while (itResources.hasNext()) {
String resource = (String)itResources.next();
CmsListItem item = getList().newItem(resource);
String resName = resource;
String project = "";
if (resource.endsWith(CmsFlexCache.CACHE_OFFLINESUFFIX)) {
resName = resource.substring(0, resource.length() - CmsFlexCache.CACHE_OFFLINESUFFIX.length());
project = "Offline";
}
if (resource.endsWith(CmsFlexCache.CACHE_ONLINESUFFIX)) {
resName = resource.substring(0, resource.length() - CmsFlexCache.CACHE_ONLINESUFFIX.length());
project = "Online";
}
item.set(LIST_COLUMN_RESOURCE, resName);
item.set(LIST_COLUMN_PROJECT, project);
item.set(LIST_COLUMN_KEY, cache.getCachedKey(resource, getCms()));
ret.add(item);
}
return ret;
}
/**
* @see org.opencms.workplace.CmsWorkplace#initMessages()
*/
protected void initMessages() {
// add specific dialog resource bundle
addMessages(Messages.get().getBundleName());
// add default resource bundles
super.initMessages();
}
/**
* @see org.opencms.workplace.list.A_CmsListDialog#setColumns(org.opencms.workplace.list.CmsListMetadata)
*/
protected void setColumns(CmsListMetadata metadata) {
// create column for icon display
CmsListColumnDefinition iconCol = new CmsListColumnDefinition(LIST_COLUMN_ICON);
iconCol.setName(Messages.get().container(Messages.GUI_FLEXCACHE_LIST_COLS_ICON_0));
iconCol.setWidth("20");
iconCol.setAlign(CmsListColumnAlignEnum.ALIGN_CENTER);
iconCol.setSorteable(false);
CmsListDirectAction iconAction = new CmsListDirectAction(LIST_ACTION_ICON);
iconAction.setName(Messages.get().container(Messages.GUI_FLEXCACHE_LIST_ACTION_ICON_NAME_0));
iconAction.setIconPath("tools/cache/buttons/flexentry.png");
iconAction.setEnabled(false);
iconCol.addDirectAction(iconAction);
// add it to the list definition
metadata.addColumn(iconCol);
// create column for resource name
CmsListColumnDefinition nameCol = new CmsListColumnDefinition(LIST_COLUMN_RESOURCE);
nameCol.setName(Messages.get().container(Messages.GUI_FLEXCACHE_LIST_COLS_RESOURCE_0));
nameCol.setWidth("60%");
// add it to the list definition
metadata.addColumn(nameCol);
// create column for project
CmsListColumnDefinition projectCol = new CmsListColumnDefinition(LIST_COLUMN_PROJECT);
projectCol.setName(Messages.get().container(Messages.GUI_FLEXCACHE_LIST_COLS_PROJECT_0));
projectCol.setWidth("15%");
// add it to the list definition
metadata.addColumn(projectCol);
// create column for cache key
CmsListColumnDefinition keyCol = new CmsListColumnDefinition(LIST_COLUMN_KEY);
keyCol.setName(Messages.get().container(Messages.GUI_FLEXCACHE_LIST_COLS_KEY_0));
keyCol.setWidth("25%");
// add it to the list definition
metadata.addColumn(keyCol);
}
/**
* @see org.opencms.workplace.list.A_CmsListDialog#setIndependentActions(org.opencms.workplace.list.CmsListMetadata)
*/
protected void setIndependentActions(CmsListMetadata metadata) {
// add variations details
CmsListItemDetails variationsDetails = new CmsListItemDetails(LIST_DETAIL_VARIATIONS);
variationsDetails.setAtColumn(LIST_COLUMN_RESOURCE);
variationsDetails.setVisible(false);
variationsDetails.setShowActionName(Messages.get().container(
Messages.GUI_FLEXCACHE_DETAIL_SHOW_VARIATIONS_NAME_0));
variationsDetails.setShowActionHelpText(Messages.get().container(
Messages.GUI_FLEXCACHE_DETAIL_SHOW_VARIATIONS_HELP_0));
variationsDetails.setHideActionName(Messages.get().container(
Messages.GUI_FLEXCACHE_DETAIL_HIDE_VARIATIONS_NAME_0));
variationsDetails.setHideActionHelpText(Messages.get().container(
Messages.GUI_FLEXCACHE_DETAIL_HIDE_VARIATIONS_HELP_0));
variationsDetails.setName(Messages.get().container(Messages.GUI_FLEXCACHE_DETAIL_VARIATIONS_NAME_0));
variationsDetails.setFormatter(new CmsListItemDetailsFormatter(Messages.get().container(
Messages.GUI_FLEXCACHE_DETAIL_VARIATIONS_NAME_0)));
metadata.addItemDetails(variationsDetails);
}
/**
* @see org.opencms.workplace.list.A_CmsListDialog#setMultiActions(org.opencms.workplace.list.CmsListMetadata)
*/
protected void setMultiActions(CmsListMetadata metadata) {
// no multi actions
}
}