~azzar1/unity/add-show-desktop-key : contents of www/dispatch/html.py at revision 313

~azzar1/unity/add-show-desktop-key : (revision 313)

# IVLE - Informatics Virtual Learning Environment
# Copyright (C) 2007-2008 The University of Melbourne
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

# Module: dispatch.html
# Author: Matt Giuca
# Date: 12/12/2007

# Provides functions for writing the dispatch-generated HTML header and footer
# content (the common parts of the HTML pages shared across the entire site).
# Does not include the login page. See login.py.

import cgi
import os.path

import conf
import conf.apps
from common import util

def write_html_head(req):
    """Writes the HTML header, given a request object.

    req: An IVLE request object. Reads attributes such as title. Also used to
    write to."""

    # Write the XHTML opening and head element
    # Note the inline JavaScript, which provides the client with constants
    # derived from the server configuration.
    if req.title != None:
        titlepart = req.title + ' - '
    else:
        titlepart = ''
    req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <title>%sIVLE</title>
  <meta http-equiv="Content-Type" content="%s; charset=utf-8" />
""" % (cgi.escape(titlepart), cgi.escape(req.content_type)))
    # Write inline JavaScript which gives the client code access to certain
    # server-side variables.
    if req.username:
        username = repr(req.username)
    else:
        username = "null"
    req.write("""  <script type="text/javascript">
    root_dir = %s;
    username = %s;
  </script>
""" % (repr(conf.root_dir), username))
    iconurl = get_icon_url(req.app)
    if iconurl:
        req.write("""  <link rel="shortcut icon" href="%s" />
""" % cgi.escape(iconurl))
    req.write("""  <link rel="stylesheet" type="text/css" href="%s" />
""" % cgi.escape(util.make_path('media/common/ivle.css')))

    # Write any app-specific style and script links
    for style in req.styles:
        req.write('  <link rel="stylesheet" type="text/css" href="%s" />\n'
            % cgi.escape(util.make_path(style)))
    for script in req.scripts:
        req.write('  <script type="text/javascript" src="%s" />\n'
            % cgi.escape(util.make_path(script)))

    req.write("</head>\n\n")

    # Open the body element and write a bunch of stuff there (the header)
    req.write("""<body>
<div id="ivleheader">
  <h1>IVLE</h1>
  <h2>Informatics Virtual Learning Environment</h2>
