repository/local/repository.class.php

   1 <?php
   2
   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/>.
  17
  18 /**
  19  * repository_local class is used to browse moodle files
  20  *
  21  * @since 2.0
  22  * @package moodlecore
  23  * @subpackage repository
  24  * @copyright 2009 Dongsheng Cai
  25  * @author Dongsheng Cai <dongsheng@moodle.com>
  26  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  27  */
  28
  29 class repository_local extends repository {
  30
  31     /**
  32      * initialize local plugin
  33      * @param int $repositoryid
  34      * @param int $context
  35      * @param array $options
  36      */
  37     public function __construct($repositoryid, $context = SYSCONTEXTID, $options = array()) {
  38         parent::__construct($repositoryid, $context, $options);
  39     }
  40
  41     /**
  42      * local plugin doesn't require login, so list all files
  43      * @return mixed
  44      */
  45     public function print_login() {
  46         return $this->get_listing();
  47     }
  48
  49     /**
  50      * Not supported by File API yet
  51      * @param string $search_text
  52      * @return mixed
  53      */
  54     public function search($search_text) {
  55         return array();
  56     }
  57
  58     /**
  59      * Get file listing
  60      *
  61      * @param string $encodedpath
  62      * @return mixed
  63      */
  64     public function get_listing($encodedpath = '') {
  65         global $CFG, $USER, $OUTPUT;
  66         $ret = array();
  67         $ret['dynload'] = true;
  68         $ret['nosearch'] = true;
  69         $ret['nologin'] = true;
  70         $list = array();
  71
  72         if (!empty($encodedpath)) {
  73             $params = unserialize(base64_decode($encodedpath));
  74             if (is_array($params)) {
  75                 $itemid   = $params['itemid'];
  76                 $filename = $params['filename'];
  77                 $filearea = $params['filearea'];
  78                 $filepath = $params['filepath'];
  79                 $context  = get_context_instance_by_id($params['contextid']);
  80             }
  81         } else {
  82             $itemid   = null;
  83             $filename = null;
  84             $filearea = null;
  85             $filepath = null;
  86             $context  = get_system_context();
  87         }
  88
  89         try {
  90             $browser = get_file_browser();
  91
  92             if ($fileinfo = $browser->get_file_info($context, $filearea, $itemid, $filepath, $filename)) {
  93                 // build path navigation
  94                 $pathnodes = array();
  95                 $encodedpath = base64_encode(serialize($fileinfo->get_params()));
  96                 $pathnodes[] = array('name'=>$fileinfo->get_visible_name(), 'path'=>$encodedpath);
  97                 $level = $fileinfo->get_parent();
  98                 while ($level) {
  99                     $encodedpath = base64_encode(serialize($level->get_params()));
 100                     $pathnodes[] = array('name'=>$level->get_visible_name(), 'path'=>$encodedpath);
 101                     $level = $level->get_parent();
 102                 }
 103                 if (!empty($pathnodes) && is_array($pathnodes)) {
 104                     $pathnodes = array_reverse($pathnodes);
 105                     $ret['path'] = $pathnodes;
 106                 }
 107                 // build file tree
 108                 $children = $fileinfo->get_children();
 109                 foreach ($children as $child) {
 110                     if ($child->is_directory()) {
 111                         $params = $child->get_params();
 112                         $encodedpath = base64_encode(serialize($params));
 113                         // hide user_private area from local plugin, user should
 114                         // use private file plugin to access private files
 115                         if ($params['filearea'] == 'user_private') {
 116                             continue;
 117                         }
 118                         $node = array(
 119                             'title' => $child->get_visible_name(),
 120                             'size' => 0,
 121                             'date' => '',
 122                             'path' => $encodedpath,
 123                             'children'=>array(),
 124                             'thumbnail' => $OUTPUT->pix_url('f/folder-32') . ''
 125                         );
 126                         $list[] = $node;
 127                     } else {
 128                         $encodedpath = base64_encode(serialize($child->get_params()));
 129                         $icon = 'f/'.str_replace('.gif', '', mimeinfo('icon', $child->get_visible_name())).'-32';
 130                         $node = array(
 131                             'title' => $child->get_visible_name(),
 132                             'size' => 0,
 133                             'date' => '',
 134                             'source'=> $encodedpath,
 135                             'thumbnail' => $OUTPUT->pix_url($icon) . '',
 136                         );
 137                         $list[] = $node;
 138                     }
 139                 }
 140             }
 141         } catch (Exception $e) {
 142             throw new repository_exception('emptyfilelist', 'repository_local');
 143         }
 144         $ret['list'] = $list;
 145         $ret['list'] = array_filter($list, array($this, 'filter'));
 146         return $ret;
 147     }
 148
 149     /**
 150      * Set repository name
 151      *
 152      * @return string repository name
 153      */
 154     public function get_name(){
 155         return get_string('repositoryname', 'repository_local');;
 156     }
 157
 158     /**
 159      * Local file don't support to link to external links
 160      *
 161      * @return int
 162      */
 163     public function supported_returntypes() {
 164         return FILE_INTERNAL;
 165     }
 166
 167     /**
 168      * Copy a file to file area
 169      *
 170      * @global object $USER
 171      * @global object $DB
 172      * @param string $encoded The metainfo of file, it is base64 encoded php seriablized data
 173      * @param string $new_filename The intended name of file
 174      * @param string $new_itemid itemid
 175      * @param string $new_filepath the new path in draft area
 176      * @return array The information of file
 177      */
 178     public function copy_to_area($encoded, $new_filearea='user_draft', $new_itemid = '', $new_filepath = '/', $new_filename = '') {
 179         global $USER, $DB;
 180         $info = array();
 181
 182         $browser = get_file_browser();
 183         $params = unserialize(base64_decode($encoded));
 184         $user_context = get_context_instance(CONTEXT_USER, $USER->id);
 185         // the final file
 186         $contextid  = $params['contextid'];
 187         $filearea   = $params['filearea'];
 188         $filepath   = $params['filepath'];
 189         $filename   = $params['filename'];
 190         $fileitemid = $params['itemid'];
 191         $context    = get_context_instance_by_id($contextid);
 192         try {
 193             $file_info = $browser->get_file_info($context, $filearea, $fileitemid, $filepath, $filename);
 194             $file_info->copy_to_storage($user_context->id, $new_filearea, $new_itemid, $new_filepath, $new_filename);
 195         } catch (Exception $e) {
 196             throw $e;
 197         }
 198
 199         $info['itemid'] = $new_itemid;
 200         $info['title']  = $new_filename;
 201         $info['contextid'] = $user_context->id;
 202         $info['filesize'] = $file_info->get_filesize();
 203
 204         return $info;
 205     }
 206 }