How to get a turnin enabled repository

First a user will need to visit Apply and create a subversion repository. After the repository has been created, the user can revisit Apply and tie the repository to one or more courses. This will turnin enable the subversion repository and a nightly process will automatically update the repository access_file and turnin folder structure.

Turnin

This page will contain a list of issues/questions that need to be addressed before moving forward with any changes to the Turnin process. I will need the ARC folks to update the information below with information from the Faculty.

Assumptions

Repository Layout

...

• SemesterCode is F, S, Su plus the last two digits of the year by default;

Constraints

• Repositories ARE tied to a full course (eg COMP412). This means ALL sections of a course are included for access to the repository.
• Repositories ARE NOT tied to specific sections of a course. There will be no support for having two sections of the same course with different turnin repositories.
• ALL users of a repository will retain access to the repository for up to 3 semesters
• Except for the Turnin managed access_file block, nothing else in the access_file is changed. The one exception to this, is that new (non-existing) permission blocks will will be added as new students are added to the repository.
• No data outside of the Turnin managed access_file block is ever deleted automatically.
• No user permission blocks in the access file or repository folders for a user are ever deleted by the automatic processing.
• Several times a year the automatic process will update the Turnin managed access_file block, removing old groups and adding new ones. The dates that these changes occur need to be specified. Or it needs to be understood that this will happen when the new semester's groups are created.
• The access file will be much more structured to allow for managed and unmanaged permissions. Breaking the functionality of turnin by corrupting the access file is possible. Fixing broken access files, is best effort or business hours.

• Wiki Markup

  Each permission block in the access_file must retain the block special tag. This means that when the turnin process writes out a new permission block *\[/turnin/netid\]* it will tag this block with *## Turnin User: netid ###*, it expects to find this same tag in the access_file the next time it looks. If it doesn't, it will re-create the permission block. The contents of the permission block can be managed as the user sees fit. Only the tag is important to keep the automatic process from re-creating it.

• Once a permission block has been written to the access_file it will no longer be managed. This means that you can change the permissions to anything you wish and they will carry forward.
• These repositories will grow without bound.

Usage

• Create a repository 'courseXXX'
• Mark this as a turnin capable repository and assign it to a specific course by subject and course number, eg COMP 412.
• The automatic turnin process will then use the members of the course as defined in Grouper to do the following:
  • Scan the access file for permission block tags, for any users that should exist in the repository but for which there is no tag
    • Create the user folder /turnin/netid within the repository
    • Create a permissions block in the access file for the user folder

Questions

• How do they expect to handle instances where
  • A course repository was setup for a course and now two instructors are teaching two different sections of the course

Examples

Current access_file

[/]
evc1 = rw

[/rice_config]
evc1 = rw
* =

[/course]
@general.IT.ARC.custom.turnin_admin = rw
@auto.courses.COMP422.Sp10.001.instructor = rw
@auto.courses.COMP422.Sp10.001.TA = rw
@auto.courses.COMP422.Sp10.001.student = r
* = 

[/turnin]
@general.IT.ARC.custom.turnin_admin = rw
@auto.courses.COMP422.Sp10.001.instructor = rw
@auto.courses.COMP422.Sp10.001.TA = rw
@auto.courses.COMP422.Sp10.001.student = r
* = 

[/turnin/jmm8]
@general.IT.ARC.custom.turnin_admin = rw
@auto.courses.COMP422.Sp10.001.instructor = rw
@auto.courses.COMP422.Sp10.001.TA = rw
jmm8 = rw
* = 

[/turnin/kgs1]
@general.IT.ARC.custom.turnin_admin = rw
@auto.courses.COMP422.Sp10.001.instructor = rw
@auto.courses.COMP422.Sp10.001.TA = rw
kgs1 = rw
* = 

[/turnin/xl10]
@general.IT.ARC.custom.turnin_admin = rw
@auto.courses.COMP422.Sp10.001.instructor = rw
@auto.courses.COMP422.Sp10.001.TA = rw
xl10 = rw
* = 

[/turnin/cy6]
@general.IT.ARC.custom.turnin_admin = rw
@auto.courses.COMP422.Sp10.001.instructor = rw
@auto.courses.COMP422.Sp10.001.TA = rw
cy6 = rw
* = 

