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

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

# 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 urllib
import os.path

import conf
import conf.apps
from common import util
import plugins.console

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.user:
        username = repr(req.user.login)
    else:
        username = "null"
    req.write("""  <script type="text/javascript">
    root_dir = %s;
    public_host = %s;
    username = %s;
  </script>
""" % (repr(conf.root_dir), repr(conf.public_host), username))
    iconurl = get_icon_url(req.app, small=True)
    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"></script>\n'
            % cgi.escape(util.make_path(script)))
    req.write('  <script type="text/javascript">\n    /* Init Functions */\n')
    for init in req.scripts_init:
        req.write('    window.addEventListener("load", %s, false);\n'%init)
    req.write('  </script>\n')

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

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

    if req.publicmode:
        req.write('   <p class="userhello">Running in public mode.</p>')
    elif req.user:
        # Get the user's nickname from the request session
        nickname = req.user.nick
        req.write('  <p class="userhello"><span id="usernick">%s</span> '
            '(<span class="username">%s</span>) |\n'
            '    <a href="%s">Settings</a> |\n'
            '    <a href="%s">Help</a> |\n'
            '    <a href="%s">Sign out</a>\n'
            '  </p>\n' %
            (cgi.escape(nickname), cgi.escape(req.user.login),
             cgi.escape(util.make_path('settings')),
             cgi.escape(get_help_url(req)),
             cgi.escape(util.make_path('logout'))))
    else:
        req.write('  <p class="userhello">Not logged in.</p>')

    # ivleheader_tabs is a separate div, so it can be positioned absolutely
    req.write('</div>\n<div id="ivleheader_tabs">\n')

    # 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. Set "
            "enable_debuginfo = False in lib/conf/apps.py, when placing IVLE "
            "into production.</small></p>\n")

    # If req has a "no_agreement" attribute, then it is because the user has
    # not signed the agreement; therefore we are displaying the TOS page.
    # Do not show apps (see dispatch.login).
    if req.user and not req.user.state == 'no_agreement':
        # 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."""
    reqapp = req.app if hasattr(req, 'app') else None
    if reqapp == 'help':
        # We're already in help. Link to the exact current page
        # instead of the generic help page.
        return req.uri
    if reqapp is not None and reqapp in conf.apps.app_url and \
        conf.apps.app_url[reqapp].hashelp:
        help_path = os.path.join('help', reqapp)
    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
    try:
        app = conf.apps.app_url[appurl]
    except KeyError:
        # Due to navigating to a bad app
        return None
    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="" /> '
                % urllib.quote(get_icon_url(urlname)))
        file.write('<a href="%s" title="%s">%s</a></li>\n'
            % (urllib.quote(util.make_path(urlname)), cgi.escape(app.desc),
                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
658 by mattgiuca dispatch/html: Added tooltips based on app descriptions ( to app tabs ).	27	import urllib
192 by mattgiuca dispatch.html: Only prints tabs if logged in.	28	import os.path
	29
93 by mattgiuca New directory hierarchy.	30	import conf
	31	import conf.apps
	32	from common import util
850 by dcoles Console: Moved console up into dispatch. Now any application can, in theory,	33	import plugins.console
93 by mattgiuca New directory hierarchy.	34
	35	def write_html_head(req):
	36	"""Writes the HTML header, given a request object.
	37
	38	req: An IVLE request object. Reads attributes such as title. Also used to
	39	write to."""
	40
	41	# Write the XHTML opening and head element
175 by mattgiuca dispatch.html: HTML headers for all pages now include a JavaScript	42	# Note the inline JavaScript, which provides the client with constants
	43	# derived from the server configuration.
93 by mattgiuca New directory hierarchy.	44	if req.title != None:
199 by mattgiuca Added small versions of all the app icons to images. These are used for	45	titlepart = req.title + ' - '
93 by mattgiuca New directory hierarchy.	46	else:
	47	titlepart = ''
	48	req.write("""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
	49	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
	50	<html xmlns="http://www.w3.org/1999/xhtml">
	51	<head>
199 by mattgiuca Added small versions of all the app icons to images. These are used for	52	<title>%sIVLE</title>
169 by mattgiuca Added global common css file (media/common/ivle.css).	53	<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.	54	""" % (cgi.escape(titlepart), cgi.escape(req.content_type)))
200 by mattgiuca fileservice.listing: Now returns a nicer date format for mtime_nice.	55	# Write inline JavaScript which gives the client code access to certain
	56	# server-side variables.
504 by mattgiuca Warning: Broken build, but rather unavoidable or this commit will spiral out	57	if req.user:
	58	username = repr(req.user.login)
200 by mattgiuca fileservice.listing: Now returns a nicer date format for mtime_nice.	59	else:
	60	username = "null"
	61	req.write(""" <script type="text/javascript">
	62	root_dir = %s;
728 by dcoles Browser: Added support for the 'Share this file' button. At the moment it opens	63	public_host = %s;
200 by mattgiuca fileservice.listing: Now returns a nicer date format for mtime_nice.	64	username = %s;
175 by mattgiuca dispatch.html: HTML headers for all pages now include a JavaScript	65	</script>
728 by dcoles Browser: Added support for the 'Share this file' button. At the moment it opens	66	""" % (repr(conf.root_dir), repr(conf.public_host), username))
553 by mattgiuca Added new app: Settings (UI for userservice).	67	iconurl = get_icon_url(req.app, small=True)
199 by mattgiuca Added small versions of all the app icons to images. These are used for	68	if iconurl:
	69	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.	70	""" % cgi.escape(iconurl))
199 by mattgiuca Added small versions of all the app icons to images. These are used for	71	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.	72	""" % cgi.escape(util.make_path('media/common/ivle.css')))
169 by mattgiuca Added global common css file (media/common/ivle.css).	73
	74	# Write any app-specific style and script links
	75	for style in req.styles:
	76	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.	77	% cgi.escape(util.make_path(style)))
