Moodle in Italiano: admin/cli/defaults.php

admin/cli/defaults.php

di Daniele Cordella - sabato, 30 ottobre 2021, 01:22

Salve a tutti.

Vorrei personalizzare i default di admin/cli/install.php

Ho trovato in https://docs.moodle.org/31/en/Administration_via_command_line#Custom_site_defaults: "Shortly, all you need to do is to add a file local/defaults.php"

Ho trovato, invece, in https://tracker.moodle.org/browse/MDL-17850: "The idea is to allow admins to place a special xml file in moodledata dir,..."

A questo punto la confusione regna sovrana.

Ho provato a scrivere:

<?php $defaults['pluginname']['settingname'] = 'settingvalue'; // for plugins $defaults['moodle']['lang'] = 'it'; // for core settings

sia in moodle/local/defaults.php
che in moodledata/local/defaults.php

ma in nessuno dei due casi ho constatato la modifica dei default all'inizio dell'esecuzione di admin/cli/install.php.

Dove sto sbagliando?

Inoltre: se il file default.php dovesse andare nella moodledata, come potrebbe essere letto in fase di installazione quando la cartella moodledata non è ancora stata identificata?

Grazie in anticipo a chi cercherà di rispondermi.

Ri: admin/cli/defaults.php

di Matteo Scaramuccia - sabato, 30 ottobre 2021, 17:43

Ciao Daniele,
è una funzionalità che non avevo mai notata!
Ho sempre forzato da config.php anche perché non volevo fosse modificabile .

Si carica dalla cartella del codice di Moodle e deve essere un file leggibile contenente un valido array $defaults:

        // load custom defaults if found
        $this->custom_defaults = null;
        $defaultsfile = "$CFG->dirroot/local/defaults.php";
        if (is_readable($defaultsfile)) {
            $defaults = array();
            include($defaultsfile);
            if (is_array($defaults) and count($defaults)) {
                $this->custom_defaults = $defaults;
            }
        }

L'overwrite sulle chiavi di configurazione con valore predefinito di Moodle (core e plugin) si fa in questa maniera:

    public function get_defaultsetting() {
        $adminroot =  admin_get_root(false, false);
        if (!empty($adminroot->custom_defaults)) {
            $plugin = is_null($this->plugin) ? 'moodle' : $this->plugin;
            if (isset($adminroot->custom_defaults[$plugin])) {
                if (array_key_exists($this->name, $adminroot->custom_defaults[$plugin])) { // null is valid value here ;-)
                    return $adminroot->custom_defaults[$plugin][$this->name];
                }
            }
        }
        return $this->defaultsetting;
    }

Per cui immagino che per fare le prove sicuramente "pluginame" e "settingname" devono essere contestualizzati al plugin di cui vuoi fare la personalizzazione della sua configurazione direttamente in fase di installazione.

Che cosa non ti funziona esattamente? Il default per il plugin?

HTH,
Matteo

Ri: admin/cli/defaults.php

di Daniele Cordella - sabato, 30 ottobre 2021, 18:06

Ciao Matteo e grazie per la tua risposta.

Semplicamente ho scritto

    <?php
        $defaults['moodle']['lang'] = 'it'; // for core settings 
in

    $CFG->dirroot/local/defaults.php

ma eseguendo

    $CFG->dirroot/admin/cli/install.php

ho ottenuto come output

    Moodle 4.0dev+ (Build: 20211026) command line installation program
    -------------------------------------------------------------------------------
    == Choose a language ==
    en - English (en)
    ? - Available language packs
    type value, press Enter to use default value (en)
    :

invece che:

    Programma di installazione Moodle 4.0dev+ (Build: 20211026) via linea di comando
    -------------------------------------------------------------------------------
    == Seleziona lingua ==
    it - Italiano (it)
    en - English (en)
    ? - Elenco delle lingue disponibili
    inserisci un valore oppure premi Invio per usare il valore di default (it)
    :

che, invece, ottengo eseguendo:

    $CFG->dirroot/admin/cli/install.php --lang=it

Ri: admin/cli/defaults.php

di Matteo Scaramuccia - sabato, 30 ottobre 2021, 20:58

Ciao Daniele,
OK ora ho capito - non ho fatto girare il codice - ma qui temo ci sia un "bug".

Al tempo, 1 Febbraio 2009, la modifica per MDL-17850 fu https://github.com/moodle/moodle/commit/cd3acbf27e111567437ca7f0964aec4082712113 e MDL-15249 aggiunse, 27 Maggio 2009, l'opzione via CLI proprio dopo pochi mesi da quella evolutiva, https://github.com/moodle/moodle/commit/3b596dbf0b3c0ba9bfe21b59bedae88238dfd306: secondo me temo non abbia mai funzionato come ti (ci si) aspetti per tutti quei parametri che si possono passare come argomento via CLI perché l'inizializzazione della configurazione, come la lingua, è cablata e al più aggiornata dagli argomenti e solo gli include potrebbero rivalutarla ma non viene fatto:

if (empty($databases)) {
    $defaultdb = '';
} else {
    reset($databases);
    $defaultdb = key($databases);
}

