notices.module

<?php
/**
 * @file
 * Notices.
 *
 * Notices Manager. Notice users about new things on website.
 */

/**
 * Status constant for read notices.
 */
define('NOTICES_READ', 0);
/**
 * Status constant for unread notices.
 */
define('NOTICES_UNREAD', 1);
/**
 * Name form with filters.
 */
define('NOTICES_FORM_NAME', 'notices_list');

/**
 * Implements hook_theme().
 */
function notices_theme() {
  return array(
    'notices_view' => array(
      'render element' => 'elements',
      'template' => 'notices-view',
      'file' => 'notices.theme.inc',
    ),
    'notices_view_teaser' => array(
      'render element' => 'elements',
      'template' => 'notices-view-teaser',
      'file' => 'notices.theme.inc',
    ),
  );
}

/**
 * Implements hook_formfilterapi().
 */
function notices_formfilterapi($op, $session_name, &$a1 = NULL) {
  if ($op == 'filters') {
    $filters = array();

    switch ($session_name) {
      case NOTICES_FORM_NAME;
        $filters['message'] = array(
          '#type' => 'textfield',
          '#title' => t('Message'),
          '#where' => array('like' => "message"),
        );

        $filters['provider'] = array(
          '#type' => 'select',
          '#title' => t('From'),
          '#where' => "provider",
          '#options' => notices_getProviders(),
        );
        $filters['status'] = array(
          '#type' => 'select',
          '#title' => t('Status'),
          '#where' => 'new',
          '#options' => array(
            1 => t('New'),
            0 => t('Read'),
          ),
        );
        break;
    }
    return $filters;
  }
}

/**
 * Implements of hook_views_api().
 */
function notices_views_api() {
  return array(
    'api' => 2,
  );
}

/**
 * Returns status from all Providers.
 *
 * @param array $notice
 *   Array with status by each Providers.
 *
 * @return array
 *   Statuses notice.
 *
 * @ingroup api
 */
function notices_getSendStatus($notice) {
  $statuses = array();
  $notice = (object) $notice;

  foreach (module_implements('sendNotice') as $name) {
    $statuses[$name] = module_invoke($name, 'sendNotice', 'status', $notice);
  }

  return $statuses;
}

/**
 * Returns all Providers.
 *
 * @return array
 *   Array with providers.
 *
 * @ingroup api
 */
function notices_getProviders() {
  $res = array();

  foreach (module_implements('provideNotice') as $name) {
    $provider = module_invoke($name, 'provideNotice', 'settings');
    if (isset($provider['title'])) {
      $res[$name] = $provider['title'];
    }
  }

  return $res;
}

/**
 * Implements hook_permission().
 */
function notices_permission() {
  // Add permission to admin pgapi.
  return array(
    'read notices' => array(
      'title' => t('Read own notices'),
      'description' => t('Allows to read own notices'),
    ),
    'read all notices' => array(
      'title' => t('Read all notices'),
      'description' => t('Allows to read all notices'),
      'restrict access' => TRUE,
    ),
    'administer notice settings' => array(
      'title' => t('Administer notices'),
      'description' => t('Allows to change notices module settings'),
      'restrict access' => TRUE,
    ),
    'delete notices' => array(
      'title' => t('Delete own notices'),
      'description' => t('Allows to delete own notices'),
    ),
    'delete all notices' => array(
      'title' => t('Delete all notices'),
      'description' => t('Allows to delete all notices'),
      'restrict access' => TRUE,
    ),
  );
}

/**
 * Implements hook_menu().
 */