169 by mattgiuca Added global common css file (media/common/ivle.css).	78	for script in req.scripts:
424 by mattgiuca dispatch.html: Added explicit closing script tag. This presents	79	req.write(' <script type="text/javascript" src="%s"></script>\n'
303 by mattgiuca dispatch/html: Do a CGI escape on all text being rendered into the HTML.	80	% cgi.escape(util.make_path(script)))
848 by dcoles Dispatch: Added scripts_init feature which uses window.addEventListener(...) to	81	req.write(' <script type="text/javascript">\n /* Init Functions */\n')
	82	for init in req.scripts_init:
	83	req.write(' window.addEventListener("load", %s, false);\n'%init)
	84	req.write(' </script>\n')
169 by mattgiuca Added global common css file (media/common/ivle.css).	85
	86	req.write("</head>\n\n")
93 by mattgiuca New directory hierarchy.	87
	88	# Open the body element and write a bunch of stuff there (the header)
	89	req.write("""<body>
361 by mattgiuca dispatch/html , ivle.css: Split header into 3 divs, and used CSS to explicitly	90	<div id="ivleheader"></div>
	91	<div id="ivleheader_text">
197 by mattgiuca dispatch.html, ivle.css: Main IVLE header is now an h1/h2 pair, styled to the	92	<h1>IVLE</h1>
	93	<h2>Informatics Virtual Learning Environment</h2>
93 by mattgiuca New directory hierarchy.	94	""")
93 by mattgiuca New directory hierarchy.	95
933 by wagrant dispatch: If running in public mode, say so instead of advising that	96	if req.publicmode:
	97	req.write(' <p class="userhello">Running in public mode.</p>')
	98	elif req.user:
377 by mattgiuca dispatch/html: Changed the "welcome line" at the top of the page.	99	# Get the user's nickname from the request session
504 by mattgiuca Warning: Broken build, but rather unavoidable or this commit will spiral out	100	nickname = req.user.nick
605 by mattgiuca settings.js: Updates the user's nickname in the top bar immediately, to avoid	101	req.write(' <p class="userhello"><span id="usernick">%s</span> '
	102	'(<span class="username">%s</span>) \|\n'
553 by mattgiuca Added new app: Settings (UI for userservice).	103	' <a href="%s">Settings</a> \|\n'
192 by mattgiuca dispatch.html: Only prints tabs if logged in.	104	' <a href="%s">Help</a> \|\n'
553 by mattgiuca Added new app: Settings (UI for userservice).	105	' <a href="%s">Sign out</a>\n'
192 by mattgiuca dispatch.html: Only prints tabs if logged in.	106	' </p>\n' %
505 by mattgiuca dispatch.html, consoleservice, userservice, interpret:	107	(cgi.escape(nickname), cgi.escape(req.user.login),
553 by mattgiuca Added new app: Settings (UI for userservice).	108	cgi.escape(util.make_path('settings')),
303 by mattgiuca dispatch/html: Do a CGI escape on all text being rendered into the HTML.	109	cgi.escape(get_help_url(req)),
	110	cgi.escape(util.make_path('logout'))))
124 by mattgiuca dispatch/request: Added new fields: method and username.	111	else:
191 by mattgiuca dispatch.html, ivle.css, browser.css: Major restyling of the IVLE website.	112	req.write(' <p class="userhello">Not logged in.</p>')
124 by mattgiuca dispatch/request: Added new fields: method and username.	113
394 by mattgiuca Fixed display of the "DebugInfo" warning. Due to the new layout, this was	114	# ivleheader_tabs is a separate div, so it can be positioned absolutely
	115	req.write('</div>\n<div id="ivleheader_tabs">\n')
	116
93 by mattgiuca New directory hierarchy.	117	# If the "debuginfo" app is installed, display a warning to the admin to
	118	# make sure it is removed in production.
	119	if "debuginfo" in conf.apps.app_url:
581 by mattgiuca html.py: Updated warning about disabling debuginfo - the new way to disable it	120	req.write(" <p><small>Warning: debuginfo is enabled. Set "
	121	"enable_debuginfo = False in lib/conf/apps.py, when placing IVLE "
	122	"into production.</small></p>\n")
