Skip to content

Replace cron with launchd #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ngencokamin wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

Replace cron with launchd #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
36ef79e
Remove cron
ngencokamin Feb 23, 2025
4dd8d1f
Initial launchd setup
ngencokamin Feb 23, 2025
2d829de
Remove extra space
ngencokamin Feb 23, 2025
c9032ba
add command to create user LaunchAgents folder if it doesn't exist, a…
ngencokamin Feb 24, 2025
676d2e8
Change mv command
ngencokamin Feb 24, 2025
f3e1e3c
Remove fancy schmancy path handling, fix typo
Feb 24, 2025
b986d24
Remove uneccessary cd
Feb 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions helpers/template.plist
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<!-- A unique label for your job -->
<key>Label</key>
<string>com._NAME_.bb-bridge</string>

<!-- The command to execute: run your command via bash -->
<key>ProgramArguments</key>
<array>
<string>/bin/bash</string>
<string>-c</string>
<string>_PLACEHOLDER_</string>
</array>

<!-- Ensure the command runs when the agent loads -->
<key>RunAtLoad</key>
<true />

<!-- Optional: Keep the process running if it exits -->
<key>KeepAlive</key>
<true />

<!-- Optional: Set environment variables if needed (e.g., to ensure the PATH includes tmux's
location) -->
<key>EnvironmentVariables</key>
<dict>
<key>PATH</key>
<string>/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin</string>
</dict>

<!-- Optional: Log output and errors -->
<key>StandardOutPath</key>
<string>/tmp/bb-bridge.out</string>
<key>StandardErrorPath</key>
<string>/tmp/bb-bridge.err</string>
</dict>
</plist>
186 changes: 101 additions & 85 deletions setup.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ check_macos_version() {
echo "Checking macOS version"
macos_version=$(sw_vers -productVersion)
required_version="12.0.0" # Replace with the required version for Ventura

if [[ $(printf '%s\n' "$required_version" "$macos_version" | sort -V | head -n1) != "$required_version" ]]; then
echo "Your macOS version is $macos_version. BlueBubbles works best on macOS Ventura (version $required_version) and up. It is recommended to upgrade your macOS version."
else
Expand Down Expand Up @@ -61,7 +61,7 @@ download_bbctl() {
echo "Making sure bbctl works"
if ! command -v bbctl >/dev/null 2>&1; then
echo "bbctl command not found! Please check the installation."
elif ! $(bbctl >/dev/null 2>&1); then
elif ! $(bbctl >/dev/null 2>&1); then
echo "bbctl missing permissions! Attempting to grant now!"
sudo chmod +x "${bbctl_path}"
if ! $(bbctl >/dev/null 2>&1); then
Expand Down Expand Up @@ -100,13 +100,13 @@ build_command() {
echo
read -r -p "Use default BlueBubbles URL '${DEFAULT_BB_URL}'? (correct option for most users) [Y/n] " -n 1
case "$REPLY" in
n | N)
echo
read -p "Please enter your BlueBubbles URL: " bb_url
n | N)
echo
read -p "Please enter your BlueBubbles URL: " bb_url
;;
*)
echo "Using default URL"
bb_url=${DEFAULT_BB_URL}
*)
echo "Using default URL"
bb_url=${DEFAULT_BB_URL}
;;
esac
read -p "Please enter your BlueBubbles password: " bb_pass
Expand All @@ -116,12 +116,12 @@ build_command() {
echo "BlueBubbles Password: ${bb_pass}"
read -r -p "Does that look correct? [Y/n] " -n 1
case "$REPLY" in
n | N)
echo
echo "Alright, let's try this again"
build_command
n | N)
echo
echo "Alright, let's try this again"
build_command
;;
*) echo "Great!" ;;
*) echo "Great!" ;;
esac
if "${use_tmux}"; then
bb_command="tmux new-session -d -s bb-bridge bbctl run --param 'bluebubbles_url=${bb_url}' --param 'bluebubbles_password=${bb_pass}' --param 'imessage_platform=bluebubbles' sh-imessage && tmux ls | grep -i 'bb-bridge'"
Expand All @@ -137,42 +137,43 @@ build_command() {
fi
}

