Mirror
/
acme.sh
mirror of https://github.com/acmesh-official/acme.sh.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

update to code

pull/1786/head
stilez 7 years ago
committed by GitHub
parent
0b0429b389
commit
21768c2aa1
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 214 additions and 197 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 411
      dnsapi/dns_pleskxml.sh

411
dnsapi/dns_pleskxml.sh
View File

@ -66,30 +66,33 @@ _DBG_EARLY_CHECK_MODE() {
return 1 return 1
fi fi
_info "plesk XML running in debug mode. Debug level = '${_pleskxml_DBG_LEVEL}' "
# This won't display if DBG level was set to zero.
if [ $_pleskxml_DBG_LEVEL -gt 0 ]; then
_info "plesk XML running in debug mode. Debug level = '${_pleskxml_DBG_LEVEL}' "
# This won't display if DBG level was set to zero.
fi
} }
# arg1 = severity level (1=least serious, 3=most serious)
# By design if DBG level is 9 for a MESSAGE, the message is ALWAYS shown, this is used for _info and _err
# arg2 = message
# arg1 = LINENO
# arg2 = severity level (1=least serious, 3=most serious)
# By design if DBG level is 9 for a MESSAGE, the message is ALWAYS shown, this is used for _info and _err
# arg3 = message
_DBG() { _DBG() {
if [ "$1" -eq 9 ] || ([ "$_pleskxml_DBG_LEVEL" -gt 0 ] && [ "$1" -ge "$_pleskxml_DBG_LEVEL" ]); then
case $1 in
1) _pleskxml_severity='INFO' ;;
2) _pleskxml_severity='WARN' ;;
3) _pleskxml_severity='ERR' ;;
9) _pleskxml_severity='_ACME.SH' ;;
if [ "$2" -eq 9 ] || ([ "$_pleskxml_DBG_LEVEL" -gt 0 ] && [ "$2" -ge "$_pleskxml_DBG_LEVEL" ]); then
case $2 in
1) _pleskxml_severity='MAX_DETAIL' ;;
2) _pleskxml_severity='DETAIL' ;;
3) _pleskxml_severity='INFO' ;;
9) _pleskxml_severity='ACME.SH' ;;
esac esac
_pleskxml_DBG_COUNT=$((_pleskxml_DBG_COUNT + 1)) _pleskxml_DBG_COUNT=$((_pleskxml_DBG_COUNT + 1))
printf '%04d DEBUG [%s]:\n%s\n\n' "$_pleskxml_DBG_COUNT" "$_pleskxml_severity" "$2"
printf '%04d DEBUG [%s/%d, line %s]:\n%s\n\n' "$_pleskxml_DBG_COUNT" "$_pleskxml_severity" "$2" "$1" "$3"
fi fi
} }
# arg1 = severity level (1=least serious, 3=most serious)
# arg2 = message (vardump will be appended)
# arg1 = LINENO
# arg2 = severity level (1=least serious, 3=most serious)
_DBG_VARDUMP() { _DBG_VARDUMP() {
_DBG "$1" "$(printf '%s: 1st lines of current defined variables are now:\n%s\n\n' "${2:-NO_FURTHER_MSG}" "$(set | grep '_pleskxml' | sort)")"
_DBG "$1" "$2" "$(printf '1st lines of current defined variables are now:\n%s\n\n' "$(set | grep '_pleskxml' | sort)")"
} }
_DBG_ERR_TRAP() { _DBG_ERR_TRAP() {
@ -118,26 +121,26 @@ _pleskxml_newline='
# (otherwise printf repeats the string causing the API call to fail) # (otherwise printf repeats the string causing the API call to fail)
_pleskxml_tplt_get_domain_id="<packet><webspace><get><filter><name>%s</name></filter><dataset></dataset></get></webspace></packet>" _pleskxml_tplt_get_domain_id="<packet><webspace><get><filter><name>%s</name></filter><dataset></dataset></get></webspace></packet>"
# Convert domain name to a Plesk internal domain ID
# Args:
# the domain name to query
# Convert domain name to a Plesk internal domain ID
# Args:
# the domain name to query
_pleskxml_tplt_add_txt_record="<packet><dns><add_rec><site-id>%s</site-id><type>TXT</type><host>%s</host><value>%s</value></add_rec></dns></packet>" _pleskxml_tplt_add_txt_record="<packet><dns><add_rec><site-id>%s</site-id><type>TXT</type><host>%s</host><value>%s</value></add_rec></dns></packet>"
# Adds a TXT record to a domain
# Args:
# the Plesk internal domain ID for the domain
# the "host" entry within the domain, to add this to (eg '_acme_challenge')
# the TXT record value
# Adds a TXT record to a domain
# Args:
# the Plesk internal domain ID for the domain
# the "host" entry within the domain, to add this to (eg '_acme_challenge')
# the TXT record value
_pleskxml_tplt_rmv_dns_record="<packet><dns><del_rec><filter><id>%s</id></filter></del_rec></dns></packet>" _pleskxml_tplt_rmv_dns_record="<packet><dns><del_rec><filter><id>%s</id></filter></del_rec></dns></packet>"
# Adds a TXT record to a domain
# Args:
# the Plesk internal ID for the dns record to delete
# Adds a TXT record to a domain
# Args:
# the Plesk internal ID for the dns record to delete
_pleskxml_tplt_get_dns_records="<packet><dns><get_rec><filter><site-id>%s</site-id></filter></get_rec></dns></packet>" _pleskxml_tplt_get_dns_records="<packet><dns><get_rec><filter><site-id>%s</site-id></filter></get_rec></dns></packet>"
# Gets all DNS records for a Plesk domain ID
# Args:
# the domain id to query
# Gets all DNS records for a Plesk domain ID
# Args:
# the domain id to query
############ Define public functions ##################### ############ Define public functions #####################
@ -145,45 +148,46 @@ _pleskxml_tplt_get_dns_records="<packet><dns><get_rec><filter><site-id>%s</site-
dns_pleskxml_add() { dns_pleskxml_add() {
_DBG 2 "Entered dns_pleskxml_add($*)..."
_DBG "$LINENO" 3 "Entered dns_pleskxml_add($*)..."
_pleskxml_FQDN=$1
_pleskxml_TXT_string=$2
_pleskxml_FQDN="$1"
_pleskxml_TXT_string="$2"
# validate variables set by user. # validate variables set by user.
# If valid, then matching internal variables will be set with the appropriate checked values # If valid, then matching internal variables will be set with the appropriate checked values
# Otherwise exit with an error # Otherwise exit with an error
_info "Plesk XML: Trying to add a DNS TXT record for acme validation."
_info "Plesk XML: Domain = $_pleskxml_FQDN. DNS TXT string = '$_pleskxml_TXT_string'."
_info "Plesk XML: Requested action: Add DNS TXT string '$_pleskxml_TXT_string' to domain: '$_pleskxml_FQDN'."
_info "Plesk XML: Checking login and other variables supplied by user" _info "Plesk XML: Checking login and other variables supplied by user"
_pleskxml_get_variables _pleskxml_get_variables
_pleskxml_retcode=$? _pleskxml_retcode=$?
_DBG_VARDUMP 2 'Called _pleskxml_get_variables()'
_DBG "$LINENO" 3 'Returned from _pleskxml_get_variables(). Back in dns_pleskxml_add().'
_DBG_VARDUMP "$LINENO" 2
if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ]; then if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ]; then
_err "$_pleskxml_errors" _err "$_pleskxml_errors"
return 1 return 1
fi fi
if [ "$_pleskxml_allow_insecure" ]; then
if [ "$_pleskxml_allow_insecure" -eq 1 ]; then
_info 'Plesk XML: You have allowed insecure http connections to Plesk. Passwords and logins may be sent in plain text.\nPlease do not use this setting unless very sure of security!' _info 'Plesk XML: You have allowed insecure http connections to Plesk. Passwords and logins may be sent in plain text.\nPlease do not use this setting unless very sure of security!'
fi fi
# Try to convert the domain name to a plesk domain ID. This also lets us know if the URI and authentication are OK. # Try to convert the domain name to a plesk domain ID. This also lets us know if the URI and authentication are OK.
_info "Plesk XML: Variables loaded."
_info "Plesk XML: Variables are valid and loaded."
_info "Trying to connect to Plesk ($_pleskxml_uri), and request Plesk's internal reference ID for domain '${_pleskxml_domain}'" _info "Trying to connect to Plesk ($_pleskxml_uri), and request Plesk's internal reference ID for domain '${_pleskxml_domain}'"
_DBG 2 "Calling API to get domain ID for $_pleskxml_domain"
_DBG "$LINENO" 3 "Calling API to get domain ID for $_pleskxml_domain"
_pleskxml_domain_id="$(_pleskxml_get_domain_ID "$_pleskxml_domain")"
_pleskxml_get_domain_ID "$_pleskxml_domain"
_pleskxml_retcode=$? _pleskxml_retcode=$?
_DBG_VARDUMP 2 'Call has returned'
_DBG "$LINENO" 3 'Returned from API call. Back in dns_pleskxml_add().'
_DBG_VARDUMP "$LINENO" 2
if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ] || [ "$_pleskxml_result" = '' ]; then if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ] || [ "$_pleskxml_result" = '' ]; then
# Really, just testing return code should be enough, based on above code, but let's go "all-in" and test all variables returned # Really, just testing return code should be enough, based on above code, but let's go "all-in" and test all variables returned
_err "$_pleskxml_errors" _err "$_pleskxml_errors"
@ -195,14 +199,15 @@ dns_pleskxml_add() {
# Try to add the TXT record # Try to add the TXT record
_DBG 2 "Calling API to add TXT record to domain ID #$_pleskxml_domain_id ('$_pleskxml_domain')"
_DBG "$LINENO" 3 "Calling API to add TXT record to domain ID #$_pleskxml_domain_id ('$_pleskxml_domain')"
_info "Plesk XML: Trying to add TXT record to domain ID $_pleskxml_domain_id ('$_pleskxml_domain'), host '$_pleskxml_host'. The TXT string is: '$_pleskxml_TXT_string'."
_info "Plesk XML: Got ID for domain. Trying to add TXT record to domain ID $_pleskxml_domain_id ('$_pleskxml_domain'), host '$_pleskxml_host'. The TXT string is: '$_pleskxml_TXT_string'."
_pleskxml_add_dns_txt_record "$_pleskxml_domain_id" "$_pleskxml_host" "$_pleskxml_TXT_string"
_pleskxml_add_txt_record "$_pleskxml_domain_id" "$_pleskxml_host" "$_pleskxml_TXT_string"
_pleskxml_retcode=$? _pleskxml_retcode=$?
_DBG_VARDUMP 2 'Call has returned'
_DBG "$LINENO" 3 'Call has returned. dns_pleskxml_add().'
_DBG_VARDUMP "$LINENO" 2
if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ] || [ "$_pleskxml_result" = '' ]; then if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ] || [ "$_pleskxml_result" = '' ]; then
# Really, just testing return code should be enough, based on above code, but let's go "all-in" and test all variables returned # Really, just testing return code should be enough, based on above code, but let's go "all-in" and test all variables returned
@ -211,9 +216,8 @@ dns_pleskxml_add() {
fi fi
_info 'An ACME Challenge TXT record for '"$_pleskxml_domain"' was added to Plesk. Plesk returned a successful response.\nThe TXT field was: '"'$_pleskxml_TXT_string'" _info 'An ACME Challenge TXT record for '"$_pleskxml_domain"' was added to Plesk. Plesk returned a successful response.\nThe TXT field was: '"'$_pleskxml_TXT_string'"
_info "(TO CHECK?: Note that all subdomains under this domain uses the same TXT record.) <-- MAY NOT BE NEEDED"
_DBG 2 "SUCCESSFULLY exiting dns_pleskxml_add()..."
_DBG "$LINENO" 2 "SUCCESSFULLY exiting dns_pleskxml_add()..."
return 0 return 0
} }
@ -223,44 +227,45 @@ dns_pleskxml_add() {
dns_pleskxml_rm() { dns_pleskxml_rm() {
_DBG 2 "Entered dns_pleskxml_rm($*)..."
_DBG "$LINENO" 2 "Entered dns_pleskxml_rm($*)..."
_pleskxml_FQDN=$1
_pleskxml_TXT_string=$2
_pleskxml_FQDN="$1"
_pleskxml_TXT_string="$2"
# validate variables set by user. # validate variables set by user.
# If valid, then matching internal variables will be set with the appropriate checked values # If valid, then matching internal variables will be set with the appropriate checked values
# Otherwise exit with an error # Otherwise exit with an error
_info "Plesk XML: Trying to remove a recently-added DNS TXT record for following acme validation."
_info "Plesk XML: Domain = $_pleskxml_FQDN. DNS TXT string = '$_pleskxml_TXT_string'."
_info "Plesk XML: Requested action: Remove DNS TXT string '$_pleskxml_TXT_string' from domain: '$_pleskxml_FQDN'."
_info "Plesk XML: Checking login and other variables supplied by user" _info "Plesk XML: Checking login and other variables supplied by user"
_pleskxml_get_variables _pleskxml_get_variables
_pleskxml_retcode=$? _pleskxml_retcode=$?
_DBG_VARDUMP 2 'Called _pleskxml_get_variables()'
_DBG "$LINENO" 2 'Called _pleskxml_get_variables()'
_DBG_VARDUMP "$LINENO" 2
if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ]; then if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ]; then
_err "$_pleskxml_errors" _err "$_pleskxml_errors"
return 1 return 1
fi fi
if [ "$_pleskxml_allow_insecure" ]; then
if [ "$_pleskxml_allow_insecure" -eq 1 ]; then
_info 'Plesk XML: You have allowed insecure http connections to Plesk. Passwords and logins may be sent in plain text.\nPlease do not use this setting unless very sure of security!' _info 'Plesk XML: You have allowed insecure http connections to Plesk. Passwords and logins may be sent in plain text.\nPlease do not use this setting unless very sure of security!'
fi fi
# Try to convert the domain name to a plesk domain ID. This also lets us know if the URI and authentication are OK. # Try to convert the domain name to a plesk domain ID. This also lets us know if the URI and authentication are OK.
_info "Plesk XML: Variables loaded."
_info "Plesk XML: Variables are valid and loaded."
_info "Trying to connect to Plesk ($_pleskxml_uri), and request Plesk's internal reference ID for domain '${_pleskxml_domain}'" _info "Trying to connect to Plesk ($_pleskxml_uri), and request Plesk's internal reference ID for domain '${_pleskxml_domain}'"
_DBG 2 "Calling API to get domain ID for $_pleskxml_domain"
_DBG "$LINENO" 2 "Calling API to get domain ID for $_pleskxml_domain"
_pleskxml_domain_id="$(_pleskxml_get_domain_ID "$_pleskxml_domain")"
_pleskxml_get_domain_ID "$_pleskxml_domain"
_pleskxml_retcode=$? _pleskxml_retcode=$?
_DBG_VARDUMP 2 'Call has returned'
_DBG "$LINENO" 2 'Call has returned'
_DBG_VARDUMP "$LINENO" 2
if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ] || [ "$_pleskxml_result" = '' ]; then if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ] || [ "$_pleskxml_result" = '' ]; then
# Really, just testing return code should be enough, based on above code, but let's go "all-in" and test all variables returned # Really, just testing return code should be enough, based on above code, but let's go "all-in" and test all variables returned
@ -273,14 +278,15 @@ dns_pleskxml_rm() {
# Try to remove the TXT record. First step - get all TXT records # Try to remove the TXT record. First step - get all TXT records
_info "Plesk XML: Trying to remove TXT record from domain ID $_pleskxml_domain_id ('$_pleskxml_domain'), host '$_pleskxml_host'."
_info "Plesk XML: Got ID for domain. Trying to remove TXT record from domain ID $_pleskxml_domain_id ('$_pleskxml_domain'), host '$_pleskxml_host'."
_DBG 2 "Calling API to remove TXT record from domain ID #$_pleskxml_domain_id ('$_pleskxml_domain')"
_DBG "$LINENO" 2 "Calling API to remove TXT record from domain ID #$_pleskxml_domain_id ('$_pleskxml_domain')"
_pleskxml_rmv_txt_record "$_pleskxml_domain_id" "$_pleskxml_host" "$_pleskxml_TXT_string" _pleskxml_rmv_txt_record "$_pleskxml_domain_id" "$_pleskxml_host" "$_pleskxml_TXT_string"
_pleskxml_retcode=$? _pleskxml_retcode=$?
_DBG_VARDUMP 2 'Call has returned'
_DBG "$LINENO" 2 'Call has returned'
_DBG_VARDUMP "$LINENO" 2
if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ] || [ "$_pleskxml_result" = '' ]; then if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ] || [ "$_pleskxml_result" = '' ]; then
# Really, just testing return code should be enough, based on above code, but let's go "all-in" and test all variables returned # Really, just testing return code should be enough, based on above code, but let's go "all-in" and test all variables returned
@ -290,7 +296,7 @@ dns_pleskxml_rm() {
_info 'A TXT record for '"$_pleskxml_domain"' was removed from Plesk. Plesk returned a successful response.\nThe TXT field was: '"'$_pleskxml_TXT_string'" _info 'A TXT record for '"$_pleskxml_domain"' was removed from Plesk. Plesk returned a successful response.\nThe TXT field was: '"'$_pleskxml_TXT_string'"
_DBG 2 "SUCCESSFULLY exiting dns_pleskxml_rm()..."
_DBG "$LINENO" 2 "SUCCESSFULLY exiting dns_pleskxml_rm()..."
return 0 return 0
} }
@ -301,7 +307,8 @@ dns_pleskxml_rm() {
_pleskxml_get_variables() { _pleskxml_get_variables() {
_DBG_VARDUMP 2 'Entered _pleskxml_get_variables()'
_DBG "$LINENO" 2 'Entered _pleskxml_get_variables()'
_DBG_VARDUMP "$LINENO" 2
_pleskxml_errors='' _pleskxml_errors=''
@ -358,11 +365,14 @@ _pleskxml_get_variables() {
# Ensure if not supplied, optional curl args are an empty string # Ensure if not supplied, optional curl args are an empty string
_pleskxml_optional_curl_args="${pleskxml_optional_curl_args:-}" _pleskxml_optional_curl_args="${pleskxml_optional_curl_args:-}"
if [ -n "$_pleskxml_errors" ]; then
_DBG_VARDUMP 2 "UNSUCCESSFULLY exiting _pleskxml_get_variables() (UNSUCCESSFUL CALL!)"
if [ "$_pleskxml_errors" != '' ]; then
_DBG "$LINENO" 2 "UNSUCCESSFULLY exiting _pleskxml_get_variables() (UNSUCCESSFUL CALL!)"
_DBG_VARDUMP "$LINENO" 2
_err 'Can'\''t parse user-defined variables. Exiting.'
return 1 return 1
else else
_DBG_VARDUMP 2 "SUCCESSFULLY exiting _pleskxml_get_variables()"
_DBG "$LINENO" 2 "SUCCESSFULLY exiting _pleskxml_get_variables()"
_DBG_VARDUMP "$LINENO" 2
return 0 return 0
fi fi
} }
@ -373,7 +383,7 @@ _pleskxml_get_variables() {
_pleskxml_api_request() { _pleskxml_api_request() {
_DBG 2 "Entered _pleskxml_api_request($*), to make an XML request.${_pleskxml_newline} arg1=^$1^${_pleskxml_newline} arg2=^$2^${_pleskxml_newline} arg3=^$3^${_pleskxml_newline} arg4=^$4^"
_DBG "$LINENO" 2 "Entered _pleskxml_api_request($*), to make an XML request.${_pleskxml_newline} arg1=^$1^${_pleskxml_newline} arg2=^$2^${_pleskxml_newline} arg3=^$3^${_pleskxml_newline} arg4=^$4^"
_pleskxml_errors='' _pleskxml_errors=''
_pleskxml_result='' _pleskxml_result=''
@ -407,13 +417,14 @@ _pleskxml_api_request() {
-d '${_pleskxml_APICMD}' \ -d '${_pleskxml_APICMD}' \
${_pleskxml_optional_curl_args}" ${_pleskxml_optional_curl_args}"
_DBG_VARDUMP 2 'About to call Plesk via cURL'
_DBG "$LINENO" 2 'About to call Plesk via cURL'
_DBG_VARDUMP "$LINENO" 2
_DBG 2 "$(printf 'cURL command: %s %s %s' "$_pleskxml_curlpath" "$_pleskxml_curlargs" "$_pleskxml_uri")"
_DBG "$LINENO" 2 "$(printf 'cURL command: %s %s %s' "$_pleskxml_curlpath" "$_pleskxml_curlargs" "$_pleskxml_uri")"
_pleskxml_prettyprint_result="$(eval "$_pleskxml_curlpath" "$_pleskxml_curlargs" "$_pleskxml_uri" 2>/dev/null)" _pleskxml_prettyprint_result="$(eval "$_pleskxml_curlpath" "$_pleskxml_curlargs" "$_pleskxml_uri" 2>/dev/null)"
_pleskxml_retcode="$?" _pleskxml_retcode="$?"
_DBG 1 "_pleskxml_prettyprint_result =${_pleskxml_newline}'$_pleskxml_prettyprint_result' "
_DBG 2 "retcode = $_pleskxml_retcode"
_DBG "$LINENO" 1 "_pleskxml_prettyprint_result =${_pleskxml_newline}'$_pleskxml_prettyprint_result' "
_DBG "$LINENO" 2 "retcode = $_pleskxml_retcode"
# BUGFIX TO CHECK - WILL RETCODE FROM cURL BE AVAILABLE HERE? # BUGFIX TO CHECK - WILL RETCODE FROM cURL BE AVAILABLE HERE?
@ -421,7 +432,7 @@ _pleskxml_api_request() {
if [ $_pleskxml_retcode -ne 0 ]; then if [ $_pleskxml_retcode -ne 0 ]; then
_pleskxml_errors="Exiting due to cURL error when querying Plesk XML API. The cURL return code was: $_pleskxml_retcode." _pleskxml_errors="Exiting due to cURL error when querying Plesk XML API. The cURL return code was: $_pleskxml_retcode."
_DBG 2 "$_pleskxml_errors"
_err "$_pleskxml_errors"
return 1 return 1
fi fi
@ -437,19 +448,20 @@ _pleskxml_api_request() {
| tr -d '\n' | tr -d '\n'
)" )"
_DBG_VARDUMP 2 'cURL succeeded, valid cURL response obtained'
_DBG "$LINENO" 2 'cURL succeeded, valid cURL response obtained'
_DBG_VARDUMP "$LINENO" 2
# Now we need to check item by item if it's OK. # Now we need to check item by item if it's OK.
# As we go, we will strip out "known OK" stuff to leave the core reply. # As we go, we will strip out "known OK" stuff to leave the core reply.
# XML header and packet version? # XML header and packet version?
_DBG 2 'Checking <?xml> and <packet> tags exist...'
_DBG "$LINENO" 2 'Checking <?xml> and <packet> tags exist...'
if printf '%s' "$_pleskxml_result" | grep -qiEv '^<\?xml version=[^>]+><packet version=[^>]+>.*</packet>$'; then if printf '%s' "$_pleskxml_result" | grep -qiEv '^<\?xml version=[^>]+><packet version=[^>]+>.*</packet>$'; then
# Error - should have <?xml><packet>...</packet>. Abort # Error - should have <?xml><packet>...</packet>. Abort
_pleskxml_errors="Error when querying Plesk XML API. The API did not return a valid XML response. The response was:${_pleskxml_newline}${_pleskxml_prettyprint_result}${_pleskxml_newline}The collapsed version was:${_pleskxml_newline}'${_pleskxml_result}'${_pleskxml_newline}" _pleskxml_errors="Error when querying Plesk XML API. The API did not return a valid XML response. The response was:${_pleskxml_newline}${_pleskxml_prettyprint_result}${_pleskxml_newline}The collapsed version was:${_pleskxml_newline}'${_pleskxml_result}'${_pleskxml_newline}"
_DBG 2 "$_pleskxml_errors"
_err "$_pleskxml_errors"
return 1 return 1
else else
# So far so good. Strip the <?xml> and <packet>...</packet> tags and continue # So far so good. Strip the <?xml> and <packet>...</packet> tags and continue
@ -458,7 +470,7 @@ _pleskxml_api_request() {
)" )"
fi fi
_DBG 2 "Checking <system> tags don't exist..."
_DBG "$LINENO" 2 "Checking <system> tags don't exist..."
# <system> section found anywhere in response? # <system> section found anywhere in response?
# This usually means some kind of basic API error such as login failure, bad XML request, etc # This usually means some kind of basic API error such as login failure, bad XML request, etc
@ -466,11 +478,11 @@ _pleskxml_api_request() {
if printf '%s' "$_pleskxml_result" | grep -qiE '<system>.*</system>'; then if printf '%s' "$_pleskxml_result" | grep -qiE '<system>.*</system>'; then
# Error - shouldn't contain <system>...</system>. Abort # Error - shouldn't contain <system>...</system>. Abort
_pleskxml_errors='Error when querying Plesk XML API. The result contained a <system> tag.\nThis usually indicates an invalid login, badly formatted API request or other error. The response was:\n'"$_pleskxml_prettyprint_result"'\n' _pleskxml_errors='Error when querying Plesk XML API. The result contained a <system> tag.\nThis usually indicates an invalid login, badly formatted API request or other error. The response was:\n'"$_pleskxml_prettyprint_result"'\n'
_DBG 2 "$_pleskxml_errors"
_err "$_pleskxml_errors"
return 1 return 1
fi fi
_DBG 2 'Checking 1 or >=1 <result> tag (or tags) found, each containing 'status:ok'...'
_DBG "$LINENO" 2 'Checking 1 or >=1 <result> tag (or tags) found, each containing 'status:ok'...'
# Check results section. Most commands only have one results section. # Check results section. Most commands only have one results section.
# But some (i.e., get all DNS records for a domain) have many results sections, # But some (i.e., get all DNS records for a domain) have many results sections,
@ -485,11 +497,11 @@ _pleskxml_api_request() {
if printf '%s' "$_pleskxml_result" | grep -qiEv '<result>.*</result>'; then if printf '%s' "$_pleskxml_result" | grep -qiEv '<result>.*</result>'; then
# Error - doesn't contain <result>...</result>. Abort # Error - doesn't contain <result>...</result>. Abort
_pleskxml_errors='Error when querying Plesk XML API. The result did not contain a <result> section.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\n' _pleskxml_errors='Error when querying Plesk XML API. The result did not contain a <result> section.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\n'
_DBG 2 "$_pleskxml_errors"
_err "$_pleskxml_errors"
return 1 return 1
fi fi
_DBG 2 'Found at least 1 <result> section. Splitting each result section to a separate line'
_DBG "$LINENO" 2 'Found at least 1 <result> section. Splitting each result section to a separate line'
_pleskxml_result="$(printf '%s' "$_pleskxml_result" \ _pleskxml_result="$(printf '%s' "$_pleskxml_result" \
| sed "s/<result>/\\${_pleskxml_newline}<result>/g" \ | sed "s/<result>/\\${_pleskxml_newline}<result>/g" \
@ -501,18 +513,19 @@ _pleskxml_api_request() {
_pleskxml_linecount=$(printf '%s\n' "$_pleskxml_result" | wc -l) _pleskxml_linecount=$(printf '%s\n' "$_pleskxml_result" | wc -l)
_DBG 2 "Result is: '$_pleskxml_result' (${_pleskxml_linecount} line(s))"
_DBG "$LINENO" 2 "Result is: '$_pleskxml_result' (${_pleskxml_linecount} line(s))"
_DBG_VARDUMP 2 'Testing <result> section linecount is OK (1 or >=1 as required)'
_DBG "$LINENO" 2 'Testing <result> section linecount is OK (1 or >=1 as required)'
_DBG_VARDUMP "$LINENO" 2
if [ $_pleskxml_multiple_results_allowed -eq 0 ] && [ "$_pleskxml_linecount" -gt 1 ]; then if [ $_pleskxml_multiple_results_allowed -eq 0 ] && [ "$_pleskxml_linecount" -gt 1 ]; then
# Error - contains multiple <result> sections. Abort # Error - contains multiple <result> sections. Abort
_pleskxml_errors='Error when querying Plesk XML API. The result contained more than one <result> section.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\n' _pleskxml_errors='Error when querying Plesk XML API. The result contained more than one <result> section.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\n'
_DBG 2 "$_pleskxml_errors"
_err "$_pleskxml_errors"
return 1 return 1
fi fi
_DBG 2 "Found ${_pleskxml_linecount} <result> section(s), checking each has status:ok..."
_DBG "$LINENO" 2 "Found ${_pleskxml_linecount} <result> section(s), checking each has status:ok..."
# Loop through each <result> section, checking every line has exactly one result section, # Loop through each <result> section, checking every line has exactly one result section,
# containing exactly one status section, which contains <status>ok</status> # containing exactly one status section, which contains <status>ok</status>
@ -522,11 +535,12 @@ _pleskxml_api_request() {
# _pleskxml_line *should* contain a single result section. # _pleskxml_line *should* contain a single result section.
# Check this is correct. # Check this is correct.
# _DBG "Checking a <result> section... content is ${_pleskxml_line}"
# _DBG "$LINENO" "Checking a <result> section... content is ${_pleskxml_line}"
if printf '%s' "$_pleskxml_line" | grep -qiEv '^<result>.*</result>$'; then if printf '%s' "$_pleskxml_line" | grep -qiEv '^<result>.*</result>$'; then
# Error - doesn't contain <result>...</result>. Abort # Error - doesn't contain <result>...</result>. Abort
_pleskxml_errors='Error when querying Plesk XML API. A <result> section was not found where expected.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\n' _pleskxml_errors='Error when querying Plesk XML API. A <result> section was not found where expected.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\n'
_err "$_pleskxml_errors"
return 1 return 1
fi fi
@ -537,21 +551,21 @@ _pleskxml_api_request() {
if printf '%s' "$_pleskxml_line" | grep -qiEv '<status>.*</status>'; then if printf '%s' "$_pleskxml_line" | grep -qiEv '<status>.*</status>'; then
# Error - doesn't contain <status>...</status>. Abort # Error - doesn't contain <status>...</status>. Abort
_pleskxml_errors='Error when querying Plesk XML API. A <result> section did not contain a <status> section.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\n' _pleskxml_errors='Error when querying Plesk XML API. A <result> section did not contain a <status> section.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\n'
_DBG 2 "$_pleskxml_errors"
_DBG "$LINENO" 2 "$_pleskxml_errors"
return 1 return 1
elif printf '%s' "$_pleskxml_line" | grep -qiE '<status>.*</status>.*<status>'; then elif printf '%s' "$_pleskxml_line" | grep -qiE '<status>.*</status>.*<status>'; then
# Error - contains <status>...</status>...<status>. Abort # Error - contains <status>...</status>...<status>. Abort
_pleskxml_errors='Error when querying Plesk XML API. A <result> section contained more than one <status> section.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\n' _pleskxml_errors='Error when querying Plesk XML API. A <result> section contained more than one <status> section.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\n'
_DBG 2 "$_pleskxml_errors"
_DBG "$LINENO" 2 "$_pleskxml_errors"
return 1 return 1
elif printf '%s' "$_pleskxml_line" | grep -qiEv '<status>ok</status>'; then elif printf '%s' "$_pleskxml_line" | grep -qiEv '<status>ok</status>'; then
# Error - doesn't contain <status>ok</status>. Abort # Error - doesn't contain <status>ok</status>. Abort
_pleskxml_errors='Error when querying Plesk XML API. A <status> tag did not contain "<status>ok</status>". The response was:\n'"$_pleskxml_prettyprint_result"'\n' _pleskxml_errors='Error when querying Plesk XML API. A <status> tag did not contain "<status>ok</status>". The response was:\n'"$_pleskxml_prettyprint_result"'\n'
_DBG 2 "$_pleskxml_errors"
_err "$_pleskxml_errors"
return 1 return 1
fi fi
# _DBG "Line is OK. Looping to next line or exiting..."
# _DBG "$LINENO" "Line is OK. Looping to next line or exiting..."
done <<EOL done <<EOL
$_pleskxml_result $_pleskxml_result
@ -559,7 +573,7 @@ EOL
# So far so good. Remove all <status>ok</status> sections as they're checked now. # So far so good. Remove all <status>ok</status> sections as they're checked now.
_DBG 2 "All results lines had status:ok. Exiting loop, and removing all <status>ok</status> tags now they've been checked"
_DBG "$LINENO" 2 "All results lines had status:ok. Exiting loop, and removing all <status>ok</status> tags now they've been checked"
_pleskxml_result="$(printf '%s' "$_pleskxml_result" \ _pleskxml_result="$(printf '%s' "$_pleskxml_result" \
| sed -E 's/<status>ok<\/status>//g' | sed -E 's/<status>ok<\/status>//g'
@ -567,15 +581,16 @@ EOL
# Result is OK. Remove any redundant self-closing tags, and <data> or </data> tags, and exit # Result is OK. Remove any redundant self-closing tags, and <data> or </data> tags, and exit
_DBG 2 'Now removing any self-closing tags, or <data>...</data> tags'
_DBG "$LINENO" 2 'Now removing any self-closing tags, or <data>...</data> tags'
_pleskxml_result="$(printf '%s' "$_pleskxml_result" \ _pleskxml_result="$(printf '%s' "$_pleskxml_result" \
| sed -E 's/(<[a-zA-Z0-9._-]+[[:space:]]*\/>|<\/?data\/?>)//g' | sed -E 's/(<[a-zA-Z0-9._-]+[[:space:]]*\/>|<\/?data\/?>)//g'
)" )"
_DBG 2 "About to exit API function. Result = ${_pleskxml_newline}'${_pleskxml_result}' "
_DBG "$LINENO" 2 "About to exit API function. Result = ${_pleskxml_newline}'${_pleskxml_result}' "
_DBG_VARDUMP 2 'Successfully exiting Plesk XML API function'
_DBG "$LINENO" 2 'Successfully exiting Plesk XML API function'
_DBG_VARDUMP "$LINENO" 2
return 0 return 0
@ -583,21 +598,21 @@ EOL
_pleskxml_get_domain_ID() { _pleskxml_get_domain_ID() {
_DBG 2 "Entered Plesk get_domain_ID($*), to get the domain's Plesk ID."
_DBG "$LINENO" 2 "Entered Plesk get_domain_ID($*), to get the domain's Plesk ID."
# Call cURL to convert a domain name to a plesk domain ID. # Call cURL to convert a domain name to a plesk domain ID.
_DBG 2 'About to make API request (domain name -> domain ID)'
_DBG "$LINENO" 2 'About to make API request (domain name -> domain ID)'
_pleskxml_api_request "$_pleskxml_tplt_get_domain_id" "$1" _pleskxml_api_request "$_pleskxml_tplt_get_domain_id" "$1"
_pleskxml_retcode=$? _pleskxml_retcode=$?
# $1 is the domain name we wish to convert to a Plesk domain ID # $1 is the domain name we wish to convert to a Plesk domain ID
_DBG 2 'Returned from API request, now back in get_domain_ID()'
_DBG "$LINENO" 2 'Returned from API request, now back in get_domain_ID()'
if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ] || [ "$_pleskxml_result" = '' ]; then if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ] || [ "$_pleskxml_result" = '' ]; then
# Really, just testing return code should be enough, based on above code, but let's go "all-in" and test all variables returned # Really, just testing return code should be enough, based on above code, but let's go "all-in" and test all variables returned
_DBG 2 "$_pleskxml_errors"
_err "$_pleskxml_errors"
return 1 return 1
fi fi
@ -605,17 +620,17 @@ _pleskxml_get_domain_ID() {
# Result should comprise precisely one <result> section # Result should comprise precisely one <result> section
_DBG 2 'Testing API return data for one <result> and removing if so'
_DBG "$LINENO" 2 'Testing API return data for one <result> and removing if so'
if printf '%s' "$_pleskxml_result" | grep -qiEv '^<result>.*</result>$'; then if printf '%s' "$_pleskxml_result" | grep -qiEv '^<result>.*</result>$'; then
# Error - doesn't comprise <result>DOMAINNAME</result>. Something's wrong. Abort # Error - doesn't comprise <result>DOMAINNAME</result>. Something's wrong. Abort
_pleskxml_errors='Error when querying Plesk XML API. The API did not comprise a <result> section containing all other data.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\nand the exact test string was:\n'"$_pleskxml_result"'\n' _pleskxml_errors='Error when querying Plesk XML API. The API did not comprise a <result> section containing all other data.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\nand the exact test string was:\n'"$_pleskxml_result"'\n'
_DBG 2 "$_pleskxml_errors"
_err "$_pleskxml_errors"
return 1 return 1
elif printf '%s' "$_pleskxml_result" | grep -qiE '<result>.*<result>'; then elif printf '%s' "$_pleskxml_result" | grep -qiE '<result>.*<result>'; then
# Error - contains <result>...</result>...<result>. Abort # Error - contains <result>...</result>...<result>. Abort
_pleskxml_errors='Error when querying Plesk XML API. The API contained more than one <result> section.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\nand the exact test string was:\n'"$_pleskxml_result"'\n' _pleskxml_errors='Error when querying Plesk XML API. The API contained more than one <result> section.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\nand the exact test string was:\n'"$_pleskxml_result"'\n'
_DBG 2 "$_pleskxml_errors"
_err "$_pleskxml_errors"
return 1 return 1
else else
# So far so good. Remove the <result>...</result> section and continue # So far so good. Remove the <result>...</result> section and continue
@ -626,17 +641,17 @@ _pleskxml_get_domain_ID() {
# Result should contain precisely one <filter-id> section, containing the domain name inquired. # Result should contain precisely one <filter-id> section, containing the domain name inquired.
_DBG 2 'Testing API return data for one <filter-id> and removing if so'
_DBG "$LINENO" 2 'Testing API return data for one <filter-id> and removing if so'
if printf '%s' "$_pleskxml_result" | grep -qiv "<filter-id>$1</filter-id>"; then if printf '%s' "$_pleskxml_result" | grep -qiv "<filter-id>$1</filter-id>"; then
# Error - doesn't contain <filter-id>DOMAINNAME</filter-id>. Something's wrong. Abort # Error - doesn't contain <filter-id>DOMAINNAME</filter-id>. Something's wrong. Abort
_pleskxml_errors='Error when querying Plesk XML API. The API did not contain the expected <filter-id> section containing the domain name.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\nand the exact test string was:\n'"$_pleskxml_result"'\n' _pleskxml_errors='Error when querying Plesk XML API. The API did not contain the expected <filter-id> section containing the domain name.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\nand the exact test string was:\n'"$_pleskxml_result"'\n'
_DBG 2 "$_pleskxml_errors"
_err "$_pleskxml_errors"
return 1 return 1
elif printf '%s' "$_pleskxml_result" | grep -qiE '<filter-id>.*<filter-id>'; then elif printf '%s' "$_pleskxml_result" | grep -qiE '<filter-id>.*<filter-id>'; then
# Error - contains <filter-id>...</filter-id>...<filter-id>. Abort # Error - contains <filter-id>...</filter-id>...<filter-id>. Abort
_pleskxml_errors='Error when querying Plesk XML API. The API contained more than one <filter-id> section.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\nand the exact test string was:\n'"$_pleskxml_result"'\n' _pleskxml_errors='Error when querying Plesk XML API. The API contained more than one <filter-id> section.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\nand the exact test string was:\n'"$_pleskxml_result"'\n'
_DBG 2 "$_pleskxml_errors"
_err "$_pleskxml_errors"
return 1 return 1
else else
# So far so good. Remove the <filter-id>...</filter-id> section and continue # So far so good. Remove the <filter-id>...</filter-id> section and continue
@ -647,12 +662,12 @@ _pleskxml_get_domain_ID() {
# All that should be left is one section, containing <id>DOMAIN_ID</id> # All that should be left is one section, containing <id>DOMAIN_ID</id>
_DBG 2 "Remaining part of result is now: '$_pleskxml_result' "
_DBG "$LINENO" 2 "Remaining part of result is now: '$_pleskxml_result' "
if printf '%s' "$_pleskxml_result" | grep -qiEv '^<id>[0-9]+</id>$'; then if printf '%s' "$_pleskxml_result" | grep -qiEv '^<id>[0-9]+</id>$'; then
# Error - doesn't contain just <id>NUMBERS</id>. Something's wrong. Abort # Error - doesn't contain just <id>NUMBERS</id>. Something's wrong. Abort
_pleskxml_errors='Error when querying Plesk XML API. The API did not contain the expected <id>[NUMERIC_ID]</id> section, or contained other unexpected values as well.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\nand the exact test string was:\n'"$_pleskxml_result"'\n' _pleskxml_errors='Error when querying Plesk XML API. The API did not contain the expected <id>[NUMERIC_ID]</id> section, or contained other unexpected values as well.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\nand the exact test string was:\n'"$_pleskxml_result"'\n'
_DBG 2 "$_pleskxml_errors"
_err "$_pleskxml_errors"
return 1 return 1
fi fi
@ -662,7 +677,10 @@ _pleskxml_get_domain_ID() {
| sed -E 's/^<id>([0-9]+)<\/id>$/\1/' | sed -E 's/^<id>([0-9]+)<\/id>$/\1/'
)" )"
_DBG_VARDUMP 2 'SUCCESSFULLY exiting Plesk get_domain_ID'
_pleskxml_domain_id="$_pleskxml_result"
_DBG "$LINENO" 2 'SUCCESSFULLY exiting Plesk get_domain_ID'
_DBG_VARDUMP "$LINENO" 2
return 0 return 0
@ -674,47 +692,47 @@ _pleskxml_get_domain_ID() {
_pleskxml_get_dns_records() { _pleskxml_get_dns_records() {
_DBG 2 "Entered Plesk _pleskxml_get_dns_records($*)"
_DBG "$LINENO" 2 "Entered Plesk _pleskxml_get_dns_records($*)"
# First, we need to get all DNS records, and check the list is valid # First, we need to get all DNS records, and check the list is valid
_DBG 2 'About to make API request (get DNS records)'
_DBG "$LINENO" 2 'About to make API request (get DNS records)'
_pleskxml_api_request "$_pleskxml_tplt_get_dns_records" "$1" _pleskxml_api_request "$_pleskxml_tplt_get_dns_records" "$1"
_pleskxml_retcode=$? _pleskxml_retcode=$?
# $1 is the Plesk internal domain ID for the domain # $1 is the Plesk internal domain ID for the domain
_DBG 2 'Returned from API request, now back in get_txt_records()'
_DBG "$LINENO" 2 'Returned from API request, now back in get_txt_records()'
if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ] || [ "$_pleskxml_result" = '' ]; then if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ] || [ "$_pleskxml_result" = '' ]; then
# Really, just testing return code should be enough, based on above code, but let's go "all-in" and test all variables returned # Really, just testing return code should be enough, based on above code, but let's go "all-in" and test all variables returned
_DBG 2 "$_pleskxml_errors"
_err "$_pleskxml_errors"
return 1 return 1
fi fi
# OK, we should have a <result> section containing a list of DNS records. # OK, we should have a <result> section containing a list of DNS records.
# Now keep only the TXT records # Now keep only the TXT records
_DBG 2 "Full DNS records were:${_pleskxml_newline}${_pleskxml_newline}'${_pleskxml_result}' "
_DBG "$LINENO" 2 "Full DNS records were:${_pleskxml_newline}${_pleskxml_newline}'${_pleskxml_result}' "
if [ -n "${2:-}" ]; then if [ -n "${2:-}" ]; then
_pleskxml_result="$(printf '%s' "$_pleskxml_result" \ _pleskxml_result="$(printf '%s' "$_pleskxml_result" \
| grep "<type>$2</type>" | grep "<type>$2</type>"
)" )"
_DBG 2 "Filtered relevant DNS records. Records to be returned are:${_pleskxml_newline}${_pleskxml_newline}'${_pleskxml_result}' "
_DBG "$LINENO" 2 "Filtered relevant DNS records. Records to be returned are:${_pleskxml_newline}${_pleskxml_newline}'${_pleskxml_result}' "
else else
_DBG 2 'Not filtering DNS records. All records will be returned.'
_DBG "$LINENO" 2 'Not filtering DNS records. All records will be returned.'
fi fi
_DBG 2 "SUCCESSFULLY exiting _pleskxml_get_dns_records"
_DBG "$LINENO" 2 "SUCCESSFULLY exiting _pleskxml_get_dns_records"
return 0 return 0
} }
_pleskxml_add_txt_record() { _pleskxml_add_txt_record() {
_DBG 2 "Entered Plesk _pleskxml_add_txt_record($*)"
_DBG "$LINENO" 2 "Entered Plesk _pleskxml_add_txt_record($*)"
_DBG 2 'About to make API request (add TXT record)'
_DBG "$LINENO" 2 'About to make API request (add TXT record)'
_pleskxml_api_request "$_pleskxml_tplt_add_txt_record" "$1" "$2" "$3" _pleskxml_api_request "$_pleskxml_tplt_add_txt_record" "$1" "$2" "$3"
_pleskxml_retcode=$? _pleskxml_retcode=$?
@ -723,11 +741,11 @@ _pleskxml_add_txt_record() {
# $2 is the "host" entry within the domain, to add this to (eg '_acme_challenge') # $2 is the "host" entry within the domain, to add this to (eg '_acme_challenge')
# $3 is the TXT record value # $3 is the TXT record value
_DBG 2 'Returned from API request, now back in add_txt_record()'
_DBG "$LINENO" 2 'Returned from API request, now back in add_txt_record()'
if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ] || [ "$_pleskxml_result" = '' ]; then if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ] || [ "$_pleskxml_result" = '' ]; then
# Really, just testing return code should be enough, based on above code, but let's go "all-in" and test all variables returned # Really, just testing return code should be enough, based on above code, but let's go "all-in" and test all variables returned
_DBG 2 "$_pleskxml_errors"
_err "$_pleskxml_errors"
return 1 return 1
fi fi
@ -737,7 +755,7 @@ _pleskxml_add_txt_record() {
if printf '%s' "$_pleskxml_result" | grep -qivE '^<result><id>[0-9]+</id></result>$'; then if printf '%s' "$_pleskxml_result" | grep -qivE '^<result><id>[0-9]+</id></result>$'; then
# Error - doesn't contain just <id>NUMBERS</id>. Something's wrong. Abort # Error - doesn't contain just <id>NUMBERS</id>. Something's wrong. Abort
_pleskxml_errors='Error when calling Plesk XML API. The API did not contain the expected <id>[PLESK_NEW_DNS_RECORD_ID]</id> section, or contained other unexpected values as well.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\nand the exact test string was:\n'"$_pleskxml_result"'\n' _pleskxml_errors='Error when calling Plesk XML API. The API did not contain the expected <id>[PLESK_NEW_DNS_RECORD_ID]</id> section, or contained other unexpected values as well.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\nand the exact test string was:\n'"$_pleskxml_result"'\n'
_DBG 2 "$_pleskxml_errors"
_err "$_pleskxml_errors"
return 1 return 1
fi fi
@ -748,33 +766,35 @@ _pleskxml_add_txt_record() {
| sed -E "s/^<result><id>([0-9]+)<\/id><\/result>$/\1/" | sed -E "s/^<result><id>([0-9]+)<\/id><\/result>$/\1/"
)" )"
_DBG_VARDUMP 2 'SUCCESSFULLY exiting Plesk _pleskxml_add_txt_record'
_DBG "$LINENO" 2 'SUCCESSFULLY exiting Plesk _pleskxml_add_txt_record'
_DBG_VARDUMP "$LINENO" 2
return 0 return 0
} }
_pleskxml_rmv_dns_record() { _pleskxml_rmv_dns_record() {
_DBG 2 "Entered Plesk _pleskxml_rmv_dns_record($*)"
_DBG "$LINENO" 2 "Entered Plesk _pleskxml_rmv_dns_record($*)"
_DBG 2 'About to make API request (rmv TXT record)'
_DBG "$LINENO" 2 'About to make API request (rmv TXT record)'
_pleskxml_api_request "$_pleskxml_tplt_rmv_dns_record" "$1" _pleskxml_api_request "$_pleskxml_tplt_rmv_dns_record" "$1"
_pleskxml_retcode=$? _pleskxml_retcode=$?
# $1 is the Plesk internal domain ID for the TXT record # $1 is the Plesk internal domain ID for the TXT record
_DBG 2 'Returned from API request, now back in rmv_dns_record()'
_DBG "$LINENO" 2 'Returned from API request, now back in rmv_dns_record()'
if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ] || [ "$_pleskxml_result" = '' ]; then if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ] || [ "$_pleskxml_result" = '' ]; then
# Really, just testing return code should be enough, based on above code, but let's go "all-in" and test all variables returned # Really, just testing return code should be enough, based on above code, but let's go "all-in" and test all variables returned
_DBG 2 "$_pleskxml_errors"
_err "$_pleskxml_errors"
return 1 return 1
fi fi
# OK, we should have removed a TXT record. If it failed, there wouldn't have been a "status:ok" above # OK, we should have removed a TXT record. If it failed, there wouldn't have been a "status:ok" above
_DBG_VARDUMP 2 'SUCCESSFULLY exiting Plesk _pleskxml_rmv_dns_record'
_DBG "$LINENO" 2 'SUCCESSFULLY exiting Plesk _pleskxml_rmv_dns_record'
_DBG_VARDUMP "$LINENO" 2
return 0 return 0
} }
@ -784,25 +804,25 @@ _pleskxml_rmv_dns_record() {
# 3rd arg = value of TXT record string to be found and removed # 3rd arg = value of TXT record string to be found and removed
_pleskxml_rmv_txt_record() { _pleskxml_rmv_txt_record() {
_DBG 2 "Entered Plesk _pleskxml_rmv_dns_TXT_record($*). Getting DNS TXT records for the domain ID"
_DBG "$LINENO" 2 "Entered Plesk _pleskxml_rmv_dns_TXT_record($*). Getting DNS TXT records for the domain ID"
_pleskxml_get_dns_records "$1" 'TXT' _pleskxml_get_dns_records "$1" 'TXT'
_pleskxml_retcode=$? _pleskxml_retcode=$?
# $1 is the Plesk internal domain ID for the domain # $1 is the Plesk internal domain ID for the domain
_DBG 2 'Returned from API request, now back in rmv_txt_record()'
_DBG "$LINENO" 2 'Returned from API request, now back in rmv_txt_record()'
if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ] || [ "$_pleskxml_result" = '' ]; then if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ] || [ "$_pleskxml_result" = '' ]; then
# Really, just testing return code should be enough, based on above code, but let's go "all-in" and test all variables returned # Really, just testing return code should be enough, based on above code, but let's go "all-in" and test all variables returned
_DBG 2 "$_pleskxml_errors"
_err "$_pleskxml_errors"
return 1 return 1
fi fi
# OK, we should have a <result> section containing a list of DNS TXT records. # OK, we should have a <result> section containing a list of DNS TXT records.
# Now we need to find our desired record in it (if it exists). # Now we need to find our desired record in it (if it exists).
# and might as well collapse any successful matches to a signle line for line-count purposes at the same time
# and might as well collapse any successful matches to a single line for line-count purposes at the same time
_DBG 2 "Filters to apply (as literal strings):${_pleskxml_newline}'<host>${2:-<NON_MATCHING_GARBAGE>}.'${_pleskxml_newline}'<value>${3:-<NON_MATCHING_GARBAGE>}</value>' "
_DBG "$LINENO" 2 "Filters to apply (as literal strings):${_pleskxml_newline}'<host>${2:-<NON_MATCHING_GARBAGE>}.'${_pleskxml_newline}'<value>${3:-<NON_MATCHING_GARBAGE>}</value>' "
_pleskxml_result="$(printf '%s' "$_pleskxml_result" \ _pleskxml_result="$(printf '%s' "$_pleskxml_result" \
| grep -F "<host>${2:-<NON_MATCHING_GARBAGE>}." \ | grep -F "<host>${2:-<NON_MATCHING_GARBAGE>}." \
@ -814,19 +834,19 @@ _pleskxml_rmv_txt_record() {
# ands this avoids regex and escaping which is easier # ands this avoids regex and escaping which is easier
# NOTE: the returned "host" field is actually the FQDN, not just the host ID, hence the grep match on that field. # NOTE: the returned "host" field is actually the FQDN, not just the host ID, hence the grep match on that field.
_DBG 2 "Filtered result:${_pleskxml_newline}'$_pleskxml_result' "
_DBG "$LINENO" 2 "Filtered result:${_pleskxml_newline}'$_pleskxml_result' "
if printf '%s' "$_pleskxml_result" | grep -qiE "<result>.*<result>"; then if printf '%s' "$_pleskxml_result" | grep -qiE "<result>.*<result>"; then
# Error - contains <result>...</result>...<result>. Abort # Error - contains <result>...</result>...<result>. Abort
_pleskxml_errors='Error when querying Plesk XML API. The API contained more than one <result> section.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\nand the exact test string was:\n'"$_pleskxml_result"'\n' _pleskxml_errors='Error when querying Plesk XML API. The API contained more than one <result> section.\nThis is unexpected: something has gone wrong. Please raise this as a bug/issue in the module. The response was:\n'"$_pleskxml_prettyprint_result"'\nand the exact test string was:\n'"$_pleskxml_result"'\n'
_DBG 2 "$_pleskxml_errors"
_err "$_pleskxml_errors"
return 1 return 1
fi fi
if printf '%s\n' "$_pleskxml_result" | grep -qiv "<result>"; then if printf '%s\n' "$_pleskxml_result" | grep -qiv "<result>"; then
# No matching TXT records, so we're done. # No matching TXT records, so we're done.
_info "Couldn't find a TXT record matching the requested host/value. Not an error, but a concern..." _info "Couldn't find a TXT record matching the requested host/value. Not an error, but a concern..."
_DBG 2 "Exiting Plesk _pleskxml_rmv_txt_record (without raising an error), as nothing more to do: the record requested for deletion doesn't exist"
_DBG "$LINENO" 2 "Exiting Plesk _pleskxml_rmv_txt_record (without raising an error), as nothing more to do: the record requested for deletion doesn't exist"
_pleskxml_result='' _pleskxml_result=''
return 0 return 0
fi fi
@ -837,112 +857,109 @@ _pleskxml_rmv_txt_record() {
| sed -E 's/^.*<id>([0-9]+)<\/id>.*$/\1/' | sed -E 's/^.*<id>([0-9]+)<\/id>.*$/\1/'
)" )"
_DBG 2 "A unique matching DNS TXT record was found, with Plesk record ID = '$_pleskxml_result'. Calling API to delete this record."
_DBG "$LINENO" 2 "A unique matching DNS TXT record was found, with Plesk record ID = '$_pleskxml_result'. Calling API to delete this record."
_pleskxml_rmv_dns_record "$_pleskxml_result" _pleskxml_rmv_dns_record "$_pleskxml_result"
_pleskxml_retcode=$? _pleskxml_retcode=$?
_DBG 2 'Returned from API request, now back in rmv_txt_record()'
_DBG "$LINENO" 2 'Returned from API request, now back in rmv_txt_record()'
if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ] || [ "$_pleskxml_result" = '' ]; then if [ $_pleskxml_retcode -ne 0 ] || [ "$_pleskxml_errors" != '' ] || [ "$_pleskxml_result" = '' ]; then
# Really, just testing return code should be enough, based on above code, but let's go "all-in" and test all variables returned # Really, just testing return code should be enough, based on above code, but let's go "all-in" and test all variables returned
_DBG 2 "$_pleskxml_errors"
_err "$_pleskxml_errors"
return 1 return 1
fi fi
_DBG_VARDUMP 2 'SUCCESSFULLY exiting Plesk _pleskxml_rmv_txt_record'
_DBG "$LINENO" 2 'SUCCESSFULLY exiting Plesk _pleskxml_rmv_txt_record'
_DBG_VARDUMP "$LINENO" 2
return 0 return 0
} }
exit
if false; then
# ---------------------- TEST CODE ------------------------------
# ---------------------- TEST CODE ------------------------------
# defined by user
pleskxml_uri="https://plesk.XXXXX.net:8443/enterprise/control/agent.php"
pleskxml_user="XXXXX"
pleskxml_pass="XXXXX"
pleskxml_debug_min_level=3
# defined by user
pleskxml_uri="https://plesk.XXXXX.net:8443/enterprise/control/agent.php"
pleskxml_user="XXXXX"
pleskxml_pass="XXXXX"
pleskxml_debug_min_level=3
# defined from args by module
_pleskxml_FQDN="_acme_challenge.XXXXX.com"
_pleskxml_TXT_string='~test~string~'
# defined from args by module
_pleskxml_FQDN="_acme_challenge.XXXXX.com"
_pleskxml_TXT_string='~test~string~'
printf '\n\n\n\n======================================================================== START OF RUN\n\n'
printf '\n\n\n\n======================================================================== START OF RUN\n\n'
_info 'Checking debug mode...'
_info 'Checking debug mode...'
_DBG_EARLY_CHECK_MODE
_DBG_EARLY_CHECK_MODE
_DBG 3 'Debug mode done. Now testing _pleskxml_get_variables()'
_DBG "$LINENO" 3 'Debug mode done. Now testing _pleskxml_get_variables()'
_pleskxml_get_variables
_DBG 3 "$(printf 'RESULT:\n _pleskxml_errors: "%s"\n _pleskxml_retcode: "%s"\n _pleskxml_result: "%s"\n\n' "$_pleskxml_errors" "$_pleskxml_retcode" "$_pleskxml_result")"
_DBG 3 '==============================================================='
_DBG 3 'Testing _pleskxml_get_domain_ID()'
_pleskxml_get_domain_ID "atticflat.uk"
_DBG 3 "$(printf 'RESULT:\n _pleskxml_errors: "%s"\n _pleskxml_retcode: "%s"\n _pleskxml_result: "%s"\n\n' "$_pleskxml_errors" "$_pleskxml_retcode" "$_pleskxml_result")"
_DBG_VARDUMP 2
_DBG 3 '==============================================================='
test_string="TEST STRING ADDED @ $(date)"
_pleskxml_get_variables
_DBG "$LINENO" 3 "$(printf 'RESULT:\n _pleskxml_errors: "%s"\n _pleskxml_retcode: "%s"\n _pleskxml_result: "%s"\n\n' "$_pleskxml_errors" "$_pleskxml_retcode" "$_pleskxml_result")"
_DBG_VARDUMP "$LINENO" 3
_DBG 3 "Testing add a TXT string: '$test_string' "
_pleskxml_add_txt_record 874 '_test_subdomain' "$test_string"
_DBG "$LINENO" 3 '==============================================================='
_DBG 3 "$(printf 'RESULT:\n _pleskxml_errors: "%s"\n _pleskxml_retcode: "%s"\n _pleskxml_result: "%s"\n\n' "$_pleskxml_errors" "$_pleskxml_retcode" "$_pleskxml_result")"
_DBG "$LINENO" 3 'Testing _pleskxml_get_domain_ID()'
_pleskxml_get_domain_ID "atticflat.uk"
_DBG_VARDUMP 2
_DBG "$LINENO" 3 "$(printf 'RESULT:\n _pleskxml_errors: "%s"\n _pleskxml_retcode: "%s"\n _pleskxml_result: "%s"\n\n' "$_pleskxml_errors" "$_pleskxml_retcode" "$_pleskxml_result")"
_DBG_VARDUMP "$LINENO" 3
_DBG 3 '==============================================================='
_DBG "$LINENO" 3 '==============================================================='
_DBG 3 'Testing get DNS records (ALL)'
_pleskxml_get_dns_records 874
test_string="TEST STRING ADDED @ $(date)"
_DBG 3 "$(printf 'RESULT:\n _pleskxml_errors: "%s"\n _pleskxml_retcode: "%s"\n _pleskxml_result: "%s"\n\n' "$_pleskxml_errors" "$_pleskxml_retcode" "$_pleskxml_result")"
_DBG "$LINENO" 3 "Testing add a TXT string: '$test_string' "
_pleskxml_add_txt_record 874 '_test_subdomain' "$test_string"
_DBG_VARDUMP 2
_DBG "$LINENO" 3 "$(printf 'RESULT:\n _pleskxml_errors: "%s"\n _pleskxml_retcode: "%s"\n _pleskxml_result: "%s"\n\n' "$_pleskxml_errors" "$_pleskxml_retcode" "$_pleskxml_result")"
_DBG_VARDUMP "$LINENO" 3
_DBG 3 '==============================================================='
_DBG "$LINENO" 3 '==============================================================='
_DBG 3 'Testing get DNS records (TXT ONLY)'
_pleskxml_get_dns_records 874 TXT
_DBG "$LINENO" 3 'Testing get DNS records (ALL)'
_pleskxml_get_dns_records 874
_DBG 3 "$(printf 'RESULT:\n _pleskxml_errors: "%s"\n _pleskxml_retcode: "%s"\n _pleskxml_result: "%s"\n\n' "$_pleskxml_errors" "$_pleskxml_retcode" "$_pleskxml_result")"
_DBG "$LINENO" 3 "$(printf 'RESULT:\n _pleskxml_errors: "%s"\n _pleskxml_retcode: "%s"\n _pleskxml_result: "%s"\n\n' "$_pleskxml_errors" "$_pleskxml_retcode" "$_pleskxml_result")"
_DBG_VARDUMP "$LINENO" 3
_DBG_VARDUMP 2
_DBG "$LINENO" 3 '==============================================================='
_DBG 3 '==============================================================='
_DBG "$LINENO" 3 'Testing get DNS records (TXT ONLY)'
_pleskxml_get_dns_records 874 TXT
_DBG 3 'Testing rmv a TXT string'
_pleskxml_rmv_txt_record 874 '_test_subdomain' "$test_string"
_DBG "$LINENO" 3 "$(printf 'RESULT:\n _pleskxml_errors: "%s"\n _pleskxml_retcode: "%s"\n _pleskxml_result: "%s"\n\n' "$_pleskxml_errors" "$_pleskxml_retcode" "$_pleskxml_result")"
_DBG_VARDUMP "$LINENO" 3
_DBG 3 "$(printf 'RESULT:\n _pleskxml_errors: "%s"\n _pleskxml_retcode: "%s"\n _pleskxml_result: "%s"\n\n' "$_pleskxml_errors" "$_pleskxml_retcode" "$_pleskxml_result")"
_DBG "$LINENO" 3 '==============================================================='
_DBG_VARDUMP 2
_DBG "$LINENO" 3 'Testing rmv a TXT string'
_pleskxml_rmv_txt_record 874 '_test_subdomain' "$test_string"
_DBG 3 '==============================================================='
_DBG "$LINENO" 3 "$(printf 'RESULT:\n _pleskxml_errors: "%s"\n _pleskxml_retcode: "%s"\n _pleskxml_result: "%s"\n\n' "$_pleskxml_errors" "$_pleskxml_retcode" "$_pleskxml_result")"
_DBG_VARDUMP "$LINENO" 3
_DBG 3 'Re-testing get DNS records (TXT ONLY) after TXT string removal'
_pleskxml_get_dns_records 874 TXT
_DBG "$LINENO" 3 '==============================================================='
_DBG 3 "$(printf 'RESULT:\n _pleskxml_errors: "%s"\n _pleskxml_retcode: "%s"\n _pleskxml_result: "%s"\n\n' "$_pleskxml_errors" "$_pleskxml_retcode" "$_pleskxml_result")"
_DBG "$LINENO" 3 'Re-testing get DNS records (TXT ONLY) after TXT string removal'
_pleskxml_get_dns_records 874 TXT
_DBG_VARDUMP 2
_DBG "$LINENO" 3 "$(printf 'RESULT:\n _pleskxml_errors: "%s"\n _pleskxml_retcode: "%s"\n _pleskxml_result: "%s"\n\n' "$_pleskxml_errors" "$_pleskxml_retcode" "$_pleskxml_result")"
_DBG_VARDUMP "$LINENO" 3
_DBG 3 '==============================================================='
_DBG "$LINENO" 3 '==============================================================='
_DBG 3 'Testing rmv a TXT string, with a non-matching string'
_pleskxml_rmv_txt_record 874 '_test_subdomain' 'JUNKegqw4bw4bb2'
_DBG "$LINENO" 3 'Testing rmv a TXT string, with a non-matching string'
_pleskxml_rmv_txt_record 874 '_test_subdomain' 'JUNKegqw4bw4bb2'
_DBG 3 "$(printf 'RESULT:\n _pleskxml_errors: "%s"\n _pleskxml_retcode: "%s"\n _pleskxml_result: "%s"\n\n' "$_pleskxml_errors" "$_pleskxml_retcode" "$_pleskxml_result")"
_DBG "$LINENO" 3 "$(printf 'RESULT:\n _pleskxml_errors: "%s"\n _pleskxml_retcode: "%s"\n _pleskxml_result: "%s"\n\n' "$_pleskxml_errors" "$_pleskxml_retcode" "$_pleskxml_result")"
_DBG_VARDUMP "$LINENO" 3
_DBG_VARDUMP 2
_DBG "$LINENO" 3 '=============================================================== END OF RUN'
_DBG 3 '=============================================================== END OF RUN'
fi
Write Preview
Loading…
Cancel
Save