Redesign Audit Logs PHP Example Application (#26)

* Redesign Audit Logs PHP Example Application

* fixing issues post review

* fixing issues for audit logs

---------

Co-authored-by: Karla Mazariegos <[email protected]>

Author: kmazariegos

php-audit-logs-example/.DS_Store

@@ -18,11 +18,12 @@ Composer - [Link](https://getcomposer.org/)
    composer i
    ```
 
-2. Create a new file called `.env` and enter your API Key and Client ID from the WorkOS Dashboard. 
+2. Create a new file called `.env` and enter your API Key and Client ID from the WorkOS Dashboard. Add your system username from your computer to generate the path to the downloads folder in line 189 in router.php. Note: do not add '' to the username in your .env file. 
 
 ```
-WORKOS_API_KEY="your_api_key"
-WORKOS_CLIENT_ID="your_client_id"
+WORKOS_API_KEY='your_api_key'
+WORKOS_CLIENT_ID='your_client_id'
+PATH_USERNAME=username
 ```
 
 ## Running the app
@@ -50,7 +51,7 @@ Action title: "user.connection_deleted" | Target type: "team"
 
 5. Once you enter the Organization ID and submit it, you will be brought to the page where you'll be able to send the audit log events that were just configured. You'll also notice that the action of setting the Organization triggered an Audit Log already. Click the buttons to send the respective events.
 
-6. To obtain a CSV of the Audit Log events that were sent for the last 30 days, click the "Export Events" button. This will bring you to a new page where you can download the events. Downloading the events is a 2 step process. First you need to create the report by clicking the "Generate CSV" button. Then click the "Access CSV" button to download a CSV of the Audit Log events for the selected Organization for the past 30 days.
+6. To obtain a CSV of the Audit Log events that were sent for the last 30 days, click the "Export Events" tab. Downloading the events is a 2 step process. First you need to create the report by clicking the "Generate CSV" button. Then click the "Access CSV" button to download a CSV of the Audit Log events for the selected Organization for the past 30 days.
 
 ## Need help?
 

php-audit-logs-example/README.md

@@ -1,7 +1,6 @@
 <?php 
 
-require __DIR__ . "/vendor/autoload.php";
-include './auditLogEvents.php';
+require __DIR__ . "/vendor/autoload.php"; 
 
 use Twig\Environment;
 use Twig\Loader\FilesystemLoader;
@@ -11,7 +10,8 @@
 
 //Set API Key, ClientID, and Connection
 $WORKOS_API_KEY = $_ENV['WORKOS_API_KEY'];
-$WORKOS_CLIENT_ID = $_ENV['WORKOS_CLIENT_ID']; 
+$WORKOS_CLIENT_ID = $_ENV['WORKOS_CLIENT_ID'];
+$PATH_USERNAME = $_ENV['PATH_USERNAME']; 
 
 // Setup html templating library
 $loader = new FilesystemLoader(__DIR__ . '/templates');
@@ -50,6 +50,16 @@ function objectToArray($d)
     }
 }
 
+// Convenient function for redirecting to  URL
+function Redirect($url, $permanent = false)
+{
+    if (headers_sent() === false) {
+        header('Location: ' . $url, true, ($permanent === true) ? 301 : 302);
+    }
+
+    exit();
+}
+
 //Routing
 switch (strtok($_SERVER["REQUEST_URI"], "?")) { 
     case (preg_match("/\.css$/", $_SERVER["REQUEST_URI"]) ? true : false):
@@ -70,42 +80,69 @@ function objectToArray($d)
         }
         return httpNotFound();
 
-
-//set_org route is what will set organization
+//List Organizations
     case ("/"):
     case ("/login"):
-    case ("/logout"):
-        echo $twig->render("login.html.twig");
+        session_start();
+        $before = $_GET['before'] ?? "";
+        $after = $_GET['after'] ?? "";
+        $listOrganizations = new WorkOS\Organizations();
+        [$before, $after, $currentPage] = $listOrganizations->listOrganizations(
+            limit: 5,
+            before: $before,
+            after: $after,
+            order: null
+        );
+        $organizations = $currentPage;
+        echo $twig->render("login.html.twig", ['organizations' => $organizations, 'after' => $after, 'before' => $before]);
         return true;
 
+//set_org
     case ("/set_org"):
-        $organizationId = $_POST["org"] ?? "";
+        session_start();
+        $organizationId = $_GET["id"] ?? "";
         $organization = (new \WorkOS\Organizations()) -> getOrganization($organizationId);
         $orgPayloadArray = objectToArray($organization);
         $orgPayloadArrayRawData = $orgPayloadArray['raw'];
         $finalOrgId = $orgPayloadArrayRawData["id"] ?? "";
         $orgName = $orgPayloadArrayRawData["name"] ?? "";
-        session_start();
         $_SESSION['id'] = $finalOrgId;
         $_SESSION['name'] = $orgName;
-        echo $twig->render("send_events.html.twig", ['org_id' => $_SESSION['id'], 'org_name' => $orgName]); 
+        $rangeEnd = (new \DateTime('now',new \DateTimeZone("UTC")))->format(\DateTime::ATOM);
+        $rangeStart = (new \DateTime('-1 month',new \DateTimeZone("UTC")))->format(\DateTime::ATOM);
+        echo $twig->render("send_events.html.twig", ['org_id' => $_SESSION['id'], 'org_name' => $orgName, 'rangeStart' => $rangeStart, 'rangeEnd' => $rangeEnd]); 
         return true;
 
 //send_event
     case ("/send_event"):
         session_start();
-        $payload = file_get_contents("php://input");
-        $eventId = $payload[6];
-        $event;
-        if($eventId === '0'){
-            $event = $user_signed_in;
-        } else if($eventId === '1'){
-            $event = $user_logged_out;
-        } else if($eventId === '2'){
-            $event = $user_organization_deleted;
-        } else if($eventId === '3'){
-            $event = $user_connection_deleted;
-        }
+        $action = $_POST['event-action'];
+        $version = $_POST['event-version'];
+        $actorName = $_POST['actor-name'];
+        $actorType = $_POST['actor-type'];
+        $targetName = $_POST['target-name'];
+        $targetType = $_POST['target-type'];
+        $event = [ 
+            "action" => $action,
+            "occurred_at" => date("c"),
+            "version" => (int)$version,
+            "actor" => [
+                "id" => "user_01GBNJC3MX9ZZJW1FSTF4C5938",
+                "name" => $actorName,
+                "type" => $actorType,
+            ],
+            "targets" => [
+                [
+                    "id" => "team_01GBNJD4MKHVKJGEWK42JNMBGS",
+                    "name" => $targetName,
+                    "type" => $targetType,
+                ],
+            ],
+            "context" => [
+                "location" => "123.123.123.123",
+                "user_agent" => "Chrome/104.0.0.0",
+            ],
+        ];
 
         $orgId = $_SESSION['id'];
         $orgName = $_SESSION['name'];
@@ -118,15 +155,6 @@ function objectToArray($d)
         echo $twig->render("send_events.html.twig", ['org_id' => $_SESSION['id'], 'org_name' => $_SESSION['name']]); 
         return true;
 
-//export_events
-    case ("/export_events"):
-        session_start();
-        $payload = file_get_contents("php://input");
-        $orgId = $_SESSION['id'];
-        $orgName = $_SESSION['name'];
-        echo $twig->render("export_events.html.twig", ['org_id' => $orgId, 'org_name' => $orgName]); 
-        return true;
-
 //generate_csv
     case ("/get_events"):
         session_start();
@@ -158,13 +186,38 @@ function objectToArray($d)
             $orgPayloadArrayRawData = $orgPayloadArray['raw'];
             $url = $orgPayloadArrayRawData["url"] ?? "";
             $source = file_get_contents($url);
-            file_put_contents('/[YOUR PATH HERE]/auditlogs.csv', $source);
+            file_put_contents("/Users/$PATH_USERNAME/Downloads/auditlogs.csv", $source);
         }
+        echo $twig->render("send_events.html.twig", ['org_id' => $orgId, 'org_name' => $orgName, 'rangeStart' => $dateNow, 'rangeEnd' => $dateMonth]); 
+        return true;
 
-        echo $twig->render("export_events.html.twig", ['org_id' => $orgId, 'org_name' => $orgName]); 
+//events
+    case ("/events"):
+        session_start();
+        $intent = $_GET['intent'];
+        $orgId = $_SESSION['id'];
+        $linkPayloadObject = (new \WorkOS\Portal())->generateLink(
+            organization: $orgId,
+            intent: $intent
+        );
+        $linkPayloadArray = objectToArray($linkPayloadObject);
+        $linkPayloadArrayRawData = $linkPayloadArray['raw'];
+        $finalLink = $linkPayloadArrayRawData['link'];
+        Redirect($finalLink, false);
+        echo $twig->render("send_events.html.twig", ['org_id' => $orgId]); 
         return true;
 
 
+//change_org
+    case ("/logout"):
+        session_start();
+        $_SESSION['organizations'] = null;
+        $_SESSION['before'] = null;
+        $_SESSION['after'] = null;
+        Redirect('/', false);
+        echo $twig->render("login.html.twig");
+        return true;
+
 
 
     default: