|
| 1 | +// Copyright (c) .NET Foundation. All rights reserved. |
| 2 | +// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. |
| 3 | + |
| 4 | +using System; |
| 5 | +using System.IO; |
| 6 | +using System.Threading.Tasks; |
| 7 | +using NuGet.Packaging; |
| 8 | +using NuGet.Services.Entities; |
| 9 | +using NuGetGallery.Packaging; |
| 10 | + |
| 11 | +namespace NuGetGallery |
| 12 | +{ |
| 13 | + public class CoreReadmeFileService : ICoreReadmeFileService |
| 14 | + { |
| 15 | + private const string ReadmeFileName = "readme"; |
| 16 | + |
| 17 | + private readonly ICoreFileStorageService _fileStorageService; |
| 18 | + private readonly IContentFileMetadataService _metadata; |
| 19 | + |
| 20 | + public CoreReadmeFileService(ICoreFileStorageService fileStorageService, IContentFileMetadataService metadata) |
| 21 | + { |
| 22 | + _fileStorageService = fileStorageService ?? throw new ArgumentNullException(nameof(fileStorageService)); |
| 23 | + _metadata = metadata ?? throw new ArgumentNullException(nameof(metadata)); |
| 24 | + } |
| 25 | + |
| 26 | + /// <summary> |
| 27 | + /// Saves the package readme.md file to storage. This method should throw if the package |
| 28 | + /// does not have an embedded readme file |
| 29 | + /// </summary> |
| 30 | + /// <param name="package">The package associated with the readme.</param> |
| 31 | + /// <param name="readmeFile">The content of readme file.</param> |
| 32 | + private Task SaveReadmeFileAsync(Package package, Stream readmeFile) |
| 33 | + { |
| 34 | + if (package == null) |
| 35 | + { |
| 36 | + throw new ArgumentNullException(nameof(package)); |
| 37 | + } |
| 38 | + |
| 39 | + if (readmeFile == null) |
| 40 | + { |
| 41 | + throw new ArgumentNullException(nameof(readmeFile)); |
| 42 | + } |
| 43 | + |
| 44 | + if (package.EmbeddedReadmeType == EmbeddedReadmeFileType.Absent) |
| 45 | + { |
| 46 | + throw new ArgumentException("Package must have an embedded readme", nameof(package)); |
| 47 | + } |
| 48 | + |
| 49 | + var fileName = BuildReadmeFileName(package); |
| 50 | + |
| 51 | + return _fileStorageService.SaveFileAsync(_metadata.PackageContentFolderName, fileName, readmeFile, overwrite: true); |
| 52 | + } |
| 53 | + |
| 54 | + /// <summary> |
| 55 | + /// Save the readme file from package stream. This method should throw if the package |
| 56 | + /// does not have an embedded readme file |
| 57 | + /// </summary> |
| 58 | + /// <param name="package">Package information.</param> |
| 59 | + /// <param name="packageStream">Package stream with .nupkg contents.</param> |
| 60 | + public async Task ExtractAndSaveReadmeFileAsync(Package package, Stream packageStream) |
| 61 | + { |
| 62 | + if (package == null) |
| 63 | + { |
| 64 | + throw new ArgumentNullException(nameof(package)); |
| 65 | + } |
| 66 | + |
| 67 | + if (packageStream == null) |
| 68 | + { |
| 69 | + throw new ArgumentNullException(nameof(packageStream)); |
| 70 | + } |
| 71 | + |
| 72 | + packageStream.Seek(0, SeekOrigin.Begin); |
| 73 | + using (var packageArchiveReader = new PackageArchiveReader(packageStream, leaveStreamOpen: true)) |
| 74 | + { |
| 75 | + var packageMetadata = PackageMetadata.FromNuspecReader(packageArchiveReader.GetNuspecReader(), strict: true); |
| 76 | + if (string.IsNullOrWhiteSpace(packageMetadata.ReadmeFile)) |
| 77 | + { |
| 78 | + throw new InvalidOperationException("No readme file specified in the nuspec"); |
| 79 | + } |
| 80 | + |
| 81 | + var filename = FileNameHelper.GetZipEntryPath(packageMetadata.ReadmeFile); |
| 82 | + var ReadmeFileEntry = packageArchiveReader.GetEntry(filename); // throws on non-existent file |
| 83 | + using (var readmeFileStream = ReadmeFileEntry.Open()) |
| 84 | + { |
| 85 | + await SaveReadmeFileAsync(package, readmeFileStream); |
| 86 | + } |
| 87 | + } |
| 88 | + } |
| 89 | + |
| 90 | + public async Task<string> DownloadReadmeFileAsync(Package package) |
| 91 | + { |
| 92 | + if (package == null) |
| 93 | + { |
| 94 | + throw new ArgumentNullException(nameof(package)); |
| 95 | + } |
| 96 | + |
| 97 | + var fileName = BuildReadmeFileName(package); |
| 98 | + |
| 99 | + using (var readmeFileStream = await _fileStorageService.GetFileAsync(_metadata.PackageContentFolderName, fileName)) |
| 100 | + { |
| 101 | + if (readmeFileStream != null) |
| 102 | + { |
| 103 | + using (var readMeMdReader = new StreamReader(readmeFileStream)) |
| 104 | + { |
| 105 | + return await readMeMdReader.ReadToEndAsync(); |
| 106 | + } |
| 107 | + } |
| 108 | + } |
| 109 | + return null; |
| 110 | + } |
| 111 | + |
| 112 | + public Task DeleteReadmeFileAsync(string id, string version) |
| 113 | + { |
| 114 | + if (id == null) |
| 115 | + { |
| 116 | + throw new ArgumentNullException(nameof(id)); |
| 117 | + } |
| 118 | + |
| 119 | + if (string.IsNullOrWhiteSpace(id)) |
| 120 | + { |
| 121 | + throw new ArgumentException($"{nameof(id)} cannot be empty", nameof(id)); |
| 122 | + } |
| 123 | + |
| 124 | + if (version == null) |
| 125 | + { |
| 126 | + throw new ArgumentNullException(nameof(version)); |
| 127 | + } |
| 128 | + |
| 129 | + if (string.IsNullOrWhiteSpace(version)) |
| 130 | + { |
| 131 | + throw new ArgumentException($"{nameof(version)} cannot be empty", nameof(version)); |
| 132 | + } |
| 133 | + |
| 134 | + var normalizedVersion = NuGetVersionFormatter.Normalize(version); |
| 135 | + var fileName = BuildReadmeFileName(id, normalizedVersion); |
| 136 | + |
| 137 | + return _fileStorageService.DeleteFileAsync(_metadata.PackageContentFolderName, fileName); |
| 138 | + } |
| 139 | + |
| 140 | + private string ReadmePathTemplate => $"{_metadata.PackageContentPathTemplate}/{ReadmeFileName}"; |
| 141 | + |
| 142 | + private string BuildReadmeFileName(Package package) |
| 143 | + => FileNameHelper.BuildFileName(package, ReadmePathTemplate, string.Empty); |
| 144 | + |
| 145 | + private string BuildReadmeFileName(string id, string version) |
| 146 | + => FileNameHelper.BuildFileName(id, version, ReadmePathTemplate, string.Empty); |
| 147 | + } |
| 148 | +} |
0 commit comments