&gf.dZddlmZ ddlmZddlmZddl m Z ddlmZddlmZdd lmZmZGd d eZGd d eZGddeZGddeeZGddeeZGddeZGddeZy#e $rddl mZddlm ZY}wxYw)zA Module where admin tools dashboard modules classes are defined. )apps)reverse) gettext_lazy) ugettext_lazy)flatatt) is_iterable)capfirst)AppListElementMixinuniquifycdeZdZdZdZdZdZdZdZdZ dZ dZ dZ dZ dZdZdZd dZdZdZd Zd Zy) DashboardModulea Base class for all dashboard modules. Dashboard modules have the following properties: ``enabled`` Boolean that determines whether the module should be enabled in the dashboard by default or not. Default value: ``True``. ``draggable`` Boolean that determines whether the module can be draggable or not. Draggable modules can be re-arranged by users. Default value: ``True``. ``collapsible`` Boolean that determines whether the module is collapsible, this allows users to show/hide module content. Default: ``True``. ``deletable`` Boolean that determines whether the module can be removed from the dashboard by users or not. Default: ``True``. ``title`` String that contains the module title, make sure you use the django gettext functions if your application is multilingual. Default value: ''. ``title_url`` String that contains the module title URL. If given the module title will be a link to this URL. Default value: ``None``. ``css_classes`` A list of css classes to be added to the module ``div`` class attribute. Default value: ``None``. ``pre_content`` Text or HTML content to display above the module content. Default value: ``None``. ``content`` The module text or HTML content. Default value: ``None``. ``post_content`` Text or HTML content to display under the module content. Default value: ``None``. ``template`` The template to use to render the module. Default value: 'admin_tools/dashboard/module.html'. z!admin_tools/dashboard/module.htmlTNc |||_|D])}t|j|st||||+|jxsg|_|j xsg|_d|_y)NF)titlehasattr __class__setattrchildren css_classes _initialized)selfrkwargskeys V/var/www/html/djangosite/lib/python3.12/site-packages/admin_tools/dashboard/modules.py__init__zDashboardModule.__init__Usi  DJ 0Ct~~s+c6#;/ 0 + ++1r!cy)af Like for the :class:`~admin_tools.dashboard.Dashboard` class, dashboard modules have a ``init_with_context`` method that is called with a ``django.template.RequestContext`` instance as unique argument. This gives you enough flexibility to build complex modules, for example, let's build a "history" dashboard module, that will list the last ten visited pages:: from admin_tools.dashboard import modules class HistoryDashboardModule(modules.LinkList): title = 'History' def init_with_context(self, context): request = context['request'] # we use sessions to store the visited pages stack history = request.session.get('history', []) for item in history: self.children.append(item) # add the current page to the history history.insert(0, { 'title': context['title'], 'url': request.META['PATH_INFO'] }) if len(history) > 10: history = history[:10] request.session['history'] = history Here's a screenshot of our history item: .. image:: images/history_dashboard_module.png N)rcontexts rinit_with_contextz!DashboardModule.init_with_contextbsD rcr|jduxr(|jduxrt|jdk(S)a Return True if the module has no content and False otherwise. >>> mod = DashboardModule() >>> mod.is_empty() True >>> mod.pre_content = 'foo' >>> mod.is_empty() False >>> mod.pre_content = None >>> mod.is_empty() True >>> mod.children.append('foo') >>> mod.is_empty() False >>> mod.children = [] >>> mod.is_empty() True Nr) pre_content post_contentlenrrs ris_emptyzDashboardModule.is_emptys@(4'$    %$  ! # $rc0dg}|js|jd|jr|jd|jr|jd|jr|jd||j z }dj |S)aU Return a string containing the css classes for the module. >>> mod = DashboardModule(enabled=False, draggable=True, ... collapsible=True, deletable=True) >>> mod.render_css_classes() 'dashboard-module disabled draggable collapsible deletable' >>> mod.css_classes.append('foo') >>> mod.render_css_classes() 'dashboard-module disabled draggable collapsible deletable foo' >>> mod.enabled = True >>> mod.render_css_classes() 'dashboard-module draggable collapsible deletable foo' zdashboard-moduledisabled draggable collapsible deletable )enabledappendr)r*r+rjoin)rrets rrender_css_classesz"DashboardModule.render_css_classessx""|| JJz " >> JJ{ #    JJ} % >> JJ{ # txx}rcyNrr%s r_prepare_childrenz!DashboardModule._prepare_childrens rr3)__name__ __module__ __qualname____doc__templater-r)r*r+ show_titler title_urlrr"r#ridrr r&r1r4rrrr r se/b3HGIKIJ EIKKLH B "" H$06 rr c:eZdZdZdZdZdZdZfdZdZ xZ S)Groupa Represents a group of modules, the group can be displayed in tabs, accordion, or just stacked (default). As well as the :class:`~admin_tools.dashboard.modules.DashboardModule` properties, the :class:`~admin_tools.dashboard.modules.Group` has two extra properties: ``display`` A string determining how the group should be rendered, this can be one of the following values: 'tabs' (default), 'accordion' or 'stacked'. ``force_show_title`` Default behaviour for Group module is to force children to always show the title if Group has ``display`` = ``stacked``. If this flag is set to ``False``, children title is shown according to their``show_title`` property. Note that in this case is children responsibility to have meaningful content if no title is shown. Here's an example of modules group:: from admin_tools.dashboard import modules, Dashboard class MyDashboard(Dashboard): def __init__(self, **kwargs): Dashboard.__init__(self, **kwargs) self.children.append(modules.Group( title="My group", display="tabs", children=[ modules.AppList( title='Administration', models=('django.contrib.*',) ), modules.AppList( title='Applications', exclude=('django.contrib.*',) ) ] )) The screenshot of what this code produces: .. image:: images/dashboard_module_group.png Tz(admin_tools/dashboard/modules/group.htmltabsc|jry|jD]H}d|_d|_d|_|j r|j dk(|_|j|Jd|_y)NFstackedT) rrr*r)r+force_show_titledisplayr:r )rrmodules rr zGroup.init_with_contextsm    mm .F"'F $F $F $$%)\\Y%>!  $ $W - .!rcrtt| ry|jD]}|jryy)ab A group of modules is considered empty if it has no children or if all its children are empty. >>> from admin_tools.dashboard.modules import DashboardModule, LinkList >>> mod = Group() >>> mod.is_empty() True >>> mod.children.append(DashboardModule()) >>> mod.is_empty() True >>> mod.children.append(LinkList('links', children=[ ... {'title': 'example1', 'url': 'http://example.com'}, ... {'title': 'example2', 'url': 'http://example.com'}, ... ])) >>> mod.is_empty() False TF)superr>r&r)rchildrs rr&zGroup.is_emptys:&  & (]] E>># rct}t|jD]H\}}|jd|jxs|dz}t |||_|j Jy)N_)set enumeraterr<r r4)rseenr<rD proposed_ids rr4zGroup._prepare_childrens_u#DMM2 'JB%)WWfii.?2a4.?@K d3FI  $ $ & 'r) r5r6r7r8rBr9rCr r&r4 __classcell__rs@rr>r>s*+Z9HG !4'rr>c.eZdZdZedZdZdZdZy)LinkLista A module that displays a list of links. As well as the :class:`~admin_tools.dashboard.modules.DashboardModule` properties, the :class:`~admin_tools.dashboard.modules.LinkList` takes an extra keyword argument: ``layout`` The layout of the list, possible values are ``stacked`` and ``inline``. The default value is ``stacked``. Link list modules children are simple python dictionaries that can have the following keys: ``title`` The link title. ``url`` The link URL. ``external`` Boolean that indicates whether the link is an external one or not. ``description`` A string describing the link, it will be the ``title`` attribute of the html ``a`` tag. ``attrs`` Hash comprising attributes of the html ``a`` tag. Children can also be iterables (lists or tuples) of length 2, 3, 4 or 5. Here's a small example of building a link list module:: from admin_tools.dashboard import modules, Dashboard class MyDashboard(Dashboard): def __init__(self, **kwargs): Dashboard.__init__(self, **kwargs) self.children.append(modules.LinkList( layout='inline', children=( { 'title': 'Python website', 'url': 'http://www.python.org', 'external': True, 'description': 'Python language rocks !', 'attrs': {'target': '_blank'}, }, ['Django', 'http://www.djangoproject.com', True], ['Some internal link', '/some/internal/link/'], ) )) The screenshot of what this code produces: .. image:: images/linklist_dashboard_module.png Linksz,admin_tools/dashboard/modules/link_list.htmlrAc|jryg}|jD]}t|ttfrO|d|dd}t |dk\r|d|d<t |dk\r|d|d<t |d k\r|d|d <|}d |vri|d <|d |d d <|j dd r |d|d d<|j ddrJdjdg|d j dd jzj|d d<t|d |d <|j|||_d|_y)NrrJ)rurlexternal descriptionattrsrUhrefrrFr,z external-linkclassT) rr isinstancetuplelistr$getr/splitstriprr.)rr new_childrenlink link_dicts rr zLinkList.init_with_contextasa     MM &D$/&*1gd1g> t9>,0GIj)t9>/3AwIm,t9>)-aIg& d" "W $(KDM& !xx r*)-m)<W g&xx E*),$%W (9(9'2(F(L(L(NN*%'W g&$DM2DM    %) &*%  rN) r5r6r7r8rIrr9layoutr rrrrRrR!s"9v gJE=H F!rrRcNeZdZdZedZdZdZdZdZ dZ dfd Z dZ xZ S)AppLista Module that lists installed apps and their models. As well as the :class:`~admin_tools.dashboard.modules.DashboardModule` properties, the :class:`~admin_tools.dashboard.modules.AppList` has two extra properties: ``models`` A list of models to include, only models whose name (e.g. "blog.comments.models.Comment") match one of the strings (e.g. "blog.*") in the models list will appear in the dashboard module. ``exclude`` A list of models to exclude, if a model name (e.g. "blog.comments.models.Comment") match an element of this list (e.g. "blog.comments.*") it won't appear in the dashboard module. If no models/exclude list is provided, **all apps** are shown. Here's a small example of building an app list module:: from admin_tools.dashboard import modules, Dashboard class MyDashboard(Dashboard): def __init__(self, **kwargs): Dashboard.__init__(self, **kwargs) # will only list the django.contrib apps self.children.append(modules.AppList( title='Administration', models=('django.contrib.*',) )) # will list all apps except the django.contrib ones self.children.append(modules.AppList( title='Applications', exclude=('django.contrib.*',) )) The screenshot of what this code produces: .. image:: images/applist_dashboard_module.png .. note:: Note that this module takes into account user permissions, for example, if a user has no rights to change or add a ``Group``, then the django.contrib.auth.Group model line will not be displayed. Applicationsz+admin_tools/dashboard/modules/app_list.htmlNc t|jdg|_t|jdg|_|jdg|_|jdg|_t t|"|fi|y)Nmodelsexclude include_list exclude_list) rapoprmrnrorprFrjr)rrrrs rrzAppList.__init__sk6::h34 FJJy"56 "JJ~r:"JJ~r: gt%e6v6rc|jry|j|d}i}|D]\}}|jj}||vr6t j |j |j||gd||<i}|jj|d<|ds|jddr|j|||d<|dr|j|||d <||d j|t|jD]9}||d jd |j j||;d |_y)Nrequest)rrUrmrchangeviewF change_urladdadd_urlrmc |dS)Nrr)xs rz+AppList.init_with_context..s 1W:r)rT)r_visible_models_meta app_label django_appsget_app_config verbose_name_get_admin_app_list_urlverbose_name_pluralrb_get_admin_change_url_get_admin_add_urlr.sortedkeyssortr) rritemsrmodelpermsr~ model_dictapps rr zAppList.init_with_contexts^    $$WY%78! 9LE5 --I$$229=JJ77wG #Y J"'++"A"AJw X%))FE":+/+E+E, <(U|(,(?(?w(O 9% OH % , ,Z 8% 9($))+& ,C Ih  $ $)= $ > MM c + ,!rr3)r5r6r7r8rIrr9rmrnrorprr rOrPs@rrjrj~s8.` n EeZdZdZdZdZdZdZdZdfd Z dZ xZ S) ModelLista  Module that lists a set of models. As well as the :class:`~admin_tools.dashboard.modules.DashboardModule` properties, the :class:`~admin_tools.dashboard.modules.ModelList` takes two extra arguments: ``models`` A list of models to include, only models whose name (e.g. "blog.comments.models.Comment") match one of the strings (e.g. "blog.*") in the models list will appear in the dashboard module. ``exclude`` A list of models to exclude, if a model name (e.g. "blog.comments.models.Comment") match an element of this list (e.g. "blog.comments.*") it won't appear in the dashboard module. Here's a small example of building a model list module:: from admin_tools.dashboard import modules, Dashboard class MyDashboard(Dashboard): def __init__(self, **kwargs): Dashboard.__init__(self, **kwargs) # will only list the django.contrib.auth models self.children += [ modules.ModelList( title='Authentication', models=['django.contrib.auth.*',] ) ] The screenshot of what this code produces: .. image:: images/modellist_dashboard_module.png .. note:: Note that this module takes into account user permissions, for example, if a user has no rights to change or add a ``Group``, then the django.contrib.auth.Group model line will not be displayed. z-admin_tools/dashboard/modules/model_list.htmlNc t|xsg|_t|xsg|_|jdg|_|jdg|_d|vr|jd|_ng|_tt|&|fi|y)Nrorpextra) rarmrnrqrorprrFrr)rrrmrnrrs rrzModelList.__init__s|6.get_qsetrs FD# / k;7#$knn#EL+6+<+"=.!rrcFeZdZdZedZdZdZdZdfd Z dZ xZ S)Feeda" Class that represents a feed dashboard module. .. important:: This class uses the `Universal Feed Parser module `_ to parse the feeds, so you'll need to install it, all feeds supported by FeedParser are thus supported by the Feed As well as the :class:`~admin_tools.dashboard.modules.DashboardModule` properties, the :class:`~admin_tools.dashboard.modules.Feed` takes two extra keyword arguments: ``feed_url`` The URL of the feed. ``limit`` The maximum number of feed children to display. Default value: None, which means that all children are displayed. Here's a small example of building a recent actions module:: from admin_tools.dashboard import modules, Dashboard class MyDashboard(Dashboard): def __init__(self, **kwargs): Dashboard.__init__(self, **kwargs) # will only list the django.contrib apps self.children.append(modules.Feed( title=_('Latest Django News'), feed_url='http://www.djangoproject.com/rss/weblog/', limit=5 )) The screenshot of what this code produces: .. image:: images/feed_dashboard_module.png zRSS Feedz'admin_tools/dashboard/modules/feed.htmlNc V|j||dtt||fi|y)N)feed_urlr)rrFrr)rrrrrrs rrz Feed.__init__s( 8e<= dD"53F3rc|jryddl}|j td ddl}|j|j}|j|dd|j}n|d}|D]P}|j|_ |j|jdd|_ |j j|Rd|_y#t $r!|j jdddYywxYw#YVxYw)Nrz!You must provide a valid feed URLz-You must install the FeedParser python moduleT)rwarningentriesrV)rdatetimerr feedparser ImportErrorrr.parserrfrUdatepublished_parsed)rrrrfeedrentrys rr zFeed.init_with_contexts     == @A A   . :: !9oktzz2G9oG (E EI *X]]E,B,B1Q,GH  MM  ' (!)  MM I"      sC !C7 'C43C47C;r) r5r6r7r8rIrr9rrrr rOrPs@rrrs-'R jME8HH E4!rrN)r8 django.appsrr django.urlsrdjango.utils.translationrrIrdjango.core.urlresolversrdjango.forms.utilsrdjango.utils.itercompatrdjango.utils.textr admin_tools.utilsr r objectr r>rRrjrrrrrrrs,<$:'/&;e fe Pa'Oa'HZ!Z!z\!o2\!~W!!4W!ta!Oa!HO!?O!a<0;