ucrcsedept / galah Goto Github PK

This would save a lot of disk space. Would have to be careful if the submissions need to still be accessible after archiving.

No error message occurs. Just indefinite hanging.

This disallows using the uwsgi server. Very big problem.

Assignments should be able to specify a due date and a disable date (a different name might be more appropriate). After the disable date passes the "Mark for grading" option should be grayed out in the submission page.

This should be considered an essential feature as students will have no idea if they uploaded there submission correctly and mayhem will ensue.

The base template should be patched so any flashed messages will be shown at the top of the page. There should be color coding based on categories (the two used categories right now are error and message).

The Python shell can be used to do this by importing galah.db.admin and setting up the environment for command help and then tossing the user into the shell. A bit of a gimmick but could be very useful and convenient.

web.py is annoying to work with and has forced a lot of unmanageable, repeated code. The sooner the switch is made the less headaches will occur.

If you don't want to use it as the developer, why would a user want to use it? Make it as pleasant as possible to use. Some points...

• Make it as simple as possible to list classes and assignments and whatnot. (done in 64995b7 and d8ae004)
• Figure out how to add bash tab completion for commands, likely just need to modify some configuration files and then distribute them with the api_client (done in d8ae004)
• Get the documentation all set to automatically generate, it's already written, just needs to be converted into a pretty format (done in 568f03b and 306681f)
• Set it up so you don't need to invoke the python interpreter manually. The env program may help with that (don't understand what it does yet but I've seen a number of scripts take advantage of it) (done in 64995b7)
• Make it easier to set up authentication. Using files may be a good addition to the environmental variables as a simple option (.galah directory in the home directory should do it) (done in 64995b7)
• Clean up get_archive, that function is very unpleasant to use and it's the most important. (done in d12cd3f)

After a final due date submissions would no longer be accepted for an assignment, despite the fact that it might be passed the regular due date.

To implement there will be a few things you have to do:

• Add a field for the final due date into the assignments model.
• Show the final due date on the web interface somewhere so students know what it is.
• Have the assignment view check if it's past the final due and then display a message rather than the submission box if it is AND have the uplioad_submission backend view check if its past the final due date and deny submissions (a log should also be made of the submission so the user can be confronted if they are trying to hack past the system).

Difficulty has been encountered when running an instance of galah.web:

• Import errors have been popping up because it has been difficult to have easy_install set up the path perfectly (apparently my imports are very finicky, this may require editing a number of files in galah.web and galah.db)
• I've got it running without "errors" but then the server won't server any pages. It will say an internal error occurred every time and provide no output to the terminal minus the normal record of requests.

I will likely do a rebase after I get it working as there are a log of extraneous commits.

Recommended: replace default file input with single large button and preferably make it so that the student doesn't have to hit submit, it just automatically submits it.

If a user goes to an assignment page that is valid (as in the assignment id is correctly parsed by the web server) but does not actually exist in the database, they are met with an internal error message.

Example here.

I do not know for sure if this is desirable, but it seems FreeBSD jails will be much quicker to initialize and tear down and look like they may provide the same level of security.

This is not something to work on until version 1.0 is released.

The layout of the resulting directory structure should be highly customizable to accommodate the TAs need for a very particular file structure for their scripts. They will find galah an inconvenience if this cannot be done.

Likely impelmentation will be to allow a path to be entered with variables that will be expanded when creating the directory. For example: ~/submissions/$class/$assignment/$student/$submission_time/. This will provide a high level of customization while still not making my life very difficult.

The message "Only student users are permitted to access this page." should be flashed as an error so it shows up as red for the user. Consistency is very important for understanding here.

The submission should still show up in the list of submissions on the assignment page.

This is more a whoops moment then anything else. Add a logout view so users can log out.

Automatically installing packages from yum or apt-get my or may not be possible. Should be tried either way.

Default configuration files should also be added (/etc/galah/web.config and /etc/nginx/conf.d/galah.conf).

Currently the dropdown button in the browse assignments view is useless. That needs to change.

• I'm trying to create a new API config file for my new system and I'm having to look through the source code for the api_client. Not good. (fixed in 306681f)
• Creating the first admin user is undocumented (I had to enter a python shell on the local system and call the api command directly with the admin_user user) (fixed in f131c34, also updated Administrative Guide)
• Not all of the directories listed need to be created, and some that need to be created are not listed. (fixed)
• Setting up Google API keys needs to be documented. (wiki has been updated)
• I need to go into minute detail on how to set up HTTPS with nginx. (done)
• The configuration system has been changed since sisyphus was added. (done)

