← Back to branch summary

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

« back to all changes in this revision

Viewing changes to setup.py

  • Committer: mattgiuca
  • Date: 2008-03-16 02:46:19 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:712
setup: Added config option "motd_path" to hold the path for message-of-the-day
    announcements.
dispatch.login: Now tries to send the file in motd_path at the bottom of the
    login page.
This allows our admins to post system-wide announcements.

Show diffs side-by-side

added added

removed removed

Lines of Context:
setup.py
31
31
# cutting a distribution, and the listfile it generates should be included in
32
32
# the distribution, avoiding the administrator having to run it.
33
33
 
34
 
# setup.py conf [args]
 
34
# setup.py config [args]
35
35
# Configures IVLE with machine-specific details, most notably, various paths.
36
36
# Either prompts the administrator for these details or accepts them as
37
37
# command-line args.
38
 
# Creates www/conf/conf.py and trampoline/conf.h.
 
38
# Creates lib/conf/conf.py and trampoline/conf.h.
39
39
 
40
40
# setup.py build
41
41
# Compiles all files and sets up a jail template in the source directory.
67
67
import mimetypes
68
68
import compileall
69
69
import getopt
 
70
import hashlib
 
71
import uuid
70
72
 
71
73
# Import modules from the website is tricky since they're in the www
72
74
# directory.
73
 
sys.path.append(os.path.join(os.getcwd(), 'www'))
 
75
sys.path.append(os.path.join(os.getcwd(), 'lib'))
74
76
import conf
75
77
import common.makeuser
76
78
 
 
79
# Determine which Python version (2.4 or 2.5, for example) we are running,
 
80
# and use that as the filename to the Python directory.
 
81
# Just get the first 3 characters of sys.version.
 
82
PYTHON_VERSION = sys.version[0:3]
 
83
 
77
84
# Operating system files to copy over into the jail.
78
85
# These will be copied from the given place on the OS file system into the
79
86
# same place within the jail.
94
101
    '/bin/ls',
95
102
    '/bin/echo',
96
103
    # Needed by python
97
 
    '/usr/bin/python2.5',
 
104
    '/usr/bin/python%s' % PYTHON_VERSION,
 
105
    # Needed by fileservice
 
106
    '/lib/libcom_err.so.2',
 
107
    '/lib/libcrypt.so.1',
 
108
    '/lib/libkeyutils.so.1',
 
109
    '/lib/libresolv.so.2',
 
110
    '/lib/librt.so.1',
 
111
    '/lib/libuuid.so.1',
 
112
    '/usr/lib/libapr-1.so.0',
 
113
    '/usr/lib/libaprutil-1.so.0',
 
114
    '/usr/lib/libdb-4.4.so',
 
115
    '/usr/lib/libexpat.so.1',
 
116
    '/usr/lib/libgcrypt.so.11',
 
117
    '/usr/lib/libgnutls.so.13',
 
118
    '/usr/lib/libgpg-error.so.0',
 
119
    '/usr/lib/libgssapi_krb5.so.2',
 
120
    '/usr/lib/libk5crypto.so.3',
 
121
    '/usr/lib/libkrb5.so.3',
 
122
    '/usr/lib/libkrb5support.so.0',
 
123
    '/usr/lib/liblber.so.2',
 
124
    '/usr/lib/libldap_r.so.2',
 
125
    '/usr/lib/libneon.so.26',
 
126
    '/usr/lib/libpq.so.5',
 
127
    '/usr/lib/libsasl2.so.2',
 
128
    '/usr/lib/libsqlite3.so.0',
 
129
    '/usr/lib/libsvn_client-1.so.1',
 
130
    '/usr/lib/libsvn_delta-1.so.1',
 
131
    '/usr/lib/libsvn_diff-1.so.1',
 
132
    '/usr/lib/libsvn_fs-1.so.1',
 
133
    '/usr/lib/libsvn_fs_base-1.so.1',
 
134
    '/usr/lib/libsvn_fs_fs-1.so.1',
 
135
    '/usr/lib/libsvn_ra-1.so.1',
 
136
    '/usr/lib/libsvn_ra_dav-1.so.1',
 
137
    '/usr/lib/libsvn_ra_local-1.so.1',
 
138
    '/usr/lib/libsvn_ra_svn-1.so.1',
 
139
    '/usr/lib/libsvn_repos-1.so.1',
 
140
    '/usr/lib/libsvn_subr-1.so.1',
 
141
    '/usr/lib/libsvn_wc-1.so.1',
 
142
    '/usr/lib/libtasn1.so.3',
 
143
    '/usr/lib/libxml2.so.2',
98
144
    # Needed by matplotlib
99
145
    '/usr/lib/i686/cmov/libssl.so.0.9.8',
100
146
    '/usr/lib/i686/cmov/libcrypto.so.0.9.8',
115
161
    '/usr/lib/libXdmcp.so.6',
116
162
    '/lib/libgcc_s.so.1',
117
163
    '/etc/matplotlibrc',
 
164
    # Needed for resolv
 
165
    '/lib/libnss_dns.so.2',
 
166
    '/lib/libnss_mdns4_minimal.so.2',
 
167
    '/etc/hosts',
 
168
    '/etc/resolv.conf',
 
169
    #'/etc/hosts.conf',
 
170
    #'/etc/hostname',
 
171
    '/etc/nsswitch.conf',
 
172
    '/lib/libnss_files.so.2',
118
173
]
119
174
# Symlinks to make within the jail. Src mapped to dst.
120
175
JAIL_LINKS = {
121
 
    'python2.5': 'jail/usr/bin/python',
 
176
    'python%s' % PYTHON_VERSION: 'jail/usr/bin/python',
122
177
}
123
178
# Trees to copy. Src mapped to dst (these will be passed to action_copytree).
124
179
JAIL_COPYTREES = {
125
 
    '/usr/lib/python2.5': 'jail/usr/lib/python2.5',
 
180
    '/usr/lib/python%s' % PYTHON_VERSION:
 
181
        'jail/usr/lib/python%s' % PYTHON_VERSION,
126
182
    '/usr/share/matplotlib': 'jail/usr/share/matplotlib',
127
183
    '/etc/ld.so.conf.d': 'jail/etc/ld.so.conf.d',
 
184
    '/usr/share/nltk': 'jail/usr/share/nltk',
128
185
}
129
186
 
 
187
class ConfigOption:
 
188
    """A configuration option; one of the things written to conf.py."""
 
189
    def __init__(self, option_name, default, prompt, comment):
 
