Refactoring and renaming public_calendars_enabled

Author: tchapi

.env

@@ -69,8 +69,8 @@ CALDAV_ENABLED=true
 CARDDAV_ENABLED=true
 WEBDAV_ENABLED=false
 
-# Can calendar be public available ?
-PUBLIC_CALENDAR_ENABLED=true
+# Do we allow calendars to be public ?
+PUBLIC_CALENDARS_ENABLED=true
 
 # What mail is used as the sender for invites ?
 INVITE_FROM_ADDRESS=[email protected]

config/services.yaml

@@ -7,8 +7,8 @@ parameters:
     default_database_driver: "mysql"
     default_admin_auth_bypass: "false"
     timezone: '%env(APP_TIMEZONE)%'
-    public_calendar_enabled: '%env(default:default_public_calendar_enabled:bool:PUBLIC_CALENDAR_ENABLED)%'
-    default_public_calendar_enabled: "true"
+    public_calendars_enabled: '%env(default:default_public_calendars_enabled:bool:PUBLIC_CALENDARS_ENABLED)%'
+    default_public_calendars_enabled: "true"
 
 services:
     # default configuration for services in *this* file
@@ -51,7 +51,7 @@ services:
             $calDAVEnabled: "%env(bool:CALDAV_ENABLED)%"
             $cardDAVEnabled: "%env(bool:CARDDAV_ENABLED)%"
             $webDAVEnabled: "%env(bool:WEBDAV_ENABLED)%"
-            $publicCalendarEnabled: "%env(default:default_public_calendar_enabled:bool:PUBLIC_CALENDAR_ENABLED)%"
+            $publicCalendarsEnabled: "%public_calendars_enabled%"
             $inviteAddress: "%env(INVITE_FROM_ADDRESS)%"
             $authMethod: "%env(AUTH_METHOD)%"
             $authRealm: "%env(AUTH_REALM)%"

src/Controller/Admin/CalendarController.php

@@ -80,20 +80,20 @@ public function calendarEdit(ManagerRegistry $doctrine, Request $request, string
             $calendarInstance->setCalendar($calendar);
         }
 
-        $isPublicCalendarEnabled = $this->getParameter('public_calendar_enabled');
+        $arePublicCalendarsEnabled = $this->getParameter('public_calendars_enabled');
 
         $form = $this->createForm(CalendarInstanceType::class, $calendarInstance, [
             'new' => !$id,
             'shared' => $calendarInstance->isShared(),
-            'public_calendar_enabled' => $isPublicCalendarEnabled
+            'public_calendars_enabled' => $arePublicCalendarsEnabled,
         ]);
 
         $components = explode(',', $calendarInstance->getCalendar()->getComponents());
 
         $form->get('events')->setData(in_array(Calendar::COMPONENT_EVENTS, $components));
         $form->get('todos')->setData(in_array(Calendar::COMPONENT_TODOS, $components));
         $form->get('notes')->setData(in_array(Calendar::COMPONENT_NOTES, $components));
