001: /*
002: * File : $Source: /usr/local/cvs/opencms/src/org/opencms/workplace/threads/CmsRelationsValidatorThread.java,v $
003: * Date : $Date: 2008-02-27 12:05:43 $
004: * Version: $Revision: 1.4 $
005: *
006: * This library is part of OpenCms -
007: * the Open Source Content Management System
008: *
009: * Copyright (c) 2002 - 2008 Alkacon Software GmbH (http://www.alkacon.com)
010: *
011: * This library is free software; you can redistribute it and/or
012: * modify it under the terms of the GNU Lesser General Public
013: * License as published by the Free Software Foundation; either
014: * version 2.1 of the License, or (at your option) any later version.
015: *
016: * This library is distributed in the hope that it will be useful,
017: * but WITHOUT ANY WARRANTY; without even the implied warranty of
018: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019: * Lesser General Public License for more details.
020: *
021: * For further information about Alkacon Software GmbH, please see the
022: * company website: http://www.alkacon.com
023: *
024: * For further information about OpenCms, please see the
025: * project website: http://www.opencms.org
026: *
027: * You should have received a copy of the GNU Lesser General Public
028: * License along with this library; if not, write to the Free Software
029: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
030: */
031:
032: package org.opencms.workplace.threads;
033:
034: import org.opencms.db.CmsPublishList;
035: import org.opencms.file.CmsObject;
036: import org.opencms.main.CmsException;
037: import org.opencms.main.CmsLog;
038: import org.opencms.main.OpenCms;
039: import org.opencms.report.A_CmsReportThread;
040: import org.opencms.workplace.CmsWorkplaceSettings;
041:
042: import org.apache.commons.logging.Log;
043:
044: /**
045: * A report thread for the relations validator.<p>
046: *
047: * @version $Revision: 1.4 $
048: *
049: * @since 6.0.0
050: */
051: public class CmsRelationsValidatorThread extends A_CmsReportThread {
052:
053: /** The log object for this class. */
054: private static final Log LOG = CmsLog
055: .getLog(CmsRelationsValidatorThread.class);
056:
057: /** A list of cms resources to be published directly.<p> */
058: private CmsPublishList m_publishList;
059:
060: /** Flag that indicates whether the publish list should be svaed in the workplace settings. */
061: private boolean m_savePublishList;
062:
063: /** The current user's workplace settings.<p> */
064: private CmsWorkplaceSettings m_settings;
065:
066: /**
067: * Creates a thread that validates the relations for all files of the current project.<p>
068: *
069: * @param cms the current OpenCms context object
070: */
071: public CmsRelationsValidatorThread(CmsObject cms) {
072:
073: super (cms, Messages.get().getBundle().key(
074: Messages.GUI_HTML_LINK_VALIDATOR_THREAD_NAME_1,
075: new Object[] { cms.getRequestContext().currentProject()
076: .getName() }));
077:
078: m_publishList = null;
079: m_savePublishList = false;
080: m_settings = null;
081:
082: initHtmlReport(cms.getRequestContext().getLocale());
083: }
084:
085: /**
086: * Creates a thread that validates the relations in the list of unpublished file(s) of the
087: * current (offline) project.<p>
088: *
089: * The publish list *IS* saved in the current user's workplace settings for
090: * further processing by other threads. The last thread processing this publish list *MUST*
091: * ensure that the publish list gets removed from the current user's workplace settings!<p>
092: *
093: * @param cms the current OpenCms context object
094: * @param publishList the list of resources which will be directly published
095: * @param settings the current user's workplace settings
096: */
097: public CmsRelationsValidatorThread(CmsObject cms,
098: CmsPublishList publishList, CmsWorkplaceSettings settings) {
099:
100: super (cms, Messages.get().getBundle().key(
101: Messages.GUI_HTML_LINK_VALIDATOR_THREAD_NAME_1,
102: new Object[] { cms.getRequestContext().currentProject()
103: .getName() }));
104:
105: m_publishList = publishList;
106: if (m_publishList == null) {
107: try {
108: m_publishList = OpenCms.getPublishManager()
109: .getPublishList(cms);
110: } catch (CmsException e) {
111: // ignore
112: }
113: }
114: m_savePublishList = true;
115: m_settings = settings;
116:
117: initHtmlReport(cms.getRequestContext().getLocale());
118: }
119:
120: /**
121: * @see org.opencms.report.A_CmsReportThread#getReportUpdate()
122: */
123: public String getReportUpdate() {
124:
125: return getReport().getReportUpdate();
126: }
127:
128: /**
129: * @see java.lang.Runnable#run()
130: */
131: public void run() {
132:
133: try {
134: // validate the HTML links in the resources that actually get published
135: OpenCms.getPublishManager().validateRelations(getCms(),
136: m_publishList, getReport());
137:
138: if (m_savePublishList && (m_settings != null)) {
139: // save the publish list optionally to be processed by further workplace threads
140: m_settings.setPublishList(m_publishList);
141: }
142: } catch (Throwable e) {
143: if (m_savePublishList && (m_settings != null)) {
144: // overwrite the publish list in any case with null
145: m_settings.setPublishList(null);
146: }
147: getReport().println(e);
148: LOG.error(Messages.get().getBundle().key(
149: Messages.ERR_LINK_VALIDATION_0), e);
150: }
151: }
152: }
|