← Back to branch summary

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

« back to all changes in this revision

Viewing changes to setup.py

  • Committer: Matt Giuca
  • Date: 2010-02-12 10:27:55 UTC
  • Revision ID: matt.giuca@gmail.com-20100212102755-ifsyo4qaqa2myvl5
docs: Added a new help page, Running and Serving.

Show diffs side-by-side

added added

removed removed

Lines of Context:
setup.py
21
21
# Date:   12/12/2007
22
22
 
23
23
# This is a command-line application, for use by the administrator.
24
 
# Prompts the administrator to enter machine-specific details and builds the
25
 
# file conf/conf.py.
26
 
# (This file is not included with the distribution precisely because it
27
 
# contains machine-specific settings).
 
24
# This program is a frontend for the modules in the setup packages that 
 
25
# build and install IVLE in separate steps.
 
26
# It is called with at least one argument, which specifies which operation to
 
27
# take.
28
28
 
29
 
import os
30
29
import sys
31
 
 
32
 
def query_user(prompt):
33
 
    """Prompts the user for a string, which is read from a line of stdin.
34
 
    Exits silently if EOF is encountered. Returns the string, with spaces
35
 
    removed from the beginning and end.
36
 
    """
37
 
    sys.stdout.write(prompt)
38
 
    sys.stdout.write("\n>")
39
 
    try:
40
 
        val = sys.stdin.readline()
41
 
    except KeyboardInterrupt:
42
 
        # Ctrl+C
43
 
        sys.stdout.write("\n")
44
 
        sys.exit(1)
45
 
    sys.stdout.write("\n")
46
 
    if val == '': sys.exit(1)
47
 
    return val.strip()
48
 
 
49
 
# MAIN SCRIPT
50
 
 
51
 
# Set up some variables
52
 
 
53
 
cwd = os.getcwd()
54
 
# the files that will be created/overwritten
55
 
conffile = os.path.join(cwd, "www/conf/conf.py")
56
 
conf_hfile = os.path.join(cwd, "trampoline/conf.h")
57
 
 
58
 
# Fixed config options that we don't ask the admin
59
 
 
60
 
default_app = "dummy"
61
 
 
62
 
# Print the opening spiel including the GPL notice
63
 
 
64
 
print """IVLE - Informatics Virtual Learning Environment Setup
65
 
Copyright (C) 2007-2008 The University of Melbourne
 
30
import setup.build
 
31
import setup.install
 
32
 
 
33
def main(argv=None):
 
34
    if argv is None:
 
35
        argv = sys.argv
 
36
 
 
37
    # Print the opening spiel including the GPL notice
 
38
 
 
39
    print """IVLE - Informatics Virtual Learning Environment Setup
 
40
Copyright (C) 2007-2009 The University of Melbourne
66
41
IVLE comes with ABSOLUTELY NO WARRANTY.
67
42
This is free software, and you are welcome to redistribute it
68
43
under certain conditions. See LICENSE.txt for details.
 
44
 
 
45
IVLE Setup
69
46
"""
70
47
 
71
 
print """IVLE Setup
72
 
This tool will create the following files:
73
 
    %s
74
 
    %s
75
 
prompting you for details about your configuration. The file will be
76
 
overwritten if it already exists. It will *not* install or deploy IVLE.
77
 
 
78
 
Please hit Ctrl+C now if you do not wish to do this.
79
 
""" % (conffile, conf_hfile)
80
 
 
81
 
# Get information from the administrator
82
 
# If EOF is encountered at any time during the questioning, just exit silently
83
 
 
84
 
root_dir = query_user("""Root directory where IVLE is located (in URL space):
85
 
(eg. "/" or "/ivle")""")
86
 
ivle_install_dir = query_user('Root directory where IVLE is located (on the '
87
 
'local file system):\n'
88
 
'(eg. "/home/informatics/ivle")')
89
 
student_dir = query_user(
90
 
    """Root directory where user files are stored (on the local file system):
91
 
