/// <summary>
/// Internal copy-job factory method. Used to coordinate all aspects of a job set-up,
/// which includes creating a copy manager, creating a job within it, setting download
/// parameters, and adding the job to our tracking collection for cleanup later
/// </summary>
/// <param name="copyManager">null reference to copy manager</param>
/// <param name="copyJob">null reference to copy job</param>
/// <param name="jobID">null reference to job id guid</param>
/// <param name="jobName">string. Job name</param>
/// <param name="jobDesc">string. Job description</param>
/// <param name="task">DownloadTask. Used to get infos about credentials, proxy, etc.</param>
private void CreateCopyJob(
IBackgroundCopyManager copyManager,
out IBackgroundCopyJob copyJob,
ref Guid jobID,
string jobName,
string jobDesc,
DownloadTask task)
{
// create the job, set its description, use "out" semantics to get jobid and the actual job object
copyManager.CreateJob(
jobName,
BG_JOB_TYPE.BG_JOB_TYPE_DOWNLOAD,
out jobID,
out copyJob);
// set useful description
copyJob.SetDescription(jobDesc);
// ***
// SET UP BITS JOB SETTINGS--TIMEOUTS/RETRY ETC
// SEE THE FOLLOWING REFERENCES:
// ** http://msdn.microsoft.com/library/default.asp?url=/library/en-us/bits/bits/IBackgroundCopyJob2_setminimumretrydelay.asp?frame=true
// ** http://msdn.microsoft.com/library/default.asp?url=/library/en-us/bits/bits/IBackgroundCopyJob2_setnoprogresstimeout.asp?frame=true
// ** http://msdn.microsoft.com/library/default.asp?url=/library/en-us/bits/bits/bg_job_priority.asp
// ***
// in constant set to 0; this makes BITS retry as soon as possible after an error
copyJob.SetMinimumRetryDelay(BitsMinimumRetryDelay);
// in constant set to 5 seconds; BITS will set job to Error status if exceeded
copyJob.SetNoProgressTimeout(BitsNoProgressTimeout);
// make this job the highest (but still background) priority--
copyJob.SetPriority(BG_JOB_PRIORITY.BG_JOB_PRIORITY_HIGH);
// ***
//----------------------------------------------------------------------
//-- Data Management and Research, Inc. - Paul Cox - 8/13/2004
//-- ADDED the following lines to verify credentials of file copy job
//----------------------------------------------------------------------
// Set credentials on the job
VerifyAndSetBackgroundCopyJobCredentials(copyJob, task);
// Set proxy infos (incl Proxy Auth.)
VerifyAndSetBackgroundCopyJobProxy(copyJob, task);
//----------------------------------------------------------------------
//-- End ADDED
//----------------------------------------------------------------------
// lock our internal collection of jobs, and add this job--we use this collection in Dispose()
// to tell BITS to Cancel() jobs--and remove them from the queue
// if we did not do this, BITS would continue for (by default) two weeks to download what we asked!
lock (bitsDownloaderJobs.SyncRoot)
{
bitsDownloaderJobs.Add(jobID, jobName);
}
}
/// <summary>
/// Creates a new transfer job.
/// </summary>
/// <param name="displayName">The display name.</param>
/// <param name="remoteUrl">The remote URL.</param>
/// <param name="localFile">The local file.</param>
/// <param name="priority">The priority.</param>
/// <exception cref="System.InvalidOperationException">An unexpected exception occurred trying to create the job.</exception>
public IDownloadJob CreateJob(string displayName, string remoteUrl, string localFile, DownloadPriority priority = DownloadPriority.Normal)
{
if (!Path.IsPathRooted(localFile))
{
localFile = new FileInfo(localFile).FullName;
}
var targetDir = Path.GetDirectoryName(localFile);
if (!Directory.Exists(targetDir))
{
Directory.CreateDirectory(targetDir);
}
if (File.Exists(localFile))
{
File.Delete(localFile);
}
IBackgroundCopyManager bitsManager = null;
IBackgroundCopyJob bitsJob = null;
var id = Guid.Empty;
try {
bitsManager = (IBackgroundCopyManager) new BackgroundCopyManager();
bitsManager.CreateJob(displayName, BG_JOB_TYPE.BG_JOB_TYPE_DOWNLOAD, out id, out bitsJob);
// ***
// SET UP BITS JOB SETTINGS--TIMEOUTS/RETRY ETC
// SEE THE FOLLOWING REFERENCES:
// ** http://msdn.microsoft.com/library/default.asp?url=/library/en-us/bits/bits/IBackgroundCopyJob2_setminimumretrydelay.asp?frame=true
// ** http://msdn.microsoft.com/library/default.asp?url=/library/en-us/bits/bits/IBackgroundCopyJob2_setnoprogresstimeout.asp?frame=true
// ** http://msdn.microsoft.com/library/default.asp?url=/library/en-us/bits/bits/bg_job_priority.asp
// ***
// in constant set to 0; this makes BITS retry as soon as possible after an error
bitsJob.SetMinimumRetryDelay(DownloadJob.DefaultMiniumRetryDelay);
// in constant set to 5 seconds; BITS will set job to Error status if exceeded
bitsJob.SetNoProgressTimeout(DownloadJob.DefaultNoProgressTimeout);
bitsJob.SetPriority((BG_JOB_PRIORITY)(int)priority);
bitsJob.AddFile(remoteUrl, localFile);
bitsJob.SetNotifyFlags((uint)(
BG_JOB_NOTIFICATION_TYPE.BG_NOTIFY_JOB_ERROR |
BG_JOB_NOTIFICATION_TYPE.BG_NOTIFY_JOB_MODIFICATION |
BG_JOB_NOTIFICATION_TYPE.BG_NOTIFY_JOB_TRANSFERRED));
var job = new DownloadJob(id, displayName, remoteUrl, localFile, priority);
// Set the notify interface to get BITS events
bitsJob.SetNotifyInterface(job);
return(job);
} catch (COMException cex) {
string error;
bitsManager.GetErrorDescription(cex.ErrorCode, 1033, out error);
throw new InvalidOperationException(error, cex);
} finally {
if (bitsJob != null)
{
Marshal.ReleaseComObject(bitsJob);
}
if (bitsManager != null)
{
Marshal.ReleaseComObject(bitsManager);
}
}
}
/// <summary>
/// Internal copy-job factory method. Used to coordinate all aspects of a job set-up,
/// which includes creating a copy manager, creating a job within it, setting download
/// parameters, and adding the job to our tracking collection for cleanup later
/// </summary>
/// <param name="copyManager">null reference to copy manager</param>
/// <param name="copyJob">null reference to copy job</param>
/// <param name="jobID">null reference to job id guid</param>
/// <param name="jobNameKey">the key used to look up the job name in the resource file</param>
/// <param name="jobDescriptionKey">the key used to look up the job description in the resource file</param>
private void CreateCopyJob(
out IBackgroundCopyManager copyManager,
out IBackgroundCopyJob copyJob,
ref Guid jobID,
string jobNameKey,
string jobDescriptionKey)
{
string jobName = Resource.ResourceManager[jobNameKey];
string jobDesc = Resource.ResourceManager[jobDescriptionKey];
// wrap in try-finally so we can clean COM objects if unexpected error
try
{
// create the manager
copyManager = (IBackgroundCopyManager) new BackgroundCopyManager();
// create the job, set its description, use "out" semantics to get jobid and the actual job object
copyManager.CreateJob(
jobName,
BG_JOB_TYPE.BG_JOB_TYPE_DOWNLOAD,
out jobID,
out copyJob);
// set useful description
copyJob.SetDescription(jobDesc);
// ***
// SET UP BITS JOB SETTINGS--TIMEOUTS/RETRY ETC
// SEE THE FOLLOWING REFERENCES:
// ** http://msdn.microsoft.com/library/default.asp?url=/library/en-us/bits/bits/ibackgroundcopyjob_setminimumretrydelay.asp?frame=true
// ** http://msdn.microsoft.com/library/default.asp?url=/library/en-us/bits/bits/ibackgroundcopyjob_setnoprogresstimeout.asp?frame=true
// ** http://msdn.microsoft.com/library/default.asp?url=/library/en-us/bits/bits/bg_job_priority.asp
// ***
// in constant set to 0; this makes BITS retry as soon as possible after an error
copyJob.SetMinimumRetryDelay((uint)BITS_SET_MINIMUM_RETRY_DELAY);
// in constant set to 5 seconds; BITS will set job to Error status if exceeded
copyJob.SetNoProgressTimeout((uint)BITS_SET_NO_PROGRESS_TIMEOUT);
// make this job the highest (but still background) priority--
copyJob.SetPriority(BG_JOB_PRIORITY.BG_JOB_PRIORITY_HIGH);
// ***
// lock our internal collection of jobs, and add this job--we use this collection in Dispose()
// to tell BITS to Cancel() jobs--and remove them from the queue
// if we did not do this, BITS would continue for (by default) two weeks to download what we asked!
lock (_jobs.SyncRoot)
{
_jobs.Add(jobID, jobName);
}
}
catch (Exception e)
{
// bad to catch all exceptions, but OK because we adorn it with necessary additional info then pass it up as innerException
string error = ApplicationUpdateManager.TraceWrite(e, "[BITSDownloader.CreateCopyJob]", "RES_EXCEPTION_BITSOtherError", jobID, jobName, jobDesc);
// publish
Exception newE = new Exception(error, e);
ExceptionManager.Publish(newE);
// rethrow;
throw newE;
}
}
/// <summary>
/// Internal copy-job factory method. Used to coordinate all aspects of a job set-up,
/// which includes creating a copy manager, creating a job within it, setting download
/// parameters, and adding the job to our tracking collection for cleanup later
/// </summary>
/// <param name="copyManager">null reference to copy manager</param>
/// <param name="copyJob">null reference to copy job</param>
/// <param name="jobID">null reference to job id guid</param>
/// <param name="jobNameKey">the key used to look up the job name in the resource file</param>
/// <param name="jobDescriptionKey">the key used to look up the job description in the resource file</param>
private void CreateCopyJob(
out IBackgroundCopyManager copyManager,
out IBackgroundCopyJob copyJob,
ref Guid jobID,
string jobNameKey,
string jobDescriptionKey)
{
string jobName = Resource.ResourceManager[ jobNameKey ];
string jobDesc = Resource.ResourceManager[ jobDescriptionKey ];
// wrap in try-finally so we can clean COM objects if unexpected error
try
{
// create the manager
copyManager = (IBackgroundCopyManager) new BackgroundCopyManager();
// create the job, set its description, use "out" semantics to get jobid and the actual job object
copyManager.CreateJob(
jobName,
BG_JOB_TYPE.BG_JOB_TYPE_DOWNLOAD,
out jobID,
out copyJob );
// set useful description
copyJob.SetDescription( jobDesc );
// ***
// SET UP BITS JOB SETTINGS--TIMEOUTS/RETRY ETC
// SEE THE FOLLOWING REFERENCES:
// ** http://msdn.microsoft.com/library/default.asp?url=/library/en-us/bits/bits/ibackgroundcopyjob_setminimumretrydelay.asp?frame=true
// ** http://msdn.microsoft.com/library/default.asp?url=/library/en-us/bits/bits/ibackgroundcopyjob_setnoprogresstimeout.asp?frame=true
// ** http://msdn.microsoft.com/library/default.asp?url=/library/en-us/bits/bits/bg_job_priority.asp
// ***
// in constant set to 0; this makes BITS retry as soon as possible after an error
copyJob.SetMinimumRetryDelay( (uint)BITS_SET_MINIMUM_RETRY_DELAY );
// in constant set to 5 seconds; BITS will set job to Error status if exceeded
copyJob.SetNoProgressTimeout( (uint)BITS_SET_NO_PROGRESS_TIMEOUT );
// make this job the highest (but still background) priority--
copyJob.SetPriority( BG_JOB_PRIORITY.BG_JOB_PRIORITY_HIGH );
// ***
// lock our internal collection of jobs, and add this job--we use this collection in Dispose()
// to tell BITS to Cancel() jobs--and remove them from the queue
// if we did not do this, BITS would continue for (by default) two weeks to download what we asked!
lock( _jobs.SyncRoot )
{
_jobs.Add( jobID, jobName );
}
}
catch( Exception e )
{
// bad to catch all exceptions, but OK because we adorn it with necessary additional info then pass it up as innerException
string error = ApplicationUpdateManager.TraceWrite( e, "[BITSDownloader.CreateCopyJob]", "RES_EXCEPTION_BITSOtherError", jobID, jobName, jobDesc );
// publish
Exception newE = new Exception( error, e );
ExceptionManager.Publish( newE );
// rethrow;
throw newE;
}
}