You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
103 lines
3.4 KiB
103 lines
3.4 KiB
<?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/>.
|
|
|
|
/**
|
|
* @package moodlecore
|
|
* @subpackage backup-helper
|
|
* @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
/**
|
|
* Collection of helper functions to handle files
|
|
*
|
|
* This class implements various functions related with moodle storage
|
|
* handling (get file from storage, put it there...) and some others
|
|
* to use the zip/unzip facilities.
|
|
*
|
|
* Note: It's supposed that, some day, files implementation will offer
|
|
* those functions without needeing to know storage internals at all.
|
|
* That day, we'll move related functions here to proper file api ones.
|
|
*
|
|
* TODO: Finish phpdocs
|
|
*/
|
|
class backup_file_manager {
|
|
|
|
/**
|
|
* Returns the full path to backup storage base dir
|
|
*/
|
|
public static function get_backup_storage_base_dir($backupid) {
|
|
global $CFG;
|
|
|
|
$backupiddir = make_backup_temp_directory($backupid);
|
|
return $backupiddir . '/files';
|
|
}
|
|
|
|
/**
|
|
* Given one file content hash, returns the path (relative to filedir)
|
|
* to the file.
|
|
*/
|
|
public static function get_backup_content_file_location($contenthash) {
|
|
$l1 = $contenthash[0].$contenthash[1];
|
|
return "$l1/$contenthash";
|
|
}
|
|
|
|
/**
|
|
* Copy one file from moodle storage to backup storage
|
|
*/
|
|
public static function copy_file_moodle2backup($backupid, $filerecorid) {
|
|
global $DB;
|
|
|
|
if (!backup_controller_dbops::backup_includes_files($backupid)) {
|
|
// Only include the files if required by the controller.
|
|
return;
|
|
}
|
|
|
|
// Normalise param
|
|
if (!is_object($filerecorid)) {
|
|
$filerecorid = $DB->get_record('files', array('id' => $filerecorid));
|
|
}
|
|
|
|
// Directory, nothing to do
|
|
if ($filerecorid->filename === '.') {
|
|
return;
|
|
}
|
|
|
|
$fs = get_file_storage();
|
|
$file = $fs->get_file_instance($filerecorid);
|
|
// If the file is external file, skip copying.
|
|
if ($file->is_external_file()) {
|
|
return;
|
|
}
|
|
|
|
// Calculate source and target paths (use same subdirs strategy for both)
|
|
$targetfilepath = self::get_backup_storage_base_dir($backupid) . '/' .
|
|
self::get_backup_content_file_location($filerecorid->contenthash);
|
|
|
|
// Create target dir if necessary
|
|
if (!file_exists(dirname($targetfilepath))) {
|
|
if (!check_dir_exists(dirname($targetfilepath), true, true)) {
|
|
throw new backup_helper_exception('cannot_create_directory', dirname($targetfilepath));
|
|
}
|
|
}
|
|
|
|
// And copy the file (if doesn't exist already)
|
|
if (!file_exists($targetfilepath)) {
|
|
$file->copy_content_to($targetfilepath);
|
|
}
|
|
}
|
|
}
|
|
|