listhierClass.php

<?php
/* apidev/listhierClass.php
  June 2015
 For MW, there may be (for homophones) calls from the basic
 display to alternate lists.
 The Javascript call from disphiermw will use 'lnum' as the
 parameter, rather than 'key'. So, this file looks for that parameter.
 When initially called, the parameter will be 'key'
 ANother approach would be to use just 'key' parameter, but
 interpret key as lnum  when all characters are numbers of period.
*/

require_once('utilities/transcoder.php');
require_once('dal.php');
require_once('dictinfo.php');
require_once('parm.php');
require_once('dbgprint.php');
class ListhierClass {
 public $table,$table1;
 public function __construct() {
  $getParms = new Parm();
  // Get $getParms->lnumin and $getParms->direction
  $getParms -> listhierParms(); 
  $lnumin = $getParms->lnumin;
  $direction = $getParms->direction;

  $dbg=false;
  $dict = $getParms->dict;
  $dal = new Dal($dict);
  $key = $getParms->key;

  // step 1: get initial record.
  if ($lnumin) { // use 'lnum'
   $matches = $dal->get2($lnumin,$lnumin);
   if (count($matches) == 0) { // error condition
    dbgprint($dbg,"<p>listhier problem. lnum=$lnumin</p>\n");
    dbgprint($dbg,"<p>dict=$dict, ('" . $dal->dict . "')</p>\n");
    exit(1);
   }
   list($key1,$lnum1,$data1) = $matches[0];
  }else { // use 'key'
   $matches = $this->match_key($key,$dal);
   list($key1,$lnum1,$data1) = $matches[0];
  }
  
  // step 2:  get several keys preceding and several keys following $key1
  $nprev=12;
  $nnext=12;
  if ($direction == 'UP') {
   $listmatches = $this->list_center($key1,$lnum1,$data1,$nprev+$nnext,0,$dal);
  }else if ($direction == 'DOWN') {
   $listmatches = $this->list_center($key1,$lnum1,$data1,0,$nprev+$nnext,$dal);
  }else {
   $listmatches = $this->list_center($key1,$lnum1,$data1,$nprev,$nnext,$dal);
  }

  // step 3 format listmatches
  $i=0;
  $table="";
  //$spcchar = "&nbsp;";
  $spcchar = ".";
  dbgprint($dbg,"Extra listhier: listmatches = " . count($listmatches) . "\n");
  while($i < count($listmatches)) {
   list($code,$key2,$lnum2,$data2) = $listmatches[$i];
   $hom2=$this->get_hom($data2);
   //dbgprint(true,"listhierClass: lnum2=$lnum2, key2=$key2, data2=\n$data2\n");
   if ($i == 0) {
    //  put 'upward button'
    $spc="&nbsp;&nbsp;";
    $out1 = "$spc<a  onclick='getWordlistUp_keyboard(\"$key2\");'>&#x25B2;</a><br/>\n";  
    $table .= $out1;
   }
   $i++;
   $filter = $getParms->filter;
   if ($filter == "deva") {
    /* use $filterin to generate the class to use for Sanskrit (<s>) text 
      This was previously done in main_webtc.js.
      This let's us use siddhanta font for Devanagari.
    */
    $sdata = "sdata_siddhanta"; // consistent with font.css
    $class = " class='$sdata'";
   } else {
    #$sdata = "sdata"; // default.
    $class ="";
   }
   if ($code == 0) {$c="color:teal";}
   else {$c="color:black";}
   // Apr 7, 2013.  Color Supplement records 
   // Aug 13, 2019. Changed test
   /*
   if (preg_match('/<info n="sup"/',$data2,$matches)) {
    $c = "color:red";
   }
   if (preg_match('/<info n="rev"/',$data2,$matches)) {
    $c = "color:green";
   }
   */
  // 07-07-2024  revsup   . 10-25-2024. Allow both rev AND sup
  $revsup = "";
  $revsups = array();
  if (in_array($getParms->dict,array('mw'))) {
   if (preg_match('|<info n="sup"/>|',$data2,$matches)) {
    $revsups[] = "&nbsp;<span title='supplement' style='font-size:11px; color:red;'>Ⓢ</span>";
   }
   else if (preg_match('|<info n="rev"|',$data2,$matches)) {
    $revsups[] = "&nbsp;<span title='revision' style='font-size:11px; color:red;'>Ⓡ</span>";
   }
   if (preg_match('|<listinfo n="sup"/>|',$data2,$matches)) {
    $revsups[] = "&nbsp;<span title='supplement' style='font-size:11px; color:red;'>Ⓢ</span>";
   }
   else if (preg_match('|<listinfo n="rev"|',$data2,$matches)) {
    $revsups[] = "&nbsp;<span title='revision' style='font-size:11px; color:red;'>Ⓡ</span>";
   }
   if (count($revsups) == 2) {
    # S S -> S, and R R -> R
    if ($revsups[0] == $revsups[1]) {
     $revsups = array($revsups[0]);
    }
   }
   $revsup = join(" ",$revsups);
  }   
   if (preg_match('/^<H([2])/',$data2,$matches)) {
    $spc="$spcchar";
   }else if(preg_match('/^<H([3])/',$data2,$matches)) {
    $spc="$spcchar$spcchar";
   }else if(preg_match('/^<H([4])/',$data2,$matches)) {
    $spc="$spcchar$spcchar$spcchar";
   }else {
    $spc="";
   }
   if ($hom2 != "") {
    $hom2=" <span style=\"color:red; font-size:smaller\">$hom2</span>";
   }
   // Apr 10, 2013. key2show: 
   $key2show=$key2;

   if (!$getParms->english) {
    $key2show ="<SA>$key2show</SA>";
   }
   #$key2show = "<span style='$c'>$key2show</span>";
   $key2show = "<span style='$c' $class>$key2show</span>";
   /* In MWE, we have key2 = cat-o'-nine-tails
    And the apostrophe causes a problem - we need to escape it. 
    However, just escaping doesn't solve the problem.  We removed
    the apostrophe in the 'key1' element in MWE.
   */
   // php 8.1.10 deprecate 'null' for first parameter.
   if ($key2 == null) {
    $key2 = "";
   }
   $key2 = htmlspecialchars($key2,ENT_QUOTES);
   if (preg_match('/<H.[BC]>/',$data2)) { // MW only
    // put key2show in parens
    $key2show = "($key2show)";
   }
   //$out1 = "$spc<a  onclick='getWordAlt_keyboard(\"$key2\");'>$key2show$hom2</a><br/>\n";
   // 07-07-2024
   $out1 = "$spc<a  onclick='getWordAlt_keyboard(\"$key2\");'>$key2show$hom2 $revsup</a><br/>\n";
   $table .= $out1;
   dbgprint($dbg,"Listhier extra: out1=$out1\n");
   if ($i == count($listmatches)) {
    //  put 'downward button'
    $spc="&nbsp;&nbsp;";
    $out1 = "$spc<a  onclick='getWordlistDown_keyboard(\"$key2\");'>&#x25BC;</a>\n";  
    $table .= $out1;
   }

  } // end while loop
  // spit it out
  $filter = $getParms->filter;
  $this->table = $table;
  $table1 = transcoder_processElements($this->table,"slp1",$filter,"SA");
  $this->table1 = $table1;
 }