190
        """Creates a configuration option.
 
191
        option_name: Name of the variable in conf.py. Also name of the
 
192
            command-line argument to setup.py conf.
 
193
        default: Default value for this variable.
 
194
        prompt: (Short) string presented during the interactive prompt in
 
195
            setup.py conf.
 
196
        comment: (Long) comment string stored in conf.py. Each line of this
 
197
            string should begin with a '#'.
 
198
        """
 
199
        self.option_name = option_name
 
200
        self.default = default
 
201
        self.prompt = prompt
 
202
        self.comment = comment
 
203
 
 
204
# Configuration options, defaults and descriptions
 
205
config_options = []
 
206
config_options.append(ConfigOption("root_dir", "/",
 
207
    """Root directory where IVLE is located (in URL space):""",
 
208
    """
 
209
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
 
210
# with this).
 
211
# eg. "/" or "/ivle"."""))
 
212
config_options.append(ConfigOption("ivle_install_dir", "/opt/ivle",
 
213
    'Root directory where IVLE will be installed (on the local file '
 
214
    'system):',
 
215
    """
 
216
# In the local file system, where IVLE is actually installed.
 
217
# This directory should contain the "www" and "bin" directories."""))
 
218
config_options.append(ConfigOption("jail_base", "/home/informatics/jails",
 
219
    """Location of Directories
 
220
=======================
 
221
Root directory where the jails (containing user files) are stored
 
222
(on the local file system):""",
 
223
    """
 
224
# In the local file system, where are the student/user file spaces located.
 
225
# The user jails are expected to be located immediately in subdirectories of
 
226
# this location."""))
 
227
config_options.append(ConfigOption("subjects_base",
 
228
    "/home/informatics/subjects",
 
229
    """Root directory where the subject directories (containing worksheets
 
230
and other per-subject files) are stored (on the local file system):""",
 
231
    """
 
232
# In the local file system, where are the per-subject file spaces located.
 
233
# The individual subject directories are expected to be located immediately
 
234
# in subdirectories of this location."""))
 
235
config_options.append(ConfigOption("exercises_base",
 
236
    "/home/informatics/exercises",
 
237
    """Root directory where the exercise directories (containing
 
238
subject-independent exercise sheets) are stored (on the local file
 
239
system):""",
 
240
    """
 
241
# In the local file system, where are the subject-independent exercise sheet
 
242
# file spaces located."""))
 
243
config_options.append(ConfigOption("tos_path",
 
244
    "/home/informatics/tos.html",
 
245
    """Location where the Terms of Service document is stored (on the local
 
246
    file system):""",
 
247
    """
 
248
# In the local file system, where is the Terms of Service document located."""))
 
249
config_options.append(ConfigOption("motd_path",
 
250
    "/home/informatics/motd.html",
 
251
    """Location where the Message of the Day document is stored (on the local
 
252
    file system):""",
 
253
    """
 
254
# In the local file system, where is the Message of the Day document
 
255
# located. This is an HTML file (just the body fragment), which will
 
256
# be displayed on the login page. It is optional."""))
 
257
config_options.append(ConfigOption("public_host", "public.localhost",
 
258
    """Hostname which will cause the server to go into "public mode",
 
259
providing login-free access to student's published work:""",
 
260
    """
 
261
# The server goes into "public mode" if the browser sends a request with this
 
262
# host. This is for security reasons - we only serve public student files on a
 
263
# separate domain to the main IVLE site.
 
264
# Public mode does not use cookies, and serves only public content.
 
265
# Private mode (normal mode) requires login, and only serves files relevant to
 
266
# the logged-in user."""))
 
267
config_options.append(ConfigOption("allowed_uids", "33",
 
268
    """UID of the web server process which will run IVLE.
 
269
Only this user may execute the trampoline. May specify multiple users as
 
270
a comma-separated list.
 
271
    (eg. "1002,78")""",
 
272
    """
 
273
# The User-ID of the web server process which will run IVLE, and any other
 
274
# users who are allowed to run the trampoline. This is stores as a string of
 
275
# comma-separated integers, simply because it is not used within Python, only
 
276
# used by the setup program to write to conf.h (see setup.py config)."""))
 
277
config_options.append(ConfigOption("db_host", "localhost",
 
278
    """PostgreSQL Database config
 
279
==========================
 
280
Hostname of the DB server:""",
 
281
    """
 
282
### PostgreSQL Database config ###
 
283
# Database server hostname"""))
 
284
config_options.append(ConfigOption("db_port", "5432",
 
285
    """Port of the DB server:""",
 
286
    """
 
287
# Database server port"""))
 
288
config_options.append(ConfigOption("db_dbname", "ivle",
 
289
    """Database name:""",
 
290
    """
 
291
# Database name"""))
 
292
config_options.append(ConfigOption("db_forumdbname", "ivle_forum",
 
293
    """Forum Database name:""",
 
294
    """
 
295
# Forum Database name"""))
 
296
config_options.append(ConfigOption("db_user", "postgres",
 
297
    """Username for DB server login:""",
 
298
    """
 
299
# Database username"""))
 
300
config_options.append(ConfigOption("db_password", "",
 
301
    """Password for DB server login:
 
302
    (Caution: This password is stored in plaintext in lib/conf/conf.py)""",
 
303
    """
 
304
# Database password"""))
 
305
config_options.append(ConfigOption("auth_modules", "ldap_auth",
 
306
    """Authentication config
 
307
=====================
 
308
Comma-separated list of authentication modules. Only "ldap" is available
 
309
by default.""",
 
310
    """
 
311
# Comma-separated list of authentication modules.
 
312
# These refer to importable Python modules in the www/auth directory.
 
313
# Modules "ldap" and "guest" are available in the source tree, but
 
314
# other modules may be plugged in to auth against organisation-specific
 
315
# auth backends."""))
 
316
config_options.append(ConfigOption("ldap_url", "ldaps://www.example.com",
 
317
    """(LDAP options are only relevant if "ldap" is included in the list of
 
318
auth modules).
 
319
URL for LDAP authentication server:""",
 
320
    """
 
321
# URL for LDAP authentication server"""))
 
322
config_options.append(ConfigOption("ldap_format_string",
 
323
    "uid=%s,ou=users,o=example",
 
324
    """Format string for LDAP auth request:
 
325
    (Must contain a single "%s" for the user's login name)""",
 
326
    """
 
327
# Format string for LDAP auth request
 
328
# (Must contain a single "%s" for the user's login name)"""))
 
329
config_options.append(ConfigOption("svn_addr", "http://svn.localhost/",
 
330
    """Subversion config
 
331
=================
 
332
The base url for accessing subversion repositories:""",
 
333
    """
 
334
# The base url for accessing subversion repositories."""))
 
335
config_options.append(ConfigOption("svn_conf", "/opt/ivle/svn/svn.conf",
 
336
    """The location of the subversion configuration file used by apache
 
337
to host the user repositories:""",
 
338
    """
 
339
# The location of the subversion configuration file used by
 
340
# apache to host the user repositories."""))
 
