cms.contrib.admin package

Submodules

cms.contrib.admin.actions module

Additional, globally-available admin actions.

cms.contrib.admin.actions.status_discarded_selected(modeladmin, request, queryset)
cms.contrib.admin.actions.status_draft_selected(modeladmin, request, queryset)
cms.contrib.admin.actions.status_publish_selected(modeladmin, request, queryset)
cms.contrib.admin.actions.status_readyforreview_selected(modeladmin, request, queryset)
cms.contrib.admin.actions.status_selected(modeladmin, request, queryset, status, message)

Default action which sets status of the selected objects.

If the user has no permission one of the related childs (foreignkeys), a ‘permission denied’ message.

It set status of all selected objects and redirects back to the change list.

cms.contrib.admin.admin module

class cms.contrib.admin.admin.AdminNotification

Bases: object

Base class for notifications in admin.

description = None
get_context(request)
get_extra_context(request)
get_objects(request)
get_title(request, count=None)
get_url(request)
has_perms = False
icon_class = None
level = 'low'
model = None
perms = ()
url_blank = False
class cms.contrib.admin.admin.CMSAdmin(model, admin_site)

Bases: reversion.admin.VersionAdmin

action_form

alias of ActionForm

change_form_template = 'admin/change_form.html'
change_list_template = 'admin/change_list.html'
changelist_stats_view(request, extra_context=None)
fields_with_sibling = ()
fieldsets = ()
formfield_for_foreignkey(db_field, request=None, **kwargs)
formfield_for_manytomany(db_field, request=None, **kwargs)
get_action_choices(request, default_choices=[(u'', u'---------')])

Return a list of choices for use in a form object. Each choice is a tuple (name, description).

Modified to support actions-grouping

get_actions(request)

Return a dictionary mapping the names of all actions for this ModelAdmin to a tuple of (callable, name, description) for each action.

Modified to support actions-grouping

get_change_view_info(request, obj)

Lookup for function _get_change_view_info in all classes call it and add to list. Could be dismissed by overwriting this function.

get_changelist(request, **kwargs)

Returns the ChangeList class for use on the changelist page.

get_changelist_actions(obj)

Lookup for function _get_changelist_actions in all classes call it and add to list and join <br />. Can be dismissed by overwriting this function.

get_changelist_meta(obj)
get_changelist_relation_html(objs)
get_inline_instances(request, obj=None)
get_queryset(request)
get_urls()
history_latest_first = True
list_display_meta = ()
list_exclude = ()
list_per_page = 50
list_stats_queryset_by = ('created_date',)
media
queryset(*args, **kwargs)
render_change_form(request, context, add=False, change=False, form_url='', obj=None)
save_formset(request, form, formset, change)

Check for BaseGenericInlineFormSet and lookup for common fields. TODO: rework

save_model(request, obj, form, change)

When creating a new object, set the created_by field, else update the modified_by field

class cms.contrib.admin.admin.CMSChangeList(request, model, list_display, list_display_links, list_filter, date_hierarchy, search_fields, list_select_related, list_per_page, list_max_show_all, list_editable, model_admin)

Bases: django.contrib.admin.views.main.ChangeList

get_filters(request)

Sort filter according to their titles

get_query_set(*args, **kwargs)
get_queryset(request)

Modified to respect sorting through filters. Filter can set force_ordering as a attribute to sort the queryset by values.

is_filtered()
class cms.contrib.admin.admin.CMSGenericStackedInline(parent_model, admin_site)

Bases: cms.contrib.admin.admin.CMSInlineMixin, django.contrib.contenttypes.admin.GenericStackedInline

media
class cms.contrib.admin.admin.CMSGenericTabularInline(parent_model, admin_site)

Bases: cms.contrib.admin.admin.CMSInlineMixin, django.contrib.contenttypes.admin.GenericTabularInline

media
class cms.contrib.admin.admin.CMSInlineMixin

Bases: object

extra = 0
extra_on_add = 0
get_extra(request, obj=None, **kwargs)

Hook for customizing the number of extra inline forms.

