wordfilter.admin.inc in Wordfilter 7

Administrative functions for word filtering.
This provides the UI to list, create, edit and delete words to be filtered.
File

wordfilter.admin.inc
View source
<?php

/**
 * @file
 * Administrative functions for word filtering.
 *
 * This provides the UI to list, create, edit and delete words to be filtered.
 */

/**
 * Word filter admin configuration form.
 *
 * @return
 *   array of form elements
 */
function wordfilter_settings_form() {
  $form = array();
  $form['general_options'] = array(
    '#type' => 'fieldset',
    '#title' => t('General options'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );
  $form['general_options']['wordfilter_node_title'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable word filtering on node titles'),
    '#description' => t('If checked, node titles will be filtered on node load but the original node title will not be changed.'),
    '#default_value' => variable_get('wordfilter_node_title', TRUE),
    '#return_value' => TRUE,
  );
  $form['general_options']['wordfilter_comment_title'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable word filtering on comment titles'),
    '#description' => t('If checked, comment titles will be filtered on comment load but the original comment title will not be changed.'),
    '#default_value' => variable_get('wordfilter_comment_title', TRUE),
    '#return_value' => TRUE,
  );
  $form['general_options']['wordfilter_process_case_sensitive'] = array(
    '#type' => 'checkbox',
    '#title' => t('Process word filters using case sensitivity'),
    '#description' => t("If checked, case sensitivity is used when checking text against the list of words to replace. For example searching for 'foo' and 'Foo' will only match once for the string 'foo and bar'."),
    '#default_value' => variable_get('wordfilter_process_case_sensitive', FALSE),
    '#return_value' => TRUE,
  );
  $form['general_options']['wordfilter_use_utf8_flag'] = array(
    '#type' => 'checkbox',
    '#title' => t('Use Perl UTF8 Regular Expression Modifier'),
    '#description' => t('Enabling this option adds the PCRE_UTF8 flag to the PHP Perl-Compatible Regular Expression used for filtering. <strong>WARNING</strong>: The PHP manual says: &ldquo;<em><u>Matching characters by Unicode property is not fast, because PCRE has to search a structure that contains data for over fifteen thousand characters.</u></em>&rdquo; If you suffer poor performance consider disabling this option.'),
    '#default_value' => variable_get('wordfilter_use_utf8_flag', FALSE),
    '#return_value' => TRUE,
  );
  $form['general_options']['wordfilter_default_replacement'] = array(
    '#type' => 'textfield',
    '#title' => t('Default word replacement'),
    '#description' => t('Enter the default replacement text here. If you do not enter replacement text for an individual filtered word, the replacement text entered here will be used as the replacement text. If you would like to replace the filtered word with an empty string, set the replacement word to <em>&lt;none&gt;</em>.'),
    '#default_value' => variable_get('wordfilter_default_replacement', '[filtered word]'),
    '#required' => TRUE,
  );
  return system_settings_form($form);
}

/**
 * Word filter list delete word confirmation callback.
 */
function wordfilter_admin_form_delete_confirm($form, &$form_state, $word_id) {
  $form = array();
  $form['word_id'] = array(
    '#type' => 'value',
    '#value' => $word_id,
  );
  return confirm_form($form, t('Are you sure you want to delete this word or phrase from the word filtering list?'), 'admin/config/content/wordfilter');
}

/**
 * Word filter list delete word submit callback.
 */
function wordfilter_admin_form_delete_confirm_submit($form, &$form_state) {
  if ($form_state['values']['confirm']) {
    db_delete('wordfilter')
      ->condition('id', $form_state['values']['word_id'])
      ->execute();
    drupal_set_message(t('The word was removed from the word filter list'));
    $form_state['redirect'] = 'admin/config/content/wordfilter';
    cache_clear_all('*', 'cache_field', TRUE);
    cache_clear_all('wordfilter', 'cache');
  }
}

/**
 * Word filter admin configuration page callback. Lists existing
 * words or phrases that are configured to be filtered.
 */
function wordfilter_admin_list() {
  $build = array();
  $header = array(
    array(
      'data' => t('Word to filter'),
      'field' => 'words',
      'sort' => 'asc',
    ),
    array(
      'data' => t('Replacement text'),
      'field' => 'replacement',
    ),
    array(
      'data' => t('Standalone'),
      'field' => 'standalone',
    ),
    array(
      'data' => t('Operations'),
      'colspan' => 2,
    ),
  );
  $rows = array();
  $list = db_select('wordfilter', 'w')
    ->fields('w')
    ->extend('PagerDefault')
    ->extend('TableSort')
    ->orderByHeader($header)
    ->limit(10)
    ->execute();
  foreach ($list as $word) {
    $rows[] = array(
      check_plain($word->words),
      $word->replacement ? check_plain($word->replacement) : check_plain(variable_get('wordfilter_default_replacement', '[filtered word]')),
      $word->standalone ? t('Yes') : t('No'),
      l(t('Edit word'), 'admin/config/content/wordfilter/edit/' . $word->id),
      l(t('Delete word'), 'admin/config/content/wordfilter/delete/' . $word->id),
    );
  }
  $build['wordfilter_settings_form'] = drupal_get_form('wordfilter_settings_form');
  $build['table'] = array(
    '#markup' => theme('table', array(
      'header' => $header,
      'rows' => $rows,
    )),
  );
  $build['pager'] = array(
    '#markup' => theme('pager'),
  );
  return $build;
}

/**
 * Word filter list edit word form.
 */
function wordfilter_admin_edit_form($form, &$form_state, $word_id = NULL) {
  if (!isset($word_id) || !is_numeric($word_id)) {
    drupal_set_message(t('The wordfilter ID of the word or phrase you are trying to edit is missing or is not a number.'), 'error');
    drupal_goto('admin/config/content/wordfilter');
  }
  $word = db_select('wordfilter', 'w')
    ->fields('w')
    ->condition('w.id', $word_id)
    ->execute()
    ->fetch();
  $form = array();
  $form['id'] = array(
    '#type' => 'hidden',
    '#value' => $word->id,
  );
  $form['words'] = array(
    '#type' => 'textfield',
    '#title' => t('Word or phrase to filter'),
    '#default_value' => $word->words,
    '#description' => t('Enter the word or phrase you want to filter.'),
    '#size' => 50,
    '#maxlength' => 255,
    '#required' => TRUE,
  );
  $form['replacement'] = array(
    '#type' => 'textfield',
    '#title' => t('Replacement text'),
    '#description' => t('Enter the filtered version of the word or phrase to replace the original word or phrase. If you would like to replace the filtered word with an empty string, set the replacement word to <em>&lt;none&gt;</em>.'),
    '#default_value' => $word->replacement ? $word->replacement : variable_get('wordfilter_default_replacement', '[filtered word]'),
    '#size' => 50,
    '#maxlength' => 255,
  );
  $form['standalone'] = array(
    '#type' => 'checkbox',
    '#title' => t('Stand-alone'),
    '#default_value' => $word->standalone,
    '#description' => t('When checked, the word or phrase will only be filtered when found as a separate word or phrase (i.e. prefixed and suffixed by spaces or "whitespace"). A period one character after a word or phrase will exclude the words or phrases from replacement in stand-alone mode. This is useful for preventing accidental word or phrase filtering with short or common words or phrases.'),
  );
  $form['Save word filter'] = array(
    '#type' => 'submit',
    '#value' => t('Save word filter'),
  );
  $form['cancel'] = array(
    '#type' => 'submit',
    '#value' => t('Cancel'),
  );
  return $form;
}

/**
 * Word filter list edit word form submit handler.
 */
function wordfilter_admin_edit_form_submit($form, &$form_state) {
  drupal_write_record('wordfilter', $form_state['values'], 'id');
  watchdog('wordfilter', 'Updated filter for: %word', array(
    '%word' => $form_state['values']['words'],
  ));
  drupal_set_message(t('Updated filter for: %word', array(
    '%word' => $form_state['values']['words'],
  )));
  $form_state['redirect'] = 'admin/config/content/wordfilter';
  cache_clear_all('*', 'cache_field', TRUE);
  cache_clear_all('wordfilter', 'cache');
}

/**
 * Word filter list add word form.
 */
function wordfilter_admin_add_form() {
  $form = array();
  $form['words'] = array(
    '#type' => 'textarea',
    '#title' => t('Words'),
    '#description' => t("Enter a word or phrase you want to filter followed by '|' and the replacement word or phrase if any. You can enter multiple word and replacement pairs by hitting return adding more word pairs on a new line. Any word or phrases that do not have a replacement word or phrase will use the default replacement word below. If you would like to replace the filtered word with an empty string, set the replacement word to <em>&lt;none&gt;</em>."),
    '#required' => true,
  );
  $form['replacement'] = array(
    '#type' => 'textfield',
    '#title' => t('Replacement'),
    '#default_value' => variable_get('wordfilter_default_replacement', '[filtered word]'),
    '#size' => 50,
    '#maxlength' => 255,
    '#description' => t('Enter the filtered version of the word to replace the original words with. If no replacement word or phrase is specified for a word or phrase in the list above, the word or phrase entered here will be used as the replacement for that word or phrase. If you would like to replace the filtered word with an empty string, set the replacement word to <em>&lt;none&gt;</em>.'),
  );
  $form['standalone'] = array(
    '#type' => 'checkbox',
    '#title' => t('Stand-alone'),
    '#description' => t('When checked, the word or phrase will only be filtered when found as a separate word or phrase (i.e. prefixed and suffixed by spaces or "whitespace"). A period one character after a word or phrase will exclude the words from replacement in stand-alone mode. This is useful for preventing accidental word or phrase filtering with short or common words and phrases.'),
  );
  $form['language'] = array(
    '#type' => 'value',
    '#value' => '',
  );
  $form['Save word filter'] = array(
    '#type' => 'submit',
    '#value' => t('Save word filter'),
  );
  $form['cancel'] = array(
    '#type' => 'submit',
    '#value' => t('Cancel'),
  );
  return $form;
}

/**
 * Word filter list add word form submit handler.
 */
function wordfilter_admin_add_form_submit($form, &$form_state) {
  $pairs = explode("\n", $form_state['values']['words']);
  $pairs = array_map('trim', $pairs);
  $pairs = array_filter($pairs, 'strlen');
  foreach ($pairs as $pair) {
    $row = new stdClass();
    $row->standalone = $form_state['values']['standalone'];
    list($row->words, $row->replacement, $row->language) = array_pad(explode('|', $pair), 3, '');
    if (!$row->replacement) {
      $row->replacement = $form_state['values']['replacement'];
    }
    if (!$row->language) {
      $row->language = $form_state['values']['language'];
    }
    drupal_write_record('wordfilter', $row);
    watchdog('wordfilter', 'Added filter for: %word', array(
      '%word' => $row->words,
    ));
    drupal_set_message(t('Added filter for: %word', array(
      '%word' => $row->words,
    )));
  }
  $form_state['redirect'] = 'admin/config/content/wordfilter';
  cache_clear_all('*', 'cache_field', TRUE);
  cache_clear_all('wordfilter', 'cache');
}

/**
 * Word filter test word form.
 */
function wordfilter_admin_test_filter_form($form, &$form_state) {
  $form = array();
  $form['#redirect'] = FALSE;
  $form['test_word'] = array(
    '#type' => 'textfield',
    '#title' => t('Word to test'),
    '#description' => t('Enter a word or phrase that you want to test your word filters on'),
    '#size' => 50,
    '#maxlength' => 255,
    '#required' => TRUE,
  );
  if (isset($form_state['values']['test_word'])) {
    $form['text_result'] = array(
      '#type' => 'item',
      '#markup' => _wordfilter_test_filter($form_state['values']['test_word']),
    );
  }
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Test word filters'),
  );
  return $form;
}

