1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
<?php
/**
* TimedFolder.php
* A folder type that provides time-based access to its contents.
*
* This program 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 2 of
* the License, or (at your option) any later version.
*
* @author Thomas Hackl <thomas.hackl@uni-passau.de>
* @copyright 2017 Stud.IP Core-Group
* @license http://www.gnu.org/licenses/gpl-2.0.html GPL version 2
* @category Stud.IP
*/
class TimedFolder extends PermissionEnabledFolder
{
public static $sorter = 5;
/**
* @var int start of folder visibility (0 for always)
*/
public $start_time;
/**
* @var int end of folder visibility (0 for always)
*/
public $end_time;
/**
* Provides the ranges this folder type is available in for the given user.
* Doesn't really make sense in other contexts than a course.
*
* @param string $range_id_or_object the object (or object ID) to check for
* @param $user_id the user to check for (must have at least 'tutor' perm in given course)
* @return bool available or not?
*/
public static function availableInRange($range_id_or_object, $user_id)
{
$course = Course::toObject($range_id_or_object);
if ($course && !$course->isNew()) {
return Seminar_Perm::get()->have_studip_perm('tutor', $course->id, $user_id);
}
return false;
}
/**
* Returns the name of the TimedFolder type.
*
* @return string the name of the TimedFolder type
*/
public static function getTypeName()
{
return _('Zeitgesteuerter Ordner');
}
/**
* Is the current folder visible for the given user?
* That depends on parent folder visibility and time settings.
*
* @param string|null $user_id the user to check visibility for
* @return bool visible or not?
*/
public function isVisible($user_id = null)
{
$now = time();
return (
($this->start_time == 0 || $this->start_time <= $now) &&
($this->end_time == 0 || $this->end_time >= $now)
||
$GLOBALS['perm']->have_studip_perm($this->must_have_perm, $this->range_id, $user_id)) &&
parent::isVisible($user_id);
}
public function isReadable($user_id = null)
{
$now = time();
return (
($this->start_time == 0 || $this->start_time <= $now) &&
($this->end_time == 0 || $this->end_time >= $now)
||
$GLOBALS['perm']->have_studip_perm($this->must_have_perm, $this->range_id, $user_id)) &&
parent::isReadable($user_id);
}
public function isWritable($user_id = null)
{
$now = time();
return (
($this->start_time == 0 || $this->start_time <= $now) &&
($this->end_time == 0 || $this->end_time >= $now)
||
$GLOBALS['perm']->have_studip_perm($this->must_have_perm, $this->range_id, $user_id)) &&
parent::isWritable($user_id);
}
/**
* This function returns the suitable Icon for this folder type (TimedFolder)
*
* @return Icon The icon object for this folder type
*/
public function getIcon($role = Icon::DEFAULT_ROLE)
{
$shape = $this->is_empty
? 'folder-date-empty'
: 'folder-date-full';
return Icon::create($shape, $role);
}
/**
* TimedFolder constructor.
*
* @param array|null $folderdata data to create folder with
*/
public function __construct($folderdata = null)
{
parent::__construct($folderdata);
if (isset($this->folderdata['data_content']['permission'])) {
$this->permission = $this->folderdata['data_content']['permission'];
} else {
$this->folderdata['data_content']['permission'] = $this->permission;
}
$this->start_time = intval($this->folderdata['data_content']['start_time'] ?? 0);
$this->end_time = intval($this->folderdata['data_content']['end_time'] ?? 0);
$this->must_have_perm = 'tutor';
}
/**
* Returns the description template for a instance of a TimedFolder type.
*
* @return Flexi_Template A description template for a instance of the type TimedFolder
*/
public function getDescriptionTemplate()
{
$template = $GLOBALS['template_factory']->open('filesystem/timed_folder/description');
$template->type = self::getTypeName();
$template->folder = $this;
$template->folderdata = $this->folderdata;
if (!Seminar_Perm::get()->have_studip_perm('tutor', $this->range_id) &&
$this->isWritable($GLOBALS['user']->id) && !$this->isReadable($GLOBALS['user']->id)) {
$files = new SimpleCollection($this->getFiles());
$template->own_files = $files->findBy('user_id', $GLOBALS['user']->id)->orderBy('name');
}
return $template;
}
/**
* Returns the edit template for this folder type.
*
* @return Flexi_Template
*/
public function getEditTemplate()
{
$template = $GLOBALS['template_factory']->open('filesystem/timed_folder/edit');
$template->folder = $this;
return $template;
}
/**
* Stores the data which was edited in the edit template
* @return mixed The template with the edited data
*/
public function setDataFromEditTemplate($request)
{
$permvalue = ($request['perm_read'] ? $this->perms['r'] : 0) +
($request['perm_write'] ? $this->perms['w'] : 0) +
$this->perms['x'];
$this->folderdata['data_content']['permission'] = $permvalue;
$start = strtotime($request['start_time']);
$end = strtotime($request['end_time']);
if (!$start && !$end) {
return MessageBox::error(_('Bitte geben Sie eine Start- und/oder Endzeit an.'));
} else {
if (!$end || $start < $end) {
$this->folderdata['data_content']['start_time'] = $start;
} else {
return MessageBox::error(_('Die Startzeit muss kleiner als die Endzeit sein.'));
}
if (!$start || $end > $start) {
$this->folderdata['data_content']['end_time'] = $end;
} else {
$this->folderdata['data_content']['end_time'] = 0;
}
return parent::setDataFromEditTemplate($request);
}
}
/**
* @param FileRef|string $fileref_or_id
* @param string $user_id
* @return bool
*/
public function isFileEditable($fileref_or_id, $user_id)
{
//HomeworkFolder Style
if (!Seminar_Perm::get()->have_studip_perm('tutor', $this->range_id) &&
$this->isWritable($user_id) && !$this->isReadable($user_id)) {
return false;
}
return parent::isFileEditable($fileref_or_id, $user_id);
}
/**
* Checks if a user has write permissions to a file.
*
*
* @param FileRef|string $fileref_or_id
* @param string $user_id
* @return bool
*/
public function isFileWritable($fileref_or_id, $user_id)
{
//HomeworkFolder Style
if (!Seminar_Perm::get()->have_studip_perm('tutor', $this->range_id) &&
$this->isWritable($user_id) && !$this->isReadable($user_id)) {
return false;
}
return parent::isFileWritable($fileref_or_id, $user_id);
}
}
|
