| 
									
										
										
										
											2018-06-17 15:14:34 +02:00
										 |  |  | <?php | 
					
						
							|  |  |  | /** | 
					
						
							|  |  |  |  * ValidRecurrenceRepetitionValue.php | 
					
						
							| 
									
										
										
										
											2020-02-16 13:56:25 +01:00
										 |  |  |  * Copyright (c) 2019 james@firefly-iii.org | 
					
						
							| 
									
										
										
										
											2018-06-17 15:14:34 +02:00
										 |  |  |  * | 
					
						
							| 
									
										
										
										
											2019-10-02 06:37:26 +02:00
										 |  |  |  * This file is part of Firefly III (https://github.com/firefly-iii). | 
					
						
							| 
									
										
										
										
											2018-06-17 15:14:34 +02:00
										 |  |  |  * | 
					
						
							| 
									
										
										
										
											2019-10-02 06:37:26 +02:00
										 |  |  |  * 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. | 
					
						
							| 
									
										
										
										
											2018-06-17 15:14:34 +02:00
										 |  |  |  * | 
					
						
							| 
									
										
										
										
											2019-10-02 06:37:26 +02:00
										 |  |  |  * This program is distributed in the hope that it will be useful, | 
					
						
							| 
									
										
										
										
											2018-06-17 15:14:34 +02:00
										 |  |  |  * but WITHOUT ANY WARRANTY; without even the implied warranty of | 
					
						
							|  |  |  |  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the | 
					
						
							| 
									
										
										
										
											2019-10-02 06:37:26 +02:00
										 |  |  |  * GNU Affero General Public License for more details. | 
					
						
							| 
									
										
										
										
											2018-06-17 15:14:34 +02:00
										 |  |  |  * | 
					
						
							| 
									
										
										
										
											2019-10-02 06:37:26 +02:00
										 |  |  |  * You should have received a copy of the GNU Affero General Public License | 
					
						
							|  |  |  |  * along with this program.  If not, see <https://www.gnu.org/licenses/>. | 
					
						
							| 
									
										
										
										
											2018-06-17 15:14:34 +02:00
										 |  |  |  */ | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | declare(strict_types=1); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | namespace FireflyIII\Rules; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | use Carbon\Carbon; | 
					
						
							|  |  |  | use Illuminate\Contracts\Validation\Rule; | 
					
						
							|  |  |  | use InvalidArgumentException; | 
					
						
							| 
									
										
										
										
											2018-07-26 06:10:17 +02:00
										 |  |  | use Log; | 
					
						
							| 
									
										
										
										
											2018-06-17 15:14:34 +02:00
										 |  |  | 
 | 
					
						
							|  |  |  | /** | 
					
						
							|  |  |  |  * Class ValidRecurrenceRepetitionValue | 
					
						
							| 
									
										
										
										
											2019-07-31 16:53:09 +02:00
										 |  |  |  * @codeCoverageIgnore | 
					
						
							| 
									
										
										
										
											2018-06-17 15:14:34 +02:00
										 |  |  |  */ | 
					
						
							|  |  |  | class ValidRecurrenceRepetitionValue implements Rule | 
					
						
							|  |  |  | { | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     /** | 
					
						
							|  |  |  |      * Get the validation error message. | 
					
						
							|  |  |  |      * | 
					
						
							|  |  |  |      * @return string | 
					
						
							|  |  |  |      */ | 
					
						
							|  |  |  |     public function message(): string | 
					
						
							|  |  |  |     { | 
					
						
							| 
									
										
										
										
											2018-07-15 09:38:49 +02:00
										 |  |  |         return (string)trans('validation.valid_recurrence_rep_type'); | 
					
						
							| 
									
										
										
										
											2018-06-17 15:14:34 +02:00
										 |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     /** | 
					
						
							|  |  |  |      * Determine if the validation rule passes. | 
					
						
							|  |  |  |      * | 
					
						
							|  |  |  |      * @param  string $attribute | 
					
						
							|  |  |  |      * @param  mixed  $value | 
					
						
							|  |  |  |      * | 
					
						
							|  |  |  |      * @return bool | 
					
						
							| 
									
										
										
										
											2019-08-17 10:47:29 +02:00
										 |  |  |      * | 
					
						
							| 
									
										
										
										
											2018-06-17 15:14:34 +02:00
										 |  |  |      */ | 
					
						
							|  |  |  |     public function passes($attribute, $value): bool | 
					
						
							|  |  |  |     { | 
					
						
							|  |  |  |         $value = (string)$value; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-07-26 06:10:17 +02:00
										 |  |  |         if ('daily' === $value) { | 
					
						
							| 
									
										
										
										
											2018-06-17 15:14:34 +02:00
										 |  |  |             return true; | 
					
						
							|  |  |  |         } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         if (0 === strpos($value, 'monthly')) { | 
					
						
							| 
									
										
										
										
											2018-07-26 06:10:17 +02:00
										 |  |  |             return $this->validateMonthly($value); | 
					
						
							| 
									
										
										
										
											2018-06-17 15:14:34 +02:00
										 |  |  |         } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-07-27 04:46:21 +02:00
										 |  |  |         // Value is like: ndom,3,7
 | 
					
						
							| 
									
										
										
										
											2018-06-17 15:14:34 +02:00
										 |  |  |         // nth x-day of the month.
 | 
					
						
							|  |  |  |         if (0 === strpos($value, 'ndom')) { | 
					
						
							| 
									
										
										
										
											2018-07-26 06:10:17 +02:00
										 |  |  |             return $this->validateNdom($value); | 
					
						
							| 
									
										
										
										
											2018-06-17 15:14:34 +02:00
										 |  |  |         } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-07-27 04:46:21 +02:00
										 |  |  |         // Value is like: weekly,7
 | 
					
						
							| 
									
										
										
										
											2018-06-17 15:14:34 +02:00
										 |  |  |         if (0 === strpos($value, 'weekly')) { | 
					
						
							| 
									
										
										
										
											2018-07-26 06:10:17 +02:00
										 |  |  |             return $this->validateWeekly($value); | 
					
						
							| 
									
										
										
										
											2018-06-17 15:14:34 +02:00
										 |  |  |         } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-07-27 04:46:21 +02:00
										 |  |  |         // Value is like: yearly,2018-01-01
 | 
					
						
							| 
									
										
										
										
											2018-06-17 15:14:34 +02:00
										 |  |  |         if (0 === strpos($value, 'yearly')) { | 
					
						
							| 
									
										
										
										
											2018-07-26 06:10:17 +02:00
										 |  |  |             return $this->validateYearly($value); | 
					
						
							| 
									
										
										
										
											2018-06-17 15:14:34 +02:00
										 |  |  |         } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         return false; | 
					
						
							|  |  |  |     } | 
					
						
							| 
									
										
										
										
											2018-07-26 06:10:17 +02:00
										 |  |  | 
 | 
					
						
							|  |  |  |     /** | 
					
						
							|  |  |  |      * @param string $value | 
					
						
							|  |  |  |      * | 
					
						
							|  |  |  |      * @return bool | 
					
						
							|  |  |  |      */ | 
					
						
							|  |  |  |     private function validateMonthly(string $value): bool | 
					
						
							|  |  |  |     { | 
					
						
							|  |  |  |         $dayOfMonth = (int)substr($value, 8); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         return $dayOfMonth > 0 && $dayOfMonth < 32; | 
					
						
							|  |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     /** | 
					
						
							|  |  |  |      * @param string $value | 
					
						
							|  |  |  |      * | 
					
						
							|  |  |  |      * @return bool | 
					
						
							|  |  |  |      * | 
					
						
							|  |  |  |      */ | 
					
						
							|  |  |  |     private function validateNdom(string $value): bool | 
					
						
							|  |  |  |     { | 
					
						
							|  |  |  |         $parameters = explode(',', substr($value, 5)); | 
					
						
							| 
									
										
										
										
											2019-05-30 12:31:19 +02:00
										 |  |  |         if (2 !== count($parameters)) { | 
					
						
							| 
									
										
										
										
											2018-07-26 06:10:17 +02:00
										 |  |  |             return false; | 
					
						
							|  |  |  |         } | 
					
						
							|  |  |  |         $nthDay    = (int)($parameters[0] ?? 0.0); | 
					
						
							|  |  |  |         $dayOfWeek = (int)($parameters[1] ?? 0.0); | 
					
						
							|  |  |  |         if ($nthDay < 1 || $nthDay > 5) { | 
					
						
							|  |  |  |             return false; | 
					
						
							|  |  |  |         } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         return $dayOfWeek > 0 && $dayOfWeek < 8; | 
					
						
							|  |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     /** | 
					
						
							|  |  |  |      * @param string $value | 
					
						
							|  |  |  |      * | 
					
						
							|  |  |  |      * @return bool | 
					
						
							|  |  |  |      */ | 
					
						
							|  |  |  |     private function validateWeekly(string $value): bool | 
					
						
							|  |  |  |     { | 
					
						
							|  |  |  |         $dayOfWeek = (int)substr($value, 7); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         return $dayOfWeek > 0 && $dayOfWeek < 8; | 
					
						
							|  |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     /** | 
					
						
							|  |  |  |      * @param string $value | 
					
						
							|  |  |  |      * | 
					
						
							|  |  |  |      * @return bool | 
					
						
							|  |  |  |      */ | 
					
						
							|  |  |  |     private function validateYearly(string $value): bool | 
					
						
							|  |  |  |     { | 
					
						
							|  |  |  |         // rest of the string must be valid date:
 | 
					
						
							|  |  |  |         $dateString = substr($value, 7); | 
					
						
							|  |  |  |         try { | 
					
						
							|  |  |  |             Carbon::createFromFormat('Y-m-d', $dateString); | 
					
						
							|  |  |  |         } catch (InvalidArgumentException $e) { | 
					
						
							|  |  |  |             Log::debug(sprintf('Could not parse date %s: %s', $dateString, $e->getMessage())); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |             return false; | 
					
						
							|  |  |  |         } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |         return true; | 
					
						
							|  |  |  |     } | 
					
						
							| 
									
										
										
										
											2018-07-22 20:32:02 +02:00
										 |  |  | } |