# Function to create the cron job
create_cron_job() {
# Create a new script that checks if the process is running and if not, it starts it
echo '#!/bin/bash

if ! pgrep -f "bbctl" > /dev/null
then
source ~/.bashrc
start-bb-server
fi' >~/check_and_run.sh
# Function to create launchd agent
create_launchd_agent() {

# Make the script executable
chmod +x ~/check_and_run.sh
# Create new plist with command and name for process substituted
echo "Generating launchd plist"
sed -e "s}_PLACEHOLDER_}$bb_command}g" -e "s}_NAME_}$(id -un)}g" helpers/template.plist > helpers/com.beeper.bridgemanager.imessage.plist

# Create user LaunchAgents folder if it doesn't exist
if ! [ -d ~/Library/LaunchAgents ]; then
echo "Creating user LaunchAgents directory"
mkdir ~/Library/LaunchAgents
fi

# Open the crontab file and add the job
(
crontab -l 2>/dev/null
echo "@reboot ~/check_and_run.sh
0 * * * * ~/check_and_run.sh"
) | crontab -
# Move created plist
echo "Moving launchd plist to local user LaunchAgent folder"
mv helpers/com.beeper.bridgemanager.imessage.plist ~/Library/LaunchAgents

# Start created plist
echo "Starting launch agent"
launchctl load -w ~/Library/LaunchAgents/com.beeper.bridgemanager.imessage.plist

echo "Bridge should be starting now. If you have any issues, logs can be found at /tmp/bb-bridge.out and /tmp/bb-bridge.err"
}

# Check if bbctl is installed
cd
echo 'Checking if bbctl is currently installed'
bbctl_name="$(compgen -c | grep -i 'bbctl')"
if ! [[ -z "${bbctl_name}" ]]; then
echo 'bbctl found!'
read -r -p "Re-install/update bbctl? (I honestly have no way to check if you're on latest) [Y/n] " -n 1
case "$REPLY" in
n | N)
echo
echo "Alright, no worries"
exit 0
n | N)
echo
echo "Alright, no worries"
exit 0
;;
*) echo "Proceeding" ;;
*) echo "Proceeding" ;;
esac
backup_bbctl
logged_in="$(bbctl w 2>&1)"
Expand All @@ -186,12 +187,12 @@ if ! [[ -z "${bbctl_name}" ]]; then
if [[ "${running}" = *"RUNNING"* ]]; then
read -r -p "The process must be killed to proceed. Can I do that for you? [Y/n] " -n 1
case "$REPLY" in
n | N)
echo
echo "Alright, exiting the script"
exit 0
n | N)
echo
echo "Alright, exiting the script"
exit 0
;;
*) echo "Finding bridge process" ;;
*) echo "Finding bridge process" ;;
esac
bridge_ps="$(pgrep 'bbctl')"
echo "Shutting down bridge"
Expand All @@ -205,19 +206,19 @@ if ! [[ -z "${bbctl_name}" ]]; then
fi
read -r -p "Some updates (such as the contact fix from 2/13/24) require creating a fresh bridge. Delete bridge now? [Y/n] " -n 1
case "$REPLY" in
n | N)
echo
echo "Alright, no worries"
n | N)
echo
echo "Alright, no worries"
;;
*)
echo "Alright, deleting bridge"
bbctl delete sh-imessage
*)
echo "Alright, deleting bridge"
bbctl delete sh-imessage
;;
esac
else
echo "No existing iMessage bridge found"
fi

