admin/xmldb/actions/save_xml_file/save_xml_file.class.php

   1 <?php // $Id$
   2
   3 ///////////////////////////////////////////////////////////////////////////
   4 //                                                                       //
   5 // NOTICE OF COPYRIGHT                                                   //
   6 //                                                                       //
   7 // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
   8 //          http://moodle.com                                            //
   9 //                                                                       //
  10 // Copyright (C) 2001-3001 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 save one edited xml file
  28
  29 class save_xml_file extends XMLDBAction {
  30
  31     /**
  32      * Init method, every subclass will have its own
  33      */
  34     function init() {
  35         parent::init();
  36
  37     /// Set own custom attributes
  38
  39     /// Get needed strings
  40         $this->loadStrings(array(
  41             'filenotwriteable' => 'xmldb'
  42         ));
  43     }
  44
  45     /**
  46      * Invoke method, every class will have its own
  47      * returns true/false on completion, setting both
  48      * errormsg and output as necessary
  49      */
  50     function invoke() {
  51         parent::invoke();
  52
  53         $result = true;
  54
  55     /// Set own core attributes
  56         $this->does_generate = ACTION_NONE;
  57
  58     /// These are always here
  59         global $CFG, $XMLDB;
  60
  61     /// Do the job, setting result as needed
  62
  63     /// Get the dir containing the file
  64         $dirpath = required_param('dir', PARAM_PATH);
  65         $dirpath = $CFG->dirroot . stripslashes_safe($dirpath);
  66
  67     /// Get the edited dir
  68         if (!empty($XMLDB->editeddirs)) {
  69             if (isset($XMLDB->editeddirs[$dirpath])) {
  70                 $editeddir =& $XMLDB->editeddirs[$dirpath];
  71             }
  72         }
  73     /// Copy the edited dir over the original one
  74         if (!empty($XMLDB->dbdirs)) {
  75             if (isset($XMLDB->dbdirs[$dirpath])) {
  76                 $XMLDB->dbdirs[$dirpath] = unserialize(serialize($editeddir));
  77                 $dbdir =& $XMLDB->dbdirs[$dirpath];
  78             }
  79         }
  80
  81     /// Chech for perms
  82         if (!is_writeable($dirpath . '/install.xml')) {
  83             $this->errormsg = $this->str['filenotwriteable'] . '(' . $dirpath . '/install.xml)';
  84             return false;
  85         }
  86
  87     /// Save the original dir
  88         $result = $dbdir->xml_file->saveXMLFile();
  89
  90         if ($result) {
  91         /// Delete the edited dir
  92             unset ($XMLDB->editeddirs[$dirpath]);
  93         /// Unload de originaldir
  94             unset($XMLDB->dbdirs[$dirpath]->xml_file);
  95             unset($XMLDB->dbdirs[$dirpath]->xml_loaded);
  96             unset($XMLDB->dbdirs[$dirpath]->xml_changed);
  97             unset($XMLDB->dbdirs[$dirpath]->xml_exists);
  98             unset($XMLDB->dbdirs[$dirpath]->xml_writeable);
  99         } else {
 100             $this->errormsg = 'Error saving XML file (' . $dirpath . ')';
 101             return false;
 102         }
 103
 104     /// Launch postaction if exists (leave this here!)
 105         if ($this->getPostAction() && $result) {
 106             return $this->launch($this->getPostAction());
 107         }
 108
 109     /// Return ok if arrived here
 110         return $result;
 111     }
 112 }
 113 ?>