root/drupal/modules/iutilities/trunk/iutilities.module

<?php
// $Id$

function iutilities_perm() {
        return array('access disk usage information', 'access disk usage settings');
} // function illuminate_perm()

function iutilities_admin() {
        $form['i_general'] = array(
                '#type' => 'fieldset',
                '#title' => 'General',
                '#description' => 'The settings apply to all the utilities below.',
        );
        $form['i_general']['email_warnings_role'] = array(
                '#type' => 'textfield',
                '#title' => t('Role to receive warning emails'),
                '#default_value' => variable_get('email_warnings_role', 'site administrator'),
                '#size' => 20,
                '#maxlength' => 25,
                '#description' => t("The role entered here here will receive warning messages by email."),
                '#required' => TRUE,
        );
        $form['i_general']['illuminate_notes'] = array(
                '#type' => 'textarea',
                '#title' => 'Notes',
                '#default_value' => variable_get('illuminate_notes','Type any notes about this contract in this box.'),
                '#description' => 'Any notes relating to this contract can go in here.',
                '#rows' => 4,
                '#resizable' => TRUE,
        );
        $form['i_diskspace'] = array(
                '#type' => 'fieldset',
                '#title' => 'Disk Space Usage Settings',
                '#description' => 'These settings apply to disk usage on this site.',
        );
        $form['i_diskspace']['disk_space_limit'] = array(
                '#type' => 'textfield',
                '#title' => t('Maximum space allowed'),
                '#default_value' => variable_get('disk_space_limit', 150),
                '#size' => 5,
                '#maxlength' => 4,
                '#field_suffix' => t('MB'),
                '#description' => t("Each illuminate ict website is permitted a certain amount of space. By default this is 150MB. This can be increased here."),
                '#required' => TRUE,
        );
        $form['i_hostingdate'] = array(
                '#type' => 'fieldset',
                '#title' => 'Hosting date settings.',
                '#description' => 'These settings apply to the length and expiry of hosting contracts.',
        );
        $next_year = time() + 31556926;
        $default_expiry = variable_get('hosting_expiry_date', $next_year);
        if (!is_array($default_expiry)) {
                $default_expiry = array(
                        'month' => format_date($default_expiry, 'custom', 'n'),
                        'day' => format_date($default_expiry, 'custom', 'j'),
                        'year' => format_date($default_expiry, 'custom', 'Y'),
                );
        }       
        $now = time();
        $default_start = variable_get('hosting_start_date',$now);
        if (!is_array($default_start)) {
                $default_start = array(
                        'month' => format_date($default_start, 'custom', 'n'),
                        'day' => format_date($default_start, 'custom', 'j'),
                        'year' => format_date($default_start, 'custom', 'Y'),
                );
        }       
        $form['i_hostingdate']['hosting_start_date'] = array(
                '#type' => 'date',
                '#title' => t('Hosting start date'),
                '#default_value' => $default_start,
                '#description' => t("Hosting for this site began on the date here. This should not be changed once set."),
                '#required' => TRUE,
        );
        $form['i_hostingdate']['hosting_expiry_date'] = array(
                '#type' => 'date',
                '#title' => t('Hosting expiry date'),
                '#default_value' => $default_expiry,
                '#description' => t("Hosting for this site expires on the date here. Users with the role defined above will recieve reminder emails when the renewal date approaches"),
                '#required' => TRUE,
        );
        $hosting_term_period = drupal_map_assoc(
                array(
                        31536000,
                        2*31536000,
                        3*31536000,
                        4*31536000,
                        5*31536000,
                        6*31536000,
                        7*31536000,
                        8*31536000,
                        9*31536000,
                        10*31536000,
                        11*31536000,
                        12*31536000
                ), 'format_interval'
        );
        $form['i_hostingdate']['hosting_term'] = array(
                '#type' => 'select',
                '#title' => t('Web hosting term'),
                '#default_value' => variable_get('hosting_term', 31536000),
                '#options' => $hosting_term_period,
                '#description' => t(""),
                '#required' => TRUE,
        );
        $form['i_hostingcost'] = array(
                '#type' => 'fieldset',
                '#title' => 'Hosting cost settings',
                '#description' => 'These settings apply to the cost of hosting contracts.',
        );
        $form['i_hostingcost']['hosting_cost'] = array(
                '#type' => 'textfield',
                '#title' => t('Yearly hosting costs'),
                '#default_value' => variable_get('hosting_cost', 240),
                '#size' => 5,
                '#maxlength' => 4,
                '#field_prefix' => t('&pound;'),
                '#description' => t("This is the yearly cost of hosting for this website."),
                '#required' => TRUE,
        );
        
        return system_settings_form($form);
}

