| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241 |
- <?php
- declare(strict_types=1);
- class FreshRSS_Entry extends Minz_Model {
- use FreshRSS_AttributesTrait;
- public const STATE_READ = 1;
- public const STATE_NOT_READ = 2;
- public const STATE_ALL = 3;
- public const STATE_FAVORITE = 4;
- public const STATE_NOT_FAVORITE = 8;
- public const STATE_ANDS = self::STATE_READ | self::STATE_NOT_READ | self::STATE_FAVORITE | self::STATE_NOT_FAVORITE;
- public const STATE_OR_NOT_READ = 32;
- public const STATE_OR_FAVORITE = 64;
- public const STATE_ORS = self::STATE_OR_NOT_READ | self::STATE_OR_FAVORITE;
- /** @var numeric-string */
- private string $id = '0';
- private string $guid;
- private string $title;
- /** @var array<string> */
- private array $authors;
- private string $content;
- private string $link;
- private int $date;
- private int $lastSeen = 0;
- private int $lastUserModified = 0;
- /** In microseconds */
- private string $date_added = '0';
- private string $hash = '';
- private ?bool $is_read;
- private ?bool $is_favorite;
- private bool $is_updated = false;
- private int $feedId;
- private ?FreshRSS_Feed $feed;
- /** @var array<string> */
- private array $tags = [];
- /**
- * @param string|array<string> $tags
- * @param int|numeric-string $pubdate
- */
- public function __construct(int $feedId = 0, string $guid = '', string $title = '', string $authors = '', string $content = '',
- string $link = '', int|string $pubdate = 0, bool|int|null $is_read = false, bool|int|null $is_favorite = false, $tags = '') {
- $this->_title($title);
- $this->_authors($authors);
- $this->_content($content);
- $this->_link($link);
- $this->_date($pubdate);
- $this->_isRead($is_read);
- $this->_isFavorite($is_favorite);
- $this->_feedId($feedId);
- $this->_tags($tags);
- $this->_guid($guid);
- }
- /** @param array{id?:string,id_feed?:int,guid?:string,title?:string,author?:string,content?:string,link?:string,
- * date?:int|string,lastSeen?:int,lastUserModified?:int,
- * hash?:string,is_read?:bool|int,is_favorite?:bool|int,tags?:string|array<string>,attributes?:?string,thumbnail?:string,timestamp?:string} $dao */
- public static function fromArray(array $dao): FreshRSS_Entry {
- if (empty($dao['content']) || !is_string($dao['content'])) {
- $dao['content'] = '';
- }
- if (!is_numeric($dao['date'] ?? null)) {
- $dao['date'] = 0;
- }
- $dao['attributes'] = empty($dao['attributes']) ? [] : json_decode($dao['attributes'], true);
- if (is_array($dao['attributes'])) {
- $dao['attributes'] = array_filter($dao['attributes'], 'is_string', ARRAY_FILTER_USE_KEY);
- } else {
- $dao['attributes'] = [];
- }
- if (!empty($dao['thumbnail'])) {
- $dao['attributes']['thumbnail'] = [
- 'url' => $dao['thumbnail'],
- ];
- }
- $entry = new FreshRSS_Entry(
- $dao['id_feed'] ?? 0,
- $dao['guid'] ?? '',
- $dao['title'] ?? '',
- $dao['author'] ?? '',
- $dao['content'],
- $dao['link'] ?? '',
- $dao['date'] ?? 0,
- $dao['is_read'] ?? false,
- $dao['is_favorite'] ?? false,
- $dao['tags'] ?? ''
- );
- if (!empty($dao['id']) && is_numeric($dao['id'])) {
- $entry->_id($dao['id']);
- }
- if (!empty($dao['timestamp'])) {
- $entry->_date(strtotime($dao['timestamp']) ?: 0);
- }
- if (isset($dao['lastSeen'])) {
- $entry->_lastSeen($dao['lastSeen']);
- }
- if (isset($dao['lastUserModified'])) {
- $entry->_lastUserModified($dao['lastUserModified']);
- }
- if (!empty($dao['attributes'])) {
- $entry->_attributes($dao['attributes']);
- }
- if (!empty($dao['hash'])) {
- $entry->_hash($dao['hash']);
- }
- return $entry;
- }
- /**
- * @param Traversable<array{id?:string,id_feed?:int,guid?:string,
- * title?:string,author?:string,content?:string,link?:string,
- * date?:int|string,lastSeen?:int,lastUserModified?:int,hash?:string,is_read?:bool|int,
- * is_favorite?:bool|int,tags?:string|array<string>,attributes?:?string,
- * thumbnail?:string,timestamp?:string}> $daos
- * @return Traversable<FreshRSS_Entry>
- */
- public static function fromTraversable(Traversable $daos): Traversable {
- foreach ($daos as $dao) {
- yield FreshRSS_Entry::fromArray($dao);
- }
- }
- /** @return numeric-string */
- public function id(): string {
- return $this->id;
- }
- public function guid(): string {
- return $this->guid;
- }
- public function title(): string {
- $title = '';
- if ($this->title === '') {
- // used while fetching the article from feed and store it in the database
- $title = $this->guid();
- } else {
- // used while fetching from the database
- if ($this->title !== $this->guid) {
- $title = $this->title;
- } else {
- $content = trim(strip_tags($this->content(false)));
- $title = trim(mb_substr($content, 0, MAX_CHARS_EMPTY_FEED_TITLE, 'UTF-8'));
- if ($title === '') {
- $title = $this->guid();
- } elseif (strlen($content) > strlen($title)) {
- $title .= '…';
- }
- }
- }
- return $title;
- }
- /** @deprecated */
- public function author(): string {
- return $this->authors(true);
- }
- /**
- * @phpstan-return ($asString is true ? string : array<string>)
- * @return string|array<string>
- */
- public function authors(bool $asString = false): string|array {
- if ($asString) {
- return $this->authors == null ? '' : ';' . implode('; ', $this->authors);
- } else {
- return $this->authors;
- }
- }
- /**
- * Basic test without ambition to catch all cases such as unquoted addresses, variants of entities, HTML comments, etc.
- */
- private static function containsLink(string $html, string $link): bool {
- return preg_match('/(?P<delim>[\'"])' . preg_quote($link, '/') . '(?P=delim)/', $html) == 1;
- }
- /** @param array{url?:string,length?:int,medium?:string,type?:string} $enclosure */
- private static function enclosureIsImage(array $enclosure): bool {
- $elink = $enclosure['url'] ?? '';
- $length = $enclosure['length'] ?? 0;
- $medium = $enclosure['medium'] ?? '';
- $mime = $enclosure['type'] ?? '';
- return ($elink != '' && $medium === 'image') || str_starts_with($mime, 'image') ||
- ($mime == '' && $length == 0 && preg_match('/[.](avif|gif|jpe?g|png|svg|webp)([?#]|$)/i', $elink));
- }
- /**
- * Provides the original content without additional content potentially added by loadCompleteContent().
- */
- public function originalContent(): string {
- return $this->attributeString('original_content') ??
- preg_replace('#<!-- FULLCONTENT start //-->.*<!-- FULLCONTENT end //-->#s', '', $this->content) ?? '';
- }
- /**
- * @param bool $withEnclosures Set to true to include the enclosures in the returned HTML, false otherwise.
- * @param bool $allowDuplicateEnclosures Set to false to remove obvious enclosure duplicates (based on simple string comparison), true otherwise.
- * @return string HTML content
- */
- public function content(bool $withEnclosures = true, bool $allowDuplicateEnclosures = false): string {
- if (!$withEnclosures) {
- return $this->content;
- }
- $content = $this->content;
- $thumbnailAttribute = $this->attributeArray('thumbnail') ?? [];
- if (!empty($thumbnailAttribute['url'])) {
- $elink = $thumbnailAttribute['url'];
- if (is_string($elink) && ($allowDuplicateEnclosures || !self::containsLink($content, $elink))) {
- $content .= <<<HTML
- <figure class="enclosure">
- <p class="enclosure-content">
- <img class="enclosure-thumbnail" src="{$elink}" alt="" />
- </p>
- </figure>
- HTML;
- }
- }
- $attributeEnclosures = $this->attributeArray('enclosures');
- if (empty($attributeEnclosures)) {
- return $content;
- }
- foreach ($attributeEnclosures as $enclosure) {
- if (!is_array($enclosure)) {
- continue;
- }
- $elink = $enclosure['url'] ?? '';
- if ($elink == '' || !is_string($elink)) {
- continue;
- }
- if (!$allowDuplicateEnclosures && self::containsLink($content, $elink)) {
- continue;
- }
- $credits = $enclosure['credit'] ?? '';
- $description = is_string($enclosure['description'] ?? null) ? nl2br($enclosure['description'], true) : '';
- $length = is_numeric($enclosure['length'] ?? null) ? (int)$enclosure['length'] : 0;
- $medium = is_string($enclosure['medium'] ?? null) ? $enclosure['medium'] : '';
- $mime = is_string($enclosure['type'] ?? null) ? $enclosure['type'] : '';
- $thumbnails = $enclosure['thumbnails'] ?? null;
- if (!is_array($thumbnails)) {
- $thumbnails = [];
- }
- $etitle = is_string($enclosure['title'] ?? null) ? $enclosure['title'] : '';
- $content .= "\n";
- $content .= '<figure class="enclosure">';
- foreach ($thumbnails as $thumbnail) {
- if (is_string($thumbnail)) {
- $content .= '<p><img class="enclosure-thumbnail" src="' . $thumbnail . '" alt="" title="' . $etitle . '" /></p>';
- }
- }
- if (self::enclosureIsImage(['url' => $elink, 'length' => $length, 'medium' => $medium, 'type' => $mime])) {
- $content .= '<p class="enclosure-content"><img src="' . $elink . '" alt="" title="' . $etitle . '" /></p>';
- } elseif ($medium === 'audio' || str_starts_with($mime, 'audio')) {
- $content .= '<p class="enclosure-content"><audio preload="none" src="' . $elink
- . ($length == null ? '' : '" data-length="' . $length)
- . ($mime == '' ? '' : '" data-type="' . htmlspecialchars($mime, ENT_COMPAT, 'UTF-8'))
- . '" controls="controls" title="' . $etitle . '"></audio> <a download="" href="' . $elink . '">💾</a></p>';
- } elseif ($medium === 'video' || str_starts_with($mime, 'video')) {
- $content .= '<p class="enclosure-content"><video preload="none" src="' . $elink
- . ($length == null ? '' : '" data-length="' . $length)
- . ($mime == '' ? '' : '" data-type="' . htmlspecialchars($mime, ENT_COMPAT, 'UTF-8'))
- . '" controls="controls" title="' . $etitle . '"></video> <a download="" href="' . $elink . '">💾</a></p>';
- } else { //e.g. application, text, unknown
- $content .= '<p class="enclosure-content"><a download="" href="' . $elink
- . ($mime == '' ? '' : '" data-type="' . htmlspecialchars($mime, ENT_COMPAT, 'UTF-8'))
- . ($medium == '' ? '' : '" data-medium="' . htmlspecialchars($medium, ENT_COMPAT, 'UTF-8'))
- . '" title="' . $etitle . '">💾</a></p>';
- }
- if ($credits != '') {
- if (!is_array($credits)) {
- $credits = [$credits];
- }
- foreach ($credits as $credit) {
- if (is_string($credit)) {
- $content .= '<p class="enclosure-credits">© ' . $credit . '</p>';
- }
- }
- }
- if ($description != '') {
- $content .= '<figcaption class="enclosure-description">' . $description . '</figcaption>';
- }
- $content .= "</figure>\n";
- }
- return $content;
- }
- /** @return Traversable<array{'url':string,'type'?:string,'medium'?:string,'length'?:int,'title'?:string,'description'?:string,'credit'?:string|array<string>,'height'?:int,'width'?:int,'thumbnails'?:array<string>}> */
- public function enclosures(bool $searchBodyImages = false): Traversable {
- $attributeEnclosures = $this->attributeArray('enclosures');
- if (is_array($attributeEnclosures)) {
- // FreshRSS 1.20.1+: The enclosures are saved as attributes
- /** @var list<array{'url':string,'type'?:string,'medium'?:string,'length'?:int,'title'?:string,'description'?:string,'credit'?:string|array<string>,'height'?:int,'width'?:int,'thumbnails'?:array<string>}> $attributeEnclosures */
- yield from $attributeEnclosures;
- }
- try {
- $searchEnclosures = !is_iterable($attributeEnclosures) && (str_contains($this->content, '<p class="enclosure-content'));
- $searchBodyImages &= (stripos($this->content, '<img') !== false);
- $xpath = null;
- if ($searchEnclosures || $searchBodyImages) {
- $dom = new DOMDocument();
- $dom->loadHTML('<?xml version="1.0" encoding="UTF-8" ?>' . $this->content, LIBXML_NONET | LIBXML_NOERROR | LIBXML_NOWARNING);
- $xpath = new DOMXPath($dom);
- }
- if ($searchEnclosures && $xpath !== null) {
- // Legacy code for database entries < FreshRSS 1.20.1
- $enclosures = $xpath->query('//div[@class="enclosure"]/p[@class="enclosure-content"]/*[@src]');
- if (!empty($enclosures)) {
- foreach ($enclosures as $enclosure) {
- if (!($enclosure instanceof DOMElement)) {
- continue;
- }
- $result = [
- 'url' => $enclosure->getAttribute('src'),
- 'type' => $enclosure->getAttribute('data-type'),
- 'medium' => $enclosure->getAttribute('data-medium'),
- 'length' => (int)($enclosure->getAttribute('data-length')),
- ];
- if (empty($result['medium'])) {
- switch (strtolower($enclosure->nodeName)) {
- case 'img': $result['medium'] = 'image'; break;
- case 'video': $result['medium'] = 'video'; break;
- case 'audio': $result['medium'] = 'audio'; break;
- }
- }
- yield Minz_Helper::htmlspecialchars_utf8($result);
- }
- }
- }
- if ($searchBodyImages && $xpath !== null) {
- $images = $xpath->query('//img');
- if (!empty($images)) {
- foreach ($images as $img) {
- if (!($img instanceof DOMElement)) {
- continue;
- }
- $src = $img->getAttribute('src');
- if ($src == null) {
- $src = $img->getAttribute('data-src');
- }
- if ($src != null) {
- $result = [
- 'url' => $src,
- 'medium' => 'image',
- ];
- yield Minz_Helper::htmlspecialchars_utf8($result);
- }
- }
- }
- }
- } catch (Exception $ex) {
- Minz_Log::debug(__METHOD__ . ' ' . $ex->getMessage());
- }
- }
- /**
- * @return array{'url':string,'height'?:int,'width'?:int,'time'?:string}|null
- */
- public function thumbnail(bool $searchEnclosures = true): ?array {
- $thumbnail = $this->attributeArray('thumbnail') ?? [];
- // First, use the provided thumbnail, if any
- if (is_string($thumbnail['url'] ?? null)) {
- /** @var array{'url':string,'height'?:int,'width'?:int,'time'?:string} $thumbnail */
- return $thumbnail;
- }
- if ($searchEnclosures) {
- foreach ($this->enclosures(true) as $enclosure) {
- // Second, search each enclosure’s thumbnails
- if (!empty($enclosure['thumbnails'][0])) {
- foreach ($enclosure['thumbnails'] as $src) {
- if (is_string($src)) {
- return [
- 'url' => $src,
- 'medium' => 'image',
- ];
- }
- }
- }
- // Third, check whether each enclosure itself is an appropriate image
- if (self::enclosureIsImage($enclosure)) {
- return $enclosure;
- }
- }
- }
- return null;
- }
- /**
- * @param bool $raw Set to true to return the raw link,
- * false (default) to attempt a fallback to the GUID if the link is empty.
- * @return string HTML-encoded link of the entry
- */
- public function link(bool $raw = false): string {
- if ($this->link === '' && !$raw) {
- // Use the GUID as a fallback if it looks like a URL
- if (filter_var($this->guid, FILTER_VALIDATE_URL, FILTER_NULL_ON_FAILURE) !== null) {
- return $this->guid;
- }
- }
- return $this->link;
- }
- /**
- * @phpstan-return ($raw is false ? string : int)
- */
- public function date(bool $raw = false): int|string {
- if ($raw) {
- return $this->date;
- }
- return timestamptodate($this->date);
- }
- public function machineReadableDate(): string {
- return @date(DATE_ATOM, $this->date);
- }
- public function lastSeen(): int {
- return $this->lastSeen;
- }
- public function lastUserModified(): int {
- return $this->lastUserModified;
- }
- /**
- * @phpstan-return ($raw is false ? string : ($microsecond is true ? string : int))
- */
- public function dateAdded(bool $raw = false, bool $microsecond = false): int|string {
- if ($raw) {
- if ($microsecond) {
- return $this->date_added;
- } else {
- return (int)substr($this->date_added, 0, -6);
- }
- } else {
- $date = (int)substr($this->date_added, 0, -6);
- return timestamptodate($date);
- }
- }
- public function isRead(): ?bool {
- return $this->is_read;
- }
- public function isFavorite(): ?bool {
- return $this->is_favorite;
- }
- /**
- * Returns whether the entry has been modified since it was inserted in database.
- * @returns bool `true` if the entry already existed (and has been modified), `false` if the entry is new (or unmodified).
- */
- public function isUpdated(): ?bool {
- return $this->is_updated;
- }
- public function _isUpdated(bool $value): void {
- $this->is_updated = $value;
- }
- public function feed(): ?FreshRSS_Feed {
- if ($this->feed === null) {
- $feedDAO = FreshRSS_Factory::createFeedDao();
- $this->feed = $feedDAO->searchById($this->feedId);
- }
- return $this->feed;
- }
- public function feedId(): int {
- return $this->feedId;
- }
- /**
- * @phpstan-return ($asString is true ? string : array<string>)
- * @return string|array<string>
- */
- public function tags(bool $asString = false): array|string {
- if ($asString) {
- return $this->tags == null ? '' : '#' . implode(' #', $this->tags);
- } else {
- return $this->tags;
- }
- }
- public function hash(): string {
- if ($this->hash === '') {
- $attributes = empty($this->attributeArray('enclosures')) ? '' : json_encode($this->attributes(), JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
- //Do not include $this->date because it may be automatically generated when lacking
- $this->hash = md5($this->link . $this->title . $this->authors(true) . $this->originalContent() . $this->tags(true) . $attributes);
- }
- return $this->hash;
- }
- public function _hash(string $value): string {
- $value = trim($value);
- if (ctype_xdigit($value)) {
- $this->hash = substr($value, 0, 32);
- }
- return $this->hash;
- }
- /** @param int|numeric-string $value String is for compatibility with 32-bit platforms */
- public function _id(int|string $value): void {
- if (is_int($value)) {
- $value = (string)$value;
- }
- $this->id = $value;
- if ($this->date_added == 0) {
- $this->date_added = $value;
- }
- }
- public function _guid(string $value): void {
- $this->guid = trim($value);
- }
- public function _title(string $value): void {
- $this->hash = '';
- $this->title = trim($value);
- }
- /** @deprecated */
- public function _author(string $value): void {
- $this->_authors($value);
- }
- /** @param array<string>|string $value */
- public function _authors(array|string $value): void {
- $this->hash = '';
- if (!is_array($value)) {
- if (str_contains($value, ';')) {
- $value = htmlspecialchars_decode($value, ENT_QUOTES);
- $value = preg_split('/\s*[;]\s*/', $value, -1, PREG_SPLIT_NO_EMPTY) ?: [];
- $value = Minz_Helper::htmlspecialchars_utf8($value);
- } else {
- $value = preg_split('/\s*[,]\s*/', $value, -1, PREG_SPLIT_NO_EMPTY) ?: [];
- }
- }
- $this->authors = $value;
- }
- public function _content(string $value): void {
- $this->hash = '';
- $this->content = $value;
- }
- public function _link(string $value): void {
- $this->hash = '';
- $this->link = trim($value);
- }
- /** @param int|numeric-string $value */
- public function _date(int|string $value): void {
- $value = (int)$value;
- $this->date = $value > 1 ? $value : time();
- }
- /**
- * @param int|numeric-string $value
- * 32-bit systems provide a string and will fail in year 2038
- */
- public function _lastSeen(int|string $value): void {
- $value = (int)$value;
- $this->lastSeen = $value > 0 ? $value : 0;
- }
- public function _lastUserModified(int|string $value): void {
- $value = (int)$value;
- $this->lastUserModified = $value > 0 ? $value : 0;
- }
- /** @param int|numeric-string $value */
- public function _dateAdded(int|string $value, bool $microsecond = false): void {
- if ($microsecond) {
- $this->date_added = (string)($value);
- } else {
- $this->date_added = $value . '000000';
- }
- }
- public function _isRead(bool|int|null $value): void {
- $this->is_read = $value === null ? null : (bool)$value;
- }
- public function _isFavorite(bool|int|null $value): void {
- $this->is_favorite = $value === null ? null : (bool)$value;
- }
- public function _feed(?FreshRSS_Feed $feed): void {
- $this->feed = $feed;
- $this->feedId = $this->feed == null ? 0 : $this->feed->id();
- }
- private function _feedId(int $id): void {
- $this->feed = null;
- $this->feedId = $id;
- }
- /** @param array<string>|string $value */
- public function _tags(array|string $value): void {
- $this->hash = '';
- if (!is_array($value)) {
- $value = preg_split('/\s*[#,]\s*/', $value, -1, PREG_SPLIT_NO_EMPTY) ?: [];
- }
- $this->tags = $value;
- }
- public function matches(FreshRSS_BooleanSearch $booleanSearch): bool {
- $ok = true;
- foreach ($booleanSearch->searches() as $filter) {
- if ($filter instanceof FreshRSS_BooleanSearch) {
- // BooleanSearches are combined by AND (default) or OR or AND NOT (special cases) operators and are recursive
- match ($filter->operator()) {
- 'AND' => $ok &= $this->matches($filter),
- 'OR' => $ok |= $this->matches($filter),
- 'AND NOT' => $ok &= !$this->matches($filter),
- 'OR NOT' => $ok |= !$this->matches($filter),
- default => $ok &= $this->matches($filter),
- };
- } elseif ($filter instanceof FreshRSS_Search) {
- // Searches are combined by OR and are not recursive
- $ok = true;
- if ($filter->getEntryIds() !== null) {
- $ok &= in_array($this->id, $filter->getEntryIds(), true);
- }
- if ($ok && $filter->getNotEntryIds() !== null) {
- $ok &= !in_array($this->id, $filter->getNotEntryIds(), true);
- }
- if ($ok && $filter->getMinDate() !== null) {
- $ok &= strnatcmp($this->id, $filter->getMinDate() . '000000') >= 0;
- }
- if ($ok && $filter->getNotMinDate() !== null) {
- $ok &= strnatcmp($this->id, $filter->getNotMinDate() . '000000') < 0;
- }
- if ($ok && $filter->getMaxDate() !== null) {
- $ok &= strnatcmp($this->id, $filter->getMaxDate() . '000000') <= 0;
- }
- if ($ok && $filter->getNotMaxDate() !== null) {
- $ok &= strnatcmp($this->id, $filter->getNotMaxDate() . '000000') > 0;
- }
- if ($ok && $filter->getMinPubdate() !== null) {
- $ok &= $this->date >= $filter->getMinPubdate();
- }
- if ($ok && $filter->getNotMinPubdate() !== null) {
- $ok &= $this->date < $filter->getNotMinPubdate();
- }
- if ($ok && $filter->getMaxPubdate() !== null) {
- $ok &= $this->date <= $filter->getMaxPubdate();
- }
- if ($ok && $filter->getNotMaxPubdate() !== null) {
- $ok &= $this->date > $filter->getNotMaxPubdate();
- }
- if ($ok && $filter->getMinUserdate() !== null) {
- $ok &= $this->lastUserModified >= $filter->getMinUserdate();
- }
- if ($ok && $filter->getNotMinUserdate() !== null) {
- $ok &= $this->lastUserModified < $filter->getNotMinUserdate();
- }
- if ($ok && $filter->getMaxUserdate() !== null) {
- $ok &= $this->lastUserModified <= $filter->getMaxUserdate();
- }
- if ($ok && $filter->getNotMaxUserdate() !== null) {
- $ok &= $this->lastUserModified > $filter->getNotMaxUserdate();
- }
- if ($ok && $filter->getFeedIds() !== null) {
- $ok &= in_array($this->feedId, $filter->getFeedIds(), true);
- }
- if ($ok && $filter->getNotFeedIds() !== null) {
- $ok &= !in_array($this->feedId, $filter->getNotFeedIds(), true);
- }
- if ($ok && $filter->getCategoryIds() !== null) {
- $ok &= in_array($this->feed()?->categoryId(), $filter->getCategoryIds(), true);
- }
- if ($ok && $filter->getNotCategoryIds() !== null) {
- $ok &= !in_array($this->feed()?->categoryId(), $filter->getNotCategoryIds(), true);
- }
- if ($ok && $filter->getAuthor() !== null) {
- foreach ($filter->getAuthor() as $author) {
- $ok &= stripos(implode(';', $this->authors), $author) !== false;
- }
- }
- if ($ok && $filter->getAuthorRegex() !== null) {
- foreach ($filter->getAuthorRegex() as $author) {
- $ok &= preg_match($author, implode("\n", $this->authors)) === 1;
- }
- }
- if ($ok && $filter->getNotAuthor() !== null) {
- foreach ($filter->getNotAuthor() as $author) {
- $ok &= stripos(implode(';', $this->authors), $author) === false;
- }
- }
- if ($ok && $filter->getNotAuthorRegex() !== null) {
- foreach ($filter->getNotAuthorRegex() as $author) {
- $ok &= preg_match($author, implode("\n", $this->authors)) === 0;
- }
- }
- if ($ok && $filter->getIntitle() !== null) {
- foreach ($filter->getIntitle() as $title) {
- $ok &= stripos($this->title, $title) !== false;
- }
- }
- if ($ok && $filter->getIntitleRegex() !== null) {
- foreach ($filter->getIntitleRegex() as $title) {
- $ok &= preg_match($title, $this->title) === 1;
- }
- }
- if ($ok && $filter->getNotIntitle() !== null) {
- foreach ($filter->getNotIntitle() as $title) {
- $ok &= stripos($this->title, $title) === false;
- }
- }
- if ($ok && $filter->getNotIntitleRegex() !== null) {
- foreach ($filter->getNotIntitleRegex() as $title) {
- $ok &= preg_match($title, $this->title) === 0;
- }
- }
- if ($ok && $filter->getIntext() !== null) {
- foreach ($filter->getIntext() as $content) {
- $ok &= stripos($this->content, $content) !== false;
- }
- }
- if ($ok && $filter->getIntextRegex() !== null) {
- foreach ($filter->getIntextRegex() as $content) {
- $ok &= preg_match($content, $this->content) === 1;
- }
- }
- if ($ok && $filter->getNotIntext() !== null) {
- foreach ($filter->getNotIntext() as $content) {
- $ok &= stripos($this->content, $content) === false;
- }
- }
- if ($ok && $filter->getNotIntextRegex() !== null) {
- foreach ($filter->getNotIntextRegex() as $content) {
- $ok &= preg_match($content, $this->content) === 0;
- }
- }
- if ($ok && $filter->getTags() !== null) {
- foreach ($filter->getTags() as $tag2) {
- $found = false;
- foreach ($this->tags as $tag1) {
- $tag1 = ltrim($tag1, '#');
- if (strcasecmp($tag1, $tag2) === 0) {
- $found = true;
- break;
- }
- }
- $ok &= $found;
- }
- }
- if ($ok && $filter->getTagsRegex() !== null) {
- foreach ($filter->getTagsRegex() as $tag2) {
- $found = false;
- foreach ($this->tags as $tag1) {
- $tag1 = ltrim($tag1, '#');
- if (preg_match($tag2, $tag1) === 1) {
- $found = true;
- break;
- }
- }
- $ok &= $found;
- }
- }
- if ($ok && $filter->getNotTags() !== null) {
- foreach ($filter->getNotTags() as $tag2) {
- $found = false;
- foreach ($this->tags as $tag1) {
- $tag1 = ltrim($tag1, '#');
- if (strcasecmp($tag1, $tag2) === 0) {
- $found = true;
- break;
- }
- }
- $ok &= !$found;
- }
- }
- if ($ok && $filter->getNotTagsRegex() !== null) {
- foreach ($filter->getNotTagsRegex() as $tag2) {
- $found = false;
- foreach ($this->tags as $tag1) {
- $tag1 = ltrim($tag1, '#');
- if (preg_match($tag2, $tag1) === 1) {
- $found = true;
- break;
- }
- }
- $ok &= !$found;
- }
- }
- if ($ok && $filter->getInurl() !== null) {
- foreach ($filter->getInurl() as $url) {
- $ok &= stripos($this->link, $url) !== false;
- }
- }
- if ($ok && $filter->getInurlRegex() !== null) {
- foreach ($filter->getInurlRegex() as $url) {
- $ok &= preg_match($url, $this->link) === 1;
- }
- }
- if ($ok && $filter->getNotInurl() !== null) {
- foreach ($filter->getNotInurl() as $url) {
- $ok &= stripos($this->link, $url) === false;
- }
- }
- if ($ok && $filter->getNotInurlRegex() !== null) {
- foreach ($filter->getNotInurlRegex() as $url) {
- $ok &= preg_match($url, $this->link) === 0;
- }
- }
- if ($ok && $filter->getSearch() !== null) {
- foreach ($filter->getSearch() as $needle) {
- $ok &= (stripos($this->title, $needle) !== false || stripos($this->content, $needle) !== false);
- }
- }
- if ($ok && $filter->getNotSearch() !== null) {
- foreach ($filter->getNotSearch() as $needle) {
- $ok &= (stripos($this->title, $needle) === false && stripos($this->content, $needle) === false);
- }
- }
- if ($ok && $filter->getSearchRegex() !== null) {
- foreach ($filter->getSearchRegex() as $needle) {
- $ok &= (preg_match($needle, $this->title) === 1 || preg_match($needle, $this->content) === 1);
- }
- }
- if ($ok && $filter->getNotSearchRegex() !== null) {
- foreach ($filter->getNotSearchRegex() as $needle) {
- $ok &= (preg_match($needle, $this->title) === 0 && preg_match($needle, $this->content) === 0);
- }
- }
- if ($ok) {
- return true;
- }
- }
- }
- return (bool)$ok;
- }
- /** @param array<string,bool|int> $titlesAsRead */
- public function applyFilterActions(array $titlesAsRead = []): void {
- $feed = $this->feed;
- if ($feed === null) {
- return;
- }
- if (!$this->isRead()) {
- if ($feed->attributeBoolean('read_upon_reception') ?? FreshRSS_Context::userConf()->mark_when['reception']) {
- $this->_isRead(true);
- Minz_ExtensionManager::callHook(Minz_HookType::EntryAutoRead, $this, 'upon_reception');
- }
- if (!empty($titlesAsRead[$this->title()])) {
- Minz_Log::debug('Mark title as read: ' . $this->title());
- $this->_isRead(true);
- Minz_ExtensionManager::callHook(Minz_HookType::EntryAutoRead, $this, 'same_title_in_feed');
- }
- }
- FreshRSS_Context::userConf()->applyFilterActions($this);
- $feed->category()?->applyFilterActions($this);
- $feed->applyFilterActions($this);
- }
- public function isDay(int $day, int $today): bool {
- $date = $this->dateAdded(true);
- switch ($day) {
- case FreshRSS_Days::TODAY:
- $tomorrow = $today + 86400;
- return $date >= $today && $date < $tomorrow;
- case FreshRSS_Days::YESTERDAY:
- $yesterday = $today - 86400;
- return $date >= $yesterday && $date < $today;
- case FreshRSS_Days::BEFORE_YESTERDAY:
- $yesterday = $today - 86400;
- return $date < $yesterday;
- default:
- return false;
- }
- }
- /**
- * @param string $url Overridden URL. Will default to the entry URL.
- * @throws Minz_Exception
- */
- public function getContentByParsing(string $url = '', int $maxRedirs = 4): string {
- $url = $url ?: htmlspecialchars_decode($this->link(), ENT_QUOTES);
- $feed = $this->feed();
- if ($url === '' || $feed === null || $feed->pathEntries() === '') {
- return '';
- }
- $conditions = $feed->attributeArray('path_entries_conditions') ?? [];
- $conditions = array_filter($conditions, fn($v): bool => (is_string($v) ? trim($v) : '') !== '');
- if (count($conditions) > 0) {
- $found = false;
- foreach ($conditions as $condition) {
- if (!is_string($condition) || trim($condition) === '') {
- continue;
- }
- $booleanSearch = new FreshRSS_BooleanSearch($condition);
- if ($this->matches($booleanSearch)) {
- $found = true;
- break;
- }
- }
- if (!$found) {
- return '';
- }
- }
- $cachePath = $feed->cacheFilename($url . '#' . $feed->pathEntries());
- $response = httpGet($url, $cachePath, 'html', $feed->attributes(), $feed->curlOptions());
- $html = $response['body'];
- if ($html !== '') {
- $doc = new DOMDocument();
- $doc->loadHTML($html, LIBXML_NONET | LIBXML_NOERROR | LIBXML_NOWARNING);
- $xpath = new DOMXPath($doc);
- // Account for HTTP redirections
- $url = $response['effective_url'] ?: $url;
- $maxRedirs -= $response['redirect_count'];
- if ($maxRedirs > 0) {
- //Follow any HTML redirection
- $metas = $xpath->query('//meta[@content]') ?: [];
- foreach ($metas as $meta) {
- if ($meta instanceof DOMElement && strtolower(trim($meta->getAttribute('http-equiv'))) === 'refresh') {
- $refresh = preg_replace('/^[0-9.; ]*\s*(url\s*=)?\s*/i', '', trim($meta->getAttribute('content')));
- $refresh = is_string($refresh) ? \SimplePie\Misc::absolutize_url($refresh, $url) : false;
- if ($refresh != false && $refresh !== $url) {
- return $this->getContentByParsing($refresh, $maxRedirs - 1);
- }
- }
- }
- }
- $base = $xpath->evaluate('normalize-space(//base/@href)');
- if ($base == false || !is_string($base)) {
- $base = $url;
- } elseif (str_starts_with($base, '//')) {
- //Protocol-relative URLs "//www.example.net"
- $base = (parse_url($url, PHP_URL_SCHEME) ?? 'https') . ':' . $base;
- }
- $html = '';
- $cssSelector = htmlspecialchars_decode($feed->pathEntries(), ENT_QUOTES);
- $cssSelector = trim($cssSelector, ', ');
- $path_entries_filter = trim($feed->attributeString('path_entries_filter') ?? '', ', ');
- $nodes = $xpath->query((new Gt\CssXPath\Translator($cssSelector, '//'))->asXPath());
- if ($nodes != false) {
- $filter_xpath = $path_entries_filter === '' ? '' : (new Gt\CssXPath\Translator($path_entries_filter, 'descendant-or-self::'))->asXPath();
- foreach ($nodes as $node) {
- if ($filter_xpath !== '' && ($filterednodes = $xpath->query($filter_xpath, $node)) !== false) {
- // Remove unwanted elements once before sanitizing, for CSS selectors to also match original content
- foreach ($filterednodes as $filterednode) {
- if ($filterednode === $node) {
- continue 2;
- }
- if (!($filterednode instanceof DOMElement) || $filterednode->parentNode === null) {
- continue;
- }
- $filterednode->parentNode->removeChild($filterednode);
- }
- }
- $html .= $doc->saveHTML($node) . "\n";
- }
- }
- unset($xpath, $doc);
- $html = sanitizeHTML($html, $base);
- if ($path_entries_filter !== '') {
- // Remove unwanted elements again after sanitizing, for CSS selectors to also match sanitized content
- $modified = false;
- $doc = new DOMDocument();
- $utf8BOM = "\xEF\xBB\xBF";
- $doc->loadHTML($utf8BOM . $html, LIBXML_NONET | LIBXML_NOERROR | LIBXML_NOWARNING);
- $xpath = new DOMXPath($doc);
- $filterednodes = $xpath->query((new Gt\CssXPath\Translator($path_entries_filter, '//'))->asXPath()) ?: [];
- foreach ($filterednodes as $filterednode) {
- if (!($filterednode instanceof DOMElement) || $filterednode->parentNode === null) {
- continue;
- }
- $filterednode->parentNode->removeChild($filterednode);
- $modified = true;
- }
- if ($modified) {
- $html = $doc->saveHTML($doc->getElementsByTagName('body')->item(0) ?? $doc->firstElementChild) ?: $html;
- }
- }
- return trim($html);
- } else {
- throw new Minz_Exception();
- }
- }
- /**
- * @return bool True if the content was modified, false otherwise
- */
- public function loadCompleteContent(bool $force = false): bool {
- // Gestion du contenu
- // Trying to fetch full article content even when feeds do not propose it
- $feed = $this->feed();
- if ($feed === null) {
- return false;
- }
- if (trim($feed->pathEntries()) != '') {
- $entryDAO = FreshRSS_Factory::createEntryDao();
- $entry = $force ? null : $entryDAO->searchByGuid($this->feedId, $this->guid);
- if ($entry !== null) {
- // l’article existe déjà en BDD, en se contente de recharger ce contenu
- $this->content = $entry->content(false);
- } else {
- try {
- // The article is not yet in the database, so let’s fetch it
- $fullContent = $this->getContentByParsing();
- if ('' !== $fullContent) {
- $fullContent = "<!-- FULLCONTENT start //-->{$fullContent}<!-- FULLCONTENT end //-->";
- $originalContent = $this->originalContent();
- switch ($feed->attributeString('content_action')) {
- case 'prepend':
- $this->_attribute('original_content');
- $this->content = $fullContent . $originalContent;
- break;
- case 'append':
- $this->_attribute('original_content');
- $this->content = $originalContent . $fullContent;
- break;
- case 'replace':
- default:
- $this->_attribute('original_content', $originalContent);
- $this->content = $fullContent;
- break;
- }
- return true;
- }
- } catch (Exception $e) {
- // rien à faire, on garde l’ancien contenu(requête a échoué)
- Minz_Log::warning($e->getMessage());
- }
- }
- } elseif (trim($feed->attributeString('path_entries_filter') ?? '') !== '') {
- $originalContent = $this->attributeString('original_content') ?? $this->content;
- $doc = new DOMDocument();
- $utf8BOM = "\xEF\xBB\xBF";
- if (!$doc->loadHTML($utf8BOM . $originalContent, LIBXML_NONET | LIBXML_NOERROR | LIBXML_NOWARNING)) {
- return false;
- }
- $xpath = new DOMXPath($doc);
- $filterednodes = $xpath->query((new Gt\CssXPath\Translator($feed->attributeString('path_entries_filter'), '//'))->asXPath()) ?: [];
- foreach ($filterednodes as $filterednode) {
- if (!($filterednode instanceof DOMElement) || $filterednode->parentNode === null) {
- continue;
- }
- $filterednode->parentNode->removeChild($filterednode);
- }
- $html = $doc->saveHTML($doc->getElementsByTagName('body')->item(0) ?? $doc->firstElementChild);
- if (!is_string($html)) {
- return false;
- }
- $html = preg_replace('%^\s*<body>\s*|\s*</body>\s*$%i', '', $html);
- $this->_attribute('original_content');
- if (is_string($html) && $this->content !== $html) {
- $this->_attribute('original_content', $originalContent);
- $this->content = $html;
- return true;
- }
- } else {
- $originalContent = $this->originalContent();
- if ($originalContent !== $this->content) {
- $this->content = $originalContent;
- return true;
- }
- }
- return false;
- }
- /**
- * @return array{id:string,guid:string,title:string,author:string,content:string,link:string,date:int,
- * lastSeen:int,lastUserModified:int,
- * hash:string,is_read:?bool,is_favorite:?bool,id_feed:int,tags:string,attributes:array<string,mixed>}
- */
- public function toArray(): array {
- return [
- 'id' => $this->id(),
- 'guid' => $this->guid(),
- 'title' => $this->title(),
- 'author' => $this->authors(true),
- 'content' => $this->content(false),
- 'link' => $this->link(raw: true),
- 'date' => $this->date(true),
- 'lastSeen' => $this->lastSeen(),
- 'lastUserModified' => $this->lastUserModified(),
- 'hash' => $this->hash(),
- 'is_read' => $this->isRead(),
- 'is_favorite' => $this->isFavorite(),
- 'id_feed' => $this->feedId(),
- 'tags' => $this->tags(true),
- 'attributes' => $this->attributes(),
- ];
- }
- /**
- * @return array{array<string>,array<string>} Array of first tags to show, then array of remaining tags
- */
- public function tagsFormattingHelper(): array {
- $firstTags = [];
- $remainingTags = [];
- if (FreshRSS_Context::hasUserConf() && in_array(FreshRSS_Context::userConf()->show_tags, ['b', 'f', 'h'], true)) {
- $maxTagsDisplayed = (int)FreshRSS_Context::userConf()->show_tags_max;
- $tags = $this->tags();
- if (!empty($tags)) {
- if ($maxTagsDisplayed > 0) {
- $firstTags = array_slice($tags, 0, $maxTagsDisplayed);
- $remainingTags = array_slice($tags, $maxTagsDisplayed);
- } else {
- $firstTags = $tags;
- }
- }
- }
- return [$firstTags,$remainingTags];
- }
- /**
- * Integer format conversion for Google Reader API format
- * @param numeric-string|int $dec Decimal number
- * @return string 64-bit hexa http://code.google.com/p/google-reader-api/wiki/ItemId
- */
- private static function dec2hex(string|int $dec): string {
- return PHP_INT_SIZE < 8 ? // 32-bit ?
- str_pad(gmp_strval(gmp_init($dec, 10), 16), 16, '0', STR_PAD_LEFT) :
- str_pad(dechex((int)($dec)), 16, '0', STR_PAD_LEFT);
- }
- /**
- * Some clients (tested with News+) would fail if sending too long item content
- * @var int
- */
- public const API_MAX_COMPAT_CONTENT_LENGTH = 500000;
- /**
- * N.B.: To avoid expensive lookups, ensure to set `$entry->_feed($feed)` before calling this function.
- * @param string $mode Set to `'compat'` to use an alternative Unicode representation for problematic HTML special characters not decoded by some clients;
- * set to `'freshrss'` for using FreshRSS additions for internal use (e.g. export/import).
- * @param array<string> $labels List of labels associated to this entry.
- * @return array<string,mixed> A representation of this entry in a format compatible with Google Reader API
- */
- public function toGReader(string $mode = '', array $labels = []): array {
- $feed = $this->feed();
- $category = $feed == null ? null : $feed->category();
- $item = [
- 'frss:id' => $this->id(),
- 'id' => 'tag:google.com,2005:reader/item/' . self::dec2hex($this->id()),
- 'crawlTimeMsec' => substr($this->dateAdded(true, true), 0, -3),
- 'timestampUsec' => '' . $this->dateAdded(true, true), //EasyRSS & Reeder
- 'published' => $this->date(true),
- // 'updated' => $this->date(true),
- 'title' => $this->title(),
- 'canonical' => [
- ['href' => htmlspecialchars_decode($this->link(), ENT_QUOTES)],
- ],
- 'alternate' => [
- [
- 'href' => htmlspecialchars_decode($this->link(), ENT_QUOTES),
- 'type' => 'text/html',
- ],
- ],
- 'categories' => [
- 'user/-/state/com.google/reading-list',
- ],
- 'origin' => [
- 'streamId' => 'feed/' . $this->feedId,
- ],
- ];
- if ($mode === 'compat') {
- $item['title'] = escapeToUnicodeAlternative($this->title(), false);
- unset($item['alternate'][0]['type']);
- $item['summary'] = [
- 'content' => mb_strcut($this->content(true), 0, self::API_MAX_COMPAT_CONTENT_LENGTH, 'UTF-8'),
- ];
- } else {
- $item['content'] = [
- 'content' => $this->content(false),
- ];
- }
- if ($mode === 'freshrss') {
- $item['guid'] = $this->guid();
- }
- if ($category != null && $mode !== 'freshrss') {
- $item['categories'][] = 'user/-/label/' . htmlspecialchars_decode($category->name(), ENT_QUOTES);
- }
- if ($feed !== null) {
- $item['origin']['htmlUrl'] = htmlspecialchars_decode($feed->website());
- $item['origin']['title'] = $feed->name(); //EasyRSS
- if ($mode === 'compat') {
- $item['origin']['title'] = escapeToUnicodeAlternative($feed->name(), true);
- } elseif ($mode === 'freshrss') {
- $item['origin']['feedUrl'] = htmlspecialchars_decode($feed->url());
- }
- }
- foreach ($this->enclosures() as $enclosure) {
- if (!empty($enclosure['url'])) {
- $media = [
- 'href' => $enclosure['url'],
- 'type' => $enclosure['type'] ?? $enclosure['medium'] ??
- (self::enclosureIsImage($enclosure) ? 'image' : ''),
- ];
- if (!empty($enclosure['length'])) {
- $media['length'] = (int)$enclosure['length'];
- }
- $item['enclosure'][] = $media;
- }
- }
- $author = $this->authors(true);
- $author = trim($author, '; ');
- if ($author != '') {
- if ($mode === 'compat') {
- $item['author'] = escapeToUnicodeAlternative($author, false);
- } else {
- $item['author'] = $author;
- }
- }
- if ($this->isRead()) {
- $item['categories'][] = 'user/-/state/com.google/read';
- } elseif ($mode === 'freshrss') {
- $item['categories'][] = 'user/-/state/com.google/unread';
- }
- if ($this->isFavorite()) {
- $item['categories'][] = 'user/-/state/com.google/starred';
- }
- foreach ($labels as $labelName) {
- $item['categories'][] = 'user/-/label/' . htmlspecialchars_decode($labelName, ENT_QUOTES);
- }
- foreach ($this->tags() as $tagName) {
- $item['categories'][] = htmlspecialchars_decode($tagName, ENT_QUOTES);
- }
- return $item;
- }
- }
|