sopac.module

<?php
/**
 * SOPAC is The Social OPAC: a Drupal module that serves as a wholly integrated web OPAC for the Drupal CMS
 *
 * @package SOPAC
 * @version 2.1
 * @author John Blyberg
 */


/**
 * Initialize the SOPAC module.  Load dependencies, etc...
 */
function sopac_init() {
  global $user, $base_url;

  // Handle SSL redirection if it is enabled.
  // You may need to occasionally add additional paths here so that embedded javascript can load in iframes (imce is an example of that)
  if ( variable_get( 'sopac_ssl_enable', 0 ) ) {
    $protected_uri = preg_match( '/^(\/user|\/myaccount|\/login|\/imce)/', request_uri(), $debug_match );
    if ( $_SERVER['HTTPS'] && !$protected_uri ) {
      //$new_link = 'http://' . $_SERVER['HTTP_HOST'] . request_uri();
    }
    elseif ( !$_SERVER['HTTPS'] && $protected_uri ) {
      if ( variable_get( 'sopac_ssl_port', 443 ) != '443' ) {
        $nonstd_port = ':' . variable_get( 'sopac_ssl_port', 443 );
      }
      $new_link = 'https://' . $_SERVER['HTTP_HOST'] . request_uri();
    }

    // Force SSL no matter what
    $new_link = 'https://' . $_SERVER['HTTP_HOST'] . request_uri();
    if ( $new_link ) {
      header( "Location: $new_link" );
    }
  }

  // Set up some user-specific values
  if ( $user->uid ) {
    $user->locum_pass = substr( $user->pass, 0, 7 );
  }

  // Assign the various CSS Files
  drupal_add_css( drupal_get_path( 'module', 'sopac' ) .'/sopac.css' );

}

/**
 * Display help and module information
 *
 * @param string  $path Which path of the site we're displaying help
 * @param array   $arg  Array that holds the current path as would be returned from arg() function
 * @return string help text for the path
 */
function sopac_help( $path, $arg ) {
  $output = '';
  switch ( $path ) {
  case "admin/help#sopac":
    $output = '<p>'.  t( "The Social OPAC&trade; for Drupal" ) .'</p>';
    break;
  }
  return $output;
}

/**
 * Valid permissions for this module
 *
 * @return array An array of valid permissions for the sopac module
 */
function sopac_perm() {
  return array( 'access user pages', 'administer sopac' );
}

/**
 * Generate HTML for the sopac block.
 * Uses the following templates: sopac_facet_block.tpl.php
 *
 * @param string  $op    the operation from the URL
 * @param int     $delta offset
 * @return string block HTML
 */
function sopac_block( $op = 'list', $delta = 0 ) {
  global $locum_results_all, $locum_cfg;
  $sopac_prefix = variable_get( 'sopac_url_prefix', 'cat/seek' );

  // listing of blocks, such as on the admin/block page
  switch ( $op ) {

  case 'list':
    $block[0] = array(
      'info' => t( 'Catalog Facets' ),
      'pages' => $sopac_prefix . '/search/*',
    );
    $block[1] = array(
      'info' => t( 'Search Tracker' ),
      'pages' => $sopac_prefix . '/search/*',
    );
    $block[2] = array(
      'info' => t( 'Catalog Tags' ),
      'pages' => $sopac_prefix . '/*',
    );
    $block[3] = array(
      'info' => t( 'Catalog Reviews' ),
      'pages' => $sopac_prefix . '/*',
      'weight' => 1,
    );
    $block[4] = array(
      'info' => t( 'Item Tags' ),
      'pages' => $sopac_prefix . '/record/*',
    );
    $block[5] = array(
      'info' => t( 'Item Reviews' ),
      'pages' => $sopac_prefix . '/record/*',
      'weight' => 1,
    );
    $block[6] = array(
      'info' => t( 'Personal Tags' ),
      'pages' => 'user/*',
    );
    $block[7] = array(
      'info' => t( 'Personal Reviews' ),
      'pages' => 'user/*',
      'weight' => 1,
    );
    return $block;
  case 'view':
    switch ( $delta ) {
    case 0:
      if ( $locum_results_all['num_hits'] ) {
        $block_content = theme( 'sopac_facet_block', $facet_menu, $locum_results_all, $locum_cfg );
        $block['subject'] = t( 'Facets' );
        $block['content'] = $block_content;
      }
      break;
    case 1:
      require_once 'sopac_catalog.php';
      $block['subject'] = t( 'Your Search' );
      $block_content = sopac_search_block( $locum_results_all, $locum_cfg );
      $block['content'] = $block_content;
      break;
    case 2:
      // SOPAC overview block for patron tags
      require_once 'sopac_social.php';
      $block['subject'] = t( 'Popular Tags' );
      $block['content'] = theme( 'sopac_tag_block', 'overview' );
      break;
    case 3:
      // SOPAC overview block for patron reviews
      require_once 'sopac_social.php';
      $block['subject'] = t( 'New Reviews' );
      $block['content'] = theme( 'sopac_review_block', 'overview' );
      break;
    case 4:
      // SOPAC item record block for patron tags
      require_once 'sopac_social.php';
      $block['subject'] = t( 'Record Tags' );
      $block['content'] = theme( 'sopac_tag_block', 'record' );
      break;
    case 5:
      // SOPAC item record block for patron reviews
      require_once 'sopac_social.php';
      $block['subject'] = t( 'Reviews' );
      $block['content'] = theme( 'sopac_review_block', 'record' );
      break;
    case 6:
      // SOPAC personal record block for patron's own tags
      require_once 'sopac_social.php';
      $block['subject'] = t( 'My Top Tags' );
      $block['content'] = theme( 'sopac_tag_block', 'personal' );
      break;
    case 7:
      // SOPAC personal record block for patron's own reviews
      require_once 'sopac_social.php';
      $block['subject'] = t( 'My Reviews' );
      $block['content'] = theme( 'sopac_review_block', 'personal' );
      break;
    }

    return $block;
  }
}