class cms.contrib.admin.admin.CMSStackedInline(parent_model, admin_site)

Bases: cms.contrib.admin.admin.CMSInlineMixin, django.contrib.admin.options.StackedInline

media
class cms.contrib.admin.admin.CMSTabularInline(parent_model, admin_site)

Bases: cms.contrib.admin.admin.CMSInlineMixin, django.contrib.admin.options.TabularInline

media
class cms.contrib.admin.admin.CleanupExpiredAdmin(model, admin_site)

Bases: django.contrib.admin.options.ModelAdmin

cleanupexpired_view(*args, **kwargs)
get_urls()
media
class cms.contrib.admin.admin.LogEntryAdmin(model, admin_site)

Bases: cms.contrib.admin.admin.CMSAdmin

date_hierarchy = 'action_time'
get_action_time(obj)
get_change_view_info = False
get_changelist_actions(obj)
get_content_type(obj)
get_info(obj)
get_readonly_fields(request, obj=None)
has_add_permission(request)
has_change_permission(request, obj=None)
has_delete_permission(request, obj=None)
list_display = ('get_action_time', 'get_info', 'get_content_type', 'user')
list_display_meta = ('action_flag',)
list_filter = (<class 'cms.contrib.admin.filters.LogEntryActionListFilter'>, 'action_time', 'content_type__app_label', 'content_type__model', <class 'cms.contrib.accounts.filters.AccountsAccountStaffListFilter'>)
list_stats_queryset_by = ('action_time',)
log_addition(request, object)
log_change(request, object, message)
log_deletion(request, object, object_repr)
media
search_fields = ('object_repr', 'change_message')
class cms.contrib.admin.admin.LogEntryModelstatsDashboardModule(request)

Bases: cms.contrib.modelstats.modules.ModelstatsDashboardModule

date_field = 'action_time'
get_objects(request)
icon_class = 'icon-app-admin-log'
model

alias of LogEntry

class cms.contrib.admin.admin.LogEntryModelstatsUserModule

Bases: cms.contrib.modelstats.modules.ModelstatsUserModule

get_objects(request)
has_perms = True
icon_class = 'icon-app-admin-log'
model

alias of LogEntry

user_field = 'user'

cms.contrib.admin.apps module

class cms.contrib.admin.apps.AdminConfig(app_name, app_module)

Bases: django.apps.config.AppConfig

label = 'cms_admin'
name = 'cms.contrib.admin'
patch_admin()
ready()

cms.contrib.admin.cms_defaults module

cms.contrib.admin.cms_plugin module

class cms.contrib.admin.cms_plugin.CMSPlugin

Bases: cms.core.plugins.CMSPluginBase

