Commit 9eecb916 authored by Vajrasky Kok's avatar Vajrasky Kok Committed by Tim Graham
Browse files

Fixed #21219 -- Added a way to set different permission for static files. 

Previously, when collecting static files, the files would receive permission
from FILE_UPLOAD_PERMISSIONS. Now, there's an option to give different
permission from uploaded files permission by subclassing any of the static
files storage classes and setting the file_permissions_mode parameter.

Thanks dblack at atlassian.com for the suggestion.
parent c052699b

django/core/files/storage.py

+7 −3
Original line number Diff line number Diff line
@@ -147,7 +147,7 @@ class FileSystemStorage(Storage): 
    Standard filesystem storage

    """



    def __init__(self, location=None, base_url=None):

    def __init__(self, location=None, base_url=None, file_permissions_mode=None):

        if location is None:

            location = settings.MEDIA_ROOT

        self.base_location = location
@@ -155,6 +155,10 @@ class FileSystemStorage(Storage): 
        if base_url is None:

            base_url = settings.MEDIA_URL

        self.base_url = base_url

        self.file_permissions_mode = (

            file_permissions_mode if file_permissions_mode is not None

            else settings.FILE_UPLOAD_PERMISSIONS

        )



    def _open(self, name, mode='rb'):

        return File(open(self.path(name), mode))
@@ -232,8 +236,8 @@ class FileSystemStorage(Storage): 
                # OK, the file save worked. Break out of the loop.

                break



        if settings.FILE_UPLOAD_PERMISSIONS is not None:

            os.chmod(full_path, settings.FILE_UPLOAD_PERMISSIONS)

        if self.file_permissions_mode is not None:

            os.chmod(full_path, self.file_permissions_mode)



        return name

docs/ref/contrib/staticfiles.txt

+26 −2
Original line number Diff line number Diff line
@@ -32,8 +32,6 @@ following settings: 
Management Commands

===================



.. highlight:: console



``django.contrib.staticfiles`` exposes three management commands.



collectstatic
@@ -61,6 +59,30 @@ receives all command line options of :djadmin:`collectstatic`. This is used 
by the :class:`~django.contrib.staticfiles.storage.CachedStaticFilesStorage`

by default.



By default, collected files receive permissions from

:setting:`FILE_UPLOAD_PERMISSIONS`. If you would like different permissions for

these files, you can subclass either of the :ref:`static files storage

classes <staticfiles-storages>` and specify the ``file_permissions_mode``

parameter. For example::



    from django.contrib.staticfiles import storage



    class MyStaticFilesStorage(storage.StaticFilesStorage):

        def __init__(self, *args, **kwargs):

            kwargs['file_permissions_mode'] = 0o640

            super(CustomStaticFilesStorage, self).__init__(*args, **kwargs)



Then set the :setting:`STATICFILES_STORAGE` setting to

``'path.to.MyStaticFilesStorage'``.



.. versionadded:: 1.7



    The ability to override ``file_permissions_mode`` is new in Django 1.7.

    Previously the file permissions always used

    :setting:`FILE_UPLOAD_PERMISSIONS`.



.. highlight:: console



Some commonly used options are:



.. django-admin-option:: --noinput
@@ -174,6 +196,8 @@ Example usage:: 


    django-admin.py runserver --insecure



.. _staticfiles-storages:



Storages

========

docs/ref/files/storage.txt

+11 −2
Original line number Diff line number Diff line
@@ -29,13 +29,23 @@ Django provides two convenient ways to access the current storage class: 
The FileSystemStorage Class

---------------------------



.. class:: FileSystemStorage

.. class:: FileSystemStorage([location=None, base_url=None, file_permissions_mode=None])



    The :class:`~django.core.files.storage.FileSystemStorage` class implements

    basic file storage on a local filesystem. It inherits from

    :class:`~django.core.files.storage.Storage` and provides implementations

    for all the public methods thereof.



    .. attribute:: file_permissions_mode



        The file system permissions that the file will receive when it is

        saved. Defaults to :setting:`FILE_UPLOAD_PERMISSIONS`.



        .. versionadded:: 1.7



            The ``file_permissions_mode`` attribute was added. Previously files

            always received :setting:`FILE_UPLOAD_PERMISSIONS` permissions.



    .. note::



        The ``FileSystemStorage.delete()`` method will not raise
@@ -81,7 +91,6 @@ The Storage Class 
        available for new content to be written to on the target storage

        system.





    .. method:: get_valid_name(name)



        Returns a filename based on the ``name`` parameter that's suitable

docs/ref/settings.txt

+4 −0
Original line number Diff line number Diff line
@@ -1159,6 +1159,10 @@ dependent behavior. On most platforms, temporary files will have a mode 
of ``0600``, and files saved from memory will be saved using the

system's standard umask.



This setting also determines the default permissions for collected static files

when using the :djadmin:`collectstatic` management command. See

:djadmin:`collectstatic` for details on overridding it.



.. warning::



    **Always prefix the mode with a 0.**

docs/releases/1.7.txt

+9 −0
Original line number Diff line number Diff line
@@ -226,6 +226,15 @@ Minor features 
  :class:`~django.middleware.http.ConditionalGetMiddleware` to handle

  conditional ``GET`` requests for sitemaps which set ``lastmod``.



:mod:`django.contrib.staticfiles`

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



* The :ref:`static files storage classes <staticfiles-storages>` may be

  subclassed to override the permissions that collected static files receive by

  setting the

  :attr:`~django.core.files.storage.FileSystemStorage.file_permissions_mode`

  parameter. See :djadmin:`collectstatic` for example usage.



:mod:`django.contrib.syndication`

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^