ImageResizer.Plugins.BatchZipper.BatchResizeSettings Class Reference

Use this to configure the a resize job. After you start the job, do not modify this instance. More...

Collaboration diagram for ImageResizer.Plugins.BatchZipper.BatchResizeSettings:

Public Member Functions
	BatchResizeSettings (string destinationFile, Guid jobId, IList< BatchResizeItem > files)
	Use this to configure a batch resize job. Mutable. Remember to assign at least a JobEvent handler so you know the fate of the job. More...
void	FixDuplicateFilenames (string prefix="_")
	Loops through all files, assigning targetFilenames if they are null, and eliminating duplicate names by adding _1, _2, etc. Also normalizes filenames for use in zip folder. Used internally. May be used externally also if calling code wishes to to know the final file names. More...

Static Public Member Functions
static string	NormalizePathForUseInZipFile (string pathName)
	Utility routine for transforming path names from filesystem format (on Windows that means backslashes) to a format suitable for use within zipfiles. This means trimming the volume letter and colon (if any) And swapping backslashes for forward slashes. More...

Public Attributes
Guid	jobId
IList< BatchResizeItem >	files
string	destinationFile
Config	conf = null

Events
ItemCallback	ItemEvent
	Fired when a file is successfully written to the zip file, or if an item fails to be added to the zip file. Will execute on a thread pool thread. Catch all your exeptions, or they will cause the jobe to fail. Set e.Cancel to cancel the job. Uses the same thread the job is processing on - I/O bound tasks in handlers should be async if possible. More...
JobCallback	JobEvent
	Fires when the Zip file has successfully been written to disk, when the job fails. Will execute on a thread pool thread. Catch all your exeptions, or they will cause the asp.net proccess to restart! More...

Detailed Description

Use this to configure the a resize job. After you start the job, do not modify this instance.

Definition at line 117 of file BatchJobSettings.cs.

Constructor & Destructor Documentation

ImageResizer.Plugins.BatchZipper.BatchResizeSettings.BatchResizeSettings ( string  destinationFile, Guid  jobId, IList< BatchResizeItem >  files  )

inline

Use this to configure a batch resize job. Mutable. Remember to assign at least a JobEvent handler so you know the fate of the job.

Parameters

jobId	The job ID, can be generated with Guid.NewGuid()
destinationFile	The physical path to the destination archive
files	A List<BatchResizeItem> of items to to resize and place in the folder.

Definition at line 126 of file BatchJobSettings.cs.

        {
            this.jobId = jobId;
            this.destinationFile = destinationFile;
            this.files = files;
            this.conf = Config.Current;
        }

Member Function Documentation

void ImageResizer.Plugins.BatchZipper.BatchResizeSettings.FixDuplicateFilenames ( string  prefix = "_" )

inline

Loops through all files, assigning targetFilenames if they are null, and eliminating duplicate names by adding _1, _2, etc. Also normalizes filenames for use in zip folder. Used internally. May be used externally also if calling code wishes to to know the final file names.

Definition at line 169 of file BatchJobSettings.cs.

        {
            HashSet<string> names = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
            foreach (BatchResizeItem i in files)
            {
                //Assign default if null
                if (i.TargetFilename == null) i.TargetFilename = System.IO.Path.GetFileNameWithoutExtension(i.PhysicalPath);

                //See if it is a duplicate
                if (names.Contains(i.TargetFilename))
                {
                    //Generate a unique filename by appending a number.
                    int index = 1;
                    string next = i.TargetFilename + prefix + index;
                    while (names.Contains(next))
                    {
                        index++;
                        next = i.TargetFilename + prefix + index;
                    }
                    i.TargetFilename = next;
                }

                //Normalize for zip usage
                i.TargetFilename = NormalizePathForUseInZipFile(i.TargetFilename);

                //Add to names set, so we can verify future filename uniqueness.
                names.Add(i.TargetFilename);

            }
        }

static string ImageResizer.Plugins.BatchZipper.BatchResizeSettings.NormalizePathForUseInZipFile ( string  pathName )

inlinestatic

Utility routine for transforming path names from filesystem format (on Windows that means backslashes) to a format suitable for use within zipfiles. This means trimming the volume letter and colon (if any) And swapping backslashes for forward slashes.

Parameters

pathName

source path.

Returns

transformed path

Definition at line 206 of file BatchJobSettings.cs.

        {
            // boundary case
            if (String.IsNullOrEmpty(pathName)) return pathName;

            // trim volume if necessary
            if ((pathName.Length >= 2) && ((pathName[1] == ':') && (pathName[2] == '\\')))
                pathName = pathName.Substring(3);

            // swap slashes
            pathName = pathName.Replace('\\', '/');

            // trim all leading slashes
            while (pathName.StartsWith("/")) pathName = pathName.Substring(1);

            return SimplifyFwdSlashPath(pathName);
        }

Event Documentation

ItemCallback ImageResizer.Plugins.BatchZipper.BatchResizeSettings.ItemEvent

Fired when a file is successfully written to the zip file, or if an item fails to be added to the zip file. Will execute on a thread pool thread. Catch all your exeptions, or they will cause the jobe to fail. Set e.Cancel to cancel the job. Uses the same thread the job is processing on - I/O bound tasks in handlers should be async if possible.

Definition at line 147 of file BatchJobSettings.cs.

JobCallback ImageResizer.Plugins.BatchZipper.BatchResizeSettings.JobEvent

Fires when the Zip file has successfully been written to disk, when the job fails. Will execute on a thread pool thread. Catch all your exeptions, or they will cause the asp.net proccess to restart!

Definition at line 152 of file BatchJobSettings.cs.

---

The documentation for this class was generated from the following file:

• C:/Users/nathanael/Documents/resizer/Plugins/BatchZipper/BatchJobSettings.cs