Merge pull request #399 from ucfopen/dev/v2-4-0

Releasing version 2.4.0

Author: bagofarms

.gitignore

@@ -14,6 +14,6 @@ assets/js/vendor/
 
 config/log.log
 
-docker/nginx.conf
-docker/nginx.crt
-docker/nginx.key
+docker/etc/nginx/nginx.conf
+docker/var/ssl/nginx.crt
+docker/var/ssl/nginx.key

DOCKER.md

@@ -28,13 +28,13 @@ $ docker-machine ip udoit
 
 ### NGINX Configuration
 
-If `docker/nginx.conf` doesn't exist, create it using a copy of the template:
+If `docker/etc/nginx/nginx.conf` doesn't exist, create it using a copy of the template:
 
 ```
-$ cp docker/nginx.template.conf docker/nginx.conf
+$ cp docker/etc/nginx/nginx.template.conf docker/etc/nginx/nginx.conf
 ```
 
-Edit `docker/nginx.conf`' to point to the UDOIT docker-machine's IP address by replacing both instances of
+Edit `docker/etc/nginx/nginx.conf`' to point to the UDOIT docker-machine's IP address by replacing both instances of
 
 ```
 localhost
@@ -49,7 +49,7 @@ with
 Generate SSL certificates according to the naming scheme located in the nginx.conf file (`nginx.key` and `nginx.crt`) or use your own SSL certificates:
 
 ```
