<?php

/**
 * <--- Copyright 2005-2011 de Solis - Cooperativa de Soluções Livres Ltda. e
 * Univates - Centro Universitário.
 * 
 * Este arquivo é parte do programa Gnuteca.
 * 
 * O Gnuteca é um software livre; você pode redistribuí-lo e/ou modificá-lo
 * dentro dos termos da Licença Pública Geral GNU como publicada pela Fundação
 * do Software Livre (FSF); na versão 2 da Licença.
 * 
 * Este programa é distribuído na esperança que possa ser útil, mas SEM
 * NENHUMA GARANTIA; sem uma garantia implícita de ADEQUAÇÃO a qualquer MERCADO
 * ou APLICAÇÃO EM PARTICULAR. Veja a Licença Pública Geral GNU/GPL em
 * português para maiores detalhes.
 * 
 * Você deve ter recebido uma cópia da Licença Pública Geral GNU, sob o título
 * "LICENCA.txt", junto com este programa, se não, acesse o Portal do Software
 * Público Brasileiro no endereço www.softwarepublico.gov.br ou escreva para a
 * Fundação do Software Livre (FSF) Inc., 51 Franklin St, Fifth Floor, Boston,
 * MA 02110-1301, USA --->
 * 
 * Class
 *
 * @author Jader Osvino Fiegenbaum [jader@solis.com.br]
 *
 * @version $Id$
 *
 * \b Maintainers: \n
 * Jader Osvino Fiegenbaum [jader@solis.com.br]
 *
 * @since
 * Class created on 11/01/2017
 *
 **/

$MIOLO->uses('classes/decs/DecsParse.class.php', 'gnuteca3');

class DecsResponse
{    
    // Resposta em array,
    public $xmlArray;
    
    // Define a linguagem.
    public $language;
    
    // Define se é qualificador.
    public $isQualifier = false; 
    
    // Número da categoria.
    public $category; 
    
    // Termo principal/Assunto.
    public $term; 
    
    // Número do registro.
    public $mfn; 
    
    // Identificador único.
    public $uniqueIdentifier; 

    // Categorias.
    public $categories = array(); 
    
    // Descritores.
    public $descriptors = array();
    
    // Sinônimos. 
    public $synonym = array(); 
    
    // Definição.
    public $definition; 
    
    // Nota de indexação.
    public $noteIndexing; 
    
    // Relacionados.
    public $related = array(); 
    
    // Qualificadores.
    public $qualifiers = array(); 
    
    // Árvore de termos.
    public $tree = array();
    
    /**
     * Método construtor.
     *
     * @param array xmlArray Vetor com os dados de resposta Decs.
     * @param boolean $onlyTerm Sinaliza que somente o termo deve ser processado.
     */
    public function __construct(array $xmlArray, $onlyTerm=FALSE, $language='pt')
    {
        $this->xmlArray = $xmlArray;
        
        $this->language = $language;
        
        // Processa o XML.
        $this->parse($onlyTerm);
    }
     
    /**
     * Processa o XML.
     *
     * @param boolean $onlyTerm Sinaliza que somente o termo deve ser processado.
     */ 
    private function parse($onlyTerm)
    {
        $tree = $this->xmlArray['tree'];
        
        // Obtém categoria e termo.
        $this->parseTerm($tree);
        
        // Obtém o restante dos dados.
        if ( !$onlyTerm )
        {
            $this->parseBody();
            $this->parseTree($tree);
        }
    }
    
    /**
     * Obtém o termo e a categoria principal.
     * 
     * @param $tree array com a árvore de categorias/termos.
     */
    private function parseTerm($tree)
    {
        $this->category = $tree['self']['term_list']['term']['@attributes']['tree_id'];
        $this->term =  $tree['self']['term_list']['term']['@content'];
        
        // Se termo começa com '/', ele é um qualificador.
        if ( substr($this->term, 0, 1) === '/' )
        {
            $this->isQualifier = true;
        }
    }
    
    /**
     * Obtém a árvore de termos.
     * @param $tree array com a árvore de categorias/termos.
     */
    private function parseTree($tree)
    {
        $leafs = array();

        //Prepara folhas.
        // Concatena temos que precedem.
        $precedings = $tree['preceding_sibling']['term_list']['term'];

        if ( current(array_keys($precedings)) === 0 )
        {
            foreach ( $precedings as $preceding )
            {
                if ( strlen($preceding) > 0 )
                {
                    $leafs[$preceding['@attributes']['tree_id']] = $preceding['@content'];
                }
            }
        }
        else
        {
            if ( strlen($precedings['@content']) > 0 )
            {
                $leafs[$precedings['@attributes']['tree_id']] = $precedings['@content'];
            }
        }

        // Concatena termo principal.
        $leafs[$this->category] = $this->term;

        // Concatena os termos que procedem.
        $followings = $tree['following_sibling']['term_list']['term'];

        if ( current(array_keys($followings)) === 0 )
        {
            foreach ( $followings as $following )
            {
                if( strlen($following['@content']) > 0)
                {
                    $leafs[$following['@attributes']['tree_id']] = $following['@content'];
                }
            }
        }
        else
        {
            if ( strlen($followings['@content']) > 0 )
            {
                $leafs[$followings['@attributes']['tree_id']] = $followings['@content'];
            }
        }
        
        $result = array();

        // Prepara estrutura da árvore.
        $completeTree = array();

        $keyParts = array();
        $keyParts[] = substr($this->category, 0, 1);
        $keyParts = array_merge($keyParts, explode('.', $this->category));

        $keyTree = '';

        foreach ( $keyParts as $i => $keyPart )
        {
            if ( $i <= 1 )
            {
                $keyTree = $keyPart;
            }
            else
            {
                $keyTree .= '.' . $keyPart;
            }

            foreach ( $tree['ancestors']['term_list']['term'] as $ancestor )
            {
                $key = $ancestor['@attributes']['tree_id'];

                if ( strlen($key) == 0 )
                {
                    continue;
                }

                if ( $keyTree == $key )
                {
                    $completeTree[$key] = $ancestor['@content'];
                }
            }
        }
            
        // Contatena folhas.
        $completeTree += $leafs;
        
        $this->tree = $completeTree;
    }
    
