tablepress / libraries / vendor / PhpSpreadsheet / Worksheet / Protection.php

Protection.php in TablePress – Tables in WordPress made easy 3.4, at libraries/vendor/PhpSpreadsheet/Worksheet/Protection.php

475 lines 8.7 KB

Raw Download Zip

1	<?php
2
3	namespace TablePress\PhpOffice\PhpSpreadsheet\Worksheet;
4
5	use TablePress\PhpOffice\PhpSpreadsheet\Shared\PasswordHasher;
6
7	class Protection
8	{
9	const ALGORITHM_MD2 = 'MD2';
10	const ALGORITHM_MD4 = 'MD4';
11	const ALGORITHM_MD5 = 'MD5';
12	const ALGORITHM_SHA_1 = 'SHA-1';
13	const ALGORITHM_SHA_256 = 'SHA-256';
14	const ALGORITHM_SHA_384 = 'SHA-384';
15	const ALGORITHM_SHA_512 = 'SHA-512';
16	const ALGORITHM_RIPEMD_128 = 'RIPEMD-128';
17	const ALGORITHM_RIPEMD_160 = 'RIPEMD-160';
18	const ALGORITHM_WHIRLPOOL = 'WHIRLPOOL';
19
20	/**
21	* Autofilters are locked when sheet is protected, default true.
22	*/
23	private ?bool $autoFilter = null;
24
25	/**
26	* Deleting columns is locked when sheet is protected, default true.
27	*/
28	private ?bool $deleteColumns = null;
29
30	/**
31	* Deleting rows is locked when sheet is protected, default true.
32	*/
33	private ?bool $deleteRows = null;
34
35	/**
36	* Formatting cells is locked when sheet is protected, default true.
37	*/
38	private ?bool $formatCells = null;
39
40	/**
41	* Formatting columns is locked when sheet is protected, default true.
42	*/
43	private ?bool $formatColumns = null;
44
45	/**
46	* Formatting rows is locked when sheet is protected, default true.
47	*/
48	private ?bool $formatRows = null;
49
50	/**
51	* Inserting columns is locked when sheet is protected, default true.
52	*/
53	private ?bool $insertColumns = null;
54
55	/**
56	* Inserting hyperlinks is locked when sheet is protected, default true.
57	*/
58	private ?bool $insertHyperlinks = null;
59
60	/**
61	* Inserting rows is locked when sheet is protected, default true.
62	*/
63	private ?bool $insertRows = null;
64
65	/**
66	* Objects are locked when sheet is protected, default false.
67	*/
68	private ?bool $objects = null;
69
70	/**
71	* Pivot tables are locked when the sheet is protected, default true.
72	*/
73	private ?bool $pivotTables = null;
74
75	/**
76	* Scenarios are locked when sheet is protected, default false.
77	*/
78	private ?bool $scenarios = null;
79
80	/**
81	* Selection of locked cells is locked when sheet is protected, default false.
82	*/
83	private ?bool $selectLockedCells = null;
84
85	/**
86	* Selection of unlocked cells is locked when sheet is protected, default false.
87	*/
88	private ?bool $selectUnlockedCells = null;
89
90	/**
91	* Sheet is locked when sheet is protected, default false.
92	*/
93	private ?bool $sheet = null;
94
95	/**
96	* Sorting is locked when sheet is protected, default true.
97	*/
98	private ?bool $sort = null;
99
100	/**
101	* Hashed password.
102	*/
103	private string $password = '';
104
105	/**
106	* Algorithm name.
107	*/
108	private string $algorithm = '';
109
110	/**
111	* Salt value.
112	*/
113	private string $salt = '';
114
115	/**
116	* Spin count.
117	*/
118	private int $spinCount = 10000;
119
120	/**
121	* Create a new Protection.
122	*/
123	public function __construct()
124	{
125	}
126
127	/**
128	* Is some sort of protection enabled?
129	*/
130	public function isProtectionEnabled(): bool
131	{
132	return
133	$this->password !== ''
134	\|\| isset($this->sheet)
135	\|\| isset($this->objects)
136	\|\| isset($this->scenarios)
137	\|\| isset($this->formatCells)
138	\|\| isset($this->formatColumns)
139	\|\| isset($this->formatRows)
140	\|\| isset($this->insertColumns)
141	\|\| isset($this->insertRows)
142	\|\| isset($this->insertHyperlinks)
143	\|\| isset($this->deleteColumns)
144	\|\| isset($this->deleteRows)
145	\|\| isset($this->selectLockedCells)
146	\|\| isset($this->sort)
147	\|\| isset($this->autoFilter)
148	\|\| isset($this->pivotTables)
149	\|\| isset($this->selectUnlockedCells);
150	}
151
152	public function getSheet(): ?bool
153	{
154	return $this->sheet;
155	}
156
157	public function setSheet(?bool $sheet): self
158	{
159	$this->sheet = $sheet;
160
161	return $this;
162	}
163
164	public function getObjects(): ?bool
165	{
166	return $this->objects;
167	}
168
169	public function setObjects(?bool $objects): self
170	{
171	$this->objects = $objects;
172
173	return $this;
174	}
175
176	public function getScenarios(): ?bool
177	{
178	return $this->scenarios;
179	}
180
181	public function setScenarios(?bool $scenarios): self
182	{
183	$this->scenarios = $scenarios;
184
185	return $this;
186	}
187
188	public function getFormatCells(): ?bool
189	{
190	return $this->formatCells;
191	}
192
193	public function setFormatCells(?bool $formatCells): self
194	{
195	$this->formatCells = $formatCells;
196
197	return $this;
198	}
199
200	public function getFormatColumns(): ?bool
201	{
202	return $this->formatColumns;
203	}
204
205	public function setFormatColumns(?bool $formatColumns): self
206	{
207	$this->formatColumns = $formatColumns;
208
209	return $this;
210	}
211
212	public function getFormatRows(): ?bool
213	{
214	return $this->formatRows;
215	}
216
217	public function setFormatRows(?bool $formatRows): self
218	{
219	$this->formatRows = $formatRows;
220
221	return $this;
222	}
223
224	public function getInsertColumns(): ?bool
225	{
226	return $this->insertColumns;
227	}
228
229	public function setInsertColumns(?bool $insertColumns): self
230	{
231	$this->insertColumns = $insertColumns;
232
233	return $this;
234	}
235
236	public function getInsertRows(): ?bool
237	{
238	return $this->insertRows;
239	}
240
241	public function setInsertRows(?bool $insertRows): self
242	{
243	$this->insertRows = $insertRows;
244
245	return $this;
246	}
247
248	public function getInsertHyperlinks(): ?bool
249	{
250	return $this->insertHyperlinks;
251	}
252
253	public function setInsertHyperlinks(?bool $insertHyperLinks): self
254	{
255	$this->insertHyperlinks = $insertHyperLinks;
256
257	return $this;
258	}
259
260	public function getDeleteColumns(): ?bool
261	{
262	return $this->deleteColumns;
263	}
264
265	public function setDeleteColumns(?bool $deleteColumns): self
266	{
267	$this->deleteColumns = $deleteColumns;
268
269	return $this;
270	}
271
272	public function getDeleteRows(): ?bool
273	{
274	return $this->deleteRows;
275	}
276
277	public function setDeleteRows(?bool $deleteRows): self
278	{
279	$this->deleteRows = $deleteRows;
280
281	return $this;
282	}
283
284	public function getSelectLockedCells(): ?bool
285	{
286	return $this->selectLockedCells;
287	}
288
289	public function setSelectLockedCells(?bool $selectLockedCells): self
290	{
291	$this->selectLockedCells = $selectLockedCells;
292
293	return $this;
294	}
295
296	public function getSort(): ?bool
297	{
298	return $this->sort;
299	}
300
301	public function setSort(?bool $sort): self
302	{
303	$this->sort = $sort;
304
305	return $this;
306	}
307
308	public function getAutoFilter(): ?bool
309	{
310	return $this->autoFilter;
311	}
312
313	public function setAutoFilter(?bool $autoFilter): self
314	{
315	$this->autoFilter = $autoFilter;
316
317	return $this;
318	}
319
320	public function getPivotTables(): ?bool
321	{
322	return $this->pivotTables;
323	}
324
325	public function setPivotTables(?bool $pivotTables): self
326	{
327	$this->pivotTables = $pivotTables;
328
329	return $this;
330	}
331
332	public function getSelectUnlockedCells(): ?bool
333	{
334	return $this->selectUnlockedCells;
335	}
336
337	public function setSelectUnlockedCells(?bool $selectUnlockedCells): self
338	{
339	$this->selectUnlockedCells = $selectUnlockedCells;
340
341	return $this;
342	}
343
344	/**
345	* Get hashed password.
346	*/
347	public function getPassword(): string
348	{
349	return $this->password;
350	}
351
352	/**
353	* Set Password.
354	*
355	* @param bool $alreadyHashed If the password has already been hashed, set this to true
356	*
357	* @return $this
358	*/
359	public function setPassword(string $password, bool $alreadyHashed = false)
360	{
361	if (!$alreadyHashed) {
362	$salt = $this->generateSalt();
363	$this->setSalt($salt);
364	$password = PasswordHasher::hashPassword($password, $this->getAlgorithm(), $this->getSalt(), $this->getSpinCount());
365	}
366
367	$this->password = $password;
368
369	return $this;
370	}
371
372	public function setHashValue(string $password): self
373	{
374	return $this->setPassword($password, true);
375	}
376
377	/**
378	* Create a pseudorandom string.
379	*/
380	private function generateSalt(): string
381	{
382	return base64_encode(random_bytes(16));
383	}
384
385	/**
386	* Get algorithm name.
387	*/
388	public function getAlgorithm(): string
389	{
390	return $this->algorithm;
391	}
392
393	/**
394	* Set algorithm name.
395	*/
396	public function setAlgorithm(string $algorithm): self
397	{
398	return $this->setAlgorithmName($algorithm);
399	}
400
401	/**
402	* Set algorithm name.
403	*/
404	public function setAlgorithmName(string $algorithm): self
405	{
406	$this->algorithm = $algorithm;
407
408	return $this;
409	}
410
411	public function getSalt(): string
412	{
413	return $this->salt;
414	}
415
416	public function setSalt(string $salt): self
417	{
418	return $this->setSaltValue($salt);
419	}
420
421	public function setSaltValue(string $salt): self
422	{
423	$this->salt = $salt;
424
425	return $this;
426	}
427
428	/**
429	* Get spin count.
430	*/
431	public function getSpinCount(): int
432	{
433	return $this->spinCount;
434	}
435
436	/**
437	* Set spin count.
438	*/
439	public function setSpinCount(int $spinCount): self
440	{
441	$this->spinCount = $spinCount;
442
443	return $this;
444	}
445
446	/**
447	* Verify that the given non-hashed password can "unlock" the protection.
448	*/
449	public function verify(string $password): bool
450	{
451	if ($this->password === '') {
452	return true;
453	}
454
455	$hash = PasswordHasher::hashPassword($password, $this->getAlgorithm(), $this->getSalt(), $this->getSpinCount());
456
457	return $this->getPassword() === $hash;
458	}
459
460	/**
461	* Implement PHP __clone to create a deep clone, not just a shallow copy.
462	*/
463	public function __clone()
464	{
465	$vars = get_object_vars($this);
466	foreach ($vars as $key => $value) {
467	if (is_object($value)) {
468	$this->$key = clone $value;
469	} else {
470	$this->$key = $value;
471	}
472	}
473	}
474	}
475