341
config_options.append(ConfigOption("svn_repo_path", "/home/informatics/repositories",
 
342
    """The root directory for the subversion repositories:""",
 
343
    """
 
344
# The root directory for the subversion repositories."""))
 
345
config_options.append(ConfigOption("svn_auth_ivle", "/opt/ivle/svn/ivle.auth",
 
346
    """The location of the password file used to authenticate users
 
347
of the subversion repository from the ivle server:""",
 
348
    """
 
349
# The location of the password file used to authenticate users
 
350
# of the subversion repository from the ivle server."""))
 
351
config_options.append(ConfigOption("svn_auth_local", "/opt/ivle/svn/local.auth",
 
352
    """The location of the password file used to authenticate local users
 
353
of the subversion repository:""",
 
354
    """
 
355
# The location of the password file used to authenticate local users
 
356
# of the subversion repository."""))
 
357
config_options.append(ConfigOption("usrmgt_host", "localhost",
 
358
    """User Management Server config
 
359
============================
 
360
The hostname where the usrmgt-server runs:""",
 
361
    """
 
362
# The hostname where the usrmgt-server runs."""))
 
363
config_options.append(ConfigOption("usrmgt_port", "2178",
 
364
    """The port where the usrmgt-server runs:""",
 
365
    """
 
366
# The port where the usrmgt-server runs."""))
 
367
config_options.append(ConfigOption("usrmgt_magic", "",
 
368
    """The password for the usrmgt-server:""",
 
369
    """
 
370
# The password for the usrmgt-server."""))
 
371
 
130
372
# Try importing existing conf, but if we can't just set up defaults
131
373
# The reason for this is that these settings are used by other phases
132
374
# of setup besides conf, so we need to know them.
133
375
# Also this allows you to hit Return to accept the existing value.
134
376
try:
135
 
    confmodule = __import__("www/conf/conf")
136
 
    try:
137
 
        root_dir = confmodule.root_dir
138
 
    except:
139
 
        root_dir = "/ivle"
140
 
    try:
141
 
        ivle_install_dir = confmodule.ivle_install_dir
142
 
    except:
143
 
        ivle_install_dir = "/opt/ivle"
144
 
    try:
145
 
        public_host = confmodule.public_host
146
 
    except:
147
 
        public_host = "public.localhost"
148
 
    try:
149
 
        jail_base = confmodule.jail_base
150
 
    except:
151
 
        jail_base = "/home/informatics/jails"
152
 
    try:
153
 
        subjects_base = confmodule.subjects_base
154
 
    except:
155
 
        subjects_base = "/home/informatics/subjects"
 
377
    confmodule = __import__("lib/conf/conf")
 
378
    for opt in config_options:
 
379
        try:
 
380
            globals()[opt.option_name] = confmodule.__dict__[opt.option_name]
 
381
        except:
 
382
            globals()[opt.option_name] = opt.default
156
383
except ImportError:
157
384
    # Just set reasonable defaults
158
 
    root_dir = "/ivle"
159
 
    ivle_install_dir = "/opt/ivle"
160
 
    public_host = "public.localhost"
161
 
    jail_base = "/home/informatics/jails"
162
 
    subjects_base = "/home/informatics/subjects"
163
 
# Always defaults
164
 
allowed_uids = "0"
 
385
    for opt in config_options:
 
386
        globals()[opt.option_name] = opt.default
165
387
 
166
388
# Try importing install_list, but don't fail if we can't, because listmake can
167
389
# function without it.
176
398
# as necessary, and include it in the distribution.
177
399
listmake_mimetypes = ['text/x-python', 'text/html',
178
400
    'application/x-javascript', 'application/javascript',
179
 
    'text/css', 'image/png']
 
401
    'text/css', 'image/png', 'image/gif', 'application/xml']
180
402
 
181
403
# Main function skeleton from Guido van Rossum
182
404
# http://www.artima.com/weblogs/viewpost.jsp?thread=4829
214
436
    try:
215
437
        oper_func = {
216
438
            'help' : help,
217
 
            'conf' : conf,
 
439
            'config' : conf,
218
440
            'build' : build,
219
441
            'listmake' : listmake,
220
442
            'install' : install,
235
457
Operation (and args) can be:
236
458
    help [operation]
237
459
    listmake (developer use only)
238
 
    conf [args]
 
460
    config [args]
239
461
    build
240
 
    install [--nojail] [-n|--dry]
 
462
    install [--nojail] [--nosubjects] [-n|--dry]
241
463
"""
242
464
        return 1
243
465
    elif len(args) != 1:
256
478
be copied upon installation. This should be run by the developer before
257
479
cutting a distribution, and the listfile it generates should be included in
258
480
the distribution, avoiding the administrator having to run it."""
259
 
    elif operation == 'conf':
260
 
        print """python setup.py conf [args]
 
481
    elif operation == 'config':
 
482
        print """python setup.py config [args]
261
483
Configures IVLE with machine-specific details, most notably, various paths.
262
484
Either prompts the administrator for these details or accepts them as
263
485
command-line args. Will be interactive only if there are no arguments given.
267
489
to rebuild/install), just provide ivle_install_dir as the IVLE trunk
268
490
directory, and run build/install one time.
269
491
 
270
 
Creates www/conf/conf.py and trampoline/conf.h.
 
492
Creates lib/conf/conf.py and trampoline/conf.h.
271
493
 
272
 
Args are:
273
 
    --root_dir
274
 
    --ivle_install_dir
275
 
    --public_host
276
 
    --jail_base
277
 
    --subjects_base
278
 
    --allowed_uids
279
 
As explained in the interactive prompt or conf.py.
 
494
Args are:"""
 
495
        for opt in config_options:
 
496
            print "    --" + opt.option_name
 
497
        print """As explained in the interactive prompt or conf.py.
280
498
"""
281
499
    elif operation == 'build':
282
500
        print """python -O setup.py build [--dry|-n]
293
511
 
294
512
--dry | -n  Print out the actions but don't do anything."""
295
513
    elif operation == 'install':
296
 
        print """sudo python setup.py install [--nojail] [--dry|-n]
 
514
        print """sudo python setup.py install [--nojail] [--nosubjects][--dry|-n]
297
515
(Requires root)
298
516
Create target install directory ($target).
299
517
Create $target/bin.
301
519
chown and chmod the installed trampoline.
302
520
Copy www/ to $target.
303
521
Copy jail/ to jails template directory (unless --nojail specified).
 
522
Copy subjects/ to subjects directory (unless --nosubjects specified).
304
523
 
305
 
