ubc-lfs / greengene

Green Gene

Last updated: Aug 16th, 2023

Qualitative - Tested with PHP 8.1.2
Quantitative - Tested with PHP 8.1.2 (Ready to launch)

For a full description of what this project does and for instructions on using it, check out the user manual!

Installation

git clone https://github.com/UBC-LFS/greengene.git

Qualitative

Follow the Qualitative Set Up Guide

Note: This step can be skipped if a database already exist. All you need to do is create a config.php file manually inside Qualitative/includes using the config template and add the secret variables.

Add the following to Qualitative/includes/config.php for SSL to work

// SSL
define('SSL_KEY_PATH', 'FILE PATH TO client-key.pem');
define('SSL_CERTIFICATE_PATH', 'FILE PATH TO client-cert.pem');
define('SSL_CA_CERTIFICATE_PATH', 'FILE PATH TO ca-cert.pem');

Updating the super admin

UPDATE User SET PrivilegeLvl=10 WHERE UserId='YOUR CWL';

Updating the database (if a database previously existed) - Qualitative

If a database already exists from a previous version of greengene, the columns will need to be updated. Why? Previous versions of mysql automatically created a timestamp for us when creating a new data for certain columns + mysql updated the timestamp for us automatically when the data is modified. Newer versions of mysql require us to specify that we want it to be automatic

CONNECT <database name>;
ALTER TABLE StudentProblem MODIFY COLUMN ModificationDate TIMESTAMP DEFAULT CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP;
ALTER TABLE MasterProblem MODIFY COLUMN ModificationDate TIMESTAMP DEFAULT CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP;
ALTER TABLE `Cross` MODIFY COLUMN CreationDate TIMESTAMP DEFAULT CURRENT_TIMESTAMP;

Note: we must use `` for Cross because it's a reserved SQL keyword

Dev notes - Qualitative

Possible flaws:

• Students cannot be in more than 1 course (will say user already exist when adding the student)
• TAs or Profs cannot be in more than 1 course (will say user already exist when adding the TA or Prof)

Testing:

• To disable authentication, go to security.php line 36

Quantitative - xgene360

Dev notes - Quantitative

Run Quantitative/install.sh to set up the config file

Add the following to Quantitative/xgene360/includes/config.inc.php for SSL to work

// SSL
define('SSL_KEY_PATH', 'FILE PATH TO client-key.pem');
define('SSL_CERTIFICATE_PATH', 'FILE PATH TO client-cert.pem');
define('SSL_CA_CERTIFICATE_PATH', 'FILE PATH TO ca-cert.pem');

Testing:

• To disable authentication, go to loginmanager.class.php line 39

greengene's Issues

Allow users to be in +1 courses

Currently users can only be added to 1 course.

Students cannot be in more than 1 course (will say user already exist when adding the student)
TAs or Profs cannot be in more than 1 course (will say user already exist when adding the TA or Prof)