/admin/tool/xmldb/actions/main_view/main_view.class.php
PHP | 308 lines | 217 code | 17 blank | 74 comment | 52 complexity | 1c8a9c2d46c83f44d99ec1ba12d7336d MD5 | raw file
- <?php
- // This file is part of Moodle - http://moodle.org/
- //
- // Moodle is free software: you can redistribute it and/or modify
- // it under the terms of the GNU General Public License as published by
- // the Free Software Foundation, either version 3 of the License, or
- // (at your option) any later version.
- //
- // Moodle is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU General Public License for more details.
- //
- // You should have received a copy of the GNU General Public License
- // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
- /**
- * @package tool_xmldb
- * @copyright 2003 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- /**
- * This class will show all the actions available under the XMLDB editor interface
- *
- * From here, files can be created, edited, saved and deleted, plus some
- * extra utilities like displaying docs, xml info and performing various consistency tests
- *
- * @package tool_xmldb
- * @copyright 2003 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- class main_view extends XMLDBAction {
- /**
- * Init method, every subclass will have its own
- */
- function init() {
- parent::init();
- // Set own custom attributes
- $this->sesskey_protected = false; // This action doesn't need sesskey protection
- // Get needed strings
- $this->loadStrings(array(
- 'load' => 'tool_xmldb',
- 'create' => 'tool_xmldb',
- 'edit' => 'tool_xmldb',
- 'save' => 'tool_xmldb',
- 'revert' => 'tool_xmldb',
- 'unload' => 'tool_xmldb',
- 'delete' => 'tool_xmldb',
- 'reservedwords' => 'tool_xmldb',
- 'gotolastused' => 'tool_xmldb',
- 'checkindexes' => 'tool_xmldb',
- 'checkdefaults' => 'tool_xmldb',
- 'checkforeignkeys' => 'tool_xmldb',
- 'checkbigints' => 'tool_xmldb',
- 'checkoraclesemantics' => 'tool_xmldb',
- 'doc' => 'tool_xmldb',
- 'filemodifiedoutfromeditor' => 'tool_xmldb',
- 'viewxml' => 'tool_xmldb',
- 'pendingchangescannotbesavedreload' => 'tool_xmldb'
- ));
- }
- /**
- * Invoke method, every class will have its own
- * returns true/false on completion, setting both
- * errormsg and output as necessary
- */
- function invoke() {
- parent::invoke();
- $result = true;
- // Set own core attributes
- $this->does_generate = ACTION_GENERATE_HTML;
- // These are always here
- global $CFG, $XMLDB, $SESSION, $DB;
- // Get lastused
- $o = '';
- if (isset($SESSION->lastused)) {
- if ($lastused = $SESSION->lastused) {
- // Print link
- $o .= '<p class="centerpara"><a href="#lastused">' . $this->str['gotolastused'] . '</a></p>';
- }
- } else {
- $lastused = NULL;
- }
- // Calculate the buttons
- $b = '<p class="centerpara buttons">';
- // The reserved_words button
- $b .= ' <a href="index.php?action=view_reserved_words">[' . $this->str['reservedwords'] . ']</a>';
- // The docs button
- $b .= ' <a href="index.php?action=generate_all_documentation">[' . $this->str['doc'] . ']</a>';
- // The check indexes button
- $b .= ' <a href="index.php?action=check_indexes&sesskey=' . sesskey() . '">[' . $this->str['checkindexes'] . ']</a>';
- // The check defaults button
- $b .= ' <a href="index.php?action=check_defaults&sesskey=' . sesskey() . '">[' . $this->str['checkdefaults'] . ']</a>';
- // The check bigints button (only for MySQL and PostgreSQL) MDL-11038a
- if ($DB->get_dbfamily() == 'mysql' || $DB->get_dbfamily() == 'postgres') {
- $b .= ' <a href="index.php?action=check_bigints&sesskey=' . sesskey() . '">[' . $this->str['checkbigints'] . ']</a>';
- }
- // The check semantics button (only for Oracle) MDL-29416
- if ($DB->get_dbfamily() == 'oracle') {
- $b .= ' <a href="index.php?action=check_oracle_semantics&sesskey=' . sesskey() . '">[' . $this->str['checkoraclesemantics'] . ']</a>';
- }
- $b .= ' <a href="index.php?action=check_foreign_keys&sesskey=' . sesskey() . '">[' . $this->str['checkforeignkeys'] . ']</a>';
- $b .= '</p>';
- // Send buttons to output
- $o .= $b;
- // Do the job
- // Get the list of DB directories
- $result = $this->launch('get_db_directories');
- // Display list of DB directories if everything is ok
- if ($result && !empty($XMLDB->dbdirs)) {
- $o .= '<table id="listdirectories" border="0" cellpadding="5" cellspacing="1" class="admintable generaltable">';
- $row = 0;
- foreach ($XMLDB->dbdirs as $key => $dbdir) {
- // Detect if this is the lastused dir
- $hithis = false;
- if (str_replace($CFG->dirroot, '', $key) == $lastused) {
- $hithis = true;
- }
- $elementtext = str_replace($CFG->dirroot . '/', '', $key);
- // Calculate the dbdir has_changed field if needed
- if (!isset($dbdir->has_changed) && isset($dbdir->xml_loaded)) {
- $dbdir->xml_changed = false;
- if (isset($XMLDB->editeddirs[$key])) {
- $editeddir = $XMLDB->editeddirs[$key];
- if (isset($editeddir->xml_file)) {
- $structure = $editeddir->xml_file->getStructure();
- if ($structure->hasChanged()) {
- $dbdir->xml_changed = true;
- $editeddir->xml_changed = true;
- }
- }
- }
- }
- // The file name (link to edit if the file is loaded)
- if ($dbdir->path_exists &&
- file_exists($key . '/install.xml') &&
- is_readable($key . '/install.xml') &&
- is_readable($key) &&
- !empty($dbdir->xml_loaded)) {
- $f = '<a href="index.php?action=edit_xml_file&dir=' . urlencode(str_replace($CFG->dirroot, '', $key)) . '">' . $elementtext . '</a>';
- } else {
- $f = $elementtext;
- }
- // Calculate the buttons
- $b = ' <td class="button cell">';
- // The create button
- if ($dbdir->path_exists &&
- !file_exists($key . '/install.xml') &&
- is_writeable($key)) {
- $b .= '<a href="index.php?action=create_xml_file&sesskey=' . sesskey() . '&dir=' . urlencode(str_replace($CFG->dirroot, '', $key)) . '&time=' . time() . '&postaction=main_view#lastused">[' . $this->str['create'] . ']</a>';
- } else {
- $b .= '[' . $this->str['create'] . ']';
- }
- $b .= '</td><td class="button cell">';
- // The load button
- if ($dbdir->path_exists &&
- file_exists($key . '/install.xml') &&
- is_readable($key . '/install.xml') &&
- empty($dbdir->xml_loaded)) {
- $b .= '<a href="index.php?action=load_xml_file&dir=' . urlencode(str_replace($CFG->dirroot, '', $key)) . '&time=' . time() . '&postaction=main_view#lastused">[' . $this->str['load'] . ']</a>';
- } else {
- $b .= '[' . $this->str['load'] . ']';
- }
- $b .= '</td><td class="button cell">';
- // The edit button
- if ($dbdir->path_exists &&
- file_exists($key . '/install.xml') &&
- is_readable($key . '/install.xml') &&
- is_readable($key) &&
- !empty($dbdir->xml_loaded)) {
- $b .= '<a href="index.php?action=edit_xml_file&dir=' . urlencode(str_replace($CFG->dirroot, '', $key)) . '">[' . $this->str['edit'] . ']</a>';
- } else {
- $b .= '[' . $this->str['edit'] . ']';
- }
- $b .= '</td><td class="button cell">';
- // The save button
- if ($dbdir->path_exists &&
- file_exists($key . '/install.xml') &&
- is_writeable($key . '/install.xml') &&
- is_writeable($key) &&
- !empty($dbdir->xml_loaded) &&
- !empty($dbdir->xml_changed)) {
- $b .= '<a href="index.php?action=save_xml_file&sesskey=' . sesskey() . '&dir=' . urlencode(str_replace($CFG->dirroot, '', $key)) . '&time=' . time() . '&postaction=main_view#lastused">[' . $this->str['save'] . ']</a>';
- // Check if the file has been manually edited while being modified in the editor
- if ($dbdir->filemtime != filemtime($key . '/install.xml')) {
- // File manually modified. Add to action error, will be displayed inline.
- $this->errormsg = $this->str['filemodifiedoutfromeditor'];
- }
- } else {
- $b .= '[' . $this->str['save'] . ']';
- }
- $b .= '</td><td class="button cell">';
- // The document button
- if ($dbdir->path_exists &&
- file_exists($key . '/install.xml') &&
- is_readable($key . '/install.xml') &&
- is_readable($key)) {
- $b .= '<a href="index.php?action=generate_documentation&dir=' . urlencode(str_replace($CFG->dirroot, '', $key)) . '">[' . $this->str['doc'] . ']</a>';
- } else {
- $b .= '[' . $this->str['doc'] . ']';
- }
- $b .= '</td><td class="button cell">';
- // The view xml button
- if ($dbdir->path_exists &&
- file_exists($key . '/install.xml') &&
- is_readable($key . '/install.xml')) {
- $b .= '<a href="index.php?action=view_xml&file=' . urlencode(str_replace($CFG->dirroot, '', $key) . '/install.xml') . '">[' . $this->str['viewxml'] . ']</a>';
- } else {
- $b .= '[' . $this->str['viewxml'] . ']';
- }
- $b .= '</td><td class="button cell">';
- // The revert button
- if ($dbdir->path_exists &&
- file_exists($key . '/install.xml') &&
- is_readable($key . '/install.xml') &&
- is_writeable($key) &&
- !empty($dbdir->xml_loaded) &&
- !empty($dbdir->xml_changed)) {
- $b .= '<a href="index.php?action=revert_changes&sesskey=' . sesskey() . '&dir=' . urlencode(str_replace($CFG->dirroot, '', $key)) . '">[' . $this->str['revert'] . ']</a>';
- } else {
- $b .= '[' . $this->str['revert'] . ']';
- }
- $b .= '</td><td class="button cell">';
- // The unload button
- if ($dbdir->path_exists &&
- file_exists($key . '/install.xml') &&
- is_readable($key . '/install.xml') &&
- !empty($dbdir->xml_loaded) &&
- empty($dbdir->xml_changed)) {
- $b .= '<a href="index.php?action=unload_xml_file&dir=' . urlencode(str_replace($CFG->dirroot, '', $key)) . '&time=' . time() . '&postaction=main_view#lastused">[' . $this->str['unload'] . ']</a>';
- } else {
- $b .= '[' . $this->str['unload'] . ']';
- }
- $b .= '</td><td class="button cell">';
- // The delete button
- if ($dbdir->path_exists &&
- file_exists($key . '/install.xml') &&
- is_readable($key . '/install.xml') &&
- is_writeable($key) &&
- empty($dbdir->xml_loaded)) {
- $b .= '<a href="index.php?action=delete_xml_file&sesskey=' . sesskey() . '&dir=' . urlencode(str_replace($CFG->dirroot, '', $key)) . '">[' . $this->str['delete'] . ']</a>';
- } else {
- $b .= '[' . $this->str['delete'] . ']';
- }
- $b .= '</td>';
- // include the higlight
- if ($hithis) {
- $o .= '<tr class="highlight"><td class="directory cell"><a name="lastused" />' . $f . '</td>' . $b . '</tr>';
- } else {
- $o .= '<tr class="r' . $row . '"><td class="directory cell">' . $f . '</td>' . $b . '</tr>';
- }
- $row = ($row + 1) % 2;
- // show errors if they exist
- if (isset($dbdir->xml_file)) {
- if ($structure = $dbdir->xml_file->getStructure()) {
- $errors = !empty($this->errormsg) ? array($this->errormsg) : array();
- $structureerrors = $structure->getAllErrors();
- if ($structureerrors) {
- $errors = array_merge($errors, $structureerrors);
- }
- if (!empty($errors)) {
- if ($hithis) {
- $o .= '<tr class="highlight"><td class="error cell" colspan="10">' . implode (', ', $errors) . '</td></tr>';
- } else {
- $o .= '<tr class="r' . $row . '"><td class="error cell" colspan="10">' . implode (', ', $errors) . '</td></tr>';
- }
- }
- }
- }
- // If there are changes pending to be saved, but the file cannot be written... inform here
- if ($dbdir->path_exists &&
- file_exists($key . '/install.xml') &&
- !empty($dbdir->xml_loaded) &&
- !empty($dbdir->xml_changed) &&
- (!is_writeable($key . '/install.xml') || !is_writeable($key))) {
- if ($hithis) {
- $o .= '<tr class="highlight"><td class="error cell" colspan="10">';
- } else {
- $o .= '<tr class="r' . $row . '"><td class="error cell" colspan="10">';
- }
- $o .= $this->str['pendingchangescannotbesavedreload'];
- $o .= '</td></tr>';
- }
- }
- $o .= '</table>';
- // Set the output
- $this->output = $o;
- }
- // Finally, return result
- return $result;
- }
- }