Merge pull request #28 from bbertucc/mvp-1

🐣 MVP 1

Author: Blake Bertuccelli

actions/add_site.php

@@ -4,12 +4,6 @@
 require_once '../config.php';
 require_once '../models/adders.php';
 require_once '../models/db.php';
-$db = connect(
-    DB_HOST, 
-    DB_USERNAME,
-    DB_PASSWORD,
-    DB_NAME
-);
 
 // We don't validate the URLs here because cURL does
 // a better job of validating/redirecting in the adders.
@@ -37,7 +31,7 @@
     $status = 'active';
     $site = $curled_site['url'];
     $is_parent = 1;
-    add_page($db, $site_url, $type, $status, $site, $is_parent );
+    DataAccess::add_page($site_url, $type, $status, $site, $is_parent );
 
 // WordPress and XML deals with adding pages similarly,
 // so their functions are wrapped in one condition.
@@ -56,7 +50,7 @@
     $site_url = $curled_site['url'];
 
     // We're setting the status and adding pages here so we
-    // do not have to call the $db inside "models/adders.php",
+    // do not have to call the db inside "models/adders.php",
     // keeping each model focused on distinct functions.
     $pages_records = [];
     foreach ($pages as &$page):
@@ -98,7 +92,7 @@
     }
 
     // Finalllly, we can add pages to the DB.
-    add_pages($db, $pages_records);
+    DataAccess::add_pages($pages_records);
 
 // Since we're passing type through a URL, we have a fallback
 // in case someone passes an unsupported 'type'. 

actions/delete_alert.php

@@ -2,12 +2,6 @@
 // Info on DB must be declared to use db.php models.
 require_once '../config.php';
 require_once '../models/db.php';
-$db = connect(
-    DB_HOST, 
-    DB_USERNAME,
-    DB_PASSWORD,
-    DB_NAME
-);
 
 // Get URL parameters.
 $id = filter_input(INPUT_GET, 'id', FILTER_VALIDATE_INT);
@@ -24,7 +18,7 @@
     'name'  => 'id',
     'value' => $id
 )];
-delete_alerts($db, $filters);
+DataAccess::delete_alerts($filters);
 
 // When the work is done, we can triumphantly return to
 // wherever we came from.

actions/install.php

@@ -1,25 +1,19 @@
 <?php
 // Info on DB must be declared to use db.php models.
 require_once 'models/db.php';
-$db = connect(
-    DB_HOST, 
-    DB_USERNAME,
-    DB_PASSWORD,
-    DB_NAME
-);
 
 // All the tables are created with this action.
-if(table_exists($db, 'alerts') == false)
-    create_alerts_table($db);
-if(table_exists($db, 'pages') == false)
-    create_pages_table($db);
-if(table_exists($db, 'scans') == false)
-    create_scans_table($db);
-if(table_exists($db, 'meta') == false){
-    create_meta_table($db);
+if(DataAccess::table_exists('alerts') == false)
+    DataAccess::create_alerts_table();
+if(DataAccess::table_exists('pages') == false)
+    DataAccess::create_pages_table();
+if(DataAccess::table_exists('scans') == false)
+    DataAccess::create_scans_table();
+if(DataAccess::table_exists('meta') == false){
+    DataAccess::create_meta_table();
 
-    // We need to add some meta to initialize the table
-    // since we don't use the INSERT statement anywhere.
-    add_meta($db, 'usage', 0);
+// We need to add some meta to initialize the table
+// since we don't use the INSERT statement anywhere.
+DataAccess::add_meta('usage', 0);
 
 }

actions/scan_all_pages.php

@@ -5,23 +5,18 @@
 require_once '../models/db.php';
 require_once '../models/view_components.php';
 require_once '../models/integrations.php';
-$db = connect(
-    DB_HOST, 
-    DB_USERNAME,
-    DB_PASSWORD,
-    DB_NAME
-);
+
 
 // Setup queries to minize db calls.
-$meta = get_meta($db);
+$meta = DataAccess::get_meta();
 $page_filters = [
     array(
         'name'  => 'status',
         'value' => 'active'
     ),
 ];
-$active_page_ids = get_page_ids($db, $page_filters);
-$active_pages = get_pages($db, $page_filters);
+$active_page_ids = DataAccess::get_page_ids($page_filters);
+$active_pages = DataAccess::get_pages($page_filters);
 $uploaded_integrations = uploaded_integrations('../integrations');
 
 // Make sure there are pages to scan.
@@ -30,8 +25,8 @@
 
 // Adding a scan to display a running task before scans complete.
 if( $_GET['action'] == 'add_scan' ){
-    add_scan($db, 'running', $active_page_ids);
-    $scans = get_scans($db);
+    DataAccess::add_scan('running', $active_page_ids);
+    $scans = DataAccess::get_scans();
     the_scan_rows($scans);
 }
 
@@ -66,17 +61,14 @@
                     try {
                         $integration_scan_function_name($page, $meta);
 
-                        // Only successful scans get their timestamp updated.
-                        update_page_scanned_time($db, $page->id);
-
                     } catch (Exception $x) {
 
                         // We will kill the scan and alert folks of any errors, but
                         // we will also record the successful scans that occured.
-                        update_usage_meta($db, $pages_count);
-                        add_integration_alert($db, $x->getMessage());
-                        update_scan_status($db, 'running', 'incomplete');
-                        $scans = get_scans($db);
+                        DataAccess::update_usage_meta($pages_count);
+                        DataAccess::add_integration_alert($x->getMessage());
+                        DataAccess::update_scan_status('running', 'incomplete');
+                        $scans = DataAccess::get_scans();
                         the_scan_rows($scans);
                         die;
 
@@ -86,6 +78,9 @@
 
             }
         }
