2 * Copyright 2015 Samsung Electronics All Rights Reserved.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 package oic.simulator.clientcontroller.view;
19 import java.io.BufferedWriter;
20 import java.io.FileWriter;
21 import java.io.IOException;
22 import java.text.DateFormat;
23 import java.text.SimpleDateFormat;
24 import java.util.HashMap;
25 import java.util.List;
27 import oic.simulator.clientcontroller.Activator;
28 import oic.simulator.clientcontroller.listener.ILogUIListener;
29 import oic.simulator.clientcontroller.manager.LogManager;
30 import oic.simulator.clientcontroller.utils.Constants;
31 import oic.simulator.clientcontroller.view.dialogs.FilterDialog;
32 import oic.simulator.clientcontroller.view.dialogs.LogDetailsDialog;
33 import oic.simulator.logger.LogContentProvider;
34 import oic.simulator.logger.LogEntry;
35 import oic.simulator.logger.LogLabelProvider;
37 import org.eclipse.jface.action.Action;
38 import org.eclipse.jface.action.IAction;
39 import org.eclipse.jface.action.IContributionItem;
40 import org.eclipse.jface.action.IMenuManager;
41 import org.eclipse.jface.action.IToolBarManager;
42 import org.eclipse.jface.action.MenuManager;
43 import org.eclipse.jface.action.Separator;
44 import org.eclipse.jface.dialogs.MessageDialog;
45 import org.eclipse.jface.resource.ImageDescriptor;
46 import org.eclipse.jface.viewers.DoubleClickEvent;
47 import org.eclipse.jface.viewers.IDoubleClickListener;
48 import org.eclipse.jface.viewers.ISelectionChangedListener;
49 import org.eclipse.jface.viewers.IStructuredSelection;
50 import org.eclipse.jface.viewers.SelectionChangedEvent;
51 import org.eclipse.jface.viewers.StructuredSelection;
52 import org.eclipse.jface.viewers.TreeViewer;
53 import org.eclipse.jface.viewers.Viewer;
54 import org.eclipse.jface.viewers.ViewerComparator;
55 import org.eclipse.jface.window.Window;
56 import org.eclipse.swt.SWT;
57 import org.eclipse.swt.events.KeyEvent;
58 import org.eclipse.swt.events.KeyListener;
59 import org.eclipse.swt.events.SelectionAdapter;
60 import org.eclipse.swt.events.SelectionEvent;
61 import org.eclipse.swt.layout.GridData;
62 import org.eclipse.swt.widgets.Composite;
63 import org.eclipse.swt.widgets.Display;
64 import org.eclipse.swt.widgets.FileDialog;
65 import org.eclipse.swt.widgets.Text;
66 import org.eclipse.swt.widgets.Tree;
67 import org.eclipse.swt.widgets.TreeColumn;
68 import org.eclipse.swt.widgets.TreeItem;
69 import org.eclipse.ui.IActionBars;
70 import org.eclipse.ui.IWorkbenchActionConstants;
71 import org.eclipse.ui.IWorkbenchPage;
72 import org.eclipse.ui.dialogs.FilteredTree;
73 import org.eclipse.ui.dialogs.PatternFilter;
74 import org.eclipse.ui.part.ViewPart;
75 import org.oic.simulator.ILogger.Level;
78 * This class manages and shows the log view in the perspective.
80 public class LogView extends ViewPart {
82 public static final String VIEW_ID = "oic.simulator.clientcontroller.view.log";
84 private LogManager logManager;
85 private ILogUIListener logListener;
87 private LogContentProvider treeContentProvider;
89 private FilteredTree tree;
90 private TreeColumn severityColumn;
91 private TreeColumn dateColumn;
92 private TreeColumn messageColumn;
94 private IAction exportLogAction;
95 private IAction clearLogAction;
96 private IAction deleteLogAction;
97 private IAction scrollLockAction;
98 private IAction logDetailsAction;
99 private IAction filterAction;
100 private IAction activateViewAction;
101 private IAction showTextFilter;
102 private IContributionItem groupByAction;
104 private HashMap<Integer, Boolean> shownSeverities = new HashMap<Integer, Boolean>();
106 private boolean activateOnChange = false;
108 private boolean hideTextFilter = false;
110 private boolean scrollLockDisabled;
112 public static final int ORDER_BY_TIME = 0;
113 public static final int ORDER_BY_SEVERITY = 1;
114 public static final int ORDER_BY_MESSAGE = 2;
116 int sortCandidate = ORDER_BY_TIME;
118 SortAction sortByTimeAction = new SortAction(
121 SortAction sortBySeverityAction = new SortAction(
124 SortAction sortByMessageAction = new SortAction(
128 private ViewerComparator dateComparator;
129 private ViewerComparator severityComparator;
130 private ViewerComparator messageComparator;
132 private TreeColumn sortColumn = null;
133 private static int DOWN = 1;
134 private static int UP = -1;
135 private int sortDirection = DOWN;
139 logListener = new ILogUIListener() {
142 public void logChanged(final List<LogEntry> entry) {
143 Display.getDefault().asyncExec(new Runnable() {
147 TreeViewer viewer = tree.getViewer();
148 if (viewer.getControl().isDisposed()) {
151 viewer.setInput(entry);
158 public void logAdded(final LogEntry added) {
159 Display.getDefault().asyncExec(new Runnable() {
163 TreeViewer viewer = tree.getViewer();
164 if (viewer.getControl().isDisposed()) {
167 LogContentProvider provider = (LogContentProvider) viewer
168 .getContentProvider();
169 provider.addLog(added);
170 tree.getViewer().add(viewer.getInput(), added);
171 @SuppressWarnings("unchecked")
172 List<LogEntry> input = (List<LogEntry>) viewer
174 if (input.size() > Constants.LOG_SIZE) {
175 viewer.remove(viewer.getInput(), 0);
182 private void updateTree(boolean needscroll) {
183 if (activateOnChange) {
184 IWorkbenchPage page = Activator.getDefault().getWorkbench()
185 .getActiveWorkbenchWindow().getActivePage();
187 page.bringToTop(LogView.this);
190 if (scrollLockDisabled && needscroll) {
191 Tree tree2 = tree.getViewer().getTree();
192 if (tree2.getItemCount() > 0) {
193 TreeItem item = tree2.getItem(tree2.getItemCount() - 1);
194 tree2.setTopItem(item);
195 deleteLogAction.setEnabled(true);
201 logManager = Activator.getDefault().getLogManager();
203 // Initially state of scroll lock
204 scrollLockDisabled = true;
208 public void createPartControl(Composite parent) {
209 PatternFilter filter = new PatternFilter() {
211 DateFormat dateFormat = new SimpleDateFormat("HH:mm:ss.SSS");
214 protected boolean isLeafMatch(Viewer viewer, Object element) {
215 if (element instanceof LogEntry) {
216 LogEntry logEntry = (LogEntry) element;
217 String severity = LogManager.getSeverityName(logEntry
219 String date = dateFormat.format(logEntry.getDate());
220 String message = logEntry.getMessage();
221 return wordMatches(severity) || wordMatches(date)
222 || wordMatches(message);
227 filter.setIncludeLeadingWildcard(true);
228 tree = new FilteredTree(parent, SWT.SINGLE | SWT.H_SCROLL
229 | SWT.V_SCROLL | SWT.FULL_SELECTION, filter, true);
233 createColumnComparators();
237 setDefaultShownSeverities();
239 IActionBars actionBars = getViewSite().getActionBars();
240 IToolBarManager toolBarManager = actionBars.getToolBarManager();
241 toolBarManager.add(exportLogAction);
242 toolBarManager.add(clearLogAction);
243 toolBarManager.add(deleteLogAction);
244 toolBarManager.add(scrollLockAction);
246 .add(new Separator(IWorkbenchActionConstants.MB_ADDITIONS));
248 IMenuManager mgr = actionBars.getMenuManager();
249 mgr.add(groupByAction);
250 mgr.add(new Separator());
251 mgr.add(filterAction);
252 mgr.add(new Separator());
253 mgr.add(activateViewAction);
254 mgr.add(showTextFilter);
256 addManagerListeners();
258 if (sortCandidate == ORDER_BY_TIME) {
259 sortByTimeAction.run();
260 } else if (sortCandidate == ORDER_BY_SEVERITY) {
261 sortBySeverityAction.run();
262 } else { // order_selected == ORDER_BY_NONE
263 sortByMessageAction.run();
268 private void setupFilteredTree() {
269 tree.setLayoutData(new GridData(GridData.FILL_BOTH));
270 final Tree innerTree = tree.getViewer().getTree();
271 innerTree.setLinesVisible(true);
273 severityColumn = new TreeColumn(innerTree, SWT.LEFT);
274 severityColumn.setText("Severity");
275 severityColumn.setWidth(110);
276 severityColumn.addSelectionListener(new SelectionAdapter() {
279 public void widgetSelected(SelectionEvent e) {
280 sortBySeverityAction.run();
283 dateColumn = new TreeColumn(innerTree, SWT.LEFT);
284 dateColumn.setText("Time");
285 dateColumn.setWidth(110);
286 dateColumn.addSelectionListener(new SelectionAdapter() {
289 public void widgetSelected(SelectionEvent e) {
290 sortByTimeAction.run();
293 messageColumn = new TreeColumn(innerTree, SWT.LEFT);
294 messageColumn.setText("Message");
295 messageColumn.setWidth(180);
296 messageColumn.addSelectionListener(new SelectionAdapter() {
298 public void widgetSelected(SelectionEvent e) {
299 sortByMessageAction.run();
303 innerTree.setHeaderVisible(true);
305 treeContentProvider = new LogContentProvider();
307 tree.getViewer().setContentProvider(treeContentProvider);
308 tree.getViewer().setLabelProvider(new LogLabelProvider());
310 tree.getViewer().setInput(logManager.getLogEntries());
312 tree.getViewer().addSelectionChangedListener(
313 new ISelectionChangedListener() {
316 public void selectionChanged(SelectionChangedEvent event) {
317 deleteLogAction.setEnabled(!tree.getViewer()
318 .getSelection().isEmpty());
319 logDetailsAction.setEnabled(!tree.getViewer()
320 .getSelection().isEmpty());
324 tree.getViewer().getTree().addKeyListener(new KeyListener() {
327 public void keyReleased(KeyEvent e) {
331 public void keyPressed(KeyEvent e) {
332 if (e.character == (char) 127) { // If delete key is pressed
333 if (deleteLogAction.isEnabled()) {
334 deleteLogAction.run();
340 tree.getViewer().addDoubleClickListener(new IDoubleClickListener() {
343 public void doubleClick(DoubleClickEvent event) {
344 logDetailsAction.run();
349 private void createColumnComparators() {
350 dateComparator = new ViewerComparator() {
353 public int compare(Viewer viewer, Object e1, Object e2) {
354 LogEntry l1 = (LogEntry) e1;
355 LogEntry l2 = (LogEntry) e2;
356 return l1.getDate().compareTo(l2.getDate()) * sortDirection;
360 severityComparator = new ViewerComparator() {
363 public int compare(Viewer viewer, Object e1, Object e2) {
364 LogEntry l1 = (LogEntry) e1;
365 LogEntry l2 = (LogEntry) e2;
366 if (l1.getSeverity() < l2.getSeverity()) {
367 return -1 * sortDirection;
369 if (l1.getSeverity() > l2.getSeverity()) {
370 return 1 * sortDirection;
376 messageComparator = new ViewerComparator() {
379 public int compare(Viewer viewer, Object e1, Object e2) {
380 LogEntry l1 = (LogEntry) e1;
381 LogEntry l2 = (LogEntry) e2;
382 return l1.getMessage().compareTo(l2.getMessage())
389 private void setDefaultShownSeverities() {
390 shownSeverities.put(Level.INFO.ordinal(), true);
391 shownSeverities.put(Level.DEBUG.ordinal(), true);
392 shownSeverities.put(Level.WARNING.ordinal(), true);
393 shownSeverities.put(Level.ERROR.ordinal(), true);
396 private void addManagerListeners() {
397 logManager.addLogListener(logListener);
398 logManager.applyFilter(shownSeverities);
401 private void createActions() {
402 exportLogAction = createExportLogAction();
403 clearLogAction = createClearLogAction();
404 deleteLogAction = createDeleteLogAction();
405 scrollLockAction = createScrollLockAction();
406 logDetailsAction = createLogDetailsAction();
408 filterAction = createFilterAction();
409 activateViewAction = createActivateViewAction();
410 showTextFilter = createShowTextFilter();
411 groupByAction = createGroupByAction();
414 private IAction createExportLogAction() {
415 Action action = new Action("Export log") {
418 FileDialog fd = new FileDialog(Display.getDefault()
419 .getActiveShell(), SWT.SAVE);
420 fd.setOverwrite(true);
421 fd.setFileName("OIC_Simulator_ServerLog.log");
422 fd.setFilterExtensions(Constants.SAVE_LOG_FILTER_EXTENSIONS);
423 String name = fd.open();
424 List<LogEntry> logEntries = logManager.getLogEntries();
425 StringBuilder sb = new StringBuilder();
426 for (LogEntry entry : logEntries) {
427 sb.append(entry.toString());
429 String data = sb.toString();
430 BufferedWriter out = null;
432 out = new BufferedWriter(new FileWriter(name));
434 } catch (IOException e) {
436 MessageDialog.openError(
437 Display.getDefault().getActiveShell(),
439 "Could not export log. IO exception: "
444 } catch (IOException e) {
445 // Error occurred during close. Ignoring
450 action.setToolTipText("Export log");
452 action.setImageDescriptor(ImageDescriptor.createFromFile(
453 this.getClass(), "/icons/export_log_e.gif"));
454 action.setDisabledImageDescriptor(ImageDescriptor.createFromFile(
455 this.getClass(), "/icons/export_log_d.gif"));
456 action.setEnabled(true);
461 private IAction createClearLogAction() {
462 Action action = new Action("Clear log") {
466 logManager.clearLog();
469 action.setToolTipText("Clear log");
471 action.setImageDescriptor(ImageDescriptor.createFromFile(
472 this.getClass(), "/icons/clear_e.gif"));
473 action.setDisabledImageDescriptor(ImageDescriptor.createFromFile(
474 this.getClass(), "/icons/clear_d.gif"));
475 action.setEnabled(true);
479 private IAction createDeleteLogAction() {
480 Action action = new Action("Delete log entry") {
483 @SuppressWarnings("unchecked")
485 IStructuredSelection selection = (IStructuredSelection) tree
486 .getViewer().getSelection();
487 List<LogEntry> entries = (List<LogEntry>) tree.getViewer()
489 LogEntry selectedEntry = (LogEntry) selection.getFirstElement();
490 if (null != selectedEntry) {
491 LogEntry toBeShownEntry = null;
492 for (LogEntry entry : entries) {
493 if (entry.equals(selectedEntry)) {
494 int size = entries.size();
495 int index = entries.indexOf(selectedEntry);
496 if (index + 1 < size) {
497 toBeShownEntry = entries.get(index + 1);
498 } else if (index > 0) {
499 toBeShownEntry = entries.get(index - 1);
504 logManager.removeEntry(selectedEntry);
505 if (null != toBeShownEntry) {
506 tree.getViewer().setSelection(
507 new StructuredSelection(toBeShownEntry));
512 action.setToolTipText("Delete log entry");
513 action.setImageDescriptor(ImageDescriptor.createFromFile(
514 this.getClass(), "/icons/delete_e.gif"));
515 action.setDisabledImageDescriptor(ImageDescriptor.createFromFile(
516 this.getClass(), "/icons/delete_d.gif"));
517 action.setEnabled(false);
521 private IAction createScrollLockAction() {
522 Action action = new Action("Scroll lock") {
526 scrollLockDisabled = !this.isChecked();
530 public int getStyle() {
531 return IAction.AS_CHECK_BOX;
534 action.setToolTipText("Scroll lock");
535 action.setImageDescriptor(ImageDescriptor.createFromFile(
536 this.getClass(), "/icons/lock_e.gif"));
537 action.setDisabledImageDescriptor(ImageDescriptor.createFromFile(
538 this.getClass(), "/icons/lock_d.gif"));
539 action.setEnabled(true);
543 private IAction createLogDetailsAction() {
544 Action action = new Action("Details...") {
548 Display.getDefault().asyncExec(new Runnable() {
552 LogEntry x = (LogEntry) ((IStructuredSelection) tree
553 .getViewer().getSelection()).getFirstElement();
555 new LogDetailsDialog(Display.getDefault()
556 .getActiveShell(), LogManager.getSeverityName(x
557 .getSeverity()), LogManager.getSeverityIcon(x
558 .getSeverity()), x.getDate(), x.getMessage())
564 action.setToolTipText("Details...");
565 action.setImageDescriptor(ImageDescriptor.createFromFile(
566 this.getClass(), "/icons/log_details_e.gif"));
567 action.setDisabledImageDescriptor(ImageDescriptor.createFromFile(
568 this.getClass(), "/icons/log_details_e.gif"));
569 action.setEnabled(false);
573 private IAction createFilterAction() {
574 Action action = new Action("Filters ...") {
578 FilterDialog fd = new FilterDialog(Display.getDefault()
579 .getActiveShell(), shownSeverities);
580 if (fd.open() == Window.OK) {
581 logManager.applyFilter(shownSeverities);
583 tree.getViewer().refresh();
586 action.setToolTipText("Filters ...");
588 action.setImageDescriptor(ImageDescriptor.createFromFile(
589 this.getClass(), "/icons/filter_e.gif"));
590 action.setDisabledImageDescriptor(ImageDescriptor.createFromFile(
591 this.getClass(), "/icons/filter_d.gif"));
592 action.setEnabled(true);
596 private IAction createActivateViewAction() {
597 Action action = new Action("Activate view on new events",
598 IAction.AS_CHECK_BOX) {
602 activateOnChange = this.isChecked();
605 action.setChecked(activateOnChange);
606 action.setToolTipText("Activate view on new events");
608 action.setImageDescriptor(ImageDescriptor.createFromFile(
609 this.getClass(), "/icons/prop_e.gif"));
610 action.setDisabledImageDescriptor(ImageDescriptor.createFromFile(
611 this.getClass(), "/icons/prop_d.gif"));
612 action.setEnabled(true);
616 private IAction createShowTextFilter() {
617 Action action = new Action("Show text filter", IAction.AS_CHECK_BOX) {
621 Text filterControl = tree.getFilterControl();
622 Composite filterComposite = filterControl.getParent();
623 GridData gd = (GridData) filterComposite.getLayoutData();
624 boolean visible = isChecked();
625 gd.exclude = !visible;
626 filterComposite.setVisible(visible);
627 filterControl.setText("");
629 filterControl.selectAll();
633 hideTextFilter = !visible;
636 action.setToolTipText("Show text filter");
638 action.setImageDescriptor(ImageDescriptor.createFromFile(
639 this.getClass(), "/icons/tree_mode_e.gif"));
640 action.setDisabledImageDescriptor(ImageDescriptor.createFromFile(
641 this.getClass(), "/icons/tree_mode_d.gif"));
642 action.setEnabled(true);
643 action.setChecked(!hideTextFilter);
644 if (hideTextFilter) {
650 private IContributionItem createGroupByAction() {
651 IMenuManager manager = new MenuManager("Order by");
652 manager.add(sortByTimeAction);
653 manager.add(sortBySeverityAction);
654 manager.add(sortByMessageAction);
658 class SortAction extends Action {
660 private final int sortBy;
662 public SortAction(String text, int sortBy) {
663 super(text, IAction.AS_RADIO_BUTTON);
664 this.sortBy = sortBy;
666 if (sortCandidate == sortBy) {
673 sortBySeverityAction.setChecked(false);
674 sortByTimeAction.setChecked(false);
675 sortCandidate = sortBy;
678 ViewerComparator comparator;
680 if (sortBy == ORDER_BY_SEVERITY) {
681 comparator = severityComparator;
682 column = severityColumn;
683 } else if (sortBy == ORDER_BY_TIME) {
684 comparator = dateComparator;
686 } else { // Order by message
687 comparator = messageComparator;
688 column = messageColumn;
690 TreeViewer viewer = tree.getViewer();
691 viewer.setComparator(comparator);
692 viewer.getTree().setSortColumn(column);
693 if (column.equals(sortColumn)) { // reverse sorting order
694 sortDirection = viewer.getTree().getSortDirection() == SWT.UP ? DOWN
696 viewer.getTree().setSortDirection(
697 sortDirection == UP ? SWT.UP : SWT.DOWN);
699 } else { // set this column as the one to sort by
700 sortDirection = DOWN;
701 viewer.getTree().setSortDirection(SWT.DOWN);
708 private void refresh() {
709 tree.getViewer().refresh();
713 public void setFocus() {
718 public void dispose() {
719 logManager.removeLogListener(logListener);