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

#!/usr/bin/env python

# IVLE - Informatics Virtual Learning Environment

# Copyright (C) 2007-2009 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

# Program: Marks

# Author:  Matt Giuca

# Script to calculate the marks for all students for a particular subject.

# Requires root to run.

import sys

import os

import csv

import datetime

import optparse

if os.getuid() != 0:

    print >>sys.stderr, "Must run %s as root." % os.path.basename(sys.argv[0])

    sys.exit()

import ivle.config

import ivle.database

import ivle.worksheet.utils

def get_userdata(user):

    """

    Given a User object, returns a list of strings for the user data which

    will be part of the output for this user.

    (This is not marks, it's other user data).

    """

    last_login = (None if user.last_login is None else

                    user.last_login.strftime("%d/%m/%y"))

    return [user.studentid, user.login, user.fullname, last_login]

userdata_header = ["Student ID", "Login", "Full name", "Last login"]

def get_header(worksheets):

    """

    Given a list of Worksheet objects (the assessable worksheets), returns a

    list of strings -- the column headings for the marks section of the CSV

    output.

    """

    return (userdata_header + [ws.name for ws in worksheets]

            + ["Total %", "Mark"])

def get_marks_user(worksheets, user, as_of=None):

    """Gets marks for a particular user for a particular set of worksheets.

    @param worksheets: List of Worksheet objects to get marks for.

    @param user: User to get marks for.

    @param as_of: Optional datetime. If supplied, gets the marks as of as_of.

    @returns: The user's percentage for each worksheet, overall, and

    their final mark, as a list of strings, in a manner which corresponds to

    the headings produced by get_marks_header.

    """

    worksheet_pcts = []

    # As we go, calculate the total score for this subject

    # (Assessable worksheets only, mandatory problems only)

    problems_done = 0

    problems_total = 0

    for worksheet in worksheets:

        # We simply ignore optional exercises here

        mand_done, mand_total, _, _ = (

            ivle.worksheet.utils.calculate_score(store, user, worksheet,

                                                 as_of))

        if mand_total > 0:

            worksheet_pcts.append(float(mand_done) / mand_total)

        else:

            # Avoid Div0, just give everyone 0 marks if there are none

            worksheet_pcts.append(0.0)

        problems_done += mand_done

        problems_total += mand_total

    percent, mark, _ = (

        ivle.worksheet.utils.calculate_mark(problems_done, problems_total))

    return worksheet_pcts + [float(percent)/100, mark]

def writeuser(worksheets, user, csvfile, cutoff=None):

    userdata = get_userdata(user)

    marksdata = get_marks_user(worksheets, user, cutoff)

    data = userdata + marksdata

    # CSV writer can't handle non-ASCII characters. Encode to UTF-8.

    data = [unicode(x).encode('utf-8') for x in data]

    csvfile.writerow(data)

def main(argv=None):

    global store

    if argv is None:

        argv = sys.argv

    usage = """usage: %prog [options] subject

    (requires root)

    Reports each student's marks for a given subject offering."""

    # Parse arguments

    parser = optparse.OptionParser(usage)

    parser.add_option("-s", "--semester",

        action="store", dest="semester", metavar="YEAR/SEMESTER",

        help="Semester of the subject's offering (eg. 2009/1). "

             "Defaults to the currently active semester.",

        default=None)

    parser.add_option("-c", "--cutoff",

        action="store", dest="cutoff", metavar="DATE",

        help="Cutoff date (calculate the marks as of this date). "

             "YYYY-MM-DD H:M:S.",

        default=None)

    (options, args) = parser.parse_args(argv[1:])

    if len(args) < 1:

        parser.print_help()

        parser.exit()

    subject_name = unicode(args[0])

    if options.semester is None:

        year, semester = None, None

    else:

        try:

            year, semester = options.semester.split('/')

            if len(year) == 0 or len(semester) == 0:

                raise ValueError()

        except ValueError:

            parser.error('Invalid semester (must have form "year/semester")')

    if options.cutoff is not None:

        try:

            cutoff = datetime.datetime.strptime(options.cutoff,

                                                "%Y-%m-%d %H:%M:%S")

        except ValueError:

            parser.error("Invalid date format: '%s' "

                         "(must be YYYY-MM-DD H:M:S)." % options.cutoff)

    else:

        cutoff = None

    store = ivle.database.get_store(ivle.config.Config(plugins=False))

    # Get the subject from the DB

    subject = store.find(ivle.database.Subject,

                     ivle.database.Subject.short_name == subject_name).one()

    if subject is None:

        print >>sys.stderr, "No subject with short name '%s'" % subject_name

        return 1

    # Get the offering from the DB

    if semester is None:

        # None specified - get the current offering from the DB

        offerings = list(subject.active_offerings())

        if len(offerings) == 0:

            print >>sys.stderr, ("No active offering for subject '%s'"

                                 % subject_name)

            return 1

        elif len(offerings) > 1:

            print >>sys.stderr, ("Multiple active offerings for subject '%s':"

                                 % subject_name)

            print >>sys.stderr, "Please use one of:"

            for offering in offerings:

                print >>sys.stderr, ("    --semester=%s/%s"

                    % (offering.semester.year, offering.semester.semester))

            return 1

        else:

            offering = offerings[0]

    else:

        # Get the offering for the specified semester

        offering = subject.offering_for_semester(year, semester)

        if offering is None:

            print >>sys.stderr, (

                "No offering for subject '%s' in semester %s/%s"

                % (subject_name, year, semester))

            return 1

    # Get the list of assessable worksheets

    worksheets = offering.worksheets.find(assessable=True)

    # Start writing the CSV file - header

    csvfile = csv.writer(sys.stdout)

    csvfile.writerow(get_header(worksheets))

    # Get all users enrolled in this offering

    users = store.find(ivle.database.User,

                   ivle.database.User.id == ivle.database.Enrolment.user_id,

                   offering.id == ivle.database.Enrolment.offering).order_by(

                        ivle.database.User.login)

    for user in users:

        writeuser(worksheets, user, csvfile, cutoff)

if __name__ == "__main__":

    sys.exit(main(sys.argv))