modules/hidden/hidden.module

<?php
// $Id: hidden.module,v 1.7 2008/12/13 18:42:43 ekes Exp $

/**
 * @file
 * Module to create, track and display hidden content.
 */

// @todo descriptions of these
define('HIDDEN_LOG_DELETE', 1);
define('HIDDEN_LOG_HIDE', 2);
define('HIDDEN_LOG_UNHIDE', 3);
define('HIDDEN_LOG_REPORTED', 4);
define('HIDDEN_LOG_SEEN', 5);
define('HIDDEN_LOG_REASONS', 6);
define('HIDDEN_LOG_SPAM', 7);
define('HIDDEN_LOG_ERROR', 51);
define('HIDDEN_LOG_DEBUG_FILTER', 52);
define('HIDDEN_LOG_DEBUG', 53);

define('HIDDEN_MAIL_NEVER', 0);
define('HIDDEN_MAIL_NOW', 1);
define('HIDDEN_MAIL_LATER', 2);

define('HIDDEN_FILTER_PLAIN', 1);
define('HIDDEN_FILTER_PREG', 2);

define('HIDDEN_PAGER_LIMIT', 20);

/********************************************************************
 * Standard hooks
 */

 /**
 * Implementation of hook_boot().
 */
function hidden_boot() {
  if (module_exists('views')) {
    // @todo not yet D6
    //include_once drupal_get_path('module', 'hidden') .'/hidden.views.inc';
  }
}

/**
 * Implementation of hook_init().
 */
function hidden_init() {
  drupal_add_css(drupal_get_path('module', 'hidden') .'/hidden.css', 'module', 'all', FALSE);
}

/**
 * Implementation of hook_help().
 */
function hidden_help($path, $arg) {
  $output = '';

  switch ($path) {
    case 'admin/content/comment/list/hidden':
      $output = '<p>'. t('The following comments have been hidden.') .'</p>';
      break;
    case 'admin/content/comment/list/hiddenreported':
      $output = '<p>'. t('The following comments have been reported for hiding.') .'</p>';
    case 'admin/content/node/list/hidden':
      $output = '<p>'. t('The following nodes have been hidden.') .'</p>';
      break;
    case 'admin/content/node/list/hiddenreported':
      $output = '<p>'. t('The following nodes have been reported for hiding.') .'</p>';
      break;
    case 'admin/content/hidden':
    case 'admin/content/hidden/reasons':
      $output = '<p>'. t('The default reasons offered for hiding an item. Disabled reasons do not show in the list.') .'</p>';
      break;
    case 'admin/content/hidden/reasons/edit':
      $output = '<p>'. t('Changing the text of a reason will change it for all previously hidden items as well.') .'</p>';
      break;
    case 'admin/content/hidden/filters':
      $output = '<p>'. t('Custom filters to automate hiding of posts. If you set a time delay they will be hidden after that time when cron is run.') .'</p>';
      break;
    case 'admin/settings/hidden':
      $output = '<p>'. t('How much detail to log and send in any e-mails. Hide reports can be sent immediately or saved and sent together in one e-mail periodically.') .'</p>';
      break;
    case 'admin/help#hidden':
      $output = '<p>'. t('Hidden enables you to un-/hide nodes and comments.') ."</p>\n".
        '<p>'. t("Every node or comment has a link called 'hide' (or 'unhide' if hidden).") ."</p>\n".
        '<p>'. t("To 'hide':") ."<br />\n".
        '- '. t('Click the link.') ."<br />\n".
        '- '. t('On the following page you have to supply a reason why the item will be hidden before you submit the form.') ."</p>\n".
        '<p>'. t('Hidden items should not appear in any listings for non-admin users except under hidden/.') ."</p>\n".
        '<p>'. t("To 'unhide':") ."<br />\n".
        '- '. t("Click the link after the contents' title/subject or click on the contents' title/subject.") ."<br />\n".
        '- '. t("Then click 'unhide'.") ."</p>\n";
      break;
    }

    return $output;
}

/**
 * Implementation of hook_perm().
 */
function hidden_perm() {
  return array('access hidden', 'report for hiding', 'mark as hidden', 'administer hidden', 'bypass hidden filter');
}

/**
 * Implementation of hook_theme().
 */