--nojail    Do not copy the jail.
 
524
--nojail        Do not copy the jail.
 
525
--nosubjects    Do not copy the subjects and exercises directories.
306
526
--dry | -n  Print out the actions but don't do anything."""
307
527
    elif operation == 'updatejails':
308
528
        print """sudo python setup.py updatejails [--dry|-n]
319
539
def listmake(args):
320
540
    # We build two separate lists, by walking www and console
321
541
    list_www = build_list_py_files('www')
322
 
    list_console = build_list_py_files('console')
 
542
    list_lib = build_list_py_files('lib')
 
543
    list_subjects = build_list_py_files('subjects', no_top_level=True)
 
544
    list_exercises = build_list_py_files('exercises', no_top_level=True)
 
545
    list_scripts = [
 
546
        "scripts/python-console",
 
547
        "scripts/fileservice",
 
548
        "scripts/serveservice",
 
549
        "scripts/usrmgt-server",
 
550
        "scripts/diffservice",
 
551
    ]
323
552
    # Make sure that the files generated by conf are in the list
324
553
    # (since listmake is typically run before conf)
325
 
    if "www/conf/conf.py" not in list_www:
326
 
        list_www.append("www/conf/conf.py")
327
 
    # Make sure that console/python-console is in the list
328
 
    if "console/python-console" not in list_console:
329
 
        list_console.append("console/python-console")
 
554
    if "lib/conf/conf.py" not in list_lib:
 
555
        list_lib.append("lib/conf/conf.py")
330
556
    # Write these out to a file
331
557
    cwd = os.getcwd()
332
558
    # the files that will be created/overwritten
346
572
list_www = """)
347
573
        writelist_pretty(file, list_www)
348
574
        file.write("""
349
 
# List of all installable files in console directory.
350
 
list_console = """)
351
 
        writelist_pretty(file, list_console)
 
575
# List of all installable files in lib directory.
 
576
list_lib = """)
 
577
        writelist_pretty(file, list_lib)
 
578
        file.write("""
 
579
# List of all installable files in scripts directory.
 
580
list_scripts = """)
 
581
        writelist_pretty(file, list_scripts)
 
582
        file.write("""
 
583
# List of all installable files in subjects directory.
 
584
# This is to install sample subjects and material.
 
585
list_subjects = """)
 
586
        writelist_pretty(file, list_subjects)
 
587
        file.write("""
 
588
# List of all installable files in exercises directory.
 
589
# This is to install sample exercise material.
 
590
list_exercises = """)
 
591
        writelist_pretty(file, list_exercises)
352
592
 
353
593
        file.close()
354
594
    except IOError, (errno, strerror):
365
605
 
366
606
    return 0
367
607
 
368
 
def build_list_py_files(dir):
 
608
def build_list_py_files(dir, no_top_level=False):
369
609
    """Builds a list of all py files found in a directory and its
370
 
    subdirectories. Returns this as a list of strings."""
 
610
    subdirectories. Returns this as a list of strings.
 
611
    no_top_level=True means the file paths will not include the top-level
 
612
    directory.
 
613
    """
371
614
    pylist = []
372
615
    for (dirpath, dirnames, filenames) in os.walk(dir):
373
616
        # Exclude directories beginning with a '.' (such as '.svn')
375
618
        # All *.py files are added to the list
376
619
        pylist += [os.path.join(dirpath, item) for item in filenames
377
620
            if mimetypes.guess_type(item)[0] in listmake_mimetypes]
 
621
    if no_top_level:
 
622
        for i in range(0, len(pylist)):
 
623
            _, pylist[i] = pylist[i].split(os.sep, 1)
378
624
    return pylist
379
625
 
380
626
def writelist_pretty(file, list):
388
634
        file.write(']\n')
389
635
 
390
636
def conf(args):
391
 
    global root_dir, ivle_install_dir, jail_base, subjects_base
392
 
    global public_host, allowed_uids
 
637
    global db_port, usrmgt_port
393
638
    # Set up some variables
394
639
 
395
640
    cwd = os.getcwd()
396
641
    # the files that will be created/overwritten
397
 
    conffile = os.path.join(cwd, "www/conf/conf.py")
 
642
    conffile = os.path.join(cwd, "lib/conf/conf.py")
 
643
    jailconffile = os.path.join(cwd, "lib/conf/jailconf.py")
398
644
    conf_hfile = os.path.join(cwd, "trampoline/conf.h")
 
645
    phpBBconffile = os.path.join(cwd, "www/php/phpBB3/config.php")
 
646
    usrmgtserver_initdfile = os.path.join(cwd, "doc/setup/usrmgt-server.init")
399
647
 
400
648
    # Get command-line arguments to avoid asking questions.
401
649
 
402
 
    (opts, args) = getopt.gnu_getopt(args, "", ['root_dir=',
403
 
                    'ivle_install_dir=', 'jail_base=', 'allowed_uids='])
 
650
    optnames = []
 
651
    for opt in config_options:
 
652
        optnames.append(opt.option_name + "=")
 
653
    (opts, args) = getopt.gnu_getopt(args, "", optnames)
404
654
 
405
655
    if args != []:
406
656
        print >>sys.stderr, "Invalid arguments:", string.join(args, ' ')
412
662
        print """This tool will create the following files:
413
663
    %s
414
664
    %s
 
665
    %s
 
666
    %s
 
667
    %s
415
668
prompting you for details about your configuration. The file will be
416
669
overwritten if it already exists. It will *not* install or deploy IVLE.
417
670
 
418
671
Please hit Ctrl+C now if you do not wish to do this.
419
 
""" % (conffile, conf_hfile)
 
672
""" % (conffile, jailconffile, conf_hfile, phpBBconffile, usrmgtserver_initdfile)
420
673
 
421
674
        # Get information from the administrator
422
675
        # If EOF is encountered at any time during the questioning, just exit
423
676
        # silently
424
677
 
425
 
        root_dir = query_user(root_dir,
426
 
        """Root directory where IVLE is located (in URL space):""")
427
 
        ivle_install_dir = query_user(ivle_install_dir,
428
 
        'Root directory where IVLE will be installed (on the local file '
429
 
        'system):')
430
 
        jail_base = query_user(jail_base,
431
 
        """Root directory where the jails (containing user files) are stored
432
 
(on the local file system):""")
433
 
        subjects_base = query_user(subjects_base,
434
 
        """Root directory where the subject directories (containing worksheets
435
 
and other per-subject files) are stored (on the local file system):""")
436
 
        public_host = query_user(public_host,
437
 
        """Hostname which will cause the server to go into "public mode",
438
 
