f0ecc7edd9a0f037739216599ba984ae4de43a6c
[moodle.git] / admin / tool / xmldb / actions / main_view / main_view.class.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * @package    tool_xmldb
19  * @copyright  2003 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
20  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
21  */
23 /**
24  * This class will show all the actions available under the XMLDB editor interface
25  *
26  * From here, files can be created, edited, saved and deleted, plus some
27  * extra utilities like displaying docs, xml info and performing various consistency tests
28  *
29  * @package    tool_xmldb
30  * @copyright  2003 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
31  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
32  */
33 class main_view extends XMLDBAction {
35     /**
36      * Init method, every subclass will have its own
37      */
38     function init() {
39         parent::init();
41         // Set own custom attributes
42         $this->sesskey_protected = false; // This action doesn't need sesskey protection
44         // Get needed strings
45         $this->loadStrings(array(
46             'load' => 'tool_xmldb',
47             'create' => 'tool_xmldb',
48             'edit' => 'tool_xmldb',
49             'save' => 'tool_xmldb',
50             'revert' => 'tool_xmldb',
51             'unload' => 'tool_xmldb',
52             'delete' => 'tool_xmldb',
53             'reservedwords' => 'tool_xmldb',
54             'gotolastused' => 'tool_xmldb',
55             'checkindexes' => 'tool_xmldb',
56             'checkdefaults' => 'tool_xmldb',
57             'checkforeignkeys' => 'tool_xmldb',
58             'checkbigints' => 'tool_xmldb',
59             'checkoraclesemantics' => 'tool_xmldb',
60             'doc' => 'tool_xmldb',
61             'viewxml' => 'tool_xmldb',
62             'pendingchangescannotbesavedreload' => 'tool_xmldb'
63         ));
64     }
66     /**
67      * Invoke method, every class will have its own
68      * returns true/false on completion, setting both
69      * errormsg and output as necessary
70      */
71     function invoke() {
72         parent::invoke();
74         $result = true;
76         // Set own core attributes
77         $this->does_generate = ACTION_GENERATE_HTML;
79         // These are always here
80         global $CFG, $XMLDB, $SESSION, $DB;
82         // Get lastused
83         $o = '';
84         if (isset($SESSION->lastused)) {
85             if ($lastused = $SESSION->lastused) {
86                 // Print link
87                 $o .= '<p class="centerpara"><a href="#lastused">' . $this->str['gotolastused'] . '</a></p>';
88             }
89         } else {
90             $lastused = NULL;
91         }
93         // Calculate the buttons
94         $b = '<p class="centerpara buttons">';
95         // The reserved_words button
96         $b .= '&nbsp;<a href="index.php?action=view_reserved_words">[' . $this->str['reservedwords'] . ']</a>';
97         // The docs button
98         $b .= '&nbsp;<a href="index.php?action=generate_all_documentation">[' . $this->str['doc'] . ']</a>';
99         // The check indexes button
100         $b .= '&nbsp;<a href="index.php?action=check_indexes&amp;sesskey=' . sesskey() . '">[' . $this->str['checkindexes'] . ']</a>';
101         // The check defaults button
102         $b .= '&nbsp;<a href="index.php?action=check_defaults&amp;sesskey=' . sesskey() . '">[' . $this->str['checkdefaults'] . ']</a>';
103         // The check bigints button (only for MySQL and PostgreSQL) MDL-11038a
104         if ($DB->get_dbfamily() == 'mysql' || $DB->get_dbfamily() == 'postgres') {
105             $b .= '&nbsp;<a href="index.php?action=check_bigints&amp;sesskey=' . sesskey() . '">[' . $this->str['checkbigints'] . ']</a>';
106         }
107         // The check semantics button (only for Oracle) MDL-29416
108         if ($DB->get_dbfamily() == 'oracle') {
109             $b .= '&nbsp;<a href="index.php?action=check_oracle_semantics&amp;sesskey=' . sesskey() . '">[' . $this->str['checkoraclesemantics'] . ']</a>';
110         }
111         $b .= '&nbsp;<a href="index.php?action=check_foreign_keys&amp;sesskey=' . sesskey() . '">[' . $this->str['checkforeignkeys'] . ']</a>';
112         $b .= '</p>';
113         // Send buttons to output
114         $o .= $b;
116         // Do the job
118         // Get the list of DB directories
119         $result = $this->launch('get_db_directories');
120         // Display list of DB directories if everything is ok
121         if ($result && !empty($XMLDB->dbdirs)) {
122             $o .= '<table id="listdirectories" border="0" cellpadding="5" cellspacing="1" class="boxaligncenter flexible">';
123             $row = 0;
124             foreach ($XMLDB->dbdirs as $key => $dbdir) {
125                 // Detect if this is the lastused dir
126                 $hithis = false;
127                 if (str_replace($CFG->dirroot, '', $key) == $lastused) {
128                     $hithis = true;
129                 }
130                 $elementtext = str_replace($CFG->dirroot . '/', '', $key);
131                 // Calculate the dbdir has_changed field if needed
132                 if (!isset($dbdir->has_changed) && isset($dbdir->xml_loaded)) {
133                     $dbdir->xml_changed = false;
134                     if (isset($XMLDB->editeddirs[$key])) {
135                         $editeddir = $XMLDB->editeddirs[$key];
136                         if (isset($editeddir->xml_file)) {
137                             $structure = $editeddir->xml_file->getStructure();
138                             if ($structure->hasChanged()) {
139                                 $dbdir->xml_changed = true;
140                                 $editeddir->xml_changed = true;
141                             }
142                         }
143                     }
144                 }
145                 // The file name (link to edit if the file is loaded)
146                 if ($dbdir->path_exists &&
147                     file_exists($key . '/install.xml') &&
148                     is_readable($key . '/install.xml') &&
149                     is_readable($key) &&
150                     !empty($dbdir->xml_loaded)) {
151                     $f = '<a href="index.php?action=edit_xml_file&amp;dir=' . urlencode(str_replace($CFG->dirroot, '', $key)) . '">' . $elementtext . '</a>';
152                 } else {
153                     $f = $elementtext;
154                 }
155                 // Calculate the buttons
156                 $b = ' <td class="button cell">';
157                 // The create button
158                 if ($dbdir->path_exists &&
159                     !file_exists($key . '/install.xml') &&
160                     is_writeable($key)) {
161                     $b .= '<a href="index.php?action=create_xml_file&amp;sesskey=' . sesskey() . '&amp;dir=' . urlencode(str_replace($CFG->dirroot, '', $key)) . '&amp;time=' . time() . '&amp;postaction=main_view#lastused">[' . $this->str['create'] . ']</a>';
162                 } else {
163                     $b .= '[' . $this->str['create'] . ']';
164                 }
165                 $b .= '</td><td class="button cell">';
166                 // The load button
167                 if ($dbdir->path_exists &&
168                     file_exists($key . '/install.xml') &&
169                     is_readable($key . '/install.xml') &&
170                     empty($dbdir->xml_loaded)) {
171                     $b .= '<a href="index.php?action=load_xml_file&amp;dir=' . urlencode(str_replace($CFG->dirroot, '', $key)) . '&amp;time=' . time() . '&amp;postaction=main_view#lastused">[' . $this->str['load'] . ']</a>';
172                 } else {
173                     $b .= '[' . $this->str['load'] . ']';
174                 }
175                 $b .= '</td><td class="button cell">';
176                 // The edit button
177                 if ($dbdir->path_exists &&
178                     file_exists($key . '/install.xml') &&
179                     is_readable($key . '/install.xml') &&
180                     is_readable($key) &&
181                     !empty($dbdir->xml_loaded)) {
182                     $b .= '<a href="index.php?action=edit_xml_file&amp;dir=' . urlencode(str_replace($CFG->dirroot, '', $key)) . '">[' . $this->str['edit'] . ']</a>';
183                 } else {
184                     $b .= '[' . $this->str['edit'] . ']';
185                 }
186                 $b .= '</td><td class="button cell">';
187                 // The save button
188                 if ($dbdir->path_exists &&
189                     file_exists($key . '/install.xml') &&
190                     is_writeable($key . '/install.xml') &&
191                     is_writeable($key) &&
192                     !empty($dbdir->xml_loaded) &&
193                     !empty($dbdir->xml_changed)) {
194                     $b .= '<a href="index.php?action=save_xml_file&amp;sesskey=' . sesskey() . '&amp;dir=' . urlencode(str_replace($CFG->dirroot, '', $key)) . '&amp;time=' . time() . '&amp;postaction=main_view#lastused">[' . $this->str['save'] . ']</a>';
195                     // Check if the file has been manually edited while being modified in the editor
196                     if ($dbdir->filemtime != filemtime($key . '/install.xml')) {
197                         // File manually modified. Add to errors.
198                         if ($structure = $dbdir->xml_file->getStructure()) {
199                             $structure->errormsg = 'Warning: File locally modified while using the XMLDB Editor. Saving will overwrite local changes';
200                         }
201                     }
202                 } else {
203                     $b .= '[' . $this->str['save'] . ']';
204                 }
205                 $b .= '</td><td class="button cell">';
206                 // The document button
207                 if ($dbdir->path_exists &&
208                     file_exists($key . '/install.xml') &&
209                     is_readable($key . '/install.xml') &&
210                     is_readable($key)) {
211                     $b .= '<a href="index.php?action=generate_documentation&amp;dir=' . urlencode(str_replace($CFG->dirroot, '', $key)) . '">[' . $this->str['doc'] . ']</a>';
212                 } else {
213                     $b .= '[' . $this->str['doc'] . ']';
214                 }
215                 $b .= '</td><td class="button cell">';
216                 // The view xml button
217                 if ($dbdir->path_exists &&
218                     file_exists($key . '/install.xml') &&
219                     is_readable($key . '/install.xml')) {
220                     $b .= '<a href="index.php?action=view_xml&amp;file=' . urlencode(str_replace($CFG->dirroot, '', $key) . '/install.xml') . '">[' . $this->str['viewxml'] . ']</a>';
221                 } else {
222                     $b .= '[' . $this->str['viewxml'] . ']';
223                 }
224                 $b .= '</td><td class="button cell">';
225                 // The revert button
226                 if ($dbdir->path_exists &&
227                     file_exists($key . '/install.xml') &&
228                     is_readable($key . '/install.xml') &&
229                     is_writeable($key) &&
230                     !empty($dbdir->xml_loaded) &&
231                     !empty($dbdir->xml_changed)) {
232                     $b .= '<a href="index.php?action=revert_changes&amp;sesskey=' . sesskey() . '&amp;dir=' . urlencode(str_replace($CFG->dirroot, '', $key)) . '">[' . $this->str['revert'] . ']</a>';
233                 } else {
234                     $b .= '[' . $this->str['revert'] . ']';
235                 }
236                 $b .= '</td><td class="button cell">';
237                 // The unload button
238                 if ($dbdir->path_exists &&
239                     file_exists($key . '/install.xml') &&
240                     is_readable($key . '/install.xml') &&
241                     !empty($dbdir->xml_loaded) &&
242                     empty($dbdir->xml_changed)) {
243                     $b .= '<a href="index.php?action=unload_xml_file&amp;dir=' . urlencode(str_replace($CFG->dirroot, '', $key)) . '&amp;time=' . time() . '&amp;postaction=main_view#lastused">[' . $this->str['unload'] . ']</a>';
244                 } else {
245                     $b .= '[' . $this->str['unload'] . ']';
246                 }
247                 $b .= '</td><td class="button cell">';
248                 // The delete button
249                 if ($dbdir->path_exists &&
250                     file_exists($key . '/install.xml') &&
251                     is_readable($key . '/install.xml') &&
252                     is_writeable($key) &&
253                     empty($dbdir->xml_loaded)) {
254                     $b .= '<a href="index.php?action=delete_xml_file&amp;sesskey=' . sesskey() . '&amp;dir=' . urlencode(str_replace($CFG->dirroot, '', $key)) . '">[' . $this->str['delete'] . ']</a>';
255                 } else {
256                     $b .= '[' . $this->str['delete'] . ']';
257                 }
258                 $b .= '</td>';
259                 // include the higlight
260                 if ($hithis) {
261                     $o .= '<tr class="highlight"><td class="directory cell"><a name="lastused" />' . $f . '</td>' . $b . '</tr>';
262                 } else {
263                     $o .= '<tr class="r' . $row . '"><td class="directory cell">' . $f . '</td>' . $b . '</tr>';
264                 }
265                 $row = ($row + 1) % 2;
266                 // show errors if they exist
267                 if (isset($dbdir->xml_file)) {
268                     if ($structure = $dbdir->xml_file->getStructure()) {
269                         if ($errors = $structure->getAllErrors()) {
270                             if ($hithis) {
271                                 $o .= '<tr class="highlight"><td class="error cell" colspan="10">' . implode (', ', $errors) . '</td></tr>';
272                             } else {
273                                 $o .= '<tr class="r' . $row . '"><td class="error cell" colspan="10">' . implode (', ', $errors) . '</td></tr>';
274                             }
275                         }
276                     }
277                 }
278                 // If there are changes pending to be saved, but the file cannot be written... inform here
279                 if ($dbdir->path_exists &&
280                     file_exists($key . '/install.xml') &&
281                     !empty($dbdir->xml_loaded) &&
282                     !empty($dbdir->xml_changed) &&
283                     (!is_writeable($key . '/install.xml') || !is_writeable($key))) {
285                     if ($hithis) {
286                         $o .= '<tr class="highlight"><td class="error cell" colspan="10">';
287                     } else {
288                         $o .= '<tr class="r' . $row . '"><td class="error cell" colspan="10">';
289                     }
290                     $o .= $this->str['pendingchangescannotbesavedreload'];
291                     $o .= '</td></tr>';
292                 }
293             }
294             $o .= '</table>';
296             // Set the output
297             $this->output = $o;
298         }
300         // Finally, return result
301         return $result;
302     }