function hidden_theme() {
  return array(
    'hidden_admin_settings' => array(
      'arguments' => array(
        'form' => NULL,
        ),
      ),
    'hidden_link' => array(
      'arguments' => array(
        'links' => NULL,
        ),
      ),
    'hidden_list_nodes' => array(
      'arguments' => array(
        'table' => NULL,
        ),
      ),
    'hidden_list_admin_nodes' => array(
      'arguments' => array(
        'form' => NULL,
        ),
      ),
    'hidden_list_admin_nodes_reported' => array(
      'arguments' => array(
        'form' => NULL,
        ),
      ),
    'hidden_list_comments' => array(
      'arguments' => array(
        'table' => NULL,
        ),
      ),
    'hidden_list_admin_comments' => array(
      'arguments' => array(
        'form' => NULL,
        ),
      ),
    'hidden_list_admin_comments_reported' => array(
      'arguments' => array(
        'form' => NULL,
        ),
      ),
    'hidden_view_reason' => array(
      'arguments' => array(
        'title' => NULL,
        'public' => '',
        'description' => '',
        'private' => '',
        'content' => '',
        'view' => TRUE,
        ),
      ),
    'hidden_filters_admin_enabled_form' => array(
      'arguments' => array(
        'form' => NULL,
        ),
    )
  );
}

/**
 * Implementation of hook_menu().
 */