[/turnin/chase]
@general.IT.ARC.custom.turnin_admin = rw
@auto.courses.COMP422.Sp10.001.instructor = rw
@auto.courses.COMP422.Sp10.001.TA = rw
chase = rw
* = 

[/turnin/smi1]
@general.IT.ARC.custom.turnin_admin = rw
@auto.courses.COMP422.Sp10.001.instructor = rw
@auto.courses.COMP422.Sp10.001.TA = rw
smi1 = rw
* = 

[/turnin/yy9]
@general.IT.ARC.custom.turnin_admin = rw
@auto.courses.COMP422.Sp10.001.instructor = rw
@auto.courses.COMP422.Sp10.001.TA = rw
yy9 = rw
* = 

[/turnin/dbryant]
@general.IT.ARC.custom.turnin_admin = rw
@auto.courses.COMP422.Sp10.001.instructor = rw
@auto.courses.COMP422.Sp10.001.TA = rw
dbryant = rw
* = 

[/turnin/cja3]
@general.IT.ARC.custom.turnin_admin = rw
@auto.courses.COMP422.Sp10.001.instructor = rw
@auto.courses.COMP422.Sp10.001.TA = rw
cja3 = rw
* = 

[/turnin/ces2]
@general.IT.ARC.custom.turnin_admin = rw
@auto.courses.COMP422.Sp10.001.instructor = rw
@auto.courses.COMP422.Sp10.001.TA = rw
ces2 = rw
* = 

[/turnin/nbh1]
@general.IT.ARC.custom.turnin_admin = rw
@auto.courses.COMP422.Sp10.001.instructor = rw
@auto.courses.COMP422.Sp10.001.TA = rw
nbh1 = rw
* = 

[/turnin/xxxtuu1]
@general.IT.ARC.custom.turnin_admin = rw
@auto.courses.COMP422.Sp10.001.instructor = rw
@auto.courses.COMP422.Sp10.001.TA = rw
xxxtuu1 = rw
* = 

[/turnin/xxxtgu1]
@general.IT.ARC.custom.turnin_admin = rw
@auto.courses.COMP422.Sp10.001.instructor = rw
@auto.courses.COMP422.Sp10.001.TA = rw
xxxtgu1 = rw
* = 

[/turnin/xxxtuu2]
@general.IT.ARC.custom.turnin_admin = rw
@auto.courses.COMP422.Sp10.001.instructor = rw
@auto.courses.COMP422.Sp10.001.TA = rw
xxxtuu2 = rw
* = 

[/turnin/xxxtgu2]
@general.IT.ARC.custom.turnin_admin = rw
@auto.courses.COMP422.Sp10.001.instructor = rw
@auto.courses.COMP422.Sp10.001.TA = rw
xxxtgu2 = rw
* = 

...

• a minimum of 3 semesters; Currently implemented as three active semesters that the course is taught. If the course is only taught in the Fall of each year, then the full repository would be accessible by a user for 3 years. If the course is taught every semester, then the repository would be fully accessible for a year. On the 4th active semester, the oldest semester will be dropped from general access to the repository. This means that students will no longer be able to access any repository folders protected by the student group. However, until the student data is removed or they lose access to their netId, they will retain read/write access to their specific turnin folder.
• Except for the one small controlled section of the access_file, all other user changes to the access_file should be carried forward.
• The one exception to user changes being carried forward is that user permission blocks for active users can not be deleted by the user without them coming back automatically the next time the automatic process run.

Data changes controlled by the automatic turnin process

• Repository data will never be deleted
• General access to the repository will be controlled by updating the access_file turnin group list. The section of the access_file that is rewritten will be surrounded by comments and user changes are not allowed.
• As new semesters (and students) are cycled into the turnin group list, the permission blocks for these new semesters and students will be added to the access_file.
• As new semesters (and students) are cycled into the turnin group list, new repository folders will be added for the semesters and students.
• The access_file turnin group list will be updated when new course groups are automatically created within Grouper. This means that a new semester may force an old semester out of the turnin group list before any new students have been added to the new course group.

Enhancements