providing login-free access to student's published work:""")
439
 
        allowed_uids = query_user(allowed_uids,
440
 
        """UID of the web server process which will run IVLE.
441
 
Only this user may execute the trampoline. May specify multiple users as
442
 
a comma-separated list.
443
 
    (eg. "1002,78")""")
444
 
 
 
678
        for opt in config_options:
 
679
            globals()[opt.option_name] = \
 
680
                query_user(globals()[opt.option_name], opt.prompt)
445
681
    else:
446
682
        opts = dict(opts)
447
683
        # Non-interactive mode. Parse the options.
448
 
        if '--root_dir' in opts:
449
 
            root_dir = opts['--root_dir']
450
 
        if '--ivle_install_dir' in opts:
451
 
            ivle_install_dir = opts['--ivle_install_dir']
452
 
        if '--jail_base' in opts:
453
 
            jail_base = opts['--jail_base']
454
 
        if '--subjects_base' in opts:
455
 
            jail_base = opts['--subjects_base']
456
 
        if '--public_host' in opts:
457
 
            public_host = opts['--public_host']
458
 
        if '--allowed_uids' in opts:
459
 
            allowed_uids = opts['--allowed_uids']
 
684
        for opt in config_options:
 
685
            if '--' + opt.option_name in opts:
 
686
                globals()[opt.option_name] = opts['--' + opt.option_name]
460
687
 
461
688
    # Error handling on input values
462
689
    try:
463
 
        allowed_uids = map(int, allowed_uids.split(','))
 
690
        allowed_uids_list = map(int, allowed_uids.split(','))
464
691
    except ValueError:
465
692
        print >>sys.stderr, (
466
693
        "Invalid UID list (%s).\n"
467
694
        "Must be a comma-separated list of integers." % allowed_uids)
468
695
        return 1
469
 
 
470
 
    # Write www/conf/conf.py
 
696
    try:
 
697
        db_port = int(db_port)
 
698
        if db_port < 0 or db_port >= 65536: raise ValueError()
 
699
    except ValueError:
 
700
        print >>sys.stderr, (
 
701
        "Invalid DB port (%s).\n"
 
702
        "Must be an integer between 0 and 65535." % repr(db_port))
 
703
        return 1
 
704
    try:
 
705
        usrmgt_port = int(usrmgt_port)
 
706
        if usrmgt_port < 0 or usrmgt_port >= 65536: raise ValueError()
 
707
    except ValueError:
 
708
        print >>sys.stderr, (
 
709
        "Invalid user management port (%s).\n"
 
710
        "Must be an integer between 0 and 65535." % repr(usrmgt_port))
 
711
        return 1
 
712
 
 
713
    # Generate the forum secret
 
714
    forum_secret = hashlib.md5(uuid.uuid4().bytes).hexdigest()
 
715
 
 
716
    # Write lib/conf/conf.py
471
717
 
472
718
    try:
473
719
        conf = open(conffile, "w")
476
722
# conf.py
477
723
# Miscellaneous application settings
478
724
 
 
725
""")
 
726
        for opt in config_options:
 
727
            conf.write('%s\n%s = %s\n' % (opt.comment, opt.option_name,
 
728
                repr(globals()[opt.option_name])))
 
729
 
 
730
        # Add the forum secret to the config file (regenerated each config)
 
731
        conf.write('forum_secret = "%s"\n' % (forum_secret))
 
732
 
 
733
        conf.close()
 
734
    except IOError, (errno, strerror):
 
735
        print "IO error(%s): %s" % (errno, strerror)
 
736
        sys.exit(1)
 
737
 
 
738
    print "Successfully wrote lib/conf/conf.py"
 
739
 
 
740
    # Write conf/jailconf.py
 
741
 
 
742
    try:
 
743
        conf = open(jailconffile, "w")
 
744
 
 
745
        # In the "in-jail" version of conf, we don't need MOST of the details
 
746
        # (it would be a security risk to have them here).
 
747
        # So we just write root_dir, and jail_base is "/".
 
748
        # (jail_base being "/" means "jail-relative" paths are relative to "/"
 
749
        # when inside the jail.)
 
750
        conf.write("""# IVLE Configuration File
 
751
# conf.py
 
752
# Miscellaneous application settings
 
753
# (User jail version)
 
754
 
479
755
 
480
756
# In URL space, where in the site is IVLE located. (All URLs will be prefixed
481
757
# with this).
482
758
# eg. "/" or "/ivle".
483
 
root_dir = "%s"
484
 
 
485
 
# In the local file system, where IVLE is actually installed.
486
 
# This directory should contain the "www" and "bin" directories.
487
 
ivle_install_dir = "%s"
488
 
 
489
 
# The server goes into "public mode" if the browser sends a request with this
490
 
# host. This is for security reasons - we only serve public student files on a
491
 
# separate domain to the main IVLE site.
492
 
# Public mode does not use cookies, and serves only public content.
493
 
# Private mode (normal mode) requires login, and only serves files relevant to
494
 
# the logged-in user.
495
 
public_host = "%s"
 
759
root_dir = %s
496
760
 
497
761
# In the local file system, where are the student/user file spaces located.
498
762
# The user jails are expected to be located immediately in subdirectories of
499
763
# this location.
500
 
jail_base = "%s"
 
764
jail_base = '/'
501
765
 
502
 
# In the local file system, where are the per-subject file spaces located.
503
 
# The individual subject directories are expected to be located immediately
504
 
# in subdirectories of this location.
505
 
subjects_base = "%s"
506
 
""" % (root_dir, ivle_install_dir, public_host, jail_base, subjects_base))
 
766
# The hostname for serving publicly accessible pages
 
767
public_host = %s
 
768
""" % (repr(root_dir),repr(public_host)))
507
769
 
508
770
        conf.close()
509
771
    except IOError, (errno, strerror):
510
772
        print "IO error(%s): %s" % (errno, strerror)
511
773
        sys.exit(1)
512
774
 
513
 
    print "Successfully wrote www/conf/conf.py"
 
775
    print "Successfully wrote lib/conf/jailconf.py"
514
776
 
515
777
    # Write trampoline/conf.h
516
778
 
535
797
 * (Note that root is an implicit member of this list).
536
798
 */
537
799
static const int allowed_uids[] = { %s };
538
 
""" % (jail_base, repr(allowed_uids)[1:-1]))
 
800
""" % (repr(jail_base)[1:-1], repr(allowed_uids_list)[1:-1]))
 
801
    # Note: The above uses PYTHON reprs, not C reprs
 
802
    # However they should be the same with the exception of the outer
 
803
    # characters, which are stripped off and replaced
539
804
 
540
805
        conf.close()
541
806
    except IOError, (errno, strerror):
544
809
 
545
810
    print "Successfully wrote trampoline/conf.h"
546
811
 
 
812
    # Write www/php/phpBB3/config.php
 
813
 
 
814
    try:
 
815
        conf = open(phpBBconffile, "w")
 
816
        
 
817
        # php-pg work around
 
818
        if db_host == 'localhost':
 
819
            forumdb_host = '127.0.0.1'
 
820
        else:
 
821
            forumdb_host = db_host
 
822
 
 
823
        conf.write( """<?php
 
824
// phpBB 3.0.x auto-generated configuration file
 
825
// Do not change anything in this file!
 
826
$dbms = 'postgres';
 
827
$dbhost = '""" + forumdb_host + """';
 
828
$dbport = '""" + str(db_port) + """';
 
829
$dbname = '""" + db_forumdbname + """';
 
830
$dbuser = '""" + db_user + """';
 
831
$dbpasswd = '""" + db_password + """';
 
832
 
 
833
$table_prefix = 'phpbb_';
 
834
$acm_type = 'file';
 
835
$load_extensions = '';
 
836
@define('PHPBB_INSTALLED', true);
 
837
// @define('DEBUG', true);
 
838
//@define('DEBUG_EXTRA', true);
 
839
 
 
840
$forum_secret = '""" + forum_secret +"""';
 
841
?>"""   )
 
842
    
 
843
        conf.close()
 
844
    except IOError, (errno, strerror):
 
845
        print "IO error(%s): %s" % (errno, strerror)
 
846
        sys.exit(1)
 
847
 
 
848
    print "Successfully wrote www/php/phpBB3/config.php"
 
849
 
 
850
    # Write lib/conf/usrmgt-server.init
 
851
 
 
852
    try:
 
853
        conf = open(usrmgtserver_initdfile, "w")
 
854
 
 
855
        conf.write( '''#! /bin/sh
 
856
 
 
857
# Works for Ubuntu. Check before using on other distributions
 
858
 
 
859
### BEGIN INIT INFO
 
860
# Provides:          usrmgt-server
 
861
# Required-Start:    $syslog $networking $urandom
 
862
# Required-Stop:     $syslog
 
863
# Default-Start:     2 3 4 5
 
864
# Default-Stop:      1
 
865
# Short-Description: IVLE user management server
 
866
# Description:       Daemon connecting to the IVLE user management database.
 
867
### END INIT INFO
 
868
 
 
869
PATH=/sbin:/bin:/usr/sbin:/usr/bin
 
870
DESC="IVLE user management server"
 
871
NAME=usrmgt-server
 
872
DAEMON=/opt/ivle/scripts/$NAME
 
873
DAEMON_ARGS="''' + str(usrmgt_port) + ''' ''' + usrmgt_magic + '''"
 
874
PIDFILE=/var/run/$NAME.pid
 
875
SCRIPTNAME=/etc/init.d/usrmgt-server
 
876
 
 
877
# Exit if the daemon does not exist 
 
878
test -f $DAEMON || exit 0
 
879
 
 
880
# Load the VERBOSE setting and other rcS variables
 
881
[ -f /etc/default/rcS ] && . /etc/default/rcS
 
882
 
 
883
# Define LSB log_* functions.
 
884
# Depend on lsb-base (>= 3.0-6) to ensure that this file is present.
 
885
. /lib/lsb/init-functions
 
886
 
 
887
#
 
888
# Function that starts the daemon/service
 
889
#
 
890
do_start()
 
891
{
 
892
        # Return
 
893
        #   0 if daemon has been started
 
894
        #   1 if daemon was already running
 
895
        #   2 if daemon could not be started
 
896
        start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \
 
897
                || return 1
 
898
        start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON -- \
 
899
                $DAEMON_ARGS \
 
900
                || return 2
 
901
        # Add code here, if necessary, that waits for the process to be ready
 
902
        # to handle requests from services started subsequently which depend
 
903
        # on this one.  As a last resort, sleep for some time.
 
904
}
 
905
 
 
906
#
 
907
# Function that stops the daemon/service
 
908
#
 
909
do_stop()
 
910
{
 
911
        # Return
 
912
        #   0 if daemon has been stopped
 
913
        #   1 if daemon was already stopped
 
914
        #   2 if daemon could not be stopped
 
915
        #   other if a failure occurred
 
916
        start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME
 
917
        RETVAL="$?"
 
918
        [ "$RETVAL" = 2 ] && return 2
 
919
        # Wait for children to finish too if this is a daemon that forks
 
920
        # and if the daemon is only ever run from this initscript.
 
921
        # If the above conditions are not satisfied then add some other code
 
922
        # that waits for the process to drop all resources that could be
 
923
        # needed by services started subsequently.  A last resort is to
 
924
        # sleep for some time.
 
925
        start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON
 
926
        [ "$?" = 2 ] && return 2
 
927
        # Many daemons don't delete their pidfiles when they exit.
 
928
        rm -f $PIDFILE
 
929
        return "$RETVAL"
 
930
}
 
931
 
 
932
#
 
933
# Function that sends a SIGHUP to the daemon/service
 
934
#
 
935
do_reload() {
 
936
        #
 
937
        # If the daemon can reload its configuration without
 
938
        # restarting (for example, when it is sent a SIGHUP),
 
939
        # then implement that here.
 
940
        #
 
941
        start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME
 
942
        return 0
 
943
}
 
944
 
 
945
case "$1" in
 
946
  start)
 
947
    [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
 
948
        do_start
 
949
        case "$?" in
 
950
                0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
 
951
                2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
 
952
        esac
 
953
        ;;
 
954
  stop)
 
955
        [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
 
956
        do_stop
 
957
        case "$?" in
 
958
                0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
 
959
                2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
 
960
        esac
 
961
        ;;
 
962
  #reload|force-reload)
 
963
        #
 
964
        # If do_reload() is not implemented then leave this commented out
 
965
        # and leave 'force-reload' as an alias for 'restart'.
 
966
        #
 
967
        #log_daemon_msg "Reloading $DESC" "$NAME"
 
968
        #do_reload
 
969
        #log_end_msg $?
 
970
        #;;
 
971
  restart|force-reload)
 
972
        #
 
973
        # If the "reload" option is implemented then remove the
 
974
        # 'force-reload' alias
 
975
        #
 
976
        log_daemon_msg "Restarting $DESC" "$NAME"
 
977
        do_stop
 
978
        case "$?" in
 
979
          0|1)
 
980
                do_start
 
981
                case "$?" in
 
982
                        0) log_end_msg 0 ;;
 
983
                        1) log_end_msg 1 ;; # Old process is still running
 
984
                        *) log_end_msg 1 ;; # Failed to start
 
985
                esac
 
986
                ;;
 
987
          *)
 
988
                # Failed to stop
 
989
                log_end_msg 1
 
990
                ;;
 
991
        esac
 
992
        ;;
 
993
  *)
 
994
        #echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
 
995
        echo "Usage: $SCRIPTNAME {start|stop|restart|force-reload}" >&2
 
996
        exit 3
 
997
        ;;
 
998
esac
 
999
 
 
1000
:
 
1001
''')
 
