Automated update

auto_git_update.sh

@@ -1,35 +1,19 @@
 #!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
 
-#######################################
+# Declare the security variable
-# Advanced Logging Setup
-#######################################
-LOGFILE="/tmp/auto_git_update.log"
-# Ensure the advanced log file exists and has strict permissions.
-ensure_file() {
-    local file="$1"
-    local permissions="$2"
-    [ ! -f "$file" ] && touch "$file" && chmod "$permissions" "$file"
-    chmod "$permissions" "$file"
-}
-ensure_file "$LOGFILE" 600
-# Redirect all stdout and stderr to LOGFILE (while still echoing to the console)
-exec > >(tee -a "$LOGFILE") 2>&1
-
-#######################################
-# Security Check
-#######################################
 security_variable=2  # Change this value as needed (0, 1, or 2)
 
+# Check the value of the security variable
 if [ "$security_variable" -eq 0 ]; then
     echo "Error: security_variable is set to 0. Exiting the script."
     exit 1
 fi
 
+# If the security variable is 2, continue without any conditions
 if [ "$security_variable" -eq 2 ]; then
     echo "security_variable is set to 2. Running the script without further checks."
 else
+    # If the security variable is 1, check if today is Friday
     DAY_OF_WEEK=$(date +%A)
     if [ "$DAY_OF_WEEK" = "Friday" ]; then
         echo "Today is Friday. Continuing with the script."
@@ -39,9 +23,7 @@ else
     fi
 fi
 
-#######################################
+# Check if required commands are available
-# Dependency Checks
-#######################################
 for cmd in git nmcli msmtp ssh scp gh; do
     if ! command -v "$cmd" &>/dev/null; then
         echo "$cmd is required but not installed. Exiting."
@@ -49,42 +31,47 @@ for cmd in git nmcli msmtp ssh scp gh; do
     fi
 done
 
-#######################################
 # Configuration
-#######################################
 TXT_FILE="/home/klein/.config/setup/autogitupdate.txt"
 CREDENTIALS_FILE="$HOME/.config/setup/credentials.config"
 REPORT="/tmp/git_update_report.txt"  # Full detailed report
 SMS_REPORT="/tmp/git_update_sms.txt"  # Minimal SMS summary
-SMS_CHAR_LIMIT=160                   # Character limit for SMS messages
+SMS_CHAR_LIMIT=160  # Character limit for SMS messages
 SSH_DIR="/home/klein/reports"
 
+# Check for the existence of the configuration file
 if [ ! -f "$TXT_FILE" ]; then
     echo "Error: Configuration file '$TXT_FILE' not found. Exiting the script."
     exit 1
 fi
 
+# Check if the credentials file exists
 if [ ! -f "$CREDENTIALS_FILE" ]; then
     echo "Error: Credentials file '$CREDENTIALS_FILE' not found. Exiting the script."
     exit 1
 fi
 
-# Source the credentials.
+# Source the credentials from the config file
 source "$CREDENTIALS_FILE"
 
+# Validate that required variables are set
 if [ -z "$EMAIL" ] || [ -z "$SSH_HOST" ] || [ -z "$PHONE_NUMBER" ]; then
     echo "Error: Missing required credentials (EMAIL, SSH_HOST, or PHONE_NUMBER) in '$CREDENTIALS_FILE'. Exiting the script."
     exit 1
 fi
 
-# Ensure the report files exist and have the correct permissions.
+# Ensure the report files exist and have the correct permissions
+ensure_file() {
+    local file="$1"
+    local permissions="$2"
+    [ ! -f "$file" ] && touch "$file" && chmod "$permissions" "$file"
+    chmod "$permissions" "$file"
+}
+
 ensure_file "$REPORT" 600
 ensure_file "$SMS_REPORT" 600
 
