/* -*- tab-width: 4 -*-
*
* Electric(tm) VLSI Design System
*
* File: CVSMenu.java
*
* Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved.
*
* Electric(tm) is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* Electric(tm) is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Electric(tm); see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, Mass 02111-1307, USA.
*/
package com.sun.electric.tool.cvspm;
import com.sun.electric.Main;
import com.sun.electric.database.hierarchy.Library;
import com.sun.electric.database.hierarchy.Cell;
import com.sun.electric.database.hierarchy.View;
import com.sun.electric.database.text.Pref;
import com.sun.electric.database.variable.VarContext;
import com.sun.electric.database.Snapshot;
import com.sun.electric.tool.user.User;
import com.sun.electric.tool.user.Exec;
import com.sun.electric.tool.user.dialogs.ModalCommandDialog;
import com.sun.electric.tool.user.dialogs.OpenFile;
import com.sun.electric.tool.user.ui.EditWindow;
import com.sun.electric.tool.user.ui.WindowFrame;
import com.sun.electric.tool.io.FileType;
import com.sun.electric.tool.io.output.DELIB;
import com.sun.electric.tool.Job;
import com.sun.electric.tool.Listener;
import com.sun.electric.util.TextUtils;
import javax.swing.*;
import java.io.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Iterator;
import java.net.URL;
/**
* The CVS Module
*/
public class CVS extends Listener {
private static CVS tool = new CVS();
private CVS() {
super("CVS");
}
public void init() {
setOn();
}
public static CVS getCVSTool() { return tool; }
/**
* Handles database changes of a Job.
* @param oldSnapshot database snapshot before Job.
* @param newSnapshot database snapshot after Job and constraint propagation.
* @param undoRedo true if Job was Undo/Redo job.
*/
public void endBatch(Snapshot oldSnapshot, Snapshot newSnapshot, boolean undoRedo)
{
if (!CVS.isEnabled()) return;
if (newSnapshot.tool == tool) return;
Edit.endBatch(oldSnapshot, newSnapshot, undoRedo);
}
public static void checkoutFromRepository() {
// get list of modules in repository
ByteArrayOutputStream out = new ByteArrayOutputStream();
runModalCVSCommand("-n checkout -c", "Getting modules in repository...", User.getWorkingDirectory(), out);
// this must come after the runModal command
LineNumberReader result = new LineNumberReader(new InputStreamReader(new ByteArrayInputStream(out.toByteArray())));
List<String> modules = new ArrayList<String>();
for (;;) {
String line = null;
try {
line = result.readLine();
} catch (IOException e) {
System.out.println(e.getMessage());
return;
}
if (line == null) break;
line = line.trim();
if (line.equals("")) continue;
String[] parts = line.split("\\s");
modules.add(parts[0]);
}
if (modules.size() == 0) {
System.out.println("No modules in CVS!");
return;
}
Object ret = JOptionPane.showInputDialog(Main.getCurrentJFrame(), "Choose Module to Checkout",
"Checkout Module...", JOptionPane.QUESTION_MESSAGE, null, modules.toArray(), modules.toArray()[0]);
if (ret == null) {
// user cancelled
return;
}
String module = (String)ret;
// choose directory to checkout to
String directory = OpenFile.chooseDirectory("Choose directory in which to checkout module "+module);
if (directory == null) {
// user cancelled
return;
}
// checkout module to current working directory
String cmd = "checkout "+module;
runModalCVSCommand(cmd, "Checking out '"+module+"' to "+directory, directory, System.out);
System.out.println("Checked out '"+module+"' to '"+directory+"'");
}
// ------------------------------------------------------------------------
/**
* This will run a CVS command in-thread; i.e. the current thread will
* block until the CVS command completes.
* @param cvsProgram the name of CVS program
* @param repository the path to cvs repositiry
* @param cmd the command to run
* @param comment the message to display on the dialog
* @param workingDir the directory in which to run the CVS command
* (null for current working directory). I recommend you specify
* this as the current library dir.
* @param out where the result of the command gets printed. May be
* a ByteArrayOutputStream for storing it, or just System.out for
* printing it.
* @return the exit value
*/
public static int runCVSCommand(String cvsProgram, String repository, String cmd, String comment, String workingDir, OutputStream out) {
String specifyRepository = "";
if (!repository.equals("")) specifyRepository = " -d"+repository;
String run = cvsProgram + specifyRepository +" "+cmd;
System.out.println(comment+": "+run);
Exec e = new Exec(run, null, new File(workingDir), out, out);
e.run();
return e.getExitVal();
}
/**
* Run this command if you have quotes ("") in your command that delimit a single
* argument. Normally exec breaks up the string command by whitespace, ignoring
* quotes. This command will preprocess the command to ensure it thinks of the
* string in quotes as one argument.
* @param cvsProgram the name of cvs program
* @param repository the path to cvs repositiry
* @param cmd the command to run
* @param comment the message to display on the dialog
* @param workingDir the directory in which to run the CVS command
* (null for current working directory). I recommend you specify
* this as the current library dir.
* @param out where the result of the command gets printed. May be
* a ByteArrayOutputStream for storing it, or just System.out for
* printing it.
* @return the exit value
*/
static int runCVSCommandWithQuotes(String cvsProgram, String repository, String cmd, String comment, String workingDir, OutputStream out) {
String specifyRepository = "";
if (!repository.equals("")) specifyRepository = " -d "+repository;
cmd = cvsProgram + specifyRepository + " " + cmd;
// break command into separate arguments
List<String> execparts = new ArrayList<String>();
String [] quoteParts = cmd.split("\"");
for (int i=0; i<quoteParts.length; i++) {
if (i % 2 == 0) {
// evens are not enclosed in quotes
String [] parts = quoteParts[i].trim().split("\\s+");
for (int j=0; j<parts.length; j++)
execparts.add(parts[j]);
} else {
// odds are enclosed in quotes
execparts.add(quoteParts[i]);
}
}
String [] exec = new String[execparts.size()];
for (int i=0; i<exec.length; i++) {
exec[i] = execparts.get(i);
// debug
//System.out.println(i+": "+exec[i]);
}
System.out.println(comment+": "+cmd);
Exec e = new Exec(exec, null, new File(workingDir), out, out);
e.run();
return e.getExitVal();
}
/**
* This will run a CVS command in a separate Thread and block the GUI until the command
* completes, or until the user hits 'cancel', which will try to
* terminate the external command. This method returns after
* the cvs command has completed.
* @param cmd the command to run
* @param comment the message to display on the dialog
* @param workingDir the directory in which to run the CVS command
* (null for current working directory). I recommend you specify
* this as the current library dir.
* @param out where the result of the command gets printed. May be
* a ByteArrayOutputStream for storing it, or just System.out for
* printing it.
*/
public static void runModalCVSCommand(String cmd, String comment, String workingDir, OutputStream out) {
String run = getCVSProgram() + " -d"+getRepository()+" "+cmd;
Exec e = new Exec(run, null, new File(workingDir), out, out);
// add a listener to get rid of the modal dialog when the command finishes
String message = "Running: "+run;
JFrame frame = (JFrame) Main.getCurrentJFrame();
ModalCommandDialog dialog = new ModalCommandDialog(frame, true, e, message, comment);
dialog.setVisible(true);
}
// -------------------------- Utility Commands --------------------------
public static void testModal() {
runModalCVSCommand("-n history -c -a", "testing command", User.getWorkingDirectory(), System.out);
}
/**
* Get the file for the given Cell, assuming the library is in DELIB format.
* @param cell the Cell being examined.
* @return the File for the Cell. If its library is not in DELIB format, returns null.
*/
public static File getCellFile(Cell cell) {
if (isDELIB(cell.getLibrary())) {
String relativeFile = DELIB.getCellFile(cell);
URL libFile = cell.getLibrary().getLibFile();
File file = TextUtils.getFile(libFile);
if (file == null) return null;
return new File(file, relativeFile);
}
return null;
}
public static boolean isDELIB(Library lib) {
return isDELIB(lib.getLibFile());
}
static boolean isDELIB(URL libFile) {
if (libFile == null) return false;
FileType type = OpenFile.getOpenFileType(libFile.getFile(), FileType.JELIB);
return (type == FileType.DELIB);
}
/**
* Returns true if this file has is being maintained from a
* CVS respository, returns false otherwise.
*/
public static boolean isFileInCVS(File fd) {
return isFileInCVS(fd, false, false);
}
/**
* Returns true if this file has is being maintained from a
* CVS respository, returns false otherwise.
*/
public static boolean isFileInCVS(File fd, boolean assertScheduledForAdd, boolean assertScheduledForRemove) {
// get directory file is in
if (fd == null) return false;
File parent = fd.getParentFile();
File CVSDIR = new File(parent, "CVS");
if (!CVSDIR.exists()) return false;
File entries = new File(CVSDIR, "Entries");
if (!entries.exists()) return false;
// make sure file is mentioned in Entries file
String filename = fd.getName();
boolean found = false;
FileReader fr = null;
try {
fr = new FileReader(entries);
LineNumberReader reader = new LineNumberReader(fr);
for (;;) {
String line = reader.readLine();
if (line == null) break;
if (line.equals("")) continue;
String parts[] = line.split("/");
if (parts.length >= 2 && parts[1].equals(filename)) {
// see if scheduled for add
if (assertScheduledForAdd) {
if (parts.length >= 3 && parts[2].equals("0")) {
found = true;
break;
} else {
break;
}
}
if (assertScheduledForRemove) {
if (parts.length >= 3 && parts[2].startsWith("-")) {
found = true;
break;
} else {
break;
}
}
found = true;
break;
}
}
fr.close();
} catch (IOException e) {
}
return found;
}
/**
* This checks the CVS Entries file to see if the library is in cvs (jelib/elib),
* or if the library dir + header file is in cvs (delib).
* @param lib
* @return true if the library is in cvs, false otherwise.
*/
public static boolean isInCVS(Library lib) {
return isInCVS(lib.getLibFile());
}
/**
* This checks the CVS Entries file to see if the library is in cvs (jelib/elib),
* or if the library dir + header file is in cvs (delib).
* @param fileURL
* @return true if the library is in cvs, false otherwise.
*/
static boolean isInCVS(URL fileURL) {
if (fileURL == null) return false; // new library not saved yet
File libfile = TextUtils.getFile(fileURL);
if (libfile == null) return false;
String libfilestr = libfile.getPath();
File libFile = new File(libfilestr);
if (isDELIB(fileURL)) {
// check both lib dir and header file
File header = new File(libFile, DELIB.getHeaderFile());
if (!isFileInCVS(libFile) || !isFileInCVS(header)) return false;
} else {
if (!isFileInCVS(libFile)) return false;
}
return true;
}
/**
* This checks the CVS Entries file to see if the cell is in cvs.
* If the cell belongs to a delib, it checks the cell file. Otherwise,
* it checks the library file for jelib/elibs.
* @param cell
* @return true if the cell is in cvs, false otherwise
*/
public static boolean isInCVS(Cell cell) {
if (!isDELIB(cell.getLibrary())) return isInCVS(cell.getLibrary());
// delibs have separate cell files
File cellFile = getCellFile(cell);
return isFileInCVS(cellFile);
}
/**
* Used by commands that require the library to be in sync with the disk.
* @param cell
* @param dialog true to pop up a dialog to tell the user, false to not do so.
* @return true if not modified, false if modified
*/
public static boolean assertNotModified(Cell cell, String cmd, boolean dialog) {
if (cell.isModified()) {
if (dialog) {
Job.getUserInterface().showErrorMessage("Cell "+cell.getName()+" must be saved to run CVS "+cmd, "CVS "+cmd);
} else {
System.out.println("Cell "+cell.getName()+" must be saved to run CVS "+cmd);
}
return false;
}
return true;
}
/**
* Returns true if the library is in CVS, otherwise generates an error message.
* @param lib the library to check
* @param cmd the CVS command (for error message display)
* @param dialog true to show a modal dialog, false to write error to message window
* @return true if it is in cvs, false otherwise
*/
public static boolean assertInCVS(Library lib, String cmd, boolean dialog) {
File libFile = new File(lib.getLibFile().getPath());
if (!CVS.isFileInCVS(libFile)) {
if (libFile.getPath().matches(".*?com.*?sun.*?electric.*?lib.*?spiceparts.*")) return false;
//if (libFile.getPath().indexOf("com/sun/electric/lib/spiceparts") != -1) return false;
String message = "Library "+lib.getName()+" is not part of CVS repository.\n" +
"Use 'CVS Add' to add to current repository.";
if (dialog) {
Job.getUserInterface().showErrorMessage(message, "CVS "+cmd+" Failed");
} else {
System.out.println(message+" CVS "+cmd+" Failed");
}
return false;
}
return true;
}
/**
* Returns true if the Cell is in CVS, otherwise generates an error message.
* @param cell the cell to check
* @param cmd the CVS command (for error message display)
* @param dialog true to show a modal dialog, false to write error to message window
* @return true if it is in cvs, false otherwise
*/
public static boolean assertInCVS(Cell cell, String cmd, boolean dialog) {
File cellFile = getCellFile(cell);
if (cellFile == null) {
String message = "Cell "+cell.libDescribe()+" is not part of CVS repository.\n" +
"Use 'CVS Add' to add to current repository.";
if (dialog) {
Job.getUserInterface().showErrorMessage(message, "CVS "+cmd+" Failed");
} else {
System.out.println(message+" CVS "+cmd+" Failed");
}
return false;
}
return true;
}
/**
* Issue an error message
* @param message
* @param title
* @param badLibs
* @param badCells
*/
public static void showError(String message, String title,
List<Library> badLibs, List<Cell> badCells) {
StringBuffer msg = new StringBuffer();
msg.append(message);
for (Library lib : badLibs) msg.append("\n Library "+lib.getName());
for (Cell cell : badCells) msg.append("\n Cell "+cell.noLibDescribe());
Job.getUserInterface().showErrorMessage(msg.toString(), title);
}
public static int askForChoice(String message, String title,
List<Library> badLibs, List<Cell> badCells,
String [] choices, String defaultChoice) {
StringBuffer msg = new StringBuffer();
msg.append(message);
for (Library lib : badLibs) msg.append("\n Library "+lib.getName());
for (Cell cell : badCells) msg.append("\n Cell "+cell.noLibDescribe());
return Job.getUserInterface().askForChoice(msg.toString(), title, choices, defaultChoice);
}
/**
* Get a command directory in which to run a CVS command on the given
* libraries and cells. This just picks the parent dir of
* the first library found.
* @param libs
* @param cells
* @return
*/
static String getUseDir(List<Library> libs, List<Cell> cells) {
if (libs != null) {
for (Library lib : libs) {
if (lib.isHidden()) continue;
if (!lib.isFromDisk()) continue;
File libFile = TextUtils.getFile(lib.getLibFile());
if (libFile == null) continue;
return libFile.getParent();
}
}
if (cells != null) {
for (Cell cell : cells) {
Library lib = cell.getLibrary();
if (lib.isHidden()) continue;
if (!lib.isFromDisk()) continue;
File libFile = TextUtils.getFile(lib.getLibFile());
if (libFile == null) continue;
return libFile.getParent();
}
}
return User.getWorkingDirectory();
}
/**
* Get a String of filenames for the associated libraries, to pass as the
* 'files' argument to a CVS command. Any files in 'useDir' will
* be relative names, otherwise they will be absolute file names.
* @param libs
* @return
*/
static StringBuffer getLibraryFiles(List<Library> libs, String useDir) {
StringBuffer libsBuf = new StringBuffer();
if (libs == null) return libsBuf;
for (Library lib : libs) {
File libFile = TextUtils.getFile(lib.getLibFile());
if (libFile == null) continue;
String file = libFile.getPath();
if (file.startsWith(useDir)) {
file = file.substring(useDir.length()+1, file.length());
}
libsBuf.append(file+" ");
}
return libsBuf;
}
/**
* Get header files for any cells that are in a delib, but
* whose delibs are not being committed.
* @param libs
* @param cells
* @param useDir
* @return
*/
static StringBuffer getHeaderFilesForCommit(List<Library> libs, List<Cell> cells, String useDir) {
if (libs == null) libs = new ArrayList<Library>();
if (cells == null) cells = new ArrayList<Cell>();
StringBuffer buf = new StringBuffer();
for (Cell cell : cells) {
if (libs.contains(cell.getLibrary())) continue;
if (!isDELIB(cell.getLibrary())) continue;
File libFile = TextUtils.getFile(cell.getLibrary().getLibFile());
if (libFile == null) continue;
String file = libFile.getPath();
if (file.startsWith(useDir)) {
file = file.substring(useDir.length()+1, file.length());
}
buf.append(file+File.separator+DELIB.getHeaderFile()+" ");
}
return buf;
}
/**
* Get a String of filenames for the associated cells, to pass as the
* 'files' argument to a CVS command. Any files in 'useDir' will
* be relative names, otherwise they will be absolute file names.
* @param cells
* @return
*/
static StringBuffer getCellFiles(List<Cell> cells, String useDir) {
StringBuffer cellsBuf = new StringBuffer();
if (cells == null) return cellsBuf;
for (Cell cell : cells) {
String file = getCellFile(cell).getPath();
if (file.startsWith(useDir)) {
file = file.substring(useDir.length()+1, file.length());
}
cellsBuf.append(file+" ");
}
return cellsBuf;
}
/**
* Get the Cell for the given path. The path is to be of the format
* .../libraryName.delib/cellname.view. Returns null if
* not of the correct format, if the library cannot be found, or
* if the cell cannot be found.
* @param path
* @return
*/
static Cell getCellFromPath(String path) {
int delibExt = path.toLowerCase().indexOf(".delib"+File.separator);
if (delibExt ==- 1) {
// try the unix file separator, since even on windows, the
// cvs command returns file paths with the unxi separator
delibExt = path.toLowerCase().indexOf(".delib/");
}
if (delibExt == -1) return null;
// get the library
String libpath = path.substring(0, delibExt);
File libFile = new File(libpath);
String libName = libFile.getName();
Library lib = Library.findLibrary(libName);
if (lib == null) return null;
// get cell file
File file = new File(path);
String cellFile = file.getName();
int ext = cellFile.lastIndexOf('.');
if (ext == -1) return null;
String cellName = cellFile.substring(0, ext);
String view = cellFile.substring(ext+1);
View realView = View.findView(view);
if (realView == null) return null;
Cell cell = lib.findNodeProto(cellName+"{"+view+"}");
return cell;
}
/**
* Get the library for the given header file plus path.
* This string should be of the format .../libraryName.delib/header.
* Returns null if not of the correct format,
* or if the library cannot be found.
* @param headerPath
* @return
*/
static Library getLibraryFromHeader(String headerPath) {
int delibExt = headerPath.toLowerCase().indexOf(".delib"+File.separator);
if (delibExt ==- 1) {
// try the unix file separator, since even on windows, the
// cvs command returns file paths with the unxi separator
delibExt = headerPath.toLowerCase().indexOf(".delib/");
}
if (delibExt == -1) return null;
// get the library
String libpath = headerPath.substring(0, delibExt);
File libFile = new File(libpath);
String filename = headerPath.substring(delibExt+7);
if (!filename.equals(DELIB.getHeaderFile()))
return null;
String libName = libFile.getName();
Library lib = Library.findLibrary(libName);
return lib;
}
/**
* Reloading libraries has the side affect that any EditWindows
* containing cells that were reloaded now point to old, unlinked
* cells instead of the new ones. This method checks for this state
* and fixes it.
*/
public static void fixStaleCellReferences(List<Library> libs) {
if (libs == null) return;
for (Library lib : libs) {
State state = CVSLibrary.getState(lib);
if (state == State.CONFLICT) {
Job.getUserInterface().showErrorMessage("Conflicts updating Library "+lib.getName()+", not reloading library", "CVS Update had Conflicts");
continue;
} else {
CVSLibrary.setState(lib, State.NONE);
}
fixStaleCellReferences(lib);
}
}
/**
* Reloading libraries has the side affect that any EditWindows
* containing cells that were reloaded now point to old, unlinked
* cells instead of the new ones. This method checks for this state
* and fixes it.
*/
public static void fixStaleCellReferences(Library reloadedLib) {
if (reloadedLib == null) return;
for (Iterator<WindowFrame> it = WindowFrame.getWindows(); it.hasNext(); ) {
WindowFrame frame = it.next();
if (frame.getContent() instanceof EditWindow) {
EditWindow wnd = (EditWindow)frame.getContent();
Cell cell = wnd.getCell();
if (cell == null) continue;
if (!cell.isLinked()) {
Library newLib = Library.findLibrary(cell.getLibrary().getName());
if (newLib == null) return;
Cell newCell = newLib.findNodeProto(cell.noLibDescribe());
if (newCell == null) return;
wnd.setCell(newCell, VarContext.globalContext, null);
}
}
}
}
// ------------------- Preferences --------------------
/**
* Get the repository. In the future, there may be some
* dialog to let the user choose between multiple respositories.
* @return
*/
static String getRepository() {
return getCVSRepository();
}
private static Pref cacheCVSEnabled = Pref.makeBooleanPref("CVS Enabled", User.getUserTool().prefs, false);
public static boolean isEnabled() { return cacheCVSEnabled.getBoolean(); }
public static void setEnabled(boolean b) { cacheCVSEnabled.setBoolean(b); }
public static boolean isFactoryEnabled() { return cacheCVSEnabled.getBooleanFactoryValue(); }
private static Pref cacheCVSProgram = Pref.makeStringPref("CVS Program", User.getUserTool().prefs, "cvs");
public static String getCVSProgram() { return cacheCVSProgram.getString(); }
public static void setCVSProgram(String s) { cacheCVSProgram.setString(s); }
public static String getFactoryCVSProgram() { return cacheCVSProgram.getStringFactoryValue(); }
private static Pref cacheCVSRepository = Pref.makeStringPref("CVS Repository", User.getUserTool().prefs, "");
public static String getCVSRepository() { return cacheCVSRepository.getString(); }
public static void setCVSRepository(String s) { cacheCVSRepository.setString(s); }
public static String getFactoryCVSRepository() { return cacheCVSRepository.getStringFactoryValue(); }
private static Pref cacheCVSLastCommitMessage = Pref.makeStringPref("CVS Last Commit Message", User.getUserTool().prefs, "");
public static String getCVSLastCommitMessage() { return cacheCVSLastCommitMessage.getString(); }
public static void setCVSLastCommitMessage(String s) { cacheCVSLastCommitMessage.setString(s); }
}