(eg. "/home/informatics/jails")""")
92
 
 
93
 
# Write www/conf.py
94
 
 
95
 
try:
96
 
    conf = open(conffile, "w")
97
 
 
98
 
    conf.write("""# IVLE Configuration File
99
 
# conf.py
100
 
# Miscellaneous application settings
101
 
 
102
 
 
103
 
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
104
 
# with this).
105
 
# eg. "/" or "/ivle".
106
 
root_dir = "%s"
107
 
 
108
 
# In the local file system, where IVLE is actually installed.
109
 
# This directory should contain the "www" and "bin" directories.
110
 
ivle_install_dir = "%s"
111
 
 
112
 
# In the local file system, where are the student/user file spaces located.
113
 
# The user jails are expected to be located immediately in subdirectories of
114
 
# this location.
115
 
student_dir = "%s"
116
 
 
117
 
# Which application to load by default (if the user navigates to the top level
118
 
# of the site). This is the app's URL name.
119
 
# Note that if this app requires authentication, the user will first be
120
 
# presented with the login screen.
121
 
default_app = "%s"
122
 
""" % (root_dir, ivle_install_dir, student_dir, default_app))
123
 
    
124
 
    conf.close()
125
 
except IOError, (errno, strerror):
126
 
    print "IO error(%s): %s" % (errno, strerror)
127
 
    sys.exit(1)
128
 
 
129
 
print "Successfully wrote www/conf.py"
130
 
 
131
 
# Write trampoline/conf.h
132
 
 
133
 
try:
134
 
    conf = open(conf_hfile, "w")
135
 
 
136
 
    conf.write("""/* IVLE Configuration File
137
 
 * conf.h
138
 
 * Administrator settings required by trampoline.
139
 
 * Note: trampoline will have to be rebuilt in order for changes to this file
140
 
 * to take effect.
141
 
 */
142
 
 
143
 
/* In the local file system, where are the jails located.
144
 
 * The trampoline does not allow the creation of a jail anywhere besides
145
 
 * jail_base or a subdirectory of jail_base.
146
 
 */
147
 
static const char* jail_base = "%s";
148
 
""" % (student_dir))
149
 
 
150
 
    conf.close()
151
 
except IOError, (errno, strerror):
152
 
    print "IO error(%s): %s" % (errno, strerror)
153
 
    sys.exit(1)
154
 
 
155
 
print "Successfully wrote trampoline/conf.h"
156
 
 
157
 
print
158
 
print "You may modify the configuration at any time by editing"
159
 
print conffile
160
 
print conf_hfile
161
 
print
 
48
    # First argument is the name of the setup operation
 
49
    try:
 
50
        operation = argv[1]
 
51
    except IndexError:
 
52
        # Print usage message and exit
 
53
        help([])
 
54
        return 1
 
55
 
 
56
    oper_func = call_operator(operation)
 
57
    return oper_func(argv[2:])
 
58
 
 
59
def help(args):
 
60
    if len(args)!=1:
 
61
        print """Usage: python setup.py operation [options]
 
62
Operation can be:
 
63
    help [operation]
 
64
    build
 
65
    install
 
66
 
 
67
    For help and options for a specific operation use 'help [operation]'."""
 
68
    else:
 
69
        operator = args[0]
 
70
        oper_func = call_operator(operator)
 
71
        oper_func(['operator','--help'])
 
72
 
 
73
def call_operator(operation):
 
74
    # Call the requested operation's function
 
75
    try:
 
76
        oper_func = {
 
77
            'help' : help,
 
78
            'build' : setup.build.build,
 
79
            'install' : setup.install.install,
 
80
        }[operation]
 
81
    except KeyError:
 
82
        print >>sys.stderr, (
 
83
            """Invalid operation '%s'. Try python setup.py help."""
 
84
            % operation)
 
85
        sys.exit(1)
 
86
    return oper_func
 
87
 
 
88
if __name__ == "__main__":
 
89
    sys.exit(main())
162
90