Skip to main content

A simple FeinCMS extension that adds permission-checking to a model.

Project description

A simple FeinCMS extension that adds permission-checking to a model. The model is assumed to be a Page, but it could be any FeinCMS model.

Usage

Install using pip:

pip install feincms-pagepermissions

Change your Django settings to include pagepermissions:

INSTALLED_APPS += (
    'pagepermissions',
)

Then add the extension to your content type:

Page.register_extensions(
    ...
    'pagepermissions.extension',
)

If you need to specify arguments for permissions field, i.e. limit_choices_to:

from pagepermissions.extension import ExtensionFactory as PagePermissionExtensionFactory

Page.register_extensions(
    ...
    PagePermissionExtensionFactory.with_model_params(
        'MyCustomPermissionExt',
        limit_choices_to=Q()
    ),
)

This will add a permissions field to your content type that you will have to add yourself through syncdb or South or otherwise.

When you edit or add a page you will have the option of setting the permissions required for a user to view that page. You can select multiple permissions, and if the user has any of those they will be able to view the page. Otherwise they will receive a 403.

Finally, you may also want to keep a page out of the navigation if the user has no permission to view it. For this, there is a template filter called check_page_permission. Use it as follows in your template:

{% load feincms_page_tags feincms_pagepermissions_tags %}

{% feincms_nav feincms_page level=1 depth=1 as level1 %}
{% for page in level1 %}
    {% if page|check_page_permission:user %}
       ...display page navigation...
    {% endif %}
{% endfor %}

Contributing

Your pull requests are very welcome! Please follow the established code style.

License

feincms-pagepermissions is released under the BSD license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

feincms-pagepermissions-0.3.4.tar.gz (4.1 kB view details)

Uploaded Source

File details

Details for the file feincms-pagepermissions-0.3.4.tar.gz.

File metadata

  • Download URL: feincms-pagepermissions-0.3.4.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.7

File hashes

Hashes for feincms-pagepermissions-0.3.4.tar.gz
Algorithm Hash digest
SHA256 b86acf65d3619f8acde3e5d76b79929204f735bd0b9dbb0d88b05eae867f0f53
MD5 be5e220812a4f627162c40742105cf73
BLAKE2b-256 91b196180a352bb2ad43e394416793ad12b3f69c17fa8bdcfafa15a85fa7a100

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page