/**
 * Implementation of hook_menu()
 * Determines what the callback is for SOPAC and returns the appropriate Drupal menu array
 *
 * @return array Drupal menu array
 */
function sopac_menu() {
  global $user;
  $sopac_prefix = variable_get( 'sopac_url_prefix', 'cat/seek' );

  $items = array();

  $items['admin/settings/sopac'] = array(
    'title' => 'SOPAC settings',
    'description' => 'SOPAC configuration options',
    'page callback' => 'drupal_get_form',
    'page arguments' => array( 'sopac_admin' ),
    'access arguments' => array( 'access administration pages' ),
    'file' => 'sopac_admin.php',
    'type' => MENU_NORMAL_ITEM,
  );

  $items[$sopac_prefix . '/search'] = array(
    'title' => 'Catalog Search',
    'page callback' => 'sopac_catalog_search',
    'access arguments' => array( 'access content' ),
    'file' => 'sopac_catalog.php',
    'type' => MENU_CALLBACK,
  );

  $items[$sopac_prefix . '/savesearch'] = array(
    'title' => 'Save Search',
    'page callback' => 'drupal_get_form',
    'page arguments' => array( 'sopac_savesearch_form' ),
    'access arguments' => array( 'access user pages' ),
    'file' => 'sopac_user.php',
    'type' => MENU_CALLBACK,
  );

  $items[$sopac_prefix . '/record/%'] = array(
    'title' => 'Item Record',
    'page callback' => 'sopac_bib_record',
    'access arguments' => array( 'access content' ),
    'file' => 'sopac_catalog.php',
    'type' => MENU_CALLBACK,
  );

  $items[$sopac_prefix . '/request'] = array(
    'title' => 'Request an Item',
    'page callback' => 'sopac_request_item',
    'access arguments' => array( 'access content' ),
    'file' => 'sopac_catalog.php',
    'type' => MENU_CALLBACK,
  );

  $items['user/checkouts'] = array(
    'title' => 'My Checkouts',
    'page callback' => 'sopac_checkouts_page',
    'access arguments' => array( 'access user pages' ),
    'file' => 'sopac_user.php',
    'type' => MENU_NORMAL_ITEM,
  );

  $items['user/holds'] = array(
    'title' => 'My Holds',
    'page callback' => 'sopac_holds_page',
    'access arguments' => array( 'access user pages' ),
    'file' => 'sopac_user.php',
    'type' => MENU_NORMAL_ITEM,
  );

  if ( variable_get( 'sopac_fines_enable', 1 ) ) {
    /*
    $items['user/fines'] = array(
      'title' => 'My Fines',
      'page callback' => 'sopac_fines_page',
      'access arguments' => array( 'access user pages' ),
      'file' => 'sopac_user.php',
      'type' => MENU_NORMAL_ITEM,
    );
    */
    $items['user/fines/list'] = array(
      'title' => 'List Fines',
      'access arguments' => array( 'access user pages' ),
      'weight' => -10,
      'file' => 'sopac_user.php',
      'type' => MENU_DEFAULT_LOCAL_TASK,
    );


    if ( variable_get( 'sopac_payments_enable', 1 ) ) {
    /*
      $items['user/fines/payments'] = array(
        'title' => 'List Payments',
        'page callback' => 'sopac_finespaid_page',
        'access arguments' => array( 'access user pages' ),
        'file' => 'sopac_user.php',
        'type' => MENU_LOCAL_TASK,
      );
      */

      $items['user/fines/pay'] = array(
        'title' => 'Fines Payment',
        'page callback' => 'sopac_makepayment_page',
        'access arguments' => array( 'access user pages' ),
        'file' => 'sopac_user.php',
        'type' => MENU_CALLBACK,
      );
    }
  }

  $items['user/library'] = array(
    'title' => 'My Library',
    'page callback' => 'sopac_personal_overview_page',
    'access arguments' => array( 'access user pages' ),
    'file' => 'sopac_social.php',
    'type' => MENU_NORMAL_ITEM,
  );

  $items['user/library/tags'] = array(
    'title' => 'My Tags',
    'page callback' => 'sopac_tags_page_cloud',
    'access arguments' => array( 'access user pages' ),
    'file' => 'sopac_social.php',
    'type' => MENU_NORMAL_ITEM,
  );

  $items['user/library/tags/cloud'] = array(
    'title' => 'Tag Cloud',
    'access arguments' => array( 'access user pages' ),
    'weight' => -10,
    'file' => 'sopac_social.php',
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );

  $items['user/library/tags/list'] = array(
    'title' => 'Tag List',
    'page callback' => 'sopac_tags_page_list',
    'access arguments' => array( 'access user pages' ),
    'file' => 'sopac_social.php',
    'type' => MENU_LOCAL_TASK,
  );

  $items['user/tag/edit'] = array(
    'title' => 'Edit Tag',
    'page callback' => 'drupal_get_form',
    'page arguments' => array( 'sopac_user_tag_edit' ),
    'access arguments' => array( 'access user pages' ),
    'file' => 'sopac_social.php',
    'type' => MENU_CALLBACK,
  );

  $items['user/tag/delete'] = array(
    'title' => 'Delete Tag',
    'page callback' => 'drupal_get_form',
    'page arguments' => array( 'sopac_user_tag_delete' ),
    'access arguments' => array( 'access user pages' ),
    'file' => 'sopac_social.php',
    'type' => MENU_CALLBACK,
  );

  $items['user/tag/show'] = array(
    'title' => 'Tagged Items',
    'page callback' => 'sopac_user_tag_hitlist',
    'page arguments' => array( 3 ),
    'access arguments' => array( 'access user pages' ),
    'file' => 'sopac_social.php',
    'type' => MENU_CALLBACK,
  );

  $items['user/library/ratings'] = array(
    'title' => 'My Ratings',
    'page callback' => 'sopac_ratings_page',
    'access arguments' => array( 'access user pages' ),
    'file' => 'sopac_social.php',
    'type' => MENU_NORMAL_ITEM,
  );

  $items['user/library/reviews'] = array(
    'title' => 'My Reviews',
    'page callback' => 'sopac_review_page',
    'access arguments' => array( 'access user pages' ),
    'page arguments' => array( 'personal' ),
    'file' => 'sopac_social.php',
    'type' => MENU_NORMAL_ITEM,
  );

  $items['user/library/searches'] = array(
    'title' => 'My Searches',
    'page callback' => 'sopac_saved_searches_page',
    'access arguments' => array( 'access user pages' ),
    'file' => 'sopac_user.php',
    'type' => MENU_NORMAL_ITEM,
  );

  $items['user/library/history'] = array(
    'title' => 'My Checkout History',
    'page callback' => 'sopac_checkout_history_page',
    'access arguments' => array( 'access user pages' ),
    'file' => 'sopac_user.php',
    'type' => MENU_NORMAL_ITEM,
  );

  $items['review/delete'] = array(
    'title' => 'Delete Review',
    'page callback' => 'drupal_get_form',
    'page arguments' => array( 'sopac_delete_review_form' ),
    'access arguments' => array( 'access user pages' ),
    'file' => 'sopac_social.php',
    'type' => MENU_CALLBACK,
  );

  $items['review/edit'] = array(
    'title' => 'Edit Review',
    'page callback' => 'drupal_get_form',
    'page arguments' => array( 'sopac_review_form' ),
    'access arguments' => array( 'access user pages' ),
    'file' => 'sopac_social.php',
    'type' => MENU_CALLBACK,
  );

  $items['review/view'] = array(
    'title' => 'Read Review',
    'page callback' => 'sopac_review_page',
    'access arguments' => array( 'access content' ),
    'page arguments' => array( 'single' ),
    'file' => 'sopac_social.php',
    'type' => MENU_CALLBACK,
  );

  $items['review/user'] = array(
    'title' => 'User Reviews',
    'page callback' => 'sopac_review_page',
    'access arguments' => array( 'access content' ),
    'page arguments' => array( 'user' ),
    'file' => 'sopac_social.php',
    'type' => MENU_CALLBACK,
  );

  return $items;
}