else
echo "No login found! Please follow the next steps to log in"
bbctl login
Expand All @@ -227,13 +228,13 @@ if ! [[ -z "${bbctl_name}" ]]; then
if ! [[ -z "${bridge_exists}" ]]; then
read -r -p "Some updates (such as the contact fix from 2/13/24) require creating a fresh bridge. Delete bridge now? [Y/n] " -n 1
case "$REPLY" in
n | N)
echo
echo "Alright, no worries"
n | N)
echo
echo "Alright, no worries"
;;
*)
echo "Alright, deleting bridge"
bbctl delete sh-imessage
*)
echo "Alright, deleting bridge"
bbctl delete sh-imessage
;;
esac
else
Expand All @@ -244,12 +245,12 @@ if ! [[ -z "${bbctl_name}" ]]; then
else
read -r -p "bbctl not found in path! Install now? [Y/n] " -n 1
case "$REPLY" in
n | N)
echo
echo "Alright, no worries"
exit 0
n | N)
echo
echo "Alright, no worries"
exit 0
;;
*) echo "Proceeding" ;;
*) echo "Proceeding" ;;
esac
download_bbctl
logged_in="$(bbctl w 2>&1)"
Expand All @@ -262,13 +263,13 @@ else
if ! [[ -z "${bridge_exists}" ]]; then
read -r -p "Some updates (such as the contact fix from 2/13/24) require creating a fresh bridge. Delete bridge now? [Y/n] " -n 1
case "$REPLY" in
n | N)
echo
echo "Alright, no worries"
n | N)
echo
echo "Alright, no worries"
;;
*)
echo "Alright, deleting bridge"
bbctl delete sh-imessage
*)
echo "Alright, deleting bridge"
bbctl delete sh-imessage
;;
esac
fi
Expand All @@ -278,13 +279,13 @@ fi
if command -v tmux >/dev/null 2>&1; then
read -r -p "Would you like to use tmux to run the bridge? It's optional, but it lets you start the bridge without needing to keep the terminal window open, so it's handy [Y/n] " -n 1
case "$REPLY" in
n | N)
echo "Alright, no worries"
use_tmux=false
n | N)
echo "Alright, no worries"
use_tmux=false
;;
*)
echo "Okie dokie, using tmux"
use_tmux=true
*)
echo "Okie dokie, using tmux"
use_tmux=true
;;
esac
else
Expand All @@ -293,19 +294,18 @@ fi

read -r -p "Would you like to add an alias to your shell to be able to start the bridge by simply running \`start-bb-server\` instead of specifying parameters each time? [Y/n] " -n 1
case "$REPLY" in
n | N)
echo "Alright, sounds good!"
use_alias=false
echo "Time to create your run command"
n | N)
echo "Alright, sounds good!"
use_alias=false
echo "Time to create your run command"
;;
*)
echo "Okie dokie, setting that up now!"
use_alias=true
*)
echo "Okie dokie, setting that up now!"
use_alias=true
;;
esac

build_command
create_cron_job
install_xcode_tools
check_macos_version

Expand All @@ -314,11 +314,27 @@ if "${use_alias}"; then echo "start-bb-server"; else echo "${bb_command}"; fi

echo

read -r -p "Looks like we're done here! Would you like to start the bridge now? [Y/n] " -n 1
read -r -p "Would you like to set up a launchd agent to start up the bridge automatically on login? [Y/n] " -n 1
case "$REPLY" in
n | N) echo "Alright, sounds good! Have a nice day, and feel free to reach out to @matchstick in the iMessage bridge matrix room if you have any issues :)" ;;
*)
echo "Alright, starting now! Have a nice day, and feel free to reach out to @matchstick in the iMessage bridge matrix room if you have any issues :)"
eval "${bb_command}"
n | N)
echo "Alright, sounds good!"
echo
read -r -p "Looks like we're done here! Would you like to start the bridge now? [Y/n] " -n 1
case "$REPLY" in
n | N) echo "Alright, sounds good! Have a nice day, and feel free to reach out to @matchstick in the iMessage bridge matrix room if you have any issues :)" ;;
*)
echo "Alright, starting now! Have a nice day, and feel free to reach out to @matchstick in the iMessage bridge matrix room if you have any issues :)"
eval "${bb_command}"
;;
esac
;;
*)
echo "Okie dokie, setting that up now!"
create_launchd_agent
echo "Have a nice day, and feel free to reach out to @matchstick in the iMessage bridge matrix room if you have any issues :)"
;;
esac

echo