 public function match_key($key,$dal) {
  // this function 'guaranteed' to return an array with one entry
  $matches = $this->list1a($key,$dal);
  $nmatches = count($matches);
  $dbg=false;
  dbgprint($dbg,"Listhier match_key chk1: $key, $nmatches\n");
  if ($nmatches != 1) {
   $key1 = $key;
   $nmatches=0;
   $n1 = strlen($key1);
   while (($nmatches == 0) && ($n1 > 0)) {
    $key2 = substr($key1,0,$n1);
    $matches = $this->list1b($key2,$dal);
    $nmatches = count($matches);
    if ($nmatches == 0) {$n1--;}
   } 
  }
  if ($nmatches == 0) {
   $key = "a"; // sure to match
   $key1 = $key;
   $nmatches=0;
   $n1 = strlen($key1);
   while (($nmatches == 0) && ($n1 > 0)) {
    $key2 = substr($key,0,$n1);
    $matches = $this->list1b($key2,$dal);
    $nmatches = count($matches);
    if ($nmatches == 0) {$n1--;}
   } 
  }
  dbgprint($dbg,"Listhier match_key chk2: $key, $nmatches\n");
  return $matches;
  }

 public function list1a($key,$dal) {
  // first exact match
  #$recarr = $dal->get1($key);
  $recarr = $dal->get1_mwalt($key);
  $matches=array();
  $nmatches=0;
  $more=true;
  foreach($recarr as $rec) {
   if ($more) {
    list($key1,$lnum1,$data1) = $rec;
    $matches[0]=$rec;
    $more=False;
   }
  }
  return $matches;
 }
 public function list1b($key,$dal) {
  // first  partial match
  $recarr = $dal->get3($key); // records LIKE key%
  $matches=array();
  $nmatches=0;
  $keylen = strlen($key);
  $more=false;
  foreach($recarr as $rec) {
   if ($more) {
    list($key1,$lnum1,$data1) = $rec;
    $keylen1 = strlen($key1);
    if (($keylen1 >= $keylen) && (substr($key1,0,$keylen) == $key)) {
     $matches[$nmatches]=$rec;
     $nmatches++;
     $more=false;
    }
   }
  }
  return $matches;
 }

