ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
class.ilObjFolder.php
Go to the documentation of this file.
1<?php
2/*
3 +-----------------------------------------------------------------------------+
4 | ILIAS open source |
5 +-----------------------------------------------------------------------------+
6 | Copyright (c) 1998-2001 ILIAS open source, University of Cologne |
7 | |
8 | This program is free software; you can redistribute it and/or |
9 | modify it under the terms of the GNU General Public License |
10 | as published by the Free Software Foundation; either version 2 |
11 | of the License, or (at your option) any later version. |
12 | |
13 | This program is distributed in the hope that it will be useful, |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
16 | GNU General Public License for more details. |
17 | |
18 | You should have received a copy of the GNU General Public License |
19 | along with this program; if not, write to the Free Software |
20 | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
21 +-----------------------------------------------------------------------------+
22*/
23
24require_once "./Services/Container/classes/class.ilContainer.php";
25
35{
37
44 function ilObjFolder($a_id = 0,$a_call_by_reference = true)
45 {
46 $this->type = "fold";
47 parent::__construct($a_id,$a_call_by_reference);
48 $this->lng->loadLanguageModule('fold');
49 }
50
51 function setFolderTree($a_tree)
52 {
53 $this->folder_tree =& $a_tree;
54 }
55
64 public function cloneObject($a_target_id,$a_copy_id = 0)
65 {
66 $new_obj = parent::cloneObject($a_target_id,$a_copy_id);
67
68 // Copy learning progress settings
69 include_once('Services/Tracking/classes/class.ilLPObjSettings.php');
70 $obj_settings = new ilLPObjSettings($this->getId());
71 $obj_settings->cloneSettings($new_obj->getId());
72 unset($obj_settings);
73
74 return $new_obj;
75 }
76
81 function putInTree($a_parent)
82 {
83 global $tree;
84
85 if (!is_object($this->folder_tree))
86 {
87 $this->folder_tree =& $tree;
88 }
89
90 if ($this->withReferences())
91 {
92 // put reference id into tree
93 $this->folder_tree->insertNode($this->getRefId(), $a_parent);
94 }
95 else
96 {
97 // put object id into tree
98 $this->folder_tree->insertNode($this->getId(), $a_parent);
99 }
100 }
101
110 public function cloneDependencies($a_target_id,$a_copy_id)
111 {
112 parent::cloneDependencies($a_target_id,$a_copy_id);
113
114 include_once('Services/Object/classes/class.ilObjectActivation.php');
115 ilObjectActivation::cloneDependencies($this->getRefId(), $a_target_id, $a_copy_id);
116
117 return true;
118 }
119
128 private static function recurseFolder ($refid, $title, $tmpdir) {
129 global $rbacsystem, $tree, $ilAccess;
130
131 $tmpdir = $tmpdir.DIRECTORY_SEPARATOR.ilUtil::getASCIIFilename($title);
132 ilUtil::makeDir($tmpdir);
133
134 $subtree = $tree->getChildsByTypeFilter($refid, array("fold","file"));
135
136 foreach ($subtree as $child)
137 {
138 if (!$ilAccess->checkAccess("read", "", $child["ref_id"]))
139 {
140 continue;
141 }
142 if (ilObject::_isInTrash($child["ref_id"]))
143 {
144 continue;
145 }
146 if ($child["type"] == "fold")
147 {
148 ilObjFolder::recurseFolder ($child["ref_id"], $child["title"], $tmpdir);
149 } else {
150 $newFilename = $tmpdir.DIRECTORY_SEPARATOR.ilUtil::getASCIIFilename($child["title"]);
151 // copy to temporal directory
152 $oldFilename = ilObjFile::_lookupAbsolutePath($child["obj_id"]);
153 if (!copy ($oldFilename, $newFilename))
154 {
155 throw new ilFileException("Could not copy ".$oldFilename." to ".$newFilename);
156 }
157 touch($newFilename, filectime($oldFilename));
158 }
159 }
160
161 }
162
163 public function downloadFolder() {
164 global $lng, $rbacsystem, $ilAccess;
165 include_once "./Services/Utilities/classes/class.ilUtil.php";
166 include_once 'Modules/File/classes/class.ilObjFile.php';
167 include_once 'Modules/File/classes/class.ilFileException.php';
168 if (!$ilAccess->checkAccess("read", "", $this->getRefId()))
169 {
170 $this->ilErr->raiseError(get_class($this)."::downloadFolder(): missing read permission!",$this->ilErr->WARNING);
171 }
172 if (ilObject::_isInTrash($this->getRefId()))
173 {
174 $this->ilErr->raiseError(get_class($this)."::downloadFolder(): object is trashed!",$this->ilErr->WARNING);
175 }
176
177 $zip = PATH_TO_ZIP;
178 $tmpdir = ilUtil::ilTempnam();
179 ilUtil::makeDir($tmpdir);
180 $basename = ilUtil::getAsciiFilename($this->getTitle());
181 $deliverFilename = $basename.".zip";
182 $zipbasedir = $tmpdir.DIRECTORY_SEPARATOR.$basename;
183 $tmpzipfile = $tmpdir.DIRECTORY_SEPARATOR.$deliverFilename;
184
185 try {
186 ilObjFolder::recurseFolder ($this->getRefId(), $this->getTitle(), $tmpdir);
187 ilUtil::zip($zipbasedir, $tmpzipfile);
188 rename($tmpzipfile,$zipfile = ilUtil::ilTempnam());
189 ilUtil::delDir($tmpdir);
190 ilUtil::deliverFile($zipfile,$deliverFilename,'',false,true);
191 } catch (ilFileException $e) {
192 ilUtil::sendInfo($e->getMessage(), true);
193 }
194 }
195
199 function getViewMode()
200 {
201 global $tree;
202
203 // default: by type
205
206 // always inherit from
207 $container_ref_id = $tree->checkForParentType($this->ref_id, 'grp');
208 if(!$container_ref_id)
209 {
210 $container_ref_id = $tree->checkForParentType($this->ref_id, 'crs');
211 }
212 if($container_ref_id)
213 {
214 include_once("./Modules/Course/classes/class.ilObjCourseAccess.php");
215 $view_mode = ilObjCourseAccess::_lookupViewMode(ilObject::_lookupObjId($container_ref_id));
216 if ($view_mode == ilContainer::VIEW_SESSIONS ||
217 $view_mode == ilContainer::VIEW_BY_TYPE ||
218 $view_mode == ilContainer::VIEW_SIMPLE)
219 {
220 $view = $view_mode;
221 }
222 }
223
224 return $view;
225 }
226
231 function addAdditionalSubItemInformation(&$a_item_data)
232 {
233 include_once './Services/Object/classes/class.ilObjectActivation.php';
235 }
236
244 public function read()
245 {
246 global $tree;
247
248 parent::read();
249
250 // Inherit order type from parent course (if exists)
251 include_once('./Services/Container/classes/class.ilContainerSortingSettings.php');
253 }
254
255} // END class.ilObjFolder
256?>
static _lookupSortMode($a_obj_id)
lookup sort mode
Class ilContainer.
setOrderType($a_value)
Class to report exception.
_lookupViewMode($a_id)
Lookup view mode.
static _lookupAbsolutePath($obj_id, $a_version=null)
return absolute path for version
Class ilObjFolder.
getViewMode()
Get container view mode.
read()
Overwritten read method.
setFolderTree($a_tree)
putInTree($a_parent)
insert folder into grp_tree
addAdditionalSubItemInformation(&$a_item_data)
Add additional information to sub item, e.g.
cloneObject($a_target_id, $a_copy_id=0)
Clone folder.
ilObjFolder($a_id=0, $a_call_by_reference=true)
Constructor @access public.
static recurseFolder($refid, $title, $tmpdir)
private functions which iterates through all folders and files and create an according file structure...
cloneDependencies($a_target_id, $a_copy_id)
Clone object dependencies (crs items, preconditions)
static cloneDependencies($a_ref_id, $a_target_id, $a_copy_id)
Clone dependencies.
static addAdditionalSubItemInformation(array &$a_item)
Parse item data for list entries.
static _lookupObjId($a_id)
_isInTrash($a_ref_id)
checks wether object is in trash
withReferences()
determines wehter objects are referenced or not (got ref ids or not)
getRefId()
get reference id @access public
getId()
get object id @access public
getTitle()
get object title @access public
static delDir($a_dir, $a_clean_only=false)
removes a dir and all its content (subdirs and files) recursively
static zip($a_dir, $a_file, $compress_content=false)
static ilTempnam($a_temp_path=null)
Create a temporary file in an ILIAS writable directory.
static sendInfo($a_info="", $a_keep=false)
Send Info Message to Screen.
static deliverFile($a_file, $a_filename, $a_mime='', $isInline=false, $removeAfterDelivery=false, $a_exit_after=true)
deliver file for download via browser.
static makeDir($a_dir)
creates a new directory and inherits all filesystem permissions of the parent directory You may pass ...