~azzar1/unity/add-show-desktop-key

# IVLE

# 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

# Plugin: console

# Author: Matt Giuca

# Date: 30/1/2008

# Console plugin. This "mini-app" can be plugged in to another application.

# It exposes two functions: "present" and "insert_scripts_styles".

# These should both be called at the appropriate time by the implementing

# application. See docs on these functions for details.

# Applications also need to call console_init in JavaScript from their own

# onload events.

import cgi

from ivle import util

import genshi

import genshi.core

import genshi.template

def insert_scripts_styles(scripts, styles, scripts_init):

    """Given 2 lists of strings: scripts and styles. These lists are lists of

    pathnames, as expected on the "scripts" and "styles" attributes of a

    Request object.

    This function appends new strings to the ends of each list, as required by

    this plugin. It does not add duplicates.

    """

    _append_if_absent(scripts,

        "media/common/json2.js",

        "media/common/md5.js",

        "media/common/util.js",

        "media/console/console.js")

    _append_if_absent(styles,

        "media/console/console.css")

    _append_if_absent(scripts_init,

        "console_init")

def present(req, windowpane=False):

    """Writes the HTML for this plugin into a request stream.

    May utilise other properties of the Request object in generating the HTML.

    windowpane: If True, starts the console in "window pane" mode, where it

    will float over the page and have a "minimize" button.

    """

    ctx = genshi.template.Context()

    ctx['windowpane'] = windowpane

    ctx['minimize_path'] = util.make_path("media/images/interface/minimize.png") 

    ctx['maximize_path'] = util.make_path("media/images/interface/maximize.png")

    loader = genshi.template.TemplateLoader(".", auto_reload=True)

    tmpl = loader.load(util.make_local_path("plugins/console/template.html"))

    #TODO: Make the dispatch render this

    req.write(tmpl.generate(ctx).render('html'))

def _append_if_absent(list, *values):

    """Appends an arbitray number of values to a list, but omits values that

    are already contained within the list."""

    for value in values:

        if not value in list:

            list.append(value)