 public function list_prev($key0,$lnum0,$nprev,$dal) {
  $ans = array();
  $dbg=false;
  if ($nprev <= 0) {return $ans;}
  $max = 5 * $nprev;  // 5 is somewhat arbitrary.
  $recarr = $dal->get4a($lnum0,$max);
  dbgprint($dbg,"Listhier list_prev: $key0,$lnum0, $nprev finds " . count($recarr) . " records</p>\n");
  // 1. get records to be displayed
  $matches = $this->list_filter($lnum0,$recarr,$dal);
  // 2. get the last $nprev records for return
  $nmatches = count($matches);
  if ($nmatches == 0) {return $ans;}
  if ($nprev <= $nmatches) {
   $n1 = $nprev;
  }else {
   $n1 = $nmatches;
  }
  // we retrieved in descending order. Now, we get back to ascending order
  $j=$n1-1;
  for($i=0;$i<$n1;$i++) {
   $x = $matches[$j];
   $ans[]=$x;
   $j--;
  }
  return $ans;
 }
 public function list_next($key0,$lnum0,$n0,$dal) {
  $ans = array();
  if ($n0 <= 0) {return $ans;}
  // next $n0 different keys
  $max = 5 * $n0;  // 5 is somewhat arbitrary.
  $recarr = $dal->get4b($lnum0,$max);
  // 1. get records to be displayed
  $matches = $this->list_filter($lnum0,$recarr,$dal);
  // 2. get the last $nprev records for return
  $nmatches = count($matches);

  if ($nmatches == 0) {return $ans;}
  if ($n0 <= $nmatches) {
   $n1 = $n0;
  }else {
   $n1 = $nmatches;
  }
  for($i=0;$i<$n1;$i++) {
   $x = $matches[$i];
   $ans[]=$x;
  }
  return $ans;
 }
 public function list_filter($lnum0,$recarrin,$dal) {
  // This variant matches on key+hom
  // This logic is relevant for MW, but will need to be changed
  // since '$data1'  is now html, not xml.
  $dict = $dal->dict; // lowercase
  $matches=array(); // returned variable
  if (! in_array($dict, array('mw','md'))) {
   foreach($recarrin as $rec) {
    list($key1,$lnum1,$data1) = $rec;  // $data1 is <info>x</info><body>y</body>
    $rec1 = array($key1,$lnum1,""); // no use for data1, since not mw
    $matches[]=$rec1;
   }
   return $matches;
  }
  // Rest of logic is for mw
  // First readjust 3rd parm of recarrin, 
  $recarr=array();
  foreach($recarrin as $rec) {
   list($key1,$lnum1,$data1) = $rec;  
   // $data1 is <info>x</info><body>y</body>
   $rec1 = $this->construct_rec1($key1,$lnum1,$data1);
   $recarr[]=$rec1;
  }

  $recarr0 = $dal->get2($lnum0,$lnum0); 
  if (count($recarr0) != 1) {return $matches;} // should not happen
  // Apr 6, 2013. Changed $recarr[0] to $recarr0[0] in next.
  list($key0,$lnum0,$data0)=$recarr0[0];  
  $prevrec = $this->construct_rec1($key0,$lnum0,$data0);
  foreach($recarr as $rec) {  
   list($key1,$lnum1,$data1) = $rec;
   if ($lnum1 == $lnum0) { continue;}  // don't repeat
    // Keep all hom records now. June 2015
   if (preg_match('/<hom>/',$data1)) {
    $matches[]=$rec;
    $prevrec=$rec;
    continue;
   }
   // Otherwise, drop HxA
   if (preg_match('/<H[1-4]A>/',$data1)) {continue;} 

   if (!$prevrec) { // this may never happen
    $matches[]=$rec;
    $prevrec=$rec;
    continue;
   }
   // June 2015 -  DO show HBC if the key1 differs from previous record
   // that was kept 
   // so prevrec is available  
   if (preg_match('/<H[1-4][BC]>/',$data1)) {  // debug
    list($key2,$lnum2,$data2) = $prevrec;
    if ($key1 != $key2) {
     $matches[]=$rec;
     $prevrec=$rec;
     dbgprint($dbg,"Listhier (BC)$key2,$lnum2\n");
     continue;
    }else {
     continue;
    }
   }
   // H[1-4] record,
   dbgprint($dbg,"(14)$key1,$lnum1\n");
   $matches[]=$rec;
   $prevrec=$rec;
  }
  return $matches;
 }

