scripture.module

<?php

module_load_include('inc','scripture','scripture.field');
module_load_include('inc','scripture','scripture.db');
module_load_include('inc','scripture','scripture.element');


/**
 * General function used during the installation of various translations
 */

function scripture_readandmysqlexecute($myfile) {
	$sql = file($myfile, true);
	$templine = '';
	
	foreach ($sql as $line) {
		if (substr($line, 0, 2) == '--' || $line == '')
			continue;
		$templine .= $line;
		if (substr(trim($line), -1, 1) == ';') {
			db_query($templine);
			$templine = '';
		}
	}	
}


/**
 * Implements hook_permission().
 */
function scripture_permission() {
  $permissions = array();
  
  $permissions['scripture_admin'] = array(
    'title' => t('Scripture admin'),
    'description' => t('Administer the Scripture module'),
    'restrict access' => TRUE,
  );

  $permissions['scripture_node_listing'] = array(
    'title' => t('View scripture node listings'),
    'description' => t('Access pages like scripture/* which lists all nodes associated with the specified scripture ranges.'),
  );
   
  return $permissions;
}

/**
 * Implements hook_menu().
 * https://api.drupal.org/api/drupal/modules%21system%21system.api.php/function/hook_menu/7
 */
function scripture_menu() {
  $items = array();
  
  $items['admin/structure/scripture'] = array(
    'title'            => 'Scripture',
    'type'             => MENU_NORMAL_ITEM,
    'description'      => 'Manage the Scripture module',
    'page callback'    => 'scripture_callback_status',
    'access callback'  => 'user_access',
    'access arguments' => array('scripture_admin'),
    'file'             => 'scripture.admin.inc',
  );
  
  $items['admin/structure/scripture/status'] = array(
    'title'         => 'Status',
    'description'   => 'View status and statistics',
    'type'          => MENU_DEFAULT_LOCAL_TASK,
    'weight'        => 10,
    'page callback' => 'scripture_callback_status',
    'access callback'  => 'user_access',
    'access arguments' => array('scripture_admin'),
    'file'          => 'scripture.admin.inc',
  );
  
  $items['admin/structure/scripture/translations'] = array(
    'title'            => 'Translations',
    'description'      => 'Manage installed translations',
    'type'             => MENU_LOCAL_TASK,
    'weight'           => 20,
    'page callback'    => 'drupal_get_form',
    'page arguments'   => array('scripture_callback_translations'),
    'access callback'  => 'user_access',
    'access arguments' => array('scripture_admin'),
    'file'             => 'scripture.admin.inc',
  );

  $items['admin/structure/scripture/queries'] = array(
    'title'            => 'Queries',
    'description'      => 'Configure query settings',
    'type'             => MENU_LOCAL_TASK,
    'weight'           => 20,
    'page callback'    => 'drupal_get_form',
    'page arguments'   => array('scripture_callback_queries'),
    'access callback'  => 'user_access',
    'access arguments' => array('scripture_admin'),
    'file'             => 'scripture.admin.inc',
  );
  
  $items['scripture/%'] = array(
    'title'            => 'Content by scripture',
    'page callback'    => 'scripture_callback_node_listing',
    'page arguments'   => array(1),
    'access callback'  => 'user_access',
    'access arguments' => array('scripture_node_listing'),
    'file'             => 'scripture.pages.inc',
  );
  
  return $items;
}

/**
 * Implements hook_element_info().
 * https://api.drupal.org/api/drupal/modules%21system%21system.api.php/function/hook_element_info/7
 * Declare a FORM API element for the verse picker
 */
function scripture_element_info() {
  return array(
    'scripture_verse_picker' => array(
      '#input'            => TRUE,
      '#process'          => array('scripture_verse_picker_process'),
      '#element_validate' => array('scripture_verse_picker_validate'),
      '#theme'            => array('scripture_verse_picker'),
      '#theme_wrappers'   => array('form_element'),
      '#tree'             => TRUE,
    ),
  );
}

/**
 * Implements hook_theme($existing, $type, $theme, $path).
 * https://api.drupal.org/api/drupal/modules%21system%21system.api.php/function/hook_theme/7
 * Registers the module's theme implementations
 */
function scripture_theme($existing, $type, $theme, $path) {
  return array(
    'scripture_verse_picker' => array(
      'render element' => 'element',
    ),
    'scripture_inline_wrapper' => array(
      'render element' => 'element',
    ),
  );
}

/**
 * Update preview for verse(s) via AJAX
 */
function scripture_ajax_preview_verse($form, $form_state) {
  return 'MOO';
}

/**
 * Load pieces of scripture from database
 */
function scripture_prepare(&$values, $display) {

  if (SCRIPTURE_SHOW_TEXT_TRUNC == $display['show_text'] || $display['show_ref']) {
    // load first and last verse text in range
    $values['from_verse'] = scripture_get_verse($values['from_vid'], $values['translation']);
    $values['to_verse'] = scripture_get_verse($values['to_vid'], $values['translation']);
  }
  
  if (SCRIPTURE_SHOW_TEXT_ALL == $display['show_text']) {
    // load entire verse range
    $values['all_verses'] = scripture_get_verses_between($values['from_vid'], $values['to_vid'], $values['translation']);
  }
  
}

/**
 * View pieces of scripture from database
 */
