package org.jetbrains.idea.svn.properties;
import com.intellij.openapi.diagnostic.Attachment;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.vcs.VcsException;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.idea.svn.SvnUtil;
import org.jetbrains.idea.svn.api.BaseSvnClient;
import org.jetbrains.idea.svn.api.Depth;
import org.jetbrains.idea.svn.commandLine.*;
import org.jetbrains.idea.svn.info.Info;
import org.tmatesoft.svn.core.SVNErrorCode;
import org.tmatesoft.svn.core.SVNException;
import org.tmatesoft.svn.core.SVNURL;
import org.tmatesoft.svn.core.wc.SVNRevision;
import org.tmatesoft.svn.core.wc2.SvnTarget;
import javax.xml.bind.JAXBException;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlValue;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
/**
* @author Konstantin Kolosovsky.
*/
public class CmdPropertyClient extends BaseSvnClient implements PropertyClient {
private static final Logger LOG = Logger.getInstance(CmdPropertyClient.class);
@Nullable
@Override
public PropertyValue getProperty(@NotNull SvnTarget target,
@NotNull String property,
boolean revisionProperty,
@Nullable SVNRevision revision)
throws VcsException {
List<String> parameters = new ArrayList<>();
parameters.add(property);
if (!revisionProperty) {
CommandUtil.put(parameters, target);
CommandUtil.put(parameters, revision);
} else {
// currently revision properties are returned only for file targets
assertFile(target);
// "svn propget --revprop" treats '@' symbol at file path end as part of the path - so here we manually omit adding '@' at the end
CommandUtil.put(parameters, target, false);
parameters.add("--revprop");
CommandUtil.put(parameters, resolveRevisionNumber(target.getFile(), revision));
}
// always use --xml option here - this allows to determine if property exists with empty value or property does not exist, which
// is critical for some parts of merge logic
parameters.add("--xml");
PropertyData data = null;
try {
CommandExecutor command = execute(myVcs, target, SvnCommandName.propget, parameters, null);
data = parseSingleProperty(target, command);
}
catch (SvnBindException e) {
if (!isPropertyNotFoundError(e)) {
throw e;
}
}
return data != null ? data.getValue() : null;
}
@Override
public void getProperty(@NotNull SvnTarget target,
@NotNull String property,
@Nullable SVNRevision revision,
@Nullable Depth depth,
@Nullable PropertyConsumer handler) throws VcsException {
List<String> parameters = new ArrayList<>();
parameters.add(property);
fillListParameters(target, revision, depth, parameters, false);
try {
CommandExecutor command = execute(myVcs, target, SvnCommandName.propget, parameters, null);
parseOutput(target, command, handler);
}
catch (SvnBindException e) {
if (!isPropertyNotFoundError(e)) {
throw e;
}
}
}
@Override
public void list(@NotNull SvnTarget target,
@Nullable SVNRevision revision,
@Nullable Depth depth,
@Nullable PropertyConsumer handler) throws VcsException {
List<String> parameters = new ArrayList<>();
fillListParameters(target, revision, depth, parameters, true);
CommandExecutor command = execute(myVcs, target, SvnCommandName.proplist, parameters, null);
parseOutput(target, command, handler);
}
@Override
public void setProperty(@NotNull File file,
@NotNull String property,
@Nullable PropertyValue value,
@Nullable Depth depth,
boolean force) throws VcsException {
runSetProperty(SvnTarget.fromFile(file), property, null, depth, value, force);
}
@Override
public void setProperties(@NotNull File file, @NotNull PropertiesMap properties) throws VcsException {
PropertiesMap currentProperties = collectPropertiesToDelete(file);
currentProperties.putAll(properties);
for (Map.Entry<String, PropertyValue> entry : currentProperties.entrySet()) {
setProperty(file, entry.getKey(), entry.getValue(), Depth.EMPTY, true);
}
}
/**
* Such error is thrown (if there is no requested property on the given target) by svn 1.9 client.
*/
private static boolean isPropertyNotFoundError(@NotNull SvnBindException e) {
return e.contains(SVNErrorCode.BASE) && e.contains(SVNErrorCode.PROPERTY_NOT_FOUND);
}
@NotNull
private PropertiesMap collectPropertiesToDelete(@NotNull File file) throws VcsException {
final PropertiesMap result = new PropertiesMap();
list(SvnTarget.fromFile(file), null, Depth.EMPTY, new PropertyConsumer() {
@Override
public void handleProperty(File path, PropertyData property) throws SVNException {
// null indicates property will be deleted
result.put(property.getName(), null);
}
@Override
public void handleProperty(SVNURL url, PropertyData property) throws SVNException {
}
@Override
public void handleProperty(long revision, PropertyData property) throws SVNException {
}
});
return result;
}
@Override
public void setRevisionProperty(@NotNull SvnTarget target,
@NotNull String property,
@NotNull SVNRevision revision,
@Nullable PropertyValue value,
boolean force) throws VcsException {
runSetProperty(target, property, revision, null, value, force);
}
private void runSetProperty(@NotNull SvnTarget target,
@NotNull String property,
@Nullable SVNRevision revision,
@Nullable Depth depth,
@Nullable PropertyValue value,
boolean force) throws VcsException {
boolean isDelete = value == null;
Command command = newCommand(isDelete ? SvnCommandName.propdel : SvnCommandName.propset);
command.put(property);
if (revision != null) {
command.put("--revprop");
command.put(revision);
}
if (!isDelete) {
command.setPropertyValue(value);
// --force could only be used in "propset" command, but not in "propdel" command
command.put("--force", force);
}
command.put(target);
command.put(depth);
execute(myVcs, target, null, command, null);
}
private void fillListParameters(@NotNull SvnTarget target,
@Nullable SVNRevision revision,
@Nullable Depth depth,
@NotNull List<String> parameters,
boolean verbose) {
CommandUtil.put(parameters, target);
CommandUtil.put(parameters, revision);
CommandUtil.put(parameters, depth);
parameters.add("--xml");
CommandUtil.put(parameters, verbose, "--verbose");
}
@Nullable
private PropertyData parseSingleProperty(SvnTarget target, @NotNull CommandExecutor command) throws VcsException {
final PropertyData[] data = new PropertyData[1];
PropertyConsumer handler = new PropertyConsumer() {
@Override
public void handleProperty(File path, PropertyData property) throws SVNException {
data[0] = property;
}
@Override
public void handleProperty(SVNURL url, PropertyData property) throws SVNException {
data[0] = property;
}
@Override
public void handleProperty(long revision, PropertyData property) throws SVNException {
data[0] = property;
}
};
parseOutput(target, command, handler);
return data[0];
}
private static void parseOutput(SvnTarget target, @NotNull CommandExecutor command, PropertyConsumer handler) throws VcsException {
try {
Properties properties = CommandUtil.parse(command.getOutput(), Properties.class);
if (properties != null) {
for (Target childInfo : properties.targets) {
SvnTarget childTarget = SvnUtil.append(target, childInfo.path);
for (Property property : childInfo.properties) {
invokeHandler(childTarget, create(property.name, property.value), handler);
}
}
if (properties.revisionProperties != null) {
for (Property property : properties.revisionProperties.properties) {
invokeHandler(properties.revisionProperties.revisionNumber(), create(property.name, property.value), handler);
}
}
}
}
catch (JAXBException e) {
LOG.error("Could not parse properties. Command: " + command.getCommandText() + ", Warning: " + command.getErrorOutput(),
new Attachment("output.xml", command.getOutput()));
throw new VcsException(e);
}
catch (SVNException e) {
throw new VcsException(e);
}
}
private static void invokeHandler(@NotNull SvnTarget target, @Nullable PropertyData data, @Nullable PropertyConsumer handler)
throws SVNException {
if (handler != null && data != null) {
if (target.isFile()) {
handler.handleProperty(target.getFile(), data);
} else {
handler.handleProperty(target.getURL(), data);
}
}
}
private static void invokeHandler(long revision, @Nullable PropertyData data, @Nullable PropertyConsumer handler)
throws SVNException {
if (handler != null && data != null) {
handler.handleProperty(revision, data);
}
}
@Nullable
private static PropertyData create(@NotNull String property, @Nullable String value) {
PropertyData result = null;
// such behavior is required to compatibility with SVNKit as some logic in merge depends on
// whether null property data or property data with empty string value is returned
if (value != null) {
result = new PropertyData(property, PropertyValue.create(value.trim()));
}
return result;
}
private SVNRevision resolveRevisionNumber(@NotNull File path, @Nullable SVNRevision revision) throws VcsException {
long result = revision != null ? revision.getNumber() : -1;
// base should be resolved manually - could not set revision to BASE to get revision property
if (SVNRevision.BASE.equals(revision)) {
Info info = myVcs.getInfo(path, SVNRevision.BASE);
result = info != null ? info.getRevision().getNumber() : -1;
}
if (result == -1) {
throw new VcsException("Could not determine revision number for file " + path + " and revision " + revision);
}
return SVNRevision.create(result);
}
@XmlRootElement(name = "properties")
public static class Properties {
@XmlElement(name = "target")
public List<Target> targets = new ArrayList<>();
@XmlElement(name = "revprops")
public RevisionProperties revisionProperties;
}
public static class Target {
@XmlAttribute(name = "path")
public String path;
@XmlElement(name = "property")
public List<Property> properties = new ArrayList<>();
}
public static class RevisionProperties {
@XmlAttribute(name = "rev")
public String revision;
@XmlElement(name = "property")
public List<Property> properties = new ArrayList<>();
public long revisionNumber() {
return Long.valueOf(revision);
}
}
public static class Property {
@XmlAttribute(name = "name")
public String name;
@XmlValue
public String value;
}
}