1002
        
 
1003
        conf.close()
 
1004
    except IOError, (errno, strerror):
 
1005
        print "IO error(%s): %s" % (errno, strerror)
 
1006
        sys.exit(1)
 
1007
 
 
1008
    # fix permissions as the file contains the database password
 
1009
    try:
 
1010
        os.chmod('doc/setup/usrmgt-server.init', 0600)
 
1011
    except OSError, (errno, strerror):
 
1012
        print "WARNING: Couldn't chmod doc/setup/usrmgt-server.init:"
 
1013
        print "OS error(%s): %s" % (errno, strerror)
 
1014
 
 
1015
    print "Successfully wrote lib/conf/usrmgt-server.init"
 
1016
 
547
1017
    print
548
1018
    print "You may modify the configuration at any time by editing"
549
1019
    print conffile
 
1020
    print jailconffile
550
1021
    print conf_hfile
 
1022
    print phpBBconffile
 
1023
    print usrmgtserver_initdfile
551
1024
    print
552
1025
    return 0
553
1026
 
561
1034
        print "Dry run (no actions will be executed\n"
562
1035
 
563
1036
    # Compile the trampoline
564
 
    action_runprog('gcc', ['-Wall', '-o', 'trampoline/trampoline',
565
 
        'trampoline/trampoline.c'], dry)
 
1037
    curdir = os.getcwd()
 
1038
    os.chdir('trampoline')
 
1039
    action_runprog('make', [], dry)
 
1040
    os.chdir(curdir)
566
1041
 
567
1042
    # Create the jail and its subdirectories
568
1043
    # Note: Other subdirs will be made by copying files
570
1045
    action_mkdir('jail/home', dry)
571
1046
    action_mkdir('jail/tmp', dry)
572
1047
 
 
1048
    # Chmod the tmp directory to world writable
 
1049
    action_chmod_w('jail/tmp', dry)
 
1050
 
573
1051
    # Copy all console and operating system files into the jail
574
 
    action_copylist(install_list.list_console, 'jail/opt/ivle', dry)
 
1052
    action_copylist(install_list.list_scripts, 'jail/opt/ivle', dry)
575
1053
    copy_os_files_jail(dry)
576
1054
    # Chmod the python console
577
 
    action_chmod_x('jail/opt/ivle/console/python-console', dry)
 
1055
    action_chmod_x('jail/opt/ivle/scripts/python-console', dry)
 
1056
    action_chmod_x('jail/opt/ivle/scripts/fileservice', dry)
 
1057
    action_chmod_x('jail/opt/ivle/scripts/serveservice', dry)
578
1058
    
 
1059
    # Also copy the IVLE lib directory into the jail
 
1060
    # This is necessary for running certain scripts
 
1061
    action_copylist(install_list.list_lib, 'jail/opt/ivle', dry)
 
1062
    # IMPORTANT: The file jail/opt/ivle/lib/conf/conf.py contains details
 
1063
    # which could compromise security if left in the jail (such as the DB
 
1064
    # password).
 
1065
    # The "safe" version is in jailconf.py. Delete conf.py and replace it with
 
1066
    # jailconf.py.
 
1067
    action_copyfile('lib/conf/jailconf.py',
 
1068
        'jail/opt/ivle/lib/conf/conf.py', dry)
579
1069
 
580
1070
    # Compile .py files into .pyc or .pyo files
581
1071
    compileall.compile_dir('www', quiet=True)
582
 
    compileall.compile_dir('console', quiet=True)
 
1072
    compileall.compile_dir('lib', quiet=True)
 
1073
    compileall.compile_dir('scripts', quiet=True)
 
1074
    compileall.compile_dir('jail/opt/ivle/lib', quiet=True)
 
1075
 
 
1076
    # Set up ivle.pth inside the jail
 
1077
    # Need to set /opt/ivle/lib to be on the import path
 
1078
    ivle_pth = \
 
1079
        "jail/usr/lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION
 
1080
    f = open(ivle_pth, 'w')
 
1081
    f.write('/opt/ivle/lib\n')
 
1082
    f.close()
583
1083
 
584
1084
    return 0
585
1085
 
602
1102
 
603
1103
def install(args):
604
1104
    # Get "dry" and "nojail" variables from command line
605
 
    (opts, args) = getopt.gnu_getopt(args, "n", ['dry', 'nojail'])
 
1105
    (opts, args) = getopt.gnu_getopt(args, "n",
 
1106
        ['dry', 'nojail', 'nosubjects'])
606
1107
    opts = dict(opts)
607
1108
    dry = '-n' in opts or '--dry' in opts
608
1109
    nojail = '--nojail' in opts
 
1110
    nosubjects = '--nosubjects' in opts
609
1111
 
610
1112
    if dry:
611
1113
        print "Dry run (no actions will be executed\n"
625
1127
    # chown trampoline to root and set setuid bit
626
1128
    action_chown_setuid(tramppath, dry)
627
1129
 
628
 
    # Copy the www directory using the list
 
1130
    # Create a scripts directory to put the usrmgt-server in.
 
1131
    action_mkdir(os.path.join(ivle_install_dir, 'scripts'), dry)
 
1132
    usrmgtpath = os.path.join(ivle_install_dir, 'scripts/usrmgt-server')
 
1133
    action_copyfile('scripts/usrmgt-server', usrmgtpath, dry)
 
1134
    action_chmod_x(usrmgtpath, dry)
 
1135
 
 
1136
    # Copy the www and lib directories using the list
629
1137
    action_copylist(install_list.list_www, ivle_install_dir, dry)
 
1138
    action_copylist(install_list.list_lib, ivle_install_dir, dry)
 
1139
    
 
1140
    # Copy the php directory
 
1141
    forum_dir = "www/php/phpBB3"
 
1142
    forum_path = os.path.join(ivle_install_dir, forum_dir)
 
1143
    action_copytree(forum_dir, forum_path, dry)
 
1144
    print "chown -R www-data:www-data %s" % forum_path
 
1145
    if not dry:
 
1146
        os.system("chown -R www-data:www-data %s" % forum_path)
630
1147
 
631
1148
    if not nojail:
632
1149
        # Copy the local jail directory built by the build action
633
1150
        # to the jails template directory (it will be used as a template
634
1151
        # for all the students' jails).
635
1152
        action_copytree('jail', os.path.join(jail_base, 'template'), dry)
 