admin_icon_class = 'icon-pstriangle'
description = <django.utils.functional.__proxy__ object at 0x244d950>
staticfiles = {'admin': {'fonts': ['open-sans-v10-latin-300.eot', 'open-sans-v10-latin-300italic.eot', 'open-sans-v10-latin-300italic.svg', 'open-sans-v10-latin-300italic.ttf', 'open-sans-v10-latin-300italic.woff', 'open-sans-v10-latin-300italic.woff2', 'open-sans-v10-latin-300.svg', 'open-sans-v10-latin-300.ttf', 'open-sans-v10-latin-300.woff', 'open-sans-v10-latin-300.woff2', 'open-sans-v10-latin-600.eot', 'open-sans-v10-latin-600italic.eot', 'open-sans-v10-latin-600italic.svg', 'open-sans-v10-latin-600italic.ttf', 'open-sans-v10-latin-600italic.woff', 'open-sans-v10-latin-600italic.woff2', 'open-sans-v10-latin-600.svg', 'open-sans-v10-latin-600.ttf', 'open-sans-v10-latin-600.woff', 'open-sans-v10-latin-600.woff2', 'open-sans-v10-latin-700.eot', 'open-sans-v10-latin-700italic.eot', 'open-sans-v10-latin-700italic.svg', 'open-sans-v10-latin-700italic.ttf', 'open-sans-v10-latin-700italic.woff', 'open-sans-v10-latin-700italic.woff2', 'open-sans-v10-latin-700.svg', 'open-sans-v10-latin-700.ttf', 'open-sans-v10-latin-700.woff', 'open-sans-v10-latin-700.woff2', 'open-sans-v10-latin-800.eot', 'open-sans-v10-latin-800italic.eot', 'open-sans-v10-latin-800italic.svg', 'open-sans-v10-latin-800italic.ttf', 'open-sans-v10-latin-800italic.woff', 'open-sans-v10-latin-800italic.woff2', 'open-sans-v10-latin-800.svg', 'open-sans-v10-latin-800.ttf', 'open-sans-v10-latin-800.woff', 'open-sans-v10-latin-800.woff2', 'open-sans-v10-latin-italic.eot', 'open-sans-v10-latin-italic.svg', 'open-sans-v10-latin-italic.ttf', 'open-sans-v10-latin-italic.woff', 'open-sans-v10-latin-italic.woff2', 'open-sans-v10-latin-regular.eot', 'open-sans-v10-latin-regular.svg', 'open-sans-v10-latin-regular.ttf', 'open-sans-v10-latin-regular.woff', 'open-sans-v10-latin-regular.woff2', 'webhostinghub-glyphs.eot', 'webhostinghub-glyphs.svg', 'webhostinghub-glyphs.ttf'], 'css': ['contrib.admin.fonts.css', 'contrib.admin.icons.css', 'contrib.admin.structures.css', 'contrib.admin.css', 'contrib.admin.ckeditor.css', 'contrib.admin.colorbox.css', 'contrib.admin.filebrowser.css', 'contrib.admin.nuntium.css', 'contrib.admin.opentip.css', 'contrib.admin.overflowtabs.css', 'contrib.admin.scrollbar.css'], 'js': ['grappelli/jquery.grp_autocomplete_fk.js', 'grappelli/jquery.grp_autocomplete_generic.js', 'grappelli/jquery.grp_autocomplete_m2m.js', 'lib/colorbox.js', 'lib/cookie.js', 'lib/echo.js', 'lib/highcharts.js', 'lib/highcharts.exporting.js', 'lib/jquery-ui-i18n.js', 'lib/localstorage-cache.js', 'lib/opentip.js', 'lib/overflowtabs.js', 'lib/scrollbar.js', 'contrib.admin.base.js', 'contrib.admin.colorbox.js', 'contrib.admin.dashboard.js', 'contrib.admin.filebrowser.js', 'contrib.admin.highcharts.js', 'contrib.admin.opentip.js']}}
status = 'stable'
verbose_name = <django.utils.functional.__proxy__ object at 0x244d990>
version = '0.8.7'

cms.contrib.admin.dashboard module

This file was generated with the customdashboard management command and contains the class for the main dashboard.

To activate your index dashboard add the following to your settings.py::
GRAPPELLI_INDEX_DASHBOARD = ‘cms.dashboard.CustomIndexDashboard’
class cms.contrib.admin.dashboard.Dashboard(**kwargs)

Bases: grappelli.dashboard.dashboards.Dashboard

Custom index dashboard for www.

init_with_context(context)
media
module_administration = <cms.contrib.admin.modules.ModelLinkList object at 0xbc96c90>
module_applications = <cms.contrib.admin.modules.AppList object at 0x92675d0>
module_issues = <cms.core.dev.modules.CoreDevRecentIssues object at 0xbc96a50>
module_media = <cms.contrib.admin.modules.ModelLinkList object at 0xc1a8d90>
module_modelsstats = <cms.contrib.modelstats.modules.ModelstatsModule object at 0xbc96110>
module_nuntium = <cms.contrib.admin.modules.NuntiumModule object at 0xbc96c50>
module_recent_actions = <cms.contrib.admin.modules.RecentActions object at 0xbc969d0>
module_sitestats_awstats = <cms.contrib.sitestats.awstats.modules.SitestatsAwstatsModule object at 0x8b10150>
module_socialmedia = <cms.contrib.socialmedia.modules.SociamediaStatsModule object at 0xbc961d0>
module_support = <cms.contrib.admin.modules.ModelLinkList object at 0xbc96290>
module_welcome = <cms.contrib.admin.modules.WelcomeModule object at 0xbc96f50>
template = 'admin/dashboard.html'

