HistoryPanel.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.cyclop.web.panels.history;

import java.util.Optional;

import javax.inject.Inject;

import org.apache.commons.lang.StringUtils;
import org.apache.wicket.ajax.AbstractDefaultAjaxBehavior;
import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.ajax.form.OnChangeAjaxBehavior;
import org.apache.wicket.ajax.markup.html.AjaxFallbackLink;
import org.apache.wicket.markup.head.IHeaderResponse;
import org.apache.wicket.markup.head.JavaScriptReferenceHeaderItem;
import org.apache.wicket.markup.html.WebMarkupContainer;
import org.apache.wicket.markup.html.basic.Label;
import org.apache.wicket.markup.html.form.TextField;
import org.apache.wicket.markup.html.link.BookmarkablePageLink;
import org.apache.wicket.markup.html.list.ListItem;
import org.apache.wicket.markup.html.list.PageableListView;
import org.apache.wicket.markup.html.panel.Panel;
import org.apache.wicket.request.mapper.parameter.PageParameters;
import org.apache.wicket.request.resource.JavaScriptResourceReference;
import org.apache.wicket.util.string.Strings;
import org.cyclop.common.StringHelper;
import org.cyclop.common.StringHelper.StringDecorator;
import org.cyclop.model.FilterResult;
import org.cyclop.model.QueryEntry;
import org.cyclop.model.UserPreferences;
import org.cyclop.service.converter.DataConverter;
import org.cyclop.service.queryprotocoling.HistoryService;
import org.cyclop.service.search.FieldAccessor;
import org.cyclop.service.search.SearchService;
import org.cyclop.service.um.UserManager;
import org.cyclop.web.common.AjaxReloadSupport;
import org.cyclop.web.common.ImmutableListModel;
import org.cyclop.web.common.TextModel;
import org.cyclop.web.components.pagination.BootstrapPagingNavigator;
import org.cyclop.web.components.pagination.PagerConfigurator;
import org.cyclop.web.pages.main.MainPage;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;

/** @author Maciej Miklas */
public class HistoryPanel extends Panel implements AjaxReloadSupport {
	@Inject
	private UserManager um;

	private static final JavaScriptResourceReference JS_HISTORY = new JavaScriptResourceReference(HistoryPanel.class,
			"history.js");

	private AbstractDefaultAjaxBehavior browserCallback;

	private BootstrapPagingNavigator historyPager;

	@Inject
	private HistoryService historyService;

	@Inject
	private DataConverter converter;

	@Inject
	private SearchService<QueryEntry> searchService;

	private PageableListView<QueryEntry> historyRows;

	private ImmutableSet<String> filterKeywords;

	private final static QueryEntryFieldAccessor FILTER_ACCESSOR = new QueryEntryFieldAccessor();

	private final static KeywordDecorator KEYWORD_DECORATOR = new KeywordDecorator();

	private WebMarkupContainer historyTable;

	private final ImmutableListModel<QueryEntry> historyModel = new ImmutableListModel<>();

	public HistoryPanel(String id) {
		super(id);
	}

	@Override
	protected void onInitialize() {
		super.onInitialize();

		initHistoryTable();
		initBrowserCallback();
		initFilter();
	}

	private String decorateQueryWithFilter(QueryEntry entry) {
		String query = Strings.escapeMarkup(entry.query.part).toString();
		if (filterKeywords != null) {
			query = StringHelper.decorate(query, KEYWORD_DECORATOR,
					filterKeywords.toArray(new String[filterKeywords.size()]));
		}
		return query;
	}

	@Override
	public String getReloadCallbackUrl() {
		return browserCallback.getCallbackUrl().toString();
	}

	@Override
	public String getRemovableContentCssRef() {
		return ".cq-historyContainer";
	}

	private void initBrowserCallback() {
		browserCallback = new AbstractDefaultAjaxBehavior() {

			@Override
			protected void respond(final AjaxRequestTarget target) {
				ImmutableList<QueryEntry> historyList = historyService.read().copyAsList();
				rebuildHistoryTable(historyList, null);
				historyTable.setVisible(true);
				historyPager.setVisible(true);
				target.add(historyTable, historyPager);
			}
		};
		add(browserCallback);
	}

	private void initFilter() {
		final TextModel filterFieldModel = new TextModel();
		final TextField<String> filterField = new TextField<>("filterField", filterFieldModel);
		filterField.setOutputMarkupId(true);

		filterField.add(new FilterBehaviour(filterFieldModel));
		add(filterField);

		AjaxFallbackLink<Void> resetFilter = new AjaxFallbackLink<Void>("resetFilter") {
			@Override
			public void onClick(AjaxRequestTarget target) {
				ImmutableList<QueryEntry> historyToUpdate = historyService.read().copyAsList();

				rebuildHistoryTable(historyToUpdate, null);
				filterFieldModel.setObject("");
				target.add(filterField);
				target.add(historyPager, historyTable);
				target.appendJavaScript("initResetButton();");
			}
		};
		add(resetFilter);
	}

