[Summary view] [Print] [Text view]

   1  <?php // $Id: load_xml_file.class.php,v 1.7 2007/10/10 05:25:26 nicolasconnault Exp $
   2  
   3  ///////////////////////////////////////////////////////////////////////////
   4  //                                                                       //
   5  // NOTICE OF COPYRIGHT                                                   //
   6  //                                                                       //
   7  // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
   8  //          http://moodle.com                                            //
   9  //                                                                       //
  10  // Copyright (C) 1999 onwards Martin Dougiamas        http://dougiamas.com  //
  11  //           (C) 2001-3001 Eloy Lafuente (stronk7) http://contiento.com  //
  12  //                                                                       //
  13  // This program is free software; you can redistribute it and/or modify  //
  14  // it under the terms of the GNU General Public License as published by  //
  15  // the Free Software Foundation; either version 2 of the License, or     //
  16  // (at your option) any later version.                                   //
  17  //                                                                       //
  18  // This program is distributed in the hope that it will be useful,       //
  19  // but WITHOUT ANY WARRANTY; without even the implied warranty of        //
  20  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
  21  // GNU General Public License for more details:                          //
  22  //                                                                       //
  23  //          http://www.gnu.org/copyleft/gpl.html                         //
  24  //                                                                       //
  25  ///////////////////////////////////////////////////////////////////////////
  26  
  27  /// This class will load one XML file to memory if necessary
  28  
  29  class load_xml_file extends XMLDBAction {
  30  
  31      /**
  32       * Init method, every subclass will have its own
  33       */
  34      function init() {
  35          parent::init();
  36      /// Set own core attributes
  37          $this->can_subaction = ACTION_NONE;
  38          //$this->can_subaction = ACTION_HAVE_SUBACTIONS;
  39  
  40      /// Set own custom attributes
  41  
  42      /// Get needed strings
  43          $this->loadStrings(array(
  44          /// 'key' => 'module',
  45          ));
  46      }
  47  
  48      /**
  49       * Invoke method, every class will have its own
  50       * returns true/false on completion, setting both
  51       * errormsg and output as necessary
  52       */
  53      function invoke() {
  54          parent::invoke();
  55  
  56          $result = true;
  57  
  58      /// Set own core attributes
  59          $this->does_generate = ACTION_NONE;
  60          //$this->does_generate = ACTION_GENERATE_HTML;
  61  
  62      /// These are always here
  63          global $CFG, $XMLDB;
  64  
  65      /// Do the job, setting $result as needed
  66  
  67      /// Get the dir containing the file
  68          $dirpath = required_param('dir', PARAM_PATH);
  69          $dirpath = $CFG->dirroot . stripslashes_safe($dirpath);
  70  
  71      /// Get the correct dir
  72          if (!empty($XMLDB->dbdirs)) {
  73              $dbdir =& $XMLDB->dbdirs[$dirpath];
  74              if ($dbdir) {
  75              /// Set some defaults
  76                  $dbdir->xml_exists = false;
  77                  $dbdir->xml_writeable = false;
  78                  $dbdir->xml_loaded  = false;
  79              ///Only if the directory exists
  80                  if (!$dbdir->path_exists) {
  81                      return false;
  82                  }
  83                  $xmldb_file = new XMLDBFile($dbdir->path . '/install.xml');
  84              ///Set the XML DTD and schema
  85                  $xmldb_file->setDTD($CFG->dirroot . '/lib/xmldb/xmldb.dtd');
  86                  $xmldb_file->setSchema($CFG->dirroot . '/lib/xmldb/xmldb.xsd');
  87              /// Set dbdir as necessary
  88                  if ($xmldb_file->fileExists()) {
  89                      $dbdir->xml_exists = true;
  90                  }
  91                  if ($xmldb_file->fileWriteable()) {
  92                      $dbdir->xml_writeable = true;
  93                  }
  94              /// Load the XML contents to structure
  95                  $loaded = $xmldb_file->loadXMLStructure();
  96                  if ($loaded && $xmldb_file->isLoaded()) {
  97                      $dbdir->xml_loaded = true;
  98                      $dbdir->filemtime = filemtime($dbdir->path . '/install.xml'); 
  99                  }
 100                  $dbdir->xml_file = $xmldb_file;
 101              } else {
 102                  $this->errormsg = 'Wrong directory (' . $dirpath . ')';
 103                  $result = false;
 104              }
 105          } else {
 106              $this->errormsg = 'XMLDB structure not found';
 107              $result = false;
 108          }
 109      /// Launch postaction if exists
 110          if ($this->getPostAction() && $result) {
 111              return $this->launch($this->getPostAction());
 112          }
 113  
 114          return $result;
 115      }
 116  }
 117  ?>