function hidden_menu() {
  $items = array();
  $view = array('access hidden');
  $report = array('report for hiding');
  $hide = array('mark as hidden');
  $admin = array('administer hidden');

  $items['admin/settings/hidden'] = array(
    'title' => 'Hidden settings',
    'description' => 'Administer settings for the hidden module.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('hidden_admin_settings'),
    'access arguments' => $admin,
    'file' => 'hidden.admin.inc',
  );
  $items['admin/content/hidden'] = array(
    'title' => 'Hidden reasons and filters',
    'description' => 'Manage reasons for hiding and content filters',
    'page callback' => 'hidden_reasons_admin',
    'access arguments' =>  $admin,
    'type' => MENU_NORMAL_ITEM,
    'file' => 'hidden.admin.inc',
  );
  $items['admin/content/hidden/reasons'] = array(
    'title' => 'Reasons',
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['admin/content/hidden/reasons/add'] = array(
    'title' => 'Add hidden reason',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('hidden_reasons_admin_form', 'add'),
    'access arguments' => $admin,
    'type' => MENU_CALLBACK,
    'file' => 'hidden.admin.inc',
  );
  $items['admin/content/hidden/reasons/edit'] = array(
    'title' => 'Edit hidden reason',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('hidden_reasons_admin_form', 'edit'),
    'access arguments' => $admin,
    'type' => MENU_CALLBACK,
    'file' => 'hidden.admin.inc',
  );
  $items['admin/content/hidden/reasons/enable'] = array(
    'title' => 'Enable hidden reason',
    'page callback' => 'hidden_reasons_admin_able',
    'page arguments' => array('enable'),
    'access arguments' => $admin,
    'type' => MENU_CALLBACK,
    'file' => 'hidden.admin.inc',
  );
  $items['admin/content/hidden/reasons/disable'] = array(
    'title' => 'Disable hidden reason',
    'page callback' => 'hidden_reasons_admin_able',
    'page arguments' => array('disable'),
    'access arguments' => $admin,
    'type' => MENU_CALLBACK,
    'file' => 'hidden.admin.inc',
  );
  $items['admin/content/hidden/filters'] = array(
    'title' => 'Filters',
    'description' => 'Manage filters for hidden content',
    'page callback' => 'hidden_filters_admin',
    'access arguments' => $admin,
    'type' => MENU_LOCAL_TASK,
    'file' => 'hidden.admin.inc',
  );
  $items['admin/content/hidden/filters/add'] = array(
    'title' => 'Add filter',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('hidden_filters_admin_form', 'add'),
    'access arguments' => $admin,
    'type' => MENU_CALLBACK,
    'file' => 'hidden.admin.inc',
  );
  $items['admin/content/hidden/filters/edit'] = array(
    'title' => 'Edit filter',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('hidden_filters_admin_form', 'edit'),
    'access arguments' => $admin,
    'type' => MENU_CALLBACK,
    'file' => 'hidden.admin.inc',
  );
  $items['admin/content/hidden/filters/enable'] = array(
    'title' => 'Enable filter',
    'page callback' => 'hidden_filters_admin_able',
    'page arguments' => array('enable'),
    'access arguments' => $admin,
    'type' => MENU_CALLBACK,
    'file' => 'hidden.admin.inc',
  );
  $items['admin/content/hidden/filters/disable'] = array(
    'title' => 'Disable filter',
    'page callback' => 'hidden_filters_admin_able',
    'page arguments' => array('disable'),
    'access arguments' => $admin,
    'type' => MENU_CALLBACK,
    'file' => 'hidden.admin.inc',
  );
  $items['admin/content/comment/list/hidden'] = array(
    'title' => 'Hidden',
    'description' => 'Hidden comments',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('hidden_list_admin_comments'),
    'access arguments' => $hide,
    'type' => MENU_LOCAL_TASK,
    'file' => 'hidden.display-admin.inc'
  );
  $items['admin/content/comment/list/hiddenreported'] = array(
    'title' => 'Reported',
    'description' => 'Reported comments',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('hidden_list_admin_comments_reported'),
    'access arguments' => $hide,
    'type' => MENU_LOCAL_TASK,
    'file' => 'hidden.display-admin.inc',
  );
  $items['admin/content/node/list/hidden'] = array(
    'title' => 'Hidden',
    'description' => 'Hidden nodes',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('hidden_list_admin_nodes'),
    'access arguments' => $hide,
    'type' => MENU_LOCAL_TASK,
    'file' => 'hidden.display-admin.inc',
  );
  $items['admin/content/node/list/hiddenreported'] = array(
    'title' => 'Reported',
    'description' => 'Reported nodes',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('hidden_list_admin_nodes_reported'),
    'access arguments' => $hide,
    'type' => MENU_LOCAL_TASK,
    'file' => 'hidden.display-admin.inc',
  );

  $items['hidden'] = array(
    'title' => 'Hidden',
    'description' => 'Access hidden content',
    'page callback' => 'hidden_list_nodes',
    'access arguments' => $view,
  //      'type' => MENU_SUGGESTED_ITEM,
    'type' => MENU_NORMAL_ITEM,
    'file' => 'hidden.display-pages.inc',
  );
  $items['hidden/node'] = array(
    'title' => 'Hidden nodes',
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
  $items['hidden/comment'] = array(
    'title' => 'Hidden comments',
    'page callback' => 'hidden_list_comments',
    'access arguments' => $view,
    'type' => MENU_LOCAL_TASK,
    'file' => 'hidden.display-pages.inc',
  );
  $items["hidden/%/%"] = array(
    'title' => 'view',
    'page callback' => 'hidden_view',
    'page arguments' => array(1, 2),
    'access arguments' =>  $view,
    'type' => MENU_CALLBACK,
    'file' => 'hidden.display-pages.inc',
  );

  $items['hidden/%/%/hide'] = array(
    'title' => 'Report post',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('hidden_hide', 1, 2),
    'access arguments' => $hide,
    'type' => MENU_CALLBACK,
    'file' => 'hidden.action-pages.inc',
  );
  $items['hidden/%/%/report'] = array(
    'title' => 'Report post',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('hidden_report', 1, 2),
    'access arguments' => $report,
    'type' => MENU_CALLBACK,
    'file' => 'hidden.action-pages.inc',
  );
  $items['hidden/%/%/unhide'] = array(
    'title' => 'Don\'t hide',
    'page callback' => 'hidden_unhide',
    'page arguments' => array(1, 2),
    'access arguments' => $hide,
    'type' => MENU_CALLBACK,
    'file' => 'hidden.action-pages.inc',
  );

  return $items;
}


/**
 * Implementation of hook_cron().
 *
 * sends periodic e-mails reports for actions set to HIDDEN_MAIL_LATER
 * unpublishes content marked as delayed hidden
 */
function hidden_cron() {
  $now = time();
  $email = _hidden_settings_mail();
  if ($email['domail'] == TRUE) {
    if (variable_get('hidden_mail_sent', 0) + $email['frequency'] < $now) {
      // log emailing on, hidden mail not sent since frequency reached
      $message = '';
      foreach ($email as $type => $when) {
        if ($when['when'] == HIDDEN_MAIL_LATER) {
          // $email set action to be mailed later
          $query = 'SELECT * FROM {hidden_log} WHERE action=%d';
          if (! $result = db_query($query, $type)) {
            _hidden_log(HIDDEN_LOG_ERROR, t('Error retrieving logged messages for e-mailing'));
            $error = TRUE;
          }
          else {
            while ($logged = db_fetch_object($result)) {
              // retrive additional information about each action that has happened
              $message .= _hidden_mail_cron_message($logged->action, $logged->description, unserialize($logged->ids), $logged->uid);
            }
          }
        }
      }
      if ($message != '') {
        // send out e-mail
        if (_hidden_mail(t('Collected log messages'), $message) && !$error) {
          $query = 'DELETE FROM {hidden_log} WHERE hidetime < %d';
          if (! db_query($query, $now)) {
            _hidden_log(HIDDEN_LOG_ERROR, t('Error removing sent logged messages from database'));
          }
          else {
            variable_set(hidden_mail_sent, $now);
          }
        }
        else {
          _hidden_log(HIDDEN_LOG_DEBUG, 'Logged messages left in database because of error retrieving or sending');
        }
      }
    }
  }
  // unpublish delayed hides
  // TODO if filter settings delayed filters
  foreach (array('node', 'comment') as $type) {
    $query = "SELECT * FROM {hidden_$type} WHERE delay != 0 AND delay < %d";
    $result = db_query($query, time());
    while ($hidden = db_fetch_object($result)) {
      _hidden_hidden_hide_unpublish($type, ($type == 'node') ? $hidden->nid : $hidden->cid);
      $query = "UPDATE {hidden_$hidden} SET delay=0 WHERE hid=%d";
      db_query($query, $hidden->hid);
      _hidden_log(HIDDEN_LOG_HIDE, t('Hidden %type', array('%type' => $type)), $type,
                  ($type == 'node') ? $hidden->nid : $hidden->cid,
                  $hidden->rid, $hidden->publicnote, $hidden->privatenote, $hidden->uid);
    }
  }
}

/**
 * Implementation of hook_comment().
 *
 * adds reasons and div tags to viewed comments.
 * passes comment through any filters.
 * removes deleted or published comments from the hidden records.
 */
function hidden_comment(&$comment, $action) {
  switch ($action) {
    case 'view':
      if (isset($comment->status) && $comment->status == COMMENT_NOT_PUBLISHED) {
        // all hidden comments are unpublished so no point making unnecessary queries
        if ($hidden=_hidden_hidden_get('comment', $comment->cid)) {
          $title = check_plain($hidden->title);
          $public = check_markup($hidden->publicnote, FILTER_HTML_STRIP, FALSE);
          $description = check_markup($hidden->description, FILTER_HTML_STRIP, FALSE);
          $private = check_markup($hidden->privatenote, FILTER_HTML_STRIP, FALSE);
          $comment->comment = theme('hidden_view_reason', $title, $public, $description, $private, $comment->comment);
          $comment->subject = t('HIDDEN: @title', array('@title' => $comment->subject));
        }
      }
      break;
    case 'update':
      // TODO reinput if hidden
    case 'insert':
      if (user_access('bypass hidden filter')) {
        return;
      }
      // $comment an array here!
      hidden_filter_content($comment['subject'] .' '. $comment['comment'], 'comment', $comment['cid']);
      break;
    case 'publish':
      // @todo array, always?
      // what should happen here? filter?
      if (! hidden_hidden_check('comment', $comment['cid'])) {
        break;
      }
      break;
    case 'delete':
      if (_hidden_hidden_delete('comment', $comment->cid)) {
        if (db_affected_rows()>0) {
          if ($action == 'delete') {
            _hidden_log(HIDDEN_LOG_DELETE, t('Hidden comment deleted'));
          }
          else {
            _hidden_log(HIDDEN_LOG_UNHIDE, t('Hidden comment published'), 'comment', $comment->cid);
            drupal_set_message(t('Hidden comment published'));
          }
        }
      }
      else {
        _hidden_log(HIDDEN_LOG_ERROR, t('Error deleting hidden comment'), 'comment', $comment->cid);
      }
      break;
    case 'form':
      if ( hidden_hidden_check('comment', $comment->cid) && user_access('administer hidden')) {
        //TODO edit form
        return;
      }
  }
}

/**
 * Implementation of hook_nodeapi().
 *
 * adds reasons and div tags to viewed nodes.
 * passes node through any filters
 * removes deleted node from the records.
 */
function hidden_nodeapi(&$node, $action, $arg=0) {
  switch ($action) {
    case 'alter':
      if (! $node->status) {
        // all hidden nodes are unpublished so no point making unnecessary queries
        if ($hidden=_hidden_hidden_get('node', $node->nid)) {
          $title = check_plain($hidden->title);
          $public = check_markup($hidden->publicnote, FILTER_HTML_STRIP, FALSE);
          $description = check_markup($hidden->description, FILTER_HTML_STRIP, FALSE);
          $private = check_markup($hidden->privatenote, FILTER_HTML_STRIP, FALSE);
          // arg TRUE on teaser view
          $node->body = theme('hidden_view_reason', $title, $public, $description, $private, $node->body, !($arg));
          $node->title = t('HIDDEN: @title', array('@title' => $node->title));
            // sadly usually set by this point for nodes
        }
      }
      break;
    case 'update':
      if ($action=='update' && $node->status) {
        // node being updated and status is published check it wasn't hidden
        if (hidden_hidden_check('node', $node->nid)) {
          if (_hidden_hidden_delete('node', $node->nid)) {
            _hidden_log(HIDDEN_LOG_UNHIDE, t('Hidden node published.'), 'node', $node->nid);
            drupal_set_message(t('Hidden node published.'));
          }
          else {
            _hidden_log(HIDDEN_LOG_ERROR, t('Error unhiding publish node.'), 'node', $node->nid);
            drupal_set_message(t('Error unhiding published node.'), 'error');
          }
        }
      }
    case 'insert':
      if (user_access('bypass hidden filter')) {
        return;
      }
      hidden_filter_content($node->title .' '. $node->teaser .' '. $node->body, 'node', $node->nid);
      break;
    case 'delete':
      // comment_nodeapi doesn't call hook_comment delete but this query will delete comments too
      if (_hidden_hidden_delete('both', $node->nid)) {
        if (db_affected_rows()>0) {
          _hidden_log(HIDDEN_LOG_DELETE, t('Deleted hidden node and/or attached comments.'));
        }
      }
      else {
        _hidden_log(HIDDEN_LOG_ERROR, t('Error deleting hidden node and/or comments.'), 'node', $node->nid);
      }
  }
}

/**
 * Implementation of hook_node_operations().
 */
function hidden_node_operations() {
  $operations = array(
    'hide' => array(
      'label' => t('Hide'),
      'page callback' => 'hidden_operations_hide',
    ),
    'unhide' => array(
      'label' => t('Unhide'),
      'page callback' => 'hidden_operations_unhide',
    ),
  );

  return $operations;
}

/**
 * Implementation of hook_link().
 */
function hidden_link($type, $item = NULL, $teaser = FALSE) {
  $links = array();
  if (!$item) {
    return $links;
  }

  if ($type == 'comment') {
    $target = $item->cid;
  }
  elseif ($type == 'node') {
    $target = $item->nid;
  }
  else {
    return $links;
  }

  $hidden=_hidden_hidden_get($type, $target);

  if ($hidden == FALSE) {
    // not hidden
    if (user_access('mark as hidden')) {
      $links['hidden-hide'] = array(
        'title' => t('hide'),
        'href' => "hidden/$type/$target/hide",
        'query' => drupal_get_destination(),
      );
    }
    // not hidden and is published
    if (user_access('report for hiding') && (
      ($type == 'comment' && $item->status != COMMENT_NOT_PUBLISHED) ||
        ($type == 'node' && $item->status)
    )) {
      $links['hidden-report'] = array(
        'title' => t('report'),
        'href' => "hidden/$type/$target/report",
        'query' => drupal_get_destination(),
      );
    }
  }
  elseif ($hidden->delay!=0) {
    // marked to be hidden by a cron job
    if (user_access('mark as hidden')) {
      $links['hidden-hide'] = array(
        'title' => t('hide now'),
        'href' => "hidden/$type/$target/hide",
        'query' => drupal_get_destination(),
      );
      $links['hidden-unhide'] = array(
        'title' => t("don't hide"),
        'href' => "hidden/$type/$target/unhide",
        'query' => drupal_get_destination(),
      );
    }
    if (user_access('report for hiding')) {
      $links['hidden-report'] = array(
        'title' => t('report'),
        'href' => "hidden/$type/$target/report",
        'query' => drupal_get_destination(),
      );
    }
  }
  else {
    // hidden
    if (user_access('mark as hidden')) {
      $links['hidden-unhide'] = array(
        'title' => t('unhide'),
        'href' => "hidden/$type/$target/unhide",
      );
    }
  }

  return $links;
}

/**
 * Creates array of rows for hidden content tables.
 *
 * @param $query
 *   string sql query for the pager
 * @param $type
 *   string type of content (comment, node)
 * @return
 *   array of hidden content for theme_table()
 */
function _hidden_list_get($query, $type) {
  $result = pager_query($query, HIDDEN_PAGER_LIMIT);

  $rows = array();

  while ($links = db_fetch_object($result)) {
    if ($type == 'comment') {
      $target = 'comment/'. $links->cid;
    }
    else {
      $target = 'node/'. $links->nid;
    }

    $rows[] = array(
      l($links->title, 'hidden/'. $target),
      theme('username', $links),
      check_plain($links->reason),
    );

    if (count($rows)==0) {
      $rows[] = array(t('No hidden content'), '');
    }
  }

  return $rows;
}

/**
 * Creates pulldown box for admin list form mass unhide operation.
 *
 * @return
 *   form array
 */
function _hidden_list_admin_options() {
  // build an 'Update options' form
  $form['options'] = array(
    '#type' => 'fieldset', '#title' => t('Update options'),
    '#prefix' => '<div class="container-inline">', '#suffix' => '</div>'
  );

  $form['options']['operation']  = array(
    '#type' => 'select',
    '#options' => array('UNHIDE' => t('Unhide the selected posts')),
    '#description' => t(''),
  );

  $form['options']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Update'),
  );

  return $form;
}

/**
 * Creates a pulldown for admin reported list form mass hide/seen operations.
 *
 * @return form array
 */
function _hidden_list_admin_reported_options() {
  // build an 'Update options' form
  $form['options'] = array(
    '#type' => 'fieldset', '#title' => t('Update options'),
    '#prefix' => '<div class="container-inline">', '#suffix' => '</div>'
  );

  $options = array('SEEN' => t('Mark the selected posts as seen'),
                   'HIDE' => t('Hide the selected posts'),
                  );
  if (module_exists('spam')) {
    $options['SPAM'] = t('Mark the selected posts as spam');
  }

  $form['options']['operation']  = array(
    '#type' => 'select',
    '#options' => $options,
    '#description' => t(''),
  );

  $form['options']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Update'),
  );

  return $form;
}

