/* Copyright 2004-2014 Jim Voris
*
* Licensed 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 com.qumasoft.guitools.qwin.operation;
import com.qumasoft.guitools.qwin.dialog.AddFileDialog;
import com.qumasoft.guitools.qwin.dialog.ProgressDialog;
import com.qumasoft.guitools.qwin.QWinFrame;
import com.qumasoft.guitools.qwin.QWinUtility;
import com.qumasoft.qvcslib.AbstractProjectProperties;
import com.qumasoft.qvcslib.ArchiveAttributes;
import com.qumasoft.qvcslib.ArchiveDirManagerInterface;
import com.qumasoft.qvcslib.ArchiveDirManagerProxy;
import com.qumasoft.qvcslib.ClientTransactionManager;
import com.qumasoft.qvcslib.ExtensionAttributeProperties;
import com.qumasoft.qvcslib.KeywordExpansionContext;
import com.qumasoft.qvcslib.KeywordManagerFactory;
import com.qumasoft.qvcslib.KeywordManagerInterface;
import com.qumasoft.qvcslib.LogFileHeaderInfo;
import com.qumasoft.qvcslib.commandargs.CreateArchiveCommandArgs;
import com.qumasoft.qvcslib.LogfileInfo;
import com.qumasoft.qvcslib.MergedInfoInterface;
import com.qumasoft.qvcslib.QVCSConstants;
import com.qumasoft.qvcslib.QVCSException;
import com.qumasoft.qvcslib.RevisionHeader;
import com.qumasoft.qvcslib.RevisionInformation;
import com.qumasoft.qvcslib.TransportProxyInterface;
import com.qumasoft.qvcslib.UserLocationProperties;
import com.qumasoft.qvcslib.Utility;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.atomic.AtomicReference;
import java.util.logging.Level;
import javax.swing.JTable;
/**
* Create an archive file; populate with first revision.
* @author Jim Voris
*/
public class OperationCreateArchive extends OperationBaseClass {
private final boolean useDialogFlag;
/**
* Create a create archive operation.
* @param fileTable the file table.
* @param serverName the server name.
* @param projectName the project name.
* @param viewName the view name.
* @param userLocationProperties user location properties.
* @param flag use the dialog or not.
*/
public OperationCreateArchive(JTable fileTable, final String serverName, final String projectName, final String viewName, UserLocationProperties userLocationProperties,
boolean flag) {
super(fileTable, serverName, projectName, viewName, userLocationProperties);
useDialogFlag = flag;
}
@Override
public void executeOperation() {
if (getFileTable() != null) {
try {
List mergedInfoArray = getSelectedFiles();
if (mergedInfoArray.size() > 0) {
if (useDialogFlag) {
AddFileDialog addFileDialog = new AddFileDialog(QWinFrame.getQWinFrame(), mergedInfoArray, QWinFrame.getQWinFrame().getCheckinComments(), this);
addFileDialog.setVisible(true);
} else {
// Don't use a dialog. Just create the archive file.
CreateArchiveCommandArgs commandArgs = new CreateArchiveCommandArgs();
commandArgs.setArchiveDescription("");
commandArgs.setLockFlag(false);
commandArgs.setCommentPrefix("");
completeOperation(mergedInfoArray, commandArgs);
}
}
} catch (Exception e) {
QWinUtility.logProblem(Level.WARNING, "Error creating archive. Caught exception: " + e.getClass().toString() + " " + e.getLocalizedMessage());
QWinUtility.logProblem(Level.WARNING, Utility.expandStackTraceToString(e));
}
}
}
/**
* Process the dialog choices.
* @param mergedInfoArray the list of files to operate on.
* @param commandArgs the command arguments.
*/
public void completeOperation(final List mergedInfoArray, final CreateArchiveCommandArgs commandArgs) {
// Display the progress dialog.
final ProgressDialog progressMonitor = createProgressDialog("Creating QVCS archives ", mergedInfoArray.size());
Runnable worker = new Runnable() {
@Override
public void run() {
TransportProxyInterface transportProxy = null;
int transactionID = 0;
try {
int size = mergedInfoArray.size();
for (int i = 0; i < size; i++) {
if (progressMonitor.getIsCancelled()) {
break;
}
MergedInfoInterface mergedInfo = (MergedInfoInterface) mergedInfoArray.get(i);
if (i == 0) {
ArchiveDirManagerInterface archiveDirManager = mergedInfo.getArchiveDirManager();
ArchiveDirManagerProxy archiveDirManagerProxy = (ArchiveDirManagerProxy) archiveDirManager;
transportProxy = archiveDirManagerProxy.getTransportProxy();
transactionID = ClientTransactionManager.getInstance().sendBeginTransaction(transportProxy);
}
if (mergedInfo.getWorkfileInfo() == null) {
QWinUtility.logProblem(Level.INFO, "Workfile does not exist: " + mergedInfo.getShortWorkfileName());
continue;
}
// Do not request an add if the file is in the cemetery.
String appendedPath = mergedInfo.getArchiveDirManager().getAppendedPath();
if (0 == appendedPath.compareTo(QVCSConstants.QVCS_CEMETERY_DIRECTORY)) {
QWinUtility.logProblem(Level.INFO, "Create archive request for cemetery file ignored for " + mergedInfo.getShortWorkfileName());
continue;
}
// Do not request an add if the file is in branch archives directory.
if (0 == appendedPath.compareTo(QVCSConstants.QVCS_BRANCH_ARCHIVES_DIRECTORY)) {
QWinUtility.logProblem(Level.INFO, "Create archive request for branch archives directory file ignored for " + mergedInfo.getShortWorkfileName());
continue;
}
// Update the progress monitor.
OperationBaseClass.updateProgressDialog(i, "Creating archive for: " + mergedInfo.getShortWorkfileName(), progressMonitor);
String fullWorkfileName = mergedInfo.getWorkfileInfo().getFullWorkfileName();
// It only makes sense to create an archive if one doesn't already exist
if (mergedInfo.getArchiveInfo() == null) {
// The command args
CreateArchiveCommandArgs currentCommandArgs = new CreateArchiveCommandArgs();
currentCommandArgs.setArchiveDescription(commandArgs.getArchiveDescription());
currentCommandArgs.setCommentPrefix(commandArgs.getCommentPrefix());
currentCommandArgs.setLockFlag(commandArgs.getLockFlag());
currentCommandArgs.setAttributes(commandArgs.getAttributes());
currentCommandArgs.setInputfileTimeStamp(mergedInfo.getWorkfileInfo().getWorkfileLastChangedDate());
currentCommandArgs.setUserName(mergedInfo.getUserName());
currentCommandArgs.setWorkfileName(fullWorkfileName);
// Create a File associated with the File we check in
File createInFile = mergedInfo.getWorkfileInfo().getWorkfile();
if (mergedInfo.getIsRemote()) {
String keywordContractedFileName = fullWorkfileName;
ArchiveAttributes attributes = commandArgs.getAttributes();
if (attributes == null) {
attributes = ExtensionAttributeProperties.getInstance().getAttributes(fullWorkfileName);
}
if (attributes.getIsExpandKeywords()) {
AtomicReference<String> checkInComment = new AtomicReference<>();
if (!attributes.getIsBinaryfile()) {
keywordContractedFileName = contractKeywords(fullWorkfileName, checkInComment, mergedInfo);
} else {
keywordContractedFileName = contractBinaryKeywords(fullWorkfileName, mergedInfo, attributes);
}
}
if (mergedInfo.getArchiveDirManager().createArchive(currentCommandArgs, keywordContractedFileName, null)) {
// This is where I would log the success to the status pane.
QWinUtility.logProblem(Level.INFO, mergedInfo.getUserName() + " requested creation of archive for '" + fullWorkfileName + "' on server.");
}
} else {
QWinUtility.logProblem(Level.WARNING, "Local create archive operation not supported!!");
}
}
}
} catch (QVCSException | IOException e) {
QWinUtility.logProblem(Level.WARNING, "Caught exception in operationAdd: " + e.getClass().toString() + ": " + e.getLocalizedMessage());
} finally {
progressMonitor.close();
ClientTransactionManager.getInstance().sendEndTransaction(transportProxy, transactionID);
}
}
};
// Put all this on a separate worker thread.
new Thread(worker).start();
}
private String contractKeywords(String fullWorkfileName, AtomicReference<String> checkInComment, MergedInfoInterface mergedInfo) {
FileInputStream inStream = null;
FileOutputStream outStream = null;
String keywordContractedFileName = fullWorkfileName;
try {
File workfile = new File(fullWorkfileName);
inStream = new FileInputStream(workfile);
File contractedOutputFile = File.createTempFile("QVCS", "tmp");
contractedOutputFile.deleteOnExit();
outStream = new FileOutputStream(contractedOutputFile);
keywordContractedFileName = contractedOutputFile.getCanonicalPath();
KeywordManagerInterface keywordManager = KeywordManagerFactory.getInstance().getKeywordManager();
keywordManager.contractKeywords(inStream, outStream, checkInComment, mergedInfo.getProjectProperties(), mergedInfo.getBinaryFileAttribute());
} catch (QVCSException | IOException e) {
QWinUtility.logProblem(Level.WARNING, e.getLocalizedMessage());
} finally {
try {
if (inStream != null) {
inStream.close();
}
if (outStream != null) {
outStream.close();
}
} catch (IOException e) {
QWinUtility.logProblem(Level.WARNING, e.getLocalizedMessage());
}
}
return keywordContractedFileName;
}
private String contractBinaryKeywords(String fullWorkfileName, MergedInfoInterface mergedInfo, ArchiveAttributes attributes) {
FileInputStream inStream = null;
FileOutputStream outStream = null;
String keywordContractedFileName = fullWorkfileName;
try {
File workfile = new File(fullWorkfileName);
inStream = new FileInputStream(workfile);
File contractedOutputFile = File.createTempFile("QVCS", "tmp");
contractedOutputFile.deleteOnExit();
outStream = new FileOutputStream(contractedOutputFile);
keywordContractedFileName = contractedOutputFile.getCanonicalPath();
AbstractProjectProperties projectProperties = mergedInfo.getArchiveDirManager().getProjectProperties();
// Gin up a fake logfileInfo object.
LogFileHeaderInfo bogusHeaderInfo = new LogFileHeaderInfo();
bogusHeaderInfo.getLogFileHeader().setAttributes(attributes);
RevisionInformation bogusRevisionInformation = new RevisionInformation(1, projectProperties.getInitialArchiveAccessList(),
projectProperties.getInitialArchiveAccessList());
bogusRevisionInformation.updateRevision(0, new RevisionHeader(projectProperties.getInitialArchiveAccessList(), projectProperties.getInitialArchiveAccessList()));
LogfileInfo bogusLogfileInfo = new LogfileInfo(bogusHeaderInfo, bogusRevisionInformation, -1, fullWorkfileName);
KeywordManagerInterface keywordManager = KeywordManagerFactory.getInstance().getNewKeywordManager();
KeywordExpansionContext keywordExpansionContext = new KeywordExpansionContext(outStream, contractedOutputFile, bogusLogfileInfo, 0, "", "", projectProperties);
keywordExpansionContext.setBinaryFileFlag(true);
keywordManager.expandKeywords(inStream, keywordExpansionContext);
} catch (QVCSException | IOException e) {
QWinUtility.logProblem(Level.WARNING, e.getLocalizedMessage());
keywordContractedFileName = fullWorkfileName;
} finally {
try {
if (inStream != null) {
inStream.close();
}
if (outStream != null) {
outStream.close();
}
} catch (IOException e) {
QWinUtility.logProblem(Level.WARNING, e.getLocalizedMessage());
}
}
return keywordContractedFileName;
}
}