/**
 * Implementation of hook_theme()
 */
function sopac_theme() {
  return array(
    'sopac_results' => array(
      'template' => 'sopac-results',
      'arguments' => array( 'result_info' => NULL, 'hitlist_pager' => NULL, 'hitlist_content' => NULL, 'locum_result' => NULL, 'locum_config' => NULL ),
    ),
    'sopac_results_rss' => array(
      'template' => 'sopac-results-rss',
      'arguments' => array( 'result_info' => NULL, 'search_term' => NULL, 'search_type' => NULL, 'hitlist_content' => NULL, 'locum_result' => NULL, 'locum_config' => NULL ),
    ),
    'sopac_results_hitlist' => array(
      'template' => 'sopac-results-hitlist',
      'arguments' => array( 'result_num' => NULL, 'cover_img_url' => NULL, 'locum_result' => NULL, 'locum_config' => NULL, 'no_circ' => NULL ),
    ),
    'sopac_results_hitlist_rss' => array(
      'template' => 'sopac-results-hitlist-rss',
      'arguments' => array( 'result_num' => NULL, 'cover_img_url' => NULL, 'locum_result' => NULL, 'locum_config' => NULL, 'no_circ' => NULL ),
    ),
    'sopac_results_nohits' => array(
      'template' => 'sopac-results-nohits',
      'arguments' => array( 'locum_result' => NULL, 'locum_config' => NULL ),
    ),
    'sopac_record' => array(
      'template' => 'sopac-record',
      'arguments' => array( 'item' => NULL, 'item_status' => NULL, 'locum_config' => NULL, 'no_circ' => NULL, 'locum' => NULL, 'rev_arr' => NULL, 'rev_form' => NULL ),
    ),
    'sopac_review' => array(
      'template' => 'sopac-review',
      'arguments' => array( 'user' => NULL, 'title' => NULL, 'rev_arr' => NULL, 'page_type' => NULL, 'rev_form' => NULL, 'ratings' => NULL, 'no_rev_msg' => NULL, 'bib_info' => NULL ),
    ),
    'sopac_facet_block' => array(
      'template' => 'sopac-facet-block',
      'arguments' => array( 'facet_menu' => NULL, 'locum_result' => NULL, 'locum_config' => NULL ),
    ),
    'sopac_search_block' => array(
      'template' => 'sopac-search-block',
      'arguments' => array( 'search' => NULL, 'locum_result' => NULL, 'locum_config' => NULL, 'user' => NULL ),
    ),
    'sopac_request' => array(
      'template' => 'sopac-request',
      'arguments' => array( 'request_result_msg' => NULL, 'request_error_msg' => NULL, 'item_form' => NULL, 'bnum' => NULL ),
    ),
    'sopac_fines' => array(
      'template' => 'sopac-fines',
      'arguments' => array( 'notice' => NULL, 'fine_table' => NULL, 'user' => NULL, 'payment_form' => NULL ),
    ),
    'sopac_pat_overview' => array(
      'template' => 'sopac-pat-overview',
      'arguments' => array( 'review_display' => NULL, 'ratings_chunk' => NULL, 'tag_cloud' => NULL ),
    ),
    'sopac_ratings_page' => array(
      'template' => 'sopac-ratings-page',
      'arguments' => array( 'ratings_arr' => NULL ),
    ),
    'sopac_tags_page' => array(
      'template' => 'sopac-tags-page',
      'arguments' => array( 'tags_arr' => NULL ),
    ),
    'sopac_user_tag_hitlist' => array(
      'template' => 'sopac-user-tag-hitlist',
      'arguments' => array( 'tag' => NULL, 'pager_body' => NULL, 'result_body' => NULL ),
    ),
    'sopac_tag_block' => array(
      'arguments' => array( 'block_type' => NULL ),
    ),
    'sopac_review_block' => array(
      'arguments' => array( 'block_type' => NULL ),
    ),
    'sopac_tag_cloud' => array(
      'arguments' => array( 'tags' => NULL, 'cloud_type' => 'catalog', 'min_size' => 10, 'max_size' => 24, 'wraplength' => 19 ),
    ),
    'sopac_get_rating_stars' => array(
      'arguments' => array( 'bnum' => NULL, 'rating' => NULL, 'show_label' => TRUE, 'post_redirect' => FALSE, 'id' => 'default' ),
    ),
    'sopac_user_holds_list' => array(
      'template' => 'sopac-user-holds-list',
      'arguments' => array( 'data' => array() ),
    ),
    'sopac_user_holds_list_multirow' => array(
      'template' => 'sopac-user-holds-list-multirow',
      'arguments' => array( 'data' => array() ),
    ),
    'sopac_user_history_form' => array(
      'template' => 'sopac-user-history-list',
      'arguments' => array( 'form' => NULL ),
    ),
  );
}

