asif/CloudflareDDNS
1
0
Fork 0
Code Issues Pull Requests Releases 2 Activity

Added timestamp to all logging entries

Browse Source
This commit is contained in:
Asif Bacchus 2018-09-13 21:58:56 -06:00
parent 9eeaa1af31
commit b366996b85
2 changed files with 45 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
*.log

78
cfddns.sh
View File

@ -34,8 +34,8 @@ echo -e "\ta valid IP6 address using the -i parameter or that your"
echo -e "\tmachine's IP6 address can be correctly detected externally." echo -e "\tmachine's IP6 address can be correctly detected externally."
echo -e "-h\tDisplay this help page" echo -e "-h\tDisplay this help page"
echo -e "-x\tDisplay script examples" echo -e "-x\tDisplay script examples"
echo -e "-l\tLocation for log file output (default: scriptname.log in same" \ echo -e "-l\tLocation for log file output"
"same directory" echo -e "\tDefault: scriptname.ext.log in same directory as this script"
echo -e "-v\tTurn on verbose logging (default: quiet)" echo -e "-v\tTurn on verbose logging (default: quiet)"
echo -e "\n\e[1;39mExamples:" echo -e "\n\e[1;39mExamples:"
echo -e "\e[0;39mRun \e[1;36m$(basename ${0}) \e[1;92m-x\e[0m\n" echo -e "\e[0;39mRun \e[1;36m$(basename ${0}) \e[1;92m-x\e[0m\n"
@ -83,7 +83,8 @@ quit none
function quit { function quit {
if [ -z "$1" ]; then if [ -z "$1" ]; then
# exit cleanly # exit cleanly
echo -e "\e[1;32m--[SUCCESS] Script completed --\e[0m" >> $logFile echo -e "\e[1;32m[`date +%Y-%m-%d` `date +%H:%M:%S`]" \
"--[SUCCESS] Script completed --\e[0m" >> $logFile
exit 0 exit 0
elif [ "$1" = "none" ]; then elif [ "$1" = "none" ]; then
if [ -z "$2" ]; then if [ -z "$2" ]; then
@ -96,13 +97,14 @@ function quit {
elif [ "$1" = "199" ]; then elif [ "$1" = "199" ]; then
# list DNS entries that were not updated # list DNS entries that were not updated
for failedName in "${failedDNS[@]}"; do for failedName in "${failedDNS[@]}"; do
echo -e "\e[1;31m-- [ERROR] $failedName was NOT updated --\e[0m" \ echo -e "\e[1;31m[`date +%Y-%m-%d` `date +%H:%M:%S`]" \
>> $logFile "-- [ERROR] $failedName was NOT updated --\e[0m" >> $logFile
done done
exit "$1" exit "$1"
else else
# notify use that error has occurred and provide exit code # notify use that error has occurred and provide exit code
echo -e "\e[1;31m-- [ERROR] Script exited with code $1 --" >> $logFile echo -e "\e[1;31m[`date +%Y-%m-%d` `date +%H:%M:%S`]" \
"-- [ERROR] Script exited with code $1 --" >> $logFile
echo -e "\e[0;31m${errorExplain[$1]}\e[0m" >> $logFile echo -e "\e[0;31m${errorExplain[$1]}\e[0m" >> $logFile
exit "$1" exit "$1"
fi fi
@ -195,8 +197,8 @@ while getopts ':f:r:i:46hxl:v' PARAMS; do
done done
# Log beginning of script # Log beginning of script
echo -e "\e[1;32m [`date %Y-%m-%d` `date %H:%M:%S`] -- Start script execution" \ echo -e "\e[1;32m [`date +%Y-%m-%d` `date +%H:%M:%S`] -- Start CloudFlare" \
"--\e[0m" >> $logFile "DDNS script execution --\e[0m" >> $logFile
# Check validity of parameters # Check validity of parameters
if [ -z "$accountFile" ] || [[ $accountFile == -* ]]; then if [ -z "$accountFile" ] || [[ $accountFile == -* ]]; then
@ -209,11 +211,11 @@ fi
# Log operating mode # Log operating mode
if [ $ip4 -eq 1 ]; then if [ $ip4 -eq 1 ]; then
echo -e "\e[1;36m [`date %Y-%m-%d` `date %H:%M:%S`] Script running in IP4" \ echo -e "\e[1;36m [`date +%Y-%m-%d` `date +%H:%M:%S`] Script running in" \
"mode\e[0m" >> $logFile "IP4 mode\e[0m" >> $logFile
elif [ $ip6 -eq 1 ]; then elif [ $ip6 -eq 1 ]; then
echo -e "\e[1;36m [`date %Y-%m-%d` `date %H:%M:%S`] Script running in IP6" \ echo -e "\e[1;36m [`date +%Y-%m-%d` `date +%H:%M:%S`] Script running in" \
"mode\e[0m" >> $logFile "IP6 mode\e[0m" >> $logFile
fi fi
@ -222,8 +224,9 @@ mapfile -t cfDetails < "$accountFile"
## Get current IP address, if not provided in parameters ## Get current IP address, if not provided in parameters
if [ -z "$ipAddress" ]; then if [ -z "$ipAddress" ]; then
echo -e "\e[0;36mNo IP address for update provided. Detecting" \ echo -e "\e[0;36m[`date +%Y-%m-%d` `date +%H:%M:%S`] No IP address for" \
"this machine's IP address..." >> $logVerboseFile "update provided. Detecting this machine's IP address..." \
>> $logVerboseFile
if [ $ip4 -eq 1 ]; then if [ $ip4 -eq 1 ]; then
ipAddress=$(curl -s http://ipv4.icanhazip.com) ipAddress=$(curl -s http://ipv4.icanhazip.com)
elif [ $ip6 -eq 1 ]; then elif [ $ip6 -eq 1 ]; then
@ -235,21 +238,24 @@ if [ -z "$ipAddress" ]; then
quit 201 quit 201
fi fi
else else
echo -e "\e[0;36mUsing IP address: $ipAddress" >> $logFile echo -e "\e[0;36m[`date +%Y-%m-%d` `date +%H:%M:%S`] Using IP address:" \
"$ipAddress" >> $logFile
fi fi
## Check if desired record(s) exist at CloudFlare ## Check if desired record(s) exist at CloudFlare
echo -e "\e[0;36mPerforming CloudFlare lookup on specified DNS" \ echo -e "\e[0;36m[`date +%Y-%m-%d` `date +%H:%M:%S`] Performing CloudFlare" \
"records...\e[0m" >> $logVerboseFile "lookup on specified DNS records...\e[0m" >> $logVerboseFile
# perform checks on A or AAAA records based on invocation options # perform checks on A or AAAA records based on invocation options
if [ $ip4 -eq 1 ]; then if [ $ip4 -eq 1 ]; then
echo -e "\t(IP4: ${dnsRecords[*]})" echo -e "[`date +%Y-%m-%d` `date +%H:%M:%S`] (IP4: ${dnsRecords[*]})" \
>> $logVerboseFile
for cfLookup in "${dnsRecords[@]}"; do for cfLookup in "${dnsRecords[@]}"; do
cfRecords+=("$(curl -s -X GET "https://api.cloudflare.com/client/v4/zones/${cfDetails[2]}/dns_records?name=$cfLookup&type=A" -H "X-Auth-Email: ${cfDetails[0]}" -H "X-Auth-Key: ${cfDetails[1]}" -H "Content-Type: application/json")") cfRecords+=("$(curl -s -X GET "https://api.cloudflare.com/client/v4/zones/${cfDetails[2]}/dns_records?name=$cfLookup&type=A" -H "X-Auth-Email: ${cfDetails[0]}" -H "X-Auth-Key: ${cfDetails[1]}" -H "Content-Type: application/json")")
done done
elif [ $ip6 -eq 1 ]; then elif [ $ip6 -eq 1 ]; then
echo -e "\t(IP6: ${dnsRecords[*]})" echo -e "[`date +%Y-%m-%d` `date +%H:%M:%S`] (IP6: ${dnsRecords[*]})" \
>> $logVerboseFile
for cfLookup in "${dnsRecords[@]}"; do for cfLookup in "${dnsRecords[@]}"; do
cfRecords+=("$(curl -s -X GET "https://api.cloudflare.com/client/v4/zones/${cfDetails[2]}/dns_records?name=$cfLookup&type=AAAA" -H "X-Auth-Email: ${cfDetails[0]}" -H "X-Auth-Key: ${cfDetails[1]}" -H "Content-Type: application/json")") cfRecords+=("$(curl -s -X GET "https://api.cloudflare.com/client/v4/zones/${cfDetails[2]}/dns_records?name=$cfLookup&type=AAAA" -H "X-Auth-Email: ${cfDetails[0]}" -H "X-Auth-Key: ${cfDetails[1]}" -H "Content-Type: application/json")")
done done
@ -263,7 +269,8 @@ fi
for recordIdx in "${!cfRecords[@]}"; do for recordIdx in "${!cfRecords[@]}"; do
if [[ ${cfRecords[recordIdx]} == *"\"count\":0"* ]]; then if [[ ${cfRecords[recordIdx]} == *"\"count\":0"* ]]; then
# inform user that domain not found in CloudFlare DNS records # inform user that domain not found in CloudFlare DNS records
echo -e "\e[0;31m***${dnsRecords[recordIdx]} not found in your" \ echo -e "\e[0;31m[`date +%Y-%m-%d` `date +%H:%M:%S`] ***" \
"${dnsRecords[recordIdx]} not found in your" \
"CloudFlare DNS records***\e[0m" >> $logVerboseFile "CloudFlare DNS records***\e[0m" >> $logVerboseFile
# remove the entry from the dnsRecords array # remove the entry from the dnsRecords array
unset dnsRecords[$recordIdx] unset dnsRecords[$recordIdx]
@ -282,8 +289,9 @@ if [ -z ${dnsRecords} ]; then
quit 104 quit 104
else else
for recordIdx in "${!cfRecords[@]}"; do for recordIdx in "${!cfRecords[@]}"; do
echo -e "\n\e[0;33mFound ${dnsRecords[recordIdx]}" \ echo -e "\e[0;33m[`date +%Y-%m-%d` `date +%H:%M:%S`] Found" \
"(Index: $recordIdx):\e[0m" >> $logVerboseFile "${dnsRecords[recordIdx]} (Index: $recordIdx):\e[0m" \
>> $logVerboseFile
echo -e "${cfRecords[recordIdx]}" >> $logVerboseFile echo -e "${cfRecords[recordIdx]}" >> $logVerboseFile
done done
fi fi
@ -295,8 +303,8 @@ for recordIdx in "${!cfRecords[@]}"; do
grep -Po '(?<="content":")[^"]*')) grep -Po '(?<="content":")[^"]*'))
recordID+=($(echo "${cfRecords[recordIdx]}" | \ recordID+=($(echo "${cfRecords[recordIdx]}" | \
grep -Po '(?<="id":")[^"]*')) grep -Po '(?<="id":")[^"]*'))
echo -e "\e[1;36mIndex $recordIdx: \e[0mFor record\e[1;33m" \ echo -e "\e[1;36m[`date +%Y-%m-%d` `date +%H:%M:%S`] Index $recordIdx:" \
"${dnsRecords[recordIdx]}\e[0m" \ "\e[0mFor record\e[1;33m ${dnsRecords[recordIdx]}\e[0m" \
"with ID: \e[1;33m${recordID[recordIdx]}\e[0m" \ "with ID: \e[1;33m${recordID[recordIdx]}\e[0m" \
"the current IP is \e[1;35m ${currentIP[recordIdx]}" \ "the current IP is \e[1;35m ${currentIP[recordIdx]}" \
"\e[0m" >> $logVerboseFile "\e[0m" >> $logVerboseFile
@ -305,21 +313,23 @@ done
## Check whether new IP matches old IP and update if they do not match ## Check whether new IP matches old IP and update if they do not match
for recordIdx in "${!currentIP[@]}"; do for recordIdx in "${!currentIP[@]}"; do
if [ ${currentIP[recordIdx]} = $ipAddress ]; then if [ ${currentIP[recordIdx]} = $ipAddress ]; then
echo -e "\e[0;32m${dnsRecords[recordIdx]} is up-to-date.\e[0m" \ echo -e "\e[0;32m[`date +%Y-%m-%d` `date +%H:%M:%S`]" \
"${dnsRecords[recordIdx]} is up-to-date.\e[0m" \
>> $logVerboseFile >> $logVerboseFile
else else
echo -e "\e[0;31m${dnsRecords[recordIdx]} needs updating...\e[0m" \ echo -e "\e[0;31m[`date +%Y-%m-%d` `date +%H:%M:%S`]" \
"${dnsRecords[recordIdx]} needs updating...\e[0m" \
>> $logVerboseFile >> $logVerboseFile
if [ $ip4 -eq 1 ]; then if [ $ip4 -eq 1 ]; then
# update record at CloudFlare with new IP # update record at CloudFlare with new IP
update=$(curl -s -X PUT "https://api.cloudflare.com/client/v4/zones/${cfDetails[2]}/dns_records/${recordID[recordIdx]}" -H "X-Auth-Email: ${cfDetails[0]}" -H "X-Auth-Key: ${cfDetails[1]}" -H "Content-Type: application/json" --data "{\"id\":\"${cfDetails[2]}\",\"type\":\"A\",\"proxied\":false,\"name\":\"${dnsRecords[recordIdx]}\",\"content\":\"$ipAddress\"}") update=$(curl -s -X PUT "https://api.cloudflare.com/client/v4/zones/${cfDetails[2]}/dns_records/${recordID[recordIdx]}" -H "X-Auth-Email: ${cfDetails[0]}" -H "X-Auth-Key: ${cfDetails[1]}" -H "Content-Type: application/json" --data "{\"id\":\"${cfDetails[2]}\",\"type\":\"A\",\"proxied\":false,\"name\":\"${dnsRecords[recordIdx]}\",\"content\":\"$ipAddress\"}")
# check for success code from CloudFlare # check for success code from CloudFlare
if [[ $update == *"\"success\":true"* ]]; then if [[ $update == *"\"success\":true"* ]]; then
echo -e "\e[1;32m${dnsRecords[recordIdx]} updated.\e[0m]" \ echo -e "\e[1;32m[`date +%Y-%m-%d` `date +%H:%M:%S`]" \
>> $logFile "${dnsRecords[recordIdx]} updated.\e[0m]" >> $logFile
else else
echo -e "\e[1;31m${dnsRecords[recordIdx]} update failed\e[0m" \ echo -e "\e[1;31m[`date +%Y-%m-%d` `date +%H:%M:%S`]" \
>> $logFile "${dnsRecords[recordIdx]} update failed\e[0m" >> $logFile
echo -e "\e[0;39m$update" >> $logVerboseFile echo -e "\e[0;39m$update" >> $logVerboseFile
failedDNS+=("${dnsRecords[recordIdx]}") failedDNS+=("${dnsRecords[recordIdx]}")
fi fi
@ -328,11 +338,11 @@ for recordIdx in "${!currentIP[@]}"; do
update=$(curl -s -X PUT "https://api.cloudflare.com/client/v4/zones/${cfDetails[2]}/dns_records/${recordID[recordIdx]}" -H "X-Auth-Email: ${cfDetails[0]}" -H "X-Auth-Key: ${cfDetails[1]}" -H "Content-Type: application/json" --data "{\"id\":\"${cfDetails[2]}\",\"type\":\"AAAA\",\"proxied\":false,\"name\":\"${dnsRecords[recordIdx]}\",\"content\":\"$ipAddress\"}") update=$(curl -s -X PUT "https://api.cloudflare.com/client/v4/zones/${cfDetails[2]}/dns_records/${recordID[recordIdx]}" -H "X-Auth-Email: ${cfDetails[0]}" -H "X-Auth-Key: ${cfDetails[1]}" -H "Content-Type: application/json" --data "{\"id\":\"${cfDetails[2]}\",\"type\":\"AAAA\",\"proxied\":false,\"name\":\"${dnsRecords[recordIdx]}\",\"content\":\"$ipAddress\"}")
# check for success code from CloudFlare # check for success code from CloudFlare
if [[ $update == *"\"success\":true"* ]]; then if [[ $update == *"\"success\":true"* ]]; then
echo -e "\e[1;32m${dnsRecords[recordIdx]} updated.\e[0m" \ echo -e "\e[1;32m[`date +%Y-%m-%d` `date +%H:%M:%S`]" \
>> $logFile "${dnsRecords[recordIdx]} updated.\e[0m" >> $logFile
else else
echo -e "\e[1;31m${dnsRecords[recordIdx]} update failed\e[0m" \ echo -e "\e[1;31m[`date +%Y-%m-%d` `date +%H:%M:%S`]" \
>> $logFile "${dnsRecords[recordIdx]} update failed\e[0m" >> $logFile
echo -e "\e[0;39m$update" >> $logVerboseFile echo -e "\e[0;39m$update" >> $logVerboseFile
failedDNS+=("${dnsRecords[recordIdx]}") failedDNS+=("${dnsRecords[recordIdx]}")
fi fi