--- legal.module Sat Sep 15 13:50:59 2007 +++ legal.module Mon Dec 31 12:29:54 2007 @@ -1,719 +1,730 @@ - l('page', 'legal'), '!access' => l('access control', 'admin/user/access'))); - } - return $output; -} - -function legal_perm() { - return array('administer Terms and Conditions', 'view Terms and Conditions'); -} - -function legal_access($op, $node) { - - if ($op == 'view' && (user_access('view Terms and Conditions') || user_access('administer Terms and Conditions') ) ) return TRUE; -} - -function legal_menu($may_cache) { - - $items = array(); - - if ($may_cache) { - - $items[] = array('path' => 'admin/settings/legal', - 'title' => t('Legal'), - 'callback' => 'drupal_get_form', - 'callback arguments' => array('legal_administration'), - 'access' => user_access('administer Terms and Conditions'), - 'description' => t('Display Terms and Conditions statement on the registration page.') - ); - $items[] = array('path' => 'legal', - 'title' => t('Terms and Conditions'), - 'callback' => 'legal_page', - 'access' => user_access('view Terms and Conditions'), - 'type' => MENU_CALLBACK - ); - } else { - $items[] = array('path' => 'legal_accept', - 'title' => t('Terms and Conditions'), - 'callback' => 'drupal_get_form', - 'callback arguments' => array('legal_login'), - 'access' => TRUE, - 'type' => MENU_CALLBACK - ); - } - - return $items; -} - -function legal_display_fields($conditions) { - - $form = array(); - - $form['current_id'] = array( - '#type' => 'value', - '#value' => $conditions['tc_id'], - ); - - $form['current_date'] = array( - '#type' => 'value', - '#value' => $conditions['date'], - ); - - $form['display'] = array( - '#type' => 'value', - '#value' => variable_get('legal_display', '0'), - ); - - $form['legal'] = array( - '#type' => 'fieldset', - '#title' => t('Terms and Conditions of Use'), - '#weight' => 29, - ); - - switch (variable_get('legal_display', '0')) { - - case 1: // scroll box (CSS) - case 2: // HTML - $form['legal']['conditions'] = array( - '#value' => filter_xss_admin($conditions['conditions']), - ); - break; - - default: // scroll box (HTML) - $form['legal']['conditions'] = array( - '#type' => 'textarea', - '#title' => t('Terms & Conditions'), - '#default_value' => $conditions['conditions'], - '#value' => $conditions['conditions'], - '#rows' => 10, - '#weight' => 0, - '#attributes' => array('readonly' => ''), - ); - } - - if (!empty($conditions['extras'])) { - while (list ($key, $label) = each ($conditions['extras'])) { - - if (!empty($label)) { - $form['legal'][$key] = array( - '#type' => 'checkbox', - '#title' => filter_xss_admin($label), - '#default_value' => 0, - '#weight' => 2, - '#required' => TRUE, - ); - } - } - } - - $form['legal']['legal_accept'] = array( - '#type' => 'checkbox', - '#title' => t('Accept Terms & Conditions of Use'), - '#default_value' => 0, - '#weight' => 50, - '#required' => TRUE, - ); - - return $form; -} - -function legal_page() { - - $conditions = legal_get_conditions(); - $output = drupal_get_form('legal_page_form', $conditions); - - return $output; -} - -function legal_page_form($conditions) { - - $form = legal_display_fields($conditions); - - $extras_count = count($conditions['extras']); - if ($extras_count < 5) $extras_count = 5; - - for ($counter = 1; $counter <= $extras_count; $counter++) { - - // overide extra checkboxes - $form['legal']['extras-' . $counter]['#disabled'] = TRUE; - $form['legal']['extras-' . $counter]['#required'] = FALSE; - } - - unset($form['legal']['legal_accept']); - - return $form; -} - -function legal_administration() { - - $conditions = legal_get_conditions(); - $form = legal_display_fields($conditions); - - $form['conditions'] = array( - '#type' => 'textarea', - '#title' => t('Terms & Conditions'), - '#default_value' => $conditions['conditions'], - '#description' => t('Your Terms & Conditions'), - '#required' => TRUE, - ); - - // overide accept checbox requirement on preview - $form['legal']['legal_accept']['#required'] = FALSE; - - // overide display setting - $form['display'] = array( - '#type' => 'radios', - '#title' => t('Display Style'), - '#default_value' => variable_get('legal_display', '0'), - '#options' => array(t('Scroll Box'), t('Scroll Box (CSS)'), t('HTML Text')), - '#description' => t('How terms & conditions should be displayed to users.'), - '#required' => TRUE, - ); - - // additional checkboxes - $form['extras'] = array( - '#type' => 'fieldset', - '#title' => t('Additional Checkboxes'), - '#description' => t('Each field will be shown as a checkbox which the user must tick to register.'), - '#collapsible' => TRUE, - '#collapsed' => TRUE, - '#tree' => TRUE, - ); - - $extras_count = count($conditions['extras']); - if ($extras_count < 5) $extras_count = 5; - - for ($counter = 1; $counter <= $extras_count; $counter++) { - - $form['extras']['extras-' . $counter] = array( - '#type' => 'textfield', - '#title' => t('Label'), - '#default_value' => $conditions['extras']['extras-' . $counter], - ); - - // overide extra checkboxes - $form['legal']['extras-' . $counter] = array( - '#type' => 'checkbox', - '#title' => filter_xss_admin($conditions['extras']['extras-' . $counter]), - '#default_value' => 0, - '#weight' => 2, - '#required' => FALSE, - ); - } - - // notes about changes to T&C - $form['changes'] = array( - '#type' => 'fieldset', - '#title' => t('Explain Changes'), - '#description' => t('Explain what changes were made to the T&C since the last version. This will only be shown to users who accepted a previous version. Each line will automatically be shown as a bullet point.'), - '#collapsible' => TRUE, - '#collapsed' => TRUE, - ); - - $form['changes']['changes'] = array( - '#type' => 'textarea', - '#title' => t('Changes'), - ); - - $form['#after_build'] = array('legal_preview'); - - $form['preview'] = array( - '#type' => 'button', - '#value' => t('Preview'), - ); - - $form['save'] = array( - '#type' => 'submit', - '#value' => t('Save'), - ); - - return $form; -} - - -function legal_preview($form, $form_values) { - - switch ($form['display']['#value']) { - - case 1: // scroll box (CSS) - case 2: // HTML - $form['legal']['conditions'] = array( - '#value' => filter_xss_admin($form['conditions']['#value']), - ); - break; - - default: // scroll box (HTML) - $form['legal']['conditions'] = array( - '#type' => 'textarea', - '#title' => t('Terms & Conditions'), - '#value' => $form['conditions']['#value'], - '#parents' => array('legal'), - '#rows' => 10, - '#attributes' => array('readonly' => ''), - ); - } - - // overide additional checkboxes in preview - if (!empty($form_values['extras'])) { - - while (list ($key, $label) = each ($form_values['extras'])) { - - if (empty($label)) { - unset($form['legal'][$key]); - } else { - $form['legal'][$key]['#title'] = filter_xss_admin($label); - } - - } - - } - - return $form; -} - -function legal_administration_validate($form_id, $form_values) { - - if ( empty($form_values['conditions']) ) form_set_error('conditions', t('Terms & Conditions must be entered.')); - return; -} - -function legal_administration_submit($form_id, $form_values) { - - if ($form_values['op'] == t('Preview')) return; - - if ( variable_get('legal_display', '0') != $form_values['display'] ) { - variable_set('legal_display', $form_values['display']); - drupal_set_message (t('Display setting has been saved.')); - } - - // If new conditions are different from current permisions - enter in database - if ( legal_conditions_updated($form_values) ) { - db_query("INSERT INTO {legal_conditions} (tc_id, conditions, date, extras, changes) VALUES (NULL, '%s', %d, '%s', '%s')", $form_values['conditions'], time(), serialize($form_values['extras']), $form_values['changes']); - drupal_set_message (t('Terms & Conditions have been saved.')); - } - - cache_clear_all(); - return; -} - - - -function theme_legal_administration($form) { - - if (empty($form['current_id']['#value'])) { - $output = '

' .t('Terms & Conditions will not be shown to users, as no T&C have been saved.') . '

'; - } else { - $output = '

' . t('Current Version') . '

' . t('Version ID:') . ' ' . $form['current_id']['#value'] . '
' . t('Last saved:') . ' ' . date("l jS \of F Y h:i:s A", $form['current_date']['#value']) . '

'; - } - - // preview - if (empty($form['legal']['conditions']['#value'])) { - drupal_render($form['legal']); - } else { - - $output .= '
'; - $output .= '

'. t('Preview') .'

'; - $form = theme('legal_display', $form); - $output .= drupal_render($form['legal']); - $output .= '
'; - } - - $output .= drupal_render($form); - - return $output; -} - -function theme_legal_display($form) { - - if (empty($form['legal']['conditions']['#value'])) return; - - // scroll box (CSS) - if ($form['display']['#value'] == 1) { - $path = base_path() . drupal_get_path('module', 'legal'); - drupal_add_css(drupal_get_path('module', 'legal') .'/legal.css'); - $form['legal']['conditions']['#prefix' ] = '
'; - $form['legal']['conditions']['#suffix' ] = '
'; - } - - return $form; -} - -function theme_legal_page($form) { - - if (empty($form['current_id']['#value'])) return; - - $form = theme('legal_display', $form); - $output .= drupal_render($form); - - return $output; -} - -function legal_user($op, &$edit, &$account, $category = FALSE) { - - global $user; - - switch ($op) { - case 'login': - - $conditions = legal_get_conditions(); - if (empty($conditions['conditions'])) return; - - $accepted = legal_version_check($user->uid, $conditions['tc_id']); - if ( $accepted == TRUE || $user->uid == 1 ) break; - - $uid = $user->uid; - - // Destroy the current session: - session_destroy(); - module_invoke_all('user', 'logout', NULL, $user); - - // We have to use $GLOBALS to unset a global variable: - $user = user_load(array('uid' => 0)); - unset($_REQUEST['destination']); - - $signatory = db_fetch_object( db_query('SELECT * FROM {users} WHERE uid = %d LIMIT 1', $uid) ); - - drupal_goto('legal_accept/' . $signatory->uid . '/' . md5($signatory->name . $signatory->password . $signatory->login)); - break; - - case 'register': - - $conditions = legal_get_conditions(); - if (empty($conditions['conditions'])) return; - - $form_fields = legal_display_fields($conditions); - - // disable checkbox if: - // user is already registered (administrator) - if (!empty($user->uid)) { - $form_fields['legal']['legal_accept']['#attributes'] = array('disabled' => 'disabled'); - $form_fields['legal']['legal_accept']['#required'] = FALSE; - - - reset($conditions['extras']); - while (list ($key, $label) = each ($conditions['extras'])) { - if (!empty($label)) { - $form_fields['legal'][$key]['#attributes'] = array('disabled' => 'disabled'); - $form_fields['legal'][$key]['#required'] = FALSE; - } - } - - - } else { - $form_fields['legal']['legal_accept']['#default_value'] = $edit['legal_accept']; - } - - $form = theme('legal_display', $form_fields); - return $form; - - case 'form': - - $conditions = legal_get_conditions(); - if (empty($conditions['conditions'])) return; - - if ($category == 'account') { - - $form_fields = legal_display_fields($conditions); - - // check latest version of T&C has been accepted - $accepted = legal_version_check($account->uid, $conditions['tc_id']); - - if ($accepted == TRUE) { - $form_fields['legal']['legal_accept']['#value'] = 1; - - if (!empty($conditions['extras'])) { - while (list ($key, $label) = each ($conditions['extras'])) { - if (!empty($label)) { - $form_fields['legal'][$key]['#value'] = 1; - } - } - } - } - - // disable checkbox if: - // user is not account owner - // latest T&C has already been accepted - if ($account->uid != $user->uid || $accepted == TRUE) { - $form_fields['legal']['legal_accept']['#attributes'] = array('disabled' => 'disabled'); - - if (!empty($conditions['extras'])) { - reset($conditions['extras']); - while (list ($key, $label) = each ($conditions['extras'])) { - if (!empty($label)) { - $form_fields['legal'][$key]['#attributes'] = array('disabled' => 'disabled'); - } - } - } - } - - // not required if user is not account owner - if ($account->uid != $user->uid) { - $form_fields['legal']['legal_accept']['#required'] = FALSE; - - if (!empty($conditions['extras'])) { - reset($conditions['extras']); - while (list ($key, $label) = each ($conditions['extras'])) { - if (!empty($label)) { - $form_fields['legal'][$key]['#required'] = FALSE; - } - } - } - } - - // enable account owner to accept - if ($account->uid == $user->uid && $accepted != TRUE) { - $form_fields['legal']['legal_accept']['#default_value'] = $edit['legal_accept']; - $form_fields['legal']['legal_accept']['#required'] = TRUE; - - if (!empty($conditions['extras'])) { - reset($conditions['extras']); - while (list ($key, $label) = each ($conditions['extras'])) { - if (!empty($label)) { - $form_fields['legal'][$key]['#default_value'] = $edit[$key]; - $form_fields['legal'][$key]['#required'] = TRUE; - } - } - } - - } - - $form = theme('legal_display', $form_fields); - return $form; - } - - break; - - case 'update': - - $conditions = legal_get_conditions(); - if (empty($conditions['conditions'])) return; - - $edit['legal_accept'] = NULL; - $edit['conditions'] = NULL; - - foreach ($conditions['extras'] as $key => $label) { - $edit[$key] = NULL; - } - - if ($account->uid != $user->uid) break; - - // if already accepted skip data entry - $accepted = legal_version_check($account->uid, $conditions['tc_id']); - - if ($accepted == TRUE) break; - - legal_save_accept($account->uid, $conditions['tc_id']); - break; - - case 'insert': - - $conditions = legal_get_conditions(); - if (empty($conditions['conditions'])) return; - - $edit['legal_accept'] = NULL; - - $edit['conditions'] = NULL; - - foreach ($conditions['extras'] as $key => $label) { - $edit[$key] = NULL; - } - - // don't insert if user is already registered (administrator) - if (!empty($user->uid)) break; - - legal_save_accept($account->uid, $conditions['tc_id']); - break; - } - - return; - } - -// force registered users to accept new T&C -function legal_login($uid, $id_hash = NULL) { - - $conditions = legal_get_conditions(); - $form = legal_display_fields($conditions); - - $form['uid'] = array( - '#type' => 'value', - '#value' => $uid, - ); - $form['id_hash'] = array( - '#type' => 'value', - '#value' => $id_hash, - ); - $form['tc_id'] = array( - '#type' => 'value', - '#value' => $conditions['tc_id'], - ); - - $form = legal_display_changes($form, $uid); - - $form['save'] = array( - '#type' => 'submit', - '#value' => t('Save'), - ); - - return $form; - -} - - -function legal_login_validate($form_id, $form_values) { - - $account = db_fetch_object( db_query('SELECT * FROM {users} WHERE uid = %d LIMIT 1', $form_values['uid']) ); - $id_hash = md5($account->name . $account->password . $account->login); - - if ($id_hash != $form_values['id_hash']) { - form_set_error('legal_accept', t('User ID cannot be identified.')); - drupal_goto(); - } - - return; -} - -function legal_login_submit($form_id, $form_values) { - - global $user; - $user = user_load(array('uid' => $form_values['uid'])); - - legal_save_accept($user->uid, $form_values['tc_id']); - - watchdog('user', t('Session opened for %name.', array('%name' => $user->name))); - - // Update the user table timestamp noting user has logged in. - db_query("UPDATE {users} SET login = '%d' WHERE uid = '%s'", time(), $user->uid); - - // user has new permissions, so we clear their menu cache - cache_clear_all($user->uid, 'cache_menu', TRUE); - - user_module_invoke('login', $edit, $user); - - return 'user/'. $user->uid; -} - -function theme_legal_login($form) { - - $form = theme('legal_display', $form); - - $output .= '

' . t('To continue to use this site please read the Terms & Conditions below, and complete the form to confirm your acceptance.' ) . '

'; - - if ($form['changes']) { - - foreach (element_children($form['changes']) as $key) { - $form['changes'][$key]['#prefix'] .= '
  • '; - $form['changes'][$key]['#suffix'] .= '
    • '; - } - - $form['changes']['start_list'] = array('#value' => '', '#weight' => 3); - $output .= drupal_render($form['changes']); - } - - $save = drupal_render($form['save']); - $output .= drupal_render($form); - $output .= $save; - - return $output; -} - -function legal_get_accept($uid) { - - $accept = db_fetch_object(db_query("SELECT * FROM {legal_accepted} WHERE uid = '%d' ORDER BY legal_id DESC LIMIT 1", $uid)); - return $accept; -} - - -function legal_save_accept($uid, $tc_id) { - - db_query("INSERT INTO {legal_accepted} (legal_id, uid, tc_id, accepted) VALUES (NULL, '%d', '%d', '%d')", $uid, $tc_id, time()); - - return; -} - -function legal_get_conditions() { - - $conditions = db_fetch_array(db_query("SELECT * FROM {legal_conditions} ORDER BY tc_id DESC LIMIT 1")); - $conditions['extras'] = unserialize($conditions['extras']); - return $conditions; -} - -function legal_conditions_updated($new) { - - $old = legal_get_conditions(); - if ($old['conditions'] != $new['conditions']) return TRUE; - - $count = count($new['extras']); - - for ($counter = 1; $counter <= $count; $counter++) { - - if ( $old['extras']['extras-' . $counter] != $new['extras']['extras-' . $counter] ) return TRUE; - } - - return FALSE; -} - -// get all changes since user last accepted -function legal_display_changes($form, $uid) { - - $last_accepted = legal_get_accept($uid); - if (empty($last_accepted)) return $form; - - $results = db_query("SELECT * FROM {legal_conditions} WHERE tc_id > %d ORDER BY tc_id DESC", $last_accepted->tc_id); - - if (empty($results)) return $form; - - $form['changes'] = array( - '#type' => 'fieldset', - '#title' => t('Changes List'), - '#description' => t('Changes to the Terms & Conditions since last accepted:'), - '#collapsible' => TRUE, - '#collapsed' => TRUE, - '#tree' => TRUE, - ); - - while ($conditions = db_fetch_object($results)) { - - unset($changes); - - if (!empty($conditions->changes)) { - - $changes = explode("\r\n", $conditions->changes); - - foreach($changes as $change) { - $form['changes'][] = array( - '#value' => filter_xss_admin($change), - '#weight' => 2, - ); - $is_list = TRUE; - } - } - - } - - if (!$is_list) $form['changes'] = NULL; - - return $form; -} - -// check if user has accepted latest version of T&C -function legal_version_check($uid, $current_tc_id) { - - $legal_account = legal_get_accept($uid); - if ($legal_account->tc_id == $current_tc_id) return TRUE; - - // get change log messages - return $log_messages; -} + l('page', 'legal'), '!access' => l('access control', 'admin/user/access'))); + } + return $output; +} + +function legal_perm() { + return array('administer Terms and Conditions', 'view Terms and Conditions'); +} + +function legal_access($op, $node) { + + if ($op == 'view' && (user_access('view Terms and Conditions') || user_access('administer Terms and Conditions') ) ) return TRUE; +} + +function legal_menu($may_cache) { + + $items = array(); + + if ($may_cache) { + + $items[] = array('path' => 'admin/settings/legal', + 'title' => t('Legal'), + 'callback' => 'drupal_get_form', + 'callback arguments' => array('legal_administration'), + 'access' => user_access('administer Terms and Conditions'), + 'description' => t('Display Terms and Conditions statement on the registration page.') + ); + $items[] = array('path' => 'legal', + 'title' => t('Terms and Conditions'), + 'callback' => 'legal_page', + 'access' => user_access('view Terms and Conditions'), + 'type' => MENU_CALLBACK + ); + } else { + $items[] = array('path' => 'legal_accept', + 'title' => t('Terms and Conditions'), + 'callback' => 'drupal_get_form', + 'callback arguments' => array('legal_login'), + 'access' => TRUE, + 'type' => MENU_CALLBACK + ); + } + + return $items; +} + +function legal_display_fields($conditions) { + + $form = array(); + + $form['current_id'] = array( + '#type' => 'value', + '#value' => $conditions['tc_id'], + ); + + $form['current_date'] = array( + '#type' => 'value', + '#value' => $conditions['date'], + ); + + $form['display'] = array( + '#type' => 'value', + '#value' => variable_get('legal_display', '0'), + ); + + $form['legal'] = array( + '#type' => 'fieldset', + '#title' => t('Terms and Conditions of Use'), + '#weight' => 29, + ); + + switch (variable_get('legal_display', '0')) { + + case 1: // scroll box (CSS) + case 2: // HTML + $form['legal']['conditions'] = array( + '#value' => filter_xss_admin($conditions['conditions']), + ); + break; + + default: // scroll box (HTML) + $form['legal']['conditions'] = array( + '#type' => 'textarea', + '#title' => t('Terms & Conditions'), + '#default_value' => $conditions['conditions'], + '#value' => $conditions['conditions'], + '#rows' => 10, + '#weight' => 0, + '#attributes' => array('readonly' => ''), + ); + } + + if (!empty($conditions['extras'])) { + while (list ($key, $label) = each ($conditions['extras'])) { + + if (!empty($label)) { + $form['legal'][$key] = array( + '#type' => 'checkbox', + '#title' => filter_xss_admin($label), + '#default_value' => 0, + '#weight' => 2, + '#required' => TRUE, + ); + } + } + } + + $form['legal']['legal_accept'] = array( + '#type' => 'checkbox', + '#title' => t('Accept Terms & Conditions of Use'), + '#default_value' => 0, + '#weight' => 50, + '#required' => TRUE, + ); + + return $form; +} + +function legal_page() { + + $conditions = legal_get_conditions(); + + $output = ''; + switch(variable_get('legal_display', '0')) { + case 0: // Scroll Box + $output = nl2br(strip_tags($conditions['conditions'])); + break; + case 1: // Scroll Box w/ HTML + case 2: // Straight HTML + $output = filter_xss_admin($conditions['conditions']); + break; + } + + return $output; +} + +function legal_page_form($conditions) { + + $form = legal_display_fields($conditions); + + $extras_count = count($conditions['extras']); + if ($extras_count < 5) $extras_count = 5; + + for ($counter = 1; $counter <= $extras_count; $counter++) { + + // overide extra checkboxes + $form['legal']['extras-' . $counter]['#disabled'] = TRUE; + $form['legal']['extras-' . $counter]['#required'] = FALSE; + } + + unset($form['legal']['legal_accept']); + + return $form; +} + +function legal_administration() { + + $conditions = legal_get_conditions(); + $form = legal_display_fields($conditions); + + $form['conditions'] = array( + '#type' => 'textarea', + '#title' => t('Terms & Conditions'), + '#default_value' => $conditions['conditions'], + '#description' => t('Your Terms & Conditions'), + '#required' => TRUE, + ); + + // overide accept checbox requirement on preview + $form['legal']['legal_accept']['#required'] = FALSE; + + // overide display setting + $form['display'] = array( + '#type' => 'radios', + '#title' => t('Display Style'), + '#default_value' => variable_get('legal_display', '0'), + '#options' => array(t('Scroll Box'), t('Scroll Box w/ HTML (CSS)'), t('HTML Text')), + '#description' => t('How terms & conditions should be displayed to users.'), + '#required' => TRUE, + ); + + // additional checkboxes + $form['extras'] = array( + '#type' => 'fieldset', + '#title' => t('Additional Checkboxes'), + '#description' => t('Each field will be shown as a checkbox which the user must tick to register.'), + '#collapsible' => TRUE, + '#collapsed' => TRUE, + '#tree' => TRUE, + ); + + $extras_count = count($conditions['extras']); + if ($extras_count < 5) $extras_count = 5; + + for ($counter = 1; $counter <= $extras_count; $counter++) { + + $form['extras']['extras-' . $counter] = array( + '#type' => 'textfield', + '#title' => t('Label'), + '#default_value' => $conditions['extras']['extras-' . $counter], + ); + + // overide extra checkboxes + $form['legal']['extras-' . $counter] = array( + '#type' => 'checkbox', + '#title' => filter_xss_admin($conditions['extras']['extras-' . $counter]), + '#default_value' => 0, + '#weight' => 2, + '#required' => FALSE, + ); + } + + // notes about changes to T&C + $form['changes'] = array( + '#type' => 'fieldset', + '#title' => t('Explain Changes'), + '#description' => t('Explain what changes were made to the T&C since the last version. This will only be shown to users who accepted a previous version. Each line will automatically be shown as a bullet point.'), + '#collapsible' => TRUE, + '#collapsed' => TRUE, + ); + + $form['changes']['changes'] = array( + '#type' => 'textarea', + '#title' => t('Changes'), + ); + + $form['#after_build'] = array('legal_preview'); + + $form['preview'] = array( + '#type' => 'button', + '#value' => t('Preview'), + ); + + $form['save'] = array( + '#type' => 'submit', + '#value' => t('Save'), + ); + + return $form; +} + + +function legal_preview($form, $form_values) { + + switch ($form['display']['#value']) { + + case 1: // scroll box (CSS) + case 2: // HTML + $form['legal']['conditions'] = array( + '#value' => filter_xss_admin($form['conditions']['#value']), + ); + break; + + default: // scroll box (HTML) + $form['legal']['conditions'] = array( + '#type' => 'textarea', + '#title' => t('Terms & Conditions'), + '#value' => $form['conditions']['#value'], + '#parents' => array('legal'), + '#rows' => 10, + '#attributes' => array('readonly' => ''), + ); + } + + // overide additional checkboxes in preview + if (!empty($form_values['extras'])) { + + while (list ($key, $label) = each ($form_values['extras'])) { + + if (empty($label)) { + unset($form['legal'][$key]); + } else { + $form['legal'][$key]['#title'] = filter_xss_admin($label); + } + + } + + } + + return $form; +} + +function legal_administration_validate($form_id, $form_values) { + + if ( empty($form_values['conditions']) ) form_set_error('conditions', t('Terms & Conditions must be entered.')); + return; +} + +function legal_administration_submit($form_id, $form_values) { + + if ($form_values['op'] == t('Preview')) return; + + if ( variable_get('legal_display', '0') != $form_values['display'] ) { + variable_set('legal_display', $form_values['display']); + drupal_set_message (t('Display setting has been saved.')); + } + + // If new conditions are different from current permisions - enter in database + if ( legal_conditions_updated($form_values) ) { + db_query("INSERT INTO {legal_conditions} (tc_id, conditions, date, extras, changes) VALUES (NULL, '%s', %d, '%s', '%s')", $form_values['conditions'], time(), serialize($form_values['extras']), $form_values['changes']); + drupal_set_message (t('Terms & Conditions have been saved.')); + } + + cache_clear_all(); + return; +} + + + +function theme_legal_administration($form) { + + if (empty($form['current_id']['#value'])) { + $output = '

    ' .t('Terms & Conditions will not be shown to users, as no T&C have been saved.') . '

    '; + } else { + $output = '

    ' . t('Current Version') . '

    ' . t('Version ID:') . ' ' . $form['current_id']['#value'] . '
    ' . t('Last saved:') . ' ' . date("l jS \of F Y h:i:s A", $form['current_date']['#value']) . '

    '; + } + + // preview + if (empty($form['legal']['conditions']['#value'])) { + drupal_render($form['legal']); + } else { + + $output .= '
    '; + $output .= '

    '. t('Preview') .'

    '; + $form = theme('legal_display', $form); + $output .= drupal_render($form['legal']); + $output .= '
    '; + } + + $output .= drupal_render($form); + + return $output; +} + +function theme_legal_display($form) { + + if (empty($form['legal']['conditions']['#value'])) return; + + // scroll box (CSS) + if ($form['display']['#value'] == 1) { + $path = base_path() . drupal_get_path('module', 'legal'); + drupal_add_css(drupal_get_path('module', 'legal') .'/legal.css'); + $form['legal']['conditions']['#prefix' ] = '
    '; + $form['legal']['conditions']['#suffix' ] = '
    '; + } + + return $form; +} + +function theme_legal_page($form) { + + if (empty($form['current_id']['#value'])) return; + + $form = theme('legal_display', $form); + $output .= drupal_render($form); + + return $output; +} + +function legal_user($op, &$edit, &$account, $category = FALSE) { + + global $user; + + switch ($op) { + case 'login': + + $conditions = legal_get_conditions(); + if (empty($conditions['conditions'])) return; + + $accepted = legal_version_check($user->uid, $conditions['tc_id']); + if ( $accepted == TRUE || $user->uid == 1 ) break; + + $uid = $user->uid; + + // Destroy the current session: + session_destroy(); + module_invoke_all('user', 'logout', NULL, $user); + + // We have to use $GLOBALS to unset a global variable: + $user = user_load(array('uid' => 0)); + unset($_REQUEST['destination']); + + $signatory = db_fetch_object( db_query('SELECT * FROM {users} WHERE uid = %d LIMIT 1', $uid) ); + + drupal_goto('legal_accept/' . $signatory->uid . '/' . md5($signatory->name . $signatory->password . $signatory->login)); + break; + + case 'register': + + $conditions = legal_get_conditions(); + if (empty($conditions['conditions'])) return; + + $form_fields = legal_display_fields($conditions); + + // disable checkbox if: + // user is already registered (administrator) + if (!empty($user->uid)) { + $form_fields['legal']['legal_accept']['#attributes'] = array('disabled' => 'disabled'); + $form_fields['legal']['legal_accept']['#required'] = FALSE; + + + reset($conditions['extras']); + while (list ($key, $label) = each ($conditions['extras'])) { + if (!empty($label)) { + $form_fields['legal'][$key]['#attributes'] = array('disabled' => 'disabled'); + $form_fields['legal'][$key]['#required'] = FALSE; + } + } + + + } else { + $form_fields['legal']['legal_accept']['#default_value'] = $edit['legal_accept']; + } + + $form = theme('legal_display', $form_fields); + return $form; + + case 'form': + + $conditions = legal_get_conditions(); + if (empty($conditions['conditions'])) return; + + if ($category == 'account') { + + $form_fields = legal_display_fields($conditions); + + // check latest version of T&C has been accepted + $accepted = legal_version_check($account->uid, $conditions['tc_id']); + + if ($accepted == TRUE) { + $form_fields['legal']['legal_accept']['#value'] = 1; + + if (!empty($conditions['extras'])) { + while (list ($key, $label) = each ($conditions['extras'])) { + if (!empty($label)) { + $form_fields['legal'][$key]['#value'] = 1; + } + } + } + } + + // disable checkbox if: + // user is not account owner + // latest T&C has already been accepted + if ($account->uid != $user->uid || $accepted == TRUE) { + $form_fields['legal']['legal_accept']['#attributes'] = array('disabled' => 'disabled'); + + if (!empty($conditions['extras'])) { + reset($conditions['extras']); + while (list ($key, $label) = each ($conditions['extras'])) { + if (!empty($label)) { + $form_fields['legal'][$key]['#attributes'] = array('disabled' => 'disabled'); + } + } + } + } + + // not required if user is not account owner + if ($account->uid != $user->uid) { + $form_fields['legal']['legal_accept']['#required'] = FALSE; + + if (!empty($conditions['extras'])) { + reset($conditions['extras']); + while (list ($key, $label) = each ($conditions['extras'])) { + if (!empty($label)) { + $form_fields['legal'][$key]['#required'] = FALSE; + } + } + } + } + + // enable account owner to accept + if ($account->uid == $user->uid && $accepted != TRUE) { + $form_fields['legal']['legal_accept']['#default_value'] = $edit['legal_accept']; + $form_fields['legal']['legal_accept']['#required'] = TRUE; + + if (!empty($conditions['extras'])) { + reset($conditions['extras']); + while (list ($key, $label) = each ($conditions['extras'])) { + if (!empty($label)) { + $form_fields['legal'][$key]['#default_value'] = $edit[$key]; + $form_fields['legal'][$key]['#required'] = TRUE; + } + } + } + + } + + $form = theme('legal_display', $form_fields); + return $form; + } + + break; + + case 'update': + + $conditions = legal_get_conditions(); + if (empty($conditions['conditions'])) return; + + $edit['legal_accept'] = NULL; + $edit['conditions'] = NULL; + + foreach ($conditions['extras'] as $key => $label) { + $edit[$key] = NULL; + } + + if ($account->uid != $user->uid) break; + + // if already accepted skip data entry + $accepted = legal_version_check($account->uid, $conditions['tc_id']); + + if ($accepted == TRUE) break; + + legal_save_accept($account->uid, $conditions['tc_id']); + break; + + case 'insert': + + $conditions = legal_get_conditions(); + if (empty($conditions['conditions'])) return; + + $edit['legal_accept'] = NULL; + + $edit['conditions'] = NULL; + + foreach ($conditions['extras'] as $key => $label) { + $edit[$key] = NULL; + } + + // don't insert if user is already registered (administrator) + if (!empty($user->uid)) break; + + legal_save_accept($account->uid, $conditions['tc_id']); + break; + } + + return; + } + +// force registered users to accept new T&C +function legal_login($uid, $id_hash = NULL) { + + $conditions = legal_get_conditions(); + $form = legal_display_fields($conditions); + + $form['uid'] = array( + '#type' => 'value', + '#value' => $uid, + ); + $form['id_hash'] = array( + '#type' => 'value', + '#value' => $id_hash, + ); + $form['tc_id'] = array( + '#type' => 'value', + '#value' => $conditions['tc_id'], + ); + + $form = legal_display_changes($form, $uid); + + $form['save'] = array( + '#type' => 'submit', + '#value' => t('Save'), + ); + + return $form; + +} + + +function legal_login_validate($form_id, $form_values) { + + $account = db_fetch_object( db_query('SELECT * FROM {users} WHERE uid = %d LIMIT 1', $form_values['uid']) ); + $id_hash = md5($account->name . $account->password . $account->login); + + if ($id_hash != $form_values['id_hash']) { + form_set_error('legal_accept', t('User ID cannot be identified.')); + drupal_goto(); + } + + return; +} + +function legal_login_submit($form_id, $form_values) { + + global $user; + $user = user_load(array('uid' => $form_values['uid'])); + + legal_save_accept($user->uid, $form_values['tc_id']); + + watchdog('user', t('Session opened for %name.', array('%name' => $user->name))); + + // Update the user table timestamp noting user has logged in. + db_query("UPDATE {users} SET login = '%d' WHERE uid = '%s'", time(), $user->uid); + + // user has new permissions, so we clear their menu cache + cache_clear_all($user->uid, 'cache_menu', TRUE); + + user_module_invoke('login', $edit, $user); + + return 'user/'. $user->uid; +} + +function theme_legal_login($form) { + + $form = theme('legal_display', $form); + + $output .= '

    ' . t('To continue to use this site please read the Terms & Conditions below, and complete the form to confirm your acceptance.' ) . '

    '; + + if ($form['changes']) { + + foreach (element_children($form['changes']) as $key) { + $form['changes'][$key]['#prefix'] .= '
  • '; + $form['changes'][$key]['#suffix'] .= '
    • '; + } + + $form['changes']['start_list'] = array('#value' => '', '#weight' => 3); + $output .= drupal_render($form['changes']); + } + + $save = drupal_render($form['save']); + $output .= drupal_render($form); + $output .= $save; + + return $output; +} + +function legal_get_accept($uid) { + + $accept = db_fetch_object(db_query("SELECT * FROM {legal_accepted} WHERE uid = '%d' ORDER BY legal_id DESC LIMIT 1", $uid)); + return $accept; +} + + +function legal_save_accept($uid, $tc_id) { + + db_query("INSERT INTO {legal_accepted} (legal_id, uid, tc_id, accepted) VALUES (NULL, '%d', '%d', '%d')", $uid, $tc_id, time()); + + return; +} + +function legal_get_conditions() { + + $conditions = db_fetch_array(db_query("SELECT * FROM {legal_conditions} ORDER BY tc_id DESC LIMIT 1")); + $conditions['extras'] = unserialize($conditions['extras']); + return $conditions; +} + +function legal_conditions_updated($new) { + + $old = legal_get_conditions(); + if ($old['conditions'] != $new['conditions']) return TRUE; + + $count = count($new['extras']); + + for ($counter = 1; $counter <= $count; $counter++) { + + if ( $old['extras']['extras-' . $counter] != $new['extras']['extras-' . $counter] ) return TRUE; + } + + return FALSE; +} + +// get all changes since user last accepted +function legal_display_changes($form, $uid) { + + $last_accepted = legal_get_accept($uid); + if (empty($last_accepted)) return $form; + + $results = db_query("SELECT * FROM {legal_conditions} WHERE tc_id > %d ORDER BY tc_id DESC", $last_accepted->tc_id); + + if (empty($results)) return $form; + + $form['changes'] = array( + '#type' => 'fieldset', + '#title' => t('Changes List'), + '#description' => t('Changes to the Terms & Conditions since last accepted:'), + '#collapsible' => TRUE, + '#collapsed' => TRUE, + '#tree' => TRUE, + ); + + while ($conditions = db_fetch_object($results)) { + + unset($changes); + + if (!empty($conditions->changes)) { + + $changes = explode("\r\n", $conditions->changes); + + foreach($changes as $change) { + $form['changes'][] = array( + '#value' => filter_xss_admin($change), + '#weight' => 2, + ); + $is_list = TRUE; + } + } + + } + + if (!$is_list) $form['changes'] = NULL; + + return $form; +} + +// check if user has accepted latest version of T&C +function legal_version_check($uid, $current_tc_id) { + + $legal_account = legal_get_accept($uid); + if ($legal_account->tc_id == $current_tc_id) return TRUE; + + // get change log messages + return $log_messages; +} --- README.txt Sat Sep 15 13:50:59 2007 +++ README.txt Mon Dec 31 12:36:43 2007 @@ -1,80 +1,81 @@ -******************************************************************** -D R U P A L M O D U L E -******************************************************************** -Name: Legal module -Author: Robert Castelo -Drupal: 5.0.x -******************************************************************** -DESCRIPTION: - - A module which displays your Terms & Conditions to users who want to - register, and makes sure they accept the T&C before their registration - is accepted. - - Note: No T&C will be displayed until the T&C text has been input by - the administrator. - - Each time a new version of the T&C is created all users will be required to - accept the new version. - - - -******************************************************************** -INSTALLATION: - - Note: It is assumed that you have Drupal up and running. Be sure to - check the Drupal web site if you need assistance. If you run into - problems, you should always read the INSTALL.txt that comes with the - Drupal package and read the online documentation. - - 1. Place the entire legal directory into your Drupal - modules/directory. - - 2. Enable the legal module by navigating to: - - Administer > Site building > Modules - - Click the 'Save configuration' button at the bottom to commit your - changes. - - - -******************************************************************** -CONFIGURATION - - 1. Go to Administer > User management > Access control - - Set which roles can "view Terms and Conditions" - Set which roles can "administer Terms and Conditions" - - 2. Go to Administer > Site configuration > Legal - - Input your terms & conditions text, set how you would like it - displayed: - - - Scroll Box - Standard form text box (read only) Text is entered - and displayed as text only - - - Scroll Box (CSS) - Scrollable text box created in CSS Text should - be entered with HTML formatting. - (less accessible than a standard scroll box) - - - HTML Text - Terms & conditions displayed as HTML formatted text - Text should be entered with HTML formatting - - - -******************************************************************** -ACKNOWLEDGEMENTS - -* Drupal 5 update sponsorship -Lullabot (http://www.lullabot.com) - - -* User data variables clean up -Steven Wittens (Steven) - - - - - +******************************************************************** +D R U P A L M O D U L E +******************************************************************** +Name: Legal module +Author: Robert Castelo +Drupal: 5.0.x +******************************************************************** +DESCRIPTION: + + A module which displays your Terms & Conditions to users who want to + register, and makes sure they accept the T&C before their registration + is accepted. + + Note: No T&C will be displayed until the T&C text has been input by + the administrator. + + Each time a new version of the T&C is created all users will be required to + accept the new version. + + + +******************************************************************** +INSTALLATION: + + Note: It is assumed that you have Drupal up and running. Be sure to + check the Drupal web site if you need assistance. If you run into + problems, you should always read the INSTALL.txt that comes with the + Drupal package and read the online documentation. + + 1. Place the entire legal directory into your Drupal + modules/directory. + + 2. Enable the legal module by navigating to: + + Administer > Site building > Modules + + Click the 'Save configuration' button at the bottom to commit your + changes. + + + +******************************************************************** +CONFIGURATION + + 1. Go to Administer > User management > Access control + + Set which roles can "view Terms and Conditions" + Set which roles can "administer Terms and Conditions" + + 2. Go to Administer > Site configuration > Legal + + Input your terms & conditions text, set how you would like it + displayed: + + - Scroll Box - Standard form text box (read only) Text is entered + and displayed as text only. Will be displayed as plain text on T&C + page. + + - Scroll Box w/ HTML (CSS) - Scrollable text box created in CSS. + Text should be entered with HTML formatting. Will be displayed as + HTML on T&C page. Less accessible than a standard scroll box! + + - HTML Text - Terms & conditions displayed as HTML formatted text. + Will be displayed as HTML on T&C page. Text should be entered with + HTML formatting. + + +******************************************************************** +ACKNOWLEDGEMENTS + +* Drupal 5 update sponsorship +Lullabot (http://www.lullabot.com) + + +* User data variables clean up +Steven Wittens (Steven) + + + + +