This will only be enabled when the testing backend is enabled.

• Set a fixed number of attemtps per hour.
• Add a randomized delay.
• Don't allow login attempts too close together.

plupload seems to be a good javascript tool for this purpose. The default styling with some color tweaks should integrate well into galah as well.

I forgot to make not of this elsewhere... I scrapped the CLI I created before for this because it wan't very user friendly, this will have to be corrected.

Most important configuration option is logging.

Documentation should fully cover all the steps needed to get galah-web working from a minimal CentOS install.

YUI is making too many requests to the server and will lower the capacity of the server too much.

This one is a big bug, user's will be confronted with an internal error screen if they put in the wrong email.

Current contenders are Pyramid Web Framework and CherryPy with CherryPy in the lead.

The reasoning for this is that web.py is so untested, so raw, so "new," and frankly, so lacking in features galah-web needs continuing to develop with it is irresponsible of me.

Currently if the number of submissions or classes grows massive they will still be displayed in a single page. The slowdown should grow linearly with the number of assignments/classes so this isn't vital, but needs to be addressed.

AJAX pagination features are usually pretty clunky, I haven't seen good ones besides github's (and I'm not even sure they use AJAX) so just do it the old fashioned way.

During the move to flask a good portion of the CSS stylesheet broke. It needs to be fixed.

It may be prudent to use the LessCSS (with the flask-lesscss extension) in order to speed up the fixing process and make it easier to change in the future.

Something simple should be fine. Curently the user has no feedback that their checkbox selection did anything.

With the configuration changes added to the last release the convenient script run_server.py no longer correctly handles configuration. There should be a way for it to override the configuration and put things into a debug, development friendly mode.

The instructor API should be accessible through the command line. Possible implementations include but are not implemented to a collection of scripts, a single script with many arguments, or a custom shell.

The following commands must be supported.

• Download all submissions for a given assignment.
  • Can be based on date range or get the latest "mark for grading" submissions.
• Create and configure assignment.
  • Includes ability to upload test drivers.

Leverage the new flashing infrastructure to add this simply and easily. Otherwise, if flashing is impractical the error logic should already be in the template, something subtle and devious is likely at work.

"development key" is not a very good secret. Possible implementations:

• Generate a new one from /dev/random every time the application reboots. This would wipe all current sessions however.
• Generate a new one at application start if one doesn't already exist in some file. That way it could selectively be cleared.

The Flash Effect per Yahoo's UI Design Patterns is essentially a way to emphasize when something new has been added to the page. This will be useful to make sure users see flashed messages.

This should also be used in the submissions page to show the user their upload.

Perhaps, "You have no assignments assigned to you."

Students should be able to upload files that aren't tarred, they should be able to upload multiple files, basically, the advanced uploader from before needs to be brought back in some form and the user should be presented with some options as far as uploading goes.

Fancy javascript effects like progress bars and what not are not necessary, though if it's simple like it was before, it may be a good idea.

While this is being done, the code responsible for uncompressing student's tar files and generally that entire block of submission code should be overhauled a little bit. In its current state it is hardly working, and almost impossible to maintain.

Get it set up to the point where enabling/disabling HTTPS is as simple as switching a flag in a config file.

It's very ugly right now. The upload section(s) should be in "action blocks" then the submissions should be organized underneath in a prettier way than they are currently.

There should be no dependency on ZeroMQ when installed like this. In this state Galah should act exactly like a simple submission system, no testing will be performed.

Reasoning: Organizations, UCR in particular, will likely not be ready to invest the large amount of time required to create Galah-compatible Test Drivers for all of their assignments without knowing whether Galah will even work for them or if they have the resources to host a web server that will deal with the load that Galah will. Therefore this will provide a "soft entrance" of sorts so they can evaluate Galah.

Some organizations may not have need for Galah's testing capabilities as well and would like to solely use it as a submission system with no plans to add on the testing back end. This should be officially supported as doing so will expand the target market.

This would save a lot of disk space. Would have to be careful if the submissions need to still be accessible after archiving.

Nothing fancy is required but something beyond their browsers handling of the various HTTP error codes.