nextcloud /
server
| Total Complexity | 42 |
| Total Lines | 193 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like Event often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Event, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 40 | class Event extends Base { |
||
| 41 | public const SUBJECT_OBJECT_ADD = 'object_add'; |
||
| 42 | public const SUBJECT_OBJECT_UPDATE = 'object_update'; |
||
| 43 | public const SUBJECT_OBJECT_MOVE_TO_TRASH = 'object_move_to_trash'; |
||
| 44 | public const SUBJECT_OBJECT_RESTORE = 'object_restore'; |
||
| 45 | public const SUBJECT_OBJECT_DELETE = 'object_delete'; |
||
| 46 | |||
| 47 | /** @var IFactory */ |
||
| 48 | protected $languageFactory; |
||
| 49 | |||
| 50 | /** @var IL10N */ |
||
| 51 | protected $l; |
||
| 52 | |||
| 53 | /** @var IManager */ |
||
| 54 | protected $activityManager; |
||
| 55 | |||
| 56 | /** @var IEventMerger */ |
||
| 57 | protected $eventMerger; |
||
| 58 | |||
| 59 | /** @var IAppManager */ |
||
| 60 | protected $appManager; |
||
| 61 | |||
| 62 | /** |
||
| 63 | * @param IFactory $languageFactory |
||
| 64 | * @param IURLGenerator $url |
||
| 65 | * @param IManager $activityManager |
||
| 66 | * @param IUserManager $userManager |
||
| 67 | * @param IGroupManager $groupManager |
||
| 68 | * @param IEventMerger $eventMerger |
||
| 69 | * @param IAppManager $appManager |
||
| 70 | */ |
||
| 71 | public function __construct(IFactory $languageFactory, IURLGenerator $url, IManager $activityManager, IUserManager $userManager, IGroupManager $groupManager, IEventMerger $eventMerger, IAppManager $appManager) { |
||
| 72 | parent::__construct($userManager, $groupManager, $url); |
||
| 73 | $this->languageFactory = $languageFactory; |
||
| 74 | $this->activityManager = $activityManager; |
||
| 75 | $this->eventMerger = $eventMerger; |
||
| 76 | $this->appManager = $appManager; |
||
| 77 | } |
||
| 78 | |||
| 79 | /** |
||
| 80 | * @param array $eventData |
||
| 81 | * @return array |
||
| 82 | */ |
||
| 83 | protected function generateObjectParameter(array $eventData) { |
||
| 84 | if (!isset($eventData['id']) || !isset($eventData['name'])) { |
||
| 85 | throw new \InvalidArgumentException(); |
||
| 86 | } |
||
| 87 | |||
| 88 | $params = [ |
||
| 89 | 'type' => 'calendar-event', |
||
| 90 | 'id' => $eventData['id'], |
||
| 91 | 'name' => $eventData['name'], |
||
| 92 | |||
| 93 | ]; |
||
| 94 | if (isset($eventData['link']) && is_array($eventData['link']) && $this->appManager->isEnabledForUser('calendar')) { |
||
| 95 | try { |
||
| 96 | // The calendar app needs to be manually loaded for the routes to be loaded |
||
| 97 | OC_App::loadApp('calendar'); |
||
| 98 | $linkData = $eventData['link']; |
||
| 99 | $objectId = base64_encode('/remote.php/dav/calendars/' . $linkData['owner'] . '/' . $linkData['calendar_uri'] . '/' . $linkData['object_uri']); |
||
| 100 | $link = [ |
||
| 101 | 'view' => 'dayGridMonth', |
||
| 102 | 'timeRange' => 'now', |
||
| 103 | 'mode' => 'sidebar', |
||
| 104 | 'objectId' => $objectId, |
||
| 105 | 'recurrenceId' => 'next' |
||
| 106 | ]; |
||
| 107 | $params['link'] = $this->url->linkToRouteAbsolute('calendar.view.indexview.timerange.edit', $link); |
||
| 108 | } catch (\Exception $error) { |
||
| 109 | // Do nothing |
||
| 110 | } |
||
| 111 | } |
||
| 112 | return $params; |
||
| 113 | } |
||
| 114 | |||
| 115 | /** |
||
| 116 | * @param string $language |
||
| 117 | * @param IEvent $event |
||
| 118 | * @param IEvent|null $previousEvent |
||
| 119 | * @return IEvent |
||
| 120 | * @throws \InvalidArgumentException |
||
| 121 | * @since 11.0.0 |
||
| 122 | */ |
||
| 123 | public function parse($language, IEvent $event, IEvent $previousEvent = null) { |
||
| 124 | if ($event->getApp() !== 'dav' || $event->getType() !== 'calendar_event') { |
||
| 125 | throw new \InvalidArgumentException(); |
||
| 126 | } |
||
| 127 | |||
| 128 | $this->l = $this->languageFactory->get('dav', $language); |
||
| 129 | |||
| 130 | if ($this->activityManager->getRequirePNG()) { |
||
| 131 | $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar-dark.png'))); |
||
| 132 | } else { |
||
| 133 | $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'places/calendar.svg'))); |
||
| 134 | } |
||
| 135 | |||
| 136 | if ($event->getSubject() === self::SUBJECT_OBJECT_ADD . '_event') { |
||
| 137 | $subject = $this->l->t('{actor} created event {event} in calendar {calendar}'); |
||
| 138 | } elseif ($event->getSubject() === self::SUBJECT_OBJECT_ADD . '_event_self') { |
||
| 139 | $subject = $this->l->t('You created event {event} in calendar {calendar}'); |
||
| 140 | } elseif ($event->getSubject() === self::SUBJECT_OBJECT_DELETE . '_event') { |
||
| 141 | $subject = $this->l->t('{actor} deleted event {event} from calendar {calendar}'); |
||
| 142 | } elseif ($event->getSubject() === self::SUBJECT_OBJECT_DELETE . '_event_self') { |
||
| 143 | $subject = $this->l->t('You deleted event {event} from calendar {calendar}'); |
||
| 144 | } elseif ($event->getSubject() === self::SUBJECT_OBJECT_UPDATE . '_event') { |
||
| 145 | $subject = $this->l->t('{actor} updated event {event} in calendar {calendar}'); |
||
| 146 | } elseif ($event->getSubject() === self::SUBJECT_OBJECT_UPDATE . '_event_self') { |
||
| 147 | $subject = $this->l->t('You updated event {event} in calendar {calendar}'); |
||
| 148 | } elseif ($event->getSubject() === self::SUBJECT_OBJECT_MOVE_TO_TRASH . '_event') { |
||
| 149 | $subject = $this->l->t('{actor} deleted event {event} from calendar {calendar}'); |
||
| 150 | } elseif ($event->getSubject() === self::SUBJECT_OBJECT_MOVE_TO_TRASH . '_event_self') { |
||
| 151 | $subject = $this->l->t('You deleted event {event} from calendar {calendar}'); |
||
| 152 | } elseif ($event->getSubject() === self::SUBJECT_OBJECT_RESTORE . '_event') { |
||
| 153 | $subject = $this->l->t('{actor} restored event {event} of calendar {calendar}'); |
||
| 154 | } elseif ($event->getSubject() === self::SUBJECT_OBJECT_RESTORE . '_event_self') { |
||
| 155 | $subject = $this->l->t('You restored event {event} of calendar {calendar}'); |
||
| 156 | } else { |
||
| 157 | throw new \InvalidArgumentException(); |
||
| 158 | } |
||
| 159 | |||
| 160 | $parsedParameters = $this->getParameters($event); |
||
| 161 | $this->setSubjects($event, $subject, $parsedParameters); |
||
| 162 | |||
| 163 | $event = $this->eventMerger->mergeEvents('event', $event, $previousEvent); |
||
| 164 | |||
| 165 | return $event; |
||
| 166 | } |
||
| 167 | |||
| 168 | /** |
||
| 169 | * @param IEvent $event |
||
| 170 | * @return array |
||
| 171 | */ |
||
| 172 | protected function getParameters(IEvent $event) { |
||
| 173 | $subject = $event->getSubject(); |
||
| 174 | $parameters = $event->getSubjectParameters(); |
||
| 175 | |||
| 176 | // Nextcloud 13+ |
||
| 177 | if (isset($parameters['calendar'])) { |
||
| 178 | switch ($subject) { |
||
| 179 | case self::SUBJECT_OBJECT_ADD . '_event': |
||
| 180 | case self::SUBJECT_OBJECT_DELETE . '_event': |
||
| 181 | case self::SUBJECT_OBJECT_UPDATE . '_event': |
||
| 182 | case self::SUBJECT_OBJECT_MOVE_TO_TRASH . '_event': |
||
| 183 | case self::SUBJECT_OBJECT_RESTORE . '_event': |
||
| 184 | return [ |
||
| 185 | 'actor' => $this->generateUserParameter($parameters['actor']), |
||
| 186 | 'calendar' => $this->generateCalendarParameter($parameters['calendar'], $this->l), |
||
| 187 | 'event' => $this->generateClassifiedObjectParameter($parameters['object']), |
||
| 188 | ]; |
||
| 189 | case self::SUBJECT_OBJECT_ADD . '_event_self': |
||
| 190 | case self::SUBJECT_OBJECT_DELETE . '_event_self': |
||
| 191 | case self::SUBJECT_OBJECT_UPDATE . '_event_self': |
||
| 192 | case self::SUBJECT_OBJECT_MOVE_TO_TRASH . '_event_self': |
||
| 193 | case self::SUBJECT_OBJECT_RESTORE . '_event_self': |
||
| 194 | return [ |
||
| 195 | 'calendar' => $this->generateCalendarParameter($parameters['calendar'], $this->l), |
||
| 196 | 'event' => $this->generateClassifiedObjectParameter($parameters['object']), |
||
| 197 | ]; |
||
| 198 | } |
||
| 199 | } |
||
| 200 | |||
| 201 | // Legacy - Do NOT Remove unless necessary |
||
| 202 | // Removing this will break parsing of activities that were created on |
||
| 203 | // Nextcloud 12, so we should keep this as long as it's acceptable. |
||
| 204 | // Otherwise if people upgrade over multiple releases in a short period, |
||
| 205 | // they will get the dead entries in their stream. |
||
| 206 | switch ($subject) { |
||
| 207 | case self::SUBJECT_OBJECT_ADD . '_event': |
||
| 208 | case self::SUBJECT_OBJECT_DELETE . '_event': |
||
| 209 | case self::SUBJECT_OBJECT_UPDATE . '_event': |
||
| 210 | return [ |
||
| 211 | 'actor' => $this->generateUserParameter($parameters[0]), |
||
| 212 | 'calendar' => $this->generateLegacyCalendarParameter($event->getObjectId(), $parameters[1]), |
||
| 213 | 'event' => $this->generateObjectParameter($parameters[2]), |
||
| 214 | ]; |
||
| 215 | case self::SUBJECT_OBJECT_ADD . '_event_self': |
||
| 216 | case self::SUBJECT_OBJECT_DELETE . '_event_self': |
||
| 217 | case self::SUBJECT_OBJECT_UPDATE . '_event_self': |
||
| 218 | return [ |
||
| 219 | 'calendar' => $this->generateLegacyCalendarParameter($event->getObjectId(), $parameters[1]), |
||
| 220 | 'event' => $this->generateObjectParameter($parameters[2]), |
||
| 221 | ]; |
||
| 222 | } |
||
| 223 | |||
| 224 | throw new \InvalidArgumentException(); |
||
| 225 | } |
||
| 226 | |||
| 227 | private function generateClassifiedObjectParameter(array $eventData) { |
||
| 233 | } |
||
| 234 | } |
||
| 235 |
