From ef8d9589d9a3a2ecb71b93095e52ea190582247c Mon Sep 17 00:00:00 2001 From: Abi Lowrie Date: Fri, 5 Aug 2022 13:46:22 +0100 Subject: [PATCH 1/2] dotNet SDK example: Initial commit Signed-off-by: Abi Lowrie --- webapp/dotNET/.gitignore | 454 ++++++++++++++++++ webapp/dotNET/WebApplication1.sln | 25 + .../Controllers/FileControllers.cs | 36 ++ .../WebApplication1/FileInfoTemplate.cs | 15 + .../dotNET/WebApplication1/Pages/Index.html | 16 + webapp/dotNET/WebApplication1/Pages/test.html | 10 + webapp/dotNET/WebApplication1/Program.cs | 25 + .../Properties/launchSettings.json | 31 ++ .../WebApplication1/WebApplication1.csproj | 13 + .../WebApplication1.csproj.user | 7 + .../appsettings.Development.json | 8 + .../dotNET/WebApplication1/appsettings.json | 9 + 12 files changed, 649 insertions(+) create mode 100644 webapp/dotNET/.gitignore create mode 100644 webapp/dotNET/WebApplication1.sln create mode 100644 webapp/dotNET/WebApplication1/Controllers/FileControllers.cs create mode 100644 webapp/dotNET/WebApplication1/FileInfoTemplate.cs create mode 100644 webapp/dotNET/WebApplication1/Pages/Index.html create mode 100644 webapp/dotNET/WebApplication1/Pages/test.html create mode 100644 webapp/dotNET/WebApplication1/Program.cs create mode 100644 webapp/dotNET/WebApplication1/Properties/launchSettings.json create mode 100644 webapp/dotNET/WebApplication1/WebApplication1.csproj create mode 100644 webapp/dotNET/WebApplication1/WebApplication1.csproj.user create mode 100644 webapp/dotNET/WebApplication1/appsettings.Development.json create mode 100644 webapp/dotNET/WebApplication1/appsettings.json diff --git a/webapp/dotNET/.gitignore b/webapp/dotNET/.gitignore new file mode 100644 index 0000000..2afa2e2 --- /dev/null +++ b/webapp/dotNET/.gitignore @@ -0,0 +1,454 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Ww][Ii][Nn]32/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET +project.lock.json +project.fragment.lock.json +artifacts/ + +# Tye +.tye/ + +# ASP.NET Scaffolding +ScaffoldingReadMe.txt + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Coverlet is a free, cross platform Code Coverage Tool +coverage*.json +coverage*.xml +coverage*.info + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ + +# Fody - auto-generated XML schema +FodyWeavers.xsd + +## +## Visual studio for Mac +## + + +# globs +Makefile.in +*.userprefs +*.usertasks +config.make +config.status +aclocal.m4 +install-sh +autom4te.cache/ +*.tar.gz +tarballs/ +test-results/ + +# Mac bundle stuff +*.dmg +*.app + +# content below from: https://github.com/github/gitignore/blob/master/Global/macOS.gitignore +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +# content below from: https://github.com/github/gitignore/blob/master/Global/Windows.gitignore +# Windows thumbnail cache files +Thumbs.db +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msix +*.msm +*.msp + +# Windows shortcuts +*.lnk + +# JetBrains Rider +.idea/ +*.sln.iml + +## +## Visual Studio Code +## +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json diff --git a/webapp/dotNET/WebApplication1.sln b/webapp/dotNET/WebApplication1.sln new file mode 100644 index 0000000..053c1a3 --- /dev/null +++ b/webapp/dotNET/WebApplication1.sln @@ -0,0 +1,25 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.2.32630.192 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WebApplication1", "WebApplication1\WebApplication1.csproj", "{2BEC5984-3403-4E6F-97B6-47A2B38B8E3B}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {2BEC5984-3403-4E6F-97B6-47A2B38B8E3B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {2BEC5984-3403-4E6F-97B6-47A2B38B8E3B}.Debug|Any CPU.Build.0 = Debug|Any CPU + {2BEC5984-3403-4E6F-97B6-47A2B38B8E3B}.Release|Any CPU.ActiveCfg = Release|Any CPU + {2BEC5984-3403-4E6F-97B6-47A2B38B8E3B}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {25293B49-E761-48D1-BEE3-C1C6D5B19C23} + EndGlobalSection +EndGlobal diff --git a/webapp/dotNET/WebApplication1/Controllers/FileControllers.cs b/webapp/dotNET/WebApplication1/Controllers/FileControllers.cs new file mode 100644 index 0000000..610200d --- /dev/null +++ b/webapp/dotNET/WebApplication1/Controllers/FileControllers.cs @@ -0,0 +1,36 @@ +using Microsoft.AspNetCore.Mvc; +using Microsoft.AspNetCore.Http; + +namespace WebApplication1.Controllers +{ + [ApiController] + [Route("[controller]")] + public class FileControllers : Controller + { + [HttpGet("/wopi/files/{fileId}")] + // This endpoint gets the information of the file, which id value is being used in the endpoint and returns it + // to the host machiene that is running the webpage from the collabora server. It responds to a GET request at + // http:///wopi/files/. The minimum amount of information needed to be returned is Name and + // Size of the file. + public ActionResult CheckFileInfo() + { + return new FileInfoTemplate + { + BaseFileName = "test.txt", + Size = 11, + UserId = 1, + UserCanWrite = true + }; + } + + [HttpGet("/wopi/files/{fileId}/contents")] + // This endpoint gets the contents of the file, as this a SDK example the content loaded onto the file origionally + // is hardcoded into the system. This is what makes sure when a new page of the SDK is opened it always opens with + // the text 'Hello World'. It is called when the GET request is called at http:///wopi/files//contents + public IActionResult GetFile() + { + var fileContent = "Hello World"; + return base.Content(fileContent); + } + } +} diff --git a/webapp/dotNET/WebApplication1/FileInfoTemplate.cs b/webapp/dotNET/WebApplication1/FileInfoTemplate.cs new file mode 100644 index 0000000..0a8602f --- /dev/null +++ b/webapp/dotNET/WebApplication1/FileInfoTemplate.cs @@ -0,0 +1,15 @@ +// This is a basic class as to the infomation needed to be held about a document. It is used in the GET request +// http:///wopi/files/ endpoint. +namespace WebApplication1 +{ + public class FileInfoTemplate + { + public string BaseFileName { get; set; } + + public int Size { get; set; } + + public int UserId { get; set; } + + public bool UserCanWrite { get; set; } + } +} diff --git a/webapp/dotNET/WebApplication1/Pages/Index.html b/webapp/dotNET/WebApplication1/Pages/Index.html new file mode 100644 index 0000000..c30475a --- /dev/null +++ b/webapp/dotNET/WebApplication1/Pages/Index.html @@ -0,0 +1,16 @@ + + + + + + + +
+ + +
+ + + \ No newline at end of file diff --git a/webapp/dotNET/WebApplication1/Pages/test.html b/webapp/dotNET/WebApplication1/Pages/test.html new file mode 100644 index 0000000..4231204 --- /dev/null +++ b/webapp/dotNET/WebApplication1/Pages/test.html @@ -0,0 +1,10 @@ + + + +
+ + +
+ + \ No newline at end of file diff --git a/webapp/dotNET/WebApplication1/Program.cs b/webapp/dotNET/WebApplication1/Program.cs new file mode 100644 index 0000000..6d1f193 --- /dev/null +++ b/webapp/dotNET/WebApplication1/Program.cs @@ -0,0 +1,25 @@ +var builder = WebApplication.CreateBuilder(args); + +// Add services to the container. + +builder.Services.AddControllers().AddJsonOptions(opition=>opition.JsonSerializerOptions.PropertyNamingPolicy=null); +// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle +builder.Services.AddEndpointsApiExplorer(); +builder.Services.AddSwaggerGen(); + +var app = builder.Build(); + +// Configure the HTTP request pipeline. +if (app.Environment.IsDevelopment()) +{ + app.UseSwagger(); + app.UseSwaggerUI(); +} + +app.UseAuthorization(); + +app.MapControllers(); + + +app.Run(); + diff --git a/webapp/dotNET/WebApplication1/Properties/launchSettings.json b/webapp/dotNET/WebApplication1/Properties/launchSettings.json new file mode 100644 index 0000000..f5ab678 --- /dev/null +++ b/webapp/dotNET/WebApplication1/Properties/launchSettings.json @@ -0,0 +1,31 @@ +{ + "$schema": "https://json.schemastore.org/launchsettings.json", + "iisSettings": { + "windowsAuthentication": false, + "anonymousAuthentication": true, + "iisExpress": { + "applicationUrl": "http://localhost:27487" + //"sslPort": 44340 + } + }, + "profiles": { + "WebApplication1": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "launchUrl": "Swagger", + "applicationUrl": "https://0.0.0.0:7123;http://0.0.0.0:5123", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + }, + "IIS Express": { + "commandName": "IISExpress", + "launchBrowser": true, + "launchUrl": "Swagger", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + } + } +} diff --git a/webapp/dotNET/WebApplication1/WebApplication1.csproj b/webapp/dotNET/WebApplication1/WebApplication1.csproj new file mode 100644 index 0000000..60bf9ea --- /dev/null +++ b/webapp/dotNET/WebApplication1/WebApplication1.csproj @@ -0,0 +1,13 @@ + + + + net6.0 + enable + enable + + + + + + + diff --git a/webapp/dotNET/WebApplication1/WebApplication1.csproj.user b/webapp/dotNET/WebApplication1/WebApplication1.csproj.user new file mode 100644 index 0000000..e4f6e71 --- /dev/null +++ b/webapp/dotNET/WebApplication1/WebApplication1.csproj.user @@ -0,0 +1,7 @@ + + + + MvcControllerEmptyScaffolder + root/Common/MVC/Controller + + \ No newline at end of file diff --git a/webapp/dotNET/WebApplication1/appsettings.Development.json b/webapp/dotNET/WebApplication1/appsettings.Development.json new file mode 100644 index 0000000..0c208ae --- /dev/null +++ b/webapp/dotNET/WebApplication1/appsettings.Development.json @@ -0,0 +1,8 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + } +} diff --git a/webapp/dotNET/WebApplication1/appsettings.json b/webapp/dotNET/WebApplication1/appsettings.json new file mode 100644 index 0000000..10f68b8 --- /dev/null +++ b/webapp/dotNET/WebApplication1/appsettings.json @@ -0,0 +1,9 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + }, + "AllowedHosts": "*" +} From 4c0afed982269d3cf519a91bc4dac1438557beaf Mon Sep 17 00:00:00 2001 From: Abi Lowrie Date: Sat, 3 Sep 2022 22:36:31 +0100 Subject: [PATCH 2/2] POST endpoint Signed-off-by: Abi Lowrie --- .../Controllers/FileControllers.cs | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/webapp/dotNET/WebApplication1/Controllers/FileControllers.cs b/webapp/dotNET/WebApplication1/Controllers/FileControllers.cs index 610200d..d6012e1 100644 --- a/webapp/dotNET/WebApplication1/Controllers/FileControllers.cs +++ b/webapp/dotNET/WebApplication1/Controllers/FileControllers.cs @@ -32,5 +32,29 @@ public IActionResult GetFile() var fileContent = "Hello World"; return base.Content(fileContent); } + + [HttpPost("/wopi/files/{fileId}/contents")] + // This endpoint allows for the files to save to the collabora space. This SDK example outputs in the console, or something + // {need to find this}, the body text put bellow then returns the status code 200; meaning it was a success but only if the + // body has something in, from being edited. Else it returns a failure code of 404. + public IActionResult PutFile() + { + using (StreamReader stream = new StreamReader(HttpContext.Request.Body)) + { + string body = stream.ReadToEndAsync().ToString(); + body = "param=somevalue¶m2=someothervalue"; + + if (body != null) + { + System.Diagnostics.Debug.WriteLine(body); + return StatusCode(200); + } + else + { + return StatusCode(404); + } + } + } + } }