File Providers topic update for 3.0 (#14027)

dotnet · Aug 26, 2019 · 2d27dd6 · 2d27dd6
1 parent a68e43d
commit 2d27dd6
Show file tree

Hide file tree

Showing 24 changed files with 458 additions and 96 deletions.
diff --git a/aspnetcore/fundamentals/file-providers.md b/aspnetcore/fundamentals/file-providers.md
diff --git a/aspnetcore/fundamentals/file-providers/samples/2.x/FileProviderSample/Pages/Index.cshtml b/aspnetcore/fundamentals/file-providers/samples/2.x/FileProviderSample/Pages/Index.cshtml
@@ -18,7 +18,7 @@
                 {
                     if (item.IsDirectory)
                     {
-                        <li><strong>@item.Name</strong></li>
+                        <li><strong>@item.Name</strong> folder</li>
                     }
                     else
                     {

diff --git a/...s/file-providers/samples/2.x/FileProviderSample/Pages/Shared/_CookieConsentPartial.cshtml b/...s/file-providers/samples/2.x/FileProviderSample/Pages/Shared/_CookieConsentPartial.cshtml
diff --git a/...re/fundamentals/file-providers/samples/2.x/FileProviderSample/Pages/Shared/_Layout.cshtml b/...re/fundamentals/file-providers/samples/2.x/FileProviderSample/Pages/Shared/_Layout.cshtml
@@ -9,10 +9,6 @@
 <body>
     <div class="container">
         @RenderBody()
-        <hr>
-        <footer>
-            <p>&copy;@System.DateTime.Now.Year - File Provider Sample</p>
-        </footer>
     </div>
 </body>
 </html>
diff --git a/...le-providers/samples/2.x/FileProviderSample/Pages/Shared/_ValidationScriptsPartial.cshtml b/...le-providers/samples/2.x/FileProviderSample/Pages/Shared/_ValidationScriptsPartial.cshtml
diff --git a/aspnetcore/fundamentals/file-providers/samples/2.x/WatchConsole/quotes.txt b/aspnetcore/fundamentals/file-providers/samples/2.x/WatchConsole/quotes.txt
@@ -1,3 +1,3 @@
 "As developers, we fail in two ways: We build the thing wrong, or we build the wrong thing." - Steve Smith
 
-"That's not a thing ... You just made that up." - David Fowler
+"That's not a thing ... You just made that up." - David Fowler
diff --git a/...core/fundamentals/file-providers/samples/3.x/FileProviderSample/FileProviderSample.csproj b/...core/fundamentals/file-providers/samples/3.x/FileProviderSample/FileProviderSample.csproj
@@ -0,0 +1,16 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>netcoreapp3.0</TargetFramework>
+    <GenerateEmbeddedFilesManifest>true</GenerateEmbeddedFilesManifest>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.FileProviders.Embedded" Version="3.0.0-preview8.19405.4" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <EmbeddedResource Include="Resource.txt" />
+  </ItemGroup>
+
+</Project>
diff --git a/aspnetcore/fundamentals/file-providers/samples/3.x/FileProviderSample/Pages/Error.cshtml b/aspnetcore/fundamentals/file-providers/samples/3.x/FileProviderSample/Pages/Error.cshtml
@@ -0,0 +1,26 @@
+@page
+@model ErrorModel
+@{
+    ViewData["Title"] = "Error";
+}
+
+<h1 class="text-danger">Error.</h1>
+<h2 class="text-danger">An error occurred while processing your request.</h2>
+
+@if (Model.ShowRequestId)
+{
+    <p>
+        <strong>Request ID:</strong> <code>@Model.RequestId</code>
+    </p>
+}
+
+<h3>Development Mode</h3>
+<p>
+    Swapping to the <strong>Development</strong> environment displays detailed information about the error that occurred.
+</p>
+<p>
+    <strong>The Development environment shouldn't be enabled for deployed applications.</strong>
+    It can result in displaying sensitive information from exceptions to end users.
+    For local debugging, enable the <strong>Development</strong> environment by setting the <strong>ASPNETCORE_ENVIRONMENT</strong> environment variable to <strong>Development</strong>
+    and restarting the app.
+</p>
diff --git a/aspnetcore/fundamentals/file-providers/samples/3.x/FileProviderSample/Pages/Error.cshtml.cs b/aspnetcore/fundamentals/file-providers/samples/3.x/FileProviderSample/Pages/Error.cshtml.cs
@@ -0,0 +1,19 @@
+using System.Diagnostics;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Mvc.RazorPages;
+
+namespace FileProviderSample.Pages
+{
+    [ResponseCache(Duration = 0, Location = ResponseCacheLocation.None, NoStore = true)]
+    public class ErrorModel : PageModel
+    {
+        public string RequestId { get; set; }
+
+        public bool ShowRequestId => !string.IsNullOrEmpty(RequestId);
+
+        public void OnGet()
+        {
+            RequestId = Activity.Current?.Id ?? HttpContext.TraceIdentifier;
+        }
+    }
+}
diff --git a/aspnetcore/fundamentals/file-providers/samples/3.x/FileProviderSample/Pages/Index.cshtml b/aspnetcore/fundamentals/file-providers/samples/3.x/FileProviderSample/Pages/Index.cshtml
@@ -0,0 +1,30 @@
+@page
+@model IndexModel
+@{
+    ViewData["Title"] = "File Provider Sample";
+}
+
+<h1>@ViewData["Title"]</h1>
+
+<div class="row">
+    <div class="panel panel-default">
+        <div class="panel-heading">
+            <h2 class="panel-title">Folder Contents</h2>
+        </div>
+        <div class="panel-body">
+            <ul>
+                @foreach (var item in Model.DirectoryContents)
+                {
+                    if (item.IsDirectory)
+                    {
+                        <li><strong>@item.Name</strong> folder</li>
+                    }
+                    else
+                    {
+                        <li>@item.Name - @item.Length bytes</li>
+                    }
+                }
+            </ul>
+        </div>
+    </div>
+</div>
diff --git a/aspnetcore/fundamentals/file-providers/samples/3.x/FileProviderSample/Pages/Index.cshtml.cs b/aspnetcore/fundamentals/file-providers/samples/3.x/FileProviderSample/Pages/Index.cshtml.cs
@@ -0,0 +1,22 @@
+using Microsoft.AspNetCore.Mvc.RazorPages;
+using Microsoft.Extensions.FileProviders;
+
+namespace FileProviderSample.Pages
+{
+    public class IndexModel : PageModel
+    {
+        private readonly IFileProvider _fileProvider;
+
+        public IndexModel(IFileProvider fileProvider)
+        {
+            _fileProvider = fileProvider;
+        }
+
+        public IDirectoryContents DirectoryContents { get; private set; }
+
+        public void OnGet()
+        {
+            DirectoryContents = _fileProvider.GetDirectoryContents(string.Empty);
+        }
+    }
+}
diff --git a/...re/fundamentals/file-providers/samples/3.x/FileProviderSample/Pages/Shared/_Layout.cshtml b/...re/fundamentals/file-providers/samples/3.x/FileProviderSample/Pages/Shared/_Layout.cshtml
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>@ViewData["Title"]</title>
+    <style>body{margin:0;padding-bottom:20px;font-family:"Helvetica Neue", Helvetica, Arial, sans-serif;font-size:14px;line-height:1.42857143;color:#333;background-color:#fff;}h1{font-size:24px;margin:.67em 0;}pre{overflow:auto;}code,pre{font-family:monospace, monospace;font-size:1em;}button,input{margin:0;font:inherit;color:inherit;}button{overflow:visible;}button{text-transform:none;}input{line-height:normal;}{box-sizing:border-box;}:before,*:after{box-sizing:border-box;}input,button{font-family:inherit;font-size:inherit;line-height:inherit;}a{color:#337ab7;text-decoration:none;}h1,h2,h3,h4{font-family:inherit;font-weight:500;line-height:1.1;color:inherit;margin-top:20px;margin-bottom:10px;}h3{font-size:16px;}h4{font-size:18px;}p{margin:0 0 10px;}ol{margin-top:0;margin-bottom:10px;}code,pre{font-family:Menlo, Monaco, Consolas, "Courier New", monospace;}code{padding:2px 4px;font-size:90%;color:#c7254e;background-color:#f9f2f4;border-radius:4px;}pre{display:block;padding:9.5px;margin:0 0 10px;font-size:13px;line-height:1.42857143;color:#333;word-break:break-all;word-wrap:break-word;background-color:#f5f5f5;border:1px solid #ccc;-radius:4px;}pre code{padding:0;font-size:inherit;color:inherit;white-space:pre-wrap;background-color:transparent;border-radius:0;}.container{padding-right:15px;padding-left:15px;margin-right:auto;margin-left:auto;}.container{width:800px;}.btn{display:inline-block;padding:6px 12px;margin-bottom:0;font-size:14px;font-weight:normal;line-height:1.42857143;text-align:center;white-space:nowrap;vertical-align:middle;background-image:none;border:1px solid transparent;border-radius:4px;;color:#fff;background-color:green;border-color:gray;float:right}.panel{margin-bottom:20px;background-color:#fff;border:1px solid transparent;border-radius:4px;box-shadow:0 1px 1px rgba(0, 0, 0, .05);}.panel-body{padding:15px;}.panel-heading{padding:10px 15px;border-bottom:1px solid transparent;border-top-left-radius:3px;border-top-right-radius:3px;}.panel-title{margin-top:0;margin-bottom:0;font-size:16px;color:inherit;}.panel-default{border-color:#ddd;}.panel-default > .panel-heading{color:#333;background-color:#f5f5f5;border-color:#ddd;}.clearfix:before,.clearfix:after,.container:before,.container:after,.panel-body:before,.panel-body:after{display:table;content:" ";}.clearfix:after,.container:after,.panel-body:after{clear:both;}.body-content{padding-left:15px;padding-right:15px;}.panel-body{font-size:16px;}</style>
+</head>
+<body>
+    <div class="container">
+        @RenderBody()
+    </div>
+</body>
+</html>
diff --git a/...core/fundamentals/file-providers/samples/3.x/FileProviderSample/Pages/_ViewImports.cshtml b/...core/fundamentals/file-providers/samples/3.x/FileProviderSample/Pages/_ViewImports.cshtml
@@ -0,0 +1,3 @@
+@using FileProviderSample
+@namespace FileProviderSample.Pages
+@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers
diff --git a/...etcore/fundamentals/file-providers/samples/3.x/FileProviderSample/Pages/_ViewStart.cshtml b/...etcore/fundamentals/file-providers/samples/3.x/FileProviderSample/Pages/_ViewStart.cshtml
@@ -0,0 +1,3 @@
+@{
+    Layout = "_Layout";
+}
diff --git a/aspnetcore/fundamentals/file-providers/samples/3.x/FileProviderSample/Program.cs b/aspnetcore/fundamentals/file-providers/samples/3.x/FileProviderSample/Program.cs
@@ -0,0 +1,20 @@
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.Extensions.Hosting;
+
+namespace FileProviderSample
+{
+    public class Program
+    {
+        public static void Main(string[] args)
+        {
+            CreateHostBuilder(args).Build().Run();
+        }
+
+        public static IHostBuilder CreateHostBuilder(string[] args) =>
+            Host.CreateDefaultBuilder(args)
+                .ConfigureWebHostDefaults(webBuilder =>
+                {
+                    webBuilder.UseStartup<Startup>();
+                });
+    }
+}
diff --git a/aspnetcore/fundamentals/file-providers/samples/3.x/FileProviderSample/README.md b/aspnetcore/fundamentals/file-providers/samples/3.x/FileProviderSample/README.md
@@ -0,0 +1,3 @@
+# ASP.NET Core File Provider Sample
+
+This sample illustrates the use of File Provider. This sample demonstrates the scenario described in the [File Providers in ASP.NET Core](https://docs.microsoft.com/aspnet/core/fundamentals/file-providers) topic.
diff --git a/aspnetcore/fundamentals/file-providers/samples/3.x/FileProviderSample/Resource.txt b/aspnetcore/fundamentals/file-providers/samples/3.x/FileProviderSample/Resource.txt
@@ -0,0 +1 @@
+An embedded resource.
diff --git a/aspnetcore/fundamentals/file-providers/samples/3.x/FileProviderSample/Startup.cs b/aspnetcore/fundamentals/file-providers/samples/3.x/FileProviderSample/Startup.cs
@@ -0,0 +1,54 @@
+using System.Reflection;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.FileProviders;
+using Microsoft.Extensions.Hosting;
+
+namespace FileProviderSample
+{
+    public class Startup
+    {
+        private readonly IWebHostEnvironment _env;
+
+        public Startup(IWebHostEnvironment env)
+        {
+            _env = env;
+        }
+
+        public void ConfigureServices(IServiceCollection services)
+        {
+            services.AddRazorPages();
+
+            #region snippet1
+            var physicalProvider = _env.ContentRootFileProvider;
+            var manifestEmbeddedProvider = 
+                new ManifestEmbeddedFileProvider(Assembly.GetEntryAssembly());
+            var compositeProvider = 
+                new CompositeFileProvider(physicalProvider, manifestEmbeddedProvider);
+
+            services.AddSingleton<IFileProvider>(compositeProvider);
+            #endregion
+        }
+
+        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
+        {
+            if (env.IsDevelopment())
+            {
+                app.UseDeveloperExceptionPage();
+            }
+            else
+            {
+                app.UseExceptionHandler("/Error");
+            }
+
+            app.UseStaticFiles();
+            app.UseRouting();
+
+            app.UseEndpoints(endpoints =>
+            {
+                endpoints.MapRazorPages();
+            });
+        }
+    }
+}
diff --git a/...e/fundamentals/file-providers/samples/3.x/FileProviderSample/appsettings.Development.json b/...e/fundamentals/file-providers/samples/3.x/FileProviderSample/appsettings.Development.json
@@ -0,0 +1,9 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Debug",
+      "System": "Information",
+      "Microsoft": "Information"
+    }
+  }
+}
diff --git a/...re/fundamentals/file-providers/samples/3.x/FileProviderSample/appsettings.Production.json b/...re/fundamentals/file-providers/samples/3.x/FileProviderSample/appsettings.Production.json
@@ -0,0 +1,9 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Error",
+      "System": "Information",
+      "Microsoft": "Information"
+    }
+  }
+}
diff --git a/aspnetcore/fundamentals/file-providers/samples/3.x/FileProviderSample/appsettings.json b/aspnetcore/fundamentals/file-providers/samples/3.x/FileProviderSample/appsettings.json
@@ -0,0 +1,10 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft": "Warning",
+      "Microsoft.Hosting.Lifetime": "Information"
+    }
+  },
+  "AllowedHosts": "*"
+}
diff --git a/aspnetcore/fundamentals/file-providers/samples/3.x/WatchConsole/Program.cs b/aspnetcore/fundamentals/file-providers/samples/3.x/WatchConsole/Program.cs
@@ -0,0 +1,39 @@
+using System;
+using System.IO;
+using System.Threading.Tasks;
+using Microsoft.Extensions.FileProviders;
+using Microsoft.Extensions.Primitives;
+
+namespace WatchConsole
+{
+    public class Program
+    {
+        #region snippet1
+        private static PhysicalFileProvider _fileProvider = 
+            new PhysicalFileProvider(Directory.GetCurrentDirectory());
+
+        public static void Main(string[] args)
+        {
+            Console.WriteLine("Monitoring quotes.txt for changes (Ctrl-c to quit)...");
+
+            while (true)
+            {
+                MainAsync().GetAwaiter().GetResult();
+            }
+        }
+
+        private static async Task MainAsync()
+        {
+            IChangeToken token = _fileProvider.Watch("quotes.txt");
+            var tcs = new TaskCompletionSource<object>();
+
+            token.RegisterChangeCallback(state => 
+                ((TaskCompletionSource<object>)state).TrySetResult(null), tcs);
+
+            await tcs.Task.ConfigureAwait(false);
+
+            Console.WriteLine("quotes.txt changed");
+        }
+        #endregion
+    }
+}
diff --git a/aspnetcore/fundamentals/file-providers/samples/3.x/WatchConsole/WatchConsole.csproj b/aspnetcore/fundamentals/file-providers/samples/3.x/WatchConsole/WatchConsole.csproj
@@ -0,0 +1,7 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>netcoreapp3.0</TargetFramework>
+  </PropertyGroup>
+
+</Project>
diff --git a/aspnetcore/fundamentals/file-providers/samples/3.x/WatchConsole/quotes.txt b/aspnetcore/fundamentals/file-providers/samples/3.x/WatchConsole/quotes.txt
@@ -0,0 +1,3 @@
+"As developers, we fail in two ways: We build the thing wrong, or we build the wrong thing." - Steve Smith
+
+"That's not a thing ... You just made that up." - David Fowler