• I've added a special comment to the access file that will allow the owner of the repository to turn OFF the automatic processing of the access_file and repository. When the automatic process sees this comment, it will abort any changes to this repository and will move to the next repository.

  Code Block
  ### TURNIN AUTOMATIC PROCESSING: OFF

access_file format

[groups]

### TURNIN MAINTAINED VALUES: BEGIN ###
### DO NOT CHANGE ANYTHING BETWEEN THESE TAGS ###
turnin_admin =      @general.IT.ARC.custom.turnin_admin
turnin_instructor = @auto.courses.COMP422.Fa10.instructor, \
                    @auto.courses.COMP422.Sp10.instructor, \
                    @auto.courses.COMP422.Fa11.instructor
turnin_ta =         @auto.courses.COMP422.Fa10.TA, \
                    @auto.courses.COMP422.Sp10.TA, \
                    @auto.courses.COMP422.Fa11.TA
turnin_student =    @auto.courses.COMP422.Sp10.student, \
                    @auto.courses.COMP422.Sp10.student, \
                    @auto.courses.COMP422.Sp10.student
turnin_test_student = xxxtuu1,xxxtgu1,xxxtuu2,xxxtgu2
### TURNIN MAINTAINED VALUES: END ###

admin =      @turnin_admin
instructor = @turnin_instructor
ta =         @turnin_ta
student =    @turnin_student,@turnin_test_student

[/]
@admin = rw
@instructor = rw
@ta = rw
@student = r

[/rice_config]
@admin = rw
@instructor = rw
@ta = rw
* =

[/course]
@admin = rw
@instructor = rw
@ta = rw
@student = r
* = 

[/turninstaff]
@admin = rw
@instructor = rw
@ta = rw
@student = rtw
* = 

## Turnin User: jmm8 ##
[/turnin/jmm8]
@admin = rw
@instructor = rw
@ta = rw
jmm8@student = rwr
* = 

## Turnin User: kgs1 ##
[/turnin/kgs1F10/netId1]
@admin = rw
@instructor = rw
@ta = rw
kgs1netId1 = rw
* = 

## Turnin User: xl10 ##
[/turnin/xl10F10/netId2]
@admin = rw
@instructor = rw
@ta = rw
xl10netId2 = rw
* = 

## Turnin User: cy6 ##...

[/turnin/S10/cy6netId1]
@admin = rw
@instructor = rw
@ta = rw
cy6netId1 = rw
* = 

## Turnin User: chase ##
[/turnin/chaseS10/netId2]
@admin = rw
@instructor = rw
@ta = rw
chasenetId2 = rw
* = 

## Turnin User: smi1 ##... 

[/turnin/smi1]
@admin = rw
@instructor = rw
@ta = rw
smi1 = rw
* = 

## Turnin User: yy9 ##
[/turnin/yy9F11/netId1]
@admin = rw
@instructor = rw
@ta = rw
yy9netId1 = rw
* = 

## Turnin User: dbryant ##
[/turnin/dbryant]
@admin = rw
@instructor = rw
@ta = rw
dbryant = rw
* = 

## Turnin User: cja3 ##
[/turnin/cja3F11/netId2]
@admin = rw
@instructor = rw
@ta = rw
cja3netId2 = rw
* = 

## Turnin User: ces2 ##
[/turnin/ces2]
@admin = rw
@instructor = rw
@ta = rw
ces2 = rw
* = 

## Turnin User: nbh1 ##
[/turnin/nbh1]
@admin = rw
@instructor = rw
@ta = rw
nbh1 = rw
* = 

## Turnin User: xxtuu1 ##
[/turnin...

[/turnin/test/xxxtuu1]
@admin = rw
@instructor = rw
@ta = rw
xxxtuu1 = rw
* = 

## Turnin User: xxxtgu1 ##
[/turnin/test/xxxtgu1]
@admin = rw
@instructor = rw
@ta = rw
xxxtgu1 = rw
* = 

## Turnin User: xxxtuu2 ##
[/turnin/test/xxxtuu2]
@admin = rw
@instructor = rw
@ta = rw
xxxtuu2 = rw
* = 

## Turnin User: xxxtgu2 ##
[/turnin/test/xxxtgu2]
@admin = rw
@instructor = rw
@ta = rw
xxxtgu2 = rw
* =