function scripture_view($values, $display) {
  $output = array();

  if (empty($values['from_verse'])) {

    drupal_set_message("Cannot view verses, as they were not properly loaded.", "error", FALSE);

  } else {

    if ($display['show_ref']) {
      $output['ref'] = array(
        '#prefix' => '<cite>',
        '#markup' => scripture_str_verseref($values['from_verse'], $values['to_verse'], NULL, $values['translation']),
        '#suffix' => '</cite>'
      );
    }

    switch ($display['show_text']) {
      case SCRIPTURE_SHOW_TEXT_TRUNC:
        $markup = scripture_shorten($values['from_verse']['versetext'], $values['to_verse']['versetext']);
        $output['text'] = array(
          '#prefix' => '<q>',
          '#markup' => $markup,
          '#suffix' => '</q>'
        );
        break;
      case SCRIPTURE_SHOW_TEXT_ALL:

        // pull all of the verses into one long string
        $alltext = "";
        foreach ($values['all_verses'] as $v) {
          $alltext .= $v->versetext . " ";
        }

        $output['text'] = array(
          '#prefix' => '<blockquote>',
          '#markup' => substr($alltext, 0, - 1),
          '#suffix' => '</blockquote>'
        );

        break;
    }

  }

  return $output;
  
}

/**
 * Generate a human-readable verse range
 */
function scripture_str_verseref($from_verse, $to_verse, $bookname = NULL, $translation_abbr = NULL) {
  
  if (empty($bookname)) {
    $book = scripture_get_book($from_verse);
    $bookname = $book['bookname'];
  }

  if ($from_verse['vid'] == $to_verse['vid']) {
    $str = "{$bookname} {$from_verse['chapternum']}:{$from_verse['versenum']}";
  } else {
    $str = "{$bookname} {$from_verse['chapternum']}:{$from_verse['versenum']} - {$to_verse['chapternum']}:{$to_verse['versenum']}";
  }
  
  if (!empty($translation_abbr)) {
    $translation = scripture_get_translation($translation_abbr);
    $str .= " (<abbr title='{$translation['name']}'>".strtoupper($translation['abbr'])."</abbr>)";
  }
  
  return $str;

}

/**
 * Takes the first few words from string $a and the last few words from string $b and concatenates them with an ellips
 */
function scripture_shorten($a, $b = "", $maxwords = 5) {

  $a = explode(" ", $a, $maxwords + 1);
  unset($a[$maxwords]);
  $a = implode(" ", $a) . " &#8230;";

  if (! empty($b)) {
    $b = explode(" ", $b);
    $b = array_slice($b, - $maxwords);
    $b = " " . implode(" ", $b);
  }

  return $a . $b;

}

/**
 * Convenience function for previewing verses
 * TODO: get a better name for this function??
 */
function scripture_preview($values, $display = array()) {
  $display += array(
    'show_ref'=>TRUE,
    'show_text'=>SCRIPTURE_SHOW_TEXT_ALL,
  );
  scripture_prepare($values,$display);
  return scripture_view($values,$display);
}


/**
 * Provide a measure of quality of match, given the verse range for a node and the verse range for a query
 */
function scripture_match_quality($field_start_vid, $field_end_vid, $query_start_vid, $query_end_vid) {

  static $weight_q;
  static $weight_e;

  if (!isset($weight_q)) {
    $weight_q = variable_get("scripture_match_quality_weight_query", 1);
    $weight_e = variable_get("scripture_match_quality_weight_entity", 1);
  }

  // FIXME: using the verse ids is crude, because they are not gauranteed to be equally spaced. Although in general, they are.

  $overlap_size = max(0, min($field_end_vid, $query_end_vid) - max($field_start_vid - $query_start_vid));
  $query_match_quality = $overlap_size / ($query_end_vid - $query_start_vid);
  $entity_match_quality = $overlap_size / ($field_end_vid - $field_start_vid);

  return $weight_q * $query_match_quality + $weight_e * $entity_match_quality;

}


/**
 * Decode a verse range represented as a string into a
 * - starting vid
 * - stopping vid
 */
function scripture_decode_range($str) {

  $from_vid = NULL;
  $to_vid = NULL;

  $matches = array();
  if (preg_match('/^(\d+)(-(\d+))?$/', $str, $matches)) {
    // looks valid, i.e. either 1234 or 1234-5678

    if (!empty($matches[1])) {

      // starting verse is specified
      $from_vid = $matches[1];

      if (!empty($matches[3])) {
        // ending verse is specified
        $to_vid = $matches[3];
      } else {

        // use the starting verse for the ending verse
        $to_vid = $from_vid;

      }

    } // else invalid starting verse

  } // else it didn't match the regular expression

  return array(
    'from_vid' => $from_vid,
    'to_vid'   => $to_vid,
  );

}


function scripture_vidrange2text($startvid, $endvid, $translation = NULL) {

	# use the default translation if not explicitly defined
	if (empty($translation)) $translation = variable_get('scripture_default_translation', NULL);
	
	$sql = "SELECT chapternum, versenum, bookname
			FROM lw_verses
			INNER JOIN lw_books using (booknum, translation)
			WHERE translation=:trans AND vid in (:vid1, :vid2)
			ORDER BY vid";
	$rst = db_query($sql, array(':trans' => $translation, ':vid1' => $startvid, ':vid2' => $endvid));

	$een = $rst->fetchObject();
	$twee = $rst->fetchObject();
	
	$out = "{$een->bookname} {$een->chapternum}:{$een->versenum}";
	if ($startvid != $endvid) {
		if ($een->chapternum==$twee->chapternum){
			$out .= "-{$twee->versenum}";
		} else {
			$out .= "-{$twee->chapternum}:{$twee->versenum}";
		} 			
	}

	return $out;
}