C:/xampp/htdocs/moodle/lib/filestorage/file_archive.php

Go to the documentation of this file.

<?php

// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.


defined('MOODLE_INTERNAL') || die();

abstract class file_archive implements Iterator {

    const OPEN      = 1;

    const CREATE    = 2;

    const OVERWRITE = 4;

    protected $encoding = 'utf-8';

    public abstract function open($archivepathname, $mode=file_archive::CREATE, $encoding='utf-8');

    public abstract function close();

    public abstract function get_stream($index);

    public abstract function get_info($index);

    public abstract function list_files();

    public abstract function count();

    public abstract function add_file_from_pathname($localname, $pathname);

    public abstract function add_file_from_string($localname, $contents);

    public abstract function add_directory($localname);

    protected function mangle_pathname($localname) {
        if ($this->encoding === 'utf-8') {
            return $localname;
        }
        $textlib = textlib_get_instance();

        $converted = $textlib->convert($localname, 'utf-8', $this->encoding);
        $original  = $textlib->convert($converted, $this->encoding, 'utf-8');

        if ($original === $localname) {
            $result = $converted;

        } else {
            // try ascii conversion
            $converted2 = $textlib->specialtoascii($localname);
            $converted2 = $textlib->convert($converted2, 'utf-8', $this->encoding);
            $original2  = $textlib->convert($converted, $this->encoding, 'utf-8');

            if ($original2 === $localname) {
                //this looks much better
                $result = $converted2;
            } else {
                //bad luck - the file name may not be usable at all
                $result = $converted;
            }
        }

        $result = preg_replace('/\.\.+/', '', $result);
        $result = ltrim($result); // no leading /

        if ($result === '.') {
            $result = '';
        }

        return $result;
    }

    protected function unmangle_pathname($localname) {
        $result = str_replace('\\', '/', $localname); // no MS \ separators
        $result = ltrim($result, '/');                // no leading /

        if ($this->encoding !== 'utf-8') {
            $result = textlib_get_instance()->convert($result, $this->encoding, 'utf-8');
        }

        return clean_param($result, PARAM_PATH);
    }

    //public abstract function current();

    //public abstract function key();

    //public abstract function next();

    //public abstract function rewind();

    //public abstract function valid();

}