 public function unused_get_keyhom($key,$data){
  $hom = $this->get_hom($data);
  return "$key+$hom";
 }

 public function get_hom($data) {
  $hom="";
  if (preg_match('|<hom>(.*?)</hom>.*?</h>|',$data,$matches)) {
   $hom = $matches[1];
  }
  return $hom;
 }

 public function list_center($key1,$lnum1,$data1,$nprev,$nnext,$dal) {
  $listmatches = array();
  $matches1 = $this->list_prev($key1,$lnum1,$nprev,$dal);
  $matches2 = $this->list_next($key1,$lnum1,$nnext,$dal);
  $nmatches1 = count($matches1);
  $nmatches2 = count($matches2);
  // handle special cases
  $i=0;
  while($i < $nmatches1) {
   list($key2,$lnum2,$data2) = $matches1[$i];
   $listmatches[]=array(-1,$key2,$lnum2,$data2);
   $i++;
  }
  // The center value
  /* 11-07-2024. Change for consistency with webtc1/listhiermodel.php */
  //x list($key2,$lnum2,$data2) = $this->construct_rec1($key1,$lnum1,$data1);
  //x $listmatches[]=array(0,$key2,$lnum2,$data2);
  $listmatches[]=array(0,$key1,$lnum1,$data1); //xnew
  $i=0;
  while($i < $nmatches2) {
   list($key2,$lnum2,$data2) = $matches2[$i];
   $listmatches[]=array(1,$key2,$lnum2,$data2);
   $i++;
  }
  $dbg = false;
  if ($dbg) {
   dbgprint($dbg,"\nkey1=$key1, lnum1=$lnum1, nprev=$nprev, nnext=$nnext\n");
   $i = 0;
   $n = count($listmatches);
   while($i < $n) {
    list($dir,$key,$lnum,$data) = $listmatches[$i];
    dbgprint($dbg,"lsthiermodel: i=$i, dir=$dir, key=$key, lnum=$lnum\n");
    $i = $i + 1;
   }
  }

  return $listmatches;
 }

 public function construct_rec1($key1,$lnum1,$data1){
  // assume this is for mw. 07-15-2018
  // php 8.1.10 deprecates null as 2nd arg to preg_match
  //dbgprint(true,"\nenter construct_rec1: key1=$key1, lnum1=$lnum1, data1=\n$data1\n");
  if ($data1 == null) {
   $data1 = "";
  }
  if (!preg_match('|<info>(.*?)</info><body>(.*?)</body>|',$data1,$matchrec))   {
   $data2 = $data1;
   $rec1 = array($key1,$lnum1,$data2);
   //dbgprint(true,"leave 1: construct_rec1: key1=$key1, lnum1=$lnum1, data2=\n$data2\n");
   return $rec1;
  }

  $info = $matchrec[1];
  $html = $matchrec[2];
  list($pginfo,$hcode,$key2,$hom) = preg_split('/:/',$info);
  // Mimic part of the MW structure
  $out=array();
  $out[] = "<$hcode>";
  if (($hom)&&($hom!='')){
   $out[] = "<h><hom>$hom</hom></h>";
  }
  // June 17, 2015.  We don't directly have information that a
  // this record is part of the additions/corrections.  That is 
  // properly done via '/<L supL=/' of the xml.  However,
  // we should be able to mimic this factoid as follows:
  $supplementFlag=false;
  if (preg_match('/^([0-9]+)/',$pginfo,$matchwork)) {
   $ipage = intval($matchwork[1]);
   if ($ipage>=1308) { // pages 1308++ are supplement
    if(substr($key1,0,1) != 'h') { // if key1 starts with h, not suppl
     $supplementFlag = true;
    }
   }
  }
  if ($supplementFlag) {
   $out[] = ' <L supL="">'; // so test at about line 76 will show positive
  }

  $data2 = join('',$out); 
  $rec1 = array($key1,$lnum1,$data2);
  dbgprint(true,"leave 2: construct_rec1: key1=$key1, lnum1=$lnum1, data2=\n$data2\n");
  return $rec1;
 }
}
?>