UDOIT Developer Guide

Installing and developing on UDOIT is actually quite easy, below is the documentation to help you get started!

License

Please see UDOIT_Release.pdf (distributed with the source code) for more information about licensing.

UDOIT

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Primary Author Contact: Jacob Bates jacob.bates@ucf.edu

Quail

UDOIT uses the QUAIL PHP library, which has been heavily customized to suit the needs of UDOIT. This library requires distribution of tools developed with their library under the GNU General Public License version 3

Installing

UDOIT uses php, apache or nginx, and mysql or postresql. For instructions on installing to Heroku, view HEROKU.md. We also support instantly deploying UDOIT:

System Requirements

PHP 5.4 is required to run UDOIT without any modifications. UDOIT is now compatible with PHP 5.6. Also, some users have been able to modify the code to work on 5.3.

If you're using PHP 5.3:

Convert all empty array initializations from using the newer [] syntax to use the older array() syntax.
If you have short_open_tag disabled, you'll need to change all <?= to <?php echo

Bower Dependencies

Bower is used to install external JavaScript Dependencies. Composer automatically runs Bower during install in the next step, so install Bower before continuing.

Currently there is only one bower library installed. You can also install manually by placing JSColor library contents in assets/js/vendor/JSColor/.

Composer Dependencies

UDOIT uses Composer to manage its dependencies, so cd into your UDOIT directory and run this command before anything else:

$ php composer.phar install

The libraries (other then Quail) that we rely on:

Please refer to the documentation for these three libraries for additional information.

File Storage

Make sure the reports directory in the root of UDOIT is writable by your webserver. UDOIT saves generated reports here for easy retrieval. You may have to change the user, group, or permissions to get this working (sorry we can't be more specific, it varies greatly depending on your environment).

Database Setup

There are only two tables required to run UDOIT. They are:

Reports Table

/* mysql */
CREATE TABLE `reports` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `user_id` int(10) unsigned NOT NULL,
  `course_id` int(10) unsigned NOT NULL,
  `file_path` text NOT NULL,
  `date_run` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  `errors` int(10) unsigned NOT NULL,
  `suggestions` int(10) unsigned NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1;

/* postgresql */
CREATE TABLE reports (
  id SERIAL PRIMARY KEY,
  user_id integer,
  course_id integer,
  file_path text,
  date_run bigint,
  errors integer,
  suggestions integer
);

Users Table

/* mysql */
CREATE TABLE `users` (
  `id` int(10) unsigned NOT NULL,
  `api_key` varchar(255) NOT NULL,
  `date_created` date NOT NULL,
  PRIMARY KEY (`id`),
  UNIQUE KEY `id` (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1;

/* postgresql */
CREATE TABLE users (
  id integer CONSTRAINT users_pk PRIMARY KEY,
  api_key varchar(255),
  date_created integer
);

Configuration

Make a copy of config/localConfig.template.php, rename it to localConfig.php.

Canvas API

Please refer to the Canvas API Policy before using this application, as it makes heavy use of the Canvas API.

$consumer_key: A consumer key you make up. Used when installing the LTI in Canvas.
$shared_secret: The shared secret you make up. Used when installing the LTI in Canvas.

Canvas Oauth2

UDOIT uses Oauth2 to take actions on behalf of the user, you'll need to sign up for a developer key

$oauth2_id: The Client_ID Instructure gives you
$oauth2_key: The Secret Instructure gives you
$oauth2_uri: The "Oauth2 Redirect URI" you provided instructure. This is the URI of the oauth2response.php file in the UDOIT directory.

Database Config

These value of these vars should be obvious:

$db_host
$db_url
$db_password
$db_name
$db_user_table
$db_reports_table

Installing the LTI in Canvas

Under Configuration Type, choose By URL.
In the Name field, type UDOIT.
In the Consumer Key field, copy the value from $consumer_key in your config file
In the Shared Secret field, copy the value from $shared_secret in your config file
In the Config URL field, input the URL that points to udoit.xml.php.
Click Submit.

The Udoit class

File: lib/Udoit.php

This is the class which will scan a Canvas course's content and a return a UDOIT report if any problems are found.

Properties

See class definition

Methods

buildReport()

Iterates through selected content types to build the final report object.

generateReport()

This calls the Quail library to scan HTML and check it for accessibility problems.

getCourseContent()

Makes API calls to Canvas and retrieves HTML and other data from selected content types.

parseLinks()

Increments the current page number for either Files or Pages in the event that their results are paginated.

The Ufixit class

File: lib/Ufixit.php

This is the class which will fix problem content and upload it to a Canvas course.

Properties

See class definition

Methods

fixAltText()

Adds the alt text value to the image that's missing it.

fixCss()

Replaces the old color/background value with the one chosen by the user.

fixTableHeaders()

Converts the first row, first column, or both into th elements - It gives them the proper scope value as well.

fixTableThScopes()

Adds the col or row attribute to any th elements without them.

getFile()

Gets a file from a Canvas course based on the $start_id parameter.

renameElement()

Renames an element to whatever name is specified in the $name parameter.

uploadFixedAssignments()

Fixes the HTML within assignments and uploads it back to the Canvas course.

uploadFixedDiscussions()

Fixes the HTML within discussions and announcements - they are of the same content type - and uploads it back to the Canvas course.

uploadFixedFiles()

Creates a temporary file, fixes the HTML within it, then uploads it back to the Canvas course.

uploadFixedPages()

Fixes the HTML within pages and uploads it back to the Canvas course.

uploadFixedSyllabus()

Fixes the HTML within the syllabus and uploads it back to the Canvas course.

Lib files

All of these files are located within the /lib directory.

cached.php

This file is called when clicking the "View Old Reports" tab. It connects to the database using PDO, selects reports matching the course id, and outputs a table with the data.

parseResults.php

This file decodes a a UDOIT report either from a JSON file or a JSON string (if not viewing a cached report). Then, the report HTML is echoed to be displayed to the user.

parsePdf.php

This creates a PDF from the HTML of a UDOIT scan and allows the user to download it.

process.php

The file is where all the magic happens, so to speak.

progress.php

Increments a progress key in the global $_SESSION variable that some AJAX in default.js talks to in order to track the progress of a UDOIT scan.

Contributors

Jacob Bates
Eric Colon
Fenel Joseph
Emily Sachs
Karen Tinsley-Kim
Joe Fauvel
John Raible
Kathleen Bastedo
Nancy Swenson

fyonekur/UDOIT

UDOIT Developer Guide

License

UDOIT

Quail

Installing

System Requirements

Bower Dependencies

Composer Dependencies

File Storage

Database Setup

Reports Table

Users Table

Configuration

Canvas API

Canvas Oauth2

Database Config

Installing the LTI in Canvas

The Udoit class

Properties

Methods

buildReport()

generateReport()

getCourseContent()

parseLinks()

The Ufixit class

Properties

Methods

fixAltText()

fixCss()

fixTableHeaders()

fixTableThScopes()

getFile()

renameElement()

uploadFixedAssignments()

uploadFixedDiscussions()

uploadFixedFiles()

uploadFixedPages()

uploadFixedSyllabus()

Lib files

cached.php

parseResults.php

parsePdf.php

process.php

progress.php

Contributors