scripts/system/common_sysadmin.sh

   1 #!/bin/bash
   2
   3 # this is a library of functions shared by scripts in the system folder.
   4 #
   5 # Author: Chris Koeritz
   6
   7 ############################################################################
   8
   9 # bind9 methods...
  10
  11 # removes a full domain from the DNS.
  12 function remove_domain_file()
  13 {
  14   local domain_name="$1"; shift
  15
  16   local domain_file="/etc/bind/${domain_name}.conf"
  17   if [ -f "$domain_file" ]; then
  18     # don't destroy, just shuffle.
  19     \mv -f "$domain_file" "/tmp/$(basename ${domain_file})-old-${RANDOM}"
  20     test_or_die "removing domain file: $domain_file"
  21   else
  22     echo "Did not see a domain file to remove: $domain_file"
  23   fi
  24 }
  25
  26 # creates a totally new domain config file for DNS.
  27 function write_new_domain_file()
  28 {
  29   local domain_name="$1"; shift
  30
  31   local domain_file="/etc/bind/${domain_name}.conf"
  32
  33   echo "adding a totally new domain called $domain_name"
  34   echo "using the config file: $domain_file"
  35
  36   if [ -f $domain_file ]; then
  37     echo
  38     echo "The domain configuration file already exists at:"
  39     echo "  $domain_file"
  40     echo "Since we don't want to tear that down if it has specialized configuration"
  41     echo "data in it, we will just leave it in place and consider our job done."
  42     echo
  43     exit 0
  44   fi
  45
  46   echo "
  47 \$TTL 1W
  48 @       IN SOA  @       ${SERVER_ADMIN}. (
  49                 2017100801 ; serial
  50                 2H ; refresh
  51                 8M ; retry
  52                 14D ; expiry
  53                 6H ) ; minimum
  54
  55         IN NS           ${MAIN_NAME_SERVER}.
  56         IN MX   10      ${MAIL_SERVER}.
  57
  58 ${domain_name}. IN A    ${IP_ADDRESS}
  59         IN HINFO        \"linux server\" \"${DISTRO}\"
  60 " >"$domain_file"
  61
  62   # our personalized configuration approach wants the real owner to own the file.
  63   chown "$(logname):$(logname)" $domain_file
  64   test_or_die "setting ownership on: $domain_file"
  65 }
  66
  67 # takes a zone back out of the local conf file for bind
  68 function remove_zone_for_domain()
  69 {
  70   local domain_name="$1"; shift
  71
  72   local domain_file="/etc/bind/${domain_name}.conf"
  73
  74   # eat the zone file definition.  this will botch up badly if more text was added
  75   # or the zone info shrank.
  76   create_chomped_copy_of_file "/etc/bind/named.conf.local" "zone.*${domain_name}" 6
  77 }
  78
  79 # hooks up a new config file into bind's list of zones.
  80 function add_zone_for_new_domain()
  81 {
  82   local domain_name="$1"; shift
  83
  84   local domain_file="/etc/bind/${domain_name}.conf"
  85
  86   echo "adding a new domain configured by ${domain_file} into"
  87   echo "the named.conf.local configuration file."
  88
  89   # append the reference to the new conf file in the zone list.
  90   echo "
  91 zone \"${domain_name}\" in {
  92         file \"${domain_file}\";
  93         type master;
  94         allow-query { any; };
  95 };
  96
  97 ////////////////////////////////////////////////////////////////////////////
  98
  99 " >> /etc/bind/named.conf.local
 100
 101   # keep ownership for the real user.
 102   chown "$(logname):$(logname)" /etc/bind/named.conf.local
 103   test_or_die "setting ownership on: /etc/bind/named.conf.local"
 104 }
 105
 106 # zaps a subdomain out of the containing domain file.
 107 function remove_subdomain()
 108 {
 109   local old_domain="$1"; shift
 110
 111   # split up the full domain name into subdomain portion and containing domain.
 112   local subdomain="${old_domain%.*.*}"
 113   local containing_domain="${old_domain#*.}"
 114
 115   echo "removing subdomain $subdomain from containing domain $containing_domain"
 116
 117   local domain_file="/etc/bind/${containing_domain}.conf"
 118   # see if config file already exists; if not, complain.
 119   if [ ! -f "$domain_file" ]; then
 120     echo "The domain configuration file for $old_domain is missing."
 121     echo "It should already be present in: $domain_file"
 122     echo "We cannot remove a subdomain if the containing domain isn't there."
 123     exit 1
 124   fi
 125
 126   # see if subdomain already present in config.
 127   if ! grep -q "$old_domain" "$domain_file"; then
 128     echo "The subdomain $subdomain is already missing from the domain"
 129     echo "configuration file: $domain_file"
 130     echo "Our work is apparently done for removing it."
 131     return 0
 132   fi
 133
 134   create_chomped_copy_of_file "$domain_file" "${old_domain}" 2
 135 }
 136
 137 # adds a new subdomain under a containing domain.
 138 function add_new_subdomain()
 139 {
 140   local new_domain="$1"; shift
 141
 142   # split up the full domain name into subdomain portion and containing domain.
 143   local subdomain="${new_domain%.*.*}"
 144   local containing_domain="${new_domain#*.}"
 145
 146   echo "adding a subdomain $subdomain to containing domain $containing_domain"
 147
 148   local domain_file="/etc/bind/${containing_domain}.conf"
 149   # see if config file already exists; if not, complain.
 150   if [ ! -f "$domain_file" ]; then
 151     echo "The domain configuration file for $new_domain is missing."
 152     echo "It should already be present in: $domain_file"
 153     echo "Please add the containing domain before trying to add a subdomain."
 154     exit 1
 155   fi
 156
 157   # see if subdomain already present in config.
 158   if grep -q "$new_domain" "$domain_file"; then
 159     echo "The subdomain $subdomain already seems to exist in the domain"
 160     echo "configuration file: $domain_file"
 161     echo "We are considering our work done; if you want to modify the subdomain,"
 162     echo "then please call remove_domain on it first."
 163     return 0
 164   fi
 165
 166   # append the new subdomain into the config file.
 167   echo "${subdomain}.${containing_domain}.    IN A    ${IP_ADDRESS}
 168         IN HINFO \"linux server\" \"${DISTRO}\"
 169 " >> /etc/bind/${containing_domain}.conf
 170
 171   # keep ownership for real user.
 172   chown "$(logname):$(logname)" "/etc/bind/${containing_domain}.conf"
 173   test_or_die "setting ownership on: /etc/bind/${containing_domain}.conf"
 174 }
 175
 176 function restart_bind()
 177 {
 178   echo restarting DNS server.
 179   service bind9 restart
 180   if [ $? -ne 0 ]; then
 181     echo "The bind service did not restart properly.  Please check the error logs."
 182     exit 1
 183   fi
 184   echo DNS server restarted.
 185 }
 186
 187 ############################################################################
 188
 189 # apache2 methods...
 190
 191 # removes a config file for apache given the app name and site name.
 192 function remove_apache_config()
 193 {
 194   local sitename="$1"; shift
 195
 196   local site_config="/etc/apache2/sites-available/${sitename}.conf"
 197
 198   if [ -f "$site_config" ]; then
 199     # don't destroy, just shuffle.
 200     \mv -f "$site_config" "/tmp/$(basename ${site_config})-old-${RANDOM}"
 201     test_or_die "removing site config: $site_config"
 202   else
 203     echo "Did not see a site config to remove: $site_config"
 204   fi
 205 }
 206
 207 # this function writes out the new configuration file for the site.
 208 function write_apache_config()
 209 {
 210   local appname="$1"; shift
 211   local sitename="$1"; shift
 212   local site_path="$1"; shift
 213
 214   local site_config="/etc/apache2/sites-available/${sitename}.conf"
 215
 216   # check if config file already exists and bail if so.
 217   if [ -f "$site_config" ]; then
 218     echo "The apache configuration file already exists at:"
 219     echo "  $site_config"
 220     echo "Since apache configuration files can get very complex, we do not want to"
 221     echo "assume that this file is removable.  Calling the site addition done."
 222     exit 0
 223   fi
 224
 225   echo "Creating a new apache2 site for $sitename with config file:"
 226   echo "  $site_config"
 227
 228   # if no path, then we default to our standard app storage location.  otherwise, we
 229   # put the site where they told us to.
 230   if [ -z "$site_path" ]; then
 231     # path where site gets checked out, in some arcane manner, and which happens to be
 232     # above the path where we put webroot (in the storage suffix, if defined).
 233     local path_above="${BASE_APPLICATION_PATH}/${appname}"
 234     # no slash between appname and suffix, in case suffix is empty.
 235     local full_path="${path_above}${STORAGE_SUFFIX}"
 236 #echo really full path is $full_path
 237   else
 238     # we'll go with their specification for the site storage.
 239     local full_path="$site_path"
 240   fi
 241
 242   echo "
 243 # set up the user's web folder as an apache user web directory.
 244
 245 # set permissions on the actual app folder.
 246 <Directory \"$full_path\">
 247   Options +ExecCGI +Indexes +FollowSymLinks +Includes +MultiViews
 248   Require all granted
 249 </Directory>
 250
 251 <VirtualHost *:80>
 252     ServerName ${sitename}
 253     DocumentRoot ${full_path}
 254     ErrorLog \${APACHE_LOG_DIR}/${sitename}-error.log
 255     CustomLog \${APACHE_LOG_DIR}/${sitename}-access.log combined
 256     Include /etc/apache2/conf-library/basic-options.conf
 257     Include /etc/apache2/conf-library/rewrite-enabling.conf
 258 </VirtualHost>
 259 " >"$site_config"
 260
 261   chown "$(logname):$(logname)" "$site_config"
 262   test_or_die "setting ownership on: $site_config"
 263 }
 264
 265 # stops apache from serving up the site.
 266 function disable_site()
 267 {
 268   local sitename="$1"; shift
 269   local site_config="/etc/apache2/sites-available/${sitename}.conf"
 270
 271   if [ ! -f "$site_config" ]; then
 272     echo "The site config did not exist and could not be disabled: $site_config"
 273     return 0
 274   fi
 275
 276 #hmmm: repeated pattern of hidden output file, very useful.  abstract it...
 277   local outfile="$TMP/apacheout.$RANDOM"
 278   a2dissite "$(basename $site_config)" &>$outfile
 279   if [ $? -ne 0 ]; then
 280     # an error happened, so we show the command's output at least.
 281     cat $outfile
 282     echo
 283     echo "There was a problem disabling the apache config file in:"
 284     echo "  $site_config"
 285     echo "Please consult the apache error logs for more details."
 286     exit 1
 287   fi
 288   \rm "$outfile"
 289 }
 290
 291 # turns on the config file we create above for apache.
 292 function enable_site()
 293 {
 294   local sitename="$1"; shift
 295   local site_config="/etc/apache2/sites-available/${sitename}.conf"
 296
 297   local outfile="$TMP/apacheout.$RANDOM"
 298   a2ensite "$(basename $site_config)" &>$outfile
 299   if [ $? -ne 0 ]; then
 300     # an error happened, so we show the command's output at least.
 301     cat $outfile
 302     echo
 303     echo "There was a problem enabling the apache config file in:"
 304     echo "  $site_config"
 305     echo "Please consult the apache error logs for more details."
 306     exit 1
 307   fi
 308   \rm "$outfile"
 309 }
 310
 311 # restarts the apache2 service.
 312 function restart_apache()
 313 {
 314   service apache2 restart
 315   if [ $? -ne 0 ]; then
 316     echo "There was a problem restarting the apache2 service."
 317     echo "Please consult the apache error logs for more details."
 318     exit 1
 319   fi
 320 }
 321
 322 # sets up the serverpilot storage location for a user hosted web site.
 323 function maybe_create_site_storage()
 324 {
 325   local our_app="$1"; shift
 326   # make sure the path for storage this app exists for the user.
 327   local full_path="$BASE_APPLICATION_PATH/$our_app"
 328   if [ ! -d "$full_path" ]; then
 329     mkdir -p $full_path
 330     test_or_die "The app storage path could not be created.\n  Path in question is: $full_path"
 331   fi
 332
 333   # now give the web server some access to the folder.  this is crucial since the folders
 334   # can be hosted in any user folder, and the group permissions will not necessarily be correct already.
 335   local chow_path="$full_path"
 336   # only the first chmod is recursive; the rest just apply to the specific folder of interest.
 337   chmod -R g+rx "$chow_path"
 338   # walk backwards up the path and fix perms.
 339   while [[ $chow_path != $HOME ]]; do
 340 echo chow path is now $chow_path
 341     chmod g+rx "$chow_path"
 342     test_or_die "Failed to add group permissions on the path: $chow_path"
 343     # reassert the user's ownership of any directories we might have just created.
 344     chown $(logname) "$chow_path"
 345     test_or_die "changing ownership to user failed on the path: $chow_path"
 346     chow_path="$(dirname "$chow_path")"
 347   done
 348 }
 349
 350 ############################################################################
 351
 352