zoumaho / backload Goto Github PK

=========== Backload is a professional, full featured file upload controller and handler (server side) for ASP.NET MVC 4, MVC 5, Web API and standard ASP.NET Web Forms (see code examples). It has been developed as part of a commercial product for the aero craft industry. While Backload out of the box handles the client side jQuery File Upload Plugin from blueimp, PlUpload from Moxiecode and Fine Uploader from Widen Enterprises, it can be easily customized to work with any client side plugin (see Example 09 or Example 10.

General information, editions and how to get a Pro/Enterprise license: http://backload.org.

Cloud storage will mark our next milestone. We start with giving you the basic means storing data in a cloud storage in the same manner Backload provides for the local file system or databases. Then we will support popular cloud storage providers out of the box. Help is much appreciated! Don't hesitate to show us your code or help develop cloud storage extensions.

Backload is a feature rich server side component which can be fully customized (declaratively) within the web.config file (resp. a linked config file). Complex storage structures are supported and handled by the component without a single line of code, whether the storage location is the file system or a database. If you want to upload different file types (images, pdfs, doc, etc) content type based subfolders can be configured to automatically store different file types in different sub folders (e.g. /images, /pdfs, /movies, etc).

The zero configuration feature allows quick setups, a default MVC controller is ready to handle incoming requests. For more complex scenarios, where you have to run your own business logic, you can derive from the default controller or call the handler method from your code.

Backload supports cropping and resizing of images. The parameters can be set within the web.config file or by an incoming request from the client. Multiple image manipulation features are implemented. Type conversion is also supported.

Backload can create unique file names (GUIDs). So files cannot be overwritten or, if this is the purpose of using this feature, cannot be accessed from the web without knowledge of the new name. Mapping of the original file name to the new file name and back is also implemented. This feature can be used to send a friendly name back to the client.

Backload is extensible. Extensions are normal, easy to write classes, implementing a simple interface and decorated with an ExportAttribute. Using extensions is a very cheap process regarding system resources. They are very good testable, scalable, isolate code and can be dynamically added and removed while the MVC app is running. You may want to add a new functionality (e.g. exception logging, change client side plugin, etc.) or perform tests without changing or stopping the application (See examples 08+).

Backload has proven its scalability in production with hundreds of thousands uploads a day. Internally it is designed to work asynchronously where possible and it supports and encourages the development of asynchronous extensions.

• Zero configuration: The defaults set up a fully functional server side file upload controller and handler.
• Declarative configuration: Features will be setup within the web.config or a linked config file.
• Storage context: Supported locations are file system and databases (by the Entity Framework) and cloud (next milestone).
• Object context based locations: Based on the context (e.g. UserX, UserY, ArtistX, ArtistY, HouseA, HouseB) different storage locations can automatically be routed.
• Content type subfolders: Based on the content type files can automatically be stored in an appropriate subfolder. This feature is fully customizable.
• Unique file names: Files can be stored with a unique name and also remapped to their original name.
• Cropping and resizing: This can be setup in the web.config file or in a request from the client.
• Image type conversion: Images can be converted to a different target type.
• Thumbnails: Static (stored in a subfolder) or dynamically (created on a request).
• Security: Access control with authentication and authorization (roles based).

• Extensibility (coming release): Dynamically hook in your own extensions. (Multiple extensions for a specific processing step are supported).
• Eventing: Backloads processing pipeline events enable full control of the request/response data and execution flow.
• Scalability by asynchronous internal code and asynchronous support for events and extensions.
• Tracing: Use standard .NET tracing to find proplems during development or log errors in production.

Setup instructions

Options, settings and enumerations

Example 01: Zero configuration
Example 02: Configuration basics: Using web.config
Example 03: Configuration basics: Using an external config file
Example 04: Using your own controllers
Example 05: Using server side image manipulation features
Example 06: Managing subfolders: Using the object context
Example 07: Managing subfolders: Using the upload context
Example 08: Extensibility: Writing a simple extension
Example 09: Extensibility: Handle and extend the PlUpload plugin (Moxiecode)
Example 10: Handling exceptions
Example 11: Asynchronous operations with async/await, Tasks and Threads
Example 12: Eventing: Using Backloads server side events
Example 13: Tracing: Use tracing to identify problems and log errors
Code example: How to use the Backload component with the Web API and standard ASP.NET WebForms

The original demo shipped with the JQuery File Upload Plugin working with the Backload the server side component can be found here.

Before posting read the faq

You can get a license for a Professional or Enterprise edition here: http://backload.org/editions.html. Or read the FAQ about the different licenses

Follow us on Twitter (just started) @Backload_org

For customers and commercial requests only: backload.mvc [at] gmail [dot] com.

Backload. (Standard version): Copyright 2014, Steffen Habermehl, License (Standard version): MIT license
Professional and Enterprise (source code) version are available under a commercial license.
Follow us on Twitter: @Backload_org