support multiple teamleads in each team (#2702)

* fix jumping avatars
* fix line-break after color dot for long names

src/Entity/Team.php

@@ -9,6 +9,7 @@
 
 namespace App\Entity;
 
+use App\Validator\Constraints as Constraints;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
@@ -27,13 +28,12 @@ use Symfony\Component\Validator\Constraints as Assert;
  * @UniqueEntity("name")
  *
  * @Serializer\ExclusionPolicy("all")
+ * @Constraints\Team
  */
 class Team
 {
     /**
-     * The internal ID
-     *
-     * @var int
+     * @var int|null
      *
      * @Serializer\Expose()
      * @Serializer\Groups({"Default"})
@@ -57,41 +57,23 @@ class Team
      */
     private $name;
     /**
-     * Teamlead
+     * All team member (including team leads)
      *
-     * The teamlead for this team
-     *
-     * @var User
+     * @var TeamMember[]|Collection<TeamMember>
      *
      * @Serializer\Expose()
      * @Serializer\Groups({"Team_Entity"})
-     * @SWG\Property(ref="#/definitions/User")
+     * @SWG\Property(type="array", @SWG\Items(ref="#/definitions/TeamMember"))
      *
-     * @ORM\ManyToOne(targetEntity="App\Entity\User")
-     * @ORM\JoinColumn(onDelete="CASCADE", nullable=false)
-     * @Assert\NotNull()
+     * @ORM\OneToMany(targetEntity="App\Entity\TeamMember", mappedBy="team", fetch="LAZY", cascade={"persist"}, orphanRemoval=true)
+     * @ORM\JoinColumn(onDelete="CASCADE")
+     * @Assert\Count(min="1")
      */
-    private $teamlead;
+    private $members;
     /**
-     * Team member
+     * Customers assigned to the team
      *
-     * All team member, including the teamlead
-     *
-     * @var User[]|ArrayCollection
-     *
-     * @Serializer\Expose()
-     * @Serializer\Groups({"Team_Entity"})
-     * @SWG\Property(type="array", @SWG\Items(ref="#/definitions/User"))
-     *
-     * @ORM\ManyToMany(targetEntity="User", mappedBy="teams", fetch="EXTRA_LAZY")
-     */
-    private $users;
-    /**
-     * Customers
-     *
-     * All customers assigned to the team
-     *
-     * @var Customer[]|ArrayCollection
+     * @var Collection<Customer>
      *
      * @Serializer\Expose()
      * @Serializer\Groups({"Team_Entity"})
@@ -101,11 +83,9 @@ class Team
      */
     private $customers;
     /**
-     * Projects
+     * Projects assigned to the team
      *
-     * All projects assigned to the team
-     *
-     * @var Project[]|ArrayCollection
+     * @var Collection<Project>
      *
      * @Serializer\Expose()
      * @Serializer\Groups({"Team_Entity", "Expanded"})
@@ -115,11 +95,9 @@ class Team
      */
     private $projects;
     /**
-     * Activities
+     * Activities assigned to the team
      *
-     * All activities assigned to the team
-     *
-     * @var Activity[]|ArrayCollection
+     * @var Collection<Activity>
      *
      * @Serializer\Expose()
      * @Serializer\Groups({"Team_Entity", "Expanded"})
@@ -133,7 +111,7 @@ class Team
 
     public function __construct()
     {
-        $this->users = new ArrayCollection();
+        $this->members = new ArrayCollection();
         $this->customers = new ArrayCollection();
         $this->projects = new ArrayCollection();
         $this->activities = new ArrayCollection();
@@ -156,55 +134,237 @@ class Team
         return $this->name;
     }
 
-    public function getTeamLead(): ?User
+    /**
+     * Indexed by ID to use it within collection type forms.
+     *
+     * @return TeamMember[]
+     */
+    public function getMembers(): iterable
     {
-        return $this->teamlead;
+        $all = [];
+        foreach ($this->members as $member) {
+            if ($member->getId() === null) {
+                $all[] = $member;
+            } else {
+                $all[$member->getId()] = $member;
+            }
+        }
+
+        return $all;
+    }
+
+    public function addMember(TeamMember $member): void
+    {
+        if ($this->members->contains($member)) {
+            return;
+        }
+
+        if ($member->getTeam() === null) {
+            $member->setTeam($this);
+        }
+
+        if ($member->getTeam() !== $this) {
+            throw new \InvalidArgumentException('Cannot set foreign team membership');
+        }
+
+        if (null !== ($existing = $this->findMember($member))) {
+            $existing->setTeamlead($member->isTeamlead());
+
+            return;
+        }
+
+        // when using the API an invalid user id does not trigger the validation first, but after calling this method :-(
+        if ($member->getUser() !== null) {
+            $this->members->add($member);
+            $member->getUser()->addMembership($member);
+        }
+    }
+
+    public function hasMember(TeamMember $member): bool
+    {
+        return $this->members->contains($member);
+    }
+
+    private function findMember(TeamMember $member): ?TeamMember
+    {
+        foreach ($this->members as $oldMember) {
+            if ($oldMember->getUser() === $member->getUser() && $oldMember->getTeam() === $member->getTeam()) {
+                return $oldMember;
+            }
+        }
+
+        return null;
+    }
+
+    public function removeMember(TeamMember $member): void
+    {
+        $existingMember = $this->findMember($member);
+        if ($existingMember === null) {
+            return;
+        }
+
+        $this->members->removeElement($existingMember);
+        $existingMember->getUser()->removeMembership($existingMember);
+    }
+
+    /**
+     * BE AWARE: this property is deprecated and will be removed with 2.0 - teams can have multiple teamleads since 1.15!
+     *
+     * @Serializer\VirtualProperty
+     * @Serializer\SerializedName("teamlead"),
+     * @Serializer\Groups({"Team_Entity"})
+     * @SWG\Property(ref="#/definitions/User")
+     *
+     * @deprecated since 1.15 - will be removed with 2.0
+     * @return User|null
+     */
+    public function getTeamlead(): ?User
+    {
+        foreach ($this->members as $member) {
+            if ($member->isTeamlead()) {
+                return $member->getUser();
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * @return User[]
+     */
+    public function getTeamleads(): array
+    {
+        $leads = [];
+        foreach ($this->members as $member) {
+            if ($member->isTeamlead()) {
+                $leads[] = $member->getUser();
+            }
+        }
+
+        return $leads;
     }
 
     public function isTeamlead(User $user): bool
     {
-        return $this->teamlead === $user;
+        foreach ($this->members as $member) {
+            if ($user === $member->getUser()) {
+                return $member->isTeamlead();
+            }
+        }
+
+        return false;
     }
 
-    public function setTeamLead(User $teamlead): Team
+    /**
+     * @deprecated since 1.15 - will be removed with 2.0
+     * @param User $teamlead
+     */
+    public function setTeamlead(User $teamlead): void
     {
-        $this->teamlead = $teamlead;
-        $this->addUser($teamlead);
+        $this->addTeamlead($teamlead);
+    }
 
-        return $this;
+    public function addTeamlead(User $user): void
+    {
+        $this->addUser($user, true);
+    }
+
+    /**
+     * Will only remove the teamlead flag, not the user from the team.
+     *
+     * @param User $user
+     */
+    public function removeTeamlead(User $user): void
+    {
+        foreach ($this->members as $member) {
+            if ($member->getUser() === $user) {
+                $member->setTeamlead(false);
+
+                return;
+            }
+        }
     }
 
     public function hasUser(User $user): bool
     {
-        return $this->users->contains($user);
+        foreach ($this->members as $member) {
+            if ($member->getUser() === $user) {
+                return true;
+            }
+        }
+
+        return false;
     }
 
-    public function addUser(User $user)
+    public function hasUsers(): bool
     {
-        if ($this->users->contains($user)) {
+        return !$this->members->isEmpty();
+    }
+
+    public function hasTeamleads(): bool
+    {
+        foreach ($this->members as $member) {
+            if ($member->isTeamlead()) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    public function addUser(User $user, bool $teamlead = false): void
+    {
+        foreach ($this->members as $member) {
+            if ($member->getUser() === $user) {
+                $member->setTeamlead($teamlead);
+
+                return;
+            }
+        }
+
+        $member = new TeamMember();
+        $member->setTeam($this);
+        $member->setUser($user);
+        $member->setTeamlead($teamlead);
+
+        $this->addMember($member);
+    }
+
+    public function removeUser(User $user): void
+    {
+        $memberToRemove = null;
+        foreach ($this->members as $member) {
+            if ($member->getUser() === $user) {
+                $memberToRemove = $member;
+                break;
+            }
+        }
+
+        if ($memberToRemove === null) {
             return;
         }
 
-        $this->users->add($user);
-        $user->addTeam($this);
-    }
-
-    public function removeUser(User $user)
-    {
-        if (!$this->users->contains($user)) {
-            return;
-        }
-
-        $this->users->removeElement($user);
-        $user->removeTeam($this);
+        $this->removeMember($memberToRemove);
     }
 
     /**
-     * @return Collection<User>
+     * Returns all users in the team, both teamlead and normal member.
+     *
+     * @Serializer\VirtualProperty
+     * @Serializer\SerializedName("users"),
+     * @Serializer\Groups({"Team_Entity"})
+     * @SWG\Property(ref="#/definitions/User")
+     *
+     * @return array<User>
      */
     public function getUsers(): iterable
     {
-        return $this->users;
+        $users = [];
+        foreach ($this->members as $member) {
+            $users[] = $member->getUser();
+        }
+
+        return $users;
     }
 
     public function hasCustomer(Customer $customer): bool
@@ -313,4 +473,37 @@ class Team
     {
         return $this->getName();
     }
+
+    public function __clone()
+    {
+        if ($this->id !== null) {
+            $this->id = null;
+        }
+
+        $members = $this->members;
+        $this->members = new ArrayCollection();
+        foreach ($members as $member) {
+            $newMember = clone $member;
+            $newMember->setTeam($this);
+            $this->addMember($newMember);
+        }
+
+        $customers = $this->customers;
+        $this->customers = new ArrayCollection();
+        foreach ($customers as $customer) {
+            $this->addCustomer($customer);
+        }
+
+        $projects = $this->projects;
+        $this->projects = new ArrayCollection();
+        foreach ($projects as $project) {
+            $this->addProject($project);
+        }
+
+        $activities = $this->activities;
+        $this->activities = new ArrayCollection();
+        foreach ($activities as $activity) {
+            $this->addActivity($activity);
+        }
+    }
 }

src/Entity/TeamMember.php

@@ -0,0 +1,113 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use JMS\Serializer\Annotation as Serializer;
+use Swagger\Annotations as SWG;
+use Symfony\Component\Validator\Constraints as Assert;
+
+/**
+ * @ORM\Table(name="kimai2_users_teams",
+ *      uniqueConstraints={
+ *          @ORM\UniqueConstraint(columns={"user_id", "team_id"})
+ *      }
+ * )
+ * @ORM\Entity
+ *
+ * @Serializer\ExclusionPolicy("all")
+ */
+class TeamMember
+{
+    /**
+     * @var int|null
+     *
+     * @ORM\Column(name="id", type="integer")
+     * @ORM\Id
+     * @ORM\GeneratedValue(strategy="IDENTITY")
+     */
+    private $id;
+    /**
+     * @var User
+     *
+     * @Serializer\Expose()
+     * @Serializer\Groups({"Default", "Entity", "Team_Entity"})
+     * @SWG\Property(ref="#/definitions/User")
+     *
+     * @ORM\ManyToOne(targetEntity="App\Entity\User", inversedBy="memberships")
+     * @ORM\JoinColumn(onDelete="CASCADE", nullable=false)
+     * @Assert\NotNull()
+     */
+    private $user;
+    /**
+     * @var Team
+     *
+     * @Serializer\Expose()
+     * @Serializer\Groups({"Default", "Entity", "User_Entity"})
+     * @SWG\Property(ref="#/definitions/TeamEntity")
+     *
+     * @ORM\ManyToOne(targetEntity="App\Entity\Team", inversedBy="members")
+     * @ORM\JoinColumn(onDelete="CASCADE", nullable=false)
+     * @Assert\NotNull()
+     */
+    private $team;
+    /**
+     * @var bool
+     *
+     * @Serializer\Expose()
+     * @Serializer\Groups({"Default", "Entity", "Team_Entity", "User_Entity"})
+     *
+     * @ORM\Column(name="teamlead", type="boolean", nullable=false, options={"default": false})
+     * @Assert\NotNull()
+     */
+    private $teamlead = false;
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
+    public function isTeamlead(): bool
+    {
+        return $this->teamlead;
+    }
+
+    public function setTeamlead(bool $teamlead): void
+    {
+        $this->teamlead = $teamlead;
+    }
+
+    public function getUser(): ?User
+    {
+        return $this->user;
+    }
+
+    public function setUser(?User $user): void
+    {
+        $this->user = $user;
+    }
+
+    public function getTeam(): ?Team
+    {
+        return $this->team;
+    }
+
+    public function setTeam(?Team $team): void
+    {
+        $this->team = $team;
+    }
+
+    public function __clone()
+    {
+        if ($this->id !== null) {
+            $id = null;
+        }
+    }
+}

src/Entity/User.php

@@ -19,6 +19,7 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 use Exception;
 use JMS\Serializer\Annotation as Serializer;
+use Swagger\Annotations as SWG;
 use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
 use Symfony\Component\Security\Core\User\EquatableInterface;
 use Symfony\Component\Security\Core\User\UserInterface;
@@ -63,7 +64,7 @@ use Symfony\Component\Validator\Constraints as Assert;
  * @Exporter\Expose("language", label="label.language", exp="object.getLanguage()")
  * @Exporter\Expose("last_login", label="label.lastLogin", exp="object.getLastLogin()", type="datetime")
  * @Exporter\Expose("roles", label="label.roles", exp="object.getRoles()", type="array")
- * @ Exporter\Expose("teams", label="label.team", exp="object.getTeams().toArray()", type="array")
+ * @ Exporter\Expose("teams", label="label.team", exp="object.getTeams()", type="array")
  * @Exporter\Expose("active", label="label.active", exp="object.isEnabled()", type="boolean")
  */
 class User implements UserInterface, EquatableInterface, \Serializable
@@ -172,25 +173,17 @@ class User implements UserInterface, EquatableInterface, \Serializable
      */
     private $preferences;
     /**
-     * All teams of the user
-     *
-     * @var Team[]|ArrayCollection
+     * @var TeamMember[]|ArrayCollection<TeamMember>
      *
      * @Serializer\Expose()
      * @Serializer\Groups({"User_Entity"})
+     * @SWG\Property(ref="#/definitions/TeamMembership")
      *
-     * @ORM\ManyToMany(targetEntity="Team", inversedBy="users", cascade={"persist"})
-     * @ORM\JoinTable(
-     *  name="kimai2_users_teams",
-     *  joinColumns={
-     *      @ORM\JoinColumn(name="user_id", referencedColumnName="id", onDelete="CASCADE")
-     *  },
-     *  inverseJoinColumns={
-     *      @ORM\JoinColumn(name="team_id", referencedColumnName="id", onDelete="CASCADE")
-     *  }
-     * )
+     * @ORM\OneToMany(targetEntity="App\Entity\TeamMember", mappedBy="user", fetch="LAZY", cascade={"persist"}, orphanRemoval=true)
+     * @ORM\JoinColumn(onDelete="CASCADE")
+     * @Assert\NotNull()
      */
-    private $teams;
+    private $memberships;
     /**
      * The type of authentication used by the user (eg. "kimai", "ldap", "saml")
      *
@@ -296,7 +289,7 @@ class User implements UserInterface, EquatableInterface, \Serializable
     {
         $this->registeredAt = new DateTime();
         $this->preferences = new ArrayCollection();
-        $this->teams = new ArrayCollection();
+        $this->memberships = new ArrayCollection();
     }
 
     public function getId(): ?int
@@ -515,37 +508,99 @@ class User implements UserInterface, EquatableInterface, \Serializable
         return $this;
     }
 
-    public function addTeam(Team $team): User
+    public function addMembership(TeamMember $member): void
     {
-        if ($this->teams->contains($team)) {
-            return $this;
-        }
-
-        $this->teams->add($team);
-        $team->addUser($this);
-
-        return $this;
-    }
-
-    public function removeTeam(Team $team)
-    {
-        if (!$this->teams->contains($team)) {
+        if ($this->memberships->contains($member)) {
             return;
         }
-        $this->teams->removeElement($team);
-        $team->removeUser($this);
+
+        if ($member->getUser() === null) {
+            $member->setUser($this);
+        }
+
+        if ($member->getUser() !== $this) {
+            throw new \InvalidArgumentException('Cannot set foreign user membership');
+        }
+
+        if (null !== ($existing = $this->findMember($member))) {
+            $existing->setTeamlead($member->isTeamlead());
+
+            return;
+        }
+
+        // when using the API an invalid team id does not trigger the validation first, but after calling this method :-(
+        if ($member->getTeam() !== null) {
+            $this->memberships->add($member);
+            $member->getTeam()->addMember($member);
+        }
     }
 
+    public function removeMembership(TeamMember $member): void
+    {
+        $existingMember = $this->findMember($member);
+        if ($existingMember === null) {
+            return;
+        }
+
+        $this->memberships->removeElement($existingMember);
+        $existingMember->getUser()->removeMembership($existingMember);
+    }
+
+    /**
+     * Indexed by ID to use it within collection type forms.
+     *
+     * @return TeamMember[]
+     */
+    public function getMemberships(): iterable
+    {
+        $all = [];
+        foreach ($this->memberships as $member) {
+            if ($member->getId() === null) {
+                $all[] = $member;
+            } else {
+                $all[$member->getId()] = $member;
+            }
+        }
+
+        return $all;
+    }
+
+    public function hasMembership(TeamMember $member): bool
+    {
+        return $this->memberships->contains($member);
+    }
+
+    private function findMember(TeamMember $member): ?TeamMember
+    {
+        foreach ($this->memberships as $oldMember) {
+            if ($oldMember->getUser() === $member->getUser() && $oldMember->getTeam() === $member->getTeam()) {
+                return $oldMember;
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * Checks if the user is member of any team.
+     *
+     * @return bool
+     */
     public function hasTeamAssignment(): bool
     {
-        return !$this->getTeams()->isEmpty();
+        return !$this->memberships->isEmpty();
     }
 
-    public function hasTeamMember(User $user): bool
+    /**
+     * Checks is the user is teamlead in any of the assigned teams.
+     *
+     * @see User::hasTeamleadRole()
+     * @return bool
+     */
+    public function isTeamlead(): bool
     {
-        /** @var Team $team */
-        foreach ($this->getTeams() as $team) {
-            if ($team->hasUser($user)) {
+        foreach ($this->memberships as $membership) {
+            if ($membership->isTeamlead()) {
                 return true;
             }
         }
@@ -554,21 +609,96 @@ class User implements UserInterface, EquatableInterface, \Serializable
     }
 
     /**
-     * @return Collection<Team>
+     * Checks if the given user is a team member.
+     *
+     * @param User $user
+     * @return bool
      */
-    public function getTeams(): Collection
+    public function hasTeamMember(User $user): bool
     {
-        return $this->teams;
+        foreach ($this->memberships as $membership) {
+            if ($membership->getTeam()->hasUser($user)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * @Serializer\VirtualProperty
+     * @Serializer\SerializedName("teams"),
+     * @Serializer\Groups({"User_Entity"})
+     * @SWG\Property(ref="#/definitions/TeamEntity")
+     *
+     * @return Team[]
+     */
+    public function getTeams(): iterable
+    {
+        $teams = [];
+        foreach ($this->memberships as $membership) {
+            $teams[] = $membership->getTeam();
+        }
+
+        return $teams;
+    }
+
+    /**
+     * Required in the User profile screen to edit his teams.
+     *
+     * @param Team $team
+     */
+    public function addTeam(Team $team): void
+    {
+        foreach ($this->memberships as $membership) {
+            if ($membership->getTeam() === $team) {
+                return;
+            }
+        }
+
+        $membership = new TeamMember();
+        $membership->setUser($this);
+        $membership->setTeam($team);
+
+        $this->addMembership($membership);
+    }
+
+    /**
+     * Required in the User profile screen to edit his teams.
+     *
+     * @param Team $team
+     */
+    public function removeTeam(Team $team): void
+    {
+        foreach ($this->memberships as $membership) {
+            if ($membership->getTeam() === $team) {
+                $this->removeMembership($membership);
+
+                return;
+            }
+        }
     }
 
     public function isInTeam(Team $team): bool
     {
-        return $this->teams->contains($team);
+        foreach ($this->memberships as $membership) {
+            if ($membership->getTeam() === $team) {
+                return true;
+            }
+        }
+
+        return false;
     }
 
     public function isTeamleadOf(Team $team): bool
     {
-        return $team->getTeamLead() === $this;
+        foreach ($this->memberships as $membership) {
+            if ($membership->getTeam() === $team) {
+                return $membership->isTeamlead();
+            }
+        }
+
+        return false;
     }
 
     public function canSeeAllData(): bool
@@ -596,7 +726,7 @@ class User implements UserInterface, EquatableInterface, \Serializable
         return true;
     }
 
-    public function isTeamlead(): bool
+    public function hasTeamleadRole(): bool
     {
         return $this->hasRole(static::ROLE_TEAMLEAD);
     }
@@ -698,6 +828,11 @@ class User implements UserInterface, EquatableInterface, \Serializable
 
     public function getLastLogin(): ?DateTime
     {
+        if ($this->lastLogin !== null) {
+            // make sure to use the users own timezone
+            $this->lastLogin->setTimeZone(new \DateTimeZone($this->getTimezone()));
+        }
+
         return $this->lastLogin;
     }