smtech / canvas-ics-sync

classes/CanvasAPIviaLTI_Installer.php

Doc Comments +2 added lines, -2 removed lines

@@ -20,7 +20,7 @@ 
 	/**
 	 * Generate a SECRETS_FILE from user input.
 	 *
-	 * @param scalar $step optional Where are we in the SECRETS_FILE creation workflow? (defaults to SECRETS_NEEDED_STEP -- the beginning)
+	 * @param integer $step optional Where are we in the SECRETS_FILE creation workflow? (defaults to SECRETS_NEEDED_STEP -- the beginning)
 	 *
 	 * @throws CanvasAPIviaLTI_Installer_Exception If form submission does not contain all required MySQL credentals (host, username, password and database)
 	 * @throws CanvasAPIviaLTI_Installer_Exception If SECRETS_FILE cannot be created
@@ -261,7 +261,7 @@ 
 	/**
 	 * Obtain a Canvas API token, if needed.
 	 *
-	 * @param scalar $step optional Where are we in the API token negotiation workflow? (defaults to API_DECISION_NEEDED_STEP -- the beginning)
+	 * @param integer $step optional Where are we in the API token negotiation workflow? (defaults to API_DECISION_NEEDED_STEP -- the beginning)
 	 * @param boolean $skip optional Skip this step (defaults to FALSE)
 	 *
 	 * @throws CanvasAPIviaLTI_Installer_Exception If $step is not a pre-defined *_STEP constant

Indentation +277 added lines, -277 removed lines

@@ -11,28 +11,28 @@ 
  * @author Seth Battis <SethBattis@stmarksschool.org>
  **/	
 class CanvasAPIviaLTI_Installer {
-	const SECRETS_NEEDED_STEP = 1;
-	const SECRETS_ENTERED_STEP = 2;
-	const API_DECISION_NEEDED_STEP = 3;
-	const API_DECISION_ENTERED_STEP = 4;
-	const API_TOKEN_PROVIDED_STEP = 5;
+    const SECRETS_NEEDED_STEP = 1;
+    const SECRETS_ENTERED_STEP = 2;
+    const API_DECISION_NEEDED_STEP = 3;
+    const API_DECISION_ENTERED_STEP = 4;
+    const API_TOKEN_PROVIDED_STEP = 5;
 		
-	/**
-	 * Generate a SECRETS_FILE from user input.
-	 *
-	 * @param scalar $step optional Where are we in the SECRETS_FILE creation workflow? (defaults to SECRETS_NEEDED_STEP -- the beginning)
-	 *
-	 * @throws CanvasAPIviaLTI_Installer_Exception If form submission does not contain all required MySQL credentals (host, username, password and database)
-	 * @throws CanvasAPIviaLTI_Installer_Exception If SECRETS_FILE cannot be created
-	 * @throws CanvasAPIviaLTI_Installer_Exception If $step is not a pre-defined *_STEP constant
-	 **/
-	public static function createSecretsFile($step = self::SECRETS_NEEDED_STEP) {
-		global $smarty; // FIXME:0 grown-ups don't program like this issue:17
+    /**
+     * Generate a SECRETS_FILE from user input.
+     *
+     * @param scalar $step optional Where are we in the SECRETS_FILE creation workflow? (defaults to SECRETS_NEEDED_STEP -- the beginning)
+     *
+     * @throws CanvasAPIviaLTI_Installer_Exception If form submission does not contain all required MySQL credentals (host, username, password and database)
+     * @throws CanvasAPIviaLTI_Installer_Exception If SECRETS_FILE cannot be created
+     * @throws CanvasAPIviaLTI_Installer_Exception If $step is not a pre-defined *_STEP constant
+     **/
+    public static function createSecretsFile($step = self::SECRETS_NEEDED_STEP) {
+        global $smarty; // FIXME:0 grown-ups don't program like this issue:17
 		
-		switch ($step) {
-			case self::SECRETS_NEEDED_STEP: {
-				// FIXME:0 passwords in clear text? oy. issue:17
-				$smarty->assign('content', '
+        switch ($step) {
+            case self::SECRETS_NEEDED_STEP: {
+                // FIXME:0 passwords in clear text? oy. issue:17
+                $smarty->assign('content', '
 					<form action="' . $_SERVER['PHP_SELF'] . '" method="post">
 						<section>
 							<h3>Application Information</h3>
@@ -57,242 +57,242 @@ 
 						<input type="submit" value="Create Secrets File" />
 					</form>
 				');
-				$smarty->display();
-				exit;
-			}
+                $smarty->display();
+                exit;
+            }
 			
-			case self::SECRETS_ENTERED_STEP: {
-				if (isset($_REQUEST['name']) && isset($_REQUEST['id']) && isset($_REQUEST['admin_username']) && isset($_REQUEST['admin_password'])) {
-					if (isset($_REQUEST['host']) && isset($_REQUEST['username']) && isset($_REQUEST['password']) && isset($_REQUEST['database'])) {
-						$secrets = new SimpleXMLElement('<secrets />');
-						$app = $secrets->addChild('app');
-						$app->addChild('name', $_REQUEST['name']);
-						$app->addChild('id', $_REQUEST['id']);
-						$admin = $app->addChild('admin');
-						$admin->addChild('username', $_REQUEST['admin_username']);
-						$admin->addChild('password', $_REQUEST['admin_password']);
-						$mysql = $secrets->addChild('mysql');
-						$mysql->addChild('host', $_REQUEST['host']);
-						$mysql->addChild('username', $_REQUEST['username']);
-						$mysql->addChild('password', $_REQUEST['password']);
-						$mysql->addChild('database', $_REQUEST['database']);
-						$oauth = $secrets->addChild('oauth');
-						$oauth->addChild('id', $_REQUEST['oauth_id']);
-						$oauth->addChild('key', $_REQUEST['oauth_key']);
-						if ($secrets->asXML(SECRETS_FILE) == false) {
-							throw new CanvasAPIviaLTI_Exception(
-								'Failed to create ' . SECRETS_FILE,
-								CanvasAPIviaLTI_Installer_Exception::SECRETS_FILE_CREATION
-							);
-						}
+            case self::SECRETS_ENTERED_STEP: {
+                if (isset($_REQUEST['name']) && isset($_REQUEST['id']) && isset($_REQUEST['admin_username']) && isset($_REQUEST['admin_password'])) {
+                    if (isset($_REQUEST['host']) && isset($_REQUEST['username']) && isset($_REQUEST['password']) && isset($_REQUEST['database'])) {
+                        $secrets = new SimpleXMLElement('<secrets />');
+                        $app = $secrets->addChild('app');
+                        $app->addChild('name', $_REQUEST['name']);
+                        $app->addChild('id', $_REQUEST['id']);
+                        $admin = $app->addChild('admin');
+                        $admin->addChild('username', $_REQUEST['admin_username']);
+                        $admin->addChild('password', $_REQUEST['admin_password']);
+                        $mysql = $secrets->addChild('mysql');
+                        $mysql->addChild('host', $_REQUEST['host']);
+                        $mysql->addChild('username', $_REQUEST['username']);
+                        $mysql->addChild('password', $_REQUEST['password']);
+                        $mysql->addChild('database', $_REQUEST['database']);
+                        $oauth = $secrets->addChild('oauth');
+                        $oauth->addChild('id', $_REQUEST['oauth_id']);
+                        $oauth->addChild('key', $_REQUEST['oauth_key']);
+                        if ($secrets->asXML(SECRETS_FILE) == false) {
+                            throw new CanvasAPIviaLTI_Exception(
+                                'Failed to create ' . SECRETS_FILE,
+                                CanvasAPIviaLTI_Installer_Exception::SECRETS_FILE_CREATION
+                            );
+                        }
 						
-						$htpasswdFile = __DIR__ . '/.htpasswd';
-						shell_exec("htpasswd -bc $htpasswdFile {$_REQUEST['admin_username']} {$_REQUEST['admin_password']}");
-						if (!file_exists($htpasswdFile)) {
-							throw new CanvasAPIviaLTI_Installer_Exception(
-								"Failed to create $htpasswdFile",
-								CanvasAPIviaLTI_Installer_Exception::HTPASSWD_FILE
-							);
-						}
+                        $htpasswdFile = __DIR__ . '/.htpasswd';
+                        shell_exec("htpasswd -bc $htpasswdFile {$_REQUEST['admin_username']} {$_REQUEST['admin_password']}");
+                        if (!file_exists($htpasswdFile)) {
+                            throw new CanvasAPIviaLTI_Installer_Exception(
+                                "Failed to create $htpasswdFile",
+                                CanvasAPIviaLTI_Installer_Exception::HTPASSWD_FILE
+                            );
+                        }
 						
-						$htaccessFile = __DIR__ . '/.htaccess';
-						if(!file_put_contents($htaccessFile, "AuthType Basic\nAuthName \"{$secrets->app->name} Admin\"\nAuthUserFile $htpasswdFile\nRequire valid-user\n")) {
-							throw new CanvasAPIviaLTI_Installer_Exception(
-								"Failed to create $htaccessFile",
-								CanvasAPIviaLTI_Installer_Exception::HTACCESS_FILE
-							);
-						}
-					} else {
-						throw new CanvasAPIviaLTI_Installer_Exception(
-							'Missing a required mysql credential (host, username, password and database all required).',
-							CanvasAPIviaLTI_Installer_Exception::SECRETS_FILE_MYSQL
-						);
-					}
-					$smarty->addMessage(
-						'Secrets file created',
-						"<code>secrets.xml</code> contains your authentication credentials and
+                        $htaccessFile = __DIR__ . '/.htaccess';
+                        if(!file_put_contents($htaccessFile, "AuthType Basic\nAuthName \"{$secrets->app->name} Admin\"\nAuthUserFile $htpasswdFile\nRequire valid-user\n")) {
+                            throw new CanvasAPIviaLTI_Installer_Exception(
+                                "Failed to create $htaccessFile",
+                                CanvasAPIviaLTI_Installer_Exception::HTACCESS_FILE
+                            );
+                        }
+                    } else {
+                        throw new CanvasAPIviaLTI_Installer_Exception(
+                            'Missing a required mysql credential (host, username, password and database all required).',
+                            CanvasAPIviaLTI_Installer_Exception::SECRETS_FILE_MYSQL
+                        );
+                    }
+                    $smarty->addMessage(
+                        'Secrets file created',
+                        "<code>secrets.xml</code> contains your authentication credentials and
 						 should be carefully protected. Be sure not to commit it to a public
 						 repository!",
-						NotificationMessage::GOOD
-					);
-				} else {
-					throw new CanvasAPIviaLTI_Installer_Exception(
-						'Missing a required app identity (name, id, admin username and admin password all required).',
-						CanvasAPIviaLTI_Installer_Exception::SECRETS_FILE_APP
-					);
-				}
+                        NotificationMessage::GOOD
+                    );
+                } else {
+                    throw new CanvasAPIviaLTI_Installer_Exception(
+                        'Missing a required app identity (name, id, admin username and admin password all required).',
+                        CanvasAPIviaLTI_Installer_Exception::SECRETS_FILE_APP
+                    );
+                }
 				
-				/* clear the processed step */
-				unset($_REQUEST['step']);
+                /* clear the processed step */
+                unset($_REQUEST['step']);
 
-				break;
-			}
+                break;
+            }
 			
-			default: {
-				throw new CanvasAPIviaLTI_Installer_Exception(
-					"Unknown step ($step) in SECRETS_FILE creation.",
-					CanvasAPIviaLTI_Installer_Exception::SECRETS_NEEDED_STEP
-				);
-			}
-		}
-	}
+            default: {
+                throw new CanvasAPIviaLTI_Installer_Exception(
+                    "Unknown step ($step) in SECRETS_FILE creation.",
+                    CanvasAPIviaLTI_Installer_Exception::SECRETS_NEEDED_STEP
+                );
+            }
+        }
+    }
 	
-	/**
-	 * Create database tables to back LTI_Tool_Provider
-	 *
-	 * @throws CanvasAPIviaLTI_Installer_Exception If database schema not found in vendors directory
-	 * @throws CanvasAPIviaLTI_Installer_Exception If database tables are not created
-	 **/
-	public static function createLTIDatabaseTables() {
-		global $sql; // FIXME:0 grown-ups don't program like this issue:17
-		global $smarty; // FIXME:0 grown-ups don't program like this issue:17
+    /**
+     * Create database tables to back LTI_Tool_Provider
+     *
+     * @throws CanvasAPIviaLTI_Installer_Exception If database schema not found in vendors directory
+     * @throws CanvasAPIviaLTI_Installer_Exception If database tables are not created
+     **/
+    public static function createLTIDatabaseTables() {
+        global $sql; // FIXME:0 grown-ups don't program like this issue:17
+        global $smarty; // FIXME:0 grown-ups don't program like this issue:17
 		
-		$ltiSchema = realpath(__DIR__ . '/../vendor/spvsoftwareproducts/LTI_Tool_Provider/lti-tables-mysql.sql');
+        $ltiSchema = realpath(__DIR__ . '/../vendor/spvsoftwareproducts/LTI_Tool_Provider/lti-tables-mysql.sql');
 		
-		if ($sql->query("SHOW TABLES LIKE 'lti_%'")->num_rows >= 5) {
-			$smarty->addMessage('LTI database tables exist', 'Database tables to support the LTI Tool Provider (TP) already exist and have not been re-created.');
-		} elseif (file_exists($ltiSchema)) {
-			$queries = explode(";", file_get_contents($ltiSchema));
-			$created = true;
-			foreach($queries as $query) {
-				if (!empty(trim($query))) {
-					if (!$sql->query($query)) {
-						throw new CanvasAPIviaLTI_Installer_Exception(
-							"Error creating LTI database tables: {$sql->error}",
-							CanvasAPIviaLTI_Installer_Exception::LTI_PREPARE_DATABASE
-						);
-					}
-				}
-			}
+        if ($sql->query("SHOW TABLES LIKE 'lti_%'")->num_rows >= 5) {
+            $smarty->addMessage('LTI database tables exist', 'Database tables to support the LTI Tool Provider (TP) already exist and have not been re-created.');
+        } elseif (file_exists($ltiSchema)) {
+            $queries = explode(";", file_get_contents($ltiSchema));
+            $created = true;
+            foreach($queries as $query) {
+                if (!empty(trim($query))) {
+                    if (!$sql->query($query)) {
+                        throw new CanvasAPIviaLTI_Installer_Exception(
+                            "Error creating LTI database tables: {$sql->error}",
+                            CanvasAPIviaLTI_Installer_Exception::LTI_PREPARE_DATABASE
+                        );
+                    }
+                }
+            }
 			
-			$smarty->addMessage(
-				'LTI database tables created',
-				'Database tables to support the LTI Tool Provider (TP) have been created in
+            $smarty->addMessage(
+                'LTI database tables created',
+                'Database tables to support the LTI Tool Provider (TP) have been created in
 				 your MySQL database.',
-				NotificationMessage::GOOD
-			);
-		} else {
-			throw new CanvasAPIviaLTI_Exception("$ltiSchema not found.");
-		}
-	}
+                NotificationMessage::GOOD
+            );
+        } else {
+            throw new CanvasAPIviaLTI_Exception("$ltiSchema not found.");
+        }
+    }
 	
-	/**
-	 * Create database tables to back app
-	 *
-	 * @throws CanvasAPIviaLTI_Installer_Exception If database tables are not created
-	 **/
-	public static function createAppDatabaseTables() {
-		global $sql; // FIXME:0 grown-ups don't program like this issue:17
-		global $smarty; // FIXME:0 grown-ups don't program like this issue:17
+    /**
+     * Create database tables to back app
+     *
+     * @throws CanvasAPIviaLTI_Installer_Exception If database tables are not created
+     **/
+    public static function createAppDatabaseTables() {
+        global $sql; // FIXME:0 grown-ups don't program like this issue:17
+        global $smarty; // FIXME:0 grown-ups don't program like this issue:17
 		
-		if (file_exists(SCHEMA_FILE)) {
-			$queries = explode(";", file_get_contents(SCHEMA_FILE));
-			$created = true;
-			foreach ($queries as $query) {
-				if (!empty(trim($query))) {
-					if (preg_match('/CREATE\s+TABLE\s+(`([^`]+)`|\w+)/i', $query, $tableName)) {
-						$tableName = (empty($tableName[2]) ? $tableName[1] : $tableName[2]);
-						if ($sql->query("SHOW TABLES LIKE '$tableName'")->num_rows > 0) {
-							$created = false;
-						} else {
-							if (!$sql->query($query)) {
-								throw new CanvasAPIviaLTI_Installer_Exception(
-									"Error creating app database tables: {$sql->error}",
-									CanvasAPIviaLTI_Installer_Exception::APP_CREATE_TABLE
-								);
-							}
-						}
-					} else {
-						if (!$sql->query($query)) {
-							throw new CanvasAPIviaLTI_Installer_Exception(
-								"Error creating app database tables: {$sql->error}",
-								CanvasAPIviaLTI_Installer_Exception::APP_PREPARE_DATABASE
-							);
-						}
-					}
-				}
-			}
+        if (file_exists(SCHEMA_FILE)) {
+            $queries = explode(";", file_get_contents(SCHEMA_FILE));
+            $created = true;
+            foreach ($queries as $query) {
+                if (!empty(trim($query))) {
+                    if (preg_match('/CREATE\s+TABLE\s+(`([^`]+)`|\w+)/i', $query, $tableName)) {
+                        $tableName = (empty($tableName[2]) ? $tableName[1] : $tableName[2]);
+                        if ($sql->query("SHOW TABLES LIKE '$tableName'")->num_rows > 0) {
+                            $created = false;
+                        } else {
+                            if (!$sql->query($query)) {
+                                throw new CanvasAPIviaLTI_Installer_Exception(
+                                    "Error creating app database tables: {$sql->error}",
+                                    CanvasAPIviaLTI_Installer_Exception::APP_CREATE_TABLE
+                                );
+                            }
+                        }
+                    } else {
+                        if (!$sql->query($query)) {
+                            throw new CanvasAPIviaLTI_Installer_Exception(
+                                "Error creating app database tables: {$sql->error}",
+                                CanvasAPIviaLTI_Installer_Exception::APP_PREPARE_DATABASE
+                            );
+                        }
+                    }
+                }
+            }
 			
-			if ($created) {
-				$smarty->addMessage(
-					'App database tables created',
-					'Database tables to support the application have been created in your
+            if ($created) {
+                $smarty->addMessage(
+                    'App database tables created',
+                    'Database tables to support the application have been created in your
 					 MySQL database.',
-					NotificationMessage::GOOD
-				);
-			} else {
-				$smarty->addMessage(
-					'App database tables exist',
-					'Database tables to support the application already exist and have not
+                    NotificationMessage::GOOD
+                );
+            } else {
+                $smarty->addMessage(
+                    'App database tables exist',
+                    'Database tables to support the application already exist and have not
 					 been re-created.'
-				);
-			}
-		}
-	}
+                );
+            }
+        }
+    }
 	
-	/**
-	 * Initialize the app metadata store, especially the APP_PATH and APP_URL
-	 *
-	 * @return AppMetadata
-	 **/
-	public static function createAppMetadata() {
-		global $secrets; // FIXME:0 grown-ups don't program like this issue:17
-		global $sql; // FIXME:0 grown-ups don't program like this issue:17
-		global $metadata; // FIXME:0 grown-ups don't program like this issue:17
-		global $smarty; // FIXME:0 grown-ups don't program like this issue:17
+    /**
+     * Initialize the app metadata store, especially the APP_PATH and APP_URL
+     *
+     * @return AppMetadata
+     **/
+    public static function createAppMetadata() {
+        global $secrets; // FIXME:0 grown-ups don't program like this issue:17
+        global $sql; // FIXME:0 grown-ups don't program like this issue:17
+        global $metadata; // FIXME:0 grown-ups don't program like this issue:17
+        global $smarty; // FIXME:0 grown-ups don't program like this issue:17
 				
-		$metadata = initAppMetadata();
-		$metadata['APP_PATH'] = preg_replace('/\/classes$/', '', __DIR__);
-		$metadata['APP_URL'] = (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] != 'on' ? 'http://' : 'https://') . $_SERVER['SERVER_NAME'] . preg_replace("|^{$_SERVER['DOCUMENT_ROOT']}(.*)$|", '$1', $metadata['APP_PATH']);
-		$metadata['APP_NAME'] = (string) $secrets->app->name;
-		$metadata['APP_ID'] = (string) $secrets->app->id;
-		$metadata['CANVAS_INSTANCE_URL_PLACEHOLDER'] = 'https://canvas.instructure.com';
-		$smarty->assign('metadata', $metadata);
+        $metadata = initAppMetadata();
+        $metadata['APP_PATH'] = preg_replace('/\/classes$/', '', __DIR__);
+        $metadata['APP_URL'] = (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] != 'on' ? 'http://' : 'https://') . $_SERVER['SERVER_NAME'] . preg_replace("|^{$_SERVER['DOCUMENT_ROOT']}(.*)$|", '$1', $metadata['APP_PATH']);
+        $metadata['APP_NAME'] = (string) $secrets->app->name;
+        $metadata['APP_ID'] = (string) $secrets->app->id;
+        $metadata['CANVAS_INSTANCE_URL_PLACEHOLDER'] = 'https://canvas.instructure.com';
+        $smarty->assign('metadata', $metadata);
 
-		$smarty->addMessage(
-			'App metadata initialized',
-			'Basic application metadata has been updated, including APP_PATH and APP_URL',
-			NotificationMessage::GOOD
-		);
+        $smarty->addMessage(
+            'App metadata initialized',
+            'Basic application metadata has been updated, including APP_PATH and APP_URL',
+            NotificationMessage::GOOD
+        );
 		
-		return $metadata;
-	}
+        return $metadata;
+    }
 	
-	/**
-	 * Obtain a Canvas API token, if needed.
-	 *
-	 * @param scalar $step optional Where are we in the API token negotiation workflow? (defaults to API_DECISION_NEEDED_STEP -- the beginning)
-	 * @param boolean $skip optional Skip this step (defaults to FALSE)
-	 *
-	 * @throws CanvasAPIviaLTI_Installer_Exception If $step is not a pre-defined *_STEP constant
-	 **/
-	public static function acquireAPIToken($step = self::API_DECISION_NEEDED_STEP, $skip = false) {
-		global $secrets; // FIXME:0 grown-ups don't program like this issue:17
-		global $metadata; // FIXME:0 grown-ups don't program like this issue:17
-		global $smarty; // FIXME:0 grown-ups don't program like this issue:17
+    /**
+     * Obtain a Canvas API token, if needed.
+     *
+     * @param scalar $step optional Where are we in the API token negotiation workflow? (defaults to API_DECISION_NEEDED_STEP -- the beginning)
+     * @param boolean $skip optional Skip this step (defaults to FALSE)
+     *
+     * @throws CanvasAPIviaLTI_Installer_Exception If $step is not a pre-defined *_STEP constant
+     **/
+    public static function acquireAPIToken($step = self::API_DECISION_NEEDED_STEP, $skip = false) {
+        global $secrets; // FIXME:0 grown-ups don't program like this issue:17
+        global $metadata; // FIXME:0 grown-ups don't program like this issue:17
+        global $smarty; // FIXME:0 grown-ups don't program like this issue:17
 		
-		if ($skip) {
-			if (isset($metadata['CANVAS_API_TOKEN']) || isset($metadata['CANVAS_API_USER'])) {
-				$api = new CanvasPest("{$metadata['CANVAS_INSTANCE_URL']}/login/oauth2", $metadata['CANVAS_API_TOKEN']);
-				$api->delete('token');
-				unset($metadata['CANVAS_API_TOKEN']);
-				unset($metadata['CANVAS_API_USER']);
-				$smarty->addMessage(
-					'Existing admin Canvas API token information expunged',
-					'There was already an administrative access token stored in your
+        if ($skip) {
+            if (isset($metadata['CANVAS_API_TOKEN']) || isset($metadata['CANVAS_API_USER'])) {
+                $api = new CanvasPest("{$metadata['CANVAS_INSTANCE_URL']}/login/oauth2", $metadata['CANVAS_API_TOKEN']);
+                $api->delete('token');
+                unset($metadata['CANVAS_API_TOKEN']);
+                unset($metadata['CANVAS_API_USER']);
+                $smarty->addMessage(
+                    'Existing admin Canvas API token information expunged',
+                    'There was already an administrative access token stored in your
 					 application metadata, and it has now been expunged.'
-				);
-			} else {
-				$smarty->addMessage(
-					'No admin Canvas API token acquired',
-					'An administrative API token has not been acquired. Users will be asked to
+                );
+            } else {
+                $smarty->addMessage(
+                    'No admin Canvas API token acquired',
+                    'An administrative API token has not been acquired. Users will be asked to
 					 acquire their own API tokens on their first use of the LTI.'
-				);
-			}
-		} else {
-			switch ($step) {
-				case self::API_DECISION_NEEDED_STEP: {
-					$smarty->assign('content', '
+                );
+            }
+        } else {
+            switch ($step) {
+                case self::API_DECISION_NEEDED_STEP: {
+                    $smarty->assign('content', '
 						<form action="' . $metadata['APP_URL'] . '/admin/oauth.php" method="post">
 							<label for="url"> Canvas Instance URL <input type="text" name="url" id="url" placeholder="' . $metadata['CANVAS_INSTANCE_URL_PLACEHOLDER'] . '" value="' . (isset($metadata['CANVAS_INSTANCE_URL']) ? $metadata['CANVAS_INSTANCE_URL'] : '') . '" /></label>
 							<label for="token"> API Access Token <input type="text" name="token" id="token" placeholder="Leave blank to acquire a token interactively" /></label>
@@ -307,43 +307,43 @@ 
 							<input type="submit" value="Require users to acquire individual tokens" />
 						</form>
 					');
-					$smarty->display();
-					exit;
-				}
-				case self::API_DECISION_ENTERED_STEP: {
-					$oauth = new OAuthNegotiator();
+                    $smarty->display();
+                    exit;
+                }
+                case self::API_DECISION_ENTERED_STEP: {
+                    $oauth = new OAuthNegotiator();
 					
-					if ($oauth->isAPIToken()) {
-						$metadata['CANVAS_API_TOKEN'] = $oauth->getToken();
+                    if ($oauth->isAPIToken()) {
+                        $metadata['CANVAS_API_TOKEN'] = $oauth->getToken();
 						
-						$smarty->addMessage(
-							'Admin Canvas API token acquired',
-							'An administrative API access token has been acquired and stored in your application metadata.',
-							NotificationMessage::GOOD
-						);
-					}
+                        $smarty->addMessage(
+                            'Admin Canvas API token acquired',
+                            'An administrative API access token has been acquired and stored in your application metadata.',
+                            NotificationMessage::GOOD
+                        );
+                    }
 					
-					/* clear the processed step */
-					unset($_REQUEST['step']);
+                    /* clear the processed step */
+                    unset($_REQUEST['step']);
 					
-					break;
-				}
-				case self::API_TOKEN_PROVIDED_STEP: {
-					$smarty->addMessage(
-						'Admin Canvas API token provided',
-						'You provided an API access token and it has been stored in your application metadata.' 
-					);
-					break;
-				}
-				default: {
-					throw new CanvasAPIviaLTI_Installer_Exception(
-						"Unknown step ($step) in obtaining API token.",
-						CanvasAPIviaLTI_Installer_Exception::API_STEP_MISMATCH
-					);
-				}
-			}
-		}
-	}
+                    break;
+                }
+                case self::API_TOKEN_PROVIDED_STEP: {
+                    $smarty->addMessage(
+                        'Admin Canvas API token provided',
+                        'You provided an API access token and it has been stored in your application metadata.' 
+                    );
+                    break;
+                }
+                default: {
+                    throw new CanvasAPIviaLTI_Installer_Exception(
+                        "Unknown step ($step) in obtaining API token.",
+                        CanvasAPIviaLTI_Installer_Exception::API_STEP_MISMATCH
+                    );
+                }
+            }
+        }
+    }
 }
 
 /**
@@ -352,20 +352,20 @@ 
  * @author Seth Battis <SethBattis@stmarksschool.org>
  **/
 class CanvasAPIviaLTI_Installer_Exception extends CanvasAPIviaLTI_Exception {
-	const SECRETS_FILE_CREATION = 1;
-	const SECRETS_FILE_APP = 2;
-	const SECRETS_FILE_MYSQL = 3;
-	const LTI_SCHEMA = 4;
-	const LTI_PREPARE_DATABASE = 5;
-	const LTI_CREATE_TABLE = 6;
-	const APP_SCHEMA = 7;
-	const APP_PREPARE_DATABASE = 8;
-	const APP_CREATE_TABLE = 9;
-	const API_STEP_MISMATCH = 10;
-	const API_URL = 14;
-	const API_TOKEN = 11;
-	const HTPASSWD_FILE = 12;
-	const HTACCESS_FILE = 13;
+    const SECRETS_FILE_CREATION = 1;
+    const SECRETS_FILE_APP = 2;
+    const SECRETS_FILE_MYSQL = 3;
+    const LTI_SCHEMA = 4;
+    const LTI_PREPARE_DATABASE = 5;
+    const LTI_CREATE_TABLE = 6;
+    const APP_SCHEMA = 7;
+    const APP_PREPARE_DATABASE = 8;
+    const APP_CREATE_TABLE = 9;
+    const API_STEP_MISMATCH = 10;
+    const API_URL = 14;
+    const API_TOKEN = 11;
+    const HTPASSWD_FILE = 12;
+    const HTACCESS_FILE = 13;
 }
 
 ?>
\ No newline at end of file

Spacing +2 added lines, -2 removed lines

@@ -96,7 +96,7 @@ 
 						}
 						
 						$htaccessFile = __DIR__ . '/.htaccess';
-						if(!file_put_contents($htaccessFile, "AuthType Basic\nAuthName \"{$secrets->app->name} Admin\"\nAuthUserFile $htpasswdFile\nRequire valid-user\n")) {
+						if (!file_put_contents($htaccessFile, "AuthType Basic\nAuthName \"{$secrets->app->name} Admin\"\nAuthUserFile $htpasswdFile\nRequire valid-user\n")) {
 							throw new CanvasAPIviaLTI_Installer_Exception(
 								"Failed to create $htaccessFile",
 								CanvasAPIviaLTI_Installer_Exception::HTACCESS_FILE
@@ -154,7 +154,7 @@ 
 		} elseif (file_exists($ltiSchema)) {
 			$queries = explode(";", file_get_contents($ltiSchema));
 			$created = true;
-			foreach($queries as $query) {
+			foreach ($queries as $query) {
 				if (!empty(trim($query))) {
 					if (!$sql->query($query)) {
 						throw new CanvasAPIviaLTI_Installer_Exception(

classes/UserAPIToken.php

Doc Comments +2 added lines, -2 removed lines

@@ -91,7 +91,7 @@ 
 	}
 	
 	/**
-	 * @return string|boolean The API access token for this user, or FALSE if no token has been acquired
+	 * @return string|false The API access token for this user, or FALSE if no token has been acquired
 	 **/
 	public function getToken() {
 		if ($this->token) {
@@ -133,7 +133,7 @@ 
 	}
 	
 	/**
-	 * @return string|boolean The URL of the API for which the user's API token is valid, or FALSE if no token has been acquired
+	 * @return string|false The URL of the API for which the user's API token is valid, or FALSE if no token has been acquired
 	 **/
 	function getAPIUrl() {
 		if ($this->apiUrl) {

Indentation +152 added lines, -152 removed lines

@@ -8,170 +8,170 @@ 
  **/
 class UserAPIToken {
 
-	const USER_TOKENS_TABLE = 'user_tokens';
+    const USER_TOKENS_TABLE = 'user_tokens';
 	
-	/**
-	 * @var string $consumerKey The unique ID of the tool consumer from whence the user is making requests to the LTI
-	 **/	
-	private $consumerKey;
+    /**
+     * @var string $consumerKey The unique ID of the tool consumer from whence the user is making requests to the LTI
+     **/	
+    private $consumerKey;
 	
-	/**
-	 * @var string $id The unique ID (within the context of a particular Tool Consumer) of a particular user
-	 **/
-	private $id;
+    /**
+     * @var string $id The unique ID (within the context of a particular Tool Consumer) of a particular user
+     **/
+    private $id;
 	
-	/**
-	 * @var mysqli $sql A MySQL connection
-	 **/
-	private $sql;
+    /**
+     * @var mysqli $sql A MySQL connection
+     **/
+    private $sql;
 	
-	/**
-	 * @var string|null $token This user's API access token (if acquired) or NULL if not yet acquired
-	 **/
-	private $token = null;
+    /**
+     * @var string|null $token This user's API access token (if acquired) or NULL if not yet acquired
+     **/
+    private $token = null;
 	
-	/**
-	 * @var string|null $apiUrl The URL of the API for which this user's token is valid, NULL if no token
-	 **/
-	private $apiUrl = null;
+    /**
+     * @var string|null $apiUrl The URL of the API for which this user's token is valid, NULL if no token
+     **/
+    private $apiUrl = null;
 
-	/**
-	 * Create a new UserAPIToken to either register a new user in the
-	 * USER_TOKENS_TABLE or	look up an existing user.
-	 *
-	 * @param string $consumerKey The unique ID of the Tool Consumer from whence the user is making requests to the LTI
-	 * @param string $userId The unique ID of the user within that Tool Consumer
-	 * @param mysqli $mysqli An active MySQL database connection to update USER_TOKEN_TABLE
-	 *
-	 * @throws UserAPIToken_Exception CONSUMER_KEY_REQUIRED If no consumer key is provided
-	 * @throws UserAPIToken_Exception USER_ID_REQUIRED If no user ID is provided
-	 * @throws UserAPIToken_Exception MYSQLI_REQUIRED If no MySQL database connection is provided
-	 * @throws UserAPIToken_Excpetion MYSQLI_ERROR If the user cannot be found or inserted in USER_TOKEN_TABLE
-	 **/
-	public function __construct($consumerKey, $userId, $mysqli) {
+    /**
+     * Create a new UserAPIToken to either register a new user in the
+     * USER_TOKENS_TABLE or	look up an existing user.
+     *
+     * @param string $consumerKey The unique ID of the Tool Consumer from whence the user is making requests to the LTI
+     * @param string $userId The unique ID of the user within that Tool Consumer
+     * @param mysqli $mysqli An active MySQL database connection to update USER_TOKEN_TABLE
+     *
+     * @throws UserAPIToken_Exception CONSUMER_KEY_REQUIRED If no consumer key is provided
+     * @throws UserAPIToken_Exception USER_ID_REQUIRED If no user ID is provided
+     * @throws UserAPIToken_Exception MYSQLI_REQUIRED If no MySQL database connection is provided
+     * @throws UserAPIToken_Excpetion MYSQLI_ERROR If the user cannot be found or inserted in USER_TOKEN_TABLE
+     **/
+    public function __construct($consumerKey, $userId, $mysqli) {
 		
-		if (empty((string) $consumerKey)) {
-			throw new UserAPIToken_Exception(
-				'A consumer key is required',
-				UserAPIToken_Exception::CONSUMER_KEY_REQUIRED
-			);
-		}
+        if (empty((string) $consumerKey)) {
+            throw new UserAPIToken_Exception(
+                'A consumer key is required',
+                UserAPIToken_Exception::CONSUMER_KEY_REQUIRED
+            );
+        }
 		
-		if (empty((string) $userId)) {
-			throw new UserAPIToken_Exception(
-				'A user ID is required',
-				UserAPIToken_Exception::USER_ID_REQUIRED
-			);
-		}
+        if (empty((string) $userId)) {
+            throw new UserAPIToken_Exception(
+                'A user ID is required',
+                UserAPIToken_Exception::USER_ID_REQUIRED
+            );
+        }
 		
-		if (!($mysqli instanceof mysqli)) {
-			throw new UserAPIToken_Exception(
-				'A valid mysqli object is required',
-				UserAPIToken_Exception::MYSQLI_REQUIRED
-			);
-		}
+        if (!($mysqli instanceof mysqli)) {
+            throw new UserAPIToken_Exception(
+                'A valid mysqli object is required',
+                UserAPIToken_Exception::MYSQLI_REQUIRED
+            );
+        }
 		
-		$this->sql = $mysqli;
-		$this->consumerKey = $this->sql->real_escape_string($consumerKey);
-		$this->id = $this->sql->real_escape_string($userId);
+        $this->sql = $mysqli;
+        $this->consumerKey = $this->sql->real_escape_string($consumerKey);
+        $this->id = $this->sql->real_escape_string($userId);
 				
-		$result = $this->sql->query("SELECT * FROM `" . self::USER_TOKENS_TABLE . "` WHERE `consumer_key` = '{$this->consumerKey}' AND `id` = '{$this->id}'");
-		$row = $result->fetch_assoc();
-		if ($row) {
-			$this->token = $row['token'];
-			$this->apiUrl = $row['api_url'];
-		} else {
-			if (!$this->sql->query("INSERT INTO `" . self::USER_TOKENS_TABLE . "` (`consumer_key`, `id`) VALUES ('{$this->consumerKey}', '{$this->id}')")) {
-				throw new UserAPIToken_Exception(
-					"Error inserting a new user: {$this->sql->error}",
-					UserAPIToken_Exception::MYSQLI_ERROR
-				);
-			}
-		}
-	}
+        $result = $this->sql->query("SELECT * FROM `" . self::USER_TOKENS_TABLE . "` WHERE `consumer_key` = '{$this->consumerKey}' AND `id` = '{$this->id}'");
+        $row = $result->fetch_assoc();
+        if ($row) {
+            $this->token = $row['token'];
+            $this->apiUrl = $row['api_url'];
+        } else {
+            if (!$this->sql->query("INSERT INTO `" . self::USER_TOKENS_TABLE . "` (`consumer_key`, `id`) VALUES ('{$this->consumerKey}', '{$this->id}')")) {
+                throw new UserAPIToken_Exception(
+                    "Error inserting a new user: {$this->sql->error}",
+                    UserAPIToken_Exception::MYSQLI_ERROR
+                );
+            }
+        }
+    }
 	
-	/**
-	 * @return string|boolean The API access token for this user, or FALSE if no token has been acquired
-	 **/
-	public function getToken() {
-		if ($this->token) {
-			return $this->token;
-		}
-		return false;
-	}
+    /**
+     * @return string|boolean The API access token for this user, or FALSE if no token has been acquired
+     **/
+    public function getToken() {
+        if ($this->token) {
+            return $this->token;
+        }
+        return false;
+    }
 	
-	/**
-	 * Stores a new API Token into USER_TOKEN_TABLE for this user
-	 *
-	 * @param string $token A new API access token for this user
-	 *
-	 * @return boolean Returns TRUE if the token is successfully stored in USER_TOKEN_TABLE, FALSE otherwise
-	 *
-	 * @throws UserAPIToken_Exception TOKEN_REQUIRED If no token is provided
-	 **/
-	public function setToken($token) {
-		if (empty($token)) {
-			throw new UserAPIToken_Exception(
-				'A token is required',
-				UserAPIToken_Exception::TOKEN_REQUIRED
-			);
-		}
-		if($this->consumerKey && $this->id && $this->sql) {
-			$_token = $this->sql->real_escape_string($token);
-			if (!$this->sql->query("UPDATE `" . self::USER_TOKENS_TABLE . "` set `token` = '$_token' WHERE `consumer_key` = '{$this->consumerKey}' AND `id` = '{$this->id}'")) {
-				throw new UserAPIToken_Exception(
-					"Error updating token: {$this->sql->error}",
-					UserAPIToken_Exception::MYSQLI_ERROR
-				);
-			}
-			$this->token = $token;
+    /**
+     * Stores a new API Token into USER_TOKEN_TABLE for this user
+     *
+     * @param string $token A new API access token for this user
+     *
+     * @return boolean Returns TRUE if the token is successfully stored in USER_TOKEN_TABLE, FALSE otherwise
+     *
+     * @throws UserAPIToken_Exception TOKEN_REQUIRED If no token is provided
+     **/
+    public function setToken($token) {
+        if (empty($token)) {
+            throw new UserAPIToken_Exception(
+                'A token is required',
+                UserAPIToken_Exception::TOKEN_REQUIRED
+            );
+        }
+        if($this->consumerKey && $this->id && $this->sql) {
+            $_token = $this->sql->real_escape_string($token);
+            if (!$this->sql->query("UPDATE `" . self::USER_TOKENS_TABLE . "` set `token` = '$_token' WHERE `consumer_key` = '{$this->consumerKey}' AND `id` = '{$this->id}'")) {
+                throw new UserAPIToken_Exception(
+                    "Error updating token: {$this->sql->error}",
+                    UserAPIToken_Exception::MYSQLI_ERROR
+                );
+            }
+            $this->token = $token;
 			
-			return true;
-		}
+            return true;
+        }
 		
-		return false;
-	}
+        return false;
+    }
 	
-	/**
-	 * @return string|boolean The URL of the API for which the user's API token is valid, or FALSE if no token has been acquired
-	 **/
-	function getAPIUrl() {
-		if ($this->apiUrl) {
-			return $this->apiUrl;
-		}
-		return false;
-	}
+    /**
+     * @return string|boolean The URL of the API for which the user's API token is valid, or FALSE if no token has been acquired
+     **/
+    function getAPIUrl() {
+        if ($this->apiUrl) {
+            return $this->apiUrl;
+        }
+        return false;
+    }
 	
-	/**
-	 * Stores a new URL for the API URL for which the user's API access token is valid in USER_TOKEN_TABLE
-	 *
-	 * @param string $apiUrl The URL of the API
-	 *
-	 * @return boolean TRUE if the URL of the API is stored in USER_TOKEN_TABLE, FALSE otherwise
-	 *
-	 * @throws UserAPITokenException API_URL_REQUIRED If no URL is provided
-	 **/
-	public function setAPIUrl($apiUrl) {
-		if (empty($apiUrl)) {
-			throw new UserAPIToken_Exception(
-				'API URL is required',
-				UserAPIToken_Exception::API_URL_REQUIRED
-			);
-		}
+    /**
+     * Stores a new URL for the API URL for which the user's API access token is valid in USER_TOKEN_TABLE
+     *
+     * @param string $apiUrl The URL of the API
+     *
+     * @return boolean TRUE if the URL of the API is stored in USER_TOKEN_TABLE, FALSE otherwise
+     *
+     * @throws UserAPITokenException API_URL_REQUIRED If no URL is provided
+     **/
+    public function setAPIUrl($apiUrl) {
+        if (empty($apiUrl)) {
+            throw new UserAPIToken_Exception(
+                'API URL is required',
+                UserAPIToken_Exception::API_URL_REQUIRED
+            );
+        }
 		
-		if ($this->consumerKey && $this->id && $this->sql) {
-			$_apiUrl = $this->sql->real_escape_string($apiUrl);
-			if (!$this->sql->query("UPDATE `" . self::USER_TOKENS_TABLE . "` set `api_url` = '$_apiUrl' WHERE `consumer_key` = '{$this->consumerKey}' AND `id` = '{$this->id}'")) {
-				throw new UserAPIToken_Exception(
-					"Error updating API URL for user token: {$this->sql->error}",
-					UserAPIToken_Exception::MYSQLI_ERROR
-				);
-			}
-			$this->apiUrl = $apiUrl;
-			return true;
-		}
-		return false;
-	}
+        if ($this->consumerKey && $this->id && $this->sql) {
+            $_apiUrl = $this->sql->real_escape_string($apiUrl);
+            if (!$this->sql->query("UPDATE `" . self::USER_TOKENS_TABLE . "` set `api_url` = '$_apiUrl' WHERE `consumer_key` = '{$this->consumerKey}' AND `id` = '{$this->id}'")) {
+                throw new UserAPIToken_Exception(
+                    "Error updating API URL for user token: {$this->sql->error}",
+                    UserAPIToken_Exception::MYSQLI_ERROR
+                );
+            }
+            $this->apiUrl = $apiUrl;
+            return true;
+        }
+        return false;
+    }
 }
 
 /**
@@ -180,12 +180,12 @@ 
  * @author Seth Battis <SethBattis@stmarksschool.org>
  **/
 class UserAPIToken_Exception extends CanvasAPIviaLTI_Exception {
-	const CONSUMER_KEY_REQUIRED = 1;
-	const USER_ID_REQUIRED = 2;
-	const MYSQLI_REQUIRED = 3;
-	const MYSQLI_ERROR = 4;
-	const TOKEN_REQUIRED = 5;
-	const API_URL_REQUIRED = 6;
+    const CONSUMER_KEY_REQUIRED = 1;
+    const USER_ID_REQUIRED = 2;
+    const MYSQLI_REQUIRED = 3;
+    const MYSQLI_ERROR = 4;
+    const TOKEN_REQUIRED = 5;
+    const API_URL_REQUIRED = 6;
 }
 
 ?>
\ No newline at end of file

Spacing +1 added lines, -1 removed lines

@@ -116,7 +116,7 @@
 				UserAPIToken_Exception::TOKEN_REQUIRED
 			);
 		}
-		if($this->consumerKey && $this->id && $this->sql) {
+		if ($this->consumerKey && $this->id && $this->sql) {
 			$_token = $this->sql->real_escape_string($token);
 			if (!$this->sql->query("UPDATE `" . self::USER_TOKENS_TABLE . "` set `token` = '$_token' WHERE `consumer_key` = '{$this->consumerKey}' AND `id` = '{$this->id}'")) {
 				throw new UserAPIToken_Exception(

import.php

Unused Use Statements -1 removed lines

@@ -11,7 +11,6 @@
 
 require_once 'common.inc.php';
 
-use smtech\CanvasPest\CanvasPest;
 use Battis\BootstrapSmarty\NotificationMessage;
 
 /**

Indentation +253 added lines, -253 removed lines

@@ -1,12 +1,12 @@ 
 <?php
 
 if (php_sapi_name() == 'cli') {
-	// TODO there is a more streamlined way of doing this that escapes me just this second
-	$_REQUEST['cal'] = $argv[1];
-	$_REQUEST['canvas_url'] = $argv[2];
-	$_REQUEST['schedule'] = $argv[3];
+    // TODO there is a more streamlined way of doing this that escapes me just this second
+    $_REQUEST['cal'] = $argv[1];
+    $_REQUEST['canvas_url'] = $argv[2];
+    $_REQUEST['schedule'] = $argv[3];
 
-	define ('IGNORE_LTI', true);
+    define ('IGNORE_LTI', true);
 }
 
 require_once 'common.inc.php';
@@ -18,49 +18,49 @@ 
  * Check to see if a URL exists
  **/
 function urlExists($url) {
-	$handle = fopen($url, 'r');
-	return $handle !== false;
+    $handle = fopen($url, 'r');
+    return $handle !== false;
 }
 
 /**
  * compute the calendar context for the canvas object based on its URL
  **/
 function getCanvasContext($canvasUrl) {
-	global $metadata;
-
-	// TODO: accept calendar2?contexts links too (they would be an intuitively obvious link to use, after all)
-	// FIXME: users aren't working
-	// TODO: it would probably be better to look up users by email address than URL
-	/* get the context (user, course or group) for the canvas URL */
-	$canvasContext = array();
-	if (preg_match('%(https?://)?(' . parse_url($metadata['CANVAS_INSTANCE_URL'], PHP_URL_HOST) . '/((about/(\d+))|(courses/(\d+)(/groups/(\d+))?)|(accounts/\d+/groups/(\d+))))%', $_REQUEST['canvas_url'], $matches)) {
-		$canvasContext['canonical_url'] = "https://{$matches[2]}"; // https://stmarksschool.instructure.com/courses/953
-
-		// course or account groups
-		if (isset($matches[9]) || isset($matches[11])) {
-			$canvasContext['context'] = 'group'; // used to for context_code in events
-			$canvasContext['id'] = ($matches[9] > $matches[11] ? $matches[9] : $matches[11]);
-			$canvasContext['verification_url'] = "groups/{$canvasContext['id']}"; // used once to look up the object to be sure it really exists
-
-		// courses
-		} elseif (isset($matches[7])) {
-			$canvasContext['context'] = 'course';
-			$canvasContext['id'] = $matches[7];
-			$canvasContext['verification_url'] = "courses/{$canvasContext['id']}";
-
-		// users
-		} elseif (isset($matches[5])) {
-			$canvasContext['context'] = 'user';
-			$canvasContext['id'] = $matches[5];
-			$canvasContext['verification_url'] = "users/{$canvasContext['id']}/profile";
-
-		// we're somewhere where we don't know where we are
-		} else {
-			return false;
-		}
-		return $canvasContext;
-	}
-	return false;
+    global $metadata;
+
+    // TODO: accept calendar2?contexts links too (they would be an intuitively obvious link to use, after all)
+    // FIXME: users aren't working
+    // TODO: it would probably be better to look up users by email address than URL
+    /* get the context (user, course or group) for the canvas URL */
+    $canvasContext = array();
+    if (preg_match('%(https?://)?(' . parse_url($metadata['CANVAS_INSTANCE_URL'], PHP_URL_HOST) . '/((about/(\d+))|(courses/(\d+)(/groups/(\d+))?)|(accounts/\d+/groups/(\d+))))%', $_REQUEST['canvas_url'], $matches)) {
+        $canvasContext['canonical_url'] = "https://{$matches[2]}"; // https://stmarksschool.instructure.com/courses/953
+
+        // course or account groups
+        if (isset($matches[9]) || isset($matches[11])) {
+            $canvasContext['context'] = 'group'; // used to for context_code in events
+            $canvasContext['id'] = ($matches[9] > $matches[11] ? $matches[9] : $matches[11]);
+            $canvasContext['verification_url'] = "groups/{$canvasContext['id']}"; // used once to look up the object to be sure it really exists
+
+        // courses
+        } elseif (isset($matches[7])) {
+            $canvasContext['context'] = 'course';
+            $canvasContext['id'] = $matches[7];
+            $canvasContext['verification_url'] = "courses/{$canvasContext['id']}";
+
+        // users
+        } elseif (isset($matches[5])) {
+            $canvasContext['context'] = 'user';
+            $canvasContext['id'] = $matches[5];
+            $canvasContext['verification_url'] = "users/{$canvasContext['id']}/profile";
+
+        // we're somewhere where we don't know where we are
+        } else {
+            return false;
+        }
+        return $canvasContext;
+    }
+    return false;
 }
 
 /**
@@ -70,22 +70,22 @@ 
  **/
 function filterEvent($event, $calendarCache) {
 
- 	return (
-	 	// include this event if filtering is off...
- 		$calendarCache['enable_regexp_filter'] == false ||
- 		(
-			(
-				( // if filtering is on, and there's an include pattern test that pattern...
-					!empty($calendarCache['include_regexp']) &&
-					preg_match("%{$calendarCache['include_regexp']}%", $event->getProperty('SUMMARY'))
-				)
-			) &&
-			!( // if there is an exclude pattern, make sure that this event is NOT excluded
-				!empty($calendarCache['exclude_regexp']) &&
-				preg_match("%{$calendarCache['exclude_regexp']}%", $event->getProperty('SUMMARY'))
-			)
-		)
-	);
+        return (
+            // include this event if filtering is off...
+            $calendarCache['enable_regexp_filter'] == false ||
+         (
+            (
+                ( // if filtering is on, and there's an include pattern test that pattern...
+                    !empty($calendarCache['include_regexp']) &&
+                    preg_match("%{$calendarCache['include_regexp']}%", $event->getProperty('SUMMARY'))
+                )
+            ) &&
+            !( // if there is an exclude pattern, make sure that this event is NOT excluded
+                !empty($calendarCache['exclude_regexp']) &&
+                preg_match("%{$calendarCache['exclude_regexp']}%", $event->getProperty('SUMMARY'))
+            )
+        )
+    );
 }
 
 // TODO: it would be nice to be able to cleanly remove a synched calendar
@@ -97,55 +97,55 @@ 
    object)? */
 if (isset($_REQUEST['cal']) && isset($_REQUEST['canvas_url'])) {
 
-	if ($canvasContext = getCanvasContext($_REQUEST['canvas_url'])) {
-		/* check ICS feed to be sure it exists */
-		if(urlExists($_REQUEST['cal'])) {
-			/* look up the canvas object -- mostly to make sure that it exists! */
-			if ($canvasObject = $api->get($canvasContext['verification_url'])) {
+    if ($canvasContext = getCanvasContext($_REQUEST['canvas_url'])) {
+        /* check ICS feed to be sure it exists */
+        if(urlExists($_REQUEST['cal'])) {
+            /* look up the canvas object -- mostly to make sure that it exists! */
+            if ($canvasObject = $api->get($canvasContext['verification_url'])) {
 
-				/* calculate the unique pairing ID of this ICS feed and canvas object */
-				$pairingHash = getPairingHash($_REQUEST['cal'], $canvasContext['canonical_url']);
-				$log = Log::singleton('file', __DIR__ . "/logs/$pairingHash.log");
-				postMessage('Sync started', getSyncTimestamp(), NotificationMessage::INFO);
+                /* calculate the unique pairing ID of this ICS feed and canvas object */
+                $pairingHash = getPairingHash($_REQUEST['cal'], $canvasContext['canonical_url']);
+                $log = Log::singleton('file', __DIR__ . "/logs/$pairingHash.log");
+                postMessage('Sync started', getSyncTimestamp(), NotificationMessage::INFO);
 
-				/* tell users that it's started and to cool their jets */
-				if (php_sapi_name() != 'cli') {
-					$smarty->assign('content', '
+                /* tell users that it's started and to cool their jets */
+                if (php_sapi_name() != 'cli') {
+                    $smarty->assign('content', '
 						<h3>Calendar Import Started</h3>
 						<p>The calendar import that you requested has begun. You may leave this page at anytime. You can see the progress of the import by visiting <a target="_blank" href="https://' . parse_url($metadata['CANVAS_INSTANCE_URL'], PHP_URL_HOST) . "/calendar?include_contexts={$canvasContext['context']}_{$canvasObject['id']}\">this calendar</a> in Canvas.</p>"
-					);
-					$smarty->display('page.tpl');
-				}
-
-				/* parse the ICS feed */
-				$ics = new vcalendar(
-					array(
-						'unique_id' => $metadata['APP_ID'],
-						'url' => $_REQUEST['cal']
-					)
-				);
-				$ics->parse();
-
-				/* log this pairing in the database cache, if it doesn't already exist */
-				$calendarCacheResponse = $sql->query("
+                    );
+                    $smarty->display('page.tpl');
+                }
+
+                /* parse the ICS feed */
+                $ics = new vcalendar(
+                    array(
+                        'unique_id' => $metadata['APP_ID'],
+                        'url' => $_REQUEST['cal']
+                    )
+                );
+                $ics->parse();
+
+                /* log this pairing in the database cache, if it doesn't already exist */
+                $calendarCacheResponse = $sql->query("
 					SELECT *
 						FROM `calendars`
 						WHERE
 							`id` = '$pairingHash'
 				");
-				$calendarCache = $calendarCacheResponse->fetch_assoc();
+                $calendarCache = $calendarCacheResponse->fetch_assoc();
 
-				/* if the calendar is already cached, just update the sync timestamp */
-				if ($calendarCache) {
-					$sql->query("
+                /* if the calendar is already cached, just update the sync timestamp */
+                if ($calendarCache) {
+                    $sql->query("
 						UPDATE `calendars`
 							SET
 								`synced` = '" . getSyncTimestamp() . "'
 							WHERE
 								`id` = '$pairingHash'
 					");
-				} else {
-					$sql->query("
+                } else {
+                    $sql->query("
 						INSERT INTO `calendars`
 							(
 								`id`,
@@ -168,46 +168,46 @@ 
 								" . ($_REQUEST['enable_regexp_filter'] == VALUE_ENABLE_REGEXP_FILTER ? "'" . $sql->real_escape_string($_REQUEST['exclude_regexp']) . "'" : 'NULL') . "
 							)
 					");
-				}
+                }
 
-				/* refresh calendar information from cache database */
-				$calendarCacheResponse = $sql->query("
+                /* refresh calendar information from cache database */
+                $calendarCacheResponse = $sql->query("
 					SELECT *
 						FROM `calendars`
 						WHERE
 							`id` = '$pairingHash'
 				");
-				$calendarCache = $calendarCacheResponse->fetch_assoc();
+                $calendarCache = $calendarCacheResponse->fetch_assoc();
 
-				/* walk through $master_array and update the Canvas calendar to match the
+                /* walk through $master_array and update the Canvas calendar to match the
 				   ICS feed, caching changes in the database */
-				// TODO: would it be worth the performance improvement to just process things from today's date forward? (i.e. ignore old items, even if they've changed...)
-				// TODO:0 the best window for syncing would be the term of the course in question, right? issue:12
-				// TODO:0 Arbitrarily selecting events in for a year on either side of today's date, probably a better system? issue:12
-				foreach ($ics->selectComponents(
-					date('Y')-1, // startYear
-					date('m'), // startMonth
-					date('d'), // startDay
-					date('Y')+1, // endYEar
-					date('m'), // endMonth
-					date('d'), // endDay
-					'vevent', // cType
-					false, // flat
-					true, // any
-					true // split
-				) as $year) {
-					foreach ($year as $month => $days) {
-						foreach ($days as $day => $events) {
-							foreach ($events as $i => $event) {
-
-								/* does this event already exist in Canvas? */
-								$eventHash = getEventHash($event);
-
-								/* if the event should be included... */
-								if (filterEvent($event, $calendarCache)) {
-
-									/* have we cached this event already? */
-									$eventCacheResponse = $sql->query("
+                // TODO: would it be worth the performance improvement to just process things from today's date forward? (i.e. ignore old items, even if they've changed...)
+                // TODO:0 the best window for syncing would be the term of the course in question, right? issue:12
+                // TODO:0 Arbitrarily selecting events in for a year on either side of today's date, probably a better system? issue:12
+                foreach ($ics->selectComponents(
+                    date('Y')-1, // startYear
+                    date('m'), // startMonth
+                    date('d'), // startDay
+                    date('Y')+1, // endYEar
+                    date('m'), // endMonth
+                    date('d'), // endDay
+                    'vevent', // cType
+                    false, // flat
+                    true, // any
+                    true // split
+                ) as $year) {
+                    foreach ($year as $month => $days) {
+                        foreach ($days as $day => $events) {
+                            foreach ($events as $i => $event) {
+
+                                /* does this event already exist in Canvas? */
+                                $eventHash = getEventHash($event);
+
+                                /* if the event should be included... */
+                                if (filterEvent($event, $calendarCache)) {
+
+                                    /* have we cached this event already? */
+                                    $eventCacheResponse = $sql->query("
 										SELECT *
 											FROM `events`
 											WHERE
@@ -216,11 +216,11 @@ 
 									");
 
 
-									/* if we already have the event cached in its current form, just update
+                                    /* if we already have the event cached in its current form, just update
 									   the timestamp */
-									$eventCache = $eventCacheResponse->fetch_assoc();
-									if ($eventCache) {
-										$sql->query("
+                                    $eventCache = $eventCacheResponse->fetch_assoc();
+                                    if ($eventCache) {
+                                        $sql->query("
 											UPDATE `events`
 												SET
 													`synced` = '" . getSyncTimestamp() . "'
@@ -228,30 +228,30 @@ 
 													`id` = '{$eventCache['id']}'
 										");
 
-									/* otherwise, add this new event and cache it */
-									} else {
-										/* multi-day event instance start times need to be changed to _this_ date */
-										$start = new DateTime(iCalUtilityFunctions::_date2strdate($event->getProperty('DTSTART')));
-										$end = new DateTime(iCalUtilityFunctions::_date2strdate($event->getProperty('DTEND')));
-										if ($event->getProperty('X-RECURRENCE')) {
-											$start = new DateTime($event->getProperty('X-CURRENT-DTSTART')[1]);
-											$end = new DateTime($event->getProperty('X-CURRENT-DTEND')[1]);
-										}
-										$start->setTimeZone(new DateTimeZone(LOCAL_TIMEZONE));
-										$end->setTimeZone(new DateTimeZone(LOCAL_TIMEZONE));
-
-										$calendarEvent = $api->post("/calendar_events",
-											array(
-												'calendar_event[context_code]' => "{$canvasContext['context']}_{$canvasObject['id']}",
-												'calendar_event[title]' => preg_replace('%^([^\]]+)(\s*\[[^\]]+\]\s*)+$%', '\\1', strip_tags($event->getProperty('SUMMARY'))),
-												'calendar_event[description]' => \Michelf\Markdown::defaultTransform(str_replace('\n', "\n\n", $event->getProperty('DESCRIPTION', 1))),
-												'calendar_event[start_at]' => $start->format(CANVAS_TIMESTAMP_FORMAT),
-												'calendar_event[end_at]' => $end->format(CANVAS_TIMESTAMP_FORMAT),
-												'calendar_event[location_name]' => $event->getProperty('LOCATION')
-											)
-										);
-
-										$sql->query("
+                                    /* otherwise, add this new event and cache it */
+                                    } else {
+                                        /* multi-day event instance start times need to be changed to _this_ date */
+                                        $start = new DateTime(iCalUtilityFunctions::_date2strdate($event->getProperty('DTSTART')));
+                                        $end = new DateTime(iCalUtilityFunctions::_date2strdate($event->getProperty('DTEND')));
+                                        if ($event->getProperty('X-RECURRENCE')) {
+                                            $start = new DateTime($event->getProperty('X-CURRENT-DTSTART')[1]);
+                                            $end = new DateTime($event->getProperty('X-CURRENT-DTEND')[1]);
+                                        }
+                                        $start->setTimeZone(new DateTimeZone(LOCAL_TIMEZONE));
+                                        $end->setTimeZone(new DateTimeZone(LOCAL_TIMEZONE));
+
+                                        $calendarEvent = $api->post("/calendar_events",
+                                            array(
+                                                'calendar_event[context_code]' => "{$canvasContext['context']}_{$canvasObject['id']}",
+                                                'calendar_event[title]' => preg_replace('%^([^\]]+)(\s*\[[^\]]+\]\s*)+$%', '\\1', strip_tags($event->getProperty('SUMMARY'))),
+                                                'calendar_event[description]' => \Michelf\Markdown::defaultTransform(str_replace('\n', "\n\n", $event->getProperty('DESCRIPTION', 1))),
+                                                'calendar_event[start_at]' => $start->format(CANVAS_TIMESTAMP_FORMAT),
+                                                'calendar_event[end_at]' => $end->format(CANVAS_TIMESTAMP_FORMAT),
+                                                'calendar_event[location_name]' => $event->getProperty('LOCATION')
+                                            )
+                                        );
+
+                                        $sql->query("
 											INSERT INTO `events`
 												(
 													`calendar`,
@@ -266,102 +266,102 @@ 
 													'" . getSyncTimestamp() . "'
 												)
 										");
-									}
-								}
-							}
-						}
-					}
-				}
-
-				/* clean out previously synced events that are no longer correct */
-				$deletedEventsResponse = $sql->query("
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+
+                /* clean out previously synced events that are no longer correct */
+                $deletedEventsResponse = $sql->query("
 					SELECT * FROM `events`
 						WHERE
 							`calendar` = '{$calendarCache['id']}' AND
 							`synced` != '" . getSyncTimestamp() . "'
 				");
-				while ($deletedEventCache = $deletedEventsResponse->fetch_assoc()) {
-					try {
-						$deletedEvent = $api->delete("/calendar_events/{$deletedEventCache['calendar_event[id]']}",
-							array(
-								'cancel_reason' => getSyncTimestamp(),
-								'as_user_id' => ($canvasContext['context'] == 'user' ? $canvasObject['id'] : '') // TODO: this feels skeevy -- like the empty string will break
-							)
-						);
-					} catch (Pest_Unauthorized $e) {
-						/* if the event has been deleted in Canvas, we'll get an error when
+                while ($deletedEventCache = $deletedEventsResponse->fetch_assoc()) {
+                    try {
+                        $deletedEvent = $api->delete("/calendar_events/{$deletedEventCache['calendar_event[id]']}",
+                            array(
+                                'cancel_reason' => getSyncTimestamp(),
+                                'as_user_id' => ($canvasContext['context'] == 'user' ? $canvasObject['id'] : '') // TODO: this feels skeevy -- like the empty string will break
+                            )
+                        );
+                    } catch (Pest_Unauthorized $e) {
+                        /* if the event has been deleted in Canvas, we'll get an error when
 						   we try to delete it a second time. We still need to delete it from
 						   our cache database, however */
-						postMessage('Cache out-of-sync', "calendar_event[{$deletedEventCache['calendar_event[id]']}] no longer exists and will be purged from cache.", NotificationMessage::INFO);
-					} catch (Pest_ClientError $e) {
-						postMessage(
-							'API Client Error',
-							'<pre>' . print_r(array(
-								'Status' => $PEST->lastStatus(),
-								'Error' => $PEST->lastBody(),
-								'Verb' => $verb,
-								'URL' => $url,
-								'Data' => $data
-							), false) . '</pre>',
-							NotificationMessage::ERROR
-						);
-						if (php_sapi_name() != 'cli') $smarty->display('page.tpl');
-						exit;
-					}
-					$sql->query("
+                        postMessage('Cache out-of-sync', "calendar_event[{$deletedEventCache['calendar_event[id]']}] no longer exists and will be purged from cache.", NotificationMessage::INFO);
+                    } catch (Pest_ClientError $e) {
+                        postMessage(
+                            'API Client Error',
+                            '<pre>' . print_r(array(
+                                'Status' => $PEST->lastStatus(),
+                                'Error' => $PEST->lastBody(),
+                                'Verb' => $verb,
+                                'URL' => $url,
+                                'Data' => $data
+                            ), false) . '</pre>',
+                            NotificationMessage::ERROR
+                        );
+                        if (php_sapi_name() != 'cli') $smarty->display('page.tpl');
+                        exit;
+                    }
+                    $sql->query("
 						DELETE FROM `events`
 							WHERE
 								`id` = '{$deletedEventCache['id']}'
 					");
-				}
+                }
 
-				/* if this was a scheduled import (i.e. a sync), update that schedule */
-				if (isset($_REQUEST['schedule'])) {
-					$sql->query("
+                /* if this was a scheduled import (i.e. a sync), update that schedule */
+                if (isset($_REQUEST['schedule'])) {
+                    $sql->query("
 						UPDATE `schedules`
 							SET
 								`synced` = '" . getSyncTimestamp() . "'
 							WHERE
 								`id` = '{$_REQUEST['schedule']}'
 					");
-				}
-				/* are we setting up a regular synchronization? */
-				if (isset($_REQUEST['sync']) && $_REQUEST['sync'] != SCHEDULE_ONCE) {
+                }
+                /* are we setting up a regular synchronization? */
+                if (isset($_REQUEST['sync']) && $_REQUEST['sync'] != SCHEDULE_ONCE) {
 
-					// FIXME:0 CRON SYNC SETUP GOES HERE issue:15 issue:13
+                    // FIXME:0 CRON SYNC SETUP GOES HERE issue:15 issue:13
 
-					/* add to the cache database schedule, replacing any schedules for this
+                    /* add to the cache database schedule, replacing any schedules for this
 					   calendar that are already there */
-					$schedulesResponse = $sql->query("
+                    $schedulesResponse = $sql->query("
 						SELECT *
 							FROM `schedules`
 							WHERE
 								`calendar` = '{$calendarCache['id']}'
 					");
 
-					if ($schedule = $schedulesResponse->fetch_assoc()) {
+                    if ($schedule = $schedulesResponse->fetch_assoc()) {
 
-						/* only need to worry if the cached schedule is different from the
+                        /* only need to worry if the cached schedule is different from the
 						   new one we just set */
-						if ($shellArguments[INDEX_SCHEDULE] != $schedule['schedule']) {
-							/* was this the last schedule to require this trigger? */
-							$schedulesResponse = $sql->query("
+                        if ($shellArguments[INDEX_SCHEDULE] != $schedule['schedule']) {
+                            /* was this the last schedule to require this trigger? */
+                            $schedulesResponse = $sql->query("
 								SELECT *
 									FROM `schedules`
 									WHERE
 										`calendar` != '{$calendarCache['id']}' AND
 										`schedule` == '{$schedule['schedule']}'
 							");
-							/* we're the last one, delete it from crontab */
-							if ($schedulesResponse->num_rows == 0) {
-								$crontabs = preg_replace("%^.*{$schedule['schedule']}.*" . PHP_EOL . '%', '', shell_exec('crontab -l'));
-								$filename = md5(getSyncTimestamp()) . '.txt';
-								file_put_contents("/tmp/$filename", $crontabs);
-								shell_exec("crontab /tmp/$filename");
-								postMessage('Unused schedule', "removed schedule '{$schedule['schedule']}' from crontab", NotificationMessage::INFO);
-							}
-
-							$sql->query("
+                            /* we're the last one, delete it from crontab */
+                            if ($schedulesResponse->num_rows == 0) {
+                                $crontabs = preg_replace("%^.*{$schedule['schedule']}.*" . PHP_EOL . '%', '', shell_exec('crontab -l'));
+                                $filename = md5(getSyncTimestamp()) . '.txt';
+                                file_put_contents("/tmp/$filename", $crontabs);
+                                shell_exec("crontab /tmp/$filename");
+                                postMessage('Unused schedule', "removed schedule '{$schedule['schedule']}' from crontab", NotificationMessage::INFO);
+                            }
+
+                            $sql->query("
 								UPDATE `schedules`
 									SET
 										`schedule` = '" . $shellArguments[INDEX_SCHEDULE] . "',
@@ -369,9 +369,9 @@ 
 									WHERE
 										`calendar` = '{$calendarCache['id']}'
 							");
-						}
-					} else {
-						$sql->query("
+                        }
+                    } else {
+                        $sql->query("
 							INSERT INTO `schedules`
 								(
 									`calendar`,
@@ -384,46 +384,46 @@ 
 									'" . getSyncTimestamp() . "'
 								)
 						");
-					}
-				}
+                    }
+                }
 
-				/* if we're ovewriting data (for example, if this is a recurring sync, we
+                /* if we're ovewriting data (for example, if this is a recurring sync, we
 				   need to remove the events that were _not_ synced this in this round */
-				if (isset($_REQUEST['overwrite']) && $_REQUEST['overwrite'] == VALUE_OVERWRITE_CANVAS_CALENDAR) {
-					// TODO: actually deal with this
-				}
-
-				// TODO: deal with messaging based on context
-
-				postMessage('Finished sync', getSyncTimestamp(), NotificationMessage::INFO);
-				exit;
-			} else {
-				postMessage(
-					'Canvas Object  Not Found',
-					'The object whose URL you submitted could not be found.<pre>' . print_r(array(
-						'Canvas URL' => $_REQUEST['canvas_url'],
-						'Canvas Context' => $canvasContext,
-						'Canvas Object' => $canvasObject
-					), false) . '</pre>',
-					NotificationMessage::ERROR
-				);
-			}
-		} else {
-			postMessage(
-				'ICS feed  Not Found',
-				'The calendar whose URL you submitted could not be found.<pre>' . $_REQUEST['cal'] . '</pre>',
-				NotificationMessage::ERROR
-			);
-		}
-	} else {
-		postMessage(
-			'Invalid Canvas URL',
-			'The Canvas URL you submitted could not be parsed.<pre>' . $_REQUEST['canvas_url'] . '</pre>',
-			NotificationMessage::ERROR
-		);
-		if (php_sapi_name() != 'cli') $smarty->display('page.tpl');
-		exit;
-	}
+                if (isset($_REQUEST['overwrite']) && $_REQUEST['overwrite'] == VALUE_OVERWRITE_CANVAS_CALENDAR) {
+                    // TODO: actually deal with this
+                }
+
+                // TODO: deal with messaging based on context
+
+                postMessage('Finished sync', getSyncTimestamp(), NotificationMessage::INFO);
+                exit;
+            } else {
+                postMessage(
+                    'Canvas Object  Not Found',
+                    'The object whose URL you submitted could not be found.<pre>' . print_r(array(
+                        'Canvas URL' => $_REQUEST['canvas_url'],
+                        'Canvas Context' => $canvasContext,
+                        'Canvas Object' => $canvasObject
+                    ), false) . '</pre>',
+                    NotificationMessage::ERROR
+                );
+            }
+        } else {
+            postMessage(
+                'ICS feed  Not Found',
+                'The calendar whose URL you submitted could not be found.<pre>' . $_REQUEST['cal'] . '</pre>',
+                NotificationMessage::ERROR
+            );
+        }
+    } else {
+        postMessage(
+            'Invalid Canvas URL',
+            'The Canvas URL you submitted could not be parsed.<pre>' . $_REQUEST['canvas_url'] . '</pre>',
+            NotificationMessage::ERROR
+        );
+        if (php_sapi_name() != 'cli') $smarty->display('page.tpl');
+        exit;
+    }
 }
 
 ?>

Spacing +4 added lines, -4 removed lines

@@ -6,7 +6,7 @@ 
 	$_REQUEST['canvas_url'] = $argv[2];
 	$_REQUEST['schedule'] = $argv[3];
 
-	define ('IGNORE_LTI', true);
+	define('IGNORE_LTI', true);
 }
 
 require_once 'common.inc.php';
@@ -99,7 +99,7 @@ 
 
 	if ($canvasContext = getCanvasContext($_REQUEST['canvas_url'])) {
 		/* check ICS feed to be sure it exists */
-		if(urlExists($_REQUEST['cal'])) {
+		if (urlExists($_REQUEST['cal'])) {
 			/* look up the canvas object -- mostly to make sure that it exists! */
 			if ($canvasObject = $api->get($canvasContext['verification_url'])) {
 
@@ -185,10 +185,10 @@ 
 				// TODO:0 the best window for syncing would be the term of the course in question, right? issue:12
 				// TODO:0 Arbitrarily selecting events in for a year on either side of today's date, probably a better system? issue:12
 				foreach ($ics->selectComponents(
-					date('Y')-1, // startYear
+					date('Y') - 1, // startYear
 					date('m'), // startMonth
 					date('d'), // startDay
-					date('Y')+1, // endYEar
+					date('Y') + 1, // endYEar
 					date('m'), // endMonth
 					date('d'), // endDay
 					'vevent', // cType

Braces +6 added lines, -2 removed lines

@@ -305,7 +305,9 @@ 
 							), false) . '</pre>',
 							NotificationMessage::ERROR
 						);
-						if (php_sapi_name() != 'cli') $smarty->display('page.tpl');
+						if (php_sapi_name() != 'cli') {
+						    $smarty->display('page.tpl');
+						}
 						exit;
 					}
 					$sql->query("
@@ -421,7 +423,9 @@ 
 			'The Canvas URL you submitted could not be parsed.<pre>' . $_REQUEST['canvas_url'] . '</pre>',
 			NotificationMessage::ERROR
 		);
-		if (php_sapi_name() != 'cli') $smarty->display('page.tpl');
+		if (php_sapi_name() != 'cli') {
+		    $smarty->display('page.tpl');
+		}
 		exit;
 	}
 }

classes/CanvasAPIviaLTI.php

Indentation +79 added lines, -79 removed lines

@@ -7,98 +7,98 @@ 
  **/	
 class CanvasAPIviaLTI extends LTI_Tool_Provider {
 	
-	/**
-	 * Handle launch requests, which start the application running
-	 **/
-	public function onLaunch() {
-		global $metadata; // FIXME:0 grown-ups don't program like this issue:17
-		global $sql; // FIXME:0 grown-ups don't program like this issue:17
+    /**
+     * Handle launch requests, which start the application running
+     **/
+    public function onLaunch() {
+        global $metadata; // FIXME:0 grown-ups don't program like this issue:17
+        global $sql; // FIXME:0 grown-ups don't program like this issue:17
 				
-		/* is this user in a role that can use this app? */
-		if ($this->user->isAdmin()) {
+        /* is this user in a role that can use this app? */
+        if ($this->user->isAdmin()) {
 			
-			/* set up any needed session variables */
-	        $_SESSION['consumer_key'] = $this->consumer->getKey();
-	        $_SESSION['resource_id'] = $this->resource_link->getId();
-	        $_SESSION['user_consumer_key'] = $this->user->getResourceLink()->getConsumer()->getKey();
-	        $_SESSION['user_id'] = $this->user->getId();
-	        $_SESSION['isStudent'] = $this->user->isLearner();
-	        $_SESSION['isContentItem'] = FALSE;	   
+            /* set up any needed session variables */
+            $_SESSION['consumer_key'] = $this->consumer->getKey();
+            $_SESSION['resource_id'] = $this->resource_link->getId();
+            $_SESSION['user_consumer_key'] = $this->user->getResourceLink()->getConsumer()->getKey();
+            $_SESSION['user_id'] = $this->user->getId();
+            $_SESSION['isStudent'] = $this->user->isLearner();
+            $_SESSION['isContentItem'] = FALSE;	   
 			
-			/* do we have an admin API access token? */
-			$haveToken = true;
-			if (empty($metadata['CANVAS_API_TOKEN'])) {
+            /* do we have an admin API access token? */
+            $haveToken = true;
+            if (empty($metadata['CANVAS_API_TOKEN'])) {
 				
-				/* ...if not, do we have a user API access token for this user? */
-				$userToken = new UserAPIToken($_SESSION['user_consumer_key'], $_SESSION['user_id'], $sql);			
-				if (empty($userToken->getToken())) {
+                /* ...if not, do we have a user API access token for this user? */
+                $userToken = new UserAPIToken($_SESSION['user_consumer_key'], $_SESSION['user_id'], $sql);			
+                if (empty($userToken->getToken())) {
 					
-					/* ...if this user has no token, let's start by getting one */
-					$haveToken = false;
-					$this->redirectURL = "{$metadata['APP_URL']}/lti/token_request.php?oauth=request";
-				} else {
+                    /* ...if this user has no token, let's start by getting one */
+                    $haveToken = false;
+                    $this->redirectURL = "{$metadata['APP_URL']}/lti/token_request.php?oauth=request";
+                } else {
 					
-					/* ...but if the user does have a token, rock on! */
-					$_SESSION['isUserToken'] = true;
-					$_SESSION['apiToken'] = $userToken->getToken();
-					//$_SESSION['apiUrl'] = $userToken->getAPIUrl();
-				}
-			} else {
+                    /* ...but if the user does have a token, rock on! */
+                    $_SESSION['isUserToken'] = true;
+                    $_SESSION['apiToken'] = $userToken->getToken();
+                    //$_SESSION['apiUrl'] = $userToken->getAPIUrl();
+                }
+            } else {
 				
-				/* ...if we have an admin API token, rock on! */
-				$_SESSION['isUserToken'] = false;
-				$_SESSION['apiToken'] = $metadata['CANVAS_API_TOKEN'];
-				//$_SESSION['apiUrl'] = $metadata['CANVAS_API_URL'];
-			}
-			$_SESSION['apiUrl'] = 'https://' . $this->user->getResourceLink()->settings['custom_canvas_api_domain'] . '/api/v1';
+                /* ...if we have an admin API token, rock on! */
+                $_SESSION['isUserToken'] = false;
+                $_SESSION['apiToken'] = $metadata['CANVAS_API_TOKEN'];
+                //$_SESSION['apiUrl'] = $metadata['CANVAS_API_URL'];
+            }
+            $_SESSION['apiUrl'] = 'https://' . $this->user->getResourceLink()->settings['custom_canvas_api_domain'] . '/api/v1';
 			
-	        /* pass control off to the app */
-	        if ($haveToken) {
-		        $this->redirectURL = "{$metadata['APP_URL']}/app.php?lti-request=launch";
-	        }
+            /* pass control off to the app */
+            if ($haveToken) {
+                $this->redirectURL = "{$metadata['APP_URL']}/app.php?lti-request=launch";
+            }
 
-		/* ...otherwise set an appropriate error message and fail */
-		} else {
-			$this->reason = 'Invalid role';
-			$this->isOK = false;
-		}
-	}
+        /* ...otherwise set an appropriate error message and fail */
+        } else {
+            $this->reason = 'Invalid role';
+            $this->isOK = false;
+        }
+    }
 	
-	/**
-	 * Handle errors created while processing the LTI request
-	 **/
-	public function onError() {
-		global $metadata; // FIXME:0 grown-ups don't program like this issue:17
+    /**
+     * Handle errors created while processing the LTI request
+     **/
+    public function onError() {
+        global $metadata; // FIXME:0 grown-ups don't program like this issue:17
 		
-		$this->redirectURL = "{$metadata['APP_URL']}/app.php?lti-request=error&reason={$this->reason}";
-	}
+        $this->redirectURL = "{$metadata['APP_URL']}/app.php?lti-request=error&reason={$this->reason}";
+    }
 	
-	/**
-	 * Handle dashboard requests (coming in LTI v2.0, I guess)
-	 **/
-	public function onDashboard() {
-		global $metadata; // FIXME:0 grown-ups don't program like this issue:17
+    /**
+     * Handle dashboard requests (coming in LTI v2.0, I guess)
+     **/
+    public function onDashboard() {
+        global $metadata; // FIXME:0 grown-ups don't program like this issue:17
 		
-		$this->redirectURL = "{$metadata['APP_URL']}/app.php?lti-request=dashboard";
-	}
+        $this->redirectURL = "{$metadata['APP_URL']}/app.php?lti-request=dashboard";
+    }
 	
-	/**
-	 * Handle configure requests (coming in LTI v2.0, I guess)
-	 **/
-	public function onConfigure() {
-		global $metadata; // FIXME:0 grown-ups don't program like this issue:17
+    /**
+     * Handle configure requests (coming in LTI v2.0, I guess)
+     **/
+    public function onConfigure() {
+        global $metadata; // FIXME:0 grown-ups don't program like this issue:17
 		
-		$this->redirectURL = "{$metadata['APP_URL']}/app.php?lti-request=configure";
-	}
+        $this->redirectURL = "{$metadata['APP_URL']}/app.php?lti-request=configure";
+    }
 	
-	/**
-	 * Handle content-item requests (that is we're a tool provider that adds a button in the content editor)
-	 **/
-	public function onContentItem() {
-		global $metadata; // FIXME:0 grown-ups don't program like this issue:17
+    /**
+     * Handle content-item requests (that is we're a tool provider that adds a button in the content editor)
+     **/
+    public function onContentItem() {
+        global $metadata; // FIXME:0 grown-ups don't program like this issue:17
 		
-		$this->redirectURL = "{$metadata['APP_URL']}/app.php?lti-request=content-item";
-	}
+        $this->redirectURL = "{$metadata['APP_URL']}/app.php?lti-request=content-item";
+    }
 }
 
 /**
@@ -107,10 +107,10 @@ 
  * @author Seth Battis <SethBattis@stmarksschool.org>
  **/
 class CanvasAPIviaLTI_Exception extends Exception {
-	const MISSING_SECRETS_FILE = 1;
-	const INVALID_SECRETS_FILE = 2;
-	const MYSQL_CONNECTION = 3;
-	const LAUNCH_REQUEST = 4;
+    const MISSING_SECRETS_FILE = 1;
+    const INVALID_SECRETS_FILE = 2;
+    const MYSQL_CONNECTION = 3;
+    const LAUNCH_REQUEST = 4;
 }
 
 ?>
\ No newline at end of file

sync.php

Indentation +4 added lines, -4 removed lines

@@ -15,15 +15,15 @@
 ");
 
 while($schedule = $schedulesResponse->fetch_assoc()) {
-	$calendarResponse = $sql->query("
+    $calendarResponse = $sql->query("
 		SELECT *
 			FROM `calendars`
 			WHERE
 				`id` = '{$schedule['calendar']}'
 	");
-	if ($calendar = $calendarResponse->fetch_assoc()) {
-		echo shell_exec('php ' . __DIR__ . '/import.php ' . $calendar['ics_url'] . ' ' . $calendar['canvas_url'] . ' ' . $schedule['id']);
-	}
+    if ($calendar = $calendarResponse->fetch_assoc()) {
+        echo shell_exec('php ' . __DIR__ . '/import.php ' . $calendar['ics_url'] . ' ' . $calendar['canvas_url'] . ' ' . $schedule['id']);
+    }
 }
 
 ?>
\ No newline at end of file

Spacing +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
 			`synced` ASC
 ");
 
-while($schedule = $schedulesResponse->fetch_assoc()) {
+while ($schedule = $schedulesResponse->fetch_assoc()) {
 	$calendarResponse = $sql->query("
 		SELECT *
 			FROM `calendars`

app.php

Indentation +1 added lines, -1 removed lines

@@ -6,7 +6,7 @@
 $smarty->assign('category', '');
 $smarty->assign('formAction', $metadata['APP_URL'] . '/import.php');
 $smarty->assign('formHidden', array(
-	'canvas_url' => $_SESSION['canvasInstanceUrl']. '/courses/' . $_SESSION['toolProvider']->user->getResourceLink()->settings['custom_canvas_course_id']
+    'canvas_url' => $_SESSION['canvasInstanceUrl']. '/courses/' . $_SESSION['toolProvider']->user->getResourceLink()->settings['custom_canvas_course_id']
 ));
 $smarty->display('course.tpl');
 

Spacing +1 added lines, -1 removed lines

@@ -6,7 +6,7 @@
 $smarty->assign('category', '');
 $smarty->assign('formAction', $metadata['APP_URL'] . '/import.php');
 $smarty->assign('formHidden', array(
-	'canvas_url' => $_SESSION['canvasInstanceUrl']. '/courses/' . $_SESSION['toolProvider']->user->getResourceLink()->settings['custom_canvas_course_id']
+	'canvas_url' => $_SESSION['canvasInstanceUrl'] . '/courses/' . $_SESSION['toolProvider']->user->getResourceLink()->settings['custom_canvas_course_id']
 ));
 $smarty->display('course.tpl');
 

visualize.php

Indentation +10 added lines, -10 removed lines

@@ -10,8 +10,8 @@ 
 $smarty->addTemplateDir(__DIR__ . '/templates');
 
 if (empty($_REQUEST['url'])) {
-	$smarty->display('visualize-form.tpl');
-	exit;
+    $smarty->display('visualize-form.tpl');
+    exit;
 }
 
 $config = new ConfigXML(__DIR__ . '/secrets.xml');
@@ -22,14 +22,14 @@ 
 
 $ics = $cache->getCache($_REQUEST['url']);
 if (empty($ics)) {
-	$ics = new vcalendar(
-		array(
-			'unique_id' => basename(__FILE__, '.php'),
-			'url' => $_REQUEST['url']
-		)
-	);
-	$ics->parse();
-	$cache->setCache($_REQUEST['url'], $ics);
+    $ics = new vcalendar(
+        array(
+            'unique_id' => basename(__FILE__, '.php'),
+            'url' => $_REQUEST['url']
+        )
+    );
+    $ics->parse();
+    $cache->setCache($_REQUEST['url'], $ics);
 }
 
 $smarty->assign('ics', $ics);

Spacing +1 added lines, -1 removed lines

@@ -33,5 +33,5 @@
 }
 
 $smarty->assign('ics', $ics);
-$smarty->assign('veventProperties', array('unique' => array('CLASS','CREATED','SUMMARY','DESCRIPTION','DTSTART','X-CURRENT-DTSTART','DTEND','X-CURRENT-DTEND','DURATION','GEO','LAST-MOD','LOCATION','ORGANIZER','PRIORITY','DTSTAMP','SEQ','STATUS','TRANSP','UID','URL','RECURID'),'multiple'=>array('ATTACH','ATTENDEE','CATEGORIES','COMMENT','CONTACT','EXDATE','EXRULE','RSTATUS','RELATED','RESOURCES','RDATE','RRULE','X-PROP')));
+$smarty->assign('veventProperties', array('unique' => array('CLASS', 'CREATED', 'SUMMARY', 'DESCRIPTION', 'DTSTART', 'X-CURRENT-DTSTART', 'DTEND', 'X-CURRENT-DTEND', 'DURATION', 'GEO', 'LAST-MOD', 'LOCATION', 'ORGANIZER', 'PRIORITY', 'DTSTAMP', 'SEQ', 'STATUS', 'TRANSP', 'UID', 'URL', 'RECURID'), 'multiple'=>array('ATTACH', 'ATTENDEE', 'CATEGORIES', 'COMMENT', 'CONTACT', 'EXDATE', 'EXRULE', 'RSTATUS', 'RELATED', 'RESOURCES', 'RDATE', 'RRULE', 'X-PROP')));
 $smarty->display('visualize.tpl');
\ No newline at end of file

common.inc.php

Indentation +97 added lines, -97 removed lines

@@ -18,8 +18,8 @@ 
  * @return boolean
  **/
 function midLaunch() {
-	global $metadata; // FIXME:0 grown-ups don't program like this issue:17
-	return $metadata['APP_LAUNCH_URL'] === (($_SERVER['HTTPS'] === 'on' ? 'https://' : 'http://') . $_SERVER['SERVER_NAME'] . $_SERVER['REQUEST_URI']);
+    global $metadata; // FIXME:0 grown-ups don't program like this issue:17
+    return $metadata['APP_LAUNCH_URL'] === (($_SERVER['HTTPS'] === 'on' ? 'https://' : 'http://') . $_SERVER['SERVER_NAME'] . $_SERVER['REQUEST_URI']);
 }
 
 /**
@@ -31,22 +31,22 @@ 
  * @throws CanvasAPIviaLTI_Exception INVALID_SECRETS_FILE if the SECRETS_FILE exists, but cannot be parsed
  **/
 function initSecrets() {
-	if (file_exists(SECRETS_FILE)) {
-		// http://stackoverflow.com/a/24760909 (oy!)
-		if (($secrets = simplexml_load_string(file_get_contents(SECRETS_FILE))) !== false) {
-			return $secrets;
-		} else {
-			throw new CanvasAPIviaLTI_Exception(
-				SECRETS_FILE . ' could not be loaded. ',
-				CanvasAPIviaLTI_Exception::INVALID_SECRETS_FILE
-			);
-		}
-	} else {
-		throw new CanvasAPIviaLTI_Exception(
-			SECRETS_FILE . " could not be found.",
-			CanvasAPIviaLTI_Exception::MISSING_SECRETS_FILE
-		);
-	}
+    if (file_exists(SECRETS_FILE)) {
+        // http://stackoverflow.com/a/24760909 (oy!)
+        if (($secrets = simplexml_load_string(file_get_contents(SECRETS_FILE))) !== false) {
+            return $secrets;
+        } else {
+            throw new CanvasAPIviaLTI_Exception(
+                SECRETS_FILE . ' could not be loaded. ',
+                CanvasAPIviaLTI_Exception::INVALID_SECRETS_FILE
+            );
+        }
+    } else {
+        throw new CanvasAPIviaLTI_Exception(
+            SECRETS_FILE . " could not be found.",
+            CanvasAPIviaLTI_Exception::MISSING_SECRETS_FILE
+        );
+    }
 }
 
 /**
@@ -59,28 +59,28 @@ 
  * @throws CanvasAPIviaLTI_Exception MYSQL_CONNECTION if a mysqli connection cannot be established
  **/
 function initMySql() {
-	global $secrets; // FIXME:0 grown-ups don't program like this issue:17
-	if (!($secrets instanceof SimpleXMLElement)) {
-		$secrets = initSecrets();
-	}
-
-	/* turn off warnings, since we're going to test the connection ourselves */
-	set_error_handler(function() {});
-	$sql = new mysqli(
-		(string) $secrets->mysql->host,
-		(string) $secrets->mysql->username,
-		(string) $secrets->mysql->password,
-		(string) $secrets->mysql->database
-	);
-	restore_error_handler();
-
-	if ($sql->connect_error) {
-		throw new CanvasAPIviaLTI_Exception(
-			$sql->connect_error,
-			CanvasAPIviaLTI_Exception::MYSQL_CONNECTION
-		);
-	}
-	return $sql;
+    global $secrets; // FIXME:0 grown-ups don't program like this issue:17
+    if (!($secrets instanceof SimpleXMLElement)) {
+        $secrets = initSecrets();
+    }
+
+    /* turn off warnings, since we're going to test the connection ourselves */
+    set_error_handler(function() {});
+    $sql = new mysqli(
+        (string) $secrets->mysql->host,
+        (string) $secrets->mysql->username,
+        (string) $secrets->mysql->password,
+        (string) $secrets->mysql->database
+    );
+    restore_error_handler();
+
+    if ($sql->connect_error) {
+        throw new CanvasAPIviaLTI_Exception(
+            $sql->connect_error,
+            CanvasAPIviaLTI_Exception::MYSQL_CONNECTION
+        );
+    }
+    return $sql;
 }
 
 /**
@@ -89,12 +89,12 @@ 
  * @return \Battis\AppMetadata
  **/
 function initAppMetadata() {
-	global $secrets; // FIXME:0 grown-ups don't program like this issue:17
-	global $sql; // FIXME:0 grown-ups don't program like this issue:17
+    global $secrets; // FIXME:0 grown-ups don't program like this issue:17
+    global $sql; // FIXME:0 grown-ups don't program like this issue:17
 
-	$metadata = new AppMetadata($sql, (string) $secrets->app->id);
+    $metadata = new AppMetadata($sql, (string) $secrets->app->id);
 
-	return $metadata;
+    return $metadata;
 }
 
 /**
@@ -105,9 +105,9 @@ 
  * @return void
  **/
 function html_var_dump($var) {
-	echo '<pre>';
-	var_dump($var);
-	echo '</pre>';
+    echo '<pre>';
+    var_dump($var);
+    echo '</pre>';
 }
 
 /*****************************************************************************
@@ -121,68 +121,68 @@ 
 
 /* preliminary interactive only initialization */
 if (php_sapi_name() != 'cli') {
-	session_start();
+    session_start();
 
-	/* fire up the templating engine for interactive scripts */
-	$smarty = StMarksSmarty::getSmarty();
-	$smarty->addTemplateDir(__DIR__ . '/templates', 'starter-canvas-api-via-lti');
-	$smarty->setFramed(true);
+    /* fire up the templating engine for interactive scripts */
+    $smarty = StMarksSmarty::getSmarty();
+    $smarty->addTemplateDir(__DIR__ . '/templates', 'starter-canvas-api-via-lti');
+    $smarty->setFramed(true);
 }
 
 /* initialization that needs to happen for interactive and CLI scripts */
 try {
-	/* initialize global variables */
-	$secrets = initSecrets();
-	$sql = initMySql();
-	$metadata = initAppMetadata();
+    /* initialize global variables */
+    $secrets = initSecrets();
+    $sql = initMySql();
+    $metadata = initAppMetadata();
 } catch (CanvasAPIviaLTI_Exception $e) {
-	if (php_sapi_name() == 'cli') {
-		echo 'Initialization Failure [' . $e->getCode() . ']' . PHP_EOL . $e->getMessage() . PHP_EOL;
-		exit;
-	} else {
-		$smarty->addMessage(
-			'Initialization Failure [' . $e->getCode() . ']',
-			$e->getMessage(),
-			NotificationMessage::ERROR
-		);
-		$smarty->display();
-		exit;
-	}
+    if (php_sapi_name() == 'cli') {
+        echo 'Initialization Failure [' . $e->getCode() . ']' . PHP_EOL . $e->getMessage() . PHP_EOL;
+        exit;
+    } else {
+        $smarty->addMessage(
+            'Initialization Failure [' . $e->getCode() . ']',
+            $e->getMessage(),
+            NotificationMessage::ERROR
+        );
+        $smarty->display();
+        exit;
+    }
 }
 
 /* interactive initialization only */
 if ($ready && php_sapi_name() != 'cli') {
 
-	/* allow web apps to use common.inc.php without LTI authentication */
-	if (!defined('IGNORE_LTI')) {
-
-		try {
-			if (midLaunch()) {
-				$ready = false;
-			} elseif (isset($_SESSION['toolProvider'])) {
-				$toolProvider = $_SESSION['toolProvider'];
-			} else {
-				throw new CanvasAPIviaLTI_Exception(
-					'The LTI launch request is missing',
-					CanvasAPIviaLTI_Exception::LAUNCH_REQUEST
-				);
-			}
-
-		} catch (CanvasAPIviaLTI_Exception $e) {
-			$ready = false;
-		}
-	}
-
-	if ($ready) {
-		$smarty->addStylesheet($metadata['APP_URL'] . '/css/canvas-api-via-lti.css', 'starter-canvas-api-via-lti');
-		$smarty->addStylesheet($metadata['APP_URL'] . '/css/app.css');
-
-		if (!midLaunch() || !defined('IGNORE_LTI')) {
-			require_once(__DIR__ . '/common-app.inc.php');
-		}
-	}
+    /* allow web apps to use common.inc.php without LTI authentication */
+    if (!defined('IGNORE_LTI')) {
+
+        try {
+            if (midLaunch()) {
+                $ready = false;
+            } elseif (isset($_SESSION['toolProvider'])) {
+                $toolProvider = $_SESSION['toolProvider'];
+            } else {
+                throw new CanvasAPIviaLTI_Exception(
+                    'The LTI launch request is missing',
+                    CanvasAPIviaLTI_Exception::LAUNCH_REQUEST
+                );
+            }
+
+        } catch (CanvasAPIviaLTI_Exception $e) {
+            $ready = false;
+        }
+    }
+
+    if ($ready) {
+        $smarty->addStylesheet($metadata['APP_URL'] . '/css/canvas-api-via-lti.css', 'starter-canvas-api-via-lti');
+        $smarty->addStylesheet($metadata['APP_URL'] . '/css/app.css');
+
+        if (!midLaunch() || !defined('IGNORE_LTI')) {
+            require_once(__DIR__ . '/common-app.inc.php');
+        }
+    }
 } elseif (php_sapi_name() == 'cli') {
-	require_once(__DIR__ . '/common-app.inc.php');
+    require_once(__DIR__ . '/common-app.inc.php');
 }
 
 

admin/install-app.inc.php

Indentation +3 added lines, -3 removed lines

@@ -29,9 +29,9 @@
 $metadata['USER_NAVIGATION_LINK_TEXT'] = '@ACCOUNT_NAVIGATION_LINK_TEXT';
 
 $smarty->addMessage(
-	'App metadata updated',
-	'Application metadata has been updated to create config.xml',
-	NotificationMessage::GOOD
+    'App metadata updated',
+    'Application metadata has been updated to create config.xml',
+    NotificationMessage::GOOD
 );
 
 ?>