function notices_menu() {
  $items['notices'] = array(
    'title' => 'Notices',
    'title callback' => 'notices_title_callback',
    'page callback' => 'notices_list',
    'access callback' => 'notices_user_access',
    'file' => 'notices.inc',
    'menu_name' => 'user-menu',
  );
  $items['notices/list'] = array(
    'title' => 'Notices',
    'page callback' => 'notices_list',
    'access callback' => 'notices_user_access',
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
    'file' => 'notices.inc',
  );
  $items['notices/settings'] = array(
    'title' => 'Settings',
    'description' => 'Configure notice settings.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('notices_settings'),
    'access callback' => 'notices_user_access',
    'type' => MENU_LOCAL_TASK,
    'file' => 'notices.inc',
  );
  $items['notices/mark-as-read'] = array(
    'title' => 'Mark as Read',
    'description' => 'Mark all notices as read.',
    'page callback' => 'notices_mark_as_read',
    'access callback' => 'notices_user_access',
    'type' => MENU_CALLBACK,
    'file' => 'notices.inc',
  );
  $items['notices/view/%noticeid'] = array(
    'title' => 'Read message',
    'page callback' => 'notices_view',
    'page arguments' => array(2),
    'access callback' => 'notices_view_access',
    'access arguments' => array(2),
    'type' => MENU_LOCAL_TASK,
    'weight' => -5,
    'file' => 'notices.inc',
  );
  $items['notices/delete/%noticeid'] = array(
    'title' => 'Delete message',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('notices_delete_form', 2),
    'access callback' => 'notices_delete_access',
    'access arguments' => array(2),
    'type' => MENU_CALLBACK,
    'file' => 'notices.inc',
  );
  $items['admin/config/notices'] = array(
    'title' => 'Notices Tools',
    'description' => 'Configure notice settings.',
    'position' => 'right',
    'weight' => 7,
    'page callback' => 'notices_admin_menu_block_page',
    'access arguments' => array('administer notice settings'),
    'file' => 'notices.admin.inc',
  );
  $items['admin/config/notices/default'] = array(
    'title' => 'Notices Settings',
    'description' => 'Configure private messaging settings.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('notices_admin_settings'),
    'access arguments' => array('administer notice settings'),
    'weight' => -10,
    'file' => 'notices.admin.inc',
  );
  $items['admin/config/notices/add'] = array(
    'title' => 'Add notice',
    'description' => 'Create custom notice.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('notices_settings_add'),
    'access arguments' => array('administer notice settings'),
    'file' => 'notices.admin.inc',
  );
  $items['user/%user/notices'] = array(
    'title' => 'Notices',
    'page callback' => 'notices_list',
    'page arguments' => array(1),
    'access callback' => 'notices_user_access',
    'access arguments' => array('read all notices'),
    'type' => MENU_LOCAL_TASK,
    'file' => 'notices.inc',
  );
  $items['ajax/notices/notices-remove/%/%'] = array(
    'title' => 'Ajax remove notice',
    'page callback' => 'notices_remove_ajax',
    'page arguments' => array(3, 4),
    'access callback' => 'notices_delete_access',
    'access arguments' => array(3),
    'type' => MENU_CALLBACK,
    'file' => 'notices.ajax.inc',
  );
  $items['ajax/notices/notices-mark-as-read'] = array(
    'title' => 'Ajax mark notice as read',
    'page callback' => 'notices_mark_read_ajax',
    'page arguments' => array('all'),
    'access callback' => TRUE,
    'type' => MENU_CALLBACK,
    'file' => 'notices.ajax.inc',
  );

  $items['ajax/notices/notices-mark-as-read/%noticeid'] = array(
    'title' => 'Ajax mark notice as read',
    'page callback' => 'notices_mark_read_ajax',
    'page arguments' => array(3),
    'access callback' => 'notices_view_access',
    'access arguments' => array(3),
    'type' => MENU_CALLBACK,
    'file' => 'notices.ajax.inc',
  );

  return $items;
}

/**
 * Notice  wrapper for user_access. Never allows anonymous user access as
 * that doesn't makes sense.
 *
 * @param string $permission
 *   Permission string, defaults to read private notice.
 *
 * @param object $account
 *   User object.
 *
 * @return bool
 *   TRUE if user has access, FALSE if not.
 */
function notices_user_access($permission = 'read notices', $account = NULL) {
  if ($account === NULL) {
    global $user;
    $account = $user;
  }

  // Disallow anonymous access, regardless of permissions.
  if (!$account->uid) {
    return FALSE;
  }

  if (!user_access($permission, $account)) {
    return FALSE;
  }

  return TRUE;
}

/**
 * Check access to the view notices page.
 *
 * Function to restrict the access of the view notices page or
 * ajax call by user_id.
 */
function notices_view_access($notice) {
  global $user;

  if ($notice->uid != $user->uid) {
    if (notices_user_access('read all notices', $user)) {
      return TRUE;
    }
  }
  elseif (notices_user_access('read notices') && (arg(1) == 'view' || arg(2) == 'notices-mark-as-read')) {
    return TRUE;
  }

  return FALSE;
}

/**
 * Check access to the delete notice.
 *
 * Function to restrict the access of the delete notice page or
 * ajax call by user_id.
 */
function notices_delete_access($notice) {
  global $user;

  if ($notice->uid != $user->uid) {
    if (notices_user_access('delete all notices', $user)) {
      return TRUE;
    }
  }
  elseif (notices_user_access('delete notices') && arg(1) == 'delete') {
    return TRUE;
  }

  return FALSE;
}

