blob: e9d84fb5556a31b2f66cdb7f98d10aa6c6532e57 (
plain)
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
|
/**
* @copyright Copyright (c) 2019 John Molakvoæ <skjnldsv@protonmail.com>
*
* @author John Molakvoæ <skjnldsv@protonmail.com>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
export default class Share {
#share;
/**
* Create the share object
*
* @param {Object} ocsData ocs request response
*/
constructor(ocsData) {
if (ocsData.ocs && ocsData.ocs.data && ocsData.ocs.data[0]) {
ocsData = ocsData.ocs.data[0]
}
// convert int into boolean
ocsData.hide_download = !!ocsData.hide_download
ocsData.mail_send = !!ocsData.mail_send
// store state
this.#share = ocsData
}
/**
* Get the share state
* ! used for reactivity purpose
* Do not remove. It allow vuejs to
* inject its watchers into the #share
* state and make the whole class reactive
*
* @returns {Object} the share raw state
* @readonly
* @memberof Sidebar
*/
get state() {
return this.#share
}
/**
* get the share id
*
* @returns {int}
* @readonly
* @memberof Share
*/
get id() {
return this.#share.id
}
/**
* Get the share type
*
* @returns {int}
* @readonly
* @memberof Share
*/
get type() {
return this.#share.share_type
}
/**
* Get the share permissions
* See OC.PERMISSION_* variables
*
* @returns {int}
* @readonly
* @memberof Share
*/
get permissions() {
return this.#share.permissions
}
/**
* Set the share permissions
* See OC.PERMISSION_* variables
*
* @param {int} permissions valid permission, See OC.PERMISSION_* variables
* @memberof Share
*/
set permissions(permissions) {
this.#share.permissions = permissions
}
// SHARE OWNER --------------------------------------------------
/**
* Get the share owner uid
*
* @returns {string}
* @readonly
* @memberof Share
*/
get owner() {
return this.#share.uid_owner
}
/**
* Get the share owner's display name
*
* @returns {string}
* @readonly
* @memberof Share
*/
get ownerDisplayName() {
return this.#share.displayname_owner
}
// SHARED WITH --------------------------------------------------
/**
* Get the share with entity uid
*
* @returns {string}
* @readonly
* @memberof Share
*/
get shareWith() {
return this.#share.share_with
}
/**
* Get the share with entity display name
* fallback to its uid if none
*
* @returns {string}
* @readonly
* @memberof Share
*/
get shareWithDisplayName() {
return this.#share.share_with_displayname
|| this.#share.share_with
}
/**
* Get the share with avatar if any
*
* @returns {string}
* @readonly
* @memberof Share
*/
get shareWithAvatar() {
return this.#share.share_with_avatar
}
// SHARED FILE OR FOLDER OWNER ----------------------------------
/**
* Get the shared item owner uid
*
* @returns {string}
* @readonly
* @memberof Share
*/
get uidFileOwner() {
return this.#share.uid_file_owner
}
/**
* Get the shared item display name
* fallback to its uid if none
*
* @returns {string}
* @readonly
* @memberof Share
*/
get displaynameFileOwner() {
return this.#share.displayname_file_owner
|| this.#share.uid_file_owner
}
// TIME DATA ----------------------------------------------------
/**
* Get the share creation timestamp
*
* @returns {int}
* @readonly
* @memberof Share
*/
get createdTime() {
return this.#share.stime
}
/**
* Get the expiration date as a string format
*
* @returns {string}
* @readonly
* @memberof Share
*/
get expireDate() {
return this.#share.expiration
}
/**
* Set the expiration date as a string format
* e.g. YYYY-MM-DD
*
* @param {string} date the share expiration date
* @memberof Share
*/
set expireDate(date) {
this.#share.expiration = date
}
// EXTRA DATA ---------------------------------------------------
/**
* Get the public share token
*
* @returns {string} the token
* @readonly
* @memberof Share
*/
get token() {
return this.#share.token
}
/**
* Get the share note if any
*
* @returns {string}
* @readonly
* @memberof Share
*/
get note() {
return this.#share.note
}
/**
* Set the share note if any
*
* @param {string} note the note
* @memberof Share
*/
set note(note) {
this.#share.note = note.trim()
}
/**
* Have a mail been sent
*
* @returns {boolean}
* @readonly
* @memberof Share
*/
get mailSend() {
return this.#share.mail_send === true
}
/**
* Hide the download button on public page
*
* @returns {boolean}
* @readonly
* @memberof Share
*/
get hideDownload() {
return this.#share.hide_download === true
}
/**
* Hide the download button on public page
*
* @param {boolean} state hide the button ?
* @memberof Share
*/
set hideDownload(state) {
this.#share.hide_download = state === true
}
/**
* Password protection of the share
*
* @returns {string}
* @readonly
* @memberof Share
*/
get password() {
return this.#share.password
}
/**
* Password protection of the share
*
* @param {string} password the share password
* @memberof Share
*/
set password(password) {
this.#share.password = password.trim()
}
// SHARED ITEM DATA ---------------------------------------------
/**
* Get the shared item absolute full path
*
* @returns {string}
* @readonly
* @memberof Share
*/
get path() {
return this.#share.path
}
/**
* Return the item type: file or folder
*
* @returns {string} 'folder' or 'file'
* @readonly
* @memberof Share
*/
get itemType() {
return this.#share.item_type
}
/**
* Get the shared item mimetype
*
* @returns {string}
* @readonly
* @memberof Share
*/
get mimetype() {
return this.#share.mimetype
}
/**
* Get the shared item id
*
* @returns {int}
* @readonly
* @memberof Share
*/
get fileSource() {
return this.#share.file_source
}
/**
* Get the target path on the receiving end
* e.g the file /xxx/aaa will be shared in
* the receiving root as /aaa, the fileTarget is /aaa
*
* @returns {string}
* @readonly
* @memberof Share
*/
get fileTarget() {
return this.#share.file_target
}
/**
* Get the parent folder id if any
*
* @returns {int}
* @readonly
* @memberof Share
*/
get fileParent() {
return this.#share.file_parent
}
// PERMISSIONS Shortcuts
/**
* Does this share have CREATE permissions
*
* @returns {boolean}
* @readonly
* @memberof Share
*/
get hasCreatePermission() {
return !!((this.permissions & OC.PERMISSION_CREATE))
}
/**
* Does this share have DELETE permissions
*
* @returns {boolean}
* @readonly
* @memberof Share
*/
get hasDeletePermission() {
return !!((this.permissions & OC.PERMISSION_DELETE))
}
/**
* Does this share have UPDATE permissions
*
* @returns {boolean}
* @readonly
* @memberof Share
*/
get hasUpdatePermission() {
return !!((this.permissions & OC.PERMISSION_UPDATE))
}
/**
* Does this share have SHARE permissions
*
* @returns {boolean}
* @readonly
* @memberof Share
*/
get hasSharePermission() {
return !!((this.permissions & OC.PERMISSION_SHARE))
}
// TODO: SORT THOSE PROPERTIES
get label() {
return this.#share.label
}
get parent() {
return this.#share.parent
}
get storageId() {
return this.#share.storage_id
}
get storage() {
return this.#share.storage
}
get itemSource() {
return this.#share.item_source
}
}
|