001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.ui.apps.logfile;
029
030import org.opencms.main.CmsLog;
031import org.opencms.main.OpenCms;
032import org.opencms.ui.CmsVaadinUtils;
033import org.opencms.ui.apps.Messages;
034import org.opencms.util.CmsLog4jUtil;
035import org.opencms.util.CmsRfsException;
036import org.opencms.util.CmsRfsFileViewer;
037
038import java.io.ByteArrayOutputStream;
039import java.io.File;
040import java.io.OutputStreamWriter;
041import java.nio.charset.Charset;
042import java.util.ArrayList;
043import java.util.List;
044
045import org.apache.commons.logging.Log;
046import org.apache.logging.log4j.LogManager;
047import org.apache.logging.log4j.core.Appender;
048import org.apache.logging.log4j.core.Logger;
049
050import com.vaadin.server.FileDownloader;
051import com.vaadin.ui.Panel;
052import com.vaadin.v7.data.Property.ValueChangeEvent;
053import com.vaadin.v7.data.Property.ValueChangeListener;
054import com.vaadin.v7.shared.ui.combobox.FilteringMode;
055import com.vaadin.v7.ui.ComboBox;
056import com.vaadin.v7.ui.Label;
057import com.vaadin.v7.ui.VerticalLayout;
058
059/**
060 * Class for the view of log files.<p>
061 */
062public class CmsLogFileView extends VerticalLayout {
063
064    /**Session attribute to store charset setting.*/
065    protected static String ATTR_FILE_VIEW_CHARSET = "log-file-char";
066
067    /**Session attribute to store currently viewed log file.*/
068    protected static String ATTR_FILE_VIEW_PATH = "log-file";
069
070    /**Session attribute to store line number to display. */
071    protected static String ATTR_FILE_VIEW_SIZE = "log-file-size";
072
073    /**Window size.*/
074    protected static int WINDOW_SIZE = 1000;
075
076    /** Logger instance for this class. */
077    private static final Log LOG = CmsLog.getLog(CmsLogFileView.class);
078
079    /**vaadin serial id.*/
080    private static final long serialVersionUID = -6323034856756469160L;
081
082    /**Vaadin component. */
083    protected FileDownloader m_fileDownloader;
084
085    /**Vaadin component. */
086    private Label m_fileContent;
087
088    /**Vaadin component. */
089    private ComboBox m_logfile;
090
091    /**RfsFileView holding data for log to show. */
092    private CmsRfsFileViewer m_logView;
093
094    private Panel m_panelComp;
095
096    /**
097     * constructor.<p>
098     *
099     * @param app which uses this view
100     */
101    protected CmsLogFileView(final CmsLogFileApp app) {
102
103        if (CmsLogFileApp.LOG_FOLDER.isEmpty()) {
104            addComponent(CmsVaadinUtils.getInfoLayout(Messages.GUI_LOGFILE_WRONG_CONFIG_0));
105        } else {
106            CmsVaadinUtils.readAndLocalizeDesign(this, CmsVaadinUtils.getWpMessagesForCurrentLocale(), null);
107
108            List<Logger> allLogger = CmsLog4jUtil.getAllLoggers();
109            List<Appender> allAppender = new ArrayList<Appender>();
110
111            allLogger.add(0, (Logger)LogManager.getRootLogger());
112
113            for (Logger logger : allLogger) {
114
115                for (Appender appender : logger.getAppenders().values()) {
116                    if (CmsLogFileApp.isFileAppender(appender)) {
117                        if (!allAppender.contains(appender)) {
118                            allAppender.add(appender);
119                        }
120
121                    }
122                }
123            }
124
125            for (File file : CmsLogFileOptionProvider.getLogFiles()) {
126                if (!file.getAbsolutePath().endsWith(".zip")) {
127                    m_logfile.addItem(file.getAbsolutePath());
128                }
129            }
130
131            m_logfile.setFilteringMode(FilteringMode.CONTAINS);
132
133            m_logView = (CmsRfsFileViewer)OpenCms.getWorkplaceManager().getFileViewSettings().clone();
134            m_logView.setAdditionalRoots(CmsLogFileOptionProvider.getAdditionalLogDirectories());
135
136            m_logView.setWindowSize(WINDOW_SIZE);
137
138            if (CmsVaadinUtils.getRequest().getSession().getAttribute(ATTR_FILE_VIEW_SIZE) == null) {
139                CmsVaadinUtils.getRequest().getSession().setAttribute(
140                    ATTR_FILE_VIEW_SIZE,
141                    String.valueOf(m_logView.getWindowSize()));
142            }
143
144            if (CmsVaadinUtils.getRequest().getSession().getAttribute(ATTR_FILE_VIEW_CHARSET) == null) {
145                Charset defaultCs = Charset.forName(new OutputStreamWriter(new ByteArrayOutputStream()).getEncoding());
146                CmsVaadinUtils.getRequest().getSession().setAttribute(ATTR_FILE_VIEW_CHARSET, defaultCs);
147            }
148
149            if (CmsVaadinUtils.getRequest().getSession().getAttribute(ATTR_FILE_VIEW_PATH) != null) {
150                m_logfile.select(CmsVaadinUtils.getRequest().getSession().getAttribute(ATTR_FILE_VIEW_PATH));
151            } else {
152                selectLogFile(allAppender, m_logView.getFilePath());
153            }
154
155            m_logfile.setNullSelectionAllowed(false);
156            m_logfile.setNewItemsAllowed(false);
157
158            m_logfile.addValueChangeListener(new ValueChangeListener() {
159
160                private static final long serialVersionUID = 1899253995224124911L;
161
162                public void valueChange(ValueChangeEvent event) {
163
164                    CmsVaadinUtils.getRequest().getSession().setAttribute(ATTR_FILE_VIEW_PATH, getCurrentFile());
165                    updateView();
166                }
167            });
168
169            updateView();
170            //            m_fileContent.setHeight("700px");
171            m_fileContent.addStyleName("v-scrollable");
172            m_fileContent.addStyleName("o-report");
173        }
174    }
175
176    /**
177     * Gets currently shown file.<p>
178     *
179     * @return path of shown file
180     */
181    protected String getCurrentFile() {
182
183        return (String)m_logfile.getValue();
184    }
185
186    /**
187     * Updates the log file view after changes.<p>
188     */
189    protected void updateView() {
190
191        if (CmsLogFileApp.LOG_FOLDER.isEmpty()) {
192            return;
193        }
194
195        try {
196            m_logView.setFilePath((String)m_logfile.getValue());
197            m_logView.setWindowSize(getSize());
198            m_logView.setFileEncoding(getChar());
199            String content = "<pre style='line-height:1.1;'>";
200            content += m_logView.readFilePortion();
201            content += "</pre>";
202            m_fileContent.setValue(content);
203            m_panelComp.setScrollTop(100000000);
204        } catch (CmsRfsException e) {
205            LOG.error(e.getLocalizedMessage(), e);
206        }
207
208    }
209
210    /**
211     * Gets  the char set.<p>
212     *
213     * @return the name of the charset
214     */
215    private String getChar() {
216
217        return ((Charset)CmsVaadinUtils.getRequest().getSession().getAttribute(ATTR_FILE_VIEW_CHARSET)).name();
218    }
219
220    /**
221     * Gets the size to be displayed.<p>
222     *
223     * @return line number
224     */
225    private int getSize() {
226
227        return Integer.valueOf(
228            (String)CmsVaadinUtils.getRequest().getSession().getAttribute(ATTR_FILE_VIEW_SIZE)).intValue();
229    }
230
231    /**
232     * Selects the currently set log file.<p>
233     *
234     * @param appender all given appender
235     * @param filePath of log file
236     */
237    private void selectLogFile(List<Appender> appender, String filePath) {
238
239        for (Appender app : appender) {
240
241            String fileName = CmsLogFileApp.getFileName(app);
242            if ((fileName != null) && fileName.equals(filePath)) {
243                m_logfile.select(fileName);
244                return;
245            }
246        }
247        if (!appender.isEmpty()) {
248            Appender app = appender.get(0);
249            String fileName = CmsLogFileApp.getFileName(app);
250            if (fileName != null) {
251                m_logfile.select(fileName); //Default, take file from root appender
252            }
253        }
254    }
255}