+
+        // Successful scans get a timestamp.
+        DataAccess::update_page_scanned_time($page->id);
 
     }    
 
@@ -94,18 +89,18 @@
     // pages.
     $pages_count = count($active_page_ids);
 
-    update_usage_meta($db, $pages_count);
-    update_scan_status($db, 'running', 'complete');
+    DataAccess::update_usage_meta($pages_count);
+    DataAccess::update_scan_status('running', 'complete');
 
     // Scan info is passed to JSON on the view, so that we can do 
     // async scans.
-    $scans = get_scans($db);
+    $scans = DataAccess::get_scans();
     the_scan_rows($scans);
 
 }
 
 // This changes the little red number asyncronistically with JS
 // embedded in the view file.
 if( $_GET['action'] == 'get_alerts' ){
-    echo count(get_alerts($db));
+    echo count(DataAccess::get_alerts());
 }

actions/toggle_integration_status.php

@@ -3,12 +3,6 @@
 require_once '../config.php';
 require_once '../models/integrations.php';
 require_once '../models/db.php';
-$db = connect(
-    DB_HOST, 
-    DB_USERNAME,
-    DB_PASSWORD,
-    DB_NAME
-);
 
 // Get URL parameters.
 $uri = $_GET['uri'];
@@ -32,7 +26,7 @@
             'value'  =>  $uri
         )
     ];
-    delete_alerts($db, $alerts_filter);
+    DataAccess::delete_alerts($alerts_filter);
 
     // Remove fields.
     $integration_fields = get_integration_fields($uri);
@@ -42,16 +36,16 @@
         // Delete "meta" fields.
         if( !empty($integration_db_fields['meta']) ){
             foreach($integration_db_fields['meta'] as $integration_meta_field){
-                if(db_column_exists($db, 'meta', $integration_meta_field['name']))
-                    delete_db_column($db, 'meta', $integration_meta_field['name']);
+                if(DataAccess::db_column_exists('meta', $integration_meta_field['name']))
+                    DataAccess::delete_db_column('meta', $integration_meta_field['name']);
             }
         }
 
         // Delete "pages" fields.
         if( !empty($integration_db_fields['pages']) ){
             foreach($integration_db_fields['pages'] as $integration_pages_field){
-                if(db_column_exists($db, 'pages', $integration_pages_field['name']))
-                    delete_db_column($db, 'pages', $integration_pages_field['name']);
+                if(DataAccess::db_column_exists('pages', $integration_pages_field['name']))
+                    DataAccess::delete_db_column('pages', $integration_pages_field['name']);
             }
         }
 
@@ -70,16 +64,16 @@
         // Setup "meta" fields.
         if( !empty($integration_db_fields['meta']) ){
             foreach($integration_db_fields['meta'] as $integration_meta_field){
-                if(!db_column_exists($db, 'meta', $integration_meta_field['name']))
-                    add_db_column($db, 'meta', $integration_meta_field['name'], $integration_meta_field['type']);
+                if(!DataAccess::db_column_exists('meta', $integration_meta_field['name']))
+                    DataAccess::add_db_column('meta', $integration_meta_field['name'], $integration_meta_field['type']);
             }
         }
 
         // Setup "pages" fields.
         if( !empty($integration_db_fields['pages']) ){
             foreach($integration_db_fields['pages'] as $integration_pages_field){
-                if(!db_column_exists($db, 'pages', $integration_pages_field['name']))
-                    add_db_column($db, 'pages', $integration_pages_field['name'], $integration_pages_field['type']);
+                if(!DataAccess::db_column_exists('pages', $integration_pages_field['name']))
+                    DataAccess::add_db_column('pages', $integration_pages_field['name'], $integration_pages_field['type']);
             }
         }
 

actions/toggle_page_status.php

@@ -3,13 +3,6 @@
 require_once '../config.php';
 require_once '../models/db.php';
 
