admin/xmldb/actions/view_xml/view_xml.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 display one XML file
  28
  29 class view_xml 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_GENERATE_XML;
  60
  61     /// These are always here
  62         global $CFG, $XMLDB;
  63
  64     /// Do the job, setting result as needed
  65
  66     /// Get the file parameter
  67         $file = required_param('file', PARAM_PATH);
  68         $file = $CFG->dirroot . stripslashes_safe($file);
  69     /// File must be under $CFG->wwwroot and
  70     ///  under one db directory (simple protection)
  71         if (substr($file, 0, strlen($CFG->dirroot)) == $CFG->dirroot &&
  72             substr(dirname($file), -2, 2) == 'db') {
  73         /// Everything is ok. Load the file to memory
  74             $this->output = file_get_contents($file);
  75         } else {
  76         /// Switch to HTML and error
  77             $this->does_generate = ACTION_GENERATE_HTML;
  78             $this->errormsg = 'File not viewable (' . $file .')';
  79             $result = false;
  80         }
  81
  82     /// Return ok if arrived here
  83         return $result;
  84     }
  85 }
  86 ?>