#region GNU General Public License
//
// NAntContrib
// Copyright (C) 2001-2003 Gerry Shaw
//
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
// Jason Reimer, Diversant Inc. (jason.reimer@diversant.net)
#endregion
using System;
using System.IO;
using SourceSafeTypeLib;
using NAnt.Core;
using NAnt.Core.Attributes;
namespace NAnt.Contrib.Tasks.SourceSafe{
/// <summary>
/// Used to checkin files into Visual Source Safe.
/// </summary>
/// <example>
/// <para>Checkin all files from an absolute directory to a local sourcesafe database.</para>
/// <code><![CDATA[
/// <vsscheckin
/// user="myusername"
/// password="mypassword"
/// localpath="C:\Dev\Latest"
/// recursive="true"
/// writable="true"
/// dbpath="C:\VSS\srcsafe.ini"
/// path="$/MyProduct"
/// comment="NAnt checkin"
/// />
/// ]]></code>
/// </example>
/// <example>
/// <para>Checkin a file from a relative directory to a remote sourcesafe database.</para>
/// <code><![CDATA[
/// <vsscheckin
/// user="myusername"
/// password="mypassword"
/// localpath="Latest\myFile.cs"
/// recursive="false"
/// writable="true"
/// dbpath="\\MyServer\VSS\srcsafe.ini"
/// path="$/MyProduct/myFile.cs"
/// comment="NAnt checkin"
/// />
/// ]]></code>
/// </example>
[TaskName("vsscheckin")]
public sealed class CheckinTask : BaseTask {
#region Private Instance Fields
private string _comment = "";
private DirectoryInfo _localPath;
private bool _recursive = true;
private bool _writable;
#endregion Private Instance Fields
#region Public Instance Properties
/// <summary>
/// The comment for the new version.
/// </summary>
[TaskAttribute("comment")]
public string Comment {
get { return _comment; }
set { _comment = value; }
}
/// <summary>
/// The path to the local working directory.
/// </summary>
[TaskAttribute("localpath", Required=true)]
public DirectoryInfo LocalPath {
get { return _localPath; }
set { _localPath = value; }
}
/// <summary>
/// Determines whether to perform a recursive checkin.
/// The default is <see langword="true" />.
/// </summary>
[TaskAttribute("recursive")]
[BooleanValidator()]
public bool Recursive {
get { return _recursive; }
set { _recursive = value; }
}
/// <summary>
/// Determines whether to leave the file(s) as writable.
/// The default is <see langword="false" />.
/// </summary>
[TaskAttribute("writable")]
[BooleanValidator()]
public bool Writable {
get { return _writable; }
set { _writable = value; }
}
#endregion Public Instance Properties
protected override void ExecuteTask() {
Open();
/* -- Allowed flag categories --
* RECURS, USERO, CMPMETHOD, TIMESTAMP, EOL, REPLACE, FORCE,
* KEEPCHECK, DEL, and UPD
*/
int flags = (Recursive ? Convert.ToInt32(RecursiveFlag) : 0) |
(Writable ? Convert.ToInt32(VSSFlags.VSSFLAG_USERRONO) : Convert.ToInt32(VSSFlags.VSSFLAG_USERROYES));
try {
Item.Checkin(Comment, LocalPath.FullName, flags);
} catch (Exception ex) {
throw new BuildException("The check-in operation failed.",
Location, ex);
}
Log(Level.Info, "Checked in '{0}'.", Path);
}
}
}
|