-#######################################
+# Function to check WiFi connection and internet availability
-# Helper Functions
-#######################################
-
 check_wifi() {
     nmcli -t -f ACTIVE,SSID dev wifi | grep -q "^yes" && ping -c 1 8.8.8.8 &>/dev/null
     return $?
@@ -92,31 +79,47 @@ check_wifi() {
 
 get_repo_dirs() {
     local valid_dirs=()
+    
     while IFS= read -r repo_dir; do
+        # Trim whitespace and skip empty lines
         repo_dir=$(echo "$repo_dir" | xargs)
         if [[ -z "$repo_dir" || "$repo_dir" == \#* ]]; then
             continue
         fi
+        # Check if the directory is valid and contains a .git folder
         if [ -d "$repo_dir" ] && [ -d "$repo_dir/.git" ]; then
             valid_dirs+=("$repo_dir")
         fi
     done < "$TXT_FILE"
-    printf "%s\n" "${valid_dirs[@]}"
+    
+    # Output only the valid directories without any additional text
+    echo "${valid_dirs[@]}"
 }
 
+# Function to create GitHub repo if it doesn't exist and push changes
 create_github_repo() {
     local repo_name="$1"
     local repo_dir="$2"
     local repo_number="$3"
     echo "Attempting to create GitHub repo for repo $repo_number ($repo_name)" >> "$REPORT"
+    
+    # Use GitHub CLI to create the repo
     if gh repo create "$repo_name" --public --source="$repo_dir" --remote=origin --push; then
         echo "Successfully created GitHub repository #$repo_number: $repo_name" >> "$REPORT"
         echo "Repo #$repo_number $repo_name: GHS" >> "$SMS_REPORT"
         echo "Success GHS"
+
+        # Check if the repository has existing commits
         if [ -d "$repo_dir/.git" ] && [ "$(git -C "$repo_dir" rev-parse HEAD)" ]; then
             echo "Repository #$repo_number has existing commits. Attempting to add remote and push." >> "$REPORT"
+            
+            # Add the GitHub remote if not already added
             git remote add origin "git@github.com:kleinpanic/$repo_name.git" 2>/dev/null || true
+            
+            # Set the main branch if necessary
             git branch -M main
+            
+            # Push to GitHub
             if git push -u origin main; then
                 echo "Existing repository #$repo_number pushed successfully to GitHub." >> "$REPORT"
                 echo "Repo #$repo_number: PS" >> "$SMS_REPORT"
@@ -136,29 +139,37 @@ create_github_repo() {
     fi
 }
 
+# Function to check if a remote GitHub origin exists
 check_github_remote() {
     if ! git remote get-url origin &>/dev/null; then
         echo "No 'origin' remote found." >> "$REPORT"
         return 1
     fi
+    
     local remote_url
     remote_url=$(git remote get-url origin)
     if [[ "$remote_url" != *github.com* ]]; then
         echo "'origin' remote does not point to GitHub." >> "$REPORT"
         return 1
     fi
-    local repo_name repo_owner full_repo_name
+    
+    local repo_name
     repo_name=$(basename "$remote_url" .git)
+    local repo_owner
     repo_owner=$(basename "$(dirname "$remote_url")")
-    full_repo_name="$repo_owner/$repo_name"
+    local full_repo_name="$repo_owner/$repo_name"
+    
     echo "Checking if GitHub repository '$full_repo_name' exists..." >> "$REPORT"
+    
     if ! gh repo view "$full_repo_name" &>/dev/null; then
         echo "GitHub repository '$full_repo_name' does not exist or is not accessible." >> "$REPORT"
         return 1
     fi
+    
     return 0
 }
 
+# Function to check if the repository is up-to-date
 is_repo_up_to_date() {
     git remote update &>/dev/null
     if git status -uno | grep -q "Your branch is up to date"; then
@@ -170,25 +181,33 @@ is_repo_up_to_date() {
     fi
 }
 
+# Function to check if the .git folder is valid
 is_valid_git_repo() {
     local repo_dir="$1"
+    
     if [ ! -d "$repo_dir/.git" ]; then
         echo "Error: '.git' directory is missing in '$repo_dir'. Skipping this repository." >> "$REPORT"
         return 1
     fi
+
+    # Check for essential .git files
     for file in HEAD config; do
         if [ ! -f "$repo_dir/.git/$file" ]; then
             echo "Error: Missing '$file' in '.git' directory of '$repo_dir'. Skipping this repository." >> "$REPORT"
             return 1
         fi
     done
+
+    # Ensure the repository has at least one commit
     if ! git -C "$repo_dir" rev-parse HEAD &>/dev/null; then
         echo "Error: The repository in '$repo_dir' appears to be corrupt or does not have any commits." >> "$REPORT"
         return 1
     fi
+
     return 0
 }
 
+# A simple logging function to write timestamped messages
 log_msg() {
     local msg="$1"
     echo "$(date '+%Y-%m-%d %H:%M:%S') - $msg" >> "$REPORT"
@@ -197,13 +216,18 @@ log_msg() {
 update_repo() {
     local repo_dir="$1"
     local repo_number="$2"
+
     cd "$repo_dir" || return 1
     log_msg "Processing repository #$repo_number at $repo_dir"
+
+    # Validate the .git folder.
     if ! is_valid_git_repo "$repo_dir"; then
         log_msg "Repo #$repo_number: Invalid repository. Skipping."
         echo "Invalid .git" >> "$SMS_REPORT"
         return 1
     fi
+
+    # Check for GitHub remote; try creating if absent.
     local remote_available=true
     if ! check_github_remote; then
         log_msg "Repo #$repo_number: No valid GitHub remote found."
@@ -212,6 +236,7 @@ update_repo() {
             local repo_name
             repo_name=$(basename "$repo_dir")
             create_github_repo "$repo_name" "$repo_dir" "$repo_number"
+            # Recheck the remote
             if check_github_remote; then
                 remote_available=true
             else
@@ -221,6 +246,8 @@ update_repo() {
             log_msg "Repo #$repo_number: No WiFi. Committing locally only."
         fi
     fi
+
+    # Check for any local changes (staged, unstaged, or untracked)
     if [ -z "$(git status --porcelain)" ]; then
         log_msg "Repo #$repo_number: No local changes detected."
         if [ "$remote_available" = false ]; then
@@ -231,7 +258,11 @@ update_repo() {
         echo "NC-GE"
         return 0
     fi
+
+    # Stage all changes.
     git add -A
+
+    # Commit changes; override PGP signing requirement for automation.
     if git -c commit.gpgSign=false commit -m "Automated update"; then
         log_msg "Repo #$repo_number: Local commit succeeded."
     else
@@ -239,8 +270,11 @@ update_repo() {
         echo "Repo #$repo_number: No commit" >> "$SMS_REPORT"
         return 0
     fi
+
+    # If a remote exists and WiFi is available, perform a pull with rebase.
     if [ "$remote_available" = true ] && check_wifi; then
-        log_msg "Repo #$repo_number: Attempting pull --rebase on branch 'main'."
+        log_msg "Repo #$repo_number: Attempting pull --rebase."
+        # Use a timeout (60 seconds in this example) and --no-edit to avoid interactive prompts.
         if timeout 60s git pull --rebase --no-edit origin main; then
             log_msg "Repo #$repo_number: Rebase succeeded."
         else
@@ -253,8 +287,10 @@ update_repo() {
     else
         log_msg "Repo #$repo_number: Skipping pull/rebase (no remote or no internet)."
     fi
+
+    # Push changes if a remote is available and there is internet.
     if [ "$remote_available" = true ] && check_wifi; then
-        log_msg "Repo #$repo_number: Attempting push on branch 'main'."
+        log_msg "Repo #$repo_number: Attempting push."
         if timeout 60s git push origin main; then
             log_msg "Repo #$repo_number: Push succeeded."
             echo "Repo #$repo_number: P" >> "$SMS_REPORT"
@@ -272,10 +308,14 @@ update_repo() {
     fi
 }
 
+# Start of the script
 echo "Starting auto git update script on $(date)" > "$REPORT"
 echo "(G-R), $(date)" > "$SMS_REPORT"
 
+# Fetch valid repositories
 repo_dirs=($(get_repo_dirs))
+
+# Counters for SMS summary report
 pushed_count=0
 no_change_count=0
 local_commit_count=0
@@ -285,6 +325,7 @@ created_count=0
 no_github_repo_count=0
 total_repos=${#repo_dirs[@]}
 
+# Loop through each valid directory
 repo_number=1
 for repo_dir in "${repo_dirs[@]}"; do
     echo "Updating repository #$repo_number: $repo_dir"
@@ -301,6 +342,7 @@ for repo_dir in "${repo_dirs[@]}"; do
     repo_number=$((repo_number + 1))
 done
 
+# Check if the detailed SMS report exceeds the SMS character limit
 sms_detailed_content=$(cat "$SMS_REPORT")
 if [ "${#sms_detailed_content}" -gt "$SMS_CHAR_LIMIT" ]; then
     DATE=$(date "+%Y-%m-%d %H:%M:%S")
@@ -321,11 +363,16 @@ EOF
 }
 
 copy_report_ssh() {
+    # Ensure SSH_DIR is defined
     if [ -z "$SSH_DIR" ]; then
         echo "Error: SSH_DIR is not set. Please define it in your script."
         return 1
     fi
+    
+    # Create the remote directory if it doesn't exist
     ssh "$SSH_HOST" "mkdir -p $SSH_DIR"
+    
+    # Transfer the report file to the specified directory
     rsync -avz --progress "$REPORT" "$SSH_HOST:$SSH_DIR/"
     return $?
 }
@@ -333,6 +380,7 @@ copy_report_ssh() {
 if check_wifi; then
     echo "WiFi is connected. Attempting to send text message and SSH transfer..."
     send_text && echo "Text message sent successfully." || echo "Failed to send text message."
+    
     if copy_report_ssh; then
         echo "SSH transfer succeeded."
         rm -f "$REPORT"
@@ -342,4 +390,3 @@ if check_wifi; then
 else
     echo "No WiFi connection detected. Changes committed locally."
 fi
-