Netigent.Utils.FileStoreIO 1.4.3

FileStoreIOClient

A generic layer to allow the saving and loading of files from configurable stores using a unique fileRef with prefix code for detection in your code.
Supports UNC (FileSystem), Database, Box, and AWS S3 Buckets.

License

This library is licensed under the Apache License 2.0.

• Full commercial use is allowed (including in closed-source products, SaaS, or sold software — no royalties or source-sharing required).
• Explicit patent grant from contributors for any patents necessarily infringed by their contributions.
• Strong disclaimers: Provided "AS IS", WITHOUT WARRANTIES of any kind (express or implied). Use at your own risk — no liability for any damages.
• Full license text: LICENSE (in the repository root).

Contributions you make are automatically licensed under the same Apache 2.0 terms.

How to Use

Thanks for considering this library — we hope it saves you time and simplifies file handling!

The library supports multiple storage providers (Database, FileSystem/UNC, Box, AWS S3) and uses a consistent fileRef (e.g., _$uniqueid) for all operations.

Database Notes

The library auto-creates and upgrades the FileStoreIndex table in the specified schema.
You can safely drop unused legacy columns: [FileType], [MainGroup], [SubGroup], [PathTags] — they are no longer used.

Quick Start

Direct Usage (keeping last 3 versions)

// Example configuration objects (use your real values!)
var myBoxConfig = new BoxConfig { /* ... your Box settings ... */ };
var myS3Config  = new S3Config  { /* ... your S3 settings ... */ };
var myFsConfig  = new FileSystemConfig { RootFolder = @"C:\temp\Files\", StoreFileAsUniqueRef = false };

var fileStoreIOClient = new FileStoreIOClient(
    appPrefix: "MyApp",
    databaseConnection: "Server=.;Database=myDb;Trusted_Connection=True;",
    maxVersions: 3,
    dbSchema: "filestore",
    defaultFileStore: FileStorageProvider.FileSystem,  // or S3, Database, Box
    boxConfig: myBoxConfig,
    s3Config: myS3Config,
    fileSystemConfig: myFsConfig);

// Example: Get a file by ref
var file = await fileStoreIOClient.File_GetAsyncV2("_$23fe627c5a5b410aa6017db308b71077");

Using Dependency Injection (recommended for ASP.NET Core)

appSettings.json example (keeping last 5 versions)

"FileStoreIO": {
  "Database": "Server=.;Database=myDatabase;UID=mySa;PWD=myPassword;",
  "AppPrefix": "MyAppToScopeTo",
  "FilePrefix": "_$",
  "DatabaseSchema": "filestore",
  "MaxVersions": 5,
  "DefaultStorage": "S3",
  "S3": {
    "AccessKey": "ExampleAccessKey",
    "SecretKey": "mysecretkeyinhere+",
    "Region": "us-west-2",
    "BucketName": "my-example-bucket-name"
  },
  "Box": {
    "EnterpriseID": "123456789",
    "AutoCreateRoot": false,
    "TimeoutInMins": 15,
    "BoxAppSettings": {
      "ClientID": "exampleid12345",
      "ClientSecret": "examplesecret12345",
      "AppAuth": {
        "Passphrase": "examplepassphrase12345",
        "PrivateKey": "-----BEGIN ENCRYPTED PRIVATE KEY-----\nEXAMPLEEXAMPLEEXAMPLE\n-----END ENCRYPTED PRIVATE KEY-----\n",
        "PublicKeyID": "abc1234"
      }
    }
  },
  "FileSystem": {
    "RootFolder": "c:\\temp\\files\\",
    "StoreFileAsUniqueRef": false
  }
}

Registering in Startup.cs

public void ConfigureServices(IServiceCollection services)
{
    // Inject FileStoreIOClient provider
    services.Configure<FileStoreIOConfig>(Configuration.GetSection(FileStoreIOConfig.Section));
    services.AddSingleton<Netigent.Utils.FileStoreIO.IFileStoreIOClient, FileStoreIOClient>();
}

Usage in a Controller Example

using Netigent.Examples.UploadApp.Models;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Netigent.Utils.FileStoreIO;
using Netigent.Utils.FileStoreIO.Enums;
using System.Threading.Tasks;

namespace Netigent.Examples.UploadApp.Controllers
{
    public class HomeController : Controller
    {
        private readonly IFileStoreIOClient _ioClient;

        public HomeController(IFileStoreIOClient fileStoreIOClient)
        {
            _ioClient = fileStoreIOClient;
        }

        public async Task<IActionResult> Index()
        {
            ViewBag.Message = TempData["Message"];
            return View(new FileUploadViewModel { Files = await _ioClient.Files_GetAll() });
        }

        [HttpPost]
        [ActionName("Upload")]
        public async Task<IActionResult> Upload(IFormFile selectedFile, string location = "database", string description = "", string customerCode = "", string itemType = "")
        {
            var uploadLocation = (location ?? "").Equals("Database", StringComparison.CurrentCultureIgnoreCase)
                ? FileStorageProvider.Database
                : FileStorageProvider.FileSystem;

            var uploadedCode = await _ioClient.File_UpsertAsync(selectedFile, uploadLocation, description: description, customerCode, itemType);

            TempData["Message"] = $"File successfully uploaded to {uploadLocation} {uploadedCode}";

            // Setting success properties
            TempData["FileId"] = uploadedCode;
            TempData["FileLink"] = $"https://localhost:44317/Home/GetFile/{uploadedCode}";

            // Example: render dynamic images from FileStoreIOClient
            // e.g. <img src="@TempData["FileLink"]" style="height: 100px; width: auto;" />

            return RedirectToAction("Index");
        }

        public async Task<IActionResult> GetFile(string id)
        {
            var file = await _ioClient.File_Get(id);
            if (file == null) return NotFound();

            return File(file.Data, file.ContentType, file.Name);
        }

        public async Task<IActionResult> DeleteFile(string id)
        {
            // var xyz = await something();  // Remove or replace placeholder
            var fileInfo = await _ioClient.File_DeleteAsync(id);
            return RedirectToAction("Index");
        }
    }
}

Version History Highlights

1.4.3
Fixed License link in README.

1.4.2
Added MimeType helper for SVG = image/svg+xml (see changes in 1.4.0).

1.4.1
Bug fix on absolute paths in FileSystem storage (see changes in 1.4.0).

1.4.0

• Marked old methods as obsolete:

  List<InternalFileModel> Files_GetAllV2(string[] pathTags, bool recursiveSearch = false);
  List<InternalFileModel> Files_GetAllV2(string relationalFilePathAndName, bool recursiveSearch = false);
  

  Use these clearer alternatives instead:

  List<FileStoreItem> Files_GetByFolder(string folderPath, bool includeSubFolders = false);
  List<FileStoreItem> Files_GetByFileAndFolder(string folderPath, bool includeSubFolders, string fileToFind, bool exactFileMatch);
  

• Removed Microsoft.AspNetCore.Http.Features dependency (Upsert methods for IFormFile removed — use byte[] directly):

  IFormFile myFile = ...;  // from HttpRequest
  
  using var dataStream = new MemoryStream();
  await myFile.CopyToAsync(dataStream);
  string fileRef = await fileStoreIOClient.File_UpsertAsyncV2("HT/Training/myprocedures.pdf", dataStream.ToArray());
  

• Renamed models for clarity:
  FileObjectModel → FileOutput (simple output for sending to clients)
  InternalFileModel → FileStoreItem (full record from FileStoreIndex table)
• FileStoreIndex table now uses Folder column (PathTags deprecated but kept for reference).

1.3.0
Added support for relocating files:

Task<ResultModel> File_MoveAsync(string fileRef, string[] pathTags);
Task<ResultModel> File_MoveAsync(string fileRef, string relationalFilePathAndName);

1.2.1
Bug fix: Subfile replaced by single Parent. RecursiveSearch = false is now default.

1.2.0
Added recursive flag to Files_GetAllV2. Removed obsolete legacy methods.

1.1.7
Bug fix for AppPrefix not populating correctly. Upgraded to .NET 8.0 LTS + package updates.

1.1.6
Database migration: Include AppPrefix in PathTags (run this SQL if files "disappeared" after v1.1.5):

UPDATE {schema}.[FileStoreIndex] 
SET PathTags = '{AppPrefix}/' + PathTags 
WHERE PathTags NOT LIKE '{AppPrefix}%';

1.1.5
README updates and stabilization.

1.1.4
Internal database upgrade.

1.1.3
Added README.md to NuGet package.

(Older versions omitted for brevity — see commit history for full details.)

Contributing

Contributions are very welcome — from individuals, companies, bug hunters, feature requesters, and documentation helpers alike!

This project uses Apache 2.0 with an explicit patent grant, so companies can contribute safely with mutual patent protection.

How to contribute:

1. Fork https://github.com/netigent/file-store-io
2. Create a branch: git checkout -b feature/my-cool-change
3. Make your changes + add tests if possible
4. Push and open a Pull Request

We especially appreciate:

• Support for new storage providers
• Performance improvements
• Better error handling / logging
• Documentation / examples
• Bug fixes

Open an issue first for big changes or questions.
Thanks in advance — your help makes this library better for everyone!

Questions / Issues

Found a bug? Have a feature idea?
→ Open an issue here: https://github.com/netigent/file-store-io/issues

Enjoy using FileStoreIOClient!