	private void initHistoryTable() {
		historyTable = new WebMarkupContainer("historyTable");
		historyTable.setOutputMarkupPlaceholderTag(true);
		add(historyTable);
		historyRows = new PageableListView<QueryEntry>("historyRow", historyModel, 1) {

			@Override
			protected void populateItem(ListItem<QueryEntry> item) {
				QueryEntry entry = item.getModel().getObject();

				populateExecutedOn(item, entry);
				populateRuntime(item, entry);
				populateQuery(item, entry);
			}
		};
		historyTable.add(historyRows);
		historyPager = new BootstrapPagingNavigator("historyPager", historyRows, new PagerConfigurator() {

			@Override
			public void onItemsPerPageChanged(AjaxRequestTarget target, long newItemsPerPage) {
				UserPreferences prefs = um.readPreferences().setPagerHistoryItems(newItemsPerPage);
				um.storePreferences(prefs);

			}

			@Override
			public long getInitialItemsPerPage() {
				return um.readPreferences().getPagerHistoryItems();
			}
		});
		historyPager.setOutputMarkupPlaceholderTag(true); 
		add(historyPager);
	}

	private void populateExecutedOn(ListItem<QueryEntry> item, QueryEntry entry) {
		String dateStr = converter.convert(entry.executedOnUtc);
		Label executedOn = new Label("executedOn", dateStr);
		item.add(executedOn);
	}

	private void populateQuery(ListItem<QueryEntry> item, QueryEntry entry) {
		PageParameters queryLinkParams = new PageParameters();
		queryLinkParams.add("cql", entry.query.toDisplayString());
		BookmarkablePageLink<Void> link = new BookmarkablePageLink<>("queryLink", MainPage.class, queryLinkParams);
		item.add(link);

		Label queryLabel = new Label("query", decorateQueryWithFilter(entry));
		queryLabel.setEscapeModelStrings(false);
		item.add(queryLabel);
	}

	private void populateRuntime(ListItem<QueryEntry> item, QueryEntry entry) {
		String dateStr = Long.toString(entry.runTime);
		Label executedOn = new Label("runtime", dateStr);
		item.add(executedOn);
	}

	private void rebuildHistoryTable(ImmutableList<QueryEntry> historyList, ImmutableSet<String> filterKeywords) {
		historyModel.setObject(historyList);
		historyRows.removeAll();
		historyPager.reset();
		this.filterKeywords = filterKeywords;
	}

	@Override
	public void renderHead(IHeaderResponse response) {
		super.renderHead(response);
		response.render(JavaScriptReferenceHeaderItem.forReference(JS_HISTORY));
	}

	private final class FilterBehaviour extends OnChangeAjaxBehavior {

		private final TextModel filterFieldModel;

		public FilterBehaviour(TextModel filterFieldModel) {
			this.filterFieldModel = filterFieldModel;
		}

		@Override
		protected void onUpdate(AjaxRequestTarget target) {
			ImmutableList<QueryEntry> historyToUpdate = historyService.read().copyAsList();
			ImmutableSet<String> kwds = null;

			String filterValue = filterFieldModel.getObject();
			filterValue = StringUtils.trimToNull(filterValue);
			if (filterValue != null) {
				String[] kwdsArr = filterValue.split(" ");
				Optional<FilterResult<QueryEntry>> filterResult = searchService.filter(historyToUpdate, FILTER_ACCESSOR,
						kwdsArr);
				if (filterResult.isPresent()) {
					FilterResult<QueryEntry> res = filterResult.get();
					historyToUpdate = res.result;
					kwds = res.normalizedKeywords;
				}
			}

			rebuildHistoryTable(historyToUpdate, kwds);
			target.add(historyPager, historyTable);
		}

	}

	private final static class KeywordDecorator implements StringDecorator {
		@Override
		public String decorate(String in) {
			return prefix() + in + postfix();
		}

		@Override
		public String postfix() {
			return "</span>";
		}

		@Override
		public String prefix() {
			return "<span class='cq-history-keyword'>";
		}
	}

	private final static class QueryEntryFieldAccessor implements FieldAccessor<QueryEntry> {
		@Override
		public String getText(QueryEntry obj) {
			return obj.query.partLc;
		}
	}

}