Project Policy Configuration

Since 4.0.0

The project policy configuration file allows the user to configure conditions for content being added to the project (via uploads), such as minimum/maximum size of files, etc.

Note that the project policy does not apply to content created via the UI.

CrafterCMS supports the following project policies:

• Filename allowed patterns and automatic renaming rules

• File size limits

• MIME-type limits

• Content-type limits

To modify the project policy configuration, click on from the Sidebar, then click on Configuration and select Project Policy Configuration from the dropdown list.

Sample

Here’s a sample Project Policy Configuration file (click on the triangle on the left to expand/collapse):

Sample project policy configuration

CRAFTER_HOME/data/repos/sites/SITENAME/sandbox/config/studio/site-policy-config.xml

<?xml version="1.0" encoding="UTF-8" ?>

<!--
  ~ Copyright (C) 2007-2022 Crafter Software Corporation. All Rights Reserved.
  ~
  ~ This program is free software: you can redistribute it and/or modify
  ~ it under the terms of the GNU General Public License version 3 as published by
  ~ the Free Software Foundation.
  ~
  ~ This program is distributed in the hope that it will be useful,
  ~ but WITHOUT ANY WARRANTY; without even the implied warranty of
  ~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  ~ GNU General Public License for more details.
  ~
  ~ You should have received a copy of the GNU General Public License
  ~ along with this program.  If not, see <http://www.gnu.org/licenses/>.
  -->

<site-policy>

    <!--
        This file can contain any number of statements to control the content added to the site:

        <statement>
            <target-path-pattern/> (Regular expression that will be compared against the path of the content)

            <permitted>
                (All elements in this section are optional and can be used in any combination)

                <minimum-file-size/> (Minimum size of the file in bytes)
                <maximum-file-size/> (Maximum size of the file in bytes)

                <mime-types/> (Comma separated list of MIME types, also support wildcards)

                <content-types/> (Comma separated list of content-types)

                <path> (Apply to CREATE action)
                    <source-regex/> (Regular expression to validate the file name or folder name)
                    <target-regex caseTransform="lowercase"/> (Expression to transform the file name or folder name)
                </path>

            </permitted>
            <denied>
                (mime-types or content-types are available)
                <mime-types/> (Comma separated list of MIME types, also support wildcards)
                <content-types/> (Comma separated list of content-types)
            </denied>
        </statement>
    -->

    <!-- Example: only allow images of less than 1 MB -->
    <!-- disable svg files -->
    <statement>
        <target-path-pattern>/static-assets/images/.*</target-path-pattern>
        <permitted>
            <maximum-file-size>1000000</maximum-file-size>
            <mime-types>image/*</mime-types>
        </permitted>
        <denied>
            <mime-types>image/svg+xml</mime-types>
        </denied>
    </statement>

</site-policy>

---

Examples

Let’s take a look at some example project policy configurations.

Mime Types

The example configuration below (as seen in the default project policy configuration) disallows svg image file uploads:

<!-- disable svg files -->
<statement>
  <target-path-pattern>/.*</target-path-pattern>
  <permitted>
    <mime-types>*/*</mime-types>
  </permitted>
  <denied>
    <mime-types>image/svg+xml</mime-types>
  </denied>
</statement>

Whenever a user tries to upload an svg image, the user will see a message on the screen informing them that it doesn’t comply with the project policies and can’t be uploaded like below:

File Size Limits

Limiting file size of uploads is supported. Simply add <minimum-file-size/> and/or <maximum-file-size/> under <permitted> where the minimum and maximum file sizes are in bytes

The example configuration below limits image uploads to less than 1MB in folder /static-assets/images/.

<!-- Example: only allow images of less than 1 MB -->
<statement>
  <target-path-pattern>/static-assets/images/.*</target-path-pattern>
  <permitted>
    <maximum-file-size>1000000</maximum-file-size>
    <mime-types>image/*</mime-types>
  </permitted>
</statement>

Whenever a user tries to upload an image that is larger than 1 MB in the /static-assets/images/ folder, the user will see a message on the screen informing them that it doesn’t comply with project policies and can’t be uploaded like below:

Transform File Names

CrafterCMS supports transforming filenames of uploaded files and convert the filenames to lower case or upper case. Simply set caseTransform to either lowercase or uppercase in target-regex to convert to your required case.

The example configuration below (as seen in the default project policy configuration) converts parenthesis ( ( and ) ) and spaces in filenames to a dash ( - ) and lower cases all the letters in filenames for files uploaded to the /static-assets/ folder .

<statement>
  <target-path-pattern>/static-assets/.*</target-path-pattern>
  <permitted>
    <path>
      <source-regex>[\(\)\s]</source-regex>
      <target-regex caseTransform="lowercase">-</target-regex>
    </path>
  </permitted>
</statement>

Whenever a user uploads a file with upper case letters or spaces and parenthesis in the filename, in the /static-assets/ folder, the user will see a message on the screen informing them that it doesn’t comply with project policies and will be asked if they would like to continue upload with the suggested name like below: