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

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

# 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 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
    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>IVLE%s</title>
  <meta http-equiv="Content-Type"
    content="%s; charset=utf-8" />
</head>

""" % (titlepart, req.content_type))

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

    # 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>Warning: debuginfo is enabled. Remove this app from "
            "conf.apps.app_url when placed into production.</p>")

    print_apps_list(req)

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

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

def print_apps_list(file):
    """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 class="apptabs">\n')

    for urlname in conf.apps.apps_in_tabs:
        app = conf.apps.app_url[urlname]
        file.write('  <li><a href="%s">%s</a></li>\n'
            % (util.make_path(app.dir), app.name))

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

38 by mattgiuca dispatch: Request now fully handles all attributes by setting the correct	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
46 by mattgiuca dispatch/html: Now prints apps list in the HTML header (common to all apps).	26	import conf
	27	import conf.apps
	28	from common import util
	29
38 by mattgiuca dispatch: Request now fully handles all attributes by setting the correct	30	def write_html_head(req):
	31	"""Writes the HTML header, given a request object.
	32
	33	req: An IVLE request object. Reads attributes such as title. Also used to
	34	write to."""
47 by mattgiuca dispatch: HTML now writes proper XHTML headers including title element based	35
	36	# Write the XHTML opening and head element
53 by mattgiuca dispatch/html.py: Refactor string writing code to use '%' operator.	37	if req.title != None:
	38	titlepart = ' - ' + req.title
	39	else:
	40	titlepart = ''
47 by mattgiuca dispatch: HTML now writes proper XHTML headers including title element based	41	req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
	42	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
	43	<html xmlns="http://www.w3.org/1999/xhtml">
	44	<head>
53 by mattgiuca dispatch/html.py: Refactor string writing code to use '%' operator.	45	<title>IVLE%s</title>
47 by mattgiuca dispatch: HTML now writes proper XHTML headers including title element based	46	<meta http-equiv="Content-Type"
63 by mattgiuca dispatch/html.py: Fixed HTML source error.	47	content="%s; charset=utf-8" />
47 by mattgiuca dispatch: HTML now writes proper XHTML headers including title element based	48	</head>
	49
53 by mattgiuca dispatch/html.py: Refactor string writing code to use '%' operator.	50	""" % (titlepart, req.content_type))
47 by mattgiuca dispatch: HTML now writes proper XHTML headers including title element based	51
	52	# Open the body element and write a bunch of stuff there (the header)
	53	req.write("""<body>
	54	<h1>IVLE - Informatics Virtual Learning Environment</h1>
	55	""")
70 by mattgiuca apps: Added app "debuginfo" which prints out IVLE system properties.	56
	57	# If the "debuginfo" app is installed, display a warning to the admin to
	58	# make sure it is removed in production.
	59	if "debuginfo" in conf.apps.app_url:
	60	req.write("<p>Warning: debuginfo is enabled. Remove this app from "
	61	"conf.apps.app_url when placed into production.</p>")
	62
46 by mattgiuca dispatch/html: Now prints apps list in the HTML header (common to all apps).	63	print_apps_list(req)
38 by mattgiuca dispatch: Request now fully handles all attributes by setting the correct	64
	65	def write_html_foot(req):
	66	"""Writes the HTML footer, given a request object.
	67
	68	req: An IVLE request object. Written to.
	69	"""
	70	req.write("</body>\n</html>\n")
46 by mattgiuca dispatch/html: Now prints apps list in the HTML header (common to all apps).	71
	72	def print_apps_list(file):
	73	"""Prints all app tabs, as a UL. Prints a list item for each app that has
	74	a tab.
	75
	76	file: Object with a "write" method - ie. the request object.
	77	Reads from: conf
	78	"""
	79	file.write('<ul class="apptabs">\n')
	80
	81	for urlname in conf.apps.apps_in_tabs:
	82	app = conf.apps.app_url[urlname]
53 by mattgiuca dispatch/html.py: Refactor string writing code to use '%' operator.	83	file.write(' <li><a href="%s">%s</a></li>\n'
	84	% (util.make_path(app.dir), app.name))
46 by mattgiuca dispatch/html: Now prints apps list in the HTML header (common to all apps).	85
	86	file.write('</ul>\n')