cms.contrib.admin.filters module

class cms.contrib.admin.filters.DateFieldListFilter(field, request, params, model, model_admin, field_path)

Bases: django.contrib.admin.filters.FieldListFilter

choices(cl)
expected_parameters()
class cms.contrib.admin.filters.LogEntryActionListFilter(request, params, model, model_admin)

Bases: django.contrib.admin.filters.SimpleListFilter

lookups(request, model_admin)
parameter_name = 'action_flag'
queryset(request, queryset)
title = <django.utils.functional.__proxy__ object at 0x4dc6b90>

cms.contrib.admin.helpers module

class cms.contrib.admin.helpers.ActionForm(data=None, files=None, auto_id=u'id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False)

Bases: django.forms.forms.Form

Pass required=False to field action.

base_fields = OrderedDict([('action', <django.forms.fields.ChoiceField object at 0x4dc6810>), ('select_across', <django.forms.fields.BooleanField object at 0x4dc6910>)])
declared_fields = OrderedDict([('action', <django.forms.fields.ChoiceField object at 0x4dc6810>), ('select_across', <django.forms.fields.BooleanField object at 0x4dc6910>)])
media

cms.contrib.admin.models module

class cms.contrib.admin.models.Admin(*args, **kwargs)

Bases: django.db.models.base.Model

A class that holds admin-settings.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception Admin.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

class Admin.Settings
Admin.objects = <django.db.models.manager.Manager object at 0x3cf2310>

cms.contrib.admin.modules module

class cms.contrib.admin.modules.AppList(title=None, **kwargs)

Bases: grappelli.dashboard.modules.AppList

Module that lists the apps and there settings-module. Always return a fresh sorted dict of models and links. If language in admin changed we got a a well sorted list.

css_classes = (('applications',),)
icon_class = 'applications'
init_with_context(context, ADMIN_DASHBOARD_EXCLUDE=True)
is_empty()

Return True if the module has no content and False otherwise - exclude pre_content and post_content.

template = 'grappelli/dashboard/modules/app_list.html'
title = <django.utils.functional.__proxy__ object at 0x54a2990>
class cms.contrib.admin.modules.DashboardModule(title=None, **kwargs)

Bases: grappelli.dashboard.modules.DashboardModule

collapsible = False
size = ''
size_min = False

Bases: cms.contrib.admin.modules.ModelList

Module that lists the models and links.

init_with_context(context)
sort_items = True
template = 'grappelli/dashboard/modules/model_linklist.html'
class cms.contrib.admin.modules.ModelList(title=None, models=None, exclude=None, **kwargs)

Bases: grappelli.dashboard.modules.ModelList

Module that lists a set of models. Always return a fresh sorted dict of models and links. If language in admin changed we got a a well sorted list.

icon_class = None
init_with_context(context, ADMIN_DASHBOARD_EXCLUDE=True)
is_empty()

Return True if the module has no content and False otherwise - exclude pre_content and post_content.

class cms.contrib.admin.modules.NuntiumModule(title=None, **kwargs)

Bases: cms.contrib.admin.modules.DashboardModule

css_classes = ('nuntium',)
icon_class = 'bellalt'
init_with_context(context)
is_empty()
template = 'grappelli/dashboard/modules/nuntium.html'
title = <django.utils.functional.__proxy__ object at 0x54a2a10>
title_sec = 'inMeta.Networks'
class cms.contrib.admin.modules.RecentActions(title=None, limit=10, include_list=None, exclude_list=None, **kwargs)

Bases: grappelli.dashboard.modules.RecentActions

Module that lists the recent actions for the current user.

css_classes = ('actions',)
get_model_graph(request, qs, name, include_list=None)
icon_class = 'app-admin-log'
init_with_context(context, app=None, include_list=None)
title = <django.utils.functional.__proxy__ object at 0x54a2a90>
title_sec = <django.utils.functional.__proxy__ object at 0x54a2b10>
class cms.contrib.admin.modules.TabsModule(title=None, **kwargs)

Bases: cms.contrib.admin.modules.DashboardModule

css_classes = ('grp-module-tabs',)
html_id = ''
icon_class_from_children = False
is_empty()
template = 'grappelli/dashboard/modules/tabs.html'
class cms.contrib.admin.modules.TabsReloadableModule(title=None, **kwargs)

Bases: cms.contrib.admin.modules.TabsModule

get_url(params)
reloadable = True
url = ''
class cms.contrib.admin.modules.WelcomeModule(title=None, **kwargs)

Bases: cms.contrib.admin.modules.DashboardModule

css_classes = ('grp-color-highlight', 'welcome')
icon_class = 'greenlightbulb'
init_with_context(context)
is_empty()
template = 'grappelli/dashboard/modules/welcome.html'
title = <django.utils.functional.__proxy__ object at 0x54a2c90>

cms.contrib.admin.monkeypatch module

cms.contrib.admin.monkeypatch.fb_upload(self, request)

Upload file to the server.

cms.contrib.admin.monkeypatch.get_cache_key(self, items=(), pk=None)

cms.contrib.admin.sites module

class cms.contrib.admin.sites.CMSAdminSite(name='admin', app_name='admin')

Bases: django.contrib.admin.sites.AdminSite

Custom AdminSite to dismiss SettingsModels and add support for notifiactions.

admin_view_no_check(view, cacheable=False, check_permissions=True)
app_index(request, app_label, extra_context=None)
check_permission(cls, request)
get_modelstatdashboard(request, model, refresh)
get_modelstatsdashboard(request)
get_modelstatssitestats(request, period='month', refresh=False)
get_modelstatsuser(request)
get_notifications(request)
get_urls()
password_change(request)
register_admintools(**options)

Registers the given class for views in admin.

register_modelstatdashboard(cls, **options)

Registers the given class for notifications in admin.

register_modelstatsitestats(cls, **options)

Registers the given class for notifications in admin.

register_modelstatuser(cls, **options)

Registers the given class for notifications in admin.

register_notification(cls, **options)

Registers the given class for notifications in admin.

register_sitestat(**options)

Registers the given class for views in admin.

register_view(**options)

Registers the given class for views in admin.

cms.contrib.admin.urls module

cms.contrib.admin.utils module

cms.contrib.admin.utils.get_nuntium(request)
cms.contrib.admin.utils.get_nuntium_css_mark(objects)

cms.contrib.admin.views module

class cms.contrib.admin.views.AdminAboutView(**kwargs)

Bases: cms.core.views.GenericTemplateView

get(request)
template_name = 'admin/about.html'
class cms.contrib.admin.views.AdminAjaxBaseView(**kwargs)

Bases: cms.core.views.GenericCSRFProtectedTemplateView

get(request)
post(*args, **kwargs)
class cms.contrib.admin.views.AdminLoginUserimageView(**kwargs)

Bases: cms.core.views.GenericCSRFProtectedView

post(*args, **kwargs)
class cms.contrib.admin.views.AdminNotificationsView(**kwargs)

Bases: cms.contrib.admin.views.AdminAjaxBaseView

get_context(request)
post(request)
template_name = 'admin/includes/navigation_menu_notifications.html'
class cms.contrib.admin.views.AdminNuntiumView(**kwargs)

Bases: cms.contrib.admin.views.AdminAjaxBaseView

get(request)
get_context(request)
template_name = 'admin/includes/nuntium.html'
class cms.contrib.admin.views.AdminSubBaseView(**kwargs)

Bases: cms.core.views.GenericTemplateView

check_permission(request)
description = ()
dispatch(request, *args, **kwargs)
get(request)
get_menu(request)
overview = False
required_permission
superuser = True
class cms.contrib.admin.views.AutocompleteLookup(**kwargs)

Bases: grappelli.views.related.AutocompleteLookup

get_searched_queryset(qs)

Module contents