/**
 * Preprocess function (apparently needs to be in module page so found by theme register)
 *
 * @param array   $variables
 */
function sopac_preprocess_sopac_user_holds_list( &$variables ) {
  $variables['freezes_enabled'] = variable_get( 'sopac_hold_freezes_enable', 1 );
  form_theme_bridge_parse_data_for_layout( $variables );
}

/**
 * Preprocess function (apparently needs to be in module page so found by theme register)
 *
 * @param array   $variables
 */
function sopac_preprocess_sopac_user_holds_list_multirow( &$variables ) {
  form_theme_bridge_parse_data_for_layout( $variables );
}

/**
 * Implementation of hook_user()
 */
function sopac_user( $op, &$edit, &$account, $category = NULL ) {

  require_once 'sopac_user.php';
  switch ( $op ) {
  case 'submit':
    sopac_update_locum_acct( $op, $edit, $account );
    break;

  case 'view':
    sopac_user_view( $op, $edit, $account, $category );
    break;

  case 'delete':
    // TODO : Clean-up
    break;
  }
}

/**
 * Checks to see if $cardnum has been verified
 *
 * @param string  $user_obj Drupal $user object
 * @return boolean True if patron has verified the barcode, False if not.
 */
function sopac_bcode_isverified( &$user_obj ) {
  if ( !$user_obj->profile_pref_cardnum ) {
    profile_load_profile( $user_obj );
  }
  if ( !$user_obj->profile_pref_cardnum ) {
    return FALSE;
  }
  $db_obj = db_fetch_object( db_query( "SELECT COUNT(*) AS vfy FROM {sopac_card_verify} WHERE uid = %d AND cardnum = '%s' AND verified > 0", $user_obj->uid, $user_obj->profile_pref_cardnum ) );
  if ( $db_obj->vfy > 0 ) {
    return TRUE;
  }
  else {
    return FALSE;
  }
}

