static void Main(string[] args)
{
_options = new Settings();
if (Parser.Default.ParseArguments(args, _options))
{
//Make sure that the Spira string is a URL.
Uri serverUrl = null;
string servicePath = _options.SpiraServer +
((_options.SpiraServer.EndsWith("/") ? "" : "/")) +
"Services/v5_0/SoapService.svc";
if (!Uri.TryCreate(servicePath, UriKind.Absolute, out serverUrl))
{
//Throw error: URL given not a URL.
return;
}
//See if we have a mappings file specified, if so, make sure it exists
List <ArtifactMapping> artifactMappings = null;
string customPropertyField = null;
if (!String.IsNullOrWhiteSpace(_options.SpiraMappingsFile))
{
if (!File.Exists(_options.SpiraMappingsFile))
{
//Throw error: Bad path.
ConsoleLog(LogLevelEnum.Normal, "Cannot access the mapping file, please check the location and try again!");
Environment.Exit(-1);
}
artifactMappings = new List <ArtifactMapping>();
//Read in the lines, the first column should contain:
//Filename,ArtifactTypeId,Custom_03
//where the number in the third column is the name of the custom property that the IDs will be using
using (StreamReader streamReader = File.OpenText(_options.SpiraMappingsFile))
{
string firstLine = streamReader.ReadLine();
string[] headings = firstLine.Split(',');
//See if we have a match on the custom property number
if (headings.Length > 2 && !String.IsNullOrWhiteSpace(headings[2]))
{
customPropertyField = headings[2].Trim();
//Now read in the rows of mappings
while (!streamReader.EndOfStream)
{
string mappingLine = streamReader.ReadLine();
ArtifactMapping artifactMapping = new ArtifactMapping();
string[] components = mappingLine.Split(',');
artifactMapping.Filename = components[0];
artifactMapping.ArtifactTypeId = Int32.Parse(components[1]);
artifactMapping.ExternalKey = components[2];
artifactMappings.Add(artifactMapping);
}
streamReader.Close();
}
}
}
//Make sure the path given is a real path..
try
{
Directory.GetCreationTime(_options.ImportPath);
}
catch
{
//Throw error: Bad path.
ConsoleLog(LogLevelEnum.Normal, "Cannot access the import path, please check the location and try again!");
Environment.Exit(-1);
}
//Tell user we're operating.
ConsoleLog(LogLevelEnum.Normal, "Importing files in " + _options.ImportPath);
//Now run through connecting procedures.
ConsoleLog(LogLevelEnum.Verbose, "Connecting to Spira server...");
SoapServiceClient client = CreateClient_Spira5(serverUrl);
client.Open();
if (client.Connection_Authenticate2(_options.SpiraLogin, _options.SpiraPass, "DocumentImporter"))
{
ConsoleLog(LogLevelEnum.Verbose, "Selecting Spira project...");
var Projects = client.Project_Retrieve();
RemoteProject proj = Projects.FirstOrDefault(p => p.ProjectId == _options.SpiraProject);
if (proj != null)
{
//Connect to the project.
if (client.Connection_ConnectToProject((int)_options.SpiraProject))
{
ConsoleLog(LogLevelEnum.Normal, "Uploading files...");
//Now let's get a list of all the files..
SearchOption opt = ((_options.PathRecursive) ? SearchOption.AllDirectories : SearchOption.TopDirectoryOnly);
List <string> files = Directory.EnumerateFiles(_options.ImportPath, _options.ImportFilter, opt).ToList();
//Loop through each file and upload it.
ConsoleLog(LogLevelEnum.Verbose, "Files:");
foreach (string file in files)
{
string conLog = Path.GetFileName(file);
try
{
//Get the file details..
FileInfo fileInf = new FileInfo(file);
string size = "";
if (fileInf.Length >= 1000000000)
{
size = (fileInf.Length / 1000000000).ToString() + "Gb";
}
else if (fileInf.Length >= 1000000)
{
size = (fileInf.Length / 1000000).ToString() + "Mb";
}
else if (fileInf.Length >= 1000)
{
size = (fileInf.Length / 1000).ToString() + "Kb";
}
else
{
size = fileInf.Length.ToString() + "b";
}
conLog += " (" + size + ")";
//Generate the RemoteDocument object.
RemoteDocument newFile = new RemoteDocument();
newFile.AttachmentTypeId = 1;
newFile.FilenameOrUrl = Path.GetFileName(file);
newFile.Size = (int)fileInf.Length;
newFile.UploadDate = DateTime.UtcNow;
//Now we see if have mapped artifact
ArtifactMapping mappedArtifact = artifactMappings.FirstOrDefault(m => m.Filename.ToLowerInvariant() == newFile.FilenameOrUrl.ToLowerInvariant());
if (mappedArtifact != null && !String.IsNullOrEmpty(customPropertyField))
{
//We have to lookup the artifact, currently only incidents are supported
if (mappedArtifact.ArtifactTypeId == 3)
{
//Retrieve the incident
RemoteSort sort = new RemoteSort();
sort.PropertyName = "IncidentId";
sort.SortAscending = true;
List <RemoteFilter> filters = new List <RemoteFilter>();
RemoteFilter filter = new RemoteFilter();
filter.PropertyName = customPropertyField;
filter.StringValue = mappedArtifact.ExternalKey;
filters.Add(filter);
RemoteIncident remoteIncident = client.Incident_Retrieve(filters, sort, 1, 1).FirstOrDefault();
if (remoteIncident != null)
{
RemoteLinkedArtifact remoteLinkedArtifact = new SpiraService.RemoteLinkedArtifact();
remoteLinkedArtifact.ArtifactTypeId = mappedArtifact.ArtifactTypeId;
remoteLinkedArtifact.ArtifactId = remoteIncident.IncidentId.Value;
newFile.AttachedArtifacts = new List <RemoteLinkedArtifact>();
newFile.AttachedArtifacts.Add(remoteLinkedArtifact);
}
}
else
{
ConsoleLog(LogLevelEnum.Normal, "Warning: Only incident mapped artifacts currently supported, so ignoring the mapped artifacts of type: " + mappedArtifact.ArtifactTypeId);
}
}
//Read the file contents. (Into memory! Beware, large files!)
byte[] fileContents = null;
fileContents = File.ReadAllBytes(file);
ConsoleLog(LogLevelEnum.Verbose, conLog);
if (fileContents != null && fileContents.Length > 1)
{
newFile.AttachmentId = client.Document_AddFile(newFile, fileContents).AttachmentId.Value;
}
else
{
throw new FileEmptyException();
}
}
catch (Exception ex)
{
conLog += " - Error. (" + ex.GetType().ToString() + ")";
ConsoleLog(LogLevelEnum.Normal, conLog);
}
}
}
else
{
ConsoleLog(LogLevelEnum.Normal, "Cannot connect to project. Verify your Project Role.");
Environment.Exit(-1);
}
}
else
{
ConsoleLog(LogLevelEnum.Normal, "Cannot connect to project. Project #" + _options.SpiraProject.ToString() + " does not exist.");
Environment.Exit(-1);
}
}
else
{
ConsoleLog(LogLevelEnum.Normal, "Cannot log in. Check username and password.");
Environment.Exit(-1);
}
}
else
{
Environment.Exit(-1);
}
}
private void processSpiraAccount(Pop3Client clientPOP3, AccountDetails account, ApplicationSystem appServer)
{
const string METHOD = CLASS + "processSpiraAccount()";
this._eventLog.EntryLog(METHOD);
//Create the application client and connect to our project and get users..
SoapServiceClient clientAppl = (SoapServiceClient)this.CreateApplicationClient(appServer, account);
//Get users in the project..
List <RemoteProjectUser> spiraUsers = clientAppl.Project_RetrieveUserMembership();
//Get the known message IDs..
List <string> seenUIDs = this.readMessageIDsForAccount(account.AccountID.Value);
//Get new emails from the client.
List <Message> newMsgs = this.popGetNewMessages(clientPOP3, account, seenUIDs);
//Get all projects..
List <RemoteProject> spiraProjs = clientAppl.Project_Retrieve();
//Loop through each email.
foreach (Message msg in newMsgs)
{
this._eventLog.WriteTrace(METHOD, "Starting on message " + msg.MessageLogID + "...");
//Make sure we have a from address, otherwise skip (Delivery Returned messages have no FROM address)
//First see if the message should be skipped. (Keywords, Headers, or Email Addresses)
if (msg.Headers != null &&
msg.Headers.From != null &&
!String.IsNullOrWhiteSpace(msg.Headers.From.Address) &&
msg.Headers.From.Address.ToLowerInvariant().Trim() != account.AccountEmail.ToLowerInvariant().Trim())
{
string filterMsg;
if (this.doesMessageClearFilters(msg, out filterMsg))
{
//First see if there's a header we can get the artifact ID from..
ArtifactTypeEnum artType = ArtifactTypeEnum.None;
int artId = -1;
if (msg.Headers.UnknownHeaders[Common.MESSAGEHEADER_SPIRA_ARTIFACT] != null && rgxArtifactToken.IsMatch(msg.Headers.UnknownHeaders[Common.MESSAGEHEADER_SPIRA_ARTIFACT]))
{
//Get the art type and the id..
Match matches = rgxArtifactToken.Match(msg.Headers.UnknownHeaders[Common.MESSAGEHEADER_SPIRA_ARTIFACT]);
this.retrieveArtTypeAndId(matches.Groups["type"].Value, matches.Groups["id"].Value, out artType, out artId);
}
if (artId == -1 || artType == ArtifactTypeEnum.None)
{
if (rgxArtifactToken.IsMatch(msg.Headers.Subject))
{
//Get the art type and the id..
Match matches = rgxArtifactToken.Match(msg.Headers.Subject);
this.retrieveArtTypeAndId(matches.Groups["type"].Value, matches.Groups["id"].Value, out artType, out artId);
}
}
//Change projects, if necessary, and if we're able to..
try
{
int projNum = clientAppl.System_GetProjectIdForArtifact((int)artType, artId);
if (projNum != 0)
{
bool succNewProject = clientAppl.Connection_ConnectToProject(projNum);
if (!succNewProject)
{
//Couldn't connect to the project this item belongs to. Throw an error.
this._eventLog.WriteMessage("Message " + msg.MessageLogID + " contains information for a project [PR:" + projNum.ToString() + "] that the client could not connect to. Skipping.", System.Diagnostics.EventLogEntryType.Information);
artType = ArtifactTypeEnum.Skip;
artId = 0;
}
}
}
catch (Exception ex)
{
this._eventLog.WriteMessage(METHOD, ex, "Message " + msg.MessageLogID + " - while trying to retrieve project number from artifact. Skipping.");
}
//If we have a match, find the user..
if (artId > 0 && artType != ArtifactTypeEnum.None)
{
//Detect if more than one user is found..
int userCnt = spiraUsers.Where(su => su.EmailAddress.ToLowerInvariant() == msg.Headers.From.MailAddress.Address.ToLowerInvariant()).Count();
if (userCnt == 1)
{
RemoteProjectUser selUser = spiraUsers.Where(su => su.EmailAddress.ToLowerInvariant() == msg.Headers.From.MailAddress.Address.ToLowerInvariant()).Single();
//See if the item exists in the server..
RemoteArtifact remArt = null;
try
{
switch (artType)
{
case ArtifactTypeEnum.Requirement:
remArt = clientAppl.Requirement_RetrieveById(artId);
break;
case ArtifactTypeEnum.Test_Case:
remArt = clientAppl.TestCase_RetrieveById(artId);
break;
case ArtifactTypeEnum.Incident:
remArt = clientAppl.Incident_RetrieveById(artId);
break;
case ArtifactTypeEnum.Release:
remArt = clientAppl.Release_RetrieveById(artId);
break;
case ArtifactTypeEnum.Task:
remArt = clientAppl.Task_RetrieveById(artId);
break;
case ArtifactTypeEnum.Test_Set:
remArt = clientAppl.TestSet_RetrieveById(artId);
break;
}
if (remArt == null)
{
throw new Exception("Artifact did not exist: " + artType.ToString() + " #" + artId.ToString());
}
}
catch (Exception ex)
{
this._eventLog.WriteMessage(METHOD, ex, "For message " + msg.MessageLogID + ", referenced artifact did not exist.");
continue;
}
try
{
//The artifact exists, let's add a comment..
RemoteComment comment = new RemoteComment();
comment.ArtifactId = artId;
comment.CreationDate = DateTime.UtcNow;
comment.UserId = selUser.UserId;
comment.Text = this.getTextFromMessage(msg, true, true);
switch (artType)
{
case ArtifactTypeEnum.Requirement:
comment = clientAppl.Requirement_CreateComment(comment);
break;
case ArtifactTypeEnum.Test_Case:
comment = clientAppl.TestCase_CreateComment(comment);
break;
case ArtifactTypeEnum.Incident:
comment = clientAppl.Incident_AddComments(new List <RemoteComment>()
{
comment
}).FirstOrDefault();
break;
case ArtifactTypeEnum.Release:
comment = clientAppl.Release_CreateComment(comment);
break;
case ArtifactTypeEnum.Task:
comment = clientAppl.Task_CreateComment(comment);
break;
case ArtifactTypeEnum.Test_Set:
comment = clientAppl.TestSet_CreateComment(comment);
break;
}
if (comment != null && comment.CommentId.HasValue)
{
//Now check for attachments
try
{
foreach (MessagePart attach in msg.FindAllAttachments().Where(aa => aa.IsMultiPart == false && aa.IsText == false))
{
//Add the file..
RemoteLinkedArtifact artifactLink = new RemoteLinkedArtifact();
artifactLink.ArtifactId = comment.ArtifactId;
artifactLink.ArtifactTypeId = (int)artType;
RemoteDocument newDoc = new RemoteDocument();
newDoc.AttachedArtifacts = new List <RemoteLinkedArtifact>()
{
artifactLink
};
newDoc.AttachmentTypeId = 1;
newDoc.AuthorId = selUser.UserId;
newDoc.FilenameOrUrl = attach.FileName;
newDoc.UploadDate = DateTime.UtcNow;
//Check for string overrun and add extension if necessary.
if (newDoc.FilenameOrUrl.Length > 250)
{
newDoc.FilenameOrUrl = newDoc.FilenameOrUrl.Substring(0, 250);
}
if (string.IsNullOrWhiteSpace(Path.GetExtension(newDoc.FilenameOrUrl)) && attach.ContentType != null)
{
string tempFileExtension = Utils.GetExtensionFromMimeType(attach.ContentType.MediaType);
if (!string.IsNullOrWhiteSpace(tempFileExtension))
{
newDoc.FilenameOrUrl += "." + tempFileExtension;
}
}
//Call the function to upload the file to Spira
newDoc = clientAppl.Document_AddFile(newDoc, attach.Body);
//Log it.
this._eventLog.WriteMessage("Attachment #" + newDoc.AttachmentId.ToSafeString() + " created from file '" + attach.FileName + "' for Artifact " + artType + " #:" + comment.ArtifactId + " from message " + msg.MessageLogID + ".", System.Diagnostics.EventLogEntryType.Information);
}
}
catch (Exception ex)
{
//Log and continue
this._eventLog.WriteMessage(METHOD, ex, "Saving attachment for message " + msg.MessageLogID);
}
}
}
catch (Exception ex)
{
this._eventLog.WriteMessage(METHOD, ex, "While trying to save message '" + msg.MessageLogID + "' as a new comment.");
continue;
}
//If we get this far, mark the message as processed.
try
{
//Add it to our list..
seenUIDs.Add(msg.MessageUID);
if (account.RemoveFromServer)
{
clientPOP3.DeleteMessage(msg.MessageIndex);
}
}
catch (Exception ex)
{
this._eventLog.WriteMessage(METHOD, ex, "Trying to delete message " + msg.MessageLogID + " from server.");
}
}
else
{
string msgLog = "";
if (userCnt == 0)
{
msgLog = "Message " + msg.MessageLogID + " was sent from a user not a mamber of the specified project. Not importing unknown users.";
}
else if (userCnt > 1)
{
msgLog = "Message " + msg.MessageLogID + " was sent from a user that did not have a unique email address. Cannot import to avoid selecting the wrong user.";
}
this._eventLog.WriteMessage(msgLog, System.Diagnostics.EventLogEntryType.Information);
}
}
else
{
if (artType != ArtifactTypeEnum.Skip)
{
int userCnt = spiraUsers.Where(su => su.EmailAddress.ToLowerInvariant() == msg.Headers.From.MailAddress.Address.ToLowerInvariant()).Count();
if (userCnt == 1)
{
RemoteProjectUser selUser = spiraUsers.Where(su => su.EmailAddress.ToLowerInvariant() == msg.Headers.From.MailAddress.Address.ToLowerInvariant()).Single();
//Create a new Incident..
RemoteIncident newIncident = new RemoteIncident();
newIncident.CreationDate = DateTime.Now;
newIncident.Description = this.getTextFromMessage(msg, true, false);
newIncident.Name = msg.Headers.Subject;
newIncident.OpenerId = selUser.UserId;
//Check regex other projects
if (account.UseRegexToMatch)
{
Regex regProj1 = new Regex(@"\[PR[\:\-\s](\d*?)\]", RegexOptions.IgnoreCase | RegexOptions.CultureInvariant);
if (regProj1.IsMatch(newIncident.Description) || regProj1.IsMatch(newIncident.Name))
{
//Someone used the PR tag in the email body, we'll use it, if possible.
string matchNum = "";
if (regProj1.IsMatch(newIncident.Name))
{
matchNum = regProj1.Matches(newIncident.Name)[0].Groups[1].Value;
}
else if (regProj1.IsMatch(newIncident.Description))
{
matchNum = regProj1.Matches(newIncident.Description)[0].Groups[1].Value;
}
else
{
this._eventLog.WriteMessage("ERROR: At least one RegEx returned IsMatch, but none contained match.", System.Diagnostics.EventLogEntryType.Information);
continue;
}
int projNum = 0;
if (int.TryParse(matchNum, out projNum))
{
//We had a number, let's see if it's a valid product.
RemoteProject proj = spiraProjs.FirstOrDefault(prd => prd.ProjectId == projNum);
if (proj != null)
{
//Connect to project..
if (clientAppl.Connection_ConnectToProject(proj.ProjectId.Value))
{
newIncident.ProjectId = proj.ProjectId.Value;
this._eventLog.WriteMessage("Message " + msg.MessageLogID + " changed to Project '" + proj.Name + "' due to having [PR:xx] tag.", System.Diagnostics.EventLogEntryType.Information);
}
else
{
this._eventLog.WriteMessage("Message " + msg.MessageLogID + " contained project token for project '" + proj.Name + "', but email import has no access to that project. Using default.", System.Diagnostics.EventLogEntryType.Information);
}
}
else
{
this._eventLog.WriteMessage("Message '" + msg.MessageLogID + "' contained token for project " + projNum.ToString() + " but project was inaccessible. Using default.", System.Diagnostics.EventLogEntryType.Information);
}
}
}
else
{
foreach (RemoteProject prod in spiraProjs)
{
Regex regProd3 = new Regex(@"\b" + prod.Name + @"\b", RegexOptions.CultureInvariant | RegexOptions.IgnoreCase);
if (regProd3.IsMatch(newIncident.Description) || regProd3.IsMatch(newIncident.Name))
{
newIncident.ProjectId = prod.ProjectId.Value;
this._eventLog.WriteMessage("Message " + msg.MessageLogID + " changed to Product '" + prod.Name + "' due to having Product name '" + prod.Name + "'", System.Diagnostics.EventLogEntryType.Information);
break;
}
}
}
}
//Now save the Incident..
try
{
newIncident = clientAppl.Incident_Create(newIncident);
if (newIncident.IncidentId.HasValue)
{
//Now check for attachments
try
{
foreach (MessagePart attach in msg.FindAllAttachments().Where(aa => aa.IsMultiPart == false && aa.IsText == false))
{
//Add the file..
RemoteLinkedArtifact artifactLink = new RemoteLinkedArtifact();
artifactLink.ArtifactId = newIncident.IncidentId.Value;
artifactLink.ArtifactTypeId = 3; /* Incident */
RemoteDocument newDoc = new RemoteDocument();
newDoc.AttachedArtifacts = new List <RemoteLinkedArtifact>()
{
artifactLink
};
newDoc.AttachmentTypeId = 1;
newDoc.AuthorId = selUser.UserId;
newDoc.FilenameOrUrl = attach.FileName;
newDoc.UploadDate = DateTime.UtcNow;
//Check for string overrun and add extension if necessary.
if (newDoc.FilenameOrUrl.Length > 250)
{
newDoc.FilenameOrUrl = newDoc.FilenameOrUrl.Substring(0, 250);
}
if (string.IsNullOrWhiteSpace(Path.GetExtension(newDoc.FilenameOrUrl)) && attach.ContentType != null)
{
string tempFileExtension = Utils.GetExtensionFromMimeType(attach.ContentType.MediaType);
if (!string.IsNullOrWhiteSpace(tempFileExtension))
{
newDoc.FilenameOrUrl += "." + tempFileExtension;
}
}
//Call the function to upload the file to Spira
newDoc = clientAppl.Document_AddFile(newDoc, attach.Body);
//Log it.
this._eventLog.WriteMessage("Attachment #" + newDoc.AttachmentId.ToSafeString() + " created from file '" + attach.FileName + "' for Incident IN:" + newIncident.IncidentId.Value + " from message " + msg.MessageLogID + ".", System.Diagnostics.EventLogEntryType.Information);
}
}
catch (Exception ex)
{
//Log and continue
this._eventLog.WriteMessage(METHOD, ex, "Saving attachment for message " + msg.MessageLogID);
}
}
//If we get this far, mark the message as processed.
try
{
//Add it to our list..
seenUIDs.Add(msg.MessageUID);
if (account.RemoveFromServer)
{
clientPOP3.DeleteMessage(msg.MessageIndex);
}
}
catch (Exception ex)
{
this._eventLog.WriteMessage(METHOD, ex, "Trying to delete message " + msg.MessageLogID + " from server.");
}
}
catch (Exception ex)
{
this._eventLog.WriteMessage(METHOD, ex, "While trying to save message '" + msg.MessageLogID + "' as an incident.");
}
}
else
{
string msgLog = "";
if (userCnt == 0)
{
msgLog = "Message " + msg.MessageLogID + " was sent from a user not a mamber of the specified project. Not importing unknown users.";
}
else if (userCnt > 1)
{
msgLog = "Message " + msg.MessageLogID + " was sent from a user that did not have a unique email address. Cannot import to avoid selecting the wrong user.";
}
this._eventLog.WriteMessage(msgLog, System.Diagnostics.EventLogEntryType.Information);
}
}
else
{
}
}
}
else
{
//Log it..
this._eventLog.WriteMessage("Message " + msg.MessageLogID + " on the server did not pass filters:" + Environment.NewLine + "Subject: " + msg.Headers.Subject + Environment.NewLine + "Reasons: " + Environment.NewLine + filterMsg, System.Diagnostics.EventLogEntryType.Warning);
}
}
else
{
//Log it..
this._eventLog.WriteMessage("Message " + msg.MessageLogID + " had no From address or was from the import account --" + Environment.NewLine + "Subject: " + msg.Headers.Subject + Environment.NewLine + "Msg UID: " + msg.Headers.MessageId + Environment.NewLine + "For reason: From Email address same as importing account, or was null.", System.Diagnostics.EventLogEntryType.Warning);
}
}
//Save the seen message IDs..
this.saveMessageIDsForAccount(account.AccountID.Value, seenUIDs);
//Disconnect client and POP3..
try
{
clientPOP3.Disconnect();
clientAppl.Connection_Disconnect();
}
catch (Exception ex)
{
this._eventLog.WriteMessage(METHOD, ex, "Trying to close connections.");
}
}