/**
 * Formats reason for hiding in node and comment display.
 *
 * This is shown in all views of hidden nodes and comments, it's called from the
 * nodeapi('view') and comment('view') hooks.
 *
 * @param $title
 *   string plain text standard reason for hiding.
 * @param $public
 *   string html public note about hiding.
 * @param $description
 *   string html description of standard reason for hiding (optional).
 * @param $private
 *   string html private note about hiding (optional).
 * @param $content
 *   string html formated node/comment (optional).
 * @param $view
 *   bool FALSE if short display without additional info and content (for teaser view) (optional).
 * @return
 *   string formatted output
 * @ingroup themeable
 */
function theme_hidden_view_reason($title, $public, $description='', $private='', $content='', $view=TRUE) {
  $output = '<div class="hidden"><div class="reason">';
  $output .= t('<p>Hidden content:</p>');
  if ($title) {
    $output .= '<p>'. $title .'</p>';
    if ($view) {
      $output .= $description;
    }
  }
  $output .= $public;
  if (user_access('mark as hidden') && $view) {
    $output .= $private;
  }
  $output .= '</div>';
  if ($view) {
    $output .= $content;
  }
  $output .= '</div>';
  return $output;
}

/**
 * Admin node_operations() callback.
 */
function hidden_operations_hide($nids) {
  global $user;

  $hide = array();
  $error = array();
  foreach ($nids as $nid) {
    if (! hidden_hidden_check('node', $nid)) {
      $nid = (int)$nid;
      if (hidden_hidden_hide('node', $nid, $user->uid, 1)) {
        $hide[] = $nid;
      }
      else {
        $error[] = $nid;
      }
    }
  }
  if ($n = count($error)) {
    $msg = format_plural($n, 'Error hiding node.', 'Error hiding nodes.');
    _hidden_log(HIDDEN_LOG_ERROR, $msg, 'node', $error);
    drupal_set_message($msg, 'error');
  }
  if ($n = count($hide)) {
    $msg = format_plural($n, 'Hidden node.', 'Hidden nodes.');
    _hidden_log(HIDDEN_LOG_HIDE, $msg, 'node', $hide);
    drupal_set_message($msg);
  }

  drupal_goto('admin/content/node');
}