/**
 * Creates an external function to formulate a search form by doing the neccesary includes.
 * An example for using this might be calling this function from within a node.
 *
 * @param string  $form_type Can be "basic", "advanced", or "both" (default)
 * @return string Drupal-themed and generated search form
 */
function sopac_search_form( $form_type = 'both' ) {

  require_once 'sopac_catalog.php';
  switch ( strtolower( trim( $form_type ) ) ) {
  case 'basic':
    $search_form = drupal_get_form( 'sopac_search_form_basic' );
    break;
  case 'advanced':
    $search_form = drupal_get_form( 'sopac_search_form_adv' );
    break;
  case 'both':
  default:
    $search_form = drupal_get_form( 'sopac_search_form_basic' ) . drupal_get_form( 'sopac_search_form_adv' );
    break;
  }
  return $search_form;
}

/**
 * A little function that strips out all the random crapola that people's browsers sometimes throw in.
 *
 * @return string cleaned-up URI.
 */
function utf8_urldecode( $str ) {
  $str = preg_replace( "/%u([0-9a-f]{3,4})/i", "&#x\\1;", urldecode( $str ) );
  return html_entity_decode( $str, NULL, 'UTF-8' );
}

/**
 * This function parses the URI to grab the elements upon which SOPAC acts. This is an
 * attempt at pseudo-RESTful URIs within the catalog.  We'll still use some GET vars but
 * the major functionality if represented RESTfully.
 *
 * @return array Array of URI elements
 */
