Merge pull request #78 from bbertucc/mvp-1.2

MVP 1.2

Author: Blake Bertuccelli

.gitignore

@@ -1,4 +1,6 @@
 .DS_Store
 .vscode
 login/
-config.php
+config.php
+vendor/
+test/

README.md

@@ -1,63 +1,54 @@
 # Equalify the web!
 
-**96.8% of homepages are inaccessible**, according to [WebAIM](https://webaim.org/projects/million/).
+**96.8% of homepages have WCAG conformance failures,** according to [WebAIM](https://webaim.org/projects/million/).
 
-That statistic is unacceptable.
-
-Everyone should have access to online information.
+The internet must become more accessible!
 
 ## Support Equalify
 
-⭐ Star the repo to show your support.
-
-⬇️ [Download and use](https://github.com/bbertucc/equalify#download-and-use) Equalify.
+⭐ **Star the repo** to show your support.
 
-🛠️ Contribute with a pull request or [new issue](https://github.com/bbertucc/equalify/issues).
+🌸 **Try our managed service**, [equalify.app](https://equalify.app/).
 
-## How will Equalify increase accessibility?
+🛠️ **Contribute a pull request** or [new issue](https://github.com/bbertucc/equalify/issues).
 
-Equalify creates deep integrations with services that run your website. 
+🎩 **[Donate](https://equalify.app/donate/)** to Equalify.
 
-Imagine: You solve A11Y issues at their source - be that source the server or a CMS. 
+## How will Equalify increase content accessibility?
 
-Equalify will become your WebOps hub, designed to solve any accessibility issue. 
+Equalify aims to:
+1. **Promote transparency** with a Open Source A11Y platform (✅ Done!).
+2. **Reduce the cost** of multi-page website scans (ongoing).
+3. **Improve automation** to simplify WCAG issue resolution (2023). 
 
-<img width="1375" alt="A screenshot of Equalify's Integrations page." src="https://user-images.githubusercontent.com/46652/185225047-9c1c2e0f-4c4d-490b-a253-f3172710f1b0.png">
+We will tackle these goals by integrating with existing web services, making Equalify your WebOps hub. 
 
+![equalify-integrations](https://user-images.githubusercontent.com/46652/188710874-e53ccb85-f542-46f3-a680-837aaf02ae92.png)
 
 ## What does Equalify currently do?
 
-The app currently scans pages for WCAG errors.
-
-Equalify supports [Little Forest](https://littleforest.co.uk/feature/web-accessibility/), a free WCAG 2.1 scan, and the popular [WAVE scan](https://wave.webaim.org/). 
+The app currently scans websites for WCAG errors.
 
-After selecting an integration, import any site.
+You can import pages from WordPress, XML sitemaps, and single URLs. Equalify then crawls all your pages for WCAG 2.1 errors using the popular [WAVE scan](https://wave.webaim.org/).
 
-The app imports pages from XML sitemaps, the WordPress API, and single URLs.
+Every alert is reported on a filterable dashboard.
 
-After all your pages are added, click "Scan" and Equalify reports WCAG errors as they are found.
-
-The goal: **Equalify every website.**
-
-![equalify-screenshot-1](https://user-images.githubusercontent.com/46652/185225467-de1114fc-8f96-4b41-8365-897de3b55d5f.png)
+![equalify-alerts](https://user-images.githubusercontent.com/46652/188710908-9bfb7da8-68ff-490c-8d6b-f9ce1f38d4c8.png)
 
 ## Download and Use
 1. Download or clone [the latest release](https://github.com/bbertucc/equalify/releases).
 2. Change `sample-config.php` to `config.php` and update info.
-3. Upload/run on a Linux server (PHP 8 + MySQL required).
-4. Report [issues](https://github.com/bbertucc/equalify/issues), questions, and patches.
-5. Checkout our [demo video](https://www.youtube.com/watch?v=yrsG32G3I0g) for usage tips.
-6. Report [issues](https://github.com/bbertucc/equalify/issues), questions, and patches.
+3. Run `composer install` to install Composer dependencies.
+4. Upload/run on a Linux server (PHP 8 + MySQL required).
+5. Report [issues](https://github.com/bbertucc/equalify/issues), questions, and patches.
 
-Not a technical user? Signup for our early access program at [equalify.app](https://equalify.app/).
+**Not a technical user?** Use Equalify now at [equalify.app](https://equalify.app/).
 
 ## Special Thanks
-A chaos wizard 🧙 and many brilliant brains help Equalify. Special shoutout to [Pantheon](https://pantheon.io/) and [Little Forest](https://littleforest.co.uk/feature/web-accessibility/) for providing funding for Drupalcon tickets and other great resources that help this project grow. Yi, Kate, Bill, Dash, Sylvia, Anne, Doug, Matt, Nathan, and John- You are the braintrust behind any great idea. Brad- You push me to code better. [@ebertucc](https://github.com/ebertucc) and [@jrchamp](https://github.com/jrchamp)- I consider y'all first contributors - woot woot! & Grace- You are the 🔥 behind everything I do.
+A chaos wizard 🧙 and many brilliant brains help Equalify. Special shoutout to [Pantheon](https://pantheon.io/) and [Little Forest](https://littleforest.co.uk/feature/web-accessibility/) for providing funding for [bounties](https://github.com/bbertucc/equalify/issues?q=is%3Aopen+is%3Aissue+label%3Abountied). Yi, Kate, Bill, Dash, Sylvia, Anne, Doug, Matt, Nathan, and John- You are the brains behind any great idea. Brad- You push me to code better. [@ebertucc](https://github.com/ebertucc) and [@jrchamp](https://github.com/jrchamp) are the project's first contributors - woot woot! [Guzzle](https://github.com/guzzle/guzzle) makes multiple concurrent scans possible. [Composer](https://getcomposer.org/) makes Guzzle possible.
 
-This project is Open Source to inspire new collaborations.
+This project is Open Source under [AGPL](https://github.com/bbertucc/equalify/blob/mvp-1.2/LICENSE) to inspire new collaborations.
 
 Together, **we can equalify the internet**.
 
 -[@bbertucc](https://github.com/bbertucc)
-
-PS: For more information on the notions behind Equalify, see my [Ethical Business Notion page](https://bbertucc.notion.site/Ethical-Business-7d8cb00d2e5f4558998450d6e38a61b6). 

actions/activate_alert.php

@@ -0,0 +1,42 @@
+<?php
+/**************!!EQUALIFY IS FOR EVERYONE!!***************
+ * This document activates an alert.
+ * 
+ * As always, we must remember that every function should 
+ * be designed to be as efficient as possible so that 
+ * Equalify works for everyone.
+**********************************************************/
+
+// Info on DB must be declared to use db.php models.
+require_once '../config.php';
+require_once '../models/db.php';
+
+// Let's get the ID that powers this action.
+$id = filter_input(INPUT_GET, 'id', FILTER_VALIDATE_INT);
+if(empty($id))
+    throw new Exception(
+        'ID "'.$id.'" is invalid or missing'
+    );
+
+// We will redirect back to a specified to a preset.
+$preset = '';
+if (isset($_GET['preset']))
+    $preset = '&preset='.$_GET['preset'];
+
+// Set the entry to "active".
+$alert_arguments = array(
+    array(
+
+        // What else? You can add arrays if you
+        // want.
+        'name' => 'status',
+        'value'=> 'active'
+
+    )
+);
+DataAccess::update_db_entry(
+    'alerts', $id, $alert_arguments
+);
+
+// If a "referrer" session was create
+header('Location:  ../index.php?view=alerts'.$preset);

actions/add_site.php

@@ -1,39 +1,89 @@
 <?php
+// ***************!!EQUALIFY IS FOR EVERYONE!!***************
 
 // Info on DB must be declared to use db.php models.
 require_once '../config.php';
 require_once '../models/adders.php';
 require_once '../models/db.php';
 
-// We don't validate the URLs here because cURL does
-// a better job of validating/redirecting in the adders.
-$site_url = $_GET['url'];
-if($site_url == false)
+// We don't validate the URLs here because cURL does a better
+// job of validating/redirecting in the adders.
+$url = $_POST['url'];
+if($url == false)
     throw new Exception('URL is missing');
 
 // We need to check the type since a user could manually
 // update the URL string to something unsupported.
-$type = $_GET['type'];
+$type = $_POST['type'];
 if( $type == false)
-    throw new Exception('Type is not specified for the URL "'.$site_url.'"');
+    throw new Exception(
+        'Type is not specified for the URL "'.$url.'"'
+    );
+
+// We also need to see if the site is of a unique URL.
+$filters = array(
+    array(
+        'name'  => 'url',
+        'value' => $url,
+        'condition' => 'OR'
+    ),
+    array(
+        'name'  => 'url',
+        'value' => $url.'/',
+        'condition' => 'OR'
+    ),
+    array(
+        'name'  => 'url',
+        'value' => 'https://'.$url.'/',
+        'condition' => 'OR'
+    ),
+    array(
+        'name'  => 'url',
+        'value' => 'http://'.$url.'/',
+        'condition' => 'OR'
+    )
+);
+$sites_with_url = DataAccess::get_db_rows('sites', $filters)['content'];
+if( !empty($sites_with_url) )
+    throw new Exception('"'.$url.'" already exists');
 
 // Static pages are treated as sites in themselves.
 if($type == 'single_page' ){
-    single_page_adder($site_url);
+    $site = single_page_adder($url);
 
 // WordPress sites are added via their API.
 }elseif($type == 'wordpress'){
-    wordpress_site_adder($site_url);
+    $site = wordpress_site_adder($url);
 
 // .XML sites use the latest version of XML standards.
 }elseif($type == 'xml'){
-    xml_site_adder($site_url);
+    $site = xml_site_adder($url);
 
 // Since we're passing type through a URL, we have a fallback
 // in case someone passes an unsupported 'type'. 
 }else{
     throw new Exception('"'.$type.'" sites are unsupported');
 }
 
+// If no errors occur, we can add these sites into the URL
+// with several default items.
+$fields = array(
+    array(
+        'name' => 'url',
+        'value' => $url
+    ),
+    array(
+        'name' => 'type',
+        'value' => $type
+    ),
+    array(
+        'name' => 'status',
+        'value' => 'active'
+    )
+);
+DataAccess::add_db_entry(
+    'sites', $fields
+);
+
 // Back home we go.
 header('Location: ../index.php?view=sites&status=success');

actions/delete_alert.php

@@ -0,0 +1,29 @@
+<?php
+/**************!!EQUALIFY IS FOR EVERYONE!!***************
+ * This document deletes labels.
+ * 
+ * As always, we must remember that every function should 
+ * be designed to be as efficient as possible so that 
+ * Equalify works for everyone.
+**********************************************************/
+
+// Info on DB must be declared to use db.php models.
+require_once '../config.php';
+require_once '../models/db.php';
+
+// Setup variables.
+$alert_label = $_GET['name'];
+
+// Delete DB 
+$filtered_to_label = array(
+    array(
+        'name' => 'meta_name',
+        'value' => $_GET['name'],
+    )
+);
+DataAccess::delete_db_entries(
+    'meta', $filtered_to_label
+);
+
+// Reload alerts page.
+header('Location: ../index.php?view=alerts');

actions/delete_alert_tab.php

@@ -0,0 +1,32 @@
+<?php
+/**************!!EQUALIFY IS FOR EVERYONE!!***************
+ * This script gets scan_log from the DB.
+ * 
+ * As always, we must remember that every function should 
+ * be designed to be as efficient as possible so that 
+ * Equalify works for everyone.
+**********************************************************/
+
+// Since this file can run in the CLI, we must set the 
+// directory if it isn't already set.
+if(!defined('__ROOT__'))
+    define('__ROOT__', dirname(dirname(__FILE__)));
+
+// Info on DB must be declared to use db.php models.
+require_once(__ROOT__.'/config.php');
+require_once(__ROOT__.'/models/db.php');
+
+// Return the scan log.
+$filtered_to_active_status = array(
+    array(
+        'name' => 'status',
+        'value' => 'active'
+    ),
+    array(
+        'name' => 'archived',
+        'value' => 0
+    )
+);
+echo number_format(DataAccess::count_db_rows(
+    'alerts', $filtered_to_active_status
+));

actions/delete_label.php

@@ -0,0 +1,20 @@
+<?php
+/**************!!EQUALIFY IS FOR EVERYONE!!***************
+ * This script gets scan_log from the DB.
+ * 
+ * As always, we must remember that every function should 
+ * be designed to be as efficient as possible so that 
+ * Equalify works for everyone.
+**********************************************************/
+
+// Since this file can run in the CLI, we must set the 
+// directory if it isn't already set.
+if(!defined('__ROOT__'))
+    define('__ROOT__', dirname(dirname(__FILE__)));
+
+// Info on DB must be declared to use db.php models.
+require_once(__ROOT__.'/config.php');
+require_once(__ROOT__.'/models/db.php');
+
+// Return the scan log.
+echo DataAccess::get_meta_value('scan_log');