mirror of
https://github.com/FreshRSS/FreshRSS.git
synced 2026-01-27 22:59:08 -05:00
bd9fa803f1
* PHPStan Level 7 complete DAOs * Finalise PHPStan Level 7 for CategoryDAO * PHPStan Level 7 for Context and Search * Apply suggestions from code review Co-authored-by: Luc SANCHEZ <4697568+ColonelMoutarde@users.noreply.github.com>
914 lines
29 KiB
PHP
914 lines
29 KiB
PHP
<?php
|
||
|
||
class FreshRSS_Entry extends Minz_Model {
|
||
const STATE_READ = 1;
|
||
const STATE_NOT_READ = 2;
|
||
const STATE_ALL = 3;
|
||
const STATE_FAVORITE = 4;
|
||
const STATE_NOT_FAVORITE = 8;
|
||
|
||
/** @var string */
|
||
private $id = '0';
|
||
/** @var string */
|
||
private $guid;
|
||
/** @var string */
|
||
private $title;
|
||
/** @var array<string> */
|
||
private $authors;
|
||
/** @var string */
|
||
private $content;
|
||
/** @var string */
|
||
private $link;
|
||
/** @var int */
|
||
private $date;
|
||
/** @var string In microseconds */
|
||
private $date_added = '0';
|
||
/** @var string */
|
||
private $hash = '';
|
||
/** @var bool|null */
|
||
private $is_read;
|
||
/** @var bool|null */
|
||
private $is_favorite;
|
||
/** @var int */
|
||
private $feedId;
|
||
/** @var FreshRSS_Feed|null */
|
||
private $feed;
|
||
/** @var array<string> */
|
||
private $tags = [];
|
||
/** @var array<string,mixed> */
|
||
private $attributes = [];
|
||
|
||
/**
|
||
* @param int|string $pubdate
|
||
* @param bool|int|null $is_read
|
||
* @param bool|int|null $is_favorite
|
||
*/
|
||
public function __construct(int $feedId = 0, string $guid = '', string $title = '', string $authors = '', string $content = '',
|
||
string $link = '', $pubdate = 0, $is_read = false, $is_favorite = false, string $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,
|
||
* 'is_read'?:bool|int,'is_favorite'?:bool|int,'tags'?:string,'attributes'?:string,'thumbnail'?:string,'timestamp'?:string,'categories'?:string} $dao */
|
||
public static function fromArray(array $dao): FreshRSS_Entry {
|
||
if (empty($dao['content'])) {
|
||
$dao['content'] = '';
|
||
}
|
||
|
||
$dao['attributes'] = empty($dao['attributes']) ? [] : json_decode($dao['attributes'], true);
|
||
if (!is_array($dao['attributes'])) {
|
||
$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'])) {
|
||
$entry->_id($dao['id']);
|
||
}
|
||
if (!empty($dao['timestamp'])) {
|
||
$entry->_date(strtotime($dao['timestamp']) ?: 0);
|
||
}
|
||
if (!empty($dao['categories'])) {
|
||
$entry->_tags($dao['categories']);
|
||
}
|
||
if (!empty($dao['attributes'])) {
|
||
$entry->_attributes('', $dao['attributes']);
|
||
}
|
||
return $entry;
|
||
}
|
||
|
||
public function id(): string {
|
||
return $this->id;
|
||
}
|
||
public function guid(): string {
|
||
return $this->guid;
|
||
}
|
||
public function title(): string {
|
||
return $this->title == '' ? $this->guid() : $this->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) {
|
||
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' || strpos($mime, 'image') === 0 ||
|
||
($mime == '' && $length == 0 && preg_match('/[.](avif|gif|jpe?g|png|svg|webp)$/i', $elink));
|
||
}
|
||
|
||
/**
|
||
* @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;
|
||
|
||
$thumbnail = $this->attributes('thumbnail');
|
||
if (!empty($thumbnail['url'])) {
|
||
$elink = $thumbnail['url'];
|
||
if ($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->attributes('enclosures');
|
||
if (empty($attributeEnclosures)) {
|
||
return $content;
|
||
}
|
||
|
||
foreach ($attributeEnclosures as $enclosure) {
|
||
$elink = $enclosure['url'] ?? '';
|
||
if ($elink == '') {
|
||
continue;
|
||
}
|
||
if (!$allowDuplicateEnclosures && self::containsLink($content, $elink)) {
|
||
continue;
|
||
}
|
||
$credit = $enclosure['credit'] ?? '';
|
||
$description = $enclosure['description'] ?? '';
|
||
$length = $enclosure['length'] ?? 0;
|
||
$medium = $enclosure['medium'] ?? '';
|
||
$mime = $enclosure['type'] ?? '';
|
||
$thumbnails = $enclosure['thumbnails'] ?? [];
|
||
$etitle = $enclosure['title'] ?? '';
|
||
|
||
$content .= "\n";
|
||
$content .= '<figure class="enclosure">';
|
||
|
||
foreach ($thumbnails as $thumbnail) {
|
||
$content .= '<p><img class="enclosure-thumbnail" src="' . $thumbnail . '" alt="" title="' . $etitle . '" /></p>';
|
||
}
|
||
|
||
if (self::enclosureIsImage($enclosure)) {
|
||
$content .= '<p class="enclosure-content"><img src="' . $elink . '" alt="" title="' . $etitle . '" /></p>';
|
||
} elseif ($medium === 'audio' || strpos($mime, 'audio') === 0) {
|
||
$content .= '<p class="enclosure-content"><audio preload="none" src="' . $elink
|
||
. ($length == null ? '' : '" data-length="' . intval($length))
|
||
. ($mime == '' ? '' : '" data-type="' . htmlspecialchars($mime, ENT_COMPAT, 'UTF-8'))
|
||
. '" controls="controls" title="' . $etitle . '"></audio> <a download="" href="' . $elink . '">💾</a></p>';
|
||
} elseif ($medium === 'video' || strpos($mime, 'video') === 0) {
|
||
$content .= '<p class="enclosure-content"><video preload="none" src="' . $elink
|
||
. ($length == null ? '' : '" data-length="' . intval($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 ($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,'height'?:int,'width'?:int,'thumbnails'?:array<string>}> */
|
||
public function enclosures(bool $searchBodyImages = false): Traversable {
|
||
$attributeEnclosures = $this->attributes('enclosures');
|
||
if (is_array($attributeEnclosures)) {
|
||
// FreshRSS 1.20.1+: The enclosures are saved as attributes
|
||
yield from $attributeEnclosures;
|
||
}
|
||
try {
|
||
$searchEnclosures = !is_array($attributeEnclosures) && (strpos($this->content, '<p class="enclosure-content') !== false);
|
||
$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) {
|
||
// Legacy code for database entries < FreshRSS 1.20.1
|
||
$enclosures = $xpath->query('//div[@class="enclosure"]/p[@class="enclosure-content"]/*[@src]');
|
||
if (!empty($enclosures)) {
|
||
/** @var DOMElement $enclosure */
|
||
foreach ($enclosures as $enclosure) {
|
||
$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) {
|
||
$images = $xpath->query('//img');
|
||
if (!empty($images)) {
|
||
/** @var DOMElement $img */
|
||
foreach ($images as $img) {
|
||
$src = $img->getAttribute('src');
|
||
if ($src == null) {
|
||
$src = $img->getAttribute('data-src');
|
||
}
|
||
if ($src != null) {
|
||
$result = [
|
||
'url' => $src,
|
||
];
|
||
yield Minz_Helper::htmlspecialchars_utf8($result);
|
||
}
|
||
}
|
||
}
|
||
}
|
||
} catch (Exception $ex) {
|
||
Minz_Log::debug(__METHOD__ . ' ' . $ex->getMessage());
|
||
}
|
||
}
|
||
|
||
/**
|
||
* @return array{'url':string,'type'?:string,'medium'?:string,'length'?:int,'title'?:string,'description'?:string,'credit'?:string,'height'?:int,'width'?:int,'thumbnails'?:array<string>}|null
|
||
*/
|
||
public function thumbnail(bool $searchEnclosures = true): ?array {
|
||
$thumbnail = $this->attributes('thumbnail');
|
||
if (!empty($thumbnail['url'])) {
|
||
return $thumbnail;
|
||
}
|
||
if ($searchEnclosures) {
|
||
foreach ($this->enclosures(true) as $enclosure) {
|
||
if (self::enclosureIsImage($enclosure)) {
|
||
return $enclosure;
|
||
}
|
||
}
|
||
}
|
||
return null;
|
||
}
|
||
|
||
/** @return string HTML-encoded link of the entry */
|
||
public function link(): string {
|
||
return $this->link;
|
||
}
|
||
/**
|
||
* @phpstan-return ($raw is false ? string : int)
|
||
* @return string|int
|
||
*/
|
||
public function date(bool $raw = false) {
|
||
if ($raw) {
|
||
return $this->date;
|
||
}
|
||
return timestamptodate($this->date);
|
||
}
|
||
public function machineReadableDate(): string {
|
||
return @date (DATE_ATOM, $this->date);
|
||
}
|
||
|
||
/**
|
||
* @phpstan-return ($raw is false ? string : ($microsecond is true ? string : int))
|
||
* @return int|string
|
||
*/
|
||
public function dateAdded(bool $raw = false, bool $microsecond = false) {
|
||
if ($raw) {
|
||
if ($microsecond) {
|
||
return $this->date_added;
|
||
} else {
|
||
return intval(substr($this->date_added, 0, -6));
|
||
}
|
||
} else {
|
||
$date = intval(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;
|
||
}
|
||
|
||
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) {
|
||
if ($asString) {
|
||
return $this->tags == null ? '' : '#' . implode(' #', $this->tags);
|
||
} else {
|
||
return $this->tags;
|
||
}
|
||
}
|
||
|
||
/**
|
||
* @phpstan-return ($key is non-empty-string ? mixed : array<string,mixed>)
|
||
* @return array<string,mixed>|mixed|null
|
||
*/
|
||
public function attributes(string $key = '') {
|
||
if ($key === '') {
|
||
return $this->attributes;
|
||
} else {
|
||
return $this->attributes[$key] ?? null;
|
||
}
|
||
}
|
||
|
||
/** @param string|array<mixed>|bool|int|null $value Value, not HTML-encoded */
|
||
public function _attributes(string $key, $value): void {
|
||
if ($key == '') {
|
||
if (is_string($value)) {
|
||
$value = json_decode($value, true);
|
||
}
|
||
if (is_array($value)) {
|
||
$this->attributes = $value;
|
||
}
|
||
} elseif ($value === null) {
|
||
unset($this->attributes[$key]);
|
||
} else {
|
||
$this->attributes[$key] = $value;
|
||
}
|
||
}
|
||
|
||
public function hash(): string {
|
||
if ($this->hash == '') {
|
||
//Do not include $this->date because it may be automatically generated when lacking
|
||
$this->hash = md5($this->link . $this->title . $this->authors(true) . $this->content . $this->tags(true));
|
||
}
|
||
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;
|
||
}
|
||
|
||
public function _id(string $value): void {
|
||
$this->id = $value;
|
||
if ($this->date_added == 0) {
|
||
$this->date_added = $value;
|
||
}
|
||
}
|
||
public function _guid(string $value): void {
|
||
if ($value == '') {
|
||
$value = $this->link;
|
||
if ($value == '') {
|
||
$value = $this->hash();
|
||
}
|
||
}
|
||
$this->guid = $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($value): void {
|
||
$this->hash = '';
|
||
if (!is_array($value)) {
|
||
if (strpos($value, ';') !== false) {
|
||
$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 = $value;
|
||
}
|
||
/** @param int|string $value */
|
||
public function _date($value): void {
|
||
$this->hash = '';
|
||
$value = intval($value);
|
||
$this->date = $value > 1 ? $value : time();
|
||
}
|
||
/** @param int|string $value */
|
||
public function _dateAdded($value, bool $microsecond = false): void {
|
||
if ($microsecond) {
|
||
$this->date_added = (string)($value);
|
||
} else {
|
||
$this->date_added = $value . '000000';
|
||
}
|
||
}
|
||
/** @param bool|int|null $value */
|
||
public function _isRead($value): void {
|
||
$this->is_read = $value === null ? null : (bool)$value;
|
||
}
|
||
/** @param bool|int|null $value */
|
||
public function _isFavorite($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();
|
||
}
|
||
|
||
/** @param int|string $id */
|
||
private function _feedId($id): void {
|
||
$this->feed = null;
|
||
$this->feedId = intval($id);
|
||
}
|
||
|
||
/** @param array<string>|string $value */
|
||
public function _tags($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
|
||
if ($filter->operator() === 'OR') {
|
||
$ok |= $this->matches($filter);
|
||
} elseif ($filter->operator() === 'AND NOT') {
|
||
$ok &= !$this->matches($filter);
|
||
} else { // AND
|
||
$ok &= $this->matches($filter);
|
||
}
|
||
} elseif ($filter instanceof FreshRSS_Search) {
|
||
// Searches are combined by OR and are not recursive
|
||
$ok = true;
|
||
if ($filter->getEntryIds()) {
|
||
$ok &= in_array($this->id, $filter->getEntryIds());
|
||
}
|
||
if ($ok && $filter->getNotEntryIds()) {
|
||
$ok &= !in_array($this->id, $filter->getNotEntryIds());
|
||
}
|
||
if ($ok && $filter->getMinDate()) {
|
||
$ok &= strnatcmp($this->id, $filter->getMinDate() . '000000') >= 0;
|
||
}
|
||
if ($ok && $filter->getNotMinDate()) {
|
||
$ok &= strnatcmp($this->id, $filter->getNotMinDate() . '000000') < 0;
|
||
}
|
||
if ($ok && $filter->getMaxDate()) {
|
||
$ok &= strnatcmp($this->id, $filter->getMaxDate() . '000000') <= 0;
|
||
}
|
||
if ($ok && $filter->getNotMaxDate()) {
|
||
$ok &= strnatcmp($this->id, $filter->getNotMaxDate() . '000000') > 0;
|
||
}
|
||
if ($ok && $filter->getMinPubdate()) {
|
||
$ok &= $this->date >= $filter->getMinPubdate();
|
||
}
|
||
if ($ok && $filter->getNotMinPubdate()) {
|
||
$ok &= $this->date < $filter->getNotMinPubdate();
|
||
}
|
||
if ($ok && $filter->getMaxPubdate()) {
|
||
$ok &= $this->date <= $filter->getMaxPubdate();
|
||
}
|
||
if ($ok && $filter->getNotMaxPubdate()) {
|
||
$ok &= $this->date > $filter->getNotMaxPubdate();
|
||
}
|
||
if ($ok && $filter->getFeedIds()) {
|
||
$ok &= in_array($this->feedId, $filter->getFeedIds());
|
||
}
|
||
if ($ok && $filter->getNotFeedIds()) {
|
||
$ok &= !in_array($this->feedId, $filter->getFeedIds());
|
||
}
|
||
if ($ok && $filter->getAuthor()) {
|
||
foreach ($filter->getAuthor() as $author) {
|
||
$ok &= stripos(implode(';', $this->authors), $author) !== false;
|
||
}
|
||
}
|
||
if ($ok && $filter->getNotAuthor()) {
|
||
foreach ($filter->getNotAuthor() as $author) {
|
||
$ok &= stripos(implode(';', $this->authors), $author) === false;
|
||
}
|
||
}
|
||
if ($ok && $filter->getIntitle()) {
|
||
foreach ($filter->getIntitle() as $title) {
|
||
$ok &= stripos($this->title, $title) !== false;
|
||
}
|
||
}
|
||
if ($ok && $filter->getNotIntitle()) {
|
||
foreach ($filter->getNotIntitle() as $title) {
|
||
$ok &= stripos($this->title, $title) === false;
|
||
}
|
||
}
|
||
if ($ok && $filter->getTags()) {
|
||
foreach ($filter->getTags() as $tag2) {
|
||
$found = false;
|
||
foreach ($this->tags as $tag1) {
|
||
if (strcasecmp($tag1, $tag2) === 0) {
|
||
$found = true;
|
||
}
|
||
}
|
||
$ok &= $found;
|
||
}
|
||
}
|
||
if ($ok && $filter->getNotTags()) {
|
||
foreach ($filter->getNotTags() as $tag2) {
|
||
$found = false;
|
||
foreach ($this->tags as $tag1) {
|
||
if (strcasecmp($tag1, $tag2) === 0) {
|
||
$found = true;
|
||
}
|
||
}
|
||
$ok &= !$found;
|
||
}
|
||
}
|
||
if ($ok && $filter->getInurl()) {
|
||
foreach ($filter->getInurl() as $url) {
|
||
$ok &= stripos($this->link, $url) !== false;
|
||
}
|
||
}
|
||
if ($ok && $filter->getNotInurl()) {
|
||
foreach ($filter->getNotInurl() as $url) {
|
||
$ok &= stripos($this->link, $url) === false;
|
||
}
|
||
}
|
||
if ($ok && $filter->getSearch()) {
|
||
foreach ($filter->getSearch() as $needle) {
|
||
$ok &= (stripos($this->title, $needle) !== false || stripos($this->content, $needle) !== false);
|
||
}
|
||
}
|
||
if ($ok && $filter->getNotSearch()) {
|
||
foreach ($filter->getNotSearch() as $needle) {
|
||
$ok &= (stripos($this->title, $needle) === false && stripos($this->content, $needle) === false);
|
||
}
|
||
}
|
||
if ($ok) {
|
||
return true;
|
||
}
|
||
}
|
||
}
|
||
return (bool)$ok;
|
||
}
|
||
|
||
/** @param array<string,int> $titlesAsRead */
|
||
public function applyFilterActions(array $titlesAsRead = []): void {
|
||
if ($this->feed != null) {
|
||
if ($this->feed->attributes('read_upon_reception') ||
|
||
($this->feed->attributes('read_upon_reception') === null && FreshRSS_Context::$user_conf->mark_when['reception'])) {
|
||
$this->_isRead(true);
|
||
}
|
||
if (isset($titlesAsRead[$this->title()])) {
|
||
Minz_Log::debug('Mark title as read: ' . $this->title());
|
||
$this->_isRead(true);
|
||
}
|
||
foreach ($this->feed->filterActions() as $filterAction) {
|
||
if ($this->matches($filterAction->booleanSearch())) {
|
||
foreach ($filterAction->actions() as $action) {
|
||
switch ($action) {
|
||
case 'read':
|
||
$this->_isRead(true);
|
||
break;
|
||
case 'star':
|
||
$this->_isFavorite(true);
|
||
break;
|
||
case 'label':
|
||
//TODO: Implement more actions
|
||
break;
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
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 array<string,mixed> $attributes
|
||
*/
|
||
public static function getContentByParsing(string $url, string $path, array $attributes = [], int $maxRedirs = 3): string {
|
||
$cachePath = FreshRSS_Feed::cacheFilename($url, $attributes, FreshRSS_Feed::KIND_HTML_XPATH);
|
||
$html = httpGet($url, $cachePath, 'html', $attributes);
|
||
if (strlen($html) > 0) {
|
||
$doc = new DOMDocument();
|
||
$doc->loadHTML($html, LIBXML_NONET | LIBXML_NOERROR | LIBXML_NOWARNING);
|
||
$xpath = new DOMXPath($doc);
|
||
|
||
if ($maxRedirs > 0) {
|
||
//Follow any HTML redirection
|
||
$metas = $xpath->query('//meta[@content]');
|
||
/** @var array<DOMElement> $metas */
|
||
foreach ($metas as $meta) {
|
||
if (strtolower(trim($meta->getAttribute('http-equiv'))) === 'refresh') {
|
||
$refresh = preg_replace('/^[0-9.; ]*\s*(url\s*=)?\s*/i', '', trim($meta->getAttribute('content')));
|
||
$refresh = SimplePie_Misc::absolutize_url($refresh, $url);
|
||
if ($refresh != false && $refresh !== $url) {
|
||
return self::getContentByParsing($refresh, $path, $attributes, $maxRedirs - 1);
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
$base = $xpath->evaluate('normalize-space(//base/@href)');
|
||
if ($base == false || !is_string($base)) {
|
||
$base = $url;
|
||
} elseif (substr($base, 0, 2) === '//') {
|
||
//Protocol-relative URLs "//www.example.net"
|
||
$base = (parse_url($url, PHP_URL_SCHEME) ?? 'https') . ':' . $base;
|
||
}
|
||
|
||
$content = '';
|
||
$nodes = $xpath->query(new Gt\CssXPath\Translator($path));
|
||
if ($nodes != false) {
|
||
foreach ($nodes as $node) {
|
||
if (!empty($attributes['path_entries_filter'])) {
|
||
$filterednodes = $xpath->query(new Gt\CssXPath\Translator($attributes['path_entries_filter']), $node) ?: [];
|
||
foreach ($filterednodes as $filterednode) {
|
||
$filterednode->parentNode->removeChild($filterednode);
|
||
}
|
||
}
|
||
$content .= $doc->saveHtml($node) . "\n";
|
||
}
|
||
}
|
||
$html = trim(sanitizeHTML($content, $base));
|
||
return $html;
|
||
} else {
|
||
throw new Exception();
|
||
}
|
||
}
|
||
|
||
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 && trim($feed->pathEntries()) != '') {
|
||
$entryDAO = FreshRSS_Factory::createEntryDao();
|
||
$entry = $force ? null : $entryDAO->searchByGuid($this->feedId, $this->guid);
|
||
|
||
if ($entry) {
|
||
// 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 = self::getContentByParsing(
|
||
htmlspecialchars_decode($this->link(), ENT_QUOTES),
|
||
htmlspecialchars_decode($feed->pathEntries(), ENT_QUOTES),
|
||
$feed->attributes()
|
||
);
|
||
if ('' !== $fullContent) {
|
||
$fullContent = "<!-- FULLCONTENT start //-->{$fullContent}<!-- FULLCONTENT end //-->";
|
||
$originalContent = preg_replace('#<!-- FULLCONTENT start //-->.*<!-- FULLCONTENT end //-->#s', '', $this->content());
|
||
switch ($feed->attributes('content_action')) {
|
||
case 'prepend':
|
||
$this->content = $fullContent . $originalContent;
|
||
break;
|
||
case 'append':
|
||
$this->content = $originalContent . $fullContent;
|
||
break;
|
||
case 'replace':
|
||
default:
|
||
$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());
|
||
}
|
||
}
|
||
}
|
||
return false;
|
||
}
|
||
|
||
/**
|
||
* @return array{'id':string,'guid':string,'title':string,'author':string,'content':string,'link':string,'date':int,
|
||
* 'hash':string,'is_read':?bool,'is_favorite':?bool,'id_feed':int,'tags':string,'attributes':array<string,mixed>}
|
||
*/
|
||
public function toArray(): array {
|
||
return array(
|
||
'id' => $this->id(),
|
||
'guid' => $this->guid(),
|
||
'title' => $this->title(),
|
||
'author' => $this->authors(true),
|
||
'content' => $this->content(false),
|
||
'link' => $this->link(),
|
||
'date' => $this->date(true),
|
||
'hash' => $this->hash(),
|
||
'is_read' => $this->isRead(),
|
||
'is_favorite' => $this->isFavorite(),
|
||
'id_feed' => $this->feedId(),
|
||
'tags' => $this->tags(true),
|
||
'attributes' => $this->attributes(),
|
||
);
|
||
}
|
||
|
||
/**
|
||
* Integer format conversion for Google Reader API format
|
||
* @param string|int $dec Decimal number
|
||
* @return string 64-bit hexa http://code.google.com/p/google-reader-api/wiki/ItemId
|
||
*/
|
||
private static function dec2hex($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
|
||
*/
|
||
const API_MAX_COMPAT_CONTENT_LENGTH = 500000;
|
||
|
||
/**
|
||
* N.B.: To avoid expensive lookups, ensure to set `$entry->_feed($feed)` before calling this function.
|
||
* N.B.: You might have to populate `$entry->_tags()` prior to 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).
|
||
* @return array<string,mixed> A representation of this entry in a format compatible with Google Reader API
|
||
*/
|
||
public function toGReader(string $mode = ''): array {
|
||
|
||
$feed = $this->feed();
|
||
$category = $feed == null ? null : $feed->category();
|
||
|
||
$item = [
|
||
'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'] = intval($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 ($this->tags() as $tagName) {
|
||
$item['categories'][] = 'user/-/label/' . htmlspecialchars_decode($tagName, ENT_QUOTES);
|
||
}
|
||
return $item;
|
||
}
|
||
}
|