function sopac_parse_uri( $strip_prefix = TRUE ) {

  // Strip out everything in the URI up through SOPAC's prefix
  if ( $strip_prefix ) {
    $args_raw = substr( $_GET['q'], strlen( variable_get( 'sopac_url_prefix', 'cat/seek' ) ) );
  }
  else {
    $args_raw = $_GET['q'];
  }

  $uri_array = explode( '/', $args_raw );
  if ( $uri_array[0] == '' ) {
    array_shift( $uri_array );
  }

  foreach ( $uri_array as $uri_elem ) {
    $result[] = urldecode( trim( $uri_elem ) );
  }

  return $result;
}

/**
 * Returns an array of GET variables, allowing for the ability to override them
 * It also parses getvars with multiple values delimited by |
 *
 * @param array   $override Optional override option that will override actual GET variables
 * @return boolean|array If there are GET vars, an array of GET vars is returned, or else FALSE
 */
function sopac_parse_get_vars( $override = array() ) {

  // TODO - Hard-coding this is not the best way to do it, but for now it is what it is... Revisit for 2.2?
  $implode = array( 'search_format', 'pub_year', 'location', 'collection', 'facet_series', 'facet_lang', 'facet_year', 'facet_decade', 'age', 'facet_subject' );

  foreach ( $_GET as $name => $value ) {
    if ( in_array( $name, $implode ) ) {
      $vars[$name] = explode( '|', trim( $value ) );
    } else if ( $name != 'q' ) {
        // don't include the drupal path variable
        $vars[$name] = $value;
      }
  }

  foreach ( $override as $okey => $ovar ) {
    if ( $ovar ) {
      $vars[$okey] = $ovar;
    }
    else {
      unset( $vars[$okey] );
    }
  }

  return count( $vars ) ? $vars : FALSE;
}

/**
 * Takes an array and creates page variable.  It's basically the reverse of sopac_parse_get_vars()
 *
 * @param array   Array of variables to formulate
 * @return string GET variable string
 */
function sopac_make_pagevars( $getvars ) {
  $pagevars = '';

  if ( is_array( $getvars ) && count( $getvars ) ) {
    foreach ( $getvars as $key => $var ) {
      if ( is_array( $var ) ) {
        $var = implode( '|', $var );
      }
      $pagevars .= $key . '=' . $var . '&';
    }
    $pagevars = substr( $pagevars, 0, -1 );
  }
  return $pagevars;

}

/**
 * Takes a url, and a new varname/value pair and updates a url
 *
 * @param string  $url  URL
 * @param string  $uKey Variable name
 * @param string  $uVal Variable value
 * @return string New URL with variable
 */
function sopac_update_url( $url, $uKey, $uVal ) {
  $Qurl = explode( "?", $url );
  $arr = explode( "&", $Qurl[1] );
  $r = '';
  $set = 0;
  for ( $i = 0; $i < sizeof( $arr ); $i++ ) {
    $arr2 = explode( "=", $arr[$i] );
    if ( $arr2[0] == $uKey ) {
      $arr2[1] = $uVal;
      $set = 1;
    }
    $r .= $arr2[0] . "=" . $arr2[1] . "&";
  }
  if ( $set == 0 ) {
    $r .= $uKey . "=" . $uVal;
  }
  else {
    $r = rtrim( $r, "&" );
  }
  return $Qurl[0] . '?' . $r;
}

/**
 * Function to automate the handling of the pager system.
 */
function sopac_pager_init( $total, $element = 0, $limit = 10 ) {
  global $pager_page_array, $pager_total, $pager_total_items;
  $page = isset( $_GET['page'] ) ? $_GET['page'] : '';

  // Convert comma-separated $page to an array, used by other functions.
  $pager_page_array = explode( ',', $page );

  // We calculate the total of pages as ceil(items / limit).
  $pager_total_items[$element] = $total;
  $pager_total[$element] = ceil( $pager_total_items[$element] / $limit );
  $pager_page_array[$element] = max( 0, min( (int)$pager_page_array[$element], ( (int)$pager_total[$element] ) - 1 ) );
}