/**
 * Loads notice by ID.
 *
 * Used as menu autoload function.
 *
 * @param int $noticeid
 *   Notice ID.
 *
 * @return object
 *   Loaded notice.
 *
 * @ingroup api
 */
function noticeid_load($noticeid) {
  $notice = db_query('SELECT * FROM {notices} WHERE noticeid = :noticeid', array(
    ':noticeid' => $noticeid,
  ))->fetchObject();

  return $notice;
}

function notices_load_settings($uid) {
  $settings = db_query('SELECT * FROM {notices_settings} WHERE uid = :uid', array(
    ':uid' => $uid,
  ))->fetchObject();

  $account = user_load($uid);

  if (!empty($settings)) {
    $settings->settings = unserialize($settings->settings);
    foreach (module_implements('provideNotice') as $name) {
      module_invoke($name, 'provideNotice', 'settings');

      if (module_exists('notices_email')) {
        if(!isset($settings->settings[$name])) {
          $settings->settings[$name] = array(
            'notices_email' => array(
              'active' => 1,
              'values' => $account->mail,
            ),
          );
        }
      }

      $settings->is_empty = FALSE;
    }
  }
  else {

    $settings = new stdClass();
    $settings->uid = $account->uid;
    foreach (module_implements('provideNotice') as $name) {
      module_invoke($name, 'provideNotice', 'settings');

      if (module_exists('notices_email')) {
        $settings->settings[$name] = array(
          'notices_email' => array(
            'active' => 1,
            'values' => $account->mail,
          ),
        );
      }

      $settings->is_empty = TRUE;
    }
  }

  return $settings;
}

/**
 * Menu item title callback for the 'notices' path.
 */
function notices_title_callback($title = NULL) {
  $count = notices_unread_count();

  if ($count > 0) {
    return t('Notices (@count new)', array('@count' => $count));
  }

  return t('Notices');
}

/**
 * Return number of unread notices for an account.
 *
 * @param object $account
 *   Specifiy the user for which the unread count should be loaded.
 *
 * @ingroup api
 */
function notices_unread_count($account = NULL) {
  if (!$account || $account->uid == 0) {
    global $user;
    $account = $user;
  }

  $count = db_query('SELECT count(*) as notices FROM {notices} WHERE uid=:uid AND new =:new', array(
    ':uid' => $account->uid,
    ':new' => NOTICES_UNREAD,
  ))->fetchObject();

  return $count->notices;
}

/**
 * Mark notice as readed.
 *
 * @param object $notice
 *   Notice object.
 *
 * @return bool
 *   Create new notice or not.
 *
 * @ingroup api
 */
function notices_mark_read($notice) {
  $notice->new = NOTICES_READ;
  notices_save($notice);
}

/**
 * Delete notice.
 *
 * @param int $noticeid
 *   Notice ID.
 *
 * @ingroup api
 */
function notices_delete($noticeid) {
  $notice = noticeid_load($noticeid);
  $settings = notices_load_settings($notice->uid);
  if (isset($settings->settings)) {
    $send_options = $settings->settings[$notice->provider];

    if (is_array($send_options)) {
      foreach ($send_options as $name => $status) {
        module_invoke($name, 'sendNotice', 'delete', $notice);
      }
    }
  }

  db_delete('notices')
    ->condition('noticeid', $noticeid, '=')
    ->execute();
}

/**
 * Save or update notice.
 *
 * @param object $notice
 *   Object notice.
 *
 * @ingroup api
 */
function notices_save(&$notice) {
  $notice = (object) $notice;

  if (isset($notice->noticeid)) {
    return drupal_write_record('notices', $notice, 'noticeid');
  }
  else {
    if (!isset($notice->format)) {
      $notice->format = variable_get('filter_default_format', 1);
    }

    $notice->new = NOTICES_UNREAD;
    $notice->timestamp = REQUEST_TIME;

    $new_notice = drupal_write_record('notices', $notice);

    $settings = notices_load_settings($notice->uid);
    if (!empty($settings->settings)) {
      $send_options = isset($settings->settings[$notice->provider]) ? $settings->settings[$notice->provider] : FALSE;

      if (is_array($send_options)) {
        foreach ($send_options as $name => $status) {
          if ($status['active'] == 1) {
            module_invoke($name, 'sendNotice', 'send', $notice, $status['values']);
          }
        }
        //foreach
      }
    }

    return $new_notice;
  }
}