Se il file è molto grande è possibile che venga generato l’errore

PHP Fatal error: Allowed memory size of 134217728 bytes exhausted (tried to allocate 48745161 bytes) in C:\vufind-3.1.2\vendor\zendframework\zendframework\libr
ary\Zend\Http\Client\Adapter\Socket.php on line 370

Questo errore si verifica che abbiamo esaurito la memoria dedicata ai processi php.

Per risolvere il problema occorre accedere al file php.ini ed estendere la proprietà incrementandola ulteriormente.

memory_limit=256M

Esempio di file scenario.txt che simula una ricerca libera

scenario
{
	warmup = 1;
	duration = 120;
	cooldown = 20;
	transaction
	{
		id = "onesearch";
		weight = 1000;
		request
		{
			url = "/vufind/Search/Results?lookfor=" + rand("1", "1000000");
			secure = false;
		}
	}
}

E’ possibile aggiungere altre transazioni per simulare altre ricerche.

Esempio di file settings.txt che simula 30 utenti

settings
{
	virtualclients = 30;
}

A questo punto potete aprire 2 shell cmd per avviare il testing e ipotizzando che il nostro vufind giri sul nostro localhost scriveremo

wcctl -s localhost -t scenario.txt -f settings.txt -c 1

wcclient localhost

A questo punto il client incomincia ad avviare un utente dopo l’altro e a simulare le chiamate configurate. A fine esecuzione sarà possibile consultare il report che indicherà quante richieste sono state effettuate e quante di esse hanno avuto esito positivo. A questo punto per aumentare le prestazioni, se i tempi di risposta non sono soddisfacenti, occorre agire sulla RAM del solr, sul numero di CORE e il tipo di Garbage Collection del nostro server. A questo punto ci viene in soccorso la doc ufficiale di vufind che riporta questo schema di prestazioni per un indice da 8,8 milioni di record:

Il report evidenzia la differenza di prestazione tra le ricerche nuove e le ricerche mantenute in cache.

• estensione del record driver
• estensione del tema relativo

Il record driver è la classe php responsabile di recuperare il dato esposta da Solr. Nella configurazione standard occorre aggiungere i metodi di get alla classe SolrDefault, tale operazione è sufficiente se il campo è già disponibile in Solr, altrimenti deve essere aggiunto modificando lo schema opportunamente, come illustrato in un articolo precedente.

Ipotizzando di gestire un campo di nome abstract modificheremo la classe SolrDefault aggiungendo il metodo

public function getAbstract()
{
return isset($this->fields['abstract']) ?
$this->fields['abstract'] : '';
}

A questo punto il metodo è invocabile nel tema, quindi modifichiamo il file core.phtml aggiungendo l’invocazione del metodo

<? $abstract = $this->driver->getAbstract(); ?>
<tr valign="top">
<th><?=$this->transEsc('abstract')?>: </th>
<td property="abstract"><?=$this->escapeHtml($abstract)?></td>
</tr>

E’ possibile modificare la presentazione aggiungendo anche un tab nella sezione a scheda. Per fare questo occorre agire sul file di configurazione del modulo VUFIND nella sezione recorddriver_tabs e definire un nuovo tab

'VuFind\RecordDriver\SolrDefault' => array(
'tabs' => array (
'Holdings' => 'HoldingsILS2', 'Description' => 'Description2',
'TOC' => 'TOC2', 'UserComments' => 'UserComments2',
'Reviews' => 'Reviews2', 'Excerpt' => 'Excerpt2',
'HierarchyTree' => 'HierarchyTree2', 'Map' => 'Map2',
'Details' => 'StaffViewArray2', 
'altreInfo' => 'AltreInfo', 
),
'defaultTab' => null,
),

LA configurazione si conclude con la creazione di un controller in RecordTab del modulo VuFind e la vista altreInfo.phtml relativa nel tema configurato.

Se abbiamo operato bene otterremo questo effetto

Il modulo ha una struttura ben definita, è una directory all’interno della cartella module e presenta la seguente alberatura

config
src
Module.php

Il file Module.pho definisce il modulo e ha un contenuto di questo

<?php
namespace VuFindNews;
use Zend\ModuleManager\ModuleManager,
Zend\Mvc\MvcEvent;

class Module
{
public function getConfig()
{
return include __DIR__ . '/config/module.config.php';
}

public function getAutoloaderConfig()
{
return array(
'Zend\Loader\StandardAutoloader' => array(
'namespaces' => array(
__NAMESPACE__ => __DIR__ . '/src/' . __NAMESPACE__,
),
),
);
}

public function init(ModuleManager $m)
{
}

public function onBootstrap(MvcEvent $e)
{
}
}