function sopac_user_block_disp_query() {
  global $user;

  $user_views = array( 'fines', 'library', 'holds', 'checkouts', 'tag' );
  $uri_arr = explode( '/', $_GET['q'] );
  if ( $uri_arr[0] == 'user' && in_array( $uri_arr[1], $user_views ) ) {
    return TRUE;
  }
  return $user->uid && arg( 0 ) == 'user' && is_numeric( arg( 1 ) ) && arg( 1 ) == $user->uid;
  return FALSE;
}

function sopac_get_branch_options() {
  $locum = sopac_get_locum();
  $branches = $locum->locum_config['branches'];
  return $branches;
}

function sopac_cron() {
  // Part of supporting user home branch in multibranch situation
  if ( variable_get( 'sopac_home_branch_enable', FALSE ) && !variable_get( 'sopac_home_selector_options', FALSE ) ) {
    require_once 'sopac_admin.php';
    sopac_setup_user_home_selector();
  }
  menu_rebuild();
}

/**
 * Return an object which is a locum
 *
 * @param string  $type
 * @param Boolean $refresh
 * @return object
 */
function sopac_get_locum( $type = 'client', $refresh = FALSE ) {
  static $instances = array();

  $new_type = !array_key_exists( $type, $instances );
  if ( $new_type ) {
    $path = trim( variable_get( 'sopac_locum_path', '/usr/local/lib/locum' ) );
    if ( $path[0] != '/' ) {
      $path = '/' . $path;
    }
    if ( substr( $path, -1 ) != '/' ) {
      $path .= '/';
    }
    $path .= $type == 'locum' ? '' : 'locum-';
    include_once $path . $type . '.php';
  }
  if ( $new_type || $refresh ) {
    $class_name = $type == 'locum' ? '' : 'locum_';
    $class_name .= $type;
    $instances[$type] = new $class_name();
  }
  return $instances[$type];
}

/**
 * Return an object which is a insurge
 *
 * @param string  $type
 * @param Boolean $refresh
 * @return object
 */
function sopac_get_insurge( $type = 'client', $refresh = FALSE ) {
  static $instances = array();

  $new_type = !array_key_exists( $type, $instances );
  if ( $new_type ) {
    $path = trim( variable_get( 'sopac_insurge_path', '/usr/local/lib/insurge' ) );
    if ( $path[0] != '/' ) {
      $path = '/' . $path;
    }
    if ( substr( $path, -1 ) != '/' ) {
      $path .= '/';
    }
    $path .= $type == 'insurge' ? '' : 'insurge-';
    include_once $path . $type . '.php';
  }
  if ( $new_type || $refresh ) {
    $class_name = $type == 'insurge' ? '' : 'insurge_';
    $class_name .= $type;
    $instances[$type] = new $class_name();
  }
  return $instances[$type];
}

/**
 * implementation of hook_form_alter for user_profile_form
 */
function sopac_form_user_profile_form_alter( &$form, &$form_state) {
  $form['#validate'] = array();
  if ( !in_array( $form['#validate'], array('sopac_user_profile_form_validate') ) ) {
    array_unshift( $form['#validate'], 'sopac_user_profile_form_validate' );
  }



}

/**
 * validate user_profile_form
 *
 * @param array   $form
 * @param array   $form_state
 */
function sopac_user_profile_form_validate( &$form, &$form_state ) {
  global $user;

  $form_state['values']['profile_pref_cardnum'] = trim( $form_state['values']['profile_pref_cardnum'] );

  $account = user_load($user->uid);
  $cardnum = $account->profile_pref_cardnum;
  $cohist_enabled = $form_state['values']['profile_pref_cohist'];

  $locum = sopac_get_locum();

  $ils_hist_enabled = $cardnum ? $locum->set_patron_checkout_history( $cardnum, $locum_pass, 'status' ) : FALSE;
  if ( $cohist_enabled ) {
    if (!$ils_hist_enabled && $cardnum) {
      $locum->set_patron_checkout_history( $cardnum, $locum_pass, 'on' );
    }
  }
  else {
    if ($ils_hist_enabled && $cardnum) {
      $locum->set_patron_checkout_history( $cardnum, $locum_pass, 'off' );
    }
  }

}