From 994199f09619cf7a24435389a0d927c874258363 Mon Sep 17 00:00:00 2001 From: Sunil Mohan Adapa Date: Tue, 13 May 2014 01:00:38 +0530 Subject: [PATCH] Cleanup menu generation using templates --- LICENSES | 1 - menu.py | 39 ++++------------------- templates/base.html | 11 +++---- templates/login_nav.html | 15 +++++++-- templates/menu.html | 36 +++++++++++++++++++++ themes/default/js/menu.js | 67 --------------------------------------- util.py | 16 ++-------- 7 files changed, 61 insertions(+), 124 deletions(-) create mode 100644 templates/menu.html delete mode 100644 themes/default/js/menu.js diff --git a/LICENSES b/LICENSES index e4a1d8a0e..f967fb292 100644 --- a/LICENSES +++ b/LICENSES @@ -108,7 +108,6 @@ specified and linked otherwise. - themes/default/img/glyphicons-halflings.png :: - - themes/default/img/glyphicons-halflings-white.png :: - - themes/default/js/functions.js :: - -- themes/default/js/menu.js :: - - themes/default/js/plinth.js :: - - themes/default/js/plugins.js :: [[file:themes/default/js/plugins.js::/%20paulirish.com/2009/log-a-lightweight-wrapper-for-consolelog/][CC0]] - themes/default/js/libs/jquery.min.js :: Symlink to external target: [[file:themes/default/js/libs/jquery.min.js::*%20Dual%20licensed%20under%20the%20MIT%20or%20GPL%20Version%202%20licenses.][MIT/GPL2]] diff --git a/menu.py b/menu.py index 93860dcdb..84b26c19d 100644 --- a/menu.py +++ b/menu.py @@ -1,19 +1,16 @@ from urlparse import urlparse -try: - import simplejson as json -except ImportError: - import json import cherrypy import cfg + class Menu(): """One menu item.""" def __init__(self, label="", icon="", url="#", order=50): """label is the text that is displayed on the menu. - icon is the icon to be displayed next to the label. - Choose from the Glyphicon set: - http://twitter.github.com/bootstrap/base-css.html#icons + icon is the icon to be displayed next to the label. + Choose from the Glyphicon set: + http://twitter.github.com/bootstrap/base-css.html#icons url is the url location that will be activated when the menu item is selected. @@ -35,11 +32,13 @@ class Menu(): def sort_items(self): """Sort the items in self.items by order.""" self.items = sorted(self.items, key=lambda x: x.order, reverse=False) + def add_item(self, label, icon, url, order=50, basehref=True): """This method creates a menu item with the parameters, adds that menu item to this menu, and returns the item. - If BASEHREF is true and url start with a slash, prepend the cfg.server_dir to it""" + If BASEHREF is true and url start with a slash, prepend the + cfg.server_dir to it""" if basehref and url.startswith("/"): url = cfg.server_dir + url @@ -62,27 +61,3 @@ class Menu(): for item in self.items: if path.startswith(item.url): return item - - def serializable(self, render_subs=False): - """Return the items in self.items as a serializable object we can pass to json. - Note: this doesn't serialize all the data in this object.""" - - so = [] - for item in self.items: - i = { 'label':item.label, 'icon':item.icon, 'url':item.url} - if item.active_p(): - i['active']=True - if item.items and render_subs: - i['subs'] = item.serializable() - so.append(i) - return so - def encode(self, name="", render_subs=False): - """return a string containing a javascript data structure - assigned to the menu name - - if render_subs is True, we render submenus too""" - - return ('') diff --git a/templates/base.html b/templates/base.html index 55552c0da..9f381dd8b 100644 --- a/templates/base.html +++ b/templates/base.html @@ -47,10 +47,7 @@ {{ css|safe }} - - {{ main_menu_js|safe }} - {{ sub_menu_js|safe }} @@ -72,13 +69,13 @@
- {% if nav or sidebar_right or sidebar_left %} + {% if submenu or sidebar_right or sidebar_left %}
- {% if nav %} + {% if submenu %}
- {{ nav|safe }} + {% include "menu.html" with menu=submenu %}
- {% endif %} + {% endif %} {% if sidebar_left %}
{{ sidebar_left|safe }} diff --git a/templates/login_nav.html b/templates/login_nav.html index 39459e2c7..dbb32f66a 100644 --- a/templates/login_nav.html +++ b/templates/login_nav.html @@ -2,9 +2,18 @@ {% block add_nav_and_login %}
- + + + {% if username %}

Logged in as {{ username }}. Log out.

{% else %} diff --git a/templates/menu.html b/templates/menu.html new file mode 100644 index 000000000..83374c40d --- /dev/null +++ b/templates/menu.html @@ -0,0 +1,36 @@ +{% comment %} +# +# This file is part of Plinth. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# +{% endcomment %} + +
    +
  • Menu
    • + {% for item in menu.items %} + +
  • + + + {{ item.label }} + + {% if item.items %} + {% include "menu.html" with menu=item %} + {% endif %} +
    • + + {% endfor %} +
diff --git a/themes/default/js/menu.js b/themes/default/js/menu.js deleted file mode 100644 index 8617d42ed..000000000 --- a/themes/default/js/menu.js +++ /dev/null @@ -1,67 +0,0 @@ -function main_menu(items) { - output = '
    ' - for (item in items) { - i = items[item]; - - // Handle active page - if (i["active"]) { - active = ' class="active"'; - } else { - active = ''; - } - - // Line break labels - /*label = i["label"]; - if (label.search(" ") != -1) { - label = label.replace(" ", "
    "); - } else { - label = " 
    " + label; - }*/ - - // Add icon before labels - icon = ''; - label = icon + i["label"]; - - output = output +'' + label + ""; - } - output = output + "
"; - document.write(output); -} - -function render_items(items) { - output = '
  • Menu
    • '; - for (item in items) { - i = items[item]; - - // Handle active page - if (i["active"]) { - active = ' class="active"'; - - // Add icon before labels - icon = ''; - label = icon + i["label"]; - } else { - active = ''; - - // Add icon before labels - icon = ''; - label = icon + i["label"]; - } - - output = output +'' + label + ""; - - if (i['subs']) { - output += render_items(i['subs']); - } - } - output = output + "
"; - return output -} - -function side_menu(items) { - if (items.length == 0) { - return 0; - } - output = render_items(items); - document.write(output); -} diff --git a/util.py b/util.py index 4ca819a8d..39e044e77 100644 --- a/util.py +++ b/util.py @@ -71,25 +71,13 @@ def render_template(template='login_nav', **kwargs): if kwargs['basehref'] == '': kwargs['basehref'] = cfg.server_dir - try: - submenu = cfg.main_menu.active_item().encode("sub_menu", render_subs=True) - except AttributeError: - submenu = "" - kwargs['template'] = template - kwargs['main_menu_js'] = cfg.main_menu.encode("main_menu") - kwargs['sub_menu_js'] = submenu + kwargs['main_menu'] = cfg.main_menu + kwargs['submenu'] = cfg.main_menu.active_item() kwargs['current_url'] = cherrypy.url() kwargs['username'] = cherrypy.session.get(cfg.session_key) kwargs['cfg'] = cfg - if not kwargs['nav'] and submenu: - kwargs['nav'] = """ """ - return render_to_string(template + '.html', kwargs)