<spanid="index-0"></span><h1><spanclass="section-number">4. </span>Progettazione di Sophon<aclass="headerlink"href="#progettazione-di-sophon"title="Link a questa intestazione"></a></h1>
<p>Vista la situazione della <aclass="reference internal"href="../ricercacollaborativa/index.html#ricerca-collaborativa"><spanclass="std std-ref">ricerca collaborativa</span></a>, si è ritenuto potesse essere utile sviluppare un'alternativa al <aclass="reference internal"href="../ricercacollaborativa/index.html#hosting-on-premises"><spanclass="std std-ref">progetto JupyterHub</span></a>.</p>
<sectionid="requisiti-del-progetto">
<spanid="index-1"></span><h2><spanclass="section-number">4.1. </span>Requisiti del progetto<aclass="headerlink"href="#requisiti-del-progetto"title="Link a questa intestazione"></a></h2>
<p>Si è stabilito che per essere un'alternativa valida, il progetto dovesse avere i seguenti requisiti:</p>
<li><p><aclass="reference internal"href="#sicurezza"><spanclass="std std-ref">security by default</span></a></p></li>
<li><p><aclass="reference internal"href="#intuitivita"><spanclass="std std-ref">interfaccia grafica facile ed intuitiva</span></a></p></li>
<li><p><aclass="reference internal"href="#possibilita-di-collaborazione"><spanclass="std std-ref">maggiore possibilità di collaborazione</span></a></p></li>
<li><p><aclass="reference internal"href="#open-source"><spanclass="std std-ref">codice open source</span></a></p></li>
<li><p><aclass="reference internal"href="#personalizzabilita"><spanclass="std std-ref">possibilità di personalizzazione</span></a></p></li>
<p>Seguono descrizioni dettagliate dei requisiti elencati.</p>
<sectionid="estendibilita">
<spanid="index-2"></span><h3>Estendibilità<aclass="headerlink"href="#estendibilita"title="Link a questa intestazione"></a></h3>
<p><strong>Aggiungere nuove funzionalità</strong> al software deve essere facile, e non richiedere ristrutturazioni profonde del codice.</p>
<p>Inoltre, il software deve essere <strong>modulare</strong>, in modo da semplificare l'aggiornamento, la sostituzione e la eventuale rimozione di componenti.</p>
<p>Infine, il software deve esporre un'<strong>interfaccia alla quale altri software esterni possono connettersi</strong> per interagirvi come se fossero un utente.</p>
</section>
<sectionid="sicurezza">
<spanid="index-3"></span><h3>Sicurezza<aclass="headerlink"href="#sicurezza"title="Link a questa intestazione"></a></h3>
<p>I dati immagazzinati all'interno del software devono essere <strong>protetti da acccessi non autorizzati</strong>.</p>
<p><strong>Tentativi di ingannare gli utenti del software devono essere impediti</strong>, riducendo il fattore umano nelle falle di sicurezza.</p>
<p>Non si reputa importante impedire agli utenti di comunicare con Internet all'interno delle loro ricerche, in quanto si ritiene che essi siano utenti fidati; qualora ne sorga la necessità, ciò deve essere possibile senza ristrutturazione del codice.</p>
<p>Non si reputa nemmeno importante limitare le risorse utilizzate dai <aclass="reference internal"href="../ricercacollaborativa/index.html#notebook-computazionali"><spanclass="std std-ref">notebook</span></a> in uso; deve però essere possibile implementare la funzionalità in futuro, se divenisse necessario.</p>
</section>
<sectionid="intuitivita">
<spanid="index-4"></span><h3>Intuitività<aclass="headerlink"href="#intuitivita"title="Link a questa intestazione"></a></h3>
<p>Il modo in cui utilizzare l'interfaccia utente del software deve essere <strong>intuitiva</strong> per l'utente medio, senza che egli abbia bisogno di leggere alcuna guida o manuale.</p>
<p>A tale scopo, l'interfaccia grafica deve utilizzare <strong>design patterns comuni e familiari</strong> all'utente medio.</p>
<p>In aggiunta, i <strong>dettagli implementativi devono essere nascosti</strong> all'utente, in modo che possa concentrarsi sull'utilizzo del software.</p>
</section>
<sectionid="personalizzabilita">
<spanid="index-5"></span><h3>Personalizzabilità<aclass="headerlink"href="#personalizzabilita"title="Link a questa intestazione"></a></h3>
<p>Il software deve permettere all'utente di <strong>personalizzare il suo workflow senza alcuna limitazione</strong>, che ciò venga fatto tramite plugin, configurazioni speciali o modifica di file dell'ambiente di lavoro, assicurando che i workflow personalizzati di un utente <strong>non possano interferire</strong> con quelli degli altri.</p>
<p>Inoltre, il software deve inoltre permettere all'amministratore di <strong>personalizzare nome e aspetto</strong> mostrati agli utenti nell'interfaccia grafica, in modo che essa possa essere adattata al brand dell'istituzione che utilizza il progetto.</p>
</section>
<sectionid="possibilita-di-collaborazione">
<spanid="index-6"></span><h3>Possibilità di collaborazione<aclass="headerlink"href="#possibilita-di-collaborazione"title="Link a questa intestazione"></a></h3>
<p>Il software deve permettere agli utenti di <strong>collaborare sui notebook in tempo reale</strong>, come all'interno dei <aclass="reference internal"href="../ricercacollaborativa/index.html#web-based-editor"><spanclass="std std-ref">web-based editor</span></a>.</p>
<p>Devono essere <strong>facilitate le interazioni tra utenti</strong>, al fine di ridurre errori e incomprensioni tra essi.</p>
</section>
<sectionid="open-source">
<spanid="index-7"></span><h3>Open source<aclass="headerlink"href="#open-source"title="Link a questa intestazione"></a></h3>
<p>Il software deve essere interamente <strong>open source</strong>.</p>
<p>In pieno spirito collaborativo, il <strong>codice sorgente deve essere liberamente consultabile, modificabile, utilizzabile e condivisibile</strong>, sia per soddisfare la curiosità degli utenti, sia per permetterne lo studio e il miglioramento.</p>
<p>Tutte le <strong>modifiche al codice sorgente devono essere rese disponibili agli utenti</strong> del software modificato, in modo che possano verificare l'affidabilità del software che utilizzano.</p>
</section>
<sectionid="responsivita">
<spanid="index-8"></span><h3>Responsività<aclass="headerlink"href="#responsivita"title="Link a questa intestazione"></a></h3>
<p>Il software deve essere <strong>utilizzabile su schermi di dimensione ridotta</strong>, come quelli di un cellulare.</p>
<p>Pertanto, gli elementi dell'interfaccia devono essere disposti in modo tale da permetterne la visualizzazione corretta su schermi di qualsiasi dimensione e risoluzione.</p>
</section>
<sectionid="accessibilita">
<spanid="index-9"></span><h3>Accessibilità<aclass="headerlink"href="#accessibilita"title="Link a questa intestazione"></a></h3>
<p>Il software deve essere utilizzabile da <strong>qualsiasi tipologia di utente</strong>, inclusi utenti con disabilità visive e motorie.</p>
<p>Deve essere quindi possibile utilizzare il software <strong>interamente da tastiera</strong>, senza dover ricorrere a un mouse.</p>
<p>Inoltre, i colori dell'interfaccia grafica devono <strong>essere scelti favorendo l'accessibilità degli utenti daltonici</strong>.</p>
</section>
</section>
<sectionid="separazione-in-moduli">
<spanid="index-10"></span><h2><spanclass="section-number">4.2. </span>Separazione in moduli<aclass="headerlink"href="#separazione-in-moduli"title="Link a questa intestazione"></a></h2>
<p>Per realizzare il requisito dell'<aclass="reference internal"href="#estendibilita"><spanclass="std std-ref">estendibilità</span></a>, si è scelto di separare le parti dell'applicazioni in 4 diversi moduli interagenti.</p>
<p><spanclass="caption-number">Figura 4.2.1 </span><spanclass="caption-text">Schema che mostra come interagiscono tra loro i moduli di Sophon.</span><aclass="headerlink"href="#id26"title="Link a questa immagine"></a></p>
</figcaption>
</figure>
<sectionid="modulo-backend">
<spanid="index-11"></span><h3>Modulo backend<aclass="headerlink"href="#modulo-backend"title="Link a questa intestazione"></a></h3>
<p>Il modulo backend consiste in una web <abbrtitle="application programming interface">API</abbr> che si interfaccia con il database e i moduli Jupyter, permettendo un accesso controllato alle risorse del software.</p>
<p>È scritto in <aclass="reference internal"href="#python"><spanclass="std std-ref">Python</span></a>, usando <aclass="reference internal"href="#poetry"><spanclass="std std-ref">Poetry</span></a> e le librerie <aclass="reference internal"href="#django"><spanclass="std std-ref">Django</span></a>, <aclass="reference internal"href="#django-rest-framework"><spanclass="std std-ref">Django REST Framework</span></a> e <aclass="reference internal"href="#docker-sdk-for-python"><spanclass="std std-ref">Docker SDK for Python</span></a>, descritte nei prossimi paragrafi.</p>
<p>Esso è <strong>eseguito dal server</strong> sul quale è ospitato Sophon.</p>
<sectionid="python">
<spanid="index-12"></span><h4>Python<aclass="headerlink"href="#python"title="Link a questa intestazione"></a></h4>
<p><aclass="reference external"href="https://www.python.org/">Python</a> è un linguaggio di programmazione orientato agli oggetti interpretato con tipizzazione dinamica forte, particolarmente popolare negli ambiti dello sviluppo web e data science.</p>
<p>Ha numerosissime librerie (dette <em>packages</em>), sia incluse nella distribuzione base del linguaggio, sia disponibili per il download sul <aclass="reference external"href="https://pypi.org/">Python Package Index</a>.</p>
<p>La sua sintassi è semplice ed human-friendly, come è possibile vedere dal seguente frammento di codice:</p>
<p>La sua semplicità e l'enorme quantità di librerie a disposizione lo ha reso il secondo linguaggio di programmazione più popolare al mondo <aclass="reference internal"href="../bibliografia/index.html#so-survey2021"id="id2"><span>[so:survey2021]</span></a>, subito dopo <aclass="reference internal"href="#javascript"><spanclass="std std-ref">JavaScript</span></a>; proprio per questi motivi è stato scelto per lo sviluppo del modulo backend.</p>
</section>
<sectionid="poetry">
<spanid="index-13"></span><h4>Poetry<aclass="headerlink"href="#poetry"title="Link a questa intestazione"></a></h4>
<p>Per gestire le dipendenze di Sophon si è scelto di usare <aclass="reference external"href="https://python-poetry.org/">Poetry</a>, un innovativo package manager per il linguaggio Python.</p>
<p>Poetry è in grado di risolvere automaticamente alberi complessi di dipendenze, generando un <em>lockfile</em> (<codeclass="docutils literal notranslate"><spanclass="pre">poetry.lock</span></code>) con la soluzione adottata, in modo che le dipendenze utilizzate siano congelate e uguali per tutti gli ambienti in cui deve essere sviluppato Sophon.</p>
</section>
<sectionid="django">
<spanid="index-14"></span><h4>Django<aclass="headerlink"href="#django"title="Link a questa intestazione"></a></h4>
<p><aclass="reference external"href="https://www.djangoproject.com/">Django</a> è un framework Python per lo sviluppo di siti web dinamici.</p>
<p>Fornisce una suite di strumenti che assistono nella creazione di siti di medie dimensioni, come un <abbrtitle="object-relational model">ORM</abbr> per i database, una pagina di amministrazione integrata per la gestione dei contenuti del sito e un sistema di moduli scollegabili detti "app".</p>
<p>Le pagine restituite vengono definite attraverso funzioni, dette <em>function-based views</em>, o attraverso classi, dette <em>class-based views</em>, che ricevono in input la richiesta effettuata dall'utente ed restituscono in output la risposta HTTP da inoltrargli.</p>
<p>È stato scelto per la realizzazione del modulo backend in quanto presentato al corso di Tecnologie web di Unimore, e in quanto contenente tutte le funzionalità necessarie per la realizzazione del progetto del sito.</p>
</section>
<sectionid="django-rest-framework">
<spanid="index-15"></span><h4>Django REST Framework<aclass="headerlink"href="#django-rest-framework"title="Link a questa intestazione"></a></h4>
<p><aclass="reference external"href="https://www.django-rest-framework.org/">Django REST Framework</a> è un'estensione per <aclass="reference internal"href="#django"><spanclass="std std-ref">Django</span></a> che aggiunge la possibilità di inserire <abbrtitle="representational state transfer">REST</abbr><abbrtitle="application programming interface">API</abbr> all'interno delle applicazioni Django.</p>
<p>Permette di definire metodi dell'API in modo molto simile alle views di Django: si vengono a creare le <em>function-based API views</em> se i metodi sono definiti attraverso funzioni, o le <em>class-based API views</em> se i metodi sono definiti attraverso classi.</p>
<p>Inoltre, permette la generazione automatica di metodi per l'interazione con certe entità del database, attraverso particolari classi dette <em>viewset</em>.</p>
<p>Come per Django, è stato scelto per lo sviluppo di Sophon in quanto è stato presentato al corso di Tecnologie web di Unimore, e perchè si è ritenuto che fosse l'opzione più semplice per realizzare una web <abbrtitle="application programming interface">API</abbr> all'interno di Django.</p>
</section>
<sectionid="docker-sdk-for-python">
<spanid="index-16"></span><h4>Docker SDK for Python<aclass="headerlink"href="#docker-sdk-for-python"title="Link a questa intestazione"></a></h4>
<p>Per interfacciarsi con i <aclass="reference internal"href="#modulo-jupyter"><spanclass="std std-ref">moduli Jupyter</span></a>, si è deciso di utilizzare <aclass="reference external"href="https://docker-py.readthedocs.io/en/stable/">Docker SDK for Python</a>, un client Python per l'interazione con il daemon <aclass="reference internal"href="#docker"><spanclass="std std-ref">Docker</span></a>.</p>
<divclass="admonition seealso">
<pclass="admonition-title">Vedi anche</p>
<p><aclass="reference internal"href="#containerizzazione"><spanclass="std std-ref">Containerizzazione</span></a>, più avanti nel capitolo.</p>
</div>
</section>
</section>
<sectionid="modulo-frontend">
<spanid="index-17"></span><h3>Modulo frontend<aclass="headerlink"href="#modulo-frontend"title="Link a questa intestazione"></a></h3>
<p>Il <em>modulo frontend</em> consiste in una applicazione web che consente agli utenti di interagire con Sophon da un'interfaccia grafica.</p>
<p>Le interazioni vengono inviate al <aclass="reference internal"href="#modulo-proxy"><spanclass="std std-ref">modulo proxy</span></a>, che le ispeziona e le inoltra al <aclass="reference internal"href="#modulo-backend"><spanclass="std std-ref">modulo backend</span></a>.</p>
<p>È scritto in <aclass="reference internal"href="#typescript"><spanclass="std std-ref">TypeScript</span></a>, usando <aclass="reference internal"href="#react"><spanclass="std std-ref">React</span></a> e le librerie <aclass="reference internal"href="#fontawesome"><spanclass="std std-ref">FontAwesome</span></a> e <aclass="reference internal"href="#bluelib"><spanclass="std std-ref">Bluelib</span></a>, in aggiunta alle loro dipendenze ed altre piccole librerie di supporto.</p>
<p>Viene <strong>eseguito dal browser web</strong> dell'utente che desidera interagire con Sophon, transcompilato da TypeScript a <aclass="reference internal"href="#javascript"><spanclass="std std-ref">JavaScript</span></a>.</p>
<sectionid="javascript">
<spanid="index-18"></span><h4>JavaScript<aclass="headerlink"href="#javascript"title="Link a questa intestazione"></a></h4>
<p><aclass="reference external"href="https://it.wikipedia.org/wiki/JavaScript">JavaScript</a> è un linguaggio di programmazione interpretato con tipizzazione dinamica debole.</p>
<p>È l'unico linguaggio utilizzabile per rendere interattive le pagine web; pertanto, è indirettamente utilizzato dal modulo frontend di Sophon.</p>
<p>Il suo modello di oggetti si basa su dizionari che mappano i nomi degli attributi ai loro corrispondenti valori.</p>
<p>Fa inoltre abbondante uso della capacità dei linguaggi dinamici di definire funzioni a runtime (dette anche callback), sfruttandole per favorire la programmazione funzionale.</p>
<spanid="index-19"></span><h4>Node.js<aclass="headerlink"href="#node-js"title="Link a questa intestazione"></a></h4>
<p><aclass="reference external"href="https://nodejs.org/">Node.js</a> è un runtime <aclass="reference internal"href="#javascript"><spanclass="std std-ref">JavaScript</span></a> che permette la scrittura e l'esecuzione di programmi all'esterno del contesto di un browser web, utilizzando invece come contesto il sistema operativo su cui viene eseguito.</p>
<p>Include <abbrtitle="Node package manager">npm</abbr>, un gestore di pacchetti per il download di librerie Node, che interagisce con l'<aclass="reference external"href="https://www.npmjs.com/">npm Registry</a>.</p>
<p>È utilizzato da Sophon come toolchain per lo sviluppo e il deployment del modulo frontend, in quanto necessario per l'esecuzione di <aclass="reference internal"href="#create-react-app"><spanclass="std std-ref">Create React App</span></a>.</p>
</section>
<sectionid="create-react-app">
<spanid="index-20"></span><h4>Create React App<aclass="headerlink"href="#create-react-app"title="Link a questa intestazione"></a></h4>
<p><aclass="reference external"href="https://create-react-app.dev/">Create React App</a> è un insieme di strumenti <aclass="reference internal"href="#node-js"><spanclass="std std-ref">Node.js</span></a> per lo sviluppo di una applicazione web utilizzando la libreria per la creazione di interfacce grafiche <aclass="reference internal"href="#react"><spanclass="std std-ref">React</span></a>.</p>
<p>È utilizzato da Sophon per la costruzione della pagina del modulo frontend che sarà servita all'utente.</p>
<p>Si è scelto di usare Create React App in quanto astrae al programmatore tutta la logica di creazione della pagina, semplificando enormemente la manutenzione ed <aclass="reference internal"href="#estendibilita"><spanclass="std std-ref">estensione</span></a> futura del software.</p>
</section>
<sectionid="typescript">
<spanid="index-21"></span><h4>TypeScript<aclass="headerlink"href="#typescript"title="Link a questa intestazione"></a></h4>
<p><aclass="reference external"href="https://www.typescriptlang.org/">TypeScript</a> è un'estensione al linguaggio di programmazione <aclass="reference internal"href="#javascript"><spanclass="std std-ref">JavaScript</span></a> che vi introduce un sistema di tipizzazione forte.</p>
<p>Non essendo immediatamente utilizzabile all'interno delle pagine web, deve essere prima convertito in JavaScript: ciò viene effettuato da <aclass="reference internal"href="#create-react-app"><spanclass="std std-ref">Create React App</span></a> in fase di costruzione dell'applicazione.</p>
<p>È stata utilizzata in quasi ogni singola parte del modulo frontend, in quanto avere una tipizzazione forte riduce significativamente i bug prodotti e facilita manutenzione ed <aclass="reference internal"href="#estendibilita"><spanclass="std std-ref">estensione</span></a> del software.</p>
</section>
<sectionid="react">
<spanid="index-22"></span><h4>React<aclass="headerlink"href="#react"title="Link a questa intestazione"></a></h4>
<p><aclass="reference external"href="https://reactjs.org/">React</a> è una libreria <aclass="reference internal"href="#javascript"><spanclass="std std-ref">JavaScript</span></a> per lo sviluppo di interfacce grafiche interattive all'interno di pagine web o applicazioni mobile.</p>
<p>L'interfaccia viene definita in modo dichiarativo e funzionale attraverso una variante dei linguaggi <aclass="reference internal"href="#javascript"><spanclass="std std-ref">JavaScript</span></a> (o <aclass="reference internal"href="#typescript"><spanclass="std std-ref">TypeScript</span></a>) detta JSX (o TSX), che permette l'inserimento di nodi HTML all'interno del codice.</p>
<p>Si basa sul concetto di <em>componenti</em>, piccole parti incapsulate di interfaccia grafica riutilizzabili attraverso tutta l'applicazione definite attraverso funzioni pure, e di <em>hooks</em>, particolari funzioni il cui nome inizia con <codeclass="docutils literal notranslate"><spanclass="pre">use</span></code> in grado di tenere traccia dello stato di un componente o di causare effetti collaterali all'interno di esso.</p>
<p>È stata scelta per l'utilizzo in Sophon in quanto permette la realizzazione di interfacce grafiche molto complesse attraverso codice di facile comprensione, rendendo possibile la creazione di un'interfaccia interattiva ed <aclass="reference internal"href="#intuitivita"><spanclass="std std-ref">intuitiva</span></a>.</p>
</section>
<sectionid="fontawesome">
<spanid="index-23"></span><h4>FontAwesome<aclass="headerlink"href="#fontawesome"title="Link a questa intestazione"></a></h4>
<p><aclass="reference external"href="https://fontawesome.com/">FontAwesome</a> è una libreria che fornisce più di mille icone utilizzabili gratuitamente all'interno di pagine web.</p>
<p>È stata usata per favorire l'<aclass="reference internal"href="#intuitivita"><spanclass="std std-ref">intuibilità</span></a> dell'interfaccia grafica attraverso simboli familiari all'utente.</p>
</section>
<sectionid="bluelib">
<spanid="index-24"></span><h4>Bluelib<aclass="headerlink"href="#bluelib"title="Link a questa intestazione"></a></h4>
<p><aclass="reference external"href="https://gh.steffo.eu/bluelib/">Bluelib</a> è un foglio di stile per pagine web orientato alla modularità, alla responsività e all'<aclass="reference internal"href="#accessibilita"><spanclass="std std-ref">accessibilità</span></a>.</p>
<p>È stato sviluppato nell'Estate 2021 come progetto personale dell'autore di questa tesi, ed è stato esteso con temi aggiuntivi in Autunno 2021, tra cui uno sviluppato appositamente per Sophon.</p>
<p>Si basa sul concetto di <strong>pannelli</strong>, sezioni di pagina separate dal resto tramite un colore di sfondo o un bordo diverso.</p>
<p>Fa ampio uso delle <aclass="reference external"href="https://developer.mozilla.org/en-US/docs/Web/CSS/--*">CSS Custom Properties</a>, permettendo lo sviluppo di vari <em>temi</em> con aspetto differente.</p>
<p><spanclass="caption-number">Figura 4.2.2 </span><spanclass="caption-text">Il tema "Royal Blue" (<codeclass="docutils literal notranslate"><spanclass="pre">royalblue</span></code>) di Bluelib, da cui ha origine il nome.</span><aclass="headerlink"href="#id27"title="Link a questa immagine"></a></p>
<p><spanclass="caption-number">Figura 4.2.3 </span><spanclass="caption-text">Il tema "Sheet of Paper" (<codeclass="docutils literal notranslate"><spanclass="pre">paper</span></code>) di Bluelib, pensato per la stampa su carta.</span><aclass="headerlink"href="#id28"title="Link a questa immagine"></a></p>
<p><spanclass="caption-number">Figura 4.2.4 </span><spanclass="caption-text">Il tema "The Sophonity" (<codeclass="docutils literal notranslate"><spanclass="pre">sophon</span></code>) di Bluelib, creato appositamente per questo progetto.</span><aclass="headerlink"href="#id29"title="Link a questa immagine"></a></p>
<p><spanclass="caption-number">Figura 4.2.5 </span><spanclass="caption-text">Il tema "Hacker Terminal" (<codeclass="docutils literal notranslate"><spanclass="pre">hacker</span></code>) di Bluelib, creato per testare la visualizzazione di caratteri monospace.</span><aclass="headerlink"href="#id30"title="Link a questa immagine"></a></p>
<p><spanclass="caption-number">Figura 4.2.6 </span><spanclass="caption-text">Il tema "Gestione Amber" (<codeclass="docutils literal notranslate"><spanclass="pre">amber</span></code>) di Bluelib, realizzato da Lorenzo Balugani.</span><aclass="headerlink"href="#id31"title="Link a questa immagine"></a></p>
</figcaption>
</figure>
<sectionid="bluelib-react">
<spanid="index-25"></span><h5>Bluelib React<aclass="headerlink"href="#bluelib-react"title="Link a questa intestazione"></a></h5>
<p><aclass="reference external"href="http://gh.steffo.eu/bluelib-react/">Bluelib React</a> è un adattamento a <aclass="reference internal"href="#react"><spanclass="std std-ref">React</span></a> del foglio di stile <aclass="reference internal"href="#bluelib"><spanclass="std std-ref">Bluelib</span></a>.</p>
<p>È stato sviluppato a inizio Autunno 2021 come parte del tirocinio interno dell'autore di questa tesi.</p>
<p>Definice componenti per ogni elemento grafico introdotto in Bluelib, e rende velocemente configurabili alcuni parametri, come il colore o la disabilitazione di un pannello.</p>
</section>
</section>
</section>
<sectionid="modulo-proxy">
<spanid="index-26"></span><h3>Modulo proxy<aclass="headerlink"href="#modulo-proxy"title="Link a questa intestazione"></a></h3>
<p>Il <em>modulo proxy</em> consiste in un web server che permette di accedere al <aclass="reference internal"href="#modulo-backend"><spanclass="std std-ref">modulo backend</span></a>, ai <aclass="reference internal"href="#modulo-jupyter"><spanclass="std std-ref">moduli Jupyter</span></a> e a una versione preconfigurata del <aclass="reference internal"href="#modulo-frontend"><spanclass="std std-ref">modulo frontend</span></a>.</p>
<p>È stato realizzato configurando <aclass="reference internal"href="#apache-http-server"><spanclass="std std-ref">Apache HTTP server</span></a> in modo che effettuasse dinamicamente <aclass="reference internal"href="#reverse-proxy"><spanclass="std std-ref">reverse proxying</span></a> verso gli altri moduli basandosi su una rubrica aggiornata dal backend.</p>
<p>Viene <strong>eseguito dal server</strong> sul quale è ospitato Sophon.</p>
<sectionid="reverse-proxy">
<spanid="index-27"></span><h4>Reverse proxy<aclass="headerlink"href="#reverse-proxy"title="Link a questa intestazione"></a></h4>
<p>Il <em>reverse proxying</em> è un'operazione effettuabile dai web server per permettere l'accesso controllato ad altri web server collocati su una rete interna attraverso l'inoltro di pacchetti.</p>
<p>Frequentemente, il reverse proxying viene utilizzato per "aggiungere" l'HTTPS a un web server disponibile solo in HTTP, o per disambiguare tra più web server che devono essere accessibili allo stesso indirizzo IP ma con nomi di dominio diversi.</p>
<p>In un'installazione predefinita di Sophon, il reverse proxying effettuato è duplice:</p>
<ulclass="simple">
<li><p>il server web della macchina host riceve richieste HTTPS e le inoltra in HTTP al server web del <aclass="reference internal"href="#modulo-proxy"><spanclass="std std-ref">modulo proxy</span></a>;</p></li>
<li><p>il server web del modulo proxy riceve richieste HTTP che inoltra ai vari moduli in base al valore dell'header <codeclass="docutils literal notranslate"><spanclass="pre">Host</span></code> della richiesta ricevuta.</p></li>
<p><spanclass="caption-number">Figura 4.2.7 </span><spanclass="caption-text">Schema del reverse proxying di Sophon.</span><aclass="headerlink"href="#id32"title="Link a questa immagine"></a></p>
</figcaption>
</figure>
</section>
<sectionid="apache-http-server">
<spanid="index-28"></span><h4>Apache HTTP server<aclass="headerlink"href="#apache-http-server"title="Link a questa intestazione"></a></h4>
<p><aclass="reference external"href="https://httpd.apache.org/">Apache HTTP Server</a>, comunemente chiamato anche <em>httpd</em> o <em>apache2</em>, è uno dei tre webserver "general purpose" più comunemente usati al mondo.</p>
<p>Ha una struttura a moduli, che forniscono funzionalità aggiuntive, ed è configurabile tramite uno o più file <codeclass="docutils literal notranslate"><spanclass="pre">.conf</span></code> aventi sintassi come la seguente:</p>
<divclass="highlight-apacheconf notranslate"><divclass="highlight"><pre><span></span><spanclass="c"># Questa è un'istruzione globale.</span>
<spanid="index-29"></span><h3>Modulo Jupyter<aclass="headerlink"href="#modulo-jupyter"title="Link a questa intestazione"></a></h3>
<p>Il <em>modulo Jupyter</em> consiste in una versione preconfigurata di <aclass="reference internal"href="../ricercacollaborativa/index.html#index-5"><spanclass="std std-ref">Jupyter</span></a> pronta per essere istanziata dal <aclass="reference internal"href="#modulo-backend"><spanclass="std std-ref">modulo backend</span></a>.</p>
<p>Tanti moduli Jupyter possono esistere contemporaneamente su Sophon: ne viene creato uno per ogni <aclass="reference internal"href="../ricercacollaborativa/index.html#notebook-computazionali"><spanclass="std std-ref">notebook computazionale</span></a> gestito dal modulo backend.</p>
<p>Viene <strong>eseguito dal server</strong> sul quale è ospitato Sophon.</p>
</section>
</section>
<sectionid="containerizzazione">
<spanid="index-30"></span><h2><spanclass="section-number">4.3. </span>Containerizzazione<aclass="headerlink"href="#containerizzazione"title="Link a questa intestazione"></a></h2>
<p>Al fine di facilitare l'installazione e di migliorare la <aclass="reference internal"href="#sicurezza"><spanclass="std std-ref">sicurezza</span></a> dell'applicazione, si è stabilito di costruire <aclass="reference internal"href="#container-docker"><spanclass="std std-ref">container Docker</span></a> per tutti i moduli di Sophon.</p>
<sectionid="docker">
<spanid="index-31"></span><h3>Docker<aclass="headerlink"href="#docker"title="Link a questa intestazione"></a></h3>
<p><aclass="reference external"href="https://www.docker.com/">Docker</a> è un software che permette di eseguire applicazioni all'interno di <aclass="reference internal"href="#container-docker"><spanclass="std std-ref">container</span></a> isolati dal resto del sistema, in maniera simile all'esecuzione di macchine virtuali, ma <strong>condividendo il kernel</strong> con la macchina host.</p>
<p>È composto da due parti, <aclass="reference internal"href="#docker-engine"><spanclass="std std-ref">Docker Engine</span></a> e <aclass="reference internal"href="#docker-compose"><spanclass="std std-ref">Docker Compose</span></a>, e prevede varie astrazioni, quali le <aclass="reference internal"href="#immagini-docker"><spanclass="std std-ref">immagini</span></a>, i <aclass="reference internal"href="#container-docker"><spanclass="std std-ref">container</span></a>, i <aclass="reference internal"href="#network-docker"><spanclass="std std-ref">network</span></a> e i <aclass="reference internal"href="#volumi-docker"><spanclass="std std-ref">volumi</span></a>.</p>
<sectionid="immagini-docker">
<spanid="index-32"></span><h4>Immagini Docker<aclass="headerlink"href="#immagini-docker"title="Link a questa intestazione"></a></h4>
<p>Le <em>immagini</em> Docker sono sequenze di regole e insiemi di file per la creazione di un <aclass="reference internal"href="#container-docker"><spanclass="std std-ref">container</span></a>, tipicamente partendo da un altro container come base. <aclass="reference internal"href="../bibliografia/index.html#docker-overview"id="id17"><span>[docker:overview]</span></a></p>
<p>Utilizzano un filesystem copy-on-write a strati: vengono registrate all'interno dell'immagine solamente le modifiche che ogni regola ha apportato al filesystem interno, rendendo le immagini molto più leggere di quanto lo sarebbero se dovesse essere salvato tutto il disco virtuale.</p>
<p>Possono essere comparate a immagini di macchine virtuali con tanti "punti di ripristino".</p>
</section>
<sectionid="container-docker">
<spanid="index-33"></span><h4>Container Docker<aclass="headerlink"href="#container-docker"title="Link a questa intestazione"></a></h4>
<p>I <em>container</em> Docker sono istanze di <aclass="reference internal"href="#immagini-docker"><spanclass="std std-ref">immagini</span></a> che possono essere eseguite dal <aclass="reference internal"href="#docker-engine"><spanclass="std std-ref">Docker Engine</span></a><aclass="reference internal"href="../bibliografia/index.html#docker-overview"id="id18"><span>[docker:overview]</span></a>.</p>
<p>Sono l'equivalente di un'intera macchina virtuale, che può essere avviata o arrestata.</p>
</section>
<sectionid="network-docker">
<spanid="index-34"></span><h4>Network Docker<aclass="headerlink"href="#network-docker"title="Link a questa intestazione"></a></h4>
<p>I <em>network</em> Docker sono astrazioni per vari tipi di reti di calcolatori: in particolare, essi permettono di collegare vari <aclass="reference internal"href="#container-docker"><spanclass="std std-ref">container</span></a> ad una rete locale virtuale, permettendone l'interazione <aclass="reference internal"href="../bibliografia/index.html#docker-networking"id="id19"><span>[docker:networking]</span></a>.</p>
<p>All'interno di un network è disponibile una funzionalità di risoluzione automatica degli indirizzi IP virtuali dei container: per accedere al container <codeclass="docutils literal notranslate"><spanclass="pre">pear</span></code> in HTTP, ad esempio, sarà sufficiente utilizzare <codeclass="docutils literal notranslate"><spanclass="pre">apple</span></code> come se fosse un nome di dominio: <codeclass="docutils literal notranslate"><spanclass="pre">http://pear/</span></code>.</p>
<p>Sono una versione più elaborata ed efficiente dei moduli di rete per macchine virtuali.</p>
</section>
<sectionid="volumi-docker">
<spanid="index-35"></span><h4>Volumi Docker<aclass="headerlink"href="#volumi-docker"title="Link a questa intestazione"></a></h4>
<p>I <em>volumi</em> Docker sono astrazioni per filesystem che permettono la permanenza e la condivisione tra container di file <aclass="reference internal"href="../bibliografia/index.html#docker-volumes"id="id20"><span>[docker:volumes]</span></a>.</p>
<p>Essi vengono montati all'interno di un container in una cartella configurabile detta <em>mount point</em>; tutti i container con accesso al volume vedranno gli stessi file all'interno di essa.</p>
<p>Sono il parallelo delle immagini disco delle macchine virtuali.</p>
</section>
</section>
<sectionid="docker-engine">
<spanid="index-36"></span><h3>Docker Engine<aclass="headerlink"href="#docker-engine"title="Link a questa intestazione"></a></h3>
<p><aclass="reference external"href="https://docs.docker.com/engine/">Docker Engine</a> è il daemon che si occupa della gestione di <aclass="reference internal"href="#immagini-docker"><spanclass="std std-ref">immagini</span></a>, <aclass="reference internal"href="#container-docker"><spanclass="std std-ref">container</span></a>, <aclass="reference internal"href="#network-docker"><spanclass="std std-ref">network</span></a> e <aclass="reference internal"href="#volumi-docker"><spanclass="std std-ref">volumi</span></a>.</p>
<p>Astrae la piattaforma su cui viene eseguito, in modo che tutte le immagini possano essere eseguite su Linux come su Windows o Mac OS X.</p>
</section>
<sectionid="docker-compose">
<spanid="index-37"></span><h3>Docker Compose<aclass="headerlink"href="#docker-compose"title="Link a questa intestazione"></a></h3>
<p><aclass="reference external"href="https://docs.docker.com/compose/">Docker Compose</a> è uno strumento da linea di comando che permette l'esecuzione di applicazioni Docker composte da più container.</p>
<p>Le applicazioni Compose sono definite all'interno di un file <aclass="reference external"href="https://it.wikipedia.org/wiki/YAML">YAML</a> come il seguente:</p>
<spanid="index-38"></span><h2><spanclass="section-number">4.4. </span>Controllo versione<aclass="headerlink"href="#controllo-versione"title="Link a questa intestazione"></a></h2>
<p>Per assistere nello sviluppo del software si è deciso di utilizzare il sistema di controllo versione <aclass="reference internal"href="#git"><spanclass="std std-ref">Git</span></a> in ogni fase dello sviluppo del progetto.</p>
<p>Inoltre, per favorire lo sviluppo di una community <aclass="reference internal"href="#open-source"><spanclass="std std-ref">open source</span></a> attorno a Sophon, si è deciso di pubblicare il progetto su <aclass="reference internal"href="#github"><spanclass="std std-ref">GitHub</span></a>, sotto la <aclass="reference internal"href="#affero-general-public-license-3-0"><spanclass="std std-ref">Affero General Public License 3.0+</span></a>.</p>
<sectionid="git">
<spanid="index-39"></span><h3>Git<aclass="headerlink"href="#git"title="Link a questa intestazione"></a></h3>
<p><aclass="reference external"href="https://git-scm.com/">Git</a> è un software di controllo versione, ovvero un software in grado di tenere traccia di modifiche effettuate su file, in modo da mantenerne uno storico, e permettere a più autori di lavorare in parallelo su documenti.</p>
<p>Inizialmente realizzato da Linus Torvalds per lo sviluppo del kernel Linux, ha preso velocemente piede in tutto il settore dello sviluppo software, diventando di fatto lo standard per lo sviluppo collaborativo di software.</p>
<p>Le cartelle di file tracciate da Git sono dette <em>repository</em>, mentre un blocco atomico di modifiche è detto <em>commit</em>.</p>
</section>
<sectionid="github">
<spanid="index-40"></span><h3>GitHub<aclass="headerlink"href="#github"title="Link a questa intestazione"></a></h3>
<p><aclass="reference external"href="https://github.com/">GitHub</a> è un servizio web di Microsoft per l'hosting e la pubblicazione di repository Git.</p>
<p>Per ciascun repository sono messe a disposizione gratuitamente numerose funzionalità, quali un issue tracker, strumenti di code review e sistemi di automazione per lo sviluppo <aclass="reference internal"href="../bibliografia/index.html#github-features"id="id25"><span>[github:features]</span></a>.</p>
</section>
<sectionid="affero-general-public-license-3-0">
<h3>Affero General Public License 3.0+<aclass="headerlink"href="#affero-general-public-license-3-0"title="Link a questa intestazione"></a></h3>
<p>Sophon è rilasciato sotto la <aclass="reference external"href="https://www.gnu.org/licenses/agpl-3.0.html">GNU Affero General Public License v3</a> (o successiva).</p>
<p>Il testo completo della licenza è disponibile all'interno del file <aclass="reference external"href="https://github.com/Steffo99/sophon/blob/main/LICENSE.txt">LICENSE.txt</a> allegato al codice sorgente del software.</p>
<p>In breve, la licenza, detta virale, permette a chiunque di utilizzare, distribuire e modificare il software, a condizione che qualsiasi modifica venga ri-distribuita agli utenti del software modificato utilizzando la stessa licenza.</p>
<p>Si specifica che la licenza copre tutti i file all'interno del repository <codeclass="docutils literal notranslate"><spanclass="pre">Steffo99/sophon</span></code>, anche se essi non contengono un header che indica che sono protetti da copyright.</p>
</section>
</section>
<sectionid="entita-di-sophon">
<spanid="index-41"></span><h2><spanclass="section-number">4.5. </span>Entità di Sophon<aclass="headerlink"href="#entita-di-sophon"title="Link a questa intestazione"></a></h2>
<p>Al fine di definire più in dettaglio le operazioni che devono poter essere effettuate all'interno di Sophon, sono state definite delle <em>entità</em>, i tipi base con cui l'utente può interagire.</p>
<sectionid="istanza-in-sophon">
<spanid="index-42"></span><h3>Istanza in Sophon<aclass="headerlink"href="#istanza-in-sophon"title="Link a questa intestazione"></a></h3>
<p>Un'<em>istanza</em> rappresenta un'<strong>installazione di Sophon</strong> effettuata su un server di un'istituzione di ricerca, come ad esempio un'Università.</p>
<p>Ogni istanza è <strong>fisicamente e logicamente separata</strong> dalle altre; istanze diverse <strong>non condividono alcun dato</strong> tra loro.</p>
<sectionid="url-dell-istanza">
<h4>URL dell'istanza<aclass="headerlink"href="#url-dell-istanza"title="Link a questa intestazione"></a></h4>
<p>Ciascuna istanza è accessibile tramite <strong>uno specifico URL</strong>, scelto dall'amministratore di sistema al momento dell'installazione.</p>
<p><spanclass="caption-number">Figura 4.5.1 </span><spanclass="caption-text">Schema rappresentante un esempio di URL di istanza rispettivamente per Unimore, Unibo e il CERN. Si noti come Sophon possa essere ospitato a domini di qualsiasi livello o radici diverse da <codeclass="docutils literal notranslate"><spanclass="pre">/</span></code>, quella predefinita.</span><aclass="headerlink"href="#id33"title="Link a questa immagine"></a></p>
</figcaption>
</figure>
</section>
</section>
<sectionid="utenti-in-sophon">
<spanid="index-43"></span><h3>Utenti in Sophon<aclass="headerlink"href="#utenti-in-sophon"title="Link a questa intestazione"></a></h3>
<p>Un <em>utente</em> è una entità che interagisce con una specifica istanza Sophon: ad esempio, un utente potrebbe essere una persona fisica, oppure potrebbe essere un software di automazione che si interfaccia con Sophon.</p>
<p>La tabella viene creata automaticamente da Django all'interno di ogni applicazione che include</p>
<sectionid="livelli-di-accesso">
<spanid="index-44"></span><h4>Livelli di accesso<aclass="headerlink"href="#livelli-di-accesso"title="Link a questa intestazione"></a></h4>
<p>Un utente può avere uno dei seguenti <em>livelli di accesso</em>:</p>
<dlclass="simple">
<dt>Superutente</dt><dd><p>Utente con accesso completo a ogni singola risorsa sull'istanza Sophon, tipicamente riservato per l'amministratore di sistema.</p>
</dd>
<dt>Utente</dt><dd><p>Utente con permessi limitati alle risorse che ha creato o a cui è stato fornito accesso.</p>
</dd>
<dt>Ospite</dt><dd><p>Utente che può visualizzare alcuni contenuti dell'istanza Sophon ma non può interagirci.</p>
</dd>
</dl>
</section>
<sectionid="credenziali-di-accesso">
<spanid="index-45"></span><h4>Credenziali di accesso<aclass="headerlink"href="#credenziali-di-accesso"title="Link a questa intestazione"></a></h4>
<p>Gli utenti di tipo <em>Utente</em> e <em>Superutente</em> devono identificarsi sull'istanza con le loro credenziali.</p>
<p>Di default, le credenziali sono un <strong>nome utente</strong> e una <strong>password</strong>, ma è possibile implementare un sistema diverso, ad esempio un sistema <abbrtitle="Single Sign-On">SSO</abbr>.</p>
</section>
</section>
<sectionid="gruppi-di-ricerca-in-sophon">
<spanid="index-46"></span><h3>Gruppi di ricerca in Sophon<aclass="headerlink"href="#gruppi-di-ricerca-in-sophon"title="Link a questa intestazione"></a></h3>
<p>Un <em>gruppo di ricerca</em> rappresenta un insieme di utenti che collaborano su uno o più progetti.</p>
<sectionid="membri-e-modalita-di-accesso">
<spanid="index-47"></span><h4>Membri e modalità di accesso<aclass="headerlink"href="#membri-e-modalita-di-accesso"title="Link a questa intestazione"></a></h4>
<p>Gli utenti dell'<aclass="reference internal"href="#istanza-in-sophon"><spanclass="std std-ref">istanza</span></a> possono diventare <em>membri</em> dei gruppi di ricerca, con una delle seguenti modalità selezionate nelle impostazioni del gruppo:</p>
<ulclass="simple">
<li><p>se il gruppo è <em>aperto</em>, allora qualsiasi utente potrà diventarne membro semplicemente <strong>facendo richiesta</strong> attraverso l'interfaccia web;</p></li>
<li><p>se il gruppo è in <em>modalità manuale</em>, allora nessun utente potrà richiedere di unirsi, e i membri saranno <strong>selezionati manualmente</strong> dal creatore del gruppo.</p></li>
</ul>
<p>In qualsiasi momento, i membri di un gruppo possono <strong>lasciarlo</strong> facendo apposita richiesta attraverso il frontend.</p>
</section>
<sectionid="creazione-di-nuovi-gruppi">
<h4>Creazione di nuovi gruppi<aclass="headerlink"href="#creazione-di-nuovi-gruppi"title="Link a questa intestazione"></a></h4>
<p>Qualsiasi <aclass="reference internal"href="#utenti-in-sophon"><spanclass="std std-ref">utente</span></a> può <strong>creare</strong> gruppi di ricerca dall'interfaccia web.</p>
</section>
<sectionid="modifica-di-gruppi">
<h4>Modifica di gruppi<aclass="headerlink"href="#modifica-di-gruppi"title="Link a questa intestazione"></a></h4>
<p>Il creatore di un gruppo di ricerca è l'unico <aclass="reference internal"href="#utenti-in-sophon"><spanclass="std std-ref">utente</span></a> che può cambiarne <strong>nome</strong>, <strong>descrizione</strong>, <strong>membri</strong> e <strong>modalità di accesso</strong>.</p>
<p>Lo <em>slug</em>, l'identificatore univoco del gruppo, non è modificabile successivamente alla creazione, in quanto verrà utilizzato all'interno degli URL, che devono essere immutabili.</p>
</section>
<sectionid="eliminazione-di-gruppi">
<h4>Eliminazione di gruppi<aclass="headerlink"href="#eliminazione-di-gruppi"title="Link a questa intestazione"></a></h4>
<p>Il creatore di un gruppo è l'unico utente in grado di <strong>cancellare</strong> il gruppo che ha creato.</p>
<divclass="admonition danger">
<pclass="admonition-title">Pericolo</p>
<p>L'eliminazione di un gruppo è un'operazione distruttiva non reversibile!</p>
</div>
</section>
</section>
<sectionid="progetti-di-ricerca-in-sophon">
<spanid="index-48"></span><h3>Progetti di ricerca in Sophon<aclass="headerlink"href="#progetti-di-ricerca-in-sophon"title="Link a questa intestazione"></a></h3>
<p>Un <em>progetto di ricerca</em> rappresenta una <strong>collezione di oggetti</strong> relativa a un singolo argomento mantenuta da un <aclass="reference internal"href="#gruppi-di-ricerca-in-sophon"><spanclass="std std-ref">gruppo di ricerca</span></a>.</p>
<sectionid="visibilita-dei-progetti">
<spanid="index-49"></span><h4>Visibilità dei progetti<aclass="headerlink"href="#visibilita-dei-progetti"title="Link a questa intestazione"></a></h4>
<p>I progetti hanno tre diverse impostazioni di visibilità che regolano chi può visualizzarne i contenuti:</p>
<dlclass="simple">
<dt>Progetto privato</dt><dd><p>Il progetto è visibile <strong>solo ai membri del gruppo</strong> a cui appartiene il progetto.</p>
</dd>
<dt>Progetto interno</dt><dd><p>Il progetto è visibile <strong>solo agli utenti</strong> dell'istanza, e non agli ospiti.</p>
</dd>
<dt>Progetto pubblico</dt><dd><p>Il progetto è visibile <strong>a tutti</strong>.</p>
</dd>
</dl>
</section>
<sectionid="creazione-di-nuovi-progetti">
<h4>Creazione di nuovi progetti<aclass="headerlink"href="#creazione-di-nuovi-progetti"title="Link a questa intestazione"></a></h4>
<p>Qualsiasi <em>membro</em> di un <aclass="reference internal"href="#gruppi-di-ricerca-in-sophon"><spanclass="std std-ref">gruppo di ricerca</span></a> può creare nuovi progetti.</p>
</section>
<sectionid="modifica-di-progetti">
<h4>Modifica di progetti<aclass="headerlink"href="#modifica-di-progetti"title="Link a questa intestazione"></a></h4>
<p>Qualsiasi <em>membro</em> di un <aclass="reference internal"href="#gruppi-di-ricerca-in-sophon"><spanclass="std std-ref">gruppo di ricerca</span></a> può modificare <strong>nome</strong>, <strong>descrizione</strong> dei progetti al suo interno.</p>
<p>Solo il <em>creatore del gruppo</em> può modificarne la <strong>visibilità</strong>, o <strong>trasferire il progetto ad un altro gruppo</strong>.</p>
<p>Lo <em>slug</em>, l'identificatore univoco del progetto, non è modificabile successivamente alla creazione, in quanto è utilizzato all'interno degli URL, che devono essere immutabili.</p>
</section>
<sectionid="eliminazione-di-progetti">
<h4>Eliminazione di progetti<aclass="headerlink"href="#eliminazione-di-progetti"title="Link a questa intestazione"></a></h4>
<p>Qualsiasi <em>membro</em> di un <aclass="reference internal"href="#gruppi-di-ricerca-in-sophon"><spanclass="std std-ref">gruppo di ricerca</span></a> può eliminare i progetti al suo interno.</p>
<divclass="admonition danger">
<pclass="admonition-title">Pericolo</p>
<p>L'eliminazione di un progetto è un'operazione distruttiva non reversibile!</p>
</div>
</section>
</section>
<sectionid="notebook-in-sophon">
<spanid="index-50"></span><h3>Notebook in Sophon<aclass="headerlink"href="#notebook-in-sophon"title="Link a questa intestazione"></a></h3>
<p>Un <em>notebook</em> rappresenta una <strong>postazione di lavoro</strong> che può essere allegata ad un <aclass="reference internal"href="#progetti-di-ricerca-in-sophon"><spanclass="std std-ref">progetto di ricerca</span></a>.</p>
<sectionid="creazione-di-nuovi-notebook">
<h4>Creazione di nuovi notebook<aclass="headerlink"href="#creazione-di-nuovi-notebook"title="Link a questa intestazione"></a></h4>
<p>Qualsiasi <strong>membro</strong> di un <aclass="reference internal"href="#gruppi-di-ricerca-in-sophon"><spanclass="std std-ref">gruppo di ricerca</span></a> può creare nuovi notebook all'interno di uno dei progetti del gruppo a cui appartiene.</p>
</section>
<sectionid="slug-riservati">
<h4>Slug riservati<aclass="headerlink"href="#slug-riservati"title="Link a questa intestazione"></a></h4>
<p>Un notebook non può avere come <em>slug</em> uno dei seguenti valori, in quanto riservati per altri usi:</p>
<p>In più, uno slug di un notebook non può iniziare o terminare con un trattino <codeclass="docutils literal notranslate"><spanclass="pre">-</span></code>, in quanto risulterebbe in un sottodominio non valido.</p>
</section>
<sectionid="stato-del-notebook">
<spanid="index-51"></span><h4>Stato del notebook<aclass="headerlink"href="#stato-del-notebook"title="Link a questa intestazione"></a></h4>
<p>Un notebook può essere <em>avviato</em> o <em>fermo</em> in base al suo stato di esecuzione sull'<aclass="reference internal"href="#istanza-in-sophon"><spanclass="std std-ref">istanza</span></a> Sophon:</p>
<ulclass="simple">
<li><p>è <em>avviato</em> se è in esecuzione e accessibile;</p></li>
<li><p>è <em>fermo</em> se non è in esecuzione o se è in fase di preparazione.</p></li>
</ul>
<p>Alla creazione, un notebook è <em>fermo</em>.</p>
<sectionid="avviare-un-notebook">
<h5>Avviare un notebook<aclass="headerlink"href="#avviare-un-notebook"title="Link a questa intestazione"></a></h5>
<p>Un <strong>membro</strong> del <aclass="reference internal"href="#gruppi-di-ricerca-in-sophon"><spanclass="std std-ref">gruppo di ricerca</span></a> a cui appartiene il notebook può richiedere al server l'avvio di quest'ultimo, in modo da poterlo utilizzare successivamente.</p>
</section>
<sectionid="fermare-un-notebook">
<h5>Fermare un notebook<aclass="headerlink"href="#fermare-un-notebook"title="Link a questa intestazione"></a></h5>
<p>Un <strong>membro</strong> del <aclass="reference internal"href="#gruppi-di-ricerca-in-sophon"><spanclass="std std-ref">gruppo di ricerca</span></a> a cui appartiene il notebook può richiedere al server l'arresto di quest'ultimo, salvando i dati e interrompendo la sessione di lavoro attualmente in corso.</p>
</section>
</section>
<sectionid="immagine-del-notebook">
<spanid="index-52"></span><h4>Immagine del notebook<aclass="headerlink"href="#immagine-del-notebook"title="Link a questa intestazione"></a></h4>
<p>In <strong>fase di creazione</strong> di un notebook, oppure mentre esso è <strong>fermo</strong>, è possibile selezionare l'<aclass="reference internal"href="#immagini-docker"><spanclass="std std-ref">immagine Docker</span></a> che esso deve eseguire all'avvio.</p>
<p>Di default, l'immagine deve essere quella del <aclass="reference internal"href="#modulo-jupyter"><spanclass="std std-ref">modulo Jupyter</span></a>.</p>
<p>Le immagini ammesse devono esporre un server HTTP sulla porta 8080, su cui verrà fatto <aclass="reference internal"href="#reverse-proxy"><spanclass="std std-ref">reverse proxying</span></a> dal <aclass="reference internal"href="#modulo-proxy"><spanclass="std std-ref">modulo proxy</span></a>.</p>
</section>
<sectionid="collegamento-a-un-notebook">
<h4>Collegamento a un notebook<aclass="headerlink"href="#collegamento-a-un-notebook"title="Link a questa intestazione"></a></h4>
<p>I <strong>membri</strong> del <aclass="reference internal"href="#gruppi-di-ricerca-in-sophon"><spanclass="std std-ref">gruppo di ricerca</span></a> a cui appartiene il notebook possono connettersi ad un notebook <strong>avviato</strong> attraverso un URL segreto comunicatogli dal <aclass="reference internal"href="#modulo-backend"><spanclass="std std-ref">modulo backend</span></a>.</p>
<p>L'URL segreto è ottenuto inserendo come query parameter dell'URL del notebook il token di autenticazione di <aclass="reference internal"href="../ricercacollaborativa/index.html#index-5"><spanclass="std std-ref">Jupyter</span></a>.</p>
</section>
<sectionid="blocco-di-un-notebook">
<spanid="index-53"></span><h4>Blocco di un notebook<aclass="headerlink"href="#blocco-di-un-notebook"title="Link a questa intestazione"></a></h4>
<p>Qualsiasi <strong>membro</strong> del <aclass="reference internal"href="#gruppi-di-ricerca-in-sophon"><spanclass="std std-ref">gruppo di ricerca</span></a> a cui appartiene il notebook può <em>bloccarlo</em> per segnalare agli altri utenti che vi hanno accesso di non utilizzare quello specifico notebook.</p>
<p>Bloccare un notebook <strong>rimuove dall'interfaccia web</strong> i bottoni di interazione con esso per tutti gli utenti, tranne l'utente richiedente il blocco.</p>
<divclass="admonition note">
<pclass="admonition-title">Nota</p>
<p>Il blocco di un notebook <strong>è solo estetico</strong>, e non ha lo scopo di impedire agli utenti di interagire con il notebook, ma serve per indicare ai propri collaboratori che si stanno effettuando modifiche che non permettono collaborazione sul notebook.</p>
</div>
<p>Un notebook bloccato può essere sbloccato da qualsiasi <strong>membro</strong> del <aclass="reference internal"href="#gruppi-di-ricerca-in-sophon"><spanclass="std std-ref">gruppo di ricerca</span></a>; il membro che ha richiesto il blocco potrà sbloccarlo <strong>immediatamente</strong>, mentre agli altri membri è richiesto di confermare l'azione.</p>
</section>
<sectionid="modifica-di-un-notebook">
<h4>Modifica di un notebook<aclass="headerlink"href="#modifica-di-un-notebook"title="Link a questa intestazione"></a></h4>
<p>Qualsiasi <em>membro</em> di un <aclass="reference internal"href="#gruppi-di-ricerca-in-sophon"><spanclass="std std-ref">gruppo di ricerca</span></a> può modificare <strong>nome</strong> e <strong>immagine</strong> dei notebook <em>fermi</em> al suo interno.</p>
<p>I notebook <em>avviati</em> non possono essere modificati.</p>
<p>Lo <em>slug</em>, l'identificatore univoco del notebook, non è modificabile successivamente alla creazione, in quanto è utilizzato all'interno degli URL, che devono essere immutabili.</p>
</section>
<sectionid="eliminazione-di-un-notebook">
<h4>Eliminazione di un notebook<aclass="headerlink"href="#eliminazione-di-un-notebook"title="Link a questa intestazione"></a></h4>
<p>Qualsiasi <em>membro</em> di un <aclass="reference internal"href="#gruppi-di-ricerca-in-sophon"><spanclass="std std-ref">gruppo di ricerca</span></a> può eliminare i notebook all'interno dei progetti del gruppo, a condizione che questi siano <em>fermi</em> e <em>non bloccati</em>.</p>
</section>
</section>
</section>
<sectionid="database">
<spanid="index-54"></span><h2><spanclass="section-number">4.6. </span>Database<aclass="headerlink"href="#database"title="Link a questa intestazione"></a></h2>
<p>Il <aclass="reference internal"href="#modulo-backend"><spanclass="std std-ref">modulo backend</span></a> di Sophon necessita di archiviare dati persistenti altamente relazionali; pertanto, è stato necessario adottare una soluzione in grado di gestirli.</p>
<p>A tale scopo, è stato selezionato il database relazionale <aclass="reference external"href="https://www.postgresql.org/">PostgreSQL</a>, in quanto <abbrtitle="Free and Libre Open Source Software">FLOSS</abbr>, adatto a dati relazionali, compatibile con Django, e ampiamente utilizzato in tutto il mondo.</p>
<p><spanclass="caption-number">Figura 4.6.1 </span><spanclass="caption-text">Schema semplificato del database di Sophon.</span><aclass="headerlink"href="#id34"title="Link a questa immagine"></a></p>
</figcaption>
</figure>
</section>
</section>
</div>
</div>
<footer><divclass="rst-footer-buttons"role="navigation"aria-label="Piè di pagina">
<ahref="../ricercacollaborativa/index.html"class="btn btn-neutral float-left"title="3. Ricerca collaborativa"accesskey="p"rel="prev"><spanclass="fa fa-arrow-circle-left"aria-hidden="true"></span> Precedente</a>
<ahref="../realizzazione/index.html"class="btn btn-neutral float-right"title="5. Realizzazione di Sophon"accesskey="n"rel="next">Prossimo <spanclass="fa fa-arrow-circle-right"aria-hidden="true"></span></a>