// now get cli options
list($options, $unrecognized) = cli_get_params(
    array(
        'chmod'             => isset($distro->directorypermissions) ? sprintf('%04o',$distro->directorypermissions) : '2777', // let distros set dir permissions
        'lang'              => $CFG->lang,
        'wwwroot'           => '',
        'dataroot'          => empty($distro->dataroot) ? str_replace('\\', '/', dirname(dirname(dirname(__DIR__))).'/moodledata'): $distro->dataroot, // initialised later after including libs or by distro
        'dbtype'            => empty($distro->dbtype) ? $defaultdb : $distro->dbtype, // let distro skip dbtype selection
        'dbhost'            => empty($distro->dbhost) ? 'localhost' : $distro->dbhost, // let distros set dbhost
        'dbname'            => 'moodle',
        'dbuser'            => empty($distro->dbuser) ? 'root' : $distro->dbuser, // let distros set dbuser
        'dbpass'            => '',
        'dbport'            => '',
        'dbsocket'          => '',
        'prefix'            => 'mdl_',
        'fullname'          => '',
        'shortname'         => '',
        'summary'           => '',
        'adminuser'         => 'admin',
        'adminpass'         => '',
        'adminemail'        => '',
        'upgradekey'        => '',
        'non-interactive'   => false,
        'agree-license'     => false,
        'allow-unstable'    => false,
        'skip-database'     => false,
        'help'              => false
    ),

Tutta la configurazione predefinita succede a posteriori, su DB, ricavandoli da admin_apply_default_settings(null, false); per cui manca quel pezzo di codice che rivaluta i default della CLI con i default finali desiderati che comunque saranno forzati nel momento del salvataggio della configurazione su DB.

Ci sarebbe poi da gestire ad esempio che non puoi scegliere un tipo di DB se non presente perché oggi questa funzionalità può "includere" configurazioni senza senso come scegliere un tipo di DB di cui non hai il driver.

Tra le altre c'è pure /install/distrolib.php, https://moodle.org/mod/forum/discuss.php?d=167115#p732909 .

Forse conviene segnalarlo sul Tracker: non dovrebbe essere complesso risolverlo solo che alle porte della 4.0 tutti saranno concetrati altrove .

HTH,
Matteo

Ri: admin/cli/defaults.php

di Daniele Cordella - sabato, 30 ottobre 2021, 22:59

Grazie Matteo.
Segnalo questa chat sul tracker (traducendola al meglio in inglese) e vediamo che succede.
A te, comunque: grazie.

Ri: admin/cli/defaults.php

di Matteo Scaramuccia - domenica, 31 ottobre 2021, 00:28

Ciao Daniele,
nel frattempo, distrolib.php mi ha incuriosito e ho trovato MDL-18198 e MDL-29046; di seguito le relative implementazioni:

Con mio stupore quindi sembra(va) utilizzato visto che qualcuno ne ha pure sentito la mancanza sulla CLI 3 anni dopo, per cui mi chiedo se il meccanismo dei defaults di cui sopra abbia un senso e se forse sia meglio puntare sul solo distrolib.php espandendelo perché a questo punto sarebbero due le opzioni presenti e sovrapponibili (!):

voglio utilizzare una configurazione predefinita per alcuni parametri e per il DB => /install/distrolib.php
voglio forzare una configurazione su DB => /local/defaults.php

Per esempio, probabilmente per il tuo use case servirebbe "una combinazione delle due" e mi chiedo se non sia meglio deprecare il meccanismo dei defaults per come ora è fatto per portarlo dentro a distrolib.php.

Ci sono delle sovrapposizioni sicuramente e una proposta del genere meriterebbe un post sulla Community Inglese per ca(r)pire quanti ne facciano uso - magari la stessa Moodle Cloud, anche se io punterei di più sul config.php che forza le configurazioni senza lasciarle editare.

Altri riferimenti:

MDL-18167: in principio fu install/versions.php che poi divenne install/distro.php che poi divenne una serie di (2) funzioni di hook (distro_get_config(), distro_pre_create_db()) registrate in install/distrolib.php (MDL-18198)

HTH,
Matteo

Ri: admin/cli/defaults.php

di Daniele Cordella - martedì, 2 novembre 2021, 13:36

Un bel minestrone.
Prima di continuare a cercare di sbrogliare la matassa cerco di mettere in chiaro lo scenario d'uso che vorrei raggiungere.
Vorrei poter installare una instanza di moodle definendo per lei i parametri necessari in un file di testo per poi eseguire l'installazione da cli senza timore di sbagliarmi ma premendo solo return-return-return....

Ri: admin/cli/defaults.php

di Matteo Scaramuccia - martedì, 2 novembre 2021, 16:20

Ciao Daniele,
immaginavo uno scenario simile per il tuo caso ed è sicuramente tipico di tante altre situazione sia in HQ con MoodleCloud sia con Moodle Partner che vogliano fare installazioni unattended.

Sto pensando sia a "Eloy Lafuente" e "Andrew Lyons" ma anche ad altri come "Brendan Heywood" o ancora Andrea (Bicciolo).
Sicuramente ognuno di loro ha consolidato un metodo di lavoro e sarebbe meglio farne tesoro, renderlo pubblico (Wiki) ed eliminare tutte le opportunità che non sono usate e che magari creano bug come quello che hai scoperto tu.

HTH,
Matteo

Piazzale Italia

admin/cli/defaults.php