C# - Installer - Sample code to run batch file via custom action

[steve]

Hi all,

Here's some work in progress that should allow you to run a batch file as a
custom action in a VS deployment project. Yup I know you can use js or wsh,
but the target may not have either.. Essentially it's just a wrapper for the
Process class and a command interpreter.

Warning, it only partly works. I had wanted to pass in

(a) The name of the batch file (through "BatchFileName" ), and
(b) A set of arguements for the batch file (through "BatchFileArgs" )

via the CustomActionDat a property exposed in the VS designer

eg.

/BatchFileName="[TARGETDIR]\InstallThirdPa rty.bat"

Unfortunately, I can't find a way to pass embedded double-quote characters
through BatchFileArgs. Passing embedded quotes is necessary when the
arguements represent paths with embedded spaces.. I'd love to know if anyone
has a workaround.

using System;
using System.Collecti ons;
using System.Componen tModel;
using System.Configur ation.Install;
using System.Diagnost ics;
using System.IO;

namespace InstallHelper
{
[RunInstaller(tr ue)]
public class BatchBootStrap : System.Configur ation.Install.I nstaller
{
Process mCmdInterpreter = new Process();

public override void Install(IDictio nary savedState)
{
Trace.WriteLine ("InstallHelper .BatchBootStrap .Install - enter");
string BatchFileName = Context.Paramet ers["BatchFileN ame"];

try
{
base.Install(sa vedState);

Path.IsPathRoot ed(BatchFileNam e); // throws ArgumentExcepti on if
BatchFileName contains any InvalidPathChar acters

if (!File.Exists(B atchFileName))
throw new Exception(strin g.Format("Batch file \"{0}\", does not
exist", BatchFileName)) ;

mCmdInterpreter .StartInfo.File Name =
Environment.Get EnvironmentVari able("ComSpec") ;

if (!File.Exists(m CmdInterpreter. StartInfo.FileN ame))
throw new Exception(strin g.Format("Comma nd interpreter \"{0}\" not
present, probably non standard or corrupted OS installation",
mCmdInterpreter .StartInfo.File Name));

string BatchFileArgs = Context.Paramet ers["BatchFileA rgs"];

// The ComSpec arguement format string supports space delimeted
double-quote framed args
// BatchFileArgs represents a space delimited list of arguements.
// Individual path / file name arguements that are passed via
BatchFileArgs must be "" framed if they contain spaces
// eg. BatchFileArgs could be the following '"C:\Test Dir\"
C:\TestDir2 123'
//

mCmdInterpreter .StartInfo.Argu ments = string.Format("/c \"\"{0}\"
{1}\"", BatchFileName, BatchFileArgs);
mCmdInterpreter .StartInfo.UseS hellExecute = false;
mCmdInterpreter .StartInfo.Redi rectStandardOut put = true;
//mCmdInterpreter .StartInfo.Redi rectStandardErr or = true;

mCmdInterpreter .Start();

Trace.WriteLine (string.Format( "InstallHelper. BatchBootStrap. Install
- Running batch file \"{0}\"\n Args ==> {1}", BatchFileName, BatchFileArgs)) ;
mCmdInterpreter .WaitForExit(); // blocking call

string StandardOutput = mCmdInterpreter .StandardOutput .ReadToEnd();
Trace.WriteLine (string.Format( "InstallHelper. BatchBootStrap. Install
- Batch file complete, output was as follows..\n{0}" , StandardOutput) );

string StandardOutputL ogFileName =
string.Format(" {0}.{1:yyyy_MM_ dd_a\\t_HH_mm_s s}.log", BatchFileName,
DateTime.Now);
Trace.WriteLine (string.Format( "InstallHelper. BatchBootStrap. Install
- Trying to log output to \"{0}\"", StandardOutputL ogFileName));

try
{
StreamWriter StandardOutputL og = new
StreamWriter(St andardOutputLog FileName);
StandardOutputL og.Write(Standa rdOutput);
StandardOutputL og.Flush();
StandardOutputL og.Close();
Trace.WriteLine (string.Format( "{0}",
"InstallHelper. BatchBootStrap. Install - log written successfully")) ;
}
catch (Exception LogErr)
{
Trace.WriteLine (string.Format(
"InstallHelper. BatchBootStrap. Install - An exception occurred
whilst trying to log output to \"{0}\", {1}\n Check user priviledge and
quotas.",
StandardOutputL ogFileName,
LogErr.Message) );
}
}
catch (Exception Err)
{
string DetailedErrMess age = string.Format(
"InstallHelper. BatchBootStrap. Install - A fatal exception occurred
whilst trying to run batch file \"{0}\". {1}",
BatchFileName,
Err.Message);
Trace.WriteLine (DetailedErrMes sage);
throw(new Exception(Detai ledErrMessage, Err));
}
finally
{
Trace.WriteLine ("InstallHelper .BatchBootStrap .Install - exit");
}
}

public BatchBootStrap( ) : base()
{
}
}
}

[Vadym Stetsyak]

"steve" <st***@discussi ons.microsoft.c om> wrote in message
news:88******** *************** ***********@mic rosoft.com...

Hi all,

Here's some work in progress that should allow you to run a batch file as
a
custom action in a VS deployment project. Yup I know you can use js or
wsh,
but the target may not have either.. Essentially it's just a wrapper for
the
Process class and a command interpreter.

Warning, it only partly works. I had wanted to pass in

(a) The name of the batch file (through "BatchFileName" ), and
(b) A set of arguements for the batch file (through "BatchFileArgs" )

via the CustomActionDat a property exposed in the VS designer

eg.

/BatchFileName="[TARGETDIR]\InstallThirdPa rty.bat"

Unfortunately, I can't find a way to pass embedded double-quote characters
through BatchFileArgs. Passing embedded quotes is necessary when the
arguements represent paths with embedded spaces.. I'd love to know if
anyone
has a workaround.
<skip>
string BatchFileArgs = Context.Paramet ers["BatchFileA rgs"];

// The ComSpec arguement format string supports space delimeted
double-quote framed args
// BatchFileArgs represents a space delimited list of arguements.
// Individual path / file name arguements that are passed via
BatchFileArgs must be "" framed if they contain spaces
// eg. BatchFileArgs could be the following '"C:\Test Dir\"
C:\TestDir2 123'
//

mCmdInterpreter .StartInfo.Argu ments = string.Format("/c \"\"{0}\"
{1}\"", BatchFileName, BatchFileArgs);

why doing so? if parameter ( BatchFileArgs ) has value "C:\test 123" adding
more double-quotes?

You can detect if there are double quotes in the BatchFileArgs, an
appropriately preprocess it ( add or remove double quotes )
--
Regards, Vadym Stetsyak
www: http://vadmyst.blogspot.com