Update

test-raiseticket.sh

@@ -1,3 +1,30 @@
+#!/bin/zsh
+#####################################################################################################
+#
+# ABOUT THIS PROGRAM
+#
+# NAME
+#   raiseticket.sh - Raise a ticket using the support tools, cognito form and log dumps
+#
+# SYNOPSIS
+#   sudo raiseticket.sh
+#
+####################################################################################################
+#
+# HISTORY
+#
+#   Version: 1.2
+#
+#   - 1.0 Michael Tanner, 07.10.2021 Initial Build
+#   - 1.1 Martyn Watts, 13.10.2021 removed unencrypted files only leaving protected file on device
+#   - 1.2 Martyn Watts, 13.10.2021 Added some comments
+#
+####################################################################################################
+# Script to download and run the raise support ticket functions.
+
+####################################################################################################
+# SET GLOBAL VARIABLES
+####################################################################################################
 dt=$(date '+%d%m%Y.%H%M00');
 host=$('hostname');
 user=$('whoami');
@@ -10,20 +37,27 @@ SMTPFROM=$(cat '/Library/Application Support/Purple/.SMTP/.smtpfrom');
 SMTPTO=$(cat '/Library/Application Support/Purple/.SMTP/.smtpto');
 SMTPMSG="/Users/Shared/.Purple/Diagnostics/.mailhead.txt"
 
+####################################################################################################
+# STYLE DEP NOTIFY READY TO DISPLAY FOR USER FEEDBACK
+####################################################################################################
 echo Command: WindowStyle: Activate >> /var/tmp/depnotify.log
 echo Command: WindowTitle: Create a Support Ticket >> /var/tmp/depnotify.log
 echo Command: MainTitle: Create a Support Ticket >> /var/tmp/depnotify.log
 echo 'Command: Image: /Library/Application Support/Purple/logo.png' >> /var/tmp/depnotify.log
-echo Command: MainText: In a few moments our support ticket form will open in Safari, please complete the form and provide as much information as possible. Whilst you are completing the form your Mac will upload diagnostic information to our Help Desk. You can hide this window as you will continue to get notifications. >> /var/tmp/depnotify.log
+echo Command: MainText: In a few moments our support ticket form will open, please complete the form and provide as much information as possible. Whilst you are completing the form your Mac will upload diagnostic information to our Help Desk. You can hide this window as you will continue to get notifications. >> /var/tmp/depnotify.log
 echo Status: Loading form... Thank you. >> /var/tmp/depnotify.log
 
-# Download CreateTicket application
+####################################################################################################
+# DOWNLOAD CREATETICKET APPLICATION
+####################################################################################################
 rm -rf "/Users/Shared/.Purple/CreateTicket.app"
 cd /Users/Shared/.Purple/
 curl -o /Users/Shared/.Purple/CreateTicket.zip https://raw.githubusercontent.com/PurpleComputing/mdmscripts/main/Helpers/CreateTicket.zip
 unzip /Users/Shared/.Purple/CreateTicket.zip
 
+####################################################################################################
 # START DEPNOTIFY
+####################################################################################################
 curl -o /Users/Shared/.Purple/launch-dep.sh https://raw.githubusercontent.com/PurpleComputing/mdmscripts/main/Helpers/launch-dep.sh
 chmod +x /Users/Shared/.Purple/launch-dep.sh
 /Users/Shared/.Purple/launch-dep.sh
@@ -44,12 +78,23 @@ echo Command: NotificationOn: >> /var/tmp/depnotify.log
 echo Command: ContinueButton: Hide >> /var/tmp/depnotify.log
 
 echo Status: Creating System Report, estimated time: 5 minutes >> /var/tmp/depnotify.log
