use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ORM\Mapping as ORM;
use Hateoas\Configuration\Annotation as Hateoas;
-use JMS\Serializer\Annotation\Groups;
-use JMS\Serializer\Annotation\XmlRoot;
use JMS\Serializer\Annotation\Exclude;
-use JMS\Serializer\Annotation\VirtualProperty;
+use JMS\Serializer\Annotation\Groups;
use JMS\Serializer\Annotation\SerializedName;
+use JMS\Serializer\Annotation\VirtualProperty;
+use JMS\Serializer\Annotation\XmlRoot;
use Symfony\Component\Validator\Constraints as Assert;
-use Wallabag\UserBundle\Entity\User;
use Wallabag\AnnotationBundle\Entity\Annotation;
+use Wallabag\CoreBundle\Helper\EntityTimestampsTrait;
+use Wallabag\CoreBundle\Helper\UrlHasher;
+use Wallabag\UserBundle\Entity\User;
/**
* Entry.
* @ORM\Table(
* name="`entry`",
* options={"collate"="utf8mb4_unicode_ci", "charset"="utf8mb4"},
- * indexes={@ORM\Index(name="created_at", columns={"created_at"})}
+ * indexes={
+ * @ORM\Index(name="created_at", columns={"created_at"}),
+ * @ORM\Index(name="uid", columns={"uid"}),
+ * @ORM\Index(name="hashed_urls_user_id", columns={"user_id", "hashed_url", "hashed_given_url"}, options={"lengths"={null, 40, 40}})
+ * }
* )
* @ORM\HasLifecycleCallbacks()
* @Hateoas\Relation("self", href = "expr('/api/entries/' ~ object.getId())")
*/
class Entry
{
+ use EntityTimestampsTrait;
+
/** @Serializer\XmlAttribute */
/**
* @var int
/**
* @var string
*
- * @ORM\Column(name="uuid", type="text", nullable=true)
+ * @ORM\Column(name="uid", type="string", length=23, nullable=true)
*
* @Groups({"entries_for_user", "export_all"})
*/
- private $uuid;
+ private $uid;
/**
* @var string
private $title;
/**
+ * Define the url fetched by wallabag (the final url after potential redirections).
+ *
* @var string
*
* @Assert\NotBlank()
*/
private $url;
+ /**
+ * @var string
+ *
+ * @ORM\Column(name="hashed_url", type="string", length=40, nullable=true)
+ */
+ private $hashedUrl;
+
+ /**
+ * From where user retrieved/found the url (an other article, a twitter, or the given_url if non are provided).
+ *
+ * @var string
+ *
+ * @ORM\Column(name="origin_url", type="text", nullable=true)
+ *
+ * @Groups({"entries_for_user", "export_all"})
+ */
+ private $originUrl;
+
+ /**
+ * Define the url entered by the user (without redirections).
+ *
+ * @var string
+ *
+ * @ORM\Column(name="given_url", type="text", nullable=true)
+ *
+ * @Groups({"entries_for_user", "export_all"})
+ */
+ private $givenUrl;
+
+ /**
+ * @var string
+ *
+ * @ORM\Column(name="hashed_given_url", type="string", length=40, nullable=true)
+ */
+ private $hashedGivenUrl;
+
/**
* @var bool
*
*/
private $isArchived = false;
+ /**
+ * @var \DateTime
+ *
+ * @ORM\Column(name="archived_at", type="datetime", nullable=true)
+ *
+ * @Groups({"entries_for_user", "export_all"})
+ */
+ private $archivedAt = null;
+
/**
* @var bool
*
*/
private $updatedAt;
+ /**
+ * @var \DateTime
+ *
+ * @ORM\Column(name="published_at", type="datetime", nullable=true)
+ *
+ * @Groups({"entries_for_user", "export_all"})
+ */
+ private $publishedAt;
+
+ /**
+ * @var array
+ *
+ * @ORM\Column(name="published_by", type="array", nullable=true)
+ *
+ * @Groups({"entries_for_user", "export_all"})
+ */
+ private $publishedBy;
+
+ /**
+ * @var \DateTime
+ *
+ * @ORM\Column(name="starred_at", type="datetime", nullable=true)
+ *
+ * @Groups({"entries_for_user", "export_all"})
+ */
+ private $starredAt = null;
+
/**
* @ORM\OneToMany(targetEntity="Wallabag\AnnotationBundle\Entity\Annotation", mappedBy="entry", cascade={"persist", "remove"})
* @ORM\JoinTable
/**
* @var int
*
- * @ORM\Column(name="reading_time", type="integer", nullable=true)
+ * @ORM\Column(name="reading_time", type="integer", nullable=false)
*
* @Groups({"entries_for_user", "export_all"})
*/
- private $readingTime;
+ private $readingTime = 0;
/**
* @var string
private $previewPicture;
/**
- * @var bool
+ * @var string
*
- * @ORM\Column(name="is_public", type="boolean", nullable=true, options={"default" = false})
+ * @ORM\Column(name="http_status", type="string", length=3, nullable=true)
*
- * @Groups({"export_all"})
+ * @Groups({"entries_for_user", "export_all"})
+ */
+ private $httpStatus;
+
+ /**
+ * @var array
+ *
+ * @ORM\Column(name="headers", type="array", nullable=true)
+ *
+ * @Groups({"entries_for_user", "export_all"})
*/
- private $isPublic;
+ private $headers;
/**
* @Exclude
public function setUrl($url)
{
$this->url = $url;
+ $this->hashedUrl = UrlHasher::hashUrl($url);
return $this;
}
return $this;
}
+ /**
+ * update isArchived and archive_at fields.
+ *
+ * @param bool $isArchived
+ *
+ * @return Entry
+ */
+ public function updateArchived($isArchived = false)
+ {
+ $this->setArchived($isArchived);
+ $this->setArchivedAt(null);
+ if ($this->isArchived()) {
+ $this->setArchivedAt(new \DateTime());
+ }
+
+ return $this;
+ }
+
+ /**
+ * @return \DateTime|null
+ */
+ public function getArchivedAt()
+ {
+ return $this->archivedAt;
+ }
+
+ /**
+ * @param \DateTime|null $archivedAt
+ *
+ * @return Entry
+ */
+ public function setArchivedAt($archivedAt = null)
+ {
+ $this->archivedAt = $archivedAt;
+
+ return $this;
+ }
+
/**
* Get isArchived.
*
public function toggleArchive()
{
- $this->isArchived = $this->isArchived() ^ 1;
+ $this->updateArchived($this->isArchived() ^ 1);
return $this;
}
}
/**
- * @ORM\PrePersist
- * @ORM\PreUpdate
+ * @return \DateTime|null
+ */
+ public function getStarredAt()
+ {
+ return $this->starredAt;
+ }
+
+ /**
+ * @param \DateTime|null $starredAt
+ *
+ * @return Entry
+ */
+ public function setStarredAt($starredAt = null)
+ {
+ $this->starredAt = $starredAt;
+
+ return $this;
+ }
+
+ /**
+ * update isStarred and starred_at fields.
+ *
+ * @param bool $isStarred
+ *
+ * @return Entry
*/
- public function timestamps()
+ public function updateStar($isStarred = false)
{
- if (is_null($this->createdAt)) {
- $this->createdAt = new \DateTime();
+ $this->setStarred($isStarred);
+ $this->setStarredAt(null);
+ if ($this->isStarred()) {
+ $this->setStarredAt(new \DateTime());
}
- $this->updatedAt = new \DateTime();
+ return $this;
}
/**
}
/**
- * @return bool
- */
- public function isPublic()
- {
- return $this->isPublic;
- }
-
- /**
- * @param bool $isPublic
- */
- public function setIsPublic($isPublic)
- {
- $this->isPublic = $isPublic;
- }
-
- /**
- * @return ArrayCollection<Tag>
+ * @return ArrayCollection
*/
public function getTags()
{
$tag->addEntry($this);
}
+ /**
+ * Remove the given tag from the entry (if the tag is associated).
+ *
+ * @param Tag $tag
+ */
public function removeTag(Tag $tag)
{
if (!$this->tags->contains($tag)) {
$tag->removeEntry($this);
}
+ /**
+ * Remove all assigned tags from the entry.
+ */
+ public function removeAllTags()
+ {
+ foreach ($this->tags as $tag) {
+ $this->tags->removeElement($tag);
+ $tag->removeEntry($this);
+ }
+ }
+
/**
* Set previewPicture.
*
/**
* @return string
*/
- public function getUuid()
+ public function getUid()
{
- return $this->uuid;
+ return $this->uid;
}
/**
- * @param string $uuid
+ * @param string $uid
*
* @return Entry
*/
- public function setUuid($uuid)
+ public function setUid($uid)
{
- $this->uuid = $uuid;
+ $this->uid = $uid;
return $this;
}
- public function generateUuid()
+ public function generateUid()
{
- if (null === $this->uuid) {
+ if (null === $this->uid) {
// @see http://blog.kevingomez.fr/til/2015/07/26/why-is-uniqid-slow/ for true parameter
- $this->uuid = uniqid('', true);
+ $this->uid = uniqid('', true);
}
}
- public function cleanUuid()
+ public function cleanUid()
+ {
+ $this->uid = null;
+ }
+
+ /**
+ * Used in the entries filter so it's more explicit for the end user than the uid.
+ * Also used in the API.
+ *
+ * @VirtualProperty
+ * @SerializedName("is_public")
+ * @Groups({"entries_for_user"})
+ *
+ * @return bool
+ */
+ public function isPublic()
+ {
+ return null !== $this->uid;
+ }
+
+ /**
+ * @return string
+ */
+ public function getHttpStatus()
+ {
+ return $this->httpStatus;
+ }
+
+ /**
+ * @param string $httpStatus
+ *
+ * @return Entry
+ */
+ public function setHttpStatus($httpStatus)
+ {
+ $this->httpStatus = $httpStatus;
+
+ return $this;
+ }
+
+ /**
+ * @return \Datetime
+ */
+ public function getPublishedAt()
+ {
+ return $this->publishedAt;
+ }
+
+ /**
+ * @param \Datetime $publishedAt
+ *
+ * @return Entry
+ */
+ public function setPublishedAt(\Datetime $publishedAt)
+ {
+ $this->publishedAt = $publishedAt;
+
+ return $this;
+ }
+
+ /**
+ * @return array
+ */
+ public function getPublishedBy()
+ {
+ return $this->publishedBy;
+ }
+
+ /**
+ * @param array $publishedBy
+ *
+ * @return Entry
+ */
+ public function setPublishedBy($publishedBy)
+ {
+ $this->publishedBy = $publishedBy;
+
+ return $this;
+ }
+
+ /**
+ * @return array
+ */
+ public function getHeaders()
+ {
+ return $this->headers;
+ }
+
+ /**
+ * @param array $headers
+ *
+ * @return Entry
+ */
+ public function setHeaders($headers)
+ {
+ $this->headers = $headers;
+
+ return $this;
+ }
+
+ /**
+ * Set origin url.
+ *
+ * @param string $originUrl
+ *
+ * @return Entry
+ */
+ public function setOriginUrl($originUrl)
+ {
+ $this->originUrl = $originUrl;
+
+ return $this;
+ }
+
+ /**
+ * Get origin url.
+ *
+ * @return string
+ */
+ public function getOriginUrl()
+ {
+ return $this->originUrl;
+ }
+
+ /**
+ * Set origin url.
+ *
+ * @param string $givenUrl
+ *
+ * @return Entry
+ */
+ public function setGivenUrl($givenUrl)
+ {
+ $this->givenUrl = $givenUrl;
+ $this->hashedGivenUrl = UrlHasher::hashUrl($givenUrl);
+
+ return $this;
+ }
+
+ /**
+ * Get origin url.
+ *
+ * @return string
+ */
+ public function getGivenUrl()
+ {
+ return $this->givenUrl;
+ }
+
+ /**
+ * @return string
+ */
+ public function getHashedUrl()
+ {
+ return $this->hashedUrl;
+ }
+
+ /**
+ * @param mixed $hashedUrl
+ *
+ * @return Entry
+ */
+ public function setHashedUrl($hashedUrl)
{
- $this->uuid = null;
+ $this->hashedUrl = $hashedUrl;
+
+ return $this;
}
}
projects / github / wallabag / wallabag.git / blobdiff