1
0
mirror of https://github.com/moodle/moodle.git synced 2025-05-16 05:00:01 +02:00

Merge branch 'MDL-59323-master' of https://github.com/sammarshallou/moodle

This commit is contained in:
Dan Poltawski 2017-07-17 15:05:55 +01:00 committed by David Monllao
commit 7af4771d63

@ -20,6 +20,8 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/ */
defined('MOODLE_INTERNAL') || die();
/** /**
* This class will check all the default values existing in the DB * This class will check all the default values existing in the DB
* match those specified in the xml specs * match those specified in the xml specs
@ -34,15 +36,15 @@ class check_defaults extends XMLDBCheckAction {
/** /**
* Init method, every subclass will have its own * Init method, every subclass will have its own
*/ */
function init() { public function init() {
$this->introstr = 'confirmcheckdefaults'; $this->introstr = 'confirmcheckdefaults';
parent::init(); parent::init();
// Set own core attributes // Set own core attributes.
// Set own custom attributes // Set own custom attributes.
// Get needed strings // Get needed strings.
$this->loadStrings(array( $this->loadStrings(array(
'wrongdefaults' => 'tool_xmldb', 'wrongdefaults' => 'tool_xmldb',
'nowrongdefaultsfound' => 'tool_xmldb', 'nowrongdefaultsfound' => 'tool_xmldb',
@ -52,107 +54,130 @@ class check_defaults extends XMLDBCheckAction {
)); ));
} }
protected function check_table(xmldb_table $xmldb_table, array $metacolumns) { protected function check_table(xmldb_table $xmldbtable, array $metacolumns) {
$o = ''; $o = '';
$wrong_fields = array(); $wrongfields = array();
// Get and process XMLDB fields // Get and process XMLDB fields.
if ($xmldb_fields = $xmldb_table->getFields()) { if ($xmldbfields = $xmldbtable->getFields()) {
$o.=' <ul>'; $o .= ' <ul>';
foreach ($xmldb_fields as $xmldb_field) { foreach ($xmldbfields as $xmldbfield) {
// Get the default value for the field // Get the default value for the field.
$xmldbdefault = $xmldb_field->getDefault(); $xmldbdefault = $xmldbfield->getDefault();
// If the metadata for that column doesn't exist or 'id' field found, skip // Char fields with not null currently have default '' when actually installed.
if (!isset($metacolumns[$xmldb_field->getName()]) or $xmldb_field->getName() == 'id') { if ($xmldbdefault === null && $xmldbfield->getType() === XMLDB_TYPE_CHAR &&
$xmldbfield->getNotNull()) {
$xmldbdefault = '';
}
if ($xmldbdefault !== null) {
$xmldbdefault = (string)$xmldbdefault;
}
// If the metadata for that column doesn't exist or 'id' field found, skip.
if (!isset($metacolumns[$xmldbfield->getName()]) or $xmldbfield->getName() == 'id') {
continue; continue;
} }
// To variable for better handling // To variable for better handling.
$metacolumn = $metacolumns[$xmldb_field->getName()]; $metacolumn = $metacolumns[$xmldbfield->getName()];
// Going to check this field in DB // Going to check this field in DB.
$o.=' <li>' . $this->str['field'] . ': ' . $xmldb_field->getName() . ' '; $o .= ' <li>' . $this->str['field'] . ': ' . $xmldbfield->getName() . ' ';
// get the value of the physical default (or blank if there isn't one) // Get the value of the physical default (or blank if there isn't one).
if ($metacolumn->has_default==1) { if ($metacolumn->has_default == 1) {
$physicaldefault = $metacolumn->default_value; $physicaldefault = $metacolumn->default_value;
} } else {
else { $physicaldefault = null;
$physicaldefault = '';
} }
// there *is* a default and it's wrong // There *is* a default and it's wrong.
if ($physicaldefault != $xmldbdefault) { if ($physicaldefault !== $xmldbdefault) {
$info = '('.$this->str['expected']." '$xmldbdefault', ".$this->str['actual']. $xmldbtext = self::display_default($xmldbdefault);
" '$physicaldefault')"; $physicaltext = self::display_default($physicaldefault);
$o.='<font color="red">' . $this->str['wrong'] . " $info</font>"; $info = "({$this->str['expected']} {$xmldbtext}, {$this->str['actual']} {$physicaltext})";
// Add the wrong field to the list $o .= '<font color="red">' . $this->str['wrong'] . " $info</font>";
// Add the wrong field to the list.
$obj = new stdClass(); $obj = new stdClass();
$obj->table = $xmldb_table; $obj->table = $xmldbtable;
$obj->field = $xmldb_field; $obj->field = $xmldbfield;
$obj->physicaldefault = $physicaldefault; $obj->physicaldefault = $physicaldefault;
$obj->xmldbdefault = $xmldbdefault; $obj->xmldbdefault = $xmldbdefault;
$wrong_fields[] = $obj; $wrongfields[] = $obj;
} else { } else {
$o.='<font color="green">' . $this->str['ok'] . '</font>'; $o .= '<font color="green">' . $this->str['ok'] . '</font>';
} }
$o.='</li>'; $o .= '</li>';
} }
$o.=' </ul>'; $o .= ' </ul>';
} }
return array($o, $wrong_fields); return array($o, $wrongfields);
} }
protected function display_results(array $wrong_fields) { /**
* Converts a default value suitable for display.
*
* @param string|null $defaultvalue Default value
* @return string Displayed version
*/
protected static function display_default($defaultvalue) {
if ($defaultvalue === null) {
return '-';
} else {
return "'" . s($defaultvalue) . "'";
}
}
protected function display_results(array $wrongfields) {
global $DB; global $DB;
$dbman = $DB->get_manager(); $dbman = $DB->get_manager();
$s = ''; $s = '';
$r = '<table class="generaltable boxaligncenter boxwidthwide" border="0" cellpadding="5" cellspacing="0" id="results">'; $r = '<table class="generaltable boxaligncenter boxwidthwide" border="0" cellpadding="5" cellspacing="0" id="results">';
$r.= ' <tr><td class="generalboxcontent">'; $r .= ' <tr><td class="generalboxcontent">';
$r.= ' <h2 class="main">' . $this->str['searchresults'] . '</h2>'; $r .= ' <h2 class="main">' . $this->str['searchresults'] . '</h2>';
$r.= ' <p class="centerpara">' . $this->str['wrongdefaults'] . ': ' . count($wrong_fields) . '</p>'; $r .= ' <p class="centerpara">' . $this->str['wrongdefaults'] . ': ' . count($wrongfields) . '</p>';
$r.= ' </td></tr>'; $r .= ' </td></tr>';
$r.= ' <tr><td class="generalboxcontent">'; $r .= ' <tr><td class="generalboxcontent">';
// If we have found wrong defaults inform about them // If we have found wrong defaults inform about them.
if (count($wrong_fields)) { if (count($wrongfields)) {
$r.= ' <p class="centerpara">' . $this->str['yeswrongdefaultsfound'] . '</p>'; $r .= ' <p class="centerpara">' . $this->str['yeswrongdefaultsfound'] . '</p>';
$r.= ' <ul>'; $r .= ' <ul>';
foreach ($wrong_fields as $obj) { foreach ($wrongfields as $obj) {
$xmldb_table = $obj->table; $xmldbtable = $obj->table;
$xmldb_field = $obj->field; $xmldbfield = $obj->field;
$physicaldefault = $obj->physicaldefault; $physicaltext = self::display_default($obj->physicaldefault);
$xmldbdefault = $obj->xmldbdefault; $xmldbtext = self::display_default($obj->xmldbdefault);
// get the alter table command // Get the alter table command.
$sqlarr = $dbman->generator->getAlterFieldSQL($xmldb_table, $xmldb_field); $sqlarr = $dbman->generator->getAlterFieldSQL($xmldbtable, $xmldbfield);
$r.= ' <li>' . $this->str['table'] . ': ' . $xmldb_table->getName() . '. ' . $r .= ' <li>' . $this->str['table'] . ': ' . $xmldbtable->getName() . '. ' .
$this->str['field'] . ': ' . $xmldb_field->getName() . ', ' . $this->str['field'] . ': ' . $xmldbfield->getName() . ', ' .
$this->str['expected'] . ' ' . "'$xmldbdefault'" . ' ' . $this->str['expected'] . ' ' . $xmldbtext . ' ' .
$this->str['actual'] . ' ' . "'$physicaldefault'" . '</li>'; $this->str['actual'] . ' ' . $physicaltext . '</li>';
// Add to output if we have sentences // Add to output if we have sentences.
if ($sqlarr) { if ($sqlarr) {
$sqlarr = $dbman->generator->getEndedStatements($sqlarr); $sqlarr = $dbman->generator->getEndedStatements($sqlarr);
$s.= '<code>' . str_replace("\n", '<br />', implode('<br />', $sqlarr)) . '</code><br />'; $s .= '<code>' . str_replace("\n", '<br />', implode('<br />', $sqlarr)) . '</code><br />';
} }
} }
$r.= ' </ul>'; $r .= ' </ul>';
// Add the SQL statements (all together) // Add the SQL statements (all together).
$r.= '<hr />' . $s; $r .= '<hr />' . $s;
} else { } else {
$r.= ' <p class="centerpara">' . $this->str['nowrongdefaultsfound'] . '</p>'; $r .= ' <p class="centerpara">' . $this->str['nowrongdefaultsfound'] . '</p>';
} }
$r.= ' </td></tr>'; $r .= ' </td></tr>';
$r.= ' <tr><td class="generalboxcontent">'; $r .= ' <tr><td class="generalboxcontent">';
// Add the complete log message // Add the complete log message.
$r.= ' <p class="centerpara">' . $this->str['completelogbelow'] . '</p>'; $r .= ' <p class="centerpara">' . $this->str['completelogbelow'] . '</p>';
$r.= ' </td></tr>'; $r .= ' </td></tr>';
$r.= '</table>'; $r .= '</table>';
return $r; return $r;
} }