/**
 * Word filter test word form submit handler.
 */
function wordfilter_admin_test_filter_form_submit($form, &$form_state) {
  $form_state['rebuild'] = TRUE;
}

/**
 * Word filter test word page callback.
 */
function _wordfilter_test_filter($word) {
  $filtered_word = wordfilter_filter_process($word);
  if ($word == $filtered_word) {
    return t("Your test phrase '%word' did not match any filters", array(
      '%word' => $word,
    ));
  }
  else {
    $no_html = t("<p>Your test phrase: <br />\n&nbsp;&nbsp;'@word' <br />\nwas filtered to: <br />\n&nbsp;&nbsp;'@filtered_word'</p>", array(
      '@word' => $word,
      '@filtered_word' => $filtered_word,
    ));
    $html = t("<p>(As HTML): <br />\n&nbsp;&nbsp;'!word' <br />\nwas filtered to: <br />\n&nbsp;&nbsp;'!filtered_word'</p>", array(
      '!word' => filter_xss_admin($word),
      '!filtered_word' => filter_xss_admin($filtered_word),
    ));
    return $no_html . $html;
  }
}
Functions

Name	Description
wordfilter_admin_add_form	Word filter list add word form.
wordfilter_admin_add_form_submit	Word filter list add word form submit handler.
wordfilter_admin_edit_form	Word filter list edit word form.
wordfilter_admin_edit_form_submit	Word filter list edit word form submit handler.
wordfilter_admin_form_delete_confirm	Word filter list delete word confirmation callback.
wordfilter_admin_form_delete_confirm_submit	Word filter list delete word submit callback.
wordfilter_admin_list	Word filter admin configuration page callback. Lists existing words or phrases that are configured to be filtered.
wordfilter_admin_test_filter_form	Word filter test word form.
wordfilter_admin_test_filter_form_submit	Word filter test word form submit handler.
wordfilter_settings_form	Word filter admin configuration form.
_wordfilter_test_filter	Word filter test word page callback.
You are here

wordfilter.admin.inc in Wordfilter 7

File

Functions

API Navigation