/**
 * Admin node_operations() callback.
 */
function hidden_operations_unhide($nids) {
  $unhide = array();
  $error = array();
  foreach ($nids as $nid) {
    $nid = (int)$nid;
    if (hidden_hidden_check('node', $nid)) {
      if (_hidden_hidden_unhide('node', $nid)) {
        $unhide[] = $nid;
      }
      else {
        $error[] = $nid;
      }
    }
  }
  if ($n = count($error)) {
    $msg = format_plural($n, 'Error unhiding node.', 'Error unhiding nodes.');
    _hidden_log(HIDDEN_LOG_ERROR, $msg, 'node', $error);
    drual_set_message($msg, 'error');
  }
  if ($n = count($unhide)) {
    $msg = format_plural($n, 'Unhidden node.', 'Unhidden nodes.');
    _hidden_log(HIDDEN_LOG_UNHIDE, $msg, 'node', $unhide);
    drupal_set_message($msg);
  }
}

/**
 * Checks if item is hidden.
 *
 * @param $type
 *   string content 'comment' or 'node'.
 * @param $id
 *   int cid or nid.
 * @return
 *   bool TRUE hidden FALSE not/fail.
 */
function hidden_hidden_check($type, $id) {
  static $hidden, $ltype, $lid, $count;
  if ($type == $ltype && $id == $lid) {
    return $hidden;
  }
  else {
    $ltype = $type;
    $lid = $id;
    $hidden = NULL;
  }

  if ($type != 'node' && $type != 'comment') {
    _hidden_log(HIDDEN_LOG_DEBUG, 'hidden_hidden_check() called with invalid $type');
    return FALSE;
  }
  $table = ($type == 'node') ? 'node' : 'comment';
  $col = ($type == 'node') ? 'nid' : 'cid';
  $query = "SELECT COUNT(*) FROM {hidden_$table WHERE $col = %d";

  $result = db_query($query, $id);
  if (db_result($result) != 0) {
    $hidden = TRUE;
    return TRUE;
  }
  else {
    $hidden = FALSE;
    return FALSE;
  }
}

