locum.php

<?php
/**
 * Locum is a software library that abstracts ILS functionality into a
 * catalog discovery layer for use with such things as bolt-on OPACs like
 * SOPAC.
 * @package Locum
 * @author John Blyberg
 */


/**
 * This is the parent Locum class for all locum-related activity.
 * This is called as the parent by either the client or the server piece.
 */
class locum {

  public $locum_config;
  public $locum_cntl;
  public $db;
  public $dsn;

  /**
   * Locum constructor.
   * This function prepares Locum for activity.
   */
  public function __construct() {
    if (file_exists('locum-hooks.php')) {
      require_once('locum-hooks.php');
    }
    if (is_callable(array('locum_hook', 'constructor_override'))) {
      $hook = new locum_client_hook;
      $hook->constructor_override($this);
      if ($this->replace_constructor) {
        return;
      }
    }
    
    ini_set('memory_limit','128M');
    $this->locum_config = parse_ini_file('config/locum.ini', true);
    $script_dir = realpath(dirname(__FILE__));

    // Take care of requirements
    require_once('MDB2.php');
    require($this->locum_config['locum_config']['dsn_file']);
    $this->dsn = $dsn;
    $connector_type = 'locum_'
      . $this->locum_config['ils_config']['ils'] . '_'
      . $this->locum_config['ils_config']['ils_version'];
    require_once('connectors/' . $connector_type . '/' . $connector_type . '.php');

    // Fire up the Locum connector
    $locum_class_name = 'locum_' . $this->locum_config['ils_config']['ils'] . '_' . $this->locum_config['ils_config']['ils_version'];
    $this->locum_cntl =& new $locum_class_name;
    if (file_exists($script_dir . '/connectors/' . $connector_type . '/config/' . $connector_type . '.ini')) {
      $this->locum_config = array_merge($this->locum_config, parse_ini_file('connectors/' . $connector_type . '/config/' . $connector_type . '.ini', true));
    }
    // Allow connector to set itself up using locum_config info,
    // passing in $this so connector can use its methods.
    if (method_exists($this->locum_cntl, 'init')) {
    	$this->locum_cntl->init($this);
    }
    else {
      $this->locum_cntl->locum_config = $this->locum_config;
    }
  }


  /**
   * Instead of using stdout, Locum will handle output via this logging transaction.
   *
   * @param string $msg Log message
   * @param int $severity Loglevel/severity of the message
   * @param boolean $silent Output to stdout.  Default: yes
   */
  public function putlog($msg, $severity = 1, $silent = TRUE) {
    
    if ($severity > 5) { $severity = 5; }
    $logfile = $this->locum_config['locum_config']['log_file'];
    $quiet = $this->locum_config['locum_config']['run_quiet'];

    $indicator = '';
    for ($i = 0; $i < $severity; $i++) { $indicator .= '*'; }
    $indicator = '[' . str_pad($indicator, 5) . ']';
    file_put_contents($logfile, $indicator . ' ' . $msg . "\n", FILE_APPEND);
    if (!$quiet && !$silent) { print $indicator . ' ' . $msg . "\n"; }
  }

  /**
   * Returns a specifically formatted array or string based on locum config values passed.  This is primarily used internally,
   * for instance, with custom search handlers.
   *
   * @param string $csv Comma (or otherwise) separated values
   * @param string $implode Optional implode character.  If not provided, the function will return an array of values
   * @param string $separator Optional separator string for the values.  Defaults to comma.
   * @return string|array Formatted values
   */
  public function csv_parser($csv, $implode = FALSE, $separator = ',') {
    
    $csv_array = explode($separator, trim($csv));
    $cleaned = array();
    foreach ($csv_array as $csv_value) {
      $cleaned[] = trim($csv_value);
    }
    if ($implode) {
      $cleaned = implode($implode, $cleaned);
    }
    return $cleaned;
  }
  
  public function db_query($query, $query_only = TRUE, $return_type = 'all', $assoc = TRUE) {
    $db =& MDB2::connect($this->dsn);
    $db_result =& $db->query($query);
    if ($query_only) {
      return TRUE;
    } else {
      switch (trim(strtolower($return_type))) {
        case 'row':
          if ($assoc) {
            return $db_result->fetchRow(MDB2_FETCHMODE_ASSOC);
          } else {
            return $db_result->fetchRow();
          }
          break;
        case 'col':
          return $db_result->fetchCol();
          break;
        case 'all':
        default:
          if ($assoc) {
            return $db_result->fetchAll(MDB2_FETCHMODE_ASSOC);
          } else {
            return $db_result->fetchAll();
          }
          break;
      }
    }
  }
  
  /**
   * Checks $query_value against $ini_value to see a) if its a regex or csv match.
   * It will then return TRUE if it is a match or FALSE if not.
   * 
   * @param string $ini_value INI file value
   * @param string $query_value Value to be matched against $ini_value
   * @return boolean TRUE = match / FALSE = no match
   */
  public function match_ini_value($ini_value, $query_value) {
    if (preg_match('/^\//', $ini_value)) {
      if (preg_match($ini_value, $query_value)) { return TRUE; }
    } else {
      if (in_array($query_value, locum::csv_parser($match_crit))) { return TRUE; }
    }
    return FALSE;
  }
  
  /**
   * Returns a CRC32 value that is compatible with MySQL (>=4.1) CRC32() function
   *
   * @param string $str String to be converted
   * @return int a CRC32 polynomial of the string
   */
  public function string_poly($str) {
    if (crc32($str) < 0) {
      return crc32($str) + 4294967296;
    } else {
      return crc32($str);
    }
  }
  
}