-$db = connect(
-    DB_HOST, 
-    DB_USERNAME,
-    DB_PASSWORD,
-    DB_NAME
-);
-
 // Get URL variables and fallbacks.
 $id = filter_input(INPUT_GET, 'id', FILTER_VALIDATE_INT);
 if(empty($id))
@@ -19,9 +12,9 @@
     throw new Exception('Status is not specfied for page "'.$id.'"');
 
 // Toggle page status.
-$site = get_page($db, $id)->site;
+$site = DataAccess::get_page($id)->site;
 if($old_status == 'active'){
-    update_site_status($db, $site, 'archived');
+    DataAccess::update_site_status($site, 'archived');
 
     // Alerts are deleted when a page is archived.
     $filters = [
@@ -30,11 +23,11 @@
             'value' => $site
         )
     ];
-    delete_alerts($db, $filters);
+    DataAccess::delete_alerts($filters);
 
 }
 if($old_status == 'archived'){
-    update_site_status($db, $site, 'active');
+    DataAccess::update_site_status($site, 'active');
 }
 
 // Redirect

actions/update_meta.php

@@ -2,12 +2,6 @@
 // Add DB Info
 require_once '../config.php';
 require_once '../models/db.php';
-$db = connect(
-    DB_HOST, 
-    DB_USERNAME,
-    DB_PASSWORD,
-    DB_NAME
-);
 
 // We need the last view, so we can redirect on success.
 if(!empty($_POST['last_view'])){
@@ -33,5 +27,5 @@
 };
 
 // Time to update meta and redirect!
-update_meta($db, $account_records);
+DataAccess::update_meta($account_records);
 header('Location: ../index.php?view='.$last_view.'&status=success');

index.php

@@ -6,13 +6,6 @@
 require_once 'models/view_components.php';
 require_once 'models/integrations.php';
 
-// Setup DB Connection
-$db = connect(
-    DB_HOST, 
-    DB_USERNAME,
-    DB_PASSWORD,
-    DB_NAME
-);
 $records = [];
 ?>
 
@@ -56,7 +49,7 @@
                         <span class="badge bg-danger float-end">
                             <span id="alert_count">
 
-                                <?php echo count(get_alerts($db));?>
+                                <?php echo count(DataAccess::get_alerts());?>
 
                             </span>
                         </span>
@@ -84,12 +77,12 @@
             <?php
             // As soon as you use Equalify, you know the toll
             // you will be asked to support the service.
-            if(!empty(get_meta($db)->usage)):
+            if(!empty(DataAccess::get_meta()->usage)):
             ?>
 
             <div class="border-top mt-3 pt-3">
                 <p>
-                    🎉 <strong><?php echo get_meta($db)->usage;?> pages scanned.</strong>
+                    🎉 <strong><?php echo DataAccess::get_meta()->usage;?> pages scanned.</strong>
                 </p>
                 <p>
                 <script type="text/javascript" defer src="https://donorbox.org/install-popup-button.js"></script>

integrations/little_forrest/functions.php

@@ -2,7 +2,7 @@
 /**
  * Name: Little Forrest
  * Description: Counts WCAG 2.1 errors and links to page reports.
- * Status: Disabled
+ * Status: Active
  */
 
 /**
@@ -40,12 +40,6 @@ function little_forrest_scans($page, $meta){
     // Add DB info and required functions.
     require_once '../config.php';
     require_once '../models/db.php';
-    $db = connect(
-        DB_HOST, 
-        DB_USERNAME,
-        DB_PASSWORD,
-        DB_NAME
-    );
 
     // Get Little Forrest data.
     $override_https = array(
@@ -82,13 +76,13 @@ function little_forrest_scans($page, $meta){
             'value'  =>  'little_forrest'
         )
     ];
-    delete_alerts($db, $alerts_filter);
+    DataAccess::delete_alerts($alerts_filter);
 
     // Set optional alerts.
     if($little_forrest_errors >= 1)
-        add_page_alert($db, $page->id, $page->site,'little_forrest', 'WCAG 2.1 page errors found! See <a href="https://inspector.littleforest.co.uk/InspectorWS/Inspector?url='.$page->url.'&lang=auto&cache=false" target="_blank">Little Forrest report</a>.');
+        DataAccess::add_page_alert($page->id, $page->site,'little_forrest', 'WCAG 2.1 page errors found! See <a href="https://inspector.littleforest.co.uk/InspectorWS/Inspector?url='.$page->url.'&lang=auto&cache=false" target="_blank">Little Forrest report</a>.');
 
     // Update page data.
-    update_page_data($db, $page->id, 'little_forrest_wcag_2_1_errors', $little_forrest_errors);
+    DataAccess::update_page_data($page->id, 'little_forrest_wcag_2_1_errors', $little_forrest_errors);
 
 }