MDL-24381 backup - avoid infinite iteration under windows caused by platform-dependen...
[moodle.git] / backup / util / xml / parser / processors / simplified_parser_processor.class.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * @package moodlecore
20  * @subpackage xml
21  * @copyright 2003 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 require_once($CFG->dirroot.'/backup/util/xml/parser/processors/progressive_parser_processor.class.php');
27 /**
28  * Abstract xml parser processor to to simplify and dispatch parsed chunks
29  *
30  * This @progressive_parser_processor handles the requested paths,
31  * performing some conversions from the original "propietary array format"
32  * used by the @progressive_parser to a simplified structure to be used
33  * easily. Found attributes are converted automatically to tags and cdata
34  * to simpler values.
35  *
36  * Note: final tag attributes are discarded completely!
37  *
38  * TODO: Complete phpdocs
39  */
40 abstract class simplified_parser_processor extends progressive_parser_processor {
41     protected $paths;       // array of paths we are interested on
42     protected $parentpaths; // array of parent paths of the $paths
43     protected $parentsinfo; // array of parent attributes to be added as child tags
45     public function __construct(array $paths) {
46         parent::__construct();
47         $this->paths = array();
48         $this->parentpaths = array();
49         $this->parentsinfo = array();
50         // Add paths and parentpaths. We are looking for attributes there
51         foreach ($paths as $key => $path) {
52             $this->add_path($path);
53         }
54     }
56     public function add_path($path) {
57         $this->paths[] = $path;
58         $this->parentpaths[] = progressive_parser::dirname($path);
59     }
61     /**
62      * Get the already simplified chunk and dispatch it
63      */
64     abstract protected function dispatch_chunk($data);
66     /**
67      * Get one chunk of parsed data and make it simpler
68      * adding attributes as tags and delegating to
69      * dispatch_chunk() the procesing of the resulting chunk
70      */
71     public function process_chunk($data) {
72         // Precalculate some vars for readability
73         $path = $data['path'];
74         $parentpath = progressive_parser::dirname($path);
75         $tag = basename($path);
77         // If the path is a registered parent one, store all its tags
78         // so, we'll be able to find attributes later when processing
79         // (child) registered paths (to get attributes if present)
80         if ($this->path_is_selected_parent($path)) { // if path is parent
81             if (isset($data['tags'])) {              // and has tags, save them
82                 $this->parentsinfo[$path] = $data['tags'];
83             }
84         }
86         // If the path is a registered one, let's process it
87         if ($this->path_is_selected($path)) {
88             // First of all, look for attributes available at parentsinfo
89             // in order to get them available as normal tags
90             if (isset($this->parentsinfo[$parentpath][$tag]['attrs'])) {
91                 $data['tags'] = array_merge($this->parentsinfo[$parentpath][$tag]['attrs'], $data['tags']);
92                 unset($this->parentsinfo[$parentpath][$tag]['attrs']);
93             }
94             // Now, let's simplify the tags array, ignoring tag attributtes and
95             // reconverting to simpler name => value array. At the same time,
96             // check for all the tag values being whitespace-string values, if all them
97             // are whitespace strings, we aren't going to postprocess/dispatch the chunk
98             $alltagswhitespace = true;
99             foreach ($data['tags'] as $key => $value) {
100                 // If the value is already a single value, do nothing
101                 // surely was added above from parentsinfo attributes,
102                 // so we'll process the chunk always
103                 if (!is_array($value)) {
104                     $alltagswhitespace = false;
105                     continue;
106                 }
107                 // If the path including the tag name matches another selected path
108                 // (registered or parent) delete it, another chunk will contain that info
109                 if ($this->path_is_selected($path . '/' . $key) ||
110                     $this->path_is_selected_parent($path . '/' . $key)) {
111                     unset($data['tags'][$key]);
112                     continue;
113                 }
114                 // Convert to simple name => value array
115                 $data['tags'][$key] = isset($value['cdata']) ? $value['cdata'] : null;
117                 // Check $alltagswhitespace continues being true
118                 if ($alltagswhitespace && strlen($data['tags'][$key]) !== 0 && trim($data['tags'][$key]) !== '') {
119                     $alltagswhitespace = false; // Found non-whitespace value
120                 }
121             }
123             // Arrived here, if the chunk has tags and not all tags are whitespace,
124             // send it to postprocess filter that will decide about dispatching. Else
125             // skip the chunk completely
126             if (!empty($data['tags']) && !$alltagswhitespace) {
127                 return $this->postprocess_chunk($data);
128             } else {
129                 $this->chunks--; // Chunk skipped
130             }
131         } else {
132             $this->chunks--; // Chunk skipped
133         }
134         return true;
135     }
137 // Protected API starts here
139     protected function postprocess_chunk($data) {
140         $this->dispatch_chunk($data);
141     }
143     protected function path_is_selected($path) {
144         return in_array($path, $this->paths);
145     }
147     protected function path_is_selected_parent($path) {
148         return in_array($path, $this->parentpaths);
149     }