1153
    if not nosubjects:
 
1154
        # Copy the subjects and exercises directories across
 
1155
        action_copylist(install_list.list_subjects, subjects_base, dry,
 
1156
            srcdir="./subjects")
 
1157
        action_copylist(install_list.list_exercises, exercises_base, dry,
 
1158
            srcdir="./exercises")
636
1159
 
637
1160
    # Append IVLE path to ivle.pth in python site packages
638
1161
    # (Unless it's already there)
639
1162
    ivle_pth = os.path.join(sys.prefix,
640
 
        "lib/python2.5/site-packages/ivle.pth")
 
1163
        "lib/python%s/site-packages/ivle.pth" % PYTHON_VERSION)
641
1164
    ivle_www = os.path.join(ivle_install_dir, "www")
 
1165
    ivle_lib = os.path.join(ivle_install_dir, "lib")
642
1166
    write_ivle_pth = True
 
1167
    write_ivle_lib_pth = True
643
1168
    try:
644
1169
        file = open(ivle_pth, 'r')
645
1170
        for line in file:
646
1171
            if line.strip() == ivle_www:
647
1172
                write_ivle_pth = False
648
 
                break
 
1173
            elif line.strip() == ivle_lib:
 
1174
                write_ivle_lib_pth = False
 
1175
        file.close()
649
1176
    except (IOError, OSError):
650
1177
        pass
651
1178
    if write_ivle_pth:
652
1179
        action_append(ivle_pth, ivle_www)
 
1180
    if write_ivle_lib_pth:
 
1181
        action_append(ivle_pth, ivle_lib)
653
1182
 
654
1183
    return 0
655
1184
 
717
1246
    if ret != 0:
718
1247
        raise RunError(prog, ret)
719
1248
 
 
1249
def action_remove(path, dry):
 
1250
    """Calls rmtree, deleting the target file if it exists."""
 
1251
    try:
 
1252
        print "rm -r", path
 
1253
        if not dry:
 
1254
            shutil.rmtree(path, True)
 
1255
    except OSError, (err, msg):
 
1256
        if err != errno.EEXIST:
 
1257
            raise
 
1258
        # Otherwise, didn't exist, so we don't care
 
1259
 
720
1260
def action_rename(src, dst, dry):
721
1261
    """Calls rename. Deletes the target if it already exists."""
722
 
    if os.access(dst, os.F_OK):
723
 
        print "rm -r", dst
724
 
        if not dry:
725
 
            shutil.rmtree(dst, True)
 
1262
    action_remove(dst, dry)
726
1263
    print "mv ", src, dst
727
1264
    if dry: return
728
1265
    try:
748
1285
    directories as necessary.
749
1286
 
750
1287
    See shutil.copytree."""
751
 
    if os.access(dst, os.F_OK):
752
 
        print "rm -r", dst
753
 
        if not dry:
754
 
            shutil.rmtree(dst, True)
 
1288
    # Allow copying over itself
 
1289
    if (os.path.normpath(os.path.join(os.getcwd(),src)) ==
 
1290
        os.path.normpath(os.path.join(os.getcwd(),dst))):
 
1291
        return
 
1292
    action_remove(dst, dry)
755
1293
    print "cp -r", src, dst
756
1294
    if dry: return
757
1295
    shutil.copytree(src, dst, True)
760
1298
    """Hard-links an entire directory tree. Same as copytree but the created
761
1299
    files are hard-links not actual copies. Removes the existing destination.
762
1300
    """
763
 
    if os.access(dst, os.F_OK):
764
 
        print "rm -r", dst
765
 
        if not dry:
766
 
            shutil.rmtree(dst, True)
 
1301
    action_remove(dst, dry)
767
1302
    print "<cp with hardlinks> -r", src, dst
768
1303
    if dry: return
769
1304
    common.makeuser.linktree(src, dst)
770
1305
 
771
 
def action_copylist(srclist, dst, dry):
 
1306
def action_copylist(srclist, dst, dry, srcdir="."):
772
1307
    """Copies all files in a list to a new location. The files in the list
773
1308
    are read relative to the current directory, and their destinations are the
774
1309
    same paths relative to dst. Creates all parent directories as necessary.
 
1310
    srcdir is "." by default, can be overridden.
775
1311
    """
776
1312
    for srcfile in srclist:
777
1313
        dstfile = os.path.join(dst, srcfile)
 
1314
        srcfile = os.path.join(srcdir, srcfile)
778
1315
        dstdir = os.path.split(dstfile)[0]
779
1316
        if not os.path.isdir(dstdir):
780
1317
            action_mkdir(dstdir, dry)
789
1326
def action_copyfile(src, dst, dry):
790
1327
    """Copies one file to a new location. Creates all parent directories
791
1328
    as necessary.
 
1329
    Warn if file not found.
792
1330
    """
793
1331
    dstdir = os.path.split(dst)[0]
794
1332
    if not os.path.isdir(dstdir):
798
1336
        try:
799
1337
            shutil.copyfile(src, dst)
800
1338
            shutil.copymode(src, dst)
801
 
        except shutil.Error:
802
 
            pass
 
1339
        except (shutil.Error, IOError), e:
 
1340
            print "Warning: " + str(e)
803
1341
 
804
1342
def action_symlink(src, dst, dry):
805
1343
    """Creates a symlink in a given location. Creates all parent directories
835
1373
            | stat.S_ISUID | stat.S_IRUSR | stat.S_IWUSR)
836
1374
 
837
1375
def action_chmod_x(file, dry):
838
 
    """Chmod +xs a file (sets execute permission)."""
839
 
    print "chmod u+rwx", file
840
 
    if not dry:
841
 
        os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR)
 
1376
    """Chmod 755 a file (sets permissions to rwxr-xr-x)."""
 
1377
    print "chmod 755", file
 
1378
    if not dry:
 
1379
        os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
 
1380
            | stat.S_IXGRP | stat.S_IRGRP | stat.S_IXOTH | stat.S_IROTH)
 
1381
 
 
1382
 
 
1383
def action_chmod_w(file, dry):
 
1384
    """Chmod 777 a file (sets permissions to rwxrwxrwx)."""
 
1385
    print "chmod 777", file
 
1386
    if not dry:
 
1387
        os.chmod(file, stat.S_IXUSR | stat.S_IRUSR | stat.S_IWUSR
 
1388
            | stat.S_IXGRP | stat.S_IWGRP | stat.S_IRGRP | stat.S_IXOTH
 
1389
            | stat.S_IWOTH | stat.S_IROTH)
842
1390
 
843
1391
def query_user(default, prompt):
844
1392
    """Prompts the user for a string, which is read from a line of stdin.