-$ sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout docker/nginx.key -out docker/nginx.crt
+$ sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout docker/var/ssl/nginx.key -out docker/var/ssl/nginx.crt
 ```
 
 ## Start Services using Docker-Compose

README.md

@@ -164,15 +164,19 @@ In order for UDOIT to scan YouTube videos for closed captioning, you will need t
 4. Create an ***API key*** credential.
 5. Add the key to `config/localConfig.php` in the `define('GOOGLE_API_KEY', '');` statement.  For example, if your API key is `heythisisanapikey`, that line should look like `define('GOOGLE_API_KEY', 'heythisisanapikey');` when you're done.
 
+If you do not provide a Google API key, a warning log will be recorded in `config/log.log` and all YouTube videos will be marked for manual inspection by the user.
+
 ### Vimeo API Key
 In order for UDOIT to scan Vimeo videos for closed captioning, you will need to create a Vimeo API key. Follow the instructions below:
 
 1. [Create a new App on Vimeo Developer API](https://developer.vimeo.com/apps/new?source=getting-started), please note you must have a Vimeo Developer account.
 2. On your applications "Authentication" page, Generate a new Access Token.  (Select the `Public` and `Private` checkboxes for Scopes.)
 3. Add the key to `config/localConfig.php` in the `define('VIMEO_API_KEY', '');` statement.  For example, if your API key is `heythisisanapikey`, that line should look like `define('VIMEO_API_KEY', 'heythisisanapikey');` when you're done.
 
+If you do not provide a Vimeo API key, a warning log will be recorded in `config/log.log` and all Vimeo videos will be marked for manual inspection by the user.
+
 ### Google Analytics
-If you would like to use Google Analytics for tracking usage of UDOIT, create a new tracking code and add it to `config/localConfig.php` in the `define('GA_TRACKING_CODE', '');` statement.  For example, if your tracking code is `UA-12345678-1`, that line should look like `define('GA_TRACKING_CODE, 'UA-12345678-1');` when you're done.
+If you would like to use Google Analytics for tracking usage of UDOIT, create a new tracking code and add it to `config/localConfig.php` in the `define('GA_TRACKING_CODE', '');` statement.  For example, if your tracking code is `UA-12345678-1`, that line should look like `define('GA_TRACKING_CODE', 'UA-12345678-1');` when you're done.
 
 ### Installing the LTI in Canvas
 Log into Canvas to add UDOIT:
@@ -191,10 +195,10 @@ Log into Canvas to add UDOIT:
 #### LTI Config URL Notes
 The URL of your UDOIT LTI config depends on your webserver install.  The file is located the `public` directory. The examples below should give you are some possible values:
 
-* `http://<DOMAIN>/udoit.xml.php`
-* `http://<DOMAIN>/public/udoit.xml.php`
-* `http://<DOMAIN>/udoit/udoit.xml.php`
-* `http://<DOMAIN>/udoit/public/udoit.xml.php`
+* `https://<DOMAIN>/udoit.xml.php`
+* `https://<DOMAIN>/public/udoit.xml.php`
+* `https://<DOMAIN>/udoit/udoit.xml.php`
+* `https://<DOMAIN>/udoit/public/udoit.xml.php`
 
 ## Upgrading UDOIT
 The instructions below are general guidelines for upgrading your installation of UDOIT from one version to the next.  However, the release notes for a particular version might contain specific instructions for that version, and those instructions supersede the ones below.  Since the instructions differ depending on how you installed UDOIT, they are separated by these methods below.
@@ -247,6 +251,12 @@ If database migrations fail, make sure the database user has the ability to alte
 
 ## FAQs
 
+### How do I get in touch with you if I have questions?
+There are a few different ways you can get in touch with us, depending on what you're most comfortable with:
+* [Canvas Community](https://community.canvaslms.com/groups/accessibility) - The easiest option is to comment on the blog post for your version of UDOIT.
+* [Slack](https://ucf-open-slackin.herokuapp.com/) - We have channels for all of our open source projects, including UDOIT.
+* Email - If you're more comfortable with email, you can contact me directly at [jacob.bates@ucf.edu](mailto:jacob.bates@ucf.edu).
+
 ### How much time will I have to spend maintaining UDOIT?
 UDOIT should require little to no maintenance. It is up to your institution to choose when you update UDOIT to the latest release. UDOIT can be updated by running `git pull` on this repository.
 

config/settings.php

@@ -2,7 +2,8 @@
 define('ENV_TEST', 'test');
 define('ENV_PROD', 'prod');
 define('ENV_DEV', 'dev');
-define('UDOIT_VERSION', '2.3.5');
+
+define('UDOIT_VERSION', '2.4.0');
 
 // SET UP AUTOLOADER (uses autoload rules from composer)
 require_once(__DIR__.'/../vendor/autoload.php');

docker-compose.yml

@@ -1,17 +1,16 @@
 version: '3.3'
 
 services:
-  web:
+  nginx:
     image: nginx:stable-alpine
     volumes:
-        - ./docker/nginx.conf:/etc/nginx/nginx.conf
-        - ./docker/nginx.crt:/var/ssl/nginx.crt
-        - ./docker/nginx.key:/var/ssl/nginx.key
+        - ./docker/etc/nginx:/etc/nginx
+        - ./docker/var/ssl:/var/ssl
         - .:/var/www/html
     ports:
         - "80:80"
         - "443:443"
-  db:
+  mysql:
     image: mysql:latest
     volumes:
       - dbdata:/var/lib/mysql

docker/nginx.template.conf docker/etc/nginx/nginx.template.confdocker/nginx.template.conf renamed to docker/etc/nginx/nginx.template.conf

@@ -132,6 +132,7 @@ public static function scanContent(array $content_items)
             $errors      = [];
             $warnings    = [];
             $suggestions = [];
+            $state       = null;
 
             // loop over the items returning from Quail
             foreach ($quail_report['report'] as $quail_issue) {
@@ -140,6 +141,8 @@ public static function scanContent(array $content_items)
                 }
 
                 $issue_count++;
+                $state = $quail_issue['state'];
+                //error_log("state in the issue is set as ".serialize($state));
 
                 switch ((int) $quail_issue['severity_num']) {
                     case 1:

lib/Udoit.php

@@ -2,7 +2,7 @@
 
 // include_once('../config/localConfig.php');
 
-/** 
+/**
 *    QUAIL - QUAIL Accessibility Information Library
 *    Copyright (C) 2009 Kevin Miller
 *
@@ -1106,7 +1106,7 @@ function check()
 	}
 }
 
-/** 
+/**
 * Test counts words for all text elements on page and suggests content chunking for pages longer than 3000 words.
 */
 class contentTooLong extends quailTest
@@ -1241,7 +1241,7 @@ function check()
 
 					if (isset($style['font-weight'])) {
 						preg_match_all('!\d+!', $style['font-weight'], $matches);
-						
+
 						if (count($matches) > 0) {
 							if ($matches >= 700) {
 								$bold = true;
@@ -1361,7 +1361,7 @@ function check()
 
 				if (isset($style['font-weight'])) {
 					preg_match_all('!\d+!', $style['font-weight'], $matches);
-					
+
 					if (count($matches) > 0) {
 						if ($matches >= 700) {
 							$bold = true;
@@ -1371,7 +1371,14 @@ function check()
 							}
 						}
 					}
-				} else if ($element->tagName === "strong") {
+				} else if ($element->tagName === "strong"
+					|| $this->getElementAncestor($element, 'strong')
+					|| (isset($element->nodeValue)
+						&& isset($element->firstChild->nodeValue)
+						&& $element->nodeValue == $element->firstChild->nodeValue
+						&& is_object($element->firstChild)
+						&& property_exists($element->firstChild, 'tagName')
+						&& $element->firstChild->tagName === 'strong')) {
 					$bold = true;
 					$style['font-weight'] = "bold";
 				} else {
@@ -2991,7 +2998,7 @@ class noHeadings extends quailTest
 	function check()
 	{
 		global $doc_length;
-		
+
 		$elements = $this->getAllElements('p');
 
 		$document_string = "";
@@ -6349,20 +6356,27 @@ function check()
 }
 
 /**
-*	HTML5 video tags have captions. There's unfortunately no way to test for captions yet...
+*	HTML5 video tags have captions.
 *	@link http://quail-lib.org/test-info/videoProvidesCaptions
 */
-class videoProvidesCaptions extends quailTagTest
+class videoProvidesCaptions extends quailTest
 {
 	/**
 	*	@var int $default_severity The default severity code for this test.
 	*/
-	var $default_severity = QUAIL_TEST_SUGGESTION;
+	var $default_severity = QUAIL_TEST_SEVERE;
 
 	/**
-	*	@var string $tag The tag this test will fire on
+	*	The main check function. This is called by the parent class to actually check content
 	*/
-	var $tag = 'video';
+	function check()
+	{
+		foreach ($this->getAllElements(array('video')) as $video) {
+			if (!$this->elementHasChild($video, 'track')) {
+				$this->addReport($video);
+			}
+		}
+	}
 }
 
 /**
@@ -6403,8 +6417,11 @@ function check()
 				elseif ( preg_match($search_vimeo, $attr_val) ) {
 					$service = 'vimeo';
 				}
-				if (isset($service) && $this->services[$service]->captionsMissing($attr_val)) {
-					$this->addReport($video);
+				if (isset($service)) {
+					$captionState = $this->services[$service]->captionsMissing($attr_val);
+					if($captionState != 2) {
+						$this->addReport($video, null, null, $captionState, ($captionState == 1));
+					}
 				}
 			}
 		}

lib/quail/quail/common/accessibility_tests.php

@@ -12,12 +12,9 @@
 class vimeoService extends mediaService
 {
 	/**
-	*	@var array An array of regular expressions to extract the Vimeo item code
+	*	@var string A regular expression to extract the Vimeo item code
 	*/
-	var $regex = array(
-		'@vimeo\.com/video/([^"\&\? ]+)@i', 
-		'@vimeo\.com/([^"\&\? ]+)@i',
-		);
+	var $regex = '@vimeo\.com/[^0-9]*([0-9]{7,9})@i';
 
 	/**
 	*	@var string The service point to request caption data from Vimeo
@@ -27,25 +24,33 @@ class vimeoService extends mediaService
 	/**
 	*	Checks to see if a video is missing caption information in Vimeo
 	*	@param string $link_url The URL to the video or video resource
-	*	@return bool TRUE if captions are missing, FALSE if captions exists
+	*   @return int 0 if captions are missing, 1 if video is private, 2 if captions exist or not a video
 	*/
 	function captionsMissing($link_url)
 	{
 		$url = $this->search_url;
 		$api_key = constant( 'VIMEO_API_KEY' );
 
+		// If the API key is blank, flag the video for manual inspection
+		$key_trimmed = trim($api_key);
+		if( empty($key_trimmed) ){
+			return 1;
+		}
+
 		if( $vimeo_id = $this->isVimeoVideo($link_url) ) {
 			$url = $url.$vimeo_id.'/texttracks';
 			$response = Request::get($url)->addHeader('Authorization', "Bearer $api_key")->send();
 
-			if ( isset($response->body->total) ) {
-				if ($response->body->total > 0) {
-					return false;
-				}
+			// Response header code is used to determine if video exists, doesn't exist, or is unaccessible
+			// 400 means a video is private, 404 means a video doesn't exist, and 200 means the video exists
+			if($response->code === 400 || $response->code === 404) {
+				return 1;
+			} else if(($response->code === 200) && $response->body->total === 0) {
+				return 0;
 			}
 		}
 
-		return true;
+		return 2;
 	}
 
 	/**
@@ -57,10 +62,8 @@ function captionsMissing($link_url)
 	private function isVimeoVideo($link_url)
 	{
 		$matches = null;
-		foreach($this->regex as $pattern) {
-			if(preg_match($pattern, trim($link_url), $matches)) {
-				return $matches[1];
-			}
+		if(preg_match($this->regex, trim($link_url), $matches)) {
+			return $matches[1];
 		}
 		return false;
 	}

lib/quail/quail/common/services/media/vimeo.php

@@ -33,33 +33,38 @@ class youtubeService extends mediaService
 	/**
 	*	Checks to see if a video is missing caption information in YouTube
 	*	@param string $link_url The URL to the video or video resource
-	*	@return bool TRUE if captions are missing, FALSE if captions exists
+	*	@return int 0 if captions are missing, 1 if video is private, 2 if captions exist or not a video
 	*/
 	function captionsMissing($link_url)
 	{
 		$url = $this->search_url;
 		$api_key = constant( 'GOOGLE_API_KEY' );
 
+		// If the API key is blank, flag the video for manual inspection
+		$key_trimmed = trim($api_key);
+		if( empty($key_trimmed) ){
+			return 1;
+		}
+
 		if( $youtube_id = $this->isYouTubeVideo($link_url) ) {
 			$url = $url.$youtube_id.'&key='.$api_key;
 			$response = Request::get($url)->send();
 
-			// If the video was pulled due to copyright violations, is unlisted, or is unavailable, the items array will be empty.
-			// Another error will result in this case
-			if( empty($response->body->items) ) {
-				return true;
+			// If the video was pulled due to copyright violations, is unlisted, or is unavailable, the reponse header will be 404
+			if( $response->code === 404) {
+				return 1;
 			}
-
+			// Looks through the captions and checks if any were not auto-generated
 			foreach ( $response->body->items as $track ) {
 				if ( $track->snippet->trackKind != 'ASR' ) {
-					return false;
+					return 2;
 				}
 			}
 
-			return true;
+			return 0;
 		}
 
-		return false;
+		return 2;
 
 	}
 
@@ -79,4 +84,4 @@ private function isYouTubeVideo($link_url)
 		}
 		return false;
 	}
-}
+}