    /**
     * Obtém demais informações.
     */
    private function parseBody()
    {
        // Obtém o MFN.
        $this->mfn = @$this->xmlArray['record_list']['record']['@attributes']['mfn'];
        
        // Obtém identificador único.
        $this->uniqueIdentifier = @$this->xmlArray['record_list']['record']['unique_identifier_nlm'];

        // Obtém descritores.
        $descriptors = @$this->xmlArray['record_list']['record']['descriptor_list']['descriptor'];
        
        foreach ( $descriptors as $descriptor )
        {
            $this->descriptors[$descriptor['@attributes']['lang']] = @$descriptor['@content'];
        }
        
        // Obtém os sinônimos.
        $this->synonym = @$this->xmlArray['record_list']['record']['synonym_list']['synonym'];
        
        // Obtém todas as categorias.
        $categories = $this->xmlArray['record_list']['record']['tree_id_list']['tree_id'];
        
        if ( is_array($categories) )
        {
            $this->categories = $categories;
        }
        else
        {
           $this->categories = array($categories);
        }
        
        // Obtém definição.
        $this->definition = @$this->xmlArray['record_list']['record']['definition']['occ']['@attributes']['n'];
        
        // Obtém nota de indexação.
        $this->noteIndexing = @$this->xmlArray['record_list']['record']['indexing_annotation'];
        
        // Obtém relacionados.
        $related = @$this->xmlArray['record_list']['record']['see_related_list']['see_related'];
        
        if ( isset($related) )
        {
            // Mais de um relacionado.
            if ( current(array_keys($related)) === 0 )
            {
                foreach ( $related as $relat )
                {
                    $this->related[] = $relat['@content'];
                }
            }
            else
            {
               $this->related[] = $related['@content'];
            }
        }
        
        //Obtém qualificadores.
        $this->parseQualifiers();
    }
    
    /**
     * Obtém os qualificadores e suas respectivas descrições.
     */
    public function parseQualifiers()
    {
        $MIOLO = MIOLO::getInstance();
        $busDomain = $MIOLO->getBusiness('gnuteca3', 'BusDomain');
        
        $descriptionQualif = $busDomain->listDomain('OAI-PMH-QUALIFIER');
        $qualifierArray = array();
        
        if ( is_array($descriptionQualif) )
        {
            foreach ( $descriptionQualif as $qualifierLine )
            {
                $qualifierArray[$qualifierLine[0]] = $qualifierLine;
            }
        }
        
        $countQualifiers = is_array($descriptionQualif) ? count($descriptionQualif) : 0;
        
        // Obtém qualificadores.
        $qualifiers = @$this->xmlArray['record_list']['record']['allowable_qualifier_list']['allowable_qualifier'];
        
        foreach ( $qualifiers as $qualifier )
        {
            if ( !isset($qualifier['@content']) )
            {
                continue;
            }
                
            $qualifier = $qualifier['@content'];
            
            $qualifierWithLanguage = $this->language . '_' . $qualifier;
            
            if ( !array_key_exists($qualifierWithLanguage, $qualifierArray) )
            {
                // Busca descrição do qualificador via WebService.
                $xmlResponseQualifier = file_get_contents(DECS_URL_SEARCH . 'words=' .  $qualifier . '&lang=' . $this->language);
                
                if ( strlen($xmlResponseQualifier) > 0 )
                {
                    $responseQualifier = new DecsParse($xmlResponseQualifier, true);

                    $qualifierObj = $responseQualifier->getQualifier();

                    if ( is_object($qualifierObj) )
                    {
                        // Insert qualifier.
                        $qualifierObj->domainId = 'OAI-PMH-QUALIFIER';
                        $qualifierObj->sequence = ++$countQualifiers;

                        $qualifierObj->key = $qualifierWithLanguage;

                        $busDomain = $MIOLO->getBusiness('gnuteca3', 'BusDomain');

                        $busDomain->setData($qualifierObj);

                        $busDomain->insertDomain();

                        $this->qualifiers[$qualifier] = array('abbreviated' => $qualifierObj->abbreviated, 'label' => $qualifierObj->label);
                    }
                }
                else
                {
                    $this->qualifiers[$qualifier] = array('abbreviated' => '', 'label' => _M('Descrição não encontrada'));
                }
              
            }
            else
            {
                $this->qualifiers[$qualifier] = array('abbreviated' => $qualifierArray[$qualifierWithLanguage][2], 'label' => $qualifierArray[$qualifierWithLanguage][1]); //'oloco'; //$descriptionQualif[$qualifierWithLanguage];
            }
           
        }
    }
}