/// <summary>
/// Checks all links detected in the source document to make sure they are valid.
/// </summary>
/// <param name="includeWarnings"></param>
/// <param name="errors">Information about broken links</param>
/// <param name="linkedDocFiles"></param>
/// <returns>True if all links are valid. Otherwise false</returns>
public bool ValidateNoBrokenLinks(bool includeWarnings, out ValidationError[] errors, out string[] linkedDocFiles)
{
if (!this.HasScanRun)
throw new InvalidOperationException("Cannot validate links until Scan() is called.");
List<string> linkedPages = new List<string>();
var foundErrors = new List<ValidationError>();
foreach (var link in this.MarkdownLinks)
{
if (null == link.def)
{
foundErrors.Add(new ValidationError(ValidationErrorCode.MissingLinkSourceId, this.DisplayName, "Link specifies ID '{0}' which was not found in the document.", link.link_text));
continue;
}
string relativeFileName;
var result = this.VerifyLink(this.FullPath, link.def.url, this.BasePath, out relativeFileName);
switch (result)
{
case LinkValidationResult.BookmarkSkipped:
case LinkValidationResult.ExternalSkipped:
if (includeWarnings)
foundErrors.Add(new ValidationWarning(ValidationErrorCode.LinkValidationSkipped, this.DisplayName, "Skipped validation of link '{1}' to URL '{0}'", link.def.url, link.link_text));
break;
case LinkValidationResult.FileNotFound:
foundErrors.Add(new ValidationError(ValidationErrorCode.LinkDestinationNotFound, this.DisplayName, "Destination missing for link '{1}' to URL '{0}'", link.def.url, link.link_text));
break;
case LinkValidationResult.ParentAboveDocSetPath:
foundErrors.Add(new ValidationError(ValidationErrorCode.LinkDestinationOutsideDocSet, this.DisplayName, "Destination outside of doc set for link '{1}' to URL '{0}'", link.def.url, link.link_text));
break;
case LinkValidationResult.UrlFormatInvalid:
foundErrors.Add(new ValidationError(ValidationErrorCode.LinkFormatInvalid, this.DisplayName, "Invalid URL format for link '{1}' to URL '{0}'", link.def.url, link.link_text));
break;
case LinkValidationResult.Valid:
foundErrors.Add(new ValidationMessage(this.DisplayName, "Link to URL '{0}' is valid.", link.def.url, link.link_text));
if (null != relativeFileName)
{
linkedPages.Add(relativeFileName);
}
break;
default:
foundErrors.Add(new ValidationError(ValidationErrorCode.Unknown, this.DisplayName, "{2}: for link '{1}' to URL '{0}'", link.def.url, link.link_text, result));
break;
}
}
errors = foundErrors.ToArray();
linkedDocFiles = linkedPages.Distinct().ToArray();
return !(errors.WereErrors() || errors.WereWarnings());
}
