How to limit the image size on the backend image upload no matter if it is to an existing library or a newly created on via the API

How to limit the image size on the backend image upload no matter if it is to an existing library or a newly created on via the API?

Oct 3, 2018
Knowledge

Title

URL Name

How-to-limit-the-image-size-on-the-backend-image-upload-no-matter-if-it-is-to-an-existing-library-or-a-newly-created-on-via-the-API

Article Number

000111118

Environment

Product: Sitefinity Version: 8.x, 9.x, 10.x, 11.x, 12.x, 13.x OS: All supported OS versions Database: All supported Microsoft SQL Server versions

Question/Problem Description

How to limit the image size on the backend image upload no matter if it is to an existing library or a newly created on via the API?

Steps to Reproduce

Clarifying Information

Error Message

Defect Number

Enhancement Number

Cause

Resolution

This can be achieved by extending the "OpenAccessLibrabriesProvider" class and overriding a method called "ValidateUpload" where this logic is happening.

1. Create a custom class, for example, named "CustomOpenAccessLibrarbiesProvider" and put it in the root of the project.
2. Inherit the class "OpenAccessLibrariesProvider".
3. Add the following code:

using System;
using Telerik.Sitefinity.Libraries.Model;
using Telerik.Sitefinity.Modules.Libraries;
using Telerik.Sitefinity.Modules.Libraries.Data;

namespace SitefinityWebApp
{
    public class CustomOpenAccessLibrarbiesProvider : OpenAccessLibrariesProvider
    {
        protected override bool ValidateUpload(MediaContent content, System.IO.Stream source, string extension)
        {
            if (content.GetType() == typeof(Image))
            {
                // Extend the allowed extension in the same manner as below with the "||" operator.
                if (extension == ".jpg" || extension == ".png")
                {
                    // The value of the source.length is calculated in bytes.
                    if (source.Length >= 1024000)
                    {
                        // Alter the exception message in the desired way.
                        throw new LibraryItemUploadException(
                        String.Format("'{0}' could not be uploaded, because the maximum allowed file size of images is {1} bytes.", content.Title, source.Length));
                    }
                }
            }
            return base.ValidateUpload(content, source, extension);
        }
    }
}

Note the sample above contains comments that explain how to further extend the limitation on image file extensions, size and exception message.

4. Build the application.

5. Register the custom OpenAccess Libraries Provider, so that the customization can take effect, under Administration->Settings->Advanced->Libraries->Provider->OpenAccessDataProvider and change the ProviderType from the default one to the custom one and click "Save":

-- If the custom provider class is located in the root of the project, the registration should look like this:

SitefinityWebApp.CustomOpenAccessLibrarbiesProvider, SitefinityWebApp

Refer to the screenshot below:

Registration Of TheCustom OpenAccess Libraries Provider

Registration Of TheCustom OpenAccess Libraries Provider

6. Restart the application so that Sitefinity will take the custom libraries provider into an account.

Workaround

Notes

Keyword Phrase

Last Modified Date

8/5/2020 8:55 AM

How to limit the image size on the backend image upload no matter if it is to an existing library or a newly created on via the API

Files(0)

Was this article helpful?

Was this article helpful?

How to limit the image size on the backend image upload no matter if it is to an existing library or a newly created on via the API

Information

Related Articles