+
+####################################################################################################
+# CLEAR ANY PREVIOUS DIAGNOSTICS FILE REMNANTS
+####################################################################################################
 rm -rf /Users/Shared/.Purple/Diagnostics/*
+
+####################################################################################################
+# CREATE THE FOLDER STRUCTURE IF ITS NOT ALREADY PRESENT
+####################################################################################################
 mkdir -p "/Users/Shared/.Purple/Diagnostics/"
 mkdir -p "/Users/Shared/.Purple/Diagnostics/$dt/"
 mkdir -p "/Users/Shared/.Purple/Diagnostics/$dt/DiagnosticReports"
 mkdir -p "/Users/Shared/.Purple/PreviousDiagnostics/"
 
+####################################################################################################
+# STREAM THE SYSTEM PROFILER OUTPUT INTO A TEXT FILE
+####################################################################################################
 system_profiler >> "/Users/Shared/.Purple/Diagnostics/$dt/system_report.$host.$dt.txt"
 sleep 3s
 
@@ -58,21 +103,33 @@ sleep 3s
 echo Status: Copying Log Files, estimated time: 4 minutes  >> /var/tmp/depnotify.log
 sleep 5s
 
+####################################################################################################
 # COPY USER DIAGNOSTIC LOGS
+####################################################################################################
 cp -r ~/Library/Logs/DiagnosticReports/* "/Users/Shared/.Purple/Diagnostics/$dt/DiagnosticReports"
+
+####################################################################################################
 # COPY SYSTEM LOGS
+####################################################################################################
 cp -r /private/var/log/*.log "/Users/Shared/.Purple/Diagnostics/$dt/DiagnosticReports"
 
-#INCLUDE TEAMVIEWER ID
+####################################################################################################
+# INCLUDE TEAMVIEWER ID
+####################################################################################################
 defaults read /Library/Preferences/com.teamviewer.teamviewer.preferences.plist ClientID >> "/Users/Shared/.Purple/Diagnostics/$dt/teamviewerID.txt"
 
 echo Command: DeterminateManualStep: 2 >> /var/tmp/depnotify.log
 
+####################################################################################################
+# PACKAGE THE FILES INTO AN ENCRYPTED ZIP FILE
+####################################################################################################
 echo Status: Zipping Diagnostics Info, estimated time: 3 minutes  >> /var/tmp/depnotify.log
 cd "/Users/Shared/.Purple/Diagnostics/"
 zip -er -P "$zippass" "/Users/Shared/.Purple/Diagnostics/"Diagnostics.$user.$host.$dt.zip .
 
-#Removing the unecrypted files immediately after compression has finished so we only leave the password protected file on the device
+####################################################################################################
+# REMOVING THE UNENCRYPTED FILES IMMEDIATLEY AFTER COMPRESSION HAS FINISHED SO WE ONLY LEAVE THE PASSWORD PROTECTED FILE ON THE DEVICE
+####################################################################################################
 rm -rf "/Users/Shared/.Purple/Diagnostics/$dt"
 
 echo Status: Uploading Diagnotics, estimated time: 2 minutes  >> /var/tmp/depnotify.log
@@ -83,7 +140,9 @@ uploadurl=$(cat "/Users/Shared/.Purple/Diagnostics/$dt.uploadurl.txt");
 
 echo Status: Sending Diagnotics to Purple Helpdesk Team, estimated time: 2 minutes  >> /var/tmp/depnotify.log
 
+####################################################################################################
 # REMOVE AND CREATE MESSAGE
+####################################################################################################
 rm -rf $SMTPMSG
 echo "From: "Purple Diagnose" <$SMTPFROM>" >> $SMTPMSG
 echo "To: "Purple Computing Team" <$SMTPTO>" >> $SMTPMSG
@@ -110,11 +169,15 @@ echo Command: DeterminateManualStep: 4 >> /var/tmp/depnotify.log
 echo Status: "Upload Finished. Once you have completed the ticket request please click 'Finished'." >> /var/tmp/depnotify.log
 echo Command: ContinueButton: Finished >> /var/tmp/depnotify.log
 
+####################################################################################################
 # POST RUN CLEANUP
+####################################################################################################
 mv "/Users/Shared/.Purple/Diagnostics/"Diagnostics.$user.$host.$dt.zip "/Users/Shared/.Purple/PreviousDiagnostics/"Diagnostics.$user.$host.$dt.zip
 rm -rf /Users/Shared/.Purple/CreateTicket.zip
-# END SCRIPT WITH SUCCESS
 
+####################################################################################################
+# END SCRIPT WITH SUCCESS
+####################################################################################################
 sleep 900s
 killall FluidApp
 exit 0