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
|
<?php
/**
* ContentTermsOfUse.class.php
* model class for table licenses
*
* The ContentTermsOfUse class provides information about the terms under which
* a content object in Stud.IP can be used. Each entry in the database table
* content_terms_of_use_entries corresponds to one terms of use variant.
*
* Content can be a file or another Stud.IP object that is capable
* of storing copyrighted material.
*
* 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 Moritz Strohm <strohm@data-quest.de>
* @copyright 2016 data-quest
* @license http://www.gnu.org/licenses/gpl-2.0.html GPL version 2
* @category Stud.IP
*
* @property string id database column: ID of the content terms of use object
* @property string name database column: Short name of the terms of use object
* @property string position database column: sorting of the entries can be made possible with this attribute
* @property string description database column: Description text of the terms of use object
* @property int download_condition: database column
* 0 = no conditions (downloadable by anyone)
* 1 = closed groups (e.g. courses with signup rules)
* 2 = only for owner
* @property string icon database column: either the name of the icon or the URL that points to the icon
*/
class ContentTermsOfUse extends SimpleORMap
{
/**
* @var
*/
private static $cache = null;
/**
* @param array $config
*/
protected static function configure($config = [])
{
$config['db_table'] = 'content_terms_of_use_entries';
$config['i18n_fields']['name'] = true;
$config['i18n_fields']['description'] = true;
$config['i18n_fields']['student_description'] = true;
$config['default_values']['download_condition'] = 0;
$config['default_values']['icon'] = 'license';
$config['default_values']['position'] = 0;
$config['default_values']['is_default'] = false;
$config['registered_callbacks']['after_store'][] = 'cbCheckDefault';
parent::configure($config);
}
/**
* @return ContentTermsOfUse[]
*/
public static function findAll()
{
if (self::$cache === null) {
self::$cache = new SimpleCollection(self::findBySQL('1 ORDER by position, id'));
}
return self::$cache;
}
/**
* @param $id string
* @return ContentTermsOfUse
*/
public static function find($id)
{
return self::findAll()->findOneBy('id', $id);
}
/**
* @param $id string
* @return ContentTermsOfUse
*/
public static function findOrBuild($id)
{
return self::find($id) ?: self::build(['id' => 'UNDEFINED', 'name' => 'unbekannt']);
}
/**
* @return ContentTermsOfUse
*/
public static function findDefault()
{
return self::findAll()->findOneBy('is_default', 1);
}
/**
* Returns a list of all valid conditions.
*
* @return array
*/
public static function getConditions()
{
return [
0 => _('Ohne Bedingung'),
1 => _('Nur innerhalb geschlossener Veranstaltungen erlaubt'),
2 => _('Nur für EigentümerIn erlaubt'),
];
}
/**
* Returns the textual representation of a condition.
*
* @param int $condition
* @return string
*/
public static function describeCondition($condition)
{
$conditions = self::getConditions();
return isset($conditions[$condition])
? $conditions[$condition]
: _('Nicht definiert');
}
/**
*
*/
public function cbCheckDefault()
{
if ($this->is_default) {
$query = "UPDATE `content_terms_of_use_entries`
SET `is_default` = 0
WHERE id != :id";
$statement = DBManager::get()->prepare($query);
$statement->bindValue(':id', $this->id);
$statement->execute();
}
self::$cache = null;
}
/**
* Validates this entry
*
* @return array with error messages, if it's empty everyhting is fine
*/
public function validate()
{
$errors = [];
if ($this->isNew() && self::exists($this->id)) {
$errors[] = sprintf(
_('Es existiert bereits ein Eintrag mit der ID %s!'),
$this->id
);
}
if (!$this->name) {
$errors[] = _('Es wurde kein Name für den Eintrag gesetzt!');
}
return $errors;
}
/**
* Determines if a user is permitted to download a file.
*
* Depening on the value of the download_condition attribute a decision
* is made regarding the permission of the given user to download
* a file, given by one of its associated FileRef objects.
*
* The folder condition can have the values 0, 1 and 2.
* - 0 means that there are no conditions for downloading, therefore the
* file is downloadable by anyone.
* - 1 means that the file is only downloadable inside a closed group.
* Such a group can be a course or study group with closed admission.
* In this case this method checks if the user is a member of the
* course or study group.
* - 2 means that the file is only downloadable for the owner.
* The user's ID must therefore match the user_id attribute
* of the FileRef object.
*/
public function isDownloadable($context_id, $context_type, $allow_owner = true, $user_id = null)
{
$user_id = $user_id ?: $GLOBALS['user']->id;
if ($allow_owner) {
if (in_array($context_type, ['course', 'institute'])
&& Seminar_Perm::get()->have_studip_perm(
'tutor', $context_id, $user_id
)
) {
return true;
} elseif ($context_type === "profile" && $context_id === $user_id) {
return true;
}
}
if ($this->download_condition == 1) {
//the content is only downloadable when the user is inside a closed group
//(referenced by range_id). If download_condition is set to 2
//the group must also have a terminated signup deadline.
if ($context_type === "course") {
//check where this range_id comes from:
$seminar = Seminar::GetInstance($context_id);
$timed_admission = $seminar->getAdmissionTimeFrame();
if ($seminar->admission_prelim
|| $seminar->isPasswordProtected()
|| $seminar->isAdmissionLocked()
|| (is_array($timed_admission) && $timed_admission['end_time'] > 0 && $timed_admission['end_time'] < time())
) {
return true;
}
}
return false;
}
if ($this->download_condition == 2) {
return false;
}
return true;
}
}
|