Come si può notare il modulo recupera la configurazione dal file module.config.php presente nella directory config. Definiamo nel file il nostro controller tramite la sintassi:

<?php
namespace VuFindNews\Module\Configuration;
$config = array(
'controllers' => array(
'invokables' => array(
'vufindnews' => 'VuFindNews\Controller\VuFindNewsController',),),);
return $config;

A questo punto implementiamo il controller  e la relativa action

<?php
namespace VuFindNews\Controller;
class VuFindNewsController extends \VuFind\Controller\AbstractBase
{
public function testAction()
{
$view = $this->createViewModel();
return $view;
}
public function homeAction()
{
$view = $this->createViewModel();
return $view;
}
}

e la view relativa ad ogni action all’interno del nostro tema nel percorso

\vufind\themes\<nomeTema>\templates\<nomeModulo>

nel nostro caso definiamo i file test.phtml e home.phtml

Non resta che dichiarare il modulo nel file application.config.ini

<?php
$config = array(
'modules' => array(
'VuFindHttp', 'VuFindTheme', 'VuFindSearch', 'VuFind', 'VuFindAdmin', 'VuFindNews'),

A questo punto è possibile verificare la correttezza delle operazioni chiamando l’url

http://localhost/site1/VuFindNews/test

Infine possiamo definire il nostro modulo come la homepage agendo sul file config.ini agendo sul parametro

; The base VuFind URL will load the "Home" action of this module unless the user
; is logged in:
defaultModule = VuFindNews

In tal modo invocando la home VUFIND chiamerà la action home del modulo scelto

Occorre creare la classe all’interno del package di VUFIND

module/VuFind/src/VuFind/controller

I controller sono classi php che estendono la classe “AbstractBase”, i cui metodi con suffisso Action individuano le action esposta dal controller.

Consideriamo la classe TestController.php contenente il seguente codice:

<?php
namespace VuFind\Controller;
class TestController extends AbstractBase
{
    public function testAction()
    {
         $view =  $this->createViewModel();
         return $view;
    }
}

Tale controller va configurato nel file di configurazione centrale del modulo VUFIND disponibile al path

module/VuFind/config/ module.config.php.

Tale configurazione prevede la definizione di un alias nela sezione invokables del file

'invokables' => array(
'test' => 'VuFind\Controller\TestController',

e la definizione della “Route”, che individua la action da invocare agendo sulla sezione delle rotte statiche

$staticRoutes = array(
                  'test/test',

Il metodo testAction prevede la presenza di una view che si chiami come la action, nel nostro caso test.phtml, presente all’interno del nostro tema all’interno di una directory pari al nome del controller

“themes/<tema>/templates/test/test.phtml”

Il cui contenuto è

<?
    echo 'TEST';
?>

E’ possibile verificare la correttezza di quanto fatto invocando l’url

http://localhost/vufind/test/test

Cosa è una tema ? Un tema è l’insieme dei template e dei css responsabili dell’aspetto grafico di una istanza. Si presentano come directory sotto la cartella themes della directory di installazione di VUFIND.

Ogni tema ha una struttura dati prestabilita, presenta la seguente struttura dati:

• una cartella css contenente tutti i file css usati
• una cartella images contenente tutti le immagini usate
• una cartella js contenente tutti i file javascript necesessari
• una cartella templates contenente tutti i file php template responsabili della renderizzazione delle pagine
• un file theme.config.php che gestisce la configurazione del tema

VUFIND mette a disposizione alcuni temi già configurati e mette a disposizione un meccanismo di ereditarietà che ci permette di creare agevolmente nuovi temi con il minimo sforzo.

Nell’articolo precedente abbiamo creato due istanze VUFIND, site1 e site2, entrambi che utilizzano lo stesso tema.

Creiamo un nuovo tema site1 da agganciare alla prima istanza. Per far ciò è sufficiente creare una cartella site1 all’interno della cartella themes contenente solo il file di configurazione theme.config.php. Tale file va modificato per indicare il tema da cui ereditare le caratteristiche, nell’esempio che segue sto ereditando da blueprint.

<?php
return array(
'extends' => 'blueprint',
'css' => array(

e modifichiamo il file config.ini dell’istanza site1 per agganciare il nuovo tema tramite il comando

;theme = bootprint
theme = site1

Lanciando la prima istanza non noteremo differenze, questo perchè il tema site1 eredita blueprint.

Adesso introduciamo delle modifiche all’aspetto grafico. Creiamo all’interno del nostro tema la cartella css e la cartella images dove inserire il file style.css e il nuovo logo. All’interno del file css modifichiamo il tipo searchHomeForm in questo modo

.searchHomeForm {
background-color: #bbb;
padding:2em;
text-align:left;
margin-top:.5em;
font-size: 12pt;
border-radius: 5px 5px 5px 5px;
-moz-border-radius: 5px 5px 5px 5px;
-webkit-border-radius: 5px 5px 5px 5px;
border: 2px solid #C6D880;
color: #264409;
}

e aggiungiamo il nuovo logo, ottenendo questo effetto

A questo punto possiamo modificare il template grafico, in particolare modifichiamo il footer per rimuovere una sezione. Per fare questo creiamo la cartella templates all’interno del nostro tema e copiamo il file footer.phtml dal tema blueprint. Modifichiamo il file rimuovendo una parte del footer

<div class="span-5"><p><strong><?=$this->transEsc('Search Options')?></strong></p>
<ul>
<li><a href="<?=$this->url('search-history')?>"><?=$this->transEsc('Search History')?></a></li>
<li><a href="<?=$this->url('search-advanced')?>"><?=$this->transEsc('Advanced Search')?></a></li>
</ul>
</div>
<div class="span-5"><p><strong><?=$this->transEsc('Find More')?></strong></p>
<ul>
<li><a href="<?=$this->url('browse-home')?>"><?=$this->transEsc('Browse the Catalog')?></a></li>
<li><a href="<?=$this->url('alphabrowse-home')?>"><?=$this->transEsc('Browse Alphabetically')?></a></li>
<li><a href="<?=$this->url('search-reserves')?>"><?=$this->transEsc('Course Reserves')?></a></li>
<li><a href="<?=$this->url('search-newitem')?>"><?=$this->transEsc('New Items')?></a></li>
</ul>
</div>
<!--
<div class="span-5 last"><p><strong><?=$this->transEsc('Need Help?')?></strong></p>
<ul>
<li><a href="<?=$this->url('help-home', array(), array('query' => array('topic' => 'search')))?>" class="searchHelp"><?=$this->transEsc('Search Tips')?></a></li>
<li><a href="#"><?=$this->transEsc('Ask a Librarian')?></a></li>
<li><a href="#"><?=$this->transEsc('FAQs')?></a></li>
</ul>
</div>
-->
<div class="clear"></div>

 e ottenendo l’effetto grafico seguente

Analizziamo il caso più semplice: la creazione di più istanze con database e Solr condivisi.

Per creare più istanze occorre utilizzare il comando

cd $VUFIND_HOME
php install.php --multisite

Ipotizziamo di creare due istanze, site1 e site2, scegliendo l’opzione Directory-Based.

A fine processo includiamo i due file di configurazione

Include c:/vufind/site1/httpd-vufind.conf
Include c:/vufind/site2/httpd-vufind.conf

Se ci limitassimo a fare questo soltanto il secondo sito sarebbe correttamente funzionante, perchè la definizione dell’alias all’interno del file crea un comportamento anomalo sul primo sito.

Per risolvere questa anomalia è sufficiente creare un link simbolico alla cartella public tramite il comando

mklink /D "c:\vufind\site1link" "C:\vufind\public"

e modificare il file c:/vufind/site1/httpd-vufind.conf in questo modo

Alias /site1 C:/vufind/site1link
<Directory C:/vufind/site1link>

Se volete usare una istanza diversa di MySql agite sul file config.ini alla sezione

[Database]
database = mysql://root@localhost/vufind

In tal modo separate la gestione delle utenze tra le varie istanze.

Se volete gestire una istanza diversa di solr agite sulla  sezione

[Index]
engine = Solr
url = http://localhost:8080/solr
local = /usr/local/vufind/solr
default_core = biblio

In tal modo ogni istanza di VUFIND vedrà un set di dati differente.

Tramite Google Book è possibile recuperare la cover di un libro a partire dall’ISBN associato.

Per abilitare il recupero delle cover page dal libro occorre intervenire sul file config.ini e abilitare la direttiva

coverimages     = Syndetics:MySyndeticsId,Amazon:MyAccessKeyId,Booksite,LibraryThing:MyLibraryThingId,Google,OpenLibrary,Summon:MySerialsSolutionsClientKey,Contentcafe:MyContentCafeID

Tramite tale direttiva VUFIND recupererà le cover dei libri invocando il servizio esposto da Google Book e ciò verrà fatto in automatico per tutti i libri che presentano il tag ISBN valorizzzato.

Per abilitare l’integrazione con Wikipedia occorre intervenire sul file di configurazione config.ini e abilitare la direttiva

authors         = Wikipedia

Tramite tale direttiva il sistema consentirà di caricare la pagina dedicata all’autore su wikipedia. Tale funzione è attiva nella pagina dedicata all’autore all’interno del sistema VUFIND.

Sono presenti due modalità di caricamenti: tramite file in formato MARC21 oppure tramite file xml con un foglio xsl associato.

Nel caso del formato MARC21 rimando al sito ufficiale. Sostanzialmente si tratta di aver un file MARC21 e di caricarlo tramite il comando

import-marc.bat nomefile.mrc

Per chi non conoscesse MARC21 (ad esempio me) VUFIND da la possibilità di caricare i libri in formato XML associando un foglio di stile xsl che effettui la trasformazione del file nel formato xml supportato da Solr, le cui specifiche sono consultabili qui.

Personalmente preferisco questa seconda soluzione, più abbordabile e alla portata di tutti. Inoltre permette a chiunque abbia un catalogo xml di poterlo caricare sul nostro sistema agevolmente.

Facciamo un caso pratico, l’esempio vale più di 1000 parole. Supponiamo di avere un file xml che contiene il nostro catalogo così fatto:

<?xml version="1.0" encoding="utf-8"?>
<books>
<book>
<id>0000000001</id>
<title>titolo1</title>
</book>
<book>
<id>0000000002</id>
<title>titolo2</title>
</book>
<book>
<id>0000000003</id>
<title>titolo3</title>
</book>
</books>

A questo punto definiamo un foglio xsl che trasforma il file xml nel formato atteso da Solr.

<?xml version="1.0" encoding="utf-8"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:template match="/">
<add>
<xsl:for-each select="/books/book">
<doc>
<field name="id">
<xsl:value-of select="id"/>
</field>
<field name="title">
<xsl:value-of select="title"/>
</field>
<field name="recordtype">book</field>
</doc>
</xsl:for-each>
</add>
</xsl:template>
</xsl:stylesheet>

Questo file permetterà di trasformare il file xml nel seguente formato atteso da Solr:

<span class="pun" style="color: #666600;">&lt;?</span><span class="pln" style="color: #000000;">xml version</span><span class="pun" style="color: #666600;">=</span><span class="str" style="color: #008800;">"1.0"</span><span class="pln" style="color: #000000;"> encoding</span><span class="pun" style="color: #666600;">=</span><span class="str" style="color: #008800;">"UTF-8"</span><span class="pun" style="color: #666600;">?&gt;</span><span class="tag" style="color: #000088;">&lt;add&gt;</span><span class="tag" style="color: #000088;">&lt;doc&gt;</span><span class="tag" style="color: #000088;">&lt;field</span><span class="atn" style="color: #660066;">name</span><span class="pun" style="color: #666600;">=</span><span class="atv" style="color: #008800;">"id"</span><span class="tag" style="color: #000088;">&gt;</span><span class="pln" style="color: #000000;">0000000001</span><span class="tag" style="color: #000088;">&lt;/field&gt;</span><span class="tag" style="color: #000088;">&lt;field</span><span class="atn" style="color: #660066;">name</span><span class="pun" style="color: #666600;">=</span><span class="atv" style="color: #008800;">"title"</span><span class="tag" style="color: #000088;">&gt;</span><span class="pln" style="color: #000000;">titolo1</span><span class="tag" style="color: #000088;">&lt;/field&gt;</span><span class="tag" style="color: #000088;">&lt;field</span><span class="atn" style="color: #660066;">name</span><span class="pun" style="color: #666600;">=</span><span class="atv" style="color: #008800;">"recordtype"</span><span class="tag" style="color: #000088;">&gt;</span><span class="pln" style="color: #000000;">book</span><span class="tag" style="color: #000088;">&lt;/field&gt;</span><span class="tag" style="color: #000088;">&lt;/doc&gt;</span><span class="tag" style="color: #000088;">&lt;doc&gt;</span><span class="tag" style="color: #000088;">&lt;field</span><span class="atn" style="color: #660066;">name</span><span class="pun" style="color: #666600;">=</span><span class="atv" style="color: #008800;">"id"</span><span class="tag" style="color: #000088;">&gt;</span><span class="pln" style="color: #000000;">0000000002</span><span class="tag" style="color: #000088;">&lt;/field&gt;</span><span class="tag" style="color: #000088;">&lt;field</span><span class="atn" style="color: #660066;">name</span><span class="pun" style="color: #666600;">=</span><span class="atv" style="color: #008800;">"title"</span><span class="tag" style="color: #000088;">&gt;</span><span class="pln" style="color: #000000;">titolo2</span><span class="tag" style="color: #000088;">&lt;/field&gt;</span><span class="tag" style="color: #000088;">&lt;field</span><span class="atn" style="color: #660066;">name</span><span class="pun" style="color: #666600;">=</span><span class="atv" style="color: #008800;">"recordtype"</span><span class="tag" style="color: #000088;">&gt;</span><span class="pln" style="color: #000000;">book</span><span class="tag" style="color: #000088;">&lt;/field&gt;</span><span class="tag" style="color: #000088;">&lt;/doc&gt;</span><span class="tag" style="color: #000088;">&lt;doc&gt;</span><span class="tag" style="color: #000088;">&lt;field</span><span class="atn" style="color: #660066;">name</span><span class="pun" style="color: #666600;">=</span><span class="atv" style="color: #008800;">"id"</span><span class="tag" style="color: #000088;">&gt;</span><span class="pln" style="color: #000000;">0000000003</span><span class="tag" style="color: #000088;">&lt;/field&gt;</span><span class="tag" style="color: #000088;">&lt;field</span><span class="atn" style="color: #660066;">name</span><span class="pun" style="color: #666600;">=</span><span class="atv" style="color: #008800;">"title"</span><span class="tag" style="color: #000088;">&gt;</span><span class="pln" style="color: #000000;">titolo3</span><span class="tag" style="color: #000088;">&lt;/field&gt;</span><span class="tag" style="color: #000088;">&lt;field</span><span class="atn" style="color: #660066;">name</span><span class="pun" style="color: #666600;">=</span><span class="atv" style="color: #008800;">"recordtype"</span><span class="tag" style="color: #000088;">&gt;</span><span class="pln" style="color: #000000;">book</span><span class="tag" style="color: #000088;">&lt;/field&gt;</span><span class="tag" style="color: #000088;">&lt;/doc&gt;</span><span class="tag" style="color: #000088;">&lt;/add&gt;</span>

Per Solr ogni documento è definito come una sequenza di field, ciascuno con il proprio nome e valore. Il file deve rispettare lo schema definito in solr, in caso contrario il file verrà rifiutato durante l’importazione.

A questo punto non ci resta che caricare il file tramite la direttiva

c:\vufind\import>php import-xsl.php books.xml opac.properties

Tale direttiva processa il file books.xml applicando le regole definite nel file opac.properties che contiene i parametri per invocare il servizio esposto da solr.  La configurazione minimale è la seguente:

[General]
xslt = opac.xsl
custom_class[] = VuFind
truncate_custom_class = true

Il parametro xslt indica il file xsl da usare e deve essere disponibile all’interno della directory xsl

C:\vufind\import\xsl

A questo punto se abbiamo operato riceveremo come risposta

c:\vufind\import>php import-xsl.php books.xml opac.properties
<pre>2014-06-28T11:21:46-04:00 DEBUG: => POST http://localhost:8080/solr/biblio/
update</pre>
<pre>2014-06-28T11:21:46-04:00 DEBUG: <= 200 OK</pre>
Successfully imported books.xml...

Buon caricamento dati

[Statistics]
;mode[] = Solr
;mode[] = File
;mode[] = Db

VUFIND offre tre modalità per salvare le statistiche: solr, file e database. Ogni modalità può essere attivata rimuovendo il commento opportunamente.

Nel caso in cui si scelga Solr, occorre definire l’indirizzo dove è esposto il servizio abilitando la riga

;solr = http://localhost:8080/solr

Nel caso in cui si scelga file, occorre definire il percorso del file abilitando la riga

;file = /usr/local/vufind/local/logs

Nel caso in cui si scelga Db non sono necessarie altre modifiche, VUFIND salverà le statistiche nel proprio database.

VUFIND salva le ricerche effettuate e i record visti, ed è possibile salvare le ricerche in modi diversi tramite la sintassi

;mode[] = Db:Records, Solr:Search

Per consultare le statistiche occorre abilitare il modulo Admin, agendo sulla direttiva

admin_enabled = true

A questo punto possiamo accedere al modulo Admin disponibile all’indirizzo

http://localhost/vufind/Admin/

e consultare le nostre statistiche