ILIAS  Release_4_1_x_branch Revision 61804
 All Data Structures Namespaces Files Functions Variables Groups Pages
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 
24 require_once "./Services/Container/classes/class.ilContainer.php";
25 
34 class ilObjFolder extends ilContainer
35 {
36  var $folder_tree;
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  global $tree;
113 
114  parent::cloneDependencies($a_target_id,$a_copy_id);
115 
116  if($course_ref_id = $tree->checkForParentType($this->getRefId(),'crs') and
117  $new_course_ref_id = $tree->checkForParentType($a_target_id,'crs'))
118  {
119  include_once('Modules/Course/classes/class.ilCourseItems.php');
120  $course_obj =& ilObjectFactory::getInstanceByRefId($course_ref_id,false);
121  $course_items = new ilCourseItems($course_obj->getRefId(),$this->getRefId());
122  $course_items->cloneDependencies($a_target_id,$a_copy_id);
123  }
124 
125  include_once('Services/Tracking/classes/class.ilLPCollections.php');
126  $lp_collection = new ilLPCollections($this->getId());
127  $lp_collection->cloneCollections($a_target_id,$a_copy_id);
128 
129  return true;
130  }
131 
140  private static function recurseFolder ($refid, $title, $tmpdir) {
141  global $rbacsystem, $tree, $ilAccess;
142 
143  $tmpdir = $tmpdir.DIRECTORY_SEPARATOR.ilUtil::getASCIIFilename($title);
144  ilUtil::makeDir($tmpdir);
145 
146  $subtree = $tree->getChildsByTypeFilter($refid, array("fold","file"));
147 
148  foreach ($subtree as $child)
149  {
150  if (!$ilAccess->checkAccess("read", "", $child["ref_id"]))
151  {
152  continue;
153  }
154  if (ilObject::_isInTrash($child["ref_id"]))
155  {
156  continue;
157  }
158  if ($child["type"] == "fold")
159  {
160  ilObjFolder::recurseFolder ($child["ref_id"], $child["title"], $tmpdir);
161  } else {
162  $newFilename = $tmpdir.DIRECTORY_SEPARATOR.ilUtil::getASCIIFilename($child["title"]);
163  // copy to temporal directory
164  $oldFilename = ilObjFile::_lookupAbsolutePath($child["obj_id"]);
165  if (!copy ($oldFilename, $newFilename))
166  {
167  throw new ilFileException("Could not copy ".$oldFilename." to ".$newFilename);
168  }
169  touch($newFilename, filectime($oldFilename));
170  }
171  }
172 
173  }
174 
175  public function downloadFolder() {
176  global $lng, $rbacsystem, $ilAccess;
177  include_once "./Services/Utilities/classes/class.ilUtil.php";
178  include_once 'Modules/File/classes/class.ilObjFile.php';
179  include_once 'Modules/File/classes/class.ilFileException.php';
180  if (!$ilAccess->checkAccess("read", "", $this->getRefId()))
181  {
182  $this->ilErr->raiseError(get_class($this)."::downloadFolder(): missing read permission!",$this->ilErr->WARNING);
183  }
184  if (ilObject::_isInTrash($this->getRefId()))
185  {
186  $this->ilErr->raiseError(get_class($this)."::downloadFolder(): object is trashed!",$this->ilErr->WARNING);
187  }
188 
189  $zip = PATH_TO_ZIP;
190  $tmpdir = ilUtil::ilTempnam();
191  ilUtil::makeDir($tmpdir);
192  $basename = ilUtil::getAsciiFilename($this->getTitle());
193  $deliverFilename = $basename.".zip";
194  $zipbasedir = $tmpdir.DIRECTORY_SEPARATOR.$basename;
195  $tmpzipfile = $tmpdir.DIRECTORY_SEPARATOR.$deliverFilename;
196 
197  try {
198  ilObjFolder::recurseFolder ($this->getRefId(), $this->getTitle(), $tmpdir);
199  ilUtil::zip($zipbasedir, $tmpzipfile);
200  rename($tmpzipfile,$zipfile = ilUtil::ilTempnam());
201  ilUtil::delDir($tmpdir);
202  ilUtil::deliverFile($zipfile,$deliverFilename,'',false,true);
203  } catch (ilFileException $e) {
204  ilUtil::sendInfo($e->getMessage(), true);
205  }
206  }
207 
211  function getViewMode()
212  {
213  global $tree;
214 
215  // default: by type
216  $view = ilContainer::VIEW_BY_TYPE;
217 
218  // get view mode from course
219  if ($course_ref_id = $tree->checkForParentType($this->ref_id,'crs'))
220  {
221  include_once("./Modules/Course/classes/class.ilObjCourseAccess.php");
222  $view_mode = ilObjCourseAccess::_lookupViewMode(ilObject::_lookupObjId($course_ref_id));
223  if ($view_mode == ilContainer::VIEW_SESSIONS ||
224  $view_mode == ilContainer::VIEW_BY_TYPE ||
225  $view_mode == ilContainer::VIEW_SIMPLE)
226  {
227  $view = $view_mode;
228  }
229  }
230 
231  return $view;
232  }
233 
238  function addAdditionalSubItemInformation(&$a_item_data)
239  {
240  global $tree;
241 
242  static $items = null;
243 
244  if(!is_object($items[$this->getRefId()]))
245  {
246  if ($course_ref_id = $tree->checkForParentType($this->getRefId(),'crs'))
247  {
248  include_once("./Modules/Course/classes/class.ilObjCourse.php");
249  include_once("./Modules/Course/classes/class.ilCourseItems.php");
250  $course_obj = new ilObjCourse($course_ref_id);
251  $items[$this->getRefId()] = new ilCourseItems($course_obj->getRefId(), $this->getRefId());
252  }
253  }
254  if(is_object($items[$this->getRefId()]))
255  {
256  $items[$this->getRefId()]->addAdditionalSubItemInformation($a_item_data);
257  }
258  }
259 
267  public function read()
268  {
269  global $tree;
270 
271  parent::read();
272 
273  // Inherit order type from parent course (if exists)
274  include_once('./Services/Container/classes/class.ilContainerSortingSettings.php');
275  $this->setOrderType(ilContainerSortingSettings::_lookupSortMode($this->getId()));
276  }
277 
278 } // END class.ilObjFolder
279 ?>