""")

    if req.username:
        req.write('  <p class="userhello">Welcome, <span '
            'class="username">%s</span> |\n'
            '    <a href="%s">Help</a> |\n'
            '    <a href="%s">Logout</a>\n'
            '  </p>\n' %
            (cgi.escape(req.username),
             cgi.escape(get_help_url(req)),
             cgi.escape(util.make_path('logout'))))
    else:
        req.write('  <p class="userhello">Not logged in.</p>')

    # If the "debuginfo" app is installed, display a warning to the admin to
    # make sure it is removed in production.
    if "debuginfo" in conf.apps.app_url:
        req.write("  <p><small>Warning: debuginfo is enabled. Remove this "
            "app from conf.apps.app_url when placed into production."
            "</small></p>\n")

    if req.username:
        # Only print app tabs if logged in
        print_apps_list(req, req.app)
    req.write('</div>\n<div id="ivlebody">\n')

def write_html_foot(req):
    """Writes the HTML footer, given a request object.

    req: An IVLE request object. Written to.
    """
    req.write("</div>\n</body>\n</html>\n")

def get_help_url(req):
    """Gets the help URL most relevant to this page, to place as the
    "help" link at the top of the page."""
    if req.app == 'help':
        # We're already in help. Link to the exact current page
        # instead of the generic help page.
        return req.uri
    if conf.apps.app_url[req.app].hashelp:
        help_path = os.path.join('help', req.app)
    else:
        help_path = 'help'
    return util.make_path(help_path)

def get_icon_url(appurl, small=False):
    """Given an app's url name, gets the URL of the icon image for this app,
    relative to the site root. Returns None if the app has no icon."""
    if appurl is None: return None
    app = conf.apps.app_url[appurl]
    if small:
        icon_dir = conf.apps.app_icon_dir_small
    else:
        icon_dir = conf.apps.app_icon_dir
    if app.icon is None: return None
    return util.make_path(os.path.join(icon_dir, app.icon))

def print_apps_list(file, thisapp):
    """Prints all app tabs, as a UL. Prints a list item for each app that has
    a tab.

    file: Object with a "write" method - ie. the request object.
    Reads from: conf
    """
    file.write('  <ul id="apptabs">\n')

    for urlname in conf.apps.apps_in_tabs:
        app = conf.apps.app_url[urlname]
        if urlname == thisapp:
            li_attr = ' class="thisapp"'
        else:
            li_attr = ''
        file.write('    <li%s>' % li_attr)
        if app.icon:
            file.write('<img src="%s" alt="" /> '
                % cgi.escape(get_icon_url(urlname)))
        file.write('<a href="%s">%s</a></li>\n'
            % (cgi.escape(util.make_path(urlname)), cgi.escape(app.name)))

    file.write('  </ul>\n')

93 by mattgiuca New directory hierarchy.	1	# IVLE - Informatics Virtual Learning Environment
	2	# Copyright (C) 2007-2008 The University of Melbourne
	3	#
	4	# This program is free software; you can redistribute it and/or modify
	5	# it under the terms of the GNU General Public License as published by
	6	# the Free Software Foundation; either version 2 of the License, or
	7	# (at your option) any later version.
	8	#
	9	# This program is distributed in the hope that it will be useful,
	10	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	# GNU General Public License for more details.
	13	#
	14	# You should have received a copy of the GNU General Public License
	15	# along with this program; if not, write to the Free Software
	16	# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	17
	18	# Module: dispatch.html
	19	# Author: Matt Giuca
	20	# Date: 12/12/2007
	21
	22	# Provides functions for writing the dispatch-generated HTML header and footer
	23	# content (the common parts of the HTML pages shared across the entire site).
	24	# Does not include the login page. See login.py.
	25
303 by mattgiuca dispatch/html: Do a CGI escape on all text being rendered into the HTML.	26	import cgi
192 by mattgiuca dispatch.html: Only prints tabs if logged in.	27	import os.path
	28
93 by mattgiuca New directory hierarchy.	29	import conf
	30	import conf.apps
	31	from common import util
	32
	33	def write_html_head(req):
	34	"""Writes the HTML header, given a request object.
	35
	36	req: An IVLE request object. Reads attributes such as title. Also used to
	37	write to."""
	38
	39	# Write the XHTML opening and head element
175 by mattgiuca dispatch.html: HTML headers for all pages now include a JavaScript	40	# Note the inline JavaScript, which provides the client with constants
	41	# derived from the server configuration.
93 by mattgiuca New directory hierarchy.	42	if req.title != None:
199 by mattgiuca Added small versions of all the app icons to images. These are used for	43	titlepart = req.title + ' - '
93 by mattgiuca New directory hierarchy.	44	else:
	45	titlepart = ''
	46	req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
	47	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
	48	<html xmlns="http://www.w3.org/1999/xhtml">
	49	<head>
199 by mattgiuca Added small versions of all the app icons to images. These are used for	50	<title>%sIVLE</title>
169 by mattgiuca Added global common css file (media/common/ivle.css).	51	<meta http-equiv="Content-Type" content="%s; charset=utf-8" />
303 by mattgiuca dispatch/html: Do a CGI escape on all text being rendered into the HTML.	52	""" % (cgi.escape(titlepart), cgi.escape(req.content_type)))
200 by mattgiuca fileservice.listing: Now returns a nicer date format for mtime_nice.	53	# Write inline JavaScript which gives the client code access to certain
	54	# server-side variables.
	55	if req.username:
	56	username = repr(req.username)
	57	else:
	58	username = "null"
	59	req.write(""" <script type="text/javascript">
	60	root_dir = %s;
	61	username = %s;
175 by mattgiuca dispatch.html: HTML headers for all pages now include a JavaScript	62	</script>
200 by mattgiuca fileservice.listing: Now returns a nicer date format for mtime_nice.	63	""" % (repr(conf.root_dir), username))
	64	iconurl = get_icon_url(req.app)
199 by mattgiuca Added small versions of all the app icons to images. These are used for	65	if iconurl:
	66	req.write(""" <link rel="shortcut icon" href="%s" />
303 by mattgiuca dispatch/html: Do a CGI escape on all text being rendered into the HTML.	67	""" % cgi.escape(iconurl))
199 by mattgiuca Added small versions of all the app icons to images. These are used for	68	req.write(""" <link rel="stylesheet" type="text/css" href="%s" />
303 by mattgiuca dispatch/html: Do a CGI escape on all text being rendered into the HTML.	69	""" % cgi.escape(util.make_path('media/common/ivle.css')))
169 by mattgiuca Added global common css file (media/common/ivle.css).	70
	71	# Write any app-specific style and script links
	72	for style in req.styles:
	73	req.write(' <link rel="stylesheet" type="text/css" href="%s" />\n'
303 by mattgiuca dispatch/html: Do a CGI escape on all text being rendered into the HTML.	74	% cgi.escape(util.make_path(style)))
169 by mattgiuca Added global common css file (media/common/ivle.css).	75	for script in req.scripts:
	76	req.write(' <script type="text/javascript" src="%s" />\n'
303 by mattgiuca dispatch/html: Do a CGI escape on all text being rendered into the HTML.	77	% cgi.escape(util.make_path(script)))
169 by mattgiuca Added global common css file (media/common/ivle.css).	78
	79	req.write("</head>\n\n")
93 by mattgiuca New directory hierarchy.	80
	81	# Open the body element and write a bunch of stuff there (the header)
	82	req.write("""<body>
191 by mattgiuca dispatch.html, ivle.css, browser.css: Major restyling of the IVLE website.	83	<div id="ivleheader">
197 by mattgiuca dispatch.html, ivle.css: Main IVLE header is now an h1/h2 pair, styled to the	84	<h1>IVLE</h1>
	85	<h2>Informatics Virtual Learning Environment</h2>
93 by mattgiuca New directory hierarchy.	86	""")
93 by mattgiuca New directory hierarchy.	87
124 by mattgiuca dispatch/request: Added new fields: method and username.	88	if req.username:
191 by mattgiuca dispatch.html, ivle.css, browser.css: Major restyling of the IVLE website.	89	req.write(' <p class="userhello">Welcome, <span '
192 by mattgiuca dispatch.html: Only prints tabs if logged in.	90	'class="username">%s</span> \|\n'
	91	' <a href="%s">Help</a> \|\n'
	92	' <a href="%s">Logout</a>\n'
	93	' </p>\n' %
303 by mattgiuca dispatch/html: Do a CGI escape on all text being rendered into the HTML.	94	(cgi.escape(req.username),
	95	cgi.escape(get_help_url(req)),
	96	cgi.escape(util.make_path('logout'))))
124 by mattgiuca dispatch/request: Added new fields: method and username.	97	else:
191 by mattgiuca dispatch.html, ivle.css, browser.css: Major restyling of the IVLE website.	98	req.write(' <p class="userhello">Not logged in.</p>')
124 by mattgiuca dispatch/request: Added new fields: method and username.	99
93 by mattgiuca New directory hierarchy.	100	# If the "debuginfo" app is installed, display a warning to the admin to
	101	# make sure it is removed in production.
	102	if "debuginfo" in conf.apps.app_url:
191 by mattgiuca dispatch.html, ivle.css, browser.css: Major restyling of the IVLE website.	103	req.write(" <p><small>Warning: debuginfo is enabled. Remove this "
	104	"app from conf.apps.app_url when placed into production."
186 by mattgiuca Added a bit of "chrome" (some CSS styling and minor touching up of the HTML).	105	"</small></p>\n")
93 by mattgiuca New directory hierarchy.	106
192 by mattgiuca dispatch.html: Only prints tabs if logged in.	107	if req.username:
	108	# Only print app tabs if logged in
	109	print_apps_list(req, req.app)
191 by mattgiuca dispatch.html, ivle.css, browser.css: Major restyling of the IVLE website.	110	req.write('</div>\n<div id="ivlebody">\n')
	111
93 by mattgiuca New directory hierarchy.	112	def write_html_foot(req):
	113	"""Writes the HTML footer, given a request object.
	114
	115	req: An IVLE request object. Written to.
	116	"""
191 by mattgiuca dispatch.html, ivle.css, browser.css: Major restyling of the IVLE website.	117	req.write("</div>\n</body>\n</html>\n")
93 by mattgiuca New directory hierarchy.	118
192 by mattgiuca dispatch.html: Only prints tabs if logged in.	119	def get_help_url(req):
	120	"""Gets the help URL most relevant to this page, to place as the
	121	"help" link at the top of the page."""
	122	if req.app == 'help':
	123	# We're already in help. Link to the exact current page
	124	# instead of the generic help page.
	125	return req.uri
	126	if conf.apps.app_url[req.app].hashelp:
	127	help_path = os.path.join('help', req.app)
	128	else:
	129	help_path = 'help'
	130	return util.make_path(help_path)
	131
200 by mattgiuca fileservice.listing: Now returns a nicer date format for mtime_nice.	132	def get_icon_url(appurl, small=False):
	133	"""Given an app's url name, gets the URL of the icon image for this app,
199 by mattgiuca Added small versions of all the app icons to images. These are used for	134	relative to the site root. Returns None if the app has no icon."""
200 by mattgiuca fileservice.listing: Now returns a nicer date format for mtime_nice.	135	if appurl is None: return None
	136	app = conf.apps.app_url[appurl]
199 by mattgiuca Added small versions of all the app icons to images. These are used for	137	if small:
	138	icon_dir = conf.apps.app_icon_dir_small
	139	else:
	140	icon_dir = conf.apps.app_icon_dir
	141	if app.icon is None: return None
	142	return util.make_path(os.path.join(icon_dir, app.icon))
	143
191 by mattgiuca dispatch.html, ivle.css, browser.css: Major restyling of the IVLE website.	144	def print_apps_list(file, thisapp):
93 by mattgiuca New directory hierarchy.	145	"""Prints all app tabs, as a UL. Prints a list item for each app that has
	146	a tab.
	147
	148	file: Object with a "write" method - ie. the request object.
	149	Reads from: conf
	150	"""
208 by mattgiuca dispatch.html, ivle.css: "apptabs" is now an ID, not a class.	151	file.write(' <ul id="apptabs">\n')
93 by mattgiuca New directory hierarchy.	152
	153	for urlname in conf.apps.apps_in_tabs:
	154	app = conf.apps.app_url[urlname]
191 by mattgiuca dispatch.html, ivle.css, browser.css: Major restyling of the IVLE website.	155	if urlname == thisapp:
	156	li_attr = ' class="thisapp"'
	157	else:
	158	li_attr = ''
196 by mattgiuca Added application icons, displayed in the tabs at the top of the IVLE page.	159	file.write(' <li%s>' % li_attr)
	160	if app.icon:
303 by mattgiuca dispatch/html: Do a CGI escape on all text being rendered into the HTML.	161	file.write('<img src="%s" alt="" /> '
	162	% cgi.escape(get_icon_url(urlname)))
196 by mattgiuca Added application icons, displayed in the tabs at the top of the IVLE page.	163	file.write('<a href="%s">%s</a></li>\n'
303 by mattgiuca dispatch/html: Do a CGI escape on all text being rendered into the HTML.	164	% (cgi.escape(util.make_path(urlname)), cgi.escape(app.name)))
93 by mattgiuca New directory hierarchy.	165
191 by mattgiuca dispatch.html, ivle.css, browser.css: Major restyling of the IVLE website.	166	file.write(' </ul>\n')