function iutilities_cron() {
        $confpath = conf_path();
        
        //deal with space usage things
        $space_used_string = `du -sm $confpath`;
        $space_used_array = explode("\t", $space_used_string);
        $space_used = (int) trim($space_used_array[0]);
        variable_set('disk_space_used', $space_used);   
        $disk_space_limit = (int) variable_get('disk_space_limit',150);
        //how long since a warning email was sent??
        $time_now = (int) time();
        $time_last_email = (int) variable_get('disk_space_last_emailed',0);
        $time_since_email = (int) $time_now - $time_last_email;
        //email if space allowance has been exceeded
        // but only email if not yet emailed
        // or it's more than a week since an email was sent
        if ( $space_used > $disk_space_limit && ($time_last_email==0 || $time_since_email > 604799) ) {
                $site_default_language = language_default();
                $email_warnings_role = variable_get('email_warnings_role', 'site administrator');
                $users_with_role_query = "select u.mail from {users} u inner join {users_roles} ur on u.uid=ur.uid inner join {role} r on r.rid=ur.rid where r.name='%s'";
                $result = db_query(db_rewrite_sql($users_with_role_query),$email_warnings_role);
                while ($data = db_fetch_object($result)) {
                        drupal_mail('iutilities', 'warning', $data->mail, $site_default_language, $params);
                }
                //set a variable which notes that an email has been sent.
                $time_stamp = (int) time();
                variable_set('disk_space_last_emailed',$time_stamp);
        } elseif ($space_used <= $disk_space_limit) {
                variable_set('disk_space_last_emailed',0);
        }
        
        //deal with hosting expiry things
        //get the hosting expiry date & convert to UNIX time
        $expiry_date = variable_get('hosting_expiry_date', time());
        if ( is_array($expiry_date) ) {
                $expiry_date_timestamp = mktime(0,0,0,$expiry_date['month'],$expiry_date['day'],$expiry_date['year']);
                $warnings_start_date = $expiry_date_timestamp - 2592000;
                //warning messages will begin a month before contract expiry - 2592000s = 1 month.
                $now = time();
                if ( $warnings_start_date < $now ) {
                        //do the sending email thing, no more than once a week.
                        $site_default_language = language_default();
                        $email_warnings_role = variable_get('email_warnings_role', 'site administrator');
                        $users_with_role_query = "select u.mail from {users} u inner join {users_roles} ur on u.uid=ur.uid inner join {role} r on r.rid=ur.rid where r.name='%s'";
                        $result = db_query(db_rewrite_sql($users_with_role_query),$email_warnings_role);
                        while ($data = db_fetch_object($result)) {
                                drupal_mail('iutilities', 'hosting_expiry', $data->mail, $site_default_language, $params);
                        }
                        //set a variable which notes that an email has been sent.
                        variable_set('hosting_expiry_last_emailed',$now);
                } elseif ( $warnings_start_date >= $now ) {
                        variable_set('hosting_expiry_last_emailed',0);
                }
        }
        
}

function iutilities_mail($key, &$message, $params) {
        global $base_url;
        $space_used = variable_get('disk_space_used',150);
        $space_limit = variable_get('disk_space_limit',150);
        switch($key) {
        case 'warning':
                $message['subject'] = t('Space usage warning from ' . $base_url);
                $message['body'] = t("An information message from your website host, ILLUMINATE ICT\n------------------------------------------------\n\nYou are listed as being a site administrator for $base_url.\n\nThis email is to inform you that you are currently exceeding your space allocation on our webserver. You have been allocated " . $space_limit . "MB and you are using " . $space_used . "MB.\n\nWe are not about to discontinue your service, but we would appreciate it if you would get in touch to discuss how we could help you. Contact us at http://www.illuminateict.org.uk.\n\nYou will receive this email weekly until we can help you to reduce the amount of space you are using, or increase your space allowance on the server.");
                break;
        case 'hosting_expiry':
                $message['subject'] = t('Hosting expiry warning from ' . $base_url);
                $message['body'] = t("You are about to run out of time.");
        }
}

function iutilities_menu() {
        $items['admin/reports/illuminate'] = array(
                'title' => 'Illuminate Hosting Report',
                'description' => 'Dispay a hosting report for this website. Includes the space limit for the site and other contract information.',
                'access arguments' => array('access disk usage information'),
                'page callback' => 'display_diskusage_report',
        );
        $items['admin/settings/illuminate'] = array(
                'title' => 'Set Hosting Defaults',
                'description' => 'Hosting defaults can be changed here.',
                'access callback' => 'access_disk_usage_settings',
                'access arguments' => array('access disk usage settings'),
                'page callback' => 'drupal_get_form',
                'page arguments' => array(iutilities_admin),
        );
        return $items;
} // illuminate_menu()

function access_disk_usage_settings() {
        global $user;
        if ( $user->uid == 1 ) {
                return TRUE;
        } else {
                return FALSE;
        }
}

function display_diskusage_report() {
        $space_used = variable_get('disk_space_used',150);
        $space_limit = variable_get('disk_space_limit',150);
        $space_percentage = ( $space_used / $space_limit ) * 100;
        $output = '<p>Your hosting account with illuminate ICT allows a maximum of <strong>'. $space_limit . 'MB</strong>.</p>';
        $output .= '<p>You are currently using <strong>' . $space_used . 'MB</strong> of your allowance.</p>';
        $output .= '<p>This is <strong>' . $space_percentage . '&#37;</strong> of the available space.</p>';
        return $output;
}


function iutilities_init() {
  //include necessary css
  global $user;
  if ($user->uid > 0) {
    $path = drupal_get_path('module', 'illuminate');
    drupal_add_css($path . '/iutilities.css', 'module', 'all', FALSE);
  }
}

function iutilities_footer($main=0) {
  //output footer message
  global $user;

  $siteDir =   "sites/" . $_SERVER[SERVER_NAME];
  $path = drupal_get_path('module', 'illuminate');
  //footer message is available for all users
  if ($user->uid == 0) {
    $loginLink = '<a href="/user/login">[login]</a>';
  } else {
    $loginLink = '<a href="/logout">[logout]</a>';
  }
  $illuminateStuff =  $loginLink . ' <br/>Website developed in association with <a href="http://www.illuminateict.org.uk">Illuminate ICT</a>';
  
  return $illuminateStuff;
}