/**
 * Gets a hidden item.
 *
 * @param $type
 *   string content type 'comment' or 'node'
 * @param $id
 *   int cid or nid
 * @return
 *   object -> hid, rid, title, description, publicnote, privatenote, or FALSE not hidden
 */
function _hidden_hidden_get($type, $id) {
  if ($type == 'node') {
    $query = 'SELECT h.hid, h.nid, h.rid, h.uid, h.publicnote, h.privatenote, h.delay,'.
            ' r.title, r.description'.
            " FROM {hidden_node} AS h".
            ' LEFT JOIN {hidden_reasons} AS r ON h.rid=r.rid'.
            " WHERE nid=%d";
  }
  elseif ($type == 'comment') {
    $query = 'SELECT h.hid, h.cid, h.rid, h.uid, h.publicnote, h.privatenote, h.delay,'.
            ' r.title, r.description'.
            " FROM {hidden_comment} AS h".
            ' LEFT JOIN {hidden_reasons} AS r ON h.rid=r.rid'.
            " WHERE cid=%d";
  }
  else {
    _hidden_log(HIDDEN_LOG_DEBUG, '_hidden_hidden_get() called with invalid $type');
    $hidden = FALSE;
    return $hidden;
  }

  if ($result = db_query($query, $id)) {
    if ($hidden = db_fetch_object($result)) {
      $hidden->type = $type;
      $hidden->id = $id;
      return $hidden;
    }
    else {
      $hidden = FALSE;
      return $hidden;
    }
  }
}

/**
 * Removes hidden items from table.
 *
 * @param $type
 *   string content type to remove 'comment', 'node' or 'both'.
 * @param $id
 *   int cid (comment only) or nid (node only or both).
 * @return
 *   FALSE on fail.
 */
function _hidden_hidden_delete($type, $id) {

  if ($type == 'both' || $type == 'node') {
    $query = 'DELETE FROM {hidden_node} WHERE nid=%d';
    // error catching
    if (! db_query($query, $id)) {
      return FALSE;
    }
  }

  if ($type == 'comment') {
    $query = 'DELETE FROM {hidden_comment} WHERE cid=%d';
  }
  elseif ($type == 'both') {
    $query = 'DELETE FROM {hidden_comment} WHERE nid=%d';
  }
  elseif ($type == 'node') {
    return TRUE;
  }

  return db_query($query, $id);
}

/**
 * Performs db queries required to hide an item.
 *
 * Inserts into hidden table.
 * Also if needed marks as seen in hidden_reported, unpublishes, stops comments on nodes.
 *
 * @param $nid
 *   int nid.
 * @param $cid
 *   int if hiding a comment, if node pass '0'.
 * @param $rid
 *   int id of reason for hiding (optional).
 * @param $public
 *   string html of public note (optional).
 * @param $private
 *   string html of private note (optional).
 * @param $filter
 *   int if called by filtering time to delay posting till, 0 for being done
 * @return
 *   FALSE on fail. hid on success.
 */
function hidden_hidden_hide($type, $id, $uid, $rid=0, $public='', $private='', $filter=FALSE) {
  // 'hide now' delay !=0 // in the future also editing a hidden if desired?
  // this check here to prevent just hidden, or calls from report as hidden etc. clashing

  if ($hidden = _hidden_hidden_get($type, $id)) {
    if ($hidden->delay==0) {
      drupal_set_message(t('The %type is already hidden!', array('%type' => $type)), 'error');
      return FALSE;
    }
    else {
      // OK to update existing delayed hide
      $hid = $hidden->hid;
      if ($type == 'node') {
        $query = "UPDATE {hidden_node} SET nid=%d, uid=%d, created=%d, rid=%d, publicnote='%s', privatenote='%s', delay=%d WHERE hid=%d";
        $result = db_query($query, $id, $uid, $created, $rid, $public, $private, $filter, $hid);
      }
      else {
        $query = "UPDATE {hidden_comment} SET cid=%d, uid=%d, created=%d, rid=%d, publicnote='%s', privatenote='%s', delay=%d WHERE hid=%d";
        $result = db_query($query, $id, $uid, $created, $rid, $public, $private, $filter, $hid);
      }
    }
  }
  else {
    // Insert into hidden table
    if ($type == 'node') {
      $query = "INSERT INTO {hidden_node} (nid, uid, created, rid, publicnote, privatenote, delay) VALUES (%d, %d, %d, %d, '%s', '%s', %d)";
      $result = db_query($query, $id, $uid, time(), $rid, $public, $private, $filter);
    }
    else {
      $query = "INSERT INTO {hidden_comment} (cid, uid, created, rid, publicnote, privatenote, delay) VALUES (%d, %d, %d, %d, '%s', '%s', %d)";
      $result = db_query($query, $id, $uid, time(), $rid, $public, $private, $filter);
    }
    $hid = db_last_insert_id("{hidden_$type}_hid", "hid");
  }
  if (! $result) {
    if ($filter === FALSE) {
      drupal_set_message(t('Database error while storing hidden.'), 'error');
    }
    _hidden_log(HIDDEN_LOG_DEBUG, "hidden_hidden_hide() failed to insert into {hidden_$type}", 'hidden', $hid);
    return FALSE;
  }

  if ($filter > 0) {
    // unpublishing handled by cron
    return TRUE;
  }

  $col = $type == 'node' ? 'nid' : 'cid';
  // If it has been reported mark as seen
  $reported = db_query("SELECT COUNT(*) FROM {hidden_reported_$type} WHERE $col=%d", $id);
  if (db_result($reported)>0) {
    if (! _hidden_reported_seen($type, $id, $uid)) {
      _hidden_log(HIDDEN_LOG_ERROR, t('Error marking as seen while hiding.'), 'hidden', $hid);
    }
  }

  if (! _hidden_hidden_hide_unpublish($type, $id)) {
    // It's a bit messy if something is in the hidden db but published
    // on display it checks published status before hidden bothing with hidden db
    return FALSE;
  }

  return TRUE;
}

/**
 * Unpublishes a node or comment
 *
 * Updates comments to status COMMENT_NOT_PUBLISHED
 * and nodes to status 0, and stops further comments
 *
 * @todo consider loading objects, manipulating (with actions), and saving
 *
 * @param $type
 *   string 'node' or 'comment'
 * @param $id
 *   int nid or cid
 * @return
 *   TRUE on success
 */
function _hidden_hidden_hide_unpublish($type, $id) {
  if ($type == 'comment') {
    // Set comment to unpublished
    if (! db_query('UPDATE {comments} SET status = '. COMMENT_NOT_PUBLISHED ." WHERE cid=%d", $id)) {
      drupal_set_message(t("Database error occurred when updating comment's status."), 'error');
      _hidden_log(HIDDEN_LOG_DEBUG, 'hidden_hide_do() error unpublishing comment.', 'comment', $id);
      return FALSE;
    }
  }
  elseif ($type == 'node') {
    // set node to unpublished and comments to read-only
    if (! db_query("UPDATE {node} SET status = 0, comment = 1 WHERE nid = %d", $id)) {
      drupal_set_message(t("Database error occurred when updating node's status."), 'error');
      _hidden_log(HIDDEN_LOG_DEBUG, 'hidden_hide_do() error unpublishing node.', 'node', $id);
      return FALSE;
    }
  }
  else {
    // @todo error
    return FALSE;
  }

  return TRUE;
}

/**
 * Performs db queries required to unhide an item.
 *
 * @param $type
 *   string type 'node' or 'comment'.
 * @param $id
 *   int nid or cid.
 * @return
 *   bool TRUE on success.
 */
function _hidden_hidden_unhide($type, $id) {
  if ($type == 'comment') {
    $query = 'DELETE FROM {hidden_comment} WHERE cid = %d';
  }
  elseif ($type == 'node') {
    $query = 'DELETE FROM {hidden_node} WHERE nid = %d';
  }
  else {
    _hidden_log(HIDDEN_LOG_DEBUG, '_hidden_hidden_unhide() called with invalid $type');
    return FALSE;
  }

  $result = db_query($query, $id);
  if (!$result) {
    drupal_set_message(t('Database error occurred when deleting item from hidden table.'), 'error');
    _hidden_log(HIDDEN_LOG_DEBUG, "_hidden_hidden_unhide() failed to delete from {hidden_$type}", $type, $id);
    return FALSE;
  }

  $result = _hidden_hidden_publish($type, $id);

  if ($result) {
    return TRUE;
  }
  else {
    _hidden_log(HIDDEN_LOG_DEBUG, '_hidden_hidden_unhide() failed to publish.', $type, $id);
    return FALSE;
  }
}

/**
 * Opposite actions to _hidden_hidden_unpublish().
 *
 * @todo set comment status to correct for type, or back to previous settings (need storing).
 */
function _hidden_hidden_publish($type, $id) {
  if ($type == 'comment') {
    $result = db_query('UPDATE {comments} SET status = '. COMMENT_PUBLISHED .' WHERE cid = %d', $id);
  }
  else {
    // set comments to read/write
    $result = db_query('UPDATE {node} SET status = 1, comment = 2 WHERE nid = %d', $id);
  }

  return $result;
}

/**
 * Check parameters.
 *
 * @param $type
 *   string 'node' or 'comment'.
 * @param $id
 *   int nid or cid.
 * @return
 *   bool TRUE if pass, FALSE on fail
 */
function _hidden_check_param($type, $id) {
  if ($type != 'comment' && $type != 'node') {
    return FALSE;
  }
  // @todo $nid is a string from node_save(); should be is_int 
  if (! is_numeric($id) || $id < 1) {
    return FALSE;
  }
  return TRUE;
}

/**
 * Marks reported posts as seen.
 *
 * @param $type
 *   string 'node' or 'comment'
 * @param $id
 *   int nid or cid
 * @param $uid
 *   int uid
 * @return
 *   FALSE on error
 */
function _hidden_reported_seen($type, $id, $uid) {
  if ($type == 'node') {
    $query = 'UPDATE {hidden_reported_node} SET seen=1, suid=%d WHERE nid=%d';
  }
  elseif ($type == 'comment') {
    $query = 'UPDATE {hidden_reported_comment} SET seen=1, suid=%d WHERE cid=%d';
  }
  else {
    return FALSE;
  }

  return db_query($query, $uid, $id);