Merge pull request #428 from ucfopen/issue/426-admin-panel-option

Add feature flag for admin panel. Fixes #426

Author: bagofarms

HEROKU.md

@@ -21,6 +21,7 @@ After clicking the Heroku button above:
 6. (optional) Copy and paste your Google/YouTube API key into the `GOOGLE_API_KEY` field.
 7. (optional) Copy and paste your Vimeo API key into the `VIMEO_API_KEY` field.
 8. (optional) If you have a Google Analytics account, you can paste your site tracking code into the `GA_TRACKING_CODE` field.
+9. (optional) If you would like to enable the Admin Panel, change the `ADMIN_PANEL_ENABLED` field to `true`.
 8. Click the Deploy button and wait for the process to complete.
 
 ### Step 3:  Request a Developer Key

README.md

@@ -179,6 +179,9 @@ If you do not provide a Vimeo API key, a warning log will be recorded in `config
 ### Google Analytics
 If you would like to use Google Analytics for tracking usage of UDOIT, create a new tracking code and add it to `config/localConfig.php` in the `define('GA_TRACKING_CODE', '');` statement.  For example, if your tracking code is `UA-12345678-1`, that line should look like `define('GA_TRACKING_CODE', 'UA-12345678-1');` when you're done.
 
+### Admin Panel
+As of 2.5.0, the admin panel is still an experimental feature.  Consider it a first draft of what we'd like it to be.  It lets you view reports across your institution, generate statistics about reports and user growth, and administer user accounts.  This feature is disabled by default.  To enable it, change `$admin_panel_enabled` to `true`.
+
 ### Installing the LTI in Canvas
 Log into Canvas to add UDOIT:
 

app.json

@@ -73,6 +73,10 @@
     "ALT_TEXT_LENGTH_LIMIT": {
       "description": "Maximum character length for alt-text before the item gets flagged as a warning.",
       "value": "125"
+    },
+    "ADMIN_PANEL_ENABLED": {
+      "description": "Enable the Admin Panel feature.  False disables access and removes the block from the configuration XML.",
+      "value": "false"
     }
   },
   "addons": [

config/herokuConfig.php

@@ -68,3 +68,6 @@
 // Sets CURLOPT_SSL_VERIFYPEER and CURLOPT_SSL_VERIFYHOST
 // This should be true for production environments
 $curl_ssl_verify = true;
+
+// Admin panel.  False disables access and removes block from XML.
+$admin_panel_enabled = (getenv("ADMIN_PANEL_ENABLED")) == 'true';

config/localConfig.template.php

@@ -71,3 +71,17 @@
 // For use while developing with self-signed SSL Certificates
 // Sets CURLOPT_SSL_VERIFYPEER and CURLOPT_SSL_VERIFYHOST
 $curl_ssl_verify = true; // This should be true for production environments
+
+
+/* Admin Panel
+ *
+ * True adds a Admin Navigation placement to the XML. Allows for generating
+ * statistics about usage of UDOIT. Also allows for user administration.
+ *
+ * False disables access and removes block from XML. Use this setting if you
+ * are in a multitenant environment, as the 2.5.0 release of UDOIT does not
+ * separate data between instances of Canvas.
+ *
+ * Default false
+ */
+$admin_panel_enabled = false;

config/localConfig.test.php

@@ -55,6 +55,8 @@
 // This should be true for production environments
 $curl_ssl_verify = true;
 
+$admin_panel_enabled = true;
+
 // send logs into the phpunit output
 $log_handler = new \Monolog\Handler\TestHandler(null, \Monolog\Logger::WARNING);
 $log_handler->setFormatter(new \Monolog\Formatter\LineFormatter(null, null, true, true));

public/admin.php

@@ -30,6 +30,10 @@
         UdoitUtils::instance()->exitWithPageError("Missing Session information. Please refresh the page. Missing: {$key}");
     }
 }
+// If the feature has been disabled, deny access.
+if (!$admin_panel_enabled) {
+    UdoitUtils::instance()->exitWithPageError("This feature has been disabled. Please contact your UDOIT administrator.");
+}
 
 // If Administrator is not found in the user's list of roles, kick them out with an error
 if (!$_SESSION['is_admin']) {

public/udoit.xml.php

@@ -57,11 +57,13 @@
 			<lticm:property name="text"><?= $canvas_nav_item_name ? $canvas_nav_item_name : 'UDOIT' ?></lticm:property>
 			<lticm:property name="enabled">true</lticm:property>
 		</lticm:options>
+<?php if ($admin_panel_enabled): ?>
 		<lticm:options name="account_navigation">
 			<lticm:property name="enabled">true</lticm:property>
 			<lticm:property name="url"><?= $launch ?>?d=admin</lticm:property>
 			<lticm:property name="text"><?= $canvas_nav_item_name ? $canvas_nav_item_name : 'UDOIT' ?> Admin</lticm:property>
 		</lticm:options>
+<?php endif; ?>
 	</blti:extensions>
 	<cartridge_bundle identifierref="BLTI001_Bundle"/>
 	<cartridge_icon identifierref="BLTI001_Icon"/>