-        if ($isPublicCalendarEnabled) {
+        if ($arePublicCalendarsEnabled) {
             $form->get('public')->setData($calendarInstance->isPublic());
         }
         $form->get('principalUri')->setData(Principal::PREFIX.$username);
@@ -115,7 +115,7 @@ public function calendarEdit(ManagerRegistry $doctrine, Request $request, string
                 if ($form->get('notes')->getData()) {
                     $components[] = Calendar::COMPONENT_NOTES;
                 }
-                if ($isPublicCalendarEnabled && true === $form->get('public')->getData()) {
+                if ($arePublicCalendarsEnabled && true === $form->get('public')->getData()) {
                     $calendarInstance->setAccess(CalendarInstance::ACCESS_PUBLIC);
                 } else {
                     $calendarInstance->setAccess(CalendarInstance::ACCESS_SHAREDOWNER);
@@ -125,7 +125,7 @@ public function calendarEdit(ManagerRegistry $doctrine, Request $request, string
             }
 
             // We want to remove all shares if a calendar goes public
-            if ($isPublicCalendarEnabled && true === $form->get('public')->getData() && $id) {
+            if ($arePublicCalendarsEnabled && true === $form->get('public')->getData() && $id) {
                 $calendarId = $calendarInstance->getCalendar()->getId();
                 $instances = $doctrine->getRepository(CalendarInstance::class)->findSharedInstancesOfInstance($calendarId, false);
                 foreach ($instances as $instance) {

src/Controller/DAVController.php

@@ -48,11 +48,11 @@ class DAVController extends AbstractController
     protected $webDAVEnabled;
 
     /**
-     * is Public Calendar enabled?
+     * Are public calendars enabled?
      *
      * @var bool
      */
-    protected $publicCalendarEnabled;
+    protected $publicCalendarsEnabled;
 
     /**
      * Mail address to send mails from.
@@ -142,14 +142,14 @@ class DAVController extends AbstractController
      */
     protected $server;
 
-    public function __construct(MailerInterface $mailer, BasicAuth $basicAuthBackend, IMAPAuth $IMAPAuthBackend, LDAPAuth $LDAPAuthBackend, UrlGeneratorInterface $router, EntityManagerInterface $entityManager, LoggerInterface $logger, string $publicDir, bool $calDAVEnabled = true, bool $cardDAVEnabled = true, bool $webDAVEnabled = false, bool $publicCalendarEnabled, ?string $inviteAddress = null, ?string $authMethod = null, ?string $authRealm = null, ?string $webdavPublicDir = null, ?string $webdavHomesDir = null, ?string $webdavTmpDir = null)
+    public function __construct(MailerInterface $mailer, BasicAuth $basicAuthBackend, IMAPAuth $IMAPAuthBackend, LDAPAuth $LDAPAuthBackend, UrlGeneratorInterface $router, EntityManagerInterface $entityManager, LoggerInterface $logger, string $publicDir, bool $calDAVEnabled = true, bool $cardDAVEnabled = true, bool $webDAVEnabled = false, bool $publicCalendarsEnabled = true, ?string $inviteAddress = null, ?string $authMethod = null, ?string $authRealm = null, ?string $webdavPublicDir = null, ?string $webdavHomesDir = null, ?string $webdavTmpDir = null)
     {
         $this->publicDir = $publicDir;
 
         $this->calDAVEnabled = $calDAVEnabled;
         $this->cardDAVEnabled = $cardDAVEnabled;
         $this->webDAVEnabled = $webDAVEnabled;
-        $this->publicCalendarEnabled = $publicCalendarEnabled;
+        $this->publicCalendarsEnabled = $publicCalendarsEnabled;
         $this->inviteAddress = $inviteAddress ?? null;
 
         $this->webdavPublicDir = $webdavPublicDir;
@@ -238,7 +238,7 @@ private function initServer(string $authMethod, string $authRealm = User::DEFAUL
         $this->server->addPlugin(new \Sabre\DAV\Browser\Plugin(false)); // We disable the file creation / upload / sharing in the browser
         $this->server->addPlugin(new \Sabre\DAV\Sync\Plugin());
 
-        $aclPlugin = new PublicAwareDAVACLPlugin($this->em, $this->publicCalendarEnabled);
+        $aclPlugin = new PublicAwareDAVACLPlugin($this->em, $this->publicCalendarsEnabled);
         $aclPlugin->hideNodesFromListings = true;
 
         // Fetch admins, if any

src/Entity/CalendarInstance.php

@@ -40,7 +40,7 @@ public static function getOwnerAccesses(): array
     #[ORM\Column(type: 'integer')]
     private $id;
 
-    #[ORM\ManyToOne(targetEntity: "App\Entity\Calendar", cascade: ['persist'], inversedBy: "instances")]
+    #[ORM\ManyToOne(targetEntity: "App\Entity\Calendar", cascade: ['persist'], inversedBy: 'instances')]
     #[ORM\JoinColumn(name: 'calendarid', nullable: false)]
     private $calendar;
 

src/Form/CalendarInstanceType.php

@@ -74,7 +74,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                 'label' => 'save',
             ]);
 
-        if (!$options['public_calendar_enabled']) {
+        if (!$options['public_calendars_enabled']) {
             $builder->remove('public');
         }
     }
@@ -85,7 +85,7 @@ public function configureOptions(OptionsResolver $resolver): void
             'new' => false,
             'shared' => false,
             'data_class' => CalendarInstance::class,
-            'public_calendar_enabled' => true
+            'public_calendars_enabled' => true,
         ]);
     }
 }

src/Plugins/PublicAwareDAVACLPlugin.php

@@ -17,12 +17,12 @@ class PublicAwareDAVACLPlugin extends \Sabre\DAVACL\Plugin
     /**
      * @var bool
      */
-    protected $public_calendar_enabled;
+    protected $public_calendars_enabled;
 
-    public function __construct(EntityManagerInterface $entityManager, bool $public_enabled)
+    public function __construct(EntityManagerInterface $entityManager, bool $public_calendars_enabled)
     {
         $this->em = $entityManager;
-        $this->public_calendar_enabled = $public_enabled;
+        $this->public_calendars_enabled = $public_calendars_enabled;
     }
 
     /**
@@ -44,7 +44,7 @@ public function getAcl($node): array
         $acl = parent::getAcl($node);
 
         if ($node instanceof \Sabre\CalDAV\Calendar) {
-            if (CalendarInstance::ACCESS_PUBLIC === $node->getShareAccess()) {
+            if (CalendarInstance::ACCESS_PUBLIC === $node->getShareAccess() && $this->public_calendars_enabled) {
                 // We must add the ACL on the calendar itself
                 $acl[] = [
                     'principal' => '{DAV:}unauthenticated',
@@ -61,7 +61,7 @@ public function getAcl($node): array
 
             $calendar = $this->em->getRepository(CalendarInstance::class)->findOneById($calendarInstanceId);
 
-            if ($calendar && $calendar->isPublic() && $this->public_calendar_enabled) {
+            if ($calendar && $calendar->isPublic() && $this->public_calendars_enabled) {
                 // We must add the ACL on the object itself
                 $acl[] = [
                     'principal' => '{DAV:}unauthenticated',