93 by mattgiuca New directory hierarchy.	123
455 by mattgiuca Login now handles the 3 login states: no_agreement, enabled and disabled.	124	# If req has a "no_agreement" attribute, then it is because the user has
	125	# not signed the agreement; therefore we are displaying the TOS page.
	126	# Do not show apps (see dispatch.login).
504 by mattgiuca Warning: Broken build, but rather unavoidable or this commit will spiral out	127	if req.user and not req.user.state == 'no_agreement':
192 by mattgiuca dispatch.html: Only prints tabs if logged in.	128	# Only print app tabs if logged in
	129	print_apps_list(req, req.app)
191 by mattgiuca dispatch.html, ivle.css, browser.css: Major restyling of the IVLE website.	130	req.write('</div>\n<div id="ivlebody">\n')
	131
93 by mattgiuca New directory hierarchy.	132	def write_html_foot(req):
	133	"""Writes the HTML footer, given a request object.
	134
	135	req: An IVLE request object. Written to.
	136	"""
191 by mattgiuca dispatch.html, ivle.css, browser.css: Major restyling of the IVLE website.	137	req.write("</div>\n</body>\n</html>\n")
93 by mattgiuca New directory hierarchy.	138
192 by mattgiuca dispatch.html: Only prints tabs if logged in.	139	def get_help_url(req):
	140	"""Gets the help URL most relevant to this page, to place as the
	141	"help" link at the top of the page."""
455 by mattgiuca Login now handles the 3 login states: no_agreement, enabled and disabled.	142	reqapp = req.app if hasattr(req, 'app') else None
	143	if reqapp == 'help':
192 by mattgiuca dispatch.html: Only prints tabs if logged in.	144	# We're already in help. Link to the exact current page
	145	# instead of the generic help page.
	146	return req.uri
896 by dcoles Dispatch: Try and get userid from session as early as possible. This is to	147	if reqapp is not None and reqapp in conf.apps.app_url and \
	148	conf.apps.app_url[reqapp].hashelp:
455 by mattgiuca Login now handles the 3 login states: no_agreement, enabled and disabled.	149	help_path = os.path.join('help', reqapp)
192 by mattgiuca dispatch.html: Only prints tabs if logged in.	150	else:
	151	help_path = 'help'
	152	return util.make_path(help_path)
	153
200 by mattgiuca fileservice.listing: Now returns a nicer date format for mtime_nice.	154	def get_icon_url(appurl, small=False):
	155	"""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	156	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.	157	if appurl is None: return None
553 by mattgiuca Added new app: Settings (UI for userservice).	158	try:
	159	app = conf.apps.app_url[appurl]
	160	except KeyError:
	161	# Due to navigating to a bad app
	162	return None
199 by mattgiuca Added small versions of all the app icons to images. These are used for	163	if small:
	164	icon_dir = conf.apps.app_icon_dir_small
	165	else:
	166	icon_dir = conf.apps.app_icon_dir
	167	if app.icon is None: return None
	168	return util.make_path(os.path.join(icon_dir, app.icon))
	169
191 by mattgiuca dispatch.html, ivle.css, browser.css: Major restyling of the IVLE website.	170	def print_apps_list(file, thisapp):
93 by mattgiuca New directory hierarchy.	171	"""Prints all app tabs, as a UL. Prints a list item for each app that has
	172	a tab.
	173
	174	file: Object with a "write" method - ie. the request object.
	175	Reads from: conf
	176	"""
208 by mattgiuca dispatch.html, ivle.css: "apptabs" is now an ID, not a class.	177	file.write(' <ul id="apptabs">\n')
93 by mattgiuca New directory hierarchy.	178
	179	for urlname in conf.apps.apps_in_tabs:
	180	app = conf.apps.app_url[urlname]
191 by mattgiuca dispatch.html, ivle.css, browser.css: Major restyling of the IVLE website.	181	if urlname == thisapp:
	182	li_attr = ' class="thisapp"'
	183	else:
	184	li_attr = ''
196 by mattgiuca Added application icons, displayed in the tabs at the top of the IVLE page.	185	file.write(' <li%s>' % li_attr)
	186	if app.icon:
303 by mattgiuca dispatch/html: Do a CGI escape on all text being rendered into the HTML.	187	file.write('<img src="%s" alt="" /> '
658 by mattgiuca dispatch/html: Added tooltips based on app descriptions ( to app tabs ).	188	% urllib.quote(get_icon_url(urlname)))
	189	file.write('<a href="%s" title="%s">%s</a></li>\n'
	190	% (urllib.quote(util.make_path(urlname)), cgi.escape(app.desc),
	191	cgi.escape(app.name)))
93 by mattgiuca New directory hierarchy.	192
191 by mattgiuca dispatch.html, ivle.css, browser.css: Major restyling of the IVLE website.	193	file.write(' </ul>\n')